@uniformdev/canvas 19.88.1-alpha.7 → 19.90.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +381 -0
- package/dist/index.d.ts +381 -0
- package/dist/index.esm.js +27 -3
- package/dist/index.js +27 -3
- package/dist/index.mjs +27 -3
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
@@ -310,6 +310,15 @@ interface components$5 {
|
|
310
310
|
_slug?: string | null;
|
311
311
|
/** @description Friendly name of this component. */
|
312
312
|
_name: string;
|
313
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
314
|
+
_pattern?: string;
|
315
|
+
/**
|
316
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
317
|
+
* Means nothing for PUTs; it will be ignored.
|
318
|
+
*/
|
319
|
+
_patternDataResources?: {
|
320
|
+
[key: string]: components$5["schemas"]["DataResourceDefinition"];
|
321
|
+
};
|
313
322
|
_dataResources?: components$5["schemas"]["DataResourceDefinitions"];
|
314
323
|
/**
|
315
324
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -1037,6 +1046,15 @@ interface external$f {
|
|
1037
1046
|
_slug?: string | null;
|
1038
1047
|
/** @description Friendly name of this component. */
|
1039
1048
|
_name: string;
|
1049
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1050
|
+
_pattern?: string;
|
1051
|
+
/**
|
1052
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1053
|
+
* Means nothing for PUTs; it will be ignored.
|
1054
|
+
*/
|
1055
|
+
_patternDataResources?: {
|
1056
|
+
[key: string]: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1057
|
+
};
|
1040
1058
|
_dataResources?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1041
1059
|
/**
|
1042
1060
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -1840,6 +1858,15 @@ interface external$e {
|
|
1840
1858
|
_slug?: string | null;
|
1841
1859
|
/** @description Friendly name of this component. */
|
1842
1860
|
_name: string;
|
1861
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1862
|
+
_pattern?: string;
|
1863
|
+
/**
|
1864
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1865
|
+
* Means nothing for PUTs; it will be ignored.
|
1866
|
+
*/
|
1867
|
+
_patternDataResources?: {
|
1868
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1869
|
+
};
|
1843
1870
|
_dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1844
1871
|
/**
|
1845
1872
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -2579,6 +2606,15 @@ interface external$d {
|
|
2579
2606
|
_slug?: string | null;
|
2580
2607
|
/** @description Friendly name of this component. */
|
2581
2608
|
_name: string;
|
2609
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2610
|
+
_pattern?: string;
|
2611
|
+
/**
|
2612
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2613
|
+
* Means nothing for PUTs; it will be ignored.
|
2614
|
+
*/
|
2615
|
+
_patternDataResources?: {
|
2616
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2617
|
+
};
|
2582
2618
|
_dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2583
2619
|
/**
|
2584
2620
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -2889,6 +2925,14 @@ interface paths$b {
|
|
2889
2925
|
offset?: components$4["parameters"]["offset"];
|
2890
2926
|
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2891
2927
|
orderBy?: components$4["parameters"]["orderBy"];
|
2928
|
+
/**
|
2929
|
+
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2930
|
+
* If true, only pattern compositions will be returned.
|
2931
|
+
* If false, only regular compositions will be returned.
|
2932
|
+
* If omitted, both pattern and regular compositions will be returned.
|
2933
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2934
|
+
*/
|
2935
|
+
pattern?: components$4["parameters"]["pattern"];
|
2892
2936
|
/** The project the entry/entries are on. */
|
2893
2937
|
projectId: components$4["parameters"]["projectId"];
|
2894
2938
|
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -2919,6 +2963,14 @@ interface paths$b {
|
|
2919
2963
|
withComponentIDs?: components$4["parameters"]["withComponentIDs"];
|
2920
2964
|
/** Performs keyword search on the entries. */
|
2921
2965
|
keyword?: components$4["parameters"]["keyword"];
|
2966
|
+
/**
|
2967
|
+
* If true, any pattern references in the composition will be left unresolved.
|
2968
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
2969
|
+
* embedded into it, and serialize the pattern data separately.
|
2970
|
+
*/
|
2971
|
+
skipPatternResolution?: components$4["parameters"]["skipPatternResolution"];
|
2972
|
+
/** @deprecated This parameter is unused and has no effect. Passing this parameter will become an error in the future. */
|
2973
|
+
skipParameterResolution?: components$4["parameters"]["skipParameterResolution"];
|
2922
2974
|
/**
|
2923
2975
|
* If true, any pattern override data is not resolved by the API.
|
2924
2976
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
@@ -2986,6 +3038,11 @@ interface paths$b {
|
|
2986
3038
|
created?: string;
|
2987
3039
|
/** @description Ignored if present */
|
2988
3040
|
modified?: string;
|
3041
|
+
/**
|
3042
|
+
* @description True if the entry is a pattern (which can be referenced on other entries)
|
3043
|
+
* @default false
|
3044
|
+
*/
|
3045
|
+
pattern?: boolean;
|
2989
3046
|
};
|
2990
3047
|
};
|
2991
3048
|
};
|
@@ -3046,6 +3103,8 @@ interface components$4 {
|
|
3046
3103
|
_slug?: string;
|
3047
3104
|
/** @description Name of the author of the most recent change. */
|
3048
3105
|
_author?: string;
|
3106
|
+
/** @description Indicates this content entry should be sourced from a pattern library pattern. */
|
3107
|
+
_pattern?: string;
|
3049
3108
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
|
3050
3109
|
_locales?: string[];
|
3051
3110
|
/** @description Entry field values. */
|
@@ -3053,6 +3112,45 @@ interface components$4 {
|
|
3053
3112
|
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3054
3113
|
};
|
3055
3114
|
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3115
|
+
/**
|
3116
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3117
|
+
* Means nothing for PUTs; it will be ignored.
|
3118
|
+
*/
|
3119
|
+
_patternDataResources?: {
|
3120
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3121
|
+
};
|
3122
|
+
/**
|
3123
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
3124
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
3125
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
3126
|
+
* Means nothing for PUTs; it will be ignored.
|
3127
|
+
*
|
3128
|
+
* @enum {string}
|
3129
|
+
*/
|
3130
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
3131
|
+
/**
|
3132
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3133
|
+
* This can be used to override parameters that are defined on patterns,
|
3134
|
+
* including nested patterns, with values that are specific to this composition.
|
3135
|
+
* The keys in this object are component IDs.
|
3136
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3137
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3138
|
+
* the composition's override replaces the pattern's.
|
3139
|
+
*
|
3140
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3141
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3142
|
+
*/
|
3143
|
+
_overrides?: {
|
3144
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3145
|
+
};
|
3146
|
+
/**
|
3147
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3148
|
+
* by consumers of the pattern.
|
3149
|
+
*
|
3150
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3151
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3152
|
+
*/
|
3153
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3056
3154
|
};
|
3057
3155
|
/** @description Defines the shape of the entry input */
|
3058
3156
|
EntryInput: {
|
@@ -3072,6 +3170,42 @@ interface components$4 {
|
|
3072
3170
|
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3073
3171
|
};
|
3074
3172
|
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3173
|
+
/** @description Indicates this content entry should be sourced from a pattern library pattern. */
|
3174
|
+
_pattern?: string;
|
3175
|
+
/**
|
3176
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3177
|
+
* Means nothing for PUTs; it will be ignored.
|
3178
|
+
*/
|
3179
|
+
_patternDataResources?: {
|
3180
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3181
|
+
};
|
3182
|
+
/**
|
3183
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
3184
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
3185
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
3186
|
+
* Means nothing for PUTs; it will be ignored.
|
3187
|
+
*
|
3188
|
+
* @enum {string}
|
3189
|
+
*/
|
3190
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
3191
|
+
/**
|
3192
|
+
* @description Defines patch overrides for the content entry fields.
|
3193
|
+
* This can be used to override fields that are defined on patterns.
|
3194
|
+
*
|
3195
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3196
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3197
|
+
*/
|
3198
|
+
_overrides?: {
|
3199
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3200
|
+
};
|
3201
|
+
/**
|
3202
|
+
* @description When used on a pattern, defines how the pattern's fields may be overridden
|
3203
|
+
* by consumers of the pattern.
|
3204
|
+
*
|
3205
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3206
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3207
|
+
*/
|
3208
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3075
3209
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
|
3076
3210
|
_locales?: string[];
|
3077
3211
|
};
|
@@ -3099,6 +3233,11 @@ interface components$4 {
|
|
3099
3233
|
* @description Modified date string for this definition
|
3100
3234
|
*/
|
3101
3235
|
modified: string;
|
3236
|
+
/**
|
3237
|
+
* @description True if the entry is a pattern (which can be referenced on other entries)
|
3238
|
+
* @default false
|
3239
|
+
*/
|
3240
|
+
pattern?: boolean;
|
3102
3241
|
entry: components$4["schemas"]["Entry"];
|
3103
3242
|
};
|
3104
3243
|
EntryListResponse: {
|
@@ -3157,12 +3296,31 @@ interface components$4 {
|
|
3157
3296
|
withTotalCount: boolean;
|
3158
3297
|
/** @description Performs keyword search on the entries. */
|
3159
3298
|
keyword: string;
|
3299
|
+
/**
|
3300
|
+
* @description If true, any pattern references in the composition will be left unresolved.
|
3301
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
3302
|
+
* embedded into it, and serialize the pattern data separately.
|
3303
|
+
*/
|
3304
|
+
skipPatternResolution: boolean;
|
3160
3305
|
/**
|
3161
3306
|
* @description If true, any pattern override data is not resolved by the API.
|
3162
3307
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
3163
3308
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
3164
3309
|
*/
|
3165
3310
|
skipOverridesResolution: boolean;
|
3311
|
+
/**
|
3312
|
+
* @deprecated
|
3313
|
+
* @description This parameter is unused and has no effect. Passing this parameter will become an error in the future.
|
3314
|
+
*/
|
3315
|
+
skipParameterResolution: boolean;
|
3316
|
+
/**
|
3317
|
+
* @description Matches compositions based on whether they are a pattern composition or a regular composition.
|
3318
|
+
* If true, only pattern compositions will be returned.
|
3319
|
+
* If false, only regular compositions will be returned.
|
3320
|
+
* If omitted, both pattern and regular compositions will be returned.
|
3321
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3322
|
+
*/
|
3323
|
+
pattern: boolean;
|
3166
3324
|
/**
|
3167
3325
|
* @description One or more locales to filter and localize by.
|
3168
3326
|
* Only entries which enable one of the specified locales _or enable no locales_ will be returned.
|
@@ -3526,6 +3684,15 @@ interface external$c {
|
|
3526
3684
|
_slug?: string | null;
|
3527
3685
|
/** @description Friendly name of this component. */
|
3528
3686
|
_name: string;
|
3687
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
3688
|
+
_pattern?: string;
|
3689
|
+
/**
|
3690
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3691
|
+
* Means nothing for PUTs; it will be ignored.
|
3692
|
+
*/
|
3693
|
+
_patternDataResources?: {
|
3694
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3695
|
+
};
|
3529
3696
|
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3530
3697
|
/**
|
3531
3698
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -4197,6 +4364,15 @@ interface external$b {
|
|
4197
4364
|
_slug?: string | null;
|
4198
4365
|
/** @description Friendly name of this component. */
|
4199
4366
|
_name: string;
|
4367
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
4368
|
+
_pattern?: string;
|
4369
|
+
/**
|
4370
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4371
|
+
* Means nothing for PUTs; it will be ignored.
|
4372
|
+
*/
|
4373
|
+
_patternDataResources?: {
|
4374
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4375
|
+
};
|
4200
4376
|
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4201
4377
|
/**
|
4202
4378
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -4927,6 +5103,15 @@ interface external$a {
|
|
4927
5103
|
_slug?: string | null;
|
4928
5104
|
/** @description Friendly name of this component. */
|
4929
5105
|
_name: string;
|
5106
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
5107
|
+
_pattern?: string;
|
5108
|
+
/**
|
5109
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
5110
|
+
* Means nothing for PUTs; it will be ignored.
|
5111
|
+
*/
|
5112
|
+
_patternDataResources?: {
|
5113
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
5114
|
+
};
|
4930
5115
|
_dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4931
5116
|
/**
|
4932
5117
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -5594,6 +5779,15 @@ interface external$9 {
|
|
5594
5779
|
_slug?: string | null;
|
5595
5780
|
/** @description Friendly name of this component. */
|
5596
5781
|
_name: string;
|
5782
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
5783
|
+
_pattern?: string;
|
5784
|
+
/**
|
5785
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
5786
|
+
* Means nothing for PUTs; it will be ignored.
|
5787
|
+
*/
|
5788
|
+
_patternDataResources?: {
|
5789
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
5790
|
+
};
|
5597
5791
|
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
5598
5792
|
/**
|
5599
5793
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -6296,6 +6490,15 @@ interface external$8 {
|
|
6296
6490
|
_slug?: string | null;
|
6297
6491
|
/** @description Friendly name of this component. */
|
6298
6492
|
_name: string;
|
6493
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
6494
|
+
_pattern?: string;
|
6495
|
+
/**
|
6496
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
6497
|
+
* Means nothing for PUTs; it will be ignored.
|
6498
|
+
*/
|
6499
|
+
_patternDataResources?: {
|
6500
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
6501
|
+
};
|
6299
6502
|
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
6300
6503
|
/**
|
6301
6504
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -6998,6 +7201,15 @@ interface external$7 {
|
|
6998
7201
|
_slug?: string | null;
|
6999
7202
|
/** @description Friendly name of this component. */
|
7000
7203
|
_name: string;
|
7204
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
7205
|
+
_pattern?: string;
|
7206
|
+
/**
|
7207
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
7208
|
+
* Means nothing for PUTs; it will be ignored.
|
7209
|
+
*/
|
7210
|
+
_patternDataResources?: {
|
7211
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
7212
|
+
};
|
7001
7213
|
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
7002
7214
|
/**
|
7003
7215
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -8324,6 +8536,15 @@ interface external$5 {
|
|
8324
8536
|
_slug?: string | null;
|
8325
8537
|
/** @description Friendly name of this component. */
|
8326
8538
|
_name: string;
|
8539
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
8540
|
+
_pattern?: string;
|
8541
|
+
/**
|
8542
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
8543
|
+
* Means nothing for PUTs; it will be ignored.
|
8544
|
+
*/
|
8545
|
+
_patternDataResources?: {
|
8546
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
8547
|
+
};
|
8327
8548
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
8328
8549
|
/**
|
8329
8550
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -8995,6 +9216,15 @@ interface external$4 {
|
|
8995
9216
|
_slug?: string | null;
|
8996
9217
|
/** @description Friendly name of this component. */
|
8997
9218
|
_name: string;
|
9219
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
9220
|
+
_pattern?: string;
|
9221
|
+
/**
|
9222
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
9223
|
+
* Means nothing for PUTs; it will be ignored.
|
9224
|
+
*/
|
9225
|
+
_patternDataResources?: {
|
9226
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
9227
|
+
};
|
8998
9228
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
8999
9229
|
/**
|
9000
9230
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -9794,6 +10024,15 @@ interface external$3 {
|
|
9794
10024
|
_slug?: string | null;
|
9795
10025
|
/** @description Friendly name of this component. */
|
9796
10026
|
_name: string;
|
10027
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
10028
|
+
_pattern?: string;
|
10029
|
+
/**
|
10030
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
10031
|
+
* Means nothing for PUTs; it will be ignored.
|
10032
|
+
*/
|
10033
|
+
_patternDataResources?: {
|
10034
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
10035
|
+
};
|
9797
10036
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
9798
10037
|
/**
|
9799
10038
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -10598,6 +10837,14 @@ interface external$3 {
|
|
10598
10837
|
offset?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["offset"];
|
10599
10838
|
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
10600
10839
|
orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
|
10840
|
+
/**
|
10841
|
+
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
10842
|
+
* If true, only pattern compositions will be returned.
|
10843
|
+
* If false, only regular compositions will be returned.
|
10844
|
+
* If omitted, both pattern and regular compositions will be returned.
|
10845
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
10846
|
+
*/
|
10847
|
+
pattern?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["pattern"];
|
10601
10848
|
/** The project the entry/entries are on. */
|
10602
10849
|
projectId: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["projectId"];
|
10603
10850
|
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -10628,6 +10875,14 @@ interface external$3 {
|
|
10628
10875
|
withComponentIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
10629
10876
|
/** Performs keyword search on the entries. */
|
10630
10877
|
keyword?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["keyword"];
|
10878
|
+
/**
|
10879
|
+
* If true, any pattern references in the composition will be left unresolved.
|
10880
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
10881
|
+
* embedded into it, and serialize the pattern data separately.
|
10882
|
+
*/
|
10883
|
+
skipPatternResolution?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
|
10884
|
+
/** @deprecated This parameter is unused and has no effect. Passing this parameter will become an error in the future. */
|
10885
|
+
skipParameterResolution?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
10631
10886
|
/**
|
10632
10887
|
* If true, any pattern override data is not resolved by the API.
|
10633
10888
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
@@ -10695,6 +10950,11 @@ interface external$3 {
|
|
10695
10950
|
created?: string;
|
10696
10951
|
/** @description Ignored if present */
|
10697
10952
|
modified?: string;
|
10953
|
+
/**
|
10954
|
+
* @description True if the entry is a pattern (which can be referenced on other entries)
|
10955
|
+
* @default false
|
10956
|
+
*/
|
10957
|
+
pattern?: boolean;
|
10698
10958
|
};
|
10699
10959
|
};
|
10700
10960
|
};
|
@@ -10755,6 +11015,8 @@ interface external$3 {
|
|
10755
11015
|
_slug?: string;
|
10756
11016
|
/** @description Name of the author of the most recent change. */
|
10757
11017
|
_author?: string;
|
11018
|
+
/** @description Indicates this content entry should be sourced from a pattern library pattern. */
|
11019
|
+
_pattern?: string;
|
10758
11020
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
|
10759
11021
|
_locales?: string[];
|
10760
11022
|
/** @description Entry field values. */
|
@@ -10762,6 +11024,45 @@ interface external$3 {
|
|
10762
11024
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
10763
11025
|
};
|
10764
11026
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
11027
|
+
/**
|
11028
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
11029
|
+
* Means nothing for PUTs; it will be ignored.
|
11030
|
+
*/
|
11031
|
+
_patternDataResources?: {
|
11032
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
11033
|
+
};
|
11034
|
+
/**
|
11035
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
11036
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
11037
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
11038
|
+
* Means nothing for PUTs; it will be ignored.
|
11039
|
+
*
|
11040
|
+
* @enum {string}
|
11041
|
+
*/
|
11042
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
11043
|
+
/**
|
11044
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
11045
|
+
* This can be used to override parameters that are defined on patterns,
|
11046
|
+
* including nested patterns, with values that are specific to this composition.
|
11047
|
+
* The keys in this object are component IDs.
|
11048
|
+
* Overrides are applied from the top down, so for example if both the composition
|
11049
|
+
* and a pattern on the composition define an override on a nested pattern,
|
11050
|
+
* the composition's override replaces the pattern's.
|
11051
|
+
*
|
11052
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
11053
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
11054
|
+
*/
|
11055
|
+
_overrides?: {
|
11056
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
11057
|
+
};
|
11058
|
+
/**
|
11059
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
11060
|
+
* by consumers of the pattern.
|
11061
|
+
*
|
11062
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
11063
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
11064
|
+
*/
|
11065
|
+
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
10765
11066
|
};
|
10766
11067
|
/** @description Defines the shape of the entry input */
|
10767
11068
|
EntryInput: {
|
@@ -10781,6 +11082,42 @@ interface external$3 {
|
|
10781
11082
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
10782
11083
|
};
|
10783
11084
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
11085
|
+
/** @description Indicates this content entry should be sourced from a pattern library pattern. */
|
11086
|
+
_pattern?: string;
|
11087
|
+
/**
|
11088
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
11089
|
+
* Means nothing for PUTs; it will be ignored.
|
11090
|
+
*/
|
11091
|
+
_patternDataResources?: {
|
11092
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
11093
|
+
};
|
11094
|
+
/**
|
11095
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
11096
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
11097
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
11098
|
+
* Means nothing for PUTs; it will be ignored.
|
11099
|
+
*
|
11100
|
+
* @enum {string}
|
11101
|
+
*/
|
11102
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
11103
|
+
/**
|
11104
|
+
* @description Defines patch overrides for the content entry fields.
|
11105
|
+
* This can be used to override fields that are defined on patterns.
|
11106
|
+
*
|
11107
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
11108
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
11109
|
+
*/
|
11110
|
+
_overrides?: {
|
11111
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
11112
|
+
};
|
11113
|
+
/**
|
11114
|
+
* @description When used on a pattern, defines how the pattern's fields may be overridden
|
11115
|
+
* by consumers of the pattern.
|
11116
|
+
*
|
11117
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
11118
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
11119
|
+
*/
|
11120
|
+
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
10784
11121
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data. */
|
10785
11122
|
_locales?: string[];
|
10786
11123
|
};
|
@@ -10808,6 +11145,11 @@ interface external$3 {
|
|
10808
11145
|
* @description Modified date string for this definition
|
10809
11146
|
*/
|
10810
11147
|
modified: string;
|
11148
|
+
/**
|
11149
|
+
* @description True if the entry is a pattern (which can be referenced on other entries)
|
11150
|
+
* @default false
|
11151
|
+
*/
|
11152
|
+
pattern?: boolean;
|
10811
11153
|
entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["Entry"];
|
10812
11154
|
};
|
10813
11155
|
EntryListResponse: {
|
@@ -10866,12 +11208,31 @@ interface external$3 {
|
|
10866
11208
|
withTotalCount: boolean;
|
10867
11209
|
/** @description Performs keyword search on the entries. */
|
10868
11210
|
keyword: string;
|
11211
|
+
/**
|
11212
|
+
* @description If true, any pattern references in the composition will be left unresolved.
|
11213
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
11214
|
+
* embedded into it, and serialize the pattern data separately.
|
11215
|
+
*/
|
11216
|
+
skipPatternResolution: boolean;
|
10869
11217
|
/**
|
10870
11218
|
* @description If true, any pattern override data is not resolved by the API.
|
10871
11219
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
10872
11220
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
10873
11221
|
*/
|
10874
11222
|
skipOverridesResolution: boolean;
|
11223
|
+
/**
|
11224
|
+
* @deprecated
|
11225
|
+
* @description This parameter is unused and has no effect. Passing this parameter will become an error in the future.
|
11226
|
+
*/
|
11227
|
+
skipParameterResolution: boolean;
|
11228
|
+
/**
|
11229
|
+
* @description Matches compositions based on whether they are a pattern composition or a regular composition.
|
11230
|
+
* If true, only pattern compositions will be returned.
|
11231
|
+
* If false, only regular compositions will be returned.
|
11232
|
+
* If omitted, both pattern and regular compositions will be returned.
|
11233
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
11234
|
+
*/
|
11235
|
+
pattern: boolean;
|
10875
11236
|
/**
|
10876
11237
|
* @description One or more locales to filter and localize by.
|
10877
11238
|
* Only entries which enable one of the specified locales _or enable no locales_ will be returned.
|
@@ -11792,6 +12153,15 @@ interface external$2 {
|
|
11792
12153
|
_slug?: string | null;
|
11793
12154
|
/** @description Friendly name of this component. */
|
11794
12155
|
_name: string;
|
12156
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
12157
|
+
_pattern?: string;
|
12158
|
+
/**
|
12159
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
12160
|
+
* Means nothing for PUTs; it will be ignored.
|
12161
|
+
*/
|
12162
|
+
_patternDataResources?: {
|
12163
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
12164
|
+
};
|
11795
12165
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
11796
12166
|
/**
|
11797
12167
|
* @description Defines patch overrides to component IDs that live in the composition.
|
@@ -14459,6 +14829,17 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
14459
14829
|
_id: string;
|
14460
14830
|
_slug?: string | null | undefined;
|
14461
14831
|
_name: string;
|
14832
|
+
_pattern?: string | undefined;
|
14833
|
+
_patternDataResources?: {
|
14834
|
+
[key: string]: {
|
14835
|
+
type: string;
|
14836
|
+
isPatternParameter?: boolean | undefined;
|
14837
|
+
ignorePatternParameterDefault?: boolean | undefined;
|
14838
|
+
variables?: {
|
14839
|
+
[key: string]: string;
|
14840
|
+
} | undefined;
|
14841
|
+
};
|
14842
|
+
} | undefined;
|
14462
14843
|
_dataResources?: {
|
14463
14844
|
[key: string]: {
|
14464
14845
|
type: string;
|