@nocobase/cli 2.1.0-alpha.25 → 2.1.0-alpha.27

package/dist/lib/auth-store.js

@@ -8,7 +8,7 @@
  */
 import { promises as fs } from 'node:fs';
 import path from 'node:path';
-import { resolveCliHomeDir, resolveConfiguredEnvPath, resolveDefaultConfigScope, resolveEnvRelativePath, } from './cli-home.js';
+import { resolveCliHomeDir, resolveConfiguredEnvPath, resolveEnvRelativePath, } from './cli-home.js';
 function normalizeStoredEnvKind(value) {
     const kind = String(value ?? '').trim();
     if (kind === 'remote') {
@@ -68,8 +68,22 @@ function normalizeEnvConfigEntry(entry) {
     };
 }
 function normalizeAuthConfig(config) {
+    const settings = config.settings ?? {};
     return {
         name: config.name || config.dockerResourcePrefix,
+        settings: {
+            ...(settings.license?.pkgUrl ? { license: { pkgUrl: normalizeOptionalString(settings.license.pkgUrl) } } : {}),
+            ...(settings.docker?.network || settings.docker?.containerPrefix
+                ? {
+                    docker: {
+                        ...(settings.docker?.network ? { network: normalizeOptionalString(settings.docker.network) } : {}),
+                        ...(settings.docker?.containerPrefix
+                            ? { containerPrefix: normalizeOptionalString(settings.docker.containerPrefix) }
+                            : {}),
+                    },
+                }
+                : {}),
+        },
         currentEnv: config.currentEnv || 'default',
         envs: Object.fromEntries(Object.entries(config.envs || {}).map(([envName, entry]) => [envName, normalizeEnvConfigEntry(entry) ?? {}])),
     };
@@ -83,45 +97,21 @@ function createDefaultConfig() {
         envs: {},
     };
 }
-function hasConfiguredEnvs(config) {
-    return Object.keys(config.envs).length > 0;
-}
-function shouldFallbackToLegacyProjectScope(options = {}) {
-    const requestedScope = options.scope ?? resolveDefaultConfigScope();
-    return requestedScope === 'global';
-}
-async function loadExactAuthConfig(options = {}) {
+async function readStoredAuthConfig(filePath) {
     try {
-        const content = await fs.readFile(getConfigFile(options), 'utf8');
+        const content = await fs.readFile(filePath, 'utf8');
         const parsed = JSON.parse(content);
         return normalizeAuthConfig(parsed);
     }
     catch (_error) {
-        return createDefaultConfig();
+        return undefined;
     }
 }
-async function resolveEnvStorageScope(envName, options = {}) {
-    const requestedScope = options.scope ?? resolveDefaultConfigScope();
-    if (requestedScope !== 'global') {
-        return { ...options, scope: requestedScope };
-    }
-    const globalConfig = await loadExactAuthConfig({ scope: 'global' });
-    if (globalConfig.envs[envName]) {
-        return { ...options, scope: 'global' };
-    }
-    const projectConfig = await loadExactAuthConfig({ scope: 'project' });
-    if (projectConfig.envs[envName]) {
-        return { ...options, scope: 'project' };
-    }
-    return { ...options, scope: 'global' };
+export async function loadExactAuthConfig(options = {}) {
+    return (await readStoredAuthConfig(getConfigFile(options))) ?? createDefaultConfig();
 }
 export async function loadAuthConfig(options = {}) {
-    const config = await loadExactAuthConfig(options);
-    if (!shouldFallbackToLegacyProjectScope(options) || hasConfiguredEnvs(config)) {
-        return config;
-    }
-    const legacyProjectConfig = await loadExactAuthConfig({ scope: 'project' });
-    return hasConfiguredEnvs(legacyProjectConfig) ? legacyProjectConfig : config;
+    return await loadExactAuthConfig(options);
 }
 export async function saveAuthConfig(config, options = {}) {
     const filePath = getConfigFile(options);
@@ -140,24 +130,12 @@ export async function getCurrentEnvName(options = {}) {
     return config.currentEnv || 'default';
 }
 export async function setCurrentEnv(envName, options = {}) {
-    const writeOptions = await resolveEnvStorageScope(envName, options);
-    const config = await loadExactAuthConfig(writeOptions);
+    const config = await loadExactAuthConfig(options);
     if (!config.envs[envName]) {
         throw new Error(`Env "${envName}" is not configured`);
     }
     config.currentEnv = envName;
-    await saveAuthConfig(config, writeOptions);
-}
-export async function ensureWorkspaceName(defaultName, options = {}) {
-    const config = await loadExactAuthConfig(options);
-    const existing = config.name?.trim();
-    if (existing) {
-        return existing;
-    }
-    const next = defaultName.trim();
-    config.name = next;
     await saveAuthConfig(config, options);
-    return next;
 }
 export class Env {
     config;
@@ -231,16 +209,7 @@ export async function getEnv(envName, options = {}) {
     const resolved = envName?.trim() || config.currentEnv || 'default';
     const envConfig = config.envs[resolved];
     if (!envConfig) {
-        if (!shouldFallbackToLegacyProjectScope(loadOptions)) {
-            return undefined;
-        }
-        const legacyProjectConfig = await loadExactAuthConfig({ scope: 'project' });
-        const legacyResolved = envName?.trim() || legacyProjectConfig.currentEnv || 'default';
-        const legacyEnvConfig = legacyProjectConfig.envs[legacyResolved];
-        if (!legacyEnvConfig) {
-            return undefined;
-        }
-        return new Env({ ...(normalizeEnvConfigEntry(legacyEnvConfig) ?? {}), name: legacyResolved });
+        return undefined;
     }
     return new Env({ ...(normalizeEnvConfigEntry(envConfig) ?? {}), name: resolved });
 }
@@ -266,12 +235,11 @@ function areAuthConfigsEquivalent(left, right) {
     return false;
 }
 async function writeEnv(envName, updater, options = {}) {
-    const writeOptions = await resolveEnvStorageScope(envName, options);
-    const config = await loadExactAuthConfig(writeOptions);
+    const config = await loadExactAuthConfig(options);
     const previous = config.envs[envName];
     config.envs[envName] = updater(previous);
     config.currentEnv = envName;
-    await saveAuthConfig(config, writeOptions);
+    await saveAuthConfig(config, options);
 }
 export async function upsertEnv(envName, config, options = {}) {
     await writeEnv(envName, (previous) => {
@@ -327,19 +295,17 @@ export async function setEnvOauthSession(envName, auth, options = {}) {
     }), options);
 }
 export async function setEnvRuntime(envName, runtime, options = {}) {
-    const writeOptions = await resolveEnvStorageScope(envName, options);
-    const config = await loadExactAuthConfig(writeOptions);
+    const config = await loadExactAuthConfig(options);
     const current = config.envs[envName] ?? {};
     config.envs[envName] = {
         ...current,
         runtime,
     };
     config.currentEnv = envName;
-    await saveAuthConfig(config, writeOptions);
+    await saveAuthConfig(config, options);
 }
 export async function removeEnv(envName, options = {}) {
-    const writeOptions = await resolveEnvStorageScope(envName, options);
-    const config = await loadExactAuthConfig(writeOptions);
+    const config = await loadExactAuthConfig(options);
     if (!config.envs[envName]) {
         throw new Error(`Env "${envName}" is not configured`);
     }
@@ -348,7 +314,7 @@ export async function removeEnv(envName, options = {}) {
         const nextEnv = Object.keys(config.envs).sort()[0];
         config.currentEnv = nextEnv ?? 'default';
     }
-    await saveAuthConfig(config, writeOptions);
+    await saveAuthConfig(config, options);
     return {
         removed: envName,
         currentEnv: config.currentEnv || 'default',

package/dist/lib/build-config.js

@@ -1,3 +1,11 @@
+/**
+ * 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';
 export async function loadBuildConfig(filePath) {
     try {

package/dist/lib/cli-config.js

@@ -0,0 +1,176 @@
+/**
+ * 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 { loadExactAuthConfig, saveAuthConfig } from './auth-store.js';
+import { resolveDefaultConfigScope } from './cli-home.js';
+export const DEFAULT_LICENSE_PKG_URL = 'https://pkg.nocobase.com/';
+export const DEFAULT_DOCKER_NETWORK = 'nocobase';
+export const DEFAULT_DOCKER_CONTAINER_PREFIX = 'nb';
+export const SUPPORTED_CLI_CONFIG_KEYS = [
+    'license.pkg-url',
+    'docker.network',
+    'docker.container-prefix',
+];
+function trimValue(value) {
+    const text = String(value ?? '').trim();
+    return text || undefined;
+}
+function resolveScope(options = {}) {
+    return {
+        scope: options.scope ?? resolveDefaultConfigScope(),
+    };
+}
+export function isSupportedCliConfigKey(value) {
+    return SUPPORTED_CLI_CONFIG_KEYS.includes(value);
+}
+export function assertSupportedCliConfigKey(value) {
+    if (!isSupportedCliConfigKey(value)) {
+        throw new Error(`Unsupported config key "${value}". Supported keys: ${SUPPORTED_CLI_CONFIG_KEYS.join(', ')}`);
+    }
+    return value;
+}
+function cloneSettings(config) {
+    return {
+        license: config.settings?.license ? { ...config.settings.license } : undefined,
+        docker: config.settings?.docker ? { ...config.settings.docker } : undefined,
+    };
+}
+function pruneSettings(config) {
+    const license = config.settings?.license;
+    if (license && !trimValue(license.pkgUrl)) {
+        delete config.settings?.license;
+    }
+    const docker = config.settings?.docker;
+    if (docker && !trimValue(docker.network) && !trimValue(docker.containerPrefix)) {
+        delete config.settings?.docker;
+    }
+    if (config.settings
+        && !config.settings.license
+        && !config.settings.docker) {
+        delete config.settings;
+    }
+}
+export function getExplicitCliConfigValue(config, key) {
+    switch (key) {
+        case 'license.pkg-url':
+            return trimValue(config.settings?.license?.pkgUrl);
+        case 'docker.network':
+            return trimValue(config.settings?.docker?.network);
+        case 'docker.container-prefix':
+            return trimValue(config.settings?.docker?.containerPrefix);
+    }
+}
+export function getEffectiveCliConfigValue(config, key) {
+    const explicit = getExplicitCliConfigValue(config, key);
+    if (explicit) {
+        return explicit;
+    }
+    switch (key) {
+        case 'license.pkg-url':
+            return DEFAULT_LICENSE_PKG_URL;
+        case 'docker.network':
+            return trimValue(config.name) || DEFAULT_DOCKER_NETWORK;
+        case 'docker.container-prefix':
+            return trimValue(config.name) || DEFAULT_DOCKER_CONTAINER_PREFIX;
+    }
+}
+export function normalizeCliConfigValue(key, value) {
+    const normalized = value.trim();
+    if (!normalized) {
+        throw new Error(`Config key "${key}" requires a non-empty value.`);
+    }
+    if (key === 'license.pkg-url') {
+        return normalized.replace(/\/+$/, '') + '/';
+    }
+    return normalized;
+}
+export async function loadCliConfig(options = {}) {
+    return await loadExactAuthConfig(resolveScope(options));
+}
+export async function getCliConfigValue(key, options = {}) {
+    const config = await loadCliConfig(options);
+    return getEffectiveCliConfigValue(config, key);
+}
+export async function listExplicitCliConfigValues(options = {}) {
+    const config = await loadCliConfig(options);
+    const out = {};
+    for (const key of SUPPORTED_CLI_CONFIG_KEYS) {
+        const value = getExplicitCliConfigValue(config, key);
+        if (value) {
+            out[key] = value;
+        }
+    }
+    return out;
+}
+export async function setCliConfigValue(key, value, options = {}) {
+    const scope = resolveScope(options);
+    const config = await loadExactAuthConfig(scope);
+    const normalized = normalizeCliConfigValue(key, value);
+    config.settings = cloneSettings(config);
+    switch (key) {
+        case 'license.pkg-url':
+            config.settings.license = {
+                ...(config.settings.license ?? {}),
+                pkgUrl: normalized,
+            };
+            break;
+        case 'docker.network':
+            config.settings.docker = {
+                ...(config.settings.docker ?? {}),
+                network: normalized,
+            };
+            break;
+        case 'docker.container-prefix':
+            config.settings.docker = {
+                ...(config.settings.docker ?? {}),
+                containerPrefix: normalized,
+            };
+            break;
+    }
+    pruneSettings(config);
+    await saveAuthConfig(config, scope);
+    return normalized;
+}
+export async function deleteCliConfigValue(key, options = {}) {
+    const scope = resolveScope(options);
+    const config = await loadExactAuthConfig(scope);
+    const hadValue = Boolean(getExplicitCliConfigValue(config, key));
+    if (!hadValue) {
+        return false;
+    }
+    config.settings = cloneSettings(config);
+    switch (key) {
+        case 'license.pkg-url':
+            if (config.settings.license) {
+                delete config.settings.license.pkgUrl;
+            }
+            break;
+        case 'docker.network':
+            if (config.settings.docker) {
+                delete config.settings.docker.network;
+            }
+            break;
+        case 'docker.container-prefix':
+            if (config.settings.docker) {
+                delete config.settings.docker.containerPrefix;
+            }
+            break;
+    }
+    pruneSettings(config);
+    await saveAuthConfig(config, scope);
+    return true;
+}
+export async function resolveDockerNetworkName(options = {}) {
+    return await getCliConfigValue('docker.network', options);
+}
+export async function resolveDockerContainerPrefix(options = {}) {
+    return await getCliConfigValue('docker.container-prefix', options);
+}
+export async function resolveLicensePkgUrlFromConfig(options = {}) {
+    return await getCliConfigValue('license.pkg-url', options);
+}

package/dist/lib/cli-home.js

@@ -6,45 +6,30 @@
  * 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 fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 export const CLI_HOME_DIRNAME = '.nocobase';
-export const NB_CONFIG_SCOPE_ENV = 'NB_CONFIG_SCOPE';
-export const NB_ENV_ROOT_ENV = 'NB_ENV_ROOT';
+export const NB_CLI_ROOT_ENV = 'NB_CLI_ROOT';
 export function resolveDefaultConfigScope() {
-    const raw = String(process.env[NB_CONFIG_SCOPE_ENV] ?? '').trim().toLowerCase();
-    return raw === 'project' ? 'project' : 'global';
+    return 'global';
+}
+function readConfiguredPath(name) {
+    const value = String(process.env[name] ?? '').trim();
+    return value || undefined;
 }
 function resolveGlobalCliHomeRoot() {
-    if (process.env.NOCOBASE_CTL_HOME) {
-        return process.env.NOCOBASE_CTL_HOME;
-    }
-    return os.homedir();
+    return readConfiguredPath(NB_CLI_ROOT_ENV) ?? os.homedir();
 }
 export function resolveCliHomeRoot(scope = resolveDefaultConfigScope()) {
-    const cwdRoot = process.cwd();
-    if (scope === 'project') {
-        return cwdRoot;
-    }
-    if (scope === 'global') {
-        return resolveGlobalCliHomeRoot();
-    }
-    const cwdCliHome = path.join(cwdRoot, CLI_HOME_DIRNAME);
-    if (fs.existsSync(cwdCliHome)) {
-        return cwdRoot;
-    }
+    void scope;
     return resolveGlobalCliHomeRoot();
 }
 export function resolveCliHomeDir(scope = resolveDefaultConfigScope()) {
     return path.join(resolveCliHomeRoot(scope), CLI_HOME_DIRNAME);
 }
 export function resolveEnvRoot(scope = resolveDefaultConfigScope()) {
-    const envRoot = String(process.env[NB_ENV_ROOT_ENV] ?? '').trim();
-    if (envRoot) {
-        return path.resolve(envRoot);
-    }
-    return resolveCliHomeRoot(scope);
+    void scope;
+    return resolveCliHomeRoot();
 }
 export function resolveEnvRelativePath(relativePath, scope = resolveDefaultConfigScope()) {
     return path.resolve(resolveEnvRoot(scope), relativePath);
@@ -57,5 +42,6 @@ export function resolveConfiguredEnvPath(value, scope = resolveDefaultConfigScop
     return path.isAbsolute(text) ? text : resolveEnvRelativePath(text, scope);
 }
 export function formatCliHomeScope(scope) {
-    return scope === 'project' ? 'project' : 'global';
+    void scope;
+    return 'global';
 }

package/dist/lib/cli-locale.js

@@ -7,6 +7,8 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 export const SUPPORTED_CLI_LOCALES = ['en-US', 'zh-CN'];
 export const CLI_LOCALE_FLAG_OPTIONS = [...SUPPORTED_CLI_LOCALES];
 export const CLI_LOCALE_FLAG_DESCRIPTION = 'Language for CLI prompts and the local setup UI.';
@@ -30,8 +32,20 @@ function loadLocaleMessages(locale) {
     if (localeCache[locale]) {
         return localeCache[locale];
     }
+    const moduleDir = path.dirname(fileURLToPath(import.meta.url));
+    const fallbackPath = path.resolve(moduleDir, '..', 'locale', `${locale}.json`);
     const fileUrl = new URL(`../locale/${locale}.json`, import.meta.url);
-    const parsed = JSON.parse(readFileSync(fileUrl, 'utf8'));
+    let parsed;
+    try {
+        parsed = JSON.parse(readFileSync(fileUrl, 'utf8'));
+    }
+    catch (error) {
+        const code = error && typeof error === 'object' && 'code' in error ? String(error.code) : '';
+        if (code !== 'ENOENT') {
+            throw error;
+        }
+        parsed = JSON.parse(readFileSync(fallbackPath, 'utf8'));
+    }
     localeCache[locale] = parsed;
     return parsed;
 }

package/dist/lib/db-connection-check.js

@@ -0,0 +1,178 @@
+/**
+ * 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 { validateTcpPort } from "./prompt-validators.js";
+const DB_CONNECTION_TIMEOUT_MS = 5_000;
+const externalDbValidationCache = new Map();
+function trimPromptValue(value) {
+    return String(value ?? '').trim();
+}
+export function readExternalDbConnectionConfig(values) {
+    const builtinDb = values.builtinDb === undefined ? true : Boolean(values.builtinDb);
+    if (builtinDb) {
+        return undefined;
+    }
+    const dialect = trimPromptValue(values.dbDialect || 'postgres');
+    if (dialect !== 'postgres' && dialect !== 'kingbase' && dialect !== 'mysql' && dialect !== 'mariadb') {
+        return undefined;
+    }
+    const host = trimPromptValue(values.dbHost);
+    const portText = trimPromptValue(values.dbPort);
+    const database = trimPromptValue(values.dbDatabase);
+    const user = trimPromptValue(values.dbUser);
+    const password = String(values.dbPassword ?? '');
+    if (!host || !portText || !database || !user || !password) {
+        return undefined;
+    }
+    if (validateTcpPort(portText)) {
+        return undefined;
+    }
+    return {
+        dialect,
+        host,
+        port: Number.parseInt(portText, 10),
+        database,
+        user,
+        password,
+    };
+}
+export function formatDbCheckAddress(config) {
+    return `${config.host}:${config.port}/${config.database}`;
+}
+function buildValidationCacheKey(config) {
+    return JSON.stringify(config);
+}
+function formatDbConnectionError(config, error) {
+    const maybeError = error;
+    const code = String(maybeError?.code ?? '').trim().toUpperCase();
+    const errno = typeof maybeError?.errno === 'number' ? maybeError.errno : undefined;
+    const rawMessage = String(maybeError?.message || maybeError?.sqlMessage || error || '').trim();
+    if (code === 'ECONNREFUSED' || code === 'ENOTFOUND' || code === 'EHOSTUNREACH' || code === 'ECONNRESET') {
+        return translateCli('validators.dbConnection.unreachable', {
+            host: config.host,
+            port: config.port,
+            details: rawMessage,
+        });
+    }
+    if (code === 'ETIMEDOUT') {
+        return translateCli('validators.dbConnection.timeout', {
+            host: config.host,
+            port: config.port,
+            seconds: Math.ceil(DB_CONNECTION_TIMEOUT_MS / 1000),
+        });
+    }
+    if (code === '28P01' || code === '28000' || code === 'ER_ACCESS_DENIED_ERROR' || errno === 1045) {
+        return translateCli('validators.dbConnection.authenticationFailed', {
+            user: config.user,
+            database: config.database,
+        });
+    }
+    if (code === '3D000' || code === 'ER_BAD_DB_ERROR' || errno === 1049) {
+        return translateCli('validators.dbConnection.databaseNotFound', {
+            database: config.database,
+        });
+    }
+    return translateCli('validators.dbConnection.connectionFailed', {
+        details: rawMessage || code || String(error),
+    });
+}
+async function checkPostgresFamilyConnection(config) {
+    const { default: pg } = await import('pg');
+    const client = new pg.Client({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectionTimeoutMillis: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await client.connect();
+        await client.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(client.end()).catch(() => undefined);
+    }
+}
+async function checkMysqlConnection(config) {
+    const { default: mysql } = await import('mysql2/promise');
+    const connection = await mysql.createConnection({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectTimeout: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await connection.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(connection.end()).catch(() => undefined);
+    }
+}
+async function checkMariaDbConnection(config) {
+    const { default: mariadb } = await import('mariadb');
+    const connection = await mariadb.createConnection({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectTimeout: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await connection.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(connection.end()).catch(() => undefined);
+    }
+}
+async function performExternalDbConnectionCheck(config) {
+    try {
+        switch (config.dialect) {
+            case 'postgres':
+            case 'kingbase': {
+                await checkPostgresFamilyConnection(config);
+                return undefined;
+            }
+            case 'mysql': {
+                await checkMysqlConnection(config);
+                return undefined;
+            }
+            case 'mariadb': {
+                await checkMariaDbConnection(config);
+                return undefined;
+            }
+        }
+    }
+    catch (error) {
+        return formatDbConnectionError(config, error);
+    }
+}
+export async function checkExternalDbConnection(config) {
+    const cacheKey = buildValidationCacheKey(config);
+    const cached = externalDbValidationCache.get(cacheKey);
+    if (cached) {
+        return await cached;
+    }
+    const pending = performExternalDbConnectionCheck(config);
+    externalDbValidationCache.set(cacheKey, pending);
+    return await pending;
+}
+export async function validateExternalDbConfig(values) {
+    const config = readExternalDbConnectionConfig(values);
+    if (!config) {
+        return undefined;
+    }
+    return await checkExternalDbConnection(config);
+}
+export function clearExternalDbValidationCache() {
+    externalDbValidationCache.clear();
+}