@uniformdev/canvas 19.49.1 → 19.49.4-alpha.67
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 +453 -184
- package/dist/index.d.ts +453 -184
- package/dist/index.esm.js +522 -153
- package/dist/index.js +533 -154
- package/dist/index.mjs +522 -153
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
@@ -170,10 +170,21 @@ interface components$5 {
|
|
170
170
|
entryName?: string | null;
|
171
171
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
172
172
|
fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
|
173
|
+
/**
|
174
|
+
* @description Description of the content type
|
175
|
+
* @default null
|
176
|
+
*/
|
177
|
+
description?: string;
|
178
|
+
/**
|
179
|
+
* @description Icon name for the content type (e.g. 'screen')
|
180
|
+
* @default file-document
|
181
|
+
*/
|
182
|
+
icon?: string;
|
173
183
|
/** @description Created date string for this content type (ignored for writes) */
|
174
184
|
created?: string;
|
175
185
|
/** @description Last modified date string for this content type (ignored for writes) */
|
176
186
|
updated?: string;
|
187
|
+
slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
|
177
188
|
};
|
178
189
|
/** @description Defines an editable parameter on a component. */
|
179
190
|
ComponentParameter: {
|
@@ -820,10 +831,21 @@ interface external$c {
|
|
820
831
|
entryName?: string | null;
|
821
832
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
822
833
|
fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
834
|
+
/**
|
835
|
+
* @description Description of the content type
|
836
|
+
* @default null
|
837
|
+
*/
|
838
|
+
description?: string;
|
839
|
+
/**
|
840
|
+
* @description Icon name for the content type (e.g. 'screen')
|
841
|
+
* @default file-document
|
842
|
+
*/
|
843
|
+
icon?: string;
|
823
844
|
/** @description Created date string for this content type (ignored for writes) */
|
824
845
|
created?: string;
|
825
846
|
/** @description Last modified date string for this content type (ignored for writes) */
|
826
847
|
updated?: string;
|
848
|
+
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
827
849
|
};
|
828
850
|
/** @description Defines an editable parameter on a component. */
|
829
851
|
ComponentParameter: {
|
@@ -1191,6 +1213,76 @@ type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPerm
|
|
1191
1213
|
/** Defines a component type that can live on a Composition */
|
1192
1214
|
type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
|
1193
1215
|
|
1216
|
+
/** Public ID of Canvas personalization component type */
|
1217
|
+
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
1218
|
+
/** Public ID of Canvas A/B test component type */
|
1219
|
+
declare const CANVAS_TEST_TYPE = "$test";
|
1220
|
+
/** Public ID of Canvas localization component type */
|
1221
|
+
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
1222
|
+
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
1223
|
+
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
1224
|
+
/** Public ID of the locale parameter on Canvas components */
|
1225
|
+
declare const CANVAS_LOCALE_TAG_PARAM = "locale";
|
1226
|
+
/** Parameter type for a block parameter */
|
1227
|
+
declare const CANVAS_BLOCK_PARAM_TYPE = "$block";
|
1228
|
+
/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
|
1229
|
+
declare const CANVAS_PERSONALIZE_SLOT = "pz";
|
1230
|
+
/** Name of the slot on CANVAS_TEST_TYPE */
|
1231
|
+
declare const CANVAS_TEST_SLOT = "test";
|
1232
|
+
/** Name of the slot on CANVAS_TEST_TYPE */
|
1233
|
+
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
1234
|
+
/** Constant for a draft composition state. Subject to change. */
|
1235
|
+
declare const CANVAS_DRAFT_STATE = 0;
|
1236
|
+
/** Constant for a published composition state. Subject to change. */
|
1237
|
+
declare const CANVAS_PUBLISHED_STATE = 64;
|
1238
|
+
/** Constant for editor composition state. */
|
1239
|
+
declare const CANVAS_EDITOR_STATE = 63;
|
1240
|
+
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
1241
|
+
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
1242
|
+
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
1243
|
+
declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
1244
|
+
/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
|
1245
|
+
declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
1246
|
+
/** The name of the query string used to detect if we are in contextual editing mode */
|
1247
|
+
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
1248
|
+
/** The name of the query string used to indicate that we want to use the playground for preview */
|
1249
|
+
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
1250
|
+
/** The name of the query string used to get the config from the preview url */
|
1251
|
+
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
1252
|
+
/** The value of "data-role" in the component start `<script>` tag */
|
1253
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
1254
|
+
/** The value of "data-role" in the component end `<script>` tag */
|
1255
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
1256
|
+
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
1257
|
+
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
1258
|
+
/**
|
1259
|
+
* The name of the attribute added to the elements rendered by Uniform.
|
1260
|
+
* Use to allow interacting with them by default in the preview panel
|
1261
|
+
*/
|
1262
|
+
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
1263
|
+
/** The ID we give to placeholder components */
|
1264
|
+
declare const PLACEHOLDER_ID = "placeholder";
|
1265
|
+
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
1266
|
+
declare const EMPTY_COMPOSITION: {
|
1267
|
+
_id: string;
|
1268
|
+
_name: string;
|
1269
|
+
type: string;
|
1270
|
+
};
|
1271
|
+
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
1272
|
+
declare const EDGE_MIN_CACHE_TTL = 15;
|
1273
|
+
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
1274
|
+
declare const EDGE_MAX_CACHE_TTL = 600;
|
1275
|
+
/** Default value for Edgehancers Cache TTL (in seconds) */
|
1276
|
+
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
1277
|
+
/** A value that indicates that Edgehancers caching is disabled */
|
1278
|
+
declare const EDGE_CACHE_DISABLED = -1;
|
1279
|
+
/** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
|
1280
|
+
declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
|
1281
|
+
/** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
|
1282
|
+
declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
|
1283
|
+
/** Default value for Edgehancers Long Term Cache TTL (in hours) */
|
1284
|
+
declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
1285
|
+
|
1194
1286
|
/**
|
1195
1287
|
* This file was auto-generated by openapi-typescript.
|
1196
1288
|
* Do not make direct changes to the file.
|
@@ -1471,10 +1563,21 @@ interface external$b {
|
|
1471
1563
|
entryName?: string | null;
|
1472
1564
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1473
1565
|
fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1566
|
+
/**
|
1567
|
+
* @description Description of the content type
|
1568
|
+
* @default null
|
1569
|
+
*/
|
1570
|
+
description?: string;
|
1571
|
+
/**
|
1572
|
+
* @description Icon name for the content type (e.g. 'screen')
|
1573
|
+
* @default file-document
|
1574
|
+
*/
|
1575
|
+
icon?: string;
|
1474
1576
|
/** @description Created date string for this content type (ignored for writes) */
|
1475
1577
|
created?: string;
|
1476
1578
|
/** @description Last modified date string for this content type (ignored for writes) */
|
1477
1579
|
updated?: string;
|
1580
|
+
slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1478
1581
|
};
|
1479
1582
|
/** @description Defines an editable parameter on a component. */
|
1480
1583
|
ComponentParameter: {
|
@@ -2131,10 +2234,21 @@ interface external$a {
|
|
2131
2234
|
entryName?: string | null;
|
2132
2235
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2133
2236
|
fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2237
|
+
/**
|
2238
|
+
* @description Description of the content type
|
2239
|
+
* @default null
|
2240
|
+
*/
|
2241
|
+
description?: string;
|
2242
|
+
/**
|
2243
|
+
* @description Icon name for the content type (e.g. 'screen')
|
2244
|
+
* @default file-document
|
2245
|
+
*/
|
2246
|
+
icon?: string;
|
2134
2247
|
/** @description Created date string for this content type (ignored for writes) */
|
2135
2248
|
created?: string;
|
2136
2249
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2137
2250
|
updated?: string;
|
2251
|
+
slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2138
2252
|
};
|
2139
2253
|
/** @description Defines an editable parameter on a component. */
|
2140
2254
|
ComponentParameter: {
|
@@ -2486,8 +2600,10 @@ interface paths$8 {
|
|
2486
2600
|
get: {
|
2487
2601
|
parameters: {
|
2488
2602
|
query: {
|
2489
|
-
/** Specify multiple entry IDs to fetch.
|
2603
|
+
/** Specify multiple entry IDs to fetch. */
|
2490
2604
|
entryIDs?: components$4["parameters"]["entryIDs"];
|
2605
|
+
/** Specify a single entry to fetch by slug. */
|
2606
|
+
slug?: components$4["parameters"]["slug"];
|
2491
2607
|
/** Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
2492
2608
|
createdBy?: components$4["parameters"]["createdBy"];
|
2493
2609
|
/** Max number of records to return */
|
@@ -2519,6 +2635,11 @@ interface paths$8 {
|
|
2519
2635
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2520
2636
|
*/
|
2521
2637
|
withUIStatus?: components$4["parameters"]["withUIStatus"];
|
2638
|
+
/**
|
2639
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
2640
|
+
* If false, the `_id` will not be present in the API response.
|
2641
|
+
*/
|
2642
|
+
withComponentIDs?: components$4["parameters"]["withComponentIDs"];
|
2522
2643
|
};
|
2523
2644
|
};
|
2524
2645
|
responses: {
|
@@ -2623,7 +2744,7 @@ interface components$4 {
|
|
2623
2744
|
_id: string;
|
2624
2745
|
/** @description The name of the entry. */
|
2625
2746
|
_name?: string;
|
2626
|
-
/** @description The slug of the entry
|
2747
|
+
/** @description The slug of the entry. */
|
2627
2748
|
_slug?: string;
|
2628
2749
|
/** @description Name of the author of the most recent change. */
|
2629
2750
|
_author?: string;
|
@@ -2642,6 +2763,8 @@ interface components$4 {
|
|
2642
2763
|
* @description The public UUID of the entry.
|
2643
2764
|
*/
|
2644
2765
|
_id?: string;
|
2766
|
+
/** @description The slug of the entry. */
|
2767
|
+
_slug?: string;
|
2645
2768
|
/** @description Entry field values. */
|
2646
2769
|
fields?: {
|
2647
2770
|
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
@@ -2683,8 +2806,10 @@ interface components$4 {
|
|
2683
2806
|
parameters: {
|
2684
2807
|
/** @description The project the entry/entries are on. */
|
2685
2808
|
projectId: string;
|
2686
|
-
/** @description Specify multiple entry IDs to fetch.
|
2809
|
+
/** @description Specify multiple entry IDs to fetch. */
|
2687
2810
|
entryIDs: string[];
|
2811
|
+
/** @description Specify a single entry to fetch by slug. */
|
2812
|
+
slug: string;
|
2688
2813
|
/** @description The content type ID to filter by. */
|
2689
2814
|
type: string[];
|
2690
2815
|
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -2701,6 +2826,11 @@ interface components$4 {
|
|
2701
2826
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2702
2827
|
*/
|
2703
2828
|
withUIStatus: boolean;
|
2829
|
+
/**
|
2830
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
2831
|
+
* If false, the `_id` will not be present in the API response.
|
2832
|
+
*/
|
2833
|
+
withComponentIDs: boolean;
|
2704
2834
|
/**
|
2705
2835
|
* @deprecated
|
2706
2836
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -2927,10 +3057,21 @@ interface external$9 {
|
|
2927
3057
|
entryName?: string | null;
|
2928
3058
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2929
3059
|
fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3060
|
+
/**
|
3061
|
+
* @description Description of the content type
|
3062
|
+
* @default null
|
3063
|
+
*/
|
3064
|
+
description?: string;
|
3065
|
+
/**
|
3066
|
+
* @description Icon name for the content type (e.g. 'screen')
|
3067
|
+
* @default file-document
|
3068
|
+
*/
|
3069
|
+
icon?: string;
|
2930
3070
|
/** @description Created date string for this content type (ignored for writes) */
|
2931
3071
|
created?: string;
|
2932
3072
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2933
3073
|
updated?: string;
|
3074
|
+
slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2934
3075
|
};
|
2935
3076
|
/** @description Defines an editable parameter on a component. */
|
2936
3077
|
ComponentParameter: {
|
@@ -3280,6 +3421,7 @@ type DeleteContentTypeOptions = paths$9['/api/v1/content-types']['delete']['requ
|
|
3280
3421
|
type PutContentTypeBody = paths$9['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
3281
3422
|
type GetContentTypesResponse = paths$9['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
3282
3423
|
type Entry = components$4['schemas']['EntryApiResponse'];
|
3424
|
+
type EntryData = Entry['entry'];
|
3283
3425
|
type GetEntriesOptions = paths$8['/api/v1/entries']['get']['parameters']['query'];
|
3284
3426
|
type GetEntriesResponse = paths$8['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
3285
3427
|
type DeleteEntryOptions = paths$8['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
@@ -3573,10 +3715,21 @@ interface external$8 {
|
|
3573
3715
|
entryName?: string | null;
|
3574
3716
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3575
3717
|
fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3718
|
+
/**
|
3719
|
+
* @description Description of the content type
|
3720
|
+
* @default null
|
3721
|
+
*/
|
3722
|
+
description?: string;
|
3723
|
+
/**
|
3724
|
+
* @description Icon name for the content type (e.g. 'screen')
|
3725
|
+
* @default file-document
|
3726
|
+
*/
|
3727
|
+
icon?: string;
|
3576
3728
|
/** @description Created date string for this content type (ignored for writes) */
|
3577
3729
|
created?: string;
|
3578
3730
|
/** @description Last modified date string for this content type (ignored for writes) */
|
3579
3731
|
updated?: string;
|
3732
|
+
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3580
3733
|
};
|
3581
3734
|
/** @description Defines an editable parameter on a component. */
|
3582
3735
|
ComponentParameter: {
|
@@ -4163,10 +4316,21 @@ interface external$7 {
|
|
4163
4316
|
entryName?: string | null;
|
4164
4317
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
4165
4318
|
fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
4319
|
+
/**
|
4320
|
+
* @description Description of the content type
|
4321
|
+
* @default null
|
4322
|
+
*/
|
4323
|
+
description?: string;
|
4324
|
+
/**
|
4325
|
+
* @description Icon name for the content type (e.g. 'screen')
|
4326
|
+
* @default file-document
|
4327
|
+
*/
|
4328
|
+
icon?: string;
|
4166
4329
|
/** @description Created date string for this content type (ignored for writes) */
|
4167
4330
|
created?: string;
|
4168
4331
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4169
4332
|
updated?: string;
|
4333
|
+
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
4170
4334
|
};
|
4171
4335
|
/** @description Defines an editable parameter on a component. */
|
4172
4336
|
ComponentParameter: {
|
@@ -4788,10 +4952,21 @@ interface external$6 {
|
|
4788
4952
|
entryName?: string | null;
|
4789
4953
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
4790
4954
|
fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
4955
|
+
/**
|
4956
|
+
* @description Description of the content type
|
4957
|
+
* @default null
|
4958
|
+
*/
|
4959
|
+
description?: string;
|
4960
|
+
/**
|
4961
|
+
* @description Icon name for the content type (e.g. 'screen')
|
4962
|
+
* @default file-document
|
4963
|
+
*/
|
4964
|
+
icon?: string;
|
4791
4965
|
/** @description Created date string for this content type (ignored for writes) */
|
4792
4966
|
created?: string;
|
4793
4967
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4794
4968
|
updated?: string;
|
4969
|
+
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
4795
4970
|
};
|
4796
4971
|
/** @description Defines an editable parameter on a component. */
|
4797
4972
|
ComponentParameter: {
|
@@ -5842,10 +6017,21 @@ interface external$5 {
|
|
5842
6017
|
entryName?: string | null;
|
5843
6018
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
5844
6019
|
fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
6020
|
+
/**
|
6021
|
+
* @description Description of the content type
|
6022
|
+
* @default null
|
6023
|
+
*/
|
6024
|
+
description?: string;
|
6025
|
+
/**
|
6026
|
+
* @description Icon name for the content type (e.g. 'screen')
|
6027
|
+
* @default file-document
|
6028
|
+
*/
|
6029
|
+
icon?: string;
|
5845
6030
|
/** @description Created date string for this content type (ignored for writes) */
|
5846
6031
|
created?: string;
|
5847
6032
|
/** @description Last modified date string for this content type (ignored for writes) */
|
5848
6033
|
updated?: string;
|
6034
|
+
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
5849
6035
|
};
|
5850
6036
|
/** @description Defines an editable parameter on a component. */
|
5851
6037
|
ComponentParameter: {
|
@@ -6300,12 +6486,39 @@ interface external$4 {
|
|
6300
6486
|
|
6301
6487
|
interface components$1 {
|
6302
6488
|
schemas: {
|
6303
|
-
CompositionResolvedGetResponse: components$1["schemas"]["
|
6304
|
-
|
6305
|
-
|
6306
|
-
|
6307
|
-
|
6308
|
-
|
6489
|
+
CompositionResolvedGetResponse: components$1["schemas"]["EdgehancersResolutionInfo"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
6490
|
+
CompositionResolvedListResponse: {
|
6491
|
+
diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
|
6492
|
+
data?: {
|
6493
|
+
[key: string]: components$1["schemas"]["DataDiagnostic"][];
|
6494
|
+
};
|
6495
|
+
};
|
6496
|
+
errors?: {
|
6497
|
+
[key: string]: components$1["schemas"]["DataResolutionIssue"][];
|
6498
|
+
};
|
6499
|
+
warnings?: {
|
6500
|
+
[key: string]: components$1["schemas"]["DataResolutionIssue"][];
|
6501
|
+
};
|
6502
|
+
} & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"];
|
6503
|
+
EntryResolvedListResponse: {
|
6504
|
+
diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
|
6505
|
+
data?: {
|
6506
|
+
[key: string]: components$1["schemas"]["DataDiagnostic"][];
|
6507
|
+
};
|
6508
|
+
};
|
6509
|
+
errors?: {
|
6510
|
+
[key: string]: components$1["schemas"]["DataResolutionIssue"][];
|
6511
|
+
};
|
6512
|
+
warnings?: {
|
6513
|
+
[key: string]: components$1["schemas"]["DataResolutionIssue"][];
|
6514
|
+
};
|
6515
|
+
} & external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
|
6516
|
+
EdgehancersResolutionInfo: {
|
6517
|
+
diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
|
6518
|
+
[key: string]: unknown;
|
6519
|
+
};
|
6520
|
+
errors?: components$1["schemas"]["DataResolutionIssue"][];
|
6521
|
+
warnings?: components$1["schemas"]["DataResolutionIssue"][];
|
6309
6522
|
};
|
6310
6523
|
EdgehancersError: {
|
6311
6524
|
message: string;
|
@@ -6344,37 +6557,36 @@ interface components$1 {
|
|
6344
6557
|
/**
|
6345
6558
|
* @description Diagnostic information about request processing, including origin/config/data
|
6346
6559
|
* * timings, edge locations, cache statuses and raw data.
|
6347
|
-
* * Only
|
6560
|
+
* * Only present when diagnostics=true is passed to the options.
|
6348
6561
|
*/
|
6349
|
-
|
6562
|
+
EdgehancersDiagnostics: {
|
6350
6563
|
/** @description Edge location where the request was processed */
|
6351
6564
|
edgeLocation?: string;
|
6352
|
-
|
6353
|
-
/** @description How long it took to fetch the
|
6565
|
+
originFetch?: {
|
6566
|
+
/** @description How long it took to fetch from the origin (ms) */
|
6354
6567
|
duration: number;
|
6355
|
-
/** @description Indicates if the
|
6568
|
+
/** @description Indicates if the origin response was cached */
|
6356
6569
|
cacheHit: boolean;
|
6357
|
-
/** @description Indicates if the request results in a valid
|
6358
|
-
|
6570
|
+
/** @description Indicates if the request results in a valid response */
|
6571
|
+
isValid: boolean;
|
6359
6572
|
/**
|
6360
|
-
* @description
|
6573
|
+
* @description Source cache used
|
6361
6574
|
* @enum {string}
|
6362
6575
|
*/
|
6363
6576
|
sourceCache?: "edge-cdn-cache" | "long-term-cache" | "api-cache";
|
6364
6577
|
/** @description Edge cache location used */
|
6365
6578
|
cacheLocation?: string;
|
6366
|
-
/** @description Uniform-specifc request
|
6579
|
+
/** @description Uniform-specifc request identifier */
|
6367
6580
|
requestId?: string;
|
6368
6581
|
};
|
6369
6582
|
configRetrieval?: {
|
6370
|
-
/** @description How long it took to retrieve the config (ms, in parallel to
|
6583
|
+
/** @description How long it took to retrieve the config (ms, in parallel to origin fetch) */
|
6371
6584
|
duration: number;
|
6372
6585
|
/** @description How many data type configs were retrieved */
|
6373
6586
|
dataTypeCount: number;
|
6374
6587
|
};
|
6375
|
-
data?: components$1["schemas"]["DataDiagnostic"][];
|
6376
6588
|
};
|
6377
|
-
|
6589
|
+
DataResolutionIssue: {
|
6378
6590
|
componentPath?: string;
|
6379
6591
|
componentType?: string;
|
6380
6592
|
message: string;
|
@@ -6386,13 +6598,6 @@ interface components$1 {
|
|
6386
6598
|
inputName?: string;
|
6387
6599
|
code?: string;
|
6388
6600
|
};
|
6389
|
-
InvalidationResult: {
|
6390
|
-
ok: boolean;
|
6391
|
-
};
|
6392
|
-
BatchInvalidationResult: {
|
6393
|
-
ok: number;
|
6394
|
-
failed: number;
|
6395
|
-
};
|
6396
6601
|
};
|
6397
6602
|
responses: {
|
6398
6603
|
/** Invalid caller input came with the request */
|
@@ -6401,11 +6606,13 @@ interface components$1 {
|
|
6401
6606
|
"application/json": components$1["schemas"]["UniformError"];
|
6402
6607
|
};
|
6403
6608
|
};
|
6609
|
+
/** Provided token or API key does not have access to the requested resource */
|
6404
6610
|
UnauthorizedError: {
|
6405
6611
|
content: {
|
6406
6612
|
"application/json": components$1["schemas"]["UniformError"];
|
6407
6613
|
};
|
6408
6614
|
};
|
6615
|
+
/** Provided token or API key does not allow this action */
|
6409
6616
|
ForbiddenError: {
|
6410
6617
|
content: {
|
6411
6618
|
"application/json": components$1["schemas"]["UniformError"];
|
@@ -6429,6 +6636,7 @@ interface components$1 {
|
|
6429
6636
|
"application/json": components$1["schemas"]["UniformError"];
|
6430
6637
|
};
|
6431
6638
|
};
|
6639
|
+
/** The endpoint is called too often */
|
6432
6640
|
RateLimitError: {
|
6433
6641
|
content: {
|
6434
6642
|
"application/json": components$1["schemas"]["UniformError"];
|
@@ -6440,39 +6648,6 @@ interface components$1 {
|
|
6440
6648
|
"application/json": components$1["schemas"]["UniformError"];
|
6441
6649
|
};
|
6442
6650
|
};
|
6443
|
-
CompositionResult: {
|
6444
|
-
content: {
|
6445
|
-
"application/json": {
|
6446
|
-
diagnostics?: components$1["schemas"]["CompositionDiagnostics"];
|
6447
|
-
errors?: components$1["schemas"]["CompositionIssue"][];
|
6448
|
-
warnings?: components$1["schemas"]["CompositionIssue"][];
|
6449
|
-
} & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
6450
|
-
};
|
6451
|
-
};
|
6452
|
-
/** Edge route response */
|
6453
|
-
EdgeRouteResponse: {
|
6454
|
-
content: {
|
6455
|
-
"application/json": external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseRedirect"] | external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseNotFound"] | {
|
6456
|
-
matchedRoute?: string;
|
6457
|
-
dynamicInputs?: external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
|
6458
|
-
/** @enum {string} */
|
6459
|
-
type?: "composition";
|
6460
|
-
compositionApiResponse?: components$1["schemas"]["CompositionResolvedGetResponse"];
|
6461
|
-
};
|
6462
|
-
};
|
6463
|
-
};
|
6464
|
-
/** Invalidation request was processed; ok indicates if it succeeded */
|
6465
|
-
InvalidationResult: {
|
6466
|
-
content: {
|
6467
|
-
"application/json": components$1["schemas"]["InvalidationResult"];
|
6468
|
-
};
|
6469
|
-
};
|
6470
|
-
/** Batch invalidation request was processed; number of successful and failed jobs is included */
|
6471
|
-
BatchInvalidationResult: {
|
6472
|
-
content: {
|
6473
|
-
"application/json": components$1["schemas"]["BatchInvalidationResult"];
|
6474
|
-
};
|
6475
|
-
};
|
6476
6651
|
};
|
6477
6652
|
}
|
6478
6653
|
interface external$3 {
|
@@ -6684,10 +6859,21 @@ interface external$3 {
|
|
6684
6859
|
entryName?: string | null;
|
6685
6860
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
6686
6861
|
fields?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
6862
|
+
/**
|
6863
|
+
* @description Description of the content type
|
6864
|
+
* @default null
|
6865
|
+
*/
|
6866
|
+
description?: string;
|
6867
|
+
/**
|
6868
|
+
* @description Icon name for the content type (e.g. 'screen')
|
6869
|
+
* @default file-document
|
6870
|
+
*/
|
6871
|
+
icon?: string;
|
6687
6872
|
/** @description Created date string for this content type (ignored for writes) */
|
6688
6873
|
created?: string;
|
6689
6874
|
/** @description Last modified date string for this content type (ignored for writes) */
|
6690
6875
|
updated?: string;
|
6876
|
+
slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
6691
6877
|
};
|
6692
6878
|
/** @description Defines an editable parameter on a component. */
|
6693
6879
|
ComponentParameter: {
|
@@ -7505,8 +7691,10 @@ interface external$3 {
|
|
7505
7691
|
get: {
|
7506
7692
|
parameters: {
|
7507
7693
|
query: {
|
7508
|
-
/** Specify multiple entry IDs to fetch.
|
7694
|
+
/** Specify multiple entry IDs to fetch. */
|
7509
7695
|
entryIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["entryIDs"];
|
7696
|
+
/** Specify a single entry to fetch by slug. */
|
7697
|
+
slug?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["slug"];
|
7510
7698
|
/** Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
7511
7699
|
createdBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["createdBy"];
|
7512
7700
|
/** Max number of records to return */
|
@@ -7538,6 +7726,11 @@ interface external$3 {
|
|
7538
7726
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7539
7727
|
*/
|
7540
7728
|
withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
7729
|
+
/**
|
7730
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
7731
|
+
* If false, the `_id` will not be present in the API response.
|
7732
|
+
*/
|
7733
|
+
withComponentIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
7541
7734
|
};
|
7542
7735
|
};
|
7543
7736
|
responses: {
|
@@ -7642,7 +7835,7 @@ interface external$3 {
|
|
7642
7835
|
_id: string;
|
7643
7836
|
/** @description The name of the entry. */
|
7644
7837
|
_name?: string;
|
7645
|
-
/** @description The slug of the entry
|
7838
|
+
/** @description The slug of the entry. */
|
7646
7839
|
_slug?: string;
|
7647
7840
|
/** @description Name of the author of the most recent change. */
|
7648
7841
|
_author?: string;
|
@@ -7661,6 +7854,8 @@ interface external$3 {
|
|
7661
7854
|
* @description The public UUID of the entry.
|
7662
7855
|
*/
|
7663
7856
|
_id?: string;
|
7857
|
+
/** @description The slug of the entry. */
|
7858
|
+
_slug?: string;
|
7664
7859
|
/** @description Entry field values. */
|
7665
7860
|
fields?: {
|
7666
7861
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
@@ -7702,8 +7897,10 @@ interface external$3 {
|
|
7702
7897
|
parameters: {
|
7703
7898
|
/** @description The project the entry/entries are on. */
|
7704
7899
|
projectId: string;
|
7705
|
-
/** @description Specify multiple entry IDs to fetch.
|
7900
|
+
/** @description Specify multiple entry IDs to fetch. */
|
7706
7901
|
entryIDs: string[];
|
7902
|
+
/** @description Specify a single entry to fetch by slug. */
|
7903
|
+
slug: string;
|
7707
7904
|
/** @description The content type ID to filter by. */
|
7708
7905
|
type: string[];
|
7709
7906
|
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -7720,6 +7917,11 @@ interface external$3 {
|
|
7720
7917
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7721
7918
|
*/
|
7722
7919
|
withUIStatus: boolean;
|
7920
|
+
/**
|
7921
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
7922
|
+
* If false, the `_id` will not be present in the API response.
|
7923
|
+
*/
|
7924
|
+
withComponentIDs: boolean;
|
7723
7925
|
/**
|
7724
7926
|
* @deprecated
|
7725
7927
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -8435,10 +8637,21 @@ interface external$2 {
|
|
8435
8637
|
entryName?: string | null;
|
8436
8638
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
8437
8639
|
fields?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
8640
|
+
/**
|
8641
|
+
* @description Description of the content type
|
8642
|
+
* @default null
|
8643
|
+
*/
|
8644
|
+
description?: string;
|
8645
|
+
/**
|
8646
|
+
* @description Icon name for the content type (e.g. 'screen')
|
8647
|
+
* @default file-document
|
8648
|
+
*/
|
8649
|
+
icon?: string;
|
8438
8650
|
/** @description Created date string for this content type (ignored for writes) */
|
8439
8651
|
created?: string;
|
8440
8652
|
/** @description Last modified date string for this content type (ignored for writes) */
|
8441
8653
|
updated?: string;
|
8654
|
+
slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
8442
8655
|
};
|
8443
8656
|
/** @description Defines an editable parameter on a component. */
|
8444
8657
|
ComponentParameter: {
|
@@ -9481,6 +9694,12 @@ type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentPara
|
|
9481
9694
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
9482
9695
|
value: TValue;
|
9483
9696
|
};
|
9697
|
+
/** Parameter which stores blocks of entry types */
|
9698
|
+
type ComponentParameterBlock = Omit<ComponentParameter<BlockValue>, 'type'> & {
|
9699
|
+
type: typeof CANVAS_BLOCK_PARAM_TYPE;
|
9700
|
+
};
|
9701
|
+
/** Value type of a block parameter or block field */
|
9702
|
+
type BlockValue = EntryData[];
|
9484
9703
|
/** The type of the parameters in contextual editing mode. */
|
9485
9704
|
type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
|
9486
9705
|
/** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
|
@@ -9568,21 +9787,25 @@ type DataResolutionParameters = {
|
|
9568
9787
|
diagnostics?: boolean;
|
9569
9788
|
};
|
9570
9789
|
/** Types of issue that can occur when fetching composition data */
|
9571
|
-
type
|
9572
|
-
|
9790
|
+
type DataResolutionIssue = PatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
9791
|
+
/** @deprecated use DataResolutionIssue instead */
|
9792
|
+
type CompositionIssue = DataResolutionIssue;
|
9793
|
+
type DataResolutionIssueCore = components$1['schemas']['DataResolutionIssue'];
|
9573
9794
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
9574
|
-
type
|
9795
|
+
type PatternIssue = DataResolutionIssueCore & {
|
9575
9796
|
type: 'pattern';
|
9576
9797
|
code: NonNullable<ComponentInstance['_patternError']>;
|
9577
9798
|
};
|
9799
|
+
/** @deprecated use PatternIssue instead */
|
9800
|
+
type CompositionPatternIssue = PatternIssue;
|
9578
9801
|
/** An error while binding a dynamic token from a data resource to a component parameter (i.e. a missing property in the data resource) */
|
9579
|
-
type DataElementBindingIssue =
|
9802
|
+
type DataElementBindingIssue = DataResolutionIssueCore & {
|
9580
9803
|
type: 'binding';
|
9581
9804
|
parameterName: string;
|
9582
9805
|
expression?: DataElementConnectionDefinition;
|
9583
9806
|
};
|
9584
9807
|
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
9585
|
-
type DataResourceIssue =
|
9808
|
+
type DataResourceIssue = DataResolutionIssueCore & {
|
9586
9809
|
type: 'data';
|
9587
9810
|
dataName: string;
|
9588
9811
|
dataType: string;
|
@@ -9591,7 +9814,7 @@ type DataResourceIssue = CompositionIssueCore & {
|
|
9591
9814
|
* An issue that occurred while binding dynamic inputs to composition data resources,
|
9592
9815
|
* specifically when an expected dynamic input did not have a value.
|
9593
9816
|
*/
|
9594
|
-
type DynamicInputIssue =
|
9817
|
+
type DynamicInputIssue = DataResolutionIssueCore & {
|
9595
9818
|
type: 'input';
|
9596
9819
|
};
|
9597
9820
|
/** Error in data resolution configuration (internal error) */
|
@@ -9600,11 +9823,16 @@ type DataResolutionConfigIssue = {
|
|
9600
9823
|
type: 'config';
|
9601
9824
|
};
|
9602
9825
|
/** Diagnostics about edge request processing */
|
9603
|
-
type
|
9826
|
+
type EdgehancersDiagnostics = components$1['schemas']['EdgehancersDiagnostics'];
|
9827
|
+
/** @deprecated use EdgehancersDiagnostics instead */
|
9828
|
+
type CompositionDiagnostics = EdgehancersDiagnostics;
|
9604
9829
|
/** Diagnostic data about the load performance of attached composition datas */
|
9605
|
-
type
|
9830
|
+
type DataDiagnostic = components$1['schemas']['DataDiagnostic'];
|
9831
|
+
/** @deprecated use DataDiagnostic instead */
|
9832
|
+
type CompositionDataDiagnostic = DataDiagnostic;
|
9606
9833
|
/** Response as it comes from uniform.global/api/v1/composition */
|
9607
9834
|
type CompositionResolvedGetResponse = components$1['schemas']['CompositionResolvedGetResponse'];
|
9835
|
+
type CompositionResolvedListResponse = components$1['schemas']['CompositionResolvedListResponse'];
|
9608
9836
|
/** All valid response types */
|
9609
9837
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
9610
9838
|
/** The GET response from /api/v1/route */
|
@@ -9614,11 +9842,10 @@ type RouteGetResponseComposition = components['schemas']['RouteResponseCompositi
|
|
9614
9842
|
type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
|
9615
9843
|
type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
|
9616
9844
|
type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
|
9617
|
-
/** Response as it comes from uniform.global/api/v1/composition */
|
9618
|
-
type EntryResolvedGetResponse = components$1['schemas']['EntryResolvedGetResponse'];
|
9619
9845
|
/** The GET response from /api/v1/entries */
|
9620
9846
|
type EntriesGetParameters = paths$8['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
9621
9847
|
type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
|
9848
|
+
type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
|
9622
9849
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
9623
9850
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
9624
9851
|
compositionApiResponse: CompositionResolvedGetResponse;
|
@@ -10193,15 +10420,24 @@ type PreviewPanelSettings = {
|
|
10193
10420
|
isInteractive: boolean;
|
10194
10421
|
};
|
10195
10422
|
type ContextualEditingComponentReference = {
|
10196
|
-
elements: HTMLElement[];
|
10197
10423
|
id: string;
|
10198
|
-
|
10199
|
-
|
10200
|
-
|
10201
|
-
|
10202
|
-
|
10424
|
+
icon?: string;
|
10425
|
+
type?: string;
|
10426
|
+
title?: string;
|
10427
|
+
name?: string;
|
10428
|
+
parameters?: Record<string, {
|
10429
|
+
id: string;
|
10430
|
+
type: string;
|
10431
|
+
name?: string;
|
10432
|
+
isReadOnly?: boolean;
|
10433
|
+
}>;
|
10203
10434
|
parentId?: string;
|
10204
10435
|
parentType?: string;
|
10436
|
+
parentSlot?: {
|
10437
|
+
id?: string;
|
10438
|
+
componentIndex?: number;
|
10439
|
+
totalComponents?: number;
|
10440
|
+
};
|
10205
10441
|
isLocalized?: boolean;
|
10206
10442
|
isReadOnly?: boolean | undefined;
|
10207
10443
|
};
|
@@ -10286,7 +10522,6 @@ type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TCo
|
|
10286
10522
|
|
10287
10523
|
type schemas = components$1['schemas'];
|
10288
10524
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
10289
|
-
type InvalidationResult = schemas['InvalidationResult'];
|
10290
10525
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
10291
10526
|
|
10292
10527
|
type LinkParameterType = 'projectMapNode' | 'url' | 'tel' | 'email';
|
@@ -10562,6 +10797,105 @@ declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ c
|
|
10562
10797
|
onErrors?: (errors: EnhancerError[]) => void;
|
10563
10798
|
}): Promise<void>;
|
10564
10799
|
|
10800
|
+
/** @deprecated use walkNodeTree */
|
10801
|
+
type ComponentLocationReference = {
|
10802
|
+
component: ComponentInstance;
|
10803
|
+
parentSlot?: string;
|
10804
|
+
parentSlotIndex?: number;
|
10805
|
+
};
|
10806
|
+
/** @deprecated use walkNodeTree and check for type = slot */
|
10807
|
+
type WalkComponentTreeActions<TContext> = {
|
10808
|
+
/** Replaces the component being visited with a new object */
|
10809
|
+
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
10810
|
+
/** Removes the component being visited from the composition */
|
10811
|
+
removeComponent: () => void;
|
10812
|
+
/** Inserts a new component immediately after the current component in its parent slot */
|
10813
|
+
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
10814
|
+
/** Aborts visitation of components that are in child slots of the current component */
|
10815
|
+
stopProcessingDescendants: () => void;
|
10816
|
+
/**
|
10817
|
+
* Set a new traversal context for descendants of this node.
|
10818
|
+
* If this is not called, `context` will automatically pass through.
|
10819
|
+
*/
|
10820
|
+
setDescendantsContext: (context: TContext) => void;
|
10821
|
+
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
10822
|
+
};
|
10823
|
+
/**
|
10824
|
+
* Walks a composition's component tree, visiting each component instance depth-first, in order.
|
10825
|
+
* @deprecated use walkNodeTree
|
10826
|
+
*/
|
10827
|
+
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
10828
|
+
/** Traversal context for this node */
|
10829
|
+
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
10830
|
+
|
10831
|
+
/** Ancestor location that is in a slot on a component */
|
10832
|
+
type ComponentLocationReferenceV2 = {
|
10833
|
+
type: 'slot';
|
10834
|
+
node: ComponentInstance;
|
10835
|
+
parentSlot: string;
|
10836
|
+
parentSlotIndex: number;
|
10837
|
+
};
|
10838
|
+
/** Ancestor location that is in a block on a parameter or field */
|
10839
|
+
type BlockLocationReference = {
|
10840
|
+
type: 'block';
|
10841
|
+
node: EntryData;
|
10842
|
+
fieldName: string;
|
10843
|
+
blockIndex: number;
|
10844
|
+
};
|
10845
|
+
/** Ancestor location that is the root of a composition or entry */
|
10846
|
+
type RootLocationReference = {
|
10847
|
+
type: 'root';
|
10848
|
+
node: ComponentInstance;
|
10849
|
+
};
|
10850
|
+
type NodeLocationReference = ComponentLocationReferenceV2 | BlockLocationReference | RootLocationReference;
|
10851
|
+
type WalkNodeTreeActions<TContext, TNodeType> = {
|
10852
|
+
/** Replaces the node being visited with a new object */
|
10853
|
+
replace: (replacement: TNodeType) => void;
|
10854
|
+
/** Removes the node being visited from the composition */
|
10855
|
+
remove: () => void;
|
10856
|
+
/** Inserts a new node immediately after the current node in its parent slot */
|
10857
|
+
insertAfter: (components: TNodeType | TNodeType[]) => void;
|
10858
|
+
/** Aborts visitation of nodes that are descendants of the current node */
|
10859
|
+
stopProcessingDescendants: () => void;
|
10860
|
+
/**
|
10861
|
+
* Set a new traversal context for descendants of this node.
|
10862
|
+
* If this is not called, `context` will automatically pass through.
|
10863
|
+
*/
|
10864
|
+
setDescendantsContext: (context: TContext) => void;
|
10865
|
+
/** Sets a traversal context for a specific child (and any descendants) of this node. */
|
10866
|
+
setChildContext: (child: TNodeType, context: TContext) => void;
|
10867
|
+
};
|
10868
|
+
type NodeTypes = 'entry' | 'component';
|
10869
|
+
type TreeNodeInfo<TType extends NodeTypes, TContext, TNodeType> = {
|
10870
|
+
/** Type of node being visited */
|
10871
|
+
type: TType;
|
10872
|
+
/** The node being visited */
|
10873
|
+
node: TNodeType;
|
10874
|
+
/** The current node and its ancestors. The current node is [0], the parent [1], etc */
|
10875
|
+
ancestorsAndSelf: Array<NodeLocationReference>;
|
10876
|
+
/** Actions you can take on this node or the traversal of additional nodes */
|
10877
|
+
actions: WalkNodeTreeActions<TContext, TNodeType>;
|
10878
|
+
/** Traversal context for this node */
|
10879
|
+
context: TContext | undefined;
|
10880
|
+
};
|
10881
|
+
type TreeNodeInfoTypes<TContext> = TreeNodeInfo<'component', TContext, ComponentInstance> | TreeNodeInfo<'entry', TContext, EntryData>;
|
10882
|
+
type WalkNodeTreeOptions<TContext> = {
|
10883
|
+
/**
|
10884
|
+
* The initial value of the node-walk context, an arbitrary object that is passed to all visitor calls.
|
10885
|
+
* The visitor can use an action to change this value for descendants of the current node.
|
10886
|
+
*/
|
10887
|
+
initialContext?: TContext;
|
10888
|
+
};
|
10889
|
+
/** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
|
10890
|
+
declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
|
10891
|
+
/** Gets the typed value of a block parameter or block field */
|
10892
|
+
declare function getBlockValue(component: ComponentInstance | EntryData, parameterName: string): BlockValue;
|
10893
|
+
|
10894
|
+
/** Returns the JSON pointer of a component based on its location */
|
10895
|
+
declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference | ComponentLocationReference>): string;
|
10896
|
+
|
10897
|
+
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference | NodeLocationReference>): string;
|
10898
|
+
|
10565
10899
|
declare function extractLocales({ component }: {
|
10566
10900
|
component: ComponentInstance;
|
10567
10901
|
}): Record<string, ComponentInstance[]>;
|
@@ -10590,37 +10924,6 @@ declare class UniqueBatchEntries<TArgs, TResult> {
|
|
10590
10924
|
resolveRemaining(value: TResult): void;
|
10591
10925
|
}
|
10592
10926
|
|
10593
|
-
type ComponentLocationReference = {
|
10594
|
-
component: ComponentInstance;
|
10595
|
-
parentSlot?: string;
|
10596
|
-
parentSlotIndex?: number;
|
10597
|
-
};
|
10598
|
-
type WalkComponentTreeActions<TContext> = {
|
10599
|
-
/** Replaces the component being visited with a new object */
|
10600
|
-
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
10601
|
-
/** Removes the component being visited from the composition */
|
10602
|
-
removeComponent: () => void;
|
10603
|
-
/** Inserts a new component immediately after the current component in its parent slot */
|
10604
|
-
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
10605
|
-
/** Aborts visitation of components that are in child slots of the current component */
|
10606
|
-
stopProcessingDescendants: () => void;
|
10607
|
-
/**
|
10608
|
-
* Set a new traversal context for descendants of this node.
|
10609
|
-
* If this is not called, `context` will automatically pass through.
|
10610
|
-
*/
|
10611
|
-
setDescendantsContext: (context: TContext) => void;
|
10612
|
-
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
10613
|
-
};
|
10614
|
-
/** Walks a composition's component tree, visiting each component instance depth-first, in order. */
|
10615
|
-
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
10616
|
-
/** Traversal context for this node */
|
10617
|
-
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
10618
|
-
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
|
10619
|
-
/** Returns the JSON pointer of a component based on its location */
|
10620
|
-
declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocationReference>, { withSlots }?: {
|
10621
|
-
withSlots?: boolean | undefined;
|
10622
|
-
}): string;
|
10623
|
-
|
10624
10927
|
interface ContextualEditingWindowData {
|
10625
10928
|
framework?: ReadyMessage['framework'];
|
10626
10929
|
version?: ReadyMessage['version'];
|
@@ -10636,8 +10939,8 @@ type SelectComponentMessage = {
|
|
10636
10939
|
};
|
10637
10940
|
type SelectParameterMessage = {
|
10638
10941
|
type: 'select-parameter';
|
10639
|
-
parameterId
|
10640
|
-
componentId
|
10942
|
+
parameterId?: string;
|
10943
|
+
componentId?: string;
|
10641
10944
|
};
|
10642
10945
|
type ReadyMessage = {
|
10643
10946
|
type: 'ready';
|
@@ -10645,6 +10948,15 @@ type ReadyMessage = {
|
|
10645
10948
|
/** A non-semantic version of the contextual editing SDK. */
|
10646
10949
|
version?: number;
|
10647
10950
|
};
|
10951
|
+
type TriggerComponentActionMessage = {
|
10952
|
+
type: 'trigger-component-action';
|
10953
|
+
actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
|
10954
|
+
componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
|
10955
|
+
};
|
10956
|
+
type UpdateComponentReferencesMessage = {
|
10957
|
+
type: 'update-component-references';
|
10958
|
+
referencesById: Record<string, ContextualEditingComponentReference>;
|
10959
|
+
};
|
10648
10960
|
type UpdateCompositionMessage = {
|
10649
10961
|
type: 'update-composition';
|
10650
10962
|
composition: RootComponentInstance;
|
@@ -10668,6 +10980,11 @@ type MoveComponentMessage = {
|
|
10668
10980
|
index: number;
|
10669
10981
|
direction: 'up' | 'down';
|
10670
10982
|
};
|
10983
|
+
type OpenParameterEditorMessage = {
|
10984
|
+
type: 'open-parameter-editor';
|
10985
|
+
componentId: string;
|
10986
|
+
parameterId: string;
|
10987
|
+
};
|
10671
10988
|
type UpdateComponentParameterMessage = {
|
10672
10989
|
type: 'update-component-parameter';
|
10673
10990
|
componentId: string;
|
@@ -10701,9 +11018,10 @@ type ReportRenderedCompositionsMessage = {
|
|
10701
11018
|
type EditorStateUpdatedMessage = {
|
10702
11019
|
type: 'editor-state-updated';
|
10703
11020
|
};
|
10704
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
|
11021
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | TriggerComponentActionMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | UpdateComponentReferencesMessage | OpenParameterEditorMessage | EditorStateUpdatedMessage;
|
10705
11022
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
10706
11023
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
11024
|
+
declare const isComponentActionMessage: (message: ChannelMessage) => message is TriggerComponentActionMessage;
|
10707
11025
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
10708
11026
|
declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
|
10709
11027
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
@@ -10715,13 +11033,17 @@ declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => messa
|
|
10715
11033
|
declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
|
10716
11034
|
declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
|
10717
11035
|
declare const isSelectParameterMessage: (message: ChannelMessage) => message is SelectParameterMessage;
|
11036
|
+
declare const isOpenParameterEditorMessage: (message: ChannelMessage) => message is OpenParameterEditorMessage;
|
11037
|
+
declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => message is UpdateComponentReferencesMessage;
|
10718
11038
|
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
10719
11039
|
type Channel = {
|
10720
11040
|
on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
|
10721
11041
|
ready: () => void;
|
10722
11042
|
destroy: () => void;
|
11043
|
+
triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
|
10723
11044
|
selectComponent: (id: string) => void;
|
10724
11045
|
selectParameter: (options: Omit<SelectParameterMessage, 'type'>) => void;
|
11046
|
+
openParameterEditor: (options: Omit<OpenParameterEditorMessage, 'type'>) => void;
|
10725
11047
|
updateComposition: (composition: RootComponentInstance, secret?: string) => void;
|
10726
11048
|
updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
|
10727
11049
|
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
@@ -10732,6 +11054,7 @@ type Channel = {
|
|
10732
11054
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
10733
11055
|
updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
|
10734
11056
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
11057
|
+
updateComponentReferences: (options: Omit<UpdateComponentReferencesMessage, 'type'>) => void;
|
10735
11058
|
editorStateUpdated: () => void;
|
10736
11059
|
};
|
10737
11060
|
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
@@ -10796,74 +11119,6 @@ declare class RouteClient extends ApiClient<RouteClientOptions> {
|
|
10796
11119
|
getRoute(options?: Omit<RouteGetParameters, 'projectId'>): Promise<ResolvedRouteGetResponse>;
|
10797
11120
|
}
|
10798
11121
|
|
10799
|
-
/** Public ID of Canvas personalization component type */
|
10800
|
-
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
10801
|
-
/** Public ID of Canvas A/B test component type */
|
10802
|
-
declare const CANVAS_TEST_TYPE = "$test";
|
10803
|
-
/** Public ID of Canvas localization component type */
|
10804
|
-
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
10805
|
-
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
10806
|
-
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
10807
|
-
/** Public ID of the locale parameter on Canvas components */
|
10808
|
-
declare const CANVAS_LOCALE_TAG_PARAM = "locale";
|
10809
|
-
/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
|
10810
|
-
declare const CANVAS_PERSONALIZE_SLOT = "pz";
|
10811
|
-
/** Name of the slot on CANVAS_TEST_TYPE */
|
10812
|
-
declare const CANVAS_TEST_SLOT = "test";
|
10813
|
-
/** Name of the slot on CANVAS_TEST_TYPE */
|
10814
|
-
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
10815
|
-
/** Constant for a draft composition state. Subject to change. */
|
10816
|
-
declare const CANVAS_DRAFT_STATE = 0;
|
10817
|
-
/** Constant for a published composition state. Subject to change. */
|
10818
|
-
declare const CANVAS_PUBLISHED_STATE = 64;
|
10819
|
-
/** Constant for editor composition state. */
|
10820
|
-
declare const CANVAS_EDITOR_STATE = 63;
|
10821
|
-
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
10822
|
-
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
10823
|
-
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
10824
|
-
declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
10825
|
-
/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
|
10826
|
-
declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
10827
|
-
/** The name of the query string used to detect if we are in contextual editing mode */
|
10828
|
-
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
10829
|
-
/** The name of the query string used to indicate that we want to use the playground for preview */
|
10830
|
-
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
10831
|
-
/** The name of the query string used to get the config from the preview url */
|
10832
|
-
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
10833
|
-
/** The value of "data-role" in the component start `<script>` tag */
|
10834
|
-
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
10835
|
-
/** The value of "data-role" in the component end `<script>` tag */
|
10836
|
-
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
10837
|
-
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
10838
|
-
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
10839
|
-
/**
|
10840
|
-
* The name of the attribute added to the elements rendered by Uniform.
|
10841
|
-
* Use to allow interacting with them by default in the preview panel
|
10842
|
-
*/
|
10843
|
-
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
10844
|
-
/** The ID we give to placeholder components */
|
10845
|
-
declare const PLACEHOLDER_ID = "placeholder";
|
10846
|
-
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
10847
|
-
declare const EMPTY_COMPOSITION: {
|
10848
|
-
_id: string;
|
10849
|
-
_name: string;
|
10850
|
-
type: string;
|
10851
|
-
};
|
10852
|
-
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
10853
|
-
declare const EDGE_MIN_CACHE_TTL = 15;
|
10854
|
-
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
10855
|
-
declare const EDGE_MAX_CACHE_TTL = 600;
|
10856
|
-
/** Default value for Edgehancers Cache TTL (in seconds) */
|
10857
|
-
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
10858
|
-
/** A value that indicates that Edgehancers caching is disabled */
|
10859
|
-
declare const EDGE_CACHE_DISABLED = -1;
|
10860
|
-
/** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
|
10861
|
-
declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
|
10862
|
-
/** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
|
10863
|
-
declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
|
10864
|
-
/** Default value for Edgehancers Long Term Cache TTL (in hours) */
|
10865
|
-
declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
10866
|
-
|
10867
11122
|
/**
|
10868
11123
|
* Creates an enhancer based on an API route.
|
10869
11124
|
* This is mainly used to create an enhancer for Contextual Editing, which can be passed to the `contextualEditingEnhancer` prop of `<UniformComposition />`.
|
@@ -10994,6 +11249,17 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
10994
11249
|
} | undefined;
|
10995
11250
|
}>;
|
10996
11251
|
|
11252
|
+
/**
|
11253
|
+
* Converts a content entry to a put content entry body that has only the properties expected to the PUT API.
|
11254
|
+
* Removes things like author, stats, etc.
|
11255
|
+
*/
|
11256
|
+
declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
|
11257
|
+
/**
|
11258
|
+
* Gets the object holding the properties (fields or parameters) of an entry or component instance
|
11259
|
+
* If no properties are defined, returns undefined.
|
11260
|
+
*/
|
11261
|
+
declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
|
11262
|
+
|
10997
11263
|
declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
|
10998
11264
|
declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
|
10999
11265
|
declare const ATTRIBUTE_PARAMETER_VALUE = "data-uniform-parameter-value";
|
@@ -11042,6 +11308,9 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
|
|
11042
11308
|
*/
|
11043
11309
|
declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
|
11044
11310
|
|
11311
|
+
declare const isComponentPlaceholderId: (id: string | undefined) => boolean | undefined;
|
11312
|
+
declare const generateComponentPlaceholderId: (randomId: string) => string;
|
11313
|
+
|
11045
11314
|
type BindVariablesResult<TValue> = {
|
11046
11315
|
/** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
|
11047
11316
|
boundCount: number;
|
@@ -11101,4 +11370,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
11101
11370
|
|
11102
11371
|
declare const CanvasClientError: typeof ApiClientError;
|
11103
11372
|
|
11104
|
-
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, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, 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, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, Entry,
|
11373
|
+
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, 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, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };
|