@takeshape/schema 8.87.2 → 8.89.2

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