@rxferrix/client 0.0.0-stage → 0.1.0

package/dist/diff.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Result diffs (docs/PROTOCOL.md, "Result diffs"): the server sends what changed in a query result instead of the
+ * whole result, relative to the result this client already has. The format, applied to the previous result:
+ *
+ * - `{"$r": value}`: replace with `value`.
+ * - `{"$a": [op, …]}`: edit an array. The ops walk the old array from the start: a positive integer `n` keeps the next
+ *   `n` elements, a negative integer `-n` deletes them, an array inserts its elements, and `{"$p": diff}` patches the
+ *   next element. Elements after the last op are kept.
+ * - `{"$o": {"s": {…}, "d": […], "p": {…}}}`: edit an object: set, delete and patch keys.
+ *
+ * Unchanged elements and objects are reused, not copied, so React and Svelte can skip re-rendering them.
+ */
+/** A diff didn't fit the result it was applied to: the client's copy is not what the server diffed against. */
+export declare class DiffMismatch extends Error {
+    constructor(message: string);
+}
+type Json = unknown;
+export declare function applyDiff(old: Json, diff: Json): Json;
+export {};
+//# sourceMappingURL=diff.d.ts.map

package/dist/diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../src/diff.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,+GAA+G;AAC/G,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAG5B;AAED,KAAK,IAAI,GAAG,OAAO,CAAC;AAYpB,wBAAgB,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAsDrD"}

package/dist/diff.js

@@ -0,0 +1,100 @@
+/**
+ * Result diffs (docs/PROTOCOL.md, "Result diffs"): the server sends what changed in a query result instead of the
+ * whole result, relative to the result this client already has. The format, applied to the previous result:
+ *
+ * - `{"$r": value}`: replace with `value`.
+ * - `{"$a": [op, …]}`: edit an array. The ops walk the old array from the start: a positive integer `n` keeps the next
+ *   `n` elements, a negative integer `-n` deletes them, an array inserts its elements, and `{"$p": diff}` patches the
+ *   next element. Elements after the last op are kept.
+ * - `{"$o": {"s": {…}, "d": […], "p": {…}}}`: edit an object: set, delete and patch keys.
+ *
+ * Unchanged elements and objects are reused, not copied, so React and Svelte can skip re-rendering them.
+ */
+/** A diff didn't fit the result it was applied to: the client's copy is not what the server diffed against. */
+export class DiffMismatch extends Error {
+    constructor(message) {
+        super(`result diff doesn't apply: ${message}`);
+    }
+}
+function isObject(v) {
+    return typeof v === "object" && v !== null && !Array.isArray(v);
+}
+/** Sets `key` as a plain own property: `out[key] = value` would set the prototype for `"__proto__"` (a key data can
+ * have, e.g. in a map keyed by user input). */
+function setOwn(out, key, value) {
+    Object.defineProperty(out, key, { value, enumerable: true, writable: true, configurable: true });
+}
+export function applyDiff(old, diff) {
+    if (!isObject(diff))
+        throw new DiffMismatch("a diff must be an object");
+    if ("$r" in diff)
+        return diff.$r;
+    if ("$a" in diff) {
+        const ops = diff.$a;
+        if (!Array.isArray(old) || !Array.isArray(ops))
+            throw new DiffMismatch("array diff applied to a non-array");
+        const out = [];
+        let i = 0;
+        for (const op of ops) {
+            if (typeof op === "number") {
+                const count = Math.abs(op);
+                if (op === 0 || !Number.isInteger(op) || i + count > old.length) {
+                    throw new DiffMismatch(`op ${op} at ${i} runs past ${old.length} elements`);
+                }
+                if (op > 0)
+                    for (let k = i; k < i + count; k++)
+                        out.push(old[k]);
+                i += count;
+            }
+            else if (Array.isArray(op)) {
+                for (const item of op)
+                    out.push(item);
+            }
+            else if (isObject(op) && "$p" in op) {
+                if (i >= old.length)
+                    throw new DiffMismatch("patch past the end");
+                out.push(applyDiff(old[i], op.$p));
+                i += 1;
+            }
+            else {
+                throw new DiffMismatch(`bad array op ${JSON.stringify(op)}`);
+            }
+        }
+        for (let k = i; k < old.length; k++)
+            out.push(old[k]);
+        return out;
+    }
+    if ("$o" in diff) {
+        const o = diff.$o;
+        if (!isObject(old) || !isObject(o))
+            throw new DiffMismatch("object diff applied to a non-object");
+        const out = { ...old };
+        if (o.d !== undefined) {
+            if (!Array.isArray(o.d))
+                throw new DiffMismatch("bad deleted keys");
+            for (const key of o.d) {
+                if (typeof key !== "string" || !Object.hasOwn(out, key))
+                    throw new DiffMismatch(`deleting missing key ${String(key)}`);
+                delete out[key];
+            }
+        }
+        if (o.s !== undefined) {
+            if (!isObject(o.s))
+                throw new DiffMismatch("bad set keys");
+            for (const [key, value] of Object.entries(o.s))
+                setOwn(out, key, value);
+        }
+        if (o.p !== undefined) {
+            if (!isObject(o.p))
+                throw new DiffMismatch("bad patched keys");
+            for (const [key, sub] of Object.entries(o.p)) {
+                if (!Object.hasOwn(old, key))
+                    throw new DiffMismatch(`patching missing key ${key}`);
+                setOwn(out, key, applyDiff(old[key], sub));
+            }
+        }
+        return out;
+    }
+    throw new DiffMismatch(`unknown diff ${JSON.stringify(diff)}`);
+}
+//# sourceMappingURL=diff.js.map

package/dist/diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../src/diff.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,+GAA+G;AAC/G,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,8BAA8B,OAAO,EAAE,CAAC,CAAC;IACjD,CAAC;CACF;AAID,SAAS,QAAQ,CAAC,CAAO;IACvB,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;+CAC+C;AAC/C,SAAS,MAAM,CAAC,GAAyB,EAAE,GAAW,EAAE,KAAW;IACjE,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;AACnG,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAS,EAAE,IAAU;IAC7C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,YAAY,CAAC,0BAA0B,CAAC,CAAC;IACxE,IAAI,IAAI,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC,EAAE,CAAC;IACjC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,YAAY,CAAC,mCAAmC,CAAC,CAAC;QAC5G,MAAM,GAAG,GAAW,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC3B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;oBAChE,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,GAAG,CAAC,MAAM,WAAW,CAAC,CAAC;gBAC9E,CAAC;gBACD,IAAI,EAAE,GAAG,CAAC;oBAAE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;wBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjE,CAAC,IAAI,KAAK,CAAC;YACb,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC7B,KAAK,MAAM,IAAI,IAAI,EAAE;oBAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;iBAAM,IAAI,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM;oBAAE,MAAM,IAAI,YAAY,CAAC,oBAAoB,CAAC,CAAC;gBAClE,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBACnC,CAAC,IAAI,CAAC,CAAC;YACT,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,YAAY,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,MAAM,IAAI,YAAY,CAAC,qCAAqC,CAAC,CAAC;QAClG,MAAM,GAAG,GAAyB,EAAE,GAAG,GAAG,EAAE,CAAC;QAC7C,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;YACpE,KAAK,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC;oBAAE,MAAM,IAAI,YAAY,CAAC,wBAAwB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACvH,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAE,MAAM,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;YAC3D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1E,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;YAC/D,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC;oBAAE,MAAM,IAAI,YAAY,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAC;gBACpF,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,MAAM,IAAI,YAAY,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACjE,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorData } from "./protocol.js";
+/**
+ * An error raised by a RxFerrix function or by the client itself.
+ *
+ * For a server `UserError`, `code` and `data` carry the error's `errorData` (`{ code, data }`). For any other server
+ * error, `code` and `data` are undefined and `message` is the server's `errorMessage` (`"Server Error"` outside
+ * `--dev`).
+ */
+export declare class RxFerrixError extends Error {
+    name: string;
+    readonly code?: string;
+    readonly data?: unknown;
+    constructor(message: string, options?: {
+        code?: string;
+        data?: unknown;
+        cause?: unknown;
+    });
+    /** Builds an error from a server failure payload (`errorMessage` + optional `errorData`). */
+    static fromServer(errorMessage: string | undefined, errorData: ErrorData | null | undefined): RxFerrixError;
+}
+/** Code used for client-side failures (lost connection, client closed). */
+export declare const CONNECTION_LOST = "ConnectionLost";
+export declare const CLIENT_CLOSED = "ClientClosed";
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAC7B,IAAI,SAAmB;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;gBAEZ,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;IAMzF,6FAA6F;IAC7F,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,GAAG,SAAS,GAAG,aAAa;CAU5G;AAED,2EAA2E;AAC3E,eAAO,MAAM,eAAe,mBAAmB,CAAC;AAChD,eAAO,MAAM,aAAa,iBAAiB,CAAC"}

package/dist/errors.js

@@ -0,0 +1,34 @@
+/**
+ * An error raised by a RxFerrix function or by the client itself.
+ *
+ * For a server `UserError`, `code` and `data` carry the error's `errorData` (`{ code, data }`). For any other server
+ * error, `code` and `data` are undefined and `message` is the server's `errorMessage` (`"Server Error"` outside
+ * `--dev`).
+ */
+export class RxFerrixError extends Error {
+    name = "RxFerrixError";
+    code;
+    data;
+    constructor(message, options) {
+        super(message, options?.cause !== undefined ? { cause: options.cause } : undefined);
+        if (options?.code !== undefined)
+            this.code = options.code;
+        if (options?.data !== undefined)
+            this.data = options.data;
+    }
+    /** Builds an error from a server failure payload (`errorMessage` + optional `errorData`). */
+    static fromServer(errorMessage, errorData) {
+        const message = typeof errorMessage === "string" && errorMessage.length > 0 ? errorMessage : "Server Error";
+        if (errorData && typeof errorData === "object") {
+            return new RxFerrixError(message, {
+                code: typeof errorData.code === "string" ? errorData.code : undefined,
+                data: errorData.data,
+            });
+        }
+        return new RxFerrixError(message);
+    }
+}
+/** Code used for client-side failures (lost connection, client closed). */
+export const CONNECTION_LOST = "ConnectionLost";
+export const CLIENT_CLOSED = "ClientClosed";
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAC7B,IAAI,GAAG,eAAe,CAAC;IACvB,IAAI,CAAU;IACd,IAAI,CAAW;IAExB,YAAY,OAAe,EAAE,OAA4D;QACvF,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACpF,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1D,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5D,CAAC;IAED,6FAA6F;IAC7F,MAAM,CAAC,UAAU,CAAC,YAAgC,EAAE,SAAuC;QACzF,MAAM,OAAO,GAAG,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,CAAC;QAC5G,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC/C,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE;gBAChC,IAAI,EAAE,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;gBACrE,IAAI,EAAE,SAAS,CAAC,IAAI;aACrB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;CACF;AAED,2EAA2E;AAC3E,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAAC;AAChD,MAAM,CAAC,MAAM,aAAa,GAAG,cAAc,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export { makeFunctionReference, getFunctionName, type FunctionKind, type FunctionReference, type AnyQueryReference, type AnyMutationReference, type AnyActionReference, type ArgsOf, type OutputOf, type OptionalArgs, type OptionalArgsOrSkip, type ArgsAndOptions, type HasNoRequiredArgs, type Id, } from "./api.js";
+export { RxFerrixClient, type RxFerrixClientOptions, type MutationOptions, type AuthTokenFetcher, type ConnectionState, type QueryWatch, } from "./client.js";
+export { RxFerrixError, CONNECTION_LOST, CLIENT_CLOSED } from "./errors.js";
+export { applyDiff, DiffMismatch } from "./diff.js";
+export { RxFerrixAuth, getAuth, systemApi, MemoryAuthStorage, type AuthStorage, type AuthState, type AuthTokens, type AuthProviders, type CodeProof, type RxFerrixAuthOptions, type RedirectResult, type User, } from "./auth.js";
+export type { OptimisticLocalStore, OptimisticUpdate } from "./optimistic_updates.js";
+export { insertAtTop, getAllPages, type PaginationOpts, type PaginationResult, type PaginationStatus, type PaginatedQuery, type PaginatedQueryResult, type PaginatedQueryOptions, type PaginatedQueryReference, type PaginatedQueryItem, type PaginatedQueryArgs, } from "./paginated_query.js";
+export { LOADING, type QueryState } from "./query_state.js";
+export { uploadFile, type UploadFileOptions, type UploadProgress } from "./storage.js";
+export { bytesToJson, bytesFromJson, isBytes, type Bytes } from "./bytes.js";
+export { canonicalJSON, queryToken, jsonEqual, type QueryToken } from "./canonical.js";
+export { CLIENT_VERSION, type StateVersion, type ClientMessage, type ServerMessage, type ErrorData } from "./protocol.js";
+export type * as protocol from "./protocol.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,OAAO,EACL,qBAAqB,EACrB,eAAe,EACf,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,MAAM,EACX,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,EAAE,GACR,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,UAAU,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EACL,YAAY,EACZ,OAAO,EACP,SAAS,EACT,iBAAiB,EACjB,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,IAAI,GACV,MAAM,WAAW,CAAC;AACnB,YAAY,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EACL,WAAW,EACX,WAAW,EACX,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1H,YAAY,KAAK,QAAQ,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,12 @@
+export { makeFunctionReference, getFunctionName, } from "./api.js";
+export { RxFerrixClient, } from "./client.js";
+export { RxFerrixError, CONNECTION_LOST, CLIENT_CLOSED } from "./errors.js";
+export { applyDiff, DiffMismatch } from "./diff.js";
+export { RxFerrixAuth, getAuth, systemApi, MemoryAuthStorage, } from "./auth.js";
+export { insertAtTop, getAllPages, } from "./paginated_query.js";
+export { LOADING } from "./query_state.js";
+export { uploadFile } from "./storage.js";
+export { bytesToJson, bytesFromJson, isBytes } from "./bytes.js";
+export { canonicalJSON, queryToken, jsonEqual } from "./canonical.js";
+export { CLIENT_VERSION } from "./protocol.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,OAAO,EACL,qBAAqB,EACrB,eAAe,GAahB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,cAAc,GAMf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EACL,YAAY,EACZ,OAAO,EACP,SAAS,EACT,iBAAiB,GASlB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,WAAW,EACX,WAAW,GAUZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAmB,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAA+C,MAAM,cAAc,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAc,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAmB,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,cAAc,EAA6E,MAAM,eAAe,CAAC"}

package/dist/local_query_set.d.ts

@@ -0,0 +1,56 @@
+import { type QueryToken } from "./canonical.js";
+import type { ModifyQuerySetMessage, QueryId } from "./protocol.js";
+export interface LocalQuery {
+    readonly token: QueryToken;
+    readonly queryId: QueryId;
+    readonly udfPath: string;
+    readonly args: Record<string, unknown>;
+    refCount: number;
+    /** Whether an `Add` for this query is part of the server's query set on the current socket. */
+    onServer: boolean;
+}
+export interface FlushResult {
+    /** The message to send, or null when nothing changed (or nothing can be sent right now). */
+    message: ModifyQuerySetMessage | null;
+    /** Queries dropped locally by this flush (their last watcher left). Their results should be discarded. */
+    removed: QueryId[];
+}
+/**
+ * The set of queries this client wants to be subscribed to.
+ *
+ * Queries are keyed by `udfPath + canonicalJSON(args)`. Watchers of the same query share one queryId and one server
+ * subscription; the subscription is dropped when the last watcher leaves. Changes are not sent eagerly: they are
+ * diffed against what the server knows on flush, so an add and a remove of the same query in the same tick cancel
+ * out and several changes produce a single `ModifyQuerySet`.
+ */
+export declare class LocalQuerySet {
+    private nextQueryId;
+    private readonly byToken;
+    private readonly byId;
+    /** Queries dropped locally whose `Remove` still has to reach the server on this socket. */
+    private readonly pendingRemoves;
+    /** The `newVersion` of the last ModifyQuerySet sent on this socket. */
+    private querySetVersion;
+    /** Adds a watcher; returns the query (created if needed) and whether a flush is needed. */
+    addRef(udfPath: string, args: Record<string, unknown>): {
+        query: LocalQuery;
+        needsFlush: boolean;
+    };
+    /** Removes a watcher; returns true when the query has no watchers left (a flush should be scheduled). */
+    removeRef(token: QueryToken): boolean;
+    get(token: QueryToken): LocalQuery | undefined;
+    getById(queryId: QueryId): LocalQuery | undefined;
+    /** All queries currently tracked (including ones whose last watcher left but that are not yet flushed). */
+    queries(): IterableIterator<LocalQuery>;
+    get size(): number;
+    /**
+     * Drops queries without watchers and, if `canSend`, builds the ModifyQuerySet that brings the server's query set
+     * in line with the local one (bumping the query set version).
+     */
+    flush(canSend: boolean): FlushResult;
+    /** The server state is fresh on a new socket: nothing is subscribed and the query set version is 0. */
+    resetForNewSocket(): void;
+    /** The `newVersion` of the last ModifyQuerySet sent on this socket. */
+    get sentQuerySetVersion(): number;
+}
+//# sourceMappingURL=local_query_set.d.ts.map

package/dist/local_query_set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local_query_set.d.ts","sourceRoot":"","sources":["../src/local_query_set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,OAAO,EAAwB,MAAM,eAAe,CAAC;AAE1F,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,+FAA+F;IAC/F,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,4FAA4F;IAC5F,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACtC,0GAA0G;IAC1G,OAAO,EAAE,OAAO,EAAE,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqC;IAC7D,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAkC;IACvD,2FAA2F;IAC3F,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAsB;IACrD,uEAAuE;IACvE,OAAO,CAAC,eAAe,CAAK;IAE5B,2FAA2F;IAC3F,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE;IAqBlG,yGAAyG;IACzG,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;IAOrC,GAAG,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS;IAI9C,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS;IAIjD,2GAA2G;IAC3G,OAAO,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIvC,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW;IA8BpC,uGAAuG;IACvG,iBAAiB,IAAI,IAAI;IAMzB,uEAAuE;IACvE,IAAI,mBAAmB,IAAI,MAAM,CAEhC;CACF"}

package/dist/local_query_set.js

@@ -0,0 +1,108 @@
+import { queryToken } from "./canonical.js";
+/**
+ * The set of queries this client wants to be subscribed to.
+ *
+ * Queries are keyed by `udfPath + canonicalJSON(args)`. Watchers of the same query share one queryId and one server
+ * subscription; the subscription is dropped when the last watcher leaves. Changes are not sent eagerly: they are
+ * diffed against what the server knows on flush, so an add and a remove of the same query in the same tick cancel
+ * out and several changes produce a single `ModifyQuerySet`.
+ */
+export class LocalQuerySet {
+    nextQueryId = 0;
+    byToken = new Map();
+    byId = new Map();
+    /** Queries dropped locally whose `Remove` still has to reach the server on this socket. */
+    pendingRemoves = new Set();
+    /** The `newVersion` of the last ModifyQuerySet sent on this socket. */
+    querySetVersion = 0;
+    /** Adds a watcher; returns the query (created if needed) and whether a flush is needed. */
+    addRef(udfPath, args) {
+        const token = queryToken(udfPath, args);
+        const existing = this.byToken.get(token);
+        if (existing) {
+            existing.refCount += 1;
+            // refCount went 0 -> 1 before the flush: the query is revived without any server traffic.
+            return { query: existing, needsFlush: false };
+        }
+        const query = {
+            token,
+            queryId: this.nextQueryId++,
+            udfPath,
+            args,
+            refCount: 1,
+            onServer: false,
+        };
+        this.byToken.set(token, query);
+        this.byId.set(query.queryId, query);
+        return { query, needsFlush: true };
+    }
+    /** Removes a watcher; returns true when the query has no watchers left (a flush should be scheduled). */
+    removeRef(token) {
+        const query = this.byToken.get(token);
+        if (!query)
+            return false;
+        query.refCount = Math.max(0, query.refCount - 1);
+        return query.refCount === 0;
+    }
+    get(token) {
+        return this.byToken.get(token);
+    }
+    getById(queryId) {
+        return this.byId.get(queryId);
+    }
+    /** All queries currently tracked (including ones whose last watcher left but that are not yet flushed). */
+    queries() {
+        return this.byToken.values();
+    }
+    get size() {
+        return this.byToken.size;
+    }
+    /**
+     * Drops queries without watchers and, if `canSend`, builds the ModifyQuerySet that brings the server's query set
+     * in line with the local one (bumping the query set version).
+     */
+    flush(canSend) {
+        const removed = [];
+        for (const query of [...this.byToken.values()]) {
+            if (query.refCount > 0)
+                continue;
+            this.byToken.delete(query.token);
+            this.byId.delete(query.queryId);
+            removed.push(query.queryId);
+            if (query.onServer)
+                this.pendingRemoves.add(query.queryId);
+        }
+        if (!canSend)
+            return { message: null, removed };
+        const modifications = [];
+        for (const query of this.byToken.values()) {
+            if (!query.onServer) {
+                modifications.push({ type: "Add", queryId: query.queryId, udfPath: query.udfPath, args: query.args });
+                query.onServer = true;
+            }
+        }
+        for (const queryId of this.pendingRemoves)
+            modifications.push({ type: "Remove", queryId });
+        this.pendingRemoves.clear();
+        if (modifications.length === 0)
+            return { message: null, removed };
+        const baseVersion = this.querySetVersion;
+        this.querySetVersion += 1;
+        return {
+            message: { type: "ModifyQuerySet", baseVersion, newVersion: this.querySetVersion, modifications },
+            removed,
+        };
+    }
+    /** The server state is fresh on a new socket: nothing is subscribed and the query set version is 0. */
+    resetForNewSocket() {
+        this.querySetVersion = 0;
+        this.pendingRemoves.clear();
+        for (const query of this.byToken.values())
+            query.onServer = false;
+    }
+    /** The `newVersion` of the last ModifyQuerySet sent on this socket. */
+    get sentQuerySetVersion() {
+        return this.querySetVersion;
+    }
+}
+//# sourceMappingURL=local_query_set.js.map

package/dist/local_query_set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local_query_set.js","sourceRoot":"","sources":["../src/local_query_set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,gBAAgB,CAAC;AAoB7D;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAChB,WAAW,GAAG,CAAC,CAAC;IACP,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAC;IAC5C,IAAI,GAAG,IAAI,GAAG,EAAuB,CAAC;IACvD,2FAA2F;IAC1E,cAAc,GAAG,IAAI,GAAG,EAAW,CAAC;IACrD,uEAAuE;IAC/D,eAAe,GAAG,CAAC,CAAC;IAE5B,2FAA2F;IAC3F,MAAM,CAAC,OAAe,EAAE,IAA6B;QACnD,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,QAAQ,IAAI,CAAC,CAAC;YACvB,0FAA0F;YAC1F,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QAChD,CAAC;QACD,MAAM,KAAK,GAAe;YACxB,KAAK;YACL,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE;YAC3B,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACpC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACrC,CAAC;IAED,yGAAyG;IACzG,SAAS,CAAC,KAAiB;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACzB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC,QAAQ,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,GAAG,CAAC,KAAiB;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,OAAgB;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,2GAA2G;IAC3G,OAAO;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAgB;QACpB,MAAM,OAAO,GAAc,EAAE,CAAC;QAC9B,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,QAAQ,GAAG,CAAC;gBAAE,SAAS;YACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC5B,IAAI,KAAK,CAAC,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAEhD,MAAM,aAAa,GAA2B,EAAE,CAAC;QACjD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACpB,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;gBACtG,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;YACxB,CAAC;QACH,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc;YAAE,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3F,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAElE,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC;QACzC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;QAC1B,OAAO;YACL,OAAO,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,CAAC,eAAe,EAAE,aAAa,EAAE;YACjG,OAAO;SACR,CAAC;IACJ,CAAC;IAED,uGAAuG;IACvG,iBAAiB;QACf,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAAE,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC;IACpE,CAAC;IAED,uEAAuE;IACvE,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CACF"}

package/dist/logging.d.ts

@@ -0,0 +1,15 @@
+export interface Logger {
+    /** Protocol-level tracing (enabled by `verbose`). */
+    debug(...args: unknown[]): void;
+    /** Connection diagnostics (enabled by `reportDebugInfoToConsole` or `verbose`). */
+    info(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    error(...args: unknown[]): void;
+    /** Server-side `logLines` forwarded from a function execution. */
+    logLines(kind: string, udfPath: string, lines: string[] | undefined): void;
+}
+export declare function createLogger(options: {
+    verbose: boolean;
+    reportDebugInfoToConsole: boolean;
+}): Logger;
+//# sourceMappingURL=logging.d.ts.map

package/dist/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,qDAAqD;IACrD,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChC,mFAAmF;IACnF,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC/B,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChC,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC;CAC5E;AAID,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,wBAAwB,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAYrG"}

package/dist/logging.js

@@ -0,0 +1,17 @@
+const PREFIX = "[rxferrix]";
+export function createLogger(options) {
+    const noop = () => { };
+    return {
+        debug: options.verbose ? (...args) => console.debug(PREFIX, ...args) : noop,
+        info: options.verbose || options.reportDebugInfoToConsole ? (...args) => console.info(PREFIX, ...args) : noop,
+        warn: (...args) => console.warn(PREFIX, ...args),
+        error: (...args) => console.error(PREFIX, ...args),
+        logLines: (kind, udfPath, lines) => {
+            if (!lines || lines.length === 0)
+                return;
+            for (const line of lines)
+                console.log(`${PREFIX} [${kind} ${udfPath}]`, line);
+        },
+    };
+}
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,GAAG,YAAY,CAAC;AAE5B,MAAM,UAAU,YAAY,CAAC,OAAgE;IAC3F,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;IACtB,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;QAC3E,IAAI,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;QAC7G,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;QAChD,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;QAClD,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YACjC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YACzC,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG,EAAE,IAAI,CAAC,CAAC;QAChF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/optimistic_updates.d.ts

@@ -0,0 +1,48 @@
+import type { ArgsOf, FunctionReference, OutputOf } from "./api.js";
+import { type QueryToken } from "./canonical.js";
+import type { Logger } from "./logging.js";
+import type { RequestId } from "./protocol.js";
+import { type QueryState } from "./query_state.js";
+/**
+ * A view of the client's query results that optimistic updates can read and write.
+ */
+export interface OptimisticLocalStore {
+    /** The current value of a query, or undefined if it is loading, failed, or not subscribed. */
+    getQuery<Q extends FunctionReference<"query">>(ref: Q, args?: ArgsOf<Q>): OutputOf<Q> | undefined;
+    /** Overrides a query's value; `undefined` makes it look like it is loading. */
+    setQuery<Q extends FunctionReference<"query">>(ref: Q, args: ArgsOf<Q>, value: OutputOf<Q> | undefined): void;
+    /** Every query of this function the client knows about, with its args and current value. */
+    getAllQueries<Q extends FunctionReference<"query">>(ref: Q): {
+        args: ArgsOf<Q>;
+        value: OutputOf<Q> | undefined;
+    }[];
+}
+/** A function that optimistically applies a mutation's effect to the local store. */
+export type OptimisticUpdate<Args> = (localStore: OptimisticLocalStore, args: Args) => void;
+export interface ViewEntry {
+    readonly udfPath: string;
+    readonly args: Record<string, unknown>;
+    readonly state: QueryState;
+}
+export type ViewMap = Map<QueryToken, ViewEntry>;
+/**
+ * Server query results with a stack of optimistic updates layered on top.
+ *
+ * Whenever the server state changes, the view is rebuilt from the server results and every pending update is
+ * replayed in the order the mutations were issued. An update is dropped when its mutation completes (its ts was
+ * observed) or fails. The view keeps the previous state object for a query when its visible value did not change, so
+ * watchers are only notified (and snapshots only change) on real changes.
+ */
+export declare class OptimisticQueryResults {
+    private readonly logger;
+    private view;
+    private updates;
+    constructor(logger: Logger);
+    get(token: QueryToken): QueryState;
+    addUpdate(requestId: RequestId, apply: (store: OptimisticLocalStore) => void): void;
+    dropUpdates(requestIds: Iterable<RequestId>): boolean;
+    hasUpdates(): boolean;
+    /** Rebuilds the view from `server` plus all optimistic updates; returns the tokens whose visible state changed. */
+    recompute(server: ViewMap): QueryToken[];
+}
+//# sourceMappingURL=optimistic_updates.d.ts.map

package/dist/optimistic_updates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optimistic_updates.d.ts","sourceRoot":"","sources":["../src/optimistic_updates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,EAAwC,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAW,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8FAA8F;IAC9F,QAAQ,CAAC,CAAC,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAClG,+EAA+E;IAC/E,QAAQ,CAAC,CAAC,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;IAC9G,4FAA4F;IAC5F,aAAa,CAAC,CAAC,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAA;KAAE,EAAE,CAAC;CACpH;AAED,qFAAqF;AACrF,MAAM,MAAM,gBAAgB,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,oBAAoB,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;AAE5F,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B;AAED,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAgCjD;;;;;;;GAOG;AACH,qBAAa,sBAAsB;IAIrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHnC,OAAO,CAAC,IAAI,CAAsB;IAClC,OAAO,CAAC,OAAO,CAAgF;gBAElE,MAAM,EAAE,MAAM;IAE3C,GAAG,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU;IAIlC,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,GAAG,IAAI;IAInF,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAQrD,UAAU,IAAI,OAAO;IAIrB,mHAAmH;IACnH,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,EAAE;CAwBzC"}

package/dist/optimistic_updates.js

@@ -0,0 +1,113 @@
+import { jsonEqual, normalizeArgs, queryToken } from "./canonical.js";
+import { LOADING } from "./query_state.js";
+class LocalStoreImpl {
+    view;
+    constructor(view) {
+        this.view = view;
+    }
+    getQuery(ref, args) {
+        const entry = this.view.get(queryToken(ref._path, normalizeArgs(args)));
+        return entry?.state.status === "success" ? entry.state.value : undefined;
+    }
+    setQuery(ref, args, value) {
+        const normalized = normalizeArgs(args);
+        this.view.set(queryToken(ref._path, normalized), {
+            udfPath: ref._path,
+            args: normalized,
+            state: value === undefined ? LOADING : { status: "success", value },
+        });
+    }
+    getAllQueries(ref) {
+        const out = [];
+        for (const entry of this.view.values()) {
+            if (entry.udfPath !== ref._path)
+                continue;
+            out.push({
+                args: entry.args,
+                value: entry.state.status === "success" ? entry.state.value : undefined,
+            });
+        }
+        return out;
+    }
+}
+/**
+ * Server query results with a stack of optimistic updates layered on top.
+ *
+ * Whenever the server state changes, the view is rebuilt from the server results and every pending update is
+ * replayed in the order the mutations were issued. An update is dropped when its mutation completes (its ts was
+ * observed) or fails. The view keeps the previous state object for a query when its visible value did not change, so
+ * watchers are only notified (and snapshots only change) on real changes.
+ */
+export class OptimisticQueryResults {
+    logger;
+    view = new Map();
+    updates = [];
+    constructor(logger) {
+        this.logger = logger;
+    }
+    get(token) {
+        return this.view.get(token)?.state ?? LOADING;
+    }
+    addUpdate(requestId, apply) {
+        this.updates.push({ requestId, apply });
+    }
+    dropUpdates(requestIds) {
+        const drop = new Set(requestIds);
+        if (drop.size === 0)
+            return false;
+        const before = this.updates.length;
+        this.updates = this.updates.filter((u) => !drop.has(u.requestId));
+        return this.updates.length !== before;
+    }
+    hasUpdates() {
+        return this.updates.length > 0;
+    }
+    /** Rebuilds the view from `server` plus all optimistic updates; returns the tokens whose visible state changed. */
+    recompute(server) {
+        const next = new Map(server);
+        const store = new LocalStoreImpl(next);
+        for (const update of this.updates) {
+            try {
+                update.apply(store);
+            }
+            catch (e) {
+                this.logger.error("optimistic update threw; ignoring it", e);
+            }
+        }
+        const changed = [];
+        for (const [token, entry] of next) {
+            const previous = this.view.get(token)?.state ?? LOADING;
+            const stable = stableState(previous, entry.state);
+            if (stable !== entry.state)
+                next.set(token, { ...entry, state: stable });
+            if (stable !== previous)
+                changed.push(token);
+        }
+        for (const [token, entry] of this.view) {
+            if (!next.has(token) && entry.state !== LOADING)
+                changed.push(token);
+        }
+        this.view = next;
+        return changed;
+    }
+}
+/** Returns `previous` if `next` shows the same thing, otherwise `next`. */
+function stableState(previous, next) {
+    if (previous === next)
+        return previous;
+    if (previous.status !== next.status)
+        return next;
+    switch (next.status) {
+        case "loading":
+            return previous;
+        case "success":
+            return jsonEqual(previous.value, next.value) ? previous : next;
+        case "error": {
+            const p = previous.error;
+            return p.message === next.error.message && p.code === next.error.code && jsonEqual(p.data, next.error.data)
+                ? previous
+                : next;
+        }
+    }
+}
+//# sourceMappingURL=optimistic_updates.js.map