@apimatic/cli 1.1.0-alpha.7 → 1.1.0-alpha.8
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 +85 -47
- package/lib/actions/portal/generate.d.ts +7 -0
- package/lib/actions/portal/generate.js +58 -0
- package/lib/actions/portal/new/toc.d.ts +17 -0
- package/lib/actions/portal/new/toc.js +134 -0
- package/lib/application/portal/new/toc/sdl-parser.d.ts +13 -0
- package/lib/application/portal/new/toc/sdl-parser.js +53 -0
- package/lib/application/portal/new/toc/toc-content-parser.d.ts +5 -0
- package/lib/application/portal/new/toc/toc-content-parser.js +46 -0
- package/lib/application/portal/new/toc/toc-structure-generator.d.ts +6 -0
- package/lib/application/portal/new/toc/toc-structure-generator.js +88 -0
- package/lib/client-utils/sdk-client.js +7 -3
- package/lib/commands/api/transform.js +3 -3
- package/lib/commands/api/validate.js +1 -1
- package/lib/commands/portal/generate.d.ts +6 -1
- package/lib/commands/portal/generate.js +58 -75
- package/lib/commands/portal/new/toc.d.ts +15 -0
- package/lib/commands/portal/new/toc.js +65 -0
- package/lib/commands/portal/quickstart.js +21 -25
- package/lib/commands/portal/serve.d.ts +0 -1
- package/lib/commands/portal/serve.js +4 -10
- package/lib/commands/sdk/generate.js +4 -4
- package/lib/controllers/api/transform.js +9 -6
- package/lib/controllers/api/validate.d.ts +2 -2
- package/lib/controllers/api/validate.js +8 -16
- package/lib/controllers/portal/generate.d.ts +2 -2
- package/lib/controllers/portal/generate.js +101 -49
- package/lib/controllers/portal/quickstart.d.ts +3 -3
- package/lib/controllers/portal/quickstart.js +60 -8
- package/lib/controllers/portal/serve.d.ts +1 -2
- package/lib/controllers/portal/serve.js +13 -27
- package/lib/controllers/sdk/generate.d.ts +3 -3
- package/lib/controllers/sdk/generate.js +5 -6
- package/lib/infrastructure/services/portal-service.d.ts +16 -0
- package/lib/infrastructure/services/portal-service.js +133 -0
- package/lib/prompts/portal/generate.d.ts +10 -0
- package/lib/prompts/portal/generate.js +62 -0
- package/lib/prompts/portal/new/toc.d.ts +10 -0
- package/lib/prompts/portal/new/toc.js +46 -0
- package/lib/prompts/portal/quickstart.d.ts +4 -5
- package/lib/prompts/portal/quickstart.js +16 -17
- package/lib/services/portal/server.d.ts +5 -2
- package/lib/services/portal/server.js +57 -27
- package/lib/types/api/transform.d.ts +16 -0
- package/lib/types/api/transform.js +19 -2
- package/lib/types/common/result.d.ts +17 -0
- package/lib/types/common/result.js +36 -0
- package/lib/types/portal/generate.d.ts +26 -9
- package/lib/types/portal/generate.js +2 -1
- package/lib/types/sdk/generate.d.ts +3 -2
- package/lib/types/sdk/generate.js +3 -2
- package/lib/types/sdl/sdl.d.ts +11 -0
- package/lib/types/sdl/sdl.js +3 -0
- package/lib/types/toc/toc.d.ts +31 -0
- package/lib/types/toc/toc.js +10 -0
- package/lib/utils/utils.d.ts +2 -0
- package/lib/utils/utils.js +37 -14
- package/lib/validators/common/directoryValidator.js +4 -4
- package/package.json +12 -9
|
@@ -11,10 +11,9 @@ class PortalQuickstartPrompts {
|
|
|
11
11
|
this.spin = (0, prompts_1.spinner)();
|
|
12
12
|
this.vscodeExtensionUrl = "\u001b[4mhttps://marketplace.visualstudio.com/items?itemName=apimatic-developers.apimatic-for-vscode\u001b[0m";
|
|
13
13
|
this.serverUrl = "\u001b[4mhttp://localhost:3000\u001b[0m";
|
|
14
|
-
this.
|
|
15
|
-
this.
|
|
16
|
-
this.
|
|
17
|
-
this.defaultPortalDirectory = path.join(process.cwd(), this.portalDirectory);
|
|
14
|
+
this.referenceDocumentationUrl = "\u001b[4mhttps://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal\u001b[0m";
|
|
15
|
+
this.customizeTheSdksUrl = "\u001b[4mhttps://docs.apimatic.io/generate-sdks/codegen-settings/codegen-settings-overview\u001b[0m";
|
|
16
|
+
this.defaultPortalDirectoryPath = process.cwd();
|
|
18
17
|
}
|
|
19
18
|
displayWelcomeMessage() {
|
|
20
19
|
(0, prompts_1.intro)(`Hello there 👋`);
|
|
@@ -51,7 +50,7 @@ class PortalQuickstartPrompts {
|
|
|
51
50
|
(0, prompts_1.cancel)("Operation cancelled.");
|
|
52
51
|
return process.exit(0);
|
|
53
52
|
}
|
|
54
|
-
return { email: String(email), password: String(pass) };
|
|
53
|
+
return { email: String(email).trim(), password: String(pass).trim() };
|
|
55
54
|
}
|
|
56
55
|
displayLoggingInMessage() {
|
|
57
56
|
this.spin.start((0, utils_1.getMessageInMagentaColor)("Logging in"));
|
|
@@ -87,7 +86,7 @@ class PortalQuickstartPrompts {
|
|
|
87
86
|
(0, prompts_1.cancel)("Operation cancelled.");
|
|
88
87
|
return process.exit(0);
|
|
89
88
|
}
|
|
90
|
-
return String(spec);
|
|
89
|
+
return String(spec).trim();
|
|
91
90
|
}
|
|
92
91
|
displaySpecValidationMessage() {
|
|
93
92
|
prompts_1.log.step((0, utils_1.getMessageInOrangeColor)(`Step 2 of 4: Validate and Lint your OpenAPI file`));
|
|
@@ -116,7 +115,7 @@ class PortalQuickstartPrompts {
|
|
|
116
115
|
}
|
|
117
116
|
if (useSampleSpec === "exit") {
|
|
118
117
|
(0, prompts_1.outro)((0, utils_1.getMessageInCyanColor)("Good luck fixing your API definition! 🛠️ Feel free to run this command again once you're done."));
|
|
119
|
-
process.exit(0);
|
|
118
|
+
return process.exit(0);
|
|
120
119
|
}
|
|
121
120
|
}
|
|
122
121
|
async sdkLanguagesPrompt() {
|
|
@@ -148,11 +147,11 @@ class PortalQuickstartPrompts {
|
|
|
148
147
|
placeholder: "Enter absolute path to the directory or leave it empty to use the current directory.",
|
|
149
148
|
defaultValue: "./",
|
|
150
149
|
validate: (input) => {
|
|
151
|
-
const dirPath = path.resolve(input.trim()
|
|
152
|
-
if (!fs.existsSync(dirPath) && dirPath != this.
|
|
150
|
+
const dirPath = path.resolve(input.trim());
|
|
151
|
+
if (!fs.existsSync(dirPath) && dirPath != this.defaultPortalDirectoryPath) {
|
|
153
152
|
return (0, utils_1.getMessageInRedColor)("Error: The specified directory path does not exist. Please try again.");
|
|
154
153
|
}
|
|
155
|
-
if (dirPath !== this.
|
|
154
|
+
if (dirPath !== this.defaultPortalDirectoryPath) {
|
|
156
155
|
const files = fs.readdirSync(dirPath).filter(item => !item.startsWith('.'));
|
|
157
156
|
;
|
|
158
157
|
if (files.length > 0) {
|
|
@@ -169,10 +168,10 @@ class PortalQuickstartPrompts {
|
|
|
169
168
|
return process.exit(0);
|
|
170
169
|
}
|
|
171
170
|
if (directory === "./") {
|
|
172
|
-
return this.
|
|
171
|
+
return this.defaultPortalDirectoryPath;
|
|
173
172
|
}
|
|
174
173
|
else {
|
|
175
|
-
return
|
|
174
|
+
return String(directory).trim();
|
|
176
175
|
}
|
|
177
176
|
}
|
|
178
177
|
displayBuildDirectoryGenerationMessage() {
|
|
@@ -199,18 +198,18 @@ class PortalQuickstartPrompts {
|
|
|
199
198
|
displayPortalGenerationSuccessMessage() {
|
|
200
199
|
this.spin.stop((0, utils_1.getMessageInCyanColor)("✅ Portal setup complete!"));
|
|
201
200
|
}
|
|
202
|
-
displayOutroMessage() {
|
|
201
|
+
displayOutroMessage(directory) {
|
|
203
202
|
prompts_1.log.step((0, utils_1.getMessageInCyanColor)(`📢 Your API Portal is live at: ${this.serverUrl}\n`) +
|
|
204
|
-
(0, utils_1.getMessageInCyanColor)(`Hot reload enabled! Edit files in
|
|
203
|
+
(0, utils_1.getMessageInCyanColor)(`Hot reload enabled! Edit files in ${directory} to see changes instantly reflected in your API Portal.\n`) +
|
|
205
204
|
(0, utils_1.getMessageInCyanColor)(`Press CTRL+C to stop the server.\n\n`) +
|
|
206
205
|
(0, utils_1.getMessageInCyanColor)(`What's next?\n`) +
|
|
207
206
|
(0, utils_1.getMessageInCyanColor)(`- Check out the Interactive Playground in your API Portal.\n`) +
|
|
208
|
-
(0, utils_1.getMessageInCyanColor)(`- Read the reference documentation to learn more about how you can customize this API Portal: ${this.
|
|
207
|
+
(0, utils_1.getMessageInCyanColor)(`- Read the reference documentation to learn more about how you can customize this API Portal: ${this.referenceDocumentationUrl}`) +
|
|
209
208
|
(0, utils_1.getMessageInCyanColor)(` \n`) +
|
|
210
209
|
(0, utils_1.getMessageInCyanColor)(`- Review the SDK Documentation for your favourite programming language and download an SDK from the API Portal.\n`) +
|
|
211
|
-
(0, utils_1.getMessageInCyanColor)(`- Check out how you can customize the SDKs using Code Generation settings: ${this.
|
|
210
|
+
(0, utils_1.getMessageInCyanColor)(`- Check out how you can customize the SDKs using Code Generation settings: ${this.customizeTheSdksUrl}`) +
|
|
212
211
|
(0, utils_1.getMessageInCyanColor)(` \n`));
|
|
213
212
|
}
|
|
214
213
|
}
|
|
215
214
|
exports.PortalQuickstartPrompts = PortalQuickstartPrompts;
|
|
216
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
215
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/prompts/portal/quickstart.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAC7B,mCAAmC;AACnC,4CAAmH;AACnH,6CAQ2B;AAE3B,MAAa,uBAAuB;IAApC;QACmB,SAAI,GAAG,IAAA,iBAAO,GAAE,CAAC;QACjB,uBAAkB,GACjC,+GAA+G,CAAC;QACjG,cAAS,GAAG,yCAAyC,CAAC;QACtD,8BAAyB,GACxC,oIAAoI,CAAC;QACtH,wBAAmB,GAClC,qGAAqG,CAAC;QACvF,+BAA0B,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAmQ9D,CAAC;IAjQC,qBAAqB;QACnB,IAAA,eAAK,EAAC,gBAAgB,CAAC,CAAC;QACxB,aAAG,CAAC,OAAO,CACT,wGAAwG,CACzG,CAAC;QACF,aAAG,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,WAAW;QACf,aAAG,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAE1C,MAAM,KAAK,GAAG,MAAM,IAAA,cAAI,EAAC;YACvB,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,IAAA,4BAAoB,EAAC,oBAAoB,CAAC,CAAC;gBACpD,CAAC;gBAED,MAAM,UAAU,GACd,sIAAsI,CAAC;gBAEzI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC5B,OAAO,IAAA,4BAAoB,EAAC,qCAAqC,CAAC,CAAC;gBACrE,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,IAAA,kBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YACpB,IAAA,gBAAM,EAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAA,kBAAQ,EAAC;YAC1B,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,IAAA,4BAAoB,EAAC,uBAAuB,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,IAAA,kBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;YACnB,IAAA,gBAAM,EAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IACxE,CAAC;IAED,uBAAuB;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,gCAAwB,EAAC,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,4BAA4B;QAC1B,IAAI,CAAC,IAAI,CAAC,IAAI,CACZ,IAAA,4BAAoB,EAAC,+EAA+E,CAAC,CACtG,CAAC;IACJ,CAAC;IAED,sBAAsB;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,6BAAqB,EAAC,sBAAsB,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,UAAU;QACd,aAAG,CAAC,IAAI,CAAC,IAAA,+BAAuB,EAAC,6CAA6C,CAAC,CAAC,CAAC;QAEjF,MAAM,IAAI,GAAG,MAAM,IAAA,cAAI,EAAC;YACtB,OAAO,EAAE,wEAAwE;YACjF,WAAW,EAAE,uDAAuD;YACpE,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,KAAK;oBAAE,OAAO;gBAEnB,IAAI,IAAA,kBAAU,EAAC,KAAK,CAAC;oBAAE,OAAO;gBAE9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAEzC,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;oBAChC,IAAI,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;wBACvC,OAAO;oBACT,CAAC;oBAED,OAAO,IAAA,4BAAoB,EAAC,6IAA6I,CAAC,CAAC;gBAC7K,CAAC;gBAED,OAAO,IAAA,4BAAoB,EAAC,2EAA2E,CAAC,CAAC;YAC3G,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,IAAA,kBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;YACnB,IAAA,gBAAM,EAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,4BAA4B;QAC1B,aAAG,CAAC,IAAI,CAAC,IAAA,+BAAuB,EAAC,kDAAkD,CAAC,CAAC,CAAC;QACtF,IAAI,CAAC,IAAI,CAAC,KAAK,CACb,IAAA,gCAAwB,EACtB,wGAAwG,CACzG,CACF,CAAC;IACJ,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,6BAAqB,EAAC,2BAA2B,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,iCAAiC;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,4BAAoB,EAAC,kDAAkD,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,4BAAoB,EAAC,qEAAqE,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED,KAAK,CAAC,2BAA2B;QAC/B,MAAM,aAAa,GAAG,MAAM,IAAA,gBAAM,EAAC;YACjC,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,qEAAqE,IAAI,CAAC,kBAAkB,EAAE,EAAE;gBACxH,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,kDAAkD,EAAE;aACjF;SACF,CAAC,CAAC;QAEH,IAAI,IAAA,kBAAQ,EAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,IAAA,gBAAM,EAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,aAAa,KAAK,MAAM,EAAE,CAAC;YAC7B,IAAA,eAAK,EACH,IAAA,6BAAqB,EACnB,kGAAkG,CACnG,CACF,CAAC;YACF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,aAAG,CAAC,IAAI,CAAC,IAAA,+BAAuB,EAAC,2CAA2C,CAAC,CAAC,CAAC;QAE/E,MAAM,SAAS,GAAG,CAAC,MAAM,IAAA,qBAAW,EAAC;YACnC,OAAO,EACL,oMAAoM;YACtM,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;gBAC5C,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;gBACpC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;gBAChC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;YACD,aAAa,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;SACvF,CAAC,CAAa,CAAC;QAEhB,IAAI,IAAA,kBAAQ,EAAC,SAAS,CAAC,EAAE,CAAC;YACxB,IAAA,gBAAM,EAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,aAAG,CAAC,IAAI,CAAC,IAAA,+BAAuB,EAAC,qDAAqD,CAAC,CAAC,CAAC;QAEzF,MAAM,SAAS,GAAG,MAAM,IAAA,cAAI,EAAC;YAC3B,OAAO,EAAE,yEAAyE;YAClF,WAAW,EAAE,sFAAsF;YACnG,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;gBAE3C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,IAAI,CAAC,0BAA0B,EAAE,CAAC;oBAC1E,OAAO,IAAA,4BAAoB,EAAC,uEAAuE,CAAC,CAAC;gBACvG,CAAC;gBAED,IAAI,OAAO,KAAK,IAAI,CAAC,0BAA0B,EAAE,CAAC;oBAChD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;oBAAA,CAAC;oBAC7E,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACrB,OAAO,IAAA,4BAAoB,EAAC,8GAA8G,CAAC,CAAC;oBAC9I,CAAC;gBACH,CAAC;qBAAM,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxE,OAAO,IAAA,4BAAoB,EAAC,8GAA8G,CAAC,CAAC;gBAC9I,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,IAAA,kBAAQ,EAAC,SAAS,CAAC,EAAE,CAAC;YACxB,IAAA,gBAAM,EAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,0BAA0B,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED,sCAAsC;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,gCAAwB,EAAC,kCAAkC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,2CAA2C;QACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,4BAAoB,EAAC,6DAA6D,CAAC,CAAC,CAAC;IACtG,CAAC;IAED,6CAA6C,CAAC,YAAoB;QAChE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,6BAAqB,EAAC,2BAA2B,YAAY,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,2BAA2B,CAAC,YAAoB;QAC9C,MAAM,cAAc,GAAG,IAAA,uBAAe,EAAC,YAAY,CAAuB,CAAC;QAE3E,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAExD,MAAM,gBAAgB,GAAG,IAAI;aAC1B,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,8BAAsB,EAAC,KAAK,CAAC,CAAC,CAAC;aAC5E,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,aAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC;IAED,8BAA8B;QAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,gCAAwB,EAAC,mBAAmB,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,qCAAqC;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,6BAAqB,EAAC,2BAA2B,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,mBAAmB,CAAC,SAAiB;QACnC,aAAG,CAAC,IAAI,CACN,IAAA,6BAAqB,EAAC,mCAAmC,IAAI,CAAC,SAAS,IAAI,CAAC;YAC1E,IAAA,6BAAqB,EACnB,qCAAqC,SAAS,2DAA2D,CAC1G;YACD,IAAA,6BAAqB,EAAC,sCAAsC,CAAC;YAC7D,IAAA,6BAAqB,EAAC,gBAAgB,CAAC;YACvC,IAAA,6BAAqB,EAAC,8DAA8D,CAAC;YACrF,IAAA,6BAAqB,EAAC,iGAAiG,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACxJ,IAAA,6BAAqB,EAAC,KAAK,CAAC;YAC5B,IAAA,6BAAqB,EACnB,mHAAmH,CACpH;YACD,IAAA,6BAAqB,EAAC,8EAA8E,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC/H,IAAA,6BAAqB,EAAC,KAAK,CAAC,CAC/B,CAAC;IACJ,CAAC;CACF;AA5QD,0DA4QC"}
|
|
@@ -4,8 +4,11 @@ export declare class PortalServerService {
|
|
|
4
4
|
private liveReloadServer;
|
|
5
5
|
private readonly app;
|
|
6
6
|
private readonly port;
|
|
7
|
+
private readonly liveReloadPort;
|
|
7
8
|
constructor();
|
|
8
|
-
|
|
9
|
-
|
|
9
|
+
private findAvailablePort;
|
|
10
|
+
private createLiveReloadServer;
|
|
11
|
+
setupServer(generatedPortalPath: string): Promise<void>;
|
|
12
|
+
startServer(config: PortalServerConfig, noReload?: boolean, displayShutdownMessages?: boolean): Promise<boolean>;
|
|
10
13
|
stopServer(): Promise<void>;
|
|
11
14
|
}
|
|
@@ -10,37 +10,67 @@ const utils_1 = require("../../utils/utils");
|
|
|
10
10
|
class PortalServerService {
|
|
11
11
|
constructor() {
|
|
12
12
|
this.port = 3000;
|
|
13
|
+
this.liveReloadPort = 35729;
|
|
13
14
|
this.app = express();
|
|
14
15
|
}
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
async findAvailablePort(startPort) {
|
|
17
|
+
let port = startPort;
|
|
18
|
+
const maxPort = startPort + 10; // Limit the port search range
|
|
19
|
+
while (port < maxPort) {
|
|
20
|
+
if (!(await (0, utils_1.isPortInUse)(port))) {
|
|
21
|
+
return port;
|
|
22
|
+
}
|
|
23
|
+
port++;
|
|
24
|
+
}
|
|
25
|
+
// If no port is found in the range, return the original port
|
|
26
|
+
return startPort;
|
|
27
|
+
}
|
|
28
|
+
async createLiveReloadServer(generatedPortalPath) {
|
|
29
|
+
try {
|
|
30
|
+
const availablePort = await this.findAvailablePort(this.liveReloadPort);
|
|
31
|
+
this.liveReloadServer = livereload.createServer({
|
|
32
|
+
port: availablePort
|
|
33
|
+
});
|
|
34
|
+
this.liveReloadServer.watch(generatedPortalPath);
|
|
35
|
+
}
|
|
36
|
+
catch (error) {
|
|
37
|
+
console.log((0, utils_1.getMessageInRedColor)(`Unable to serve the portal: ${error.message}`));
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
async setupServer(generatedPortalPath) {
|
|
41
|
+
await this.createLiveReloadServer(generatedPortalPath);
|
|
42
|
+
if (this.liveReloadServer) {
|
|
43
|
+
this.app.use(connectLivereload());
|
|
44
|
+
}
|
|
19
45
|
this.app.use(express.static(generatedPortalPath));
|
|
20
46
|
}
|
|
21
|
-
startServer(config, noReload = false, displayShutdownMessages = true) {
|
|
47
|
+
async startServer(config, noReload = false, displayShutdownMessages = true) {
|
|
22
48
|
const { generatedPortalPath, targetFolder, configDir, authKey, ignoredPaths, port, openInBrowser } = config;
|
|
23
|
-
const
|
|
24
|
-
return new Promise((resolve) => {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
process.stdin.setRawMode(false);
|
|
37
|
-
}
|
|
49
|
+
const requestedPort = port !== null && port !== void 0 ? port : this.port;
|
|
50
|
+
return new Promise((resolve, reject) => {
|
|
51
|
+
this.server = this.app.listen(requestedPort, () => {
|
|
52
|
+
if (openInBrowser) {
|
|
53
|
+
open(`http://localhost:${requestedPort}`);
|
|
54
|
+
}
|
|
55
|
+
if (!noReload) {
|
|
56
|
+
(0, serve_1.watchAndRegeneratePortal)(targetFolder, generatedPortalPath, configDir, authKey, ignoredPaths);
|
|
57
|
+
}
|
|
58
|
+
if (process.platform !== "darwin") {
|
|
59
|
+
//For non-macOS users.
|
|
60
|
+
if (process.stdin.setRawMode) {
|
|
61
|
+
process.stdin.setRawMode(false);
|
|
38
62
|
}
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
63
|
+
}
|
|
64
|
+
resolve(true);
|
|
65
|
+
}).on('error', (err) => {
|
|
66
|
+
if (err.code === 'EADDRINUSE') {
|
|
67
|
+
console.error((0, utils_1.getMessageInRedColor)(`Port ${requestedPort} is not available. Unable to serve your portal.`));
|
|
68
|
+
}
|
|
69
|
+
else {
|
|
70
|
+
console.error((0, utils_1.getMessageInRedColor)(`Unable to serve the portal: ${err.message}`));
|
|
71
|
+
}
|
|
72
|
+
reject(err);
|
|
73
|
+
});
|
|
44
74
|
const shutdown = async () => {
|
|
45
75
|
if (displayShutdownMessages) {
|
|
46
76
|
console.log("Shutting down server...");
|
|
@@ -49,7 +79,7 @@ class PortalServerService {
|
|
|
49
79
|
if (displayShutdownMessages) {
|
|
50
80
|
console.log("Server shut down successfully.");
|
|
51
81
|
}
|
|
52
|
-
resolve();
|
|
82
|
+
resolve(true);
|
|
53
83
|
process.exit(0);
|
|
54
84
|
};
|
|
55
85
|
process.on("SIGINT", shutdown);
|
|
@@ -68,4 +98,4 @@ class PortalServerService {
|
|
|
68
98
|
}
|
|
69
99
|
}
|
|
70
100
|
exports.PortalServerService = PortalServerService;
|
|
71
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
101
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3NlcnZpY2VzL3BvcnRhbC9zZXJ2ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsbUNBQW1DO0FBQ25DLHlDQUF5QztBQUN6Qyx3REFBd0Q7QUFDeEQsNkJBQTZCO0FBQzdCLDBEQUEwRTtBQUcxRSw2Q0FBc0U7QUFFdEUsTUFBYSxtQkFBbUI7SUFPOUI7UUFIaUIsU0FBSSxHQUFHLElBQUksQ0FBQztRQUNaLG1CQUFjLEdBQUcsS0FBSyxDQUFDO1FBR3RDLElBQUksQ0FBQyxHQUFHLEdBQUcsT0FBTyxFQUFFLENBQUM7SUFDdkIsQ0FBQztJQUVPLEtBQUssQ0FBQyxpQkFBaUIsQ0FBQyxTQUFpQjtRQUMvQyxJQUFJLElBQUksR0FBRyxTQUFTLENBQUM7UUFDckIsTUFBTSxPQUFPLEdBQUcsU0FBUyxHQUFHLEVBQUUsQ0FBQyxDQUFDLDhCQUE4QjtRQUU5RCxPQUFPLElBQUksR0FBRyxPQUFPLEVBQUUsQ0FBQztZQUN0QixJQUFJLENBQUMsQ0FBQyxNQUFNLElBQUEsbUJBQVcsRUFBQyxJQUFJLENBQUMsQ0FBQyxFQUFFLENBQUM7Z0JBQy9CLE9BQU8sSUFBSSxDQUFDO1lBQ2QsQ0FBQztZQUNELElBQUksRUFBRSxDQUFDO1FBQ1QsQ0FBQztRQUVELDZEQUE2RDtRQUM3RCxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRU8sS0FBSyxDQUFDLHNCQUFzQixDQUFDLG1CQUEyQjtRQUM5RCxJQUFJLENBQUM7WUFDSCxNQUFNLGFBQWEsR0FBRyxNQUFNLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7WUFFeEUsSUFBSSxDQUFDLGdCQUFnQixHQUFHLFVBQVUsQ0FBQyxZQUFZLENBQUM7Z0JBQzlDLElBQUksRUFBRSxhQUFhO2FBQ3BCLENBQUMsQ0FBQztZQUVILElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLENBQUMsbUJBQW1CLENBQUMsQ0FBQztRQUNuRCxDQUFDO1FBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztZQUNmLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBQSw0QkFBb0IsRUFBQywrQkFBZ0MsS0FBZSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUMsQ0FBQztRQUMvRixDQUFDO0lBQ0gsQ0FBQztJQUVELEtBQUssQ0FBQyxXQUFXLENBQUMsbUJBQTJCO1FBQzNDLE1BQU0sSUFBSSxDQUFDLHNCQUFzQixDQUFDLG1CQUFtQixDQUFDLENBQUM7UUFFdkQsSUFBSSxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQztZQUMxQixJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxpQkFBaUIsRUFBRSxDQUFDLENBQUM7UUFDcEMsQ0FBQztRQUNELElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsbUJBQW1CLENBQUMsQ0FBQyxDQUFDO0lBQ3BELENBQUM7SUFFRCxLQUFLLENBQUMsV0FBVyxDQUFDLE1BQTBCLEVBQUUsUUFBUSxHQUFHLEtBQUssRUFBRSx1QkFBdUIsR0FBRyxJQUFJO1FBQzVGLE1BQU0sRUFBRSxtQkFBbUIsRUFBRSxZQUFZLEVBQUUsU0FBUyxFQUFFLE9BQU8sRUFBRSxZQUFZLEVBQUUsSUFBSSxFQUFFLGFBQWEsRUFBRSxHQUFHLE1BQU0sQ0FBQztRQUM1RyxNQUFNLGFBQWEsR0FBRyxJQUFJLGFBQUosSUFBSSxjQUFKLElBQUksR0FBSSxJQUFJLENBQUMsSUFBSSxDQUFDO1FBRXhDLE9BQU8sSUFBSSxPQUFPLENBQVUsQ0FBQyxPQUFPLEVBQUUsTUFBTSxFQUFFLEVBQUU7WUFDOUMsSUFBSSxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxhQUFhLEVBQUUsR0FBRyxFQUFFO2dCQUNoRCxJQUFJLGFBQWEsRUFBRSxDQUFDO29CQUNsQixJQUFJLENBQUMsb0JBQW9CLGFBQWEsRUFBRSxDQUFDLENBQUM7Z0JBQzVDLENBQUM7Z0JBRUQsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO29CQUNkLElBQUEsZ0NBQXdCLEVBQUMsWUFBWSxFQUFFLG1CQUFtQixFQUFFLFNBQVMsRUFBRSxPQUFPLEVBQUUsWUFBWSxDQUFDLENBQUM7Z0JBQ2hHLENBQUM7Z0JBRUQsSUFBSSxPQUFPLENBQUMsUUFBUSxLQUFLLFFBQVEsRUFBRSxDQUFDO29CQUNsQyxzQkFBc0I7b0JBQ3RCLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLEVBQUUsQ0FBQzt3QkFDN0IsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsS0FBSyxDQUFDLENBQUM7b0JBQ2xDLENBQUM7Z0JBQ0gsQ0FBQztnQkFDRCxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDaEIsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLEdBQTBCLEVBQUUsRUFBRTtnQkFDNUMsSUFBSSxHQUFHLENBQUMsSUFBSSxLQUFLLFlBQVksRUFBRSxDQUFDO29CQUM5QixPQUFPLENBQUMsS0FBSyxDQUFDLElBQUEsNEJBQW9CLEVBQUMsUUFBUSxhQUFhLGlEQUFpRCxDQUFDLENBQUMsQ0FBQztnQkFDOUcsQ0FBQztxQkFBTSxDQUFDO29CQUNOLE9BQU8sQ0FBQyxLQUFLLENBQUMsSUFBQSw0QkFBb0IsRUFBQywrQkFBK0IsR0FBRyxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUMsQ0FBQztnQkFDcEYsQ0FBQztnQkFDRCxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUM7WUFDZCxDQUFDLENBQUMsQ0FBQztZQUVILE1BQU0sUUFBUSxHQUFHLEtBQUssSUFBSSxFQUFFO2dCQUMxQixJQUFJLHVCQUF1QixFQUFFLENBQUM7b0JBQzVCLE9BQU8sQ0FBQyxHQUFHLENBQUMseUJBQXlCLENBQUMsQ0FBQztnQkFDekMsQ0FBQztnQkFDRCxNQUFNLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztnQkFDeEIsSUFBSSx1QkFBdUIsRUFBRSxDQUFDO29CQUM1QixPQUFPLENBQUMsR0FBRyxDQUFDLGdDQUFnQyxDQUFDLENBQUM7Z0JBQ2hELENBQUM7Z0JBQ0QsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNkLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDbEIsQ0FBQyxDQUFDO1lBRUYsT0FBTyxDQUFDLEVBQUUsQ0FBQyxRQUFRLEVBQUUsUUFBUSxDQUFDLENBQUM7WUFDL0IsT0FBTyxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDbEMsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQsS0FBSyxDQUFDLFVBQVU7UUFDZCxJQUFJLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSxDQUFDO1lBQzFCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUNoQyxDQUFDO1FBRUQsSUFBSSxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDaEIsTUFBTSxJQUFJLE9BQU8sQ0FBTyxDQUFDLE9BQU8sRUFBRSxFQUFFO2dCQUNsQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO1lBQ3JDLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7Q0FDRjtBQTNHRCxrREEyR0MifQ==
|
|
@@ -27,3 +27,19 @@ export declare const DestinationFormats: {
|
|
|
27
27
|
Postman20: string;
|
|
28
28
|
GraphQlSchema: string;
|
|
29
29
|
};
|
|
30
|
+
export declare enum TransformationFormats {
|
|
31
|
+
APIMATIC = "Apimatic",
|
|
32
|
+
WADL2009 = "Wadl2009",
|
|
33
|
+
WSDL = "Wsdl",
|
|
34
|
+
SWAGGER10 = "Swagger10",
|
|
35
|
+
SWAGGER20 = "Swagger20",
|
|
36
|
+
SWAGGERYAML = "Swaggeryaml",
|
|
37
|
+
OAS3 = "Oas3",
|
|
38
|
+
OPENAPI3YAML = "Openapi3Yaml",
|
|
39
|
+
APIBLUEPRINT = "Apiblueprint",
|
|
40
|
+
RAML = "Raml",
|
|
41
|
+
RAML10 = "Raml10",
|
|
42
|
+
POSTMAN10 = "Postman10",
|
|
43
|
+
POSTMAN20 = "Postman20",
|
|
44
|
+
GRAPHQLSCHEMA = "Graphqlschema"
|
|
45
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DestinationFormats = void 0;
|
|
3
|
+
exports.TransformationFormats = exports.DestinationFormats = void 0;
|
|
4
4
|
exports.DestinationFormats = {
|
|
5
5
|
OpenApi3Json: "json",
|
|
6
6
|
OpenApi3Yaml: "yaml",
|
|
@@ -16,4 +16,21 @@ exports.DestinationFormats = {
|
|
|
16
16
|
Postman20: "json",
|
|
17
17
|
GraphQlSchema: "json"
|
|
18
18
|
};
|
|
19
|
-
|
|
19
|
+
var TransformationFormats;
|
|
20
|
+
(function (TransformationFormats) {
|
|
21
|
+
TransformationFormats["APIMATIC"] = "Apimatic";
|
|
22
|
+
TransformationFormats["WADL2009"] = "Wadl2009";
|
|
23
|
+
TransformationFormats["WSDL"] = "Wsdl";
|
|
24
|
+
TransformationFormats["SWAGGER10"] = "Swagger10";
|
|
25
|
+
TransformationFormats["SWAGGER20"] = "Swagger20";
|
|
26
|
+
TransformationFormats["SWAGGERYAML"] = "Swaggeryaml";
|
|
27
|
+
TransformationFormats["OAS3"] = "Oas3";
|
|
28
|
+
TransformationFormats["OPENAPI3YAML"] = "Openapi3Yaml";
|
|
29
|
+
TransformationFormats["APIBLUEPRINT"] = "Apiblueprint";
|
|
30
|
+
TransformationFormats["RAML"] = "Raml";
|
|
31
|
+
TransformationFormats["RAML10"] = "Raml10";
|
|
32
|
+
TransformationFormats["POSTMAN10"] = "Postman10";
|
|
33
|
+
TransformationFormats["POSTMAN20"] = "Postman20";
|
|
34
|
+
TransformationFormats["GRAPHQLSCHEMA"] = "Graphqlschema";
|
|
35
|
+
})(TransformationFormats || (exports.TransformationFormats = TransformationFormats = {}));
|
|
36
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhbnNmb3JtLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2FwaS90cmFuc2Zvcm0udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBa0JhLFFBQUEsa0JBQWtCLEdBQUc7SUFDaEMsWUFBWSxFQUFFLE1BQU07SUFDcEIsWUFBWSxFQUFFLE1BQU07SUFDcEIsUUFBUSxFQUFFLE1BQU07SUFDaEIsUUFBUSxFQUFFLEtBQUs7SUFDZixJQUFJLEVBQUUsS0FBSztJQUNYLFNBQVMsRUFBRSxNQUFNO0lBQ2pCLFNBQVMsRUFBRSxNQUFNO0lBQ2pCLFdBQVcsRUFBRSxNQUFNO0lBQ25CLElBQUksRUFBRSxNQUFNO0lBQ1osTUFBTSxFQUFFLE1BQU07SUFDZCxTQUFTLEVBQUUsTUFBTTtJQUNqQixTQUFTLEVBQUUsTUFBTTtJQUNqQixhQUFhLEVBQUUsTUFBTTtDQUN0QixDQUFDO0FBRUYsSUFBWSxxQkFlWDtBQWZELFdBQVkscUJBQXFCO0lBQy9CLDhDQUFxQixDQUFBO0lBQ3JCLDhDQUFxQixDQUFBO0lBQ3JCLHNDQUFhLENBQUE7SUFDYixnREFBdUIsQ0FBQTtJQUN2QixnREFBdUIsQ0FBQTtJQUN2QixvREFBMkIsQ0FBQTtJQUMzQixzQ0FBYSxDQUFBO0lBQ2Isc0RBQTZCLENBQUE7SUFDN0Isc0RBQTZCLENBQUE7SUFDN0Isc0NBQWEsQ0FBQTtJQUNiLDBDQUFpQixDQUFBO0lBQ2pCLGdEQUF1QixDQUFBO0lBQ3ZCLGdEQUF1QixDQUFBO0lBQ3ZCLHdEQUErQixDQUFBO0FBQ2pDLENBQUMsRUFmVyxxQkFBcUIscUNBQXJCLHFCQUFxQixRQWVoQyJ9
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare class Result<T, TError> {
|
|
2
|
+
private readonly Status;
|
|
3
|
+
readonly value?: T | undefined;
|
|
4
|
+
readonly error?: TError | undefined;
|
|
5
|
+
private constructor();
|
|
6
|
+
static success<T, TError>(value: T): Result<T, TError>;
|
|
7
|
+
static failure<T, TError>(error: TError): Result<T, TError>;
|
|
8
|
+
static cancelled<T, TError>(value: T): Result<T, TError>;
|
|
9
|
+
isFailed(): boolean;
|
|
10
|
+
isCancelled(): boolean;
|
|
11
|
+
isSuccess(): boolean;
|
|
12
|
+
}
|
|
13
|
+
export declare enum ResultStatus {
|
|
14
|
+
Success = 0,
|
|
15
|
+
Failed = 1,
|
|
16
|
+
Cancelled = 2
|
|
17
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ResultStatus = exports.Result = void 0;
|
|
4
|
+
class Result {
|
|
5
|
+
constructor(Status, value, error) {
|
|
6
|
+
this.Status = Status;
|
|
7
|
+
this.value = value;
|
|
8
|
+
this.error = error;
|
|
9
|
+
}
|
|
10
|
+
static success(value) {
|
|
11
|
+
return new Result(ResultStatus.Success, value, undefined);
|
|
12
|
+
}
|
|
13
|
+
static failure(error) {
|
|
14
|
+
return new Result(ResultStatus.Failed, undefined, error);
|
|
15
|
+
}
|
|
16
|
+
static cancelled(value) {
|
|
17
|
+
return new Result(ResultStatus.Cancelled, value, undefined);
|
|
18
|
+
}
|
|
19
|
+
isFailed() {
|
|
20
|
+
return this.Status == ResultStatus.Failed;
|
|
21
|
+
}
|
|
22
|
+
isCancelled() {
|
|
23
|
+
return this.Status == ResultStatus.Cancelled;
|
|
24
|
+
}
|
|
25
|
+
isSuccess() {
|
|
26
|
+
return this.Status == ResultStatus.Success;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
exports.Result = Result;
|
|
30
|
+
var ResultStatus;
|
|
31
|
+
(function (ResultStatus) {
|
|
32
|
+
ResultStatus[ResultStatus["Success"] = 0] = "Success";
|
|
33
|
+
ResultStatus[ResultStatus["Failed"] = 1] = "Failed";
|
|
34
|
+
ResultStatus[ResultStatus["Cancelled"] = 2] = "Cancelled";
|
|
35
|
+
})(ResultStatus || (exports.ResultStatus = ResultStatus = {}));
|
|
36
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVzdWx0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2NvbW1vbi9yZXN1bHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsTUFBYSxNQUFNO0lBQ2pCLFlBQ21CLE1BQW9CLEVBQ3JCLEtBQVMsRUFDVCxLQUFjO1FBRmIsV0FBTSxHQUFOLE1BQU0sQ0FBYztRQUNyQixVQUFLLEdBQUwsS0FBSyxDQUFJO1FBQ1QsVUFBSyxHQUFMLEtBQUssQ0FBUztJQUM3QixDQUFDO0lBRUcsTUFBTSxDQUFDLE9BQU8sQ0FBWSxLQUFRO1FBQ3ZDLE9BQU8sSUFBSSxNQUFNLENBQVksWUFBWSxDQUFDLE9BQU8sRUFBRSxLQUFLLEVBQUUsU0FBUyxDQUFDLENBQUM7SUFDdkUsQ0FBQztJQUVNLE1BQU0sQ0FBQyxPQUFPLENBQVksS0FBYTtRQUM1QyxPQUFPLElBQUksTUFBTSxDQUFZLFlBQVksQ0FBQyxNQUFNLEVBQUUsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ3RFLENBQUM7SUFFTSxNQUFNLENBQUMsU0FBUyxDQUFZLEtBQVE7UUFDekMsT0FBTyxJQUFJLE1BQU0sQ0FBWSxZQUFZLENBQUMsU0FBUyxFQUFFLEtBQUssRUFBRSxTQUFTLENBQUMsQ0FBQztJQUN6RSxDQUFDO0lBRU0sUUFBUTtRQUNiLE9BQU8sSUFBSSxDQUFDLE1BQU0sSUFBSSxZQUFZLENBQUMsTUFBTSxDQUFDO0lBQzVDLENBQUM7SUFFTSxXQUFXO1FBQ2hCLE9BQU8sSUFBSSxDQUFDLE1BQU0sSUFBSSxZQUFZLENBQUMsU0FBUyxDQUFDO0lBQy9DLENBQUM7SUFFTSxTQUFTO1FBQ2QsT0FBTyxJQUFJLENBQUMsTUFBTSxJQUFJLFlBQVksQ0FBQyxPQUFPLENBQUM7SUFDN0MsQ0FBQztDQUNGO0FBOUJELHdCQThCQztBQUVELElBQVksWUFJWDtBQUpELFdBQVksWUFBWTtJQUN0QixxREFBTyxDQUFBO0lBQ1AsbURBQU0sQ0FBQTtJQUNOLHlEQUFTLENBQUE7QUFDWCxDQUFDLEVBSlcsWUFBWSw0QkFBWixZQUFZLFFBSXZCIn0=
|
|
@@ -1,9 +1,26 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
export interface GeneratePortalParams {
|
|
2
|
+
readonly sourceBuildInputZipFilePath: string;
|
|
3
|
+
readonly generatedPortalArtifactsFolderPath: string;
|
|
4
|
+
readonly generatedPortalArtifactsZipFilePath: string;
|
|
5
|
+
readonly overrideAuthKey: string | null;
|
|
6
|
+
readonly generateZipFile: boolean;
|
|
7
|
+
}
|
|
8
|
+
export interface PortalPaths {
|
|
9
|
+
readonly sourceFolderPath: string;
|
|
10
|
+
readonly destinationFolderPath: string;
|
|
11
|
+
readonly generatedPortalArtifactsFolderPath: string;
|
|
12
|
+
readonly generatedPortalArtifactsZipFilePath: string;
|
|
13
|
+
}
|
|
14
|
+
export interface ErrorResponse {
|
|
15
|
+
readonly title: string;
|
|
16
|
+
readonly detail?: string;
|
|
17
|
+
readonly errors: Record<string, string[]>;
|
|
18
|
+
readonly message?: string;
|
|
19
|
+
}
|
|
20
|
+
export interface GenerateFlags {
|
|
21
|
+
readonly folder: string;
|
|
22
|
+
readonly destination: string;
|
|
23
|
+
readonly force: boolean;
|
|
24
|
+
readonly zip: boolean;
|
|
25
|
+
readonly "auth-key": string;
|
|
26
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
|
|
3
|
+
;
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMvcG9ydGFsL2dlbmVyYXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBTUMsQ0FBQyJ9
|
|
@@ -15,8 +15,9 @@ export type SDKGenerateUnprocessableError = {
|
|
|
15
15
|
export declare enum SimplePlatforms {
|
|
16
16
|
CSHARP = "CS_NET_STANDARD_LIB",
|
|
17
17
|
JAVA = "JAVA_ECLIPSE_JRE_LIB",
|
|
18
|
-
PHP = "
|
|
18
|
+
PHP = "PHP_GENERIC_LIB_V2",
|
|
19
19
|
PYTHON = "PYTHON_GENERIC_LIB",
|
|
20
20
|
RUBY = "RUBY_GENERIC_LIB",
|
|
21
|
-
TYPESCRIPT = "TS_GENERIC_LIB"
|
|
21
|
+
TYPESCRIPT = "TS_GENERIC_LIB",
|
|
22
|
+
GO = "GO_GENERIC_LIB"
|
|
22
23
|
}
|
|
@@ -5,9 +5,10 @@ var SimplePlatforms;
|
|
|
5
5
|
(function (SimplePlatforms) {
|
|
6
6
|
SimplePlatforms["CSHARP"] = "CS_NET_STANDARD_LIB";
|
|
7
7
|
SimplePlatforms["JAVA"] = "JAVA_ECLIPSE_JRE_LIB";
|
|
8
|
-
SimplePlatforms["PHP"] = "
|
|
8
|
+
SimplePlatforms["PHP"] = "PHP_GENERIC_LIB_V2";
|
|
9
9
|
SimplePlatforms["PYTHON"] = "PYTHON_GENERIC_LIB";
|
|
10
10
|
SimplePlatforms["RUBY"] = "RUBY_GENERIC_LIB";
|
|
11
11
|
SimplePlatforms["TYPESCRIPT"] = "TS_GENERIC_LIB";
|
|
12
|
+
SimplePlatforms["GO"] = "GO_GENERIC_LIB";
|
|
12
13
|
})(SimplePlatforms || (exports.SimplePlatforms = SimplePlatforms = {}));
|
|
13
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
14
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMvc2RrL2dlbmVyYXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQWlCQSxJQUFZLGVBUVg7QUFSRCxXQUFZLGVBQWU7SUFDekIsaURBQThCLENBQUE7SUFDOUIsZ0RBQTZCLENBQUE7SUFDN0IsNkNBQTBCLENBQUE7SUFDMUIsZ0RBQTZCLENBQUE7SUFDN0IsNENBQXlCLENBQUE7SUFDekIsZ0RBQTZCLENBQUE7SUFDN0Isd0NBQXFCLENBQUE7QUFDdkIsQ0FBQyxFQVJXLGVBQWUsK0JBQWYsZUFBZSxRQVExQiJ9
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2RsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL3NkbC9zZGwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
export interface Toc {
|
|
2
|
+
toc: Array<TocGroup | TocGenerated>;
|
|
3
|
+
}
|
|
4
|
+
export interface TocGroup {
|
|
5
|
+
readonly group: string;
|
|
6
|
+
readonly items: Array<TocGroup | TocGenerated | TocEndpoint | TocEndpointGroupOverview | TocModel | TocCustomPage>;
|
|
7
|
+
}
|
|
8
|
+
export interface TocGenerated {
|
|
9
|
+
readonly generate: string;
|
|
10
|
+
readonly from: string;
|
|
11
|
+
}
|
|
12
|
+
export interface TocEndpointGroupOverview {
|
|
13
|
+
readonly generate: null;
|
|
14
|
+
readonly from: "endpoint-group-overview";
|
|
15
|
+
readonly endpointGroup: string;
|
|
16
|
+
}
|
|
17
|
+
export interface TocEndpoint {
|
|
18
|
+
readonly generate: null;
|
|
19
|
+
readonly from: "endpoint";
|
|
20
|
+
readonly endpointName: string;
|
|
21
|
+
readonly endpointGroup: string;
|
|
22
|
+
}
|
|
23
|
+
export interface TocModel {
|
|
24
|
+
readonly generate: null;
|
|
25
|
+
readonly from: "model";
|
|
26
|
+
readonly modelName: string;
|
|
27
|
+
}
|
|
28
|
+
export interface TocCustomPage {
|
|
29
|
+
readonly page: string;
|
|
30
|
+
readonly file: string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
;
|
|
4
|
+
;
|
|
5
|
+
;
|
|
6
|
+
;
|
|
7
|
+
;
|
|
8
|
+
;
|
|
9
|
+
;
|
|
10
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidG9jLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL3RvYy90b2MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQyxDQUFDO0FBS0QsQ0FBQztBQUtELENBQUM7QUFNRCxDQUFDO0FBT0QsQ0FBQztBQU1ELENBQUM7QUFLRCxDQUFDIn0=
|
package/lib/utils/utils.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export declare const zipDirectoryToStream: (sourcePath: string) => Promise<NodeJ
|
|
|
22
22
|
export declare const zipDirectory: (sourcePath: string, destinationPath: string) => Promise<string>;
|
|
23
23
|
export declare const replaceHTML: (string: string) => string;
|
|
24
24
|
export declare const isJSONParsable: (json: string) => boolean;
|
|
25
|
+
export declare const getGeneratedFilesPaths: (sourceDirectoryPath: string, generatedPortalArtifactsDirectoryPath: string) => string[];
|
|
25
26
|
export declare const getFileNameFromPath: (filePath: string) => string;
|
|
26
27
|
export declare const printValidationMessages: ({ warnings, errors, messages }: ValidationMessages, { log, warn, error }: loggers) => void;
|
|
27
28
|
/**
|
|
@@ -34,6 +35,7 @@ export declare function extractZipFile(zipFilePath: string, destinationDir: stri
|
|
|
34
35
|
export declare function validateAndZipPortalSource(sourceDir: string, outputPath: string, ignoredPaths?: string[]): Promise<string>;
|
|
35
36
|
export declare function cleanUpGeneratedPortalFiles(sourceDir: string): Promise<void>;
|
|
36
37
|
export declare function isPortInUse(port: number): Promise<boolean>;
|
|
38
|
+
export declare function parseStreamBodyToJson(body: NodeJS.ReadableStream): Promise<any>;
|
|
37
39
|
export declare const getNonHiddenItemsFromDirectory: (directoryPath: string) => string[];
|
|
38
40
|
export declare const getMessageInOrangeColor: (message: string) => string;
|
|
39
41
|
export declare const getMessageInBlueColor: (message: string) => string;
|