reqon-dsl 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (396) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +22 -0
  3. package/dist/ast/nodes.d.ts +83 -4
  4. package/dist/ast/nodes.js +14 -0
  5. package/dist/auth/circuit-breaker.js +7 -6
  6. package/dist/auth/rate-limiter.d.ts +4 -0
  7. package/dist/auth/rate-limiter.js +9 -16
  8. package/dist/cli.d.ts +13 -0
  9. package/dist/cli.js +84 -4
  10. package/dist/config/constants.d.ts +141 -0
  11. package/dist/config/constants.js +128 -0
  12. package/dist/config/index.d.ts +4 -0
  13. package/dist/config/index.js +4 -0
  14. package/dist/control/index.d.ts +2 -0
  15. package/dist/control/index.js +1 -0
  16. package/dist/control/server.d.ts +88 -0
  17. package/dist/control/server.js +238 -0
  18. package/dist/control/types.d.ts +55 -0
  19. package/dist/control/types.js +7 -0
  20. package/dist/debug/cli-debugger.d.ts +17 -0
  21. package/dist/debug/cli-debugger.js +180 -0
  22. package/dist/debug/controller.d.ts +94 -0
  23. package/dist/debug/controller.js +45 -0
  24. package/dist/debug/index.d.ts +6 -0
  25. package/dist/debug/index.js +5 -0
  26. package/dist/errors/index.d.ts +67 -0
  27. package/dist/errors/index.js +89 -1
  28. package/dist/execution/index.d.ts +1 -1
  29. package/dist/execution/state.d.ts +24 -0
  30. package/dist/index.d.ts +21 -1
  31. package/dist/index.js +33 -2
  32. package/dist/interpreter/context.d.ts +14 -0
  33. package/dist/interpreter/context.js +15 -0
  34. package/dist/interpreter/evaluator.d.ts +63 -1
  35. package/dist/interpreter/evaluator.js +186 -39
  36. package/dist/interpreter/executor.d.ts +70 -14
  37. package/dist/interpreter/executor.js +503 -174
  38. package/dist/interpreter/fetch-handler.d.ts +9 -0
  39. package/dist/interpreter/fetch-handler.js +133 -24
  40. package/dist/interpreter/http.d.ts +5 -0
  41. package/dist/interpreter/http.js +26 -12
  42. package/dist/interpreter/index.d.ts +3 -1
  43. package/dist/interpreter/index.js +2 -0
  44. package/dist/interpreter/pagination.d.ts +11 -2
  45. package/dist/interpreter/pagination.js +95 -31
  46. package/dist/interpreter/signals.d.ts +8 -0
  47. package/dist/interpreter/signals.js +12 -0
  48. package/dist/interpreter/source-manager.d.ts +75 -0
  49. package/dist/interpreter/source-manager.js +157 -0
  50. package/dist/interpreter/step-handlers/apply-handler.d.ts +29 -0
  51. package/dist/interpreter/step-handlers/apply-handler.js +79 -0
  52. package/dist/interpreter/step-handlers/for-handler.d.ts +13 -0
  53. package/dist/interpreter/step-handlers/for-handler.js +71 -4
  54. package/dist/interpreter/step-handlers/index.d.ts +4 -2
  55. package/dist/interpreter/step-handlers/index.js +4 -2
  56. package/dist/interpreter/step-handlers/match-handler.d.ts +9 -0
  57. package/dist/interpreter/step-handlers/match-handler.js +43 -16
  58. package/dist/interpreter/step-handlers/pause-handler.d.ts +52 -0
  59. package/dist/interpreter/step-handlers/pause-handler.js +87 -0
  60. package/dist/interpreter/step-handlers/store-handler.d.ts +11 -1
  61. package/dist/interpreter/step-handlers/store-handler.js +45 -13
  62. package/dist/interpreter/step-handlers/types.d.ts +3 -0
  63. package/dist/interpreter/step-handlers/validate-handler.d.ts +2 -1
  64. package/dist/interpreter/step-handlers/validate-handler.js +4 -2
  65. package/dist/interpreter/step-handlers/webhook-handler.d.ts +3 -0
  66. package/dist/interpreter/step-handlers/webhook-handler.js +18 -2
  67. package/dist/interpreter/store-manager.d.ts +46 -0
  68. package/dist/interpreter/store-manager.js +66 -0
  69. package/dist/lexer/index.d.ts +11 -4
  70. package/dist/lexer/index.js +11 -4
  71. package/dist/lexer/tokens.d.ts +17 -1
  72. package/dist/lexer/tokens.js +36 -0
  73. package/dist/mcp/index.d.ts +11 -0
  74. package/dist/mcp/index.js +11 -0
  75. package/dist/mcp/server.d.ts +17 -0
  76. package/dist/mcp/server.js +451 -0
  77. package/dist/oas/index.d.ts +2 -0
  78. package/dist/oas/index.js +1 -0
  79. package/dist/oas/mock-generator.d.ts +12 -0
  80. package/dist/oas/mock-generator.js +187 -0
  81. package/dist/observability/events.d.ts +244 -0
  82. package/dist/observability/events.js +90 -0
  83. package/dist/observability/index.d.ts +15 -0
  84. package/dist/observability/index.js +12 -0
  85. package/dist/observability/logger.d.ts +106 -0
  86. package/dist/observability/logger.js +259 -0
  87. package/dist/observability/otel.d.ts +135 -0
  88. package/dist/observability/otel.js +386 -0
  89. package/dist/parser/action-parser.d.ts +105 -0
  90. package/dist/parser/action-parser.js +645 -0
  91. package/dist/parser/expressions.d.ts +13 -0
  92. package/dist/parser/expressions.js +72 -2
  93. package/dist/parser/fetch-parser.d.ts +27 -0
  94. package/dist/parser/fetch-parser.js +269 -0
  95. package/dist/parser/index.d.ts +17 -0
  96. package/dist/parser/index.js +17 -0
  97. package/dist/parser/parser.d.ts +44 -46
  98. package/dist/parser/parser.js +122 -1070
  99. package/dist/parser/pipeline-parser.d.ts +12 -0
  100. package/dist/parser/pipeline-parser.js +52 -0
  101. package/dist/parser/schedule-parser.d.ts +7 -0
  102. package/dist/parser/schedule-parser.js +137 -0
  103. package/dist/parser/source-parser.d.ts +9 -0
  104. package/dist/parser/source-parser.js +151 -0
  105. package/dist/pause/index.d.ts +14 -0
  106. package/dist/pause/index.js +11 -0
  107. package/dist/pause/manager.d.ts +118 -0
  108. package/dist/pause/manager.js +245 -0
  109. package/dist/pause/state.d.ts +93 -0
  110. package/dist/pause/state.js +103 -0
  111. package/dist/pause/store.d.ts +61 -0
  112. package/dist/pause/store.js +156 -0
  113. package/dist/plugin.d.ts +9 -12
  114. package/dist/plugin.js +10 -13
  115. package/dist/stores/factory.d.ts +1 -1
  116. package/dist/stores/factory.js +3 -2
  117. package/dist/stores/file.d.ts +26 -0
  118. package/dist/stores/file.js +64 -10
  119. package/dist/stores/index.d.ts +16 -1
  120. package/dist/stores/index.js +16 -1
  121. package/dist/stores/memory.d.ts +4 -0
  122. package/dist/stores/memory.js +11 -0
  123. package/dist/stores/types.d.ts +17 -0
  124. package/dist/stores/types.js +12 -0
  125. package/dist/trace/index.d.ts +16 -0
  126. package/dist/trace/index.js +12 -0
  127. package/dist/trace/recorder.d.ts +71 -0
  128. package/dist/trace/recorder.js +144 -0
  129. package/dist/trace/replay.d.ts +132 -0
  130. package/dist/trace/replay.js +264 -0
  131. package/dist/trace/state.d.ts +102 -0
  132. package/dist/trace/state.js +86 -0
  133. package/dist/trace/store.d.ts +69 -0
  134. package/dist/trace/store.js +225 -0
  135. package/dist/utils/index.d.ts +1 -0
  136. package/dist/utils/index.js +1 -0
  137. package/dist/utils/type-guards.d.ts +58 -0
  138. package/dist/utils/type-guards.js +92 -0
  139. package/dist/webhook/server.js +7 -6
  140. package/package.json +55 -6
  141. package/.claude/settings.local.json +0 -31
  142. package/.claude/skills/api-integration.md +0 -125
  143. package/.claude/skills/database-schema.md +0 -51
  144. package/.claude/skills/dsl-design.md +0 -80
  145. package/.claude/skills/property-testing.md +0 -143
  146. package/.claude/skills/reqon/SKILL.md +0 -44
  147. package/.claude/skills/reqon/references/examples.md +0 -206
  148. package/.claude/skills/reqon/references/syntax.md +0 -263
  149. package/.claude/skills/vscode-extension.md +0 -113
  150. package/.github/dependabot.yml +0 -32
  151. package/.github/pull_request_template.md +0 -21
  152. package/.github/workflows/ci.yml +0 -174
  153. package/.github/workflows/release.yml +0 -73
  154. package/CLAUDE.md +0 -72
  155. package/CONTRIBUTING.md +0 -161
  156. package/TODO.md +0 -51
  157. package/dist/auth/auth.test.d.ts +0 -1
  158. package/dist/auth/auth.test.js +0 -255
  159. package/dist/errors/errors.test.d.ts +0 -1
  160. package/dist/errors/errors.test.js +0 -165
  161. package/dist/execution/execution.test.d.ts +0 -1
  162. package/dist/execution/execution.test.js +0 -246
  163. package/dist/integration.test.d.ts +0 -1
  164. package/dist/integration.test.js +0 -168
  165. package/dist/interpreter/evaluator.test.d.ts +0 -1
  166. package/dist/interpreter/evaluator.test.js +0 -512
  167. package/dist/interpreter/http.test.d.ts +0 -1
  168. package/dist/interpreter/http.test.js +0 -299
  169. package/dist/interpreter/progress.test.d.ts +0 -1
  170. package/dist/interpreter/progress.test.js +0 -216
  171. package/dist/interpreter/schema-matcher.test.d.ts +0 -1
  172. package/dist/interpreter/schema-matcher.test.js +0 -122
  173. package/dist/lexer/lexer.d.ts +0 -24
  174. package/dist/lexer/lexer.js +0 -264
  175. package/dist/lexer/lexer.test.d.ts +0 -1
  176. package/dist/lexer/lexer.test.js +0 -259
  177. package/dist/loader/loader.test.d.ts +0 -1
  178. package/dist/loader/loader.test.js +0 -287
  179. package/dist/oas/oas.test.d.ts +0 -1
  180. package/dist/oas/oas.test.js +0 -218
  181. package/dist/parser/expressions.test.d.ts +0 -1
  182. package/dist/parser/expressions.test.js +0 -378
  183. package/dist/parser/match.test.d.ts +0 -1
  184. package/dist/parser/match.test.js +0 -254
  185. package/dist/parser/parser.test.d.ts +0 -1
  186. package/dist/parser/parser.test.js +0 -333
  187. package/dist/parser/schedule.test.d.ts +0 -1
  188. package/dist/parser/schedule.test.js +0 -241
  189. package/dist/scheduler/cron-parser.test.d.ts +0 -1
  190. package/dist/scheduler/cron-parser.test.js +0 -188
  191. package/dist/stores/file.test.d.ts +0 -1
  192. package/dist/stores/file.test.js +0 -165
  193. package/dist/stores/memory.test.d.ts +0 -1
  194. package/dist/stores/memory.test.js +0 -157
  195. package/dist/stores/stores.test.d.ts +0 -1
  196. package/dist/stores/stores.test.js +0 -158
  197. package/dist/sync/sync.test.d.ts +0 -1
  198. package/dist/sync/sync.test.js +0 -221
  199. package/docusaurus/README.md +0 -41
  200. package/docusaurus/docs/advanced/execution-state.md +0 -283
  201. package/docusaurus/docs/advanced/extending-reqon.md +0 -388
  202. package/docusaurus/docs/advanced/multi-file-missions.md +0 -250
  203. package/docusaurus/docs/advanced/parallel-execution.md +0 -353
  204. package/docusaurus/docs/api-reference.md +0 -443
  205. package/docusaurus/docs/authentication/api-key.md +0 -339
  206. package/docusaurus/docs/authentication/basic.md +0 -276
  207. package/docusaurus/docs/authentication/bearer.md +0 -282
  208. package/docusaurus/docs/authentication/oauth2.md +0 -317
  209. package/docusaurus/docs/authentication/overview.md +0 -251
  210. package/docusaurus/docs/cli.md +0 -229
  211. package/docusaurus/docs/core-concepts/actions.md +0 -286
  212. package/docusaurus/docs/core-concepts/missions.md +0 -264
  213. package/docusaurus/docs/core-concepts/schemas.md +0 -353
  214. package/docusaurus/docs/core-concepts/sources.md +0 -339
  215. package/docusaurus/docs/core-concepts/stores.md +0 -332
  216. package/docusaurus/docs/dsl-syntax/expressions.md +0 -361
  217. package/docusaurus/docs/dsl-syntax/fetch.md +0 -293
  218. package/docusaurus/docs/dsl-syntax/for-loops.md +0 -324
  219. package/docusaurus/docs/dsl-syntax/map.md +0 -345
  220. package/docusaurus/docs/dsl-syntax/match.md +0 -387
  221. package/docusaurus/docs/dsl-syntax/pipelines.md +0 -397
  222. package/docusaurus/docs/dsl-syntax/validate.md +0 -401
  223. package/docusaurus/docs/error-handling/dead-letter-queues.md +0 -399
  224. package/docusaurus/docs/error-handling/flow-control.md +0 -337
  225. package/docusaurus/docs/error-handling/retry-strategies.md +0 -368
  226. package/docusaurus/docs/examples.md +0 -488
  227. package/docusaurus/docs/getting-started.md +0 -256
  228. package/docusaurus/docs/http/circuit-breaker.md +0 -401
  229. package/docusaurus/docs/http/incremental-sync.md +0 -394
  230. package/docusaurus/docs/http/pagination.md +0 -361
  231. package/docusaurus/docs/http/rate-limiting.md +0 -383
  232. package/docusaurus/docs/http/requests.md +0 -328
  233. package/docusaurus/docs/http/retry.md +0 -402
  234. package/docusaurus/docs/intro.md +0 -90
  235. package/docusaurus/docs/openapi/loading-specs.md +0 -305
  236. package/docusaurus/docs/openapi/operation-calls.md +0 -314
  237. package/docusaurus/docs/openapi/overview.md +0 -212
  238. package/docusaurus/docs/openapi/response-validation.md +0 -344
  239. package/docusaurus/docs/scheduling/cron.md +0 -305
  240. package/docusaurus/docs/scheduling/daemon-mode.md +0 -317
  241. package/docusaurus/docs/scheduling/intervals.md +0 -289
  242. package/docusaurus/docs/scheduling/overview.md +0 -231
  243. package/docusaurus/docs/stores/custom-adapters.md +0 -376
  244. package/docusaurus/docs/stores/file.md +0 -236
  245. package/docusaurus/docs/stores/memory.md +0 -193
  246. package/docusaurus/docs/stores/overview.md +0 -274
  247. package/docusaurus/docs/stores/postgrest.md +0 -316
  248. package/docusaurus/docusaurus.config.ts +0 -148
  249. package/docusaurus/package-lock.json +0 -18029
  250. package/docusaurus/package.json +0 -47
  251. package/docusaurus/sidebars.ts +0 -155
  252. package/docusaurus/src/components/HomepageFeatures/index.tsx +0 -105
  253. package/docusaurus/src/components/HomepageFeatures/styles.module.css +0 -12
  254. package/docusaurus/src/css/custom.css +0 -169
  255. package/docusaurus/src/pages/index.module.css +0 -48
  256. package/docusaurus/src/pages/index.tsx +0 -110
  257. package/docusaurus/src/pages/markdown-page.md +0 -7
  258. package/docusaurus/static/.nojekyll +0 -0
  259. package/docusaurus/static/img/docusaurus-social-card.jpg +0 -0
  260. package/docusaurus/static/img/docusaurus.png +0 -0
  261. package/docusaurus/static/img/favicon.ico +0 -0
  262. package/docusaurus/static/img/logo.svg +0 -10
  263. package/docusaurus/static/img/undraw_docusaurus_mountain.svg +0 -171
  264. package/docusaurus/static/img/undraw_docusaurus_react.svg +0 -170
  265. package/docusaurus/static/img/undraw_docusaurus_tree.svg +0 -40
  266. package/docusaurus/tsconfig.json +0 -8
  267. package/examples/README.md +0 -112
  268. package/examples/error-handling/README.md +0 -150
  269. package/examples/error-handling/payment-processor.vague +0 -287
  270. package/examples/github-sync/README.md +0 -74
  271. package/examples/github-sync/fetch-issues.vague +0 -47
  272. package/examples/github-sync/fetch-prs.vague +0 -40
  273. package/examples/github-sync/mission.vague +0 -101
  274. package/examples/github-sync/normalize.vague +0 -70
  275. package/examples/jsonplaceholder/README.md +0 -28
  276. package/examples/jsonplaceholder/posts.vague +0 -48
  277. package/examples/petstore/README.md +0 -35
  278. package/examples/petstore/openapi.yaml +0 -97
  279. package/examples/petstore/sync.vague +0 -52
  280. package/examples/temporal-comparison/README.md +0 -297
  281. package/examples/temporal-comparison/reconciliation.vague +0 -355
  282. package/examples/temporal-comparison/temporal/activities/index.ts +0 -8
  283. package/examples/temporal-comparison/temporal/activities/shipstation.ts +0 -225
  284. package/examples/temporal-comparison/temporal/activities/shopify.ts +0 -257
  285. package/examples/temporal-comparison/temporal/activities/storage.ts +0 -198
  286. package/examples/temporal-comparison/temporal/activities/stripe.ts +0 -169
  287. package/examples/temporal-comparison/temporal/activities/validation.ts +0 -205
  288. package/examples/temporal-comparison/temporal/client/schedule.ts +0 -218
  289. package/examples/temporal-comparison/temporal/config/retry.ts +0 -63
  290. package/examples/temporal-comparison/temporal/types/index.ts +0 -129
  291. package/examples/temporal-comparison/temporal/workers/main.ts +0 -130
  292. package/examples/temporal-comparison/temporal/workflows/orderReconciliation.ts +0 -262
  293. package/examples/xero/README.md +0 -88
  294. package/examples/xero/invoices.vague +0 -189
  295. package/src/api-integration.test.ts +0 -954
  296. package/src/ast/index.ts +0 -1
  297. package/src/ast/nodes.ts +0 -310
  298. package/src/auth/auth.test.ts +0 -326
  299. package/src/auth/circuit-breaker.test.ts +0 -390
  300. package/src/auth/circuit-breaker.ts +0 -379
  301. package/src/auth/credentials.test.ts +0 -273
  302. package/src/auth/credentials.ts +0 -246
  303. package/src/auth/index.ts +0 -40
  304. package/src/auth/oauth2-provider.ts +0 -177
  305. package/src/auth/rate-limiter.ts +0 -459
  306. package/src/auth/token-store.ts +0 -177
  307. package/src/auth/types.ts +0 -159
  308. package/src/benchmark/e2e.bench.ts +0 -288
  309. package/src/benchmark/evaluator.bench.ts +0 -331
  310. package/src/benchmark/fixtures.ts +0 -295
  311. package/src/benchmark/index.ts +0 -108
  312. package/src/benchmark/lexer.bench.ts +0 -69
  313. package/src/benchmark/parser.bench.ts +0 -103
  314. package/src/benchmark/resilience.bench.ts +0 -193
  315. package/src/benchmark/store.bench.ts +0 -147
  316. package/src/benchmark/utils.ts +0 -230
  317. package/src/cli.ts +0 -313
  318. package/src/errors/errors.test.ts +0 -234
  319. package/src/errors/index.ts +0 -223
  320. package/src/execution/execution.test.ts +0 -307
  321. package/src/execution/index.ts +0 -21
  322. package/src/execution/state.ts +0 -207
  323. package/src/execution/store.ts +0 -188
  324. package/src/index.ts +0 -169
  325. package/src/integration.test.ts +0 -192
  326. package/src/interpreter/context.ts +0 -57
  327. package/src/interpreter/evaluator.test.ts +0 -796
  328. package/src/interpreter/evaluator.ts +0 -245
  329. package/src/interpreter/executor.ts +0 -946
  330. package/src/interpreter/fetch-handler.ts +0 -302
  331. package/src/interpreter/http.test.ts +0 -423
  332. package/src/interpreter/http.ts +0 -308
  333. package/src/interpreter/index.ts +0 -32
  334. package/src/interpreter/pagination.ts +0 -207
  335. package/src/interpreter/progress.test.ts +0 -276
  336. package/src/interpreter/schema-matcher.test.ts +0 -160
  337. package/src/interpreter/schema-matcher.ts +0 -168
  338. package/src/interpreter/signals.ts +0 -73
  339. package/src/interpreter/step-handlers/for-handler.ts +0 -65
  340. package/src/interpreter/step-handlers/index.ts +0 -17
  341. package/src/interpreter/step-handlers/map-handler.ts +0 -24
  342. package/src/interpreter/step-handlers/match-handler.ts +0 -101
  343. package/src/interpreter/step-handlers/store-handler.ts +0 -78
  344. package/src/interpreter/step-handlers/types.ts +0 -17
  345. package/src/interpreter/step-handlers/validate-handler.ts +0 -30
  346. package/src/interpreter/step-handlers/webhook-handler.ts +0 -142
  347. package/src/lexer/index.ts +0 -18
  348. package/src/lexer/lexer.test.ts +0 -316
  349. package/src/lexer/tokens.ts +0 -179
  350. package/src/loader/index.ts +0 -288
  351. package/src/loader/loader.test.ts +0 -360
  352. package/src/oas/index.ts +0 -4
  353. package/src/oas/loader.ts +0 -126
  354. package/src/oas/oas.test.ts +0 -254
  355. package/src/oas/validator.ts +0 -299
  356. package/src/parser/base.ts +0 -124
  357. package/src/parser/expressions.test.ts +0 -525
  358. package/src/parser/expressions.ts +0 -314
  359. package/src/parser/index.ts +0 -3
  360. package/src/parser/match.test.ts +0 -296
  361. package/src/parser/parser.test.ts +0 -739
  362. package/src/parser/parser.ts +0 -1469
  363. package/src/parser/schedule.test.ts +0 -287
  364. package/src/parser/webhook.test.ts +0 -248
  365. package/src/plugin.ts +0 -83
  366. package/src/scheduler/cron-parser.test.ts +0 -236
  367. package/src/scheduler/cron-parser.ts +0 -236
  368. package/src/scheduler/index.ts +0 -10
  369. package/src/scheduler/scheduler.ts +0 -443
  370. package/src/scheduler/types.ts +0 -71
  371. package/src/stores/factory.ts +0 -104
  372. package/src/stores/file.test.ts +0 -276
  373. package/src/stores/file.ts +0 -211
  374. package/src/stores/index.ts +0 -6
  375. package/src/stores/memory.test.ts +0 -238
  376. package/src/stores/memory.ts +0 -63
  377. package/src/stores/postgrest.test.ts +0 -488
  378. package/src/stores/postgrest.ts +0 -263
  379. package/src/stores/stores.test.ts +0 -197
  380. package/src/stores/types.ts +0 -58
  381. package/src/sync/index.ts +0 -16
  382. package/src/sync/state.ts +0 -126
  383. package/src/sync/store.ts +0 -139
  384. package/src/sync/sync.test.ts +0 -271
  385. package/src/utils/async.ts +0 -10
  386. package/src/utils/file.ts +0 -106
  387. package/src/utils/index.ts +0 -14
  388. package/src/utils/logger.ts +0 -53
  389. package/src/utils/path.ts +0 -47
  390. package/src/webhook/index.ts +0 -15
  391. package/src/webhook/server.test.ts +0 -253
  392. package/src/webhook/server.ts +0 -389
  393. package/src/webhook/store.ts +0 -239
  394. package/src/webhook/types.ts +0 -93
  395. package/tsconfig.json +0 -17
  396. package/vitest.config.ts +0 -39
@@ -1,316 +0,0 @@
1
- ---
2
- sidebar_position: 4
3
- ---
4
-
5
- # PostgREST Store
6
-
7
- The PostgREST store adapter connects to PostgreSQL via PostgREST or Supabase, enabling production-ready SQL storage.
8
-
9
- ## Configuration
10
-
11
- ### Mission File
12
-
13
- ```vague
14
- store items: sql("items")
15
- store users: sql("users")
16
- ```
17
-
18
- ### Store Configuration
19
-
20
- Create `stores.json`:
21
-
22
- ```json
23
- {
24
- "sql": {
25
- "type": "postgrest",
26
- "url": "https://your-project.supabase.co/rest/v1",
27
- "apiKey": "your-anon-key"
28
- }
29
- }
30
- ```
31
-
32
- Run with:
33
-
34
- ```bash
35
- reqon mission.vague --store-config ./stores.json
36
- ```
37
-
38
- ## Supabase Setup
39
-
40
- ### 1. Create Supabase Project
41
-
42
- 1. Go to [supabase.com](https://supabase.com)
43
- 2. Create a new project
44
- 3. Note your project URL and anon key
45
-
46
- ### 2. Create Tables
47
-
48
- ```sql
49
- CREATE TABLE items (
50
- id TEXT PRIMARY KEY,
51
- data JSONB NOT NULL,
52
- created_at TIMESTAMPTZ DEFAULT NOW(),
53
- updated_at TIMESTAMPTZ DEFAULT NOW()
54
- );
55
-
56
- CREATE TABLE users (
57
- id TEXT PRIMARY KEY,
58
- email TEXT UNIQUE NOT NULL,
59
- name TEXT,
60
- metadata JSONB,
61
- created_at TIMESTAMPTZ DEFAULT NOW()
62
- );
63
- ```
64
-
65
- ### 3. Configure Reqon
66
-
67
- ```json
68
- {
69
- "sql": {
70
- "type": "postgrest",
71
- "url": "https://abc123.supabase.co/rest/v1",
72
- "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
73
- }
74
- }
75
- ```
76
-
77
- ## Self-Hosted PostgREST
78
-
79
- ### Docker Setup
80
-
81
- ```yaml
82
- # docker-compose.yml
83
- version: '3'
84
- services:
85
- db:
86
- image: postgres:15
87
- environment:
88
- POSTGRES_PASSWORD: secret
89
- volumes:
90
- - pgdata:/var/lib/postgresql/data
91
-
92
- postgrest:
93
- image: postgrest/postgrest
94
- environment:
95
- PGRST_DB_URI: postgres://postgres:secret@db:5432/postgres
96
- PGRST_DB_ANON_ROLE: anon
97
- ports:
98
- - "3000:3000"
99
-
100
- volumes:
101
- pgdata:
102
- ```
103
-
104
- ### Configuration
105
-
106
- ```json
107
- {
108
- "sql": {
109
- "type": "postgrest",
110
- "url": "http://localhost:3000"
111
- }
112
- }
113
- ```
114
-
115
- ## Operations
116
-
117
- ### Write
118
-
119
- ```vague
120
- // Insert
121
- store response -> items { key: .id }
122
-
123
- // Upsert
124
- store response -> items { key: .id, upsert: true }
125
-
126
- // Partial update
127
- store response -> items { key: .id, partial: true }
128
- ```
129
-
130
- ### Read
131
-
132
- ```vague
133
- for item in items { }
134
- for item in items where .status == "active" { }
135
- ```
136
-
137
- ### Delete
138
-
139
- ```vague
140
- delete items[item.id]
141
- ```
142
-
143
- ## Query Mapping
144
-
145
- Reqon where clauses map to PostgREST queries:
146
-
147
- | Reqon | PostgREST |
148
- |-------|-----------|
149
- | `.field == "value"` | `?field=eq.value` |
150
- | `.field != "value"` | `?field=neq.value` |
151
- | `.field > 10` | `?field=gt.10` |
152
- | `.field >= 10` | `?field=gte.10` |
153
- | `.field < 10` | `?field=lt.10` |
154
- | `.field <= 10` | `?field=lte.10` |
155
-
156
- ## Authentication
157
-
158
- ### Anon Key
159
-
160
- ```json
161
- {
162
- "sql": {
163
- "type": "postgrest",
164
- "url": "https://abc.supabase.co/rest/v1",
165
- "apiKey": "anon-key"
166
- }
167
- }
168
- ```
169
-
170
- ### Service Role Key
171
-
172
- For full access:
173
-
174
- ```json
175
- {
176
- "sql": {
177
- "type": "postgrest",
178
- "url": "https://abc.supabase.co/rest/v1",
179
- "apiKey": "service-role-key"
180
- }
181
- }
182
- ```
183
-
184
- ### Row Level Security
185
-
186
- With RLS enabled:
187
-
188
- ```json
189
- {
190
- "sql": {
191
- "type": "postgrest",
192
- "url": "https://abc.supabase.co/rest/v1",
193
- "apiKey": "anon-key",
194
- "headers": {
195
- "Authorization": "Bearer user-jwt"
196
- }
197
- }
198
- }
199
- ```
200
-
201
- ## Best Practices
202
-
203
- ### Table Design
204
-
205
- ```sql
206
- CREATE TABLE items (
207
- -- Use text ID for compatibility
208
- id TEXT PRIMARY KEY,
209
-
210
- -- Store full record as JSONB
211
- data JSONB NOT NULL,
212
-
213
- -- Add common query fields
214
- status TEXT,
215
- created_at TIMESTAMPTZ DEFAULT NOW(),
216
- updated_at TIMESTAMPTZ DEFAULT NOW()
217
- );
218
-
219
- -- Index common queries
220
- CREATE INDEX items_status_idx ON items(status);
221
- CREATE INDEX items_created_idx ON items(created_at);
222
- ```
223
-
224
- ### Upsert with Timestamps
225
-
226
- ```sql
227
- -- Add trigger for updated_at
228
- CREATE OR REPLACE FUNCTION update_updated_at()
229
- RETURNS TRIGGER AS $$
230
- BEGIN
231
- NEW.updated_at = NOW();
232
- RETURN NEW;
233
- END;
234
- $$ LANGUAGE plpgsql;
235
-
236
- CREATE TRIGGER items_updated
237
- BEFORE UPDATE ON items
238
- FOR EACH ROW
239
- EXECUTE FUNCTION update_updated_at();
240
- ```
241
-
242
- ### Connection Pooling
243
-
244
- For high-volume usage:
245
-
246
- ```json
247
- {
248
- "sql": {
249
- "type": "postgrest",
250
- "url": "https://abc.supabase.co/rest/v1",
251
- "apiKey": "...",
252
- "poolSize": 10
253
- }
254
- }
255
- ```
256
-
257
- ## Error Handling
258
-
259
- ```vague
260
- action SafeStore {
261
- get "/items"
262
-
263
- for item in response.items {
264
- match {
265
- _ where true -> {
266
- store item -> items { key: .id }
267
- }
268
- } catch {
269
- { code: 23505 } -> skip, // Unique violation
270
- { code: 23503 } -> skip, // Foreign key violation
271
- _ -> queue errors { item: { id: item.id, error: "Store failed" } }
272
- }
273
- }
274
- }
275
- ```
276
-
277
- ## Monitoring
278
-
279
- ### Query Logs
280
-
281
- Enable in Supabase Dashboard or PostgREST config.
282
-
283
- ### Performance
284
-
285
- ```sql
286
- -- Check slow queries
287
- SELECT * FROM pg_stat_statements
288
- ORDER BY total_time DESC
289
- LIMIT 10;
290
- ```
291
-
292
- ## Troubleshooting
293
-
294
- ### "Relation does not exist"
295
-
296
- Table hasn't been created:
297
-
298
- ```sql
299
- CREATE TABLE your_table (...);
300
- ```
301
-
302
- ### "Permission denied"
303
-
304
- Check RLS policies:
305
-
306
- ```sql
307
- CREATE POLICY "Allow all" ON items FOR ALL USING (true);
308
- ```
309
-
310
- ### Connection Issues
311
-
312
- Verify URL and credentials:
313
-
314
- ```bash
315
- curl -H "apikey: your-key" https://abc.supabase.co/rest/v1/items
316
- ```
@@ -1,148 +0,0 @@
1
- import {themes as prismThemes} from 'prism-react-renderer';
2
- import type {Config} from '@docusaurus/types';
3
- import type * as Preset from '@docusaurus/preset-classic';
4
-
5
- const config: Config = {
6
- title: 'Reqon',
7
- tagline: 'Declarative DSL for fetch, map, validate pipelines',
8
- favicon: 'img/favicon.ico',
9
-
10
- future: {
11
- v4: true,
12
- },
13
-
14
- url: 'https://reqon.dev',
15
- baseUrl: '/',
16
-
17
- organizationName: 'mcclowes',
18
- projectName: 'reqon',
19
-
20
- onBrokenLinks: 'throw',
21
- onBrokenMarkdownLinks: 'warn',
22
-
23
- i18n: {
24
- defaultLocale: 'en',
25
- locales: ['en'],
26
- },
27
-
28
- presets: [
29
- [
30
- 'classic',
31
- {
32
- docs: {
33
- sidebarPath: './sidebars.ts',
34
- editUrl: 'https://github.com/mcclowes/reqon/tree/main/docusaurus/',
35
- routeBasePath: 'docs',
36
- },
37
- blog: false,
38
- theme: {
39
- customCss: './src/css/custom.css',
40
- },
41
- } satisfies Preset.Options,
42
- ],
43
- ],
44
-
45
- themeConfig: {
46
- image: 'img/reqon-social-card.png',
47
- colorMode: {
48
- defaultMode: 'light',
49
- respectPrefersColorScheme: true,
50
- },
51
- navbar: {
52
- title: 'Reqon',
53
- logo: {
54
- alt: 'Reqon Logo',
55
- src: 'img/logo.svg',
56
- },
57
- items: [
58
- {
59
- type: 'docSidebar',
60
- sidebarId: 'docsSidebar',
61
- position: 'left',
62
- label: 'Documentation',
63
- },
64
- {
65
- to: '/docs/examples',
66
- label: 'Examples',
67
- position: 'left',
68
- },
69
- {
70
- to: '/docs/api-reference',
71
- label: 'API',
72
- position: 'left',
73
- },
74
- {
75
- href: 'https://github.com/mcclowes/vague',
76
- label: 'Vague DSL',
77
- position: 'right',
78
- },
79
- {
80
- href: 'https://github.com/mcclowes/reqon',
81
- label: 'GitHub',
82
- position: 'right',
83
- },
84
- ],
85
- },
86
- footer: {
87
- style: 'dark',
88
- links: [
89
- {
90
- title: 'Learn',
91
- items: [
92
- {
93
- label: 'Getting Started',
94
- to: '/docs/getting-started',
95
- },
96
- {
97
- label: 'Core Concepts',
98
- to: '/docs/category/core-concepts',
99
- },
100
- {
101
- label: 'Examples',
102
- to: '/docs/examples',
103
- },
104
- ],
105
- },
106
- {
107
- title: 'Reference',
108
- items: [
109
- {
110
- label: 'DSL Syntax',
111
- to: '/docs/category/dsl-syntax',
112
- },
113
- {
114
- label: 'API Reference',
115
- to: '/docs/api-reference',
116
- },
117
- {
118
- label: 'CLI',
119
- to: '/docs/cli',
120
- },
121
- ],
122
- },
123
- {
124
- title: 'More',
125
- items: [
126
- {
127
- label: 'GitHub',
128
- href: 'https://github.com/mcclowes/reqon',
129
- },
130
- {
131
- label: 'Vague DSL',
132
- href: 'https://github.com/mcclowes/vague',
133
- },
134
- ],
135
- },
136
- ],
137
- copyright: `Copyright © ${new Date().getFullYear()} Reqon. Built with Docusaurus.`,
138
- },
139
- prism: {
140
- theme: prismThemes.github,
141
- darkTheme: prismThemes.dracula,
142
- additionalLanguages: ['bash', 'json', 'yaml'],
143
- },
144
- algolia: undefined,
145
- } satisfies Preset.ThemeConfig,
146
- };
147
-
148
- export default config;