create-syncular-app 0.5.1 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-syncular-app",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Scaffold a new Syncular app: `create-syncular-app`",
   "license": "Apache-2.0",
   "author": "Benjamin Kniffler",
@@ -49,6 +49,6 @@
     "!dist/**/*.test.d.ts"
   ],
   "devDependencies": {
-    "@syncular/typegen": "0.5.1"
+    "@syncular/typegen": "0.6.0"
   }
 }

package/template/tauri/queries/list-todos.syql

@@ -1,6 +1,8 @@
 query listTodos(listId) {
-  select id, list_id, title, done, position, updated_at_ms
-  from todos
-  where list_id = :listId
-  order by position, id
+  sql {
+    select id, list_id, title, done, position, updated_at_ms
+    from todos
+    where @scope(todos.list_id = :listId)
+    order by position, id
+  }
 }

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

@@ -1,6 +1,30 @@
 // Generated by @syncular/typegen — DO NOT EDIT.
 // irVersion: 1
-// irHash: sha256:4c2d58e50c85edd5a15aa6d61f2195b802e90b9056fc3cea17ceddb6ea37d0e7
+// irHash: sha256:14904cd41e8ae90720d152cd47a944d2f01bf8572b97e32fa71cda8909cab768
+
+export type SyqlRuntimeErrorCode =
+  | 'SYQL_RUNTIME_MISSING_REQUIRED_INPUT'
+  | 'SYQL_RUNTIME_UNKNOWN_INPUT'
+  | 'SYQL_RUNTIME_INVALID_INPUT'
+  | 'SYQL_RUNTIME_INVALID_GROUP'
+  | 'SYQL_RUNTIME_INVALID_SORT'
+  | 'SYQL_RUNTIME_INVALID_PAGE';
+
+export class SyqlInputError extends Error {
+  readonly name = 'SyqlInputError';
+  constructor(readonly code: SyqlRuntimeErrorCode, message: string) {
+    super(message);
+  }
+}
+
+export interface SyqlPresent<T> {
+  readonly present: true;
+  readonly value: T;
+}
+
+export function syqlPresent<T>(value: T): SyqlPresent<T> {
+  return { present: true, value };
+}
 
 /** A bindable SQL param/row value (the wrapper's SqlValue subset). */
 export type QueryValue =
@@ -25,8 +49,7 @@ export interface QueryClient {
  *  `bind(params)` → positional args. Consumed by
  *  `@syncular/react`'s `useQuery`. `Row` is the projection row
  *  type; `Params` is `undefined` for a param-less query. `sqlFor`
- *  (present only with an orderBy knob) composes the statement from a
- *  generate-time-checked column allowlist. */
+ *  selects a checked revision-1 SYQL physical statement when needed. */
 export interface NamedQuery<Row, Params = undefined> {
   readonly id: string;
   readonly hasParams: boolean;
@@ -66,34 +89,55 @@ export interface ListTodosRow {
   updatedAtMs: number;
 }
 
-/** Named parameters for 'listTodos'. */
+/** Public revision-1 SYQL inputs for 'listTodos'. */
 export interface ListTodosParams {
   listId: string;
 }
 
+function listTodosValidate(raw?: ListTodosParams): ListTodosParams {
+  const params = raw ?? ({} as ListTodosParams);
+  const allowed = new Set(['listId']);
+  for (const key of Object.keys(params)) {
+    if (!allowed.has(key)) throw new SyqlInputError('SYQL_RUNTIME_UNKNOWN_INPUT', 'listTodos' + ': unknown input ' + key);
+  }
+  if (!Object.prototype.hasOwnProperty.call(params, 'listId')) throw new SyqlInputError('SYQL_RUNTIME_MISSING_REQUIRED_INPUT', 'listTodos: missing required input listId');
+  if (!(typeof params.listId === 'string')) throw new SyqlInputError('SYQL_RUNTIME_INVALID_INPUT', 'listTodos: invalid input listId');
+  return params;
+}
+
 /** Tables 'listTodos' reads (compatibility/export surface). */
 export const listTodosTables = ['todos'] as const;
 
-const listTodosSql = 'select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where list_id = ? order by position, id';
+const listTodosStatements: { sql: string; bind: (params: ListTodosParams) => QueryValue[] }[] = [
+  { sql: 'select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where (todos.list_id = ?) order by position, id', bind: (params) => [params.listId] },
+];
+function listTodosSelect(raw: ListTodosParams): { sql: string; bind: QueryValue[] } {
+  const params = listTodosValidate(raw);
+  let mask = 0;
+  const statement = listTodosStatements[mask * 1 + 0];
+  if (statement === undefined) throw new Error('invalid generated SYQL statement index');
+  return { sql: statement.sql, bind: statement.bind(params) };
+}
 
 /** Run the 'listTodos' named query (SELECT-only). */
 export async function listTodos(client: QueryClient, params: ListTodosParams): Promise<ListTodosRow[]> {
-  const rows = await client.query(listTodosSql, [params.listId]);
+  const selected = listTodosSelect(params);
+  const rows = await client.query(selected.sql, selected.bind);
   return rows as unknown as ListTodosRow[];
 }
 
 /** Revisioned reactive descriptor for `useQuery(listTodosQuery, params)`. */
 export const listTodosQuery: NamedQuery<ListTodosRow, ListTodosParams> = {
-  id: 'sha256:4c2d58e50c85edd5a15aa6d61f2195b802e90b9056fc3cea17ceddb6ea37d0e7/listTodos',
+  id: 'sha256:14904cd41e8ae90720d152cd47a944d2f01bf8572b97e32fa71cda8909cab768/listTodos',
   hasParams: true,
-  sql: listTodosSql,
+  sql: 'select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where (todos.list_id = ?) order by position, id',
+  sqlFor: (params: ListTodosParams) => listTodosSelect(params).sql,
   tables: listTodosTables,
   dependencies: (params) => [
     { table: 'todos', scopeKeys: ['list:' + String(params.listId) + ''] },
   ],
-  coverage: (params) => [
-    { base: { table: 'todos', variable: 'list_id' }, units: [String(params.listId)] },
+  coverage: () => [
   ],
-  bind: (params: ListTodosParams) => [params.listId],
+  bind: (params: ListTodosParams) => listTodosSelect(params).bind,
   rowKey: (row) => [row.id],
 };

package/template/tauri/syncular.queries.ir.json

@@ -1,12 +1,12 @@
 {
-  "queryIrVersion": 2,
+  "queryIrVersion": 3,
   "queries": [
     {
       "name": "listTodos",
-      "file": "list-todos.syql (query listTodos)",
-      "sourceSql": "select id, list_id, title, done, position, updated_at_ms\n  from todos\n  where list_id = :listId\n  order by position, id",
-      "sql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where list_id = :listId order by position, id",
-      "positionalSql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where list_id = ? order by position, id",
+      "file": "list-todos.syql",
+      "sourceSql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos\n    where (todos.list_id = :listId)\n    order by position, id",
+      "sql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos\n    where (todos.list_id = :listId)\n    order by position, id",
+      "positionalSql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where (todos.list_id = ?) order by position, id",
       "params": [
         {
           "name": "listId",
@@ -100,17 +100,44 @@
             ]
           }
         ],
-        "coverage": [
+        "coverage": [],
+        "rowKey": [
+          "id"
+        ]
+      },
+      "syql": {
+        "revision": 1,
+        "inputs": [
           {
-            "table": "todos",
-            "variable": "list_id",
-            "units": [
-              "listId"
-            ],
-            "fixedScopes": []
+            "kind": "value",
+            "name": "listId",
+            "langName": "listId",
+            "type": "string",
+            "nullable": false,
+            "required": true
           }
         ],
-        "rowKey": [
+        "plan": {
+          "backend": "variants",
+          "activationControls": [],
+          "conditions": [],
+          "statements": [
+            {
+              "activationMask": 0,
+              "sql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos\n    where (todos.list_id = :listId)\n    order by position, id",
+              "positionalSql": "select id, list_id AS listId, title, done, position, updated_at_ms AS updatedAtMs from todos where (todos.list_id = ?) order by position, id",
+              "binds": [
+                {
+                  "kind": "value",
+                  "name": "listId",
+                  "type": "string",
+                  "input": "listId"
+                }
+              ]
+            }
+          ]
+        },
+        "identity": [
           "id"
         ]
       }