@apimatic/cli 0.0.0-alpha.3 → 1.0.0-beta.1

package/lib/commands/api/validate.js

@@ -1,68 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs-extra");
-const command_1 = require("@oclif/command");
-const sdk_1 = require("@apimatic/sdk");
-const sdk_client_1 = require("../../client-utils/sdk-client");
-const validate_1 = require("../../controllers/api/validate");
-const utils_1 = require("../../utils/utils");
-class Validate extends command_1.Command {
+import { Command, Flags } from "@oclif/core";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { FlagsProvider } from "../../types/flags-provider.js";
+import { ValidateAction } from "../../actions/api/validate.js";
+import { format, intro, outro } from "../../prompts/format.js";
+import { createResourceInput } from "../../types/file/resource-input.js";
+class Validate extends Command {
+    constructor() {
+        super(...arguments);
+        this.getConfigDir = () => {
+            return new DirectoryPath(this.config.configDir);
+        };
+    }
     async run() {
-        const { flags } = this.parse(Validate);
-        try {
-            if (flags.file && !(await fs.pathExists(flags.file))) {
-                throw new Error(`Validation file: ${flags.file} does not exist`);
-            }
-            const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
-            const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
-            const apiValidationController = new sdk_1.APIValidationExternalApisController(client);
-            const validationSummary = await validate_1.getValidation(flags, apiValidationController);
-            const logFunctions = {
-                log: this.log,
-                warn: this.warn,
-                error: this.error
-            };
-            utils_1.printValidationMessages(validationSummary, logFunctions);
-            validationSummary.success
-                ? this.log("Specification file provided is valid")
-                : this.error("Specification file provided is invalid");
-        }
-        catch (error) {
-            if (error.result) {
-                const apiError = error;
-                const result = apiError.result;
-                if (result.modelState["exception Error"] && apiError.statusCode === 400) {
-                    this.error(utils_1.replaceHTML(result.modelState["exception Error"][0]));
-                }
-                else if (error.body && apiError.statusCode === 401) {
-                    this.error(error.body);
-                }
-                else {
-                    this.error(error.message);
-                }
-            }
-            else {
-                this.error(`${error.message}`);
-            }
-        }
+        const { flags: { file, url, "auth-key": authKey } } = await this.parse(Validate);
+        const commandMetadata = {
+            commandName: Validate.id,
+            shell: this.config.shell
+        };
+        const action = new ValidateAction(this.getConfigDir(), commandMetadata, authKey);
+        const resourceInput = createResourceInput(file, url);
+        intro("Validate API");
+        const result = await action.execute(resourceInput);
+        outro(result);
     }
 }
-exports.default = Validate;
-Validate.description = "Validate the syntactic and semantic correctness of an API specification";
+Validate.summary = "Validate API specification for syntactic and semantic correctness";
+Validate.description = `Validate your API specification to ensure it adheres to syntactic and semantic standards.`;
+Validate.cmdTxt = format.cmd("apimatic", "api", "validate");
 Validate.examples = [
-    `$ apimatic api:validate --file="./specs/sample.json"
-Specification file provided is valid
-`,
-    `$ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
-Specification file provided is valid
-`
+    `${Validate.cmdTxt} ${format.flag("file", "./specs/sample.json")}`,
+    `${Validate.cmdTxt} ${format.flag("url", '"https://petstore.swagger.io/v2/swagger.json"')}`
 ];
-Validate.flags = {
-    file: command_1.flags.string({ default: "", description: "Path to the API specification file to validate" }),
-    url: command_1.flags.string({
-        default: "",
-        description: "URL to the specification file to validate. Can be used in place of the --file option if the API specification is publicly available."
-    }),
-    // docs: flags.boolean({ default: false, description: "Validate specification for docs generation" }), // Next tier, not included in API spec
-    "auth-key": command_1.flags.string({ description: "override current authentication state with an authentication key" })
-};
+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);
+export default Validate;
+//# sourceMappingURL=validate.js.map

package/lib/commands/api/validate.js.map

@@ -0,0 +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"}

package/lib/commands/auth/login.d.ts

@@ -1,9 +1,11 @@
-import { flags, Command } from "@oclif/command";
+import { Command } from "@oclif/core";
 export default class Login extends Command {
+    static summary: string;
     static description: string;
+    private static cmdTxt;
     static examples: string[];
     static flags: {
-        "auth-key": flags.IOptionFlag<string>;
+        "auth-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/lib/commands/auth/login.js

@@ -1,60 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cli_ux_1 = require("cli-ux");
-const command_1 = require("@oclif/command");
-const utils_1 = require("../../utils/utils");
-const sdk_client_1 = require("../../client-utils/sdk-client");
-class Login extends command_1.Command {
+import { Command, Flags } from "@oclif/core";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { LoginAction } from "../../actions/auth/login.js";
+import { format, intro, outro } from "../../prompts/format.js";
+class Login extends Command {
     async run() {
-        const { flags } = this.parse(Login);
-        const configDir = this.config.configDir;
-        try {
-            const client = sdk_client_1.SDKClient.getInstance();
-            // If user is setting auth key
-            if (flags["auth-key"]) {
-                const response = client.setAuthKey(flags["auth-key"], configDir);
-                return this.log(response);
-            }
-            else {
-                // If user logs in with email and password
-                const email = await cli_ux_1.cli.prompt("Please enter your registered email");
-                const password = await cli_ux_1.cli.prompt("Please enter your password", {
-                    type: "hide"
-                });
-                const response = await client.login(email, password, configDir);
-                this.log(response);
-            }
-        }
-        catch (error) {
-            if (error && error.response) {
-                const apiError = error;
-                const apiResponse = apiError.response;
-                if (apiResponse) {
-                    const responseData = apiResponse.data;
-                    if (apiResponse.status === 403 && responseData) {
-                        return this.error(utils_1.replaceHTML(responseData));
-                    }
-                    else {
-                        return this.error(apiError.message);
-                    }
-                }
-            }
-            this.error(error.message);
+        const { flags: { "auth-key": authKey } } = await this.parse(Login);
+        if (authKey === "") {
+            this.error("Flag --auth-key must not be empty when provided.");
         }
+        const commandMetadata = {
+            commandName: Login.id,
+            shell: this.config.shell
+        };
+        intro("Login");
+        const loginAction = new LoginAction(new DirectoryPath(this.config.configDir), commandMetadata);
+        const result = await loginAction.execute(authKey);
+        outro(result);
     }
 }
-exports.default = Login;
+Login.summary = "Login to your APIMatic account";
 Login.description = "Login using your APIMatic credentials or an API Key";
+Login.cmdTxt = format.cmd('apimatic', 'auth', 'login');
 Login.examples = [
-    `$ apimatic auth:login
-Please enter your registered email: apimatic-user@gmail.com
-Please enter your password: *********
-
-You have successfully logged into APIMatic
-`,
-    `$ apimatic auth:login --auth-key=xxxxxx
-Authentication key successfully set`
+    Login.cmdTxt,
+    `${Login.cmdTxt} ${format.flag('auth-key', '{api-key}')}`
 ];
 Login.flags = {
-    "auth-key": command_1.flags.string({ default: "", description: "Set authentication key for all commands" })
+    "auth-key": Flags.string({
+        char: "k",
+        description: "Sets authentication key for all commands."
+    })
 };
+export default Login;
+//# sourceMappingURL=login.js.map

package/lib/commands/auth/login.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../../src/commands/auth/login.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAE/D,MAAqB,KAAM,SAAQ,OAAO;IAkBxC,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,EAC/B,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE5B,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,KAAK,CAAC,EAAE;YACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC,CAAC;QAC/F,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;;AAnCM,aAAO,GAAG,gCAAgC,CAAC;AAE3C,iBAAW,GAAG,qDAAqD,CAAC;AAE5D,YAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAG,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1D,cAAQ,GAAG;IAChB,KAAK,CAAC,MAAM;IACZ,GAAG,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE;CAAC,CAAC;AAEtD,WAAK,GAAG;IACb,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;QACvB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,2CAA2C;KACzD,CAAC;CACH,CAAC;eAfiB,KAAK"}

package/lib/commands/auth/logout.d.ts

@@ -1,6 +1,8 @@
-import { Command } from "@oclif/command";
-export default class Login extends Command {
+import { Command } from "@oclif/core";
+export default class Logout extends Command {
+    static summary: string;
     static description: string;
+    private static cmdTxt;
     static examples: string[];
     run(): Promise<void>;
 }

package/lib/commands/auth/logout.js

@@ -1,23 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const sdk_client_1 = require("../../client-utils/sdk-client");
-class Login extends command_1.Command {
+import { Command } from "@oclif/core";
+import { format, intro, outro } from "../../prompts/format.js";
+import { LogoutAction } from "../../actions/auth/logout.js";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+class Logout extends Command {
     async run() {
-        try {
-            const client = sdk_client_1.SDKClient.getInstance();
-            const response = await client.logout(this.config.configDir);
-            this.log(response);
-        }
-        catch (error) {
-            this.error(error);
-        }
+        intro("Logout");
+        const actionResult = await new LogoutAction(new DirectoryPath(this.config.configDir)).execute();
+        outro(actionResult);
     }
 }
-exports.default = Login;
-Login.description = "Clear local login credentials";
-Login.examples = [
-    `$ apimatic auth:logout
-Logged out
-`
-];
+Logout.summary = "Clears the local login credentials.";
+Logout.description = "Clears the local login credentials. This will also clear any cached credentials from the CLI.";
+Logout.cmdTxt = format.cmd('apimatic', 'auth', 'logout');
+Logout.examples = [Logout.cmdTxt];
+export default Logout;
+//# sourceMappingURL=logout.js.map

package/lib/commands/auth/logout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logout.js","sourceRoot":"","sources":["../../../src/commands/auth/logout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE,MAAqB,MAAO,SAAQ,OAAO;IAQzC,KAAK,CAAC,GAAG;QAEP,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChB,MAAM,YAAY,GAAG,MAAM,IAAI,YAAY,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAChG,KAAK,CAAC,YAAY,CAAC,CAAA;IACrB,CAAC;;AAZM,cAAO,GAAG,qCAAqC,CAAC;AAEhD,kBAAW,GAAG,+FAA+F,CAAC;AAEtG,aAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAG,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC3D,eAAQ,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;eANf,MAAM"}

package/lib/commands/auth/status.d.ts

@@ -1,6 +1,7 @@
-import { Command } from "@oclif/command";
+import { Command } from "@oclif/core";
 export default class Status extends Command {
     static description: string;
+    private static cmdTxt;
     static examples: string[];
     run(): Promise<void>;
 }

package/lib/commands/auth/status.js

@@ -1,23 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const sdk_client_1 = require("../../client-utils/sdk-client");
-class Status extends command_1.Command {
+import { Command } from "@oclif/core";
+import { format, intro, outro } from "../../prompts/format.js";
+import { StatusAction } from "../../actions/auth/status.js";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+class Status extends Command {
     async run() {
-        try {
-            const client = sdk_client_1.SDKClient.getInstance();
-            const response = await client.status(this.config.configDir);
-            this.log(response);
-        }
-        catch (error) {
-            this.error(error);
-        }
+        const commandMetadata = {
+            commandName: Status.id,
+            shell: this.config.shell
+        };
+        intro('Status');
+        const statusAction = new StatusAction(new DirectoryPath(this.config.configDir), commandMetadata);
+        const actionResult = await statusAction.execute(null);
+        outro(actionResult);
     }
 }
-exports.default = Status;
-Status.description = "View current authentication state";
-Status.examples = [
-    `$ apimatic auth:status
-Currently logged in as apimatic-client@gmail.com
-`
-];
+Status.description = "View the currently logged in user.";
+Status.cmdTxt = format.cmd('apimatic', 'auth', 'status');
+Status.examples = [Status.cmdTxt];
+export default Status;
+//# sourceMappingURL=status.js.map

package/lib/commands/auth/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../src/commands/auth/status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAIlE,MAAqB,MAAO,SAAQ,OAAO;IAMzC,KAAK,CAAC,GAAG;QAEP,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,MAAM,CAAC,EAAE;YACtB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,KAAK,CAAC,QAAQ,CAAC,CAAA;QACf,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC,CAAC;QACjG,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtD,KAAK,CAAC,YAAY,CAAC,CAAA;IACrB,CAAC;;AAhBM,kBAAW,GAAG,oCAAoC,CAAC;AAE3C,aAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAG,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC3D,eAAQ,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;eAJf,MAAM"}

package/lib/commands/portal/copilot.d.ts

@@ -0,0 +1,13 @@
+import { Command } from "@oclif/core";
+export default class PortalCopilot extends Command {
+    static summary: string;
+    static description: string;
+    static flags: {
+        "auth-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        disable: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static cmdTxt: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/lib/commands/portal/copilot.js

@@ -0,0 +1,34 @@
+var _a;
+import { Command, Flags } from "@oclif/core";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { FlagsProvider } from "../../types/flags-provider.js";
+import { CopilotAction } from "../../actions/portal/copilot.js";
+import { format, intro, outro } from "../../prompts/format.js";
+class PortalCopilot extends Command {
+    async run() {
+        const { flags: { input, "auth-key": authKey, disable, force } } = await this.parse(_a);
+        const commandMetadata = {
+            commandName: _a.id,
+            shell: this.config.shell
+        };
+        intro("Configure API Copilot");
+        const buildDirectory = new DirectoryPath(input !== null && input !== void 0 ? input : "./", "src");
+        const copilotConfigAction = new CopilotAction(new DirectoryPath(this.config.configDir), commandMetadata, authKey);
+        const result = await copilotConfigAction.execute(buildDirectory, force, !disable);
+        outro(result);
+    }
+}
+_a = PortalCopilot;
+PortalCopilot.summary = "Configure API Copilot for your API Documentation portal";
+PortalCopilot.description = `Displays available API Copilots associated with your account and allows you to select which one to integrate with your portal. Each APIMatic account includes one Copilot by default. The selected Copilot will be added to your ${format.var("APIMATIC-BUILD.json")} file`;
+PortalCopilot.flags = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, FlagsProvider.input), { disable: Flags.boolean({
+        default: false,
+        description: "marks the API Copilot as disabled in the configuration"
+    }) }), FlagsProvider.force), FlagsProvider.force), FlagsProvider.authKey);
+PortalCopilot.cmdTxt = format.cmd("apimatic", "portal", "copilot");
+PortalCopilot.examples = [
+    `${_a.cmdTxt} ${format.flag("input", './')}`,
+    `${_a.cmdTxt} ${format.flag("input", './')} ${format.flag("disable")}`
+];
+export default PortalCopilot;
+//# sourceMappingURL=copilot.js.map

package/lib/commands/portal/copilot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilot.js","sourceRoot":"","sources":["../../../src/commands/portal/copilot.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,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAE/D,MAAqB,aAAc,SAAQ,OAAO;IAuBhD,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,EACtD,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,EAAa,CAAC,CAAC;QAEpC,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,EAAa,CAAC,EAAE;YAC7B,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC/B,MAAM,cAAc,GAAG,IAAI,aAAa,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/D,MAAM,mBAAmB,GAAG,IAAI,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAClH,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC;QAClF,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;;;AArCM,qBAAO,GAAG,yDAAyD,AAA5D,CAA6D;AAEpE,yBAAW,GAChB,oOAAoO,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,OAAO,AAD5P,CAC6P;AAExQ,mBAAK,6EACP,aAAa,CAAC,KAAK,KACtB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACrB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,wDAAwD;KACtE,CAAC,KACC,aAAa,CAAC,KAAK,GACnB,aAAa,CAAC,KAAK,GACnB,aAAa,CAAC,OAAO,CARd,CASV;AAEK,oBAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,AAA9C,CAA+C;AACrD,sBAAQ,GAAG;IAChB,GAAG,EAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;IAC9C,GAAG,EAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;CACzE,AAHc,CAGb;eArBiB,aAAa"}

package/lib/commands/portal/generate.d.ts

@@ -1,13 +1,14 @@
-import { Command, flags } from "@oclif/command";
-export default class PortalGenerate extends Command {
+import { Command } from "@oclif/core";
+export declare class PortalGenerate extends Command {
+    static summary: string;
     static description: string;
     static flags: {
-        folder: flags.IOptionFlag<string>;
-        destination: flags.IOptionFlag<string>;
-        force: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        zip: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        "auth-key": flags.IOptionFlag<string>;
+        "auth-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        zip: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        destination: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
+    static cmdTxt: string;
     static examples: string[];
-    run(): Promise<undefined>;
+    run(): Promise<void>;
 }

package/lib/commands/portal/generate.js

@@ -1,102 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = require("path");
-const fs = require("fs-extra");
-const command_1 = require("@oclif/command");
-const sdk_1 = require("@apimatic/sdk");
-const sdk_client_1 = require("../../client-utils/sdk-client");
-const generate_1 = require("../../controllers/portal/generate");
-const utils_1 = require("../../utils/utils");
-class PortalGenerate extends command_1.Command {
+var _a;
+import { Command, Flags } from "@oclif/core";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { GenerateAction } from "../../actions/portal/generate.js";
+import { FlagsProvider } from "../../types/flags-provider.js";
+import { format, intro, outro } from "../../prompts/format.js";
+const DEFAULT_WORKING_DIRECTORY = "./";
+export class PortalGenerate extends Command {
     async run() {
-        const { flags } = this.parse(PortalGenerate);
-        const zip = flags.zip;
-        const sourceFolderPath = flags.folder;
-        const portalFolderPath = path.join(flags.destination, "generated_portal");
-        const zippedPortalPath = path.join(flags.destination, "generated_portal.zip");
-        const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
-        // Check if at destination, portal already exists and throw error if force flag is not set for both zip and extracted
-        if (fs.existsSync(portalFolderPath) && !flags.force && !zip) {
-            throw new Error(`Can't download portal to path ${portalFolderPath}, because it already exists`);
-        }
-        else if (fs.existsSync(zippedPortalPath) && !flags.force && zip) {
-            throw new Error(`Can't download portal to path ${zippedPortalPath}, because it already exists`);
-        }
-        try {
-            if (!(await fs.pathExists(flags.destination))) {
-                throw new Error(`Destination path ${flags.destination} does not exist`);
-            }
-            else if (!(await fs.pathExists(flags.folder))) {
-                throw new Error(`Portal build folder ${flags.folder} does not exist`);
-            }
-            const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
-            const docsPortalController = new sdk_1.DocsPortalManagementController(client);
-            const zippedBuildFilePath = await utils_1.zipDirectory(sourceFolderPath, flags.destination);
-            const generatePortalParams = {
-                zippedBuildFilePath,
-                portalFolderPath,
-                zippedPortalPath,
-                docsPortalController,
-                overrideAuthKey,
-                zip
-            };
-            const generatedPortalPath = await generate_1.downloadDocsPortal(generatePortalParams, this.config.configDir);
-            this.log(`Your portal has been generated at ${generatedPortalPath}`);
-        }
-        catch (error) {
-            if (error && error.response) {
-                const apiError = error;
-                const apiResponse = apiError.response;
-                if (apiResponse) {
-                    const responseData = apiResponse.data.toString();
-                    if (apiResponse.status === 422 && responseData.length > 0 && utils_1.isJSONParsable(responseData)) {
-                        const nestedErrors = JSON.parse(responseData);
-                        if (nestedErrors.error) {
-                            return this.error(utils_1.replaceHTML(nestedErrors.error));
-                        }
-                        else if (nestedErrors.message) {
-                            return this.error(utils_1.replaceHTML(nestedErrors.message));
-                        }
-                    }
-                    else if (apiResponse.status === 401 && responseData.length > 0) {
-                        this.error(utils_1.replaceHTML(responseData));
-                    }
-                    else if (apiResponse.status === 403 && apiResponse.statusText) {
-                        return this.error(utils_1.replaceHTML(apiResponse.statusText));
-                    }
-                    else {
-                        return this.error(apiError.message);
-                    }
-                }
-            }
-            else {
-                this.error(`${error.message}`);
-            }
-        }
+        const { flags: { input, destination, force, zip: zipPortal, "auth-key": authKey } } = await this.parse(_a);
+        const workingDirectory = new DirectoryPath(input !== null && input !== void 0 ? input : DEFAULT_WORKING_DIRECTORY);
+        const buildDirectory = input ? new DirectoryPath(input, "src") : workingDirectory.join("src");
+        const portalDirectory = destination ? new DirectoryPath(destination) : workingDirectory.join("portal");
+        const commandMetadata = {
+            commandName: _a.id,
+            shell: this.config.shell
+        };
+        intro("Generate Portal");
+        const action = new GenerateAction(new DirectoryPath(this.config.configDir), commandMetadata, authKey);
+        const result = await action.execute(buildDirectory, portalDirectory, force, zipPortal);
+        outro(result);
     }
 }
-exports.default = PortalGenerate;
-PortalGenerate.description = "Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)";
-PortalGenerate.flags = {
-    folder: command_1.flags.string({
-        parse: (input) => path.resolve(input),
-        default: "./",
-        description: "path to the input directory containing API specifications and config files"
-    }),
-    destination: command_1.flags.string({
-        parse: (input) => path.resolve(input),
-        default: path.resolve("./"),
-        description: "path to the downloaded portal"
-    }),
-    force: command_1.flags.boolean({ char: "f", default: false, description: "overwrite if a portal exists in the destination" }),
-    zip: command_1.flags.boolean({ default: false, description: "download the generated portal as a .zip archive" }),
-    "auth-key": command_1.flags.string({
-        default: "",
-        description: "override current authentication state with an authentication key"
-    })
-};
+_a = PortalGenerate;
+PortalGenerate.summary = "Generate an API Documentation portal";
+PortalGenerate.description = "Generate an API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)";
+PortalGenerate.flags = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, FlagsProvider.input), FlagsProvider.destination("portal", "portal")), FlagsProvider.force), { zip: Flags.boolean({
+        default: false,
+        description: "Download the generated portal as a .zip archive"
+    }) }), FlagsProvider.authKey);
+PortalGenerate.cmdTxt = format.cmd("apimatic", "portal", "generate");
 PortalGenerate.examples = [
-    `$ apimatic portal:generate --folder="./portal/" --destination="D:/"
-Your portal has been generated at D:/
-`
+    _a.cmdTxt,
+    `${_a.cmdTxt} ${format.flag("input", '"./"')} ${format.flag("destination", '"./portal"')}`
 ];
+//# sourceMappingURL=generate.js.map

package/lib/commands/portal/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/portal/generate.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAG/D,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAEvC,MAAM,OAAO,cAAe,SAAQ,OAAO;IAuBzC,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,EAC1E,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,EAAc,CAAC,CAAC;QAErC,MAAM,gBAAgB,GAAG,IAAI,aAAa,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,yBAAyB,CAAC,CAAC;QAC/E,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9F,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvG,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,EAAc,CAAC,EAAE;YAC9B,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QACtG,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QACvF,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;;;AAvCM,sBAAO,GAAG,sCAAsC,AAAzC,CAA0C;AAEjD,0BAAW,GAChB,mSAAmS,AADnR,CACoR;AAE/R,oBAAK,6EACP,aAAa,CAAC,KAAK,GACnB,aAAa,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAC7C,aAAa,CAAC,KAAK,KACtB,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC;QACjB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,iDAAiD;KAC/D,CAAC,KACC,aAAa,CAAC,OAAO,CARd,CASV;AAEK,qBAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,AAA/C,CAAgD;AACtD,uBAAQ,GAAG;IAChB,EAAI,CAAC,MAAM;IACX,GAAG,EAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE;CAC7F,AAHc,CAGb"}

package/lib/commands/portal/quickstart.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "@oclif/core";
+export default class PortalQuickstart extends Command {
+    static description: string;
+    static summary: string;
+    static cmdTxt: string;
+    static examples: string[];
+    run(): Promise<void>;
+    private readonly getConfigDir;
+}

package/lib/commands/portal/quickstart.js

@@ -0,0 +1,37 @@
+var _a;
+import { Command } from "@oclif/core";
+import { PortalQuickstartAction } from "../../actions/portal/quickstart.js";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { TelemetryService } from "../../infrastructure/services/telemetry-service.js";
+import { QuickstartInitiatedEvent } from "../../types/events/quickstart-initiated.js";
+import { QuickstartCompletedEvent } from "../../types/events/quickstart-completed.js";
+import { format, intro, outro } from "../../prompts/format.js";
+class PortalQuickstart extends Command {
+    constructor() {
+        super(...arguments);
+        this.getConfigDir = () => {
+            return new DirectoryPath(this.config.configDir);
+        };
+    }
+    async run() {
+        const telemetryService = new TelemetryService(this.getConfigDir());
+        const commandMetadata = {
+            commandName: _a.id,
+            shell: this.config.shell
+        };
+        await telemetryService.trackEvent(new QuickstartInitiatedEvent(), commandMetadata.shell);
+        intro("Portal Quickstart");
+        const action = new PortalQuickstartAction(this.getConfigDir(), commandMetadata);
+        const result = await action.execute();
+        outro(result);
+        // TODO: Remove this, find a solution for tracking.
+        await result.mapAll(async () => await telemetryService.trackEvent(new QuickstartCompletedEvent(), commandMetadata.shell), () => new Promise(() => { }), () => new Promise(() => { }));
+    }
+}
+_a = PortalQuickstart;
+PortalQuickstart.description = "Create your first API Portal using APIMatic's Docs as Code offering.";
+PortalQuickstart.summary = "Get started with your first API Portal in four easy steps.";
+PortalQuickstart.cmdTxt = format.cmd("apimatic", "portal", "quickstart");
+PortalQuickstart.examples = [_a.cmdTxt];
+export default PortalQuickstart;
+//# sourceMappingURL=quickstart.js.map

package/lib/commands/portal/quickstart.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/commands/portal/quickstart.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oDAAoD,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AAEtF,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAE/D,MAAqB,gBAAiB,SAAQ,OAAO;IAArD;;QA+BmB,iBAAY,GAAG,GAAG,EAAE;YACnC,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC,CAAC;IACJ,CAAC;IAzBC,KAAK,CAAC,GAAG;QACP,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACnE,MAAM,eAAe,GAAoB;YACvC,WAAW,EAAE,EAAgB,CAAC,EAAE;YAChC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;SACzB,CAAC;QAEF,MAAM,gBAAgB,CAAC,UAAU,CAAC,IAAI,wBAAwB,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAEzF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC3B,MAAM,MAAM,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,CAAC;QAChF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACtC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,mDAAmD;QACnD,MAAM,MAAM,CAAC,MAAM,CACjB,KAAK,IAAI,EAAE,CAAC,MAAM,gBAAgB,CAAC,UAAU,CAAC,IAAI,wBAAwB,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EACpG,GAAG,EAAE,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,EAC3B,GAAG,EAAE,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAC5B,CAAC;IACJ,CAAC;;;AA5BM,4BAAW,GAAG,sEAAsE,AAAzE,CAA0E;AAErF,wBAAO,GAAG,4DAA4D,AAA/D,CAAgE;AAEvE,uBAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,AAAjD,CAAkD;AAExD,yBAAQ,GAAG,CAAC,EAAI,CAAC,MAAM,CAAC,AAAhB,CAAiB;eAPb,gBAAgB"}

package/lib/commands/portal/recipe/new.d.ts

@@ -0,0 +1,12 @@
+import { Command } from "@oclif/core";
+export default class PortalRecipeNew extends Command {
+    static summary: string;
+    static description: string;
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static readonly cmdTxt: string;
+    static readonly examples: string[];
+    run(): Promise<void>;
+}