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

package/dist/index.d.mts

@@ -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.
      */
@@ -11548,7 +11552,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
         filters?: CompositionFilters;
     } & ({
         resolveData: true;
-        diagnostics?: boolean;
+        diagnostics: DataResolutionParameters['diagnostics'];
     } | {
         resolveData?: false;
     })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;

package/dist/index.d.ts

@@ -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.
      */
@@ -11548,7 +11552,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
         filters?: CompositionFilters;
     } & ({
         resolveData: true;
-        diagnostics?: boolean;
+        diagnostics: DataResolutionParameters['diagnostics'];
     } | {
         resolveData?: false;
     })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;

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
     };
   }
 };

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
     };
   }
 };

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
     };
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "20.7.1-alpha.26+03c49728b3",
+  "version": "20.7.1-alpha.28+5b9868df5c",
   "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.28+5b9868df5c",
+    "@uniformdev/context": "20.7.1-alpha.28+5b9868df5c",
+    "@uniformdev/richtext": "20.7.1-alpha.28+5b9868df5c",
     "immer": "10.1.1"
   },
   "files": [
@@ -49,5 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "03c49728b3fb82b57e64265bde2f950f12ee7cb6"
+  "gitHead": "5b9868df5c62413be37a4f1e59c11f05d52ac169"
 }