@hesed/webui 0.1.0 → 0.2.2

package/README.md

@@ -26,7 +26,7 @@ $ npm install -g @hesed/webui
 $ webui COMMAND
 running command...
 $ webui (--version)
-@hesed/webui/0.1.0 darwin-arm64 node-v22.22.3
+@hesed/webui/0.2.2 linux-x64 node-v24.16.0
 $ webui --help [COMMAND]
 USAGE
   $ webui COMMAND
@@ -63,5 +63,5 @@ EXAMPLES
   $ webui webui --host 0.0.0.0
 ```
 
-_See code: [src/commands/webui.ts](https://github.com/hesedcasa/webui/blob/v0.1.0/src/commands/webui.ts)_
+_See code: [src/commands/webui.ts](https://github.com/hesedcasa/webui/blob/v0.2.2/src/commands/webui.ts)_
 <!-- commandsstop -->

package/dist/commands/webui.d.ts

@@ -1,3 +1,5 @@
+import type { Config } from '@oclif/core';
+import type { LoadOptions } from '@oclif/core/interfaces';
 import { Command } from '@oclif/core';
 export default class WebUI extends Command {
     static description: string;
@@ -7,6 +9,12 @@ export default class WebUI extends Command {
         open: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         port: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
     };
+    /**
+     * oclif normally reloads a Config when a command comes from a different
+     * oclif core installation. Preserve the host CLI's initialized Config so
+     * commands registered dynamically by init hooks remain available to the UI.
+     */
+    static run<T extends Command>(this: new (argv: string[], config: Config) => T, argv?: string[], options?: LoadOptions): Promise<ReturnType<T['run']>>;
     run(): Promise<void>;
     private openBrowser;
 }

package/dist/commands/webui.js

@@ -23,6 +23,18 @@ export default class WebUI extends Command {
             description: 'Port to listen on.',
         }),
     };
+    /**
+     * oclif normally reloads a Config when a command comes from a different
+     * oclif core installation. Preserve the host CLI's initialized Config so
+     * commands registered dynamically by init hooks remain available to the UI.
+     */
+    static async run(argv = [], options) {
+        if (options && typeof options !== 'string' && 'runCommand' in options) {
+            const command = new this(argv, options);
+            return command._run();
+        }
+        return super.run(argv, options);
+    }
     async run() {
         const { flags } = await this.parse(WebUI);
         this.log(`Starting web UI…`);

package/dist/lib/introspect.js

@@ -1,9 +1,20 @@
-function flagToMeta(name, flag) {
+function renderMetadataText(value, config, commandId) {
+    if (!value)
+        return value;
+    const replacements = {
+        'command.id': commandId,
+        'config.bin': config.bin,
+        'config.name': config.name,
+        'config.version': config.version,
+    };
+    return value.replaceAll(/<%=\s*(command\.id|config\.(?:bin|name|version))\s*%>/g, (template, key) => replacements[key] ?? template);
+}
+function flagToMeta(name, flag, config, commandId) {
     const isBoolean = flag.type === 'boolean';
     return {
         char: flag.char,
         default: isBoolean ? undefined : flag.default,
-        description: flag.summary ?? flag.description,
+        description: renderMetadataText(flag.summary ?? flag.description, config, commandId),
         multiple: !isBoolean && Boolean(flag.multiple),
         name,
         options: isBoolean ? undefined : flag.options,
@@ -11,10 +22,10 @@ function flagToMeta(name, flag) {
         type: isBoolean ? 'boolean' : 'option',
     };
 }
-function argToMeta(name, arg) {
+function argToMeta(name, arg, config, commandId) {
     return {
         default: arg.default,
-        description: arg.description,
+        description: renderMetadataText(arg.description, config, commandId),
         name,
         options: arg.options,
         required: Boolean(arg.required),
@@ -26,19 +37,21 @@ function argToMeta(name, arg) {
  */
 export function describeCommands(config) {
     return config.commands
-        .filter((cmd) => !cmd.hidden)
+        .filter((cmd) => !cmd.hidden && !(cmd.id === 'webui' && cmd.pluginName === '@hesed/webui'))
         .map((cmd) => ({
         aliases: cmd.aliases ?? [],
-        args: Object.entries(cmd.args ?? {}).map(([name, arg]) => argToMeta(name, arg)),
-        description: cmd.description,
+        args: Object.entries(cmd.args ?? {}).map(([name, arg]) => argToMeta(name, arg, config, cmd.id)),
+        description: renderMetadataText(cmd.description, config, cmd.id),
         flags: Object.entries(cmd.flags ?? {})
             .filter(([, flag]) => !flag.hidden)
-            .map(([name, flag]) => flagToMeta(name, flag)),
+            .map(([name, flag]) => flagToMeta(name, flag, config, cmd.id)),
         id: cmd.id,
         pluginName: cmd.pluginName,
         pluginType: cmd.pluginType,
-        summary: cmd.summary,
-        usage: cmd.usage,
+        summary: renderMetadataText(cmd.summary, config, cmd.id),
+        usage: Array.isArray(cmd.usage)
+            ? cmd.usage.map((usage) => renderMetadataText(usage, config, cmd.id) ?? usage)
+            : renderMetadataText(cmd.usage, config, cmd.id),
     }))
         .sort((a, b) => a.id.localeCompare(b.id));
 }

package/dist/lib/server.d.ts

@@ -1,5 +1,5 @@
 import type { Config } from '@oclif/core';
-import type { Server } from 'node:http';
+import type { IncomingMessage, Server, ServerResponse } from 'node:http';
 interface ServerOptions {
     config: Config;
     host: string;
@@ -9,6 +9,12 @@ interface RunningServer {
     server: Server;
     url: string;
 }
+/**
+ * Handle the small JSON API the browser app talks to. Returns `true` if the
+ * request was an API request (and has been answered), `false` otherwise so the
+ * caller can hand it to Next.js.
+ */
+export declare function handleApi(config: Config, req: IncomingMessage, res: ServerResponse): Promise<boolean>;
 /**
  * Start the web UI server: a Next.js app for the front-end plus a JSON API
  * (served from the same origin) that introspects and runs oclif commands.

package/dist/lib/server.js

@@ -7,6 +7,8 @@ import { describeCommands } from './introspect.js';
 const moduleDir = dirname(fileURLToPath(import.meta.url));
 /** The Next.js project lives at `<pluginRoot>/web`; this file is `<pluginRoot>/dist/lib/server.js`. */
 const webDir = join(moduleDir, '..', '..', 'web');
+/** The compiled Next.js build output (distDir: ../dist/web relative to web/). */
+const distWebDir = join(moduleDir, '..', 'web');
 function sendJson(res, status, body) {
     const payload = JSON.stringify(body);
     res.writeHead(status, { 'content-length': Buffer.byteLength(payload), 'content-type': 'application/json' });
@@ -25,7 +27,7 @@ async function readJsonBody(req) {
  * request was an API request (and has been answered), `false` otherwise so the
  * caller can hand it to Next.js.
  */
-async function handleApi(config, req, res) {
+export async function handleApi(config, req, res) {
     const { pathname } = new URL(req.url ?? '/', 'http://localhost');
     if (!pathname?.startsWith('/api/'))
         return false;
@@ -68,8 +70,8 @@ async function handleApi(config, req, res) {
  */
 export async function startServer(options) {
     const { config, host, port } = options;
-    if (!existsSync(join(webDir, '.next'))) {
-        throw new Error(`No production build found at ${join(webDir, '.next')}.\n` +
+    if (!existsSync(distWebDir)) {
+        throw new Error(`No production build found at ${distWebDir}.\n` +
             `Run "npm run build:web" in the @hesed/webui plugin.`);
     }
     // Imported lazily and loosely typed so the oclif command can be compiled

package/dist/web/BUILD_ID

@@ -0,0 +1 @@
+PDMigBNKG7RenqXyfgiNr

package/{web/.next → dist/web}/app-path-routes-manifest.json

@@ -1,4 +1,5 @@
 {
+  "/_global-error/page": "/_global-error",
   "/_not-found/page": "/_not-found",
   "/page": "/"
 }

package/dist/web/build-manifest.json

@@ -0,0 +1,20 @@
+{
+  "pages": {
+    "/_app": []
+  },
+  "devFiles": [],
+  "polyfillFiles": [
+    "static/chunks/0cz1d0mv5g_q7.js"
+  ],
+  "lowPriorityFiles": [
+    "static/PDMigBNKG7RenqXyfgiNr/_buildManifest.js",
+    "static/PDMigBNKG7RenqXyfgiNr/_ssgManifest.js",
+    "static/PDMigBNKG7RenqXyfgiNr/_clientMiddlewareManifest.js"
+  ],
+  "rootMainFiles": [
+    "static/chunks/1jq4o6yq14o4c.js",
+    "static/chunks/0atut6a2uuyid.js",
+    "static/chunks/2nykiepra7i1k.js",
+    "static/chunks/turbopack-3i0d1wb0b07u8.js"
+  ]
+}

package/dist/web/cache/.previewinfo

@@ -0,0 +1 @@
+{"previewModeId":"90a29e4e1089fd04e00b8bda53572f39","previewModeSigningKey":"73045342933677012481a59e3b128d8418629f88be33f3c7b578ab43e6f9a8a3","previewModeEncryptionKey":"0aa21e14ef4df6afc98b2196533fa5ac3c2f84814d97d9106896283038ab0bd3","expireAt":1783167422001}

package/dist/web/cache/.rscinfo

@@ -0,0 +1 @@
+{"encryption.key":"9qErRLYqmtbms3mk/Ewq5HWhixoZHMvzjzO88Fk+XiE=","encryption.expire_at":1783167421864}