@choiceopen/automation-plugin-cli 0.0.1

package/README.md

@@ -0,0 +1,274 @@
+automation-plugin-cli
+=================
+
+A command-line utility for building and publishing Choiceform Automation Plugin.
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/automation-plugin-cli.svg)](https://npmjs.org/package/automation-plugin-cli)
+[![Downloads/week](https://img.shields.io/npm/dw/automation-plugin-cli.svg)](https://npmjs.org/package/automation-plugin-cli)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @choiceopen/automation-plugin-cli
+$ automation COMMAND
+running command...
+$ automation (--version)
+@choiceopen/automation-plugin-cli/0.0.1 darwin-arm64 node-v24.12.0
+$ automation --help [COMMAND]
+USAGE
+  $ automation COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`automation auth login`](#automation-auth-login)
+* [`automation autocomplete [SHELL]`](#automation-autocomplete-shell)
+* [`automation help [COMMAND]`](#automation-help-command)
+* [`automation plugin checksum [FILE]`](#automation-plugin-checksum-file)
+* [`automation plugin init`](#automation-plugin-init)
+* [`automation plugin pack [FILE]`](#automation-plugin-pack-file)
+* [`automation plugin permission [FILE]`](#automation-plugin-permission-file)
+* [`automation plugin run [FILE]`](#automation-plugin-run-file)
+* [`automation version`](#automation-version)
+
+## `automation auth login`
+
+Uses device authorization flow to login with your Choiceform account by following these steps:
+
+```
+USAGE
+  $ automation auth login
+
+DESCRIPTION
+  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
+
+EXAMPLES
+  Login by using device authorization flow
+
+    $ automation auth login
+```
+
+_See code: [src/commands/auth/login.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/auth/login.ts)_
+
+## `automation autocomplete [SHELL]`
+
+Display autocomplete installation instructions.
+
+```
+USAGE
+  $ automation autocomplete [SHELL] [-r]
+
+ARGUMENTS
+  [SHELL]  (zsh|bash|powershell) Shell type
+
+FLAGS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+DESCRIPTION
+  Display autocomplete installation instructions.
+
+EXAMPLES
+  $ automation autocomplete
+
+  $ automation autocomplete bash
+
+  $ automation autocomplete zsh
+
+  $ automation autocomplete powershell
+
+  $ automation autocomplete --refresh-cache
+```
+
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.39/src/commands/autocomplete/index.ts)_
+
+## `automation help [COMMAND]`
+
+Display help for automation.
+
+```
+USAGE
+  $ automation help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for automation.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
+
+## `automation plugin checksum [FILE]`
+
+describe the command here
+
+```
+USAGE
+  $ automation plugin checksum [FILE] [-f] [-n <value>]
+
+ARGUMENTS
+  [FILE]  file to read
+
+FLAGS
+  -f, --force
+  -n, --name=<value>  name to print
+
+DESCRIPTION
+  describe the command here
+
+EXAMPLES
+  $ automation plugin checksum
+```
+
+_See code: [src/commands/plugin/checksum.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/checksum.ts)_
+
+## `automation plugin init`
+
+Initialize a new plugin with step-by-step interactive instructions.
+
+```
+USAGE
+  $ automation plugin init [-i] [-n my-awesome-plugin] [-d Descriptive
+    text...] [-a John Doe] [-e john.doe@example.com] [-u <value>] [--locales en_US|zh_Hans|ja_JP...] [-l
+    elixir|python|typescript] [-t extension|llm|tool|trigger] [-p endpoints:register|model:call_llm|model:call_embedding
+    |model:call_moderation|model:call_rerank|model:call_stt|model:call_tts|storage:kv|tools:invoke...]
+
+FLAGS
+  -a, --author=John Doe                  Author name
+  -d, --description=Descriptive text...  Short description
+  -e, --email=john.doe@example.com       Author email address
+  -i, --[no-]interactive                 Use interactive mode (by default)
+  -l, --language=<option>                Programming language to use for plugin development
+                                         <options: elixir|python|typescript>
+  -n, --name=my-awesome-plugin           Plugin name
+  -p, --permissions=<option>...          Permissions required by the plugin
+                                         <options:
+                                         endpoints:register|model:call_llm|model:call_embedding|model:call_moderation|mo
+                                         del:call_rerank|model:call_stt|model:call_tts|storage:kv|tools:invoke>
+  -t, --type=<option>                    Plugin type
+                                         <options: extension|llm|tool|trigger>
+  -u, --url=<value>                      Repository URL
+      --locales=<option>...              Provide READMEs in which languages
+                                         <options: en_US|zh_Hans|ja_JP>
+
+DESCRIPTION
+  Initialize a new plugin with step-by-step interactive instructions.
+
+  Providing required flags skips interactive flow and completes initialization in one go.
+
+EXAMPLES
+  Start with interactive initialization:
+
+    $ automation plugin init
+```
+
+_See code: [src/commands/plugin/init.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/init.ts)_
+
+## `automation plugin pack [FILE]`
+
+describe the command here
+
+```
+USAGE
+  $ automation plugin pack [FILE] [-f] [-n <value>]
+
+ARGUMENTS
+  [FILE]  file to read
+
+FLAGS
+  -f, --force
+  -n, --name=<value>  name to print
+
+DESCRIPTION
+  describe the command here
+
+EXAMPLES
+  $ automation plugin pack
+```
+
+_See code: [src/commands/plugin/pack.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/pack.ts)_
+
+## `automation plugin permission [FILE]`
+
+describe the command here
+
+```
+USAGE
+  $ automation plugin permission [FILE] [-f] [-n <value>]
+
+ARGUMENTS
+  [FILE]  file to read
+
+FLAGS
+  -f, --force
+  -n, --name=<value>  name to print
+
+DESCRIPTION
+  describe the command here
+
+EXAMPLES
+  $ automation plugin permission
+```
+
+_See code: [src/commands/plugin/permission.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/permission.ts)_
+
+## `automation plugin run [FILE]`
+
+describe the command here
+
+```
+USAGE
+  $ automation plugin run [FILE] [-f] [-n <value>]
+
+ARGUMENTS
+  [FILE]  file to read
+
+FLAGS
+  -f, --force
+  -n, --name=<value>  name to print
+
+DESCRIPTION
+  describe the command here
+
+EXAMPLES
+  $ automation plugin run
+```
+
+_See code: [src/commands/plugin/run.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/run.ts)_
+
+## `automation version`
+
+```
+USAGE
+  $ automation version [--json] [--verbose]
+
+FLAGS
+  --verbose  Show additional information about the CLI.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+FLAG DESCRIPTIONS
+  --verbose  Show additional information about the CLI.
+
+    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
+```
+
+_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.36/src/commands/version.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=DeprecationWarning --disable-warning=ExperimentalWarning --trace-deprecation
+
+import { execute } from "@oclif/core"
+
+await execute({ development: true, dir: import.meta.url })

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from "@oclif/core"
+
+await execute({ dir: import.meta.url })

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

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

package/dist/commands/auth/index.js

@@ -0,0 +1,15 @@
+import { Command } from "@oclif/core";
+export default class Auth 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", ["auth"]);
+    }
+}

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

@@ -0,0 +1,15 @@
+import { Command } from "@oclif/core";
+export default class AuthLogin extends Command {
+    static description: string;
+    static examples: {
+        command: string;
+        description: string;
+    }[];
+    static flags: {};
+    private pollingInterval;
+    private client_id;
+    private grant_type;
+    run(): Promise<void>;
+    private requestDeviceCode;
+    private pollForToken;
+}

package/dist/commands/auth/login.js

@@ -0,0 +1,115 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,33 @@
+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;
+}