@revealui/sync 0.0.0-canary-20260409021642

package/dist/offline-queue.js

@@ -0,0 +1,126 @@
+/**
+ * Offline mutation queue — stores pending mutations in localStorage
+ * so they survive page reloads and can be flushed when connectivity returns.
+ */
+/** localStorage key for the persisted queue. */
+const STORAGE_KEY = 'revealui:offline-queue';
+/**
+ * Check whether `localStorage` is available.
+ * Returns `false` during SSR or in private-browsing contexts that throw on access.
+ */
+function hasLocalStorage() {
+    if (typeof window === 'undefined') {
+        return false;
+    }
+    try {
+        const testKey = '__revealui_ls_test__';
+        window.localStorage.setItem(testKey, '1');
+        window.localStorage.removeItem(testKey);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Read the current queue from localStorage.
+ * Returns an empty array when storage is unavailable or the data is corrupt.
+ */
+function readQueue() {
+    if (!hasLocalStorage()) {
+        return [];
+    }
+    try {
+        const raw = window.localStorage.getItem(STORAGE_KEY);
+        if (raw === null) {
+            return [];
+        }
+        const parsed = JSON.parse(raw);
+        if (!Array.isArray(parsed)) {
+            return [];
+        }
+        return parsed;
+    }
+    catch {
+        return [];
+    }
+}
+/**
+ * Persist the queue to localStorage.
+ * Silently ignores errors (e.g. quota exceeded, private browsing).
+ */
+function writeQueue(queue) {
+    if (!hasLocalStorage()) {
+        return;
+    }
+    try {
+        window.localStorage.setItem(STORAGE_KEY, JSON.stringify(queue));
+    }
+    catch {
+        // Quota exceeded or private browsing — drop silently.
+    }
+}
+/**
+ * Manages a FIFO queue of mutations that were created while the browser
+ * was offline. Mutations are persisted in `localStorage` under the key
+ * `revealui:offline-queue`.
+ *
+ * All operations are no-ops when `localStorage` is unavailable (SSR,
+ * private browsing that throws, etc.).
+ */
+export class OfflineMutationQueue {
+    /**
+     * Add a mutation to the end of the queue.
+     *
+     * @param mutation - The mutation to enqueue (must include a unique `id`).
+     */
+    enqueue(mutation) {
+        const queue = readQueue();
+        queue.push(mutation);
+        writeQueue(queue);
+    }
+    /**
+     * Execute all queued mutations in order via the provided executor.
+     * Each mutation is removed from the persisted queue only after the
+     * executor resolves successfully. Processing stops at the first failure
+     * so ordering is preserved.
+     *
+     * @param executor - Async function that sends a single mutation to the server.
+     */
+    async flush(executor) {
+        const queue = readQueue();
+        for (const mutation of queue) {
+            await executor(mutation);
+            // Remove the successfully-processed mutation from storage.
+            const current = readQueue();
+            const updated = current.filter((m) => m.id !== mutation.id);
+            writeQueue(updated);
+        }
+    }
+    /**
+     * Return all pending mutations without removing them.
+     */
+    peek() {
+        return readQueue();
+    }
+    /**
+     * Number of mutations currently in the queue.
+     */
+    get size() {
+        return readQueue().length;
+    }
+    /**
+     * Remove all pending mutations from the queue.
+     */
+    clear() {
+        if (!hasLocalStorage()) {
+            return;
+        }
+        try {
+            window.localStorage.removeItem(STORAGE_KEY);
+        }
+        catch {
+            // Ignore — same guard as writeQueue.
+        }
+    }
+}

package/dist/provider/index.d.ts

@@ -0,0 +1,35 @@
+import { type ReactNode } from 'react';
+interface ElectricContextValue {
+    /**
+     * Direct Electric service URL (e.g. the Railway instance).
+     * Stored in context for future use — not consumed by the current proxy-based hooks.
+     * All hooks use proxyBaseUrl + /api/shapes/* instead.
+     */
+    serviceUrl: string | null;
+    /**
+     * Base URL prefix for authenticated CMS shape proxy routes.
+     * Default '' keeps all hook URLs relative (works for same-origin apps).
+     * Set to 'https://cms.revealui.com' when consuming from a different origin.
+     */
+    proxyBaseUrl: string;
+    debug: boolean;
+}
+/**
+ * Provides ElectricSQL configuration to child hooks (`useConversations`, `useCollabDocument`).
+ *
+ * Provides proxyBaseUrl (and optional serviceUrl/debug) to child hooks via context.
+ * All hooks use the CMS proxy pattern — no direct Electric connection is established here.
+ */
+export declare function ElectricProvider(props: {
+    children: ReactNode;
+    serviceUrl?: string;
+    proxyBaseUrl?: string;
+    debug?: boolean;
+}): ReactNode;
+/**
+ * Access the ElectricSQL configuration provided by `ElectricProvider`.
+ * Returns `{ serviceUrl: null, debug: false }` if no provider is present.
+ */
+export declare function useElectricConfig(): ElectricContextValue;
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/provider/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAiB,KAAK,SAAS,EAAgB,MAAM,OAAO,CAAC;AAEpE,UAAU,oBAAoB;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;CAChB;AAQD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE;IACtC,QAAQ,EAAE,SAAS,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GAAG,SAAS,CAWZ;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,oBAAoB,CAExD"}

package/dist/provider/index.js

@@ -0,0 +1,29 @@
+'use client';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, use, useMemo } from 'react';
+const ElectricContext = createContext({
+    serviceUrl: null,
+    proxyBaseUrl: '',
+    debug: false,
+});
+/**
+ * Provides ElectricSQL configuration to child hooks (`useConversations`, `useCollabDocument`).
+ *
+ * Provides proxyBaseUrl (and optional serviceUrl/debug) to child hooks via context.
+ * All hooks use the CMS proxy pattern — no direct Electric connection is established here.
+ */
+export function ElectricProvider(props) {
+    const value = useMemo(() => ({
+        serviceUrl: props.serviceUrl ?? null,
+        proxyBaseUrl: props.proxyBaseUrl ?? '',
+        debug: props.debug ?? false,
+    }), [props.serviceUrl, props.proxyBaseUrl, props.debug]);
+    return _jsx(ElectricContext, { value: value, children: props.children });
+}
+/**
+ * Access the ElectricSQL configuration provided by `ElectricProvider`.
+ * Returns `{ serviceUrl: null, debug: false }` if no provider is present.
+ */
+export function useElectricConfig() {
+    return use(ElectricContext);
+}

package/dist/shape-utils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Cast ElectricSQL shape data to a typed record array.
+ *
+ * ElectricSQL's `useShape` returns `Row[]` (i.e. `Record<string, Value>[]`).
+ * Our record interfaces describe the exact same shape but lack the index
+ * signature that `Row` carries, so TypeScript rejects a direct assignment.
+ * This helper encapsulates the boundary cast in one place and returns an
+ * empty array when data is falsy.
+ */
+export declare function toRecords<T>(data: unknown[] | undefined): T[];
+//# sourceMappingURL=shape-utils.d.ts.map

package/dist/shape-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape-utils.d.ts","sourceRoot":"","sources":["../src/shape-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,SAAS,GAAG,CAAC,EAAE,CAG7D"}

package/dist/shape-utils.js

@@ -0,0 +1,14 @@
+/**
+ * Cast ElectricSQL shape data to a typed record array.
+ *
+ * ElectricSQL's `useShape` returns `Row[]` (i.e. `Record<string, Value>[]`).
+ * Our record interfaces describe the exact same shape but lack the index
+ * signature that `Row` carries, so TypeScript rejects a direct assignment.
+ * This helper encapsulates the boundary cast in one place and returns an
+ * empty array when data is falsy.
+ */
+export function toRecords(data) {
+    if (!Array.isArray(data))
+        return [];
+    return data;
+}

package/dist/test-setup.d.ts

@@ -0,0 +1,2 @@
+import '@testing-library/jest-dom/vitest';
+//# sourceMappingURL=test-setup.d.ts.map

package/dist/test-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-setup.d.ts","sourceRoot":"","sources":["../src/test-setup.ts"],"names":[],"mappings":"AAAA,OAAO,kCAAkC,CAAC"}

package/dist/test-setup.js

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/vitest';

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@revealui/sync",
+  "version": "0.0.0-canary-20260409021642",
+  "description": "ElectricSQL sync utilities for RevealUI",
+  "license": "MIT",
+  "dependencies": {
+    "@electric-sql/react": "^1.0.27",
+    "lib0": "^0.2.117",
+    "ws": "^8.18.0",
+    "y-protocols": "^1.0.7",
+    "yjs": "^13.6.29",
+    "@revealui/db": "0.0.0-canary-20260409021642",
+    "@revealui/contracts": "0.0.0-canary-20260409021642"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.6.4",
+    "@testing-library/react": "^16.3.0",
+    "@types/ws": "^8.5.14",
+    "@vitest/coverage-v8": "^4.1.0",
+    "jsdom": "^29.0.1",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.0",
+    "dev": "0.0.1"
+  },
+  "engines": {
+    "node": ">=24.13.0"
+  },
+  "experimental": true,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./provider": {
+      "types": "./dist/provider/index.d.ts",
+      "import": "./dist/provider/index.js"
+    },
+    "./collab": {
+      "types": "./dist/collab/index.d.ts",
+      "import": "./dist/collab/index.js"
+    },
+    "./collab/server": {
+      "types": "./dist/collab/server-index.d.ts",
+      "import": "./dist/collab/server-index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "dev": "tsc --watch",
+    "lint": "biome check .",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage --coverage.reporter=json-summary --coverage.reporter=html --coverage.reporter=text",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}