@apifuse/provider-sdk 2.1.0-beta.9 → 2.2.0-beta.10

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 (263) hide show
  1. package/AUTHORING.md +240 -0
  2. package/CHANGELOG.md +93 -0
  3. package/README.md +26 -10
  4. package/SUBMISSION.md +11 -12
  5. package/bin/apifuse-check.ts +44 -59
  6. package/bin/apifuse-create.ts +1 -1
  7. package/bin/apifuse-dev.ts +27 -52
  8. package/bin/apifuse-pack-check.ts +36 -0
  9. package/bin/apifuse-pack-smoke.ts +22 -81
  10. package/bin/apifuse-pack-types.ts +266 -0
  11. package/bin/apifuse-perf.ts +45 -127
  12. package/bin/apifuse-record.ts +53 -70
  13. package/bin/apifuse-submit-check.ts +2177 -353
  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-semantics.ts +204 -0
  18. package/bin/submit-check-xml.ts +134 -0
  19. package/dist/auth-turn/auth-turn.v1.schema.json +89 -0
  20. package/dist/auth-turn/fixtures/invalid/empty-kind.json +4 -0
  21. package/dist/auth-turn/fixtures/invalid/expires-at-not-string.json +5 -0
  22. package/dist/auth-turn/fixtures/invalid/missing-kind.json +3 -0
  23. package/dist/auth-turn/fixtures/invalid/missing-turn-id.json +3 -0
  24. package/dist/auth-turn/fixtures/invalid/timing-unknown-field.json +7 -0
  25. package/dist/auth-turn/fixtures/invalid/turn-id-snake-case.json +4 -0
  26. package/dist/auth-turn/fixtures/invalid/unknown-top-level-field.json +5 -0
  27. package/dist/auth-turn/fixtures/valid/abort.json +8 -0
  28. package/dist/auth-turn/fixtures/valid/challenge.json +17 -0
  29. package/dist/auth-turn/fixtures/valid/complete.json +13 -0
  30. package/dist/auth-turn/fixtures/valid/form.json +14 -0
  31. package/dist/auth-turn/fixtures/valid/message.json +13 -0
  32. package/dist/auth-turn/fixtures/valid/multi_choice.json +15 -0
  33. package/dist/auth-turn/fixtures/valid/pending.json +5 -0
  34. package/dist/auth-turn/fixtures/valid/poll.json +9 -0
  35. package/dist/auth-turn/fixtures/valid/redirect.json +16 -0
  36. package/dist/auth-turn/fixtures/valid/retry.json +8 -0
  37. package/dist/auth-turn/fixtures/valid/unknown-kind.json +7 -0
  38. package/dist/auth-turn/index.d.ts +195 -0
  39. package/dist/auth-turn/index.js +133 -0
  40. package/dist/auth.d.ts +76 -0
  41. package/dist/auth.js +427 -0
  42. package/dist/ceremonies/index.d.ts +1 -1
  43. package/dist/ceremonies/index.js +14 -48
  44. package/dist/cli/commands.d.ts +1 -1
  45. package/dist/cli/commands.js +8 -0
  46. package/dist/cli/create.d.ts +3 -0
  47. package/dist/cli/create.js +47 -33
  48. package/dist/cli/prompt-assets.d.ts +80 -0
  49. package/dist/cli/prompt-assets.js +743 -0
  50. package/dist/cli/templates/provider/.agents/skills/fixtures-and-recording/SKILL.md.tpl +58 -0
  51. package/dist/cli/templates/provider/.agents/skills/health-checks-and-fail-closed/SKILL.md.tpl +65 -0
  52. package/dist/cli/templates/provider/.agents/skills/normalization-standards/SKILL.md.tpl +57 -0
  53. package/dist/cli/templates/provider/.agents/skills/pagination-and-counts/SKILL.md.tpl +52 -0
  54. package/dist/cli/templates/provider/.agents/skills/upstream-contract-verification/SKILL.md.tpl +45 -0
  55. package/dist/cli/templates/provider/.agents/skills/upstream-notes/README.md.tpl +13 -0
  56. package/dist/cli/templates/provider/.dockerignore.tpl +22 -0
  57. package/dist/cli/templates/provider/.gitignore.tpl +22 -0
  58. package/dist/cli/templates/provider/AGENTS.md.tpl +96 -0
  59. package/dist/cli/templates/provider/Dockerfile.tpl +7 -0
  60. package/dist/cli/templates/provider/README.md.tpl +163 -0
  61. package/dist/cli/templates/provider/dev.ts.tpl +5 -0
  62. package/dist/cli/templates/provider/domain/README.md.tpl +3 -0
  63. package/dist/cli/templates/provider/index.test.ts.tpl +13 -0
  64. package/dist/cli/templates/provider/index.ts.tpl +15 -0
  65. package/dist/cli/templates/provider/mappers/README.md.tpl +3 -0
  66. package/dist/cli/templates/provider/meta.ts.tpl +7 -0
  67. package/dist/cli/templates/provider/operations/index.ts.tpl +5 -0
  68. package/dist/cli/templates/provider/operations/ping.ts.tpl +24 -0
  69. package/dist/cli/templates/provider/schemas/ping.ts.tpl +24 -0
  70. package/dist/cli/templates/provider/start.ts.tpl +5 -0
  71. package/dist/cli/templates/provider/upstream/README.md.tpl +3 -0
  72. package/dist/config/loader.d.ts +149 -8
  73. package/dist/config/loader.js +378 -89
  74. package/dist/contract-serialization.d.ts +2 -2
  75. package/dist/contract-serialization.js +3 -6
  76. package/dist/contract-types.d.ts +2 -2
  77. package/dist/contract.d.ts +3 -3
  78. package/dist/contract.js +5 -6
  79. package/dist/define.d.ts +13 -1
  80. package/dist/define.js +245 -178
  81. package/dist/dev.d.ts +1 -1
  82. package/dist/dev.js +1 -1
  83. package/dist/errors.d.ts +4 -1
  84. package/dist/errors.js +48 -0
  85. package/dist/i18n/catalog.d.ts +2 -2
  86. package/dist/i18n/catalog.js +4 -10
  87. package/dist/i18n/index.d.ts +2 -2
  88. package/dist/i18n/index.js +2 -2
  89. package/dist/i18n/keys.d.ts +2 -2
  90. package/dist/index.d.ts +44 -41
  91. package/dist/index.js +39 -36
  92. package/dist/lint.d.ts +1 -0
  93. package/dist/lint.js +35 -15
  94. package/dist/provider.d.ts +11 -9
  95. package/dist/provider.js +9 -8
  96. package/dist/public-schema-field-lint.d.ts +1 -1
  97. package/dist/recipes/gov-api.js +1 -1
  98. package/dist/runtime/auth-flow.d.ts +1 -1
  99. package/dist/runtime/auth-flow.js +4 -2
  100. package/dist/runtime/browser.d.ts +1 -1
  101. package/dist/runtime/browser.js +214 -25
  102. package/dist/runtime/cache.d.ts +1 -1
  103. package/dist/runtime/cache.js +4 -8
  104. package/dist/runtime/choice.d.ts +1 -1
  105. package/dist/runtime/choice.js +31 -35
  106. package/dist/runtime/credential.d.ts +1 -1
  107. package/dist/runtime/credential.js +1 -1
  108. package/dist/runtime/env.d.ts +1 -1
  109. package/dist/runtime/executor.d.ts +1 -1
  110. package/dist/runtime/executor.js +15 -3
  111. package/dist/runtime/http.d.ts +2 -2
  112. package/dist/runtime/http.js +160 -344
  113. package/dist/runtime/insights.d.ts +1 -1
  114. package/dist/runtime/insights.js +6 -13
  115. package/dist/runtime/instrumentation.d.ts +2 -2
  116. package/dist/runtime/instrumentation.js +56 -19
  117. package/dist/runtime/keyring.js +1 -1
  118. package/dist/runtime/namespace.js +1 -1
  119. package/dist/runtime/otlp.d.ts +1 -1
  120. package/dist/runtime/perf.d.ts +1 -1
  121. package/dist/runtime/provider.d.ts +1 -1
  122. package/dist/runtime/provider.js +1 -2
  123. package/dist/runtime/proxy-errors.d.ts +1 -1
  124. package/dist/runtime/proxy-errors.js +9 -7
  125. package/dist/runtime/proxy-nodemaven.d.ts +35 -0
  126. package/dist/runtime/proxy-nodemaven.js +128 -0
  127. package/dist/runtime/proxy-retry-policy.d.ts +40 -0
  128. package/dist/runtime/proxy-retry-policy.js +326 -0
  129. package/dist/runtime/proxy-telemetry.d.ts +2 -1
  130. package/dist/runtime/proxy-telemetry.js +55 -52
  131. package/dist/runtime/redis.d.ts +1 -1
  132. package/dist/runtime/redis.js +2 -4
  133. package/dist/runtime/request-options.d.ts +1 -1
  134. package/dist/runtime/secrets.d.ts +27 -0
  135. package/dist/runtime/secrets.js +51 -0
  136. package/dist/runtime/state.d.ts +2 -2
  137. package/dist/runtime/state.js +15 -4
  138. package/dist/runtime/stealth.d.ts +7 -4
  139. package/dist/runtime/stealth.js +257 -215
  140. package/dist/runtime/stt.d.ts +1 -1
  141. package/dist/runtime/stt.js +11 -15
  142. package/dist/runtime/trace.d.ts +2 -2
  143. package/dist/runtime/trace.js +2 -4
  144. package/dist/runtime/waterfall.d.ts +1 -1
  145. package/dist/schema.d.ts +1 -1
  146. package/dist/schema.js +7 -15
  147. package/dist/serve.d.ts +1 -1
  148. package/dist/serve.js +1 -1
  149. package/dist/server/index.d.ts +7 -3
  150. package/dist/server/index.js +6 -2
  151. package/dist/server/self-test-input-tokens.d.ts +1 -0
  152. package/dist/server/self-test-input-tokens.js +37 -0
  153. package/dist/server/self-test-redaction.d.ts +20 -0
  154. package/dist/server/self-test-redaction.js +70 -0
  155. package/dist/server/self-test-token.d.ts +30 -0
  156. package/dist/server/self-test-token.js +50 -0
  157. package/dist/server/self-test.d.ts +199 -0
  158. package/dist/server/self-test.js +1113 -0
  159. package/dist/server/serve.d.ts +14 -3
  160. package/dist/server/serve.js +135 -64
  161. package/dist/server/types.d.ts +10 -9
  162. package/dist/server/types.js +3 -7
  163. package/dist/stealth/profiles.d.ts +1 -1
  164. package/dist/stealth/profiles.js +5 -14
  165. package/dist/stream.d.ts +1 -1
  166. package/dist/testing/index.d.ts +2 -2
  167. package/dist/testing/index.js +2 -2
  168. package/dist/testing/run.d.ts +1 -1
  169. package/dist/testing/run.js +12 -15
  170. package/dist/types.d.ts +237 -1
  171. package/dist/user-input.d.ts +30 -0
  172. package/dist/user-input.js +66 -0
  173. package/package.json +16 -5
  174. package/src/auth-turn/auth-turn.v1.schema.json +89 -0
  175. package/src/auth-turn/fixtures/invalid/empty-kind.json +4 -0
  176. package/src/auth-turn/fixtures/invalid/expires-at-not-string.json +5 -0
  177. package/src/auth-turn/fixtures/invalid/missing-kind.json +3 -0
  178. package/src/auth-turn/fixtures/invalid/missing-turn-id.json +3 -0
  179. package/src/auth-turn/fixtures/invalid/timing-unknown-field.json +7 -0
  180. package/src/auth-turn/fixtures/invalid/turn-id-snake-case.json +4 -0
  181. package/src/auth-turn/fixtures/invalid/unknown-top-level-field.json +5 -0
  182. package/src/auth-turn/fixtures/valid/abort.json +8 -0
  183. package/src/auth-turn/fixtures/valid/challenge.json +17 -0
  184. package/src/auth-turn/fixtures/valid/complete.json +13 -0
  185. package/src/auth-turn/fixtures/valid/form.json +14 -0
  186. package/src/auth-turn/fixtures/valid/message.json +13 -0
  187. package/src/auth-turn/fixtures/valid/multi_choice.json +15 -0
  188. package/src/auth-turn/fixtures/valid/pending.json +5 -0
  189. package/src/auth-turn/fixtures/valid/poll.json +9 -0
  190. package/src/auth-turn/fixtures/valid/redirect.json +16 -0
  191. package/src/auth-turn/fixtures/valid/retry.json +8 -0
  192. package/src/auth-turn/fixtures/valid/unknown-kind.json +7 -0
  193. package/src/auth-turn/index.ts +177 -0
  194. package/src/auth.ts +728 -0
  195. package/src/ceremonies/index.ts +33 -121
  196. package/src/cli/commands.ts +10 -0
  197. package/src/cli/create.ts +69 -99
  198. package/src/cli/prompt-assets.ts +865 -0
  199. package/src/cli/templates/provider/.agents/skills/fixtures-and-recording/SKILL.md.tpl +58 -0
  200. package/src/cli/templates/provider/.agents/skills/health-checks-and-fail-closed/SKILL.md.tpl +65 -0
  201. package/src/cli/templates/provider/.agents/skills/normalization-standards/SKILL.md.tpl +57 -0
  202. package/src/cli/templates/provider/.agents/skills/pagination-and-counts/SKILL.md.tpl +52 -0
  203. package/src/cli/templates/provider/.agents/skills/upstream-contract-verification/SKILL.md.tpl +45 -0
  204. package/src/cli/templates/provider/.agents/skills/upstream-notes/README.md.tpl +13 -0
  205. package/src/cli/templates/provider/AGENTS.md.tpl +96 -0
  206. package/src/cli/templates/provider/README.md.tpl +7 -4
  207. package/src/config/loader.ts +543 -208
  208. package/src/contract-serialization.ts +5 -11
  209. package/src/contract-types.ts +2 -2
  210. package/src/contract.ts +13 -28
  211. package/src/define.ts +397 -528
  212. package/src/dev.ts +4 -9
  213. package/src/errors.ts +58 -5
  214. package/src/i18n/catalog.ts +10 -32
  215. package/src/i18n/index.ts +2 -2
  216. package/src/i18n/keys.ts +5 -11
  217. package/src/index.ts +64 -41
  218. package/src/lint.ts +122 -159
  219. package/src/provider.ts +40 -9
  220. package/src/public-schema-field-lint.ts +7 -33
  221. package/src/recipes/gov-api.ts +2 -5
  222. package/src/runtime/auth-flow.ts +6 -6
  223. package/src/runtime/browser.ts +320 -151
  224. package/src/runtime/cache.ts +20 -67
  225. package/src/runtime/choice.ts +79 -132
  226. package/src/runtime/credential.ts +2 -2
  227. package/src/runtime/env.ts +1 -1
  228. package/src/runtime/executor.ts +23 -20
  229. package/src/runtime/http.ts +216 -539
  230. package/src/runtime/insights.ts +15 -53
  231. package/src/runtime/instrumentation.ts +78 -65
  232. package/src/runtime/keyring.ts +7 -19
  233. package/src/runtime/namespace.ts +2 -7
  234. package/src/runtime/otlp.ts +12 -23
  235. package/src/runtime/perf.ts +1 -1
  236. package/src/runtime/provider.ts +4 -9
  237. package/src/runtime/proxy-errors.ts +29 -42
  238. package/src/runtime/proxy-nodemaven.ts +178 -0
  239. package/src/runtime/proxy-retry-policy.ts +469 -0
  240. package/src/runtime/proxy-telemetry.ts +79 -77
  241. package/src/runtime/redis.ts +4 -12
  242. package/src/runtime/request-options.ts +4 -13
  243. package/src/runtime/secrets.ts +64 -0
  244. package/src/runtime/state.ts +41 -110
  245. package/src/runtime/stealth.ts +331 -369
  246. package/src/runtime/stt.ts +38 -94
  247. package/src/runtime/trace.ts +14 -44
  248. package/src/runtime/waterfall.ts +5 -18
  249. package/src/schema.ts +23 -84
  250. package/src/serve.ts +1 -1
  251. package/src/server/index.ts +44 -3
  252. package/src/server/self-test-input-tokens.ts +46 -0
  253. package/src/server/self-test-redaction.ts +97 -0
  254. package/src/server/self-test-token.ts +70 -0
  255. package/src/server/self-test.ts +1450 -0
  256. package/src/server/serve.ts +206 -216
  257. package/src/server/types.ts +7 -19
  258. package/src/stealth/profiles.ts +10 -26
  259. package/src/stream.ts +8 -19
  260. package/src/testing/index.ts +2 -2
  261. package/src/testing/run.ts +24 -64
  262. package/src/types.ts +274 -1
  263. package/src/user-input.ts +118 -0
@@ -0,0 +1,117 @@
1
+ #!/usr/bin/env bun
2
+
3
+ import {
4
+ formatPromptAssetIssues,
5
+ installedSdkVersion,
6
+ syncPromptAssets,
7
+ verifyPromptAssets,
8
+ } from "../src/cli/prompt-assets.js";
9
+ import { resolveProviderRoot } from "./apifuse-check.js";
10
+
11
+ const HELP_TEXT = `Usage: apifuse sync-assets [path] [--check]
12
+ Example: apifuse sync-assets .
13
+ Default: apifuse sync-assets .
14
+
15
+ Regenerates the SDK-managed agent prompt assets for the installed SDK version:
16
+ AGENTS.md, .agents/skills/**, the CLAUDE.md/.claude/.codex symlinks, and the
17
+ .apifuse/prompt-assets.json manifest. Legacy top-level skills/ layouts are
18
+ migrated. Idempotent.
19
+
20
+ Options:
21
+ --check Verify only; exit 1 with a diff list when assets are stale/missing/modified
22
+ --help, -h Show this help`;
23
+
24
+ export async function main() {
25
+ const args = normalizeArgs(process.argv.slice(2));
26
+
27
+ if (args.includes("--help") || args.includes("-h")) {
28
+ console.log(HELP_TEXT);
29
+ return;
30
+ }
31
+
32
+ let checkOnly = false;
33
+ let inputPath: string | undefined;
34
+ for (const arg of args) {
35
+ if (arg === "--check") {
36
+ checkOnly = true;
37
+ continue;
38
+ }
39
+ if (arg.startsWith("-")) {
40
+ throw new Error(`Unknown option: ${arg}`);
41
+ }
42
+ if (inputPath !== undefined) {
43
+ throw new Error(`Unexpected argument: ${arg}`);
44
+ }
45
+ inputPath = arg;
46
+ }
47
+
48
+ const providerRoot = resolveProviderRoot(inputPath ?? ".");
49
+
50
+ if (checkOnly) {
51
+ const verification = verifyPromptAssets(providerRoot);
52
+ if (verification.ok) {
53
+ console.log(
54
+ `Prompt assets are in sync with the installed SDK (${installedSdkVersion()}): ${providerRoot}`,
55
+ );
56
+ return;
57
+ }
58
+ console.error(`Prompt assets are out of sync in ${providerRoot}:`);
59
+ for (const issue of formatPromptAssetIssues(verification)) {
60
+ console.error(` - ${issue}`);
61
+ }
62
+ console.error("\nRun `bun run sync-assets` (or `bunx apifuse sync-assets .`) to regenerate.");
63
+ process.exit(1);
64
+ }
65
+
66
+ const result = syncPromptAssets(providerRoot);
67
+
68
+ // Honesty gate: writes alone never imply success. sync-assets intentionally
69
+ // PRESERVES (does not delete) unauthorized skills and symlinks under
70
+ // .agents/skills, so it can return changed:false while verify still fails.
71
+ // Re-verify AFTER writing and let the true post-sync state drive the exit
72
+ // code — never claim success while the freshness gate would reject the tree.
73
+ const verification = verifyPromptAssets(providerRoot);
74
+
75
+ if (result.changed) {
76
+ for (const removed of result.removed) {
77
+ console.log(`removed ${removed}`);
78
+ }
79
+ for (const wrote of result.wroteFiles) {
80
+ console.log(`wrote ${wrote}`);
81
+ }
82
+ for (const link of result.createdSymlinks) {
83
+ console.log(`symlink ${link}`);
84
+ }
85
+ console.log(`manifest ${result.manifestPath} (sdkVersion ${installedSdkVersion()})`);
86
+ }
87
+
88
+ if (!verification.ok) {
89
+ console.error(`\nPrompt assets are still out of sync in ${providerRoot}:`);
90
+ for (const issue of formatPromptAssetIssues(verification)) {
91
+ console.error(` - ${issue}`);
92
+ }
93
+ console.error(
94
+ "\nsync-assets never deletes unrecognized content: resolve these by hand — remove any unauthorized skill directory or symlink under .agents/skills/, migrate a real .claude/.codex directory into .agents/ — then re-run `apifuse sync-assets .`.",
95
+ );
96
+ process.exit(1);
97
+ }
98
+
99
+ if (!result.changed) {
100
+ console.log(
101
+ `Prompt assets already in sync with the installed SDK (${installedSdkVersion()}): ${providerRoot}`,
102
+ );
103
+ return;
104
+ }
105
+ console.log(`\nPrompt assets synced: ${providerRoot}`);
106
+ }
107
+
108
+ function normalizeArgs(argv: string[]): string[] {
109
+ return argv[0] === "sync-assets" ? argv.slice(1) : argv;
110
+ }
111
+
112
+ if (import.meta.main) {
113
+ await main().catch((error: unknown) => {
114
+ console.error(error instanceof Error ? error.message : String(error));
115
+ process.exit(1);
116
+ });
117
+ }
package/bin/apifuse.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env bun
2
2
 
3
3
  import packageJson from "../package.json";
4
- import { COMMAND_MANIFEST, COMMAND_ORDER } from "../src/cli/commands";
4
+ import { COMMAND_MANIFEST, COMMAND_ORDER } from "../src/cli/commands.js";
5
5
 
6
6
  const command = process.argv[2];
7
7
 
@@ -0,0 +1,50 @@
1
+ const MIN_RECORDED_DELIMITED_TEXT_LENGTH = 200;
2
+ const MIN_RECORDED_DELIMITED_TEXT_LINES = 3;
3
+ const MAX_SAMPLED_DELIMITED_TEXT_LINES = 10;
4
+ const DELIMITER_CANDIDATES = [",", "\t", ";"] as const;
5
+
6
+ // Recognizes a recorded operation value that is a substantive tabular text
7
+ // payload. The length floor and repeated, quote-aware field structure keep
8
+ // short strings and prose from being treated as fixture provenance.
9
+ export function hasSubstantiveDelimitedTextStructure(value: string): boolean {
10
+ if (value.length < MIN_RECORDED_DELIMITED_TEXT_LENGTH) {
11
+ return false;
12
+ }
13
+
14
+ const lines = value
15
+ .replace(/^\uFEFF/, "")
16
+ .split(/\r\n?|\n/)
17
+ .filter((line) => line.trim().length > 0);
18
+ if (lines.length < MIN_RECORDED_DELIMITED_TEXT_LINES) {
19
+ return false;
20
+ }
21
+
22
+ const sampledLines = lines.slice(0, MAX_SAMPLED_DELIMITED_TEXT_LINES);
23
+ return DELIMITER_CANDIDATES.some((delimiter) => {
24
+ const fieldCounts = sampledLines.map((line) => countDelimitedFields(line, delimiter));
25
+ const expectedFieldCount = fieldCounts[0];
26
+ return (
27
+ expectedFieldCount !== undefined &&
28
+ expectedFieldCount >= 2 &&
29
+ fieldCounts.every((fieldCount) => fieldCount === expectedFieldCount)
30
+ );
31
+ });
32
+ }
33
+
34
+ function countDelimitedFields(line: string, delimiter: string): number | undefined {
35
+ let fieldCount = 1;
36
+ let insideQuotes = false;
37
+ for (let index = 0; index < line.length; index += 1) {
38
+ const character = line[index];
39
+ if (character === '"') {
40
+ if (insideQuotes && line[index + 1] === '"') {
41
+ index += 1;
42
+ } else {
43
+ insideQuotes = !insideQuotes;
44
+ }
45
+ } else if (!insideQuotes && character === delimiter) {
46
+ fieldCount += 1;
47
+ }
48
+ }
49
+ return insideQuotes ? undefined : fieldCount;
50
+ }
@@ -0,0 +1,204 @@
1
+ import type { XmlElement } from "@rgrove/parse-xml";
2
+
3
+ const FAILURE_TEXT_PATTERN =
4
+ /\b(?:access denied|denied|error|exception|failed|failure|fault|forbidden|invalid|maintenance|not authorized|temporarily unavailable|unauthorized|unavailable)\b/i;
5
+ const KOREAN_FAILURE_TEXT_PATTERN =
6
+ /(?:오류|에러|실패|장애|점검|서비스\s*(?:중단|불가)|(?:일시적(?:으로)?\s*)?(?:이용|사용)\s*(?:이|가)?\s*(?:불가|어렵|할\s*수\s*없))/u;
7
+ const SUCCESS_CODE_PATTERN = /^(?:0+|2\d\d|2xx|ok|success|successful|normalservice)$/;
8
+ const SUCCESS_VALUE_PATTERN = /^(?:1|true|y|yes|ok|success|successful)$/;
9
+ const SUCCESS_TEXT_PATTERN = /^(?:normalserviceresponse|successfulresponse)$/;
10
+ const LOCALIZED_SUCCESS_TEXT_PATTERN =
11
+ /^(?:成功|正常|処理完了|正常終了|処理が完了しました|성공|정상|처리완료|처리가완료되었습니다|处理完成|處理完成|操作成功)$/u;
12
+ const CODE_SHAPED_VALUE_PATTERN = /^(?:\d+|[1-5]xx)$/;
13
+ const CODE_CONTROL_FIELDS: ReadonlySet<string> = new Set([
14
+ "httpstatus",
15
+ "resultcode",
16
+ "returnreasoncode",
17
+ "statuscode",
18
+ ]);
19
+ const TEXT_CONTROL_FIELDS: ReadonlySet<string> = new Set([
20
+ "message",
21
+ "msg",
22
+ "reason",
23
+ "resultmessage",
24
+ "resultmsg",
25
+ "state",
26
+ "status",
27
+ "statustext",
28
+ ]);
29
+ const SUCCESS_CONTROL_FIELDS: ReadonlySet<string> = new Set([
30
+ "issuccess",
31
+ "ok",
32
+ "success",
33
+ "successful",
34
+ ]);
35
+ const ERROR_CODE_FIELD_PATTERN = /^(?:(?:error|exception|fault)(?:code|status)s?|errcode)$/;
36
+ const ERROR_TEXT_FIELD_PATTERN =
37
+ /^(?:(?:error|exception|fault)(?:description|detail|details|info|message|reason|string|type)?s?|errmsg|returnauthmsg)$/;
38
+ const STRONG_CONTROL_CONTEXT_NAMES: ReadonlySet<string> = new Set([
39
+ "cmmmsgheader",
40
+ "control",
41
+ "error",
42
+ "exception",
43
+ "fault",
44
+ "header",
45
+ "meta",
46
+ "result",
47
+ "status",
48
+ ]);
49
+ const ORDINARY_ENVELOPE_NAMES: ReadonlySet<string> = new Set(["body", "envelope", "response"]);
50
+ const ERROR_ROOT_NAMES: ReadonlySet<string> = new Set([
51
+ "error",
52
+ "errorresponse",
53
+ "exception",
54
+ "exceptionresponse",
55
+ "fault",
56
+ "faultresponse",
57
+ ]);
58
+ const DOMAIN_BOUNDARY_NAMES: ReadonlySet<string> = new Set([
59
+ "entry",
60
+ "item",
61
+ "measurement",
62
+ "record",
63
+ "row",
64
+ ]);
65
+
66
+ export type XmlSemanticBranch = "control" | "domain" | "envelope" | "error" | "neutral";
67
+
68
+ // A control failure is only meaningful in a control/error/envelope context.
69
+ // Inside a domain boundary (item/record/row/…) the same field names are ordinary
70
+ // data — e.g. `faultCode` describing a charger's fault is not a service failure.
71
+ export function hasSemanticXmlFailure(element: XmlElement, branch: XmlSemanticBranch): boolean {
72
+ if (branch === "domain") return false;
73
+ const insideError = branch === "error";
74
+ const strongControl = insideError || branch === "control";
75
+ const insideControl = strongControl || branch === "envelope";
76
+ const fieldName = normalizedXmlName(element.name);
77
+ const value = element.text.trim();
78
+ if (
79
+ hasControlValueFailure({
80
+ fieldName,
81
+ value,
82
+ insideControl: insideControl || isSemanticControlField(fieldName),
83
+ strongControl,
84
+ })
85
+ ) {
86
+ return true;
87
+ }
88
+ return Object.entries(element.attributes).some(([name, attributeValue]) =>
89
+ hasControlValueFailure({
90
+ fieldName: normalizedXmlName(name),
91
+ value: attributeValue.trim(),
92
+ insideControl: true,
93
+ strongControl: true,
94
+ }),
95
+ );
96
+ }
97
+
98
+ export function rootXmlContext(name: string): XmlSemanticBranch {
99
+ if (DOMAIN_BOUNDARY_NAMES.has(name)) return "domain";
100
+ if (isXmlErrorWrapperName(name)) return "error";
101
+ if (isStrongControlContextName(name)) return "control";
102
+ return ORDINARY_ENVELOPE_NAMES.has(name) ? "envelope" : "neutral";
103
+ }
104
+
105
+ export function childXmlContext(parent: XmlSemanticBranch, name: string): XmlSemanticBranch {
106
+ if (parent === "control" || parent === "domain" || parent === "error") return parent;
107
+ if (isXmlErrorWrapperName(name)) return "error";
108
+ if (isStrongControlContextName(name)) return "control";
109
+ if (DOMAIN_BOUNDARY_NAMES.has(name)) return "domain";
110
+ return parent === "envelope" || ORDINARY_ENVELOPE_NAMES.has(name) ? "envelope" : "neutral";
111
+ }
112
+
113
+ export function isXmlErrorRootName(name: string): boolean {
114
+ return ERROR_ROOT_NAMES.has(name) || isXmlErrorWrapperName(name);
115
+ }
116
+
117
+ export function normalizedXmlName(name: string): string {
118
+ const compatibleName = name.normalize("NFKC");
119
+ const localName = compatibleName.slice(compatibleName.lastIndexOf(":") + 1);
120
+ return localName.replace(/[^\p{L}\p{N}]/gu, "").toLowerCase();
121
+ }
122
+
123
+ function hasControlValueFailure(input: {
124
+ readonly fieldName: string;
125
+ readonly value: string;
126
+ readonly insideControl: boolean;
127
+ readonly strongControl: boolean;
128
+ }): boolean {
129
+ const { fieldName, value, insideControl, strongControl } = input;
130
+ const normalizedValue = normalizedXmlValue(value);
131
+ if (ERROR_CODE_FIELD_PATTERN.test(fieldName)) {
132
+ return !SUCCESS_CODE_PATTERN.test(normalizedValue);
133
+ }
134
+ if (ERROR_TEXT_FIELD_PATTERN.test(fieldName)) {
135
+ return normalizedValue.length > 0 && !SUCCESS_CODE_PATTERN.test(normalizedValue);
136
+ }
137
+ if (
138
+ strongControl &&
139
+ TEXT_CONTROL_FIELDS.has(fieldName) &&
140
+ normalizedValue.length > 0 &&
141
+ !isExplicitSuccess(normalizedValue)
142
+ ) {
143
+ return true;
144
+ }
145
+ const isCodeControl =
146
+ CODE_CONTROL_FIELDS.has(fieldName) ||
147
+ (fieldName === "code" && insideControl) ||
148
+ (fieldName === "status" && insideControl && CODE_SHAPED_VALUE_PATTERN.test(normalizedValue));
149
+ if (isCodeControl && !SUCCESS_CODE_PATTERN.test(normalizedValue)) return true;
150
+ if (
151
+ insideControl &&
152
+ SUCCESS_CONTROL_FIELDS.has(fieldName) &&
153
+ !SUCCESS_VALUE_PATTERN.test(normalizedValue)
154
+ ) {
155
+ return true;
156
+ }
157
+ return insideControl && TEXT_CONTROL_FIELDS.has(fieldName) && hasFailureText(value);
158
+ }
159
+
160
+ function isSemanticControlField(fieldName: string): boolean {
161
+ return (
162
+ CODE_CONTROL_FIELDS.has(fieldName) ||
163
+ TEXT_CONTROL_FIELDS.has(fieldName) ||
164
+ SUCCESS_CONTROL_FIELDS.has(fieldName) ||
165
+ ERROR_CODE_FIELD_PATTERN.test(fieldName) ||
166
+ ERROR_TEXT_FIELD_PATTERN.test(fieldName) ||
167
+ fieldName === "code"
168
+ );
169
+ }
170
+
171
+ function isExplicitSuccess(value: string): boolean {
172
+ return (
173
+ SUCCESS_CODE_PATTERN.test(value) ||
174
+ SUCCESS_VALUE_PATTERN.test(value) ||
175
+ SUCCESS_TEXT_PATTERN.test(value) ||
176
+ LOCALIZED_SUCCESS_TEXT_PATTERN.test(value)
177
+ );
178
+ }
179
+
180
+ function isStrongControlContextName(name: string): boolean {
181
+ return STRONG_CONTROL_CONTEXT_NAMES.has(name) || name.endsWith("control");
182
+ }
183
+
184
+ function isXmlErrorWrapperName(name: string): boolean {
185
+ return /(?:error|exception|fault)(?:response)?$/.test(name);
186
+ }
187
+
188
+ function hasFailureText(value: string): boolean {
189
+ const normalized = value.normalize("NFKC");
190
+ return [normalized, normalized.replace(/\p{Cf}/gu, "")].some((candidate) => {
191
+ if (KOREAN_FAILURE_TEXT_PATTERN.test(candidate)) return true;
192
+ const tokenized = candidate
193
+ .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
194
+ .replace(/[^A-Za-z0-9]+/g, " ");
195
+ return FAILURE_TEXT_PATTERN.test(tokenized);
196
+ });
197
+ }
198
+
199
+ function normalizedXmlValue(value: string): string {
200
+ return value
201
+ .normalize("NFKC")
202
+ .replace(/[^\p{L}\p{N}]/gu, "")
203
+ .toLowerCase();
204
+ }
@@ -0,0 +1,134 @@
1
+ import {
2
+ parseXml,
3
+ XmlDocumentType,
4
+ XmlElement,
5
+ XmlError,
6
+ XmlProcessingInstruction,
7
+ } from "@rgrove/parse-xml";
8
+ import { Buffer } from "node:buffer";
9
+
10
+ import {
11
+ childXmlContext,
12
+ hasSemanticXmlFailure,
13
+ isXmlErrorRootName,
14
+ normalizedXmlName,
15
+ rootXmlContext,
16
+ type XmlSemanticBranch,
17
+ } from "./submit-check-xml-semantics.js";
18
+
19
+ const MIN_RECORDED_XML_LENGTH = 128;
20
+ // Recorded fixtures must remain reviewable; this pre-allocation cap also bounds the parser tree.
21
+ export const MAX_RECORDED_XML_BYTES = 4 * 1024 * 1024;
22
+ const MAX_RECORDED_XML_DEPTH = 64;
23
+ const MAX_RECORDED_XML_ELEMENTS = 50_000;
24
+ const XML_DOCTYPE_PATTERN = /<!DOCTYPE\b/i;
25
+ const REJECTED_RECORDED_XML_ROOT_NAMES: ReadonlySet<string> = new Set(["body", "html", "head"]);
26
+
27
+ // Recognizes a recorded operation value that is a substantive, well-formed XML
28
+ // success payload — the shape captured by `apifuse record` against upstreams
29
+ // that return XML (e.g. Korean public-data APIs). Fails closed on malformed XML,
30
+ // HTML, DTD/processing-instruction payloads, oversized/deep/wide trees, error
31
+ // roots, and failure/control-only envelopes. Uses a maintained parser rather
32
+ // than regex so entity/namespace/CDATA handling is correct.
33
+ export function hasSubstantiveXmlStructure(
34
+ value: string,
35
+ parser: typeof parseXml = parseXml,
36
+ ): boolean {
37
+ if (Buffer.byteLength(value, "utf8") > MAX_RECORDED_XML_BYTES) {
38
+ return false;
39
+ }
40
+ const xml = value.trim();
41
+ if (xml.length < MIN_RECORDED_XML_LENGTH || XML_DOCTYPE_PATTERN.test(xml)) {
42
+ return false;
43
+ }
44
+
45
+ let document: ReturnType<typeof parseXml>;
46
+ try {
47
+ document = parser(xml, { preserveDocumentType: true });
48
+ } catch (error) {
49
+ if (error instanceof XmlError || error instanceof RangeError) {
50
+ return false;
51
+ }
52
+ throw error;
53
+ }
54
+ if (
55
+ document.children.some(
56
+ (child) => child instanceof XmlDocumentType || child instanceof XmlProcessingInstruction,
57
+ )
58
+ ) {
59
+ return false;
60
+ }
61
+
62
+ const root = document.root;
63
+ if (root === null) {
64
+ return false;
65
+ }
66
+ const rootName = normalizedXmlName(root.name);
67
+ if (REJECTED_RECORDED_XML_ROOT_NAMES.has(rootName) || isXmlErrorRootName(rootName)) {
68
+ return false;
69
+ }
70
+
71
+ const pending: Array<{
72
+ readonly branch: XmlSemanticBranch;
73
+ readonly element: XmlElement;
74
+ readonly depth: number;
75
+ }> = [
76
+ {
77
+ element: root,
78
+ depth: 1,
79
+ branch: rootXmlContext(rootName),
80
+ },
81
+ ];
82
+ const leafNames = new Set<string>();
83
+ let leafTextLength = 0;
84
+ let elementCount = 0;
85
+ while (pending.length > 0) {
86
+ const current = pending.pop();
87
+ if (current === undefined) {
88
+ break;
89
+ }
90
+ elementCount += 1;
91
+ if (
92
+ elementCount > MAX_RECORDED_XML_ELEMENTS ||
93
+ current.depth > MAX_RECORDED_XML_DEPTH ||
94
+ hasSemanticXmlFailure(current.element, current.branch)
95
+ ) {
96
+ return false;
97
+ }
98
+
99
+ const childElements: XmlElement[] = [];
100
+ for (const child of current.element.children) {
101
+ if (child instanceof XmlProcessingInstruction) {
102
+ return false;
103
+ }
104
+ if (child instanceof XmlElement) {
105
+ childElements.push(child);
106
+ }
107
+ }
108
+ if (childElements.length === 0) {
109
+ const leafText = current.element.text.trim();
110
+ // Only substantive *domain* leaves count as evidence. Control/error
111
+ // leaves (resultCode, resultMsg, header status, …) are not payload data,
112
+ // so a control-only success envelope with no real records is rejected.
113
+ if (
114
+ leafText.length > 0 &&
115
+ current.depth >= 3 &&
116
+ current.branch !== "control" &&
117
+ current.branch !== "error"
118
+ ) {
119
+ leafNames.add(normalizedXmlName(current.element.name));
120
+ leafTextLength += leafText.length;
121
+ }
122
+ continue;
123
+ }
124
+ for (const child of childElements) {
125
+ const childName = normalizedXmlName(child.name);
126
+ pending.push({
127
+ element: child,
128
+ depth: current.depth + 1,
129
+ branch: childXmlContext(current.branch, childName),
130
+ });
131
+ }
132
+ }
133
+ return leafNames.size >= 2 && leafTextLength >= 16;
134
+ }
@@ -0,0 +1,89 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://apifuse.com/contracts/auth-turn/v1",
4
+ "title": "APIFuse AuthTurn envelope v1",
5
+ "description": "Protocol message exchanged during auth.flow ceremonies. kind is an open string; known kinds are tooling metadata, not a wire constraint.",
6
+ "type": "object",
7
+ "additionalProperties": false,
8
+ "required": ["kind", "turnId"],
9
+ "properties": {
10
+ "kind": {
11
+ "type": "string",
12
+ "minLength": 1,
13
+ "description": "Open turn kind. Known kinds are listed in the TURN_KINDS registry; unknown kinds remain valid on the wire."
14
+ },
15
+ "turnId": {
16
+ "type": "string",
17
+ "minLength": 1,
18
+ "description": "Provider-scoped identifier of this turn."
19
+ },
20
+ "expiresAt": {
21
+ "type": "string",
22
+ "minLength": 1,
23
+ "description": "Turn expiry timestamp as an ISO 8601 / RFC 3339 string."
24
+ },
25
+ "data": {
26
+ "type": "object",
27
+ "additionalProperties": true,
28
+ "description": "Kind-specific payload. Terminal kinds carry the payloads described in $defs."
29
+ },
30
+ "expectedInput": {
31
+ "type": "object",
32
+ "additionalProperties": true,
33
+ "description": "JSON Schema describing the input expected next."
34
+ },
35
+ "hint": {
36
+ "type": "string",
37
+ "description": "Deprecated but load-bearing human-readable hint materialized from provider locale catalogs."
38
+ },
39
+ "hintKey": {
40
+ "type": "string",
41
+ "description": "Provider locale catalog key for the turn hint."
42
+ },
43
+ "timing": {
44
+ "type": "object",
45
+ "additionalProperties": false,
46
+ "description": "Client pacing guidance for poll-style turns.",
47
+ "properties": {
48
+ "suggestedPollIntervalMs": {
49
+ "type": "number",
50
+ "minimum": 1
51
+ },
52
+ "maxWaitMs": {
53
+ "type": "number",
54
+ "minimum": 1
55
+ }
56
+ }
57
+ }
58
+ },
59
+ "$defs": {
60
+ "completeTurnData": {
61
+ "title": "Terminal payload for kind \"complete\"",
62
+ "description": "data payload of a complete turn. The gateway extracts data.credential for persistence; complete turns are never echoed to browsers.",
63
+ "type": "object",
64
+ "additionalProperties": true,
65
+ "required": ["credential"],
66
+ "properties": {
67
+ "credential": {
68
+ "type": "object",
69
+ "additionalProperties": true
70
+ },
71
+ "metadata": {
72
+ "type": "object",
73
+ "additionalProperties": true
74
+ }
75
+ }
76
+ },
77
+ "abortTurnData": {
78
+ "title": "Terminal payload for kind \"abort\"",
79
+ "description": "data payload of an abort turn. code, when present, is the machine-readable abort reason.",
80
+ "type": "object",
81
+ "additionalProperties": true,
82
+ "properties": {
83
+ "code": {
84
+ "type": "string"
85
+ }
86
+ }
87
+ }
88
+ }
89
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "kind": "",
3
+ "turnId": "fixture.invalid.empty-kind"
4
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "kind": "challenge",
3
+ "turnId": "fixture.invalid.expires-at-not-string",
4
+ "expiresAt": 1767225600000
5
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "turnId": "fixture.invalid.missing-kind"
3
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "kind": "form"
3
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "kind": "poll",
3
+ "turnId": "fixture.invalid.timing-unknown-field",
4
+ "timing": {
5
+ "recommendedIntervalMs": 5000
6
+ }
7
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "kind": "form",
3
+ "turn_id": "fixture.invalid.turn-id-snake-case"
4
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "kind": "form",
3
+ "turnId": "fixture.invalid.unknown-top-level-field",
4
+ "setCookie": "session=leaked-value"
5
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "kind": "abort",
3
+ "turnId": "fixture.abort",
4
+ "hint": "OAuth flow aborted.",
5
+ "data": {
6
+ "code": "flow_expired"
7
+ }
8
+ }
@@ -0,0 +1,17 @@
1
+ {
2
+ "kind": "challenge",
3
+ "turnId": "fixture.challenge",
4
+ "hint": "Complete the WebAuthn prompt in your browser.",
5
+ "expiresAt": "2026-01-01T00:00:00.000Z",
6
+ "data": {
7
+ "challenge": "fixture-challenge-not-real",
8
+ "rpId": "example.com"
9
+ },
10
+ "expectedInput": {
11
+ "type": "object",
12
+ "required": ["attestation"],
13
+ "properties": {
14
+ "attestation": { "type": "object" }
15
+ }
16
+ }
17
+ }
@@ -0,0 +1,13 @@
1
+ {
2
+ "kind": "complete",
3
+ "turnId": "fixture.complete",
4
+ "hint": "OAuth flow completed.",
5
+ "data": {
6
+ "credential": {
7
+ "accessToken": "fixture-fake-access-token-not-a-secret"
8
+ },
9
+ "metadata": {
10
+ "scope": "read"
11
+ }
12
+ }
13
+ }