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

package/dist/handler.mjs

@@ -1208,6 +1208,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) {
@@ -1252,130 +1262,94 @@ 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_DRAFT_STATE = 0;
+var CANVAS_PUBLISHED_STATE = 64;
+var CANVAS_EDITOR_STATE = 63;
+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 SECRET_QUERY_STRING_PARAM = "secret";
+var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
+var IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
+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;
@@ -1484,14 +1458,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",
@@ -1499,6 +1477,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));
@@ -1511,15 +1493,6 @@ var _DataTypeClient = class _DataTypeClient2 extends ApiClient {
 };
 _url8 = /* @__PURE__ */ new WeakMap();
 __privateAdd3(_DataTypeClient, _url8, "/api/v1/data-types");
-var CANVAS_DRAFT_STATE = 0;
-var CANVAS_EDITOR_STATE = 63;
-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 SECRET_QUERY_STRING_PARAM = "secret";
-var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
-var IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
-var EDGE_MAX_CACHE_TTL = 24 * 60 * 60;
 var escapeCharacter = "\\";
 var variablePrefix = "${";
 var variableSuffix = "}";
@@ -1653,20 +1626,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",
@@ -1674,6 +1655,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();
@@ -2134,9 +2119,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(),
@@ -2184,7 +2169,10 @@ var getCanvasClient = (options) => {
         }
       });
     }
-  });
+  };
+};
+var getCompositionDeliveryClient = (options) => {
+  return new CompositionDeliveryClient(buildCanvasClientOptions(options));
 };
 
 // src/clients/projectMap.ts
@@ -2580,13 +2568,13 @@ var processCompositionChange = async (compositionId) => {
   };
 };
 var getComposition = async ({ compositionId }) => {
-  const canvasClient = getCanvasClient({
+  const canvasClient = getCompositionDeliveryClient({
     cache: {
       type: "no-cache"
     }
   });
   try {
-    const composition = await canvasClient.getCompositionById({
+    const composition = await canvasClient.get({
       compositionId
     });
     return composition;

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { CanvasClient, RouteClient, ComponentInstance } from '@uniformdev/canvas';
+import { CanvasClient, CompositionDeliveryClient, RouteClient, ComponentInstance } from '@uniformdev/canvas';
 import { CacheMode, CanvasCacheMode, ManifestCacheMode, ProjectMapCacheMode, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
 import { ManifestClient } from '@uniformdev/context/api';
 import { ProjectMapClient } from '@uniformdev/project-map';
@@ -24,7 +24,12 @@ type DetectCacheMode = {
 type ResolvableCacheOptions<TCacheMode extends CacheMode> = SpecificCacheMode<TCacheMode> | StateCacheMode | DetectCacheMode;
 
 type GetCanvasClientOptions = ResolvableCacheOptions<CanvasCacheMode>;
+type GetCompositionDeliveryClientOptions = GetCanvasClientOptions;
+/**
+ * @deprecated Use {@link getCompositionDeliveryClient} instead
+ */
 declare const getCanvasClient: (options?: GetCanvasClientOptions) => CanvasClient;
+declare const getCompositionDeliveryClient: (options?: GetCompositionDeliveryClientOptions) => CompositionDeliveryClient;
 
 type GetManifestClientOptions = ResolvableCacheOptions<ManifestCacheMode>;
 declare const getManifestClient: (options?: GetManifestClientOptions) => ManifestClient;
@@ -271,4 +276,4 @@ declare const findRouteMatch: (routes: CustomRoute[], path: string) => RouteMatc
 
 declare const serverContext: <T>(defaultValue?: T) => [() => T | undefined, (v: T) => void];
 
-export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, precomputeComposition, resolvePlaygroundRoute, serverContext };
+export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetCompositionDeliveryClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getCompositionDeliveryClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, precomputeComposition, resolvePlaygroundRoute, serverContext };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { CanvasClient, RouteClient, ComponentInstance } from '@uniformdev/canvas';
+import { CanvasClient, CompositionDeliveryClient, RouteClient, ComponentInstance } from '@uniformdev/canvas';
 import { CacheMode, CanvasCacheMode, ManifestCacheMode, ProjectMapCacheMode, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
 import { ManifestClient } from '@uniformdev/context/api';
 import { ProjectMapClient } from '@uniformdev/project-map';
@@ -24,7 +24,12 @@ type DetectCacheMode = {
 type ResolvableCacheOptions<TCacheMode extends CacheMode> = SpecificCacheMode<TCacheMode> | StateCacheMode | DetectCacheMode;
 
 type GetCanvasClientOptions = ResolvableCacheOptions<CanvasCacheMode>;
+type GetCompositionDeliveryClientOptions = GetCanvasClientOptions;
+/**
+ * @deprecated Use {@link getCompositionDeliveryClient} instead
+ */
 declare const getCanvasClient: (options?: GetCanvasClientOptions) => CanvasClient;
+declare const getCompositionDeliveryClient: (options?: GetCompositionDeliveryClientOptions) => CompositionDeliveryClient;
 
 type GetManifestClientOptions = ResolvableCacheOptions<ManifestCacheMode>;
 declare const getManifestClient: (options?: GetManifestClientOptions) => ManifestClient;
@@ -271,4 +276,4 @@ declare const findRouteMatch: (routes: CustomRoute[], path: string) => RouteMatc
 
 declare const serverContext: <T>(defaultValue?: T) => [() => T | undefined, (v: T) => void];
 
-export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, precomputeComposition, resolvePlaygroundRoute, serverContext };
+export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetCompositionDeliveryClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getCompositionDeliveryClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, precomputeComposition, resolvePlaygroundRoute, serverContext };