@apifuse/provider-sdk 2.2.0-beta.3 → 2.2.0-beta.30

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 (342) hide show
  1. package/AUTHORING.md +493 -5
  2. package/CHANGELOG.md +127 -1
  3. package/README.md +52 -6
  4. package/SUBMISSION.md +1 -1
  5. package/bin/apifuse-check.ts +106 -62
  6. package/bin/apifuse-create.ts +1 -1
  7. package/bin/apifuse-dev.ts +63 -55
  8. package/bin/apifuse-pack-check.ts +22 -2
  9. package/bin/apifuse-pack-smoke.ts +78 -82
  10. package/bin/apifuse-pack-types.ts +583 -0
  11. package/bin/apifuse-perf.ts +59 -140
  12. package/bin/apifuse-record.ts +698 -113
  13. package/bin/apifuse-submit-check.ts +517 -44
  14. package/bin/apifuse-sync-assets.ts +117 -0
  15. package/bin/apifuse.ts +1 -1
  16. package/bin/submit-check-delimited-text.ts +50 -0
  17. package/bin/submit-check-xml.ts +1 -1
  18. package/dist/auth-turn/index.d.ts +4 -4
  19. package/dist/auth-turn/index.js +1 -1
  20. package/dist/auth.d.ts +16 -2
  21. package/dist/auth.js +76 -18
  22. package/dist/ceremonies/index.d.ts +9 -1
  23. package/dist/ceremonies/index.js +117 -29
  24. package/dist/cli/commands.d.ts +1 -1
  25. package/dist/cli/commands.js +8 -0
  26. package/dist/cli/create.d.ts +3 -0
  27. package/dist/cli/create.js +34 -35
  28. package/dist/cli/prompt-assets.d.ts +80 -0
  29. package/dist/cli/prompt-assets.js +743 -0
  30. package/dist/cli/templates/provider/AGENTS.md.tpl +17 -8
  31. package/dist/cli/templates/provider/README.md.tpl +4 -4
  32. package/dist/config/loader.d.ts +176 -17
  33. package/dist/config/loader.js +434 -161
  34. package/dist/contract-serialization.d.ts +2 -2
  35. package/dist/contract-serialization.js +7 -14
  36. package/dist/contract-types.d.ts +3 -2
  37. package/dist/contract.d.ts +3 -3
  38. package/dist/contract.js +6 -6
  39. package/dist/declaration-validation.d.ts +23 -0
  40. package/dist/declaration-validation.js +159 -0
  41. package/dist/define.d.ts +13 -1
  42. package/dist/define.js +391 -122
  43. package/dist/dev.d.ts +1 -1
  44. package/dist/dev.js +1 -1
  45. package/dist/error-resolution.d.ts +4 -0
  46. package/dist/error-resolution.js +122 -0
  47. package/dist/errors.d.ts +19 -1
  48. package/dist/errors.js +41 -3
  49. package/dist/fixture-sanitization.d.ts +26 -0
  50. package/dist/fixture-sanitization.js +216 -0
  51. package/dist/i18n/catalog.d.ts +2 -2
  52. package/dist/i18n/catalog.js +4 -10
  53. package/dist/i18n/index.d.ts +2 -2
  54. package/dist/i18n/index.js +2 -2
  55. package/dist/i18n/keys.d.ts +2 -2
  56. package/dist/index.d.ts +50 -42
  57. package/dist/index.js +41 -37
  58. package/dist/lint.d.ts +6 -1
  59. package/dist/lint.js +370 -18
  60. package/dist/native-address.d.ts +43 -0
  61. package/dist/native-address.js +281 -0
  62. package/dist/native-egress-policy.d.ts +31 -0
  63. package/dist/native-egress-policy.js +288 -0
  64. package/dist/observability.d.ts +5 -2
  65. package/dist/observability.js +48 -1
  66. package/dist/provider.d.ts +13 -11
  67. package/dist/provider.js +10 -9
  68. package/dist/public-schema-field-lint.d.ts +1 -1
  69. package/dist/recipes/gov-api.js +1 -1
  70. package/dist/runtime/auth-flow.d.ts +3 -1
  71. package/dist/runtime/auth-flow.js +8 -3
  72. package/dist/runtime/browser.d.ts +1 -1
  73. package/dist/runtime/browser.js +138 -40
  74. package/dist/runtime/cache.d.ts +2 -1
  75. package/dist/runtime/cache.js +173 -23
  76. package/dist/runtime/choice-wordlist.d.ts +9 -0
  77. package/dist/runtime/choice-wordlist.js +138 -0
  78. package/dist/runtime/choice.d.ts +13 -1
  79. package/dist/runtime/choice.js +514 -124
  80. package/dist/runtime/credential.d.ts +1 -1
  81. package/dist/runtime/credential.js +1 -1
  82. package/dist/runtime/env.d.ts +1 -1
  83. package/dist/runtime/executor.d.ts +1 -1
  84. package/dist/runtime/executor.js +25 -3
  85. package/dist/runtime/http.d.ts +3 -2
  86. package/dist/runtime/http.js +517 -55
  87. package/dist/runtime/insights.d.ts +1 -1
  88. package/dist/runtime/insights.js +6 -13
  89. package/dist/runtime/instrumentation.d.ts +2 -2
  90. package/dist/runtime/instrumentation.js +371 -23
  91. package/dist/runtime/keyring.js +1 -1
  92. package/dist/runtime/namespace.js +1 -1
  93. package/dist/runtime/native-network-errors.d.ts +33 -0
  94. package/dist/runtime/native-network-errors.js +69 -0
  95. package/dist/runtime/native-network.d.ts +96 -0
  96. package/dist/runtime/native-network.js +1232 -0
  97. package/dist/runtime/ocr.d.ts +29 -0
  98. package/dist/runtime/ocr.js +440 -0
  99. package/dist/runtime/otlp.d.ts +1 -1
  100. package/dist/runtime/perf.d.ts +1 -1
  101. package/dist/runtime/provider.d.ts +1 -1
  102. package/dist/runtime/provider.js +1 -2
  103. package/dist/runtime/proxy-errors.d.ts +1 -1
  104. package/dist/runtime/proxy-errors.js +9 -7
  105. package/dist/runtime/proxy-nodemaven.d.ts +56 -0
  106. package/dist/runtime/proxy-nodemaven.js +146 -0
  107. package/dist/runtime/proxy-retry-policy.d.ts +2 -2
  108. package/dist/runtime/proxy-retry-policy.js +2 -2
  109. package/dist/runtime/proxy-telemetry.d.ts +2 -1
  110. package/dist/runtime/proxy-telemetry.js +58 -52
  111. package/dist/runtime/redirects.d.ts +29 -0
  112. package/dist/runtime/redirects.js +36 -0
  113. package/dist/runtime/redis.d.ts +1 -1
  114. package/dist/runtime/redis.js +5 -5
  115. package/dist/runtime/request-options.d.ts +68 -1
  116. package/dist/runtime/request-options.js +548 -0
  117. package/dist/runtime/resolver-config.d.ts +6 -0
  118. package/dist/runtime/resolver-config.js +6 -0
  119. package/dist/runtime/resolver-public.d.ts +1 -0
  120. package/dist/runtime/resolver-public.js +1 -0
  121. package/dist/runtime/resolver-shared.d.ts +3 -0
  122. package/dist/runtime/resolver-shared.js +12 -0
  123. package/dist/runtime/resolver-vendors/bindings.d.ts +48 -0
  124. package/dist/runtime/resolver-vendors/bindings.js +40 -0
  125. package/dist/runtime/resolver-vendors/browser.d.ts +20 -0
  126. package/dist/runtime/resolver-vendors/browser.js +282 -0
  127. package/dist/runtime/resolver-vendors/hosts.d.ts +2 -0
  128. package/dist/runtime/resolver-vendors/hosts.js +33 -0
  129. package/dist/runtime/resolver-vendors/twocaptcha.d.ts +24 -0
  130. package/dist/runtime/resolver-vendors/twocaptcha.js +368 -0
  131. package/dist/runtime/resolver-vendors/types.d.ts +83 -0
  132. package/dist/runtime/resolver-vendors/types.js +69 -0
  133. package/dist/runtime/resolver.d.ts +59 -0
  134. package/dist/runtime/resolver.js +705 -0
  135. package/dist/runtime/secrets.d.ts +27 -0
  136. package/dist/runtime/secrets.js +51 -0
  137. package/dist/runtime/state.d.ts +5 -2
  138. package/dist/runtime/state.js +280 -74
  139. package/dist/runtime/stealth-cookies.d.ts +20 -0
  140. package/dist/runtime/stealth-cookies.js +111 -0
  141. package/dist/runtime/stealth.d.ts +30 -5
  142. package/dist/runtime/stealth.js +523 -259
  143. package/dist/runtime/stt.d.ts +1 -1
  144. package/dist/runtime/stt.js +12 -27
  145. package/dist/runtime/timeout.d.ts +5 -0
  146. package/dist/runtime/timeout.js +12 -0
  147. package/dist/runtime/trace.d.ts +2 -2
  148. package/dist/runtime/trace.js +2 -4
  149. package/dist/runtime/waterfall.d.ts +1 -1
  150. package/dist/schema.d.ts +1 -1
  151. package/dist/schema.js +7 -15
  152. package/dist/serve.d.ts +1 -1
  153. package/dist/serve.js +1 -1
  154. package/dist/server/index.d.ts +7 -7
  155. package/dist/server/index.js +6 -6
  156. package/dist/server/self-test-input-tokens.d.ts +2 -1
  157. package/dist/server/self-test-input-tokens.js +18 -14
  158. package/dist/server/self-test-redaction.d.ts +1 -1
  159. package/dist/server/self-test-redaction.js +1 -1
  160. package/dist/server/self-test.d.ts +117 -3
  161. package/dist/server/self-test.js +787 -151
  162. package/dist/server/serve-implementation.d.ts +210 -0
  163. package/dist/server/serve-implementation.js +2077 -0
  164. package/dist/server/serve.d.ts +1 -70
  165. package/dist/server/serve.js +1 -1143
  166. package/dist/server/types.d.ts +34 -9
  167. package/dist/server/types.js +8 -1
  168. package/dist/stateful/errors.d.ts +19 -0
  169. package/dist/stateful/errors.js +24 -0
  170. package/dist/stateful/http-provider-event-emitter.d.ts +40 -0
  171. package/dist/stateful/http-provider-event-emitter.js +237 -0
  172. package/dist/stateful/http-session-owner-registry.d.ts +44 -0
  173. package/dist/stateful/http-session-owner-registry.js +210 -0
  174. package/dist/stateful/index.d.ts +18 -0
  175. package/dist/stateful/index.js +18 -0
  176. package/dist/stateful/provider-event-delivery-failures.d.ts +32 -0
  177. package/dist/stateful/provider-event-delivery-failures.js +43 -0
  178. package/dist/stateful/provider-event-pipeline-metrics.d.ts +46 -0
  179. package/dist/stateful/provider-event-pipeline-metrics.js +48 -0
  180. package/dist/stateful/provider-event-pipeline.d.ts +50 -0
  181. package/dist/stateful/provider-event-pipeline.js +1 -0
  182. package/dist/stateful/provider-events.d.ts +101 -0
  183. package/dist/stateful/provider-events.js +289 -0
  184. package/dist/stateful/session-key.d.ts +15 -0
  185. package/dist/stateful/session-key.js +86 -0
  186. package/dist/stateful/stateful-provider-adapter-context.d.ts +5 -0
  187. package/dist/stateful/stateful-provider-adapter-context.js +42 -0
  188. package/dist/stateful/stateful-provider-adapter-metrics.d.ts +15 -0
  189. package/dist/stateful/stateful-provider-adapter-metrics.js +21 -0
  190. package/dist/stateful/stateful-provider-adapter.d.ts +98 -0
  191. package/dist/stateful/stateful-provider-adapter.js +287 -0
  192. package/dist/stateful/stateful-provider-observability.d.ts +62 -0
  193. package/dist/stateful/stateful-provider-observability.js +161 -0
  194. package/dist/stateful/stateful-provider-owner-forwarder.d.ts +41 -0
  195. package/dist/stateful/stateful-provider-owner-forwarder.js +215 -0
  196. package/dist/stateful/stateful-provider-runtime-context.d.ts +32 -0
  197. package/dist/stateful/stateful-provider-runtime-context.js +60 -0
  198. package/dist/stateful/stateful-provider-runtime-executor.d.ts +34 -0
  199. package/dist/stateful/stateful-provider-runtime-executor.js +52 -0
  200. package/dist/stateful/stateful-provider-session-routing.d.ts +67 -0
  201. package/dist/stateful/stateful-provider-session-routing.js +345 -0
  202. package/dist/stateful/stateful-provider-session-runtime.d.ts +98 -0
  203. package/dist/stateful/stateful-provider-session-runtime.js +245 -0
  204. package/dist/stateful-signing.d.ts +18 -0
  205. package/dist/stateful-signing.js +27 -0
  206. package/dist/stealth/profiles.d.ts +1 -1
  207. package/dist/stealth/profiles.js +21 -21
  208. package/dist/stream-evidence.d.ts +74 -0
  209. package/dist/stream-evidence.js +785 -0
  210. package/dist/stream.d.ts +1 -1
  211. package/dist/stream.js +7 -1
  212. package/dist/testing/index.d.ts +3 -2
  213. package/dist/testing/index.js +3 -2
  214. package/dist/testing/run.d.ts +32 -2
  215. package/dist/testing/run.js +488 -28
  216. package/dist/types.d.ts +566 -19
  217. package/dist/types.js +1 -0
  218. package/dist/user-input.d.ts +30 -0
  219. package/dist/user-input.js +66 -0
  220. package/package.json +42 -7
  221. package/src/auth-turn/index.ts +2 -2
  222. package/src/auth.ts +146 -86
  223. package/src/ceremonies/index.ts +167 -92
  224. package/src/cli/commands.ts +10 -0
  225. package/src/cli/create.ts +42 -35
  226. package/src/cli/prompt-assets.ts +865 -0
  227. package/src/cli/templates/provider/AGENTS.md.tpl +17 -8
  228. package/src/cli/templates/provider/README.md.tpl +4 -4
  229. package/src/config/loader.ts +667 -289
  230. package/src/contract-serialization.ts +10 -18
  231. package/src/contract-types.ts +3 -2
  232. package/src/contract.ts +14 -28
  233. package/src/declaration-validation.ts +202 -0
  234. package/src/define.ts +631 -495
  235. package/src/dev.ts +4 -9
  236. package/src/error-resolution.ts +127 -0
  237. package/src/errors.ts +56 -11
  238. package/src/fixture-sanitization.ts +247 -0
  239. package/src/i18n/catalog.ts +10 -32
  240. package/src/i18n/index.ts +2 -2
  241. package/src/i18n/keys.ts +5 -11
  242. package/src/index.ts +157 -44
  243. package/src/lint.ts +488 -154
  244. package/src/native-address.ts +340 -0
  245. package/src/native-egress-policy.ts +358 -0
  246. package/src/observability.ts +51 -1
  247. package/src/provider.ts +65 -11
  248. package/src/public-schema-field-lint.ts +7 -33
  249. package/src/recipes/gov-api.ts +2 -5
  250. package/src/runtime/auth-flow.ts +13 -7
  251. package/src/runtime/browser.ts +252 -207
  252. package/src/runtime/cache.ts +209 -81
  253. package/src/runtime/choice-wordlist.ts +145 -0
  254. package/src/runtime/choice.ts +685 -216
  255. package/src/runtime/credential.ts +2 -2
  256. package/src/runtime/env.ts +1 -1
  257. package/src/runtime/executor.ts +37 -19
  258. package/src/runtime/http.ts +645 -65
  259. package/src/runtime/insights.ts +15 -53
  260. package/src/runtime/instrumentation.ts +530 -67
  261. package/src/runtime/keyring.ts +7 -19
  262. package/src/runtime/namespace.ts +2 -7
  263. package/src/runtime/native-network-errors.ts +99 -0
  264. package/src/runtime/native-network.ts +1605 -0
  265. package/src/runtime/ocr.ts +523 -0
  266. package/src/runtime/otlp.ts +12 -23
  267. package/src/runtime/perf.ts +1 -1
  268. package/src/runtime/provider.ts +4 -9
  269. package/src/runtime/proxy-errors.ts +29 -42
  270. package/src/runtime/proxy-nodemaven.ts +221 -0
  271. package/src/runtime/proxy-retry-policy.ts +3 -3
  272. package/src/runtime/proxy-telemetry.ts +84 -77
  273. package/src/runtime/redirects.ts +66 -0
  274. package/src/runtime/redis.ts +10 -13
  275. package/src/runtime/request-options.ts +679 -9
  276. package/src/runtime/resolver-config.ts +6 -0
  277. package/src/runtime/resolver-public.ts +18 -0
  278. package/src/runtime/resolver-shared.ts +17 -0
  279. package/src/runtime/resolver-vendors/bindings.ts +56 -0
  280. package/src/runtime/resolver-vendors/browser.ts +408 -0
  281. package/src/runtime/resolver-vendors/hosts.ts +38 -0
  282. package/src/runtime/resolver-vendors/twocaptcha.ts +500 -0
  283. package/src/runtime/resolver-vendors/types.ts +173 -0
  284. package/src/runtime/resolver.ts +1060 -0
  285. package/src/runtime/secrets.ts +64 -0
  286. package/src/runtime/state.ts +399 -161
  287. package/src/runtime/stealth-cookies.ts +132 -0
  288. package/src/runtime/stealth.ts +681 -295
  289. package/src/runtime/stt.ts +39 -113
  290. package/src/runtime/timeout.ts +18 -0
  291. package/src/runtime/trace.ts +14 -44
  292. package/src/runtime/waterfall.ts +5 -18
  293. package/src/schema.ts +23 -84
  294. package/src/serve.ts +6 -1
  295. package/src/server/index.ts +30 -7
  296. package/src/server/self-test-input-tokens.ts +29 -14
  297. package/src/server/self-test-redaction.ts +2 -2
  298. package/src/server/self-test.ts +1030 -180
  299. package/src/server/serve-implementation.ts +3060 -0
  300. package/src/server/serve.ts +1 -1781
  301. package/src/server/types.ts +12 -13
  302. package/src/stateful/README.md +146 -0
  303. package/src/stateful/errors.ts +35 -0
  304. package/src/stateful/http-provider-event-emitter.ts +314 -0
  305. package/src/stateful/http-session-owner-registry.ts +306 -0
  306. package/src/stateful/index.ts +18 -0
  307. package/src/stateful/provider-event-delivery-failures.ts +80 -0
  308. package/src/stateful/provider-event-pipeline-metrics.ts +95 -0
  309. package/src/stateful/provider-event-pipeline.ts +61 -0
  310. package/src/stateful/provider-events.ts +462 -0
  311. package/src/stateful/session-key.ts +111 -0
  312. package/src/stateful/stateful-provider-adapter-context.ts +59 -0
  313. package/src/stateful/stateful-provider-adapter-metrics.ts +48 -0
  314. package/src/stateful/stateful-provider-adapter.ts +562 -0
  315. package/src/stateful/stateful-provider-observability.ts +261 -0
  316. package/src/stateful/stateful-provider-owner-forwarder.ts +287 -0
  317. package/src/stateful/stateful-provider-runtime-context.ts +92 -0
  318. package/src/stateful/stateful-provider-runtime-executor.ts +96 -0
  319. package/src/stateful/stateful-provider-session-routing.ts +546 -0
  320. package/src/stateful/stateful-provider-session-runtime.ts +403 -0
  321. package/src/stateful-signing.ts +46 -0
  322. package/src/stealth/profiles.ts +27 -33
  323. package/src/stream-evidence.ts +988 -0
  324. package/src/stream.ts +16 -20
  325. package/src/testing/index.ts +11 -2
  326. package/src/testing/run.ts +668 -74
  327. package/src/types.ts +665 -35
  328. package/src/user-input.ts +118 -0
  329. package/dist/cli/templates/provider/CLAUDE.md.tpl +0 -1
  330. package/src/cli/templates/provider/CLAUDE.md.tpl +0 -1
  331. /package/dist/cli/templates/provider/{skills → .agents/skills}/fixtures-and-recording/SKILL.md.tpl +0 -0
  332. /package/dist/cli/templates/provider/{skills → .agents/skills}/health-checks-and-fail-closed/SKILL.md.tpl +0 -0
  333. /package/dist/cli/templates/provider/{skills → .agents/skills}/normalization-standards/SKILL.md.tpl +0 -0
  334. /package/dist/cli/templates/provider/{skills → .agents/skills}/pagination-and-counts/SKILL.md.tpl +0 -0
  335. /package/dist/cli/templates/provider/{skills → .agents/skills}/upstream-contract-verification/SKILL.md.tpl +0 -0
  336. /package/dist/cli/templates/provider/{skills → .agents/skills}/upstream-notes/README.md.tpl +0 -0
  337. /package/src/cli/templates/provider/{skills → .agents/skills}/fixtures-and-recording/SKILL.md.tpl +0 -0
  338. /package/src/cli/templates/provider/{skills → .agents/skills}/health-checks-and-fail-closed/SKILL.md.tpl +0 -0
  339. /package/src/cli/templates/provider/{skills → .agents/skills}/normalization-standards/SKILL.md.tpl +0 -0
  340. /package/src/cli/templates/provider/{skills → .agents/skills}/pagination-and-counts/SKILL.md.tpl +0 -0
  341. /package/src/cli/templates/provider/{skills → .agents/skills}/upstream-contract-verification/SKILL.md.tpl +0 -0
  342. /package/src/cli/templates/provider/{skills → .agents/skills}/upstream-notes/README.md.tpl +0 -0
package/dist/types.js CHANGED
@@ -32,6 +32,7 @@ export const HEALTH_CHECK_TIMEOUT_MS_MIN = 1;
32
32
  export const HEALTH_CHECK_TIMEOUT_MS_MAX = 60_000;
33
33
  export const HEALTH_CHECK_DEGRADED_THRESHOLD_MS_MIN = 1;
34
34
  export const HEALTH_CHECK_DEGRADED_THRESHOLD_MS_MAX = 60_000;
35
+ export const VALID_OPERATION_ERROR_STATUSES = [400, 401, 404, 409, 410, 422, 429, 500, 502, 503, 504];
35
36
  export const HttpRetryPreset = {
36
37
  Off: "off",
37
38
  TransportTransient: "transport_transient",
@@ -0,0 +1,30 @@
1
+ export declare const NEEDS_INPUT_STATUS: "needs_input";
2
+ export interface ProviderSelectionOption {
3
+ readonly selection_value: string;
4
+ readonly label: string;
5
+ readonly [extra: string]: unknown;
6
+ }
7
+ export interface ProviderRequiredSelection {
8
+ readonly selection_key: string;
9
+ readonly label: string;
10
+ readonly required: boolean;
11
+ readonly selection_type?: string;
12
+ readonly valid_options: readonly ProviderSelectionOption[];
13
+ readonly [extra: string]: unknown;
14
+ }
15
+ export interface ProviderSelectedOption {
16
+ readonly selection_key: string;
17
+ readonly selection_value: string;
18
+ /** Free-text answer for text-kind selections. */
19
+ readonly text?: string;
20
+ /** Quantity for quantity-kind selections. */
21
+ readonly quantity?: number;
22
+ }
23
+ export interface ProviderNeedsInputPayload {
24
+ readonly status: typeof NEEDS_INPUT_STATUS;
25
+ readonly required_selections: readonly ProviderRequiredSelection[];
26
+ readonly selected_options?: readonly ProviderSelectedOption[];
27
+ /** Provider-specific fresh state token(s), e.g. `reservation_state`. */
28
+ readonly [extra: string]: unknown;
29
+ }
30
+ export declare function isProviderNeedsInputPayload(value: unknown): value is ProviderNeedsInputPayload;
@@ -0,0 +1,66 @@
1
+ // Official cross-provider contract for user-input round-trips.
2
+ //
3
+ // Doctrine (born from the 2026-07-20 CatchTable reserve incident): an
4
+ // operation MUST NOT dead-end on a problem the end user can resolve by
5
+ // choosing among live options. Instead of throwing, the provider returns a
6
+ // SUCCESSFUL payload with `status: "needs_input"` that carries everything a
7
+ // consumer-side agent needs to relay the choice verbatim and retry:
8
+ //
9
+ // - `required_selections`: only the still-pending questions, each with
10
+ // human-readable `label`s and `valid_options` the agent shows the user
11
+ // as-is. The agent never chooses on the user's behalf.
12
+ // - `selected_options`: selections already settled, echoed so the follow-up
13
+ // call keeps them without the agent reconstructing anything.
14
+ // - a fresh provider-specific state token (e.g. `reservation_state`) minted
15
+ // at response time, so the retry never races an expired token.
16
+ //
17
+ // Keeping this success-shaped (instead of error `details`) is deliberate:
18
+ // consumer error-shaping layers routinely strip error metadata, and a model
19
+ // that only sees "error" narrates failure to the user. Complex recovery
20
+ // logic belongs to the system, not the model.
21
+ //
22
+ // Deliberately ABSENT: retry templates, next-action routing, or any other
23
+ // agent choreography. Provider payloads carry upstream-backed data only; how
24
+ // to phrase the ask and shape the retry call is the consumer's contract
25
+ // (apifuse#1030). The retry is fully determined by data: copy the echoed
26
+ // selected_options, add the user's new answers, resend with the fresh state.
27
+ export const NEEDS_INPUT_STATUS = "needs_input";
28
+ function isRecord(value) {
29
+ return typeof value === "object" && value !== null && !Array.isArray(value);
30
+ }
31
+ function isSelectionOption(value) {
32
+ return (isRecord(value) &&
33
+ typeof value.selection_value === "string" &&
34
+ typeof value.label === "string");
35
+ }
36
+ function isRequiredSelection(value) {
37
+ return (isRecord(value) &&
38
+ typeof value.selection_key === "string" &&
39
+ typeof value.label === "string" &&
40
+ typeof value.required === "boolean" &&
41
+ Array.isArray(value.valid_options) &&
42
+ value.valid_options.every(isSelectionOption));
43
+ }
44
+ function isSelectedOption(value) {
45
+ return (isRecord(value) &&
46
+ typeof value.selection_key === "string" &&
47
+ typeof value.selection_value === "string");
48
+ }
49
+ export function isProviderNeedsInputPayload(value) {
50
+ if (!isRecord(value)) {
51
+ return false;
52
+ }
53
+ if (value.status !== NEEDS_INPUT_STATUS ||
54
+ !Array.isArray(value.required_selections) ||
55
+ !value.required_selections.every(isRequiredSelection)) {
56
+ return false;
57
+ }
58
+ // A needs_input with nothing to ask AND nothing settled to echo is a
59
+ // no-op dead end — reject it so providers cannot ship it accidentally.
60
+ if (value.required_selections.length > 0) {
61
+ return true;
62
+ }
63
+ return (Array.isArray(value.selected_options) &&
64
+ value.selected_options.length > 0 &&
65
+ value.selected_options.every(isSelectedOption));
66
+ }
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "2.2.0-beta.3",
2
+ "version": "2.2.0-beta.30",
3
3
  "name": "@apifuse/provider-sdk",
4
4
  "private": false,
5
5
  "type": "module",
@@ -61,6 +61,36 @@
61
61
  "import": "./dist/server/index.js",
62
62
  "default": "./dist/server/index.js"
63
63
  },
64
+ "./runtime/browser": {
65
+ "types": "./dist/runtime/browser.d.ts",
66
+ "import": "./dist/runtime/browser.js",
67
+ "default": "./dist/runtime/browser.js"
68
+ },
69
+ "./runtime/native-network": {
70
+ "types": "./dist/runtime/native-network.d.ts",
71
+ "import": "./dist/runtime/native-network.js",
72
+ "default": "./dist/runtime/native-network.js"
73
+ },
74
+ "./runtime/prevalidate": {
75
+ "types": "./dist/runtime/prevalidate.d.ts",
76
+ "import": "./dist/runtime/prevalidate.js",
77
+ "default": "./dist/runtime/prevalidate.js"
78
+ },
79
+ "./runtime/resolver": {
80
+ "types": "./dist/runtime/resolver-public.d.ts",
81
+ "import": "./dist/runtime/resolver-public.js",
82
+ "default": "./dist/runtime/resolver-public.js"
83
+ },
84
+ "./runtime/stealth": {
85
+ "types": "./dist/runtime/stealth.d.ts",
86
+ "import": "./dist/runtime/stealth.js",
87
+ "default": "./dist/runtime/stealth.js"
88
+ },
89
+ "./stateful": {
90
+ "types": "./dist/stateful/index.d.ts",
91
+ "import": "./dist/stateful/index.js",
92
+ "default": "./dist/stateful/index.js"
93
+ },
64
94
  "./testing": {
65
95
  "types": "./dist/testing/index.d.ts",
66
96
  "import": "./dist/testing/index.js",
@@ -75,30 +105,32 @@
75
105
  "scripts": {
76
106
  "lint": "biome lint .",
77
107
  "lint:fix": "biome lint --write",
108
+ "lint:deprecated": "bun run scripts/lint-deprecated-usage.ts",
78
109
  "format": "biome format --write",
79
- "type-check": "tsgo --noEmit",
110
+ "type-check": "tsc --noEmit",
80
111
  "test": "bun test",
81
- "check": "bun run lint && bun run type-check && bun run build",
112
+ "check": "bun run lint && bun run type-check && bun run lint:deprecated && bun run build",
82
113
  "pack:check": "bun run build && bun bin/apifuse-pack-check.ts",
83
114
  "pack:smoke": "bun run build && bun bin/apifuse-pack-smoke.ts",
115
+ "pack:types": "bun run build && bun bin/apifuse-pack-types.ts",
84
116
  "release:guard": "bun scripts/guard-release-pr.ts",
85
117
  "format:check": "biome format .",
86
- "build": "tsgo -p tsconfig.build.json && rm -rf dist/cli/templates && cp -R src/cli/templates dist/cli/templates && rm -rf dist/auth-turn/fixtures && cp -R src/auth-turn/fixtures dist/auth-turn/fixtures && cp src/auth-turn/auth-turn.v1.schema.json dist/auth-turn/auth-turn.v1.schema.json"
118
+ "build": "tsc -p tsconfig.build.json && rm -rf dist/cli/templates && cp -R src/cli/templates dist/cli/templates && rm -rf dist/auth-turn/fixtures && cp -R src/auth-turn/fixtures dist/auth-turn/fixtures && cp src/auth-turn/auth-turn.v1.schema.json dist/auth-turn/auth-turn.v1.schema.json"
87
119
  },
88
120
  "devDependencies": {
121
+ "@arethetypeswrong/cli": "^0.18.5",
89
122
  "@biomejs/biome": "^2.5.0",
90
123
  "@types/bun": "latest",
91
124
  "@types/node": "^25.9.3",
92
- "@typescript/native-preview": "7.0.0-dev.20260419.1"
125
+ "ajv": "^8.17",
126
+ "typescript": "6.0.3"
93
127
  },
94
128
  "dependencies": {
95
129
  "@clack/prompts": "^1.5.1",
96
130
  "@rgrove/parse-xml": "4.2.2",
97
131
  "@types/ms": "^2.1.0",
98
132
  "acorn": "^8.17.0",
99
- "ajv": "^8.17",
100
133
  "hono": "^4.12.25",
101
- "impit": "0.14.1",
102
134
  "ioredis": "^5.11.1",
103
135
  "ms": "^2.1.3",
104
136
  "playwright": "^1.55.1",
@@ -106,6 +138,9 @@
106
138
  "puppeteer-extra-plugin-stealth": "^2.11.2",
107
139
  "re2-wasm": "^1.0",
108
140
  "safe-regex": "^2.1",
141
+ "socks": "^2.8.9",
142
+ "tough-cookie": "^6.0.2",
143
+ "wreq-js": "3.0.0",
109
144
  "zod": "^4.4.3"
110
145
  },
111
146
  "repository": {
@@ -1,4 +1,4 @@
1
- import type { AuthTurn } from "../types";
1
+ import type { AuthTurn } from "../types.js";
2
2
 
3
3
  export type { AuthTurn };
4
4
 
@@ -24,7 +24,7 @@ export const AUTH_TURN_SCHEMA_ARTIFACT_PATH = "dist/auth-turn/auth-turn.v1.schem
24
24
  *
25
25
  * This is the exact codification of the runtime validation the SDK applies to
26
26
  * ceremony outputs (see `validateCeremonyOutput` in `src/ceremonies`), which
27
- * compiles this same document. `kind` is an OPEN string on the wire: the known
27
+ * evaluates this same document. `kind` is an OPEN string on the wire: the known
28
28
  * kinds in {@link TURN_KINDS} are tooling metadata, never a wire constraint.
29
29
  *
30
30
  * The committed artifact at `src/auth-turn/auth-turn.v1.schema.json` (shipped
package/src/auth.ts CHANGED
@@ -1,4 +1,9 @@
1
- import { AuthError, ProviderError } from "./errors";
1
+ import { AuthError, ProviderError } from "./errors.js";
2
+ import {
3
+ declarationInvalidError,
4
+ DECLARATION_RULE_IDS,
5
+ type DeclarationViolation,
6
+ } from "./declaration-validation.js";
2
7
  import type {
3
8
  AuthAbortData,
4
9
  AuthConfig,
@@ -10,7 +15,7 @@ import type {
10
15
  CredentialDeclaration,
11
16
  FlowContext,
12
17
  ProviderLocaleKeyInput,
13
- } from "./types";
18
+ } from "./types.js";
14
19
 
15
20
  const CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY = "__credentialsAuthChallenge";
16
21
  const DEFAULT_COMPLETE_TURN_ID = "auth.complete";
@@ -33,11 +38,7 @@ function isSensitiveAuthDataKey(key: string): boolean {
33
38
  return SENSITIVE_ABORT_DATA_KEY_PATTERN.test(normalizedAuthDataKey(key));
34
39
  }
35
40
 
36
- export type CredentialsAuthFieldType =
37
- | "string"
38
- | "email"
39
- | "password"
40
- | "otp";
41
+ export type CredentialsAuthFieldType = "string" | "email" | "password" | "otp";
41
42
 
42
43
  export interface CredentialsAuthField {
43
44
  type?: CredentialsAuthFieldType;
@@ -138,10 +139,9 @@ function abortData(options: {
138
139
  };
139
140
  }
140
141
 
141
- export function createAuthFlowHelpers(options: {
142
- readonly signal?: AbortSignal;
143
- readonly deadline?: string;
144
- } = {}): AuthFlowTerminalContext {
142
+ export function createAuthFlowHelpers(
143
+ options: { readonly signal?: AbortSignal; readonly deadline?: string } = {},
144
+ ): AuthFlowTerminalContext {
145
145
  return {
146
146
  ...(options.signal ? { signal: options.signal } : {}),
147
147
  ...(options.deadline ? { deadline: options.deadline } : {}),
@@ -156,16 +156,7 @@ export function createAuthFlowHelpers(options: {
156
156
  },
157
157
  };
158
158
  },
159
- abort({
160
- code,
161
- message,
162
- retry,
163
- actionHint,
164
- fieldErrors,
165
- data,
166
- turnId,
167
- expiresAt,
168
- }) {
159
+ abort({ code, message, retry, actionHint, fieldErrors, data, turnId, expiresAt }) {
169
160
  return {
170
161
  kind: "abort",
171
162
  ...authTurnBase({ turnId, defaultTurnId: DEFAULT_ABORT_TURN_ID, expiresAt }),
@@ -190,8 +181,7 @@ export function createAuthFlowHelpers(options: {
190
181
  ...(options.hintKey ? { hintKey: options.hintKey } : {}),
191
182
  ...(options.timing ? { timing: options.timing } : {}),
192
183
  ...(options.data ? { data: options.data } : {}),
193
- expectedInput:
194
- options.expectedInput ?? expectedInputFromFields(options.fields ?? {}),
184
+ expectedInput: options.expectedInput ?? expectedInputFromFields(options.fields ?? {}),
195
185
  };
196
186
  },
197
187
  nextPoll(options = {}) {
@@ -223,9 +213,7 @@ export class AuthAbortError extends AuthError {
223
213
  }
224
214
  }
225
215
 
226
- export interface CredentialsAuthCompleteResult<
227
- TCredentialKeys extends readonly string[],
228
- > {
216
+ export interface CredentialsAuthCompleteResult<TCredentialKeys extends readonly string[]> {
229
217
  credential: CredentialsAuthCredential<TCredentialKeys>;
230
218
  /** Additional non-credential auth-flow data to return alongside credential. */
231
219
  data?: Record<string, unknown>;
@@ -247,9 +235,7 @@ export interface CredentialsAuthChallengeRequest<TChallengeId extends string = s
247
235
  export type CredentialsAuthLoginResult<
248
236
  TCredentialKeys extends readonly string[],
249
237
  TChallengeId extends string = string,
250
- > =
251
- | CredentialsAuthCompleteResult<TCredentialKeys>
252
- | CredentialsAuthChallengeRequest<TChallengeId>;
238
+ > = CredentialsAuthCompleteResult<TCredentialKeys> | CredentialsAuthChallengeRequest<TChallengeId>;
253
239
 
254
240
  export interface CredentialsAuthChallengeDefinition<
255
241
  TFields extends CredentialsAuthFields,
@@ -310,6 +296,25 @@ export interface DefineCredentialsAuthOptions<
310
296
  ):
311
297
  | CredentialsAuthLoginResult<TCredentialKeys, keyof TChallenges & string>
312
298
  | Promise<CredentialsAuthLoginResult<TCredentialKeys, keyof TChallenges & string>>;
299
+ /**
300
+ * Optional re-mint of an expired session from the stored credential, wired
301
+ * to `auth.flow.refresh`.
302
+ *
303
+ * Credential-auth upstreams routinely invalidate a session well before the
304
+ * `expiresAt` the provider advertised, which leaves every operation failing
305
+ * with a reauth error until a human repeats the whole interactive login.
306
+ * Implement this to re-establish the session from what is already stored on
307
+ * the connection; the result is resolved exactly like `login`, so it may
308
+ * also raise a challenge when the upstream demands one. Omit it when the
309
+ * upstream has no non-interactive path and re-authentication genuinely
310
+ * requires the user.
311
+ */
312
+ refresh?(
313
+ ctx: FlowContext,
314
+ input: Partial<CredentialsAuthInput<TFields>>,
315
+ ):
316
+ | CredentialsAuthLoginResult<TCredentialKeys, keyof TChallenges & string>
317
+ | Promise<CredentialsAuthLoginResult<TCredentialKeys, keyof TChallenges & string>>;
313
318
  }
314
319
 
315
320
  export interface DefinedCredentialsAuth {
@@ -351,12 +356,8 @@ function expectedInputFromFields(fields: CredentialsAuthFields): Record<string,
351
356
  ...(field.type === "password" ? { format: "password" } : {}),
352
357
  ...(field.type === "otp" ? { format: "otp" } : {}),
353
358
  ...(field.labelKey ? { nameKey: field.labelKey } : {}),
354
- ...(field.descriptionKey
355
- ? { descriptionKey: field.descriptionKey }
356
- : {}),
357
- ...(field.placeholderKey
358
- ? { placeholderKey: field.placeholderKey }
359
- : {}),
359
+ ...(field.descriptionKey ? { descriptionKey: field.descriptionKey } : {}),
360
+ ...(field.placeholderKey ? { placeholderKey: field.placeholderKey } : {}),
360
361
  ...(field.sensitive || field.type === "password" || field.type === "otp"
361
362
  ? { sensitive: true }
362
363
  : {}),
@@ -394,6 +395,27 @@ function normalizeInput<TFields extends CredentialsAuthFields>(
394
395
  return result as CredentialsAuthInput<TFields>;
395
396
  }
396
397
 
398
+ /**
399
+ * Refresh variant of {@link normalizeInput}. `login` coerces every declared
400
+ * field to a string because the interactive turn has already enforced that they
401
+ * are present; refresh runs with no user present, so an absent field is omitted
402
+ * rather than turned into an empty string. That keeps "the user did not supply
403
+ * this" distinguishable from "the user supplied an empty value".
404
+ */
405
+ function normalizePartialInput<TFields extends CredentialsAuthFields>(
406
+ fields: TFields,
407
+ input: Record<string, unknown> | undefined,
408
+ ): Partial<CredentialsAuthInput<TFields>> {
409
+ const result: Record<string, string> = {};
410
+ for (const name of Object.keys(fields)) {
411
+ const value = input?.[name];
412
+ if (typeof value === "string") {
413
+ result[name] = value;
414
+ }
415
+ }
416
+ return result as Partial<CredentialsAuthInput<TFields>>;
417
+ }
418
+
397
419
  function assertCredentialKeys<TCredentialKeys extends readonly string[]>(
398
420
  credentialKeys: TCredentialKeys,
399
421
  credential: Record<string, unknown>,
@@ -437,10 +459,7 @@ function getPendingChallenge(ctx: FlowContext): PendingCredentialsAuthChallenge
437
459
  };
438
460
  }
439
461
 
440
- function setPendingChallenge(
441
- ctx: FlowContext,
442
- challenge: PendingCredentialsAuthChallenge,
443
- ): void {
462
+ function setPendingChallenge(ctx: FlowContext, challenge: PendingCredentialsAuthChallenge): void {
444
463
  ctx.context.set(CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY, challenge);
445
464
  }
446
465
 
@@ -473,9 +492,7 @@ function retryTurn(
473
492
  turnId: retryTurnId,
474
493
  expectedInput,
475
494
  data: {
476
- fieldErrors: Object.fromEntries(
477
- missing.map((name) => [name, "Required"]),
478
- ),
495
+ fieldErrors: Object.fromEntries(missing.map((name) => [name, "Required"])),
479
496
  fieldErrorKeys: Object.fromEntries(
480
497
  missing.map((name) => [name, "auth.credentials.fieldRequired"]),
481
498
  ),
@@ -499,18 +516,12 @@ function completeTurn<TCredentialKeys extends readonly string[]>(
499
516
  typeof result.credential !== "object" ||
500
517
  Array.isArray(result.credential)
501
518
  ) {
502
- throw new ProviderError(
503
- "Credentials auth login completed without a credential object",
504
- {
505
- code: "credentials_auth_missing_credential",
506
- fix: "Return { credential: { ... } } from defineCredentialsAuth handlers. Gateway persists only auth.flow complete data.credential into the connection.",
507
- },
508
- );
519
+ throw new ProviderError("Credentials auth login completed without a credential object", {
520
+ code: "credentials_auth_missing_credential",
521
+ fix: "Return { credential: { ... } } from defineCredentialsAuth handlers. Gateway persists only auth.flow complete data.credential into the connection.",
522
+ });
509
523
  }
510
- assertCredentialKeys(
511
- credentialKeys,
512
- result.credential as Record<string, unknown>,
513
- );
524
+ assertCredentialKeys(credentialKeys, result.credential as Record<string, unknown>);
514
525
  return {
515
526
  kind: "complete",
516
527
  turnId: result.turnId ?? defaultTurnId,
@@ -523,24 +534,18 @@ function completeTurn<TCredentialKeys extends readonly string[]>(
523
534
  }
524
535
 
525
536
  function challengeTurn(
526
- definition: CredentialsAuthChallengeDefinition<
527
- CredentialsAuthFields,
528
- readonly string[],
529
- string
530
- >,
537
+ definition: CredentialsAuthChallengeDefinition<CredentialsAuthFields, readonly string[], string>,
531
538
  request: CredentialsAuthChallengeRequest<string>,
532
539
  ): AuthTurn {
533
- const expectedInput = definition.fields
534
- ? expectedInputFromFields(definition.fields)
535
- : undefined;
540
+ const expectedInput = definition.fields ? expectedInputFromFields(definition.fields) : undefined;
536
541
  return {
537
542
  kind: expectedInput ? "form" : "pending",
538
543
  turnId: request.turnId ?? definition.turnId ?? `credentials.${request.challengeId}`,
539
544
  ...(request.expiresAt ? { expiresAt: request.expiresAt } : {}),
540
- ...(request.hintKey ?? definition.hintKey
545
+ ...((request.hintKey ?? definition.hintKey)
541
546
  ? { hintKey: request.hintKey ?? definition.hintKey }
542
547
  : {}),
543
- ...(request.timing ?? definition.timing
548
+ ...((request.timing ?? definition.timing)
544
549
  ? { timing: request.timing ?? definition.timing }
545
550
  : {}),
546
551
  ...(expectedInput ? { expectedInput } : {}),
@@ -630,13 +635,7 @@ async function continuePendingChallenge<TCredentialKeys extends readonly string[
630
635
  normalizeInput(definition.fields, rawInput),
631
636
  pending.state,
632
637
  );
633
- return await resolveAuthResult(
634
- ctx,
635
- credentialKeys,
636
- challenges,
637
- result,
638
- completeTurnId,
639
- );
638
+ return await resolveAuthResult(ctx, credentialKeys, challenges, result, completeTurnId);
640
639
  }
641
640
 
642
641
  async function pollPendingChallenge<TCredentialKeys extends readonly string[]>(
@@ -669,13 +668,7 @@ async function pollPendingChallenge<TCredentialKeys extends readonly string[]>(
669
668
  `credentials.${pending.challengeId}.pending`,
670
669
  };
671
670
  }
672
- return await resolveAuthResult(
673
- ctx,
674
- credentialKeys,
675
- challenges,
676
- result,
677
- completeTurnId,
678
- );
671
+ return await resolveAuthResult(ctx, credentialKeys, challenges, result, completeTurnId);
679
672
  }
680
673
 
681
674
  export function defineCredentialsAuth<
@@ -697,7 +690,7 @@ export function defineCredentialsAuth<
697
690
  ): DefinedCredentialsAuth {
698
691
  if (Object.keys(options.fields).length === 0) {
699
692
  throw new ProviderError("defineCredentialsAuth requires at least one field", {
700
- fix: "Pass fields such as { email: { type: \"email\" }, password: { type: \"password\" } }.",
693
+ fix: 'Pass fields such as { email: { type: "email" }, password: { type: "password" } }.',
701
694
  });
702
695
  }
703
696
 
@@ -708,6 +701,7 @@ export function defineCredentialsAuth<
708
701
  string,
709
702
  CredentialsAuthChallengeDefinition<CredentialsAuthFields, TCredentialKeys, string>
710
703
  >;
704
+ validateCredentialsAuthChallenges(challenges);
711
705
 
712
706
  return {
713
707
  auth: {
@@ -737,10 +731,7 @@ export function defineCredentialsAuth<
737
731
  return retryTurn(expectedInput, missing, retryTurnId);
738
732
  }
739
733
 
740
- const result = await options.login(
741
- ctx,
742
- normalizeInput(options.fields, rawInput),
743
- );
734
+ const result = await options.login(ctx, normalizeInput(options.fields, rawInput));
744
735
  return await resolveAuthResult(
745
736
  ctx,
746
737
  options.credentialKeys,
@@ -765,6 +756,44 @@ export function defineCredentialsAuth<
765
756
  completeTurnId,
766
757
  );
767
758
  },
759
+ // Only advertise refresh when the provider implements it: the
760
+ // protocol treats the hook's presence as "this connection can be
761
+ // re-established without the user", and exposing a stub that
762
+ // cannot actually re-mint would turn a recoverable expiry into a
763
+ // silent failure.
764
+ ...(options.refresh
765
+ ? {
766
+ refresh: async (ctx: FlowContext, rawInput?: Record<string, unknown>) => {
767
+ // A pending challenge belongs to the interactive flow that
768
+ // raised it; finish it there rather than restarting.
769
+ const pending = getPendingChallenge(ctx);
770
+ if (pending) {
771
+ return await continuePendingChallenge(
772
+ ctx,
773
+ options.credentialKeys,
774
+ challenges,
775
+ pending,
776
+ rawInput,
777
+ completeTurnId,
778
+ );
779
+ }
780
+
781
+ // Refresh runs without user input, so fields are optional
782
+ // here — unlike `continue`, missing ones are not a retry.
783
+ const result = await options.refresh!(
784
+ ctx,
785
+ normalizePartialInput(options.fields, rawInput),
786
+ );
787
+ return await resolveAuthResult(
788
+ ctx,
789
+ options.credentialKeys,
790
+ challenges,
791
+ result,
792
+ completeTurnId,
793
+ );
794
+ },
795
+ }
796
+ : {}),
768
797
  },
769
798
  },
770
799
  credential: {
@@ -776,11 +805,42 @@ export function defineCredentialsAuth<
776
805
  },
777
806
  context: {
778
807
  keys: Array.from(
779
- new Set([
780
- CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY,
781
- ...(options.contextKeys ?? []),
782
- ]),
808
+ new Set([CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY, ...(options.contextKeys ?? [])]),
783
809
  ),
784
810
  },
785
811
  };
786
812
  }
813
+
814
+ function validateCredentialsAuthChallenges(
815
+ challenges: Record<
816
+ string,
817
+ CredentialsAuthChallengeDefinition<CredentialsAuthFields, readonly string[], string>
818
+ >,
819
+ ): void {
820
+ const violations: DeclarationViolation[] = [];
821
+ for (const [challengeId, challenge] of Object.entries(challenges)) {
822
+ const fieldCount =
823
+ challenge.fields && typeof challenge.fields === "object"
824
+ ? Object.keys(challenge.fields).length
825
+ : 0;
826
+ const fieldsDeclared =
827
+ challenge.fields !== undefined && challenge.fields !== null;
828
+ const hasFields = fieldCount > 0;
829
+ const hasVerify = typeof challenge.verify === "function";
830
+ const hasPoll = typeof challenge.poll === "function";
831
+ const isInteractive = hasFields && hasVerify && !hasPoll;
832
+ const isPolling = !fieldsDeclared && !hasVerify && hasPoll;
833
+ const isHybrid = hasFields && hasVerify && hasPoll;
834
+ const emptyFieldsDeclared = fieldsDeclared && !hasFields;
835
+ if (!emptyFieldsDeclared && (isInteractive || isPolling || isHybrid)) continue;
836
+
837
+ const path = `challenges.${challengeId}`;
838
+ violations.push({
839
+ ruleId: DECLARATION_RULE_IDS.challengeShape,
840
+ path,
841
+ message: "challenge must be interactive, polling, or an explicit hybrid.",
842
+ fix: `Give ${path} non-empty fields plus verify, poll alone, or all three for a hybrid.`,
843
+ });
844
+ }
845
+ if (violations.length > 0) throw declarationInvalidError(violations);
846
+ }