@uniformdev/canvas 19.58.1 → 19.58.2-alpha.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +333 -111
- package/dist/index.d.ts +333 -111
- package/dist/index.esm.js +516 -162
- package/dist/index.js +526 -163
- package/dist/index.mjs +516 -162
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -185,6 +185,12 @@ interface components$5 {
|
|
185
185
|
/** @description Last modified date string for this content type (ignored for writes) */
|
186
186
|
updated?: string;
|
187
187
|
slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
|
188
|
+
/**
|
189
|
+
* @description The definition type of this content type (block or content type)
|
190
|
+
* @default contentType
|
191
|
+
* @enum {string}
|
192
|
+
*/
|
193
|
+
type?: "contentType" | "block";
|
188
194
|
};
|
189
195
|
/** @description Defines an editable parameter on a component. */
|
190
196
|
ComponentParameter: {
|
@@ -846,6 +852,12 @@ interface external$c {
|
|
846
852
|
/** @description Last modified date string for this content type (ignored for writes) */
|
847
853
|
updated?: string;
|
848
854
|
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
855
|
+
/**
|
856
|
+
* @description The definition type of this content type (block or content type)
|
857
|
+
* @default contentType
|
858
|
+
* @enum {string}
|
859
|
+
*/
|
860
|
+
type?: "contentType" | "block";
|
849
861
|
};
|
850
862
|
/** @description Defines an editable parameter on a component. */
|
851
863
|
ComponentParameter: {
|
@@ -1213,6 +1225,81 @@ type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPerm
|
|
1213
1225
|
/** Defines a component type that can live on a Composition */
|
1214
1226
|
type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
|
1215
1227
|
|
1228
|
+
/** Public ID of Canvas personalization component type */
|
1229
|
+
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
1230
|
+
/** Public ID of Canvas A/B test component type */
|
1231
|
+
declare const CANVAS_TEST_TYPE = "$test";
|
1232
|
+
/** Public ID of Canvas localization component type */
|
1233
|
+
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
1234
|
+
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
1235
|
+
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
1236
|
+
/** Public ID of the locale parameter on Canvas components */
|
1237
|
+
declare const CANVAS_LOCALE_TAG_PARAM = "locale";
|
1238
|
+
/** Parameter type for a block parameter */
|
1239
|
+
declare const CANVAS_BLOCK_PARAM_TYPE = "$block";
|
1240
|
+
/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
|
1241
|
+
declare const CANVAS_PERSONALIZE_SLOT = "pz";
|
1242
|
+
/** Name of the slot on CANVAS_TEST_TYPE */
|
1243
|
+
declare const CANVAS_TEST_SLOT = "test";
|
1244
|
+
/** Name of the slot on CANVAS_TEST_TYPE */
|
1245
|
+
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
1246
|
+
/** Constant for a draft composition state. Subject to change. */
|
1247
|
+
declare const CANVAS_DRAFT_STATE = 0;
|
1248
|
+
/** Constant for a published composition state. Subject to change. */
|
1249
|
+
declare const CANVAS_PUBLISHED_STATE = 64;
|
1250
|
+
/** Constant for editor composition state. */
|
1251
|
+
declare const CANVAS_EDITOR_STATE = 63;
|
1252
|
+
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
1253
|
+
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
1254
|
+
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
1255
|
+
declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
1256
|
+
/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
|
1257
|
+
declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
1258
|
+
/**
|
1259
|
+
* The name of the query string used to set a secret to protect for the preview mode.
|
1260
|
+
* This is not configurable at the moment.
|
1261
|
+
*/
|
1262
|
+
declare const SECRET_QUERY_STRING_PARAM = "secret";
|
1263
|
+
/** The name of the query string used to detect if we are in contextual editing mode */
|
1264
|
+
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
1265
|
+
/** The name of the query string used to indicate that we want to use the playground for preview */
|
1266
|
+
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
1267
|
+
/** The name of the query string used to get the config from the preview url */
|
1268
|
+
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
1269
|
+
/** The value of "data-role" in the component start `<script>` tag */
|
1270
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
1271
|
+
/** The value of "data-role" in the component end `<script>` tag */
|
1272
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
1273
|
+
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
1274
|
+
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
1275
|
+
/**
|
1276
|
+
* The name of the attribute added to the elements rendered by Uniform.
|
1277
|
+
* Use to allow interacting with them by default in the preview panel
|
1278
|
+
*/
|
1279
|
+
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
1280
|
+
/** The ID we give to placeholder components */
|
1281
|
+
declare const PLACEHOLDER_ID = "placeholder";
|
1282
|
+
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
1283
|
+
declare const EMPTY_COMPOSITION: {
|
1284
|
+
_id: string;
|
1285
|
+
_name: string;
|
1286
|
+
type: string;
|
1287
|
+
};
|
1288
|
+
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
1289
|
+
declare const EDGE_MIN_CACHE_TTL = 15;
|
1290
|
+
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
1291
|
+
declare const EDGE_MAX_CACHE_TTL = 600;
|
1292
|
+
/** Default value for Edgehancers Cache TTL (in seconds) */
|
1293
|
+
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
1294
|
+
/** A value that indicates that Edgehancers caching is disabled */
|
1295
|
+
declare const EDGE_CACHE_DISABLED = -1;
|
1296
|
+
/** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
|
1297
|
+
declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
|
1298
|
+
/** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
|
1299
|
+
declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
|
1300
|
+
/** Default value for Edgehancers Long Term Cache TTL (in hours) */
|
1301
|
+
declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
1302
|
+
|
1216
1303
|
/**
|
1217
1304
|
* This file was auto-generated by openapi-typescript.
|
1218
1305
|
* Do not make direct changes to the file.
|
@@ -1508,6 +1595,12 @@ interface external$b {
|
|
1508
1595
|
/** @description Last modified date string for this content type (ignored for writes) */
|
1509
1596
|
updated?: string;
|
1510
1597
|
slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1598
|
+
/**
|
1599
|
+
* @description The definition type of this content type (block or content type)
|
1600
|
+
* @default contentType
|
1601
|
+
* @enum {string}
|
1602
|
+
*/
|
1603
|
+
type?: "contentType" | "block";
|
1511
1604
|
};
|
1512
1605
|
/** @description Defines an editable parameter on a component. */
|
1513
1606
|
ComponentParameter: {
|
@@ -1878,6 +1971,8 @@ interface paths$9 {
|
|
1878
1971
|
offset?: number;
|
1879
1972
|
/** Max number of records to return */
|
1880
1973
|
limit?: number;
|
1974
|
+
/** Limit the types of content type to return. If not specified, both block types and content types are returned. */
|
1975
|
+
type?: "block" | "contentType";
|
1881
1976
|
};
|
1882
1977
|
};
|
1883
1978
|
responses: {
|
@@ -2179,6 +2274,12 @@ interface external$a {
|
|
2179
2274
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2180
2275
|
updated?: string;
|
2181
2276
|
slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2277
|
+
/**
|
2278
|
+
* @description The definition type of this content type (block or content type)
|
2279
|
+
* @default contentType
|
2280
|
+
* @enum {string}
|
2281
|
+
*/
|
2282
|
+
type?: "contentType" | "block";
|
2182
2283
|
};
|
2183
2284
|
/** @description Defines an editable parameter on a component. */
|
2184
2285
|
ComponentParameter: {
|
@@ -2565,6 +2666,11 @@ interface paths$8 {
|
|
2565
2666
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2566
2667
|
*/
|
2567
2668
|
withUIStatus?: components$4["parameters"]["withUIStatus"];
|
2669
|
+
/**
|
2670
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
2671
|
+
* If false, the `_id` will not be present in the API response.
|
2672
|
+
*/
|
2673
|
+
withComponentIDs?: components$4["parameters"]["withComponentIDs"];
|
2568
2674
|
};
|
2569
2675
|
};
|
2570
2676
|
responses: {
|
@@ -2751,6 +2857,11 @@ interface components$4 {
|
|
2751
2857
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2752
2858
|
*/
|
2753
2859
|
withUIStatus: boolean;
|
2860
|
+
/**
|
2861
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
2862
|
+
* If false, the `_id` will not be present in the API response.
|
2863
|
+
*/
|
2864
|
+
withComponentIDs: boolean;
|
2754
2865
|
/**
|
2755
2866
|
* @deprecated
|
2756
2867
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -2992,6 +3103,12 @@ interface external$9 {
|
|
2992
3103
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2993
3104
|
updated?: string;
|
2994
3105
|
slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3106
|
+
/**
|
3107
|
+
* @description The definition type of this content type (block or content type)
|
3108
|
+
* @default contentType
|
3109
|
+
* @enum {string}
|
3110
|
+
*/
|
3111
|
+
type?: "contentType" | "block";
|
2995
3112
|
};
|
2996
3113
|
/** @description Defines an editable parameter on a component. */
|
2997
3114
|
ComponentParameter: {
|
@@ -3341,6 +3458,7 @@ type DeleteContentTypeOptions = paths$9['/api/v1/content-types']['delete']['requ
|
|
3341
3458
|
type PutContentTypeBody = paths$9['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
3342
3459
|
type GetContentTypesResponse = paths$9['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
3343
3460
|
type Entry = components$4['schemas']['EntryApiResponse'];
|
3461
|
+
type EntryData = Entry['entry'];
|
3344
3462
|
type GetEntriesOptions = paths$8['/api/v1/entries']['get']['parameters']['query'];
|
3345
3463
|
type GetEntriesResponse = paths$8['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
3346
3464
|
type DeleteEntryOptions = paths$8['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
@@ -3649,6 +3767,12 @@ interface external$8 {
|
|
3649
3767
|
/** @description Last modified date string for this content type (ignored for writes) */
|
3650
3768
|
updated?: string;
|
3651
3769
|
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3770
|
+
/**
|
3771
|
+
* @description The definition type of this content type (block or content type)
|
3772
|
+
* @default contentType
|
3773
|
+
* @enum {string}
|
3774
|
+
*/
|
3775
|
+
type?: "contentType" | "block";
|
3652
3776
|
};
|
3653
3777
|
/** @description Defines an editable parameter on a component. */
|
3654
3778
|
ComponentParameter: {
|
@@ -4250,6 +4374,12 @@ interface external$7 {
|
|
4250
4374
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4251
4375
|
updated?: string;
|
4252
4376
|
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
4377
|
+
/**
|
4378
|
+
* @description The definition type of this content type (block or content type)
|
4379
|
+
* @default contentType
|
4380
|
+
* @enum {string}
|
4381
|
+
*/
|
4382
|
+
type?: "contentType" | "block";
|
4253
4383
|
};
|
4254
4384
|
/** @description Defines an editable parameter on a component. */
|
4255
4385
|
ComponentParameter: {
|
@@ -4886,6 +5016,12 @@ interface external$6 {
|
|
4886
5016
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4887
5017
|
updated?: string;
|
4888
5018
|
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
5019
|
+
/**
|
5020
|
+
* @description The definition type of this content type (block or content type)
|
5021
|
+
* @default contentType
|
5022
|
+
* @enum {string}
|
5023
|
+
*/
|
5024
|
+
type?: "contentType" | "block";
|
4889
5025
|
};
|
4890
5026
|
/** @description Defines an editable parameter on a component. */
|
4891
5027
|
ComponentParameter: {
|
@@ -5951,6 +6087,12 @@ interface external$5 {
|
|
5951
6087
|
/** @description Last modified date string for this content type (ignored for writes) */
|
5952
6088
|
updated?: string;
|
5953
6089
|
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
6090
|
+
/**
|
6091
|
+
* @description The definition type of this content type (block or content type)
|
6092
|
+
* @default contentType
|
6093
|
+
* @enum {string}
|
6094
|
+
*/
|
6095
|
+
type?: "contentType" | "block";
|
5954
6096
|
};
|
5955
6097
|
/** @description Defines an editable parameter on a component. */
|
5956
6098
|
ComponentParameter: {
|
@@ -6793,6 +6935,12 @@ interface external$3 {
|
|
6793
6935
|
/** @description Last modified date string for this content type (ignored for writes) */
|
6794
6936
|
updated?: string;
|
6795
6937
|
slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
6938
|
+
/**
|
6939
|
+
* @description The definition type of this content type (block or content type)
|
6940
|
+
* @default contentType
|
6941
|
+
* @enum {string}
|
6942
|
+
*/
|
6943
|
+
type?: "contentType" | "block";
|
6796
6944
|
};
|
6797
6945
|
/** @description Defines an editable parameter on a component. */
|
6798
6946
|
ComponentParameter: {
|
@@ -7645,6 +7793,11 @@ interface external$3 {
|
|
7645
7793
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7646
7794
|
*/
|
7647
7795
|
withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
7796
|
+
/**
|
7797
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
7798
|
+
* If false, the `_id` will not be present in the API response.
|
7799
|
+
*/
|
7800
|
+
withComponentIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
7648
7801
|
};
|
7649
7802
|
};
|
7650
7803
|
responses: {
|
@@ -7831,6 +7984,11 @@ interface external$3 {
|
|
7831
7984
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7832
7985
|
*/
|
7833
7986
|
withUIStatus: boolean;
|
7987
|
+
/**
|
7988
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
7989
|
+
* If false, the `_id` will not be present in the API response.
|
7990
|
+
*/
|
7991
|
+
withComponentIDs: boolean;
|
7834
7992
|
/**
|
7835
7993
|
* @deprecated
|
7836
7994
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -8561,6 +8719,12 @@ interface external$2 {
|
|
8561
8719
|
/** @description Last modified date string for this content type (ignored for writes) */
|
8562
8720
|
updated?: string;
|
8563
8721
|
slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
8722
|
+
/**
|
8723
|
+
* @description The definition type of this content type (block or content type)
|
8724
|
+
* @default contentType
|
8725
|
+
* @enum {string}
|
8726
|
+
*/
|
8727
|
+
type?: "contentType" | "block";
|
8564
8728
|
};
|
8565
8729
|
/** @description Defines an editable parameter on a component. */
|
8566
8730
|
ComponentParameter: {
|
@@ -9603,6 +9767,12 @@ type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentPara
|
|
9603
9767
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
9604
9768
|
value: TValue;
|
9605
9769
|
};
|
9770
|
+
/** Parameter which stores blocks of entry types */
|
9771
|
+
type ComponentParameterBlock = Omit<ComponentParameter<BlockValue>, 'type'> & {
|
9772
|
+
type: typeof CANVAS_BLOCK_PARAM_TYPE;
|
9773
|
+
};
|
9774
|
+
/** Value type of a block parameter or block field */
|
9775
|
+
type BlockValue = EntryData[];
|
9606
9776
|
/** The type of the parameters in contextual editing mode. */
|
9607
9777
|
type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
|
9608
9778
|
/** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
|
@@ -10323,15 +10493,25 @@ type PreviewPanelSettings = {
|
|
10323
10493
|
isInteractive: boolean;
|
10324
10494
|
};
|
10325
10495
|
type ContextualEditingComponentReference = {
|
10326
|
-
elements: HTMLElement[];
|
10327
10496
|
id: string;
|
10328
|
-
|
10329
|
-
|
10330
|
-
|
10331
|
-
|
10332
|
-
|
10497
|
+
icon?: string;
|
10498
|
+
type?: string;
|
10499
|
+
title?: string;
|
10500
|
+
name?: string;
|
10501
|
+
parameters?: Record<string, {
|
10502
|
+
id: string;
|
10503
|
+
type: string;
|
10504
|
+
name?: string;
|
10505
|
+
isReadOnly?: boolean;
|
10506
|
+
}>;
|
10333
10507
|
parentId?: string;
|
10334
10508
|
parentType?: string;
|
10509
|
+
parentSlot?: {
|
10510
|
+
id?: string;
|
10511
|
+
componentIndex?: number;
|
10512
|
+
totalComponents?: number;
|
10513
|
+
};
|
10514
|
+
childIdsBySlot?: Record<string, string[]>;
|
10335
10515
|
isLocalized?: boolean;
|
10336
10516
|
isReadOnly?: boolean | undefined;
|
10337
10517
|
};
|
@@ -10691,6 +10871,105 @@ declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ c
|
|
10691
10871
|
onErrors?: (errors: EnhancerError[]) => void;
|
10692
10872
|
}): Promise<void>;
|
10693
10873
|
|
10874
|
+
/** @deprecated use walkNodeTree */
|
10875
|
+
type ComponentLocationReference = {
|
10876
|
+
component: ComponentInstance;
|
10877
|
+
parentSlot?: string;
|
10878
|
+
parentSlotIndex?: number;
|
10879
|
+
};
|
10880
|
+
/** @deprecated use walkNodeTree and check for type = slot */
|
10881
|
+
type WalkComponentTreeActions<TContext> = {
|
10882
|
+
/** Replaces the component being visited with a new object */
|
10883
|
+
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
10884
|
+
/** Removes the component being visited from the composition */
|
10885
|
+
removeComponent: () => void;
|
10886
|
+
/** Inserts a new component immediately after the current component in its parent slot */
|
10887
|
+
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
10888
|
+
/** Aborts visitation of components that are in child slots of the current component */
|
10889
|
+
stopProcessingDescendants: () => void;
|
10890
|
+
/**
|
10891
|
+
* Set a new traversal context for descendants of this node.
|
10892
|
+
* If this is not called, `context` will automatically pass through.
|
10893
|
+
*/
|
10894
|
+
setDescendantsContext: (context: TContext) => void;
|
10895
|
+
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
10896
|
+
};
|
10897
|
+
/**
|
10898
|
+
* Walks a composition's component tree, visiting each component instance depth-first, in order.
|
10899
|
+
* @deprecated use walkNodeTree
|
10900
|
+
*/
|
10901
|
+
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
10902
|
+
/** Traversal context for this node */
|
10903
|
+
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
10904
|
+
|
10905
|
+
/** Ancestor location that is in a slot on a component */
|
10906
|
+
type ComponentLocationReferenceV2 = {
|
10907
|
+
type: 'slot';
|
10908
|
+
node: ComponentInstance;
|
10909
|
+
parentSlot: string;
|
10910
|
+
parentSlotIndex: number;
|
10911
|
+
};
|
10912
|
+
/** Ancestor location that is in a block on a parameter or field */
|
10913
|
+
type BlockLocationReference = {
|
10914
|
+
type: 'block';
|
10915
|
+
node: EntryData;
|
10916
|
+
fieldName: string;
|
10917
|
+
blockIndex: number;
|
10918
|
+
};
|
10919
|
+
/** Ancestor location that is the root of a composition or entry */
|
10920
|
+
type RootLocationReference = {
|
10921
|
+
type: 'root';
|
10922
|
+
node: ComponentInstance;
|
10923
|
+
};
|
10924
|
+
type NodeLocationReference = ComponentLocationReferenceV2 | BlockLocationReference | RootLocationReference;
|
10925
|
+
type WalkNodeTreeActions<TContext, TNodeType> = {
|
10926
|
+
/** Replaces the node being visited with a new object */
|
10927
|
+
replace: (replacement: TNodeType) => void;
|
10928
|
+
/** Removes the node being visited from the composition */
|
10929
|
+
remove: () => void;
|
10930
|
+
/** Inserts a new node immediately after the current node in its parent slot */
|
10931
|
+
insertAfter: (components: TNodeType | TNodeType[]) => void;
|
10932
|
+
/** Aborts visitation of nodes that are descendants of the current node */
|
10933
|
+
stopProcessingDescendants: () => void;
|
10934
|
+
/**
|
10935
|
+
* Set a new traversal context for descendants of this node.
|
10936
|
+
* If this is not called, `context` will automatically pass through.
|
10937
|
+
*/
|
10938
|
+
setDescendantsContext: (context: TContext) => void;
|
10939
|
+
/** Sets a traversal context for a specific child (and any descendants) of this node. */
|
10940
|
+
setChildContext: (child: TNodeType, context: TContext) => void;
|
10941
|
+
};
|
10942
|
+
type NodeTypes = 'entry' | 'component';
|
10943
|
+
type TreeNodeInfo<TType extends NodeTypes, TContext, TNodeType> = {
|
10944
|
+
/** Type of node being visited */
|
10945
|
+
type: TType;
|
10946
|
+
/** The node being visited */
|
10947
|
+
node: TNodeType;
|
10948
|
+
/** The current node and its ancestors. The current node is [0], the parent [1], etc */
|
10949
|
+
ancestorsAndSelf: Array<NodeLocationReference>;
|
10950
|
+
/** Actions you can take on this node or the traversal of additional nodes */
|
10951
|
+
actions: WalkNodeTreeActions<TContext, TNodeType>;
|
10952
|
+
/** Traversal context for this node */
|
10953
|
+
context: TContext | undefined;
|
10954
|
+
};
|
10955
|
+
type TreeNodeInfoTypes<TContext> = TreeNodeInfo<'component', TContext, ComponentInstance> | TreeNodeInfo<'entry', TContext, EntryData>;
|
10956
|
+
type WalkNodeTreeOptions<TContext> = {
|
10957
|
+
/**
|
10958
|
+
* The initial value of the node-walk context, an arbitrary object that is passed to all visitor calls.
|
10959
|
+
* The visitor can use an action to change this value for descendants of the current node.
|
10960
|
+
*/
|
10961
|
+
initialContext?: TContext;
|
10962
|
+
};
|
10963
|
+
/** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
|
10964
|
+
declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
|
10965
|
+
/** Gets the typed value of a block parameter or block field */
|
10966
|
+
declare function getBlockValue(component: ComponentInstance | EntryData, parameterName: string): BlockValue;
|
10967
|
+
|
10968
|
+
/** Returns the JSON pointer of a component based on its location */
|
10969
|
+
declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference | ComponentLocationReference>): string;
|
10970
|
+
|
10971
|
+
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference | NodeLocationReference>): string;
|
10972
|
+
|
10694
10973
|
declare function extractLocales({ component }: {
|
10695
10974
|
component: ComponentInstance;
|
10696
10975
|
}): Record<string, ComponentInstance[]>;
|
@@ -10719,37 +10998,6 @@ declare class UniqueBatchEntries<TArgs, TResult> {
|
|
10719
10998
|
resolveRemaining(value: TResult): void;
|
10720
10999
|
}
|
10721
11000
|
|
10722
|
-
type ComponentLocationReference = {
|
10723
|
-
component: ComponentInstance;
|
10724
|
-
parentSlot?: string;
|
10725
|
-
parentSlotIndex?: number;
|
10726
|
-
};
|
10727
|
-
type WalkComponentTreeActions<TContext> = {
|
10728
|
-
/** Replaces the component being visited with a new object */
|
10729
|
-
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
10730
|
-
/** Removes the component being visited from the composition */
|
10731
|
-
removeComponent: () => void;
|
10732
|
-
/** Inserts a new component immediately after the current component in its parent slot */
|
10733
|
-
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
10734
|
-
/** Aborts visitation of components that are in child slots of the current component */
|
10735
|
-
stopProcessingDescendants: () => void;
|
10736
|
-
/**
|
10737
|
-
* Set a new traversal context for descendants of this node.
|
10738
|
-
* If this is not called, `context` will automatically pass through.
|
10739
|
-
*/
|
10740
|
-
setDescendantsContext: (context: TContext) => void;
|
10741
|
-
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
10742
|
-
};
|
10743
|
-
/** Walks a composition's component tree, visiting each component instance depth-first, in order. */
|
10744
|
-
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
10745
|
-
/** Traversal context for this node */
|
10746
|
-
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
10747
|
-
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
|
10748
|
-
/** Returns the JSON pointer of a component based on its location */
|
10749
|
-
declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocationReference>, { withSlots }?: {
|
10750
|
-
withSlots?: boolean | undefined;
|
10751
|
-
}): string;
|
10752
|
-
|
10753
11001
|
interface ContextualEditingWindowData {
|
10754
11002
|
framework?: ReadyMessage['framework'];
|
10755
11003
|
version?: ReadyMessage['version'];
|
@@ -10765,8 +11013,8 @@ type SelectComponentMessage = {
|
|
10765
11013
|
};
|
10766
11014
|
type SelectParameterMessage = {
|
10767
11015
|
type: 'select-parameter';
|
10768
|
-
parameterId
|
10769
|
-
componentId
|
11016
|
+
parameterId?: string;
|
11017
|
+
componentId?: string;
|
10770
11018
|
};
|
10771
11019
|
type ReadyMessage = {
|
10772
11020
|
type: 'ready';
|
@@ -10774,6 +11022,15 @@ type ReadyMessage = {
|
|
10774
11022
|
/** A non-semantic version of the contextual editing SDK. */
|
10775
11023
|
version?: number;
|
10776
11024
|
};
|
11025
|
+
type TriggerComponentActionMessage = {
|
11026
|
+
type: 'trigger-component-action';
|
11027
|
+
actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
|
11028
|
+
componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
|
11029
|
+
};
|
11030
|
+
type UpdateComponentReferencesMessage = {
|
11031
|
+
type: 'update-component-references';
|
11032
|
+
referencesById: Record<string, ContextualEditingComponentReference>;
|
11033
|
+
};
|
10777
11034
|
type UpdateCompositionMessage = {
|
10778
11035
|
type: 'update-composition';
|
10779
11036
|
composition: RootComponentInstance;
|
@@ -10797,6 +11054,11 @@ type MoveComponentMessage = {
|
|
10797
11054
|
index: number;
|
10798
11055
|
direction: 'up' | 'down';
|
10799
11056
|
};
|
11057
|
+
type OpenParameterEditorMessage = {
|
11058
|
+
type: 'open-parameter-editor';
|
11059
|
+
componentId: string;
|
11060
|
+
parameterId: string;
|
11061
|
+
};
|
10800
11062
|
type UpdateComponentParameterMessage = {
|
10801
11063
|
type: 'update-component-parameter';
|
10802
11064
|
componentId: string;
|
@@ -10816,10 +11078,25 @@ type UpdatePreviewSettingsMessage = {
|
|
10816
11078
|
type: 'update-preview-settings';
|
10817
11079
|
settings: PreviewPanelSettings;
|
10818
11080
|
};
|
11081
|
+
type UpdateFeatureFlagsMessage = {
|
11082
|
+
type: 'update-feature-flags';
|
11083
|
+
featureFlags: Record<string, boolean>;
|
11084
|
+
};
|
10819
11085
|
type UpdateContextualEditingStateInternalMessage = {
|
10820
11086
|
type: 'update-contextual-editing-state-internal';
|
10821
11087
|
state: {
|
10822
|
-
selectedComponentReference?:
|
11088
|
+
selectedComponentReference?: {
|
11089
|
+
id: string;
|
11090
|
+
slotName?: string;
|
11091
|
+
componentIndex?: number;
|
11092
|
+
totalComponents?: number;
|
11093
|
+
componentName?: string;
|
11094
|
+
componentTitle?: string;
|
11095
|
+
parentId?: string;
|
11096
|
+
parentType?: string;
|
11097
|
+
isLocalized?: boolean;
|
11098
|
+
isReadOnly?: boolean | undefined;
|
11099
|
+
};
|
10823
11100
|
};
|
10824
11101
|
};
|
10825
11102
|
type ReportRenderedCompositionsMessage = {
|
@@ -10830,9 +11107,10 @@ type ReportRenderedCompositionsMessage = {
|
|
10830
11107
|
type EditorStateUpdatedMessage = {
|
10831
11108
|
type: 'editor-state-updated';
|
10832
11109
|
};
|
10833
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
|
11110
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | TriggerComponentActionMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | UpdateFeatureFlagsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | UpdateComponentReferencesMessage | OpenParameterEditorMessage | EditorStateUpdatedMessage;
|
10834
11111
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
10835
11112
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
11113
|
+
declare const isComponentActionMessage: (message: ChannelMessage) => message is TriggerComponentActionMessage;
|
10836
11114
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
10837
11115
|
declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
|
10838
11116
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
@@ -10841,16 +11119,21 @@ declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => me
|
|
10841
11119
|
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
10842
11120
|
declare const isTriggerCompositionActionMessage: (message: ChannelMessage) => message is TriggerCompositionActionMessage;
|
10843
11121
|
declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
|
11122
|
+
declare const isUpdateFeatureFlagsMessage: (message: ChannelMessage) => message is UpdateFeatureFlagsMessage;
|
10844
11123
|
declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
|
10845
11124
|
declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
|
10846
11125
|
declare const isSelectParameterMessage: (message: ChannelMessage) => message is SelectParameterMessage;
|
11126
|
+
declare const isOpenParameterEditorMessage: (message: ChannelMessage) => message is OpenParameterEditorMessage;
|
11127
|
+
declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => message is UpdateComponentReferencesMessage;
|
10847
11128
|
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
10848
11129
|
type Channel = {
|
10849
11130
|
on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
|
10850
11131
|
ready: () => void;
|
10851
11132
|
destroy: () => void;
|
11133
|
+
triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
|
10852
11134
|
selectComponent: (id: string) => void;
|
10853
11135
|
selectParameter: (options: Omit<SelectParameterMessage, 'type'>) => void;
|
11136
|
+
openParameterEditor: (options: Omit<OpenParameterEditorMessage, 'type'>) => void;
|
10854
11137
|
updateComposition: (composition: RootComponentInstance, secret?: string) => void;
|
10855
11138
|
updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
|
10856
11139
|
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
@@ -10859,8 +11142,10 @@ type Channel = {
|
|
10859
11142
|
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
10860
11143
|
triggerCompositionAction: (options: Omit<TriggerCompositionActionMessage, 'type'>) => void;
|
10861
11144
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
11145
|
+
updateFeatureFlags: (options: Omit<UpdateFeatureFlagsMessage, 'type'>) => void;
|
10862
11146
|
updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
|
10863
11147
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
11148
|
+
updateComponentReferences: (options: Omit<UpdateComponentReferencesMessage, 'type'>) => void;
|
10864
11149
|
editorStateUpdated: () => void;
|
10865
11150
|
};
|
10866
11151
|
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
@@ -10925,74 +11210,6 @@ declare class RouteClient extends ApiClient<RouteClientOptions> {
|
|
10925
11210
|
getRoute(options?: Omit<RouteGetParameters, 'projectId'>): Promise<ResolvedRouteGetResponse>;
|
10926
11211
|
}
|
10927
11212
|
|
10928
|
-
/** Public ID of Canvas personalization component type */
|
10929
|
-
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
10930
|
-
/** Public ID of Canvas A/B test component type */
|
10931
|
-
declare const CANVAS_TEST_TYPE = "$test";
|
10932
|
-
/** Public ID of Canvas localization component type */
|
10933
|
-
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
10934
|
-
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
10935
|
-
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
10936
|
-
/** Public ID of the locale parameter on Canvas components */
|
10937
|
-
declare const CANVAS_LOCALE_TAG_PARAM = "locale";
|
10938
|
-
/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
|
10939
|
-
declare const CANVAS_PERSONALIZE_SLOT = "pz";
|
10940
|
-
/** Name of the slot on CANVAS_TEST_TYPE */
|
10941
|
-
declare const CANVAS_TEST_SLOT = "test";
|
10942
|
-
/** Name of the slot on CANVAS_TEST_TYPE */
|
10943
|
-
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
10944
|
-
/** Constant for a draft composition state. Subject to change. */
|
10945
|
-
declare const CANVAS_DRAFT_STATE = 0;
|
10946
|
-
/** Constant for a published composition state. Subject to change. */
|
10947
|
-
declare const CANVAS_PUBLISHED_STATE = 64;
|
10948
|
-
/** Constant for editor composition state. */
|
10949
|
-
declare const CANVAS_EDITOR_STATE = 63;
|
10950
|
-
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
10951
|
-
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
10952
|
-
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
10953
|
-
declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
10954
|
-
/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
|
10955
|
-
declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
10956
|
-
/** The name of the query string used to detect if we are in contextual editing mode */
|
10957
|
-
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
10958
|
-
/** The name of the query string used to indicate that we want to use the playground for preview */
|
10959
|
-
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
10960
|
-
/** The name of the query string used to get the config from the preview url */
|
10961
|
-
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
10962
|
-
/** The value of "data-role" in the component start `<script>` tag */
|
10963
|
-
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
10964
|
-
/** The value of "data-role" in the component end `<script>` tag */
|
10965
|
-
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
10966
|
-
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
10967
|
-
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
10968
|
-
/**
|
10969
|
-
* The name of the attribute added to the elements rendered by Uniform.
|
10970
|
-
* Use to allow interacting with them by default in the preview panel
|
10971
|
-
*/
|
10972
|
-
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
10973
|
-
/** The ID we give to placeholder components */
|
10974
|
-
declare const PLACEHOLDER_ID = "placeholder";
|
10975
|
-
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
10976
|
-
declare const EMPTY_COMPOSITION: {
|
10977
|
-
_id: string;
|
10978
|
-
_name: string;
|
10979
|
-
type: string;
|
10980
|
-
};
|
10981
|
-
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
10982
|
-
declare const EDGE_MIN_CACHE_TTL = 15;
|
10983
|
-
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
10984
|
-
declare const EDGE_MAX_CACHE_TTL = 600;
|
10985
|
-
/** Default value for Edgehancers Cache TTL (in seconds) */
|
10986
|
-
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
10987
|
-
/** A value that indicates that Edgehancers caching is disabled */
|
10988
|
-
declare const EDGE_CACHE_DISABLED = -1;
|
10989
|
-
/** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
|
10990
|
-
declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
|
10991
|
-
/** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
|
10992
|
-
declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
|
10993
|
-
/** Default value for Edgehancers Long Term Cache TTL (in hours) */
|
10994
|
-
declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
10995
|
-
|
10996
11213
|
/**
|
10997
11214
|
* Creates an enhancer based on an API route.
|
10998
11215
|
* This is mainly used to create an enhancer for Contextual Editing, which can be passed to the `contextualEditingEnhancer` prop of `<UniformComposition />`.
|
@@ -11128,6 +11345,11 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
11128
11345
|
* Removes things like author, stats, etc.
|
11129
11346
|
*/
|
11130
11347
|
declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
|
11348
|
+
/**
|
11349
|
+
* Gets the object holding the properties (fields or parameters) of an entry or component instance
|
11350
|
+
* If no properties are defined, returns undefined.
|
11351
|
+
*/
|
11352
|
+
declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
|
11131
11353
|
|
11132
11354
|
declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
|
11133
11355
|
declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
|
@@ -11184,7 +11406,7 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
|
|
11184
11406
|
declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
|
11185
11407
|
|
11186
11408
|
declare const isComponentPlaceholderId: (id: string | undefined) => boolean | undefined;
|
11187
|
-
declare const generateComponentPlaceholderId: (randomId: string) => string;
|
11409
|
+
declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
|
11188
11410
|
|
11189
11411
|
type BindVariablesResult<TValue> = {
|
11190
11412
|
/** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
|
@@ -11245,4 +11467,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
11245
11467
|
|
11246
11468
|
declare const CanvasClientError: typeof ApiClientError;
|
11247
11469
|
|
11248
|
-
export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_EDITOR_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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, 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, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, Entry, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isAllowedReferrer, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
|
11470
|
+
export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, BlockLocationReference, BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentLocationReferenceV2, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterBlock, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, 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, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, Entry, EntryData, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NodeLocationReference, NonProjectMapLinkParamValue, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RootLocationReference, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TreeNodeInfoTypes, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdateFeatureFlagsMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, WalkNodeTreeActions, WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };
|