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,71 @@
|
|
|
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_fs_1 = require("node:fs");
|
|
8
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
9
|
+
const node_test_1 = require("node:test");
|
|
10
|
+
const loadGovernanceConfig_1 = require("../loadGovernanceConfig");
|
|
11
|
+
function createTempDir(prefix) {
|
|
12
|
+
const generatedRoot = node_path_1.default.join(__dirname, 'generated');
|
|
13
|
+
(0, node_fs_1.mkdirSync)(generatedRoot, { recursive: true });
|
|
14
|
+
return (0, node_fs_1.mkdtempSync)(node_path_1.default.join(generatedRoot, prefix));
|
|
15
|
+
}
|
|
16
|
+
(0, node_test_1.describe)('@unit: loadGovernanceConfig', () => {
|
|
17
|
+
(0, node_test_1.test)('returns undefined when path is not provided', async () => {
|
|
18
|
+
const config = await (0, loadGovernanceConfig_1.loadGovernanceConfig)();
|
|
19
|
+
node_assert_1.default.strictEqual(config, undefined);
|
|
20
|
+
});
|
|
21
|
+
(0, node_test_1.test)('loads valid governance config', async (t) => {
|
|
22
|
+
const tempDir = createTempDirWithCleanup(t, 'openapi-governance-config-valid-');
|
|
23
|
+
const configPath = node_path_1.default.join(tempDir, 'governance.json');
|
|
24
|
+
(0, node_fs_1.writeFileSync)(configPath, JSON.stringify({
|
|
25
|
+
rules: {
|
|
26
|
+
NO_BREAKING_WITHOUT_FLAG: {
|
|
27
|
+
enabled: true,
|
|
28
|
+
severity: 'error',
|
|
29
|
+
},
|
|
30
|
+
REQUIRE_OPERATION_ID: {
|
|
31
|
+
allowList: [{ operation: '/users GET' }],
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
}));
|
|
35
|
+
const config = await (0, loadGovernanceConfig_1.loadGovernanceConfig)(configPath);
|
|
36
|
+
node_assert_1.default.ok(config);
|
|
37
|
+
node_assert_1.default.strictEqual(config?.rules?.NO_BREAKING_WITHOUT_FLAG?.severity, 'error');
|
|
38
|
+
node_assert_1.default.strictEqual(config?.rules?.REQUIRE_OPERATION_ID?.allowList?.[0]?.operation, '/users GET');
|
|
39
|
+
});
|
|
40
|
+
(0, node_test_1.test)('throws with path details for invalid severity', async (t) => {
|
|
41
|
+
const tempDir = createTempDirWithCleanup(t, 'openapi-governance-config-invalid-severity-');
|
|
42
|
+
const configPath = node_path_1.default.join(tempDir, 'governance.json');
|
|
43
|
+
(0, node_fs_1.writeFileSync)(configPath, JSON.stringify({
|
|
44
|
+
rules: {
|
|
45
|
+
NO_DEFAULT_WITHOUT_2XX: {
|
|
46
|
+
severity: 'fatal',
|
|
47
|
+
},
|
|
48
|
+
},
|
|
49
|
+
}));
|
|
50
|
+
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'));
|
|
51
|
+
});
|
|
52
|
+
(0, node_test_1.test)('throws with path details for invalid allowList item', async (t) => {
|
|
53
|
+
const tempDir = createTempDirWithCleanup(t, 'openapi-governance-config-invalid-allowlist-');
|
|
54
|
+
const configPath = node_path_1.default.join(tempDir, 'governance.json');
|
|
55
|
+
(0, node_fs_1.writeFileSync)(configPath, JSON.stringify({
|
|
56
|
+
rules: {
|
|
57
|
+
REQUIRE_OPERATION_ID: {
|
|
58
|
+
allowList: [{}],
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
}));
|
|
62
|
+
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]'));
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
function createTempDirWithCleanup(t, prefix) {
|
|
66
|
+
const tempDir = createTempDir(prefix);
|
|
67
|
+
t.after(() => {
|
|
68
|
+
(0, node_fs_1.rmSync)(tempDir, { recursive: true, force: true });
|
|
69
|
+
});
|
|
70
|
+
return tempDir;
|
|
71
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { CommonOpenApi } from '../types/shared/CommonOpenApi.model';
|
|
2
|
+
type GovernanceSeverity = 'error' | 'warning' | 'info';
|
|
3
|
+
export type GovernanceRuleId = 'NO_BREAKING_WITHOUT_FLAG' | 'REQUIRE_OPERATION_ID' | 'NO_DEFAULT_WITHOUT_2XX';
|
|
4
|
+
type GovernanceSummary = {
|
|
5
|
+
errors: number;
|
|
6
|
+
warnings: number;
|
|
7
|
+
info: number;
|
|
8
|
+
};
|
|
9
|
+
export type GovernanceViolation = {
|
|
10
|
+
ruleId: GovernanceRuleId;
|
|
11
|
+
severity: GovernanceSeverity;
|
|
12
|
+
message: string;
|
|
13
|
+
path: string;
|
|
14
|
+
};
|
|
15
|
+
export type GovernanceReport = {
|
|
16
|
+
summary: GovernanceSummary;
|
|
17
|
+
violations: GovernanceViolation[];
|
|
18
|
+
};
|
|
19
|
+
export type GovernanceAllowListItem = {
|
|
20
|
+
operation?: string;
|
|
21
|
+
path?: string;
|
|
22
|
+
};
|
|
23
|
+
export type GovernanceRuleConfig = {
|
|
24
|
+
enabled?: boolean;
|
|
25
|
+
severity?: GovernanceSeverity;
|
|
26
|
+
allowList?: GovernanceAllowListItem[];
|
|
27
|
+
};
|
|
28
|
+
export type GovernancePolicyConfig = {
|
|
29
|
+
rules?: Partial<Record<GovernanceRuleId, GovernanceRuleConfig>>;
|
|
30
|
+
};
|
|
31
|
+
type GovernanceInput = {
|
|
32
|
+
openApi: CommonOpenApi;
|
|
33
|
+
allowBreaking?: boolean;
|
|
34
|
+
breakingChangesCount?: number;
|
|
35
|
+
governanceConfig?: GovernancePolicyConfig;
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Evaluates governance rules and returns machine-readable violations.
|
|
39
|
+
*/
|
|
40
|
+
export declare function evaluateGovernanceRules(params: GovernanceInput): GovernanceReport;
|
|
41
|
+
export {};
|
|
42
|
+
//# sourceMappingURL=evaluateGovernanceRules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.evaluateGovernanceRules = evaluateGovernanceRules;
|
|
4
|
+
const HTTP_METHODS = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'];
|
|
5
|
+
/**
|
|
6
|
+
* Checks whether response key is an explicit successful HTTP status code key.
|
|
7
|
+
*/
|
|
8
|
+
function isSuccessResponseCode(responseCode) {
|
|
9
|
+
return /^\s*2\d\d\s*$/.test(responseCode) || /^\s*2xx\s*$/i.test(responseCode);
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Builds governance summary counters from violations.
|
|
13
|
+
*/
|
|
14
|
+
function buildSummary(violations) {
|
|
15
|
+
return violations.reduce((summary, violation) => {
|
|
16
|
+
if (violation.severity === 'error') {
|
|
17
|
+
summary.errors += 1;
|
|
18
|
+
}
|
|
19
|
+
else if (violation.severity === 'warning') {
|
|
20
|
+
summary.warnings += 1;
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
summary.info += 1;
|
|
24
|
+
}
|
|
25
|
+
return summary;
|
|
26
|
+
}, {
|
|
27
|
+
errors: 0,
|
|
28
|
+
warnings: 0,
|
|
29
|
+
info: 0,
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
const RULE_DEFAULTS = {
|
|
33
|
+
NO_BREAKING_WITHOUT_FLAG: {
|
|
34
|
+
enabled: true,
|
|
35
|
+
severity: 'error',
|
|
36
|
+
},
|
|
37
|
+
REQUIRE_OPERATION_ID: {
|
|
38
|
+
enabled: true,
|
|
39
|
+
severity: 'warning',
|
|
40
|
+
},
|
|
41
|
+
NO_DEFAULT_WITHOUT_2XX: {
|
|
42
|
+
enabled: true,
|
|
43
|
+
severity: 'warning',
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Resolves effective rule config using defaults overridden by user policy.
|
|
48
|
+
*/
|
|
49
|
+
function getEffectiveRuleConfig(ruleId, governanceConfig) {
|
|
50
|
+
const defaults = RULE_DEFAULTS[ruleId];
|
|
51
|
+
const configuredRule = governanceConfig?.rules?.[ruleId] ?? {};
|
|
52
|
+
return {
|
|
53
|
+
enabled: configuredRule.enabled ?? defaults.enabled,
|
|
54
|
+
severity: configuredRule.severity ?? defaults.severity,
|
|
55
|
+
allowList: Array.isArray(configuredRule.allowList) ? configuredRule.allowList : [],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Returns true when violation is allowed by operation/path allow list.
|
|
60
|
+
*/
|
|
61
|
+
function isViolationAllowed(allowList, operation, violationPath) {
|
|
62
|
+
return allowList.some(item => {
|
|
63
|
+
const operationAllowed = typeof item.operation === 'string' && operation ? item.operation === operation : false;
|
|
64
|
+
const pathAllowed = typeof item.path === 'string' && item.path.trim().length > 0
|
|
65
|
+
? violationPath === item.path || violationPath.startsWith(item.path)
|
|
66
|
+
: false;
|
|
67
|
+
return operationAllowed || pathAllowed;
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Evaluates governance rules and returns machine-readable violations.
|
|
72
|
+
*/
|
|
73
|
+
function evaluateGovernanceRules(params) {
|
|
74
|
+
const { openApi, allowBreaking = false, breakingChangesCount = 0, governanceConfig } = params;
|
|
75
|
+
const violations = [];
|
|
76
|
+
const noBreakingRule = getEffectiveRuleConfig('NO_BREAKING_WITHOUT_FLAG', governanceConfig);
|
|
77
|
+
if (noBreakingRule.enabled && !allowBreaking && breakingChangesCount > 0) {
|
|
78
|
+
const violationPath = '#/summary/breaking';
|
|
79
|
+
if (!isViolationAllowed(noBreakingRule.allowList, undefined, violationPath)) {
|
|
80
|
+
violations.push({
|
|
81
|
+
ruleId: 'NO_BREAKING_WITHOUT_FLAG',
|
|
82
|
+
severity: noBreakingRule.severity,
|
|
83
|
+
message: `Breaking changes are not allowed without explicit allow flag. Found ${breakingChangesCount}.`,
|
|
84
|
+
path: violationPath,
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
const paths = openApi.paths;
|
|
89
|
+
for (const [routePath, pathItemRaw] of Object.entries(paths ?? {})) {
|
|
90
|
+
const pathItem = pathItemRaw ?? {};
|
|
91
|
+
for (const method of HTTP_METHODS) {
|
|
92
|
+
const operationRaw = pathItem[method];
|
|
93
|
+
if (!operationRaw || typeof operationRaw !== 'object') {
|
|
94
|
+
continue;
|
|
95
|
+
}
|
|
96
|
+
const operation = operationRaw;
|
|
97
|
+
const operationPath = `${routePath} ${method.toUpperCase()}`;
|
|
98
|
+
const requireOperationIdRule = getEffectiveRuleConfig('REQUIRE_OPERATION_ID', governanceConfig);
|
|
99
|
+
if (requireOperationIdRule.enabled && !operation.operationId) {
|
|
100
|
+
if (!isViolationAllowed(requireOperationIdRule.allowList, operationPath, operationPath)) {
|
|
101
|
+
violations.push({
|
|
102
|
+
ruleId: 'REQUIRE_OPERATION_ID',
|
|
103
|
+
severity: requireOperationIdRule.severity,
|
|
104
|
+
message: 'Operation must define operationId.',
|
|
105
|
+
path: operationPath,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
const responses = operation.responses;
|
|
110
|
+
if (!responses || typeof responses !== 'object') {
|
|
111
|
+
continue;
|
|
112
|
+
}
|
|
113
|
+
const responseCodes = Object.keys(responses);
|
|
114
|
+
const hasDefaultResponse = responseCodes.includes('default');
|
|
115
|
+
const hasSuccessResponse = responseCodes.some(isSuccessResponseCode);
|
|
116
|
+
const noDefaultWithout2xxRule = getEffectiveRuleConfig('NO_DEFAULT_WITHOUT_2XX', governanceConfig);
|
|
117
|
+
if (noDefaultWithout2xxRule.enabled && hasDefaultResponse && !hasSuccessResponse) {
|
|
118
|
+
const violationPath = `${operationPath} responses.default`;
|
|
119
|
+
if (!isViolationAllowed(noDefaultWithout2xxRule.allowList, operationPath, violationPath)) {
|
|
120
|
+
violations.push({
|
|
121
|
+
ruleId: 'NO_DEFAULT_WITHOUT_2XX',
|
|
122
|
+
severity: noDefaultWithout2xxRule.severity,
|
|
123
|
+
message: 'Default response is present without an explicit 2xx response.',
|
|
124
|
+
path: violationPath,
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
return {
|
|
131
|
+
summary: buildSummary(violations),
|
|
132
|
+
violations,
|
|
133
|
+
};
|
|
134
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.governancePolicyConfigSchema = void 0;
|
|
4
|
+
const zod_1 = require("zod");
|
|
5
|
+
const GOVERNANCE_SEVERITIES = ['error', 'warning', 'info'];
|
|
6
|
+
const allowListItemSchema = zod_1.z
|
|
7
|
+
.object({
|
|
8
|
+
operation: zod_1.z.string().min(1).optional(),
|
|
9
|
+
path: zod_1.z.string().min(1).optional(),
|
|
10
|
+
})
|
|
11
|
+
.strict()
|
|
12
|
+
.superRefine((item, ctx) => {
|
|
13
|
+
if (!item.operation && !item.path) {
|
|
14
|
+
ctx.addIssue({
|
|
15
|
+
code: 'custom',
|
|
16
|
+
message: 'allowList item must define at least one of: operation or path',
|
|
17
|
+
path: [],
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
});
|
|
21
|
+
const governanceRuleConfigSchema = zod_1.z
|
|
22
|
+
.object({
|
|
23
|
+
enabled: zod_1.z.boolean().optional(),
|
|
24
|
+
severity: zod_1.z.enum(GOVERNANCE_SEVERITIES).optional(),
|
|
25
|
+
allowList: zod_1.z.array(allowListItemSchema).optional(),
|
|
26
|
+
})
|
|
27
|
+
.strict();
|
|
28
|
+
const governanceRulesSchema = zod_1.z
|
|
29
|
+
.object({
|
|
30
|
+
NO_BREAKING_WITHOUT_FLAG: governanceRuleConfigSchema.optional(),
|
|
31
|
+
REQUIRE_OPERATION_ID: governanceRuleConfigSchema.optional(),
|
|
32
|
+
NO_DEFAULT_WITHOUT_2XX: governanceRuleConfigSchema.optional(),
|
|
33
|
+
})
|
|
34
|
+
.strict();
|
|
35
|
+
exports.governancePolicyConfigSchema = zod_1.z
|
|
36
|
+
.object({
|
|
37
|
+
rules: governanceRulesSchema.optional(),
|
|
38
|
+
})
|
|
39
|
+
.strict();
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { GovernancePolicyConfig } from './evaluateGovernanceRules';
|
|
2
|
+
/**
|
|
3
|
+
* Loads governance policy config JSON from file path.
|
|
4
|
+
* Returns undefined when path is not provided.
|
|
5
|
+
*/
|
|
6
|
+
export declare function loadGovernanceConfig(governanceConfigPath?: string): Promise<GovernancePolicyConfig | undefined>;
|
|
7
|
+
//# sourceMappingURL=loadGovernanceConfig.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loadGovernanceConfig.d.ts","sourceRoot":"","sources":["../../../src/core/governance/loadGovernanceConfig.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAkCnE;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC,CA6BrH"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.loadGovernanceConfig = loadGovernanceConfig;
|
|
4
|
+
const fileSystemHelpers_1 = require("../../common/utils/fileSystemHelpers");
|
|
5
|
+
const pathHelpers_1 = require("../../common/utils/pathHelpers");
|
|
6
|
+
const governanceConfigSchema_1 = require("./governanceConfigSchema");
|
|
7
|
+
/**
|
|
8
|
+
* Formats Zod path for governance JSON config context.
|
|
9
|
+
*/
|
|
10
|
+
function formatGovernanceConfigPath(path) {
|
|
11
|
+
if (path.length === 0) {
|
|
12
|
+
return 'root';
|
|
13
|
+
}
|
|
14
|
+
return path
|
|
15
|
+
.map(segment => {
|
|
16
|
+
if (typeof segment === 'number') {
|
|
17
|
+
return `[${segment}]`;
|
|
18
|
+
}
|
|
19
|
+
return String(segment);
|
|
20
|
+
})
|
|
21
|
+
.join('.');
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Formats governance config validation errors as user-readable message.
|
|
25
|
+
*/
|
|
26
|
+
function formatGovernanceConfigValidationError(error) {
|
|
27
|
+
if (!error.issues.length) {
|
|
28
|
+
return 'Unknown governance config validation error';
|
|
29
|
+
}
|
|
30
|
+
return error.issues
|
|
31
|
+
.map(issue => `${formatGovernanceConfigPath(issue.path)}: ${issue.message}`)
|
|
32
|
+
.join('\n');
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Loads governance policy config JSON from file path.
|
|
36
|
+
* Returns undefined when path is not provided.
|
|
37
|
+
*/
|
|
38
|
+
async function loadGovernanceConfig(governanceConfigPath) {
|
|
39
|
+
if (!governanceConfigPath) {
|
|
40
|
+
return undefined;
|
|
41
|
+
}
|
|
42
|
+
const resolvedPath = (0, pathHelpers_1.resolveHelper)(process.cwd(), governanceConfigPath);
|
|
43
|
+
const exists = await fileSystemHelpers_1.fileSystemHelpers.exists(resolvedPath);
|
|
44
|
+
if (!exists) {
|
|
45
|
+
throw new Error(`Governance config file does not exist: ${resolvedPath}`);
|
|
46
|
+
}
|
|
47
|
+
const rawContent = await fileSystemHelpers_1.fileSystemHelpers.readFile(resolvedPath, "utf8");
|
|
48
|
+
let parsed;
|
|
49
|
+
try {
|
|
50
|
+
parsed = JSON.parse(rawContent);
|
|
51
|
+
}
|
|
52
|
+
catch (error) {
|
|
53
|
+
throw new Error(`Failed to parse governance config JSON at "${resolvedPath}": ${error instanceof Error ? error.message : String(error)}`);
|
|
54
|
+
}
|
|
55
|
+
const validationResult = governanceConfigSchema_1.governancePolicyConfigSchema.safeParse(parsed);
|
|
56
|
+
if (!validationResult.success) {
|
|
57
|
+
throw new Error(`Invalid governance config at "${resolvedPath}":\n${formatGovernanceConfigValidationError(validationResult.error)}`);
|
|
58
|
+
}
|
|
59
|
+
return validationResult.data;
|
|
60
|
+
}
|
package/dist/core/index.d.ts
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { TRawOptions } from '../common/TRawOptions';
|
|
2
|
+
export type { OpenApiGeneratorPlugin, SchemaTypeOverrideContext, SchemaTypeOverrideInput, TOpenApiVersion } from './plugins';
|
|
3
|
+
export type { ApplySemanticDiffPluginHooksResult, PluginHookDiagnostic, PluginHookName } from './plugins';
|
|
4
|
+
export { applySemanticDiffPluginHooks } from './plugins';
|
|
2
5
|
export { HttpClient } from './types/enums/HttpClient.enum';
|
|
3
6
|
export declare function generate(rawOptions: TRawOptions): Promise<void>;
|
|
4
7
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/core/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIpD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,wBAAsB,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKrE"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIpD,YAAY,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC7H,YAAY,EAAE,kCAAkC,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC1G,OAAO,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAE3D,wBAAsB,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKrE"}
|
package/dist/core/index.js
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.HttpClient = void 0;
|
|
3
|
+
exports.HttpClient = exports.applySemanticDiffPluginHooks = void 0;
|
|
4
4
|
exports.generate = generate;
|
|
5
5
|
const OpenApiClient_1 = require("./OpenApiClient");
|
|
6
6
|
const validateRawOptions_1 = require("./utils/validateRawOptions");
|
|
7
|
+
var plugins_1 = require("./plugins");
|
|
8
|
+
Object.defineProperty(exports, "applySemanticDiffPluginHooks", { enumerable: true, get: function () { return plugins_1.applySemanticDiffPluginHooks; } });
|
|
7
9
|
var HttpClient_enum_1 = require("./types/enums/HttpClient.enum");
|
|
8
10
|
Object.defineProperty(exports, "HttpClient", { enumerable: true, get: function () { return HttpClient_enum_1.HttpClient; } });
|
|
9
11
|
async function generate(rawOptions) {
|
|
10
|
-
(0, validateRawOptions_1.validateRawOptions)(rawOptions);
|
|
12
|
+
await (0, validateRawOptions_1.validateRawOptions)(rawOptions);
|
|
11
13
|
const openApiClient = new OpenApiClient_1.OpenApiClient();
|
|
12
14
|
await openApiClient.generate(rawOptions);
|
|
13
15
|
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { SemanticDiffReport } from '../semanticDiff/analyzeOpenApiDiff';
|
|
2
|
+
export type TOpenApiVersion = 'v2' | 'v3';
|
|
3
|
+
export type OpenApiCodegenPluginApiVersion = '1' | '2';
|
|
4
|
+
export interface SchemaTypeOverrideContext {
|
|
5
|
+
openApiVersion: TOpenApiVersion;
|
|
6
|
+
parentRef: string;
|
|
7
|
+
}
|
|
8
|
+
export interface SchemaTypeOverrideInput {
|
|
9
|
+
schema: Record<string, any>;
|
|
10
|
+
context: SchemaTypeOverrideContext;
|
|
11
|
+
}
|
|
12
|
+
export interface SemanticDiffPluginContext {
|
|
13
|
+
report: SemanticDiffReport;
|
|
14
|
+
options: {
|
|
15
|
+
allowBreaking: boolean;
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
export interface RecommendationPluginContext {
|
|
19
|
+
recommendation: SemanticDiffReport['recommendation'];
|
|
20
|
+
summary: SemanticDiffReport['summary'];
|
|
21
|
+
governance: SemanticDiffReport['governance'];
|
|
22
|
+
}
|
|
23
|
+
export interface BeforeReportWritePluginContext {
|
|
24
|
+
report: SemanticDiffReport;
|
|
25
|
+
reportPath: string;
|
|
26
|
+
}
|
|
27
|
+
export interface OpenApiGeneratorPlugin {
|
|
28
|
+
name: string;
|
|
29
|
+
version?: string;
|
|
30
|
+
apiVersion?: OpenApiCodegenPluginApiVersion;
|
|
31
|
+
resolveSchemaTypeOverride?: (input: SchemaTypeOverrideInput) => string | undefined;
|
|
32
|
+
afterSemanticDiff?: (ctx: SemanticDiffPluginContext) => SemanticDiffReport | void | Promise<SemanticDiffReport | void>;
|
|
33
|
+
mapRecommendation?: (ctx: RecommendationPluginContext) => SemanticDiffReport['recommendation'] | void | Promise<SemanticDiffReport['recommendation'] | void>;
|
|
34
|
+
beforeReportWrite?: (ctx: BeforeReportWritePluginContext) => {
|
|
35
|
+
report?: SemanticDiffReport;
|
|
36
|
+
reportPath?: string;
|
|
37
|
+
} | void | Promise<{
|
|
38
|
+
report?: SemanticDiffReport;
|
|
39
|
+
reportPath?: string;
|
|
40
|
+
} | void>;
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=GeneratorPlugin.model.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"GeneratorPlugin.model.d.ts","sourceRoot":"","sources":["../../../src/core/plugins/GeneratorPlugin.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,IAAI,CAAC;AAC1C,MAAM,MAAM,8BAA8B,GAAG,GAAG,GAAG,GAAG,CAAC;AAEvD,MAAM,WAAW,yBAAyB;IACtC,cAAc,EAAE,eAAe,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACpC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,OAAO,EAAE,yBAAyB,CAAC;CACtC;AAED,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,OAAO,EAAE;QACL,aAAa,EAAE,OAAO,CAAC;KAC1B,CAAC;CACL;AAED,MAAM,WAAW,2BAA2B;IACxC,cAAc,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACrD,OAAO,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACvC,UAAU,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,8BAA8B;IAC3C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,8BAA8B,CAAC;IAC5C,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE,uBAAuB,KAAK,MAAM,GAAG,SAAS,CAAC;IACnF,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,kBAAkB,GAAG,IAAI,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACvH,iBAAiB,CAAC,EAAE,CAChB,GAAG,EAAE,2BAA2B,KAC/B,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;IACxG,iBAAiB,CAAC,EAAE,CAChB,GAAG,EAAE,8BAA8B,KAClC;QAAE,MAAM,CAAC,EAAE,kBAAkB,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,GAAG,OAAO,CAAC;QAAE,MAAM,CAAC,EAAE,kBAAkB,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC;CAC3I"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"applySemanticDiffPluginHooks.test.d.ts","sourceRoot":"","sources":["../../../../src/core/plugins/__tests__/applySemanticDiffPluginHooks.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,115 @@
|
|
|
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 applySemanticDiffPluginHooks_1 = require("../applySemanticDiffPluginHooks");
|
|
9
|
+
function createBaseReport() {
|
|
10
|
+
return {
|
|
11
|
+
schemaVersion: '1.1.0',
|
|
12
|
+
summary: {
|
|
13
|
+
breaking: 1,
|
|
14
|
+
nonBreaking: 0,
|
|
15
|
+
informational: 0,
|
|
16
|
+
},
|
|
17
|
+
recommendation: {
|
|
18
|
+
semver: 'major',
|
|
19
|
+
confidence: 'medium',
|
|
20
|
+
reason: 'Breaking changes detected.',
|
|
21
|
+
reasons: ['HAS_BREAKING_CHANGES'],
|
|
22
|
+
},
|
|
23
|
+
governance: {
|
|
24
|
+
summary: {
|
|
25
|
+
errors: 1,
|
|
26
|
+
warnings: 0,
|
|
27
|
+
info: 0,
|
|
28
|
+
},
|
|
29
|
+
violations: [
|
|
30
|
+
{
|
|
31
|
+
ruleId: 'NO_BREAKING_WITHOUT_FLAG',
|
|
32
|
+
severity: 'error',
|
|
33
|
+
message: 'breaking changes found',
|
|
34
|
+
path: '#/paths/GET /users',
|
|
35
|
+
},
|
|
36
|
+
],
|
|
37
|
+
},
|
|
38
|
+
changes: [
|
|
39
|
+
{
|
|
40
|
+
type: 'operation.removed',
|
|
41
|
+
severity: 'breaking',
|
|
42
|
+
message: 'Operation "GET /users" was removed.',
|
|
43
|
+
path: '#/paths/GET /users',
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
(0, node_test_1.describe)('@unit: applySemanticDiffPluginHooks', () => {
|
|
49
|
+
(0, node_test_1.test)('applies v2 hooks in deterministic order', async () => {
|
|
50
|
+
const pluginA = {
|
|
51
|
+
name: 'plugin-a',
|
|
52
|
+
apiVersion: '2',
|
|
53
|
+
afterSemanticDiff: ({ report }) => ({
|
|
54
|
+
...report,
|
|
55
|
+
summary: {
|
|
56
|
+
...report.summary,
|
|
57
|
+
informational: 1,
|
|
58
|
+
},
|
|
59
|
+
}),
|
|
60
|
+
mapRecommendation: ({ recommendation }) => ({
|
|
61
|
+
...recommendation,
|
|
62
|
+
confidence: 'high',
|
|
63
|
+
}),
|
|
64
|
+
beforeReportWrite: ({ reportPath }) => ({
|
|
65
|
+
reportPath: reportPath.replace('.json', '.v2.json'),
|
|
66
|
+
}),
|
|
67
|
+
};
|
|
68
|
+
const result = await (0, applySemanticDiffPluginHooks_1.applySemanticDiffPluginHooks)({
|
|
69
|
+
report: createBaseReport(),
|
|
70
|
+
reportPath: './report.json',
|
|
71
|
+
plugins: [pluginA],
|
|
72
|
+
allowBreaking: false,
|
|
73
|
+
strictPluginMode: false,
|
|
74
|
+
});
|
|
75
|
+
node_assert_1.default.strictEqual(result.report.summary.informational, 1);
|
|
76
|
+
node_assert_1.default.strictEqual(result.report.recommendation.confidence, 'high');
|
|
77
|
+
node_assert_1.default.strictEqual(result.reportPath, './report.v2.json');
|
|
78
|
+
node_assert_1.default.ok(result.diagnostics.length >= 3);
|
|
79
|
+
node_assert_1.default.ok(result.diagnostics.every(item => item.status === 'applied'));
|
|
80
|
+
});
|
|
81
|
+
(0, node_test_1.test)('non-strict mode keeps working when plugin hook fails', async () => {
|
|
82
|
+
const faultyPlugin = {
|
|
83
|
+
name: 'faulty-plugin',
|
|
84
|
+
apiVersion: '2',
|
|
85
|
+
afterSemanticDiff: () => {
|
|
86
|
+
throw new Error('boom');
|
|
87
|
+
},
|
|
88
|
+
};
|
|
89
|
+
const result = await (0, applySemanticDiffPluginHooks_1.applySemanticDiffPluginHooks)({
|
|
90
|
+
report: createBaseReport(),
|
|
91
|
+
reportPath: './report.json',
|
|
92
|
+
plugins: [faultyPlugin],
|
|
93
|
+
allowBreaking: false,
|
|
94
|
+
strictPluginMode: false,
|
|
95
|
+
});
|
|
96
|
+
node_assert_1.default.strictEqual(result.reportPath, './report.json');
|
|
97
|
+
node_assert_1.default.ok(result.diagnostics.some(item => item.pluginName === 'faulty-plugin' && item.status === 'failed'));
|
|
98
|
+
});
|
|
99
|
+
(0, node_test_1.test)('strict mode throws when plugin hook fails', async () => {
|
|
100
|
+
const faultyPlugin = {
|
|
101
|
+
name: 'faulty-plugin',
|
|
102
|
+
apiVersion: '2',
|
|
103
|
+
mapRecommendation: () => {
|
|
104
|
+
throw new Error('map failed');
|
|
105
|
+
},
|
|
106
|
+
};
|
|
107
|
+
await node_assert_1.default.rejects(async () => (0, applySemanticDiffPluginHooks_1.applySemanticDiffPluginHooks)({
|
|
108
|
+
report: createBaseReport(),
|
|
109
|
+
reportPath: './report.json',
|
|
110
|
+
plugins: [faultyPlugin],
|
|
111
|
+
allowBreaking: false,
|
|
112
|
+
strictPluginMode: true,
|
|
113
|
+
}), (error) => error instanceof Error && error.message.includes('faulty-plugin'));
|
|
114
|
+
});
|
|
115
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loadGeneratorPlugins.test.d.ts","sourceRoot":"","sources":["../../../../src/core/plugins/__tests__/loadGeneratorPlugins.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,62 @@
|
|
|
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_fs_1 = require("node:fs");
|
|
8
|
+
const node_os_1 = require("node:os");
|
|
9
|
+
const node_path_1 = require("node:path");
|
|
10
|
+
const node_test_1 = require("node:test");
|
|
11
|
+
const loadGeneratorPlugins_1 = require("../loadGeneratorPlugins");
|
|
12
|
+
(0, node_test_1.describe)('@unit: loadGeneratorPlugins', () => {
|
|
13
|
+
(0, node_test_1.test)('loads cjs plugin and keeps builtin fallback plugins', async () => {
|
|
14
|
+
const tempDir = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), 'openapi-plugin-'));
|
|
15
|
+
const pluginPath = (0, node_path_1.join)(tempDir, 'custom-plugin.cjs');
|
|
16
|
+
(0, node_fs_1.writeFileSync)(pluginPath, `module.exports = {
|
|
17
|
+
name: 'custom-type-override',
|
|
18
|
+
resolveSchemaTypeOverride: ({ schema }) => schema['x-custom-type']
|
|
19
|
+
};`);
|
|
20
|
+
try {
|
|
21
|
+
const plugins = await (0, loadGeneratorPlugins_1.loadGeneratorPlugins)([pluginPath]);
|
|
22
|
+
node_assert_1.default.ok(plugins.length >= 2);
|
|
23
|
+
node_assert_1.default.strictEqual(plugins[0]?.name, 'custom-type-override');
|
|
24
|
+
node_assert_1.default.ok(plugins.some(plugin => plugin.name === 'x-typescript-type'));
|
|
25
|
+
}
|
|
26
|
+
finally {
|
|
27
|
+
(0, node_fs_1.rmSync)(tempDir, { recursive: true, force: true });
|
|
28
|
+
}
|
|
29
|
+
});
|
|
30
|
+
(0, node_test_1.test)('loads esm plugin from .mjs', async () => {
|
|
31
|
+
const tempDir = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), 'openapi-plugin-esm-'));
|
|
32
|
+
const pluginPath = (0, node_path_1.join)(tempDir, 'custom-plugin.mjs');
|
|
33
|
+
(0, node_fs_1.writeFileSync)(pluginPath, `export default {
|
|
34
|
+
name: 'esm-type-override',
|
|
35
|
+
resolveSchemaTypeOverride: ({ schema }) => schema['x-esm-type']
|
|
36
|
+
};`);
|
|
37
|
+
try {
|
|
38
|
+
const plugins = await (0, loadGeneratorPlugins_1.loadGeneratorPlugins)([pluginPath]);
|
|
39
|
+
node_assert_1.default.strictEqual(plugins[0]?.name, 'esm-type-override');
|
|
40
|
+
node_assert_1.default.ok(plugins.some(plugin => plugin.name === 'x-typescript-type'));
|
|
41
|
+
}
|
|
42
|
+
finally {
|
|
43
|
+
(0, node_fs_1.rmSync)(tempDir, { recursive: true, force: true });
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
(0, node_test_1.test)('loads typescript plugin when runtime supports ts imports', async () => {
|
|
47
|
+
const tempDir = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), 'openapi-plugin-ts-'));
|
|
48
|
+
const pluginPath = (0, node_path_1.join)(tempDir, 'custom-plugin.ts');
|
|
49
|
+
(0, node_fs_1.writeFileSync)(pluginPath, `export default {
|
|
50
|
+
name: 'ts-type-override',
|
|
51
|
+
resolveSchemaTypeOverride: ({ schema }: { schema: Record<string, unknown> }) => schema['x-ts-type']
|
|
52
|
+
};`);
|
|
53
|
+
try {
|
|
54
|
+
const plugins = await (0, loadGeneratorPlugins_1.loadGeneratorPlugins)([pluginPath]);
|
|
55
|
+
node_assert_1.default.strictEqual(plugins[0]?.name, 'ts-type-override');
|
|
56
|
+
node_assert_1.default.ok(plugins.some(plugin => plugin.name === 'x-typescript-type'));
|
|
57
|
+
}
|
|
58
|
+
finally {
|
|
59
|
+
(0, node_fs_1.rmSync)(tempDir, { recursive: true, force: true });
|
|
60
|
+
}
|
|
61
|
+
});
|
|
62
|
+
});
|