on-zero 0.6.11 → 0.6.13

package/dist/esm/syncHost.test.native.js

@@ -0,0 +1,252 @@
+import { DatabaseSync } from "node:sqlite";
+import { defineQueries, defineQuery } from "@rocicorp/zero";
+import * as v from "valibot";
+import { afterEach, beforeEach, describe, expect, test } from "vitest";
+import { getScopedAuthData } from "./helpers/mutatorContext.native.js";
+import { zeroHttpFixtureSchema } from "./httpPull/fixtureSchema.native.js";
+import { createZeroSyncHostAdapter } from "./syncHost.native.js";
+import { zql } from "./zql.native.js";
+var queries = defineQueries({
+  project: {
+    byOwner: defineQuery(v.object({
+      ownerId: v.string()
+    }), function (param) {
+      var {
+        args
+      } = param;
+      return zql.project.where("ownerId", args.ownerId);
+    })
+  }
+});
+describe("createZeroSyncHostAdapter", function () {
+  var db;
+  var executor;
+  var transaction;
+  var lastQueryFormat;
+  beforeEach(function () {
+    db = new DatabaseSync(":memory:");
+    db.exec("CREATE TABLE project (id TEXT PRIMARY KEY, ownerId TEXT NOT NULL, name TEXT NOT NULL)");
+    executor = {
+      exec(sql) {
+        var params = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : [];
+        db.prepare(sql).run(...params);
+      },
+      query(sql) {
+        var params = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : [];
+        return db.prepare(sql).all(...params);
+      },
+      queryAst(_ast, format) {
+        lastQueryFormat = format;
+        var rows = db.prepare("SELECT * FROM project ORDER BY id").all();
+        return format.singular ? rows[0] : rows;
+      }
+    };
+    transaction = async function (work) {
+      var effects = [];
+      db.exec("BEGIN");
+      try {
+        var value = await work(executor, {
+          defer(effect2) {
+            effects.push(effect2);
+          }
+        });
+        db.exec("COMMIT");
+        var _iteratorNormalCompletion = true,
+          _didIteratorError = false,
+          _iteratorError = void 0;
+        try {
+          for (var _iterator = effects[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+            var effect = _step.value;
+            await effect();
+          }
+        } catch (err) {
+          _didIteratorError = true;
+          _iteratorError = err;
+        } finally {
+          try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+              _iterator.return();
+            }
+          } finally {
+            if (_didIteratorError) {
+              throw _iteratorError;
+            }
+          }
+        }
+        return value;
+      } catch (error) {
+        db.exec("ROLLBACK");
+        throw error;
+      }
+    };
+  });
+  afterEach(function () {
+    db.close();
+  });
+  test("adapts pipe-named mutators, auth, validation, and deferred effects", async function () {
+    var effectAuthID;
+    var validatedAuthID;
+    var adapter = createZeroSyncHostAdapter({
+      schema: zeroHttpFixtureSchema,
+      models: {
+        project: {
+          mutate: {
+            create: async function (param, value) {
+              var {
+                authData,
+                server,
+                tx
+              } = param;
+              expect(authData === null || authData === void 0 ? void 0 : authData.id).toBe("u1");
+              await tx.mutate.project.insert(value);
+              server === null || server === void 0 ? void 0 : server.asyncTasks.push(async function () {
+                var _getScopedAuthData;
+                effectAuthID = (_getScopedAuthData = getScopedAuthData()) === null || _getScopedAuthData === void 0 ? void 0 : _getScopedAuthData.id;
+              });
+            }
+          }
+        }
+      },
+      createServerActions: function () {
+        return {};
+      },
+      queries,
+      transaction,
+      validateMutation(param) {
+        var {
+          authData
+        } = param;
+        validatedAuthID = authData === null || authData === void 0 ? void 0 : authData.id;
+      }
+    });
+    expect(Object.keys(adapter.mutators)).toEqual(["project|create", "_zero_cleanupResults"]);
+    await transaction(function (tx, context) {
+      return adapter.mutators["project|create"](tx, {
+        id: "p1",
+        ownerId: "u1",
+        name: "first"
+      }, mutationContext(context));
+    });
+    expect(db.prepare("SELECT * FROM project").all()).toEqual([{
+      id: "p1",
+      ownerId: "u1",
+      name: "first"
+    }]);
+    expect(validatedAuthID).toBe("u1");
+    expect(effectAuthID).toBe("u1");
+  });
+  test("returns a structural application error and drops rolled-back effects", async function () {
+    var effectRuns = 0;
+    var adapter = createZeroSyncHostAdapter({
+      schema: zeroHttpFixtureSchema,
+      models: {
+        project: {
+          mutate: {
+            reject: async function (param, value) {
+              var {
+                server,
+                tx
+              } = param;
+              await tx.mutate.project.insert(value);
+              server === null || server === void 0 ? void 0 : server.asyncTasks.push(async function () {
+                effectRuns++;
+              });
+              throw new Error("denied");
+            }
+          }
+        }
+      },
+      createServerActions: function () {
+        return {};
+      },
+      transaction
+    });
+    var error = await transaction(function (tx, context) {
+      return adapter.mutators["project|reject"](tx, {
+        id: "p1",
+        ownerId: "u1",
+        name: "must roll back"
+      }, mutationContext(context));
+    }).catch(function (caught) {
+      return caught;
+    });
+    expect(error).toMatchObject({
+      name: "MutationApplicationError",
+      message: "denied",
+      details: "denied"
+    });
+    expect(db.prepare("SELECT * FROM project").all()).toEqual([]);
+    expect(effectRuns).toBe(0);
+  });
+  test("uses the host queryAst compiler surface for direct server queries", async function () {
+    db.prepare("INSERT INTO project (id, ownerId, name) VALUES (?, ?, ?)").run("p1", "u1", "first");
+    var adapter = createZeroSyncHostAdapter({
+      schema: zeroHttpFixtureSchema,
+      models: {},
+      createServerActions: function () {
+        return {};
+      },
+      transaction
+    });
+    await expect(adapter.server.query(function (q) {
+      return q.project.one();
+    })).resolves.toEqual({
+      id: "p1",
+      ownerId: "u1",
+      name: "first"
+    });
+    expect(lastQueryFormat).toEqual({
+      relationships: {},
+      singular: true
+    });
+  });
+  test("resolves auth-sensitive named queries and runs query validation", async function () {
+    var validation;
+    var adapter = createZeroSyncHostAdapter({
+      schema: zeroHttpFixtureSchema,
+      models: {},
+      createServerActions: function () {
+        return {};
+      },
+      queries,
+      transaction,
+      validateQuery(args) {
+        validation = args;
+      }
+    });
+    var ast = await adapter.resolveQuery("project|byOwner", [{
+      ownerId: "u1"
+    }], {
+      userID: "u1",
+      role: "member"
+    });
+    expect(ast).toMatchObject({
+      table: "project"
+    });
+    expect(JSON.stringify(ast)).toContain("ownerId");
+    expect(JSON.stringify(ast)).toContain("u1");
+    expect(validation).toEqual({
+      authData: {
+        id: "u1",
+        role: "member",
+        userID: "u1"
+      },
+      queryName: "project|byOwner",
+      params: {
+        ownerId: "u1"
+      }
+    });
+  });
+});
+function mutationContext(context) {
+  return {
+    ...context,
+    claims: {
+      userID: "u1",
+      role: "member"
+    },
+    clientID: "client-a",
+    mutationID: "1"
+  };
+}
+//# sourceMappingURL=syncHost.test.native.js.map

package/dist/esm/syncHost.test.native.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["DatabaseSync","defineQueries","defineQuery","v","afterEach","beforeEach","describe","expect","test","getScopedAuthData","zeroHttpFixtureSchema","createZeroSyncHostAdapter","zql","queries","project","byOwner","object","ownerId","string","param","args","where","db","executor","transaction","lastQueryFormat","exec","sql","params","arguments","length","prepare","run","query","all","queryAst","_ast","format","rows","singular","work","effects","value","defer","effect2","push","_iteratorNormalCompletion","_didIteratorError","_iteratorError","_iterator","Symbol","iterator","_step","next","done","effect","err","return","error","close","effectAuthID","validatedAuthID","adapter","schema","models","mutate","create","authData","server","tx","id","toBe","insert","asyncTasks","_getScopedAuthData","createServerActions","validateMutation","Object","keys","mutators","toEqual","context","name","mutationContext","effectRuns","reject","Error","catch","caught","toMatchObject","message","details","q","one","resolves"],"sources":["../../src/syncHost.test.ts"],"sourcesContent":[null],"mappings":"AAAA,SAASA,YAAA,QAAwC;AAEjD,SAASC,aAAA,EAAeC,WAAA,QAAmB;AAC3C,YAAYC,CAAA,MAAO;AACnB,SAASC,SAAA,EAAWC,UAAA,EAAYC,QAAA,EAAUC,MAAA,EAAQC,IAAA,QAAY;AAE9D,SAASC,iBAAA,QAAyB;AAClC,SAASC,qBAAA,QAA6B;AACtC,SAASC,yBAAA,QAAiC;AAC1C,SAASC,GAAA,QAAW;AASpB,IAAAC,OAAM,GAAAZ,aAAU;EACda,OAAA,EAAS;IACPC,OAAA,EAASb,WAAA,CAAAC,CAAA,CAAAa,MAAA;MAAYC,OAAE,EAAOd,CAAA,CAAEe,MAAA;IAAqB,EAAG,EAAC,UAAOC,KAC9D,EAAI;MACN;QAAAC;MAAA,IAAAD,KAAA;MACF,OAAAP,GAAA,CAAAE,OAAA,CAAAO,KAAA,YAAAD,IAAA,CAAAH,OAAA;IACD;EAED;AACE;AACAX,QAAI;EACJ,IAAIgB,EAAA;EACJ,IAAIC,QAAA;EAEJ,IAAAC,WAAW;EACT,IAAAC,eAAS;EACTpB,UAAG;IAAAiB,EACD,OAAAtB,YAAA;IACFsB,EAAA,CAAAI,IAAA;IACAH,QAAA,GAAW;MACTG,KAAKC,GAAA,EAAK;QACR,IAAGC,MAAA,GAAQC,SAAS,CAAIC,MAA0B,QAAAD,SAAA,iBAAAA,SAAA;QACpDP,EAAA,CAAAS,OAAA,CAAAJ,GAAA,EAAAK,GAAA,IAAAJ,MAAA;MACA;MACEK,MAAAN,GAAO;QACT,IAAAC,MAAA,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,iBAAAA,SAAA;QACA,OAAiBP,EAAA,CAAAS,OAAM,CAAAJ,GAAQ,EAAAO,GAAA,IAAAN,MAAA;MAC7B;MACAO,QAAMA,CAAAC,IAAA,EAAOC,MAAG;QAChBZ,eAAe,GAAAY,MAAA;QACjB,IAAAC,IAAA,GAAAhB,EAAA,CAAAS,OAAA,sCAAAG,GAAA;QACF,OAAAG,MAAA,CAAAE,QAAA,GAAAD,IAAA,MAAAA,IAAA;MACA;IACE;IACAd,WAAQ,kBAAAA,CAAOgB,IAAA;MACf,IAAIC,OAAA;MACFnB,EAAA,CAAAI,IAAA,CAAM,QAAQ;MAAqB,IACjC;QACE,IAAAgB,KAAA,GAAQ,MAAKF,IAAA,CAAMjB,QAAA;UACrBoB,MAAAC,OAAA;YACDH,OAAA,CAAAI,IAAA,CAAAD,OAAA;UACD;QACA;QACAtB,EAAA,CAAAI,IAAO;QACT,IAAAoB,yBAAgB;UAAAC,iBAAA;UAAAC,cAAA;QACd,IAAG;UACH,KAAM,IAAAC,SAAA,GAAAR,OAAA,CAAAS,MAAA,CAAAC,QAAA,KAAAC,KAAA,IAAAN,yBAAA,IAAAM,KAAA,GAAAH,SAAA,CAAAI,IAAA,IAAAC,IAAA,GAAAR,yBAAA;YACR,IAAAS,MAAA,GAAAH,KAAA,CAAAV,KAAA;YACF,MAAAa,MAAA;UACD;QAED,SAAUC,GAAM;UACXT,iBAAM;UACVC,cAAA,GAAAQ,GAAA;QAEI;UACC;YACA,KAAAV,yBAAA,IAAAG,SAAA,CAAAQ,MAAA;cACER,SAAU,CAAAQ,MAAA;YACd;UACA,UAAQ;YACN,IAAAV,iBAAS;cACP,MAAQC,cAAA;YACN;UACE;QACA;QACA,OAAAN,KAAA;MACE,SAAAgB,KAAA;QAAoCpC,EAAA,CAAAI,IACrC;QAAA,MACHgC,KAAA;MAAA;IACF;EACF;EACFtD,SACA;IAA6BkB,EAC7B,CAAAqC,KAAA;EAAA;EACAnD,IACA,qEAA+B;IAC7B,IAAAoD,YAAA;IAA4B,IAC9BC,eAAA;IACF,IAACC,OAAA,GAAAnD,yBAAA;MAEDoD,MAAO,EAAArD,qBAAoB;MACzBsD,MAAA;QACAlD,OAAA;UACDmD,MAAA;YACKC,MAAA,iBAAAA,CAAA/C,KAAA,EAAAuB,KAAA;cAAiB;gBAAAyB,QACrB;gBAAAC,MAAQ;gBAAAC;cAAS,IAAAlD,KAAA;cACfZ,MAAA,CAAA4D,QAAA,aAAAA,QAAA,uBAAAA,QAAA,CAAAG,EAAA,EAAAC,IAAA;cACM,MAAMF,EAAA,CAAAJ,MAAS,CAAAnD,OAAM,CAAA0D,MAAM,CAAA9B,KAAQ;cACzC0B,MAAA,KAAgB,QAAOA,MAAA,uBAAAA,MAAA,CAAAK,UAAA,CAAA5B,IAAA;gBACzB,IAAA6B,kBAAA;gBACFd,YAAA,IAAAc,kBAAA,GAAAjE,iBAAA,gBAAAiE,kBAAA,uBAAAA,kBAAA,CAAAJ,EAAA;cAEU;YACF;UACP;QACD;MACA;MACDK,mBAAA,WAAAA,CAAA;QAEI;MACH;MACA9D,OAAM;MACJW,WAAQ;MACRoD,gBAAQA,CAAAzD,KAAA;QACN;UAAAgD;QAAS,IAAAhD,KAAA;QAAA0C,eACC,GAAAM,QAAA,aAAAA,QAAA,uBAAAA,QAAA,CAAAG,EAAA;MAAA;IAEJ;IACA/D,MAAA,CAAAsE,MAAA,CAAAC,IAAQ,CAAAhB,OAAA,CAAAiB,QAAgB,GAAAC,OAAA,CAAY,CAClC,wCACD,CACD;IAAwB,MAAAxD,WAC1B,WAAA6C,EAAA,EAAAY,OAAA;MAAA,OACFnB,OAAA,CAAAiB,QAAA,mBAAAV,EAAA;QACFC,EAAA;QACFrD,OAAA;QACAiE,IAAA;MACA,GAAAC,eAAA,CAAAF,OAAA;IACF,CAAC;IAED1E,MAAM,CAAAe,EAAA,CAAAS,OAAQ,wBAAM,EAAAG,GAAA,IAAA8C,OAAA,EAAY;MAE5BV,EAAA;MACArD,OAAM,MAAM;MACZiE,IAAA;IACF,EACF,CAAE;IAEF3E,MAAA,CAAOsD,eAAO,EAAAU,IAAc;IAAAhE,MAC1B,CAAAqD,YAAM,EAAAW,IAAA;EAAA;EACG/D,IACT,uEAAS;IACX,IAAC4E,UAAA;IACD,IAAAtB,OAAU,GAAAnD,yBAAQ;MAClBoD,MAAO,EAAArD,qBAAkB;MAC1BsD,MAAA;QAEIlD,OAAA;UACAmD,MAAQ;YACToB,MAAA,iBAAAA,CAAAlE,KAAA,EAAAuB,KAAA;cACA;gBAAA0B,MAAA;gBAAAC;cAAA,IAAAlD,KAAA;cACA,MAAAkD,EAAA,CAAAJ,MAAA,CAAAnD,OAAA,CAAA0D,MAAA,CAAA9B,KAAA;cACF0B,MAAA,aAAAA,MAAA,uBAAAA,MAAA,CAAAK,UAAA,CAAA5B,IAAA;gBACMuC,UAAU;cACN;cACA,MAAC,IAAAE,KAAA;YACT;UACA;QACD;MAED;MACEX,mBAAI,WAAAA,CAAA;QACJ,OAAS;MACT;MACDnD;IACD;IACD,IAAAkC,KAAA,SAAAlC,WAAA,WAAA6C,EAAA,EAAAY,OAAA;MAED,OAAKnB,OAAA,CAAAiB,QAAA,mBAAAV,EAAA;QACCC,EAAA;QACJrD,OAAM,MAAU;QACdiE,IAAA,EAAQ;MACR,GAAAC,eAAS,CAAAF,OAAA;IAAA,EACT,CAAAM,KAAA,WAAAC,MAAqB;MACrB,OAAAA,MAAA;IAAA,EACA;IAAAjF,MACA,CAAAmD,KAAA,EAAA+B,aAAoB;MAClBP,IAAA,4BAAa;MACfQ,OAAA;MACDC,OAAA;IAED;IAA+EpF,MAC7E,CAAAe,EAAA,CAAQS,OAAA,0BAAAG,GAAA,IAAA8C,OAAA;IAAAzE,MACR,CAAA6E,UAAM,EAAAb,IAAA;EAAA,EACR;EAEA/D,IAAA,oEAA8C;IAC9Cc,EAAA,CAAAS,OAAO,2DAAwC,EAAAC,GAAA;IAC/C,IAAA8B,OAAO,GAAKnD,yBAA0B;MACtCoD,MAAO,EAAArD,qBAAoB;MACzBsD,MAAA,IAAU;MACVW,mBAAW,WAAAA,CAAA;QACX,OAAQ,CAAE;MACX;MACFnD;IACF;IAED,MAASjB,MAAA,CAAAuD,OAAA,CAAgBM,MAAA,CAAAnC,KAEE,WAAA2D,CAAA;MACzB,OAAOA,CAAA,CAAA9E,OAAA,CAAA+E,GAAA;IACL,GAAG,CAAAC,QAAA,CAAAd,OAAA;MACHV,EAAA,MAAU;MACVrD,OAAA,EAAU;MACViE,IAAA;IACF;IACF3E,MAAA,CAAAkB,eAAA,EAAAuD,OAAA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "on-zero",
-  "version": "0.6.11",
+  "version": "0.6.13",
   "description": "A typed layer over @rocicorp/zero with queries, mutations, and permissions",
   "sideEffects": false,
   "source": "src/index.ts",
@@ -37,7 +37,8 @@
     "watch": "tamagui-build --watch",
     "clean": "tamagui-build clean",
     "clean:build": "tamagui-build clean:build",
-    "test": "vitest run",
+    "test": "vitest run && bun run test:consumer-types",
+    "test:consumer-types": "bun run build && tsc -p test-fixtures/tsconfig.json",
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit",
     "format": "oxfmt",
@@ -60,6 +61,21 @@
       "import": "./dist/esm/server.mjs",
       "require": "./dist/cjs/server.cjs"
     },
+    "./sqlite": {
+      "types": "./types/createZeroSQLiteServer.d.ts",
+      "import": "./dist/esm/createZeroSQLiteServer.mjs",
+      "require": "./dist/cjs/createZeroSQLiteServer.cjs"
+    },
+    "./sync-host": {
+      "types": "./types/syncHost.d.ts",
+      "import": "./dist/esm/syncHost.mjs",
+      "require": "./dist/cjs/syncHost.cjs"
+    },
+    "./http-pull": {
+      "types": "./types/httpPullTransport.d.ts",
+      "import": "./dist/esm/httpPullTransport.mjs",
+      "require": "./dist/cjs/httpPullTransport.cjs"
+    },
     "./vite": {
       "types": "./types/vite-plugin.d.ts",
       "import": "./dist/esm/vite-plugin.mjs",
@@ -83,7 +99,7 @@
     }
   },
   "dependencies": {
-    "@take-out/helpers": "0.6.11",
+    "@take-out/helpers": "0.6.13",
     "chokidar": "^4.0.3",
     "citty": "^0.1.6",
     "valibot": "^1.1.0"

package/readme.md

@@ -517,6 +517,32 @@ app.post('/api/zero/pull', async (req) => {
 })
 ```
 
+SQLite uses the same handler surface through a separate entrypoint that does
+not import the PostgreSQL adapter:
+
+```ts
+import { createZeroSQLiteServer } from 'on-zero/sqlite'
+
+export const zeroServer = createZeroSQLiteServer({
+  schema,
+  models,
+  queries: syncedQueries,
+  mutations: mutationValidators,
+  createServerActions: () => ({ ... }),
+  transactionProvider: (callback) =>
+    storage.transaction(() => callback(sqliteExecutor)),
+})
+```
+
+`sqliteExecutor` implements `exec`, `query`, and `queryAst`. `queryAst` receives
+the query format and returns the fully materialized logical result, including
+nested relationships and singular shaping. The provider must run the callback
+inside the authoritative SQLite transaction. If the storage engine retries the
+callback, on-zero discards tasks from the abandoned attempt and returns only
+tasks from the committed attempt. The first push creates the `<schema>_clients`
+and `<schema>_mutations` ledger tables in that transaction; for example,
+`schema=zero_0` creates `zero_0_clients` and `zero_0_mutations`.
+
 ### multiple client instances
 
 one page can run several zero clients (e.g. a global control-plane instance