@nocobase/cli 2.3.0-beta.3 → 3.0.0-alpha.11

package/dist/lib/portal-build-html.js

@@ -0,0 +1,27 @@
+/**
+ * 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 { readFile, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+const BUILD_HTML_SCRIPT_PATH = path.join('scripts', 'build-html.mjs');
+const BUILD_HTML_ENV_FILES_PATTERN = /return\s+\[\s*["']\.env["']\s*,\s*["']\.env\.local["']\s*,\s*`\.env\.\$\{mode\}`\s*,\s*`\.env\.\$\{mode\}\.local`\s*\]\.map\(\s*\(?file\)?\s*=>\s*path\.join\(rootDir,\s*file\)\s*\);/m;
+const BUILD_HTML_ENV_ONLY_REPLACEMENT = 'return [".env"].map((file) => path.join(rootDir, file));';
+export async function ensurePortalBuildHtmlReadsEnvOnly(portalDir) {
+    const scriptPath = path.join(portalDir, BUILD_HTML_SCRIPT_PATH);
+    let content;
+    try {
+        content = await readFile(scriptPath, 'utf-8');
+    }
+    catch {
+        return;
+    }
+    const nextContent = content.replace(BUILD_HTML_ENV_FILES_PATTERN, BUILD_HTML_ENV_ONLY_REPLACEMENT);
+    if (nextContent !== content) {
+        await writeFile(scriptPath, nextContent, 'utf-8');
+    }
+}

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 };
+}

package/dist/lib/portal-config.js

@@ -0,0 +1,119 @@
+/**
+ * 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 path from 'node:path';
+import { executeApiRequest } from './api-client.js';
+import { translateCli } from './cli-locale.js';
+export const DEFAULT_PORTAL_GIT_PATH = '.';
+const portalConfigText = (key, values, fallback) => translateCli(`commands.portalConfig.${key}`, values, { fallback });
+const UPDATE_PORTAL_OPERATION = {
+    method: 'POST',
+    pathTemplate: '/multiPortals:update',
+    hasBody: true,
+    bodyRequired: true,
+    parameters: [
+        {
+            name: 'filter',
+            flagName: 'filter',
+            in: 'query',
+            type: 'object',
+            required: true,
+        },
+    ],
+};
+function trimValue(value) {
+    return String(value ?? '').trim();
+}
+function readObject(value) {
+    return value && typeof value === 'object' && !Array.isArray(value) ? value : {};
+}
+function validatePortalSourceStorage(value) {
+    const sourceStorage = trimValue(value) || 'nocobase';
+    if (sourceStorage === 'nocobase' || sourceStorage === 'git') {
+        return sourceStorage;
+    }
+    throw new Error(portalConfigText('errors.invalidSourceStorage', { value: sourceStorage }, `Invalid source storage "${sourceStorage}". Use "nocobase" or "git".`));
+}
+function isFullGitRemoteUrl(value) {
+    return /^(?:https?:\/\/|ssh:\/\/|file:\/\/|git@[^:]+:).+/.test(value);
+}
+function validateGitPath(value) {
+    const gitPath = trimValue(value);
+    if (!gitPath || path.isAbsolute(gitPath) || gitPath.split(/[\\/]+/).includes('..')) {
+        throw new Error(portalConfigText('errors.invalidGitPath', { value }, '--git-path must be a relative path inside the Git repository.'));
+    }
+    return gitPath.replace(/\\/g, '/').replace(/^\/+|\/+$/g, '');
+}
+export function buildPortalConfig(options) {
+    const sourceStorage = validatePortalSourceStorage(options.sourceStorage ?? options.existingConfig?.sourceStorage);
+    const hasGitOption = Boolean(trimValue(options.gitRepo) || trimValue(options.gitBranch) || trimValue(options.gitPath));
+    if (sourceStorage === 'nocobase') {
+        if (hasGitOption) {
+            throw new Error(portalConfigText('errors.gitOptionsForNocobaseStorage', undefined, '--git-repo, --git-branch, and --git-path can only be used with --source-storage git.'));
+        }
+        return { sourceStorage };
+    }
+    const repo = trimValue(options.gitRepo) || options.existingConfig?.git?.repo || '';
+    if (!repo) {
+        throw new Error(portalConfigText('errors.gitRepoRequired', undefined, '--git-repo is required when --source-storage is git.'));
+    }
+    if (!isFullGitRemoteUrl(repo)) {
+        throw new Error(portalConfigText('errors.gitRepoInvalid', undefined, '--git-repo must be a full Git remote URL.'));
+    }
+    return {
+        sourceStorage,
+        git: {
+            repo,
+            branch: trimValue(options.gitBranch) || options.existingConfig?.git?.branch || 'main',
+            path: validateGitPath(trimValue(options.gitPath) || options.existingConfig?.git?.path || DEFAULT_PORTAL_GIT_PATH),
+        },
+    };
+}
+export function buildPortalConfigFromOptions(options, portal) {
+    const sourceOptions = readObject(options);
+    const git = readObject(sourceOptions.git);
+    return buildPortalConfig({
+        portal,
+        sourceStorage: trimValue(sourceOptions.sourceStorage) || 'nocobase',
+        gitRepo: trimValue(git.repo),
+        gitBranch: trimValue(git.branch),
+        gitPath: trimValue(git.path),
+    });
+}
+export function mergePortalConfigIntoOptions(config, currentOptions) {
+    const nextOptions = {
+        ...(currentOptions ?? {}),
+        sourceStorage: config.sourceStorage,
+    };
+    if (config.sourceStorage === 'git') {
+        nextOptions.git = config.git;
+    }
+    else {
+        delete nextOptions.git;
+    }
+    return nextOptions;
+}
+export async function syncPortalConfigToRemote(options) {
+    const apiRequest = options.apiRequest ?? executeApiRequest;
+    const response = await apiRequest({
+        cliVersion: options.cliVersion ?? '',
+        envName: options.envName,
+        flags: {
+            filter: {
+                portalName: options.portal,
+            },
+            body: JSON.stringify({
+                options: mergePortalConfigIntoOptions(options.config, options.currentOptions),
+            }),
+        },
+        operation: UPDATE_PORTAL_OPERATION,
+    });
+    if (!response.ok) {
+        throw new Error(portalConfigText('errors.updateFailed', { status: response.status, details: JSON.stringify(response.data, null, 2) }, `Portal config update failed with status ${response.status}\n${JSON.stringify(response.data, null, 2)}`));
+    }
+}

package/dist/lib/portal-configure.js

@@ -0,0 +1,110 @@
+/**
+ * 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 { translateCli } from './cli-locale.js';
+import { resolvePortalAppContext, resolvePortalSourcePath, resolveSavedPortalSourcePath, validatePortalSlug, } from './portal-create.js';
+import { buildPortalConfig, buildPortalConfigFromOptions, syncPortalConfigToRemote, } from './portal-config.js';
+import { findPortalListItem } from './portal-info.js';
+import { listPortalWorkspaces } from './portal-list.js';
+const portalConfigureText = (key, values, fallback) => translateCli(`commands.portalConfigure.${key}`, values, { fallback });
+function trimValue(value) {
+    return String(value ?? '').trim();
+}
+function hasSourceConfigurationChange(options) {
+    return Boolean(options.sourceStorage !== undefined ||
+        trimValue(options.gitRepo) ||
+        trimValue(options.gitBranch) ||
+        trimValue(options.gitPath));
+}
+function hasPathConfigurationChange(options) {
+    return Boolean(trimValue(options.sourcePath));
+}
+function buildConfigFromRemoteOptions(params) {
+    if (params.options && Object.keys(params.options).length > 0) {
+        return buildPortalConfigFromOptions(params.options, params.portal);
+    }
+    if (!params.sourceStorage && !params.gitRepo && !params.gitBranch && !params.gitPath) {
+        return undefined;
+    }
+    return buildPortalConfig({
+        portal: params.portal,
+        sourceStorage: params.sourceStorage,
+        gitRepo: params.gitRepo,
+        gitBranch: params.gitBranch,
+        gitPath: params.gitPath,
+    });
+}
+export async function configurePortalWorkspace(options) {
+    const hasSourceChange = hasSourceConfigurationChange(options);
+    const hasPathChange = hasPathConfigurationChange(options);
+    if (!hasSourceChange && !hasPathChange) {
+        throw new Error(portalConfigureText('errors.noChanges', undefined, 'No portal configuration changes were provided. Pass --path, --source-storage, or a --git-* flag.'));
+    }
+    const portal = validatePortalSlug(options.portal);
+    const portalDir = hasPathChange
+        ? resolvePortalSourcePath(portal, options.sourcePath)
+        : resolveSavedPortalSourcePath(options.env, portal) ?? '';
+    const appContext = await resolvePortalAppContext(options);
+    const { app } = appContext;
+    let config;
+    let remoteSynced = false;
+    const list = await listPortalWorkspaces({
+        env: options.env,
+        envName: options.envName,
+        cliVersion: options.cliVersion,
+        apiRequest: options.apiRequest,
+        appContext,
+    });
+    const remoteItem = findPortalListItem(list.items, portal);
+    if (!remoteItem) {
+        throw new Error(portalConfigureText('errors.notFound', { portal }, `Portal "${portal}" was not found. Run \`nb portal list\` to see available portals.`));
+    }
+    if (!hasSourceChange) {
+        return {
+            app,
+            portal,
+            portalDir,
+            config: undefined,
+            remoteSynced: false,
+            pathUpdated: hasPathChange,
+        };
+    }
+    const existingConfig = buildConfigFromRemoteOptions({
+        portal,
+        options: remoteItem.options,
+        sourceStorage: remoteItem.sourceStorage,
+        gitRepo: remoteItem.gitRepo,
+        gitBranch: remoteItem.gitBranch,
+        gitPath: remoteItem.gitPath,
+    });
+    config = buildPortalConfig({
+        portal,
+        sourceStorage: options.sourceStorage,
+        gitRepo: options.gitRepo,
+        gitBranch: options.gitBranch,
+        gitPath: options.gitPath,
+        existingConfig,
+    });
+    await syncPortalConfigToRemote({
+        portal,
+        config,
+        currentOptions: remoteItem.options,
+        envName: options.envName,
+        cliVersion: options.cliVersion,
+        apiRequest: options.apiRequest,
+    });
+    remoteSynced = true;
+    return {
+        app,
+        portal,
+        portalDir,
+        config,
+        remoteSynced,
+        pathUpdated: hasPathChange,
+    };
+}