@missionmind/sync-api 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MissionMind
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,113 @@
-# Temporary Holding Version
+# @missionmind/sync-api
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The server side of an offline-first app whose devices keep the user's rows in
+SQLite and sync them: it applies the changes a device uploads, and serves its
+pulls, small tables whole and large ones by cursor. Drizzle on Postgres, with
+any driver and any HTTP or RPC layer. The device side is
+[`@missionmind/sync-front`](https://www.npmjs.com/package/@missionmind/sync-front).
+
+```sh
+npm install @missionmind/sync-api drizzle-orm zod
+```
+
+## How it works
+
+- **Uploads.** A device sends its queued changes in batches, each a whole row
+  to create or replace (`PUT`) or a deletion, keyed by the row's id (ids are
+  made on the device). `applyChanges` applies them one by one and returns
+  those it refuses for good (invalid data, a row of another user, a broken
+  reference): the device puts the server's version back, and the rest of the
+  batch still goes through. Any other failure throws, and the device sends the
+  batch again, so writes must be idempotent.
+- **Pulls.** One request fetches every table: the small ones whole (a
+  profile, a short list), the large ones as a page of the rows changed since
+  the device's cursor, with the ids deleted since. Cursors are positions in
+  two streams per table, rows by (`updatedAt`, `id`) and tombstones by
+  (`deletedAt`, `id`), and stay a minute behind "now" so that a transaction
+  committing late is never skipped (its rows come again; the device applies
+  them idempotently). Tables with more pages are asked again alone.
+- **Triggers** keep the pulled tables ready: every insert or update stamps
+  `updatedAt`, every deletion (cascades included) writes a tombstone in
+  `sync_tombstones`.
+- **Sync pushes** tell a device that some tables changed on the server (from
+  another client), so it pulls them now.
+
+## Exports
+
+| Entry | What |
+| --- | --- |
+| `@missionmind/sync-api` | `applyChanges`, `TableSync`, `syncChangeSchema`, `createSyncPull`, `syncTriggersSql`, `createSyncPushMessage` |
+| `@missionmind/sync-api/schema` | the `sync_tombstones` table |
+
+## Tables
+
+Every synced table has a string `id` primary key and a `userId`. Tables
+pulled by cursor also need an `updatedAt` timestamp (with time zone) and an
+index on (`userId`, `updatedAt`, `id`). Add `@missionmind/sync-api/schema` to
+`drizzle-kit`'s `schema` beside the app's, then run the triggers' SQL in a
+migration, after the tables exist (and again when a pulled table is added):
+
+```ts
+import { syncTriggersSql } from "@missionmind/sync-api";
+
+syncTriggersSql({
+  tables: ["notes", "note_items"], // the tables pulled by cursor
+  usersTable: "user", // a row deleted with its user leaves no tombstone
+});
+```
+
+## Uploads
+
+```ts
+import { applyChanges, syncChangeSchema, type TableSync } from "@missionmind/sync-api";
+
+const notesSync: TableSync<z.infer<typeof noteSchema>> = {
+  name: "note",
+  allowedKeys: ["title", "body"], // other keys of the uploaded row are ignored
+  insertSchema: noteSchema,
+  ownerOf: async (id) => (await db.query.notes.findFirst({ where: eq(notes.id, id) }))?.userId,
+  upsert: (id, userId, data) =>
+    db.insert(notes).values({ id, userId, ...data }).onConflictDoUpdate({ target: notes.id, set: data }),
+  remove: (id, userId) => db.delete(notes).where(and(eq(notes.id, id), eq(notes.userId, userId))),
+};
+
+// The endpoint takes { changes: z.array(syncChangeSchema) } and returns { rejected }.
+const rejected = await applyChanges(userId, changes, notesSync);
+```
+
+Tables whose rows reference each other (a note and its items) are uploaded
+in one request, parents first: apply them in that order.
+
+## Pulls
+
+```ts
+import { createSyncPull } from "@missionmind/sync-api";
+
+const syncPull = createSyncPull({
+  db,
+  pulled: { notes, note_items: noteItems }, // by the names the device uses
+  whole: { settings: (userId) => db.query.settings.findMany({ where: eq(settings.userId, userId) }) },
+  // pageSize (500) and safetyMarginSeconds (60) have defaults.
+});
+
+// Inputs: { changes: z.partialRecord(syncPull.pulledTableSchema, z.string().nullable()),
+//           whole: z.array(syncPull.wholeTableSchema) }
+const { changes, whole } = await syncPull.pull(userId, input);
+// After a refused upload, the device asks for the server's version of some rows:
+const rows = await syncPull.getRows(userId, "notes", ids);
+```
+
+Rows are returned without their `userId`.
+
+## Sync pushes
+
+```ts
+import { createSyncPushMessage } from "@missionmind/sync-api";
+
+// Send it with Expo's push API (https://exp.host/--/api/v2/push/send).
+createSyncPushMessage({ to: expoPushToken, tables: ["notes"], type: "myapp.sync" });
+```
+
+A data-only, high-priority push with `content-available`, kept an hour by the
+push service. The device handles it with `defineSyncPushTask` of
+`@missionmind/sync-front/push`, given the same `type`.

package/dist/changes.d.ts

@@ -0,0 +1,38 @@
+import z from "zod";
+/**
+ * A change the app queued: a whole row to create or replace, or a deletion.
+ * The endpoints take them in batches and answer with the ones they refused.
+ */
+export declare const syncChangeSchema: z.ZodObject<{
+    id: z.ZodString;
+    operation: z.ZodEnum<{
+        PUT: "PUT";
+        DELETE: "DELETE";
+    }>;
+    data: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.z.core.$strip>;
+export type SyncChange = z.infer<typeof syncChangeSchema>;
+/** A change the server refused for good; sending it again cannot help. */
+export interface RejectedChange {
+    id: string;
+    reason: string;
+}
+export interface TableSync<TInsert> {
+    allowedKeys: string[];
+    insertSchema: z.ZodType<TInsert>;
+    name: string;
+    ownerOf: (id: string) => Promise<string | undefined>;
+    /** Turns the app's stored values (ISO strings) into the column types. */
+    prepare?: (data: Record<string, unknown>) => void;
+    remove: (id: string, userId: string) => Promise<unknown>;
+    upsert: (id: string, userId: string, data: TInsert) => Promise<unknown>;
+}
+/**
+ * Applies the app's changes to one table. A change the server refuses
+ * (invalid data, a row of another user, a broken reference) is skipped and
+ * returned, so the app can put the server's version back; the rest of the
+ * batch still goes through. Any other failure throws, and the app sends the
+ * batch again.
+ */
+export declare function applyChanges<TInsert>(userId: string, changes: SyncChange[], sync: TableSync<TInsert>): Promise<RejectedChange[]>;
+//# sourceMappingURL=changes.d.ts.map

package/dist/changes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changes.d.ts","sourceRoot":"","sources":["../src/changes.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;mBAI3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,0EAA0E;AAC1E,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS,CAAC,OAAO;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACrD,yEAAyE;IACzE,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IAClD,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzD,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACzE;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,OAAO,EACxC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,UAAU,EAAE,EACrB,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC,CA+C3B"}

package/dist/changes.js

@@ -0,0 +1,82 @@
+import z from "zod";
+/**
+ * A change the app queued: a whole row to create or replace, or a deletion.
+ * The endpoints take them in batches and answer with the ones they refused.
+ */
+export const syncChangeSchema = z.object({
+    id: z.string(),
+    operation: z.enum(["PUT", "DELETE"]),
+    data: z.record(z.string(), z.unknown()).nullable(),
+});
+/**
+ * Applies the app's changes to one table. A change the server refuses
+ * (invalid data, a row of another user, a broken reference) is skipped and
+ * returned, so the app can put the server's version back; the rest of the
+ * batch still goes through. Any other failure throws, and the app sends the
+ * batch again.
+ */
+export async function applyChanges(userId, changes, sync) {
+    const rejected = [];
+    const reject = (id, reason) => {
+        console.error(`[sync] SYNC_REJECTED ${sync.name} ${id}: ${reason}`);
+        rejected.push({ id, reason });
+    };
+    for (const change of changes) {
+        try {
+            if (change.operation === "DELETE") {
+                await sync.remove(change.id, userId);
+                continue;
+            }
+            const data = Object.fromEntries(Object.entries(change.data ?? {}).filter(([key]) => sync.allowedKeys.includes(key)));
+            if (Object.keys(data).length === 0) {
+                continue;
+            }
+            sync.prepare?.(data);
+            const parsed = sync.insertSchema.safeParse(data);
+            if (!parsed.success) {
+                reject(change.id, `INVALID_DATA: ${describeIssues(parsed.error)}`);
+                continue;
+            }
+            const owner = await sync.ownerOf(change.id);
+            if (owner && owner !== userId) {
+                reject(change.id, "NOT_OWNED");
+                continue;
+            }
+            await sync.upsert(change.id, userId, parsed.data);
+        }
+        catch (error) {
+            // A broken reference or a value the column refuses is the change's own
+            // fault; anything else (the connection, a timeout) deserves a retry.
+            const code = postgresErrorCode(error);
+            if (code?.startsWith("23") || code?.startsWith("22")) {
+                reject(change.id, `CONSTRAINT: ${code}`);
+                continue;
+            }
+            throw error;
+        }
+    }
+    return rejected;
+}
+function describeIssues(error) {
+    return error.issues
+        .map((issue) => `${issue.path.join(".")} ${issue.message}`)
+        .join("; ");
+}
+const SQLSTATE = /^[0-9A-Z]{5}$/;
+/** Drizzle wraps the driver's error; the SQLSTATE is on its cause. */
+function postgresErrorCode(error) {
+    for (let current = error; current;) {
+        if (typeof current === "object" &&
+            "code" in current &&
+            typeof current.code === "string" &&
+            SQLSTATE.test(current.code)) {
+            return current.code;
+        }
+        current =
+            typeof current === "object" && "cause" in current
+                ? current.cause
+                : undefined;
+    }
+    return;
+}
+//# sourceMappingURL=changes.js.map

package/dist/changes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changes.js","sourceRoot":"","sources":["../src/changes.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC;AAqBH;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,OAAqB,EACrB,IAAwB;IAExB,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,CAAC,EAAU,EAAE,MAAc,EAAE,EAAE;QAC5C,OAAO,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,IAAI,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC,CAAC;QACpE,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC;IAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,IAAI,MAAM,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAClC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;gBACrC,SAAS;YACX,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAC7B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CACjD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC/B,CACF,CAAC;YACF,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnC,SAAS;YACX,CAAC;YACD,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YAErB,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,iBAAiB,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACnE,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC5C,IAAI,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;gBAC/B,SAAS;YACX,CAAC;YACD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,uEAAuE;YACvE,qEAAqE;YACrE,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,eAAe,IAAI,EAAE,CAAC,CAAC;gBACzC,SAAS;YACX,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,cAAc,CAAC,KAAiB;IACvC,OAAO,KAAK,CAAC,MAAM;SAChB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;SAC1D,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,QAAQ,GAAG,eAAe,CAAC;AAEjC,sEAAsE;AACtE,SAAS,iBAAiB,CAAC,KAAc;IACvC,KAAK,IAAI,OAAO,GAAG,KAAK,EAAE,OAAO,GAAI,CAAC;QACpC,IACE,OAAO,OAAO,KAAK,QAAQ;YAC3B,MAAM,IAAI,OAAO;YACjB,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;YAChC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAC3B,CAAC;YACD,OAAO,OAAO,CAAC,IAAI,CAAC;QACtB,CAAC;QACD,OAAO;YACL,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO;gBAC/C,CAAC,CAAC,OAAO,CAAC,KAAK;gBACf,CAAC,CAAC,SAAS,CAAC;IAClB,CAAC;IACD,OAAO;AACT,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/** biome-ignore-all lint/performance/noBarrelFile: the package's entry point */
+export { applyChanges, type RejectedChange, type SyncChange, syncChangeSchema, type TableSync, } from "./changes.js";
+export { type ChangesPage, createSyncPull, type PulledRow, type PulledServerTable, type SyncDatabase, type SyncPullOptions, type WholeTableReader, } from "./pull.js";
+export { createSyncPushMessage, type SyncPushMessage } from "./push.js";
+export { syncTriggersSql } from "./triggers.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,OAAO,EACL,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,gBAAgB,EAChB,KAAK,SAAS,GACf,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,WAAW,EAChB,cAAc,EACd,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,qBAAqB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+/** biome-ignore-all lint/performance/noBarrelFile: the package's entry point */
+export { applyChanges, syncChangeSchema, } from "./changes.js";
+export { createSyncPull, } from "./pull.js";
+export { createSyncPushMessage } from "./push.js";
+export { syncTriggersSql } from "./triggers.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,OAAO,EACL,YAAY,EAGZ,gBAAgB,GAEjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAEL,cAAc,GAMf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,qBAAqB,EAAwB,MAAM,WAAW,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}

package/dist/pull.d.ts

@@ -0,0 +1,59 @@
+import type { PgColumn, PgDatabase, PgTable } from "drizzle-orm/pg-core";
+import z from "zod";
+/** Drizzle on Postgres, whatever the driver. */
+export type SyncDatabase = PgDatabase<any, any, any>;
+/**
+ * A table the app pulls by cursor: the user's rows, with a string `id`, a
+ * `userId` and an `updatedAt` kept current by the sync triggers
+ * (`syncTriggersSql`). Give it a (userId, updatedAt, id) index.
+ */
+export type PulledServerTable = PgTable & {
+    id: PgColumn;
+    updatedAt: PgColumn;
+    userId: PgColumn;
+};
+/** A row as a pull sends it: without its `userId`. */
+export type PulledRow<TTable extends PulledServerTable> = Omit<TTable["$inferSelect"], "userId">;
+/** A page of the changes made to a table since a cursor. */
+export interface ChangesPage<TRow> {
+    /** Where the next pull of the table starts. */
+    cursor: string;
+    deletedIds: string[];
+    /** Whether another page is ready: ask again with `cursor`. */
+    hasMore: boolean;
+    rows: TRow[];
+}
+/** The user's rows of a small table, sent whole on every pull. */
+export type WholeTableReader = (userId: string) => Promise<unknown[]>;
+export interface SyncPullOptions<TPulled extends Record<string, PulledServerTable>, TWhole extends Record<string, WholeTableReader>> {
+    db: SyncDatabase;
+    /** Rows per table and page. Defaults to 500. */
+    pageSize?: number;
+    /** Tables pulled by cursor, under the names the app asks for them by. */
+    pulled: TPulled;
+    /**
+     * How far behind "now" a cursor stays, in seconds. Defaults to 60: longer
+     * than any transaction that writes the pulled tables.
+     */
+    safetyMarginSeconds?: number;
+    /** Small tables the app fetches whole on every pull, with their readers. */
+    whole: TWhole;
+}
+/**
+ * What the app's sync fetches: the small tables whole, and the others a page
+ * at a time from a cursor, with the ids deleted since (the tombstones the
+ * sync triggers write).
+ */
+export declare function createSyncPull<TPulled extends Record<string, PulledServerTable>, TWhole extends Record<string, WholeTableReader>>(options: SyncPullOptions<TPulled, TWhole>): {
+    getRows: <TName extends Extract<keyof TPulled, string>>(userId: string, tableName: TName, ids: string[]) => Promise<PulledRow<TPulled[TName]>[]>;
+    pull: (userId: string, request: {
+        changes: Partial<Record<Extract<keyof TPulled, string>, string | null>>;
+        whole: Extract<keyof TWhole, string>[];
+    }) => Promise<{
+        changes: { [TName in Extract<keyof TPulled, string>]?: ChangesPage<PulledRow<TPulled[TName]>> | undefined; };
+        whole: { [TName_1 in Extract<keyof TWhole, string>]?: Awaited<ReturnType<TWhole[TName_1]>> | undefined; };
+    }>;
+    pulledTableSchema: z.ZodEnum<{ [k_1 in Extract<keyof TPulled, string>]: k_1; } extends infer T ? { [k in keyof T]: T[k]; } : never>;
+    wholeTableSchema: z.ZodEnum<{ [k_3 in Extract<keyof TWhole, string>]: k_3; } extends infer T_1 ? { [k_2 in keyof T_1]: T_1[k_2]; } : never>;
+};
+//# sourceMappingURL=pull.d.ts.map

package/dist/pull.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pull.d.ts","sourceRoot":"","sources":["../src/pull.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,CAAC,MAAM,KAAK,CAAC;AAGpB,gDAAgD;AAEhD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IACxC,EAAE,EAAE,QAAQ,CAAC;IACb,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,EAAE,QAAQ,CAAC;CAClB,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,SAAS,CAAC,MAAM,SAAS,iBAAiB,IAAI,IAAI,CAC5D,MAAM,CAAC,cAAc,CAAC,EACtB,QAAQ,CACT,CAAC;AAEF,4DAA4D;AAC5D,MAAM,WAAW,WAAW,CAAC,IAAI;IAC/B,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,8DAA8D;IAC9D,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,EAAE,CAAC;CACd;AAED,kEAAkE;AAClE,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;AAEtE,MAAM,WAAW,eAAe,CAC9B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,EACjD,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE/C,EAAE,EAAE,YAAY,CAAC;IACjB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;CACf;AAyCD;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,EACjD,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAC/C,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC;cAyBlB,KAAK,iDAClB,MAAM,aACH,KAAK,OACX,MAAM,EAAE,KACZ,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;mBA6G7B,MAAM,WACL;QACP,OAAO,EAAE,OAAO,CAAC,MAAM,iCAAa,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;QACpD,KAAK,EAAE,+BAAW,CAAC;KACpB;oBAUE,KAAK;;;;;EAgCX"}

package/dist/pull.js

@@ -0,0 +1,149 @@
+import { and, asc, eq, getTableColumns, inArray, sql, } from "drizzle-orm";
+import z from "zod";
+import { syncTombstones } from "./schema.js";
+/**
+ * Position in the two streams of a table: rows ordered by (updatedAt, id),
+ * tombstones by (deletedAt, id). Timestamps are kept as text with their
+ * microseconds, which JavaScript dates would drop and stall the cursor.
+ */
+const cursorSchema = z.object({
+    rows: z.tuple([z.string(), z.string()]).nullable(),
+    tombstones: z.tuple([z.string(), z.number()]).nullable(),
+});
+function decodeCursor(cursor) {
+    if (!cursor) {
+        return { rows: null, tombstones: null };
+    }
+    const parsed = cursorSchema.safeParse(JSON.parse(Buffer.from(cursor, "base64url").toString("utf8")));
+    if (!parsed.success) {
+        throw new Error("SYNC_ERROR.INVALID_CURSOR");
+    }
+    return parsed.data;
+}
+function encodeCursor(cursor) {
+    return Buffer.from(JSON.stringify(cursor), "utf8").toString("base64url");
+}
+/** Fixed-width UTC text: compares like the timestamp it encodes. */
+const cursorTime = (value) => sql `to_char((${value}) at time zone 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS.US"Z"')`;
+/** The rows of a raw query, whether the driver returns them alone or in `rows`. */
+function rowsOf(result) {
+    return (Array.isArray(result) ? result : result.rows);
+}
+/**
+ * What the app's sync fetches: the small tables whole, and the others a page
+ * at a time from a cursor, with the ids deleted since (the tombstones the
+ * sync triggers write).
+ */
+export function createSyncPull(options) {
+    const { db, pulled } = options;
+    const pageSize = options.pageSize ?? 500;
+    /**
+     * A row is stamped with its transaction's start time but only visible once
+     * committed, so a transaction still running when a page is read may commit
+     * rows older than that page's newest one. Staying behind re-sends the last
+     * minute of changes on every pull (the app applies them idempotently)
+     * instead of missing those rows.
+     */
+    const safetyMargin = sql.raw(`interval '${Math.floor(options.safetyMarginSeconds ?? 60)} seconds'`);
+    const pulledTableSchema = z.enum(Object.keys(pulled));
+    const wholeTableSchema = z.enum(Object.keys(options.whole));
+    /** The user's rows among `ids`, as `pull` returns them. */
+    async function getRows(userId, tableName, ids) {
+        if (ids.length === 0) {
+            return [];
+        }
+        const table = pulled[tableName];
+        const rows = (await db
+            .select()
+            .from(table)
+            .where(and(eq(table.userId, userId), inArray(table.id, ids))));
+        return rows.map(({ userId: _user, ...row }) => row);
+    }
+    /** One page of the changes to `tableName` since `cursor`. */
+    async function pullChanges(userId, tableName, cursor, safeUntil) {
+        const table = pulled[tableName];
+        const position = decodeCursor(cursor);
+        const rows = (await db
+            .select({
+            ...getTableColumns(table),
+            cursorAt: cursorTime(table.updatedAt),
+            isRecent: sql `${table.updatedAt} > ${safeUntil}::timestamptz`,
+        })
+            .from(table)
+            .where(and(eq(table.userId, userId), position.rows
+            ? sql `(${table.updatedAt}, ${table.id}) > (${position.rows[0]}::timestamptz, ${position.rows[1]})`
+            : undefined))
+            .orderBy(asc(table.updatedAt), asc(table.id))
+            .limit(pageSize));
+        const tombstones = await db
+            .select({
+            id: syncTombstones.id,
+            rowId: syncTombstones.rowId,
+            cursorAt: cursorTime(syncTombstones.deletedAt),
+            isRecent: sql `${syncTombstones.deletedAt} > ${safeUntil}::timestamptz`,
+        })
+            .from(syncTombstones)
+            .where(and(eq(syncTombstones.userId, userId), eq(syncTombstones.tableName, tableName), position.tombstones
+            ? sql `(${syncTombstones.deletedAt}, ${syncTombstones.id}) > (${position.tombstones[0]}::timestamptz, ${position.tombstones[1]})`
+            : undefined))
+            .orderBy(asc(syncTombstones.deletedAt), asc(syncTombstones.id))
+            .limit(pageSize);
+        const rowsStream = advance(rows.map((row) => ({
+            position: [row.cursorAt, row.id],
+            isRecent: row.isRecent,
+        })), position.rows, [safeUntil, ""], pageSize);
+        const tombstonesStream = advance(tombstones.map((row) => ({
+            position: [row.cursorAt, row.id],
+            isRecent: row.isRecent,
+        })), position.tombstones, [safeUntil, 0], pageSize);
+        return {
+            rows: rows.map(({ cursorAt: _at, isRecent: _recent, userId: _user, ...row }) => row),
+            deletedIds: tombstones.map((tombstone) => tombstone.rowId),
+            cursor: encodeCursor({
+                rows: rowsStream.position,
+                tombstones: tombstonesStream.position,
+            }),
+            hasMore: rowsStream.hasMore || tombstonesStream.hasMore,
+        };
+    }
+    /**
+     * Everything a sync fetches, in one request: the `whole` tables in full,
+     * and a page of the changes to each table of `changes` since its cursor (a
+     * null cursor starts from the beginning). The app calls again, for the
+     * tables whose page `hasMore`, with the returned cursors.
+     */
+    async function pull(userId, request) {
+        // One reference time for every table of the request.
+        const [{ safeUntil }] = rowsOf(await db.execute(sql `select ${cursorTime(sql `now() - ${safetyMargin}`)} as "safeUntil"`));
+        const changes = {};
+        for (const [tableName, cursor] of Object.entries(request.changes)) {
+            changes[tableName] = await pullChanges(userId, tableName, cursor, safeUntil);
+        }
+        const requested = new Set(request.whole);
+        const whole = {};
+        for (const [tableName, read] of Object.entries(options.whole)) {
+            if (requested.has(tableName)) {
+                whole[tableName] = (await read(userId));
+            }
+        }
+        return { changes, whole };
+    }
+    return { getRows, pull, pulledTableSchema, wholeTableSchema };
+}
+/**
+ * Where a stream resumes: after its last item, unless that item is inside the
+ * safety margin, in which case at the margin (so the recent items come again).
+ */
+function advance(items, previous, margin, pageSize) {
+    const last = items.at(-1);
+    if (!last) {
+        return { position: previous, hasMore: false };
+    }
+    if (last.isRecent) {
+        // Never move backwards past where a previous pull already got to.
+        const isAheadOfPrevious = !previous || margin[0] > previous[0];
+        return { position: isAheadOfPrevious ? margin : previous, hasMore: false };
+    }
+    return { position: last.position, hasMore: items.length === pageSize };
+}
+//# sourceMappingURL=pull.js.map

package/dist/pull.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pull.js","sourceRoot":"","sources":["../src/pull.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,GAAG,EACH,EAAE,EACF,eAAe,EACf,OAAO,EAEP,GAAG,GACJ,MAAM,aAAa,CAAC;AAErB,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAsD7C;;;;GAIG;AACH,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC;AAGH,SAAS,YAAY,CAAC,MAAqB;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC1C,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CACnC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAC9D,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAED,SAAS,YAAY,CAAC,MAAc;IAClC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC3E,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,GAAG,CAAC,KAAkC,EAAE,EAAE,CACxD,GAAG,CAAQ,YAAY,KAAK,wDAAwD,CAAC;AAEvF,mFAAmF;AACnF,SAAS,MAAM,CAAI,MAAe;IAChC,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,MAAwB,CAAC,IAAI,CACzD,CAAC;AACX,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAG5B,OAAyC;IAIzC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,CAAC;IACzC;;;;;;OAMG;IACH,MAAM,YAAY,GAAG,GAAG,CAAC,GAAG,CAC1B,aAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,mBAAmB,IAAI,EAAE,CAAC,WAAW,CACtE,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAkC,CACrD,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAgC,CAC1D,CAAC;IAEF,2DAA2D;IAC3D,KAAK,UAAU,OAAO,CACpB,MAAc,EACd,SAAgB,EAChB,GAAa;QAEb,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,KAAK,GAAsB,MAAM,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE;aACnB,MAAM,EAAE;aACR,IAAI,CAAC,KAAK,CAAC;aACX,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,CAG5D,CAAC;QACJ,OAAO,IAAI,CAAC,GAAG,CACb,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,CAAC,GAAgC,CAChE,CAAC;IACJ,CAAC;IAED,6DAA6D;IAC7D,KAAK,UAAU,WAAW,CACxB,MAAc,EACd,SAAgB,EAChB,MAAqB,EACrB,SAAiB;QAEjB,MAAM,KAAK,GAAsB,MAAM,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QAEtC,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE;aACnB,MAAM,CAAC;YACN,GAAG,eAAe,CAAC,KAAK,CAAC;YACzB,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC;YACrC,QAAQ,EAAE,GAAG,CAAS,GAAG,KAAK,CAAC,SAAS,MAAM,SAAS,eAAe;SACvE,CAAC;aACD,IAAI,CAAC,KAAK,CAAC;aACX,KAAK,CACJ,GAAG,CACD,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EACxB,QAAQ,CAAC,IAAI;YACX,CAAC,CAAC,GAAG,CAAA,IAAI,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,EAAE,QAAQ,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG;YAClG,CAAC,CAAC,SAAS,CACd,CACF;aACA,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aAC5C,KAAK,CAAC,QAAQ,CAAC,CAId,CAAC;QAEL,MAAM,UAAU,GAAG,MAAM,EAAE;aACxB,MAAM,CAAC;YACN,EAAE,EAAE,cAAc,CAAC,EAAE;YACrB,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,QAAQ,EAAE,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC;YAC9C,QAAQ,EAAE,GAAG,CAAS,GAAG,cAAc,CAAC,SAAS,MAAM,SAAS,eAAe;SAChF,CAAC;aACD,IAAI,CAAC,cAAc,CAAC;aACpB,KAAK,CACJ,GAAG,CACD,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EACjC,EAAE,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,EACvC,QAAQ,CAAC,UAAU;YACjB,CAAC,CAAC,GAAG,CAAA,IAAI,cAAc,CAAC,SAAS,KAAK,cAAc,CAAC,EAAE,QAAQ,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG;YAChI,CAAC,CAAC,SAAS,CACd,CACF;aACA,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;aAC9D,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEnB,MAAM,UAAU,GAAG,OAAO,CACxB,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACjB,QAAQ,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAqB;YACpD,QAAQ,EAAE,GAAG,CAAC,QAAQ;SACvB,CAAC,CAAC,EACH,QAAQ,CAAC,IAAI,EACb,CAAC,SAAS,EAAE,EAAE,CAAC,EACf,QAAQ,CACT,CAAC;QACF,MAAM,gBAAgB,GAAG,OAAO,CAC9B,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACvB,QAAQ,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAqB;YACpD,QAAQ,EAAE,GAAG,CAAC,QAAQ;SACvB,CAAC,CAAC,EACH,QAAQ,CAAC,UAAU,EACnB,CAAC,SAAS,EAAE,CAAC,CAAC,EACd,QAAQ,CACT,CAAC;QAEF,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,GAAG,CACZ,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,CAC9D,GAAgC,CACnC;YACD,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;YAC1D,MAAM,EAAE,YAAY,CAAC;gBACnB,IAAI,EAAE,UAAU,CAAC,QAAQ;gBACzB,UAAU,EAAE,gBAAgB,CAAC,QAAQ;aACtC,CAAC;YACF,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,gBAAgB,CAAC,OAAO;SACxD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,UAAU,IAAI,CACjB,MAAc,EACd,OAGC;QAED,qDAAqD;QACrD,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,MAAM,CAC5B,MAAM,EAAE,CAAC,OAAO,CACd,GAAG,CAAA,UAAU,UAAU,CAAC,GAAG,CAAA,WAAW,YAAY,EAAE,CAAC,iBAAiB,CACvE,CACF,CAAC;QAEF,MAAM,OAAO,GAET,EAAE,CAAC;QACP,KAAK,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAG7D,EAAE,CAAC;YACJ,OAAO,CAAC,SAAS,CAAC,GAAG,MAAM,WAAW,CACpC,MAAM,EACN,SAAS,EACT,MAAM,EACN,SAAS,CACV,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,GAAG,CAAS,OAAO,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,KAAK,GAEP,EAAE,CAAC;QACP,KAAK,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAGzD,EAAE,CAAC;YACJ,IAAI,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAErC,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,SAAS,OAAO,CACd,KAA2C,EAC3C,QAAkB,EAClB,MAAS,EACT,QAAgB;IAEhB,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAChD,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,kEAAkE;QAClE,MAAM,iBAAiB,GAAG,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/D,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC7E,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;AACzE,CAAC"}

package/dist/push.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A sync push: a headless background notification (data only, no title or
+ * body, `content-available` on iOS) telling the user's device that these
+ * tables changed on the server, so it pulls them now rather than at its next
+ * sync. `@missionmind/sync-front/push` handles it on the device, with the same
+ * `type`.
+ */
+export interface SyncPushMessage {
+    _contentAvailable: true;
+    data: {
+        tables: string[];
+        type: string;
+    };
+    priority: "high";
+    to: string;
+    ttl: number;
+}
+/** The Expo push message of a sync push, for Expo's push API. */
+export declare function createSyncPushMessage(options: {
+    tables: string[];
+    /** The Expo push token of the device. */
+    to: string;
+    /** Tells a sync push from the app's other notifications, e.g. "myapp.sync". */
+    type: string;
+    /**
+     * Seconds the push service keeps trying to deliver it. Defaults to an hour:
+     * a sync asked for long ago is no longer worth waking the app for.
+     */
+    ttl?: number;
+}): SyncPushMessage;
+//# sourceMappingURL=push.d.ts.map

package/dist/push.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.d.ts","sourceRoot":"","sources":["../src/push.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,iBAAiB,EAAE,IAAI,CAAC;IACxB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACb;AAED,iEAAiE;AACjE,wBAAgB,qBAAqB,CAAC,OAAO,EAAE;IAC7C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GAAG,eAAe,CAQlB"}

package/dist/push.js

@@ -0,0 +1,11 @@
+/** The Expo push message of a sync push, for Expo's push API. */
+export function createSyncPushMessage(options) {
+    return {
+        to: options.to,
+        data: { type: options.type, tables: options.tables },
+        _contentAvailable: true,
+        priority: "high",
+        ttl: options.ttl ?? 60 * 60,
+    };
+}
+//# sourceMappingURL=push.js.map

package/dist/push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.js","sourceRoot":"","sources":["../src/push.ts"],"names":[],"mappings":"AAeA,iEAAiE;AACjE,MAAM,UAAU,qBAAqB,CAAC,OAWrC;IACC,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;QACpD,iBAAiB,EAAE,IAAI;QACvB,QAAQ,EAAE,MAAM;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE;KAC5B,CAAC;AACJ,CAAC"}