syncorejs 0.2.1 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/_vendor/cli/app.d.mts.map +1 -1
- package/dist/_vendor/cli/app.mjs +330 -46
- package/dist/_vendor/cli/app.mjs.map +1 -1
- package/dist/_vendor/cli/context.mjs +27 -9
- package/dist/_vendor/cli/context.mjs.map +1 -1
- package/dist/_vendor/cli/dev-session.mjs.map +1 -1
- package/dist/_vendor/cli/doctor.mjs +513 -46
- package/dist/_vendor/cli/doctor.mjs.map +1 -1
- package/dist/_vendor/cli/errors.mjs.map +1 -1
- package/dist/_vendor/cli/help.mjs.map +1 -1
- package/dist/_vendor/cli/index.mjs +9 -2
- package/dist/_vendor/cli/index.mjs.map +1 -1
- package/dist/_vendor/cli/messages.mjs +5 -4
- package/dist/_vendor/cli/messages.mjs.map +1 -1
- package/dist/_vendor/cli/preflight.mjs.map +1 -1
- package/dist/_vendor/cli/project.mjs +125 -27
- package/dist/_vendor/cli/project.mjs.map +1 -1
- package/dist/_vendor/cli/render.mjs +57 -9
- package/dist/_vendor/cli/render.mjs.map +1 -1
- package/dist/_vendor/cli/targets.mjs +4 -3
- package/dist/_vendor/cli/targets.mjs.map +1 -1
- package/dist/_vendor/core/cli.d.mts +20 -4
- package/dist/_vendor/core/cli.d.mts.map +1 -1
- package/dist/_vendor/core/cli.mjs +458 -133
- package/dist/_vendor/core/cli.mjs.map +1 -1
- package/dist/_vendor/core/devtools-auth.mjs +60 -0
- package/dist/_vendor/core/devtools-auth.mjs.map +1 -0
- package/dist/_vendor/core/index.d.mts +5 -3
- package/dist/_vendor/core/index.mjs +22 -2
- package/dist/_vendor/core/index.mjs.map +1 -1
- package/dist/_vendor/core/runtime/components.d.mts +111 -0
- package/dist/_vendor/core/runtime/components.d.mts.map +1 -0
- package/dist/_vendor/core/runtime/components.mjs +186 -0
- package/dist/_vendor/core/runtime/components.mjs.map +1 -0
- package/dist/_vendor/core/runtime/devtools.d.mts +4 -4
- package/dist/_vendor/core/runtime/devtools.d.mts.map +1 -1
- package/dist/_vendor/core/runtime/devtools.mjs +178 -60
- package/dist/_vendor/core/runtime/devtools.mjs.map +1 -1
- package/dist/_vendor/core/runtime/functions.d.mts +398 -16
- package/dist/_vendor/core/runtime/functions.d.mts.map +1 -1
- package/dist/_vendor/core/runtime/functions.mjs +74 -3
- package/dist/_vendor/core/runtime/functions.mjs.map +1 -1
- package/dist/_vendor/core/runtime/id.d.mts.map +1 -1
- package/dist/_vendor/core/runtime/id.mjs.map +1 -1
- package/dist/_vendor/core/runtime/internal/engines/devtoolsEngine.mjs +83 -0
- package/dist/_vendor/core/runtime/internal/engines/devtoolsEngine.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/engines/executionEngine.mjs +720 -0
- package/dist/_vendor/core/runtime/internal/engines/executionEngine.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/engines/reactivityEngine.mjs +234 -0
- package/dist/_vendor/core/runtime/internal/engines/reactivityEngine.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/engines/schedulerEngine.mjs +255 -0
- package/dist/_vendor/core/runtime/internal/engines/schedulerEngine.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/engines/schemaEngine.mjs +200 -0
- package/dist/_vendor/core/runtime/internal/engines/schemaEngine.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/engines/shared.mjs +252 -0
- package/dist/_vendor/core/runtime/internal/engines/shared.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/engines/storageEngine.mjs +145 -0
- package/dist/_vendor/core/runtime/internal/engines/storageEngine.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/runtimeKernel.mjs +221 -0
- package/dist/_vendor/core/runtime/internal/runtimeKernel.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/runtimeStatus.mjs +32 -0
- package/dist/_vendor/core/runtime/internal/runtimeStatus.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/systemMeta.mjs +61 -0
- package/dist/_vendor/core/runtime/internal/systemMeta.mjs.map +1 -0
- package/dist/_vendor/core/runtime/internal/transactionCoordinator.mjs +41 -0
- package/dist/_vendor/core/runtime/internal/transactionCoordinator.mjs.map +1 -0
- package/dist/_vendor/core/runtime/runtime.d.mts +1187 -202
- package/dist/_vendor/core/runtime/runtime.d.mts.map +1 -1
- package/dist/_vendor/core/runtime/runtime.mjs +73 -1365
- package/dist/_vendor/core/runtime/runtime.mjs.map +1 -1
- package/dist/_vendor/core/transport.d.mts +113 -0
- package/dist/_vendor/core/transport.d.mts.map +1 -0
- package/dist/_vendor/core/transport.mjs +428 -0
- package/dist/_vendor/core/transport.mjs.map +1 -0
- package/dist/_vendor/devtools-protocol/index.d.ts +187 -4
- package/dist/_vendor/devtools-protocol/index.d.ts.map +1 -1
- package/dist/_vendor/devtools-protocol/index.js +25 -9
- package/dist/_vendor/devtools-protocol/index.js.map +1 -1
- package/dist/_vendor/next/config.d.ts +3 -4
- package/dist/_vendor/next/config.d.ts.map +1 -1
- package/dist/_vendor/next/config.js +37 -19
- package/dist/_vendor/next/config.js.map +1 -1
- package/dist/_vendor/next/index.d.ts +109 -29
- package/dist/_vendor/next/index.d.ts.map +1 -1
- package/dist/_vendor/next/index.js +104 -26
- package/dist/_vendor/next/index.js.map +1 -1
- package/dist/_vendor/platform-expo/index.d.ts +156 -37
- package/dist/_vendor/platform-expo/index.d.ts.map +1 -1
- package/dist/_vendor/platform-expo/index.js +80 -12
- package/dist/_vendor/platform-expo/index.js.map +1 -1
- package/dist/_vendor/platform-expo/react.d.ts.map +1 -1
- package/dist/_vendor/platform-expo/react.js +11 -10
- package/dist/_vendor/platform-expo/react.js.map +1 -1
- package/dist/_vendor/platform-expo/web-sqljs-wasm.js +16 -0
- package/dist/_vendor/platform-expo/web-sqljs-wasm.js.map +1 -0
- package/dist/_vendor/platform-node/index.d.mts +192 -24
- package/dist/_vendor/platform-node/index.d.mts.map +1 -1
- package/dist/_vendor/platform-node/index.mjs +236 -97
- package/dist/_vendor/platform-node/index.mjs.map +1 -1
- package/dist/_vendor/platform-node/ipc-react.d.mts.map +1 -1
- package/dist/_vendor/platform-node/ipc-react.mjs +15 -2
- package/dist/_vendor/platform-node/ipc-react.mjs.map +1 -1
- package/dist/_vendor/platform-node/ipc.d.mts +11 -35
- package/dist/_vendor/platform-node/ipc.d.mts.map +1 -1
- package/dist/_vendor/platform-node/ipc.mjs +3 -273
- package/dist/_vendor/platform-node/ipc.mjs.map +1 -1
- package/dist/_vendor/platform-web/external-change.d.ts +43 -1
- package/dist/_vendor/platform-web/external-change.d.ts.map +1 -1
- package/dist/_vendor/platform-web/external-change.js +32 -1
- package/dist/_vendor/platform-web/external-change.js.map +1 -1
- package/dist/_vendor/platform-web/index.d.ts +323 -51
- package/dist/_vendor/platform-web/index.d.ts.map +1 -1
- package/dist/_vendor/platform-web/index.js +233 -30
- package/dist/_vendor/platform-web/index.js.map +1 -1
- package/dist/_vendor/platform-web/indexeddb.d.ts +12 -0
- package/dist/_vendor/platform-web/indexeddb.d.ts.map +1 -1
- package/dist/_vendor/platform-web/indexeddb.js +10 -0
- package/dist/_vendor/platform-web/indexeddb.js.map +1 -1
- package/dist/_vendor/platform-web/opfs.d.ts +13 -0
- package/dist/_vendor/platform-web/opfs.d.ts.map +1 -1
- package/dist/_vendor/platform-web/opfs.js +12 -0
- package/dist/_vendor/platform-web/opfs.js.map +1 -1
- package/dist/_vendor/platform-web/persistence.d.ts +54 -0
- package/dist/_vendor/platform-web/persistence.d.ts.map +1 -1
- package/dist/_vendor/platform-web/persistence.js +15 -0
- package/dist/_vendor/platform-web/persistence.js.map +1 -1
- package/dist/_vendor/platform-web/react.d.ts +1 -2
- package/dist/_vendor/platform-web/react.d.ts.map +1 -1
- package/dist/_vendor/platform-web/react.js +27 -13
- package/dist/_vendor/platform-web/react.js.map +1 -1
- package/dist/_vendor/platform-web/sqljs.js +10 -1
- package/dist/_vendor/platform-web/sqljs.js.map +1 -1
- package/dist/_vendor/platform-web/web-sqljs-wasm.js +8 -0
- package/dist/_vendor/platform-web/web-sqljs-wasm.js.map +1 -0
- package/dist/_vendor/platform-web/worker.d.ts +71 -44
- package/dist/_vendor/platform-web/worker.d.ts.map +1 -1
- package/dist/_vendor/platform-web/worker.js +40 -271
- package/dist/_vendor/platform-web/worker.js.map +1 -1
- package/dist/_vendor/react/index.d.ts +222 -23
- package/dist/_vendor/react/index.d.ts.map +1 -1
- package/dist/_vendor/react/index.js +476 -63
- package/dist/_vendor/react/index.js.map +1 -1
- package/dist/_vendor/schema/definition.d.ts +151 -37
- package/dist/_vendor/schema/definition.d.ts.map +1 -1
- package/dist/_vendor/schema/definition.js +102 -20
- package/dist/_vendor/schema/definition.js.map +1 -1
- package/dist/_vendor/schema/index.d.ts +4 -4
- package/dist/_vendor/schema/index.js +2 -2
- package/dist/_vendor/schema/planner.d.ts +19 -2
- package/dist/_vendor/schema/planner.d.ts.map +1 -1
- package/dist/_vendor/schema/planner.js +79 -3
- package/dist/_vendor/schema/planner.js.map +1 -1
- package/dist/_vendor/schema/validators.d.ts +279 -83
- package/dist/_vendor/schema/validators.d.ts.map +1 -1
- package/dist/_vendor/schema/validators.js +330 -38
- package/dist/_vendor/schema/validators.js.map +1 -1
- package/dist/_vendor/svelte/index.d.ts +245 -19
- package/dist/_vendor/svelte/index.d.ts.map +1 -1
- package/dist/_vendor/svelte/index.js +443 -20
- package/dist/_vendor/svelte/index.js.map +1 -1
- package/dist/browser.d.ts.map +1 -1
- package/dist/cli.js +3 -1
- package/dist/cli.js.map +1 -1
- package/dist/components.d.ts +2 -0
- package/dist/components.js +2 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.js +2 -1
- package/package.json +29 -21
|
@@ -1,63 +1,141 @@
|
|
|
1
1
|
import { createSyncoreNextWorkerUrl, getSyncoreWorkerUrl } from "./config.js";
|
|
2
2
|
import { ManagedWebWorkerClient } from "../platform-web/index.d.ts";
|
|
3
3
|
import { ReactNode } from "react";
|
|
4
|
-
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
|
5
4
|
|
|
6
5
|
//#region src/index.d.ts
|
|
6
|
+
/**
|
|
7
|
+
* Shared configuration options for the Syncore Next.js integration.
|
|
8
|
+
*
|
|
9
|
+
* Accepted by both {@link SyncoreNextProvider} and
|
|
10
|
+
* {@link registerSyncoreServiceWorker}.
|
|
11
|
+
*/
|
|
7
12
|
interface SyncoreNextOptions {
|
|
8
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* URL of the Next PWA service worker. Defaults to `"/sw.js"` (the path
|
|
15
|
+
* emitted by `next-pwa` or `@ducanh2912/next-pwa`).
|
|
16
|
+
*/
|
|
9
17
|
serviceWorkerUrl?: string;
|
|
10
|
-
/**
|
|
11
|
-
|
|
12
|
-
|
|
18
|
+
/**
|
|
19
|
+
* Public path to the compiled Syncore worker asset. Defaults to
|
|
20
|
+
* `"/syncore.worker.js"`. Override if your build tool emits the worker to a
|
|
21
|
+
* different path.
|
|
22
|
+
*/
|
|
13
23
|
workerAssetUrl?: string;
|
|
14
24
|
}
|
|
15
25
|
/**
|
|
16
|
-
*
|
|
26
|
+
* Handle returned by {@link registerSyncoreServiceWorker}.
|
|
17
27
|
*/
|
|
18
28
|
interface SyncoreServiceWorkerRegistration {
|
|
19
29
|
/** Unregister the installed service worker. */
|
|
20
30
|
unregister(): Promise<boolean>;
|
|
21
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Instruct the browser to check for a new service worker version. Useful
|
|
33
|
+
* for implementing an “Update available” prompt.
|
|
34
|
+
*/
|
|
22
35
|
update(): Promise<ServiceWorkerRegistration>;
|
|
23
36
|
}
|
|
24
37
|
/**
|
|
25
|
-
* Register the Syncore service worker
|
|
38
|
+
* Register the Syncore PWA service worker in a Next.js app.
|
|
39
|
+
*
|
|
40
|
+
* Call this once at app startup (e.g. in your root layout’s `useEffect`, or in
|
|
41
|
+
* `instrumentation.ts` with `"use client"`). Returns `null` on the server or
|
|
42
|
+
* when the browser does not support service workers.
|
|
43
|
+
*
|
|
44
|
+
* ```ts
|
|
45
|
+
* // app/layout.tsx (client component)
|
|
46
|
+
* import { registerSyncoreServiceWorker } from "syncorejs/next";
|
|
47
|
+
*
|
|
48
|
+
* useEffect(() => {
|
|
49
|
+
* registerSyncoreServiceWorker({ serviceWorkerUrl: "/sw.js" });
|
|
50
|
+
* }, []);
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param options - Optional configuration. Defaults to `"/sw.js"`.
|
|
54
|
+
* @returns A {@link SyncoreServiceWorkerRegistration} handle, or `null` on
|
|
55
|
+
* the server / when unsupported.
|
|
26
56
|
*/
|
|
27
57
|
declare function registerSyncoreServiceWorker(options?: SyncoreNextOptions): Promise<SyncoreServiceWorkerRegistration | null>;
|
|
28
58
|
/**
|
|
29
|
-
*
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
*
|
|
59
|
+
* Create a worker-backed Syncore client for a Next.js app.
|
|
60
|
+
*
|
|
61
|
+
* The client communicates with a Syncore runtime running inside a `Worker`.
|
|
62
|
+
* The worker runs the SQLite engine and all function handlers off the main
|
|
63
|
+
* thread so the UI stays responsive.
|
|
64
|
+
*
|
|
65
|
+
* In most cases you should use {@link SyncoreNextProvider} instead, which
|
|
66
|
+
* manages the client lifecycle automatically. Use `createNextSyncoreClient`
|
|
67
|
+
* directly only when you need to control the client lifecycle yourself (e.g.
|
|
68
|
+
* in testing harnesses or custom providers).
|
|
69
|
+
*
|
|
70
|
+
* ```ts
|
|
71
|
+
* const managedClient = createNextSyncoreClient({
|
|
72
|
+
* workerAssetUrl: "/syncore.worker.js",
|
|
73
|
+
* });
|
|
74
|
+
*
|
|
75
|
+
* // Later:
|
|
76
|
+
* managedClient.dispose();
|
|
77
|
+
* ```
|
|
34
78
|
*/
|
|
35
79
|
declare function createNextSyncoreClient(options: {
|
|
36
80
|
/**
|
|
37
|
-
*
|
|
38
|
-
*
|
|
81
|
+
* Custom worker factory function. Useful in tests (supply a `Worker` backed
|
|
82
|
+
* by a mock or in-process runtime) or when using Next’s App Router dev-mode
|
|
83
|
+
* bundling where `new Worker(new URL(...))` must be used inside the component.
|
|
39
84
|
*/
|
|
40
|
-
createWorker?: () => Worker; /**
|
|
41
|
-
workerUrl?: URL | string; /**
|
|
85
|
+
createWorker?: () => Worker; /** Explicit module URL for an already-public worker script. */
|
|
86
|
+
workerUrl?: URL | string; /** Public asset path for the compiled worker file. Defaults to `"/syncore.worker.js"`. */
|
|
42
87
|
workerAssetUrl?: string;
|
|
43
88
|
}): ManagedWebWorkerClient;
|
|
44
89
|
/**
|
|
45
|
-
*
|
|
90
|
+
* React component that registers a PWA service worker as a side-effect.
|
|
91
|
+
*
|
|
92
|
+
* Renders its `children` immediately (no loading state) and registers the
|
|
93
|
+
* service worker asynchronously. Safe to render on the server — the
|
|
94
|
+
* registration effect only runs in browsers that support service workers.
|
|
95
|
+
*
|
|
96
|
+
* ```tsx
|
|
97
|
+
* <SyncoreServiceWorker serviceWorkerUrl="/sw.js" onRegistered={console.log}>
|
|
98
|
+
* <App />
|
|
99
|
+
* </SyncoreServiceWorker>
|
|
100
|
+
* ```
|
|
46
101
|
*/
|
|
47
102
|
declare function SyncoreServiceWorker({
|
|
48
103
|
children,
|
|
49
104
|
serviceWorkerUrl,
|
|
50
105
|
onRegistered
|
|
51
106
|
}: {
|
|
52
|
-
children: ReactNode;
|
|
53
|
-
serviceWorkerUrl?: string;
|
|
107
|
+
children: ReactNode; /** URL of the service worker script. Defaults to `"/sw.js"`. */
|
|
108
|
+
serviceWorkerUrl?: string; /** Called after the service worker is successfully registered. */
|
|
54
109
|
onRegistered?: (registration: ServiceWorkerRegistration) => void;
|
|
55
110
|
}): ReactNode;
|
|
56
111
|
/**
|
|
57
|
-
*
|
|
112
|
+
* Root provider that wires a worker-backed Syncore runtime into a Next.js
|
|
113
|
+
* React tree.
|
|
114
|
+
*
|
|
115
|
+
* Place this at the top of your App Router layout. It spawns the Syncore
|
|
116
|
+
* worker on mount, exposes the client via React context (accessible with
|
|
117
|
+
* `useSyncore()`), and optionally registers the PWA service worker.
|
|
118
|
+
*
|
|
119
|
+
* ```tsx
|
|
120
|
+
* // app/layout.tsx
|
|
121
|
+
* import { SyncoreNextProvider } from "syncorejs/next";
|
|
58
122
|
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
123
|
+
* export default function RootLayout({ children }) {
|
|
124
|
+
* return (
|
|
125
|
+
* <html>
|
|
126
|
+
* <body>
|
|
127
|
+
* <SyncoreNextProvider
|
|
128
|
+
* createWorker={() => new Worker(
|
|
129
|
+
* new URL("../syncore.worker.ts", import.meta.url)
|
|
130
|
+
* )}
|
|
131
|
+
* >
|
|
132
|
+
* {children}
|
|
133
|
+
* </SyncoreNextProvider>
|
|
134
|
+
* </body>
|
|
135
|
+
* </html>
|
|
136
|
+
* );
|
|
137
|
+
* }
|
|
138
|
+
* ```
|
|
61
139
|
*/
|
|
62
140
|
declare function SyncoreNextProvider({
|
|
63
141
|
children,
|
|
@@ -68,13 +146,15 @@ declare function SyncoreNextProvider({
|
|
|
68
146
|
}: {
|
|
69
147
|
/** The React subtree that should receive the Syncore client. */children: ReactNode;
|
|
70
148
|
/**
|
|
71
|
-
*
|
|
149
|
+
* Factory function that creates the Syncore `Worker`. Required in Next App
|
|
150
|
+
* Router dev mode because `new Worker(new URL(..., import.meta.url))` must
|
|
151
|
+
* be called inside the module to be bundled correctly.
|
|
72
152
|
*/
|
|
73
|
-
createWorker?: () => Worker; /**
|
|
74
|
-
serviceWorkerUrl?: string; /**
|
|
75
|
-
workerUrl?: URL | string; /**
|
|
153
|
+
createWorker?: () => Worker; /** URL of the PWA service worker script. Omit to skip service worker registration. */
|
|
154
|
+
serviceWorkerUrl?: string; /** Explicit module URL for an already-public worker asset. */
|
|
155
|
+
workerUrl?: URL | string; /** Public asset path for the compiled worker file. Defaults to `"/syncore.worker.js"`. */
|
|
76
156
|
workerAssetUrl?: string;
|
|
77
|
-
}):
|
|
157
|
+
}): import("react/jsx-runtime").JSX.Element;
|
|
78
158
|
//#endregion
|
|
79
|
-
export { SyncoreNextOptions, SyncoreNextProvider, SyncoreServiceWorker, SyncoreServiceWorkerRegistration, createNextSyncoreClient, createSyncoreNextWorkerUrl, getSyncoreWorkerUrl, registerSyncoreServiceWorker
|
|
159
|
+
export { SyncoreNextOptions, SyncoreNextProvider, SyncoreServiceWorker, SyncoreServiceWorkerRegistration, createNextSyncoreClient, createSyncoreNextWorkerUrl, getSyncoreWorkerUrl, registerSyncoreServiceWorker };
|
|
80
160
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;AA4BA;;;;AAYgB;UAZC,kBAAA;EAkBgC;;;;EAb/C,gBAAA;EAqBiB;;;;;EAdjB,cAAc;AAAA;;AAc6B;AAuB7C;UA/BiB,gCAAA;;EAEf,UAAA,IAAc,OAAA;EA+BL;;;;EAzBT,MAAA,IAAU,OAAA,CAAQ,yBAAA;AAAA;;;;AAyBuB;AAoC3C;;;;;;;;;;;;;;;;iBAtCsB,4BAAA,CACpB,OAAA,GAAU,kBAAA,GACT,OAAA,CAAQ,gCAAA;AA2EX;;;;;;;;;;;;;;;;;;;;;AAAA,iBAvCgB,uBAAA,CAAwB,OAAA;EAgDtB;;;AACjB;AA6CD;EAxFE,YAAA,SAAqB,MAAA;EAGrB,SAAA,GAAY,GAAA,WAuFZ;EApFA,cAAA;AAAA,IACE,sBAAA;;;;;;;;;;;;;;iBA0BY,oBAAA,CAAA;EACd,QAAA;EACA,gBAAA;EACA;AAAA;EAEA,QAAA,EAAU,SAAA,EAuDV;EArDA,gBAAA,WAwDU;EAtDV,YAAA,IAAgB,YAAA,EAAc,yBAAA;AAAA,IAC/B,SAAA;;;;;;;;AAsEA;;;;;;;;;;;;;;;;;;;;;;iBAzBe,mBAAA,CAAA;EACd,QAAA;EACA,YAAA;EACA,gBAAA;EACA,SAAA;EACA;AAAA;kEAGA,QAAA,EAAU,SAAA;;;;;;EAOV,YAAA,SAAqB,MAAA;EAGrB,gBAAA;EAGA,SAAA,GAAY,GAAA;EAGZ,cAAA;AAAA,gCACD,GAAA,CAAA,OAAA"}
|
|
@@ -1,11 +1,29 @@
|
|
|
1
1
|
import { createSyncoreNextWorkerUrl, getSyncoreWorkerUrl } from "./config.js";
|
|
2
|
+
import { createUnavailableSyncoreClient } from "../core/index.mjs";
|
|
2
3
|
import { createManagedWebWorkerClient, createSyncoreWebWorkerClient } from "../platform-web/index.js";
|
|
3
4
|
import { SyncoreProvider } from "../react/index.js";
|
|
4
|
-
import { useEffect, useState } from "react";
|
|
5
|
+
import { useEffect, useMemo, useRef, useState } from "react";
|
|
5
6
|
import { jsx } from "react/jsx-runtime";
|
|
6
7
|
//#region src/index.tsx
|
|
7
8
|
/**
|
|
8
|
-
* Register the Syncore service worker
|
|
9
|
+
* Register the Syncore PWA service worker in a Next.js app.
|
|
10
|
+
*
|
|
11
|
+
* Call this once at app startup (e.g. in your root layout’s `useEffect`, or in
|
|
12
|
+
* `instrumentation.ts` with `"use client"`). Returns `null` on the server or
|
|
13
|
+
* when the browser does not support service workers.
|
|
14
|
+
*
|
|
15
|
+
* ```ts
|
|
16
|
+
* // app/layout.tsx (client component)
|
|
17
|
+
* import { registerSyncoreServiceWorker } from "syncorejs/next";
|
|
18
|
+
*
|
|
19
|
+
* useEffect(() => {
|
|
20
|
+
* registerSyncoreServiceWorker({ serviceWorkerUrl: "/sw.js" });
|
|
21
|
+
* }, []);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @param options - Optional configuration. Defaults to `"/sw.js"`.
|
|
25
|
+
* @returns A {@link SyncoreServiceWorkerRegistration} handle, or `null` on
|
|
26
|
+
* the server / when unsupported.
|
|
9
27
|
*/
|
|
10
28
|
async function registerSyncoreServiceWorker(options) {
|
|
11
29
|
if (typeof window === "undefined" || !("serviceWorker" in navigator)) return null;
|
|
@@ -16,20 +34,42 @@ async function registerSyncoreServiceWorker(options) {
|
|
|
16
34
|
};
|
|
17
35
|
}
|
|
18
36
|
/**
|
|
19
|
-
*
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
*
|
|
37
|
+
* Create a worker-backed Syncore client for a Next.js app.
|
|
38
|
+
*
|
|
39
|
+
* The client communicates with a Syncore runtime running inside a `Worker`.
|
|
40
|
+
* The worker runs the SQLite engine and all function handlers off the main
|
|
41
|
+
* thread so the UI stays responsive.
|
|
42
|
+
*
|
|
43
|
+
* In most cases you should use {@link SyncoreNextProvider} instead, which
|
|
44
|
+
* manages the client lifecycle automatically. Use `createNextSyncoreClient`
|
|
45
|
+
* directly only when you need to control the client lifecycle yourself (e.g.
|
|
46
|
+
* in testing harnesses or custom providers).
|
|
47
|
+
*
|
|
48
|
+
* ```ts
|
|
49
|
+
* const managedClient = createNextSyncoreClient({
|
|
50
|
+
* workerAssetUrl: "/syncore.worker.js",
|
|
51
|
+
* });
|
|
52
|
+
*
|
|
53
|
+
* // Later:
|
|
54
|
+
* managedClient.dispose();
|
|
55
|
+
* ```
|
|
26
56
|
*/
|
|
27
57
|
function createNextSyncoreClient(options) {
|
|
28
58
|
if (options.createWorker) return createManagedWebWorkerClient({ createWorker: options.createWorker });
|
|
29
59
|
return createSyncoreWebWorkerClient({ workerUrl: options.workerUrl ?? options.workerAssetUrl ?? "/syncore.worker.js" });
|
|
30
60
|
}
|
|
31
61
|
/**
|
|
32
|
-
*
|
|
62
|
+
* React component that registers a PWA service worker as a side-effect.
|
|
63
|
+
*
|
|
64
|
+
* Renders its `children` immediately (no loading state) and registers the
|
|
65
|
+
* service worker asynchronously. Safe to render on the server — the
|
|
66
|
+
* registration effect only runs in browsers that support service workers.
|
|
67
|
+
*
|
|
68
|
+
* ```tsx
|
|
69
|
+
* <SyncoreServiceWorker serviceWorkerUrl="/sw.js" onRegistered={console.log}>
|
|
70
|
+
* <App />
|
|
71
|
+
* </SyncoreServiceWorker>
|
|
72
|
+
* ```
|
|
33
73
|
*/
|
|
34
74
|
function SyncoreServiceWorker({ children, serviceWorkerUrl, onRegistered }) {
|
|
35
75
|
useEffect(() => {
|
|
@@ -42,40 +82,78 @@ function SyncoreServiceWorker({ children, serviceWorkerUrl, onRegistered }) {
|
|
|
42
82
|
return children;
|
|
43
83
|
}
|
|
44
84
|
/**
|
|
45
|
-
*
|
|
85
|
+
* Root provider that wires a worker-backed Syncore runtime into a Next.js
|
|
86
|
+
* React tree.
|
|
87
|
+
*
|
|
88
|
+
* Place this at the top of your App Router layout. It spawns the Syncore
|
|
89
|
+
* worker on mount, exposes the client via React context (accessible with
|
|
90
|
+
* `useSyncore()`), and optionally registers the PWA service worker.
|
|
91
|
+
*
|
|
92
|
+
* ```tsx
|
|
93
|
+
* // app/layout.tsx
|
|
94
|
+
* import { SyncoreNextProvider } from "syncorejs/next";
|
|
46
95
|
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
96
|
+
* export default function RootLayout({ children }) {
|
|
97
|
+
* return (
|
|
98
|
+
* <html>
|
|
99
|
+
* <body>
|
|
100
|
+
* <SyncoreNextProvider
|
|
101
|
+
* createWorker={() => new Worker(
|
|
102
|
+
* new URL("../syncore.worker.ts", import.meta.url)
|
|
103
|
+
* )}
|
|
104
|
+
* >
|
|
105
|
+
* {children}
|
|
106
|
+
* </SyncoreNextProvider>
|
|
107
|
+
* </body>
|
|
108
|
+
* </html>
|
|
109
|
+
* );
|
|
110
|
+
* }
|
|
111
|
+
* ```
|
|
49
112
|
*/
|
|
50
113
|
function SyncoreNextProvider({ children, createWorker, serviceWorkerUrl, workerUrl, workerAssetUrl }) {
|
|
51
|
-
const
|
|
114
|
+
const createWorkerRef = useRef(createWorker);
|
|
115
|
+
createWorkerRef.current = createWorker;
|
|
52
116
|
const resolvedWorkerUrl = typeof workerUrl === "string" ? workerUrl : workerUrl?.toString();
|
|
117
|
+
const bootingClient = useMemo(() => createUnavailableSyncoreClient({
|
|
118
|
+
kind: "starting",
|
|
119
|
+
reason: "booting"
|
|
120
|
+
}), []);
|
|
121
|
+
const [client, setClient] = useState(bootingClient);
|
|
53
122
|
useEffect(() => {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
123
|
+
let managedClient;
|
|
124
|
+
setClient(bootingClient);
|
|
125
|
+
try {
|
|
126
|
+
const workerFactory = createWorkerRef.current;
|
|
127
|
+
managedClient = createNextSyncoreClient({
|
|
128
|
+
...workerFactory ? { createWorker: () => workerFactory() } : {},
|
|
129
|
+
...resolvedWorkerUrl ? { workerUrl: process.env.NODE_ENV === "production" ? getSyncoreWorkerUrl() : resolvedWorkerUrl } : {},
|
|
130
|
+
...workerAssetUrl ? { workerAssetUrl } : {}
|
|
131
|
+
});
|
|
132
|
+
setClient(managedClient.client);
|
|
133
|
+
} catch (error) {
|
|
134
|
+
setClient(createUnavailableSyncoreClient({
|
|
135
|
+
kind: "unavailable",
|
|
136
|
+
reason: "worker-unavailable",
|
|
137
|
+
...error instanceof Error ? { error } : {}
|
|
138
|
+
}));
|
|
139
|
+
}
|
|
60
140
|
return () => {
|
|
61
|
-
|
|
62
|
-
setManagedClient(null);
|
|
141
|
+
managedClient?.dispose();
|
|
63
142
|
};
|
|
64
143
|
}, [
|
|
65
|
-
|
|
144
|
+
bootingClient,
|
|
66
145
|
resolvedWorkerUrl,
|
|
67
146
|
workerAssetUrl
|
|
68
147
|
]);
|
|
69
|
-
if (!managedClient) return null;
|
|
70
148
|
return /* @__PURE__ */ jsx(SyncoreServiceWorker, {
|
|
71
149
|
...serviceWorkerUrl ? { serviceWorkerUrl } : {},
|
|
72
150
|
children: /* @__PURE__ */ jsx(SyncoreProvider, {
|
|
73
|
-
client
|
|
151
|
+
client,
|
|
74
152
|
children
|
|
75
153
|
})
|
|
76
154
|
});
|
|
77
155
|
}
|
|
78
156
|
//#endregion
|
|
79
|
-
export { SyncoreNextProvider, SyncoreServiceWorker, createNextSyncoreClient, createSyncoreNextWorkerUrl, getSyncoreWorkerUrl, registerSyncoreServiceWorker
|
|
157
|
+
export { SyncoreNextProvider, SyncoreServiceWorker, createNextSyncoreClient, createSyncoreNextWorkerUrl, getSyncoreWorkerUrl, registerSyncoreServiceWorker };
|
|
80
158
|
|
|
81
159
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/index.tsx"],"sourcesContent":["import {\n createManagedWebWorkerClient,\n createSyncoreWebWorkerClient,\n type ManagedWebWorkerClient\n} from \"@syncore/platform-web\";\nimport { SyncoreProvider } from \"@syncore/react\";\nimport { useEffect, useState, type ReactNode } from \"react\";\nimport { getSyncoreWorkerUrl } from \"./config.js\";\n\nexport { getSyncoreWorkerUrl } from \"./config.js\";\nexport { createSyncoreNextWorkerUrl } from \"./config.js\";\n\nexport interface SyncoreNextOptions {\n /** Optional service worker URL used to cache the application shell. */\n serviceWorkerUrl?: string;\n\n /** Optional URL for the `sql.js` wasm asset. */\n wasmAssetUrl?: string;\n\n /** Optional URL for the worker asset used by the local Syncore runtime. */\n workerAssetUrl?: string;\n}\n\n/**\n * The result of registering the Syncore service worker in a Next app.\n */\nexport interface SyncoreServiceWorkerRegistration {\n /** Unregister the installed service worker. */\n unregister(): Promise<boolean>;\n\n /** Ask the browser to check for an updated service worker. */\n update(): Promise<ServiceWorkerRegistration>;\n}\n\n/**\n * Register the Syncore service worker used by the Next integration.\n */\nexport async function registerSyncoreServiceWorker(\n options?: SyncoreNextOptions\n): Promise<SyncoreServiceWorkerRegistration | null> {\n if (typeof window === \"undefined\" || !(\"serviceWorker\" in navigator)) {\n return null;\n }\n\n const registration = await navigator.serviceWorker.register(\n options?.serviceWorkerUrl ?? \"/sw.js\"\n );\n\n return {\n unregister: () => registration.unregister(),\n update: () => registration.update()\n };\n}\n\n/**\n * Resolve the public URL used by SQL.js to load its wasm file in a Next app.\n */\nexport function resolveSqlJsWasmUrl(options?: SyncoreNextOptions): string {\n return options?.wasmAssetUrl ?? \"/sql-wasm.wasm\";\n}\n\n/**\n * Create a worker-backed Syncore client for a Next app.\n */\nexport function createNextSyncoreClient(options: {\n /**\n * Optional custom worker factory for tests or framework-specific worker\n * bundling patterns such as Next App Router development.\n */\n createWorker?: () => Worker;\n\n /** Optional explicit module URL for an already-public worker asset. */\n workerUrl?: URL | string;\n\n /** Optional public worker asset path for production builds. */\n workerAssetUrl?: string;\n}): ManagedWebWorkerClient {\n if (options.createWorker) {\n return createManagedWebWorkerClient({\n createWorker: options.createWorker\n });\n }\n\n return createSyncoreWebWorkerClient({\n workerUrl:\n options.workerUrl ?? options.workerAssetUrl ?? \"/syncore.worker.js\"\n });\n}\n\n/**\n * Register a service worker while rendering a React subtree.\n */\nexport function SyncoreServiceWorker({\n children,\n serviceWorkerUrl,\n onRegistered\n}: {\n children: ReactNode;\n serviceWorkerUrl?: string;\n onRegistered?: (registration: ServiceWorkerRegistration) => void;\n}) {\n useEffect(() => {\n void (async () => {\n if (typeof window === \"undefined\" || !(\"serviceWorker\" in navigator)) {\n return;\n }\n const registration = await navigator.serviceWorker.register(\n serviceWorkerUrl ?? \"/sw.js\"\n );\n onRegistered?.(registration);\n })();\n }, [onRegistered, serviceWorkerUrl]);\n\n return children;\n}\n\n/**\n * Provides a worker-backed Syncore client to a Next React tree.\n *\n * This is the shortest recommended integration for App Router pages that run\n * fully local in the browser.\n */\nexport function SyncoreNextProvider({\n children,\n createWorker,\n serviceWorkerUrl,\n workerUrl,\n workerAssetUrl\n}: {\n /** The React subtree that should receive the Syncore client. */\n children: ReactNode;\n\n /**\n * Optional custom worker factory for tests or Next colocated worker modules.\n */\n createWorker?: () => Worker;\n\n /** Optional service worker URL used to cache the application shell. */\n serviceWorkerUrl?: string;\n\n /** Optional explicit module URL for an already-public worker asset. */\n workerUrl?: URL | string;\n\n /** Optional public worker asset path for production builds. */\n workerAssetUrl?: string;\n}) {\n const [managedClient, setManagedClient] =\n useState<ManagedWebWorkerClient | null>(null);\n const resolvedWorkerUrl =\n typeof workerUrl === \"string\" ? workerUrl : workerUrl?.toString();\n\n useEffect(() => {\n const nextClient = createNextSyncoreClient({\n ...(createWorker ? { createWorker } : {}),\n ...(resolvedWorkerUrl\n ? {\n workerUrl:\n process.env.NODE_ENV === \"production\"\n ? getSyncoreWorkerUrl()\n : resolvedWorkerUrl\n }\n : {}),\n ...(workerAssetUrl ? { workerAssetUrl } : {})\n });\n setManagedClient(nextClient);\n\n return () => {\n nextClient.dispose();\n setManagedClient(null);\n };\n }, [createWorker, resolvedWorkerUrl, workerAssetUrl]);\n\n if (!managedClient) {\n return null;\n }\n\n return (\n <SyncoreServiceWorker {...(serviceWorkerUrl ? { serviceWorkerUrl } : {})}>\n <SyncoreProvider client={managedClient.client}>\n {children}\n </SyncoreProvider>\n </SyncoreServiceWorker>\n );\n}\n"],"mappings":";;;;;;;;;AAqCA,eAAsB,6BACpB,SACkD;AAClD,KAAI,OAAO,WAAW,eAAe,EAAE,mBAAmB,WACxD,QAAO;CAGT,MAAM,eAAe,MAAM,UAAU,cAAc,SACjD,SAAS,oBAAoB,SAC9B;AAED,QAAO;EACL,kBAAkB,aAAa,YAAY;EAC3C,cAAc,aAAa,QAAQ;EACpC;;;;;AAMH,SAAgB,oBAAoB,SAAsC;AACxE,QAAO,SAAS,gBAAgB;;;;;AAMlC,SAAgB,wBAAwB,SAYb;AACzB,KAAI,QAAQ,aACV,QAAO,6BAA6B,EAClC,cAAc,QAAQ,cACvB,CAAC;AAGJ,QAAO,6BAA6B,EAClC,WACE,QAAQ,aAAa,QAAQ,kBAAkB,sBAClD,CAAC;;;;;AAMJ,SAAgB,qBAAqB,EACnC,UACA,kBACA,gBAKC;AACD,iBAAgB;AACd,GAAM,YAAY;AAChB,OAAI,OAAO,WAAW,eAAe,EAAE,mBAAmB,WACxD;GAEF,MAAM,eAAe,MAAM,UAAU,cAAc,SACjD,oBAAoB,SACrB;AACD,kBAAe,aAAa;MAC1B;IACH,CAAC,cAAc,iBAAiB,CAAC;AAEpC,QAAO;;;;;;;;AAST,SAAgB,oBAAoB,EAClC,UACA,cACA,kBACA,WACA,kBAkBC;CACD,MAAM,CAAC,eAAe,oBACpB,SAAwC,KAAK;CAC/C,MAAM,oBACJ,OAAO,cAAc,WAAW,YAAY,WAAW,UAAU;AAEnE,iBAAgB;EACd,MAAM,aAAa,wBAAwB;GACzC,GAAI,eAAe,EAAE,cAAc,GAAG,EAAE;GACxC,GAAI,oBACA,EACE,WACE,QAAQ,IAAI,aAAa,eACrB,qBAAqB,GACrB,mBACP,GACD,EAAE;GACN,GAAI,iBAAiB,EAAE,gBAAgB,GAAG,EAAE;GAC7C,CAAC;AACF,mBAAiB,WAAW;AAE5B,eAAa;AACX,cAAW,SAAS;AACpB,oBAAiB,KAAK;;IAEvB;EAAC;EAAc;EAAmB;EAAe,CAAC;AAErD,KAAI,CAAC,cACH,QAAO;AAGT,QACE,oBAAC,sBAAD;EAAsB,GAAK,mBAAmB,EAAE,kBAAkB,GAAG,EAAE;YACrE,oBAAC,iBAAD;GAAiB,QAAQ,cAAc;GACpC;GACe,CAAA;EACG,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.tsx"],"sourcesContent":["import {\n createUnavailableSyncoreClient,\n type SyncoreClient\n} from \"@syncore/core\";\nimport {\n createManagedWebWorkerClient,\n createSyncoreWebWorkerClient,\n type ManagedWebWorkerClient\n} from \"@syncore/platform-web\";\nimport { SyncoreProvider } from \"@syncore/react\";\nimport {\n useEffect,\n useMemo,\n useRef,\n useState,\n type ReactNode\n} from \"react\";\nimport { getSyncoreWorkerUrl } from \"./config.js\";\n\nexport { getSyncoreWorkerUrl } from \"./config.js\";\nexport { createSyncoreNextWorkerUrl } from \"./config.js\";\n\n/**\n * Shared configuration options for the Syncore Next.js integration.\n *\n * Accepted by both {@link SyncoreNextProvider} and\n * {@link registerSyncoreServiceWorker}.\n */\nexport interface SyncoreNextOptions {\n /**\n * URL of the Next PWA service worker. Defaults to `\"/sw.js\"` (the path\n * emitted by `next-pwa` or `@ducanh2912/next-pwa`).\n */\n serviceWorkerUrl?: string;\n\n /**\n * Public path to the compiled Syncore worker asset. Defaults to\n * `\"/syncore.worker.js\"`. Override if your build tool emits the worker to a\n * different path.\n */\n workerAssetUrl?: string;\n}\n\n/**\n * Handle returned by {@link registerSyncoreServiceWorker}.\n */\nexport interface SyncoreServiceWorkerRegistration {\n /** Unregister the installed service worker. */\n unregister(): Promise<boolean>;\n\n /**\n * Instruct the browser to check for a new service worker version. Useful\n * for implementing an “Update available” prompt.\n */\n update(): Promise<ServiceWorkerRegistration>;\n}\n\n/**\n * Register the Syncore PWA service worker in a Next.js app.\n *\n * Call this once at app startup (e.g. in your root layout’s `useEffect`, or in\n * `instrumentation.ts` with `\"use client\"`). Returns `null` on the server or\n * when the browser does not support service workers.\n *\n * ```ts\n * // app/layout.tsx (client component)\n * import { registerSyncoreServiceWorker } from \"syncorejs/next\";\n *\n * useEffect(() => {\n * registerSyncoreServiceWorker({ serviceWorkerUrl: \"/sw.js\" });\n * }, []);\n * ```\n *\n * @param options - Optional configuration. Defaults to `\"/sw.js\"`.\n * @returns A {@link SyncoreServiceWorkerRegistration} handle, or `null` on\n * the server / when unsupported.\n */\nexport async function registerSyncoreServiceWorker(\n options?: SyncoreNextOptions\n): Promise<SyncoreServiceWorkerRegistration | null> {\n if (typeof window === \"undefined\" || !(\"serviceWorker\" in navigator)) {\n return null;\n }\n\n const registration = await navigator.serviceWorker.register(\n options?.serviceWorkerUrl ?? \"/sw.js\"\n );\n\n return {\n unregister: () => registration.unregister(),\n update: () => registration.update()\n };\n}\n\n/**\n * Create a worker-backed Syncore client for a Next.js app.\n *\n * The client communicates with a Syncore runtime running inside a `Worker`.\n * The worker runs the SQLite engine and all function handlers off the main\n * thread so the UI stays responsive.\n *\n * In most cases you should use {@link SyncoreNextProvider} instead, which\n * manages the client lifecycle automatically. Use `createNextSyncoreClient`\n * directly only when you need to control the client lifecycle yourself (e.g.\n * in testing harnesses or custom providers).\n *\n * ```ts\n * const managedClient = createNextSyncoreClient({\n * workerAssetUrl: \"/syncore.worker.js\",\n * });\n *\n * // Later:\n * managedClient.dispose();\n * ```\n */\nexport function createNextSyncoreClient(options: {\n /**\n * Custom worker factory function. Useful in tests (supply a `Worker` backed\n * by a mock or in-process runtime) or when using Next’s App Router dev-mode\n * bundling where `new Worker(new URL(...))` must be used inside the component.\n */\n createWorker?: () => Worker;\n\n /** Explicit module URL for an already-public worker script. */\n workerUrl?: URL | string;\n\n /** Public asset path for the compiled worker file. Defaults to `\"/syncore.worker.js\"`. */\n workerAssetUrl?: string;\n}): ManagedWebWorkerClient {\n if (options.createWorker) {\n return createManagedWebWorkerClient({\n createWorker: options.createWorker\n });\n }\n\n return createSyncoreWebWorkerClient({\n workerUrl:\n options.workerUrl ?? options.workerAssetUrl ?? \"/syncore.worker.js\"\n });\n}\n\n/**\n * React component that registers a PWA service worker as a side-effect.\n *\n * Renders its `children` immediately (no loading state) and registers the\n * service worker asynchronously. Safe to render on the server — the\n * registration effect only runs in browsers that support service workers.\n *\n * ```tsx\n * <SyncoreServiceWorker serviceWorkerUrl=\"/sw.js\" onRegistered={console.log}>\n * <App />\n * </SyncoreServiceWorker>\n * ```\n */\nexport function SyncoreServiceWorker({\n children,\n serviceWorkerUrl,\n onRegistered\n}: {\n children: ReactNode;\n /** URL of the service worker script. Defaults to `\"/sw.js\"`. */\n serviceWorkerUrl?: string;\n /** Called after the service worker is successfully registered. */\n onRegistered?: (registration: ServiceWorkerRegistration) => void;\n}) {\n useEffect(() => {\n void (async () => {\n if (typeof window === \"undefined\" || !(\"serviceWorker\" in navigator)) {\n return;\n }\n const registration = await navigator.serviceWorker.register(\n serviceWorkerUrl ?? \"/sw.js\"\n );\n onRegistered?.(registration);\n })();\n }, [onRegistered, serviceWorkerUrl]);\n\n return children;\n}\n\n/**\n * Root provider that wires a worker-backed Syncore runtime into a Next.js\n * React tree.\n *\n * Place this at the top of your App Router layout. It spawns the Syncore\n * worker on mount, exposes the client via React context (accessible with\n * `useSyncore()`), and optionally registers the PWA service worker.\n *\n * ```tsx\n * // app/layout.tsx\n * import { SyncoreNextProvider } from \"syncorejs/next\";\n *\n * export default function RootLayout({ children }) {\n * return (\n * <html>\n * <body>\n * <SyncoreNextProvider\n * createWorker={() => new Worker(\n * new URL(\"../syncore.worker.ts\", import.meta.url)\n * )}\n * >\n * {children}\n * </SyncoreNextProvider>\n * </body>\n * </html>\n * );\n * }\n * ```\n */\nexport function SyncoreNextProvider({\n children,\n createWorker,\n serviceWorkerUrl,\n workerUrl,\n workerAssetUrl\n}: {\n /** The React subtree that should receive the Syncore client. */\n children: ReactNode;\n\n /**\n * Factory function that creates the Syncore `Worker`. Required in Next App\n * Router dev mode because `new Worker(new URL(..., import.meta.url))` must\n * be called inside the module to be bundled correctly.\n */\n createWorker?: () => Worker;\n\n /** URL of the PWA service worker script. Omit to skip service worker registration. */\n serviceWorkerUrl?: string;\n\n /** Explicit module URL for an already-public worker asset. */\n workerUrl?: URL | string;\n\n /** Public asset path for the compiled worker file. Defaults to `\"/syncore.worker.js\"`. */\n workerAssetUrl?: string;\n}) {\n const createWorkerRef = useRef(createWorker);\n createWorkerRef.current = createWorker;\n const resolvedWorkerUrl =\n typeof workerUrl === \"string\" ? workerUrl : workerUrl?.toString();\n const bootingClient = useMemo(\n () =>\n createUnavailableSyncoreClient({\n kind: \"starting\",\n reason: \"booting\"\n }),\n []\n );\n const [client, setClient] = useState<SyncoreClient>(bootingClient);\n\n useEffect(() => {\n let managedClient: ManagedWebWorkerClient | undefined;\n\n setClient(bootingClient);\n\n try {\n const workerFactory = createWorkerRef.current;\n managedClient = createNextSyncoreClient({\n ...(workerFactory\n ? {\n createWorker: () => workerFactory()\n }\n : {}),\n ...(resolvedWorkerUrl\n ? {\n workerUrl:\n process.env.NODE_ENV === \"production\"\n ? getSyncoreWorkerUrl()\n : resolvedWorkerUrl\n }\n : {}),\n ...(workerAssetUrl ? { workerAssetUrl } : {})\n });\n setClient(managedClient.client);\n } catch (error) {\n setClient(\n createUnavailableSyncoreClient({\n kind: \"unavailable\",\n reason: \"worker-unavailable\",\n ...(error instanceof Error ? { error } : {})\n })\n );\n }\n\n return () => {\n managedClient?.dispose();\n };\n }, [bootingClient, resolvedWorkerUrl, workerAssetUrl]);\n\n return (\n <SyncoreServiceWorker {...(serviceWorkerUrl ? { serviceWorkerUrl } : {})}>\n <SyncoreProvider client={client}>{children}</SyncoreProvider>\n </SyncoreServiceWorker>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA6EA,eAAsB,6BACpB,SACkD;CAClD,IAAI,OAAO,WAAW,eAAe,EAAE,mBAAmB,YACxD,OAAO;CAGT,MAAM,eAAe,MAAM,UAAU,cAAc,SACjD,SAAS,oBAAoB,QAC/B;CAEA,OAAO;EACL,kBAAkB,aAAa,WAAW;EAC1C,cAAc,aAAa,OAAO;CACpC;AACF;;;;;;;;;;;;;;;;;;;;;;AAuBA,SAAgB,wBAAwB,SAab;CACzB,IAAI,QAAQ,cACV,OAAO,6BAA6B,EAClC,cAAc,QAAQ,aACxB,CAAC;CAGH,OAAO,6BAA6B,EAClC,WACE,QAAQ,aAAa,QAAQ,kBAAkB,qBACnD,CAAC;AACH;;;;;;;;;;;;;;AAeA,SAAgB,qBAAqB,EACnC,UACA,kBACA,gBAOC;CACD,gBAAgB;EACd,CAAM,YAAY;GAChB,IAAI,OAAO,WAAW,eAAe,EAAE,mBAAmB,YACxD;GAEF,MAAM,eAAe,MAAM,UAAU,cAAc,SACjD,oBAAoB,QACtB;GACA,eAAe,YAAY;EAC7B,GAAG;CACL,GAAG,CAAC,cAAc,gBAAgB,CAAC;CAEnC,OAAO;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,SAAgB,oBAAoB,EAClC,UACA,cACA,kBACA,WACA,kBAoBC;CACD,MAAM,kBAAkB,OAAO,YAAY;CAC3C,gBAAgB,UAAU;CAC1B,MAAM,oBACJ,OAAO,cAAc,WAAW,YAAY,WAAW,SAAS;CAClE,MAAM,gBAAgB,cAElB,+BAA+B;EAC7B,MAAM;EACN,QAAQ;CACV,CAAC,GACH,CAAC,CACH;CACA,MAAM,CAAC,QAAQ,aAAa,SAAwB,aAAa;CAEjE,gBAAgB;EACd,IAAI;EAEJ,UAAU,aAAa;EAEvB,IAAI;GACF,MAAM,gBAAgB,gBAAgB;GACtC,gBAAgB,wBAAwB;IACtC,GAAI,gBACA,EACE,oBAAoB,cAAc,EACpC,IACA,CAAC;IACL,GAAI,oBACA,EACE,WACE,QAAQ,IAAI,aAAa,eACrB,oBAAoB,IACpB,kBACR,IACA,CAAC;IACL,GAAI,iBAAiB,EAAE,eAAe,IAAI,CAAC;GAC7C,CAAC;GACD,UAAU,cAAc,MAAM;EAChC,SAAS,OAAO;GACd,UACE,+BAA+B;IAC7B,MAAM;IACN,QAAQ;IACR,GAAI,iBAAiB,QAAQ,EAAE,MAAM,IAAI,CAAC;GAC5C,CAAC,CACH;EACF;EAEA,aAAa;GACX,eAAe,QAAQ;EACzB;CACF,GAAG;EAAC;EAAe;EAAmB;CAAc,CAAC;CAErD,OACE,oBAAC,sBAAD;EAAsB,GAAK,mBAAmB,EAAE,iBAAiB,IAAI,CAAC;YACpE,oBAAC,iBAAD;GAAyB;GAAS;EAA0B,CAAA;CACxC,CAAA;AAE1B"}
|
|
@@ -1,70 +1,189 @@
|
|
|
1
1
|
import { SQLiteDatabase } from "expo-sqlite";
|
|
2
|
-
import
|
|
3
|
-
import { AnySyncoreSchema, DevtoolsSink, SchedulerOptions, StorageObject, StorageWriteInput, SyncoreCapabilities, SyncoreExperimentalPlugin, SyncoreExternalChangeApplier, SyncoreExternalChangeSignal, SyncoreRuntime, SyncoreRuntimeOptions, SyncoreSqlDriver, SyncoreStorageAdapter } from "../core/index.d.mts";
|
|
2
|
+
import { DevtoolsSink, SchedulerOptions, StorageObject, StorageWriteInput, SyncoreCapabilities, SyncoreDataModel, SyncoreExternalChangeApplier, SyncoreExternalChangeSignal, SyncoreRuntime, SyncoreRuntimeOptions, SyncoreSqlDriver, SyncoreStorageAdapter } from "../core/index.d.mts";
|
|
4
3
|
|
|
5
4
|
//#region src/index.d.ts
|
|
6
|
-
type ExpoSyncoreSchema =
|
|
5
|
+
type ExpoSyncoreSchema<TSchema extends SyncoreDataModel = SyncoreDataModel> = TSchema;
|
|
7
6
|
/**
|
|
8
|
-
* Options for
|
|
7
|
+
* Options for {@link createExpoSyncoreRuntime}.
|
|
9
8
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
9
|
+
* On native (iOS/Android) Syncore uses `expo-sqlite` and `expo-file-system`
|
|
10
|
+
* automatically. When the same app is served on web (via `expo-router` or
|
|
11
|
+
* Metro’s web bundler) it falls back to the SQL.js + OPFS web stack instead.
|
|
12
|
+
*
|
|
13
|
+
* At minimum supply `schema` and `functions`. Everything else has platform
|
|
14
|
+
* defaults.
|
|
15
|
+
*
|
|
16
|
+
* ```ts
|
|
17
|
+
* const runtime = createExpoSyncoreRuntime({
|
|
18
|
+
* schema,
|
|
19
|
+
* functions,
|
|
20
|
+
* databaseName: "app.db",
|
|
21
|
+
* storageDirectoryName: "app-storage",
|
|
22
|
+
* });
|
|
23
|
+
* await runtime.start();
|
|
24
|
+
* ```
|
|
12
25
|
*/
|
|
13
|
-
interface CreateExpoRuntimeOptions {
|
|
14
|
-
/** The
|
|
15
|
-
schema:
|
|
16
|
-
/**
|
|
17
|
-
|
|
18
|
-
|
|
26
|
+
interface CreateExpoRuntimeOptions<TSchema extends ExpoSyncoreSchema = ExpoSyncoreSchema> {
|
|
27
|
+
/** The data model that defines the available tables and indexes. */
|
|
28
|
+
schema: TSchema;
|
|
29
|
+
/**
|
|
30
|
+
* The registered function map. Use the `functions` export from
|
|
31
|
+
* `syncore/_generated/functions.ts`.
|
|
32
|
+
*/
|
|
33
|
+
functions: SyncoreRuntimeOptions<TSchema>["functions"];
|
|
34
|
+
/**
|
|
35
|
+
* Resolved Syncore component instances. Only required when your app
|
|
36
|
+
* installs Syncore component packages.
|
|
37
|
+
*/
|
|
38
|
+
components?: SyncoreRuntimeOptions<TSchema>["components"];
|
|
39
|
+
/**
|
|
40
|
+
* Platform capabilities injected into `ctx.capabilities` inside function
|
|
41
|
+
* handlers.
|
|
42
|
+
*/
|
|
19
43
|
capabilities?: SyncoreCapabilities;
|
|
20
|
-
/**
|
|
44
|
+
/**
|
|
45
|
+
* Custom SQL driver. Defaults to an `ExpoSqliteDriver` backed by
|
|
46
|
+
* `expo-sqlite`.
|
|
47
|
+
*/
|
|
21
48
|
driver?: SyncoreSqlDriver;
|
|
22
|
-
/**
|
|
23
|
-
experimentalPlugins?: Array<SyncoreExperimentalPlugin<ExpoSyncoreSchema>>;
|
|
24
|
-
/** Optional custom file/blob storage adapter. */
|
|
49
|
+
/** Custom file/blob storage adapter. Defaults to `ExpoFileStorageAdapter`. */
|
|
25
50
|
storage?: SyncoreStorageAdapter;
|
|
26
|
-
/**
|
|
51
|
+
/**
|
|
52
|
+
* SQLite database filename (e.g. `"app.db"`). Defaults to `"syncore.db"`.
|
|
53
|
+
* The file is created inside the app-local documents directory on device.
|
|
54
|
+
*/
|
|
27
55
|
databaseName?: string;
|
|
28
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* Absolute path to the directory where the SQLite file is stored.
|
|
58
|
+
* Defaults to `expo-sqlite`’s `defaultDatabaseDirectory`.
|
|
59
|
+
*/
|
|
29
60
|
databaseDirectory?: string;
|
|
30
|
-
/**
|
|
61
|
+
/**
|
|
62
|
+
* Name of the sub-directory inside the app’s documents folder used for
|
|
63
|
+
* blob/file storage. Defaults to `"syncore-storage"`.
|
|
64
|
+
*/
|
|
31
65
|
storageDirectoryName?: string;
|
|
32
|
-
/**
|
|
66
|
+
/**
|
|
67
|
+
* Platform label reported to devtools. Defaults to `"expo"`. Override to
|
|
68
|
+
* `"expo-web"` when running on web.
|
|
69
|
+
*/
|
|
33
70
|
platform?: string;
|
|
34
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* Devtools event sink. Omit to disable devtools. On-device devtools
|
|
73
|
+
* connections require pointing to your development machine’s IP address.
|
|
74
|
+
*/
|
|
35
75
|
devtools?: DevtoolsSink;
|
|
36
|
-
/**
|
|
76
|
+
/** Scheduler configuration for background and recurring jobs. */
|
|
37
77
|
scheduler?: SchedulerOptions;
|
|
38
|
-
/**
|
|
78
|
+
/**
|
|
79
|
+
* External change signal used to keep multiple in-process instances in sync.
|
|
80
|
+
* On web, defaults to a `BroadcastChannel`-based signal automatically.
|
|
81
|
+
*/
|
|
39
82
|
externalChangeSignal?: SyncoreExternalChangeSignal;
|
|
40
|
-
/**
|
|
83
|
+
/**
|
|
84
|
+
* External change applier used when change events arrive from other tabs or
|
|
85
|
+
* processes. On web with `ExpoSqliteDriver`, defaults to
|
|
86
|
+
* `ExpoWebExternalChangeApplier` automatically.
|
|
87
|
+
*/
|
|
41
88
|
externalChangeApplier?: SyncoreExternalChangeApplier;
|
|
89
|
+
/**
|
|
90
|
+
* Direct URL to the SQL.js `.wasm` binary. Only needed when the app runs on
|
|
91
|
+
* web and the default CDN URL is unreachable.
|
|
92
|
+
*/
|
|
93
|
+
wasmUrl?: string;
|
|
94
|
+
/**
|
|
95
|
+
* Resolver for SQL.js support files (`.wasm`, `.worker.js`). Equivalent to
|
|
96
|
+
* the `locateFile` option in `initSqlJs()`. Only used on web.
|
|
97
|
+
*/
|
|
98
|
+
locateFile?: (fileName: string) => string;
|
|
42
99
|
}
|
|
43
100
|
/**
|
|
44
|
-
* A reusable
|
|
101
|
+
* A reusable, lazily-started Expo Syncore runtime handle.
|
|
102
|
+
*
|
|
103
|
+
* Created by {@link createExpoSyncoreBootstrap}. The bootstrap defers actual
|
|
104
|
+
* runtime startup until the first call to `getClient()` and keeps a single
|
|
105
|
+
* instance alive across React Navigation reloads.
|
|
106
|
+
*
|
|
107
|
+
* ```ts
|
|
108
|
+
* const bootstrap = createExpoSyncoreBootstrap({ schema, functions });
|
|
109
|
+
*
|
|
110
|
+
* // In your root component:
|
|
111
|
+
* const client = await bootstrap.getClient();
|
|
112
|
+
* ```
|
|
45
113
|
*/
|
|
46
|
-
interface ExpoSyncoreBootstrap {
|
|
47
|
-
/**
|
|
114
|
+
interface ExpoSyncoreBootstrap<TSchema extends ExpoSyncoreSchema = ExpoSyncoreSchema> {
|
|
115
|
+
/** @deprecated Access the runtime via `getClient()` instead. */
|
|
48
116
|
getRuntime(): never;
|
|
49
|
-
/**
|
|
50
|
-
|
|
51
|
-
|
|
117
|
+
/**
|
|
118
|
+
* Start the runtime on first call, then return the same client on subsequent
|
|
119
|
+
* calls. Safe to call from multiple places concurrently.
|
|
120
|
+
*/
|
|
121
|
+
getClient(): Promise<ReturnType<SyncoreRuntime<TSchema>["createClient"]>>;
|
|
122
|
+
/** Stop the running runtime instance if one is active. */
|
|
52
123
|
stop(): Promise<void>;
|
|
53
|
-
/**
|
|
124
|
+
/**
|
|
125
|
+
* Stop and discard the current runtime so the next `getClient()` call
|
|
126
|
+
* creates a fresh one. Useful after a full app reset or database migration.
|
|
127
|
+
*/
|
|
54
128
|
reset(): Promise<void>;
|
|
55
129
|
}
|
|
56
130
|
/**
|
|
57
|
-
* Create
|
|
131
|
+
* Create a Syncore runtime for Expo (React Native and Expo web) backed by
|
|
132
|
+
* `expo-sqlite` on native platforms and SQL.js on web.
|
|
133
|
+
*
|
|
134
|
+
* Returns an unstarted {@link SyncoreRuntime}. Call `await runtime.start()`
|
|
135
|
+
* before using the client:
|
|
136
|
+
*
|
|
137
|
+
* ```ts
|
|
138
|
+
* import { createExpoSyncoreRuntime } from "syncorejs/expo";
|
|
139
|
+
* import schema from "./syncore/schema";
|
|
140
|
+
* import { functions } from "./syncore/_generated/functions";
|
|
141
|
+
*
|
|
142
|
+
* const runtime = createExpoSyncoreRuntime({ schema, functions });
|
|
143
|
+
* await runtime.start();
|
|
144
|
+
* const client = runtime.createClient();
|
|
145
|
+
* ```
|
|
146
|
+
*
|
|
147
|
+
* For managed lifecycle in React components, prefer
|
|
148
|
+
* {@link createExpoSyncoreBootstrap} instead.
|
|
58
149
|
*/
|
|
59
|
-
declare function createExpoSyncoreRuntime(options: CreateExpoRuntimeOptions): SyncoreRuntime<
|
|
150
|
+
declare function createExpoSyncoreRuntime<TSchema extends ExpoSyncoreSchema>(options: CreateExpoRuntimeOptions<TSchema>): SyncoreRuntime<TSchema>;
|
|
60
151
|
/**
|
|
61
|
-
* Create a same-process Syncore client from a started Expo runtime.
|
|
152
|
+
* Create a same-process Syncore client directly from a started Expo runtime.
|
|
153
|
+
*
|
|
154
|
+
* Prefer this in scripts or non-component code. For React component trees,
|
|
155
|
+
* use {@link createExpoSyncoreBootstrap} instead to get automatic lifecycle
|
|
156
|
+
* management.
|
|
157
|
+
*
|
|
158
|
+
* ```ts
|
|
159
|
+
* const client = createExpoSyncoreClient(runtime);
|
|
160
|
+
* await client.mutation(api.todos.create, { text: "Buy milk" });
|
|
161
|
+
* ```
|
|
62
162
|
*/
|
|
63
|
-
declare function createExpoSyncoreClient(runtime: SyncoreRuntime<
|
|
163
|
+
declare function createExpoSyncoreClient<TSchema extends ExpoSyncoreSchema>(runtime: SyncoreRuntime<TSchema>): import("../core/index.d.mts").SyncoreClient;
|
|
64
164
|
/**
|
|
65
|
-
* Create a reusable Expo bootstrap that lazily starts the local runtime
|
|
165
|
+
* Create a reusable Expo bootstrap that lazily starts the local runtime the
|
|
166
|
+
* first time a client is requested.
|
|
167
|
+
*
|
|
168
|
+
* The bootstrap keeps a single runtime instance alive across component
|
|
169
|
+
* remounts and safely handles concurrent `getClient()` calls.
|
|
170
|
+
*
|
|
171
|
+
* ```ts
|
|
172
|
+
* // app/_layout.tsx
|
|
173
|
+
* import { createExpoSyncoreBootstrap } from "syncorejs/expo";
|
|
174
|
+
* import schema from "../syncore/schema";
|
|
175
|
+
* import { functions } from "../syncore/_generated/functions";
|
|
176
|
+
*
|
|
177
|
+
* export const syncoreBootstrap = createExpoSyncoreBootstrap({
|
|
178
|
+
* schema,
|
|
179
|
+
* functions,
|
|
180
|
+
* });
|
|
181
|
+
*
|
|
182
|
+
* // Later in SyncoreProvider:
|
|
183
|
+
* const client = await syncoreBootstrap.getClient();
|
|
184
|
+
* ```
|
|
66
185
|
*/
|
|
67
|
-
declare function createExpoSyncoreBootstrap(options: CreateExpoRuntimeOptions): ExpoSyncoreBootstrap
|
|
186
|
+
declare function createExpoSyncoreBootstrap<TSchema extends ExpoSyncoreSchema>(options: CreateExpoRuntimeOptions<TSchema>): ExpoSyncoreBootstrap<TSchema>;
|
|
68
187
|
/**
|
|
69
188
|
* Syncore SQL driver implementation backed by `expo-sqlite`.
|
|
70
189
|
*/
|