@takeshape/schema 11.144.1 → 11.154.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (537) hide show
  1. package/examples/latest/all-fields-shapes-inline.json +1 -1
  2. package/examples/latest/all-fields-shapes.json +1 -1
  3. package/examples/latest/betzino.json +1 -1
  4. package/examples/latest/blog-schema.json +1 -1
  5. package/examples/latest/brewery-schema.json +1 -1
  6. package/examples/latest/chat-agent-schema.json +1 -1
  7. package/examples/latest/clear-cache-schema.json +1 -1
  8. package/examples/latest/complex-project-schema.json +1 -1
  9. package/examples/latest/complex-schema.json +1 -1
  10. package/examples/latest/edit-schema.json +1 -1
  11. package/examples/latest/frank-and-fred-schema.json +1 -1
  12. package/examples/latest/generate-agent-schema.json +1 -1
  13. package/examples/latest/klirr-schema.json +1 -1
  14. package/examples/latest/layers/rick-and-morty-layer.json +1 -1
  15. package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
  16. package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
  17. package/examples/latest/layers/wordpress-2024-01.json +1 -1
  18. package/examples/latest/massive-schema.json +1 -1
  19. package/examples/latest/mill-components-schema.json +1 -1
  20. package/examples/latest/nested-shape-arrays.json +1 -1
  21. package/examples/latest/one-earth.json +1 -1
  22. package/examples/latest/pet-oneof-array.json +1 -1
  23. package/examples/latest/post-schema.json +1 -1
  24. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  25. package/examples/latest/rag-example.json +1 -1
  26. package/examples/latest/real-world-schema.json +1 -1
  27. package/examples/latest/recursive-repeater-schema.json +1 -1
  28. package/examples/latest/recursive-schema.json +1 -1
  29. package/examples/latest/rick-and-morty-ast.json +1 -1
  30. package/examples/latest/rick-and-morty-graphql.json +1 -1
  31. package/examples/latest/rick-and-morty-rest.json +1 -1
  32. package/examples/latest/rick-and-morty-user-schema.json +1 -1
  33. package/examples/latest/rick-and-morty-with-indexing.json +1 -1
  34. package/examples/latest/schema-where-filter.json +1 -1
  35. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  36. package/examples/latest/schema-with-rick-and-morty.json +1 -1
  37. package/examples/latest/shape-books-v3_2_0.json +1 -1
  38. package/examples/latest/shape-books.json +1 -1
  39. package/examples/latest/shape-editor-schema-edited.json +1 -1
  40. package/examples/latest/shape-editor-schema-initial.json +1 -1
  41. package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
  42. package/examples/latest/shopify-lookbook.json +1 -1
  43. package/examples/latest/shopify-product-2022-07.json +1 -1
  44. package/examples/latest/shopify-product-2023-04.json +1 -1
  45. package/examples/latest/shopify-store-with-widget.json +1 -1
  46. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  47. package/examples/latest/stripe-starter-resolved.json +1 -1
  48. package/examples/latest/user-schema-no-required.json +1 -1
  49. package/examples/latest/user-schema-with-defaults.json +1 -1
  50. package/examples/latest/valvoline-ai-demo.json +1461 -1421
  51. package/examples/latest/vector-search-schema.json +1 -1
  52. package/package.json +10 -9
  53. package/dist/agents.d.ts +0 -62
  54. package/dist/agents.js +0 -338
  55. package/dist/api-version.d.ts +0 -5
  56. package/dist/api-version.js +0 -17
  57. package/dist/auth-schemas.d.ts +0 -128
  58. package/dist/auth-schemas.js +0 -7
  59. package/dist/auth-utils.d.ts +0 -5
  60. package/dist/auth-utils.js +0 -6
  61. package/dist/builtin-schema.d.ts +0 -18
  62. package/dist/builtin-schema.js +0 -683
  63. package/dist/constants.d.ts +0 -1
  64. package/dist/constants.js +0 -1
  65. package/dist/content-schema-transform.d.ts +0 -35
  66. package/dist/content-schema-transform.js +0 -162
  67. package/dist/create-input-schema.d.ts +0 -9
  68. package/dist/create-input-schema.js +0 -68
  69. package/dist/enum.d.ts +0 -2
  70. package/dist/enum.js +0 -9
  71. package/dist/flatten-templates.d.ts +0 -2
  72. package/dist/flatten-templates.js +0 -20
  73. package/dist/get-is-leaf.d.ts +0 -3
  74. package/dist/get-is-leaf.js +0 -56
  75. package/dist/index.d.ts +0 -62
  76. package/dist/index.js +0 -59
  77. package/dist/interfaces.d.ts +0 -14
  78. package/dist/interfaces.js +0 -86
  79. package/dist/layers/layers.d.ts +0 -26
  80. package/dist/layers/layers.js +0 -301
  81. package/dist/layers/refs.d.ts +0 -102
  82. package/dist/layers/refs.js +0 -220
  83. package/dist/layers/type-utils.d.ts +0 -59
  84. package/dist/layers/type-utils.js +0 -118
  85. package/dist/layers/visitor.d.ts +0 -5
  86. package/dist/layers/visitor.js +0 -38
  87. package/dist/migration/index.d.ts +0 -73
  88. package/dist/migration/index.js +0 -103
  89. package/dist/migration/to/v3.0.0.d.ts +0 -4
  90. package/dist/migration/to/v3.0.0.js +0 -212
  91. package/dist/migration/to/v3.1.0.d.ts +0 -4
  92. package/dist/migration/to/v3.1.0.js +0 -194
  93. package/dist/migration/to/v3.10.0.d.ts +0 -4
  94. package/dist/migration/to/v3.10.0.js +0 -67
  95. package/dist/migration/to/v3.11.0.d.ts +0 -4
  96. package/dist/migration/to/v3.11.0.js +0 -85
  97. package/dist/migration/to/v3.12.3.d.ts +0 -4
  98. package/dist/migration/to/v3.12.3.js +0 -87
  99. package/dist/migration/to/v3.13.0.d.ts +0 -4
  100. package/dist/migration/to/v3.13.0.js +0 -17
  101. package/dist/migration/to/v3.17.0.d.ts +0 -4
  102. package/dist/migration/to/v3.17.0.js +0 -22
  103. package/dist/migration/to/v3.18.0.d.ts +0 -4
  104. package/dist/migration/to/v3.18.0.js +0 -64
  105. package/dist/migration/to/v3.18.1.d.ts +0 -4
  106. package/dist/migration/to/v3.18.1.js +0 -12
  107. package/dist/migration/to/v3.18.2.d.ts +0 -4
  108. package/dist/migration/to/v3.18.2.js +0 -19
  109. package/dist/migration/to/v3.20.0.d.ts +0 -4
  110. package/dist/migration/to/v3.20.0.js +0 -24
  111. package/dist/migration/to/v3.22.0.d.ts +0 -4
  112. package/dist/migration/to/v3.22.0.js +0 -25
  113. package/dist/migration/to/v3.24.0.d.ts +0 -4
  114. package/dist/migration/to/v3.24.0.js +0 -11
  115. package/dist/migration/to/v3.25.0.d.ts +0 -4
  116. package/dist/migration/to/v3.25.0.js +0 -11
  117. package/dist/migration/to/v3.3.0.d.ts +0 -4
  118. package/dist/migration/to/v3.3.0.js +0 -13
  119. package/dist/migration/to/v3.31.0.d.ts +0 -4
  120. package/dist/migration/to/v3.31.0.js +0 -38
  121. package/dist/migration/to/v3.32.0.d.ts +0 -4
  122. package/dist/migration/to/v3.32.0.js +0 -59
  123. package/dist/migration/to/v3.34.0.d.ts +0 -6
  124. package/dist/migration/to/v3.34.0.js +0 -111
  125. package/dist/migration/to/v3.36.0.d.ts +0 -4
  126. package/dist/migration/to/v3.36.0.js +0 -22
  127. package/dist/migration/to/v3.39.0.d.ts +0 -4
  128. package/dist/migration/to/v3.39.0.js +0 -45
  129. package/dist/migration/to/v3.40.0.d.ts +0 -4
  130. package/dist/migration/to/v3.40.0.js +0 -26
  131. package/dist/migration/to/v3.46.0.d.ts +0 -4
  132. package/dist/migration/to/v3.46.0.js +0 -35
  133. package/dist/migration/to/v3.57.0.d.ts +0 -4
  134. package/dist/migration/to/v3.57.0.js +0 -18
  135. package/dist/migration/to/v3.9.0.d.ts +0 -4
  136. package/dist/migration/to/v3.9.0.js +0 -79
  137. package/dist/migration/types.d.ts +0 -26
  138. package/dist/migration/types.js +0 -3
  139. package/dist/migration/utils.d.ts +0 -2
  140. package/dist/migration/utils.js +0 -6
  141. package/dist/mocks.d.ts +0 -14
  142. package/dist/mocks.js +0 -58
  143. package/dist/models/agent.d.ts +0 -3
  144. package/dist/models/agent.js +0 -29
  145. package/dist/models/project-schema.d.ts +0 -18
  146. package/dist/models/project-schema.js +0 -119
  147. package/dist/models/query.d.ts +0 -3
  148. package/dist/models/query.js +0 -38
  149. package/dist/models/runtime-schema.d.ts +0 -9
  150. package/dist/models/runtime-schema.js +0 -20
  151. package/dist/models/shape.d.ts +0 -4
  152. package/dist/models/shape.js +0 -36
  153. package/dist/models/types.d.ts +0 -36
  154. package/dist/models/types.js +0 -1
  155. package/dist/models/user-schema.d.ts +0 -7
  156. package/dist/models/user-schema.js +0 -9
  157. package/dist/patterns.d.ts +0 -12
  158. package/dist/patterns.js +0 -1
  159. package/dist/project-schema/index.d.ts +0 -211
  160. package/dist/project-schema/index.js +0 -83
  161. package/dist/project-schema/latest.d.ts +0 -2619
  162. package/dist/project-schema/latest.js +0 -7
  163. package/dist/project-schema/migrate.d.ts +0 -4
  164. package/dist/project-schema/migrate.js +0 -218
  165. package/dist/project-schema/v1.0.0.d.ts +0 -299
  166. package/dist/project-schema/v1.0.0.js +0 -7
  167. package/dist/project-schema/v3.0.0.d.ts +0 -478
  168. package/dist/project-schema/v3.0.0.js +0 -7
  169. package/dist/project-schema/v3.1.0.d.ts +0 -621
  170. package/dist/project-schema/v3.1.0.js +0 -7
  171. package/dist/project-schema/v3.10.0.d.ts +0 -1201
  172. package/dist/project-schema/v3.10.0.js +0 -7
  173. package/dist/project-schema/v3.11.0.d.ts +0 -1210
  174. package/dist/project-schema/v3.11.0.js +0 -7
  175. package/dist/project-schema/v3.12.0.d.ts +0 -1214
  176. package/dist/project-schema/v3.12.0.js +0 -7
  177. package/dist/project-schema/v3.12.1.d.ts +0 -1273
  178. package/dist/project-schema/v3.12.1.js +0 -7
  179. package/dist/project-schema/v3.12.2.d.ts +0 -1283
  180. package/dist/project-schema/v3.12.2.js +0 -7
  181. package/dist/project-schema/v3.12.3.d.ts +0 -1306
  182. package/dist/project-schema/v3.12.3.js +0 -7
  183. package/dist/project-schema/v3.13.0.d.ts +0 -1317
  184. package/dist/project-schema/v3.13.0.js +0 -7
  185. package/dist/project-schema/v3.13.1.d.ts +0 -1412
  186. package/dist/project-schema/v3.13.1.js +0 -7
  187. package/dist/project-schema/v3.14.0.d.ts +0 -1436
  188. package/dist/project-schema/v3.14.0.js +0 -7
  189. package/dist/project-schema/v3.15.0.d.ts +0 -1458
  190. package/dist/project-schema/v3.15.0.js +0 -7
  191. package/dist/project-schema/v3.16.0.d.ts +0 -1470
  192. package/dist/project-schema/v3.16.0.js +0 -7
  193. package/dist/project-schema/v3.17.0.d.ts +0 -1467
  194. package/dist/project-schema/v3.17.0.js +0 -7
  195. package/dist/project-schema/v3.17.1.d.ts +0 -1468
  196. package/dist/project-schema/v3.17.1.js +0 -7
  197. package/dist/project-schema/v3.18.0.d.ts +0 -1333
  198. package/dist/project-schema/v3.18.0.js +0 -7
  199. package/dist/project-schema/v3.18.1.d.ts +0 -1332
  200. package/dist/project-schema/v3.18.1.js +0 -7
  201. package/dist/project-schema/v3.18.2.d.ts +0 -1332
  202. package/dist/project-schema/v3.18.2.js +0 -7
  203. package/dist/project-schema/v3.19.0.d.ts +0 -1336
  204. package/dist/project-schema/v3.19.0.js +0 -7
  205. package/dist/project-schema/v3.2.0.d.ts +0 -632
  206. package/dist/project-schema/v3.2.0.js +0 -7
  207. package/dist/project-schema/v3.20.0.d.ts +0 -1336
  208. package/dist/project-schema/v3.20.0.js +0 -7
  209. package/dist/project-schema/v3.21.0.d.ts +0 -1338
  210. package/dist/project-schema/v3.21.0.js +0 -7
  211. package/dist/project-schema/v3.22.0.d.ts +0 -1344
  212. package/dist/project-schema/v3.22.0.js +0 -7
  213. package/dist/project-schema/v3.23.0.d.ts +0 -1376
  214. package/dist/project-schema/v3.23.0.js +0 -7
  215. package/dist/project-schema/v3.24.0.d.ts +0 -1364
  216. package/dist/project-schema/v3.24.0.js +0 -7
  217. package/dist/project-schema/v3.25.0.d.ts +0 -1363
  218. package/dist/project-schema/v3.25.0.js +0 -7
  219. package/dist/project-schema/v3.26.0.d.ts +0 -1388
  220. package/dist/project-schema/v3.26.0.js +0 -7
  221. package/dist/project-schema/v3.27.0.d.ts +0 -1397
  222. package/dist/project-schema/v3.27.0.js +0 -7
  223. package/dist/project-schema/v3.28.0.d.ts +0 -1416
  224. package/dist/project-schema/v3.28.0.js +0 -7
  225. package/dist/project-schema/v3.29.0.d.ts +0 -1423
  226. package/dist/project-schema/v3.29.0.js +0 -7
  227. package/dist/project-schema/v3.3.0.d.ts +0 -632
  228. package/dist/project-schema/v3.3.0.js +0 -7
  229. package/dist/project-schema/v3.30.0.d.ts +0 -1416
  230. package/dist/project-schema/v3.30.0.js +0 -7
  231. package/dist/project-schema/v3.31.0.d.ts +0 -1448
  232. package/dist/project-schema/v3.31.0.js +0 -7
  233. package/dist/project-schema/v3.32.0.d.ts +0 -1439
  234. package/dist/project-schema/v3.32.0.js +0 -7
  235. package/dist/project-schema/v3.33.0.d.ts +0 -1445
  236. package/dist/project-schema/v3.33.0.js +0 -7
  237. package/dist/project-schema/v3.34.0.d.ts +0 -1445
  238. package/dist/project-schema/v3.34.0.js +0 -7
  239. package/dist/project-schema/v3.35.0.d.ts +0 -1464
  240. package/dist/project-schema/v3.35.0.js +0 -7
  241. package/dist/project-schema/v3.36.0.d.ts +0 -1470
  242. package/dist/project-schema/v3.36.0.js +0 -7
  243. package/dist/project-schema/v3.37.0.d.ts +0 -1522
  244. package/dist/project-schema/v3.37.0.js +0 -7
  245. package/dist/project-schema/v3.38.0.d.ts +0 -1522
  246. package/dist/project-schema/v3.38.0.js +0 -7
  247. package/dist/project-schema/v3.39.0.d.ts +0 -1529
  248. package/dist/project-schema/v3.39.0.js +0 -7
  249. package/dist/project-schema/v3.4.0.d.ts +0 -624
  250. package/dist/project-schema/v3.4.0.js +0 -7
  251. package/dist/project-schema/v3.40.0.d.ts +0 -1530
  252. package/dist/project-schema/v3.40.0.js +0 -7
  253. package/dist/project-schema/v3.41.0.d.ts +0 -1530
  254. package/dist/project-schema/v3.41.0.js +0 -7
  255. package/dist/project-schema/v3.42.0.d.ts +0 -1534
  256. package/dist/project-schema/v3.42.0.js +0 -7
  257. package/dist/project-schema/v3.43.0.d.ts +0 -1536
  258. package/dist/project-schema/v3.43.0.js +0 -7
  259. package/dist/project-schema/v3.44.0.d.ts +0 -1621
  260. package/dist/project-schema/v3.44.0.js +0 -7
  261. package/dist/project-schema/v3.45.0.d.ts +0 -1650
  262. package/dist/project-schema/v3.45.0.js +0 -7
  263. package/dist/project-schema/v3.46.0.d.ts +0 -1703
  264. package/dist/project-schema/v3.46.0.js +0 -7
  265. package/dist/project-schema/v3.47.0.d.ts +0 -1736
  266. package/dist/project-schema/v3.47.0.js +0 -7
  267. package/dist/project-schema/v3.48.0.d.ts +0 -2208
  268. package/dist/project-schema/v3.48.0.js +0 -7
  269. package/dist/project-schema/v3.49.0.d.ts +0 -2217
  270. package/dist/project-schema/v3.49.0.js +0 -7
  271. package/dist/project-schema/v3.5.0.d.ts +0 -649
  272. package/dist/project-schema/v3.5.0.js +0 -7
  273. package/dist/project-schema/v3.5.1.d.ts +0 -649
  274. package/dist/project-schema/v3.5.1.js +0 -7
  275. package/dist/project-schema/v3.50.0.d.ts +0 -2269
  276. package/dist/project-schema/v3.50.0.js +0 -7
  277. package/dist/project-schema/v3.51.0.d.ts +0 -2269
  278. package/dist/project-schema/v3.51.0.js +0 -7
  279. package/dist/project-schema/v3.52.0.d.ts +0 -2269
  280. package/dist/project-schema/v3.52.0.js +0 -7
  281. package/dist/project-schema/v3.53.0.d.ts +0 -2350
  282. package/dist/project-schema/v3.53.0.js +0 -7
  283. package/dist/project-schema/v3.54.0.d.ts +0 -2369
  284. package/dist/project-schema/v3.54.0.js +0 -7
  285. package/dist/project-schema/v3.55.0.d.ts +0 -2369
  286. package/dist/project-schema/v3.55.0.js +0 -7
  287. package/dist/project-schema/v3.56.0.d.ts +0 -2405
  288. package/dist/project-schema/v3.56.0.js +0 -7
  289. package/dist/project-schema/v3.57.0.d.ts +0 -2601
  290. package/dist/project-schema/v3.57.0.js +0 -7
  291. package/dist/project-schema/v3.58.0.d.ts +0 -2601
  292. package/dist/project-schema/v3.58.0.js +0 -7
  293. package/dist/project-schema/v3.59.0.d.ts +0 -2619
  294. package/dist/project-schema/v3.59.0.js +0 -7
  295. package/dist/project-schema/v3.6.0.d.ts +0 -658
  296. package/dist/project-schema/v3.6.0.js +0 -7
  297. package/dist/project-schema/v3.7.0.d.ts +0 -961
  298. package/dist/project-schema/v3.7.0.js +0 -7
  299. package/dist/project-schema/v3.8.0.d.ts +0 -979
  300. package/dist/project-schema/v3.8.0.js +0 -7
  301. package/dist/project-schema/v3.9.0.d.ts +0 -1178
  302. package/dist/project-schema/v3.9.0.js +0 -7
  303. package/dist/project-schema/v4.0.0.d.ts +0 -1328
  304. package/dist/project-schema/v4.0.0.js +0 -7
  305. package/dist/refs.d.ts +0 -218
  306. package/dist/refs.js +0 -616
  307. package/dist/relationships.d.ts +0 -40
  308. package/dist/relationships.js +0 -302
  309. package/dist/resolvers/ai/abort-agent-message-args.d.ts +0 -16
  310. package/dist/resolvers/ai/abort-agent-message-args.js +0 -13
  311. package/dist/resolvers/ai/abort-agent-message-response.d.ts +0 -39
  312. package/dist/resolvers/ai/abort-agent-message-response.js +0 -19
  313. package/dist/resolvers/ai/agent-chat-args.d.ts +0 -17
  314. package/dist/resolvers/ai/agent-chat-args.js +0 -14
  315. package/dist/resolvers/ai/agent-chat-payload.d.ts +0 -35
  316. package/dist/resolvers/ai/agent-chat-payload.js +0 -26
  317. package/dist/resolvers/ai/agent-chat-response.d.ts +0 -289
  318. package/dist/resolvers/ai/agent-chat-response.js +0 -21
  319. package/dist/resolvers/ai/agent-generate-args.d.ts +0 -17
  320. package/dist/resolvers/ai/agent-generate-args.js +0 -14
  321. package/dist/resolvers/ai/agent-message-input.d.ts +0 -73
  322. package/dist/resolvers/ai/agent-message-input.js +0 -39
  323. package/dist/resolvers/ai/agent-message-output.d.ts +0 -169
  324. package/dist/resolvers/ai/agent-message-output.js +0 -77
  325. package/dist/resolvers/ai/agent-message-payload.d.ts +0 -507
  326. package/dist/resolvers/ai/agent-message-payload.js +0 -156
  327. package/dist/resolvers/ai/agent-run-mode.d.ts +0 -7
  328. package/dist/resolvers/ai/agent-run-mode.js +0 -9
  329. package/dist/resolvers/ai/agent-session-payload.d.ts +0 -515
  330. package/dist/resolvers/ai/agent-session-payload.js +0 -175
  331. package/dist/resolvers/ai/create-agent-session-response.d.ts +0 -199
  332. package/dist/resolvers/ai/create-agent-session-response.js +0 -9
  333. package/dist/resolvers/ai/embedding-search.d.ts +0 -54
  334. package/dist/resolvers/ai/embedding-search.js +0 -46
  335. package/dist/resolvers/ai/get-agent-message-args.d.ts +0 -16
  336. package/dist/resolvers/ai/get-agent-message-args.js +0 -13
  337. package/dist/resolvers/ai/get-agent-message-response.d.ts +0 -805
  338. package/dist/resolvers/ai/get-agent-message-response.js +0 -63
  339. package/dist/resolvers/ai/inspect-agent-args.d.ts +0 -16
  340. package/dist/resolvers/ai/inspect-agent-args.js +0 -13
  341. package/dist/resolvers/ai/inspect-agent-response.d.ts +0 -504
  342. package/dist/resolvers/ai/inspect-agent-response.js +0 -48
  343. package/dist/resolvers/ai/send-agent-feedback-args.d.ts +0 -52
  344. package/dist/resolvers/ai/send-agent-feedback-args.js +0 -16
  345. package/dist/resolvers/ai/send-agent-message-args.d.ts +0 -48
  346. package/dist/resolvers/ai/send-agent-message-args.js +0 -36
  347. package/dist/resolvers/ai/send-agent-message-response.d.ts +0 -353
  348. package/dist/resolvers/ai/send-agent-message-response.js +0 -51
  349. package/dist/resolvers/ai/types.d.ts +0 -6
  350. package/dist/resolvers/ai/types.js +0 -1
  351. package/dist/resolvers/takeshape/assets/asset-image-meta.d.ts +0 -79
  352. package/dist/resolvers/takeshape/assets/asset-image-meta.js +0 -98
  353. package/dist/resolvers/takeshape/assets/asset-image-params.d.ts +0 -901
  354. package/dist/resolvers/takeshape/assets/asset-image-params.js +0 -726
  355. package/dist/resolvers/takeshape/assets/asset-image.d.ts +0 -17
  356. package/dist/resolvers/takeshape/assets/asset-image.js +0 -15
  357. package/dist/resolvers/takeshape/assets/asset.d.ts +0 -125
  358. package/dist/resolvers/takeshape/assets/asset.js +0 -107
  359. package/dist/resolvers/takeshape/assets/constants.d.ts +0 -11
  360. package/dist/resolvers/takeshape/assets/constants.js +0 -11
  361. package/dist/resolvers/takeshape/builtins/constants.d.ts +0 -1
  362. package/dist/resolvers/takeshape/builtins/constants.js +0 -1
  363. package/dist/runtime-schema.d.ts +0 -6
  364. package/dist/runtime-schema.js +0 -85
  365. package/dist/scalars.d.ts +0 -2
  366. package/dist/scalars.js +0 -4
  367. package/dist/schema-transform.d.ts +0 -19
  368. package/dist/schema-transform.js +0 -74
  369. package/dist/schema-util.d.ts +0 -266
  370. package/dist/schema-util.js +0 -1127
  371. package/dist/schemas/auth-schemas.json +0 -374
  372. package/dist/schemas/index.d.ts +0 -4
  373. package/dist/schemas/index.js +0 -170
  374. package/dist/schemas/project-schema/experimental-2025-07.json +0 -1297
  375. package/dist/schemas/project-schema/latest.d.ts +0 -180
  376. package/dist/schemas/project-schema/latest.js +0 -11
  377. package/dist/schemas/project-schema/latest.json +0 -4846
  378. package/dist/schemas/project-schema/meta-schema-v1.0.0.json +0 -193
  379. package/dist/schemas/project-schema/meta-schema-v3.0.0.json +0 -608
  380. package/dist/schemas/project-schema/meta-schema-v3.1.0.json +0 -608
  381. package/dist/schemas/project-schema/meta-schema-v3.2.0.json +0 -612
  382. package/dist/schemas/project-schema/meta-schema-v3.3.0.json +0 -612
  383. package/dist/schemas/project-schema/meta-schema-v3.4.0.json +0 -637
  384. package/dist/schemas/project-schema/meta-schema-v3.5.0.json +0 -626
  385. package/dist/schemas/project-schema/meta-schema-v3.5.1.json +0 -626
  386. package/dist/schemas/project-schema/meta-schema-v3.6.0.json +0 -629
  387. package/dist/schemas/project-schema/meta-schema-v3.7.0.json +0 -1137
  388. package/dist/schemas/project-schema/meta-schema-v3.8.0.json +0 -1137
  389. package/dist/schemas/project-schema/meta-schema-v3.9.0.json +0 -1477
  390. package/dist/schemas/project-schema/v1.0.0.json +0 -321
  391. package/dist/schemas/project-schema/v3.0.0.json +0 -414
  392. package/dist/schemas/project-schema/v3.1.0.json +0 -572
  393. package/dist/schemas/project-schema/v3.10.0.json +0 -2097
  394. package/dist/schemas/project-schema/v3.11.0.json +0 -2141
  395. package/dist/schemas/project-schema/v3.12.0.json +0 -2144
  396. package/dist/schemas/project-schema/v3.12.1.json +0 -2282
  397. package/dist/schemas/project-schema/v3.12.2.json +0 -2304
  398. package/dist/schemas/project-schema/v3.12.3.json +0 -2357
  399. package/dist/schemas/project-schema/v3.13.0.json +0 -2377
  400. package/dist/schemas/project-schema/v3.14.0.json +0 -2385
  401. package/dist/schemas/project-schema/v3.15.0.json +0 -2365
  402. package/dist/schemas/project-schema/v3.16.0.json +0 -2373
  403. package/dist/schemas/project-schema/v3.17.0.json +0 -2378
  404. package/dist/schemas/project-schema/v3.17.1.json +0 -2380
  405. package/dist/schemas/project-schema/v3.18.0.json +0 -2356
  406. package/dist/schemas/project-schema/v3.18.1.json +0 -2357
  407. package/dist/schemas/project-schema/v3.18.2.json +0 -2357
  408. package/dist/schemas/project-schema/v3.19.0.json +0 -2369
  409. package/dist/schemas/project-schema/v3.2.0.json +0 -580
  410. package/dist/schemas/project-schema/v3.20.0.json +0 -2369
  411. package/dist/schemas/project-schema/v3.21.0.json +0 -2376
  412. package/dist/schemas/project-schema/v3.22.0.json +0 -2381
  413. package/dist/schemas/project-schema/v3.23.0.json +0 -2456
  414. package/dist/schemas/project-schema/v3.24.0.json +0 -2556
  415. package/dist/schemas/project-schema/v3.25.0.json +0 -2552
  416. package/dist/schemas/project-schema/v3.26.0.json +0 -2599
  417. package/dist/schemas/project-schema/v3.27.0.json +0 -2611
  418. package/dist/schemas/project-schema/v3.28.0.json +0 -2656
  419. package/dist/schemas/project-schema/v3.29.0.json +0 -2670
  420. package/dist/schemas/project-schema/v3.3.0.json +0 -581
  421. package/dist/schemas/project-schema/v3.30.0.json +0 -2656
  422. package/dist/schemas/project-schema/v3.31.0.json +0 -2714
  423. package/dist/schemas/project-schema/v3.32.0.json +0 -2708
  424. package/dist/schemas/project-schema/v3.33.0.json +0 -2715
  425. package/dist/schemas/project-schema/v3.34.0.json +0 -2715
  426. package/dist/schemas/project-schema/v3.35.0.json +0 -2748
  427. package/dist/schemas/project-schema/v3.36.0.json +0 -2756
  428. package/dist/schemas/project-schema/v3.37.0.json +0 -2821
  429. package/dist/schemas/project-schema/v3.38.0.json +0 -2819
  430. package/dist/schemas/project-schema/v3.39.0.json +0 -2827
  431. package/dist/schemas/project-schema/v3.4.0.json +0 -571
  432. package/dist/schemas/project-schema/v3.40.0.json +0 -2830
  433. package/dist/schemas/project-schema/v3.41.0.json +0 -2830
  434. package/dist/schemas/project-schema/v3.42.0.json +0 -2835
  435. package/dist/schemas/project-schema/v3.43.0.json +0 -2841
  436. package/dist/schemas/project-schema/v3.44.0.json +0 -3013
  437. package/dist/schemas/project-schema/v3.45.0.json +0 -3064
  438. package/dist/schemas/project-schema/v3.46.0.json +0 -3136
  439. package/dist/schemas/project-schema/v3.47.0.json +0 -3189
  440. package/dist/schemas/project-schema/v3.48.0.json +0 -3196
  441. package/dist/schemas/project-schema/v3.49.0.json +0 -3239
  442. package/dist/schemas/project-schema/v3.5.0.json +0 -571
  443. package/dist/schemas/project-schema/v3.5.1.json +0 -571
  444. package/dist/schemas/project-schema/v3.50.0.json +0 -3320
  445. package/dist/schemas/project-schema/v3.51.0.json +0 -3326
  446. package/dist/schemas/project-schema/v3.52.0.json +0 -3326
  447. package/dist/schemas/project-schema/v3.53.0.json +0 -3476
  448. package/dist/schemas/project-schema/v3.54.0.json +0 -3512
  449. package/dist/schemas/project-schema/v3.55.0.json +0 -3515
  450. package/dist/schemas/project-schema/v3.56.0.json +0 -3530
  451. package/dist/schemas/project-schema/v3.57.0.json +0 -4815
  452. package/dist/schemas/project-schema/v3.58.0.json +0 -4815
  453. package/dist/schemas/project-schema/v3.59.0.json +0 -4846
  454. package/dist/schemas/project-schema/v3.6.0.json +0 -587
  455. package/dist/schemas/project-schema/v3.7.0.json +0 -587
  456. package/dist/schemas/project-schema/v3.8.0.json +0 -604
  457. package/dist/schemas/project-schema/v3.9.0.json +0 -604
  458. package/dist/schemas/project-schema/v4.0.0.json +0 -2316
  459. package/dist/schemas/project-schema.json +0 -214
  460. package/dist/service-dependencies.d.ts +0 -13
  461. package/dist/service-dependencies.js +0 -165
  462. package/dist/services/services.d.ts +0 -31
  463. package/dist/services/services.js +0 -145
  464. package/dist/services/types.d.ts +0 -11
  465. package/dist/services/types.js +0 -1
  466. package/dist/services/util.d.ts +0 -16
  467. package/dist/services/util.js +0 -36
  468. package/dist/shape-paths.d.ts +0 -7
  469. package/dist/shape-paths.js +0 -28
  470. package/dist/taxonomies.d.ts +0 -15
  471. package/dist/taxonomies.js +0 -24
  472. package/dist/template-shapes/index.d.ts +0 -7
  473. package/dist/template-shapes/index.js +0 -33
  474. package/dist/template-shapes/names.d.ts +0 -10
  475. package/dist/template-shapes/names.js +0 -21
  476. package/dist/template-shapes/templates.d.ts +0 -32
  477. package/dist/template-shapes/templates.js +0 -316
  478. package/dist/template-shapes/types.d.ts +0 -15
  479. package/dist/template-shapes/types.js +0 -7
  480. package/dist/template-shapes/where.d.ts +0 -37
  481. package/dist/template-shapes/where.js +0 -400
  482. package/dist/types/index.d.ts +0 -3
  483. package/dist/types/index.js +0 -2
  484. package/dist/types/transforms.d.ts +0 -15
  485. package/dist/types/transforms.js +0 -1
  486. package/dist/types/types.d.ts +0 -200
  487. package/dist/types/types.js +0 -10
  488. package/dist/types/utils.d.ts +0 -112
  489. package/dist/types/utils.js +0 -269
  490. package/dist/unions.d.ts +0 -14
  491. package/dist/unions.js +0 -77
  492. package/dist/util/ai-tools.d.ts +0 -2
  493. package/dist/util/ai-tools.js +0 -14
  494. package/dist/util/api-indexing.d.ts +0 -9
  495. package/dist/util/api-indexing.js +0 -57
  496. package/dist/util/coerce-value.d.ts +0 -9
  497. package/dist/util/coerce-value.js +0 -32
  498. package/dist/util/detect-cycles.d.ts +0 -7
  499. package/dist/util/detect-cycles.js +0 -45
  500. package/dist/util/expressions.d.ts +0 -34
  501. package/dist/util/expressions.js +0 -350
  502. package/dist/util/find-shape-at-path.d.ts +0 -21
  503. package/dist/util/find-shape-at-path.js +0 -53
  504. package/dist/util/form-config.d.ts +0 -11
  505. package/dist/util/form-config.js +0 -62
  506. package/dist/util/get-conflicting-properties.d.ts +0 -6
  507. package/dist/util/get-conflicting-properties.js +0 -55
  508. package/dist/util/get-return-shape.d.ts +0 -4
  509. package/dist/util/get-return-shape.js +0 -30
  510. package/dist/util/has-arg.d.ts +0 -6
  511. package/dist/util/has-arg.js +0 -25
  512. package/dist/util/is-asset-property.d.ts +0 -3
  513. package/dist/util/is-asset-property.js +0 -11
  514. package/dist/util/mcp.d.ts +0 -8
  515. package/dist/util/mcp.js +0 -21
  516. package/dist/util/merge.d.ts +0 -15
  517. package/dist/util/merge.js +0 -254
  518. package/dist/util/patch-schema.d.ts +0 -8
  519. package/dist/util/patch-schema.js +0 -51
  520. package/dist/util/query-field-path.d.ts +0 -9
  521. package/dist/util/query-field-path.js +0 -23
  522. package/dist/util/shapes.d.ts +0 -5
  523. package/dist/util/shapes.js +0 -22
  524. package/dist/validate/ai.d.ts +0 -6
  525. package/dist/validate/ai.js +0 -183
  526. package/dist/validate/errors.d.ts +0 -3
  527. package/dist/validate/errors.js +0 -20
  528. package/dist/validate/types.d.ts +0 -1
  529. package/dist/validate/types.js +0 -1
  530. package/dist/validate/util.d.ts +0 -3
  531. package/dist/validate/util.js +0 -28
  532. package/dist/validate/validate.d.ts +0 -80
  533. package/dist/validate/validate.js +0 -1058
  534. package/dist/versions.d.ts +0 -4
  535. package/dist/versions.js +0 -4
  536. package/dist/workflows.d.ts +0 -14
  537. package/dist/workflows.js +0 -66
@@ -1,1650 +0,0 @@
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 `ProjectSchemaJSONV3_45_0`'s JSON-Schema
8
- * via the `definition` "args".
9
- */
10
- export type ArgsV3_45_0 = string | ObjectSchemaV3_45_0;
11
- /**
12
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
13
- * via the `definition` "objectSchema".
14
- */
15
- export type ObjectSchemaV3_45_0 = PropertySchemaV3_45_0 & {
16
- type: 'object';
17
- properties: {
18
- [k: string]: PropertySchemaV3_45_0;
19
- };
20
- };
21
- /**
22
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
23
- * via the `definition` "nonNegativeInteger".
24
- */
25
- export type NonNegativeIntegerV3_45_0 = number;
26
- /**
27
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
28
- * via the `definition` "nonNegativeIntegerDefault0".
29
- */
30
- export type NonNegativeIntegerDefault0V3_45_0 = NonNegativeIntegerV3_45_0;
31
- /**
32
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
33
- * via the `definition` "stringArray".
34
- */
35
- export type StringArrayV3_45_0 = string[];
36
- /**
37
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
38
- * via the `definition` "simpleTypes".
39
- */
40
- export type SimpleTypesV3_45_0 = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
41
- /**
42
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
43
- * via the `definition` "schemaArray".
44
- */
45
- export type SchemaArrayV3_45_0 = PropertySchemaV3_45_0[];
46
- /**
47
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
48
- * via the `definition` "ref".
49
- */
50
- export type RefV3_45_0 = string;
51
- /**
52
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
53
- * via the `definition` "objectOrRefArray".
54
- */
55
- export type ObjectOrRefArrayV3_45_0 = (RefSchemaV3_45_0 | RefSchemaLegacyV3_45_0 | ObjectSchemaV3_45_0)[];
56
- /**
57
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
58
- * via the `definition` "fieldMapping".
59
- */
60
- export type FieldMappingV3_45_0 = MappingStringV3_45_0 | MappingStringV3_45_0[];
61
- /**
62
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
63
- * via the `definition` "mappingString".
64
- */
65
- export type MappingStringV3_45_0 = string;
66
- /**
67
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
68
- * via the `definition` "resolver".
69
- */
70
- export type ResolverV3_45_0 = BasicResolverV3_45_0 | ComposeResolverV3_45_0;
71
- /**
72
- * A single resolver, can be composed with the ComposeResolver.
73
- *
74
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
75
- * via the `definition` "basicResolver".
76
- */
77
- export type BasicResolverV3_45_0 = UtilResolverV3_45_0 | DelegateResolverV3_45_0 | TakeshapeResolverV3_45_0 | ShapedbResolverV3_45_0 | ShapedbResolverShapeNameNotRequiredV3_45_0 | GraphqlResolverV3_45_0 | RestResolverV3_45_0 | AwsLambdaResolverV3_45_0 | SalsifyResolverV3_45_0 | FunctionResolverV3_45_0 | AIGenerateTextResolverV3_45_0 | AIEmbeddingResolverV3_45_0;
78
- /**
79
- * Name of the resolver function.
80
- */
81
- export type UtilResolverNameV3_45_0 = 'util:noop' | 'util:wrap';
82
- /**
83
- * An object describing an operation to generate a parameter.
84
- *
85
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
86
- * via the `definition` "parameterOp".
87
- */
88
- export type ParameterOpV3_45_0 = ParameterOpNestedV3_45_0 | ParameterOpValueV3_45_0 | ParameterOpMappingV3_45_0 | ParameterOpOpV3_45_0;
89
- /**
90
- * A tuple with a string directive name, and options to pass to the directive
91
- *
92
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
93
- * via the `definition` "directiveConfigItem".
94
- */
95
- export type DirectiveConfigItemV3_45_0 = [DirectiveNameV3_45_0, DirectiveOptionsV3_45_0];
96
- export type DirectiveNameV3_45_0 = string;
97
- /**
98
- * An array of individual directive config items to process in order
99
- *
100
- * This interface was referenced by `DirectiveMappingMapV3_45_0`'s JSON-Schema definition
101
- * via the `patternProperty` "[0-9A-Za-z_-]+".
102
- *
103
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
104
- * via the `definition` "directiveConfig".
105
- */
106
- export type DirectiveConfigV3_45_0 = DirectiveConfigItemV3_45_0[];
107
- /**
108
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
109
- * via the `definition` "parameterOpList".
110
- */
111
- export type ParameterOpListV3_45_0 = ParameterOpV3_45_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 `ProjectSchemaJSONV3_45_0`'s JSON-Schema
116
- * via the `definition` "argsMapping".
117
- */
118
- export type ArgsMappingV3_45_0 = DirectiveMappingMapV3_45_0 | DirectiveConfigV3_45_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 `ProjectSchemaJSONV3_45_0`'s JSON-Schema
123
- * via the `definition` "resultsMapping".
124
- */
125
- export type ResultsMappingV3_45_0 = DirectiveMappingMapV3_45_0 | DirectiveConfigV3_45_0;
126
- /**
127
- * Name of the resolver function.
128
- */
129
- export type DelegateResolverNameV3_45_0 = 'delegate';
130
- /**
131
- * Name of the resolver function.
132
- */
133
- export type TakeshapeResolverNameV3_45_0 = 'takeshape:getUser' | 'takeshape:search' | 'takeshape:vectorSearch' | 'takeshape:queryApiIndex';
134
- /**
135
- * Name of the resolver function.
136
- */
137
- export type ShapedbResolverNameV3_45_0 = 'shapedb:get' | 'shapedb:create' | 'shapedb:update' | 'shapedb:delete' | 'shapedb:duplicate' | 'shapedb:find';
138
- /**
139
- * Name of the resolver function.
140
- */
141
- export type ShapedbResolverShapeNameNotRequiredNameV3_45_0 = 'shapedb:list' | 'shapedb:taxonomySuggest' | 'shapedb:getRelated';
142
- /**
143
- * Name of the resolver function.
144
- */
145
- export type GraphqlResolverNameV3_45_0 = 'graphql:query' | 'graphql:mutation' | 'shopify:bulkQuery';
146
- /**
147
- * Name of the resolver function.
148
- */
149
- export type RestResolverNameV3_45_0 = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
150
- /**
151
- * A tuple with a string key and a directive config to evaluate
152
- *
153
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
154
- * via the `definition` "directiveMappingArrayItem".
155
- */
156
- export type DirectiveMappingArrayItemV3_45_0 = [string, DirectiveConfigV3_45_0];
157
- /**
158
- * An array of key / value or directive config tuples
159
- */
160
- export type SearchParamsMappingV3_45_0 = DirectiveMappingArrayItemV3_45_0[];
161
- /**
162
- * Name of the resolver function.
163
- */
164
- export type AwsLambdaResolverNameV3_45_0 = 'awsLambda:invoke';
165
- /**
166
- * Name of the resolver function.
167
- */
168
- export type SalsifyResolverNameV3_45_0 = 'salsify:listChannelProducts';
169
- /**
170
- * Name of the resolver function.
171
- */
172
- export type FunctionResolverNameV3_45_0 = 'function:run';
173
- export type FunctionResolverJavascriptV3_45_0 = string;
174
- /**
175
- * Name of the resolver function.
176
- */
177
- export type AIResolverNameV3_45_0 = 'ai:generateText';
178
- /**
179
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
180
- * via the `definition` "aiGuardrail".
181
- */
182
- export type AIGuardrailV3_45_0 = AISimilarityGuardrailV3_45_0;
183
- /**
184
- * Name of the resolver function.
185
- */
186
- export type AIResolverNameV3_45_01 = 'ai:createEmbedding';
187
- /**
188
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
189
- * via the `definition` "dependencies".
190
- */
191
- export type DependenciesV3_45_0 = string;
192
- /**
193
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
194
- * via the `definition` "returnShape".
195
- */
196
- export type ReturnShapeV3_45_0 = string | ReturnShapeArraySchemaV3_45_0;
197
- /**
198
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
199
- * via the `definition` "returnShapeArraySchema".
200
- */
201
- export type ReturnShapeArraySchemaV3_45_0 = PropertySchemaV3_45_0 & {
202
- type: 'array';
203
- items: RefSchemaV3_45_0 | {
204
- type: 'boolean' | 'integer' | 'number' | 'string' | 'object';
205
- [k: string]: any;
206
- };
207
- };
208
- export type ModelTypeV3_45_0 = 'single' | 'multiple' | 'taxonomy';
209
- /**
210
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
211
- * via the `definition` "paginationConfig".
212
- */
213
- export type PaginationConfigV3_45_0 = PaginationCursorConfigV3_45_0 | PaginationPageConfigV3_45_0 | PaginationOffsetConfigV3_45_0;
214
- /**
215
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
216
- * via the `definition` "cacheTriggerConfig".
217
- */
218
- export type CacheTriggerConfigV3_45_0 = CacheScheduleTriggerConfigV3_45_0 | CacheWebhookTriggerConfigV3_45_0;
219
- /**
220
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
221
- * via the `definition` "shapeSchema".
222
- */
223
- export type ShapeSchemaV3_45_0 = ShapeSchemaAllOfV3_45_0 | ShapeSchemaExtendsV3_45_0 | ShapeSchemaOneOfV3_45_0 | ShapeSchemaEnumV3_45_0 | ObjectSchemaV3_45_0 | ShapeSchemaAnyV3_45_0;
224
- /**
225
- * Human-readable id for use in the UI
226
- */
227
- export type WorkflowNameV3_45_0 = string;
228
- /**
229
- * machine-readable slug
230
- */
231
- export type NameV3_45_0 = string;
232
- /**
233
- * Human-readable id for use in the UI
234
- */
235
- export type TitleV3_45_0 = string;
236
- export type DescriptionV3_45_0 = string;
237
- /**
238
- * Hex color code
239
- */
240
- export type ColorV3_45_0 = string;
241
- /**
242
- * Value to indicate whether items in the state should be returned in list queries
243
- */
244
- export type LiveV3_45_0 = boolean;
245
- /**
246
- * machine-readable id
247
- */
248
- export type KeyV3_45_0 = string;
249
- export type StepsV3_45_0 = WorkflowStepV3_45_0[];
250
- /**
251
- * The general type of this service, specifying how and where it will be utilized.
252
- *
253
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
254
- * via the `definition` "serviceType".
255
- */
256
- export type ServiceTypeV3_45_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
257
- /**
258
- * The name of a health check to run
259
- */
260
- export type CheckNameV3_45_0 = 'graphqlIntrospection' | 'ping' | 'none';
261
- /**
262
- * The endpoint to use when checking the service health.
263
- */
264
- export type EndpointV3_45_0 = string;
265
- /**
266
- * A custom method to use for the health check request.
267
- */
268
- export type RequestMethodV3_45_0 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
269
- /**
270
- * A custom body to send along with the ping request.
271
- */
272
- export type RequestBodyV3_45_0 = string;
273
- /**
274
- * A custom body to send along with the ping request.
275
- */
276
- export type RequestBodyFormatV3_45_0 = 'string' | 'form' | 'json';
277
- /**
278
- * The amount of time to wait when receiving a response from the health check, in seconds.
279
- */
280
- export type RequestTimeoutV3_45_0 = number;
281
- /**
282
- * The response status code that qualifies as healthy.
283
- */
284
- export type HealthyResponseStatusCodeV3_45_0 = number;
285
- /**
286
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
287
- * via the `definition` "allOfSchema".
288
- */
289
- export type AllOfSchemaV3_45_0 = PropertySchemaV3_45_0 & {
290
- allOf: ObjectOrRefArrayV3_45_0;
291
- };
292
- /**
293
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
294
- * via the `definition` "extendsSchema".
295
- */
296
- export type ExtendsSchemaV3_45_0 = PropertySchemaV3_45_0 & {
297
- extends: ObjectOrRefArrayV3_45_0;
298
- };
299
- /**
300
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
301
- * via the `definition` "oneOfSchema".
302
- */
303
- export type OneOfSchemaV3_45_0 = PropertySchemaV3_45_0 & {
304
- oneOf: ObjectOrRefArrayV3_45_0;
305
- };
306
- /**
307
- * Options to be passed to the serialization routine.
308
- *
309
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
310
- * via the `definition` "parameterSerializeOptions".
311
- *
312
- * This interface was referenced by `undefined`'s JSON-Schema definition
313
- * via the `patternProperty` "^[^\n\r]*$".
314
- */
315
- export type ParameterSerializeOptionsV3_45_0 = ParameterSerializeStyleOptionsV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
316
- /**
317
- * An array of key / value or directive config tuples
318
- *
319
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
320
- * via the `definition` "directiveMappingArray".
321
- */
322
- export type DirectiveMappingArrayV3_45_0 = DirectiveMappingArrayItemV3_45_0[];
323
- /**
324
- * A resolver which references a specific service
325
- *
326
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
327
- * via the `definition` "serviceResolver".
328
- */
329
- export type ServiceResolverV3_45_0 = TakeshapeResolverV3_45_0 | ShapedbResolverShapeNameNotRequiredV3_45_0 | ShapedbResolverV3_45_0 | GraphqlResolverV3_45_0 | RestResolverV3_45_0 | AwsLambdaResolverV3_45_0;
330
- /**
331
- * An array of key / value or directive config tuples
332
- *
333
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
334
- * via the `definition` "searchParamsMapping".
335
- */
336
- export type SearchParamsMappingV3_45_01 = DirectiveMappingArrayItemV3_45_0[];
337
- /**
338
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
339
- * via the `definition` "shapeWithObjectSchema".
340
- */
341
- export type ShapeWithObjectSchemaV3_45_0 = ShapeJSONV3_45_0 & {
342
- schema: ObjectSchemaV3_45_0;
343
- };
344
- /**
345
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
346
- * via the `definition` "serviceAuthentication".
347
- */
348
- export type ServiceAuthenticationV3_45_0 = OAuth2AuthenticationV3_45_0 | OAuth2BearerAuthenticationV3_45_0 | BearerAuthenticationV3_45_0 | BasicAuthenticationV3_45_0 | SearchParamsAuthenticationV3_45_0 | AWSAuthenticationV3_45_0 | CustomAuthenticationV3_45_0;
349
- /**
350
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
351
- * via the `definition` "anyServiceConfig".
352
- */
353
- export type AnyServiceConfigV3_45_0 = ServiceConfigJSONV3_45_0 | ServiceConfigV3_45_0;
354
- export interface ProjectSchemaJSONV3_45_0 {
355
- $schema?: string;
356
- /**
357
- * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
358
- */
359
- apiVersion: string;
360
- /**
361
- * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
362
- */
363
- schemaVersion: '3.45.0';
364
- /**
365
- * The ID of the TakeShape project this schema belongs to.
366
- */
367
- projectId: string;
368
- /**
369
- * The ID of the TakeShape user who created the schema.
370
- */
371
- author?: string;
372
- deactivated?: number;
373
- /**
374
- * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
375
- */
376
- defaultLocale: string;
377
- locales: string[];
378
- queries: QueryMapV3_45_0;
379
- mutations: QueryMapV3_45_0;
380
- shapes: ShapeMapV3_45_0;
381
- forms?: FormMapV3_45_0;
382
- workflows: WorkflowMapV3_45_0;
383
- services?: ServiceMapJSONV3_45_0;
384
- }
385
- /**
386
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
387
- * via the `definition` "queryMap".
388
- */
389
- export interface QueryMapV3_45_0 {
390
- [k: string]: QueryJSONV3_45_0;
391
- }
392
- /**
393
- * This interface was referenced by `QueryMapV3_45_0`'s JSON-Schema definition
394
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
395
- *
396
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
397
- * via the `definition` "query".
398
- */
399
- export interface QueryJSONV3_45_0 {
400
- args?: ArgsV3_45_0;
401
- resolver: ResolverV3_45_0;
402
- shape: ReturnShapeV3_45_0;
403
- /**
404
- * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
405
- */
406
- description?: string;
407
- }
408
- /**
409
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
410
- * via the `definition` "propertySchema".
411
- */
412
- export interface PropertySchemaV3_45_0 {
413
- $ref?: string;
414
- title?: string;
415
- description?: string;
416
- default?: any;
417
- readOnly?: boolean;
418
- multipleOf?: number;
419
- maximum?: number;
420
- exclusiveMaximum?: number;
421
- minimum?: number;
422
- exclusiveMinimum?: number;
423
- maxLength?: NonNegativeIntegerV3_45_0;
424
- minLength?: NonNegativeIntegerDefault0V3_45_0;
425
- pattern?: string;
426
- additionalItems?: PropertySchemaV3_45_0;
427
- items?: PropertySchemaV3_45_0;
428
- maxItems?: NonNegativeIntegerV3_45_0;
429
- minItems?: NonNegativeIntegerDefault0V3_45_0;
430
- uniqueItems?: boolean;
431
- contains?: PropertySchemaV3_45_0;
432
- maxProperties?: NonNegativeIntegerV3_45_0;
433
- minProperties?: NonNegativeIntegerDefault0V3_45_0;
434
- required?: StringArrayV3_45_0;
435
- additionalProperties?: PropertySchemaV3_45_0 | false;
436
- definitions?: {
437
- [k: string]: PropertySchemaV3_45_0;
438
- };
439
- properties?: {
440
- [k: string]: PropertySchemaV3_45_0;
441
- };
442
- const?: any;
443
- enum?: any[];
444
- type?: SimpleTypesV3_45_0 | SimpleTypesV3_45_0[];
445
- format?: string;
446
- contentMediaType?: string;
447
- contentEncoding?: string;
448
- allOf?: SchemaArrayV3_45_0;
449
- discriminator?: {
450
- propertyName?: string;
451
- [k: string]: any;
452
- };
453
- oneOf?: SchemaArrayV3_45_0;
454
- extends?: ObjectOrRefArrayV3_45_0;
455
- '@backreference'?: BackReferenceV3_45_0;
456
- '@input'?: PropertySchemaV3_45_0;
457
- '@output'?: PropertySchemaV3_45_0;
458
- '@syncLocaleStructure'?: boolean;
459
- '@sensitive'?: boolean;
460
- '@draftjs'?: boolean;
461
- '@l10n'?: boolean;
462
- '@key'?: string;
463
- '@workflow'?: string;
464
- '@mapping'?: FieldMappingV3_45_0;
465
- '@tag'?: string;
466
- '@tags'?: string[];
467
- '@deprecationReason'?: string;
468
- '@args'?: ArgsV3_45_0;
469
- '@resolver'?: ResolverV3_45_0;
470
- '@dependencies'?: DependenciesV3_45_0;
471
- '@ref'?: RefV3_45_0;
472
- '@derivedFrom'?: string;
473
- '@indexed'?: IndexedV3_45_0;
474
- '@graphql'?: GraphQLConfigV3_45_0;
475
- }
476
- /**
477
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
478
- * via the `definition` "refSchema".
479
- */
480
- export interface RefSchemaV3_45_0 {
481
- '@ref': RefV3_45_0;
482
- [k: string]: any;
483
- }
484
- /**
485
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
486
- * via the `definition` "refSchemaLegacy".
487
- */
488
- export interface RefSchemaLegacyV3_45_0 {
489
- $ref: RefV3_45_0;
490
- [k: string]: any;
491
- }
492
- /**
493
- * A configuration object for a reverse reference in a relationship.
494
- *
495
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
496
- * via the `definition` "backreference".
497
- */
498
- export interface BackReferenceV3_45_0 {
499
- enabled: boolean;
500
- name?: string;
501
- }
502
- /**
503
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
504
- * via the `definition` "utilResolver".
505
- */
506
- export interface UtilResolverV3_45_0 {
507
- if?: string;
508
- id?: string;
509
- name: UtilResolverNameV3_45_0;
510
- options?: UtilResolverOptionsV3_45_0;
511
- /**
512
- * Optional value to return from the noop resolver.
513
- */
514
- value?: number | string | boolean | {
515
- [k: string]: any;
516
- } | any[] | null;
517
- args?: ParameterConfigForJsonV3_45_0;
518
- results?: ParameterConfigForJsonV3_45_0;
519
- argsMapping?: ArgsMappingV3_45_0;
520
- resultsMapping?: ResultsMappingV3_45_0;
521
- }
522
- export interface UtilResolverOptionsV3_45_0 {
523
- [k: string]: any;
524
- }
525
- /**
526
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
527
- * via the `definition` "parameterConfigForJson".
528
- */
529
- export interface ParameterConfigForJsonV3_45_0 {
530
- ops: ParameterOpListV3_45_0;
531
- }
532
- /**
533
- * An object describing an operation to generate a parameter, using a nested OpList.
534
- *
535
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
536
- * via the `definition` "parameterOpNested".
537
- */
538
- export interface ParameterOpNestedV3_45_0 {
539
- /**
540
- * A path to the parameter for this operation.
541
- */
542
- path: string;
543
- /**
544
- * A mode for this parameter's operation.
545
- */
546
- op?: 'set' | 'concat' | 'extend' | 'remove';
547
- ops: ParameterOpListV3_45_0;
548
- }
549
- /**
550
- * An object describing an operation to generate a parameter using a value.
551
- *
552
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
553
- * via the `definition` "parameterOpValue".
554
- */
555
- export interface ParameterOpValueV3_45_0 {
556
- /**
557
- * A path to the parameter for this operation.
558
- */
559
- path: string;
560
- /**
561
- * A mode for this parameter's operation.
562
- */
563
- op?: 'set' | 'concat' | 'extend' | 'remove';
564
- /**
565
- * A value to set directly at this path.
566
- */
567
- value: number | string | boolean | {
568
- [k: string]: any;
569
- } | any[] | null;
570
- }
571
- /**
572
- * An object describing an operation to generate a parameter using a mapping.
573
- *
574
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
575
- * via the `definition` "parameterOpMapping".
576
- */
577
- export interface ParameterOpMappingV3_45_0 {
578
- /**
579
- * A path to the parameter for this operation.
580
- */
581
- path: string;
582
- /**
583
- * A mode for this parameter's operation.
584
- */
585
- op?: 'set' | 'concat' | 'extend' | 'remove';
586
- /**
587
- * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
588
- */
589
- mapping: string | DirectiveConfigV3_45_0;
590
- }
591
- export interface DirectiveOptionsV3_45_0 {
592
- [k: string]: any;
593
- }
594
- /**
595
- * An object describing an operation to generate a parameter using a mapping.
596
- *
597
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
598
- * via the `definition` "parameterOpOp".
599
- */
600
- export interface ParameterOpOpV3_45_0 {
601
- /**
602
- * A path to the parameter for this operation.
603
- */
604
- path: string;
605
- /**
606
- * A mode for this parameter's operation.
607
- */
608
- op: 'set' | 'concat' | 'extend' | 'remove';
609
- }
610
- /**
611
- * An map of object keys / key paths to directive configs
612
- *
613
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
614
- * via the `definition` "directiveMappingMap".
615
- */
616
- export interface DirectiveMappingMapV3_45_0 {
617
- [k: string]: DirectiveConfigV3_45_0;
618
- }
619
- /**
620
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
621
- * via the `definition` "delegateResolver".
622
- */
623
- export interface DelegateResolverV3_45_0 {
624
- if?: string;
625
- id?: string;
626
- name: DelegateResolverNameV3_45_0;
627
- options?: DelegateResolverOptionsV3_45_0;
628
- argsMapping?: ArgsMappingV3_45_0;
629
- resultsMapping?: ResultsMappingV3_45_0;
630
- /**
631
- * A ref to a query/mutation/property to delegate to.
632
- */
633
- to: string;
634
- args?: ParameterConfigForJsonV3_45_0;
635
- results?: ParameterConfigForJsonV3_45_0;
636
- }
637
- export interface DelegateResolverOptionsV3_45_0 {
638
- [k: string]: any;
639
- }
640
- /**
641
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
642
- * via the `definition` "takeshapeResolver".
643
- */
644
- export interface TakeshapeResolverV3_45_0 {
645
- if?: string;
646
- id?: string;
647
- name: TakeshapeResolverNameV3_45_0;
648
- /**
649
- * Internal service identifier.
650
- */
651
- service: 'takeshape';
652
- options?: TakeshapeResolverOptionsV3_45_0;
653
- /**
654
- * An optional Shape name for the resolver.
655
- */
656
- shapeName?: string;
657
- args?: ParameterConfigForJsonV3_45_0;
658
- results?: ParameterConfigForJsonV3_45_0;
659
- argsMapping?: ArgsMappingV3_45_0;
660
- resultsMapping?: ResultsMappingV3_45_0;
661
- }
662
- export interface TakeshapeResolverOptionsV3_45_0 {
663
- [k: string]: any;
664
- }
665
- /**
666
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
667
- * via the `definition` "shapedbResolver".
668
- */
669
- export interface ShapedbResolverV3_45_0 {
670
- if?: string;
671
- id?: string;
672
- name: ShapedbResolverNameV3_45_0;
673
- /**
674
- * Internal service identifier.
675
- */
676
- service: 'shapedb';
677
- options?: ShapedbResolverOptionsV3_45_0;
678
- argsMapping?: ArgsMappingV3_45_0;
679
- resultsMapping?: ResultsMappingV3_45_0;
680
- /**
681
- * A Shape name for the resolver to use.
682
- */
683
- shapeName: string;
684
- args?: ParameterConfigForJsonV3_45_0;
685
- results?: ParameterConfigForJsonV3_45_0;
686
- }
687
- export interface ShapedbResolverOptionsV3_45_0 {
688
- [k: string]: any;
689
- }
690
- /**
691
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
692
- * via the `definition` "shapedbResolverShapeNameNotRequired".
693
- */
694
- export interface ShapedbResolverShapeNameNotRequiredV3_45_0 {
695
- if?: string;
696
- id?: string;
697
- name: ShapedbResolverShapeNameNotRequiredNameV3_45_0;
698
- /**
699
- * Internal service identifier.
700
- */
701
- service: 'shapedb';
702
- options?: ShapedbResolverShapeNameNotRequiredOptionsV3_45_0;
703
- /**
704
- * An optional Shape name for the resolver.
705
- */
706
- shapeName?: string;
707
- args?: ParameterConfigForJsonV3_45_0;
708
- results?: ParameterConfigForJsonV3_45_0;
709
- argsMapping?: ArgsMappingV3_45_0;
710
- resultsMapping?: ResultsMappingV3_45_0;
711
- }
712
- export interface ShapedbResolverShapeNameNotRequiredOptionsV3_45_0 {
713
- [k: string]: any;
714
- }
715
- /**
716
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
717
- * via the `definition` "graphqlResolver".
718
- */
719
- export interface GraphqlResolverV3_45_0 {
720
- if?: string;
721
- id?: string;
722
- name: GraphqlResolverNameV3_45_0;
723
- /**
724
- * Configuration for a service to use with this resolver.
725
- */
726
- service: string;
727
- argsMapping?: ArgsMappingV3_45_0;
728
- resultsMapping?: ResultsMappingV3_45_0;
729
- options?: GraphqlResolverOptionsV3_45_0;
730
- /**
731
- * A fieldname to use in queries.
732
- */
733
- fieldName: string;
734
- headers?: ParameterConfigForHeadersV3_45_0;
735
- searchParams?: ParameterConfigForSearchParamsV3_45_0;
736
- args?: ParameterConfigForJsonV3_45_0;
737
- results?: ParameterConfigForJsonV3_45_0;
738
- }
739
- export interface GraphqlResolverOptionsV3_45_0 {
740
- selectionSet?: string;
741
- unboxParentSelectionSet?: boolean;
742
- ignoreErrors?: boolean;
743
- skipWhenMissingArgs?: boolean;
744
- ttl?: number;
745
- timeout?: number;
746
- allowStream?: boolean;
747
- retry?: number | {
748
- [k: string]: any;
749
- };
750
- [k: string]: any;
751
- }
752
- /**
753
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
754
- * via the `definition` "parameterConfigForHeaders".
755
- */
756
- export interface ParameterConfigForHeadersV3_45_0 {
757
- ops: ParameterOpListV3_45_0;
758
- serialize?: ParameterSerializeConfigForHeadersV3_45_0;
759
- }
760
- /**
761
- * Top-level paths to use headers serialization options for.
762
- *
763
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
764
- * via the `definition` "parameterSerializeConfigForHeaders".
765
- */
766
- export interface ParameterSerializeConfigForHeadersV3_45_0 {
767
- defaults?: ParameterSerializeStyleOptionsForHeadersV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
768
- paths?: {
769
- /**
770
- * This interface was referenced by `undefined`'s JSON-Schema definition
771
- * via the `patternProperty` "^[^\n\r]*$".
772
- */
773
- [k: string]: ParameterSerializeStyleOptionsForHeadersV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
774
- };
775
- }
776
- /**
777
- * Options to be passed to the serialization routine.
778
- *
779
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
780
- * via the `definition` "parameterSerializeStyleOptionsForHeaders".
781
- */
782
- export interface ParameterSerializeStyleOptionsForHeadersV3_45_0 {
783
- style: 'simple' | 'none';
784
- explode?: boolean;
785
- }
786
- /**
787
- * Options to be passed to the serialization routine.
788
- *
789
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
790
- * via the `definition` "parameterSerializeContentOptions".
791
- */
792
- export interface ParameterSerializeContentOptionsV3_45_0 {
793
- contentType: string;
794
- /**
795
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
796
- */
797
- allowReserved?: boolean;
798
- skipEncoding?: boolean;
799
- /**
800
- * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
801
- */
802
- options?: {
803
- [k: string]: any;
804
- };
805
- }
806
- /**
807
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
808
- * via the `definition` "parameterConfigForSearchParams".
809
- */
810
- export interface ParameterConfigForSearchParamsV3_45_0 {
811
- ops: ParameterOpListV3_45_0;
812
- serialize?: ParameterSerializeConfigForSearchParamsV3_45_0;
813
- }
814
- /**
815
- * Top-level paths to use search params serialization options for.
816
- *
817
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
818
- * via the `definition` "parameterSerializeConfigForSearchParams".
819
- */
820
- export interface ParameterSerializeConfigForSearchParamsV3_45_0 {
821
- defaults?: ParameterSerializeStyleOptionsForSearchParamsV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
822
- paths?: {
823
- /**
824
- * This interface was referenced by `undefined`'s JSON-Schema definition
825
- * via the `patternProperty` "^[^\n\r]*$".
826
- */
827
- [k: string]: ParameterSerializeStyleOptionsForSearchParamsV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
828
- };
829
- }
830
- /**
831
- * Options to be passed to the serialization routine.
832
- *
833
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
834
- * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
835
- */
836
- export interface ParameterSerializeStyleOptionsForSearchParamsV3_45_0 {
837
- style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
838
- explode?: boolean;
839
- allowEmptyValue?: boolean;
840
- /**
841
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
842
- */
843
- allowReserved?: boolean;
844
- skipEncoding?: boolean;
845
- }
846
- /**
847
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
848
- * via the `definition` "restResolver".
849
- */
850
- export interface RestResolverV3_45_0 {
851
- if?: string;
852
- id?: string;
853
- name: RestResolverNameV3_45_0;
854
- /**
855
- * Configuration for a service to use with this resolver.
856
- */
857
- service: string;
858
- argsMapping?: ArgsMappingV3_45_0;
859
- searchParamsMapping?: SearchParamsMappingV3_45_0;
860
- resultsMapping?: ResultsMappingV3_45_0;
861
- options?: RestResolverOptionsV3_45_0;
862
- body?: ParameterConfigForBodyV3_45_0;
863
- form?: ParameterConfigForSearchParamsV3_45_0;
864
- headers?: ParameterConfigForHeadersV3_45_0;
865
- json?: ParameterConfigForJsonV3_45_0;
866
- /**
867
- * Mapping and serialization configuration for the path, or a simple string.
868
- */
869
- path: ParameterConfigForPathParamsV3_45_0 | string;
870
- searchParams?: ParameterConfigForSearchParamsV3_45_0;
871
- args?: ParameterConfigForJsonV3_45_0;
872
- results?: ParameterConfigForJsonV3_45_0;
873
- }
874
- export interface RestResolverOptionsV3_45_0 {
875
- trailingSlash?: boolean;
876
- allowStream?: boolean;
877
- ttl?: number;
878
- timeout?: number;
879
- retry?: number | {
880
- [k: string]: any;
881
- };
882
- [k: string]: any;
883
- }
884
- /**
885
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
886
- * via the `definition` "parameterConfigForBody".
887
- */
888
- export interface ParameterConfigForBodyV3_45_0 {
889
- ops: ParameterOpListV3_45_0;
890
- serialize?: ParameterSerializeConfigForBodyV3_45_0;
891
- }
892
- /**
893
- * Top-level paths to use serialization options for.
894
- *
895
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
896
- * via the `definition` "parameterSerializeConfigForBody".
897
- */
898
- export interface ParameterSerializeConfigForBodyV3_45_0 {
899
- content?: ParameterSerializeContentOptionsV3_45_0;
900
- }
901
- /**
902
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
903
- * via the `definition` "parameterConfigForPathParams".
904
- */
905
- export interface ParameterConfigForPathParamsV3_45_0 {
906
- ops: ParameterOpListV3_45_0;
907
- serialize: ParameterSerializeConfigForPathParamsV3_45_0;
908
- }
909
- /**
910
- * Top-level paths to use path params serialization options for.
911
- *
912
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
913
- * via the `definition` "parameterSerializeConfigForPathParams".
914
- */
915
- export interface ParameterSerializeConfigForPathParamsV3_45_0 {
916
- /**
917
- * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
918
- */
919
- template: string;
920
- defaults?: ParameterSerializeStyleOptionsForPathParamsV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
921
- paths?: {
922
- /**
923
- * This interface was referenced by `undefined`'s JSON-Schema definition
924
- * via the `patternProperty` "^[^\n\r]*$".
925
- */
926
- [k: string]: ParameterSerializeStyleOptionsForPathParamsV3_45_0 | ParameterSerializeContentOptionsV3_45_0;
927
- };
928
- }
929
- /**
930
- * Options to be passed to the serialization routine.
931
- *
932
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
933
- * via the `definition` "parameterSerializeStyleOptionsForPathParams".
934
- */
935
- export interface ParameterSerializeStyleOptionsForPathParamsV3_45_0 {
936
- style: 'simple' | 'label' | 'matrix' | 'none';
937
- explode?: boolean;
938
- allowEmptyValue?: boolean;
939
- /**
940
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
941
- */
942
- allowReserved?: boolean;
943
- skipEncoding?: boolean;
944
- }
945
- /**
946
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
947
- * via the `definition` "awsLambdaResolver".
948
- */
949
- export interface AwsLambdaResolverV3_45_0 {
950
- if?: string;
951
- id?: string;
952
- name: AwsLambdaResolverNameV3_45_0;
953
- /**
954
- * Configuration for a service to use with this resolver.
955
- */
956
- service: string;
957
- options?: AwsLambdaResolverOptionsV3_45_0;
958
- payload?: ParameterConfigForJsonV3_45_0;
959
- /**
960
- * Mapping configuration for the FunctionName.
961
- */
962
- functionName: string | ParameterConfigForAwsLambdaV3_45_0;
963
- clientContext?: ParameterConfigForJsonV3_45_0;
964
- args?: ParameterConfigForJsonV3_45_0;
965
- results?: ParameterConfigForJsonV3_45_0;
966
- argsMapping?: ArgsMappingV3_45_0;
967
- searchParamsMapping?: SearchParamsMappingV3_45_0;
968
- resultsMapping?: ResultsMappingV3_45_0;
969
- }
970
- export interface AwsLambdaResolverOptionsV3_45_0 {
971
- [k: string]: any;
972
- }
973
- /**
974
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
975
- * via the `definition` "parameterConfigForAwsLambda".
976
- */
977
- export interface ParameterConfigForAwsLambdaV3_45_0 {
978
- ops: ParameterOpListV3_45_0;
979
- serialize: ParameterSerializeConfigForPathParamsV3_45_0;
980
- }
981
- /**
982
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
983
- * via the `definition` "salsifyResolver".
984
- */
985
- export interface SalsifyResolverV3_45_0 {
986
- if?: string;
987
- id?: string;
988
- name: SalsifyResolverNameV3_45_0;
989
- /**
990
- * Configuration for a service to use with this resolver.
991
- */
992
- service: string;
993
- options?: SalsifyResolverOptionsV3_45_0;
994
- args?: ParameterConfigForJsonV3_45_0;
995
- results?: ParameterConfigForJsonV3_45_0;
996
- argsMapping?: ArgsMappingV3_45_0;
997
- resultsMapping?: ResultsMappingV3_45_0;
998
- }
999
- export interface SalsifyResolverOptionsV3_45_0 {
1000
- [k: string]: any;
1001
- }
1002
- /**
1003
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1004
- * via the `definition` "functionResolver".
1005
- */
1006
- export interface FunctionResolverV3_45_0 {
1007
- if?: string;
1008
- id?: string;
1009
- name: FunctionResolverNameV3_45_0;
1010
- options?: FunctionResolverOptionsV3_45_0;
1011
- args?: ParameterConfigForJsonV3_45_0;
1012
- results?: ParameterConfigForJsonV3_45_0;
1013
- argsMapping?: ArgsMappingV3_45_0;
1014
- resultsMapping?: ResultsMappingV3_45_0;
1015
- javascript?: FunctionResolverJavascriptV3_45_0;
1016
- }
1017
- export interface FunctionResolverOptionsV3_45_0 {
1018
- [k: string]: any;
1019
- }
1020
- /**
1021
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1022
- * via the `definition` "aiGenerateTextResolver".
1023
- */
1024
- export interface AIGenerateTextResolverV3_45_0 {
1025
- if?: string;
1026
- id?: string;
1027
- name: AIResolverNameV3_45_0;
1028
- /**
1029
- * Configuration for a service to use with this resolver.
1030
- */
1031
- service: string;
1032
- options?: AIGenerateTextResolverOptionsV3_45_0;
1033
- systemPrompt: string;
1034
- inputTemplate?: string;
1035
- model: string;
1036
- tools?: (string | AIToolConfigV3_45_0)[];
1037
- guardrails?: AIGuardrailV3_45_0[];
1038
- context?: ParameterConfigForJsonV3_45_0;
1039
- results?: ParameterConfigForJsonV3_45_0;
1040
- }
1041
- /**
1042
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1043
- * via the `definition` "aiGenerateTextResolverOptions".
1044
- */
1045
- export interface AIGenerateTextResolverOptionsV3_45_0 {
1046
- history?: boolean;
1047
- [k: string]: any;
1048
- }
1049
- /**
1050
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1051
- * via the `definition` "aiToolConfig".
1052
- */
1053
- export interface AIToolConfigV3_45_0 {
1054
- ref: string;
1055
- selectionSet?: string;
1056
- }
1057
- /**
1058
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1059
- * via the `definition` "aiSimilarityGuardrail".
1060
- */
1061
- export interface AISimilarityGuardrailV3_45_0 {
1062
- name: 'similarity';
1063
- shape: string;
1064
- defaultResponse: string;
1065
- threshold?: number;
1066
- }
1067
- /**
1068
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1069
- * via the `definition` "aiEmbeddingResolver".
1070
- */
1071
- export interface AIEmbeddingResolverV3_45_0 {
1072
- if?: string;
1073
- id?: string;
1074
- name: AIResolverNameV3_45_01;
1075
- /**
1076
- * Configuration for a service to use with this resolver.
1077
- */
1078
- service: string;
1079
- options?: AIEmbeddingResolverOptionsV3_45_0;
1080
- model: string;
1081
- args?: ParameterConfigForJsonV3_45_0;
1082
- results?: ParameterConfigForJsonV3_45_0;
1083
- }
1084
- /**
1085
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1086
- * via the `definition` "aiEmbeddingResolverOptions".
1087
- */
1088
- export interface AIEmbeddingResolverOptionsV3_45_0 {
1089
- useDependencies?: boolean;
1090
- [k: string]: any;
1091
- }
1092
- /**
1093
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1094
- * via the `definition` "composeResolver".
1095
- */
1096
- export interface ComposeResolverV3_45_0 {
1097
- compose: BasicResolverV3_45_0[];
1098
- resultsMapping?: DirectiveMappingMapV3_45_0 | DirectiveConfigV3_45_0;
1099
- results?: ParameterConfigForJsonV3_45_0;
1100
- }
1101
- /**
1102
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1103
- * via the `definition` "indexed".
1104
- */
1105
- export interface IndexedV3_45_0 {
1106
- nested?: boolean;
1107
- }
1108
- /**
1109
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1110
- * via the `definition` "graphql".
1111
- */
1112
- export interface GraphQLConfigV3_45_0 {
1113
- json?: boolean;
1114
- }
1115
- /**
1116
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1117
- * via the `definition` "shapeMap".
1118
- */
1119
- export interface ShapeMapV3_45_0 {
1120
- [k: string]: ShapeJSONV3_45_0;
1121
- }
1122
- /**
1123
- * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
1124
- *
1125
- * This interface was referenced by `ShapeMapV3_45_0`'s JSON-Schema definition
1126
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
1127
- *
1128
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1129
- * via the `definition` "shape".
1130
- */
1131
- export interface ShapeJSONV3_45_0 {
1132
- /**
1133
- * 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
1134
- */
1135
- name: string;
1136
- /**
1137
- * 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.
1138
- */
1139
- id: string;
1140
- /**
1141
- * The human-readable name for a Shape for use in a UI.
1142
- */
1143
- title: string;
1144
- description?: string;
1145
- type?: 'interface' | 'input' | 'output';
1146
- interfaces?: string[];
1147
- /**
1148
- * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
1149
- */
1150
- model?: {
1151
- type: ModelTypeV3_45_0;
1152
- };
1153
- workflow?: string;
1154
- loaders?: ShapeLoadersV3_45_0;
1155
- joins?: ShapeJoinsV3_45_0;
1156
- cache?: ShapeCacheConfigV3_45_0;
1157
- schema: ShapeSchemaV3_45_0;
1158
- }
1159
- /**
1160
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1161
- * via the `definition` "shapeLoaders".
1162
- */
1163
- export interface ShapeLoadersV3_45_0 {
1164
- list: StoredListQueryLoaderConfigV3_45_0 | StoredListQueryLoaderConfigV3_45_0[];
1165
- get?: GetQueryLoaderConfigV3_45_0;
1166
- }
1167
- /**
1168
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1169
- * via the `definition` "storedListQueryLoaderConfig".
1170
- */
1171
- export interface StoredListQueryLoaderConfigV3_45_0 {
1172
- query: string;
1173
- args?: {
1174
- [k: string]: any;
1175
- } | {
1176
- [k: string]: any;
1177
- }[];
1178
- pagination?: PaginationConfigV3_45_0;
1179
- }
1180
- /**
1181
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1182
- * via the `definition` "paginationCursorConfig".
1183
- */
1184
- export interface PaginationCursorConfigV3_45_0 {
1185
- type: 'cursor';
1186
- cursorArg: string;
1187
- cursorPath: string;
1188
- pageSize?: number;
1189
- pageSizeArg: string;
1190
- hasMorePath: string;
1191
- itemsPath: string;
1192
- }
1193
- /**
1194
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1195
- * via the `definition` "paginationPageConfig".
1196
- */
1197
- export interface PaginationPageConfigV3_45_0 {
1198
- type: 'page';
1199
- pageArg: string;
1200
- pageSize?: number;
1201
- pageSizeArg?: string;
1202
- itemsPath: string;
1203
- pageTotalPath: string;
1204
- }
1205
- /**
1206
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1207
- * via the `definition` "paginationOffsetConfig".
1208
- */
1209
- export interface PaginationOffsetConfigV3_45_0 {
1210
- type: 'offset';
1211
- offsetArg: string;
1212
- pageSize?: number;
1213
- pageSizeArg?: string;
1214
- itemsPath: string;
1215
- itemTotalPath: string;
1216
- }
1217
- /**
1218
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1219
- * via the `definition` "getQueryLoaderConfig".
1220
- */
1221
- export interface GetQueryLoaderConfigV3_45_0 {
1222
- query: string;
1223
- args?: {
1224
- [k: string]: any;
1225
- };
1226
- idArg?: string;
1227
- }
1228
- /**
1229
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1230
- * via the `definition` "shapeJoins".
1231
- */
1232
- export interface ShapeJoinsV3_45_0 {
1233
- [k: string]: ShapeJoinV3_45_0;
1234
- }
1235
- /**
1236
- * This interface was referenced by `ShapeJoinsV3_45_0`'s JSON-Schema definition
1237
- * via the `patternProperty` "[:0-9A-Za-z_-]+".
1238
- *
1239
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1240
- * via the `definition` "shapeJoin".
1241
- */
1242
- export interface ShapeJoinV3_45_0 {
1243
- resolver: DelegateResolverV3_45_0 | ShapedbResolverV3_45_0;
1244
- dependencies?: string;
1245
- }
1246
- /**
1247
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1248
- * via the `definition` "shapeCacheConfig".
1249
- */
1250
- export interface ShapeCacheConfigV3_45_0 {
1251
- enabled: boolean;
1252
- idField?: string;
1253
- searchSummaryField?: string;
1254
- fragment?: CachedFragmentConfigV3_45_0;
1255
- triggers?: CacheTriggerConfigV3_45_0[];
1256
- /**
1257
- * Number of seconds this Shape should be cached. Default 0.
1258
- */
1259
- maxAge?: number;
1260
- }
1261
- /**
1262
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1263
- * via the `definition` "cachedFragmentConfig".
1264
- */
1265
- export interface CachedFragmentConfigV3_45_0 {
1266
- ignoreFields?: string[];
1267
- maxDepth?: number;
1268
- selectionSet?: string;
1269
- includeDeprecated?: boolean;
1270
- }
1271
- /**
1272
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1273
- * via the `definition` "cacheScheduleTriggerConfig".
1274
- */
1275
- export interface CacheScheduleTriggerConfigV3_45_0 {
1276
- type: 'schedule';
1277
- loader: 'get' | 'list';
1278
- interval: number;
1279
- }
1280
- /**
1281
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1282
- * via the `definition` "cacheWebhookTriggerConfig".
1283
- */
1284
- export interface CacheWebhookTriggerConfigV3_45_0 {
1285
- type: 'webhook';
1286
- loader: 'get' | 'list';
1287
- service: string;
1288
- events: string[];
1289
- }
1290
- /**
1291
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1292
- * via the `definition` "shapeSchemaAllOf".
1293
- */
1294
- export interface ShapeSchemaAllOfV3_45_0 {
1295
- allOf: ObjectOrRefArrayV3_45_0;
1296
- }
1297
- /**
1298
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1299
- * via the `definition` "shapeSchemaExtends".
1300
- */
1301
- export interface ShapeSchemaExtendsV3_45_0 {
1302
- extends: ObjectOrRefArrayV3_45_0;
1303
- }
1304
- /**
1305
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1306
- * via the `definition` "shapeSchemaOneOf".
1307
- */
1308
- export interface ShapeSchemaOneOfV3_45_0 {
1309
- oneOf: ObjectOrRefArrayV3_45_0;
1310
- }
1311
- /**
1312
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1313
- * via the `definition` "shapeSchemaEnum".
1314
- */
1315
- export interface ShapeSchemaEnumV3_45_0 {
1316
- enum: any[];
1317
- }
1318
- /**
1319
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1320
- * via the `definition` "shapeSchemaAny".
1321
- */
1322
- export interface ShapeSchemaAnyV3_45_0 {
1323
- }
1324
- /**
1325
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1326
- * via the `definition` "formMap".
1327
- */
1328
- export interface FormMapV3_45_0 {
1329
- [k: string]: FormsConfigV3_45_0;
1330
- }
1331
- /**
1332
- * This interface was referenced by `FormMapV3_45_0`'s JSON-Schema definition
1333
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1334
- *
1335
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1336
- * via the `definition` "formsConfig".
1337
- */
1338
- export interface FormsConfigV3_45_0 {
1339
- default: FormConfigV3_45_0;
1340
- [k: string]: FormConfigV3_45_0;
1341
- }
1342
- /**
1343
- * This interface was referenced by `FormsConfigV3_45_0`'s JSON-Schema definition
1344
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1345
- *
1346
- * This interface was referenced by `undefined`'s JSON-Schema definition
1347
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1348
- *
1349
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1350
- * via the `definition` "formConfig".
1351
- */
1352
- export interface FormConfigV3_45_0 {
1353
- [k: string]: any;
1354
- }
1355
- /**
1356
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1357
- * via the `definition` "workflowMap".
1358
- */
1359
- export interface WorkflowMapV3_45_0 {
1360
- [k: string]: WorkflowV3_45_0;
1361
- }
1362
- /**
1363
- * This interface was referenced by `WorkflowMapV3_45_0`'s JSON-Schema definition
1364
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1365
- *
1366
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1367
- * via the `definition` "workflow".
1368
- */
1369
- export interface WorkflowV3_45_0 {
1370
- /**
1371
- * machine-readable id
1372
- */
1373
- name: string;
1374
- title: WorkflowNameV3_45_0;
1375
- steps: StepsV3_45_0;
1376
- [k: string]: any;
1377
- }
1378
- /**
1379
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1380
- * via the `definition` "workflowStep".
1381
- */
1382
- export interface WorkflowStepV3_45_0 {
1383
- name: NameV3_45_0;
1384
- title: TitleV3_45_0;
1385
- description?: DescriptionV3_45_0;
1386
- color: ColorV3_45_0;
1387
- live: LiveV3_45_0;
1388
- key: KeyV3_45_0;
1389
- }
1390
- /**
1391
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1392
- * via the `definition` "storedServiceMap".
1393
- */
1394
- export interface ServiceMapJSONV3_45_0 {
1395
- [k: string]: ServiceConfigJSONV3_45_0;
1396
- }
1397
- /**
1398
- * This interface was referenced by `ServiceMapJSONV3_45_0`'s JSON-Schema definition
1399
- * via the `patternProperty` "[0-9A-Za-z_-]+".
1400
- *
1401
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1402
- * via the `definition` "storedServiceConfig".
1403
- */
1404
- export interface ServiceConfigJSONV3_45_0 {
1405
- /**
1406
- * Machine-readable identifier, should typically be the same as the property name on the services object.
1407
- */
1408
- id: string;
1409
- /**
1410
- * Human-readable name for this service.
1411
- */
1412
- title: string;
1413
- /**
1414
- * The service provider id.
1415
- */
1416
- provider: string;
1417
- /**
1418
- * A namespace to use for the imported types tied to this service.
1419
- */
1420
- namespace?: string;
1421
- serviceType: ServiceTypeV3_45_0;
1422
- authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
1423
- authentication?: string;
1424
- healthCheck?: ServiceHealthCheckV3_45_0;
1425
- webhookId?: string;
1426
- /**
1427
- * Configuration options passed to and handled by the provider.
1428
- */
1429
- options?: {
1430
- [k: string]: any;
1431
- };
1432
- }
1433
- /**
1434
- * Configuration for ping health checks.
1435
- *
1436
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1437
- * via the `definition` "serviceHealthCheck".
1438
- */
1439
- export interface ServiceHealthCheckV3_45_0 {
1440
- checkName: CheckNameV3_45_0;
1441
- endpoint?: EndpointV3_45_0;
1442
- requestMethod?: RequestMethodV3_45_0;
1443
- requestHeaders?: RequestHeadersV3_45_0;
1444
- requestSearchParams?: RequestSearchParamsV3_45_0;
1445
- requestBody?: RequestBodyV3_45_0;
1446
- requestBodyFormat?: RequestBodyFormatV3_45_0;
1447
- requestTimeout?: RequestTimeoutV3_45_0;
1448
- healthyResponseStatusCode?: HealthyResponseStatusCodeV3_45_0;
1449
- }
1450
- /**
1451
- * Any custom headers to set with the health check request.
1452
- */
1453
- export interface RequestHeadersV3_45_0 {
1454
- [k: string]: any;
1455
- }
1456
- /**
1457
- * Any custom search params to set with the health check request.
1458
- */
1459
- export interface RequestSearchParamsV3_45_0 {
1460
- [k: string]: any;
1461
- }
1462
- /**
1463
- * All possible options for the more specific ParameterSerializeStyleOptions types.
1464
- *
1465
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1466
- * via the `definition` "parameterSerializeStyleOptions".
1467
- */
1468
- export interface ParameterSerializeStyleOptionsV3_45_0 {
1469
- style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
1470
- explode?: boolean;
1471
- allowEmptyValue?: boolean;
1472
- /**
1473
- * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1474
- */
1475
- allowReserved?: boolean;
1476
- skipEncoding?: boolean;
1477
- }
1478
- /**
1479
- * All possible options for the more specific ParameterSerializeConfig types.
1480
- *
1481
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1482
- * via the `definition` "parameterSerializeConfig".
1483
- */
1484
- export interface ParameterSerializeConfigV3_45_0 {
1485
- content?: ParameterSerializeContentOptionsV3_45_0;
1486
- defaults?: ParameterSerializeOptionsV3_45_0;
1487
- paths?: {
1488
- [k: string]: ParameterSerializeOptionsV3_45_0;
1489
- };
1490
- }
1491
- /**
1492
- * All possible options for the more specific ParameterConfig types.
1493
- *
1494
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1495
- * via the `definition` "parameterConfig".
1496
- */
1497
- export interface ParameterConfigV3_45_0 {
1498
- ops: ParameterOpListV3_45_0;
1499
- serialize?: ParameterSerializeConfigV3_45_0;
1500
- }
1501
- /**
1502
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1503
- * via the `definition` "listQueryLoaderConfig".
1504
- */
1505
- export interface ListQueryLoaderConfigV3_45_0 {
1506
- query: string;
1507
- args?: {
1508
- [k: string]: any;
1509
- };
1510
- pagination?: PaginationConfigV3_45_0;
1511
- }
1512
- /**
1513
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1514
- * via the `definition` "formScalarConfig".
1515
- */
1516
- export interface FormScalarConfigV3_45_0 {
1517
- widget: string;
1518
- }
1519
- /**
1520
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1521
- * via the `definition` "formObjectConfig".
1522
- */
1523
- export interface FormObjectConfigV3_45_0 {
1524
- widget?: string;
1525
- order?: string[];
1526
- properties?: {
1527
- [k: string]: FormConfigV3_45_0;
1528
- };
1529
- }
1530
- /**
1531
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1532
- * via the `definition` "formArrayConfig".
1533
- */
1534
- export interface FormArrayConfigV3_45_0 {
1535
- widget: string;
1536
- items: FormConfigV3_45_0;
1537
- }
1538
- /**
1539
- * For use with a custom auth handler on a service provider.
1540
- *
1541
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1542
- * via the `definition` "customAuthentication".
1543
- */
1544
- export interface CustomAuthenticationV3_45_0 {
1545
- type: 'custom';
1546
- [k: string]: any;
1547
- }
1548
- /**
1549
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1550
- * via the `definition` "searchParamsAuthentication".
1551
- */
1552
- export interface SearchParamsAuthenticationV3_45_0 {
1553
- type: 'searchParams';
1554
- params: {
1555
- name: string;
1556
- value: string;
1557
- }[];
1558
- }
1559
- /**
1560
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1561
- * via the `definition` "bearerAuthentication".
1562
- */
1563
- export interface BearerAuthenticationV3_45_0 {
1564
- type: 'bearer';
1565
- token: string;
1566
- prefix?: string;
1567
- header?: string;
1568
- }
1569
- /**
1570
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1571
- * via the `definition` "oauth2BearerAuthentication".
1572
- */
1573
- export interface OAuth2BearerAuthenticationV3_45_0 {
1574
- type: 'oauth2Bearer';
1575
- token: string;
1576
- prefix?: string;
1577
- header?: string;
1578
- scope?: string;
1579
- expiresAt?: string;
1580
- }
1581
- /**
1582
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1583
- * via the `definition` "basicAuthentication".
1584
- */
1585
- export interface BasicAuthenticationV3_45_0 {
1586
- type: 'basic';
1587
- username: string;
1588
- password: string;
1589
- useIso8859?: boolean;
1590
- }
1591
- /**
1592
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1593
- * via the `definition` "oauth2Authentication".
1594
- */
1595
- export interface OAuth2AuthenticationV3_45_0 {
1596
- type: 'oauth2';
1597
- grantType: 'authorizationCode' | 'clientCredentials';
1598
- authorizationUrl?: string;
1599
- accessTokenUrl?: string;
1600
- clientId: string;
1601
- clientSecret?: string;
1602
- scope?: string;
1603
- usePkce?: boolean;
1604
- redirectUrl?: string;
1605
- headerPrefix?: string;
1606
- audience?: string;
1607
- resource?: string;
1608
- }
1609
- /**
1610
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1611
- * via the `definition` "awsAuthentication".
1612
- */
1613
- export interface AWSAuthenticationV3_45_0 {
1614
- type: 'aws';
1615
- awsAccessKeyId: string;
1616
- awsSecretAccessKey: string;
1617
- }
1618
- /**
1619
- * This interface was referenced by `ProjectSchemaJSONV3_45_0`'s JSON-Schema
1620
- * via the `definition` "serviceConfig".
1621
- */
1622
- export interface ServiceConfigV3_45_0 {
1623
- /**
1624
- * Machine-readable identifier, should typically be the same as the property name on the services object.
1625
- */
1626
- id: string;
1627
- /**
1628
- * Human-readable name for this service.
1629
- */
1630
- title: string;
1631
- /**
1632
- * The service provider id.
1633
- */
1634
- provider: string;
1635
- /**
1636
- * A namespace to use for the imported types tied to this service.
1637
- */
1638
- namespace?: string;
1639
- serviceType: ServiceTypeV3_45_0;
1640
- authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
1641
- authentication?: ServiceAuthenticationV3_45_0;
1642
- healthCheck?: ServiceHealthCheckV3_45_0;
1643
- webhookId?: string;
1644
- /**
1645
- * Configuration options passed to and handled by the provider.
1646
- */
1647
- options?: {
1648
- [k: string]: any;
1649
- };
1650
- }