@thymian/rules-api-description-validation 0.1.10 → 0.1.11-canary.20260624-288c194

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 (19) hide show
  1. package/dist/rules/request-body-conforms-to-schema.rule.d.ts.map +1 -1
  2. package/dist/rules/request-body-conforms-to-schema.rule.js +46 -18
  3. package/dist/rules/request-body-conforms-to-schema.rule.js.map +1 -1
  4. package/dist/rules/request-headers-conform-to-schema.rule.d.ts.map +1 -1
  5. package/dist/rules/request-headers-conform-to-schema.rule.js +46 -18
  6. package/dist/rules/request-headers-conform-to-schema.rule.js.map +1 -1
  7. package/dist/rules/request-path-parameters-conform-to-schema.rule.d.ts.map +1 -1
  8. package/dist/rules/request-path-parameters-conform-to-schema.rule.js +46 -18
  9. package/dist/rules/request-path-parameters-conform-to-schema.rule.js.map +1 -1
  10. package/dist/rules/request-query-parameters-conform-to-schema.rule.d.ts.map +1 -1
  11. package/dist/rules/request-query-parameters-conform-to-schema.rule.js +46 -18
  12. package/dist/rules/request-query-parameters-conform-to-schema.rule.js.map +1 -1
  13. package/dist/rules/response-body-conforms-to-schema.rule.d.ts.map +1 -1
  14. package/dist/rules/response-body-conforms-to-schema.rule.js +48 -34
  15. package/dist/rules/response-body-conforms-to-schema.rule.js.map +1 -1
  16. package/dist/rules/response-headers-conform-to-schema.rule.d.ts.map +1 -1
  17. package/dist/rules/response-headers-conform-to-schema.rule.js +48 -34
  18. package/dist/rules/response-headers-conform-to-schema.rule.js.map +1 -1
  19. package/package.json +2 -2
package/dist/rules/request-body-conforms-to-schema.rule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-body-conforms-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-body-conforms-to-schema.rule.ts"],"names":[],"mappings":";AASA,wBAwCU"}
1
+ {"version":3,"file":"request-body-conforms-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-body-conforms-to-schema.rule.ts"],"names":[],"mappings":";AAWA,wBAkEU"}
package/dist/rules/request-body-conforms-to-schema.rule.js CHANGED
@@ -1,24 +1,52 @@
1
- import { constant, httpRule, validateBodyForRequest, } from '@thymian/core';
1
+ import { constant, httpRule, httpTestResultToRuleFindings, validateBodyForRequest, } from '@thymian/core';
2
2
  export default httpRule('thymian/request-body-must-conform-to-schema')
3
3
  .severity('error')
4
4
  .type('analytics')
5
5
  .description('Request body must conform to the API description schema.')
6
- .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
7
- if (typeof location === 'string') {
8
- return false;
9
- }
10
- const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
11
- if (!transaction) {
12
- return false;
13
- }
14
- const results = validateBodyForRequest(request.body, transaction.thymianReq);
15
- const failures = results.filter((r) => r.type === 'assertion-failure');
16
- if (failures.length > 0) {
17
- return {
18
- message: failures.map((f) => f.message).join('\n'),
19
- };
20
- }
21
- return false;
22
- }))
6
+ .rule(async (ctx) => {
7
+ return ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
8
+ if (typeof location === 'string') {
9
+ return [
10
+ {
11
+ location,
12
+ findings: [
13
+ {
14
+ title: 'thymian/request-body-must-conform-to-schema',
15
+ kind: 'rule-skip',
16
+ message: `No matching endpoint found in corresponding API description document.`,
17
+ },
18
+ ],
19
+ },
20
+ ];
21
+ }
22
+ const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
23
+ if (!transaction) {
24
+ return [
25
+ {
26
+ location,
27
+ findings: [
28
+ {
29
+ title: 'thymian/request-body-must-conform-to-schema',
30
+ kind: 'rule-skip',
31
+ message: `Can't find transaction with given ID ${location.elementId} in Thymian format.`,
32
+ },
33
+ ],
34
+ },
35
+ ];
36
+ }
37
+ const results = validateBodyForRequest(request.body, transaction.thymianReq);
38
+ const failures = results.filter((r) => r.type === 'assertion-failure');
39
+ if (failures.length > 0) {
40
+ return [
41
+ {
42
+ location,
43
+ violation: { message: `${failures.length} assertion(s) failed` },
44
+ findings: httpTestResultToRuleFindings(results),
45
+ },
46
+ ];
47
+ }
48
+ return [{ location, findings: httpTestResultToRuleFindings(results) }];
49
+ });
50
+ })
23
51
  .done();
24
52
  //# sourceMappingURL=request-body-conforms-to-schema.rule.js.map
package/dist/rules/request-body-conforms-to-schema.rule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-body-conforms-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-body-conforms-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EAER,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,6CAA6C,CAAC;KACnE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,0DAA0D,CAAC;KACvE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,wBAAwB,CAC1B,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EAC/B,EAAE;IACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,sBAAsB,CACpC,OAAO,CAAC,IAAI,EACZ,WAAW,CAAC,UAAU,CACvB,CAAC;IACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CACF;KACA,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"request-body-conforms-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-body-conforms-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EACR,4BAA4B,EAG5B,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,6CAA6C,CAAC;KACnE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,0DAA0D,CAAC;KACvE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,OAAO,GAAG,CAAC,wBAAwB,CACjC,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EACf,EAAE;QAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,6CAA6C;4BACpD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,uEAAuE;yBACjF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,6CAA6C;4BACpD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,wCAAwC,QAAQ,CAAC,SAAS,qBAAqB;yBACzF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,sBAAsB,CACpC,OAAO,CAAC,IAAI,EACZ,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;QAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO;gBACL;oBACE,QAAQ;oBACR,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,EAAE;oBAChE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC;iBAChD;aACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;KACD,IAAI,EAAE,CAAC"}
package/dist/rules/request-headers-conform-to-schema.rule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-headers-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-headers-conform-to-schema.rule.ts"],"names":[],"mappings":";AASA,wBA2CU"}
1
+ {"version":3,"file":"request-headers-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-headers-conform-to-schema.rule.ts"],"names":[],"mappings":";AAWA,wBAqEU"}
package/dist/rules/request-headers-conform-to-schema.rule.js CHANGED
@@ -1,25 +1,53 @@
1
- import { constant, httpRule, validateRequestHeaders, } from '@thymian/core';
1
+ import { constant, httpRule, httpTestResultToRuleFindings, validateRequestHeaders, } from '@thymian/core';
2
2
  export default httpRule('thymian/request-headers-must-conform-to-schema')
3
3
  .severity('error')
4
4
  .type('analytics')
5
5
  .description('Request headers must conform to the API description schema. Checks for missing required headers, additional undocumented headers, and validates existing headers against their schema.')
6
6
  .summary('Request headers must conform to the API description schema.')
7
- .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
8
- if (typeof location === 'string') {
9
- return false;
10
- }
11
- const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
12
- if (!transaction) {
13
- return false;
14
- }
15
- const results = validateRequestHeaders(request.headers ?? {}, transaction.thymianReq);
16
- const failures = results.filter((r) => r.type === 'assertion-failure');
17
- if (failures.length > 0) {
18
- return {
19
- message: failures.map((f) => f.message).join('\n'),
20
- };
21
- }
22
- return false;
23
- }))
7
+ .rule(async (ctx) => {
8
+ return ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
9
+ if (typeof location === 'string') {
10
+ return [
11
+ {
12
+ location,
13
+ findings: [
14
+ {
15
+ title: 'thymian/request-headers-must-conform-to-schema',
16
+ kind: 'rule-skip',
17
+ message: `No matching endpoint found in corresponding API description document.`,
18
+ },
19
+ ],
20
+ },
21
+ ];
22
+ }
23
+ const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
24
+ if (!transaction) {
25
+ return [
26
+ {
27
+ location,
28
+ findings: [
29
+ {
30
+ title: 'thymian/request-headers-must-conform-to-schema',
31
+ kind: 'rule-skip',
32
+ message: `Can't find transaction with given ID ${location.elementId} in Thymian format.`,
33
+ },
34
+ ],
35
+ },
36
+ ];
37
+ }
38
+ const results = validateRequestHeaders(request.headers ?? {}, transaction.thymianReq);
39
+ const failures = results.filter((r) => r.type === 'assertion-failure');
40
+ if (failures.length > 0) {
41
+ return [
42
+ {
43
+ location,
44
+ violation: { message: `${failures.length} assertion(s) failed` },
45
+ findings: httpTestResultToRuleFindings(results),
46
+ },
47
+ ];
48
+ }
49
+ return [{ location, findings: httpTestResultToRuleFindings(results) }];
50
+ });
51
+ })
24
52
  .done();
25
53
  //# sourceMappingURL=request-headers-conform-to-schema.rule.js.map
package/dist/rules/request-headers-conform-to-schema.rule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-headers-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-headers-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EAER,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,gDAAgD,CAAC;KACtE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CACV,wLAAwL,CACzL;KACA,OAAO,CAAC,6DAA6D,CAAC;KACtE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,wBAAwB,CAC1B,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EAC/B,EAAE;IACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,sBAAsB,CACpC,OAAO,CAAC,OAAO,IAAI,EAAE,EACrB,WAAW,CAAC,UAAU,CACvB,CAAC;IACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CACF;KACA,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"request-headers-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-headers-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EACR,4BAA4B,EAG5B,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,gDAAgD,CAAC;KACtE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CACV,wLAAwL,CACzL;KACA,OAAO,CAAC,6DAA6D,CAAC;KACtE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,OAAO,GAAG,CAAC,wBAAwB,CACjC,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EACf,EAAE;QAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,gDAAgD;4BACvD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,uEAAuE;yBACjF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,gDAAgD;4BACvD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,wCAAwC,QAAQ,CAAC,SAAS,qBAAqB;yBACzF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,sBAAsB,CACpC,OAAO,CAAC,OAAO,IAAI,EAAE,EACrB,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;QAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO;gBACL;oBACE,QAAQ;oBACR,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,EAAE;oBAChE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC;iBAChD;aACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;KACD,IAAI,EAAE,CAAC"}
package/dist/rules/request-path-parameters-conform-to-schema.rule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-path-parameters-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-path-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":";AASA,wBA6CU"}
1
+ {"version":3,"file":"request-path-parameters-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-path-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":";AAWA,wBAyEU"}
package/dist/rules/request-path-parameters-conform-to-schema.rule.js CHANGED
@@ -1,25 +1,53 @@
1
- import { constant, httpRule, validateRequestPathParameters, } from '@thymian/core';
1
+ import { constant, httpRule, httpTestResultToRuleFindings, validateRequestPathParameters, } from '@thymian/core';
2
2
  export default httpRule('thymian/request-path-parameters-must-conform-to-schema')
3
3
  .severity('error')
4
4
  .type('analytics')
5
5
  .description('Request path parameters must conform to the API description schema. Validates extracted path parameters against their schema definitions.')
6
6
  .summary('Request path parameters must conform to the API description schema')
7
- .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
8
- if (typeof location === 'string') {
9
- return false;
10
- }
11
- const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
12
- if (!transaction) {
13
- return false;
14
- }
15
- const results = validateRequestPathParameters(request.path, transaction.thymianReq);
16
- const failures = results.filter((r) => r.type === 'assertion-failure');
17
- if (failures.length > 0) {
18
- return {
19
- message: failures.map((f) => f.message).join('\n'),
20
- };
21
- }
22
- return false;
23
- }))
7
+ .rule(async (ctx) => {
8
+ return ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
9
+ if (typeof location === 'string') {
10
+ return [
11
+ {
12
+ location,
13
+ findings: [
14
+ {
15
+ title: 'thymian/request-path-parameters-must-conform-to-schema',
16
+ kind: 'rule-skip',
17
+ message: `No matching endpoint found in corresponding API description document.`,
18
+ },
19
+ ],
20
+ },
21
+ ];
22
+ }
23
+ const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
24
+ if (!transaction) {
25
+ return [
26
+ {
27
+ location,
28
+ findings: [
29
+ {
30
+ title: 'thymian/request-path-parameters-must-conform-to-schema',
31
+ kind: 'rule-skip',
32
+ message: `Can't find transaction with given ID ${location.elementId} in Thymian format.`,
33
+ },
34
+ ],
35
+ },
36
+ ];
37
+ }
38
+ const results = validateRequestPathParameters(request.path, transaction.thymianReq);
39
+ const failures = results.filter((r) => r.type === 'assertion-failure');
40
+ if (failures.length > 0) {
41
+ return [
42
+ {
43
+ location,
44
+ violation: { message: `${failures.length} assertion(s) failed` },
45
+ findings: httpTestResultToRuleFindings(results),
46
+ },
47
+ ];
48
+ }
49
+ return [{ location, findings: httpTestResultToRuleFindings(results) }];
50
+ });
51
+ })
24
52
  .done();
25
53
  //# sourceMappingURL=request-path-parameters-conform-to-schema.rule.js.map
package/dist/rules/request-path-parameters-conform-to-schema.rule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-path-parameters-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-path-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EAER,6BAA6B,GAC9B,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CACrB,wDAAwD,CACzD;KACE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CACV,2IAA2I,CAC5I;KACA,OAAO,CAAC,oEAAoE,CAAC;KAC7E,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,wBAAwB,CAC1B,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EAC/B,EAAE;IACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,6BAA6B,CAC3C,OAAO,CAAC,IAAI,EACZ,WAAW,CAAC,UAAU,CACvB,CAAC;IACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CACF;KACA,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"request-path-parameters-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-path-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EACR,4BAA4B,EAG5B,6BAA6B,GAC9B,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CACrB,wDAAwD,CACzD;KACE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CACV,2IAA2I,CAC5I;KACA,OAAO,CAAC,oEAAoE,CAAC;KAC7E,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,OAAO,GAAG,CAAC,wBAAwB,CACjC,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EACf,EAAE;QAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EACH,wDAAwD;4BAC1D,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,uEAAuE;yBACjF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EACH,wDAAwD;4BAC1D,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,wCAAwC,QAAQ,CAAC,SAAS,qBAAqB;yBACzF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,6BAA6B,CAC3C,OAAO,CAAC,IAAI,EACZ,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;QAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO;gBACL;oBACE,QAAQ;oBACR,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,EAAE;oBAChE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC;iBAChD;aACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;KACD,IAAI,EAAE,CAAC"}
package/dist/rules/request-query-parameters-conform-to-schema.rule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-query-parameters-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-query-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":";AASA,wBA+CU"}
1
+ {"version":3,"file":"request-query-parameters-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/request-query-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":";AAWA,wBA2EU"}
package/dist/rules/request-query-parameters-conform-to-schema.rule.js CHANGED
@@ -1,25 +1,53 @@
1
- import { constant, httpRule, validateRequestQueryParameters, } from '@thymian/core';
1
+ import { constant, httpRule, httpTestResultToRuleFindings, validateRequestQueryParameters, } from '@thymian/core';
2
2
  export default httpRule('thymian/request-query-parameters-must-conform-to-schema')
3
3
  .severity('error')
4
4
  .type('analytics')
5
5
  .description('Request query parameters must conform to the API description schema. Checks for missing required parameters, additional undocumented parameters, and validates existing parameters against their schema.')
6
6
  .summary('Request query parameters must conform to the API description schema')
7
- .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
8
- if (typeof location === 'string') {
9
- return false;
10
- }
11
- const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
12
- if (!transaction) {
13
- return false;
14
- }
15
- const results = validateRequestQueryParameters(request.path, transaction.thymianReq);
16
- const failures = results.filter((r) => r.type === 'assertion-failure');
17
- if (failures.length > 0) {
18
- return {
19
- message: failures.map((f) => f.message).join('\n'),
20
- };
21
- }
22
- return false;
23
- }))
7
+ .rule(async (ctx) => {
8
+ return ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
9
+ if (typeof location === 'string') {
10
+ return [
11
+ {
12
+ location,
13
+ findings: [
14
+ {
15
+ title: 'thymian/request-query-parameters-must-conform-to-schema',
16
+ kind: 'rule-skip',
17
+ message: `No matching endpoint found in corresponding API description document.`,
18
+ },
19
+ ],
20
+ },
21
+ ];
22
+ }
23
+ const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
24
+ if (!transaction) {
25
+ return [
26
+ {
27
+ location,
28
+ findings: [
29
+ {
30
+ title: 'thymian/request-query-parameters-must-conform-to-schema',
31
+ kind: 'rule-skip',
32
+ message: `Can't find transaction with given ID ${location.elementId} in Thymian format.`,
33
+ },
34
+ ],
35
+ },
36
+ ];
37
+ }
38
+ const results = validateRequestQueryParameters(request.path, transaction.thymianReq);
39
+ const failures = results.filter((r) => r.type === 'assertion-failure');
40
+ if (failures.length > 0) {
41
+ return [
42
+ {
43
+ location,
44
+ violation: { message: `${failures.length} assertion(s) failed` },
45
+ findings: httpTestResultToRuleFindings(results),
46
+ },
47
+ ];
48
+ }
49
+ return [{ location, findings: httpTestResultToRuleFindings(results) }];
50
+ });
51
+ })
24
52
  .done();
25
53
  //# sourceMappingURL=request-query-parameters-conform-to-schema.rule.js.map
package/dist/rules/request-query-parameters-conform-to-schema.rule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-query-parameters-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-query-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EAER,8BAA8B,GAC/B,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CACrB,yDAAyD,CAC1D;KACE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CACV,0MAA0M,CAC3M;KACA,OAAO,CACN,qEAAqE,CACtE;KACA,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,wBAAwB,CAC1B,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EAC/B,EAAE;IACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,8BAA8B,CAC5C,OAAO,CAAC,IAAI,EACZ,WAAW,CAAC,UAAU,CACvB,CAAC;IACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CACF;KACA,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"request-query-parameters-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/request-query-parameters-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,QAAQ,EACR,4BAA4B,EAG5B,8BAA8B,GAC/B,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CACrB,yDAAyD,CAC1D;KACE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CACV,0MAA0M,CAC3M;KACA,OAAO,CACN,qEAAqE,CACtE;KACA,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,OAAO,GAAG,CAAC,wBAAwB,CACjC,QAAQ,CAAC,IAAI,CAAC,EACd,CACE,OAAoB,EACpB,SAAuB,EACvB,QAA+B,EACf,EAAE;QAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EACH,yDAAyD;4BAC3D,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,uEAAuE;yBACjF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EACH,yDAAyD;4BAC3D,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,wCAAwC,QAAQ,CAAC,SAAS,qBAAqB;yBACzF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,8BAA8B,CAC5C,OAAO,CAAC,IAAI,EACZ,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;QAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO;gBACL;oBACE,QAAQ;oBACR,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,EAAE;oBAChE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC;iBAChD;aACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;KACD,IAAI,EAAE,CAAC"}
package/dist/rules/response-body-conforms-to-schema.rule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"response-body-conforms-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/response-body-conforms-to-schema.rule.ts"],"names":[],"mappings":";AAgBA,wBAyEU"}
1
+ {"version":3,"file":"response-body-conforms-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/response-body-conforms-to-schema.rule.ts"],"names":[],"mappings":";AAcA,wBA+EU"}
package/dist/rules/response-body-conforms-to-schema.rule.js CHANGED
@@ -1,43 +1,57 @@
1
- import { httpRule, or, singleTestCase, statusCodeRange, successfulStatusCode, validateBodyForResponse, } from '@thymian/core';
1
+ import { httpRule, httpTestResultToRuleFindings, or, singleTestCase, statusCodeRange, successfulStatusCode, validateBodyForResponse, } from '@thymian/core';
2
2
  export default httpRule('thymian/response-body-must-conforms-to-schema')
3
3
  .severity('error')
4
4
  .type('test', 'analytics')
5
5
  .description('Response body for 2xx and 4xx responses must conform to the API description schema.')
6
6
  .summary('Response body must conform to the API description schema.')
7
- .rule((ctx) => ctx.validateHttpTransactions(or(successfulStatusCode(), statusCodeRange(400, 499)), (_request, response, location) => {
8
- if (typeof location === 'string') {
9
- return false;
10
- }
11
- const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
12
- if (!transaction) {
13
- return false;
14
- }
15
- const results = validateBodyForResponse(response.body, transaction.thymianRes);
16
- const failures = results.filter((r) => r.type === 'assertion-failure');
17
- if (failures.length > 0) {
18
- return {
19
- message: failures.map((f) => f.message).join('\n'),
20
- };
21
- }
22
- return false;
23
- }))
24
- .overrideTest(async (ctx) => {
25
- const testResult = await ctx.runHttpTest(singleTestCase()
26
- .forTransactionsWith(or(successfulStatusCode(), statusCodeRange(400, 499)))
27
- .run({ checkBody: true })
28
- .done());
29
- return testResult.cases
30
- .filter((testCase) => testCase.status === 'failed')
31
- .flatMap((testCase) => {
32
- const failures = testCase.results.filter((r) => r.type === 'assertion-failure' && !!r.transaction);
33
- return failures.map((failure) => ({
34
- location: {
35
- elementType: 'edge',
36
- elementId: failure.transaction.transactionId,
37
- },
38
- message: failure.message,
39
- }));
7
+ .rule(async (ctx) => {
8
+ return ctx.validateHttpTransactions(or(successfulStatusCode(), statusCodeRange(400, 499)), (_request, response, location) => {
9
+ if (typeof location === 'string') {
10
+ return [
11
+ {
12
+ location,
13
+ findings: [
14
+ {
15
+ title: 'thymian/response-body-must-conforms-to-schema',
16
+ kind: 'rule-skip',
17
+ message: `No matching endpoint found in corresponding API description document.`,
18
+ },
19
+ ],
20
+ },
21
+ ];
22
+ }
23
+ const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
24
+ if (!transaction) {
25
+ return [
26
+ {
27
+ location,
28
+ findings: [
29
+ {
30
+ title: 'thymian/response-body-must-conforms-to-schema',
31
+ kind: 'rule-skip',
32
+ message: `Can't find transaction with given ID ${location.elementId} in Thymian format.`,
33
+ },
34
+ ],
35
+ },
36
+ ];
37
+ }
38
+ const results = validateBodyForResponse(response.body, transaction.thymianRes);
39
+ const failures = results.filter((r) => r.type === 'assertion-failure');
40
+ if (failures.length > 0) {
41
+ return [
42
+ {
43
+ location,
44
+ violation: { message: `${failures.length} assertion(s) failed` },
45
+ findings: httpTestResultToRuleFindings(results),
46
+ },
47
+ ];
48
+ }
49
+ return [{ location, findings: httpTestResultToRuleFindings(results) }];
40
50
  });
41
51
  })
52
+ .overrideTest((ctx) => ctx.httpTest(singleTestCase()
53
+ .forTransactionsWith(or(successfulStatusCode(), statusCodeRange(400, 499)))
54
+ .run({ checkBody: true })
55
+ .done()))
42
56
  .done();
43
57
  //# sourceMappingURL=response-body-conforms-to-schema.rule.js.map
package/dist/rules/response-body-conforms-to-schema.rule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"response-body-conforms-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/response-body-conforms-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,QAAQ,EAER,EAAE,EAGF,cAAc,EACd,eAAe,EACf,oBAAoB,EAEpB,uBAAuB,GACxB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,+CAA+C,CAAC;KACrE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;KACzB,WAAW,CACV,qFAAqF,CACtF;KACA,OAAO,CAAC,2DAA2D,CAAC;KACpE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,wBAAwB,CAC1B,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACrD,CACE,QAAqB,EACrB,QAAsB,EACtB,QAA+B,EAC/B,EAAE;IACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,uBAAuB,CACrC,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,UAAU,CACvB,CAAC;IACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CACF;KACA,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAC1B,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,WAAW,CACtC,cAAc,EAAE;SACb,mBAAmB,CAClB,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACtD;SACA,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;SACxB,IAAI,EAAE,CACV,CAAC;IAEF,OAAO,UAAU,CAAC,KAAK;SACpB,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC;SAClD,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CACtC,CACE,CAAC,EAE0D,EAAE,CAC7D,CAAC,CAAC,IAAI,KAAK,mBAAmB,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CACpD,CAAC;QAEF,OAAO,QAAQ,CAAC,GAAG,CAAgB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC/C,QAAQ,EAAE;gBACR,WAAW,EAAE,MAAM;gBACnB,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,aAAa;aAC7C;YACD,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;KACD,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"response-body-conforms-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/response-body-conforms-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,EACR,4BAA4B,EAC5B,EAAE,EAGF,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,+CAA+C,CAAC;KACrE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;KACzB,WAAW,CACV,qFAAqF,CACtF;KACA,OAAO,CAAC,2DAA2D,CAAC;KACpE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,OAAO,GAAG,CAAC,wBAAwB,CACjC,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACrD,CACE,QAAqB,EACrB,QAAsB,EACtB,QAA+B,EACf,EAAE;QAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,+CAA+C;4BACtD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,uEAAuE;yBACjF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,+CAA+C;4BACtD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,wCAAwC,QAAQ,CAAC,SAAS,qBAAqB;yBACzF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,uBAAuB,CACrC,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;QAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO;gBACL;oBACE,QAAQ;oBACR,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,EAAE;oBAChE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC;iBAChD;aACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;KACD,YAAY,CAAC,CAAC,GAAG,EAAE,EAAE,CACpB,GAAG,CAAC,QAAQ,CACV,cAAc,EAAE;KACb,mBAAmB,CAClB,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACtD;KACA,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;KACxB,IAAI,EAAE,CACV,CACF;KACA,IAAI,EAAE,CAAC"}
package/dist/rules/response-headers-conform-to-schema.rule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"response-headers-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/response-headers-conform-to-schema.rule.ts"],"names":[],"mappings":";AAgBA,wBAyEU"}
1
+ {"version":3,"file":"response-headers-conform-to-schema.rule.d.ts","sourceRoot":"","sources":["../../src/rules/response-headers-conform-to-schema.rule.ts"],"names":[],"mappings":";AAcA,wBA+EU"}
package/dist/rules/response-headers-conform-to-schema.rule.js CHANGED
@@ -1,43 +1,57 @@
1
- import { httpRule, or, singleTestCase, statusCodeRange, successfulStatusCode, validateHeaders, } from '@thymian/core';
1
+ import { httpRule, httpTestResultToRuleFindings, or, singleTestCase, statusCodeRange, successfulStatusCode, validateHeaders, } from '@thymian/core';
2
2
  export default httpRule('thymian/response-headers-must-conform-to-schema')
3
3
  .severity('error')
4
4
  .type('test', 'analytics')
5
5
  .description('Response headers must conform to the API description schema. Checks for missing required headers, additional undocumented headers, and validates existing headers against their schema.')
6
6
  .summary('Response headers must conform to the API description schema')
7
- .rule((ctx) => ctx.validateHttpTransactions(or(successfulStatusCode(), statusCodeRange(400, 499)), (_request, response, location) => {
8
- if (typeof location === 'string') {
9
- return false;
10
- }
11
- const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
12
- if (!transaction) {
13
- return false;
14
- }
15
- const results = validateHeaders(response.headers, transaction.thymianRes);
16
- const failures = results.filter((r) => r.type === 'assertion-failure');
17
- if (failures.length > 0) {
18
- return {
19
- message: failures.map((f) => f.message).join('\n'),
20
- };
21
- }
22
- return false;
23
- }))
24
- .overrideTest(async (ctx) => {
25
- const testResult = await ctx.runHttpTest(singleTestCase()
26
- .forTransactionsWith(or(successfulStatusCode(), statusCodeRange(400, 499)))
27
- .run({ checkHeaders: true })
28
- .done());
29
- return testResult.cases
30
- .filter((testCase) => testCase.status === 'failed')
31
- .flatMap((testCase) => {
32
- const failures = testCase.results.filter((r) => r.type === 'assertion-failure' && !!r.transaction);
33
- return failures.map((failure) => ({
34
- location: {
35
- elementType: 'edge',
36
- elementId: failure.transaction.transactionId,
37
- },
38
- message: failure.message,
39
- }));
7
+ .rule(async (ctx) => {
8
+ return ctx.validateHttpTransactions(or(successfulStatusCode(), statusCodeRange(400, 499)), (_request, response, location) => {
9
+ if (typeof location === 'string') {
10
+ return [
11
+ {
12
+ location,
13
+ findings: [
14
+ {
15
+ title: 'thymian/response-headers-must-conform-to-schema',
16
+ kind: 'rule-skip',
17
+ message: `No matching endpoint found in corresponding API description document.`,
18
+ },
19
+ ],
20
+ },
21
+ ];
22
+ }
23
+ const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
24
+ if (!transaction) {
25
+ return [
26
+ {
27
+ location,
28
+ findings: [
29
+ {
30
+ title: 'thymian/response-headers-must-conform-to-schema',
31
+ kind: 'rule-skip',
32
+ message: `Can't find transaction with given ID ${location.elementId} in Thymian format.`,
33
+ },
34
+ ],
35
+ },
36
+ ];
37
+ }
38
+ const results = validateHeaders(response.headers, transaction.thymianRes);
39
+ const failures = results.filter((r) => r.type === 'assertion-failure');
40
+ if (failures.length > 0) {
41
+ return [
42
+ {
43
+ location,
44
+ violation: { message: `${failures.length} assertion(s) failed` },
45
+ findings: httpTestResultToRuleFindings(results),
46
+ },
47
+ ];
48
+ }
49
+ return [{ location, findings: httpTestResultToRuleFindings(results) }];
40
50
  });
41
51
  })
52
+ .overrideTest((ctx) => ctx.httpTest(singleTestCase()
53
+ .forTransactionsWith(or(successfulStatusCode(), statusCodeRange(400, 499)))
54
+ .run({ checkHeaders: true })
55
+ .done()))
42
56
  .done();
43
57
  //# sourceMappingURL=response-headers-conform-to-schema.rule.js.map
package/dist/rules/response-headers-conform-to-schema.rule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"response-headers-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/response-headers-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,QAAQ,EAER,EAAE,EAGF,cAAc,EACd,eAAe,EACf,oBAAoB,EAEpB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,iDAAiD,CAAC;KACvE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;KACzB,WAAW,CACV,yLAAyL,CAC1L;KACA,OAAO,CAAC,6DAA6D,CAAC;KACtE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,wBAAwB,CAC1B,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACrD,CACE,QAAqB,EACrB,QAAsB,EACtB,QAA+B,EAC/B,EAAE;IACF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,eAAe,CAC7B,QAAQ,CAAC,OAAO,EAChB,WAAW,CAAC,UAAU,CACvB,CAAC;IACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CACF;KACA,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAC1B,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,WAAW,CACtC,cAAc,EAAE;SACb,mBAAmB,CAClB,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACtD;SACA,GAAG,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;SAC3B,IAAI,EAAE,CACV,CAAC;IAEF,OAAO,UAAU,CAAC,KAAK;SACpB,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC;SAClD,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CACtC,CACE,CAAC,EAE0D,EAAE,CAC7D,CAAC,CAAC,IAAI,KAAK,mBAAmB,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CACpD,CAAC;QAEF,OAAO,QAAQ,CAAC,GAAG,CAAgB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC/C,QAAQ,EAAE;gBACR,WAAW,EAAE,MAAM;gBACnB,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,aAAa;aAC7C;YACD,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;KACD,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"response-headers-conform-to-schema.rule.js","sourceRoot":"","sources":["../../src/rules/response-headers-conform-to-schema.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,EACR,4BAA4B,EAC5B,EAAE,EAGF,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,eAAe,QAAQ,CAAC,iDAAiD,CAAC;KACvE,QAAQ,CAAC,OAAO,CAAC;KACjB,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;KACzB,WAAW,CACV,yLAAyL,CAC1L;KACA,OAAO,CAAC,6DAA6D,CAAC;KACtE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,OAAO,GAAG,CAAC,wBAAwB,CACjC,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACrD,CACE,QAAqB,EACrB,QAAsB,EACtB,QAA+B,EACf,EAAE;QAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,iDAAiD;4BACxD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,uEAAuE;yBACjF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,6BAA6B,CAC1D,QAAQ,CAAC,SAAS,CACnB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;gBACL;oBACE,QAAQ;oBACR,QAAQ,EAAE;wBACR;4BACE,KAAK,EAAE,iDAAiD;4BACxD,IAAI,EAAE,WAAW;4BACjB,OAAO,EAAE,wCAAwC,QAAQ,CAAC,SAAS,qBAAqB;yBACzF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,eAAe,CAC7B,QAAQ,CAAC,OAAO,EAChB,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAAC;QAEvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO;gBACL;oBACE,QAAQ;oBACR,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,sBAAsB,EAAE;oBAChE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC;iBAChD;aACF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;KACD,YAAY,CAAC,CAAC,GAAG,EAAE,EAAE,CACpB,GAAG,CAAC,QAAQ,CACV,cAAc,EAAE;KACb,mBAAmB,CAClB,EAAE,CAAC,oBAAoB,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACtD;KACA,GAAG,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;KAC3B,IAAI,EAAE,CACV,CACF;KACA,IAAI,EAAE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thymian/rules-api-description-validation",
3
- "version": "0.1.10",
3
+ "version": "0.1.11-canary.20260624-288c194",
4
4
  "description": "Thymian rule set for validating API description documents",
5
5
  "license": "AGPL-3.0-only",
6
6
  "bugs": {
@@ -41,6 +41,6 @@
41
41
  "!**/*.tsbuildinfo"
42
42
  ],
43
43
  "dependencies": {
44
- "@thymian/core": "0.1.10"
44
+ "@thymian/core": "0.1.11-canary.20260624-288c194"
45
45
  }
46
46
  }