@uniformdev/canvas 20.7.1-alpha.26 → 20.7.1-alpha.32

package/dist/index.d.mts

@@ -553,7 +553,7 @@ interface components$n {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -778,7 +778,7 @@ interface components$m {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -7507,6 +7507,8 @@ interface components$8 {
                 retryCount: number;
                 retryDelay: number;
                 sourceCache?: string;
+                /** @description Array of status codes for corresponding retries; will be empty for cache hits, Uniform Content data resources and static JSON data resources */
+                statusCodes: number[];
             };
             data: unknown;
         };
@@ -7541,6 +7543,7 @@ interface components$8 {
             };
         };
         DataResolutionIssue: {
+            componentId?: string;
             componentPath?: string;
             componentType?: string;
             message: string;
@@ -8419,8 +8422,8 @@ interface components$8 {
         };
     };
     parameters: {
-        /** @description Enables additional diagnostics that will be attached to the response */
-        diagnostics: boolean;
+        /** @description Enables additional diagnostics that will be attached to the response; set to "no-data" to skip data resource values while keeping metrics */
+        diagnostics: "true" | "false" | "no-data";
         /** @description Controls how many levels deep content references should be resolved */
         resolutionDepth: number;
         /** @description Max number of records to return */
@@ -9732,9 +9735,10 @@ type DataResolutionOptionPositive = {
 type DataResolutionParameters = {
     /**
      * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
-     * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
+     * Only use when diagnosing performance issues, don't use for serving production traffic.
+     * Setting to `true` will include all resolved data which may be big. Use `"no-data"` to skip data.
      */
-    diagnostics?: boolean;
+    diagnostics?: boolean | 'no-data';
     /**
      * Controls how many levels deep content references should be resolved.
      */
@@ -10101,10 +10105,7 @@ interface paths$6 {
             path?: never;
             cookie?: never;
         };
-        /**
-         * @deprecated
-         * @description Gets all preview URLs
-         */
+        /** @description Gets all preview URLs */
         get: {
             parameters: {
                 query: {
@@ -10149,10 +10150,7 @@ interface paths$6 {
                 500: components$6["responses"]["InternalServerError"];
             };
         };
-        /**
-         * @deprecated
-         * @description Upserts a preview URL
-         */
+        /** @description Upserts a preview URL */
         put: {
             parameters: {
                 query?: never;
@@ -10214,10 +10212,7 @@ interface paths$6 {
             };
         };
         post?: never;
-        /**
-         * @deprecated
-         * @description Deletes a preview URL
-         */
+        /** @description Deletes a preview URL */
         delete: {
             parameters: {
                 query?: never;
@@ -11548,7 +11543,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
         filters?: CompositionFilters;
     } & ({
         resolveData: true;
-        diagnostics?: boolean;
+        diagnostics: DataResolutionParameters['diagnostics'];
     } | {
         resolveData?: false;
     })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
@@ -12102,13 +12097,19 @@ interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityO
      * When false, indeterminate criteria will fail the summary result, and the node will be hidden
      */
     showIndeterminate?: boolean;
+    /**
+     * When evaluating visibility of a root node, this controls what happens when the node is found to be invisible.
+     * When 'throw' (default), an error is thrown.
+     * When 'ignore', the node is left intact. False is still returned.
+     */
+    rootNodeInvisibleHandling?: 'throw' | 'ignore';
 }
 /**
  * Function to call to evaluate visibility rules when traversing the node tree with walkNodeTree.
  *
  * If the function returns false, that means the current node is removed and you should stop any other code handling.
  */
-declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
+declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, rootNodeInvisibleHandling, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
 
 interface EvaluateWalkTreePropertyCriteriaOptions extends Pick<EvaluatePropertyCriteriaOptions, 'rules' | 'keepIndeterminate'> {
     node: ComponentInstance;
@@ -12398,8 +12399,6 @@ declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
 
 /**
  * API client to work with Uniform Project Preview entities
- *
- * @deprecated beta functionality subject to change
  */
 declare class PreviewClient extends ApiClient {
     constructor(options: ClientOptions);

package/dist/index.d.ts

@@ -553,7 +553,7 @@ interface components$n {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -778,7 +778,7 @@ interface components$m {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -7507,6 +7507,8 @@ interface components$8 {
                 retryCount: number;
                 retryDelay: number;
                 sourceCache?: string;
+                /** @description Array of status codes for corresponding retries; will be empty for cache hits, Uniform Content data resources and static JSON data resources */
+                statusCodes: number[];
             };
             data: unknown;
         };
@@ -7541,6 +7543,7 @@ interface components$8 {
             };
         };
         DataResolutionIssue: {
+            componentId?: string;
             componentPath?: string;
             componentType?: string;
             message: string;
@@ -8419,8 +8422,8 @@ interface components$8 {
         };
     };
     parameters: {
-        /** @description Enables additional diagnostics that will be attached to the response */
-        diagnostics: boolean;
+        /** @description Enables additional diagnostics that will be attached to the response; set to "no-data" to skip data resource values while keeping metrics */
+        diagnostics: "true" | "false" | "no-data";
         /** @description Controls how many levels deep content references should be resolved */
         resolutionDepth: number;
         /** @description Max number of records to return */
@@ -9732,9 +9735,10 @@ type DataResolutionOptionPositive = {
 type DataResolutionParameters = {
     /**
      * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
-     * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
+     * Only use when diagnosing performance issues, don't use for serving production traffic.
+     * Setting to `true` will include all resolved data which may be big. Use `"no-data"` to skip data.
      */
-    diagnostics?: boolean;
+    diagnostics?: boolean | 'no-data';
     /**
      * Controls how many levels deep content references should be resolved.
      */
@@ -10101,10 +10105,7 @@ interface paths$6 {
             path?: never;
             cookie?: never;
         };
-        /**
-         * @deprecated
-         * @description Gets all preview URLs
-         */
+        /** @description Gets all preview URLs */
         get: {
             parameters: {
                 query: {
@@ -10149,10 +10150,7 @@ interface paths$6 {
                 500: components$6["responses"]["InternalServerError"];
             };
         };
-        /**
-         * @deprecated
-         * @description Upserts a preview URL
-         */
+        /** @description Upserts a preview URL */
         put: {
             parameters: {
                 query?: never;
@@ -10214,10 +10212,7 @@ interface paths$6 {
             };
         };
         post?: never;
-        /**
-         * @deprecated
-         * @description Deletes a preview URL
-         */
+        /** @description Deletes a preview URL */
         delete: {
             parameters: {
                 query?: never;
@@ -11548,7 +11543,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
         filters?: CompositionFilters;
     } & ({
         resolveData: true;
-        diagnostics?: boolean;
+        diagnostics: DataResolutionParameters['diagnostics'];
     } | {
         resolveData?: false;
     })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
@@ -12102,13 +12097,19 @@ interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityO
      * When false, indeterminate criteria will fail the summary result, and the node will be hidden
      */
     showIndeterminate?: boolean;
+    /**
+     * When evaluating visibility of a root node, this controls what happens when the node is found to be invisible.
+     * When 'throw' (default), an error is thrown.
+     * When 'ignore', the node is left intact. False is still returned.
+     */
+    rootNodeInvisibleHandling?: 'throw' | 'ignore';
 }
 /**
  * Function to call to evaluate visibility rules when traversing the node tree with walkNodeTree.
  *
  * If the function returns false, that means the current node is removed and you should stop any other code handling.
  */
-declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
+declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, rootNodeInvisibleHandling, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
 
 interface EvaluateWalkTreePropertyCriteriaOptions extends Pick<EvaluatePropertyCriteriaOptions, 'rules' | 'keepIndeterminate'> {
     node: ComponentInstance;
@@ -12398,8 +12399,6 @@ declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
 
 /**
  * API client to work with Uniform Project Preview entities
- *
- * @deprecated beta functionality subject to change
  */
 declare class PreviewClient extends ApiClient {
     constructor(options: ClientOptions);

package/dist/index.esm.js

@@ -624,7 +624,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -665,7 +665,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      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);
@@ -847,7 +847,7 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -2092,15 +2092,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2336,25 +2340,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2365,9 +2368,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2377,7 +2378,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });

package/dist/index.js

@@ -787,7 +787,7 @@ var CanvasClient = class extends import_api2.ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -828,7 +828,7 @@ var CanvasClient = class extends import_api2.ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      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);
@@ -1010,7 +1010,7 @@ var _ContentClient = class _ContentClient extends import_api4.ApiClient {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -2255,15 +2255,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2499,25 +2503,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2528,9 +2531,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2540,7 +2541,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });

package/dist/index.mjs

@@ -624,7 +624,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -665,7 +665,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      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);
@@ -847,7 +847,7 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -2092,15 +2092,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2336,25 +2340,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2365,9 +2368,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2377,7 +2378,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "20.7.1-alpha.26+03c49728b3",
+  "version": "20.7.1-alpha.32+616e77445e",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -28,7 +28,7 @@
     "lint": "eslint \"src/**/*.{js,ts,tsx}\"",
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
     "update-openapi": "tsx ./scripts/update-openapi.cts",
-    "document": "api-extractor run --local"
+    "document:prebuild": "api-extractor run --local"
   },
   "devDependencies": {
     "@types/retry": "0.12.5",
@@ -38,9 +38,9 @@
     "p-throttle": "5.0.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "20.7.1-alpha.26+03c49728b3",
-    "@uniformdev/context": "20.7.1-alpha.26+03c49728b3",
-    "@uniformdev/richtext": "20.7.1-alpha.26+03c49728b3",
+    "@uniformdev/assets": "20.7.1-alpha.32+616e77445e",
+    "@uniformdev/context": "20.7.1-alpha.32+616e77445e",
+    "@uniformdev/richtext": "20.7.1-alpha.32+616e77445e",
     "immer": "10.1.1"
   },
   "files": [
@@ -49,5 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "03c49728b3fb82b57e64265bde2f950f12ee7cb6"
+  "gitHead": "616e77445e7f75fca783616a70b359a2fb7bdfab"
 }