@thymian/rules-api-description-validation 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# Thymian
+
+Add resilience and HTTP conformance to your API development workflow. Thymian is a lightweight, language-agnostic library that helps you build robust APIs.
+
+## @thymian/api-description-validation-rules
+
+Validates JSON and YAML format structures.
+
+## Documentation
+
+For comprehensive documentation, visit [Thymian Documentation](https://thymian.dev/).

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { RuleSet } from '@thymian/core';
+declare const apiDescriptionValidation: RuleSet;
+export default apiDescriptionValidation;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,QAAA,MAAM,wBAAwB,EAAE,OAG/B,CAAC;AAEF,eAAe,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+const apiDescriptionValidation = {
+    name: '@thymian/rules-api-description-validation',
+    pattern: 'rules/**/*.rule.js',
+};
+export default apiDescriptionValidation;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,wBAAwB,GAAY;IACxC,IAAI,EAAE,2CAA2C;IACjD,OAAO,EAAE,oBAAoB;CAC9B,CAAC;AAEF,eAAe,wBAAwB,CAAC"}

package/dist/rules/request-body-conforms-to-schema.rule.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@thymian/core").Rule<Record<PropertyKey, unknown>>;
+export default _default;
+//# sourceMappingURL=request-body-conforms-to-schema.rule.d.ts.map

package/dist/rules/request-body-conforms-to-schema.rule.d.ts.map

@@ -0,0 +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"}

package/dist/rules/request-body-conforms-to-schema.rule.js

@@ -0,0 +1,24 @@
+import { constant, httpRule, validateBodyForRequest, } from '@thymian/core';
+export default httpRule('thymian/request-body-must-conform-to-schema')
+    .severity('error')
+    .type('analytics')
+    .description('Request body must conform to the API description schema.')
+    .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
+    if (typeof location === 'string') {
+        return false;
+    }
+    const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
+    if (!transaction) {
+        return false;
+    }
+    const results = validateBodyForRequest(request.body, transaction.thymianReq);
+    const failures = results.filter((r) => r.type === 'assertion-failure');
+    if (failures.length > 0) {
+        return {
+            message: failures.map((f) => f.message).join('\n'),
+        };
+    }
+    return false;
+}))
+    .done();
+//# sourceMappingURL=request-body-conforms-to-schema.rule.js.map

package/dist/rules/request-body-conforms-to-schema.rule.js.map

@@ -0,0 +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"}

package/dist/rules/request-headers-conform-to-schema.rule.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@thymian/core").Rule<Record<PropertyKey, unknown>>;
+export default _default;
+//# sourceMappingURL=request-headers-conform-to-schema.rule.d.ts.map

package/dist/rules/request-headers-conform-to-schema.rule.d.ts.map

@@ -0,0 +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"}

package/dist/rules/request-headers-conform-to-schema.rule.js

@@ -0,0 +1,25 @@
+import { constant, httpRule, validateRequestHeaders, } from '@thymian/core';
+export default httpRule('thymian/request-headers-must-conform-to-schema')
+    .severity('error')
+    .type('analytics')
+    .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.')
+    .summary('Request headers must conform to the API description schema.')
+    .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
+    if (typeof location === 'string') {
+        return false;
+    }
+    const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
+    if (!transaction) {
+        return false;
+    }
+    const results = validateRequestHeaders(request.headers ?? {}, transaction.thymianReq);
+    const failures = results.filter((r) => r.type === 'assertion-failure');
+    if (failures.length > 0) {
+        return {
+            message: failures.map((f) => f.message).join('\n'),
+        };
+    }
+    return false;
+}))
+    .done();
+//# sourceMappingURL=request-headers-conform-to-schema.rule.js.map

package/dist/rules/request-headers-conform-to-schema.rule.js.map

@@ -0,0 +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"}

package/dist/rules/request-path-parameters-conform-to-schema.rule.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@thymian/core").Rule<Record<PropertyKey, unknown>>;
+export default _default;
+//# sourceMappingURL=request-path-parameters-conform-to-schema.rule.d.ts.map

package/dist/rules/request-path-parameters-conform-to-schema.rule.d.ts.map

@@ -0,0 +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"}

package/dist/rules/request-path-parameters-conform-to-schema.rule.js

@@ -0,0 +1,25 @@
+import { constant, httpRule, validateRequestPathParameters, } from '@thymian/core';
+export default httpRule('thymian/request-path-parameters-must-conform-to-schema')
+    .severity('error')
+    .type('analytics')
+    .description('Request path parameters must conform to the API description schema. Validates extracted path parameters against their schema definitions.')
+    .summary('Request path parameters must conform to the API description schema')
+    .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
+    if (typeof location === 'string') {
+        return false;
+    }
+    const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
+    if (!transaction) {
+        return false;
+    }
+    const results = validateRequestPathParameters(request.path, transaction.thymianReq);
+    const failures = results.filter((r) => r.type === 'assertion-failure');
+    if (failures.length > 0) {
+        return {
+            message: failures.map((f) => f.message).join('\n'),
+        };
+    }
+    return false;
+}))
+    .done();
+//# sourceMappingURL=request-path-parameters-conform-to-schema.rule.js.map

package/dist/rules/request-path-parameters-conform-to-schema.rule.js.map

@@ -0,0 +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"}

package/dist/rules/request-query-parameters-conform-to-schema.rule.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@thymian/core").Rule<Record<PropertyKey, unknown>>;
+export default _default;
+//# sourceMappingURL=request-query-parameters-conform-to-schema.rule.d.ts.map

package/dist/rules/request-query-parameters-conform-to-schema.rule.d.ts.map

@@ -0,0 +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"}

package/dist/rules/request-query-parameters-conform-to-schema.rule.js

@@ -0,0 +1,25 @@
+import { constant, httpRule, validateRequestQueryParameters, } from '@thymian/core';
+export default httpRule('thymian/request-query-parameters-must-conform-to-schema')
+    .severity('error')
+    .type('analytics')
+    .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.')
+    .summary('Request query parameters must conform to the API description schema')
+    .rule((ctx) => ctx.validateHttpTransactions(constant(true), (request, _response, location) => {
+    if (typeof location === 'string') {
+        return false;
+    }
+    const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
+    if (!transaction) {
+        return false;
+    }
+    const results = validateRequestQueryParameters(request.path, transaction.thymianReq);
+    const failures = results.filter((r) => r.type === 'assertion-failure');
+    if (failures.length > 0) {
+        return {
+            message: failures.map((f) => f.message).join('\n'),
+        };
+    }
+    return false;
+}))
+    .done();
+//# sourceMappingURL=request-query-parameters-conform-to-schema.rule.js.map

package/dist/rules/request-query-parameters-conform-to-schema.rule.js.map

@@ -0,0 +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"}

package/dist/rules/response-body-conforms-to-schema.rule.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@thymian/core").Rule<Record<PropertyKey, unknown>>;
+export default _default;
+//# sourceMappingURL=response-body-conforms-to-schema.rule.d.ts.map

package/dist/rules/response-body-conforms-to-schema.rule.d.ts.map

@@ -0,0 +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"}

package/dist/rules/response-body-conforms-to-schema.rule.js

@@ -0,0 +1,43 @@
+import { httpRule, or, singleTestCase, statusCodeRange, successfulStatusCode, validateBodyForResponse, } from '@thymian/core';
+export default httpRule('thymian/response-body-must-conforms-to-schema')
+    .severity('error')
+    .type('test', 'analytics')
+    .description('Response body for 2xx and 4xx responses must conform to the API description schema.')
+    .summary('Response body must conform to the API description schema.')
+    .rule((ctx) => ctx.validateHttpTransactions(or(successfulStatusCode(), statusCodeRange(400, 499)), (_request, response, location) => {
+    if (typeof location === 'string') {
+        return false;
+    }
+    const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
+    if (!transaction) {
+        return false;
+    }
+    const results = validateBodyForResponse(response.body, transaction.thymianRes);
+    const failures = results.filter((r) => r.type === 'assertion-failure');
+    if (failures.length > 0) {
+        return {
+            message: failures.map((f) => f.message).join('\n'),
+        };
+    }
+    return false;
+}))
+    .overrideTest(async (ctx) => {
+    const testResult = await ctx.runHttpTest(singleTestCase()
+        .forTransactionsWith(or(successfulStatusCode(), statusCodeRange(400, 499)))
+        .run({ checkBody: true })
+        .done());
+    return testResult.cases
+        .filter((testCase) => testCase.status === 'failed')
+        .flatMap((testCase) => {
+        const failures = testCase.results.filter((r) => r.type === 'assertion-failure' && !!r.transaction);
+        return failures.map((failure) => ({
+            location: {
+                elementType: 'edge',
+                elementId: failure.transaction.transactionId,
+            },
+            message: failure.message,
+        }));
+    });
+})
+    .done();
+//# sourceMappingURL=response-body-conforms-to-schema.rule.js.map

package/dist/rules/response-body-conforms-to-schema.rule.js.map

@@ -0,0 +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"}

package/dist/rules/response-headers-conform-to-schema.rule.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@thymian/core").Rule<Record<PropertyKey, unknown>>;
+export default _default;
+//# sourceMappingURL=response-headers-conform-to-schema.rule.d.ts.map

package/dist/rules/response-headers-conform-to-schema.rule.d.ts.map

@@ -0,0 +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"}

package/dist/rules/response-headers-conform-to-schema.rule.js

@@ -0,0 +1,43 @@
+import { httpRule, or, singleTestCase, statusCodeRange, successfulStatusCode, validateHeaders, } from '@thymian/core';
+export default httpRule('thymian/response-headers-must-conform-to-schema')
+    .severity('error')
+    .type('test', 'analytics')
+    .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.')
+    .summary('Response headers must conform to the API description schema')
+    .rule((ctx) => ctx.validateHttpTransactions(or(successfulStatusCode(), statusCodeRange(400, 499)), (_request, response, location) => {
+    if (typeof location === 'string') {
+        return false;
+    }
+    const transaction = ctx.format.getThymianHttpTransactionById(location.elementId);
+    if (!transaction) {
+        return false;
+    }
+    const results = validateHeaders(response.headers, transaction.thymianRes);
+    const failures = results.filter((r) => r.type === 'assertion-failure');
+    if (failures.length > 0) {
+        return {
+            message: failures.map((f) => f.message).join('\n'),
+        };
+    }
+    return false;
+}))
+    .overrideTest(async (ctx) => {
+    const testResult = await ctx.runHttpTest(singleTestCase()
+        .forTransactionsWith(or(successfulStatusCode(), statusCodeRange(400, 499)))
+        .run({ checkHeaders: true })
+        .done());
+    return testResult.cases
+        .filter((testCase) => testCase.status === 'failed')
+        .flatMap((testCase) => {
+        const failures = testCase.results.filter((r) => r.type === 'assertion-failure' && !!r.transaction);
+        return failures.map((failure) => ({
+            location: {
+                elementType: 'edge',
+                elementId: failure.transaction.transactionId,
+            },
+            message: failure.message,
+        }));
+    });
+})
+    .done();
+//# sourceMappingURL=response-headers-conform-to-schema.rule.js.map

package/dist/rules/response-headers-conform-to-schema.rule.js.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@thymian/rules-api-description-validation",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@thymian/core": "0.1.0"
+  }
+}