@moltcms-sdk/client 0.2.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,107 @@
+# @moltcms-sdk/client
+
+Typed, authenticated client for the moltcms incremental-sync SSE endpoint.
+
+## Install
+
+```sh
+npm install @moltcms-sdk/client
+```
+
+## Usage
+
+`openSyncStream` uses `fetch`, not the native `EventSource`, so it can send the
+required Bearer API key. `onChange` may be asynchronous; changes are delivered
+one at a time and the completion cursor is not emitted until each handler has
+finished successfully.
+
+```ts
+import { openSyncStream, type DeliveryItem } from "@moltcms-sdk/client";
+
+const stream = openSyncStream<DeliveryItem>(
+	"https://api.example.com/tenants/tenant-id/sync",
+	{
+		onChange: async (item, seq) => {
+			await persistChange(item, seq);
+		},
+		onComplete: async (cursor) => {
+			await persistCursor(cursor);
+		},
+		onError: (message) => console.error("moltcms sync error:", message),
+		onTransportError: (error) => console.error("moltcms transport error:", error),
+	},
+	{
+		apiKey: process.env.MOLTCMS_READ_KEY!,
+		cursor: await loadCursor(),
+	},
+);
+
+```
+
+Call `stream.close()` only when the consumer is shutting down or the sync is no
+longer needed; it aborts the active request and disables reconnects.
+
+After an interrupted connection, the client reuses the last successfully
+handled change event id as `Last-Event-ID`. On the next fresh sync, pass the
+opaque cursor received by `onComplete` through the `cursor` option instead.
+
+The default `autoClose: true` stops the stream after a `sync-complete` or
+server `error` event. Set `autoClose: false` to reconnect after each completed
+cycle.
+
+## Generated, schema-safe items
+
+The API-key endpoint `GET /tenants/{tenant}/sync/schemas` exposes the current
+schema definitions. Generate an importable type module before compiling the
+consumer:
+
+```sh
+npx moltcms-sdk-codegen \
+	--sync-url https://api.example.com/tenants/tenant-id/sync \
+	--api-key "$MOLTCMS_READ_KEY" \
+	--output src/moltcms-schema.ts
+```
+
+Use the generated map with `openTypedSyncStream`:
+
+```ts
+import { openTypedSyncStream } from "@moltcms-sdk/client";
+import {
+	schemaVersions,
+	type MoltcmsSchemas,
+} from "./moltcms-schema.js";
+
+openTypedSyncStream<MoltcmsSchemas>(
+	"https://api.example.com/tenants/tenant-id/sync",
+	{
+		onChange: async (item) => {
+			if (item.type === "content" && item.content_type === "post") {
+				await persistPost(item.data.title);
+			}
+		},
+	},
+	{
+		apiKey: process.env.MOLTCMS_READ_KEY!,
+		schemaVersions,
+	},
+);
+```
+
+For every content item, the client retrieves and validates the exact
+`(content_type, schema_version)` before calling `onChange`. A version absent
+from the generated module fails closed; regenerate after a schema change before
+accepting data written with that version. The API intentionally does not cast
+old content to the latest schema.
+
+## Publishing
+
+Pushing a tag named `v<package.json version>` runs the release workflow. Before
+the first release, configure npm Trusted Publishing with:
+
+- Package: `@moltcms-sdk/client`
+- Organization: `smartcrabai`
+- Repository: `moltcms-sdk`
+- Workflow filename: `release.yml`
+- Environment: leave empty
+
+The workflow publishes with npm provenance.

package/dist/codegen.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import type { ContentSchema } from "./types.js";
+/** Renders an importable TypeScript schema map from moltcms schema metadata. */
+export declare function generateSchemaTypes(schemas: readonly ContentSchema[]): string;

package/dist/codegen.js

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+import { writeFile } from "node:fs/promises";
+import { pathToFileURL } from "node:url";
+import { fetchSyncSchemas } from "./schema-client.js";
+/** Renders an importable TypeScript schema map from moltcms schema metadata. */
+export function generateSchemaTypes(schemas) {
+    const ordered = [...schemas].sort((left, right) => left.content_type.localeCompare(right.content_type));
+    const schemaBlocks = ordered.map(renderSchema).join("\n");
+    const versions = Object.fromEntries(ordered.map((schema) => [schema.content_type, [schema.version]]));
+    return `// Generated by @moltcms-sdk/client. Do not edit.\nimport type { SchemaVersionIndex } from "@moltcms-sdk/client";\n\nexport interface MoltcmsSchemas {\n${schemaBlocks}}\n\nexport const schemaVersions = ${JSON.stringify(versions, null, "\t")} as const satisfies SchemaVersionIndex<MoltcmsSchemas>;\n`;
+}
+function renderSchema(schema) {
+    const fields = schema.fields.map(renderField).join("\n");
+    return `\t${JSON.stringify(schema.content_type)}: {\n\t\t${schema.version}: {\n${fields}\n\t\t};\n\t};\n`;
+}
+function renderField(field) {
+    const property = JSON.stringify(field.name);
+    const value = renderFieldValue(field);
+    const definition = field.required
+        ? `${property}: ${value}`
+        : `${property}?: ${value} | null`;
+    return `\t\t\t${definition};`;
+}
+function renderFieldValue(field) {
+    switch (field.kind) {
+        case "string":
+        case "text":
+        case "datetime":
+            return "string";
+        case "number":
+            return "number";
+        case "boolean":
+            return "boolean";
+        case "image":
+        case "relation":
+            return field.multiple ? "string[]" : "string";
+        case "select": {
+            const options = field.options
+                .map((option) => JSON.stringify(option))
+                .join(" | ");
+            const value = options.length === 0 ? "never" : options;
+            return field.multiple ? `(${value})[]` : value;
+        }
+        case "richtext":
+        case "json":
+            return "unknown";
+    }
+}
+async function main() {
+    const args = parseArguments(process.argv.slice(2));
+    const schemas = await fetchSyncSchemas(args.syncUrl, { apiKey: args.apiKey });
+    await writeFile(args.output, generateSchemaTypes(schemas));
+}
+function parseArguments(args) {
+    const values = {};
+    for (let index = 0; index < args.length; index += 2) {
+        const option = args[index];
+        const value = args[index + 1];
+        if (option === undefined ||
+            value === undefined ||
+            !option.startsWith("--")) {
+            throw new TypeError("Usage: moltcms-sdk-codegen --sync-url <url> --api-key <key> --output <file>");
+        }
+        values[option.slice(2)] = value;
+    }
+    const syncUrl = values["sync-url"];
+    const apiKey = values["api-key"];
+    const output = values.output;
+    if (syncUrl === undefined || apiKey === undefined || output === undefined) {
+        throw new TypeError("Usage: moltcms-sdk-codegen --sync-url <url> --api-key <key> --output <file>");
+    }
+    return { syncUrl, apiKey, output };
+}
+if (process.argv[1] !== undefined &&
+    import.meta.url === pathToFileURL(process.argv[1]).href) {
+    main().catch((error) => {
+        console.error(error);
+        process.exitCode = 1;
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { openSyncStream, SyncHttpError } from "./sync-stream.js";
+export type { SyncStream, SyncStreamHandlers, SyncStreamOptions, SyncFetch, } from "./sync-stream.js";
+export { fetchSyncSchemas, fetchSyncSchemaVersion, schemaCollectionUrl, SyncSchemaHttpError, } from "./schema-client.js";
+export type { SyncSchemaRequestOptions } from "./schema-client.js";
+export { openTypedSyncStream, SyncItemValidationError, UnknownGeneratedSchemaVersionError, } from "./typed-sync-stream.js";
+export type { SchemaTypeMap, SchemaVersionIndex, TypedDeliveryItem, TypedSyncStreamHandlers, TypedSyncStreamOptions, } from "./typed-sync-stream.js";
+export type { ContentChange, ContentDeleted, ContentSchema, ContentType, DeliveryItem, FieldDef, FieldType, SchemaChanged, } from "./types.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { openSyncStream, SyncHttpError } from "./sync-stream.js";
+export { fetchSyncSchemas, fetchSyncSchemaVersion, schemaCollectionUrl, SyncSchemaHttpError, } from "./schema-client.js";
+export { openTypedSyncStream, SyncItemValidationError, UnknownGeneratedSchemaVersionError, } from "./typed-sync-stream.js";

package/dist/schema-client.d.ts

@@ -0,0 +1,22 @@
+import type { ContentSchema } from "./types.js";
+import type { SyncFetch } from "./sync-stream.js";
+export interface SyncSchemaRequestOptions {
+    /** Read-only API key sent as `Authorization: Bearer <apiKey>`. */
+    apiKey: string;
+    /** Overrides the transport, for example to instrument requests. */
+    fetch?: SyncFetch;
+    /** Cancels the schema request when aborted. */
+    signal?: AbortSignal;
+}
+/** An unsuccessful HTTP response while retrieving schema metadata. */
+export declare class SyncSchemaHttpError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    constructor(response: Response);
+}
+/** Retrieves the current schema for each content type accessible to this API key. */
+export declare function fetchSyncSchemas(syncUrl: string, options: SyncSchemaRequestOptions): Promise<ContentSchema[]>;
+/** Retrieves the schema whose version exactly matches a sync content item. */
+export declare function fetchSyncSchemaVersion(syncUrl: string, contentType: string, version: number, options: SyncSchemaRequestOptions): Promise<ContentSchema>;
+/** Derives the API-key schema collection endpoint from a `/sync` endpoint URL. */
+export declare function schemaCollectionUrl(syncUrl: string): URL;

package/dist/schema-client.js

@@ -0,0 +1,52 @@
+/** An unsuccessful HTTP response while retrieving schema metadata. */
+export class SyncSchemaHttpError extends Error {
+    status;
+    statusText;
+    constructor(response) {
+        super(`Sync schema request failed with HTTP ${response.status} ${response.statusText}`);
+        this.name = "SyncSchemaHttpError";
+        this.status = response.status;
+        this.statusText = response.statusText;
+    }
+}
+/** Retrieves the current schema for each content type accessible to this API key. */
+export async function fetchSyncSchemas(syncUrl, options) {
+    return requestSchemaJson(schemaCollectionUrl(syncUrl), options);
+}
+/** Retrieves the schema whose version exactly matches a sync content item. */
+export async function fetchSyncSchemaVersion(syncUrl, contentType, version, options) {
+    if (!Number.isSafeInteger(version) || version < 1) {
+        throw new RangeError("Schema version must be a positive safe integer");
+    }
+    const url = schemaCollectionUrl(syncUrl);
+    url.pathname += `/${encodeURIComponent(contentType)}/${version}`;
+    return requestSchemaJson(url, options);
+}
+/** Derives the API-key schema collection endpoint from a `/sync` endpoint URL. */
+export function schemaCollectionUrl(syncUrl) {
+    const base = typeof location === "undefined" ? undefined : location.href;
+    const url = new URL(syncUrl, base);
+    if (!url.pathname.endsWith("/sync")) {
+        throw new TypeError("The sync URL must end with /sync");
+    }
+    url.pathname += "/schemas";
+    url.search = "";
+    url.hash = "";
+    return url;
+}
+async function requestSchemaJson(url, options) {
+    if (options.apiKey.length === 0) {
+        throw new TypeError("SyncSchemaRequestOptions.apiKey must not be empty");
+    }
+    const request = options.fetch ?? globalThis.fetch;
+    const response = await request(url, {
+        headers: {
+            accept: "application/json",
+            authorization: `Bearer ${options.apiKey}`,
+        },
+        signal: options.signal,
+    });
+    if (!response.ok)
+        throw new SyncSchemaHttpError(response);
+    return (await response.json());
+}

package/dist/sync-stream.d.ts

@@ -0,0 +1,49 @@
+import type { DeliveryItem } from "./types.js";
+/** A fetch implementation used to open the sync stream. */
+export type SyncFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+export interface SyncStreamHandlers<Item> {
+    /** A content or schema change. `seq` is the raw SSE event id. */
+    onChange: (item: Item, seq: string) => void | Promise<void>;
+    /** The feed is fully drained; persist this opaque cursor for the next run. */
+    onComplete?: (cursor: string) => void | Promise<void>;
+    /** A server-sent `error` event. */
+    onError?: (message: string) => void | Promise<void>;
+    /** Network, HTTP-status, malformed-payload, or consumer-handler failures. */
+    onTransportError?: (error: unknown) => void | Promise<void>;
+}
+export interface SyncStreamOptions {
+    /** Read-only API key sent as `Authorization: Bearer <apiKey>`. */
+    apiKey: string;
+    /** Opaque cursor from the preceding `sync-complete` event. */
+    cursor?: string;
+    /** Selects the published (default) or draft feed. */
+    kind?: "published" | "draft";
+    /** Stops after `sync-complete` or server `error`; defaults to `true`. */
+    autoClose?: boolean;
+    /** Cancels the stream when aborted. */
+    signal?: AbortSignal;
+    /** Overrides the transport, for example to instrument requests. */
+    fetch?: SyncFetch;
+}
+export interface SyncStream {
+    /** Stops the request and prevents any reconnect. Idempotent. */
+    close: () => void;
+    /** Whether this client has been closed. */
+    readonly closed: boolean;
+}
+/** An unsuccessful HTTP response while opening the sync feed. */
+export declare class SyncHttpError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    constructor(response: Response);
+}
+/**
+ * Opens an authenticated, reconnecting client for a moltcms `/sync` SSE feed.
+ *
+ * `fetch` is used instead of `EventSource` because the moltcms endpoint
+ * requires a Bearer API key, which the browser's native EventSource cannot
+ * attach. After an interrupted connection the client sends the most recent
+ * `change` event id in `Last-Event-ID`; that header takes precedence over a
+ * supplied cursor on the server.
+ */
+export declare function openSyncStream<Item = DeliveryItem>(syncUrl: string, handlers: SyncStreamHandlers<Item>, options: SyncStreamOptions): SyncStream;

package/dist/sync-stream.js

@@ -0,0 +1,235 @@
+/** An unsuccessful HTTP response while opening the sync feed. */
+export class SyncHttpError extends Error {
+    status;
+    statusText;
+    constructor(response) {
+        super(`Sync request failed with HTTP ${response.status} ${response.statusText}`);
+        this.name = "SyncHttpError";
+        this.status = response.status;
+        this.statusText = response.statusText;
+    }
+}
+const DEFAULT_RETRY_MILLISECONDS = 3_000;
+/**
+ * Opens an authenticated, reconnecting client for a moltcms `/sync` SSE feed.
+ *
+ * `fetch` is used instead of `EventSource` because the moltcms endpoint
+ * requires a Bearer API key, which the browser's native EventSource cannot
+ * attach. After an interrupted connection the client sends the most recent
+ * `change` event id in `Last-Event-ID`; that header takes precedence over a
+ * supplied cursor on the server.
+ */
+export function openSyncStream(syncUrl, handlers, options) {
+    if (options.apiKey.length === 0) {
+        throw new TypeError("SyncStreamOptions.apiKey must not be empty");
+    }
+    const base = typeof location === "undefined" ? undefined : location.href;
+    const url = new URL(syncUrl, base);
+    if (options.cursor !== undefined)
+        url.searchParams.set("cursor", options.cursor);
+    if (options.kind !== undefined)
+        url.searchParams.set("kind", options.kind);
+    const shutdown = new AbortController();
+    const request = options.fetch ?? globalThis.fetch;
+    const autoClose = options.autoClose ?? true;
+    let activeRequest;
+    let closed = false;
+    let lastEventId;
+    let retryMilliseconds = DEFAULT_RETRY_MILLISECONDS;
+    const close = () => {
+        if (closed)
+            return;
+        closed = true;
+        activeRequest?.abort();
+        shutdown.abort();
+    };
+    const stopForExternalAbort = () => close();
+    if (options.signal !== undefined) {
+        if (options.signal.aborted)
+            close();
+        else
+            options.signal.addEventListener("abort", stopForExternalAbort, {
+                once: true,
+            });
+    }
+    void consume();
+    return {
+        close,
+        get closed() {
+            return closed;
+        },
+    };
+    async function consume() {
+        while (!closed) {
+            const controller = new AbortController();
+            activeRequest = controller;
+            const abortFromShutdown = () => controller.abort();
+            shutdown.signal.addEventListener("abort", abortFromShutdown, {
+                once: true,
+            });
+            try {
+                const response = await request(url, {
+                    headers: syncHeaders(options.apiKey, lastEventId),
+                    signal: controller.signal,
+                });
+                if (!response.ok) {
+                    close();
+                    await handlers.onTransportError?.(new SyncHttpError(response));
+                    return;
+                }
+                if (response.body === null) {
+                    throw new TypeError("Sync response did not include a body");
+                }
+                await parseSse(response.body, {
+                    onMessage: async (message) => {
+                        if (!closed)
+                            await handleMessage(message);
+                    },
+                    onRetry: (milliseconds) => {
+                        retryMilliseconds = milliseconds;
+                    },
+                });
+            }
+            catch (error) {
+                if (!closed)
+                    await handlers.onTransportError?.(error);
+            }
+            finally {
+                shutdown.signal.removeEventListener("abort", abortFromShutdown);
+                if (activeRequest === controller)
+                    activeRequest = undefined;
+            }
+            if (!closed)
+                await delay(retryMilliseconds, shutdown.signal);
+        }
+    }
+    async function handleMessage(message) {
+        switch (message.event) {
+            case "change": {
+                try {
+                    const item = JSON.parse(message.data);
+                    await handlers.onChange(item, message.id ?? "");
+                    if (message.id !== undefined)
+                        lastEventId = message.id;
+                }
+                catch (error) {
+                    // A failed consumer has not durably handled this change. Do not
+                    // accept the completion cursor or advance Last-Event-ID past it.
+                    close();
+                    await handlers.onTransportError?.(error);
+                }
+                break;
+            }
+            case "sync-complete": {
+                try {
+                    const cursor = JSON.parse(message.data);
+                    if (typeof cursor !== "string") {
+                        throw new TypeError("sync-complete data must be a JSON string");
+                    }
+                    if (autoClose)
+                        close();
+                    await handlers.onComplete?.(cursor);
+                }
+                catch (error) {
+                    close();
+                    await handlers.onTransportError?.(error);
+                }
+                break;
+            }
+            case "error":
+                if (autoClose)
+                    close();
+                await handlers.onError?.(message.data);
+                break;
+            default:
+                break;
+        }
+    }
+}
+function syncHeaders(apiKey, lastEventId) {
+    const headers = new Headers({
+        accept: "text/event-stream",
+        authorization: `Bearer ${apiKey}`,
+    });
+    if (lastEventId !== undefined && lastEventId.length > 0) {
+        headers.set("last-event-id", lastEventId);
+    }
+    return headers;
+}
+async function parseSse(body, callbacks) {
+    const reader = body.getReader();
+    const decoder = new TextDecoder();
+    let buffer = "";
+    let event = "message";
+    let data = [];
+    let id;
+    const dispatch = async () => {
+        if (data.length > 0) {
+            await callbacks.onMessage({ event, data: data.join("\n"), id });
+        }
+        event = "message";
+        data = [];
+        id = undefined;
+    };
+    const processLine = async (line) => {
+        if (line.length === 0) {
+            await dispatch();
+            return;
+        }
+        if (line.startsWith(":"))
+            return;
+        const separator = line.indexOf(":");
+        const field = separator === -1 ? line : line.slice(0, separator);
+        const valueStart = separator === -1 ? line.length : separator + 1;
+        const value = line.charAt(valueStart) === " "
+            ? line.slice(valueStart + 1)
+            : line.slice(valueStart);
+        switch (field) {
+            case "event":
+                event = value;
+                break;
+            case "data":
+                data.push(value);
+                break;
+            case "id":
+                if (!value.includes("\0"))
+                    id = value;
+                break;
+            case "retry": {
+                if (/^\d+$/.test(value))
+                    callbacks.onRetry(Number(value));
+                break;
+            }
+            default:
+                break;
+        }
+    };
+    try {
+        while (true) {
+            const chunk = await reader.read();
+            if (chunk.done)
+                return;
+            buffer += decoder.decode(chunk.value, { stream: true });
+            let newline = buffer.indexOf("\n");
+            while (newline !== -1) {
+                const line = buffer.slice(0, newline).replace(/\r$/, "");
+                buffer = buffer.slice(newline + 1);
+                await processLine(line);
+                newline = buffer.indexOf("\n");
+            }
+        }
+    }
+    finally {
+        reader.releaseLock();
+    }
+}
+function delay(milliseconds, signal) {
+    const { promise, resolve } = Promise.withResolvers();
+    const timer = setTimeout(resolve, milliseconds);
+    const abort = () => {
+        clearTimeout(timer);
+        resolve();
+    };
+    signal.addEventListener("abort", abort, { once: true });
+    return promise.finally(() => signal.removeEventListener("abort", abort));
+}

package/dist/typed-sync-stream.d.ts

@@ -0,0 +1,55 @@
+import { type SyncStream, type SyncStreamOptions } from "./sync-stream.js";
+import type { ContentChange, ContentDeleted, SchemaChanged } from "./types.js";
+/**
+ * A generated mapping from content-type literals to exact schema-version data
+ * shapes. It intentionally has no string index signature so TypeScript keeps
+ * each generated content type as a discriminant.
+ */
+export type SchemaTypeMap = object;
+/** Runtime counterpart of generated schema versions, coupled to `S`. */
+export type SchemaVersionIndex<S extends SchemaTypeMap> = {
+    readonly [ContentType in keyof S & string]: readonly (keyof S[ContentType] & number)[];
+};
+type TypedContentChange<S extends SchemaTypeMap> = {
+    [C in keyof S & string]: {
+        [V in keyof S[C] & number]: Omit<ContentChange, "content_type" | "schema_version" | "data"> & {
+            content_type: C;
+            schema_version: V;
+            data: S[C][V];
+        };
+    }[keyof S[C] & number];
+}[keyof S & string];
+type TypedContentDeleted<S extends SchemaTypeMap> = Omit<ContentDeleted, "content_type"> & {
+    content_type: keyof S & string;
+};
+/** A sync item narrowed to the content types and schema versions generated for `S`. */
+export type TypedDeliveryItem<S extends SchemaTypeMap> = TypedContentChange<S> | TypedContentDeleted<S> | SchemaChanged;
+export interface TypedSyncStreamHandlers<S extends SchemaTypeMap> {
+    /** A validated item whose content data has the exact generated schema type. */
+    onChange: (item: TypedDeliveryItem<S>, seq: string) => void | Promise<void>;
+    onComplete?: (cursor: string) => void | Promise<void>;
+    onError?: (message: string) => void | Promise<void>;
+    onTransportError?: (error: unknown) => void | Promise<void>;
+}
+export interface TypedSyncStreamOptions<S extends SchemaTypeMap> extends SyncStreamOptions {
+    /** Versions emitted by the generated schema module. Unknown versions are rejected. */
+    schemaVersions: SchemaVersionIndex<S>;
+}
+/** A schema version was not present in the generated type module. */
+export declare class UnknownGeneratedSchemaVersionError extends Error {
+    constructor(contentType: string, version: number);
+}
+/** A received content item did not conform to its exact moltcms schema version. */
+export declare class SyncItemValidationError extends Error {
+    constructor(message: string);
+}
+/**
+ * Opens a schema-validated sync stream.
+ *
+ * This function fetches and caches the exact `(content_type, schema_version)`
+ * definition for each content item. The generated `schemaVersions` index is
+ * checked first, so an item written against a version absent from generated
+ * TypeScript types fails closed instead of being cast to the latest schema.
+ */
+export declare function openTypedSyncStream<S extends SchemaTypeMap>(syncUrl: string, handlers: TypedSyncStreamHandlers<S>, options: TypedSyncStreamOptions<S>): SyncStream;
+export {};

package/dist/typed-sync-stream.js

@@ -0,0 +1,146 @@
+import { fetchSyncSchemaVersion, } from "./schema-client.js";
+import { openSyncStream, } from "./sync-stream.js";
+/** A schema version was not present in the generated type module. */
+export class UnknownGeneratedSchemaVersionError extends Error {
+    constructor(contentType, version) {
+        super(`No generated schema exists for content type ${contentType} version ${version}`);
+        this.name = "UnknownGeneratedSchemaVersionError";
+    }
+}
+/** A received content item did not conform to its exact moltcms schema version. */
+export class SyncItemValidationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "SyncItemValidationError";
+    }
+}
+/**
+ * Opens a schema-validated sync stream.
+ *
+ * This function fetches and caches the exact `(content_type, schema_version)`
+ * definition for each content item. The generated `schemaVersions` index is
+ * checked first, so an item written against a version absent from generated
+ * TypeScript types fails closed instead of being cast to the latest schema.
+ */
+export function openTypedSyncStream(syncUrl, handlers, options) {
+    const schemas = new Map();
+    const runtimeSchemaVersions = options.schemaVersions;
+    const schemaOptions = {
+        apiKey: options.apiKey,
+        fetch: options.fetch,
+        signal: options.signal,
+    };
+    return openSyncStream(syncUrl, {
+        onChange: async (item, seq) => {
+            if (item.type === "content") {
+                const schema = await schemaFor(item.content_type, item.schema_version);
+                validateContentItem(item, schema);
+            }
+            await handlers.onChange(item, seq);
+        },
+        onComplete: handlers.onComplete,
+        onError: handlers.onError,
+        onTransportError: handlers.onTransportError,
+    }, options);
+    function schemaFor(contentType, version) {
+        if (!runtimeSchemaVersions[contentType]?.includes(version)) {
+            throw new UnknownGeneratedSchemaVersionError(contentType, version);
+        }
+        const key = `${contentType}\u0000${version}`;
+        let schema = schemas.get(key);
+        if (schema === undefined) {
+            schema = fetchSyncSchemaVersion(syncUrl, contentType, version, schemaOptions);
+            schemas.set(key, schema);
+        }
+        return schema;
+    }
+}
+function validateContentItem(item, schema) {
+    if (schema.content_type !== item.content_type ||
+        schema.version !== item.schema_version) {
+        throw new SyncItemValidationError(`Schema response does not match ${item.content_type} version ${item.schema_version}`);
+    }
+    const fields = new Map(schema.fields.map((field) => [field.name, field]));
+    for (const name of Object.keys(item.data)) {
+        if (!fields.has(name)) {
+            throw new SyncItemValidationError(`Unknown field ${name} in ${item.content_type}`);
+        }
+    }
+    for (const field of schema.fields)
+        validateField(item.data[field.name], field);
+}
+function validateField(value, field) {
+    if (value === undefined || value === null) {
+        if (field.required) {
+            throw new SyncItemValidationError(`Required field ${field.name} is missing`);
+        }
+        return;
+    }
+    const invalid = () => {
+        throw new SyncItemValidationError(`Field ${field.name} has an invalid value`);
+    };
+    switch (field.kind) {
+        case "string": {
+            if (typeof value !== "string")
+                invalid();
+            const stringValue = value;
+            const maxLength = "max_len" in field ? field.max_len : undefined;
+            if (maxLength !== undefined &&
+                maxLength !== null &&
+                stringValue.length > maxLength) {
+                invalid();
+            }
+            break;
+        }
+        case "text":
+        case "datetime":
+            if (typeof value !== "string")
+                invalid();
+            break;
+        case "number": {
+            if (typeof value !== "number" || !Number.isFinite(value))
+                invalid();
+            const numberValue = value;
+            const minimum = "min" in field ? field.min : undefined;
+            const maximum = "max" in field ? field.max : undefined;
+            if (minimum !== undefined && minimum !== null && numberValue < minimum)
+                invalid();
+            if (maximum !== undefined && maximum !== null && numberValue > maximum)
+                invalid();
+            if (field.integer && !Number.isInteger(numberValue))
+                invalid();
+            break;
+        }
+        case "boolean":
+            if (typeof value !== "boolean")
+                invalid();
+            break;
+        case "image":
+        case "relation": {
+            const multiple = "multiple" in field && field.multiple === true;
+            if (multiple) {
+                if (!Array.isArray(value) ||
+                    value.some((item) => typeof item !== "string")) {
+                    invalid();
+                }
+            }
+            else if (typeof value !== "string") {
+                invalid();
+            }
+            break;
+        }
+        case "select": {
+            const multiple = "multiple" in field && field.multiple === true;
+            const options = "options" in field ? field.options : [];
+            const selected = multiple ? value : [value];
+            if (!Array.isArray(selected) ||
+                selected.some((option) => typeof option !== "string" || !options.includes(option))) {
+                invalid();
+            }
+            break;
+        }
+        case "richtext":
+        case "json":
+            break;
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,71 @@
+/** The name of a content type within a moltcms tenant. */
+export type ContentType = string;
+/** A field declaration in a content schema. */
+export type FieldType = {
+    kind: "string";
+    max_len?: number | null;
+} | {
+    kind: "text";
+} | {
+    kind: "richtext";
+} | {
+    kind: "number";
+    integer?: boolean;
+    min?: number | null;
+    max?: number | null;
+} | {
+    kind: "boolean";
+} | {
+    kind: "datetime";
+} | {
+    kind: "image";
+    multiple?: boolean;
+} | {
+    kind: "relation";
+    multiple?: boolean;
+    target: ContentType;
+} | {
+    kind: "select";
+    multiple?: boolean;
+    options: string[];
+} | {
+    kind: "json";
+};
+/** A named field in a content schema. */
+export type FieldDef = FieldType & {
+    name: string;
+    required?: boolean;
+};
+/** A complete, immutable version of one content type's schema. */
+export interface ContentSchema {
+    content_type: ContentType;
+    version: number;
+    fields: FieldDef[];
+}
+/** The current state of a content entity. */
+export interface ContentChange {
+    type: "content";
+    content_type: ContentType;
+    id: string;
+    seq: number;
+    schema_version: number;
+    /** Field values are defined by the content type's schema. */
+    data: Record<string, unknown>;
+}
+/** A content entity that must be removed from a local projection. */
+export interface ContentDeleted {
+    type: "content_deleted";
+    content_type: ContentType;
+    id: string;
+    seq: number;
+}
+/** A versioned content-schema definition. */
+export interface SchemaChanged {
+    type: "schema_changed";
+    content_type: ContentType;
+    seq: number;
+    version: number;
+    fields: FieldDef[];
+}
+/** One item sent in a `change` event on the sync feed. */
+export type DeliveryItem = ContentChange | ContentDeleted | SchemaChanged;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "@moltcms-sdk/client",
+	"version": "0.2.1",
+	"description": "Typed, authenticated Server-Sent Events client for moltcms incremental sync.",
+	"license": "Apache-2.0",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"bin": {
+		"moltcms-sdk-codegen": "./dist/codegen.js"
+	},
+	"files": [
+		"dist"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		}
+	},
+	"scripts": {
+		"build": "tsc -p tsconfig.build.json",
+		"check": "tsc -p tsconfig.build.json --noEmit && tsc -p tsconfig.test.json",
+		"test": "bun test",
+		"fmt": "biome format .",
+		"fmt:fix": "biome format --write .",
+		"lint": "oxlint .",
+		"lint:fix": "oxlint --fix .",
+		"prepublishOnly": "bun run check && bun run build"
+	},
+	"publishConfig": {
+		"access": "public",
+		"registry": "https://registry.npmjs.org"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/smartcrabai/moltcms-sdk.git"
+	},
+	"keywords": [
+		"moltcms",
+		"sse",
+		"sync",
+		"typescript"
+	],
+	"engines": {
+		"node": ">=22"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "2.5.3",
+		"@types/bun": "latest",
+		"oxlint": "1.73.0",
+		"typescript": "^5.9.3"
+	}
+}