Skip to content

Commit 4a2eb8d

Browse files
betterdatacobetterdataco
committed
feat(loop-status-client): land @loop-engine/loop-status-client in the canonical repo
OSS client for the Boss Loops Cloud loop-status API (SSE subscribe + cursor pull/replay over @loop-engine/events LoopEvent). Ported from the bd-forge-main build into the canonical loop-engine repo so it publishes from the family's pipeline, not ad-hoc. - Conformed to the repo's stricter tsconfig.base (exactOptionalPropertyTypes): optional `status` assigned only when present; `signal` set conditionally on RequestInit. Build (esm/cjs/dts), typecheck, and 8/8 vitest pass. - validate:publish (check-no-workspace-refs) green — packed manifest pins @loop-engine/events to 1.0.0-rc.0, no workspace: refs. - check-security-metadata green; apache-2.0 SPDX header added to the test file so check-boundary gains no new failure. Version (0.1.0) and changeset are deliberately deferred to the names/versions -final gate (join the 1.0.0-rc.0 line vs. carry its own version).
1 parent 1a0afe3 commit 4a2eb8d

11 files changed

Lines changed: 819 additions & 55 deletions

File tree

‎packages/loop-status-client/LICENSE‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
Copyright 2026 Better Data, Inc.
2+
3+
Apache License
4+
Version 2.0, January 2004
5+
http://www.apache.org/licenses/
6+
7+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8+
9+
1. Definitions.
10+
11+
"License" shall mean the terms and conditions for use, reproduction,
12+
and distribution as defined by Sections 1 through 9 of this document.
13+
14+
"Licensor" shall mean the copyright owner or entity authorized by
15+
the copyright owner that is granting the License.
16+
17+
"Legal Entity" shall mean the union of the acting entity and all
18+
other entities that control, are controlled by, or are under common
19+
control with that entity. For the purposes of this definition,
20+
"control" means (i) the power, direct or indirect, to cause the
21+
direction or management of such entity, whether by contract or
22+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
23+
outstanding shares, or (iii) beneficial ownership of such entity.
24+
25+
"You" (or "Your") shall mean an individual or Legal Entity
26+
exercising permissions granted by this License.
27+
28+
"Source" form shall mean the preferred form for making modifications,
29+
including but not limited to software source code, documentation
30+
source, and configuration files.
31+
32+
"Object" form shall mean any form resulting from mechanical
33+
transformation or translation of a Source form, including but
34+
not limited to compiled object code, generated documentation,
35+
and conversions to other media types.
36+
37+
"Work" shall mean the work of authorship, whether in Source or
38+
Object form, made available under the License, as indicated by a
39+
copyright notice that is included in or attached to the work
40+
(an example is provided in the Appendix below).
41+
42+
"Derivative Works" shall mean any work, whether in Source or Object
43+
form, that is based on (or derived from) the Work and for which the
44+
editorial revisions, annotations, elaborations, or other modifications
45+
represent, as a whole, an original work of authorship. For the purposes
46+
of this License, Derivative Works shall not include works that remain
47+
separable from, or merely link (or bind by name) to the interfaces of,
48+
the Work and Derivative Works thereof.
49+
50+
"Contribution" shall mean any work of authorship, including
51+
the original version of the Work and any modifications or additions
52+
to that Work or Derivative Works thereof, that is intentionally
53+
submitted to Licensor for inclusion in the Work by the copyright owner
54+
or by an individual or Legal Entity authorized to submit on behalf of
55+
the copyright owner. For the purposes of this definition, "submitted"
56+
means any form of electronic, verbal, or written communication sent
57+
to the Licensor or its representatives, including but not limited to
58+
communication on electronic mailing lists, source code control systems,
59+
and issue tracking systems that are managed by, or on behalf of, the
60+
Licensor for the purpose of discussing and improving the Work, but
61+
excluding communication that is conspicuously marked or otherwise
62+
designated in writing by the copyright owner as "Not a Contribution."
63+
64+
"Contributor" shall mean Licensor and any individual or Legal Entity
65+
on behalf of whom a Contribution has been received by Licensor and
66+
subsequently incorporated within the Work.
67+
68+
2. Grant of Copyright License. Subject to the terms and conditions of
69+
this License, each Contributor hereby grants to You a perpetual,
70+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71+
copyright license to reproduce, prepare Derivative Works of,
72+
publicly display, publicly perform, sublicense, and distribute the
73+
Work and such Derivative Works in Source or Object form.
74+
75+
3. Grant of Patent License. Subject to the terms and conditions of
76+
this License, each Contributor hereby grants to You a perpetual,
77+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78+
(except as stated in this section) patent license to make, have made,
79+
use, offer to sell, sell, import, and otherwise transfer the Work,
80+
where such license applies only to those patent claims licensable
81+
by such Contributor that are necessarily infringed by their
82+
Contribution(s) alone or by combination of their Contribution(s)
83+
with the Work to which such Contribution(s) was submitted. If You
84+
institute patent litigation against any entity (including a
85+
cross-claim or counterclaim in a lawsuit) alleging that the Work
86+
or a Contribution incorporated within the Work constitutes direct
87+
or contributory patent infringement, then any patent licenses
88+
granted to You under this License for that Work shall terminate
89+
as of the date such litigation is filed.
90+
91+
4. Redistribution. You may reproduce and distribute copies of the
92+
Work or Derivative Works thereof in any medium, with or without
93+
modifications, and in Source or Object form, provided that You
94+
meet the following conditions:
95+
96+
(a) You must give any other recipients of the Work or
97+
Derivative Works a copy of this License; and
98+
99+
(b) You must cause any modified files to carry prominent notices
100+
stating that You changed the files; and
101+
102+
(c) You must retain, in the Source form of any Derivative Works
103+
that You distribute, all copyright, patent, trademark, and
104+
attribution notices from the Source form of the Work,
105+
excluding those notices that do not pertain to any part of
106+
the Derivative Works; and
107+
108+
(d) If the Work includes a "NOTICE" text file as part of its
109+
distribution, then any Derivative Works that You distribute must
110+
include a readable copy of the attribution notices contained
111+
within such NOTICE file, excluding those notices that do not
112+
pertain to any part of the Derivative Works, in at least one
113+
of the following places: within a NOTICE text file distributed
114+
as part of the Derivative Works; within the Source form or
115+
documentation, if provided along with the Derivative Works; or,
116+
within a display generated by the Derivative Works, if and
117+
wherever such third-party notices normally appear. The contents
118+
of the NOTICE file are for informational purposes only and
119+
do not modify the License. You may add Your own attribution
120+
notices within Derivative Works that You distribute, alongside
121+
or as an addendum to the NOTICE text from the Work, provided
122+
that such additional attribution notices cannot be construed
123+
as modifying the License.
124+
125+
You may add Your own copyright statement to Your modifications and
126+
may provide additional or different license terms and conditions
127+
for use, reproduction, or distribution of Your modifications, or
128+
for any such Derivative Works as a whole, provided Your use,
129+
reproduction, and distribution of the Work otherwise complies with
130+
the conditions stated in this License.
131+
132+
5. Submission of Contributions. Unless You explicitly state otherwise,
133+
any Contribution intentionally submitted for inclusion in the Work
134+
by You to the Licensor shall be under the terms and conditions of
135+
this License, without any additional terms or conditions.
136+
Notwithstanding the above, nothing herein shall supersede or modify
137+
the terms of any separate license agreement you may have executed
138+
with Licensor regarding such Contributions.
139+
140+
6. Trademarks. This License does not grant permission to use the trade
141+
names, trademarks, service marks, or product names of the Licensor,
142+
except as required for reasonable and customary use in describing the
143+
origin of the Work and reproducing the content of the NOTICE file.
144+
145+
7. Disclaimer of Warranty. Unless required by applicable law or
146+
agreed to in writing, Licensor provides the Work (and each
147+
Contributor provides its Contributions) on an "AS IS" BASIS,
148+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149+
implied, including, without limitation, any warranties or conditions
150+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151+
PARTICULAR PURPOSE. You are solely responsible for determining the
152+
appropriateness of using or redistributing the Work and assume any
153+
risks associated with Your exercise of permissions under this License.
154+
155+
8. Limitation of Liability. In no event and under no legal theory,
156+
whether in tort (including negligence), contract, or otherwise,
157+
unless required by applicable law (such as deliberate and grossly
158+
negligent acts) or agreed to in writing, shall any Contributor be
159+
liable to You for damages, including any direct, indirect, special,
160+
incidental, or consequential damages of any character arising as a
161+
result of this License or out of the use or inability to use the
162+
Work (including but not limited to damages for loss of goodwill,
163+
work stoppage, computer failure or malfunction, or any and all
164+
other commercial damages or losses), even if such Contributor
165+
has been advised of the possibility of such damages.
166+
167+
9. Accepting Warranty or Additional Liability. While redistributing
168+
the Work or Derivative Works thereof, You may choose to offer,
169+
and charge a fee for, acceptance of support, warranty, indemnity,
170+
or other liability obligations and/or rights consistent with this
171+
License. However, in accepting such obligations, You may act only
172+
on Your own behalf and on Your sole responsibility, not on behalf
173+
of any other Contributor, and only if You agree to indemnify,
174+
defend, and hold each Contributor harmless for any liability
175+
incurred by, or claims asserted against, such Contributor by reason
176+
of your accepting any such warranty or additional liability.
177+
178+
END OF TERMS AND CONDITIONS
179+
180+
APPENDIX: How to apply the Apache License to your work.
181+
182+
To apply the Apache License to your work, attach the following
183+
boilerplate notice, with the fields enclosed by brackets "[]"
184+
replaced with your own identifying information. (Don't include
185+
the brackets!) The text should be enclosed in the appropriate
186+
comment syntax for the file format. We also recommend that a
187+
file or class name and description of purpose be included on the
188+
same "printed page" as the copyright notice for easier
189+
identification within third-party archives.
190+
191+
Copyright [yyyy] [name of copyright owner]
192+
193+
Licensed under the Apache License, Version 2.0 (the "License");
194+
you may not use this file except in compliance with the License.
195+
You may obtain a copy of the License at
196+
197+
http://www.apache.org/licenses/LICENSE-2.0
198+
199+
Unless required by applicable law or agreed to in writing, software
200+
distributed under the License is distributed on an "AS IS" BASIS,
201+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202+
See the License for the specific language governing permissions and
203+
limitations under the License.

‎packages/loop-status-client/README.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# @loop-engine/loop-status-client
2+
3+
OSS client for the **Boss Loops Cloud loop-status API** — subscribe to a live
4+
stream of loop-state transitions (SSE) and pull/replay them from a cursor, all
5+
over the OSS [`@loop-engine/events`](../events) `LoopEvent` types.
6+
7+
> Boss Loops OSS is distributed as the `@loop-engine/*` packages; this is the
8+
> distribution-level client for the hosted loop-status surface (BL-BRAND-01).
9+
10+
It contains **no proprietary logic**: it is an HTTP/SSE client over a Cloud API
11+
with public event types, so any consumer (first- or third-party) can subscribe to
12+
loop status. The Cloud API itself is the proprietary surface.
13+
14+
## Design
15+
16+
- **Pull is the backbone, stream is convenience.** `pullTransitions` is the
17+
durable, cursor-ordered read; `streamLoopState` is a best-effort live push of
18+
the same events. A consumer resumes from its last cursor and never misses a
19+
transition — "degradation is time, not data".
20+
- **Auth is supplied, never minted.** You pass `getToken()`; the client sends it
21+
as a Bearer token. Token issuance is platform-only (PLAT-AUTH-01) — this client
22+
has no knowledge of signing or org claims, by design.
23+
24+
## Usage
25+
26+
```ts
27+
import { createLoopStatusClient, cursorOf } from "@loop-engine/loop-status-client";
28+
29+
const client = createLoopStatusClient({
30+
baseUrl: "https://cloud.bossloops.example",
31+
getToken: async () => fetchServiceToken(), // your PLAT-AUTH-01 token source
32+
});
33+
34+
// Durable catch-up from a stored cursor.
35+
let cursor: string | null = loadCursor();
36+
let page = await client.pullTransitions({ organizationId, since: cursor, limit: 200 });
37+
for (const event of page.events) handle(event);
38+
cursor = page.nextCursor;
39+
while (page.hasMore) {
40+
page = await client.pullTransitions({ organizationId, since: cursor });
41+
for (const event of page.events) handle(event);
42+
cursor = page.nextCursor;
43+
}
44+
45+
// Live stream, resuming from the same cursor.
46+
const controller = new AbortController();
47+
await client.streamLoopState({
48+
organizationId,
49+
since: cursor,
50+
signal: controller.signal,
51+
onEvent: (event) => {
52+
handle(event);
53+
cursor = cursorOf(event) ?? cursor; // persist for resume
54+
},
55+
onResyncRequired: async (nextCursor) => {
56+
// history exceeded one catch-up page — drain via pull, then the stream continues live
57+
cursor = nextCursor;
58+
},
59+
});
60+
```
61+
62+
## API
63+
64+
- `createLoopStatusClient(options)` → `{ pullTransitions, streamLoopState }`
65+
- `pullTransitions({ organizationId, since?, limit?, signal? })` →
66+
`{ events, nextCursor, hasMore }`
67+
- `streamLoopState({ organizationId, since?, signal?, onEvent, onPing?, onResyncRequired?, onError? })`
68+
- `cursorOf(event)` → the resume cursor for a `LoopEvent`
69+
- `LoopStatusError` — thrown on non-2xx, carries `status`
70+
71+
## Build / test
72+
73+
- `pnpm build` — tsup (esm + cjs + dts)
74+
- `pnpm test` — vitest (mocked fetch; no network)

‎packages/loop-status-client/package.json‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"name": "@loop-engine/loop-status-client",
3+
"version": "0.1.0",
4+
"description": "OSS client for the Boss Loops Cloud loop-status API: subscribe (SSE) + cursor pull/replay over OSS LoopEvent types.",
5+
"license": "Apache-2.0",
6+
"repository": {
7+
"type": "git",
8+
"url": "git+https://github.com/loopengine/loop-engine.git",
9+
"directory": "packages/loop-status-client"
10+
},
11+
"homepage": "https://loopengine.io/docs/packages/loop-status-client",
12+
"type": "module",
13+
"main": "./dist/index.cjs",
14+
"module": "./dist/index.js",
15+
"types": "./dist/index.d.ts",
16+
"exports": {
17+
".": {
18+
"types": "./dist/index.d.ts",
19+
"import": "./dist/index.js",
20+
"require": "./dist/index.cjs"
21+
}
22+
},
23+
"files": [
24+
"dist",
25+
"README.md",
26+
"LICENSE"
27+
],
28+
"sideEffects": false,
29+
"scripts": {
30+
"build": "tsup",
31+
"typecheck": "tsc --noEmit -p tsconfig.json",
32+
"test": "vitest run"
33+
},
34+
"dependencies": {
35+
"@loop-engine/events": "workspace:*"
36+
},
37+
"devDependencies": {
38+
"tsup": "^8.5.1",
39+
"typescript": "^5.9.3",
40+
"vitest": "^1.6.1"
41+
},
42+
"engines": {
43+
"node": ">=18.17"
44+
},
45+
"keywords": [
46+
"loop-engine",
47+
"loop-status",
48+
"sse",
49+
"event-stream",
50+
"cursor-replay",
51+
"client"
52+
],
53+
"publishConfig": {
54+
"access": "public",
55+
"provenance": true
56+
}
57+
}

0 commit comments

Comments
 (0)