@rocicorp/zero 0.25.0 → 0.26.0-canary.0

package/out/zero-client/src/client/options.d.ts

@@ -1,14 +1,15 @@
 import type { LogLevel } from '@rocicorp/logger';
 import type { StoreProvider } from '../../../replicache/src/kv/store.ts';
 import * as v from '../../../shared/src/valita.ts';
-import type { Schema } from '../../../zero-schema/src/builder/schema-builder.ts';
+import type { DefaultContext, DefaultSchema } from '../../../zero-types/src/default-types.ts';
+import type { Schema } from '../../../zero-types/src/schema.ts';
+import type { AnyMutatorRegistry } from '../../../zql/src/mutate/mutator-registry.ts';
 import type { CustomMutatorDefs } from './custom.ts';
-import type { OnError } from './on-error.ts';
 import { UpdateNeededReasonType } from './update-needed-reason-type.ts';
 /**
  * Configuration for {@linkcode Zero}.
  */
-export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | undefined = undefined> {
+export interface ZeroOptions<S extends Schema = DefaultSchema, MD extends CustomMutatorDefs | undefined = undefined, C = DefaultContext> {
     /**
      * URL to the zero-cache. This can be a simple hostname, e.g.
      * - "https://myapp-myteam.zero.ms"
@@ -20,6 +21,10 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      * the zero-cache is hosted on the same domain as the application. **Note that
      * only a single path segment is allowed (e.g. it cannot be "/proxy/zero/\*")**.
      */
+    cacheURL?: string | null | undefined;
+    /**
+     * @deprecated Use {@linkcode cacheURL} instead.
+     */
     server?: string | null | undefined;
     /**
      * A token to identify and authenticate the user.
@@ -74,8 +79,41 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      * implementations. Client side mutators must be idempotent as a
      * mutation can be rebased multiple times when folding in authoritative
      * changes from the server to the client.
+     *
+     * Define mutators using the `defineMutator` function to create type-safe,
+     * parameterized mutations. Mutators can be top-level or grouped in namespaces.
+     *
+     * @example
+     * ```ts
+     * import {defineMutator} from '@rocicorp/zero';
+     *
+     * const z = new Zero({
+     *   schema,
+     *   userID,
+     *   mutators: {
+     *     // Top-level mutator
+     *     increment: defineMutator(({tx, args}: {tx: Transaction<Schema>, args: {id: string}}) =>
+     *       tx.mutate.counter.update({id: args.id, value: tx.query.counter.where('id', '=', args.id).value + 1})
+     *     ),
+     *     // Namespace with multiple mutators
+     *     issues: {
+     *       create: defineMutator(({tx, args}: {tx: Transaction<Schema>, args: {title: string}}) =>
+     *         tx.mutate.issues.insert({id: nanoid(), title: args.title, status: 'open'})
+     *       ),
+     *       close: defineMutator(({tx, args}: {tx: Transaction<Schema>, args: {id: string}}) =>
+     *         tx.mutate.issues.update({id: args.id, status: 'closed'})
+     *       ),
+     *     },
+     *   },
+     * });
+     *
+     * // Usage
+     * await z.mutate.increment({id: 'counter-1'}).client;
+     * await z.mutate.issues.create({title: 'New issue'}).client;
+     * await z.mutate.issues.close({id: 'issue-123'}).client;
+     * ```
      */
-    mutators?: MD | undefined;
+    mutators?: MD extends CustomMutatorDefs ? MD : AnyMutatorRegistry | undefined;
     /**
      * Custom URL for mutation requests sent to your API server.
      * If not provided, uses the default configured in zero-cache.
@@ -84,8 +122,15 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
     /**
      * Custom URL for query requests sent to your API server.
      * If not provided, uses the default configured in zero-cache.
+     *
+     * @deprecated Use {@linkcode queryURL} instead.
      */
     getQueriesURL?: string | undefined;
+    /**
+     * Custom URL for query requests sent to your API server.
+     * If not provided, uses the default configured in zero-cache.
+     */
+    queryURL?: string | undefined;
     /**
      * `onOnlineChange` is called when the Zero instance's online status changes.
      *
@@ -97,7 +142,7 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      * });
      * ```
      *
-     * Or use a hook like {@linkcode useZeroConnectionState} to subscribe to state changes.
+     * Or use a hook like {@linkcode useConnectionState} to subscribe to state changes.
      */
     onOnlineChange?: ((online: boolean) => void) | undefined;
     /**
@@ -136,11 +181,22 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      */
     hiddenTabDisconnectDelay?: number | undefined;
     /**
-     * This gets called when the Zero instance encounters an error. The default
-     * behavior is to log the error to the console. Provide your own function to
-     * prevent the default behavior.
+     * The number of milliseconds to wait before disconnecting a Zero
+     * instance when the connection to the server has timed out.
+     *
+     * Default is 5 minutes.
      */
-    onError?: OnError | undefined;
+    disconnectTimeoutMs?: number | undefined;
+    /**
+     * The timeout in milliseconds for ping operations. This value is used for:
+     * - How long to wait in idle before sending a ping to the server
+     * - How long to wait for a pong response after sending a ping
+     *
+     * Total time to detect a dead connection is 2 × pingTimeoutMs.
+     *
+     * Default is 5_000.
+     */
+    pingTimeoutMs?: number | undefined;
     /**
      * Determines what kind of storage implementation to use on the client.
      *
@@ -215,11 +271,15 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      * Defaults is 10.
      */
     queryChangeThrottleMs?: number | undefined;
+    /**
+     * Context is passed to Synced Queries when they are executed
+     */
+    context?: C | undefined;
 }
 /**
  * @deprecated Use {@link ZeroOptions} instead.
  */
-export interface ZeroAdvancedOptions<S extends Schema, MD extends CustomMutatorDefs | undefined = undefined> extends ZeroOptions<S, MD> {
+export interface ZeroAdvancedOptions<S extends Schema, MD extends CustomMutatorDefs | undefined, Context> extends ZeroOptions<S, MD, Context> {
 }
 type UpdateNeededReasonBase = {
     message?: string;

package/out/zero-client/src/client/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,CAAC,MAAM,+BAA+B,CAAC;AACnD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,oDAAoD,CAAC;AAC/E,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS;IAEpD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEjC;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;IAEV;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEpE;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,CACpD,SAAQ,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC;CAAG;AAE/B,KAAK,sBAAsB,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAC,cAAc,CAAA;CAAC,GAAG,sBAAsB,CAAC,GACxE,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,mBAAmB,CAAC;CAClD,GAAG,sBAAsB,CAAC,GAC3B,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,yBAAyB,CAAC;CACxD,GAAG,sBAAsB,CAAC,CAAC;AAEhC,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAKzE,CAAC"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,CAAC,MAAM,+BAA+B,CAAC;AACnD,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACd,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,6CAA6C,CAAC;AACpF,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AACnD,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,CAAC,SAAS,MAAM,GAAG,aAAa,EAChC,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,EACpD,CAAC,GAAG,cAAc;IAElB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEjC;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;IAEV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,QAAQ,CAAC,EAAE,EAAE,SAAS,iBAAiB,GAAG,EAAE,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAE9E;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEpE;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;OAEG;IAEH,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,EACxC,OAAO,CACP,SAAQ,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC;CAAG;AAExC,KAAK,sBAAsB,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAC,cAAc,CAAA;CAAC,GAAG,sBAAsB,CAAC,GACxE,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,mBAAmB,CAAC;CAClD,GAAG,sBAAsB,CAAC,GAC3B,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,yBAAyB,CAAC;CACxD,GAAG,sBAAsB,CAAC,CAAC;AAEhC,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAKzE,CAAC"}

package/out/zero-client/src/client/options.js

@@ -0,0 +1,11 @@
+import { literalUnion } from "../../../shared/src/valita.js";
+import { SchemaVersionNotSupported, VersionNotSupported, NewClientGroup } from "./update-needed-reason-type-enum.js";
+const updateNeededReasonTypeSchema = literalUnion(
+  NewClientGroup,
+  VersionNotSupported,
+  SchemaVersionNotSupported
+);
+export {
+  updateNeededReasonTypeSchema
+};
+//# sourceMappingURL=options.js.map

package/out/zero-client/src/client/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sources":["../../../../../zero-client/src/client/options.ts"],"sourcesContent":["import type {LogLevel} from '@rocicorp/logger';\nimport type {StoreProvider} from '../../../replicache/src/kv/store.ts';\nimport * as v from '../../../shared/src/valita.ts';\nimport type {\n  DefaultContext,\n  DefaultSchema,\n} from '../../../zero-types/src/default-types.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport type {AnyMutatorRegistry} from '../../../zql/src/mutate/mutator-registry.ts';\nimport type {CustomMutatorDefs} from './custom.ts';\nimport {UpdateNeededReasonType} from './update-needed-reason-type.ts';\n\n/**\n * Configuration for {@linkcode Zero}.\n */\nexport interface ZeroOptions<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  C = DefaultContext,\n> {\n  /**\n   * URL to the zero-cache. This can be a simple hostname, e.g.\n   * - \"https://myapp-myteam.zero.ms\"\n   * or a prefix with a single path component, e.g.\n   * - \"https://myapp-myteam.zero.ms/zero\"\n   * - \"https://myapp-myteam.zero.ms/db\"\n   *\n   * The latter is useful for configuring routing rules (e.g. \"/zero/\\*\") when\n   * the zero-cache is hosted on the same domain as the application. **Note that\n   * only a single path segment is allowed (e.g. it cannot be \"/proxy/zero/\\*\")**.\n   */\n  cacheURL?: string | null | undefined;\n\n  /**\n   * @deprecated Use {@linkcode cacheURL} instead.\n   */\n  server?: string | null | undefined;\n\n  /**\n   * A token to identify and authenticate the user.\n   *\n   * Set `auth` to `null` or `undefined` if there is no logged in user.\n   *\n   * When a 401 or 403 HTTP status code is received from your server, Zero will\n   * transition to the `needs-auth` connection state. The app should call\n   * `zero.connection.connect({auth: newToken})` with a new token to reconnect.\n   *\n   * The call to `connect` is handled automatically by the ZeroProvider component\n   * for React and SolidJS when the `auth` prop changes.\n   */\n  auth?: string | null | undefined;\n\n  /**\n   * A unique identifier for the user. Must be non-empty.\n   *\n   * Each userID gets its own client-side storage so that the app can switch\n   * between users without losing state.\n   *\n   * This must match the `sub` claim of the `auth` token if\n   * `auth` is provided.\n   */\n  userID: string;\n\n  /**\n   * Distinguishes the storage used by this Zero instance from that of other\n   * instances with the same userID. Useful in the case where the app wants to\n   * have multiple Zero instances for the same user for different parts of the\n   * app.\n   */\n  storageKey?: string | undefined;\n\n  /**\n   * Determines the level of detail at which Zero logs messages about\n   * its operation. Messages are logged to the `console`.\n   *\n   * When this is set to `'debug'`, `'info'` and `'error'` messages are also\n   * logged. When set to `'info'`, `'info'` and `'error'` but not\n   * `'debug'` messages are logged. When set to `'error'` only `'error'`\n   * messages are logged.\n   *\n   * Default is `'error'`.\n   */\n  logLevel?: LogLevel | undefined;\n\n  /**\n   * This defines the schema of the tables used in Zero and their relationships\n   * to one another.\n   */\n  schema: S;\n\n  /**\n   * `mutators` is a map of custom mutator definitions. The keys are\n   * namespaces or names of the mutators. The values are the mutator\n   * implementations. Client side mutators must be idempotent as a\n   * mutation can be rebased multiple times when folding in authoritative\n   * changes from the server to the client.\n   *\n   * Define mutators using the `defineMutator` function to create type-safe,\n   * parameterized mutations. Mutators can be top-level or grouped in namespaces.\n   *\n   * @example\n   * ```ts\n   * import {defineMutator} from '@rocicorp/zero';\n   *\n   * const z = new Zero({\n   *   schema,\n   *   userID,\n   *   mutators: {\n   *     // Top-level mutator\n   *     increment: defineMutator(({tx, args}: {tx: Transaction<Schema>, args: {id: string}}) =>\n   *       tx.mutate.counter.update({id: args.id, value: tx.query.counter.where('id', '=', args.id).value + 1})\n   *     ),\n   *     // Namespace with multiple mutators\n   *     issues: {\n   *       create: defineMutator(({tx, args}: {tx: Transaction<Schema>, args: {title: string}}) =>\n   *         tx.mutate.issues.insert({id: nanoid(), title: args.title, status: 'open'})\n   *       ),\n   *       close: defineMutator(({tx, args}: {tx: Transaction<Schema>, args: {id: string}}) =>\n   *         tx.mutate.issues.update({id: args.id, status: 'closed'})\n   *       ),\n   *     },\n   *   },\n   * });\n   *\n   * // Usage\n   * await z.mutate.increment({id: 'counter-1'}).client;\n   * await z.mutate.issues.create({title: 'New issue'}).client;\n   * await z.mutate.issues.close({id: 'issue-123'}).client;\n   * ```\n   */\n  mutators?: MD extends CustomMutatorDefs ? MD : AnyMutatorRegistry | undefined;\n\n  /**\n   * Custom URL for mutation requests sent to your API server.\n   * If not provided, uses the default configured in zero-cache.\n   */\n  mutateURL?: string | undefined;\n\n  /**\n   * Custom URL for query requests sent to your API server.\n   * If not provided, uses the default configured in zero-cache.\n   *\n   * @deprecated Use {@linkcode queryURL} instead.\n   */\n  getQueriesURL?: string | undefined;\n\n  /**\n   * Custom URL for query requests sent to your API server.\n   * If not provided, uses the default configured in zero-cache.\n   */\n  queryURL?: string | undefined;\n\n  /**\n   * `onOnlineChange` is called when the Zero instance's online status changes.\n   *\n   * @deprecated Use {@linkcode Connection.state.subscribe} on the Zero instance instead. e.g.\n   * ```ts\n   * const zero = new Zero({...});\n   * zero.connection.state.subscribe((state) => {\n   *   console.log('Connection state:', state.name);\n   * });\n   * ```\n   *\n   * Or use a hook like {@linkcode useConnectionState} to subscribe to state changes.\n   */\n  onOnlineChange?: ((online: boolean) => void) | undefined;\n\n  /**\n   * `onUpdateNeeded` is called when a client code update is needed.\n   *\n   * See {@link UpdateNeededReason} for why updates can be needed.\n   *\n   * The default behavior is to reload the page (using `location.reload()`).\n   * Provide your own function to prevent the page from\n   * reloading automatically. You may want to display a toast to inform the end\n   * user there is a new version of your app available and prompt them to\n   * refresh.\n   */\n  onUpdateNeeded?: ((reason: UpdateNeededReason) => void) | undefined;\n\n  /**\n   * `onClientStateNotFound` is called when this client is no longer able\n   * to sync with the zero-cache due to missing synchronization state.  This\n   * can be because:\n   * - the local persistent synchronization state has been garbage collected.\n   *   This can happen if the client has no pending mutations and has not been\n   *   used for a while (e.g. the client's tab has been hidden for a long time).\n   * - the zero-cache fails to find the server side synchronization state for\n   *   this client.\n   *\n   * The default behavior is to reload the page (using `location.reload()`).\n   * Provide your own function to prevent the page from reloading automatically.\n   */\n  onClientStateNotFound?: (() => void) | undefined;\n\n  /**\n   * The number of milliseconds to wait before disconnecting a Zero\n   * instance whose tab has become hidden.\n   *\n   * Instances in hidden tabs are disconnected to save resources.\n   *\n   * Default is 5_000.\n   */\n  hiddenTabDisconnectDelay?: number | undefined;\n\n  /**\n   * The number of milliseconds to wait before disconnecting a Zero\n   * instance when the connection to the server has timed out.\n   *\n   * Default is 5 minutes.\n   */\n  disconnectTimeoutMs?: number | undefined;\n\n  /**\n   * The timeout in milliseconds for ping operations. This value is used for:\n   * - How long to wait in idle before sending a ping to the server\n   * - How long to wait for a pong response after sending a ping\n   *\n   * Total time to detect a dead connection is 2 × pingTimeoutMs.\n   *\n   * Default is 5_000.\n   */\n  pingTimeoutMs?: number | undefined;\n\n  /**\n   * Determines what kind of storage implementation to use on the client.\n   *\n   * Defaults to `'idb'` which means that Zero uses an IndexedDB storage\n   * implementation. This allows the data to be persisted on the client and\n   * enables faster syncs between application restarts.\n   *\n   * By setting this to `'mem'`, Zero uses an in memory storage and\n   * the data is not persisted on the client.\n   *\n   * You can also set this to a function that is used to create new KV stores,\n   * allowing a custom implementation of the underlying storage layer.\n   */\n  kvStore?: 'mem' | 'idb' | StoreProvider | undefined;\n\n  /**\n   * The maximum number of bytes to allow in a single header.\n   *\n   * Zero adds some extra information to headers on initialization if possible.\n   * This speeds up data synchronization. This number should be kept less than\n   * or equal to the maximum header size allowed by the zero-cache and any load\n   * balancers.\n   *\n   * Default value: 8kb.\n   */\n  maxHeaderLength?: number | undefined;\n\n  /**\n   * The maximum amount of milliseconds to wait for a materialization to\n   * complete (including network/server time) before printing a warning to the\n   * console.\n   *\n   * Default value: 5_000.\n   */\n  slowMaterializeThreshold?: number | undefined;\n\n  /**\n   * UI rendering libraries will often provide a utility for batching multiple\n   * state updates into a single render. Some examples are React's\n   * `unstable_batchedUpdates`, and solid-js's `batch`.\n   *\n   * This option enables integrating these batch utilities with Zero.\n   *\n   * When `batchViewUpdates` is provided, Zero will call it whenever\n   * it updates query view state with an `applyViewUpdates` function\n   * that performs the actual state updates.\n   *\n   * Zero updates query view state when:\n   * 1. creating a new view\n   * 2. updating all existing queries' views to a new consistent state\n   *\n   * When creating a new view, that single view's creation will be wrapped\n   * in a `batchViewUpdates` call.\n   *\n   * When updating existing queries, all queries will be updated in a single\n   * `batchViewUpdates` call, so that the transition to the new consistent\n   * state can be done in a single render.\n   *\n   * Implementations must always call `applyViewUpdates` synchronously.\n   */\n  batchViewUpdates?: ((applyViewUpdates: () => void) => void) | undefined;\n\n  /**\n   * The maximum number of recent queries, no longer subscribed to by a preload\n   * or view, to continue syncing.\n   *\n   * Defaults is 0.\n   *\n   * @deprecated Use ttl instead\n   */\n  maxRecentQueries?: number | undefined;\n\n  /**\n   * Changes to queries are sent to server in batches. This option controls\n   * the number of milliseconds to wait before sending the next batch.\n   *\n   * Defaults is 10.\n   */\n  queryChangeThrottleMs?: number | undefined;\n\n  /**\n   * Context is passed to Synced Queries when they are executed\n   */\n  // TODO(arv): Mutators should also get context.\n  context?: C | undefined;\n}\n\n/**\n * @deprecated Use {@link ZeroOptions} instead.\n */\nexport interface ZeroAdvancedOptions<\n  S extends Schema,\n  MD extends CustomMutatorDefs | undefined,\n  Context,\n> extends ZeroOptions<S, MD, Context> {}\n\ntype UpdateNeededReasonBase = {\n  message?: string;\n};\n\nexport type UpdateNeededReason =\n  | ({type: UpdateNeededReasonType.NewClientGroup} & UpdateNeededReasonBase)\n  | ({\n      type: UpdateNeededReasonType.VersionNotSupported;\n    } & UpdateNeededReasonBase)\n  | ({\n      type: UpdateNeededReasonType.SchemaVersionNotSupported;\n    } & UpdateNeededReasonBase);\n\nexport const updateNeededReasonTypeSchema: v.Type<UpdateNeededReason['type']> =\n  v.literalUnion(\n    UpdateNeededReasonType.NewClientGroup,\n    UpdateNeededReasonType.VersionNotSupported,\n    UpdateNeededReasonType.SchemaVersionNotSupported,\n  );\n"],"names":["v.literalUnion","UpdateNeededReasonType.NewClientGroup","UpdateNeededReasonType.VersionNotSupported","UpdateNeededReasonType.SchemaVersionNotSupported"],"mappings":";;AA6UO,MAAM,+BACXA;AAAAA,EACEC;AAAAA,EACAC;AAAAA,EACAC;AACF;"}

package/out/zero-client/src/client/query-manager.d.ts

@@ -1,3 +1,4 @@
+import type { LogContext } from '@rocicorp/logger';
 import type { ReplicacheImpl } from '../../../replicache/src/replicache-impl.ts';
 import type { ClientID } from '../../../replicache/src/sync/ids.ts';
 import { TDigest } from '../../../shared/src/tdigest.ts';
@@ -10,11 +11,12 @@ import type { ClientMetricMap } from '../../../zql/src/query/metrics-delegate.ts
 import type { CustomQueryID } from '../../../zql/src/query/named.ts';
 import type { GotCallback } from '../../../zql/src/query/query-delegate.ts';
 import { type TTL } from '../../../zql/src/query/ttl.ts';
+import type { ClientErrorKind } from './client-error-kind.ts';
+import type { ClientError } from './error.ts';
 import { type ZeroError } from './error.ts';
 import type { InspectorDelegate } from './inspector/inspector.ts';
 import type { MutationTracker } from './mutation-tracker.ts';
 import type { ReadTransaction } from './replicache-types.ts';
-import type { ZeroLogContext } from './zero-log-context.ts';
 type ClientMetric = {
     [K in keyof ClientMetricMap]: TDigest;
 };
@@ -25,8 +27,9 @@ type ClientMetric = {
  */
 export declare class QueryManager implements InspectorDelegate {
     #private;
-    constructor(lc: ZeroLogContext, mutationTracker: MutationTracker, clientID: ClientID, tables: Record<string, TableSchema>, send: (change: ChangeDesiredQueriesMessage) => void, experimentalWatch: ReplicacheImpl['experimentalWatch'], recentQueriesMaxSize: number, queryChangeThrottleMs: number, slowMaterializeThreshold: number, onFatalError: (error: ZeroError) => void);
+    constructor(lc: LogContext, mutationTracker: MutationTracker, clientID: ClientID, tables: Record<string, TableSchema>, send: (change: ChangeDesiredQueriesMessage) => void, experimentalWatch: ReplicacheImpl['experimentalWatch'], recentQueriesMaxSize: number, queryChangeThrottleMs: number, slowMaterializeThreshold: number, onFatalError: (error: ZeroError) => void);
     getAST(queryID: string): AST | undefined;
+    mapClientASTToServer(ast: AST): AST;
     /**
      * Get the queries that need to be registered with the server.
      *
@@ -44,6 +47,10 @@ export declare class QueryManager implements InspectorDelegate {
      */
     getQueriesPatch(tx: ReadTransaction, lastPatch?: Map<string, UpQueriesPatchOp>): Promise<Map<string, UpQueriesPatchOp>>;
     handleTransformErrors(errors: ErroredQuery[]): void;
+    handleClosed(reason: ClientError<{
+        kind: ClientErrorKind.ClientClosed;
+        message: string;
+    }>): void;
     addCustom(ast: AST, { name, args }: CustomQueryID, ttl: TTL, gotCallback?: GotCallback): () => void;
     addLegacy(ast: AST, ttl: TTL, gotCallback?: GotCallback): () => void;
     updateCustom({ name, args }: CustomQueryID, ttl: TTL): void;

package/out/zero-client/src/client/query-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-manager.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,4CAA4C,CAAC;AAC/E,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,qCAAqC,CAAC;AAIlE,OAAO,EAAC,OAAO,EAAC,MAAM,gCAAgC,CAAC;AACvD,OAAO,EAGL,KAAK,GAAG,EACT,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,2BAA2B,EAAC,MAAM,sDAAsD,CAAC;AACtG,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8CAA8C,CAAC;AAK/E,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,6CAA6C,CAAC;AAUlF,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAuB,KAAK,GAAG,EAAC,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAC,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAEhE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAc1D,KAAK,YAAY,GAAG;KACjB,CAAC,IAAI,MAAM,eAAe,GAAG,OAAO;CACtC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,YAAa,YAAW,iBAAiB;;gBAqBlD,EAAE,EAAE,cAAc,EAClB,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,IAAI,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACnD,iBAAiB,EAAE,cAAc,CAAC,mBAAmB,CAAC,EACtD,oBAAoB,EAAE,MAAM,EAC5B,qBAAqB,EAAE,MAAM,EAC7B,wBAAwB,EAAE,MAAM,EAChC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI;IA8C1C,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAYxC;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAE,EAAE,eAAe,EACnB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,GACxC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAgDzC,qBAAqB,CAAC,MAAM,EAAE,YAAY,EAAE;IA8B5C,SAAS,CACP,GAAG,EAAE,GAAG,EACR,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAC3B,GAAG,EAAE,GAAG,EACR,WAAW,CAAC,EAAE,WAAW,GACxB,MAAM,IAAI;IAMb,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,IAAI;IAkFpE,YAAY,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG;IAMlD,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IAsC/B,UAAU;IAmCV;;OAEG;IACH,IAAI,OAAO,IAAI,YAAY,CAE1B;IAED,SAAS,CAAC,CAAC,SAAS,MAAM,eAAe,EACvC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,MAAM,EACb,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,IAAI;IA4CP,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAG3D"}
+{"version":3,"file":"query-manager.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,4CAA4C,CAAC;AAC/E,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,qCAAqC,CAAC;AAIlE,OAAO,EAAC,OAAO,EAAC,MAAM,gCAAgC,CAAC;AACvD,OAAO,EAGL,KAAK,GAAG,EACT,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,2BAA2B,EAAC,MAAM,sDAAsD,CAAC;AACtG,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8CAA8C,CAAC;AAK/E,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,6CAA6C,CAAC;AAUlF,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAuB,KAAK,GAAG,EAAC,MAAM,+BAA+B,CAAC;AAC7E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAC,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAEhE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAc3D,KAAK,YAAY,GAAG;KACjB,CAAC,IAAI,MAAM,eAAe,GAAG,OAAO;CACtC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,YAAa,YAAW,iBAAiB;;gBAsBlD,EAAE,EAAE,UAAU,EACd,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,IAAI,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACnD,iBAAiB,EAAE,cAAc,CAAC,mBAAmB,CAAC,EACtD,oBAAoB,EAAE,MAAM,EAC5B,qBAAqB,EAAE,MAAM,EAC7B,wBAAwB,EAAE,MAAM,EAChC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI;IA8C1C,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAKxC,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IAWnC;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAE,EAAE,eAAe,EACnB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,GACxC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAgDzC,qBAAqB,CAAC,MAAM,EAAE,YAAY,EAAE;IA8B5C,YAAY,CACV,MAAM,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,eAAe,CAAC,YAAY,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,CAAC;IAoB5E,SAAS,CACP,GAAG,EAAE,GAAG,EACR,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAC3B,GAAG,EAAE,GAAG,EACR,WAAW,CAAC,EAAE,WAAW,GACxB,MAAM,IAAI;IAMb,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,IAAI;IAkFpE,YAAY,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG;IAMlD,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IAsC/B,UAAU;IAmCV;;OAEG;IACH,IAAI,OAAO,IAAI,YAAY,CAE1B;IAED,SAAS,CAAC,CAAC,SAAS,MAAM,eAAe,EACvC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,MAAM,EACb,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,IAAI;IA4CP,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAG3D"}

package/out/zero-client/src/client/query-manager.js

@@ -0,0 +1,377 @@
+import { assert } from "../../../shared/src/asserts.js";
+import { must } from "../../../shared/src/must.js";
+import { TDigest } from "../../../shared/src/tdigest.js";
+import { mapAST, normalizeAST } from "../../../zero-protocol/src/ast.js";
+import { TransformFailed } from "../../../zero-protocol/src/error-kind-enum.js";
+import { ZeroCache } from "../../../zero-protocol/src/error-origin-enum.js";
+import { Internal } from "../../../zero-protocol/src/error-reason-enum.js";
+import { ProtocolError } from "../../../zero-protocol/src/error.js";
+import { hashOfNameAndArgs, hashOfAST } from "../../../zero-protocol/src/query-hash.js";
+import { clientToServer, serverToClient } from "../../../zero-schema/src/name-mapper.js";
+import { clampTTL, compareTTL } from "../../../zql/src/query/ttl.js";
+import "../../../shared/src/json-schema.js";
+import { GOT_QUERIES_KEY_PREFIX, desiredQueriesPrefixForClient } from "./keys.js";
+class QueryManager {
+  #clientID;
+  #clientToServer;
+  #serverToClient;
+  #send;
+  #onFatalError;
+  #queries = /* @__PURE__ */ new Map();
+  #recentQueriesMaxSize;
+  #recentQueries = /* @__PURE__ */ new Set();
+  #gotQueries = /* @__PURE__ */ new Set();
+  #mutationTracker;
+  #pendingQueryChanges = [];
+  #queryChangeThrottleMs;
+  #pendingRemovals = [];
+  #batchTimer;
+  #lc;
+  #metrics = newMetrics();
+  #queryMetrics = /* @__PURE__ */ new Map();
+  #slowMaterializeThreshold;
+  #closedError;
+  constructor(lc, mutationTracker, clientID, tables, send, experimentalWatch, recentQueriesMaxSize, queryChangeThrottleMs, slowMaterializeThreshold, onFatalError) {
+    this.#lc = lc.withContext("QueryManager");
+    this.#clientID = clientID;
+    this.#clientToServer = clientToServer(tables);
+    this.#serverToClient = serverToClient(tables);
+    this.#recentQueriesMaxSize = recentQueriesMaxSize;
+    this.#send = send;
+    this.#mutationTracker = mutationTracker;
+    this.#queryChangeThrottleMs = queryChangeThrottleMs;
+    this.#slowMaterializeThreshold = slowMaterializeThreshold;
+    this.#onFatalError = onFatalError;
+    this.#mutationTracker.onAllMutationsApplied(() => {
+      if (this.#pendingRemovals.length === 0) {
+        return;
+      }
+      const pendingRemovals = this.#pendingRemovals;
+      this.#pendingRemovals = [];
+      for (const removal of pendingRemovals) {
+        removal();
+      }
+    });
+    experimentalWatch(
+      (diff) => {
+        for (const diffOp of diff) {
+          const queryHash = diffOp.key.substring(GOT_QUERIES_KEY_PREFIX.length);
+          switch (diffOp.op) {
+            case "add":
+              this.#gotQueries.add(queryHash);
+              this.#fireGotCallbacks(queryHash, true);
+              break;
+            case "del":
+              this.#gotQueries.delete(queryHash);
+              this.#fireGotCallbacks(queryHash, false);
+              break;
+          }
+        }
+      },
+      {
+        prefix: GOT_QUERIES_KEY_PREFIX,
+        initialValuesInFirstDiff: true
+      }
+    );
+  }
+  getAST(queryID) {
+    const ast = this.#queries.get(queryID)?.normalized;
+    return ast && mapAST(ast, this.#serverToClient);
+  }
+  mapClientASTToServer(ast) {
+    return mapAST(ast, this.#clientToServer);
+  }
+  #fireGotCallbacks(queryHash, got) {
+    const gotCallbacks = this.#queries.get(queryHash)?.gotCallbacks ?? [];
+    for (const gotCallback of gotCallbacks) {
+      gotCallback(got);
+    }
+  }
+  /**
+   * Get the queries that need to be registered with the server.
+   *
+   * An optional `lastPatch` can be provided. This is the last patch that was
+   * sent to the server and may not yet have been acked. If `lastPatch` is provided,
+   * this method will return a patch that does not include any events sent in `lastPatch`.
+   *
+   * This diffing of last patch and current patch is needed since we send
+   * a set of queries to the server when we first connect inside of the `sec-protocol` as
+   * the `initConnectionMessage`.
+   *
+   * While we're waiting for the `connected` response to come back from the server,
+   * the client may have registered more queries. We need to diff the `initConnectionMessage`
+   * queries with the current set of queries to understand what those were.
+   */
+  async getQueriesPatch(tx, lastPatch) {
+    const existingQueryHashes = /* @__PURE__ */ new Set();
+    const prefix = desiredQueriesPrefixForClient(this.#clientID);
+    for await (const key of tx.scan({ prefix }).keys()) {
+      existingQueryHashes.add(key.substring(prefix.length, key.length));
+    }
+    const patch = /* @__PURE__ */ new Map();
+    for (const hash of existingQueryHashes) {
+      if (!this.#queries.has(hash)) {
+        patch.set(hash, { op: "del", hash });
+      }
+    }
+    for (const [hash, { normalized, ttl, name, args }] of this.#queries) {
+      if (!existingQueryHashes.has(hash)) {
+        patch.set(hash, {
+          op: "put",
+          hash,
+          ast: name === void 0 ? normalized : void 0,
+          name,
+          args,
+          // We get TTL out of the DagStore so it is possible that the TTL was written
+          // with a too high TTL.
+          ttl: clampTTL(ttl)
+          // no lc here since no need to log here
+        });
+      }
+    }
+    if (lastPatch) {
+      for (const [hash, { op }] of lastPatch) {
+        if (op === "put" && !patch.has(hash)) {
+          patch.set(hash, { op: "del", hash });
+        }
+      }
+      for (const [hash, { op }] of patch) {
+        const lastPatchOp = lastPatch.get(hash);
+        if (lastPatchOp && lastPatchOp.op === op) {
+          patch.delete(hash);
+        }
+      }
+    }
+    return patch;
+  }
+  handleTransformErrors(errors) {
+    for (const error of errors) {
+      const queryId = error.id;
+      const entry = this.#queries.get(queryId);
+      if (!entry) {
+        continue;
+      }
+      if (error.error === "app" || error.error === "parse") {
+        entry.gotCallbacks.forEach((callback) => callback(false, error));
+      } else {
+        this.#onFatalError(
+          new ProtocolError({
+            kind: TransformFailed,
+            origin: ZeroCache,
+            reason: Internal,
+            message: `Unknown error transforming queries: ${JSON.stringify(error)}`,
+            queryIDs: []
+          })
+        );
+      }
+    }
+  }
+  handleClosed(reason) {
+    if (this.#closedError) {
+      return;
+    }
+    this.#closedError = reason;
+    for (const [queryId, entry] of this.#queries) {
+      const erroredQuery = {
+        error: "app",
+        id: queryId,
+        name: entry.name ?? "legacy",
+        message: reason.message,
+        details: { kind: reason.kind }
+      };
+      for (const gotCallback of entry.gotCallbacks) {
+        gotCallback(false, erroredQuery);
+      }
+    }
+  }
+  addCustom(ast, { name, args }, ttl, gotCallback) {
+    const normalized = normalizeAST(ast);
+    const queryId = hashOfNameAndArgs(name, args);
+    return this.#add(queryId, normalized, name, args, ttl, gotCallback);
+  }
+  addLegacy(ast, ttl, gotCallback) {
+    const normalized = normalizeAST(ast);
+    const astHash = hashOfAST(normalized);
+    return this.#add(
+      astHash,
+      normalized,
+      void 0,
+      // name is undefined for legacy queries
+      void 0,
+      // args are undefined for legacy queries
+      ttl,
+      gotCallback
+    );
+  }
+  #add(queryId, normalized, name, args, ttl, gotCallback) {
+    assert(
+      name === void 0 === (args === void 0),
+      "If name is defined, args must be defined"
+    );
+    ttl = clampTTL(ttl, this.#lc);
+    let entry = this.#queries.get(queryId);
+    this.#recentQueries.delete(queryId);
+    if (!entry) {
+      normalized = mapAST(normalized, this.#clientToServer);
+      entry = {
+        normalized,
+        name,
+        args,
+        count: 1,
+        gotCallbacks: gotCallback ? [gotCallback] : [],
+        ttl
+      };
+      this.#queries.set(queryId, entry);
+      this.#queueQueryChange({
+        op: "put",
+        hash: queryId,
+        ast: name === void 0 ? normalized : void 0,
+        name,
+        args,
+        ttl
+      });
+    } else {
+      ++entry.count;
+      this.#updateEntry(entry, queryId, ttl);
+      if (gotCallback) {
+        entry.gotCallbacks.push(gotCallback);
+      }
+    }
+    if (gotCallback) {
+      gotCallback(this.#gotQueries.has(queryId));
+    }
+    let removed = false;
+    const cleanupCb = () => {
+      if (removed) {
+        return;
+      }
+      removed = true;
+      if (this.#mutationTracker.size > 0) {
+        this.#pendingRemovals.push(
+          () => this.#remove(entry, queryId, gotCallback)
+        );
+        return;
+      }
+      this.#remove(entry, queryId, gotCallback);
+    };
+    return cleanupCb;
+  }
+  updateCustom({ name, args }, ttl) {
+    const queryID = hashOfNameAndArgs(name, args);
+    const entry = must(this.#queries.get(queryID));
+    this.#updateEntry(entry, queryID, ttl);
+  }
+  updateLegacy(ast, ttl) {
+    const normalized = normalizeAST(ast);
+    const queryID = hashOfAST(normalized);
+    const entry = must(this.#queries.get(queryID));
+    this.#updateEntry(entry, queryID, ttl);
+  }
+  #updateEntry(entry, queryID, ttl) {
+    ttl = clampTTL(ttl, this.#lc);
+    if (compareTTL(ttl, entry.ttl) > 0) {
+      entry.ttl = ttl;
+      this.#queueQueryChange({
+        op: "put",
+        hash: queryID,
+        ast: entry.name === void 0 ? entry.normalized : void 0,
+        name: entry.name,
+        args: entry.args,
+        ttl
+      });
+    }
+  }
+  #queueQueryChange(op) {
+    this.#pendingQueryChanges.push(op);
+    this.#scheduleBatch();
+  }
+  #scheduleBatch() {
+    if (this.#batchTimer === void 0) {
+      this.#batchTimer = setTimeout(
+        () => this.flushBatch(),
+        this.#queryChangeThrottleMs
+      );
+    }
+  }
+  flushBatch() {
+    if (this.#batchTimer !== void 0) {
+      clearTimeout(this.#batchTimer);
+      this.#batchTimer = void 0;
+    }
+    if (this.#pendingQueryChanges.length > 0) {
+      this.#send([
+        "changeDesiredQueries",
+        {
+          desiredQueriesPatch: [...this.#pendingQueryChanges]
+        }
+      ]);
+      this.#pendingQueryChanges.length = 0;
+    }
+  }
+  #remove(entry, astHash, gotCallback) {
+    if (gotCallback) {
+      const index = entry.gotCallbacks.indexOf(gotCallback);
+      entry.gotCallbacks.splice(index, 1);
+    }
+    --entry.count;
+    if (entry.count === 0) {
+      this.#recentQueries.add(astHash);
+      if (this.#recentQueries.size > this.#recentQueriesMaxSize) {
+        const lruQueryID = this.#recentQueries.values().next().value;
+        assert(lruQueryID);
+        this.#queries.delete(lruQueryID);
+        this.#recentQueries.delete(lruQueryID);
+        this.#queryMetrics.delete(lruQueryID);
+        this.#queueQueryChange({ op: "del", hash: lruQueryID });
+      }
+    }
+  }
+  /**
+   * Gets the aggregated metrics for all queries managed by this QueryManager.
+   */
+  get metrics() {
+    return this.#metrics;
+  }
+  addMetric(metric, value, ...args) {
+    this.#metrics[metric].add(value);
+    const queryID = args[0];
+    if (metric === "query-materialization-end-to-end") {
+      const ast = args[1];
+      if (this.#slowMaterializeThreshold !== void 0 && value > this.#slowMaterializeThreshold) {
+        this.#lc.warn?.(
+          "Slow query materialization (including server/network)",
+          queryID,
+          ast,
+          value
+        );
+      } else {
+        this.#lc.debug?.(
+          "Materialized query (including server/network)",
+          queryID,
+          ast,
+          value
+        );
+      }
+    }
+    let existing = this.#queryMetrics.get(queryID);
+    if (!existing) {
+      existing = newMetrics();
+      this.#queryMetrics.set(queryID, existing);
+    }
+    existing[metric].add(value);
+  }
+  getQueryMetrics(queryID) {
+    return this.#queryMetrics.get(queryID);
+  }
+}
+function newMetrics() {
+  return {
+    "query-materialization-client": new TDigest(),
+    "query-materialization-end-to-end": new TDigest(),
+    "query-update-client": new TDigest()
+  };
+}
+export {
+  QueryManager
+};
+//# sourceMappingURL=query-manager.js.map