create-syncular-app 0.59.0 → 0.60.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-syncular-app",
-  "version": "0.59.0",
+  "version": "0.60.0",
   "author": "Benjamin Kniffler",
   "repository": {
     "type": "git",

package/template/minimal/src/clients.ts

@@ -9,6 +9,7 @@
  * clients`). Both talk real HTTP to http://localhost:8787.
  */
 import { makeClient } from './make-client';
+import { todosInListSubscription } from './syncular.generated';
 
 const BASE_URL = process.env.SERVER_URL ?? 'http://localhost:8787';
 const LIST_ID = 'groceries';
@@ -18,10 +19,11 @@ const b = makeClient(BASE_URL, 'client-b');
 await a.start();
 await b.start();
 
-// Both clients subscribe to the same list (the requested scope).
-const sub = { id: 'todos', table: 'todos', scopes: { list_id: [LIST_ID] } };
-a.subscribe(sub);
-b.subscribe(sub);
+// Both clients subscribe to the list's unit: one scope map covers every table
+// scoped by `list_id`.
+const list = todosInListSubscription.scopes({ listId: LIST_ID });
+a.subscribe(list);
+b.subscribe(list);
 
 // A writes a todo. mutate() records it locally + queues it for the next push.
 a.mutate([

package/template/minimal/src/smoke.test.ts

@@ -13,7 +13,7 @@ import {
 } from '@syncular/server';
 import { createSyncularHono } from '@syncular/server-hono';
 import { makeClient } from './make-client';
-import { schema } from './syncular.generated';
+import { schema, todosInListSubscription } from './syncular.generated';
 
 let server: ReturnType<typeof Bun.serve>;
 let baseUrl: string;
@@ -43,13 +43,9 @@ test('two clients converge through the server', async () => {
   await a.start();
   await b.start();
 
-  const sub = {
-    id: 'todos',
-    table: 'todos',
-    scopes: { list_id: ['groceries'] },
-  };
-  a.subscribe(sub);
-  b.subscribe(sub);
+  const list = todosInListSubscription.scopes({ listId: 'groceries' });
+  a.subscribe(list);
+  b.subscribe(list);
 
   a.mutate([
     {

package/template/minimal/src/syncular.generated.ts

@@ -1,6 +1,6 @@
 // Generated by @syncular/typegen — DO NOT EDIT.
 // irVersion: 1
-// irHash: sha256:87f3b0e11fc0434b220472a00110771ac69dc0d56068d8ce69d0c1eb2930894e
+// irHash: sha256:7a54dda11222e7937ece27856682da95d651ebc94cb95f9db77748f3282ffba2
 
 /** Structural descriptor consumed by renderer bindings; phantom type
  * fields make row/insert/update/id inference available without imports. */
@@ -106,11 +106,10 @@ export interface TodosInListParams {
   listId: string;
 }
 
-/** Requested-scope template for the 'todosInList' subscription. */
+/** Unit template for the 'todosInList' subscription (SPEC §4.1). */
 export const todosInListSubscription = {
   name: 'todosInList',
-  table: 'todos',
-  scopes: (params: TodosInListParams): Record<string, string[]> => ({
-    list_id: [params.listId],
+  scopes: (params: TodosInListParams): Record<string, string> => ({
+    list_id: params.listId,
   }),
 } as const;

package/template/minimal/syncular.ir.json

@@ -58,16 +58,13 @@
   "subscriptions": [
     {
       "name": "todosInList",
-      "table": "todos",
       "scopes": [
         {
           "variable": "list_id",
-          "values": [
-            {
-              "kind": "parameter",
-              "name": "listId"
-            }
-          ]
+          "value": {
+            "kind": "parameter",
+            "name": "listId"
+          }
         }
       ]
     }

package/template/minimal/syncular.json

@@ -8,10 +8,6 @@
   "schemaVersions": [{ "version": 1, "through": "0001_initial" }],
   "tables": [{ "name": "todos", "scopes": ["list:{list_id}"] }],
   "subscriptions": [
-    {
-      "name": "todosInList",
-      "table": "todos",
-      "scopes": { "list_id": ["{listId}"] }
-    }
+    { "name": "todosInList", "scopes": { "list_id": "{listId}" } }
   ]
 }

package/template/tauri/migrations/0001_initial/up.sql

@@ -9,3 +9,6 @@ CREATE TABLE todos (
   position INTEGER NOT NULL,
   updated_at_ms INTEGER NOT NULL
 );
+
+-- listTodos reads one list at a time; this index lets SQLite search it.
+CREATE INDEX idx_todos_list ON todos (list_id);

package/template/tauri/src/smoke.test.ts

@@ -63,9 +63,9 @@ test('two clients converge through the scaffolded server config', async () => {
   await a.start();
   await b.start();
 
-  const scopes = todoListSubscription.scopes({ listId: 'welcome' });
-  a.subscribe({ id: 'todos', table: 'todos', scopes });
-  b.subscribe({ id: 'todos', table: 'todos', scopes });
+  const list = todoListSubscription.scopes({ listId: 'welcome' });
+  a.subscribe(list);
+  b.subscribe(list);
 
   a.mutate([
     {

package/template/tauri/src/syncular.generated.ts

@@ -1,6 +1,6 @@
 // Generated by @syncular/typegen — DO NOT EDIT.
 // irVersion: 1
-// irHash: sha256:2ffc5b70cb96cd546326de9c06868bd988c9fa3459fb3bac8428a81dcc85fca0
+// irHash: sha256:6bcec8061116d46f6e483f2f338f9d706972d272572c67b510e54a78e6b966c8
 
 /** Structural descriptor consumed by renderer bindings; phantom type
  * fields make row/insert/update/id inference available without imports. */
@@ -60,6 +60,15 @@ export const schema = {
           "pattern": "list:{list_id}",
           "column": "list_id"
         }
+      ],
+      "indexes": [
+        {
+          "name": "idx_todos_list",
+          "columns": [
+            "list_id"
+          ],
+          "unique": false
+        }
       ]
     }
   ]
@@ -106,11 +115,10 @@ export interface TodoListParams {
   listId: string;
 }
 
-/** Requested-scope template for the 'todoList' subscription. */
+/** Unit template for the 'todoList' subscription (SPEC §4.1). */
 export const todoListSubscription = {
   name: 'todoList',
-  table: 'todos',
-  scopes: (params: TodoListParams): Record<string, string[]> => ({
-    list_id: [params.listId],
+  scopes: (params: TodoListParams): Record<string, string> => ({
+    list_id: params.listId,
   }),
 } as const;

package/template/tauri/src/syncular.queries.ts

@@ -98,12 +98,11 @@ export interface QueryResultColumn {
   readonly nullable: boolean;
 }
 
+/** A window base (SPEC §4.8) and the unit values a query reads. */
 export interface WindowCoverage {
   readonly base: {
-    readonly table: string;
     readonly variable: string;
-    readonly fixedScopes?: Readonly<Record<string, readonly string[]>>;
-    readonly params?: string;
+    readonly fixedScopes?: Readonly<Record<string, string>>;
   };
   readonly units: readonly string[];
 }

package/template/tauri/src-tauri/Cargo.toml

@@ -21,7 +21,7 @@ tauri = { version = "2", features = [] }
 # The syncular plugin from crates.io. `native-transport` gives the core its
 # real HTTP + WebSocket transport (ureq + tungstenite) inside the host
 # process — the webview never talks to the sync server directly.
-tauri-plugin-syncular = { version = "0.59.0", features = ["native-transport"] }
+tauri-plugin-syncular = { version = "0.60.0", features = ["native-transport"] }
 
 [features]
 default = []

package/template/tauri/syncular.ir.json

@@ -52,22 +52,28 @@
           "column": "list_id"
         }
       ],
+      "indexes": [
+        {
+          "name": "idx_todos_list",
+          "columns": [
+            "list_id"
+          ],
+          "unique": false
+        }
+      ],
       "extensions": {}
     }
   ],
   "subscriptions": [
     {
       "name": "todoList",
-      "table": "todos",
       "scopes": [
         {
           "variable": "list_id",
-          "values": [
-            {
-              "kind": "parameter",
-              "name": "listId"
-            }
-          ]
+          "value": {
+            "kind": "parameter",
+            "name": "listId"
+          }
         }
       ]
     }

package/template/tauri/syncular.json

@@ -10,10 +10,6 @@
   "schemaVersions": [{ "version": 1, "through": "0001_initial" }],
   "tables": [{ "name": "todos", "scopes": ["list:{list_id}"] }],
   "subscriptions": [
-    {
-      "name": "todoList",
-      "table": "todos",
-      "scopes": { "list_id": ["{listId}"] }
-    }
+    { "name": "todoList", "scopes": { "list_id": "{listId}" } }
   ]
 }

package/template/tauri/syncular.migrations.lock.json

@@ -3,7 +3,7 @@
   "migrations": [
     {
       "name": "0001_initial",
-      "sha256": "87b23cd0f8e3677ca6fa7ca67eb7c8373a285607b6de10854cc43df1290bb0fa",
+      "sha256": "33fdb7df2e4dc4c598137acdacf009922ea1d107b2c4284efe62ec25eb681116",
       "schemaVersion": 1
     }
   ],

package/template/web/src/frontend/main.ts

@@ -72,11 +72,8 @@ async function main(): Promise<void> {
     onSynced: () => void refresh(),
   });
 
-  await handle.subscribe({
-    id: 'todos',
-    table: 'todos',
-    scopes: todoListSubscription.scopes({ listId: LIST_ID }),
-  });
+  // One unit per list: the scope map covers every table scoped by `list_id`.
+  await handle.subscribe(todoListSubscription.scopes({ listId: LIST_ID }));
 
   // The supported host policy owns connect + catch-up, retries transient
   // startup/socket loss, and suspends while this page is offline.

package/template/web/src/smoke.test.ts

@@ -62,9 +62,9 @@ test('two clients converge through the scaffolded server config', async () => {
   await a.start();
   await b.start();
 
-  const scopes = todoListSubscription.scopes({ listId: 'welcome' });
-  a.subscribe({ id: 'todos', table: 'todos', scopes });
-  b.subscribe({ id: 'todos', table: 'todos', scopes });
+  const list = todoListSubscription.scopes({ listId: 'welcome' });
+  a.subscribe(list);
+  b.subscribe(list);
 
   a.mutate([
     {

package/template/web/src/syncular.generated.ts

@@ -1,6 +1,6 @@
 // Generated by @syncular/typegen — DO NOT EDIT.
 // irVersion: 1
-// irHash: sha256:2ffc5b70cb96cd546326de9c06868bd988c9fa3459fb3bac8428a81dcc85fca0
+// irHash: sha256:9c3077b1f537f8d84725f38d0b5234f7a53520777265f36f10059651d2cddd32
 
 /** Structural descriptor consumed by renderer bindings; phantom type
  * fields make row/insert/update/id inference available without imports. */
@@ -106,11 +106,10 @@ export interface TodoListParams {
   listId: string;
 }
 
-/** Requested-scope template for the 'todoList' subscription. */
+/** Unit template for the 'todoList' subscription (SPEC §4.1). */
 export const todoListSubscription = {
   name: 'todoList',
-  table: 'todos',
-  scopes: (params: TodoListParams): Record<string, string[]> => ({
-    list_id: [params.listId],
+  scopes: (params: TodoListParams): Record<string, string> => ({
+    list_id: params.listId,
   }),
 } as const;

package/template/web/syncular.ir.json

@@ -58,16 +58,13 @@
   "subscriptions": [
     {
       "name": "todoList",
-      "table": "todos",
       "scopes": [
         {
           "variable": "list_id",
-          "values": [
-            {
-              "kind": "parameter",
-              "name": "listId"
-            }
-          ]
+          "value": {
+            "kind": "parameter",
+            "name": "listId"
+          }
         }
       ]
     }

package/template/web/syncular.json

@@ -8,10 +8,6 @@
   "schemaVersions": [{ "version": 1, "through": "0001_initial" }],
   "tables": [{ "name": "todos", "scopes": ["list:{list_id}"] }],
   "subscriptions": [
-    {
-      "name": "todoList",
-      "table": "todos",
-      "scopes": { "list_id": ["{listId}"] }
-    }
+    { "name": "todoList", "scopes": { "list_id": "{listId}" } }
   ]
 }