@uniformdev/next-app-router 20.72.2-alpha.3 → 20.72.3-alpha.14

package/dist/index.js

@@ -408,6 +408,7 @@ __export(index_exports, {
   expireMiddlewareCacheTag: () => expireMiddlewareCacheTag,
   findRouteMatch: () => findRouteMatch,
   getCanvasClient: () => getCanvasClient,
+  getCompositionDeliveryClient: () => getCompositionDeliveryClient,
   getManifest: () => getManifest,
   getManifestClient: () => getManifestClient,
   getProjectMapClient: () => getProjectMapClient,
@@ -1225,6 +1226,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) {
@@ -1269,7 +1280,105 @@ function projectionToQuery(spec) {
   }
   return out;
 }
-var CANVAS_URL = "/api/v1/canvas";
+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 {
+  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;
+  }
+  /** 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;
+  }
+};
+var EDGE_SINGLE_URL = "/api/v1/composition";
+var EDGE_LIST_URL = "/api/v1/compositions";
+var CompositionDeliveryClient = class extends DeliveryClientBase {
+  constructor(options) {
+    super(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);
+  }
+  /** 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 CANVAS_URL2 = "/api/v1/canvas";
 var CanvasClient = class extends ApiClient {
   constructor(options) {
     var _a;
@@ -1287,7 +1396,7 @@ var CanvasClient = class extends ApiClient {
     const rewrittenFilters = rewriteFiltersForApi(filters);
     const rewrittenSelect = projectionToQuery(select);
     if (!resolveData) {
-      const fetchUri = this.createUrl(CANVAS_URL, {
+      const fetchUri = this.createUrl(CANVAS_URL2, {
         ...originParams,
         projectId,
         ...rewrittenFilters,
@@ -1335,7 +1444,7 @@ var CanvasClient = class extends ApiClient {
   }) {
     const { projectId } = this.options;
     if (skipDataResolution) {
-      return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
+      return this.apiClient(this.createUrl(CANVAS_URL2, { ...params, projectId }));
     }
     const edgeParams = {
       ...params,
@@ -1347,7 +1456,7 @@ var CanvasClient = class extends ApiClient {
   }
   /** Updates or creates a Canvas component definition */
   async updateComposition(body, options) {
-    const fetchUri = this.createUrl(CANVAS_URL);
+    const fetchUri = this.createUrl(CANVAS_URL2);
     const headers = {};
     if (options == null ? void 0 : options.ifUnmodifiedSince) {
       headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
@@ -1362,7 +1471,7 @@ var CanvasClient = class extends ApiClient {
   }
   /** Deletes a Canvas component definition */
   async removeComposition(body) {
-    const fetchUri = this.createUrl(CANVAS_URL);
+    const fetchUri = this.createUrl(CANVAS_URL2);
     const { projectId } = this.options;
     await this.apiClient(fetchUri, {
       method: "DELETE",
@@ -1501,14 +1610,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",
@@ -1516,6 +1629,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));
@@ -1553,24 +1670,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_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);
 }
@@ -1590,9 +1689,9 @@ function parseVariableExpression(serialized, onToken) {
   let bufferStartIndex = 0;
   let bufferEndIndex = 0;
   let tokenCount = 0;
-  const handleToken = (token, type) => {
+  const handleToken = (token, type, offset) => {
     tokenCount++;
-    return onToken == null ? void 0 : onToken(token, type);
+    return onToken == null ? void 0 : onToken(token, type, offset);
   };
   let state = "text";
   for (let index = 0; index < serialized.length; index++) {
@@ -1603,7 +1702,7 @@ function parseVariableExpression(serialized, onToken) {
     if (char === variablePrefix[0] && serialized[index + 1] === variablePrefix[1]) {
       if (serialized[index - 1] === escapeCharacter) {
         bufferEndIndex -= escapeCharacter.length;
-        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text", bufferStartIndex) === false) {
           return tokenCount;
         }
         bufferStartIndex = index;
@@ -1612,12 +1711,12 @@ function parseVariableExpression(serialized, onToken) {
       }
       if (state === "variable") {
         const textStart = bufferStartIndex - variablePrefix.length;
-        if (handleToken(serialized.substring(textStart, bufferEndIndex), "text") === false) {
+        if (handleToken(serialized.substring(textStart, bufferEndIndex), "text", textStart) === false) {
           return tokenCount;
         }
         bufferStartIndex = bufferEndIndex;
       } else if (bufferEndIndex > bufferStartIndex) {
-        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text", bufferStartIndex) === false) {
           return tokenCount;
         }
         bufferStartIndex = bufferEndIndex;
@@ -1635,7 +1734,7 @@ function parseVariableExpression(serialized, onToken) {
       state = "text";
       if (bufferEndIndex > bufferStartIndex) {
         const unescapedVariableName = serialized.substring(bufferStartIndex, bufferEndIndex).replace(/\\([${}])/g, "$1");
-        if (handleToken(unescapedVariableName, "variable") === false) {
+        if (handleToken(unescapedVariableName, "variable", bufferStartIndex) === false) {
           return tokenCount;
         }
         bufferStartIndex = bufferEndIndex + variableSuffix.length;
@@ -1649,7 +1748,7 @@ function parseVariableExpression(serialized, onToken) {
     bufferStartIndex -= variablePrefix.length;
   }
   if (bufferStartIndex < serialized.length) {
-    handleToken(serialized.substring(bufferStartIndex), state);
+    handleToken(serialized.substring(bufferStartIndex), state, bufferStartIndex);
   }
   return tokenCount;
 }
@@ -2012,6 +2111,48 @@ var _IntegrationPropertyEditorsClient = class _IntegrationPropertyEditorsClient2
 _baseUrl = /* @__PURE__ */ new WeakMap();
 __privateAdd3(_IntegrationPropertyEditorsClient, _baseUrl, "/api/v1/integration-property-editors");
 var _url22;
+var _NotificationsClient = class _NotificationsClient2 extends ApiClient {
+  constructor(options) {
+    super(options);
+  }
+  /**
+   * Lists notifications for the current user.
+   *
+   * @deprecated This API is experimental and may change without notice.
+   */
+  async list(options) {
+    const fetchUri = this.createUrl(__privateGet3(_NotificationsClient2, _url22), options);
+    return await this.apiClient(fetchUri);
+  }
+  /**
+   * Creates a notification for one or more recipients.
+   *
+   * @deprecated This API is experimental and may change without notice.
+   */
+  async create(body) {
+    const fetchUri = this.createUrl(__privateGet3(_NotificationsClient2, _url22));
+    return await this.apiClient(fetchUri, {
+      method: "POST",
+      body: JSON.stringify(body)
+    });
+  }
+  /**
+   * Updates the read state of the current user's notifications.
+   *
+   * @deprecated This API is experimental and may change without notice.
+   */
+  async setReadState(body) {
+    const fetchUri = this.createUrl(__privateGet3(_NotificationsClient2, _url22));
+    await this.apiClient(fetchUri, {
+      method: "PATCH",
+      body: JSON.stringify(body),
+      expectNoContent: true
+    });
+  }
+};
+_url22 = /* @__PURE__ */ new WeakMap();
+__privateAdd3(_NotificationsClient, _url22, "/api/v1/notifications");
+var _url32;
 var _projectsUrl;
 var _ProjectClient = class _ProjectClient2 extends ApiClient {
   constructor(options) {
@@ -2019,7 +2160,7 @@ var _ProjectClient = class _ProjectClient2 extends ApiClient {
   }
   /** Fetches single Project */
   async get(options) {
-    const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url22), { ...options });
+    const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url32), { ...options });
     return await this.apiClient(fetchUri);
   }
   /**
@@ -2027,31 +2168,43 @@ 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) {
-    const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url22));
+  async save(body) {
+    const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url32));
     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) {
-    const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url22));
+  async remove(body) {
+    const fetchUri = this.createUrl(__privateGet3(_ProjectClient2, _url32));
     await this.apiClient(fetchUri, {
       method: "DELETE",
       body: JSON.stringify({ ...body }),
       expectNoContent: true
     });
   }
+  /** @deprecated Use {@link remove} instead. */
+  async delete(body) {
+    return this.remove(body);
+  }
 };
-_url22 = /* @__PURE__ */ new WeakMap();
+_url32 = /* @__PURE__ */ new WeakMap();
 _projectsUrl = /* @__PURE__ */ new WeakMap();
-__privateAdd3(_ProjectClient, _url22, "/api/v1/project");
+__privateAdd3(_ProjectClient, _url32, "/api/v1/project");
 __privateAdd3(_ProjectClient, _projectsUrl, "/api/v1/projects");
 var ROUTE_URL = "/api/v1/route";
 var RouteClient = class extends ApiClient {
@@ -2063,8 +2216,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);
@@ -2074,6 +2233,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;
@@ -2380,9 +2543,9 @@ function createLimitPolicy2({
 }
 
 // src/clients/canvas.ts
-var getCanvasClient = (options) => {
+var buildCanvasClientOptions = (options) => {
   const cache2 = resolveCanvasCache(options);
-  return new CanvasClient({
+  return {
     projectId: env.getProjectId(),
     apiHost: env.getApiHost(),
     apiKey: env.getApiKey(),
@@ -2430,7 +2593,13 @@ var getCanvasClient = (options) => {
         }
       });
     }
-  });
+  };
+};
+var getCanvasClient = (options) => {
+  return new CanvasClient(buildCanvasClientOptions(options));
+};
+var getCompositionDeliveryClient = (options) => {
+  return new CompositionDeliveryClient(buildCanvasClientOptions(options));
 };
 
 // src/clients/manifest.ts
@@ -2729,6 +2898,35 @@ var _Route = class _Route2 {
     }
     return segment.slice(_Route2.dynamicSegmentPrefix.length);
   }
+  /**
+   * Splits a path into the path portion and an optional `#fragment`
+   * (everything after the first `#`).
+   *
+   * Variable expressions (`${...}`) may legitimately contain `#` characters
+   * (e.g. JSON-pointer tokens like `${#jptr:/foo/_slug}`), so the fragment
+   * delimiter is the first `#` that falls outside of a variable expression.
+   */
+  static splitFragment(path) {
+    let fragmentIndex = -1;
+    parseVariableExpression(path, (token, type, offset) => {
+      if (type === "variable") {
+        return;
+      }
+      const hashOffset = token.indexOf("#");
+      if (hashOffset === -1) {
+        return;
+      }
+      fragmentIndex = offset + hashOffset;
+      return false;
+    });
+    if (fragmentIndex === -1) {
+      return { path, fragment: void 0 };
+    }
+    return {
+      path: path.slice(0, fragmentIndex),
+      fragment: path.slice(fragmentIndex + 1)
+    };
+  }
 };
 _routeInfo = /* @__PURE__ */ new WeakMap();
 _Route_static = /* @__PURE__ */ new WeakSet();
@@ -3435,14 +3633,14 @@ var import_react7 = __toESM(require("react"));
 var import_next_app_router_shared5 = require("@uniformdev/next-app-router-shared");
 var resolvePlaygroundRoute = async ({ code }) => {
   const pageState = (0, import_next_app_router_shared5.deserializeEvaluationResult)({ input: code });
-  const canvasClient = getCanvasClient({
+  const canvasClient = getCompositionDeliveryClient({
     cache: {
       type: "no-cache"
     }
   });
   let composition = void 0;
   try {
-    composition = await canvasClient.getCompositionById({
+    composition = await canvasClient.get({
       compositionId: pageState.routePath,
       state: pageState.compositionState,
       withComponentIDs: true
@@ -3588,7 +3786,7 @@ var createUniformPlaygroundStaticParams = async (options) => {
     const routeClient = getRouteClient({
       state
     });
-    route = await routeClient.getRoute({
+    route = await routeClient.get({
       path: firstPath,
       withComponentIDs: true,
       state: CANVAS_DRAFT_STATE
@@ -3641,7 +3839,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.getRoute({
+  const route = await routeClient.get({
     path: resolvedPath,
     withComponentIDs: true,
     state: CANVAS_PUBLISHED_STATE
@@ -3894,14 +4092,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([
@@ -4171,6 +4369,7 @@ var createCompositionCache = () => {
   expireMiddlewareCacheTag,
   findRouteMatch,
   getCanvasClient,
+  getCompositionDeliveryClient,
   getManifest,
   getManifestClient,
   getProjectMapClient,