@sveltebase/sync 1.0.5 → 1.0.6

package/README.md

@@ -572,5 +572,34 @@ try {
 }
 ```
 
+### G. Type-Safe Backend Event Publishing (`createPublisher`)
+When publishing backend events (e.g. from standard API routes, message queues, or cron triggers) to push updates to connected clients, you can create a type-safe publisher matched to your application's database schema. This checks channels (including dynamic channel patterns like `"todos:user_123"`), actions, and payloads at compile-time:
+
+```typescript
+import { createPublisher } from "@sveltebase/sync";
+import type { Todo } from "$lib/server/db/schema";
+
+// Define schema matching channel names to model types
+type AppSyncSchema = {
+  todos: Todo;
+};
+
+// Create typed publisher instance
+const publisher = createPublisher<AppSyncSchema>();
+
+// 1. Publish a create event (expects full Todo payload)
+await publisher.publish("todos", "create", todo.id, todo);
+
+// 2. Publish an update event (expects Partial<Todo> payload)
+await publisher.publish("todos", "update", todo.id, { completed: true });
+
+// 3. Publish a delete event (expects optional { updatedAt: string } metadata)
+await publisher.publish("todos", "delete", todo.id, undefined);
+
+// 4. Supports scoped/dynamic channels (e.g. "channelName:scopeId")
+await publisher.publish("todos:user_123", "update", todo.id, { title: "New Title" });
+```
+
+
 
 

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { SyncClient, useLiveQuery } from "./client/index.js";
 export { defineSync } from "./server/index.js";
-export { handleUpgrade, publishEvent } from "./server/handler.js";
+export { handleUpgrade, publishEvent, createPublisher } from "./server/handler.js";
+export type { PublishEventData } from "./server/handler.js";
 export type { SyncContext, SyncHandler } from "./server/index.js";
 export type { SyncMessage } from "./protocol.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAClE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACnF,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -1,3 +1,3 @@
 export { SyncClient, useLiveQuery } from "./client/index.js";
 export { defineSync } from "./server/index.js";
-export { handleUpgrade, publishEvent } from "./server/handler.js";
+export { handleUpgrade, publishEvent, createPublisher } from "./server/handler.js";

package/dist/server/handler.d.ts

@@ -1,3 +1,9 @@
+export type PublishEventData<TRecord, TAction extends "create" | "update" | "delete"> = TAction extends "create" ? TRecord : TAction extends "update" ? Partial<TRecord> : {
+    updatedAt?: string;
+} | undefined;
+export declare function createPublisher<TSchema extends Record<string, any>>(): {
+    publish: <TChannel extends keyof TSchema & string, TAction extends "create" | "update" | "delete">(channel: TChannel | `${TChannel}:${string}`, action: TAction, key: string | undefined, data: PublishEventData<TSchema[TChannel], TAction>) => Promise<void>;
+};
 export declare function publishEvent(channel: string, action: "create" | "update" | "delete", key: string | undefined, data: any): Promise<void>;
 export declare function handleUpgrade(request: Request, platform: App.Platform | undefined): Promise<Response>;
 //# sourceMappingURL=handler.d.ts.map

package/dist/server/handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/server/handler.ts"],"names":[],"mappings":"AAAA,wBAAsB,YAAY,CAChC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,EACtC,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,IAAI,EAAE,GAAG,iBAgCV;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,GAAG,CAAC,QAAQ,GAAG,SAAS,GACjC,OAAO,CAAC,QAAQ,CAAC,CAqBnB"}
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/server/handler.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,CAAC,OAAO,EAAE,OAAO,SAAS,QAAQ,GAAG,QAAQ,GAAG,QAAQ,IAClF,OAAO,SAAS,QAAQ,GACpB,OAAO,GACP,OAAO,SAAS,QAAQ,GACtB,OAAO,CAAC,OAAO,CAAC,GAChB;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAE3C,wBAAgB,eAAe,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;cAG7D,QAAQ,SAAS,MAAM,OAAO,GAAG,MAAM,EACvC,OAAO,SAAS,QAAQ,GAAG,QAAQ,GAAG,QAAQ,WAErC,QAAQ,GAAG,GAAG,QAAQ,IAAI,MAAM,EAAE,UACnC,OAAO,OACV,MAAM,GAAG,SAAS,QACjB,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,KACjD,OAAO,CAAC,IAAI,CAAC;EAKnB;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,EACtC,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,IAAI,EAAE,GAAG,iBAgCV;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,GAAG,CAAC,QAAQ,GAAG,SAAS,GACjC,OAAO,CAAC,QAAQ,CAAC,CAqBnB"}

package/dist/server/handler.js

@@ -1,3 +1,11 @@
+export function createPublisher() {
+    return {
+        publish: async (channel, action, key, data) => {
+            const resolvedChannel = String(channel);
+            return publishEvent(resolvedChannel, action, key, data);
+        },
+    };
+}
 export async function publishEvent(channel, action, key, data) {
     const envId = "$app/environment";
     let isDev = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltebase/sync",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "type": "module",
   "publishConfig": {
     "access": "public"