@nocobase/cli 2.2.0-test.16 → 3.0.0-alpha.1

package/dist/commands/portal/config.js

@@ -0,0 +1,88 @@
+/**
+ * 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 { Args, Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { configurePortalWorkspace } from '../../lib/portal-configure.js';
+import { printInfo, printSuccess } from '../../lib/ui.js';
+const portalConfigureText = (key, values, fallback) => translateCli(`commands.portalConfigure.${key}`, values, { fallback });
+export default class PortalConfig extends Command {
+    static summary = 'Update portal source configuration';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer --source-storage nocobase',
+        '<%= config.bin %> <%= command.id %> customer --source-storage git --git-repo git@github.com:nocobase/customer-portal.git',
+        '<%= config.bin %> <%= command.id %> customer --git-branch main --git-path portals/customer',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name',
+        }),
+    };
+    static flags = {
+        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,
+        }),
+        'source-storage': Flags.string({
+            description: 'Where portal source code is managed',
+            options: ['nocobase', 'git'],
+        }),
+        'git-repo': Flags.string({
+            description: 'Git repository URL used when --source-storage=git',
+        }),
+        'git-branch': Flags.string({
+            description: 'Git branch used when --source-storage=git',
+        }),
+        'git-path': Flags.string({
+            description: 'Directory inside the Git repository for this portal; defaults to the repository root',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalConfig);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalConfigureText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await configurePortalWorkspace({
+            portal: args.portal,
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+            sourceStorage: flags['source-storage'],
+            gitRepo: flags['git-repo'],
+            gitBranch: flags['git-branch'],
+            gitPath: flags['git-path'],
+        });
+        printSuccess(portalConfigureText('messages.updated', { portal: result.portal, portalDir: result.portalDir }, `Portal "${result.portal}" configuration updated at ${result.portalDir}/portal.config.json.`));
+        printInfo(result.remoteSynced
+            ? portalConfigureText('messages.remoteSynced', undefined, 'Remote portal record: synced')
+            : portalConfigureText('messages.remoteSkipped', undefined, 'Remote portal record: not found; local config only'));
+    }
+}

package/dist/commands/portal/create.js

@@ -16,7 +16,7 @@ import { printInfo, printSuccess } from '../../lib/ui.js';
 const DEFAULT_PORTAL_TEMPLATE = '@nocobase/portal-template-default';
 const portalCreateText = (key, values, fallback) => translateCli(`commands.portalCreate.${key}`, values, { fallback });
 export default class PortalCreate extends Command {
-    static summary = 'Create a local Portal workspace from a template';
+    static summary = 'Create a local AI portal from a template';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer',
         '<%= config.bin %> <%= command.id %> customer --template @nocobase/portal-template-default',
@@ -26,7 +26,7 @@ export default class PortalCreate extends Command {
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'AI Portal name',
         }),
     };
     static flags = {
@@ -47,11 +47,11 @@ export default class PortalCreate extends Command {
             description: 'Portal display title; defaults to a title generated from the portal slug',
         }),
         force: Flags.boolean({
-            description: 'Delete the existing Portal workspace and recreate it',
+            description: 'Delete the existing portal and recreate it',
             default: false,
         }),
         'source-storage': Flags.string({
-            description: 'Where Portal source code is managed',
+            description: 'Where portal source code is managed',
             options: ['nocobase', 'git'],
             default: 'nocobase',
         }),
@@ -62,7 +62,7 @@ export default class PortalCreate extends Command {
             description: 'Git branch used when --source-storage=git',
         }),
         'git-path': Flags.string({
-            description: 'Directory inside the Git repository for this Portal; defaults to the portal slug',
+            description: 'Directory inside the Git repository for this portal; defaults to the repository root',
         }),
     };
     async run() {
@@ -76,7 +76,8 @@ export default class PortalCreate extends Command {
         if (!confirmed) {
             return;
         }
-        const env = await getEnv(flags.env, { scope: resolveDefaultConfigScope() });
+        const scope = resolveDefaultConfigScope();
+        const env = await getEnv(flags.env, { scope });
         if (!env) {
             this.error(flags.env
                 ? portalCreateText('errors.envNotConfigured', { envName: flags.env }, `Env "${flags.env}" is not configured. Run \`nb env add ${flags.env} --api-base-url <url>\` first.`)

package/dist/commands/portal/deploy.js

@@ -17,7 +17,7 @@ import { listPortalWorkspaces } from '../../lib/portal-list.js';
 import { printSuccess } from '../../lib/ui.js';
 const portalDeployText = (key, values, fallback) => translateCli(`commands.portalDeploy.${key}`, values, { fallback });
 export default class PortalDeploy extends Command {
-    static summary = 'Build and deploy a Portal workspace';
+    static summary = 'Build and deploy a portal';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer',
         '<%= config.bin %> <%= command.id %> customer --env dev --yes',
@@ -25,7 +25,7 @@ export default class PortalDeploy extends Command {
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'Portal name',
         }),
     };
     static flags = {

package/dist/commands/portal/destroy.js

@@ -20,11 +20,11 @@ async function ensureDestroyConfirmed(options) {
         return true;
     }
     if (!isInteractiveTerminal()) {
-        options.command.error(portalDestroyText('errors.confirmationRequired', undefined, 'Refusing to destroy a Portal in non-interactive mode without --yes.'));
+        options.command.error(portalDestroyText('errors.confirmationRequired', undefined, 'Refusing to destroy a portal in non-interactive mode without --yes.'));
     }
     try {
         return Boolean(await confirm({
-            message: portalDestroyText('prompts.confirm', { portal: options.portal }, `Destroy Portal "${options.portal}" and delete its storage directory?`),
+            message: portalDestroyText('prompts.confirm', { portal: options.portal }, `Destroy portal "${options.portal}" and delete its storage directory?`),
             default: false,
         }));
     }
@@ -33,7 +33,7 @@ async function ensureDestroyConfirmed(options) {
     }
 }
 export default class PortalDestroy extends Command {
-    static summary = 'Destroy a Portal record and its local workspace';
+    static summary = 'Destroy a portal record and local files';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer --yes',
         '<%= config.bin %> <%= command.id %> customer --env dev --yes',
@@ -42,7 +42,7 @@ export default class PortalDestroy extends Command {
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'Portal name',
         }),
     };
     static flags = {
@@ -56,7 +56,7 @@ export default class PortalDestroy extends Command {
             default: false,
         }),
         force: Flags.boolean({
-            description: 'Ignore missing Portal records or workspace directories',
+            description: 'Ignore missing portal records or local files',
             default: false,
         }),
     };
@@ -99,6 +99,6 @@ export default class PortalDestroy extends Command {
         printInfo(portalDestroyText('messages.app', { app: result.app }, `App: ${result.app}`));
         printInfo(portalDestroyText('messages.base', { base: result.portalBase }, `Base: ${result.portalBase}`));
         printInfo(portalDestroyText('messages.record', { status: result.recordDeleted ? 'deleted' : 'missing' }, `Record: ${result.recordDeleted ? 'deleted' : 'missing'}`));
-        printInfo(portalDestroyText('messages.workspace', { dir: result.portalDir, status: result.workspaceDeleted ? 'deleted' : 'missing' }, `Workspace: ${result.workspaceDeleted ? 'deleted' : 'missing'} (${result.portalDir})`));
+        printInfo(portalDestroyText('messages.workspace', { dir: result.portalDir, status: result.workspaceDeleted ? 'deleted' : 'missing' }, `Portal files: ${result.workspaceDeleted ? 'deleted' : 'missing'} (${result.portalDir})`));
     }
 }

package/dist/commands/portal/dev.js

@@ -15,7 +15,7 @@ import { devPortalWorkspace } from '../../lib/portal-dev.js';
 import { printInfo } from '../../lib/ui.js';
 const portalDevText = (key, values, fallback) => translateCli(`commands.portalDev.${key}`, values, { fallback });
 export default class PortalDev extends Command {
-    static summary = 'Start a Portal workspace in development mode';
+    static summary = 'Start a portal in development mode';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer',
         '<%= config.bin %> <%= command.id %> customer --env dev --yes',
@@ -23,7 +23,7 @@ export default class PortalDev extends Command {
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'Portal name',
         }),
     };
     static flags = {
@@ -60,7 +60,7 @@ export default class PortalDev extends Command {
             portal: args.portal,
             env,
             onStart: (result) => {
-                printInfo(portalDevText('messages.starting', { portal: result.portal }, `Starting Portal "${result.portal}"...`));
+                printInfo(portalDevText('messages.starting', { portal: result.portal }, `Starting portal "${result.portal}"...`));
                 printInfo(portalDevText('messages.mode', { mode: result.mode }, `Mode: ${result.mode}`));
                 printInfo(portalDevText('messages.app', { app: result.app }, `App: ${result.app}`));
                 printInfo(portalDevText('messages.base', { base: result.portalBase }, `Base: ${result.portalBase}`));

package/dist/commands/portal/index.js

@@ -8,7 +8,7 @@
  */
 import { Command, loadHelpClass } from '@oclif/core';
 export default class Portal extends Command {
-    static summary = 'Manage Portal workspaces';
+    static summary = 'Manage portals';
     async run() {
         await this.parse(Portal);
         const Help = await loadHelpClass(this.config);

package/dist/commands/portal/info.js

@@ -15,7 +15,7 @@ import { findPortalListItem, formatPortalInfo } from '../../lib/portal-info.js';
 import { listPortalWorkspaces, toPortalOutputItem } from '../../lib/portal-list.js';
 const portalInfoText = (key, values, fallback) => translateCli(`commands.portalInfo.${key}`, values, { fallback });
 export default class PortalInfo extends Command {
-    static summary = 'Show Portal record and local workspace details';
+    static summary = 'Show portal record and local file details';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer',
         '<%= config.bin %> <%= command.id %> customer --env dev --yes',
@@ -24,7 +24,7 @@ export default class PortalInfo extends Command {
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'Portal name',
         }),
     };
     static flags = {
@@ -40,7 +40,7 @@ export default class PortalInfo extends Command {
         'json-output': Flags.boolean({
             char: 'j',
             aliases: ['json'],
-            description: 'Print Portal details as JSON',
+            description: 'Print portal details as JSON',
             default: false,
         }),
     };

package/dist/commands/portal/list.js

@@ -21,7 +21,7 @@ function formatBoolean(value) {
     return value ? 'yes' : 'no';
 }
 export default class PortalList extends Command {
-    static summary = 'List Portal records and local workspace sync status';
+    static summary = 'List portal records and local sync status';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
         '<%= config.bin %> <%= command.id %> --env dev --yes',
@@ -40,7 +40,7 @@ export default class PortalList extends Command {
         'json-output': Flags.boolean({
             char: 'j',
             aliases: ['json'],
-            description: 'Print Portal records as JSON',
+            description: 'Print portal records as JSON',
             default: false,
         }),
     };
@@ -74,13 +74,13 @@ export default class PortalList extends Command {
             return;
         }
         if (!outputItems.length) {
-            printInfo(portalListText('messages.empty', undefined, 'No Portal records found.'));
+            printInfo(portalListText('messages.empty', undefined, 'No portal records found.'));
             return;
         }
         this.log(renderTable([
             portalListText('table.name', undefined, 'Name'),
             portalListText('table.url', undefined, 'URL'),
-            portalListText('table.developmentMode', undefined, 'Development mode'),
+            portalListText('table.portalType', undefined, 'Portal type'),
             portalListText('table.sourceStorage', undefined, 'Source storage'),
             portalListText('table.path', undefined, 'Local path'),
             portalListText('table.enabled', undefined, 'Enabled'),
@@ -88,7 +88,7 @@ export default class PortalList extends Command {
         ], outputItems.map((item) => [
             item.name,
             item.url,
-            item.developmentMode,
+            item.portalType,
             item.sourceStorage,
             item.localPath,
             formatBoolean(item.enabled),

package/dist/commands/portal/pull.js

@@ -15,16 +15,17 @@ import { pullPortalSource } from '../../lib/portal-source.js';
 import { printInfo, printSuccess } from '../../lib/ui.js';
 const portalPullText = (key, values, fallback) => translateCli(`commands.portalPull.${key}`, values, { fallback });
 export default class PortalPull extends Command {
-    static summary = 'Pull Portal source into the local workspace';
+    static summary = 'Pull portal source into local files';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer',
         '<%= config.bin %> <%= command.id %> customer --env prod --yes',
         '<%= config.bin %> <%= command.id %> customer --force',
+        '<%= config.bin %> <%= command.id %> customer --no-install',
     ];
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'Portal name',
         }),
     };
     static flags = {
@@ -38,9 +39,14 @@ export default class PortalPull extends Command {
             default: false,
         }),
         force: Flags.boolean({
-            description: 'Delete the existing local workspace and pull it again',
+            description: 'Delete the existing local files and pull them again',
             default: false,
         }),
+        install: Flags.boolean({
+            description: 'Run pnpm install after pulling the portal source',
+            default: true,
+            allowNo: true,
+        }),
     };
     async run() {
         const { args, flags } = await this.parse(PortalPull);
@@ -67,11 +73,12 @@ export default class PortalPull extends Command {
             envName,
             cliVersion: String(this.config.pjson.version ?? '').trim(),
             force: flags.force,
+            installDependencies: flags.install,
         });
         if (!result.changed) {
             printInfo(result.noopReason ?? portalPullText('messages.noop', undefined, 'No pull is needed.'));
             return;
         }
-        printSuccess(portalPullText('messages.pulled', { portal: result.portal, portalDir: result.portalDir }, `Pulled Portal source "${result.portal}" into ${result.portalDir}.`));
+        printSuccess(portalPullText('messages.pulled', { portal: result.portal, portalDir: result.portalDir }, `Pulled portal source "${result.portal}" into ${result.portalDir}.`));
     }
 }

package/dist/commands/portal/push.js

@@ -15,7 +15,7 @@ import { pushPortalSource } from '../../lib/portal-source.js';
 import { printInfo, printSuccess } from '../../lib/ui.js';
 const portalPushText = (key, values, fallback) => translateCli(`commands.portalPush.${key}`, values, { fallback });
 export default class PortalPush extends Command {
-    static summary = 'Push local Portal source changes to source storage';
+    static summary = 'Push local portal source changes to source storage';
     static examples = [
         '<%= config.bin %> <%= command.id %> customer',
         '<%= config.bin %> <%= command.id %> customer --env prod --yes',
@@ -24,7 +24,7 @@ export default class PortalPush extends Command {
     static args = {
         portal: Args.string({
             required: true,
-            description: 'Portal name/slug',
+            description: 'Portal name',
         }),
     };
     static flags = {
@@ -73,7 +73,7 @@ export default class PortalPush extends Command {
             return;
         }
         printSuccess(portalPushText('messages.pushed', { portal: result.portal, sourceRevision: result.sourceRevision ?? '' }, result.sourceRevision
-            ? `Pushed Portal source "${result.portal}" (${result.sourceRevision}).`
-            : `Pushed Portal source "${result.portal}".`));
+            ? `Pushed portal source "${result.portal}" (${result.sourceRevision}).`
+            : `Pushed portal source "${result.portal}".`));
     }
 }

package/dist/lib/api-client.js

@@ -199,6 +199,13 @@ async function createMultipartBody(flags, operation) {
         if (value === undefined) {
             continue;
         }
+        if (Array.isArray(value)) {
+            for (const item of value) {
+                formData.append(parameter.name, typeof item === 'object' ? JSON.stringify(item) : String(item));
+            }
+            hasValues = hasValues || value.length > 0;
+            continue;
+        }
         formData.append(parameter.name, typeof value === 'object' ? JSON.stringify(value) : String(value));
         hasValues = true;
     }

package/dist/lib/env-auth.js

@@ -32,12 +32,12 @@ function buildDeviceVerificationPathFromApiBaseUrl(apiBaseUrl) {
     const subappMatch = url.pathname.match(/^(.*)\/api\/__app\/([^/]+)\/?$/);
     if (subappMatch) {
         const publicPath = (subappMatch[1] || '').replace(/\/+$/, '');
-        return `${publicPath}/apps/${subappMatch[2]}/idpOAuth/device`;
+        return `${publicPath}/settings/apps/${subappMatch[2]}/idpOAuth/device`;
     }
     const appMatch = url.pathname.match(/^(.*)\/api\/?$/);
     if (appMatch) {
         const publicPath = (appMatch[1] || '').replace(/\/+$/, '');
-        return `${publicPath}/idpOAuth/device`;
+        return `${publicPath}/settings/idpOAuth/device`;
     }
     return undefined;
 }

package/dist/lib/env-config.js

@@ -36,7 +36,7 @@ const STRING_ENV_CONFIG_KEYS = [
     'dbSchema',
     'dbTablePrefix',
     'lang',
-    'developmentMode',
+    'portalType',
     'portalName',
     'portalTemplate',
     'rootUsername',