@rocicorp/zero 0.26.1-canary.9 → 0.26.2-canary.1

package/out/zero-client/src/client/mutation-tracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"mutation-tracker.js","sources":["../../../../../zero-client/src/client/mutation-tracker.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {resolver, type Resolver} from '@rocicorp/resolver';\nimport type {NoIndexDiff} from '../../../replicache/src/btree/node.ts';\nimport type {ReplicacheImpl} from '../../../replicache/src/impl.ts';\nimport type {\n  EphemeralID,\n  MutationTrackingData,\n} from '../../../replicache/src/replicache-options.ts';\nimport {assert, unreachable} from '../../../shared/src/asserts.ts';\nimport {getErrorDetails} from '../../../shared/src/error.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {emptyObject} from '../../../shared/src/sentinels.ts';\nimport * as v from '../../../shared/src/valita.ts';\nimport {\n  ApplicationError,\n  isApplicationError,\n  wrapWithApplicationError,\n} from '../../../zero-protocol/src/application-error.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport {ErrorOrigin} from '../../../zero-protocol/src/error-origin.ts';\nimport {ErrorReason} from '../../../zero-protocol/src/error-reason.ts';\nimport {ProtocolError} from '../../../zero-protocol/src/error.ts';\nimport {\n  mutationResultSchema,\n  type MutationError,\n  type MutationID,\n  type MutationOk,\n  type PushError,\n  type PushOk,\n  type PushResponseBody,\n} from '../../../zero-protocol/src/push.ts';\nimport type {MutatorResultSuccessDetails} from './custom.ts';\nimport {isZeroError, type ZeroError} from './error.ts';\nimport {MUTATIONS_KEY_PREFIX} from './keys.ts';\n\ntype MutationSuccessType = MutatorResultSuccessDetails;\ntype MutationErrorType = ApplicationError | ZeroError;\n\nlet currentEphemeralID = 0;\nfunction nextEphemeralID(): EphemeralID {\n  return ++currentEphemeralID as EphemeralID;\n}\n\nconst successResultDetails: MutationSuccessType = {type: 'success'};\n\n/**\n * Tracks what pushes are in-flight and resolves promises when they're acked.\n */\nexport class MutationTracker {\n  readonly #outstandingMutations: Map<\n    EphemeralID,\n    {\n      mutationID?: number | undefined;\n      resolver: Resolver<MutationSuccessType, MutationErrorType>;\n    }\n  >;\n  readonly #ephemeralIDsByMutationID: Map<number, EphemeralID>;\n  readonly #allMutationsAppliedListeners: Set<() => void>;\n  readonly #lc: LogContext;\n\n  readonly #ackMutations: (upTo: MutationID) => void;\n  readonly #onFatalError: (error: ZeroError) => void;\n\n  #clientID: string | undefined;\n  #largestOutstandingMutationID: number;\n  #currentMutationID: number;\n\n  constructor(\n    lc: LogContext,\n    ackMutations: (upTo: MutationID) => void,\n    onFatalError: (error: ZeroError) => void,\n  ) {\n    this.#lc = lc.withContext('MutationTracker');\n    this.#outstandingMutations = new Map();\n    this.#ephemeralIDsByMutationID = new Map();\n    this.#allMutationsAppliedListeners = new Set();\n    this.#largestOutstandingMutationID = 0;\n    this.#currentMutationID = 0;\n    this.#ackMutations = ackMutations;\n    this.#onFatalError = onFatalError;\n  }\n\n  setClientIDAndWatch(\n    clientID: string,\n    experimentalWatch: ReplicacheImpl['experimentalWatch'],\n  ) {\n    assert(this.#clientID === undefined, 'clientID already set');\n    this.#clientID = clientID;\n    experimentalWatch(\n      diffs => {\n        this.#processMutationResponses(diffs);\n      },\n      {\n        prefix: MUTATIONS_KEY_PREFIX + clientID + '/',\n        initialValuesInFirstDiff: true,\n      },\n    );\n  }\n\n  trackMutation(): MutationTrackingData<MutationSuccessType> {\n    const id = nextEphemeralID();\n    const mutationResolver = resolver<MutationSuccessType, MutationErrorType>();\n\n    this.#outstandingMutations.set(id, {\n      resolver: mutationResolver,\n    });\n    return {ephemeralID: id, serverPromise: mutationResolver.promise};\n  }\n\n  mutationIDAssigned(id: EphemeralID, mutationID: number): void {\n    const entry = this.#outstandingMutations.get(id);\n    if (entry) {\n      entry.mutationID = mutationID;\n      this.#ephemeralIDsByMutationID.set(mutationID, id);\n      this.#largestOutstandingMutationID = Math.max(\n        this.#largestOutstandingMutationID,\n        mutationID,\n      );\n    }\n  }\n\n  /**\n   * Reject the mutation due to an unhandled exception on the client.\n   * The mutation must not have been persisted to the client store.\n   */\n  rejectMutation(id: EphemeralID, e: unknown): void {\n    const entry = this.#outstandingMutations.get(id);\n    if (entry) {\n      this.#settleMutation(id, entry, wrapWithApplicationError(e));\n    }\n  }\n\n  /**\n   * Reject all outstanding mutations. Called when the client is in a state\n   * that prevents mutations from being applied, such as offline or closed.\n   */\n  rejectAllOutstandingMutations(error: ZeroError): void {\n    if (this.#outstandingMutations.size === 0) {\n      return;\n    }\n    for (const [id, entry] of this.#outstandingMutations) {\n      this.#settleMutation(id, entry, error);\n    }\n    this.#largestOutstandingMutationID = this.#currentMutationID;\n    this.#notifyAllMutationsAppliedListeners();\n  }\n\n  /**\n   * Used when zero-cache pokes down mutation results.\n   */\n  #processMutationResponses(diffs: NoIndexDiff): void {\n    const clientID = must(this.#clientID);\n    let largestLmid = 0;\n    for (const diff of diffs) {\n      const mutationID = Number(\n        diff.key.slice(MUTATIONS_KEY_PREFIX.length + clientID.length + 1),\n      );\n      assert(\n        !isNaN(mutationID),\n        `MutationTracker received a diff with an invalid mutation ID: ${diff.key}`,\n      );\n      largestLmid = Math.max(largestLmid, mutationID);\n      switch (diff.op) {\n        case 'add': {\n          const result = v.parse(diff.newValue, mutationResultSchema);\n          if ('error' in result) {\n            this.#processMutationError(clientID, mutationID, result);\n          } else {\n            this.#processMutationOk(clientID, mutationID, result);\n          }\n          break;\n        }\n        case 'del':\n          break;\n        case 'change':\n          throw new Error('MutationTracker does not expect change operations');\n      }\n    }\n\n    if (largestLmid > 0) {\n      this.#ackMutations({\n        clientID: must(this.#clientID),\n        id: largestLmid,\n      });\n    }\n  }\n\n  processPushResponse(response: PushResponseBody): void {\n    if ('error' in response) {\n      this.#lc.error?.(\n        'Received an error response when pushing mutations',\n        response,\n      );\n      const fatalError = this.#fatalErrorFromPushError(response);\n      if (fatalError) {\n        this.#onFatalError(fatalError);\n      }\n    } else {\n      this.#processPushOk(response);\n    }\n  }\n\n  #fatalErrorFromPushError(error: PushError): ZeroError | undefined {\n    switch (error.error) {\n      case 'unsupportedPushVersion':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.Internal,\n          message: `Unsupported push version`,\n          mutationIDs: [],\n        });\n      case 'unsupportedSchemaVersion':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.Internal,\n          message: `Unsupported schema version`,\n          mutationIDs: [],\n        });\n      case 'http':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.HTTP,\n          status: error.status,\n          message: `Fetch from API server returned non-OK status ${error.status}: ${error.details ?? 'unknown'}`,\n          mutationIDs: [],\n        });\n      case 'zeroPusher':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.Internal,\n          message: `ZeroPusher error: ${error.details ?? 'unknown'}`,\n          mutationIDs: [],\n        });\n      default:\n        unreachable(error);\n    }\n  }\n\n  /**\n   * DEPRECATED: to be removed when we switch to fully driving\n   * mutation resolution via poke.\n   *\n   * When we reconnect to zero-cache, we resolve all outstanding mutations\n   * whose ID is less than or equal to the lastMutationID.\n   *\n   * The reason is that any responses the API server sent\n   * to those mutations have been lost.\n   *\n   * An example case: the API server responds while the connection\n   * is down. Those responses are lost.\n   *\n   * Mutations whose LMID is > the lastMutationID are not resolved\n   * since they will be retried by the client, giving us another chance\n   * at getting a response.\n   *\n   * The only way to ensure that all API server responses are\n   * received would be to have the API server write them\n   * to the DB while writing the LMID.\n   */\n  onConnected(lastMutationID: number) {\n    this.lmidAdvanced(lastMutationID);\n  }\n\n  /**\n   * lmid advance will:\n   * 1. notify \"allMutationsApplied\" listeners if the lastMutationID\n   *    is greater than or equal to the largest outstanding mutation ID.\n   * 2. resolve all mutations whose mutation ID is less than or equal to\n   *    the lastMutationID.\n   */\n  lmidAdvanced(lastMutationID: number): void {\n    assert(\n      lastMutationID >= this.#currentMutationID,\n      'lmid must be greater than or equal to current lmid',\n    );\n    if (lastMutationID === this.#currentMutationID) {\n      return;\n    }\n\n    try {\n      this.#currentMutationID = lastMutationID;\n      this.#resolveMutations(lastMutationID);\n    } finally {\n      if (lastMutationID >= this.#largestOutstandingMutationID) {\n        // this is very important otherwise we hang query de-registration\n        this.#notifyAllMutationsAppliedListeners();\n      }\n    }\n  }\n\n  get size() {\n    return this.#outstandingMutations.size;\n  }\n\n  #resolveMutations(upTo: number): void {\n    // We resolve all mutations whose mutation ID is less than or equal to\n    // the upTo mutation ID.\n    for (const [id, entry] of this.#outstandingMutations) {\n      if (entry.mutationID && entry.mutationID <= upTo) {\n        this.#settleMutation(id, entry, emptyObject);\n      } else {\n        break; // the map is in insertion order which is in mutation ID order\n      }\n    }\n  }\n\n  #processPushOk(ok: PushOk): void {\n    for (const mutation of ok.mutations) {\n      if ('error' in mutation.result) {\n        this.#processMutationError(\n          mutation.id.clientID,\n          mutation.id.id,\n          mutation.result,\n        );\n      } else {\n        this.#processMutationOk(\n          mutation.id.clientID,\n          mutation.id.id,\n          mutation.result,\n        );\n      }\n    }\n  }\n\n  #processMutationError(\n    clientID: string,\n    mid: number,\n    error: MutationError | Omit<PushError, 'mutationIDs'>,\n  ): void {\n    assert(\n      clientID === this.#clientID,\n      'received mutation for the wrong client',\n    );\n\n    // Each tab sends all mutations for the client group\n    // and the server responds back to the individual client that actually\n    // ran the mutation. This means that N clients can send the same\n    // mutation concurrently. If that happens, the promise for the mutation tracked\n    // by this class will try to be resolved N times.\n    // Every time after the first, the ephemeral ID will not be found.\n    //\n    // We also reject all outstanding mutations when the client is in a state\n    // that prevents mutations from being applied, such as offline or closed.\n    // In this case, the ephemeral ID will also not be found.\n    const ephemeralID = this.#ephemeralIDsByMutationID.get(mid);\n    if (!ephemeralID) {\n      this.#lc.debug?.(\n        'Mutation already resolved or rejected (e.g. due to disconnect); ignore late reject.',\n      );\n      return;\n    }\n\n    const entry = this.#outstandingMutations.get(ephemeralID);\n    assert(\n      entry && entry.mutationID === mid,\n      `outstanding mutation not found for mutation ID ${mid} and ephemeral ID ${ephemeralID}`,\n    );\n\n    if (error.error === 'alreadyProcessed') {\n      this.#settleMutation(ephemeralID, entry, emptyObject);\n      return;\n    }\n\n    this.#settleMutation(\n      ephemeralID,\n      entry,\n      error.error === 'app'\n        ? new ApplicationError(\n            error.message ?? `Unknown application error: ${error.error}`,\n            error.details ? {details: error.details} : undefined,\n          )\n        : new ProtocolError({\n            kind: ErrorKind.InvalidPush,\n            origin: ErrorOrigin.Server,\n            reason: ErrorReason.Internal,\n            message:\n              error.error === 'oooMutation'\n                ? 'Server reported an out-of-order mutation'\n                : `Unknown fallback error with mutation ID ${mid}: ${error.error}`,\n            details: getErrorDetails(error),\n          }),\n    );\n\n    // this is included for backwards compatibility with the per-mutation fatal error responses\n    if (error.error === 'oooMutation') {\n      this.#onFatalError(\n        new ProtocolError({\n          kind: ErrorKind.InvalidPush,\n          origin: ErrorOrigin.Server,\n          reason: ErrorReason.Internal,\n          message: 'Server reported an out-of-order mutation',\n          details: error.details,\n        }),\n      );\n    }\n  }\n\n  #processMutationOk(clientID: string, mid: number, result: MutationOk): void {\n    assert(\n      clientID === this.#clientID,\n      'received mutation for the wrong client',\n    );\n\n    // We reject all outstanding mutations when the client is in a state\n    // that prevents mutations from being applied, such as offline or closed.\n    // In this case, the ephemeral ID will not be found.\n    const ephemeralID = this.#ephemeralIDsByMutationID.get(mid);\n    if (!ephemeralID) {\n      this.#lc.debug?.(\n        'Mutation already resolved or rejected (e.g. due to disconnect); ignore late resolve.',\n      );\n      return;\n    }\n\n    const entry = this.#outstandingMutations.get(ephemeralID);\n    assert(\n      entry && entry.mutationID === mid,\n      `outstanding mutation not found for mutation ID ${mid} and ephemeral ID ${ephemeralID}`,\n    );\n    this.#settleMutation(ephemeralID, entry, result);\n  }\n\n  #settleMutation<Result extends MutationOk | ApplicationError | ZeroError>(\n    ephemeralID: EphemeralID,\n    entry: {\n      mutationID?: number | undefined;\n      resolver: Resolver<MutationSuccessType, MutationErrorType>;\n    },\n    result: Result,\n  ): void {\n    if (isApplicationError(result) || isZeroError(result)) {\n      // we reject here and catch in the mutator proxy\n      // the mutator proxy catches both client and server errors\n      entry.resolver.reject(result);\n    } else {\n      entry.resolver.resolve(successResultDetails);\n    }\n\n    this.#outstandingMutations.delete(ephemeralID);\n    if (entry.mutationID) {\n      this.#ephemeralIDsByMutationID.delete(entry.mutationID);\n    }\n  }\n\n  /**\n   * Be notified when all mutations have been included in the server snapshot.\n   *\n   * The query manager will not de-register queries from the server until there\n   * are no pending mutations.\n   *\n   * The reason is that a mutation may need to be rebased. We do not want\n   * data that was available the first time it was run to not be available\n   * on a rebase.\n   */\n  onAllMutationsApplied(listener: () => void): void {\n    this.#allMutationsAppliedListeners.add(listener);\n  }\n\n  #notifyAllMutationsAppliedListeners() {\n    for (const listener of this.#allMutationsAppliedListeners) {\n      listener();\n    }\n  }\n}\n"],"names":["v.parse","ErrorKind.PushFailed","ErrorOrigin.ZeroCache","ErrorReason.Internal","ErrorReason.HTTP","ErrorKind.InvalidPush","ErrorOrigin.Server"],"mappings":";;;;;;;;;;;;;;AAsCA,IAAI,qBAAqB;AACzB,SAAS,kBAA+B;AACtC,SAAO,EAAE;AACX;AAEA,MAAM,uBAA4C,EAAC,MAAM,UAAA;AAKlD,MAAM,gBAAgB;AAAA,EAClB;AAAA,EAOA;AAAA,EACA;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EAET;AAAA,EACA;AAAA,EACA;AAAA,EAEA,YACE,IACA,cACA,cACA;AACA,SAAK,MAAM,GAAG,YAAY,iBAAiB;AAC3C,SAAK,4CAA4B,IAAA;AACjC,SAAK,gDAAgC,IAAA;AACrC,SAAK,oDAAoC,IAAA;AACzC,SAAK,gCAAgC;AACrC,SAAK,qBAAqB;AAC1B,SAAK,gBAAgB;AACrB,SAAK,gBAAgB;AAAA,EACvB;AAAA,EAEA,oBACE,UACA,mBACA;AACA,WAAO,KAAK,cAAc,QAAW,sBAAsB;AAC3D,SAAK,YAAY;AACjB;AAAA,MACE,CAAA,UAAS;AACP,aAAK,0BAA0B,KAAK;AAAA,MACtC;AAAA,MACA;AAAA,QACE,QAAQ,uBAAuB,WAAW;AAAA,QAC1C,0BAA0B;AAAA,MAAA;AAAA,IAC5B;AAAA,EAEJ;AAAA,EAEA,gBAA2D;AACzD,UAAM,KAAK,gBAAA;AACX,UAAM,mBAAmB,SAAA;AAEzB,SAAK,sBAAsB,IAAI,IAAI;AAAA,MACjC,UAAU;AAAA,IAAA,CACX;AACD,WAAO,EAAC,aAAa,IAAI,eAAe,iBAAiB,QAAA;AAAA,EAC3D;AAAA,EAEA,mBAAmB,IAAiB,YAA0B;AAC5D,UAAM,QAAQ,KAAK,sBAAsB,IAAI,EAAE;AAC/C,QAAI,OAAO;AACT,YAAM,aAAa;AACnB,WAAK,0BAA0B,IAAI,YAAY,EAAE;AACjD,WAAK,gCAAgC,KAAK;AAAA,QACxC,KAAK;AAAA,QACL;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,eAAe,IAAiB,GAAkB;AAChD,UAAM,QAAQ,KAAK,sBAAsB,IAAI,EAAE;AAC/C,QAAI,OAAO;AACT,WAAK,gBAAgB,IAAI,OAAO,yBAAyB,CAAC,CAAC;AAAA,IAC7D;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,8BAA8B,OAAwB;AACpD,QAAI,KAAK,sBAAsB,SAAS,GAAG;AACzC;AAAA,IACF;AACA,eAAW,CAAC,IAAI,KAAK,KAAK,KAAK,uBAAuB;AACpD,WAAK,gBAAgB,IAAI,OAAO,KAAK;AAAA,IACvC;AACA,SAAK,gCAAgC,KAAK;AAC1C,SAAK,oCAAA;AAAA,EACP;AAAA;AAAA;AAAA;AAAA,EAKA,0BAA0B,OAA0B;AAClD,UAAM,WAAW,KAAK,KAAK,SAAS;AACpC,QAAI,cAAc;AAClB,eAAW,QAAQ,OAAO;AACxB,YAAM,aAAa;AAAA,QACjB,KAAK,IAAI,MAAM,qBAAqB,SAAS,SAAS,SAAS,CAAC;AAAA,MAAA;AAElE;AAAA,QACE,CAAC,MAAM,UAAU;AAAA,QACjB,gEAAgE,KAAK,GAAG;AAAA,MAAA;AAE1E,oBAAc,KAAK,IAAI,aAAa,UAAU;AAC9C,cAAQ,KAAK,IAAA;AAAA,QACX,KAAK,OAAO;AACV,gBAAM,SAASA,MAAQ,KAAK,UAAU,oBAAoB;AAC1D,cAAI,WAAW,QAAQ;AACrB,iBAAK,sBAAsB,UAAU,YAAY,MAAM;AAAA,UACzD,OAAO;AACL,iBAAK,mBAAmB,UAAU,YAAY,MAAM;AAAA,UACtD;AACA;AAAA,QACF;AAAA,QACA,KAAK;AACH;AAAA,QACF,KAAK;AACH,gBAAM,IAAI,MAAM,mDAAmD;AAAA,MAAA;AAAA,IAEzE;AAEA,QAAI,cAAc,GAAG;AACnB,WAAK,cAAc;AAAA,QACjB,UAAU,KAAK,KAAK,SAAS;AAAA,QAC7B,IAAI;AAAA,MAAA,CACL;AAAA,IACH;AAAA,EACF;AAAA,EAEA,oBAAoB,UAAkC;AACpD,QAAI,WAAW,UAAU;AACvB,WAAK,IAAI;AAAA,QACP;AAAA,QACA;AAAA,MAAA;AAEF,YAAM,aAAa,KAAK,yBAAyB,QAAQ;AACzD,UAAI,YAAY;AACd,aAAK,cAAc,UAAU;AAAA,MAC/B;AAAA,IACF,OAAO;AACL,WAAK,eAAe,QAAQ;AAAA,IAC9B;AAAA,EACF;AAAA,EAEA,yBAAyB,OAAyC;AAChE,YAAQ,MAAM,OAAA;AAAA,MACZ,KAAK;AACH,eAAO,IAAI,cAAc;AAAA,UACvB,MAAMC;AAAAA,UACN,QAAQC;AAAAA,UACR,QAAQC;AAAAA,UACR,SAAS;AAAA,UACT,aAAa,CAAA;AAAA,QAAC,CACf;AAAA,MACH,KAAK;AACH,eAAO,IAAI,cAAc;AAAA,UACvB,MAAMF;AAAAA,UACN,QAAQC;AAAAA,UACR,QAAQC;AAAAA,UACR,SAAS;AAAA,UACT,aAAa,CAAA;AAAA,QAAC,CACf;AAAA,MACH,KAAK;AACH,eAAO,IAAI,cAAc;AAAA,UACvB,MAAMF;AAAAA,UACN,QAAQC;AAAAA,UACR,QAAQE;AAAAA,UACR,QAAQ,MAAM;AAAA,UACd,SAAS,gDAAgD,MAAM,MAAM,KAAK,MAAM,WAAW,SAAS;AAAA,UACpG,aAAa,CAAA;AAAA,QAAC,CACf;AAAA,MACH,KAAK;AACH,eAAO,IAAI,cAAc;AAAA,UACvB,MAAMH;AAAAA,UACN,QAAQC;AAAAA,UACR,QAAQC;AAAAA,UACR,SAAS,qBAAqB,MAAM,WAAW,SAAS;AAAA,UACxD,aAAa,CAAA;AAAA,QAAC,CACf;AAAA,MACH;AACE,oBAAiB;AAAA,IAAA;AAAA,EAEvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,YAAY,gBAAwB;AAClC,SAAK,aAAa,cAAc;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,aAAa,gBAA8B;AACzC;AAAA,MACE,kBAAkB,KAAK;AAAA,MACvB;AAAA,IAAA;AAEF,QAAI,mBAAmB,KAAK,oBAAoB;AAC9C;AAAA,IACF;AAEA,QAAI;AACF,WAAK,qBAAqB;AAC1B,WAAK,kBAAkB,cAAc;AAAA,IACvC,UAAA;AACE,UAAI,kBAAkB,KAAK,+BAA+B;AAExD,aAAK,oCAAA;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,sBAAsB;AAAA,EACpC;AAAA,EAEA,kBAAkB,MAAoB;AAGpC,eAAW,CAAC,IAAI,KAAK,KAAK,KAAK,uBAAuB;AACpD,UAAI,MAAM,cAAc,MAAM,cAAc,MAAM;AAChD,aAAK,gBAAgB,IAAI,OAAO,WAAW;AAAA,MAC7C,OAAO;AACL;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,eAAe,IAAkB;AAC/B,eAAW,YAAY,GAAG,WAAW;AACnC,UAAI,WAAW,SAAS,QAAQ;AAC9B,aAAK;AAAA,UACH,SAAS,GAAG;AAAA,UACZ,SAAS,GAAG;AAAA,UACZ,SAAS;AAAA,QAAA;AAAA,MAEb,OAAO;AACL,aAAK;AAAA,UACH,SAAS,GAAG;AAAA,UACZ,SAAS,GAAG;AAAA,UACZ,SAAS;AAAA,QAAA;AAAA,MAEb;AAAA,IACF;AAAA,EACF;AAAA,EAEA,sBACE,UACA,KACA,OACM;AACN;AAAA,MACE,aAAa,KAAK;AAAA,MAClB;AAAA,IAAA;AAaF,UAAM,cAAc,KAAK,0BAA0B,IAAI,GAAG;AAC1D,QAAI,CAAC,aAAa;AAChB,WAAK,IAAI;AAAA,QACP;AAAA,MAAA;AAEF;AAAA,IACF;AAEA,UAAM,QAAQ,KAAK,sBAAsB,IAAI,WAAW;AACxD;AAAA,MACE,SAAS,MAAM,eAAe;AAAA,MAC9B,kDAAkD,GAAG,qBAAqB,WAAW;AAAA,IAAA;AAGvF,QAAI,MAAM,UAAU,oBAAoB;AACtC,WAAK,gBAAgB,aAAa,OAAO,WAAW;AACpD;AAAA,IACF;AAEA,SAAK;AAAA,MACH;AAAA,MACA;AAAA,MACA,MAAM,UAAU,QACZ,IAAI;AAAA,QACF,MAAM,WAAW,8BAA8B,MAAM,KAAK;AAAA,QAC1D,MAAM,UAAU,EAAC,SAAS,MAAM,YAAW;AAAA,MAAA,IAE7C,IAAI,cAAc;AAAA,QAChB,MAAME;AAAAA,QACN,QAAQC;AAAAA,QACR,QAAQH;AAAAA,QACR,SACE,MAAM,UAAU,gBACZ,6CACA,2CAA2C,GAAG,KAAK,MAAM,KAAK;AAAA,QACpE,SAAS,gBAAgB,KAAK;AAAA,MAAA,CAC/B;AAAA,IAAA;AAIP,QAAI,MAAM,UAAU,eAAe;AACjC,WAAK;AAAA,QACH,IAAI,cAAc;AAAA,UAChB,MAAME;AAAAA,UACN,QAAQC;AAAAA,UACR,QAAQH;AAAAA,UACR,SAAS;AAAA,UACT,SAAS,MAAM;AAAA,QAAA,CAChB;AAAA,MAAA;AAAA,IAEL;AAAA,EACF;AAAA,EAEA,mBAAmB,UAAkB,KAAa,QAA0B;AAC1E;AAAA,MACE,aAAa,KAAK;AAAA,MAClB;AAAA,IAAA;AAMF,UAAM,cAAc,KAAK,0BAA0B,IAAI,GAAG;AAC1D,QAAI,CAAC,aAAa;AAChB,WAAK,IAAI;AAAA,QACP;AAAA,MAAA;AAEF;AAAA,IACF;AAEA,UAAM,QAAQ,KAAK,sBAAsB,IAAI,WAAW;AACxD;AAAA,MACE,SAAS,MAAM,eAAe;AAAA,MAC9B,kDAAkD,GAAG,qBAAqB,WAAW;AAAA,IAAA;AAEvF,SAAK,gBAAgB,aAAa,OAAO,MAAM;AAAA,EACjD;AAAA,EAEA,gBACE,aACA,OAIA,QACM;AACN,QAAI,mBAAmB,MAAM,KAAK,YAAY,MAAM,GAAG;AAGrD,YAAM,SAAS,OAAO,MAAM;AAAA,IAC9B,OAAO;AACL,YAAM,SAAS,QAAQ,oBAAoB;AAAA,IAC7C;AAEA,SAAK,sBAAsB,OAAO,WAAW;AAC7C,QAAI,MAAM,YAAY;AACpB,WAAK,0BAA0B,OAAO,MAAM,UAAU;AAAA,IACxD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,sBAAsB,UAA4B;AAChD,SAAK,8BAA8B,IAAI,QAAQ;AAAA,EACjD;AAAA,EAEA,sCAAsC;AACpC,eAAW,YAAY,KAAK,+BAA+B;AACzD,eAAA;AAAA,IACF;AAAA,EACF;AACF;"}
+{"version":3,"file":"mutation-tracker.js","names":["#outstandingMutations","#ephemeralIDsByMutationID","#allMutationsAppliedListeners","#lc","#ackMutations","#onFatalError","#largestOutstandingMutationID","#currentMutationID","#clientID","#processMutationResponses","#settleMutation","#notifyAllMutationsAppliedListeners","#processMutationError","#processMutationOk","#fatalErrorFromPushError","#processPushOk","#resolveMutations"],"sources":["../../../../../zero-client/src/client/mutation-tracker.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {resolver, type Resolver} from '@rocicorp/resolver';\nimport type {NoIndexDiff} from '../../../replicache/src/btree/node.ts';\nimport type {ReplicacheImpl} from '../../../replicache/src/impl.ts';\nimport type {\n  EphemeralID,\n  MutationTrackingData,\n} from '../../../replicache/src/replicache-options.ts';\nimport {assert, unreachable} from '../../../shared/src/asserts.ts';\nimport {getErrorDetails} from '../../../shared/src/error.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {emptyObject} from '../../../shared/src/sentinels.ts';\nimport * as v from '../../../shared/src/valita.ts';\nimport {\n  ApplicationError,\n  isApplicationError,\n  wrapWithApplicationError,\n} from '../../../zero-protocol/src/application-error.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport {ErrorOrigin} from '../../../zero-protocol/src/error-origin.ts';\nimport {ErrorReason} from '../../../zero-protocol/src/error-reason.ts';\nimport {ProtocolError} from '../../../zero-protocol/src/error.ts';\nimport {\n  mutationResultSchema,\n  type MutationError,\n  type MutationID,\n  type MutationOk,\n  type PushError,\n  type PushOk,\n  type PushResponseBody,\n} from '../../../zero-protocol/src/push.ts';\nimport type {MutatorResultSuccessDetails} from './custom.ts';\nimport {isZeroError, type ZeroError} from './error.ts';\nimport {MUTATIONS_KEY_PREFIX} from './keys.ts';\n\ntype MutationSuccessType = MutatorResultSuccessDetails;\ntype MutationErrorType = ApplicationError | ZeroError;\n\nlet currentEphemeralID = 0;\nfunction nextEphemeralID(): EphemeralID {\n  return ++currentEphemeralID as EphemeralID;\n}\n\nconst successResultDetails: MutationSuccessType = {type: 'success'};\n\n/**\n * Tracks what pushes are in-flight and resolves promises when they're acked.\n */\nexport class MutationTracker {\n  readonly #outstandingMutations: Map<\n    EphemeralID,\n    {\n      mutationID?: number | undefined;\n      resolver: Resolver<MutationSuccessType, MutationErrorType>;\n    }\n  >;\n  readonly #ephemeralIDsByMutationID: Map<number, EphemeralID>;\n  readonly #allMutationsAppliedListeners: Set<() => void>;\n  readonly #lc: LogContext;\n\n  readonly #ackMutations: (upTo: MutationID) => void;\n  readonly #onFatalError: (error: ZeroError) => void;\n\n  #clientID: string | undefined;\n  #largestOutstandingMutationID: number;\n  #currentMutationID: number;\n\n  constructor(\n    lc: LogContext,\n    ackMutations: (upTo: MutationID) => void,\n    onFatalError: (error: ZeroError) => void,\n  ) {\n    this.#lc = lc.withContext('MutationTracker');\n    this.#outstandingMutations = new Map();\n    this.#ephemeralIDsByMutationID = new Map();\n    this.#allMutationsAppliedListeners = new Set();\n    this.#largestOutstandingMutationID = 0;\n    this.#currentMutationID = 0;\n    this.#ackMutations = ackMutations;\n    this.#onFatalError = onFatalError;\n  }\n\n  setClientIDAndWatch(\n    clientID: string,\n    experimentalWatch: ReplicacheImpl['experimentalWatch'],\n  ) {\n    assert(this.#clientID === undefined, 'clientID already set');\n    this.#clientID = clientID;\n    experimentalWatch(\n      diffs => {\n        this.#processMutationResponses(diffs);\n      },\n      {\n        prefix: MUTATIONS_KEY_PREFIX + clientID + '/',\n        initialValuesInFirstDiff: true,\n      },\n    );\n  }\n\n  trackMutation(): MutationTrackingData<MutationSuccessType> {\n    const id = nextEphemeralID();\n    const mutationResolver = resolver<MutationSuccessType, MutationErrorType>();\n\n    this.#outstandingMutations.set(id, {\n      resolver: mutationResolver,\n    });\n    return {ephemeralID: id, serverPromise: mutationResolver.promise};\n  }\n\n  mutationIDAssigned(id: EphemeralID, mutationID: number): void {\n    const entry = this.#outstandingMutations.get(id);\n    if (entry) {\n      entry.mutationID = mutationID;\n      this.#ephemeralIDsByMutationID.set(mutationID, id);\n      this.#largestOutstandingMutationID = Math.max(\n        this.#largestOutstandingMutationID,\n        mutationID,\n      );\n    }\n  }\n\n  /**\n   * Reject the mutation due to an unhandled exception on the client.\n   * The mutation must not have been persisted to the client store.\n   */\n  rejectMutation(id: EphemeralID, e: unknown): void {\n    const entry = this.#outstandingMutations.get(id);\n    if (entry) {\n      this.#settleMutation(id, entry, wrapWithApplicationError(e));\n    }\n  }\n\n  /**\n   * Reject all outstanding mutations. Called when the client is in a state\n   * that prevents mutations from being applied, such as offline or closed.\n   */\n  rejectAllOutstandingMutations(error: ZeroError): void {\n    if (this.#outstandingMutations.size === 0) {\n      return;\n    }\n    for (const [id, entry] of this.#outstandingMutations) {\n      this.#settleMutation(id, entry, error);\n    }\n    this.#largestOutstandingMutationID = this.#currentMutationID;\n    this.#notifyAllMutationsAppliedListeners();\n  }\n\n  /**\n   * Used when zero-cache pokes down mutation results.\n   */\n  #processMutationResponses(diffs: NoIndexDiff): void {\n    const clientID = must(this.#clientID);\n    let largestLmid = 0;\n    for (const diff of diffs) {\n      const mutationID = Number(\n        diff.key.slice(MUTATIONS_KEY_PREFIX.length + clientID.length + 1),\n      );\n      assert(\n        !isNaN(mutationID),\n        `MutationTracker received a diff with an invalid mutation ID: ${diff.key}`,\n      );\n      largestLmid = Math.max(largestLmid, mutationID);\n      switch (diff.op) {\n        case 'add': {\n          const result = v.parse(diff.newValue, mutationResultSchema);\n          if ('error' in result) {\n            this.#processMutationError(clientID, mutationID, result);\n          } else {\n            this.#processMutationOk(clientID, mutationID, result);\n          }\n          break;\n        }\n        case 'del':\n          break;\n        case 'change':\n          throw new Error('MutationTracker does not expect change operations');\n      }\n    }\n\n    if (largestLmid > 0) {\n      this.#ackMutations({\n        clientID: must(this.#clientID),\n        id: largestLmid,\n      });\n    }\n  }\n\n  processPushResponse(response: PushResponseBody): void {\n    if ('error' in response) {\n      this.#lc.error?.(\n        'Received an error response when pushing mutations',\n        response,\n      );\n      const fatalError = this.#fatalErrorFromPushError(response);\n      if (fatalError) {\n        this.#onFatalError(fatalError);\n      }\n    } else {\n      this.#processPushOk(response);\n    }\n  }\n\n  #fatalErrorFromPushError(error: PushError): ZeroError | undefined {\n    switch (error.error) {\n      case 'unsupportedPushVersion':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.Internal,\n          message: `Unsupported push version`,\n          mutationIDs: [],\n        });\n      case 'unsupportedSchemaVersion':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.Internal,\n          message: `Unsupported schema version`,\n          mutationIDs: [],\n        });\n      case 'http':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.HTTP,\n          status: error.status,\n          message: `Fetch from API server returned non-OK status ${error.status}: ${error.details ?? 'unknown'}`,\n          mutationIDs: [],\n        });\n      case 'zeroPusher':\n        return new ProtocolError({\n          kind: ErrorKind.PushFailed,\n          origin: ErrorOrigin.ZeroCache,\n          reason: ErrorReason.Internal,\n          message: `ZeroPusher error: ${error.details ?? 'unknown'}`,\n          mutationIDs: [],\n        });\n      default:\n        unreachable(error);\n    }\n  }\n\n  /**\n   * DEPRECATED: to be removed when we switch to fully driving\n   * mutation resolution via poke.\n   *\n   * When we reconnect to zero-cache, we resolve all outstanding mutations\n   * whose ID is less than or equal to the lastMutationID.\n   *\n   * The reason is that any responses the API server sent\n   * to those mutations have been lost.\n   *\n   * An example case: the API server responds while the connection\n   * is down. Those responses are lost.\n   *\n   * Mutations whose LMID is > the lastMutationID are not resolved\n   * since they will be retried by the client, giving us another chance\n   * at getting a response.\n   *\n   * The only way to ensure that all API server responses are\n   * received would be to have the API server write them\n   * to the DB while writing the LMID.\n   */\n  onConnected(lastMutationID: number) {\n    this.lmidAdvanced(lastMutationID);\n  }\n\n  /**\n   * lmid advance will:\n   * 1. notify \"allMutationsApplied\" listeners if the lastMutationID\n   *    is greater than or equal to the largest outstanding mutation ID.\n   * 2. resolve all mutations whose mutation ID is less than or equal to\n   *    the lastMutationID.\n   */\n  lmidAdvanced(lastMutationID: number): void {\n    assert(\n      lastMutationID >= this.#currentMutationID,\n      'lmid must be greater than or equal to current lmid',\n    );\n    if (lastMutationID === this.#currentMutationID) {\n      return;\n    }\n\n    try {\n      this.#currentMutationID = lastMutationID;\n      this.#resolveMutations(lastMutationID);\n    } finally {\n      if (lastMutationID >= this.#largestOutstandingMutationID) {\n        // this is very important otherwise we hang query de-registration\n        this.#notifyAllMutationsAppliedListeners();\n      }\n    }\n  }\n\n  get size() {\n    return this.#outstandingMutations.size;\n  }\n\n  #resolveMutations(upTo: number): void {\n    // We resolve all mutations whose mutation ID is less than or equal to\n    // the upTo mutation ID.\n    for (const [id, entry] of this.#outstandingMutations) {\n      if (entry.mutationID && entry.mutationID <= upTo) {\n        this.#settleMutation(id, entry, emptyObject);\n      } else {\n        break; // the map is in insertion order which is in mutation ID order\n      }\n    }\n  }\n\n  #processPushOk(ok: PushOk): void {\n    for (const mutation of ok.mutations) {\n      if ('error' in mutation.result) {\n        this.#processMutationError(\n          mutation.id.clientID,\n          mutation.id.id,\n          mutation.result,\n        );\n      } else {\n        this.#processMutationOk(\n          mutation.id.clientID,\n          mutation.id.id,\n          mutation.result,\n        );\n      }\n    }\n  }\n\n  #processMutationError(\n    clientID: string,\n    mid: number,\n    error: MutationError | Omit<PushError, 'mutationIDs'>,\n  ): void {\n    assert(\n      clientID === this.#clientID,\n      'received mutation for the wrong client',\n    );\n\n    // Each tab sends all mutations for the client group\n    // and the server responds back to the individual client that actually\n    // ran the mutation. This means that N clients can send the same\n    // mutation concurrently. If that happens, the promise for the mutation tracked\n    // by this class will try to be resolved N times.\n    // Every time after the first, the ephemeral ID will not be found.\n    //\n    // We also reject all outstanding mutations when the client is in a state\n    // that prevents mutations from being applied, such as offline or closed.\n    // In this case, the ephemeral ID will also not be found.\n    const ephemeralID = this.#ephemeralIDsByMutationID.get(mid);\n    if (!ephemeralID) {\n      this.#lc.debug?.(\n        'Mutation already resolved or rejected (e.g. due to disconnect); ignore late reject.',\n      );\n      return;\n    }\n\n    const entry = this.#outstandingMutations.get(ephemeralID);\n    assert(\n      entry && entry.mutationID === mid,\n      `outstanding mutation not found for mutation ID ${mid} and ephemeral ID ${ephemeralID}`,\n    );\n\n    if (error.error === 'alreadyProcessed') {\n      this.#settleMutation(ephemeralID, entry, emptyObject);\n      return;\n    }\n\n    this.#settleMutation(\n      ephemeralID,\n      entry,\n      error.error === 'app'\n        ? new ApplicationError(\n            error.message ?? `Unknown application error: ${error.error}`,\n            error.details ? {details: error.details} : undefined,\n          )\n        : new ProtocolError({\n            kind: ErrorKind.InvalidPush,\n            origin: ErrorOrigin.Server,\n            reason: ErrorReason.Internal,\n            message:\n              error.error === 'oooMutation'\n                ? 'Server reported an out-of-order mutation'\n                : `Unknown fallback error with mutation ID ${mid}: ${error.error}`,\n            details: getErrorDetails(error),\n          }),\n    );\n\n    // this is included for backwards compatibility with the per-mutation fatal error responses\n    if (error.error === 'oooMutation') {\n      this.#onFatalError(\n        new ProtocolError({\n          kind: ErrorKind.InvalidPush,\n          origin: ErrorOrigin.Server,\n          reason: ErrorReason.Internal,\n          message: 'Server reported an out-of-order mutation',\n          details: error.details,\n        }),\n      );\n    }\n  }\n\n  #processMutationOk(clientID: string, mid: number, result: MutationOk): void {\n    assert(\n      clientID === this.#clientID,\n      'received mutation for the wrong client',\n    );\n\n    // We reject all outstanding mutations when the client is in a state\n    // that prevents mutations from being applied, such as offline or closed.\n    // In this case, the ephemeral ID will not be found.\n    const ephemeralID = this.#ephemeralIDsByMutationID.get(mid);\n    if (!ephemeralID) {\n      this.#lc.debug?.(\n        'Mutation already resolved or rejected (e.g. due to disconnect); ignore late resolve.',\n      );\n      return;\n    }\n\n    const entry = this.#outstandingMutations.get(ephemeralID);\n    assert(\n      entry && entry.mutationID === mid,\n      `outstanding mutation not found for mutation ID ${mid} and ephemeral ID ${ephemeralID}`,\n    );\n    this.#settleMutation(ephemeralID, entry, result);\n  }\n\n  #settleMutation<Result extends MutationOk | ApplicationError | ZeroError>(\n    ephemeralID: EphemeralID,\n    entry: {\n      mutationID?: number | undefined;\n      resolver: Resolver<MutationSuccessType, MutationErrorType>;\n    },\n    result: Result,\n  ): void {\n    if (isApplicationError(result) || isZeroError(result)) {\n      // we reject here and catch in the mutator proxy\n      // the mutator proxy catches both client and server errors\n      entry.resolver.reject(result);\n    } else {\n      entry.resolver.resolve(successResultDetails);\n    }\n\n    this.#outstandingMutations.delete(ephemeralID);\n    if (entry.mutationID) {\n      this.#ephemeralIDsByMutationID.delete(entry.mutationID);\n    }\n  }\n\n  /**\n   * Be notified when all mutations have been included in the server snapshot.\n   *\n   * The query manager will not de-register queries from the server until there\n   * are no pending mutations.\n   *\n   * The reason is that a mutation may need to be rebased. We do not want\n   * data that was available the first time it was run to not be available\n   * on a rebase.\n   */\n  onAllMutationsApplied(listener: () => void): void {\n    this.#allMutationsAppliedListeners.add(listener);\n  }\n\n  #notifyAllMutationsAppliedListeners() {\n    for (const listener of this.#allMutationsAppliedListeners) {\n      listener();\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;AAsCA,IAAI,qBAAqB;AACzB,SAAS,kBAA+B;AACtC,QAAO,EAAE;;AAGX,IAAM,uBAA4C,EAAC,MAAM,WAAU;;;;AAKnE,IAAa,kBAAb,MAA6B;CAC3B;CAOA;CACA;CACA;CAEA;CACA;CAEA;CACA;CACA;CAEA,YACE,IACA,cACA,cACA;AACA,QAAA,KAAW,GAAG,YAAY,kBAAkB;AAC5C,QAAA,uCAA6B,IAAI,KAAK;AACtC,QAAA,2CAAiC,IAAI,KAAK;AAC1C,QAAA,+CAAqC,IAAI,KAAK;AAC9C,QAAA,+BAAqC;AACrC,QAAA,oBAA0B;AAC1B,QAAA,eAAqB;AACrB,QAAA,eAAqB;;CAGvB,oBACE,UACA,mBACA;AACA,SAAO,MAAA,aAAmB,KAAA,GAAW,uBAAuB;AAC5D,QAAA,WAAiB;AACjB,qBACE,UAAS;AACP,SAAA,yBAA+B,MAAM;KAEvC;GACE,QAAA,OAA+B,WAAW;GAC1C,0BAA0B;GAC3B,CACF;;CAGH,gBAA2D;EACzD,MAAM,KAAK,iBAAiB;EAC5B,MAAM,mBAAmB,UAAkD;AAE3E,QAAA,qBAA2B,IAAI,IAAI,EACjC,UAAU,kBACX,CAAC;AACF,SAAO;GAAC,aAAa;GAAI,eAAe,iBAAiB;GAAQ;;CAGnE,mBAAmB,IAAiB,YAA0B;EAC5D,MAAM,QAAQ,MAAA,qBAA2B,IAAI,GAAG;AAChD,MAAI,OAAO;AACT,SAAM,aAAa;AACnB,SAAA,yBAA+B,IAAI,YAAY,GAAG;AAClD,SAAA,+BAAqC,KAAK,IACxC,MAAA,8BACA,WACD;;;;;;;CAQL,eAAe,IAAiB,GAAkB;EAChD,MAAM,QAAQ,MAAA,qBAA2B,IAAI,GAAG;AAChD,MAAI,MACF,OAAA,eAAqB,IAAI,OAAO,yBAAyB,EAAE,CAAC;;;;;;CAQhE,8BAA8B,OAAwB;AACpD,MAAI,MAAA,qBAA2B,SAAS,EACtC;AAEF,OAAK,MAAM,CAAC,IAAI,UAAU,MAAA,qBACxB,OAAA,eAAqB,IAAI,OAAO,MAAM;AAExC,QAAA,+BAAqC,MAAA;AACrC,QAAA,oCAA0C;;;;;CAM5C,0BAA0B,OAA0B;EAClD,MAAM,WAAW,KAAK,MAAA,SAAe;EACrC,IAAI,cAAc;AAClB,OAAK,MAAM,QAAQ,OAAO;GACxB,MAAM,aAAa,OACjB,KAAK,IAAI,MAAA,IAAoC,SAAS,SAAS,EAAE,CAClE;AACD,UACE,CAAC,MAAM,WAAW,EAClB,gEAAgE,KAAK,MACtE;AACD,iBAAc,KAAK,IAAI,aAAa,WAAW;AAC/C,WAAQ,KAAK,IAAb;IACE,KAAK,OAAO;KACV,MAAM,SAAS,MAAQ,KAAK,UAAU,qBAAqB;AAC3D,SAAI,WAAW,OACb,OAAA,qBAA2B,UAAU,YAAY,OAAO;SAExD,OAAA,kBAAwB,UAAU,YAAY,OAAO;AAEvD;;IAEF,KAAK,MACH;IACF,KAAK,SACH,OAAM,IAAI,MAAM,oDAAoD;;;AAI1E,MAAI,cAAc,EAChB,OAAA,aAAmB;GACjB,UAAU,KAAK,MAAA,SAAe;GAC9B,IAAI;GACL,CAAC;;CAIN,oBAAoB,UAAkC;AACpD,MAAI,WAAW,UAAU;AACvB,SAAA,GAAS,QACP,qDACA,SACD;GACD,MAAM,aAAa,MAAA,wBAA8B,SAAS;AAC1D,OAAI,WACF,OAAA,aAAmB,WAAW;QAGhC,OAAA,cAAoB,SAAS;;CAIjC,yBAAyB,OAAyC;AAChE,UAAQ,MAAM,OAAd;GACE,KAAK,yBACH,QAAO,IAAI,cAAc;IACvB,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,aAAa,EAAE;IAChB,CAAC;GACJ,KAAK,2BACH,QAAO,IAAI,cAAc;IACvB,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,aAAa,EAAE;IAChB,CAAC;GACJ,KAAK,OACH,QAAO,IAAI,cAAc;IACvB,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,QAAQ,MAAM;IACd,SAAS,gDAAgD,MAAM,OAAO,IAAI,MAAM,WAAW;IAC3F,aAAa,EAAE;IAChB,CAAC;GACJ,KAAK,aACH,QAAO,IAAI,cAAc;IACvB,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,SAAS,qBAAqB,MAAM,WAAW;IAC/C,aAAa,EAAE;IAChB,CAAC;GACJ,QACE,aAAY,MAAM;;;;;;;;;;;;;;;;;;;;;;;;CAyBxB,YAAY,gBAAwB;AAClC,OAAK,aAAa,eAAe;;;;;;;;;CAUnC,aAAa,gBAA8B;AACzC,SACE,kBAAkB,MAAA,mBAClB,qDACD;AACD,MAAI,mBAAmB,MAAA,kBACrB;AAGF,MAAI;AACF,SAAA,oBAA0B;AAC1B,SAAA,iBAAuB,eAAe;YAC9B;AACR,OAAI,kBAAkB,MAAA,6BAEpB,OAAA,oCAA0C;;;CAKhD,IAAI,OAAO;AACT,SAAO,MAAA,qBAA2B;;CAGpC,kBAAkB,MAAoB;AAGpC,OAAK,MAAM,CAAC,IAAI,UAAU,MAAA,qBACxB,KAAI,MAAM,cAAc,MAAM,cAAc,KAC1C,OAAA,eAAqB,IAAI,OAAO,YAAY;MAE5C;;CAKN,eAAe,IAAkB;AAC/B,OAAK,MAAM,YAAY,GAAG,UACxB,KAAI,WAAW,SAAS,OACtB,OAAA,qBACE,SAAS,GAAG,UACZ,SAAS,GAAG,IACZ,SAAS,OACV;MAED,OAAA,kBACE,SAAS,GAAG,UACZ,SAAS,GAAG,IACZ,SAAS,OACV;;CAKP,sBACE,UACA,KACA,OACM;AACN,SACE,aAAa,MAAA,UACb,yCACD;EAYD,MAAM,cAAc,MAAA,yBAA+B,IAAI,IAAI;AAC3D,MAAI,CAAC,aAAa;AAChB,SAAA,GAAS,QACP,sFACD;AACD;;EAGF,MAAM,QAAQ,MAAA,qBAA2B,IAAI,YAAY;AACzD,SACE,SAAS,MAAM,eAAe,KAC9B,kDAAkD,IAAI,oBAAoB,cAC3E;AAED,MAAI,MAAM,UAAU,oBAAoB;AACtC,SAAA,eAAqB,aAAa,OAAO,YAAY;AACrD;;AAGF,QAAA,eACE,aACA,OACA,MAAM,UAAU,QACZ,IAAI,iBACF,MAAM,WAAW,8BAA8B,MAAM,SACrD,MAAM,UAAU,EAAC,SAAS,MAAM,SAAQ,GAAG,KAAA,EAC5C,GACD,IAAI,cAAc;GAChB,MAAM;GACN,QAAQ;GACR,QAAQ;GACR,SACE,MAAM,UAAU,gBACZ,6CACA,2CAA2C,IAAI,IAAI,MAAM;GAC/D,SAAS,gBAAgB,MAAM;GAChC,CAAC,CACP;AAGD,MAAI,MAAM,UAAU,cAClB,OAAA,aACE,IAAI,cAAc;GAChB,MAAM;GACN,QAAQ;GACR,QAAQ;GACR,SAAS;GACT,SAAS,MAAM;GAChB,CAAC,CACH;;CAIL,mBAAmB,UAAkB,KAAa,QAA0B;AAC1E,SACE,aAAa,MAAA,UACb,yCACD;EAKD,MAAM,cAAc,MAAA,yBAA+B,IAAI,IAAI;AAC3D,MAAI,CAAC,aAAa;AAChB,SAAA,GAAS,QACP,uFACD;AACD;;EAGF,MAAM,QAAQ,MAAA,qBAA2B,IAAI,YAAY;AACzD,SACE,SAAS,MAAM,eAAe,KAC9B,kDAAkD,IAAI,oBAAoB,cAC3E;AACD,QAAA,eAAqB,aAAa,OAAO,OAAO;;CAGlD,gBACE,aACA,OAIA,QACM;AACN,MAAI,mBAAmB,OAAO,IAAI,YAAY,OAAO,CAGnD,OAAM,SAAS,OAAO,OAAO;MAE7B,OAAM,SAAS,QAAQ,qBAAqB;AAG9C,QAAA,qBAA2B,OAAO,YAAY;AAC9C,MAAI,MAAM,WACR,OAAA,yBAA+B,OAAO,MAAM,WAAW;;;;;;;;;;;;CAc3D,sBAAsB,UAA4B;AAChD,QAAA,6BAAmC,IAAI,SAAS;;CAGlD,sCAAsC;AACpC,OAAK,MAAM,YAAY,MAAA,6BACrB,WAAU"}

package/out/zero-client/src/client/mutator-proxy.js

@@ -1,157 +1,128 @@
 import { unreachable } from "../../../shared/src/asserts.js";
 import { wrapWithApplicationError } from "../../../zero-protocol/src/application-error.js";
-import { NoSocketOrigin, ClientClosed, Offline } from "./client-error-kind-enum.js";
-import { Disconnected, NeedsAuth, Connecting, Connected, Closed, Error } from "./connection-status-enum.js";
+import { Closed, Connected, Connecting, Disconnected, Error, NeedsAuth } from "./connection-status-enum.js";
+import { ClientClosed, Offline } from "./client-error-kind-enum.js";
 import { isZeroError } from "./error.js";
-const successResultDetails = {
-  type: "success"
-};
-const successResult = () => successResultDetails;
+//#region ../zero-client/src/client/mutator-proxy.ts
+var successResultDetails = { type: "success" };
+var successResult = () => successResultDetails;
 function getStateDescription(error) {
-  switch (error.kind) {
-    case Offline:
-      return "offline";
-    case ClientClosed:
-      return "closed";
-    default:
-      return "in error state";
-  }
-}
-class MutatorProxy {
-  #lc;
-  #connectionManager;
-  #mutationTracker;
-  #mutationRejection;
-  constructor(lc, connectionManager, mutationTracker) {
-    this.#lc = lc;
-    this.#connectionManager = connectionManager;
-    this.#mutationTracker = mutationTracker;
-    this.#connectionManager.subscribe(
-      (state) => this.#onConnectionStateChange(state)
-    );
-    this.#onConnectionStateChange(connectionManager.state);
-  }
-  get mutationRejectionError() {
-    return this.#mutationRejection?.error;
-  }
-  /**
-   * Called when the connection state changes.
-   *
-   * If the connection state is disconnected, error, or closed, the
-   * mutation rejection error is set and all outstanding `.server` promises in
-   * the mutation tracker are rejected with the error.
-   */
-  #onConnectionStateChange(state) {
-    if (state.name === Disconnected && state.reason.kind === NoSocketOrigin) {
-      this.#mutationRejection = void 0;
-      return;
-    }
-    switch (state.name) {
-      case Disconnected:
-      case Error:
-      case Closed:
-        this.#mutationRejection = {
-          error: state.reason,
-          promise: Promise.resolve(
-            this.#makeZeroErrorResultDetails(state.reason)
-          )
-        };
-        this.#mutationTracker.rejectAllOutstandingMutations(state.reason);
-        break;
-      case Connected:
-      case Connecting:
-      case NeedsAuth:
-        this.#mutationRejection = void 0;
-        return;
-      default:
-        unreachable();
-    }
-  }
-  wrapCustomMutator(name, f) {
-    return (...args) => {
-      if (this.#mutationRejection) {
-        const error = this.#mutationRejection.error;
-        this.#lc.warn?.(
-          `Mutation "${name}" rejected because Zero is ${getStateDescription(error)}. Details: ${error.message}. See also: https://zero.rocicorp.dev/docs/connection.`
-        );
-        return {
-          client: this.#mutationRejection.promise,
-          server: this.#mutationRejection.promise
-        };
-      }
-      let result;
-      const cachedMutationPromises = {};
-      const wrapErrorFor = (origin) => (error) => {
-        const cachedPromise = cachedMutationPromises[origin];
-        if (cachedPromise) {
-          return cachedPromise;
-        }
-        if (isZeroError(error)) {
-          this.#lc.error?.(`Mutator "${name}" error on ${origin}`, error);
-          const zeroErrorPromise = this.#makeZeroErrorResultDetails(error);
-          cachedMutationPromises[origin] = zeroErrorPromise;
-          return zeroErrorPromise;
-        }
-        const applicationError = wrapWithApplicationError(error);
-        this.#lc.error?.(
-          `Mutator "${name}" app error on ${origin}`,
-          applicationError
-        );
-        const applicationErrorPromise = this.#makeApplicationErrorResultDetails(applicationError);
-        cachedMutationPromises[origin] = applicationErrorPromise;
-        return applicationErrorPromise;
-      };
-      try {
-        result = f(...args);
-      } catch (error) {
-        const clientPromise = wrapErrorFor("client")(error);
-        const serverPromise = wrapErrorFor("server")(error);
-        return {
-          client: clientPromise,
-          server: serverPromise
-        };
-      }
-      const client = this.#normalizeResultPromise(
-        result.client,
-        wrapErrorFor("client")
-      );
-      const server = this.#normalizeResultPromise(
-        result.server,
-        wrapErrorFor("server")
-      );
-      return {
-        client,
-        server
-      };
-    };
-  }
-  #normalizeResultPromise(promise, wrapError) {
-    return promise.then(
-      successResult,
-      wrapError
-    );
-  }
-  #makeZeroErrorResultDetails(zeroError) {
-    return Promise.resolve({
-      type: "error",
-      error: {
-        type: "zero",
-        message: zeroError.message
-      }
-    });
-  }
-  #makeApplicationErrorResultDetails(applicationError) {
-    return Promise.resolve({
-      type: "error",
-      error: {
-        type: "app",
-        message: applicationError.message,
-        details: applicationError.details
-      }
-    });
-  }
+	switch (error.kind) {
+		case Offline: return "offline";
+		case ClientClosed: return "closed";
+		default: return "in error state";
+	}
 }
-export {
-  MutatorProxy
+var MutatorProxy = class {
+	#lc;
+	#connectionManager;
+	#mutationTracker;
+	#mutationRejection;
+	constructor(lc, connectionManager, mutationTracker) {
+		this.#lc = lc;
+		this.#connectionManager = connectionManager;
+		this.#mutationTracker = mutationTracker;
+		this.#connectionManager.subscribe((state) => this.#onConnectionStateChange(state));
+		this.#onConnectionStateChange(connectionManager.state);
+	}
+	get mutationRejectionError() {
+		return this.#mutationRejection?.error;
+	}
+	/**
+	* Called when the connection state changes.
+	*
+	* If the connection state is disconnected, error, or closed, the
+	* mutation rejection error is set and all outstanding `.server` promises in
+	* the mutation tracker are rejected with the error.
+	*/
+	#onConnectionStateChange(state) {
+		if (state.name === "disconnected" && state.reason.kind === "NoSocketOrigin") {
+			this.#mutationRejection = void 0;
+			return;
+		}
+		switch (state.name) {
+			case Disconnected:
+			case Error:
+			case Closed:
+				this.#mutationRejection = {
+					error: state.reason,
+					promise: Promise.resolve(this.#makeZeroErrorResultDetails(state.reason))
+				};
+				this.#mutationTracker.rejectAllOutstandingMutations(state.reason);
+				break;
+			case Connected:
+			case Connecting:
+			case NeedsAuth:
+				this.#mutationRejection = void 0;
+				return;
+			default: unreachable(state);
+		}
+	}
+	wrapCustomMutator(name, f) {
+		return (...args) => {
+			if (this.#mutationRejection) {
+				const error = this.#mutationRejection.error;
+				this.#lc.warn?.(`Mutation "${name}" rejected because Zero is ${getStateDescription(error)}. Details: ${error.message}. See also: https://zero.rocicorp.dev/docs/connection.`);
+				return {
+					client: this.#mutationRejection.promise,
+					server: this.#mutationRejection.promise
+				};
+			}
+			let result;
+			const cachedMutationPromises = {};
+			const wrapErrorFor = (origin) => (error) => {
+				const cachedPromise = cachedMutationPromises[origin];
+				if (cachedPromise) return cachedPromise;
+				if (isZeroError(error)) {
+					this.#lc.error?.(`Mutator "${name}" error on ${origin}`, error);
+					const zeroErrorPromise = this.#makeZeroErrorResultDetails(error);
+					cachedMutationPromises[origin] = zeroErrorPromise;
+					return zeroErrorPromise;
+				}
+				const applicationError = wrapWithApplicationError(error);
+				this.#lc.error?.(`Mutator "${name}" app error on ${origin}`, applicationError);
+				const applicationErrorPromise = this.#makeApplicationErrorResultDetails(applicationError);
+				cachedMutationPromises[origin] = applicationErrorPromise;
+				return applicationErrorPromise;
+			};
+			try {
+				result = f(...args);
+			} catch (error) {
+				return {
+					client: wrapErrorFor("client")(error),
+					server: wrapErrorFor("server")(error)
+				};
+			}
+			return {
+				client: this.#normalizeResultPromise(result.client, wrapErrorFor("client")),
+				server: this.#normalizeResultPromise(result.server, wrapErrorFor("server"))
+			};
+		};
+	}
+	#normalizeResultPromise(promise, wrapError) {
+		return promise.then(successResult, wrapError);
+	}
+	#makeZeroErrorResultDetails(zeroError) {
+		return Promise.resolve({
+			type: "error",
+			error: {
+				type: "zero",
+				message: zeroError.message
+			}
+		});
+	}
+	#makeApplicationErrorResultDetails(applicationError) {
+		return Promise.resolve({
+			type: "error",
+			error: {
+				type: "app",
+				message: applicationError.message,
+				details: applicationError.details
+			}
+		});
+	}
 };
-//# sourceMappingURL=mutator-proxy.js.map
+//#endregion
+export { MutatorProxy };
+
+//# sourceMappingURL=mutator-proxy.js.map

package/out/zero-client/src/client/mutator-proxy.js.map

@@ -1 +1 @@
-{"version":3,"file":"mutator-proxy.js","sources":["../../../../../zero-client/src/client/mutator-proxy.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {unreachable} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport type {ApplicationError} from '../../../zero-protocol/src/application-error.ts';\nimport {wrapWithApplicationError} from '../../../zero-protocol/src/application-error.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';\nimport type {\n  MutatorResult,\n  MutatorResultErrorDetails,\n  MutatorResultSuccessDetails,\n} from './custom.ts';\nimport {isZeroError, type ZeroError} from './error.ts';\nimport type {MutationTracker} from './mutation-tracker.ts';\n\nconst successResultDetails = {\n  type: 'success',\n} as const satisfies MutatorResultSuccessDetails;\nconst successResult = () => successResultDetails;\n\nfunction getStateDescription(error: ZeroError): string {\n  switch (error.kind) {\n    case ClientErrorKind.Offline:\n      return 'offline';\n    case ClientErrorKind.ClientClosed:\n      return 'closed';\n    default:\n      return 'in error state';\n  }\n}\n\ntype CachedMutationRejection = {\n  readonly error: ZeroError;\n  readonly promise: Promise<MutatorResultErrorDetails>;\n};\n\nexport class MutatorProxy {\n  readonly #lc: LogContext;\n  readonly #connectionManager: ConnectionManager;\n  readonly #mutationTracker: MutationTracker;\n  #mutationRejection: CachedMutationRejection | undefined;\n\n  constructor(\n    lc: LogContext,\n    connectionManager: ConnectionManager,\n    mutationTracker: MutationTracker,\n  ) {\n    this.#lc = lc;\n    this.#connectionManager = connectionManager;\n    this.#mutationTracker = mutationTracker;\n\n    this.#connectionManager.subscribe(state =>\n      this.#onConnectionStateChange(state),\n    );\n    this.#onConnectionStateChange(connectionManager.state);\n  }\n\n  get mutationRejectionError(): ZeroError | undefined {\n    return this.#mutationRejection?.error;\n  }\n\n  /**\n   * Called when the connection state changes.\n   *\n   * If the connection state is disconnected, error, or closed, the\n   * mutation rejection error is set and all outstanding `.server` promises in\n   * the mutation tracker are rejected with the error.\n   */\n  #onConnectionStateChange(state: ConnectionManagerState) {\n    // we short circuit the rejection if the error is due to a missing cacheURL\n    // this allows local writes to continue\n    if (\n      state.name === ConnectionStatus.Disconnected &&\n      state.reason.kind === ClientErrorKind.NoSocketOrigin\n    ) {\n      this.#mutationRejection = undefined;\n      return;\n    }\n\n    switch (state.name) {\n      case ConnectionStatus.Disconnected:\n      case ConnectionStatus.Error:\n      case ConnectionStatus.Closed:\n        this.#mutationRejection = {\n          error: state.reason,\n          promise: Promise.resolve(\n            this.#makeZeroErrorResultDetails(state.reason),\n          ),\n        };\n        this.#mutationTracker.rejectAllOutstandingMutations(state.reason);\n        break;\n      case ConnectionStatus.Connected:\n      case ConnectionStatus.Connecting:\n      case ConnectionStatus.NeedsAuth:\n        this.#mutationRejection = undefined;\n        return;\n      default:\n        unreachable(state);\n    }\n  }\n\n  wrapCustomMutator<\n    F extends (...args: [] | [ReadonlyJSONValue]) => {\n      client: Promise<unknown>;\n      server: Promise<unknown>;\n    },\n  >(name: string, f: F): (...args: Parameters<F>) => MutatorResult {\n    return (...args) => {\n      if (this.#mutationRejection) {\n        const error = this.#mutationRejection.error;\n        this.#lc.warn?.(\n          `Mutation \"${name}\" rejected because Zero is ${getStateDescription(error)}. Details: ${error.message}. See also: https://zero.rocicorp.dev/docs/connection.`,\n        );\n        return {\n          client: this.#mutationRejection.promise,\n          server: this.#mutationRejection.promise,\n        } as const satisfies MutatorResult;\n      }\n\n      let result: {\n        client: Promise<unknown>;\n        server: Promise<unknown>;\n      };\n\n      const cachedMutationPromises: Partial<\n        Record<'client' | 'server', Promise<MutatorResultErrorDetails>>\n      > = {};\n\n      const wrapErrorFor =\n        (origin: 'client' | 'server') =>\n        (error: unknown): Promise<MutatorResultErrorDetails> => {\n          const cachedPromise = cachedMutationPromises[origin];\n          if (cachedPromise) {\n            return cachedPromise;\n          }\n\n          if (isZeroError(error)) {\n            this.#lc.error?.(`Mutator \"${name}\" error on ${origin}`, error);\n\n            const zeroErrorPromise = this.#makeZeroErrorResultDetails(error);\n            cachedMutationPromises[origin] = zeroErrorPromise;\n            return zeroErrorPromise;\n          }\n\n          const applicationError = wrapWithApplicationError(error);\n          this.#lc.error?.(\n            `Mutator \"${name}\" app error on ${origin}`,\n            applicationError,\n          );\n\n          const applicationErrorPromise =\n            this.#makeApplicationErrorResultDetails(applicationError);\n          cachedMutationPromises[origin] = applicationErrorPromise;\n          return applicationErrorPromise;\n        };\n\n      try {\n        result = f(...args);\n      } catch (error) {\n        const clientPromise = wrapErrorFor('client')(error);\n        const serverPromise = wrapErrorFor('server')(error);\n\n        return {\n          client: clientPromise,\n          server: serverPromise,\n        } as const satisfies MutatorResult;\n      }\n\n      const client = this.#normalizeResultPromise(\n        result.client,\n        wrapErrorFor('client'),\n      );\n      const server = this.#normalizeResultPromise(\n        result.server,\n        wrapErrorFor('server'),\n      );\n\n      return {\n        client,\n        server,\n      };\n    };\n  }\n\n  #normalizeResultPromise(\n    promise: Promise<unknown>,\n    wrapError: (error: unknown) => Promise<MutatorResultErrorDetails>,\n  ) {\n    return promise.then<MutatorResultSuccessDetails, MutatorResultErrorDetails>(\n      successResult,\n      wrapError,\n    );\n  }\n\n  #makeZeroErrorResultDetails(zeroError: ZeroError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'zero',\n        message: zeroError.message,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n\n  #makeApplicationErrorResultDetails(applicationError: ApplicationError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'app',\n        message: applicationError.message,\n        details: applicationError.details,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n}\n"],"names":["ClientErrorKind.Offline","ClientErrorKind.ClientClosed","ConnectionStatus.Disconnected","ClientErrorKind.NoSocketOrigin","ConnectionStatus.Error","ConnectionStatus.Closed","ConnectionStatus.Connected","ConnectionStatus.Connecting","ConnectionStatus.NeedsAuth"],"mappings":";;;;;AAmBA,MAAM,uBAAuB;AAAA,EAC3B,MAAM;AACR;AACA,MAAM,gBAAgB,MAAM;AAE5B,SAAS,oBAAoB,OAA0B;AACrD,UAAQ,MAAM,MAAA;AAAA,IACZ,KAAKA;AACH,aAAO;AAAA,IACT,KAAKC;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EAAA;AAEb;AAOO,MAAM,aAAa;AAAA,EACf;AAAA,EACA;AAAA,EACA;AAAA,EACT;AAAA,EAEA,YACE,IACA,mBACA,iBACA;AACA,SAAK,MAAM;AACX,SAAK,qBAAqB;AAC1B,SAAK,mBAAmB;AAExB,SAAK,mBAAmB;AAAA,MAAU,CAAA,UAChC,KAAK,yBAAyB,KAAK;AAAA,IAAA;AAErC,SAAK,yBAAyB,kBAAkB,KAAK;AAAA,EACvD;AAAA,EAEA,IAAI,yBAAgD;AAClD,WAAO,KAAK,oBAAoB;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,yBAAyB,OAA+B;AAGtD,QACE,MAAM,SAASC,gBACf,MAAM,OAAO,SAASC,gBACtB;AACA,WAAK,qBAAqB;AAC1B;AAAA,IACF;AAEA,YAAQ,MAAM,MAAA;AAAA,MACZ,KAAKD;AAAAA,MACL,KAAKE;AAAAA,MACL,KAAKC;AACH,aAAK,qBAAqB;AAAA,UACxB,OAAO,MAAM;AAAA,UACb,SAAS,QAAQ;AAAA,YACf,KAAK,4BAA4B,MAAM,MAAM;AAAA,UAAA;AAAA,QAC/C;AAEF,aAAK,iBAAiB,8BAA8B,MAAM,MAAM;AAChE;AAAA,MACF,KAAKC;AAAAA,MACL,KAAKC;AAAAA,MACL,KAAKC;AACH,aAAK,qBAAqB;AAC1B;AAAA,MACF;AACE,oBAAiB;AAAA,IAAA;AAAA,EAEvB;AAAA,EAEA,kBAKE,MAAc,GAAiD;AAC/D,WAAO,IAAI,SAAS;AAClB,UAAI,KAAK,oBAAoB;AAC3B,cAAM,QAAQ,KAAK,mBAAmB;AACtC,aAAK,IAAI;AAAA,UACP,aAAa,IAAI,8BAA8B,oBAAoB,KAAK,CAAC,cAAc,MAAM,OAAO;AAAA,QAAA;AAEtG,eAAO;AAAA,UACL,QAAQ,KAAK,mBAAmB;AAAA,UAChC,QAAQ,KAAK,mBAAmB;AAAA,QAAA;AAAA,MAEpC;AAEA,UAAI;AAKJ,YAAM,yBAEF,CAAA;AAEJ,YAAM,eACJ,CAAC,WACD,CAAC,UAAuD;AACtD,cAAM,gBAAgB,uBAAuB,MAAM;AACnD,YAAI,eAAe;AACjB,iBAAO;AAAA,QACT;AAEA,YAAI,YAAY,KAAK,GAAG;AACtB,eAAK,IAAI,QAAQ,YAAY,IAAI,cAAc,MAAM,IAAI,KAAK;AAE9D,gBAAM,mBAAmB,KAAK,4BAA4B,KAAK;AAC/D,iCAAuB,MAAM,IAAI;AACjC,iBAAO;AAAA,QACT;AAEA,cAAM,mBAAmB,yBAAyB,KAAK;AACvD,aAAK,IAAI;AAAA,UACP,YAAY,IAAI,kBAAkB,MAAM;AAAA,UACxC;AAAA,QAAA;AAGF,cAAM,0BACJ,KAAK,mCAAmC,gBAAgB;AAC1D,+BAAuB,MAAM,IAAI;AACjC,eAAO;AAAA,MACT;AAEF,UAAI;AACF,iBAAS,EAAE,GAAG,IAAI;AAAA,MACpB,SAAS,OAAO;AACd,cAAM,gBAAgB,aAAa,QAAQ,EAAE,KAAK;AAClD,cAAM,gBAAgB,aAAa,QAAQ,EAAE,KAAK;AAElD,eAAO;AAAA,UACL,QAAQ;AAAA,UACR,QAAQ;AAAA,QAAA;AAAA,MAEZ;AAEA,YAAM,SAAS,KAAK;AAAA,QAClB,OAAO;AAAA,QACP,aAAa,QAAQ;AAAA,MAAA;AAEvB,YAAM,SAAS,KAAK;AAAA,QAClB,OAAO;AAAA,QACP,aAAa,QAAQ;AAAA,MAAA;AAGvB,aAAO;AAAA,QACL;AAAA,QACA;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AAAA,EAEA,wBACE,SACA,WACA;AACA,WAAO,QAAQ;AAAA,MACb;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,4BAA4B,WAAsB;AAChD,WAAO,QAAQ,QAAQ;AAAA,MACrB,MAAM;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,UAAU;AAAA,MAAA;AAAA,IACrB,CAC4C;AAAA,EAChD;AAAA,EAEA,mCAAmC,kBAAoC;AACrE,WAAO,QAAQ,QAAQ;AAAA,MACrB,MAAM;AAAA,MACN,OAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,iBAAiB;AAAA,QAC1B,SAAS,iBAAiB;AAAA,MAAA;AAAA,IAC5B,CAC4C;AAAA,EAChD;AACF;"}
+{"version":3,"file":"mutator-proxy.js","names":["#lc","#connectionManager","#mutationTracker","#onConnectionStateChange","#mutationRejection","#makeZeroErrorResultDetails","#makeApplicationErrorResultDetails","#normalizeResultPromise"],"sources":["../../../../../zero-client/src/client/mutator-proxy.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {unreachable} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport type {ApplicationError} from '../../../zero-protocol/src/application-error.ts';\nimport {wrapWithApplicationError} from '../../../zero-protocol/src/application-error.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';\nimport type {\n  MutatorResult,\n  MutatorResultErrorDetails,\n  MutatorResultSuccessDetails,\n} from './custom.ts';\nimport {isZeroError, type ZeroError} from './error.ts';\nimport type {MutationTracker} from './mutation-tracker.ts';\n\nconst successResultDetails = {\n  type: 'success',\n} as const satisfies MutatorResultSuccessDetails;\nconst successResult = () => successResultDetails;\n\nfunction getStateDescription(error: ZeroError): string {\n  switch (error.kind) {\n    case ClientErrorKind.Offline:\n      return 'offline';\n    case ClientErrorKind.ClientClosed:\n      return 'closed';\n    default:\n      return 'in error state';\n  }\n}\n\ntype CachedMutationRejection = {\n  readonly error: ZeroError;\n  readonly promise: Promise<MutatorResultErrorDetails>;\n};\n\nexport class MutatorProxy {\n  readonly #lc: LogContext;\n  readonly #connectionManager: ConnectionManager;\n  readonly #mutationTracker: MutationTracker;\n  #mutationRejection: CachedMutationRejection | undefined;\n\n  constructor(\n    lc: LogContext,\n    connectionManager: ConnectionManager,\n    mutationTracker: MutationTracker,\n  ) {\n    this.#lc = lc;\n    this.#connectionManager = connectionManager;\n    this.#mutationTracker = mutationTracker;\n\n    this.#connectionManager.subscribe(state =>\n      this.#onConnectionStateChange(state),\n    );\n    this.#onConnectionStateChange(connectionManager.state);\n  }\n\n  get mutationRejectionError(): ZeroError | undefined {\n    return this.#mutationRejection?.error;\n  }\n\n  /**\n   * Called when the connection state changes.\n   *\n   * If the connection state is disconnected, error, or closed, the\n   * mutation rejection error is set and all outstanding `.server` promises in\n   * the mutation tracker are rejected with the error.\n   */\n  #onConnectionStateChange(state: ConnectionManagerState) {\n    // we short circuit the rejection if the error is due to a missing cacheURL\n    // this allows local writes to continue\n    if (\n      state.name === ConnectionStatus.Disconnected &&\n      state.reason.kind === ClientErrorKind.NoSocketOrigin\n    ) {\n      this.#mutationRejection = undefined;\n      return;\n    }\n\n    switch (state.name) {\n      case ConnectionStatus.Disconnected:\n      case ConnectionStatus.Error:\n      case ConnectionStatus.Closed:\n        this.#mutationRejection = {\n          error: state.reason,\n          promise: Promise.resolve(\n            this.#makeZeroErrorResultDetails(state.reason),\n          ),\n        };\n        this.#mutationTracker.rejectAllOutstandingMutations(state.reason);\n        break;\n      case ConnectionStatus.Connected:\n      case ConnectionStatus.Connecting:\n      case ConnectionStatus.NeedsAuth:\n        this.#mutationRejection = undefined;\n        return;\n      default:\n        unreachable(state);\n    }\n  }\n\n  wrapCustomMutator<\n    F extends (...args: [] | [ReadonlyJSONValue]) => {\n      client: Promise<unknown>;\n      server: Promise<unknown>;\n    },\n  >(name: string, f: F): (...args: Parameters<F>) => MutatorResult {\n    return (...args) => {\n      if (this.#mutationRejection) {\n        const error = this.#mutationRejection.error;\n        this.#lc.warn?.(\n          `Mutation \"${name}\" rejected because Zero is ${getStateDescription(error)}. Details: ${error.message}. See also: https://zero.rocicorp.dev/docs/connection.`,\n        );\n        return {\n          client: this.#mutationRejection.promise,\n          server: this.#mutationRejection.promise,\n        } as const satisfies MutatorResult;\n      }\n\n      let result: {\n        client: Promise<unknown>;\n        server: Promise<unknown>;\n      };\n\n      const cachedMutationPromises: Partial<\n        Record<'client' | 'server', Promise<MutatorResultErrorDetails>>\n      > = {};\n\n      const wrapErrorFor =\n        (origin: 'client' | 'server') =>\n        (error: unknown): Promise<MutatorResultErrorDetails> => {\n          const cachedPromise = cachedMutationPromises[origin];\n          if (cachedPromise) {\n            return cachedPromise;\n          }\n\n          if (isZeroError(error)) {\n            this.#lc.error?.(`Mutator \"${name}\" error on ${origin}`, error);\n\n            const zeroErrorPromise = this.#makeZeroErrorResultDetails(error);\n            cachedMutationPromises[origin] = zeroErrorPromise;\n            return zeroErrorPromise;\n          }\n\n          const applicationError = wrapWithApplicationError(error);\n          this.#lc.error?.(\n            `Mutator \"${name}\" app error on ${origin}`,\n            applicationError,\n          );\n\n          const applicationErrorPromise =\n            this.#makeApplicationErrorResultDetails(applicationError);\n          cachedMutationPromises[origin] = applicationErrorPromise;\n          return applicationErrorPromise;\n        };\n\n      try {\n        result = f(...args);\n      } catch (error) {\n        const clientPromise = wrapErrorFor('client')(error);\n        const serverPromise = wrapErrorFor('server')(error);\n\n        return {\n          client: clientPromise,\n          server: serverPromise,\n        } as const satisfies MutatorResult;\n      }\n\n      const client = this.#normalizeResultPromise(\n        result.client,\n        wrapErrorFor('client'),\n      );\n      const server = this.#normalizeResultPromise(\n        result.server,\n        wrapErrorFor('server'),\n      );\n\n      return {\n        client,\n        server,\n      };\n    };\n  }\n\n  #normalizeResultPromise(\n    promise: Promise<unknown>,\n    wrapError: (error: unknown) => Promise<MutatorResultErrorDetails>,\n  ) {\n    return promise.then<MutatorResultSuccessDetails, MutatorResultErrorDetails>(\n      successResult,\n      wrapError,\n    );\n  }\n\n  #makeZeroErrorResultDetails(zeroError: ZeroError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'zero',\n        message: zeroError.message,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n\n  #makeApplicationErrorResultDetails(applicationError: ApplicationError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'app',\n        message: applicationError.message,\n        details: applicationError.details,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n}\n"],"mappings":";;;;;;AAmBA,IAAM,uBAAuB,EAC3B,MAAM,WACP;AACD,IAAM,sBAAsB;AAE5B,SAAS,oBAAoB,OAA0B;AACrD,SAAQ,MAAM,MAAd;EACE,KAAK,QACH,QAAO;EACT,KAAK,aACH,QAAO;EACT,QACE,QAAO;;;AASb,IAAa,eAAb,MAA0B;CACxB;CACA;CACA;CACA;CAEA,YACE,IACA,mBACA,iBACA;AACA,QAAA,KAAW;AACX,QAAA,oBAA0B;AAC1B,QAAA,kBAAwB;AAExB,QAAA,kBAAwB,WAAU,UAChC,MAAA,wBAA8B,MAAM,CACrC;AACD,QAAA,wBAA8B,kBAAkB,MAAM;;CAGxD,IAAI,yBAAgD;AAClD,SAAO,MAAA,mBAAyB;;;;;;;;;CAUlC,yBAAyB,OAA+B;AAGtD,MACE,MAAM,SAAS,kBACf,MAAM,OAAO,SAAS,kBACtB;AACA,SAAA,oBAA0B,KAAA;AAC1B;;AAGF,UAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK;GACL,KAAK;AACH,UAAA,oBAA0B;KACxB,OAAO,MAAM;KACb,SAAS,QAAQ,QACf,MAAA,2BAAiC,MAAM,OAAO,CAC/C;KACF;AACD,UAAA,gBAAsB,8BAA8B,MAAM,OAAO;AACjE;GACF,KAAK;GACL,KAAK;GACL,KAAK;AACH,UAAA,oBAA0B,KAAA;AAC1B;GACF,QACE,aAAY,MAAM;;;CAIxB,kBAKE,MAAc,GAAiD;AAC/D,UAAQ,GAAG,SAAS;AAClB,OAAI,MAAA,mBAAyB;IAC3B,MAAM,QAAQ,MAAA,kBAAwB;AACtC,UAAA,GAAS,OACP,aAAa,KAAK,6BAA6B,oBAAoB,MAAM,CAAC,aAAa,MAAM,QAAQ,wDACtG;AACD,WAAO;KACL,QAAQ,MAAA,kBAAwB;KAChC,QAAQ,MAAA,kBAAwB;KACjC;;GAGH,IAAI;GAKJ,MAAM,yBAEF,EAAE;GAEN,MAAM,gBACH,YACA,UAAuD;IACtD,MAAM,gBAAgB,uBAAuB;AAC7C,QAAI,cACF,QAAO;AAGT,QAAI,YAAY,MAAM,EAAE;AACtB,WAAA,GAAS,QAAQ,YAAY,KAAK,aAAa,UAAU,MAAM;KAE/D,MAAM,mBAAmB,MAAA,2BAAiC,MAAM;AAChE,4BAAuB,UAAU;AACjC,YAAO;;IAGT,MAAM,mBAAmB,yBAAyB,MAAM;AACxD,UAAA,GAAS,QACP,YAAY,KAAK,iBAAiB,UAClC,iBACD;IAED,MAAM,0BACJ,MAAA,kCAAwC,iBAAiB;AAC3D,2BAAuB,UAAU;AACjC,WAAO;;AAGX,OAAI;AACF,aAAS,EAAE,GAAG,KAAK;YACZ,OAAO;AAId,WAAO;KACL,QAJoB,aAAa,SAAS,CAAC,MAAM;KAKjD,QAJoB,aAAa,SAAS,CAAC,MAAM;KAKlD;;AAYH,UAAO;IACL,QAVa,MAAA,uBACb,OAAO,QACP,aAAa,SAAS,CACvB;IAQC,QAPa,MAAA,uBACb,OAAO,QACP,aAAa,SAAS,CACvB;IAKA;;;CAIL,wBACE,SACA,WACA;AACA,SAAO,QAAQ,KACb,eACA,UACD;;CAGH,4BAA4B,WAAsB;AAChD,SAAO,QAAQ,QAAQ;GACrB,MAAM;GACN,OAAO;IACL,MAAM;IACN,SAAS,UAAU;IACpB;GACF,CAA8C;;CAGjD,mCAAmC,kBAAoC;AACrE,SAAO,QAAQ,QAAQ;GACrB,MAAM;GACN,OAAO;IACL,MAAM;IACN,SAAS,iBAAiB;IAC1B,SAAS,iBAAiB;IAC3B;GACF,CAA8C"}

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

@@ -1,11 +1,8 @@
 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
+import { NewClientGroup, SchemaVersionNotSupported, VersionNotSupported } from "./update-needed-reason-type-enum.js";
+//#region ../zero-client/src/client/options.ts
+var updateNeededReasonTypeSchema = literalUnion(NewClientGroup, VersionNotSupported, SchemaVersionNotSupported);
+//#endregion
+export { updateNeededReasonTypeSchema };
+
+//# sourceMappingURL=options.js.map

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

@@ -1 +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  BaseDefaultContext,\n  BaseDefaultSchema,\n  DefaultContext,\n  DefaultSchema,\n} from '../../../zero-types/src/default-types.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 type ZeroOptions<\n  S extends BaseDefaultSchema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  C extends BaseDefaultContext = 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   * The call to `connect` is handled automatically by the ZeroProvider component\n   * for React and SolidJS when the `auth` prop changes.\n   *\n   * When `auth` changes while connected, Zero refreshes server-side auth context\n   * and re-transforms queries without reconnecting.\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  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 headers to include in mutation requests sent to your API server.\n   * These headers are passed through zero-cache to the mutate endpoint.\n   */\n  mutateHeaders?: Record<string, 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   * Custom headers to include in query requests sent to your API server.\n   * These headers are passed through zero-cache to the query endpoint.\n   */\n  queryHeaders?: Record<string, 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 minutes.\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 1 minute.\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 queries when they are executed.\n   */\n  context?: C | undefined;\n} & (unknown extends DefaultContext\n  ? {}\n  : {\n      context: C;\n    });\n\n/**\n * @deprecated Use {@link ZeroOptions} instead.\n */\nexport type ZeroAdvancedOptions<\n  S extends BaseDefaultSchema,\n  MD extends CustomMutatorDefs | undefined,\n  Context extends BaseDefaultContext,\n> = 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":";;AAgWO,MAAM,+BACXA;AAAAA,EACEC;AAAAA,EACAC;AAAAA,EACAC;AACF;"}
+{"version":3,"file":"options.js","names":[],"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  BaseDefaultContext,\n  BaseDefaultSchema,\n  DefaultContext,\n  DefaultSchema,\n} from '../../../zero-types/src/default-types.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 type ZeroOptions<\n  S extends BaseDefaultSchema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  C extends BaseDefaultContext = 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   * The call to `connect` is handled automatically by the ZeroProvider component\n   * for React and SolidJS when the `auth` prop changes.\n   *\n   * When `auth` changes while connected, Zero refreshes server-side auth context\n   * and re-transforms queries without reconnecting.\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  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 headers to include in mutation requests sent to your API server.\n   * These headers are passed through zero-cache to the mutate endpoint.\n   */\n  mutateHeaders?: Record<string, 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   * Custom headers to include in query requests sent to your API server.\n   * These headers are passed through zero-cache to the query endpoint.\n   */\n  queryHeaders?: Record<string, 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 minutes.\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 1 minute.\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 queries when they are executed.\n   */\n  context?: C | undefined;\n} & (unknown extends DefaultContext\n  ? {}\n  : {\n      context: C;\n    });\n\n/**\n * @deprecated Use {@link ZeroOptions} instead.\n */\nexport type ZeroAdvancedOptions<\n  S extends BaseDefaultSchema,\n  MD extends CustomMutatorDefs | undefined,\n  Context extends BaseDefaultContext,\n> = 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"],"mappings":";;;AAgWA,IAAa,+BACX,aACE,gBACA,qBACA,0BACD"}