ts-openapi-codegen 2.0.0 → 2.1.0-beta.2

package/dist/core/api/v3/parser/__tests__/getContent.test.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_test_1 = require("node:test");
+const getContent_1 = require("../getContent");
+(0, node_test_1.describe)('@unit: getContent', () => {
+    (0, node_test_1.test)('should prefer application/json over other media types', () => {
+        const content = (0, getContent_1.getContent)({
+            'text/plain': {
+                schema: { type: 'string' },
+            },
+            'application/json': {
+                schema: { type: 'object' },
+            },
+        });
+        node_assert_1.default.strictEqual(content?.mediaType, 'application/json');
+        node_assert_1.default.strictEqual(content?.schema.type, 'object');
+    });
+    (0, node_test_1.test)('should prefer application/*+json when application/json is absent', () => {
+        const content = (0, getContent_1.getContent)({
+            'text/plain': {
+                schema: { type: 'string' },
+            },
+            'application/problem+json': {
+                schema: { type: 'object' },
+            },
+        });
+        node_assert_1.default.strictEqual(content?.mediaType, 'application/problem+json');
+        node_assert_1.default.strictEqual(content?.schema.type, 'object');
+    });
+    (0, node_test_1.test)('should prefer wildcard when no json media type exists', () => {
+        const content = (0, getContent_1.getContent)({
+            'text/plain': {
+                schema: { type: 'string' },
+            },
+            '*/*': {
+                schema: { type: 'number' },
+            },
+        });
+        node_assert_1.default.strictEqual(content?.mediaType, '*/*');
+        node_assert_1.default.strictEqual(content?.schema.type, 'number');
+    });
+    (0, node_test_1.test)('should fallback to the first media type with schema', () => {
+        const content = (0, getContent_1.getContent)({
+            'text/plain': {
+                schema: { type: 'string' },
+            },
+            'application/xml': {
+                schema: { type: 'object' },
+            },
+        });
+        node_assert_1.default.strictEqual(content?.mediaType, 'text/plain');
+        node_assert_1.default.strictEqual(content?.schema.type, 'string');
+    });
+    (0, node_test_1.test)('should ignore media types without schema and return null if none found', () => {
+        const content = (0, getContent_1.getContent)({
+            'application/json': {},
+            'text/plain': {},
+        });
+        node_assert_1.default.strictEqual(content, null);
+    });
+});

package/dist/core/api/v3/parser/__tests__/getModel.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getModel.test.d.ts.map

package/dist/core/api/v3/parser/__tests__/getModel.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getModel.test.d.ts","sourceRoot":"","sources":["../../../../../../src/core/api/v3/parser/__tests__/getModel.test.ts"],"names":[],"mappings":""}

package/dist/core/api/v3/parser/__tests__/getModel.test.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_test_1 = require("node:test");
+const Context_1 = require("../../../../Context");
+const xTypescriptTypePlugin_1 = require("../../../../plugins/builtins/xTypescriptTypePlugin");
+const getOutputPaths_1 = require("../../../../utils/getOutputPaths");
+const Parser_1 = require("../../Parser");
+(0, node_test_1.describe)('@unit: getModel (v3)', () => {
+    (0, node_test_1.test)('should prioritize x-typescript-type over format binary', () => {
+        const context = new Context_1.Context({
+            input: 'test/spec/v3.json',
+            output: (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }),
+            plugins: [xTypescriptTypePlugin_1.xTypescriptTypePlugin],
+        });
+        const parser = new Parser_1.Parser(context);
+        const model = parser.getModel({
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            openApi: {},
+            definition: {
+                type: 'string',
+                format: 'binary',
+                'x-typescript-type': 'File',
+            },
+            parentRef: '',
+        });
+        node_assert_1.default.strictEqual(model.export, 'generic');
+        node_assert_1.default.strictEqual(model.base, 'File');
+        node_assert_1.default.strictEqual(model.type, 'File');
+    });
+});

package/dist/core/api/v3/parser/getContent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getContent.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getContent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAEzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE,KAAK,QAAQ,GAAG;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;CACzB,CAAC;AAIF,wBAAgB,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,QAAQ,GAAG,IAAI,CAejF"}
+{"version":3,"file":"getContent.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getContent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAEzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE,KAAK,QAAQ,GAAG;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;CACzB,CAAC;AAQF,wBAAgB,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,QAAQ,GAAG,IAAI,CA2BjF"}

package/dist/core/api/v3/parser/getContent.js

@@ -2,17 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContent = getContent;
 const isDefined_1 = require("../../../utils/isDefined");
-const CONTENT_MEDIA_TYPES = ['application/json-patch+json', 'application/json', 'text/json', 'text/plain', 'multipart/mixed', 'multipart/related', 'multipart/batch', 'multipart/form-data'];
+function normalizeMediaType(mediaType) {
+    return mediaType.split(';')[0].trim().toLowerCase();
+}
 function getContent(content) {
-    const mediaTypesWithSchema = Object.keys(content).find(mediaType => {
-        const cleanMediaType = mediaType.split(';')[0].trim();
-        return CONTENT_MEDIA_TYPES.includes(cleanMediaType) && (0, isDefined_1.isDefined)(content[mediaType]?.schema);
-    });
-    if (mediaTypesWithSchema) {
-        return {
-            mediaType: mediaTypesWithSchema,
-            schema: content[mediaTypesWithSchema].schema,
-        };
+    const entriesWithSchema = Object.entries(content).filter(([, mediaTypeObject]) => (0, isDefined_1.isDefined)(mediaTypeObject?.schema));
+    if (entriesWithSchema.length === 0) {
+        return null;
+    }
+    const getByPredicate = (predicate) => {
+        return entriesWithSchema.find(([mediaType]) => predicate(normalizeMediaType(mediaType)));
+    };
+    const selectedEntry = getByPredicate(mediaType => mediaType === 'application/json') ??
+        getByPredicate(mediaType => mediaType.startsWith('application/') && mediaType.endsWith('+json')) ??
+        getByPredicate(mediaType => mediaType === '*/*') ??
+        entriesWithSchema[0];
+    if (!selectedEntry) {
+        return null;
     }
-    return null;
+    const [mediaType, mediaTypeObject] = selectedEntry;
+    return {
+        mediaType,
+        schema: mediaTypeObject.schema,
+    };
 }

package/dist/core/api/v3/parser/getModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getModel.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getModel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAM/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAGzD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,KAAK,CAgLjE"}
+{"version":3,"file":"getModel.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getModel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAM/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAGzD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,KAAK,CAqLjE"}

package/dist/core/api/v3/parser/getModel.js

@@ -164,7 +164,12 @@ function getModel(config) {
     }
     // If the schema has a type than it can be a basic or generic type.
     if (definition.type) {
-        const definitionType = this.getType(definition.type, parentRef);
+        const pluginType = this.context.resolveSchemaTypeOverride(definition, {
+            openApiVersion: 'v3',
+            parentRef,
+        });
+        const primitiveType = pluginType || (definition.format === 'binary' ? 'Blob' : definition.type);
+        const definitionType = this.getType(primitiveType, parentRef);
         model.export = 'generic';
         model.type = definitionType.type;
         model.base = definitionType.base;

package/dist/core/api/v3/parser/getOperation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getOperation.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAS3F,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGxE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,gBAAgB,EAAE,UAAU,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAgE3M"}
+{"version":3,"file":"getOperation.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAS3F,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGxE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,gBAAgB,EAAE,UAAU,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAkE3M"}

package/dist/core/api/v3/parser/getOperation.js

@@ -33,6 +33,7 @@ function getOperation(openApi, url, method, op, pathParams, serviceClassName, pa
         errors: [],
         results: [],
         responseHeader: null,
+        responseType: null,
     };
     // Parse the operation parameters (path, query, body, etc).
     if (op.parameters) {
@@ -61,6 +62,7 @@ function getOperation(openApi, url, method, op, pathParams, serviceClassName, pa
         const operationResults = (0, getOperationResults_1.getOperationResults)(operationResponses);
         operation.errors = (0, getOperationErrors_1.getOperationErrors)(operationResponses);
         operation.responseHeader = (0, getOperationResponseHeader_1.getOperationResponseHeader)(operationResults);
+        operation.responseType = operationResults.some(operationResult => operationResult.base === 'Blob' || operationResult.base === 'File') ? 'blob' : null;
         operationResults.forEach(operationResult => {
             operation.results.push(operationResult);
             operation.imports.push(...operationResult.imports);

package/dist/core/api/v3/parser/getOperationResponses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getOperationResponses.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getOperationResponses.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAsBzI"}
+{"version":3,"file":"getOperationResponses.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/parser/getOperationResponses.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAIvF,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,EAAE,CA0BzI"}

package/dist/core/api/v3/parser/getOperationResponses.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOperationResponses = getOperationResponses;
+const path_1 = require("path");
+const pathHelpers_1 = require("../../../../common/utils/pathHelpers");
 const safeHasOwn_1 = require("../../../../common/utils/safeHasOwn");
 const getOperationResponseCode_1 = require("../../../utils/getOperationResponseCode");
+const normalizeRef_1 = require("../../../utils/normalizeRef");
+const parseRef_1 = require("../../../utils/parseRef");
 function getOperationResponses(openApi, responses, parentRef) {
     const operationResponses = [];
     // Iterate over each response code and get the
@@ -12,8 +16,12 @@ function getOperationResponses(openApi, responses, parentRef) {
             const responseOrReference = responses[code];
             const response = (responseOrReference.$ref ? this.context.get(responseOrReference.$ref, parentRef) : responseOrReference);
             const responseCode = (0, getOperationResponseCode_1.getOperationResponseCode)(code);
+            const normalizedParentRef = (0, path_1.isAbsolute)(parentRef) ? parentRef : (0, pathHelpers_1.resolveHelper)(this.context.root?.dirName || process.cwd(), parentRef);
+            const responseParentRef = responseOrReference.$ref
+                ? (0, parseRef_1.parseRef)((0, normalizeRef_1.normalizeRef)(responseOrReference.$ref, normalizedParentRef)).filePath || normalizedParentRef
+                : parentRef;
             if (responseCode) {
-                const operationResponse = this.getOperationResponse(openApi, response, responseCode, parentRef);
+                const operationResponse = this.getOperationResponse(openApi, response, responseCode, responseParentRef);
                 operationResponses.push(operationResponse);
             }
         }

package/dist/core/api/v3/types/OpenApiSchema.model.d.ts

@@ -43,5 +43,7 @@ export interface OpenApiSchema extends OpenApiReference, WithEnumExtension {
     externalDocs?: OpenApiExternalDocs;
     example?: any;
     deprecated?: boolean;
+    /** Other vendor extensions (`x-*`) on the schema object. */
+    [extension: `x-${string}`]: unknown;
 }
 //# sourceMappingURL=OpenApiSchema.model.d.ts.map

package/dist/core/api/v3/types/OpenApiSchema.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenApiSchema.model.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/types/OpenApiSchema.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0DAA0D,CAAC;AAClG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AACrF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB,EAAE,iBAAiB;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,GAAG,CAAC,EAAE,aAAa,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,UAAU,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;IACvC,oBAAoB,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAC/H,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"OpenApiSchema.model.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v3/types/OpenApiSchema.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0DAA0D,CAAC;AAClG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AACrF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB,EAAE,iBAAiB;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,GAAG,CAAC,EAAE,aAAa,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,UAAU,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;IACvC,oBAAoB,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAC/H,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,CAAC,SAAS,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC;CACvC"}

package/dist/core/governance/__tests__/evaluateGovernanceRules.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=evaluateGovernanceRules.test.d.ts.map

package/dist/core/governance/__tests__/evaluateGovernanceRules.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluateGovernanceRules.test.d.ts","sourceRoot":"","sources":["../../../../src/core/governance/__tests__/evaluateGovernanceRules.test.ts"],"names":[],"mappings":""}

package/dist/core/governance/__tests__/evaluateGovernanceRules.test.js

@@ -0,0 +1,100 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_test_1 = require("node:test");
+const evaluateGovernanceRules_1 = require("../evaluateGovernanceRules");
+(0, node_test_1.describe)('@unit: evaluateGovernanceRules', () => {
+    (0, node_test_1.test)('returns no violations for compliant spec without breaking changes', () => {
+        const report = (0, evaluateGovernanceRules_1.evaluateGovernanceRules)({
+            openApi: {
+                openapi: '3.0.0',
+                paths: {
+                    '/users': {
+                        get: {
+                            operationId: 'getUsers',
+                            responses: {
+                                '200': {
+                                    description: 'ok',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            breakingChangesCount: 0,
+            allowBreaking: false,
+        });
+        node_assert_1.default.deepStrictEqual(report.summary, {
+            errors: 0,
+            warnings: 0,
+            info: 0,
+        });
+        node_assert_1.default.deepStrictEqual(report.violations, []);
+    });
+    (0, node_test_1.test)('returns violations for breaking flag, missing operationId and default-only response', () => {
+        const report = (0, evaluateGovernanceRules_1.evaluateGovernanceRules)({
+            openApi: {
+                openapi: '3.0.0',
+                paths: {
+                    '/users': {
+                        get: {
+                            responses: {
+                                default: {
+                                    description: 'fallback',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            breakingChangesCount: 2,
+            allowBreaking: false,
+        });
+        node_assert_1.default.ok(report.violations.some(violation => violation.ruleId === 'NO_BREAKING_WITHOUT_FLAG'));
+        node_assert_1.default.ok(report.violations.some(violation => violation.ruleId === 'REQUIRE_OPERATION_ID'));
+        node_assert_1.default.ok(report.violations.some(violation => violation.ruleId === 'NO_DEFAULT_WITHOUT_2XX'));
+        node_assert_1.default.ok(report.summary.errors > 0);
+        node_assert_1.default.ok(report.summary.warnings > 0);
+    });
+    (0, node_test_1.test)('applies enabled, severity and allowList overrides from config', () => {
+        const report = (0, evaluateGovernanceRules_1.evaluateGovernanceRules)({
+            openApi: {
+                openapi: '3.0.0',
+                paths: {
+                    '/users': {
+                        get: {
+                            responses: {
+                                default: {
+                                    description: 'fallback',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            breakingChangesCount: 1,
+            allowBreaking: false,
+            governanceConfig: {
+                rules: {
+                    NO_BREAKING_WITHOUT_FLAG: {
+                        enabled: false,
+                    },
+                    REQUIRE_OPERATION_ID: {
+                        severity: 'error',
+                        allowList: [{ operation: '/users GET' }],
+                    },
+                    NO_DEFAULT_WITHOUT_2XX: {
+                        severity: 'error',
+                    },
+                },
+            },
+        });
+        node_assert_1.default.ok(!report.violations.some(violation => violation.ruleId === 'NO_BREAKING_WITHOUT_FLAG'));
+        node_assert_1.default.ok(!report.violations.some(violation => violation.ruleId === 'REQUIRE_OPERATION_ID'));
+        node_assert_1.default.ok(report.violations.some(violation => violation.ruleId === 'NO_DEFAULT_WITHOUT_2XX' && violation.severity === 'error'));
+        node_assert_1.default.strictEqual(report.summary.errors, 1);
+    });
+});

package/dist/core/governance/__tests__/loadGovernanceConfig.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=loadGovernanceConfig.test.d.ts.map

package/dist/core/governance/__tests__/loadGovernanceConfig.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadGovernanceConfig.test.d.ts","sourceRoot":"","sources":["../../../../src/core/governance/__tests__/loadGovernanceConfig.test.ts"],"names":[],"mappings":""}

package/dist/core/governance/__tests__/loadGovernanceConfig.test.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node:path"));
+const node_test_1 = require("node:test");
+const loadGovernanceConfig_1 = require("../loadGovernanceConfig");
+function createTempDir(prefix) {
+    const generatedRoot = node_path_1.default.join(__dirname, 'generated');
+    (0, node_fs_1.mkdirSync)(generatedRoot, { recursive: true });
+    return (0, node_fs_1.mkdtempSync)(node_path_1.default.join(generatedRoot, prefix));
+}
+(0, node_test_1.describe)('@unit: loadGovernanceConfig', () => {
+    (0, node_test_1.test)('returns undefined when path is not provided', async () => {
+        const config = await (0, loadGovernanceConfig_1.loadGovernanceConfig)();
+        node_assert_1.default.strictEqual(config, undefined);
+    });
+    (0, node_test_1.test)('loads valid governance config', async (t) => {
+        const tempDir = createTempDirWithCleanup(t, 'openapi-governance-config-valid-');
+        const configPath = node_path_1.default.join(tempDir, 'governance.json');
+        (0, node_fs_1.writeFileSync)(configPath, JSON.stringify({
+            rules: {
+                NO_BREAKING_WITHOUT_FLAG: {
+                    enabled: true,
+                    severity: 'error',
+                },
+                REQUIRE_OPERATION_ID: {
+                    allowList: [{ operation: '/users GET' }],
+                },
+            },
+        }));
+        const config = await (0, loadGovernanceConfig_1.loadGovernanceConfig)(configPath);
+        node_assert_1.default.ok(config);
+        node_assert_1.default.strictEqual(config?.rules?.NO_BREAKING_WITHOUT_FLAG?.severity, 'error');
+        node_assert_1.default.strictEqual(config?.rules?.REQUIRE_OPERATION_ID?.allowList?.[0]?.operation, '/users GET');
+    });
+    (0, node_test_1.test)('throws with path details for invalid severity', async (t) => {
+        const tempDir = createTempDirWithCleanup(t, 'openapi-governance-config-invalid-severity-');
+        const configPath = node_path_1.default.join(tempDir, 'governance.json');
+        (0, node_fs_1.writeFileSync)(configPath, JSON.stringify({
+            rules: {
+                NO_DEFAULT_WITHOUT_2XX: {
+                    severity: 'fatal',
+                },
+            },
+        }));
+        await node_assert_1.default.rejects(async () => (0, loadGovernanceConfig_1.loadGovernanceConfig)(configPath), (error) => error instanceof Error && error.message.includes('rules.NO_DEFAULT_WITHOUT_2XX.severity'));
+    });
+    (0, node_test_1.test)('throws with path details for invalid allowList item', async (t) => {
+        const tempDir = createTempDirWithCleanup(t, 'openapi-governance-config-invalid-allowlist-');
+        const configPath = node_path_1.default.join(tempDir, 'governance.json');
+        (0, node_fs_1.writeFileSync)(configPath, JSON.stringify({
+            rules: {
+                REQUIRE_OPERATION_ID: {
+                    allowList: [{}],
+                },
+            },
+        }));
+        await node_assert_1.default.rejects(async () => (0, loadGovernanceConfig_1.loadGovernanceConfig)(configPath), (error) => error instanceof Error && error.message.includes('rules.REQUIRE_OPERATION_ID.allowList.[0]'));
+    });
+});
+function createTempDirWithCleanup(t, prefix) {
+    const tempDir = createTempDir(prefix);
+    t.after(() => {
+        (0, node_fs_1.rmSync)(tempDir, { recursive: true, force: true });
+    });
+    return tempDir;
+}

package/dist/core/governance/evaluateGovernanceRules.d.ts

@@ -0,0 +1,42 @@
+import { CommonOpenApi } from '../types/shared/CommonOpenApi.model';
+type GovernanceSeverity = 'error' | 'warning' | 'info';
+export type GovernanceRuleId = 'NO_BREAKING_WITHOUT_FLAG' | 'REQUIRE_OPERATION_ID' | 'NO_DEFAULT_WITHOUT_2XX';
+type GovernanceSummary = {
+    errors: number;
+    warnings: number;
+    info: number;
+};
+export type GovernanceViolation = {
+    ruleId: GovernanceRuleId;
+    severity: GovernanceSeverity;
+    message: string;
+    path: string;
+};
+export type GovernanceReport = {
+    summary: GovernanceSummary;
+    violations: GovernanceViolation[];
+};
+export type GovernanceAllowListItem = {
+    operation?: string;
+    path?: string;
+};
+export type GovernanceRuleConfig = {
+    enabled?: boolean;
+    severity?: GovernanceSeverity;
+    allowList?: GovernanceAllowListItem[];
+};
+export type GovernancePolicyConfig = {
+    rules?: Partial<Record<GovernanceRuleId, GovernanceRuleConfig>>;
+};
+type GovernanceInput = {
+    openApi: CommonOpenApi;
+    allowBreaking?: boolean;
+    breakingChangesCount?: number;
+    governanceConfig?: GovernancePolicyConfig;
+};
+/**
+ * Evaluates governance rules and returns machine-readable violations.
+ */
+export declare function evaluateGovernanceRules(params: GovernanceInput): GovernanceReport;
+export {};
+//# sourceMappingURL=evaluateGovernanceRules.d.ts.map

package/dist/core/governance/evaluateGovernanceRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluateGovernanceRules.d.ts","sourceRoot":"","sources":["../../../src/core/governance/evaluateGovernanceRules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,KAAK,kBAAkB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAEvD,MAAM,MAAM,gBAAgB,GAAG,0BAA0B,GAAG,sBAAsB,GAAG,wBAAwB,CAAC;AAE9G,KAAK,iBAAiB,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,MAAM,EAAE,gBAAgB,CAAC;IACzB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC3B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,UAAU,EAAE,mBAAmB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,SAAS,CAAC,EAAE,uBAAuB,EAAE,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC,CAAC;CACnE,CAAC;AAEF,KAAK,eAAe,GAAG;IACnB,OAAO,EAAE,aAAa,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC7C,CAAC;AAwFF;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,GAAG,gBAAgB,CAqEjF"}

package/dist/core/governance/evaluateGovernanceRules.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateGovernanceRules = evaluateGovernanceRules;
+const HTTP_METHODS = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'];
+/**
+ * Checks whether response key is an explicit successful HTTP status code key.
+ */
+function isSuccessResponseCode(responseCode) {
+    return /^\s*2\d\d\s*$/.test(responseCode) || /^\s*2xx\s*$/i.test(responseCode);
+}
+/**
+ * Builds governance summary counters from violations.
+ */
+function buildSummary(violations) {
+    return violations.reduce((summary, violation) => {
+        if (violation.severity === 'error') {
+            summary.errors += 1;
+        }
+        else if (violation.severity === 'warning') {
+            summary.warnings += 1;
+        }
+        else {
+            summary.info += 1;
+        }
+        return summary;
+    }, {
+        errors: 0,
+        warnings: 0,
+        info: 0,
+    });
+}
+const RULE_DEFAULTS = {
+    NO_BREAKING_WITHOUT_FLAG: {
+        enabled: true,
+        severity: 'error',
+    },
+    REQUIRE_OPERATION_ID: {
+        enabled: true,
+        severity: 'warning',
+    },
+    NO_DEFAULT_WITHOUT_2XX: {
+        enabled: true,
+        severity: 'warning',
+    },
+};
+/**
+ * Resolves effective rule config using defaults overridden by user policy.
+ */
+function getEffectiveRuleConfig(ruleId, governanceConfig) {
+    const defaults = RULE_DEFAULTS[ruleId];
+    const configuredRule = governanceConfig?.rules?.[ruleId] ?? {};
+    return {
+        enabled: configuredRule.enabled ?? defaults.enabled,
+        severity: configuredRule.severity ?? defaults.severity,
+        allowList: Array.isArray(configuredRule.allowList) ? configuredRule.allowList : [],
+    };
+}
+/**
+ * Returns true when violation is allowed by operation/path allow list.
+ */
+function isViolationAllowed(allowList, operation, violationPath) {
+    return allowList.some(item => {
+        const operationAllowed = typeof item.operation === 'string' && operation ? item.operation === operation : false;
+        const pathAllowed = typeof item.path === 'string' && item.path.trim().length > 0
+            ? violationPath === item.path || violationPath.startsWith(item.path)
+            : false;
+        return operationAllowed || pathAllowed;
+    });
+}
+/**
+ * Evaluates governance rules and returns machine-readable violations.
+ */
+function evaluateGovernanceRules(params) {
+    const { openApi, allowBreaking = false, breakingChangesCount = 0, governanceConfig } = params;
+    const violations = [];
+    const noBreakingRule = getEffectiveRuleConfig('NO_BREAKING_WITHOUT_FLAG', governanceConfig);
+    if (noBreakingRule.enabled && !allowBreaking && breakingChangesCount > 0) {
+        const violationPath = '#/summary/breaking';
+        if (!isViolationAllowed(noBreakingRule.allowList, undefined, violationPath)) {
+            violations.push({
+                ruleId: 'NO_BREAKING_WITHOUT_FLAG',
+                severity: noBreakingRule.severity,
+                message: `Breaking changes are not allowed without explicit allow flag. Found ${breakingChangesCount}.`,
+                path: violationPath,
+            });
+        }
+    }
+    const paths = openApi.paths;
+    for (const [routePath, pathItemRaw] of Object.entries(paths ?? {})) {
+        const pathItem = pathItemRaw ?? {};
+        for (const method of HTTP_METHODS) {
+            const operationRaw = pathItem[method];
+            if (!operationRaw || typeof operationRaw !== 'object') {
+                continue;
+            }
+            const operation = operationRaw;
+            const operationPath = `${routePath} ${method.toUpperCase()}`;
+            const requireOperationIdRule = getEffectiveRuleConfig('REQUIRE_OPERATION_ID', governanceConfig);
+            if (requireOperationIdRule.enabled && !operation.operationId) {
+                if (!isViolationAllowed(requireOperationIdRule.allowList, operationPath, operationPath)) {
+                    violations.push({
+                        ruleId: 'REQUIRE_OPERATION_ID',
+                        severity: requireOperationIdRule.severity,
+                        message: 'Operation must define operationId.',
+                        path: operationPath,
+                    });
+                }
+            }
+            const responses = operation.responses;
+            if (!responses || typeof responses !== 'object') {
+                continue;
+            }
+            const responseCodes = Object.keys(responses);
+            const hasDefaultResponse = responseCodes.includes('default');
+            const hasSuccessResponse = responseCodes.some(isSuccessResponseCode);
+            const noDefaultWithout2xxRule = getEffectiveRuleConfig('NO_DEFAULT_WITHOUT_2XX', governanceConfig);
+            if (noDefaultWithout2xxRule.enabled && hasDefaultResponse && !hasSuccessResponse) {
+                const violationPath = `${operationPath} responses.default`;
+                if (!isViolationAllowed(noDefaultWithout2xxRule.allowList, operationPath, violationPath)) {
+                    violations.push({
+                        ruleId: 'NO_DEFAULT_WITHOUT_2XX',
+                        severity: noDefaultWithout2xxRule.severity,
+                        message: 'Default response is present without an explicit 2xx response.',
+                        path: violationPath,
+                    });
+                }
+            }
+        }
+    }
+    return {
+        summary: buildSummary(violations),
+        violations,
+    };
+}

package/dist/core/governance/governanceConfigSchema.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { GovernancePolicyConfig } from './evaluateGovernanceRules';
+export declare const governancePolicyConfigSchema: z.ZodType<GovernancePolicyConfig>;
+//# sourceMappingURL=governanceConfigSchema.d.ts.map

package/dist/core/governance/governanceConfigSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"governanceConfigSchema.d.ts","sourceRoot":"","sources":["../../../src/core/governance/governanceConfigSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAoCnE,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAI9D,CAAC"}