@forumulate/sdk 0.11.4 → 0.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,23 @@
3
3
  Releases of `@forumulate/sdk`. Earlier versions are described in the git history of
4
4
  `packages/sdk` (`release(sdk): …` commits).
5
5
 
6
+ ## 0.12.1
7
+
8
+ - A CSV export over the API's row threshold answers `202` with a job instead of the
9
+ file. Every `exportCsv` (and any GET that answers 202 with an `export.csv` job) now
10
+ waits for the job and returns the file, the same as the `200`; a failed job throws
11
+ `ForumulateError` with the job's error, and 30 minutes without a result throws
12
+ `export.timeout`. Pass `raw: true` to get the `202` itself.
13
+
14
+ ## 0.12.0
15
+
16
+ Types and operations for the 2026-11-01 batch: connector `knowledge` state and the token
17
+ response, monitor `headers` / `headersSet` / `json`, domain `settling` and manifest
18
+ `domains[].state`, `readerIdentity`, `releases`, `legalDocuments`, page
19
+ `metadata.frontMatter`, consent `webhookLastFailure`, `DELETE /orgs/{orgId}/members`
20
+ by external id, `POST …/reader-auth/jwt/check`, `POST …/reader-sessions/revoke`, and the
21
+ external_jwt `testVector` on reader-auth setup.
22
+
6
23
  ## 0.11.4
7
24
 
8
25
  ### Added
package/dist/http.d.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  * and not another.
7
7
  */
8
8
  /** Kept in step with package.json by `coverage.test.ts`. */
9
- export declare const SDK_VERSION = "0.11.4";
9
+ export declare const SDK_VERSION = "0.12.1";
10
10
  /** The API's error envelope: `{ error: { code, message, details? }, requestId? }`. */
11
11
  export interface ForumulateErrorInit {
12
12
  /** Field-level detail, e.g. `{ title: ['Required'] }` for `validation.failed`. */
@@ -83,4 +83,6 @@ export interface Transport {
83
83
  */
84
84
  export declare function retryDelayMs(attempt: number, retryAfter: string | null | undefined, now?: number): number | null;
85
85
  export declare function send<T>(t: Transport, init: SendInit): Promise<T>;
86
+ /** How long a queued export is waited for before giving up (the file is kept 7 days). */
87
+ export declare const EXPORT_WAIT_MS: number;
86
88
  //# sourceMappingURL=http.d.ts.map
package/dist/http.js CHANGED
@@ -7,11 +7,11 @@
7
7
  * and not another.
8
8
  */
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.ForumulateError = exports.SDK_VERSION = void 0;
10
+ exports.EXPORT_WAIT_MS = exports.ForumulateError = exports.SDK_VERSION = void 0;
11
11
  exports.retryDelayMs = retryDelayMs;
12
12
  exports.send = send;
13
13
  /** Kept in step with package.json by `coverage.test.ts`. */
14
- exports.SDK_VERSION = '0.11.4';
14
+ exports.SDK_VERSION = '0.12.1';
15
15
  /**
16
16
  * Thrown for any non-2xx API response, and for a network failure that
17
17
  * outlived its retries (`status: 0`, `code: 'network.error'`). Mirrors the
@@ -184,8 +184,15 @@ async function send(t, init) {
184
184
  await sleep(wait, init.signal);
185
185
  continue;
186
186
  }
187
- if (res.ok)
187
+ if (res.ok) {
188
+ if (res.status === 202 && method === 'GET' && !init.raw && init.kind !== 'binary') {
189
+ const job = (await decode(res, { ...init, kind: 'json' }));
190
+ if (job?.kind === 'export.csv' && job.links?.self)
191
+ return (await followExport(t, init, job));
192
+ return job;
193
+ }
188
194
  return (await decode(res, init));
195
+ }
189
196
  if (attempt < maxRetries && RETRY_STATUS.has(res.status)) {
190
197
  const wait = retryDelayMs(attempt, res.headers?.get?.('retry-after'));
191
198
  if (wait !== null) {
@@ -197,4 +204,32 @@ async function send(t, init) {
197
204
  throw await toError(res);
198
205
  }
199
206
  }
207
+ /** An absolute or `/api`-prefixed link from the API, as a path under the client's base URL. */
208
+ const apiPath = (link) => link.replace(/^https?:\/\/[^/]+/, '').replace(/^\/api(?=\/)/, '');
209
+ /** How long a queued export is waited for before giving up (the file is kept 7 days). */
210
+ exports.EXPORT_WAIT_MS = 30 * 60_000;
211
+ /**
212
+ * A CSV export over the API's row threshold answers 202 with the job that builds
213
+ * the file, not the file. Every caller asked for the file, so wait for the job and
214
+ * fetch it: the same answer the 200 gives, however big. `raw: true` opts out.
215
+ */
216
+ async function followExport(t, init, first) {
217
+ const base = { headers: init.headers, signal: init.signal, version: init.version, maxRetries: init.maxRetries };
218
+ const deadline = Date.now() + exports.EXPORT_WAIT_MS;
219
+ let job = first;
220
+ for (let i = 0; job.state !== 'completed'; i++) {
221
+ if (job.state === 'failed' || job.state === 'canceled') {
222
+ throw new ForumulateError(500, job.error?.code ?? 'job.failed', job.error?.message ?? 'The export failed.', { body: job });
223
+ }
224
+ if (Date.now() > deadline) {
225
+ throw new ForumulateError(504, 'export.timeout', 'The export did not finish within 30 minutes.', { body: job });
226
+ }
227
+ await sleep(Math.min(1000 * 2 ** i, 10_000), init.signal);
228
+ job = await send(t, { ...base, method: 'GET', path: apiPath(job.links.self) });
229
+ }
230
+ const result = job.links?.result;
231
+ if (!result)
232
+ throw new ForumulateError(500, 'job.no_result', 'The export finished without a file.', { body: job });
233
+ return send(t, { ...base, method: 'GET', path: apiPath(result), kind: init.kind });
234
+ }
200
235
  //# sourceMappingURL=http.js.map
@@ -2429,6 +2429,7 @@ export declare const OPERATIONS: {
2429
2429
  readonly Member: readonly ["members", {
2430
2430
  readonly list: "GET ~o/members p";
2431
2431
  readonly invite: "POST ~o/members";
2432
+ readonly removeByExternal: "DELETE ~o/members";
2432
2433
  readonly invites: "GET ~o/members/invites p";
2433
2434
  readonly revokeInvite: "DELETE ~o/members/invites/{inviteId}";
2434
2435
  readonly bulkInvite: "POST ~o/members/bulk";
@@ -3161,6 +3162,9 @@ export declare const OPERATIONS: {
3161
3162
  readonly ReaderImageSign: readonly ["readers.imageSign", {
3162
3163
  readonly sign: "POST /public/orgs/{orgId}/me/images/sign";
3163
3164
  }];
3165
+ readonly ReaderJwtCheck: readonly ["readers.jwtCheck", {
3166
+ readonly check: "POST ~o/reader-auth/jwt/check";
3167
+ }];
3164
3168
  readonly ReaderPolicy: readonly ["readers.policy", {
3165
3169
  readonly getLegalGate: "GET ~s/legal-gate";
3166
3170
  readonly setLegalGate: "PUT ~s/legal-gate";
@@ -3191,6 +3195,9 @@ export declare const OPERATIONS: {
3191
3195
  readonly ReaderPolicyPublic: readonly ["readers.publicPolicy", {
3192
3196
  readonly resolved: "GET ~P/reader-policy";
3193
3197
  }];
3198
+ readonly ReaderSessions: readonly ["readers.sessions", {
3199
+ readonly revoke: "POST ~o/reader-sessions/revoke";
3200
+ }];
3194
3201
  readonly ReaderSignOut: readonly ["readers.signOut", {
3195
3202
  readonly signOut: "POST /public/reader/sign-out";
3196
3203
  }];
@@ -338,7 +338,7 @@ exports.OPERATIONS = {
338
338
  McpAgent: ['mcp.agent', { rpc: 'POST ~o/mcp', info: 'GET ~o/mcp', rpcReadOnly: 'POST ~o/mcp/readonly', infoReadOnly: 'GET ~o/mcp/readonly' }],
339
339
  McpDiscovery: ['mcp.discovery', { aiCatalog: 'GET /public/orgs/{orgId}/sites/{slug}/ai-catalog', serverCard: 'GET /public/orgs/{orgId}/sites/{slug}/mcp-server-card' }],
340
340
  MeetingOauthCallback: ['meetingOauthCallback', { callback: 'GET /public/meetings/{provider}/oauth/callback' }],
341
- Member: ['members', { list: 'GET ~o/members p', invite: 'POST ~o/members', invites: 'GET ~o/members/invites p', revokeInvite: 'DELETE ~o/members/invites/{inviteId}', bulkInvite: 'POST ~o/members/bulk', listInviteLinks: 'GET ~o/members/invite-links p', createInviteLink: 'POST ~o/members/invite-links', revokeInviteLink: 'DELETE ~o/members/invite-links/{linkId}', update: 'PATCH ~o/members/{userId}', remove: 'DELETE ~o/members/{userId}', revokeSessions: 'POST ~o/members/{userId}/sessions/revoke', reassignContent: 'POST ~o/members/{userId}/reassign-content', delete: '=remove DELETE ~o/members/{userId}' }],
341
+ Member: ['members', { list: 'GET ~o/members p', invite: 'POST ~o/members', removeByExternal: 'DELETE ~o/members', invites: 'GET ~o/members/invites p', revokeInvite: 'DELETE ~o/members/invites/{inviteId}', bulkInvite: 'POST ~o/members/bulk', listInviteLinks: 'GET ~o/members/invite-links p', createInviteLink: 'POST ~o/members/invite-links', revokeInviteLink: 'DELETE ~o/members/invite-links/{linkId}', update: 'PATCH ~o/members/{userId}', remove: 'DELETE ~o/members/{userId}', revokeSessions: 'POST ~o/members/{userId}/sessions/revoke', reassignContent: 'POST ~o/members/{userId}/reassign-content', delete: '=remove DELETE ~o/members/{userId}' }],
342
342
  MemberMerge: ['members.merge', { preview: 'GET ~o/members/{userId}/merge-preview', merge: 'POST ~o/members/{userId}/merge' }],
343
343
  PublicMemberSegments: ['members.publicSegments', { membership: 'GET /public/orgs/{orgId}/segments/{segmentId}/membership' }],
344
344
  MemberRelink: ['members.relink', { relink: 'POST ~o/members/relink', get: 'GET ~o/members/relink/{jobId}' }],
@@ -445,11 +445,13 @@ exports.OPERATIONS = {
445
445
  ReaderAuth: ['readers.auth', { getOrg: 'GET ~o/reader-auth', setOrg: 'PUT ~o/reader-auth', patchOrg: 'PATCH ~o/reader-auth', setupOrg: 'GET ~o/reader-auth/setup', setup: 'GET ~s/reader-auth/setup', getSpace: 'GET ~s/reader-auth', setSpace: 'PUT ~s/reader-auth', patchSpace: 'PATCH ~s/reader-auth', deleteSpace: 'DELETE ~s/reader-auth' }],
446
446
  ReaderDomain: ['readers.domain', { get: 'GET ~o/reader-domain', configure: 'PUT ~o/reader-domain', remove: 'DELETE ~o/reader-domain', verify: 'POST ~o/reader-domain/verify', delete: '=remove DELETE ~o/reader-domain' }],
447
447
  ReaderImageSign: ['readers.imageSign', { sign: 'POST /public/orgs/{orgId}/me/images/sign' }],
448
+ ReaderJwtCheck: ['readers.jwtCheck', { check: 'POST ~o/reader-auth/jwt/check' }],
448
449
  ReaderPolicy: ['readers.policy', { getLegalGate: 'GET ~s/legal-gate', setLegalGate: 'PUT ~s/legal-gate', patchLegalGate: 'PATCH ~s/legal-gate', deleteLegalGate: 'DELETE ~s/legal-gate', getReaderIdentity: 'GET ~s/reader-identity', setReaderIdentity: 'PUT ~s/reader-identity', patchReaderIdentity: 'PATCH ~s/reader-identity', deleteReaderIdentity: 'DELETE ~s/reader-identity' }],
449
450
  ReaderAuthPublic: ['readers.publicAuth', { resolved: 'GET ~P/reader-auth' }],
450
451
  ReaderIdpPublic: ['readers.publicIdp', { backchannelLogout: 'POST /public/orgs/{orgId}/oidc/backchannel-logout', atlasBackchannelLogout: 'POST /public/orgs/{orgId}/atlas/backchannel-logout', lifecycle: 'POST /public/orgs/{orgId}/identity/events/{preset}', oktaVerification: 'GET /public/orgs/{orgId}/identity/events/okta' }],
451
452
  PublicReaderMarks: ['readers.publicMarks', { streak: 'GET ~P/marks/streak', read: 'GET ~P/marks/{slug}', mark: 'POST ~P/marks/{slug}', clap: 'POST ~P/marks/{slug}/clap', unmark: 'DELETE ~P/marks/{slug}/{markId}', get: '=read GET ~P/marks/{slug}' }],
452
453
  ReaderPolicyPublic: ['readers.publicPolicy', { resolved: 'GET ~P/reader-policy' }],
454
+ ReaderSessions: ['readers.sessions', { revoke: 'POST ~o/reader-sessions/revoke' }],
453
455
  ReaderSignOut: ['readers.signOut', { signOut: 'POST /public/reader/sign-out' }],
454
456
  ReaderSignup: ['readers.signup', { list: 'GET ~s/reader-signups p', approve: 'POST ~s/reader-signups/{id}/approve', reject: 'POST ~s/reader-signups/{id}/reject' }],
455
457
  VisitorOidc: ['readers.visitorOidc', { redeemJwtPost: 'POST ~P/reader-auth/jwt', redeemJwtGet: 'GET ~P/reader-auth/jwt', start: 'GET ~P/visitor-oidc/start', callback: 'GET /public/visitor-oidc/callback', adopt: 'GET /public/visitor-oidc/adopt' }],
package/dist/schema.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  [diffend] Oversized file quarantined before diffing.
2
2
  name: package/dist/schema.d.ts
3
- size: 34806671 bytes
4
- sha256: ad8b4b08ed789898d232c8f742e55563b02a6789bdb25a43eb9e65987488709d
3
+ size: 34841872 bytes
4
+ sha256: ff12cb64f52387db657f9411da0e348276bf47a2a6ebbe7ff8b14875e453febf
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forumulate/sdk",
3
- "version": "0.11.4",
3
+ "version": "0.12.1",
4
4
  "description": "Typed TypeScript client for the Forumulate REST API.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://forumulate.com/reference",