@nocobase/cli 2.2.0-beta.9 → 2.2.0-test.15

package/dist/commands/portal/push.js

@@ -0,0 +1,79 @@
+/**
+ * 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 { 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 examples = [
+        '<%= config.bin %> <%= command.id %> customer',
+        '<%= config.bin %> <%= command.id %> customer --env prod --yes',
+        '<%= config.bin %> <%= command.id %> customer --message "Update customer portal"',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    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,
+        }),
+        message: Flags.string({
+            char: 'm',
+            description: 'Source update message; used as the Git commit message for Git-managed source',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalPush);
+        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(portalPushText(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 pushPortalSource({
+            portal: args.portal,
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+            message: flags.message,
+        });
+        if (!result.changed) {
+            printInfo(result.noopReason ?? portalPushText('messages.noop', undefined, 'No push is needed.'));
+            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}".`));
+    }
+}

package/dist/commands/source/dev.js

@@ -140,7 +140,7 @@ export default class SourceDev extends Command {
                     : `Run \`nb app stop --env ${runtime.envName}\` before starting dev mode, or choose another dev port with --port.`,
             ].join('\n'));
         }
-        const npmArgs = ['dev', '--rsbuild'];
+        const npmArgs = ['dev', '--rsbuild', '--quickstart'];
         if (flags['db-sync']) {
             npmArgs.push('--db-sync');
         }

package/dist/commands/source/download.js

@@ -345,8 +345,8 @@ export default class SourceDownload extends Command {
                     label: downloadText('prompts.dockerPlatform.autoLabel'),
                     hint: downloadText('prompts.dockerPlatform.autoHint'),
                 },
-                { value: 'linux/amd64', label: 'linux/amd64' },
-                { value: 'linux/arm64', label: 'linux/arm64' },
+                { value: 'linux/amd64', label: 'amd64' },
+                { value: 'linux/arm64', label: 'arm64' },
             ],
             initialValue: DEFAULT_DOCKER_PLATFORM,
             yesInitialValue: DEFAULT_DOCKER_PLATFORM,

package/dist/lib/auth-store.js

@@ -97,6 +97,7 @@ function normalizeAuthConfig(config) {
     const locale = normalizeOptionalCliLocale(settings.locale);
     const defaultUiHost = normalizeOptionalString(settings.init?.defaultUiHost);
     const defaultApiHost = normalizeOptionalString(settings.init?.defaultApiHost);
+    const defaultPortalTemplate = normalizeOptionalString(settings.init?.defaultPortalTemplate);
     const updatePolicy = normalizeOptionalCliUpdatePolicy(settings.update?.policy);
     const logRetentionDays = typeof settings.log?.retentionDays === 'number' && Number.isInteger(settings.log.retentionDays)
         ? settings.log.retentionDays
@@ -117,11 +118,12 @@ function normalizeAuthConfig(config) {
         name: config.name || config.dockerResourcePrefix,
         settings: {
             ...(locale ? { locale } : {}),
-            ...(defaultUiHost || defaultApiHost
+            ...(defaultUiHost || defaultApiHost || defaultPortalTemplate
                 ? {
                     init: {
                         ...(defaultUiHost ? { defaultUiHost } : {}),
                         ...(defaultApiHost ? { defaultApiHost } : {}),
+                        ...(defaultPortalTemplate ? { defaultPortalTemplate } : {}),
                     },
                 }
                 : {}),

package/dist/lib/cli-config.js

@@ -34,6 +34,7 @@ export const SUPPORTED_CLI_CONFIG_KEYS = [
     'locale',
     'default-ui-host',
     'default-api-host',
+    'default-portal-template',
     'update.policy',
     'license.pkg-url',
     'docker.network',
@@ -120,7 +121,10 @@ function pruneSettings(config) {
         delete config.settings.locale;
     }
     const init = config.settings?.init;
-    if (init && !trimValue(init.defaultUiHost) && !trimValue(init.defaultApiHost)) {
+    if (init &&
+        !trimValue(init.defaultUiHost) &&
+        !trimValue(init.defaultApiHost) &&
+        !trimValue(init.defaultPortalTemplate)) {
         delete config.settings?.init;
     }
     const update = config.settings?.update;
@@ -181,6 +185,8 @@ export function getExplicitCliConfigValue(config, key) {
             return trimValue(config.settings?.init?.defaultUiHost);
         case 'default-api-host':
             return trimValue(config.settings?.init?.defaultApiHost);
+        case 'default-portal-template':
+            return trimValue(config.settings?.init?.defaultPortalTemplate);
         case 'update.policy':
             return normalizeCliUpdatePolicy(config.settings?.update?.policy);
         case 'license.pkg-url':
@@ -233,6 +239,8 @@ export function getEffectiveCliConfigValue(config, key) {
             return '127.0.0.1';
         case 'default-api-host':
             return '127.0.0.1';
+        case 'default-portal-template':
+            return explicit ?? '';
         case 'update.policy':
             return explicit ?? DEFAULT_UPDATE_POLICY;
         case 'license.pkg-url':
@@ -242,7 +250,9 @@ export function getEffectiveCliConfigValue(config, key) {
         case 'docker.container-prefix':
             return trimValue(config.name) || DEFAULT_DOCKER_CONTAINER_PREFIX;
         case 'nb-image-registry':
-            return explicit ?? DEFAULT_NB_IMAGE_REGISTRY;
+            return explicit ?? (resolveCliLocale(undefined, { configuredLocale: trimValue(config.settings?.locale) }) === 'zh-CN'
+                ? 'aliyun'
+                : DEFAULT_NB_IMAGE_REGISTRY);
         case 'nb-image-variant':
             return explicit ?? DEFAULT_NB_IMAGE_VARIANT;
         case 'bin.docker':
@@ -375,6 +385,12 @@ export async function setCliConfigValue(key, value, options = {}) {
                 defaultApiHost: normalized,
             };
             break;
+        case 'default-portal-template':
+            config.settings.init = {
+                ...(config.settings.init ?? {}),
+                defaultPortalTemplate: normalized,
+            };
+            break;
         case 'update.policy':
             config.settings.update = {
                 ...(config.settings.update ?? {}),
@@ -510,6 +526,11 @@ export async function deleteCliConfigValue(key, options = {}) {
                 delete config.settings.init.defaultApiHost;
             }
             break;
+        case 'default-portal-template':
+            if (config.settings.init) {
+                delete config.settings.init.defaultPortalTemplate;
+            }
+            break;
         case 'update.policy':
             if (config.settings.update) {
                 delete config.settings.update.policy;

package/dist/lib/env-config.js

@@ -36,6 +36,9 @@ const STRING_ENV_CONFIG_KEYS = [
     'dbSchema',
     'dbTablePrefix',
     'lang',
+    'developmentMode',
+    'portalName',
+    'portalTemplate',
     'rootUsername',
     'rootEmail',
     'rootPassword',

package/dist/lib/env-proxy.js

@@ -23,6 +23,7 @@ const DEFAULT_MODERN_CLIENT_PREFIX = 'v';
 const DEFAULT_API_CLIENT_STORAGE_PREFIX = 'NOCOBASE_';
 const DEFAULT_API_CLIENT_STORAGE_TYPE = 'localStorage';
 const DEFAULT_ESM_CDN_BASE_URL = 'https://esm.sh';
+const PORTAL_CLIENT_PREFIX = 'x';
 const LOCAL_APP_PACKAGE_JSON_PATH = 'node_modules/@nocobase/app/package.json';
 const MANAGED_PROXY_BLOCK_BEGIN = '# BEGIN NocoBase proxy';
 const MANAGED_PROXY_BLOCK_END = '# END NocoBase proxy';
@@ -489,6 +490,7 @@ function buildNginxManagedConfigBlock(context) {
     const v2PublicPathNoTrailingSlash = trimTrailingSlash(context.v2PublicPath);
     const apiBasePathNoTrailingSlash = trimTrailingSlash(context.apiBasePath);
     const appPublicPathNoTrailingSlash = trimTrailingSlash(context.appPublicPath);
+    const fileAccessPath = `${context.appPublicPath}files/`;
     const isRootMounted = context.appPublicPath === '/';
     const appPublicPathRedirectBlock = isRootMounted
         ? ''
@@ -526,6 +528,22 @@ function buildNginxManagedConfigBlock(context) {
         `        include ${context.snippetsDir}/proxy-location.conf;`,
         '    }',
         '',
+        `    location ^~ ${fileAccessPath} {`,
+        `        proxy_pass ${context.backendUrl};`,
+        `        include ${context.snippetsDir}/proxy-location.conf;`,
+        '    }',
+        ...(!isRootMounted
+            ? [
+                '',
+                '    location ^~ /files/ {',
+                `        proxy_pass ${context.backendUrl};`,
+                `        include ${context.snippetsDir}/proxy-location.conf;`,
+                '    }',
+            ]
+            : []),
+        '',
+        buildNginxPortalLocationBlock(context),
+        '',
         `    location = ${apiBasePathNoTrailingSlash} {`,
         `        return 308 ${context.apiBasePath}$is_args$args;`,
         '    }',
@@ -551,7 +569,7 @@ function buildNginxManagedConfigBlock(context) {
         `        include ${context.snippetsDir}/spa-location.conf;`,
         '    }',
         '',
-        `    location ^~ ${context.appPublicPath} {`,
+        `    location ${context.appPublicPath} {`,
         `        alias ${context.publicDir}/;`,
         `        try_files $uri /index-v1.html =404;`,
         `        include ${context.snippetsDir}/spa-location.conf;`,
@@ -560,6 +578,65 @@ function buildNginxManagedConfigBlock(context) {
         `    ${MANAGED_NGINX_CONFIG_BLOCK_END}`,
     ].join('\n');
 }
+function buildNginxPortalRootPublicPath(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 portalBasePathPattern = escapeRegExp(portalBasePath);
+    return [
+        `    location ^~ ${portalBasePath}/apps/ {`,
+        '        absolute_redirect off;',
+        '',
+        `        if ($uri ~ ^${portalBasePathPattern}/apps/(?<subapp>[A-Za-z0-9_-]+)/(?<portal>[A-Za-z0-9_-]+)$) {`,
+        `            return 308 ${portalBasePath}/apps/$subapp/$portal/$is_args$args;`,
+        '        }',
+        '',
+        `        if ($uri !~ ^${portalBasePathPattern}/apps/(?<subapp>[A-Za-z0-9_-]+)/(?<portal>[A-Za-z0-9_-]+)/(?<portal_path>.*)$) {`,
+        '            return 404;',
+        '        }',
+        '',
+        `        root ${context.storageDir};`,
+        '',
+        '        if ($portal_path = "") {',
+        '            rewrite ^ /portals/$subapp/$portal/dist/index.html break;',
+        '        }',
+        '',
+        '        try_files',
+        '            /portals/$subapp/$portal/dist/$portal_path',
+        '            /portals/$subapp/$portal/dist/$portal_path/',
+        '            /portals/$subapp/$portal/dist/index.html',
+        '            =404;',
+        '    }',
+        '',
+        `    location ^~ ${portalBasePath}/ {`,
+        '        absolute_redirect off;',
+        '',
+        `        if ($uri ~ ^${portalBasePathPattern}/(?<portal>[A-Za-z0-9_-]+)$) {`,
+        `            return 308 ${portalBasePath}/$portal/$is_args$args;`,
+        '        }',
+        '',
+        `        if ($uri !~ ^${portalBasePathPattern}/(?<portal>[A-Za-z0-9_-]+)/(?<portal_path>.*)$) {`,
+        '            return 404;',
+        '        }',
+        '',
+        `        root ${context.storageDir};`,
+        '',
+        '        if ($portal_path = "") {',
+        '            rewrite ^ /portals/main/$portal/dist/index.html break;',
+        '        }',
+        '',
+        '        try_files',
+        '            /portals/main/$portal/dist/$portal_path',
+        '            /portals/main/$portal/dist/$portal_path/',
+        '            /portals/main/$portal/dist/index.html',
+        '            =404;',
+        '    }',
+        '',
+    ].join('\n');
+}
 function buildNginxRuntimeConfig(context, variant) {
     return {
         __webpack_public_path__: context.cdnBaseUrl,
@@ -593,6 +670,7 @@ async function buildEnvProxyNginxRenderContext(source, options) {
     const mappedPublicDir = await mapProxyPathFromCliRoot(publicDir, options);
     const mappedSnippetsDir = await mapProxyPathFromCliRoot(snippetsDir, options);
     const mappedDistRootDir = await mapProxyPathFromCliRoot(distRootDir, options);
+    const mappedStorageDir = await mapProxyPathFromCliRoot(source.storagePath, options);
     const mappedUploadsDir = await mapProxyPathFromCliRoot(uploadsDir, options);
     const v2PublicPath = `${source.settings.appPublicPath.replace(/\/$/, '')}/${source.settings.modernClientPrefix}/`;
     return {
@@ -617,6 +695,7 @@ async function buildEnvProxyNginxRenderContext(source, options) {
         modernClientPrefix: source.settings.modernClientPrefix,
         proxyHost,
         snippetsDir: mappedSnippetsDir,
+        storageDir: mappedStorageDir,
         uploadsDir: mappedUploadsDir,
         v2PublicPath,
         wsPath: source.settings.wsPath,
@@ -1000,15 +1079,17 @@ function renderNginxLocationTemplate(context) {
         default_type text/markdown;
         add_header Cache-Control "public";
         add_header Content-Disposition "inline";
+        add_header Content-Security-Policy "sandbox" always;
         add_header X-Content-Type-Options "nosniff" always;
         access_log off;
         autoindex off;
     }
 
-    location ~* ^${context.appPublicPath}storage/uploads/(.*\\.(?:htm|html|svg|svgz|xhtml|pdf))$ {
+    location ~* ^${context.appPublicPath}storage/uploads/(.*\\.(?:htm|html|pdf|svg|svgz|xht|xhtml|xml|xsl|xslt))$ {
         alias ${context.uploadsPath}/$1;
         add_header Cache-Control "public";
         add_header Content-Disposition "attachment" always;
+        add_header Content-Security-Policy "sandbox" always;
         add_header X-Content-Type-Options "nosniff" always;
         access_log off;
         autoindex off;
@@ -1017,6 +1098,7 @@ function renderNginxLocationTemplate(context) {
     location ${context.appPublicPath}storage/uploads/ {
         alias ${context.uploadsPath}/;
         add_header Cache-Control "public";
+        add_header Content-Security-Policy "sandbox" always;
         add_header X-Content-Type-Options "nosniff" always;
         access_log off;
         autoindex off;
@@ -1095,6 +1177,7 @@ function buildCaddyContextCommentLines(siteAddress, context, publicDir) {
 }
 function renderCaddyAppTemplate(siteAddress, context, publicDir) {
     const uploadsPath = `${context.appPublicPath}storage/uploads/`;
+    const fileAccessPathMatcher = toCaddyPathMatcher(`${context.appPublicPath}files/`);
     const distPathMatcher = toCaddyPathMatcher(context.distPath);
     const uploadsPathMatcher = toCaddyPathMatcher(uploadsPath);
     const apiPathMatcher = toCaddyPathMatcher(context.apiBasePath);
@@ -1136,10 +1219,14 @@ function renderCaddyAppTemplate(siteAddress, context, publicDir) {
         `${siteAddress} {`,
         `    encode zstd gzip${rootRedirectBlock}${appPublicPathRedirectBlock}${modernClientRedirectBlock}${shorthandModernClientRedirectBlock}`,
         '',
+        '    @activeUploadedContent path_regexp activeUploadedContent (?i)\\.(?:htm|html|pdf|svg|svgz|xht|xhtml|xml|xsl|xslt)$',
+        '',
         `    handle_path ${uploadsPathMatcher} {`,
         `        root * ${context.uploadsPath}`,
         '        header Cache-Control public',
+        '        header Content-Security-Policy sandbox',
         '        header X-Content-Type-Options nosniff',
+        '        header @activeUploadedContent Content-Disposition attachment',
         '        file_server',
         '    }',
         '',
@@ -1161,7 +1248,19 @@ function renderCaddyAppTemplate(siteAddress, context, publicDir) {
         `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
         '    }',
         '',
-        '    # Keep API and WS routes above the SPA fallbacks.',
+        '    # Keep file, API and WS routes above the SPA fallbacks.',
+        `    handle ${fileAccessPathMatcher} {`,
+        `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
+        '    }',
+        ...(context.appPublicPath === DEFAULT_APP_PUBLIC_PATH
+            ? []
+            : [
+                '',
+                '    handle /files/* {',
+                `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
+                '    }',
+            ]),
+        '',
         `    handle ${apiPathMatcher} {`,
         `        reverse_proxy ${context.proxyHost}:${context.apiPort}`,
         '    }',

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

@@ -15,7 +15,7 @@ export function resolveManagedSetupState(value) {
 export function isPreparedSetupState(value) {
     return resolveManagedSetupState(value) === 'prepared';
 }
-export function buildInitAppEnvVarsFromConfig(config) {
+export function buildInitAppEnvVarsFromConfig(config, options = {}) {
     const out = {};
     const put = (key, value) => {
         const text = trimValue(value);
@@ -28,5 +28,10 @@ export function buildInitAppEnvVarsFromConfig(config) {
     put('INIT_ROOT_EMAIL', config?.rootEmail);
     put('INIT_ROOT_PASSWORD', config?.rootPassword);
     put('INIT_ROOT_NICKNAME', config?.rootNickname);
+    if (options.includePortal !== false) {
+        put('INIT_DEVELOPMENT_MODE', config?.developmentMode);
+        put('INIT_PORTAL_NAME', config?.portalName);
+        put('INIT_PORTAL_TEMPLATE', config?.portalTemplate);
+    }
     return out;
 }

package/dist/lib/portal-command-env.js

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+const PORTAL_COMMAND_BASE_ENV_KEYS = [
+    'PATH',
+    'Path',
+    'PATHEXT',
+    'SystemRoot',
+    'WINDIR',
+    'ComSpec',
+    'HOME',
+    'USERPROFILE',
+    'TMPDIR',
+    'TEMP',
+    'TMP',
+];
+export function buildPortalCommandEnv(env = {}) {
+    const out = {};
+    for (const key of PORTAL_COMMAND_BASE_ENV_KEYS) {
+        const value = process.env[key];
+        if (value) {
+            out[key] = value;
+        }
+    }
+    return { ...out, ...env };
+}