@bpmnkit/cli 0.0.14 → 0.0.16

package/README.md

@@ -106,6 +106,9 @@ casen instances list --state active
 | [`@bpmnkit/operate`](https://www.npmjs.com/package/@bpmnkit/operate) | Monitoring & operations frontend for Camunda clusters |
 | [`@bpmnkit/connector-gen`](https://www.npmjs.com/package/@bpmnkit/connector-gen) | Generate connector templates from OpenAPI specs |
 | [`@bpmnkit/proxy`](https://www.npmjs.com/package/@bpmnkit/proxy) | Local AI bridge and Camunda API proxy server |
+| [`@bpmnkit/cli-sdk`](https://www.npmjs.com/package/@bpmnkit/cli-sdk) | Plugin authoring SDK for the casen CLI |
+| [`@bpmnkit/create-casen-plugin`](https://www.npmjs.com/package/@bpmnkit/create-casen-plugin) | Scaffold a new casen CLI plugin in seconds |
+| [`@bpmnkit/casen-report`](https://www.npmjs.com/package/@bpmnkit/casen-report) | HTML reports from Camunda 8 incident and SLA data |
 
 ## License
 

package/dist/commands/index.js

@@ -4,6 +4,7 @@ import { askGroup } from "./ask.js";
 import { getDmnReqsXmlCmd, getDmnXmlCmd, getStartFormCmd, getUserTaskFormCmd, getXmlCmd, renderBpmnCmd, } from "./bpmn.js";
 import { completionGroup } from "./completion.js";
 import { connectorGroup } from "./connector.js";
+import { pluginGroup } from "./plugin.js";
 import { profileGroup } from "./profile.js";
 import { computeRelations } from "./relations.js";
 import { settingsGroup } from "./settings.js";
@@ -35,6 +36,7 @@ const customisedGroups = generatedCommandGroups.map((g) => {
 });
 const sortedOtherGroups = [
     connectorGroup,
+    pluginGroup,
     ...customisedGroups,
     ...adminCommandGroups,
     completionGroup,

package/dist/commands/plugin.js

@@ -0,0 +1,244 @@
+import { spawn } from "node:child_process";
+import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { PLUGINS_DIR, readInstalledPlugins, sanitiseName, } from "../plugin-loader.js";
+// ── npm helper ────────────────────────────────────────────────────────────────
+function runNpm(args, cwd) {
+    return new Promise((resolve, reject) => {
+        const npmCmd = process.platform === "win32" ? "npm.cmd" : "npm";
+        const child = spawn(npmCmd, ["install", ...args], { cwd, stdio: "inherit" });
+        child.on("close", (code) => {
+            if (code === 0)
+                resolve();
+            else
+                reject(new Error(`npm install exited with code ${String(code)}`));
+        });
+        child.on("error", reject);
+    });
+}
+async function searchNpmRegistry(query) {
+    const text = `keywords:casen-plugin${query ? ` ${query}` : ""}`;
+    const url = `https://registry.npmjs.org/-/v1/search?text=${encodeURIComponent(text)}&size=50`;
+    const res = await fetch(url);
+    if (!res.ok)
+        throw new Error(`npm registry returned HTTP ${res.status}`);
+    const data = (await res.json());
+    return data.objects;
+}
+// ── plugin group ──────────────────────────────────────────────────────────────
+export const pluginGroup = {
+    name: "plugin",
+    description: "Manage casen CLI plugins",
+    commands: [
+        // ── list ──────────────────────────────────────────────────────────────
+        {
+            name: "list",
+            aliases: ["ls"],
+            description: "List installed plugins",
+            async run(ctx) {
+                const plugins = await readInstalledPlugins();
+                if (plugins.length === 0) {
+                    ctx.output.info('No plugins installed. Run "casen plugin search" to discover plugins.');
+                    return;
+                }
+                ctx.output.printList({
+                    items: plugins.map((p) => ({
+                        name: p.package,
+                        version: p.version,
+                        installed: p.installedAt.slice(0, 10),
+                    })),
+                }, [
+                    { key: "name", header: "NAME" },
+                    { key: "version", header: "VERSION" },
+                    { key: "installed", header: "INSTALLED" },
+                ]);
+            },
+        },
+        // ── install ───────────────────────────────────────────────────────────
+        {
+            name: "install",
+            aliases: ["add"],
+            description: "Install a plugin from the npm registry or a local path",
+            args: [{ name: "name", description: "npm package name or ./local-path", required: true }],
+            examples: [
+                { description: "Install from npm", command: "casen plugin install casen-deploy" },
+                {
+                    description: "Install from local path (dev mode)",
+                    command: "casen plugin install ./my-plugin",
+                },
+            ],
+            async run(ctx) {
+                const nameArg = ctx.positional[0];
+                if (!nameArg)
+                    throw new Error("Missing required argument: <name>");
+                // Detect local path vs npm package name
+                const isLocalPath = nameArg.startsWith(".") || nameArg.startsWith("/");
+                let pkgName;
+                if (isLocalPath) {
+                    const localPath = join(homedir(), nameArg.startsWith("/") ? "" : ".", nameArg);
+                    const localPkgText = await readFile(join(isLocalPath ? nameArg : localPath, "package.json"), "utf8");
+                    const localPkg = JSON.parse(localPkgText);
+                    if (!localPkg.name)
+                        throw new Error(`No "name" field found in ${nameArg}/package.json`);
+                    pkgName = localPkg.name;
+                }
+                else {
+                    pkgName = nameArg;
+                }
+                const dirName = sanitiseName(pkgName);
+                const pluginDir = join(PLUGINS_DIR, dirName);
+                ctx.output.info(`Installing ${pkgName}…`);
+                await mkdir(pluginDir, { recursive: true });
+                // Initialise a minimal host package.json so npm has a valid workspace
+                const hostPkg = { name: "_casen-plugin-host", version: "0.0.0", private: true };
+                const hostPkgPath = join(pluginDir, "package.json");
+                try {
+                    await readFile(hostPkgPath, "utf8");
+                }
+                catch {
+                    // Only write if it doesn't already exist
+                    await writeFile(hostPkgPath, `${JSON.stringify(hostPkg, null, 2)}\n`, "utf8");
+                }
+                await runNpm([nameArg], pluginDir);
+                // Read the installed version from the plugin's own package.json
+                const installedPkgText = await readFile(join(pluginDir, "node_modules", pkgName, "package.json"), "utf8");
+                const installedPkg = JSON.parse(installedPkgText);
+                const version = installedPkg.version ?? "unknown";
+                const meta = {
+                    package: pkgName,
+                    version,
+                    installedAt: new Date().toISOString(),
+                };
+                await writeFile(join(pluginDir, ".meta.json"), `${JSON.stringify(meta, null, 2)}\n`, "utf8");
+                ctx.output.ok(`Installed ${pkgName}@${version}`);
+                ctx.output.info("Restart casen to activate the plugin.");
+            },
+        },
+        // ── remove ────────────────────────────────────────────────────────────
+        {
+            name: "remove",
+            aliases: ["uninstall", "rm"],
+            description: "Uninstall a plugin",
+            args: [{ name: "name", description: "Plugin package name", required: true }],
+            async run(ctx) {
+                const pkgName = ctx.positional[0];
+                if (!pkgName)
+                    throw new Error("Missing required argument: <name>");
+                const pluginDir = join(PLUGINS_DIR, sanitiseName(pkgName));
+                try {
+                    await readFile(join(pluginDir, ".meta.json"), "utf8");
+                }
+                catch {
+                    throw new Error(`Plugin "${pkgName}" is not installed.`);
+                }
+                await rm(pluginDir, { recursive: true, force: true });
+                ctx.output.ok(`Removed ${pkgName}`);
+                ctx.output.info("Restart casen for the change to take effect.");
+            },
+        },
+        // ── update ────────────────────────────────────────────────────────────
+        {
+            name: "update",
+            aliases: ["upgrade"],
+            description: "Update one or all plugins to their latest versions",
+            args: [
+                {
+                    name: "name",
+                    description: "Plugin to update (omit to update all installed plugins)",
+                    required: false,
+                },
+            ],
+            async run(ctx) {
+                const target = ctx.positional[0];
+                const plugins = await readInstalledPlugins();
+                if (plugins.length === 0) {
+                    ctx.output.info("No plugins installed.");
+                    return;
+                }
+                const toUpdate = target ? plugins.filter((p) => p.package === target) : plugins;
+                if (toUpdate.length === 0) {
+                    throw new Error(`Plugin "${String(target)}" is not installed.`);
+                }
+                for (const plugin of toUpdate) {
+                    ctx.output.info(`Updating ${plugin.package}…`);
+                    await runNpm([`${plugin.package}@latest`], plugin.dir);
+                    const pkgText = await readFile(join(plugin.dir, "node_modules", plugin.package, "package.json"), "utf8");
+                    const pkg = JSON.parse(pkgText);
+                    const newVersion = pkg.version ?? "unknown";
+                    const meta = {
+                        package: plugin.package,
+                        version: newVersion,
+                        installedAt: plugin.installedAt,
+                    };
+                    await writeFile(join(plugin.dir, ".meta.json"), `${JSON.stringify(meta, null, 2)}\n`, "utf8");
+                    ctx.output.ok(`Updated ${plugin.package} → ${newVersion}`);
+                }
+                ctx.output.info("Restart casen for the changes to take effect.");
+            },
+        },
+        // ── info ──────────────────────────────────────────────────────────────
+        {
+            name: "info",
+            description: "Show details for an installed plugin",
+            args: [{ name: "name", description: "Plugin package name", required: true }],
+            async run(ctx) {
+                const pkgName = ctx.positional[0];
+                if (!pkgName)
+                    throw new Error("Missing required argument: <name>");
+                const pluginDir = join(PLUGINS_DIR, sanitiseName(pkgName));
+                const metaText = await readFile(join(pluginDir, ".meta.json"), "utf8");
+                const meta = JSON.parse(metaText);
+                const pkgText = await readFile(join(pluginDir, "node_modules", pkgName, "package.json"), "utf8");
+                const pkg = JSON.parse(pkgText);
+                const repoUrl = typeof pkg.repository === "string" ? pkg.repository : (pkg.repository?.url ?? "");
+                const author = typeof pkg.author === "string" ? pkg.author : (pkg.author?.name ?? "");
+                ctx.output.printItem({
+                    name: meta.package,
+                    version: meta.version,
+                    installedAt: meta.installedAt,
+                    description: pkg.description ?? "",
+                    homepage: pkg.homepage ?? "",
+                    repository: repoUrl,
+                    author,
+                    directory: pluginDir,
+                });
+            },
+        },
+        // ── search ────────────────────────────────────────────────────────────
+        {
+            name: "search",
+            description: "Search the npm registry for casen plugins",
+            args: [{ name: "query", description: "Search terms (optional)", required: false }],
+            examples: [
+                { description: "Browse all plugins", command: "casen plugin search" },
+                { description: "Search for deploy-related plugins", command: "casen plugin search deploy" },
+            ],
+            async run(ctx) {
+                const query = ctx.positional[0] ?? "";
+                ctx.output.info(`Searching npm for casen plugins${query ? ` matching "${query}"` : ""}…`);
+                const results = await searchNpmRegistry(query);
+                if (results.length === 0) {
+                    ctx.output.info("No plugins found.");
+                    return;
+                }
+                ctx.output.printList({
+                    items: results.map((r) => ({
+                        name: r.package.name,
+                        version: r.package.version,
+                        description: r.package.description ?? "",
+                        publisher: r.package.publisher?.username ?? "",
+                        score: r.score.final.toFixed(2),
+                    })),
+                }, [
+                    { key: "name", header: "NAME" },
+                    { key: "version", header: "VERSION" },
+                    { key: "description", header: "DESCRIPTION", maxWidth: 52 },
+                    { key: "publisher", header: "PUBLISHER" },
+                    { key: "score", header: "SCORE" },
+                ]);
+            },
+        },
+    ],
+};
+//# sourceMappingURL=plugin.js.map

package/dist/generated/commands.js

@@ -406,21 +406,6 @@ export const decisionInstanceGroup = {
             argName: "decisionEvaluationInstanceKey",
             get: (client, key) => client.decisionInstance.getDecisionInstance(key),
         }),
-        {
-            name: "delete",
-            description: "Delete decision instance",
-            args: [{ name: "decisionInstanceKey", description: "decisionInstanceKey", required: true }],
-            flags: [DATA_OPT_FLAG],
-            async run(ctx) {
-                const decisionInstanceKey = ctx.positional[0];
-                if (!decisionInstanceKey)
-                    throw new Error("Missing required argument: <decisionInstanceKey>");
-                const body = parseJson(ctx.flags.data, "data");
-                const client = await ctx.getClient();
-                await client.decisionInstance.deleteDecisionInstance(decisionInstanceKey, body);
-                ctx.output.ok("delete completed.");
-            },
-        },
         makeCreateCmd({
             name: "delete-batch-operation",
             description: "Delete decision instances (batch)",

package/dist/plugin-loader.js

@@ -0,0 +1,89 @@
+import { readFile, readdir } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { pathToFileURL } from "node:url";
+// ── Paths ─────────────────────────────────────────────────────────────────────
+export const PLUGINS_DIR = join(homedir(), ".casen", "plugins");
+// ── Helpers ───────────────────────────────────────────────────────────────────
+/**
+ * Converts an npm package name to a safe directory name.
+ * "@acme/casen-deploy" → "acme__casen-deploy"
+ */
+export function sanitiseName(pkg) {
+    return pkg.replace(/^@/, "").replace(/\//g, "__");
+}
+// ── Plugin loader ─────────────────────────────────────────────────────────────
+/**
+ * Loads all installed plugins from `~/.casen/plugins/` and returns their
+ * combined command groups. Failures are isolated — a broken plugin logs a
+ * warning to stderr and is skipped; it cannot crash the CLI.
+ */
+export async function loadPlugins() {
+    let entries;
+    try {
+        entries = await readdir(PLUGINS_DIR);
+    }
+    catch {
+        return [];
+    }
+    const groups = [];
+    for (const entry of entries) {
+        if (entry.startsWith("."))
+            continue;
+        const pluginDir = join(PLUGINS_DIR, entry);
+        try {
+            // Read metadata to get the actual npm package name
+            const metaText = await readFile(join(pluginDir, ".meta.json"), "utf8");
+            const meta = JSON.parse(metaText);
+            const pkgName = meta.package;
+            // Resolve entry point via the plugin's own package.json
+            const pkgText = await readFile(join(pluginDir, "node_modules", pkgName, "package.json"), "utf8");
+            const pkg = JSON.parse(pkgText);
+            const main = pkg.main ?? "dist/index.js";
+            const entryPath = join(pluginDir, "node_modules", pkgName, main);
+            // Dynamic import — use file URL for cross-platform compatibility
+            const mod = (await import(pathToFileURL(entryPath).href));
+            const plugin = (mod.default ?? mod);
+            if (!Array.isArray(plugin.groups)) {
+                process.stderr.write(`[plugin] ${pkgName}: no groups exported, skipping\n`);
+                continue;
+            }
+            groups.push(...plugin.groups);
+        }
+        catch (err) {
+            const msg = err instanceof Error ? err.message : String(err);
+            process.stderr.write(`[plugin] ${entry}: failed to load — ${msg}\n`);
+        }
+    }
+    return groups;
+}
+// ── Management helpers ────────────────────────────────────────────────────────
+/**
+ * Returns metadata for all installed plugins.
+ * Directories without a `.meta.json` are silently ignored.
+ */
+export async function readInstalledPlugins() {
+    let entries;
+    try {
+        entries = await readdir(PLUGINS_DIR);
+    }
+    catch {
+        return [];
+    }
+    const result = [];
+    for (const entry of entries) {
+        if (entry.startsWith("."))
+            continue;
+        const dir = join(PLUGINS_DIR, entry);
+        try {
+            const metaText = await readFile(join(dir, ".meta.json"), "utf8");
+            const meta = JSON.parse(metaText);
+            result.push({ ...meta, dir });
+        }
+        catch {
+            // Directory without .meta.json — not a managed plugin, skip
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=plugin-loader.js.map

package/dist/run.js

@@ -4,6 +4,7 @@ import { commandGroups } from "./commands/index.js";
 import { getRuntimeCompletions } from "./completion.js";
 import { printCommandHelp, printGlobalHelp, printGroupHelp, printVersion } from "./help.js";
 import { createNullWriter, createOutputWriter, printRawResponse } from "./output.js";
+import { loadPlugins } from "./plugin-loader.js";
 import { runProfileManager } from "./profile-tui.js";
 import { runSettingsManager } from "./settings-tui.js";
 import { runAskTui, runGroupTui, runMainTui } from "./tui.js";
@@ -47,6 +48,10 @@ function printError(msg, colors) {
 }
 // ─── Main ─────────────────────────────────────────────────────────────────────
 export async function run(argv) {
+    // Load plugin-contributed groups and merge with built-in groups.
+    // Failures are isolated inside loadPlugins — a broken plugin cannot crash the CLI.
+    const pluginGroups = await loadPlugins();
+    const allGroups = [...commandGroups, ...pluginGroups];
     // ── Completion protocol ───────────────────────────────────────────────────
     // casen --complete <cursorWordIndex> -- <words...>
     const completeIdx = argv.indexOf("--complete");
@@ -54,7 +59,7 @@ export async function run(argv) {
         const cursorIdx = Number(argv[completeIdx + 1] ?? "0");
         const dashDash = argv.indexOf("--", completeIdx + 2);
         const words = dashDash >= 0 ? argv.slice(dashDash + 1) : [];
-        const suggestions = getRuntimeCompletions(commandGroups, cursorIdx, words);
+        const suggestions = getRuntimeCompletions(allGroups, cursorIdx, words);
         process.stdout.write(`${suggestions.join("\n")}\n`);
         return;
     }
@@ -73,11 +78,11 @@ export async function run(argv) {
     // ── Top-level: main menu TUI or help ─────────────────────────────────────
     if (positional.length === 0) {
         if (wantHelp) {
-            printGlobalHelp(commandGroups, colors);
+            printGlobalHelp(allGroups, colors);
         }
         else {
             const { name: pName, info: pInfo } = buildProfileInfo(profileName);
-            await runMainTui(commandGroups, () => Promise.resolve(createClientFromProfile(profileName)), () => Promise.resolve(createAdminClientFromProfile(profileName)), { profile: pName, profileInfo: pInfo });
+            await runMainTui(allGroups, () => Promise.resolve(createClientFromProfile(profileName)), () => Promise.resolve(createAdminClientFromProfile(profileName)), { profile: pName, profileInfo: pInfo });
         }
         return;
     }
@@ -85,7 +90,7 @@ export async function run(argv) {
     const getAdminClient = () => Promise.resolve(createAdminClientFromProfile(profileName));
     // ── Find group ────────────────────────────────────────────────────────────
     const groupToken = positional[0] ?? "";
-    const group = commandGroups.find((g) => g.name === groupToken || g.aliases?.includes(groupToken));
+    const group = allGroups.find((g) => g.name === groupToken || g.aliases?.includes(groupToken));
     if (!group) {
         printError(`Unknown resource: "${groupToken}". Run \`casen --help\` to see all resources.`, colors);
         process.exitCode = 1;
@@ -111,7 +116,7 @@ export async function run(argv) {
     if (positional.length === 1 && !wantHelp) {
         if (group.name === "ask") {
             const { name: pName, info: pInfo } = buildProfileInfo(profileName);
-            await runAskTui(commandGroups, getClient, getAdminClient, {
+            await runAskTui(allGroups, getClient, getAdminClient, {
                 profile: pName,
                 profileInfo: pInfo,
             });
@@ -124,7 +129,7 @@ export async function run(argv) {
         }
         else if (group.name !== "completion") {
             const { name: pName, info: pInfo } = buildProfileInfo(profileName);
-            await runGroupTui(group, commandGroups, getClient, getAdminClient, {
+            await runGroupTui(group, allGroups, getClient, getAdminClient, {
                 profile: pName,
                 profileInfo: pInfo,
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmnkit/cli",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "Command-line interface for Camunda 8 — deploy, manage, and monitor processes from the terminal",
   "type": "module",
   "bin": {
@@ -15,10 +15,10 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@bpmnkit/api": "0.0.12",
-    "@bpmnkit/ascii": "0.0.13",
-    "@bpmnkit/connector-gen": "0.0.6",
-    "@bpmnkit/profiles": "0.0.9"
+    "@bpmnkit/api": "0.0.13",
+    "@bpmnkit/ascii": "0.0.14",
+    "@bpmnkit/connector-gen": "0.0.8",
+    "@bpmnkit/profiles": "0.0.10"
   },
   "publishConfig": {
     "access": "public"