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.
Files changed (211) hide show
  1. package/README.md +352 -0
  2. package/dist/assertion/diff-recordings-vs-spec.d.ts +3 -0
  3. package/dist/assertion/diff-recordings-vs-spec.d.ts.map +1 -0
  4. package/dist/assertion/diff-recordings-vs-spec.js +176 -0
  5. package/dist/assertion/diff-recordings-vs-spec.js.map +1 -0
  6. package/dist/assertion/index.d.ts +2 -0
  7. package/dist/assertion/index.d.ts.map +1 -0
  8. package/dist/assertion/index.js +2 -0
  9. package/dist/assertion/index.js.map +1 -0
  10. package/dist/assertion/recorder.d.ts +7 -0
  11. package/dist/assertion/recorder.d.ts.map +1 -0
  12. package/dist/assertion/recorder.js +81 -0
  13. package/dist/assertion/recorder.js.map +1 -0
  14. package/dist/assertion/summarize-recordings.d.ts +3 -0
  15. package/dist/assertion/summarize-recordings.d.ts.map +1 -0
  16. package/dist/assertion/summarize-recordings.js +121 -0
  17. package/dist/assertion/summarize-recordings.js.map +1 -0
  18. package/dist/assertion/validator.d.ts +2 -0
  19. package/dist/assertion/validator.d.ts.map +1 -0
  20. package/dist/assertion/validator.js +3 -0
  21. package/dist/assertion/validator.js.map +1 -0
  22. package/dist/base.d.ts +2 -0
  23. package/dist/base.d.ts.map +1 -0
  24. package/dist/base.js +3 -0
  25. package/dist/base.js.map +1 -0
  26. package/dist/cli/index.d.ts +3 -0
  27. package/dist/cli/index.d.ts.map +1 -0
  28. package/dist/cli/index.js +84 -0
  29. package/dist/cli/index.js.map +1 -0
  30. package/dist/extractor/src/lib/child-expansion.d.ts +8 -0
  31. package/dist/extractor/src/lib/child-expansion.d.ts.map +1 -0
  32. package/dist/extractor/src/lib/child-expansion.js +72 -0
  33. package/dist/extractor/src/lib/child-expansion.js.map +1 -0
  34. package/dist/extractor/src/lib/git.d.ts +9 -0
  35. package/dist/extractor/src/lib/git.d.ts.map +1 -0
  36. package/dist/extractor/src/lib/git.js +22 -0
  37. package/dist/extractor/src/lib/git.js.map +1 -0
  38. package/dist/extractor/src/lib/schema-flatten.d.ts +10 -0
  39. package/dist/extractor/src/lib/schema-flatten.d.ts.map +1 -0
  40. package/dist/extractor/src/lib/schema-flatten.js +203 -0
  41. package/dist/extractor/src/lib/schema-flatten.js.map +1 -0
  42. package/dist/extractor/src/lib/type-utils.d.ts +5 -0
  43. package/dist/extractor/src/lib/type-utils.d.ts.map +1 -0
  44. package/dist/extractor/src/lib/type-utils.js +27 -0
  45. package/dist/extractor/src/lib/type-utils.js.map +1 -0
  46. package/dist/index.d.ts +5 -0
  47. package/dist/index.d.ts.map +1 -0
  48. package/dist/index.js +6 -0
  49. package/dist/index.js.map +1 -0
  50. package/dist/lib/assert.d.ts +27 -0
  51. package/dist/lib/assert.d.ts.map +1 -0
  52. package/dist/lib/assert.js +32 -0
  53. package/dist/lib/assert.js.map +1 -0
  54. package/dist/lib/child-expansion.d.ts +2 -0
  55. package/dist/lib/child-expansion.d.ts.map +1 -0
  56. package/dist/lib/child-expansion.js +2 -0
  57. package/dist/lib/child-expansion.js.map +1 -0
  58. package/dist/lib/config.d.ts +27 -0
  59. package/dist/lib/config.d.ts.map +1 -0
  60. package/dist/lib/config.js +139 -0
  61. package/dist/lib/config.js.map +1 -0
  62. package/dist/lib/extractor.d.ts +6 -0
  63. package/dist/lib/extractor.d.ts.map +1 -0
  64. package/dist/lib/extractor.js +164 -0
  65. package/dist/lib/extractor.js.map +1 -0
  66. package/dist/lib/git.d.ts +2 -0
  67. package/dist/lib/git.d.ts.map +1 -0
  68. package/dist/lib/git.js +2 -0
  69. package/dist/lib/git.js.map +1 -0
  70. package/dist/lib/recorder.d.ts +8 -0
  71. package/dist/lib/recorder.d.ts.map +1 -0
  72. package/dist/lib/recorder.js +68 -0
  73. package/dist/lib/recorder.js.map +1 -0
  74. package/dist/lib/responses.d.ts +13 -0
  75. package/dist/lib/responses.d.ts.map +1 -0
  76. package/dist/lib/responses.js +114 -0
  77. package/dist/lib/responses.js.map +1 -0
  78. package/dist/lib/schema-flatten.d.ts +2 -0
  79. package/dist/lib/schema-flatten.d.ts.map +1 -0
  80. package/dist/lib/schema-flatten.js +2 -0
  81. package/dist/lib/schema-flatten.js.map +1 -0
  82. package/dist/lib/tools/diff-recordings-vs-spec.d.ts +2 -0
  83. package/dist/lib/tools/diff-recordings-vs-spec.d.ts.map +1 -0
  84. package/dist/lib/tools/diff-recordings-vs-spec.js +2 -0
  85. package/dist/lib/tools/diff-recordings-vs-spec.js.map +1 -0
  86. package/dist/lib/tools/recorder.d.ts +2 -0
  87. package/dist/lib/tools/recorder.d.ts.map +1 -0
  88. package/dist/lib/tools/recorder.js +3 -0
  89. package/dist/lib/tools/recorder.js.map +1 -0
  90. package/dist/lib/tools/summarize-recordings.d.ts +2 -0
  91. package/dist/lib/tools/summarize-recordings.d.ts.map +1 -0
  92. package/dist/lib/tools/summarize-recordings.js +2 -0
  93. package/dist/lib/tools/summarize-recordings.js.map +1 -0
  94. package/dist/lib/type-utils.d.ts +2 -0
  95. package/dist/lib/type-utils.d.ts.map +1 -0
  96. package/dist/lib/type-utils.js +2 -0
  97. package/dist/lib/type-utils.js.map +1 -0
  98. package/dist/lib/validator.d.ts +33 -0
  99. package/dist/lib/validator.d.ts.map +1 -0
  100. package/dist/lib/validator.js +179 -0
  101. package/dist/lib/validator.js.map +1 -0
  102. package/dist/types/index.d.ts +88 -0
  103. package/dist/types/index.d.ts.map +1 -0
  104. package/dist/types/index.js +3 -0
  105. package/dist/types/index.js.map +1 -0
  106. package/dist-cjs/assertion/diff-recordings-vs-spec.d.ts +3 -0
  107. package/dist-cjs/assertion/diff-recordings-vs-spec.d.ts.map +1 -0
  108. package/dist-cjs/assertion/diff-recordings-vs-spec.js +178 -0
  109. package/dist-cjs/assertion/diff-recordings-vs-spec.js.map +1 -0
  110. package/dist-cjs/assertion/index.d.ts +2 -0
  111. package/dist-cjs/assertion/index.d.ts.map +1 -0
  112. package/dist-cjs/assertion/index.js +3 -0
  113. package/dist-cjs/assertion/index.js.map +1 -0
  114. package/dist-cjs/assertion/recorder.d.ts +7 -0
  115. package/dist-cjs/assertion/recorder.d.ts.map +1 -0
  116. package/dist-cjs/assertion/recorder.js +84 -0
  117. package/dist-cjs/assertion/recorder.js.map +1 -0
  118. package/dist-cjs/assertion/summarize-recordings.d.ts +3 -0
  119. package/dist-cjs/assertion/summarize-recordings.d.ts.map +1 -0
  120. package/dist-cjs/assertion/summarize-recordings.js +123 -0
  121. package/dist-cjs/assertion/summarize-recordings.js.map +1 -0
  122. package/dist-cjs/assertion/validator.d.ts +2 -0
  123. package/dist-cjs/assertion/validator.d.ts.map +1 -0
  124. package/dist-cjs/assertion/validator.js +7 -0
  125. package/dist-cjs/assertion/validator.js.map +1 -0
  126. package/dist-cjs/base.d.ts +2 -0
  127. package/dist-cjs/base.d.ts.map +1 -0
  128. package/dist-cjs/base.js +7 -0
  129. package/dist-cjs/base.js.map +1 -0
  130. package/dist-cjs/cli/index.d.ts +3 -0
  131. package/dist-cjs/cli/index.d.ts.map +1 -0
  132. package/dist-cjs/cli/index.js +86 -0
  133. package/dist-cjs/cli/index.js.map +1 -0
  134. package/dist-cjs/extractor/src/lib/child-expansion.d.ts +8 -0
  135. package/dist-cjs/extractor/src/lib/child-expansion.d.ts.map +1 -0
  136. package/dist-cjs/extractor/src/lib/child-expansion.js +76 -0
  137. package/dist-cjs/extractor/src/lib/child-expansion.js.map +1 -0
  138. package/dist-cjs/extractor/src/lib/git.d.ts +9 -0
  139. package/dist-cjs/extractor/src/lib/git.d.ts.map +1 -0
  140. package/dist-cjs/extractor/src/lib/git.js +26 -0
  141. package/dist-cjs/extractor/src/lib/git.js.map +1 -0
  142. package/dist-cjs/extractor/src/lib/schema-flatten.d.ts +10 -0
  143. package/dist-cjs/extractor/src/lib/schema-flatten.d.ts.map +1 -0
  144. package/dist-cjs/extractor/src/lib/schema-flatten.js +211 -0
  145. package/dist-cjs/extractor/src/lib/schema-flatten.js.map +1 -0
  146. package/dist-cjs/extractor/src/lib/type-utils.d.ts +5 -0
  147. package/dist-cjs/extractor/src/lib/type-utils.d.ts.map +1 -0
  148. package/dist-cjs/extractor/src/lib/type-utils.js +32 -0
  149. package/dist-cjs/extractor/src/lib/type-utils.js.map +1 -0
  150. package/dist-cjs/index.d.ts +5 -0
  151. package/dist-cjs/index.d.ts.map +1 -0
  152. package/dist-cjs/index.js +26 -0
  153. package/dist-cjs/index.js.map +1 -0
  154. package/dist-cjs/lib/assert.d.ts +27 -0
  155. package/dist-cjs/lib/assert.d.ts.map +1 -0
  156. package/dist-cjs/lib/assert.js +35 -0
  157. package/dist-cjs/lib/assert.js.map +1 -0
  158. package/dist-cjs/lib/child-expansion.d.ts +2 -0
  159. package/dist-cjs/lib/child-expansion.d.ts.map +1 -0
  160. package/dist-cjs/lib/child-expansion.js +7 -0
  161. package/dist-cjs/lib/child-expansion.js.map +1 -0
  162. package/dist-cjs/lib/config.d.ts +27 -0
  163. package/dist-cjs/lib/config.d.ts.map +1 -0
  164. package/dist-cjs/lib/config.js +147 -0
  165. package/dist-cjs/lib/config.js.map +1 -0
  166. package/dist-cjs/lib/extractor.d.ts +6 -0
  167. package/dist-cjs/lib/extractor.d.ts.map +1 -0
  168. package/dist-cjs/lib/extractor.js +172 -0
  169. package/dist-cjs/lib/extractor.js.map +1 -0
  170. package/dist-cjs/lib/git.d.ts +2 -0
  171. package/dist-cjs/lib/git.d.ts.map +1 -0
  172. package/dist-cjs/lib/git.js +6 -0
  173. package/dist-cjs/lib/git.js.map +1 -0
  174. package/dist-cjs/lib/recorder.d.ts +8 -0
  175. package/dist-cjs/lib/recorder.d.ts.map +1 -0
  176. package/dist-cjs/lib/recorder.js +71 -0
  177. package/dist-cjs/lib/recorder.js.map +1 -0
  178. package/dist-cjs/lib/responses.d.ts +13 -0
  179. package/dist-cjs/lib/responses.d.ts.map +1 -0
  180. package/dist-cjs/lib/responses.js +117 -0
  181. package/dist-cjs/lib/responses.js.map +1 -0
  182. package/dist-cjs/lib/schema-flatten.d.ts +2 -0
  183. package/dist-cjs/lib/schema-flatten.d.ts.map +1 -0
  184. package/dist-cjs/lib/schema-flatten.js +11 -0
  185. package/dist-cjs/lib/schema-flatten.js.map +1 -0
  186. package/dist-cjs/lib/tools/diff-recordings-vs-spec.d.ts +2 -0
  187. package/dist-cjs/lib/tools/diff-recordings-vs-spec.d.ts.map +1 -0
  188. package/dist-cjs/lib/tools/diff-recordings-vs-spec.js +18 -0
  189. package/dist-cjs/lib/tools/diff-recordings-vs-spec.js.map +1 -0
  190. package/dist-cjs/lib/tools/recorder.d.ts +2 -0
  191. package/dist-cjs/lib/tools/recorder.d.ts.map +1 -0
  192. package/dist-cjs/lib/tools/recorder.js +19 -0
  193. package/dist-cjs/lib/tools/recorder.js.map +1 -0
  194. package/dist-cjs/lib/tools/summarize-recordings.d.ts +2 -0
  195. package/dist-cjs/lib/tools/summarize-recordings.d.ts.map +1 -0
  196. package/dist-cjs/lib/tools/summarize-recordings.js +18 -0
  197. package/dist-cjs/lib/tools/summarize-recordings.js.map +1 -0
  198. package/dist-cjs/lib/type-utils.d.ts +2 -0
  199. package/dist-cjs/lib/type-utils.d.ts.map +1 -0
  200. package/dist-cjs/lib/type-utils.js +8 -0
  201. package/dist-cjs/lib/type-utils.js.map +1 -0
  202. package/dist-cjs/lib/validator.d.ts +33 -0
  203. package/dist-cjs/lib/validator.d.ts.map +1 -0
  204. package/dist-cjs/lib/validator.js +182 -0
  205. package/dist-cjs/lib/validator.js.map +1 -0
  206. package/dist-cjs/package.json +1 -0
  207. package/dist-cjs/types/index.d.ts +88 -0
  208. package/dist-cjs/types/index.d.ts.map +1 -0
  209. package/dist-cjs/types/index.js +4 -0
  210. package/dist-cjs/types/index.js.map +1 -0
  211. package/package.json +125 -0
@@ -0,0 +1,2 @@
1
+ export * from '../../assertion/diff-recordings-vs-spec.js';
2
+ //# sourceMappingURL=diff-recordings-vs-spec.d.ts.map
@@ -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,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("../../assertion/diff-recordings-vs-spec.js"), exports);
18
+ //# sourceMappingURL=diff-recordings-vs-spec.js.map
@@ -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,6EAA2D"}
@@ -0,0 +1,2 @@
1
+ export * from '../recorder.js';
2
+ //# sourceMappingURL=recorder.d.ts.map
@@ -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,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ // Legacy recorder relocated under lib/tools. Prefer using lib/recorder for runtime decisions.
18
+ __exportStar(require("../recorder.js"), exports);
19
+ //# sourceMappingURL=recorder.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"recorder.js","sourceRoot":"","sources":["../../../src/lib/tools/recorder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8FAA8F;AAC9F,iDAA+B"}
@@ -0,0 +1,2 @@
1
+ export * from '../../assertion/summarize-recordings.js';
2
+ //# sourceMappingURL=summarize-recordings.d.ts.map
@@ -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,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("../../assertion/summarize-recordings.js"), exports);
18
+ //# sourceMappingURL=summarize-recordings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summarize-recordings.js","sourceRoot":"","sources":["../../../src/lib/tools/summarize-recordings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0EAAwD"}
@@ -0,0 +1,2 @@
1
+ export { normalizeType, refNameOf, dedupeFields } from '../extractor/src/lib/type-utils.js';
2
+ //# sourceMappingURL=type-utils.d.ts.map
@@ -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,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.dedupeFields = exports.refNameOf = exports.normalizeType = void 0;
4
+ var type_utils_js_1 = require("../extractor/src/lib/type-utils.js");
5
+ Object.defineProperty(exports, "normalizeType", { enumerable: true, get: function () { return type_utils_js_1.normalizeType; } });
6
+ Object.defineProperty(exports, "refNameOf", { enumerable: true, get: function () { return type_utils_js_1.refNameOf; } });
7
+ Object.defineProperty(exports, "dedupeFields", { enumerable: true, get: function () { return type_utils_js_1.dedupeFields; } });
8
+ //# sourceMappingURL=type-utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/lib/type-utils.ts"],"names":[],"mappings":";;;AAAA,oEAA4F;AAAnF,8GAAA,aAAa,OAAA;AAAE,0GAAA,SAAS,OAAA;AAAE,6GAAA,YAAY,OAAA"}
@@ -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,182 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateResponseShape = validateResponseShape;
4
+ exports._validateRouteContext = _validateRouteContext;
5
+ const responses_js_1 = require("./responses.js");
6
+ const recorder_js_1 = require("./recorder.js");
7
+ const config_js_1 = require("./config.js");
8
+ const isPrimitive = (t) => t === 'string' || t === 'number' || t === 'boolean';
9
+ const extractArrayInner = (typeStr) => { const m = /^array<(.+)>$/.exec(typeStr.trim()); return m ? m[1].trim() : null; };
10
+ const shouldTreatAsEnum = (typeStr) => /Enum$/.test(typeStr);
11
+ const shouldTreatAsObject = (spec) => { if (spec.children)
12
+ return true; if (spec.type === 'object')
13
+ return true; if (/^[A-Z][A-Za-z0-9]+$/.test(spec.type) && !shouldTreatAsEnum(spec.type))
14
+ return true; return false; };
15
+ const jsonPointerEscape = (seg) => seg.replace(/~/g, '~0').replace(/\//g, '~1');
16
+ const toExpectedDescriptor = (spec) => { const inner = extractArrayInner(spec.type); if (inner)
17
+ return `array<${inner}>`; if (spec.wrapper && spec.underlyingPrimitive)
18
+ return `${spec.underlyingPrimitive} (wrapper ${spec.rawRefName || spec.type})`; if (spec.enumValues?.length)
19
+ return `enum<${spec.underlyingPrimitive || 'string'}>[${spec.enumValues.join('|')}]`; if (spec.children || spec.type === 'object')
20
+ return 'object'; return spec.type; };
21
+ const actualDescriptor = (val) => { if (val === null)
22
+ return 'null'; if (Array.isArray(val))
23
+ return 'array'; return typeof val; };
24
+ function _validateRouteContext(routeCtx, body) {
25
+ if (!routeCtx.route || routeCtx.requiredFields.length === 0)
26
+ return; // no spec
27
+ if (body === null || typeof body !== 'object' || Array.isArray(body)) {
28
+ throw new Error(`Expected object response body to validate route required fields for ${routeCtx.route}`);
29
+ }
30
+ const options = { arraySampleLimit: 25 };
31
+ const errors = [];
32
+ const checkPrimitiveType = (val, expected) => typeof val === expected;
33
+ const validateGroup = (obj, specs, pointer, mode, optionalSpecsForExtras) => {
34
+ if (mode === 'required') {
35
+ const allowed = new Set();
36
+ for (const s of specs)
37
+ allowed.add(s.name);
38
+ if (optionalSpecsForExtras) {
39
+ for (const s of optionalSpecsForExtras)
40
+ allowed.add(s.name);
41
+ }
42
+ for (const key of Object.keys(obj)) {
43
+ if (!allowed.has(key)) {
44
+ const fieldPath = pointer ? `${pointer}/${jsonPointerEscape(key)}` : `/${jsonPointerEscape(key)}`;
45
+ errors.push(`[EXTRA] ${fieldPath} is not declared in spec`);
46
+ }
47
+ }
48
+ }
49
+ for (const spec of specs) {
50
+ const fieldPath = pointer ? `${pointer}/${jsonPointerEscape(spec.name)}` : `/${jsonPointerEscape(spec.name)}`;
51
+ const exists = spec.name in obj;
52
+ if (!exists) {
53
+ if (mode === 'required') {
54
+ errors.push(`[MISSING] ${fieldPath} expected ${toExpectedDescriptor(spec)}`);
55
+ }
56
+ continue;
57
+ }
58
+ const value = obj[spec.name];
59
+ if (value === null) {
60
+ errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got null`);
61
+ continue;
62
+ }
63
+ const inner = extractArrayInner(spec.type);
64
+ if (inner) {
65
+ if (!Array.isArray(value)) {
66
+ errors.push(`[TYPE] ${fieldPath} expected array<${inner}> but got ${actualDescriptor(value)}`);
67
+ }
68
+ else if (value.length > 0) {
69
+ const sample = value.slice(0, options.arraySampleLimit);
70
+ if (isPrimitive(inner)) {
71
+ for (let i = 0; i < sample.length; i++) {
72
+ const el = sample[i];
73
+ if (typeof el !== inner) {
74
+ errors.push(`[TYPE] ${fieldPath}/${i} expected ${inner} but got ${actualDescriptor(el)}`);
75
+ }
76
+ }
77
+ }
78
+ else if (spec.children) {
79
+ for (let i = 0; i < sample.length; i++) {
80
+ const el = sample[i];
81
+ if (el === null || typeof el !== 'object' || Array.isArray(el)) {
82
+ errors.push(`[TYPE] ${fieldPath}/${i} expected object but got ${actualDescriptor(el)}`);
83
+ continue;
84
+ }
85
+ validateGroup(el, spec.children.required || [], `${fieldPath}/${i}`, 'required', spec.children.optional);
86
+ if (spec.children.optional?.length) {
87
+ validateGroup(el, spec.children.optional, `${fieldPath}/${i}`, 'optional-present');
88
+ }
89
+ }
90
+ }
91
+ }
92
+ continue;
93
+ }
94
+ if (spec.wrapper && spec.underlyingPrimitive && isPrimitive(spec.underlyingPrimitive)) {
95
+ if (!checkPrimitiveType(value, spec.underlyingPrimitive)) {
96
+ errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got ${actualDescriptor(value)}`);
97
+ }
98
+ if (spec.enumValues && typeof value === 'string') {
99
+ if (!spec.enumValues.includes(value)) {
100
+ errors.push(`[ENUM] ${fieldPath} value ${JSON.stringify(value)} not in [${spec.enumValues.join(', ')}]`);
101
+ }
102
+ }
103
+ continue;
104
+ }
105
+ if (isPrimitive(spec.type)) {
106
+ if (!checkPrimitiveType(value, spec.type)) {
107
+ errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got ${actualDescriptor(value)}`);
108
+ }
109
+ if (spec.enumValues && typeof value === 'string') {
110
+ if (!spec.enumValues.includes(value)) {
111
+ errors.push(`[ENUM] ${fieldPath} value ${JSON.stringify(value)} not in [${spec.enumValues.join(', ')}]`);
112
+ }
113
+ }
114
+ continue;
115
+ }
116
+ if (shouldTreatAsEnum(spec.type)) {
117
+ if (typeof value !== 'string') {
118
+ errors.push(`[TYPE] ${fieldPath} expected ${toExpectedDescriptor(spec)} but got ${actualDescriptor(value)}`);
119
+ }
120
+ if (spec.enumValues && typeof value === 'string') {
121
+ if (!spec.enumValues.includes(value)) {
122
+ errors.push(`[ENUM] ${fieldPath} value ${JSON.stringify(value)} not in [${spec.enumValues.join(', ')}]`);
123
+ }
124
+ }
125
+ continue;
126
+ }
127
+ if (shouldTreatAsObject(spec)) {
128
+ if (typeof value !== 'object' || Array.isArray(value)) {
129
+ errors.push(`[TYPE] ${fieldPath} expected object but got ${actualDescriptor(value)}`);
130
+ continue;
131
+ }
132
+ if (spec.children) {
133
+ validateGroup(value, spec.children.required || [], fieldPath, 'required', spec.children.optional);
134
+ if (spec.children.optional?.length) {
135
+ validateGroup(value, spec.children.optional, fieldPath, 'optional-present');
136
+ }
137
+ }
138
+ continue;
139
+ }
140
+ }
141
+ };
142
+ validateGroup(body, routeCtx.requiredFields, '', 'required', routeCtx.optionalFields);
143
+ if (routeCtx.optionalFields.length) {
144
+ validateGroup(body, routeCtx.optionalFields, '', 'optional-present');
145
+ }
146
+ if (errors.length) {
147
+ const preview = errors.slice(0, 15).join('\n');
148
+ const extra = errors.length > 15 ? `\n...and ${errors.length - 15} more` : '';
149
+ throw new Error(`Response shape errors for route ${routeCtx.method || '*'} ${routeCtx.status || '*'} ${routeCtx.route}:\n${preview}${extra}`);
150
+ }
151
+ }
152
+ function validateResponseShape(spec, body, options = {}) {
153
+ const routeCtx = (0, responses_js_1.pickRoute)(spec.path, {
154
+ method: spec.method || options.method,
155
+ status: spec.status || options.status,
156
+ responsesFilePath: options.responsesFilePath,
157
+ configPath: options.configPath,
158
+ });
159
+ const cfg = (0, config_js_1.buildConfig)(options.configPath);
160
+ const globalThrow = cfg.resolved.validate.throwOnValidationFail;
161
+ const shouldThrow = options.throw !== undefined ? options.throw : globalThrow;
162
+ const globalRecord = cfg.resolved.validate.recordResponses;
163
+ const doRecord = options.record !== undefined ? !!options.record : globalRecord;
164
+ if (doRecord) {
165
+ let label;
166
+ if (typeof options.record === 'object' && options.record)
167
+ label = options.record.label;
168
+ (0, recorder_js_1.recordBody)({ routeCtx, body, label });
169
+ }
170
+ try {
171
+ _validateRouteContext(routeCtx, body);
172
+ return { ok: true, response: body, schema: { required: routeCtx.requiredFields, optional: routeCtx.optionalFields }, routeContext: routeCtx };
173
+ }
174
+ catch (err) {
175
+ if (shouldThrow)
176
+ throw err;
177
+ const msg = err.message || '';
178
+ const lines = msg.split('\n');
179
+ return { ok: false, errors: lines.slice(1).filter(Boolean), response: body, schema: { required: routeCtx.requiredFields, optional: routeCtx.optionalFields }, routeContext: routeCtx };
180
+ }
181
+ }
182
+ //# sourceMappingURL=validator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/lib/validator.ts"],"names":[],"mappings":";;AA2GA,sDA0BC;AAEQ,sDAAqB;AAtI9B,iDAA2C;AAC3C,+CAA2C;AAC3C,2CAA0C;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,SAAgB,qBAAqB,CAAC,IAAwD,EAAE,IAAa,EAAE,UAA2B,EAAE;IAC1I,MAAM,QAAQ,GAAG,IAAA,wBAAS,EAAC,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,IAAA,uBAAW,EAAC,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,IAAA,wBAAU,EAAC,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"}
@@ -0,0 +1 @@
1
+ {"type":"commonjs"}
@@ -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,4 @@
1
+ "use strict";
2
+ /* Unified type definitions combining assertion ResponseFieldSpec and extractor FieldSpec */
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA,4FAA4F"}
package/package.json ADDED
@@ -0,0 +1,125 @@
1
+ {
2
+ "name": "assert-json-body",
3
+ "version": "1.0.2",
4
+ "description": "OpenAPI response body extraction and JSON shape assertion toolkit (framework-agnostic)",
5
+ "type": "module",
6
+ "main": "./dist-cjs/index.js",
7
+ "exports": {
8
+ ".": {
9
+ "import": "./dist/index.js",
10
+ "require": "./dist-cjs/index.js",
11
+ "types": "./dist/index.d.ts"
12
+ },
13
+ "./base": {
14
+ "import": "./dist/base.js",
15
+ "require": "./dist-cjs/base.js",
16
+ "types": "./dist/base.d.ts"
17
+ },
18
+ "./cli": {
19
+ "import": "./dist/cli/index.js",
20
+ "require": "./dist-cjs/cli/index.js",
21
+ "types": "./dist/cli/index.d.ts"
22
+ },
23
+ "./package.json": "./package.json"
24
+ },
25
+ "bin": {
26
+ "assert-json-body": "dist/cli/index.js"
27
+ },
28
+ "files": [
29
+ "dist",
30
+ "dist-cjs",
31
+ "README.md",
32
+ "LICENSE"
33
+ ],
34
+ "scripts": {
35
+ "build:esm": "tsc -p tsconfig.json",
36
+ "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist-cjs/package.json",
37
+ "build": "npm run build:esm && npm run build:cjs",
38
+ "dev": "tsx watch src/index.ts",
39
+ "dev:cli": "tsx watch src/cli/index.ts",
40
+ "generate": "node ./dist/cli/index.js extract",
41
+ "config:init": "node ./dist/cli/index.js init-config",
42
+ "test": "vitest run -c vitest.config.ts",
43
+ "test:watch": "vitest -c vitest.config.ts",
44
+ "test:integration": "vitest run -c vitest.config.integration.ts",
45
+ "lint": "eslint .",
46
+ "format": "prettier --write .",
47
+ "prepare": "npm run build",
48
+ "release": "semantic-release",
49
+ "prepare:husky": "husky install"
50
+ },
51
+ "repository": {
52
+ "type": "git",
53
+ "url": "git+https://github.com/camunda/assert-json-body.git"
54
+ },
55
+ "keywords": [
56
+ "openapi",
57
+ "playwright",
58
+ "testing",
59
+ "assertion",
60
+ "cli"
61
+ ],
62
+ "author": "Josh Wulf <josh.wulf@camunda.com>",
63
+ "license": "ISC",
64
+ "bugs": {
65
+ "url": "https://github.com/camunda/assert-json-body/issues"
66
+ },
67
+ "homepage": "https://github.com/camunda/assert-json-body#readme",
68
+ "dependencies": {
69
+ "js-yaml": "^4.1.0",
70
+ "openapi-types": "^12.1.3",
71
+ "undici": "^6.19.8"
72
+ },
73
+ "devDependencies": {
74
+ "@commitlint/cli": "^19.4.0",
75
+ "@commitlint/config-conventional": "^19.4.0",
76
+ "@eslint/js": "^9.36.0",
77
+ "@semantic-release/changelog": "^6.0.3",
78
+ "@semantic-release/commit-analyzer": "^13.0.0",
79
+ "@semantic-release/git": "^10.0.1",
80
+ "@semantic-release/github": "^10.0.6",
81
+ "@semantic-release/npm": "^11.0.2",
82
+ "@semantic-release/release-notes-generator": "^14.0.0",
83
+ "@types/js-yaml": "^4.0.9",
84
+ "@types/node": "^20.19.17",
85
+ "eslint": "^8.57.1",
86
+ "globals": "^16.4.0",
87
+ "husky": "^9.0.11",
88
+ "prettier": "^3.2.5",
89
+ "semantic-release": "^23.0.0",
90
+ "tsx": "^4.7.0",
91
+ "typescript": "^5.4.5",
92
+ "typescript-eslint": "^8.44.1",
93
+ "vitest": "^2.0.5"
94
+ },
95
+ "publishConfig": {
96
+ "access": "public"
97
+ },
98
+ "release": {
99
+ "branches": [
100
+ "main"
101
+ ],
102
+ "plugins": [
103
+ "@semantic-release/commit-analyzer",
104
+ "@semantic-release/release-notes-generator",
105
+ [
106
+ "@semantic-release/changelog",
107
+ {
108
+ "changelogFile": "CHANGELOG.md"
109
+ }
110
+ ],
111
+ "@semantic-release/npm",
112
+ [
113
+ "@semantic-release/git",
114
+ {
115
+ "assets": [
116
+ "CHANGELOG.md",
117
+ "package.json"
118
+ ],
119
+ "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
120
+ }
121
+ ],
122
+ "@semantic-release/github"
123
+ ]
124
+ }
125
+ }