assert-json-body 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +352 -0
- package/dist/assertion/diff-recordings-vs-spec.d.ts +3 -0
- package/dist/assertion/diff-recordings-vs-spec.d.ts.map +1 -0
- package/dist/assertion/diff-recordings-vs-spec.js +176 -0
- package/dist/assertion/diff-recordings-vs-spec.js.map +1 -0
- package/dist/assertion/index.d.ts +2 -0
- package/dist/assertion/index.d.ts.map +1 -0
- package/dist/assertion/index.js +2 -0
- package/dist/assertion/index.js.map +1 -0
- package/dist/assertion/recorder.d.ts +7 -0
- package/dist/assertion/recorder.d.ts.map +1 -0
- package/dist/assertion/recorder.js +81 -0
- package/dist/assertion/recorder.js.map +1 -0
- package/dist/assertion/summarize-recordings.d.ts +3 -0
- package/dist/assertion/summarize-recordings.d.ts.map +1 -0
- package/dist/assertion/summarize-recordings.js +121 -0
- package/dist/assertion/summarize-recordings.js.map +1 -0
- package/dist/assertion/validator.d.ts +2 -0
- package/dist/assertion/validator.d.ts.map +1 -0
- package/dist/assertion/validator.js +3 -0
- package/dist/assertion/validator.js.map +1 -0
- package/dist/base.d.ts +2 -0
- package/dist/base.d.ts.map +1 -0
- package/dist/base.js +3 -0
- package/dist/base.js.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +84 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/extractor/src/lib/child-expansion.d.ts +8 -0
- package/dist/extractor/src/lib/child-expansion.d.ts.map +1 -0
- package/dist/extractor/src/lib/child-expansion.js +72 -0
- package/dist/extractor/src/lib/child-expansion.js.map +1 -0
- package/dist/extractor/src/lib/git.d.ts +9 -0
- package/dist/extractor/src/lib/git.d.ts.map +1 -0
- package/dist/extractor/src/lib/git.js +22 -0
- package/dist/extractor/src/lib/git.js.map +1 -0
- package/dist/extractor/src/lib/schema-flatten.d.ts +10 -0
- package/dist/extractor/src/lib/schema-flatten.d.ts.map +1 -0
- package/dist/extractor/src/lib/schema-flatten.js +203 -0
- package/dist/extractor/src/lib/schema-flatten.js.map +1 -0
- package/dist/extractor/src/lib/type-utils.d.ts +5 -0
- package/dist/extractor/src/lib/type-utils.d.ts.map +1 -0
- package/dist/extractor/src/lib/type-utils.js +27 -0
- package/dist/extractor/src/lib/type-utils.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/assert.d.ts +27 -0
- package/dist/lib/assert.d.ts.map +1 -0
- package/dist/lib/assert.js +32 -0
- package/dist/lib/assert.js.map +1 -0
- package/dist/lib/child-expansion.d.ts +2 -0
- package/dist/lib/child-expansion.d.ts.map +1 -0
- package/dist/lib/child-expansion.js +2 -0
- package/dist/lib/child-expansion.js.map +1 -0
- package/dist/lib/config.d.ts +27 -0
- package/dist/lib/config.d.ts.map +1 -0
- package/dist/lib/config.js +139 -0
- package/dist/lib/config.js.map +1 -0
- package/dist/lib/extractor.d.ts +6 -0
- package/dist/lib/extractor.d.ts.map +1 -0
- package/dist/lib/extractor.js +164 -0
- package/dist/lib/extractor.js.map +1 -0
- package/dist/lib/git.d.ts +2 -0
- package/dist/lib/git.d.ts.map +1 -0
- package/dist/lib/git.js +2 -0
- package/dist/lib/git.js.map +1 -0
- package/dist/lib/recorder.d.ts +8 -0
- package/dist/lib/recorder.d.ts.map +1 -0
- package/dist/lib/recorder.js +68 -0
- package/dist/lib/recorder.js.map +1 -0
- package/dist/lib/responses.d.ts +13 -0
- package/dist/lib/responses.d.ts.map +1 -0
- package/dist/lib/responses.js +114 -0
- package/dist/lib/responses.js.map +1 -0
- package/dist/lib/schema-flatten.d.ts +2 -0
- package/dist/lib/schema-flatten.d.ts.map +1 -0
- package/dist/lib/schema-flatten.js +2 -0
- package/dist/lib/schema-flatten.js.map +1 -0
- package/dist/lib/tools/diff-recordings-vs-spec.d.ts +2 -0
- package/dist/lib/tools/diff-recordings-vs-spec.d.ts.map +1 -0
- package/dist/lib/tools/diff-recordings-vs-spec.js +2 -0
- package/dist/lib/tools/diff-recordings-vs-spec.js.map +1 -0
- package/dist/lib/tools/recorder.d.ts +2 -0
- package/dist/lib/tools/recorder.d.ts.map +1 -0
- package/dist/lib/tools/recorder.js +3 -0
- package/dist/lib/tools/recorder.js.map +1 -0
- package/dist/lib/tools/summarize-recordings.d.ts +2 -0
- package/dist/lib/tools/summarize-recordings.d.ts.map +1 -0
- package/dist/lib/tools/summarize-recordings.js +2 -0
- package/dist/lib/tools/summarize-recordings.js.map +1 -0
- package/dist/lib/type-utils.d.ts +2 -0
- package/dist/lib/type-utils.d.ts.map +1 -0
- package/dist/lib/type-utils.js +2 -0
- package/dist/lib/type-utils.js.map +1 -0
- package/dist/lib/validator.d.ts +33 -0
- package/dist/lib/validator.d.ts.map +1 -0
- package/dist/lib/validator.js +179 -0
- package/dist/lib/validator.js.map +1 -0
- package/dist/types/index.d.ts +88 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +3 -0
- package/dist/types/index.js.map +1 -0
- package/dist-cjs/assertion/diff-recordings-vs-spec.d.ts +3 -0
- package/dist-cjs/assertion/diff-recordings-vs-spec.d.ts.map +1 -0
- package/dist-cjs/assertion/diff-recordings-vs-spec.js +178 -0
- package/dist-cjs/assertion/diff-recordings-vs-spec.js.map +1 -0
- package/dist-cjs/assertion/index.d.ts +2 -0
- package/dist-cjs/assertion/index.d.ts.map +1 -0
- package/dist-cjs/assertion/index.js +3 -0
- package/dist-cjs/assertion/index.js.map +1 -0
- package/dist-cjs/assertion/recorder.d.ts +7 -0
- package/dist-cjs/assertion/recorder.d.ts.map +1 -0
- package/dist-cjs/assertion/recorder.js +84 -0
- package/dist-cjs/assertion/recorder.js.map +1 -0
- package/dist-cjs/assertion/summarize-recordings.d.ts +3 -0
- package/dist-cjs/assertion/summarize-recordings.d.ts.map +1 -0
- package/dist-cjs/assertion/summarize-recordings.js +123 -0
- package/dist-cjs/assertion/summarize-recordings.js.map +1 -0
- package/dist-cjs/assertion/validator.d.ts +2 -0
- package/dist-cjs/assertion/validator.d.ts.map +1 -0
- package/dist-cjs/assertion/validator.js +7 -0
- package/dist-cjs/assertion/validator.js.map +1 -0
- package/dist-cjs/base.d.ts +2 -0
- package/dist-cjs/base.d.ts.map +1 -0
- package/dist-cjs/base.js +7 -0
- package/dist-cjs/base.js.map +1 -0
- package/dist-cjs/cli/index.d.ts +3 -0
- package/dist-cjs/cli/index.d.ts.map +1 -0
- package/dist-cjs/cli/index.js +86 -0
- package/dist-cjs/cli/index.js.map +1 -0
- package/dist-cjs/extractor/src/lib/child-expansion.d.ts +8 -0
- package/dist-cjs/extractor/src/lib/child-expansion.d.ts.map +1 -0
- package/dist-cjs/extractor/src/lib/child-expansion.js +76 -0
- package/dist-cjs/extractor/src/lib/child-expansion.js.map +1 -0
- package/dist-cjs/extractor/src/lib/git.d.ts +9 -0
- package/dist-cjs/extractor/src/lib/git.d.ts.map +1 -0
- package/dist-cjs/extractor/src/lib/git.js +26 -0
- package/dist-cjs/extractor/src/lib/git.js.map +1 -0
- package/dist-cjs/extractor/src/lib/schema-flatten.d.ts +10 -0
- package/dist-cjs/extractor/src/lib/schema-flatten.d.ts.map +1 -0
- package/dist-cjs/extractor/src/lib/schema-flatten.js +211 -0
- package/dist-cjs/extractor/src/lib/schema-flatten.js.map +1 -0
- package/dist-cjs/extractor/src/lib/type-utils.d.ts +5 -0
- package/dist-cjs/extractor/src/lib/type-utils.d.ts.map +1 -0
- package/dist-cjs/extractor/src/lib/type-utils.js +32 -0
- package/dist-cjs/extractor/src/lib/type-utils.js.map +1 -0
- package/dist-cjs/index.d.ts +5 -0
- package/dist-cjs/index.d.ts.map +1 -0
- package/dist-cjs/index.js +26 -0
- package/dist-cjs/index.js.map +1 -0
- package/dist-cjs/lib/assert.d.ts +27 -0
- package/dist-cjs/lib/assert.d.ts.map +1 -0
- package/dist-cjs/lib/assert.js +35 -0
- package/dist-cjs/lib/assert.js.map +1 -0
- package/dist-cjs/lib/child-expansion.d.ts +2 -0
- package/dist-cjs/lib/child-expansion.d.ts.map +1 -0
- package/dist-cjs/lib/child-expansion.js +7 -0
- package/dist-cjs/lib/child-expansion.js.map +1 -0
- package/dist-cjs/lib/config.d.ts +27 -0
- package/dist-cjs/lib/config.d.ts.map +1 -0
- package/dist-cjs/lib/config.js +147 -0
- package/dist-cjs/lib/config.js.map +1 -0
- package/dist-cjs/lib/extractor.d.ts +6 -0
- package/dist-cjs/lib/extractor.d.ts.map +1 -0
- package/dist-cjs/lib/extractor.js +172 -0
- package/dist-cjs/lib/extractor.js.map +1 -0
- package/dist-cjs/lib/git.d.ts +2 -0
- package/dist-cjs/lib/git.d.ts.map +1 -0
- package/dist-cjs/lib/git.js +6 -0
- package/dist-cjs/lib/git.js.map +1 -0
- package/dist-cjs/lib/recorder.d.ts +8 -0
- package/dist-cjs/lib/recorder.d.ts.map +1 -0
- package/dist-cjs/lib/recorder.js +71 -0
- package/dist-cjs/lib/recorder.js.map +1 -0
- package/dist-cjs/lib/responses.d.ts +13 -0
- package/dist-cjs/lib/responses.d.ts.map +1 -0
- package/dist-cjs/lib/responses.js +117 -0
- package/dist-cjs/lib/responses.js.map +1 -0
- package/dist-cjs/lib/schema-flatten.d.ts +2 -0
- package/dist-cjs/lib/schema-flatten.d.ts.map +1 -0
- package/dist-cjs/lib/schema-flatten.js +11 -0
- package/dist-cjs/lib/schema-flatten.js.map +1 -0
- package/dist-cjs/lib/tools/diff-recordings-vs-spec.d.ts +2 -0
- package/dist-cjs/lib/tools/diff-recordings-vs-spec.d.ts.map +1 -0
- package/dist-cjs/lib/tools/diff-recordings-vs-spec.js +18 -0
- package/dist-cjs/lib/tools/diff-recordings-vs-spec.js.map +1 -0
- package/dist-cjs/lib/tools/recorder.d.ts +2 -0
- package/dist-cjs/lib/tools/recorder.d.ts.map +1 -0
- package/dist-cjs/lib/tools/recorder.js +19 -0
- package/dist-cjs/lib/tools/recorder.js.map +1 -0
- package/dist-cjs/lib/tools/summarize-recordings.d.ts +2 -0
- package/dist-cjs/lib/tools/summarize-recordings.d.ts.map +1 -0
- package/dist-cjs/lib/tools/summarize-recordings.js +18 -0
- package/dist-cjs/lib/tools/summarize-recordings.js.map +1 -0
- package/dist-cjs/lib/type-utils.d.ts +2 -0
- package/dist-cjs/lib/type-utils.d.ts.map +1 -0
- package/dist-cjs/lib/type-utils.js +8 -0
- package/dist-cjs/lib/type-utils.js.map +1 -0
- package/dist-cjs/lib/validator.d.ts +33 -0
- package/dist-cjs/lib/validator.d.ts.map +1 -0
- package/dist-cjs/lib/validator.js +182 -0
- package/dist-cjs/lib/validator.js.map +1 -0
- package/dist-cjs/package.json +1 -0
- package/dist-cjs/types/index.d.ts +88 -0
- package/dist-cjs/types/index.d.ts.map +1 -0
- package/dist-cjs/types/index.js +4 -0
- package/dist-cjs/types/index.js.map +1 -0
- package/package.json +125 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { RouteContext } from '../types/index.js';
|
|
2
|
+
interface ResolverOptions {
|
|
3
|
+
responsesFilePath?: string;
|
|
4
|
+
configPath?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface PickRouteOptions extends ResolverOptions {
|
|
7
|
+
method?: string;
|
|
8
|
+
status?: string;
|
|
9
|
+
}
|
|
10
|
+
export declare function pickRoute(path: string, method?: string, status?: string, _deprecated?: unknown): RouteContext;
|
|
11
|
+
export declare function pickRoute(path: string, options?: PickRouteOptions): RouteContext;
|
|
12
|
+
export {};
|
|
13
|
+
//# sourceMappingURL=responses.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/lib/responses.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgC,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAG/E,UAAU,eAAe;IAAG,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE;AA0D7E,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IAAG,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;AAE9F,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;AAC/G,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,YAAY,CAAC"}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { readFileSync, existsSync } from 'node:fs';
|
|
2
|
+
import { resolve, isAbsolute } from 'node:path';
|
|
3
|
+
import { buildConfig } from './config.js';
|
|
4
|
+
let cachedConfig = null;
|
|
5
|
+
const responseIndexCache = new Map();
|
|
6
|
+
function loadConfigOnce(configPath) {
|
|
7
|
+
if (!cachedConfig) {
|
|
8
|
+
cachedConfig = buildConfig(configPath);
|
|
9
|
+
}
|
|
10
|
+
return cachedConfig;
|
|
11
|
+
}
|
|
12
|
+
function resolveResponsesFile(opts = {}) {
|
|
13
|
+
// 1. explicit option
|
|
14
|
+
if (opts.responsesFilePath) {
|
|
15
|
+
const p = isAbsolute(opts.responsesFilePath) ? opts.responsesFilePath : resolve(process.cwd(), opts.responsesFilePath);
|
|
16
|
+
return { path: p, source: 'explicit' };
|
|
17
|
+
}
|
|
18
|
+
// 2. env var
|
|
19
|
+
const envPath = process.env.ROUTE_TEST_RESPONSES_FILE || process.env.AJB_RESPONSES_FILE;
|
|
20
|
+
if (envPath) {
|
|
21
|
+
const p = isAbsolute(envPath) ? envPath : resolve(process.cwd(), envPath);
|
|
22
|
+
return { path: p, source: 'env' };
|
|
23
|
+
}
|
|
24
|
+
// 3. config (load lazily)
|
|
25
|
+
const cfg = loadConfigOnce(opts.configPath);
|
|
26
|
+
const configured = cfg.resolved.extract.responsesFile || (cfg.resolved.extract.outputDir ? resolve(process.cwd(), cfg.resolved.extract.outputDir, 'responses.json') : undefined);
|
|
27
|
+
if (configured)
|
|
28
|
+
return { path: configured, source: 'config' };
|
|
29
|
+
// 4. default (cwd/assert-json-body/responses.json)
|
|
30
|
+
return { path: resolve(process.cwd(), 'assert-json-body', 'responses.json'), source: 'default' };
|
|
31
|
+
}
|
|
32
|
+
function buildIndex(filePath) {
|
|
33
|
+
if (!existsSync(filePath)) {
|
|
34
|
+
throw new Error(`Responses schema file not found at ${filePath}`);
|
|
35
|
+
}
|
|
36
|
+
let raw;
|
|
37
|
+
try {
|
|
38
|
+
raw = readFileSync(filePath, 'utf8');
|
|
39
|
+
}
|
|
40
|
+
catch (e) {
|
|
41
|
+
throw new Error(`Failed to read responses schema at ${filePath}: ${e.message}`);
|
|
42
|
+
}
|
|
43
|
+
let parsed;
|
|
44
|
+
try {
|
|
45
|
+
parsed = JSON.parse(raw);
|
|
46
|
+
}
|
|
47
|
+
catch (e) {
|
|
48
|
+
throw new Error(`Failed to parse responses schema JSON at ${filePath}: ${e.message}`);
|
|
49
|
+
}
|
|
50
|
+
if (!parsed || !Array.isArray(parsed.responses)) {
|
|
51
|
+
throw new Error(`Invalid responses schema format at ${filePath}: missing 'responses' array`);
|
|
52
|
+
}
|
|
53
|
+
const map = new Map();
|
|
54
|
+
for (const entry of parsed.responses) {
|
|
55
|
+
if (!entry || typeof entry !== 'object' || !entry.path)
|
|
56
|
+
continue; // skip malformed entries silently
|
|
57
|
+
const list = map.get(entry.path) || [];
|
|
58
|
+
list.push(entry);
|
|
59
|
+
map.set(entry.path, list);
|
|
60
|
+
}
|
|
61
|
+
return map;
|
|
62
|
+
}
|
|
63
|
+
function getIndex(filePath) {
|
|
64
|
+
let idx = responseIndexCache.get(filePath);
|
|
65
|
+
if (!idx) {
|
|
66
|
+
idx = buildIndex(filePath);
|
|
67
|
+
responseIndexCache.set(filePath, idx);
|
|
68
|
+
}
|
|
69
|
+
return idx;
|
|
70
|
+
}
|
|
71
|
+
export function pickRoute(path, a, b, _d) {
|
|
72
|
+
// Hard break: if second arg is object treat as options, else legacy signature still partially honored this release but will throw if 4th param used.
|
|
73
|
+
let method;
|
|
74
|
+
let status;
|
|
75
|
+
let opts = {};
|
|
76
|
+
if (a && typeof a === 'object' && !Array.isArray(a)) {
|
|
77
|
+
opts = a;
|
|
78
|
+
method = opts.method;
|
|
79
|
+
status = opts.status;
|
|
80
|
+
}
|
|
81
|
+
else {
|
|
82
|
+
method = a;
|
|
83
|
+
status = b;
|
|
84
|
+
if (_d !== undefined)
|
|
85
|
+
throw new Error('Fourth argument to pickRoute removed; use options object instead.');
|
|
86
|
+
}
|
|
87
|
+
const resolved = resolveResponsesFile({ responsesFilePath: opts.responsesFilePath, configPath: opts.configPath });
|
|
88
|
+
const idx = getIndex(resolved.path);
|
|
89
|
+
const entries = idx.get(path) || [];
|
|
90
|
+
if (entries.length === 0) {
|
|
91
|
+
throw new Error(`No OpenAPI response spec entries found for path '${path}' (schema source: ${resolved.source} @ ${resolved.path}).`);
|
|
92
|
+
}
|
|
93
|
+
let filtered = entries;
|
|
94
|
+
if (method)
|
|
95
|
+
filtered = filtered.filter(e => e.method.toLowerCase() === method.toLowerCase());
|
|
96
|
+
if (status)
|
|
97
|
+
filtered = filtered.filter(e => e.status === status);
|
|
98
|
+
if ((method || status) && filtered.length === 0) {
|
|
99
|
+
const available = entries.map(e => `${e.method} ${e.status}`).sort().join(', ');
|
|
100
|
+
throw new Error(`No matching spec entry for ${path} with method=${method || '*'} status=${status || '*'} (schema: ${resolved.path}).\nAvailable: ${available}`);
|
|
101
|
+
}
|
|
102
|
+
const chosen = filtered.find(e => e.status === '200' && e.method === 'GET') || filtered.find(e => e.status === '200') || filtered.find(e => e.status === '201') || filtered[0];
|
|
103
|
+
const required = chosen.schema.required || [];
|
|
104
|
+
const optional = chosen.schema.optional || [];
|
|
105
|
+
return {
|
|
106
|
+
route: path,
|
|
107
|
+
method: chosen.method,
|
|
108
|
+
status: chosen.status,
|
|
109
|
+
requiredFieldNames: required.map(f => f.name),
|
|
110
|
+
requiredFields: required,
|
|
111
|
+
optionalFields: optional,
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
//# sourceMappingURL=responses.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/lib/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAK1C,IAAI,YAAY,GAA0C,IAAI,CAAC;AAC/D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAwC,CAAC;AAE3E,SAAS,cAAc,CAAC,UAAmB;IACzC,IAAI,CAAC,YAAY,EAAE,CAAC;QAAC,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;IAAC,CAAC;IAC9D,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAwB,EAAE;IACtD,qBAAqB;IACrB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACvH,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IACzC,CAAC;IACD,aAAa;IACb,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IACxF,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1E,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACpC,CAAC;IACD,0BAA0B;IAC1B,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjL,IAAI,UAAU;QAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC9D,mDAAmD;IACnD,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACnG,CAAC;AAED,SAAS,UAAU,CAAC,QAAgB;IAClC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QAAC,GAAG,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAAC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QAAC,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,KAAM,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;IAAC,CAAC;IACvJ,IAAI,MAAqB,CAAC;IAC1B,IAAI,CAAC;QAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAkB,CAAC;IAAC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QAAC,MAAM,IAAI,KAAK,CAAC,4CAA4C,QAAQ,KAAM,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;IAAC,CAAC;IAClK,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,6BAA6B,CAAC,CAAC;IAC/F,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,EAA2B,CAAC;IAC/C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,SAAS,CAAC,kCAAkC;QACpG,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,QAAQ,CAAC,QAAgB;IAChC,IAAI,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC3C,IAAI,CAAC,GAAG,EAAE,CAAC;QAAC,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAAC,CAAC;IAChF,OAAO,GAAG,CAAC;AACb,CAAC;AAMD,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,CAA6B,EAAE,CAAU,EAAE,EAAY;IAC7F,qJAAqJ;IACrJ,IAAI,MAA0B,CAAC;IAC/B,IAAI,MAA0B,CAAC;IAC/B,IAAI,IAAI,GAAqB,EAAE,CAAC;IAChC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,IAAI,GAAG,CAAqB,CAAC;QAC7B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACrB,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAW,CAAC;QACrB,MAAM,GAAG,CAAC,CAAC;QACX,IAAI,EAAE,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IAC7G,CAAC;IACD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAClH,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,oDAAoD,IAAI,qBAAqB,QAAQ,CAAC,MAAM,MAAM,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC;IACvI,CAAC;IACD,IAAI,QAAQ,GAAG,OAAO,CAAC;IACvB,IAAI,MAAM;QAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7F,IAAI,MAAM;QAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IACjE,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,gBAAgB,MAAM,IAAI,GAAG,WAAW,MAAM,IAAI,GAAG,aAAa,QAAQ,CAAC,IAAI,kBAAkB,SAAS,EAAE,CAAC,CAAC;IAClK,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/K,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC9C,OAAO;QACL,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,kBAAkB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7C,cAAc,EAAE,QAAQ;QACxB,cAAc,EAAE,QAAQ;KACzB,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-flatten.d.ts","sourceRoot":"","sources":["../../src/lib/schema-flatten.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-flatten.js","sourceRoot":"","sources":["../../src/lib/schema-flatten.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"diff-recordings-vs-spec.d.ts","sourceRoot":"","sources":["../../../src/lib/tools/diff-recordings-vs-spec.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"diff-recordings-vs-spec.js","sourceRoot":"","sources":["../../../src/lib/tools/diff-recordings-vs-spec.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recorder.d.ts","sourceRoot":"","sources":["../../../src/lib/tools/recorder.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recorder.js","sourceRoot":"","sources":["../../../src/lib/tools/recorder.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAC9F,cAAc,gBAAgB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"summarize-recordings.d.ts","sourceRoot":"","sources":["../../../src/lib/tools/summarize-recordings.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"summarize-recordings.js","sourceRoot":"","sources":["../../../src/lib/tools/summarize-recordings.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type-utils.d.ts","sourceRoot":"","sources":["../../src/lib/type-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/lib/type-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { RouteContext, FieldSpec } from '../types/index.js';
|
|
2
|
+
declare function _validateRouteContext(routeCtx: RouteContext, body: unknown): void;
|
|
3
|
+
export interface ValidateOptions {
|
|
4
|
+
responsesFilePath?: string;
|
|
5
|
+
configPath?: string;
|
|
6
|
+
method?: string;
|
|
7
|
+
status?: string;
|
|
8
|
+
throw?: boolean;
|
|
9
|
+
record?: boolean | {
|
|
10
|
+
label?: string;
|
|
11
|
+
};
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Public API: validateResponseShape(spec, body, options?)
|
|
15
|
+
* Resolves the route context (schema lookup) internally using configuration precedence.
|
|
16
|
+
*/
|
|
17
|
+
export interface ValidateResultBase {
|
|
18
|
+
ok: boolean;
|
|
19
|
+
errors?: string[];
|
|
20
|
+
response: unknown;
|
|
21
|
+
schema: {
|
|
22
|
+
required: FieldSpec[];
|
|
23
|
+
optional: FieldSpec[];
|
|
24
|
+
};
|
|
25
|
+
routeContext: RouteContext;
|
|
26
|
+
}
|
|
27
|
+
export declare function validateResponseShape(spec: {
|
|
28
|
+
path: string;
|
|
29
|
+
method?: string;
|
|
30
|
+
status?: string;
|
|
31
|
+
}, body: unknown, options?: ValidateOptions): ValidateResultBase;
|
|
32
|
+
export { _validateRouteContext };
|
|
33
|
+
//# sourceMappingURL=validator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/lib/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAe1D,iBAAS,qBAAqB,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,QAkFnE;AAED,MAAM,WAAW,eAAe;IAAG,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE;AAE9K;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAAG,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;QAAC,QAAQ,EAAE,SAAS,EAAE,CAAA;KAAE,CAAC;IAAC,YAAY,EAAE,YAAY,CAAA;CAAE;AAE/K,wBAAgB,qBAAqB,CAAC,IAAI,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAE,eAAoB,GAAG,kBAAkB,CA0BhK;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
import { pickRoute } from './responses.js';
|
|
2
|
+
import { recordBody } from './recorder.js';
|
|
3
|
+
import { buildConfig } from './config.js';
|
|
4
|
+
const isPrimitive = (t) => t === 'string' || t === 'number' || t === 'boolean';
|
|
5
|
+
const extractArrayInner = (typeStr) => { const m = /^array<(.+)>$/.exec(typeStr.trim()); return m ? m[1].trim() : null; };
|
|
6
|
+
const shouldTreatAsEnum = (typeStr) => /Enum$/.test(typeStr);
|
|
7
|
+
const shouldTreatAsObject = (spec) => { if (spec.children)
|
|
8
|
+
return true; if (spec.type === 'object')
|
|
9
|
+
return true; if (/^[A-Z][A-Za-z0-9]+$/.test(spec.type) && !shouldTreatAsEnum(spec.type))
|
|
10
|
+
return true; return false; };
|
|
11
|
+
const jsonPointerEscape = (seg) => seg.replace(/~/g, '~0').replace(/\//g, '~1');
|
|
12
|
+
const toExpectedDescriptor = (spec) => { const inner = extractArrayInner(spec.type); if (inner)
|
|
13
|
+
return `array<${inner}>`; if (spec.wrapper && spec.underlyingPrimitive)
|
|
14
|
+
return `${spec.underlyingPrimitive} (wrapper ${spec.rawRefName || spec.type})`; if (spec.enumValues?.length)
|
|
15
|
+
return `enum<${spec.underlyingPrimitive || 'string'}>[${spec.enumValues.join('|')}]`; if (spec.children || spec.type === 'object')
|
|
16
|
+
return 'object'; return spec.type; };
|
|
17
|
+
const actualDescriptor = (val) => { if (val === null)
|
|
18
|
+
return 'null'; if (Array.isArray(val))
|
|
19
|
+
return 'array'; return typeof val; };
|
|
20
|
+
function _validateRouteContext(routeCtx, body) {
|
|
21
|
+
if (!routeCtx.route || routeCtx.requiredFields.length === 0)
|
|
22
|
+
return; // no spec
|
|
23
|
+
if (body === null || typeof body !== 'object' || Array.isArray(body)) {
|
|
24
|
+
throw new Error(`Expected object response body to validate route required fields for ${routeCtx.route}`);
|
|
25
|
+
}
|
|
26
|
+
const options = { arraySampleLimit: 25 };
|
|
27
|
+
const errors = [];
|
|
28
|
+
const checkPrimitiveType = (val, expected) => typeof val === expected;
|
|
29
|
+
const validateGroup = (obj, specs, pointer, mode, optionalSpecsForExtras) => {
|
|
30
|
+
if (mode === 'required') {
|
|
31
|
+
const allowed = new Set();
|
|
32
|
+
for (const s of specs)
|
|
33
|
+
allowed.add(s.name);
|
|
34
|
+
if (optionalSpecsForExtras) {
|
|
35
|
+
for (const s of optionalSpecsForExtras)
|
|
36
|
+
allowed.add(s.name);
|
|
37
|
+
}
|
|
38
|
+
for (const key of Object.keys(obj)) {
|
|
39
|
+
if (!allowed.has(key)) {
|
|
40
|
+
const fieldPath = pointer ? `${pointer}/${jsonPointerEscape(key)}` : `/${jsonPointerEscape(key)}`;
|
|
41
|
+
errors.push(`[EXTRA] ${fieldPath} is not declared in spec`);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
for (const spec of specs) {
|
|
46
|
+
const fieldPath = pointer ? `${pointer}/${jsonPointerEscape(spec.name)}` : `/${jsonPointerEscape(spec.name)}`;
|
|
47
|
+
const exists = spec.name in obj;
|
|
48
|
+
if (!exists) {
|
|
49
|
+
if (mode === 'required') {
|
|
50
|
+
errors.push(`[MISSING] ${fieldPath} expected ${toExpectedDescriptor(spec)}`);
|
|
51
|
+
}
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
const value = obj[spec.name];
|
|
55
|
+
if (value === null) {
|
|
56
|
+
errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got null`);
|
|
57
|
+
continue;
|
|
58
|
+
}
|
|
59
|
+
const inner = extractArrayInner(spec.type);
|
|
60
|
+
if (inner) {
|
|
61
|
+
if (!Array.isArray(value)) {
|
|
62
|
+
errors.push(`[TYPE] ${fieldPath} expected array<${inner}> but got ${actualDescriptor(value)}`);
|
|
63
|
+
}
|
|
64
|
+
else if (value.length > 0) {
|
|
65
|
+
const sample = value.slice(0, options.arraySampleLimit);
|
|
66
|
+
if (isPrimitive(inner)) {
|
|
67
|
+
for (let i = 0; i < sample.length; i++) {
|
|
68
|
+
const el = sample[i];
|
|
69
|
+
if (typeof el !== inner) {
|
|
70
|
+
errors.push(`[TYPE] ${fieldPath}/${i} expected ${inner} but got ${actualDescriptor(el)}`);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
else if (spec.children) {
|
|
75
|
+
for (let i = 0; i < sample.length; i++) {
|
|
76
|
+
const el = sample[i];
|
|
77
|
+
if (el === null || typeof el !== 'object' || Array.isArray(el)) {
|
|
78
|
+
errors.push(`[TYPE] ${fieldPath}/${i} expected object but got ${actualDescriptor(el)}`);
|
|
79
|
+
continue;
|
|
80
|
+
}
|
|
81
|
+
validateGroup(el, spec.children.required || [], `${fieldPath}/${i}`, 'required', spec.children.optional);
|
|
82
|
+
if (spec.children.optional?.length) {
|
|
83
|
+
validateGroup(el, spec.children.optional, `${fieldPath}/${i}`, 'optional-present');
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
continue;
|
|
89
|
+
}
|
|
90
|
+
if (spec.wrapper && spec.underlyingPrimitive && isPrimitive(spec.underlyingPrimitive)) {
|
|
91
|
+
if (!checkPrimitiveType(value, spec.underlyingPrimitive)) {
|
|
92
|
+
errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got ${actualDescriptor(value)}`);
|
|
93
|
+
}
|
|
94
|
+
if (spec.enumValues && typeof value === 'string') {
|
|
95
|
+
if (!spec.enumValues.includes(value)) {
|
|
96
|
+
errors.push(`[ENUM] ${fieldPath} value ${JSON.stringify(value)} not in [${spec.enumValues.join(', ')}]`);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
continue;
|
|
100
|
+
}
|
|
101
|
+
if (isPrimitive(spec.type)) {
|
|
102
|
+
if (!checkPrimitiveType(value, spec.type)) {
|
|
103
|
+
errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got ${actualDescriptor(value)}`);
|
|
104
|
+
}
|
|
105
|
+
if (spec.enumValues && typeof value === 'string') {
|
|
106
|
+
if (!spec.enumValues.includes(value)) {
|
|
107
|
+
errors.push(`[ENUM] ${fieldPath} value ${JSON.stringify(value)} not in [${spec.enumValues.join(', ')}]`);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
continue;
|
|
111
|
+
}
|
|
112
|
+
if (shouldTreatAsEnum(spec.type)) {
|
|
113
|
+
if (typeof value !== 'string') {
|
|
114
|
+
errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got ${actualDescriptor(value)}`);
|
|
115
|
+
}
|
|
116
|
+
if (spec.enumValues && typeof value === 'string') {
|
|
117
|
+
if (!spec.enumValues.includes(value)) {
|
|
118
|
+
errors.push(`[ENUM] ${fieldPath} value ${JSON.stringify(value)} not in [${spec.enumValues.join(', ')}]`);
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
continue;
|
|
122
|
+
}
|
|
123
|
+
if (shouldTreatAsObject(spec)) {
|
|
124
|
+
if (typeof value !== 'object' || Array.isArray(value)) {
|
|
125
|
+
errors.push(`[TYPE] ${fieldPath} expected object but got ${actualDescriptor(value)}`);
|
|
126
|
+
continue;
|
|
127
|
+
}
|
|
128
|
+
if (spec.children) {
|
|
129
|
+
validateGroup(value, spec.children.required || [], fieldPath, 'required', spec.children.optional);
|
|
130
|
+
if (spec.children.optional?.length) {
|
|
131
|
+
validateGroup(value, spec.children.optional, fieldPath, 'optional-present');
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
continue;
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
};
|
|
138
|
+
validateGroup(body, routeCtx.requiredFields, '', 'required', routeCtx.optionalFields);
|
|
139
|
+
if (routeCtx.optionalFields.length) {
|
|
140
|
+
validateGroup(body, routeCtx.optionalFields, '', 'optional-present');
|
|
141
|
+
}
|
|
142
|
+
if (errors.length) {
|
|
143
|
+
const preview = errors.slice(0, 15).join('\n');
|
|
144
|
+
const extra = errors.length > 15 ? `\n...and ${errors.length - 15} more` : '';
|
|
145
|
+
throw new Error(`Response shape errors for route ${routeCtx.method || '*'} ${routeCtx.status || '*'} ${routeCtx.route}:\n${preview}${extra}`);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
export function validateResponseShape(spec, body, options = {}) {
|
|
149
|
+
const routeCtx = pickRoute(spec.path, {
|
|
150
|
+
method: spec.method || options.method,
|
|
151
|
+
status: spec.status || options.status,
|
|
152
|
+
responsesFilePath: options.responsesFilePath,
|
|
153
|
+
configPath: options.configPath,
|
|
154
|
+
});
|
|
155
|
+
const cfg = buildConfig(options.configPath);
|
|
156
|
+
const globalThrow = cfg.resolved.validate.throwOnValidationFail;
|
|
157
|
+
const shouldThrow = options.throw !== undefined ? options.throw : globalThrow;
|
|
158
|
+
const globalRecord = cfg.resolved.validate.recordResponses;
|
|
159
|
+
const doRecord = options.record !== undefined ? !!options.record : globalRecord;
|
|
160
|
+
if (doRecord) {
|
|
161
|
+
let label;
|
|
162
|
+
if (typeof options.record === 'object' && options.record)
|
|
163
|
+
label = options.record.label;
|
|
164
|
+
recordBody({ routeCtx, body, label });
|
|
165
|
+
}
|
|
166
|
+
try {
|
|
167
|
+
_validateRouteContext(routeCtx, body);
|
|
168
|
+
return { ok: true, response: body, schema: { required: routeCtx.requiredFields, optional: routeCtx.optionalFields }, routeContext: routeCtx };
|
|
169
|
+
}
|
|
170
|
+
catch (err) {
|
|
171
|
+
if (shouldThrow)
|
|
172
|
+
throw err;
|
|
173
|
+
const msg = err.message || '';
|
|
174
|
+
const lines = msg.split('\n');
|
|
175
|
+
return { ok: false, errors: lines.slice(1).filter(Boolean), response: body, schema: { required: routeCtx.requiredFields, optional: routeCtx.optionalFields }, routeContext: routeCtx };
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
export { _validateRouteContext };
|
|
179
|
+
//# sourceMappingURL=validator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/lib/validator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAI1C,MAAM,WAAW,GAAG,CAAC,CAAS,EAAwC,EAAE,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,SAAS,CAAC;AAC7H,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAiB,EAAE,GAAG,MAAM,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjJ,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC9E,MAAM,mBAAmB,GAAG,CAAC,IAAe,EAAW,EAAE,GAAG,IAAI,IAAI,CAAC,QAAQ;IAAE,OAAO,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;IAAE,OAAO,IAAI,CAAC,CAAC,IAAI,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;IAAE,OAAO,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9O,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACxF,MAAM,oBAAoB,GAAG,CAAC,IAAe,EAAU,EAAE,GAAG,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK;IAAE,OAAO,SAAS,KAAK,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB;IAAE,OAAO,GAAG,IAAI,CAAC,mBAAmB,aAAa,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM;IAAE,OAAO,QAAQ,IAAI,CAAC,mBAAmB,IAAI,QAAQ,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;IAAE,OAAO,QAAQ,CAAC,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAChd,MAAM,gBAAgB,GAAG,CAAC,GAAY,EAAU,EAAE,GAAG,IAAI,GAAG,KAAK,IAAI;IAAE,OAAO,MAAM,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;IAAE,OAAO,OAAO,CAAC,CAAC,OAAO,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;AAEnJ,SAAS,qBAAqB,CAAC,QAAsB,EAAE,IAAa;IAClE,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,UAAU;IAC/E,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,uEAAuE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAC3G,CAAC;IACD,MAAM,OAAO,GAAsB,EAAC,gBAAgB,EAAE,EAAE,EAAC,CAAC;IAC1D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,kBAAkB,GAAG,CAAC,GAAY,EAAE,QAAgB,EAAW,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC;IAChG,MAAM,aAAa,GAAG,CACpB,GAA4B,EAC5B,KAAkB,EAClB,OAAe,EACf,IAAqC,EACrC,sBAAoC,EACpC,EAAE;QACF,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;YAClC,KAAK,MAAM,CAAC,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,sBAAsB,EAAE,CAAC;gBAAC,KAAK,MAAM,CAAC,IAAI,sBAAsB;oBAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAAC,CAAC;YAC5F,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;oBACtB,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;oBAClG,MAAM,CAAC,IAAI,CAAC,WAAW,SAAS,0BAA0B,CAAC,CAAC;gBAC9D,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9G,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC;YAChC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAAC,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;oBAAC,MAAM,CAAC,IAAI,CAAC,aAAa,SAAS,aAAa,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YACrI,MAAM,KAAK,GAAI,GAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1D,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,aAAa,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YACzH,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,mBAAmB,KAAK,aAAa,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAAC,CAAC;qBACzH,IAAK,KAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzC,MAAM,MAAM,GAAI,KAAmB,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;oBACvE,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;wBACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;4BAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;4BAAC,IAAI,OAAO,EAAE,KAAK,KAAK,EAAE,CAAC;gCAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,IAAI,CAAC,aAAa,KAAK,YAAY,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;4BAAC,CAAC;wBAAC,CAAC;oBAC3L,CAAC;yBAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;4BAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;4BAAC,IAAI,EAAE,KAAK,IAAI,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;gCAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,IAAI,CAAC,4BAA4B,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gCAAC,SAAS;4BAAC,CAAC;4BACpO,aAAa,CAAC,EAA6B,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE,GAAG,SAAS,IAAI,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;4BACpI,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;gCACnC,aAAa,CAAC,EAA6B,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,SAAS,IAAI,CAAC,EAAE,EAAE,kBAAkB,CAAC,CAAC;4BAChH,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,SAAS;YACX,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,IAAI,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBACtF,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;oBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,aAAa,oBAAoB,CAAC,IAAI,CAAC,YAAY,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAAC,CAAC;gBAC3K,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAAC,CAAC;gBAAC,CAAC;gBACzM,SAAS;YACX,CAAC;YACD,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,aAAa,oBAAoB,CAAC,IAAI,CAAC,YAAY,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAAC,CAAC;gBAC5J,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAAC,CAAC;gBAAC,CAAC;gBACzM,SAAS;YACX,CAAC;YACD,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,aAAa,oBAAoB,CAAC,IAAI,CAAC,YAAY,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAAC,CAAC;gBAChJ,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAAC,CAAC;gBAAC,CAAC;gBACzM,SAAS;YACX,CAAC;YACD,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAAC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,4BAA4B,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;oBAAC,SAAS;gBAAC,CAAC;gBAC3J,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,aAAa,CAAC,KAAgC,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC7H,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;wBAAC,aAAa,CAAC,KAAgC,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC;oBAAC,CAAC;gBACjJ,CAAC;gBACD,SAAS;YACX,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,aAAa,CAAC,IAA+B,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACjH,IAAI,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAAC,aAAa,CAAC,IAA+B,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,EAAE,kBAAkB,CAAC,CAAC;IAAC,CAAC;IACxI,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,MAAM,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC;IAChJ,CAAC;AACH,CAAC;AAUD,MAAM,UAAU,qBAAqB,CAAC,IAAwD,EAAE,IAAa,EAAE,UAA2B,EAAE;IAC1I,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE;QACpC,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM;QACrC,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM;QACrC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;QAC5C,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAChE,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;IAC9E,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC3D,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC;IAChF,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,KAAyB,CAAC;QAC9B,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM;YAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QACvF,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,CAAC;QACH,qBAAqB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACtC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IAChJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,WAAW;YAAE,MAAM,GAAG,CAAC;QAC3B,MAAM,GAAG,GAAI,GAAa,CAAC,OAAO,IAAI,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IACzL,CAAC;AACH,CAAC;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
export interface FieldSpec {
|
|
2
|
+
name: string;
|
|
3
|
+
type: string;
|
|
4
|
+
children?: SchemaGroup;
|
|
5
|
+
enumValues?: string[];
|
|
6
|
+
underlyingPrimitive?: string;
|
|
7
|
+
rawRefName?: string;
|
|
8
|
+
wrapper?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface SchemaGroup {
|
|
11
|
+
required: FieldSpec[];
|
|
12
|
+
optional: FieldSpec[];
|
|
13
|
+
}
|
|
14
|
+
export interface ResponseEntry {
|
|
15
|
+
path: string;
|
|
16
|
+
method: string;
|
|
17
|
+
status: string;
|
|
18
|
+
schema: SchemaGroup;
|
|
19
|
+
}
|
|
20
|
+
export interface ResponsesFileMetadata {
|
|
21
|
+
sourceRepo: string;
|
|
22
|
+
commit: string;
|
|
23
|
+
generatedAt: string;
|
|
24
|
+
specPath: string;
|
|
25
|
+
specSha256: string;
|
|
26
|
+
}
|
|
27
|
+
export interface ResponsesFile {
|
|
28
|
+
metadata?: ResponsesFileMetadata;
|
|
29
|
+
responses: ResponseEntry[];
|
|
30
|
+
}
|
|
31
|
+
export interface RouteContext {
|
|
32
|
+
route: string;
|
|
33
|
+
method?: string;
|
|
34
|
+
status?: string;
|
|
35
|
+
requiredFieldNames: string[];
|
|
36
|
+
requiredFields: FieldSpec[];
|
|
37
|
+
optionalFields: FieldSpec[];
|
|
38
|
+
}
|
|
39
|
+
export interface FlattenResult {
|
|
40
|
+
required: FieldSpec[];
|
|
41
|
+
optional: FieldSpec[];
|
|
42
|
+
}
|
|
43
|
+
/** Extraction (generate) configuration options */
|
|
44
|
+
export interface ExtractConfig {
|
|
45
|
+
repo?: string;
|
|
46
|
+
specPath?: string;
|
|
47
|
+
ref?: string;
|
|
48
|
+
outputDir?: string;
|
|
49
|
+
preserveCheckout?: boolean;
|
|
50
|
+
dryRun?: boolean;
|
|
51
|
+
responsesFile?: string;
|
|
52
|
+
logLevel?: 'silent' | 'error' | 'warn' | 'info' | 'debug';
|
|
53
|
+
failIfExists?: boolean;
|
|
54
|
+
}
|
|
55
|
+
/** Validation behaviour configuration options */
|
|
56
|
+
export interface ValidateConfig {
|
|
57
|
+
/** Enable recording of validated bodies globally (can still be overridden per call) */
|
|
58
|
+
recordResponses?: boolean;
|
|
59
|
+
/** Throw on validation failure by default (true) vs structured result mode */
|
|
60
|
+
throwOnValidationFail?: boolean;
|
|
61
|
+
}
|
|
62
|
+
/** Root JSON configuration file shape */
|
|
63
|
+
export interface ConfigFile {
|
|
64
|
+
extract?: ExtractConfig;
|
|
65
|
+
validate?: ValidateConfig;
|
|
66
|
+
/** Room for future config sections */
|
|
67
|
+
assert?: Record<string, unknown>;
|
|
68
|
+
}
|
|
69
|
+
export interface ResolvedExtractConfig extends Required<Pick<ExtractConfig, 'repo' | 'specPath' | 'ref' | 'outputDir' | 'preserveCheckout' | 'dryRun' | 'logLevel' | 'failIfExists'>> {
|
|
70
|
+
responsesFile?: string;
|
|
71
|
+
}
|
|
72
|
+
export type ResolvedValidateConfig = Required<Pick<ValidateConfig, 'recordResponses' | 'throwOnValidationFail'>>;
|
|
73
|
+
export interface ResolvedConfig {
|
|
74
|
+
extract: ResolvedExtractConfig;
|
|
75
|
+
validate: ResolvedValidateConfig;
|
|
76
|
+
}
|
|
77
|
+
export interface ConfigResolution {
|
|
78
|
+
filePath?: string;
|
|
79
|
+
file?: ConfigFile;
|
|
80
|
+
cli: ExtractConfig;
|
|
81
|
+
env: {
|
|
82
|
+
extract: ExtractConfig;
|
|
83
|
+
validate: ValidateConfig;
|
|
84
|
+
};
|
|
85
|
+
resolved: ResolvedConfig;
|
|
86
|
+
warnings: string[];
|
|
87
|
+
}
|
|
88
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAAG,QAAQ,EAAE,SAAS,EAAE,CAAC;IAAC,QAAQ,EAAE,SAAS,EAAE,CAAA;CAAE;AAE7E,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,SAAS,EAAE,CAAC;IAC5B,cAAc,EAAE,SAAS,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAAG,QAAQ,EAAE,SAAS,EAAE,CAAC;IAAC,QAAQ,EAAE,SAAS,EAAE,CAAA;CAAE;AAM/E,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAC1D,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,uFAAuF;IACvF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,yCAAyC;AACzC,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,qBAAsB,SAAQ,QAAQ,CAAC,IAAI,CAAC,aAAa,EACxE,MAAM,GAAG,UAAU,GAAG,KAAK,GAAG,WAAW,GAAG,kBAAkB,GAAG,QAAQ,GAAG,UAAU,GAAG,cAAc,CAAC,CAAC;IACzG,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,EAC/D,iBAAiB,GAAG,uBAAuB,CAAC,CAAC,CAAA;AAE/C,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,qBAAqB,CAAC;IAC/B,QAAQ,EAAE,sBAAsB,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,GAAG,EAAE;QAAE,OAAO,EAAE,aAAa,CAAC;QAAC,QAAQ,EAAE,cAAc,CAAA;KAAE,CAAC;IAC1D,QAAQ,EAAE,cAAc,CAAC;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,4FAA4F"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"diff-recordings-vs-spec.d.ts","sourceRoot":"","sources":["../../src/assertion/diff-recordings-vs-spec.ts"],"names":[],"mappings":""}
|