@choiceopen/automation-plugin-cli 0.0.1 → 0.1.3

package/dist/commands/auth/login.js

@@ -1,115 +0,0 @@
-import confirm from "@inquirer/confirm";
-import { Command } from "@oclif/core";
-import { colorize } from "@oclif/core/ux";
-import { assert } from "es-toolkit";
-import open from "open";
-import { dedent } from "ts-dedent";
-import yoctoSpinner from "yocto-spinner";
-import * as configStore from "../../utils/config.js";
-export default class AuthLogin extends Command {
-    static description = dedent `
-    Uses device authorization flow to login with your Choiceform account by following these steps:
-
-    1. Request a validation code automatically
-    2. Show the validation code and a verification URL to the user
-    3. Open the verification URL in the user's browser and paste the verification code
-    4. Submit the validation code to complete the device authorization flow
-  `;
-    static examples = [
-        {
-            command: "<%= config.bin %> <%= command.id %>",
-            description: "Login by using device authorization flow",
-        },
-    ];
-    static flags = {};
-    pollingInterval = 5;
-    client_id = "automation_plugin_cli";
-    grant_type = "urn:ietf:params:oauth:grant-type:device_code";
-    async run() {
-        await this.parse(AuthLogin);
-        const config = await configStore.load();
-        assert(config.auth?.endpoint, "Auth endpoint is required");
-        const payload = await this.requestDeviceCode(config.auth.endpoint);
-        this.log(colorize("yellowBright", "Starting device authorization flow...\n"));
-        this.log(colorize("bold", colorize("gray", "Verification URL : ")), payload.verification_uri);
-        this.log(colorize("bold", colorize("gray", "Verification Code: ")), `${payload.user_code}\n`);
-        const autoOpen = await confirm({
-            message: dedent `
-      Do you want to open the verification URL in your browser automatically?
-        If not, you can manually open the URL and paste the code.
-    `,
-        });
-        if (autoOpen) {
-            await open(payload.verification_uri_complete);
-        }
-        const spinner = yoctoSpinner({ text: "Polling for token..." }).start();
-        const result = (await this.pollForToken(payload.device_code, spinner));
-        await configStore.update({ auth: { access_token: result.access_token } });
-        const session = await fetch(`${config.auth.endpoint}/v1/auth/get-session`, {
-            headers: {
-                "Content-Type": "application/json",
-                "User-Agent": "Choiceform (Automation Plugin CLI)",
-                Authorization: `Bearer ${result.access_token}`,
-            },
-        }).then((response) => response.json());
-        this.log(colorize("greenBright", dedent `
-      Welcome back, ${session.user.name} <${session.user.email}>!
-      To create a new plugin, you can use the following command:
-      \`${colorize("bold", colorize("yellowBright", "automation plugin init"))}\`
-    `));
-    }
-    async requestDeviceCode(endpoint) {
-        const response = await fetch(`${endpoint}/v1/auth/device/code`, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "User-Agent": "Choiceform (Automation Plugin CLI)",
-            },
-            body: JSON.stringify({ client_id: this.client_id }),
-        });
-        return (await response.json());
-    }
-    async pollForToken(device_code, spinner) {
-        return new Promise((resolve) => {
-            const poll = async () => {
-                const response = await fetch("http://localhost:5001/v1/auth/device/token", {
-                    method: "POST",
-                    headers: {
-                        "Content-Type": "application/json",
-                        "User-Agent": "Choiceform (Automation Plugin CLI)",
-                    },
-                    body: JSON.stringify({
-                        grant_type: this.grant_type,
-                        client_id: this.client_id,
-                        device_code,
-                    }),
-                });
-                const payload = (await response.json());
-                if (payload.error) {
-                    switch (payload.error) {
-                        case "authorization_pending":
-                            setTimeout(poll, this.pollingInterval * 1000);
-                            break;
-                        case "slow_down":
-                            this.pollingInterval += 5;
-                            break;
-                        case "access_denied":
-                            spinner.error("Access was denied by the user");
-                            return process.exit(0);
-                        case "expired_token":
-                            spinner.error("The device code has expired. Please try again.");
-                            return process.exit(0);
-                        default:
-                            spinner.error(`Error: ${payload.error_description}`);
-                            return process.exit(1);
-                    }
-                }
-                else {
-                    spinner.success("Token acquired successfully\n");
-                    resolve(payload);
-                }
-            };
-            setTimeout(poll, this.pollingInterval * 1000);
-        });
-    }
-}

package/dist/commands/plugin/checksum.d.ts

@@ -1,13 +0,0 @@
-import { Command } from "@oclif/core";
-export default class PluginChecksum extends Command {
-    static args: {
-        file: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/plugin/checksum.js

@@ -1,22 +0,0 @@
-import { Args, Command, Flags } from "@oclif/core";
-export default class PluginChecksum extends Command {
-    static args = {
-        file: Args.string({ description: "file to read" }),
-    };
-    static description = "describe the command here";
-    static examples = ["<%= config.bin %> <%= command.id %>"];
-    static flags = {
-        // flag with no value (-f, --force)
-        force: Flags.boolean({ char: "f" }),
-        // flag with a value (-n, --name=VALUE)
-        name: Flags.string({ char: "n", description: "name to print" }),
-    };
-    async run() {
-        const { args, flags } = await this.parse(PluginChecksum);
-        const name = flags.name ?? "world";
-        this.log(`hello ${name} from /Users/nightire/Code/github.com/choice-open/automation-plugin-cli/src/commands/plugin/checksum.ts`);
-        if (args.file && flags.force) {
-            this.log(`you input --force and --file: ${args.file}`);
-        }
-    }
-}

package/dist/commands/plugin/index.d.ts

@@ -1,11 +0,0 @@
-import { Command } from "@oclif/core";
-export default class Plugin extends Command {
-    static description: string;
-    static enableJsonFlag: boolean;
-    static examples: {
-        command: string;
-        description: string;
-    }[];
-    static hidden: boolean;
-    run(): Promise<void>;
-}

package/dist/commands/plugin/index.js

@@ -1,15 +0,0 @@
-import { Command } from "@oclif/core";
-export default class Plugin extends Command {
-    static description = "Manages your plugin via subcommands";
-    static enableJsonFlag = true;
-    static examples = [
-        {
-            command: "<%= config.bin %> help <%= command.id %> [COMMAND]",
-            description: "Check help for each individual sub-command",
-        },
-    ];
-    static hidden = true;
-    async run() {
-        await this.config.runCommand("help", ["plugin"]);
-    }
-}

package/dist/commands/plugin/init.d.ts

@@ -1,33 +0,0 @@
-import { Command } from "@oclif/core";
-export default class PluginInit extends Command {
-    static description: string;
-    static examples: {
-        command: string;
-        description: string;
-    }[];
-    static flags: {
-        interactive: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        description: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        author: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        email: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        url: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        locales: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        language: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        type: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        permissions: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-    private nameIsValid;
-    private reconcileInteractiveFlag;
-    private runInteractiveMode;
-    private collectName;
-    private collectDescription;
-    private collectAuthor;
-    private collectEmail;
-    private collectURL;
-    private collectLocales;
-    private collectLanguage;
-    private collectType;
-    private collectPermissions;
-}

package/dist/commands/plugin/init.js

@@ -1,363 +0,0 @@
-import path from "node:path";
-import checkbox, { Separator } from "@inquirer/checkbox";
-import input from "@inquirer/input";
-import select from "@inquirer/select";
-import { Command, Flags } from "@oclif/core";
-import { colorize } from "@oclif/core/ux";
-import { assert, isString } from "es-toolkit";
-import { dedent } from "ts-dedent";
-import z from "zod";
-import { createPluginGenerator } from "../../utils/generator.js";
-import { checkboxTheme, selectTheme } from "../../utils/theme.js";
-const LOCALES = ["en_US", "zh_Hans", "ja_JP"];
-const LANGUAGES = ["elixir", "python", "typescript"];
-const PERMISSIONS = [
-    "endpoints:register",
-    "model:call_llm",
-    "model:call_embedding",
-    "model:call_moderation",
-    "model:call_rerank",
-    "model:call_stt",
-    "model:call_tts",
-    "storage:kv",
-    "tools:invoke",
-];
-export default class PluginInit extends Command {
-    static description = dedent `
-    Initialize a new plugin with step-by-step interactive instructions.
-
-    Providing required flags skips interactive flow and completes initialization in one go.
-  `;
-    static examples = [
-        {
-            command: "<%= config.bin %> <%= command.id %>",
-            description: "Start with interactive initialization:",
-        },
-    ];
-    static flags = {
-        interactive: Flags.boolean({
-            allowNo: true,
-            char: "i",
-            default: true,
-            summary: "Use interactive mode (by default)",
-        }),
-        name: Flags.string({
-            char: "n",
-            helpValue: "my-awesome-plugin",
-            summary: "Plugin name",
-        }),
-        description: Flags.string({
-            char: "d",
-            default: "",
-            helpValue: "Descriptive text...",
-            summary: "Short description",
-        }),
-        author: Flags.string({
-            char: "a",
-            default: "",
-            helpValue: "John Doe",
-            summary: "Author name",
-        }),
-        email: Flags.string({
-            char: "e",
-            default: "",
-            helpValue: "john.doe@example.com",
-            summary: "Author email address",
-        }),
-        url: Flags.string({
-            char: "u",
-            default: "",
-            summary: "Repository URL",
-        }),
-        locales: Flags.option({
-            multiple: true,
-            options: LOCALES,
-        })({
-            delimiter: ",",
-            summary: "Provide READMEs in which languages",
-        }),
-        language: Flags.option({
-            multiple: false,
-            options: LANGUAGES,
-        })({
-            char: "l",
-            summary: "Programming language to use for plugin development",
-        }),
-        type: Flags.option({
-            multiple: false,
-            options: ["extension", "llm", "tool", "trigger"],
-        })({
-            char: "t",
-            summary: "Plugin type",
-        }),
-        permissions: Flags.option({
-            multiple: true,
-            options: PERMISSIONS,
-        })({
-            char: "p",
-            delimiter: ",",
-            summary: "Permissions required by the plugin",
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(PluginInit);
-        this.reconcileInteractiveFlag(flags);
-        if (flags.interactive) {
-            await this.runInteractiveMode(flags);
-        }
-        assert(flags.name, "flags.name should be valid here...");
-        assert(flags.language, "flags.language should be valid here...");
-        const generator = createPluginGenerator(flags.language, {
-            props: { ...flags, createdAt: new Date().toISOString() },
-            target: path.join(process.cwd(), flags.name),
-        });
-        await generator.generate();
-    }
-    nameIsValid(name) {
-        return isString(name) && /^[a-z][a-z0-9_-]{2,62}[a-z0-9]$/.test(name);
-    }
-    reconcileInteractiveFlag(flags) {
-        if (flags.interactive && this.nameIsValid(flags.name)) {
-            flags.interactive = false;
-        }
-        if (!flags.interactive && !this.nameIsValid(flags.name)) {
-            this.log(colorize("redBright", dedent `
-            Without interactive mode, you should provide initial information manually.
-            Use ${colorize("blue", "automation help plugin init")} to see all available options.
-          `));
-            this.exit(0);
-        }
-    }
-    async runInteractiveMode(flags) {
-        this.log(dedent `
-      Guiding you through creating a new plugin in interactive mode
-      Please follow the instructions below to complete the process:\n
-    `);
-        try {
-            flags.name = await this.collectName();
-            flags.description = await this.collectDescription();
-            flags.author = await this.collectAuthor();
-            flags.email = await this.collectEmail();
-            flags.url = await this.collectURL();
-            flags.locales = await this.collectLocales(flags);
-            flags.language = await this.collectLanguage();
-            flags.type = await this.collectType();
-            flags.permissions = await this.collectPermissions(flags);
-        }
-        catch (error) {
-            if (error instanceof Error && error.name === "ExitPromptError") {
-                process.exit(0);
-            }
-            throw error;
-        }
-    }
-    async collectName() {
-        return await input({
-            message: "What's the name of this new plugin:",
-            pattern: /^[a-z][a-z0-9_-]{2,62}[a-z0-9]$/,
-            patternError: dedent `
-        You must provide a name for the new plugin:
-          - Only lowercase letters, digits, underscores, and hyphens are allowed
-          - Minimum length of 4 and maximum length of 64
-          - Starts with a lowercase letter (not a digit)
-          - Ends with a lowercase letter or digit (not underscore or hyphen)
-      `,
-        });
-    }
-    async collectDescription() {
-        return await input({
-            message: "How do you describe this new plugin:",
-            default: "A brief description of the plugin's functionality",
-            prefill: "tab",
-            pattern: /^.{16,256}$/,
-            patternError: dedent `
-        You must provide a description for the new plugin:
-          - Allows any characters, minimum 16 characters, maximum 256 characters
-      `,
-        });
-    }
-    async collectAuthor() {
-        return await input({
-            message: "Who is the author of the new plugin:",
-            default: "John Doe",
-            prefill: "tab",
-            pattern: /^.{2,64}$/,
-            patternError: dedent `
-        You must provide the author name:
-          - Allows any characters, minimum 2 characters, maximum 64 characters
-      `,
-        });
-    }
-    async collectEmail() {
-        return await input({
-            message: "What is the email address of the author:",
-            default: "john.doe@example.com",
-            prefill: "tab",
-            pattern: /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(?:\.[a-zA-Z]{2,})*$/,
-            patternError: dedent `You must provide the author email`,
-        });
-    }
-    async collectURL() {
-        return await input({
-            message: "What is the repository URL address (Optional):",
-            default: "https://github.com/[user]/[repo]",
-            prefill: "tab",
-            validate: (value) => {
-                const { success } = z
-                    .url({ normalize: true, protocol: /https?|git/ })
-                    .optional()
-                    .safeParse(value);
-                return success || "You must provide a valid URL";
-            },
-        });
-    }
-    async collectLocales(flags) {
-        const values = await checkbox({
-            choices: [
-                {
-                    checked: flags.locales?.includes("en_US"),
-                    disabled: "(required)",
-                    name: "English",
-                    description: "English (United States)",
-                    value: "en_US",
-                },
-                {
-                    checked: flags.locales?.includes("zh_Hans"),
-                    disabled: false,
-                    name: "简体中文",
-                    description: "Simplified Chinese (China)",
-                    value: "zh_Hans",
-                },
-                {
-                    checked: flags.locales?.includes("ja_JP"),
-                    disabled: false,
-                    name: "日本語",
-                    description: "Japanese (Japan)",
-                    value: "ja_JP",
-                },
-            ],
-            message: "Provide READMEs in which language(s)?",
-            theme: checkboxTheme,
-        });
-        return ["en_US", ...values];
-    }
-    async collectLanguage() {
-        return await select({
-            choices: [
-                {
-                    name: "Elixir",
-                    value: "elixir",
-                },
-                {
-                    name: "Python",
-                    value: "python",
-                },
-                {
-                    name: "TypeScript",
-                    value: "typescript",
-                },
-            ],
-            message: "What programming language do you prefer for developing this plugin?",
-            theme: selectTheme,
-        });
-    }
-    async collectType() {
-        return await select({
-            choices: [
-                {
-                    name: "Extension",
-                    value: "extension",
-                    description: "Extend capabilities by integrating with external APIs.",
-                },
-                {
-                    name: "Model",
-                    value: "llm",
-                    description: "Introduce more LLMs to enhance AI capabilities.",
-                },
-                {
-                    name: "Tool",
-                    value: "tool",
-                    description: "Complete specific tasks, typically invoked by LLMs.",
-                },
-                {
-                    name: "Trigger",
-                    value: "trigger",
-                    description: "Run workflows by receiving events through webhooks.",
-                },
-            ],
-            message: dedent `
-        ${colorize("blue", "Choose the type of the new plugin")}
-
-        Plugins can extend the platform's capabilities in multiple ways, making workflows more flexible and powerful.
-        Based on your specific requirement, plugins can be categorized into the following types:
-
-          - ${colorize("yellowBright", "Extension")}: Provide more functionality to workflows by integrating external service APIs
-          - ${colorize("yellowBright", "Model")}:     Access more large language models to enrich the AI capabilities of workflows
-          - ${colorize("yellowBright", "Tool")}:      Customized logic to perform specific tasks, typically invoked by LLMs and/or Agents
-          - ${colorize("yellowBright", "Trigger")}:   Receive external events through webhooks to start workflows with initial input data
-
-        Please select the matching type from the following options:
-      `,
-            theme: selectTheme,
-        });
-    }
-    async collectPermissions(flags) {
-        return await checkbox({
-            choices: [
-                new Separator(colorize("yellowBright", " ⎯⎯⎯⎯⎯  Endpoints ⎯⎯⎯⎯⎯")),
-                {
-                    checked: flags.permissions?.includes("endpoints:register"),
-                    value: "endpoints:register",
-                    description: "Ability to register API endpoints",
-                },
-                new Separator(colorize("yellowBright", " ⎯⎯⎯⎯⎯    Model   ⎯⎯⎯⎯⎯")),
-                {
-                    checked: flags.permissions?.includes("model:call_llm"),
-                    value: "model:call_llm",
-                    description: "Ability to call LLMs",
-                },
-                {
-                    checked: flags.permissions?.includes("model:call_embedding"),
-                    value: "model:call_embedding",
-                    description: "Ability to call embeddings models",
-                },
-                {
-                    checked: flags.permissions?.includes("model:call_moderation"),
-                    value: "model:call_moderation",
-                    description: "Ability to call moderation models",
-                },
-                {
-                    checked: flags.permissions?.includes("model:call_rerank"),
-                    value: "model:call_rerank",
-                    description: "Ability to call rerank models",
-                },
-                {
-                    checked: flags.permissions?.includes("model:call_stt"),
-                    value: "model:call_stt",
-                    description: "Ability to call STT models",
-                },
-                {
-                    checked: flags.permissions?.includes("model:call_tts"),
-                    value: "model:call_tts",
-                    description: "Ability to call TTS models",
-                },
-                new Separator(colorize("yellowBright", " ⎯⎯⎯⎯⎯   Storage  ⎯⎯⎯⎯⎯")),
-                {
-                    checked: flags.permissions?.includes("storage:kv"),
-                    value: "storage:kv",
-                    description: "Ability to use key-value storage",
-                },
-                new Separator(colorize("yellowBright", " ⎯⎯⎯⎯⎯    Tools   ⎯⎯⎯⎯⎯")),
-                {
-                    checked: flags.permissions?.includes("tools:invoke"),
-                    value: "tools:invoke",
-                    description: "Ability to invoke other tools",
-                },
-            ],
-            loop: false,
-            pageSize: 15,
-            message: "Select required permissions for the plugin:",
-            theme: checkboxTheme,
-        });
-    }
-}

package/dist/commands/plugin/pack.d.ts

@@ -1,13 +0,0 @@
-import { Command } from "@oclif/core";
-export default class PluginPack extends Command {
-    static args: {
-        file: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/plugin/pack.js

@@ -1,22 +0,0 @@
-import { Args, Command, Flags } from "@oclif/core";
-export default class PluginPack extends Command {
-    static args = {
-        file: Args.string({ description: "file to read" }),
-    };
-    static description = "describe the command here";
-    static examples = ["<%= config.bin %> <%= command.id %>"];
-    static flags = {
-        // flag with no value (-f, --force)
-        force: Flags.boolean({ char: "f" }),
-        // flag with a value (-n, --name=VALUE)
-        name: Flags.string({ char: "n", description: "name to print" }),
-    };
-    async run() {
-        const { args, flags } = await this.parse(PluginPack);
-        const name = flags.name ?? "world";
-        this.log(`hello ${name} from /Users/nightire/Code/github.com/choice-open/automation-plugin-cli/src/commands/plugin/pack.ts`);
-        if (args.file && flags.force) {
-            this.log(`you input --force and --file: ${args.file}`);
-        }
-    }
-}

package/dist/commands/plugin/permission.d.ts

@@ -1,13 +0,0 @@
-import { Command } from "@oclif/core";
-export default class PluginPermission extends Command {
-    static args: {
-        file: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/plugin/permission.js

@@ -1,22 +0,0 @@
-import { Args, Command, Flags } from "@oclif/core";
-export default class PluginPermission extends Command {
-    static args = {
-        file: Args.string({ description: "file to read" }),
-    };
-    static description = "describe the command here";
-    static examples = ["<%= config.bin %> <%= command.id %>"];
-    static flags = {
-        // flag with no value (-f, --force)
-        force: Flags.boolean({ char: "f" }),
-        // flag with a value (-n, --name=VALUE)
-        name: Flags.string({ char: "n", description: "name to print" }),
-    };
-    async run() {
-        const { args, flags } = await this.parse(PluginPermission);
-        const name = flags.name ?? "world";
-        this.log(`hello ${name} from /Users/nightire/Code/github.com/choice-open/automation-plugin-cli/src/commands/plugin/permission.ts`);
-        if (args.file && flags.force) {
-            this.log(`you input --force and --file: ${args.file}`);
-        }
-    }
-}

package/dist/commands/plugin/run.d.ts

@@ -1,13 +0,0 @@
-import { Command } from "@oclif/core";
-export default class PluginRun extends Command {
-    static args: {
-        file: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}