@uniformdev/canvas 19.173.1-alpha.17 → 19.175.1-alpha.35
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 +191 -1466
- package/dist/index.d.ts +191 -1466
- package/dist/index.esm.js +19 -129
- package/dist/index.js +21 -132
- package/dist/index.mjs +19 -129
- package/package.json +4 -4
package/dist/index.d.ts
CHANGED
@@ -25,21 +25,6 @@ interface components$8 {
|
|
25
25
|
* this property will have a single value that is shared for all locales
|
26
26
|
*/
|
27
27
|
localizable?: boolean;
|
28
|
-
/**
|
29
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
30
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
31
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
32
|
-
*
|
33
|
-
* If `localized` is false, this has no effect.
|
34
|
-
*/
|
35
|
-
notLocalizedByDefault?: boolean;
|
36
|
-
/**
|
37
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
38
|
-
* When combined with a localized value, each locale has independent conditional values.
|
39
|
-
*
|
40
|
-
* When not defined, conditional values are not allowed.
|
41
|
-
*/
|
42
|
-
allowConditionalValues?: boolean;
|
43
28
|
/** @description The configuration object for the type (type-specific) */
|
44
29
|
typeConfig?: unknown;
|
45
30
|
};
|
@@ -248,65 +233,6 @@ interface components$8 {
|
|
248
233
|
locales?: {
|
249
234
|
[key: string]: unknown;
|
250
235
|
};
|
251
|
-
conditions?: components$8["schemas"]["ComponentParameterConditions"];
|
252
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
253
|
-
localesConditions?: {
|
254
|
-
[key: string]: components$8["schemas"]["ComponentParameterConditions"];
|
255
|
-
};
|
256
|
-
};
|
257
|
-
/**
|
258
|
-
* @description Array of alternate values which are based on conditions.
|
259
|
-
*
|
260
|
-
* When requested with an explicit locale parameter, or via the route API:
|
261
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
262
|
-
* * If no conditions match, the `value` property is used.
|
263
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
264
|
-
*
|
265
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
266
|
-
*/
|
267
|
-
ComponentParameterConditions: components$8["schemas"]["ComponentParameterConditionalValue"][];
|
268
|
-
/** @description Defines a conditional value for a component parameter */
|
269
|
-
ComponentParameterConditionalValue: {
|
270
|
-
when: components$8["schemas"]["VisibilityCriteriaGroup"];
|
271
|
-
/**
|
272
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
273
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
274
|
-
*/
|
275
|
-
value: unknown;
|
276
|
-
/**
|
277
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
278
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
279
|
-
*/
|
280
|
-
id: number;
|
281
|
-
};
|
282
|
-
/**
|
283
|
-
* @deprecated
|
284
|
-
* @description beta functionality subject to change
|
285
|
-
*/
|
286
|
-
VisibilityCriteriaGroup: {
|
287
|
-
/**
|
288
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
289
|
-
* @enum {string}
|
290
|
-
*/
|
291
|
-
op?: "&" | "|";
|
292
|
-
clauses: (components$8["schemas"]["VisibilityCriteria"] | components$8["schemas"]["VisibilityCriteriaGroup"])[];
|
293
|
-
};
|
294
|
-
/**
|
295
|
-
* @deprecated
|
296
|
-
* @description beta functionality subject to change
|
297
|
-
*/
|
298
|
-
VisibilityCriteria: {
|
299
|
-
/** @description The rule type to execute */
|
300
|
-
rule: string;
|
301
|
-
/**
|
302
|
-
* @description The source value of the rule.
|
303
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
304
|
-
*/
|
305
|
-
source?: string;
|
306
|
-
/** @description The rule-definition-specific operator to test against */
|
307
|
-
op: string;
|
308
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
309
|
-
value: string | string[];
|
310
236
|
};
|
311
237
|
/** @description Defines a connection to a dynamic token on a data resource */
|
312
238
|
DataElementConnectionDefinition: {
|
@@ -553,6 +479,11 @@ interface components$8 {
|
|
553
479
|
localeMapping?: {
|
554
480
|
[key: string]: string;
|
555
481
|
};
|
482
|
+
/**
|
483
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
484
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
485
|
+
*/
|
486
|
+
enableUnpublishedMode?: boolean;
|
556
487
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
557
488
|
customPublic?: {
|
558
489
|
[key: string]: unknown;
|
@@ -659,6 +590,8 @@ interface components$8 {
|
|
659
590
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
660
591
|
*/
|
661
592
|
optionalPatternParameter?: boolean;
|
593
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
594
|
+
isDraft?: boolean;
|
662
595
|
variables?: components$8["schemas"]["DataResourceVariables"];
|
663
596
|
};
|
664
597
|
/** @description Variable values for a data resource */
|
@@ -1399,21 +1332,6 @@ interface external$i {
|
|
1399
1332
|
* this property will have a single value that is shared for all locales
|
1400
1333
|
*/
|
1401
1334
|
localizable?: boolean;
|
1402
|
-
/**
|
1403
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
1404
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
1405
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
1406
|
-
*
|
1407
|
-
* If `localized` is false, this has no effect.
|
1408
|
-
*/
|
1409
|
-
notLocalizedByDefault?: boolean;
|
1410
|
-
/**
|
1411
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
1412
|
-
* When combined with a localized value, each locale has independent conditional values.
|
1413
|
-
*
|
1414
|
-
* When not defined, conditional values are not allowed.
|
1415
|
-
*/
|
1416
|
-
allowConditionalValues?: boolean;
|
1417
1335
|
/** @description The configuration object for the type (type-specific) */
|
1418
1336
|
typeConfig?: unknown;
|
1419
1337
|
};
|
@@ -1622,65 +1540,6 @@ interface external$i {
|
|
1622
1540
|
locales?: {
|
1623
1541
|
[key: string]: unknown;
|
1624
1542
|
};
|
1625
|
-
conditions?: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
1626
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
1627
|
-
localesConditions?: {
|
1628
|
-
[key: string]: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
1629
|
-
};
|
1630
|
-
};
|
1631
|
-
/**
|
1632
|
-
* @description Array of alternate values which are based on conditions.
|
1633
|
-
*
|
1634
|
-
* When requested with an explicit locale parameter, or via the route API:
|
1635
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
1636
|
-
* * If no conditions match, the `value` property is used.
|
1637
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
1638
|
-
*
|
1639
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
1640
|
-
*/
|
1641
|
-
ComponentParameterConditions: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
1642
|
-
/** @description Defines a conditional value for a component parameter */
|
1643
|
-
ComponentParameterConditionalValue: {
|
1644
|
-
when: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
1645
|
-
/**
|
1646
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
1647
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
1648
|
-
*/
|
1649
|
-
value: unknown;
|
1650
|
-
/**
|
1651
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
1652
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
1653
|
-
*/
|
1654
|
-
id: number;
|
1655
|
-
};
|
1656
|
-
/**
|
1657
|
-
* @deprecated
|
1658
|
-
* @description beta functionality subject to change
|
1659
|
-
*/
|
1660
|
-
VisibilityCriteriaGroup: {
|
1661
|
-
/**
|
1662
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
1663
|
-
* @enum {string}
|
1664
|
-
*/
|
1665
|
-
op?: "&" | "|";
|
1666
|
-
clauses: (external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
1667
|
-
};
|
1668
|
-
/**
|
1669
|
-
* @deprecated
|
1670
|
-
* @description beta functionality subject to change
|
1671
|
-
*/
|
1672
|
-
VisibilityCriteria: {
|
1673
|
-
/** @description The rule type to execute */
|
1674
|
-
rule: string;
|
1675
|
-
/**
|
1676
|
-
* @description The source value of the rule.
|
1677
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
1678
|
-
*/
|
1679
|
-
source?: string;
|
1680
|
-
/** @description The rule-definition-specific operator to test against */
|
1681
|
-
op: string;
|
1682
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
1683
|
-
value: string | string[];
|
1684
1543
|
};
|
1685
1544
|
/** @description Defines a connection to a dynamic token on a data resource */
|
1686
1545
|
DataElementConnectionDefinition: {
|
@@ -1927,6 +1786,11 @@ interface external$i {
|
|
1927
1786
|
localeMapping?: {
|
1928
1787
|
[key: string]: string;
|
1929
1788
|
};
|
1789
|
+
/**
|
1790
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
1791
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
1792
|
+
*/
|
1793
|
+
enableUnpublishedMode?: boolean;
|
1930
1794
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
1931
1795
|
customPublic?: {
|
1932
1796
|
[key: string]: unknown;
|
@@ -2033,6 +1897,8 @@ interface external$i {
|
|
2033
1897
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
2034
1898
|
*/
|
2035
1899
|
optionalPatternParameter?: boolean;
|
1900
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
1901
|
+
isDraft?: boolean;
|
2036
1902
|
variables?: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2037
1903
|
};
|
2038
1904
|
/** @description Variable values for a data resource */
|
@@ -2772,21 +2638,6 @@ interface external$h {
|
|
2772
2638
|
* this property will have a single value that is shared for all locales
|
2773
2639
|
*/
|
2774
2640
|
localizable?: boolean;
|
2775
|
-
/**
|
2776
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
2777
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
2778
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
2779
|
-
*
|
2780
|
-
* If `localized` is false, this has no effect.
|
2781
|
-
*/
|
2782
|
-
notLocalizedByDefault?: boolean;
|
2783
|
-
/**
|
2784
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
2785
|
-
* When combined with a localized value, each locale has independent conditional values.
|
2786
|
-
*
|
2787
|
-
* When not defined, conditional values are not allowed.
|
2788
|
-
*/
|
2789
|
-
allowConditionalValues?: boolean;
|
2790
2641
|
/** @description The configuration object for the type (type-specific) */
|
2791
2642
|
typeConfig?: unknown;
|
2792
2643
|
};
|
@@ -2995,65 +2846,6 @@ interface external$h {
|
|
2995
2846
|
locales?: {
|
2996
2847
|
[key: string]: unknown;
|
2997
2848
|
};
|
2998
|
-
conditions?: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
2999
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
3000
|
-
localesConditions?: {
|
3001
|
-
[key: string]: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
3002
|
-
};
|
3003
|
-
};
|
3004
|
-
/**
|
3005
|
-
* @description Array of alternate values which are based on conditions.
|
3006
|
-
*
|
3007
|
-
* When requested with an explicit locale parameter, or via the route API:
|
3008
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
3009
|
-
* * If no conditions match, the `value` property is used.
|
3010
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
3011
|
-
*
|
3012
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
3013
|
-
*/
|
3014
|
-
ComponentParameterConditions: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
3015
|
-
/** @description Defines a conditional value for a component parameter */
|
3016
|
-
ComponentParameterConditionalValue: {
|
3017
|
-
when: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
3018
|
-
/**
|
3019
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
3020
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
3021
|
-
*/
|
3022
|
-
value: unknown;
|
3023
|
-
/**
|
3024
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
3025
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
3026
|
-
*/
|
3027
|
-
id: number;
|
3028
|
-
};
|
3029
|
-
/**
|
3030
|
-
* @deprecated
|
3031
|
-
* @description beta functionality subject to change
|
3032
|
-
*/
|
3033
|
-
VisibilityCriteriaGroup: {
|
3034
|
-
/**
|
3035
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
3036
|
-
* @enum {string}
|
3037
|
-
*/
|
3038
|
-
op?: "&" | "|";
|
3039
|
-
clauses: (external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
3040
|
-
};
|
3041
|
-
/**
|
3042
|
-
* @deprecated
|
3043
|
-
* @description beta functionality subject to change
|
3044
|
-
*/
|
3045
|
-
VisibilityCriteria: {
|
3046
|
-
/** @description The rule type to execute */
|
3047
|
-
rule: string;
|
3048
|
-
/**
|
3049
|
-
* @description The source value of the rule.
|
3050
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
3051
|
-
*/
|
3052
|
-
source?: string;
|
3053
|
-
/** @description The rule-definition-specific operator to test against */
|
3054
|
-
op: string;
|
3055
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
3056
|
-
value: string | string[];
|
3057
2849
|
};
|
3058
2850
|
/** @description Defines a connection to a dynamic token on a data resource */
|
3059
2851
|
DataElementConnectionDefinition: {
|
@@ -3300,6 +3092,11 @@ interface external$h {
|
|
3300
3092
|
localeMapping?: {
|
3301
3093
|
[key: string]: string;
|
3302
3094
|
};
|
3095
|
+
/**
|
3096
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
3097
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
3098
|
+
*/
|
3099
|
+
enableUnpublishedMode?: boolean;
|
3303
3100
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
3304
3101
|
customPublic?: {
|
3305
3102
|
[key: string]: unknown;
|
@@ -3406,6 +3203,8 @@ interface external$h {
|
|
3406
3203
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
3407
3204
|
*/
|
3408
3205
|
optionalPatternParameter?: boolean;
|
3206
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
3207
|
+
isDraft?: boolean;
|
3409
3208
|
variables?: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3410
3209
|
};
|
3411
3210
|
/** @description Variable values for a data resource */
|
@@ -4234,21 +4033,6 @@ interface external$g {
|
|
4234
4033
|
* this property will have a single value that is shared for all locales
|
4235
4034
|
*/
|
4236
4035
|
localizable?: boolean;
|
4237
|
-
/**
|
4238
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
4239
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
4240
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
4241
|
-
*
|
4242
|
-
* If `localized` is false, this has no effect.
|
4243
|
-
*/
|
4244
|
-
notLocalizedByDefault?: boolean;
|
4245
|
-
/**
|
4246
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
4247
|
-
* When combined with a localized value, each locale has independent conditional values.
|
4248
|
-
*
|
4249
|
-
* When not defined, conditional values are not allowed.
|
4250
|
-
*/
|
4251
|
-
allowConditionalValues?: boolean;
|
4252
4036
|
/** @description The configuration object for the type (type-specific) */
|
4253
4037
|
typeConfig?: unknown;
|
4254
4038
|
};
|
@@ -4457,65 +4241,6 @@ interface external$g {
|
|
4457
4241
|
locales?: {
|
4458
4242
|
[key: string]: unknown;
|
4459
4243
|
};
|
4460
|
-
conditions?: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
4461
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
4462
|
-
localesConditions?: {
|
4463
|
-
[key: string]: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
4464
|
-
};
|
4465
|
-
};
|
4466
|
-
/**
|
4467
|
-
* @description Array of alternate values which are based on conditions.
|
4468
|
-
*
|
4469
|
-
* When requested with an explicit locale parameter, or via the route API:
|
4470
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
4471
|
-
* * If no conditions match, the `value` property is used.
|
4472
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
4473
|
-
*
|
4474
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
4475
|
-
*/
|
4476
|
-
ComponentParameterConditions: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
4477
|
-
/** @description Defines a conditional value for a component parameter */
|
4478
|
-
ComponentParameterConditionalValue: {
|
4479
|
-
when: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
4480
|
-
/**
|
4481
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
4482
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
4483
|
-
*/
|
4484
|
-
value: unknown;
|
4485
|
-
/**
|
4486
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
4487
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
4488
|
-
*/
|
4489
|
-
id: number;
|
4490
|
-
};
|
4491
|
-
/**
|
4492
|
-
* @deprecated
|
4493
|
-
* @description beta functionality subject to change
|
4494
|
-
*/
|
4495
|
-
VisibilityCriteriaGroup: {
|
4496
|
-
/**
|
4497
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
4498
|
-
* @enum {string}
|
4499
|
-
*/
|
4500
|
-
op?: "&" | "|";
|
4501
|
-
clauses: (external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
4502
|
-
};
|
4503
|
-
/**
|
4504
|
-
* @deprecated
|
4505
|
-
* @description beta functionality subject to change
|
4506
|
-
*/
|
4507
|
-
VisibilityCriteria: {
|
4508
|
-
/** @description The rule type to execute */
|
4509
|
-
rule: string;
|
4510
|
-
/**
|
4511
|
-
* @description The source value of the rule.
|
4512
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
4513
|
-
*/
|
4514
|
-
source?: string;
|
4515
|
-
/** @description The rule-definition-specific operator to test against */
|
4516
|
-
op: string;
|
4517
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
4518
|
-
value: string | string[];
|
4519
4244
|
};
|
4520
4245
|
/** @description Defines a connection to a dynamic token on a data resource */
|
4521
4246
|
DataElementConnectionDefinition: {
|
@@ -4762,6 +4487,11 @@ interface external$g {
|
|
4762
4487
|
localeMapping?: {
|
4763
4488
|
[key: string]: string;
|
4764
4489
|
};
|
4490
|
+
/**
|
4491
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
4492
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
4493
|
+
*/
|
4494
|
+
enableUnpublishedMode?: boolean;
|
4765
4495
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
4766
4496
|
customPublic?: {
|
4767
4497
|
[key: string]: unknown;
|
@@ -4868,6 +4598,8 @@ interface external$g {
|
|
4868
4598
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
4869
4599
|
*/
|
4870
4600
|
optionalPatternParameter?: boolean;
|
4601
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
4602
|
+
isDraft?: boolean;
|
4871
4603
|
variables?: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4872
4604
|
};
|
4873
4605
|
/** @description Variable values for a data resource */
|
@@ -5847,6 +5579,11 @@ interface components$7 {
|
|
5847
5579
|
workflowStageId?: string;
|
5848
5580
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
5849
5581
|
workflowDefinition?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowDefinition"];
|
5582
|
+
/**
|
5583
|
+
* @description Only present if an imcomplete entry is returned; indicates reason for stubbing
|
5584
|
+
* @enum {string}
|
5585
|
+
*/
|
5586
|
+
stubType?: "missing" | "tooDeep";
|
5850
5587
|
};
|
5851
5588
|
EntryListResponse: {
|
5852
5589
|
entries: components$7["schemas"]["EntryApiResponse"][];
|
@@ -6025,21 +5762,6 @@ interface external$f {
|
|
6025
5762
|
* this property will have a single value that is shared for all locales
|
6026
5763
|
*/
|
6027
5764
|
localizable?: boolean;
|
6028
|
-
/**
|
6029
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
6030
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
6031
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
6032
|
-
*
|
6033
|
-
* If `localized` is false, this has no effect.
|
6034
|
-
*/
|
6035
|
-
notLocalizedByDefault?: boolean;
|
6036
|
-
/**
|
6037
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
6038
|
-
* When combined with a localized value, each locale has independent conditional values.
|
6039
|
-
*
|
6040
|
-
* When not defined, conditional values are not allowed.
|
6041
|
-
*/
|
6042
|
-
allowConditionalValues?: boolean;
|
6043
5765
|
/** @description The configuration object for the type (type-specific) */
|
6044
5766
|
typeConfig?: unknown;
|
6045
5767
|
};
|
@@ -6248,65 +5970,6 @@ interface external$f {
|
|
6248
5970
|
locales?: {
|
6249
5971
|
[key: string]: unknown;
|
6250
5972
|
};
|
6251
|
-
conditions?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
6252
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
6253
|
-
localesConditions?: {
|
6254
|
-
[key: string]: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
6255
|
-
};
|
6256
|
-
};
|
6257
|
-
/**
|
6258
|
-
* @description Array of alternate values which are based on conditions.
|
6259
|
-
*
|
6260
|
-
* When requested with an explicit locale parameter, or via the route API:
|
6261
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
6262
|
-
* * If no conditions match, the `value` property is used.
|
6263
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
6264
|
-
*
|
6265
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
6266
|
-
*/
|
6267
|
-
ComponentParameterConditions: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
6268
|
-
/** @description Defines a conditional value for a component parameter */
|
6269
|
-
ComponentParameterConditionalValue: {
|
6270
|
-
when: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
6271
|
-
/**
|
6272
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
6273
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
6274
|
-
*/
|
6275
|
-
value: unknown;
|
6276
|
-
/**
|
6277
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
6278
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
6279
|
-
*/
|
6280
|
-
id: number;
|
6281
|
-
};
|
6282
|
-
/**
|
6283
|
-
* @deprecated
|
6284
|
-
* @description beta functionality subject to change
|
6285
|
-
*/
|
6286
|
-
VisibilityCriteriaGroup: {
|
6287
|
-
/**
|
6288
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
6289
|
-
* @enum {string}
|
6290
|
-
*/
|
6291
|
-
op?: "&" | "|";
|
6292
|
-
clauses: (external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
6293
|
-
};
|
6294
|
-
/**
|
6295
|
-
* @deprecated
|
6296
|
-
* @description beta functionality subject to change
|
6297
|
-
*/
|
6298
|
-
VisibilityCriteria: {
|
6299
|
-
/** @description The rule type to execute */
|
6300
|
-
rule: string;
|
6301
|
-
/**
|
6302
|
-
* @description The source value of the rule.
|
6303
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
6304
|
-
*/
|
6305
|
-
source?: string;
|
6306
|
-
/** @description The rule-definition-specific operator to test against */
|
6307
|
-
op: string;
|
6308
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
6309
|
-
value: string | string[];
|
6310
5973
|
};
|
6311
5974
|
/** @description Defines a connection to a dynamic token on a data resource */
|
6312
5975
|
DataElementConnectionDefinition: {
|
@@ -6553,6 +6216,11 @@ interface external$f {
|
|
6553
6216
|
localeMapping?: {
|
6554
6217
|
[key: string]: string;
|
6555
6218
|
};
|
6219
|
+
/**
|
6220
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
6221
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
6222
|
+
*/
|
6223
|
+
enableUnpublishedMode?: boolean;
|
6556
6224
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
6557
6225
|
customPublic?: {
|
6558
6226
|
[key: string]: unknown;
|
@@ -6659,6 +6327,8 @@ interface external$f {
|
|
6659
6327
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
6660
6328
|
*/
|
6661
6329
|
optionalPatternParameter?: boolean;
|
6330
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
6331
|
+
isDraft?: boolean;
|
6662
6332
|
variables?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
6663
6333
|
};
|
6664
6334
|
/** @description Variable values for a data resource */
|
@@ -7328,21 +6998,6 @@ interface external$e {
|
|
7328
6998
|
* this property will have a single value that is shared for all locales
|
7329
6999
|
*/
|
7330
7000
|
localizable?: boolean;
|
7331
|
-
/**
|
7332
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
7333
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
7334
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
7335
|
-
*
|
7336
|
-
* If `localized` is false, this has no effect.
|
7337
|
-
*/
|
7338
|
-
notLocalizedByDefault?: boolean;
|
7339
|
-
/**
|
7340
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
7341
|
-
* When combined with a localized value, each locale has independent conditional values.
|
7342
|
-
*
|
7343
|
-
* When not defined, conditional values are not allowed.
|
7344
|
-
*/
|
7345
|
-
allowConditionalValues?: boolean;
|
7346
7001
|
/** @description The configuration object for the type (type-specific) */
|
7347
7002
|
typeConfig?: unknown;
|
7348
7003
|
};
|
@@ -7551,65 +7206,6 @@ interface external$e {
|
|
7551
7206
|
locales?: {
|
7552
7207
|
[key: string]: unknown;
|
7553
7208
|
};
|
7554
|
-
conditions?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
7555
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
7556
|
-
localesConditions?: {
|
7557
|
-
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
7558
|
-
};
|
7559
|
-
};
|
7560
|
-
/**
|
7561
|
-
* @description Array of alternate values which are based on conditions.
|
7562
|
-
*
|
7563
|
-
* When requested with an explicit locale parameter, or via the route API:
|
7564
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
7565
|
-
* * If no conditions match, the `value` property is used.
|
7566
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
7567
|
-
*
|
7568
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
7569
|
-
*/
|
7570
|
-
ComponentParameterConditions: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
7571
|
-
/** @description Defines a conditional value for a component parameter */
|
7572
|
-
ComponentParameterConditionalValue: {
|
7573
|
-
when: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
7574
|
-
/**
|
7575
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
7576
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
7577
|
-
*/
|
7578
|
-
value: unknown;
|
7579
|
-
/**
|
7580
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
7581
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
7582
|
-
*/
|
7583
|
-
id: number;
|
7584
|
-
};
|
7585
|
-
/**
|
7586
|
-
* @deprecated
|
7587
|
-
* @description beta functionality subject to change
|
7588
|
-
*/
|
7589
|
-
VisibilityCriteriaGroup: {
|
7590
|
-
/**
|
7591
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
7592
|
-
* @enum {string}
|
7593
|
-
*/
|
7594
|
-
op?: "&" | "|";
|
7595
|
-
clauses: (external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
7596
|
-
};
|
7597
|
-
/**
|
7598
|
-
* @deprecated
|
7599
|
-
* @description beta functionality subject to change
|
7600
|
-
*/
|
7601
|
-
VisibilityCriteria: {
|
7602
|
-
/** @description The rule type to execute */
|
7603
|
-
rule: string;
|
7604
|
-
/**
|
7605
|
-
* @description The source value of the rule.
|
7606
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
7607
|
-
*/
|
7608
|
-
source?: string;
|
7609
|
-
/** @description The rule-definition-specific operator to test against */
|
7610
|
-
op: string;
|
7611
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
7612
|
-
value: string | string[];
|
7613
7209
|
};
|
7614
7210
|
/** @description Defines a connection to a dynamic token on a data resource */
|
7615
7211
|
DataElementConnectionDefinition: {
|
@@ -7856,6 +7452,11 @@ interface external$e {
|
|
7856
7452
|
localeMapping?: {
|
7857
7453
|
[key: string]: string;
|
7858
7454
|
};
|
7455
|
+
/**
|
7456
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
7457
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
7458
|
+
*/
|
7459
|
+
enableUnpublishedMode?: boolean;
|
7859
7460
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
7860
7461
|
customPublic?: {
|
7861
7462
|
[key: string]: unknown;
|
@@ -7962,6 +7563,8 @@ interface external$e {
|
|
7962
7563
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
7963
7564
|
*/
|
7964
7565
|
optionalPatternParameter?: boolean;
|
7566
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
7567
|
+
isDraft?: boolean;
|
7965
7568
|
variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
7966
7569
|
};
|
7967
7570
|
/** @description Variable values for a data resource */
|
@@ -8688,21 +8291,6 @@ interface external$d {
|
|
8688
8291
|
* this property will have a single value that is shared for all locales
|
8689
8292
|
*/
|
8690
8293
|
localizable?: boolean;
|
8691
|
-
/**
|
8692
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
8693
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
8694
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
8695
|
-
*
|
8696
|
-
* If `localized` is false, this has no effect.
|
8697
|
-
*/
|
8698
|
-
notLocalizedByDefault?: boolean;
|
8699
|
-
/**
|
8700
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
8701
|
-
* When combined with a localized value, each locale has independent conditional values.
|
8702
|
-
*
|
8703
|
-
* When not defined, conditional values are not allowed.
|
8704
|
-
*/
|
8705
|
-
allowConditionalValues?: boolean;
|
8706
8294
|
/** @description The configuration object for the type (type-specific) */
|
8707
8295
|
typeConfig?: unknown;
|
8708
8296
|
};
|
@@ -8911,65 +8499,6 @@ interface external$d {
|
|
8911
8499
|
locales?: {
|
8912
8500
|
[key: string]: unknown;
|
8913
8501
|
};
|
8914
|
-
conditions?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
8915
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
8916
|
-
localesConditions?: {
|
8917
|
-
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
8918
|
-
};
|
8919
|
-
};
|
8920
|
-
/**
|
8921
|
-
* @description Array of alternate values which are based on conditions.
|
8922
|
-
*
|
8923
|
-
* When requested with an explicit locale parameter, or via the route API:
|
8924
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
8925
|
-
* * If no conditions match, the `value` property is used.
|
8926
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
8927
|
-
*
|
8928
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
8929
|
-
*/
|
8930
|
-
ComponentParameterConditions: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
8931
|
-
/** @description Defines a conditional value for a component parameter */
|
8932
|
-
ComponentParameterConditionalValue: {
|
8933
|
-
when: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
8934
|
-
/**
|
8935
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
8936
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
8937
|
-
*/
|
8938
|
-
value: unknown;
|
8939
|
-
/**
|
8940
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
8941
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
8942
|
-
*/
|
8943
|
-
id: number;
|
8944
|
-
};
|
8945
|
-
/**
|
8946
|
-
* @deprecated
|
8947
|
-
* @description beta functionality subject to change
|
8948
|
-
*/
|
8949
|
-
VisibilityCriteriaGroup: {
|
8950
|
-
/**
|
8951
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
8952
|
-
* @enum {string}
|
8953
|
-
*/
|
8954
|
-
op?: "&" | "|";
|
8955
|
-
clauses: (external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
8956
|
-
};
|
8957
|
-
/**
|
8958
|
-
* @deprecated
|
8959
|
-
* @description beta functionality subject to change
|
8960
|
-
*/
|
8961
|
-
VisibilityCriteria: {
|
8962
|
-
/** @description The rule type to execute */
|
8963
|
-
rule: string;
|
8964
|
-
/**
|
8965
|
-
* @description The source value of the rule.
|
8966
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
8967
|
-
*/
|
8968
|
-
source?: string;
|
8969
|
-
/** @description The rule-definition-specific operator to test against */
|
8970
|
-
op: string;
|
8971
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
8972
|
-
value: string | string[];
|
8973
8502
|
};
|
8974
8503
|
/** @description Defines a connection to a dynamic token on a data resource */
|
8975
8504
|
DataElementConnectionDefinition: {
|
@@ -9216,6 +8745,11 @@ interface external$d {
|
|
9216
8745
|
localeMapping?: {
|
9217
8746
|
[key: string]: string;
|
9218
8747
|
};
|
8748
|
+
/**
|
8749
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
8750
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
8751
|
+
*/
|
8752
|
+
enableUnpublishedMode?: boolean;
|
9219
8753
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
9220
8754
|
customPublic?: {
|
9221
8755
|
[key: string]: unknown;
|
@@ -9322,6 +8856,8 @@ interface external$d {
|
|
9322
8856
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
9323
8857
|
*/
|
9324
8858
|
optionalPatternParameter?: boolean;
|
8859
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
8860
|
+
isDraft?: boolean;
|
9325
8861
|
variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
9326
8862
|
};
|
9327
8863
|
/** @description Variable values for a data resource */
|
@@ -9985,21 +9521,6 @@ interface external$c {
|
|
9985
9521
|
* this property will have a single value that is shared for all locales
|
9986
9522
|
*/
|
9987
9523
|
localizable?: boolean;
|
9988
|
-
/**
|
9989
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
9990
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
9991
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
9992
|
-
*
|
9993
|
-
* If `localized` is false, this has no effect.
|
9994
|
-
*/
|
9995
|
-
notLocalizedByDefault?: boolean;
|
9996
|
-
/**
|
9997
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
9998
|
-
* When combined with a localized value, each locale has independent conditional values.
|
9999
|
-
*
|
10000
|
-
* When not defined, conditional values are not allowed.
|
10001
|
-
*/
|
10002
|
-
allowConditionalValues?: boolean;
|
10003
9524
|
/** @description The configuration object for the type (type-specific) */
|
10004
9525
|
typeConfig?: unknown;
|
10005
9526
|
};
|
@@ -10208,65 +9729,6 @@ interface external$c {
|
|
10208
9729
|
locales?: {
|
10209
9730
|
[key: string]: unknown;
|
10210
9731
|
};
|
10211
|
-
conditions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
10212
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
10213
|
-
localesConditions?: {
|
10214
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
10215
|
-
};
|
10216
|
-
};
|
10217
|
-
/**
|
10218
|
-
* @description Array of alternate values which are based on conditions.
|
10219
|
-
*
|
10220
|
-
* When requested with an explicit locale parameter, or via the route API:
|
10221
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
10222
|
-
* * If no conditions match, the `value` property is used.
|
10223
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
10224
|
-
*
|
10225
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
10226
|
-
*/
|
10227
|
-
ComponentParameterConditions: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
10228
|
-
/** @description Defines a conditional value for a component parameter */
|
10229
|
-
ComponentParameterConditionalValue: {
|
10230
|
-
when: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
10231
|
-
/**
|
10232
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
10233
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
10234
|
-
*/
|
10235
|
-
value: unknown;
|
10236
|
-
/**
|
10237
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
10238
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
10239
|
-
*/
|
10240
|
-
id: number;
|
10241
|
-
};
|
10242
|
-
/**
|
10243
|
-
* @deprecated
|
10244
|
-
* @description beta functionality subject to change
|
10245
|
-
*/
|
10246
|
-
VisibilityCriteriaGroup: {
|
10247
|
-
/**
|
10248
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
10249
|
-
* @enum {string}
|
10250
|
-
*/
|
10251
|
-
op?: "&" | "|";
|
10252
|
-
clauses: (external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
10253
|
-
};
|
10254
|
-
/**
|
10255
|
-
* @deprecated
|
10256
|
-
* @description beta functionality subject to change
|
10257
|
-
*/
|
10258
|
-
VisibilityCriteria: {
|
10259
|
-
/** @description The rule type to execute */
|
10260
|
-
rule: string;
|
10261
|
-
/**
|
10262
|
-
* @description The source value of the rule.
|
10263
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
10264
|
-
*/
|
10265
|
-
source?: string;
|
10266
|
-
/** @description The rule-definition-specific operator to test against */
|
10267
|
-
op: string;
|
10268
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
10269
|
-
value: string | string[];
|
10270
9732
|
};
|
10271
9733
|
/** @description Defines a connection to a dynamic token on a data resource */
|
10272
9734
|
DataElementConnectionDefinition: {
|
@@ -10513,6 +9975,11 @@ interface external$c {
|
|
10513
9975
|
localeMapping?: {
|
10514
9976
|
[key: string]: string;
|
10515
9977
|
};
|
9978
|
+
/**
|
9979
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
9980
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
9981
|
+
*/
|
9982
|
+
enableUnpublishedMode?: boolean;
|
10516
9983
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
10517
9984
|
customPublic?: {
|
10518
9985
|
[key: string]: unknown;
|
@@ -10619,6 +10086,8 @@ interface external$c {
|
|
10619
10086
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
10620
10087
|
*/
|
10621
10088
|
optionalPatternParameter?: boolean;
|
10089
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
10090
|
+
isDraft?: boolean;
|
10622
10091
|
variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
10623
10092
|
};
|
10624
10093
|
/** @description Variable values for a data resource */
|
@@ -11317,21 +10786,6 @@ interface external$b {
|
|
11317
10786
|
* this property will have a single value that is shared for all locales
|
11318
10787
|
*/
|
11319
10788
|
localizable?: boolean;
|
11320
|
-
/**
|
11321
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
11322
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
11323
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
11324
|
-
*
|
11325
|
-
* If `localized` is false, this has no effect.
|
11326
|
-
*/
|
11327
|
-
notLocalizedByDefault?: boolean;
|
11328
|
-
/**
|
11329
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
11330
|
-
* When combined with a localized value, each locale has independent conditional values.
|
11331
|
-
*
|
11332
|
-
* When not defined, conditional values are not allowed.
|
11333
|
-
*/
|
11334
|
-
allowConditionalValues?: boolean;
|
11335
10789
|
/** @description The configuration object for the type (type-specific) */
|
11336
10790
|
typeConfig?: unknown;
|
11337
10791
|
};
|
@@ -11540,65 +10994,6 @@ interface external$b {
|
|
11540
10994
|
locales?: {
|
11541
10995
|
[key: string]: unknown;
|
11542
10996
|
};
|
11543
|
-
conditions?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
11544
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
11545
|
-
localesConditions?: {
|
11546
|
-
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
11547
|
-
};
|
11548
|
-
};
|
11549
|
-
/**
|
11550
|
-
* @description Array of alternate values which are based on conditions.
|
11551
|
-
*
|
11552
|
-
* When requested with an explicit locale parameter, or via the route API:
|
11553
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
11554
|
-
* * If no conditions match, the `value` property is used.
|
11555
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
11556
|
-
*
|
11557
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
11558
|
-
*/
|
11559
|
-
ComponentParameterConditions: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
11560
|
-
/** @description Defines a conditional value for a component parameter */
|
11561
|
-
ComponentParameterConditionalValue: {
|
11562
|
-
when: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
11563
|
-
/**
|
11564
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
11565
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
11566
|
-
*/
|
11567
|
-
value: unknown;
|
11568
|
-
/**
|
11569
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
11570
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
11571
|
-
*/
|
11572
|
-
id: number;
|
11573
|
-
};
|
11574
|
-
/**
|
11575
|
-
* @deprecated
|
11576
|
-
* @description beta functionality subject to change
|
11577
|
-
*/
|
11578
|
-
VisibilityCriteriaGroup: {
|
11579
|
-
/**
|
11580
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
11581
|
-
* @enum {string}
|
11582
|
-
*/
|
11583
|
-
op?: "&" | "|";
|
11584
|
-
clauses: (external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
11585
|
-
};
|
11586
|
-
/**
|
11587
|
-
* @deprecated
|
11588
|
-
* @description beta functionality subject to change
|
11589
|
-
*/
|
11590
|
-
VisibilityCriteria: {
|
11591
|
-
/** @description The rule type to execute */
|
11592
|
-
rule: string;
|
11593
|
-
/**
|
11594
|
-
* @description The source value of the rule.
|
11595
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
11596
|
-
*/
|
11597
|
-
source?: string;
|
11598
|
-
/** @description The rule-definition-specific operator to test against */
|
11599
|
-
op: string;
|
11600
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
11601
|
-
value: string | string[];
|
11602
10997
|
};
|
11603
10998
|
/** @description Defines a connection to a dynamic token on a data resource */
|
11604
10999
|
DataElementConnectionDefinition: {
|
@@ -11845,6 +11240,11 @@ interface external$b {
|
|
11845
11240
|
localeMapping?: {
|
11846
11241
|
[key: string]: string;
|
11847
11242
|
};
|
11243
|
+
/**
|
11244
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
11245
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
11246
|
+
*/
|
11247
|
+
enableUnpublishedMode?: boolean;
|
11848
11248
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
11849
11249
|
customPublic?: {
|
11850
11250
|
[key: string]: unknown;
|
@@ -11951,6 +11351,8 @@ interface external$b {
|
|
11951
11351
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
11952
11352
|
*/
|
11953
11353
|
optionalPatternParameter?: boolean;
|
11354
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
11355
|
+
isDraft?: boolean;
|
11954
11356
|
variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
11955
11357
|
};
|
11956
11358
|
/** @description Variable values for a data resource */
|
@@ -12649,21 +12051,6 @@ interface external$a {
|
|
12649
12051
|
* this property will have a single value that is shared for all locales
|
12650
12052
|
*/
|
12651
12053
|
localizable?: boolean;
|
12652
|
-
/**
|
12653
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
12654
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
12655
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
12656
|
-
*
|
12657
|
-
* If `localized` is false, this has no effect.
|
12658
|
-
*/
|
12659
|
-
notLocalizedByDefault?: boolean;
|
12660
|
-
/**
|
12661
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
12662
|
-
* When combined with a localized value, each locale has independent conditional values.
|
12663
|
-
*
|
12664
|
-
* When not defined, conditional values are not allowed.
|
12665
|
-
*/
|
12666
|
-
allowConditionalValues?: boolean;
|
12667
12054
|
/** @description The configuration object for the type (type-specific) */
|
12668
12055
|
typeConfig?: unknown;
|
12669
12056
|
};
|
@@ -12872,65 +12259,6 @@ interface external$a {
|
|
12872
12259
|
locales?: {
|
12873
12260
|
[key: string]: unknown;
|
12874
12261
|
};
|
12875
|
-
conditions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
12876
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
12877
|
-
localesConditions?: {
|
12878
|
-
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
12879
|
-
};
|
12880
|
-
};
|
12881
|
-
/**
|
12882
|
-
* @description Array of alternate values which are based on conditions.
|
12883
|
-
*
|
12884
|
-
* When requested with an explicit locale parameter, or via the route API:
|
12885
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
12886
|
-
* * If no conditions match, the `value` property is used.
|
12887
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
12888
|
-
*
|
12889
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
12890
|
-
*/
|
12891
|
-
ComponentParameterConditions: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
12892
|
-
/** @description Defines a conditional value for a component parameter */
|
12893
|
-
ComponentParameterConditionalValue: {
|
12894
|
-
when: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
12895
|
-
/**
|
12896
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
12897
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
12898
|
-
*/
|
12899
|
-
value: unknown;
|
12900
|
-
/**
|
12901
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
12902
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
12903
|
-
*/
|
12904
|
-
id: number;
|
12905
|
-
};
|
12906
|
-
/**
|
12907
|
-
* @deprecated
|
12908
|
-
* @description beta functionality subject to change
|
12909
|
-
*/
|
12910
|
-
VisibilityCriteriaGroup: {
|
12911
|
-
/**
|
12912
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
12913
|
-
* @enum {string}
|
12914
|
-
*/
|
12915
|
-
op?: "&" | "|";
|
12916
|
-
clauses: (external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
12917
|
-
};
|
12918
|
-
/**
|
12919
|
-
* @deprecated
|
12920
|
-
* @description beta functionality subject to change
|
12921
|
-
*/
|
12922
|
-
VisibilityCriteria: {
|
12923
|
-
/** @description The rule type to execute */
|
12924
|
-
rule: string;
|
12925
|
-
/**
|
12926
|
-
* @description The source value of the rule.
|
12927
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
12928
|
-
*/
|
12929
|
-
source?: string;
|
12930
|
-
/** @description The rule-definition-specific operator to test against */
|
12931
|
-
op: string;
|
12932
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
12933
|
-
value: string | string[];
|
12934
12262
|
};
|
12935
12263
|
/** @description Defines a connection to a dynamic token on a data resource */
|
12936
12264
|
DataElementConnectionDefinition: {
|
@@ -13177,6 +12505,11 @@ interface external$a {
|
|
13177
12505
|
localeMapping?: {
|
13178
12506
|
[key: string]: string;
|
13179
12507
|
};
|
12508
|
+
/**
|
12509
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
12510
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
12511
|
+
*/
|
12512
|
+
enableUnpublishedMode?: boolean;
|
13180
12513
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
13181
12514
|
customPublic?: {
|
13182
12515
|
[key: string]: unknown;
|
@@ -13283,6 +12616,8 @@ interface external$a {
|
|
13283
12616
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
13284
12617
|
*/
|
13285
12618
|
optionalPatternParameter?: boolean;
|
12619
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
12620
|
+
isDraft?: boolean;
|
13286
12621
|
variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
13287
12622
|
};
|
13288
12623
|
/** @description Variable values for a data resource */
|
@@ -14718,21 +14053,6 @@ interface external$8 {
|
|
14718
14053
|
* this property will have a single value that is shared for all locales
|
14719
14054
|
*/
|
14720
14055
|
localizable?: boolean;
|
14721
|
-
/**
|
14722
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
14723
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
14724
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
14725
|
-
*
|
14726
|
-
* If `localized` is false, this has no effect.
|
14727
|
-
*/
|
14728
|
-
notLocalizedByDefault?: boolean;
|
14729
|
-
/**
|
14730
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
14731
|
-
* When combined with a localized value, each locale has independent conditional values.
|
14732
|
-
*
|
14733
|
-
* When not defined, conditional values are not allowed.
|
14734
|
-
*/
|
14735
|
-
allowConditionalValues?: boolean;
|
14736
14056
|
/** @description The configuration object for the type (type-specific) */
|
14737
14057
|
typeConfig?: unknown;
|
14738
14058
|
};
|
@@ -14926,80 +14246,21 @@ interface external$8 {
|
|
14926
14246
|
*/
|
14927
14247
|
workflowId?: string;
|
14928
14248
|
};
|
14929
|
-
/** @description Defines an editable parameter on a component */
|
14930
|
-
ComponentParameter: {
|
14931
|
-
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
14932
|
-
value?: unknown;
|
14933
|
-
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
14934
|
-
type: string;
|
14935
|
-
/** @deprecated */
|
14936
|
-
connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
14937
|
-
/**
|
14938
|
-
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
14939
|
-
* Note that locales must be registered on the entry/composition `_locales` before being used
|
14940
|
-
*/
|
14941
|
-
locales?: {
|
14942
|
-
[key: string]: unknown;
|
14943
|
-
};
|
14944
|
-
conditions?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
14945
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
14946
|
-
localesConditions?: {
|
14947
|
-
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
14948
|
-
};
|
14949
|
-
};
|
14950
|
-
/**
|
14951
|
-
* @description Array of alternate values which are based on conditions.
|
14952
|
-
*
|
14953
|
-
* When requested with an explicit locale parameter, or via the route API:
|
14954
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
14955
|
-
* * If no conditions match, the `value` property is used.
|
14956
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
14957
|
-
*
|
14958
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
14959
|
-
*/
|
14960
|
-
ComponentParameterConditions: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
14961
|
-
/** @description Defines a conditional value for a component parameter */
|
14962
|
-
ComponentParameterConditionalValue: {
|
14963
|
-
when: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
14964
|
-
/**
|
14965
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
14966
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
14967
|
-
*/
|
14968
|
-
value: unknown;
|
14969
|
-
/**
|
14970
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
14971
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
14972
|
-
*/
|
14973
|
-
id: number;
|
14974
|
-
};
|
14975
|
-
/**
|
14976
|
-
* @deprecated
|
14977
|
-
* @description beta functionality subject to change
|
14978
|
-
*/
|
14979
|
-
VisibilityCriteriaGroup: {
|
14980
|
-
/**
|
14981
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
14982
|
-
* @enum {string}
|
14983
|
-
*/
|
14984
|
-
op?: "&" | "|";
|
14985
|
-
clauses: (external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
14986
|
-
};
|
14987
|
-
/**
|
14988
|
-
* @deprecated
|
14989
|
-
* @description beta functionality subject to change
|
14990
|
-
*/
|
14991
|
-
VisibilityCriteria: {
|
14992
|
-
/** @description The rule type to execute */
|
14993
|
-
rule: string;
|
14249
|
+
/** @description Defines an editable parameter on a component */
|
14250
|
+
ComponentParameter: {
|
14251
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
14252
|
+
value?: unknown;
|
14253
|
+
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
14254
|
+
type: string;
|
14255
|
+
/** @deprecated */
|
14256
|
+
connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
14994
14257
|
/**
|
14995
|
-
* @description
|
14996
|
-
*
|
14258
|
+
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
14259
|
+
* Note that locales must be registered on the entry/composition `_locales` before being used
|
14997
14260
|
*/
|
14998
|
-
|
14999
|
-
|
15000
|
-
|
15001
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
15002
|
-
value: string | string[];
|
14261
|
+
locales?: {
|
14262
|
+
[key: string]: unknown;
|
14263
|
+
};
|
15003
14264
|
};
|
15004
14265
|
/** @description Defines a connection to a dynamic token on a data resource */
|
15005
14266
|
DataElementConnectionDefinition: {
|
@@ -15246,6 +14507,11 @@ interface external$8 {
|
|
15246
14507
|
localeMapping?: {
|
15247
14508
|
[key: string]: string;
|
15248
14509
|
};
|
14510
|
+
/**
|
14511
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
14512
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
14513
|
+
*/
|
14514
|
+
enableUnpublishedMode?: boolean;
|
15249
14515
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
15250
14516
|
customPublic?: {
|
15251
14517
|
[key: string]: unknown;
|
@@ -15352,6 +14618,8 @@ interface external$8 {
|
|
15352
14618
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
15353
14619
|
*/
|
15354
14620
|
optionalPatternParameter?: boolean;
|
14621
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
14622
|
+
isDraft?: boolean;
|
15355
14623
|
variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
15356
14624
|
};
|
15357
14625
|
/** @description Variable values for a data resource */
|
@@ -16021,21 +15289,6 @@ interface external$7 {
|
|
16021
15289
|
* this property will have a single value that is shared for all locales
|
16022
15290
|
*/
|
16023
15291
|
localizable?: boolean;
|
16024
|
-
/**
|
16025
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
16026
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
16027
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
16028
|
-
*
|
16029
|
-
* If `localized` is false, this has no effect.
|
16030
|
-
*/
|
16031
|
-
notLocalizedByDefault?: boolean;
|
16032
|
-
/**
|
16033
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
16034
|
-
* When combined with a localized value, each locale has independent conditional values.
|
16035
|
-
*
|
16036
|
-
* When not defined, conditional values are not allowed.
|
16037
|
-
*/
|
16038
|
-
allowConditionalValues?: boolean;
|
16039
15292
|
/** @description The configuration object for the type (type-specific) */
|
16040
15293
|
typeConfig?: unknown;
|
16041
15294
|
};
|
@@ -16244,65 +15497,6 @@ interface external$7 {
|
|
16244
15497
|
locales?: {
|
16245
15498
|
[key: string]: unknown;
|
16246
15499
|
};
|
16247
|
-
conditions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
16248
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
16249
|
-
localesConditions?: {
|
16250
|
-
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
16251
|
-
};
|
16252
|
-
};
|
16253
|
-
/**
|
16254
|
-
* @description Array of alternate values which are based on conditions.
|
16255
|
-
*
|
16256
|
-
* When requested with an explicit locale parameter, or via the route API:
|
16257
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
16258
|
-
* * If no conditions match, the `value` property is used.
|
16259
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
16260
|
-
*
|
16261
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
16262
|
-
*/
|
16263
|
-
ComponentParameterConditions: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
16264
|
-
/** @description Defines a conditional value for a component parameter */
|
16265
|
-
ComponentParameterConditionalValue: {
|
16266
|
-
when: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
16267
|
-
/**
|
16268
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
16269
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
16270
|
-
*/
|
16271
|
-
value: unknown;
|
16272
|
-
/**
|
16273
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
16274
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
16275
|
-
*/
|
16276
|
-
id: number;
|
16277
|
-
};
|
16278
|
-
/**
|
16279
|
-
* @deprecated
|
16280
|
-
* @description beta functionality subject to change
|
16281
|
-
*/
|
16282
|
-
VisibilityCriteriaGroup: {
|
16283
|
-
/**
|
16284
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
16285
|
-
* @enum {string}
|
16286
|
-
*/
|
16287
|
-
op?: "&" | "|";
|
16288
|
-
clauses: (external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
16289
|
-
};
|
16290
|
-
/**
|
16291
|
-
* @deprecated
|
16292
|
-
* @description beta functionality subject to change
|
16293
|
-
*/
|
16294
|
-
VisibilityCriteria: {
|
16295
|
-
/** @description The rule type to execute */
|
16296
|
-
rule: string;
|
16297
|
-
/**
|
16298
|
-
* @description The source value of the rule.
|
16299
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
16300
|
-
*/
|
16301
|
-
source?: string;
|
16302
|
-
/** @description The rule-definition-specific operator to test against */
|
16303
|
-
op: string;
|
16304
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
16305
|
-
value: string | string[];
|
16306
15500
|
};
|
16307
15501
|
/** @description Defines a connection to a dynamic token on a data resource */
|
16308
15502
|
DataElementConnectionDefinition: {
|
@@ -16549,6 +15743,11 @@ interface external$7 {
|
|
16549
15743
|
localeMapping?: {
|
16550
15744
|
[key: string]: string;
|
16551
15745
|
};
|
15746
|
+
/**
|
15747
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
15748
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
15749
|
+
*/
|
15750
|
+
enableUnpublishedMode?: boolean;
|
16552
15751
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
16553
15752
|
customPublic?: {
|
16554
15753
|
[key: string]: unknown;
|
@@ -16655,6 +15854,8 @@ interface external$7 {
|
|
16655
15854
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
16656
15855
|
*/
|
16657
15856
|
optionalPatternParameter?: boolean;
|
15857
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
15858
|
+
isDraft?: boolean;
|
16658
15859
|
variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
16659
15860
|
};
|
16660
15861
|
/** @description Variable values for a data resource */
|
@@ -17348,7 +16549,6 @@ interface components$4 {
|
|
17348
16549
|
inputName?: string;
|
17349
16550
|
code?: string;
|
17350
16551
|
locale?: string;
|
17351
|
-
conditionIndex?: number;
|
17352
16552
|
};
|
17353
16553
|
};
|
17354
16554
|
responses: {
|
@@ -17465,21 +16665,6 @@ interface external$6 {
|
|
17465
16665
|
* this property will have a single value that is shared for all locales
|
17466
16666
|
*/
|
17467
16667
|
localizable?: boolean;
|
17468
|
-
/**
|
17469
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
17470
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
17471
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
17472
|
-
*
|
17473
|
-
* If `localized` is false, this has no effect.
|
17474
|
-
*/
|
17475
|
-
notLocalizedByDefault?: boolean;
|
17476
|
-
/**
|
17477
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
17478
|
-
* When combined with a localized value, each locale has independent conditional values.
|
17479
|
-
*
|
17480
|
-
* When not defined, conditional values are not allowed.
|
17481
|
-
*/
|
17482
|
-
allowConditionalValues?: boolean;
|
17483
16668
|
/** @description The configuration object for the type (type-specific) */
|
17484
16669
|
typeConfig?: unknown;
|
17485
16670
|
};
|
@@ -17688,65 +16873,6 @@ interface external$6 {
|
|
17688
16873
|
locales?: {
|
17689
16874
|
[key: string]: unknown;
|
17690
16875
|
};
|
17691
|
-
conditions?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
17692
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
17693
|
-
localesConditions?: {
|
17694
|
-
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
17695
|
-
};
|
17696
|
-
};
|
17697
|
-
/**
|
17698
|
-
* @description Array of alternate values which are based on conditions.
|
17699
|
-
*
|
17700
|
-
* When requested with an explicit locale parameter, or via the route API:
|
17701
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
17702
|
-
* * If no conditions match, the `value` property is used.
|
17703
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
17704
|
-
*
|
17705
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
17706
|
-
*/
|
17707
|
-
ComponentParameterConditions: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
17708
|
-
/** @description Defines a conditional value for a component parameter */
|
17709
|
-
ComponentParameterConditionalValue: {
|
17710
|
-
when: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
17711
|
-
/**
|
17712
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
17713
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
17714
|
-
*/
|
17715
|
-
value: unknown;
|
17716
|
-
/**
|
17717
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
17718
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
17719
|
-
*/
|
17720
|
-
id: number;
|
17721
|
-
};
|
17722
|
-
/**
|
17723
|
-
* @deprecated
|
17724
|
-
* @description beta functionality subject to change
|
17725
|
-
*/
|
17726
|
-
VisibilityCriteriaGroup: {
|
17727
|
-
/**
|
17728
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
17729
|
-
* @enum {string}
|
17730
|
-
*/
|
17731
|
-
op?: "&" | "|";
|
17732
|
-
clauses: (external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
17733
|
-
};
|
17734
|
-
/**
|
17735
|
-
* @deprecated
|
17736
|
-
* @description beta functionality subject to change
|
17737
|
-
*/
|
17738
|
-
VisibilityCriteria: {
|
17739
|
-
/** @description The rule type to execute */
|
17740
|
-
rule: string;
|
17741
|
-
/**
|
17742
|
-
* @description The source value of the rule.
|
17743
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
17744
|
-
*/
|
17745
|
-
source?: string;
|
17746
|
-
/** @description The rule-definition-specific operator to test against */
|
17747
|
-
op: string;
|
17748
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
17749
|
-
value: string | string[];
|
17750
16876
|
};
|
17751
16877
|
/** @description Defines a connection to a dynamic token on a data resource */
|
17752
16878
|
DataElementConnectionDefinition: {
|
@@ -17993,6 +17119,11 @@ interface external$6 {
|
|
17993
17119
|
localeMapping?: {
|
17994
17120
|
[key: string]: string;
|
17995
17121
|
};
|
17122
|
+
/**
|
17123
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
17124
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
17125
|
+
*/
|
17126
|
+
enableUnpublishedMode?: boolean;
|
17996
17127
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
17997
17128
|
customPublic?: {
|
17998
17129
|
[key: string]: unknown;
|
@@ -18099,6 +17230,8 @@ interface external$6 {
|
|
18099
17230
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
18100
17231
|
*/
|
18101
17232
|
optionalPatternParameter?: boolean;
|
17233
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
17234
|
+
isDraft?: boolean;
|
18102
17235
|
variables?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
18103
17236
|
};
|
18104
17237
|
/** @description Variable values for a data resource */
|
@@ -19317,6 +18450,11 @@ interface external$6 {
|
|
19317
18450
|
workflowStageId?: string;
|
19318
18451
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
19319
18452
|
workflowDefinition?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowDefinition"];
|
18453
|
+
/**
|
18454
|
+
* @description Only present if an imcomplete entry is returned; indicates reason for stubbing
|
18455
|
+
* @enum {string}
|
18456
|
+
*/
|
18457
|
+
stubType?: "missing" | "tooDeep";
|
19320
18458
|
};
|
19321
18459
|
EntryListResponse: {
|
19322
18460
|
entries: external$6["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"][];
|
@@ -20042,6 +19180,8 @@ interface external$6 {
|
|
20042
19180
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
20043
19181
|
*/
|
20044
19182
|
releaseId?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["releaseId"];
|
19183
|
+
/** If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
|
19184
|
+
isDraft?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["isDraft"];
|
20045
19185
|
};
|
20046
19186
|
};
|
20047
19187
|
responses: {
|
@@ -20087,6 +19227,11 @@ interface external$6 {
|
|
20087
19227
|
/** @description The route that was matched in the project map */
|
20088
19228
|
matchedRoute: string;
|
20089
19229
|
dynamicInputs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
|
19230
|
+
/**
|
19231
|
+
* @description If true, the response includes draft/unpublished/modified content.
|
19232
|
+
* If false, such content is excluded.
|
19233
|
+
*/
|
19234
|
+
isDraft?: boolean;
|
20090
19235
|
/** @enum {string} */
|
20091
19236
|
type: "composition";
|
20092
19237
|
compositionApiResponse: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
@@ -20167,6 +19312,8 @@ interface external$6 {
|
|
20167
19312
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
20168
19313
|
*/
|
20169
19314
|
releaseId: string;
|
19315
|
+
/** @description If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
|
19316
|
+
isDraft: boolean;
|
20170
19317
|
};
|
20171
19318
|
};
|
20172
19319
|
operations: {};
|
@@ -20242,6 +19389,8 @@ interface paths$5 {
|
|
20242
19389
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
20243
19390
|
*/
|
20244
19391
|
releaseId?: components$3["parameters"]["releaseId"];
|
19392
|
+
/** If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
|
19393
|
+
isDraft?: components$3["parameters"]["isDraft"];
|
20245
19394
|
};
|
20246
19395
|
};
|
20247
19396
|
responses: {
|
@@ -20287,6 +19436,11 @@ interface components$3 {
|
|
20287
19436
|
/** @description The route that was matched in the project map */
|
20288
19437
|
matchedRoute: string;
|
20289
19438
|
dynamicInputs?: components$3["schemas"]["RouteDynamicInputs"];
|
19439
|
+
/**
|
19440
|
+
* @description If true, the response includes draft/unpublished/modified content.
|
19441
|
+
* If false, such content is excluded.
|
19442
|
+
*/
|
19443
|
+
isDraft?: boolean;
|
20290
19444
|
/** @enum {string} */
|
20291
19445
|
type: "composition";
|
20292
19446
|
compositionApiResponse: external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
@@ -20367,6 +19521,8 @@ interface components$3 {
|
|
20367
19521
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
20368
19522
|
*/
|
20369
19523
|
releaseId: string;
|
19524
|
+
/** @description If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
|
19525
|
+
isDraft: boolean;
|
20370
19526
|
};
|
20371
19527
|
}
|
20372
19528
|
interface external$5 {
|
@@ -20432,21 +19588,6 @@ interface external$5 {
|
|
20432
19588
|
* this property will have a single value that is shared for all locales
|
20433
19589
|
*/
|
20434
19590
|
localizable?: boolean;
|
20435
|
-
/**
|
20436
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
20437
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
20438
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
20439
|
-
*
|
20440
|
-
* If `localized` is false, this has no effect.
|
20441
|
-
*/
|
20442
|
-
notLocalizedByDefault?: boolean;
|
20443
|
-
/**
|
20444
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
20445
|
-
* When combined with a localized value, each locale has independent conditional values.
|
20446
|
-
*
|
20447
|
-
* When not defined, conditional values are not allowed.
|
20448
|
-
*/
|
20449
|
-
allowConditionalValues?: boolean;
|
20450
19591
|
/** @description The configuration object for the type (type-specific) */
|
20451
19592
|
typeConfig?: unknown;
|
20452
19593
|
};
|
@@ -20655,65 +19796,6 @@ interface external$5 {
|
|
20655
19796
|
locales?: {
|
20656
19797
|
[key: string]: unknown;
|
20657
19798
|
};
|
20658
|
-
conditions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
20659
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
20660
|
-
localesConditions?: {
|
20661
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
20662
|
-
};
|
20663
|
-
};
|
20664
|
-
/**
|
20665
|
-
* @description Array of alternate values which are based on conditions.
|
20666
|
-
*
|
20667
|
-
* When requested with an explicit locale parameter, or via the route API:
|
20668
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
20669
|
-
* * If no conditions match, the `value` property is used.
|
20670
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
20671
|
-
*
|
20672
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
20673
|
-
*/
|
20674
|
-
ComponentParameterConditions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
20675
|
-
/** @description Defines a conditional value for a component parameter */
|
20676
|
-
ComponentParameterConditionalValue: {
|
20677
|
-
when: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
20678
|
-
/**
|
20679
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
20680
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
20681
|
-
*/
|
20682
|
-
value: unknown;
|
20683
|
-
/**
|
20684
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
20685
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
20686
|
-
*/
|
20687
|
-
id: number;
|
20688
|
-
};
|
20689
|
-
/**
|
20690
|
-
* @deprecated
|
20691
|
-
* @description beta functionality subject to change
|
20692
|
-
*/
|
20693
|
-
VisibilityCriteriaGroup: {
|
20694
|
-
/**
|
20695
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
20696
|
-
* @enum {string}
|
20697
|
-
*/
|
20698
|
-
op?: "&" | "|";
|
20699
|
-
clauses: (external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
20700
|
-
};
|
20701
|
-
/**
|
20702
|
-
* @deprecated
|
20703
|
-
* @description beta functionality subject to change
|
20704
|
-
*/
|
20705
|
-
VisibilityCriteria: {
|
20706
|
-
/** @description The rule type to execute */
|
20707
|
-
rule: string;
|
20708
|
-
/**
|
20709
|
-
* @description The source value of the rule.
|
20710
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
20711
|
-
*/
|
20712
|
-
source?: string;
|
20713
|
-
/** @description The rule-definition-specific operator to test against */
|
20714
|
-
op: string;
|
20715
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
20716
|
-
value: string | string[];
|
20717
19799
|
};
|
20718
19800
|
/** @description Defines a connection to a dynamic token on a data resource */
|
20719
19801
|
DataElementConnectionDefinition: {
|
@@ -20960,6 +20042,11 @@ interface external$5 {
|
|
20960
20042
|
localeMapping?: {
|
20961
20043
|
[key: string]: string;
|
20962
20044
|
};
|
20045
|
+
/**
|
20046
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
20047
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
20048
|
+
*/
|
20049
|
+
enableUnpublishedMode?: boolean;
|
20963
20050
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
20964
20051
|
customPublic?: {
|
20965
20052
|
[key: string]: unknown;
|
@@ -21066,6 +20153,8 @@ interface external$5 {
|
|
21066
20153
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
21067
20154
|
*/
|
21068
20155
|
optionalPatternParameter?: boolean;
|
20156
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
20157
|
+
isDraft?: boolean;
|
21069
20158
|
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
21070
20159
|
};
|
21071
20160
|
/** @description Variable values for a data resource */
|
@@ -22577,9 +21666,10 @@ type DataResolutionParameters = {
|
|
22577
21666
|
* Controls how many levels deep content references should be resolved.
|
22578
21667
|
*/
|
22579
21668
|
resolutionDepth?: number;
|
21669
|
+
isDraft?: boolean;
|
22580
21670
|
};
|
22581
21671
|
/** Types of issue that can occur when fetching composition data */
|
22582
|
-
type DataResolutionIssue = PatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
21672
|
+
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
22583
21673
|
/** @deprecated use DataResolutionIssue instead */
|
22584
21674
|
type CompositionIssue = DataResolutionIssue;
|
22585
21675
|
type DataResolutionIssueCore = components$4['schemas']['DataResolutionIssue'];
|
@@ -22594,7 +21684,6 @@ type CompositionPatternIssue = PatternIssue;
|
|
22594
21684
|
type DataElementBindingIssue = DataResolutionIssueCore & {
|
22595
21685
|
type: 'binding';
|
22596
21686
|
parameterName: string;
|
22597
|
-
conditionIndex?: number;
|
22598
21687
|
expression?: DataElementConnectionDefinition;
|
22599
21688
|
};
|
22600
21689
|
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
@@ -22603,6 +21692,10 @@ type DataResourceIssue = DataResolutionIssueCore & {
|
|
22603
21692
|
dataName: string;
|
22604
21693
|
dataType: string;
|
22605
21694
|
};
|
21695
|
+
type MaxDepthExceededIssue = DataResolutionIssueCore & {
|
21696
|
+
type: 'maxDepthExceeded';
|
21697
|
+
resolutionDepth: number;
|
21698
|
+
};
|
22606
21699
|
/**
|
22607
21700
|
* An issue that occurred while binding dynamic inputs to composition data resources,
|
22608
21701
|
* specifically when an expected dynamic input did not have a value.
|
@@ -22674,7 +21767,6 @@ type ContextualEditingComponentReference = {
|
|
22674
21767
|
isReadOnly?: boolean;
|
22675
21768
|
localizable?: boolean;
|
22676
21769
|
targetLocale?: Locale;
|
22677
|
-
targetConditionIndex: number;
|
22678
21770
|
}>;
|
22679
21771
|
/** The ID of the pattern if the component is actually a pattern node. */
|
22680
21772
|
patternId?: string;
|
@@ -23286,21 +22378,6 @@ interface external$3 {
|
|
23286
22378
|
* this property will have a single value that is shared for all locales
|
23287
22379
|
*/
|
23288
22380
|
localizable?: boolean;
|
23289
|
-
/**
|
23290
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
23291
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
23292
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
23293
|
-
*
|
23294
|
-
* If `localized` is false, this has no effect.
|
23295
|
-
*/
|
23296
|
-
notLocalizedByDefault?: boolean;
|
23297
|
-
/**
|
23298
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
23299
|
-
* When combined with a localized value, each locale has independent conditional values.
|
23300
|
-
*
|
23301
|
-
* When not defined, conditional values are not allowed.
|
23302
|
-
*/
|
23303
|
-
allowConditionalValues?: boolean;
|
23304
22381
|
/** @description The configuration object for the type (type-specific) */
|
23305
22382
|
typeConfig?: unknown;
|
23306
22383
|
};
|
@@ -23509,65 +22586,6 @@ interface external$3 {
|
|
23509
22586
|
locales?: {
|
23510
22587
|
[key: string]: unknown;
|
23511
22588
|
};
|
23512
|
-
conditions?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
23513
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
23514
|
-
localesConditions?: {
|
23515
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
23516
|
-
};
|
23517
|
-
};
|
23518
|
-
/**
|
23519
|
-
* @description Array of alternate values which are based on conditions.
|
23520
|
-
*
|
23521
|
-
* When requested with an explicit locale parameter, or via the route API:
|
23522
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
23523
|
-
* * If no conditions match, the `value` property is used.
|
23524
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
23525
|
-
*
|
23526
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
23527
|
-
*/
|
23528
|
-
ComponentParameterConditions: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
23529
|
-
/** @description Defines a conditional value for a component parameter */
|
23530
|
-
ComponentParameterConditionalValue: {
|
23531
|
-
when: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
23532
|
-
/**
|
23533
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
23534
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
23535
|
-
*/
|
23536
|
-
value: unknown;
|
23537
|
-
/**
|
23538
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
23539
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
23540
|
-
*/
|
23541
|
-
id: number;
|
23542
|
-
};
|
23543
|
-
/**
|
23544
|
-
* @deprecated
|
23545
|
-
* @description beta functionality subject to change
|
23546
|
-
*/
|
23547
|
-
VisibilityCriteriaGroup: {
|
23548
|
-
/**
|
23549
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
23550
|
-
* @enum {string}
|
23551
|
-
*/
|
23552
|
-
op?: "&" | "|";
|
23553
|
-
clauses: (external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
23554
|
-
};
|
23555
|
-
/**
|
23556
|
-
* @deprecated
|
23557
|
-
* @description beta functionality subject to change
|
23558
|
-
*/
|
23559
|
-
VisibilityCriteria: {
|
23560
|
-
/** @description The rule type to execute */
|
23561
|
-
rule: string;
|
23562
|
-
/**
|
23563
|
-
* @description The source value of the rule.
|
23564
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
23565
|
-
*/
|
23566
|
-
source?: string;
|
23567
|
-
/** @description The rule-definition-specific operator to test against */
|
23568
|
-
op: string;
|
23569
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
23570
|
-
value: string | string[];
|
23571
22589
|
};
|
23572
22590
|
/** @description Defines a connection to a dynamic token on a data resource */
|
23573
22591
|
DataElementConnectionDefinition: {
|
@@ -23814,6 +22832,11 @@ interface external$3 {
|
|
23814
22832
|
localeMapping?: {
|
23815
22833
|
[key: string]: string;
|
23816
22834
|
};
|
22835
|
+
/**
|
22836
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
22837
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
22838
|
+
*/
|
22839
|
+
enableUnpublishedMode?: boolean;
|
23817
22840
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
23818
22841
|
customPublic?: {
|
23819
22842
|
[key: string]: unknown;
|
@@ -23920,6 +22943,8 @@ interface external$3 {
|
|
23920
22943
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
23921
22944
|
*/
|
23922
22945
|
optionalPatternParameter?: boolean;
|
22946
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
22947
|
+
isDraft?: boolean;
|
23923
22948
|
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
23924
22949
|
};
|
23925
22950
|
/** @description Variable values for a data resource */
|
@@ -24875,21 +23900,6 @@ interface external$1 {
|
|
24875
23900
|
* this property will have a single value that is shared for all locales
|
24876
23901
|
*/
|
24877
23902
|
localizable?: boolean;
|
24878
|
-
/**
|
24879
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
24880
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
24881
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
24882
|
-
*
|
24883
|
-
* If `localized` is false, this has no effect.
|
24884
|
-
*/
|
24885
|
-
notLocalizedByDefault?: boolean;
|
24886
|
-
/**
|
24887
|
-
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
24888
|
-
* When combined with a localized value, each locale has independent conditional values.
|
24889
|
-
*
|
24890
|
-
* When not defined, conditional values are not allowed.
|
24891
|
-
*/
|
24892
|
-
allowConditionalValues?: boolean;
|
24893
23903
|
/** @description The configuration object for the type (type-specific) */
|
24894
23904
|
typeConfig?: unknown;
|
24895
23905
|
};
|
@@ -25098,65 +24108,6 @@ interface external$1 {
|
|
25098
24108
|
locales?: {
|
25099
24109
|
[key: string]: unknown;
|
25100
24110
|
};
|
25101
|
-
conditions?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
25102
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
25103
|
-
localesConditions?: {
|
25104
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
25105
|
-
};
|
25106
|
-
};
|
25107
|
-
/**
|
25108
|
-
* @description Array of alternate values which are based on conditions.
|
25109
|
-
*
|
25110
|
-
* When requested with an explicit locale parameter, or via the route API:
|
25111
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
25112
|
-
* * If no conditions match, the `value` property is used.
|
25113
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
25114
|
-
*
|
25115
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
25116
|
-
*/
|
25117
|
-
ComponentParameterConditions: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
25118
|
-
/** @description Defines a conditional value for a component parameter */
|
25119
|
-
ComponentParameterConditionalValue: {
|
25120
|
-
when: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
25121
|
-
/**
|
25122
|
-
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
25123
|
-
* A value of `null` will cause the parameter value to be removed, if it matches.
|
25124
|
-
*/
|
25125
|
-
value: unknown;
|
25126
|
-
/**
|
25127
|
-
* @description Unique sequence identifier of the conditional value within the component parameter.
|
25128
|
-
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
25129
|
-
*/
|
25130
|
-
id: number;
|
25131
|
-
};
|
25132
|
-
/**
|
25133
|
-
* @deprecated
|
25134
|
-
* @description beta functionality subject to change
|
25135
|
-
*/
|
25136
|
-
VisibilityCriteriaGroup: {
|
25137
|
-
/**
|
25138
|
-
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
25139
|
-
* @enum {string}
|
25140
|
-
*/
|
25141
|
-
op?: "&" | "|";
|
25142
|
-
clauses: (external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
25143
|
-
};
|
25144
|
-
/**
|
25145
|
-
* @deprecated
|
25146
|
-
* @description beta functionality subject to change
|
25147
|
-
*/
|
25148
|
-
VisibilityCriteria: {
|
25149
|
-
/** @description The rule type to execute */
|
25150
|
-
rule: string;
|
25151
|
-
/**
|
25152
|
-
* @description The source value of the rule.
|
25153
|
-
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
25154
|
-
*/
|
25155
|
-
source?: string;
|
25156
|
-
/** @description The rule-definition-specific operator to test against */
|
25157
|
-
op: string;
|
25158
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
25159
|
-
value: string | string[];
|
25160
24111
|
};
|
25161
24112
|
/** @description Defines a connection to a dynamic token on a data resource */
|
25162
24113
|
DataElementConnectionDefinition: {
|
@@ -25403,6 +24354,11 @@ interface external$1 {
|
|
25403
24354
|
localeMapping?: {
|
25404
24355
|
[key: string]: string;
|
25405
24356
|
};
|
24357
|
+
/**
|
24358
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
24359
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
24360
|
+
*/
|
24361
|
+
enableUnpublishedMode?: boolean;
|
25406
24362
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
25407
24363
|
customPublic?: {
|
25408
24364
|
[key: string]: unknown;
|
@@ -25509,6 +24465,8 @@ interface external$1 {
|
|
25509
24465
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
25510
24466
|
*/
|
25511
24467
|
optionalPatternParameter?: boolean;
|
24468
|
+
/** @description Resolve this data resource with draft mode content. TBD */
|
24469
|
+
isDraft?: boolean;
|
25512
24470
|
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
25513
24471
|
};
|
25514
24472
|
/** @description Variable values for a data resource */
|
@@ -26159,8 +25117,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
26159
25117
|
helpText?: string | undefined;
|
26160
25118
|
type: string;
|
26161
25119
|
localizable?: boolean | undefined;
|
26162
|
-
notLocalizedByDefault?: boolean | undefined;
|
26163
|
-
allowConditionalValues?: boolean | undefined;
|
26164
25120
|
typeConfig?: unknown;
|
26165
25121
|
}[] | undefined;
|
26166
25122
|
categoryId?: string | null | undefined;
|
@@ -26204,34 +25160,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
26204
25160
|
locales?: {
|
26205
25161
|
[key: string]: unknown;
|
26206
25162
|
} | undefined;
|
26207
|
-
conditions?: {
|
26208
|
-
when: {
|
26209
|
-
op?: "&" | "|" | undefined;
|
26210
|
-
clauses: (any | {
|
26211
|
-
rule: string;
|
26212
|
-
source?: string | undefined;
|
26213
|
-
op: string;
|
26214
|
-
value: string | string[];
|
26215
|
-
})[];
|
26216
|
-
};
|
26217
|
-
value: unknown;
|
26218
|
-
id: number;
|
26219
|
-
}[] | undefined;
|
26220
|
-
localesConditions?: {
|
26221
|
-
[key: string]: {
|
26222
|
-
when: {
|
26223
|
-
op?: "&" | "|" | undefined;
|
26224
|
-
clauses: (any | {
|
26225
|
-
rule: string;
|
26226
|
-
source?: string | undefined;
|
26227
|
-
op: string;
|
26228
|
-
value: string | string[];
|
26229
|
-
})[];
|
26230
|
-
};
|
26231
|
-
value: unknown;
|
26232
|
-
id: number;
|
26233
|
-
}[];
|
26234
|
-
} | undefined;
|
26235
25163
|
};
|
26236
25164
|
} | undefined;
|
26237
25165
|
variant?: string | undefined;
|
@@ -26246,6 +25174,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
26246
25174
|
isPatternParameter?: boolean | undefined;
|
26247
25175
|
ignorePatternParameterDefault?: boolean | undefined;
|
26248
25176
|
optionalPatternParameter?: boolean | undefined;
|
25177
|
+
isDraft?: boolean | undefined;
|
26249
25178
|
variables?: {
|
26250
25179
|
[key: string]: string;
|
26251
25180
|
} | undefined;
|
@@ -26257,6 +25186,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
26257
25186
|
isPatternParameter?: boolean | undefined;
|
26258
25187
|
ignorePatternParameterDefault?: boolean | undefined;
|
26259
25188
|
optionalPatternParameter?: boolean | undefined;
|
25189
|
+
isDraft?: boolean | undefined;
|
26260
25190
|
variables?: {
|
26261
25191
|
[key: string]: string;
|
26262
25192
|
} | undefined;
|
@@ -26279,34 +25209,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
26279
25209
|
locales?: {
|
26280
25210
|
[key: string]: unknown;
|
26281
25211
|
} | undefined;
|
26282
|
-
conditions?: {
|
26283
|
-
when: {
|
26284
|
-
op?: "&" | "|" | undefined;
|
26285
|
-
clauses: (any | {
|
26286
|
-
rule: string;
|
26287
|
-
source?: string | undefined;
|
26288
|
-
op: string;
|
26289
|
-
value: string | string[];
|
26290
|
-
})[];
|
26291
|
-
};
|
26292
|
-
value: unknown;
|
26293
|
-
id: number;
|
26294
|
-
}[] | undefined;
|
26295
|
-
localesConditions?: {
|
26296
|
-
[key: string]: {
|
26297
|
-
when: {
|
26298
|
-
op?: "&" | "|" | undefined;
|
26299
|
-
clauses: (any | {
|
26300
|
-
rule: string;
|
26301
|
-
source?: string | undefined;
|
26302
|
-
op: string;
|
26303
|
-
value: string | string[];
|
26304
|
-
})[];
|
26305
|
-
};
|
26306
|
-
value: unknown;
|
26307
|
-
id: number;
|
26308
|
-
}[];
|
26309
|
-
} | undefined;
|
26310
25212
|
};
|
26311
25213
|
} | undefined;
|
26312
25214
|
slots?: {
|
@@ -26428,6 +25330,7 @@ declare class DataSourceClient extends ApiClient {
|
|
26428
25330
|
localeMapping?: {
|
26429
25331
|
[key: string]: string;
|
26430
25332
|
} | undefined;
|
25333
|
+
enableUnpublishedMode?: boolean | undefined;
|
26431
25334
|
customPublic?: {
|
26432
25335
|
[key: string]: unknown;
|
26433
25336
|
} | undefined;
|
@@ -26464,6 +25367,7 @@ declare class DataSourceClient extends ApiClient {
|
|
26464
25367
|
localeMapping?: {
|
26465
25368
|
[key: string]: string;
|
26466
25369
|
} | undefined;
|
25370
|
+
enableUnpublishedMode?: boolean | undefined;
|
26467
25371
|
customPublic?: {
|
26468
25372
|
[key: string]: unknown;
|
26469
25373
|
} | undefined;
|
@@ -26806,7 +25710,6 @@ declare class UniqueBatchEntries<TArgs, TResult> {
|
|
26806
25710
|
}
|
26807
25711
|
|
26808
25712
|
declare const CANVAS_VIZ_CONTROL_PARAM = "$viz";
|
26809
|
-
|
26810
25713
|
/**
|
26811
25714
|
* @deprecated beta functionality subject to change
|
26812
25715
|
*/
|
@@ -26832,21 +25735,26 @@ type VisibilityParameterValue = {
|
|
26832
25735
|
/**
|
26833
25736
|
* @deprecated beta functionality subject to change
|
26834
25737
|
*/
|
26835
|
-
type VisibilityCriteriaGroup =
|
26836
|
-
/**
|
26837
|
-
|
26838
|
-
|
26839
|
-
|
25738
|
+
type VisibilityCriteriaGroup = {
|
25739
|
+
/** The boolean operator to join the clauses with. Defaults to & if not specified. */
|
25740
|
+
op?: '&' | '|';
|
25741
|
+
clauses: Array<VisibilityCriteria | VisibilityCriteriaGroup>;
|
25742
|
+
};
|
26840
25743
|
/**
|
26841
25744
|
* @deprecated beta functionality subject to change
|
26842
25745
|
*/
|
26843
|
-
type
|
25746
|
+
type VisibilityCriteria = {
|
25747
|
+
/** The rule type to execute */
|
25748
|
+
rule: string;
|
25749
|
+
/** The source value of the rule. For rules which have multiple classes of match, for example a dynamic input matches on a named DI. The rule is dynamic input. The DI name is the source. */
|
25750
|
+
source?: string;
|
25751
|
+
/** The rule-definition-specific operator to test against */
|
25752
|
+
op: string;
|
25753
|
+
/** The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
25754
|
+
value: string | string[];
|
25755
|
+
};
|
26844
25756
|
/**
|
26845
25757
|
* @deprecated beta functionality subject to change
|
26846
|
-
*
|
26847
|
-
* true: criteria group is true
|
26848
|
-
* false: criteria group is false
|
26849
|
-
* null: criteria group has clauses which are indeterminate with the current rule-set
|
26850
25758
|
*/
|
26851
25759
|
type VisibilityCriteriaEvaluationResult = boolean | null;
|
26852
25760
|
|
@@ -26868,44 +25776,15 @@ type EvaluateCriteriaGroupOptions = {
|
|
26868
25776
|
*/
|
26869
25777
|
declare function evaluateVisibilityCriteriaGroup(options: EvaluateCriteriaGroupOptions): VisibilityCriteriaEvaluationResult;
|
26870
25778
|
|
26871
|
-
interface
|
26872
|
-
/** The
|
26873
|
-
|
26874
|
-
/** Conditional values that are possible for the property. May be localized conditions. */
|
26875
|
-
conditionalValues: ComponentParameterConditionalValue[] | undefined;
|
26876
|
-
/**
|
26877
|
-
* Controls the overall result when indeterminate criteria are found
|
26878
|
-
* (unknown rule types, or rule evaluators that return null)
|
26879
|
-
* When true, indeterminate criteria will be kept for downstream evaluation when more rule types are available
|
26880
|
-
* When false, indeterminate criteria will be treated as non-matching and removed (appropriate for the final rules evaluation before rendering)
|
26881
|
-
*/
|
26882
|
-
keepIndeterminate?: boolean;
|
25779
|
+
interface EvaluateNodeVisibilityParameterOptions extends Omit<EvaluateCriteriaGroupOptions, 'criteriaGroup'> {
|
25780
|
+
/** The parameter to evaluate visibility rules on */
|
25781
|
+
parameter: VisibilityParameterValue | undefined;
|
26883
25782
|
}
|
26884
|
-
type PropertyCriteriaMatch = {
|
26885
|
-
/** The conditional value that matched. When undefined, the default value matched. */
|
26886
|
-
matched?: ComponentParameterConditionalValue;
|
26887
|
-
/** The current value of the property from the conditional or default value. */
|
26888
|
-
currentValue: unknown;
|
26889
|
-
/**
|
26890
|
-
* The index of the matched condition, or -1 if no condition matched
|
26891
|
-
* NOTE: if simplifyCriteria is true, this index reflects the original index
|
26892
|
-
* in the `conditionalValues` parameter before any criteria simplification occurred.
|
26893
|
-
*/
|
26894
|
-
currentConditionIndex: number;
|
26895
|
-
/**
|
26896
|
-
* Remaining criteria after simplifying the expressions using the rules.
|
26897
|
-
* If undefined, all criteria have been eliminated as candidates, and the `currentValue` is the final value.
|
26898
|
-
*/
|
26899
|
-
remainingConditionalValues: ComponentParameterConditionalValue[] | undefined;
|
26900
|
-
};
|
26901
25783
|
/**
|
26902
|
-
*
|
26903
|
-
* NOTE: function mutates the conditionalValues input parameter when `simplifyCriteria` is passed for max performance.
|
26904
|
-
* If you want immutability, wrap it in immer.
|
26905
25784
|
*
|
26906
25785
|
* @deprecated beta functionality subject to change
|
26907
25786
|
*/
|
26908
|
-
declare function
|
25787
|
+
declare function evaluateNodeVisibilityParameter({ parameter, ...evaluateGroupOptions }: EvaluateNodeVisibilityParameterOptions): VisibilityCriteriaEvaluationResult;
|
26909
25788
|
|
26910
25789
|
interface EvaluateNodeVisibilityOptions extends Omit<EvaluateCriteriaGroupOptions, 'criteriaGroup'> {
|
26911
25790
|
/** The node to evaluate visibility rules on */
|
@@ -26929,24 +25808,7 @@ interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityO
|
|
26929
25808
|
*
|
26930
25809
|
* @deprecated beta functionality subject to change
|
26931
25810
|
*/
|
26932
|
-
declare function
|
26933
|
-
|
26934
|
-
interface EvaluateWalkTreePropertyCriteriaOptions extends Pick<EvaluatePropertyCriteriaOptions, 'rules' | 'keepIndeterminate'> {
|
26935
|
-
node: ComponentInstance;
|
26936
|
-
}
|
26937
|
-
/**
|
26938
|
-
* Function to call to evaluate conditional properties rules when traversing the node tree with walkNodeTree or other traversal tool.
|
26939
|
-
* This function will perform a simplification of the conditional property values,
|
26940
|
-
* removing known-non-matching conditions, and for authoritative matches the match value
|
26941
|
-
* replaces the `value` property, clearing the conditionals.
|
26942
|
-
*
|
26943
|
-
* Automatically also evaluates localizable conditional values.
|
26944
|
-
*
|
26945
|
-
* NOTE: this function may mutate its input object for maximum performance.
|
26946
|
-
*
|
26947
|
-
* @deprecated beta functionality subject to change
|
26948
|
-
*/
|
26949
|
-
declare function evaluateWalkTreePropertyCriteria({ rules, node, keepIndeterminate, }: EvaluateWalkTreePropertyCriteriaOptions): void;
|
25811
|
+
declare function evaluateWalkTreeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
|
26950
25812
|
|
26951
25813
|
/**
|
26952
25814
|
* @deprecated beta functionality subject to change
|
@@ -27288,7 +26150,7 @@ interface paths {
|
|
27288
26150
|
parameters: {
|
27289
26151
|
query: {
|
27290
26152
|
projectId: string;
|
27291
|
-
type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern";
|
26153
|
+
type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern" | "compositionPattern" | "entry";
|
27292
26154
|
ids: string[];
|
27293
26155
|
withInstances?: boolean | null;
|
27294
26156
|
limit?: number;
|
@@ -27488,34 +26350,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27488
26350
|
locales?: {
|
27489
26351
|
[key: string]: unknown;
|
27490
26352
|
} | undefined;
|
27491
|
-
conditions?: {
|
27492
|
-
when: {
|
27493
|
-
op?: "&" | "|" | undefined;
|
27494
|
-
clauses: (any | {
|
27495
|
-
rule: string;
|
27496
|
-
source?: string | undefined;
|
27497
|
-
op: string;
|
27498
|
-
value: string | string[];
|
27499
|
-
})[];
|
27500
|
-
};
|
27501
|
-
value: unknown;
|
27502
|
-
id: number;
|
27503
|
-
}[] | undefined;
|
27504
|
-
localesConditions?: {
|
27505
|
-
[key: string]: {
|
27506
|
-
when: {
|
27507
|
-
op?: "&" | "|" | undefined;
|
27508
|
-
clauses: (any | {
|
27509
|
-
rule: string;
|
27510
|
-
source?: string | undefined;
|
27511
|
-
op: string;
|
27512
|
-
value: string | string[];
|
27513
|
-
})[];
|
27514
|
-
};
|
27515
|
-
value: unknown;
|
27516
|
-
id: number;
|
27517
|
-
}[];
|
27518
|
-
} | undefined;
|
27519
26353
|
};
|
27520
26354
|
} | undefined;
|
27521
26355
|
variant?: string | undefined;
|
@@ -27556,34 +26390,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27556
26390
|
locales?: {
|
27557
26391
|
[key: string]: unknown;
|
27558
26392
|
} | undefined;
|
27559
|
-
conditions?: {
|
27560
|
-
when: {
|
27561
|
-
op?: "&" | "|" | undefined;
|
27562
|
-
clauses: (any | {
|
27563
|
-
rule: string;
|
27564
|
-
source?: string | undefined;
|
27565
|
-
op: string;
|
27566
|
-
value: string | string[];
|
27567
|
-
})[];
|
27568
|
-
};
|
27569
|
-
value: unknown;
|
27570
|
-
id: number;
|
27571
|
-
}[] | undefined;
|
27572
|
-
localesConditions?: {
|
27573
|
-
[key: string]: {
|
27574
|
-
when: {
|
27575
|
-
op?: "&" | "|" | undefined;
|
27576
|
-
clauses: (any | {
|
27577
|
-
rule: string;
|
27578
|
-
source?: string | undefined;
|
27579
|
-
op: string;
|
27580
|
-
value: string | string[];
|
27581
|
-
})[];
|
27582
|
-
};
|
27583
|
-
value: unknown;
|
27584
|
-
id: number;
|
27585
|
-
}[];
|
27586
|
-
} | undefined;
|
27587
26393
|
};
|
27588
26394
|
} | undefined;
|
27589
26395
|
variant?: string | undefined;
|
@@ -27598,6 +26404,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27598
26404
|
isPatternParameter?: boolean | undefined;
|
27599
26405
|
ignorePatternParameterDefault?: boolean | undefined;
|
27600
26406
|
optionalPatternParameter?: boolean | undefined;
|
26407
|
+
isDraft?: boolean | undefined;
|
27601
26408
|
variables?: {
|
27602
26409
|
[key: string]: string;
|
27603
26410
|
} | undefined;
|
@@ -27609,6 +26416,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27609
26416
|
isPatternParameter?: boolean | undefined;
|
27610
26417
|
ignorePatternParameterDefault?: boolean | undefined;
|
27611
26418
|
optionalPatternParameter?: boolean | undefined;
|
26419
|
+
isDraft?: boolean | undefined;
|
27612
26420
|
variables?: {
|
27613
26421
|
[key: string]: string;
|
27614
26422
|
} | undefined;
|
@@ -27631,34 +26439,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27631
26439
|
locales?: {
|
27632
26440
|
[key: string]: unknown;
|
27633
26441
|
} | undefined;
|
27634
|
-
conditions?: {
|
27635
|
-
when: {
|
27636
|
-
op?: "&" | "|" | undefined;
|
27637
|
-
clauses: (any | {
|
27638
|
-
rule: string;
|
27639
|
-
source?: string | undefined;
|
27640
|
-
op: string;
|
27641
|
-
value: string | string[];
|
27642
|
-
})[];
|
27643
|
-
};
|
27644
|
-
value: unknown;
|
27645
|
-
id: number;
|
27646
|
-
}[] | undefined;
|
27647
|
-
localesConditions?: {
|
27648
|
-
[key: string]: {
|
27649
|
-
when: {
|
27650
|
-
op?: "&" | "|" | undefined;
|
27651
|
-
clauses: (any | {
|
27652
|
-
rule: string;
|
27653
|
-
source?: string | undefined;
|
27654
|
-
op: string;
|
27655
|
-
value: string | string[];
|
27656
|
-
})[];
|
27657
|
-
};
|
27658
|
-
value: unknown;
|
27659
|
-
id: number;
|
27660
|
-
}[];
|
27661
|
-
} | undefined;
|
27662
26442
|
};
|
27663
26443
|
} | undefined;
|
27664
26444
|
slots?: {
|
@@ -27691,6 +26471,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27691
26471
|
isPatternParameter?: boolean | undefined;
|
27692
26472
|
ignorePatternParameterDefault?: boolean | undefined;
|
27693
26473
|
optionalPatternParameter?: boolean | undefined;
|
26474
|
+
isDraft?: boolean | undefined;
|
27694
26475
|
variables?: {
|
27695
26476
|
[key: string]: string;
|
27696
26477
|
} | undefined;
|
@@ -27702,6 +26483,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27702
26483
|
isPatternParameter?: boolean | undefined;
|
27703
26484
|
ignorePatternParameterDefault?: boolean | undefined;
|
27704
26485
|
optionalPatternParameter?: boolean | undefined;
|
26486
|
+
isDraft?: boolean | undefined;
|
27705
26487
|
variables?: {
|
27706
26488
|
[key: string]: string;
|
27707
26489
|
} | undefined;
|
@@ -27724,34 +26506,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
27724
26506
|
locales?: {
|
27725
26507
|
[key: string]: unknown;
|
27726
26508
|
} | undefined;
|
27727
|
-
conditions?: {
|
27728
|
-
when: {
|
27729
|
-
op?: "&" | "|" | undefined;
|
27730
|
-
clauses: (any | {
|
27731
|
-
rule: string;
|
27732
|
-
source?: string | undefined;
|
27733
|
-
op: string;
|
27734
|
-
value: string | string[];
|
27735
|
-
})[];
|
27736
|
-
};
|
27737
|
-
value: unknown;
|
27738
|
-
id: number;
|
27739
|
-
}[] | undefined;
|
27740
|
-
localesConditions?: {
|
27741
|
-
[key: string]: {
|
27742
|
-
when: {
|
27743
|
-
op?: "&" | "|" | undefined;
|
27744
|
-
clauses: (any | {
|
27745
|
-
rule: string;
|
27746
|
-
source?: string | undefined;
|
27747
|
-
op: string;
|
27748
|
-
value: string | string[];
|
27749
|
-
})[];
|
27750
|
-
};
|
27751
|
-
value: unknown;
|
27752
|
-
id: number;
|
27753
|
-
}[];
|
27754
|
-
} | undefined;
|
27755
26509
|
};
|
27756
26510
|
} | undefined;
|
27757
26511
|
slots?: {
|
@@ -27862,15 +26616,9 @@ declare const parseComponentPlaceholderId: (id: string) => {
|
|
27862
26616
|
parent?: PlaceholderParent | undefined;
|
27863
26617
|
} | undefined;
|
27864
26618
|
|
27865
|
-
/**
|
27866
|
-
* @deprecated do not use, will be removed in a future version
|
27867
|
-
*/
|
27868
26619
|
type FlattenProperty<P> = P extends {
|
27869
26620
|
value: unknown;
|
27870
26621
|
} ? P['value'] : P;
|
27871
|
-
/**
|
27872
|
-
* @deprecated do not use, will be removed in a future version
|
27873
|
-
*/
|
27874
26622
|
type FlattenValues<T extends DataWithProperties> = T extends Pick<ComponentInstance, 'parameters'> ? Record<string, unknown> & {
|
27875
26623
|
[Property in keyof T['parameters']]: FlattenProperty<T['parameters'][Property]>;
|
27876
26624
|
} : T extends Pick<EntryData, 'fields'> ? Record<string, unknown> & {
|
@@ -27881,9 +26629,6 @@ type FlattenValues<T extends DataWithProperties> = T extends Pick<ComponentInsta
|
|
27881
26629
|
* If no properties are defined, returns undefined.
|
27882
26630
|
*/
|
27883
26631
|
declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
|
27884
|
-
/**
|
27885
|
-
* @deprecated do not use, will be removed in a future version
|
27886
|
-
*/
|
27887
26632
|
interface FlattenValuesOptions {
|
27888
26633
|
/**
|
27889
26634
|
* Take only the first item from an array
|
@@ -27907,16 +26652,11 @@ interface FlattenValuesOptions {
|
|
27907
26652
|
levels?: number;
|
27908
26653
|
}
|
27909
26654
|
/**
|
27910
|
-
*
|
26655
|
+
* Get the data stored in the value of a component parameter
|
26656
|
+
* or a field attached to an Entry, Block or Asset
|
27911
26657
|
*/
|
27912
26658
|
declare function getPropertyValue<TValue, T extends ComponentParameter<TValue>>(parameter: T): TValue;
|
27913
|
-
/**
|
27914
|
-
* @deprecated do not use, will be removed in a future version
|
27915
|
-
*/
|
27916
26659
|
declare function getPropertyValue(parameter: null): null;
|
27917
|
-
/**
|
27918
|
-
* @deprecated do not use, will be removed in a future version
|
27919
|
-
*/
|
27920
26660
|
declare function getPropertyValue(parameter: undefined): undefined;
|
27921
26661
|
/**
|
27922
26662
|
* Get the localized values of a component parameter
|
@@ -27929,27 +26669,12 @@ declare function getLocalizedPropertyValues<TValue, T extends ComponentParameter
|
|
27929
26669
|
declare function getLocalizedPropertyValues(parameter: null): null;
|
27930
26670
|
declare function getLocalizedPropertyValues(parameter: undefined): undefined;
|
27931
26671
|
type DataWithProperties = Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>;
|
27932
|
-
/**
|
27933
|
-
* @deprecated do not use, will be removed in a future version
|
27934
|
-
*/
|
27935
26672
|
declare function flattenValues(data: null, options?: FlattenValuesOptions): null;
|
27936
|
-
/**
|
27937
|
-
* @deprecated do not use, will be removed in a future version
|
27938
|
-
*/
|
27939
26673
|
declare function flattenValues(data: undefined, options?: FlattenValuesOptions): undefined;
|
27940
|
-
/**
|
27941
|
-
* @deprecated do not use, will be removed in a future version
|
27942
|
-
*/
|
27943
26674
|
declare function flattenValues<Data extends DataWithProperties>(data: Data | null | undefined, options?: FlattenValuesOptions): FlattenValues<Data> | null | undefined;
|
27944
|
-
/**
|
27945
|
-
* @deprecated do not use, will be removed in a future version
|
27946
|
-
*/
|
27947
26675
|
declare function flattenValues<Data extends DataWithProperties>(data: Array<Data> | null | undefined, options: {
|
27948
26676
|
toSingle: true;
|
27949
26677
|
} & Omit<FlattenValuesOptions, 'toSingle'>): FlattenValues<Data> | null | undefined;
|
27950
|
-
/**
|
27951
|
-
* @deprecated do not use, will be removed in a future version
|
27952
|
-
*/
|
27953
26678
|
declare function flattenValues<Data extends DataWithProperties>(data: Array<Data> | null | undefined, options?: FlattenValuesOptions): Array<FlattenValues<Data>> | null | undefined;
|
27954
26679
|
|
27955
26680
|
type BindVariablesResult<TValue> = {
|
@@ -28056,4 +26781,4 @@ declare class WorkflowClient extends ApiClient {
|
|
28056
26781
|
|
28057
26782
|
declare const CanvasClientError: typeof ApiClientError;
|
28058
26783
|
|
28059
|
-
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_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, 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 ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, 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 CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, 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 EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type EventNames, type Filters, 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_FORCED_SETTINGS_QUERY_STRING_PARAM, 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 PropertyCriteriaMatch, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, 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 RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type StringOperators, type SubscribeToCompositionOptions, type SuggestComponentMessage, 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 VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createEventBus, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
|
26784
|
+
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_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, 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 CompositionFilters, 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 CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, 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 EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EventNames, type Filters, 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_FORCED_SETTINGS_QUERY_STRING_PARAM, 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 MaxDepthExceededIssue, 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, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, 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 RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type StringOperators, type SubscribeToCompositionOptions, type SuggestComponentMessage, 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 VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createEventBus, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, evaluateNodeVisibilityParameter, evaluateVisibilityCriteriaGroup, evaluateWalkTreeVisibility, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
|