ts-openapi-codegen 2.0.0-beta.9 → 2.1.0-beta.1
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.
- package/README.md +177 -18
- package/README.rus.md +177 -21
- package/dist/cli/analyzeDiff/__tests__/analyzeDiff.cli.test.d.ts +2 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiff.cli.test.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiff.cli.test.js +365 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiffRenameAndInvalidRegex.test.d.ts +2 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiffRenameAndInvalidRegex.test.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiffRenameAndInvalidRegex.test.js +142 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiffTypeCoercion.test.d.ts +2 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiffTypeCoercion.test.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/__tests__/analyzeDiffTypeCoercion.test.js +137 -0
- package/dist/cli/analyzeDiff/analyzeDiff.d.ts +17 -0
- package/dist/cli/analyzeDiff/analyzeDiff.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/analyzeDiff.js +105 -0
- package/dist/cli/analyzeDiff/buildLegacyReport.d.ts +17 -0
- package/dist/cli/analyzeDiff/buildLegacyReport.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/buildLegacyReport.js +54 -0
- package/dist/cli/analyzeDiff/ciSummary.d.ts +6 -0
- package/dist/cli/analyzeDiff/ciSummary.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/ciSummary.js +20 -0
- package/dist/cli/analyzeDiff/diffEngine.d.ts +54 -0
- package/dist/cli/analyzeDiff/diffEngine.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/diffEngine.js +209 -0
- package/dist/cli/analyzeDiff/ignoreRules.d.ts +33 -0
- package/dist/cli/analyzeDiff/ignoreRules.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/ignoreRules.js +93 -0
- package/dist/cli/analyzeDiff/ignoreSemanticChanges.d.ts +10 -0
- package/dist/cli/analyzeDiff/ignoreSemanticChanges.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/ignoreSemanticChanges.js +84 -0
- package/dist/cli/analyzeDiff/logLegacyReport.d.ts +6 -0
- package/dist/cli/analyzeDiff/logLegacyReport.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/logLegacyReport.js +29 -0
- package/dist/cli/analyzeDiff/miracles.d.ts +89 -0
- package/dist/cli/analyzeDiff/miracles.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/miracles.js +325 -0
- package/dist/cli/analyzeDiff/pluginPaths.d.ts +5 -0
- package/dist/cli/analyzeDiff/pluginPaths.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/pluginPaths.js +13 -0
- package/dist/cli/analyzeDiff/report.d.ts +3 -0
- package/dist/cli/analyzeDiff/report.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/report.js +7 -0
- package/dist/cli/analyzeDiff/semanticDiffContext.d.ts +6 -0
- package/dist/cli/analyzeDiff/semanticDiffContext.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/semanticDiffContext.js +16 -0
- package/dist/cli/analyzeDiff/specParser.d.ts +22 -0
- package/dist/cli/analyzeDiff/specParser.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/specParser.js +80 -0
- package/dist/cli/analyzeDiff/types.d.ts +61 -0
- package/dist/cli/analyzeDiff/types.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/types.js +2 -0
- package/dist/cli/analyzeDiff/writeLegacyReport.d.ts +6 -0
- package/dist/cli/analyzeDiff/writeLegacyReport.d.ts.map +1 -0
- package/dist/cli/analyzeDiff/writeLegacyReport.js +21 -0
- package/dist/cli/checkAndUpdateConfig/checkConfig.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/checkConfig.js +13 -8
- package/dist/cli/checkAndUpdateConfig/constants.d.ts +0 -9
- package/dist/cli/checkAndUpdateConfig/constants.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/constants.js +1 -10
- package/dist/cli/checkAndUpdateConfig/updateConfig.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/updateConfig.js +11 -7
- package/dist/cli/checkAndUpdateConfig/utils/selectConfigAction.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/utils/selectConfigAction.js +6 -3
- package/dist/cli/checkAndUpdateConfig/utils/updateExistingConfigFile.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/utils/updateExistingConfigFile.js +3 -2
- package/dist/cli/checkAndUpdateConfig/utils/validateAndMigrateConfigData.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/utils/validateAndMigrateConfigData.js +5 -0
- package/dist/cli/checkAndUpdateConfig/utils/writeExampleConfigFile.d.ts.map +1 -1
- package/dist/cli/checkAndUpdateConfig/utils/writeExampleConfigFile.js +2 -2
- package/dist/cli/generateOpenApiClient/__tests__/generateOpenApiClient.strict.test.d.ts +2 -0
- package/dist/cli/generateOpenApiClient/__tests__/generateOpenApiClient.strict.test.d.ts.map +1 -0
- package/dist/cli/generateOpenApiClient/__tests__/generateOpenApiClient.strict.test.js +152 -0
- package/dist/cli/generateOpenApiClient/generateOpenApiClient.d.ts +6 -2
- package/dist/cli/generateOpenApiClient/generateOpenApiClient.d.ts.map +1 -1
- package/dist/cli/generateOpenApiClient/generateOpenApiClient.js +70 -22
- package/dist/cli/index.js +62 -5
- package/dist/cli/initOpenApiConfig/init.d.ts.map +1 -1
- package/dist/cli/initOpenApiConfig/init.js +19 -6
- package/dist/cli/initOpenApiConfig/initConfig.d.ts +1 -0
- package/dist/cli/initOpenApiConfig/initConfig.d.ts.map +1 -1
- package/dist/cli/initOpenApiConfig/initConfig.js +47 -24
- package/dist/cli/initOpenApiConfig/initCustomRequest.d.ts +8 -1
- package/dist/cli/initOpenApiConfig/initCustomRequest.d.ts.map +1 -1
- package/dist/cli/initOpenApiConfig/initCustomRequest.js +40 -8
- package/dist/cli/initOpenApiConfig/utils/buildConfig.d.ts.map +1 -1
- package/dist/cli/initOpenApiConfig/utils/buildConfig.js +60 -0
- package/dist/cli/initOpenApiConfig/utils/validateSpecFile.d.ts.map +1 -1
- package/dist/cli/initOpenApiConfig/utils/validateSpecFile.js +2 -1
- package/dist/cli/initOpenApiConfig/utils/writeConfigFile.d.ts.map +1 -1
- package/dist/cli/initOpenApiConfig/utils/writeConfigFile.js +2 -1
- package/dist/cli/interactive/confirmDialog.d.ts.map +1 -1
- package/dist/cli/interactive/confirmDialog.js +3 -2
- package/dist/cli/interactive/constants.d.ts +2 -2
- package/dist/cli/interactive/constants.js +8 -8
- package/dist/cli/interactive/selectDialog.d.ts.map +1 -1
- package/dist/cli/interactive/selectDialog.js +11 -6
- package/dist/cli/previewChanges/previewChanges.d.ts.map +1 -1
- package/dist/cli/previewChanges/previewChanges.js +151 -39
- package/dist/cli/previewChanges/utils/updateOutputPaths.d.ts.map +1 -1
- package/dist/cli/previewChanges/utils/updateOutputPaths.js +6 -0
- package/dist/cli/schemas/analyzeDiff.d.ts +14 -0
- package/dist/cli/schemas/analyzeDiff.d.ts.map +1 -0
- package/dist/cli/schemas/analyzeDiff.js +28 -0
- package/dist/cli/schemas/generate.d.ts +9 -0
- package/dist/cli/schemas/generate.d.ts.map +1 -1
- package/dist/cli/schemas/generate.js +9 -0
- package/dist/cli/schemas/index.d.ts +3 -1
- package/dist/cli/schemas/index.d.ts.map +1 -1
- package/dist/cli/schemas/index.js +2 -0
- package/dist/common/Consts.d.ts +1 -0
- package/dist/common/Consts.d.ts.map +1 -1
- package/dist/common/Consts.js +19 -2
- package/dist/common/Logger.d.ts +20 -1
- package/dist/common/Logger.d.ts.map +1 -1
- package/dist/common/Logger.js +70 -9
- package/dist/common/LoggerMessages.d.ts +136 -33
- package/dist/common/LoggerMessages.d.ts.map +1 -1
- package/dist/common/LoggerMessages.js +119 -45
- package/dist/common/VersionedSchema/AllVersionedSchemas/AllMigrationPlans.d.ts +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/AllMigrationPlans.d.ts.map +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/AllMigrationPlans.js +20 -4
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedBase.d.ts +4 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedBase.d.ts.map +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV1.d.ts +10 -2
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV1.d.ts.map +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV2.d.ts +10 -2
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV2.d.ts.map +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV3.d.ts +10 -2
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV3.d.ts.map +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV4.d.ts +77 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV4.d.ts.map +1 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV4.js +41 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV5.d.ts +79 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV5.d.ts.map +1 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedOptionsSchemaV5.js +19 -0
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedVersionedSchemas.d.ts +326 -28
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedVersionedSchemas.d.ts.map +1 -1
- package/dist/common/VersionedSchema/AllVersionedSchemas/UnifiedVersionedSchemas.js +15 -17
- package/dist/common/VersionedSchema/CommonSchemas.d.ts +52 -4
- package/dist/common/VersionedSchema/CommonSchemas.d.ts.map +1 -1
- package/dist/common/VersionedSchema/CommonSchemas.js +48 -7
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV1.d.ts +6 -2
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV1.d.ts.map +1 -1
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV2.d.ts +4 -0
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV2.d.ts.map +1 -1
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV3.d.ts +4 -0
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV3.d.ts.map +1 -1
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV4.d.ts +6 -2
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV4.d.ts.map +1 -1
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV5.d.ts +6 -2
- package/dist/common/VersionedSchema/MultiOptionsVersioned/MultiOptionsSchemaV5.d.ts.map +1 -1
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV1.d.ts +6 -2
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV1.d.ts.map +1 -1
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV2.d.ts +4 -0
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV2.d.ts.map +1 -1
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV3.d.ts +4 -0
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV3.d.ts.map +1 -1
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV4.d.ts +6 -2
- package/dist/common/VersionedSchema/OptionsVersioned/OptionsSchemaV4.d.ts.map +1 -1
- package/dist/common/VersionedSchema/Utils/__mocks__/compatibilityCases.d.ts.map +1 -1
- package/dist/common/VersionedSchema/Utils/__mocks__/compatibilityCases.js +40 -1
- package/dist/common/VersionedSchema/Utils/__tests__/allUtils.test.d.ts +2 -0
- package/dist/common/VersionedSchema/Utils/__tests__/allUtils.test.d.ts.map +1 -0
- package/dist/common/VersionedSchema/Utils/__tests__/allUtils.test.js +185 -0
- package/dist/common/VersionedSchema/Utils/__tests__/compareShapes.test.js +20 -3
- package/dist/common/VersionedSchema/Utils/__tests__/migrateDataToLatestSchemaVersion.test.js +19 -1
- package/dist/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.d.ts +4 -0
- package/dist/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.d.ts.map +1 -1
- package/dist/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.js +68 -23
- package/dist/common/VersionedSchema/Utils/getUniqueKeysFromSchemas.d.ts +1 -1
- package/dist/common/VersionedSchema/Utils/getUniqueKeysFromSchemas.js +1 -1
- package/dist/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.d.ts +10 -0
- package/dist/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.d.ts.map +1 -1
- package/dist/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.js +34 -15
- package/dist/common/__tests__/Logger.test.d.ts +2 -0
- package/dist/common/__tests__/Logger.test.d.ts.map +1 -0
- package/dist/common/__tests__/Logger.test.js +100 -0
- package/dist/common/utils/__tests__/convertArrayToObject.test.js +67 -169
- package/dist/common/utils/__tests__/eslintFix.test.d.ts +2 -0
- package/dist/common/utils/__tests__/eslintFix.test.d.ts.map +1 -0
- package/dist/common/utils/__tests__/eslintFix.test.js +134 -0
- package/dist/common/utils/__tests__/format.test.d.ts +2 -0
- package/dist/common/utils/__tests__/format.test.d.ts.map +1 -0
- package/dist/common/utils/__tests__/format.test.js +90 -0
- package/dist/common/utils/convertArrayToObject.d.ts.map +1 -1
- package/dist/common/utils/convertArrayToObject.js +54 -14
- package/dist/common/utils/eslintFix.d.ts +7 -0
- package/dist/common/utils/eslintFix.d.ts.map +1 -0
- package/dist/common/utils/eslintFix.js +78 -0
- package/dist/common/utils/format.d.ts +1 -1
- package/dist/common/utils/format.d.ts.map +1 -1
- package/dist/common/utils/format.js +39 -15
- package/dist/common/utils/jsonPath.d.ts +5 -0
- package/dist/common/utils/jsonPath.d.ts.map +1 -0
- package/dist/common/utils/jsonPath.js +27 -0
- package/dist/common/utils/normalizeObject.d.ts +2 -0
- package/dist/common/utils/normalizeObject.d.ts.map +1 -0
- package/dist/common/utils/normalizeObject.js +63 -0
- package/dist/core/Context.d.ts +8 -1
- package/dist/core/Context.d.ts.map +1 -1
- package/dist/core/Context.js +23 -4
- package/dist/core/OpenApiClient.d.ts +2 -0
- package/dist/core/OpenApiClient.d.ts.map +1 -1
- package/dist/core/OpenApiClient.js +127 -6
- package/dist/core/WriteClient.d.ts +12 -1
- package/dist/core/WriteClient.d.ts.map +1 -1
- package/dist/core/WriteClient.js +83 -8
- package/dist/core/__tests__/WriteClient.test.js +6 -1
- package/dist/core/api/v2/parser/__tests__/getModel.test.d.ts +2 -0
- package/dist/core/api/v2/parser/__tests__/getModel.test.d.ts.map +1 -0
- package/dist/core/api/v2/parser/__tests__/getModel.test.js +34 -0
- package/dist/core/api/v2/parser/getModel.d.ts.map +1 -1
- package/dist/core/api/v2/parser/getModel.js +6 -1
- package/dist/core/api/v2/parser/getOperation.d.ts.map +1 -1
- package/dist/core/api/v2/parser/getOperation.js +2 -0
- package/dist/core/api/v2/parser/getOperationResponses.d.ts.map +1 -1
- package/dist/core/api/v2/parser/getOperationResponses.js +9 -1
- package/dist/core/api/v2/parser/getType.d.ts.map +1 -1
- package/dist/core/api/v2/parser/getType.js +2 -1
- package/dist/core/api/v2/types/OpenApiSchema.model.d.ts +2 -0
- package/dist/core/api/v2/types/OpenApiSchema.model.d.ts.map +1 -1
- package/dist/core/api/v3/parser/__tests__/getContent.test.d.ts +2 -0
- package/dist/core/api/v3/parser/__tests__/getContent.test.d.ts.map +1 -0
- package/dist/core/api/v3/parser/__tests__/getContent.test.js +65 -0
- package/dist/core/api/v3/parser/__tests__/getModel.test.d.ts +2 -0
- package/dist/core/api/v3/parser/__tests__/getModel.test.d.ts.map +1 -0
- package/dist/core/api/v3/parser/__tests__/getModel.test.js +34 -0
- package/dist/core/api/v3/parser/getContent.d.ts.map +1 -1
- package/dist/core/api/v3/parser/getContent.js +21 -11
- package/dist/core/api/v3/parser/getModel.d.ts.map +1 -1
- package/dist/core/api/v3/parser/getModel.js +6 -1
- package/dist/core/api/v3/parser/getOperation.d.ts.map +1 -1
- package/dist/core/api/v3/parser/getOperation.js +2 -0
- package/dist/core/api/v3/parser/getOperationResponses.d.ts.map +1 -1
- package/dist/core/api/v3/parser/getOperationResponses.js +9 -1
- package/dist/core/api/v3/parser/getType.d.ts.map +1 -1
- package/dist/core/api/v3/parser/getType.js +2 -1
- package/dist/core/api/v3/types/OpenApiSchema.model.d.ts +2 -0
- package/dist/core/api/v3/types/OpenApiSchema.model.d.ts.map +1 -1
- package/dist/core/governance/__tests__/evaluateGovernanceRules.test.d.ts +2 -0
- package/dist/core/governance/__tests__/evaluateGovernanceRules.test.d.ts.map +1 -0
- package/dist/core/governance/__tests__/evaluateGovernanceRules.test.js +100 -0
- package/dist/core/governance/__tests__/loadGovernanceConfig.test.d.ts +2 -0
- package/dist/core/governance/__tests__/loadGovernanceConfig.test.d.ts.map +1 -0
- package/dist/core/governance/__tests__/loadGovernanceConfig.test.js +71 -0
- package/dist/core/governance/evaluateGovernanceRules.d.ts +42 -0
- package/dist/core/governance/evaluateGovernanceRules.d.ts.map +1 -0
- package/dist/core/governance/evaluateGovernanceRules.js +134 -0
- package/dist/core/governance/governanceConfigSchema.d.ts +4 -0
- package/dist/core/governance/governanceConfigSchema.d.ts.map +1 -0
- package/dist/core/governance/governanceConfigSchema.js +39 -0
- package/dist/core/governance/loadGovernanceConfig.d.ts +7 -0
- package/dist/core/governance/loadGovernanceConfig.d.ts.map +1 -0
- package/dist/core/governance/loadGovernanceConfig.js +60 -0
- package/dist/core/index.d.ts +3 -0
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.js +4 -2
- package/dist/core/plugins/GeneratorPlugin.model.d.ts +42 -0
- package/dist/core/plugins/GeneratorPlugin.model.d.ts.map +1 -0
- package/dist/core/plugins/GeneratorPlugin.model.js +2 -0
- package/dist/core/plugins/__tests__/applySemanticDiffPluginHooks.test.d.ts +2 -0
- package/dist/core/plugins/__tests__/applySemanticDiffPluginHooks.test.d.ts.map +1 -0
- package/dist/core/plugins/__tests__/applySemanticDiffPluginHooks.test.js +115 -0
- package/dist/core/plugins/__tests__/loadGeneratorPlugins.test.d.ts +2 -0
- package/dist/core/plugins/__tests__/loadGeneratorPlugins.test.d.ts.map +1 -0
- package/dist/core/plugins/__tests__/loadGeneratorPlugins.test.js +62 -0
- package/dist/core/plugins/applySemanticDiffPluginHooks.d.ts +28 -0
- package/dist/core/plugins/applySemanticDiffPluginHooks.d.ts.map +1 -0
- package/dist/core/plugins/applySemanticDiffPluginHooks.js +160 -0
- package/dist/core/plugins/builtins/xTypescriptTypePlugin.d.ts +6 -0
- package/dist/core/plugins/builtins/xTypescriptTypePlugin.d.ts.map +1 -0
- package/dist/core/plugins/builtins/xTypescriptTypePlugin.js +13 -0
- package/dist/core/plugins/getBuiltinPlugins.d.ts +6 -0
- package/dist/core/plugins/getBuiltinPlugins.d.ts.map +1 -0
- package/dist/core/plugins/getBuiltinPlugins.js +10 -0
- package/dist/core/plugins/index.d.ts +4 -0
- package/dist/core/plugins/index.d.ts.map +1 -0
- package/dist/core/plugins/index.js +5 -0
- package/dist/core/plugins/loadGeneratorPlugins.d.ts +6 -0
- package/dist/core/plugins/loadGeneratorPlugins.d.ts.map +1 -0
- package/dist/core/plugins/loadGeneratorPlugins.js +94 -0
- package/dist/core/semanticDiff/__tests__/analyzeOpenApiDiff.test.d.ts +2 -0
- package/dist/core/semanticDiff/__tests__/analyzeOpenApiDiff.test.d.ts.map +1 -0
- package/dist/core/semanticDiff/__tests__/analyzeOpenApiDiff.test.js +537 -0
- package/dist/core/semanticDiff/__tests__/semanticDiffReportSchema.test.d.ts +2 -0
- package/dist/core/semanticDiff/__tests__/semanticDiffReportSchema.test.d.ts.map +1 -0
- package/dist/core/semanticDiff/__tests__/semanticDiffReportSchema.test.js +66 -0
- package/dist/core/semanticDiff/analyzeOpenApiDiff.d.ts +45 -0
- package/dist/core/semanticDiff/analyzeOpenApiDiff.d.ts.map +1 -0
- package/dist/core/semanticDiff/analyzeOpenApiDiff.js +640 -0
- package/dist/core/semanticDiff/semanticDiffReportSchema.d.ts +11 -0
- package/dist/core/semanticDiff/semanticDiffReportSchema.d.ts.map +1 -0
- package/dist/core/semanticDiff/semanticDiffReportSchema.js +132 -0
- package/dist/core/strict/__tests__/validateOpenApiStrict.test.d.ts +2 -0
- package/dist/core/strict/__tests__/validateOpenApiStrict.test.d.ts.map +1 -0
- package/dist/core/strict/__tests__/validateOpenApiStrict.test.js +156 -0
- package/dist/core/strict/validateOpenApiStrict.d.ts +43 -0
- package/dist/core/strict/validateOpenApiStrict.d.ts.map +1 -0
- package/dist/core/strict/validateOpenApiStrict.js +253 -0
- package/dist/core/types/base/ClientArtifacts.model.d.ts +2 -0
- package/dist/core/types/base/ClientArtifacts.model.d.ts.map +1 -1
- package/dist/core/types/base/Templates.model.d.ts +4 -1
- package/dist/core/types/base/Templates.model.d.ts.map +1 -1
- package/dist/core/types/enums/EmptySchemaStrategy.enum.d.ts +6 -0
- package/dist/core/types/enums/EmptySchemaStrategy.enum.d.ts.map +1 -0
- package/dist/core/types/enums/EmptySchemaStrategy.enum.js +9 -0
- package/dist/core/types/enums/ModelsMode.enum.d.ts +5 -0
- package/dist/core/types/enums/ModelsMode.enum.d.ts.map +1 -0
- package/dist/core/types/enums/ModelsMode.enum.js +8 -0
- package/dist/core/types/shared/Client.model.d.ts +2 -0
- package/dist/core/types/shared/Client.model.d.ts.map +1 -1
- package/dist/core/types/shared/DiffInfo.model.d.ts +13 -0
- package/dist/core/types/shared/DiffInfo.model.d.ts.map +1 -0
- package/dist/core/types/shared/DiffInfo.model.js +2 -0
- package/dist/core/types/shared/Miracle.model.d.ts +13 -0
- package/dist/core/types/shared/Miracle.model.d.ts.map +1 -0
- package/dist/core/types/shared/Miracle.model.js +2 -0
- package/dist/core/types/shared/Model.model.d.ts +23 -0
- package/dist/core/types/shared/Model.model.d.ts.map +1 -1
- package/dist/core/types/shared/Operation.model.d.ts +5 -0
- package/dist/core/types/shared/Operation.model.d.ts.map +1 -1
- package/dist/core/utils/__mocks__/templates.d.ts.map +1 -1
- package/dist/core/utils/__mocks__/templates.js +9 -0
- package/dist/core/utils/__tests__/applyDiffReportToClient.test.d.ts +2 -0
- package/dist/core/utils/__tests__/applyDiffReportToClient.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/applyDiffReportToClient.test.js +108 -0
- package/dist/core/utils/__tests__/getMappedType.test.js +2 -0
- package/dist/core/utils/__tests__/getOperationResponseCode.test.js +7 -2
- package/dist/core/utils/__tests__/getOperationResults.test.d.ts +2 -0
- package/dist/core/utils/__tests__/getOperationResults.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/getOperationResults.test.js +43 -0
- package/dist/core/utils/__tests__/getRelativeModelPath.test.d.ts +2 -0
- package/dist/core/utils/__tests__/getRelativeModelPath.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/getRelativeModelPath.test.js +27 -0
- package/dist/core/utils/__tests__/modelHelpers.test.d.ts +2 -0
- package/dist/core/utils/__tests__/modelHelpers.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/modelHelpers.test.js +151 -0
- package/dist/core/utils/__tests__/postProcessModelImports.test.d.ts +2 -0
- package/dist/core/utils/__tests__/postProcessModelImports.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/postProcessModelImports.test.js +67 -0
- package/dist/core/utils/__tests__/postProcessServiceImports.test.d.ts +2 -0
- package/dist/core/utils/__tests__/postProcessServiceImports.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/postProcessServiceImports.test.js +26 -0
- package/dist/core/utils/__tests__/prepareDtoModels.test.d.ts +2 -0
- package/dist/core/utils/__tests__/prepareDtoModels.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/prepareDtoModels.test.js +116 -0
- package/dist/core/utils/__tests__/resolveRefPath.test.d.ts +2 -0
- package/dist/core/utils/__tests__/resolveRefPath.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/resolveRefPath.test.js +22 -0
- package/dist/core/utils/__tests__/serviceHelpers.test.d.ts +2 -0
- package/dist/core/utils/__tests__/serviceHelpers.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/serviceHelpers.test.js +122 -0
- package/dist/core/utils/__tests__/writeClientExecutor.test.d.ts +2 -0
- package/dist/core/utils/__tests__/writeClientExecutor.test.d.ts.map +1 -0
- package/dist/core/utils/__tests__/writeClientExecutor.test.js +20 -0
- package/dist/core/utils/__tests__/writeClientModels.test.js +50 -0
- package/dist/core/utils/__tests__/writeClientSchemas.test.js +2 -0
- package/dist/core/utils/applyDiffReportToClient.d.ts +14 -0
- package/dist/core/utils/applyDiffReportToClient.d.ts.map +1 -0
- package/dist/core/utils/applyDiffReportToClient.js +367 -0
- package/dist/core/utils/getMappedType.d.ts.map +1 -1
- package/dist/core/utils/getMappedType.js +2 -0
- package/dist/core/utils/getOperationResponseCode.d.ts.map +1 -1
- package/dist/core/utils/getOperationResponseCode.js +10 -8
- package/dist/core/utils/getRelativeModelPath.d.ts +9 -0
- package/dist/core/utils/getRelativeModelPath.d.ts.map +1 -0
- package/dist/core/utils/getRelativeModelPath.js +37 -0
- package/dist/core/utils/loadDiffReport.d.ts +39 -0
- package/dist/core/utils/loadDiffReport.d.ts.map +1 -0
- package/dist/core/utils/loadDiffReport.js +51 -0
- package/dist/core/utils/modelHelpers.d.ts.map +1 -1
- package/dist/core/utils/modelHelpers.js +37 -3
- package/dist/core/utils/postProcessModelImports.d.ts.map +1 -1
- package/dist/core/utils/postProcessModelImports.js +14 -1
- package/dist/core/utils/postProcessServiceImports.d.ts.map +1 -1
- package/dist/core/utils/postProcessServiceImports.js +1 -2
- package/dist/core/utils/precompileTemplates.js +1 -0
- package/dist/core/utils/prepareDtoModels.d.ts +3 -0
- package/dist/core/utils/prepareDtoModels.d.ts.map +1 -0
- package/dist/core/utils/prepareDtoModels.js +189 -0
- package/dist/core/utils/registerHandlebarHelpers.d.ts.map +1 -1
- package/dist/core/utils/registerHandlebarHelpers.js +29 -1
- package/dist/core/utils/registerHandlebarTemplates.d.ts.map +1 -1
- package/dist/core/utils/registerHandlebarTemplates.js +48 -41
- package/dist/core/utils/resolveRefPath.d.ts.map +1 -1
- package/dist/core/utils/resolveRefPath.js +1 -4
- package/dist/core/utils/validateRawOptions.d.ts +1 -1
- package/dist/core/utils/validateRawOptions.d.ts.map +1 -1
- package/dist/core/utils/validateRawOptions.js +4 -2
- package/dist/core/utils/writeClientCore.d.ts +2 -0
- package/dist/core/utils/writeClientCore.d.ts.map +1 -1
- package/dist/core/utils/writeClientCore.js +6 -1
- package/dist/core/utils/writeClientCoreIndex.d.ts +1 -0
- package/dist/core/utils/writeClientCoreIndex.d.ts.map +1 -1
- package/dist/core/utils/writeClientCoreIndex.js +2 -2
- package/dist/core/utils/writeClientExecutor.d.ts +6 -1
- package/dist/core/utils/writeClientExecutor.d.ts.map +1 -1
- package/dist/core/utils/writeClientExecutor.js +22 -3
- package/dist/core/utils/writeClientFullIndex.d.ts.map +1 -1
- package/dist/core/utils/writeClientFullIndex.js +3 -1
- package/dist/core/utils/writeClientModels.d.ts +6 -0
- package/dist/core/utils/writeClientModels.d.ts.map +1 -1
- package/dist/core/utils/writeClientModels.js +24 -3
- package/dist/core/utils/writeClientModelsIndex.d.ts +2 -0
- package/dist/core/utils/writeClientModelsIndex.d.ts.map +1 -1
- package/dist/core/utils/writeClientModelsIndex.js +2 -2
- package/dist/core/utils/writeClientSchemas.d.ts +6 -1
- package/dist/core/utils/writeClientSchemas.d.ts.map +1 -1
- package/dist/core/utils/writeClientSchemas.js +16 -3
- package/dist/core/utils/writeClientServices.d.ts +2 -0
- package/dist/core/utils/writeClientServices.d.ts.map +1 -1
- package/dist/core/utils/writeClientServices.js +6 -2
- package/dist/templatesCompiled/cli/openApiConfig.d.ts +4 -1
- package/dist/templatesCompiled/cli/openApiConfig.d.ts.map +1 -1
- package/dist/templatesCompiled/cli/openApiConfig.js +88 -37
- package/dist/templatesCompiled/client/core/ApiError.js +1 -1
- package/dist/templatesCompiled/client/core/ApiRequestOptions.js +1 -1
- package/dist/templatesCompiled/client/core/ApiResult.js +1 -1
- package/dist/templatesCompiled/client/core/BaseDto.d.ts +8 -0
- package/dist/templatesCompiled/client/core/BaseDto.d.ts.map +1 -0
- package/dist/templatesCompiled/client/core/BaseDto.js +18 -0
- package/dist/templatesCompiled/client/core/axios/getResponseBody.js +1 -1
- package/dist/templatesCompiled/client/core/axios/request.js +3 -3
- package/dist/templatesCompiled/client/core/axios/sendRequest.js +4 -4
- package/dist/templatesCompiled/client/core/dtoUtils.d.ts +8 -0
- package/dist/templatesCompiled/client/core/dtoUtils.d.ts.map +1 -0
- package/dist/templatesCompiled/client/core/dtoUtils.js +18 -0
- package/dist/templatesCompiled/client/core/executor/createExecutorAdapter.d.ts +2 -0
- package/dist/templatesCompiled/client/core/executor/createExecutorAdapter.d.ts.map +1 -1
- package/dist/templatesCompiled/client/core/executor/createExecutorAdapter.js +13 -8
- package/dist/templatesCompiled/client/core/executor/requestExecutor.js +1 -1
- package/dist/templatesCompiled/client/core/fetch/getResponseBody.js +1 -1
- package/dist/templatesCompiled/client/core/fetch/request.js +3 -3
- package/dist/templatesCompiled/client/core/functions/catchErrors.js +1 -1
- package/dist/templatesCompiled/client/core/functions/isBinary.js +1 -1
- package/dist/templatesCompiled/client/core/interceptors/withInterceptors.js +1 -1
- package/dist/templatesCompiled/client/core/node/getResponseBody.js +1 -1
- package/dist/templatesCompiled/client/core/node/request.js +3 -3
- package/dist/templatesCompiled/client/core/xhr/getResponseBody.js +1 -1
- package/dist/templatesCompiled/client/core/xhr/request.js +3 -3
- package/dist/templatesCompiled/client/core/xhr/sendRequest.js +4 -4
- package/dist/templatesCompiled/client/exportClient.d.ts +4 -0
- package/dist/templatesCompiled/client/exportClient.d.ts.map +1 -1
- package/dist/templatesCompiled/client/exportClient.js +51 -13
- package/dist/templatesCompiled/client/exportModels.d.ts +34 -0
- package/dist/templatesCompiled/client/exportModels.d.ts.map +1 -0
- package/dist/templatesCompiled/client/exportModels.js +280 -0
- package/dist/templatesCompiled/client/exportSchema.d.ts +5 -1
- package/dist/templatesCompiled/client/exportSchema.d.ts.map +1 -1
- package/dist/templatesCompiled/client/exportSchema.js +37 -7
- package/dist/templatesCompiled/client/exportService.d.ts +9 -4
- package/dist/templatesCompiled/client/exportService.d.ts.map +1 -1
- package/dist/templatesCompiled/client/exportService.js +96 -37
- package/dist/templatesCompiled/client/indexCore.d.ts +3 -1
- package/dist/templatesCompiled/client/indexCore.d.ts.map +1 -1
- package/dist/templatesCompiled/client/indexCore.js +13 -2
- package/dist/templatesCompiled/client/indexFull.d.ts +10 -7
- package/dist/templatesCompiled/client/indexFull.d.ts.map +1 -1
- package/dist/templatesCompiled/client/indexFull.js +54 -33
- package/dist/templatesCompiled/client/indexModels.d.ts +7 -5
- package/dist/templatesCompiled/client/indexModels.d.ts.map +1 -1
- package/dist/templatesCompiled/client/indexModels.js +27 -18
- package/dist/templatesCompiled/client/indexSimple.d.ts +1 -0
- package/dist/templatesCompiled/client/indexSimple.d.ts.map +1 -1
- package/dist/templatesCompiled/client/indexSimple.js +4 -1
- package/dist/templatesCompiled/client/joi/exportSchema.js +5 -5
- package/dist/templatesCompiled/client/joi/partials/joiSchema.js +7 -7
- package/dist/templatesCompiled/client/joi/partials/joiSchemaComposition.js +4 -4
- package/dist/templatesCompiled/client/joi/partials/joiSchemaGeneric.d.ts +27 -19
- package/dist/templatesCompiled/client/joi/partials/joiSchemaGeneric.d.ts.map +1 -1
- package/dist/templatesCompiled/client/joi/partials/joiSchemaGeneric.js +144 -63
- package/dist/templatesCompiled/client/joi/partials/joiSchemaInterface.d.ts +5 -3
- package/dist/templatesCompiled/client/joi/partials/joiSchemaInterface.d.ts.map +1 -1
- package/dist/templatesCompiled/client/joi/partials/joiSchemaInterface.js +39 -12
- package/dist/templatesCompiled/client/jsonschema/exportSchema.d.ts +1 -0
- package/dist/templatesCompiled/client/jsonschema/exportSchema.d.ts.map +1 -1
- package/dist/templatesCompiled/client/jsonschema/exportSchema.js +21 -17
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchema.js +7 -7
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchemaArray.js +5 -5
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchemaComposition.js +2 -2
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchemaDictionary.js +5 -5
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchemaInterface.d.ts +3 -1
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchemaInterface.d.ts.map +1 -1
- package/dist/templatesCompiled/client/jsonschema/partials/jsonschemaSchemaInterface.js +45 -15
- package/dist/templatesCompiled/client/partials/exportInterface.d.ts +13 -5
- package/dist/templatesCompiled/client/partials/exportInterface.d.ts.map +1 -1
- package/dist/templatesCompiled/client/partials/exportInterface.js +91 -21
- package/dist/templatesCompiled/client/partials/result.d.ts +6 -4
- package/dist/templatesCompiled/client/partials/result.d.ts.map +1 -1
- package/dist/templatesCompiled/client/partials/result.js +16 -6
- package/dist/templatesCompiled/client/partials/serviceOption.d.ts +1 -0
- package/dist/templatesCompiled/client/partials/serviceOption.d.ts.map +1 -1
- package/dist/templatesCompiled/client/partials/serviceOption.js +11 -4
- package/dist/templatesCompiled/client/yup/exportSchema.js +3 -3
- package/dist/templatesCompiled/client/yup/partials/yupSchema.js +7 -7
- package/dist/templatesCompiled/client/yup/partials/yupSchemaComposition.js +4 -4
- package/dist/templatesCompiled/client/yup/partials/yupSchemaGeneric.d.ts +22 -16
- package/dist/templatesCompiled/client/yup/partials/yupSchemaGeneric.d.ts.map +1 -1
- package/dist/templatesCompiled/client/yup/partials/yupSchemaGeneric.js +72 -60
- package/dist/templatesCompiled/client/yup/partials/yupSchemaInterface.d.ts +5 -3
- package/dist/templatesCompiled/client/yup/partials/yupSchemaInterface.d.ts.map +1 -1
- package/dist/templatesCompiled/client/yup/partials/yupSchemaInterface.js +39 -12
- package/dist/templatesCompiled/client/zod/exportSchema.js +3 -3
- package/dist/templatesCompiled/client/zod/partials/zodSchema.js +7 -7
- package/dist/templatesCompiled/client/zod/partials/zodSchemaArray.d.ts +5 -6
- package/dist/templatesCompiled/client/zod/partials/zodSchemaArray.d.ts.map +1 -1
- package/dist/templatesCompiled/client/zod/partials/zodSchemaArray.js +14 -28
- package/dist/templatesCompiled/client/zod/partials/zodSchemaComposition.d.ts +3 -0
- package/dist/templatesCompiled/client/zod/partials/zodSchemaComposition.d.ts.map +1 -1
- package/dist/templatesCompiled/client/zod/partials/zodSchemaComposition.js +32 -8
- package/dist/templatesCompiled/client/zod/partials/zodSchemaDictionary.d.ts +3 -4
- package/dist/templatesCompiled/client/zod/partials/zodSchemaDictionary.d.ts.map +1 -1
- package/dist/templatesCompiled/client/zod/partials/zodSchemaDictionary.js +9 -23
- package/dist/templatesCompiled/client/zod/partials/zodSchemaGeneric.d.ts +27 -19
- package/dist/templatesCompiled/client/zod/partials/zodSchemaGeneric.d.ts.map +1 -1
- package/dist/templatesCompiled/client/zod/partials/zodSchemaGeneric.js +77 -61
- package/dist/templatesCompiled/client/zod/partials/zodSchemaInterface.d.ts +4 -2
- package/dist/templatesCompiled/client/zod/partials/zodSchemaInterface.d.ts.map +1 -1
- package/dist/templatesCompiled/client/zod/partials/zodSchemaInterface.js +18 -7
- package/package.json +8 -6
- package/dist/common/defaultOptions.d.ts +0 -3
- package/dist/common/defaultOptions.d.ts.map +0 -1
- package/dist/common/defaultOptions.js +0 -28
- package/dist/core/utils/advancedDeduplicatePath.d.ts +0 -5
- package/dist/core/utils/advancedDeduplicatePath.d.ts.map +0 -1
- package/dist/core/utils/advancedDeduplicatePath.js +0 -29
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.semanticDiffReportJsonSchema = void 0;
|
|
4
|
+
exports.validateSemanticDiffReportSchema = validateSemanticDiffReportSchema;
|
|
5
|
+
const json_schema_1 = require("json-schema");
|
|
6
|
+
const analyzeOpenApiDiff_1 = require("./analyzeOpenApiDiff");
|
|
7
|
+
exports.semanticDiffReportJsonSchema = {
|
|
8
|
+
type: 'object',
|
|
9
|
+
additionalProperties: false,
|
|
10
|
+
properties: {
|
|
11
|
+
schemaVersion: {
|
|
12
|
+
type: 'string',
|
|
13
|
+
enum: [analyzeOpenApiDiff_1.SEMANTIC_DIFF_REPORT_SCHEMA_VERSION],
|
|
14
|
+
required: true,
|
|
15
|
+
},
|
|
16
|
+
summary: {
|
|
17
|
+
type: 'object',
|
|
18
|
+
additionalProperties: false,
|
|
19
|
+
required: true,
|
|
20
|
+
properties: {
|
|
21
|
+
breaking: { type: 'integer', minimum: 0, required: true },
|
|
22
|
+
nonBreaking: { type: 'integer', minimum: 0, required: true },
|
|
23
|
+
informational: { type: 'integer', minimum: 0, required: true },
|
|
24
|
+
},
|
|
25
|
+
},
|
|
26
|
+
recommendation: {
|
|
27
|
+
type: 'object',
|
|
28
|
+
additionalProperties: false,
|
|
29
|
+
required: true,
|
|
30
|
+
properties: {
|
|
31
|
+
semver: {
|
|
32
|
+
type: 'string',
|
|
33
|
+
enum: ['major', 'minor', 'patch'],
|
|
34
|
+
required: true,
|
|
35
|
+
},
|
|
36
|
+
confidence: {
|
|
37
|
+
type: 'string',
|
|
38
|
+
enum: ['high', 'medium', 'low'],
|
|
39
|
+
required: true,
|
|
40
|
+
},
|
|
41
|
+
reason: {
|
|
42
|
+
type: 'string',
|
|
43
|
+
minLength: 1,
|
|
44
|
+
required: true,
|
|
45
|
+
},
|
|
46
|
+
reasons: {
|
|
47
|
+
type: 'array',
|
|
48
|
+
minItems: 1,
|
|
49
|
+
required: true,
|
|
50
|
+
items: {
|
|
51
|
+
type: 'string',
|
|
52
|
+
enum: [
|
|
53
|
+
'HAS_BREAKING_CHANGES',
|
|
54
|
+
'HAS_BACKWARD_COMPATIBLE_CHANGES',
|
|
55
|
+
'HAS_INFORMATIONAL_ONLY_CHANGES',
|
|
56
|
+
'NO_API_SURFACE_CHANGES',
|
|
57
|
+
],
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
},
|
|
62
|
+
governance: {
|
|
63
|
+
type: 'object',
|
|
64
|
+
additionalProperties: false,
|
|
65
|
+
required: true,
|
|
66
|
+
properties: {
|
|
67
|
+
summary: {
|
|
68
|
+
type: 'object',
|
|
69
|
+
additionalProperties: false,
|
|
70
|
+
required: true,
|
|
71
|
+
properties: {
|
|
72
|
+
errors: { type: 'integer', minimum: 0, required: true },
|
|
73
|
+
warnings: { type: 'integer', minimum: 0, required: true },
|
|
74
|
+
info: { type: 'integer', minimum: 0, required: true },
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
violations: {
|
|
78
|
+
type: 'array',
|
|
79
|
+
required: true,
|
|
80
|
+
items: {
|
|
81
|
+
type: 'object',
|
|
82
|
+
additionalProperties: false,
|
|
83
|
+
properties: {
|
|
84
|
+
ruleId: { type: 'string', minLength: 1, required: true },
|
|
85
|
+
severity: {
|
|
86
|
+
type: 'string',
|
|
87
|
+
enum: ['error', 'warning', 'info'],
|
|
88
|
+
required: true,
|
|
89
|
+
},
|
|
90
|
+
message: { type: 'string', minLength: 1, required: true },
|
|
91
|
+
path: { type: 'string', minLength: 1, required: true },
|
|
92
|
+
},
|
|
93
|
+
},
|
|
94
|
+
},
|
|
95
|
+
},
|
|
96
|
+
},
|
|
97
|
+
changes: {
|
|
98
|
+
type: 'array',
|
|
99
|
+
required: true,
|
|
100
|
+
items: {
|
|
101
|
+
type: 'object',
|
|
102
|
+
additionalProperties: false,
|
|
103
|
+
properties: {
|
|
104
|
+
type: { type: 'string', minLength: 1, required: true },
|
|
105
|
+
severity: {
|
|
106
|
+
type: 'string',
|
|
107
|
+
enum: ['breaking', 'non-breaking', 'informational'],
|
|
108
|
+
required: true,
|
|
109
|
+
},
|
|
110
|
+
message: { type: 'string', minLength: 1, required: true },
|
|
111
|
+
path: { type: 'string', minLength: 1, required: true },
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
},
|
|
115
|
+
},
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Validates semantic diff report payload by JSON Schema contract.
|
|
119
|
+
*/
|
|
120
|
+
function validateSemanticDiffReportSchema(report) {
|
|
121
|
+
if (report === null || typeof report !== 'object') {
|
|
122
|
+
return {
|
|
123
|
+
valid: false,
|
|
124
|
+
errors: ['root: report must be an object'],
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
const result = (0, json_schema_1.validate)(report, exports.semanticDiffReportJsonSchema);
|
|
128
|
+
return {
|
|
129
|
+
valid: result.valid,
|
|
130
|
+
errors: result.errors.map(error => `${error.property}: ${error.message}`),
|
|
131
|
+
};
|
|
132
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validateOpenApiStrict.test.d.ts","sourceRoot":"","sources":["../../../../src/core/strict/__tests__/validateOpenApiStrict.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const node_assert_1 = __importDefault(require("node:assert"));
|
|
7
|
+
const node_test_1 = require("node:test");
|
|
8
|
+
const validateOpenApiStrict_1 = require("../validateOpenApiStrict");
|
|
9
|
+
(0, node_test_1.describe)('@unit: validateOpenApiStrict', () => {
|
|
10
|
+
(0, node_test_1.test)('reports unresolved refs, fallback media type, suspicious default response, and missing operationId', () => {
|
|
11
|
+
const openApi = {
|
|
12
|
+
paths: {
|
|
13
|
+
'/pets': {
|
|
14
|
+
post: {
|
|
15
|
+
requestBody: {
|
|
16
|
+
content: {
|
|
17
|
+
'text/plain': {
|
|
18
|
+
schema: { type: 'string' },
|
|
19
|
+
},
|
|
20
|
+
},
|
|
21
|
+
},
|
|
22
|
+
responses: {
|
|
23
|
+
default: {
|
|
24
|
+
description: 'ok',
|
|
25
|
+
content: {
|
|
26
|
+
'application/problem+json': {
|
|
27
|
+
schema: { type: 'object' },
|
|
28
|
+
},
|
|
29
|
+
},
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
const report = (0, validateOpenApiStrict_1.validateOpenApiStrict)({
|
|
37
|
+
openApi,
|
|
38
|
+
context: {
|
|
39
|
+
paths: () => ['/spec/main.yaml'],
|
|
40
|
+
get: () => ({
|
|
41
|
+
components: {
|
|
42
|
+
schemas: {
|
|
43
|
+
Pet: {
|
|
44
|
+
$ref: '#/components/schemas/Missing',
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
}),
|
|
49
|
+
exists: () => false,
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
node_assert_1.default.strictEqual(report.summary.errors, 1);
|
|
53
|
+
node_assert_1.default.strictEqual(report.summary.warnings, 3);
|
|
54
|
+
node_assert_1.default.strictEqual(report.summary.info, 1);
|
|
55
|
+
node_assert_1.default.ok(report.issues.some(issue => issue.code === 'UNRESOLVED_REF'));
|
|
56
|
+
node_assert_1.default.ok(report.issues.some(issue => issue.code === 'CONTENT_MEDIA_TYPE_FALLBACK'));
|
|
57
|
+
node_assert_1.default.ok(report.issues.some(issue => issue.code === 'SUSPICIOUS_DEFAULT_RESPONSE'));
|
|
58
|
+
node_assert_1.default.ok(report.issues.some(issue => issue.code === 'MISSING_OPERATION_ID'));
|
|
59
|
+
node_assert_1.default.ok(report.governance.violations.some(violation => violation.ruleId === 'REQUIRE_OPERATION_ID'));
|
|
60
|
+
node_assert_1.default.ok(report.governance.violations.some(violation => violation.ruleId === 'NO_DEFAULT_WITHOUT_2XX'));
|
|
61
|
+
});
|
|
62
|
+
(0, node_test_1.test)('returns clean report when no strict issues found', () => {
|
|
63
|
+
const openApi = {
|
|
64
|
+
paths: {
|
|
65
|
+
'/pets': {
|
|
66
|
+
get: {
|
|
67
|
+
operationId: 'getPets',
|
|
68
|
+
responses: {
|
|
69
|
+
'200': {
|
|
70
|
+
description: 'ok',
|
|
71
|
+
content: {
|
|
72
|
+
'application/json': {
|
|
73
|
+
schema: { type: 'array' },
|
|
74
|
+
},
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
},
|
|
78
|
+
},
|
|
79
|
+
},
|
|
80
|
+
},
|
|
81
|
+
};
|
|
82
|
+
const report = (0, validateOpenApiStrict_1.validateOpenApiStrict)({
|
|
83
|
+
openApi,
|
|
84
|
+
context: {
|
|
85
|
+
paths: () => ['/spec/main.yaml'],
|
|
86
|
+
get: () => ({}),
|
|
87
|
+
exists: () => true,
|
|
88
|
+
},
|
|
89
|
+
});
|
|
90
|
+
node_assert_1.default.deepStrictEqual(report.summary, {
|
|
91
|
+
errors: 0,
|
|
92
|
+
warnings: 0,
|
|
93
|
+
info: 0,
|
|
94
|
+
});
|
|
95
|
+
node_assert_1.default.deepStrictEqual(report.issues, []);
|
|
96
|
+
node_assert_1.default.deepStrictEqual(report.governance.violations, []);
|
|
97
|
+
});
|
|
98
|
+
(0, node_test_1.test)('includes preIssues from parser validation into final report', () => {
|
|
99
|
+
const report = (0, validateOpenApiStrict_1.validateOpenApiStrict)({
|
|
100
|
+
openApi: { paths: {} },
|
|
101
|
+
context: {
|
|
102
|
+
paths: () => [],
|
|
103
|
+
get: () => ({}),
|
|
104
|
+
exists: () => true,
|
|
105
|
+
},
|
|
106
|
+
preIssues: [
|
|
107
|
+
{
|
|
108
|
+
severity: 'error',
|
|
109
|
+
code: 'OPENAPI_PARSER_VALIDATION_FAILED',
|
|
110
|
+
message: 'Parser validation failed',
|
|
111
|
+
path: '/spec/openapi.yaml',
|
|
112
|
+
},
|
|
113
|
+
],
|
|
114
|
+
});
|
|
115
|
+
node_assert_1.default.strictEqual(report.summary.errors, 1);
|
|
116
|
+
node_assert_1.default.strictEqual(report.summary.warnings, 0);
|
|
117
|
+
node_assert_1.default.strictEqual(report.summary.info, 0);
|
|
118
|
+
node_assert_1.default.strictEqual(report.issues.length, 1);
|
|
119
|
+
node_assert_1.default.strictEqual(report.issues[0].code, 'OPENAPI_PARSER_VALIDATION_FAILED');
|
|
120
|
+
node_assert_1.default.deepStrictEqual(report.governance.violations, []);
|
|
121
|
+
});
|
|
122
|
+
(0, node_test_1.test)('applies governance config overrides in strict mode', () => {
|
|
123
|
+
const report = (0, validateOpenApiStrict_1.validateOpenApiStrict)({
|
|
124
|
+
openApi: {
|
|
125
|
+
paths: {
|
|
126
|
+
'/pets': {
|
|
127
|
+
get: {
|
|
128
|
+
responses: {
|
|
129
|
+
default: {
|
|
130
|
+
description: 'fallback',
|
|
131
|
+
},
|
|
132
|
+
},
|
|
133
|
+
},
|
|
134
|
+
},
|
|
135
|
+
},
|
|
136
|
+
},
|
|
137
|
+
context: {
|
|
138
|
+
paths: () => [],
|
|
139
|
+
get: () => ({}),
|
|
140
|
+
exists: () => true,
|
|
141
|
+
},
|
|
142
|
+
governanceConfig: {
|
|
143
|
+
rules: {
|
|
144
|
+
REQUIRE_OPERATION_ID: {
|
|
145
|
+
enabled: false,
|
|
146
|
+
},
|
|
147
|
+
NO_DEFAULT_WITHOUT_2XX: {
|
|
148
|
+
severity: 'error',
|
|
149
|
+
},
|
|
150
|
+
},
|
|
151
|
+
},
|
|
152
|
+
});
|
|
153
|
+
node_assert_1.default.ok(!report.governance.violations.some(violation => violation.ruleId === 'REQUIRE_OPERATION_ID'));
|
|
154
|
+
node_assert_1.default.ok(report.governance.violations.some(violation => violation.ruleId === 'NO_DEFAULT_WITHOUT_2XX' && violation.severity === 'error'));
|
|
155
|
+
});
|
|
156
|
+
});
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { Context } from '../Context';
|
|
2
|
+
import { GovernancePolicyConfig, GovernanceReport } from '../governance/evaluateGovernanceRules';
|
|
3
|
+
import { CommonOpenApi } from '../types/shared/CommonOpenApi.model';
|
|
4
|
+
type StrictIssueSeverity = 'error' | 'warning' | 'info';
|
|
5
|
+
type StrictIssue = {
|
|
6
|
+
severity: StrictIssueSeverity;
|
|
7
|
+
code: 'UNRESOLVED_REF' | 'CONTENT_MEDIA_TYPE_FALLBACK' | 'SUSPICIOUS_DEFAULT_RESPONSE' | 'MISSING_OPERATION_ID' | 'OPENAPI_PARSER_VALIDATION_FAILED';
|
|
8
|
+
message: string;
|
|
9
|
+
path: string;
|
|
10
|
+
};
|
|
11
|
+
type StrictSummary = {
|
|
12
|
+
errors: number;
|
|
13
|
+
warnings: number;
|
|
14
|
+
info: number;
|
|
15
|
+
};
|
|
16
|
+
export type StrictOpenApiReport = {
|
|
17
|
+
summary: StrictSummary;
|
|
18
|
+
governance: GovernanceReport;
|
|
19
|
+
issues: StrictIssue[];
|
|
20
|
+
};
|
|
21
|
+
type StrictValidationContext = Pick<Context, 'paths' | 'get' | 'exists'> & Partial<Pick<Context, 'getAllCanonicalRefs'>>;
|
|
22
|
+
type ValidateOpenApiStrictParams = {
|
|
23
|
+
openApi: CommonOpenApi;
|
|
24
|
+
context: StrictValidationContext;
|
|
25
|
+
preIssues?: StrictIssue[];
|
|
26
|
+
governanceConfig?: GovernancePolicyConfig;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Runs SwaggerParser built-in `validate` and converts parser failure into strict issues.
|
|
30
|
+
* This check complements (but does not replace) custom strict diagnostics.
|
|
31
|
+
*/
|
|
32
|
+
export declare function validateWithSwaggerParser(inputPath: string): Promise<StrictIssue[]>;
|
|
33
|
+
/**
|
|
34
|
+
* Runs strict OpenAPI diagnostics and returns a structured report.
|
|
35
|
+
*/
|
|
36
|
+
export declare function validateOpenApiStrict(params: ValidateOpenApiStrictParams): StrictOpenApiReport;
|
|
37
|
+
/**
|
|
38
|
+
* Writes strict diagnostics report to a JSON file and returns absolute file path.
|
|
39
|
+
* Creates target directory if it does not exist.
|
|
40
|
+
*/
|
|
41
|
+
export declare function writeOpenApiStrictReport(report: StrictOpenApiReport, reportFilePath: string): Promise<string>;
|
|
42
|
+
export {};
|
|
43
|
+
//# sourceMappingURL=validateOpenApiStrict.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validateOpenApiStrict.d.ts","sourceRoot":"","sources":["../../../src/core/strict/validateOpenApiStrict.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAA0B,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACzH,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,KAAK,mBAAmB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAExD,KAAK,WAAW,GAAG;IACf,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,IAAI,EAAE,gBAAgB,GAAG,6BAA6B,GAAG,6BAA6B,GAAG,sBAAsB,GAAG,kCAAkC,CAAC;IACrJ,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,aAAa,GAAG;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,OAAO,EAAE,aAAa,CAAC;IACvB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB,CAAC;AAEF,KAAK,uBAAuB,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC,GACpE,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;AAElD,KAAK,2BAA2B,GAAG;IAC/B,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,uBAAuB,CAAC;IACjC,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC7C,CAAC;AAqNF;;;GAGG;AACH,wBAAsB,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAiBzF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,mBAAmB,CAe9F;AAED;;;GAGG;AACH,wBAAsB,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAanH"}
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.validateWithSwaggerParser = validateWithSwaggerParser;
|
|
7
|
+
exports.validateOpenApiStrict = validateOpenApiStrict;
|
|
8
|
+
exports.writeOpenApiStrictReport = writeOpenApiStrictReport;
|
|
9
|
+
const swagger_parser_1 = __importDefault(require("@apidevtools/swagger-parser"));
|
|
10
|
+
const path_1 = __importDefault(require("path"));
|
|
11
|
+
const fileSystemHelpers_1 = require("../../common/utils/fileSystemHelpers");
|
|
12
|
+
const format_1 = require("../../common/utils/format");
|
|
13
|
+
const pathHelpers_1 = require("../../common/utils/pathHelpers");
|
|
14
|
+
const getContent_1 = require("../api/v3/parser/getContent");
|
|
15
|
+
const evaluateGovernanceRules_1 = require("../governance/evaluateGovernanceRules");
|
|
16
|
+
const HTTP_METHODS = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'];
|
|
17
|
+
/**
|
|
18
|
+
* Normalizes a media type value by:
|
|
19
|
+
* 1) removing parameters after `;`
|
|
20
|
+
* 2) trimming surrounding spaces
|
|
21
|
+
* 3) converting to lowercase.
|
|
22
|
+
*/
|
|
23
|
+
function normalizeMediaType(mediaType) {
|
|
24
|
+
return mediaType.split(';')[0].trim().toLowerCase();
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Checks whether a response code key is an explicit success code.
|
|
28
|
+
* Supports exact `2xx` numeric codes and OpenAPI range form `2XX`.
|
|
29
|
+
*/
|
|
30
|
+
function isSuccessResponseCode(responseCode) {
|
|
31
|
+
return /^\s*2\d\d\s*$/.test(responseCode) || /^\s*2xx\s*$/i.test(responseCode);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Builds aggregated counters for report summary from collected issues.
|
|
35
|
+
*/
|
|
36
|
+
function createSummary(issues) {
|
|
37
|
+
return issues.reduce((summary, issue) => {
|
|
38
|
+
if (issue.severity === 'error') {
|
|
39
|
+
summary.errors += 1;
|
|
40
|
+
}
|
|
41
|
+
else if (issue.severity === 'warning') {
|
|
42
|
+
summary.warnings += 1;
|
|
43
|
+
}
|
|
44
|
+
else {
|
|
45
|
+
summary.info += 1;
|
|
46
|
+
}
|
|
47
|
+
return summary;
|
|
48
|
+
}, { errors: 0, warnings: 0, info: 0 });
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Extracts source file path from a canonical ref.
|
|
52
|
+
* Example: `/spec/pet.yaml#/components/schemas/Pet` -> `/spec/pet.yaml`.
|
|
53
|
+
*/
|
|
54
|
+
function getSourceFileFromRef(ref) {
|
|
55
|
+
return ref.split('#')[0] || ref;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Returns refs to traverse for strict `$ref` checks.
|
|
59
|
+
*
|
|
60
|
+
* Priority:
|
|
61
|
+
* 1) Canonical refs from `context.getAllCanonicalRefs()` when available.
|
|
62
|
+
* 2) Fallback to file-level refs from `context.paths()`.
|
|
63
|
+
*/
|
|
64
|
+
function getSchemaTraversalRefs(context) {
|
|
65
|
+
if (typeof context.getAllCanonicalRefs === 'function') {
|
|
66
|
+
const canonicalRefs = context.getAllCanonicalRefs();
|
|
67
|
+
if (canonicalRefs.length > 0) {
|
|
68
|
+
return canonicalRefs;
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
return context.paths();
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Traverses resolved schemas and collects diagnostics for unresolved `$ref`.
|
|
75
|
+
*
|
|
76
|
+
* Uses Context methods:
|
|
77
|
+
* - `getAllCanonicalRefs()` to iterate canonical refs with fragments (when available)
|
|
78
|
+
* - `paths()` to iterate source schema files
|
|
79
|
+
* - `get()` to load schema data
|
|
80
|
+
* - `exists()` to validate each discovered `$ref`
|
|
81
|
+
*
|
|
82
|
+
* Duplicate diagnostics are removed via a local dedupe set.
|
|
83
|
+
*/
|
|
84
|
+
function collectUnresolvedRefIssues(context) {
|
|
85
|
+
const issues = [];
|
|
86
|
+
const dedupe = new Set();
|
|
87
|
+
const walk = (node, sourceFile, pathSegments) => {
|
|
88
|
+
if (!node || typeof node !== 'object') {
|
|
89
|
+
return;
|
|
90
|
+
}
|
|
91
|
+
const objectNode = node;
|
|
92
|
+
if (typeof objectNode.$ref === 'string') {
|
|
93
|
+
const ref = objectNode.$ref;
|
|
94
|
+
const isRefExists = context.exists(ref, sourceFile);
|
|
95
|
+
if (!isRefExists) {
|
|
96
|
+
const issuePath = `${sourceFile} ${pathSegments.join('.') || '$'}.$ref`;
|
|
97
|
+
const dedupeKey = `${sourceFile}|${issuePath}|${ref}`;
|
|
98
|
+
if (!dedupe.has(dedupeKey)) {
|
|
99
|
+
dedupe.add(dedupeKey);
|
|
100
|
+
issues.push({
|
|
101
|
+
severity: 'error',
|
|
102
|
+
code: 'UNRESOLVED_REF',
|
|
103
|
+
message: `Unresolved $ref: ${ref}`,
|
|
104
|
+
path: issuePath,
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
if (Array.isArray(node)) {
|
|
110
|
+
node.forEach((item, index) => walk(item, sourceFile, [...pathSegments, `[${index}]`]));
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
for (const [key, value] of Object.entries(objectNode)) {
|
|
114
|
+
walk(value, sourceFile, [...pathSegments, key]);
|
|
115
|
+
}
|
|
116
|
+
};
|
|
117
|
+
const traversalRefs = getSchemaTraversalRefs(context);
|
|
118
|
+
for (const traversalRef of traversalRefs) {
|
|
119
|
+
try {
|
|
120
|
+
const schema = context.get(traversalRef);
|
|
121
|
+
const sourceFile = getSourceFileFromRef(traversalRef);
|
|
122
|
+
walk(schema, sourceFile, []);
|
|
123
|
+
}
|
|
124
|
+
catch {
|
|
125
|
+
// Ignore non-schema technical refs.
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
return issues;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Collects operation-level diagnostics:
|
|
132
|
+
* - `info` for missing `operationId`
|
|
133
|
+
* - `warning` for fallback media type selection
|
|
134
|
+
* - `warning` for `default` response without explicit `2xx`.
|
|
135
|
+
*/
|
|
136
|
+
function collectOperationIssues(openApi) {
|
|
137
|
+
const issues = [];
|
|
138
|
+
const paths = openApi.paths;
|
|
139
|
+
for (const [routePath, pathItem] of Object.entries(paths ?? {})) {
|
|
140
|
+
for (const method of HTTP_METHODS) {
|
|
141
|
+
const operation = pathItem?.[method];
|
|
142
|
+
if (!operation || typeof operation !== 'object') {
|
|
143
|
+
continue;
|
|
144
|
+
}
|
|
145
|
+
const operationPath = `${routePath} ${method.toUpperCase()}`;
|
|
146
|
+
if (!operation.operationId) {
|
|
147
|
+
issues.push({
|
|
148
|
+
severity: 'info',
|
|
149
|
+
code: 'MISSING_OPERATION_ID',
|
|
150
|
+
message: 'Operation does not define operationId.',
|
|
151
|
+
path: operationPath,
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
const requestBodyContent = operation?.requestBody?.content;
|
|
155
|
+
if (requestBodyContent && typeof requestBodyContent === 'object') {
|
|
156
|
+
const selectedContent = (0, getContent_1.getContent)(requestBodyContent);
|
|
157
|
+
if (selectedContent && normalizeMediaType(selectedContent.mediaType) !== 'application/json') {
|
|
158
|
+
issues.push({
|
|
159
|
+
severity: 'warning',
|
|
160
|
+
code: 'CONTENT_MEDIA_TYPE_FALLBACK',
|
|
161
|
+
message: `No application/json found, fallback media type selected: ${selectedContent.mediaType}`,
|
|
162
|
+
path: `${operationPath} requestBody.content`,
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
const responses = operation?.responses;
|
|
167
|
+
if (responses && typeof responses === 'object') {
|
|
168
|
+
const responseCodes = Object.keys(responses);
|
|
169
|
+
const hasDefaultResponse = responseCodes.includes('default');
|
|
170
|
+
const hasExplicitSuccessResponse = responseCodes.some(isSuccessResponseCode);
|
|
171
|
+
if (hasDefaultResponse && !hasExplicitSuccessResponse) {
|
|
172
|
+
issues.push({
|
|
173
|
+
severity: 'warning',
|
|
174
|
+
code: 'SUSPICIOUS_DEFAULT_RESPONSE',
|
|
175
|
+
message: 'Default response is used without an explicit 2xx response.',
|
|
176
|
+
path: `${operationPath} responses.default`,
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
for (const responseCode of responseCodes) {
|
|
180
|
+
const response = responses[responseCode];
|
|
181
|
+
const responseContent = response?.content;
|
|
182
|
+
if (!responseContent || typeof responseContent !== 'object') {
|
|
183
|
+
continue;
|
|
184
|
+
}
|
|
185
|
+
const selectedContent = (0, getContent_1.getContent)(responseContent);
|
|
186
|
+
if (selectedContent && normalizeMediaType(selectedContent.mediaType) !== 'application/json') {
|
|
187
|
+
issues.push({
|
|
188
|
+
severity: 'warning',
|
|
189
|
+
code: 'CONTENT_MEDIA_TYPE_FALLBACK',
|
|
190
|
+
message: `No application/json found, fallback media type selected: ${selectedContent.mediaType}`,
|
|
191
|
+
path: `${operationPath} responses.${responseCode}.content`,
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
return issues;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Runs SwaggerParser built-in `validate` and converts parser failure into strict issues.
|
|
202
|
+
* This check complements (but does not replace) custom strict diagnostics.
|
|
203
|
+
*/
|
|
204
|
+
async function validateWithSwaggerParser(inputPath) {
|
|
205
|
+
const parser = new swagger_parser_1.default();
|
|
206
|
+
const absoluteInputPath = (0, pathHelpers_1.resolveHelper)(inputPath);
|
|
207
|
+
try {
|
|
208
|
+
await parser.validate(absoluteInputPath);
|
|
209
|
+
return [];
|
|
210
|
+
}
|
|
211
|
+
catch (error) {
|
|
212
|
+
return [
|
|
213
|
+
{
|
|
214
|
+
severity: 'error',
|
|
215
|
+
code: 'OPENAPI_PARSER_VALIDATION_FAILED',
|
|
216
|
+
message: error instanceof Error ? error.message : String(error),
|
|
217
|
+
path: absoluteInputPath,
|
|
218
|
+
},
|
|
219
|
+
];
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Runs strict OpenAPI diagnostics and returns a structured report.
|
|
224
|
+
*/
|
|
225
|
+
function validateOpenApiStrict(params) {
|
|
226
|
+
const { openApi, context, preIssues = [], governanceConfig } = params;
|
|
227
|
+
const issues = [...preIssues, ...collectUnresolvedRefIssues(context), ...collectOperationIssues(openApi)];
|
|
228
|
+
const governance = (0, evaluateGovernanceRules_1.evaluateGovernanceRules)({
|
|
229
|
+
openApi,
|
|
230
|
+
allowBreaking: true,
|
|
231
|
+
governanceConfig,
|
|
232
|
+
});
|
|
233
|
+
return {
|
|
234
|
+
summary: createSummary(issues),
|
|
235
|
+
governance,
|
|
236
|
+
issues,
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Writes strict diagnostics report to a JSON file and returns absolute file path.
|
|
241
|
+
* Creates target directory if it does not exist.
|
|
242
|
+
*/
|
|
243
|
+
async function writeOpenApiStrictReport(report, reportFilePath) {
|
|
244
|
+
const resolvedReportPath = (0, pathHelpers_1.resolveHelper)(process.cwd(), reportFilePath);
|
|
245
|
+
const reportDir = path_1.default.dirname(resolvedReportPath);
|
|
246
|
+
const isReportDirExists = await fileSystemHelpers_1.fileSystemHelpers.exists(reportDir);
|
|
247
|
+
if (!isReportDirExists) {
|
|
248
|
+
await fileSystemHelpers_1.fileSystemHelpers.mkdir(reportDir);
|
|
249
|
+
}
|
|
250
|
+
const reportContent = await (0, format_1.format)(JSON.stringify(report), 'json');
|
|
251
|
+
await fileSystemHelpers_1.fileSystemHelpers.writeFile(resolvedReportPath, reportContent);
|
|
252
|
+
return resolvedReportPath;
|
|
253
|
+
}
|
|
@@ -8,5 +8,7 @@ export type ClientArtifacts = {
|
|
|
8
8
|
models: ExportedModel[];
|
|
9
9
|
schemas: ExportedModel[];
|
|
10
10
|
services: ExportedService[];
|
|
11
|
+
modelsMode?: import('../enums/ModelsMode.enum').ModelsMode;
|
|
12
|
+
modelsPackage?: string;
|
|
11
13
|
};
|
|
12
14
|
//# sourceMappingURL=ClientArtifacts.model.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ClientArtifacts.model.d.ts","sourceRoot":"","sources":["../../../../src/core/types/base/ClientArtifacts.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,MAAM,eAAe,GAAG;IAC1B,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"ClientArtifacts.model.d.ts","sourceRoot":"","sources":["../../../../src/core/types/base/ClientArtifacts.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,MAAM,eAAe,GAAG;IAC1B,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,0BAA0B,EAAE,UAAU,CAAC;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAA"}
|
|
@@ -11,7 +11,8 @@ export interface Templates {
|
|
|
11
11
|
exports: {
|
|
12
12
|
client: Handlebars.TemplateDelegate;
|
|
13
13
|
model: Handlebars.TemplateDelegate;
|
|
14
|
-
|
|
14
|
+
models: Handlebars.TemplateDelegate;
|
|
15
|
+
schema: Handlebars.TemplateDelegate;
|
|
15
16
|
service: Handlebars.TemplateDelegate;
|
|
16
17
|
};
|
|
17
18
|
core: {
|
|
@@ -19,6 +20,8 @@ export interface Templates {
|
|
|
19
20
|
apiError: Handlebars.TemplateDelegate;
|
|
20
21
|
apiRequestOptions: Handlebars.TemplateDelegate;
|
|
21
22
|
apiResult: Handlebars.TemplateDelegate;
|
|
23
|
+
baseDto: Handlebars.TemplateDelegate;
|
|
24
|
+
dtoUtils: Handlebars.TemplateDelegate;
|
|
22
25
|
request: Handlebars.TemplateDelegate;
|
|
23
26
|
cancelablePromise: Handlebars.TemplateDelegate;
|
|
24
27
|
httpStatusCode: Handlebars.TemplateDelegate;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Templates.model.d.ts","sourceRoot":"","sources":["../../../../src/core/types/base/Templates.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE;QACL,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACrC,QAAQ,EAAE,UAAU,CAAC,gBAAgB,CAAC;KACzC,CAAC;IACF,OAAO,EAAE;QACL,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,KAAK,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACnC,MAAM,EAAE,UAAU,CAAC,gBAAgB,
|
|
1
|
+
{"version":3,"file":"Templates.model.d.ts","sourceRoot":"","sources":["../../../../src/core/types/base/Templates.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE;QACL,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAClC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACrC,QAAQ,EAAE,UAAU,CAAC,gBAAgB,CAAC;KACzC,CAAC;IACF,OAAO,EAAE;QACL,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,KAAK,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACnC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACpC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC;KACxC,CAAC;IACF,IAAI,EAAE;QACF,QAAQ,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACtC,QAAQ,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACtC,iBAAiB,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAC/C,SAAS,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACvC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACrC,QAAQ,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACtC,OAAO,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACrC,iBAAiB,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAC/C,cAAc,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAC5C,eAAe,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAC7C,qBAAqB,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACnD,YAAY,EAAE,UAAU,CAAC,gBAAgB,CAAC;QAC1C,mBAAmB,EAAE,UAAU,CAAC,gBAAgB,CAAC;QACjD,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;KACjD,CAAC;CACL"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EmptySchemaStrategy.enum.d.ts","sourceRoot":"","sources":["../../../../src/core/types/enums/EmptySchemaStrategy.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,mBAAmB;IAC3B,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;CAChB"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.EmptySchemaStrategy = void 0;
|
|
4
|
+
var EmptySchemaStrategy;
|
|
5
|
+
(function (EmptySchemaStrategy) {
|
|
6
|
+
EmptySchemaStrategy["SEMANTIC"] = "semantic";
|
|
7
|
+
EmptySchemaStrategy["SKIP"] = "skip";
|
|
8
|
+
EmptySchemaStrategy["KEEP"] = "keep";
|
|
9
|
+
})(EmptySchemaStrategy || (exports.EmptySchemaStrategy = EmptySchemaStrategy = {}));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModelsMode.enum.d.ts","sourceRoot":"","sources":["../../../../src/core/types/enums/ModelsMode.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU;IAClB,UAAU,eAAe;IACzB,OAAO,YAAY;CACtB"}
|