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