@uniformdev/next-app-router 20.74.6-alpha.3 → 20.74.6-alpha.6

package/dist/middleware.js

@@ -1413,6 +1413,16 @@ function createLimitPolicy({
     return currentFunc();
   };
 }
+var ContentClientBase = class extends ApiClient {
+  constructor(options, defaultBypassCache) {
+    var _a, _b;
+    super({
+      ...options,
+      limitPolicy: (_a = options.limitPolicy) != null ? _a : createLimitPolicy({}),
+      bypassCache: (_b = options.bypassCache) != null ? _b : defaultBypassCache
+    });
+  }
+};
 var SELECT_QUERY_PREFIX = "select.";
 function appendCsv(out, key, values) {
   if (values === void 0) {
@@ -1457,130 +1467,100 @@ function projectionToQuery(spec) {
   }
   return out;
 }
-var CANVAS_URL = "/api/v1/canvas";
-var CanvasClient = class extends ApiClient {
-  constructor(options) {
-    var _a;
-    if (!options.limitPolicy) {
-      options.limitPolicy = createLimitPolicy({});
-    }
-    super(options);
-    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
-    this.edgeApiRequestInit = options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0;
-  }
-  /** Fetches lists of Canvas compositions, optionally by type */
-  async getCompositionList(params = {}) {
-    const { projectId } = this.options;
-    const { resolveData, filters, select, ...originParams } = params;
-    const rewrittenFilters = rewriteFiltersForApi(filters);
-    const rewrittenSelect = projectionToQuery(select);
-    if (!resolveData) {
-      const fetchUri = this.createUrl(CANVAS_URL, {
-        ...originParams,
-        projectId,
-        ...rewrittenFilters,
-        ...rewrittenSelect
-      });
-      return this.apiClient(fetchUri);
-    }
-    const edgeParams = {
-      ...originParams,
-      projectId,
-      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
-      ...rewrittenFilters,
-      ...rewrittenSelect
-    };
-    const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
-  }
-  getCompositionByNodePath(options) {
-    return this.getOneComposition(options);
-  }
-  getCompositionByNodeId(options) {
-    return this.getOneComposition(options);
-  }
-  getCompositionBySlug(options) {
-    return this.getOneComposition(options);
-  }
-  getCompositionById(options) {
-    return this.getOneComposition(options);
-  }
-  getCompositionDefaults(options) {
-    return this.getOneComposition(options);
-  }
-  /** Fetches historical versions of a composition or pattern */
-  async getCompositionHistory(options) {
-    const historyUrl = this.createUrl("/api/v1/canvas-history", {
-      ...options,
-      projectId: this.options.projectId
-    });
-    return this.apiClient(historyUrl);
-  }
-  getOneComposition({
-    skipDataResolution,
-    diagnostics,
-    ...params
-  }) {
-    const { projectId } = this.options;
-    if (skipDataResolution) {
-      return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
-    }
-    const edgeParams = {
-      ...params,
-      projectId,
-      diagnostics: typeof diagnostics === "boolean" ? diagnostics : diagnostics === "no-data" ? "no-data" : void 0
+var CANVAS_PERSONALIZE_TYPE = "$personalization";
+var CANVAS_TEST_TYPE = "$test";
+var CANVAS_BLOCK_PARAM_TYPE = "$block";
+var CANVAS_PERSONALIZE_SLOT = "pz";
+var CANVAS_TEST_SLOT = "test";
+var CANVAS_DRAFT_STATE = 0;
+var CANVAS_PUBLISHED_STATE = 64;
+var CANVAS_EDITOR_STATE = 63;
+var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
+var CANVAS_INTERNAL_PARAM_PREFIX = "$internal_";
+var CANVAS_COMPONENT_DISPLAY_NAME_PARAM = `${CANVAS_INTERNAL_PARAM_PREFIX}displayName`;
+var CANVAS_HYPOTHESIS_PARAM = `${CANVAS_INTERNAL_PARAM_PREFIX}hypothesis`;
+var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
+var IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM = "is_incontext_editing_forced_settings";
+var EDGE_MAX_CACHE_TTL = 24 * 60 * 60;
+function resolveCompositionSelector(args) {
+  if ("compositionId" in args) {
+    const { compositionId, editionId, versionId, ...readOptions } = args;
+    return {
+      readOptions,
+      // raw mode matches on composition OR edition id via the compositionId param
+      compositionId: editionId != null ? editionId : compositionId,
+      versionId,
+      hasCompositionId: true,
+      pinnedEdition: editionId !== void 0
     };
-    const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
-  /** Updates or creates a Canvas component definition */
-  async updateComposition(body, options) {
-    const fetchUri = this.createUrl(CANVAS_URL);
-    const headers = {};
-    if (options == null ? void 0 : options.ifUnmodifiedSince) {
-      headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
-    }
-    const { response } = await this.apiClientWithResponse(fetchUri, {
-      method: "PUT",
-      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
-      expectNoContent: true,
-      headers
-    });
-    return { modified: response.headers.get("x-modified-at") };
+  return { readOptions: args, hasCompositionId: false, pinnedEdition: false };
+}
+var DEFAULT_EDGE_API_HOST = "https://uniform.global";
+var DeliveryClientBase = class extends ContentClientBase {
+  constructor(options) {
+    var _a;
+    super(
+      options,
+      /* defaultBypassCache */
+      false
+    );
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : DEFAULT_EDGE_API_HOST;
+    this.edgeRequestInit = options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0;
   }
-  /** Deletes a Canvas component definition */
-  async removeComposition(body) {
-    const fetchUri = this.createUrl(CANVAS_URL);
-    const { projectId } = this.options;
-    await this.apiClient(fetchUri, {
-      method: "DELETE",
-      body: JSON.stringify({ ...body, projectId }),
-      expectNoContent: true
-    });
+  /** Coerces the `diagnostics` option into the shape the edge endpoints accept. */
+  coerceDiagnostics(diagnostics) {
+    return typeof diagnostics === "boolean" ? diagnostics : diagnostics === "no-data" ? "no-data" : void 0;
   }
-  /** Fetches all Canvas component definitions */
-  async getComponentDefinitions(options) {
-    const { projectId } = this.options;
-    const fetchUri = this.createUrl("/api/v1/canvas-definitions", { ...options, projectId });
-    return this.apiClient(fetchUri);
+};
+var EDGE_SINGLE_URL = "/api/v1/composition";
+var EDGE_LIST_URL = "/api/v1/compositions";
+var CompositionDeliveryClient = class extends DeliveryClientBase {
+  constructor(options) {
+    super(options);
   }
-  /** Updates or creates a Canvas component definition */
-  async updateComponentDefinition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas-definitions");
-    await this.apiClient(fetchUri, {
-      method: "PUT",
-      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
-      expectNoContent: true
-    });
+  /** Fetches exactly one composition (throws `ApiClientError(404)` if absent). */
+  get(args) {
+    var _a;
+    const { diagnostics, select, ...rest } = args;
+    const { readOptions, compositionId, versionId, pinnedEdition } = resolveCompositionSelector(rest);
+    const url = this.createUrl(
+      EDGE_SINGLE_URL,
+      {
+        ...readOptions,
+        ...projectionToQuery(select),
+        // A pinned edition is folded into compositionId (raw matches edition or
+        // composition id); there is no editionId query param on this endpoint.
+        compositionId,
+        versionId,
+        projectId: this.options.projectId,
+        state: (_a = args.state) != null ? _a : CANVAS_PUBLISHED_STATE,
+        // editionId pins a specific edition for preview; otherwise locale-best.
+        editions: pinnedEdition ? "raw" : "auto",
+        diagnostics: this.coerceDiagnostics(diagnostics)
+      },
+      this.edgeApiHost
+    );
+    return this.apiClient(url, this.edgeRequestInit);
   }
-  /** Deletes a Canvas component definition */
-  async removeComponentDefinition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas-definitions");
-    await this.apiClient(fetchUri, {
-      method: "DELETE",
-      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
-      expectNoContent: true
-    });
+  /** Fetches a list of compositions, optionally filtered. */
+  list(args = {}) {
+    var _a;
+    const { diagnostics, filters, select, ...rest } = args;
+    const url = this.createUrl(
+      EDGE_LIST_URL,
+      {
+        ...rest,
+        ...rewriteFiltersForApi(filters),
+        ...projectionToQuery(select),
+        projectId: this.options.projectId,
+        state: (_a = args.state) != null ? _a : CANVAS_PUBLISHED_STATE,
+        diagnostics: this.coerceDiagnostics(diagnostics)
+      },
+      this.edgeApiHost
+    );
+    return this.apiClient(url, this.edgeRequestInit);
   }
 };
 var _contentTypesUrl;
@@ -1689,14 +1669,18 @@ var _DataTypeClient = class _DataTypeClient2 extends ApiClient {
   constructor(options) {
     super(options);
   }
-  /** Fetches all DataTypes for a project */
-  async get(options) {
+  /** Fetches a list of DataTypes for a project */
+  async list(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet3(_DataTypeClient2, _url8), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** @deprecated Use {@link list} instead. */
+  async get(options) {
+    return this.list(options);
+  }
   /** Updates or creates (based on id) a DataType */
-  async upsert(body) {
+  async save(body) {
     const fetchUri = this.createUrl(__privateGet3(_DataTypeClient2, _url8));
     await this.apiClient(fetchUri, {
       method: "PUT",
@@ -1704,6 +1688,10 @@ var _DataTypeClient = class _DataTypeClient2 extends ApiClient {
       expectNoContent: true
     });
   }
+  /** @deprecated Use {@link save} instead. */
+  async upsert(body) {
+    return this.save(body);
+  }
   /** Deletes a DataType */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet3(_DataTypeClient2, _url8));
@@ -1741,22 +1729,6 @@ function getComponentPath(ancestorsAndSelf) {
   }
   return `.${path.join(".")}`;
 }
-var CANVAS_PERSONALIZE_TYPE = "$personalization";
-var CANVAS_TEST_TYPE = "$test";
-var CANVAS_BLOCK_PARAM_TYPE = "$block";
-var CANVAS_PERSONALIZE_SLOT = "pz";
-var CANVAS_TEST_SLOT = "test";
-var CANVAS_DRAFT_STATE = 0;
-var CANVAS_PUBLISHED_STATE = 64;
-var CANVAS_EDITOR_STATE = 63;
-var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
-var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
-var CANVAS_INTERNAL_PARAM_PREFIX = "$internal_";
-var CANVAS_COMPONENT_DISPLAY_NAME_PARAM = `${CANVAS_INTERNAL_PARAM_PREFIX}displayName`;
-var CANVAS_HYPOTHESIS_PARAM = `${CANVAS_INTERNAL_PARAM_PREFIX}hypothesis`;
-var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
-var IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM = "is_incontext_editing_forced_settings";
-var EDGE_MAX_CACHE_TTL = 24 * 60 * 60;
 function isRootEntryReference(root) {
   return root.type === "root" && isEntryData(root.node);
 }
@@ -2358,20 +2330,28 @@ var _ProjectClient = class _ProjectClient2 extends ApiClient {
    * When teamId is provided, returns a single team with its projects.
    * When omitted, returns all accessible teams and their projects.
    */
-  async getProjects(options) {
+  async list(options) {
     const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _projectsUrl), options ? { ...options } : {});
     return await this.apiClient(fetchUri);
   }
+  /** @deprecated Use {@link list} instead. */
+  async getProjects(options) {
+    return this.list(options);
+  }
   /** Updates or creates (based on id) a Project */
-  async upsert(body) {
+  async save(body) {
     const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url22));
     return await this.apiClient(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body })
     });
   }
+  /** @deprecated Use {@link save} instead. */
+  async upsert(body) {
+    return this.save(body);
+  }
   /** Deletes a Project */
-  async delete(body) {
+  async remove(body) {
     const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url22));
     await this.apiClient(fetchUri, {
       method: "DELETE",
@@ -2379,6 +2359,10 @@ var _ProjectClient = class _ProjectClient2 extends ApiClient {
       expectNoContent: true
     });
   }
+  /** @deprecated Use {@link remove} instead. */
+  async delete(body) {
+    return this.remove(body);
+  }
 };
 _url22 = /* @__PURE__ */ new WeakMap();
 _projectsUrl = /* @__PURE__ */ new WeakMap();
@@ -2394,8 +2378,14 @@ var RouteClient = class extends ApiClient {
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
   }
-  /** Fetches lists of Canvas compositions, optionally by type */
-  async getRoute(options) {
+  /**
+   * Resolves a route to a composition, redirect, or not-found result.
+   *
+   * An optional `select` projection applies to the resolved composition when
+   * the route matches one; redirect / notFound responses pass through
+   * untouched.
+   */
+  async get(options) {
     const { projectId } = this.options;
     const { select, ...rest } = options != null ? options : {};
     const rewrittenSelect = projectionToQuery(select);
@@ -2405,6 +2395,10 @@ var RouteClient = class extends ApiClient {
       this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
     );
   }
+  /** @deprecated use {@link RouteClient.get} instead (renamed). */
+  async getRoute(options) {
+    return this.get(options);
+  }
 };
 var getDataSourceVariantFromRouteGetParams = (params, defaultPreviewState) => {
   var _a, _b;
@@ -2707,9 +2701,9 @@ function createLimitPolicy2({
 }
 
 // src/clients/canvas.ts
-var getCanvasClient = (options) => {
+var buildCanvasClientOptions = (options) => {
   const cache = resolveCanvasCache(options);
-  return new CanvasClient({
+  return {
     projectId: env.getProjectId(),
     apiHost: env.getApiHost(),
     apiKey: env.getApiKey(),
@@ -2757,7 +2751,10 @@ var getCanvasClient = (options) => {
         }
       });
     }
-  });
+  };
+};
+var getCompositionDeliveryClient = (options) => {
+  return new CompositionDeliveryClient(buildCanvasClientOptions(options));
 };
 
 // src/config/helpers.ts
@@ -2980,14 +2977,14 @@ var DefaultDataClient = class {
       if (oldCachedRoute) {
         (0, import_functions.waitUntil)(
           (async () => {
-            const result2 = await routeClient.getRoute(route);
+            const result2 = await routeClient.get(route);
             await cacheNewRoute(result2);
           })()
         );
         return oldCachedRoute;
       }
     }
-    const result = await routeClient.getRoute(route);
+    const result = await routeClient.get(route);
     (0, import_functions.waitUntil)(
       (async () => {
         await Promise.all([
@@ -5585,7 +5582,6 @@ var retrieveRouteByPath = async ({
   releaseId,
   locale
 }) => {
-  var _a;
   return await dataClient.getRoute({
     source: "middleware",
     searchParams,
@@ -5595,7 +5591,6 @@ var retrieveRouteByPath = async ({
       state,
       dataSourceVariant: getDataSourceVariantFromRouteGetParams({}, state),
       withComponentIDs: true,
-      withContentSourceMap: (_a = getServerConfig().experimental) == null ? void 0 : _a.vercelVisualEditing,
       releaseId,
       locale,
       ignoreRedirects: shouldIgnoreRedirects({ state })
@@ -5684,7 +5679,7 @@ var handlePlaygroundRequest = async ({
       { status: 400 }
     );
   }
-  const canvasClient = getCanvasClient({
+  const canvasClient = getCompositionDeliveryClient({
     cache: {
       type: "no-cache"
     }
@@ -5694,7 +5689,7 @@ var handlePlaygroundRequest = async ({
   for (let i = 0; i < possibleStates.length; i++) {
     const state = possibleStates[i];
     try {
-      composition = await canvasClient.getCompositionById({
+      composition = await canvasClient.get({
         compositionId: id,
         state,
         withComponentIDs: true