@uniformdev/canvas 17.5.1-alpha.6 → 17.6.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/chunk-62Q2UUAR.mjs +4 -0
- package/dist/cli/cli.d.ts +1 -1
- package/dist/cli/cli.js +41 -41
- package/dist/cli/cli.mjs +36 -36
- package/dist/{createEventBus-ae757f10.d.ts → createEventBus-e55b26b0.d.ts} +686 -686
- package/dist/index.d.ts +434 -426
- package/dist/index.esm.js +1 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +1 -1
- package/package.json +6 -6
- package/dist/chunk-3DNK2OLJ.mjs +0 -4
|
@@ -1,592 +1,85 @@
|
|
|
1
1
|
import Pusher from 'pusher-js';
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
/** Max number of records to return */
|
|
19
|
-
limit?: number;
|
|
20
|
-
/** Whether to fetch system meta-component definitions (personalize, test, etc) */
|
|
21
|
-
includeSystem?: boolean;
|
|
22
|
-
};
|
|
23
|
-
};
|
|
24
|
-
responses: {
|
|
25
|
-
/** OK */
|
|
26
|
-
200: {
|
|
27
|
-
content: {
|
|
28
|
-
"application/json": {
|
|
29
|
-
/** @description Component definitions that match the query */
|
|
30
|
-
componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
|
31
|
-
};
|
|
32
|
-
};
|
|
33
|
-
};
|
|
34
|
-
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
35
|
-
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
36
|
-
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
37
|
-
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
38
|
-
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
39
|
-
};
|
|
3
|
+
interface components$2 {
|
|
4
|
+
schemas: {
|
|
5
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
|
6
|
+
PublicIdProperty: string;
|
|
7
|
+
/** @description The definition of a component parameter */
|
|
8
|
+
ComponentDefinitionParameter: {
|
|
9
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
|
10
|
+
/** @description Friendly name of the parameter */
|
|
11
|
+
name: string;
|
|
12
|
+
/** @description Appears next to the parameter in the Composition editor */
|
|
13
|
+
helpText?: string;
|
|
14
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
15
|
+
type: string;
|
|
16
|
+
/** @description The configuration object for the type (type-specific) */
|
|
17
|
+
typeConfig?: unknown;
|
|
40
18
|
};
|
|
41
|
-
/**
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
* @description The project ID to upsert the component definition to
|
|
58
|
-
*/
|
|
59
|
-
projectId: string;
|
|
60
|
-
componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
|
61
|
-
};
|
|
62
|
-
};
|
|
63
|
-
};
|
|
19
|
+
/** @description The definition of a named component slot that can contain other components */
|
|
20
|
+
ComponentDefinitionSlot: {
|
|
21
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
|
22
|
+
/** @description Friendly name of the slot */
|
|
23
|
+
name: string;
|
|
24
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
25
|
+
allowedComponents: string[];
|
|
26
|
+
/**
|
|
27
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
28
|
+
* @default false
|
|
29
|
+
*/
|
|
30
|
+
inheritAllowedComponents: boolean;
|
|
31
|
+
/** @description Minimum valid number of components in this slot */
|
|
32
|
+
minComponents?: number;
|
|
33
|
+
/** @description Maximum valid number of components in this slot */
|
|
34
|
+
maxComponents?: number;
|
|
64
35
|
};
|
|
65
|
-
/**
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
36
|
+
/** @description The definition of a composition's slug settings */
|
|
37
|
+
ComponentDefinitionSlugSettings: {
|
|
38
|
+
/**
|
|
39
|
+
* @description Whether the slug is required
|
|
40
|
+
* no: slug is optional
|
|
41
|
+
* yes: slug is required
|
|
42
|
+
* disabled: slug is disabled and will not be shown in the editor
|
|
43
|
+
*
|
|
44
|
+
* @default no
|
|
45
|
+
* @enum {string}
|
|
46
|
+
*/
|
|
47
|
+
required?: "no" | "yes" | "disabled";
|
|
48
|
+
/**
|
|
49
|
+
* @description Slug uniqueness configuration.
|
|
50
|
+
* no = no unique constraint
|
|
51
|
+
* local = must be unique within this component type
|
|
52
|
+
* global = must be unique across all component types
|
|
53
|
+
*
|
|
54
|
+
* @enum {string}
|
|
55
|
+
*/
|
|
56
|
+
unique?: "no" | "local" | "global";
|
|
57
|
+
/** @description Regular expression slugs must match */
|
|
58
|
+
regularExpression?: string;
|
|
59
|
+
/**
|
|
60
|
+
* @description Custom error message when regular expression validation fails.
|
|
61
|
+
* Has no effect if `regularExpression` is not set.
|
|
62
|
+
*/
|
|
63
|
+
regularExpressionMessage?: string;
|
|
89
64
|
};
|
|
90
|
-
/**
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
};
|
|
65
|
+
/** @description The definition of a component variant */
|
|
66
|
+
ComponentDefinitionVariant: {
|
|
67
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
|
68
|
+
/** @description Friendly name of the variant */
|
|
69
|
+
name: string;
|
|
96
70
|
};
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
responses: {
|
|
110
|
-
/** Request input validation failed */
|
|
111
|
-
BadRequestError: {
|
|
112
|
-
content: {
|
|
113
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
114
|
-
};
|
|
115
|
-
};
|
|
116
|
-
/** API key or token was not valid */
|
|
117
|
-
UnauthorizedError: {
|
|
118
|
-
content: {
|
|
119
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
120
|
-
};
|
|
121
|
-
};
|
|
122
|
-
/** Permission was denied */
|
|
123
|
-
ForbiddenError: {
|
|
124
|
-
content: {
|
|
125
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
126
|
-
};
|
|
127
|
-
};
|
|
128
|
-
/** Resource not found */
|
|
129
|
-
NotFoundError: {
|
|
130
|
-
content: {
|
|
131
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
132
|
-
};
|
|
133
|
-
};
|
|
134
|
-
/** Too many requests in allowed time period */
|
|
135
|
-
RateLimitError: unknown;
|
|
136
|
-
/** Execution error occurred */
|
|
137
|
-
InternalServerError: unknown;
|
|
138
|
-
};
|
|
139
|
-
};
|
|
140
|
-
operations: {};
|
|
141
|
-
};
|
|
142
|
-
"uniform-canvas-types.swagger.yml": {
|
|
143
|
-
paths: {};
|
|
144
|
-
components: {
|
|
145
|
-
schemas: {
|
|
146
|
-
/** @description Public ID (used in code). Do not change after creation. */
|
|
147
|
-
PublicIdProperty: string;
|
|
148
|
-
/** @description The definition of a component parameter */
|
|
149
|
-
ComponentDefinitionParameter: {
|
|
150
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
151
|
-
/** @description Friendly name of the parameter */
|
|
152
|
-
name: string;
|
|
153
|
-
/** @description Appears next to the parameter in the Composition editor */
|
|
154
|
-
helpText?: string;
|
|
155
|
-
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
156
|
-
type: string;
|
|
157
|
-
/** @description The configuration object for the type (type-specific) */
|
|
158
|
-
typeConfig?: unknown;
|
|
159
|
-
};
|
|
160
|
-
/** @description The definition of a named component slot that can contain other components */
|
|
161
|
-
ComponentDefinitionSlot: {
|
|
162
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
163
|
-
/** @description Friendly name of the slot */
|
|
164
|
-
name: string;
|
|
165
|
-
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
166
|
-
allowedComponents: string[];
|
|
167
|
-
/**
|
|
168
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
169
|
-
* @default false
|
|
170
|
-
*/
|
|
171
|
-
inheritAllowedComponents: boolean;
|
|
172
|
-
/** @description Minimum valid number of components in this slot */
|
|
173
|
-
minComponents?: number;
|
|
174
|
-
/** @description Maximum valid number of components in this slot */
|
|
175
|
-
maxComponents?: number;
|
|
176
|
-
};
|
|
177
|
-
/** @description The definition of a composition's slug settings */
|
|
178
|
-
ComponentDefinitionSlugSettings: {
|
|
179
|
-
/**
|
|
180
|
-
* @description Whether the slug is required
|
|
181
|
-
* no: slug is optional
|
|
182
|
-
* yes: slug is required
|
|
183
|
-
* disabled: slug is disabled and will not be shown in the editor
|
|
184
|
-
*
|
|
185
|
-
* @default no
|
|
186
|
-
* @enum {string}
|
|
187
|
-
*/
|
|
188
|
-
required?: "no" | "yes" | "disabled";
|
|
189
|
-
/**
|
|
190
|
-
* @description Slug uniqueness configuration.
|
|
191
|
-
* no = no unique constraint
|
|
192
|
-
* local = must be unique within this component type
|
|
193
|
-
* global = must be unique across all component types
|
|
194
|
-
*
|
|
195
|
-
* @enum {string}
|
|
196
|
-
*/
|
|
197
|
-
unique?: "no" | "local" | "global";
|
|
198
|
-
/** @description Regular expression slugs must match */
|
|
199
|
-
regularExpression?: string;
|
|
200
|
-
/**
|
|
201
|
-
* @description Custom error message when regular expression validation fails.
|
|
202
|
-
* Has no effect if `regularExpression` is not set.
|
|
203
|
-
*/
|
|
204
|
-
regularExpressionMessage?: string;
|
|
205
|
-
};
|
|
206
|
-
/** @description The definition of a component variant */
|
|
207
|
-
ComponentDefinitionVariant: {
|
|
208
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
209
|
-
/** @description Friendly name of the variant */
|
|
210
|
-
name: string;
|
|
211
|
-
};
|
|
212
|
-
/** @description Permission set for a component defintion */
|
|
213
|
-
ComponentDefinitionPermission: {
|
|
214
|
-
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
215
|
-
/**
|
|
216
|
-
* @description Permission type for this permission ComponentDefinition:
|
|
217
|
-
* read | write | create | delete
|
|
218
|
-
*
|
|
219
|
-
* @enum {string}
|
|
220
|
-
*/
|
|
221
|
-
permission: "read" | "write" | "create" | "delete";
|
|
222
|
-
/** @description State of the component that this permission applies to */
|
|
223
|
-
state: number;
|
|
224
|
-
};
|
|
225
|
-
/** @description Defines a component type that can live on a Composition */
|
|
226
|
-
ComponentDefinition: {
|
|
227
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
228
|
-
/** @description Friendly name of the component definition */
|
|
229
|
-
name: string;
|
|
230
|
-
/**
|
|
231
|
-
* @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
232
|
-
* @default screen
|
|
233
|
-
*/
|
|
234
|
-
icon?: string;
|
|
235
|
-
/**
|
|
236
|
-
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
237
|
-
* The parameter type must support being used as a title parameter for this to work.
|
|
238
|
-
*/
|
|
239
|
-
titleParameter?: string | null;
|
|
240
|
-
/**
|
|
241
|
-
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
|
242
|
-
* @default false
|
|
243
|
-
*/
|
|
244
|
-
canBeComposition?: boolean;
|
|
245
|
-
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
|
246
|
-
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
|
247
|
-
/**
|
|
248
|
-
* @description if this component uses team permissions or custom permissions
|
|
249
|
-
* @default true
|
|
250
|
-
*/
|
|
251
|
-
useTeamPermissions?: boolean;
|
|
252
|
-
/** @description Custom role permissions for this component definition */
|
|
253
|
-
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
254
|
-
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
|
255
|
-
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
|
256
|
-
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
|
257
|
-
/** @description Default component instance value */
|
|
258
|
-
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
|
259
|
-
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
|
260
|
-
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
|
261
|
-
/** @description Created date string for this definition (ignored for writes) */
|
|
262
|
-
created?: string;
|
|
263
|
-
/** @description Last modified date string for this definition (ignored for writes) */
|
|
264
|
-
updated?: string;
|
|
265
|
-
};
|
|
266
|
-
/** @description Defines an editable parameter on a component. */
|
|
267
|
-
ComponentParameter: {
|
|
268
|
-
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
|
269
|
-
value: unknown;
|
|
270
|
-
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
|
271
|
-
type: string;
|
|
272
|
-
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
|
273
|
-
};
|
|
274
|
-
/**
|
|
275
|
-
* @deprecated
|
|
276
|
-
* @description Defines a connection to a data element on a data resource. Do not use.
|
|
277
|
-
*/
|
|
278
|
-
DataElementConnectionDefinition: {
|
|
279
|
-
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
|
280
|
-
pointer: string;
|
|
281
|
-
/**
|
|
282
|
-
* @description The syntax used to select the data element to bind to
|
|
283
|
-
* @enum {string}
|
|
284
|
-
*/
|
|
285
|
-
syntax: "jptr";
|
|
286
|
-
/**
|
|
287
|
-
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
|
288
|
-
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
|
289
|
-
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
|
290
|
-
*
|
|
291
|
-
* @default false
|
|
292
|
-
*/
|
|
293
|
-
required?: boolean;
|
|
294
|
-
};
|
|
295
|
-
/** @description Defines the shape of a component instance served by the composition API. */
|
|
296
|
-
ComponentInstance: {
|
|
297
|
-
/** @description Type of the component instance (public_id of its definition) */
|
|
298
|
-
type: string;
|
|
299
|
-
/** @description Component parameter values for the component instance */
|
|
300
|
-
parameters?: {
|
|
301
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
302
|
-
};
|
|
303
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
304
|
-
variant?: string;
|
|
305
|
-
/** @description Slots containing any child components */
|
|
306
|
-
slots?: {
|
|
307
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
308
|
-
};
|
|
309
|
-
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
|
310
|
-
_id?: string;
|
|
311
|
-
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
|
312
|
-
_pattern?: string;
|
|
313
|
-
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
314
|
-
/**
|
|
315
|
-
* @deprecated
|
|
316
|
-
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
|
317
|
-
* Means nothing for PUTs; it will be ignored.
|
|
318
|
-
*/
|
|
319
|
-
_patternDataResources?: {
|
|
320
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
321
|
-
};
|
|
322
|
-
/**
|
|
323
|
-
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
324
|
-
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
325
|
-
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
|
326
|
-
* Means nothing for PUTs; it will be ignored.
|
|
327
|
-
*
|
|
328
|
-
* @enum {string}
|
|
329
|
-
*/
|
|
330
|
-
_patternError?: "NOTFOUND" | "CYCLIC";
|
|
331
|
-
};
|
|
332
|
-
/** @description Defines the shape of the root component in a composition */
|
|
333
|
-
RootComponentInstance: {
|
|
334
|
-
/** @description Type of the component instance (public_id of its definition) */
|
|
335
|
-
type: string;
|
|
336
|
-
/** @description Component parameter values for the component instance */
|
|
337
|
-
parameters?: {
|
|
338
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
339
|
-
};
|
|
340
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
341
|
-
variant?: string;
|
|
342
|
-
/** @description Slots containing any child components */
|
|
343
|
-
slots?: {
|
|
344
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
345
|
-
};
|
|
346
|
-
/** @description The public UUID of the composition. */
|
|
347
|
-
_id: string;
|
|
348
|
-
/** @description Slug pattern of this component. */
|
|
349
|
-
_slug?: string | null;
|
|
350
|
-
/** @description Friendly name of this component. */
|
|
351
|
-
_name: string;
|
|
352
|
-
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
353
|
-
};
|
|
354
|
-
/**
|
|
355
|
-
* @deprecated
|
|
356
|
-
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
|
357
|
-
*/
|
|
358
|
-
DataSourceInfo: {
|
|
359
|
-
/** @description Public ID of the data source */
|
|
360
|
-
id: string;
|
|
361
|
-
/** @description Display name of the data source */
|
|
362
|
-
displayName: string;
|
|
363
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
364
|
-
connectorType: string;
|
|
365
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
366
|
-
baseUrl: string;
|
|
367
|
-
};
|
|
368
|
-
/**
|
|
369
|
-
* @deprecated
|
|
370
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
371
|
-
*/
|
|
372
|
-
DataSource: {
|
|
373
|
-
/** @description Public ID of the data source */
|
|
374
|
-
id: string;
|
|
375
|
-
/** @description Display name of the data source */
|
|
376
|
-
displayName: string;
|
|
377
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
378
|
-
connectorType: string;
|
|
379
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
380
|
-
baseUrl: string;
|
|
381
|
-
headers?: {
|
|
382
|
-
[key: string]: string;
|
|
383
|
-
} | {
|
|
384
|
-
key: string;
|
|
385
|
-
value: string;
|
|
386
|
-
}[];
|
|
387
|
-
parameters?: {
|
|
388
|
-
[key: string]: string;
|
|
389
|
-
} | {
|
|
390
|
-
key: string;
|
|
391
|
-
value: string;
|
|
392
|
-
}[];
|
|
393
|
-
/** @description Variables needed to make calls to the data source */
|
|
394
|
-
variables?: {
|
|
395
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
396
|
-
};
|
|
397
|
-
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
|
398
|
-
custom?: {
|
|
399
|
-
[key: string]: unknown;
|
|
400
|
-
};
|
|
401
|
-
};
|
|
402
|
-
/**
|
|
403
|
-
* @deprecated
|
|
404
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
|
405
|
-
*/
|
|
406
|
-
DataType: {
|
|
407
|
-
/** @description Public ID of the data type */
|
|
408
|
-
id: string;
|
|
409
|
-
/** @description Display name of the data type */
|
|
410
|
-
displayName: string;
|
|
411
|
-
/** @description Public ID of the associated data source */
|
|
412
|
-
dataSourceId: string;
|
|
413
|
-
/**
|
|
414
|
-
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
415
|
-
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
416
|
-
* no special UI or processing is required.
|
|
417
|
-
*/
|
|
418
|
-
archetype?: string;
|
|
419
|
-
allowedOnComponents?: string[];
|
|
420
|
-
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
421
|
-
path: string;
|
|
422
|
-
/** @description Time-to-live for the resource data cache. */
|
|
423
|
-
ttl?: number;
|
|
424
|
-
/** @description A key for the resource data cache purging. */
|
|
425
|
-
purgeKey?: string;
|
|
426
|
-
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
427
|
-
badgeIconUrl?: string;
|
|
428
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
|
429
|
-
headers?: {
|
|
430
|
-
[key: string]: string;
|
|
431
|
-
} | {
|
|
432
|
-
key: string;
|
|
433
|
-
value: string;
|
|
434
|
-
}[];
|
|
435
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
|
436
|
-
parameters?: {
|
|
437
|
-
[key: string]: string;
|
|
438
|
-
} | {
|
|
439
|
-
key: string;
|
|
440
|
-
value: string;
|
|
441
|
-
}[];
|
|
442
|
-
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
|
443
|
-
body?: string;
|
|
444
|
-
/**
|
|
445
|
-
* @description HTTP method to use with requests to the data type.
|
|
446
|
-
* @default GET
|
|
447
|
-
* @enum {string}
|
|
448
|
-
*/
|
|
449
|
-
method: "GET" | "POST" | "HEAD";
|
|
450
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
|
451
|
-
variables?: {
|
|
452
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
453
|
-
};
|
|
454
|
-
/** @description Custom configuration specific to the data source being defined */
|
|
455
|
-
custom?: {
|
|
456
|
-
[key: string]: unknown;
|
|
457
|
-
};
|
|
458
|
-
};
|
|
459
|
-
/**
|
|
460
|
-
* @deprecated
|
|
461
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
462
|
-
*/
|
|
463
|
-
DataVariableDefinition: {
|
|
464
|
-
/** @description Display name of the data variable */
|
|
465
|
-
displayName?: string;
|
|
466
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
467
|
-
helpText?: string;
|
|
468
|
-
/**
|
|
469
|
-
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
470
|
-
* @default text
|
|
471
|
-
*/
|
|
472
|
-
type?: string;
|
|
473
|
-
/** @description Default value of the data variable */
|
|
474
|
-
default: string;
|
|
475
|
-
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
476
|
-
order?: number;
|
|
477
|
-
};
|
|
478
|
-
/**
|
|
479
|
-
* @deprecated
|
|
480
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
481
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
482
|
-
*/
|
|
483
|
-
DataResourceDefinitions: {
|
|
484
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
485
|
-
};
|
|
486
|
-
/**
|
|
487
|
-
* @deprecated
|
|
488
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
489
|
-
*/
|
|
490
|
-
DataResourceDefinition: {
|
|
491
|
-
/** @description Public ID of the data type that provides this data */
|
|
492
|
-
type: string;
|
|
493
|
-
/** @description Whether this data is a pattern parameter that has to 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. */
|
|
494
|
-
isPatternParameter?: boolean;
|
|
495
|
-
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
496
|
-
};
|
|
497
|
-
/**
|
|
498
|
-
* @deprecated
|
|
499
|
-
* @description Variable values for a data resource.
|
|
500
|
-
*/
|
|
501
|
-
DataResourceVariables: {
|
|
502
|
-
[key: string]: string;
|
|
503
|
-
};
|
|
504
|
-
};
|
|
505
|
-
};
|
|
506
|
-
operations: {};
|
|
507
|
-
};
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
interface components$2 {
|
|
511
|
-
schemas: {
|
|
512
|
-
/** @description Public ID (used in code). Do not change after creation. */
|
|
513
|
-
PublicIdProperty: string;
|
|
514
|
-
/** @description The definition of a component parameter */
|
|
515
|
-
ComponentDefinitionParameter: {
|
|
516
|
-
id: components$2["schemas"]["PublicIdProperty"];
|
|
517
|
-
/** @description Friendly name of the parameter */
|
|
518
|
-
name: string;
|
|
519
|
-
/** @description Appears next to the parameter in the Composition editor */
|
|
520
|
-
helpText?: string;
|
|
521
|
-
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
522
|
-
type: string;
|
|
523
|
-
/** @description The configuration object for the type (type-specific) */
|
|
524
|
-
typeConfig?: unknown;
|
|
525
|
-
};
|
|
526
|
-
/** @description The definition of a named component slot that can contain other components */
|
|
527
|
-
ComponentDefinitionSlot: {
|
|
528
|
-
id: components$2["schemas"]["PublicIdProperty"];
|
|
529
|
-
/** @description Friendly name of the slot */
|
|
530
|
-
name: string;
|
|
531
|
-
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
532
|
-
allowedComponents: string[];
|
|
533
|
-
/**
|
|
534
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
535
|
-
* @default false
|
|
536
|
-
*/
|
|
537
|
-
inheritAllowedComponents: boolean;
|
|
538
|
-
/** @description Minimum valid number of components in this slot */
|
|
539
|
-
minComponents?: number;
|
|
540
|
-
/** @description Maximum valid number of components in this slot */
|
|
541
|
-
maxComponents?: number;
|
|
542
|
-
};
|
|
543
|
-
/** @description The definition of a composition's slug settings */
|
|
544
|
-
ComponentDefinitionSlugSettings: {
|
|
545
|
-
/**
|
|
546
|
-
* @description Whether the slug is required
|
|
547
|
-
* no: slug is optional
|
|
548
|
-
* yes: slug is required
|
|
549
|
-
* disabled: slug is disabled and will not be shown in the editor
|
|
550
|
-
*
|
|
551
|
-
* @default no
|
|
552
|
-
* @enum {string}
|
|
553
|
-
*/
|
|
554
|
-
required?: "no" | "yes" | "disabled";
|
|
555
|
-
/**
|
|
556
|
-
* @description Slug uniqueness configuration.
|
|
557
|
-
* no = no unique constraint
|
|
558
|
-
* local = must be unique within this component type
|
|
559
|
-
* global = must be unique across all component types
|
|
560
|
-
*
|
|
561
|
-
* @enum {string}
|
|
562
|
-
*/
|
|
563
|
-
unique?: "no" | "local" | "global";
|
|
564
|
-
/** @description Regular expression slugs must match */
|
|
565
|
-
regularExpression?: string;
|
|
566
|
-
/**
|
|
567
|
-
* @description Custom error message when regular expression validation fails.
|
|
568
|
-
* Has no effect if `regularExpression` is not set.
|
|
569
|
-
*/
|
|
570
|
-
regularExpressionMessage?: string;
|
|
571
|
-
};
|
|
572
|
-
/** @description The definition of a component variant */
|
|
573
|
-
ComponentDefinitionVariant: {
|
|
574
|
-
id: components$2["schemas"]["PublicIdProperty"];
|
|
575
|
-
/** @description Friendly name of the variant */
|
|
576
|
-
name: string;
|
|
577
|
-
};
|
|
578
|
-
/** @description Permission set for a component defintion */
|
|
579
|
-
ComponentDefinitionPermission: {
|
|
580
|
-
roleId: components$2["schemas"]["PublicIdProperty"];
|
|
581
|
-
/**
|
|
582
|
-
* @description Permission type for this permission ComponentDefinition:
|
|
583
|
-
* read | write | create | delete
|
|
584
|
-
*
|
|
585
|
-
* @enum {string}
|
|
586
|
-
*/
|
|
587
|
-
permission: "read" | "write" | "create" | "delete";
|
|
588
|
-
/** @description State of the component that this permission applies to */
|
|
589
|
-
state: number;
|
|
71
|
+
/** @description Permission set for a component defintion */
|
|
72
|
+
ComponentDefinitionPermission: {
|
|
73
|
+
roleId: components$2["schemas"]["PublicIdProperty"];
|
|
74
|
+
/**
|
|
75
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
76
|
+
* read | write | create | delete
|
|
77
|
+
*
|
|
78
|
+
* @enum {string}
|
|
79
|
+
*/
|
|
80
|
+
permission: "read" | "write" | "create" | "delete";
|
|
81
|
+
/** @description State of the component that this permission applies to */
|
|
82
|
+
state: number;
|
|
590
83
|
};
|
|
591
84
|
/** @description Defines a component type that can live on a Composition */
|
|
592
85
|
ComponentDefinition: {
|
|
@@ -817,56 +310,563 @@ interface components$2 {
|
|
|
817
310
|
variables?: {
|
|
818
311
|
[key: string]: components$2["schemas"]["DataVariableDefinition"];
|
|
819
312
|
};
|
|
820
|
-
/** @description Custom configuration specific to the data source being defined */
|
|
821
|
-
custom?: {
|
|
822
|
-
[key: string]: unknown;
|
|
313
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
314
|
+
custom?: {
|
|
315
|
+
[key: string]: unknown;
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
/**
|
|
319
|
+
* @deprecated
|
|
320
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
321
|
+
*/
|
|
322
|
+
DataVariableDefinition: {
|
|
323
|
+
/** @description Display name of the data variable */
|
|
324
|
+
displayName?: string;
|
|
325
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
326
|
+
helpText?: string;
|
|
327
|
+
/**
|
|
328
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
329
|
+
* @default text
|
|
330
|
+
*/
|
|
331
|
+
type?: string;
|
|
332
|
+
/** @description Default value of the data variable */
|
|
333
|
+
default: string;
|
|
334
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
335
|
+
order?: number;
|
|
336
|
+
};
|
|
337
|
+
/**
|
|
338
|
+
* @deprecated
|
|
339
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
340
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
341
|
+
*/
|
|
342
|
+
DataResourceDefinitions: {
|
|
343
|
+
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
|
344
|
+
};
|
|
345
|
+
/**
|
|
346
|
+
* @deprecated
|
|
347
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
348
|
+
*/
|
|
349
|
+
DataResourceDefinition: {
|
|
350
|
+
/** @description Public ID of the data type that provides this data */
|
|
351
|
+
type: string;
|
|
352
|
+
/** @description Whether this data is a pattern parameter that has to 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. */
|
|
353
|
+
isPatternParameter?: boolean;
|
|
354
|
+
variables?: components$2["schemas"]["DataResourceVariables"];
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* @deprecated
|
|
358
|
+
* @description Variable values for a data resource.
|
|
359
|
+
*/
|
|
360
|
+
DataResourceVariables: {
|
|
361
|
+
[key: string]: string;
|
|
362
|
+
};
|
|
363
|
+
};
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* This file was auto-generated by openapi-typescript.
|
|
368
|
+
* Do not make direct changes to the file.
|
|
369
|
+
*/
|
|
370
|
+
interface paths$4 {
|
|
371
|
+
"/api/v1/canvas-definitions": {
|
|
372
|
+
get: {
|
|
373
|
+
parameters: {
|
|
374
|
+
query: {
|
|
375
|
+
/** The project ID to get component definitions for. */
|
|
376
|
+
projectId: string;
|
|
377
|
+
/** Limit list to one result by ID (response remains an array). */
|
|
378
|
+
componentId?: string;
|
|
379
|
+
/** Number of records to skip */
|
|
380
|
+
offset?: number;
|
|
381
|
+
/** Max number of records to return */
|
|
382
|
+
limit?: number;
|
|
383
|
+
/** Whether to fetch system meta-component definitions (personalize, test, etc) */
|
|
384
|
+
includeSystem?: boolean;
|
|
385
|
+
};
|
|
386
|
+
};
|
|
387
|
+
responses: {
|
|
388
|
+
/** OK */
|
|
389
|
+
200: {
|
|
390
|
+
content: {
|
|
391
|
+
"application/json": {
|
|
392
|
+
/** @description Component definitions that match the query */
|
|
393
|
+
componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
|
394
|
+
};
|
|
395
|
+
};
|
|
396
|
+
};
|
|
397
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
398
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
399
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
400
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
401
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
402
|
+
};
|
|
403
|
+
};
|
|
404
|
+
/** Upserts a component definition */
|
|
405
|
+
put: {
|
|
406
|
+
responses: {
|
|
407
|
+
/** OK */
|
|
408
|
+
204: never;
|
|
409
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
410
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
411
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
412
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
413
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
414
|
+
};
|
|
415
|
+
requestBody: {
|
|
416
|
+
content: {
|
|
417
|
+
"application/json": {
|
|
418
|
+
/**
|
|
419
|
+
* Format: uuid
|
|
420
|
+
* @description The project ID to upsert the component definition to
|
|
421
|
+
*/
|
|
422
|
+
projectId: string;
|
|
423
|
+
componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
|
424
|
+
};
|
|
425
|
+
};
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
/** Deletes a component definition */
|
|
429
|
+
delete: {
|
|
430
|
+
responses: {
|
|
431
|
+
/** OK */
|
|
432
|
+
204: never;
|
|
433
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
434
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
435
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
436
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
437
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
438
|
+
};
|
|
439
|
+
requestBody: {
|
|
440
|
+
content: {
|
|
441
|
+
"application/json": {
|
|
442
|
+
/** @description The public ID of the component definition to delete */
|
|
443
|
+
componentId: string;
|
|
444
|
+
/**
|
|
445
|
+
* Format: uuid
|
|
446
|
+
* @description The ID of the project the composition to delete belongs to
|
|
447
|
+
*/
|
|
448
|
+
projectId: string;
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
};
|
|
452
|
+
};
|
|
453
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
454
|
+
options: {
|
|
455
|
+
responses: {
|
|
456
|
+
/** OK */
|
|
457
|
+
204: never;
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
}
|
|
462
|
+
interface external$5 {
|
|
463
|
+
"swagger.yml": {
|
|
464
|
+
paths: {};
|
|
465
|
+
components: {
|
|
466
|
+
schemas: {
|
|
467
|
+
Error: {
|
|
468
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
469
|
+
errorMessage?: string[] | string;
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
responses: {
|
|
473
|
+
/** Request input validation failed */
|
|
474
|
+
BadRequestError: {
|
|
475
|
+
content: {
|
|
476
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
477
|
+
};
|
|
478
|
+
};
|
|
479
|
+
/** API key or token was not valid */
|
|
480
|
+
UnauthorizedError: {
|
|
481
|
+
content: {
|
|
482
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
483
|
+
};
|
|
484
|
+
};
|
|
485
|
+
/** Permission was denied */
|
|
486
|
+
ForbiddenError: {
|
|
487
|
+
content: {
|
|
488
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
/** Resource not found */
|
|
492
|
+
NotFoundError: {
|
|
493
|
+
content: {
|
|
494
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
495
|
+
};
|
|
496
|
+
};
|
|
497
|
+
/** Too many requests in allowed time period */
|
|
498
|
+
RateLimitError: unknown;
|
|
499
|
+
/** Execution error occurred */
|
|
500
|
+
InternalServerError: unknown;
|
|
501
|
+
};
|
|
502
|
+
};
|
|
503
|
+
operations: {};
|
|
504
|
+
};
|
|
505
|
+
"uniform-canvas-types.swagger.yml": {
|
|
506
|
+
paths: {};
|
|
507
|
+
components: {
|
|
508
|
+
schemas: {
|
|
509
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
|
510
|
+
PublicIdProperty: string;
|
|
511
|
+
/** @description The definition of a component parameter */
|
|
512
|
+
ComponentDefinitionParameter: {
|
|
513
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
514
|
+
/** @description Friendly name of the parameter */
|
|
515
|
+
name: string;
|
|
516
|
+
/** @description Appears next to the parameter in the Composition editor */
|
|
517
|
+
helpText?: string;
|
|
518
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
519
|
+
type: string;
|
|
520
|
+
/** @description The configuration object for the type (type-specific) */
|
|
521
|
+
typeConfig?: unknown;
|
|
522
|
+
};
|
|
523
|
+
/** @description The definition of a named component slot that can contain other components */
|
|
524
|
+
ComponentDefinitionSlot: {
|
|
525
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
526
|
+
/** @description Friendly name of the slot */
|
|
527
|
+
name: string;
|
|
528
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
529
|
+
allowedComponents: string[];
|
|
530
|
+
/**
|
|
531
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
532
|
+
* @default false
|
|
533
|
+
*/
|
|
534
|
+
inheritAllowedComponents: boolean;
|
|
535
|
+
/** @description Minimum valid number of components in this slot */
|
|
536
|
+
minComponents?: number;
|
|
537
|
+
/** @description Maximum valid number of components in this slot */
|
|
538
|
+
maxComponents?: number;
|
|
539
|
+
};
|
|
540
|
+
/** @description The definition of a composition's slug settings */
|
|
541
|
+
ComponentDefinitionSlugSettings: {
|
|
542
|
+
/**
|
|
543
|
+
* @description Whether the slug is required
|
|
544
|
+
* no: slug is optional
|
|
545
|
+
* yes: slug is required
|
|
546
|
+
* disabled: slug is disabled and will not be shown in the editor
|
|
547
|
+
*
|
|
548
|
+
* @default no
|
|
549
|
+
* @enum {string}
|
|
550
|
+
*/
|
|
551
|
+
required?: "no" | "yes" | "disabled";
|
|
552
|
+
/**
|
|
553
|
+
* @description Slug uniqueness configuration.
|
|
554
|
+
* no = no unique constraint
|
|
555
|
+
* local = must be unique within this component type
|
|
556
|
+
* global = must be unique across all component types
|
|
557
|
+
*
|
|
558
|
+
* @enum {string}
|
|
559
|
+
*/
|
|
560
|
+
unique?: "no" | "local" | "global";
|
|
561
|
+
/** @description Regular expression slugs must match */
|
|
562
|
+
regularExpression?: string;
|
|
563
|
+
/**
|
|
564
|
+
* @description Custom error message when regular expression validation fails.
|
|
565
|
+
* Has no effect if `regularExpression` is not set.
|
|
566
|
+
*/
|
|
567
|
+
regularExpressionMessage?: string;
|
|
568
|
+
};
|
|
569
|
+
/** @description The definition of a component variant */
|
|
570
|
+
ComponentDefinitionVariant: {
|
|
571
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
572
|
+
/** @description Friendly name of the variant */
|
|
573
|
+
name: string;
|
|
574
|
+
};
|
|
575
|
+
/** @description Permission set for a component defintion */
|
|
576
|
+
ComponentDefinitionPermission: {
|
|
577
|
+
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
578
|
+
/**
|
|
579
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
580
|
+
* read | write | create | delete
|
|
581
|
+
*
|
|
582
|
+
* @enum {string}
|
|
583
|
+
*/
|
|
584
|
+
permission: "read" | "write" | "create" | "delete";
|
|
585
|
+
/** @description State of the component that this permission applies to */
|
|
586
|
+
state: number;
|
|
587
|
+
};
|
|
588
|
+
/** @description Defines a component type that can live on a Composition */
|
|
589
|
+
ComponentDefinition: {
|
|
590
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
591
|
+
/** @description Friendly name of the component definition */
|
|
592
|
+
name: string;
|
|
593
|
+
/**
|
|
594
|
+
* @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
595
|
+
* @default screen
|
|
596
|
+
*/
|
|
597
|
+
icon?: string;
|
|
598
|
+
/**
|
|
599
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
600
|
+
* The parameter type must support being used as a title parameter for this to work.
|
|
601
|
+
*/
|
|
602
|
+
titleParameter?: string | null;
|
|
603
|
+
/**
|
|
604
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
|
605
|
+
* @default false
|
|
606
|
+
*/
|
|
607
|
+
canBeComposition?: boolean;
|
|
608
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
|
609
|
+
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
|
610
|
+
/**
|
|
611
|
+
* @description if this component uses team permissions or custom permissions
|
|
612
|
+
* @default true
|
|
613
|
+
*/
|
|
614
|
+
useTeamPermissions?: boolean;
|
|
615
|
+
/** @description Custom role permissions for this component definition */
|
|
616
|
+
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
617
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
|
618
|
+
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
|
619
|
+
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
|
620
|
+
/** @description Default component instance value */
|
|
621
|
+
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
|
622
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
|
623
|
+
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
|
624
|
+
/** @description Created date string for this definition (ignored for writes) */
|
|
625
|
+
created?: string;
|
|
626
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
|
627
|
+
updated?: string;
|
|
628
|
+
};
|
|
629
|
+
/** @description Defines an editable parameter on a component. */
|
|
630
|
+
ComponentParameter: {
|
|
631
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
|
632
|
+
value: unknown;
|
|
633
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
|
634
|
+
type: string;
|
|
635
|
+
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
|
636
|
+
};
|
|
637
|
+
/**
|
|
638
|
+
* @deprecated
|
|
639
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
|
640
|
+
*/
|
|
641
|
+
DataElementConnectionDefinition: {
|
|
642
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
|
643
|
+
pointer: string;
|
|
644
|
+
/**
|
|
645
|
+
* @description The syntax used to select the data element to bind to
|
|
646
|
+
* @enum {string}
|
|
647
|
+
*/
|
|
648
|
+
syntax: "jptr";
|
|
649
|
+
/**
|
|
650
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
|
651
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
|
652
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
|
653
|
+
*
|
|
654
|
+
* @default false
|
|
655
|
+
*/
|
|
656
|
+
required?: boolean;
|
|
657
|
+
};
|
|
658
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
|
659
|
+
ComponentInstance: {
|
|
660
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
661
|
+
type: string;
|
|
662
|
+
/** @description Component parameter values for the component instance */
|
|
663
|
+
parameters?: {
|
|
664
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
665
|
+
};
|
|
666
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
667
|
+
variant?: string;
|
|
668
|
+
/** @description Slots containing any child components */
|
|
669
|
+
slots?: {
|
|
670
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
671
|
+
};
|
|
672
|
+
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
|
673
|
+
_id?: string;
|
|
674
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
|
675
|
+
_pattern?: string;
|
|
676
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
677
|
+
/**
|
|
678
|
+
* @deprecated
|
|
679
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
|
680
|
+
* Means nothing for PUTs; it will be ignored.
|
|
681
|
+
*/
|
|
682
|
+
_patternDataResources?: {
|
|
683
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
684
|
+
};
|
|
685
|
+
/**
|
|
686
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
687
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
688
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
|
689
|
+
* Means nothing for PUTs; it will be ignored.
|
|
690
|
+
*
|
|
691
|
+
* @enum {string}
|
|
692
|
+
*/
|
|
693
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
|
694
|
+
};
|
|
695
|
+
/** @description Defines the shape of the root component in a composition */
|
|
696
|
+
RootComponentInstance: {
|
|
697
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
698
|
+
type: string;
|
|
699
|
+
/** @description Component parameter values for the component instance */
|
|
700
|
+
parameters?: {
|
|
701
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
702
|
+
};
|
|
703
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
704
|
+
variant?: string;
|
|
705
|
+
/** @description Slots containing any child components */
|
|
706
|
+
slots?: {
|
|
707
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
708
|
+
};
|
|
709
|
+
/** @description The public UUID of the composition. */
|
|
710
|
+
_id: string;
|
|
711
|
+
/** @description Slug pattern of this component. */
|
|
712
|
+
_slug?: string | null;
|
|
713
|
+
/** @description Friendly name of this component. */
|
|
714
|
+
_name: string;
|
|
715
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
716
|
+
};
|
|
717
|
+
/**
|
|
718
|
+
* @deprecated
|
|
719
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
|
720
|
+
*/
|
|
721
|
+
DataSourceInfo: {
|
|
722
|
+
/** @description Public ID of the data source */
|
|
723
|
+
id: string;
|
|
724
|
+
/** @description Display name of the data source */
|
|
725
|
+
displayName: string;
|
|
726
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
727
|
+
connectorType: string;
|
|
728
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
|
729
|
+
baseUrl: string;
|
|
730
|
+
};
|
|
731
|
+
/**
|
|
732
|
+
* @deprecated
|
|
733
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
734
|
+
*/
|
|
735
|
+
DataSource: {
|
|
736
|
+
/** @description Public ID of the data source */
|
|
737
|
+
id: string;
|
|
738
|
+
/** @description Display name of the data source */
|
|
739
|
+
displayName: string;
|
|
740
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
741
|
+
connectorType: string;
|
|
742
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
|
743
|
+
baseUrl: string;
|
|
744
|
+
headers?: {
|
|
745
|
+
[key: string]: string;
|
|
746
|
+
} | {
|
|
747
|
+
key: string;
|
|
748
|
+
value: string;
|
|
749
|
+
}[];
|
|
750
|
+
parameters?: {
|
|
751
|
+
[key: string]: string;
|
|
752
|
+
} | {
|
|
753
|
+
key: string;
|
|
754
|
+
value: string;
|
|
755
|
+
}[];
|
|
756
|
+
/** @description Variables needed to make calls to the data source */
|
|
757
|
+
variables?: {
|
|
758
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
759
|
+
};
|
|
760
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
|
761
|
+
custom?: {
|
|
762
|
+
[key: string]: unknown;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
/**
|
|
766
|
+
* @deprecated
|
|
767
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
|
768
|
+
*/
|
|
769
|
+
DataType: {
|
|
770
|
+
/** @description Public ID of the data type */
|
|
771
|
+
id: string;
|
|
772
|
+
/** @description Display name of the data type */
|
|
773
|
+
displayName: string;
|
|
774
|
+
/** @description Public ID of the associated data source */
|
|
775
|
+
dataSourceId: string;
|
|
776
|
+
/**
|
|
777
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
778
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
779
|
+
* no special UI or processing is required.
|
|
780
|
+
*/
|
|
781
|
+
archetype?: string;
|
|
782
|
+
allowedOnComponents?: string[];
|
|
783
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
784
|
+
path: string;
|
|
785
|
+
/** @description Time-to-live for the resource data cache. */
|
|
786
|
+
ttl?: number;
|
|
787
|
+
/** @description A key for the resource data cache purging. */
|
|
788
|
+
purgeKey?: string;
|
|
789
|
+
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
790
|
+
badgeIconUrl?: string;
|
|
791
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
|
792
|
+
headers?: {
|
|
793
|
+
[key: string]: string;
|
|
794
|
+
} | {
|
|
795
|
+
key: string;
|
|
796
|
+
value: string;
|
|
797
|
+
}[];
|
|
798
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
|
799
|
+
parameters?: {
|
|
800
|
+
[key: string]: string;
|
|
801
|
+
} | {
|
|
802
|
+
key: string;
|
|
803
|
+
value: string;
|
|
804
|
+
}[];
|
|
805
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
|
806
|
+
body?: string;
|
|
807
|
+
/**
|
|
808
|
+
* @description HTTP method to use with requests to the data type.
|
|
809
|
+
* @default GET
|
|
810
|
+
* @enum {string}
|
|
811
|
+
*/
|
|
812
|
+
method: "GET" | "POST" | "HEAD";
|
|
813
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
|
814
|
+
variables?: {
|
|
815
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
816
|
+
};
|
|
817
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
818
|
+
custom?: {
|
|
819
|
+
[key: string]: unknown;
|
|
820
|
+
};
|
|
821
|
+
};
|
|
822
|
+
/**
|
|
823
|
+
* @deprecated
|
|
824
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
825
|
+
*/
|
|
826
|
+
DataVariableDefinition: {
|
|
827
|
+
/** @description Display name of the data variable */
|
|
828
|
+
displayName?: string;
|
|
829
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
830
|
+
helpText?: string;
|
|
831
|
+
/**
|
|
832
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
833
|
+
* @default text
|
|
834
|
+
*/
|
|
835
|
+
type?: string;
|
|
836
|
+
/** @description Default value of the data variable */
|
|
837
|
+
default: string;
|
|
838
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
839
|
+
order?: number;
|
|
840
|
+
};
|
|
841
|
+
/**
|
|
842
|
+
* @deprecated
|
|
843
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
844
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
845
|
+
*/
|
|
846
|
+
DataResourceDefinitions: {
|
|
847
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
848
|
+
};
|
|
849
|
+
/**
|
|
850
|
+
* @deprecated
|
|
851
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
852
|
+
*/
|
|
853
|
+
DataResourceDefinition: {
|
|
854
|
+
/** @description Public ID of the data type that provides this data */
|
|
855
|
+
type: string;
|
|
856
|
+
/** @description Whether this data is a pattern parameter that has to 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. */
|
|
857
|
+
isPatternParameter?: boolean;
|
|
858
|
+
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
859
|
+
};
|
|
860
|
+
/**
|
|
861
|
+
* @deprecated
|
|
862
|
+
* @description Variable values for a data resource.
|
|
863
|
+
*/
|
|
864
|
+
DataResourceVariables: {
|
|
865
|
+
[key: string]: string;
|
|
866
|
+
};
|
|
823
867
|
};
|
|
824
868
|
};
|
|
825
|
-
|
|
826
|
-
* @deprecated
|
|
827
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
828
|
-
*/
|
|
829
|
-
DataVariableDefinition: {
|
|
830
|
-
/** @description Display name of the data variable */
|
|
831
|
-
displayName?: string;
|
|
832
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
833
|
-
helpText?: string;
|
|
834
|
-
/**
|
|
835
|
-
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
836
|
-
* @default text
|
|
837
|
-
*/
|
|
838
|
-
type?: string;
|
|
839
|
-
/** @description Default value of the data variable */
|
|
840
|
-
default: string;
|
|
841
|
-
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
842
|
-
order?: number;
|
|
843
|
-
};
|
|
844
|
-
/**
|
|
845
|
-
* @deprecated
|
|
846
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
847
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
848
|
-
*/
|
|
849
|
-
DataResourceDefinitions: {
|
|
850
|
-
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
|
851
|
-
};
|
|
852
|
-
/**
|
|
853
|
-
* @deprecated
|
|
854
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
855
|
-
*/
|
|
856
|
-
DataResourceDefinition: {
|
|
857
|
-
/** @description Public ID of the data type that provides this data */
|
|
858
|
-
type: string;
|
|
859
|
-
/** @description Whether this data is a pattern parameter that has to 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. */
|
|
860
|
-
isPatternParameter?: boolean;
|
|
861
|
-
variables?: components$2["schemas"]["DataResourceVariables"];
|
|
862
|
-
};
|
|
863
|
-
/**
|
|
864
|
-
* @deprecated
|
|
865
|
-
* @description Variable values for a data resource.
|
|
866
|
-
*/
|
|
867
|
-
DataResourceVariables: {
|
|
868
|
-
[key: string]: string;
|
|
869
|
-
};
|
|
869
|
+
operations: {};
|
|
870
870
|
};
|
|
871
871
|
}
|
|
872
872
|
|
|
@@ -2559,10 +2559,11 @@ declare type CompositionGetValidResponses = CompositionGetResponse | Composition
|
|
|
2559
2559
|
* Do not make direct changes to the file.
|
|
2560
2560
|
*/
|
|
2561
2561
|
interface paths$2 {
|
|
2562
|
-
"/api/v1/data-
|
|
2562
|
+
"/api/v1/data-source": {
|
|
2563
2563
|
get: {
|
|
2564
2564
|
parameters: {
|
|
2565
2565
|
query: {
|
|
2566
|
+
dataSourceId: string;
|
|
2566
2567
|
projectId: string;
|
|
2567
2568
|
};
|
|
2568
2569
|
};
|
|
@@ -2571,7 +2572,7 @@ interface paths$2 {
|
|
|
2571
2572
|
200: {
|
|
2572
2573
|
content: {
|
|
2573
2574
|
"application/json": {
|
|
2574
|
-
|
|
2575
|
+
result: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
|
2575
2576
|
};
|
|
2576
2577
|
};
|
|
2577
2578
|
};
|
|
@@ -2595,9 +2596,11 @@ interface paths$2 {
|
|
|
2595
2596
|
requestBody: {
|
|
2596
2597
|
content: {
|
|
2597
2598
|
"application/json": {
|
|
2598
|
-
data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
|
2599
|
+
data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
|
2599
2600
|
/** Format: uuid */
|
|
2600
2601
|
projectId: string;
|
|
2602
|
+
/** Format: uuid */
|
|
2603
|
+
integrationId: string;
|
|
2601
2604
|
};
|
|
2602
2605
|
};
|
|
2603
2606
|
};
|
|
@@ -2615,7 +2618,7 @@ interface paths$2 {
|
|
|
2615
2618
|
requestBody: {
|
|
2616
2619
|
content: {
|
|
2617
2620
|
"application/json": {
|
|
2618
|
-
|
|
2621
|
+
dataSourceId: string;
|
|
2619
2622
|
/** Format: uuid */
|
|
2620
2623
|
projectId: string;
|
|
2621
2624
|
};
|
|
@@ -3040,11 +3043,10 @@ interface external$2 {
|
|
|
3040
3043
|
* Do not make direct changes to the file.
|
|
3041
3044
|
*/
|
|
3042
3045
|
interface paths$1 {
|
|
3043
|
-
"/api/v1/data-
|
|
3046
|
+
"/api/v1/data-sources": {
|
|
3044
3047
|
get: {
|
|
3045
3048
|
parameters: {
|
|
3046
3049
|
query: {
|
|
3047
|
-
dataSourceId: string;
|
|
3048
3050
|
projectId: string;
|
|
3049
3051
|
};
|
|
3050
3052
|
};
|
|
@@ -3053,7 +3055,7 @@ interface paths$1 {
|
|
|
3053
3055
|
200: {
|
|
3054
3056
|
content: {
|
|
3055
3057
|
"application/json": {
|
|
3056
|
-
|
|
3058
|
+
results: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSourceInfo"][];
|
|
3057
3059
|
};
|
|
3058
3060
|
};
|
|
3059
3061
|
};
|
|
@@ -3064,48 +3066,6 @@ interface paths$1 {
|
|
|
3064
3066
|
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3065
3067
|
};
|
|
3066
3068
|
};
|
|
3067
|
-
put: {
|
|
3068
|
-
responses: {
|
|
3069
|
-
/** OK */
|
|
3070
|
-
204: never;
|
|
3071
|
-
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3072
|
-
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3073
|
-
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3074
|
-
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3075
|
-
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3076
|
-
};
|
|
3077
|
-
requestBody: {
|
|
3078
|
-
content: {
|
|
3079
|
-
"application/json": {
|
|
3080
|
-
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
|
3081
|
-
/** Format: uuid */
|
|
3082
|
-
projectId: string;
|
|
3083
|
-
/** Format: uuid */
|
|
3084
|
-
integrationId: string;
|
|
3085
|
-
};
|
|
3086
|
-
};
|
|
3087
|
-
};
|
|
3088
|
-
};
|
|
3089
|
-
delete: {
|
|
3090
|
-
responses: {
|
|
3091
|
-
/** OK */
|
|
3092
|
-
204: never;
|
|
3093
|
-
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3094
|
-
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3095
|
-
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3096
|
-
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3097
|
-
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3098
|
-
};
|
|
3099
|
-
requestBody: {
|
|
3100
|
-
content: {
|
|
3101
|
-
"application/json": {
|
|
3102
|
-
dataSourceId: string;
|
|
3103
|
-
/** Format: uuid */
|
|
3104
|
-
projectId: string;
|
|
3105
|
-
};
|
|
3106
|
-
};
|
|
3107
|
-
};
|
|
3108
|
-
};
|
|
3109
3069
|
};
|
|
3110
3070
|
}
|
|
3111
3071
|
interface external$1 {
|
|
@@ -3524,7 +3484,7 @@ interface external$1 {
|
|
|
3524
3484
|
* Do not make direct changes to the file.
|
|
3525
3485
|
*/
|
|
3526
3486
|
interface paths {
|
|
3527
|
-
"/api/v1/data-
|
|
3487
|
+
"/api/v1/data-types": {
|
|
3528
3488
|
get: {
|
|
3529
3489
|
parameters: {
|
|
3530
3490
|
query: {
|
|
@@ -3536,7 +3496,7 @@ interface paths {
|
|
|
3536
3496
|
200: {
|
|
3537
3497
|
content: {
|
|
3538
3498
|
"application/json": {
|
|
3539
|
-
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
|
3499
|
+
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
|
|
3540
3500
|
};
|
|
3541
3501
|
};
|
|
3542
3502
|
};
|
|
@@ -3547,6 +3507,46 @@ interface paths {
|
|
|
3547
3507
|
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3548
3508
|
};
|
|
3549
3509
|
};
|
|
3510
|
+
put: {
|
|
3511
|
+
responses: {
|
|
3512
|
+
/** OK */
|
|
3513
|
+
204: never;
|
|
3514
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3515
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3516
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3517
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3518
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3519
|
+
};
|
|
3520
|
+
requestBody: {
|
|
3521
|
+
content: {
|
|
3522
|
+
"application/json": {
|
|
3523
|
+
data: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
|
3524
|
+
/** Format: uuid */
|
|
3525
|
+
projectId: string;
|
|
3526
|
+
};
|
|
3527
|
+
};
|
|
3528
|
+
};
|
|
3529
|
+
};
|
|
3530
|
+
delete: {
|
|
3531
|
+
responses: {
|
|
3532
|
+
/** OK */
|
|
3533
|
+
204: never;
|
|
3534
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3535
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3536
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3537
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3538
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3539
|
+
};
|
|
3540
|
+
requestBody: {
|
|
3541
|
+
content: {
|
|
3542
|
+
"application/json": {
|
|
3543
|
+
typeId: string;
|
|
3544
|
+
/** Format: uuid */
|
|
3545
|
+
projectId: string;
|
|
3546
|
+
};
|
|
3547
|
+
};
|
|
3548
|
+
};
|
|
3549
|
+
};
|
|
3550
3550
|
};
|
|
3551
3551
|
}
|
|
3552
3552
|
interface external {
|
|
@@ -3960,9 +3960,9 @@ interface external {
|
|
|
3960
3960
|
};
|
|
3961
3961
|
}
|
|
3962
3962
|
|
|
3963
|
-
declare type DataTypeApi = paths
|
|
3964
|
-
declare type DataSourcesApi = paths['/api/v1/data-sources'];
|
|
3965
|
-
declare type DataSourceApi = paths$
|
|
3963
|
+
declare type DataTypeApi = paths['/api/v1/data-types'];
|
|
3964
|
+
declare type DataSourcesApi = paths$1['/api/v1/data-sources'];
|
|
3965
|
+
declare type DataSourceApi = paths$2['/api/v1/data-source'];
|
|
3966
3966
|
/** Query parameter options for GET /api/v1/data-types */
|
|
3967
3967
|
declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
|
3968
3968
|
/** The GET response from /api/v1/data-types */
|
|
@@ -4013,4 +4013,4 @@ declare global {
|
|
|
4013
4013
|
*/
|
|
4014
4014
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
|
4015
4015
|
|
|
4016
|
-
export {
|
|
4016
|
+
export { DataResourceDefinitions as $, ChannelSubscription as A, createEventBus as B, CompositionGetParameters as C, DataResolutionOptionNegative as D, ComponentDefinitionGetResponse as E, ComponentDefinitionAPIResponse as F, ComponentDefinitionAPIPutRequest as G, ComponentDefinitionAPIDeleteRequest as H, ComponentDefinitionListAPIOptions as I, ComponentDefinitionParameter as J, ComponentDefinitionVariant as K, ComponentDefinitionSlugSettings as L, ComponentDefinitionSlot as M, ComponentDefinitionPermission as N, ComponentDefinition as O, PreviewEventBus as P, CreatingComponentDefinition as Q, RootComponentInstance as R, CompositionGetOrderBy as S, CompositionUIStatus as T, CompositionGetListResponse as U, CompositionAPIResponse as V, CompositionAPIDeleteRequest as W, CompositionListAPIResponse as X, CompositionAPIOptions as Y, DataElementConnectionDefinition as Z, DataResourceVariables as _, CompositionGetByNodePathParameters as a, DataResourceDefinition as a0, CanvasDefinitions as a1, CompositionIssue as a2, CompositionPatternIssue as a3, DataElementBindingIssue as a4, DataResourceIssue as a5, DataResourceVariableIssue as a6, DataResolutionConfigIssue as a7, CompositionDataDiagnostic as a8, DataSourceGetResponse as a9, DataSourcesGetResponse as aa, DataType as ab, DataSource as ac, DataSourceInfo as ad, DataVariableDefinition as ae, CompositionGetResponse as b, DataResolutionOptionPositive as c, DataResolutionParameters as d, CompositionResolvedGetResponse as e, CompositionGetValidResponses as f, DataResolutionOption as g, CompositionGetByNodeIdParameters as h, CompositionGetBySlugParameters as i, CompositionGetByIdParameters as j, CompositionPutParameters as k, CompositionDeleteParameters as l, ComponentDefinitionGetParameters as m, ComponentDefinitionPutParameters as n, ComponentDefinitionDeleteParameters as o, ComponentInstance as p, ComponentParameter as q, components as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };
|