@colixsystems/widget-sdk 0.23.0 → 0.24.0

package/dist/contract.cjs

@@ -314,6 +314,31 @@ const HOOKS = [
     requiredContextSlice: ["datastore.records"],
     scopes: ["acl.write:records"],
   },
+  // REQ-RT-07 — realtime table subscription.
+  {
+    name: "useDatastoreSubscription",
+    signature: "useDatastoreSubscription(tableId, handlers, options?)",
+    description:
+      "Subscribe to a table's realtime change stream via the injected " +
+      "datastore-client at ctx.datastore.records(tableId).subscribe(...). " +
+      "handlers is { onCreated?, onUpdated?, onDeleted? }; each receives the " +
+      "snake_case record verbatim (same shape REST returns). The socket opens " +
+      "on mount, re-opens when tableId changes, and is torn down on unmount. " +
+      "Returns { status } where status is 'connecting' | 'live' | " +
+      "'reconnecting' | 'fallback'. The server gates each subscribe by the " +
+      "same read ACL REST honours; on an ACL reject, a missing WebSocket, or a " +
+      "host whose client predates realtime, the hook resolves to " +
+      "{ status: 'fallback' } WITHOUT throwing so the widget can poll instead. " +
+      "Reads the same datastore.read scope as useDatastoreQuery — declare " +
+      "datastore.read for the table you subscribe to. Pair with " +
+      "useDatastoreQuery for the initial load and merge the streamed envelopes.",
+    returnShape: {
+      status:
+        "'connecting' | 'live' | 'reconnecting' | 'fallback'  // transport state; 'fallback' → poll",
+    },
+    requiredContextSlice: ["datastore.records"],
+    scopes: ["datastore.read:<table>"],
+  },
   // REQ-WSDK-PLATFORM §6 — Tier A SDK hooks. Mirror of contract.js.
   {
     name: "useClipboard",
@@ -1136,7 +1161,15 @@ const CONTRACT = deepFreeze({
   //    is additive — minor bump on the pre-1.0 channel. The compiler pins the
   //    native-module members in the exported Expo app's package.json and now
   //    always emits the react-native-reanimated/plugin (CLAUDE.md §3 parity).
-  version: "1.13.0",
+  //
+  // 1.14.0: additive (REQ-RT-07) — new `useDatastoreSubscription(tableId,
+  //    handlers, options?)` hook reading ctx.datastore.records(t).subscribe.
+  //    Backed by the datastore-client 0.6.0 `subscribe` method (WebSocket to
+  //    `/datastore/ws`). Safe-by-default: resolves to { status: 'fallback' }
+  //    when the host's client predates realtime or no WebSocket is available,
+  //    so widgets degrade to polling on both platforms. No existing hook,
+  //    primitive, or contract field changed — minor bump on the pre-1.0 channel.
+  version: "1.14.0",
   hooks: HOOKS,
   primitives: PRIMITIVES,
   manifestSchema: MANIFEST_SCHEMA,

package/dist/contract.js

@@ -321,6 +321,31 @@ const HOOKS = [
     requiredContextSlice: ["datastore.records"],
     scopes: ["acl.write:records"],
   },
+  // REQ-RT-07 — realtime table subscription.
+  {
+    name: "useDatastoreSubscription",
+    signature: "useDatastoreSubscription(tableId, handlers, options?)",
+    description:
+      "Subscribe to a table's realtime change stream via the injected " +
+      "datastore-client at ctx.datastore.records(tableId).subscribe(...). " +
+      "handlers is { onCreated?, onUpdated?, onDeleted? }; each receives the " +
+      "snake_case record verbatim (same shape REST returns). The socket opens " +
+      "on mount, re-opens when tableId changes, and is torn down on unmount. " +
+      "Returns { status } where status is 'connecting' | 'live' | " +
+      "'reconnecting' | 'fallback'. The server gates each subscribe by the " +
+      "same read ACL REST honours; on an ACL reject, a missing WebSocket, or a " +
+      "host whose client predates realtime, the hook resolves to " +
+      "{ status: 'fallback' } WITHOUT throwing so the widget can poll instead. " +
+      "Reads the same datastore.read scope as useDatastoreQuery — declare " +
+      "datastore.read for the table you subscribe to. Pair with " +
+      "useDatastoreQuery for the initial load and merge the streamed envelopes.",
+    returnShape: {
+      status:
+        "'connecting' | 'live' | 'reconnecting' | 'fallback'  // transport state; 'fallback' → poll",
+    },
+    requiredContextSlice: ["datastore.records"],
+    scopes: ["datastore.read:<table>"],
+  },
   // REQ-WSDK-PLATFORM §6 — Tier A SDK hooks.
   {
     name: "useClipboard",
@@ -1089,7 +1114,15 @@ const CONTRACT = deepFreeze({
   //    is additive — minor bump on the pre-1.0 channel. The compiler pins the
   //    native-module members in the exported Expo app's package.json and now
   //    always emits the react-native-reanimated/plugin (CLAUDE.md §3 parity).
-  version: "1.13.0",
+  //
+  // 1.14.0: additive (REQ-RT-07) — new `useDatastoreSubscription(tableId,
+  //    handlers, options?)` hook reading ctx.datastore.records(t).subscribe.
+  //    Backed by the datastore-client 0.6.0 `subscribe` method (WebSocket to
+  //    `/datastore/ws`). Safe-by-default: resolves to { status: 'fallback' }
+  //    when the host's client predates realtime or no WebSocket is available,
+  //    so widgets degrade to polling on both platforms. No existing hook,
+  //    primitive, or contract field changed — minor bump on the pre-1.0 channel.
+  version: "1.14.0",
   hooks: HOOKS,
   primitives: PRIMITIVES,
   manifestSchema: MANIFEST_SCHEMA,

package/dist/hooks.js

@@ -921,6 +921,93 @@ export function useRecordPermissions(tableId, recordId) {
   return { permissions, loading, error, grant, revoke, update, refetch };
 }
 
+/**
+ * REQ-RT-07: subscribe to a table's realtime change stream. Reads
+ * `ctx.datastore.records(table).subscribe({ onCreated, onUpdated, onDeleted,
+ * onStatus })` and wires it to a React lifecycle: the socket is opened on
+ * mount (and re-opened when `table` changes) and torn down on unmount via the
+ * unsubscribe function the client returns. The author's `handlers` callbacks
+ * are held in a ref so re-renders with fresh callback identities never tear
+ * the socket down — only a `table` change does.
+ *
+ * Returns `{ status }` where status is "connecting" | "live" | "reconnecting"
+ * | "fallback". A widget typically pairs this with `useDatastoreQuery` for the
+ * initial load and merges the streamed create/update/delete envelopes into its
+ * local list; when `status === "fallback"` (no socket support on the host, the
+ * subscribe was ACL-rejected, or the connect timed out) the widget should run
+ * its own REST polling instead.
+ *
+ * Cross-platform + safe-by-default: if the host's datastore client doesn't
+ * expose `subscribe` (an older host, or a runtime with no WebSocket), the hook
+ * resolves to `{ status: "fallback" }` WITHOUT throwing, so a widget that
+ * subscribes degrades to polling on both the web Player and the native export
+ * rather than crashing at render (CLAUDE.md §11).
+ *
+ * @param {string} table  Bound table id (falsy → no subscription, status "fallback").
+ * @param {{ onCreated?, onUpdated?, onDeleted? }} [handlers]  Per-event callbacks; each receives the snake_case record.
+ * @param {{ fallbackAfterMs?: number }} [options]
+ * @returns {{ status: "connecting" | "live" | "reconnecting" | "fallback" }}
+ */
+export function useDatastoreSubscription(table, handlers, options) {
+  const ctx = useWidgetContextOrThrow("useDatastoreSubscription");
+  const [status, setStatus] = useState("connecting");
+
+  // Author callbacks live in a ref so a new closure each render does not
+  // re-run the effect (which would tear down + re-open the socket).
+  const handlersRef = useRef(handlers);
+  handlersRef.current = handlers;
+  // `ctx` is a fresh object identity per host render; hold the records
+  // factory in a ref so the effect depends only on `table`.
+  const recordsRef = useRef(
+    ctx.datastore && typeof ctx.datastore.records === "function"
+      ? ctx.datastore.records
+      : null,
+  );
+  recordsRef.current =
+    ctx.datastore && typeof ctx.datastore.records === "function"
+      ? ctx.datastore.records
+      : null;
+
+  const fallbackAfterMs =
+    options && Number.isFinite(options.fallbackAfterMs)
+      ? options.fallbackAfterMs
+      : undefined;
+
+  useEffect(() => {
+    if (!table || typeof recordsRef.current !== "function") {
+      setStatus("fallback");
+      return undefined;
+    }
+    let ns;
+    try {
+      ns = recordsRef.current(table);
+    } catch (_) {
+      setStatus("fallback");
+      return undefined;
+    }
+    if (!ns || typeof ns.subscribe !== "function") {
+      // Host's datastore client predates realtime — degrade to polling.
+      setStatus("fallback");
+      return undefined;
+    }
+    const stop = ns.subscribe(
+      {
+        onCreated: (r) => handlersRef.current?.onCreated?.(r),
+        onUpdated: (r) => handlersRef.current?.onUpdated?.(r),
+        onDeleted: (r) => handlersRef.current?.onDeleted?.(r),
+        onStatus: (s) => setStatus(s),
+      },
+      fallbackAfterMs != null ? { fallbackAfterMs } : undefined,
+    );
+    return () => {
+      if (typeof stop === "function") stop();
+    };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [table, fallbackAfterMs]);
+
+  return { status };
+}
+
 /* ============================================================================
  * FILES CLIENT — ctx.files (@colixsystems/files-client)
  *

package/dist/index.d.ts

@@ -624,6 +624,37 @@ export function useDatastoreSchema(
   tableId: string | null | undefined,
 ): SchemaResult;
 
+// REQ-RT-07 realtime subscription transport state.
+export type DatastoreSubscriptionStatus =
+  | "connecting"
+  | "live"
+  | "reconnecting"
+  | "fallback";
+
+export interface DatastoreSubscriptionHandlers {
+  onCreated?: (record: Record<string, unknown>) => void;
+  onUpdated?: (record: Record<string, unknown>) => void;
+  onDeleted?: (record: Record<string, unknown>) => void;
+}
+
+export interface DatastoreSubscriptionOptions {
+  fallbackAfterMs?: number;
+}
+
+/**
+ * REQ-RT-07: subscribe to a table's realtime change stream via
+ * `ctx.datastore.records(tableId).subscribe(...)`. Opens on mount, re-opens on
+ * `tableId` change, tears down on unmount. Returns `{ status }`; when status
+ * is `"fallback"` (no socket support, ACL-rejected, or connect timed out) run
+ * REST polling instead. Never throws — degrades to `{ status: "fallback" }` on
+ * a host whose datastore client predates realtime.
+ */
+export function useDatastoreSubscription(
+  tableId: string | null | undefined,
+  handlers?: DatastoreSubscriptionHandlers,
+  options?: DatastoreSubscriptionOptions,
+): { status: DatastoreSubscriptionStatus };
+
 /**
  * Stateful file-asset resolver hook. Returns `{ url, file, loading, error,
  * refetch }`. The `url` is an absolute URL composed against the host's API

package/dist/index.js

@@ -20,6 +20,7 @@ export {
   useUsers,
   useGroups,
   useRecordPermissions,
+  useDatastoreSubscription,
   useWidgetEvent,
   usePayments,
   useTheme,

package/dist/index.native.js

@@ -20,6 +20,7 @@ export {
   useUsers,
   useGroups,
   useRecordPermissions,
+  useDatastoreSubscription,
   useWidgetEvent,
   usePayments,
   useTheme,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "type": "module",
   "main": "./dist/index.js",
@@ -35,7 +35,7 @@
   ],
   "scripts": {
     "build": "node scripts/build.js",
-    "test": "node --test src/__tests__/contract.test.js src/__tests__/hooks-users.test.js src/__tests__/hooks-groups.test.js src/__tests__/hooks-schema.test.js src/__tests__/hooks-mutation.test.js src/__tests__/hooks-record-permissions.test.js src/__tests__/linter-users-scope.test.js src/__tests__/manifest-actions.test.js src/__tests__/widget-translations.test.js"
+    "test": "node --test src/__tests__/contract.test.js src/__tests__/hooks-users.test.js src/__tests__/hooks-groups.test.js src/__tests__/hooks-schema.test.js src/__tests__/hooks-mutation.test.js src/__tests__/hooks-record-permissions.test.js src/__tests__/hooks-subscription.test.js src/__tests__/linter-users-scope.test.js src/__tests__/manifest-actions.test.js src/__tests__/widget-translations.test.js"
   },
   "engines": {
     "node": ">=18"