@takeshape/schema 8.274.0 → 8.276.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.
Files changed (72) hide show
  1. package/dist/migration/index.d.ts +1 -0
  2. package/dist/migration/index.d.ts.map +1 -1
  3. package/dist/migration/index.js +4 -1
  4. package/dist/migration/to/v3.26.0.d.ts +5 -0
  5. package/dist/migration/to/v3.26.0.d.ts.map +1 -0
  6. package/dist/migration/to/v3.26.0.js +18 -0
  7. package/dist/project-schema/index.d.ts +4 -1
  8. package/dist/project-schema/index.d.ts.map +1 -1
  9. package/dist/project-schema/index.js +20 -3
  10. package/dist/project-schema/latest.d.ts +28 -3
  11. package/dist/project-schema/latest.d.ts.map +1 -1
  12. package/dist/project-schema/migrate.d.ts.map +1 -1
  13. package/dist/project-schema/migrate.js +4 -0
  14. package/dist/project-schema/v3.26.0.d.ts +1389 -0
  15. package/dist/project-schema/v3.26.0.d.ts.map +1 -0
  16. package/dist/project-schema/v3.26.0.js +5 -0
  17. package/dist/refs.d.ts +4 -0
  18. package/dist/refs.d.ts.map +1 -1
  19. package/dist/refs.js +23 -0
  20. package/dist/schemas/index.d.ts +2 -2
  21. package/dist/schemas/index.d.ts.map +1 -1
  22. package/dist/schemas/index.js +6 -4
  23. package/dist/schemas/index.ts +4 -2
  24. package/dist/schemas/project-schema/latest.json +57 -4
  25. package/dist/schemas/project-schema/v3.26.0.json +2956 -0
  26. package/dist/schemas/project-schema.json +3 -0
  27. package/dist/types/types.d.ts +3 -2
  28. package/dist/types/types.d.ts.map +1 -1
  29. package/dist/validate.js +1 -1
  30. package/es/migration/index.js +3 -1
  31. package/es/migration/to/v3.26.0.js +10 -0
  32. package/es/project-schema/index.js +3 -1
  33. package/es/project-schema/migrate.js +5 -1
  34. package/es/project-schema/v3.26.0.js +1 -0
  35. package/es/refs.js +20 -0
  36. package/es/schemas/index.js +4 -3
  37. package/es/schemas/index.ts +4 -2
  38. package/es/schemas/project-schema/latest.json +57 -4
  39. package/es/schemas/project-schema/v3.26.0.json +2956 -0
  40. package/es/schemas/project-schema.json +3 -0
  41. package/es/validate.js +1 -1
  42. package/examples/latest/betzino.json +1 -1
  43. package/examples/latest/blog-schema.json +1 -1
  44. package/examples/latest/brewery-schema.json +1 -1
  45. package/examples/latest/complex-project-schema.json +1 -1
  46. package/examples/latest/complex-schema.json +1 -1
  47. package/examples/latest/fabric-ecommerce.json +1 -1
  48. package/examples/latest/frank-and-fred-schema.json +1 -1
  49. package/examples/latest/klirr-schema.json +1 -1
  50. package/examples/latest/massive-schema.json +1 -1
  51. package/examples/latest/mill-components-schema.json +1 -1
  52. package/examples/latest/one-earth.json +1 -1
  53. package/examples/latest/pet-oneof-array.json +1 -1
  54. package/examples/latest/post-schema.json +1 -1
  55. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  56. package/examples/latest/real-world-schema.json +1 -1
  57. package/examples/latest/recursive-repeater-schema.json +1 -1
  58. package/examples/latest/recursive-schema.json +1 -1
  59. package/examples/latest/rick-and-morty-ast.json +1 -1
  60. package/examples/latest/rick-and-morty-graphql.json +1 -1
  61. package/examples/latest/rick-and-morty-rest.json +1 -1
  62. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  63. package/examples/latest/shape-books-v3_2_0.json +1 -1
  64. package/examples/latest/shape-books.json +1 -1
  65. package/examples/latest/shopify-lookbook.json +1 -1
  66. package/examples/latest/shopify-product-2022-07.json +1 -1
  67. package/examples/latest/shopify-store-with-widget.json +1 -1
  68. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  69. package/examples/latest/stripe-starter-resolved.json +1 -1
  70. package/examples/latest/user-schema-no-required.json +1 -1
  71. package/examples/latest/user-schema-with-defaults.json +1 -1
  72. package/package.json +4 -4
@@ -0,0 +1,1389 @@
1
+ /**
2
+ * This file was automatically generated by json-schema-to-typescript.
3
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
4
+ * and run json-schema-to-typescript to regenerate this file.
5
+ */
6
+ /**
7
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
8
+ * via the `definition` "args".
9
+ */
10
+ export declare type ArgsV3_26_0 = string | ObjectSchemaV3_26_0;
11
+ /**
12
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
13
+ * via the `definition` "objectSchema".
14
+ */
15
+ export declare type ObjectSchemaV3_26_0 = PropertySchemaV3_26_0 & {
16
+ type: 'object';
17
+ properties: {
18
+ [k: string]: PropertySchemaV3_26_0;
19
+ };
20
+ };
21
+ /**
22
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
23
+ * via the `definition` "nonNegativeInteger".
24
+ */
25
+ export declare type NonNegativeIntegerV3_26_0 = number;
26
+ /**
27
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
28
+ * via the `definition` "nonNegativeIntegerDefault0".
29
+ */
30
+ export declare type NonNegativeIntegerDefault0V3_26_0 = NonNegativeIntegerV3_26_0;
31
+ /**
32
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
33
+ * via the `definition` "stringArray".
34
+ */
35
+ export declare type StringArrayV3_26_0 = string[];
36
+ /**
37
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
38
+ * via the `definition` "simpleTypes".
39
+ */
40
+ export declare type SimpleTypesV3_26_0 = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
41
+ /**
42
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
43
+ * via the `definition` "schemaArray".
44
+ */
45
+ export declare type SchemaArrayV3_26_0 = PropertySchemaV3_26_0[];
46
+ /**
47
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
48
+ * via the `definition` "ref".
49
+ */
50
+ export declare type RefV3_26_0 = string;
51
+ /**
52
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
53
+ * via the `definition` "objectOrRefArray".
54
+ */
55
+ export declare type ObjectOrRefArrayV3_26_0 = (RefSchemaV3_26_0 | RefSchemaLegacyV3_26_0 | ObjectSchemaV3_26_0)[];
56
+ /**
57
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
58
+ * via the `definition` "fieldMapping".
59
+ */
60
+ export declare type FieldMappingV3_26_0 = MappingStringV3_26_0 | MappingStringV3_26_0[];
61
+ /**
62
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
63
+ * via the `definition` "mappingString".
64
+ */
65
+ export declare type MappingStringV3_26_0 = string;
66
+ /**
67
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
68
+ * via the `definition` "resolver".
69
+ */
70
+ export declare type ResolverV3_26_0 = BasicResolverV3_26_0 | ComposeResolverV3_26_0;
71
+ /**
72
+ * A single resolver, can be composed with the ComposeResolver.
73
+ *
74
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
75
+ * via the `definition` "basicResolver".
76
+ */
77
+ export declare type BasicResolverV3_26_0 = UtilResolverV3_26_0 | DelegateResolverV3_26_0 | TakeshapeResolverV3_26_0 | InternalTakeshapeResolverV3_26_0 | GraphqlResolverV3_26_0 | RestResolverV3_26_0 | AwsLambdaResolverV3_26_0 | SalsifyResolverV3_26_0;
78
+ /**
79
+ * Name of the resolver function.
80
+ */
81
+ export declare type UtilResolverNameV3_26_0 = 'debug:noop' | 'util:wrap';
82
+ /**
83
+ * An object describing an operation to generate a parameter.
84
+ *
85
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
86
+ * via the `definition` "parameterOp".
87
+ */
88
+ export declare type ParameterOpV3_26_0 = ParameterOpNestedV3_26_0 | ParameterOpValueV3_26_0 | ParameterOpMappingV3_26_0 | ParameterOpOpV3_26_0;
89
+ /**
90
+ * A tuple with a string directive name, and options to pass to the directive
91
+ *
92
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
93
+ * via the `definition` "directiveConfigItem".
94
+ */
95
+ export declare type DirectiveConfigItemV3_26_0 = [DirectiveNameV3_26_0, DirectiveOptionsV3_26_0];
96
+ export declare type DirectiveNameV3_26_0 = string;
97
+ /**
98
+ * An array of individual directive config items to process in order
99
+ *
100
+ * This interface was referenced by `DirectiveMappingMapV3_26_0`'s JSON-Schema definition
101
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
102
+ *
103
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
104
+ * via the `definition` "directiveConfig".
105
+ */
106
+ export declare type DirectiveConfigV3_26_0 = DirectiveConfigItemV3_26_0[];
107
+ /**
108
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
109
+ * via the `definition` "parameterOpList".
110
+ */
111
+ export declare type ParameterOpListV3_26_0 = ParameterOpV3_26_0[];
112
+ /**
113
+ * Maps a query's input args to the input expected by the service's endpoint.
114
+ *
115
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
116
+ * via the `definition` "argsMapping".
117
+ */
118
+ export declare type ArgsMappingV3_26_0 = DirectiveMappingMapV3_26_0 | DirectiveConfigV3_26_0;
119
+ /**
120
+ * Maps a service endpoint's response results to the expected shape of the query's response.
121
+ *
122
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
123
+ * via the `definition` "resultsMapping".
124
+ */
125
+ export declare type ResultsMappingV3_26_0 = DirectiveMappingMapV3_26_0 | DirectiveConfigV3_26_0;
126
+ /**
127
+ * Name of the resolver function.
128
+ */
129
+ export declare type DelegateResolverNameV3_26_0 = 'delegate';
130
+ /**
131
+ * Name of the resolver function.
132
+ */
133
+ export declare type TakeshapeResolverNameV3_26_0 = 'takeshape:get' | 'takeshape:create' | 'takeshape:update' | 'takeshape:delete' | 'takeshape:duplicate' | 'takeshape:find' | 'takeshape:queryApiIndex';
134
+ /**
135
+ * Name of the resolver function.
136
+ */
137
+ export declare type InternalTakeshapeResolverNameV3_26_0 = 'takeshape:getRelated' | 'takeshape:getUser' | 'takeshape:taxonomySuggest' | 'takeshape:list' | 'takeshape:search';
138
+ /**
139
+ * Name of the resolver function.
140
+ */
141
+ export declare type GraphqlResolverNameV3_26_0 = 'graphql:query' | 'graphql:mutation';
142
+ /**
143
+ * Name of the resolver function.
144
+ */
145
+ export declare type RestResolverNameV3_26_0 = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
146
+ /**
147
+ * A tuple with a string key and a directive config to evaluate
148
+ *
149
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
150
+ * via the `definition` "directiveMappingArrayItem".
151
+ */
152
+ export declare type DirectiveMappingArrayItemV3_26_0 = [string, DirectiveConfigV3_26_0];
153
+ /**
154
+ * An array of key / value or directive config tuples
155
+ */
156
+ export declare type SearchParamsMappingV3_26_0 = DirectiveMappingArrayItemV3_26_0[];
157
+ /**
158
+ * Name of the resolver function.
159
+ */
160
+ export declare type AwsLambdaResolverNameV3_26_0 = 'awsLambda:invoke';
161
+ /**
162
+ * Name of the resolver function.
163
+ */
164
+ export declare type SalsifyResolverNameV3_26_0 = 'salsify:listChannelProducts';
165
+ /**
166
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
167
+ * via the `definition` "returnShape".
168
+ */
169
+ export declare type ReturnShapeV3_26_0 = string | ReturnShapeArraySchemaV3_26_0;
170
+ /**
171
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
172
+ * via the `definition` "returnShapeArraySchema".
173
+ */
174
+ export declare type ReturnShapeArraySchemaV3_26_0 = PropertySchemaV3_26_0 & {
175
+ type: 'array';
176
+ items: RefSchemaV3_26_0 | {
177
+ type: 'boolean' | 'integer' | 'number' | 'string' | 'object';
178
+ [k: string]: any;
179
+ };
180
+ };
181
+ export declare type ModelTypeV3_26_0 = 'single' | 'multiple' | 'taxonomy';
182
+ /**
183
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
184
+ * via the `definition` "shapeSchema".
185
+ */
186
+ export declare type ShapeSchemaV3_26_0 = ShapeSchemaAllOfV3_26_0 | ShapeSchemaExtendsV3_26_0 | ShapeSchemaOneOfV3_26_0 | ShapeSchemaEnumV3_26_0 | ObjectSchemaV3_26_0;
187
+ /**
188
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
189
+ * via the `definition` "paginationConfig".
190
+ */
191
+ export declare type PaginationConfigV3_26_0 = PaginationCursorConfigV3_26_0 | PaginationPageConfigV3_26_0 | PaginationOffsetConfigV3_26_0;
192
+ /**
193
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
194
+ * via the `definition` "indexedShapeTriggersConfig".
195
+ */
196
+ export declare type IndexedShapeTriggersConfigV3_26_0 = IndexedShapeScheduleTriggerConfigV3_26_0 | IndexedShapeWebhookTriggerConfigV3_26_0;
197
+ /**
198
+ * Human-readable id for use in the UI
199
+ */
200
+ export declare type WorkflowNameV3_26_0 = string;
201
+ /**
202
+ * machine-readable slug
203
+ */
204
+ export declare type NameV3_26_0 = string;
205
+ /**
206
+ * Human-readable id for use in the UI
207
+ */
208
+ export declare type TitleV3_26_0 = string;
209
+ export declare type DescriptionV3_26_0 = string;
210
+ /**
211
+ * Hex color code
212
+ */
213
+ export declare type ColorV3_26_0 = string;
214
+ /**
215
+ * Value to indicate whether items in the state should be returned in list queries
216
+ */
217
+ export declare type LiveV3_26_0 = boolean;
218
+ /**
219
+ * machine-readable id
220
+ */
221
+ export declare type KeyV3_26_0 = string;
222
+ export declare type StepsV3_26_0 = WorkflowStepV3_26_0[];
223
+ /**
224
+ * The general type of this service, specifying how and where it will be utilized.
225
+ *
226
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
227
+ * via the `definition` "serviceType".
228
+ */
229
+ export declare type ServiceTypeV3_26_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
230
+ /**
231
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
232
+ * via the `definition` "allOfSchema".
233
+ */
234
+ export declare type AllOfSchemaV3_26_0 = PropertySchemaV3_26_0 & {
235
+ allOf: ObjectOrRefArrayV3_26_0;
236
+ };
237
+ /**
238
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
239
+ * via the `definition` "extendsSchema".
240
+ */
241
+ export declare type ExtendsSchemaV3_26_0 = PropertySchemaV3_26_0 & {
242
+ extends: ObjectOrRefArrayV3_26_0;
243
+ };
244
+ /**
245
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
246
+ * via the `definition` "oneOfSchema".
247
+ */
248
+ export declare type OneOfSchemaV3_26_0 = PropertySchemaV3_26_0 & {
249
+ oneOf: ObjectOrRefArrayV3_26_0;
250
+ };
251
+ /**
252
+ * Options to be passed to the serialization routine.
253
+ *
254
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
255
+ * via the `definition` "parameterSerializeOptions".
256
+ *
257
+ * This interface was referenced by `undefined`'s JSON-Schema definition
258
+ * via the `patternProperty` "^[^\n\r]*$".
259
+ */
260
+ export declare type ParameterSerializeOptionsV3_26_0 = ParameterSerializeStyleOptionsV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
261
+ /**
262
+ * An array of key / value or directive config tuples
263
+ *
264
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
265
+ * via the `definition` "directiveMappingArray".
266
+ */
267
+ export declare type DirectiveMappingArrayV3_26_0 = DirectiveMappingArrayItemV3_26_0[];
268
+ /**
269
+ * A resolver which references a specific service
270
+ *
271
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
272
+ * via the `definition` "serviceResolver".
273
+ */
274
+ export declare type ServiceResolverV3_26_0 = UtilResolverV3_26_0 | TakeshapeResolverV3_26_0 | InternalTakeshapeResolverV3_26_0 | GraphqlResolverV3_26_0 | RestResolverV3_26_0 | AwsLambdaResolverV3_26_0;
275
+ /**
276
+ * An array of key / value or directive config tuples
277
+ *
278
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
279
+ * via the `definition` "searchParamsMapping".
280
+ */
281
+ export declare type SearchParamsMappingV3_26_01 = DirectiveMappingArrayItemV3_26_0[];
282
+ /**
283
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
284
+ * via the `definition` "shapeWithObjectSchema".
285
+ */
286
+ export declare type ShapeWithObjectSchemaV3_26_0 = ShapeV3_26_0 & {
287
+ schema: ObjectSchemaV3_26_0;
288
+ };
289
+ /**
290
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
291
+ * via the `definition` "serviceAuthentication".
292
+ */
293
+ export declare type ServiceAuthenticationV3_26_0 = OAuth2AuthenticationV3_26_0 | OAuth2BearerAuthenticationV3_26_0 | BearerAuthenticationV3_26_0 | BasicAuthenticationV3_26_0 | SearchParamsAuthenticationV3_26_0 | AWSAuthenticationV3_26_0 | CustomAuthenticationV3_26_0;
294
+ /**
295
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
296
+ * via the `definition` "anyServiceConfig".
297
+ */
298
+ export declare type AnyServiceConfigV3_26_0 = StoredServiceConfigV3_26_0 | ServiceConfigV3_26_0;
299
+ export interface ProjectSchemaV3_26_0 {
300
+ $schema?: string;
301
+ /**
302
+ * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
303
+ */
304
+ apiVersion: string;
305
+ /**
306
+ * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
307
+ */
308
+ schemaVersion: '3.26.0';
309
+ /**
310
+ * The ID of the TakeShape project this schema belongs to.
311
+ */
312
+ projectId: string;
313
+ /**
314
+ * The ID of the TakeShape user who created the schema.
315
+ */
316
+ author?: string;
317
+ deactivated?: number;
318
+ /**
319
+ * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
320
+ */
321
+ defaultLocale: string;
322
+ locales: string[];
323
+ queries: QueryMapV3_26_0;
324
+ mutations: QueryMapV3_26_0;
325
+ shapes: ShapeMapV3_26_0;
326
+ indexedShapes?: IndexedShapeMapV3_26_0;
327
+ forms?: FormMapV3_26_0;
328
+ workflows: WorkflowMapV3_26_0;
329
+ services?: StoredServiceMapV3_26_0;
330
+ }
331
+ /**
332
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
333
+ * via the `definition` "queryMap".
334
+ */
335
+ export interface QueryMapV3_26_0 {
336
+ [k: string]: QueryV3_26_0;
337
+ }
338
+ /**
339
+ * This interface was referenced by `QueryMapV3_26_0`'s JSON-Schema definition
340
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
341
+ *
342
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
343
+ * via the `definition` "query".
344
+ */
345
+ export interface QueryV3_26_0 {
346
+ args?: ArgsV3_26_0;
347
+ resolver: ResolverV3_26_0;
348
+ shape: ReturnShapeV3_26_0;
349
+ /**
350
+ * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
351
+ */
352
+ description?: string;
353
+ }
354
+ /**
355
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
356
+ * via the `definition` "propertySchema".
357
+ */
358
+ export interface PropertySchemaV3_26_0 {
359
+ $ref?: string;
360
+ title?: string;
361
+ description?: string;
362
+ default?: any;
363
+ readOnly?: boolean;
364
+ multipleOf?: number;
365
+ maximum?: number;
366
+ exclusiveMaximum?: number;
367
+ minimum?: number;
368
+ exclusiveMinimum?: number;
369
+ maxLength?: NonNegativeIntegerV3_26_0;
370
+ minLength?: NonNegativeIntegerDefault0V3_26_0;
371
+ pattern?: string;
372
+ additionalItems?: PropertySchemaV3_26_0;
373
+ items?: PropertySchemaV3_26_0;
374
+ maxItems?: NonNegativeIntegerV3_26_0;
375
+ minItems?: NonNegativeIntegerDefault0V3_26_0;
376
+ uniqueItems?: boolean;
377
+ contains?: PropertySchemaV3_26_0;
378
+ maxProperties?: NonNegativeIntegerV3_26_0;
379
+ minProperties?: NonNegativeIntegerDefault0V3_26_0;
380
+ required?: StringArrayV3_26_0;
381
+ additionalProperties?: PropertySchemaV3_26_0 | false;
382
+ definitions?: {
383
+ [k: string]: PropertySchemaV3_26_0;
384
+ };
385
+ properties?: {
386
+ [k: string]: PropertySchemaV3_26_0;
387
+ };
388
+ const?: any;
389
+ enum?: any[];
390
+ type?: SimpleTypesV3_26_0 | SimpleTypesV3_26_0[];
391
+ format?: string;
392
+ contentMediaType?: string;
393
+ contentEncoding?: string;
394
+ allOf?: SchemaArrayV3_26_0;
395
+ discriminator?: {
396
+ propertyName?: string;
397
+ [k: string]: any;
398
+ };
399
+ oneOf?: SchemaArrayV3_26_0;
400
+ extends?: ObjectOrRefArrayV3_26_0;
401
+ '@backreference'?: BackReferenceV3_26_0;
402
+ '@input'?: PropertySchemaV3_26_0;
403
+ '@output'?: PropertySchemaV3_26_0;
404
+ '@syncLocaleStructure'?: boolean;
405
+ '@sensitive'?: boolean;
406
+ '@draftjs'?: boolean;
407
+ '@l10n'?: boolean;
408
+ '@key'?: string;
409
+ '@workflow'?: string;
410
+ '@mapping'?: FieldMappingV3_26_0;
411
+ '@tag'?: string;
412
+ '@tags'?: string[];
413
+ '@deprecationReason'?: string;
414
+ '@args'?: ArgsV3_26_0;
415
+ '@resolver'?: ResolverV3_26_0;
416
+ '@ref'?: RefV3_26_0;
417
+ '@derivedFrom'?: string;
418
+ }
419
+ /**
420
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
421
+ * via the `definition` "refSchema".
422
+ */
423
+ export interface RefSchemaV3_26_0 {
424
+ '@ref': RefV3_26_0;
425
+ [k: string]: any;
426
+ }
427
+ /**
428
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
429
+ * via the `definition` "refSchemaLegacy".
430
+ */
431
+ export interface RefSchemaLegacyV3_26_0 {
432
+ $ref: RefV3_26_0;
433
+ [k: string]: any;
434
+ }
435
+ /**
436
+ * A configuration object for a reverse reference in a relationship.
437
+ *
438
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
439
+ * via the `definition` "backreference".
440
+ */
441
+ export interface BackReferenceV3_26_0 {
442
+ enabled: boolean;
443
+ name?: string;
444
+ }
445
+ /**
446
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
447
+ * via the `definition` "utilResolver".
448
+ */
449
+ export interface UtilResolverV3_26_0 {
450
+ if?: string;
451
+ id?: string;
452
+ name: UtilResolverNameV3_26_0;
453
+ /**
454
+ * Configuration for a service to use with this resolver.
455
+ */
456
+ service: string;
457
+ options?: UtilResolverOptionsV3_26_0;
458
+ args?: ParameterConfigForJsonV3_26_0;
459
+ results?: ParameterConfigForJsonV3_26_0;
460
+ argsMapping?: ArgsMappingV3_26_0;
461
+ resultsMapping?: ResultsMappingV3_26_0;
462
+ }
463
+ export interface UtilResolverOptionsV3_26_0 {
464
+ [k: string]: any;
465
+ }
466
+ /**
467
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
468
+ * via the `definition` "parameterConfigForJson".
469
+ */
470
+ export interface ParameterConfigForJsonV3_26_0 {
471
+ ops: ParameterOpListV3_26_0;
472
+ }
473
+ /**
474
+ * An object describing an operation to generate a parameter, using a nested OpList.
475
+ *
476
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
477
+ * via the `definition` "parameterOpNested".
478
+ */
479
+ export interface ParameterOpNestedV3_26_0 {
480
+ /**
481
+ * A path to the parameter for this operation.
482
+ */
483
+ path: string;
484
+ /**
485
+ * A mode for this parameter's operation.
486
+ */
487
+ op?: 'set' | 'concat' | 'extend' | 'remove';
488
+ ops: ParameterOpListV3_26_0;
489
+ }
490
+ /**
491
+ * An object describing an operation to generate a parameter using a value.
492
+ *
493
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
494
+ * via the `definition` "parameterOpValue".
495
+ */
496
+ export interface ParameterOpValueV3_26_0 {
497
+ /**
498
+ * A path to the parameter for this operation.
499
+ */
500
+ path: string;
501
+ /**
502
+ * A mode for this parameter's operation.
503
+ */
504
+ op?: 'set' | 'concat' | 'extend' | 'remove';
505
+ /**
506
+ * A value to set directly at this path.
507
+ */
508
+ value: number | string | boolean | {
509
+ [k: string]: any;
510
+ } | any[] | null;
511
+ }
512
+ /**
513
+ * An object describing an operation to generate a parameter using a mapping.
514
+ *
515
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
516
+ * via the `definition` "parameterOpMapping".
517
+ */
518
+ export interface ParameterOpMappingV3_26_0 {
519
+ /**
520
+ * A path to the parameter for this operation.
521
+ */
522
+ path: string;
523
+ /**
524
+ * A mode for this parameter's operation.
525
+ */
526
+ op?: 'set' | 'concat' | 'extend' | 'remove';
527
+ /**
528
+ * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
529
+ */
530
+ mapping: string | DirectiveConfigV3_26_0;
531
+ }
532
+ export interface DirectiveOptionsV3_26_0 {
533
+ [k: string]: any;
534
+ }
535
+ /**
536
+ * An object describing an operation to generate a parameter using a mapping.
537
+ *
538
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
539
+ * via the `definition` "parameterOpOp".
540
+ */
541
+ export interface ParameterOpOpV3_26_0 {
542
+ /**
543
+ * A path to the parameter for this operation.
544
+ */
545
+ path: string;
546
+ /**
547
+ * A mode for this parameter's operation.
548
+ */
549
+ op: 'set' | 'concat' | 'extend' | 'remove';
550
+ }
551
+ /**
552
+ * An map of object keys / key paths to directive configs
553
+ *
554
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
555
+ * via the `definition` "directiveMappingMap".
556
+ */
557
+ export interface DirectiveMappingMapV3_26_0 {
558
+ [k: string]: DirectiveConfigV3_26_0;
559
+ }
560
+ /**
561
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
562
+ * via the `definition` "delegateResolver".
563
+ */
564
+ export interface DelegateResolverV3_26_0 {
565
+ if?: string;
566
+ id?: string;
567
+ name: DelegateResolverNameV3_26_0;
568
+ options?: DelegateResolverOptionsV3_26_0;
569
+ argsMapping?: ArgsMappingV3_26_0;
570
+ resultsMapping?: ResultsMappingV3_26_0;
571
+ /**
572
+ * A ref to a query/mutation/property to delegate to.
573
+ */
574
+ to: string;
575
+ args?: ParameterConfigForJsonV3_26_0;
576
+ results?: ParameterConfigForJsonV3_26_0;
577
+ }
578
+ export interface DelegateResolverOptionsV3_26_0 {
579
+ [k: string]: any;
580
+ }
581
+ /**
582
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
583
+ * via the `definition` "takeshapeResolver".
584
+ */
585
+ export interface TakeshapeResolverV3_26_0 {
586
+ if?: string;
587
+ id?: string;
588
+ name: TakeshapeResolverNameV3_26_0;
589
+ /**
590
+ * Internal service identifier.
591
+ */
592
+ service: 'takeshape:local';
593
+ options?: TakeshapeResolverOptionsV3_26_0;
594
+ argsMapping?: ArgsMappingV3_26_0;
595
+ resultsMapping?: ResultsMappingV3_26_0;
596
+ /**
597
+ * A Shape name for the resolver to use.
598
+ */
599
+ shapeName: string;
600
+ args?: ParameterConfigForJsonV3_26_0;
601
+ results?: ParameterConfigForJsonV3_26_0;
602
+ }
603
+ export interface TakeshapeResolverOptionsV3_26_0 {
604
+ [k: string]: any;
605
+ }
606
+ /**
607
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
608
+ * via the `definition` "internalTakeshapeResolver".
609
+ */
610
+ export interface InternalTakeshapeResolverV3_26_0 {
611
+ if?: string;
612
+ id?: string;
613
+ name: InternalTakeshapeResolverNameV3_26_0;
614
+ /**
615
+ * Internal service identifier.
616
+ */
617
+ service: 'takeshape:local';
618
+ options?: TakeshapeResolverOptionsV3_26_01;
619
+ /**
620
+ * An optional Shape name for the resolver.
621
+ */
622
+ shapeName?: string;
623
+ args?: ParameterConfigForJsonV3_26_0;
624
+ results?: ParameterConfigForJsonV3_26_0;
625
+ argsMapping?: ArgsMappingV3_26_0;
626
+ resultsMapping?: ResultsMappingV3_26_0;
627
+ }
628
+ export interface TakeshapeResolverOptionsV3_26_01 {
629
+ [k: string]: any;
630
+ }
631
+ /**
632
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
633
+ * via the `definition` "graphqlResolver".
634
+ */
635
+ export interface GraphqlResolverV3_26_0 {
636
+ if?: string;
637
+ id?: string;
638
+ name: GraphqlResolverNameV3_26_0;
639
+ /**
640
+ * Configuration for a service to use with this resolver.
641
+ */
642
+ service: string;
643
+ argsMapping?: ArgsMappingV3_26_0;
644
+ resultsMapping?: ResultsMappingV3_26_0;
645
+ options?: GraphqlResolverOptionsV3_26_0;
646
+ /**
647
+ * A fieldname to use in queries.
648
+ */
649
+ fieldName: string;
650
+ headers?: ParameterConfigForHeadersV3_26_0;
651
+ searchParams?: ParameterConfigForSearchParamsV3_26_0;
652
+ args?: ParameterConfigForJsonV3_26_0;
653
+ results?: ParameterConfigForJsonV3_26_0;
654
+ }
655
+ export interface GraphqlResolverOptionsV3_26_0 {
656
+ selectionSet?: string;
657
+ unboxParentSelectionSet?: boolean;
658
+ ignoreErrors?: boolean;
659
+ skipWhenMissingArgs?: boolean;
660
+ ttl?: number;
661
+ timeout?: number;
662
+ retry?: number | {
663
+ [k: string]: any;
664
+ };
665
+ [k: string]: any;
666
+ }
667
+ /**
668
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
669
+ * via the `definition` "parameterConfigForHeaders".
670
+ */
671
+ export interface ParameterConfigForHeadersV3_26_0 {
672
+ ops: ParameterOpListV3_26_0;
673
+ serialize?: ParameterSerializeConfigForHeadersV3_26_0;
674
+ }
675
+ /**
676
+ * Top-level paths to use headers serialization options for.
677
+ *
678
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
679
+ * via the `definition` "parameterSerializeConfigForHeaders".
680
+ */
681
+ export interface ParameterSerializeConfigForHeadersV3_26_0 {
682
+ defaults?: ParameterSerializeStyleOptionsForHeadersV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
683
+ paths?: {
684
+ /**
685
+ * This interface was referenced by `undefined`'s JSON-Schema definition
686
+ * via the `patternProperty` "^[^\n\r]*$".
687
+ */
688
+ [k: string]: ParameterSerializeStyleOptionsForHeadersV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
689
+ };
690
+ }
691
+ /**
692
+ * Options to be passed to the serialization routine.
693
+ *
694
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
695
+ * via the `definition` "parameterSerializeStyleOptionsForHeaders".
696
+ */
697
+ export interface ParameterSerializeStyleOptionsForHeadersV3_26_0 {
698
+ style: 'simple' | 'none';
699
+ explode?: boolean;
700
+ }
701
+ /**
702
+ * Options to be passed to the serialization routine.
703
+ *
704
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
705
+ * via the `definition` "parameterSerializeContentOptions".
706
+ */
707
+ export interface ParameterSerializeContentOptionsV3_26_0 {
708
+ contentType: string;
709
+ /**
710
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
711
+ */
712
+ allowReserved?: boolean;
713
+ skipEncoding?: boolean;
714
+ /**
715
+ * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
716
+ */
717
+ options?: {
718
+ [k: string]: any;
719
+ };
720
+ }
721
+ /**
722
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
723
+ * via the `definition` "parameterConfigForSearchParams".
724
+ */
725
+ export interface ParameterConfigForSearchParamsV3_26_0 {
726
+ ops: ParameterOpListV3_26_0;
727
+ serialize?: ParameterSerializeConfigForSearchParamsV3_26_0;
728
+ }
729
+ /**
730
+ * Top-level paths to use search params serialization options for.
731
+ *
732
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
733
+ * via the `definition` "parameterSerializeConfigForSearchParams".
734
+ */
735
+ export interface ParameterSerializeConfigForSearchParamsV3_26_0 {
736
+ defaults?: ParameterSerializeStyleOptionsForSearchParamsV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
737
+ paths?: {
738
+ /**
739
+ * This interface was referenced by `undefined`'s JSON-Schema definition
740
+ * via the `patternProperty` "^[^\n\r]*$".
741
+ */
742
+ [k: string]: ParameterSerializeStyleOptionsForSearchParamsV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
743
+ };
744
+ }
745
+ /**
746
+ * Options to be passed to the serialization routine.
747
+ *
748
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
749
+ * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
750
+ */
751
+ export interface ParameterSerializeStyleOptionsForSearchParamsV3_26_0 {
752
+ style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
753
+ explode?: boolean;
754
+ allowEmptyValue?: boolean;
755
+ /**
756
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
757
+ */
758
+ allowReserved?: boolean;
759
+ skipEncoding?: boolean;
760
+ }
761
+ /**
762
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
763
+ * via the `definition` "restResolver".
764
+ */
765
+ export interface RestResolverV3_26_0 {
766
+ if?: string;
767
+ id?: string;
768
+ name: RestResolverNameV3_26_0;
769
+ /**
770
+ * Configuration for a service to use with this resolver.
771
+ */
772
+ service: string;
773
+ argsMapping?: ArgsMappingV3_26_0;
774
+ searchParamsMapping?: SearchParamsMappingV3_26_0;
775
+ resultsMapping?: ResultsMappingV3_26_0;
776
+ options?: RestResolverOptionsV3_26_0;
777
+ body?: ParameterConfigForBodyV3_26_0;
778
+ form?: ParameterConfigForSearchParamsV3_26_0;
779
+ headers?: ParameterConfigForHeadersV3_26_0;
780
+ json?: ParameterConfigForJsonV3_26_0;
781
+ /**
782
+ * Mapping and serialization configuration for the path, or a simple string.
783
+ */
784
+ path: ParameterConfigForPathParamsV3_26_0 | string;
785
+ searchParams?: ParameterConfigForSearchParamsV3_26_0;
786
+ args?: ParameterConfigForJsonV3_26_0;
787
+ results?: ParameterConfigForJsonV3_26_0;
788
+ }
789
+ export interface RestResolverOptionsV3_26_0 {
790
+ trailingSlash?: boolean;
791
+ ttl?: number;
792
+ timeout?: number;
793
+ retry?: number | {
794
+ [k: string]: any;
795
+ };
796
+ [k: string]: any;
797
+ }
798
+ /**
799
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
800
+ * via the `definition` "parameterConfigForBody".
801
+ */
802
+ export interface ParameterConfigForBodyV3_26_0 {
803
+ ops: ParameterOpListV3_26_0;
804
+ serialize?: ParameterSerializeConfigForBodyV3_26_0;
805
+ }
806
+ /**
807
+ * Top-level paths to use serialization options for.
808
+ *
809
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
810
+ * via the `definition` "parameterSerializeConfigForBody".
811
+ */
812
+ export interface ParameterSerializeConfigForBodyV3_26_0 {
813
+ content?: ParameterSerializeContentOptionsV3_26_0;
814
+ }
815
+ /**
816
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
817
+ * via the `definition` "parameterConfigForPathParams".
818
+ */
819
+ export interface ParameterConfigForPathParamsV3_26_0 {
820
+ ops: ParameterOpListV3_26_0;
821
+ serialize: ParameterSerializeConfigForPathParamsV3_26_0;
822
+ }
823
+ /**
824
+ * Top-level paths to use path params serialization options for.
825
+ *
826
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
827
+ * via the `definition` "parameterSerializeConfigForPathParams".
828
+ */
829
+ export interface ParameterSerializeConfigForPathParamsV3_26_0 {
830
+ /**
831
+ * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
832
+ */
833
+ template: string;
834
+ defaults?: ParameterSerializeStyleOptionsForPathParamsV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
835
+ paths?: {
836
+ /**
837
+ * This interface was referenced by `undefined`'s JSON-Schema definition
838
+ * via the `patternProperty` "^[^\n\r]*$".
839
+ */
840
+ [k: string]: ParameterSerializeStyleOptionsForPathParamsV3_26_0 | ParameterSerializeContentOptionsV3_26_0;
841
+ };
842
+ }
843
+ /**
844
+ * Options to be passed to the serialization routine.
845
+ *
846
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
847
+ * via the `definition` "parameterSerializeStyleOptionsForPathParams".
848
+ */
849
+ export interface ParameterSerializeStyleOptionsForPathParamsV3_26_0 {
850
+ style: 'simple' | 'label' | 'matrix' | 'none';
851
+ explode?: boolean;
852
+ allowEmptyValue?: boolean;
853
+ /**
854
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
855
+ */
856
+ allowReserved?: boolean;
857
+ skipEncoding?: boolean;
858
+ }
859
+ /**
860
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
861
+ * via the `definition` "awsLambdaResolver".
862
+ */
863
+ export interface AwsLambdaResolverV3_26_0 {
864
+ if?: string;
865
+ id?: string;
866
+ name: AwsLambdaResolverNameV3_26_0;
867
+ /**
868
+ * Configuration for a service to use with this resolver.
869
+ */
870
+ service: string;
871
+ options?: AwsLambdaResolverOptionsV3_26_0;
872
+ payload?: ParameterConfigForJsonV3_26_0;
873
+ /**
874
+ * Mapping configuration for the FunctionName.
875
+ */
876
+ functionName: string | ParameterConfigForAwsLambdaV3_26_0;
877
+ clientContext?: ParameterConfigForJsonV3_26_0;
878
+ args?: ParameterConfigForJsonV3_26_0;
879
+ results?: ParameterConfigForJsonV3_26_0;
880
+ argsMapping?: ArgsMappingV3_26_0;
881
+ searchParamsMapping?: SearchParamsMappingV3_26_0;
882
+ resultsMapping?: ResultsMappingV3_26_0;
883
+ }
884
+ export interface AwsLambdaResolverOptionsV3_26_0 {
885
+ [k: string]: any;
886
+ }
887
+ /**
888
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
889
+ * via the `definition` "parameterConfigForAwsLambda".
890
+ */
891
+ export interface ParameterConfigForAwsLambdaV3_26_0 {
892
+ ops: ParameterOpListV3_26_0;
893
+ serialize: ParameterSerializeConfigForPathParamsV3_26_0;
894
+ }
895
+ /**
896
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
897
+ * via the `definition` "salsifyResolver".
898
+ */
899
+ export interface SalsifyResolverV3_26_0 {
900
+ if?: string;
901
+ id?: string;
902
+ name: SalsifyResolverNameV3_26_0;
903
+ /**
904
+ * Configuration for a service to use with this resolver.
905
+ */
906
+ service: string;
907
+ options?: SalsifyResolverOptionsV3_26_0;
908
+ args?: ParameterConfigForJsonV3_26_0;
909
+ results?: ParameterConfigForJsonV3_26_0;
910
+ argsMapping?: ArgsMappingV3_26_0;
911
+ resultsMapping?: ResultsMappingV3_26_0;
912
+ }
913
+ export interface SalsifyResolverOptionsV3_26_0 {
914
+ [k: string]: any;
915
+ }
916
+ /**
917
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
918
+ * via the `definition` "composeResolver".
919
+ */
920
+ export interface ComposeResolverV3_26_0 {
921
+ compose: BasicResolverV3_26_0[];
922
+ resultsMapping?: DirectiveMappingMapV3_26_0 | DirectiveConfigV3_26_0;
923
+ results?: ParameterConfigForJsonV3_26_0;
924
+ }
925
+ /**
926
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
927
+ * via the `definition` "shapeMap".
928
+ */
929
+ export interface ShapeMapV3_26_0 {
930
+ [k: string]: ShapeV3_26_0;
931
+ }
932
+ /**
933
+ * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
934
+ *
935
+ * This interface was referenced by `ShapeMapV3_26_0`'s JSON-Schema definition
936
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
937
+ *
938
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
939
+ * via the `definition` "shape".
940
+ */
941
+ export interface ShapeV3_26_0 {
942
+ /**
943
+ * The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations
944
+ */
945
+ name: string;
946
+ /**
947
+ * The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used database as a stable "table name" and changing it will result in orphaning that data.
948
+ */
949
+ id: string;
950
+ /**
951
+ * The human-readable name for a Shape for use in a UI.
952
+ */
953
+ title: string;
954
+ description?: string;
955
+ type?: 'interface' | 'input' | 'output';
956
+ interfaces?: string[];
957
+ /**
958
+ * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
959
+ */
960
+ model?: {
961
+ type: ModelTypeV3_26_0;
962
+ };
963
+ workflow?: string;
964
+ schema: ShapeSchemaV3_26_0;
965
+ }
966
+ /**
967
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
968
+ * via the `definition` "shapeSchemaAllOf".
969
+ */
970
+ export interface ShapeSchemaAllOfV3_26_0 {
971
+ allOf: ObjectOrRefArrayV3_26_0;
972
+ }
973
+ /**
974
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
975
+ * via the `definition` "shapeSchemaExtends".
976
+ */
977
+ export interface ShapeSchemaExtendsV3_26_0 {
978
+ extends: ObjectOrRefArrayV3_26_0;
979
+ }
980
+ /**
981
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
982
+ * via the `definition` "shapeSchemaOneOf".
983
+ */
984
+ export interface ShapeSchemaOneOfV3_26_0 {
985
+ oneOf: ObjectOrRefArrayV3_26_0;
986
+ }
987
+ /**
988
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
989
+ * via the `definition` "shapeSchemaEnum".
990
+ */
991
+ export interface ShapeSchemaEnumV3_26_0 {
992
+ enum: string[];
993
+ }
994
+ /**
995
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
996
+ * via the `definition` "indexedShapeMap".
997
+ */
998
+ export interface IndexedShapeMapV3_26_0 {
999
+ [k: string]: IndexedShapeConfigV3_26_0;
1000
+ }
1001
+ /**
1002
+ * This interface was referenced by `IndexedShapeMapV3_26_0`'s JSON-Schema definition
1003
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1004
+ *
1005
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1006
+ * via the `definition` "indexedShapeConfig".
1007
+ */
1008
+ export interface IndexedShapeConfigV3_26_0 {
1009
+ idField?: string;
1010
+ searchSummaryField?: string;
1011
+ query?: IndexedShapeQueryConfigV3_26_0;
1012
+ queries: IndexedShapeQueriesConfigV3_26_0;
1013
+ triggers: IndexedShapeTriggersConfigV3_26_0[];
1014
+ }
1015
+ /**
1016
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1017
+ * via the `definition` "indexedShapeQueryConfig".
1018
+ */
1019
+ export interface IndexedShapeQueryConfigV3_26_0 {
1020
+ ignoreFields?: string[];
1021
+ maxDepth?: number;
1022
+ selectionSet?: string;
1023
+ }
1024
+ /**
1025
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1026
+ * via the `definition` "indexedShapeQueriesConfig".
1027
+ */
1028
+ export interface IndexedShapeQueriesConfigV3_26_0 {
1029
+ list?: IndexedShapeListQueryConfigV3_26_0;
1030
+ get?: IndexedShapeGetQueryConfigV3_26_0;
1031
+ }
1032
+ /**
1033
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1034
+ * via the `definition` "indexedShapeListQueryConfig".
1035
+ */
1036
+ export interface IndexedShapeListQueryConfigV3_26_0 {
1037
+ name: string;
1038
+ pagination?: PaginationConfigV3_26_0;
1039
+ }
1040
+ /**
1041
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1042
+ * via the `definition` "paginationCursorConfig".
1043
+ */
1044
+ export interface PaginationCursorConfigV3_26_0 {
1045
+ type: 'cursor';
1046
+ cursorArg: string;
1047
+ cursorPath: string;
1048
+ pageSize?: number;
1049
+ pageSizeArg: string;
1050
+ hasMorePath: string;
1051
+ itemsToIndexPath: string;
1052
+ }
1053
+ /**
1054
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1055
+ * via the `definition` "paginationPageConfig".
1056
+ */
1057
+ export interface PaginationPageConfigV3_26_0 {
1058
+ type: 'page';
1059
+ pageArg: string;
1060
+ pageSize?: number;
1061
+ pageSizeArg?: string;
1062
+ itemsToIndexPath: string;
1063
+ pageTotalPath: string;
1064
+ }
1065
+ /**
1066
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1067
+ * via the `definition` "paginationOffsetConfig".
1068
+ */
1069
+ export interface PaginationOffsetConfigV3_26_0 {
1070
+ type: 'offset';
1071
+ offsetArg: string;
1072
+ pageSize?: number;
1073
+ pageSizeArg?: string;
1074
+ itemsToIndexPath: string;
1075
+ itemTotalPath: string;
1076
+ }
1077
+ /**
1078
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1079
+ * via the `definition` "indexedShapeGetQueryConfig".
1080
+ */
1081
+ export interface IndexedShapeGetQueryConfigV3_26_0 {
1082
+ name: string;
1083
+ idArg?: string;
1084
+ }
1085
+ /**
1086
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1087
+ * via the `definition` "indexedShapeScheduleTriggerConfig".
1088
+ */
1089
+ export interface IndexedShapeScheduleTriggerConfigV3_26_0 {
1090
+ type: 'schedule';
1091
+ query: 'get' | 'list';
1092
+ interval: number;
1093
+ }
1094
+ /**
1095
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1096
+ * via the `definition` "indexedShapeWebhookTriggerConfig".
1097
+ */
1098
+ export interface IndexedShapeWebhookTriggerConfigV3_26_0 {
1099
+ type: 'webhook';
1100
+ query: 'get' | 'list';
1101
+ service: string;
1102
+ events: string[];
1103
+ }
1104
+ /**
1105
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1106
+ * via the `definition` "formMap".
1107
+ */
1108
+ export interface FormMapV3_26_0 {
1109
+ [k: string]: FormsConfigV3_26_0;
1110
+ }
1111
+ /**
1112
+ * This interface was referenced by `FormMapV3_26_0`'s JSON-Schema definition
1113
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1114
+ *
1115
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1116
+ * via the `definition` "formsConfig".
1117
+ */
1118
+ export interface FormsConfigV3_26_0 {
1119
+ default: FormConfigV3_26_0;
1120
+ [k: string]: FormConfigV3_26_0;
1121
+ }
1122
+ /**
1123
+ * This interface was referenced by `FormsConfigV3_26_0`'s JSON-Schema definition
1124
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1125
+ *
1126
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1127
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1128
+ *
1129
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1130
+ * via the `definition` "formConfig".
1131
+ */
1132
+ export interface FormConfigV3_26_0 {
1133
+ [k: string]: any;
1134
+ }
1135
+ /**
1136
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1137
+ * via the `definition` "workflowMap".
1138
+ */
1139
+ export interface WorkflowMapV3_26_0 {
1140
+ [k: string]: WorkflowV3_26_0;
1141
+ }
1142
+ /**
1143
+ * This interface was referenced by `WorkflowMapV3_26_0`'s JSON-Schema definition
1144
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1145
+ *
1146
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1147
+ * via the `definition` "workflow".
1148
+ */
1149
+ export interface WorkflowV3_26_0 {
1150
+ /**
1151
+ * machine-readable id
1152
+ */
1153
+ name: string;
1154
+ title: WorkflowNameV3_26_0;
1155
+ steps: StepsV3_26_0;
1156
+ [k: string]: any;
1157
+ }
1158
+ /**
1159
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1160
+ * via the `definition` "workflowStep".
1161
+ */
1162
+ export interface WorkflowStepV3_26_0 {
1163
+ name: NameV3_26_0;
1164
+ title: TitleV3_26_0;
1165
+ description?: DescriptionV3_26_0;
1166
+ color: ColorV3_26_0;
1167
+ live: LiveV3_26_0;
1168
+ key: KeyV3_26_0;
1169
+ }
1170
+ /**
1171
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1172
+ * via the `definition` "storedServiceMap".
1173
+ */
1174
+ export interface StoredServiceMapV3_26_0 {
1175
+ [k: string]: StoredServiceConfigV3_26_0;
1176
+ }
1177
+ /**
1178
+ * This interface was referenced by `StoredServiceMapV3_26_0`'s JSON-Schema definition
1179
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1180
+ *
1181
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1182
+ * via the `definition` "storedServiceConfig".
1183
+ */
1184
+ export interface StoredServiceConfigV3_26_0 {
1185
+ /**
1186
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
1187
+ */
1188
+ id: string;
1189
+ /**
1190
+ * Human-readable name for this service.
1191
+ */
1192
+ title: string;
1193
+ /**
1194
+ * The service provider id.
1195
+ */
1196
+ provider: string;
1197
+ /**
1198
+ * A namespace to use for the imported types tied to this service.
1199
+ */
1200
+ namespace?: string;
1201
+ serviceType: ServiceTypeV3_26_0;
1202
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
1203
+ authentication?: string;
1204
+ webhookId?: string;
1205
+ /**
1206
+ * Configuration options passed to and handled by the provider.
1207
+ */
1208
+ options?: {
1209
+ [k: string]: any;
1210
+ };
1211
+ }
1212
+ /**
1213
+ * All possible options for the more specific ParameterSerializeStyleOptions types.
1214
+ *
1215
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1216
+ * via the `definition` "parameterSerializeStyleOptions".
1217
+ */
1218
+ export interface ParameterSerializeStyleOptionsV3_26_0 {
1219
+ style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
1220
+ explode?: boolean;
1221
+ allowEmptyValue?: boolean;
1222
+ /**
1223
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1224
+ */
1225
+ allowReserved?: boolean;
1226
+ skipEncoding?: boolean;
1227
+ }
1228
+ /**
1229
+ * All possible options for the more specific ParameterSerializeConfig types.
1230
+ *
1231
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1232
+ * via the `definition` "parameterSerializeConfig".
1233
+ */
1234
+ export interface ParameterSerializeConfigV3_26_0 {
1235
+ content?: ParameterSerializeContentOptionsV3_26_0;
1236
+ defaults?: ParameterSerializeOptionsV3_26_0;
1237
+ paths?: {
1238
+ [k: string]: ParameterSerializeOptionsV3_26_0;
1239
+ };
1240
+ }
1241
+ /**
1242
+ * All possible options for the more specific ParameterConfig types.
1243
+ *
1244
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1245
+ * via the `definition` "parameterConfig".
1246
+ */
1247
+ export interface ParameterConfigV3_26_0 {
1248
+ ops: ParameterOpListV3_26_0;
1249
+ serialize?: ParameterSerializeConfigV3_26_0;
1250
+ }
1251
+ /**
1252
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1253
+ * via the `definition` "formScalarConfig".
1254
+ */
1255
+ export interface FormScalarConfigV3_26_0 {
1256
+ widget: string;
1257
+ }
1258
+ /**
1259
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1260
+ * via the `definition` "formObjectConfig".
1261
+ */
1262
+ export interface FormObjectConfigV3_26_0 {
1263
+ widget?: string;
1264
+ order?: string[];
1265
+ properties?: {
1266
+ [k: string]: FormConfigV3_26_0;
1267
+ };
1268
+ }
1269
+ /**
1270
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1271
+ * via the `definition` "formArrayConfig".
1272
+ */
1273
+ export interface FormArrayConfigV3_26_0 {
1274
+ widget: string;
1275
+ items: FormConfigV3_26_0;
1276
+ }
1277
+ /**
1278
+ * For use with a custom auth handler on a service provider.
1279
+ *
1280
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1281
+ * via the `definition` "customAuthentication".
1282
+ */
1283
+ export interface CustomAuthenticationV3_26_0 {
1284
+ type: 'custom';
1285
+ [k: string]: any;
1286
+ }
1287
+ /**
1288
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1289
+ * via the `definition` "searchParamsAuthentication".
1290
+ */
1291
+ export interface SearchParamsAuthenticationV3_26_0 {
1292
+ type: 'searchParams';
1293
+ params: {
1294
+ name: string;
1295
+ value: string;
1296
+ }[];
1297
+ }
1298
+ /**
1299
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1300
+ * via the `definition` "bearerAuthentication".
1301
+ */
1302
+ export interface BearerAuthenticationV3_26_0 {
1303
+ type: 'bearer';
1304
+ token: string;
1305
+ prefix?: string;
1306
+ header?: string;
1307
+ }
1308
+ /**
1309
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1310
+ * via the `definition` "oauth2BearerAuthentication".
1311
+ */
1312
+ export interface OAuth2BearerAuthenticationV3_26_0 {
1313
+ type: 'oauth2Bearer';
1314
+ token: string;
1315
+ prefix?: string;
1316
+ header?: string;
1317
+ scope?: string;
1318
+ expiresAt?: string;
1319
+ }
1320
+ /**
1321
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1322
+ * via the `definition` "basicAuthentication".
1323
+ */
1324
+ export interface BasicAuthenticationV3_26_0 {
1325
+ type: 'basic';
1326
+ username: string;
1327
+ password: string;
1328
+ useIso8859?: boolean;
1329
+ }
1330
+ /**
1331
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1332
+ * via the `definition` "oauth2Authentication".
1333
+ */
1334
+ export interface OAuth2AuthenticationV3_26_0 {
1335
+ type: 'oauth2';
1336
+ grantType: 'authorizationCode' | 'clientCredentials';
1337
+ authorizationUrl?: string;
1338
+ accessTokenUrl?: string;
1339
+ clientId: string;
1340
+ clientSecret?: string;
1341
+ scope?: string;
1342
+ usePkce?: boolean;
1343
+ redirectUrl?: string;
1344
+ headerPrefix?: string;
1345
+ audience?: string;
1346
+ resource?: string;
1347
+ }
1348
+ /**
1349
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1350
+ * via the `definition` "awsAuthentication".
1351
+ */
1352
+ export interface AWSAuthenticationV3_26_0 {
1353
+ type: 'aws';
1354
+ awsAccessKeyId: string;
1355
+ awsSecretAccessKey: string;
1356
+ }
1357
+ /**
1358
+ * This interface was referenced by `ProjectSchemaV3_26_0`'s JSON-Schema
1359
+ * via the `definition` "serviceConfig".
1360
+ */
1361
+ export interface ServiceConfigV3_26_0 {
1362
+ /**
1363
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
1364
+ */
1365
+ id: string;
1366
+ /**
1367
+ * Human-readable name for this service.
1368
+ */
1369
+ title: string;
1370
+ /**
1371
+ * The service provider id.
1372
+ */
1373
+ provider: string;
1374
+ /**
1375
+ * A namespace to use for the imported types tied to this service.
1376
+ */
1377
+ namespace?: string;
1378
+ serviceType: ServiceTypeV3_26_0;
1379
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
1380
+ authentication?: ServiceAuthenticationV3_26_0;
1381
+ webhookId?: string;
1382
+ /**
1383
+ * Configuration options passed to and handled by the provider.
1384
+ */
1385
+ options?: {
1386
+ [k: string]: any;
1387
+ };
1388
+ }
1389
+ //# sourceMappingURL=v3.26.0.d.ts.map