@uniformdev/canvas 19.58.2-alpha.0 → 19.59.0
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 +328 -111
- package/dist/index.d.ts +328 -111
- package/dist/index.esm.js +514 -162
- package/dist/index.js +523 -163
- package/dist/index.mjs +514 -162
- package/package.json +3 -3
package/dist/index.d.mts
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,76 @@ 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
|
+
/** The name of the query string used to detect if we are in contextual editing mode */
|
1259
|
+
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
1260
|
+
/** The name of the query string used to indicate that we want to use the playground for preview */
|
1261
|
+
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
1262
|
+
/** The name of the query string used to get the config from the preview url */
|
1263
|
+
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
1264
|
+
/** The value of "data-role" in the component start `<script>` tag */
|
1265
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
1266
|
+
/** The value of "data-role" in the component end `<script>` tag */
|
1267
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
1268
|
+
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
1269
|
+
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
1270
|
+
/**
|
1271
|
+
* The name of the attribute added to the elements rendered by Uniform.
|
1272
|
+
* Use to allow interacting with them by default in the preview panel
|
1273
|
+
*/
|
1274
|
+
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
1275
|
+
/** The ID we give to placeholder components */
|
1276
|
+
declare const PLACEHOLDER_ID = "placeholder";
|
1277
|
+
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
1278
|
+
declare const EMPTY_COMPOSITION: {
|
1279
|
+
_id: string;
|
1280
|
+
_name: string;
|
1281
|
+
type: string;
|
1282
|
+
};
|
1283
|
+
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
1284
|
+
declare const EDGE_MIN_CACHE_TTL = 15;
|
1285
|
+
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
1286
|
+
declare const EDGE_MAX_CACHE_TTL = 600;
|
1287
|
+
/** Default value for Edgehancers Cache TTL (in seconds) */
|
1288
|
+
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
1289
|
+
/** A value that indicates that Edgehancers caching is disabled */
|
1290
|
+
declare const EDGE_CACHE_DISABLED = -1;
|
1291
|
+
/** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
|
1292
|
+
declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
|
1293
|
+
/** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
|
1294
|
+
declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
|
1295
|
+
/** Default value for Edgehancers Long Term Cache TTL (in hours) */
|
1296
|
+
declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
1297
|
+
|
1216
1298
|
/**
|
1217
1299
|
* This file was auto-generated by openapi-typescript.
|
1218
1300
|
* Do not make direct changes to the file.
|
@@ -1508,6 +1590,12 @@ interface external$b {
|
|
1508
1590
|
/** @description Last modified date string for this content type (ignored for writes) */
|
1509
1591
|
updated?: string;
|
1510
1592
|
slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1593
|
+
/**
|
1594
|
+
* @description The definition type of this content type (block or content type)
|
1595
|
+
* @default contentType
|
1596
|
+
* @enum {string}
|
1597
|
+
*/
|
1598
|
+
type?: "contentType" | "block";
|
1511
1599
|
};
|
1512
1600
|
/** @description Defines an editable parameter on a component. */
|
1513
1601
|
ComponentParameter: {
|
@@ -1878,6 +1966,8 @@ interface paths$9 {
|
|
1878
1966
|
offset?: number;
|
1879
1967
|
/** Max number of records to return */
|
1880
1968
|
limit?: number;
|
1969
|
+
/** Limit the types of content type to return. If not specified, both block types and content types are returned. */
|
1970
|
+
type?: "block" | "contentType";
|
1881
1971
|
};
|
1882
1972
|
};
|
1883
1973
|
responses: {
|
@@ -2179,6 +2269,12 @@ interface external$a {
|
|
2179
2269
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2180
2270
|
updated?: string;
|
2181
2271
|
slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2272
|
+
/**
|
2273
|
+
* @description The definition type of this content type (block or content type)
|
2274
|
+
* @default contentType
|
2275
|
+
* @enum {string}
|
2276
|
+
*/
|
2277
|
+
type?: "contentType" | "block";
|
2182
2278
|
};
|
2183
2279
|
/** @description Defines an editable parameter on a component. */
|
2184
2280
|
ComponentParameter: {
|
@@ -2565,6 +2661,11 @@ interface paths$8 {
|
|
2565
2661
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2566
2662
|
*/
|
2567
2663
|
withUIStatus?: components$4["parameters"]["withUIStatus"];
|
2664
|
+
/**
|
2665
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
2666
|
+
* If false, the `_id` will not be present in the API response.
|
2667
|
+
*/
|
2668
|
+
withComponentIDs?: components$4["parameters"]["withComponentIDs"];
|
2568
2669
|
};
|
2569
2670
|
};
|
2570
2671
|
responses: {
|
@@ -2751,6 +2852,11 @@ interface components$4 {
|
|
2751
2852
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2752
2853
|
*/
|
2753
2854
|
withUIStatus: boolean;
|
2855
|
+
/**
|
2856
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
2857
|
+
* If false, the `_id` will not be present in the API response.
|
2858
|
+
*/
|
2859
|
+
withComponentIDs: boolean;
|
2754
2860
|
/**
|
2755
2861
|
* @deprecated
|
2756
2862
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -2992,6 +3098,12 @@ interface external$9 {
|
|
2992
3098
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2993
3099
|
updated?: string;
|
2994
3100
|
slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3101
|
+
/**
|
3102
|
+
* @description The definition type of this content type (block or content type)
|
3103
|
+
* @default contentType
|
3104
|
+
* @enum {string}
|
3105
|
+
*/
|
3106
|
+
type?: "contentType" | "block";
|
2995
3107
|
};
|
2996
3108
|
/** @description Defines an editable parameter on a component. */
|
2997
3109
|
ComponentParameter: {
|
@@ -3341,6 +3453,7 @@ type DeleteContentTypeOptions = paths$9['/api/v1/content-types']['delete']['requ
|
|
3341
3453
|
type PutContentTypeBody = paths$9['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
3342
3454
|
type GetContentTypesResponse = paths$9['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
3343
3455
|
type Entry = components$4['schemas']['EntryApiResponse'];
|
3456
|
+
type EntryData = Entry['entry'];
|
3344
3457
|
type GetEntriesOptions = paths$8['/api/v1/entries']['get']['parameters']['query'];
|
3345
3458
|
type GetEntriesResponse = paths$8['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
3346
3459
|
type DeleteEntryOptions = paths$8['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
@@ -3649,6 +3762,12 @@ interface external$8 {
|
|
3649
3762
|
/** @description Last modified date string for this content type (ignored for writes) */
|
3650
3763
|
updated?: string;
|
3651
3764
|
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3765
|
+
/**
|
3766
|
+
* @description The definition type of this content type (block or content type)
|
3767
|
+
* @default contentType
|
3768
|
+
* @enum {string}
|
3769
|
+
*/
|
3770
|
+
type?: "contentType" | "block";
|
3652
3771
|
};
|
3653
3772
|
/** @description Defines an editable parameter on a component. */
|
3654
3773
|
ComponentParameter: {
|
@@ -4250,6 +4369,12 @@ interface external$7 {
|
|
4250
4369
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4251
4370
|
updated?: string;
|
4252
4371
|
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
4372
|
+
/**
|
4373
|
+
* @description The definition type of this content type (block or content type)
|
4374
|
+
* @default contentType
|
4375
|
+
* @enum {string}
|
4376
|
+
*/
|
4377
|
+
type?: "contentType" | "block";
|
4253
4378
|
};
|
4254
4379
|
/** @description Defines an editable parameter on a component. */
|
4255
4380
|
ComponentParameter: {
|
@@ -4886,6 +5011,12 @@ interface external$6 {
|
|
4886
5011
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4887
5012
|
updated?: string;
|
4888
5013
|
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
5014
|
+
/**
|
5015
|
+
* @description The definition type of this content type (block or content type)
|
5016
|
+
* @default contentType
|
5017
|
+
* @enum {string}
|
5018
|
+
*/
|
5019
|
+
type?: "contentType" | "block";
|
4889
5020
|
};
|
4890
5021
|
/** @description Defines an editable parameter on a component. */
|
4891
5022
|
ComponentParameter: {
|
@@ -5951,6 +6082,12 @@ interface external$5 {
|
|
5951
6082
|
/** @description Last modified date string for this content type (ignored for writes) */
|
5952
6083
|
updated?: string;
|
5953
6084
|
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
6085
|
+
/**
|
6086
|
+
* @description The definition type of this content type (block or content type)
|
6087
|
+
* @default contentType
|
6088
|
+
* @enum {string}
|
6089
|
+
*/
|
6090
|
+
type?: "contentType" | "block";
|
5954
6091
|
};
|
5955
6092
|
/** @description Defines an editable parameter on a component. */
|
5956
6093
|
ComponentParameter: {
|
@@ -6793,6 +6930,12 @@ interface external$3 {
|
|
6793
6930
|
/** @description Last modified date string for this content type (ignored for writes) */
|
6794
6931
|
updated?: string;
|
6795
6932
|
slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
6933
|
+
/**
|
6934
|
+
* @description The definition type of this content type (block or content type)
|
6935
|
+
* @default contentType
|
6936
|
+
* @enum {string}
|
6937
|
+
*/
|
6938
|
+
type?: "contentType" | "block";
|
6796
6939
|
};
|
6797
6940
|
/** @description Defines an editable parameter on a component. */
|
6798
6941
|
ComponentParameter: {
|
@@ -7645,6 +7788,11 @@ interface external$3 {
|
|
7645
7788
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7646
7789
|
*/
|
7647
7790
|
withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
7791
|
+
/**
|
7792
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
7793
|
+
* If false, the `_id` will not be present in the API response.
|
7794
|
+
*/
|
7795
|
+
withComponentIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
7648
7796
|
};
|
7649
7797
|
};
|
7650
7798
|
responses: {
|
@@ -7831,6 +7979,11 @@ interface external$3 {
|
|
7831
7979
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7832
7980
|
*/
|
7833
7981
|
withUIStatus: boolean;
|
7982
|
+
/**
|
7983
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
7984
|
+
* If false, the `_id` will not be present in the API response.
|
7985
|
+
*/
|
7986
|
+
withComponentIDs: boolean;
|
7834
7987
|
/**
|
7835
7988
|
* @deprecated
|
7836
7989
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -8561,6 +8714,12 @@ interface external$2 {
|
|
8561
8714
|
/** @description Last modified date string for this content type (ignored for writes) */
|
8562
8715
|
updated?: string;
|
8563
8716
|
slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
8717
|
+
/**
|
8718
|
+
* @description The definition type of this content type (block or content type)
|
8719
|
+
* @default contentType
|
8720
|
+
* @enum {string}
|
8721
|
+
*/
|
8722
|
+
type?: "contentType" | "block";
|
8564
8723
|
};
|
8565
8724
|
/** @description Defines an editable parameter on a component. */
|
8566
8725
|
ComponentParameter: {
|
@@ -9603,6 +9762,12 @@ type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentPara
|
|
9603
9762
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
9604
9763
|
value: TValue;
|
9605
9764
|
};
|
9765
|
+
/** Parameter which stores blocks of entry types */
|
9766
|
+
type ComponentParameterBlock = Omit<ComponentParameter<BlockValue>, 'type'> & {
|
9767
|
+
type: typeof CANVAS_BLOCK_PARAM_TYPE;
|
9768
|
+
};
|
9769
|
+
/** Value type of a block parameter or block field */
|
9770
|
+
type BlockValue = EntryData[];
|
9606
9771
|
/** The type of the parameters in contextual editing mode. */
|
9607
9772
|
type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
|
9608
9773
|
/** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
|
@@ -10323,15 +10488,25 @@ type PreviewPanelSettings = {
|
|
10323
10488
|
isInteractive: boolean;
|
10324
10489
|
};
|
10325
10490
|
type ContextualEditingComponentReference = {
|
10326
|
-
elements: HTMLElement[];
|
10327
10491
|
id: string;
|
10328
|
-
|
10329
|
-
|
10330
|
-
|
10331
|
-
|
10332
|
-
|
10492
|
+
icon?: string;
|
10493
|
+
type?: string;
|
10494
|
+
title?: string;
|
10495
|
+
name?: string;
|
10496
|
+
parameters?: Record<string, {
|
10497
|
+
id: string;
|
10498
|
+
type: string;
|
10499
|
+
name?: string;
|
10500
|
+
isReadOnly?: boolean;
|
10501
|
+
}>;
|
10333
10502
|
parentId?: string;
|
10334
10503
|
parentType?: string;
|
10504
|
+
parentSlot?: {
|
10505
|
+
id?: string;
|
10506
|
+
componentIndex?: number;
|
10507
|
+
totalComponents?: number;
|
10508
|
+
};
|
10509
|
+
childIdsBySlot?: Record<string, string[]>;
|
10335
10510
|
isLocalized?: boolean;
|
10336
10511
|
isReadOnly?: boolean | undefined;
|
10337
10512
|
};
|
@@ -10691,6 +10866,105 @@ declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ c
|
|
10691
10866
|
onErrors?: (errors: EnhancerError[]) => void;
|
10692
10867
|
}): Promise<void>;
|
10693
10868
|
|
10869
|
+
/** @deprecated use walkNodeTree */
|
10870
|
+
type ComponentLocationReference = {
|
10871
|
+
component: ComponentInstance;
|
10872
|
+
parentSlot?: string;
|
10873
|
+
parentSlotIndex?: number;
|
10874
|
+
};
|
10875
|
+
/** @deprecated use walkNodeTree and check for type = slot */
|
10876
|
+
type WalkComponentTreeActions<TContext> = {
|
10877
|
+
/** Replaces the component being visited with a new object */
|
10878
|
+
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
10879
|
+
/** Removes the component being visited from the composition */
|
10880
|
+
removeComponent: () => void;
|
10881
|
+
/** Inserts a new component immediately after the current component in its parent slot */
|
10882
|
+
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
10883
|
+
/** Aborts visitation of components that are in child slots of the current component */
|
10884
|
+
stopProcessingDescendants: () => void;
|
10885
|
+
/**
|
10886
|
+
* Set a new traversal context for descendants of this node.
|
10887
|
+
* If this is not called, `context` will automatically pass through.
|
10888
|
+
*/
|
10889
|
+
setDescendantsContext: (context: TContext) => void;
|
10890
|
+
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
10891
|
+
};
|
10892
|
+
/**
|
10893
|
+
* Walks a composition's component tree, visiting each component instance depth-first, in order.
|
10894
|
+
* @deprecated use walkNodeTree
|
10895
|
+
*/
|
10896
|
+
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
10897
|
+
/** Traversal context for this node */
|
10898
|
+
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
10899
|
+
|
10900
|
+
/** Ancestor location that is in a slot on a component */
|
10901
|
+
type ComponentLocationReferenceV2 = {
|
10902
|
+
type: 'slot';
|
10903
|
+
node: ComponentInstance;
|
10904
|
+
parentSlot: string;
|
10905
|
+
parentSlotIndex: number;
|
10906
|
+
};
|
10907
|
+
/** Ancestor location that is in a block on a parameter or field */
|
10908
|
+
type BlockLocationReference = {
|
10909
|
+
type: 'block';
|
10910
|
+
node: EntryData;
|
10911
|
+
fieldName: string;
|
10912
|
+
blockIndex: number;
|
10913
|
+
};
|
10914
|
+
/** Ancestor location that is the root of a composition or entry */
|
10915
|
+
type RootLocationReference = {
|
10916
|
+
type: 'root';
|
10917
|
+
node: ComponentInstance;
|
10918
|
+
};
|
10919
|
+
type NodeLocationReference = ComponentLocationReferenceV2 | BlockLocationReference | RootLocationReference;
|
10920
|
+
type WalkNodeTreeActions<TContext, TNodeType> = {
|
10921
|
+
/** Replaces the node being visited with a new object */
|
10922
|
+
replace: (replacement: TNodeType) => void;
|
10923
|
+
/** Removes the node being visited from the composition */
|
10924
|
+
remove: () => void;
|
10925
|
+
/** Inserts a new node immediately after the current node in its parent slot */
|
10926
|
+
insertAfter: (components: TNodeType | TNodeType[]) => void;
|
10927
|
+
/** Aborts visitation of nodes that are descendants of the current node */
|
10928
|
+
stopProcessingDescendants: () => void;
|
10929
|
+
/**
|
10930
|
+
* Set a new traversal context for descendants of this node.
|
10931
|
+
* If this is not called, `context` will automatically pass through.
|
10932
|
+
*/
|
10933
|
+
setDescendantsContext: (context: TContext) => void;
|
10934
|
+
/** Sets a traversal context for a specific child (and any descendants) of this node. */
|
10935
|
+
setChildContext: (child: TNodeType, context: TContext) => void;
|
10936
|
+
};
|
10937
|
+
type NodeTypes = 'entry' | 'component';
|
10938
|
+
type TreeNodeInfo<TType extends NodeTypes, TContext, TNodeType> = {
|
10939
|
+
/** Type of node being visited */
|
10940
|
+
type: TType;
|
10941
|
+
/** The node being visited */
|
10942
|
+
node: TNodeType;
|
10943
|
+
/** The current node and its ancestors. The current node is [0], the parent [1], etc */
|
10944
|
+
ancestorsAndSelf: Array<NodeLocationReference>;
|
10945
|
+
/** Actions you can take on this node or the traversal of additional nodes */
|
10946
|
+
actions: WalkNodeTreeActions<TContext, TNodeType>;
|
10947
|
+
/** Traversal context for this node */
|
10948
|
+
context: TContext | undefined;
|
10949
|
+
};
|
10950
|
+
type TreeNodeInfoTypes<TContext> = TreeNodeInfo<'component', TContext, ComponentInstance> | TreeNodeInfo<'entry', TContext, EntryData>;
|
10951
|
+
type WalkNodeTreeOptions<TContext> = {
|
10952
|
+
/**
|
10953
|
+
* The initial value of the node-walk context, an arbitrary object that is passed to all visitor calls.
|
10954
|
+
* The visitor can use an action to change this value for descendants of the current node.
|
10955
|
+
*/
|
10956
|
+
initialContext?: TContext;
|
10957
|
+
};
|
10958
|
+
/** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
|
10959
|
+
declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
|
10960
|
+
/** Gets the typed value of a block parameter or block field */
|
10961
|
+
declare function getBlockValue(component: ComponentInstance | EntryData, parameterName: string): BlockValue;
|
10962
|
+
|
10963
|
+
/** Returns the JSON pointer of a component based on its location */
|
10964
|
+
declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference | ComponentLocationReference>): string;
|
10965
|
+
|
10966
|
+
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference | NodeLocationReference>): string;
|
10967
|
+
|
10694
10968
|
declare function extractLocales({ component }: {
|
10695
10969
|
component: ComponentInstance;
|
10696
10970
|
}): Record<string, ComponentInstance[]>;
|
@@ -10719,37 +10993,6 @@ declare class UniqueBatchEntries<TArgs, TResult> {
|
|
10719
10993
|
resolveRemaining(value: TResult): void;
|
10720
10994
|
}
|
10721
10995
|
|
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
10996
|
interface ContextualEditingWindowData {
|
10754
10997
|
framework?: ReadyMessage['framework'];
|
10755
10998
|
version?: ReadyMessage['version'];
|
@@ -10765,8 +11008,8 @@ type SelectComponentMessage = {
|
|
10765
11008
|
};
|
10766
11009
|
type SelectParameterMessage = {
|
10767
11010
|
type: 'select-parameter';
|
10768
|
-
parameterId
|
10769
|
-
componentId
|
11011
|
+
parameterId?: string;
|
11012
|
+
componentId?: string;
|
10770
11013
|
};
|
10771
11014
|
type ReadyMessage = {
|
10772
11015
|
type: 'ready';
|
@@ -10774,6 +11017,15 @@ type ReadyMessage = {
|
|
10774
11017
|
/** A non-semantic version of the contextual editing SDK. */
|
10775
11018
|
version?: number;
|
10776
11019
|
};
|
11020
|
+
type TriggerComponentActionMessage = {
|
11021
|
+
type: 'trigger-component-action';
|
11022
|
+
actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
|
11023
|
+
componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
|
11024
|
+
};
|
11025
|
+
type UpdateComponentReferencesMessage = {
|
11026
|
+
type: 'update-component-references';
|
11027
|
+
referencesById: Record<string, ContextualEditingComponentReference>;
|
11028
|
+
};
|
10777
11029
|
type UpdateCompositionMessage = {
|
10778
11030
|
type: 'update-composition';
|
10779
11031
|
composition: RootComponentInstance;
|
@@ -10797,6 +11049,11 @@ type MoveComponentMessage = {
|
|
10797
11049
|
index: number;
|
10798
11050
|
direction: 'up' | 'down';
|
10799
11051
|
};
|
11052
|
+
type OpenParameterEditorMessage = {
|
11053
|
+
type: 'open-parameter-editor';
|
11054
|
+
componentId: string;
|
11055
|
+
parameterId: string;
|
11056
|
+
};
|
10800
11057
|
type UpdateComponentParameterMessage = {
|
10801
11058
|
type: 'update-component-parameter';
|
10802
11059
|
componentId: string;
|
@@ -10816,10 +11073,25 @@ type UpdatePreviewSettingsMessage = {
|
|
10816
11073
|
type: 'update-preview-settings';
|
10817
11074
|
settings: PreviewPanelSettings;
|
10818
11075
|
};
|
11076
|
+
type UpdateFeatureFlagsMessage = {
|
11077
|
+
type: 'update-feature-flags';
|
11078
|
+
featureFlags: Record<string, boolean>;
|
11079
|
+
};
|
10819
11080
|
type UpdateContextualEditingStateInternalMessage = {
|
10820
11081
|
type: 'update-contextual-editing-state-internal';
|
10821
11082
|
state: {
|
10822
|
-
selectedComponentReference?:
|
11083
|
+
selectedComponentReference?: {
|
11084
|
+
id: string;
|
11085
|
+
slotName?: string;
|
11086
|
+
componentIndex?: number;
|
11087
|
+
totalComponents?: number;
|
11088
|
+
componentName?: string;
|
11089
|
+
componentTitle?: string;
|
11090
|
+
parentId?: string;
|
11091
|
+
parentType?: string;
|
11092
|
+
isLocalized?: boolean;
|
11093
|
+
isReadOnly?: boolean | undefined;
|
11094
|
+
};
|
10823
11095
|
};
|
10824
11096
|
};
|
10825
11097
|
type ReportRenderedCompositionsMessage = {
|
@@ -10830,9 +11102,10 @@ type ReportRenderedCompositionsMessage = {
|
|
10830
11102
|
type EditorStateUpdatedMessage = {
|
10831
11103
|
type: 'editor-state-updated';
|
10832
11104
|
};
|
10833
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
|
11105
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | TriggerComponentActionMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | UpdateFeatureFlagsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | UpdateComponentReferencesMessage | OpenParameterEditorMessage | EditorStateUpdatedMessage;
|
10834
11106
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
10835
11107
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
11108
|
+
declare const isComponentActionMessage: (message: ChannelMessage) => message is TriggerComponentActionMessage;
|
10836
11109
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
10837
11110
|
declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
|
10838
11111
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
@@ -10841,16 +11114,21 @@ declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => me
|
|
10841
11114
|
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
10842
11115
|
declare const isTriggerCompositionActionMessage: (message: ChannelMessage) => message is TriggerCompositionActionMessage;
|
10843
11116
|
declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
|
11117
|
+
declare const isUpdateFeatureFlagsMessage: (message: ChannelMessage) => message is UpdateFeatureFlagsMessage;
|
10844
11118
|
declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
|
10845
11119
|
declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
|
10846
11120
|
declare const isSelectParameterMessage: (message: ChannelMessage) => message is SelectParameterMessage;
|
11121
|
+
declare const isOpenParameterEditorMessage: (message: ChannelMessage) => message is OpenParameterEditorMessage;
|
11122
|
+
declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => message is UpdateComponentReferencesMessage;
|
10847
11123
|
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
10848
11124
|
type Channel = {
|
10849
11125
|
on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
|
10850
11126
|
ready: () => void;
|
10851
11127
|
destroy: () => void;
|
11128
|
+
triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
|
10852
11129
|
selectComponent: (id: string) => void;
|
10853
11130
|
selectParameter: (options: Omit<SelectParameterMessage, 'type'>) => void;
|
11131
|
+
openParameterEditor: (options: Omit<OpenParameterEditorMessage, 'type'>) => void;
|
10854
11132
|
updateComposition: (composition: RootComponentInstance, secret?: string) => void;
|
10855
11133
|
updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
|
10856
11134
|
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
@@ -10859,8 +11137,10 @@ type Channel = {
|
|
10859
11137
|
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
10860
11138
|
triggerCompositionAction: (options: Omit<TriggerCompositionActionMessage, 'type'>) => void;
|
10861
11139
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
11140
|
+
updateFeatureFlags: (options: Omit<UpdateFeatureFlagsMessage, 'type'>) => void;
|
10862
11141
|
updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
|
10863
11142
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
11143
|
+
updateComponentReferences: (options: Omit<UpdateComponentReferencesMessage, 'type'>) => void;
|
10864
11144
|
editorStateUpdated: () => void;
|
10865
11145
|
};
|
10866
11146
|
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
@@ -10925,74 +11205,6 @@ declare class RouteClient extends ApiClient<RouteClientOptions> {
|
|
10925
11205
|
getRoute(options?: Omit<RouteGetParameters, 'projectId'>): Promise<ResolvedRouteGetResponse>;
|
10926
11206
|
}
|
10927
11207
|
|
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
11208
|
/**
|
10997
11209
|
* Creates an enhancer based on an API route.
|
10998
11210
|
* This is mainly used to create an enhancer for Contextual Editing, which can be passed to the `contextualEditingEnhancer` prop of `<UniformComposition />`.
|
@@ -11128,6 +11340,11 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
11128
11340
|
* Removes things like author, stats, etc.
|
11129
11341
|
*/
|
11130
11342
|
declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
|
11343
|
+
/**
|
11344
|
+
* Gets the object holding the properties (fields or parameters) of an entry or component instance
|
11345
|
+
* If no properties are defined, returns undefined.
|
11346
|
+
*/
|
11347
|
+
declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
|
11131
11348
|
|
11132
11349
|
declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
|
11133
11350
|
declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
|
@@ -11184,7 +11401,7 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
|
|
11184
11401
|
declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
|
11185
11402
|
|
11186
11403
|
declare const isComponentPlaceholderId: (id: string | undefined) => boolean | undefined;
|
11187
|
-
declare const generateComponentPlaceholderId: (randomId: string) => string;
|
11404
|
+
declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
|
11188
11405
|
|
11189
11406
|
type BindVariablesResult<TValue> = {
|
11190
11407
|
/** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
|
@@ -11245,4 +11462,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
11245
11462
|
|
11246
11463
|
declare const CanvasClientError: typeof ApiClientError;
|
11247
11464
|
|
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 };
|
11465
|
+
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, 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 };
|