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

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

@@ -26,11 +26,9 @@ import { CRUD_MUTATION_NAME, mapCRUD } from "../../../zero-protocol/src/push.js"
 import { nullableVersionSchema } from "../../../zero-protocol/src/version.js";
 import { clientSchemaFrom } from "../../../zero-schema/src/builder/schema-builder.js";
 import { clientToServer } from "../../../zero-schema/src/name-mapper.js";
-import { customMutatorKey } from "../../../zql/src/mutate/custom.js";
-import { wrapCustomQuery } from "../../../zql/src/query/define-query.js";
+import { iterateMutators, isMutatorRegistry } from "../../../zql/src/mutate/mutator-registry.js";
+import { createBuilder } from "../../../zql/src/query/create-builder.js";
 import { isClientMetric } from "../../../zql/src/query/metrics-delegate.js";
-import { newQuery } from "../../../zql/src/query/query-impl.js";
-import { isQueryInternals } from "../../../zql/src/query/query-internals.js";
 import "../../../zero-protocol/src/ast.js";
 import { nanoid } from "../util/nanoid.js";
 import { send } from "../util/socket.js";
@@ -41,8 +39,7 @@ import { ConnectionManager, throwIfConnectionError } from "./connection-manager.
 import { Connected, Closed, Disconnected, Connecting, Error as Error$1, NeedsAuth } from "./connection-status-enum.js";
 import { ConnectionImpl } from "./connection.js";
 import { ZeroContext } from "./context.js";
-import { makeCRUDMutator, makeCRUDMutate } from "./crud.js";
-import { makeReplicacheMutator } from "./custom.js";
+import { makeCRUDMutate } from "./crud.js";
 import { DeleteClientsManager } from "./delete-clients-manager.js";
 import { shouldEnableAnalytics } from "./enable-analytics.js";
 import { ClientError, getErrorConnectionTransition, NO_STATUS_TRANSITION, isClientError, isAuthError, isServerError, getBackoffParams } from "./error.js";
@@ -50,6 +47,8 @@ import { toWSString, appendPath } from "./http-string.js";
 import { Inspector } from "./inspector/inspector.js";
 import { IVMSourceBranch } from "./ivm-branch.js";
 import { createLogOptions } from "./log-options.js";
+import { makeMutateProperty } from "./make-mutate-property.js";
+import { makeReplicacheMutators } from "./make-replicache-mutators.js";
 import { MetricManager, REPORT_INTERVAL_MS, shouldReportConnectError, getLastConnectErrorValue, DID_NOT_CONNECT_VALUE } from "./metrics.js";
 import { MutationTracker } from "./mutation-tracker.js";
 import { MutatorProxy } from "./mutator-proxy.js";
@@ -98,45 +97,6 @@ function onClientStateNotFoundServerReason(serverErrMsg) {
 }
 const ON_CLIENT_STATE_NOT_FOUND_REASON_CLIENT = "The local persistent state needed to synchronize this client has been garbage collected.";
 const CLOSE_CODE_NORMAL = 1e3;
-function registerQueries(schema, queries, contextHolder, lc) {
-  const rv = {};
-  for (const name of Object.keys(schema.tables)) {
-    rv[name] = newQuery(schema, name);
-  }
-  if (queries) {
-    const processQueries = (queriesToProcess, target, namespacePrefix = []) => {
-      for (const [key, value] of Object.entries(queriesToProcess)) {
-        if (typeof value === "function") {
-          const queryName = [...namespacePrefix, key].join(".");
-          const targetValue = target[key];
-          if (isQueryInternals(targetValue)) {
-            lc.debug?.(
-              `Query key "${[...namespacePrefix, key].join(".")}" conflicts with an existing table name.`
-            );
-          }
-          target[key] = wrapCustomQuery(queryName, value, contextHolder);
-        } else {
-          let existing = target[key];
-          if (isQueryInternals(existing)) {
-            lc.debug?.(
-              `Query namespace "${[...namespacePrefix, key].join(".")}" conflicts with an existing table name.`
-            );
-          }
-          if (existing === void 0) {
-            existing = {};
-            target[key] = existing;
-          }
-          processQueries(value, existing, [
-            ...namespacePrefix,
-            key
-          ]);
-        }
-      }
-    };
-    processQueries(queries, rv);
-  }
-  return rv;
-}
 class Zero {
   version = version;
   #rep;
@@ -223,6 +183,11 @@ class Zero {
   // 2. client successfully connects
   #totalToConnectStart = void 0;
   #options;
+  /**
+   * Query builders for each table in the schema.
+   *
+   * @deprecated Use {@linkcode createBuilder} to create query builders instead.
+   */
   query;
   // TODO: Metrics needs to be rethought entirely as we're not going to
   // send metrics to customer server.
@@ -254,7 +219,8 @@ class Zero {
         message: "ZeroOptions.userID must not be empty."
       });
     }
-    const server = getServer(options.server);
+    const cacheURL = options.cacheURL ?? options.server;
+    const server = getServer(cacheURL);
     this.#enableAnalytics = shouldEnableAnalytics(
       server,
       false
@@ -281,6 +247,7 @@ class Zero {
       this.#onlineManager.subscribe(onOnlineChange);
     }
     this.#options = options;
+    this.query = createBuilder(schema);
     this.#logOptions = this.#createLogOptions({
       consoleLogLevel: options.logLevel ?? "warn",
       server: null,
@@ -299,22 +266,6 @@ class Zero {
     };
     syncConnectionState(this.#connectionManager.state);
     this.#connectionManager.subscribe(syncConnectionState);
-    const { enableLegacyMutators = true, enableLegacyQueries = true } = schema;
-    const replicacheMutators = {
-      [CRUD_MUTATION_NAME]: enableLegacyMutators ? makeCRUDMutator(schema) : () => Promise.reject(
-        new ClientError({
-          kind: Internal,
-          message: "Zero CRUD mutators are not enabled."
-        })
-      )
-    };
-    this.#ivmMain = new IVMSourceBranch(schema.tables);
-    function assertUnique(key) {
-      assert(
-        replicacheMutators[key] === void 0,
-        `A mutator, or mutator namespace, has already been defined for ${key}`
-      );
-    }
     const sink = logOptions.logSink;
     const lc = new LogContext(logOptions.logLevel, {}, sink);
     this.#mutationTracker = new MutationTracker(
@@ -322,33 +273,21 @@ class Zero {
       (upTo) => this.#send(["ackMutationResponses", upTo]),
       (error) => this.#disconnect(lc, error)
     );
-    if (options.mutators) {
-      const processMutators = (mutators, namespacePrefix = []) => {
-        for (const [key, value] of Object.entries(mutators)) {
-          if (typeof value === "function") {
-            const fullKey = customMutatorKey(...namespacePrefix, key);
-            assertUnique(fullKey);
-            replicacheMutators[fullKey] = makeReplicacheMutator(
-              lc,
-              value,
-              schema
-            );
-          } else if (typeof value === "object") {
-            processMutators(value, [...namespacePrefix, key]);
-          } else {
-            unreachable();
-          }
-        }
-      };
-      processMutators(options.mutators);
-    }
+    this.#ivmMain = new IVMSourceBranch(schema.tables);
+    const { enableLegacyQueries = true } = schema;
+    const replicacheMutators = makeReplicacheMutators(
+      schema,
+      options.mutators,
+      this.context,
+      lc
+    );
     this.storageKey = storageKey ?? "";
     const { clientSchema, hash } = clientSchemaFrom(schema);
     this.#clientSchema = clientSchema;
     const nameKey = JSON.stringify({
       storageKey: this.storageKey,
       mutateUrl: options.mutateURL ?? "",
-      queryUrl: options.getQueriesURL ?? ""
+      queryUrl: options.queryURL ?? options.getQueriesURL ?? ""
     });
     const hashedKey = h64(nameKey).toString(36);
     const replicacheOptions = {
@@ -452,35 +391,33 @@ class Zero {
     });
     this.#onClientStateNotFound = onClientStateNotFoundCallback;
     this.#rep.onClientStateNotFound = onClientStateNotFoundCallback;
-    const { mutate, mutateBatch } = makeCRUDMutate(schema, rep.mutate);
     const mutatorProxy = new MutatorProxy(
       this.#connectionManager,
       this.#mutationTracker
     );
-    if (options.mutators) {
-      const exposeMutators = (mutators, target, namespacePrefix = []) => {
-        for (const [key, value] of Object.entries(mutators)) {
-          if (typeof value === "function") {
-            const fullKey = customMutatorKey(...namespacePrefix, key);
-            target[key] = mutatorProxy.wrapCustomMutator(
-              must(rep.mutate[fullKey])
-            );
-          } else if (typeof value === "object" && value !== null) {
-            let existing = target[key];
-            if (existing === void 0) {
-              existing = {};
-              target[key] = existing;
-            }
-            exposeMutators(value, existing, [
-              ...namespacePrefix,
-              key
-            ]);
-          }
-        }
-      };
-      exposeMutators(options.mutators, mutate);
+    const { mutators } = options;
+    const registeredMutators = new Set(
+      isMutatorRegistry(mutators) ? iterateMutators(mutators) : void 0
+    );
+    const callableMutate = (mr) => {
+      if (!registeredMutators.has(mr.mutator)) {
+        throw new Error(
+          `Mutator "${mr.mutator.mutatorName}" is not registered. Mutators must be registered with the Zero constructor before use.`
+        );
+      }
+      const repMutator = rep.mutate[mr.mutator.mutatorName];
+      return mutatorProxy.wrapCustomMutator(repMutator)(mr.args);
+    };
+    const mutateBatch = makeCRUDMutate(schema, rep.mutate, callableMutate);
+    if (mutators && !isMutatorRegistry(mutators)) {
+      makeMutateProperty(
+        mutators,
+        mutatorProxy,
+        callableMutate,
+        rep.mutate
+      );
     }
-    this.mutate = mutate;
+    this.mutate = callableMutate;
     this.mutateBatch = mutateBatch;
     this.#queryManager = new QueryManager(
       this.#lc,
@@ -503,12 +440,6 @@ class Zero {
       this.#lc,
       this.#rep.clientGroupID
     );
-    this.query = registerQueries(
-      schema,
-      this.#options.queries,
-      this,
-      lc
-    );
     reportReloadReason(this.#lc);
     this.#metrics = new MetricManager({
       reportIntervalMs: REPORT_INTERVAL_MS,
@@ -590,7 +521,7 @@ class Zero {
    * ```
    */
   preload(query, options) {
-    return this.#zeroContext.preload(query, options);
+    return this.#zeroContext.preload(query.toQuery(this.context), options);
   }
   /**
    * Executes a query once and returns the results.
@@ -613,12 +544,13 @@ class Zero {
    * ```
    */
   run(query, runOptions) {
-    return this.#zeroContext.run(query, runOptions);
+    return this.#zeroContext.run(query.toQuery(this.context), runOptions);
   }
   get context() {
     return this.#options.context;
   }
   materialize(query, factoryOrOptions, maybeOptions) {
+    const q = query.toQuery(this.context);
     let factory;
     let options;
     if (typeof factoryOrOptions === "function") {
@@ -627,7 +559,7 @@ class Zero {
     } else {
       options = factoryOrOptions;
     }
-    return this.#zeroContext.materialize(query, factory, options);
+    return this.#zeroContext.materialize(q, factory, options);
   }
   /**
    * The server URL that this Zero instance is configured with.
@@ -715,6 +647,8 @@ class Zero {
    *
    * `mutateBatch` is not allowed inside another `mutateBatch` call. Doing so
    * will throw an error.
+   *
+   * @deprecated Use `zero.mutate(mutationRequest)`
    */
   mutateBatch;
   /**
@@ -1034,7 +968,7 @@ ${error.errorBody.message}`, error);
           // Henceforth it is stored with the CVR and verified automatically.
           ...this.#connectCookie === null ? { clientSchema } : {},
           userPushURL: this.#options.mutateURL,
-          userQueryURL: this.#options.getQueriesURL
+          userQueryURL: this.#options.queryURL ?? this.#options.getQueriesURL
         }
       ]);
       this.#deletedClients = void 0;
@@ -1120,7 +1054,7 @@ ${error.errorBody.message}`, error);
       this.#options.logLevel === "debug",
       lc,
       this.#options.mutateURL,
-      this.#options.getQueriesURL,
+      this.#options.queryURL ?? this.#options.getQueriesURL,
       additionalConnectParams,
       await this.#activeClientsManager,
       this.#options.maxHeaderLength