@takeshape/schema 12.1.1 → 12.1.5

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 (514) hide show
  1. package/dist/agents.d.ts +62 -0
  2. package/dist/agents.js +346 -0
  3. package/dist/api-version.d.ts +5 -0
  4. package/dist/api-version.js +17 -0
  5. package/dist/auth-schemas.d.ts +144 -0
  6. package/dist/auth-schemas.js +7 -0
  7. package/dist/auth-utils.d.ts +19 -0
  8. package/dist/auth-utils.js +26 -0
  9. package/dist/builtin-schema.d.ts +18 -0
  10. package/dist/builtin-schema.js +710 -0
  11. package/dist/constants.d.ts +1 -0
  12. package/dist/constants.js +1 -0
  13. package/dist/content-schema-transform.d.ts +35 -0
  14. package/dist/content-schema-transform.js +162 -0
  15. package/dist/create-input-schema.d.ts +9 -0
  16. package/dist/create-input-schema.js +68 -0
  17. package/dist/enum.d.ts +2 -0
  18. package/dist/enum.js +9 -0
  19. package/dist/flatten-templates.d.ts +2 -0
  20. package/dist/flatten-templates.js +20 -0
  21. package/dist/get-is-leaf.d.ts +3 -0
  22. package/dist/get-is-leaf.js +56 -0
  23. package/dist/index.d.ts +64 -0
  24. package/dist/index.js +61 -0
  25. package/dist/interfaces.d.ts +14 -0
  26. package/dist/interfaces.js +86 -0
  27. package/dist/layers/layers.d.ts +26 -0
  28. package/dist/layers/layers.js +301 -0
  29. package/dist/layers/refs.d.ts +102 -0
  30. package/dist/layers/refs.js +220 -0
  31. package/dist/layers/type-utils.d.ts +59 -0
  32. package/dist/layers/type-utils.js +118 -0
  33. package/dist/layers/visitor.d.ts +5 -0
  34. package/dist/layers/visitor.js +38 -0
  35. package/dist/migration/index.d.ts +79 -0
  36. package/dist/migration/index.js +110 -0
  37. package/dist/migration/to/v3.0.0.d.ts +4 -0
  38. package/dist/migration/to/v3.0.0.js +212 -0
  39. package/dist/migration/to/v3.1.0.d.ts +4 -0
  40. package/dist/migration/to/v3.1.0.js +194 -0
  41. package/dist/migration/to/v3.10.0.d.ts +4 -0
  42. package/dist/migration/to/v3.10.0.js +67 -0
  43. package/dist/migration/to/v3.11.0.d.ts +4 -0
  44. package/dist/migration/to/v3.11.0.js +85 -0
  45. package/dist/migration/to/v3.12.3.d.ts +4 -0
  46. package/dist/migration/to/v3.12.3.js +87 -0
  47. package/dist/migration/to/v3.13.0.d.ts +4 -0
  48. package/dist/migration/to/v3.13.0.js +17 -0
  49. package/dist/migration/to/v3.17.0.d.ts +4 -0
  50. package/dist/migration/to/v3.17.0.js +22 -0
  51. package/dist/migration/to/v3.18.0.d.ts +4 -0
  52. package/dist/migration/to/v3.18.0.js +64 -0
  53. package/dist/migration/to/v3.18.1.d.ts +4 -0
  54. package/dist/migration/to/v3.18.1.js +12 -0
  55. package/dist/migration/to/v3.18.2.d.ts +4 -0
  56. package/dist/migration/to/v3.18.2.js +19 -0
  57. package/dist/migration/to/v3.20.0.d.ts +4 -0
  58. package/dist/migration/to/v3.20.0.js +24 -0
  59. package/dist/migration/to/v3.22.0.d.ts +4 -0
  60. package/dist/migration/to/v3.22.0.js +25 -0
  61. package/dist/migration/to/v3.24.0.d.ts +4 -0
  62. package/dist/migration/to/v3.24.0.js +11 -0
  63. package/dist/migration/to/v3.25.0.d.ts +4 -0
  64. package/dist/migration/to/v3.25.0.js +11 -0
  65. package/dist/migration/to/v3.3.0.d.ts +4 -0
  66. package/dist/migration/to/v3.3.0.js +13 -0
  67. package/dist/migration/to/v3.31.0.d.ts +4 -0
  68. package/dist/migration/to/v3.31.0.js +38 -0
  69. package/dist/migration/to/v3.32.0.d.ts +4 -0
  70. package/dist/migration/to/v3.32.0.js +59 -0
  71. package/dist/migration/to/v3.34.0.d.ts +6 -0
  72. package/dist/migration/to/v3.34.0.js +111 -0
  73. package/dist/migration/to/v3.36.0.d.ts +4 -0
  74. package/dist/migration/to/v3.36.0.js +22 -0
  75. package/dist/migration/to/v3.39.0.d.ts +4 -0
  76. package/dist/migration/to/v3.39.0.js +45 -0
  77. package/dist/migration/to/v3.40.0.d.ts +4 -0
  78. package/dist/migration/to/v3.40.0.js +26 -0
  79. package/dist/migration/to/v3.46.0.d.ts +4 -0
  80. package/dist/migration/to/v3.46.0.js +35 -0
  81. package/dist/migration/to/v3.57.0.d.ts +4 -0
  82. package/dist/migration/to/v3.57.0.js +18 -0
  83. package/dist/migration/to/v3.60.0.d.ts +4 -0
  84. package/dist/migration/to/v3.60.0.js +129 -0
  85. package/dist/migration/to/v3.9.0.d.ts +4 -0
  86. package/dist/migration/to/v3.9.0.js +79 -0
  87. package/dist/migration/types.d.ts +26 -0
  88. package/dist/migration/types.js +3 -0
  89. package/dist/migration/utils.d.ts +2 -0
  90. package/dist/migration/utils.js +6 -0
  91. package/dist/mocks.d.ts +14 -0
  92. package/dist/mocks.js +58 -0
  93. package/dist/models/agent.d.ts +3 -0
  94. package/dist/models/agent.js +73 -0
  95. package/dist/models/project-schema.d.ts +28 -0
  96. package/dist/models/project-schema.js +186 -0
  97. package/dist/models/query.d.ts +3 -0
  98. package/dist/models/query.js +46 -0
  99. package/dist/models/runtime-schema.d.ts +9 -0
  100. package/dist/models/runtime-schema.js +20 -0
  101. package/dist/models/shape.d.ts +4 -0
  102. package/dist/models/shape.js +36 -0
  103. package/dist/models/tool.d.ts +4 -0
  104. package/dist/models/tool.js +147 -0
  105. package/dist/models/types.d.ts +97 -0
  106. package/dist/models/types.js +1 -0
  107. package/dist/models/user-schema.d.ts +7 -0
  108. package/dist/models/user-schema.js +9 -0
  109. package/dist/patterns.d.ts +12 -0
  110. package/dist/patterns.js +1 -0
  111. package/dist/project-schema/index.d.ts +229 -0
  112. package/dist/project-schema/index.js +89 -0
  113. package/dist/project-schema/latest.d.ts +2762 -0
  114. package/dist/project-schema/latest.js +7 -0
  115. package/dist/project-schema/migrate.d.ts +4 -0
  116. package/dist/project-schema/migrate.js +236 -0
  117. package/dist/project-schema/v1.0.0.d.ts +299 -0
  118. package/dist/project-schema/v1.0.0.js +7 -0
  119. package/dist/project-schema/v3.0.0.d.ts +478 -0
  120. package/dist/project-schema/v3.0.0.js +7 -0
  121. package/dist/project-schema/v3.1.0.d.ts +621 -0
  122. package/dist/project-schema/v3.1.0.js +7 -0
  123. package/dist/project-schema/v3.10.0.d.ts +1201 -0
  124. package/dist/project-schema/v3.10.0.js +7 -0
  125. package/dist/project-schema/v3.11.0.d.ts +1210 -0
  126. package/dist/project-schema/v3.11.0.js +7 -0
  127. package/dist/project-schema/v3.12.0.d.ts +1214 -0
  128. package/dist/project-schema/v3.12.0.js +7 -0
  129. package/dist/project-schema/v3.12.1.d.ts +1273 -0
  130. package/dist/project-schema/v3.12.1.js +7 -0
  131. package/dist/project-schema/v3.12.2.d.ts +1283 -0
  132. package/dist/project-schema/v3.12.2.js +7 -0
  133. package/dist/project-schema/v3.12.3.d.ts +1306 -0
  134. package/dist/project-schema/v3.12.3.js +7 -0
  135. package/dist/project-schema/v3.13.0.d.ts +1317 -0
  136. package/dist/project-schema/v3.13.0.js +7 -0
  137. package/dist/project-schema/v3.13.1.d.ts +1412 -0
  138. package/dist/project-schema/v3.13.1.js +7 -0
  139. package/dist/project-schema/v3.14.0.d.ts +1436 -0
  140. package/dist/project-schema/v3.14.0.js +7 -0
  141. package/dist/project-schema/v3.15.0.d.ts +1458 -0
  142. package/dist/project-schema/v3.15.0.js +7 -0
  143. package/dist/project-schema/v3.16.0.d.ts +1470 -0
  144. package/dist/project-schema/v3.16.0.js +7 -0
  145. package/dist/project-schema/v3.17.0.d.ts +1467 -0
  146. package/dist/project-schema/v3.17.0.js +7 -0
  147. package/dist/project-schema/v3.17.1.d.ts +1468 -0
  148. package/dist/project-schema/v3.17.1.js +7 -0
  149. package/dist/project-schema/v3.18.0.d.ts +1333 -0
  150. package/dist/project-schema/v3.18.0.js +7 -0
  151. package/dist/project-schema/v3.18.1.d.ts +1332 -0
  152. package/dist/project-schema/v3.18.1.js +7 -0
  153. package/dist/project-schema/v3.18.2.d.ts +1332 -0
  154. package/dist/project-schema/v3.18.2.js +7 -0
  155. package/dist/project-schema/v3.19.0.d.ts +1336 -0
  156. package/dist/project-schema/v3.19.0.js +7 -0
  157. package/dist/project-schema/v3.2.0.d.ts +632 -0
  158. package/dist/project-schema/v3.2.0.js +7 -0
  159. package/dist/project-schema/v3.20.0.d.ts +1336 -0
  160. package/dist/project-schema/v3.20.0.js +7 -0
  161. package/dist/project-schema/v3.21.0.d.ts +1338 -0
  162. package/dist/project-schema/v3.21.0.js +7 -0
  163. package/dist/project-schema/v3.22.0.d.ts +1344 -0
  164. package/dist/project-schema/v3.22.0.js +7 -0
  165. package/dist/project-schema/v3.23.0.d.ts +1376 -0
  166. package/dist/project-schema/v3.23.0.js +7 -0
  167. package/dist/project-schema/v3.24.0.d.ts +1364 -0
  168. package/dist/project-schema/v3.24.0.js +7 -0
  169. package/dist/project-schema/v3.25.0.d.ts +1363 -0
  170. package/dist/project-schema/v3.25.0.js +7 -0
  171. package/dist/project-schema/v3.26.0.d.ts +1388 -0
  172. package/dist/project-schema/v3.26.0.js +7 -0
  173. package/dist/project-schema/v3.27.0.d.ts +1397 -0
  174. package/dist/project-schema/v3.27.0.js +7 -0
  175. package/dist/project-schema/v3.28.0.d.ts +1416 -0
  176. package/dist/project-schema/v3.28.0.js +7 -0
  177. package/dist/project-schema/v3.29.0.d.ts +1423 -0
  178. package/dist/project-schema/v3.29.0.js +7 -0
  179. package/dist/project-schema/v3.3.0.d.ts +632 -0
  180. package/dist/project-schema/v3.3.0.js +7 -0
  181. package/dist/project-schema/v3.30.0.d.ts +1416 -0
  182. package/dist/project-schema/v3.30.0.js +7 -0
  183. package/dist/project-schema/v3.31.0.d.ts +1448 -0
  184. package/dist/project-schema/v3.31.0.js +7 -0
  185. package/dist/project-schema/v3.32.0.d.ts +1439 -0
  186. package/dist/project-schema/v3.32.0.js +7 -0
  187. package/dist/project-schema/v3.33.0.d.ts +1445 -0
  188. package/dist/project-schema/v3.33.0.js +7 -0
  189. package/dist/project-schema/v3.34.0.d.ts +1445 -0
  190. package/dist/project-schema/v3.34.0.js +7 -0
  191. package/dist/project-schema/v3.35.0.d.ts +1464 -0
  192. package/dist/project-schema/v3.35.0.js +7 -0
  193. package/dist/project-schema/v3.36.0.d.ts +1470 -0
  194. package/dist/project-schema/v3.36.0.js +7 -0
  195. package/dist/project-schema/v3.37.0.d.ts +1522 -0
  196. package/dist/project-schema/v3.37.0.js +7 -0
  197. package/dist/project-schema/v3.38.0.d.ts +1522 -0
  198. package/dist/project-schema/v3.38.0.js +7 -0
  199. package/dist/project-schema/v3.39.0.d.ts +1529 -0
  200. package/dist/project-schema/v3.39.0.js +7 -0
  201. package/dist/project-schema/v3.4.0.d.ts +624 -0
  202. package/dist/project-schema/v3.4.0.js +7 -0
  203. package/dist/project-schema/v3.40.0.d.ts +1530 -0
  204. package/dist/project-schema/v3.40.0.js +7 -0
  205. package/dist/project-schema/v3.41.0.d.ts +1530 -0
  206. package/dist/project-schema/v3.41.0.js +7 -0
  207. package/dist/project-schema/v3.42.0.d.ts +1534 -0
  208. package/dist/project-schema/v3.42.0.js +7 -0
  209. package/dist/project-schema/v3.43.0.d.ts +1536 -0
  210. package/dist/project-schema/v3.43.0.js +7 -0
  211. package/dist/project-schema/v3.44.0.d.ts +1621 -0
  212. package/dist/project-schema/v3.44.0.js +7 -0
  213. package/dist/project-schema/v3.45.0.d.ts +1650 -0
  214. package/dist/project-schema/v3.45.0.js +7 -0
  215. package/dist/project-schema/v3.46.0.d.ts +1703 -0
  216. package/dist/project-schema/v3.46.0.js +7 -0
  217. package/dist/project-schema/v3.47.0.d.ts +1736 -0
  218. package/dist/project-schema/v3.47.0.js +7 -0
  219. package/dist/project-schema/v3.48.0.d.ts +2208 -0
  220. package/dist/project-schema/v3.48.0.js +7 -0
  221. package/dist/project-schema/v3.49.0.d.ts +2217 -0
  222. package/dist/project-schema/v3.49.0.js +7 -0
  223. package/dist/project-schema/v3.5.0.d.ts +649 -0
  224. package/dist/project-schema/v3.5.0.js +7 -0
  225. package/dist/project-schema/v3.5.1.d.ts +649 -0
  226. package/dist/project-schema/v3.5.1.js +7 -0
  227. package/dist/project-schema/v3.50.0.d.ts +2269 -0
  228. package/dist/project-schema/v3.50.0.js +7 -0
  229. package/dist/project-schema/v3.51.0.d.ts +2269 -0
  230. package/dist/project-schema/v3.51.0.js +7 -0
  231. package/dist/project-schema/v3.52.0.d.ts +2269 -0
  232. package/dist/project-schema/v3.52.0.js +7 -0
  233. package/dist/project-schema/v3.53.0.d.ts +2350 -0
  234. package/dist/project-schema/v3.53.0.js +7 -0
  235. package/dist/project-schema/v3.54.0.d.ts +2369 -0
  236. package/dist/project-schema/v3.54.0.js +7 -0
  237. package/dist/project-schema/v3.55.0.d.ts +2369 -0
  238. package/dist/project-schema/v3.55.0.js +7 -0
  239. package/dist/project-schema/v3.56.0.d.ts +2405 -0
  240. package/dist/project-schema/v3.56.0.js +7 -0
  241. package/dist/project-schema/v3.57.0.d.ts +2601 -0
  242. package/dist/project-schema/v3.57.0.js +7 -0
  243. package/dist/project-schema/v3.58.0.d.ts +2601 -0
  244. package/dist/project-schema/v3.58.0.js +7 -0
  245. package/dist/project-schema/v3.59.0.d.ts +2650 -0
  246. package/dist/project-schema/v3.59.0.js +7 -0
  247. package/dist/project-schema/v3.6.0.d.ts +658 -0
  248. package/dist/project-schema/v3.6.0.js +7 -0
  249. package/dist/project-schema/v3.60.0.d.ts +2678 -0
  250. package/dist/project-schema/v3.60.0.js +7 -0
  251. package/dist/project-schema/v3.61.0.d.ts +2678 -0
  252. package/dist/project-schema/v3.61.0.js +7 -0
  253. package/dist/project-schema/v3.62.0.d.ts +2693 -0
  254. package/dist/project-schema/v3.62.0.js +7 -0
  255. package/dist/project-schema/v3.63.0.d.ts +2701 -0
  256. package/dist/project-schema/v3.63.0.js +7 -0
  257. package/dist/project-schema/v3.64.0.d.ts +2710 -0
  258. package/dist/project-schema/v3.64.0.js +7 -0
  259. package/dist/project-schema/v3.65.0.d.ts +2762 -0
  260. package/dist/project-schema/v3.65.0.js +7 -0
  261. package/dist/project-schema/v3.7.0.d.ts +961 -0
  262. package/dist/project-schema/v3.7.0.js +7 -0
  263. package/dist/project-schema/v3.8.0.d.ts +979 -0
  264. package/dist/project-schema/v3.8.0.js +7 -0
  265. package/dist/project-schema/v3.9.0.d.ts +1178 -0
  266. package/dist/project-schema/v3.9.0.js +7 -0
  267. package/dist/project-schema/v4.0.0.d.ts +1328 -0
  268. package/dist/project-schema/v4.0.0.js +7 -0
  269. package/dist/refs.d.ts +220 -0
  270. package/dist/refs.js +648 -0
  271. package/dist/relationships.d.ts +40 -0
  272. package/dist/relationships.js +302 -0
  273. package/dist/resolvers/ai/abort-agent-message-args.d.ts +16 -0
  274. package/dist/resolvers/ai/abort-agent-message-args.js +13 -0
  275. package/dist/resolvers/ai/abort-agent-message-response.d.ts +39 -0
  276. package/dist/resolvers/ai/abort-agent-message-response.js +19 -0
  277. package/dist/resolvers/ai/agent-attachment.d.ts +27 -0
  278. package/dist/resolvers/ai/agent-attachment.js +22 -0
  279. package/dist/resolvers/ai/agent-chat-args.d.ts +62 -0
  280. package/dist/resolvers/ai/agent-chat-args.js +30 -0
  281. package/dist/resolvers/ai/agent-chat-payload.d.ts +35 -0
  282. package/dist/resolvers/ai/agent-chat-payload.js +26 -0
  283. package/dist/resolvers/ai/agent-chat-response.d.ts +366 -0
  284. package/dist/resolvers/ai/agent-chat-response.js +21 -0
  285. package/dist/resolvers/ai/agent-generate-args.d.ts +62 -0
  286. package/dist/resolvers/ai/agent-generate-args.js +30 -0
  287. package/dist/resolvers/ai/agent-message-input.d.ts +73 -0
  288. package/dist/resolvers/ai/agent-message-input.js +39 -0
  289. package/dist/resolvers/ai/agent-message-output.d.ts +169 -0
  290. package/dist/resolvers/ai/agent-message-output.js +77 -0
  291. package/dist/resolvers/ai/agent-message-payload.d.ts +849 -0
  292. package/dist/resolvers/ai/agent-message-payload.js +167 -0
  293. package/dist/resolvers/ai/agent-run-mode.d.ts +8 -0
  294. package/dist/resolvers/ai/agent-run-mode.js +9 -0
  295. package/dist/resolvers/ai/agent-session-payload.d.ts +840 -0
  296. package/dist/resolvers/ai/agent-session-payload.js +218 -0
  297. package/dist/resolvers/ai/ai-usage-item.d.ts +70 -0
  298. package/dist/resolvers/ai/ai-usage-item.js +70 -0
  299. package/dist/resolvers/ai/create-agent-session-response.d.ts +276 -0
  300. package/dist/resolvers/ai/create-agent-session-response.js +9 -0
  301. package/dist/resolvers/ai/embedding-search.d.ts +54 -0
  302. package/dist/resolvers/ai/embedding-search.js +46 -0
  303. package/dist/resolvers/ai/get-agent-message-args.d.ts +16 -0
  304. package/dist/resolvers/ai/get-agent-message-args.js +13 -0
  305. package/dist/resolvers/ai/get-agent-message-response.d.ts +1253 -0
  306. package/dist/resolvers/ai/get-agent-message-response.js +79 -0
  307. package/dist/resolvers/ai/inspect-agent-args.d.ts +16 -0
  308. package/dist/resolvers/ai/inspect-agent-args.js +13 -0
  309. package/dist/resolvers/ai/inspect-agent-response.d.ts +631 -0
  310. package/dist/resolvers/ai/inspect-agent-response.js +48 -0
  311. package/dist/resolvers/ai/send-agent-feedback-args.d.ts +52 -0
  312. package/dist/resolvers/ai/send-agent-feedback-args.js +16 -0
  313. package/dist/resolvers/ai/send-agent-message-args.d.ts +48 -0
  314. package/dist/resolvers/ai/send-agent-message-args.js +36 -0
  315. package/dist/resolvers/ai/send-agent-message-response.d.ts +432 -0
  316. package/dist/resolvers/ai/send-agent-message-response.js +51 -0
  317. package/dist/resolvers/ai/types.d.ts +8 -0
  318. package/dist/resolvers/ai/types.js +1 -0
  319. package/dist/resolvers/takeshape/assets/asset-image-meta.d.ts +79 -0
  320. package/dist/resolvers/takeshape/assets/asset-image-meta.js +98 -0
  321. package/dist/resolvers/takeshape/assets/asset-image-params.d.ts +901 -0
  322. package/dist/resolvers/takeshape/assets/asset-image-params.js +726 -0
  323. package/dist/resolvers/takeshape/assets/asset-image.d.ts +17 -0
  324. package/dist/resolvers/takeshape/assets/asset-image.js +15 -0
  325. package/dist/resolvers/takeshape/assets/asset.d.ts +125 -0
  326. package/dist/resolvers/takeshape/assets/asset.js +107 -0
  327. package/dist/resolvers/takeshape/assets/constants.d.ts +11 -0
  328. package/dist/resolvers/takeshape/assets/constants.js +11 -0
  329. package/dist/resolvers/takeshape/builtins/constants.d.ts +1 -0
  330. package/dist/resolvers/takeshape/builtins/constants.js +1 -0
  331. package/dist/runtime-schema.d.ts +6 -0
  332. package/dist/runtime-schema.js +85 -0
  333. package/dist/scalars.d.ts +2 -0
  334. package/dist/scalars.js +4 -0
  335. package/dist/schema-transform.d.ts +19 -0
  336. package/dist/schema-transform.js +74 -0
  337. package/dist/schema-util.d.ts +266 -0
  338. package/dist/schema-util.js +1127 -0
  339. package/dist/schemas/auth-schemas.json +400 -0
  340. package/dist/schemas/index.d.ts +4 -0
  341. package/dist/schemas/index.js +182 -0
  342. package/dist/schemas/project-schema/experimental-2025-07.json +1297 -0
  343. package/dist/schemas/project-schema/latest.d.ts +245 -0
  344. package/dist/schemas/project-schema/latest.js +25 -0
  345. package/dist/schemas/project-schema/latest.json +5109 -0
  346. package/dist/schemas/project-schema/meta-schema-v1.0.0.json +193 -0
  347. package/dist/schemas/project-schema/meta-schema-v3.0.0.json +608 -0
  348. package/dist/schemas/project-schema/meta-schema-v3.1.0.json +608 -0
  349. package/dist/schemas/project-schema/meta-schema-v3.2.0.json +612 -0
  350. package/dist/schemas/project-schema/meta-schema-v3.3.0.json +612 -0
  351. package/dist/schemas/project-schema/meta-schema-v3.4.0.json +637 -0
  352. package/dist/schemas/project-schema/meta-schema-v3.5.0.json +626 -0
  353. package/dist/schemas/project-schema/meta-schema-v3.5.1.json +626 -0
  354. package/dist/schemas/project-schema/meta-schema-v3.6.0.json +629 -0
  355. package/dist/schemas/project-schema/meta-schema-v3.7.0.json +1137 -0
  356. package/dist/schemas/project-schema/meta-schema-v3.8.0.json +1137 -0
  357. package/dist/schemas/project-schema/meta-schema-v3.9.0.json +1477 -0
  358. package/dist/schemas/project-schema/v1.0.0.json +321 -0
  359. package/dist/schemas/project-schema/v3.0.0.json +414 -0
  360. package/dist/schemas/project-schema/v3.1.0.json +572 -0
  361. package/dist/schemas/project-schema/v3.10.0.json +2097 -0
  362. package/dist/schemas/project-schema/v3.11.0.json +2141 -0
  363. package/dist/schemas/project-schema/v3.12.0.json +2144 -0
  364. package/dist/schemas/project-schema/v3.12.1.json +2282 -0
  365. package/dist/schemas/project-schema/v3.12.2.json +2304 -0
  366. package/dist/schemas/project-schema/v3.12.3.json +2357 -0
  367. package/dist/schemas/project-schema/v3.13.0.json +2377 -0
  368. package/dist/schemas/project-schema/v3.14.0.json +2385 -0
  369. package/dist/schemas/project-schema/v3.15.0.json +2365 -0
  370. package/dist/schemas/project-schema/v3.16.0.json +2373 -0
  371. package/dist/schemas/project-schema/v3.17.0.json +2378 -0
  372. package/dist/schemas/project-schema/v3.17.1.json +2380 -0
  373. package/dist/schemas/project-schema/v3.18.0.json +2356 -0
  374. package/dist/schemas/project-schema/v3.18.1.json +2357 -0
  375. package/dist/schemas/project-schema/v3.18.2.json +2357 -0
  376. package/dist/schemas/project-schema/v3.19.0.json +2369 -0
  377. package/dist/schemas/project-schema/v3.2.0.json +580 -0
  378. package/dist/schemas/project-schema/v3.20.0.json +2369 -0
  379. package/dist/schemas/project-schema/v3.21.0.json +2376 -0
  380. package/dist/schemas/project-schema/v3.22.0.json +2381 -0
  381. package/dist/schemas/project-schema/v3.23.0.json +2456 -0
  382. package/dist/schemas/project-schema/v3.24.0.json +2556 -0
  383. package/dist/schemas/project-schema/v3.25.0.json +2552 -0
  384. package/dist/schemas/project-schema/v3.26.0.json +2599 -0
  385. package/dist/schemas/project-schema/v3.27.0.json +2611 -0
  386. package/dist/schemas/project-schema/v3.28.0.json +2656 -0
  387. package/dist/schemas/project-schema/v3.29.0.json +2670 -0
  388. package/dist/schemas/project-schema/v3.3.0.json +581 -0
  389. package/dist/schemas/project-schema/v3.30.0.json +2656 -0
  390. package/dist/schemas/project-schema/v3.31.0.json +2714 -0
  391. package/dist/schemas/project-schema/v3.32.0.json +2708 -0
  392. package/dist/schemas/project-schema/v3.33.0.json +2715 -0
  393. package/dist/schemas/project-schema/v3.34.0.json +2715 -0
  394. package/dist/schemas/project-schema/v3.35.0.json +2748 -0
  395. package/dist/schemas/project-schema/v3.36.0.json +2756 -0
  396. package/dist/schemas/project-schema/v3.37.0.json +2821 -0
  397. package/dist/schemas/project-schema/v3.38.0.json +2819 -0
  398. package/dist/schemas/project-schema/v3.39.0.json +2827 -0
  399. package/dist/schemas/project-schema/v3.4.0.json +571 -0
  400. package/dist/schemas/project-schema/v3.40.0.json +2830 -0
  401. package/dist/schemas/project-schema/v3.41.0.json +2830 -0
  402. package/dist/schemas/project-schema/v3.42.0.json +2835 -0
  403. package/dist/schemas/project-schema/v3.43.0.json +2841 -0
  404. package/dist/schemas/project-schema/v3.44.0.json +3013 -0
  405. package/dist/schemas/project-schema/v3.45.0.json +3064 -0
  406. package/dist/schemas/project-schema/v3.46.0.json +3136 -0
  407. package/dist/schemas/project-schema/v3.47.0.json +3189 -0
  408. package/dist/schemas/project-schema/v3.48.0.json +3196 -0
  409. package/dist/schemas/project-schema/v3.49.0.json +3239 -0
  410. package/dist/schemas/project-schema/v3.5.0.json +571 -0
  411. package/dist/schemas/project-schema/v3.5.1.json +571 -0
  412. package/dist/schemas/project-schema/v3.50.0.json +3320 -0
  413. package/dist/schemas/project-schema/v3.51.0.json +3326 -0
  414. package/dist/schemas/project-schema/v3.52.0.json +3326 -0
  415. package/dist/schemas/project-schema/v3.53.0.json +3476 -0
  416. package/dist/schemas/project-schema/v3.54.0.json +3512 -0
  417. package/dist/schemas/project-schema/v3.55.0.json +3515 -0
  418. package/dist/schemas/project-schema/v3.56.0.json +3530 -0
  419. package/dist/schemas/project-schema/v3.57.0.json +4815 -0
  420. package/dist/schemas/project-schema/v3.58.0.json +4815 -0
  421. package/dist/schemas/project-schema/v3.59.0.json +4912 -0
  422. package/dist/schemas/project-schema/v3.6.0.json +587 -0
  423. package/dist/schemas/project-schema/v3.60.0.json +4974 -0
  424. package/dist/schemas/project-schema/v3.61.0.json +4974 -0
  425. package/dist/schemas/project-schema/v3.62.0.json +5007 -0
  426. package/dist/schemas/project-schema/v3.63.0.json +5020 -0
  427. package/dist/schemas/project-schema/v3.64.0.json +5032 -0
  428. package/dist/schemas/project-schema/v3.65.0.json +5109 -0
  429. package/dist/schemas/project-schema/v3.7.0.json +587 -0
  430. package/dist/schemas/project-schema/v3.8.0.json +604 -0
  431. package/dist/schemas/project-schema/v3.9.0.json +604 -0
  432. package/dist/schemas/project-schema/v4.0.0.json +2316 -0
  433. package/dist/schemas/project-schema.json +232 -0
  434. package/dist/service-dependencies.d.ts +13 -0
  435. package/dist/service-dependencies.js +165 -0
  436. package/dist/services/services.d.ts +31 -0
  437. package/dist/services/services.js +145 -0
  438. package/dist/services/types.d.ts +11 -0
  439. package/dist/services/types.js +1 -0
  440. package/dist/services/util.d.ts +16 -0
  441. package/dist/services/util.js +36 -0
  442. package/dist/shape-paths.d.ts +7 -0
  443. package/dist/shape-paths.js +40 -0
  444. package/dist/taxonomies.d.ts +15 -0
  445. package/dist/taxonomies.js +24 -0
  446. package/dist/template-shapes/index.d.ts +7 -0
  447. package/dist/template-shapes/index.js +33 -0
  448. package/dist/template-shapes/names.d.ts +10 -0
  449. package/dist/template-shapes/names.js +21 -0
  450. package/dist/template-shapes/templates.d.ts +32 -0
  451. package/dist/template-shapes/templates.js +316 -0
  452. package/dist/template-shapes/types.d.ts +15 -0
  453. package/dist/template-shapes/types.js +7 -0
  454. package/dist/template-shapes/where.d.ts +37 -0
  455. package/dist/template-shapes/where.js +415 -0
  456. package/dist/types/index.d.ts +3 -0
  457. package/dist/types/index.js +2 -0
  458. package/dist/types/transforms.d.ts +15 -0
  459. package/dist/types/transforms.js +1 -0
  460. package/dist/types/types.d.ts +206 -0
  461. package/dist/types/types.js +10 -0
  462. package/dist/types/utils.d.ts +112 -0
  463. package/dist/types/utils.js +269 -0
  464. package/dist/unions.d.ts +14 -0
  465. package/dist/unions.js +77 -0
  466. package/dist/util/agent-utils.d.ts +2 -0
  467. package/dist/util/agent-utils.js +7 -0
  468. package/dist/util/api-indexing.d.ts +9 -0
  469. package/dist/util/api-indexing.js +57 -0
  470. package/dist/util/coerce-value.d.ts +9 -0
  471. package/dist/util/coerce-value.js +32 -0
  472. package/dist/util/detect-cycles.d.ts +7 -0
  473. package/dist/util/detect-cycles.js +45 -0
  474. package/dist/util/expressions.d.ts +34 -0
  475. package/dist/util/expressions.js +350 -0
  476. package/dist/util/find-shape-at-path.d.ts +21 -0
  477. package/dist/util/find-shape-at-path.js +53 -0
  478. package/dist/util/form-config.d.ts +11 -0
  479. package/dist/util/form-config.js +62 -0
  480. package/dist/util/get-conflicting-properties.d.ts +6 -0
  481. package/dist/util/get-conflicting-properties.js +55 -0
  482. package/dist/util/get-return-shape.d.ts +4 -0
  483. package/dist/util/get-return-shape.js +30 -0
  484. package/dist/util/graphql-string.d.ts +6 -0
  485. package/dist/util/graphql-string.js +75 -0
  486. package/dist/util/has-arg.d.ts +6 -0
  487. package/dist/util/has-arg.js +25 -0
  488. package/dist/util/is-asset-property.d.ts +3 -0
  489. package/dist/util/is-asset-property.js +11 -0
  490. package/dist/util/merge.d.ts +17 -0
  491. package/dist/util/merge.js +278 -0
  492. package/dist/util/patch-schema.d.ts +13 -0
  493. package/dist/util/patch-schema.js +89 -0
  494. package/dist/util/query-field-path.d.ts +9 -0
  495. package/dist/util/query-field-path.js +23 -0
  496. package/dist/util/shapes.d.ts +5 -0
  497. package/dist/util/shapes.js +22 -0
  498. package/dist/util/tools.d.ts +10 -0
  499. package/dist/util/tools.js +39 -0
  500. package/dist/validate/ai.d.ts +6 -0
  501. package/dist/validate/ai.js +221 -0
  502. package/dist/validate/errors.d.ts +3 -0
  503. package/dist/validate/errors.js +20 -0
  504. package/dist/validate/types.d.ts +43 -0
  505. package/dist/validate/types.js +1 -0
  506. package/dist/validate/util.d.ts +9 -0
  507. package/dist/validate/util.js +62 -0
  508. package/dist/validate/validate.d.ts +41 -0
  509. package/dist/validate/validate.js +1042 -0
  510. package/dist/versions.d.ts +4 -0
  511. package/dist/versions.js +4 -0
  512. package/dist/workflows.d.ts +14 -0
  513. package/dist/workflows.js +66 -0
  514. package/package.json +6 -6
@@ -0,0 +1,2762 @@
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 `ProjectSchemaJSON`'s JSON-Schema
8
+ * via the `definition` "args".
9
+ */
10
+ export type Args = string | ObjectSchema | ExtendsSchema;
11
+ /**
12
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
13
+ * via the `definition` "objectSchema".
14
+ */
15
+ export type ObjectSchema = PropertySchema & {
16
+ type: 'object';
17
+ properties: {
18
+ [k: string]: PropertySchema;
19
+ };
20
+ };
21
+ /**
22
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
23
+ * via the `definition` "nonNegativeInteger".
24
+ */
25
+ export type NonNegativeInteger = number;
26
+ /**
27
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
28
+ * via the `definition` "nonNegativeIntegerDefault0".
29
+ */
30
+ export type NonNegativeIntegerDefault0 = NonNegativeInteger;
31
+ /**
32
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
33
+ * via the `definition` "stringArray".
34
+ */
35
+ export type StringArray = string[];
36
+ /**
37
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
38
+ * via the `definition` "simpleTypes".
39
+ */
40
+ export type SimpleTypes = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
41
+ /**
42
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
43
+ * via the `definition` "schemaArray".
44
+ */
45
+ export type SchemaArray = PropertySchema[];
46
+ /**
47
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
48
+ * via the `definition` "ref".
49
+ */
50
+ export type Ref = string;
51
+ /**
52
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
53
+ * via the `definition` "objectOrRefArray".
54
+ */
55
+ export type ObjectOrRefArray = (RefSchema | RefSchemaLegacy | ObjectSchema)[];
56
+ /**
57
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
58
+ * via the `definition` "fieldMapping".
59
+ */
60
+ export type FieldMapping = MappingString | MappingString[];
61
+ /**
62
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
63
+ * via the `definition` "mappingString".
64
+ */
65
+ export type MappingString = string;
66
+ /**
67
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
68
+ * via the `definition` "resolver".
69
+ */
70
+ export type Resolver = BasicResolver | ComposeResolver;
71
+ /**
72
+ * A single resolver, can be composed with the ComposeResolver.
73
+ *
74
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
75
+ * via the `definition` "basicResolver".
76
+ */
77
+ export type BasicResolver = UtilResolver | DelegateResolver | FetchAllResolver | TakeshapeResolver | ShapedbResolver | ShapedbResolverShapeNameNotRequired | GraphqlResolver | RestResolver | AwsLambdaResolver | SalsifyResolver | SyndigoResolver | FunctionResolver | AIGenerateTextResolver | AIGeneratePropertyResolver | AIEmbeddingResolver | AIEmbeddingSearchResolver | AIParseFileResolver | ChunkResolver | AISendAgentMessageResolver | AIInspectAgentResolver | AICreateAgentSessionResolver | AIGetAgentMessageResolver | AIAbortAgentMessageResolver | AISendAgentFeedbackResolver;
78
+ /**
79
+ * Name of the resolver function.
80
+ */
81
+ export type UtilResolverName = 'util:noop' | 'util:wrap';
82
+ /**
83
+ * An object describing an operation to generate a parameter.
84
+ *
85
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
86
+ * via the `definition` "parameterOp".
87
+ */
88
+ export type ParameterOp = ParameterOpNested | ParameterOpValue | ParameterOpMapping | ParameterOpOp;
89
+ /**
90
+ * A tuple with a string directive name, and options to pass to the directive
91
+ *
92
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
93
+ * via the `definition` "directiveConfigItem".
94
+ */
95
+ export type DirectiveConfigItem = [DirectiveName, DirectiveOptions];
96
+ export type DirectiveName = string;
97
+ /**
98
+ * An array of individual directive config items to process in order
99
+ *
100
+ * This interface was referenced by `DirectiveMappingMap`'s JSON-Schema definition
101
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
102
+ *
103
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
104
+ * via the `definition` "directiveConfig".
105
+ */
106
+ export type DirectiveConfig = DirectiveConfigItem[];
107
+ /**
108
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
109
+ * via the `definition` "parameterOpList".
110
+ */
111
+ export type ParameterOpList = ParameterOp[];
112
+ /**
113
+ * Maps a query's input args to the input expected by the service's endpoint.
114
+ *
115
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
116
+ * via the `definition` "argsMapping".
117
+ */
118
+ export type ArgsMapping = DirectiveMappingMap | DirectiveConfig;
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 `ProjectSchemaJSON`'s JSON-Schema
123
+ * via the `definition` "resultsMapping".
124
+ */
125
+ export type ResultsMapping = DirectiveMappingMap | DirectiveConfig;
126
+ /**
127
+ * Name of the resolver function.
128
+ */
129
+ export type DelegateResolverName = 'delegate';
130
+ /**
131
+ * Name of the resolver function.
132
+ */
133
+ export type FetchAllResolverName = 'fetchAll';
134
+ /**
135
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
136
+ * via the `definition` "paginationConfig".
137
+ */
138
+ export type PaginationConfig = PaginationCursorConfig | PaginationPageConfig | PaginationOffsetConfig;
139
+ /**
140
+ * Name of the resolver function.
141
+ */
142
+ export type TakeshapeResolverName = 'takeshape:get' | 'takeshape:getUser' | 'takeshape:search' | 'takeshape:vectorSearch' | 'takeshape:queryApiIndex' | 'takeshape:assetUrl' | 'takeshape:assetImage' | 'takeshape:assetImageMeta';
143
+ /**
144
+ * Name of the resolver function.
145
+ */
146
+ export type ShapedbResolverName = 'shapedb:get' | 'shapedb:create' | 'shapedb:update' | 'shapedb:delete' | 'shapedb:duplicate' | 'shapedb:find';
147
+ /**
148
+ * Name of the resolver function.
149
+ */
150
+ export type ShapedbResolverShapeNameNotRequiredName = 'shapedb:list' | 'shapedb:taxonomySuggest' | 'shapedb:getRelated';
151
+ /**
152
+ * Name of the resolver function.
153
+ */
154
+ export type GraphqlResolverName = 'graphql:query' | 'graphql:mutation' | 'shopify:bulkQuery';
155
+ /**
156
+ * Name of the resolver function.
157
+ */
158
+ export type RestResolverName = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
159
+ /**
160
+ * A tuple with a string key and a directive config to evaluate
161
+ *
162
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
163
+ * via the `definition` "directiveMappingArrayItem".
164
+ */
165
+ export type DirectiveMappingArrayItem = [string, DirectiveConfig];
166
+ /**
167
+ * An array of key / value or directive config tuples
168
+ */
169
+ export type SearchParamsMapping = DirectiveMappingArrayItem[];
170
+ /**
171
+ * Name of the resolver function.
172
+ */
173
+ export type AwsLambdaResolverName = 'awsLambda:invoke';
174
+ /**
175
+ * Name of the resolver function.
176
+ */
177
+ export type SalsifyResolverName = 'salsify:listChannelProducts';
178
+ /**
179
+ * Name of the resolver function.
180
+ */
181
+ export type SyndigoResolverName = 'syndigo:searchProducts';
182
+ /**
183
+ * Name of the resolver function.
184
+ */
185
+ export type FunctionResolverName = 'function:run';
186
+ export type FunctionResolverJavascript = string;
187
+ /**
188
+ * Name of the resolver function.
189
+ */
190
+ export type AIResolverName = 'ai:generateText' | 'ai:chat';
191
+ export type History = boolean;
192
+ /**
193
+ * Maximum number of tokens to generate.
194
+ */
195
+ export type MaximumTokens = number;
196
+ /**
197
+ * This is a number between 0 (almost no randomness) and 1 (very random). It is recommended to set either `temperature` or `topP`, but not both. Defaults to 0
198
+ */
199
+ export type Temperature = number;
200
+ /**
201
+ * Nucleus sampling. This is a number between 0 and 1. E.g. 0.1 would mean that only tokens with the top 10% probability mass are considered. It is recommended to set either `temperature` or `topP`, but not both.
202
+ */
203
+ export type TopP = number;
204
+ /**
205
+ * Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Recommended for advanced use cases only. You usually only need to use temperature.
206
+ */
207
+ export type TopK = number;
208
+ /**
209
+ * It affects the likelihood of the model to repeat information that is already in the prompt. The presence penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
210
+ */
211
+ export type PresencePenaltySetting = number;
212
+ /**
213
+ * It affects the likelihood of the model to repeatedly use the same words or phrases. The frequency penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
214
+ */
215
+ export type FrequencyPenaltySetting = number;
216
+ /**
217
+ * If set, the model will stop generating text when one of the stop sequences is generated.
218
+ */
219
+ export type StopSequences = string[];
220
+ /**
221
+ * The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
222
+ */
223
+ export type Seed = number;
224
+ /**
225
+ * Enable prompt caching for supported providers (e.g., Anthropic). Reduces token costs by caching system messages, tools, and conversation history.
226
+ *
227
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
228
+ * via the `definition` "promptCaching".
229
+ */
230
+ export type PromptCaching = boolean;
231
+ /**
232
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
233
+ * via the `definition` "agentToolConfigArg".
234
+ */
235
+ export type AgentToolConfigArg = AgentControlled | VariableValue;
236
+ /**
237
+ * The argument name that will be exposed by the tool for the LLM to use.
238
+ */
239
+ export type ToolArgumentName = string;
240
+ /**
241
+ * Name of argument to pass value to. This prevents the LLM from setting the argument.
242
+ */
243
+ export type ToolArgumentName1 = string;
244
+ /**
245
+ * Name of variable to pull value from.
246
+ */
247
+ export type StateVariableName = string;
248
+ /**
249
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
250
+ * via the `definition` "aiGuardrail".
251
+ */
252
+ export type AIGuardrail = AISimilarityGuardrail;
253
+ /**
254
+ * Name of the resolver function.
255
+ */
256
+ export type AIResolverName1 = 'ai:generateProperty';
257
+ /**
258
+ * Name of the resolver function.
259
+ */
260
+ export type AIResolverName2 = 'ai:createEmbedding';
261
+ /**
262
+ * Name of the resolver function.
263
+ */
264
+ export type AIResolverName3 = 'ai:embeddingSearch';
265
+ /**
266
+ * Name of the resolver function.
267
+ */
268
+ export type AIResolverName4 = 'ai:parseFile';
269
+ /**
270
+ * Name of the resolver function.
271
+ */
272
+ export type UtilResolverName1 = 'util:chunk';
273
+ /**
274
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
275
+ * via the `definition` "utilChunkResolverOptions".
276
+ */
277
+ export type UtilChunkResolverOptions = UtilChunkResolverOptionsCharacterCount | UtilChunkResolverOptionsSeparators | UtilChunkResolverOptionsMarkdown | UtilChunkResolverOptionsSemantic;
278
+ /**
279
+ * Name of the resolver function.
280
+ */
281
+ export type AIResolverName5 = 'ai:sendAgentMessage';
282
+ /**
283
+ * Name of the resolver function.
284
+ */
285
+ export type AIResolverName6 = 'ai:inspectAgent';
286
+ /**
287
+ * Name of the resolver function.
288
+ */
289
+ export type AIResolverName7 = 'ai:createAgentSession';
290
+ /**
291
+ * Name of the resolver function.
292
+ */
293
+ export type AIResolverName8 = 'ai:getAgentMessage';
294
+ /**
295
+ * Name of the resolver function.
296
+ */
297
+ export type AIResolverName9 = 'ai:abortAgentMessage';
298
+ /**
299
+ * Name of the resolver function.
300
+ */
301
+ export type AIResolverName10 = 'ai:sendAgentFeedback';
302
+ /**
303
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
304
+ * via the `definition` "dependencies".
305
+ */
306
+ export type Dependencies = string;
307
+ /**
308
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
309
+ * via the `definition` "extendsSchema".
310
+ */
311
+ export type ExtendsSchema = PropertySchema & {
312
+ extends: ObjectOrRefArray;
313
+ };
314
+ /**
315
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
316
+ * via the `definition` "returnShape".
317
+ */
318
+ export type ReturnShape = string | ReturnShapeArraySchema;
319
+ /**
320
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
321
+ * via the `definition` "returnShapeArraySchema".
322
+ */
323
+ export type ReturnShapeArraySchema = PropertySchema & {
324
+ type: 'array';
325
+ items: RefSchema | {
326
+ type: 'boolean' | 'integer' | 'number' | 'string' | 'object';
327
+ [k: string]: any;
328
+ };
329
+ };
330
+ export type ModelType = 'single' | 'multiple' | 'taxonomy';
331
+ /**
332
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
333
+ * via the `definition` "cacheTriggerConfig".
334
+ */
335
+ export type CacheTriggerConfig = CacheScheduleTriggerConfig | CacheWebhookTriggerConfig;
336
+ /**
337
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
338
+ * via the `definition` "shapeSchema".
339
+ */
340
+ export type ShapeSchema = ShapeSchemaAllOf | ShapeSchemaExtends | ShapeSchemaOneOf | ShapeSchemaEnum | ObjectSchema | ShapeSchemaAny;
341
+ /**
342
+ * Human-readable id for use in the UI
343
+ */
344
+ export type WorkflowName = string;
345
+ /**
346
+ * machine-readable slug
347
+ */
348
+ export type Name = string;
349
+ /**
350
+ * Human-readable id for use in the UI
351
+ */
352
+ export type Title = string;
353
+ export type Description = string;
354
+ /**
355
+ * Hex color code
356
+ */
357
+ export type Color = string;
358
+ /**
359
+ * Value to indicate whether items in the state should be returned in list queries
360
+ */
361
+ export type Live = boolean;
362
+ /**
363
+ * machine-readable id
364
+ */
365
+ export type Key = string;
366
+ export type Steps = WorkflowStep[];
367
+ /**
368
+ * The general type of this service, specifying how and where it will be utilized.
369
+ *
370
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
371
+ * via the `definition` "serviceType".
372
+ */
373
+ export type ServiceType = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
374
+ /**
375
+ * The name of a health check to run
376
+ */
377
+ export type CheckName = 'graphqlIntrospection' | 'ping' | 'none';
378
+ /**
379
+ * The endpoint to use when checking the service health.
380
+ */
381
+ export type Endpoint = string;
382
+ /**
383
+ * A custom method to use for the health check request.
384
+ */
385
+ export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
386
+ /**
387
+ * A custom body to send along with the ping request.
388
+ */
389
+ export type RequestBody = string;
390
+ /**
391
+ * A custom body to send along with the ping request.
392
+ */
393
+ export type RequestBodyFormat = 'string' | 'form' | 'json' | 'form-data';
394
+ /**
395
+ * The amount of time to wait when receiving a response from the health check, in seconds.
396
+ */
397
+ export type RequestTimeout = number;
398
+ /**
399
+ * The response status code that qualifies as healthy.
400
+ */
401
+ export type HealthyResponseStatusCode = number;
402
+ /**
403
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
404
+ * via the `definition` "serviceHealthCheckTrigger".
405
+ */
406
+ export type ServiceHealthCheckTrigger = 'manual' | 'schedule';
407
+ /**
408
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
409
+ * via the `definition` "agentApiInput".
410
+ */
411
+ export type AgentAPIInput = AgentAPIMutationInput;
412
+ export type InteractionTimeoutMilliseconds = number;
413
+ export type AgentStateSessionMemory = AgentStateSessionMemoryAssignment[];
414
+ export type Variables = AgentVariable[];
415
+ /**
416
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
417
+ * via the `definition` "agentExecution".
418
+ */
419
+ export type AgentExecution = AgentExecutionGraphQL | AgentExecutionGenerate | AgentExecutionChat;
420
+ /**
421
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
422
+ * via the `definition` "agentAiStateInput".
423
+ */
424
+ export type AgentAIStateInput = AgentAIStateInputArgument | AgentAIStateInputTemplate;
425
+ /**
426
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
427
+ * via the `definition` "agentAiStateAttachments".
428
+ */
429
+ export type AgentAIStateAttachments = AgentAIStateAttachmentsNone | AgentAIStateAttachmentsArg | AgentAIStateAttachmentsExpression;
430
+ export type History1 = boolean;
431
+ /**
432
+ * Maximum number of tokens to generate. Defaults to 1024
433
+ */
434
+ export type MaximumTokens1 = number;
435
+ /**
436
+ * This is a number between 0 (almost no randomness) and 1 (very random). It is recommended to set either `temperature` or `topP`, but not both. Defaults to 0
437
+ */
438
+ export type Temperature1 = number;
439
+ /**
440
+ * Nucleus sampling. This is a number between 0 and 1. E.g. 0.1 would mean that only tokens with the top 10% probability mass are considered. It is recommended to set either `temperature` or `topP`, but not both.
441
+ */
442
+ export type TopP1 = number;
443
+ /**
444
+ * Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Recommended for advanced use cases only. You usually only need to use temperature.
445
+ */
446
+ export type TopK1 = number;
447
+ /**
448
+ * It affects the likelihood of the model to repeat information that is already in the prompt. The presence penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
449
+ */
450
+ export type PresencePenaltySetting1 = number;
451
+ /**
452
+ * It affects the likelihood of the model to repeatedly use the same words or phrases. The frequency penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.
453
+ */
454
+ export type FrequencyPenaltySetting1 = number;
455
+ /**
456
+ * If set, the model will stop generating text when one of the stop sequences is generated.
457
+ */
458
+ export type StopSequences1 = string[];
459
+ /**
460
+ * The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
461
+ */
462
+ export type Seed1 = number;
463
+ /**
464
+ * Maximal number of automatic roundtrips for tool calls.
465
+ */
466
+ export type MaxToolRoundtrips = number;
467
+ /**
468
+ * If true, structured outputs will be enabled on the model for non-text requests.
469
+ */
470
+ export type StructuredOutputs = boolean;
471
+ /**
472
+ * Enable OpenAI schema format. Must be enabled if `structuredOutputs` is enabled.
473
+ */
474
+ export type EnableOpenAISchemaFormat = boolean;
475
+ export type MinimatchPattern = string;
476
+ /**
477
+ * Remove properties from the schema sent to the model with keys matching these minimatch glob patterns.
478
+ *
479
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
480
+ * via the `definition` "removePropertyKeyPatterns".
481
+ */
482
+ export type RemovePropertyKeyPatterns = MinimatchPattern[];
483
+ /**
484
+ * Remove Markdown formatting from the LLM response
485
+ */
486
+ export type StripMarkdown = boolean;
487
+ /**
488
+ * These steps are evaluated in order until a destination is found.
489
+ *
490
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
491
+ * via the `definition` "agentTransition".
492
+ */
493
+ export type AgentTransition = AgentTransitionImmediate | AgentTransitionSuspend;
494
+ export type AgentStateSessionMemory1 = AgentStateSessionMemoryAssignment[];
495
+ export type GuardID = string;
496
+ export type Variables1 = AgentVariable[];
497
+ /**
498
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
499
+ * via the `definition` "historyStrategyTransform".
500
+ */
501
+ export type HistoryStrategyTransform = HistoryStrategyTransformNone | HistoryStrategyTransformReplace | HistoryStrategyTransformSummarize;
502
+ /**
503
+ * Enabling this will require a proof-of-work token to be included with each request. This will prevent abuse and spam.
504
+ */
505
+ export type EnableAgentAbuseProtection = boolean;
506
+ /**
507
+ * The human-readable name of the Guard.
508
+ */
509
+ export type Name1 = string;
510
+ /**
511
+ * A description of the Guard.
512
+ */
513
+ export type Description1 = string;
514
+ /**
515
+ * Guards will not run unless enabled.
516
+ */
517
+ export type Enabled = boolean;
518
+ /**
519
+ * The remote id of the Guardrail.
520
+ */
521
+ export type GuardrailIdentifier = string;
522
+ /**
523
+ * The remote version of the Guardrail.
524
+ */
525
+ export type GuardrailVersion = string;
526
+ /**
527
+ * A message to return when the input message is blocked by the Guard.
528
+ */
529
+ export type BlockedInputMessaging = string;
530
+ /**
531
+ * A message to return when the output message is blocked by the Guard.
532
+ */
533
+ export type BlockedOutputsMessaging = string;
534
+ export type Example = string;
535
+ /**
536
+ * A topic to block.
537
+ */
538
+ export type Topic = {
539
+ name: string;
540
+ definition: string;
541
+ /**
542
+ * Examples of the topic that can hint the LLM.
543
+ */
544
+ examples?: Example[];
545
+ type: 'DENY';
546
+ }[];
547
+ export type InputStrength = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
548
+ export type OutputStrength = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
549
+ /**
550
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
551
+ * via the `definition` "guardrailModality".
552
+ */
553
+ export type GuardrailModality = 'TEXT' | 'IMAGE';
554
+ /**
555
+ * Whether to filter images or text
556
+ */
557
+ export type InputModalities = GuardrailModality[];
558
+ /**
559
+ * Whether to filter images or text
560
+ */
561
+ export type OutputModalities = GuardrailModality[];
562
+ /**
563
+ * Types of content to filter.
564
+ */
565
+ export type Filter = {
566
+ type: 'HATE' | 'INSULTS' | 'MICONDUCT' | 'PROMPT_ATTACK' | 'SEXUAL' | 'VIOLENCE';
567
+ inputStrength: InputStrength;
568
+ outputStrength: OutputStrength;
569
+ inputModalities?: InputModalities;
570
+ outputModalities?: OutputModalities;
571
+ }[];
572
+ /**
573
+ * Specific words to block.
574
+ */
575
+ export type WordList = {
576
+ text: string;
577
+ }[];
578
+ /**
579
+ * This is solely used for blocking profanity.
580
+ */
581
+ export type ManagedWordList = {
582
+ type: 'PROFANITY';
583
+ }[];
584
+ /**
585
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
586
+ * via the `definition` "guardrailSensitiveInformationAction".
587
+ */
588
+ export type GuardrailSensitiveInformationAction = 'ANONYMIZE' | 'BLOCK';
589
+ /**
590
+ * PII entity to infer from the text.
591
+ */
592
+ export type PIIEntity = {
593
+ type: 'ADDRESS' | 'AGE' | 'AWS_ACCESS_KEY' | 'AWS_SECRET_KEY' | 'CA_HEALTH_NUMBER' | 'CA_SOCIAL_INSURANCE_NUMBER' | 'CREDIT_DEBIT_CARD_CVV' | 'CREDIT_DEBIT_CARD_EXPIRY' | 'CREDIT_DEBIT_CARD_NUMBER' | 'DRIVER_ID' | 'EMAIL' | 'INTERNATIONAL_BANK_ACCOUNT_NUMBER' | 'IP_ADDRESS' | 'LICENSE_PLATE' | 'MAC_ADDRESS' | 'NAME' | 'PASSWORD' | 'PHONE' | 'PIN' | 'SWIFT_CODE' | 'UK_NATIONAL_HEALTH_SERVICE_NUMBER' | 'UK_NATIONAL_INSURANCE_NUMBER' | 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER' | 'URL' | 'USERNAME' | 'US_BANK_ACCOUNT_NUMBER' | 'US_BANK_ROUTING_NUMBER' | 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER' | 'US_PASSPORT_NUMBER' | 'US_SOCIAL_SECURITY_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER';
594
+ action: GuardrailSensitiveInformationAction;
595
+ }[];
596
+ /**
597
+ * A regular expression to match sensitive information.
598
+ */
599
+ export type RegularExpression = {
600
+ name: string;
601
+ description?: string;
602
+ pattern: string;
603
+ action: GuardrailSensitiveInformationAction;
604
+ }[];
605
+ /**
606
+ * The type of filter.
607
+ */
608
+ export type Type = 'GROUNDING' | 'RELEVANCE';
609
+ /**
610
+ * The threshold for the filter as a floating point value greater than 0.0 and less than 1.0.
611
+ */
612
+ export type Threshold = number;
613
+ /**
614
+ * Filter to evaluate grounding text.
615
+ */
616
+ export type Filter1 = {
617
+ type: Type;
618
+ threshold: Threshold;
619
+ }[];
620
+ /**
621
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
622
+ * via the `definition` "toolExecution".
623
+ */
624
+ export type ToolExecutionJSON = ToolExecutionRemoteJSON | ToolExecutionGraphQLJSON;
625
+ /**
626
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
627
+ * via the `definition` "toolQueryConfig".
628
+ */
629
+ export type ToolQueryConfig = ToolQueryRefConfig | string;
630
+ /**
631
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
632
+ * via the `definition` "allOfSchema".
633
+ */
634
+ export type AllOfSchema = PropertySchema & {
635
+ allOf: ObjectOrRefArray;
636
+ };
637
+ /**
638
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
639
+ * via the `definition` "oneOfSchema".
640
+ */
641
+ export type OneOfSchema = PropertySchema & {
642
+ oneOf: ObjectOrRefArray;
643
+ };
644
+ /**
645
+ * Options to be passed to the serialization routine.
646
+ *
647
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
648
+ * via the `definition` "parameterSerializeOptions".
649
+ *
650
+ * This interface was referenced by `undefined`'s JSON-Schema definition
651
+ * via the `patternProperty` "^[^\n\r]*$".
652
+ */
653
+ export type ParameterSerializeOptions = ParameterSerializeStyleOptions | ParameterSerializeContentOptions;
654
+ /**
655
+ * An array of key / value or directive config tuples
656
+ *
657
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
658
+ * via the `definition` "directiveMappingArray".
659
+ */
660
+ export type DirectiveMappingArray = DirectiveMappingArrayItem[];
661
+ /**
662
+ * A resolver which references a specific service
663
+ *
664
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
665
+ * via the `definition` "serviceResolver".
666
+ */
667
+ export type ServiceResolver = TakeshapeResolver | ShapedbResolverShapeNameNotRequired | ShapedbResolver | GraphqlResolver | RestResolver | AwsLambdaResolver;
668
+ /**
669
+ * An array of key / value or directive config tuples
670
+ *
671
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
672
+ * via the `definition` "searchParamsMapping".
673
+ */
674
+ export type SearchParamsMapping1 = DirectiveMappingArrayItem[];
675
+ /**
676
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
677
+ * via the `definition` "shapeWithObjectSchema".
678
+ */
679
+ export type ShapeWithObjectSchema = ShapeJSON & {
680
+ schema: ObjectSchema;
681
+ };
682
+ /**
683
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
684
+ * via the `definition` "serviceAuthentication".
685
+ */
686
+ export type ServiceAuthentication = OAuth2Authentication | OAuth2BearerAuthentication | BearerAuthentication | BasicAuthentication | SearchParamsAuthentication | AWSAuthentication | GoogleAuthentication | CustomAuthentication;
687
+ /**
688
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
689
+ * via the `definition` "anyServiceConfig".
690
+ */
691
+ export type AnyServiceConfig = ServiceConfigJSON | ServiceConfig;
692
+ export interface ProjectSchemaJSON {
693
+ $schema?: string;
694
+ /**
695
+ * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
696
+ */
697
+ apiVersion: string;
698
+ /**
699
+ * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
700
+ */
701
+ schemaVersion: '3.65.0';
702
+ /**
703
+ * The ID of the TakeShape project this schema belongs to.
704
+ */
705
+ projectId: string;
706
+ /**
707
+ * The ID of the TakeShape user who created the schema.
708
+ */
709
+ author?: string;
710
+ deactivated?: number;
711
+ /**
712
+ * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
713
+ */
714
+ defaultLocale: string;
715
+ locales: string[];
716
+ queries: QueryMap;
717
+ mutations: QueryMap;
718
+ shapes: ShapeMap;
719
+ forms?: FormMap;
720
+ workflows: WorkflowMap;
721
+ services?: ServiceMapJSON;
722
+ agents?: AgentMap;
723
+ guards?: GuardMap;
724
+ tools?: ToolMap;
725
+ }
726
+ /**
727
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
728
+ * via the `definition` "queryMap".
729
+ */
730
+ export interface QueryMap {
731
+ [k: string]: QueryJSON;
732
+ }
733
+ /**
734
+ * This interface was referenced by `QueryMap`'s JSON-Schema definition
735
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
736
+ *
737
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
738
+ * via the `definition` "query".
739
+ */
740
+ export interface QueryJSON {
741
+ args?: Args;
742
+ resolver: Resolver;
743
+ shape: ReturnShape;
744
+ /**
745
+ * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
746
+ */
747
+ description?: string;
748
+ }
749
+ /**
750
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
751
+ * via the `definition` "propertySchema".
752
+ */
753
+ export interface PropertySchema {
754
+ $ref?: string;
755
+ title?: string;
756
+ description?: string;
757
+ default?: any;
758
+ readOnly?: boolean;
759
+ multipleOf?: number;
760
+ maximum?: number;
761
+ exclusiveMaximum?: number;
762
+ minimum?: number;
763
+ exclusiveMinimum?: number;
764
+ maxLength?: NonNegativeInteger;
765
+ minLength?: NonNegativeIntegerDefault0;
766
+ pattern?: string;
767
+ additionalItems?: PropertySchema;
768
+ items?: PropertySchema;
769
+ maxItems?: NonNegativeInteger;
770
+ minItems?: NonNegativeIntegerDefault0;
771
+ uniqueItems?: boolean;
772
+ contains?: PropertySchema;
773
+ maxProperties?: NonNegativeInteger;
774
+ minProperties?: NonNegativeIntegerDefault0;
775
+ required?: StringArray;
776
+ additionalProperties?: PropertySchema | false;
777
+ definitions?: {
778
+ [k: string]: PropertySchema;
779
+ };
780
+ properties?: {
781
+ [k: string]: PropertySchema;
782
+ };
783
+ const?: any;
784
+ enum?: any[];
785
+ type?: SimpleTypes | SimpleTypes[];
786
+ format?: string;
787
+ contentMediaType?: string;
788
+ contentEncoding?: string;
789
+ allOf?: SchemaArray;
790
+ discriminator?: {
791
+ propertyName?: string;
792
+ [k: string]: any;
793
+ };
794
+ oneOf?: SchemaArray;
795
+ extends?: ObjectOrRefArray;
796
+ '@backreference'?: BackReference;
797
+ '@input'?: PropertySchema;
798
+ '@output'?: PropertySchema;
799
+ '@syncLocaleStructure'?: boolean;
800
+ '@sensitive'?: boolean;
801
+ '@draftjs'?: boolean;
802
+ '@l10n'?: boolean;
803
+ '@key'?: string;
804
+ '@workflow'?: string;
805
+ '@mapping'?: FieldMapping;
806
+ '@tag'?: string;
807
+ '@tags'?: string[];
808
+ '@deprecationReason'?: string;
809
+ '@args'?: Args;
810
+ '@resolver'?: Resolver;
811
+ '@dependencies'?: Dependencies;
812
+ '@ref'?: Ref;
813
+ '@derivedFrom'?: string;
814
+ '@indexed'?: Indexed;
815
+ '@graphql'?: GraphQLConfig;
816
+ }
817
+ /**
818
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
819
+ * via the `definition` "refSchema".
820
+ */
821
+ export interface RefSchema {
822
+ '@ref': Ref;
823
+ [k: string]: any;
824
+ }
825
+ /**
826
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
827
+ * via the `definition` "refSchemaLegacy".
828
+ */
829
+ export interface RefSchemaLegacy {
830
+ $ref: Ref;
831
+ [k: string]: any;
832
+ }
833
+ /**
834
+ * A configuration object for a reverse reference in a relationship.
835
+ *
836
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
837
+ * via the `definition` "backreference".
838
+ */
839
+ export interface BackReference {
840
+ enabled: boolean;
841
+ name?: string;
842
+ }
843
+ /**
844
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
845
+ * via the `definition` "utilResolver".
846
+ */
847
+ export interface UtilResolver {
848
+ if?: string;
849
+ id?: string;
850
+ name: UtilResolverName;
851
+ options?: UtilResolverOptions;
852
+ /**
853
+ * Optional value to return from the noop resolver.
854
+ */
855
+ value?: number | string | boolean | {
856
+ [k: string]: any;
857
+ } | any[] | null;
858
+ args?: ParameterConfigForJson;
859
+ results?: ParameterConfigForJson;
860
+ argsMapping?: ArgsMapping;
861
+ resultsMapping?: ResultsMapping;
862
+ }
863
+ export interface UtilResolverOptions {
864
+ [k: string]: any;
865
+ }
866
+ /**
867
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
868
+ * via the `definition` "parameterConfigForJson".
869
+ */
870
+ export interface ParameterConfigForJson {
871
+ ops: ParameterOpList;
872
+ }
873
+ /**
874
+ * An object describing an operation to generate a parameter, using a nested OpList.
875
+ *
876
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
877
+ * via the `definition` "parameterOpNested".
878
+ */
879
+ export interface ParameterOpNested {
880
+ /**
881
+ * A path to the parameter for this operation.
882
+ */
883
+ path: string;
884
+ /**
885
+ * A mode for this parameter's operation.
886
+ */
887
+ op?: 'set' | 'concat' | 'extend' | 'remove';
888
+ ops: ParameterOpList;
889
+ }
890
+ /**
891
+ * An object describing an operation to generate a parameter using a value.
892
+ *
893
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
894
+ * via the `definition` "parameterOpValue".
895
+ */
896
+ export interface ParameterOpValue {
897
+ /**
898
+ * A path to the parameter for this operation.
899
+ */
900
+ path: string;
901
+ /**
902
+ * A mode for this parameter's operation.
903
+ */
904
+ op?: 'set' | 'concat' | 'extend' | 'remove';
905
+ /**
906
+ * A value to set directly at this path.
907
+ */
908
+ value: number | string | boolean | {
909
+ [k: string]: any;
910
+ } | any[] | null;
911
+ }
912
+ /**
913
+ * An object describing an operation to generate a parameter using a mapping.
914
+ *
915
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
916
+ * via the `definition` "parameterOpMapping".
917
+ */
918
+ export interface ParameterOpMapping {
919
+ /**
920
+ * A path to the parameter for this operation.
921
+ */
922
+ path: string;
923
+ /**
924
+ * A mode for this parameter's operation.
925
+ */
926
+ op?: 'set' | 'concat' | 'extend' | 'remove';
927
+ /**
928
+ * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
929
+ */
930
+ mapping: string | DirectiveConfig;
931
+ }
932
+ export interface DirectiveOptions {
933
+ [k: string]: any;
934
+ }
935
+ /**
936
+ * An object describing an operation to generate a parameter using a mapping.
937
+ *
938
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
939
+ * via the `definition` "parameterOpOp".
940
+ */
941
+ export interface ParameterOpOp {
942
+ /**
943
+ * A path to the parameter for this operation.
944
+ */
945
+ path: string;
946
+ /**
947
+ * A mode for this parameter's operation.
948
+ */
949
+ op: 'set' | 'concat' | 'extend' | 'remove';
950
+ }
951
+ /**
952
+ * An map of object keys / key paths to directive configs
953
+ *
954
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
955
+ * via the `definition` "directiveMappingMap".
956
+ */
957
+ export interface DirectiveMappingMap {
958
+ [k: string]: DirectiveConfig;
959
+ }
960
+ /**
961
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
962
+ * via the `definition` "delegateResolver".
963
+ */
964
+ export interface DelegateResolver {
965
+ if?: string;
966
+ id?: string;
967
+ name: DelegateResolverName;
968
+ options?: DelegateResolverOptions;
969
+ argsMapping?: ArgsMapping;
970
+ resultsMapping?: ResultsMapping;
971
+ /**
972
+ * A ref to a query/mutation/property to delegate to.
973
+ */
974
+ to: string;
975
+ args?: ParameterConfigForJson;
976
+ results?: ParameterConfigForJson;
977
+ }
978
+ export interface DelegateResolverOptions {
979
+ [k: string]: any;
980
+ }
981
+ /**
982
+ * A resolver that automatically paginates through a GraphQL query and returns all items as a flat array.
983
+ *
984
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
985
+ * via the `definition` "fetchAllResolver".
986
+ */
987
+ export interface FetchAllResolver {
988
+ if?: string;
989
+ id?: string;
990
+ name: FetchAllResolverName;
991
+ options?: FetchAllResolverOptions;
992
+ /**
993
+ * The GraphQL query string to execute
994
+ */
995
+ query: string;
996
+ /**
997
+ * Path to the paginated field within the query response (e.g., 'variants'). All pagination paths are relative to this.
998
+ */
999
+ dataPath?: string;
1000
+ args?: ParameterConfigForJson;
1001
+ results?: ParameterConfigForJson;
1002
+ pagination?: PaginationConfig;
1003
+ }
1004
+ export interface FetchAllResolverOptions {
1005
+ /**
1006
+ * Maximum number of pages to fetch
1007
+ */
1008
+ maxPages?: number;
1009
+ /**
1010
+ * Number of items per page (overrides pagination config)
1011
+ */
1012
+ pageSize?: number;
1013
+ }
1014
+ /**
1015
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1016
+ * via the `definition` "paginationCursorConfig".
1017
+ */
1018
+ export interface PaginationCursorConfig {
1019
+ type: 'cursor';
1020
+ cursorArg: string;
1021
+ cursorPath: string;
1022
+ pageSize?: number;
1023
+ pageSizeArg: string;
1024
+ hasMorePath: string;
1025
+ itemsPath: string;
1026
+ }
1027
+ /**
1028
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1029
+ * via the `definition` "paginationPageConfig".
1030
+ */
1031
+ export interface PaginationPageConfig {
1032
+ type: 'page';
1033
+ pageArg: string;
1034
+ pageSize?: number;
1035
+ pageSizeArg?: string;
1036
+ itemsPath: string;
1037
+ pageTotalPath: string;
1038
+ }
1039
+ /**
1040
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1041
+ * via the `definition` "paginationOffsetConfig".
1042
+ */
1043
+ export interface PaginationOffsetConfig {
1044
+ type: 'offset';
1045
+ offsetArg: string;
1046
+ pageSize?: number;
1047
+ pageSizeArg?: string;
1048
+ itemsPath: string;
1049
+ itemTotalPath: string;
1050
+ }
1051
+ /**
1052
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1053
+ * via the `definition` "takeshapeResolver".
1054
+ */
1055
+ export interface TakeshapeResolver {
1056
+ if?: string;
1057
+ id?: string;
1058
+ name: TakeshapeResolverName;
1059
+ /**
1060
+ * Internal service identifier.
1061
+ */
1062
+ service: 'takeshape';
1063
+ options?: TakeshapeResolverOptions;
1064
+ /**
1065
+ * An optional Shape name for the resolver.
1066
+ */
1067
+ shapeName?: string;
1068
+ args?: ParameterConfigForJson;
1069
+ results?: ParameterConfigForJson;
1070
+ argsMapping?: ArgsMapping;
1071
+ resultsMapping?: ResultsMapping;
1072
+ }
1073
+ export interface TakeshapeResolverOptions {
1074
+ [k: string]: any;
1075
+ }
1076
+ /**
1077
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1078
+ * via the `definition` "shapedbResolver".
1079
+ */
1080
+ export interface ShapedbResolver {
1081
+ if?: string;
1082
+ id?: string;
1083
+ name: ShapedbResolverName;
1084
+ /**
1085
+ * Internal service identifier.
1086
+ */
1087
+ service: 'shapedb';
1088
+ options?: ShapedbResolverOptions;
1089
+ argsMapping?: ArgsMapping;
1090
+ resultsMapping?: ResultsMapping;
1091
+ /**
1092
+ * A Shape name for the resolver to use.
1093
+ */
1094
+ shapeName: string;
1095
+ args?: ParameterConfigForJson;
1096
+ results?: ParameterConfigForJson;
1097
+ }
1098
+ export interface ShapedbResolverOptions {
1099
+ [k: string]: any;
1100
+ }
1101
+ /**
1102
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1103
+ * via the `definition` "shapedbResolverShapeNameNotRequired".
1104
+ */
1105
+ export interface ShapedbResolverShapeNameNotRequired {
1106
+ if?: string;
1107
+ id?: string;
1108
+ name: ShapedbResolverShapeNameNotRequiredName;
1109
+ /**
1110
+ * Internal service identifier.
1111
+ */
1112
+ service: 'shapedb';
1113
+ options?: ShapedbResolverShapeNameNotRequiredOptions;
1114
+ /**
1115
+ * An optional Shape name for the resolver.
1116
+ */
1117
+ shapeName?: string;
1118
+ args?: ParameterConfigForJson;
1119
+ results?: ParameterConfigForJson;
1120
+ argsMapping?: ArgsMapping;
1121
+ resultsMapping?: ResultsMapping;
1122
+ }
1123
+ export interface ShapedbResolverShapeNameNotRequiredOptions {
1124
+ [k: string]: any;
1125
+ }
1126
+ /**
1127
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1128
+ * via the `definition` "graphqlResolver".
1129
+ */
1130
+ export interface GraphqlResolver {
1131
+ if?: string;
1132
+ id?: string;
1133
+ name: GraphqlResolverName;
1134
+ /**
1135
+ * Configuration for a service to use with this resolver.
1136
+ */
1137
+ service: string;
1138
+ argsMapping?: ArgsMapping;
1139
+ resultsMapping?: ResultsMapping;
1140
+ options?: GraphqlResolverOptions;
1141
+ /**
1142
+ * A fieldname to use in queries.
1143
+ */
1144
+ fieldName: string;
1145
+ headers?: ParameterConfigForHeaders;
1146
+ searchParams?: ParameterConfigForSearchParams;
1147
+ args?: ParameterConfigForJson;
1148
+ results?: ParameterConfigForJson;
1149
+ }
1150
+ export interface GraphqlResolverOptions {
1151
+ selectionSet?: string;
1152
+ unboxParentSelectionSet?: boolean;
1153
+ ignoreErrors?: boolean;
1154
+ skipWhenMissingArgs?: boolean;
1155
+ ttl?: number;
1156
+ timeout?: number;
1157
+ allowStream?: boolean;
1158
+ retry?: number | {
1159
+ [k: string]: any;
1160
+ };
1161
+ [k: string]: any;
1162
+ }
1163
+ /**
1164
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1165
+ * via the `definition` "parameterConfigForHeaders".
1166
+ */
1167
+ export interface ParameterConfigForHeaders {
1168
+ ops: ParameterOpList;
1169
+ serialize?: ParameterSerializeConfigForHeaders;
1170
+ }
1171
+ /**
1172
+ * Top-level paths to use headers serialization options for.
1173
+ *
1174
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1175
+ * via the `definition` "parameterSerializeConfigForHeaders".
1176
+ */
1177
+ export interface ParameterSerializeConfigForHeaders {
1178
+ defaults?: ParameterSerializeStyleOptionsForHeaders | ParameterSerializeContentOptions;
1179
+ paths?: {
1180
+ /**
1181
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1182
+ * via the `patternProperty` "^[^\n\r]*$".
1183
+ */
1184
+ [k: string]: ParameterSerializeStyleOptionsForHeaders | ParameterSerializeContentOptions;
1185
+ };
1186
+ }
1187
+ /**
1188
+ * Options to be passed to the serialization routine.
1189
+ *
1190
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1191
+ * via the `definition` "parameterSerializeStyleOptionsForHeaders".
1192
+ */
1193
+ export interface ParameterSerializeStyleOptionsForHeaders {
1194
+ style: 'simple' | 'none';
1195
+ explode?: boolean;
1196
+ }
1197
+ /**
1198
+ * Options to be passed to the serialization routine.
1199
+ *
1200
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1201
+ * via the `definition` "parameterSerializeContentOptions".
1202
+ */
1203
+ export interface ParameterSerializeContentOptions {
1204
+ contentType: string;
1205
+ /**
1206
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1207
+ */
1208
+ allowReserved?: boolean;
1209
+ skipEncoding?: boolean;
1210
+ /**
1211
+ * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
1212
+ */
1213
+ options?: {
1214
+ [k: string]: any;
1215
+ };
1216
+ }
1217
+ /**
1218
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1219
+ * via the `definition` "parameterConfigForSearchParams".
1220
+ */
1221
+ export interface ParameterConfigForSearchParams {
1222
+ ops: ParameterOpList;
1223
+ serialize?: ParameterSerializeConfigForSearchParams;
1224
+ }
1225
+ /**
1226
+ * Top-level paths to use search params serialization options for.
1227
+ *
1228
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1229
+ * via the `definition` "parameterSerializeConfigForSearchParams".
1230
+ */
1231
+ export interface ParameterSerializeConfigForSearchParams {
1232
+ defaults?: ParameterSerializeStyleOptionsForSearchParams | ParameterSerializeContentOptions;
1233
+ paths?: {
1234
+ /**
1235
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1236
+ * via the `patternProperty` "^[^\n\r]*$".
1237
+ */
1238
+ [k: string]: ParameterSerializeStyleOptionsForSearchParams | ParameterSerializeContentOptions;
1239
+ };
1240
+ }
1241
+ /**
1242
+ * Options to be passed to the serialization routine.
1243
+ *
1244
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1245
+ * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
1246
+ */
1247
+ export interface ParameterSerializeStyleOptionsForSearchParams {
1248
+ style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
1249
+ explode?: boolean;
1250
+ allowEmptyValue?: boolean;
1251
+ /**
1252
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1253
+ */
1254
+ allowReserved?: boolean;
1255
+ skipEncoding?: boolean;
1256
+ }
1257
+ /**
1258
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1259
+ * via the `definition` "restResolver".
1260
+ */
1261
+ export interface RestResolver {
1262
+ if?: string;
1263
+ id?: string;
1264
+ name: RestResolverName;
1265
+ /**
1266
+ * Configuration for a service to use with this resolver.
1267
+ */
1268
+ service: string;
1269
+ argsMapping?: ArgsMapping;
1270
+ searchParamsMapping?: SearchParamsMapping;
1271
+ resultsMapping?: ResultsMapping;
1272
+ options?: RestResolverOptions;
1273
+ body?: ParameterConfigForBody;
1274
+ form?: ParameterConfigForSearchParams;
1275
+ headers?: ParameterConfigForHeaders;
1276
+ json?: ParameterConfigForJson;
1277
+ /**
1278
+ * Mapping and serialization configuration for the path, or a simple string.
1279
+ */
1280
+ path: ParameterConfigForPathParams | string;
1281
+ searchParams?: ParameterConfigForSearchParams;
1282
+ args?: ParameterConfigForJson;
1283
+ results?: ParameterConfigForJson;
1284
+ }
1285
+ export interface RestResolverOptions {
1286
+ trailingSlash?: boolean;
1287
+ allowStream?: boolean;
1288
+ ttl?: number;
1289
+ timeout?: number;
1290
+ retry?: number | {
1291
+ [k: string]: any;
1292
+ };
1293
+ [k: string]: any;
1294
+ }
1295
+ /**
1296
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1297
+ * via the `definition` "parameterConfigForBody".
1298
+ */
1299
+ export interface ParameterConfigForBody {
1300
+ ops: ParameterOpList;
1301
+ serialize?: ParameterSerializeConfigForBody;
1302
+ }
1303
+ /**
1304
+ * Top-level paths to use serialization options for.
1305
+ *
1306
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1307
+ * via the `definition` "parameterSerializeConfigForBody".
1308
+ */
1309
+ export interface ParameterSerializeConfigForBody {
1310
+ content?: ParameterSerializeContentOptions;
1311
+ }
1312
+ /**
1313
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1314
+ * via the `definition` "parameterConfigForPathParams".
1315
+ */
1316
+ export interface ParameterConfigForPathParams {
1317
+ ops: ParameterOpList;
1318
+ serialize: ParameterSerializeConfigForPathParams;
1319
+ }
1320
+ /**
1321
+ * Top-level paths to use path params serialization options for.
1322
+ *
1323
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1324
+ * via the `definition` "parameterSerializeConfigForPathParams".
1325
+ */
1326
+ export interface ParameterSerializeConfigForPathParams {
1327
+ /**
1328
+ * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
1329
+ */
1330
+ template: string;
1331
+ defaults?: ParameterSerializeStyleOptionsForPathParams | ParameterSerializeContentOptions;
1332
+ paths?: {
1333
+ /**
1334
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1335
+ * via the `patternProperty` "^[^\n\r]*$".
1336
+ */
1337
+ [k: string]: ParameterSerializeStyleOptionsForPathParams | ParameterSerializeContentOptions;
1338
+ };
1339
+ }
1340
+ /**
1341
+ * Options to be passed to the serialization routine.
1342
+ *
1343
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1344
+ * via the `definition` "parameterSerializeStyleOptionsForPathParams".
1345
+ */
1346
+ export interface ParameterSerializeStyleOptionsForPathParams {
1347
+ style: 'simple' | 'label' | 'matrix' | 'none';
1348
+ explode?: boolean;
1349
+ allowEmptyValue?: boolean;
1350
+ /**
1351
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
1352
+ */
1353
+ allowReserved?: boolean;
1354
+ skipEncoding?: boolean;
1355
+ }
1356
+ /**
1357
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1358
+ * via the `definition` "awsLambdaResolver".
1359
+ */
1360
+ export interface AwsLambdaResolver {
1361
+ if?: string;
1362
+ id?: string;
1363
+ name: AwsLambdaResolverName;
1364
+ /**
1365
+ * Configuration for a service to use with this resolver.
1366
+ */
1367
+ service: string;
1368
+ options?: AwsLambdaResolverOptions;
1369
+ payload?: ParameterConfigForJson;
1370
+ /**
1371
+ * Mapping configuration for the FunctionName.
1372
+ */
1373
+ functionName: string | ParameterConfigForAwsLambda;
1374
+ clientContext?: ParameterConfigForJson;
1375
+ args?: ParameterConfigForJson;
1376
+ results?: ParameterConfigForJson;
1377
+ argsMapping?: ArgsMapping;
1378
+ searchParamsMapping?: SearchParamsMapping;
1379
+ resultsMapping?: ResultsMapping;
1380
+ }
1381
+ export interface AwsLambdaResolverOptions {
1382
+ [k: string]: any;
1383
+ }
1384
+ /**
1385
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1386
+ * via the `definition` "parameterConfigForAwsLambda".
1387
+ */
1388
+ export interface ParameterConfigForAwsLambda {
1389
+ ops: ParameterOpList;
1390
+ serialize: ParameterSerializeConfigForPathParams;
1391
+ }
1392
+ /**
1393
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1394
+ * via the `definition` "salsifyResolver".
1395
+ */
1396
+ export interface SalsifyResolver {
1397
+ if?: string;
1398
+ id?: string;
1399
+ name: SalsifyResolverName;
1400
+ /**
1401
+ * Configuration for a service to use with this resolver.
1402
+ */
1403
+ service: string;
1404
+ options?: SalsifyResolverOptions;
1405
+ args?: ParameterConfigForJson;
1406
+ results?: ParameterConfigForJson;
1407
+ argsMapping?: ArgsMapping;
1408
+ resultsMapping?: ResultsMapping;
1409
+ }
1410
+ export interface SalsifyResolverOptions {
1411
+ [k: string]: any;
1412
+ }
1413
+ /**
1414
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1415
+ * via the `definition` "syndigoResolver".
1416
+ */
1417
+ export interface SyndigoResolver {
1418
+ if?: string;
1419
+ id?: string;
1420
+ name: SyndigoResolverName;
1421
+ /**
1422
+ * Configuration for a service to use with this resolver.
1423
+ */
1424
+ service: string;
1425
+ options?: SyndigoResolverOptions;
1426
+ args?: ParameterConfigForJson;
1427
+ results?: ParameterConfigForJson;
1428
+ argsMapping?: ArgsMapping;
1429
+ resultsMapping?: ResultsMapping;
1430
+ }
1431
+ export interface SyndigoResolverOptions {
1432
+ [k: string]: any;
1433
+ }
1434
+ /**
1435
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1436
+ * via the `definition` "functionResolver".
1437
+ */
1438
+ export interface FunctionResolver {
1439
+ if?: string;
1440
+ id?: string;
1441
+ name: FunctionResolverName;
1442
+ options?: FunctionResolverOptions;
1443
+ args?: ParameterConfigForJson;
1444
+ results?: ParameterConfigForJson;
1445
+ argsMapping?: ArgsMapping;
1446
+ resultsMapping?: ResultsMapping;
1447
+ javascript?: FunctionResolverJavascript;
1448
+ }
1449
+ export interface FunctionResolverOptions {
1450
+ [k: string]: any;
1451
+ }
1452
+ /**
1453
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1454
+ * via the `definition` "aiGenerateTextResolver".
1455
+ */
1456
+ export interface AIGenerateTextResolver {
1457
+ if?: string;
1458
+ id?: string;
1459
+ name: AIResolverName;
1460
+ /**
1461
+ * Configuration for a service to use with this resolver.
1462
+ */
1463
+ service: string;
1464
+ options?: AIGenerateTextResolverOptions;
1465
+ systemPrompt: string;
1466
+ inputTemplate?: string;
1467
+ model: string;
1468
+ tools?: AgentToolConfig[];
1469
+ guardrails?: AIGuardrail[];
1470
+ context?: ParameterConfigForJson;
1471
+ results?: ParameterConfigForJson;
1472
+ }
1473
+ /**
1474
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1475
+ * via the `definition` "aiGenerateTextResolverOptions".
1476
+ */
1477
+ export interface AIGenerateTextResolverOptions {
1478
+ history?: History;
1479
+ maxTokens?: MaximumTokens;
1480
+ temperature?: Temperature;
1481
+ topP?: TopP;
1482
+ topK?: TopK;
1483
+ presencePenalty?: PresencePenaltySetting;
1484
+ frequencyPenalty?: FrequencyPenaltySetting;
1485
+ stopSequences?: StopSequences;
1486
+ seed?: Seed;
1487
+ /**
1488
+ * Maximum number of retries. Set to 0 to disable retries. Defaults to 2
1489
+ */
1490
+ maxRetries?: number;
1491
+ /**
1492
+ * The tool choice strategy. Default: 'auto'
1493
+ */
1494
+ toolChoice?: (('auto' | 'none' | 'required') | string) & string;
1495
+ /**
1496
+ * Maximal number of automatic roundtrips for tool calls.
1497
+ */
1498
+ maxToolRoundtrips?: number;
1499
+ promptCaching?: PromptCaching;
1500
+ [k: string]: any;
1501
+ }
1502
+ /**
1503
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1504
+ * via the `definition` "agentToolConfig".
1505
+ */
1506
+ export interface AgentToolConfig {
1507
+ tool: string;
1508
+ alias?: string;
1509
+ description?: string;
1510
+ argBindings?: AgentToolConfigArg[];
1511
+ }
1512
+ /**
1513
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1514
+ * via the `definition` "agentToolConfigArgAgent".
1515
+ */
1516
+ export interface AgentControlled {
1517
+ type: 'agent';
1518
+ argName: ToolArgumentName;
1519
+ }
1520
+ /**
1521
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1522
+ * via the `definition` "agentToolConfigArgVariable".
1523
+ */
1524
+ export interface VariableValue {
1525
+ type: 'variable';
1526
+ argName: ToolArgumentName1;
1527
+ variableName: StateVariableName;
1528
+ }
1529
+ /**
1530
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1531
+ * via the `definition` "aiSimilarityGuardrail".
1532
+ */
1533
+ export interface AISimilarityGuardrail {
1534
+ name: 'similarity';
1535
+ shape: string;
1536
+ defaultResponse: string;
1537
+ threshold?: number;
1538
+ }
1539
+ /**
1540
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1541
+ * via the `definition` "aiGeneratePropertyResolver".
1542
+ */
1543
+ export interface AIGeneratePropertyResolver {
1544
+ id?: string;
1545
+ name: AIResolverName1;
1546
+ /**
1547
+ * Configuration for a service to use with this resolver.
1548
+ */
1549
+ service: string;
1550
+ model: string;
1551
+ systemPrompt?: string;
1552
+ }
1553
+ /**
1554
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1555
+ * via the `definition` "aiEmbeddingResolver".
1556
+ */
1557
+ export interface AIEmbeddingResolver {
1558
+ if?: string;
1559
+ id?: string;
1560
+ name: AIResolverName2;
1561
+ /**
1562
+ * Configuration for a service to use with this resolver.
1563
+ */
1564
+ service: string;
1565
+ options?: AIEmbeddingResolverOptions;
1566
+ model: string;
1567
+ args?: ParameterConfigForJson;
1568
+ results?: ParameterConfigForJson;
1569
+ }
1570
+ /**
1571
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1572
+ * via the `definition` "aiEmbeddingResolverOptions".
1573
+ */
1574
+ export interface AIEmbeddingResolverOptions {
1575
+ useDependencies?: boolean;
1576
+ [k: string]: any;
1577
+ }
1578
+ /**
1579
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1580
+ * via the `definition` "aiEmbeddingSearchResolver".
1581
+ */
1582
+ export interface AIEmbeddingSearchResolver {
1583
+ if?: string;
1584
+ id?: string;
1585
+ name: AIResolverName3;
1586
+ /**
1587
+ * A vector property ref to use for the query.
1588
+ */
1589
+ vectorProperty: string;
1590
+ args?: ParameterConfigForJson;
1591
+ results?: ParameterConfigForJson;
1592
+ }
1593
+ /**
1594
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1595
+ * via the `definition` "aiParseFileResolver".
1596
+ */
1597
+ export interface AIParseFileResolver {
1598
+ if?: string;
1599
+ id?: string;
1600
+ name: AIResolverName4;
1601
+ /**
1602
+ * Configuration for a service to use with this resolver.
1603
+ */
1604
+ service: string;
1605
+ options?: AIEmbeddingResolverOptions;
1606
+ args?: ParameterConfigForJson;
1607
+ results?: ParameterConfigForJson;
1608
+ }
1609
+ /**
1610
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1611
+ * via the `definition` "utilChunkResolver".
1612
+ */
1613
+ export interface ChunkResolver {
1614
+ if?: string;
1615
+ id?: string;
1616
+ name: UtilResolverName1;
1617
+ options: UtilChunkResolverOptions;
1618
+ args?: ParameterConfigForJson;
1619
+ results?: ParameterConfigForJson;
1620
+ }
1621
+ /**
1622
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1623
+ * via the `definition` "utilChunkResolverOptionsCharacterCount".
1624
+ */
1625
+ export interface UtilChunkResolverOptionsCharacterCount {
1626
+ type: 'characterCount';
1627
+ characterCount: number;
1628
+ }
1629
+ /**
1630
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1631
+ * via the `definition` "utilChunkResolverOptionsSeparators".
1632
+ */
1633
+ export interface UtilChunkResolverOptionsSeparators {
1634
+ type: 'separators';
1635
+ separators: string[];
1636
+ }
1637
+ /**
1638
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1639
+ * via the `definition` "utilChunkResolverOptionsMarkdown".
1640
+ */
1641
+ export interface UtilChunkResolverOptionsMarkdown {
1642
+ type: 'markdown';
1643
+ /**
1644
+ * New chunks will be created at headers for this level or lower. Default 2.
1645
+ */
1646
+ headerLevel?: number;
1647
+ /**
1648
+ * A new chunk will be started when this number of characters is reached, regardless of markup.
1649
+ */
1650
+ maxCharacters?: number;
1651
+ }
1652
+ /**
1653
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1654
+ * via the `definition` "utilChunkResolverOptionsSemantic".
1655
+ */
1656
+ export interface UtilChunkResolverOptionsSemantic {
1657
+ type: 'semantic';
1658
+ serviceId: string;
1659
+ modelId: string;
1660
+ /**
1661
+ * Similarity below which two embeddings are considered different.
1662
+ */
1663
+ similarityThreshold?: number;
1664
+ /**
1665
+ * Advanced. How many sentences to advance when grouping sentences to create embeddings. Default 1.
1666
+ */
1667
+ stride?: number;
1668
+ /**
1669
+ * Advanced. How many sentences are grouped together to create embeddings. Default 3.
1670
+ */
1671
+ sentenceCount?: number;
1672
+ /**
1673
+ * The maximum number of characters in a chunk.
1674
+ */
1675
+ maxCharacters?: number;
1676
+ /**
1677
+ * The maximum number of tokens in a chunk.
1678
+ */
1679
+ maxTokens?: number;
1680
+ }
1681
+ /**
1682
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1683
+ * via the `definition` "aiRunAgentResolver".
1684
+ */
1685
+ export interface AISendAgentMessageResolver {
1686
+ id?: string;
1687
+ name: AIResolverName5;
1688
+ agentName: string;
1689
+ inputName: string;
1690
+ }
1691
+ /**
1692
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1693
+ * via the `definition` "aiInspectAgentResolver".
1694
+ */
1695
+ export interface AIInspectAgentResolver {
1696
+ id?: string;
1697
+ name: AIResolverName6;
1698
+ agentName: string;
1699
+ }
1700
+ /**
1701
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1702
+ * via the `definition` "aiCreateAgentSessionResolver".
1703
+ */
1704
+ export interface AICreateAgentSessionResolver {
1705
+ id?: string;
1706
+ name: AIResolverName7;
1707
+ agentName: string;
1708
+ }
1709
+ /**
1710
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1711
+ * via the `definition` "aiGetAgentMessageResolver".
1712
+ */
1713
+ export interface AIGetAgentMessageResolver {
1714
+ id?: string;
1715
+ name: AIResolverName8;
1716
+ agentName: string;
1717
+ }
1718
+ /**
1719
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1720
+ * via the `definition` "aiAbortAgentMessageResolver".
1721
+ */
1722
+ export interface AIAbortAgentMessageResolver {
1723
+ id?: string;
1724
+ name: AIResolverName9;
1725
+ agentName: string;
1726
+ }
1727
+ /**
1728
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1729
+ * via the `definition` "aiSendAgentFeedbackResolver".
1730
+ */
1731
+ export interface AISendAgentFeedbackResolver {
1732
+ id?: string;
1733
+ name: AIResolverName10;
1734
+ agentName: string;
1735
+ }
1736
+ /**
1737
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1738
+ * via the `definition` "composeResolver".
1739
+ */
1740
+ export interface ComposeResolver {
1741
+ compose: BasicResolver[];
1742
+ resultsMapping?: DirectiveMappingMap | DirectiveConfig;
1743
+ results?: ParameterConfigForJson;
1744
+ }
1745
+ /**
1746
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1747
+ * via the `definition` "indexed".
1748
+ */
1749
+ export interface Indexed {
1750
+ nested?: boolean;
1751
+ }
1752
+ /**
1753
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1754
+ * via the `definition` "graphql".
1755
+ */
1756
+ export interface GraphQLConfig {
1757
+ json?: boolean;
1758
+ }
1759
+ /**
1760
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1761
+ * via the `definition` "shapeMap".
1762
+ */
1763
+ export interface ShapeMap {
1764
+ [k: string]: ShapeJSON;
1765
+ }
1766
+ /**
1767
+ * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
1768
+ *
1769
+ * This interface was referenced by `ShapeMap`'s JSON-Schema definition
1770
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
1771
+ *
1772
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1773
+ * via the `definition` "shape".
1774
+ */
1775
+ export interface ShapeJSON {
1776
+ /**
1777
+ * 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
1778
+ */
1779
+ name: string;
1780
+ /**
1781
+ * 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.
1782
+ */
1783
+ id: string;
1784
+ /**
1785
+ * The human-readable name for a Shape for use in a UI.
1786
+ */
1787
+ title: string;
1788
+ description?: string;
1789
+ type?: 'interface' | 'input' | 'output';
1790
+ interfaces?: string[];
1791
+ /**
1792
+ * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
1793
+ */
1794
+ model?: {
1795
+ type: ModelType;
1796
+ };
1797
+ workflow?: string;
1798
+ loaders?: ShapeLoaders;
1799
+ joins?: ShapeJoins;
1800
+ cache?: ShapeCacheConfig;
1801
+ context?: ShapeContext;
1802
+ schema: ShapeSchema;
1803
+ }
1804
+ /**
1805
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1806
+ * via the `definition` "shapeLoaders".
1807
+ */
1808
+ export interface ShapeLoaders {
1809
+ list: StoredListQueryLoaderConfig | StoredListQueryLoaderConfig[];
1810
+ get?: GetQueryLoaderConfig;
1811
+ }
1812
+ /**
1813
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1814
+ * via the `definition` "storedListQueryLoaderConfig".
1815
+ */
1816
+ export interface StoredListQueryLoaderConfig {
1817
+ query: string;
1818
+ args?: {
1819
+ [k: string]: any;
1820
+ } | {
1821
+ [k: string]: any;
1822
+ }[];
1823
+ pagination?: PaginationConfig;
1824
+ }
1825
+ /**
1826
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1827
+ * via the `definition` "getQueryLoaderConfig".
1828
+ */
1829
+ export interface GetQueryLoaderConfig {
1830
+ query: string;
1831
+ args?: {
1832
+ [k: string]: any;
1833
+ };
1834
+ idArg?: string;
1835
+ }
1836
+ /**
1837
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1838
+ * via the `definition` "shapeJoins".
1839
+ */
1840
+ export interface ShapeJoins {
1841
+ [k: string]: ShapeJoin;
1842
+ }
1843
+ /**
1844
+ * This interface was referenced by `ShapeJoins`'s JSON-Schema definition
1845
+ * via the `patternProperty` "[:0-9A-Za-z_-]+".
1846
+ *
1847
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1848
+ * via the `definition` "shapeJoin".
1849
+ */
1850
+ export interface ShapeJoin {
1851
+ resolver: DelegateResolver | ShapedbResolver;
1852
+ dependencies?: string;
1853
+ }
1854
+ /**
1855
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1856
+ * via the `definition` "shapeCacheConfig".
1857
+ */
1858
+ export interface ShapeCacheConfig {
1859
+ enabled: boolean;
1860
+ idField?: string;
1861
+ searchSummaryField?: string;
1862
+ fragment?: CachedFragmentConfig;
1863
+ triggers?: CacheTriggerConfig[];
1864
+ /**
1865
+ * Number of seconds this Shape should be cached. Default 0.
1866
+ */
1867
+ maxAge?: number;
1868
+ /**
1869
+ * Requests after maxAge will send a request to origin to revalidate while serving stale content for this duration in the meantime.
1870
+ */
1871
+ staleWhileRevalidate?: number;
1872
+ }
1873
+ /**
1874
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1875
+ * via the `definition` "cachedFragmentConfig".
1876
+ */
1877
+ export interface CachedFragmentConfig {
1878
+ ignoreFields?: string[];
1879
+ maxDepth?: number;
1880
+ selectionSet?: string;
1881
+ includeDeprecated?: boolean;
1882
+ }
1883
+ /**
1884
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1885
+ * via the `definition` "cacheScheduleTriggerConfig".
1886
+ */
1887
+ export interface CacheScheduleTriggerConfig {
1888
+ type: 'schedule';
1889
+ loader: 'get' | 'list';
1890
+ interval: number;
1891
+ }
1892
+ /**
1893
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1894
+ * via the `definition` "cacheWebhookTriggerConfig".
1895
+ */
1896
+ export interface CacheWebhookTriggerConfig {
1897
+ type: 'webhook';
1898
+ loader: 'get' | 'list';
1899
+ service: string;
1900
+ events: string[];
1901
+ }
1902
+ /**
1903
+ * Context configuration for storing variables that can be accessed by descendant resolvers
1904
+ *
1905
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1906
+ * via the `definition` "shapeContext".
1907
+ */
1908
+ export interface ShapeContext {
1909
+ /**
1910
+ * Variables to store in context when resolving fields on this shape. Keys are variable names, values are paths to property values.
1911
+ */
1912
+ variables?: {
1913
+ [k: string]: string;
1914
+ };
1915
+ }
1916
+ /**
1917
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1918
+ * via the `definition` "shapeSchemaAllOf".
1919
+ */
1920
+ export interface ShapeSchemaAllOf {
1921
+ allOf: ObjectOrRefArray;
1922
+ }
1923
+ /**
1924
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1925
+ * via the `definition` "shapeSchemaExtends".
1926
+ */
1927
+ export interface ShapeSchemaExtends {
1928
+ extends: ObjectOrRefArray;
1929
+ }
1930
+ /**
1931
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1932
+ * via the `definition` "shapeSchemaOneOf".
1933
+ */
1934
+ export interface ShapeSchemaOneOf {
1935
+ title?: string;
1936
+ description?: string;
1937
+ discriminator?: {
1938
+ propertyName: string;
1939
+ [k: string]: any;
1940
+ };
1941
+ oneOf: ObjectOrRefArray;
1942
+ }
1943
+ /**
1944
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1945
+ * via the `definition` "shapeSchemaEnum".
1946
+ */
1947
+ export interface ShapeSchemaEnum {
1948
+ enum: any[];
1949
+ }
1950
+ /**
1951
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1952
+ * via the `definition` "shapeSchemaAny".
1953
+ */
1954
+ export interface ShapeSchemaAny {
1955
+ }
1956
+ /**
1957
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1958
+ * via the `definition` "formMap".
1959
+ */
1960
+ export interface FormMap {
1961
+ [k: string]: FormsConfig;
1962
+ }
1963
+ /**
1964
+ * This interface was referenced by `FormMap`'s JSON-Schema definition
1965
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1966
+ *
1967
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1968
+ * via the `definition` "formsConfig".
1969
+ */
1970
+ export interface FormsConfig {
1971
+ default: FormConfig;
1972
+ [k: string]: FormConfig;
1973
+ }
1974
+ /**
1975
+ * This interface was referenced by `FormsConfig`'s JSON-Schema definition
1976
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1977
+ *
1978
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1979
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1980
+ *
1981
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1982
+ * via the `definition` "formConfig".
1983
+ */
1984
+ export interface FormConfig {
1985
+ [k: string]: any;
1986
+ }
1987
+ /**
1988
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1989
+ * via the `definition` "workflowMap".
1990
+ */
1991
+ export interface WorkflowMap {
1992
+ [k: string]: Workflow;
1993
+ }
1994
+ /**
1995
+ * This interface was referenced by `WorkflowMap`'s JSON-Schema definition
1996
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1997
+ *
1998
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1999
+ * via the `definition` "workflow".
2000
+ */
2001
+ export interface Workflow {
2002
+ /**
2003
+ * machine-readable id
2004
+ */
2005
+ name: string;
2006
+ title: WorkflowName;
2007
+ steps: Steps;
2008
+ [k: string]: any;
2009
+ }
2010
+ /**
2011
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2012
+ * via the `definition` "workflowStep".
2013
+ */
2014
+ export interface WorkflowStep {
2015
+ name: Name;
2016
+ title: Title;
2017
+ description?: Description;
2018
+ color: Color;
2019
+ live: Live;
2020
+ key: Key;
2021
+ }
2022
+ /**
2023
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2024
+ * via the `definition` "storedServiceMap".
2025
+ */
2026
+ export interface ServiceMapJSON {
2027
+ [k: string]: ServiceConfigJSON;
2028
+ }
2029
+ /**
2030
+ * This interface was referenced by `ServiceMapJSON`'s JSON-Schema definition
2031
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
2032
+ *
2033
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2034
+ * via the `definition` "storedServiceConfig".
2035
+ */
2036
+ export interface ServiceConfigJSON {
2037
+ /**
2038
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
2039
+ */
2040
+ id: string;
2041
+ /**
2042
+ * Human-readable name for this service.
2043
+ */
2044
+ title: string;
2045
+ /**
2046
+ * The service provider id.
2047
+ */
2048
+ provider: string;
2049
+ /**
2050
+ * A namespace to use for the imported types tied to this service.
2051
+ */
2052
+ namespace?: string;
2053
+ serviceType: ServiceType;
2054
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
2055
+ authentication?: string;
2056
+ healthCheck?: ServiceHealthCheck;
2057
+ webhookId?: string;
2058
+ /**
2059
+ * Configuration options passed to and handled by the provider.
2060
+ */
2061
+ options?: {
2062
+ [k: string]: any;
2063
+ };
2064
+ }
2065
+ /**
2066
+ * Configuration for ping health checks.
2067
+ *
2068
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2069
+ * via the `definition` "serviceHealthCheck".
2070
+ */
2071
+ export interface ServiceHealthCheck {
2072
+ checkName: CheckName;
2073
+ endpoint?: Endpoint;
2074
+ requestMethod?: RequestMethod;
2075
+ requestHeaders?: RequestHeaders;
2076
+ requestSearchParams?: RequestSearchParams;
2077
+ requestBody?: RequestBody;
2078
+ requestBodyFormat?: RequestBodyFormat;
2079
+ requestTimeout?: RequestTimeout;
2080
+ healthyResponseStatusCode?: HealthyResponseStatusCode;
2081
+ triggers?: ServiceHealthCheckTrigger[];
2082
+ }
2083
+ /**
2084
+ * Any custom headers to set with the health check request.
2085
+ */
2086
+ export interface RequestHeaders {
2087
+ [k: string]: any;
2088
+ }
2089
+ /**
2090
+ * Any custom search params to set with the health check request.
2091
+ */
2092
+ export interface RequestSearchParams {
2093
+ [k: string]: any;
2094
+ }
2095
+ /**
2096
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2097
+ * via the `definition` "agentMap".
2098
+ */
2099
+ export interface AgentMap {
2100
+ [k: string]: AgentJSON;
2101
+ }
2102
+ /**
2103
+ * An Agent is a configuration for an AI service such as a chat bot or a search engine.
2104
+ *
2105
+ * This interface was referenced by `AgentMap`'s JSON-Schema definition
2106
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
2107
+ *
2108
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2109
+ * via the `definition` "agent".
2110
+ */
2111
+ export interface AgentJSON {
2112
+ title?: string;
2113
+ description?: string;
2114
+ disabled?: boolean;
2115
+ systemPrompt?: string;
2116
+ api: AgentAPI;
2117
+ memory?: AgentMemory;
2118
+ start: AgentStart;
2119
+ states: AgentStates;
2120
+ guards?: AgentGuard[];
2121
+ historyStrategies?: HistoryStrategyMap;
2122
+ protection?: AgentProtection;
2123
+ }
2124
+ /**
2125
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2126
+ * via the `definition` "agentApi".
2127
+ */
2128
+ export interface AgentAPI {
2129
+ inputs: AgentAPIInput[];
2130
+ }
2131
+ /**
2132
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2133
+ * via the `definition` "agentApiMutationInput".
2134
+ */
2135
+ export interface AgentAPIMutationInput {
2136
+ type: 'mutation';
2137
+ name: string;
2138
+ args: string;
2139
+ interactionTimeout?: InteractionTimeoutMilliseconds;
2140
+ }
2141
+ /**
2142
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2143
+ * via the `definition` "agentMemory".
2144
+ */
2145
+ export interface AgentMemory {
2146
+ sessionMemory: AgentSessionMemory;
2147
+ }
2148
+ /**
2149
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2150
+ * via the `definition` "agentSessionMemory".
2151
+ */
2152
+ export interface AgentSessionMemory {
2153
+ shape?: string;
2154
+ }
2155
+ /**
2156
+ * Configuration for the start of an agent's execution
2157
+ *
2158
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2159
+ * via the `definition` "agentStart".
2160
+ */
2161
+ export interface AgentStart {
2162
+ transitions: AgentTransitionSuspend[];
2163
+ }
2164
+ /**
2165
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2166
+ * via the `definition` "agentTransitionSuspend".
2167
+ */
2168
+ export interface AgentTransitionSuspend {
2169
+ type: 'suspend';
2170
+ destination: string;
2171
+ input: string;
2172
+ condition?: string;
2173
+ limit?: number;
2174
+ sessionMemory?: AgentStateSessionMemory;
2175
+ historyStrategy?: string;
2176
+ }
2177
+ /**
2178
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2179
+ * via the `definition` "agentStateSessionMemoryAssignment".
2180
+ */
2181
+ export interface AgentStateSessionMemoryAssignment {
2182
+ memoryPath?: string;
2183
+ expression: string;
2184
+ }
2185
+ /**
2186
+ * States that are traversed during the execution of an agent.
2187
+ *
2188
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2189
+ * via the `definition` "agentStateMap".
2190
+ */
2191
+ export interface AgentStates {
2192
+ [k: string]: AgentState;
2193
+ }
2194
+ /**
2195
+ * One step of an agent's execution.
2196
+ *
2197
+ * This interface was referenced by `AgentStates`'s JSON-Schema definition
2198
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
2199
+ *
2200
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2201
+ * via the `definition` "agentState".
2202
+ */
2203
+ export interface AgentState {
2204
+ name: string;
2205
+ variables?: Variables;
2206
+ execution: AgentExecution;
2207
+ transitions?: AgentTransition[];
2208
+ }
2209
+ /**
2210
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2211
+ * via the `definition` "agentVariable".
2212
+ */
2213
+ export interface AgentVariable {
2214
+ name: string;
2215
+ /**
2216
+ * These are evaluated in order until a value is found.
2217
+ */
2218
+ steps: AgentVariableStep[];
2219
+ }
2220
+ /**
2221
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2222
+ * via the `definition` "agentVariableStep".
2223
+ */
2224
+ export interface AgentVariableStep {
2225
+ condition?: string;
2226
+ expression: string;
2227
+ }
2228
+ /**
2229
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2230
+ * via the `definition` "agentExecutionGraphql".
2231
+ */
2232
+ export interface AgentExecutionGraphQL {
2233
+ type: 'graphql';
2234
+ query: string;
2235
+ path?: string;
2236
+ }
2237
+ /**
2238
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2239
+ * via the `definition` "agentExecutionGenerate".
2240
+ */
2241
+ export interface AgentExecutionGenerate {
2242
+ type: 'generate';
2243
+ service: string;
2244
+ model: string;
2245
+ systemPrompt?: string;
2246
+ input: AgentAIStateInput;
2247
+ attachments?: AgentAIStateAttachments;
2248
+ outputShape?: string;
2249
+ tools?: AgentToolConfig[];
2250
+ memoryTools?: MemoryToolJSON[];
2251
+ clientTools?: ClientToolJSON[];
2252
+ options?: AgentGenerateOptions;
2253
+ }
2254
+ /**
2255
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2256
+ * via the `definition` "agentAiStateInputArg".
2257
+ */
2258
+ export interface AgentAIStateInputArgument {
2259
+ type: 'arg';
2260
+ }
2261
+ /**
2262
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2263
+ * via the `definition` "agentAiStateInputTemplate".
2264
+ */
2265
+ export interface AgentAIStateInputTemplate {
2266
+ type: 'template';
2267
+ inputTemplate: string;
2268
+ }
2269
+ /**
2270
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2271
+ * via the `definition` "agentAiStateAttachmentsNone".
2272
+ */
2273
+ export interface AgentAIStateAttachmentsNone {
2274
+ type: 'none';
2275
+ }
2276
+ /**
2277
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2278
+ * via the `definition` "agentAiStateAttachmentsArg".
2279
+ */
2280
+ export interface AgentAIStateAttachmentsArg {
2281
+ type: 'arg';
2282
+ }
2283
+ /**
2284
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2285
+ * via the `definition` "agentAiStateAttachmentsExpression".
2286
+ */
2287
+ export interface AgentAIStateAttachmentsExpression {
2288
+ type: 'expression';
2289
+ expression: string;
2290
+ }
2291
+ /**
2292
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2293
+ * via the `definition` "memoryTool".
2294
+ */
2295
+ export interface MemoryToolJSON {
2296
+ name: string;
2297
+ description?: string;
2298
+ args?: string;
2299
+ operation: 'set' | 'merge' | 'add' | 'clear' | 'get' | 'search' | 'remove' | 'update' | 'concat';
2300
+ path?: string;
2301
+ }
2302
+ /**
2303
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2304
+ * via the `definition` "clientTool".
2305
+ */
2306
+ export interface ClientToolJSON {
2307
+ name: string;
2308
+ description?: string;
2309
+ parameters?: string;
2310
+ /**
2311
+ * noop = fire-and-forget yield = waits for client response
2312
+ */
2313
+ type: 'noop' | 'yield';
2314
+ }
2315
+ /**
2316
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2317
+ * via the `definition` "agentGenerateOptions".
2318
+ */
2319
+ export interface AgentGenerateOptions {
2320
+ history?: History1;
2321
+ maxTokens?: MaximumTokens1;
2322
+ temperature?: Temperature1;
2323
+ topP?: TopP1;
2324
+ topK?: TopK1;
2325
+ presencePenalty?: PresencePenaltySetting1;
2326
+ frequencyPenalty?: FrequencyPenaltySetting1;
2327
+ stopSequences?: StopSequences1;
2328
+ seed?: Seed1;
2329
+ /**
2330
+ * Maximum number of retries. Set to 0 to disable retries. Defaults to 2
2331
+ */
2332
+ maxRetries?: number;
2333
+ /**
2334
+ * The tool choice strategy. Default: 'auto'
2335
+ */
2336
+ toolChoice?: (('auto' | 'none' | 'required') | string) & string;
2337
+ maxToolRoundtrips?: MaxToolRoundtrips;
2338
+ promptCaching?: PromptCaching;
2339
+ structuredOutputs?: StructuredOutputs;
2340
+ enableOpenAIFormat?: EnableOpenAISchemaFormat;
2341
+ removePropertyKeyPatterns?: RemovePropertyKeyPatterns;
2342
+ stripMarkdown?: StripMarkdown;
2343
+ }
2344
+ /**
2345
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2346
+ * via the `definition` "agentExecutionChat".
2347
+ */
2348
+ export interface AgentExecutionChat {
2349
+ type: 'chat';
2350
+ service: string;
2351
+ model: string;
2352
+ systemPrompt?: string;
2353
+ input: AgentAIStateInput;
2354
+ attachments?: AgentAIStateAttachments;
2355
+ artifact?: string;
2356
+ tools?: AgentToolConfig[];
2357
+ memoryTools?: MemoryToolJSON[];
2358
+ clientTools?: ClientToolJSON[];
2359
+ options?: AgentGenerateOptions;
2360
+ }
2361
+ /**
2362
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2363
+ * via the `definition` "agentTransitionImmediate".
2364
+ */
2365
+ export interface AgentTransitionImmediate {
2366
+ type: 'immediate';
2367
+ destination: string;
2368
+ condition?: string;
2369
+ limit?: number;
2370
+ sessionMemory?: AgentStateSessionMemory1;
2371
+ historyStrategy?: string;
2372
+ }
2373
+ /**
2374
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2375
+ * via the `definition` "agentGuard".
2376
+ */
2377
+ export interface AgentGuard {
2378
+ guardId: GuardID;
2379
+ }
2380
+ /**
2381
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2382
+ * via the `definition` "historyStrategyMap".
2383
+ */
2384
+ export interface HistoryStrategyMap {
2385
+ [k: string]: HistoryStrategy;
2386
+ }
2387
+ /**
2388
+ * This interface was referenced by `HistoryStrategyMap`'s JSON-Schema definition
2389
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
2390
+ *
2391
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2392
+ * via the `definition` "historyStrategy".
2393
+ */
2394
+ export interface HistoryStrategy {
2395
+ name: string;
2396
+ variables?: Variables1;
2397
+ filter?: HistoryStrategyFilter;
2398
+ transform: HistoryStrategyTransform;
2399
+ }
2400
+ /**
2401
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2402
+ * via the `definition` "historyStrategyFilter".
2403
+ */
2404
+ export interface HistoryStrategyFilter {
2405
+ toolCalls?: 'retain' | 'clear';
2406
+ }
2407
+ /**
2408
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2409
+ * via the `definition` "historyStrategyTransformNone".
2410
+ */
2411
+ export interface HistoryStrategyTransformNone {
2412
+ type: 'none';
2413
+ }
2414
+ /**
2415
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2416
+ * via the `definition` "historyStrategyTransformReplace".
2417
+ */
2418
+ export interface HistoryStrategyTransformReplace {
2419
+ type: 'replace';
2420
+ template: string;
2421
+ }
2422
+ /**
2423
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2424
+ * via the `definition` "historyStrategyTransformSummarize".
2425
+ */
2426
+ export interface HistoryStrategyTransformSummarize {
2427
+ type: 'generate';
2428
+ service: string;
2429
+ model: string;
2430
+ systemPrompt: string;
2431
+ tools?: AgentToolConfig[];
2432
+ options?: AgentGenerateOptions;
2433
+ }
2434
+ /**
2435
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2436
+ * via the `definition` "agentProtection".
2437
+ */
2438
+ export interface AgentProtection {
2439
+ enabled: EnableAgentAbuseProtection;
2440
+ }
2441
+ /**
2442
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2443
+ * via the `definition` "guardMap".
2444
+ */
2445
+ export interface GuardMap {
2446
+ [k: string]: GuardJSON;
2447
+ }
2448
+ /**
2449
+ * A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.
2450
+ *
2451
+ * This interface was referenced by `GuardMap`'s JSON-Schema definition
2452
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
2453
+ *
2454
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2455
+ * via the `definition` "guard".
2456
+ */
2457
+ export interface GuardJSON {
2458
+ name: Name1;
2459
+ description?: Description1;
2460
+ enabled?: Enabled;
2461
+ guardrailIdentifier?: GuardrailIdentifier;
2462
+ guardrailVersion?: GuardrailVersion;
2463
+ blockedInputMessaging?: BlockedInputMessaging;
2464
+ blockedOutputsMessaging?: BlockedOutputsMessaging;
2465
+ topicPolicyConfig?: TopicPolicy;
2466
+ contentPolicyConfig?: ContentPolicy;
2467
+ wordPolicyConfig?: WordPolicy;
2468
+ sensitiveInformationPolicyConfig?: SensitiveInformationPolicy;
2469
+ contextualGroundingPolicyConfig?: ContextualGroundingPolicy;
2470
+ }
2471
+ /**
2472
+ * Topics to identify and block.
2473
+ */
2474
+ export interface TopicPolicy {
2475
+ topicsConfig: Topic;
2476
+ }
2477
+ /**
2478
+ * Types of content to filter and strength configuration.
2479
+ */
2480
+ export interface ContentPolicy {
2481
+ filtersConfig: Filter;
2482
+ }
2483
+ /**
2484
+ * Specific words to identify and block.
2485
+ */
2486
+ export interface WordPolicy {
2487
+ wordsConfig?: WordList;
2488
+ managedWordListsConfig?: ManagedWordList;
2489
+ }
2490
+ /**
2491
+ * Filter out and block or obscure sensitive information. Matching text will be handled per the policy.
2492
+ */
2493
+ export interface SensitiveInformationPolicy {
2494
+ piiEntitiesConfig?: PIIEntity;
2495
+ regexesConfig?: RegularExpression;
2496
+ }
2497
+ /**
2498
+ * Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.
2499
+ */
2500
+ export interface ContextualGroundingPolicy {
2501
+ filtersConfig: Filter1;
2502
+ }
2503
+ /**
2504
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2505
+ * via the `definition` "toolMap".
2506
+ */
2507
+ export interface ToolMap {
2508
+ [k: string]: ToolJSON;
2509
+ }
2510
+ /**
2511
+ * This interface was referenced by `ToolMap`'s JSON-Schema definition
2512
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
2513
+ *
2514
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2515
+ * via the `definition` "tool".
2516
+ */
2517
+ export interface ToolJSON {
2518
+ visibility?: 'public' | 'private';
2519
+ execution: ToolExecutionJSON;
2520
+ description?: string;
2521
+ }
2522
+ /**
2523
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2524
+ * via the `definition` "toolExecutionRemote".
2525
+ */
2526
+ export interface ToolExecutionRemoteJSON {
2527
+ type: 'remote';
2528
+ toolName: string;
2529
+ service: string;
2530
+ parameters?: ObjectSchema;
2531
+ }
2532
+ /**
2533
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2534
+ * via the `definition` "toolExecutionGraphQL".
2535
+ */
2536
+ export interface ToolExecutionGraphQLJSON {
2537
+ type: 'graphql';
2538
+ query: ToolQueryConfig;
2539
+ path?: string;
2540
+ optimizeResponse?: ToolExecutionGraphQLOptimizeResponseJSON;
2541
+ }
2542
+ /**
2543
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2544
+ * via the `definition` "toolQueryRefConfig".
2545
+ */
2546
+ export interface ToolQueryRefConfig {
2547
+ ref: string;
2548
+ selectionSet?: string;
2549
+ args?: string[];
2550
+ }
2551
+ /**
2552
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2553
+ * via the `definition` "toolExecutionGraphQLOptimizeResponse".
2554
+ */
2555
+ export interface ToolExecutionGraphQLOptimizeResponseJSON {
2556
+ compactPagination?: boolean;
2557
+ }
2558
+ /**
2559
+ * All possible options for the more specific ParameterSerializeStyleOptions types.
2560
+ *
2561
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2562
+ * via the `definition` "parameterSerializeStyleOptions".
2563
+ */
2564
+ export interface ParameterSerializeStyleOptions {
2565
+ style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
2566
+ explode?: boolean;
2567
+ allowEmptyValue?: boolean;
2568
+ /**
2569
+ * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
2570
+ */
2571
+ allowReserved?: boolean;
2572
+ skipEncoding?: boolean;
2573
+ }
2574
+ /**
2575
+ * All possible options for the more specific ParameterSerializeConfig types.
2576
+ *
2577
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2578
+ * via the `definition` "parameterSerializeConfig".
2579
+ */
2580
+ export interface ParameterSerializeConfig {
2581
+ content?: ParameterSerializeContentOptions;
2582
+ defaults?: ParameterSerializeOptions;
2583
+ paths?: {
2584
+ [k: string]: ParameterSerializeOptions;
2585
+ };
2586
+ }
2587
+ /**
2588
+ * All possible options for the more specific ParameterConfig types.
2589
+ *
2590
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2591
+ * via the `definition` "parameterConfig".
2592
+ */
2593
+ export interface ParameterConfig {
2594
+ ops: ParameterOpList;
2595
+ serialize?: ParameterSerializeConfig;
2596
+ }
2597
+ /**
2598
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2599
+ * via the `definition` "aiParseFileResolverOptions".
2600
+ */
2601
+ export interface AIParseFileResolverOptions {
2602
+ [k: string]: any;
2603
+ }
2604
+ /**
2605
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2606
+ * via the `definition` "listQueryLoaderConfig".
2607
+ */
2608
+ export interface ListQueryLoaderConfig {
2609
+ query: string;
2610
+ args?: {
2611
+ [k: string]: any;
2612
+ };
2613
+ pagination?: PaginationConfig;
2614
+ }
2615
+ /**
2616
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2617
+ * via the `definition` "formScalarConfig".
2618
+ */
2619
+ export interface FormScalarConfig {
2620
+ widget: string;
2621
+ }
2622
+ /**
2623
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2624
+ * via the `definition` "formObjectConfig".
2625
+ */
2626
+ export interface FormObjectConfig {
2627
+ widget?: string;
2628
+ order?: string[];
2629
+ properties?: {
2630
+ [k: string]: FormConfig;
2631
+ };
2632
+ }
2633
+ /**
2634
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2635
+ * via the `definition` "formArrayConfig".
2636
+ */
2637
+ export interface FormArrayConfig {
2638
+ widget: string;
2639
+ items: FormConfig;
2640
+ }
2641
+ /**
2642
+ * For use with a custom auth handler on a service provider.
2643
+ *
2644
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2645
+ * via the `definition` "customAuthentication".
2646
+ */
2647
+ export interface CustomAuthentication {
2648
+ type: 'custom';
2649
+ [k: string]: any;
2650
+ }
2651
+ /**
2652
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2653
+ * via the `definition` "searchParamsAuthentication".
2654
+ */
2655
+ export interface SearchParamsAuthentication {
2656
+ type: 'searchParams';
2657
+ params: {
2658
+ name: string;
2659
+ value: string;
2660
+ }[];
2661
+ }
2662
+ /**
2663
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2664
+ * via the `definition` "bearerAuthentication".
2665
+ */
2666
+ export interface BearerAuthentication {
2667
+ type: 'bearer';
2668
+ token: string;
2669
+ prefix?: string;
2670
+ header?: string;
2671
+ }
2672
+ /**
2673
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2674
+ * via the `definition` "oauth2BearerAuthentication".
2675
+ */
2676
+ export interface OAuth2BearerAuthentication {
2677
+ type: 'oauth2Bearer';
2678
+ token: string;
2679
+ prefix?: string;
2680
+ header?: string;
2681
+ scope?: string;
2682
+ expiresAt?: string;
2683
+ }
2684
+ /**
2685
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2686
+ * via the `definition` "basicAuthentication".
2687
+ */
2688
+ export interface BasicAuthentication {
2689
+ type: 'basic';
2690
+ username: string;
2691
+ password: string;
2692
+ useIso8859?: boolean;
2693
+ }
2694
+ /**
2695
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2696
+ * via the `definition` "oauth2Authentication".
2697
+ */
2698
+ export interface OAuth2Authentication {
2699
+ type: 'oauth2';
2700
+ grantType: 'authorizationCode' | 'clientCredentials';
2701
+ authorizationUrl?: string;
2702
+ accessTokenUrl?: string;
2703
+ clientId: string;
2704
+ clientSecret?: string;
2705
+ scope?: string;
2706
+ usePkce?: boolean;
2707
+ redirectUrl?: string;
2708
+ headerPrefix?: string;
2709
+ audience?: string;
2710
+ resource?: string;
2711
+ }
2712
+ /**
2713
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2714
+ * via the `definition` "awsAuthentication".
2715
+ */
2716
+ export interface AWSAuthentication {
2717
+ type: 'aws';
2718
+ awsAccessKeyId: string;
2719
+ awsSecretAccessKey: string;
2720
+ }
2721
+ /**
2722
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2723
+ * via the `definition` "googleAuthentication".
2724
+ */
2725
+ export interface GoogleAuthentication {
2726
+ type: 'google';
2727
+ clientEmail: string;
2728
+ privateKey: string;
2729
+ }
2730
+ /**
2731
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2732
+ * via the `definition` "serviceConfig".
2733
+ */
2734
+ export interface ServiceConfig {
2735
+ /**
2736
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
2737
+ */
2738
+ id: string;
2739
+ /**
2740
+ * Human-readable name for this service.
2741
+ */
2742
+ title: string;
2743
+ /**
2744
+ * The service provider id.
2745
+ */
2746
+ provider: string;
2747
+ /**
2748
+ * A namespace to use for the imported types tied to this service.
2749
+ */
2750
+ namespace?: string;
2751
+ serviceType: ServiceType;
2752
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
2753
+ authentication?: ServiceAuthentication;
2754
+ healthCheck?: ServiceHealthCheck;
2755
+ webhookId?: string;
2756
+ /**
2757
+ * Configuration options passed to and handled by the provider.
2758
+ */
2759
+ options?: {
2760
+ [k: string]: any;
2761
+ };
2762
+ }