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

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

@@ -0,0 +1,97 @@
+import { GovernancePolicyConfig, GovernanceReport } from '../governance/evaluateGovernanceRules';
+import type { UnifiedDiffReport } from '../types/DiffReport.model';
+import { CommonOpenApi } from '../types/shared/CommonOpenApi.model';
+import type { MiracleEntry } from '../types/shared/Miracle.model';
+type ChangeSeverity = 'breaking' | 'non-breaking' | 'informational';
+/**
+ * Сводка семантических изменений по уровню серьёзности.
+ * @property breaking количество breaking-изменений
+ * @property nonBreaking количество обратно совместимых изменений
+ * @property informational количество информационных изменений
+ */
+export 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';
+/**
+ * Рекомендация по semver-версии на основе семантического diff.
+ * @property semver рекомендуемый уровень версии
+ * @property confidence уверенность в рекомендации
+ * @property reason человекочитаемое объяснение
+ * @property reasons машиночитаемые коды причин
+ */
+export type SemanticDiffRecommendation = {
+    semver: SemanticDiffSemverRecommendation;
+    confidence: SemanticDiffConfidence;
+    reason: string;
+    reasons: SemanticDiffRecommendationReason[];
+};
+/**
+ * Одно семантическое изменение OpenAPI.
+ * @property type тип изменения
+ * @property severity уровень серьёзности
+ * @property message описание изменения
+ * @property path JSON Pointer путь к изменённому элементу
+ * @property [from] значение до изменения
+ * @property [to] значение после изменения
+ * @property [fromRequired] обязательность до изменения
+ * @property [toRequired] обязательность после изменения
+ * @property [fromNullable] nullable до изменения
+ * @property [toNullable] nullable после изменения
+ */
+export type SemanticDiffChange = {
+    type: string;
+    severity: ChangeSeverity;
+    message: string;
+    path: string;
+    from?: unknown;
+    to?: unknown;
+    fromRequired?: boolean;
+    toRequired?: boolean;
+    fromNullable?: boolean;
+    toNullable?: boolean;
+};
+/** Версия схемы семантического diff-отчёта. */
+export declare const SEMANTIC_DIFF_REPORT_SCHEMA_VERSION = "1.1.0";
+/**
+ * Семантический diff-отчёт OpenAPI.
+ * @property schemaVersion версия схемы отчёта
+ * @property summary сводка изменений по серьёзности
+ * @property recommendation рекомендация по semver
+ * @property governance результат проверки governance-правил
+ * @property changes список семантических изменений
+ * @property [miracles] кандидаты на переименование и приведение типов
+ */
+export type SemanticDiffReport = {
+    schemaVersion: string;
+    summary: SemanticDiffSummary;
+    recommendation: SemanticDiffRecommendation;
+    governance: GovernanceReport;
+    changes: SemanticDiffChange[];
+    miracles?: MiracleEntry[];
+};
+type AnalyzeOpenApiDiffOptions = {
+    allowBreaking?: boolean;
+    governanceConfig?: GovernancePolicyConfig;
+};
+/**
+ * Формирует семантический diff-отчёт между двумя OpenAPI-спецификациями.
+ * @param oldSpec базовая спецификация
+ * @param newSpec целевая спецификация
+ * @param [options] опции анализа, включая governance и разрешение breaking-изменений
+ * @returns семантический diff-отчёт
+ */
+export declare function analyzeOpenApiDiff(oldSpec: CommonOpenApi, newSpec: CommonOpenApi, options?: AnalyzeOpenApiDiffOptions): SemanticDiffReport;
+/**
+ * Записывает семантический или унифицированный diff-отчёт в JSON-файл.
+ * @param report отчёт для сохранения
+ * @param reportFilePath путь к файлу отчёта
+ * @returns абсолютный путь к сохранённому файлу
+ */
+export declare function writeSemanticDiffReport(report: SemanticDiffReport | UnifiedDiffReport, 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,EAA2B,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAC1H,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAElE,KAAK,cAAc,GAAG,UAAU,GAAG,cAAc,GAAG,eAAe,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,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,GAAG,sBAAsB,GAAG,iCAAiC,GAAG,gCAAgC,GAAG,wBAAwB,CAAC;AAEjK;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACrC,MAAM,EAAE,gCAAgC,CAAC;IACzC,UAAU,EAAE,sBAAsB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,gCAAgC,EAAE,CAAC;CAC/C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAIF,+CAA+C;AAC/C,eAAO,MAAM,mCAAmC,UAAU,CAAC;AAE3D;;;;;;;;GAQG;AACH,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;IAC9B,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC7B,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC7C,CAAC;AA0zBF;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAE,yBAA8B,GAAG,kBAAkB,CA2B9I;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,MAAM,EAAE,kBAAkB,GAAG,iBAAiB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAarI"}