@syncular/client 0.0.6-55 → 0.0.6-66

package/src/sync.ts

@@ -0,0 +1,170 @@
+import type {
+  ColumnCodecDialect,
+  ColumnCodecSource,
+  ScopeDefinition,
+  ScopeValue,
+  ScopeValuesFromPatterns,
+  SyncSubscriptionRequest,
+} from '@syncular/core';
+import {
+  type CreateClientHandlerOptions,
+  createClientHandler,
+} from './handlers/create-handler';
+import type { ClientTableHandler } from './handlers/types';
+import type { SyncClientDb } from './schema';
+
+type ClientSyncSubscription<ScopeDefs extends readonly ScopeDefinition[]> =
+  Omit<SyncSubscriptionRequest, 'cursor' | 'table' | 'scopes'> & {
+    table: string;
+    scopes?: ScopeValuesFromPatterns<ScopeDefs>;
+  };
+
+type SharedTableName<DB extends SyncClientDb> = keyof DB & string;
+
+export type ClientSyncHandlerOptionsForTable<
+  DB extends SyncClientDb,
+  TableName extends SharedTableName<DB>,
+  ScopeDefs extends readonly ScopeDefinition[],
+  Identity,
+> = Omit<
+  CreateClientHandlerOptions<DB, TableName, ScopeDefs>,
+  'columnCodecs' | 'codecDialect' | 'subscribe'
+> & {
+  columnCodecs?: ColumnCodecSource;
+  codecDialect?: ColumnCodecDialect;
+  subscribe?:
+    | ClientSyncSubscription<ScopeDefs>
+    | ClientSyncSubscription<ScopeDefs>[]
+    | null
+    | ((args: {
+        identity: Identity;
+      }) =>
+        | ClientSyncSubscription<ScopeDefs>
+        | ClientSyncSubscription<ScopeDefs>[]
+        | null);
+};
+
+export interface ClientSyncConfig<
+  DB extends SyncClientDb = SyncClientDb,
+  Identity = { actorId: string },
+> {
+  handlers: ClientTableHandler<DB>[];
+  subscriptions(
+    identity: Identity
+  ): Array<Omit<SyncSubscriptionRequest, 'cursor'>>;
+}
+
+export interface DefineClientSyncOptions {
+  codecs?: ColumnCodecSource;
+  codecDialect?: ColumnCodecDialect;
+}
+
+export interface ClientSyncBuilder<
+  DB extends SyncClientDb,
+  ScopeDefs extends readonly ScopeDefinition[],
+  Identity,
+> extends ClientSyncConfig<DB, Identity> {
+  addHandler<TableName extends SharedTableName<DB>>(
+    options: ClientSyncHandlerOptionsForTable<
+      DB,
+      TableName,
+      ScopeDefs,
+      Identity
+    >
+  ): this;
+}
+
+export function defineClientSync<
+  DB extends SyncClientDb,
+  ScopeDefs extends readonly ScopeDefinition[],
+  Identity,
+>(
+  options: DefineClientSyncOptions
+): ClientSyncBuilder<DB, ScopeDefs, Identity> {
+  const handlers: ClientTableHandler<DB>[] = [];
+  const registeredTables = new Set<string>();
+  const subscriptionsByTable = new Map<
+    string,
+    ClientSyncHandlerOptionsForTable<
+      DB,
+      SharedTableName<DB>,
+      ScopeDefs,
+      Identity
+    >['subscribe']
+  >();
+
+  const toScopeValues = (
+    value: ScopeValuesFromPatterns<ScopeDefs> | undefined
+  ): Record<string, ScopeValue> => {
+    const result: Record<string, ScopeValue> = {};
+    for (const [key, scopeValue] of Object.entries(
+      (value ?? {}) as Record<string, ScopeValue | undefined>
+    )) {
+      if (scopeValue === undefined) continue;
+      result[key] = scopeValue;
+    }
+    return result;
+  };
+
+  const sync: ClientSyncBuilder<DB, ScopeDefs, Identity> = {
+    handlers,
+    addHandler<TableName extends SharedTableName<DB>>(
+      handlerOptions: ClientSyncHandlerOptionsForTable<
+        DB,
+        TableName,
+        ScopeDefs,
+        Identity
+      >
+    ) {
+      if (registeredTables.has(handlerOptions.table)) {
+        throw new Error(
+          `Client table handler already registered: ${handlerOptions.table}`
+        );
+      }
+
+      handlers.push(
+        createClientHandler({
+          ...handlerOptions,
+          subscribe: false,
+          columnCodecs: options.codecs,
+          codecDialect: options.codecDialect,
+        })
+      );
+      subscriptionsByTable.set(
+        handlerOptions.table,
+        handlerOptions.subscribe as ClientSyncHandlerOptionsForTable<
+          DB,
+          SharedTableName<DB>,
+          ScopeDefs,
+          Identity
+        >['subscribe']
+      );
+      registeredTables.add(handlerOptions.table);
+      return sync;
+    },
+    subscriptions(
+      identity: Identity
+    ): Array<Omit<SyncSubscriptionRequest, 'cursor'>> {
+      const resolved: Array<Omit<SyncSubscriptionRequest, 'cursor'>> = [];
+      for (const [table, subscribe] of subscriptionsByTable.entries()) {
+        if (!subscribe) continue;
+        const value =
+          typeof subscribe === 'function' ? subscribe({ identity }) : subscribe;
+        if (!value) continue;
+        const entries = Array.isArray(value) ? value : [value];
+        for (const entry of entries) {
+          resolved.push({
+            id: entry.id,
+            table: entry.table ?? table,
+            scopes: toScopeValues(entry.scopes),
+            params: entry.params,
+            bootstrapState: entry.bootstrapState,
+          });
+        }
+      }
+      return resolved;
+    },
+  };
+
+  return sync;
+}

package/dist/handlers/registry.d.ts

@@ -1,15 +0,0 @@
-/**
- * @syncular/client - Sync client table registry
- */
-import type { ClientTableHandler } from './types';
-/**
- * Registry for client-side table handlers.
- */
-export declare class ClientTableRegistry<DB> {
-    private handlers;
-    register(handler: ClientTableHandler<DB>): this;
-    get(table: string): ClientTableHandler<DB> | undefined;
-    getOrThrow(table: string): ClientTableHandler<DB>;
-    getAll(): ClientTableHandler<DB>[];
-}
-//# sourceMappingURL=registry.d.ts.map

package/dist/handlers/registry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/handlers/registry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD;;GAEG;AACH,qBAAa,mBAAmB,CAAC,EAAE;IACjC,OAAO,CAAC,QAAQ,CAA6C;IAE7D,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC,GAAG,IAAI,CAQ9C;IAED,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC,EAAE,CAAC,GAAG,SAAS,CAErD;IAED,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAIhD;IAED,MAAM,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAEjC;CACF"}

package/dist/handlers/registry.js

@@ -1,29 +0,0 @@
-/**
- * @syncular/client - Sync client table registry
- */
-/**
- * Registry for client-side table handlers.
- */
-export class ClientTableRegistry {
-    handlers = new Map();
-    register(handler) {
-        if (this.handlers.has(handler.table)) {
-            throw new Error(`Client table handler already registered: ${handler.table}`);
-        }
-        this.handlers.set(handler.table, handler);
-        return this;
-    }
-    get(table) {
-        return this.handlers.get(table);
-    }
-    getOrThrow(table) {
-        const h = this.handlers.get(table);
-        if (!h)
-            throw new Error(`Missing client table handler for table: ${table}`);
-        return h;
-    }
-    getAll() {
-        return Array.from(this.handlers.values());
-    }
-}
-//# sourceMappingURL=registry.js.map

package/dist/handlers/registry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/handlers/registry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,MAAM,OAAO,mBAAmB;IACtB,QAAQ,GAAG,IAAI,GAAG,EAAkC,CAAC;IAE7D,QAAQ,CAAC,OAA+B,EAAQ;QAC9C,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,4CAA4C,OAAO,CAAC,KAAK,EAAE,CAC5D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IAAA,CACb;IAED,GAAG,CAAC,KAAa,EAAsC;QACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAAA,CACjC;IAED,UAAU,CAAC,KAAa,EAA0B;QAChD,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,KAAK,EAAE,CAAC,CAAC;QAC5E,OAAO,CAAC,CAAC;IAAA,CACV;IAED,MAAM,GAA6B;QACjC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAA,CAC3C;CACF"}

package/src/handlers/registry.ts

@@ -1,36 +0,0 @@
-/**
- * @syncular/client - Sync client table registry
- */
-
-import type { ClientTableHandler } from './types';
-
-/**
- * Registry for client-side table handlers.
- */
-export class ClientTableRegistry<DB> {
-  private handlers = new Map<string, ClientTableHandler<DB>>();
-
-  register(handler: ClientTableHandler<DB>): this {
-    if (this.handlers.has(handler.table)) {
-      throw new Error(
-        `Client table handler already registered: ${handler.table}`
-      );
-    }
-    this.handlers.set(handler.table, handler);
-    return this;
-  }
-
-  get(table: string): ClientTableHandler<DB> | undefined {
-    return this.handlers.get(table);
-  }
-
-  getOrThrow(table: string): ClientTableHandler<DB> {
-    const h = this.handlers.get(table);
-    if (!h) throw new Error(`Missing client table handler for table: ${table}`);
-    return h;
-  }
-
-  getAll(): ClientTableHandler<DB>[] {
-    return Array.from(this.handlers.values());
-  }
-}