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