@choiceopen/automation-plugin-cli 0.1.3 → 0.2.2

package/dist/utils/generator.js

@@ -0,0 +1,68 @@
+import { copyFile, mkdir, readdir, writeFile } from "node:fs/promises";
+import { basename, extname, join } from "node:path";
+import { Eta } from "eta";
+export function createPluginGenerator(type, context) {
+    switch (type) {
+        case "typescript":
+            return new TypeScriptPluginGenerator(context);
+        default:
+            throw new Error(`Plugin generator type "${type}" is not implemented.`);
+    }
+}
+export class TypeScriptPluginGenerator {
+    context;
+    type = "typescript";
+    renderer = new Eta({
+        autoTrim: false,
+        autoEscape: false,
+        varName: "props",
+        views: join(import.meta.dirname, "../templates"),
+    });
+    constructor(context) {
+        this.context = context;
+        this.context.props.permissions = this.groupPermissions(this.context.props.permissions ?? []);
+    }
+    async generate() {
+        await Promise.all([
+            this.#generateFiles(join(import.meta.dirname, "../templates/common")),
+            this.#generateFiles(join(import.meta.dirname, `../templates/${this.context.props.language}`)),
+        ]);
+    }
+    async #generateFiles(source, target = this.context.target) {
+        await mkdir(target, { recursive: true });
+        for (const entry of await readdir(source, { withFileTypes: true })) {
+            const sourcePath = join(source, entry.name);
+            if (entry.isDirectory()) {
+                await this.#generateFiles(sourcePath, join(target, entry.name));
+            }
+            else {
+                if (extname(sourcePath).toLowerCase() === ".eta") {
+                    console.info(sourcePath, entry, this.renderer);
+                    const fileName = basename(sourcePath, extname(sourcePath));
+                    const templatePath = sourcePath.replace(this.renderer.config.views ?? "", "");
+                    const content = this.renderer.render(templatePath, this.context.props);
+                    const targetPath = join(target, fileName);
+                    await writeFile(targetPath, content, "utf-8");
+                }
+                else {
+                    await copyFile(sourcePath, join(target, entry.name));
+                }
+            }
+        }
+    }
+    groupPermissions(permissions) {
+        return permissions
+            .reduce((finale, permission) => {
+            const [scope, entry] = permission.split(":");
+            const existing = finale.find((item) => item.scope === scope);
+            if (existing) {
+                existing.entries.push(entry);
+            }
+            else {
+                finale.push({ scope, entries: [entry] });
+            }
+            return finale;
+        }, [])
+            .sort((a, b) => a.scope.localeCompare(b.scope, "en"));
+    }
+}

package/dist/utils/theme.d.ts

@@ -0,0 +1,13 @@
+export declare const checkboxTheme: {
+    icon: {
+        checked: string;
+        unchecked: string;
+        cursor: string;
+    };
+};
+export declare const selectTheme: {
+    icon: {
+        cursor: string;
+    };
+    indexMode: "number";
+};

package/dist/utils/theme.js

@@ -0,0 +1,13 @@
+export const checkboxTheme = {
+    icon: {
+        checked: " [✔︎]",
+        unchecked: " [ ]",
+        cursor: "→",
+    },
+};
+export const selectTheme = {
+    icon: {
+        cursor: "→",
+    },
+    indexMode: "number",
+};

package/dist/utils/views.d.ts

@@ -0,0 +1,2 @@
+import { Eta } from "eta";
+export declare const views: Eta;

package/dist/utils/views.js

@@ -0,0 +1,8 @@
+import path from "node:path";
+import { Eta } from "eta";
+export const views = new Eta({
+    autoTrim: false,
+    autoEscape: false,
+    varName: "props",
+    views: path.join(import.meta.dirname, "../templates"),
+});

package/oclif.manifest.json

@@ -1,4 +1,454 @@
 {
-  "commands": {},
-  "version": "0.1.3"
+  "commands": {
+    "auth": {
+      "aliases": [],
+      "args": {},
+      "description": "Manages your plugin via subcommands",
+      "examples": [
+        {
+          "command": "<%= config.bin %> help <%= command.id %> [COMMAND]",
+          "description": "Check help for each individual sub-command"
+        }
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "auth",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "auth",
+        "index.js"
+      ]
+    },
+    "auth:login": {
+      "aliases": [],
+      "args": {},
+      "description": "Uses device authorization flow to login with your Choiceform account by following these steps:\n\n1. Request a validation code automatically\n2. Show the validation code and a verification URL to the user\n3. Open the verification URL in the user's browser and paste the verification code\n4. Submit the validation code to complete the device authorization flow",
+      "examples": [
+        {
+          "command": "<%= config.bin %> <%= command.id %>",
+          "description": "Login by using device authorization flow"
+        }
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "auth:login",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "auth",
+        "login.js"
+      ]
+    },
+    "auth:status": {
+      "aliases": [],
+      "args": {},
+      "description": "Display the current authentication status.\n\nShows user information and session details if authenticated,\nor prompts to login if not yet authenticated.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> <%= command.id %>",
+          "description": "Check current authentication status"
+        }
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "auth:status",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "auth",
+        "status.js"
+      ]
+    },
+    "plugin:checksum": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "file to read",
+          "name": "file"
+        }
+      },
+      "description": "describe the command here",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "description": "name to print",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugin:checksum",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "checksum.js"
+      ]
+    },
+    "plugin": {
+      "aliases": [],
+      "args": {},
+      "description": "Manages your plugin via subcommands",
+      "examples": [
+        {
+          "command": "<%= config.bin %> help <%= command.id %> [COMMAND]",
+          "description": "Check help for each individual sub-command"
+        }
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "plugin",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "index.js"
+      ]
+    },
+    "plugin:init": {
+      "aliases": [],
+      "args": {},
+      "description": "Initialize a new plugin with step-by-step interactive instructions.\n\nProviding required flags skips interactive flow and completes initialization in one go.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> <%= command.id %>",
+          "description": "Start with interactive initialization:"
+        }
+      ],
+      "flags": {
+        "interactive": {
+          "char": "i",
+          "name": "interactive",
+          "summary": "Use interactive mode (by default)",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "name": "name",
+          "summary": "Plugin name",
+          "hasDynamicHelp": false,
+          "helpValue": "my-awesome-plugin",
+          "multiple": false,
+          "type": "option"
+        },
+        "description": {
+          "char": "d",
+          "name": "description",
+          "summary": "Short description",
+          "default": "",
+          "hasDynamicHelp": false,
+          "helpValue": "Descriptive text...",
+          "multiple": false,
+          "type": "option"
+        },
+        "author": {
+          "char": "a",
+          "name": "author",
+          "summary": "Author name",
+          "default": "",
+          "hasDynamicHelp": false,
+          "helpValue": "John Doe",
+          "multiple": false,
+          "type": "option"
+        },
+        "email": {
+          "char": "e",
+          "name": "email",
+          "summary": "Author email address",
+          "default": "",
+          "hasDynamicHelp": false,
+          "helpValue": "john.doe@example.com",
+          "multiple": false,
+          "type": "option"
+        },
+        "url": {
+          "char": "u",
+          "name": "url",
+          "summary": "Repository URL",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "locales": {
+          "name": "locales",
+          "summary": "Provide READMEs in which languages",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "en_US",
+            "zh_Hans",
+            "ja_JP"
+          ],
+          "type": "option"
+        },
+        "language": {
+          "char": "l",
+          "name": "language",
+          "summary": "Programming language to use for plugin development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "elixir",
+            "python",
+            "typescript"
+          ],
+          "type": "option"
+        },
+        "type": {
+          "char": "t",
+          "name": "type",
+          "summary": "Plugin type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "extension",
+            "llm",
+            "tool",
+            "trigger"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugin:init",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "init.js"
+      ]
+    },
+    "plugin:pack": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "file to read",
+          "name": "file"
+        }
+      },
+      "description": "describe the command here",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "description": "name to print",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugin:pack",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "pack.js"
+      ]
+    },
+    "plugin:permission": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "file to read",
+          "name": "file"
+        }
+      },
+      "description": "describe the command here",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "description": "name to print",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugin:permission",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "permission.js"
+      ]
+    },
+    "plugin:refresh-key": {
+      "aliases": [],
+      "args": {},
+      "description": "Refresh or create API Key for plugin debugging in development stage.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugin:refresh-key",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "refresh-key.js"
+      ]
+    },
+    "plugin:run": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "file to read",
+          "name": "file"
+        }
+      },
+      "description": "describe the command here",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "description": "name to print",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugin:run",
+      "pluginAlias": "@choiceopen/automation-plugin-cli",
+      "pluginName": "@choiceopen/automation-plugin-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugin",
+        "run.js"
+      ]
+    }
+  },
+  "version": "0.2.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@choiceopen/automation-plugin-cli",
-  "version": "0.1.3",
-  "description": "A command-line utility for building and publishing Choiceform Automation Plugin.",
+  "version": "0.2.2",
+  "description": "A command-line utility for building and publishing Choiceform Atomemo Plugin.",
   "keywords": [
     "oclif"
   ],
@@ -17,7 +17,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
-    "automation": "bin/run.js",
+    "atomemo": "bin/run.js",
     "cap": "bin/run.js"
   },
   "files": [
@@ -36,12 +36,11 @@
   },
   "oclif": {
     "alias": [
-      "automation",
-      "cap"
+      "atomemo"
     ],
-    "bin": "automation",
+    "bin": "atomemo",
     "commands": "./dist/commands",
-    "dirname": "automation",
+    "dirname": "atomemo",
     "helpOptions": {
       "flagSortOrder": "none"
     },
@@ -54,10 +53,10 @@
     "topicSeparator": " "
   },
   "dependencies": {
-    "@inquirer/checkbox": "^5.0.3",
+    "@inquirer/checkbox": "^5.0.4",
     "@inquirer/confirm": "^6.0.3",
-    "@inquirer/input": "^5.0.3",
-    "@inquirer/select": "^5.0.3",
+    "@inquirer/input": "^5.0.4",
+    "@inquirer/select": "^5.0.4",
     "@oclif/core": "^4.8.0",
     "@oclif/plugin-autocomplete": "^3.2.39",
     "@oclif/plugin-help": "^6.2.36",
@@ -77,7 +76,7 @@
     "@types/node": "20.19.27",
     "chai": "4.5.0",
     "mocha": "10.8.2",
-    "oclif": "^4.22.63",
+    "oclif": "^4.22.65",
     "shx": "^0.4.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3"