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

package/dist/core/semanticDiff/__tests__/semanticDiffReportSchema.test.js

@@ -0,0 +1,66 @@
+"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 analyzeOpenApiDiff_1 = require("../analyzeOpenApiDiff");
+const semanticDiffReportSchema_1 = require("../semanticDiffReportSchema");
+(0, node_test_1.describe)('@unit: semanticDiffReportSchema', () => {
+    (0, node_test_1.test)('validates report produced by analyzeOpenApiDiff', () => {
+        const report = (0, analyzeOpenApiDiff_1.analyzeOpenApiDiff)({
+            openapi: '3.0.0',
+            paths: {
+                '/ping': {
+                    get: {
+                        responses: {
+                            '200': { description: 'ok' },
+                        },
+                    },
+                },
+            },
+            components: { schemas: {} },
+        }, {
+            openapi: '3.0.0',
+            paths: {
+                '/ping': {
+                    get: {
+                        responses: {
+                            '200': { description: 'ok' },
+                            '201': { description: 'created' },
+                        },
+                    },
+                },
+            },
+            components: { schemas: {} },
+        });
+        const validation = (0, semanticDiffReportSchema_1.validateSemanticDiffReportSchema)(report);
+        node_assert_1.default.strictEqual(validation.valid, true, validation.errors.join('\n'));
+    });
+    (0, node_test_1.test)('rejects report without schemaVersion', () => {
+        const malformedReport = {
+            summary: {
+                breaking: 0,
+                nonBreaking: 0,
+                informational: 0,
+            },
+            recommendation: {
+                semver: 'patch',
+                reason: 'No changes',
+            },
+            governance: {
+                summary: {
+                    errors: 0,
+                    warnings: 0,
+                    info: 0,
+                },
+                violations: [],
+            },
+            changes: [],
+        };
+        const validation = (0, semanticDiffReportSchema_1.validateSemanticDiffReportSchema)(malformedReport);
+        node_assert_1.default.strictEqual(validation.valid, false);
+        node_assert_1.default.ok(validation.errors.some(error => error.includes('schemaVersion')));
+    });
+});

package/dist/core/semanticDiff/analyzeOpenApiDiff.d.ts

@@ -0,0 +1,45 @@
+import { GovernancePolicyConfig, GovernanceReport } from '../governance/evaluateGovernanceRules';
+import { CommonOpenApi } from '../types/shared/CommonOpenApi.model';
+type ChangeSeverity = 'breaking' | 'non-breaking' | 'informational';
+type SemanticDiffSummary = {
+    breaking: number;
+    nonBreaking: number;
+    informational: number;
+};
+type SemanticDiffSemverRecommendation = 'major' | 'minor' | 'patch';
+type SemanticDiffConfidence = 'high' | 'medium' | 'low';
+type SemanticDiffRecommendationReason = 'HAS_BREAKING_CHANGES' | 'HAS_BACKWARD_COMPATIBLE_CHANGES' | 'HAS_INFORMATIONAL_ONLY_CHANGES' | 'NO_API_SURFACE_CHANGES';
+type SemanticDiffRecommendation = {
+    semver: SemanticDiffSemverRecommendation;
+    confidence: SemanticDiffConfidence;
+    reason: string;
+    reasons: SemanticDiffRecommendationReason[];
+};
+type SemanticDiffChange = {
+    type: string;
+    severity: ChangeSeverity;
+    message: string;
+    path: string;
+};
+export declare const SEMANTIC_DIFF_REPORT_SCHEMA_VERSION = "1.1.0";
+export type SemanticDiffReport = {
+    schemaVersion: string;
+    summary: SemanticDiffSummary;
+    recommendation: SemanticDiffRecommendation;
+    governance: GovernanceReport;
+    changes: SemanticDiffChange[];
+};
+type AnalyzeOpenApiDiffOptions = {
+    allowBreaking?: boolean;
+    governanceConfig?: GovernancePolicyConfig;
+};
+/**
+ * Creates semantic diff report between two OpenAPI specs.
+ */
+export declare function analyzeOpenApiDiff(oldSpec: CommonOpenApi, newSpec: CommonOpenApi, options?: AnalyzeOpenApiDiffOptions): SemanticDiffReport;
+/**
+ * Writes semantic diff report to JSON file and returns absolute path.
+ */
+export declare function writeSemanticDiffReport(report: SemanticDiffReport, reportFilePath: string): Promise<string>;
+export {};
+//# sourceMappingURL=analyzeOpenApiDiff.d.ts.map

package/dist/core/semanticDiff/analyzeOpenApiDiff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeOpenApiDiff.d.ts","sourceRoot":"","sources":["../../../src/core/semanticDiff/analyzeOpenApiDiff.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAA2B,MAAM,uCAAuC,CAAC;AAC1H,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,KAAK,cAAc,GAAG,UAAU,GAAG,cAAc,GAAG,eAAe,CAAC;AAEpE,KAAK,mBAAmB,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,KAAK,gCAAgC,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AACpE,KAAK,sBAAsB,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;AACxD,KAAK,gCAAgC,GAC/B,sBAAsB,GACtB,iCAAiC,GACjC,gCAAgC,GAChC,wBAAwB,CAAC;AAE/B,KAAK,0BAA0B,GAAG;IAC9B,MAAM,EAAE,gCAAgC,CAAC;IACzC,UAAU,EAAE,sBAAsB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,gCAAgC,EAAE,CAAC;CAC/C,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,eAAO,MAAM,mCAAmC,UAAU,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,cAAc,EAAE,0BAA0B,CAAC;IAC3C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,OAAO,EAAE,kBAAkB,EAAE,CAAC;CACjC,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC7C,CAAC;AA6yBF;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAE,yBAA8B,GAAG,kBAAkB,CA2B9I;AAED;;GAEG;AACH,wBAAsB,uBAAuB,CAAC,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAajH"}