@apimatic/cli 1.1.0-alpha.7 → 1.1.0-alpha.9

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.
Files changed (59) hide show
  1. package/README.md +85 -47
  2. package/lib/actions/portal/generate.d.ts +7 -0
  3. package/lib/actions/portal/generate.js +58 -0
  4. package/lib/actions/portal/toc/new-toc.d.ts +17 -0
  5. package/lib/actions/portal/toc/new-toc.js +134 -0
  6. package/lib/application/portal/toc/sdl-parser.d.ts +13 -0
  7. package/lib/application/portal/toc/sdl-parser.js +53 -0
  8. package/lib/application/portal/toc/toc-content-parser.d.ts +5 -0
  9. package/lib/application/portal/toc/toc-content-parser.js +46 -0
  10. package/lib/application/portal/toc/toc-structure-generator.d.ts +6 -0
  11. package/lib/application/portal/toc/toc-structure-generator.js +88 -0
  12. package/lib/client-utils/sdk-client.js +7 -3
  13. package/lib/commands/api/transform.js +3 -3
  14. package/lib/commands/api/validate.js +1 -1
  15. package/lib/commands/portal/generate.d.ts +6 -1
  16. package/lib/commands/portal/generate.js +58 -75
  17. package/lib/commands/portal/quickstart.js +21 -25
  18. package/lib/commands/portal/serve.d.ts +0 -1
  19. package/lib/commands/portal/serve.js +4 -10
  20. package/lib/commands/portal/toc/new.d.ts +15 -0
  21. package/lib/commands/portal/toc/new.js +65 -0
  22. package/lib/commands/sdk/generate.js +4 -4
  23. package/lib/controllers/api/transform.js +9 -6
  24. package/lib/controllers/api/validate.d.ts +2 -2
  25. package/lib/controllers/api/validate.js +8 -16
  26. package/lib/controllers/portal/generate.d.ts +2 -2
  27. package/lib/controllers/portal/generate.js +101 -49
  28. package/lib/controllers/portal/quickstart.d.ts +3 -3
  29. package/lib/controllers/portal/quickstart.js +60 -8
  30. package/lib/controllers/portal/serve.d.ts +1 -2
  31. package/lib/controllers/portal/serve.js +13 -27
  32. package/lib/controllers/sdk/generate.d.ts +3 -3
  33. package/lib/controllers/sdk/generate.js +5 -6
  34. package/lib/infrastructure/services/portal-service.d.ts +16 -0
  35. package/lib/infrastructure/services/portal-service.js +133 -0
  36. package/lib/prompts/portal/generate.d.ts +10 -0
  37. package/lib/prompts/portal/generate.js +62 -0
  38. package/lib/prompts/portal/quickstart.d.ts +4 -5
  39. package/lib/prompts/portal/quickstart.js +16 -17
  40. package/lib/prompts/portal/toc/new-toc.d.ts +10 -0
  41. package/lib/prompts/portal/toc/new-toc.js +46 -0
  42. package/lib/services/portal/server.d.ts +5 -2
  43. package/lib/services/portal/server.js +57 -27
  44. package/lib/types/api/transform.d.ts +16 -0
  45. package/lib/types/api/transform.js +19 -2
  46. package/lib/types/common/result.d.ts +17 -0
  47. package/lib/types/common/result.js +36 -0
  48. package/lib/types/portal/generate.d.ts +26 -9
  49. package/lib/types/portal/generate.js +2 -1
  50. package/lib/types/sdk/generate.d.ts +3 -2
  51. package/lib/types/sdk/generate.js +3 -2
  52. package/lib/types/sdl/sdl.d.ts +11 -0
  53. package/lib/types/sdl/sdl.js +3 -0
  54. package/lib/types/toc/toc.d.ts +31 -0
  55. package/lib/types/toc/toc.js +10 -0
  56. package/lib/utils/utils.d.ts +2 -0
  57. package/lib/utils/utils.js +37 -14
  58. package/lib/validators/common/directoryValidator.js +4 -4
  59. package/package.json +12 -9
@@ -14,10 +14,10 @@ class DirectoryValidator {
14
14
  }
15
15
  }
16
16
  async validateGeneratedPortalDestinationDirectory(destinationDir, portalDir) {
17
- if (!fs.pathExistsSync(destinationDir) && destinationDir != "./api-portal") {
17
+ if (!fs.pathExistsSync(destinationDir) && destinationDir != "./generated_portal") {
18
18
  this.error((0, utils_1.getMessageInRedColor)(`The specified destination directory does not exist: ${destinationDir}. Please provide a valid destination directory to continue.`));
19
19
  }
20
- if (destinationDir == "./api-portal") {
20
+ if (destinationDir == "./generated_portal") {
21
21
  await fs.ensureDir(portalDir);
22
22
  }
23
23
  }
@@ -44,10 +44,10 @@ class DirectoryValidator {
44
44
  }
45
45
  validateGeneratedPortalDestinationDirectoryIsEmpty(destinationDir) {
46
46
  const portalDirItems = (0, utils_1.getNonHiddenItemsFromDirectory)(destinationDir);
47
- if (portalDirItems.length > 0 && destinationDir != "./api-portal") {
47
+ if (portalDirItems.length > 0 && destinationDir != "./generated_portal") {
48
48
  this.error((0, utils_1.getMessageInRedColor)("The destination directory is not empty. Please specify an empty destination directory or empty the provided directory."));
49
49
  }
50
50
  }
51
51
  }
52
52
  exports.DirectoryValidator = DirectoryValidator;
53
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGlyZWN0b3J5VmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRvcnMvY29tbW9uL2RpcmVjdG9yeVZhbGlkYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwrQkFBK0I7QUFDL0IsNkJBQTZCO0FBQzdCLDZDQUF5RjtBQUV6RixNQUFhLGtCQUFrQjtJQUM3QixZQUE2QixLQUFnQztRQUFoQyxVQUFLLEdBQUwsS0FBSyxDQUEyQjtJQUFHLENBQUM7SUFFakUsdUJBQXVCLENBQUMsU0FBaUI7UUFDdkMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQztZQUNsQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUEsNEJBQW9CLEVBQUMsa0RBQWtELFNBQVMsd0RBQXdELENBQUMsQ0FBQyxDQUFDO1FBQ3hKLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLDJDQUEyQyxDQUFDLGNBQXNCLEVBQUUsU0FBaUI7UUFDekYsSUFBSSxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLElBQUksY0FBYyxJQUFJLGNBQWMsRUFBRSxDQUFDO1lBQzNFLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBQSw0QkFBb0IsRUFBQyx1REFBdUQsY0FBYyw2REFBNkQsQ0FBQyxDQUFDLENBQUM7UUFDdkssQ0FBQztRQUVELElBQUksY0FBYyxJQUFJLGNBQWMsRUFBRSxDQUFDO1lBQ3JDLE1BQU0sRUFBRSxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQztRQUNoQyxDQUFDO0lBQ0gsQ0FBQztJQUVELDZCQUE2QixDQUFDLFNBQWlCO1FBQzdDLE1BQU0sY0FBYyxHQUFHLElBQUEsc0NBQThCLEVBQUMsU0FBUyxDQUFDLENBQUM7UUFDakUsSUFBSSxjQUFjLENBQUMsTUFBTSxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQy9CLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBQSw0QkFBb0IsRUFBQywySEFBMkgsQ0FBQyxDQUFDLENBQUM7UUFDaEssQ0FBQztRQUNELElBQUksQ0FBQyxjQUFjLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7WUFDckMsSUFBSSxDQUFDLEtBQUssQ0FDUixJQUFBLDRCQUFvQixFQUFDLGtKQUFrSixDQUFDLENBQ3pLLENBQUM7UUFDSixDQUFDO1FBQ0QsSUFBSSxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDdEUsSUFBSSxDQUFDLEtBQUssQ0FDUixJQUFBLDRCQUFvQixFQUNsQiwyR0FBMkcsQ0FDNUcsQ0FDRixDQUFDO1FBQ0osQ0FBQztJQUNILENBQUM7SUFFRCxpQ0FBaUMsQ0FBQyxTQUFpQjtRQUNqRCxNQUFNLGVBQWUsR0FBRyxJQUFBLHNDQUE4QixFQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7UUFDckYsSUFBSSxlQUFlLENBQUMsTUFBTSxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2hDLElBQUksQ0FBQyxLQUFLLENBQ1IsSUFBQSw0QkFBb0IsRUFBQyw2SUFBNkksQ0FBQyxDQUNwSyxDQUFDO1FBQ0osQ0FBQztRQUNELElBQUksZUFBZSxDQUFDLE1BQU0sSUFBSSxDQUFDLElBQUksZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLFdBQVcsRUFBRSxDQUFDLFVBQVUsQ0FBQyxlQUFlLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDbEgsSUFBSSxDQUFDLEtBQUssQ0FDUixJQUFBLDRCQUFvQixFQUNsQiw2SUFBNkksQ0FDOUksQ0FDRixDQUFDO1FBQ0osQ0FBQztJQUNILENBQUM7SUFFRCxrREFBa0QsQ0FBQyxjQUFzQjtRQUN2RSxNQUFNLGNBQWMsR0FBRyxJQUFBLHNDQUE4QixFQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQ3RFLElBQUksY0FBYyxDQUFDLE1BQU0sR0FBRyxDQUFDLElBQUksY0FBYyxJQUFJLGNBQWMsRUFBRSxDQUFDO1lBQ2xFLElBQUksQ0FBQyxLQUFLLENBQ1IsSUFBQSw0QkFBb0IsRUFDbEIsd0hBQXdILENBQ3pILENBQ0YsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUFoRUQsZ0RBZ0VDIn0=
53
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGlyZWN0b3J5VmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRvcnMvY29tbW9uL2RpcmVjdG9yeVZhbGlkYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwrQkFBK0I7QUFDL0IsNkJBQTZCO0FBQzdCLDZDQUF5RjtBQUV6RixNQUFhLGtCQUFrQjtJQUM3QixZQUE2QixLQUFnQztRQUFoQyxVQUFLLEdBQUwsS0FBSyxDQUEyQjtJQUFHLENBQUM7SUFFakUsdUJBQXVCLENBQUMsU0FBaUI7UUFDdkMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQztZQUNsQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUEsNEJBQW9CLEVBQUMsa0RBQWtELFNBQVMsd0RBQXdELENBQUMsQ0FBQyxDQUFDO1FBQ3hKLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLDJDQUEyQyxDQUFDLGNBQXNCLEVBQUUsU0FBaUI7UUFDekYsSUFBSSxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLElBQUksY0FBYyxJQUFJLG9CQUFvQixFQUFFLENBQUM7WUFDakYsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFBLDRCQUFvQixFQUFDLHVEQUF1RCxjQUFjLDZEQUE2RCxDQUFDLENBQUMsQ0FBQztRQUN2SyxDQUFDO1FBRUQsSUFBSSxjQUFjLElBQUksb0JBQW9CLEVBQUUsQ0FBQztZQUMzQyxNQUFNLEVBQUUsQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDaEMsQ0FBQztJQUNILENBQUM7SUFFRCw2QkFBNkIsQ0FBQyxTQUFpQjtRQUM3QyxNQUFNLGNBQWMsR0FBRyxJQUFBLHNDQUE4QixFQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ2pFLElBQUksY0FBYyxDQUFDLE1BQU0sSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUMvQixJQUFJLENBQUMsS0FBSyxDQUFDLElBQUEsNEJBQW9CLEVBQUMsMkhBQTJILENBQUMsQ0FBQyxDQUFDO1FBQ2hLLENBQUM7UUFDRCxJQUFJLENBQUMsY0FBYyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ3JDLElBQUksQ0FBQyxLQUFLLENBQ1IsSUFBQSw0QkFBb0IsRUFBQyxrSkFBa0osQ0FBQyxDQUN6SyxDQUFDO1FBQ0osQ0FBQztRQUNELElBQUksQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLGdCQUFnQixDQUFDLENBQUMsRUFBRSxDQUFDO1lBQ3RFLElBQUksQ0FBQyxLQUFLLENBQ1IsSUFBQSw0QkFBb0IsRUFDbEIsMkdBQTJHLENBQzVHLENBQ0YsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0lBRUQsaUNBQWlDLENBQUMsU0FBaUI7UUFDakQsTUFBTSxlQUFlLEdBQUcsSUFBQSxzQ0FBOEIsRUFBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO1FBQ3JGLElBQUksZUFBZSxDQUFDLE1BQU0sSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUNoQyxJQUFJLENBQUMsS0FBSyxDQUNSLElBQUEsNEJBQW9CLEVBQUMsNklBQTZJLENBQUMsQ0FDcEssQ0FBQztRQUNKLENBQUM7UUFDRCxJQUFJLGVBQWUsQ0FBQyxNQUFNLElBQUksQ0FBQyxJQUFJLGVBQWUsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQyxVQUFVLENBQUMsZUFBZSxDQUFDLENBQUMsRUFBRSxDQUFDO1lBQ2xILElBQUksQ0FBQyxLQUFLLENBQ1IsSUFBQSw0QkFBb0IsRUFDbEIsNklBQTZJLENBQzlJLENBQ0YsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0lBRUQsa0RBQWtELENBQUMsY0FBc0I7UUFDdkUsTUFBTSxjQUFjLEdBQUcsSUFBQSxzQ0FBOEIsRUFBQyxjQUFjLENBQUMsQ0FBQztRQUN0RSxJQUFJLGNBQWMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLGNBQWMsSUFBSSxvQkFBb0IsRUFBRSxDQUFDO1lBQ3hFLElBQUksQ0FBQyxLQUFLLENBQ1IsSUFBQSw0QkFBb0IsRUFDbEIsd0hBQXdILENBQ3pILENBQ0YsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUFoRUQsZ0RBZ0VDIn0=
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@apimatic/cli",
3
3
  "description": "The official CLI for APIMatic.",
4
- "version": "1.1.0-alpha.7",
4
+ "version": "1.1.0-alpha.9",
5
5
  "author": "APIMatic",
6
6
  "bin": {
7
7
  "apimatic": "./bin/run"
@@ -43,8 +43,8 @@
43
43
  "lint:fix": "eslint --fix \"src/**/*.{js,ts}\" --quiet"
44
44
  },
45
45
  "dependencies": {
46
- "@apimatic/sdk": "0.1.0-alpha.2",
47
- "@clack/prompts": "^0.10.0",
46
+ "@apimatic/sdk": "^0.2.0-alpha.1",
47
+ "@clack/prompts": "^0.11.0",
48
48
  "@oclif/core": "^4.2.8",
49
49
  "@oclif/plugin-autocomplete": "^3.2.24",
50
50
  "@oclif/plugin-help": "^6.2.26",
@@ -65,39 +65,42 @@
65
65
  "striptags": "^3.2.0",
66
66
  "treeify": "^1.1.0",
67
67
  "tslib": "^2.5.0",
68
- "unzipper": "^0.12.3"
68
+ "unzipper": "^0.12.3",
69
+ "yaml": "^2.8.0"
69
70
  },
70
71
  "devDependencies": {
71
72
  "@commitlint/cli": "^15.0.0",
72
73
  "@commitlint/config-conventional": "^15.0.0",
73
- "@oclif/test": "^4.1.11",
74
+ "@oclif/test": "^4.1.13",
74
75
  "@semantic-release/changelog": "^6.0.3",
75
76
  "@semantic-release/git": "^10.0.1",
76
77
  "@types/adm-zip": "^0.5.5",
77
78
  "@types/archiver": "^5.1.1",
78
79
  "@types/base-64": "^1.0.0",
79
- "@types/chai": "^4.2.22",
80
+ "@types/chai": "^4.3.20",
80
81
  "@types/connect-livereload": "^0.5.1",
81
82
  "@types/express": "^4.17.13",
82
83
  "@types/fs-extra": "^9.0.13",
83
84
  "@types/livereload": "^0.9.2",
84
85
  "@types/mocha": "^5.2.7",
85
- "@types/node": "^10.17.60",
86
+ "@types/node": "^20.17.50",
86
87
  "@types/treeify": "^1.0.3",
87
88
  "@types/unzipper": "^0.10.4",
88
89
  "@typescript-eslint/eslint-plugin": "^8.0.0",
89
90
  "@typescript-eslint/parser": "^8.0.0",
90
- "chai": "^4.3.4",
91
+ "chai": "^4.5.0",
91
92
  "eslint": "^9.21.0",
92
93
  "eslint-config-prettier": "^8.3.0",
93
94
  "eslint-plugin-import": "^2.25.2",
94
95
  "husky": "^7.0.4",
95
96
  "lint-staged": "^11.2.6",
96
- "mocha": "^11.1.0",
97
+ "mocha": "^11.5.0",
98
+ "nock": "^14.0.4",
97
99
  "nyc": "^17.1.0",
98
100
  "oclif": "^4.17.34",
99
101
  "prettier": "^2.4.1",
100
102
  "rimraf": "^6.0.1",
103
+ "tmp-promise": "^3.0.3",
101
104
  "ts-node": "^8.10.2",
102
105
  "typescript": "^5.2.2"
103
106
  },