@uniformdev/canvas 18.23.1-alpha.34 → 18.24.0

package/dist/index.d.ts

@@ -1963,9 +1963,32 @@ interface components {
             };
             data: unknown;
         };
+        CompositionDiagnostics: {
+            /** @description Edge location where the request was processed */
+            edgeLocation?: string;
+            compositionFetch?: {
+                /** @description How long it took to fetch the composition (ms) */
+                duration: number;
+                /** @description Indicates if the composition was fetched from the cache */
+                cacheHit: boolean;
+                /** @description Indicates if the request results in a valid composition */
+                hasValidComposition: boolean;
+                /** @description Edge cache location used */
+                cacheLocation?: string;
+                /** @description Uniform-specifc request identifiers */
+                requestId?: string;
+            };
+            configRetrieval?: {
+                /** @description How long it took to retrieve the config (ms, in parallel to composition fetch) */
+                duration: number;
+                /** @description How many data type configs were retrieved */
+                dataTypeCount: number;
+            };
+            data?: components["schemas"]["DataDiagnostic"][];
+        };
         CompositionIssue: {
-            componentPath: string;
-            componentType: string;
+            componentPath?: string;
+            componentType?: string;
             message: string;
             type: string;
         };
@@ -2026,7 +2049,7 @@ interface components {
         CompositionResult: {
             content: {
                 "application/json": {
-                    dataDiagnostics?: components["schemas"]["DataDiagnostic"][];
+                    diagnostics?: components["schemas"]["CompositionDiagnostics"];
                     errors?: components["schemas"]["CompositionIssue"][];
                     warnings?: components["schemas"]["CompositionIssue"][];
                 } & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
@@ -2964,10 +2987,10 @@ type DataResolutionOptionPositive = {
 };
 type DataResolutionParameters = {
     /**
-     * Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
+     * 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.
      */
-    unstable_dataDiagnostics?: boolean;
+    unstable_diagnostics?: boolean;
     /**
      * Pass dynamic variables to the composition that are required for resolving bindings and datas,
      * such as language, detail page ID, etc.
@@ -3008,15 +3031,18 @@ type OverrideIssue = CompositionIssueCore & {
     message: string;
     type: 'override';
 };
+/** Diagnostics about edge request processing */
+type CompositionDiagnostics = components['schemas']['CompositionDiagnostics'];
 /** Diagnostic data about the load performance of attached composition datas */
 type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
 /** Response as it comes from the data resolution endpoint */
 type CompositionResolvedGetResponse = CompositionGetResponse & {
     /**
-     * Copies of resolved data and how long it took to resolve each data.
-     * Only set when dataDiagnostics=true is passed to the options.
+     * Diagnostic information about request processing, including origin/config/data
+     * timings, edge locations, cache statuses and raw data.
+     * Only set when diagnostics=true is passed to the options.
      */
-    dataDiagnostics?: Array<CompositionDataDiagnostic>;
+    diagnostics?: CompositionDiagnostics;
     /**
      * Any failures to bind to data that occured on bindings marked 'must exist'.
      * If no failures occurred, this will be undefined.
@@ -3219,10 +3245,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
             slots?: {
                 id: string;
                 name: string;
-                allowedComponents: string[]; /** Deletes a Canvas component definition */
+                allowedComponents: string[];
                 inheritAllowedComponents: boolean;
                 allowAllComponents?: boolean | undefined;
-                patternsInAllowedComponents?: boolean | undefined; /** Deletes a Canvas component definition */
+                patternsInAllowedComponents?: boolean | undefined;
                 minComponents?: number | undefined;
                 maxComponents?: number | undefined;
             }[] | undefined;
@@ -5716,4 +5742,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
+export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };

package/dist/index.esm.js

@@ -490,7 +490,7 @@ var CanvasClient = class extends ApiClient {
   getOneComposition({
     unstable_resolveData: resolveData,
     unstable_dynamicVariables: dynamicVariables,
-    unstable_dataDiagnostics: dataDiagnostics,
+    unstable_diagnostics: diagnostics,
     ...params
   }) {
     const { projectId } = this.options;
@@ -501,7 +501,7 @@ var CanvasClient = class extends ApiClient {
       ...params,
       projectId,
       ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
-      ...dataDiagnostics ? { dataDiagnostics: "true" } : {}
+      ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl);

package/dist/index.js

@@ -561,7 +561,7 @@ var CanvasClient = class extends import_api.ApiClient {
   getOneComposition({
     unstable_resolveData: resolveData,
     unstable_dynamicVariables: dynamicVariables,
-    unstable_dataDiagnostics: dataDiagnostics,
+    unstable_diagnostics: diagnostics,
     ...params
   }) {
     const { projectId } = this.options;
@@ -572,7 +572,7 @@ var CanvasClient = class extends import_api.ApiClient {
       ...params,
       projectId,
       ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
-      ...dataDiagnostics ? { dataDiagnostics: "true" } : {}
+      ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl);

package/dist/index.mjs

@@ -490,7 +490,7 @@ var CanvasClient = class extends ApiClient {
   getOneComposition({
     unstable_resolveData: resolveData,
     unstable_dynamicVariables: dynamicVariables,
-    unstable_dataDiagnostics: dataDiagnostics,
+    unstable_diagnostics: diagnostics,
     ...params
   }) {
     const { projectId } = this.options;
@@ -501,7 +501,7 @@ var CanvasClient = class extends ApiClient {
       ...params,
       projectId,
       ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
-      ...dataDiagnostics ? { dataDiagnostics: "true" } : {}
+      ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "18.23.1-alpha.34+8eddcae60",
+  "version": "18.24.0",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -47,7 +47,7 @@
     "pusher-js": "8.0.1"
   },
   "dependencies": {
-    "@uniformdev/context": "18.23.1-alpha.34+8eddcae60"
+    "@uniformdev/context": "18.24.0"
   },
   "files": [
     "/dist"
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8eddcae607f5c8b7ef9f7752bc11e186eee4305b"
+  "gitHead": "1e3a51a48860f7ec5861307dcda7d75278ac1505"
 }