@nocobase/cli 3.0.0-alpha.2 → 3.0.0-alpha.4

package/dist/commands/api/swagger/get.js

@@ -0,0 +1,96 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import { Command, Flags } from '@oclif/core';
+import { translateCli } from '../../../lib/cli-locale.js';
+import { executeSwaggerRequest, swaggerRequestFlags } from '../../../lib/swagger-command.js';
+import { renderTable } from '../../../lib/ui.js';
+const swaggerText = (key, values, fallback) => translateCli(`commands.swagger.${key}`, values, { fallback });
+function isRecord(value) {
+    return Boolean(value && typeof value === 'object' && !Array.isArray(value));
+}
+function unwrapData(value) {
+    if (!isRecord(value) || typeof value.openapi === 'string') {
+        return value;
+    }
+    return Object.prototype.hasOwnProperty.call(value, 'data') ? value.data : value;
+}
+function normalizeDocument(value) {
+    const document = unwrapData(value);
+    if (!isRecord(document) ||
+        typeof document.openapi !== 'string' ||
+        !isRecord(document.info) ||
+        !isRecord(document.paths)) {
+        return undefined;
+    }
+    return document;
+}
+export default class SwaggerGet extends Command {
+    static summary = 'Get a NocoBase OpenAPI document';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --json',
+        '<%= config.bin %> <%= command.id %> --namespace collections/orders --json',
+        '<%= config.bin %> <%= command.id %> --namespace plugins/ai --output ./openapi/ai.json',
+    ];
+    static flags = {
+        ...swaggerRequestFlags,
+        namespace: Flags.string({
+            aliases: ['ns'],
+            description: 'Document namespace, such as core, plugins/ai, or collections/orders',
+        }),
+        output: Flags.string({
+            char: 'o',
+            description: 'Write the OpenAPI document to a file',
+        }),
+        'json-output': Flags.boolean({
+            char: 'j',
+            aliases: ['json'],
+            description: 'Print the complete OpenAPI document as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SwaggerGet);
+        const namespace = flags.namespace?.trim() || undefined;
+        const response = await executeSwaggerRequest(this, flags, '/swagger:get', { ns: namespace });
+        if (!response) {
+            return;
+        }
+        if (!response.ok) {
+            const details = JSON.stringify(response.data, null, 2);
+            this.error(response.status === 404
+                ? swaggerText('errors.pluginDisabled', undefined, 'The API documentation plugin is not enabled. Enable it before requesting Swagger documents.')
+                : swaggerText('errors.requestFailed', { status: response.status, details }, `Swagger request failed with status ${response.status}\n${details}`));
+        }
+        const document = normalizeDocument(response.data);
+        if (!document) {
+            this.error(swaggerText('errors.invalidDocument', undefined, 'swagger:get returned an invalid OpenAPI document.'));
+        }
+        const json = `${JSON.stringify(document, null, 2)}\n`;
+        if (flags.output) {
+            const outputPath = path.resolve(flags.output);
+            await fs.mkdir(path.dirname(outputPath), { recursive: true });
+            await fs.writeFile(outputPath, json);
+            this.log(swaggerText('messages.saved', { output: outputPath }, `Saved Swagger document to ${outputPath}.`));
+            return;
+        }
+        if (flags['json-output']) {
+            this.log(json.trimEnd());
+            return;
+        }
+        this.log(renderTable([swaggerText('table.field', undefined, 'Field'), swaggerText('table.value', undefined, 'Value')], [
+            [swaggerText('fields.namespace', undefined, 'Namespace'), namespace ?? 'all'],
+            [swaggerText('fields.title', undefined, 'Title'), document.info.title ?? ''],
+            [swaggerText('fields.version', undefined, 'Version'), document.info.version ?? ''],
+            [swaggerText('fields.openapi', undefined, 'OpenAPI'), document.openapi],
+            [swaggerText('fields.paths', undefined, 'Paths'), String(Object.keys(document.paths).length)],
+        ]));
+    }
+}

package/dist/commands/api/swagger/index.js

@@ -0,0 +1,20 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, loadHelpClass } from '@oclif/core';
+export default class Swagger extends Command {
+    static summary = 'Inspect the current NocoBase OpenAPI documentation';
+    async run() {
+        await this.parse(Swagger);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'api:swagger',
+            ...this.argv,
+        ]);
+    }
+}

package/dist/commands/api/swagger/list.js

@@ -0,0 +1,92 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { translateCli } from '../../../lib/cli-locale.js';
+import { executeSwaggerRequest, swaggerRequestFlags } from '../../../lib/swagger-command.js';
+import { renderTable } from '../../../lib/ui.js';
+const swaggerText = (key, values, fallback) => translateCli(`commands.swagger.${key}`, values, { fallback });
+function isRecord(value) {
+    return Boolean(value && typeof value === 'object' && !Array.isArray(value));
+}
+function unwrapData(value) {
+    return isRecord(value) && Object.prototype.hasOwnProperty.call(value, 'data') ? value.data : value;
+}
+function readNamespace(url) {
+    try {
+        return new URL(url, 'http://localhost').searchParams.get('ns') || 'all';
+    }
+    catch {
+        return 'all';
+    }
+}
+function normalizeDestinations(value) {
+    const data = unwrapData(value);
+    if (!Array.isArray(data)) {
+        return undefined;
+    }
+    const destinations = [];
+    for (const item of data) {
+        if (!isRecord(item) || typeof item.name !== 'string' || typeof item.url !== 'string') {
+            return undefined;
+        }
+        destinations.push({
+            name: item.name,
+            namespace: readNamespace(item.url),
+            url: item.url,
+        });
+    }
+    return destinations;
+}
+export default class SwaggerList extends Command {
+    static summary = 'List available NocoBase OpenAPI document namespaces';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --json',
+        '<%= config.bin %> <%= command.id %> --env dev --yes --json',
+    ];
+    static flags = {
+        ...swaggerRequestFlags,
+        'json-output': Flags.boolean({
+            char: 'j',
+            aliases: ['json'],
+            description: 'Print namespaces as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SwaggerList);
+        const response = await executeSwaggerRequest(this, flags, '/swagger:getUrls');
+        if (!response) {
+            return;
+        }
+        if (!response.ok) {
+            const details = JSON.stringify(response.data, null, 2);
+            this.error(response.status === 404
+                ? swaggerText('errors.pluginDisabled', undefined, 'The API documentation plugin is not enabled. Enable it before requesting Swagger documents.')
+                : swaggerText('errors.requestFailed', { status: response.status, details }, `Swagger request failed with status ${response.status}\n${details}`));
+        }
+        const destinations = normalizeDestinations(response.data);
+        if (!destinations) {
+            this.error(swaggerText('errors.invalidDestinations', undefined, 'swagger:getUrls returned an invalid destination list.'));
+        }
+        if (flags['json-output']) {
+            this.log(JSON.stringify(destinations, null, 2));
+            return;
+        }
+        if (!destinations.length) {
+            this.log(swaggerText('messages.empty', undefined, 'No Swagger document namespaces are available.'));
+            return;
+        }
+        this.log(renderTable([
+            swaggerText('table.name', undefined, 'Name'),
+            swaggerText('table.namespace', undefined, 'Namespace'),
+            swaggerText('table.url', undefined, 'URL'),
+        ], destinations.map((item) => [item.name, item.namespace, item.url])));
+    }
+}

package/dist/commands/init.js

@@ -109,6 +109,15 @@ function resolveInitDownloadVersion(results) {
 function initVersionPromptValue(version) {
     return version === 'latest' || version === 'beta' || version === 'alpha' ? version : 'other';
 }
+export function defaultInitDownloadVersionForCliVersion(cliVersion) {
+    if (/-alpha(?:[.-]|$)/i.test(cliVersion)) {
+        return 'alpha';
+    }
+    if (/-beta(?:[.-]|$)/i.test(cliVersion)) {
+        return 'beta';
+    }
+    return 'latest';
+}
 function yesInitialValue(def, fallback) {
     if ('yesInitialValue' in def && def.yesInitialValue !== undefined) {
         return String(def.yesInitialValue);
@@ -409,8 +418,15 @@ Prompt modes:
         installAccessToken: installConnectionAccessTokenPrompt,
     };
     buildPromptCatalog(flags, options) {
+        const downloadVersion = defaultInitDownloadVersionForCliVersion(String(this.config.pjson?.version ?? '').trim());
+        const versionPrompt = Init.prompts.version;
         const prompts = {
             ...Init.prompts,
+            version: {
+                ...versionPrompt,
+                initialValue: downloadVersion,
+                yesInitialValue: downloadVersion,
+            },
             installApiBaseUrl: createInstallConnectionApiBaseUrlPrompt(options.defaultApiHost),
         };
         if (flags['skip-auth']) {

package/dist/lib/bootstrap.js

@@ -72,7 +72,9 @@ function hasVersionFlag(argv) {
 function isBuiltinCommand(argv) {
     const commandTokens = argv.filter((token) => token && !token.startsWith('-'));
     const [topic, subtopic] = commandTokens;
-    return topic === 'env' || topic === 'resource' || (topic === 'api' && subtopic === 'resource');
+    return (topic === 'env' ||
+        topic === 'resource' ||
+        (topic === 'api' && (subtopic === 'resource' || subtopic === 'swagger')));
 }
 export function shouldSkipRuntimeBootstrap(argv) {
     return hasVersionFlag(argv) || isBuiltinCommand(argv);

package/dist/lib/browser.js

@@ -0,0 +1,29 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { spawn } from 'node:child_process';
+export async function openUrlInDefaultBrowser(url) {
+    const [command, args, options] = process.platform === 'darwin'
+        ? ['open', [url], { detached: true, stdio: 'ignore' }]
+        : process.platform === 'win32'
+            ? ['cmd', ['/c', 'start', '', url], { detached: true, stdio: 'ignore', windowsHide: true }]
+            : ['xdg-open', [url], { detached: true, stdio: 'ignore' }];
+    return new Promise((resolve) => {
+        try {
+            const child = spawn(command, args, options);
+            child.once('error', () => resolve(false));
+            child.once('spawn', () => {
+                child.unref();
+                resolve(true);
+            });
+        }
+        catch {
+            resolve(false);
+        }
+    });
+}

package/dist/lib/env-proxy.js

@@ -605,17 +605,30 @@ function buildNginxManagedConfigBlock(context) {
         `    ${MANAGED_NGINX_CONFIG_BLOCK_END}`,
     ].join('\n');
 }
-function buildNginxPortalRootPublicPath(appPublicPath) {
+function buildPortalRootPublicPath(appPublicPath) {
     return appPublicPath === DEFAULT_APP_PUBLIC_PATH
         ? `/${PORTAL_CLIENT_PREFIX}/`
         : `${trimTrailingSlash(appPublicPath)}/${PORTAL_CLIENT_PREFIX}/`;
 }
 function buildNginxPortalLocationBlock(context) {
-    const portalBasePath = trimTrailingSlash(buildNginxPortalRootPublicPath(context.appPublicPath));
+    const portalBasePath = trimTrailingSlash(buildPortalRootPublicPath(context.appPublicPath));
     const portalBasePathPattern = escapeRegExp(portalBasePath);
     return [
+        `    location = ${portalBasePath} {`,
+        '        absolute_redirect off;',
+        `        return 302 ${context.v2PublicPath}$is_args$args;`,
+        '    }',
+        '',
+        `    location = ${portalBasePath}/ {`,
+        '        absolute_redirect off;',
+        `        return 302 ${context.v2PublicPath}$is_args$args;`,
+        '    }',
+        '',
         `    location ^~ ${portalBasePath}/apps/ {`,
         '        absolute_redirect off;',
+        `        if ($uri ~ ^${portalBasePathPattern}/apps/(?<subapp>[A-Za-z0-9_-]+)/?$) {`,
+        `            return 302 ${context.v2PublicPath}apps/$subapp/$is_args$args;`,
+        '        }',
         '',
         `        if ($uri ~ ^${portalBasePathPattern}/apps/(?<subapp>[A-Za-z0-9_-]+)/(?<portal>[A-Za-z0-9_-]+)$) {`,
         `            return 308 ${portalBasePath}/apps/$subapp/$portal/$is_args$args;`,
@@ -640,7 +653,6 @@ function buildNginxPortalLocationBlock(context) {
         '',
         `    location ^~ ${portalBasePath}/ {`,
         '        absolute_redirect off;',
-        '',
         `        if ($uri ~ ^${portalBasePathPattern}/(?<portal>[A-Za-z0-9_-]+)$) {`,
         `            return 308 ${portalBasePath}/$portal/$is_args$args;`,
         '        }',
@@ -1229,6 +1241,7 @@ function renderCaddyAppTemplate(siteAddress, context, publicDir) {
     const apiPathMatcher = toCaddyPathMatcher(context.apiBasePath);
     const appPublicPathNoTrailingSlash = trimTrailingSlash(context.appPublicPath);
     const v2PublicPathNoTrailingSlash = trimTrailingSlash(context.v2PublicPath);
+    const portalBasePath = trimTrailingSlash(buildPortalRootPublicPath(context.appPublicPath));
     const rootRedirectBlock = context.appPublicPath === DEFAULT_APP_PUBLIC_PATH
         ? ''
         : `
@@ -1321,6 +1334,14 @@ function renderCaddyAppTemplate(siteAddress, context, publicDir) {
         `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
         '    }',
         '',
+        `    handle ${portalBasePath} {`,
+        `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
+        '    }',
+        '',
+        `    handle ${portalBasePath}/* {`,
+        `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
+        '    }',
+        '',
         `    @settingsRoute path_regexp settingsRoute ${settingsRoutePattern}`,
         '    handle @settingsRoute {',
         `        root * ${publicDir}`,

package/dist/lib/generated-command.js

@@ -15,12 +15,20 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from './auth-store.js';
 import { executeApiRequest } from './api-client.js';
+import { resolveAppUrlFromApiBaseUrl } from '../commands/env/shared.js';
 import { findApiCommandCompatViolation, formatApiCommandCompatViolation } from './api-command-compat.js';
+import { openUrlInDefaultBrowser } from './browser.js';
 import { ensureCrossEnvConfirmed } from './env-guard.js';
 import { applyPostProcessor } from './post-processors.js';
 import { readInstalledManagedSkillsVersion } from './skills-manager.js';
 import { registerPostProcessors } from '../post-processors/index.js';
+const UI_OPERATION_QUERY_KEY = '_operation_';
+const UI_OPERATION_VERSION = 1;
+function encodeUIOperation(operation) {
+    return Buffer.from(JSON.stringify(operation), 'utf8').toString('base64url');
+}
 function buildParameterFlag(parameter, options) {
     const hints = [parameter.in];
     if (parameter.isFile) {
@@ -104,6 +112,13 @@ export function createGeneratedFlags(operation) {
             required: true,
         });
     }
+    if (operation.ui) {
+        flags.ui = Flags.boolean({
+            description: 'Open the corresponding page in the NocoBase UI',
+            default: false,
+            helpGroup: 'Global',
+        });
+    }
     flags['api-base-url'] = Flags.string({
         description: 'NocoBase API base URL, for example http://localhost:13000/api',
         helpGroup: 'Global',
@@ -142,6 +157,68 @@ export function createGeneratedFlags(operation) {
     });
     return flags;
 }
+function hasFlagValue(value) {
+    if (Array.isArray(value)) {
+        return value.length > 0;
+    }
+    return value !== undefined && value !== '';
+}
+function listProvidedBodyFlags(flags, operation) {
+    const rawBodyFlags = ['body', 'body-file'].filter((flagName) => hasFlagValue(flags[flagName])).map((flagName) => `--${flagName}`);
+    const uiParameterNames = new Set(operation.ui?.parameters ?? []);
+    const bodyFieldFlags = operation.parameters
+        .filter((parameter) => parameter.in === 'body' && !uiParameterNames.has(parameter.name) && hasFlagValue(flags[parameter.flagName]))
+        .map((parameter) => `--${parameter.flagName}`);
+    return [...rawBodyFlags, ...bodyFieldFlags];
+}
+async function resolveUiAppUrl(flags) {
+    const apiBaseUrl = typeof flags['api-base-url'] === 'string' ? flags['api-base-url'] : undefined;
+    if (apiBaseUrl) {
+        return resolveAppUrlFromApiBaseUrl(apiBaseUrl);
+    }
+    const requestedEnv = typeof flags.env === 'string' ? flags.env : undefined;
+    const envName = requestedEnv ?? (await getCurrentEnvName());
+    const env = await getEnv(envName);
+    if (!env?.baseUrl) {
+        throw new Error(env
+            ? `Env "${envName}" is missing a base URL. Use --api-base-url or update env "${envName}" with \`nb env update ${envName} --api-base-url <url>\` first.`
+            : `Env "${envName}" is not configured. Use --api-base-url or run \`nb init --ui --env ${envName}\` first.`);
+    }
+    return resolveAppUrlFromApiBaseUrl(env.baseUrl);
+}
+function buildUiOperationUrl(appUrl, path, encodedOperation) {
+    const url = new URL(appUrl);
+    url.pathname = `${url.pathname.replace(/\/+$/, '')}/${path}`;
+    url.searchParams.set(UI_OPERATION_QUERY_KEY, encodedOperation);
+    return url.toString();
+}
+async function openUiOperation(command, operation, flags) {
+    const { operationId, ui } = operation;
+    if (!ui || !operationId) {
+        command.error('This API operation does not support --ui.');
+    }
+    const bodyFlags = listProvidedBodyFlags(flags, operation);
+    if (bodyFlags.length) {
+        command.error('--ui cannot be combined with API request body flags. Remove --ui to submit through the API, or remove the body flags to open the UI.');
+    }
+    const uiParameterNames = new Set(ui.parameters ?? []);
+    const params = Object.fromEntries(operation.parameters
+        .filter((parameter) => uiParameterNames.has(parameter.name) && hasFlagValue(flags[parameter.flagName]))
+        .map((parameter) => [parameter.name, flags[parameter.flagName]]));
+    const uiOperation = {
+        v: UI_OPERATION_VERSION,
+        operationId,
+        ...(Object.keys(params).length ? { params } : {}),
+    };
+    const encodedOperation = encodeUIOperation(uiOperation);
+    const appUrl = await resolveUiAppUrl(flags);
+    const targetUrl = buildUiOperationUrl(appUrl, ui.path, encodedOperation);
+    const opened = await openUrlInDefaultBrowser(targetUrl);
+    command.log(targetUrl);
+    if (!opened) {
+        command.warn('Could not open the default browser. Copy the URL above to continue.');
+    }
+}
 export class GeneratedApiCommand extends Command {
     static operation;
     static runtimeVersion;
@@ -169,6 +246,10 @@ export class GeneratedApiCommand extends Command {
         if (compatViolation) {
             this.error(formatApiCommandCompatViolation(compatViolation));
         }
+        if (flags.ui) {
+            await openUiOperation(this, ctor.operation, flags);
+            return;
+        }
         const response = await executeApiRequest({
             cliVersion,
             skillsVersion,

package/dist/lib/managed-env-file.js

@@ -21,9 +21,6 @@ function trimValue(value) {
     const text = String(value ?? '').trim();
     return text || undefined;
 }
-function normalizeEnvFilePath(value) {
-    return value.replace(/\\/g, '/');
-}
 function stripWrappingQuotes(value) {
     if (value.length >= 2 && value.startsWith('"') && value.endsWith('"')) {
         return value
@@ -63,38 +60,39 @@ export function resolveManagedLocalEnvFilePath(runtime) {
     const config = runtime.env.config ?? {};
     const explicitEnvFile = trimValue(config.envFile);
     if (explicitEnvFile) {
-        return normalizeEnvFilePath(resolveConfiguredEnvPath(explicitEnvFile) ?? explicitEnvFile);
+        return resolveConfiguredEnvPath(explicitEnvFile) ?? explicitEnvFile;
     }
     const configuredAppPath = resolveConfiguredAppPath(config);
     if (configuredAppPath) {
-        return normalizeEnvFilePath(path.join(configuredAppPath, '.env'));
+        return path.join(configuredAppPath, '.env');
     }
     if (path.basename(runtime.projectRoot) === 'source') {
-        return normalizeEnvFilePath(path.resolve(runtime.projectRoot, '..', '.env'));
+        return path.resolve(runtime.projectRoot, '..', '.env');
     }
-    return normalizeEnvFilePath(path.join(runtime.projectRoot, '.env'));
+    return path.join(runtime.projectRoot, '.env');
 }
 export function resolveManagedEnvFilePathFromConfig(envName, config) {
     const kind = config?.kind ?? resolveEnvKind(config);
     if (kind === 'docker') {
-        const filePath = resolveDockerEnvFilePath(envName, config);
-        return filePath ? normalizeEnvFilePath(filePath) : undefined;
+        return resolveDockerEnvFilePath(envName, config);
     }
     if (kind !== 'local') {
         return undefined;
     }
     const explicitEnvFile = trimValue(config?.envFile);
     if (explicitEnvFile) {
-        return normalizeEnvFilePath(resolveConfiguredEnvPath(explicitEnvFile) ?? explicitEnvFile);
+        return resolveConfiguredEnvPath(explicitEnvFile) ?? explicitEnvFile;
     }
     const configuredAppPath = resolveConfiguredAppPath(config);
     if (configuredAppPath) {
-        return normalizeEnvFilePath(path.join(configuredAppPath, '.env'));
+        return path.join(configuredAppPath, '.env');
     }
     const configuredAppRootPath = trimValue(config?.appRootPath);
     if (configuredAppRootPath) {
         const appRootPath = resolveConfiguredEnvPath(configuredAppRootPath) ?? configuredAppRootPath;
-        return normalizeEnvFilePath(path.basename(appRootPath) === 'source' ? path.resolve(appRootPath, '..', '.env') : path.join(appRootPath, '.env'));
+        return path.basename(appRootPath) === 'source'
+            ? path.resolve(appRootPath, '..', '.env')
+            : path.join(appRootPath, '.env');
     }
     return undefined;
 }

package/dist/lib/portal-create.js

@@ -21,7 +21,7 @@ import { resolveEnvRelativePath } from './cli-home.js';
 import { translateCli } from './cli-locale.js';
 import { buildPortalCommandEnv } from './portal-command-env.js';
 import { buildPortalConfig, mergePortalConfigIntoOptions, writePortalConfig, } from './portal-config.js';
-import { run } from './run-npm.js';
+import { run, runPnpmCommand } from './run-npm.js';
 const DEFAULT_PORTAL_TEMPLATE = '@nocobase/portal-template-default';
 const DEFAULT_PORTAL_APP_NAME = 'main';
 const TEMPLATE_COPY_EXCLUDED_NAMES = new Set(['.git', 'node_modules', '.DS_Store']);
@@ -392,7 +392,7 @@ export async function createPortalWorkspace(options) {
         const hasPackageJson = await pathExists(path.join(portalDir, 'package.json'));
         if (hasPackageJson) {
             const runCommand = options.runCommand ?? run;
-            await runCommand('pnpm', ['install'], {
+            await runPnpmCommand(runCommand, ['install'], {
                 cwd: portalDir,
                 env: buildPortalCommandEnv(),
                 envMode: 'replace',

package/dist/lib/portal-deploy.js

@@ -16,7 +16,7 @@ import { buildPortalBasePath, resolvePortalAppFromApiBaseUrl, resolvePortalStora
 import { buildPortalCommandEnv } from './portal-command-env.js';
 import { updatePortalEnvFiles } from './portal-env-files.js';
 import { mergePortalConfigIntoOptions, readPortalConfig } from './portal-config.js';
-import { run } from './run-npm.js';
+import { run, runPnpmCommand } from './run-npm.js';
 const portalDeployText = (key, values, fallback) => translateCli(`commands.portalDeploy.${key}`, values, { fallback });
 const DEPLOY_OPERATION = {
     method: 'POST',
@@ -208,13 +208,13 @@ export async function deployPortalWorkspace(options) {
         portalBase,
     });
     const runCommand = options.runCommand ?? run;
-    await runCommand('pnpm', ['install'], {
+    await runPnpmCommand(runCommand, ['install'], {
         cwd: portalDir,
         env: buildPortalCommandEnv(),
         envMode: 'replace',
         errorName: 'pnpm install',
     });
-    await runCommand('pnpm', ['build'], {
+    await runPnpmCommand(runCommand, ['build'], {
         cwd: portalDir,
         env: buildPortalCommandEnv({
             NOCOBASE_API_URL: apiBaseUrl,
@@ -223,7 +223,7 @@ export async function deployPortalWorkspace(options) {
         envMode: 'replace',
         errorName: 'pnpm build',
     });
-    await runCommand('pnpm', ['build:html'], {
+    await runPnpmCommand(runCommand, ['build:html'], {
         cwd: portalDir,
         env: buildPortalCommandEnv({
             NOCOBASE_API_URL: apiBaseUrl,

package/dist/lib/portal-dev.js

@@ -12,7 +12,7 @@ import { translateCli } from './cli-locale.js';
 import { buildPortalBasePath, resolvePortalAppFromApiBaseUrl, resolvePortalStoragePath, validatePortalSlug, } from './portal-create.js';
 import { buildPortalCommandEnv } from './portal-command-env.js';
 import { updatePortalEnvFiles } from './portal-env-files.js';
-import { run } from './run-npm.js';
+import { run, runPnpmCommand } from './run-npm.js';
 const portalDevText = (key, values, fallback) => translateCli(`commands.portalDev.${key}`, values, { fallback });
 function trimValue(value) {
     return String(value ?? '').trim();
@@ -66,7 +66,7 @@ export async function devPortalWorkspace(options) {
     };
     options.onStart?.(result);
     const runCommand = options.runCommand ?? run;
-    await runCommand('pnpm', ['dev'], {
+    await runPnpmCommand(runCommand, ['dev'], {
         cwd: portalDir,
         env: buildPortalCommandEnv({
             NOCOBASE_API_URL: apiBaseUrl,

package/dist/lib/portal-source.js

@@ -19,7 +19,7 @@ import { buildPortalCommandEnv } from './portal-command-env.js';
 import { buildPortalBasePath, resolvePortalAppFromApiBaseUrl, resolvePortalStoragePath, validatePortalSlug, } from './portal-create.js';
 import { listPortalWorkspaces } from './portal-list.js';
 import { findPortalListItem } from './portal-info.js';
-import { run } from './run-npm.js';
+import { run, runPnpmCommand } from './run-npm.js';
 const execFileAsync = promisify(execFile);
 const portalSourceText = (key, values, fallback) => translateCli(`commands.portalSource.${key}`, values, { fallback });
 const PULL_SOURCE_OPERATION = {
@@ -194,7 +194,7 @@ async function installPortalDependencies(params) {
         };
     }
     const runCommand = params.runCommand ?? run;
-    await runCommand('pnpm', ['install'], {
+    await runPnpmCommand(runCommand, ['install'], {
         cwd: params.portalDir,
         env: buildPortalCommandEnv(),
         envMode: 'replace',

package/dist/lib/prompt-web-ui.js

@@ -765,11 +765,10 @@ function runPromptCatalogWebUIImpl(options) {
             }
         };
         const servePage = (port) => {
-            const base = `http://${publicHost}:${port}`;
             const formInner = buildPwcFormHtml(catalog, formDefaults, initialShow, pwcStepDefs, 0, pwcNSteps, locale, uiText);
             const wizardClientJson = JSON.stringify({ n: pwcNSteps, stepDefs: pwcStepDefs });
-            const pwcValStepUrl = pwcNSteps > 1 ? JSON.stringify(base + resolveValidateStepPath) : 'null';
-            const pwcValFieldUrl = JSON.stringify(base + resolveValidateFieldPath);
+            const pwcValStepUrl = pwcNSteps > 1 ? JSON.stringify(resolveValidateStepPath) : 'null';
+            const pwcValFieldUrl = JSON.stringify(resolveValidateFieldPath);
             const uiTextJson = JSON.stringify(uiText);
             const pwcShellClass = options.stages && options.stages.length > 0
                 ? 'pwc-shell pwc-shell--stages'
@@ -1493,8 +1492,8 @@ function runPromptCatalogWebUIImpl(options) {
   </div>
   <script>
   (function () {
-    var sub = ${JSON.stringify(base + submitPath)};
-    var ref = ${JSON.stringify(base + reflowPath)};
+    var sub = ${JSON.stringify(submitPath)};
+    var ref = ${JSON.stringify(reflowPath)};
     var pwcValStep = ${pwcValStepUrl};
     var pwcValField = ${pwcValFieldUrl};
     var pwcStepMeta = ${JSON.stringify(PWC_FORM_META_STEP)};

package/dist/lib/run-npm.js

@@ -75,18 +75,36 @@ function buildProcessEnv(options) {
     };
 }
 function createMissingCommandError(name, label, error) {
-    const code = error && typeof error === 'object' && 'code' in error ? String(error.code) : undefined;
-    if (code !== 'ENOENT') {
-        return undefined;
-    }
     if (!Object.prototype.hasOwnProperty.call(MISSING_COMMAND_SPECS, name)) {
         return undefined;
     }
     const spec = MISSING_COMMAND_SPECS[name];
+    if (!isMissingCommandError(name, spec.displayName, error)) {
+        return undefined;
+    }
     return new Error(translateCli('commands.shared.missingCommand', { action: label, displayName: spec.displayName, configKey: spec.configKey }, {
         fallback: `Couldn't run \`${label}\` because the ${spec.displayName} executable could not be found. Install ${spec.displayName} or update \`nb config set ${spec.configKey} <path>\` and try again.`,
     }));
 }
+function isMissingCommandError(name, displayName, error) {
+    const code = error && typeof error === 'object' && 'code' in error ? String(error.code) : undefined;
+    if (code === 'ENOENT') {
+        return true;
+    }
+    const message = error instanceof Error ? error.message : String(error);
+    const lowerMessage = message.toLowerCase();
+    return (lowerMessage.includes(`spawn ${name.toLowerCase()} enoent`) ||
+        lowerMessage.includes(`${name.toLowerCase()} executable could not be found`) ||
+        lowerMessage.includes(`${displayName.toLowerCase()} executable could not be found`));
+}
+export async function runPnpmCommand(runCommand, args, options) {
+    try {
+        await runCommand('pnpm', args, options);
+    }
+    catch (error) {
+        throw createMissingCommandError('pnpm', options.errorName ?? `pnpm ${args.join(' ')}`.trim(), error) ?? error;
+    }
+}
 function isDockerDaemonUnavailableError(error) {
     const message = error instanceof Error ? error.message : String(error);
     return DOCKER_DAEMON_UNAVAILABLE_PATTERNS.some((pattern) => pattern.test(message));

package/dist/lib/runtime-generator.js

@@ -18,7 +18,31 @@ import { createHash } from 'node:crypto';
 import { loadBuildConfig } from './build-config.js';
 import { toKebabCase, toLogicalActionName, toLogicalResourceName, toResourceSegments } from './naming.js';
 import { collectOperations } from './openapi.js';
-const RESERVED_FLAG_NAMES = new Set(['api-base-url', 'base-url', 'env', 'token', 'json-output', 'body', 'body-file', 'yes']);
+const RESERVED_FLAG_NAMES = new Set(['api-base-url', 'base-url', 'env', 'token', 'json-output', 'body', 'body-file', 'ui', 'yes']);
+const isRecord = (value) => value !== null && typeof value === 'object' && !Array.isArray(value);
+const isStringArray = (value) => Array.isArray(value) && value.every((item) => typeof item === 'string' && Boolean(item));
+function getGeneratedUIOperation(operation, parameters) {
+    if (!operation.operationId) {
+        return undefined;
+    }
+    const extension = operation['x-nocobase-cli-ui'];
+    if (!isRecord(extension) || typeof extension.path !== 'string') {
+        return undefined;
+    }
+    const path = extension.path.trim();
+    if (!path || path.startsWith('/') || /[?#]/.test(path) || /^[a-z][a-z\d+.-]*:/i.test(path)) {
+        return undefined;
+    }
+    const mappedParameters = extension.parameters === undefined ? [] : extension.parameters;
+    if (!isStringArray(mappedParameters) || new Set(mappedParameters).size !== mappedParameters.length) {
+        return undefined;
+    }
+    const allowedParameters = new Set(parameters.map((parameter) => parameter.name));
+    if (!mappedParameters.every((parameter) => allowedParameters.has(parameter))) {
+        return undefined;
+    }
+    return { path, parameters: mappedParameters };
+}
 function matchesPattern(value, pattern) {
     if (!value) {
         return false;
@@ -425,6 +449,7 @@ export async function generateRuntime(document, configFile, baseUrl) {
         const parameters = (operation.parameters ?? []).filter(isSupportedParameter).map((parameter) => toGeneratedParameter(parameter, usedFlagNames));
         const bodyParameters = extractBodyParameters(operation.requestBody, usedFlagNames);
         const allParameters = [...parameters, ...bodyParameters];
+        const ui = getGeneratedUIOperation(operation, allParameters);
         const hasBody = Boolean(operation.requestBody && !('$ref' in operation.requestBody));
         const requestContentType = getRequestContentType(operation.requestBody);
         const responseType = getResponseType(operation);
@@ -456,6 +481,8 @@ export async function generateRuntime(document, configFile, baseUrl) {
             resourceDisplayName,
             resourceDescription,
             commandId: segments.join(' '),
+            operationId: operation.operationId,
+            ui,
             method,
             pathTemplate,
             tags: operation.tags,

package/dist/lib/swagger-command.js

@@ -0,0 +1,52 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Flags } from '@oclif/core';
+import { executeRawApiRequest } from './api-client.js';
+import { ensureCrossEnvConfirmed } from './env-guard.js';
+export const swaggerRequestFlags = {
+    env: Flags.string({
+        char: 'e',
+        description: 'CLI env name; omitted uses the current env',
+    }),
+    yes: Flags.boolean({
+        char: 'y',
+        description: 'Confirm using --env when it targets a different env than the current env',
+        default: false,
+    }),
+    'api-base-url': Flags.string({
+        description: 'NocoBase API base URL, for example http://localhost:13000/api',
+    }),
+    role: Flags.string({
+        description: 'Role override, sent as X-Role',
+    }),
+    token: Flags.string({
+        char: 't',
+        description: 'API key or access token override',
+    }),
+};
+export async function executeSwaggerRequest(command, flags, path, query) {
+    const requestedEnv = flags.env?.trim() || undefined;
+    const confirmed = await ensureCrossEnvConfirmed({
+        command,
+        requestedEnv,
+        yes: flags.yes,
+    });
+    if (!confirmed) {
+        return undefined;
+    }
+    return executeRawApiRequest({
+        envName: requestedEnv,
+        baseUrl: flags['api-base-url'],
+        token: flags.token,
+        role: flags.role,
+        method: 'GET',
+        path,
+        query,
+    });
+}

package/dist/locale/en-US.json

@@ -259,6 +259,32 @@
         "localSynced": "Local synced"
       }
     },
+    "swagger": {
+      "errors": {
+        "pluginDisabled": "The API documentation plugin is not enabled. Enable it before requesting Swagger documents.",
+        "requestFailed": "Swagger request failed with status {{status}}\n{{details}}",
+        "invalidDestinations": "swagger:getUrls returned an invalid destination list.",
+        "invalidDocument": "swagger:get returned an invalid OpenAPI document."
+      },
+      "messages": {
+        "empty": "No Swagger document namespaces are available.",
+        "saved": "Saved Swagger document to {{output}}."
+      },
+      "table": {
+        "name": "Name",
+        "namespace": "Namespace",
+        "url": "URL",
+        "field": "Field",
+        "value": "Value"
+      },
+      "fields": {
+        "namespace": "Namespace",
+        "title": "Title",
+        "version": "Version",
+        "openapi": "OpenAPI",
+        "paths": "Paths"
+      }
+    },
     "portalInfo": {
       "errors": {
         "envNotConfigured": "Env \"{{envName}}\" is not configured. Run `nb env add {{envName}} --api-base-url <url>` first.",

package/dist/locale/zh-CN.json

@@ -259,6 +259,32 @@
         "localSynced": "本地已同步"
       }
     },
+    "swagger": {
+      "errors": {
+        "pluginDisabled": "API 文档插件尚未启用。请先启用该插件，再获取 Swagger 文档。",
+        "requestFailed": "Swagger 请求失败，状态码 {{status}}\n{{details}}",
+        "invalidDestinations": "swagger:getUrls 返回了无效的文档列表。",
+        "invalidDocument": "swagger:get 返回了无效的 OpenAPI 文档。"
+      },
+      "messages": {
+        "empty": "没有可用的 Swagger 文档命名空间。",
+        "saved": "Swagger 文档已保存到 {{output}}。"
+      },
+      "table": {
+        "name": "名称",
+        "namespace": "命名空间",
+        "url": "URL",
+        "field": "字段",
+        "value": "值"
+      },
+      "fields": {
+        "namespace": "命名空间",
+        "title": "标题",
+        "version": "版本",
+        "openapi": "OpenAPI",
+        "paths": "路径数"
+      }
+    },
     "portalInfo": {
       "errors": {
         "envNotConfigured": "env \"{{envName}}\" 尚未配置。请先运行 `nb env add {{envName}} --api-base-url <url>`。",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.4",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
@@ -147,5 +147,5 @@
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "a3faea21082b30989301de04591ee1b91fd4e6a5"
+  "gitHead": "6658768567378382de758c4e814ac510d688400c"
 }