@takeshape/schema 8.48.2 → 8.50.6

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 (74) hide show
  1. package/es/flatten-templates.js +1 -1
  2. package/es/migration/index.js +6 -1
  3. package/es/migration/to/v3.10.0.js +54 -15
  4. package/es/migration/to/v3.12.1.js +10 -0
  5. package/es/project-schema/index.js +1 -0
  6. package/es/project-schema/v3.12.1.js +1 -0
  7. package/es/schemas/index.js +4 -3
  8. package/es/schemas/index.ts +4 -2
  9. package/es/schemas/project-schema/v3.12.1.json +2281 -0
  10. package/es/schemas/project-schema.json +2 -1
  11. package/es/template-shapes/templates.js +1 -1
  12. package/es/template-shapes/where.js +55 -19
  13. package/es/types/utils.js +2 -1
  14. package/es/validate.js +69 -4
  15. package/examples/latest/betzino.json +43364 -0
  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 +1 -1
  30. package/examples/latest/rick-and-morty-graphql.json +1 -1
  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 +1 -1
  37. package/examples/latest/stripe-starter-resolved.json +1 -1
  38. package/examples/latest/user-schema-no-required.json +1 -1
  39. package/examples/latest/user-schema-with-defaults.json +1 -1
  40. package/examples/source/betzino.json +43364 -0
  41. package/lib/flatten-templates.js +1 -1
  42. package/lib/migration/index.d.ts.map +1 -1
  43. package/lib/migration/index.js +6 -0
  44. package/lib/migration/to/v3.10.0.d.ts.map +1 -1
  45. package/lib/migration/to/v3.10.0.js +55 -15
  46. package/lib/migration/to/v3.12.1.d.ts +4 -0
  47. package/lib/migration/to/v3.12.1.d.ts.map +1 -0
  48. package/lib/migration/to/v3.12.1.js +18 -0
  49. package/lib/project-schema/index.d.ts +3 -1
  50. package/lib/project-schema/index.d.ts.map +1 -1
  51. package/lib/project-schema/index.js +28 -15
  52. package/lib/project-schema/latest.d.ts +61 -2
  53. package/lib/project-schema/latest.d.ts.map +1 -1
  54. package/lib/project-schema/v3.12.1.d.ts +1274 -0
  55. package/lib/project-schema/v3.12.1.d.ts.map +1 -0
  56. package/lib/project-schema/v3.12.1.js +5 -0
  57. package/lib/schemas/index.d.ts +2 -2
  58. package/lib/schemas/index.d.ts.map +1 -1
  59. package/lib/schemas/index.js +19 -17
  60. package/lib/schemas/index.ts +4 -2
  61. package/lib/schemas/project-schema/v3.12.1.json +2281 -0
  62. package/lib/schemas/project-schema.json +2 -1
  63. package/lib/template-shapes/templates.js +1 -1
  64. package/lib/template-shapes/where.d.ts +2 -1
  65. package/lib/template-shapes/where.d.ts.map +1 -1
  66. package/lib/template-shapes/where.js +57 -21
  67. package/lib/types/types.d.ts +2 -2
  68. package/lib/types/types.d.ts.map +1 -1
  69. package/lib/types/utils.d.ts +3 -2
  70. package/lib/types/utils.d.ts.map +1 -1
  71. package/lib/types/utils.js +4 -2
  72. package/lib/validate.d.ts.map +1 -1
  73. package/lib/validate.js +70 -4
  74. package/package.json +4 -4
@@ -0,0 +1,1274 @@
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_12_1`'s JSON-Schema
8
+ * via the `definition` "args".
9
+ */
10
+ export declare type ArgsV3_12_1 = string | ObjectSchemaV3_12_1;
11
+ /**
12
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
13
+ * via the `definition` "objectSchema".
14
+ */
15
+ export declare type ObjectSchemaV3_12_1 = PropertySchemaV3_12_1 & {
16
+ type: 'object';
17
+ properties: {
18
+ [k: string]: PropertySchemaV3_12_1;
19
+ };
20
+ };
21
+ /**
22
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
23
+ * via the `definition` "nonNegativeInteger".
24
+ */
25
+ export declare type NonNegativeIntegerV3_12_1 = number;
26
+ /**
27
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
28
+ * via the `definition` "nonNegativeIntegerDefault0".
29
+ */
30
+ export declare type NonNegativeIntegerDefault0V3_12_1 = NonNegativeIntegerV3_12_1;
31
+ /**
32
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
33
+ * via the `definition` "stringArray".
34
+ */
35
+ export declare type StringArrayV3_12_1 = string[];
36
+ /**
37
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
38
+ * via the `definition` "simpleTypes".
39
+ */
40
+ export declare type SimpleTypesV3_12_1 = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
41
+ /**
42
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
43
+ * via the `definition` "schemaArray".
44
+ */
45
+ export declare type SchemaArrayV3_12_1 = PropertySchemaV3_12_1[];
46
+ /**
47
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
48
+ * via the `definition` "fieldMapping".
49
+ */
50
+ export declare type FieldMappingV3_12_1 = MappingStringV3_12_1 | MappingStringV3_12_1[];
51
+ /**
52
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
53
+ * via the `definition` "mappingString".
54
+ */
55
+ export declare type MappingStringV3_12_1 = string;
56
+ /**
57
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
58
+ * via the `definition` "resolver".
59
+ */
60
+ export declare type ResolverV3_12_1 = BasicResolverV3_12_1 | ComposeResolverV3_12_1;
61
+ /**
62
+ * A single resolver, can be composed with the ComposeResolver.
63
+ *
64
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
65
+ * via the `definition` "basicResolver".
66
+ */
67
+ export declare type BasicResolverV3_12_1 = UtilResolverV3_12_1 | TakeshapeResolverV3_12_1 | InternalTakeshapeResolverV3_12_1 | GraphqlResolverV3_12_1 | RestResolverV3_12_1 | AwsLambdaResolverV3_12_1;
68
+ /**
69
+ * Name of the resolver function.
70
+ */
71
+ export declare type UtilResolverNameV3_12_1 = 'debug:noop' | 'util:wrap';
72
+ /**
73
+ * An object describing an operation to generate a parameter.
74
+ *
75
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
76
+ * via the `definition` "parameterOp".
77
+ */
78
+ export declare type ParameterOpV3_12_1 = ParameterOpNestedV3_12_1 | ParameterOpValueV3_12_1 | ParameterOpMappingV3_12_1 | ParameterOpOpV3_12_1;
79
+ /**
80
+ * A tuple with a string directive name, and options to pass to the directive
81
+ *
82
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
83
+ * via the `definition` "directiveConfigItem".
84
+ */
85
+ export declare type DirectiveConfigItemV3_12_1 = [DirectiveNameV3_12_1, DirectiveOptionsV3_12_1];
86
+ export declare type DirectiveNameV3_12_1 = string;
87
+ /**
88
+ * An array of individual directive config items to process in order
89
+ *
90
+ * This interface was referenced by `DirectiveMappingMapV3_12_1`'s JSON-Schema definition
91
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
92
+ *
93
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
94
+ * via the `definition` "directiveConfig".
95
+ */
96
+ export declare type DirectiveConfigV3_12_1 = DirectiveConfigItemV3_12_1[];
97
+ /**
98
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
99
+ * via the `definition` "parameterOpList".
100
+ */
101
+ export declare type ParameterOpListV3_12_1 = ParameterOpV3_12_1[];
102
+ /**
103
+ * Maps a query's input args to the input expected by the service's endpoint.
104
+ *
105
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
106
+ * via the `definition` "argsMapping".
107
+ */
108
+ export declare type ArgsMappingV3_12_1 = DirectiveMappingMapV3_12_1 | DirectiveConfigV3_12_1;
109
+ /**
110
+ * Maps a service endpoint's response results to the expected shape of the query's response.
111
+ *
112
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
113
+ * via the `definition` "resultsMapping".
114
+ */
115
+ export declare type ResultsMappingV3_12_1 = DirectiveMappingMapV3_12_1 | DirectiveConfigV3_12_1;
116
+ /**
117
+ * Name of the resolver function.
118
+ */
119
+ export declare type TakeshapeResolverNameV3_12_1 = 'takeshape:get' | 'takeshape:create' | 'takeshape:update' | 'takeshape:delete' | 'takeshape:duplicate' | 'takeshape:find' | 'takeshape:queryApiIndex';
120
+ /**
121
+ * Name of the resolver function.
122
+ */
123
+ export declare type InternalTakeshapeResolverNameV3_12_1 = 'takeshape:getRelationship' | 'takeshape:taxonomySuggest' | 'takeshape:list' | 'takeshape:search';
124
+ /**
125
+ * Name of the resolver function.
126
+ */
127
+ export declare type GraphqlResolverNameV3_12_1 = 'graphql:query' | 'graphql:mutation';
128
+ /**
129
+ * Name of the resolver function.
130
+ */
131
+ export declare type RestResolverNameV3_12_1 = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
132
+ /**
133
+ * A tuple with a string key and a directive config to evaluate
134
+ *
135
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
136
+ * via the `definition` "directiveMappingArrayItem".
137
+ */
138
+ export declare type DirectiveMappingArrayItemV3_12_1 = [string, DirectiveConfigV3_12_1];
139
+ /**
140
+ * An array of key / value or directive config tuples
141
+ */
142
+ export declare type SearchParamsMappingV3_12_1 = DirectiveMappingArrayItemV3_12_1[];
143
+ /**
144
+ * Name of the resolver function.
145
+ */
146
+ export declare type AwsLambdaResolverNameV3_12_1 = 'awsLambda:invoke';
147
+ /**
148
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
149
+ * via the `definition` "ref".
150
+ */
151
+ export declare type RefV3_12_1 = string;
152
+ /**
153
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
154
+ * via the `definition` "returnShape".
155
+ */
156
+ export declare type ReturnShapeV3_12_1 = string | ReturnShapeArraySchemaV3_12_1;
157
+ /**
158
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
159
+ * via the `definition` "returnShapeArraySchema".
160
+ */
161
+ export declare type ReturnShapeArraySchemaV3_12_1 = PropertySchemaV3_12_1 & {
162
+ type: 'array';
163
+ items: RefSchemaV3_12_1 | {
164
+ type: 'boolean' | 'integer' | 'number' | 'string';
165
+ [k: string]: any;
166
+ };
167
+ };
168
+ export declare type ModelTypeV3_12_1 = 'single' | 'multiple' | 'taxonomy';
169
+ /**
170
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
171
+ * via the `definition` "shapeSchema".
172
+ */
173
+ export declare type ShapeSchemaV3_12_1 = ShapeSchemaAllOfV3_12_1 | ShapeSchemaOneOfV3_12_1 | ShapeSchemaEnumV3_12_1 | ObjectSchemaV3_12_1;
174
+ /**
175
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
176
+ * via the `definition` "paginationConfig".
177
+ */
178
+ export declare type PaginationConfigV3_12_1 = PaginationCursorConfigV3_12_1 | PaginationPageConfigV3_12_1 | PaginationOffsetConfigV3_12_1;
179
+ /**
180
+ * Human-readable id for use in the UI
181
+ */
182
+ export declare type WorkflowNameV3_12_1 = string;
183
+ /**
184
+ * machine-readable slug
185
+ */
186
+ export declare type NameV3_12_1 = string;
187
+ /**
188
+ * Human-readable id for use in the UI
189
+ */
190
+ export declare type TitleV3_12_1 = string;
191
+ export declare type DescriptionV3_12_1 = string;
192
+ /**
193
+ * Hex color code
194
+ */
195
+ export declare type ColorV3_12_1 = string;
196
+ /**
197
+ * Value to indicate whether items in the state should be returned in list queries
198
+ */
199
+ export declare type LiveV3_12_1 = boolean;
200
+ /**
201
+ * machine-readable id
202
+ */
203
+ export declare type KeyV3_12_1 = string;
204
+ export declare type StepsV3_12_1 = WorkflowStepV3_12_1[];
205
+ /**
206
+ * The general type of this service, specifying how and where it will be utilized.
207
+ *
208
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
209
+ * via the `definition` "serviceType".
210
+ */
211
+ export declare type ServiceTypeV3_12_1 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
212
+ /**
213
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
214
+ * via the `definition` "allOfSchema".
215
+ */
216
+ export declare type AllOfSchemaV3_12_1 = PropertySchemaV3_12_1 & {
217
+ allOf: (RefSchemaV3_12_1 | RefSchemaLegacyV3_12_1 | ObjectSchemaV3_12_1)[];
218
+ };
219
+ /**
220
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
221
+ * via the `definition` "oneOfSchema".
222
+ */
223
+ export declare type OneOfSchemaV3_12_1 = PropertySchemaV3_12_1 & {
224
+ oneOf: (RefSchemaV3_12_1 | RefSchemaLegacyV3_12_1 | ObjectSchemaV3_12_1)[];
225
+ };
226
+ /**
227
+ * Options to be passed to the serialization routine.
228
+ *
229
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
230
+ * via the `definition` "parameterSerializeOptions".
231
+ *
232
+ * This interface was referenced by `undefined`'s JSON-Schema definition
233
+ * via the `patternProperty` "^[^\n\r]*$".
234
+ */
235
+ export declare type ParameterSerializeOptionsV3_12_1 = ParameterSerializeStyleOptionsV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
236
+ /**
237
+ * An array of key / value or directive config tuples
238
+ *
239
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
240
+ * via the `definition` "directiveMappingArray".
241
+ */
242
+ export declare type DirectiveMappingArrayV3_12_1 = DirectiveMappingArrayItemV3_12_1[];
243
+ /**
244
+ * An array of key / value or directive config tuples
245
+ *
246
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
247
+ * via the `definition` "searchParamsMapping".
248
+ */
249
+ export declare type SearchParamsMappingV3_12_11 = DirectiveMappingArrayItemV3_12_1[];
250
+ /**
251
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
252
+ * via the `definition` "shapeWithObjectSchema".
253
+ */
254
+ export declare type ShapeWithObjectSchemaV3_12_1 = ShapeV3_12_1 & {
255
+ schema: ObjectSchemaV3_12_1;
256
+ };
257
+ /**
258
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
259
+ * via the `definition` "serviceAuthentication".
260
+ */
261
+ export declare type ServiceAuthenticationV3_12_1 = OAuth2AuthenticationV3_12_1 | OAuth2BearerAuthenticationV3_12_1 | BearerAuthenticationV3_12_1 | BasicAuthenticationV3_12_1 | SearchParamsAuthenticationV3_12_1 | AWSAuthenticationV3_12_1 | CustomAuthenticationV3_12_1;
262
+ /**
263
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
264
+ * via the `definition` "anyServiceConfig".
265
+ */
266
+ export declare type AnyServiceConfigV3_12_1 = StoredServiceConfigV3_12_1 | ServiceConfigV3_12_1;
267
+ export interface ProjectSchemaV3_12_1 {
268
+ $schema?: string;
269
+ /**
270
+ * This is the revision number of your schema. Every time your project schema is updated, this value should be incremented.
271
+ */
272
+ version: number;
273
+ /**
274
+ * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
275
+ */
276
+ apiVersion: string;
277
+ /**
278
+ * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
279
+ */
280
+ schemaVersion: '3.12.1';
281
+ /**
282
+ * The ID of the TakeShape project this schema belongs to.
283
+ */
284
+ projectId: string;
285
+ /**
286
+ * The ID of the TakeShape user who created the schema.
287
+ */
288
+ author?: string;
289
+ /**
290
+ * The date the schema was created
291
+ */
292
+ created: string;
293
+ /**
294
+ * The date the schema was last updated
295
+ */
296
+ updated: string;
297
+ deactivated?: number;
298
+ /**
299
+ * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
300
+ */
301
+ defaultLocale: string;
302
+ locales: string[];
303
+ queries: QueryMapV3_12_1;
304
+ mutations: QueryMapV3_12_1;
305
+ shapes: ShapeMapV3_12_1;
306
+ indexedShapes?: IndexedShapeMapV3_12_1;
307
+ forms?: FormMapV3_12_1;
308
+ workflows: WorkflowMapV3_12_1;
309
+ dataKey: string;
310
+ services?: StoredServiceMapV3_12_1;
311
+ }
312
+ /**
313
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
314
+ * via the `definition` "queryMap".
315
+ */
316
+ export interface QueryMapV3_12_1 {
317
+ [k: string]: QueryV3_12_1;
318
+ }
319
+ /**
320
+ * This interface was referenced by `QueryMapV3_12_1`'s JSON-Schema definition
321
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
322
+ *
323
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
324
+ * via the `definition` "query".
325
+ */
326
+ export interface QueryV3_12_1 {
327
+ args?: ArgsV3_12_1;
328
+ resolver: ResolverV3_12_1;
329
+ shape: ReturnShapeV3_12_1;
330
+ /**
331
+ * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
332
+ */
333
+ description?: string;
334
+ [k: string]: any;
335
+ }
336
+ /**
337
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
338
+ * via the `definition` "propertySchema".
339
+ */
340
+ export interface PropertySchemaV3_12_1 {
341
+ $ref?: string;
342
+ title?: string;
343
+ description?: string;
344
+ default?: any;
345
+ readOnly?: boolean;
346
+ multipleOf?: number;
347
+ maximum?: number;
348
+ exclusiveMaximum?: number;
349
+ minimum?: number;
350
+ exclusiveMinimum?: number;
351
+ maxLength?: NonNegativeIntegerV3_12_1;
352
+ minLength?: NonNegativeIntegerDefault0V3_12_1;
353
+ pattern?: string;
354
+ additionalItems?: PropertySchemaV3_12_1;
355
+ items?: PropertySchemaV3_12_1;
356
+ maxItems?: NonNegativeIntegerV3_12_1;
357
+ minItems?: NonNegativeIntegerDefault0V3_12_1;
358
+ uniqueItems?: boolean;
359
+ contains?: PropertySchemaV3_12_1;
360
+ maxProperties?: NonNegativeIntegerV3_12_1;
361
+ minProperties?: NonNegativeIntegerDefault0V3_12_1;
362
+ required?: StringArrayV3_12_1;
363
+ additionalProperties?: PropertySchemaV3_12_1 | false;
364
+ definitions?: {
365
+ [k: string]: PropertySchemaV3_12_1;
366
+ };
367
+ properties?: {
368
+ [k: string]: PropertySchemaV3_12_1;
369
+ };
370
+ const?: any;
371
+ enum?: any[];
372
+ type?: SimpleTypesV3_12_1 | SimpleTypesV3_12_1[];
373
+ format?: string;
374
+ contentMediaType?: string;
375
+ contentEncoding?: string;
376
+ allOf?: SchemaArrayV3_12_1;
377
+ oneOf?: SchemaArrayV3_12_1;
378
+ '@relationship'?: RelationshipV3_12_1;
379
+ '@syncLocaleStructure'?: boolean;
380
+ '@sensitive'?: boolean;
381
+ '@draftjs'?: boolean;
382
+ '@l10n'?: boolean;
383
+ '@key'?: string;
384
+ '@workflow'?: string;
385
+ '@mapping'?: FieldMappingV3_12_1;
386
+ '@tag'?: string;
387
+ '@tags'?: string[];
388
+ '@deprecationReason'?: string;
389
+ '@user'?: boolean;
390
+ '@args'?: ArgsV3_12_1;
391
+ '@resolver'?: ResolverV3_12_1;
392
+ '@ref'?: RefV3_12_1;
393
+ '@derivedFrom'?: string;
394
+ }
395
+ /**
396
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
397
+ * via the `definition` "relationship".
398
+ */
399
+ export interface RelationshipV3_12_1 {
400
+ shapeIds: string[];
401
+ type?: string;
402
+ relatedName?: string;
403
+ }
404
+ /**
405
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
406
+ * via the `definition` "utilResolver".
407
+ */
408
+ export interface UtilResolverV3_12_1 {
409
+ if?: string;
410
+ id?: string;
411
+ name: UtilResolverNameV3_12_1;
412
+ /**
413
+ * Configuration for a service to use with this resolver.
414
+ */
415
+ service: string;
416
+ options?: UtilResolverOptionsV3_12_1;
417
+ args?: ParameterConfigForJsonV3_12_1;
418
+ results?: ParameterConfigForJsonV3_12_1;
419
+ argsMapping?: ArgsMappingV3_12_1;
420
+ resultsMapping?: ResultsMappingV3_12_1;
421
+ }
422
+ export interface UtilResolverOptionsV3_12_1 {
423
+ [k: string]: any;
424
+ }
425
+ /**
426
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
427
+ * via the `definition` "parameterConfigForJson".
428
+ */
429
+ export interface ParameterConfigForJsonV3_12_1 {
430
+ ops: ParameterOpListV3_12_1;
431
+ }
432
+ /**
433
+ * An object describing an operation to generate a parameter, using a nested OpList.
434
+ *
435
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
436
+ * via the `definition` "parameterOpNested".
437
+ */
438
+ export interface ParameterOpNestedV3_12_1 {
439
+ /**
440
+ * A path to the parameter for this operation.
441
+ */
442
+ path: string;
443
+ /**
444
+ * A mode for this parameter's operation.
445
+ */
446
+ op?: 'set' | 'concat' | 'extend' | 'remove';
447
+ ops: ParameterOpListV3_12_1;
448
+ }
449
+ /**
450
+ * An object describing an operation to generate a parameter using a value.
451
+ *
452
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
453
+ * via the `definition` "parameterOpValue".
454
+ */
455
+ export interface ParameterOpValueV3_12_1 {
456
+ /**
457
+ * A path to the parameter for this operation.
458
+ */
459
+ path: string;
460
+ /**
461
+ * A mode for this parameter's operation.
462
+ */
463
+ op?: 'set' | 'concat' | 'extend' | 'remove';
464
+ /**
465
+ * A value to set directly at this path.
466
+ */
467
+ value: number | string | boolean | {
468
+ [k: string]: any;
469
+ } | any[] | null;
470
+ }
471
+ /**
472
+ * An object describing an operation to generate a parameter using a mapping.
473
+ *
474
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
475
+ * via the `definition` "parameterOpMapping".
476
+ */
477
+ export interface ParameterOpMappingV3_12_1 {
478
+ /**
479
+ * A path to the parameter for this operation.
480
+ */
481
+ path: string;
482
+ /**
483
+ * A mode for this parameter's operation.
484
+ */
485
+ op?: 'set' | 'concat' | 'extend' | 'remove';
486
+ /**
487
+ * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
488
+ */
489
+ mapping: string | DirectiveConfigV3_12_1;
490
+ }
491
+ export interface DirectiveOptionsV3_12_1 {
492
+ [k: string]: any;
493
+ }
494
+ /**
495
+ * An object describing an operation to generate a parameter using a mapping.
496
+ *
497
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
498
+ * via the `definition` "parameterOpOp".
499
+ */
500
+ export interface ParameterOpOpV3_12_1 {
501
+ /**
502
+ * A path to the parameter for this operation.
503
+ */
504
+ path: string;
505
+ /**
506
+ * A mode for this parameter's operation.
507
+ */
508
+ op: 'set' | 'concat' | 'extend' | 'remove';
509
+ }
510
+ /**
511
+ * An map of object keys / key paths to directive configs
512
+ *
513
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
514
+ * via the `definition` "directiveMappingMap".
515
+ */
516
+ export interface DirectiveMappingMapV3_12_1 {
517
+ [k: string]: DirectiveConfigV3_12_1;
518
+ }
519
+ /**
520
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
521
+ * via the `definition` "takeshapeResolver".
522
+ */
523
+ export interface TakeshapeResolverV3_12_1 {
524
+ if?: string;
525
+ id?: string;
526
+ name: TakeshapeResolverNameV3_12_1;
527
+ /**
528
+ * Internal service identifier.
529
+ */
530
+ service: 'takeshape:local';
531
+ options?: TakeshapeResolverOptionsV3_12_1;
532
+ argsMapping?: ArgsMappingV3_12_1;
533
+ resultsMapping?: ResultsMappingV3_12_1;
534
+ /**
535
+ * A Shape name for the resolver to use.
536
+ */
537
+ shapeName: string;
538
+ args?: ParameterConfigForJsonV3_12_1;
539
+ results?: ParameterConfigForJsonV3_12_1;
540
+ }
541
+ export interface TakeshapeResolverOptionsV3_12_1 {
542
+ [k: string]: any;
543
+ }
544
+ /**
545
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
546
+ * via the `definition` "internalTakeshapeResolver".
547
+ */
548
+ export interface InternalTakeshapeResolverV3_12_1 {
549
+ if?: string;
550
+ id?: string;
551
+ name: InternalTakeshapeResolverNameV3_12_1;
552
+ /**
553
+ * Internal service identifier.
554
+ */
555
+ service: 'takeshape:local';
556
+ options?: TakeshapeResolverOptionsV3_12_11;
557
+ /**
558
+ * An optional Shape name for the resolver.
559
+ */
560
+ shapeName?: string;
561
+ args?: ParameterConfigForJsonV3_12_1;
562
+ results?: ParameterConfigForJsonV3_12_1;
563
+ argsMapping?: ArgsMappingV3_12_1;
564
+ resultsMapping?: ResultsMappingV3_12_1;
565
+ }
566
+ export interface TakeshapeResolverOptionsV3_12_11 {
567
+ [k: string]: any;
568
+ }
569
+ /**
570
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
571
+ * via the `definition` "graphqlResolver".
572
+ */
573
+ export interface GraphqlResolverV3_12_1 {
574
+ if?: string;
575
+ id?: string;
576
+ name: GraphqlResolverNameV3_12_1;
577
+ /**
578
+ * Configuration for a service to use with this resolver.
579
+ */
580
+ service: string;
581
+ argsMapping?: ArgsMappingV3_12_1;
582
+ resultsMapping?: ResultsMappingV3_12_1;
583
+ options?: GraphqlResolverOptionsV3_12_1;
584
+ /**
585
+ * A fieldname to use in queries.
586
+ */
587
+ fieldName: string;
588
+ headers?: ParameterConfigForHeadersV3_12_1;
589
+ searchParams?: ParameterConfigForSearchParamsV3_12_1;
590
+ args?: ParameterConfigForJsonV3_12_1;
591
+ results?: ParameterConfigForJsonV3_12_1;
592
+ }
593
+ export interface GraphqlResolverOptionsV3_12_1 {
594
+ selectionSet?: string;
595
+ unboxParentSelectionSet?: boolean;
596
+ ignoreErrors?: boolean;
597
+ skipWhenMissingArgs?: boolean;
598
+ ttl?: number;
599
+ timeout?: number;
600
+ retry?: number | {
601
+ [k: string]: any;
602
+ };
603
+ [k: string]: any;
604
+ }
605
+ /**
606
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
607
+ * via the `definition` "parameterConfigForHeaders".
608
+ */
609
+ export interface ParameterConfigForHeadersV3_12_1 {
610
+ ops: ParameterOpListV3_12_1;
611
+ serialize?: ParameterSerializeConfigForHeadersV3_12_1;
612
+ }
613
+ /**
614
+ * Top-level paths to use headers serialization options for.
615
+ *
616
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
617
+ * via the `definition` "parameterSerializeConfigForHeaders".
618
+ */
619
+ export interface ParameterSerializeConfigForHeadersV3_12_1 {
620
+ defaults?: ParameterSerializeStyleOptionsForHeadersV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
621
+ paths?: {
622
+ /**
623
+ * This interface was referenced by `undefined`'s JSON-Schema definition
624
+ * via the `patternProperty` "^[^\n\r]*$".
625
+ */
626
+ [k: string]: ParameterSerializeStyleOptionsForHeadersV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
627
+ };
628
+ }
629
+ /**
630
+ * Options to be passed to the serialization routine.
631
+ *
632
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
633
+ * via the `definition` "parameterSerializeStyleOptionsForHeaders".
634
+ */
635
+ export interface ParameterSerializeStyleOptionsForHeadersV3_12_1 {
636
+ style: 'simple' | 'none';
637
+ explode?: boolean;
638
+ }
639
+ /**
640
+ * Options to be passed to the serialization routine.
641
+ *
642
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
643
+ * via the `definition` "parameterSerializeContentOptions".
644
+ */
645
+ export interface ParameterSerializeContentOptionsV3_12_1 {
646
+ contentType: string;
647
+ /**
648
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
649
+ */
650
+ allowReserved?: boolean;
651
+ skipEncoding?: boolean;
652
+ /**
653
+ * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
654
+ */
655
+ options?: {
656
+ [k: string]: any;
657
+ };
658
+ }
659
+ /**
660
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
661
+ * via the `definition` "parameterConfigForSearchParams".
662
+ */
663
+ export interface ParameterConfigForSearchParamsV3_12_1 {
664
+ ops: ParameterOpListV3_12_1;
665
+ serialize?: ParameterSerializeConfigForSearchParamsV3_12_1;
666
+ }
667
+ /**
668
+ * Top-level paths to use search params serialization options for.
669
+ *
670
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
671
+ * via the `definition` "parameterSerializeConfigForSearchParams".
672
+ */
673
+ export interface ParameterSerializeConfigForSearchParamsV3_12_1 {
674
+ defaults?: ParameterSerializeStyleOptionsForSearchParamsV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
675
+ paths?: {
676
+ /**
677
+ * This interface was referenced by `undefined`'s JSON-Schema definition
678
+ * via the `patternProperty` "^[^\n\r]*$".
679
+ */
680
+ [k: string]: ParameterSerializeStyleOptionsForSearchParamsV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
681
+ };
682
+ }
683
+ /**
684
+ * Options to be passed to the serialization routine.
685
+ *
686
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
687
+ * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
688
+ */
689
+ export interface ParameterSerializeStyleOptionsForSearchParamsV3_12_1 {
690
+ style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
691
+ explode?: boolean;
692
+ allowEmptyValue?: boolean;
693
+ /**
694
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
695
+ */
696
+ allowReserved?: boolean;
697
+ skipEncoding?: boolean;
698
+ }
699
+ /**
700
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
701
+ * via the `definition` "restResolver".
702
+ */
703
+ export interface RestResolverV3_12_1 {
704
+ if?: string;
705
+ id?: string;
706
+ name: RestResolverNameV3_12_1;
707
+ /**
708
+ * Configuration for a service to use with this resolver.
709
+ */
710
+ service: string;
711
+ argsMapping?: ArgsMappingV3_12_1;
712
+ searchParamsMapping?: SearchParamsMappingV3_12_1;
713
+ resultsMapping?: ResultsMappingV3_12_1;
714
+ options?: RestResolverOptionsV3_12_1;
715
+ body?: ParameterConfigForBodyV3_12_1;
716
+ form?: ParameterConfigForSearchParamsV3_12_1;
717
+ headers?: ParameterConfigForHeadersV3_12_1;
718
+ json?: ParameterConfigForJsonV3_12_1;
719
+ /**
720
+ * Mapping and serialization configuration for the path, or a simple string.
721
+ */
722
+ path: ParameterConfigForPathParamsV3_12_1 | string;
723
+ searchParams?: ParameterConfigForSearchParamsV3_12_1;
724
+ args?: ParameterConfigForJsonV3_12_1;
725
+ results?: ParameterConfigForJsonV3_12_1;
726
+ }
727
+ export interface RestResolverOptionsV3_12_1 {
728
+ trailingSlash?: boolean;
729
+ ttl?: number;
730
+ timeout?: number;
731
+ retry?: number | {
732
+ [k: string]: any;
733
+ };
734
+ [k: string]: any;
735
+ }
736
+ /**
737
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
738
+ * via the `definition` "parameterConfigForBody".
739
+ */
740
+ export interface ParameterConfigForBodyV3_12_1 {
741
+ ops: ParameterOpListV3_12_1;
742
+ serialize?: ParameterSerializeConfigForBodyV3_12_1;
743
+ }
744
+ /**
745
+ * Top-level paths to use serialization options for.
746
+ *
747
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
748
+ * via the `definition` "parameterSerializeConfigForBody".
749
+ */
750
+ export interface ParameterSerializeConfigForBodyV3_12_1 {
751
+ content?: ParameterSerializeContentOptionsV3_12_1;
752
+ }
753
+ /**
754
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
755
+ * via the `definition` "parameterConfigForPathParams".
756
+ */
757
+ export interface ParameterConfigForPathParamsV3_12_1 {
758
+ ops: ParameterOpListV3_12_1;
759
+ serialize: ParameterSerializeConfigForPathParamsV3_12_1;
760
+ }
761
+ /**
762
+ * Top-level paths to use path params serialization options for.
763
+ *
764
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
765
+ * via the `definition` "parameterSerializeConfigForPathParams".
766
+ */
767
+ export interface ParameterSerializeConfigForPathParamsV3_12_1 {
768
+ /**
769
+ * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
770
+ */
771
+ template: string;
772
+ defaults?: ParameterSerializeStyleOptionsForPathParamsV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
773
+ paths?: {
774
+ /**
775
+ * This interface was referenced by `undefined`'s JSON-Schema definition
776
+ * via the `patternProperty` "^[^\n\r]*$".
777
+ */
778
+ [k: string]: ParameterSerializeStyleOptionsForPathParamsV3_12_1 | ParameterSerializeContentOptionsV3_12_1;
779
+ };
780
+ }
781
+ /**
782
+ * Options to be passed to the serialization routine.
783
+ *
784
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
785
+ * via the `definition` "parameterSerializeStyleOptionsForPathParams".
786
+ */
787
+ export interface ParameterSerializeStyleOptionsForPathParamsV3_12_1 {
788
+ style: 'simple' | 'label' | 'matrix' | 'none';
789
+ explode?: boolean;
790
+ allowEmptyValue?: boolean;
791
+ /**
792
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
793
+ */
794
+ allowReserved?: boolean;
795
+ skipEncoding?: boolean;
796
+ }
797
+ /**
798
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
799
+ * via the `definition` "awsLambdaResolver".
800
+ */
801
+ export interface AwsLambdaResolverV3_12_1 {
802
+ if?: string;
803
+ id?: string;
804
+ name: AwsLambdaResolverNameV3_12_1;
805
+ /**
806
+ * Configuration for a service to use with this resolver.
807
+ */
808
+ service: string;
809
+ options?: AwsLambdaResolverOptionsV3_12_1;
810
+ payload?: ParameterConfigForJsonV3_12_1;
811
+ /**
812
+ * Mapping configuration for the FunctionName.
813
+ */
814
+ functionName: string | ParameterConfigForAwsLambdaV3_12_1;
815
+ clientContext?: ParameterConfigForJsonV3_12_1;
816
+ args?: ParameterConfigForJsonV3_12_1;
817
+ results?: ParameterConfigForJsonV3_12_1;
818
+ argsMapping?: ArgsMappingV3_12_1;
819
+ searchParamsMapping?: SearchParamsMappingV3_12_1;
820
+ resultsMapping?: ResultsMappingV3_12_1;
821
+ }
822
+ export interface AwsLambdaResolverOptionsV3_12_1 {
823
+ [k: string]: any;
824
+ }
825
+ /**
826
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
827
+ * via the `definition` "parameterConfigForAwsLambda".
828
+ */
829
+ export interface ParameterConfigForAwsLambdaV3_12_1 {
830
+ ops: ParameterOpListV3_12_1;
831
+ serialize: ParameterSerializeConfigForPathParamsV3_12_1;
832
+ }
833
+ /**
834
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
835
+ * via the `definition` "composeResolver".
836
+ */
837
+ export interface ComposeResolverV3_12_1 {
838
+ compose: BasicResolverV3_12_1[];
839
+ resultsMapping?: DirectiveMappingMapV3_12_1 | DirectiveConfigV3_12_1;
840
+ results?: ParameterConfigForJsonV3_12_1;
841
+ }
842
+ /**
843
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
844
+ * via the `definition` "refSchema".
845
+ */
846
+ export interface RefSchemaV3_12_1 {
847
+ '@ref': RefV3_12_1;
848
+ [k: string]: any;
849
+ }
850
+ /**
851
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
852
+ * via the `definition` "shapeMap".
853
+ */
854
+ export interface ShapeMapV3_12_1 {
855
+ [k: string]: ShapeV3_12_1;
856
+ }
857
+ /**
858
+ * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
859
+ *
860
+ * This interface was referenced by `ShapeMapV3_12_1`'s JSON-Schema definition
861
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
862
+ *
863
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
864
+ * via the `definition` "shape".
865
+ */
866
+ export interface ShapeV3_12_1 {
867
+ /**
868
+ * 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
869
+ */
870
+ name: string;
871
+ /**
872
+ * 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.
873
+ */
874
+ id: string;
875
+ /**
876
+ * The human-readable name for a Shape for use in a UI.
877
+ */
878
+ title: string;
879
+ description?: string;
880
+ /**
881
+ * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
882
+ */
883
+ model?: {
884
+ type: ModelTypeV3_12_1;
885
+ };
886
+ workflow?: string;
887
+ schema: ShapeSchemaV3_12_1;
888
+ }
889
+ /**
890
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
891
+ * via the `definition` "shapeSchemaAllOf".
892
+ */
893
+ export interface ShapeSchemaAllOfV3_12_1 {
894
+ allOf: (RefSchemaV3_12_1 | RefSchemaLegacyV3_12_1 | ObjectSchemaV3_12_1)[];
895
+ }
896
+ /**
897
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
898
+ * via the `definition` "refSchemaLegacy".
899
+ */
900
+ export interface RefSchemaLegacyV3_12_1 {
901
+ $ref: RefV3_12_1;
902
+ [k: string]: any;
903
+ }
904
+ /**
905
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
906
+ * via the `definition` "shapeSchemaOneOf".
907
+ */
908
+ export interface ShapeSchemaOneOfV3_12_1 {
909
+ oneOf: (RefSchemaV3_12_1 | RefSchemaLegacyV3_12_1 | ObjectSchemaV3_12_1)[];
910
+ }
911
+ /**
912
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
913
+ * via the `definition` "shapeSchemaEnum".
914
+ */
915
+ export interface ShapeSchemaEnumV3_12_1 {
916
+ enum: string[];
917
+ }
918
+ /**
919
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
920
+ * via the `definition` "indexedShapeMap".
921
+ */
922
+ export interface IndexedShapeMapV3_12_1 {
923
+ [k: string]: IndexedShapeConfigV3_12_1;
924
+ }
925
+ /**
926
+ * This interface was referenced by `IndexedShapeMapV3_12_1`'s JSON-Schema definition
927
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
928
+ *
929
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
930
+ * via the `definition` "indexedShapeConfig".
931
+ */
932
+ export interface IndexedShapeConfigV3_12_1 {
933
+ idField?: string;
934
+ searchSummaryField?: string;
935
+ queries?: IndexedShapeQueriesConfigV3_12_1;
936
+ }
937
+ /**
938
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
939
+ * via the `definition` "indexedShapeQueriesConfig".
940
+ */
941
+ export interface IndexedShapeQueriesConfigV3_12_1 {
942
+ all: IndexedShapeQueryAllConfigV3_12_1;
943
+ }
944
+ /**
945
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
946
+ * via the `definition` "indexedShapeQueryAllConfig".
947
+ */
948
+ export interface IndexedShapeQueryAllConfigV3_12_1 {
949
+ name: string;
950
+ ignoreFields?: string[];
951
+ interval?: number;
952
+ objectDepthLimit?: number;
953
+ pagination?: PaginationConfigV3_12_1;
954
+ }
955
+ /**
956
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
957
+ * via the `definition` "paginationCursorConfig".
958
+ */
959
+ export interface PaginationCursorConfigV3_12_1 {
960
+ type: 'cursor';
961
+ cursorArg: string;
962
+ cursorPath: string;
963
+ size?: number;
964
+ sizeArg: string;
965
+ hasMorePath: string;
966
+ itemsPath: string;
967
+ }
968
+ /**
969
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
970
+ * via the `definition` "paginationPageConfig".
971
+ */
972
+ export interface PaginationPageConfigV3_12_1 {
973
+ type: 'page';
974
+ pageArg: string;
975
+ itemsPath: string;
976
+ totalPagesPath: string;
977
+ }
978
+ /**
979
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
980
+ * via the `definition` "paginationOffsetConfig".
981
+ */
982
+ export interface PaginationOffsetConfigV3_12_1 {
983
+ type: 'offset';
984
+ offsetParam: string;
985
+ itemsPath: string;
986
+ resultsPath: string;
987
+ totalPath: string;
988
+ }
989
+ /**
990
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
991
+ * via the `definition` "formMap".
992
+ */
993
+ export interface FormMapV3_12_1 {
994
+ [k: string]: FormsConfigV3_12_1;
995
+ }
996
+ /**
997
+ * This interface was referenced by `FormMapV3_12_1`'s JSON-Schema definition
998
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
999
+ *
1000
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1001
+ * via the `definition` "formsConfig".
1002
+ */
1003
+ export interface FormsConfigV3_12_1 {
1004
+ default: FormConfigV3_12_1;
1005
+ [k: string]: FormConfigV3_12_1;
1006
+ }
1007
+ /**
1008
+ * This interface was referenced by `FormsConfigV3_12_1`'s JSON-Schema definition
1009
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1010
+ *
1011
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1012
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1013
+ *
1014
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1015
+ * via the `definition` "formConfig".
1016
+ */
1017
+ export interface FormConfigV3_12_1 {
1018
+ [k: string]: any;
1019
+ }
1020
+ /**
1021
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1022
+ * via the `definition` "workflowMap".
1023
+ */
1024
+ export interface WorkflowMapV3_12_1 {
1025
+ [k: string]: WorkflowV3_12_1;
1026
+ }
1027
+ /**
1028
+ * This interface was referenced by `WorkflowMapV3_12_1`'s JSON-Schema definition
1029
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1030
+ *
1031
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1032
+ * via the `definition` "workflow".
1033
+ */
1034
+ export interface WorkflowV3_12_1 {
1035
+ /**
1036
+ * machine-readable id
1037
+ */
1038
+ name: string;
1039
+ title: WorkflowNameV3_12_1;
1040
+ steps: StepsV3_12_1;
1041
+ [k: string]: any;
1042
+ }
1043
+ /**
1044
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1045
+ * via the `definition` "workflowStep".
1046
+ */
1047
+ export interface WorkflowStepV3_12_1 {
1048
+ name: NameV3_12_1;
1049
+ title: TitleV3_12_1;
1050
+ description?: DescriptionV3_12_1;
1051
+ color: ColorV3_12_1;
1052
+ live: LiveV3_12_1;
1053
+ key: KeyV3_12_1;
1054
+ }
1055
+ /**
1056
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1057
+ * via the `definition` "storedServiceMap".
1058
+ */
1059
+ export interface StoredServiceMapV3_12_1 {
1060
+ [k: string]: StoredServiceConfigV3_12_1;
1061
+ }
1062
+ /**
1063
+ * This interface was referenced by `StoredServiceMapV3_12_1`'s JSON-Schema definition
1064
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1065
+ *
1066
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1067
+ * via the `definition` "storedServiceConfig".
1068
+ */
1069
+ export interface StoredServiceConfigV3_12_1 {
1070
+ /**
1071
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
1072
+ */
1073
+ id: string;
1074
+ /**
1075
+ * Human-readable name for this service.
1076
+ */
1077
+ title: string;
1078
+ /**
1079
+ * The service provider id.
1080
+ */
1081
+ provider: string;
1082
+ /**
1083
+ * A namespace to use for the imported types tied to this service.
1084
+ */
1085
+ namespace?: string;
1086
+ serviceType: ServiceTypeV3_12_1;
1087
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
1088
+ authentication?: string;
1089
+ webhookId?: string;
1090
+ /**
1091
+ * Configuration options passed to and handled by the provider.
1092
+ */
1093
+ options?: {
1094
+ [k: string]: any;
1095
+ };
1096
+ }
1097
+ /**
1098
+ * All possible options for the more specific ParameterSerializeStyleOptions types.
1099
+ *
1100
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1101
+ * via the `definition` "parameterSerializeStyleOptions".
1102
+ */
1103
+ export interface ParameterSerializeStyleOptionsV3_12_1 {
1104
+ style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
1105
+ explode?: boolean;
1106
+ allowEmptyValue?: boolean;
1107
+ /**
1108
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1109
+ */
1110
+ allowReserved?: boolean;
1111
+ skipEncoding?: boolean;
1112
+ }
1113
+ /**
1114
+ * All possible options for the more specific ParameterSerializeConfig types.
1115
+ *
1116
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1117
+ * via the `definition` "parameterSerializeConfig".
1118
+ */
1119
+ export interface ParameterSerializeConfigV3_12_1 {
1120
+ content?: ParameterSerializeContentOptionsV3_12_1;
1121
+ defaults?: ParameterSerializeOptionsV3_12_1;
1122
+ paths?: {
1123
+ [k: string]: ParameterSerializeOptionsV3_12_1;
1124
+ };
1125
+ }
1126
+ /**
1127
+ * All possible options for the more specific ParameterConfig types.
1128
+ *
1129
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1130
+ * via the `definition` "parameterConfig".
1131
+ */
1132
+ export interface ParameterConfigV3_12_1 {
1133
+ ops: ParameterOpListV3_12_1;
1134
+ serialize?: ParameterSerializeConfigV3_12_1;
1135
+ }
1136
+ /**
1137
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1138
+ * via the `definition` "formScalarConfig".
1139
+ */
1140
+ export interface FormScalarConfigV3_12_1 {
1141
+ widget: string;
1142
+ }
1143
+ /**
1144
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1145
+ * via the `definition` "formObjectConfig".
1146
+ */
1147
+ export interface FormObjectConfigV3_12_1 {
1148
+ widget?: string;
1149
+ order?: string[];
1150
+ properties?: {
1151
+ [k: string]: FormConfigV3_12_1;
1152
+ };
1153
+ }
1154
+ /**
1155
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1156
+ * via the `definition` "formArrayConfig".
1157
+ */
1158
+ export interface FormArrayConfigV3_12_1 {
1159
+ widget: string;
1160
+ items: FormConfigV3_12_1;
1161
+ }
1162
+ /**
1163
+ * For use with a custom auth handler on a service provider.
1164
+ *
1165
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1166
+ * via the `definition` "customAuthentication".
1167
+ */
1168
+ export interface CustomAuthenticationV3_12_1 {
1169
+ type: 'custom';
1170
+ [k: string]: any;
1171
+ }
1172
+ /**
1173
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1174
+ * via the `definition` "searchParamsAuthentication".
1175
+ */
1176
+ export interface SearchParamsAuthenticationV3_12_1 {
1177
+ type: 'searchParams';
1178
+ params: {
1179
+ name: string;
1180
+ value: string;
1181
+ }[];
1182
+ }
1183
+ /**
1184
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1185
+ * via the `definition` "bearerAuthentication".
1186
+ */
1187
+ export interface BearerAuthenticationV3_12_1 {
1188
+ type: 'bearer';
1189
+ token: string;
1190
+ prefix?: string;
1191
+ header?: string;
1192
+ }
1193
+ /**
1194
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1195
+ * via the `definition` "oauth2BearerAuthentication".
1196
+ */
1197
+ export interface OAuth2BearerAuthenticationV3_12_1 {
1198
+ type: 'oauth2Bearer';
1199
+ token: string;
1200
+ prefix?: string;
1201
+ header?: string;
1202
+ scope?: string;
1203
+ expiresAt?: string;
1204
+ }
1205
+ /**
1206
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1207
+ * via the `definition` "basicAuthentication".
1208
+ */
1209
+ export interface BasicAuthenticationV3_12_1 {
1210
+ type: 'basic';
1211
+ username: string;
1212
+ password: string;
1213
+ useIso8859?: boolean;
1214
+ }
1215
+ /**
1216
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1217
+ * via the `definition` "oauth2Authentication".
1218
+ */
1219
+ export interface OAuth2AuthenticationV3_12_1 {
1220
+ type: 'oauth2';
1221
+ grantType: 'authorizationCode' | 'clientCredentials';
1222
+ authorizationUrl?: string;
1223
+ accessTokenUrl?: string;
1224
+ clientId: string;
1225
+ clientSecret?: string;
1226
+ scope?: string;
1227
+ usePkce?: boolean;
1228
+ redirectUrl?: string;
1229
+ headerPrefix?: string;
1230
+ audience?: string;
1231
+ resource?: string;
1232
+ }
1233
+ /**
1234
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1235
+ * via the `definition` "awsAuthentication".
1236
+ */
1237
+ export interface AWSAuthenticationV3_12_1 {
1238
+ type: 'aws';
1239
+ awsAccessKeyId: string;
1240
+ awsSecretAccessKey: string;
1241
+ }
1242
+ /**
1243
+ * This interface was referenced by `ProjectSchemaV3_12_1`'s JSON-Schema
1244
+ * via the `definition` "serviceConfig".
1245
+ */
1246
+ export interface ServiceConfigV3_12_1 {
1247
+ /**
1248
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
1249
+ */
1250
+ id: string;
1251
+ /**
1252
+ * Human-readable name for this service.
1253
+ */
1254
+ title: string;
1255
+ /**
1256
+ * The service provider id.
1257
+ */
1258
+ provider: string;
1259
+ /**
1260
+ * A namespace to use for the imported types tied to this service.
1261
+ */
1262
+ namespace?: string;
1263
+ serviceType: ServiceTypeV3_12_1;
1264
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
1265
+ authentication?: ServiceAuthenticationV3_12_1;
1266
+ webhookId?: string;
1267
+ /**
1268
+ * Configuration options passed to and handled by the provider.
1269
+ */
1270
+ options?: {
1271
+ [k: string]: any;
1272
+ };
1273
+ }
1274
+ //# sourceMappingURL=v3.12.1.d.ts.map