jazz-tools 0.18.10 → 0.18.11

package/.svelte-kit/__package__/jazz.svelte.d.ts

@@ -32,7 +32,7 @@ export declare function getAuthSecretStorage(): AuthSecretStorage;
 export declare class InviteListener<V extends CoValueClassOrSchema> {
     constructor({ invitedObjectSchema, onAccept, forValueHint, }: {
         invitedObjectSchema: V;
-        onAccept: (projectID: ID<V>) => void;
+        onAccept: (coValueID: ID<V>) => void;
         forValueHint?: string;
     });
 }

package/.svelte-kit/__package__/jazz.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jazz.svelte.d.ts","sourceRoot":"","sources":["../../../src/svelte/jazz.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EACjB,oBAAoB,EACpB,EAAE,EAEF,eAAe,EAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,QAAQ,IAAK,CAAC;AAC3B,eAAO,MAAM,aAAa,IAAK,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,SAAS,OAAO,IAAI;IAC7C,OAAO,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,OAAO,KAW9B;IAChB,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAC/B,CACF;AAED,wBAAgB,oBAAoB,sBAUnC;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,oBAAoB;gBAC5C,EACV,mBAAmB,EACnB,QAAQ,EACR,YAAY,GACb,EAAE;QACD,mBAAmB,EAAE,CAAC,CAAC;QACvB,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;QACrC,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CA+BF"}
+{"version":3,"file":"jazz.svelte.d.ts","sourceRoot":"","sources":["../../../src/svelte/jazz.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EACjB,oBAAoB,EACpB,EAAE,EAEF,eAAe,EAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,QAAQ,IAAK,CAAC;AAC3B,eAAO,MAAM,aAAa,IAAK,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,SAAS,OAAO,IAAI;IAC7C,OAAO,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,OAAO,KAW9B;IAChB,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAC/B,CACF;AAED,wBAAgB,oBAAoB,sBAUnC;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,oBAAoB;gBAC5C,EACV,mBAAmB,EACnB,QAAQ,EACR,YAAY,GACb,EAAE;QACD,mBAAmB,EAAE,CAAC,CAAC;QACvB,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;QACrC,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CA2BF"}

package/.svelte-kit/__package__/jazz.svelte.js

@@ -1,5 +1,5 @@
 import { consumeInviteLinkFromWindowLocation } from "jazz-tools/browser";
-import { getContext, untrack } from "svelte";
+import { getContext, onDestroy, untrack } from "svelte";
 import Provider from "./Provider.svelte";
 export { Provider as JazzSvelteProvider };
 /**
@@ -38,33 +38,26 @@ export function getAuthSecretStorage() {
  */
 export class InviteListener {
     constructor({ invitedObjectSchema, onAccept, forValueHint, }) {
-        // TODO Listen to the hashchange event
         const _onAccept = onAccept;
-        // Subscribe to the onAccept function.
+        const ctx = getJazzContext();
+        const tryConsume = () => {
+            if (!ctx.current || !("me" in ctx.current))
+                return;
+            consumeInviteLinkFromWindowLocation({
+                as: ctx.current.me,
+                invitedObjectSchema,
+                forValueHint,
+            })
+                .then((result) => result && _onAccept(result.valueID))
+                .catch((e) => console.error("Failed to accept invite", e));
+        };
+        // run once when instantiated
         $effect(() => {
-            const ctx = getJazzContext();
-            // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-            _onAccept;
-            // Subscribe to the onAccept function.
-            untrack(() => {
-                // If there is no context, return.
-                if (!ctx.current)
-                    return;
-                if (!("me" in ctx.current))
-                    return;
-                // Consume the invite link from the window location.
-                const result = consumeInviteLinkFromWindowLocation({
-                    as: ctx.current.me,
-                    invitedObjectSchema,
-                    forValueHint,
-                });
-                // If the result is valid, call the onAccept function.
-                result
-                    .then((result) => result && _onAccept(result?.valueID))
-                    .catch((e) => {
-                    console.error("Failed to accept invite", e);
-                });
-            });
+            untrack(tryConsume);
+        });
+        window.addEventListener("hashchange", tryConsume);
+        onDestroy(() => {
+            window.removeEventListener("hashchange", tryConsume);
         });
     }
 }

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> jazz-tools@0.18.10 build /home/runner/_work/jazz/jazz/packages/jazz-tools
+> jazz-tools@0.18.11 build /home/runner/_work/jazz/jazz/packages/jazz-tools
 > tsup && pnpm types && pnpm build:svelte
 
 CLI Building entry: {"index":"src/index.ts","testing":"src/testing.ts"}
@@ -107,22 +107,22 @@
 ESM Build start
 CLI Cleaning output folder
 ESM Build start
-ESM dist/react/ssr.js     688.00 B
-ESM dist/react/ssr.js.map 1.12 KB
-ESM ⚡️ Build success in 26ms
-ESM dist/worker/index.js     2.47 KB
-ESM dist/worker/index.js.map 5.26 KB
-ESM ⚡️ Build success in 22ms
 ESM dist/tiptap/index.js     564.00 B
 ESM dist/tiptap/index.js.map 1.21 KB
-ESM ⚡️ Build success in 22ms
+ESM ⚡️ Build success in 11ms
+ESM dist/react/ssr.js     688.00 B
+ESM dist/react/ssr.js.map 1.12 KB
+ESM ⚡️ Build success in 14ms
+ESM dist/worker/index.js     3.19 KB
+ESM dist/worker/index.js.map 6.17 KB
+ESM ⚡️ Build success in 14ms
 ESM dist/better-auth/auth/client.js     4.44 KB
 ESM dist/better-auth/auth/server.js     8.36 KB
 ESM dist/better-auth/auth/react.js      799.00 B
 ESM dist/better-auth/auth/client.js.map 8.24 KB
 ESM dist/better-auth/auth/server.js.map 15.29 KB
 ESM dist/better-auth/auth/react.js.map  2.04 KB
-ESM ⚡️ Build success in 25ms
+ESM ⚡️ Build success in 18ms
 ESM dist/media/index.js              236.00 B
 ESM dist/media/index.browser.js      2.79 KB
 ESM dist/media/index.native.js       2.90 KB
@@ -133,67 +133,67 @@
 ESM dist/media/index.native.js.map   6.09 KB
 ESM dist/media/index.server.js.map   6.37 KB
 ESM dist/media/chunk-W3S526L3.js.map 16.57 KB
-ESM ⚡️ Build success in 40ms
+ESM ⚡️ Build success in 25ms
 ESM dist/expo/index.js       4.68 KB
 ESM dist/expo/testing.js     112.00 B
 ESM dist/expo/crypto.js      153.00 B
 ESM dist/expo/index.js.map   10.23 KB
 ESM dist/expo/testing.js.map 168.00 B
 ESM dist/expo/crypto.js.map  189.00 B
-ESM ⚡️ Build success in 40ms
+ESM ⚡️ Build success in 24ms
+ESM dist/browser/index.js     13.64 KB
+ESM dist/browser/index.js.map 29.14 KB
+ESM ⚡️ Build success in 34ms
 ESM dist/react-native/index.js       2.53 KB
 ESM dist/react-native/testing.js     120.00 B
 ESM dist/react-native/crypto.js      161.00 B
 ESM dist/react-native/index.js.map   5.68 KB
 ESM dist/react-native/testing.js.map 176.00 B
 ESM dist/react-native/crypto.js.map  197.00 B
-ESM ⚡️ Build success in 36ms
-ESM dist/browser/index.js     13.64 KB
-ESM dist/browser/index.js.map 29.14 KB
-ESM ⚡️ Build success in 41ms
+ESM ⚡️ Build success in 29ms
 ESM dist/react-native-core/index.js       18.00 KB
 ESM dist/react-native-core/testing.js     119.00 B
 ESM dist/react-native-core/crypto.js      2.10 KB
 ESM dist/react-native-core/index.js.map   36.73 KB
 ESM dist/react-native-core/testing.js.map 175.00 B
 ESM dist/react-native-core/crypto.js.map  4.25 KB
-ESM ⚡️ Build success in 46ms
-ESM dist/prosemirror/index.js     77.63 KB
-ESM dist/prosemirror/index.js.map 306.98 KB
-ESM ⚡️ Build success in 49ms
-ESM dist/react/index.js       24.76 KB
+ESM ⚡️ Build success in 38ms
 ESM dist/react/testing.js     122.00 B
-ESM dist/react/index.js.map   53.56 KB
+ESM dist/react/index.js       24.76 KB
 ESM dist/react/testing.js.map 165.00 B
-ESM ⚡️ Build success in 49ms
+ESM dist/react/index.js.map   53.56 KB
+ESM ⚡️ Build success in 41ms
+ESM dist/prosemirror/index.js     77.63 KB
+ESM dist/prosemirror/index.js.map 306.98 KB
+ESM ⚡️ Build success in 43ms
 ESM dist/inspector/index.js     69.71 KB
 ESM dist/inspector/index.js.map 121.38 KB
-ESM ⚡️ Build success in 61ms
+ESM ⚡️ Build success in 54ms
 ESM dist/testing.js            7.17 KB
 ESM dist/index.js              26.13 KB
 ESM dist/chunk-RQHJFPIB.js     169.74 KB
 ESM dist/testing.js.map        14.10 KB
 ESM dist/index.js.map          52.92 KB
 ESM dist/chunk-RQHJFPIB.js.map 402.59 KB
-ESM ⚡️ Build success in 88ms
-ESM dist/react-core/index.js              146.19 KB
+ESM ⚡️ Build success in 78ms
 ESM dist/react-core/testing.js            1.17 KB
 ESM dist/react-core/chunk-7DYMJ74I.js     279.00 B
+ESM dist/react-core/index.js              146.19 KB
 ESM dist/react-core/testing.js.map        1.82 KB
 ESM dist/react-core/chunk-7DYMJ74I.js.map 533.00 B
 ESM dist/react-core/index.js.map          404.45 KB
-ESM ⚡️ Build success in 90ms
+ESM ⚡️ Build success in 77ms
 ESM dist/inspector/register-custom-element.js     218.00 B
 ESM dist/inspector/register-custom-element.js.map 314.00 B
 ESM dist/inspector/custom-element-G6SPZEBR.js     1.54 MB
 ESM dist/inspector/custom-element-G6SPZEBR.js.map 2.36 MB
-ESM ⚡️ Build success in 122ms
+ESM ⚡️ Build success in 109ms
 
-> jazz-tools@0.18.10 types /home/runner/_work/jazz/jazz/packages/jazz-tools
+> jazz-tools@0.18.11 types /home/runner/_work/jazz/jazz/packages/jazz-tools
 > tsc --outDir dist
 
 
-> jazz-tools@0.18.10 build:svelte /home/runner/_work/jazz/jazz/packages/jazz-tools
+> jazz-tools@0.18.11 build:svelte /home/runner/_work/jazz/jazz/packages/jazz-tools
 > rm -rf dist/svelte && svelte-package -i src/svelte -o dist/svelte --tsconfig tsconfig.svelte.json
 
 src/svelte -> dist/svelte

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # jazz-tools
 
+## 0.18.11
+
+### Patch Changes
+
+- 06b4617: Update the Svelte InviteListener to listen to hash change events
+- 70eb465: Add docs to the worker API and deprecate done in favor of shutdownWorker
+- Updated dependencies [a4a9a1e]
+  - cojson@0.18.11
+  - cojson-storage-indexeddb@0.18.11
+  - cojson-transport-ws@0.18.11
+
 ## 0.18.10
 
 ### Patch Changes

package/dist/svelte/jazz.svelte.d.ts

@@ -32,7 +32,7 @@ export declare function getAuthSecretStorage(): AuthSecretStorage;
 export declare class InviteListener<V extends CoValueClassOrSchema> {
     constructor({ invitedObjectSchema, onAccept, forValueHint, }: {
         invitedObjectSchema: V;
-        onAccept: (projectID: ID<V>) => void;
+        onAccept: (coValueID: ID<V>) => void;
         forValueHint?: string;
     });
 }

package/dist/svelte/jazz.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jazz.svelte.d.ts","sourceRoot":"","sources":["../../../src/svelte/jazz.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EACjB,oBAAoB,EACpB,EAAE,EAEF,eAAe,EAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,QAAQ,IAAK,CAAC;AAC3B,eAAO,MAAM,aAAa,IAAK,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,SAAS,OAAO,IAAI;IAC7C,OAAO,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,OAAO,KAW9B;IAChB,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAC/B,CACF;AAED,wBAAgB,oBAAoB,sBAUnC;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,oBAAoB;gBAC5C,EACV,mBAAmB,EACnB,QAAQ,EACR,YAAY,GACb,EAAE;QACD,mBAAmB,EAAE,CAAC,CAAC;QACvB,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;QACrC,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CA+BF"}
+{"version":3,"file":"jazz.svelte.d.ts","sourceRoot":"","sources":["../../../src/svelte/jazz.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EACjB,oBAAoB,EACpB,EAAE,EAEF,eAAe,EAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,QAAQ,IAAK,CAAC;AAC3B,eAAO,MAAM,aAAa,IAAK,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,SAAS,OAAO,IAAI;IAC7C,OAAO,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,OAAO,KAW9B;IAChB,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CAC/B,CACF;AAED,wBAAgB,oBAAoB,sBAUnC;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,oBAAoB;gBAC5C,EACV,mBAAmB,EACnB,QAAQ,EACR,YAAY,GACb,EAAE;QACD,mBAAmB,EAAE,CAAC,CAAC;QACvB,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;QACrC,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CA2BF"}

package/dist/svelte/jazz.svelte.js

@@ -1,5 +1,5 @@
 import { consumeInviteLinkFromWindowLocation } from "jazz-tools/browser";
-import { getContext, untrack } from "svelte";
+import { getContext, onDestroy, untrack } from "svelte";
 import Provider from "./Provider.svelte";
 export { Provider as JazzSvelteProvider };
 /**
@@ -38,33 +38,26 @@ export function getAuthSecretStorage() {
  */
 export class InviteListener {
     constructor({ invitedObjectSchema, onAccept, forValueHint, }) {
-        // TODO Listen to the hashchange event
         const _onAccept = onAccept;
-        // Subscribe to the onAccept function.
+        const ctx = getJazzContext();
+        const tryConsume = () => {
+            if (!ctx.current || !("me" in ctx.current))
+                return;
+            consumeInviteLinkFromWindowLocation({
+                as: ctx.current.me,
+                invitedObjectSchema,
+                forValueHint,
+            })
+                .then((result) => result && _onAccept(result.valueID))
+                .catch((e) => console.error("Failed to accept invite", e));
+        };
+        // run once when instantiated
         $effect(() => {
-            const ctx = getJazzContext();
-            // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-            _onAccept;
-            // Subscribe to the onAccept function.
-            untrack(() => {
-                // If there is no context, return.
-                if (!ctx.current)
-                    return;
-                if (!("me" in ctx.current))
-                    return;
-                // Consume the invite link from the window location.
-                const result = consumeInviteLinkFromWindowLocation({
-                    as: ctx.current.me,
-                    invitedObjectSchema,
-                    forValueHint,
-                });
-                // If the result is valid, call the onAccept function.
-                result
-                    .then((result) => result && _onAccept(result?.valueID))
-                    .catch((e) => {
-                    console.error("Failed to accept invite", e);
-                });
-            });
+            untrack(tryConsume);
+        });
+        window.addEventListener("hashchange", tryConsume);
+        onDestroy(() => {
+            window.removeEventListener("hashchange", tryConsume);
         });
     }
 }

package/dist/worker/index.d.ts

@@ -19,17 +19,43 @@ type WorkerOptions<S extends (AccountClass<Account> & CoValueFromRaw<Account>) |
 };
 /** @category Context Creation */
 export declare function startWorker<S extends (AccountClass<Account> & CoValueFromRaw<Account>) | AnyAccountSchema>(options: WorkerOptions<S>): Promise<{
+    /**
+     * The worker account instance.
+     */
     worker: Loaded<S>;
     experimental: {
+        /**
+         * API to subscribe to the inbox messages.
+         *
+         * More info on the Inbox API: https://jazz.tools/docs/react/server-side/inbox
+         */
         inbox: {
             subscribe: Inbox["subscribe"];
         } | {
             subscribe: () => void;
         };
     };
+    /**
+     * Wait for the connection to the sync server to be established.
+     *
+     * If already connected, it will resolve immediately.
+     */
     waitForConnection(): Promise<void>;
     subscribeToConnectionChange(listener: (connected: boolean) => void): () => void;
+    /**
+     * Waits for all CoValues to sync and then shuts down the worker.
+     *
+     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()
+     *
+     * @deprecated Use shutdownWorker
+     */
     done: () => Promise<void>;
+    /**
+     * Waits for all CoValues to sync and then shuts down the worker.
+     *
+     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()
+     */
+    shutdownWorker(): Promise<void>;
 }>;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/worker/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/worker/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,cAAc,EAAmB,MAAM,QAAQ,CAAC;AACtE,OAAO,EACL,KAAK,uBAAuB,EAE7B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,KAAK,EAEL,MAAM,EAGP,MAAM,YAAY,CAAC;AAEpB,KAAK,aAAa,CAChB,CAAC,SACG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,GACjD,gBAAgB,IAClB;IACF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,aAAa,CAAC,EAAE,CAAC,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,iCAAiC;AACjC,wBAAsB,WAAW,CAC/B,CAAC,SACG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,GACjD,gBAAgB,EACpB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;YAiFI,MAAM,CAAC,CAAC,CAAC;;;uBAPU,KAAK,CAAC,WAAW,CAAC;;;;;;0CAc1B,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI;;GASrE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/worker/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,cAAc,EAAmB,MAAM,QAAQ,CAAC;AACtE,OAAO,EACL,KAAK,uBAAuB,EAE7B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,KAAK,EAEL,MAAM,EAGP,MAAM,YAAY,CAAC;AAEpB,KAAK,aAAa,CAChB,CAAC,SACG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,GACjD,gBAAgB,IAClB;IACF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,aAAa,CAAC,EAAE,CAAC,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,iCAAiC;AACjC,wBAAsB,WAAW,CAC/B,CAAC,SACG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,GACjD,gBAAgB,EACpB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;IAgFvB;;OAEG;YACwB,MAAM,CAAC,CAAC,CAAC;;QAElC;;;;WAIG;;uBAhByC,KAAK,CAAC,WAAW,CAAC;;;;;IAmBhE;;;;OAIG;;0CAImC,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI;IAOlE;;;;;;OAMG;;IAEH;;;;OAIG;;GAKN"}

package/dist/worker/index.js

@@ -53,7 +53,6 @@ async function startWorker(options) {
       secret: accountSecret
     },
     AccountSchema,
-    // TODO: locked sessions similar to browser
     sessionProvider: randomSessionProvider,
     peersToLoadFrom,
     crypto: options.crypto ?? await WasmCrypto.create(),
@@ -77,10 +76,23 @@ async function startWorker(options) {
     }
   };
   return {
+    /**
+     * The worker account instance.
+     */
     worker: context.account,
     experimental: {
+      /**
+       * API to subscribe to the inbox messages.
+       *
+       * More info on the Inbox API: https://jazz.tools/docs/react/server-side/inbox
+       */
       inbox: inboxPublicApi
     },
+    /**
+     * Wait for the connection to the sync server to be established.
+     *
+     * If already connected, it will resolve immediately.
+     */
     waitForConnection() {
       return wsPeer.waitUntilConnected();
     },
@@ -90,7 +102,22 @@ async function startWorker(options) {
         wsPeer.unsubscribe(listener);
       };
     },
-    done
+    /**
+     * Waits for all CoValues to sync and then shuts down the worker.
+     *
+     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()
+     *
+     * @deprecated Use shutdownWorker
+     */
+    done,
+    /**
+     * Waits for all CoValues to sync and then shuts down the worker.
+     *
+     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()
+     */
+    shutdownWorker() {
+      return done();
+    }
   };
 }
 export {

package/dist/worker/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/worker/index.ts"],"sourcesContent":["import { AgentSecret, CryptoProvider, LocalNode, Peer } from \"cojson\";\nimport {\n  type AnyWebSocketConstructor,\n  WebSocketPeerWithReconnection,\n} from \"cojson-transport-ws\";\nimport { WasmCrypto } from \"cojson/crypto/WasmCrypto\";\nimport {\n  Account,\n  AccountClass,\n  AnyAccountSchema,\n  CoValueFromRaw,\n  Inbox,\n  InstanceOfSchema,\n  Loaded,\n  createJazzContextFromExistingCredentials,\n  randomSessionProvider,\n} from \"jazz-tools\";\n\ntype WorkerOptions<\n  S extends\n    | (AccountClass<Account> & CoValueFromRaw<Account>)\n    | AnyAccountSchema,\n> = {\n  accountID?: string;\n  accountSecret?: string;\n  syncServer?: string;\n  WebSocket?: AnyWebSocketConstructor;\n  AccountSchema?: S;\n  crypto?: CryptoProvider;\n  /**\n   * If true, the inbox will not be loaded.\n   */\n  skipInboxLoad?: boolean;\n  /**\n   * If false, the worker will not set in the global account context\n   */\n  asActiveAccount?: boolean;\n};\n\n/** @category Context Creation */\nexport async function startWorker<\n  S extends\n    | (AccountClass<Account> & CoValueFromRaw<Account>)\n    | AnyAccountSchema,\n>(options: WorkerOptions<S>) {\n  const {\n    accountID = process.env.JAZZ_WORKER_ACCOUNT,\n    accountSecret = process.env.JAZZ_WORKER_SECRET,\n    syncServer = \"wss://cloud.jazz.tools\",\n    AccountSchema = Account as unknown as S,\n    skipInboxLoad = false,\n    asActiveAccount = true,\n  } = options;\n\n  let node: LocalNode | undefined = undefined;\n\n  const peersToLoadFrom: Peer[] = [];\n\n  const wsPeer = new WebSocketPeerWithReconnection({\n    peer: syncServer,\n    reconnectionTimeout: 100,\n    addPeer: (peer) => {\n      if (node) {\n        node.syncManager.addPeer(peer);\n      } else {\n        peersToLoadFrom.push(peer);\n      }\n    },\n    removePeer: () => {},\n    WebSocketConstructor: options.WebSocket,\n  });\n\n  wsPeer.enable();\n\n  if (!accountID) {\n    throw new Error(\"No accountID provided\");\n  }\n  if (!accountSecret) {\n    throw new Error(\"No accountSecret provided\");\n  }\n  if (!accountID.startsWith(\"co_\")) {\n    throw new Error(\"Invalid accountID\");\n  }\n  if (!accountSecret?.startsWith(\"sealerSecret_\")) {\n    throw new Error(\"Invalid accountSecret\");\n  }\n\n  const context = await createJazzContextFromExistingCredentials({\n    credentials: {\n      accountID: accountID,\n      secret: accountSecret as AgentSecret,\n    },\n    AccountSchema,\n    // TODO: locked sessions similar to browser\n    sessionProvider: randomSessionProvider,\n    peersToLoadFrom,\n    crypto: options.crypto ?? (await WasmCrypto.create()),\n    asActiveAccount,\n  });\n\n  const account = context.account as InstanceOfSchema<S>;\n  node = account.$jazz.localNode;\n\n  if (!account.$jazz.refs.profile?.id) {\n    throw new Error(\"Account has no profile\");\n  }\n\n  const inbox = skipInboxLoad ? undefined : await Inbox.load(account);\n\n  async function done() {\n    await context.account.$jazz.waitForAllCoValuesSync();\n\n    wsPeer.disable();\n    context.done();\n  }\n\n  const inboxPublicApi = inbox\n    ? {\n        subscribe: inbox.subscribe.bind(inbox) as Inbox[\"subscribe\"],\n      }\n    : {\n        subscribe: () => {},\n      };\n\n  return {\n    worker: context.account as Loaded<S>,\n    experimental: {\n      inbox: inboxPublicApi,\n    },\n    waitForConnection() {\n      return wsPeer.waitUntilConnected();\n    },\n    subscribeToConnectionChange(listener: (connected: boolean) => void) {\n      wsPeer.subscribe(listener);\n\n      return () => {\n        wsPeer.unsubscribe(listener);\n      };\n    },\n    done,\n  };\n}\n"],"mappings":";AACA;AAAA,EAEE;AAAA,OACK;AACP,SAAS,kBAAkB;AAC3B;AAAA,EACE;AAAA,EAIA;AAAA,EAGA;AAAA,EACA;AAAA,OACK;AAwBP,eAAsB,YAIpB,SAA2B;AAC3B,QAAM;AAAA,IACJ,YAAY,QAAQ,IAAI;AAAA,IACxB,gBAAgB,QAAQ,IAAI;AAAA,IAC5B,aAAa;AAAA,IACb,gBAAgB;AAAA,IAChB,gBAAgB;AAAA,IAChB,kBAAkB;AAAA,EACpB,IAAI;AAEJ,MAAI,OAA8B;AAElC,QAAM,kBAA0B,CAAC;AAEjC,QAAM,SAAS,IAAI,8BAA8B;AAAA,IAC/C,MAAM;AAAA,IACN,qBAAqB;AAAA,IACrB,SAAS,CAAC,SAAS;AACjB,UAAI,MAAM;AACR,aAAK,YAAY,QAAQ,IAAI;AAAA,MAC/B,OAAO;AACL,wBAAgB,KAAK,IAAI;AAAA,MAC3B;AAAA,IACF;AAAA,IACA,YAAY,MAAM;AAAA,IAAC;AAAA,IACnB,sBAAsB,QAAQ;AAAA,EAChC,CAAC;AAED,SAAO,OAAO;AAEd,MAAI,CAAC,WAAW;AACd,UAAM,IAAI,MAAM,uBAAuB;AAAA,EACzC;AACA,MAAI,CAAC,eAAe;AAClB,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AACA,MAAI,CAAC,UAAU,WAAW,KAAK,GAAG;AAChC,UAAM,IAAI,MAAM,mBAAmB;AAAA,EACrC;AACA,MAAI,CAAC,eAAe,WAAW,eAAe,GAAG;AAC/C,UAAM,IAAI,MAAM,uBAAuB;AAAA,EACzC;AAEA,QAAM,UAAU,MAAM,yCAAyC;AAAA,IAC7D,aAAa;AAAA,MACX;AAAA,MACA,QAAQ;AAAA,IACV;AAAA,IACA;AAAA;AAAA,IAEA,iBAAiB;AAAA,IACjB;AAAA,IACA,QAAQ,QAAQ,UAAW,MAAM,WAAW,OAAO;AAAA,IACnD;AAAA,EACF,CAAC;AAED,QAAM,UAAU,QAAQ;AACxB,SAAO,QAAQ,MAAM;AAErB,MAAI,CAAC,QAAQ,MAAM,KAAK,SAAS,IAAI;AACnC,UAAM,IAAI,MAAM,wBAAwB;AAAA,EAC1C;AAEA,QAAM,QAAQ,gBAAgB,SAAY,MAAM,MAAM,KAAK,OAAO;AAElE,iBAAe,OAAO;AACpB,UAAM,QAAQ,QAAQ,MAAM,uBAAuB;AAEnD,WAAO,QAAQ;AACf,YAAQ,KAAK;AAAA,EACf;AAEA,QAAM,iBAAiB,QACnB;AAAA,IACE,WAAW,MAAM,UAAU,KAAK,KAAK;AAAA,EACvC,IACA;AAAA,IACE,WAAW,MAAM;AAAA,IAAC;AAAA,EACpB;AAEJ,SAAO;AAAA,IACL,QAAQ,QAAQ;AAAA,IAChB,cAAc;AAAA,MACZ,OAAO;AAAA,IACT;AAAA,IACA,oBAAoB;AAClB,aAAO,OAAO,mBAAmB;AAAA,IACnC;AAAA,IACA,4BAA4B,UAAwC;AAClE,aAAO,UAAU,QAAQ;AAEzB,aAAO,MAAM;AACX,eAAO,YAAY,QAAQ;AAAA,MAC7B;AAAA,IACF;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/worker/index.ts"],"sourcesContent":["import { AgentSecret, CryptoProvider, LocalNode, Peer } from \"cojson\";\nimport {\n  type AnyWebSocketConstructor,\n  WebSocketPeerWithReconnection,\n} from \"cojson-transport-ws\";\nimport { WasmCrypto } from \"cojson/crypto/WasmCrypto\";\nimport {\n  Account,\n  AccountClass,\n  AnyAccountSchema,\n  CoValueFromRaw,\n  Inbox,\n  InstanceOfSchema,\n  Loaded,\n  createJazzContextFromExistingCredentials,\n  randomSessionProvider,\n} from \"jazz-tools\";\n\ntype WorkerOptions<\n  S extends\n    | (AccountClass<Account> & CoValueFromRaw<Account>)\n    | AnyAccountSchema,\n> = {\n  accountID?: string;\n  accountSecret?: string;\n  syncServer?: string;\n  WebSocket?: AnyWebSocketConstructor;\n  AccountSchema?: S;\n  crypto?: CryptoProvider;\n  /**\n   * If true, the inbox will not be loaded.\n   */\n  skipInboxLoad?: boolean;\n  /**\n   * If false, the worker will not set in the global account context\n   */\n  asActiveAccount?: boolean;\n};\n\n/** @category Context Creation */\nexport async function startWorker<\n  S extends\n    | (AccountClass<Account> & CoValueFromRaw<Account>)\n    | AnyAccountSchema,\n>(options: WorkerOptions<S>) {\n  const {\n    accountID = process.env.JAZZ_WORKER_ACCOUNT,\n    accountSecret = process.env.JAZZ_WORKER_SECRET,\n    syncServer = \"wss://cloud.jazz.tools\",\n    AccountSchema = Account as unknown as S,\n    skipInboxLoad = false,\n    asActiveAccount = true,\n  } = options;\n\n  let node: LocalNode | undefined = undefined;\n\n  const peersToLoadFrom: Peer[] = [];\n\n  const wsPeer = new WebSocketPeerWithReconnection({\n    peer: syncServer,\n    reconnectionTimeout: 100,\n    addPeer: (peer) => {\n      if (node) {\n        node.syncManager.addPeer(peer);\n      } else {\n        peersToLoadFrom.push(peer);\n      }\n    },\n    removePeer: () => {},\n    WebSocketConstructor: options.WebSocket,\n  });\n\n  wsPeer.enable();\n\n  if (!accountID) {\n    throw new Error(\"No accountID provided\");\n  }\n  if (!accountSecret) {\n    throw new Error(\"No accountSecret provided\");\n  }\n  if (!accountID.startsWith(\"co_\")) {\n    throw new Error(\"Invalid accountID\");\n  }\n  if (!accountSecret?.startsWith(\"sealerSecret_\")) {\n    throw new Error(\"Invalid accountSecret\");\n  }\n\n  const context = await createJazzContextFromExistingCredentials({\n    credentials: {\n      accountID: accountID,\n      secret: accountSecret as AgentSecret,\n    },\n    AccountSchema,\n    sessionProvider: randomSessionProvider,\n    peersToLoadFrom,\n    crypto: options.crypto ?? (await WasmCrypto.create()),\n    asActiveAccount,\n  });\n\n  const account = context.account as InstanceOfSchema<S>;\n  node = account.$jazz.localNode;\n\n  if (!account.$jazz.refs.profile?.id) {\n    throw new Error(\"Account has no profile\");\n  }\n\n  const inbox = skipInboxLoad ? undefined : await Inbox.load(account);\n\n  async function done() {\n    await context.account.$jazz.waitForAllCoValuesSync();\n\n    wsPeer.disable();\n    context.done();\n  }\n\n  const inboxPublicApi = inbox\n    ? {\n        subscribe: inbox.subscribe.bind(inbox) as Inbox[\"subscribe\"],\n      }\n    : {\n        subscribe: () => {},\n      };\n\n  return {\n    /**\n     * The worker account instance.\n     */\n    worker: context.account as Loaded<S>,\n    experimental: {\n      /**\n       * API to subscribe to the inbox messages.\n       *\n       * More info on the Inbox API: https://jazz.tools/docs/react/server-side/inbox\n       */\n      inbox: inboxPublicApi,\n    },\n    /**\n     * Wait for the connection to the sync server to be established.\n     *\n     * If already connected, it will resolve immediately.\n     */\n    waitForConnection() {\n      return wsPeer.waitUntilConnected();\n    },\n    subscribeToConnectionChange(listener: (connected: boolean) => void) {\n      wsPeer.subscribe(listener);\n\n      return () => {\n        wsPeer.unsubscribe(listener);\n      };\n    },\n    /**\n     * Waits for all CoValues to sync and then shuts down the worker.\n     *\n     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()\n     *\n     * @deprecated Use shutdownWorker\n     */\n    done,\n    /**\n     * Waits for all CoValues to sync and then shuts down the worker.\n     *\n     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()\n     */\n    shutdownWorker() {\n      return done();\n    },\n  };\n}\n"],"mappings":";AACA;AAAA,EAEE;AAAA,OACK;AACP,SAAS,kBAAkB;AAC3B;AAAA,EACE;AAAA,EAIA;AAAA,EAGA;AAAA,EACA;AAAA,OACK;AAwBP,eAAsB,YAIpB,SAA2B;AAC3B,QAAM;AAAA,IACJ,YAAY,QAAQ,IAAI;AAAA,IACxB,gBAAgB,QAAQ,IAAI;AAAA,IAC5B,aAAa;AAAA,IACb,gBAAgB;AAAA,IAChB,gBAAgB;AAAA,IAChB,kBAAkB;AAAA,EACpB,IAAI;AAEJ,MAAI,OAA8B;AAElC,QAAM,kBAA0B,CAAC;AAEjC,QAAM,SAAS,IAAI,8BAA8B;AAAA,IAC/C,MAAM;AAAA,IACN,qBAAqB;AAAA,IACrB,SAAS,CAAC,SAAS;AACjB,UAAI,MAAM;AACR,aAAK,YAAY,QAAQ,IAAI;AAAA,MAC/B,OAAO;AACL,wBAAgB,KAAK,IAAI;AAAA,MAC3B;AAAA,IACF;AAAA,IACA,YAAY,MAAM;AAAA,IAAC;AAAA,IACnB,sBAAsB,QAAQ;AAAA,EAChC,CAAC;AAED,SAAO,OAAO;AAEd,MAAI,CAAC,WAAW;AACd,UAAM,IAAI,MAAM,uBAAuB;AAAA,EACzC;AACA,MAAI,CAAC,eAAe;AAClB,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AACA,MAAI,CAAC,UAAU,WAAW,KAAK,GAAG;AAChC,UAAM,IAAI,MAAM,mBAAmB;AAAA,EACrC;AACA,MAAI,CAAC,eAAe,WAAW,eAAe,GAAG;AAC/C,UAAM,IAAI,MAAM,uBAAuB;AAAA,EACzC;AAEA,QAAM,UAAU,MAAM,yCAAyC;AAAA,IAC7D,aAAa;AAAA,MACX;AAAA,MACA,QAAQ;AAAA,IACV;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,IACjB;AAAA,IACA,QAAQ,QAAQ,UAAW,MAAM,WAAW,OAAO;AAAA,IACnD;AAAA,EACF,CAAC;AAED,QAAM,UAAU,QAAQ;AACxB,SAAO,QAAQ,MAAM;AAErB,MAAI,CAAC,QAAQ,MAAM,KAAK,SAAS,IAAI;AACnC,UAAM,IAAI,MAAM,wBAAwB;AAAA,EAC1C;AAEA,QAAM,QAAQ,gBAAgB,SAAY,MAAM,MAAM,KAAK,OAAO;AAElE,iBAAe,OAAO;AACpB,UAAM,QAAQ,QAAQ,MAAM,uBAAuB;AAEnD,WAAO,QAAQ;AACf,YAAQ,KAAK;AAAA,EACf;AAEA,QAAM,iBAAiB,QACnB;AAAA,IACE,WAAW,MAAM,UAAU,KAAK,KAAK;AAAA,EACvC,IACA;AAAA,IACE,WAAW,MAAM;AAAA,IAAC;AAAA,EACpB;AAEJ,SAAO;AAAA;AAAA;AAAA;AAAA,IAIL,QAAQ,QAAQ;AAAA,IAChB,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMZ,OAAO;AAAA,IACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,oBAAoB;AAClB,aAAO,OAAO,mBAAmB;AAAA,IACnC;AAAA,IACA,4BAA4B,UAAwC;AAClE,aAAO,UAAU,QAAQ;AAEzB,aAAO,MAAM;AACX,eAAO,YAAY,QAAQ;AAAA,MAC7B;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,iBAAiB;AACf,aAAO,KAAK;AAAA,IACd;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -167,7 +167,7 @@
   },
   "type": "module",
   "license": "MIT",
-  "version": "0.18.10",
+  "version": "0.18.11",
   "dependencies": {
     "@manuscripts/prosemirror-recreate-steps": "^0.1.4",
     "@scure/base": "1.2.1",
@@ -184,9 +184,9 @@
     "prosemirror-transform": "^1.9.0",
     "use-sync-external-store": "^1.5.0",
     "zod": "3.25.76",
-    "cojson": "0.18.10",
-    "cojson-storage-indexeddb": "0.18.10",
-    "cojson-transport-ws": "0.18.10"
+    "cojson": "0.18.11",
+    "cojson-storage-indexeddb": "0.18.11",
+    "cojson-transport-ws": "0.18.11"
   },
   "devDependencies": {
     "@scure/bip39": "^1.3.0",

package/src/svelte/jazz.svelte.ts

@@ -8,7 +8,7 @@ import type {
 } from "jazz-tools";
 import { Account } from "jazz-tools";
 import { consumeInviteLinkFromWindowLocation } from "jazz-tools/browser";
-import { getContext, untrack } from "svelte";
+import { getContext, onDestroy, untrack } from "svelte";
 import Provider from "./Provider.svelte";
 
 export { Provider as JazzSvelteProvider };
@@ -73,37 +73,33 @@ export class InviteListener<V extends CoValueClassOrSchema> {
     forValueHint,
   }: {
     invitedObjectSchema: V;
-    onAccept: (projectID: ID<V>) => void;
+    onAccept: (coValueID: ID<V>) => void;
     forValueHint?: string;
   }) {
-    // TODO Listen to the hashchange event
     const _onAccept = onAccept;
+    const ctx = getJazzContext<InstanceOfSchema<AccountClass<Account>>>();
 
-    // Subscribe to the onAccept function.
+    const tryConsume = () => {
+      if (!ctx.current || !("me" in ctx.current)) return;
+
+      consumeInviteLinkFromWindowLocation({
+        as: ctx.current.me,
+        invitedObjectSchema,
+        forValueHint,
+      })
+        .then((result) => result && _onAccept(result.valueID))
+        .catch((e) => console.error("Failed to accept invite", e));
+    };
+
+    // run once when instantiated
     $effect(() => {
-      const ctx = getJazzContext<InstanceOfSchema<AccountClass<Account>>>();
-
-      // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-      _onAccept;
-      // Subscribe to the onAccept function.
-      untrack(() => {
-        // If there is no context, return.
-        if (!ctx.current) return;
-        if (!("me" in ctx.current)) return;
-
-        // Consume the invite link from the window location.
-        const result = consumeInviteLinkFromWindowLocation({
-          as: ctx.current.me,
-          invitedObjectSchema,
-          forValueHint,
-        });
-        // If the result is valid, call the onAccept function.
-        result
-          .then((result) => result && _onAccept(result?.valueID))
-          .catch((e) => {
-            console.error("Failed to accept invite", e);
-          });
-      });
+      untrack(tryConsume);
+    });
+
+    window.addEventListener("hashchange", tryConsume);
+
+    onDestroy(() => {
+      window.removeEventListener("hashchange", tryConsume);
     });
   }
 }

package/src/worker/index.ts

@@ -91,7 +91,6 @@ export async function startWorker<
       secret: accountSecret as AgentSecret,
     },
     AccountSchema,
-    // TODO: locked sessions similar to browser
     sessionProvider: randomSessionProvider,
     peersToLoadFrom,
     crypto: options.crypto ?? (await WasmCrypto.create()),
@@ -123,10 +122,23 @@ export async function startWorker<
       };
 
   return {
+    /**
+     * The worker account instance.
+     */
     worker: context.account as Loaded<S>,
     experimental: {
+      /**
+       * API to subscribe to the inbox messages.
+       *
+       * More info on the Inbox API: https://jazz.tools/docs/react/server-side/inbox
+       */
       inbox: inboxPublicApi,
     },
+    /**
+     * Wait for the connection to the sync server to be established.
+     *
+     * If already connected, it will resolve immediately.
+     */
     waitForConnection() {
       return wsPeer.waitUntilConnected();
     },
@@ -137,6 +149,21 @@ export async function startWorker<
         wsPeer.unsubscribe(listener);
       };
     },
+    /**
+     * Waits for all CoValues to sync and then shuts down the worker.
+     *
+     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()
+     *
+     * @deprecated Use shutdownWorker
+     */
     done,
+    /**
+     * Waits for all CoValues to sync and then shuts down the worker.
+     *
+     * To only wait for sync use worker.$jazz.waitForAllCoValuesSync()
+     */
+    shutdownWorker() {
+      return done();
+    },
   };
 }