@uniformdev/canvas 17.2.0 → 17.2.1-alpha.201

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { C as ComponentInstance, a as ComponentParameter, c as components, b as CompositionGetParameters, d as CompositionPutParameters, e as CompositionDeleteParameters, f as ComponentDefinitionGetParameters, g as ComponentDefinitionPutParameters, h as ComponentDefinitionDeleteParameters, R as RootComponentInstance, P as PreviewEventBus, i as CompositionGetResponse } from './createEventBus-3f3f7633.js';
2
- export { H as CanvasDefinitions, I as ChannelSubscription, t as ComponentDefinition, m as ComponentDefinitionAPIDeleteRequest, l as ComponentDefinitionAPIPutRequest, k as ComponentDefinitionAPIResponse, h as ComponentDefinitionDeleteParameters, f as ComponentDefinitionGetParameters, j as ComponentDefinitionGetResponse, n as ComponentDefinitionListAPIOptions, o as ComponentDefinitionParameter, s as ComponentDefinitionPermission, g as ComponentDefinitionPutParameters, r as ComponentDefinitionSlot, q as ComponentDefinitionSlugSettings, p as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, D as ComponentParameterBinding, z as CompositionAPIDeleteRequest, B as CompositionAPIOptions, y as CompositionAPIResponse, G as CompositionDataDefinition, F as CompositionDataDefinitions, E as CompositionDataVariables, e as CompositionDeleteParameters, x as CompositionGetListResponse, v as CompositionGetOrderBy, b as CompositionGetParameters, i as CompositionGetResponse, A as CompositionListAPIResponse, d as CompositionPutParameters, w as CompositionUIStatus, u as CreatingComponentDefinition, P as PreviewEventBus, R as RootComponentInstance, J as createEventBus } from './createEventBus-3f3f7633.js';
1
+ import { C as ComponentInstance, a as ComponentParameter, b as CompositionGetParameters, c as CompositionPutParameters, d as CompositionDeleteParameters, e as ComponentDefinitionGetParameters, f as ComponentDefinitionPutParameters, g as ComponentDefinitionDeleteParameters, D as DataConnectionGetParameters, h as DataConnectionsGetParameters, i as DataConnectionPutParameters, j as DataConnectionDeleteParameters, k as DataTypeGetParameters, l as DataTypeGetResponse, m as DataTypePutParameters, n as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus, o as CompositionGetResponse } from './createEventBus-6f48d55f.js';
2
+ export { O as CanvasDefinitions, X as ChannelSubscription, z as ComponentDefinition, s as ComponentDefinitionAPIDeleteRequest, r as ComponentDefinitionAPIPutRequest, q as ComponentDefinitionAPIResponse, g as ComponentDefinitionDeleteParameters, e as ComponentDefinitionGetParameters, p as ComponentDefinitionGetResponse, t as ComponentDefinitionListAPIOptions, u as ComponentDefinitionParameter, y as ComponentDefinitionPermission, f as ComponentDefinitionPutParameters, x as ComponentDefinitionSlot, w as ComponentDefinitionSlugSettings, v as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, K as ComponentParameterBinding, H as CompositionAPIDeleteRequest, J as CompositionAPIOptions, G as CompositionAPIResponse, N as CompositionDataDefinition, M as CompositionDataDefinitions, L as CompositionDataVariables, d as CompositionDeleteParameters, F as CompositionGetListResponse, B as CompositionGetOrderBy, b as CompositionGetParameters, o as CompositionGetResponse, I as CompositionListAPIResponse, c as CompositionPutParameters, E as CompositionUIStatus, A as CreatingComponentDefinition, U as DataConnection, j as DataConnectionDeleteParameters, D as DataConnectionGetParameters, Q as DataConnectionGetResponse, V as DataConnectionInfo, i as DataConnectionPutParameters, h as DataConnectionsGetParameters, S as DataConnectionsGetResponse, T as DataType, n as DataTypeDeleteParameters, k as DataTypeGetParameters, l as DataTypeGetResponse, m as DataTypePutParameters, W as DataVariable, P as PreviewEventBus, R as RootComponentInstance, Y as createEventBus } from './createEventBus-6f48d55f.js';
3
3
  import { Options } from 'p-throttle';
4
4
  import { Options as Options$1 } from 'p-retry';
5
5
  import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
@@ -85,1395 +85,6 @@ declare type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unkn
85
85
  completeAll?: () => Promise<number>;
86
86
  };
87
87
 
88
- /**
89
- * This file was auto-generated by openapi-typescript.
90
- * Do not make direct changes to the file.
91
- */
92
- interface paths$2 {
93
- "/api/v1/data-types": {
94
- get: {
95
- parameters: {
96
- query: {
97
- projectId: string;
98
- };
99
- };
100
- responses: {
101
- /** OK */
102
- 200: {
103
- content: {
104
- "application/json": {
105
- results: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
106
- };
107
- };
108
- };
109
- 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
110
- 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
111
- 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
112
- 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
113
- 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
114
- };
115
- };
116
- put: {
117
- responses: {
118
- /** OK */
119
- 204: never;
120
- 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
121
- 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
122
- 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
123
- 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
124
- 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
125
- };
126
- requestBody: {
127
- content: {
128
- "application/json": {
129
- data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
130
- /** Format: uuid */
131
- projectId: string;
132
- };
133
- };
134
- };
135
- };
136
- delete: {
137
- responses: {
138
- /** OK */
139
- 204: never;
140
- 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
141
- 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
142
- 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
143
- 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
144
- 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
145
- };
146
- requestBody: {
147
- content: {
148
- "application/json": {
149
- typeId: string;
150
- /** Format: uuid */
151
- projectId: string;
152
- };
153
- };
154
- };
155
- };
156
- };
157
- }
158
- interface external$2 {
159
- "swagger.yml": {
160
- paths: {};
161
- components: {
162
- schemas: {
163
- Error: {
164
- /** @description Error message(s) that occurred while processing the request */
165
- errorMessage?: string[] | string;
166
- };
167
- };
168
- responses: {
169
- /** Request input validation failed */
170
- BadRequestError: {
171
- content: {
172
- "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
173
- };
174
- };
175
- /** API key or token was not valid */
176
- UnauthorizedError: {
177
- content: {
178
- "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
179
- };
180
- };
181
- /** Permission was denied */
182
- ForbiddenError: {
183
- content: {
184
- "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
185
- };
186
- };
187
- /** Resource not found */
188
- NotFoundError: {
189
- content: {
190
- "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
191
- };
192
- };
193
- /** Too many requests in allowed time period */
194
- RateLimitError: unknown;
195
- /** Execution error occurred */
196
- InternalServerError: unknown;
197
- };
198
- };
199
- operations: {};
200
- };
201
- "uniform-canvas-types.swagger.yml": {
202
- paths: {};
203
- components: {
204
- schemas: {
205
- /** @description Public ID (used in code). Do not change after creation. */
206
- PublicIdProperty: string;
207
- /** @description The definition of a component parameter */
208
- ComponentDefinitionParameter: {
209
- id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
210
- /** @description Friendly name of the parameter */
211
- name: string;
212
- /** @description Appears next to the parameter in the Composition editor */
213
- helpText?: string;
214
- /** @description Type name of the parameter (provided by a Uniform integration) */
215
- type: string;
216
- /** @description The configuration object for the type (type-specific) */
217
- typeConfig?: unknown;
218
- };
219
- /** @description The definition of a named component slot that can contain other components */
220
- ComponentDefinitionSlot: {
221
- id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
222
- /** @description Friendly name of the slot */
223
- name: string;
224
- /** @description A list of component definition public IDs that are allowed in this named slot */
225
- allowedComponents: string[];
226
- /**
227
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
228
- * @default false
229
- */
230
- inheritAllowedComponents: boolean;
231
- /** @description Minimum valid number of components in this slot */
232
- minComponents?: number;
233
- /** @description Maximum valid number of components in this slot */
234
- maxComponents?: number;
235
- };
236
- /** @description The definition of a composition's slug settings */
237
- ComponentDefinitionSlugSettings: {
238
- /**
239
- * @description Whether the slug is required
240
- * no: slug is optional
241
- * yes: slug is required
242
- * disabled: slug is disabled and will not be shown in the editor
243
- *
244
- * @default no
245
- * @enum {string}
246
- */
247
- required?: "no" | "yes" | "disabled";
248
- /**
249
- * @description Slug uniqueness configuration.
250
- * no = no unique constraint
251
- * local = must be unique within this component type
252
- * global = must be unique across all component types
253
- *
254
- * @enum {string}
255
- */
256
- unique?: "no" | "local" | "global";
257
- /** @description Regular expression slugs must match */
258
- regularExpression?: string;
259
- /**
260
- * @description Custom error message when regular expression validation fails.
261
- * Has no effect if `regularExpression` is not set.
262
- */
263
- regularExpressionMessage?: string;
264
- };
265
- /** @description The definition of a component variant */
266
- ComponentDefinitionVariant: {
267
- id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
268
- /** @description Friendly name of the variant */
269
- name: string;
270
- };
271
- /** @description Permission set for a component defintion */
272
- ComponentDefinitionPermission: {
273
- roleId: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
274
- /**
275
- * @description Permission type for this permission ComponentDefinition:
276
- * read | write | create | delete
277
- *
278
- * @enum {string}
279
- */
280
- permission: "read" | "write" | "create" | "delete";
281
- /** @description State of the component that this permission applies to */
282
- state: number;
283
- };
284
- /** @description Defines a component type that can live on a Composition */
285
- ComponentDefinition: {
286
- id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
287
- /** @description Friendly name of the component definition */
288
- name: string;
289
- /**
290
- * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
291
- * @default screen
292
- */
293
- icon?: string;
294
- /**
295
- * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
296
- * The parameter type must support being used as a title parameter for this to work.
297
- */
298
- titleParameter?: string | null;
299
- /**
300
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
301
- * @default false
302
- */
303
- canBeComposition?: boolean;
304
- /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
305
- parameters?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
306
- /**
307
- * @description if this component uses team permissions or custom permissions
308
- * @default true
309
- */
310
- useTeamPermissions?: boolean;
311
- /** @description Custom role permissions for this component definition */
312
- permissions?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
313
- /** @description The named slots for this component; placement areas where arrays of other components can be added. */
314
- slots?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
315
- slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
316
- /** @description Default component instance value */
317
- defaults?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
318
- /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
319
- variants?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
320
- /** @description Created date string for this definition (ignored for writes) */
321
- created?: string;
322
- /** @description Last modified date string for this definition (ignored for writes) */
323
- updated?: string;
324
- };
325
- /** @description Defines an editable parameter on a component. */
326
- ComponentParameter: {
327
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
328
- value: unknown;
329
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
330
- type: string;
331
- binding?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
332
- };
333
- /**
334
- * @deprecated
335
- * @description Defines a binding from a resource data value to a component parameter value. Do not use.
336
- */
337
- ComponentParameterBinding: {
338
- /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
339
- pointer: string;
340
- /**
341
- * @description The syntax of the binding (currently always 'jptr')
342
- * @enum {string}
343
- */
344
- syntax: "jptr";
345
- /**
346
- * @description Whether the binding should cause an error if it cannot be resolved.
347
- * If true, and the binding cannot be resolved, an error will be returned by the binding process.
348
- * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
349
- *
350
- * @default false
351
- */
352
- required?: boolean;
353
- };
354
- /** @description Defines the shape of a component instance served by the composition API. */
355
- ComponentInstance: {
356
- /** @description Type of the component instance (public_id of its definition) */
357
- type: string;
358
- /** @description Component parameter values for the component instance */
359
- parameters?: {
360
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
361
- };
362
- /** @description Public ID of alternate visual appearance for this component, if any selected */
363
- variant?: string;
364
- /** @description Slots containing any child components */
365
- slots?: {
366
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
367
- };
368
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
369
- _id?: string;
370
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
371
- _pattern?: string;
372
- _data?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
373
- /**
374
- * @deprecated
375
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
376
- * Means nothing for PUTs; it will be ignored.
377
- */
378
- _patternData?: {
379
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
380
- };
381
- /**
382
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
383
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
384
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
385
- * Means nothing for PUTs; it will be ignored.
386
- *
387
- * @enum {string}
388
- */
389
- _patternError?: "NOTFOUND" | "CYCLIC";
390
- };
391
- /** @description Defines the shape of the root component in a composition */
392
- RootComponentInstance: {
393
- /** @description Type of the component instance (public_id of its definition) */
394
- type: string;
395
- /** @description Component parameter values for the component instance */
396
- parameters?: {
397
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
398
- };
399
- /** @description Public ID of alternate visual appearance for this component, if any selected */
400
- variant?: string;
401
- /** @description Slots containing any child components */
402
- slots?: {
403
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
404
- };
405
- /** @description The public UUID of the composition. */
406
- _id: string;
407
- /** @description Slug pattern of this component. */
408
- _slug?: string | null;
409
- /** @description Friendly name of this component. */
410
- _name: string;
411
- _data?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
412
- };
413
- /**
414
- * @deprecated
415
- * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
416
- */
417
- DataConnectionInfo: {
418
- /** @description Public ID of the data connector */
419
- id: string;
420
- /** @description Display name of the data connector */
421
- displayName: string;
422
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
423
- connectorType: string;
424
- /** @description Base resource URL of the data connector. No trailing slash. */
425
- baseUrl?: string;
426
- };
427
- /**
428
- * @deprecated
429
- * @description An instance of an integration data connector (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.
430
- */
431
- DataConnection: {
432
- /** @description Public ID of the data connection */
433
- id: string;
434
- /** @description Display name of the data connection */
435
- displayName: string;
436
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
437
- connectorType: string;
438
- /** @description Base resource URL of the data connection. No trailing slash. */
439
- baseUrl: string;
440
- /** @description HTTP headers to pass with requests to the data connection */
441
- headers?: {
442
- [key: string]: string;
443
- };
444
- /** @description Query String parameters to pass with requests to the data connection */
445
- parameters?: {
446
- [key: string]: string;
447
- };
448
- /** @description Variables needed to make calls to the data connection */
449
- variables?: {
450
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
451
- };
452
- /** @description Custom configuration specific to the data connection being defined */
453
- custom?: {
454
- [key: string]: unknown;
455
- };
456
- };
457
- /**
458
- * @deprecated
459
- * @description A specific type of data that a Data Connection 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.
460
- */
461
- DataType: {
462
- /** @description Public ID of the data type */
463
- id: string;
464
- /** @description Display name of the data type */
465
- displayName: string;
466
- /** @description Public ID of the associated data connection */
467
- connectionId: string;
468
- /**
469
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
470
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
471
- * no special UI or processing is required.
472
- */
473
- archetype?: string;
474
- allowedOnComponents?: string[];
475
- /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
476
- path: string;
477
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
478
- headers?: {
479
- [key: string]: string;
480
- };
481
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
482
- parameters?: {
483
- [key: string]: string;
484
- };
485
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
486
- body?: string;
487
- /**
488
- * @description HTTP method to use with requests to the data type.
489
- * @default GET
490
- * @enum {string}
491
- */
492
- method: "GET" | "POST" | "HEAD";
493
- /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
494
- variables?: {
495
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
496
- };
497
- /** @description Custom configuration specific to the data connection being defined */
498
- custom?: {
499
- [key: string]: unknown;
500
- };
501
- };
502
- /**
503
- * @deprecated
504
- * @description Defines the shape of a data variable on a Data Connector or Data Type
505
- */
506
- DataVariable: {
507
- /** @description Display name of the data variable */
508
- displayName?: string;
509
- /**
510
- * @description Type of the data variable
511
- * @default text
512
- */
513
- type: string;
514
- /** @description Default value of the data variable */
515
- default: string;
516
- /**
517
- * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
518
- * @enum {string}
519
- */
520
- setBy: "static" | "dynamic";
521
- };
522
- /**
523
- * @deprecated
524
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
525
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
526
- */
527
- CompositionDataDefinitions: {
528
- [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
529
- };
530
- /**
531
- * @deprecated
532
- * @description Data definition attached to this component
533
- */
534
- CompositionDataDefinition: {
535
- /** @description Public ID of the data type that provides this data */
536
- type: string;
537
- /** @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. */
538
- isPatternParameter?: boolean;
539
- variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
540
- };
541
- /**
542
- * @deprecated
543
- * @description Static variable values for this composition.
544
- */
545
- CompositionDataVariables: {
546
- [key: string]: string;
547
- };
548
- };
549
- };
550
- operations: {};
551
- };
552
- }
553
-
554
- /**
555
- * This file was auto-generated by openapi-typescript.
556
- * Do not make direct changes to the file.
557
- */
558
- interface paths$1 {
559
- "/api/v1/data-connection": {
560
- get: {
561
- parameters: {
562
- query: {
563
- dataConnectionId: string;
564
- projectId: string;
565
- };
566
- };
567
- responses: {
568
- /** OK */
569
- 200: {
570
- content: {
571
- "application/json": {
572
- result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnection"];
573
- };
574
- };
575
- };
576
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
577
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
578
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
579
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
580
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
581
- };
582
- };
583
- put: {
584
- responses: {
585
- /** OK */
586
- 204: never;
587
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
588
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
589
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
590
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
591
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
592
- };
593
- requestBody: {
594
- content: {
595
- "application/json": {
596
- data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnection"];
597
- /** Format: uuid */
598
- projectId: string;
599
- /** Format: uuid */
600
- integrationId: string;
601
- };
602
- };
603
- };
604
- };
605
- delete: {
606
- responses: {
607
- /** OK */
608
- 204: never;
609
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
610
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
611
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
612
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
613
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
614
- };
615
- requestBody: {
616
- content: {
617
- "application/json": {
618
- connectionId: string;
619
- /** Format: uuid */
620
- projectId: string;
621
- };
622
- };
623
- };
624
- };
625
- };
626
- }
627
- interface external$1 {
628
- "swagger.yml": {
629
- paths: {};
630
- components: {
631
- schemas: {
632
- Error: {
633
- /** @description Error message(s) that occurred while processing the request */
634
- errorMessage?: string[] | string;
635
- };
636
- };
637
- responses: {
638
- /** Request input validation failed */
639
- BadRequestError: {
640
- content: {
641
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
642
- };
643
- };
644
- /** API key or token was not valid */
645
- UnauthorizedError: {
646
- content: {
647
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
648
- };
649
- };
650
- /** Permission was denied */
651
- ForbiddenError: {
652
- content: {
653
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
654
- };
655
- };
656
- /** Resource not found */
657
- NotFoundError: {
658
- content: {
659
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
660
- };
661
- };
662
- /** Too many requests in allowed time period */
663
- RateLimitError: unknown;
664
- /** Execution error occurred */
665
- InternalServerError: unknown;
666
- };
667
- };
668
- operations: {};
669
- };
670
- "uniform-canvas-types.swagger.yml": {
671
- paths: {};
672
- components: {
673
- schemas: {
674
- /** @description Public ID (used in code). Do not change after creation. */
675
- PublicIdProperty: string;
676
- /** @description The definition of a component parameter */
677
- ComponentDefinitionParameter: {
678
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
679
- /** @description Friendly name of the parameter */
680
- name: string;
681
- /** @description Appears next to the parameter in the Composition editor */
682
- helpText?: string;
683
- /** @description Type name of the parameter (provided by a Uniform integration) */
684
- type: string;
685
- /** @description The configuration object for the type (type-specific) */
686
- typeConfig?: unknown;
687
- };
688
- /** @description The definition of a named component slot that can contain other components */
689
- ComponentDefinitionSlot: {
690
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
691
- /** @description Friendly name of the slot */
692
- name: string;
693
- /** @description A list of component definition public IDs that are allowed in this named slot */
694
- allowedComponents: string[];
695
- /**
696
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
697
- * @default false
698
- */
699
- inheritAllowedComponents: boolean;
700
- /** @description Minimum valid number of components in this slot */
701
- minComponents?: number;
702
- /** @description Maximum valid number of components in this slot */
703
- maxComponents?: number;
704
- };
705
- /** @description The definition of a composition's slug settings */
706
- ComponentDefinitionSlugSettings: {
707
- /**
708
- * @description Whether the slug is required
709
- * no: slug is optional
710
- * yes: slug is required
711
- * disabled: slug is disabled and will not be shown in the editor
712
- *
713
- * @default no
714
- * @enum {string}
715
- */
716
- required?: "no" | "yes" | "disabled";
717
- /**
718
- * @description Slug uniqueness configuration.
719
- * no = no unique constraint
720
- * local = must be unique within this component type
721
- * global = must be unique across all component types
722
- *
723
- * @enum {string}
724
- */
725
- unique?: "no" | "local" | "global";
726
- /** @description Regular expression slugs must match */
727
- regularExpression?: string;
728
- /**
729
- * @description Custom error message when regular expression validation fails.
730
- * Has no effect if `regularExpression` is not set.
731
- */
732
- regularExpressionMessage?: string;
733
- };
734
- /** @description The definition of a component variant */
735
- ComponentDefinitionVariant: {
736
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
737
- /** @description Friendly name of the variant */
738
- name: string;
739
- };
740
- /** @description Permission set for a component defintion */
741
- ComponentDefinitionPermission: {
742
- roleId: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
743
- /**
744
- * @description Permission type for this permission ComponentDefinition:
745
- * read | write | create | delete
746
- *
747
- * @enum {string}
748
- */
749
- permission: "read" | "write" | "create" | "delete";
750
- /** @description State of the component that this permission applies to */
751
- state: number;
752
- };
753
- /** @description Defines a component type that can live on a Composition */
754
- ComponentDefinition: {
755
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
756
- /** @description Friendly name of the component definition */
757
- name: string;
758
- /**
759
- * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
760
- * @default screen
761
- */
762
- icon?: string;
763
- /**
764
- * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
765
- * The parameter type must support being used as a title parameter for this to work.
766
- */
767
- titleParameter?: string | null;
768
- /**
769
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
770
- * @default false
771
- */
772
- canBeComposition?: boolean;
773
- /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
774
- parameters?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
775
- /**
776
- * @description if this component uses team permissions or custom permissions
777
- * @default true
778
- */
779
- useTeamPermissions?: boolean;
780
- /** @description Custom role permissions for this component definition */
781
- permissions?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
782
- /** @description The named slots for this component; placement areas where arrays of other components can be added. */
783
- slots?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
784
- slugSettings?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
785
- /** @description Default component instance value */
786
- defaults?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
787
- /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
788
- variants?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
789
- /** @description Created date string for this definition (ignored for writes) */
790
- created?: string;
791
- /** @description Last modified date string for this definition (ignored for writes) */
792
- updated?: string;
793
- };
794
- /** @description Defines an editable parameter on a component. */
795
- ComponentParameter: {
796
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
797
- value: unknown;
798
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
799
- type: string;
800
- binding?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
801
- };
802
- /**
803
- * @deprecated
804
- * @description Defines a binding from a resource data value to a component parameter value. Do not use.
805
- */
806
- ComponentParameterBinding: {
807
- /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
808
- pointer: string;
809
- /**
810
- * @description The syntax of the binding (currently always 'jptr')
811
- * @enum {string}
812
- */
813
- syntax: "jptr";
814
- /**
815
- * @description Whether the binding should cause an error if it cannot be resolved.
816
- * If true, and the binding cannot be resolved, an error will be returned by the binding process.
817
- * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
818
- *
819
- * @default false
820
- */
821
- required?: boolean;
822
- };
823
- /** @description Defines the shape of a component instance served by the composition API. */
824
- ComponentInstance: {
825
- /** @description Type of the component instance (public_id of its definition) */
826
- type: string;
827
- /** @description Component parameter values for the component instance */
828
- parameters?: {
829
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
830
- };
831
- /** @description Public ID of alternate visual appearance for this component, if any selected */
832
- variant?: string;
833
- /** @description Slots containing any child components */
834
- slots?: {
835
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
836
- };
837
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
838
- _id?: string;
839
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
840
- _pattern?: string;
841
- _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
842
- /**
843
- * @deprecated
844
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
845
- * Means nothing for PUTs; it will be ignored.
846
- */
847
- _patternData?: {
848
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
849
- };
850
- /**
851
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
852
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
853
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
854
- * Means nothing for PUTs; it will be ignored.
855
- *
856
- * @enum {string}
857
- */
858
- _patternError?: "NOTFOUND" | "CYCLIC";
859
- };
860
- /** @description Defines the shape of the root component in a composition */
861
- RootComponentInstance: {
862
- /** @description Type of the component instance (public_id of its definition) */
863
- type: string;
864
- /** @description Component parameter values for the component instance */
865
- parameters?: {
866
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
867
- };
868
- /** @description Public ID of alternate visual appearance for this component, if any selected */
869
- variant?: string;
870
- /** @description Slots containing any child components */
871
- slots?: {
872
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
873
- };
874
- /** @description The public UUID of the composition. */
875
- _id: string;
876
- /** @description Slug pattern of this component. */
877
- _slug?: string | null;
878
- /** @description Friendly name of this component. */
879
- _name: string;
880
- _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
881
- };
882
- /**
883
- * @deprecated
884
- * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
885
- */
886
- DataConnectionInfo: {
887
- /** @description Public ID of the data connector */
888
- id: string;
889
- /** @description Display name of the data connector */
890
- displayName: string;
891
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
892
- connectorType: string;
893
- /** @description Base resource URL of the data connector. No trailing slash. */
894
- baseUrl?: string;
895
- };
896
- /**
897
- * @deprecated
898
- * @description An instance of an integration data connector (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.
899
- */
900
- DataConnection: {
901
- /** @description Public ID of the data connection */
902
- id: string;
903
- /** @description Display name of the data connection */
904
- displayName: string;
905
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
906
- connectorType: string;
907
- /** @description Base resource URL of the data connection. No trailing slash. */
908
- baseUrl: string;
909
- /** @description HTTP headers to pass with requests to the data connection */
910
- headers?: {
911
- [key: string]: string;
912
- };
913
- /** @description Query String parameters to pass with requests to the data connection */
914
- parameters?: {
915
- [key: string]: string;
916
- };
917
- /** @description Variables needed to make calls to the data connection */
918
- variables?: {
919
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
920
- };
921
- /** @description Custom configuration specific to the data connection being defined */
922
- custom?: {
923
- [key: string]: unknown;
924
- };
925
- };
926
- /**
927
- * @deprecated
928
- * @description A specific type of data that a Data Connection 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.
929
- */
930
- DataType: {
931
- /** @description Public ID of the data type */
932
- id: string;
933
- /** @description Display name of the data type */
934
- displayName: string;
935
- /** @description Public ID of the associated data connection */
936
- connectionId: string;
937
- /**
938
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
939
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
940
- * no special UI or processing is required.
941
- */
942
- archetype?: string;
943
- allowedOnComponents?: string[];
944
- /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
945
- path: string;
946
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
947
- headers?: {
948
- [key: string]: string;
949
- };
950
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
951
- parameters?: {
952
- [key: string]: string;
953
- };
954
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
955
- body?: string;
956
- /**
957
- * @description HTTP method to use with requests to the data type.
958
- * @default GET
959
- * @enum {string}
960
- */
961
- method: "GET" | "POST" | "HEAD";
962
- /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
963
- variables?: {
964
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
965
- };
966
- /** @description Custom configuration specific to the data connection being defined */
967
- custom?: {
968
- [key: string]: unknown;
969
- };
970
- };
971
- /**
972
- * @deprecated
973
- * @description Defines the shape of a data variable on a Data Connector or Data Type
974
- */
975
- DataVariable: {
976
- /** @description Display name of the data variable */
977
- displayName?: string;
978
- /**
979
- * @description Type of the data variable
980
- * @default text
981
- */
982
- type: string;
983
- /** @description Default value of the data variable */
984
- default: string;
985
- /**
986
- * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
987
- * @enum {string}
988
- */
989
- setBy: "static" | "dynamic";
990
- };
991
- /**
992
- * @deprecated
993
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
994
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
995
- */
996
- CompositionDataDefinitions: {
997
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
998
- };
999
- /**
1000
- * @deprecated
1001
- * @description Data definition attached to this component
1002
- */
1003
- CompositionDataDefinition: {
1004
- /** @description Public ID of the data type that provides this data */
1005
- type: string;
1006
- /** @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. */
1007
- isPatternParameter?: boolean;
1008
- variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
1009
- };
1010
- /**
1011
- * @deprecated
1012
- * @description Static variable values for this composition.
1013
- */
1014
- CompositionDataVariables: {
1015
- [key: string]: string;
1016
- };
1017
- };
1018
- };
1019
- operations: {};
1020
- };
1021
- }
1022
-
1023
- /**
1024
- * This file was auto-generated by openapi-typescript.
1025
- * Do not make direct changes to the file.
1026
- */
1027
- interface paths {
1028
- "/api/v1/data-connections": {
1029
- get: {
1030
- parameters: {
1031
- query: {
1032
- projectId: string;
1033
- };
1034
- };
1035
- responses: {
1036
- /** OK */
1037
- 200: {
1038
- content: {
1039
- "application/json": {
1040
- results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnectionInfo"][];
1041
- };
1042
- };
1043
- };
1044
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1045
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1046
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1047
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1048
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1049
- };
1050
- };
1051
- };
1052
- }
1053
- interface external {
1054
- "swagger.yml": {
1055
- paths: {};
1056
- components: {
1057
- schemas: {
1058
- Error: {
1059
- /** @description Error message(s) that occurred while processing the request */
1060
- errorMessage?: string[] | string;
1061
- };
1062
- };
1063
- responses: {
1064
- /** Request input validation failed */
1065
- BadRequestError: {
1066
- content: {
1067
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1068
- };
1069
- };
1070
- /** API key or token was not valid */
1071
- UnauthorizedError: {
1072
- content: {
1073
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1074
- };
1075
- };
1076
- /** Permission was denied */
1077
- ForbiddenError: {
1078
- content: {
1079
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1080
- };
1081
- };
1082
- /** Resource not found */
1083
- NotFoundError: {
1084
- content: {
1085
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1086
- };
1087
- };
1088
- /** Too many requests in allowed time period */
1089
- RateLimitError: unknown;
1090
- /** Execution error occurred */
1091
- InternalServerError: unknown;
1092
- };
1093
- };
1094
- operations: {};
1095
- };
1096
- "uniform-canvas-types.swagger.yml": {
1097
- paths: {};
1098
- components: {
1099
- schemas: {
1100
- /** @description Public ID (used in code). Do not change after creation. */
1101
- PublicIdProperty: string;
1102
- /** @description The definition of a component parameter */
1103
- ComponentDefinitionParameter: {
1104
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1105
- /** @description Friendly name of the parameter */
1106
- name: string;
1107
- /** @description Appears next to the parameter in the Composition editor */
1108
- helpText?: string;
1109
- /** @description Type name of the parameter (provided by a Uniform integration) */
1110
- type: string;
1111
- /** @description The configuration object for the type (type-specific) */
1112
- typeConfig?: unknown;
1113
- };
1114
- /** @description The definition of a named component slot that can contain other components */
1115
- ComponentDefinitionSlot: {
1116
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1117
- /** @description Friendly name of the slot */
1118
- name: string;
1119
- /** @description A list of component definition public IDs that are allowed in this named slot */
1120
- allowedComponents: string[];
1121
- /**
1122
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
1123
- * @default false
1124
- */
1125
- inheritAllowedComponents: boolean;
1126
- /** @description Minimum valid number of components in this slot */
1127
- minComponents?: number;
1128
- /** @description Maximum valid number of components in this slot */
1129
- maxComponents?: number;
1130
- };
1131
- /** @description The definition of a composition's slug settings */
1132
- ComponentDefinitionSlugSettings: {
1133
- /**
1134
- * @description Whether the slug is required
1135
- * no: slug is optional
1136
- * yes: slug is required
1137
- * disabled: slug is disabled and will not be shown in the editor
1138
- *
1139
- * @default no
1140
- * @enum {string}
1141
- */
1142
- required?: "no" | "yes" | "disabled";
1143
- /**
1144
- * @description Slug uniqueness configuration.
1145
- * no = no unique constraint
1146
- * local = must be unique within this component type
1147
- * global = must be unique across all component types
1148
- *
1149
- * @enum {string}
1150
- */
1151
- unique?: "no" | "local" | "global";
1152
- /** @description Regular expression slugs must match */
1153
- regularExpression?: string;
1154
- /**
1155
- * @description Custom error message when regular expression validation fails.
1156
- * Has no effect if `regularExpression` is not set.
1157
- */
1158
- regularExpressionMessage?: string;
1159
- };
1160
- /** @description The definition of a component variant */
1161
- ComponentDefinitionVariant: {
1162
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1163
- /** @description Friendly name of the variant */
1164
- name: string;
1165
- };
1166
- /** @description Permission set for a component defintion */
1167
- ComponentDefinitionPermission: {
1168
- roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1169
- /**
1170
- * @description Permission type for this permission ComponentDefinition:
1171
- * read | write | create | delete
1172
- *
1173
- * @enum {string}
1174
- */
1175
- permission: "read" | "write" | "create" | "delete";
1176
- /** @description State of the component that this permission applies to */
1177
- state: number;
1178
- };
1179
- /** @description Defines a component type that can live on a Composition */
1180
- ComponentDefinition: {
1181
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1182
- /** @description Friendly name of the component definition */
1183
- name: string;
1184
- /**
1185
- * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
1186
- * @default screen
1187
- */
1188
- icon?: string;
1189
- /**
1190
- * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
1191
- * The parameter type must support being used as a title parameter for this to work.
1192
- */
1193
- titleParameter?: string | null;
1194
- /**
1195
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
1196
- * @default false
1197
- */
1198
- canBeComposition?: boolean;
1199
- /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
1200
- parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1201
- /**
1202
- * @description if this component uses team permissions or custom permissions
1203
- * @default true
1204
- */
1205
- useTeamPermissions?: boolean;
1206
- /** @description Custom role permissions for this component definition */
1207
- permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1208
- /** @description The named slots for this component; placement areas where arrays of other components can be added. */
1209
- slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1210
- slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1211
- /** @description Default component instance value */
1212
- defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1213
- /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
1214
- variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1215
- /** @description Created date string for this definition (ignored for writes) */
1216
- created?: string;
1217
- /** @description Last modified date string for this definition (ignored for writes) */
1218
- updated?: string;
1219
- };
1220
- /** @description Defines an editable parameter on a component. */
1221
- ComponentParameter: {
1222
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
1223
- value: unknown;
1224
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
1225
- type: string;
1226
- binding?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
1227
- };
1228
- /**
1229
- * @deprecated
1230
- * @description Defines a binding from a resource data value to a component parameter value. Do not use.
1231
- */
1232
- ComponentParameterBinding: {
1233
- /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
1234
- pointer: string;
1235
- /**
1236
- * @description The syntax of the binding (currently always 'jptr')
1237
- * @enum {string}
1238
- */
1239
- syntax: "jptr";
1240
- /**
1241
- * @description Whether the binding should cause an error if it cannot be resolved.
1242
- * If true, and the binding cannot be resolved, an error will be returned by the binding process.
1243
- * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
1244
- *
1245
- * @default false
1246
- */
1247
- required?: boolean;
1248
- };
1249
- /** @description Defines the shape of a component instance served by the composition API. */
1250
- ComponentInstance: {
1251
- /** @description Type of the component instance (public_id of its definition) */
1252
- type: string;
1253
- /** @description Component parameter values for the component instance */
1254
- parameters?: {
1255
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1256
- };
1257
- /** @description Public ID of alternate visual appearance for this component, if any selected */
1258
- variant?: string;
1259
- /** @description Slots containing any child components */
1260
- slots?: {
1261
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1262
- };
1263
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
1264
- _id?: string;
1265
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1266
- _pattern?: string;
1267
- _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1268
- /**
1269
- * @deprecated
1270
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
1271
- * Means nothing for PUTs; it will be ignored.
1272
- */
1273
- _patternData?: {
1274
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1275
- };
1276
- /**
1277
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
1278
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
1279
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
1280
- * Means nothing for PUTs; it will be ignored.
1281
- *
1282
- * @enum {string}
1283
- */
1284
- _patternError?: "NOTFOUND" | "CYCLIC";
1285
- };
1286
- /** @description Defines the shape of the root component in a composition */
1287
- RootComponentInstance: {
1288
- /** @description Type of the component instance (public_id of its definition) */
1289
- type: string;
1290
- /** @description Component parameter values for the component instance */
1291
- parameters?: {
1292
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1293
- };
1294
- /** @description Public ID of alternate visual appearance for this component, if any selected */
1295
- variant?: string;
1296
- /** @description Slots containing any child components */
1297
- slots?: {
1298
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1299
- };
1300
- /** @description The public UUID of the composition. */
1301
- _id: string;
1302
- /** @description Slug pattern of this component. */
1303
- _slug?: string | null;
1304
- /** @description Friendly name of this component. */
1305
- _name: string;
1306
- _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1307
- };
1308
- /**
1309
- * @deprecated
1310
- * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
1311
- */
1312
- DataConnectionInfo: {
1313
- /** @description Public ID of the data connector */
1314
- id: string;
1315
- /** @description Display name of the data connector */
1316
- displayName: string;
1317
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1318
- connectorType: string;
1319
- /** @description Base resource URL of the data connector. No trailing slash. */
1320
- baseUrl?: string;
1321
- };
1322
- /**
1323
- * @deprecated
1324
- * @description An instance of an integration data connector (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.
1325
- */
1326
- DataConnection: {
1327
- /** @description Public ID of the data connection */
1328
- id: string;
1329
- /** @description Display name of the data connection */
1330
- displayName: string;
1331
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1332
- connectorType: string;
1333
- /** @description Base resource URL of the data connection. No trailing slash. */
1334
- baseUrl: string;
1335
- /** @description HTTP headers to pass with requests to the data connection */
1336
- headers?: {
1337
- [key: string]: string;
1338
- };
1339
- /** @description Query String parameters to pass with requests to the data connection */
1340
- parameters?: {
1341
- [key: string]: string;
1342
- };
1343
- /** @description Variables needed to make calls to the data connection */
1344
- variables?: {
1345
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1346
- };
1347
- /** @description Custom configuration specific to the data connection being defined */
1348
- custom?: {
1349
- [key: string]: unknown;
1350
- };
1351
- };
1352
- /**
1353
- * @deprecated
1354
- * @description A specific type of data that a Data Connection 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.
1355
- */
1356
- DataType: {
1357
- /** @description Public ID of the data type */
1358
- id: string;
1359
- /** @description Display name of the data type */
1360
- displayName: string;
1361
- /** @description Public ID of the associated data connection */
1362
- connectionId: string;
1363
- /**
1364
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
1365
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
1366
- * no special UI or processing is required.
1367
- */
1368
- archetype?: string;
1369
- allowedOnComponents?: string[];
1370
- /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
1371
- path: string;
1372
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
1373
- headers?: {
1374
- [key: string]: string;
1375
- };
1376
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
1377
- parameters?: {
1378
- [key: string]: string;
1379
- };
1380
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
1381
- body?: string;
1382
- /**
1383
- * @description HTTP method to use with requests to the data type.
1384
- * @default GET
1385
- * @enum {string}
1386
- */
1387
- method: "GET" | "POST" | "HEAD";
1388
- /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
1389
- variables?: {
1390
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1391
- };
1392
- /** @description Custom configuration specific to the data connection being defined */
1393
- custom?: {
1394
- [key: string]: unknown;
1395
- };
1396
- };
1397
- /**
1398
- * @deprecated
1399
- * @description Defines the shape of a data variable on a Data Connector or Data Type
1400
- */
1401
- DataVariable: {
1402
- /** @description Display name of the data variable */
1403
- displayName?: string;
1404
- /**
1405
- * @description Type of the data variable
1406
- * @default text
1407
- */
1408
- type: string;
1409
- /** @description Default value of the data variable */
1410
- default: string;
1411
- /**
1412
- * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
1413
- * @enum {string}
1414
- */
1415
- setBy: "static" | "dynamic";
1416
- };
1417
- /**
1418
- * @deprecated
1419
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
1420
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1421
- */
1422
- CompositionDataDefinitions: {
1423
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1424
- };
1425
- /**
1426
- * @deprecated
1427
- * @description Data definition attached to this component
1428
- */
1429
- CompositionDataDefinition: {
1430
- /** @description Public ID of the data type that provides this data */
1431
- type: string;
1432
- /** @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. */
1433
- isPatternParameter?: boolean;
1434
- variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
1435
- };
1436
- /**
1437
- * @deprecated
1438
- * @description Static variable values for this composition.
1439
- */
1440
- CompositionDataVariables: {
1441
- [key: string]: string;
1442
- };
1443
- };
1444
- };
1445
- operations: {};
1446
- };
1447
- }
1448
-
1449
- declare type DataTypeApi = paths$2['/api/v1/data-types'];
1450
- declare type DataConnectionsApi = paths['/api/v1/data-connections'];
1451
- declare type DataConnectionApi = paths$1['/api/v1/data-connection'];
1452
- /** Query parameter options for GET /api/v1/data-types */
1453
- declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
1454
- /** The GET response from /api/v1/data-types */
1455
- declare type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
1456
- /** The PUT request body for /api/v1/data-types */
1457
- declare type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
1458
- /** Shape of the DELETE request body for /api/v1/data-types */
1459
- declare type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
1460
- /** Query parameter options for GET /api/v1/data-connection */
1461
- declare type DataConnectionGetParameters = DataConnectionApi['get']['parameters']['query'];
1462
- /** Query parameter options for GET /api/v1/data-connections */
1463
- declare type DataConnectionsGetParameters = DataConnectionsApi['get']['parameters']['query'];
1464
- /** The GET response from /api/v1/data-connections */
1465
- declare type DataConnectionGetResponse = DataConnectionApi['get']['responses']['200']['content']['application/json'];
1466
- /** The GET response from /api/v1/data-connections */
1467
- declare type DataConnectionsGetResponse = DataConnectionsApi['get']['responses']['200']['content']['application/json'];
1468
- /** The PUT request body for /api/v1/data-connection */
1469
- declare type DataConnectionPutParameters = DataConnectionApi['put']['requestBody']['content']['application/json'];
1470
- /** Shape of the DELETE request body for /api/v1/data-connection */
1471
- declare type DataConnectionDeleteParameters = DataConnectionApi['delete']['requestBody']['content']['application/json'];
1472
- declare type DataType = components['schemas']['DataType'];
1473
- declare type DataConnection = components['schemas']['DataConnection'];
1474
- declare type DataConnectionInfo = components['schemas']['DataConnectionInfo'];
1475
- declare type DataVariable = components['schemas']['DataVariable'];
1476
-
1477
88
  declare type ComponentLocationReference = {
1478
89
  component: ComponentInstance;
1479
90
  parentSlot?: string;
@@ -1732,9 +343,10 @@ declare class CanvasClient extends ApiClient<ClientOptions> {
1732
343
  } | undefined;
1733
344
  };
1734
345
  }[];
346
+ totalCount?: number | undefined;
1735
347
  }>;
1736
348
  /** Fetches a Canvas composition by string name (slug) */
1737
- getCompositionBySlug(options: Pick<CompositionGetParameters, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus'>): Promise<{
349
+ getCompositionBySlug(options: Pick<CompositionGetParameters, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>): Promise<{
1738
350
  state: number;
1739
351
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
1740
352
  projectId: string;
@@ -1811,7 +423,7 @@ declare class CanvasClient extends ApiClient<ClientOptions> {
1811
423
  };
1812
424
  }>;
1813
425
  /** Fetches a Canvas composition by its public UUID */
1814
- getCompositionById(options: Pick<CompositionGetParameters, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus'>): Promise<{
426
+ getCompositionById(options: Pick<CompositionGetParameters, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>): Promise<{
1815
427
  state: number;
1816
428
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
1817
429
  projectId: string;
@@ -1985,7 +597,7 @@ declare class UncachedCanvasClient extends CanvasClient {
1985
597
  /**
1986
598
  * @deprecated
1987
599
  */
1988
- declare class CanvasDataConnectionClient extends ApiClient {
600
+ declare class DataConnectionClient extends ApiClient {
1989
601
  constructor(options: ClientOptions);
1990
602
  /** Fetches all DataConnections for a project */
1991
603
  get(options?: ExceptProject<DataConnectionGetParameters>): Promise<{
@@ -2019,7 +631,7 @@ declare class CanvasDataConnectionClient extends ApiClient {
2019
631
  id: string;
2020
632
  displayName: string;
2021
633
  connectorType: string;
2022
- baseUrl?: string | undefined;
634
+ baseUrl: string;
2023
635
  }[];
2024
636
  }>;
2025
637
  /** Updates or creates (based on id) a DataConnection */
@@ -2031,7 +643,7 @@ declare class CanvasDataConnectionClient extends ApiClient {
2031
643
  /**
2032
644
  * @deprecated
2033
645
  */
2034
- declare class CanvasDataTypeClient extends ApiClient {
646
+ declare class DataTypeClient extends ApiClient {
2035
647
  #private;
2036
648
  constructor(options: ClientOptions);
2037
649
  /** Fetches all DataTypes for a project */
@@ -2250,4 +862,4 @@ declare class EdgeCanvasClient extends ApiClient<ClientOptions> {
2250
862
 
2251
863
  declare const CanvasClientError: typeof ApiClientError;
2252
864
 
2253
- export { AddComponentMessage, BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDataConnectionClient, CanvasDataTypeClient, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionBindingIssue, CompositionDataDiagnostic, CompositionDataIssue, CompositionIssue, CompositionPatternIssue, CompositionVariableIssue, DataConnection, DataConnectionDeleteParameters, DataConnectionGetParameters, DataConnectionGetResponse, DataConnectionInfo, DataConnectionPutParameters, DataConnectionsGetParameters, DataConnectionsGetResponse, DataType, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariable, EdgeCanvasClient, EdgeCompositionGetResponse, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, LimitPolicy, MessageHandler, MoveComponentMessage, ReadyMessage, SelectComponentMessage, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createLimitPolicy, enhance, extractLocales, generateHash, getChannelName, getComponentPath, isAddComponentMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
865
+ export { AddComponentMessage, BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionBindingIssue, CompositionDataDiagnostic, CompositionDataIssue, CompositionIssue, CompositionPatternIssue, CompositionVariableIssue, DataConnectionClient, DataTypeClient, EdgeCanvasClient, EdgeCompositionGetResponse, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, LimitPolicy, MessageHandler, MoveComponentMessage, ReadyMessage, SelectComponentMessage, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createLimitPolicy, enhance, extractLocales, generateHash, getChannelName, getComponentPath, isAddComponentMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };