@scalar/openapi-parser 0.10.16 → 0.11.0
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/CHANGELOG.md +17 -0
- package/README.md +0 -27
- package/dist/configuration/index.js +19 -22
- package/dist/configuration/index.js.map +7 -0
- package/dist/declarations.d.js +1 -0
- package/dist/declarations.d.js.map +7 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -29
- package/dist/index.js.map +7 -0
- package/dist/lib/Validator/Validator.d.ts +2 -2
- package/dist/lib/Validator/Validator.d.ts.map +1 -1
- package/dist/lib/Validator/Validator.js +99 -119
- package/dist/lib/Validator/Validator.js.map +7 -0
- package/dist/lib/Validator/Validator.test.js +8 -0
- package/dist/lib/Validator/Validator.test.js.map +7 -0
- package/dist/lib/Validator/index.d.ts +2 -2
- package/dist/lib/Validator/index.d.ts.map +1 -1
- package/dist/lib/Validator/index.js +3 -0
- package/dist/lib/Validator/index.js.map +7 -0
- package/dist/plugins/fetch-urls/fetchUrls.d.ts +1 -1
- package/dist/plugins/fetch-urls/fetchUrls.d.ts.map +1 -1
- package/dist/plugins/fetch-urls/fetchUrls.js +36 -39
- package/dist/plugins/fetch-urls/fetchUrls.js.map +7 -0
- package/dist/plugins/fetch-urls/fetchUrls.test.js +50 -0
- package/dist/plugins/fetch-urls/fetchUrls.test.js.map +7 -0
- package/dist/plugins/fetch-urls/index.d.ts +1 -1
- package/dist/plugins/fetch-urls/index.d.ts.map +1 -1
- package/dist/plugins/fetch-urls/index.js +2 -1
- package/dist/plugins/fetch-urls/index.js.map +7 -0
- package/dist/plugins/read-files/index.d.ts +1 -1
- package/dist/plugins/read-files/index.d.ts.map +1 -1
- package/dist/plugins/read-files/index.js +2 -1
- package/dist/plugins/read-files/index.js.map +7 -0
- package/dist/plugins/read-files/readFiles.d.ts +1 -1
- package/dist/plugins/read-files/readFiles.d.ts.map +1 -1
- package/dist/plugins/read-files/readFiles.js +50 -55
- package/dist/plugins/read-files/readFiles.js.map +7 -0
- package/dist/plugins/read-files/readFiles.test.js +20 -0
- package/dist/plugins/read-files/readFiles.test.js.map +7 -0
- package/dist/polyfills/index.d.ts +1 -1
- package/dist/polyfills/index.d.ts.map +1 -1
- package/dist/polyfills/index.js +5 -0
- package/dist/polyfills/index.js.map +7 -0
- package/dist/polyfills/path.js +155 -98
- package/dist/polyfills/path.js.map +7 -0
- package/dist/schemas/v2.0/schema.d.ts +1405 -0
- package/dist/schemas/v2.0/schema.d.ts.map +1 -0
- package/dist/schemas/v2.0/schema.js +1463 -0
- package/dist/schemas/v2.0/schema.js.map +7 -0
- package/dist/schemas/v3.0/schema.d.ts +1264 -0
- package/dist/schemas/v3.0/schema.d.ts.map +1 -0
- package/dist/schemas/v3.0/schema.js +1493 -0
- package/dist/schemas/v3.0/schema.js.map +7 -0
- package/dist/schemas/v3.1/schema.d.ts +1225 -0
- package/dist/schemas/v3.1/schema.d.ts.map +1 -0
- package/dist/schemas/v3.1/schema.js +1296 -0
- package/dist/schemas/v3.1/schema.js.map +7 -0
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +1 -0
- package/dist/types/index.js.map +7 -0
- package/dist/utils/betterAjvErrors/helpers.js +88 -93
- package/dist/utils/betterAjvErrors/helpers.js.map +7 -0
- package/dist/utils/betterAjvErrors/index.js +14 -13
- package/dist/utils/betterAjvErrors/index.js.map +7 -0
- package/dist/utils/betterAjvErrors/json/get-meta-from-path.d.ts +2 -0
- package/dist/utils/betterAjvErrors/json/get-meta-from-path.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/json/get-meta-from-path.js +27 -0
- package/dist/utils/betterAjvErrors/json/get-meta-from-path.js.map +7 -0
- package/dist/utils/betterAjvErrors/json/index.d.ts +2 -0
- package/dist/utils/betterAjvErrors/json/index.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/json/index.js +5 -0
- package/dist/utils/betterAjvErrors/json/index.js.map +7 -0
- package/dist/utils/betterAjvErrors/json/utils.d.ts +2 -0
- package/dist/utils/betterAjvErrors/json/utils.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/json/utils.js +11 -0
- package/dist/utils/betterAjvErrors/json/utils.js.map +7 -0
- package/dist/utils/betterAjvErrors/utils.js +21 -14
- package/dist/utils/betterAjvErrors/utils.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/additional-prop.d.ts +10 -0
- package/dist/utils/betterAjvErrors/validation-errors/additional-prop.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/additional-prop.js +8 -9
- package/dist/utils/betterAjvErrors/validation-errors/additional-prop.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/base.d.ts +23 -0
- package/dist/utils/betterAjvErrors/validation-errors/base.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/base.js +6 -10
- package/dist/utils/betterAjvErrors/validation-errors/base.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/default.d.ts +10 -0
- package/dist/utils/betterAjvErrors/validation-errors/default.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/default.js +8 -9
- package/dist/utils/betterAjvErrors/validation-errors/default.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/enum.d.ts +11 -0
- package/dist/utils/betterAjvErrors/validation-errors/enum.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/enum.js +19 -29
- package/dist/utils/betterAjvErrors/validation-errors/enum.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/index.d.ts +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/index.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/index.js +15 -0
- package/dist/utils/betterAjvErrors/validation-errors/index.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/pattern.d.ts +10 -0
- package/dist/utils/betterAjvErrors/validation-errors/pattern.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/pattern.js +8 -9
- package/dist/utils/betterAjvErrors/validation-errors/pattern.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/required.d.ts +10 -0
- package/dist/utils/betterAjvErrors/validation-errors/required.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/required.js +8 -9
- package/dist/utils/betterAjvErrors/validation-errors/required.js.map +7 -0
- package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.d.ts +10 -0
- package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.d.ts.map +1 -0
- package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.js +8 -9
- package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.js.map +7 -0
- package/dist/utils/dereference.d.ts +2 -2
- package/dist/utils/dereference.d.ts.map +1 -1
- package/dist/utils/dereference.js +17 -19
- package/dist/utils/dereference.js.map +7 -0
- package/dist/utils/dereference.test.js +300 -0
- package/dist/utils/dereference.test.js.map +7 -0
- package/dist/utils/details.d.ts +1 -1
- package/dist/utils/details.d.ts.map +1 -1
- package/dist/utils/details.js +26 -28
- package/dist/utils/details.js.map +7 -0
- package/dist/utils/errors.test.js +48 -0
- package/dist/utils/errors.test.js.map +7 -0
- package/dist/utils/escapeJsonPointer.js +5 -8
- package/dist/utils/escapeJsonPointer.js.map +7 -0
- package/dist/utils/escapeJsonPointer.test.js +11 -0
- package/dist/utils/escapeJsonPointer.test.js.map +7 -0
- package/dist/utils/filter.d.ts +1 -1
- package/dist/utils/filter.d.ts.map +1 -1
- package/dist/utils/filter.js +13 -15
- package/dist/utils/filter.js.map +7 -0
- package/dist/utils/getEntrypoint.d.ts +1 -1
- package/dist/utils/getEntrypoint.d.ts.map +1 -1
- package/dist/utils/getEntrypoint.js +5 -6
- package/dist/utils/getEntrypoint.js.map +7 -0
- package/dist/utils/getEntrypoint.test.js +18 -0
- package/dist/utils/getEntrypoint.test.js.map +7 -0
- package/dist/utils/getListOfReferences.d.ts +1 -1
- package/dist/utils/getListOfReferences.d.ts.map +1 -1
- package/dist/utils/getListOfReferences.js +15 -22
- package/dist/utils/getListOfReferences.js.map +7 -0
- package/dist/utils/getSegmentsFromPath.js +8 -15
- package/dist/utils/getSegmentsFromPath.js.map +7 -0
- package/dist/utils/getSegmentsFromPath.test.js +13 -0
- package/dist/utils/getSegmentsFromPath.test.js.map +7 -0
- package/dist/utils/index.d.ts +26 -26
- package/dist/utils/index.d.ts.map +1 -1
- package/dist/utils/index.js +27 -0
- package/dist/utils/index.js.map +7 -0
- package/dist/utils/isFilesystem.d.ts +2 -1
- package/dist/utils/isFilesystem.d.ts.map +1 -1
- package/dist/utils/isFilesystem.js +5 -9
- package/dist/utils/isFilesystem.js.map +7 -0
- package/dist/utils/isJson.js +10 -9
- package/dist/utils/isJson.js.map +7 -0
- package/dist/utils/isObject.js +5 -6
- package/dist/utils/isObject.js.map +7 -0
- package/dist/utils/isObject.test.js +23 -0
- package/dist/utils/isObject.test.js.map +7 -0
- package/dist/utils/isYaml.js +16 -17
- package/dist/utils/isYaml.js.map +7 -0
- package/dist/utils/load/index.d.ts +1 -1
- package/dist/utils/load/index.d.ts.map +1 -1
- package/dist/utils/load/index.js +2 -0
- package/dist/utils/load/index.js.map +7 -0
- package/dist/utils/load/load.d.ts +1 -1
- package/dist/utils/load/load.d.ts.map +1 -1
- package/dist/utils/load/load.js +89 -110
- package/dist/utils/load/load.js.map +7 -0
- package/dist/utils/load/load.test.js +361 -0
- package/dist/utils/load/load.test.js.map +7 -0
- package/dist/utils/makeFilesystem.d.ts +1 -1
- package/dist/utils/makeFilesystem.d.ts.map +1 -1
- package/dist/utils/makeFilesystem.js +20 -22
- package/dist/utils/makeFilesystem.js.map +7 -0
- package/dist/utils/makeFilesystem.test.js +15 -0
- package/dist/utils/makeFilesystem.test.js.map +7 -0
- package/dist/utils/normalize.d.ts +1 -1
- package/dist/utils/normalize.d.ts.map +1 -1
- package/dist/utils/normalize.js +22 -27
- package/dist/utils/normalize.js.map +7 -0
- package/dist/utils/normalize.test.js +88 -0
- package/dist/utils/normalize.test.js.map +7 -0
- package/dist/utils/openapi/actions/details.d.ts +2 -2
- package/dist/utils/openapi/actions/details.d.ts.map +1 -1
- package/dist/utils/openapi/actions/details.js +9 -11
- package/dist/utils/openapi/actions/details.js.map +7 -0
- package/dist/utils/openapi/actions/files.d.ts +1 -1
- package/dist/utils/openapi/actions/files.d.ts.map +1 -1
- package/dist/utils/openapi/actions/files.js +7 -9
- package/dist/utils/openapi/actions/files.js.map +7 -0
- package/dist/utils/openapi/actions/get.d.ts +1 -1
- package/dist/utils/openapi/actions/get.d.ts.map +1 -1
- package/dist/utils/openapi/actions/get.js +9 -11
- package/dist/utils/openapi/actions/get.js.map +7 -0
- package/dist/utils/openapi/actions/toJson.d.ts +1 -1
- package/dist/utils/openapi/actions/toJson.d.ts.map +1 -1
- package/dist/utils/openapi/actions/toJson.js +9 -11
- package/dist/utils/openapi/actions/toJson.js.map +7 -0
- package/dist/utils/openapi/actions/toYaml.d.ts +1 -1
- package/dist/utils/openapi/actions/toYaml.d.ts.map +1 -1
- package/dist/utils/openapi/actions/toYaml.js +9 -11
- package/dist/utils/openapi/actions/toYaml.js.map +7 -0
- package/dist/utils/openapi/commands/dereferenceCommand.d.ts +5 -5
- package/dist/utils/openapi/commands/dereferenceCommand.d.ts.map +1 -1
- package/dist/utils/openapi/commands/dereferenceCommand.js +25 -27
- package/dist/utils/openapi/commands/dereferenceCommand.js.map +7 -0
- package/dist/utils/openapi/commands/filterCommand.d.ts +9 -9
- package/dist/utils/openapi/commands/filterCommand.d.ts.map +1 -1
- package/dist/utils/openapi/commands/filterCommand.js +24 -26
- package/dist/utils/openapi/commands/filterCommand.js.map +7 -0
- package/dist/utils/openapi/commands/loadCommand.d.ts +994 -994
- package/dist/utils/openapi/commands/loadCommand.d.ts.map +1 -1
- package/dist/utils/openapi/commands/loadCommand.js +40 -42
- package/dist/utils/openapi/commands/loadCommand.js.map +7 -0
- package/dist/utils/openapi/commands/upgradeCommand.d.ts +311 -311
- package/dist/utils/openapi/commands/upgradeCommand.d.ts.map +1 -1
- package/dist/utils/openapi/commands/upgradeCommand.js +27 -29
- package/dist/utils/openapi/commands/upgradeCommand.js.map +7 -0
- package/dist/utils/openapi/commands/validateCommand.d.ts +311 -311
- package/dist/utils/openapi/commands/validateCommand.d.ts.map +1 -1
- package/dist/utils/openapi/commands/validateCommand.js +31 -33
- package/dist/utils/openapi/commands/validateCommand.js.map +7 -0
- package/dist/utils/openapi/index.d.ts +1 -1
- package/dist/utils/openapi/index.d.ts.map +1 -1
- package/dist/utils/openapi/index.js +2 -0
- package/dist/utils/openapi/index.js.map +7 -0
- package/dist/utils/openapi/openapi.d.ts +702 -700
- package/dist/utils/openapi/openapi.d.ts.map +1 -1
- package/dist/utils/openapi/openapi.js +13 -16
- package/dist/utils/openapi/openapi.js.map +7 -0
- package/dist/utils/openapi/openapi.test-d.js +14 -0
- package/dist/utils/openapi/openapi.test-d.js.map +7 -0
- package/dist/utils/openapi/openapi.test.js +309 -0
- package/dist/utils/openapi/openapi.test.js.map +7 -0
- package/dist/utils/openapi/utils/queueTask.d.ts +1 -1
- package/dist/utils/openapi/utils/queueTask.d.ts.map +1 -1
- package/dist/utils/openapi/utils/queueTask.js +8 -9
- package/dist/utils/openapi/utils/queueTask.js.map +7 -0
- package/dist/utils/openapi/utils/workThroughQueue.d.ts +1 -1
- package/dist/utils/openapi/utils/workThroughQueue.d.ts.map +1 -1
- package/dist/utils/openapi/utils/workThroughQueue.js +49 -64
- package/dist/utils/openapi/utils/workThroughQueue.js.map +7 -0
- package/dist/utils/openapi/utils/workThroughQueue.test.js +244 -0
- package/dist/utils/openapi/utils/workThroughQueue.test.js.map +7 -0
- package/dist/utils/resolveReferences.d.ts +1 -1
- package/dist/utils/resolveReferences.d.ts.map +1 -1
- package/dist/utils/resolveReferences.js +91 -139
- package/dist/utils/resolveReferences.js.map +7 -0
- package/dist/utils/resolveReferences.test.js +567 -0
- package/dist/utils/resolveReferences.test.js.map +7 -0
- package/dist/utils/toJson.d.ts +1 -1
- package/dist/utils/toJson.d.ts.map +1 -1
- package/dist/utils/toJson.js +4 -2
- package/dist/utils/toJson.js.map +7 -0
- package/dist/utils/toYaml.d.ts +1 -1
- package/dist/utils/toYaml.d.ts.map +1 -1
- package/dist/utils/toYaml.js +5 -4
- package/dist/utils/toYaml.js.map +7 -0
- package/dist/utils/transform/index.d.ts +1 -1
- package/dist/utils/transform/index.d.ts.map +1 -1
- package/dist/utils/transform/index.js +2 -0
- package/dist/utils/transform/index.js.map +7 -0
- package/dist/utils/transform/sanitize.d.ts +3 -3
- package/dist/utils/transform/sanitize.d.ts.map +1 -1
- package/dist/utils/transform/sanitize.js +22 -21
- package/dist/utils/transform/sanitize.js.map +7 -0
- package/dist/utils/transform/sanitize.test.js +148 -0
- package/dist/utils/transform/sanitize.test.js.map +7 -0
- package/dist/utils/transform/utils/addInfoObject.d.ts +1 -1
- package/dist/utils/transform/utils/addInfoObject.d.ts.map +1 -1
- package/dist/utils/transform/utils/addInfoObject.js +14 -10
- package/dist/utils/transform/utils/addInfoObject.js.map +7 -0
- package/dist/utils/transform/utils/addLatestOpenApiVersion.d.ts +1 -1
- package/dist/utils/transform/utils/addLatestOpenApiVersion.d.ts.map +1 -1
- package/dist/utils/transform/utils/addLatestOpenApiVersion.js +8 -5
- package/dist/utils/transform/utils/addLatestOpenApiVersion.js.map +7 -0
- package/dist/utils/transform/utils/addMissingTags.d.ts +1 -1
- package/dist/utils/transform/utils/addMissingTags.d.ts.map +1 -1
- package/dist/utils/transform/utils/addMissingTags.js +26 -27
- package/dist/utils/transform/utils/addMissingTags.js.map +7 -0
- package/dist/utils/transform/utils/normalizeSecuritySchemes.d.ts +1 -1
- package/dist/utils/transform/utils/normalizeSecuritySchemes.d.ts.map +1 -1
- package/dist/utils/transform/utils/normalizeSecuritySchemes.js +36 -40
- package/dist/utils/transform/utils/normalizeSecuritySchemes.js.map +7 -0
- package/dist/utils/transform/utils/rejectSwaggerDocuments.d.ts +1 -1
- package/dist/utils/transform/utils/rejectSwaggerDocuments.d.ts.map +1 -1
- package/dist/utils/transform/utils/rejectSwaggerDocuments.js +8 -6
- package/dist/utils/transform/utils/rejectSwaggerDocuments.js.map +7 -0
- package/dist/utils/transformErrors.d.ts +1 -1
- package/dist/utils/transformErrors.d.ts.map +1 -1
- package/dist/utils/transformErrors.js +18 -21
- package/dist/utils/transformErrors.js.map +7 -0
- package/dist/utils/transformErrors.test.js +17 -0
- package/dist/utils/transformErrors.test.js.map +7 -0
- package/dist/utils/traverse.d.ts +3 -3
- package/dist/utils/traverse.d.ts.map +1 -1
- package/dist/utils/traverse.js +22 -23
- package/dist/utils/traverse.js.map +7 -0
- package/dist/utils/traverse.test.js +68 -0
- package/dist/utils/traverse.test.js.map +7 -0
- package/dist/utils/unescapeJsonPointer.js +5 -9
- package/dist/utils/unescapeJsonPointer.js.map +7 -0
- package/dist/utils/unescapeJsonPointer.test.js +19 -0
- package/dist/utils/unescapeJsonPointer.test.js.map +7 -0
- package/dist/utils/upgrade.bench.d.ts +2 -0
- package/dist/utils/upgrade.bench.d.ts.map +1 -0
- package/dist/utils/upgrade.bench.js +31 -0
- package/dist/utils/upgrade.bench.js.map +7 -0
- package/dist/utils/upgrade.d.ts +1 -1
- package/dist/utils/upgrade.d.ts.map +1 -1
- package/dist/utils/upgrade.js +28 -22
- package/dist/utils/upgrade.js.map +7 -0
- package/dist/utils/upgrade.test-d.js +16 -0
- package/dist/utils/upgrade.test-d.js.map +7 -0
- package/dist/utils/upgrade.test.js +57 -0
- package/dist/utils/upgrade.test.js.map +7 -0
- package/dist/utils/upgradeFromThreeToThreeOne.d.ts +3 -3
- package/dist/utils/upgradeFromThreeToThreeOne.d.ts.map +1 -1
- package/dist/utils/upgradeFromThreeToThreeOne.js +107 -144
- package/dist/utils/upgradeFromThreeToThreeOne.js.map +7 -0
- package/dist/utils/upgradeFromThreeToThreeOne.test.js +462 -0
- package/dist/utils/upgradeFromThreeToThreeOne.test.js.map +7 -0
- package/dist/utils/upgradeFromTwoToThree.d.ts.map +1 -1
- package/dist/utils/upgradeFromTwoToThree.js +212 -219
- package/dist/utils/upgradeFromTwoToThree.js.map +7 -0
- package/dist/utils/upgradeFromTwoToThree.test.js +589 -0
- package/dist/utils/upgradeFromTwoToThree.test.js.map +7 -0
- package/dist/utils/validate.d.ts +1 -1
- package/dist/utils/validate.d.ts.map +1 -1
- package/dist/utils/validate.js +14 -16
- package/dist/utils/validate.js.map +7 -0
- package/dist/utils/validate.test.js +64 -0
- package/dist/utils/validate.test.js.map +7 -0
- package/package.json +7 -8
- package/dist/schemas/v2.0/schema.json.js +0 -1623
- package/dist/schemas/v3.0/schema.json.js +0 -1673
- package/dist/schemas/v3.1/schema.json.js +0 -1451
package/dist/utils/toYaml.js
CHANGED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/utils/toYaml.ts"],
|
|
4
|
+
"sourcesContent": ["import { stringify } from 'yaml'\n\nimport type { AnyObject } from '../types/index'\n\nexport const toYaml = (value: AnyObject) => stringify(value)\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,iBAAiB;AAInB,MAAM,SAAS,CAAC,UAAqB,UAAU,KAAK;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './sanitize.
|
|
1
|
+
export * from './sanitize.js';
|
|
2
2
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/index.ts"],"names":[],"mappings":"AAAA,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { OpenAPI } from '@scalar/openapi-types';
|
|
2
|
-
import type { AnyObject } from '../../types/index.
|
|
3
|
-
export { DEFAULT_OPENAPI_VERSION } from './utils/addLatestOpenApiVersion.
|
|
4
|
-
export { DEFAULT_TITLE, DEFAULT_VERSION } from './utils/addInfoObject.
|
|
2
|
+
import type { AnyObject } from '../../types/index.js';
|
|
3
|
+
export { DEFAULT_OPENAPI_VERSION } from './utils/addLatestOpenApiVersion.js';
|
|
4
|
+
export { DEFAULT_TITLE, DEFAULT_VERSION } from './utils/addInfoObject.js';
|
|
5
5
|
/**
|
|
6
6
|
* Make an OpenAPI document a valid and clean OpenAPI document
|
|
7
7
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/sanitize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/sanitize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAOlD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AACzE,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAEtE;;GAEG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAUhE"}
|
|
@@ -1,23 +1,24 @@
|
|
|
1
|
-
import { addInfoObject } from
|
|
2
|
-
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Make an OpenAPI document a valid and clean OpenAPI document
|
|
11
|
-
*/
|
|
1
|
+
import { addInfoObject } from "./utils/addInfoObject.js";
|
|
2
|
+
import { addLatestOpenApiVersion } from "./utils/addLatestOpenApiVersion.js";
|
|
3
|
+
import { addMissingTags } from "./utils/addMissingTags.js";
|
|
4
|
+
import { normalizeSecuritySchemes } from "./utils/normalizeSecuritySchemes.js";
|
|
5
|
+
import { rejectSwaggerDocuments } from "./utils/rejectSwaggerDocuments.js";
|
|
6
|
+
import { DEFAULT_OPENAPI_VERSION } from "./utils/addLatestOpenApiVersion.js";
|
|
7
|
+
import { DEFAULT_TITLE, DEFAULT_VERSION } from "./utils/addInfoObject.js";
|
|
12
8
|
function sanitize(definition) {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
9
|
+
const transformers = [
|
|
10
|
+
rejectSwaggerDocuments,
|
|
11
|
+
addLatestOpenApiVersion,
|
|
12
|
+
addInfoObject,
|
|
13
|
+
addMissingTags,
|
|
14
|
+
normalizeSecuritySchemes
|
|
15
|
+
];
|
|
16
|
+
return transformers.reduce((doc, transformer) => transformer(doc), definition);
|
|
21
17
|
}
|
|
22
|
-
|
|
23
|
-
|
|
18
|
+
export {
|
|
19
|
+
DEFAULT_OPENAPI_VERSION,
|
|
20
|
+
DEFAULT_TITLE,
|
|
21
|
+
DEFAULT_VERSION,
|
|
22
|
+
sanitize
|
|
23
|
+
};
|
|
24
|
+
//# sourceMappingURL=sanitize.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../src/utils/transform/sanitize.ts"],
|
|
4
|
+
"sourcesContent": ["import type { OpenAPI } from '@scalar/openapi-types'\n\nimport type { AnyObject } from '../../types/index'\nimport { addInfoObject } from './utils/addInfoObject'\nimport { addLatestOpenApiVersion } from './utils/addLatestOpenApiVersion'\nimport { addMissingTags } from './utils/addMissingTags'\nimport { normalizeSecuritySchemes } from './utils/normalizeSecuritySchemes'\nimport { rejectSwaggerDocuments } from './utils/rejectSwaggerDocuments'\n\nexport { DEFAULT_OPENAPI_VERSION } from './utils/addLatestOpenApiVersion'\nexport { DEFAULT_TITLE, DEFAULT_VERSION } from './utils/addInfoObject'\n\n/**\n * Make an OpenAPI document a valid and clean OpenAPI document\n */\nexport function sanitize(definition: AnyObject): OpenAPI.Document {\n const transformers = [\n rejectSwaggerDocuments,\n addLatestOpenApiVersion,\n addInfoObject,\n addMissingTags,\n normalizeSecuritySchemes,\n ]\n\n return transformers.reduce((doc, transformer) => transformer(doc), definition)\n}\n"],
|
|
5
|
+
"mappings": "AAGA,SAAS,qBAAqB;AAC9B,SAAS,+BAA+B;AACxC,SAAS,sBAAsB;AAC/B,SAAS,gCAAgC;AACzC,SAAS,8BAA8B;AAEvC,SAAS,+BAA+B;AACxC,SAAS,eAAe,uBAAuB;AAKxC,SAAS,SAAS,YAAyC;AAChE,QAAM,eAAe;AAAA,IACnB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,SAAO,aAAa,OAAO,CAAC,KAAK,gBAAgB,YAAY,GAAG,GAAG,UAAU;AAC/E;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { DEFAULT_OPENAPI_VERSION, DEFAULT_TITLE, sanitize } from "./sanitize.js";
|
|
3
|
+
describe("sanitize", () => {
|
|
4
|
+
describe("required properties", () => {
|
|
5
|
+
it("adds required properties", () => {
|
|
6
|
+
const result = sanitize({});
|
|
7
|
+
expect(result).toStrictEqual({
|
|
8
|
+
openapi: DEFAULT_OPENAPI_VERSION,
|
|
9
|
+
info: {
|
|
10
|
+
title: DEFAULT_TITLE,
|
|
11
|
+
version: "1.0"
|
|
12
|
+
}
|
|
13
|
+
});
|
|
14
|
+
});
|
|
15
|
+
it("doesn\u2019t overwrite existing properties", () => {
|
|
16
|
+
const result = sanitize({
|
|
17
|
+
openapi: "3.0.0",
|
|
18
|
+
info: {
|
|
19
|
+
title: "Foobar"
|
|
20
|
+
}
|
|
21
|
+
});
|
|
22
|
+
expect(result).toStrictEqual({
|
|
23
|
+
openapi: "3.0.0",
|
|
24
|
+
info: {
|
|
25
|
+
title: "Foobar",
|
|
26
|
+
version: "1.0"
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
it("throws an error when it\u2019s a swagger document", () => {
|
|
31
|
+
expect(
|
|
32
|
+
() => sanitize({
|
|
33
|
+
swagger: "2.0"
|
|
34
|
+
})
|
|
35
|
+
).toThrow("Swagger 2.0 documents are not supported. Please upgrade to OpenAPI 3.x.");
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
describe("tags", () => {
|
|
39
|
+
it("adds missing tags", () => {
|
|
40
|
+
const result = sanitize({
|
|
41
|
+
paths: {
|
|
42
|
+
"/pets": {
|
|
43
|
+
get: {
|
|
44
|
+
tags: ["pets"],
|
|
45
|
+
responses: {}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"/stores": {
|
|
49
|
+
get: {
|
|
50
|
+
tags: ["stores"],
|
|
51
|
+
responses: {}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
expect(result.tags).toStrictEqual([{ name: "pets" }, { name: "stores" }]);
|
|
57
|
+
});
|
|
58
|
+
});
|
|
59
|
+
describe("components.securitySchemes", () => {
|
|
60
|
+
it("normalizes security scheme types to lowercase", () => {
|
|
61
|
+
const result = sanitize({
|
|
62
|
+
components: {
|
|
63
|
+
securitySchemes: {
|
|
64
|
+
bearerAuth: {
|
|
65
|
+
type: "HTTP",
|
|
66
|
+
scheme: "bearer"
|
|
67
|
+
},
|
|
68
|
+
basicAuth: {
|
|
69
|
+
type: "HTTP",
|
|
70
|
+
scheme: "basic"
|
|
71
|
+
},
|
|
72
|
+
apiKeyHeader: {
|
|
73
|
+
type: "APIKEY",
|
|
74
|
+
in: "header",
|
|
75
|
+
name: "X-API-Key"
|
|
76
|
+
},
|
|
77
|
+
oauth2: {
|
|
78
|
+
type: "OAUTH2",
|
|
79
|
+
flows: {
|
|
80
|
+
authorizationCode: {
|
|
81
|
+
authorizationUrl: "https://example.com/oauth/authorize",
|
|
82
|
+
tokenUrl: "https://example.com/oauth/token",
|
|
83
|
+
scopes: {}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
openIdConnect: {
|
|
88
|
+
type: "OPENIDCONNECT",
|
|
89
|
+
openIdConnectUrl: "https://example.com/.well-known/openid-configuration"
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
});
|
|
94
|
+
expect(result.components?.securitySchemes).toStrictEqual({
|
|
95
|
+
bearerAuth: {
|
|
96
|
+
type: "http",
|
|
97
|
+
scheme: "bearer"
|
|
98
|
+
},
|
|
99
|
+
basicAuth: {
|
|
100
|
+
type: "http",
|
|
101
|
+
scheme: "basic"
|
|
102
|
+
},
|
|
103
|
+
apiKeyHeader: {
|
|
104
|
+
type: "apiKey",
|
|
105
|
+
in: "header",
|
|
106
|
+
name: "X-API-Key"
|
|
107
|
+
},
|
|
108
|
+
oauth2: {
|
|
109
|
+
type: "oauth2",
|
|
110
|
+
flows: {
|
|
111
|
+
authorizationCode: {
|
|
112
|
+
authorizationUrl: "https://example.com/oauth/authorize",
|
|
113
|
+
tokenUrl: "https://example.com/oauth/token",
|
|
114
|
+
scopes: {}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
openIdConnect: {
|
|
119
|
+
type: "openIdConnect",
|
|
120
|
+
openIdConnectUrl: "https://example.com/.well-known/openid-configuration"
|
|
121
|
+
}
|
|
122
|
+
});
|
|
123
|
+
});
|
|
124
|
+
it("converts array scopes to objects", () => {
|
|
125
|
+
const result = sanitize({
|
|
126
|
+
components: {
|
|
127
|
+
securitySchemes: {
|
|
128
|
+
oauth2: {
|
|
129
|
+
type: "oauth2",
|
|
130
|
+
flows: {
|
|
131
|
+
authorizationCode: {
|
|
132
|
+
authorizationUrl: "https://example.com/oauth/authorize",
|
|
133
|
+
tokenUrl: "https://example.com/oauth/token",
|
|
134
|
+
scopes: ["read:data", "write:data"]
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
});
|
|
141
|
+
expect(result.components?.securitySchemes?.oauth2.flows.authorizationCode.scopes).toStrictEqual({
|
|
142
|
+
"read:data": "",
|
|
143
|
+
"write:data": ""
|
|
144
|
+
});
|
|
145
|
+
});
|
|
146
|
+
});
|
|
147
|
+
});
|
|
148
|
+
//# sourceMappingURL=sanitize.test.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../src/utils/transform/sanitize.test.ts"],
|
|
4
|
+
"sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { DEFAULT_OPENAPI_VERSION, DEFAULT_TITLE, sanitize } from './sanitize'\n\ndescribe('sanitize', () => {\n describe('required properties', () => {\n /** @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#openapi-object */\n it('adds required properties', () => {\n const result = sanitize({})\n\n expect(result).toStrictEqual({\n openapi: DEFAULT_OPENAPI_VERSION,\n info: {\n title: DEFAULT_TITLE,\n version: '1.0',\n },\n })\n })\n\n it('doesn\u2019t overwrite existing properties', () => {\n const result = sanitize({\n openapi: '3.0.0',\n info: {\n title: 'Foobar',\n },\n })\n\n expect(result).toStrictEqual({\n openapi: '3.0.0',\n info: {\n title: 'Foobar',\n version: '1.0',\n },\n })\n })\n\n it('throws an error when it\u2019s a swagger document', () => {\n expect(() =>\n sanitize({\n swagger: '2.0',\n }),\n ).toThrow('Swagger 2.0 documents are not supported. Please upgrade to OpenAPI 3.x.')\n })\n })\n\n describe('tags', () => {\n it('adds missing tags', () => {\n const result = sanitize({\n paths: {\n '/pets': {\n get: {\n tags: ['pets'],\n responses: {},\n },\n },\n '/stores': {\n get: {\n tags: ['stores'],\n responses: {},\n },\n },\n },\n })\n\n expect(result.tags).toStrictEqual([{ name: 'pets' }, { name: 'stores' }])\n })\n })\n\n describe('components.securitySchemes', () => {\n it('normalizes security scheme types to lowercase', () => {\n const result = sanitize({\n components: {\n securitySchemes: {\n bearerAuth: {\n type: 'HTTP',\n scheme: 'bearer',\n },\n basicAuth: {\n type: 'HTTP',\n scheme: 'basic',\n },\n apiKeyHeader: {\n type: 'APIKEY',\n in: 'header',\n name: 'X-API-Key',\n },\n oauth2: {\n type: 'OAUTH2',\n flows: {\n authorizationCode: {\n authorizationUrl: 'https://example.com/oauth/authorize',\n tokenUrl: 'https://example.com/oauth/token',\n scopes: {},\n },\n },\n },\n openIdConnect: {\n type: 'OPENIDCONNECT',\n openIdConnectUrl: 'https://example.com/.well-known/openid-configuration',\n },\n },\n },\n })\n\n expect(result.components?.securitySchemes).toStrictEqual({\n bearerAuth: {\n type: 'http',\n scheme: 'bearer',\n },\n basicAuth: {\n type: 'http',\n scheme: 'basic',\n },\n apiKeyHeader: {\n type: 'apiKey',\n in: 'header',\n name: 'X-API-Key',\n },\n oauth2: {\n type: 'oauth2',\n flows: {\n authorizationCode: {\n authorizationUrl: 'https://example.com/oauth/authorize',\n tokenUrl: 'https://example.com/oauth/token',\n scopes: {},\n },\n },\n },\n openIdConnect: {\n type: 'openIdConnect',\n openIdConnectUrl: 'https://example.com/.well-known/openid-configuration',\n },\n })\n })\n\n it('converts array scopes to objects', () => {\n const result = sanitize({\n components: {\n securitySchemes: {\n oauth2: {\n type: 'oauth2',\n flows: {\n authorizationCode: {\n authorizationUrl: 'https://example.com/oauth/authorize',\n tokenUrl: 'https://example.com/oauth/token',\n scopes: ['read:data', 'write:data'],\n },\n },\n },\n },\n },\n })\n\n expect(result.components?.securitySchemes?.oauth2.flows.authorizationCode.scopes).toStrictEqual({\n 'read:data': '',\n 'write:data': '',\n })\n })\n })\n})\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,yBAAyB,eAAe,gBAAgB;AAEjE,SAAS,YAAY,MAAM;AACzB,WAAS,uBAAuB,MAAM;AAEpC,OAAG,4BAA4B,MAAM;AACnC,YAAM,SAAS,SAAS,CAAC,CAAC;AAE1B,aAAO,MAAM,EAAE,cAAc;AAAA,QAC3B,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,OAAG,8CAAyC,MAAM;AAChD,YAAM,SAAS,SAAS;AAAA,QACtB,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,QACT;AAAA,MACF,CAAC;AAED,aAAO,MAAM,EAAE,cAAc;AAAA,QAC3B,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,OAAG,qDAAgD,MAAM;AACvD;AAAA,QAAO,MACL,SAAS;AAAA,UACP,SAAS;AAAA,QACX,CAAC;AAAA,MACH,EAAE,QAAQ,yEAAyE;AAAA,IACrF,CAAC;AAAA,EACH,CAAC;AAED,WAAS,QAAQ,MAAM;AACrB,OAAG,qBAAqB,MAAM;AAC5B,YAAM,SAAS,SAAS;AAAA,QACtB,OAAO;AAAA,UACL,SAAS;AAAA,YACP,KAAK;AAAA,cACH,MAAM,CAAC,MAAM;AAAA,cACb,WAAW,CAAC;AAAA,YACd;AAAA,UACF;AAAA,UACA,WAAW;AAAA,YACT,KAAK;AAAA,cACH,MAAM,CAAC,QAAQ;AAAA,cACf,WAAW,CAAC;AAAA,YACd;AAAA,UACF;AAAA,QACF;AAAA,MACF,CAAC;AAED,aAAO,OAAO,IAAI,EAAE,cAAc,CAAC,EAAE,MAAM,OAAO,GAAG,EAAE,MAAM,SAAS,CAAC,CAAC;AAAA,IAC1E,CAAC;AAAA,EACH,CAAC;AAED,WAAS,8BAA8B,MAAM;AAC3C,OAAG,iDAAiD,MAAM;AACxD,YAAM,SAAS,SAAS;AAAA,QACtB,YAAY;AAAA,UACV,iBAAiB;AAAA,YACf,YAAY;AAAA,cACV,MAAM;AAAA,cACN,QAAQ;AAAA,YACV;AAAA,YACA,WAAW;AAAA,cACT,MAAM;AAAA,cACN,QAAQ;AAAA,YACV;AAAA,YACA,cAAc;AAAA,cACZ,MAAM;AAAA,cACN,IAAI;AAAA,cACJ,MAAM;AAAA,YACR;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,cACN,OAAO;AAAA,gBACL,mBAAmB;AAAA,kBACjB,kBAAkB;AAAA,kBAClB,UAAU;AAAA,kBACV,QAAQ,CAAC;AAAA,gBACX;AAAA,cACF;AAAA,YACF;AAAA,YACA,eAAe;AAAA,cACb,MAAM;AAAA,cACN,kBAAkB;AAAA,YACpB;AAAA,UACF;AAAA,QACF;AAAA,MACF,CAAC;AAED,aAAO,OAAO,YAAY,eAAe,EAAE,cAAc;AAAA,QACvD,YAAY;AAAA,UACV,MAAM;AAAA,UACN,QAAQ;AAAA,QACV;AAAA,QACA,WAAW;AAAA,UACT,MAAM;AAAA,UACN,QAAQ;AAAA,QACV;AAAA,QACA,cAAc;AAAA,UACZ,MAAM;AAAA,UACN,IAAI;AAAA,UACJ,MAAM;AAAA,QACR;AAAA,QACA,QAAQ;AAAA,UACN,MAAM;AAAA,UACN,OAAO;AAAA,YACL,mBAAmB;AAAA,cACjB,kBAAkB;AAAA,cAClB,UAAU;AAAA,cACV,QAAQ,CAAC;AAAA,YACX;AAAA,UACF;AAAA,QACF;AAAA,QACA,eAAe;AAAA,UACb,MAAM;AAAA,UACN,kBAAkB;AAAA,QACpB;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,OAAG,oCAAoC,MAAM;AAC3C,YAAM,SAAS,SAAS;AAAA,QACtB,YAAY;AAAA,UACV,iBAAiB;AAAA,YACf,QAAQ;AAAA,cACN,MAAM;AAAA,cACN,OAAO;AAAA,gBACL,mBAAmB;AAAA,kBACjB,kBAAkB;AAAA,kBAClB,UAAU;AAAA,kBACV,QAAQ,CAAC,aAAa,YAAY;AAAA,gBACpC;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF,CAAC;AAED,aAAO,OAAO,YAAY,iBAAiB,OAAO,MAAM,kBAAkB,MAAM,EAAE,cAAc;AAAA,QAC9F,aAAa;AAAA,QACb,cAAc;AAAA,MAChB,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AACH,CAAC;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AnyObject } from '../../../types/index.
|
|
1
|
+
import type { AnyObject } from '../../../types/index.js';
|
|
2
2
|
export declare const DEFAULT_TITLE = "API";
|
|
3
3
|
export declare const DEFAULT_VERSION = "1.0";
|
|
4
4
|
export declare const addInfoObject: (definition: AnyObject) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"addInfoObject.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addInfoObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"addInfoObject.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addInfoObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,eAAO,MAAM,aAAa,QAAQ,CAAA;AAClC,eAAO,MAAM,eAAe,QAAQ,CAAA;AAEpC,eAAO,MAAM,aAAa,eAAgB,SAAS;;CAOjD,CAAA"}
|
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
const DEFAULT_TITLE =
|
|
2
|
-
const DEFAULT_VERSION =
|
|
1
|
+
const DEFAULT_TITLE = "API";
|
|
2
|
+
const DEFAULT_VERSION = "1.0";
|
|
3
3
|
const addInfoObject = (definition) => ({
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
...definition,
|
|
5
|
+
info: {
|
|
6
|
+
...definition.info,
|
|
7
|
+
title: definition.info?.title ?? DEFAULT_TITLE,
|
|
8
|
+
version: definition.info?.version ?? DEFAULT_VERSION
|
|
9
|
+
}
|
|
10
10
|
});
|
|
11
|
-
|
|
12
|
-
|
|
11
|
+
export {
|
|
12
|
+
DEFAULT_TITLE,
|
|
13
|
+
DEFAULT_VERSION,
|
|
14
|
+
addInfoObject
|
|
15
|
+
};
|
|
16
|
+
//# sourceMappingURL=addInfoObject.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../../src/utils/transform/utils/addInfoObject.ts"],
|
|
4
|
+
"sourcesContent": ["import type { AnyObject } from '../../../types/index'\n\nexport const DEFAULT_TITLE = 'API'\nexport const DEFAULT_VERSION = '1.0'\n\nexport const addInfoObject = (definition: AnyObject) => ({\n ...definition,\n info: {\n ...definition.info,\n title: definition.info?.title ?? DEFAULT_TITLE,\n version: definition.info?.version ?? DEFAULT_VERSION,\n },\n})\n"],
|
|
5
|
+
"mappings": "AAEO,MAAM,gBAAgB;AACtB,MAAM,kBAAkB;AAExB,MAAM,gBAAgB,CAAC,gBAA2B;AAAA,EACvD,GAAG;AAAA,EACH,MAAM;AAAA,IACJ,GAAG,WAAW;AAAA,IACd,OAAO,WAAW,MAAM,SAAS;AAAA,IACjC,SAAS,WAAW,MAAM,WAAW;AAAA,EACvC;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"addLatestOpenApiVersion.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addLatestOpenApiVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"addLatestOpenApiVersion.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addLatestOpenApiVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,eAAO,MAAM,uBAAuB,UAAU,CAAA;AAE9C,eAAO,MAAM,uBAAuB,eAAgB,SAAS;;CAG3D,CAAA"}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
|
-
const DEFAULT_OPENAPI_VERSION =
|
|
1
|
+
const DEFAULT_OPENAPI_VERSION = "3.1.1";
|
|
2
2
|
const addLatestOpenApiVersion = (definition) => ({
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
openapi: definition.openapi ?? DEFAULT_OPENAPI_VERSION,
|
|
4
|
+
...definition
|
|
5
5
|
});
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
export {
|
|
7
|
+
DEFAULT_OPENAPI_VERSION,
|
|
8
|
+
addLatestOpenApiVersion
|
|
9
|
+
};
|
|
10
|
+
//# sourceMappingURL=addLatestOpenApiVersion.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../../src/utils/transform/utils/addLatestOpenApiVersion.ts"],
|
|
4
|
+
"sourcesContent": ["import type { AnyObject } from '../../../types/index'\n\nexport const DEFAULT_OPENAPI_VERSION = '3.1.1'\n\nexport const addLatestOpenApiVersion = (definition: AnyObject) => ({\n openapi: definition.openapi ?? DEFAULT_OPENAPI_VERSION,\n ...definition,\n})\n"],
|
|
5
|
+
"mappings": "AAEO,MAAM,0BAA0B;AAEhC,MAAM,0BAA0B,CAAC,gBAA2B;AAAA,EACjE,SAAS,WAAW,WAAW;AAAA,EAC/B,GAAG;AACL;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"addMissingTags.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addMissingTags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"addMissingTags.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addMissingTags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,eAAO,MAAM,cAAc,eAAgB,SAAS,cAmCnD,CAAA"}
|
|
@@ -1,31 +1,30 @@
|
|
|
1
1
|
const addMissingTags = (definition) => {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
}
|
|
15
|
-
}
|
|
16
|
-
}
|
|
2
|
+
if (!definition.paths) {
|
|
3
|
+
return definition;
|
|
4
|
+
}
|
|
5
|
+
const usedTags = /* @__PURE__ */ new Set();
|
|
6
|
+
for (const path of Object.values(definition.paths)) {
|
|
7
|
+
if (typeof path === "object" && path !== null) {
|
|
8
|
+
for (const operation of Object.values(path)) {
|
|
9
|
+
if (typeof operation === "object" && operation !== null && "tags" in operation) {
|
|
10
|
+
const tags = operation.tags;
|
|
11
|
+
if (Array.isArray(tags)) {
|
|
12
|
+
tags.forEach((tag) => usedTags.add(String(tag)));
|
|
13
|
+
}
|
|
17
14
|
}
|
|
15
|
+
}
|
|
18
16
|
}
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
17
|
+
}
|
|
18
|
+
const existingTags = new Set(
|
|
19
|
+
(Array.isArray(definition.tags) ? definition.tags : []).map((tag) => typeof tag === "object" && tag !== null ? String(tag.name) : null).filter(Boolean)
|
|
20
|
+
);
|
|
21
|
+
const missingTags = [...usedTags].filter((tag) => !existingTags.has(tag)).map((name) => ({ name }));
|
|
22
|
+
return {
|
|
23
|
+
...definition,
|
|
24
|
+
tags: [...Array.isArray(definition.tags) ? definition.tags : [], ...missingTags]
|
|
25
|
+
};
|
|
26
|
+
};
|
|
27
|
+
export {
|
|
28
|
+
addMissingTags
|
|
29
29
|
};
|
|
30
|
-
|
|
31
|
-
export { addMissingTags };
|
|
30
|
+
//# sourceMappingURL=addMissingTags.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../../src/utils/transform/utils/addMissingTags.ts"],
|
|
4
|
+
"sourcesContent": ["import type { AnyObject } from '../../../types/index'\n\nexport const addMissingTags = (definition: AnyObject) => {\n if (!definition.paths) {\n return definition\n }\n\n // Collect all unique tags used in operations\n const usedTags = new Set<string>()\n for (const path of Object.values(definition.paths)) {\n if (typeof path === 'object' && path !== null) {\n for (const operation of Object.values(path)) {\n if (typeof operation === 'object' && operation !== null && 'tags' in operation) {\n const tags = operation.tags\n\n if (Array.isArray(tags)) {\n tags.forEach((tag) => usedTags.add(String(tag)))\n }\n }\n }\n }\n }\n\n // Convert tags to array of tag objects if not already present\n const existingTags = new Set(\n (Array.isArray(definition.tags) ? definition.tags : [])\n .map((tag) => (typeof tag === 'object' && tag !== null ? String(tag.name) : null))\n .filter(Boolean),\n )\n\n // Add missing tags\n const missingTags = [...usedTags].filter((tag) => !existingTags.has(tag)).map((name) => ({ name }))\n\n return {\n ...definition,\n tags: [...(Array.isArray(definition.tags) ? definition.tags : []), ...missingTags],\n }\n}\n"],
|
|
5
|
+
"mappings": "AAEO,MAAM,iBAAiB,CAAC,eAA0B;AACvD,MAAI,CAAC,WAAW,OAAO;AACrB,WAAO;AAAA,EACT;AAGA,QAAM,WAAW,oBAAI,IAAY;AACjC,aAAW,QAAQ,OAAO,OAAO,WAAW,KAAK,GAAG;AAClD,QAAI,OAAO,SAAS,YAAY,SAAS,MAAM;AAC7C,iBAAW,aAAa,OAAO,OAAO,IAAI,GAAG;AAC3C,YAAI,OAAO,cAAc,YAAY,cAAc,QAAQ,UAAU,WAAW;AAC9E,gBAAM,OAAO,UAAU;AAEvB,cAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,iBAAK,QAAQ,CAAC,QAAQ,SAAS,IAAI,OAAO,GAAG,CAAC,CAAC;AAAA,UACjD;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAGA,QAAM,eAAe,IAAI;AAAA,KACtB,MAAM,QAAQ,WAAW,IAAI,IAAI,WAAW,OAAO,CAAC,GAClD,IAAI,CAAC,QAAS,OAAO,QAAQ,YAAY,QAAQ,OAAO,OAAO,IAAI,IAAI,IAAI,IAAK,EAChF,OAAO,OAAO;AAAA,EACnB;AAGA,QAAM,cAAc,CAAC,GAAG,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,aAAa,IAAI,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE;AAElG,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM,CAAC,GAAI,MAAM,QAAQ,WAAW,IAAI,IAAI,WAAW,OAAO,CAAC,GAAI,GAAG,WAAW;AAAA,EACnF;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"normalizeSecuritySchemes.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/normalizeSecuritySchemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"normalizeSecuritySchemes.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/normalizeSecuritySchemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,eAAO,MAAM,wBAAwB,eAAgB,SAAS,cAiD7D,CAAA"}
|
|
@@ -1,46 +1,42 @@
|
|
|
1
1
|
const normalizeSecuritySchemes = (definition) => {
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
if (!definition.components?.securitySchemes) {
|
|
3
|
+
return definition;
|
|
4
|
+
}
|
|
5
|
+
const securitySchemes = { ...definition.components.securitySchemes };
|
|
6
|
+
for (const scheme of Object.values(securitySchemes)) {
|
|
7
|
+
if (typeof scheme === "object" && scheme !== null && "type" in scheme) {
|
|
8
|
+
const type = String(scheme.type).toLowerCase();
|
|
9
|
+
scheme.type = {
|
|
10
|
+
apikey: "apiKey",
|
|
11
|
+
oauth2: "oauth2",
|
|
12
|
+
http: "http",
|
|
13
|
+
mutualtls: "mutualTLS",
|
|
14
|
+
openidconnect: "openIdConnect"
|
|
15
|
+
}[type] ?? type;
|
|
4
16
|
}
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
openidconnect: 'openIdConnect',
|
|
16
|
-
}[type] ?? type;
|
|
17
|
+
}
|
|
18
|
+
for (const scheme of Object.values(securitySchemes)) {
|
|
19
|
+
if (typeof scheme === "object" && scheme !== null && "type" in scheme && scheme.type === "oauth2" && "flows" in scheme) {
|
|
20
|
+
const flows = scheme.flows;
|
|
21
|
+
for (const flow of Object.values(flows)) {
|
|
22
|
+
if (typeof flow === "object" && flow !== null && "scopes" in flow && Array.isArray(flow.scopes)) {
|
|
23
|
+
flow.scopes = flow.scopes.reduce((acc, scope) => {
|
|
24
|
+
acc[scope] = "";
|
|
25
|
+
return acc;
|
|
26
|
+
}, {});
|
|
17
27
|
}
|
|
28
|
+
}
|
|
18
29
|
}
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
'flows' in scheme) {
|
|
26
|
-
const flows = scheme.flows;
|
|
27
|
-
for (const flow of Object.values(flows)) {
|
|
28
|
-
if (typeof flow === 'object' && flow !== null && 'scopes' in flow && Array.isArray(flow.scopes)) {
|
|
29
|
-
flow.scopes = flow.scopes.reduce((acc, scope) => {
|
|
30
|
-
acc[scope] = '';
|
|
31
|
-
return acc;
|
|
32
|
-
}, {});
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
}
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
...definition,
|
|
33
|
+
components: {
|
|
34
|
+
...definition.components,
|
|
35
|
+
securitySchemes
|
|
36
36
|
}
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
securitySchemes,
|
|
42
|
-
},
|
|
43
|
-
};
|
|
37
|
+
};
|
|
38
|
+
};
|
|
39
|
+
export {
|
|
40
|
+
normalizeSecuritySchemes
|
|
44
41
|
};
|
|
45
|
-
|
|
46
|
-
export { normalizeSecuritySchemes };
|
|
42
|
+
//# sourceMappingURL=normalizeSecuritySchemes.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../../src/utils/transform/utils/normalizeSecuritySchemes.ts"],
|
|
4
|
+
"sourcesContent": ["import type { AnyObject } from '../../../types/index'\n\nexport const normalizeSecuritySchemes = (definition: AnyObject) => {\n if (!definition.components?.securitySchemes) {\n return definition\n }\n\n const securitySchemes = { ...definition.components.securitySchemes }\n\n for (const scheme of Object.values(securitySchemes)) {\n if (typeof scheme === 'object' && scheme !== null && 'type' in scheme) {\n const type = String(scheme.type).toLowerCase()\n scheme.type =\n {\n apikey: 'apiKey',\n oauth2: 'oauth2',\n http: 'http',\n mutualtls: 'mutualTLS',\n openidconnect: 'openIdConnect',\n }[type] ?? type\n }\n }\n\n // Convert array scopes to objects\n for (const scheme of Object.values(securitySchemes)) {\n if (\n typeof scheme === 'object' &&\n scheme !== null &&\n 'type' in scheme &&\n scheme.type === 'oauth2' &&\n 'flows' in scheme\n ) {\n const flows = scheme.flows as AnyObject\n for (const flow of Object.values(flows)) {\n if (typeof flow === 'object' && flow !== null && 'scopes' in flow && Array.isArray(flow.scopes)) {\n flow.scopes = flow.scopes.reduce((acc: AnyObject, scope: string) => {\n acc[scope] = ''\n return acc\n }, {})\n }\n }\n }\n }\n\n return {\n ...definition,\n components: {\n ...definition.components,\n securitySchemes,\n },\n }\n}\n"],
|
|
5
|
+
"mappings": "AAEO,MAAM,2BAA2B,CAAC,eAA0B;AACjE,MAAI,CAAC,WAAW,YAAY,iBAAiB;AAC3C,WAAO;AAAA,EACT;AAEA,QAAM,kBAAkB,EAAE,GAAG,WAAW,WAAW,gBAAgB;AAEnE,aAAW,UAAU,OAAO,OAAO,eAAe,GAAG;AACnD,QAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,UAAU,QAAQ;AACrE,YAAM,OAAO,OAAO,OAAO,IAAI,EAAE,YAAY;AAC7C,aAAO,OACL;AAAA,QACE,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,MAAM;AAAA,QACN,WAAW;AAAA,QACX,eAAe;AAAA,MACjB,EAAE,IAAI,KAAK;AAAA,IACf;AAAA,EACF;AAGA,aAAW,UAAU,OAAO,OAAO,eAAe,GAAG;AACnD,QACE,OAAO,WAAW,YAClB,WAAW,QACX,UAAU,UACV,OAAO,SAAS,YAChB,WAAW,QACX;AACA,YAAM,QAAQ,OAAO;AACrB,iBAAW,QAAQ,OAAO,OAAO,KAAK,GAAG;AACvC,YAAI,OAAO,SAAS,YAAY,SAAS,QAAQ,YAAY,QAAQ,MAAM,QAAQ,KAAK,MAAM,GAAG;AAC/F,eAAK,SAAS,KAAK,OAAO,OAAO,CAAC,KAAgB,UAAkB;AAClE,gBAAI,KAAK,IAAI;AACb,mBAAO;AAAA,UACT,GAAG,CAAC,CAAC;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,GAAG;AAAA,IACH,YAAY;AAAA,MACV,GAAG,WAAW;AAAA,MACd;AAAA,IACF;AAAA,EACF;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rejectSwaggerDocuments.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/rejectSwaggerDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"rejectSwaggerDocuments.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/rejectSwaggerDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,eAAO,MAAM,sBAAsB,cAAe,SAAS,cAM1D,CAAA"}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
const rejectSwaggerDocuments = (defintion) => {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
if ("swagger" in defintion) {
|
|
3
|
+
throw new Error("Swagger 2.0 documents are not supported. Please upgrade to OpenAPI 3.x.");
|
|
4
|
+
}
|
|
5
|
+
return defintion;
|
|
6
6
|
};
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
export {
|
|
8
|
+
rejectSwaggerDocuments
|
|
9
|
+
};
|
|
10
|
+
//# sourceMappingURL=rejectSwaggerDocuments.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../../src/utils/transform/utils/rejectSwaggerDocuments.ts"],
|
|
4
|
+
"sourcesContent": ["import type { AnyObject } from '../../../types/index'\n\nexport const rejectSwaggerDocuments = (defintion: AnyObject) => {\n if ('swagger' in defintion) {\n throw new Error('Swagger 2.0 documents are not supported. Please upgrade to OpenAPI 3.x.')\n }\n\n return defintion\n}\n"],
|
|
5
|
+
"mappings": "AAEO,MAAM,yBAAyB,CAAC,cAAyB;AAC9D,MAAI,aAAa,WAAW;AAC1B,UAAM,IAAI,MAAM,yEAAyE;AAAA,EAC3F;AAEA,SAAO;AACT;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformErrors.d.ts","sourceRoot":"","sources":["../../src/utils/transformErrors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"transformErrors.d.ts","sourceRoot":"","sources":["../../src/utils/transformErrors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAG/C;;GAEG;AACH,wBAAgB,eAAe,CAAC,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAkBpE"}
|