@uniformdev/next-app-router 20.50.2-alpha.167 → 20.50.2-alpha.180

package/dist/index.js

@@ -1225,16 +1225,6 @@ 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) {
@@ -1276,102 +1266,130 @@ function projectionToQuery(spec) {
   }
   return out;
 }
-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_ENRICHMENT_TAG_PARAM = "$enr";
-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 CANVAS_CONTEXTUAL_EDITING_PARAM = "$contextualEditing";
-var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
-var PLACEHOLDER_ID = "placeholder";
-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
-    };
-  }
-  return { readOptions: args, hasCompositionId: false, pinnedEdition: false };
-}
-var DEFAULT_EDGE_API_HOST = "https://uniform.global";
-var DeliveryClientBase = class extends ContentClientBase {
+var CANVAS_URL = "/api/v1/canvas";
+var CanvasClient = class extends ApiClient {
   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;
+    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);
   }
-  /** 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;
+  getCompositionByNodePath(options) {
+    return this.getOneComposition(options);
   }
-};
-var EDGE_SINGLE_URL = "/api/v1/composition";
-var EDGE_LIST_URL = "/api/v1/compositions";
-var CompositionDeliveryClient = class extends DeliveryClientBase {
-  constructor(options) {
-    super(options);
+  getCompositionByNodeId(options) {
+    return this.getOneComposition(options);
   }
-  /** 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);
+  getCompositionBySlug(options) {
+    return this.getOneComposition(options);
   }
-  /** 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);
+  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
+    };
+    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") };
+  }
+  /** 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
+    });
+  }
+  /** 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);
+  }
+  /** 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
+    });
+  }
+  /** 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
+    });
   }
 };
 var _contentTypesUrl;
@@ -1480,18 +1498,14 @@ var _DataTypeClient = class _DataTypeClient2 extends ApiClient {
   constructor(options) {
     super(options);
   }
-  /** Fetches a list of DataTypes for a project */
-  async list(options) {
+  /** Fetches all DataTypes for a project */
+  async get(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 save(body) {
+  async upsert(body) {
     const fetchUri = this.createUrl(__privateGet3(_DataTypeClient2, _url8));
     await this.apiClient(fetchUri, {
       method: "PUT",
@@ -1499,10 +1513,6 @@ 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));
@@ -1540,6 +1550,24 @@ 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_ENRICHMENT_TAG_PARAM = "$enr";
+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 CANVAS_CONTEXTUAL_EDITING_PARAM = "$contextualEditing";
+var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
+var PLACEHOLDER_ID = "placeholder";
+var EDGE_MAX_CACHE_TTL = 24 * 60 * 60;
 function isRootEntryReference(root) {
   return root.type === "root" && isEntryData(root.node);
 }
@@ -1996,28 +2024,20 @@ 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 list(options) {
+  async getProjects(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 save(body) {
+  async upsert(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 remove(body) {
+  async delete(body) {
     const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url22));
     await this.apiClient(fetchUri, {
       method: "DELETE",
@@ -2025,10 +2045,6 @@ 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();
@@ -2044,14 +2060,8 @@ var RouteClient = class extends ApiClient {
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
   }
-  /**
-   * 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) {
+  /** Fetches lists of Canvas compositions, optionally by type */
+  async getRoute(options) {
     const { projectId } = this.options;
     const { select, ...rest } = options != null ? options : {};
     const rewrittenSelect = projectionToQuery(select);
@@ -2061,10 +2071,6 @@ 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);
-  }
 };
 function mapSlotToPersonalizedVariations(slot) {
   if (!slot) return [];
@@ -2362,7 +2368,7 @@ function createLimitPolicy2({
 // src/clients/canvas.ts
 var getCanvasClient = (options) => {
   const cache2 = resolveCanvasCache(options);
-  return new CompositionDeliveryClient({
+  return new CanvasClient({
     projectId: env.getProjectId(),
     apiHost: env.getApiHost(),
     apiKey: env.getApiKey(),
@@ -3422,7 +3428,7 @@ var resolvePlaygroundRoute = async ({ code }) => {
   });
   let composition = void 0;
   try {
-    composition = await canvasClient.get({
+    composition = await canvasClient.getCompositionById({
       compositionId: pageState.routePath,
       state: pageState.compositionState,
       withComponentIDs: true
@@ -3568,7 +3574,7 @@ var createUniformPlaygroundStaticParams = async (options) => {
     const routeClient = getRouteClient({
       state
     });
-    route = await routeClient.get({
+    route = await routeClient.getRoute({
       path: firstPath,
       withComponentIDs: true,
       state: CANVAS_DRAFT_STATE
@@ -3621,7 +3627,7 @@ async function processRoutePath({
   });
   const rewrittenPath = await (rewrite == null ? void 0 : rewrite({ path }));
   const resolvedPath = (_a = rewrittenPath == null ? void 0 : rewrittenPath.path) != null ? _a : path;
-  const route = await routeClient.get({
+  const route = await routeClient.getRoute({
     path: resolvedPath,
     withComponentIDs: true,
     state: CANVAS_PUBLISHED_STATE
@@ -3874,14 +3880,14 @@ var DefaultDataClient = class {
       if (oldCachedRoute) {
         (0, import_functions.waitUntil)(
           (async () => {
-            const result2 = await routeClient.get(route);
+            const result2 = await routeClient.getRoute(route);
             await cacheNewRoute(result2);
           })()
         );
         return oldCachedRoute;
       }
     }
-    const result = await routeClient.get(route);
+    const result = await routeClient.getRoute(route);
     (0, import_functions.waitUntil)(
       (async () => {
         await Promise.all([