@rocicorp/zero 1.11.0-canary.0 → 1.11.0-canary.10

package/out/zero-client/src/client/connection-status-enum.d.ts

@@ -1,9 +1,11 @@
+export declare const Initializing = "initializing";
 export declare const Disconnected = "disconnected";
 export declare const Connecting = "connecting";
 export declare const Connected = "connected";
 export declare const NeedsAuth = "needs-auth";
 export declare const Error = "error";
 export declare const Closed = "closed";
+export type Initializing = typeof Initializing;
 export type Disconnected = typeof Disconnected;
 export type Connecting = typeof Connecting;
 export type Connected = typeof Connected;

package/out/zero-client/src/client/connection-status-enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connection-status-enum.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/connection-status-enum.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAC3C,eAAO,MAAM,UAAU,eAAe,CAAC;AACvC,eAAO,MAAM,SAAS,cAAc,CAAC;AACrC,eAAO,MAAM,SAAS,eAAe,CAAC;AACtC,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,MAAM,WAAW,CAAC;AAE/B,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC;AAC3C,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACzC,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACzC,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC;AACjC,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}
+{"version":3,"file":"connection-status-enum.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/connection-status-enum.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAC3C,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAC3C,eAAO,MAAM,UAAU,eAAe,CAAC;AACvC,eAAO,MAAM,SAAS,cAAc,CAAC;AACrC,eAAO,MAAM,SAAS,eAAe,CAAC;AACtC,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,MAAM,WAAW,CAAC;AAE/B,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAC/C,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC;AAC3C,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACzC,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACzC,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC;AACjC,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}

package/out/zero-client/src/client/connection-status-enum.js

@@ -6,8 +6,10 @@ var connection_status_enum_exports = /* @__PURE__ */ __exportAll({
 	Connecting: () => Connecting,
 	Disconnected: () => Disconnected,
 	Error: () => Error,
+	Initializing: () => Initializing,
 	NeedsAuth: () => NeedsAuth
 });
+var Initializing = "initializing";
 var Disconnected = "disconnected";
 var Connecting = "connecting";
 var Connected = "connected";
@@ -15,6 +17,6 @@ var NeedsAuth = "needs-auth";
 var Error = "error";
 var Closed = "closed";
 //#endregion
-export { Closed, Connected, Connecting, Disconnected, Error, NeedsAuth, connection_status_enum_exports };
+export { Closed, Connected, Connecting, Disconnected, Error, Initializing, NeedsAuth, connection_status_enum_exports };
 
 //# sourceMappingURL=connection-status-enum.js.map

package/out/zero-client/src/client/connection-status-enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"connection-status-enum.js","names":[],"sources":["../../../../../zero-client/src/client/connection-status-enum.ts"],"sourcesContent":["export const Disconnected = 'disconnected';\nexport const Connecting = 'connecting';\nexport const Connected = 'connected';\nexport const NeedsAuth = 'needs-auth';\nexport const Error = 'error';\nexport const Closed = 'closed';\n\nexport type Disconnected = typeof Disconnected;\nexport type Connecting = typeof Connecting;\nexport type Connected = typeof Connected;\nexport type NeedsAuth = typeof NeedsAuth;\nexport type Error = typeof Error;\nexport type Closed = typeof Closed;\n"],"mappings":";;;;;;;;;;AAAA,IAAa,eAAe;AAC5B,IAAa,aAAa;AAC1B,IAAa,YAAY;AACzB,IAAa,YAAY;AACzB,IAAa,QAAQ;AACrB,IAAa,SAAS"}
+{"version":3,"file":"connection-status-enum.js","names":[],"sources":["../../../../../zero-client/src/client/connection-status-enum.ts"],"sourcesContent":["export const Initializing = 'initializing';\nexport const Disconnected = 'disconnected';\nexport const Connecting = 'connecting';\nexport const Connected = 'connected';\nexport const NeedsAuth = 'needs-auth';\nexport const Error = 'error';\nexport const Closed = 'closed';\n\nexport type Initializing = typeof Initializing;\nexport type Disconnected = typeof Disconnected;\nexport type Connecting = typeof Connecting;\nexport type Connected = typeof Connected;\nexport type NeedsAuth = typeof NeedsAuth;\nexport type Error = typeof Error;\nexport type Closed = typeof Closed;\n"],"mappings":";;;;;;;;;;;AAAA,IAAa,eAAe;AAC5B,IAAa,eAAe;AAC5B,IAAa,aAAa;AAC1B,IAAa,YAAY;AACzB,IAAa,YAAY;AACzB,IAAa,QAAQ;AACrB,IAAa,SAAS"}

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

@@ -4,6 +4,10 @@ import type { ConnectionManager } from './connection-manager.ts';
 /**
  * The current connection state of the Zero instance. One of the following states:
  *
+ * - `initializing`: The client is loading its local store. Nothing has been
+ *   sent to the server yet, so time spent here depends on the device and the
+ *   amount of local data, not on the network. Entered once, when the Zero
+ *   instance is created, and followed by `connecting`.
  * - `connecting`: The client is actively trying to connect every 5 seconds.
  * - `disconnected`: The client is now in an "offline" state. It will continue
  *   to try to connect every 5 seconds.
@@ -16,6 +20,8 @@ import type { ConnectionManager } from './connection-manager.ts';
  *   a terminal state, and a new Zero instance must be created to reconnect.
  */
 export type ConnectionState = {
+    name: 'initializing';
+} | {
     name: 'disconnected';
     reason: string;
 } | {

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

@@ -1 +1 @@
-{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/connection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAC,YAAY,EAAC,MAAM,qCAAqC,CAAC;AAGjE,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,yBAAyB,CAAC;AAGjC;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EACF;QACE,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GACD;QACE,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GACD;QACE,IAAI,EAAE,YAAY,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACP,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IAEpB;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAExC;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED,qBAAa,cAAe,YAAW,UAAU;;IAM/C,YACE,iBAAiB,EAAE,iBAAiB,EACpC,EAAE,EAAE,UAAU,EACd,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAMhC;IAED,IAAI,KAAK,IAAI,MAAM,CAAC,eAAe,CAAC,CAEnC;IAEK,OAAO,CAAC,IAAI,CAAC,EAAE;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAuClD;CACF;AAED,qBAAa,gBACX,SAAQ,YAAY,CAAC,eAAe,CACpC,YAAW,MAAM,CAAC,eAAe,CAAC;;IAIlC,YAAY,iBAAiB,EAAE,iBAAiB,EAY/C;IAED,IAAI,OAAO,IAAI,eAAe,CAE7B;CA0DF"}
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/connection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAC,YAAY,EAAC,MAAM,qCAAqC,CAAC;AAGjE,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,yBAAyB,CAAC;AAGjC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,cAAc,CAAC;CACtB,GACD;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EACF;QACE,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GACD;QACE,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GACD;QACE,IAAI,EAAE,YAAY,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACP,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IAEpB;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAExC;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED,qBAAa,cAAe,YAAW,UAAU;;IAM/C,YACE,iBAAiB,EAAE,iBAAiB,EACpC,EAAE,EAAE,UAAU,EACd,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAMhC;IAED,IAAI,KAAK,IAAI,MAAM,CAAC,eAAe,CAAC,CAEnC;IAEK,OAAO,CAAC,IAAI,CAAC,EAAE;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAuClD;CACF;AAED,qBAAa,gBACX,SAAQ,YAAY,CAAC,eAAe,CACpC,YAAW,MAAM,CAAC,eAAe,CAAC;;IAIlC,YAAY,iBAAiB,EAAE,iBAAiB,EAY/C;IAED,IAAI,OAAO,IAAI,eAAe,CAE7B;CA8DF"}

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

@@ -1,6 +1,6 @@
 import { unreachable } from "../../../shared/src/asserts.js";
 import "../../../zero-protocol/src/error-kind-enum.js";
-import { Closed, Connected, Connecting, Disconnected, Error, NeedsAuth } from "./connection-status-enum.js";
+import { Closed, Connected, Connecting, Disconnected, Error, Initializing, NeedsAuth } from "./connection-status-enum.js";
 import { Subscribable } from "../../../shared/src/subscribable.js";
 import "./client-error-kind-enum.js";
 //#region ../zero-client/src/client/connection.ts
@@ -53,6 +53,7 @@ var ConnectionSource = class extends Subscribable {
 	}
 	#mapConnectionManagerState(state) {
 		switch (state.name) {
+			case Initializing: return { name: "initializing" };
 			case Closed: return {
 				name: "closed",
 				reason: state.reason.message

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

@@ -1 +1 @@
-{"version":3,"file":"connection.js","names":["#connectionManager","#lc","#source","#setAuth","#state","#mapConnectionManagerState"],"sources":["../../../../../zero-client/src/client/connection.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {unreachable} from '../../../shared/src/asserts.ts';\nimport {Subscribable} from '../../../shared/src/subscribable.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport {ClientErrorKind} from './client-error-kind.ts';\nimport type {\n  ConnectionManager,\n  ConnectionManagerState,\n} from './connection-manager.ts';\nimport {ConnectionStatus} from './connection-status.ts';\n\n/**\n * The current connection state of the Zero instance. One of the following states:\n *\n * - `connecting`: The client is actively trying to connect every 5 seconds.\n * - `disconnected`: The client is now in an \"offline\" state. It will continue\n *   to try to connect every 5 seconds.\n * - `connected`: The client has opened a successful connection to the server.\n * - `needs-auth`: Authentication is invalid or expired. No connection retries will be made\n *   until the host application calls `connect()`.\n * - `error`: A fatal error occurred. No connection retries will be made until the host\n *   application calls `connect()` again.\n * - `closed`: The client was shut down (for example via `zero.close()`). This is\n *   a terminal state, and a new Zero instance must be created to reconnect.\n */\nexport type ConnectionState =\n  | {\n      name: 'disconnected';\n      reason: string;\n    }\n  | {\n      name: 'connecting';\n      reason?: string;\n    }\n  | {\n      name: 'connected';\n    }\n  | {\n      name: 'needs-auth';\n      reason:\n        | {\n            type: 'mutate';\n            status: 401 | 403;\n            body?: string;\n          }\n        | {\n            type: 'query';\n            status: 401 | 403;\n            body?: string;\n          }\n        | {\n            type: 'zero-cache';\n            reason: string;\n          };\n    }\n  | {\n      name: 'error';\n      reason: string;\n    }\n  | {\n      name: 'closed';\n      reason: string;\n    };\n\nexport interface Source<T> {\n  /**\n   * The current state value.\n   */\n  readonly current: T;\n\n  /**\n   * Subscribe to state changes.\n   *\n   * @param listener - Called when the state changes with the new state value.\n   * @returns A function to unsubscribe from state changes.\n   */\n  subscribe(listener: (state: T) => void): () => void;\n}\n\n/**\n * Connection API for managing Zero's connection lifecycle.\n */\nexport interface Connection {\n  /**\n   * The current connection state as a subscribable value.\n   */\n  readonly state: Source<ConnectionState>;\n\n  /**\n   * Updates the auth token and, when Zero is paused in `needs-auth` or `error`,\n   * resumes connecting.\n   *\n   * Calling `connect()` without `auth` preserves the current auth token.\n   * If Zero is already `connected`, it sends an auth update to the server\n   * _without_ reconnecting. In other states, the new token is used the next time\n   * Zero connects.\n   *\n   * This method does not reconnect from `disconnected` or `closed`. To switch\n   * to logged-out, create a new Zero instance with `auth` omitted.\n   *\n   * @param opts - Optional connection options.\n   * @param opts.auth - Optional new auth token to store and use for auth refreshes or\n   *                    the next connection.\n   * @returns A promise that resolves immediately unless Zero is paused in\n   *          `needs-auth` or `error`, in which case it resolves after the next\n   *          connection state change.\n   */\n  connect(opts?: {auth: string}): Promise<void>;\n}\n\nexport class ConnectionImpl implements Connection {\n  readonly #connectionManager: ConnectionManager;\n  readonly #lc: LogContext;\n  readonly #source: ConnectionSource;\n  readonly #setAuth: (auth: string) => void;\n\n  constructor(\n    connectionManager: ConnectionManager,\n    lc: LogContext,\n    setAuth: (auth: string) => void,\n  ) {\n    this.#connectionManager = connectionManager;\n    this.#lc = lc;\n    this.#source = new ConnectionSource(connectionManager);\n    this.#setAuth = setAuth;\n  }\n\n  get state(): Source<ConnectionState> {\n    return this.#source;\n  }\n\n  async connect(opts?: {auth: string}): Promise<void> {\n    const lc = this.#lc.withContext('connect');\n\n    if (opts && 'auth' in opts) {\n      lc.debug?.('Updating auth credential from connect()');\n      this.#setAuth(opts.auth);\n    }\n\n    // if the connection is disconnected due to a missing cacheURL, we don't allow a reconnect\n    if (\n      this.#connectionManager.state.name === ConnectionStatus.Disconnected &&\n      this.#connectionManager.state.reason.kind ===\n        ClientErrorKind.NoSocketOrigin\n    ) {\n      lc.error?.(\n        'connect() called but the connection is disconnected due to a missing cacheURL. No reconnect will be attempted.',\n      );\n      return;\n    }\n\n    // only allow connect() to be called from a terminal state\n    if (!this.#connectionManager.isInTerminalState()) {\n      lc.debug?.(\n        'connect() called but not in a terminal state. Current state:',\n        this.#connectionManager.state.name,\n      );\n      return;\n    }\n\n    lc.info?.(\n      `Resuming connection from state: ${this.#connectionManager.state.name}`,\n    );\n\n    this.#connectionManager.requestConnect();\n    if (this.#connectionManager.state.name === ConnectionStatus.Connecting) {\n      return;\n    }\n\n    await this.#connectionManager.waitForStateChange();\n  }\n}\n\nexport class ConnectionSource\n  extends Subscribable<ConnectionState>\n  implements Source<ConnectionState>\n{\n  #state: ConnectionState;\n\n  constructor(connectionManager: ConnectionManager) {\n    super();\n    this.#state = this.#mapConnectionManagerState(connectionManager.state);\n\n    // Subscribe to ConnectionManager immediately to keep #state in sync.\n    // This ensures `current` always returns the correct state, even if\n    // external code hasn't subscribed yet (fixes race condition where\n    // connection completes before React subscribes).\n    connectionManager.subscribe(state => {\n      this.#state = this.#mapConnectionManagerState(state);\n      this.notify(this.#state);\n    });\n  }\n\n  get current(): ConnectionState {\n    return this.#state;\n  }\n\n  #mapConnectionManagerState(state: ConnectionManagerState): ConnectionState {\n    switch (state.name) {\n      case ConnectionStatus.Closed:\n        return {\n          name: 'closed',\n          reason: state.reason.message,\n        };\n      case ConnectionStatus.Connected:\n        return {\n          name: 'connected',\n        };\n      case ConnectionStatus.Connecting:\n        return {\n          name: 'connecting',\n          ...(state.reason?.message ? {reason: state.reason.message} : {}),\n        };\n      case ConnectionStatus.Disconnected:\n        return {\n          name: 'disconnected',\n          reason: state.reason.message,\n        };\n      case ConnectionStatus.Error:\n        return {\n          name: 'error',\n          reason: state.reason.message,\n        };\n      case ConnectionStatus.NeedsAuth:\n        return {\n          name: 'needs-auth',\n          reason:\n            state.reason.errorBody.kind === ErrorKind.PushFailed\n              ? {\n                  type: 'mutate',\n                  status: state.reason.errorBody.status,\n                  ...(state.reason.errorBody.bodyPreview\n                    ? {body: state.reason.errorBody.bodyPreview}\n                    : {}),\n                }\n              : state.reason.errorBody.kind === ErrorKind.TransformFailed\n                ? {\n                    type: 'query',\n                    status: state.reason.errorBody.status,\n                    ...(state.reason.errorBody.bodyPreview\n                      ? {body: state.reason.errorBody.bodyPreview}\n                      : {}),\n                  }\n                : {\n                    type: 'zero-cache',\n                    reason: state.reason.message,\n                  },\n        };\n\n      default:\n        unreachable(state);\n    }\n  }\n}\n"],"mappings":";;;;;;AA8GA,IAAa,iBAAb,MAAkD;CAChD;CACA;CACA;CACA;CAEA,YACE,mBACA,IACA,SACA;EACA,KAAKA,qBAAqB;EAC1B,KAAKC,MAAM;EACX,KAAKC,UAAU,IAAI,iBAAiB,iBAAiB;EACrD,KAAKC,WAAW;CAClB;CAEA,IAAI,QAAiC;EACnC,OAAO,KAAKD;CACd;CAEA,MAAM,QAAQ,MAAsC;EAClD,MAAM,KAAK,KAAKD,IAAI,YAAY,SAAS;EAEzC,IAAI,QAAQ,UAAU,MAAM;GAC1B,GAAG,QAAQ,yCAAyC;GACpD,KAAKE,SAAS,KAAK,IAAI;EACzB;EAGA,IACE,KAAKH,mBAAmB,MAAM,SAAS,kBACvC,KAAKA,mBAAmB,MAAM,OAAO,SACnC,kBACF;GACA,GAAG,QACD,gHACF;GACA;EACF;EAGA,IAAI,CAAC,KAAKA,mBAAmB,kBAAkB,GAAG;GAChD,GAAG,QACD,gEACA,KAAKA,mBAAmB,MAAM,IAChC;GACA;EACF;EAEA,GAAG,OACD,mCAAmC,KAAKA,mBAAmB,MAAM,MACnE;EAEA,KAAKA,mBAAmB,eAAe;EACvC,IAAI,KAAKA,mBAAmB,MAAM,SAAS,cACzC;EAGF,MAAM,KAAKA,mBAAmB,mBAAmB;CACnD;AACF;AAEA,IAAa,mBAAb,cACU,aAEV;CACE;CAEA,YAAY,mBAAsC;EAChD,MAAM;EACN,KAAKI,SAAS,KAAKC,2BAA2B,kBAAkB,KAAK;EAMrE,kBAAkB,WAAU,UAAS;GACnC,KAAKD,SAAS,KAAKC,2BAA2B,KAAK;GACnD,KAAK,OAAO,KAAKD,MAAM;EACzB,CAAC;CACH;CAEA,IAAI,UAA2B;EAC7B,OAAO,KAAKA;CACd;CAEA,2BAA2B,OAAgD;EACzE,QAAQ,MAAM,MAAd;GACE,KAAK,QACH,OAAO;IACL,MAAM;IACN,QAAQ,MAAM,OAAO;GACvB;GACF,KAAK,WACH,OAAO,EACL,MAAM,YACR;GACF,KAAK,YACH,OAAO;IACL,MAAM;IACN,GAAI,MAAM,QAAQ,UAAU,EAAC,QAAQ,MAAM,OAAO,QAAO,IAAI,CAAC;GAChE;GACF,KAAK,cACH,OAAO;IACL,MAAM;IACN,QAAQ,MAAM,OAAO;GACvB;GACF,KAAK,OACH,OAAO;IACL,MAAM;IACN,QAAQ,MAAM,OAAO;GACvB;GACF,KAAK,WACH,OAAO;IACL,MAAM;IACN,QACE,MAAM,OAAO,UAAU,SAAS,eAC5B;KACE,MAAM;KACN,QAAQ,MAAM,OAAO,UAAU;KAC/B,GAAI,MAAM,OAAO,UAAU,cACvB,EAAC,MAAM,MAAM,OAAO,UAAU,YAAW,IACzC,CAAC;IACP,IACA,MAAM,OAAO,UAAU,SAAS,oBAC9B;KACE,MAAM;KACN,QAAQ,MAAM,OAAO,UAAU;KAC/B,GAAI,MAAM,OAAO,UAAU,cACvB,EAAC,MAAM,MAAM,OAAO,UAAU,YAAW,IACzC,CAAC;IACP,IACA;KACE,MAAM;KACN,QAAQ,MAAM,OAAO;IACvB;GACV;GAEF,SACE,YAAY,KAAK;EACrB;CACF;AACF"}
+{"version":3,"file":"connection.js","names":["#connectionManager","#lc","#source","#setAuth","#state","#mapConnectionManagerState"],"sources":["../../../../../zero-client/src/client/connection.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {unreachable} from '../../../shared/src/asserts.ts';\nimport {Subscribable} from '../../../shared/src/subscribable.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport {ClientErrorKind} from './client-error-kind.ts';\nimport type {\n  ConnectionManager,\n  ConnectionManagerState,\n} from './connection-manager.ts';\nimport {ConnectionStatus} from './connection-status.ts';\n\n/**\n * The current connection state of the Zero instance. One of the following states:\n *\n * - `initializing`: The client is loading its local store. Nothing has been\n *   sent to the server yet, so time spent here depends on the device and the\n *   amount of local data, not on the network. Entered once, when the Zero\n *   instance is created, and followed by `connecting`.\n * - `connecting`: The client is actively trying to connect every 5 seconds.\n * - `disconnected`: The client is now in an \"offline\" state. It will continue\n *   to try to connect every 5 seconds.\n * - `connected`: The client has opened a successful connection to the server.\n * - `needs-auth`: Authentication is invalid or expired. No connection retries will be made\n *   until the host application calls `connect()`.\n * - `error`: A fatal error occurred. No connection retries will be made until the host\n *   application calls `connect()` again.\n * - `closed`: The client was shut down (for example via `zero.close()`). This is\n *   a terminal state, and a new Zero instance must be created to reconnect.\n */\nexport type ConnectionState =\n  | {\n      name: 'initializing';\n    }\n  | {\n      name: 'disconnected';\n      reason: string;\n    }\n  | {\n      name: 'connecting';\n      reason?: string;\n    }\n  | {\n      name: 'connected';\n    }\n  | {\n      name: 'needs-auth';\n      reason:\n        | {\n            type: 'mutate';\n            status: 401 | 403;\n            body?: string;\n          }\n        | {\n            type: 'query';\n            status: 401 | 403;\n            body?: string;\n          }\n        | {\n            type: 'zero-cache';\n            reason: string;\n          };\n    }\n  | {\n      name: 'error';\n      reason: string;\n    }\n  | {\n      name: 'closed';\n      reason: string;\n    };\n\nexport interface Source<T> {\n  /**\n   * The current state value.\n   */\n  readonly current: T;\n\n  /**\n   * Subscribe to state changes.\n   *\n   * @param listener - Called when the state changes with the new state value.\n   * @returns A function to unsubscribe from state changes.\n   */\n  subscribe(listener: (state: T) => void): () => void;\n}\n\n/**\n * Connection API for managing Zero's connection lifecycle.\n */\nexport interface Connection {\n  /**\n   * The current connection state as a subscribable value.\n   */\n  readonly state: Source<ConnectionState>;\n\n  /**\n   * Updates the auth token and, when Zero is paused in `needs-auth` or `error`,\n   * resumes connecting.\n   *\n   * Calling `connect()` without `auth` preserves the current auth token.\n   * If Zero is already `connected`, it sends an auth update to the server\n   * _without_ reconnecting. In other states, the new token is used the next time\n   * Zero connects.\n   *\n   * This method does not reconnect from `disconnected` or `closed`. To switch\n   * to logged-out, create a new Zero instance with `auth` omitted.\n   *\n   * @param opts - Optional connection options.\n   * @param opts.auth - Optional new auth token to store and use for auth refreshes or\n   *                    the next connection.\n   * @returns A promise that resolves immediately unless Zero is paused in\n   *          `needs-auth` or `error`, in which case it resolves after the next\n   *          connection state change.\n   */\n  connect(opts?: {auth: string}): Promise<void>;\n}\n\nexport class ConnectionImpl implements Connection {\n  readonly #connectionManager: ConnectionManager;\n  readonly #lc: LogContext;\n  readonly #source: ConnectionSource;\n  readonly #setAuth: (auth: string) => void;\n\n  constructor(\n    connectionManager: ConnectionManager,\n    lc: LogContext,\n    setAuth: (auth: string) => void,\n  ) {\n    this.#connectionManager = connectionManager;\n    this.#lc = lc;\n    this.#source = new ConnectionSource(connectionManager);\n    this.#setAuth = setAuth;\n  }\n\n  get state(): Source<ConnectionState> {\n    return this.#source;\n  }\n\n  async connect(opts?: {auth: string}): Promise<void> {\n    const lc = this.#lc.withContext('connect');\n\n    if (opts && 'auth' in opts) {\n      lc.debug?.('Updating auth credential from connect()');\n      this.#setAuth(opts.auth);\n    }\n\n    // if the connection is disconnected due to a missing cacheURL, we don't allow a reconnect\n    if (\n      this.#connectionManager.state.name === ConnectionStatus.Disconnected &&\n      this.#connectionManager.state.reason.kind ===\n        ClientErrorKind.NoSocketOrigin\n    ) {\n      lc.error?.(\n        'connect() called but the connection is disconnected due to a missing cacheURL. No reconnect will be attempted.',\n      );\n      return;\n    }\n\n    // only allow connect() to be called from a terminal state\n    if (!this.#connectionManager.isInTerminalState()) {\n      lc.debug?.(\n        'connect() called but not in a terminal state. Current state:',\n        this.#connectionManager.state.name,\n      );\n      return;\n    }\n\n    lc.info?.(\n      `Resuming connection from state: ${this.#connectionManager.state.name}`,\n    );\n\n    this.#connectionManager.requestConnect();\n    if (this.#connectionManager.state.name === ConnectionStatus.Connecting) {\n      return;\n    }\n\n    await this.#connectionManager.waitForStateChange();\n  }\n}\n\nexport class ConnectionSource\n  extends Subscribable<ConnectionState>\n  implements Source<ConnectionState>\n{\n  #state: ConnectionState;\n\n  constructor(connectionManager: ConnectionManager) {\n    super();\n    this.#state = this.#mapConnectionManagerState(connectionManager.state);\n\n    // Subscribe to ConnectionManager immediately to keep #state in sync.\n    // This ensures `current` always returns the correct state, even if\n    // external code hasn't subscribed yet (fixes race condition where\n    // connection completes before React subscribes).\n    connectionManager.subscribe(state => {\n      this.#state = this.#mapConnectionManagerState(state);\n      this.notify(this.#state);\n    });\n  }\n\n  get current(): ConnectionState {\n    return this.#state;\n  }\n\n  #mapConnectionManagerState(state: ConnectionManagerState): ConnectionState {\n    switch (state.name) {\n      case ConnectionStatus.Initializing:\n        return {\n          name: 'initializing',\n        };\n      case ConnectionStatus.Closed:\n        return {\n          name: 'closed',\n          reason: state.reason.message,\n        };\n      case ConnectionStatus.Connected:\n        return {\n          name: 'connected',\n        };\n      case ConnectionStatus.Connecting:\n        return {\n          name: 'connecting',\n          ...(state.reason?.message ? {reason: state.reason.message} : {}),\n        };\n      case ConnectionStatus.Disconnected:\n        return {\n          name: 'disconnected',\n          reason: state.reason.message,\n        };\n      case ConnectionStatus.Error:\n        return {\n          name: 'error',\n          reason: state.reason.message,\n        };\n      case ConnectionStatus.NeedsAuth:\n        return {\n          name: 'needs-auth',\n          reason:\n            state.reason.errorBody.kind === ErrorKind.PushFailed\n              ? {\n                  type: 'mutate',\n                  status: state.reason.errorBody.status,\n                  ...(state.reason.errorBody.bodyPreview\n                    ? {body: state.reason.errorBody.bodyPreview}\n                    : {}),\n                }\n              : state.reason.errorBody.kind === ErrorKind.TransformFailed\n                ? {\n                    type: 'query',\n                    status: state.reason.errorBody.status,\n                    ...(state.reason.errorBody.bodyPreview\n                      ? {body: state.reason.errorBody.bodyPreview}\n                      : {}),\n                  }\n                : {\n                    type: 'zero-cache',\n                    reason: state.reason.message,\n                  },\n        };\n\n      default:\n        unreachable(state);\n    }\n  }\n}\n"],"mappings":";;;;;;AAqHA,IAAa,iBAAb,MAAkD;CAChD;CACA;CACA;CACA;CAEA,YACE,mBACA,IACA,SACA;EACA,KAAKA,qBAAqB;EAC1B,KAAKC,MAAM;EACX,KAAKC,UAAU,IAAI,iBAAiB,iBAAiB;EACrD,KAAKC,WAAW;CAClB;CAEA,IAAI,QAAiC;EACnC,OAAO,KAAKD;CACd;CAEA,MAAM,QAAQ,MAAsC;EAClD,MAAM,KAAK,KAAKD,IAAI,YAAY,SAAS;EAEzC,IAAI,QAAQ,UAAU,MAAM;GAC1B,GAAG,QAAQ,yCAAyC;GACpD,KAAKE,SAAS,KAAK,IAAI;EACzB;EAGA,IACE,KAAKH,mBAAmB,MAAM,SAAS,kBACvC,KAAKA,mBAAmB,MAAM,OAAO,SACnC,kBACF;GACA,GAAG,QACD,gHACF;GACA;EACF;EAGA,IAAI,CAAC,KAAKA,mBAAmB,kBAAkB,GAAG;GAChD,GAAG,QACD,gEACA,KAAKA,mBAAmB,MAAM,IAChC;GACA;EACF;EAEA,GAAG,OACD,mCAAmC,KAAKA,mBAAmB,MAAM,MACnE;EAEA,KAAKA,mBAAmB,eAAe;EACvC,IAAI,KAAKA,mBAAmB,MAAM,SAAS,cACzC;EAGF,MAAM,KAAKA,mBAAmB,mBAAmB;CACnD;AACF;AAEA,IAAa,mBAAb,cACU,aAEV;CACE;CAEA,YAAY,mBAAsC;EAChD,MAAM;EACN,KAAKI,SAAS,KAAKC,2BAA2B,kBAAkB,KAAK;EAMrE,kBAAkB,WAAU,UAAS;GACnC,KAAKD,SAAS,KAAKC,2BAA2B,KAAK;GACnD,KAAK,OAAO,KAAKD,MAAM;EACzB,CAAC;CACH;CAEA,IAAI,UAA2B;EAC7B,OAAO,KAAKA;CACd;CAEA,2BAA2B,OAAgD;EACzE,QAAQ,MAAM,MAAd;GACE,KAAK,cACH,OAAO,EACL,MAAM,eACR;GACF,KAAK,QACH,OAAO;IACL,MAAM;IACN,QAAQ,MAAM,OAAO;GACvB;GACF,KAAK,WACH,OAAO,EACL,MAAM,YACR;GACF,KAAK,YACH,OAAO;IACL,MAAM;IACN,GAAI,MAAM,QAAQ,UAAU,EAAC,QAAQ,MAAM,OAAO,QAAO,IAAI,CAAC;GAChE;GACF,KAAK,cACH,OAAO;IACL,MAAM;IACN,QAAQ,MAAM,OAAO;GACvB;GACF,KAAK,OACH,OAAO;IACL,MAAM;IACN,QAAQ,MAAM,OAAO;GACvB;GACF,KAAK,WACH,OAAO;IACL,MAAM;IACN,QACE,MAAM,OAAO,UAAU,SAAS,eAC5B;KACE,MAAM;KACN,QAAQ,MAAM,OAAO,UAAU;KAC/B,GAAI,MAAM,OAAO,UAAU,cACvB,EAAC,MAAM,MAAM,OAAO,UAAU,YAAW,IACzC,CAAC;IACP,IACA,MAAM,OAAO,UAAU,SAAS,oBAC9B;KACE,MAAM;KACN,QAAQ,MAAM,OAAO,UAAU;KAC/B,GAAI,MAAM,OAAO,UAAU,cACvB,EAAC,MAAM,MAAM,OAAO,UAAU,YAAW,IACzC,CAAC;IACP,IACA;KACE,MAAM;KACN,QAAQ,MAAM,OAAO;IACvB;GACV;GAEF,SACE,YAAY,KAAK;EACrB;CACF;AACF"}

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

@@ -1,13 +1,14 @@
 import type { LogContext } from '@rocicorp/logger';
 import type { NoIndexDiff } from '../../../replicache/src/btree/node.ts';
 import type { Hash } from '../../../replicache/src/hash.ts';
+import type { DocumentVisibilityWatcher } from '../../../shared/src/document-visible.ts';
 import type { AST } from '../../../zero-protocol/src/ast.ts';
 import type { DebugDelegate } from '../../../zql/src/builder/debug-delegate.ts';
 import type { Input } from '../../../zql/src/ivm/operator.ts';
 import type { Source, SourceInput } from '../../../zql/src/ivm/source.ts';
 import type { MetricsDelegate } from '../../../zql/src/query/metrics-delegate.ts';
 import { QueryDelegateBase } from '../../../zql/src/query/query-delegate-base.ts';
-import type { CommitListener } from '../../../zql/src/query/query-delegate.ts';
+import type { AttachPipeline, CommitListener } from '../../../zql/src/query/query-delegate.ts';
 import type { RunOptions } from '../../../zql/src/query/query.ts';
 import { type IVMSourceBranch } from './ivm-branch.ts';
 import type { QueryManager } from './query-manager.ts';
@@ -35,10 +36,34 @@ export declare class ZeroContext extends QueryDelegateBase {
      */
     readonly defaultQueryComplete = false;
     readonly addMetric: MetricsDelegate['addMetric'];
-    constructor(lc: LogContext, mainSources: IVMSourceBranch, addQuery: AddQuery, addCustomQuery: AddCustomQuery, updateQuery: UpdateQuery, updateCustomQuery: UpdateCustomQuery, flushQueryChanges: () => void, batchViewUpdates: (applyViewUpdates: () => void) => void, addMetric: MetricsDelegate['addMetric'], assertValidRunOptions: (options?: RunOptions) => void);
+    constructor(lc: LogContext, mainSources: IVMSourceBranch, addQuery: AddQuery, addCustomQuery: AddCustomQuery, updateQuery: UpdateQuery, updateCustomQuery: UpdateCustomQuery, flushQueryChanges: () => void, batchViewUpdates: (applyViewUpdates: () => void) => void, addMetric: MetricsDelegate['addMetric'], assertValidRunOptions: (options?: RunOptions) => void, visibilityWatcher?: DocumentVisibilityWatcher | undefined);
     applyFiltersAnyway?: boolean | undefined;
     debug?: DebugDelegate | undefined;
     getSource(name: string): Source | undefined;
+    get pipelinesReady(): boolean;
+    onPipelinesReady(cb: AttachPipeline): () => void;
+    /**
+     * Build and hydrate every pipeline deferred since construction, in
+     * materialization order, as a single view-update batch. Views materialized
+     * before this is called are empty and `unknown` in the meantime, exactly as
+     * they would be over empty sources. A pipeline that fails to build is
+     * logged and its view reports an error; the rest are still built.
+     *
+     * Returns `this` so it can be chained onto the constructor call.
+     */
+    markPipelinesReady(): this;
+    /**
+     * Like {@link markPipelinesReady} but hydrates in time slices, yielding to
+     * the event loop in between so a burst of queries registered at startup does
+     * not monopolize the thread. It only ever yields *between* pipelines.
+     *
+     * No view is exposed until all of them are hydrated: they are released, and
+     * the commit listeners notified, in one synchronous batch at the end.
+     * Queries materialized in the meantime are still deferred and join that
+     * batch. The caller must not call {@link processChanges} until the returned
+     * promise resolves.
+     */
+    hydratePendingPipelines(sliceMs?: number, yieldToEventLoop?: () => Promise<void>): Promise<void>;
     mapAst(ast: AST): AST;
     decorateSourceInput(input: SourceInput, queryID: string): Input;
     onTransactionCommit(cb: CommitListener): () => void;

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

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,uCAAuC,CAAC;AACvE,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iCAAiC,CAAC;AAE1D,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,mCAAmC,CAAC;AAE3D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,4CAA4C,CAAC;AAC9E,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,kCAAkC,CAAC;AAC5D,OAAO,KAAK,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,gCAAgC,CAAC;AAExE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,4CAA4C,CAAC;AAChF,OAAO,EAAC,iBAAiB,EAAC,MAAM,+CAA+C,CAAC;AAChF,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAC,KAAK,eAAe,EAAC,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAErD,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AACjD,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AAEvD,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AACvD,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AAC7D,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;AAE3D;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;;IAShD,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC;IACxC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,IAAI,CAAC;IAIvC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,oBAAoB,SAAS;IAEtC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IAEjD,YACE,EAAE,EAAE,UAAU,EACd,WAAW,EAAE,eAAe,EAC5B,QAAQ,EAAE,QAAQ,EAClB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,WAAW,EACxB,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,MAAM,IAAI,EAC7B,gBAAgB,EAAE,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,EACxD,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,EACvC,qBAAqB,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,KAAK,IAAI,EAatD;IAED,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAEzC,KAAK,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAElC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE1C;IAED,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAEpB;IAEQ,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAEvE;IAED,mBAAmB,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,IAAI,CAKlD;IAEQ,gBAAgB,CAAC,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,GAWnC,CAAC,CACnB;IAED,cAAc,CACZ,YAAY,EAAE,IAAI,GAAG,SAAS,EAC9B,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,WAAW,QASrB;CAkBF"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,uCAAuC,CAAC;AACvE,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iCAAiC,CAAC;AAG1D,OAAO,KAAK,EAAC,yBAAyB,EAAC,MAAM,yCAAyC,CAAC;AACvF,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,mCAAmC,CAAC;AAE3D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,4CAA4C,CAAC;AAC9E,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,kCAAkC,CAAC;AAC5D,OAAO,KAAK,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,gCAAgC,CAAC;AAExE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,4CAA4C,CAAC;AAChF,OAAO,EAAC,iBAAiB,EAAC,MAAM,+CAA+C,CAAC;AAChF,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACf,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAC,KAAK,eAAe,EAAC,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAErD,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AACjD,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AAEvD,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AACvD,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AAC7D,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;AAS3D;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;;IAShD,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC;IACxC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,IAAI,CAAC;IAevC,QAAQ,CAAC,qBAAqB,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,oBAAoB,SAAS;IAEtC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IAEjD,YACE,EAAE,EAAE,UAAU,EACd,WAAW,EAAE,eAAe,EAC5B,QAAQ,EAAE,QAAQ,EAClB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,WAAW,EACxB,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,MAAM,IAAI,EAC7B,gBAAgB,EAAE,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,EACxD,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,EACvC,qBAAqB,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,KAAK,IAAI,EACrD,iBAAiB,CAAC,EAAE,yBAAyB,GAAG,SAAS,EAc1D;IAED,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAEzC,KAAK,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAElC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE1C;IAED,IAAa,cAAc,IAAI,OAAO,CAErC;IAEQ,gBAAgB,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,IAAI,CASxD;IAED;;;;;;;;OAQG;IACH,kBAAkB,IAAI,IAAI,CAezB;IAED;;;;;;;;;;OAUG;IACG,uBAAuB,CAC3B,OAAO,SAAmB,EAC1B,gBAAgB,GAAE,MAAM,OAAO,CAAC,IAAI,CAA0B,GAC7D,OAAO,CAAC,IAAI,CAAC,CAuBf;IA8DD,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAEpB;IAEQ,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAEvE;IAED,mBAAmB,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,IAAI,CAKlD;IAEQ,gBAAgB,CAAC,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,GAWnC,CAAC,CACnB;IAED,cAAc,CACZ,YAAY,EAAE,IAAI,GAAG,SAAS,EAC9B,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,WAAW,QAcrB;CAkBF"}

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

@@ -1,10 +1,17 @@
 import { assert } from "../../../shared/src/asserts.js";
+import { getBrowserGlobal } from "../../../shared/src/browser-env.js";
 import { Internal } from "../../../zero-protocol/src/error-kind-enum.js";
 import { MeasurePushOperator } from "../../../zql/src/query/measure-push-operator.js";
 import { QueryDelegateBase } from "../../../zql/src/query/query-delegate-base.js";
 import "./ivm-branch.js";
 //#region ../zero-client/src/client/context.ts
 /**
+* How long pipelines are hydrated for before yielding to the event loop. Short
+* enough to keep a frame or two, long enough that the yields themselves (a
+* `setTimeout(0)` is clamped to 4ms in browsers) stay in the noise.
+*/
+var HYDRATE_SLICE_MS = 12;
+/**
 * ZeroContext glues together zql and Replicache. It listens to changes in
 * Replicache data and pushes them into IVM and on tells the server about new
 * queries.
@@ -19,6 +26,10 @@ var ZeroContext = class extends QueryDelegateBase {
 	flushQueryChanges;
 	#batchViewUpdates;
 	#commitListeners = /* @__PURE__ */ new Set();
+	#pipelinesReady = false;
+	#pendingPipelines = /* @__PURE__ */ new Set();
+	#hydratingPipelines = false;
+	#visibilityWatcher;
 	assertValidRunOptions;
 	/**
 	* Client-side queries start out as "unknown" and are then updated to
@@ -26,7 +37,7 @@ var ZeroContext = class extends QueryDelegateBase {
 	*/
 	defaultQueryComplete = false;
 	addMetric;
-	constructor(lc, mainSources, addQuery, addCustomQuery, updateQuery, updateCustomQuery, flushQueryChanges, batchViewUpdates, addMetric, assertValidRunOptions) {
+	constructor(lc, mainSources, addQuery, addCustomQuery, updateQuery, updateCustomQuery, flushQueryChanges, batchViewUpdates, addMetric, assertValidRunOptions, visibilityWatcher) {
 		super();
 		this.#lc = lc;
 		this.#mainSources = mainSources;
@@ -38,12 +49,111 @@ var ZeroContext = class extends QueryDelegateBase {
 		this.addCustomQuery = addCustomQuery;
 		this.flushQueryChanges = flushQueryChanges;
 		this.addMetric = addMetric;
+		this.#visibilityWatcher = visibilityWatcher;
 	}
 	applyFiltersAnyway;
 	debug;
 	getSource(name) {
 		return this.#mainSources.getSource(name);
 	}
+	get pipelinesReady() {
+		return this.#pipelinesReady;
+	}
+	onPipelinesReady(cb) {
+		assert(!this.#pipelinesReady, "onPipelinesReady called while pipelines are ready");
+		this.#pendingPipelines.add(cb);
+		return () => {
+			this.#pendingPipelines.delete(cb);
+		};
+	}
+	/**
+	* Build and hydrate every pipeline deferred since construction, in
+	* materialization order, as a single view-update batch. Views materialized
+	* before this is called are empty and `unknown` in the meantime, exactly as
+	* they would be over empty sources. A pipeline that fails to build is
+	* logged and its view reports an error; the rest are still built.
+	*
+	* Returns `this` so it can be chained onto the constructor call.
+	*/
+	markPipelinesReady() {
+		if (this.#pipelinesReady) return this;
+		assert(!this.#hydratingPipelines, "Pipelines are already being hydrated");
+		if (this.#pendingPipelines.size === 0) {
+			this.#pipelinesReady = true;
+			return this;
+		}
+		this.batchViewUpdates(() => {
+			const releases = [];
+			this.#attachPending(releases, () => false);
+			this.#release(releases);
+		});
+		return this;
+	}
+	/**
+	* Like {@link markPipelinesReady} but hydrates in time slices, yielding to
+	* the event loop in between so a burst of queries registered at startup does
+	* not monopolize the thread. It only ever yields *between* pipelines.
+	*
+	* No view is exposed until all of them are hydrated: they are released, and
+	* the commit listeners notified, in one synchronous batch at the end.
+	* Queries materialized in the meantime are still deferred and join that
+	* batch. The caller must not call {@link processChanges} until the returned
+	* promise resolves.
+	*/
+	async hydratePendingPipelines(sliceMs = HYDRATE_SLICE_MS, yieldToEventLoop = this.#yieldToEventLoop) {
+		if (this.#pipelinesReady) return;
+		assert(!this.#hydratingPipelines, "Pipelines are already being hydrated");
+		if (this.#pendingPipelines.size === 0) {
+			this.#pipelinesReady = true;
+			return;
+		}
+		this.#hydratingPipelines = true;
+		const releases = [];
+		for (;;) {
+			const sliceEnd = performance.now() + sliceMs;
+			this.batchViewUpdates(() => {
+				this.#attachPending(releases, () => performance.now() >= sliceEnd);
+			});
+			if (this.#pendingPipelines.size === 0) break;
+			await yieldToEventLoop();
+		}
+		this.#hydratingPipelines = false;
+		this.batchViewUpdates(() => this.#release(releases));
+	}
+	#yieldToEventLoop = () => {
+		const scheduler = getBrowserGlobal("scheduler");
+		if (typeof scheduler?.yield === "function") return scheduler.yield();
+		if (this.#visibilityWatcher?.visibilityState === "hidden") return Promise.resolve();
+		return new Promise((resolve) => setTimeout(resolve, 0));
+	};
+	/**
+	* Attaches pending pipelines, always at least one, until none are left or
+	* `shouldStop` says the slice is over.
+	*/
+	#attachPending(releases, shouldStop) {
+		for (const attach of this.#pendingPipelines) {
+			this.#pendingPipelines.delete(attach);
+			try {
+				releases.push(attach());
+			} catch (e) {
+				this.#lc.error?.(Internal, "Failed to build a deferred query pipeline", e);
+			}
+			if (shouldStop()) return;
+		}
+	}
+	/** Must be called inside `batchViewUpdates`. */
+	#release(releases) {
+		this.#pipelinesReady = true;
+		try {
+			for (const release of releases) try {
+				release();
+			} catch (e) {
+				this.#lc.error?.(Internal, "Failed to release a deferred query pipeline", e);
+			}
+		} finally {
+			this.#endTransaction();
+		}
+	}
 	mapAst(ast) {
 		return ast;
 	}
@@ -67,6 +177,7 @@ var ZeroContext = class extends QueryDelegateBase {
 		return result;
 	}
 	processChanges(expectedHead, newHead, changes) {
+		assert(!this.#hydratingPipelines, "processChanges called while pipelines are being hydrated");
 		this.batchViewUpdates(() => {
 			try {
 				this.#mainSources.advance(expectedHead, newHead, changes);

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

@@ -1 +1 @@
-{"version":3,"file":"context.js","names":["#lc","#mainSources","#batchViewUpdates","#commitListeners","#endTransaction"],"sources":["../../../../../zero-client/src/client/context.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {NoIndexDiff} from '../../../replicache/src/btree/node.ts';\nimport type {Hash} from '../../../replicache/src/hash.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport type {DebugDelegate} from '../../../zql/src/builder/debug-delegate.ts';\nimport type {Input} from '../../../zql/src/ivm/operator.ts';\nimport type {Source, SourceInput} from '../../../zql/src/ivm/source.ts';\nimport {MeasurePushOperator} from '../../../zql/src/query/measure-push-operator.ts';\nimport type {MetricsDelegate} from '../../../zql/src/query/metrics-delegate.ts';\nimport {QueryDelegateBase} from '../../../zql/src/query/query-delegate-base.ts';\nimport type {CommitListener} from '../../../zql/src/query/query-delegate.ts';\nimport type {RunOptions} from '../../../zql/src/query/query.ts';\nimport {type IVMSourceBranch} from './ivm-branch.ts';\nimport type {QueryManager} from './query-manager.ts';\n\nexport type AddQuery = QueryManager['addLegacy'];\nexport type AddCustomQuery = QueryManager['addCustom'];\n\nexport type UpdateQuery = QueryManager['updateLegacy'];\nexport type UpdateCustomQuery = QueryManager['updateCustom'];\nexport type FlushQueryChanges = QueryManager['flushBatch'];\n\n/**\n * ZeroContext glues together zql and Replicache. It listens to changes in\n * Replicache data and pushes them into IVM and on tells the server about new\n * queries.\n */\nexport class ZeroContext extends QueryDelegateBase {\n  readonly #lc: LogContext;\n\n  // It is a bummer to have to maintain separate MemorySources here and copy the\n  // data in from the Replicache db. But we want the data to be accessible via\n  // pipelines *synchronously* and the core Replicache infra is all async. So\n  // that needs to be fixed.\n  readonly #mainSources: IVMSourceBranch;\n\n  readonly addServerQuery: AddQuery;\n  readonly addCustomQuery: AddCustomQuery;\n  readonly updateServerQuery: UpdateQuery;\n  readonly updateCustomQuery: UpdateCustomQuery;\n  readonly flushQueryChanges: () => void;\n  readonly #batchViewUpdates: (applyViewUpdates: () => void) => void;\n  readonly #commitListeners: Set<CommitListener> = new Set();\n\n  readonly assertValidRunOptions: (options?: RunOptions) => void;\n\n  /**\n   * Client-side queries start out as \"unknown\" and are then updated to\n   * \"complete\" once the server has sent back the query result.\n   */\n  readonly defaultQueryComplete = false;\n\n  readonly addMetric: MetricsDelegate['addMetric'];\n\n  constructor(\n    lc: LogContext,\n    mainSources: IVMSourceBranch,\n    addQuery: AddQuery,\n    addCustomQuery: AddCustomQuery,\n    updateQuery: UpdateQuery,\n    updateCustomQuery: UpdateCustomQuery,\n    flushQueryChanges: () => void,\n    batchViewUpdates: (applyViewUpdates: () => void) => void,\n    addMetric: MetricsDelegate['addMetric'],\n    assertValidRunOptions: (options?: RunOptions) => void,\n  ) {\n    super();\n    this.#lc = lc;\n    this.#mainSources = mainSources;\n    this.addServerQuery = addQuery;\n    this.updateServerQuery = updateQuery;\n    this.updateCustomQuery = updateCustomQuery;\n    this.#batchViewUpdates = batchViewUpdates;\n    this.assertValidRunOptions = assertValidRunOptions;\n    this.addCustomQuery = addCustomQuery;\n    this.flushQueryChanges = flushQueryChanges;\n    this.addMetric = addMetric;\n  }\n\n  applyFiltersAnyway?: boolean | undefined;\n\n  debug?: DebugDelegate | undefined;\n\n  getSource(name: string): Source | undefined {\n    return this.#mainSources.getSource(name);\n  }\n\n  mapAst(ast: AST): AST {\n    return ast;\n  }\n\n  override decorateSourceInput(input: SourceInput, queryID: string): Input {\n    return new MeasurePushOperator(input, queryID, this, 'query-update-client');\n  }\n\n  onTransactionCommit(cb: CommitListener): () => void {\n    this.#commitListeners.add(cb);\n    return () => {\n      this.#commitListeners.delete(cb);\n    };\n  }\n\n  override batchViewUpdates<T>(applyViewUpdates: () => T) {\n    let result: T | undefined;\n    let viewChangesPerformed = false;\n    this.#batchViewUpdates(() => {\n      result = applyViewUpdates();\n      viewChangesPerformed = true;\n    });\n    assert(\n      viewChangesPerformed,\n      'batchViewUpdates must call applyViewUpdates synchronously.',\n    );\n    return result as T;\n  }\n\n  processChanges(\n    expectedHead: Hash | undefined,\n    newHead: Hash,\n    changes: NoIndexDiff,\n  ) {\n    this.batchViewUpdates(() => {\n      try {\n        this.#mainSources.advance(expectedHead, newHead, changes);\n      } finally {\n        this.#endTransaction();\n      }\n    });\n  }\n\n  #endTransaction() {\n    for (const listener of this.#commitListeners) {\n      try {\n        listener();\n      } catch (e) {\n        // We should not fatal the inner-workings of Zero due to the user's application\n        // code throwing an error.\n        // Hence we wrap notifications in a try-catch block.\n        this.#lc.error?.(\n          ErrorKind.Internal,\n          'Failed notifying a commit listener of IVM updates',\n          e,\n        );\n      }\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;AA6BA,IAAa,cAAb,cAAiC,kBAAkB;CACjD;CAMA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA,mCAAiD,IAAI,IAAI;CAEzD;;;;;CAMA,uBAAgC;CAEhC;CAEA,YACE,IACA,aACA,UACA,gBACA,aACA,mBACA,mBACA,kBACA,WACA,uBACA;EACA,MAAM;EACN,KAAKA,MAAM;EACX,KAAKC,eAAe;EACpB,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,oBAAoB;EACzB,KAAKC,oBAAoB;EACzB,KAAK,wBAAwB;EAC7B,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,YAAY;CACnB;CAEA;CAEA;CAEA,UAAU,MAAkC;EAC1C,OAAO,KAAKD,aAAa,UAAU,IAAI;CACzC;CAEA,OAAO,KAAe;EACpB,OAAO;CACT;CAEA,oBAA6B,OAAoB,SAAwB;EACvE,OAAO,IAAI,oBAAoB,OAAO,SAAS,MAAM,qBAAqB;CAC5E;CAEA,oBAAoB,IAAgC;EAClD,KAAKE,iBAAiB,IAAI,EAAE;EAC5B,aAAa;GACX,KAAKA,iBAAiB,OAAO,EAAE;EACjC;CACF;CAEA,iBAA6B,kBAA2B;EACtD,IAAI;EACJ,IAAI,uBAAuB;EAC3B,KAAKD,wBAAwB;GAC3B,SAAS,iBAAiB;GAC1B,uBAAuB;EACzB,CAAC;EACD,OACE,sBACA,4DACF;EACA,OAAO;CACT;CAEA,eACE,cACA,SACA,SACA;EACA,KAAK,uBAAuB;GAC1B,IAAI;IACF,KAAKD,aAAa,QAAQ,cAAc,SAAS,OAAO;GAC1D,UAAU;IACR,KAAKG,gBAAgB;GACvB;EACF,CAAC;CACH;CAEA,kBAAkB;EAChB,KAAK,MAAM,YAAY,KAAKD,kBAC1B,IAAI;GACF,SAAS;EACX,SAAS,GAAG;GAIV,KAAKH,IAAI,QACP,UACA,qDACA,CACF;EACF;CAEJ;AACF"}
+{"version":3,"file":"context.js","names":["#lc","#mainSources","#batchViewUpdates","#commitListeners","#pendingPipelines","#visibilityWatcher","#pipelinesReady","#hydratingPipelines","#attachPending","#release","#yieldToEventLoop","#endTransaction"],"sources":["../../../../../zero-client/src/client/context.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {NoIndexDiff} from '../../../replicache/src/btree/node.ts';\nimport type {Hash} from '../../../replicache/src/hash.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport {getBrowserGlobal} from '../../../shared/src/browser-env.ts';\nimport type {DocumentVisibilityWatcher} from '../../../shared/src/document-visible.ts';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport type {DebugDelegate} from '../../../zql/src/builder/debug-delegate.ts';\nimport type {Input} from '../../../zql/src/ivm/operator.ts';\nimport type {Source, SourceInput} from '../../../zql/src/ivm/source.ts';\nimport {MeasurePushOperator} from '../../../zql/src/query/measure-push-operator.ts';\nimport type {MetricsDelegate} from '../../../zql/src/query/metrics-delegate.ts';\nimport {QueryDelegateBase} from '../../../zql/src/query/query-delegate-base.ts';\nimport type {\n  AttachPipeline,\n  CommitListener,\n} from '../../../zql/src/query/query-delegate.ts';\nimport type {RunOptions} from '../../../zql/src/query/query.ts';\nimport {type IVMSourceBranch} from './ivm-branch.ts';\nimport type {QueryManager} from './query-manager.ts';\n\nexport type AddQuery = QueryManager['addLegacy'];\nexport type AddCustomQuery = QueryManager['addCustom'];\n\nexport type UpdateQuery = QueryManager['updateLegacy'];\nexport type UpdateCustomQuery = QueryManager['updateCustom'];\nexport type FlushQueryChanges = QueryManager['flushBatch'];\n\n/**\n * How long pipelines are hydrated for before yielding to the event loop. Short\n * enough to keep a frame or two, long enough that the yields themselves (a\n * `setTimeout(0)` is clamped to 4ms in browsers) stay in the noise.\n */\nconst HYDRATE_SLICE_MS = 12;\n\n/**\n * ZeroContext glues together zql and Replicache. It listens to changes in\n * Replicache data and pushes them into IVM and on tells the server about new\n * queries.\n */\nexport class ZeroContext extends QueryDelegateBase {\n  readonly #lc: LogContext;\n\n  // It is a bummer to have to maintain separate MemorySources here and copy the\n  // data in from the Replicache db. But we want the data to be accessible via\n  // pipelines *synchronously* and the core Replicache infra is all async. So\n  // that needs to be fixed.\n  readonly #mainSources: IVMSourceBranch;\n\n  readonly addServerQuery: AddQuery;\n  readonly addCustomQuery: AddCustomQuery;\n  readonly updateServerQuery: UpdateQuery;\n  readonly updateCustomQuery: UpdateCustomQuery;\n  readonly flushQueryChanges: () => void;\n  readonly #batchViewUpdates: (applyViewUpdates: () => void) => void;\n  readonly #commitListeners: Set<CommitListener> = new Set();\n\n  // Pipeline construction is deferred until `markPipelinesReady()` is called.\n  // Zero calls it once the replica has been loaded into the IVM sources, so\n  // cold boot loads the sources once instead of pushing every row through\n  // every already-materialized pipeline. Contexts whose sources are already\n  // populated at construction (custom mutator transactions, tests) call it\n  // right away.\n  #pipelinesReady = false;\n  readonly #pendingPipelines: Set<AttachPipeline> = new Set();\n  #hydratingPipelines = false;\n  readonly #visibilityWatcher: DocumentVisibilityWatcher | undefined;\n\n  readonly assertValidRunOptions: (options?: RunOptions) => void;\n\n  /**\n   * Client-side queries start out as \"unknown\" and are then updated to\n   * \"complete\" once the server has sent back the query result.\n   */\n  readonly defaultQueryComplete = false;\n\n  readonly addMetric: MetricsDelegate['addMetric'];\n\n  constructor(\n    lc: LogContext,\n    mainSources: IVMSourceBranch,\n    addQuery: AddQuery,\n    addCustomQuery: AddCustomQuery,\n    updateQuery: UpdateQuery,\n    updateCustomQuery: UpdateCustomQuery,\n    flushQueryChanges: () => void,\n    batchViewUpdates: (applyViewUpdates: () => void) => void,\n    addMetric: MetricsDelegate['addMetric'],\n    assertValidRunOptions: (options?: RunOptions) => void,\n    visibilityWatcher?: DocumentVisibilityWatcher | undefined,\n  ) {\n    super();\n    this.#lc = lc;\n    this.#mainSources = mainSources;\n    this.addServerQuery = addQuery;\n    this.updateServerQuery = updateQuery;\n    this.updateCustomQuery = updateCustomQuery;\n    this.#batchViewUpdates = batchViewUpdates;\n    this.assertValidRunOptions = assertValidRunOptions;\n    this.addCustomQuery = addCustomQuery;\n    this.flushQueryChanges = flushQueryChanges;\n    this.addMetric = addMetric;\n    this.#visibilityWatcher = visibilityWatcher;\n  }\n\n  applyFiltersAnyway?: boolean | undefined;\n\n  debug?: DebugDelegate | undefined;\n\n  getSource(name: string): Source | undefined {\n    return this.#mainSources.getSource(name);\n  }\n\n  override get pipelinesReady(): boolean {\n    return this.#pipelinesReady;\n  }\n\n  override onPipelinesReady(cb: AttachPipeline): () => void {\n    assert(\n      !this.#pipelinesReady,\n      'onPipelinesReady called while pipelines are ready',\n    );\n    this.#pendingPipelines.add(cb);\n    return () => {\n      this.#pendingPipelines.delete(cb);\n    };\n  }\n\n  /**\n   * Build and hydrate every pipeline deferred since construction, in\n   * materialization order, as a single view-update batch. Views materialized\n   * before this is called are empty and `unknown` in the meantime, exactly as\n   * they would be over empty sources. A pipeline that fails to build is\n   * logged and its view reports an error; the rest are still built.\n   *\n   * Returns `this` so it can be chained onto the constructor call.\n   */\n  markPipelinesReady(): this {\n    if (this.#pipelinesReady) {\n      return this;\n    }\n    assert(!this.#hydratingPipelines, 'Pipelines are already being hydrated');\n    if (this.#pendingPipelines.size === 0) {\n      this.#pipelinesReady = true;\n      return this;\n    }\n    this.batchViewUpdates(() => {\n      const releases: (() => void)[] = [];\n      this.#attachPending(releases, () => false);\n      this.#release(releases);\n    });\n    return this;\n  }\n\n  /**\n   * Like {@link markPipelinesReady} but hydrates in time slices, yielding to\n   * the event loop in between so a burst of queries registered at startup does\n   * not monopolize the thread. It only ever yields *between* pipelines.\n   *\n   * No view is exposed until all of them are hydrated: they are released, and\n   * the commit listeners notified, in one synchronous batch at the end.\n   * Queries materialized in the meantime are still deferred and join that\n   * batch. The caller must not call {@link processChanges} until the returned\n   * promise resolves.\n   */\n  async hydratePendingPipelines(\n    sliceMs = HYDRATE_SLICE_MS,\n    yieldToEventLoop: () => Promise<void> = this.#yieldToEventLoop,\n  ): Promise<void> {\n    if (this.#pipelinesReady) {\n      return;\n    }\n    assert(!this.#hydratingPipelines, 'Pipelines are already being hydrated');\n    if (this.#pendingPipelines.size === 0) {\n      this.#pipelinesReady = true;\n      return;\n    }\n    this.#hydratingPipelines = true;\n    const releases: (() => void)[] = [];\n    for (;;) {\n      const sliceEnd = performance.now() + sliceMs;\n      this.batchViewUpdates(() => {\n        this.#attachPending(releases, () => performance.now() >= sliceEnd);\n      });\n      if (this.#pendingPipelines.size === 0) {\n        break;\n      }\n      await yieldToEventLoop();\n    }\n    this.#hydratingPipelines = false;\n    this.batchViewUpdates(() => this.#release(releases));\n  }\n\n  #yieldToEventLoop = (): Promise<void> => {\n    // Not in React Native or Safari.\n    const scheduler = getBrowserGlobal('scheduler');\n    if (typeof scheduler?.yield === 'function') {\n      return scheduler.yield();\n    }\n    // Timers are throttled to a second or more in a background tab, which would\n    // stretch startup to minutes, and a hidden page has nothing to keep\n    // responsive anyway.\n    if (this.#visibilityWatcher?.visibilityState === 'hidden') {\n      return Promise.resolve();\n    }\n    return new Promise(resolve => setTimeout(resolve, 0));\n  };\n\n  /**\n   * Attaches pending pipelines, always at least one, until none are left or\n   * `shouldStop` says the slice is over.\n   */\n  #attachPending(releases: (() => void)[], shouldStop: () => boolean) {\n    for (const attach of this.#pendingPipelines) {\n      this.#pendingPipelines.delete(attach);\n      try {\n        releases.push(attach());\n      } catch (e) {\n        // The failing view has already been marked as errored; keep\n        // building the others rather than aborting startup.\n        this.#lc.error?.(\n          ErrorKind.Internal,\n          'Failed to build a deferred query pipeline',\n          e,\n        );\n      }\n      if (shouldStop()) {\n        return;\n      }\n    }\n  }\n\n  /** Must be called inside `batchViewUpdates`. */\n  #release(releases: (() => void)[]) {\n    this.#pipelinesReady = true;\n    try {\n      for (const release of releases) {\n        try {\n          release();\n        } catch (e) {\n          // One view must not keep the rest from being released.\n          this.#lc.error?.(\n            ErrorKind.Internal,\n            'Failed to release a deferred query pipeline',\n            e,\n          );\n        }\n      }\n    } finally {\n      this.#endTransaction();\n    }\n  }\n\n  mapAst(ast: AST): AST {\n    return ast;\n  }\n\n  override decorateSourceInput(input: SourceInput, queryID: string): Input {\n    return new MeasurePushOperator(input, queryID, this, 'query-update-client');\n  }\n\n  onTransactionCommit(cb: CommitListener): () => void {\n    this.#commitListeners.add(cb);\n    return () => {\n      this.#commitListeners.delete(cb);\n    };\n  }\n\n  override batchViewUpdates<T>(applyViewUpdates: () => T) {\n    let result: T | undefined;\n    let viewChangesPerformed = false;\n    this.#batchViewUpdates(() => {\n      result = applyViewUpdates();\n      viewChangesPerformed = true;\n    });\n    assert(\n      viewChangesPerformed,\n      'batchViewUpdates must call applyViewUpdates synchronously.',\n    );\n    return result as T;\n  }\n\n  processChanges(\n    expectedHead: Hash | undefined,\n    newHead: Hash,\n    changes: NoIndexDiff,\n  ) {\n    // Views hydrated so far would flush ahead of the rest of their batch.\n    assert(\n      !this.#hydratingPipelines,\n      'processChanges called while pipelines are being hydrated',\n    );\n    this.batchViewUpdates(() => {\n      try {\n        this.#mainSources.advance(expectedHead, newHead, changes);\n      } finally {\n        this.#endTransaction();\n      }\n    });\n  }\n\n  #endTransaction() {\n    for (const listener of this.#commitListeners) {\n      try {\n        listener();\n      } catch (e) {\n        // We should not fatal the inner-workings of Zero due to the user's application\n        // code throwing an error.\n        // Hence we wrap notifications in a try-catch block.\n        this.#lc.error?.(\n          ErrorKind.Internal,\n          'Failed notifying a commit listener of IVM updates',\n          e,\n        );\n      }\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAkCA,IAAM,mBAAmB;;;;;;AAOzB,IAAa,cAAb,cAAiC,kBAAkB;CACjD;CAMA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA,mCAAiD,IAAI,IAAI;CAQzD,kBAAkB;CAClB,oCAAkD,IAAI,IAAI;CAC1D,sBAAsB;CACtB;CAEA;;;;;CAMA,uBAAgC;CAEhC;CAEA,YACE,IACA,aACA,UACA,gBACA,aACA,mBACA,mBACA,kBACA,WACA,uBACA,mBACA;EACA,MAAM;EACN,KAAKA,MAAM;EACX,KAAKC,eAAe;EACpB,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,oBAAoB;EACzB,KAAKC,oBAAoB;EACzB,KAAK,wBAAwB;EAC7B,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,YAAY;EACjB,KAAKG,qBAAqB;CAC5B;CAEA;CAEA;CAEA,UAAU,MAAkC;EAC1C,OAAO,KAAKJ,aAAa,UAAU,IAAI;CACzC;CAEA,IAAa,iBAA0B;EACrC,OAAO,KAAKK;CACd;CAEA,iBAA0B,IAAgC;EACxD,OACE,CAAC,KAAKA,iBACN,mDACF;EACA,KAAKF,kBAAkB,IAAI,EAAE;EAC7B,aAAa;GACX,KAAKA,kBAAkB,OAAO,EAAE;EAClC;CACF;;;;;;;;;;CAWA,qBAA2B;EACzB,IAAI,KAAKE,iBACP,OAAO;EAET,OAAO,CAAC,KAAKC,qBAAqB,sCAAsC;EACxE,IAAI,KAAKH,kBAAkB,SAAS,GAAG;GACrC,KAAKE,kBAAkB;GACvB,OAAO;EACT;EACA,KAAK,uBAAuB;GAC1B,MAAM,WAA2B,CAAC;GAClC,KAAKE,eAAe,gBAAgB,KAAK;GACzC,KAAKC,SAAS,QAAQ;EACxB,CAAC;EACD,OAAO;CACT;;;;;;;;;;;;CAaA,MAAM,wBACJ,UAAU,kBACV,mBAAwC,KAAKC,mBAC9B;EACf,IAAI,KAAKJ,iBACP;EAEF,OAAO,CAAC,KAAKC,qBAAqB,sCAAsC;EACxE,IAAI,KAAKH,kBAAkB,SAAS,GAAG;GACrC,KAAKE,kBAAkB;GACvB;EACF;EACA,KAAKC,sBAAsB;EAC3B,MAAM,WAA2B,CAAC;EAClC,SAAS;GACP,MAAM,WAAW,YAAY,IAAI,IAAI;GACrC,KAAK,uBAAuB;IAC1B,KAAKC,eAAe,gBAAgB,YAAY,IAAI,KAAK,QAAQ;GACnE,CAAC;GACD,IAAI,KAAKJ,kBAAkB,SAAS,GAClC;GAEF,MAAM,iBAAiB;EACzB;EACA,KAAKG,sBAAsB;EAC3B,KAAK,uBAAuB,KAAKE,SAAS,QAAQ,CAAC;CACrD;CAEA,0BAAyC;EAEvC,MAAM,YAAY,iBAAiB,WAAW;EAC9C,IAAI,OAAO,WAAW,UAAU,YAC9B,OAAO,UAAU,MAAM;EAKzB,IAAI,KAAKJ,oBAAoB,oBAAoB,UAC/C,OAAO,QAAQ,QAAQ;EAEzB,OAAO,IAAI,SAAQ,YAAW,WAAW,SAAS,CAAC,CAAC;CACtD;;;;;CAMA,eAAe,UAA0B,YAA2B;EAClE,KAAK,MAAM,UAAU,KAAKD,mBAAmB;GAC3C,KAAKA,kBAAkB,OAAO,MAAM;GACpC,IAAI;IACF,SAAS,KAAK,OAAO,CAAC;GACxB,SAAS,GAAG;IAGV,KAAKJ,IAAI,QACP,UACA,6CACA,CACF;GACF;GACA,IAAI,WAAW,GACb;EAEJ;CACF;;CAGA,SAAS,UAA0B;EACjC,KAAKM,kBAAkB;EACvB,IAAI;GACF,KAAK,MAAM,WAAW,UACpB,IAAI;IACF,QAAQ;GACV,SAAS,GAAG;IAEV,KAAKN,IAAI,QACP,UACA,+CACA,CACF;GACF;EAEJ,UAAU;GACR,KAAKW,gBAAgB;EACvB;CACF;CAEA,OAAO,KAAe;EACpB,OAAO;CACT;CAEA,oBAA6B,OAAoB,SAAwB;EACvE,OAAO,IAAI,oBAAoB,OAAO,SAAS,MAAM,qBAAqB;CAC5E;CAEA,oBAAoB,IAAgC;EAClD,KAAKR,iBAAiB,IAAI,EAAE;EAC5B,aAAa;GACX,KAAKA,iBAAiB,OAAO,EAAE;EACjC;CACF;CAEA,iBAA6B,kBAA2B;EACtD,IAAI;EACJ,IAAI,uBAAuB;EAC3B,KAAKD,wBAAwB;GAC3B,SAAS,iBAAiB;GAC1B,uBAAuB;EACzB,CAAC;EACD,OACE,sBACA,4DACF;EACA,OAAO;CACT;CAEA,eACE,cACA,SACA,SACA;EAEA,OACE,CAAC,KAAKK,qBACN,0DACF;EACA,KAAK,uBAAuB;GAC1B,IAAI;IACF,KAAKN,aAAa,QAAQ,cAAc,SAAS,OAAO;GAC1D,UAAU;IACR,KAAKU,gBAAgB;GACvB;EACF,CAAC;CACH;CAEA,kBAAkB;EAChB,KAAK,MAAM,YAAY,KAAKR,kBAC1B,IAAI;GACF,SAAS;EACX,SAAS,GAAG;GAIV,KAAKH,IAAI,QACP,UACA,qDACA,CACF;EACF;CAEJ;AACF"}

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

@@ -53,10 +53,10 @@ function makeReplicacheMutator(lc, mutator, schema, context) {
 	};
 }
 function assertValidRunOptions(options) {
-	assert(options?.type !== "complete", "Cannot wait for complete results in custom mutations");
+	assert(options?.type !== "complete" && options?.type !== "cached", "Cannot wait for cached or complete results in custom mutations");
 }
 function newZeroContext(lc, ivmBranch) {
-	return new ZeroContext(lc, ivmBranch, () => emptyFunction, () => emptyFunction, emptyFunction, emptyFunction, emptyFunction, (applyViewUpdates) => applyViewUpdates(), emptyFunction, assertValidRunOptions);
+	return new ZeroContext(lc, ivmBranch, () => emptyFunction, () => emptyFunction, emptyFunction, emptyFunction, emptyFunction, (applyViewUpdates) => applyViewUpdates(), emptyFunction, assertValidRunOptions).markPipelinesReady();
 }
 //#endregion
 export { TransactionImpl, makeReplicacheMutator };

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

@@ -1 +1 @@
-{"version":3,"file":"custom.js","names":["#repTx","#zeroContext"],"sources":["../../../../../zero-client/src/client/custom.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {ZeroTxData} from '../../../replicache/src/replicache-options.ts';\nimport type {WriteTransactionImpl} from '../../../replicache/src/transactions.ts';\nimport {zeroData} from '../../../replicache/src/transactions.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {emptyFunction} from '../../../shared/src/sentinels.ts';\nimport type {DefaultSchema} from '../../../zero-types/src/default-types.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport {\n  makeTransactionMutate,\n  type TransactionMutate,\n} from '../../../zql/src/mutate/crud.ts';\nimport type {\n  ClientTransaction,\n  Transaction,\n} from '../../../zql/src/mutate/custom.ts';\nimport {createRunnableBuilder} from '../../../zql/src/query/create-builder.ts';\nimport {\n  type HumanReadable,\n  type Query,\n  type RunOptions,\n} from '../../../zql/src/query/query.ts';\nimport type {ConditionalSchemaQuery} from '../../../zql/src/query/schema-query.ts';\nimport type {ClientID} from '../types/client-state.ts';\nimport {ZeroContext} from './context.ts';\nimport {makeCRUDExecutor} from './crud.ts';\nimport type {IVMSourceBranch} from './ivm-branch.ts';\nimport type {WriteTransaction} from './replicache-types.ts';\n\n/**\n * The shape which a user's custom mutator definitions must conform to.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type CustomMutatorDefs = {\n  // oxlint-disable-next-line no-explicit-any\n  [namespaceOrKey: string]: CustomMutatorImpl<any> | CustomMutatorDefs;\n};\n\nexport type MutatorResultDetails =\n  | {\n      readonly type: 'success';\n    }\n  | {\n      readonly type: 'error';\n      readonly error:\n        | {\n            readonly type: 'app';\n            readonly message: string;\n            readonly details: ReadonlyJSONValue | undefined;\n          }\n        | {\n            readonly type: 'zero';\n            readonly message: string;\n          };\n    };\n\nexport type MutatorResultSuccessDetails = Extract<\n  MutatorResultDetails,\n  {type: 'success'}\n>;\nexport type MutatorResultErrorDetails = Extract<\n  MutatorResultDetails,\n  {type: 'error'}\n>;\n\nexport type MutatorResult = {\n  client: Promise<MutatorResultDetails & {}>;\n  server: Promise<MutatorResultDetails & {}>;\n} & {};\n\nexport type CustomMutatorImpl<\n  S extends Schema,\n  TWrappedTransaction = unknown,\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  TArgs = any,\n  Context = unknown,\n> = (\n  tx: Transaction<S, TWrappedTransaction>,\n  // TODO: many args. See commit: 52657c2f934b4a458d628ea77e56ce92b61eb3c6 which did have many args.\n  // The issue being that it will be a protocol change to support varargs.\n  args: TArgs,\n  ctx: Context,\n) => Promise<void>;\n\n/**\n * The shape exposed on the `Zero.mutate` instance.\n * The signature of a custom mutator takes a `transaction` as its first arg\n * but the user does not provide this arg when calling the mutator.\n *\n * This utility strips the `tx` arg from the user's custom mutator signatures.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type MakeCustomMutatorInterfaces<\n  S extends Schema,\n  MD extends CustomMutatorDefs,\n  TContext,\n> = {\n  readonly [NamespaceOrName in keyof MD]: MD[NamespaceOrName] extends (\n    tx: Transaction<S>,\n    ...args: infer Args\n  ) => Promise<void>\n    ? (...args: Args) => MutatorResult\n    : MD[NamespaceOrName] extends CustomMutatorDefs\n      ? MakeCustomMutatorInterfaces<S, MD[NamespaceOrName], TContext>\n      : never;\n};\n\nexport type MakeCustomMutatorInterface<TSchema extends Schema, F> = F extends (\n  tx: ClientTransaction<TSchema>,\n  ...args: infer Args\n) => Promise<void>\n  ? (...args: Args) => MutatorResult\n  : never;\n\nexport class TransactionImpl<\n  TSchema extends Schema = DefaultSchema,\n> implements ClientTransaction<TSchema> {\n  readonly location = 'client';\n  readonly mutate: TransactionMutate<TSchema>;\n  /**\n   * @deprecated Use {@linkcode createBuilder} with `tx.run(zql.table.where(...))` instead.\n   */\n  readonly query: ConditionalSchemaQuery<TSchema>;\n\n  readonly #repTx: WriteTransaction;\n  readonly #zeroContext: ZeroContext;\n\n  constructor(lc: LogContext, repTx: WriteTransaction, schema: TSchema) {\n    must(repTx.reason === 'initial' || repTx.reason === 'rebase');\n    const txData = getZeroTxData(repTx);\n    const ivmBranch = txData.ivmSources as IVMSourceBranch;\n\n    this.#repTx = repTx;\n\n    const executor = makeCRUDExecutor(repTx, schema, ivmBranch);\n    this.mutate = makeTransactionMutate(schema, executor);\n\n    const zeroContext = newZeroContext(\n      lc,\n      txData.ivmSources as IVMSourceBranch,\n    );\n\n    this.query = createRunnableBuilder(zeroContext, schema);\n\n    this.#zeroContext = zeroContext;\n  }\n\n  get clientID(): ClientID {\n    return this.#repTx.clientID;\n  }\n\n  get mutationID(): number {\n    return this.#repTx.mutationID;\n  }\n\n  get reason(): 'optimistic' | 'rebase' {\n    return this.#repTx.reason === 'initial' ? 'optimistic' : 'rebase';\n  }\n\n  get token(): string | undefined {\n    return (this.#repTx as WriteTransactionImpl)[zeroData]?.token;\n  }\n\n  run<TTable extends keyof TSchema['tables'] & string, TReturn>(\n    query: Query<TTable, TSchema, TReturn>,\n    options?: RunOptions,\n  ): Promise<HumanReadable<TReturn>> {\n    return this.#zeroContext.run(query, options);\n  }\n}\n\nexport function getZeroTxData(repTx: WriteTransaction): ZeroTxData {\n  const txData = must(\n    (repTx as WriteTransactionImpl)[zeroData],\n    'zero was not set on replicache internal options!',\n  );\n  return txData as ZeroTxData;\n}\n\nexport function makeReplicacheMutator<\n  S extends Schema,\n  TWrappedTransaction,\n  Context,\n>(\n  lc: LogContext,\n  mutator: CustomMutatorImpl<S, TWrappedTransaction>,\n  schema: S,\n  context: Context,\n): (repTx: WriteTransaction, args: ReadonlyJSONValue) => Promise<void> {\n  return async (\n    repTx: WriteTransaction,\n    args: ReadonlyJSONValue,\n  ): Promise<void> => {\n    const tx = new TransactionImpl(lc, repTx, schema);\n    await mutator(tx, args, context);\n  };\n}\n\nfunction assertValidRunOptions(options: RunOptions | undefined): void {\n  // TODO(arv): We should enforce this with the type system too.\n  assert(\n    options?.type !== 'complete',\n    'Cannot wait for complete results in custom mutations',\n  );\n}\n\nfunction newZeroContext(lc: LogContext, ivmBranch: IVMSourceBranch) {\n  return new ZeroContext(\n    lc,\n    ivmBranch,\n    () => emptyFunction,\n    () => emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    applyViewUpdates => applyViewUpdates(),\n    emptyFunction,\n    assertValidRunOptions,\n  );\n}\n"],"mappings":";;;;;;;;;;AAoHA,IAAa,kBAAb,MAEwC;CACtC,WAAoB;CACpB;;;;CAIA;CAEA;CACA;CAEA,YAAY,IAAgB,OAAyB,QAAiB;EACpE,KAAK,MAAM,WAAW,aAAa,MAAM,WAAW,QAAQ;EAC5D,MAAM,SAAS,cAAc,KAAK;EAClC,MAAM,YAAY,OAAO;EAEzB,KAAKA,SAAS;EAEd,MAAM,WAAW,iBAAiB,OAAO,QAAQ,SAAS;EAC1D,KAAK,SAAS,sBAAsB,QAAQ,QAAQ;EAEpD,MAAM,cAAc,eAClB,IACA,OAAO,UACT;EAEA,KAAK,QAAQ,sBAAsB,aAAa,MAAM;EAEtD,KAAKC,eAAe;CACtB;CAEA,IAAI,WAAqB;EACvB,OAAO,KAAKD,OAAO;CACrB;CAEA,IAAI,aAAqB;EACvB,OAAO,KAAKA,OAAO;CACrB;CAEA,IAAI,SAAkC;EACpC,OAAO,KAAKA,OAAO,WAAW,YAAY,eAAe;CAC3D;CAEA,IAAI,QAA4B;EAC9B,OAAQ,KAAKA,OAAgC,WAAW;CAC1D;CAEA,IACE,OACA,SACiC;EACjC,OAAO,KAAKC,aAAa,IAAI,OAAO,OAAO;CAC7C;AACF;AAEA,SAAgB,cAAc,OAAqC;CAKjE,OAJe,KACZ,MAA+B,WAChC,kDAEK;AACT;AAEA,SAAgB,sBAKd,IACA,SACA,QACA,SACqE;CACrE,OAAO,OACL,OACA,SACkB;EAElB,MAAM,QAAQ,IADC,gBAAgB,IAAI,OAAO,MAC5B,GAAI,MAAM,OAAO;CACjC;AACF;AAEA,SAAS,sBAAsB,SAAuC;CAEpE,OACE,SAAS,SAAS,YAClB,sDACF;AACF;AAEA,SAAS,eAAe,IAAgB,WAA4B;CAClE,OAAO,IAAI,YACT,IACA,iBACM,qBACA,eACN,eACA,eACA,gBACA,qBAAoB,iBAAiB,GACrC,eACA,qBACF;AACF"}
+{"version":3,"file":"custom.js","names":["#repTx","#zeroContext"],"sources":["../../../../../zero-client/src/client/custom.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {ZeroTxData} from '../../../replicache/src/replicache-options.ts';\nimport type {WriteTransactionImpl} from '../../../replicache/src/transactions.ts';\nimport {zeroData} from '../../../replicache/src/transactions.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {emptyFunction} from '../../../shared/src/sentinels.ts';\nimport type {DefaultSchema} from '../../../zero-types/src/default-types.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport {\n  makeTransactionMutate,\n  type TransactionMutate,\n} from '../../../zql/src/mutate/crud.ts';\nimport type {\n  ClientTransaction,\n  Transaction,\n} from '../../../zql/src/mutate/custom.ts';\nimport {createRunnableBuilder} from '../../../zql/src/query/create-builder.ts';\nimport {\n  type HumanReadable,\n  type Query,\n  type RunOptions,\n} from '../../../zql/src/query/query.ts';\nimport type {ConditionalSchemaQuery} from '../../../zql/src/query/schema-query.ts';\nimport type {ClientID} from '../types/client-state.ts';\nimport {ZeroContext} from './context.ts';\nimport {makeCRUDExecutor} from './crud.ts';\nimport type {IVMSourceBranch} from './ivm-branch.ts';\nimport type {WriteTransaction} from './replicache-types.ts';\n\n/**\n * The shape which a user's custom mutator definitions must conform to.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type CustomMutatorDefs = {\n  // oxlint-disable-next-line no-explicit-any\n  [namespaceOrKey: string]: CustomMutatorImpl<any> | CustomMutatorDefs;\n};\n\nexport type MutatorResultDetails =\n  | {\n      readonly type: 'success';\n    }\n  | {\n      readonly type: 'error';\n      readonly error:\n        | {\n            readonly type: 'app';\n            readonly message: string;\n            readonly details: ReadonlyJSONValue | undefined;\n          }\n        | {\n            readonly type: 'zero';\n            readonly message: string;\n          };\n    };\n\nexport type MutatorResultSuccessDetails = Extract<\n  MutatorResultDetails,\n  {type: 'success'}\n>;\nexport type MutatorResultErrorDetails = Extract<\n  MutatorResultDetails,\n  {type: 'error'}\n>;\n\nexport type MutatorResult = {\n  client: Promise<MutatorResultDetails & {}>;\n  server: Promise<MutatorResultDetails & {}>;\n} & {};\n\nexport type CustomMutatorImpl<\n  S extends Schema,\n  TWrappedTransaction = unknown,\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  TArgs = any,\n  Context = unknown,\n> = (\n  tx: Transaction<S, TWrappedTransaction>,\n  // TODO: many args. See commit: 52657c2f934b4a458d628ea77e56ce92b61eb3c6 which did have many args.\n  // The issue being that it will be a protocol change to support varargs.\n  args: TArgs,\n  ctx: Context,\n) => Promise<void>;\n\n/**\n * The shape exposed on the `Zero.mutate` instance.\n * The signature of a custom mutator takes a `transaction` as its first arg\n * but the user does not provide this arg when calling the mutator.\n *\n * This utility strips the `tx` arg from the user's custom mutator signatures.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type MakeCustomMutatorInterfaces<\n  S extends Schema,\n  MD extends CustomMutatorDefs,\n  TContext,\n> = {\n  readonly [NamespaceOrName in keyof MD]: MD[NamespaceOrName] extends (\n    tx: Transaction<S>,\n    ...args: infer Args\n  ) => Promise<void>\n    ? (...args: Args) => MutatorResult\n    : MD[NamespaceOrName] extends CustomMutatorDefs\n      ? MakeCustomMutatorInterfaces<S, MD[NamespaceOrName], TContext>\n      : never;\n};\n\nexport type MakeCustomMutatorInterface<TSchema extends Schema, F> = F extends (\n  tx: ClientTransaction<TSchema>,\n  ...args: infer Args\n) => Promise<void>\n  ? (...args: Args) => MutatorResult\n  : never;\n\nexport class TransactionImpl<\n  TSchema extends Schema = DefaultSchema,\n> implements ClientTransaction<TSchema> {\n  readonly location = 'client';\n  readonly mutate: TransactionMutate<TSchema>;\n  /**\n   * @deprecated Use {@linkcode createBuilder} with `tx.run(zql.table.where(...))` instead.\n   */\n  readonly query: ConditionalSchemaQuery<TSchema>;\n\n  readonly #repTx: WriteTransaction;\n  readonly #zeroContext: ZeroContext;\n\n  constructor(lc: LogContext, repTx: WriteTransaction, schema: TSchema) {\n    must(repTx.reason === 'initial' || repTx.reason === 'rebase');\n    const txData = getZeroTxData(repTx);\n    const ivmBranch = txData.ivmSources as IVMSourceBranch;\n\n    this.#repTx = repTx;\n\n    const executor = makeCRUDExecutor(repTx, schema, ivmBranch);\n    this.mutate = makeTransactionMutate(schema, executor);\n\n    const zeroContext = newZeroContext(\n      lc,\n      txData.ivmSources as IVMSourceBranch,\n    );\n\n    this.query = createRunnableBuilder(zeroContext, schema);\n\n    this.#zeroContext = zeroContext;\n  }\n\n  get clientID(): ClientID {\n    return this.#repTx.clientID;\n  }\n\n  get mutationID(): number {\n    return this.#repTx.mutationID;\n  }\n\n  get reason(): 'optimistic' | 'rebase' {\n    return this.#repTx.reason === 'initial' ? 'optimistic' : 'rebase';\n  }\n\n  get token(): string | undefined {\n    return (this.#repTx as WriteTransactionImpl)[zeroData]?.token;\n  }\n\n  run<TTable extends keyof TSchema['tables'] & string, TReturn>(\n    query: Query<TTable, TSchema, TReturn>,\n    options?: RunOptions,\n  ): Promise<HumanReadable<TReturn>> {\n    return this.#zeroContext.run(query, options);\n  }\n}\n\nexport function getZeroTxData(repTx: WriteTransaction): ZeroTxData {\n  const txData = must(\n    (repTx as WriteTransactionImpl)[zeroData],\n    'zero was not set on replicache internal options!',\n  );\n  return txData as ZeroTxData;\n}\n\nexport function makeReplicacheMutator<\n  S extends Schema,\n  TWrappedTransaction,\n  Context,\n>(\n  lc: LogContext,\n  mutator: CustomMutatorImpl<S, TWrappedTransaction>,\n  schema: S,\n  context: Context,\n): (repTx: WriteTransaction, args: ReadonlyJSONValue) => Promise<void> {\n  return async (\n    repTx: WriteTransaction,\n    args: ReadonlyJSONValue,\n  ): Promise<void> => {\n    const tx = new TransactionImpl(lc, repTx, schema);\n    await mutator(tx, args, context);\n  };\n}\n\nfunction assertValidRunOptions(options: RunOptions | undefined): void {\n  // TODO(arv): We should enforce this with the type system too.\n  assert(\n    options?.type !== 'complete' && options?.type !== 'cached',\n    'Cannot wait for cached or complete results in custom mutations',\n  );\n}\n\nfunction newZeroContext(lc: LogContext, ivmBranch: IVMSourceBranch) {\n  // The forked branch is already populated, so there is nothing to defer.\n  return new ZeroContext(\n    lc,\n    ivmBranch,\n    () => emptyFunction,\n    () => emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    applyViewUpdates => applyViewUpdates(),\n    emptyFunction,\n    assertValidRunOptions,\n  ).markPipelinesReady();\n}\n"],"mappings":";;;;;;;;;;AAoHA,IAAa,kBAAb,MAEwC;CACtC,WAAoB;CACpB;;;;CAIA;CAEA;CACA;CAEA,YAAY,IAAgB,OAAyB,QAAiB;EACpE,KAAK,MAAM,WAAW,aAAa,MAAM,WAAW,QAAQ;EAC5D,MAAM,SAAS,cAAc,KAAK;EAClC,MAAM,YAAY,OAAO;EAEzB,KAAKA,SAAS;EAEd,MAAM,WAAW,iBAAiB,OAAO,QAAQ,SAAS;EAC1D,KAAK,SAAS,sBAAsB,QAAQ,QAAQ;EAEpD,MAAM,cAAc,eAClB,IACA,OAAO,UACT;EAEA,KAAK,QAAQ,sBAAsB,aAAa,MAAM;EAEtD,KAAKC,eAAe;CACtB;CAEA,IAAI,WAAqB;EACvB,OAAO,KAAKD,OAAO;CACrB;CAEA,IAAI,aAAqB;EACvB,OAAO,KAAKA,OAAO;CACrB;CAEA,IAAI,SAAkC;EACpC,OAAO,KAAKA,OAAO,WAAW,YAAY,eAAe;CAC3D;CAEA,IAAI,QAA4B;EAC9B,OAAQ,KAAKA,OAAgC,WAAW;CAC1D;CAEA,IACE,OACA,SACiC;EACjC,OAAO,KAAKC,aAAa,IAAI,OAAO,OAAO;CAC7C;AACF;AAEA,SAAgB,cAAc,OAAqC;CAKjE,OAJe,KACZ,MAA+B,WAChC,kDAEK;AACT;AAEA,SAAgB,sBAKd,IACA,SACA,QACA,SACqE;CACrE,OAAO,OACL,OACA,SACkB;EAElB,MAAM,QAAQ,IADC,gBAAgB,IAAI,OAAO,MAC5B,GAAI,MAAM,OAAO;CACjC;AACF;AAEA,SAAS,sBAAsB,SAAuC;CAEpE,OACE,SAAS,SAAS,cAAc,SAAS,SAAS,UAClD,gEACF;AACF;AAEA,SAAS,eAAe,IAAgB,WAA4B;CAElE,OAAO,IAAI,YACT,IACA,iBACM,qBACA,eACN,eACA,eACA,gBACA,qBAAoB,iBAAiB,GACrC,eACA,qBACF,EAAE,mBAAmB;AACvB"}

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

@@ -128,6 +128,6 @@ function getErrorConnectionTransition(ex) {
 	};
 }
 //#endregion
-export { ClientError, NO_STATUS_TRANSITION, getBackoffParams, getErrorConnectionTransition, isAuthError, isClientError, isServerError, isZeroError };
+export { ClientError, NO_STATUS_TRANSITION, getBackoffParams, getErrorConnectionTransition, isClientError, isServerError, isZeroError };
 
 //# sourceMappingURL=error.js.map

package/out/zero-client/src/client/inspector/lazy-inspector.js

@@ -161,7 +161,7 @@ function clientMap(delegate, clientID) {
 	return withDagRead(delegate, async (dagRead) => {
 		const tree = await getBTree(dagRead, clientID);
 		const map = /* @__PURE__ */ new Map();
-		for await (const [key, value] of tree.scan("")) map.set(key, value);
+		for await (const [key, value] of tree.scan("", true)) map.set(key, value);
 		return map;
 	});
 }
@@ -170,7 +170,7 @@ function clientRows(delegate, clientID, tableName) {
 		const prefix = "e/" + tableName + "/";
 		const tree = await getBTree(dagRead, clientID);
 		const rows = [];
-		for await (const [key, value] of tree.scan(prefix)) {
+		for await (const [key, value] of tree.scan(prefix, false)) {
 			if (!key.startsWith(prefix)) break;
 			rows.push(value);
 		}