@apimatic/cli 1.1.0-alpha.8 → 1.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 +436 -374
- package/bin/run.js +5 -0
- package/lib/actions/action-result.d.ts +13 -0
- package/lib/actions/action-result.js +44 -0
- package/lib/actions/action-result.js.map +1 -0
- package/lib/actions/api/transform.d.ts +15 -0
- package/lib/actions/api/transform.js +48 -0
- package/lib/actions/api/transform.js.map +1 -0
- package/lib/actions/api/validate.d.ts +12 -0
- package/lib/actions/api/validate.js +41 -0
- package/lib/actions/api/validate.js.map +1 -0
- package/lib/actions/auth/login.d.ts +13 -0
- package/lib/actions/auth/login.js +55 -0
- package/lib/actions/auth/login.js.map +1 -0
- package/lib/actions/auth/logout.d.ts +8 -0
- package/lib/actions/auth/logout.js +15 -0
- package/lib/actions/auth/logout.js.map +1 -0
- package/lib/actions/auth/status.d.ts +11 -0
- package/lib/actions/auth/status.js +26 -0
- package/lib/actions/auth/status.js.map +1 -0
- package/lib/actions/portal/copilot.d.ts +16 -0
- package/lib/actions/portal/copilot.js +89 -0
- package/lib/actions/portal/copilot.js.map +1 -0
- package/lib/actions/portal/generate.d.ts +11 -5
- package/lib/actions/portal/generate.js +60 -55
- package/lib/actions/portal/generate.js.map +1 -0
- package/lib/actions/portal/quickstart.d.ts +16 -0
- package/lib/actions/portal/quickstart.js +146 -0
- package/lib/actions/portal/quickstart.js.map +1 -0
- package/lib/actions/portal/recipe/new-recipe.d.ts +15 -0
- package/lib/actions/portal/recipe/new-recipe.js +177 -0
- package/lib/actions/portal/recipe/new-recipe.js.map +1 -0
- package/lib/actions/portal/serve.d.ts +15 -0
- package/lib/actions/portal/serve.js +118 -0
- package/lib/actions/portal/serve.js.map +1 -0
- package/lib/actions/portal/toc/new-toc.d.ts +21 -0
- package/lib/actions/portal/toc/new-toc.js +97 -0
- package/lib/actions/portal/toc/new-toc.js.map +1 -0
- package/lib/actions/quickstart.d.ts +10 -0
- package/lib/actions/quickstart.js +30 -0
- package/lib/actions/quickstart.js.map +1 -0
- package/lib/actions/sdk/generate.d.ts +13 -0
- package/lib/actions/sdk/generate.js +47 -0
- package/lib/actions/sdk/generate.js.map +1 -0
- package/lib/actions/sdk/quickstart.d.ts +14 -0
- package/lib/actions/sdk/quickstart.js +149 -0
- package/lib/actions/sdk/quickstart.js.map +1 -0
- package/lib/application/portal/recipe/portal-recipe.d.ts +8 -0
- package/lib/application/portal/recipe/portal-recipe.js +33 -0
- package/lib/application/portal/recipe/portal-recipe.js.map +1 -0
- package/lib/application/portal/recipe/recipe-generator.d.ts +21 -0
- package/lib/application/portal/recipe/recipe-generator.js +145 -0
- package/lib/application/portal/recipe/recipe-generator.js.map +1 -0
- package/lib/application/portal/{new/toc → toc}/toc-content-parser.d.ts +1 -1
- package/lib/application/portal/toc/toc-content-parser.js +44 -0
- package/lib/application/portal/toc/toc-content-parser.js.map +1 -0
- package/lib/application/portal/{new/toc → toc}/toc-structure-generator.d.ts +1 -1
- package/lib/application/portal/toc/toc-structure-generator.js +84 -0
- package/lib/application/portal/toc/toc-structure-generator.js.map +1 -0
- package/lib/client-utils/auth-manager.d.ts +7 -2
- package/lib/client-utils/auth-manager.js +26 -14
- package/lib/client-utils/auth-manager.js.map +1 -0
- package/lib/commands/api/transform.d.ts +10 -7
- package/lib/commands/api/transform.js +51 -111
- package/lib/commands/api/transform.js.map +1 -0
- package/lib/commands/api/validate.d.ts +7 -4
- package/lib/commands/api/validate.js +31 -74
- package/lib/commands/api/validate.js.map +1 -0
- package/lib/commands/auth/login.d.ts +3 -1
- package/lib/commands/auth/login.js +26 -68
- package/lib/commands/auth/login.js.map +1 -0
- package/lib/commands/auth/logout.d.ts +3 -1
- package/lib/commands/auth/logout.js +14 -21
- package/lib/commands/auth/logout.js.map +1 -0
- package/lib/commands/auth/status.d.ts +1 -0
- package/lib/commands/auth/status.js +18 -21
- package/lib/commands/auth/status.js.map +1 -0
- package/lib/commands/portal/copilot.d.ts +13 -0
- package/lib/commands/portal/copilot.js +34 -0
- package/lib/commands/portal/copilot.js.map +1 -0
- package/lib/commands/portal/generate.d.ts +7 -11
- package/lib/commands/portal/generate.js +26 -89
- package/lib/commands/portal/generate.js.map +1 -0
- package/lib/commands/portal/recipe/new.d.ts +12 -0
- package/lib/commands/portal/recipe/new.js +45 -0
- package/lib/commands/portal/recipe/new.js.map +1 -0
- package/lib/commands/portal/serve.d.ts +8 -8
- package/lib/commands/portal/serve.js +41 -125
- package/lib/commands/portal/serve.js.map +1 -0
- package/lib/commands/portal/toc/new.d.ts +14 -0
- package/lib/commands/portal/toc/new.js +60 -0
- package/lib/commands/portal/toc/new.js.map +1 -0
- package/lib/commands/quickstart.d.ts +9 -0
- package/lib/commands/quickstart.js +37 -0
- package/lib/commands/quickstart.js.map +1 -0
- package/lib/commands/sdk/generate.d.ts +10 -8
- package/lib/commands/sdk/generate.js +46 -131
- package/lib/commands/sdk/generate.js.map +1 -0
- package/lib/config/axios-config.js +4 -6
- package/lib/config/axios-config.js.map +1 -0
- package/lib/hooks/not-found.d.ts +3 -0
- package/lib/hooks/not-found.js +52 -0
- package/lib/hooks/not-found.js.map +1 -0
- package/lib/hooks/utils.d.ts +5 -0
- package/lib/hooks/utils.js +51 -0
- package/lib/hooks/utils.js.map +1 -0
- package/lib/index.js +2 -5
- package/lib/index.js.map +1 -0
- package/lib/infrastructure/debounce-service.d.ts +10 -0
- package/lib/infrastructure/debounce-service.js +52 -0
- package/lib/infrastructure/debounce-service.js.map +1 -0
- package/lib/infrastructure/env-info.d.ts +12 -0
- package/lib/infrastructure/env-info.js +58 -0
- package/lib/infrastructure/env-info.js.map +1 -0
- package/lib/infrastructure/file-service.d.ts +24 -0
- package/lib/infrastructure/file-service.js +120 -0
- package/lib/infrastructure/file-service.js.map +1 -0
- package/lib/infrastructure/launcher-service.d.ts +9 -0
- package/lib/infrastructure/launcher-service.js +72 -0
- package/lib/infrastructure/launcher-service.js.map +1 -0
- package/lib/infrastructure/network-service.d.ts +3 -0
- package/lib/infrastructure/network-service.js +7 -0
- package/lib/infrastructure/network-service.js.map +1 -0
- package/lib/infrastructure/service-error.d.ts +16 -0
- package/lib/infrastructure/service-error.js +49 -0
- package/lib/infrastructure/service-error.js.map +1 -0
- package/lib/infrastructure/services/api-client-factory.d.ts +6 -0
- package/lib/infrastructure/services/api-client-factory.js +20 -0
- package/lib/infrastructure/services/api-client-factory.js.map +1 -0
- package/lib/infrastructure/services/api-service.d.ts +12 -0
- package/lib/infrastructure/services/api-service.js +79 -0
- package/lib/infrastructure/services/api-service.js.map +1 -0
- package/lib/infrastructure/services/auth-service.d.ts +11 -0
- package/lib/infrastructure/services/auth-service.js +37 -0
- package/lib/infrastructure/services/auth-service.js.map +1 -0
- package/lib/infrastructure/services/file-download-service.d.ts +15 -0
- package/lib/infrastructure/services/file-download-service.js +104 -0
- package/lib/infrastructure/services/file-download-service.js.map +1 -0
- package/lib/infrastructure/services/portal-service.d.ts +17 -12
- package/lib/infrastructure/services/portal-service.js +134 -99
- package/lib/infrastructure/services/portal-service.js.map +1 -0
- package/lib/infrastructure/services/telemetry-service.d.ts +9 -0
- package/lib/infrastructure/services/telemetry-service.js +38 -0
- package/lib/infrastructure/services/telemetry-service.js.map +1 -0
- package/lib/infrastructure/services/transformation-service.d.ts +23 -0
- package/lib/infrastructure/services/transformation-service.js +56 -0
- package/lib/infrastructure/services/transformation-service.js.map +1 -0
- package/lib/infrastructure/services/validation-service.d.ts +17 -0
- package/lib/infrastructure/services/validation-service.js +49 -0
- package/lib/infrastructure/services/validation-service.js.map +1 -0
- package/lib/infrastructure/tmp-extensions.d.ts +2 -0
- package/lib/infrastructure/tmp-extensions.js +6 -0
- package/lib/infrastructure/tmp-extensions.js.map +1 -0
- package/lib/infrastructure/zip-service.d.ts +6 -0
- package/lib/infrastructure/zip-service.js +39 -0
- package/lib/infrastructure/zip-service.js.map +1 -0
- package/lib/prompts/api/transform.d.ts +11 -0
- package/lib/prompts/api/transform.js +29 -0
- package/lib/prompts/api/transform.js.map +1 -0
- package/lib/prompts/api/validate.d.ts +12 -0
- package/lib/prompts/api/validate.js +40 -0
- package/lib/prompts/api/validate.js.map +1 -0
- package/lib/prompts/auth/login.d.ts +10 -0
- package/lib/prompts/auth/login.js +22 -0
- package/lib/prompts/auth/login.js.map +1 -0
- package/lib/prompts/auth/logout.d.ts +3 -0
- package/lib/prompts/auth/logout.js +7 -0
- package/lib/prompts/auth/logout.js.map +1 -0
- package/lib/prompts/auth/status.d.ts +8 -0
- package/lib/prompts/auth/status.js +22 -0
- package/lib/prompts/auth/status.js.map +1 -0
- package/lib/prompts/format.d.ts +31 -0
- package/lib/prompts/format.js +89 -0
- package/lib/prompts/format.js.map +1 -0
- package/lib/prompts/portal/copilot.d.ts +18 -0
- package/lib/prompts/portal/copilot.js +82 -0
- package/lib/prompts/portal/copilot.js.map +1 -0
- package/lib/prompts/portal/generate.d.ts +13 -8
- package/lib/prompts/portal/generate.js +36 -53
- package/lib/prompts/portal/generate.js.map +1 -0
- package/lib/prompts/portal/quickstart.d.ts +28 -29
- package/lib/prompts/portal/quickstart.js +102 -185
- package/lib/prompts/portal/quickstart.js.map +1 -0
- package/lib/prompts/portal/recipe/new-recipe.d.ts +29 -0
- package/lib/prompts/portal/recipe/new-recipe.js +165 -0
- package/lib/prompts/portal/recipe/new-recipe.js.map +1 -0
- package/lib/prompts/portal/serve.d.ts +9 -5
- package/lib/prompts/portal/serve.js +29 -19
- package/lib/prompts/portal/serve.js.map +1 -0
- package/lib/prompts/portal/toc/new-toc.d.ts +15 -0
- package/lib/prompts/portal/toc/new-toc.js +38 -0
- package/lib/prompts/portal/toc/new-toc.js.map +1 -0
- package/lib/prompts/prompt.d.ts +3 -0
- package/lib/prompts/prompt.js +37 -0
- package/lib/prompts/prompt.js.map +1 -0
- package/lib/prompts/quickstart.d.ts +6 -0
- package/lib/prompts/quickstart.js +25 -0
- package/lib/prompts/quickstart.js.map +1 -0
- package/lib/prompts/sdk/generate.d.ts +11 -0
- package/lib/prompts/sdk/generate.js +37 -0
- package/lib/prompts/sdk/generate.js.map +1 -0
- package/lib/prompts/sdk/quickstart.d.ts +32 -0
- package/lib/prompts/sdk/quickstart.js +140 -0
- package/lib/prompts/sdk/quickstart.js.map +1 -0
- package/lib/types/api/account.d.ts +10 -0
- package/lib/types/api/account.js +2 -0
- package/lib/types/api/account.js.map +1 -0
- package/lib/types/api/transform.d.ts +14 -25
- package/lib/types/api/transform.js +20 -23
- package/lib/types/api/transform.js.map +1 -0
- package/lib/types/build/build.d.ts +22 -0
- package/lib/types/build/build.js +7 -0
- package/lib/types/build/build.js.map +1 -0
- package/lib/types/build-context.d.ts +13 -0
- package/lib/types/build-context.js +33 -0
- package/lib/types/build-context.js.map +1 -0
- package/lib/types/common/command-metadata.d.ts +4 -0
- package/lib/types/common/command-metadata.js +2 -0
- package/lib/types/common/command-metadata.js.map +1 -0
- package/lib/types/events/domain-event.d.ts +8 -0
- package/lib/types/events/domain-event.js +11 -0
- package/lib/types/events/domain-event.js.map +1 -0
- package/lib/types/events/quickstart-completed.d.ts +7 -0
- package/lib/types/events/quickstart-completed.js +10 -0
- package/lib/types/events/quickstart-completed.js.map +1 -0
- package/lib/types/events/quickstart-initiated.d.ts +7 -0
- package/lib/types/events/quickstart-initiated.js +10 -0
- package/lib/types/events/quickstart-initiated.js.map +1 -0
- package/lib/types/events/recipe-creation-failed.d.ts +5 -0
- package/lib/types/events/recipe-creation-failed.js +8 -0
- package/lib/types/events/recipe-creation-failed.js.map +1 -0
- package/lib/types/events/toc-creation-failed.d.ts +5 -0
- package/lib/types/events/toc-creation-failed.js +8 -0
- package/lib/types/events/toc-creation-failed.js.map +1 -0
- package/lib/types/file/directory.d.ts +17 -0
- package/lib/types/file/directory.js +87 -0
- package/lib/types/file/directory.js.map +1 -0
- package/lib/types/file/directoryPath.d.ts +10 -0
- package/lib/types/file/directoryPath.js +26 -0
- package/lib/types/file/directoryPath.js.map +1 -0
- package/lib/types/file/fileName.d.ts +7 -0
- package/lib/types/file/fileName.js +21 -0
- package/lib/types/file/fileName.js.map +1 -0
- package/lib/types/file/filePath.d.ts +10 -0
- package/lib/types/file/filePath.js +32 -0
- package/lib/types/file/filePath.js.map +1 -0
- package/lib/types/file/resource-input.d.ts +5 -0
- package/lib/types/file/resource-input.js +42 -0
- package/lib/types/file/resource-input.js.map +1 -0
- package/lib/types/file/urlPath.d.ts +6 -0
- package/lib/types/file/urlPath.js +22 -0
- package/lib/types/file/urlPath.js.map +1 -0
- package/lib/types/flags-provider.d.ts +15 -0
- package/lib/types/flags-provider.js +34 -0
- package/lib/types/flags-provider.js.map +1 -0
- package/lib/types/portal-context.d.ts +13 -0
- package/lib/types/portal-context.js +38 -0
- package/lib/types/portal-context.js.map +1 -0
- package/lib/types/recipe/recipe.d.ts +22 -0
- package/lib/types/recipe/recipe.js +6 -0
- package/lib/types/recipe/recipe.js.map +1 -0
- package/lib/types/recipe-context.d.ts +9 -0
- package/lib/types/recipe-context.js +26 -0
- package/lib/types/recipe-context.js.map +1 -0
- package/lib/types/resource-context.d.ts +12 -0
- package/lib/types/resource-context.js +30 -0
- package/lib/types/resource-context.js.map +1 -0
- package/lib/types/sdk/generate.d.ts +9 -22
- package/lib/types/sdk/generate.js +25 -14
- package/lib/types/sdk/generate.js.map +1 -0
- package/lib/types/sdk-context.d.ts +14 -0
- package/lib/types/sdk-context.js +32 -0
- package/lib/types/sdk-context.js.map +1 -0
- package/lib/types/sdl/sdl.d.ts +10 -0
- package/lib/types/sdl/sdl.js +47 -3
- package/lib/types/sdl/sdl.js.map +1 -0
- package/lib/types/spec-context.d.ts +12 -0
- package/lib/types/spec-context.js +29 -0
- package/lib/types/spec-context.js.map +1 -0
- package/lib/types/temp-context.d.ts +11 -0
- package/lib/types/temp-context.js +27 -0
- package/lib/types/temp-context.js.map +1 -0
- package/lib/types/toc/toc.js +2 -10
- package/lib/types/toc/toc.js.map +1 -0
- package/lib/types/toc-context.d.ts +12 -0
- package/lib/types/toc-context.js +26 -0
- package/lib/types/toc-context.js.map +1 -0
- package/lib/types/transform-context.d.ts +13 -0
- package/lib/types/transform-context.js +30 -0
- package/lib/types/transform-context.js.map +1 -0
- package/lib/types/utils.d.ts +0 -9
- package/lib/types/utils.js +2 -3
- package/lib/types/utils.js.map +1 -0
- package/lib/utils/string-utils.d.ts +2 -0
- package/lib/utils/string-utils.js +37 -0
- package/lib/utils/string-utils.js.map +1 -0
- package/lib/utils/utils.d.ts +2 -44
- package/lib/utils/utils.js +14 -366
- package/lib/utils/utils.js.map +1 -0
- package/package.json +50 -31
- package/bin/run +0 -9
- package/lib/actions/portal/new/toc.d.ts +0 -17
- package/lib/actions/portal/new/toc.js +0 -134
- package/lib/application/portal/new/toc/sdl-parser.d.ts +0 -13
- package/lib/application/portal/new/toc/sdl-parser.js +0 -53
- package/lib/application/portal/new/toc/toc-content-parser.js +0 -46
- package/lib/application/portal/new/toc/toc-structure-generator.js +0 -88
- package/lib/client-utils/sdk-client.d.ts +0 -23
- package/lib/client-utils/sdk-client.js +0 -124
- package/lib/commands/portal/new/toc.d.ts +0 -15
- package/lib/commands/portal/new/toc.js +0 -65
- package/lib/commands/portal/quickstart.d.ts +0 -10
- package/lib/commands/portal/quickstart.js +0 -79
- package/lib/config/env.d.ts +0 -27
- package/lib/config/env.js +0 -31
- package/lib/controllers/api/transform.d.ts +0 -5
- package/lib/controllers/api/transform.js +0 -56
- package/lib/controllers/api/validate.d.ts +0 -3
- package/lib/controllers/api/validate.js +0 -33
- package/lib/controllers/portal/generate.d.ts +0 -3
- package/lib/controllers/portal/generate.js +0 -110
- package/lib/controllers/portal/quickstart.d.ts +0 -14
- package/lib/controllers/portal/quickstart.js +0 -258
- package/lib/controllers/portal/serve.d.ts +0 -3
- package/lib/controllers/portal/serve.js +0 -138
- package/lib/controllers/sdk/generate.d.ts +0 -4
- package/lib/controllers/sdk/generate.js +0 -66
- package/lib/prompts/portal/new/toc.d.ts +0 -10
- package/lib/prompts/portal/new/toc.js +0 -46
- package/lib/services/portal/server.d.ts +0 -14
- package/lib/services/portal/server.js +0 -101
- package/lib/types/api/validate.d.ts +0 -12
- package/lib/types/api/validate.js +0 -3
- package/lib/types/common/result.d.ts +0 -17
- package/lib/types/common/result.js +0 -36
- package/lib/types/portal/generate.d.ts +0 -26
- package/lib/types/portal/generate.js +0 -4
- package/lib/types/portal/quickstart.d.ts +0 -17
- package/lib/types/portal/quickstart.js +0 -3
- package/lib/validators/common/directoryValidator.d.ts +0 -9
- package/lib/validators/common/directoryValidator.js +0 -53
- package/lib/validators/common/portValidator.d.ts +0 -5
- package/lib/validators/common/portValidator.js +0 -20
- package/lib/validators/portal/serveValidator.d.ts +0 -6
- package/lib/validators/portal/serveValidator.js +0 -21
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import * as path from "path";
|
|
2
|
+
import * as fs from "fs/promises";
|
|
3
|
+
export class TocContentParser {
|
|
4
|
+
async parseContentFolder(contentFolderPath, workingDirectory) {
|
|
5
|
+
const items = await fs.readdir(contentFolderPath);
|
|
6
|
+
const contentItems = [];
|
|
7
|
+
for (const item of items) {
|
|
8
|
+
const itemPath = path.join(contentFolderPath, item);
|
|
9
|
+
const stats = await fs.stat(itemPath);
|
|
10
|
+
if (stats.isDirectory()) {
|
|
11
|
+
const subItems = await this.parseContentFolder(itemPath, workingDirectory);
|
|
12
|
+
if (subItems.length > 0) {
|
|
13
|
+
contentItems.push({
|
|
14
|
+
group: item,
|
|
15
|
+
items: subItems[0].items // Take items from the Custom Content group
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
else if (stats.isFile() && item.endsWith(".md")) {
|
|
20
|
+
const relativePath = path.relative(workingDirectory, itemPath);
|
|
21
|
+
const pageName = path.basename(item, ".md");
|
|
22
|
+
contentItems.push({
|
|
23
|
+
page: pageName,
|
|
24
|
+
file: this.normalizePath(relativePath)
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
// Return empty array if no markdown files were found
|
|
29
|
+
if (contentItems.length === 0) {
|
|
30
|
+
return [];
|
|
31
|
+
}
|
|
32
|
+
// Wrap everything under a "Custom Content" group
|
|
33
|
+
return [
|
|
34
|
+
{
|
|
35
|
+
group: "Custom Content",
|
|
36
|
+
items: contentItems
|
|
37
|
+
}
|
|
38
|
+
];
|
|
39
|
+
}
|
|
40
|
+
normalizePath(path) {
|
|
41
|
+
return path.replace(/\\/g, "/");
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=toc-content-parser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"toc-content-parser.js","sourceRoot":"","sources":["../../../../src/application/portal/toc/toc-content-parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAGlC,MAAM,OAAO,gBAAgB;IAC3B,KAAK,CAAC,kBAAkB,CAAC,iBAAyB,EAAE,gBAAwB;QAC1E,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAClD,MAAM,YAAY,GAAiC,EAAE,CAAC;QAEtD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;YACpD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEtC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;gBAC3E,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxB,YAAY,CAAC,IAAI,CAAC;wBAChB,KAAK,EAAE,IAAI;wBACX,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,2CAA2C;qBACrE,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;gBAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAE5C,YAAY,CAAC,IAAI,CAAC;oBAChB,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;iBACvC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,iDAAiD;QACjD,OAAO;YACL;gBACE,KAAK,EAAE,gBAAgB;gBACvB,KAAK,EAAE,YAAY;aACpB;SACF,CAAC;IACJ,CAAC;IAEO,aAAa,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAClC,CAAC;CACF"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Toc, TocGroup, TocEndpoint, TocModel } from "
|
|
1
|
+
import { Toc, TocGroup, TocEndpoint, TocModel } from "../../../types/toc/toc.js";
|
|
2
2
|
export declare class TocStructureGenerator {
|
|
3
3
|
createTocStructure(endpointGroups: Map<string, TocEndpoint[]>, models: TocModel[], expandEndpoints?: boolean, expandModels?: boolean, contentGroups?: TocGroup[]): Toc;
|
|
4
4
|
transformToYaml(toc: Toc): string;
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { stringify } from "yaml";
|
|
2
|
+
export class TocStructureGenerator {
|
|
3
|
+
createTocStructure(endpointGroups, models, expandEndpoints = false, expandModels = false, contentGroups = []) {
|
|
4
|
+
const tocStructure = {
|
|
5
|
+
toc: []
|
|
6
|
+
};
|
|
7
|
+
// Add Getting Started section
|
|
8
|
+
tocStructure.toc.push({
|
|
9
|
+
group: "Getting Started",
|
|
10
|
+
items: [
|
|
11
|
+
{
|
|
12
|
+
generate: "How to Get Started",
|
|
13
|
+
from: "getting-started"
|
|
14
|
+
}
|
|
15
|
+
]
|
|
16
|
+
});
|
|
17
|
+
// Add content groups
|
|
18
|
+
if (contentGroups.length > 0) {
|
|
19
|
+
tocStructure.toc.push(...contentGroups);
|
|
20
|
+
}
|
|
21
|
+
// Add API Endpoints section
|
|
22
|
+
if (!expandEndpoints || endpointGroups.size === 0) {
|
|
23
|
+
tocStructure.toc.push({
|
|
24
|
+
generate: "API Endpoints",
|
|
25
|
+
from: "endpoints"
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
else {
|
|
29
|
+
tocStructure.toc.push({
|
|
30
|
+
group: "API Endpoints",
|
|
31
|
+
items: Array.from(endpointGroups).map(([groupName, endpoints]) => ({
|
|
32
|
+
group: groupName,
|
|
33
|
+
items: [
|
|
34
|
+
{
|
|
35
|
+
generate: null,
|
|
36
|
+
from: "endpoint-group-overview",
|
|
37
|
+
endpointGroup: groupName
|
|
38
|
+
},
|
|
39
|
+
...endpoints
|
|
40
|
+
]
|
|
41
|
+
}))
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
// Add Models section
|
|
45
|
+
if (!expandModels || models.length === 0) {
|
|
46
|
+
tocStructure.toc.push({
|
|
47
|
+
generate: "Models",
|
|
48
|
+
from: "models"
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
else {
|
|
52
|
+
tocStructure.toc.push({
|
|
53
|
+
group: "Models",
|
|
54
|
+
items: models
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
//Add Sdk Infra section
|
|
58
|
+
tocStructure.toc.push({
|
|
59
|
+
generate: "SDK Infrastructure",
|
|
60
|
+
from: "sdk-infra"
|
|
61
|
+
});
|
|
62
|
+
return tocStructure;
|
|
63
|
+
}
|
|
64
|
+
transformToYaml(toc) {
|
|
65
|
+
const transformedToc = this.transformKeys(toc);
|
|
66
|
+
return stringify(transformedToc, {
|
|
67
|
+
indent: 2,
|
|
68
|
+
nullStr: ""
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
transformKeys(obj) {
|
|
72
|
+
if (Array.isArray(obj)) {
|
|
73
|
+
return obj.map((item) => this.transformKeys(item));
|
|
74
|
+
}
|
|
75
|
+
if (obj !== null && typeof obj === "object") {
|
|
76
|
+
return Object.fromEntries(Object.entries(obj).map(([key, value]) => [
|
|
77
|
+
key.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase(),
|
|
78
|
+
this.transformKeys(value)
|
|
79
|
+
]));
|
|
80
|
+
}
|
|
81
|
+
return obj;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
//# sourceMappingURL=toc-structure-generator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"toc-structure-generator.js","sourceRoot":"","sources":["../../../../src/application/portal/toc/toc-structure-generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAGjC,MAAM,OAAO,qBAAqB;IAChC,kBAAkB,CAChB,cAA0C,EAC1C,MAAkB,EAClB,kBAA2B,KAAK,EAChC,eAAwB,KAAK,EAC7B,gBAA4B,EAAE;QAE9B,MAAM,YAAY,GAAQ;YACxB,GAAG,EAAE,EAAE;SACR,CAAC;QAEF,8BAA8B;QAC9B,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;YACpB,KAAK,EAAE,iBAAiB;YACxB,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,oBAAoB;oBAC9B,IAAI,EAAE,iBAAiB;iBACxB;aACF;SACF,CAAC,CAAC;QAEH,qBAAqB;QACrB,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAC1C,CAAC;QAED,4BAA4B;QAC5B,IAAI,CAAC,eAAe,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAClD,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;gBACpB,QAAQ,EAAE,eAAe;gBACzB,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,eAAe;gBACtB,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;oBACjE,KAAK,EAAE,SAAS;oBAChB,KAAK,EAAE;wBACL;4BACE,QAAQ,EAAE,IAAI;4BACd,IAAI,EAAE,yBAAyB;4BAC/B,aAAa,EAAE,SAAS;yBACG;wBAC7B,GAAG,SAAS;qBACb;iBACF,CAAC,CAAC;aACJ,CAAC,CAAC;QACL,CAAC;QAED,qBAAqB;QACrB,IAAI,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;gBACpB,QAAQ,EAAE,QAAQ;gBAClB,IAAI,EAAE,QAAQ;aACf,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,MAAM;aACd,CAAC,CAAC;QACL,CAAC;QAED,uBAAuB;QACvB,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;YACpB,QAAQ,EAAE,oBAAoB;YAC9B,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAQ;QACtB,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC/C,OAAO,SAAS,CAAC,cAAc,EAAE;YAC/B,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC;IACL,CAAC;IAEO,aAAa,CAAC,GAAQ;QAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;gBACxC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE;gBACxD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;aAC1B,CAAC,CACH,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
import { DirectoryPath } from "../types/file/directoryPath.js";
|
|
1
2
|
export type AuthInfo = {
|
|
2
3
|
email: string;
|
|
3
4
|
authKey: string;
|
|
5
|
+
APIMATIC_CLI_TELEMETRY_OPTOUT?: string;
|
|
4
6
|
};
|
|
5
7
|
/**
|
|
6
8
|
*
|
|
@@ -10,8 +12,11 @@ export type AuthInfo = {
|
|
|
10
12
|
export declare function getAuthInfo(configDir: string): Promise<AuthInfo | null>;
|
|
11
13
|
/**
|
|
12
14
|
*
|
|
13
|
-
* @param {
|
|
15
|
+
* @param {string} email
|
|
16
|
+
* @param {string} authKey
|
|
17
|
+
* @param {string} isTelemetryOptedOut
|
|
14
18
|
* @param {string} configDir <- Directory with user configuration
|
|
15
19
|
* //Function to set credentials.
|
|
16
20
|
*/
|
|
17
|
-
export declare function setAuthInfo(
|
|
21
|
+
export declare function setAuthInfo(email: string, authKey: string, isTelemetryOptedOut: boolean, configDir: DirectoryPath): Promise<void>;
|
|
22
|
+
export declare function removeAuthInfo(configDir: DirectoryPath): Promise<void>;
|
|
@@ -1,33 +1,45 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
exports.getAuthInfo = getAuthInfo;
|
|
4
|
-
exports.setAuthInfo = setAuthInfo;
|
|
5
|
-
const path = require("path");
|
|
6
|
-
const fs = require("fs-extra");
|
|
1
|
+
import * as path from "path";
|
|
2
|
+
import fs from "fs-extra";
|
|
7
3
|
/**
|
|
8
4
|
*
|
|
9
5
|
* @param {string} configDir <- Directory with user configuration
|
|
10
6
|
* //Function to get credentials
|
|
11
7
|
*/
|
|
12
|
-
async function getAuthInfo(configDir) {
|
|
8
|
+
export async function getAuthInfo(configDir) {
|
|
13
9
|
try {
|
|
14
|
-
|
|
15
|
-
return data;
|
|
10
|
+
return JSON.parse(await fs.readFile(path.join(configDir, "config.json"), "utf8"));
|
|
16
11
|
}
|
|
17
|
-
catch (
|
|
12
|
+
catch (_a) {
|
|
18
13
|
return null;
|
|
19
14
|
}
|
|
20
15
|
}
|
|
21
16
|
/**
|
|
22
17
|
*
|
|
23
|
-
* @param {
|
|
18
|
+
* @param {string} email
|
|
19
|
+
* @param {string} authKey
|
|
20
|
+
* @param {string} isTelemetryOptedOut
|
|
24
21
|
* @param {string} configDir <- Directory with user configuration
|
|
25
22
|
* //Function to set credentials.
|
|
26
23
|
*/
|
|
27
|
-
async function setAuthInfo(
|
|
28
|
-
const
|
|
24
|
+
export async function setAuthInfo(email, authKey, isTelemetryOptedOut, configDir) {
|
|
25
|
+
const credentials = {
|
|
26
|
+
email,
|
|
27
|
+
authKey,
|
|
28
|
+
APIMATIC_CLI_TELEMETRY_OPTOUT: isTelemetryOptedOut ? "1" : "0"
|
|
29
|
+
};
|
|
30
|
+
const configFilePath = path.join(configDir.toString(), "config.json");
|
|
29
31
|
if (!fs.existsSync(configFilePath))
|
|
30
32
|
fs.createFileSync(configFilePath);
|
|
31
33
|
return await fs.writeFile(configFilePath, JSON.stringify(credentials));
|
|
32
34
|
}
|
|
33
|
-
|
|
35
|
+
export async function removeAuthInfo(configDir) {
|
|
36
|
+
const credentials = {
|
|
37
|
+
email: "",
|
|
38
|
+
authKey: ""
|
|
39
|
+
};
|
|
40
|
+
const configFilePath = path.join(configDir.toString(), "config.json");
|
|
41
|
+
if (!fs.existsSync(configFilePath))
|
|
42
|
+
fs.createFileSync(configFilePath);
|
|
43
|
+
return await fs.writeFile(configFilePath, JSON.stringify(credentials));
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=auth-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auth-manager.js","sourceRoot":"","sources":["../../src/client-utils/auth-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,UAAU,CAAC;AAQ1B;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,SAAiB;IACjD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACpF,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,KAAa,EACb,OAAe,EACf,mBAA4B,EAC5B,SAAwB;IAExB,MAAM,WAAW,GAAa;QAC5B,KAAK;QACL,OAAO;QACP,6BAA6B,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;KAC/D,CAAC;IACF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;IAEtE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QAAE,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAEtE,OAAO,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,SAAwB;IAC3D,MAAM,WAAW,GAAa;QAC5B,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;IAEtE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QAAE,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAEtE,OAAO,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;AACzE,CAAC"}
|
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
import { Command } from "@oclif/core";
|
|
2
2
|
export default class Transform extends Command {
|
|
3
|
-
static
|
|
3
|
+
static readonly summary = "Transform API specifications between different formats";
|
|
4
|
+
static readonly description = "Transform API specifications from one format to another.\nSupports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.";
|
|
5
|
+
static readonly cmdTxt: string;
|
|
4
6
|
static examples: string[];
|
|
5
7
|
static flags: {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
8
|
+
"auth-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
9
|
+
force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
10
|
+
format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
|
+
file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
|
+
url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
13
|
+
destination: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
14
|
};
|
|
13
15
|
run(): Promise<void>;
|
|
16
|
+
private readonly getConfigDir;
|
|
14
17
|
}
|
|
@@ -1,117 +1,57 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
1
|
+
import { Command, Flags } from "@oclif/core";
|
|
2
|
+
import { DirectoryPath } from "../../types/file/directoryPath.js";
|
|
3
|
+
import { FlagsProvider } from "../../types/flags-provider.js";
|
|
4
|
+
import { TransformAction } from "../../actions/api/transform.js";
|
|
5
|
+
import { format, intro, outro } from "../../prompts/format.js";
|
|
6
|
+
import { createResourceInput } from "../../types/file/resource-input.js";
|
|
7
|
+
import { TransformationFormats } from "../../types/api/transform.js";
|
|
8
|
+
import { ExportFormats } from "@apimatic/sdk";
|
|
9
|
+
class Transform extends Command {
|
|
10
|
+
constructor() {
|
|
11
|
+
super(...arguments);
|
|
12
|
+
this.getConfigDir = () => {
|
|
13
|
+
return new DirectoryPath(this.config.configDir);
|
|
14
|
+
};
|
|
15
|
+
}
|
|
15
16
|
async run() {
|
|
16
|
-
const { flags } = await this.parse(
|
|
17
|
-
const
|
|
18
|
-
const
|
|
19
|
-
const
|
|
20
|
-
//
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
|
|
33
|
-
const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
|
|
34
|
-
const transformationController = new sdk_1.TransformationController(client);
|
|
35
|
-
const { id, apiValidationSummary } = await (0, transform_2.getTransformationId)(flags, transformationController);
|
|
36
|
-
const logFunctions = {
|
|
37
|
-
log: (message) => this.log(message),
|
|
38
|
-
warn: (message) => this.warn(message),
|
|
39
|
-
error: (message) => this.error(message)
|
|
40
|
-
};
|
|
41
|
-
(0, utils_1.printValidationMessages)(apiValidationSummary, logFunctions);
|
|
42
|
-
const savedTransformationFile = await (0, transform_2.downloadTransformationFile)({
|
|
43
|
-
id,
|
|
44
|
-
destinationFilePath,
|
|
45
|
-
transformationController
|
|
46
|
-
});
|
|
47
|
-
this.log(`Success! Your transformed file is located at ${savedTransformationFile}`);
|
|
48
|
-
}
|
|
49
|
-
catch (error) {
|
|
50
|
-
if (error.result) {
|
|
51
|
-
const apiError = error;
|
|
52
|
-
// TODO: Hopefully, this type-cast won't be necessary when the SDK is
|
|
53
|
-
// updated to throw the right exception type for this status code.
|
|
54
|
-
const result = apiError.result;
|
|
55
|
-
if (apiError.statusCode === 422 && result && "errors" in result && Array.isArray(result.errors)) {
|
|
56
|
-
this.error((0, utils_2.replaceHTML)(`${result.errors}`));
|
|
57
|
-
}
|
|
58
|
-
else if (apiError.statusCode === 422 && apiError.body && typeof apiError.body === "string") {
|
|
59
|
-
this.error(JSON.parse(apiError.body)["dto.FileUrl"][0]);
|
|
60
|
-
}
|
|
61
|
-
else if (apiError.statusCode === 401 && apiError.body && typeof apiError.body === "string") {
|
|
62
|
-
this.error("You are not authorized to perform this action");
|
|
63
|
-
}
|
|
64
|
-
else if (apiError.statusCode === 500) {
|
|
65
|
-
this.error(apiError.message);
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
else if (error.statusCode === 401) {
|
|
69
|
-
this.error("You are not authorized to perform this action");
|
|
70
|
-
}
|
|
71
|
-
else if (error.statusCode === 402 &&
|
|
72
|
-
error.body &&
|
|
73
|
-
typeof error.body === "string") {
|
|
74
|
-
this.error(error.body);
|
|
75
|
-
}
|
|
76
|
-
else {
|
|
77
|
-
this.error(`${error.message}`);
|
|
78
|
-
}
|
|
79
|
-
}
|
|
17
|
+
const { flags: { format, file, url, destination, force, "auth-key": authKey } } = await this.parse(Transform);
|
|
18
|
+
const workingDirectory = DirectoryPath.createInput(destination);
|
|
19
|
+
const transformedApiDirectory = workingDirectory.join("transformations");
|
|
20
|
+
const specFile = createResourceInput(file, url);
|
|
21
|
+
// Directly map the format flag to ExportFormats using TransformationFormats
|
|
22
|
+
const key = format;
|
|
23
|
+
const transformationFormat = TransformationFormats[key];
|
|
24
|
+
const parsedFormat = ExportFormats[transformationFormat];
|
|
25
|
+
const commandMetadata = {
|
|
26
|
+
commandName: Transform.id,
|
|
27
|
+
shell: this.config.shell
|
|
28
|
+
};
|
|
29
|
+
intro("Transform API");
|
|
30
|
+
const action = new TransformAction(this.getConfigDir(), commandMetadata, authKey);
|
|
31
|
+
const result = await action.execute(specFile, parsedFormat, transformedApiDirectory, force);
|
|
32
|
+
outro(result);
|
|
80
33
|
}
|
|
81
34
|
}
|
|
82
|
-
|
|
83
|
-
Transform.description = `Transform API specifications from one format to another.
|
|
35
|
+
Transform.summary = "Transform API specifications between different formats";
|
|
36
|
+
Transform.description = `Transform API specifications from one format to another.
|
|
37
|
+
Supports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.`;
|
|
38
|
+
Transform.cmdTxt = format.cmd("apimatic", "api", "transform");
|
|
84
39
|
Transform.examples = [
|
|
85
|
-
`$
|
|
86
|
-
|
|
87
|
-
`,
|
|
88
|
-
`$ apimatic api:transform --format=RAML --url="https://petstore.swagger.io/v2/swagger.json" --destination="D:/"
|
|
89
|
-
Success! Your transformed file is located at D:/swagger_raml.yaml
|
|
90
|
-
`
|
|
40
|
+
`${Transform.cmdTxt} ${format.flag("format", "openapi3yaml")} ${format.flag("file", "./specs/sample.json")} ${format.flag("destination", "./")}`,
|
|
41
|
+
`${Transform.cmdTxt} ${format.flag("format", "raml")} ${format.flag("url", '"https://petstore.swagger.io/v2/swagger.json"')} ${format.flag("destination", "./")}`
|
|
91
42
|
];
|
|
92
|
-
Transform.flags = {
|
|
93
|
-
format: core_1.Flags.string({
|
|
94
|
-
parse: async (format) => (0, transform_2.getValidFormat)(format),
|
|
43
|
+
Transform.flags = Object.assign(Object.assign({ format: Flags.string({
|
|
95
44
|
required: true,
|
|
96
|
-
description:
|
|
97
|
-
|
|
98
|
-
}),
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
default: ""
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
parse: async (input) => path.resolve(input),
|
|
110
|
-
default: path.resolve("./"),
|
|
111
|
-
description: "directory to download transformed file to"
|
|
112
|
-
}),
|
|
113
|
-
force: core_1.Flags.boolean({ char: "f", default: false, description: "overwrite if same file exist in the destination" }),
|
|
114
|
-
"auth-key": core_1.Flags.string({ description: "override current authentication state with an authentication key" })
|
|
115
|
-
};
|
|
116
|
-
exports.default = Transform;
|
|
117
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhbnNmb3JtLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbW1hbmRzL2FwaS90cmFuc2Zvcm0udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsNkJBQTZCO0FBQzdCLCtCQUErQjtBQUUvQixzQ0FBNkM7QUFDN0MsdUNBQTBHO0FBRzFHLDhEQUEwRDtBQUMxRCw2Q0FBNEQ7QUFDNUQsNkNBQXFFO0FBQ3JFLHlEQUFzRjtBQUN0RiwrREFBa0g7QUFFbEgsTUFBTSxPQUFPLEdBQVcsTUFBTSxDQUFDLElBQUksQ0FBQyxpQ0FBcUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztBQUNyRSxNQUFxQixTQUFVLFNBQVEsY0FBTztJQXNDNUMsS0FBSyxDQUFDLEdBQUc7UUFDUCxNQUFNLEVBQUUsS0FBSyxFQUFFLEdBQUcsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLEVBQVMsQ0FBQyxDQUFDO1FBQzlDLE1BQU0sUUFBUSxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLElBQUEsMkJBQW1CLEVBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFBLDJCQUFtQixFQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUMvRixNQUFNLGlCQUFpQixHQUFXLDhCQUFrQixDQUFDLEtBQUssQ0FBQyxNQUF5QyxDQUFDLENBQUM7UUFDdEcsTUFBTSxtQkFBbUIsR0FBVyxJQUFJLENBQUMsSUFBSSxDQUMzQyxLQUFLLENBQUMsV0FBVyxFQUNqQixHQUFHLFFBQVEsSUFBSSxLQUFLLENBQUMsTUFBTSxJQUFJLGlCQUFpQixFQUFFLENBQUMsV0FBVyxFQUFFLENBQ2pFLENBQUM7UUFFRixtRkFBbUY7UUFDbkYsSUFBSSxFQUFFLENBQUMsVUFBVSxDQUFDLG1CQUFtQixDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxFQUFFLENBQUM7WUFDdkQsTUFBTSxJQUFJLEtBQUssQ0FBQywyQ0FBMkMsbUJBQW1CLDZCQUE2QixDQUFDLENBQUM7UUFDL0csQ0FBQztRQUVELElBQUksQ0FBQztZQUNILG9DQUFvQztZQUNwQyxJQUFJLEtBQUssQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDO2dCQUNyRCxNQUFNLElBQUksS0FBSyxDQUFDLHdCQUF3QixLQUFLLENBQUMsSUFBSSxpQkFBaUIsQ0FBQyxDQUFDO1lBQ3ZFLENBQUM7aUJBQU0sSUFBSSxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQyxFQUFFLENBQUM7Z0JBQ3JELE1BQU0sSUFBSSxLQUFLLENBQUMscUJBQXFCLEtBQUssQ0FBQyxXQUFXLGlCQUFpQixDQUFDLENBQUM7WUFDM0UsQ0FBQztZQUNELE1BQU0sZUFBZSxHQUFHLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFDckUsTUFBTSxNQUFNLEdBQVcsTUFBTSxzQkFBUyxDQUFDLFdBQVcsRUFBRSxDQUFDLFNBQVMsQ0FBQyxlQUFlLEVBQUUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxTQUFTLENBQUMsQ0FBQztZQUN2RyxNQUFNLHdCQUF3QixHQUE2QixJQUFJLDhCQUF3QixDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBRWhHLE1BQU0sRUFBRSxFQUFFLEVBQUUsb0JBQW9CLEVBQUUsR0FBbUIsTUFBTSxJQUFBLCtCQUFtQixFQUFDLEtBQUssRUFBRSx3QkFBd0IsQ0FBQyxDQUFDO1lBRWhILE1BQU0sWUFBWSxHQUFZO2dCQUM1QixHQUFHLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDO2dCQUNuQyxJQUFJLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO2dCQUNyQyxLQUFLLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDO2FBQ3hDLENBQUM7WUFDRixJQUFBLCtCQUF1QixFQUFDLG9CQUFvQixFQUFFLFlBQVksQ0FBQyxDQUFDO1lBRTVELE1BQU0sdUJBQXVCLEdBQVcsTUFBTSxJQUFBLHNDQUEwQixFQUFDO2dCQUN2RSxFQUFFO2dCQUNGLG1CQUFtQjtnQkFDbkIsd0JBQXdCO2FBQ3pCLENBQUMsQ0FBQztZQUNILElBQUksQ0FBQyxHQUFHLENBQUMsZ0RBQWdELHVCQUF1QixFQUFFLENBQUMsQ0FBQztRQUN0RixDQUFDO1FBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztZQUNmLElBQUssS0FBa0IsQ0FBQyxNQUFNLEVBQUUsQ0FBQztnQkFDL0IsTUFBTSxRQUFRLEdBQUcsS0FBaUIsQ0FBQztnQkFFbkMscUVBQXFFO2dCQUNyRSxrRUFBa0U7Z0JBQ2xFLE1BQU0sTUFBTSxHQUFHLFFBQVEsQ0FBQyxNQUE2QyxDQUFDO2dCQUN0RSxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxJQUFJLE1BQU0sSUFBSSxRQUFRLElBQUksTUFBTSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7b0JBQ2hHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBQSxtQkFBVyxFQUFDLEdBQUcsTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztnQkFDOUMsQ0FBQztxQkFBTSxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxJQUFJLFFBQVEsQ0FBQyxJQUFJLElBQUksT0FBTyxRQUFRLENBQUMsSUFBSSxLQUFLLFFBQVEsRUFBRSxDQUFDO29CQUM3RixJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzFELENBQUM7cUJBQU0sSUFBSSxRQUFRLENBQUMsVUFBVSxLQUFLLEdBQUcsSUFBSSxRQUFRLENBQUMsSUFBSSxJQUFJLE9BQU8sUUFBUSxDQUFDLElBQUksS0FBSyxRQUFRLEVBQUUsQ0FBQztvQkFDN0YsSUFBSSxDQUFDLEtBQUssQ0FBQywrQ0FBK0MsQ0FBQyxDQUFDO2dCQUM5RCxDQUFDO3FCQUFNLElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxHQUFHLEVBQUUsQ0FBQztvQkFDdkMsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7Z0JBQy9CLENBQUM7WUFDSCxDQUFDO2lCQUFNLElBQUssS0FBNkIsQ0FBQyxVQUFVLEtBQUssR0FBRyxFQUFFLENBQUM7Z0JBQzdELElBQUksQ0FBQyxLQUFLLENBQUMsK0NBQStDLENBQUMsQ0FBQztZQUM5RCxDQUFDO2lCQUFNLElBQ0osS0FBNkIsQ0FBQyxVQUFVLEtBQUssR0FBRztnQkFDaEQsS0FBNkIsQ0FBQyxJQUFJO2dCQUNuQyxPQUFRLEtBQTZCLENBQUMsSUFBSSxLQUFLLFFBQVEsRUFDdkQsQ0FBQztnQkFDRCxJQUFJLENBQUMsS0FBSyxDQUFFLEtBQTZCLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDbEQsQ0FBQztpQkFBTSxDQUFDO2dCQUNOLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBSSxLQUFlLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztZQUM1QyxDQUFDO1FBQ0gsQ0FBQztJQUNILENBQUM7OztBQXpHTSxxQkFBVyxHQUFHLGtOQUFrTixBQUFyTixDQUFzTjtBQUVqTyxrQkFBUSxHQUFHO0lBQ2hCOztDQUVIO0lBQ0c7O0NBRUg7Q0FDRSxBQVBjLENBT2I7QUFFSyxlQUFLLEdBQUc7SUFDYixNQUFNLEVBQUUsWUFBSyxDQUFDLE1BQU0sQ0FBQztRQUNuQixLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQWMsRUFBRSxFQUFFLENBQUMsSUFBQSwwQkFBYyxFQUFDLE1BQU0sQ0FBQztRQUN2RCxRQUFRLEVBQUUsSUFBSTtRQUNkLFdBQVcsRUFBRTtFQUNqQixPQUFPLEVBQUU7S0FDTixDQUFDO0lBQ0YsSUFBSSxFQUFFLFlBQUssQ0FBQyxNQUFNLENBQUM7UUFDakIsS0FBSyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDO1FBQzNDLE9BQU8sRUFBRSxFQUFFO1FBQ1gsV0FBVyxFQUFFLGlEQUFpRDtLQUMvRCxDQUFDO0lBQ0YsR0FBRyxFQUFFLFlBQUssQ0FBQyxNQUFNLENBQUM7UUFDaEIsT0FBTyxFQUFFLEVBQUU7UUFDWCxXQUFXLEVBQ1QsMklBQTJJO0tBQzlJLENBQUM7SUFDRixXQUFXLEVBQUUsWUFBSyxDQUFDLE1BQU0sQ0FBQztRQUN4QixLQUFLLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUM7UUFDM0MsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1FBQzNCLFdBQVcsRUFBRSwyQ0FBMkM7S0FDekQsQ0FBQztJQUNGLEtBQUssRUFBRSxZQUFLLENBQUMsT0FBTyxDQUFDLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFdBQVcsRUFBRSxpREFBaUQsRUFBRSxDQUFDO0lBQ25ILFVBQVUsRUFBRSxZQUFLLENBQUMsTUFBTSxDQUFDLEVBQUUsV0FBVyxFQUFFLGtFQUFrRSxFQUFFLENBQUM7Q0FDOUcsQUF4QlcsQ0F3QlY7a0JBcENpQixTQUFTIn0=
|
|
45
|
+
description: "Specification format to transform API specification into",
|
|
46
|
+
options: Object.keys(TransformationFormats)
|
|
47
|
+
}), file: Flags.string({
|
|
48
|
+
description: "Path to the API specification file to transform"
|
|
49
|
+
}), url: Flags.string({
|
|
50
|
+
description: "URL to the API specification file to transform (publicly accessible)"
|
|
51
|
+
}), destination: Flags.string({
|
|
52
|
+
char: "d",
|
|
53
|
+
description: "Directory to save the transformed file to",
|
|
54
|
+
default: "./"
|
|
55
|
+
}) }, FlagsProvider.force), FlagsProvider.authKey);
|
|
56
|
+
export default Transform;
|
|
57
|
+
//# sourceMappingURL=transform.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../src/commands/api/transform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,MAAqB,SAAU,SAAQ,OAAO;IAA9C;;QAgEmB,iBAAY,GAAG,GAAG,EAAE;YACnC,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC,CAAC;IACJ,CAAC;IA3BC,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,EACtE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,gBAAgB,GAAG,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAChE,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,mBAAmB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChD,4EAA4E;QAC5E,MAAM,GAAG,GAAG,MAA4C,CAAC;QACzD,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,GAAG,CAA+B,CAAC;QACtF,MAAM,YAAY,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;QAEzD,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,SAAS,CAAC,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,KAAK,CAAC,eAAe,CAAC,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAClF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,EAAE,uBAAuB,EAAE,KAAK,CAAC,CAAC;QAC5F,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;;AA7De,iBAAO,GAAG,wDAAwD,AAA3D,CAA4D;AAEnE,qBAAW,GAAG;0FAC0D,AAD7D,CAC8D;AAEzE,gBAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC,AAA7C,CAA8C;AAE7D,kBAAQ,GAAG;IAChB,GAAG,SAAS,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,MAAM,CAAC,IAAI,CACzE,MAAM,EACN,qBAAqB,CACtB,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE;IACvC,GAAG,SAAS,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CACjE,KAAK,EACL,+CAA+C,CAChD,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE;CACxC,AATc,CASb;AAEK,eAAK,iCACV,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACnB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,0DAA0D;QACvE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC;KAC5C,CAAC,EACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;QACjB,WAAW,EAAE,iDAAiD;KAC/D,CAAC,EACF,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;QAChB,WAAW,EAAE,sEAAsE;KACpF,CAAC,EACF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;QACxB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,2CAA2C;QACxD,OAAO,EAAE,IAAI;KACd,CAAC,IACC,aAAa,CAAC,KAAK,GACnB,aAAa,CAAC,OAAO,CAlBd,CAmBV;eAtCiB,SAAS"}
|
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
import { Command } from "@oclif/core";
|
|
2
2
|
export default class Validate extends Command {
|
|
3
|
-
static
|
|
3
|
+
static readonly summary = "Validate API specification for syntactic and semantic correctness";
|
|
4
|
+
static readonly description = "Validate your API specification to ensure it adheres to syntactic and semantic standards.";
|
|
5
|
+
static readonly cmdTxt: string;
|
|
4
6
|
static examples: string[];
|
|
5
7
|
static flags: {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
"auth-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
9
|
+
file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
10
|
+
url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
9
11
|
};
|
|
10
12
|
run(): Promise<void>;
|
|
13
|
+
private readonly getConfigDir;
|
|
11
14
|
}
|
|
@@ -1,79 +1,36 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
import { Command, Flags } from "@oclif/core";
|
|
2
|
+
import { DirectoryPath } from "../../types/file/directoryPath.js";
|
|
3
|
+
import { FlagsProvider } from "../../types/flags-provider.js";
|
|
4
|
+
import { ValidateAction } from "../../actions/api/validate.js";
|
|
5
|
+
import { format, intro, outro } from "../../prompts/format.js";
|
|
6
|
+
import { createResourceInput } from "../../types/file/resource-input.js";
|
|
7
|
+
class Validate extends Command {
|
|
8
|
+
constructor() {
|
|
9
|
+
super(...arguments);
|
|
10
|
+
this.getConfigDir = () => {
|
|
11
|
+
return new DirectoryPath(this.config.configDir);
|
|
12
|
+
};
|
|
13
|
+
}
|
|
10
14
|
async run() {
|
|
11
|
-
const { flags } = await this.parse(Validate);
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
core_1.ux.action.stop();
|
|
22
|
-
const logFunctions = {
|
|
23
|
-
log: (message) => this.log(message),
|
|
24
|
-
warn: (message) => this.warn(message),
|
|
25
|
-
error: (message) => this.error(message)
|
|
26
|
-
};
|
|
27
|
-
(0, utils_1.printValidationMessages)(validationSummary, logFunctions);
|
|
28
|
-
validationSummary.success
|
|
29
|
-
? this.log("Specification file provided is valid")
|
|
30
|
-
: this.error("Specification file provided is invalid");
|
|
31
|
-
}
|
|
32
|
-
catch (error) {
|
|
33
|
-
if (error.result) {
|
|
34
|
-
const apiError = error;
|
|
35
|
-
const result = apiError.result;
|
|
36
|
-
if (result.modelState["exception Error"] && apiError.statusCode === 400) {
|
|
37
|
-
this.error((0, utils_1.replaceHTML)(result.modelState["exception Error"][0]));
|
|
38
|
-
}
|
|
39
|
-
else if (error.body && apiError.statusCode === 401) {
|
|
40
|
-
this.error("You are not authorized to perform this action");
|
|
41
|
-
}
|
|
42
|
-
else {
|
|
43
|
-
this.error(error.message);
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
else if (error.statusCode === 401) {
|
|
47
|
-
this.error("You are not authorized to perform this action");
|
|
48
|
-
}
|
|
49
|
-
else if (error.statusCode === 402 &&
|
|
50
|
-
error.body &&
|
|
51
|
-
typeof error.body === "string") {
|
|
52
|
-
this.error(error.body);
|
|
53
|
-
}
|
|
54
|
-
else {
|
|
55
|
-
this.error(`${error.message}`);
|
|
56
|
-
}
|
|
57
|
-
}
|
|
15
|
+
const { flags: { file, url, "auth-key": authKey } } = await this.parse(Validate);
|
|
16
|
+
const commandMetadata = {
|
|
17
|
+
commandName: Validate.id,
|
|
18
|
+
shell: this.config.shell
|
|
19
|
+
};
|
|
20
|
+
const action = new ValidateAction(this.getConfigDir(), commandMetadata, authKey);
|
|
21
|
+
const resourceInput = createResourceInput(file, url);
|
|
22
|
+
intro("Validate API");
|
|
23
|
+
const result = await action.execute(resourceInput);
|
|
24
|
+
outro(result);
|
|
58
25
|
}
|
|
59
26
|
}
|
|
60
|
-
Validate.
|
|
27
|
+
Validate.summary = "Validate API specification for syntactic and semantic correctness";
|
|
28
|
+
Validate.description = `Validate your API specification to ensure it adheres to syntactic and semantic standards.`;
|
|
29
|
+
Validate.cmdTxt = format.cmd("apimatic", "api", "validate");
|
|
61
30
|
Validate.examples = [
|
|
62
|
-
`$
|
|
63
|
-
|
|
64
|
-
`,
|
|
65
|
-
`$ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
|
|
66
|
-
Specification file provided is valid
|
|
67
|
-
`
|
|
31
|
+
`${Validate.cmdTxt} ${format.flag("file", "./specs/sample.json")}`,
|
|
32
|
+
`${Validate.cmdTxt} ${format.flag("url", '"https://petstore.swagger.io/v2/swagger.json"')}`
|
|
68
33
|
];
|
|
69
|
-
Validate.flags = {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
default: "",
|
|
73
|
-
description: "URL to the specification file to validate. Can be used in place of the --file option if the API specification is publicly available."
|
|
74
|
-
}),
|
|
75
|
-
// docs: flags.boolean({ default: false, description: "Validate specification for docs generation" }), // Next tier, not included in API spec
|
|
76
|
-
"auth-key": core_1.Flags.string({ description: "override current authentication state with an authentication key" })
|
|
77
|
-
};
|
|
78
|
-
exports.default = Validate;
|
|
79
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29tbWFuZHMvYXBpL3ZhbGlkYXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0JBQStCO0FBRS9CLHNDQUFpRDtBQUNqRCx1Q0FBNEc7QUFHNUcsOERBQTBEO0FBQzFELDZEQUFzRTtBQUN0RSw2Q0FBeUU7QUFHekUsTUFBcUIsUUFBUyxTQUFRLGNBQU87SUF1QjNDLEtBQUssQ0FBQyxHQUFHO1FBQ1AsTUFBTSxFQUFFLEtBQUssRUFBRSxHQUFHLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUU3QyxJQUFJLENBQUM7WUFDSCxJQUFJLEtBQUssQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDO2dCQUNyRCxNQUFNLElBQUksS0FBSyxDQUFDLG9CQUFvQixLQUFLLENBQUMsSUFBSSxpQkFBaUIsQ0FBQyxDQUFDO1lBQ25FLENBQUM7WUFDRCxNQUFNLGVBQWUsR0FBRyxLQUFLLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDO1lBQ3JFLE1BQU0sTUFBTSxHQUFXLE1BQU0sc0JBQVMsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxTQUFTLENBQUMsZUFBZSxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUM7WUFFdkcsTUFBTSx1QkFBdUIsR0FBd0MsSUFBSSx5Q0FBbUMsQ0FDMUcsTUFBTSxDQUNQLENBQUM7WUFFRixTQUFFLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQywrQkFBK0IsQ0FBQyxDQUFDO1lBQ2pELE1BQU0saUJBQWlCLEdBQXlCLE1BQU0sSUFBQSwrQkFBb0IsRUFBQyxLQUFLLEVBQUUsdUJBQXVCLENBQUMsQ0FBQztZQUMzRyxTQUFFLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDO1lBQ2pCLE1BQU0sWUFBWSxHQUFZO2dCQUM1QixHQUFHLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDO2dCQUNuQyxJQUFJLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO2dCQUNyQyxLQUFLLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDO2FBQ3hDLENBQUM7WUFDRixJQUFBLCtCQUF1QixFQUFDLGlCQUFpQixFQUFFLFlBQVksQ0FBQyxDQUFDO1lBRXpELGlCQUFpQixDQUFDLE9BQU87Z0JBQ3ZCLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLHNDQUFzQyxDQUFDO2dCQUNsRCxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFDO1FBQzNELENBQUM7UUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1lBQ2YsSUFBSyxLQUFrQixDQUFDLE1BQU0sRUFBRSxDQUFDO2dCQUMvQixNQUFNLFFBQVEsR0FBRyxLQUFpQixDQUFDO2dCQUNuQyxNQUFNLE1BQU0sR0FBRyxRQUFRLENBQUMsTUFBMEIsQ0FBQztnQkFDbkQsSUFBSSxNQUFNLENBQUMsVUFBVSxDQUFDLGlCQUFpQixDQUFDLElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxHQUFHLEVBQUUsQ0FBQztvQkFDeEUsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFBLG1CQUFXLEVBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztnQkFDbkUsQ0FBQztxQkFBTSxJQUFLLEtBQTRCLENBQUMsSUFBSSxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxFQUFFLENBQUM7b0JBQzdFLElBQUksQ0FBQyxLQUFLLENBQUMsK0NBQStDLENBQUMsQ0FBQztnQkFDOUQsQ0FBQztxQkFBTSxDQUFDO29CQUNOLElBQUksQ0FBQyxLQUFLLENBQUUsS0FBZSxDQUFDLE9BQU8sQ0FBQyxDQUFDO2dCQUN2QyxDQUFDO1lBQ0gsQ0FBQztpQkFBTSxJQUFLLEtBQTZCLENBQUMsVUFBVSxLQUFLLEdBQUcsRUFBRSxDQUFDO2dCQUM3RCxJQUFJLENBQUMsS0FBSyxDQUFDLCtDQUErQyxDQUFDLENBQUM7WUFDOUQsQ0FBQztpQkFBTSxJQUNKLEtBQTZCLENBQUMsVUFBVSxLQUFLLEdBQUc7Z0JBQ2hELEtBQTZCLENBQUMsSUFBSTtnQkFDbkMsT0FBUSxLQUE2QixDQUFDLElBQUksS0FBSyxRQUFRLEVBQ3ZELENBQUM7Z0JBQ0QsSUFBSSxDQUFDLEtBQUssQ0FBRSxLQUE2QixDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2xELENBQUM7aUJBQU0sQ0FBQztnQkFDTixJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUksS0FBZSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7WUFDNUMsQ0FBQztRQUNILENBQUM7SUFDSCxDQUFDOztBQXhFTSxvQkFBVyxHQUFHLHlFQUF5RSxDQUFDO0FBRXhGLGlCQUFRLEdBQUc7SUFDaEI7O0NBRUg7SUFDRzs7Q0FFSDtDQUNFLENBQUM7QUFFSyxjQUFLLEdBQUc7SUFDYixJQUFJLEVBQUUsWUFBSyxDQUFDLE1BQU0sQ0FBQyxFQUFFLE9BQU8sRUFBRSxFQUFFLEVBQUUsV0FBVyxFQUFFLGdEQUFnRCxFQUFFLENBQUM7SUFDbEcsR0FBRyxFQUFFLFlBQUssQ0FBQyxNQUFNLENBQUM7UUFDaEIsT0FBTyxFQUFFLEVBQUU7UUFDWCxXQUFXLEVBQ1Qsc0lBQXNJO0tBQ3pJLENBQUM7SUFDRiw2SUFBNkk7SUFDN0ksVUFBVSxFQUFFLFlBQUssQ0FBQyxNQUFNLENBQUMsRUFBRSxXQUFXLEVBQUUsa0VBQWtFLEVBQUUsQ0FBQztDQUM5RyxDQUFDO2tCQXJCaUIsUUFBUSJ9
|
|
34
|
+
Validate.flags = Object.assign({ file: Flags.string({ description: "Path to the API specification file to validate" }), url: Flags.string({ description: "URL to the API specification file to validate (publicly accessible)" }) }, FlagsProvider.authKey);
|
|
35
|
+
export default Validate;
|
|
36
|
+
//# sourceMappingURL=validate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../src/commands/api/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE/D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAEzE,MAAqB,QAAS,SAAQ,OAAO;IAA7C;;QAoCmB,iBAAY,GAAG,GAAG,EAAE;YACnC,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC,CAAC;IACJ,CAAC;IArBC,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,EAC1C,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE/B,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,QAAQ,CAAC,EAAE;YACxB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QACjF,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAErD,KAAK,CAAC,cAAc,CAAC,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACnD,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;;AAjCe,gBAAO,GAAG,mEAAmE,AAAtE,CAAuE;AAE9E,oBAAW,GAAG,2FAA2F,AAA9F,CAA+F;AAE1G,eAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,AAA5C,CAA6C;AAE5D,iBAAQ,GAAG;IAChB,GAAG,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,qBAAqB,CAAC,EAAE;IAClE,GAAG,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,+CAA+C,CAAC,EAAE;CAC5F,AAHc,CAGb;AAEK,cAAK,mBACV,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,gDAAgD,EAAE,CAAC,EACrF,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,qEAAqE,EAAE,CAAC,IACtG,aAAa,CAAC,OAAO,CAHd,CAIV;eAhBiB,QAAQ"}
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import { Command } from "@oclif/core";
|
|
2
2
|
export default class Login extends Command {
|
|
3
|
+
static summary: string;
|
|
3
4
|
static description: string;
|
|
5
|
+
private static cmdTxt;
|
|
4
6
|
static examples: string[];
|
|
5
7
|
static flags: {
|
|
6
|
-
"auth-key": import("@oclif/core/
|
|
8
|
+
"auth-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
7
9
|
};
|
|
8
10
|
run(): Promise<void>;
|
|
9
11
|
}
|