@rocicorp/zero 0.25.0-canary.7 → 0.25.0-canary.9

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

@@ -0,0 +1,60 @@
+import { consoleLogSink, TeeLogSink } from "@rocicorp/logger";
+import { DatadogLogSink } from "../../../datadog/src/datadog-log-sink.js";
+import { appendPath } from "./http-string.js";
+import { version } from "./version.js";
+class LevelFilterLogSink {
+  #wrappedLogSink;
+  #level;
+  constructor(wrappedLogSink, level) {
+    this.#wrappedLogSink = wrappedLogSink;
+    this.#level = level;
+  }
+  log(level, context, ...args) {
+    if (this.#level === "error" && level !== "error") {
+      return;
+    }
+    if (this.#level === "info" && level === "debug") {
+      return;
+    }
+    this.#wrappedLogSink.log(level, context, ...args);
+  }
+  async flush() {
+    await consoleLogSink.flush?.();
+  }
+}
+const DATADOG_LOG_LEVEL = "info";
+const ZERO_SASS_DOMAIN = ".reflect-server.net";
+function createLogOptions(options, createDatadogLogSink = (options2) => new DatadogLogSink(options2)) {
+  const { consoleLogLevel, server, enableAnalytics } = options;
+  if (!enableAnalytics || server === null) {
+    return {
+      logLevel: consoleLogLevel,
+      logSink: consoleLogSink
+    };
+  }
+  const serverURL = new URL(server);
+  const { hostname } = serverURL;
+  const datadogServiceLabel = hostname.endsWith(ZERO_SASS_DOMAIN) ? hostname.substring(0, hostname.length - ZERO_SASS_DOMAIN.length).toLowerCase() : hostname;
+  const baseURL = new URL(appendPath(server, "/logs/v0/log"));
+  const logLevel = consoleLogLevel === "debug" ? "debug" : "info";
+  const logSink = new TeeLogSink([
+    new LevelFilterLogSink(consoleLogSink, consoleLogLevel),
+    new LevelFilterLogSink(
+      createDatadogLogSink({
+        service: datadogServiceLabel,
+        host: location.host,
+        version,
+        baseURL
+      }),
+      DATADOG_LOG_LEVEL
+    )
+  ]);
+  return {
+    logLevel,
+    logSink
+  };
+}
+export {
+  createLogOptions
+};
+//# sourceMappingURL=log-options.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"log-options.js","sources":["../../../../../zero-client/src/client/log-options.ts"],"sourcesContent":["import {\n  TeeLogSink,\n  consoleLogSink,\n  type Context,\n  type LogLevel,\n  type LogSink,\n} from '@rocicorp/logger';\nimport {\n  DatadogLogSink,\n  type DatadogLogSinkOptions,\n} from '../../../datadog/src/datadog-log-sink.ts';\nimport {appendPath, type HTTPString} from './http-string.ts';\nimport {version} from './version.ts';\n\nclass LevelFilterLogSink implements LogSink {\n  readonly #wrappedLogSink: LogSink;\n  readonly #level: LogLevel;\n\n  constructor(wrappedLogSink: LogSink, level: LogLevel) {\n    this.#wrappedLogSink = wrappedLogSink;\n    this.#level = level;\n  }\n\n  log(level: LogLevel, context: Context | undefined, ...args: unknown[]): void {\n    if (this.#level === 'error' && level !== 'error') {\n      return;\n    }\n    if (this.#level === 'info' && level === 'debug') {\n      return;\n    }\n    this.#wrappedLogSink.log(level, context, ...args);\n  }\n\n  async flush() {\n    await consoleLogSink.flush?.();\n  }\n}\n\nconst DATADOG_LOG_LEVEL = 'info';\nconst ZERO_SASS_DOMAIN = '.reflect-server.net';\n\nexport type LogOptions = {\n  readonly logLevel: LogLevel;\n  readonly logSink: LogSink;\n};\n\nexport function createLogOptions(\n  options: {\n    consoleLogLevel: LogLevel;\n    server: HTTPString | null;\n    enableAnalytics: boolean;\n  },\n  createDatadogLogSink: (options: DatadogLogSinkOptions) => LogSink = (\n    options: DatadogLogSinkOptions,\n  ) => new DatadogLogSink(options),\n): LogOptions {\n  const {consoleLogLevel, server, enableAnalytics} = options;\n\n  if (!enableAnalytics || server === null) {\n    return {\n      logLevel: consoleLogLevel,\n      logSink: consoleLogSink,\n    };\n  }\n\n  const serverURL = new URL(server);\n  const {hostname} = serverURL;\n  const datadogServiceLabel = hostname.endsWith(ZERO_SASS_DOMAIN)\n    ? hostname\n        .substring(0, hostname.length - ZERO_SASS_DOMAIN.length)\n        .toLowerCase()\n    : hostname;\n  const baseURL = new URL(appendPath(server, '/logs/v0/log'));\n  const logLevel = consoleLogLevel === 'debug' ? 'debug' : 'info';\n  const logSink = new TeeLogSink([\n    new LevelFilterLogSink(consoleLogSink, consoleLogLevel),\n    new LevelFilterLogSink(\n      createDatadogLogSink({\n        service: datadogServiceLabel,\n        host: location.host,\n        version,\n        baseURL,\n      }),\n      DATADOG_LOG_LEVEL,\n    ),\n  ]);\n  return {\n    logLevel,\n    logSink,\n  };\n}\n"],"names":["options"],"mappings":";;;;AAcA,MAAM,mBAAsC;AAAA,EACjC;AAAA,EACA;AAAA,EAET,YAAY,gBAAyB,OAAiB;AACpD,SAAK,kBAAkB;AACvB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,IAAI,OAAiB,YAAiC,MAAuB;AAC3E,QAAI,KAAK,WAAW,WAAW,UAAU,SAAS;AAChD;AAAA,IACF;AACA,QAAI,KAAK,WAAW,UAAU,UAAU,SAAS;AAC/C;AAAA,IACF;AACA,SAAK,gBAAgB,IAAI,OAAO,SAAS,GAAG,IAAI;AAAA,EAClD;AAAA,EAEA,MAAM,QAAQ;AACZ,UAAM,eAAe,QAAA;AAAA,EACvB;AACF;AAEA,MAAM,oBAAoB;AAC1B,MAAM,mBAAmB;AAOlB,SAAS,iBACd,SAKA,uBAAoE,CAClEA,aACG,IAAI,eAAeA,QAAO,GACnB;AACZ,QAAM,EAAC,iBAAiB,QAAQ,gBAAA,IAAmB;AAEnD,MAAI,CAAC,mBAAmB,WAAW,MAAM;AACvC,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAAS;AAAA,IAAA;AAAA,EAEb;AAEA,QAAM,YAAY,IAAI,IAAI,MAAM;AAChC,QAAM,EAAC,aAAY;AACnB,QAAM,sBAAsB,SAAS,SAAS,gBAAgB,IAC1D,SACG,UAAU,GAAG,SAAS,SAAS,iBAAiB,MAAM,EACtD,gBACH;AACJ,QAAM,UAAU,IAAI,IAAI,WAAW,QAAQ,cAAc,CAAC;AAC1D,QAAM,WAAW,oBAAoB,UAAU,UAAU;AACzD,QAAM,UAAU,IAAI,WAAW;AAAA,IAC7B,IAAI,mBAAmB,gBAAgB,eAAe;AAAA,IACtD,IAAI;AAAA,MACF,qBAAqB;AAAA,QACnB,SAAS;AAAA,QACT,MAAM,SAAS;AAAA,QACf;AAAA,QACA;AAAA,MAAA,CACD;AAAA,MACD;AAAA,IAAA;AAAA,EACF,CACD;AACD,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EAAA;AAEJ;"}

package/out/zero-client/src/client/make-mutate-property.d.ts

@@ -0,0 +1,43 @@
+import type { DeepMerge } from '../../../shared/src/deep-merge.ts';
+import type { Schema } from '../../../zero-types/src/schema.ts';
+import { type Transaction } from '../../../zql/src/mutate/custom.ts';
+import type { AnyMutatorRegistry } from '../../../zql/src/mutate/mutator-registry.ts';
+import { type MutatorDefinition } from '../../../zql/src/mutate/mutator.ts';
+import type { DBMutator } from './crud.ts';
+import type { CustomMutatorDefs, MutatorResult } from './custom.ts';
+import type { MutatorProxy } from './mutator-proxy.ts';
+/**
+ * Creates and populates a mutate property object by processing mutator definitions recursively.
+ *
+ * This function traverses through mutator definitions (either schema-based or custom) and builds
+ * a corresponding object structure where each mutator is wrapped by the mutator proxy. It handles
+ * both flat mutator functions and nested mutator definition objects.
+ *
+ * @template S - The schema type that defines the structure of the data
+ * @template C - The context type used by mutators, defaults to unknown
+ *
+ * @param mutators - The mutator definitions to process, can be schema-based or custom mutator definitions
+ * @param mutatorProxy - The proxy object responsible for wrapping mutators with additional functionality
+ * @param mutateObject - The target object to populate with wrapped mutators
+ * @param replicacheMutate - The source object containing the actual mutator implementations to wrap
+ *
+ * @returns void - This function mutates the mutateObject parameter directly
+ *
+ * @remarks
+ * The function recursively processes nested mutator structures, creating corresponding nested objects
+ * in the mutateObject. For leaf mutators (functions or mutator definitions), it generates a full key
+ * using different separators ('.' for mutator definitions, '|' for custom functions) and wraps them
+ * using the mutator proxy.
+ */
+export declare function makeMutateProperty(mutators: AnyMutatorRegistry | CustomMutatorDefs, mutatorProxy: MutatorProxy, mutateObject: Record<string, unknown>, replicacheMutate: Record<string, unknown>): void;
+/**
+ * Builds the mutate type from mutator definitions, handling arbitrary nesting.
+ * Each node can be either a MutatorDefinition or a CustomMutatorImpl function,
+ * or a namespace containing more mutators.
+ */
+type MakeFromMutatorDefinitions<S extends Schema, MD extends AnyMutatorRegistry | CustomMutatorDefs, C> = {
+    readonly [K in keyof MD]: MD[K] extends MutatorDefinition<S, C, infer TInput, any, any> ? [TInput] extends [undefined] ? () => MutatorResult : undefined extends TInput ? (args?: TInput) => MutatorResult : (args: TInput) => MutatorResult : MD[K] extends (tx: Transaction<S>, ...args: infer Args) => Promise<void> ? (...args: Args) => MutatorResult : MD[K] extends AnyMutatorRegistry | CustomMutatorDefs ? MakeFromMutatorDefinitions<S, MD[K], C> : never;
+};
+export type MakeMutatePropertyType<S extends Schema, MD extends AnyMutatorRegistry | CustomMutatorDefs | undefined, C> = MD extends AnyMutatorRegistry ? {} : MD extends AnyMutatorRegistry | CustomMutatorDefs ? S['enableLegacyMutators'] extends false ? MakeFromMutatorDefinitions<S, MD, C> : DeepMerge<DBMutator<S>, MakeFromMutatorDefinitions<S, MD, C>> : DBMutator<S>;
+export {};
+//# sourceMappingURL=make-mutate-property.d.ts.map

package/out/zero-client/src/client/make-mutate-property.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-mutate-property.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/make-mutate-property.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,mCAAmC,CAAC;AAEjE,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAEL,KAAK,WAAW,EACjB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,6CAA6C,CAAC;AACpF,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAC,iBAAiB,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,kBAAkB,GAAG,iBAAiB,EAChD,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,IAAI,CAwCN;AAED;;;;GAIG;AACH,KAAK,0BAA0B,CAC7B,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,kBAAkB,GAAG,iBAAiB,EACjD,CAAC,IACC;IACF,QAAQ,EAAE,CAAC,IAAI,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,iBAAiB,CACvD,CAAC,EACD,CAAC,EACD,MAAM,MAAM,EAEZ,GAAG,EAEH,GAAG,CACJ,GACG,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAC1B,MAAM,aAAa,GACnB,SAAS,SAAS,MAAM,GACtB,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,aAAa,GAChC,CAAC,IAAI,EAAE,MAAM,KAAK,aAAa,GACnC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,GACtE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,aAAa,GAChC,EAAE,CAAC,CAAC,CAAC,SAAS,kBAAkB,GAAG,iBAAiB,GAClD,0BAA0B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GACvC,KAAK;CACd,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAChC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,kBAAkB,GAAG,iBAAiB,GAAG,SAAS,EAC7D,CAAC,IACC,EAAE,SAAS,kBAAkB,GAE7B,EAAE,GACF,EAAE,SAAS,kBAAkB,GAAG,iBAAiB,GAC/C,CAAC,CAAC,sBAAsB,CAAC,SAAS,KAAK,GACrC,0BAA0B,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,GACpC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,GAC/D,SAAS,CAAC,CAAC,CAAC,CAAC"}

package/out/zero-client/src/client/make-mutate-property.js

@@ -0,0 +1,38 @@
+import { must } from "../../../shared/src/must.js";
+import { customMutatorKey } from "../../../zql/src/mutate/custom.js";
+import { isMutator } from "../../../zql/src/mutate/mutator.js";
+function makeMutateProperty(mutators, mutatorProxy, mutateObject, replicacheMutate) {
+  const processMutators = (mutators2, path, mutateObject2) => {
+    for (const [key, mutator] of Object.entries(mutators2)) {
+      path.push(key);
+      let fullKey;
+      if (isMutator(mutator)) {
+        fullKey = customMutatorKey(".", path);
+      } else if (typeof mutator === "function") {
+        fullKey = customMutatorKey("|", path);
+      }
+      if (fullKey) {
+        mutateObject2[key] = mutatorProxy.wrapCustomMutator(
+          must(replicacheMutate[fullKey])
+        );
+      } else {
+        let existing = mutateObject2[key];
+        if (existing === void 0) {
+          existing = {};
+          mutateObject2[key] = existing;
+        }
+        processMutators(
+          mutator,
+          path,
+          existing
+        );
+      }
+      path.pop();
+    }
+  };
+  processMutators(mutators, [], mutateObject);
+}
+export {
+  makeMutateProperty
+};
+//# sourceMappingURL=make-mutate-property.js.map

package/out/zero-client/src/client/make-mutate-property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-mutate-property.js","sources":["../../../../../zero-client/src/client/make-mutate-property.ts"],"sourcesContent":["import type {DeepMerge} from '../../../shared/src/deep-merge.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport {\n  customMutatorKey,\n  type Transaction,\n} from '../../../zql/src/mutate/custom.ts';\nimport type {AnyMutatorRegistry} from '../../../zql/src/mutate/mutator-registry.ts';\nimport {\n  isMutator,\n  type MutatorDefinition,\n} from '../../../zql/src/mutate/mutator.ts';\nimport type {DBMutator} from './crud.ts';\nimport type {CustomMutatorDefs, MutatorResult} from './custom.ts';\nimport type {MutatorProxy} from './mutator-proxy.ts';\n\n/**\n * Creates and populates a mutate property object by processing mutator definitions recursively.\n *\n * This function traverses through mutator definitions (either schema-based or custom) and builds\n * a corresponding object structure where each mutator is wrapped by the mutator proxy. It handles\n * both flat mutator functions and nested mutator definition objects.\n *\n * @template S - The schema type that defines the structure of the data\n * @template C - The context type used by mutators, defaults to unknown\n *\n * @param mutators - The mutator definitions to process, can be schema-based or custom mutator definitions\n * @param mutatorProxy - The proxy object responsible for wrapping mutators with additional functionality\n * @param mutateObject - The target object to populate with wrapped mutators\n * @param replicacheMutate - The source object containing the actual mutator implementations to wrap\n *\n * @returns void - This function mutates the mutateObject parameter directly\n *\n * @remarks\n * The function recursively processes nested mutator structures, creating corresponding nested objects\n * in the mutateObject. For leaf mutators (functions or mutator definitions), it generates a full key\n * using different separators ('.' for mutator definitions, '|' for custom functions) and wraps them\n * using the mutator proxy.\n */\nexport function makeMutateProperty(\n  mutators: AnyMutatorRegistry | CustomMutatorDefs,\n  mutatorProxy: MutatorProxy,\n  mutateObject: Record<string, unknown>,\n  replicacheMutate: Record<string, unknown>,\n): void {\n  const processMutators = (\n    mutators: AnyMutatorRegistry | CustomMutatorDefs,\n    path: string[],\n    mutateObject: Record<string, unknown>,\n  ) => {\n    for (const [key, mutator] of Object.entries(mutators)) {\n      path.push(key);\n      let fullKey: string | undefined;\n      if (isMutator(mutator)) {\n        fullKey = customMutatorKey('.', path);\n      } else if (typeof mutator === 'function') {\n        // Legacy CustomMutatorImpl\n        fullKey = customMutatorKey('|', path);\n      }\n\n      if (fullKey) {\n        mutateObject[key] = mutatorProxy.wrapCustomMutator(\n          must(replicacheMutate[fullKey]) as unknown as (\n            ...args: unknown[]\n          ) => MutatorResult,\n        );\n      } else {\n        // recursive build and process.\n        let existing = mutateObject[key];\n        if (existing === undefined) {\n          existing = {};\n          mutateObject[key] = existing;\n        }\n        processMutators(\n          mutator as AnyMutatorRegistry | CustomMutatorDefs,\n          path,\n          existing as Record<string, unknown>,\n        );\n      }\n      path.pop();\n    }\n  };\n\n  processMutators(mutators, [], mutateObject);\n}\n\n/**\n * Builds the mutate type from mutator definitions, handling arbitrary nesting.\n * Each node can be either a MutatorDefinition or a CustomMutatorImpl function,\n * or a namespace containing more mutators.\n */\ntype MakeFromMutatorDefinitions<\n  S extends Schema,\n  MD extends AnyMutatorRegistry | CustomMutatorDefs,\n  C,\n> = {\n  readonly [K in keyof MD]: MD[K] extends MutatorDefinition<\n    S,\n    C,\n    infer TInput,\n    // oxlint-disable-next-line no-explicit-any\n    any,\n    // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >\n    ? [TInput] extends [undefined]\n      ? () => MutatorResult\n      : undefined extends TInput\n        ? (args?: TInput) => MutatorResult\n        : (args: TInput) => MutatorResult\n    : MD[K] extends (tx: Transaction<S>, ...args: infer Args) => Promise<void>\n      ? (...args: Args) => MutatorResult\n      : MD[K] extends AnyMutatorRegistry | CustomMutatorDefs\n        ? MakeFromMutatorDefinitions<S, MD[K], C>\n        : never;\n};\n\nexport type MakeMutatePropertyType<\n  S extends Schema,\n  MD extends AnyMutatorRegistry | CustomMutatorDefs | undefined,\n  C,\n> = MD extends AnyMutatorRegistry\n  ? // MutatorRegistry: no property tree, user calls zero.mutate(mr) directly\n    {}\n  : MD extends AnyMutatorRegistry | CustomMutatorDefs\n    ? S['enableLegacyMutators'] extends false\n      ? MakeFromMutatorDefinitions<S, MD, C>\n      : DeepMerge<DBMutator<S>, MakeFromMutatorDefinitions<S, MD, C>>\n    : DBMutator<S>;\n"],"names":["mutators","mutateObject"],"mappings":";;;AAuCO,SAAS,mBACd,UACA,cACA,cACA,kBACM;AACN,QAAM,kBAAkB,CACtBA,WACA,MACAC,kBACG;AACH,eAAW,CAAC,KAAK,OAAO,KAAK,OAAO,QAAQD,SAAQ,GAAG;AACrD,WAAK,KAAK,GAAG;AACb,UAAI;AACJ,UAAI,UAAU,OAAO,GAAG;AACtB,kBAAU,iBAAiB,KAAK,IAAI;AAAA,MACtC,WAAW,OAAO,YAAY,YAAY;AAExC,kBAAU,iBAAiB,KAAK,IAAI;AAAA,MACtC;AAEA,UAAI,SAAS;AACXC,sBAAa,GAAG,IAAI,aAAa;AAAA,UAC/B,KAAK,iBAAiB,OAAO,CAAC;AAAA,QAAA;AAAA,MAIlC,OAAO;AAEL,YAAI,WAAWA,cAAa,GAAG;AAC/B,YAAI,aAAa,QAAW;AAC1B,qBAAW,CAAA;AACXA,wBAAa,GAAG,IAAI;AAAA,QACtB;AACA;AAAA,UACE;AAAA,UACA;AAAA,UACA;AAAA,QAAA;AAAA,MAEJ;AACA,WAAK,IAAA;AAAA,IACP;AAAA,EACF;AAEA,kBAAgB,UAAU,CAAA,GAAI,YAAY;AAC5C;"}

package/out/zero-client/src/client/make-replicache-mutators.d.ts

@@ -0,0 +1,34 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { Schema } from '../../../zero-types/src/schema.ts';
+import { type AnyMutatorRegistry } from '../../../zql/src/mutate/mutator-registry.ts';
+import type { CustomMutatorDefs } from './custom.ts';
+import type { MutatorDefs } from '../../../replicache/src/types.ts';
+import { type CRUDMutator } from './crud.ts';
+export declare function extendReplicacheMutators<S extends Schema, C>(lc: LogContext, context: C, mutators: AnyMutatorRegistry | CustomMutatorDefs, schema: S, mutateObject: Record<string, unknown>): void;
+/**
+ * Creates Replicache mutators from mutator definitions.
+ *
+ * This function processes mutator definitions at arbitrary depth, supporting both
+ * new-style mutator definitions and legacy custom mutator implementations. It creates
+ * a mutator object with the CRUD mutator and any provided custom mutators, with keys
+ * generated based on their path in the mutator definition hierarchy.
+ *
+ * @template S - The schema type that defines the structure of the data
+ * @template C - The type of the context object passed to mutators
+ *
+ * @param schema - The schema instance used for validation and type checking
+ * @param mutators - The mutator definitions to process, can be nested objects or custom mutator definitions
+ * @param context - The context to be passed to mutators
+ * @param lc - The log context used for logging operations
+ *
+ * @returns A mutator definitions object containing the CRUD mutator and any custom mutators
+ *
+ * @remarks
+ * - New-style mutator definitions use '.' as a separator in their keys
+ * - Legacy custom mutator implementations use '|' as a separator in their keys
+ * - The CRUD mutator can be disabled by setting `enableLegacyMutators: false` in the schema
+ */
+export declare function makeReplicacheMutators<const S extends Schema, C>(schema: S, mutators: AnyMutatorRegistry | CustomMutatorDefs | undefined, context: C, lc: LogContext): MutatorDefs & {
+    _zero_crud: CRUDMutator;
+};
+//# sourceMappingURL=make-replicache-mutators.d.ts.map

package/out/zero-client/src/client/make-replicache-mutators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-replicache-mutators.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/make-replicache-mutators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAE9D,OAAO,EAEL,KAAK,kBAAkB,EACxB,MAAM,6CAA6C,CAAC;AAErD,OAAO,KAAK,EAAC,iBAAiB,EAAoB,MAAM,aAAa,CAAC;AAEtE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,kCAAkC,CAAC;AAIlE,OAAO,EAAkB,KAAK,WAAW,EAAC,MAAM,WAAW,CAAC;AAQ5D,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAC1D,EAAE,EAAE,UAAU,EACd,OAAO,EAAE,CAAC,EACV,QAAQ,EAAE,kBAAkB,GAAG,iBAAiB,EAChD,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpC,IAAI,CA8BN;AA2BD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAC9D,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,SAAS,EAC5D,OAAO,EAAE,CAAC,EACV,EAAE,EAAE,UAAU,GACb,WAAW,GAAG;IAAC,UAAU,EAAE,WAAW,CAAA;CAAC,CAoCzC"}

package/out/zero-client/src/client/make-replicache-mutators.js

@@ -0,0 +1,103 @@
+import { customMutatorKey } from "../../../zql/src/mutate/custom.js";
+import { isMutatorRegistry } from "../../../zql/src/mutate/mutator-registry.js";
+import { CRUD_MUTATION_NAME } from "../../../zero-protocol/src/push.js";
+import { Internal } from "./client-error-kind-enum.js";
+import { makeCRUDMutator } from "./crud.js";
+import { TransactionImpl, makeReplicacheMutator as makeReplicacheMutator$1 } from "./custom.js";
+import { ClientError } from "./error.js";
+function extendReplicacheMutators(lc, context, mutators, schema, mutateObject) {
+  const processMutators = (mutators2, path) => {
+    for (const [key, mutator] of Object.entries(mutators2)) {
+      path.push(key);
+      if (isMutator(mutator)) {
+        const fullKey = customMutatorKey(".", path);
+        mutateObject[fullKey] = makeReplicacheMutator(
+          lc,
+          mutator,
+          schema,
+          context
+        );
+      } else if (typeof mutator === "function") {
+        const fullKey = customMutatorKey("|", path);
+        mutateObject[fullKey] = makeReplicacheMutator$1(
+          lc,
+          // oxlint-disable-next-line no-explicit-any
+          mutator,
+          schema,
+          context
+        );
+      } else {
+        processMutators(mutator, path);
+      }
+      path.pop();
+    }
+  };
+  processMutators(mutators, []);
+}
+function makeReplicacheMutator(lc, mutator, schema, context) {
+  return async (repTx, args) => {
+    const tx = new TransactionImpl(lc, repTx, schema);
+    await mutator.fn({
+      args,
+      ctx: context,
+      tx
+    });
+  };
+}
+function makeReplicacheMutators(schema, mutators, context, lc) {
+  const { enableLegacyMutators = true } = schema;
+  const replicacheMutators = {
+    [CRUD_MUTATION_NAME]: enableLegacyMutators ? makeCRUDMutator(schema) : () => Promise.reject(
+      new ClientError({
+        kind: Internal,
+        message: "Zero CRUD mutators are not enabled."
+      })
+    )
+  };
+  if (mutators) {
+    if (isMutatorRegistry(mutators)) {
+      extendFromMutatorRegistry(
+        lc,
+        context,
+        mutators,
+        schema,
+        replicacheMutators
+      );
+    } else {
+      extendReplicacheMutators(
+        lc,
+        context,
+        mutators,
+        schema,
+        replicacheMutators
+      );
+    }
+  }
+  return replicacheMutators;
+}
+function isMutator(value) {
+  return typeof value === "function" && "mutatorName" in value && typeof value.mutatorName === "string" && "fn" in value && typeof value.fn === "function";
+}
+function extendFromMutatorRegistry(lc, context, registry, schema, mutateObject) {
+  const walk = (node) => {
+    if (typeof node !== "object" || node === null) {
+      return;
+    }
+    for (const value of Object.values(node)) {
+      if (isMutator(value)) {
+        mutateObject[value.mutatorName] = (repTx, args) => {
+          const tx = new TransactionImpl(lc, repTx, schema);
+          return value.fn({ args, ctx: context, tx });
+        };
+      } else if (typeof value === "object" && value !== null) {
+        walk(value);
+      }
+    }
+  };
+  walk(registry);
+}
+export {
+  extendReplicacheMutators,
+  makeReplicacheMutators
+};
+//# sourceMappingURL=make-replicache-mutators.js.map

package/out/zero-client/src/client/make-replicache-mutators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-replicache-mutators.js","sources":["../../../../../zero-client/src/client/make-replicache-mutators.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport {customMutatorKey} from '../../../zql/src/mutate/custom.ts';\nimport {\n  isMutatorRegistry,\n  type AnyMutatorRegistry,\n} from '../../../zql/src/mutate/mutator-registry.ts';\nimport {type Mutator} from '../../../zql/src/mutate/mutator.ts';\nimport type {CustomMutatorDefs, CustomMutatorImpl} from './custom.ts';\n\nimport type {MutatorDefs} from '../../../replicache/src/types.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport {CRUD_MUTATION_NAME} from '../../../zero-protocol/src/push.ts';\nimport {ClientErrorKind} from './client-error-kind.ts';\nimport {makeCRUDMutator, type CRUDMutator} from './crud.ts';\nimport {\n  makeReplicacheMutator as makeReplicacheMutatorLegacy,\n  TransactionImpl,\n} from './custom.ts';\nimport {ClientError} from './error.ts';\nimport type {WriteTransaction} from './replicache-types.ts';\n\nexport function extendReplicacheMutators<S extends Schema, C>(\n  lc: LogContext,\n  context: C,\n  mutators: AnyMutatorRegistry | CustomMutatorDefs,\n  schema: S,\n  mutateObject: Record<string, unknown>,\n): void {\n  // Recursively process mutator definitions at arbitrary depth\n  const processMutators = (mutators: object, path: string[]) => {\n    for (const [key, mutator] of Object.entries(mutators)) {\n      path.push(key);\n      if (isMutator(mutator)) {\n        const fullKey = customMutatorKey('.', path);\n        mutateObject[fullKey] = makeReplicacheMutator(\n          lc,\n          mutator,\n          schema,\n          context,\n        );\n      } else if (typeof mutator === 'function') {\n        const fullKey = customMutatorKey('|', path);\n        mutateObject[fullKey] = makeReplicacheMutatorLegacy(\n          lc,\n          // oxlint-disable-next-line no-explicit-any\n          mutator as CustomMutatorImpl<any>,\n          schema,\n          context,\n        );\n      } else {\n        processMutators(mutator, path);\n      }\n      path.pop();\n    }\n  };\n\n  processMutators(mutators, []);\n}\n\nfunction makeReplicacheMutator<\n  TSchema extends Schema,\n  TContext,\n  TArgs extends ReadonlyJSONValue | undefined,\n  TWrappedTransaction,\n>(\n  lc: LogContext,\n  mutator: Mutator<TSchema, TContext, TArgs, TWrappedTransaction>,\n  schema: TSchema,\n  context: TContext,\n): (repTx: WriteTransaction, args: ReadonlyJSONValue) => Promise<void> {\n  return async (\n    repTx: WriteTransaction,\n    args: ReadonlyJSONValue,\n  ): Promise<void> => {\n    const tx = new TransactionImpl(lc, repTx, schema);\n    // fn does input validation internally\n    await mutator.fn({\n      args: args as TArgs,\n      ctx: context,\n      tx: tx,\n    });\n  };\n}\n\n/**\n * Creates Replicache mutators from mutator definitions.\n *\n * This function processes mutator definitions at arbitrary depth, supporting both\n * new-style mutator definitions and legacy custom mutator implementations. It creates\n * a mutator object with the CRUD mutator and any provided custom mutators, with keys\n * generated based on their path in the mutator definition hierarchy.\n *\n * @template S - The schema type that defines the structure of the data\n * @template C - The type of the context object passed to mutators\n *\n * @param schema - The schema instance used for validation and type checking\n * @param mutators - The mutator definitions to process, can be nested objects or custom mutator definitions\n * @param context - The context to be passed to mutators\n * @param lc - The log context used for logging operations\n *\n * @returns A mutator definitions object containing the CRUD mutator and any custom mutators\n *\n * @remarks\n * - New-style mutator definitions use '.' as a separator in their keys\n * - Legacy custom mutator implementations use '|' as a separator in their keys\n * - The CRUD mutator can be disabled by setting `enableLegacyMutators: false` in the schema\n */\nexport function makeReplicacheMutators<const S extends Schema, C>(\n  schema: S,\n  mutators: AnyMutatorRegistry | CustomMutatorDefs | undefined,\n  context: C,\n  lc: LogContext,\n): MutatorDefs & {_zero_crud: CRUDMutator} {\n  const {enableLegacyMutators = true} = schema;\n\n  const replicacheMutators = {\n    [CRUD_MUTATION_NAME]: enableLegacyMutators\n      ? makeCRUDMutator(schema)\n      : () =>\n          Promise.reject(\n            new ClientError({\n              kind: ClientErrorKind.Internal,\n              message: 'Zero CRUD mutators are not enabled.',\n            }),\n          ),\n  };\n\n  if (mutators) {\n    if (isMutatorRegistry(mutators)) {\n      extendFromMutatorRegistry(\n        lc,\n        context,\n        mutators,\n        schema,\n        replicacheMutators,\n      );\n    } else {\n      extendReplicacheMutators(\n        lc,\n        context,\n        mutators as CustomMutatorDefs,\n        schema,\n        replicacheMutators,\n      );\n    }\n  }\n\n  return replicacheMutators;\n}\n\n/**\n * Checks if a value is a Mutator (from MutatorRegistry).\n * Mutators have `mutatorName` and `fn` properties.\n */\nfunction isMutator(\n  value: unknown,\n  // oxlint-disable-next-line no-explicit-any\n): value is Mutator<any, any, any, any> {\n  return (\n    typeof value === 'function' &&\n    'mutatorName' in value &&\n    typeof value.mutatorName === 'string' &&\n    'fn' in value &&\n    typeof value.fn === 'function'\n  );\n}\n\n/**\n * Extends replicache mutators from a MutatorRegistry.\n * Walks the registry tree and wraps each Mutator.fn for Replicache.\n */\nfunction extendFromMutatorRegistry<S extends Schema, C>(\n  lc: LogContext,\n  context: C,\n  registry: AnyMutatorRegistry,\n  schema: S,\n  mutateObject: Record<string, unknown>,\n): void {\n  const walk = (node: unknown) => {\n    if (typeof node !== 'object' || node === null) {\n      return;\n    }\n    for (const value of Object.values(node)) {\n      if (isMutator(value)) {\n        // Mutator.fn already handles validation internally\n        mutateObject[value.mutatorName] = (\n          repTx: WriteTransaction,\n          args: ReadonlyJSONValue,\n        ): Promise<void> => {\n          const tx = new TransactionImpl(lc, repTx, schema);\n          return value.fn({args, ctx: context, tx});\n        };\n      } else if (typeof value === 'object' && value !== null) {\n        // Nested namespace\n        walk(value);\n      }\n    }\n  };\n  walk(registry);\n}\n"],"names":["mutators","makeReplicacheMutatorLegacy","ClientErrorKind.Internal"],"mappings":";;;;;;;AAsBO,SAAS,yBACd,IACA,SACA,UACA,QACA,cACM;AAEN,QAAM,kBAAkB,CAACA,WAAkB,SAAmB;AAC5D,eAAW,CAAC,KAAK,OAAO,KAAK,OAAO,QAAQA,SAAQ,GAAG;AACrD,WAAK,KAAK,GAAG;AACb,UAAI,UAAU,OAAO,GAAG;AACtB,cAAM,UAAU,iBAAiB,KAAK,IAAI;AAC1C,qBAAa,OAAO,IAAI;AAAA,UACtB;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QAAA;AAAA,MAEJ,WAAW,OAAO,YAAY,YAAY;AACxC,cAAM,UAAU,iBAAiB,KAAK,IAAI;AAC1C,qBAAa,OAAO,IAAIC;AAAAA,UACtB;AAAA;AAAA,UAEA;AAAA,UACA;AAAA,UACA;AAAA,QAAA;AAAA,MAEJ,OAAO;AACL,wBAAgB,SAAS,IAAI;AAAA,MAC/B;AACA,WAAK,IAAA;AAAA,IACP;AAAA,EACF;AAEA,kBAAgB,UAAU,EAAE;AAC9B;AAEA,SAAS,sBAMP,IACA,SACA,QACA,SACqE;AACrE,SAAO,OACL,OACA,SACkB;AAClB,UAAM,KAAK,IAAI,gBAAgB,IAAI,OAAO,MAAM;AAEhD,UAAM,QAAQ,GAAG;AAAA,MACf;AAAA,MACA,KAAK;AAAA,MACL;AAAA,IAAA,CACD;AAAA,EACH;AACF;AAyBO,SAAS,uBACd,QACA,UACA,SACA,IACyC;AACzC,QAAM,EAAC,uBAAuB,KAAA,IAAQ;AAEtC,QAAM,qBAAqB;AAAA,IACzB,CAAC,kBAAkB,GAAG,uBAClB,gBAAgB,MAAM,IACtB,MACE,QAAQ;AAAA,MACN,IAAI,YAAY;AAAA,QACd,MAAMC;AAAAA,QACN,SAAS;AAAA,MAAA,CACV;AAAA,IAAA;AAAA,EACH;AAGR,MAAI,UAAU;AACZ,QAAI,kBAAkB,QAAQ,GAAG;AAC/B;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MAAA;AAAA,IAEJ,OAAO;AACL;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AAEA,SAAO;AACT;AAMA,SAAS,UACP,OAEsC;AACtC,SACE,OAAO,UAAU,cACjB,iBAAiB,SACjB,OAAO,MAAM,gBAAgB,YAC7B,QAAQ,SACR,OAAO,MAAM,OAAO;AAExB;AAMA,SAAS,0BACP,IACA,SACA,UACA,QACA,cACM;AACN,QAAM,OAAO,CAAC,SAAkB;AAC9B,QAAI,OAAO,SAAS,YAAY,SAAS,MAAM;AAC7C;AAAA,IACF;AACA,eAAW,SAAS,OAAO,OAAO,IAAI,GAAG;AACvC,UAAI,UAAU,KAAK,GAAG;AAEpB,qBAAa,MAAM,WAAW,IAAI,CAChC,OACA,SACkB;AAClB,gBAAM,KAAK,IAAI,gBAAgB,IAAI,OAAO,MAAM;AAChD,iBAAO,MAAM,GAAG,EAAC,MAAM,KAAK,SAAS,IAAG;AAAA,QAC1C;AAAA,MACF,WAAW,OAAO,UAAU,YAAY,UAAU,MAAM;AAEtD,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AACA,OAAK,QAAQ;AACf;"}

package/out/zero-client/src/client/metric-name-enum.js

@@ -0,0 +1,15 @@
+const TimeToConnectMs = "time_to_connect_ms";
+const LastConnectError = "last_connect_error";
+const TimeToConnectMsV2 = "time_to_connect_ms_v2";
+const LastConnectErrorV2 = "last_connect_error_v2";
+const TotalTimeToConnectMs = "total_time_to_connect_ms";
+const NotConnected = "not_connected";
+export {
+  LastConnectError,
+  LastConnectErrorV2,
+  NotConnected,
+  TimeToConnectMs,
+  TimeToConnectMsV2,
+  TotalTimeToConnectMs
+};
+//# sourceMappingURL=metric-name-enum.js.map

package/out/zero-client/src/client/metric-name-enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric-name-enum.js","sources":["../../../../../zero-client/src/client/metric-name-enum.ts"],"sourcesContent":["export const TimeToConnectMs = 'time_to_connect_ms';\nexport const LastConnectError = 'last_connect_error';\nexport const TimeToConnectMsV2 = 'time_to_connect_ms_v2';\nexport const LastConnectErrorV2 = 'last_connect_error_v2';\nexport const TotalTimeToConnectMs = 'total_time_to_connect_ms';\nexport const NotConnected = 'not_connected';\n\nexport type TimeToConnectMs = typeof TimeToConnectMs;\nexport type LastConnectError = typeof LastConnectError;\nexport type TimeToConnectMsV2 = typeof TimeToConnectMsV2;\nexport type LastConnectErrorV2 = typeof LastConnectErrorV2;\nexport type TotalTimeToConnectMs = typeof TotalTimeToConnectMs;\nexport type NotConnected = typeof NotConnected;\n"],"names":[],"mappings":"AAAO,MAAM,kBAAkB;AACxB,MAAM,mBAAmB;AACzB,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAC3B,MAAM,uBAAuB;AAC7B,MAAM,eAAe;"}

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

@@ -1 +1 @@
-{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/metrics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAGL,KAAK,SAAS,EAEf,MAAM,YAAY,CAAC;AAOpB,eAAO,MAAM,qBAAqB,QAAa,CAAC;AAEhD,eAAO,MAAM,kBAAkB,OAAQ,CAAC;AASxC,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,2CAEzD;AAYD;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAcnE;AAED,KAAK,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;AAEjE,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,eAAe,CAAC;IAC1B,EAAE,EAAE,UAAU,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAa;;gBAOZ,IAAI,EAAE,oBAAoB;IAqCtC,QAAQ,CAAC,eAAe,QAEtB;IAMF,QAAQ,CAAC,gBAAgB,QAKvB;IAqCF,YAAY,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM;IAOlE,gCAAgC;IAmBhC,eAAe,CAAC,MAAM,EAAE,SAAS;IAOjC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAM;IAIvB,KAAK;IA4BX,IAAI;CAaL;AAMD,6DAA6D;AAC7D,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AACF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAMvC,KAAK,SAAS,GAAG;IACf,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAC,GAAG,SAAS,CAAC;CACxD,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,qBAAa,KAAM,YAAW,SAAS;;gBAIzB,IAAI,EAAE,MAAM;IAIxB,GAAG,CAAC,KAAK,EAAE,MAAM;IAIjB,GAAG;IAIH,KAAK;IAIL,KAAK;;;;CASN;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,KAAM,YAAW,SAAS;;gBAKzB,MAAM,EAAE,MAAM,EAAE,YAAY,UAAQ;IAKhD,GAAG,CAAC,KAAK,EAAE,MAAM;IAIjB,GAAG;IAIH,KAAK;IAIL,KAAK;;;;CAYN"}
+{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/metrics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAGL,KAAK,SAAS,EAEf,MAAM,YAAY,CAAC;AAOpB,eAAO,MAAM,qBAAqB,QAAa,CAAC;AAEhD,eAAO,MAAM,kBAAkB,OAAQ,CAAC;AASxC,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,2CAEzD;AAYD;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAcnE;AAED,KAAK,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;AAEjE,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,eAAe,CAAC;IAC1B,EAAE,EAAE,UAAU,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAa;;gBAOZ,IAAI,EAAE,oBAAoB;IAiCtC,QAAQ,CAAC,eAAe,QAEtB;IAMF,QAAQ,CAAC,gBAAgB,QAKvB;IAqCF,YAAY,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM;IAOlE,gCAAgC;IAmBhC,eAAe,CAAC,MAAM,EAAE,SAAS;IAOjC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAM;IAIvB,KAAK;IA4BX,IAAI;CAaL;AAMD,6DAA6D;AAC7D,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AACF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAMvC,KAAK,SAAS,GAAG;IACf,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAC,GAAG,SAAS,CAAC;CACxD,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,qBAAa,KAAM,YAAW,SAAS;;gBAIzB,IAAI,EAAE,MAAM;IAIxB,GAAG,CAAC,KAAK,EAAE,MAAM;IAIjB,GAAG;IAIH,KAAK;IAIL,KAAK;;;;CASN;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,KAAM,YAAW,SAAS;;gBAKzB,MAAM,EAAE,MAAM,EAAE,YAAY,UAAQ;IAKhD,GAAG,CAAC,KAAK,EAAE,MAAM;IAIjB,GAAG;IAIH,KAAK;IAIL,KAAK;;;;CAYN"}

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

@@ -0,0 +1,249 @@
+import { AbruptClose, CleanClose, UserDisconnect, ClientClosed, Hidden } from "./client-error-kind-enum.js";
+import { isClientError, isServerError } from "./error.js";
+import { TimeToConnectMs, LastConnectError, NotConnected, TimeToConnectMsV2, LastConnectErrorV2, TotalTimeToConnectMs } from "./metric-name-enum.js";
+const DID_NOT_CONNECT_VALUE = 100 * 1e3;
+const REPORT_INTERVAL_MS = 5e3;
+function getLastConnectErrorValue(reason) {
+  return `${isServerError(reason) ? "server_" : "client_"}${camelToSnake(reason.kind)}`;
+}
+function camelToSnake(kind) {
+  return kind.split(/\.?(?=[A-Z])/).join("_").toLowerCase();
+}
+function shouldReportConnectError(reason) {
+  if (!isClientError(reason)) {
+    return true;
+  }
+  switch (reason.kind) {
+    case Hidden:
+    case ClientClosed:
+    case UserDisconnect:
+    case CleanClose:
+    case AbruptClose:
+      return false;
+    default:
+      return true;
+  }
+}
+class MetricManager {
+  #reportIntervalMs;
+  #host;
+  #reporter;
+  #lc;
+  #timerID;
+  constructor(opts) {
+    this.#reportIntervalMs = opts.reportIntervalMs;
+    this.#host = opts.host;
+    this.#reporter = opts.reporter;
+    this.#lc = opts.lc;
+    this.tags.push(`source:${opts.source}`);
+    this.timeToConnectMs.set(DID_NOT_CONNECT_VALUE);
+    this.#setNotConnectedReason("init");
+    this.#timerID = setInterval(() => {
+      void this.flush();
+    }, this.#reportIntervalMs);
+  }
+  #metrics = [];
+  // timeToConnectMs measures the time from the call to connect() to receiving
+  // the 'connected' ws message. We record the DID_NOT_CONNECT_VALUE if the previous
+  // connection attempt failed for any reason.
+  //
+  // We set the gauge using #connectStart as follows:
+  // - #connectStart is undefined if we are disconnected or connected; it is
+  //   defined only in the Connecting state, as a number representing the timestamp
+  //   at which we started connecting.
+  // - #connectStart is set to the current time when connect() is called.
+  // - When we receive the 'connected' message we record the time to connect and
+  //   set #connectStart to undefined.
+  // - If disconnect() is called with a defined #connectStart then we record
+  //   DID_NOT_CONNECT_VALUE and set #connectStart to undefined.
+  //
+  // TODO: this should be folded into the ConnectionManager.
+  timeToConnectMs = this.#register(
+    new Gauge(TimeToConnectMs)
+  );
+  // lastConnectError records the last error that occurred when connecting,
+  // if any. It is cleared when connecting successfully or when reported, so this
+  // state only gets reported if there was a failure during the reporting period and
+  // we are still not connected.
+  lastConnectError = this.#register(
+    new State(
+      LastConnectError,
+      true
+      // clearOnFlush
+    )
+  );
+  // notConnected records the reason why the client is not currently connected.
+  // It is cleared when the client successfully connects.
+  #notConnected = this.#register(new State(NotConnected));
+  // The time from the call to connect() to receiving the 'connected' ws message
+  // for the current connection.  Cleared when the client is not connected.
+  // TODO: Not actually currently cleared on disconnect untill there is a
+  // connect error, or client reports disconnected and waiting for visible.
+  // Should have a value iff _notConnected has no value.
+  #timeToConnectMsV2 = this.#register(
+    new Gauge(TimeToConnectMsV2)
+  );
+  // lastConnectErrorV2 records the last error that occurred when connecting,
+  // if any. It is cleared when the client successfully connects or
+  // stops trying to connect due to being hidden.
+  // Should have a value iff notConnected state is NotConnectedReason.Error.
+  #lastConnectErrorV2 = this.#register(
+    new State(LastConnectErrorV2)
+  );
+  // The total time it took to connect across retries for the current
+  // connection.  Cleared when the client is not connected.
+  // TODO: Not actually currently cleared on disconnect until there is a
+  // connect error, or client reports disconnected and waiting for visible.
+  // See Zero.#totalToConnectStart for details of how this total is computed.
+  // Should have a value iff _notConnected has no value.
+  #totalTimeToConnectMs = this.#register(
+    new Gauge(TotalTimeToConnectMs)
+  );
+  #setNotConnectedReason(reason) {
+    this.#notConnected.set(reason);
+  }
+  setConnected(timeToConnectMs, totalTimeToConnectMs) {
+    this.#notConnected.clear();
+    this.#lastConnectErrorV2.clear();
+    this.#timeToConnectMsV2.set(timeToConnectMs);
+    this.#totalTimeToConnectMs.set(totalTimeToConnectMs);
+  }
+  setDisconnectedWaitingForVisible() {
+    this.#timeToConnectMsV2.clear();
+    this.#totalTimeToConnectMs.clear();
+    this.#lastConnectErrorV2.clear();
+    let notConnectedReason;
+    switch (this.#notConnected.get()) {
+      case "init":
+        notConnectedReason = "hidden_was_init";
+        break;
+      case "error":
+        notConnectedReason = "hidden_was_error";
+        break;
+      default:
+        notConnectedReason = "hidden";
+        break;
+    }
+    this.#setNotConnectedReason(notConnectedReason);
+  }
+  setConnectError(reason) {
+    this.#timeToConnectMsV2.clear();
+    this.#totalTimeToConnectMs.clear();
+    this.#setNotConnectedReason("error");
+    this.#lastConnectErrorV2.set(getLastConnectErrorValue(reason));
+  }
+  /**
+   * Tags to include in all metrics.
+   */
+  tags = [];
+  // Flushes all metrics to an array of time series (plural), one Series
+  // per metric.
+  async flush() {
+    const lc = this.#lc;
+    if (this.#timerID === null) {
+      lc.error?.("MetricManager.flush() called but already stopped");
+      return;
+    }
+    const allSeries = [];
+    for (const metric of this.#metrics) {
+      const series = metric.flush();
+      if (series !== void 0) {
+        allSeries.push({
+          ...series,
+          host: this.#host,
+          tags: this.tags
+        });
+      }
+    }
+    if (allSeries.length === 0) {
+      lc?.debug?.("No metrics to report");
+      return;
+    }
+    try {
+      await this.#reporter(allSeries);
+    } catch (e) {
+      lc?.error?.("Error reporting metrics", e);
+    }
+  }
+  stop() {
+    if (this.#timerID === null) {
+      this.#lc.error?.("MetricManager.stop() called but already stopped");
+      return;
+    }
+    clearInterval(this.#timerID);
+    this.#timerID = null;
+  }
+  #register(metric) {
+    this.#metrics.push(metric);
+    return metric;
+  }
+}
+function makePoint(ts, value) {
+  return [ts, [value]];
+}
+class Gauge {
+  #name;
+  #value = void 0;
+  constructor(name) {
+    this.#name = name;
+  }
+  set(value) {
+    this.#value = value;
+  }
+  get() {
+    return this.#value;
+  }
+  clear() {
+    this.#value = void 0;
+  }
+  flush() {
+    if (this.#value === void 0) {
+      return void 0;
+    }
+    const points = [makePoint(t(), this.#value)];
+    return { metric: this.#name, points };
+  }
+}
+function t() {
+  return Math.round(Date.now() / 1e3);
+}
+class State {
+  #prefix;
+  #clearOnFlush;
+  #current = void 0;
+  constructor(prefix, clearOnFlush = false) {
+    this.#prefix = prefix;
+    this.#clearOnFlush = clearOnFlush;
+  }
+  set(state) {
+    this.#current = state;
+  }
+  get() {
+    return this.#current;
+  }
+  clear() {
+    this.#current = void 0;
+  }
+  flush() {
+    if (this.#current === void 0) {
+      return void 0;
+    }
+    const gauge = new Gauge([this.#prefix, this.#current].join("_"));
+    gauge.set(1);
+    const series = gauge.flush();
+    if (this.#clearOnFlush) {
+      this.clear();
+    }
+    return series;
+  }
+}
+export {
+  DID_NOT_CONNECT_VALUE,
+  Gauge,
+  MetricManager,
+  REPORT_INTERVAL_MS,
+  State,
+  getLastConnectErrorValue,
+  shouldReportConnectError
+};
+//# sourceMappingURL=metrics.js.map