@apimatic/cli 1.1.0-beta.10 → 1.1.0-beta.13

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 (166) hide show
  1. package/README.md +105 -6
  2. package/lib/actions/portal/generate.js +7 -1
  3. package/lib/actions/portal/generate.js.map +1 -1
  4. package/lib/actions/publishing/profile/list.d.ts +11 -0
  5. package/lib/actions/publishing/profile/list.js +29 -0
  6. package/lib/actions/publishing/profile/list.js.map +1 -0
  7. package/lib/actions/sdk/generate.d.ts +5 -1
  8. package/lib/actions/sdk/generate.js +55 -40
  9. package/lib/actions/sdk/generate.js.map +1 -1
  10. package/lib/actions/sdk/merge-source-tree.d.ts +12 -0
  11. package/lib/actions/sdk/merge-source-tree.js +78 -0
  12. package/lib/actions/sdk/merge-source-tree.js.map +1 -0
  13. package/lib/actions/sdk/publish/interactive.d.ts +13 -0
  14. package/lib/actions/sdk/publish/interactive.js +105 -0
  15. package/lib/actions/sdk/publish/interactive.js.map +1 -0
  16. package/lib/actions/sdk/publish/non-interactive.d.ts +14 -0
  17. package/lib/actions/sdk/publish/non-interactive.js +101 -0
  18. package/lib/actions/sdk/publish/non-interactive.js.map +1 -0
  19. package/lib/actions/sdk/publish.d.ts +18 -0
  20. package/lib/actions/sdk/publish.js +56 -0
  21. package/lib/actions/sdk/publish.js.map +1 -0
  22. package/lib/actions/sdk/quickstart.js +1 -1
  23. package/lib/actions/sdk/quickstart.js.map +1 -1
  24. package/lib/actions/sdk/save-changes.d.ts +8 -0
  25. package/lib/actions/sdk/save-changes.js +93 -0
  26. package/lib/actions/sdk/save-changes.js.map +1 -0
  27. package/lib/commands/portal/recipe/new.js +2 -2
  28. package/lib/commands/portal/recipe/new.js.map +1 -1
  29. package/lib/commands/portal/toc/new.js +2 -2
  30. package/lib/commands/portal/toc/new.js.map +1 -1
  31. package/lib/commands/publishing/profile/list.d.ts +9 -0
  32. package/lib/commands/publishing/profile/list.js +28 -0
  33. package/lib/commands/publishing/profile/list.js.map +1 -0
  34. package/lib/commands/quickstart.js +1 -1
  35. package/lib/commands/quickstart.js.map +1 -1
  36. package/lib/commands/sdk/generate.d.ts +4 -2
  37. package/lib/commands/sdk/generate.js +26 -8
  38. package/lib/commands/sdk/generate.js.map +1 -1
  39. package/lib/commands/sdk/publish.d.ts +18 -0
  40. package/lib/commands/sdk/publish.js +73 -0
  41. package/lib/commands/sdk/publish.js.map +1 -0
  42. package/lib/commands/sdk/save-changes.d.ts +14 -0
  43. package/lib/commands/sdk/save-changes.js +51 -0
  44. package/lib/commands/sdk/save-changes.js.map +1 -0
  45. package/lib/hooks/not-found.js +1 -1
  46. package/lib/hooks/not-found.js.map +1 -1
  47. package/lib/infrastructure/env-info.d.ts +2 -0
  48. package/lib/infrastructure/env-info.js +22 -11
  49. package/lib/infrastructure/env-info.js.map +1 -1
  50. package/lib/infrastructure/file-service.d.ts +9 -0
  51. package/lib/infrastructure/file-service.js +94 -5
  52. package/lib/infrastructure/file-service.js.map +1 -1
  53. package/lib/infrastructure/git-service.d.ts +14 -0
  54. package/lib/infrastructure/git-service.js +90 -0
  55. package/lib/infrastructure/git-service.js.map +1 -0
  56. package/lib/infrastructure/launcher-service.d.ts +5 -0
  57. package/lib/infrastructure/launcher-service.js +35 -2
  58. package/lib/infrastructure/launcher-service.js.map +1 -1
  59. package/lib/infrastructure/os-extensions.d.ts +2 -0
  60. package/lib/infrastructure/os-extensions.js +6 -0
  61. package/lib/infrastructure/os-extensions.js.map +1 -0
  62. package/lib/infrastructure/service-error.d.ts +14 -2
  63. package/lib/infrastructure/service-error.js +26 -9
  64. package/lib/infrastructure/service-error.js.map +1 -1
  65. package/lib/infrastructure/services/portal-service.d.ts +6 -1
  66. package/lib/infrastructure/services/portal-service.js +37 -18
  67. package/lib/infrastructure/services/portal-service.js.map +1 -1
  68. package/lib/infrastructure/services/publishing-api-service.d.ts +19 -0
  69. package/lib/infrastructure/services/publishing-api-service.js +111 -0
  70. package/lib/infrastructure/services/publishing-api-service.js.map +1 -0
  71. package/lib/infrastructure/zip-service.d.ts +2 -2
  72. package/lib/infrastructure/zip-service.js +29 -11
  73. package/lib/infrastructure/zip-service.js.map +1 -1
  74. package/lib/prompts/format.d.ts +0 -2
  75. package/lib/prompts/format.js +0 -31
  76. package/lib/prompts/format.js.map +1 -1
  77. package/lib/prompts/portal/generate.d.ts +1 -1
  78. package/lib/prompts/portal/generate.js +9 -3
  79. package/lib/prompts/portal/generate.js.map +1 -1
  80. package/lib/prompts/prompt.d.ts +6 -0
  81. package/lib/prompts/prompt.js +45 -0
  82. package/lib/prompts/prompt.js.map +1 -1
  83. package/lib/prompts/publishing/profile/list.d.ts +9 -0
  84. package/lib/prompts/publishing/profile/list.js +27 -0
  85. package/lib/prompts/publishing/profile/list.js.map +1 -0
  86. package/lib/prompts/sdk/generate.d.ts +5 -3
  87. package/lib/prompts/sdk/generate.js +20 -14
  88. package/lib/prompts/sdk/generate.js.map +1 -1
  89. package/lib/prompts/sdk/merge-source-tree.d.ts +22 -0
  90. package/lib/prompts/sdk/merge-source-tree.js +90 -0
  91. package/lib/prompts/sdk/merge-source-tree.js.map +1 -0
  92. package/lib/prompts/sdk/publish/interactive.d.ts +30 -0
  93. package/lib/prompts/sdk/publish/interactive.js +139 -0
  94. package/lib/prompts/sdk/publish/interactive.js.map +1 -0
  95. package/lib/prompts/sdk/publish/non-interactive.d.ts +27 -0
  96. package/lib/prompts/sdk/publish/non-interactive.js +97 -0
  97. package/lib/prompts/sdk/publish/non-interactive.js.map +1 -0
  98. package/lib/prompts/sdk/publish.d.ts +12 -0
  99. package/lib/prompts/sdk/publish.js +16 -0
  100. package/lib/prompts/sdk/publish.js.map +1 -0
  101. package/lib/prompts/sdk/save-changes.d.ts +21 -0
  102. package/lib/prompts/sdk/save-changes.js +84 -0
  103. package/lib/prompts/sdk/save-changes.js.map +1 -0
  104. package/lib/types/build/build.d.ts +2 -0
  105. package/lib/types/build/build.js.map +1 -1
  106. package/lib/types/build-context.d.ts +11 -0
  107. package/lib/types/build-context.js +81 -1
  108. package/lib/types/build-context.js.map +1 -1
  109. package/lib/types/events/sdk-changes-saved.d.ts +8 -0
  110. package/lib/types/events/sdk-changes-saved.js +11 -0
  111. package/lib/types/events/sdk-changes-saved.js.map +1 -0
  112. package/lib/types/events/sdk-changes-tracked.d.ts +8 -0
  113. package/lib/types/events/sdk-changes-tracked.js +11 -0
  114. package/lib/types/events/sdk-changes-tracked.js.map +1 -0
  115. package/lib/types/events/sdk-conflicts-resolved.d.ts +8 -0
  116. package/lib/types/events/sdk-conflicts-resolved.js +11 -0
  117. package/lib/types/events/sdk-conflicts-resolved.js.map +1 -0
  118. package/lib/types/events/sdk-publish-validation-failed.d.ts +5 -0
  119. package/lib/types/events/sdk-publish-validation-failed.js +8 -0
  120. package/lib/types/events/sdk-publish-validation-failed.js.map +1 -0
  121. package/lib/types/file/directory.d.ts +10 -1
  122. package/lib/types/file/directory.js +63 -5
  123. package/lib/types/file/directory.js.map +1 -1
  124. package/lib/types/file/directoryPath.js.map +1 -1
  125. package/lib/types/merge-source-tree-context.d.ts +28 -0
  126. package/lib/types/merge-source-tree-context.js +63 -0
  127. package/lib/types/merge-source-tree-context.js.map +1 -0
  128. package/lib/types/package-settings-context.d.ts +10 -0
  129. package/lib/types/package-settings-context.js +20 -0
  130. package/lib/types/package-settings-context.js.map +1 -0
  131. package/lib/types/publish/package-settings-configuration.d.ts +70 -0
  132. package/lib/types/publish/package-settings-configuration.js +46 -0
  133. package/lib/types/publish/package-settings-configuration.js.map +1 -0
  134. package/lib/types/publish/profile-id.d.ts +10 -0
  135. package/lib/types/publish/profile-id.js +22 -0
  136. package/lib/types/publish/profile-id.js.map +1 -0
  137. package/lib/types/publish/publishing-profile.d.ts +18 -0
  138. package/lib/types/publish/publishing-profile.js +105 -0
  139. package/lib/types/publish/publishing-profile.js.map +1 -0
  140. package/lib/types/publish/publishing-profiles.d.ts +12 -0
  141. package/lib/types/publish/publishing-profiles.js +36 -0
  142. package/lib/types/publish/publishing-profiles.js.map +1 -0
  143. package/lib/types/publish/version.d.ts +7 -0
  144. package/lib/types/publish/version.js +17 -0
  145. package/lib/types/publish/version.js.map +1 -0
  146. package/lib/types/publish-api/publish-log.d.ts +20 -0
  147. package/lib/types/publish-api/publish-log.js +2 -0
  148. package/lib/types/publish-api/publish-log.js.map +1 -0
  149. package/lib/types/publish-api/publishing-info.d.ts +4 -0
  150. package/lib/types/publish-api/publishing-info.js +2 -0
  151. package/lib/types/publish-api/publishing-info.js.map +1 -0
  152. package/lib/types/publish-api/publishing-profile-item.d.ts +183 -0
  153. package/lib/types/publish-api/publishing-profile-item.js +6 -0
  154. package/lib/types/publish-api/publishing-profile-item.js.map +1 -0
  155. package/lib/types/save-changes-context.d.ts +17 -0
  156. package/lib/types/save-changes-context.js +42 -0
  157. package/lib/types/save-changes-context.js.map +1 -0
  158. package/lib/types/sdk-context.d.ts +5 -4
  159. package/lib/types/sdk-context.js +26 -13
  160. package/lib/types/sdk-context.js.map +1 -1
  161. package/lib/types/spec-context.js.map +1 -1
  162. package/lib/types/temp-context.js.map +1 -1
  163. package/package.json +18 -9
  164. package/lib/types/versioned-build-context.d.ts +0 -15
  165. package/lib/types/versioned-build-context.js +0 -28
  166. package/lib/types/versioned-build-context.js.map +0 -1
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-beta.10",
4
+ "version": "1.1.0-beta.13",
5
5
  "author": "APIMatic",
6
6
  "bin": {
7
7
  "apimatic": "./bin/run.js"
@@ -47,12 +47,11 @@
47
47
  "test": "tsx node_modules/mocha/bin/_mocha --forbid-only \"test/**/*.test.ts\" --timeout 99999"
48
48
  },
49
49
  "dependencies": {
50
- "@apimatic/sdk": "^0.2.0-alpha.7",
50
+ "@apimatic/sdk": "0.2.0-alpha.8",
51
51
  "@clack/prompts": "1.0.0-alpha.1",
52
52
  "@oclif/core": "^4.2.8",
53
53
  "@oclif/plugin-autocomplete": "^3.2.24",
54
54
  "@oclif/plugin-help": "^6.2.26",
55
- "archiver": "^7.0.1",
56
55
  "async-mutex": "^0.5.0",
57
56
  "axios": "^1.8.1",
58
57
  "chokidar": "^3.6.0",
@@ -65,6 +64,7 @@
65
64
  "fs-extra": "^11.3.0",
66
65
  "get-port": "^7.1.0",
67
66
  "is-in-ci": "^2.0.0",
67
+ "isomorphic-git": "^1.37.2",
68
68
  "livereload": "^0.9.3",
69
69
  "neverthrow": "^8.2.0",
70
70
  "open": "^8.4.0",
@@ -73,16 +73,16 @@
73
73
  "tmp-promise": "^3.0.3",
74
74
  "tslib": "^2.8.1",
75
75
  "uuid": "^11.1.0",
76
- "yaml": "^2.8.0"
76
+ "yaml": "^2.8.0",
77
+ "yazl": "^3.3.1"
77
78
  },
78
79
  "devDependencies": {
79
- "@commitlint/cli": "^15.0.0",
80
+ "@commitlint/cli": "^20.5.0",
80
81
  "@commitlint/config-conventional": "^15.0.0",
81
82
  "@eslint/js": "^9.34.0",
82
83
  "@oclif/test": "^4.1.13",
83
84
  "@semantic-release/changelog": "^6.0.3",
84
85
  "@semantic-release/git": "^10.0.1",
85
- "@types/archiver": "^5.3.4",
86
86
  "@types/base-64": "^1.0.0",
87
87
  "@types/chai": "^4.3.20",
88
88
  "@types/connect-livereload": "^0.5.32",
@@ -97,6 +97,7 @@
97
97
  "@types/sinon": "^17.0.4",
98
98
  "@types/treeify": "^1.0.3",
99
99
  "@types/unzipper": "^0.10.4",
100
+ "@types/yazl": "^3.3.0",
100
101
  "@typescript-eslint/eslint-plugin": "^8.0.0",
101
102
  "@typescript-eslint/parser": "^8.0.0",
102
103
  "chai": "^4.5.0",
@@ -111,6 +112,7 @@
111
112
  "nyc": "^17.1.0",
112
113
  "oclif": "^4.17.34",
113
114
  "rimraf": "^6.0.1",
115
+ "semantic-release": "^23.1.1",
114
116
  "sinon": "^21.0.0",
115
117
  "ts-node": "^10.9.2",
116
118
  "tsx": "^4.20.3",
@@ -120,7 +122,7 @@
120
122
  "commands": "./lib/commands",
121
123
  "dirname": "apimatic",
122
124
  "bin": "apimatic",
123
- "description": "The official CLI for APIMatic. \nTo get started with APIMatic's CLI using a step by step wizard, run 'apimatic portal:quickstart'.",
125
+ "description": "The official CLI for APIMatic. \nTo get started with APIMatic's CLI using a step by step wizard, run 'apimatic quickstart'.",
124
126
  "hooks": {
125
127
  "command_not_found": "./lib/hooks/not-found"
126
128
  },
@@ -139,7 +141,13 @@
139
141
  "description": "Generate, download and serve an API Documentation portal for your APIs."
140
142
  },
141
143
  "sdk": {
142
- "description": "Generate SDKs for your APIs in multiple languages."
144
+ "description": "Generate and publish SDKs for your APIs in multiple languages."
145
+ },
146
+ "publishing": {
147
+ "description": "Manage SDK publishing configurations."
148
+ },
149
+ "publishing:profile": {
150
+ "description": "Manage publishing profiles."
143
151
  },
144
152
  "portal:toc": {
145
153
  "description": "Generate a Table of Contents (TOC) file for your API documentation portal."
@@ -153,11 +161,12 @@
153
161
  "*.{js,ts}": "prettier --write"
154
162
  },
155
163
  "overrides": {
164
+ "diff": "^8.0.4",
156
165
  "inflight": "npm:lru-cache@^7.14.1",
157
166
  "lodash.get": "npm:lodash@^4.17.21",
158
167
  "@humanwhocodes/config-array": "npm:@eslint/config-array@latest",
159
168
  "rimraf": "^6.0.1",
160
- "glob": "^10.4.5",
169
+ "glob": "^13.0.0",
161
170
  "q": "npm:promise@^8.3.0"
162
171
  }
163
172
  }
@@ -1,15 +0,0 @@
1
- import { DirectoryPath } from "./file/directoryPath.js";
2
- type VersionedBuildValidateResult = {
3
- isValid: false;
4
- } | {
5
- isValid: true;
6
- versionsDirectory: DirectoryPath;
7
- versions: string[];
8
- };
9
- export declare class VersionedBuildContext {
10
- private readonly fileService;
11
- private readonly buildDirectory;
12
- constructor(buildDirectory: DirectoryPath);
13
- validate(): Promise<VersionedBuildValidateResult>;
14
- }
15
- export {};
@@ -1,28 +0,0 @@
1
- import { FileService } from "../infrastructure/file-service.js";
2
- import { BuildContext } from "./build-context.js";
3
- export class VersionedBuildContext {
4
- constructor(buildDirectory) {
5
- this.fileService = new FileService();
6
- this.buildDirectory = buildDirectory;
7
- }
8
- async validate() {
9
- var _a;
10
- const buildContext = new BuildContext(this.buildDirectory);
11
- if (!(await buildContext.validate())) {
12
- return { isValid: false };
13
- }
14
- const config = await buildContext.getBuildFileContents();
15
- if (!("generateVersionedPortal" in config)) {
16
- return { isValid: false };
17
- }
18
- const versionsPath = (_a = config.versionsPath) !== null && _a !== void 0 ? _a : "versioned_docs";
19
- const versionsDirectory = this.buildDirectory.join(versionsPath);
20
- if (!(await this.fileService.directoryExists(versionsDirectory))) {
21
- return { isValid: false };
22
- }
23
- const versionsDirs = await this.fileService.getSubDirectoriesPaths(versionsDirectory);
24
- const versions = versionsDirs.map((dir) => dir.leafName());
25
- return { isValid: true, versionsDirectory, versions };
26
- }
27
- }
28
- //# sourceMappingURL=versioned-build-context.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"versioned-build-context.js","sourceRoot":"","sources":["../../src/types/versioned-build-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAQlD,MAAM,OAAO,qBAAqB;IAIhC,YAAY,cAA6B;QAHxB,gBAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QAI/C,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,QAAQ;;QACnB,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3D,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACrC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,oBAAoB,EAAE,CAAC;QACzD,IAAI,CAAC,CAAC,yBAAyB,IAAI,MAAM,CAAC,EAAE,CAAC;YAC3C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;QACD,MAAM,YAAY,GAAG,MAAC,MAAM,CAAC,YAAuB,mCAAI,gBAAgB,CAAC;QACzE,MAAM,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC;YACjE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QACtF,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,CAAC;IACxD,CAAC;CACF"}