@nocobase/cli 2.2.0-beta.1 → 2.2.0-beta.11

package/dist/commands/source/download.js

@@ -12,11 +12,15 @@ import path from 'node:path';
 import { stdin as stdinStream, stdout as stdoutStream } from 'node:process';
 import { runPromptCatalog, } from "../../lib/prompt-catalog.js";
 import { applyCliLocale, CLI_LOCALE_FLAG_DESCRIPTION, CLI_LOCALE_FLAG_OPTIONS, localeText, resolveCliLocale, translateCli, } from "../../lib/cli-locale.js";
-import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_REGISTRY_ZH_CN, resolveDockerImageRef, } from "../../lib/docker-image.js";
+import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_REGISTRY_ZH_CN, resolveOfficialDockerRegistry, resolveDockerImageRef, } from "../../lib/docker-image.js";
+import { getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { getCliConfigValue } from '../../lib/cli-config.js';
+import { buildBeforeDependencyInstallHookContext, runBeforeDependencyInstallHook, } from '../../lib/hook-script.js';
 import { run } from "../../lib/run-npm.js";
 import { printVerbose, setVerboseMode, startTask, stopTask, updateTask } from '../../lib/ui.js';
 const DEFAULT_DOCKER_PLATFORM = 'auto';
-const DEFAULT_DOWNLOAD_VERSION = 'beta';
+const DEFAULT_DOWNLOAD_VERSION = 'latest';
 const downloadText = (key, values) => localeText(`commands.download.${key}`, values);
 const downloadTranslatedText = (key, values, fallback) => translateCli(`commands.download.${key}`, values, { fallback });
 function defaultOutputDirForVersion(versionTag) {
@@ -231,6 +235,26 @@ export default class SourceDownload extends Command {
         'npm-registry': Flags.string({
             description: 'npm registry for npm/git downloads and dependency installation.',
         }),
+        'hook-script': Flags.string({
+            description: 'Hook module to run after npm scaffold or git clone and before dependency installation.',
+        }),
+        'hook-phase': Flags.string({
+            hidden: true,
+            options: ['init', 'upgrade', 'restore', 'source-download', 'app-start'],
+        }),
+        'hook-command': Flags.string({
+            hidden: true,
+            options: ['init', 'source:download', 'app:start', 'app:restart', 'app:upgrade'],
+        }),
+        'hook-env-name': Flags.string({
+            hidden: true,
+        }),
+        'hook-app-path': Flags.string({
+            hidden: true,
+        }),
+        'hook-storage-path': Flags.string({
+            hidden: true,
+        }),
         build: Flags.boolean({
             allowNo: true,
             description: 'Build npm/git source after dependencies are installed.',
@@ -276,7 +300,6 @@ export default class SourceDownload extends Command {
                     value: 'latest',
                     label: downloadText('prompts.version.latestLabel'),
                     hint: downloadText('prompts.version.latestHint'),
-                    disabled: true,
                 },
                 {
                     value: 'beta',
@@ -322,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,
@@ -428,9 +451,9 @@ export default class SourceDownload extends Command {
         }
         return outputAbs;
     }
-    dockerTarPath(flags, outputAbs) {
+    async dockerTarPath(flags, outputAbs) {
         const imageRef = resolveDockerImageRef(flags['docker-registry'], flags.version, {
-            defaultRegistry: defaultDockerRegistryForLang(process.env.NB_LOCALE),
+            defaultRegistry: await this.resolveConfiguredDockerRegistryDefault(),
             defaultVersion: 'latest',
         });
         const safeBase = imageRef.replace(/[\\/:]/g, '-');
@@ -440,9 +463,11 @@ export default class SourceDownload extends Command {
      * Defaults for prompts only. Keys present in **`preset`** are omitted so `runPromptCatalog` uses
      * **`values`** (preset) alone for those steps — no duplicate prefill for skipped prompts.
      */
-    buildInitialValuesFromParsed(flags, preset) {
+    async resolveConfiguredDockerRegistryDefault() {
+        return resolveOfficialDockerRegistry(await getCliConfigValue('nb-image-registry'));
+    }
+    buildInitialValuesFromParsed(flags, preset, defaultDockerRegistry) {
         const initialValues = {};
-        const localeDefaultDockerRegistry = defaultDockerRegistryForLang(flags.locale ?? process.env.NB_LOCALE);
         const source = flags.source?.trim();
         if (source) {
             initialValues.source = source;
@@ -466,7 +491,7 @@ export default class SourceDownload extends Command {
             initialValues.dockerRegistry = String(flags['docker-registry'] ?? '').trim();
         }
         else {
-            initialValues.dockerRegistry = localeDefaultDockerRegistry;
+            initialValues.dockerRegistry = defaultDockerRegistry;
         }
         initialValues.dockerPlatform = normalizeDockerPlatform(flags['docker-platform']);
         initialValues.dockerSave = flags['docker-save'];
@@ -547,7 +572,7 @@ export default class SourceDownload extends Command {
         }
         return flags.build;
     }
-    mapCatalogResultsToResolved(results, flags) {
+    mapCatalogResultsToResolved(results, flags, defaultDockerRegistry) {
         const source = String(results.source);
         const version = resolveVersionFromResults(results, flags.version) || 'latest';
         const devDependencies = source === 'npm' ? Boolean(results.devDependencies) : undefined;
@@ -561,7 +586,7 @@ export default class SourceDownload extends Command {
         const dockerRegistry = source === 'docker'
             ? results.dockerRegistry !== undefined
                 ? String(results.dockerRegistry).trim() || undefined
-                : flags['docker-registry']?.trim() || defaultDockerRegistryForLang(flags.locale ?? process.env.NB_LOCALE)
+                : flags['docker-registry']?.trim() || defaultDockerRegistry
             : undefined;
         const dockerPlatform = source === 'docker'
             ? normalizeDockerPlatform(results.dockerPlatform !== undefined ? results.dockerPlatform : flags['docker-platform'])
@@ -574,6 +599,9 @@ export default class SourceDownload extends Command {
         const npmRegistryRaw = results.npmRegistry !== undefined ? String(results.npmRegistry) : flags['npm-registry'] ?? '';
         const npmRegistry = npmRegistryRaw.trim() || undefined;
         const npmDevDependencies = devDependencies ?? false;
+        const hookScript = flags['hook-script']?.trim()
+            ? path.resolve(process.cwd(), flags['hook-script'].trim())
+            : undefined;
         return {
             source,
             version,
@@ -587,6 +615,14 @@ export default class SourceDownload extends Command {
             ...(source === 'docker' ? { 'docker-platform': dockerPlatform } : {}),
             ...(source === 'docker' ? { 'docker-save': dockerSave } : {}),
             ...(npmRegistry ? { 'npm-registry': npmRegistry } : {}),
+            ...(hookScript ? { 'hook-script': hookScript } : {}),
+            ...(flags['hook-phase'] ? { 'hook-phase': flags['hook-phase'] } : {}),
+            ...(flags['hook-command'] ? { 'hook-command': flags['hook-command'] } : {}),
+            ...(flags['hook-env-name'] ? { 'hook-env-name': flags['hook-env-name'].trim() } : {}),
+            ...(flags['hook-app-path'] ? { 'hook-app-path': path.resolve(process.cwd(), flags['hook-app-path']) } : {}),
+            ...(flags['hook-storage-path']
+                ? { 'hook-storage-path': path.resolve(process.cwd(), flags['hook-storage-path']) }
+                : {}),
         };
     }
     async resolveDownloadFlags(flags) {
@@ -595,7 +631,8 @@ export default class SourceDownload extends Command {
             this.error('Download source is required in non-interactive mode. Use --source npm, --source git, or --source docker.');
         }
         const presetValues = this.buildPresetValuesFromFlags(flags);
-        const initialValues = this.buildInitialValuesFromParsed(flags, presetValues);
+        const defaultDockerRegistry = await this.resolveConfiguredDockerRegistryDefault();
+        const initialValues = this.buildInitialValuesFromParsed(flags, presetValues, defaultDockerRegistry);
         const results = await runPromptCatalog(SourceDownload.prompts, {
             initialValues,
             values: presetValues,
@@ -621,7 +658,7 @@ export default class SourceDownload extends Command {
         if (flags['docker-save'] && source !== 'docker') {
             this.error('--docker-save is only available when --source docker is selected.');
         }
-        return this.mapCatalogResultsToResolved(results, flags);
+        return this.mapCatalogResultsToResolved(results, flags, defaultDockerRegistry);
     }
     npmRegistryUrl(flags) {
         const url = flags['npm-registry']?.trim();
@@ -719,9 +756,39 @@ export default class SourceDownload extends Command {
         }
         return argv;
     }
+    async runBeforeDependencyInstallHookIfNeeded(flags, projectRoot) {
+        const hookScript = flags['hook-script']?.trim();
+        if (!hookScript || (flags.source !== 'npm' && flags.source !== 'git')) {
+            return;
+        }
+        const envName = flags['hook-env-name']?.trim() || '';
+        const env = envName ? await getEnv(envName, { scope: resolveDefaultConfigScope() }) : undefined;
+        const appPath = flags['hook-app-path']?.trim() || projectRoot;
+        const storagePath = flags['hook-storage-path']?.trim() || path.join(appPath, 'storage');
+        const context = buildBeforeDependencyInstallHookContext({
+            phase: flags['hook-phase'] ?? 'source-download',
+            command: flags['hook-command'] ?? 'source:download',
+            envName,
+            source: flags.source,
+            version: flags.version,
+            appPath,
+            sourcePath: projectRoot,
+            storagePath,
+            hookScript,
+            envConfig: env?.config ?? {},
+        });
+        if (!context) {
+            return;
+        }
+        this.log(`Running hook before dependency install: ${hookScript}`);
+        await runBeforeDependencyInstallHook({
+            hookScriptPath: hookScript,
+            context,
+        });
+    }
     async downloadFromDocker(flags) {
         const imageRef = resolveDockerImageRef(flags['docker-registry'], flags.version, {
-            defaultRegistry: defaultDockerRegistryForLang(process.env.NB_LOCALE),
+            defaultRegistry: await this.resolveConfiguredDockerRegistryDefault(),
             defaultVersion: 'latest',
         });
         const platform = dockerPlatformArg(flags['docker-platform']);
@@ -748,7 +815,7 @@ export default class SourceDownload extends Command {
             await fsp.rm(outAbs, { recursive: true, force: true });
         }
         await fsp.mkdir(outAbs, { recursive: true });
-        const tarPath = this.dockerTarPath(flags, outAbs);
+        const tarPath = await this.dockerTarPath(flags, outAbs);
         this.log(`Saving Docker image tarball to ${tarPath}`);
         await this.runExternalCommand('docker', ['save', '-o', tarPath, imageRef], {
             errorName: 'docker save',
@@ -778,6 +845,7 @@ export default class SourceDownload extends Command {
             errorName: 'npx create-nocobase-app',
             loadingMessage: 'Creating the app scaffold',
         });
+        await this.runBeforeDependencyInstallHookIfNeeded(flags, projectRoot);
         const installArgs = ['install'];
         if (!flags['dev-dependencies']) {
             installArgs.push('--production');
@@ -821,6 +889,7 @@ export default class SourceDownload extends Command {
         });
         const projectRoot = path.resolve(process.cwd(), outputDir);
         const registryEnv = this.npmRegistryEnv(flags);
+        await this.runBeforeDependencyInstallHookIfNeeded(flags, projectRoot);
         this.log(`Installing dependencies in ${projectRoot}`);
         await this.runExternalCommand('yarn', ['install'], {
             ...this.runOptionsWithCwd(projectRoot, registryEnv),

package/dist/lib/api-command-compat.js

@@ -114,12 +114,22 @@ function compareWithOperator(version, operator, expected) {
 }
 function normalizeAppByChannelComparableVersion(version) {
     const normalized = String(version ?? '').trim();
-    const match = normalized.match(/^(\d+\.\d+\.\d+)-(alpha|beta|rc)(?:\.(\d+))?(?:\..+)?$/);
+    const match = normalized.match(/^(\d+\.\d+\.\d+)(?:-([0-9A-Za-z-.]+))?$/);
     if (!match) {
         return normalized;
     }
-    const [, base, channel, sequence] = match;
-    return sequence ? `${base}-${channel}.${sequence}` : `${base}-${channel}`;
+    const [, base, prerelease] = match;
+    if (!prerelease) {
+        return base;
+    }
+    const [channel, sequence] = prerelease.split('.');
+    if ((channel === 'alpha' || channel === 'beta') && sequence && /^\d+$/.test(sequence)) {
+        return `${base}-${channel}.${sequence}`;
+    }
+    if (channel === 'alpha' || channel === 'beta') {
+        return `${base}-${channel}`;
+    }
+    return base;
 }
 function normalizeAppByChannelCondition(condition) {
     if (!condition) {
@@ -134,6 +144,42 @@ function normalizeAppByChannelCondition(condition) {
     }
     return normalized;
 }
+function compareAppByChannelVersions(version, expected) {
+    const comparableVersion = normalizeAppByChannelComparableVersion(version);
+    const comparableExpected = normalizeAppByChannelComparableVersion(expected);
+    if (comparableVersion === comparableExpected ||
+        comparableVersion.startsWith(`${comparableExpected}.`) ||
+        comparableVersion.startsWith(`${comparableExpected}-`)) {
+        return 0;
+    }
+    return compareVersions(comparableVersion, comparableExpected);
+}
+function compareAppByChannelWithOperator(version, operator, expected) {
+    const compared = compareAppByChannelVersions(version, expected);
+    switch (operator) {
+        case 'eq':
+            return compared === 0;
+        case 'gt':
+            return compared > 0;
+        case 'gte':
+            return compared >= 0;
+        case 'lt':
+            return compared < 0;
+        case 'lte':
+            return compared <= 0;
+        default:
+            return false;
+    }
+}
+function matchesAppByChannelVersionCondition(version, condition) {
+    if (!condition) {
+        return true;
+    }
+    return ['eq', 'gt', 'gte', 'lt', 'lte'].every((operator) => {
+        const expected = condition[operator];
+        return expected ? compareAppByChannelWithOperator(version, operator, expected) : true;
+    });
+}
 function matchesVersionCondition(version, condition) {
     if (!condition) {
         return true;
@@ -168,10 +214,7 @@ function resolveAppChannel(version) {
     if (channel === 'beta') {
         return 'beta';
     }
-    if (channel === 'rc') {
-        return 'rc';
-    }
-    return 'unknownPrerelease';
+    return 'stable';
 }
 function evaluateAppByChannelCondition(version, condition) {
     if (!condition) {
@@ -208,7 +251,7 @@ function evaluateAppByChannelCondition(version, condition) {
     const comparableVersion = normalizeAppByChannelComparableVersion(version);
     const comparableCondition = normalizeAppByChannelCondition(channelCondition);
     return {
-        result: matchesVersionCondition(comparableVersion, comparableCondition) ? 'match' : 'mismatch',
+        result: matchesAppByChannelVersionCondition(comparableVersion, comparableCondition) ? 'match' : 'mismatch',
         channel,
         condition: channelCondition,
     };

package/dist/lib/app-managed-resources.js

@@ -6,13 +6,16 @@
  * 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 { mkdir, readdir } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { mkdir, readFile, readdir, writeFile } from 'node:fs/promises';
 import { resolveAppPublicPath } from './app-public-path.js';
 import { dockerContainerExists, managedAppLifecycleEnvVars, runLocalNocoBaseCommand, startDockerContainer, } from './app-runtime.js';
 import { deriveBuiltinDbConnection, resolveBuiltinDbConnection } from './builtin-db.js';
 import { resolveConfiguredStoragePath } from './env-paths.js';
 import { resolveDockerEnvFileArg } from "./docker-env-file.js";
-import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageRef, } from "./docker-image.js";
+import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageContainerPort, resolveDockerImageRef, } from "./docker-image.js";
+import { resolveHookScriptPath } from './hook-script.js';
 import { commandSucceeds, ensureDockerDaemonRunning, run } from './run-npm.js';
 import Install from '../commands/install.js';
 const DOCKER_APP_STORAGE_DESTINATION = '/app/nocobase/storage';
@@ -90,6 +93,15 @@ function formatLocalPostinstallFailure(envName, message) {
         `Details: ${message}`,
     ].join('\n');
 }
+function formatNpmSourceDevDependenciesFailure(envName, projectRoot, message) {
+    return [
+        `Couldn't prepare source dev dependencies for "${envName}".`,
+        '`nb source dev` requires @nocobase/devtools in npm source envs.',
+        `Source directory: ${projectRoot}`,
+        `Run \`cd ${projectRoot} && yarn install\` after fixing package.json, then try again.`,
+        `Details: ${message}`,
+    ].join('\n');
+}
 function formatSavedDockerSettingsIncomplete(envName, missing) {
     return [
         `Can't start NocoBase for "${envName}" yet.`,
@@ -114,6 +126,45 @@ async function localProjectHasFiles(projectRoot) {
         return false;
     }
 }
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+async function readPackageJson(projectRoot) {
+    const packageJsonPath = path.join(projectRoot, 'package.json');
+    const content = await readFile(packageJsonPath, 'utf-8');
+    const parsed = JSON.parse(content);
+    if (!isRecord(parsed)) {
+        throw new Error(`${packageJsonPath} must contain a JSON object.`);
+    }
+    return parsed;
+}
+function getStringDependency(packageJson, section, packageName) {
+    const dependencies = packageJson[section];
+    if (!isRecord(dependencies)) {
+        return undefined;
+    }
+    const version = dependencies[packageName];
+    return typeof version === 'string' && version.trim() ? version.trim() : undefined;
+}
+function ensureDevDependencies(packageJson) {
+    const devDependencies = packageJson.devDependencies;
+    if (devDependencies === undefined) {
+        const next = {};
+        packageJson.devDependencies = next;
+        return next;
+    }
+    if (!isRecord(devDependencies)) {
+        throw new Error('package.json devDependencies must be an object.');
+    }
+    return devDependencies;
+}
+function hasNpmSourceDevtools(projectRoot) {
+    return existsSync(path.join(projectRoot, 'node_modules', '@nocobase', 'devtools', 'package.json'));
+}
+function npmRegistryEnv(runtime) {
+    const npmRegistry = String(runtime.env.config?.npmRegistry ?? '').trim();
+    return npmRegistry ? { npm_config_registry: npmRegistry } : undefined;
+}
 export async function buildSavedDockerRunArgs(runtime, options) {
     const config = runtime.env.config ?? {};
     const storagePath = trimValue(resolveConfiguredStoragePath(config));
@@ -141,6 +192,7 @@ export async function buildSavedDockerRunArgs(runtime, options) {
         defaultRegistry: DEFAULT_DOCKER_REGISTRY,
         defaultVersion: DEFAULT_DOCKER_VERSION,
     });
+    const containerPort = resolveDockerImageContainerPort(imageRef);
     const missing = [];
     if (!storagePath) {
         missing.push('storagePath');
@@ -174,8 +226,6 @@ export async function buildSavedDockerRunArgs(runtime, options) {
         '-d',
         '--name',
         runtime.containerName,
-        '--restart',
-        'always',
         '--network',
         runtime.workspaceName,
     ];
@@ -184,7 +234,7 @@ export async function buildSavedDockerRunArgs(runtime, options) {
         args.push('--platform', dockerPlatform);
     }
     if (appPort) {
-        args.push('-p', `${appPort}:80`);
+        args.push('-p', `${appPort}:${containerPort}`);
     }
     if (envFile) {
         args.push('--env-file', envFile);
@@ -302,6 +352,13 @@ export function buildSavedLocalDownloadArgv(runtime, options) {
     if (config.buildDts === true) {
         argv.push('--build-dts');
     }
+    const hookScriptPath = resolveHookScriptPath({
+        appPath: runtime.env.appPath,
+        hookScript: config.hookScript,
+    });
+    if (hookScriptPath) {
+        argv.push('--hook-script', hookScriptPath, '--hook-phase', options?.hookPhase ?? 'restore', '--hook-command', options?.hookCommand ?? 'app:start', '--hook-env-name', runtime.envName, '--hook-app-path', runtime.env.appPath, '--hook-storage-path', runtime.env.storagePath);
+    }
     return argv;
 }
 export async function ensureSavedLocalSource(runtime, runCommand, options) {
@@ -313,6 +370,8 @@ export async function ensureSavedLocalSource(runtime, runCommand, options) {
     try {
         await runCommand('source:download', buildSavedLocalDownloadArgv(runtime, {
             verbose: options?.verbose,
+            hookPhase: options?.hookPhase,
+            hookCommand: options?.hookCommand,
         }));
         options?.onSucceedTask?.(`NocoBase files are ready for "${runtime.envName}".`);
     }
@@ -335,3 +394,43 @@ export async function ensureLocalPostinstall(runtime, options) {
         throw new Error(formatLocalPostinstallFailure(runtime.envName, error instanceof Error ? error.message : String(error)));
     }
 }
+export async function ensureNpmSourceDevDependencies(runtime, options) {
+    if (runtime.source !== 'npm') {
+        return;
+    }
+    let taskStarted = false;
+    try {
+        const packageJson = await readPackageJson(runtime.projectRoot);
+        const appVersion = getStringDependency(packageJson, 'dependencies', '@nocobase/app');
+        const devtoolsVersion = getStringDependency(packageJson, 'devDependencies', '@nocobase/devtools');
+        let updatedPackageJson = false;
+        if (!devtoolsVersion) {
+            if (!appVersion) {
+                throw new Error('Cannot determine @nocobase/devtools version because dependencies["@nocobase/app"] is missing.');
+            }
+            const devDependencies = ensureDevDependencies(packageJson);
+            devDependencies['@nocobase/devtools'] = appVersion;
+            updatedPackageJson = true;
+            await writeFile(path.join(runtime.projectRoot, 'package.json'), `${JSON.stringify(packageJson, null, 2)}\n`, 'utf-8');
+        }
+        const needsInstall = updatedPackageJson || !hasNpmSourceDevtools(runtime.projectRoot);
+        if (!needsInstall) {
+            return;
+        }
+        options?.onStartTask?.(`Preparing source dev dependencies for "${runtime.envName}"...`);
+        taskStarted = true;
+        await run('yarn', ['install'], {
+            cwd: runtime.projectRoot,
+            env: npmRegistryEnv(runtime),
+            errorName: 'yarn install',
+            stdio: commandStdio(options?.verbose),
+        });
+        options?.onSucceedTask?.(`Source dev dependencies are ready for "${runtime.envName}".`);
+    }
+    catch (error) {
+        if (taskStarted) {
+            options?.onFailTask?.(`Failed to prepare source dev dependencies for "${runtime.envName}".`);
+        }
+        throw new Error(formatNpmSourceDevDependenciesFailure(runtime.envName, runtime.projectRoot, error instanceof Error ? error.message : String(error)));
+    }
+}