@uniformdev/canvas 19.68.1-alpha.27 → 19.71.1-alpha.103

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 CHANGED
@@ -7,25 +7,30 @@ import { Options } from 'p-throttle';
7
7
  import { SerializedEditorState } from 'lexical';
8
8
  import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
9
9
 
10
- interface components$4 {
10
+ interface components$5 {
11
11
  schemas: {
12
12
  /** @description Public ID (used in code). Do not change after creation. */
13
13
  PublicIdProperty: string;
14
14
  /** @description The definition of a component parameter */
15
15
  ComponentDefinitionParameter: {
16
- id: components$4["schemas"]["PublicIdProperty"];
16
+ id: components$5["schemas"]["PublicIdProperty"];
17
17
  /** @description Friendly name of the parameter */
18
18
  name: string;
19
19
  /** @description Appears next to the parameter in the Composition editor */
20
20
  helpText?: string;
21
21
  /** @description Type name of the parameter (provided by a Uniform integration) */
22
22
  type: string;
23
+ /**
24
+ * @description If true, this property can have locale-specific values. If false or not defined,
25
+ * this property will have a single value that is shared for all locales.
26
+ */
27
+ localizable?: boolean;
23
28
  /** @description The configuration object for the type (type-specific) */
24
29
  typeConfig?: unknown;
25
30
  };
26
31
  /** @description The definition of a named component slot that can contain other components */
27
32
  ComponentDefinitionSlot: {
28
- id: components$4["schemas"]["PublicIdProperty"];
33
+ id: components$5["schemas"]["PublicIdProperty"];
29
34
  /** @description Friendly name of the slot */
30
35
  name: string;
31
36
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -83,13 +88,13 @@ interface components$4 {
83
88
  };
84
89
  /** @description The definition of a component variant */
85
90
  ComponentDefinitionVariant: {
86
- id: components$4["schemas"]["PublicIdProperty"];
91
+ id: components$5["schemas"]["PublicIdProperty"];
87
92
  /** @description Friendly name of the variant */
88
93
  name: string;
89
94
  };
90
95
  /** @description Permission set for a component defintion */
91
96
  ComponentDefinitionPermission: {
92
- roleId: components$4["schemas"]["PublicIdProperty"];
97
+ roleId: components$5["schemas"]["PublicIdProperty"];
93
98
  /**
94
99
  * @description Permission type for this permission ComponentDefinition:
95
100
  * read | write | create | delete
@@ -102,7 +107,7 @@ interface components$4 {
102
107
  };
103
108
  /** @description Defines a component type that can live on a Composition */
104
109
  ComponentDefinition: {
105
- id: components$4["schemas"]["PublicIdProperty"];
110
+ id: components$5["schemas"]["PublicIdProperty"];
106
111
  /** @description Friendly name of the component definition */
107
112
  name: string;
108
113
  /**
@@ -123,7 +128,7 @@ interface components$4 {
123
128
  */
124
129
  canBeComposition?: boolean;
125
130
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
126
- parameters?: components$4["schemas"]["ComponentDefinitionParameter"][];
131
+ parameters?: components$5["schemas"]["ComponentDefinitionParameter"][];
127
132
  /**
128
133
  * Format: uuid
129
134
  * @description Reference to the category this component definition belongs to
@@ -146,14 +151,14 @@ interface components$4 {
146
151
  */
147
152
  useTeamPermissions?: boolean;
148
153
  /** @description Custom role permissions for this component definition */
149
- permissions?: components$4["schemas"]["ComponentDefinitionPermission"][];
154
+ permissions?: components$5["schemas"]["ComponentDefinitionPermission"][];
150
155
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
151
- slots?: components$4["schemas"]["ComponentDefinitionSlot"][];
152
- slugSettings?: components$4["schemas"]["ComponentDefinitionSlugSettings"];
156
+ slots?: components$5["schemas"]["ComponentDefinitionSlot"][];
157
+ slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
153
158
  /** @description Default component instance value */
154
- defaults?: components$4["schemas"]["ComponentInstance"] | null;
159
+ defaults?: components$5["schemas"]["ComponentInstance"] | null;
155
160
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
156
- variants?: components$4["schemas"]["ComponentDefinitionVariant"][];
161
+ variants?: components$5["schemas"]["ComponentDefinitionVariant"][];
157
162
  /** @description Created date string for this definition (ignored for writes) */
158
163
  created?: string;
159
164
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -161,7 +166,7 @@ interface components$4 {
161
166
  };
162
167
  /** @description Defines a content type */
163
168
  ContentType: {
164
- id: components$4["schemas"]["PublicIdProperty"];
169
+ id: components$5["schemas"]["PublicIdProperty"];
165
170
  /** @description Friendly name of the content type */
166
171
  name: string;
167
172
  /**
@@ -170,7 +175,7 @@ interface components$4 {
170
175
  */
171
176
  entryName?: string | null;
172
177
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
173
- fields?: components$4["schemas"]["ComponentDefinitionParameter"][];
178
+ fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
174
179
  /**
175
180
  * @description Description of the content type
176
181
  * @default null
@@ -185,7 +190,7 @@ interface components$4 {
185
190
  created?: string;
186
191
  /** @description Last modified date string for this content type (ignored for writes) */
187
192
  updated?: string;
188
- slugSettings?: components$4["schemas"]["ComponentDefinitionSlugSettings"];
193
+ slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
189
194
  /**
190
195
  * @description The definition type of this content type (block or content type)
191
196
  * @default contentType
@@ -196,11 +201,18 @@ interface components$4 {
196
201
  /** @description Defines an editable parameter on a component. */
197
202
  ComponentParameter: {
198
203
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
199
- value: unknown;
204
+ value?: unknown;
200
205
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
201
206
  type: string;
202
207
  /** @deprecated */
203
- connectedData?: components$4["schemas"]["DataElementConnectionDefinition"];
208
+ connectedData?: components$5["schemas"]["DataElementConnectionDefinition"];
209
+ /**
210
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
211
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
212
+ */
213
+ locales?: {
214
+ [key: string]: unknown;
215
+ };
204
216
  };
205
217
  /** @description Defines a connection to a dynamic token on a data resource. */
206
218
  DataElementConnectionDefinition: {
@@ -218,13 +230,13 @@ interface components$4 {
218
230
  type: string;
219
231
  /** @description Component parameter values for the component instance */
220
232
  parameters?: {
221
- [key: string]: components$4["schemas"]["ComponentParameter"];
233
+ [key: string]: components$5["schemas"]["ComponentParameter"];
222
234
  };
223
235
  /** @description Public ID of alternate visual appearance for this component, if any selected */
224
236
  variant?: string;
225
237
  /** @description Slots containing any child components */
226
238
  slots?: {
227
- [key: string]: components$4["schemas"]["ComponentInstance"][];
239
+ [key: string]: components$5["schemas"]["ComponentInstance"][];
228
240
  };
229
241
  /**
230
242
  * @description Unique identifier of the component within the composition.
@@ -235,13 +247,13 @@ interface components$4 {
235
247
  _id?: string;
236
248
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
237
249
  _pattern?: string;
238
- _dataResources?: components$4["schemas"]["DataResourceDefinitions"];
250
+ _dataResources?: components$5["schemas"]["DataResourceDefinitions"];
239
251
  /**
240
252
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
241
253
  * Means nothing for PUTs; it will be ignored.
242
254
  */
243
255
  _patternDataResources?: {
244
- [key: string]: components$4["schemas"]["DataResourceDefinition"];
256
+ [key: string]: components$5["schemas"]["DataResourceDefinition"];
245
257
  };
246
258
  /**
247
259
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -265,7 +277,7 @@ interface components$4 {
265
277
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
266
278
  */
267
279
  _overrides?: {
268
- [key: string]: components$4["schemas"]["ComponentOverride"];
280
+ [key: string]: components$5["schemas"]["ComponentOverride"];
269
281
  };
270
282
  /**
271
283
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -274,7 +286,7 @@ interface components$4 {
274
286
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
275
287
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
276
288
  */
277
- _overridability?: components$4["schemas"]["ComponentOverridability"];
289
+ _overridability?: components$5["schemas"]["ComponentOverridability"];
278
290
  };
279
291
  /** @description Defines the shape of the root component in a composition */
280
292
  RootComponentInstance: {
@@ -282,15 +294,15 @@ interface components$4 {
282
294
  type: string;
283
295
  /** @description Component parameter values for the component instance */
284
296
  parameters?: {
285
- [key: string]: components$4["schemas"]["ComponentParameter"];
297
+ [key: string]: components$5["schemas"]["ComponentParameter"];
286
298
  };
287
299
  /** @description Public ID of alternate visual appearance for this component, if any selected */
288
300
  variant?: string;
289
301
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
290
- projectMapNodes?: components$4["schemas"]["CompositionProjectMapNodeInfo"][];
302
+ projectMapNodes?: components$5["schemas"]["CompositionProjectMapNodeInfo"][];
291
303
  /** @description Slots containing any child components */
292
304
  slots?: {
293
- [key: string]: components$4["schemas"]["ComponentInstance"][];
305
+ [key: string]: components$5["schemas"]["ComponentInstance"][];
294
306
  };
295
307
  /** @description The public UUID of the composition. */
296
308
  _id: string;
@@ -298,7 +310,7 @@ interface components$4 {
298
310
  _slug?: string | null;
299
311
  /** @description Friendly name of this component. */
300
312
  _name: string;
301
- _dataResources?: components$4["schemas"]["DataResourceDefinitions"];
313
+ _dataResources?: components$5["schemas"]["DataResourceDefinitions"];
302
314
  /**
303
315
  * @description Defines patch overrides to component IDs that live in the composition.
304
316
  * This can be used to override parameters that are defined on patterns,
@@ -312,7 +324,7 @@ interface components$4 {
312
324
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
313
325
  */
314
326
  _overrides?: {
315
- [key: string]: components$4["schemas"]["ComponentOverride"];
327
+ [key: string]: components$5["schemas"]["ComponentOverride"];
316
328
  };
317
329
  /**
318
330
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -321,7 +333,9 @@ interface components$4 {
321
333
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
322
334
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
323
335
  */
324
- _overridability?: components$4["schemas"]["ComponentOverridability"];
336
+ _overridability?: components$5["schemas"]["ComponentOverridability"];
337
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
338
+ _locales?: string[];
325
339
  };
326
340
  /**
327
341
  * @description Defines how to override a specific component.
@@ -331,7 +345,7 @@ interface components$4 {
331
345
  */
332
346
  ComponentOverride: {
333
347
  parameters?: {
334
- [key: string]: components$4["schemas"]["ComponentParameter"];
348
+ [key: string]: components$5["schemas"]["ComponentParameter"];
335
349
  };
336
350
  variant?: string;
337
351
  };
@@ -345,7 +359,7 @@ interface components$4 {
345
359
  ComponentOverridability: {
346
360
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
347
361
  parameters?: {
348
- [key: string]: components$4["schemas"]["OverrideOptions"];
362
+ [key: string]: components$5["schemas"]["OverrideOptions"];
349
363
  };
350
364
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
351
365
  variants?: boolean;
@@ -386,7 +400,7 @@ interface components$4 {
386
400
  }[];
387
401
  /** @description Variables needed to make calls to the data source */
388
402
  variables?: {
389
- [key: string]: components$4["schemas"]["DataVariableDefinition"];
403
+ [key: string]: components$5["schemas"]["DataVariableDefinition"];
390
404
  };
391
405
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
392
406
  custom?: {
@@ -438,7 +452,7 @@ interface components$4 {
438
452
  method: "GET" | "POST" | "HEAD";
439
453
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
440
454
  variables?: {
441
- [key: string]: components$4["schemas"]["DataVariableDefinition"];
455
+ [key: string]: components$5["schemas"]["DataVariableDefinition"];
442
456
  };
443
457
  /** @description Custom configuration specific to the data source being defined */
444
458
  custom?: {
@@ -471,7 +485,7 @@ interface components$4 {
471
485
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
472
486
  */
473
487
  DataResourceDefinitions: {
474
- [key: string]: components$4["schemas"]["DataResourceDefinition"];
488
+ [key: string]: components$5["schemas"]["DataResourceDefinition"];
475
489
  };
476
490
  /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
477
491
  DataResourceDefinition: {
@@ -485,7 +499,7 @@ interface components$4 {
485
499
  * If isPatternParameter is false or undefined, this has no meaning.
486
500
  */
487
501
  ignorePatternParameterDefault?: boolean;
488
- variables?: components$4["schemas"]["DataResourceVariables"];
502
+ variables?: components$5["schemas"]["DataResourceVariables"];
489
503
  };
490
504
  /** @description Variable values for a data resource. */
491
505
  DataResourceVariables: {
@@ -500,7 +514,7 @@ interface components$4 {
500
514
  /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
501
515
  truncated?: boolean;
502
516
  /** @description Version history entries. */
503
- results?: components$4["schemas"]["HistoryEntry"][];
517
+ results?: components$5["schemas"]["HistoryEntry"][];
504
518
  };
505
519
  HistoryEntry: {
506
520
  /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
@@ -553,15 +567,19 @@ interface components$4 {
553
567
  /** @description Unique identifier for the integration that this prompt belongs to. */
554
568
  integrationType: string;
555
569
  /** @description Name for the prompt */
556
- promptName?: string | null;
570
+ name?: string | null;
557
571
  /** @description Text for the prompt */
558
- promptText?: string | null;
572
+ text?: string | null;
559
573
  /** @description Data for the prompt */
560
- promptData?: string | null;
574
+ data?: {
575
+ [key: string]: unknown;
576
+ } | null;
561
577
  /** @description Turn off/on prompt */
562
578
  enabled?: boolean | null;
563
579
  /** @description Integration default prompt */
564
580
  builtIn?: boolean | null;
581
+ /** @description Supported parameter types */
582
+ parameterTypes?: string[] | null;
565
583
  };
566
584
  };
567
585
  }
@@ -722,6 +740,11 @@ interface external$f {
722
740
  helpText?: string;
723
741
  /** @description Type name of the parameter (provided by a Uniform integration) */
724
742
  type: string;
743
+ /**
744
+ * @description If true, this property can have locale-specific values. If false or not defined,
745
+ * this property will have a single value that is shared for all locales.
746
+ */
747
+ localizable?: boolean;
725
748
  /** @description The configuration object for the type (type-specific) */
726
749
  typeConfig?: unknown;
727
750
  };
@@ -898,11 +921,18 @@ interface external$f {
898
921
  /** @description Defines an editable parameter on a component. */
899
922
  ComponentParameter: {
900
923
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
901
- value: unknown;
924
+ value?: unknown;
902
925
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
903
926
  type: string;
904
927
  /** @deprecated */
905
928
  connectedData?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
929
+ /**
930
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
931
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
932
+ */
933
+ locales?: {
934
+ [key: string]: unknown;
935
+ };
906
936
  };
907
937
  /** @description Defines a connection to a dynamic token on a data resource. */
908
938
  DataElementConnectionDefinition: {
@@ -1024,6 +1054,8 @@ interface external$f {
1024
1054
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1025
1055
  */
1026
1056
  _overridability?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1057
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
1058
+ _locales?: string[];
1027
1059
  };
1028
1060
  /**
1029
1061
  * @description Defines how to override a specific component.
@@ -1255,15 +1287,19 @@ interface external$f {
1255
1287
  /** @description Unique identifier for the integration that this prompt belongs to. */
1256
1288
  integrationType: string;
1257
1289
  /** @description Name for the prompt */
1258
- promptName?: string | null;
1290
+ name?: string | null;
1259
1291
  /** @description Text for the prompt */
1260
- promptText?: string | null;
1292
+ text?: string | null;
1261
1293
  /** @description Data for the prompt */
1262
- promptData?: string | null;
1294
+ data?: {
1295
+ [key: string]: unknown;
1296
+ } | null;
1263
1297
  /** @description Turn off/on prompt */
1264
1298
  enabled?: boolean | null;
1265
1299
  /** @description Integration default prompt */
1266
1300
  builtIn?: boolean | null;
1301
+ /** @description Supported parameter types */
1302
+ parameterTypes?: string[] | null;
1267
1303
  };
1268
1304
  };
1269
1305
  };
@@ -1271,7 +1307,7 @@ interface external$f {
1271
1307
  };
1272
1308
  }
1273
1309
 
1274
- type SharedComponents$2 = components$4['schemas'];
1310
+ type SharedComponents$2 = components$5['schemas'];
1275
1311
  type Api$2 = paths$e['/api/v1/canvas-definitions'];
1276
1312
  /** Shape of the GET response from /api/v1/canvas-definitions */
1277
1313
  type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
@@ -1282,7 +1318,7 @@ type ComponentDefinitionDeleteParameters = Api$2['delete']['requestBody']['conte
1282
1318
  /** Query parameter options for GET /api/v1/canvas-definitions */
1283
1319
  type ComponentDefinitionGetParameters = Api$2['get']['parameters']['query'];
1284
1320
  /** The definition of a component parameter */
1285
- type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$4['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
1321
+ type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$5['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
1286
1322
  typeConfig?: TConfig;
1287
1323
  };
1288
1324
  /** The definition of a component visual variant */
@@ -1364,6 +1400,12 @@ declare const EDGE_MAX_CACHE_TTL: number;
1364
1400
  declare const EDGE_DEFAULT_CACHE_TTL = 30;
1365
1401
  /** A value that indicates that Edgehancers caching is disabled */
1366
1402
  declare const EDGE_CACHE_DISABLED = -1;
1403
+ /** This is the type value for the asset parameter or field */
1404
+ declare const ASSET_PARAMETER_TYPE = "asset";
1405
+ /** The _source for any assets coming from the Uniform Asset Library */
1406
+ declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
1407
+ /** The _source for any assets which have manually set fields */
1408
+ declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
1367
1409
 
1368
1410
  /**
1369
1411
  * This file was auto-generated by openapi-typescript.
@@ -1494,6 +1536,11 @@ interface external$e {
1494
1536
  helpText?: string;
1495
1537
  /** @description Type name of the parameter (provided by a Uniform integration) */
1496
1538
  type: string;
1539
+ /**
1540
+ * @description If true, this property can have locale-specific values. If false or not defined,
1541
+ * this property will have a single value that is shared for all locales.
1542
+ */
1543
+ localizable?: boolean;
1497
1544
  /** @description The configuration object for the type (type-specific) */
1498
1545
  typeConfig?: unknown;
1499
1546
  };
@@ -1670,11 +1717,18 @@ interface external$e {
1670
1717
  /** @description Defines an editable parameter on a component. */
1671
1718
  ComponentParameter: {
1672
1719
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
1673
- value: unknown;
1720
+ value?: unknown;
1674
1721
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
1675
1722
  type: string;
1676
1723
  /** @deprecated */
1677
1724
  connectedData?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
1725
+ /**
1726
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
1727
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
1728
+ */
1729
+ locales?: {
1730
+ [key: string]: unknown;
1731
+ };
1678
1732
  };
1679
1733
  /** @description Defines a connection to a dynamic token on a data resource. */
1680
1734
  DataElementConnectionDefinition: {
@@ -1796,6 +1850,8 @@ interface external$e {
1796
1850
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1797
1851
  */
1798
1852
  _overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1853
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
1854
+ _locales?: string[];
1799
1855
  };
1800
1856
  /**
1801
1857
  * @description Defines how to override a specific component.
@@ -2027,15 +2083,19 @@ interface external$e {
2027
2083
  /** @description Unique identifier for the integration that this prompt belongs to. */
2028
2084
  integrationType: string;
2029
2085
  /** @description Name for the prompt */
2030
- promptName?: string | null;
2086
+ name?: string | null;
2031
2087
  /** @description Text for the prompt */
2032
- promptText?: string | null;
2088
+ text?: string | null;
2033
2089
  /** @description Data for the prompt */
2034
- promptData?: string | null;
2090
+ data?: {
2091
+ [key: string]: unknown;
2092
+ } | null;
2035
2093
  /** @description Turn off/on prompt */
2036
2094
  enabled?: boolean | null;
2037
2095
  /** @description Integration default prompt */
2038
2096
  builtIn?: boolean | null;
2097
+ /** @description Supported parameter types */
2098
+ parameterTypes?: string[] | null;
2039
2099
  };
2040
2100
  };
2041
2101
  };
@@ -2043,7 +2103,7 @@ interface external$e {
2043
2103
  };
2044
2104
  }
2045
2105
 
2046
- type SharedComponents$1 = components$4['schemas'];
2106
+ type SharedComponents$1 = components$5['schemas'];
2047
2107
  type Api$1 = paths$d['/api/v1/categories'];
2048
2108
  /** Shape of the GET response from /api/v1/category */
2049
2109
  type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
@@ -2208,6 +2268,11 @@ interface external$d {
2208
2268
  helpText?: string;
2209
2269
  /** @description Type name of the parameter (provided by a Uniform integration) */
2210
2270
  type: string;
2271
+ /**
2272
+ * @description If true, this property can have locale-specific values. If false or not defined,
2273
+ * this property will have a single value that is shared for all locales.
2274
+ */
2275
+ localizable?: boolean;
2211
2276
  /** @description The configuration object for the type (type-specific) */
2212
2277
  typeConfig?: unknown;
2213
2278
  };
@@ -2384,11 +2449,18 @@ interface external$d {
2384
2449
  /** @description Defines an editable parameter on a component. */
2385
2450
  ComponentParameter: {
2386
2451
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
2387
- value: unknown;
2452
+ value?: unknown;
2388
2453
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
2389
2454
  type: string;
2390
2455
  /** @deprecated */
2391
2456
  connectedData?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
2457
+ /**
2458
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
2459
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
2460
+ */
2461
+ locales?: {
2462
+ [key: string]: unknown;
2463
+ };
2392
2464
  };
2393
2465
  /** @description Defines a connection to a dynamic token on a data resource. */
2394
2466
  DataElementConnectionDefinition: {
@@ -2510,6 +2582,8 @@ interface external$d {
2510
2582
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2511
2583
  */
2512
2584
  _overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2585
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
2586
+ _locales?: string[];
2513
2587
  };
2514
2588
  /**
2515
2589
  * @description Defines how to override a specific component.
@@ -2741,15 +2815,19 @@ interface external$d {
2741
2815
  /** @description Unique identifier for the integration that this prompt belongs to. */
2742
2816
  integrationType: string;
2743
2817
  /** @description Name for the prompt */
2744
- promptName?: string | null;
2818
+ name?: string | null;
2745
2819
  /** @description Text for the prompt */
2746
- promptText?: string | null;
2820
+ text?: string | null;
2747
2821
  /** @description Data for the prompt */
2748
- promptData?: string | null;
2822
+ data?: {
2823
+ [key: string]: unknown;
2824
+ } | null;
2749
2825
  /** @description Turn off/on prompt */
2750
2826
  enabled?: boolean | null;
2751
2827
  /** @description Integration default prompt */
2752
2828
  builtIn?: boolean | null;
2829
+ /** @description Supported parameter types */
2830
+ parameterTypes?: string[] | null;
2753
2831
  };
2754
2832
  };
2755
2833
  };
@@ -2767,59 +2845,78 @@ interface paths$b {
2767
2845
  parameters: {
2768
2846
  query: {
2769
2847
  /** Specify multiple entry IDs to fetch. */
2770
- entryIDs?: components$3["parameters"]["entryIDs"];
2848
+ entryIDs?: components$4["parameters"]["entryIDs"];
2771
2849
  /**
2772
2850
  * Specify a historical entry version ID to fetch (retrieved from the entries-history API).
2773
2851
  * Must be used with the `entryIDs` parameter, and there must be only one entryID passed.
2774
2852
  */
2775
- versionId?: components$3["parameters"]["versionId"];
2853
+ versionId?: components$4["parameters"]["versionId"];
2776
2854
  /** Specify a single entry to fetch by slug. */
2777
- slug?: components$3["parameters"]["slug"];
2855
+ slug?: components$4["parameters"]["slug"];
2778
2856
  /** Filters entry lists by the user who created them. The user is specified by their identity subject. */
2779
- createdBy?: components$3["parameters"]["createdBy"];
2857
+ createdBy?: components$4["parameters"]["createdBy"];
2780
2858
  /** Max number of records to return */
2781
- limit?: components$3["parameters"]["limit"];
2859
+ limit?: components$4["parameters"]["limit"];
2782
2860
  /** Number of records to skip */
2783
- offset?: components$3["parameters"]["offset"];
2861
+ offset?: components$4["parameters"]["offset"];
2784
2862
  /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
2785
- orderBy?: components$3["parameters"]["orderBy"];
2863
+ orderBy?: components$4["parameters"]["orderBy"];
2786
2864
  /** The project the entry/entries are on. */
2787
- projectId: components$3["parameters"]["projectId"];
2865
+ projectId: components$4["parameters"]["projectId"];
2788
2866
  /** Publishing state to fetch. 0 = draft, 64 = published. */
2789
- state?: components$3["parameters"]["state"];
2867
+ state?: components$4["parameters"]["state"];
2790
2868
  /** The content type ID to filter by. */
2791
- type?: components$3["parameters"]["type"];
2869
+ type?: components$4["parameters"]["type"];
2792
2870
  /**
2793
2871
  * @deprecated Filters entries lists by the UI status of the entry.
2794
2872
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2795
2873
  */
2796
- uiStatus?: components$3["parameters"]["uiStatus"];
2874
+ uiStatus?: components$4["parameters"]["uiStatus"];
2797
2875
  /** Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
2798
- updatedBy?: components$3["parameters"]["updatedBy"];
2876
+ updatedBy?: components$4["parameters"]["updatedBy"];
2799
2877
  /**
2800
2878
  * Controls whether the total count of results will be returned along with the current results page in a list.
2801
2879
  * Has no effect when not fetching a list. This does impact performance when enabled.
2802
2880
  */
2803
- withTotalCount?: components$3["parameters"]["withTotalCount"];
2881
+ withTotalCount?: components$4["parameters"]["withTotalCount"];
2804
2882
  /**
2805
2883
  * @deprecated Returns the UI status string of the entry.
2806
2884
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2807
2885
  */
2808
- withUIStatus?: components$3["parameters"]["withUIStatus"];
2886
+ withUIStatus?: components$4["parameters"]["withUIStatus"];
2809
2887
  /**
2810
2888
  * If true the `_id` unique identifier of blocks will be part of the response data.
2811
2889
  * If false, the `_id` will not be present in the API response.
2812
2890
  */
2813
- withComponentIDs?: components$3["parameters"]["withComponentIDs"];
2891
+ withComponentIDs?: components$4["parameters"]["withComponentIDs"];
2814
2892
  /** Performs keyword search on the entries. */
2815
- keyword?: components$3["parameters"]["keyword"];
2893
+ keyword?: components$4["parameters"]["keyword"];
2894
+ /**
2895
+ * If true, any pattern override data is not resolved by the API.
2896
+ * This is intended for internal use in the Canvas editor, and should not be used.
2897
+ * Passing this parameter automatically implies withComponentIDs to be true.
2898
+ */
2899
+ skipOverridesResolution?: components$4["parameters"]["skipOverridesResolution"];
2900
+ /**
2901
+ * One or more locales to filter and localize by.
2902
+ * Only entries which enable one of the specified locales _or enable no locales_ will be returned.
2903
+ * The response will be localized to include only the first matching locale's data.
2904
+ *
2905
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
2906
+ * en-US
2907
+ * fr-CA,fr
2908
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
2909
+ *
2910
+ * When this parameter is not passed, all locales' data will be returned.
2911
+ */
2912
+ locale?: components$4["parameters"]["locale"];
2816
2913
  };
2817
2914
  };
2818
2915
  responses: {
2819
2916
  /** OK */
2820
2917
  200: {
2821
2918
  content: {
2822
- "application/json": components$3["schemas"]["EntryListResponse"];
2919
+ "application/json": components$4["schemas"]["EntryListResponse"];
2823
2920
  };
2824
2921
  };
2825
2922
  400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
@@ -2856,7 +2953,7 @@ interface paths$b {
2856
2953
  projectId: string;
2857
2954
  /** @description The publishing state to upsert into. 0 = draft, 64 = published */
2858
2955
  state: number;
2859
- entry: components$3["schemas"]["EntryInput"];
2956
+ entry: components$4["schemas"]["EntryInput"];
2860
2957
  /** @description Ignored if present */
2861
2958
  created?: string;
2862
2959
  /** @description Ignored if present */
@@ -2904,7 +3001,7 @@ interface paths$b {
2904
3001
  };
2905
3002
  };
2906
3003
  }
2907
- interface components$3 {
3004
+ interface components$4 {
2908
3005
  schemas: {
2909
3006
  /** @description Defines the shape of the entry */
2910
3007
  Entry: {
@@ -2921,6 +3018,8 @@ interface components$3 {
2921
3018
  _slug?: string;
2922
3019
  /** @description Name of the author of the most recent change. */
2923
3020
  _author?: string;
3021
+ /** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
3022
+ _locales?: string[];
2924
3023
  /** @description Entry field values. */
2925
3024
  fields?: {
2926
3025
  [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
@@ -2945,6 +3044,8 @@ interface components$3 {
2945
3044
  [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2946
3045
  };
2947
3046
  _dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3047
+ /** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
3048
+ _locales?: string[];
2948
3049
  };
2949
3050
  EntryApiResponse: {
2950
3051
  /** @description Publishing state to fetch. 0 = draft, 64 = published. */
@@ -2970,10 +3071,10 @@ interface components$3 {
2970
3071
  * @description Modified date string for this definition
2971
3072
  */
2972
3073
  modified: string;
2973
- entry: components$3["schemas"]["Entry"];
3074
+ entry: components$4["schemas"]["Entry"];
2974
3075
  };
2975
3076
  EntryListResponse: {
2976
- entries: components$3["schemas"]["EntryApiResponse"][];
3077
+ entries: components$4["schemas"]["EntryApiResponse"][];
2977
3078
  /** @description Total number of entries that match the query. Only present when `withTotalCount` option is true. */
2978
3079
  totalCount?: number;
2979
3080
  };
@@ -3028,6 +3129,25 @@ interface components$3 {
3028
3129
  withTotalCount: boolean;
3029
3130
  /** @description Performs keyword search on the entries. */
3030
3131
  keyword: string;
3132
+ /**
3133
+ * @description If true, any pattern override data is not resolved by the API.
3134
+ * This is intended for internal use in the Canvas editor, and should not be used.
3135
+ * Passing this parameter automatically implies withComponentIDs to be true.
3136
+ */
3137
+ skipOverridesResolution: boolean;
3138
+ /**
3139
+ * @description One or more locales to filter and localize by.
3140
+ * Only entries which enable one of the specified locales _or enable no locales_ will be returned.
3141
+ * The response will be localized to include only the first matching locale's data.
3142
+ *
3143
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
3144
+ * en-US
3145
+ * fr-CA,fr
3146
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
3147
+ *
3148
+ * When this parameter is not passed, all locales' data will be returned.
3149
+ */
3150
+ locale: string;
3031
3151
  };
3032
3152
  }
3033
3153
  interface external$c {
@@ -3088,6 +3208,11 @@ interface external$c {
3088
3208
  helpText?: string;
3089
3209
  /** @description Type name of the parameter (provided by a Uniform integration) */
3090
3210
  type: string;
3211
+ /**
3212
+ * @description If true, this property can have locale-specific values. If false or not defined,
3213
+ * this property will have a single value that is shared for all locales.
3214
+ */
3215
+ localizable?: boolean;
3091
3216
  /** @description The configuration object for the type (type-specific) */
3092
3217
  typeConfig?: unknown;
3093
3218
  };
@@ -3264,11 +3389,18 @@ interface external$c {
3264
3389
  /** @description Defines an editable parameter on a component. */
3265
3390
  ComponentParameter: {
3266
3391
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
3267
- value: unknown;
3392
+ value?: unknown;
3268
3393
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
3269
3394
  type: string;
3270
3395
  /** @deprecated */
3271
3396
  connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
3397
+ /**
3398
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
3399
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
3400
+ */
3401
+ locales?: {
3402
+ [key: string]: unknown;
3403
+ };
3272
3404
  };
3273
3405
  /** @description Defines a connection to a dynamic token on a data resource. */
3274
3406
  DataElementConnectionDefinition: {
@@ -3390,6 +3522,8 @@ interface external$c {
3390
3522
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3391
3523
  */
3392
3524
  _overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3525
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
3526
+ _locales?: string[];
3393
3527
  };
3394
3528
  /**
3395
3529
  * @description Defines how to override a specific component.
@@ -3621,15 +3755,19 @@ interface external$c {
3621
3755
  /** @description Unique identifier for the integration that this prompt belongs to. */
3622
3756
  integrationType: string;
3623
3757
  /** @description Name for the prompt */
3624
- promptName?: string | null;
3758
+ name?: string | null;
3625
3759
  /** @description Text for the prompt */
3626
- promptText?: string | null;
3760
+ text?: string | null;
3627
3761
  /** @description Data for the prompt */
3628
- promptData?: string | null;
3762
+ data?: {
3763
+ [key: string]: unknown;
3764
+ } | null;
3629
3765
  /** @description Turn off/on prompt */
3630
3766
  enabled?: boolean | null;
3631
3767
  /** @description Integration default prompt */
3632
3768
  builtIn?: boolean | null;
3769
+ /** @description Supported parameter types */
3770
+ parameterTypes?: string[] | null;
3633
3771
  };
3634
3772
  };
3635
3773
  };
@@ -3734,6 +3872,11 @@ interface external$b {
3734
3872
  helpText?: string;
3735
3873
  /** @description Type name of the parameter (provided by a Uniform integration) */
3736
3874
  type: string;
3875
+ /**
3876
+ * @description If true, this property can have locale-specific values. If false or not defined,
3877
+ * this property will have a single value that is shared for all locales.
3878
+ */
3879
+ localizable?: boolean;
3737
3880
  /** @description The configuration object for the type (type-specific) */
3738
3881
  typeConfig?: unknown;
3739
3882
  };
@@ -3910,11 +4053,18 @@ interface external$b {
3910
4053
  /** @description Defines an editable parameter on a component. */
3911
4054
  ComponentParameter: {
3912
4055
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
3913
- value: unknown;
4056
+ value?: unknown;
3914
4057
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
3915
4058
  type: string;
3916
4059
  /** @deprecated */
3917
4060
  connectedData?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
4061
+ /**
4062
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
4063
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
4064
+ */
4065
+ locales?: {
4066
+ [key: string]: unknown;
4067
+ };
3918
4068
  };
3919
4069
  /** @description Defines a connection to a dynamic token on a data resource. */
3920
4070
  DataElementConnectionDefinition: {
@@ -4036,6 +4186,8 @@ interface external$b {
4036
4186
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4037
4187
  */
4038
4188
  _overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4189
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
4190
+ _locales?: string[];
4039
4191
  };
4040
4192
  /**
4041
4193
  * @description Defines how to override a specific component.
@@ -4267,15 +4419,19 @@ interface external$b {
4267
4419
  /** @description Unique identifier for the integration that this prompt belongs to. */
4268
4420
  integrationType: string;
4269
4421
  /** @description Name for the prompt */
4270
- promptName?: string | null;
4422
+ name?: string | null;
4271
4423
  /** @description Text for the prompt */
4272
- promptText?: string | null;
4424
+ text?: string | null;
4273
4425
  /** @description Data for the prompt */
4274
- promptData?: string | null;
4426
+ data?: {
4427
+ [key: string]: unknown;
4428
+ } | null;
4275
4429
  /** @description Turn off/on prompt */
4276
4430
  enabled?: boolean | null;
4277
4431
  /** @description Integration default prompt */
4278
4432
  builtIn?: boolean | null;
4433
+ /** @description Supported parameter types */
4434
+ parameterTypes?: string[] | null;
4279
4435
  };
4280
4436
  };
4281
4437
  };
@@ -4284,13 +4440,14 @@ interface external$b {
4284
4440
  }
4285
4441
 
4286
4442
  type HistoryApi$1 = paths$a['/api/v1/entries-history'];
4287
- type ContentType = components$4['schemas']['ContentType'];
4443
+ type ContentType = components$5['schemas']['ContentType'];
4288
4444
  type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
4289
4445
  type GetContentTypesOptions = paths$c['/api/v1/content-types']['get']['parameters']['query'];
4290
4446
  type DeleteContentTypeOptions = paths$c['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
4291
4447
  type PutContentTypeBody = paths$c['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
4292
4448
  type GetContentTypesResponse = paths$c['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
4293
- type Entry = components$3['schemas']['EntryApiResponse'];
4449
+ type Entry = components$4['schemas']['EntryApiResponse'];
4450
+ type EntryList = components$4['schemas']['EntryListResponse'];
4294
4451
  type EntryData = Entry['entry'];
4295
4452
  type GetEntriesOptions = paths$b['/api/v1/entries']['get']['parameters']['query'];
4296
4453
  type GetEntriesResponse = paths$b['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
@@ -4299,7 +4456,7 @@ type PutEntryBody = paths$b['/api/v1/entries']['put']['requestBody']['content'][
4299
4456
  /** The GET response from /api/v1/entries-history (history for one entry) */
4300
4457
  type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
4301
4458
  /** The GET response from /api/v1/entries-history */
4302
- type EntriesHistoryGetResponse = components$4['schemas']['HistoryApiResponse'];
4459
+ type EntriesHistoryGetResponse = components$5['schemas']['HistoryApiResponse'];
4303
4460
 
4304
4461
  /**
4305
4462
  * This file was auto-generated by openapi-typescript.
@@ -4438,6 +4595,11 @@ interface external$a {
4438
4595
  helpText?: string;
4439
4596
  /** @description Type name of the parameter (provided by a Uniform integration) */
4440
4597
  type: string;
4598
+ /**
4599
+ * @description If true, this property can have locale-specific values. If false or not defined,
4600
+ * this property will have a single value that is shared for all locales.
4601
+ */
4602
+ localizable?: boolean;
4441
4603
  /** @description The configuration object for the type (type-specific) */
4442
4604
  typeConfig?: unknown;
4443
4605
  };
@@ -4614,11 +4776,18 @@ interface external$a {
4614
4776
  /** @description Defines an editable parameter on a component. */
4615
4777
  ComponentParameter: {
4616
4778
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
4617
- value: unknown;
4779
+ value?: unknown;
4618
4780
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
4619
4781
  type: string;
4620
4782
  /** @deprecated */
4621
4783
  connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
4784
+ /**
4785
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
4786
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
4787
+ */
4788
+ locales?: {
4789
+ [key: string]: unknown;
4790
+ };
4622
4791
  };
4623
4792
  /** @description Defines a connection to a dynamic token on a data resource. */
4624
4793
  DataElementConnectionDefinition: {
@@ -4740,6 +4909,8 @@ interface external$a {
4740
4909
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4741
4910
  */
4742
4911
  _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4912
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
4913
+ _locales?: string[];
4743
4914
  };
4744
4915
  /**
4745
4916
  * @description Defines how to override a specific component.
@@ -4971,15 +5142,19 @@ interface external$a {
4971
5142
  /** @description Unique identifier for the integration that this prompt belongs to. */
4972
5143
  integrationType: string;
4973
5144
  /** @description Name for the prompt */
4974
- promptName?: string | null;
5145
+ name?: string | null;
4975
5146
  /** @description Text for the prompt */
4976
- promptText?: string | null;
5147
+ text?: string | null;
4977
5148
  /** @description Data for the prompt */
4978
- promptData?: string | null;
5149
+ data?: {
5150
+ [key: string]: unknown;
5151
+ } | null;
4979
5152
  /** @description Turn off/on prompt */
4980
5153
  enabled?: boolean | null;
4981
5154
  /** @description Integration default prompt */
4982
5155
  builtIn?: boolean | null;
5156
+ /** @description Supported parameter types */
5157
+ parameterTypes?: string[] | null;
4983
5158
  };
4984
5159
  };
4985
5160
  };
@@ -5080,6 +5255,11 @@ interface external$9 {
5080
5255
  helpText?: string;
5081
5256
  /** @description Type name of the parameter (provided by a Uniform integration) */
5082
5257
  type: string;
5258
+ /**
5259
+ * @description If true, this property can have locale-specific values. If false or not defined,
5260
+ * this property will have a single value that is shared for all locales.
5261
+ */
5262
+ localizable?: boolean;
5083
5263
  /** @description The configuration object for the type (type-specific) */
5084
5264
  typeConfig?: unknown;
5085
5265
  };
@@ -5256,11 +5436,18 @@ interface external$9 {
5256
5436
  /** @description Defines an editable parameter on a component. */
5257
5437
  ComponentParameter: {
5258
5438
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
5259
- value: unknown;
5439
+ value?: unknown;
5260
5440
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
5261
5441
  type: string;
5262
5442
  /** @deprecated */
5263
5443
  connectedData?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
5444
+ /**
5445
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
5446
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
5447
+ */
5448
+ locales?: {
5449
+ [key: string]: unknown;
5450
+ };
5264
5451
  };
5265
5452
  /** @description Defines a connection to a dynamic token on a data resource. */
5266
5453
  DataElementConnectionDefinition: {
@@ -5382,6 +5569,8 @@ interface external$9 {
5382
5569
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
5383
5570
  */
5384
5571
  _overridability?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
5572
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
5573
+ _locales?: string[];
5385
5574
  };
5386
5575
  /**
5387
5576
  * @description Defines how to override a specific component.
@@ -5613,15 +5802,19 @@ interface external$9 {
5613
5802
  /** @description Unique identifier for the integration that this prompt belongs to. */
5614
5803
  integrationType: string;
5615
5804
  /** @description Name for the prompt */
5616
- promptName?: string | null;
5805
+ name?: string | null;
5617
5806
  /** @description Text for the prompt */
5618
- promptText?: string | null;
5807
+ text?: string | null;
5619
5808
  /** @description Data for the prompt */
5620
- promptData?: string | null;
5809
+ data?: {
5810
+ [key: string]: unknown;
5811
+ } | null;
5621
5812
  /** @description Turn off/on prompt */
5622
5813
  enabled?: boolean | null;
5623
5814
  /** @description Integration default prompt */
5624
5815
  builtIn?: boolean | null;
5816
+ /** @description Supported parameter types */
5817
+ parameterTypes?: string[] | null;
5625
5818
  };
5626
5819
  };
5627
5820
  };
@@ -5757,6 +5950,11 @@ interface external$8 {
5757
5950
  helpText?: string;
5758
5951
  /** @description Type name of the parameter (provided by a Uniform integration) */
5759
5952
  type: string;
5953
+ /**
5954
+ * @description If true, this property can have locale-specific values. If false or not defined,
5955
+ * this property will have a single value that is shared for all locales.
5956
+ */
5957
+ localizable?: boolean;
5760
5958
  /** @description The configuration object for the type (type-specific) */
5761
5959
  typeConfig?: unknown;
5762
5960
  };
@@ -5933,11 +6131,18 @@ interface external$8 {
5933
6131
  /** @description Defines an editable parameter on a component. */
5934
6132
  ComponentParameter: {
5935
6133
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
5936
- value: unknown;
6134
+ value?: unknown;
5937
6135
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
5938
6136
  type: string;
5939
6137
  /** @deprecated */
5940
6138
  connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
6139
+ /**
6140
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
6141
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
6142
+ */
6143
+ locales?: {
6144
+ [key: string]: unknown;
6145
+ };
5941
6146
  };
5942
6147
  /** @description Defines a connection to a dynamic token on a data resource. */
5943
6148
  DataElementConnectionDefinition: {
@@ -6059,6 +6264,8 @@ interface external$8 {
6059
6264
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
6060
6265
  */
6061
6266
  _overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
6267
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
6268
+ _locales?: string[];
6062
6269
  };
6063
6270
  /**
6064
6271
  * @description Defines how to override a specific component.
@@ -6290,15 +6497,19 @@ interface external$8 {
6290
6497
  /** @description Unique identifier for the integration that this prompt belongs to. */
6291
6498
  integrationType: string;
6292
6499
  /** @description Name for the prompt */
6293
- promptName?: string | null;
6500
+ name?: string | null;
6294
6501
  /** @description Text for the prompt */
6295
- promptText?: string | null;
6502
+ text?: string | null;
6296
6503
  /** @description Data for the prompt */
6297
- promptData?: string | null;
6504
+ data?: {
6505
+ [key: string]: unknown;
6506
+ } | null;
6298
6507
  /** @description Turn off/on prompt */
6299
6508
  enabled?: boolean | null;
6300
6509
  /** @description Integration default prompt */
6301
6510
  builtIn?: boolean | null;
6511
+ /** @description Supported parameter types */
6512
+ parameterTypes?: string[] | null;
6302
6513
  };
6303
6514
  };
6304
6515
  };
@@ -6311,11 +6522,11 @@ interface external$8 {
6311
6522
  * Do not make direct changes to the file.
6312
6523
  */
6313
6524
  interface paths$6 {
6314
- "/api/v1/prompt": {
6525
+ "/api/v1/prompts": {
6315
6526
  get: {
6316
6527
  parameters: {
6317
6528
  query: {
6318
- promptId: string;
6529
+ promptId?: string;
6319
6530
  projectId: string;
6320
6531
  };
6321
6532
  };
@@ -6323,9 +6534,7 @@ interface paths$6 {
6323
6534
  /** OK */
6324
6535
  200: {
6325
6536
  content: {
6326
- "application/json": {
6327
- result: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"];
6328
- };
6537
+ "application/json": external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"] | external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"][];
6329
6538
  };
6330
6539
  };
6331
6540
  400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
@@ -6436,6 +6645,11 @@ interface external$7 {
6436
6645
  helpText?: string;
6437
6646
  /** @description Type name of the parameter (provided by a Uniform integration) */
6438
6647
  type: string;
6648
+ /**
6649
+ * @description If true, this property can have locale-specific values. If false or not defined,
6650
+ * this property will have a single value that is shared for all locales.
6651
+ */
6652
+ localizable?: boolean;
6439
6653
  /** @description The configuration object for the type (type-specific) */
6440
6654
  typeConfig?: unknown;
6441
6655
  };
@@ -6612,11 +6826,18 @@ interface external$7 {
6612
6826
  /** @description Defines an editable parameter on a component. */
6613
6827
  ComponentParameter: {
6614
6828
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
6615
- value: unknown;
6829
+ value?: unknown;
6616
6830
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
6617
6831
  type: string;
6618
6832
  /** @deprecated */
6619
6833
  connectedData?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
6834
+ /**
6835
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
6836
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
6837
+ */
6838
+ locales?: {
6839
+ [key: string]: unknown;
6840
+ };
6620
6841
  };
6621
6842
  /** @description Defines a connection to a dynamic token on a data resource. */
6622
6843
  DataElementConnectionDefinition: {
@@ -6738,6 +6959,8 @@ interface external$7 {
6738
6959
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
6739
6960
  */
6740
6961
  _overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
6962
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
6963
+ _locales?: string[];
6741
6964
  };
6742
6965
  /**
6743
6966
  * @description Defines how to override a specific component.
@@ -6969,15 +7192,19 @@ interface external$7 {
6969
7192
  /** @description Unique identifier for the integration that this prompt belongs to. */
6970
7193
  integrationType: string;
6971
7194
  /** @description Name for the prompt */
6972
- promptName?: string | null;
7195
+ name?: string | null;
6973
7196
  /** @description Text for the prompt */
6974
- promptText?: string | null;
7197
+ text?: string | null;
6975
7198
  /** @description Data for the prompt */
6976
- promptData?: string | null;
7199
+ data?: {
7200
+ [key: string]: unknown;
7201
+ } | null;
6977
7202
  /** @description Turn off/on prompt */
6978
7203
  enabled?: boolean | null;
6979
7204
  /** @description Integration default prompt */
6980
7205
  builtIn?: boolean | null;
7206
+ /** @description Supported parameter types */
7207
+ parameterTypes?: string[] | null;
6981
7208
  };
6982
7209
  };
6983
7210
  };
@@ -6985,12 +7212,49 @@ interface external$7 {
6985
7212
  };
6986
7213
  }
6987
7214
 
7215
+ type PromptsApi = paths$6['/api/v1/prompts'];
7216
+ type DataTypeApi = paths$7['/api/v1/data-types'];
7217
+ type DataSourcesApi = paths$8['/api/v1/data-sources'];
7218
+ type DataSourceApi = paths$9['/api/v1/data-source'];
7219
+ /** Query parameter options for GET /api/v1/data-types */
7220
+ type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
7221
+ /** The GET response from /api/v1/data-types */
7222
+ type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
7223
+ /** The PUT request body for /api/v1/data-types */
7224
+ type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
7225
+ /** Shape of the DELETE request body for /api/v1/data-types */
7226
+ type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
7227
+ /** Query parameter options for GET /api/v1/data-source */
7228
+ type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
7229
+ /** Query parameter options for GET /api/v1/data-sources */
7230
+ type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
7231
+ /** The GET response from /api/v1/data-sources */
7232
+ type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
7233
+ /** The GET response from /api/v1/data-sources */
7234
+ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
7235
+ /** The PUT request body for /api/v1/data-source */
7236
+ type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
7237
+ /** Shape of the DELETE request body for /api/v1/data-source */
7238
+ type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
7239
+ /** Query parameter options for GET /api/v1/prompts */
7240
+ type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
7241
+ /** The GET response from /api/v1/prompts */
7242
+ type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
7243
+ /** The PUT request body for /api/v1/prompts */
7244
+ type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
7245
+ /** Shape of the DELETE request body for /api/v1/prompts */
7246
+ type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
7247
+ type DataType = components$5['schemas']['DataType'];
7248
+ type DataSource = components$5['schemas']['DataSource'];
7249
+ type DataVariableDefinition = components$5['schemas']['DataVariableDefinition'];
7250
+ type Prompt = components$5['schemas']['Prompt'];
7251
+
6988
7252
  /**
6989
7253
  * This file was auto-generated by openapi-typescript.
6990
7254
  * Do not make direct changes to the file.
6991
7255
  */
6992
7256
  interface paths$5 {
6993
- "/api/v1/prompts": {
7257
+ "/api/v1/locales": {
6994
7258
  get: {
6995
7259
  parameters: {
6996
7260
  query: {
@@ -6998,11 +7262,11 @@ interface paths$5 {
6998
7262
  };
6999
7263
  };
7000
7264
  responses: {
7001
- /** Gets a list of prompts. */
7265
+ /** Gets a list of all defined locales for a project */
7002
7266
  200: {
7003
7267
  content: {
7004
7268
  "application/json": {
7005
- results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"][];
7269
+ results: components$3["schemas"]["Locale"][];
7006
7270
  };
7007
7271
  };
7008
7272
  };
@@ -7013,6 +7277,75 @@ interface paths$5 {
7013
7277
  500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
7014
7278
  };
7015
7279
  };
7280
+ put: {
7281
+ responses: {
7282
+ /** OK */
7283
+ 204: never;
7284
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
7285
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
7286
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
7287
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
7288
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
7289
+ };
7290
+ requestBody: {
7291
+ content: {
7292
+ "application/json": components$3["schemas"]["LocalePutBody"];
7293
+ };
7294
+ };
7295
+ };
7296
+ delete: {
7297
+ responses: {
7298
+ /** OK */
7299
+ 204: never;
7300
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
7301
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
7302
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
7303
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
7304
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
7305
+ };
7306
+ requestBody: {
7307
+ content: {
7308
+ "application/json": components$3["schemas"]["LocaleDeleteBody"];
7309
+ };
7310
+ };
7311
+ };
7312
+ };
7313
+ }
7314
+ interface components$3 {
7315
+ schemas: {
7316
+ Locale: {
7317
+ /**
7318
+ * @description The locale code
7319
+ * @example en-US
7320
+ */
7321
+ locale: string;
7322
+ /**
7323
+ * @description The locale's display name in the UI
7324
+ * @example English (United States)
7325
+ */
7326
+ displayName: string;
7327
+ /**
7328
+ * @description Whether this is the default locale
7329
+ * @example true
7330
+ */
7331
+ isDefault: boolean;
7332
+ };
7333
+ LocalePutBody: {
7334
+ locale: components$3["schemas"]["Locale"];
7335
+ /**
7336
+ * Format: uuid
7337
+ * @description The project ID
7338
+ */
7339
+ projectId: string;
7340
+ };
7341
+ LocaleDeleteBody: {
7342
+ locale: string;
7343
+ /**
7344
+ * Format: uuid
7345
+ * @description The project ID
7346
+ */
7347
+ projectId: string;
7348
+ };
7016
7349
  };
7017
7350
  }
7018
7351
  interface external$6 {
@@ -7058,641 +7391,50 @@ interface external$6 {
7058
7391
  };
7059
7392
  operations: {};
7060
7393
  };
7061
- "uniform-canvas-types.swagger.yml": {
7062
- paths: {};
7063
- components: {
7064
- schemas: {
7065
- /** @description Public ID (used in code). Do not change after creation. */
7066
- PublicIdProperty: string;
7067
- /** @description The definition of a component parameter */
7068
- ComponentDefinitionParameter: {
7069
- id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
7070
- /** @description Friendly name of the parameter */
7071
- name: string;
7072
- /** @description Appears next to the parameter in the Composition editor */
7073
- helpText?: string;
7074
- /** @description Type name of the parameter (provided by a Uniform integration) */
7075
- type: string;
7076
- /** @description The configuration object for the type (type-specific) */
7077
- typeConfig?: unknown;
7078
- };
7079
- /** @description The definition of a named component slot that can contain other components */
7080
- ComponentDefinitionSlot: {
7081
- id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
7082
- /** @description Friendly name of the slot */
7083
- name: string;
7084
- /** @description A list of component definition public IDs that are allowed in this named slot */
7085
- allowedComponents: string[];
7394
+ }
7395
+
7396
+ type LocalesApi = paths$5['/api/v1/locales'];
7397
+ /** A locale definition */
7398
+ type Locale = components$3['schemas']['Locale'];
7399
+ /** Query parameter options for GET /api/v1/locales */
7400
+ type LocalesGetParameters = LocalesApi['get']['parameters']['query'];
7401
+ /** The GET response from /api/v1/locales */
7402
+ type LocalesGetResponse = LocalesApi['get']['responses']['200']['content']['application/json'];
7403
+ /** The PUT request body for /api/v1/locales */
7404
+ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['application/json'];
7405
+ /** Shape of the DELETE request body for /api/v1/locales */
7406
+ type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
7407
+ declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
7408
+
7409
+ /**
7410
+ * This file was auto-generated by openapi-typescript.
7411
+ * Do not make direct changes to the file.
7412
+ */
7413
+ interface paths$4 {
7414
+ "/api/v1/canvas": {
7415
+ get: {
7416
+ parameters: {
7417
+ query: {
7086
7418
  /**
7087
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
7088
- * If allowAllComponents is true, this value is ignored.
7089
- *
7090
- * @default false
7419
+ * Specify a single composition ID to fetch. Response will be a single composition.
7420
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7091
7421
  */
7092
- inheritAllowedComponents: boolean;
7422
+ compositionId?: components$2["parameters"]["compositionId"];
7093
7423
  /**
7094
- * @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
7095
- * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
7424
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
7425
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7096
7426
  */
7097
- allowAllComponents?: boolean;
7427
+ componentId?: components$2["parameters"]["componentId"];
7098
7428
  /**
7099
- * @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
7100
- * When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
7429
+ * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
7430
+ * Must be used with the `compositionId` parameter.
7101
7431
  */
7102
- patternsInAllowedComponents?: boolean;
7103
- /** @description Minimum valid number of components in this slot */
7104
- minComponents?: number;
7105
- /** @description Maximum valid number of components in this slot */
7106
- maxComponents?: number;
7107
- };
7108
- /** @description The definition of a composition's slug settings */
7109
- ComponentDefinitionSlugSettings: {
7432
+ versionId?: components$2["parameters"]["versionId"];
7110
7433
  /**
7111
- * @description Whether the slug is required
7112
- * no: slug is optional
7113
- * yes: slug is required
7114
- * disabled: slug is disabled and will not be shown in the editor
7115
- *
7116
- * @default no
7117
- * @enum {string}
7434
+ * Specify multiple composition IDs to fetch. Response type will be a list.
7435
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7118
7436
  */
7119
- required?: "no" | "yes" | "disabled";
7120
- /**
7121
- * @description Slug uniqueness configuration.
7122
- * no = no unique constraint
7123
- * local = must be unique within this component type
7124
- * global = must be unique across all component types
7125
- *
7126
- * @enum {string}
7127
- */
7128
- unique?: "no" | "local" | "global";
7129
- /** @description Regular expression slugs must match */
7130
- regularExpression?: string;
7131
- /**
7132
- * @description Custom error message when regular expression validation fails.
7133
- * Has no effect if `regularExpression` is not set.
7134
- */
7135
- regularExpressionMessage?: string;
7136
- };
7137
- /** @description The definition of a component variant */
7138
- ComponentDefinitionVariant: {
7139
- id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
7140
- /** @description Friendly name of the variant */
7141
- name: string;
7142
- };
7143
- /** @description Permission set for a component defintion */
7144
- ComponentDefinitionPermission: {
7145
- roleId: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
7146
- /**
7147
- * @description Permission type for this permission ComponentDefinition:
7148
- * read | write | create | delete
7149
- *
7150
- * @enum {string}
7151
- */
7152
- permission: "read" | "write" | "create" | "delete";
7153
- /** @description State of the component that this permission applies to */
7154
- state: number;
7155
- };
7156
- /** @description Defines a component type that can live on a Composition */
7157
- ComponentDefinition: {
7158
- id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
7159
- /** @description Friendly name of the component definition */
7160
- name: string;
7161
- /**
7162
- * @description Icon name for the component definition (e.g. 'screen')
7163
- * @default screen
7164
- */
7165
- icon?: string;
7166
- /**
7167
- * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
7168
- * The parameter type must support being used as a title parameter for this to work.
7169
- *
7170
- * @default null
7171
- */
7172
- titleParameter?: string | null;
7173
- /**
7174
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
7175
- * @default false
7176
- */
7177
- canBeComposition?: boolean;
7178
- /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
7179
- parameters?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
7180
- /**
7181
- * Format: uuid
7182
- * @description Reference to the category this component definition belongs to
7183
- * @default null
7184
- */
7185
- categoryId?: string | null;
7186
- /**
7187
- * @description Description of the component definition
7188
- * @default null
7189
- */
7190
- description?: string;
7191
- /**
7192
- * @description Description of the component definition
7193
- * @default null
7194
- */
7195
- previewImageUrl?: string;
7196
- /**
7197
- * @description if this component uses team permissions or custom permissions
7198
- * @default true
7199
- */
7200
- useTeamPermissions?: boolean;
7201
- /** @description Custom role permissions for this component definition */
7202
- permissions?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
7203
- /** @description The named slots for this component; placement areas where arrays of other components can be added. */
7204
- slots?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
7205
- slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
7206
- /** @description Default component instance value */
7207
- defaults?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
7208
- /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
7209
- variants?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
7210
- /** @description Created date string for this definition (ignored for writes) */
7211
- created?: string;
7212
- /** @description Last modified date string for this definition (ignored for writes) */
7213
- updated?: string;
7214
- };
7215
- /** @description Defines a content type */
7216
- ContentType: {
7217
- id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
7218
- /** @description Friendly name of the content type */
7219
- name: string;
7220
- /**
7221
- * @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
7222
- * The field type must support being used as an entry name for this to work.
7223
- */
7224
- entryName?: string | null;
7225
- /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
7226
- fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
7227
- /**
7228
- * @description Description of the content type
7229
- * @default null
7230
- */
7231
- description?: string;
7232
- /**
7233
- * @description Icon name for the content type (e.g. 'screen')
7234
- * @default file-document
7235
- */
7236
- icon?: string;
7237
- /** @description Created date string for this content type (ignored for writes) */
7238
- created?: string;
7239
- /** @description Last modified date string for this content type (ignored for writes) */
7240
- updated?: string;
7241
- slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
7242
- /**
7243
- * @description The definition type of this content type (block or content type)
7244
- * @default contentType
7245
- * @enum {string}
7246
- */
7247
- type?: "contentType" | "block";
7248
- };
7249
- /** @description Defines an editable parameter on a component. */
7250
- ComponentParameter: {
7251
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
7252
- value: unknown;
7253
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
7254
- type: string;
7255
- /** @deprecated */
7256
- connectedData?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
7257
- };
7258
- /** @description Defines a connection to a dynamic token on a data resource. */
7259
- DataElementConnectionDefinition: {
7260
- /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
7261
- pointer: string;
7262
- /**
7263
- * @description The syntax used to select the dynamic token to bind to
7264
- * @enum {string}
7265
- */
7266
- syntax: "jptr";
7267
- };
7268
- /** @description Defines the shape of a component instance served by the composition API. */
7269
- ComponentInstance: {
7270
- /** @description Type of the component instance (public_id of its definition) */
7271
- type: string;
7272
- /** @description Component parameter values for the component instance */
7273
- parameters?: {
7274
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
7275
- };
7276
- /** @description Public ID of alternate visual appearance for this component, if any selected */
7277
- variant?: string;
7278
- /** @description Slots containing any child components */
7279
- slots?: {
7280
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
7281
- };
7282
- /**
7283
- * @description Unique identifier of the component within the composition.
7284
- * No assumptions should be made about the format of this value other than "it will be unique."
7285
- * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
7286
- * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
7287
- */
7288
- _id?: string;
7289
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
7290
- _pattern?: string;
7291
- _dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
7292
- /**
7293
- * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
7294
- * Means nothing for PUTs; it will be ignored.
7295
- */
7296
- _patternDataResources?: {
7297
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
7298
- };
7299
- /**
7300
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
7301
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
7302
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
7303
- * Means nothing for PUTs; it will be ignored.
7304
- *
7305
- * @enum {string}
7306
- */
7307
- _patternError?: "NOTFOUND" | "CYCLIC";
7308
- /**
7309
- * @description Defines patch overrides to component IDs that live in the composition.
7310
- * This can be used to override parameters that are defined on patterns,
7311
- * including nested patterns, with values that are specific to this composition.
7312
- * The keys in this object are component IDs.
7313
- * Overrides are applied from the top down, so for example if both the composition
7314
- * and a pattern on the composition define an override on a nested pattern,
7315
- * the composition's override replaces the pattern's.
7316
- *
7317
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7318
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7319
- */
7320
- _overrides?: {
7321
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
7322
- };
7323
- /**
7324
- * @description When used on a pattern, defines how the pattern's parameters may be overridden
7325
- * by consumers of the pattern.
7326
- *
7327
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7328
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7329
- */
7330
- _overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
7331
- };
7332
- /** @description Defines the shape of the root component in a composition */
7333
- RootComponentInstance: {
7334
- /** @description Type of the component instance (public_id of its definition) */
7335
- type: string;
7336
- /** @description Component parameter values for the component instance */
7337
- parameters?: {
7338
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
7339
- };
7340
- /** @description Public ID of alternate visual appearance for this component, if any selected */
7341
- variant?: string;
7342
- /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
7343
- projectMapNodes?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
7344
- /** @description Slots containing any child components */
7345
- slots?: {
7346
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
7347
- };
7348
- /** @description The public UUID of the composition. */
7349
- _id: string;
7350
- /** @description Slug pattern of this component. */
7351
- _slug?: string | null;
7352
- /** @description Friendly name of this component. */
7353
- _name: string;
7354
- _dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
7355
- /**
7356
- * @description Defines patch overrides to component IDs that live in the composition.
7357
- * This can be used to override parameters that are defined on patterns,
7358
- * including nested patterns, with values that are specific to this composition.
7359
- * The keys in this object are component IDs.
7360
- * Overrides are applied from the top down, so for example if both the composition
7361
- * and a pattern on the composition define an override on a nested pattern,
7362
- * the composition's override replaces the pattern's.
7363
- *
7364
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7365
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7366
- */
7367
- _overrides?: {
7368
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
7369
- };
7370
- /**
7371
- * @description When used on a pattern, defines how the pattern's parameters may be overridden
7372
- * by consumers of the pattern.
7373
- *
7374
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7375
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7376
- */
7377
- _overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
7378
- };
7379
- /**
7380
- * @description Defines how to override a specific component.
7381
- *
7382
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7383
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7384
- */
7385
- ComponentOverride: {
7386
- parameters?: {
7387
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
7388
- };
7389
- variant?: string;
7390
- };
7391
- /**
7392
- * @description Defines how a component on a pattern may have its values overridden.
7393
- * NOTE: Data resources' overridability is defined in the data resource definition, not here.
7394
- *
7395
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7396
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7397
- */
7398
- ComponentOverridability: {
7399
- /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
7400
- parameters?: {
7401
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
7402
- };
7403
- /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
7404
- variants?: boolean;
7405
- };
7406
- /**
7407
- * @description Whether a parameter is overridable
7408
- *
7409
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
7410
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
7411
- *
7412
- * @enum {string}
7413
- */
7414
- OverrideOptions: "yes" | "no";
7415
- /**
7416
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
7417
- * These are created in the UI and shared across a whole project.
7418
- * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
7419
- * for all header, parameter, and variable values to obscure the actual encrypted secret value.
7420
- */
7421
- DataSource: {
7422
- /** @description Public ID of the data source */
7423
- id: string;
7424
- /** @description Display name of the data source */
7425
- displayName: string;
7426
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
7427
- connectorType: string;
7428
- /** @description Base resource URL of the data source. No trailing slash. */
7429
- baseUrl: string;
7430
- /** @description HTTP headers to pass with requests to the data source */
7431
- headers?: {
7432
- key: string;
7433
- value: string;
7434
- }[];
7435
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
7436
- parameters?: {
7437
- key: string;
7438
- value: string;
7439
- }[];
7440
- /** @description Variables needed to make calls to the data source */
7441
- variables?: {
7442
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
7443
- };
7444
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
7445
- custom?: {
7446
- [key: string]: unknown;
7447
- };
7448
- };
7449
- /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
7450
- DataType: {
7451
- /** @description Public ID of the data type */
7452
- id: string;
7453
- /** @description Display name of the data type */
7454
- displayName: string;
7455
- /** @description Public ID of the associated data source */
7456
- dataSourceId: string;
7457
- /**
7458
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
7459
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
7460
- * no special UI or processing is required.
7461
- */
7462
- archetype?: string;
7463
- allowedOnComponents?: string[];
7464
- /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
7465
- path: string;
7466
- /** @description Time-to-live (in seconds) for the resource data cache. */
7467
- ttl?: number;
7468
- /** @description A key for the resource data cache purging. */
7469
- purgeKey?: string;
7470
- /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
7471
- badgeIconUrl?: string;
7472
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
7473
- headers?: {
7474
- key: string;
7475
- value: string;
7476
- omitIfEmpty?: boolean;
7477
- }[];
7478
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
7479
- parameters?: {
7480
- key: string;
7481
- value: string;
7482
- omitIfEmpty?: boolean;
7483
- }[];
7484
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
7485
- body?: string;
7486
- /**
7487
- * @description HTTP method to use with requests to the data type.
7488
- * @default GET
7489
- * @enum {string}
7490
- */
7491
- method: "GET" | "POST" | "HEAD";
7492
- /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
7493
- variables?: {
7494
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
7495
- };
7496
- /** @description Custom configuration specific to the data source being defined */
7497
- custom?: {
7498
- [key: string]: unknown;
7499
- };
7500
- };
7501
- /** @description Defines the shape of a data variable on a Data Source or Data Type */
7502
- DataVariableDefinition: {
7503
- /** @description Display name of the data variable */
7504
- displayName?: string;
7505
- /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
7506
- helpText?: string;
7507
- /**
7508
- * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
7509
- * @default text
7510
- */
7511
- type?: string;
7512
- /** @description Default value of the data variable */
7513
- default: string;
7514
- /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
7515
- order?: number;
7516
- /**
7517
- * @description An optional arbitrary human readable source identifier to describe where this variable is from.
7518
- * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
7519
- */
7520
- source?: string;
7521
- };
7522
- /**
7523
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
7524
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
7525
- */
7526
- DataResourceDefinitions: {
7527
- [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
7528
- };
7529
- /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
7530
- DataResourceDefinition: {
7531
- /** @description Public ID of the data type that provides this data */
7532
- type: string;
7533
- /** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
7534
- isPatternParameter?: boolean;
7535
- /**
7536
- * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
7537
- * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
7538
- * If isPatternParameter is false or undefined, this has no meaning.
7539
- */
7540
- ignorePatternParameterDefault?: boolean;
7541
- variables?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
7542
- };
7543
- /** @description Variable values for a data resource. */
7544
- DataResourceVariables: {
7545
- [key: string]: string;
7546
- };
7547
- HistoryApiResponse: {
7548
- /**
7549
- * @description If there are more results, this will be populated with a token to pass in the next request to get the next page of results.
7550
- * If this is undefined then no more results are available.
7551
- */
7552
- cursor?: string;
7553
- /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
7554
- truncated?: boolean;
7555
- /** @description Version history entries. */
7556
- results?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
7557
- };
7558
- HistoryEntry: {
7559
- /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
7560
- versionId: string;
7561
- /** @description The timestamp when the version was created in epoch milliseconds. */
7562
- timestamp: number;
7563
- /** @description The name (full name) of the user who created the version. */
7564
- authorName: string;
7565
- authorIsApiKey: boolean;
7566
- /** @description The state of the entity when the history entry was made. */
7567
- state: number;
7568
- };
7569
- /** @description Category for tagging canvas entities */
7570
- Category: {
7571
- /**
7572
- * Format: uuid
7573
- * @description Unique identifier for the category
7574
- */
7575
- id: string;
7576
- /** @description Display name of the category */
7577
- name: string;
7578
- /**
7579
- * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
7580
- * @default 0
7581
- */
7582
- order?: number;
7583
- };
7584
- /** @description Project map node information related to a component. */
7585
- CompositionProjectMapNodeInfo: {
7586
- /**
7587
- * Format: uuid
7588
- * @description Unique identifier for the project map node
7589
- */
7590
- id: string;
7591
- /** @description Path of the project map node */
7592
- path: string;
7593
- /**
7594
- * Format: uuid
7595
- * @description Unique identifier for the project map that this node belongs to.
7596
- */
7597
- projectMapId: string;
7598
- };
7599
- /** @description AI Prompt definition. */
7600
- Prompt: {
7601
- /**
7602
- * Format: uuid
7603
- * @description Unique identifier for the prompt
7604
- */
7605
- id: string;
7606
- /** @description Unique identifier for the integration that this prompt belongs to. */
7607
- integrationType: string;
7608
- /** @description Name for the prompt */
7609
- promptName?: string | null;
7610
- /** @description Text for the prompt */
7611
- promptText?: string | null;
7612
- /** @description Data for the prompt */
7613
- promptData?: string | null;
7614
- /** @description Turn off/on prompt */
7615
- enabled?: boolean | null;
7616
- /** @description Integration default prompt */
7617
- builtIn?: boolean | null;
7618
- };
7619
- };
7620
- };
7621
- operations: {};
7622
- };
7623
- }
7624
-
7625
- type PromptApi = paths$6['/api/v1/prompt'];
7626
- type PromptsApi = paths$5['/api/v1/prompts'];
7627
- type DataTypeApi = paths$7['/api/v1/data-types'];
7628
- type DataSourcesApi = paths$8['/api/v1/data-sources'];
7629
- type DataSourceApi = paths$9['/api/v1/data-source'];
7630
- /** Query parameter options for GET /api/v1/data-types */
7631
- type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
7632
- /** The GET response from /api/v1/data-types */
7633
- type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
7634
- /** The PUT request body for /api/v1/data-types */
7635
- type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
7636
- /** Shape of the DELETE request body for /api/v1/data-types */
7637
- type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
7638
- /** Query parameter options for GET /api/v1/data-source */
7639
- type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
7640
- /** Query parameter options for GET /api/v1/data-sources */
7641
- type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
7642
- /** The GET response from /api/v1/data-sources */
7643
- type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
7644
- /** The GET response from /api/v1/data-sources */
7645
- type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
7646
- /** The PUT request body for /api/v1/data-source */
7647
- type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
7648
- /** Shape of the DELETE request body for /api/v1/data-source */
7649
- type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
7650
- /** Query parameter options for GET /api/v1/prompt */
7651
- type PromptGetParameters = PromptApi['get']['parameters']['query'];
7652
- /** The GET response from /api/v1/prompt */
7653
- type PromptGetResponse = PromptApi['get']['responses']['200']['content']['application/json'];
7654
- /** The PUT request body for /api/v1/prompt */
7655
- type PromptPutParameters = PromptApi['put']['requestBody']['content']['application/json'];
7656
- /** Shape of the DELETE request body for /api/v1/prompt */
7657
- type PromptDeleteParameters = PromptApi['delete']['requestBody']['content']['application/json'];
7658
- /** Query parameter options for GET /api/v1/prompts */
7659
- type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
7660
- /** The GET response from /api/v1/prompts */
7661
- type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
7662
- type DataType = components$4['schemas']['DataType'];
7663
- type DataSource = components$4['schemas']['DataSource'];
7664
- type DataVariableDefinition = components$4['schemas']['DataVariableDefinition'];
7665
- type Prompt = components$4['schemas']['Prompt'];
7666
-
7667
- /**
7668
- * This file was auto-generated by openapi-typescript.
7669
- * Do not make direct changes to the file.
7670
- */
7671
- interface paths$4 {
7672
- "/api/v1/canvas": {
7673
- get: {
7674
- parameters: {
7675
- query: {
7676
- /**
7677
- * Specify a single composition ID to fetch. Response will be a single composition.
7678
- * This is a primary query parameter, and cannot be used with any other primary query parameters.
7679
- */
7680
- compositionId?: components$2["parameters"]["compositionId"];
7681
- /**
7682
- * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
7683
- * This is a primary query parameter, and cannot be used with any other primary query parameters.
7684
- */
7685
- componentId?: components$2["parameters"]["componentId"];
7686
- /**
7687
- * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
7688
- * Must be used with the `compositionId` parameter.
7689
- */
7690
- versionId?: components$2["parameters"]["versionId"];
7691
- /**
7692
- * Specify multiple composition IDs to fetch. Response type will be a list.
7693
- * This is a primary query parameter, and cannot be used with any other primary query parameters.
7694
- */
7695
- compositionIDs?: components$2["parameters"]["compositionIDs"];
7437
+ compositionIDs?: components$2["parameters"]["compositionIDs"];
7696
7438
  /**
7697
7439
  * Filters composition lists by the user who created them. The user is specified by their identity subject.
7698
7440
  * This is a list query parameter, and cannot be used with any primary query parameters.
@@ -7818,6 +7560,20 @@ interface paths$4 {
7818
7560
  withProjectMapNodes?: components$2["parameters"]["withProjectMapNodes"];
7819
7561
  /** @deprecated Includes content source map metadata on supported parameters */
7820
7562
  withContentSourceMap?: components$2["parameters"]["withContentSourceMap"];
7563
+ /**
7564
+ * One or more locales to filter and localize by.
7565
+ * For list responses, only compositions which enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
7566
+ * For all types of response, the response will be localized to include only the first matching locale's data.
7567
+ *
7568
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
7569
+ * en-US
7570
+ * fr-CA,fr
7571
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
7572
+ *
7573
+ * When this parameter is not passed, all locales' data will be returned.
7574
+ * If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned.
7575
+ */
7576
+ locale?: components$2["parameters"]["locale"];
7821
7577
  };
7822
7578
  };
7823
7579
  responses: {
@@ -8133,7 +7889,21 @@ interface components$2 {
8133
7889
  * @description Controls whether the total count of results will be returned along with the current results page in a list.
8134
7890
  * Has no effect when not fetching a list. This does impact performance when enabled.
8135
7891
  */
8136
- withTotalCount: boolean;
7892
+ withTotalCount: boolean;
7893
+ /**
7894
+ * @description One or more locales to filter and localize by.
7895
+ * For list responses, only compositions which enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
7896
+ * For all types of response, the response will be localized to include only the first matching locale's data.
7897
+ *
7898
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
7899
+ * en-US
7900
+ * fr-CA,fr
7901
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
7902
+ *
7903
+ * When this parameter is not passed, all locales' data will be returned.
7904
+ * If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned.
7905
+ */
7906
+ locale: string;
8137
7907
  };
8138
7908
  }
8139
7909
  interface external$5 {
@@ -8194,6 +7964,11 @@ interface external$5 {
8194
7964
  helpText?: string;
8195
7965
  /** @description Type name of the parameter (provided by a Uniform integration) */
8196
7966
  type: string;
7967
+ /**
7968
+ * @description If true, this property can have locale-specific values. If false or not defined,
7969
+ * this property will have a single value that is shared for all locales.
7970
+ */
7971
+ localizable?: boolean;
8197
7972
  /** @description The configuration object for the type (type-specific) */
8198
7973
  typeConfig?: unknown;
8199
7974
  };
@@ -8370,11 +8145,18 @@ interface external$5 {
8370
8145
  /** @description Defines an editable parameter on a component. */
8371
8146
  ComponentParameter: {
8372
8147
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
8373
- value: unknown;
8148
+ value?: unknown;
8374
8149
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
8375
8150
  type: string;
8376
8151
  /** @deprecated */
8377
8152
  connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
8153
+ /**
8154
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
8155
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
8156
+ */
8157
+ locales?: {
8158
+ [key: string]: unknown;
8159
+ };
8378
8160
  };
8379
8161
  /** @description Defines a connection to a dynamic token on a data resource. */
8380
8162
  DataElementConnectionDefinition: {
@@ -8496,6 +8278,8 @@ interface external$5 {
8496
8278
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
8497
8279
  */
8498
8280
  _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
8281
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
8282
+ _locales?: string[];
8499
8283
  };
8500
8284
  /**
8501
8285
  * @description Defines how to override a specific component.
@@ -8727,15 +8511,19 @@ interface external$5 {
8727
8511
  /** @description Unique identifier for the integration that this prompt belongs to. */
8728
8512
  integrationType: string;
8729
8513
  /** @description Name for the prompt */
8730
- promptName?: string | null;
8514
+ name?: string | null;
8731
8515
  /** @description Text for the prompt */
8732
- promptText?: string | null;
8516
+ text?: string | null;
8733
8517
  /** @description Data for the prompt */
8734
- promptData?: string | null;
8518
+ data?: {
8519
+ [key: string]: unknown;
8520
+ } | null;
8735
8521
  /** @description Turn off/on prompt */
8736
8522
  enabled?: boolean | null;
8737
8523
  /** @description Integration default prompt */
8738
8524
  builtIn?: boolean | null;
8525
+ /** @description Supported parameter types */
8526
+ parameterTypes?: string[] | null;
8739
8527
  };
8740
8528
  };
8741
8529
  };
@@ -8840,6 +8628,11 @@ interface external$4 {
8840
8628
  helpText?: string;
8841
8629
  /** @description Type name of the parameter (provided by a Uniform integration) */
8842
8630
  type: string;
8631
+ /**
8632
+ * @description If true, this property can have locale-specific values. If false or not defined,
8633
+ * this property will have a single value that is shared for all locales.
8634
+ */
8635
+ localizable?: boolean;
8843
8636
  /** @description The configuration object for the type (type-specific) */
8844
8637
  typeConfig?: unknown;
8845
8638
  };
@@ -9016,11 +8809,18 @@ interface external$4 {
9016
8809
  /** @description Defines an editable parameter on a component. */
9017
8810
  ComponentParameter: {
9018
8811
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
9019
- value: unknown;
8812
+ value?: unknown;
9020
8813
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
9021
8814
  type: string;
9022
8815
  /** @deprecated */
9023
8816
  connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
8817
+ /**
8818
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
8819
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
8820
+ */
8821
+ locales?: {
8822
+ [key: string]: unknown;
8823
+ };
9024
8824
  };
9025
8825
  /** @description Defines a connection to a dynamic token on a data resource. */
9026
8826
  DataElementConnectionDefinition: {
@@ -9142,6 +8942,8 @@ interface external$4 {
9142
8942
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
9143
8943
  */
9144
8944
  _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
8945
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
8946
+ _locales?: string[];
9145
8947
  };
9146
8948
  /**
9147
8949
  * @description Defines how to override a specific component.
@@ -9373,15 +9175,19 @@ interface external$4 {
9373
9175
  /** @description Unique identifier for the integration that this prompt belongs to. */
9374
9176
  integrationType: string;
9375
9177
  /** @description Name for the prompt */
9376
- promptName?: string | null;
9178
+ name?: string | null;
9377
9179
  /** @description Text for the prompt */
9378
- promptText?: string | null;
9180
+ text?: string | null;
9379
9181
  /** @description Data for the prompt */
9380
- promptData?: string | null;
9182
+ data?: {
9183
+ [key: string]: unknown;
9184
+ } | null;
9381
9185
  /** @description Turn off/on prompt */
9382
9186
  enabled?: boolean | null;
9383
9187
  /** @description Integration default prompt */
9384
9188
  builtIn?: boolean | null;
9189
+ /** @description Supported parameter types */
9190
+ parameterTypes?: string[] | null;
9385
9191
  };
9386
9192
  };
9387
9193
  };
@@ -9420,7 +9226,7 @@ interface components$1 {
9420
9226
  } & external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
9421
9227
  EdgehancersResolutionInfo: {
9422
9228
  diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
9423
- [key: string]: unknown;
9229
+ data?: components$1["schemas"]["DataDiagnostic"][];
9424
9230
  };
9425
9231
  errors?: components$1["schemas"]["DataResolutionIssue"][];
9426
9232
  warnings?: components$1["schemas"]["DataResolutionIssue"][];
@@ -9502,6 +9308,7 @@ interface components$1 {
9502
9308
  dataType?: string;
9503
9309
  inputName?: string;
9504
9310
  code?: string;
9311
+ locale?: string;
9505
9312
  };
9506
9313
  };
9507
9314
  responses: {
@@ -9613,6 +9420,11 @@ interface external$3 {
9613
9420
  helpText?: string;
9614
9421
  /** @description Type name of the parameter (provided by a Uniform integration) */
9615
9422
  type: string;
9423
+ /**
9424
+ * @description If true, this property can have locale-specific values. If false or not defined,
9425
+ * this property will have a single value that is shared for all locales.
9426
+ */
9427
+ localizable?: boolean;
9616
9428
  /** @description The configuration object for the type (type-specific) */
9617
9429
  typeConfig?: unknown;
9618
9430
  };
@@ -9789,11 +9601,18 @@ interface external$3 {
9789
9601
  /** @description Defines an editable parameter on a component. */
9790
9602
  ComponentParameter: {
9791
9603
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
9792
- value: unknown;
9604
+ value?: unknown;
9793
9605
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
9794
9606
  type: string;
9795
9607
  /** @deprecated */
9796
9608
  connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
9609
+ /**
9610
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
9611
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
9612
+ */
9613
+ locales?: {
9614
+ [key: string]: unknown;
9615
+ };
9797
9616
  };
9798
9617
  /** @description Defines a connection to a dynamic token on a data resource. */
9799
9618
  DataElementConnectionDefinition: {
@@ -9915,6 +9734,8 @@ interface external$3 {
9915
9734
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
9916
9735
  */
9917
9736
  _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
9737
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
9738
+ _locales?: string[];
9918
9739
  };
9919
9740
  /**
9920
9741
  * @description Defines how to override a specific component.
@@ -10146,15 +9967,19 @@ interface external$3 {
10146
9967
  /** @description Unique identifier for the integration that this prompt belongs to. */
10147
9968
  integrationType: string;
10148
9969
  /** @description Name for the prompt */
10149
- promptName?: string | null;
9970
+ name?: string | null;
10150
9971
  /** @description Text for the prompt */
10151
- promptText?: string | null;
9972
+ text?: string | null;
10152
9973
  /** @description Data for the prompt */
10153
- promptData?: string | null;
9974
+ data?: {
9975
+ [key: string]: unknown;
9976
+ } | null;
10154
9977
  /** @description Turn off/on prompt */
10155
9978
  enabled?: boolean | null;
10156
9979
  /** @description Integration default prompt */
10157
9980
  builtIn?: boolean | null;
9981
+ /** @description Supported parameter types */
9982
+ parameterTypes?: string[] | null;
10158
9983
  };
10159
9984
  };
10160
9985
  };
@@ -10311,6 +10136,20 @@ interface external$3 {
10311
10136
  withProjectMapNodes?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
10312
10137
  /** @deprecated Includes content source map metadata on supported parameters */
10313
10138
  withContentSourceMap?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withContentSourceMap"];
10139
+ /**
10140
+ * One or more locales to filter and localize by.
10141
+ * For list responses, only compositions which enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
10142
+ * For all types of response, the response will be localized to include only the first matching locale's data.
10143
+ *
10144
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
10145
+ * en-US
10146
+ * fr-CA,fr
10147
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
10148
+ *
10149
+ * When this parameter is not passed, all locales' data will be returned.
10150
+ * If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned.
10151
+ */
10152
+ locale?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["locale"];
10314
10153
  };
10315
10154
  };
10316
10155
  responses: {
@@ -10627,6 +10466,20 @@ interface external$3 {
10627
10466
  * Has no effect when not fetching a list. This does impact performance when enabled.
10628
10467
  */
10629
10468
  withTotalCount: boolean;
10469
+ /**
10470
+ * @description One or more locales to filter and localize by.
10471
+ * For list responses, only compositions which enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
10472
+ * For all types of response, the response will be localized to include only the first matching locale's data.
10473
+ *
10474
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
10475
+ * en-US
10476
+ * fr-CA,fr
10477
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
10478
+ *
10479
+ * When this parameter is not passed, all locales' data will be returned.
10480
+ * If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned.
10481
+ */
10482
+ locale: string;
10630
10483
  };
10631
10484
  };
10632
10485
  operations: {};
@@ -10684,6 +10537,25 @@ interface external$3 {
10684
10537
  withComponentIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
10685
10538
  /** Performs keyword search on the entries. */
10686
10539
  keyword?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["keyword"];
10540
+ /**
10541
+ * If true, any pattern override data is not resolved by the API.
10542
+ * This is intended for internal use in the Canvas editor, and should not be used.
10543
+ * Passing this parameter automatically implies withComponentIDs to be true.
10544
+ */
10545
+ skipOverridesResolution?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
10546
+ /**
10547
+ * One or more locales to filter and localize by.
10548
+ * Only entries which enable one of the specified locales _or enable no locales_ will be returned.
10549
+ * The response will be localized to include only the first matching locale's data.
10550
+ *
10551
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
10552
+ * en-US
10553
+ * fr-CA,fr
10554
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
10555
+ *
10556
+ * When this parameter is not passed, all locales' data will be returned.
10557
+ */
10558
+ locale?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["locale"];
10687
10559
  };
10688
10560
  };
10689
10561
  responses: {
@@ -10792,6 +10664,8 @@ interface external$3 {
10792
10664
  _slug?: string;
10793
10665
  /** @description Name of the author of the most recent change. */
10794
10666
  _author?: string;
10667
+ /** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
10668
+ _locales?: string[];
10795
10669
  /** @description Entry field values. */
10796
10670
  fields?: {
10797
10671
  [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
@@ -10816,6 +10690,8 @@ interface external$3 {
10816
10690
  [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
10817
10691
  };
10818
10692
  _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
10693
+ /** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
10694
+ _locales?: string[];
10819
10695
  };
10820
10696
  EntryApiResponse: {
10821
10697
  /** @description Publishing state to fetch. 0 = draft, 64 = published. */
@@ -10899,6 +10775,25 @@ interface external$3 {
10899
10775
  withTotalCount: boolean;
10900
10776
  /** @description Performs keyword search on the entries. */
10901
10777
  keyword: string;
10778
+ /**
10779
+ * @description If true, any pattern override data is not resolved by the API.
10780
+ * This is intended for internal use in the Canvas editor, and should not be used.
10781
+ * Passing this parameter automatically implies withComponentIDs to be true.
10782
+ */
10783
+ skipOverridesResolution: boolean;
10784
+ /**
10785
+ * @description One or more locales to filter and localize by.
10786
+ * Only entries which enable one of the specified locales _or enable no locales_ will be returned.
10787
+ * The response will be localized to include only the first matching locale's data.
10788
+ *
10789
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
10790
+ * en-US
10791
+ * fr-CA,fr
10792
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
10793
+ *
10794
+ * When this parameter is not passed, all locales' data will be returned.
10795
+ */
10796
+ locale: string;
10902
10797
  };
10903
10798
  };
10904
10799
  operations: {};
@@ -11141,6 +11036,23 @@ interface external$3 {
11141
11036
  withComponentIDs?: external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
11142
11037
  /** @deprecated Includes content source map metadata on supported parameters */
11143
11038
  withContentSourceMap?: external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["withContentSourceMap"];
11039
+ /**
11040
+ * One or more locales to localize the response to.
11041
+ * When the result is a composition, it includes only the first matching locale's data.
11042
+ * If no matching locale is found, the response will be a not-found result.
11043
+ *
11044
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
11045
+ * en-US
11046
+ * fr-CA,fr
11047
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
11048
+ *
11049
+ * When this parameter is not passed:
11050
+ * - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
11051
+ * - Otherwise, all locales' data is returned.
11052
+ *
11053
+ * When the result is a redirect, this parameter has no effect.
11054
+ */
11055
+ locale?: external$3["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["locale"];
11144
11056
  };
11145
11057
  };
11146
11058
  responses: {
@@ -11240,6 +11152,23 @@ interface external$3 {
11240
11152
  * @description Includes content source map metadata on supported parameters
11241
11153
  */
11242
11154
  withContentSourceMap: boolean;
11155
+ /**
11156
+ * @description One or more locales to localize the response to.
11157
+ * When the result is a composition, it includes only the first matching locale's data.
11158
+ * If no matching locale is found, the response will be a not-found result.
11159
+ *
11160
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
11161
+ * en-US
11162
+ * fr-CA,fr
11163
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
11164
+ *
11165
+ * When this parameter is not passed:
11166
+ * - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
11167
+ * - Otherwise, all locales' data is returned.
11168
+ *
11169
+ * When the result is a redirect, this parameter has no effect.
11170
+ */
11171
+ locale: string;
11243
11172
  };
11244
11173
  };
11245
11174
  operations: {};
@@ -11289,6 +11218,23 @@ interface paths$2 {
11289
11218
  withComponentIDs?: components["parameters"]["withComponentIDs"];
11290
11219
  /** @deprecated Includes content source map metadata on supported parameters */
11291
11220
  withContentSourceMap?: components["parameters"]["withContentSourceMap"];
11221
+ /**
11222
+ * One or more locales to localize the response to.
11223
+ * When the result is a composition, it includes only the first matching locale's data.
11224
+ * If no matching locale is found, the response will be a not-found result.
11225
+ *
11226
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
11227
+ * en-US
11228
+ * fr-CA,fr
11229
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
11230
+ *
11231
+ * When this parameter is not passed:
11232
+ * - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
11233
+ * - Otherwise, all locales' data is returned.
11234
+ *
11235
+ * When the result is a redirect, this parameter has no effect.
11236
+ */
11237
+ locale?: components["parameters"]["locale"];
11292
11238
  };
11293
11239
  };
11294
11240
  responses: {
@@ -11388,6 +11334,23 @@ interface components {
11388
11334
  * @description Includes content source map metadata on supported parameters
11389
11335
  */
11390
11336
  withContentSourceMap: boolean;
11337
+ /**
11338
+ * @description One or more locales to localize the response to.
11339
+ * When the result is a composition, it includes only the first matching locale's data.
11340
+ * If no matching locale is found, the response will be a not-found result.
11341
+ *
11342
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
11343
+ * en-US
11344
+ * fr-CA,fr
11345
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
11346
+ *
11347
+ * When this parameter is not passed:
11348
+ * - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
11349
+ * - Otherwise, all locales' data is returned.
11350
+ *
11351
+ * When the result is a redirect, this parameter has no effect.
11352
+ */
11353
+ locale: string;
11391
11354
  };
11392
11355
  }
11393
11356
  interface external$2 {
@@ -11448,6 +11411,11 @@ interface external$2 {
11448
11411
  helpText?: string;
11449
11412
  /** @description Type name of the parameter (provided by a Uniform integration) */
11450
11413
  type: string;
11414
+ /**
11415
+ * @description If true, this property can have locale-specific values. If false or not defined,
11416
+ * this property will have a single value that is shared for all locales.
11417
+ */
11418
+ localizable?: boolean;
11451
11419
  /** @description The configuration object for the type (type-specific) */
11452
11420
  typeConfig?: unknown;
11453
11421
  };
@@ -11624,11 +11592,18 @@ interface external$2 {
11624
11592
  /** @description Defines an editable parameter on a component. */
11625
11593
  ComponentParameter: {
11626
11594
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
11627
- value: unknown;
11595
+ value?: unknown;
11628
11596
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
11629
11597
  type: string;
11630
11598
  /** @deprecated */
11631
11599
  connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
11600
+ /**
11601
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
11602
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
11603
+ */
11604
+ locales?: {
11605
+ [key: string]: unknown;
11606
+ };
11632
11607
  };
11633
11608
  /** @description Defines a connection to a dynamic token on a data resource. */
11634
11609
  DataElementConnectionDefinition: {
@@ -11750,6 +11725,8 @@ interface external$2 {
11750
11725
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
11751
11726
  */
11752
11727
  _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
11728
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
11729
+ _locales?: string[];
11753
11730
  };
11754
11731
  /**
11755
11732
  * @description Defines how to override a specific component.
@@ -11981,15 +11958,19 @@ interface external$2 {
11981
11958
  /** @description Unique identifier for the integration that this prompt belongs to. */
11982
11959
  integrationType: string;
11983
11960
  /** @description Name for the prompt */
11984
- promptName?: string | null;
11961
+ name?: string | null;
11985
11962
  /** @description Text for the prompt */
11986
- promptText?: string | null;
11963
+ text?: string | null;
11987
11964
  /** @description Data for the prompt */
11988
- promptData?: string | null;
11965
+ data?: {
11966
+ [key: string]: unknown;
11967
+ } | null;
11989
11968
  /** @description Turn off/on prompt */
11990
11969
  enabled?: boolean | null;
11991
11970
  /** @description Integration default prompt */
11992
11971
  builtIn?: boolean | null;
11972
+ /** @description Supported parameter types */
11973
+ parameterTypes?: string[] | null;
11993
11974
  };
11994
11975
  };
11995
11976
  };
@@ -12146,6 +12127,20 @@ interface external$2 {
12146
12127
  withProjectMapNodes?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
12147
12128
  /** @deprecated Includes content source map metadata on supported parameters */
12148
12129
  withContentSourceMap?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["withContentSourceMap"];
12130
+ /**
12131
+ * One or more locales to filter and localize by.
12132
+ * For list responses, only compositions which enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
12133
+ * For all types of response, the response will be localized to include only the first matching locale's data.
12134
+ *
12135
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
12136
+ * en-US
12137
+ * fr-CA,fr
12138
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
12139
+ *
12140
+ * When this parameter is not passed, all locales' data will be returned.
12141
+ * If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned.
12142
+ */
12143
+ locale?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["locale"];
12149
12144
  };
12150
12145
  };
12151
12146
  responses: {
@@ -12462,6 +12457,20 @@ interface external$2 {
12462
12457
  * Has no effect when not fetching a list. This does impact performance when enabled.
12463
12458
  */
12464
12459
  withTotalCount: boolean;
12460
+ /**
12461
+ * @description One or more locales to filter and localize by.
12462
+ * For list responses, only compositions which enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
12463
+ * For all types of response, the response will be localized to include only the first matching locale's data.
12464
+ *
12465
+ * This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
12466
+ * en-US
12467
+ * fr-CA,fr
12468
+ * de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
12469
+ *
12470
+ * When this parameter is not passed, all locales' data will be returned.
12471
+ * If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned.
12472
+ */
12473
+ locale: string;
12465
12474
  };
12466
12475
  };
12467
12476
  operations: {};
@@ -12667,7 +12676,7 @@ interface external$2 {
12667
12676
  }
12668
12677
 
12669
12678
  type Components = components$2['schemas'];
12670
- type SharedComponents = components$4['schemas'];
12679
+ type SharedComponents = components$5['schemas'];
12671
12680
  type Api = paths$4['/api/v1/canvas'];
12672
12681
  type HistoryApi = paths$3['/api/v1/canvas-history'];
12673
12682
  /** Query parameter options for GET /api/v1/canvas */
@@ -12694,7 +12703,7 @@ type CompositionDeleteParameters = Api['delete']['requestBody']['content']['appl
12694
12703
  /** Defines an editable parameter on a component. */
12695
12704
  type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
12696
12705
  /** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
12697
- value: TValue;
12706
+ value?: TValue;
12698
12707
  };
12699
12708
  /** Parameter which stores blocks of entry types */
12700
12709
  type ComponentParameterBlock = Omit<ComponentParameter<BlockValue>, 'type'> & {
@@ -12760,9 +12769,10 @@ type CanvasDefinitions = {
12760
12769
  entries?: Array<Entry>;
12761
12770
  prompts?: Array<Prompt>;
12762
12771
  assets?: Array<AssetGetResponseSingle>;
12772
+ locales?: Array<Locale>;
12763
12773
  };
12764
12774
  /** Defines shared parameters for requests getting a single composition */
12765
- type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
12775
+ type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale'>;
12766
12776
  type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
12767
12777
  type SpecificProjectMap = {
12768
12778
  projectMapId?: string;
@@ -12848,7 +12858,7 @@ type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
12848
12858
  type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
12849
12859
  /** The GET response from /api/v1/entries */
12850
12860
  type EntriesGetParameters = paths$b['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
12851
- type EntriesGetResponse = components$3['schemas']['EntryListResponse'];
12861
+ type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
12852
12862
  type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
12853
12863
  /** GET response from uniform.global/api/v1/route when result is a composition */
12854
12864
  type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
@@ -12918,6 +12928,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
12918
12928
  name: string;
12919
12929
  helpText?: string | undefined;
12920
12930
  type: string;
12931
+ localizable?: boolean | undefined;
12921
12932
  typeConfig?: unknown;
12922
12933
  }[] | undefined;
12923
12934
  categoryId?: string | null | undefined;
@@ -12949,12 +12960,15 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
12949
12960
  type: string;
12950
12961
  parameters?: {
12951
12962
  [key: string]: {
12952
- value: unknown;
12963
+ value?: unknown;
12953
12964
  type: string;
12954
12965
  connectedData?: {
12955
12966
  pointer: string;
12956
12967
  syntax: "jptr";
12957
12968
  } | undefined;
12969
+ locales?: {
12970
+ [key: string]: unknown;
12971
+ } | undefined;
12958
12972
  };
12959
12973
  } | undefined;
12960
12974
  variant?: string | undefined;
@@ -12988,12 +13002,15 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
12988
13002
  [key: string]: {
12989
13003
  parameters?: {
12990
13004
  [key: string]: {
12991
- value: unknown;
13005
+ value?: unknown;
12992
13006
  type: string;
12993
13007
  connectedData?: {
12994
13008
  pointer: string;
12995
13009
  syntax: "jptr";
12996
13010
  } | undefined;
13011
+ locales?: {
13012
+ [key: string]: unknown;
13013
+ } | undefined;
12997
13014
  };
12998
13015
  } | undefined;
12999
13016
  variant?: string | undefined;
@@ -13053,8 +13070,9 @@ interface paths$1 {
13053
13070
  parameters: {
13054
13071
  query: {
13055
13072
  projectId: string;
13056
- type: "definition";
13073
+ type: "definition" | "instance";
13057
13074
  definitionIds?: string;
13075
+ instanceIds?: string;
13058
13076
  withCompositions?: boolean | null;
13059
13077
  };
13060
13078
  };
@@ -13303,12 +13321,21 @@ type ContextualEditingComponentReference = {
13303
13321
  type?: string;
13304
13322
  title?: string;
13305
13323
  name?: string;
13324
+ /**
13325
+ * Whether this component is localized to be shown at all only in a specific locale
13326
+ * (e.g. inside a localization container)
13327
+ */
13328
+ shownInLocale?: Locale;
13306
13329
  parameters?: Record<string, {
13307
13330
  id: string;
13308
13331
  type: string;
13309
13332
  name?: string;
13310
13333
  isReadOnly?: boolean;
13334
+ localizable?: boolean;
13335
+ targetLocale?: Locale;
13311
13336
  }>;
13337
+ /** The ID of the pattern if the component is actually a pattern node. */
13338
+ patternId?: string;
13312
13339
  parentId?: string;
13313
13340
  parentType?: string;
13314
13341
  parentSlot?: {
@@ -13316,7 +13343,16 @@ type ContextualEditingComponentReference = {
13316
13343
  componentIndex?: number;
13317
13344
  totalComponents?: number;
13318
13345
  };
13319
- childIdsBySlot?: Record<string, string[]>;
13346
+ slotsById?: Record<string, {
13347
+ id: string;
13348
+ name: string;
13349
+ children: string[];
13350
+ }>;
13351
+ canBePersonalized?: boolean;
13352
+ canBeTested?: boolean;
13353
+ canBeLocalized?: boolean;
13354
+ isPersonalized?: boolean;
13355
+ isTested?: boolean;
13320
13356
  isLocalized?: boolean;
13321
13357
  isReadOnly?: boolean | undefined;
13322
13358
  };
@@ -13403,6 +13439,81 @@ type schemas = components$1['schemas'];
13403
13439
  type InvalidationPayload = schemas['InvalidationPayload'];
13404
13440
  type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
13405
13441
 
13442
+ type AssetParamValue = AssetParamValueItem[];
13443
+ type AssetParamValueItem = {
13444
+ type: string;
13445
+ _id: string;
13446
+ /**
13447
+ * Internal Uniform source ID or
13448
+ * dataType ID of the global integration library
13449
+ * which created this asset item
13450
+ */
13451
+ _source?: string;
13452
+ fields: {
13453
+ url: {
13454
+ type: 'text';
13455
+ value: string;
13456
+ };
13457
+ id?: {
13458
+ type: 'text';
13459
+ value: string | undefined;
13460
+ };
13461
+ title?: {
13462
+ type: 'text';
13463
+ value: string | undefined;
13464
+ };
13465
+ description?: {
13466
+ type: 'text';
13467
+ value: string | undefined;
13468
+ };
13469
+ mediaType?: {
13470
+ type: 'text';
13471
+ value: string | undefined;
13472
+ };
13473
+ /**
13474
+ * The width of the original asset
13475
+ *
13476
+ * Should resolve to a number but might
13477
+ * be a string with a pointer reference
13478
+ */
13479
+ width?: {
13480
+ type: 'number';
13481
+ value: number | string | undefined;
13482
+ };
13483
+ /**
13484
+ * The height of the original asset
13485
+ *
13486
+ * Should resolve to a number but might
13487
+ * be a string with a pointer reference
13488
+ */
13489
+ height?: {
13490
+ type: 'number';
13491
+ value: number | string | undefined;
13492
+ };
13493
+ /**
13494
+ * The size in bytes of the original asset
13495
+ *
13496
+ * Should resolve to a number but might
13497
+ * be a string with a pointer reference
13498
+ */
13499
+ size?: {
13500
+ type: 'number';
13501
+ value: number | string | undefined;
13502
+ };
13503
+ /**
13504
+ * Any key/value properties which the source
13505
+ * wants to attach to the asset data
13506
+ */
13507
+ custom?: {
13508
+ type: string;
13509
+ value: Record<string, unknown>;
13510
+ };
13511
+ };
13512
+ _overrides?: {
13513
+ fields: ComponentOverride['parameters'];
13514
+ };
13515
+ };
13516
+
13406
13517
  type LinkParameterType = 'projectMapNode' | 'url' | 'tel' | 'email';
13407
13518
  type LinkTypeConfiguration = Partial<Record<LinkParameterType, boolean>>;
13408
13519
  type LinkParamConfiguration = {
@@ -13464,7 +13575,9 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
13464
13575
  state: number;
13465
13576
  }[] | undefined;
13466
13577
  }>;
13467
- upsertContentType(body: ExceptProject<PutContentTypeBody>): Promise<void>;
13578
+ upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
13579
+ autogenerateDataTypes?: boolean;
13580
+ }): Promise<void>;
13468
13581
  upsertEntry(body: ExceptProject<PutEntryBody>): Promise<void>;
13469
13582
  deleteContentType(body: ExceptProject<DeleteContentTypeOptions>): Promise<void>;
13470
13583
  deleteEntry(body: ExceptProject<DeleteEntryOptions>): Promise<void>;
@@ -13688,37 +13801,6 @@ declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ c
13688
13801
  onErrors?: (errors: EnhancerError[]) => void;
13689
13802
  }): Promise<void>;
13690
13803
 
13691
- /** @deprecated use walkNodeTree */
13692
- type ComponentLocationReference = {
13693
- component: ComponentInstance;
13694
- parentSlot?: string;
13695
- parentSlotIndex?: number;
13696
- };
13697
- /** @deprecated use walkNodeTree and check for type = slot */
13698
- type WalkComponentTreeActions<TContext> = {
13699
- /** Replaces the component being visited with a new object */
13700
- replaceComponent: (replacementComponent: ComponentInstance) => void;
13701
- /** Removes the component being visited from the composition */
13702
- removeComponent: () => void;
13703
- /** Inserts a new component immediately after the current component in its parent slot */
13704
- insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
13705
- /** Aborts visitation of components that are in child slots of the current component */
13706
- stopProcessingDescendants: () => void;
13707
- /**
13708
- * Set a new traversal context for descendants of this node.
13709
- * If this is not called, `context` will automatically pass through.
13710
- */
13711
- setDescendantsContext: (context: TContext) => void;
13712
- setChildContext: (child: ComponentInstance, context: TContext) => void;
13713
- };
13714
- /**
13715
- * Walks a composition's component tree, visiting each component instance depth-first, in order.
13716
- * @deprecated use walkNodeTree
13717
- */
13718
- declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
13719
- /** Traversal context for this node */
13720
- currentContext: TContext | undefined) => void, initialContext?: TContext): void;
13721
-
13722
13804
  /** Ancestor location that is in a slot on a component */
13723
13805
  type ComponentLocationReferenceV2 = {
13724
13806
  type: 'slot';
@@ -13738,7 +13820,11 @@ type RootLocationReference = {
13738
13820
  type: 'root';
13739
13821
  node: ComponentInstance;
13740
13822
  };
13741
- type NodeLocationReference = ComponentLocationReferenceV2 | BlockLocationReference | RootLocationReference;
13823
+ type RootEntryReference = {
13824
+ type: 'root';
13825
+ node: EntryData;
13826
+ };
13827
+ type NodeLocationReference = ComponentLocationReferenceV2 | BlockLocationReference | RootLocationReference | RootEntryReference;
13742
13828
  type WalkNodeTreeActions<TContext, TNodeType> = {
13743
13829
  /** Replaces the node being visited with a new object */
13744
13830
  replace: (replacement: TNodeType) => void;
@@ -13779,24 +13865,103 @@ type WalkNodeTreeOptions<TContext> = {
13779
13865
  };
13780
13866
  /** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
13781
13867
  declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
13868
+ /**
13869
+ * Any types which hold an array of nodes and
13870
+ * therefore should be iterated over as child nodes
13871
+ */
13872
+ declare function isNestedNodeType(type: string): boolean;
13782
13873
  /** Gets the typed value of a block parameter or block field */
13783
13874
  declare function getBlockValue(component: ComponentInstance | EntryData, parameterName: string): BlockValue;
13784
13875
 
13876
+ interface FindInNodeTreeReference {
13877
+ key: string;
13878
+ pointer: string;
13879
+ /** This might be the composition parameter, or entry field */
13880
+ parameter: ComponentParameter;
13881
+ }
13882
+ /**
13883
+ * Walk a Composition or Entry tree to find parameters or fields
13884
+ * based on the predicate returning true
13885
+ *
13886
+ * @example
13887
+ *
13888
+ * const textReferences = findParameterInNodeTree(
13889
+ * composition,
13890
+ * (parameter) => parameter.type === 'text'
13891
+ * )
13892
+ *
13893
+ * @param data The composition or entry data
13894
+ * @param predicate Return true from this function to include the parameter in the results
13895
+ */
13896
+ declare function findParameterInNodeTree(data: ComponentInstance | EntryData | Array<NodeLocationReference>, predicate: (parameter: ComponentParameter, parameterKey: string, node: ComponentInstance | EntryData | Array<NodeLocationReference>) => boolean): FindInNodeTreeReference[];
13897
+
13898
+ /** @deprecated use walkNodeTree */
13899
+ type ComponentLocationReference = {
13900
+ component: ComponentInstance;
13901
+ parentSlot?: string;
13902
+ parentSlotIndex?: number;
13903
+ };
13904
+ /** @deprecated use walkNodeTree and check for type = slot */
13905
+ type WalkComponentTreeActions<TContext> = {
13906
+ /** Replaces the component being visited with a new object */
13907
+ replaceComponent: (replacementComponent: ComponentInstance) => void;
13908
+ /** Removes the component being visited from the composition */
13909
+ removeComponent: () => void;
13910
+ /** Inserts a new component immediately after the current component in its parent slot */
13911
+ insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
13912
+ /** Aborts visitation of components that are in child slots of the current component */
13913
+ stopProcessingDescendants: () => void;
13914
+ /**
13915
+ * Set a new traversal context for descendants of this node.
13916
+ * If this is not called, `context` will automatically pass through.
13917
+ */
13918
+ setDescendantsContext: (context: TContext) => void;
13919
+ setChildContext: (child: ComponentInstance, context: TContext) => void;
13920
+ };
13921
+ /**
13922
+ * Walks a composition's component tree, visiting each component instance depth-first, in order.
13923
+ * @deprecated use walkNodeTree
13924
+ */
13925
+ declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
13926
+ /** Traversal context for this node */
13927
+ currentContext: TContext | undefined) => void, initialContext?: TContext): void;
13928
+
13785
13929
  /** Returns the JSON pointer of a component based on its location */
13786
13930
  declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference | ComponentLocationReference>): string;
13931
+ declare function getNounForLocation(parentLocation: NodeLocationReference | ComponentLocationReference | undefined): "parameters" | "fields";
13932
+ declare function getNounForNode(node: ComponentInstance | EntryData | Array<NodeLocationReference>): "parameters" | "fields";
13787
13933
 
13788
13934
  declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference | NodeLocationReference>): string;
13789
13935
 
13790
13936
  declare function extractLocales({ component }: {
13791
13937
  component: ComponentInstance;
13792
13938
  }): Record<string, ComponentInstance[]>;
13793
- declare function localize({ composition, locale, }: {
13939
+ type LocalizeModernOptions = {
13940
+ nodes: RootComponentInstance | EntryData;
13941
+ locale: string | undefined;
13942
+ };
13943
+ /** @deprecated use modern options type (nodes property). This overload is incompatible with parameter level localization. */
13944
+ type LocalizeDeprecatedOptions = {
13794
13945
  composition: ComponentInstance;
13795
13946
  locale: string | ((options: {
13796
13947
  component: Readonly<ComponentInstance>;
13797
13948
  locales: Readonly<Record<string, ComponentInstance[]>>;
13798
13949
  }) => string | undefined);
13799
- }): void;
13950
+ };
13951
+ /** @deprecated use LocalizeModernOptions overload instead */
13952
+ declare function localize(options: LocalizeDeprecatedOptions): void;
13953
+ /**
13954
+ * Localizes a composition or entry that may contain:
13955
+ * * Structural localization with localization components (locale specific layout)
13956
+ * * Property localization with localizable property values (translations)
13957
+ *
13958
+ * The result will contain only parameters and localizations that match one of the input locales.
13959
+ * Information for other locales will be discarded in the result.
13960
+ *
13961
+ * NOTE: this function mutates its input object for maximum performance.
13962
+ * If you desire immutability wrap it in immer.
13963
+ */
13964
+ declare function localize(options: LocalizeModernOptions): void;
13800
13965
 
13801
13966
  /**
13802
13967
  * Given a batch of enhancements containing potentially duplicate entries (i.e. several components referencing the same thing),
@@ -13815,6 +13980,23 @@ declare class UniqueBatchEntries<TArgs, TResult> {
13815
13980
  resolveRemaining(value: TResult): void;
13816
13981
  }
13817
13982
 
13983
+ /** API client to enable managing project locales */
13984
+ declare class LocaleClient extends ApiClient {
13985
+ constructor(options: ClientOptions);
13986
+ /** Fetches all locales for a project */
13987
+ get(options?: ExceptProject<LocalesGetParameters>): Promise<{
13988
+ results: {
13989
+ locale: string;
13990
+ displayName: string;
13991
+ isDefault: boolean;
13992
+ }[];
13993
+ }>;
13994
+ /** Updates or creates (based on id) a locale */
13995
+ upsert(body: ExceptProject<LocalePutParameters>): Promise<void>;
13996
+ /** Deletes a locale */
13997
+ remove(body: ExceptProject<LocaleDeleteParameters>): Promise<void>;
13998
+ }
13999
+
13818
14000
  interface ContextualEditingWindowData {
13819
14001
  framework?: ReadyMessage['framework'];
13820
14002
  version?: ReadyMessage['version'];
@@ -13838,11 +14020,14 @@ type ReadyMessage = {
13838
14020
  framework?: 'React' | 'Vue';
13839
14021
  /** A non-semantic version of the contextual editing SDK. */
13840
14022
  version?: number;
14023
+ /** Whether or not the SDK is RSC or not, activates editor state. */
14024
+ rsc?: boolean;
13841
14025
  };
13842
14026
  type TriggerComponentActionMessage = {
13843
14027
  type: 'trigger-component-action';
13844
- actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
14028
+ actionType: 'insertBefore' | 'insertAfter' | 'insertInto' | 'duplicate' | 'delete' | 'editPattern' | 'unlinkPattern' | 'convertToPattern' | 'personalize' | 'test' | 'localize';
13845
14029
  componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
14030
+ extraData?: Record<string, any>;
13846
14031
  };
13847
14032
  type UpdateComponentReferencesMessage = {
13848
14033
  type: 'update-component-references';
@@ -13945,7 +14130,7 @@ declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => m
13945
14130
  type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
13946
14131
  type Channel = {
13947
14132
  on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
13948
- ready: () => void;
14133
+ ready: (options?: Pick<ReadyMessage, 'rsc'>) => void;
13949
14134
  destroy: () => void;
13950
14135
  triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
13951
14136
  selectComponent: (id: string) => void;
@@ -14014,34 +14199,34 @@ declare function subscribeToComposition({ projectId, compositionId, compositionS
14014
14199
  /** API client to make comms with the Next Gen Mesh Data Source API simpler */
14015
14200
  declare class PromptClient extends ApiClient {
14016
14201
  constructor(options: ClientOptions);
14017
- /** Fetches all Prompts for a project */
14018
- get(options?: ExceptProject<PromptGetParameters>): Promise<{
14019
- result: {
14020
- id: string;
14021
- integrationType: string;
14022
- promptName?: string | null | undefined;
14023
- promptText?: string | null | undefined;
14024
- promptData?: string | null | undefined;
14025
- enabled?: boolean | null | undefined;
14026
- builtIn?: boolean | null | undefined;
14027
- };
14028
- }>;
14029
- /** Fetches all Prompts for a project */
14030
- getList(options?: ExceptProject<PromptsGetParameters>): Promise<{
14031
- results: {
14032
- id: string;
14033
- integrationType: string;
14034
- promptName?: string | null | undefined;
14035
- promptText?: string | null | undefined;
14036
- promptData?: string | null | undefined;
14037
- enabled?: boolean | null | undefined;
14038
- builtIn?: boolean | null | undefined;
14039
- }[];
14040
- }>;
14202
+ /** Fetches Prompts for a project */
14203
+ get(options?: ExceptProject<PromptsGetParameters>): Promise<{
14204
+ id: string;
14205
+ integrationType: string;
14206
+ name?: string | null | undefined;
14207
+ text?: string | null | undefined;
14208
+ data?: {
14209
+ [key: string]: unknown;
14210
+ } | null | undefined;
14211
+ enabled?: boolean | null | undefined;
14212
+ builtIn?: boolean | null | undefined;
14213
+ parameterTypes?: string[] | null | undefined;
14214
+ } | {
14215
+ id: string;
14216
+ integrationType: string;
14217
+ name?: string | null | undefined;
14218
+ text?: string | null | undefined;
14219
+ data?: {
14220
+ [key: string]: unknown;
14221
+ } | null | undefined;
14222
+ enabled?: boolean | null | undefined;
14223
+ builtIn?: boolean | null | undefined;
14224
+ parameterTypes?: string[] | null | undefined;
14225
+ }[]>;
14041
14226
  /** Updates or creates (based on id) a Prompt */
14042
- upsert(body: ExceptProject<PromptPutParameters>): Promise<void>;
14227
+ upsert(body: ExceptProject<PromptsPutParameters>): Promise<void>;
14043
14228
  /** Deletes a Prompt */
14044
- remove(body: ExceptProject<PromptDeleteParameters>): Promise<void>;
14229
+ remove(body: ExceptProject<PromptsDeleteParameters>): Promise<void>;
14045
14230
  }
14046
14231
 
14047
14232
  type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
@@ -14077,12 +14262,15 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
14077
14262
  type: string;
14078
14263
  parameters?: {
14079
14264
  [key: string]: {
14080
- value: unknown;
14265
+ value?: unknown;
14081
14266
  type: string;
14082
14267
  connectedData?: {
14083
14268
  pointer: string;
14084
14269
  syntax: "jptr";
14085
14270
  } | undefined;
14271
+ locales?: {
14272
+ [key: string]: unknown;
14273
+ } | undefined;
14086
14274
  };
14087
14275
  } | undefined;
14088
14276
  variant?: string | undefined;
@@ -14096,12 +14284,15 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
14096
14284
  type: string;
14097
14285
  parameters?: {
14098
14286
  [key: string]: {
14099
- value: unknown;
14287
+ value?: unknown;
14100
14288
  type: string;
14101
14289
  connectedData?: {
14102
14290
  pointer: string;
14103
14291
  syntax: "jptr";
14104
14292
  } | undefined;
14293
+ locales?: {
14294
+ [key: string]: unknown;
14295
+ } | undefined;
14105
14296
  };
14106
14297
  } | undefined;
14107
14298
  variant?: string | undefined;
@@ -14135,12 +14326,15 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
14135
14326
  [key: string]: {
14136
14327
  parameters?: {
14137
14328
  [key: string]: {
14138
- value: unknown;
14329
+ value?: unknown;
14139
14330
  type: string;
14140
14331
  connectedData?: {
14141
14332
  pointer: string;
14142
14333
  syntax: "jptr";
14143
14334
  } | undefined;
14335
+ locales?: {
14336
+ [key: string]: unknown;
14337
+ } | undefined;
14144
14338
  };
14145
14339
  } | undefined;
14146
14340
  variant?: string | undefined;
@@ -14171,12 +14365,15 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
14171
14365
  [key: string]: {
14172
14366
  parameters?: {
14173
14367
  [key: string]: {
14174
- value: unknown;
14368
+ value?: unknown;
14175
14369
  type: string;
14176
14370
  connectedData?: {
14177
14371
  pointer: string;
14178
14372
  syntax: "jptr";
14179
14373
  } | undefined;
14374
+ locales?: {
14375
+ [key: string]: unknown;
14376
+ } | undefined;
14180
14377
  };
14181
14378
  } | undefined;
14182
14379
  variant?: string | undefined;
@@ -14188,6 +14385,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
14188
14385
  } | undefined;
14189
14386
  variants?: boolean | undefined;
14190
14387
  } | undefined;
14388
+ _locales?: string[] | undefined;
14191
14389
  }>;
14192
14390
 
14193
14391
  /**
@@ -14195,11 +14393,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
14195
14393
  * Removes things like author, stats, etc.
14196
14394
  */
14197
14395
  declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
14198
- /**
14199
- * Gets the object holding the properties (fields or parameters) of an entry or component instance
14200
- * If no properties are defined, returns undefined.
14201
- */
14202
- declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
14203
14396
 
14204
14397
  declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
14205
14398
  declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
@@ -14229,6 +14422,27 @@ type GetParameterAttributesProps = {
14229
14422
  */
14230
14423
  declare const getParameterAttributes: ({ id, component, placeholder, isMultiline, }: GetParameterAttributesProps) => Record<string, string | boolean | undefined>;
14231
14424
 
14425
+ /**
14426
+ * When walking a node tree, is the node the root node
14427
+ * and look like Entry data
14428
+ */
14429
+ declare function isRootEntryReference(root: NodeLocationReference): root is RootEntryReference;
14430
+ /**
14431
+ * Check to see if some generic composition data structure
14432
+ * looks like Entry data
14433
+ */
14434
+ declare function isEntryData(entryData: ComponentInstance | EntryData | null | undefined | unknown): entryData is EntryData;
14435
+ /**
14436
+ * A fast, non-exhaustive guard which checks that the value is an array
14437
+ * as well as the first item, if there is one, looks like an asset item
14438
+ */
14439
+ declare function isAssetParamValue(value: unknown): value is AssetParamValue;
14440
+ /**
14441
+ * A fast, non-exhaustive guard which checks the
14442
+ * required structure of an asset item
14443
+ */
14444
+ declare function isAssetParamValueItem(item: unknown): item is AssetParamValueItem;
14445
+
14232
14446
  declare const generateHash: ({ composition, secret, }: {
14233
14447
  composition: RootComponentInstance;
14234
14448
  secret: string | undefined;
@@ -14255,9 +14469,60 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
14255
14469
  */
14256
14470
  declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
14257
14471
 
14258
- declare const isComponentPlaceholderId: (id: string | undefined) => boolean | undefined;
14472
+ declare const isComponentPlaceholderId: (id: string | undefined) => boolean;
14259
14473
  declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
14260
14474
 
14475
+ type FlattenProperty<P> = P extends {
14476
+ value: unknown;
14477
+ } ? P['value'] : P;
14478
+ type FlattenValues<T extends DataWithProperties> = T extends Pick<ComponentInstance, 'parameters'> ? Record<string, unknown> & {
14479
+ [Property in keyof T['parameters']]: FlattenProperty<T['parameters'][Property]>;
14480
+ } : T extends Pick<EntryData, 'fields'> ? Record<string, unknown> & {
14481
+ [Property in keyof T['fields']]: FlattenProperty<T['fields'][Property]>;
14482
+ } : unknown;
14483
+ /**
14484
+ * Gets the object holding the properties (fields or parameters) of an entry or component instance
14485
+ * If no properties are defined, returns undefined.
14486
+ */
14487
+ declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
14488
+ interface FlattenValuesOptions {
14489
+ /**
14490
+ * Take only the first item from an array
14491
+ * of values, flatten it and return it as a single object
14492
+ */
14493
+ toSingle?: boolean;
14494
+ /**
14495
+ * If the property has nested properties, like Blocks or Assets
14496
+ * can, then how many levels should we traverse.
14497
+ *
14498
+ * You can set this to `Infinity` although it would be more
14499
+ * advisable, for performance, to use the number you need in your code.
14500
+ *
14501
+ * Where:
14502
+ * levels=0 will only extract the properties of the current object
14503
+ * levels=1 will include any child blocks or assets on the current object
14504
+ * but not any grandchildren
14505
+ *
14506
+ * @default 1
14507
+ */
14508
+ levels?: number;
14509
+ }
14510
+ /**
14511
+ * Get the data stored in the value of a component parameter
14512
+ * or a field attached to an Entry, Block or Asset
14513
+ */
14514
+ declare function getPropertyValue<TValue, T extends ComponentParameter<TValue>>(parameter: T): TValue;
14515
+ declare function getPropertyValue(parameter: null): null;
14516
+ declare function getPropertyValue(parameter: undefined): undefined;
14517
+ type DataWithProperties = Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>;
14518
+ declare function flattenValues(data: null, options?: FlattenValuesOptions): null;
14519
+ declare function flattenValues(data: undefined, options?: FlattenValuesOptions): undefined;
14520
+ declare function flattenValues<Data extends DataWithProperties>(data: Data | null | undefined, options?: FlattenValuesOptions): FlattenValues<Data> | null | undefined;
14521
+ declare function flattenValues<Data extends DataWithProperties>(data: Array<Data> | null | undefined, options: {
14522
+ toSingle: true;
14523
+ } & Omit<FlattenValuesOptions, 'toSingle'>): FlattenValues<Data> | null | undefined;
14524
+ declare function flattenValues<Data extends DataWithProperties>(data: Array<Data> | null | undefined, options?: FlattenValuesOptions): Array<FlattenValues<Data>> | null | undefined;
14525
+
14261
14526
  type BindVariablesResult<TValue> = {
14262
14527
  /** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
14263
14528
  boundCount: number;
@@ -14317,4 +14582,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
14317
14582
 
14318
14583
  declare const CanvasClientError: typeof ApiClientError;
14319
14584
 
14320
- 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_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesHistoryGetParameters, EntriesHistoryGetResponse, 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, Prompt, PromptClient, PromptDeleteParameters, PromptGetParameters, PromptGetResponse, PromptPutParameters, PromptsGetParameters, PromptsGetResponse, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RootLocationReference, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TreeNodeInfoTypes, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdateFeatureFlagsMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, WalkNodeTreeActions, WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };
14585
+ export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type 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, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionRelationshipsClientOptions, type CompositionRelationshipsDDefinitionGetResponse, type CompositionRelationshipsDefinitionApi, type CompositionRelationshipsDefinitionGetParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type 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, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, type ReportRenderedCompositionsMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UsageTrackingApi, type UsageTrackingGetParameters, type UsageTrackingGetResponse, type UsageTrackingPostParameters, type UsageTrackingPostResponse, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };