velocious 1.0.501 → 1.0.503

package/build/src/sync/sync-publisher-types.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Args resolved against a publish declaration's broadcasts after a published
+ * server-side mutation commits.
+ */
+export type SyncPublishBroadcastArgs = {
+    /**
+     * - Payload snapshotted through the declaration's `serialize(record)` at mutation time.
+     */
+    data: Record<string, unknown>;
+    /**
+     * - Mutation operation that published.
+     */
+    operation: "create" | "update" | "destroy";
+    /**
+     * - Mutated server model record.
+     */
+    record: unknown;
+    /**
+     * - Published resource id.
+     */
+    resourceId: string;
+    /**
+     * - Published resource type.
+     */
+    resourceType: string;
+    /**
+     * - Upserted sync/change row.
+     */
+    syncRow: unknown;
+    /**
+     * - Published sync type ("update" for creates/updates, "delete" for destroys).
+     */
+    syncType: string;
+};
+/**
+ * One declarative broadcast fanned out after a published server-side mutation
+ * commits — same shape the replay service's injected broadcaster consumes.
+ */
+export type SyncPublishBroadcast = {
+    /**
+     * - Channel name or resolver.
+     */
+    channel: string | ((args: SyncPublishBroadcastArgs) => string);
+    /**
+     * - Channel routing params.
+     */
+    broadcastParams: (args: SyncPublishBroadcastArgs) => Record<string, unknown>;
+    /**
+     * - Broadcast body.
+     */
+    body: (args: SyncPublishBroadcastArgs) => unknown;
+    /**
+     * - Optional gate; skipped when it returns false.
+     */
+    when?: ((args: SyncPublishBroadcastArgs) => boolean) | undefined;
+};
+/**
+ * Server-side publish declaration on a model's `static sync`, consumed by
+ * `SyncPublisher.fromConfiguration(...)`. Publishing is on for models
+ * declaring it (server-side creates and updates write to the sync change
+ * feed and broadcast automatically once their transaction commits);
+ * `publish: false` opts a model out explicitly.
+ */
+export type SyncPublishDeclarationConfig = {
+    /**
+     * - Builds the published payload snapshot from the mutated record (snapshotted at mutation time).
+     */
+    serialize: (record: unknown) => Record<string, unknown> | Promise<Record<string, unknown>>;
+    /**
+     * - Resolves the event scope persisted to the sync row's event_id column.
+     */
+    eventId?: ((record: unknown) => string | number | null | Promise<string | number | null>) | undefined;
+    /**
+     * - Declarative broadcasts fanned out after the sync row is upserted.
+     */
+    broadcasts?: SyncPublishBroadcast[] | undefined;
+    /**
+     * - Published operations. Defaults to creates and updates; destroys are opt-in because a server destroy is often cleanup rather than a synced delete.
+     */
+    operations?: ("update" | "destroy" | "create")[] | undefined;
+    /**
+     * - Published resource type. Defaults to the model name.
+     */
+    resourceType?: string | undefined;
+};
+export type SyncPublishDeclaration = false | SyncPublishDeclarationConfig;
+/**
+ * Options for building a sync publisher. Published resources are derived from
+ * the configuration's registered models (`static sync` publish declarations).
+ */
+export type SyncPublisherOptions = {
+    /**
+     * - Sync model column linking rows to a device actor. Published server-origin rows set it to null (no device to echo). Defaults to "authentication_token_id".
+     */
+    actorForeignKeyColumn?: string | undefined;
+    /**
+     * - Delivers declared broadcasts. Defaults to the configuration's channel broadcast.
+     */
+    broadcaster?: ((broadcast: {
+        channel: string;
+        params: Record<string, unknown>;
+        body: unknown;
+    }) => Promise<void>) | undefined;
+    /**
+     * - Configuration owning the registered models. Defaults to the current configuration.
+     */
+    configuration?: import("../configuration.js").default | undefined;
+    /**
+     * - Reports post-commit publish failures. Defaults to loud logging.
+     */
+    onError?: ((error: Error) => void) | undefined;
+    /**
+     * - Sync/change model override. Defaults to the registered "Sync" model.
+     */
+    syncModel?: unknown;
+};
+/**
+ * Internal derived publish policy for one resource — not an app-facing API.
+ */
+export type SyncPublisherResourceConfig = {
+    /**
+     * - Declared broadcasts.
+     */
+    broadcasts: SyncPublishBroadcast[] | undefined;
+    /**
+     * - Event scope resolver.
+     */
+    eventId: SyncPublishDeclarationConfig["eventId"] | undefined;
+    /**
+     * - Server model class for this resource.
+     */
+    modelClass: unknown;
+    /**
+     * - Published operations.
+     */
+    operations: Array<"create" | "update" | "destroy">;
+    /**
+     * - Published resource type.
+     */
+    resourceType: string;
+    /**
+     * - Payload snapshot builder.
+     */
+    serialize: SyncPublishDeclarationConfig["serialize"];
+};
+//# sourceMappingURL=sync-publisher-types.d.ts.map

package/build/src/sync/sync-publisher-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-publisher-types.d.ts","sourceRoot":"","sources":["../../../src/sync/sync-publisher-types.js"],"names":[],"mappings":";;;;;;;;UAMc,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC;;;;eACjB,QAAQ,GAAG,QAAQ,GAAG,SAAS;;;;YAC/B,OAAC;;;;gBACD,MAAM;;;;kBACN,MAAM;;;;aACN,OAAC;;;;cACD,MAAM;;;;;;;;;;aAON,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,wBAAwB,KAAK,MAAM,CAAC;;;;qBACrD,CAAC,IAAI,EAAE,wBAAwB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC;;;;UACrD,CAAC,IAAI,EAAE,wBAAwB,KAAK,OAAC;;;;mBAC9B,wBAAwB,KAAK,OAAO;;;;;;;;;;;;;eAU3C,CAAC,MAAM,EAAE,OAAC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAAC;;;;wBACpD,OAAC,KAAK,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;;;;;;;;;;;;;;qCAMvE,KAAK,GAAG,4BAA4B;;;;;;;;;;;;;+BAOxB;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAAC;QAAC,IAAI,EAAE,OAAC,CAAA;KAAC,KAAK,OAAO,CAAC,IAAI,CAAC;;;;;;;;uBAE3E,KAAK,KAAK,IAAI;;;;gBACtB,OAAC;;;;;;;;;gBAMD,oBAAoB,EAAE,GAAG,SAAS;;;;aAClC,4BAA4B,CAAC,SAAS,CAAC,GAAG,SAAS;;;;gBACnD,OAAC;;;;gBACD,KAAK,CAAC,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;;;;kBACtC,MAAM;;;;eACN,4BAA4B,CAAC,WAAW,CAAC"}

package/build/src/sync/sync-publisher-types.js

@@ -0,0 +1,3 @@
+// @ts-check
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3luYy1wdWJsaXNoZXItdHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc3luYy9zeW5jLXB1Ymxpc2hlci10eXBlcy5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxZQUFZIiwic291cmNlc0NvbnRlbnQiOlsiLy8gQHRzLWNoZWNrXG5cbi8qKlxuICogQXJncyByZXNvbHZlZCBhZ2FpbnN0IGEgcHVibGlzaCBkZWNsYXJhdGlvbidzIGJyb2FkY2FzdHMgYWZ0ZXIgYSBwdWJsaXNoZWRcbiAqIHNlcnZlci1zaWRlIG11dGF0aW9uIGNvbW1pdHMuXG4gKiBAdHlwZWRlZiB7b2JqZWN0fSBTeW5jUHVibGlzaEJyb2FkY2FzdEFyZ3NcbiAqIEBwcm9wZXJ0eSB7UmVjb3JkPHN0cmluZywgPz59IGRhdGEgLSBQYXlsb2FkIHNuYXBzaG90dGVkIHRocm91Z2ggdGhlIGRlY2xhcmF0aW9uJ3MgYHNlcmlhbGl6ZShyZWNvcmQpYCBhdCBtdXRhdGlvbiB0aW1lLlxuICogQHByb3BlcnR5IHtcImNyZWF0ZVwiIHwgXCJ1cGRhdGVcIiB8IFwiZGVzdHJveVwifSBvcGVyYXRpb24gLSBNdXRhdGlvbiBvcGVyYXRpb24gdGhhdCBwdWJsaXNoZWQuXG4gKiBAcHJvcGVydHkgez99IHJlY29yZCAtIE11dGF0ZWQgc2VydmVyIG1vZGVsIHJlY29yZC5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSByZXNvdXJjZUlkIC0gUHVibGlzaGVkIHJlc291cmNlIGlkLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IHJlc291cmNlVHlwZSAtIFB1Ymxpc2hlZCByZXNvdXJjZSB0eXBlLlxuICogQHByb3BlcnR5IHs/fSBzeW5jUm93IC0gVXBzZXJ0ZWQgc3luYy9jaGFuZ2Ugcm93LlxuICogQHByb3BlcnR5IHtzdHJpbmd9IHN5bmNUeXBlIC0gUHVibGlzaGVkIHN5bmMgdHlwZSAoXCJ1cGRhdGVcIiBmb3IgY3JlYXRlcy91cGRhdGVzLCBcImRlbGV0ZVwiIGZvciBkZXN0cm95cykuXG4gKi9cblxuLyoqXG4gKiBPbmUgZGVjbGFyYXRpdmUgYnJvYWRjYXN0IGZhbm5lZCBvdXQgYWZ0ZXIgYSBwdWJsaXNoZWQgc2VydmVyLXNpZGUgbXV0YXRpb25cbiAqIGNvbW1pdHMg4oCUIHNhbWUgc2hhcGUgdGhlIHJlcGxheSBzZXJ2aWNlJ3MgaW5qZWN0ZWQgYnJvYWRjYXN0ZXIgY29uc3VtZXMuXG4gKiBAdHlwZWRlZiB7b2JqZWN0fSBTeW5jUHVibGlzaEJyb2FkY2FzdFxuICogQHByb3BlcnR5IHtzdHJpbmcgfCAoKGFyZ3M6IFN5bmNQdWJsaXNoQnJvYWRjYXN0QXJncykgPT4gc3RyaW5nKX0gY2hhbm5lbCAtIENoYW5uZWwgbmFtZSBvciByZXNvbHZlci5cbiAqIEBwcm9wZXJ0eSB7KGFyZ3M6IFN5bmNQdWJsaXNoQnJvYWRjYXN0QXJncykgPT4gUmVjb3JkPHN0cmluZywgPz59IGJyb2FkY2FzdFBhcmFtcyAtIENoYW5uZWwgcm91dGluZyBwYXJhbXMuXG4gKiBAcHJvcGVydHkgeyhhcmdzOiBTeW5jUHVibGlzaEJyb2FkY2FzdEFyZ3MpID0+ID99IGJvZHkgLSBCcm9hZGNhc3QgYm9keS5cbiAqIEBwcm9wZXJ0eSB7KGFyZ3M6IFN5bmNQdWJsaXNoQnJvYWRjYXN0QXJncykgPT4gYm9vbGVhbn0gW3doZW5dIC0gT3B0aW9uYWwgZ2F0ZTsgc2tpcHBlZCB3aGVuIGl0IHJldHVybnMgZmFsc2UuXG4gKi9cblxuLyoqXG4gKiBTZXJ2ZXItc2lkZSBwdWJsaXNoIGRlY2xhcmF0aW9uIG9uIGEgbW9kZWwncyBgc3RhdGljIHN5bmNgLCBjb25zdW1lZCBieVxuICogYFN5bmNQdWJsaXNoZXIuZnJvbUNvbmZpZ3VyYXRpb24oLi4uKWAuIFB1Ymxpc2hpbmcgaXMgb24gZm9yIG1vZGVsc1xuICogZGVjbGFyaW5nIGl0IChzZXJ2ZXItc2lkZSBjcmVhdGVzIGFuZCB1cGRhdGVzIHdyaXRlIHRvIHRoZSBzeW5jIGNoYW5nZVxuICogZmVlZCBhbmQgYnJvYWRjYXN0IGF1dG9tYXRpY2FsbHkgb25jZSB0aGVpciB0cmFuc2FjdGlvbiBjb21taXRzKTtcbiAqIGBwdWJsaXNoOiBmYWxzZWAgb3B0cyBhIG1vZGVsIG91dCBleHBsaWNpdGx5LlxuICogQHR5cGVkZWYge29iamVjdH0gU3luY1B1Ymxpc2hEZWNsYXJhdGlvbkNvbmZpZ1xuICogQHByb3BlcnR5IHsocmVjb3JkOiA/KSA9PiBSZWNvcmQ8c3RyaW5nLCA/PiB8IFByb21pc2U8UmVjb3JkPHN0cmluZywgPz4+fSBzZXJpYWxpemUgLSBCdWlsZHMgdGhlIHB1Ymxpc2hlZCBwYXlsb2FkIHNuYXBzaG90IGZyb20gdGhlIG11dGF0ZWQgcmVjb3JkIChzbmFwc2hvdHRlZCBhdCBtdXRhdGlvbiB0aW1lKS5cbiAqIEBwcm9wZXJ0eSB7KHJlY29yZDogPykgPT4gc3RyaW5nIHwgbnVtYmVyIHwgbnVsbCB8IFByb21pc2U8c3RyaW5nIHwgbnVtYmVyIHwgbnVsbD59IFtldmVudElkXSAtIFJlc29sdmVzIHRoZSBldmVudCBzY29wZSBwZXJzaXN0ZWQgdG8gdGhlIHN5bmMgcm93J3MgZXZlbnRfaWQgY29sdW1uLlxuICogQHByb3BlcnR5IHtTeW5jUHVibGlzaEJyb2FkY2FzdFtdfSBbYnJvYWRjYXN0c10gLSBEZWNsYXJhdGl2ZSBicm9hZGNhc3RzIGZhbm5lZCBvdXQgYWZ0ZXIgdGhlIHN5bmMgcm93IGlzIHVwc2VydGVkLlxuICogQHByb3BlcnR5IHtBcnJheTxcImNyZWF0ZVwiIHwgXCJ1cGRhdGVcIiB8IFwiZGVzdHJveVwiPn0gW29wZXJhdGlvbnNdIC0gUHVibGlzaGVkIG9wZXJhdGlvbnMuIERlZmF1bHRzIHRvIGNyZWF0ZXMgYW5kIHVwZGF0ZXM7IGRlc3Ryb3lzIGFyZSBvcHQtaW4gYmVjYXVzZSBhIHNlcnZlciBkZXN0cm95IGlzIG9mdGVuIGNsZWFudXAgcmF0aGVyIHRoYW4gYSBzeW5jZWQgZGVsZXRlLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IFtyZXNvdXJjZVR5cGVdIC0gUHVibGlzaGVkIHJlc291cmNlIHR5cGUuIERlZmF1bHRzIHRvIHRoZSBtb2RlbCBuYW1lLlxuICovXG5cbi8qKiBAdHlwZWRlZiB7ZmFsc2UgfCBTeW5jUHVibGlzaERlY2xhcmF0aW9uQ29uZmlnfSBTeW5jUHVibGlzaERlY2xhcmF0aW9uICovXG5cbi8qKlxuICogT3B0aW9ucyBmb3IgYnVpbGRpbmcgYSBzeW5jIHB1Ymxpc2hlci4gUHVibGlzaGVkIHJlc291cmNlcyBhcmUgZGVyaXZlZCBmcm9tXG4gKiB0aGUgY29uZmlndXJhdGlvbidzIHJlZ2lzdGVyZWQgbW9kZWxzIChgc3RhdGljIHN5bmNgIHB1Ymxpc2ggZGVjbGFyYXRpb25zKS5cbiAqIEB0eXBlZGVmIHtvYmplY3R9IFN5bmNQdWJsaXNoZXJPcHRpb25zXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW2FjdG9yRm9yZWlnbktleUNvbHVtbl0gLSBTeW5jIG1vZGVsIGNvbHVtbiBsaW5raW5nIHJvd3MgdG8gYSBkZXZpY2UgYWN0b3IuIFB1Ymxpc2hlZCBzZXJ2ZXItb3JpZ2luIHJvd3Mgc2V0IGl0IHRvIG51bGwgKG5vIGRldmljZSB0byBlY2hvKS4gRGVmYXVsdHMgdG8gXCJhdXRoZW50aWNhdGlvbl90b2tlbl9pZFwiLlxuICogQHByb3BlcnR5IHsoYnJvYWRjYXN0OiB7Y2hhbm5lbDogc3RyaW5nLCBwYXJhbXM6IFJlY29yZDxzdHJpbmcsID8+LCBib2R5OiA/fSkgPT4gUHJvbWlzZTx2b2lkPn0gW2Jyb2FkY2FzdGVyXSAtIERlbGl2ZXJzIGRlY2xhcmVkIGJyb2FkY2FzdHMuIERlZmF1bHRzIHRvIHRoZSBjb25maWd1cmF0aW9uJ3MgY2hhbm5lbCBicm9hZGNhc3QuXG4gKiBAcHJvcGVydHkge2ltcG9ydChcIi4uL2NvbmZpZ3VyYXRpb24uanNcIikuZGVmYXVsdH0gW2NvbmZpZ3VyYXRpb25dIC0gQ29uZmlndXJhdGlvbiBvd25pbmcgdGhlIHJlZ2lzdGVyZWQgbW9kZWxzLiBEZWZhdWx0cyB0byB0aGUgY3VycmVudCBjb25maWd1cmF0aW9uLlxuICogQHByb3BlcnR5IHsoZXJyb3I6IEVycm9yKSA9PiB2b2lkfSBbb25FcnJvcl0gLSBSZXBvcnRzIHBvc3QtY29tbWl0IHB1Ymxpc2ggZmFpbHVyZXMuIERlZmF1bHRzIHRvIGxvdWQgbG9nZ2luZy5cbiAqIEBwcm9wZXJ0eSB7P30gW3N5bmNNb2RlbF0gLSBTeW5jL2NoYW5nZSBtb2RlbCBvdmVycmlkZS4gRGVmYXVsdHMgdG8gdGhlIHJlZ2lzdGVyZWQgXCJTeW5jXCIgbW9kZWwuXG4gKi9cblxuLyoqXG4gKiBJbnRlcm5hbCBkZXJpdmVkIHB1Ymxpc2ggcG9saWN5IGZvciBvbmUgcmVzb3VyY2Ug4oCUIG5vdCBhbiBhcHAtZmFjaW5nIEFQSS5cbiAqIEB0eXBlZGVmIHtvYmplY3R9IFN5bmNQdWJsaXNoZXJSZXNvdXJjZUNvbmZpZ1xuICogQHByb3BlcnR5IHtTeW5jUHVibGlzaEJyb2FkY2FzdFtdIHwgdW5kZWZpbmVkfSBicm9hZGNhc3RzIC0gRGVjbGFyZWQgYnJvYWRjYXN0cy5cbiAqIEBwcm9wZXJ0eSB7U3luY1B1Ymxpc2hEZWNsYXJhdGlvbkNvbmZpZ1tcImV2ZW50SWRcIl0gfCB1bmRlZmluZWR9IGV2ZW50SWQgLSBFdmVudCBzY29wZSByZXNvbHZlci5cbiAqIEBwcm9wZXJ0eSB7P30gbW9kZWxDbGFzcyAtIFNlcnZlciBtb2RlbCBjbGFzcyBmb3IgdGhpcyByZXNvdXJjZS5cbiAqIEBwcm9wZXJ0eSB7QXJyYXk8XCJjcmVhdGVcIiB8IFwidXBkYXRlXCIgfCBcImRlc3Ryb3lcIj59IG9wZXJhdGlvbnMgLSBQdWJsaXNoZWQgb3BlcmF0aW9ucy5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSByZXNvdXJjZVR5cGUgLSBQdWJsaXNoZWQgcmVzb3VyY2UgdHlwZS5cbiAqIEBwcm9wZXJ0eSB7U3luY1B1Ymxpc2hEZWNsYXJhdGlvbkNvbmZpZ1tcInNlcmlhbGl6ZVwiXX0gc2VyaWFsaXplIC0gUGF5bG9hZCBzbmFwc2hvdCBidWlsZGVyLlxuICovXG5cbmV4cG9ydCB7fVxuIl19

package/build/src/sync/sync-publisher.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Declarative server-side sync publisher — the server mirror of the client's
+ * track-by-default mutation tracking.
+ *
+ * Server models declare what to publish through `static sync`'s `publish`
+ * key, and Velocious writes every committed server-side change to the sync
+ * change feed (model-backed Sync-row upsert with server re-sequencing) and
+ * fans out the declared broadcasts, so devices receive server-origin changes
+ * without app code calling manual upsert/broadcast helpers:
+ *
+ *     static sync = {
+ *       publish: {
+ *         serialize: (event) => ({id: event.id(), eventPin: event.eventPin()}),
+ *         eventId: (event) => event.id(),
+ *         broadcasts: [{channel: "ticket-scans", broadcastParams: ..., body: ...}]
+ *       }
+ *     }
+ *
+ * Replayed device mutations never double-publish: the framework's routed
+ * replay apply marks its written records through `markServerApply(record)`
+ * (see sync-publish-suppression.js), and app code applying already-synced
+ * data can use `markServerApply`/`withoutPublishing` the same way.
+ */
+export default class SyncPublisher {
+    /**
+     * Builds a sync publisher derived from the given configuration. Alias for
+     * `new SyncPublisher({configuration, ...options})`.
+     * @param {Configuration} [configuration] - Configuration owning the registered models. Defaults to the current configuration.
+     * @param {Omit<import("./sync-publisher-types.js").SyncPublisherOptions, "configuration">} [options] - Optional overrides.
+     * @returns {SyncPublisher} Sync publisher derived from the configuration.
+     */
+    static fromConfiguration(configuration?: Configuration, options?: Omit<import("./sync-publisher-types.js").SyncPublisherOptions, "configuration">): SyncPublisher;
+    /**
+     * Starts (and memoizes per configuration) the sync publisher for a server
+     * boot: no-op when no registered model declares a publish config, guarded so
+     * repeated boots with the same configuration register the publish callbacks
+     * only once.
+     * @param {Configuration} configuration - Configuration owning the registered models.
+     * @returns {Promise<SyncPublisher | null>} Started publisher, or null when no models declare publish.
+     */
+    static startFromConfiguration(configuration: Configuration): Promise<SyncPublisher | null>;
+    /**
+     * Builds the sync publisher by deriving published resources from the
+     * configuration's registered models: every model declaring `static sync`
+     * with a `publish` declaration becomes a published resource
+     * (`publish: false` opts out). The sync/change model is the registered
+     * "Sync" model and broadcasts default to the configuration's channel
+     * broadcast.
+     * @param {import("./sync-publisher-types.js").SyncPublisherOptions} [options] - Optional overrides.
+     */
+    constructor(options?: import("./sync-publisher-types.js").SyncPublisherOptions);
+    /** @type {{actorForeignKeyColumn: string, broadcaster: import("./sync-publisher-types.js").SyncPublisherOptions["broadcaster"], configuration: Configuration, onError: import("./sync-publisher-types.js").SyncPublisherOptions["onError"], resources: Record<string, import("./sync-publisher-types.js").SyncPublisherResourceConfig>, syncModel: ?}} */
+    config: {
+        actorForeignKeyColumn: string;
+        broadcaster: import("./sync-publisher-types.js").SyncPublisherOptions["broadcaster"];
+        configuration: Configuration;
+        onError: import("./sync-publisher-types.js").SyncPublisherOptions["onError"];
+        resources: Record<string, import("./sync-publisher-types.js").SyncPublisherResourceConfig>;
+        syncModel: unknown;
+    };
+    /** @type {Array<{callback: (record: ?) => Promise<void>, callbackName: "afterCreate" | "afterUpdate" | "afterDestroy", modelClass: ?}>} */
+    _publishedCallbacks: Array<{
+        callback: (record: unknown) => Promise<void>;
+        callbackName: "afterCreate" | "afterUpdate" | "afterDestroy";
+        modelClass: unknown;
+    }>;
+    /** @type {Logger | null} */
+    _logger: Logger | null;
+    _started: boolean;
+    /**
+     * Registers the publish callbacks for every published resource: server-side
+     * creates and updates (destroys when opted in) upsert a sync change row and
+     * fan out the declared broadcasts once their transaction commits.
+     * @returns {Promise<void>}
+     */
+    start(): Promise<void>;
+    /**
+     * Unregisters all publish callbacks (tests, shutdown).
+     * @returns {void}
+     */
+    stop(): void;
+    /**
+     * Builds the lifecycle callback publishing one server-side mutation. The
+     * published payload (declaration `serialize`), event scope, and sync type
+     * are snapshotted at mutation-callback time, so afterSave hooks assigning
+     * unsaved attributes (or any later drift on the record) cannot change what
+     * gets published vs what was committed. Persisting and broadcasting are
+     * deferred through the model connection's afterCommit hook so they only run
+     * once the mutation's transaction has committed (immediately when no
+     * transaction is open) - rolled-back mutations never publish. Post-commit
+     * publish failures are reported without rethrowing into the driver's
+     * afterCommit chain (see reportAfterCommitError).
+     * @param {{operation: "create" | "update" | "destroy", resourceConfig: import("./sync-publisher-types.js").SyncPublisherResourceConfig}} args - Operation and resource config.
+     * @returns {(record: ?) => Promise<void>} Lifecycle callback.
+     */
+    publishedMutationCallback({ operation, resourceConfig }: {
+        operation: "create" | "update" | "destroy";
+        resourceConfig: import("./sync-publisher-types.js").SyncPublisherResourceConfig;
+    }): (record: unknown) => Promise<void>;
+    /**
+     * Upserts the published server-origin sync row for a resource identity:
+     * server-origin rows carry a null actor column (no device to echo the
+     * change back to), so repeated server changes to one resource reuse and
+     * re-sequence one feed row.
+     * @param {Record<string, ?>} attributes - Snapshotted sync row attributes.
+     * @returns {Promise<?>} Upserted sync row.
+     */
+    upsertPublishedSyncRow(attributes: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Returns the broadcaster delivering declared broadcasts: the injected one,
+     * or the configuration's channel broadcast awaited through the pending
+     * broadcast queue.
+     * @returns {NonNullable<import("./sync-publisher-types.js").SyncPublisherOptions["broadcaster"]>} Broadcast deliverer.
+     */
+    broadcaster(): NonNullable<import("./sync-publisher-types.js").SyncPublisherOptions["broadcaster"]>;
+    /**
+     * Reports a post-commit publish failure. The transaction has already
+     * committed when afterCommit callbacks run, so rethrowing here would poison
+     * the driver's awaited afterCommit chain (breaking unrelated callbacks) -
+     * instead the failure goes to the configured onError hook, or is emitted on
+     * the configuration's framework-error/all-error channels (so production bug
+     * reporting via `configuration.getErrorEvents()` sees a broken publish
+     * path) and logged loudly through the publisher's logger when none is
+     * configured.
+     * @param {Error} error - Post-commit publish failure.
+     * @returns {Promise<void>}
+     */
+    reportAfterCommitError(error: Error): Promise<void>;
+    /**
+     * Returns the lazily built publisher logger.
+     * @returns {Logger} Publisher logger.
+     */
+    logger(): Logger;
+}
+import Configuration from "../configuration.js";
+import Logger from "../logger.js";
+//# sourceMappingURL=sync-publisher.d.ts.map

package/build/src/sync/sync-publisher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-publisher.d.ts","sourceRoot":"","sources":["../../../src/sync/sync-publisher.js"],"names":[],"mappings":"AAwBA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IAgDE;;;;;;OAMG;IACH,yCAJW,aAAa,YACb,IAAI,CAAC,OAAO,2BAA2B,EAAE,oBAAoB,EAAE,eAAe,CAAC,GAC7E,aAAa,CAIzB;IAED;;;;;;;OAOG;IACH,6CAHW,aAAa,GACX,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAezC;IA/ED;;;;;;;;OAQG;IACH,sBAFW,OAAO,2BAA2B,EAAE,oBAAoB,EAsClE;IAPC,0VAA0V;IAC1V,QADW;QAAC,qBAAqB,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,OAAO,2BAA2B,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAAC,aAAa,EAAE,aAAa,CAAC;QAAC,OAAO,EAAE,OAAO,2BAA2B,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,2BAA2B,EAAE,2BAA2B,CAAC,CAAC;QAAC,SAAS,EAAE,OAAC,CAAA;KAAC,CACnO;IACnH,2IAA2I;IAC3I,qBADW,KAAK,CAAC;QAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAAC,YAAY,EAAE,aAAa,GAAG,aAAa,GAAG,cAAc,CAAC;QAAC,UAAU,EAAE,OAAC,CAAA;KAAC,CAAC,CAC1G;IAC7B,4BAA4B;IAC5B,SADW,MAAM,GAAG,IAAI,CACL;IACnB,kBAAqB;IAqCvB;;;;;OAKG;IACH,SAFa,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAED;;;OAGG;IACH,QAFa,IAAI,CAShB;IAED;;;;;;;;;;;;;OAaG;IACH,yDAHW;QAAC,SAAS,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;QAAC,cAAc,EAAE,OAAO,2BAA2B,EAAE,2BAA2B,CAAA;KAAC,GAC3H,CAAC,MAAM,EAAE,OAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAyCxC;IAED;;;;;;;OAOG;IACH,mCAHW,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,GACf,OAAO,CAAC,OAAC,CAAC,CAYtB;IAED;;;;;OAKG;IACH,eAFa,WAAW,CAAC,OAAO,2BAA2B,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAShG;IAED;;;;;;;;;;;OAWG;IACH,8BAHW,KAAK,GACH,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAED;;;OAGG;IACH,UAFa,MAAM,CAMlB;CACF;0BAjSyB,qBAAqB;mBAC5B,cAAc"}