@takeshape/schema 8.263.3 → 8.264.0

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