@uniformdev/canvas 18.21.1-alpha.4 → 18.23.1-alpha.34
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.ts +181 -7
- package/package.json +11 -13
package/dist/index.d.ts
CHANGED
@@ -30,9 +30,21 @@ interface components$2 {
|
|
30
30
|
allowedComponents: string[];
|
31
31
|
/**
|
32
32
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
33
|
+
* If allowAllComponents is true, this value is ignored.
|
34
|
+
*
|
33
35
|
* @default false
|
34
36
|
*/
|
35
37
|
inheritAllowedComponents: boolean;
|
38
|
+
/**
|
39
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
40
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
41
|
+
*/
|
42
|
+
allowAllComponents?: boolean;
|
43
|
+
/**
|
44
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
45
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
46
|
+
*/
|
47
|
+
patternsInAllowedComponents?: boolean;
|
36
48
|
/** @description Minimum valid number of components in this slot */
|
37
49
|
minComponents?: number;
|
38
50
|
/** @description Maximum valid number of components in this slot */
|
@@ -268,6 +280,7 @@ interface components$2 {
|
|
268
280
|
parameters?: {
|
269
281
|
[key: string]: components$2["schemas"]["ComponentParameter"];
|
270
282
|
};
|
283
|
+
variant?: string;
|
271
284
|
};
|
272
285
|
/**
|
273
286
|
* @deprecated
|
@@ -276,9 +289,12 @@ interface components$2 {
|
|
276
289
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
277
290
|
*/
|
278
291
|
ComponentOverridability: {
|
292
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
279
293
|
parameters?: {
|
280
294
|
[key: string]: components$2["schemas"]["OverrideOptions"];
|
281
295
|
};
|
296
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
297
|
+
variants?: boolean;
|
282
298
|
};
|
283
299
|
/**
|
284
300
|
* @deprecated
|
@@ -415,8 +431,14 @@ interface components$2 {
|
|
415
431
|
DataResourceDefinition: {
|
416
432
|
/** @description Public ID of the data type that provides this data */
|
417
433
|
type: string;
|
418
|
-
/** @description Whether this data is a pattern
|
434
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
419
435
|
isPatternParameter?: boolean;
|
436
|
+
/**
|
437
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
438
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
439
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
440
|
+
*/
|
441
|
+
ignorePatternParameterDefault?: boolean;
|
420
442
|
variables?: components$2["schemas"]["DataResourceVariables"];
|
421
443
|
};
|
422
444
|
/**
|
@@ -610,9 +632,21 @@ interface external$5 {
|
|
610
632
|
allowedComponents: string[];
|
611
633
|
/**
|
612
634
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
635
|
+
* If allowAllComponents is true, this value is ignored.
|
636
|
+
*
|
613
637
|
* @default false
|
614
638
|
*/
|
615
639
|
inheritAllowedComponents: boolean;
|
640
|
+
/**
|
641
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
642
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
643
|
+
*/
|
644
|
+
allowAllComponents?: boolean;
|
645
|
+
/**
|
646
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
647
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
648
|
+
*/
|
649
|
+
patternsInAllowedComponents?: boolean;
|
616
650
|
/** @description Minimum valid number of components in this slot */
|
617
651
|
minComponents?: number;
|
618
652
|
/** @description Maximum valid number of components in this slot */
|
@@ -848,6 +882,7 @@ interface external$5 {
|
|
848
882
|
parameters?: {
|
849
883
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
850
884
|
};
|
885
|
+
variant?: string;
|
851
886
|
};
|
852
887
|
/**
|
853
888
|
* @deprecated
|
@@ -856,9 +891,12 @@ interface external$5 {
|
|
856
891
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
857
892
|
*/
|
858
893
|
ComponentOverridability: {
|
894
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
859
895
|
parameters?: {
|
860
896
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
861
897
|
};
|
898
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
899
|
+
variants?: boolean;
|
862
900
|
};
|
863
901
|
/**
|
864
902
|
* @deprecated
|
@@ -995,8 +1033,14 @@ interface external$5 {
|
|
995
1033
|
DataResourceDefinition: {
|
996
1034
|
/** @description Public ID of the data type that provides this data */
|
997
1035
|
type: string;
|
998
|
-
/** @description Whether this data is a pattern
|
1036
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
999
1037
|
isPatternParameter?: boolean;
|
1038
|
+
/**
|
1039
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
1040
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
1041
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
1042
|
+
*/
|
1043
|
+
ignorePatternParameterDefault?: boolean;
|
1000
1044
|
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1001
1045
|
};
|
1002
1046
|
/**
|
@@ -1444,9 +1488,21 @@ interface external$4 {
|
|
1444
1488
|
allowedComponents: string[];
|
1445
1489
|
/**
|
1446
1490
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
1491
|
+
* If allowAllComponents is true, this value is ignored.
|
1492
|
+
*
|
1447
1493
|
* @default false
|
1448
1494
|
*/
|
1449
1495
|
inheritAllowedComponents: boolean;
|
1496
|
+
/**
|
1497
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
1498
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
1499
|
+
*/
|
1500
|
+
allowAllComponents?: boolean;
|
1501
|
+
/**
|
1502
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
1503
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
1504
|
+
*/
|
1505
|
+
patternsInAllowedComponents?: boolean;
|
1450
1506
|
/** @description Minimum valid number of components in this slot */
|
1451
1507
|
minComponents?: number;
|
1452
1508
|
/** @description Maximum valid number of components in this slot */
|
@@ -1682,6 +1738,7 @@ interface external$4 {
|
|
1682
1738
|
parameters?: {
|
1683
1739
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1684
1740
|
};
|
1741
|
+
variant?: string;
|
1685
1742
|
};
|
1686
1743
|
/**
|
1687
1744
|
* @deprecated
|
@@ -1690,9 +1747,12 @@ interface external$4 {
|
|
1690
1747
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
1691
1748
|
*/
|
1692
1749
|
ComponentOverridability: {
|
1750
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1693
1751
|
parameters?: {
|
1694
1752
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1695
1753
|
};
|
1754
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1755
|
+
variants?: boolean;
|
1696
1756
|
};
|
1697
1757
|
/**
|
1698
1758
|
* @deprecated
|
@@ -1829,8 +1889,14 @@ interface external$4 {
|
|
1829
1889
|
DataResourceDefinition: {
|
1830
1890
|
/** @description Public ID of the data type that provides this data */
|
1831
1891
|
type: string;
|
1832
|
-
/** @description Whether this data is a pattern
|
1892
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
1833
1893
|
isPatternParameter?: boolean;
|
1894
|
+
/**
|
1895
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
1896
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
1897
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
1898
|
+
*/
|
1899
|
+
ignorePatternParameterDefault?: boolean;
|
1834
1900
|
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1835
1901
|
};
|
1836
1902
|
/**
|
@@ -2050,9 +2116,21 @@ interface external$3 {
|
|
2050
2116
|
allowedComponents: string[];
|
2051
2117
|
/**
|
2052
2118
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
2119
|
+
* If allowAllComponents is true, this value is ignored.
|
2120
|
+
*
|
2053
2121
|
* @default false
|
2054
2122
|
*/
|
2055
2123
|
inheritAllowedComponents: boolean;
|
2124
|
+
/**
|
2125
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
2126
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
2127
|
+
*/
|
2128
|
+
allowAllComponents?: boolean;
|
2129
|
+
/**
|
2130
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
2131
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
2132
|
+
*/
|
2133
|
+
patternsInAllowedComponents?: boolean;
|
2056
2134
|
/** @description Minimum valid number of components in this slot */
|
2057
2135
|
minComponents?: number;
|
2058
2136
|
/** @description Maximum valid number of components in this slot */
|
@@ -2288,6 +2366,7 @@ interface external$3 {
|
|
2288
2366
|
parameters?: {
|
2289
2367
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2290
2368
|
};
|
2369
|
+
variant?: string;
|
2291
2370
|
};
|
2292
2371
|
/**
|
2293
2372
|
* @deprecated
|
@@ -2296,9 +2375,12 @@ interface external$3 {
|
|
2296
2375
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
2297
2376
|
*/
|
2298
2377
|
ComponentOverridability: {
|
2378
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2299
2379
|
parameters?: {
|
2300
2380
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2301
2381
|
};
|
2382
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2383
|
+
variants?: boolean;
|
2302
2384
|
};
|
2303
2385
|
/**
|
2304
2386
|
* @deprecated
|
@@ -2435,8 +2517,14 @@ interface external$3 {
|
|
2435
2517
|
DataResourceDefinition: {
|
2436
2518
|
/** @description Public ID of the data type that provides this data */
|
2437
2519
|
type: string;
|
2438
|
-
/** @description Whether this data is a pattern
|
2520
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
2439
2521
|
isPatternParameter?: boolean;
|
2522
|
+
/**
|
2523
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
2524
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
2525
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
2526
|
+
*/
|
2527
|
+
ignorePatternParameterDefault?: boolean;
|
2440
2528
|
variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2441
2529
|
};
|
2442
2530
|
/**
|
@@ -3002,6 +3090,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3002
3090
|
[key: string]: {
|
3003
3091
|
type: string;
|
3004
3092
|
isPatternParameter?: boolean | undefined;
|
3093
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
3005
3094
|
variables?: {
|
3006
3095
|
[key: string]: string;
|
3007
3096
|
} | undefined;
|
@@ -3011,6 +3100,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3011
3100
|
[key: string]: {
|
3012
3101
|
type: string;
|
3013
3102
|
isPatternParameter?: boolean | undefined;
|
3103
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
3014
3104
|
variables?: {
|
3015
3105
|
[key: string]: string;
|
3016
3106
|
} | undefined;
|
@@ -3030,12 +3120,14 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3030
3120
|
} | undefined;
|
3031
3121
|
};
|
3032
3122
|
} | undefined;
|
3123
|
+
variant?: string | undefined;
|
3033
3124
|
};
|
3034
3125
|
} | undefined;
|
3035
3126
|
_overridability?: {
|
3036
3127
|
parameters?: {
|
3037
3128
|
[key: string]: "no" | "yes";
|
3038
3129
|
} | undefined;
|
3130
|
+
variants?: boolean | undefined;
|
3039
3131
|
} | undefined;
|
3040
3132
|
}[];
|
3041
3133
|
} | undefined;
|
@@ -3046,6 +3138,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3046
3138
|
[key: string]: {
|
3047
3139
|
type: string;
|
3048
3140
|
isPatternParameter?: boolean | undefined;
|
3141
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
3049
3142
|
variables?: {
|
3050
3143
|
[key: string]: string;
|
3051
3144
|
} | undefined;
|
@@ -3064,12 +3157,14 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3064
3157
|
} | undefined;
|
3065
3158
|
};
|
3066
3159
|
} | undefined;
|
3160
|
+
variant?: string | undefined;
|
3067
3161
|
};
|
3068
3162
|
} | undefined;
|
3069
3163
|
_overridability?: {
|
3070
3164
|
parameters?: {
|
3071
3165
|
[key: string]: "no" | "yes";
|
3072
3166
|
} | undefined;
|
3167
|
+
variants?: boolean | undefined;
|
3073
3168
|
} | undefined;
|
3074
3169
|
};
|
3075
3170
|
}[];
|
@@ -3126,6 +3221,8 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3126
3221
|
name: string;
|
3127
3222
|
allowedComponents: string[]; /** Deletes a Canvas component definition */
|
3128
3223
|
inheritAllowedComponents: boolean;
|
3224
|
+
allowAllComponents?: boolean | undefined;
|
3225
|
+
patternsInAllowedComponents?: boolean | undefined; /** Deletes a Canvas component definition */
|
3129
3226
|
minComponents?: number | undefined;
|
3130
3227
|
maxComponents?: number | undefined;
|
3131
3228
|
}[] | undefined;
|
@@ -3158,6 +3255,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3158
3255
|
[key: string]: {
|
3159
3256
|
type: string;
|
3160
3257
|
isPatternParameter?: boolean | undefined;
|
3258
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
3161
3259
|
variables?: {
|
3162
3260
|
[key: string]: string;
|
3163
3261
|
} | undefined;
|
@@ -3167,6 +3265,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3167
3265
|
[key: string]: {
|
3168
3266
|
type: string;
|
3169
3267
|
isPatternParameter?: boolean | undefined;
|
3268
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
3170
3269
|
variables?: {
|
3171
3270
|
[key: string]: string;
|
3172
3271
|
} | undefined;
|
@@ -3186,12 +3285,14 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3186
3285
|
} | undefined;
|
3187
3286
|
};
|
3188
3287
|
} | undefined;
|
3288
|
+
variant?: string | undefined;
|
3189
3289
|
};
|
3190
3290
|
} | undefined;
|
3191
3291
|
_overridability?: {
|
3192
3292
|
parameters?: {
|
3193
3293
|
[key: string]: "no" | "yes";
|
3194
3294
|
} | undefined;
|
3295
|
+
variants?: boolean | undefined;
|
3195
3296
|
} | undefined;
|
3196
3297
|
} | null | undefined;
|
3197
3298
|
variants?: {
|
@@ -3360,9 +3461,21 @@ interface external$2 {
|
|
3360
3461
|
allowedComponents: string[];
|
3361
3462
|
/**
|
3362
3463
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
3464
|
+
* If allowAllComponents is true, this value is ignored.
|
3465
|
+
*
|
3363
3466
|
* @default false
|
3364
3467
|
*/
|
3365
3468
|
inheritAllowedComponents: boolean;
|
3469
|
+
/**
|
3470
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
3471
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
3472
|
+
*/
|
3473
|
+
allowAllComponents?: boolean;
|
3474
|
+
/**
|
3475
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
3476
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
3477
|
+
*/
|
3478
|
+
patternsInAllowedComponents?: boolean;
|
3366
3479
|
/** @description Minimum valid number of components in this slot */
|
3367
3480
|
minComponents?: number;
|
3368
3481
|
/** @description Maximum valid number of components in this slot */
|
@@ -3598,6 +3711,7 @@ interface external$2 {
|
|
3598
3711
|
parameters?: {
|
3599
3712
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3600
3713
|
};
|
3714
|
+
variant?: string;
|
3601
3715
|
};
|
3602
3716
|
/**
|
3603
3717
|
* @deprecated
|
@@ -3606,9 +3720,12 @@ interface external$2 {
|
|
3606
3720
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
3607
3721
|
*/
|
3608
3722
|
ComponentOverridability: {
|
3723
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
3609
3724
|
parameters?: {
|
3610
3725
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
3611
3726
|
};
|
3727
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
3728
|
+
variants?: boolean;
|
3612
3729
|
};
|
3613
3730
|
/**
|
3614
3731
|
* @deprecated
|
@@ -3745,8 +3862,14 @@ interface external$2 {
|
|
3745
3862
|
DataResourceDefinition: {
|
3746
3863
|
/** @description Public ID of the data type that provides this data */
|
3747
3864
|
type: string;
|
3748
|
-
/** @description Whether this data is a pattern
|
3865
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
3749
3866
|
isPatternParameter?: boolean;
|
3867
|
+
/**
|
3868
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
3869
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
3870
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
3871
|
+
*/
|
3872
|
+
ignorePatternParameterDefault?: boolean;
|
3750
3873
|
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3751
3874
|
};
|
3752
3875
|
/**
|
@@ -3882,9 +4005,21 @@ interface external$1 {
|
|
3882
4005
|
allowedComponents: string[];
|
3883
4006
|
/**
|
3884
4007
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
4008
|
+
* If allowAllComponents is true, this value is ignored.
|
4009
|
+
*
|
3885
4010
|
* @default false
|
3886
4011
|
*/
|
3887
4012
|
inheritAllowedComponents: boolean;
|
4013
|
+
/**
|
4014
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
4015
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
4016
|
+
*/
|
4017
|
+
allowAllComponents?: boolean;
|
4018
|
+
/**
|
4019
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
4020
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
4021
|
+
*/
|
4022
|
+
patternsInAllowedComponents?: boolean;
|
3888
4023
|
/** @description Minimum valid number of components in this slot */
|
3889
4024
|
minComponents?: number;
|
3890
4025
|
/** @description Maximum valid number of components in this slot */
|
@@ -4120,6 +4255,7 @@ interface external$1 {
|
|
4120
4255
|
parameters?: {
|
4121
4256
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
4122
4257
|
};
|
4258
|
+
variant?: string;
|
4123
4259
|
};
|
4124
4260
|
/**
|
4125
4261
|
* @deprecated
|
@@ -4128,9 +4264,12 @@ interface external$1 {
|
|
4128
4264
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
4129
4265
|
*/
|
4130
4266
|
ComponentOverridability: {
|
4267
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
4131
4268
|
parameters?: {
|
4132
4269
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
4133
4270
|
};
|
4271
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
4272
|
+
variants?: boolean;
|
4134
4273
|
};
|
4135
4274
|
/**
|
4136
4275
|
* @deprecated
|
@@ -4267,8 +4406,14 @@ interface external$1 {
|
|
4267
4406
|
DataResourceDefinition: {
|
4268
4407
|
/** @description Public ID of the data type that provides this data */
|
4269
4408
|
type: string;
|
4270
|
-
/** @description Whether this data is a pattern
|
4409
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
4271
4410
|
isPatternParameter?: boolean;
|
4411
|
+
/**
|
4412
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
4413
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
4414
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
4415
|
+
*/
|
4416
|
+
ignorePatternParameterDefault?: boolean;
|
4272
4417
|
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4273
4418
|
};
|
4274
4419
|
/**
|
@@ -4439,9 +4584,21 @@ interface external {
|
|
4439
4584
|
allowedComponents: string[];
|
4440
4585
|
/**
|
4441
4586
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
4587
|
+
* If allowAllComponents is true, this value is ignored.
|
4588
|
+
*
|
4442
4589
|
* @default false
|
4443
4590
|
*/
|
4444
4591
|
inheritAllowedComponents: boolean;
|
4592
|
+
/**
|
4593
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
4594
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
4595
|
+
*/
|
4596
|
+
allowAllComponents?: boolean;
|
4597
|
+
/**
|
4598
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
4599
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
4600
|
+
*/
|
4601
|
+
patternsInAllowedComponents?: boolean;
|
4445
4602
|
/** @description Minimum valid number of components in this slot */
|
4446
4603
|
minComponents?: number;
|
4447
4604
|
/** @description Maximum valid number of components in this slot */
|
@@ -4677,6 +4834,7 @@ interface external {
|
|
4677
4834
|
parameters?: {
|
4678
4835
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
4679
4836
|
};
|
4837
|
+
variant?: string;
|
4680
4838
|
};
|
4681
4839
|
/**
|
4682
4840
|
* @deprecated
|
@@ -4685,9 +4843,12 @@ interface external {
|
|
4685
4843
|
* NOTE: Data resources' overridability is defined in the data resource definition.
|
4686
4844
|
*/
|
4687
4845
|
ComponentOverridability: {
|
4846
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
4688
4847
|
parameters?: {
|
4689
4848
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
4690
4849
|
};
|
4850
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
4851
|
+
variants?: boolean;
|
4691
4852
|
};
|
4692
4853
|
/**
|
4693
4854
|
* @deprecated
|
@@ -4824,8 +4985,14 @@ interface external {
|
|
4824
4985
|
DataResourceDefinition: {
|
4825
4986
|
/** @description Public ID of the data type that provides this data */
|
4826
4987
|
type: string;
|
4827
|
-
/** @description Whether this data is a pattern
|
4988
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
4828
4989
|
isPatternParameter?: boolean;
|
4990
|
+
/**
|
4991
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
4992
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
4993
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
4994
|
+
*/
|
4995
|
+
ignorePatternParameterDefault?: boolean;
|
4829
4996
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4830
4997
|
};
|
4831
4998
|
/**
|
@@ -5449,6 +5616,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
5449
5616
|
[key: string]: {
|
5450
5617
|
type: string;
|
5451
5618
|
isPatternParameter?: boolean | undefined;
|
5619
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
5452
5620
|
variables?: {
|
5453
5621
|
[key: string]: string;
|
5454
5622
|
} | undefined;
|
@@ -5458,6 +5626,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
5458
5626
|
[key: string]: {
|
5459
5627
|
type: string;
|
5460
5628
|
isPatternParameter?: boolean | undefined;
|
5629
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
5461
5630
|
variables?: {
|
5462
5631
|
[key: string]: string;
|
5463
5632
|
} | undefined;
|
@@ -5477,12 +5646,14 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
5477
5646
|
} | undefined;
|
5478
5647
|
};
|
5479
5648
|
} | undefined;
|
5649
|
+
variant?: string | undefined;
|
5480
5650
|
};
|
5481
5651
|
} | undefined;
|
5482
5652
|
_overridability?: {
|
5483
5653
|
parameters?: {
|
5484
5654
|
[key: string]: "no" | "yes";
|
5485
5655
|
} | undefined;
|
5656
|
+
variants?: boolean | undefined;
|
5486
5657
|
} | undefined;
|
5487
5658
|
}[];
|
5488
5659
|
} | undefined;
|
@@ -5493,6 +5664,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
5493
5664
|
[key: string]: {
|
5494
5665
|
type: string;
|
5495
5666
|
isPatternParameter?: boolean | undefined;
|
5667
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
5496
5668
|
variables?: {
|
5497
5669
|
[key: string]: string;
|
5498
5670
|
} | undefined;
|
@@ -5511,12 +5683,14 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
5511
5683
|
} | undefined;
|
5512
5684
|
};
|
5513
5685
|
} | undefined;
|
5686
|
+
variant?: string | undefined;
|
5514
5687
|
};
|
5515
5688
|
} | undefined;
|
5516
5689
|
_overridability?: {
|
5517
5690
|
parameters?: {
|
5518
5691
|
[key: string]: "no" | "yes";
|
5519
5692
|
} | undefined;
|
5693
|
+
variants?: boolean | undefined;
|
5520
5694
|
} | undefined;
|
5521
5695
|
}>;
|
5522
5696
|
|
package/package.json
CHANGED
@@ -1,21 +1,19 @@
|
|
1
1
|
{
|
2
2
|
"name": "@uniformdev/canvas",
|
3
|
-
"version": "18.
|
3
|
+
"version": "18.23.1-alpha.34+8eddcae60",
|
4
4
|
"description": "Common functionality and types for Uniform Canvas",
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
6
6
|
"main": "./dist/index.js",
|
7
7
|
"module": "./dist/index.esm.js",
|
8
8
|
"exports": {
|
9
|
-
"
|
10
|
-
"
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
"
|
16
|
-
|
17
|
-
"default": "./dist/index.js"
|
18
|
-
}
|
9
|
+
"import": {
|
10
|
+
"types": "./dist/index.d.ts",
|
11
|
+
"node": "./dist/index.mjs",
|
12
|
+
"default": "./dist/index.esm.js"
|
13
|
+
},
|
14
|
+
"require": {
|
15
|
+
"types": "./dist/index.d.ts",
|
16
|
+
"default": "./dist/index.js"
|
19
17
|
}
|
20
18
|
},
|
21
19
|
"types": "./dist/index.d.ts",
|
@@ -49,7 +47,7 @@
|
|
49
47
|
"pusher-js": "8.0.1"
|
50
48
|
},
|
51
49
|
"dependencies": {
|
52
|
-
"@uniformdev/context": "18.
|
50
|
+
"@uniformdev/context": "18.23.1-alpha.34+8eddcae60"
|
53
51
|
},
|
54
52
|
"files": [
|
55
53
|
"/dist"
|
@@ -57,5 +55,5 @@
|
|
57
55
|
"publishConfig": {
|
58
56
|
"access": "public"
|
59
57
|
},
|
60
|
-
"gitHead": "
|
58
|
+
"gitHead": "8eddcae607f5c8b7ef9f7752bc11e186eee4305b"
|
61
59
|
}
|