@nocobase/cli 2.1.0-beta.37 → 2.1.0-beta.38

package/dist/commands/db/start.js

@@ -7,8 +7,9 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Command, Flags } from '@oclif/core';
-import { formatMissingManagedAppEnvMessage, startDockerContainer, } from '../../lib/app-runtime.js';
-import { announceTargetEnv, failTask, startTask, succeedTask } from '../../lib/ui.js';
+import { formatMissingManagedAppEnvMessage, startDockerContainer } from '../../lib/app-runtime.js';
+import { ensureBuiltinDbReady } from '../../lib/app-managed-resources.js';
+import { announceTargetEnv, failTask, startTask, succeedTask, updateTask } from '../../lib/ui.js';
 import { formatUnmanagedDbMessage, resolveDbRuntime } from './shared.js';
 function formatDbStartFailure(envName, message) {
     if (/does not exist/i.test(message)) {
@@ -45,6 +46,7 @@ export default class DbStart extends Command {
     async run() {
         const { flags } = await this.parse(DbStart);
         const requestedEnv = flags.env?.trim() || undefined;
+        const verbose = Boolean(flags.verbose);
         const runtime = await resolveDbRuntime(requestedEnv);
         if (!runtime) {
             this.error(formatMissingManagedAppEnvMessage(requestedEnv));
@@ -55,12 +57,25 @@ export default class DbStart extends Command {
         announceTargetEnv(runtime.envName);
         startTask(`Starting the built-in database for "${runtime.envName}"...`);
         try {
-            const state = await startDockerContainer(runtime.containerName, {
-                stdio: flags.verbose ? 'inherit' : 'ignore',
-            });
-            succeedTask(state === 'already-running'
-                ? `The built-in database is already running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`
-                : `The built-in database is running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`);
+            try {
+                const state = await startDockerContainer(runtime.containerName, {
+                    stdio: verbose ? 'inherit' : 'ignore',
+                });
+                succeedTask(state === 'already-running'
+                    ? `The built-in database is already running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`
+                    : `The built-in database is running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                if (!/does not exist/i.test(message)) {
+                    throw error;
+                }
+                updateTask(`Restoring the built-in database for "${runtime.envName}"...`);
+                await ensureBuiltinDbReady(runtime.appRuntime, {
+                    verbose,
+                });
+                succeedTask(`The built-in database is running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`);
+            }
         }
         catch (error) {
             const message = error instanceof Error ? error.message : String(error);

package/dist/commands/license/plugins/shared.js

@@ -11,8 +11,14 @@ import { access, mkdir, rm } from 'node:fs/promises';
 import { Readable } from 'node:stream';
 import { createGunzip } from 'node:zlib';
 import * as tar from 'tar';
-import { removeStoragePluginSymlink, resolvePluginStoragePath, } from '../../../lib/plugin-storage.js';
-import { parseLicenseKey, readSavedLicenseKey, resolveLicensePkgUrl, } from '../shared.js';
+import { removeStoragePluginSymlink, resolvePluginStoragePath } from '../../../lib/plugin-storage.js';
+import { parseLicenseKey, readSavedLicenseKey, resolveLicensePkgUrl } from '../shared.js';
+export class MissingSavedLicenseKeyError extends Error {
+    constructor(envName) {
+        super(`No saved license key was found for env "${envName}". Run \`nb license activate\` first.`);
+        this.name = 'MissingSavedLicenseKeyError';
+    }
+}
 async function resolvePkgBaseUrl(pkgUrl) {
     return await resolveLicensePkgUrl(pkgUrl);
 }
@@ -54,7 +60,7 @@ async function loginPkg(baseURL, keyData) {
 export async function loadSavedLicenseKeyData(runtime) {
     const licenseKey = await readSavedLicenseKey(runtime);
     if (!licenseKey) {
-        throw new Error(`No saved license key was found for env "${runtime.envName}". Run \`nb license activate\` first.`);
+        throw new MissingSavedLicenseKeyError(runtime.envName);
     }
     return parseLicenseKey(licenseKey);
 }

package/dist/commands/license/plugins/sync.js

@@ -10,10 +10,10 @@ import { Command, Flags } from '@oclif/core';
 import pc from 'picocolors';
 import { readFile } from 'node:fs/promises';
 import path from 'node:path';
-import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageRef, } from "../../../lib/docker-image.js";
+import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageRef } from "../../../lib/docker-image.js";
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../../lib/env-guard.js';
-import { createLicenseEnvFlag, licenseJsonFlag, licensePkgUrlFlag, licenseYesFlag, requireLicenseRuntime, } from '../shared.js';
-import { syncLicensedPlugins } from './shared.js';
+import { createLicenseEnvFlag, licenseJsonFlag, licensePkgUrlFlag, licenseYesFlag, readSavedLicenseKey, requireLicenseRuntime, } from '../shared.js';
+import { MissingSavedLicenseKeyError, syncLicensedPlugins } from './shared.js';
 import { resolvePluginStoragePath } from '../../../lib/plugin-storage.js';
 import { commandOutput } from '../../../lib/run-npm.js';
 import { announceTargetEnv, startTask, stopTask, succeedTask, updateTask } from '../../../lib/ui.js';
@@ -93,12 +93,7 @@ async function resolveDockerAppVersion(runtime) {
         defaultRegistry: DEFAULT_DOCKER_REGISTRY,
         defaultVersion: DEFAULT_DOCKER_VERSION,
     });
-    const args = [
-        'run',
-        '--rm',
-        '--network',
-        runtime.workspaceName,
-    ];
+    const args = ['run', '--rm', '--network', runtime.workspaceName];
     const dockerPlatform = normalizeDockerPlatform(config.dockerPlatform);
     if (dockerPlatform) {
         args.push('--platform', dockerPlatform);
@@ -130,6 +125,16 @@ async function resolveManagedAppVersion(runtime) {
     }
     throw new Error(`Env "${runtime.envName}" does not support automatic app version detection.`);
 }
+function buildNoLicenseSkipPayload(runtime, dryRun) {
+    return {
+        ok: true,
+        env: runtime.envName,
+        kind: runtime.kind,
+        dryRun,
+        status: 'skipped',
+        skipReason: 'no-license-key',
+    };
+}
 export default class LicensePluginsSync extends Command {
     static summary = 'Synchronize commercial plugins for the selected env';
     static description = 'Synchronize the commercial plugins allowed by the current saved license key.';
@@ -150,6 +155,10 @@ export default class LicensePluginsSync extends Command {
         version: Flags.string({
             description: 'Registry version or dist-tag to synchronize. Defaults to the current workspace version.',
         }),
+        'skip-if-no-license': Flags.boolean({
+            description: 'Skip without error when this env does not have a saved license key',
+            default: false,
+        }),
         verbose: Flags.boolean({
             description: 'Show detailed per-plugin sync logs',
             default: false,
@@ -174,7 +183,17 @@ export default class LicensePluginsSync extends Command {
         if (!flags.json) {
             announceTargetEnv(runtime.envName);
         }
-        const version = trimValue(flags.version) || await resolveManagedAppVersion(runtime);
+        if (flags['skip-if-no-license']) {
+            const savedLicenseKey = await readSavedLicenseKey(runtime);
+            if (!savedLicenseKey) {
+                const payload = buildNoLicenseSkipPayload(runtime, Boolean(flags['dry-run']));
+                if (flags.json) {
+                    this.log(JSON.stringify(payload, null, 2));
+                }
+                return;
+            }
+        }
+        const version = trimValue(flags.version) || (await resolveManagedAppVersion(runtime));
         const registryVersion = normalizePluginRegistryVersion(version);
         const shouldStreamLogs = !flags.json && Boolean(flags.verbose);
         const pluginStoragePath = resolvePluginStoragePath(runtime.env.storagePath);
@@ -210,20 +229,32 @@ export default class LicensePluginsSync extends Command {
         }
         let result;
         try {
-            result = await syncLicensedPlugins(runtime, {
-                pkgUrl: flags['pkg-url'],
-                version: registryVersion,
-                dryRun: Boolean(flags['dry-run']),
-                onProgress: shouldStreamLogs
-                    ? async (detail) => {
-                        this.log(`${formatActionLabel(detail.action)} ${pc.bold(detail.packageName)}`);
-                        this.log(pc.dim(`  output: ${detail.outputDir}`));
-                        if (detail.warning) {
-                            this.log(pc.yellow(`  warning: ${detail.warning}`));
+            try {
+                result = await syncLicensedPlugins(runtime, {
+                    pkgUrl: flags['pkg-url'],
+                    version: registryVersion,
+                    dryRun: Boolean(flags['dry-run']),
+                    onProgress: shouldStreamLogs
+                        ? async (detail) => {
+                            this.log(`${formatActionLabel(detail.action)} ${pc.bold(detail.packageName)}`);
+                            this.log(pc.dim(`  output: ${detail.outputDir}`));
+                            if (detail.warning) {
+                                this.log(pc.yellow(`  warning: ${detail.warning}`));
+                            }
                         }
+                        : undefined,
+                });
+            }
+            catch (error) {
+                if (flags['skip-if-no-license'] && error instanceof MissingSavedLicenseKeyError) {
+                    const payload = buildNoLicenseSkipPayload(runtime, Boolean(flags['dry-run']));
+                    if (flags.json) {
+                        this.log(JSON.stringify(payload, null, 2));
                     }
-                    : undefined,
-            });
+                    return;
+                }
+                throw error;
+            }
         }
         finally {
             if (loadingTimer) {
@@ -250,9 +281,7 @@ export default class LicensePluginsSync extends Command {
             return;
         }
         if (loadingStarted) {
-            succeedTask(flags['dry-run']
-                ? 'Commercial plugin sync preview is ready.'
-                : 'Commercial plugin sync completed.');
+            succeedTask(flags['dry-run'] ? 'Commercial plugin sync preview is ready.' : 'Commercial plugin sync completed.');
         }
         if (!flags.verbose) {
             const changes = [];

package/dist/commands/source/download.js

@@ -70,6 +70,9 @@ function downloadSourceLabel(source) {
             return source;
     }
 }
+function downloadActionLabel(flags) {
+    return flags.replace ? 'Source refresh' : 'Download';
+}
 function normalizeDockerPlatform(value) {
     const text = String(value ?? '').trim();
     if (text === 'linux/amd64' || text === 'linux/arm64') {
@@ -228,7 +231,7 @@ export default class SourceDownload extends Command {
         'npm-registry': Flags.string({
             description: 'npm registry for npm/git downloads and dependency installation.',
         }),
-        'build': Flags.boolean({
+        build: Flags.boolean({
             allowNo: true,
             description: 'Build npm/git source after dependencies are installed.',
             default: true,
@@ -347,7 +350,8 @@ export default class SourceDownload extends Command {
             message: downloadText('prompts.outputDir.message'),
             placeholder: downloadText('prompts.outputDir.placeholder'),
             initialValue: (values) => {
-                const version = resolveVersionFromResults(values, DEFAULT_DOWNLOAD_VERSION) || DEFAULT_DOWNLOAD_VERSION;
+                const version = resolveVersionFromResults(values, DEFAULT_DOWNLOAD_VERSION) ||
+                    DEFAULT_DOWNLOAD_VERSION;
                 return defaultOutputDirForVersion(version);
             },
             required: true,
@@ -467,8 +471,7 @@ export default class SourceDownload extends Command {
         initialValues.dockerPlatform = normalizeDockerPlatform(flags['docker-platform']);
         initialValues.dockerSave = flags['docker-save'];
         if (flags['npm-registry'] !== undefined) {
-            initialValues.npmRegistry =
-                typeof flags['npm-registry'] === 'string' ? flags['npm-registry'] : '';
+            initialValues.npmRegistry = typeof flags['npm-registry'] === 'string' ? flags['npm-registry'] : '';
         }
         for (const key of Object.keys(preset)) {
             if (Object.prototype.hasOwnProperty.call(initialValues, key)) {
@@ -536,7 +539,7 @@ export default class SourceDownload extends Command {
         return preset;
     }
     resolveEffectiveBuild(source, results, flags) {
-        if (source === 'npm' && !Boolean(results.devDependencies)) {
+        if (source === 'npm' && !results.devDependencies) {
             return false;
         }
         if (source === 'npm' || source === 'git') {
@@ -554,34 +557,29 @@ export default class SourceDownload extends Command {
             ? String(results.outputDir).trim() || undefined
             : flags['output-dir']?.trim() || undefined;
         const replace = results.replace !== undefined ? Boolean(results.replace) : flags.replace;
-        const gitUrl = results.gitUrl !== undefined
-            ? String(results.gitUrl).trim() || undefined
-            : flags['git-url']?.trim() || undefined;
+        const gitUrl = results.gitUrl !== undefined ? String(results.gitUrl).trim() || undefined : flags['git-url']?.trim() || undefined;
         const dockerRegistry = source === 'docker'
-            ? (results.dockerRegistry !== undefined
+            ? results.dockerRegistry !== undefined
                 ? String(results.dockerRegistry).trim() || undefined
-                : flags['docker-registry']?.trim() || defaultDockerRegistryForLang(flags.locale ?? process.env.NB_LOCALE))
+                : flags['docker-registry']?.trim() || defaultDockerRegistryForLang(flags.locale ?? process.env.NB_LOCALE)
             : undefined;
         const dockerPlatform = source === 'docker'
-            ? normalizeDockerPlatform(results.dockerPlatform !== undefined
-                ? results.dockerPlatform
-                : flags['docker-platform'])
+            ? normalizeDockerPlatform(results.dockerPlatform !== undefined ? results.dockerPlatform : flags['docker-platform'])
             : undefined;
         const dockerSave = source === 'docker'
             ? results.dockerSave !== undefined
                 ? Boolean(results.dockerSave)
                 : flags['docker-save']
             : false;
-        const npmRegistryRaw = results.npmRegistry !== undefined
-            ? String(results.npmRegistry)
-            : flags['npm-registry'] ?? '';
+        const npmRegistryRaw = results.npmRegistry !== undefined ? String(results.npmRegistry) : flags['npm-registry'] ?? '';
         const npmRegistry = npmRegistryRaw.trim() || undefined;
+        const npmDevDependencies = devDependencies ?? false;
         return {
             source,
             version,
             replace,
-            ...(source === 'npm' ? { 'dev-dependencies': devDependencies } : {}),
-            'build': effectiveBuild,
+            ...(source === 'npm' ? { 'dev-dependencies': npmDevDependencies } : {}),
+            build: effectiveBuild,
             'build-dts': normalizeBuildDts(source, effectiveBuild, buildDtsWant),
             'output-dir': outputDir,
             'git-url': gitUrl,
@@ -772,7 +770,9 @@ export default class SourceDownload extends Command {
         await fsp.mkdir(parentDir, { recursive: true });
         const registryEnv = this.npmRegistryEnv(flags);
         this.finishPreparationTask();
-        this.log(`Creating NocoBase app "${appName}" from npm`);
+        this.log(flags.replace
+            ? `Refreshing NocoBase source in ${projectRoot} from npm`
+            : `Creating NocoBase app "${appName}" from npm`);
         await this.runExternalCommand('npx', npxArgs, {
             ...this.runOptionsWithCwd(parentDir, registryEnv),
             errorName: 'npx create-nocobase-app',
@@ -795,7 +795,7 @@ export default class SourceDownload extends Command {
                 ...(this.isVerbose() ? ['--verbose'] : []),
             ]);
         }
-        this.log(`NocoBase app is ready at ${projectRoot}`);
+        this.log(`${flags.replace ? 'NocoBase source' : 'NocoBase app'} is ready at ${projectRoot}`);
         return projectRoot;
     }
     async downloadFromGit(flags) {
@@ -808,9 +808,13 @@ export default class SourceDownload extends Command {
         gitArgs.push('--branch', branch);
         gitArgs.push('--depth', '1', repoUrl, outputDir);
         this.finishPreparationTask();
-        this.log(branch === versionSpec
-            ? `Cloning NocoBase from ${repoUrl} (${branch})`
-            : `Cloning NocoBase from ${repoUrl} (${branch}, resolved from ${versionSpec})`);
+        this.log(flags.replace
+            ? branch === versionSpec
+                ? `Refreshing NocoBase source from ${repoUrl} (${branch})`
+                : `Refreshing NocoBase source from ${repoUrl} (${branch}, resolved from ${versionSpec})`
+            : branch === versionSpec
+                ? `Cloning NocoBase from ${repoUrl} (${branch})`
+                : `Cloning NocoBase from ${repoUrl} (${branch}, resolved from ${versionSpec})`);
         await this.runExternalCommand('git', gitArgs, {
             errorName: 'git clone',
             loadingMessage: 'Cloning the repository',
@@ -830,7 +834,7 @@ export default class SourceDownload extends Command {
                 ...(this.isVerbose() ? ['--verbose'] : []),
             ]);
         }
-        this.log(`NocoBase app is ready at ${projectRoot}`);
+        this.log(`${flags.replace ? 'NocoBase source' : 'NocoBase app'} is ready at ${projectRoot}`);
         return projectRoot;
     }
     async download() {
@@ -869,7 +873,7 @@ export default class SourceDownload extends Command {
     async run() {
         try {
             const result = await this.download();
-            this.logProgress(`Download completed via ${downloadSourceLabel(result.resolved.source)}.`);
+            this.logProgress(`${downloadActionLabel(result.resolved)} completed via ${downloadSourceLabel(result.resolved.source)}.`);
             return result;
         }
         catch (error) {

package/dist/generated/command-registry.js

@@ -50,13 +50,14 @@ function readEnvName(argv) {
     }
     return undefined;
 }
-function createRuntimeCommand(operation) {
+function createRuntimeCommand(operation, runtimeVersion) {
     return class RuntimeCommand extends GeneratedApiCommand {
         static summary = operation.summary;
         static description = operation.description;
         static examples = operation.examples;
         static flags = createGeneratedFlags(operation);
         static operation = operation;
+        static runtimeVersion = runtimeVersion;
     };
 }
 function createRuntimeIndexCommand(commandId, metadata) {
@@ -122,7 +123,7 @@ const runtime = loadRuntimeSync(env?.runtime?.version);
 for (const operation of runtime?.commands ?? []) {
     const commandSegments = operation.commandId.split(' ');
     const commandKey = commandSegments.join(':');
-    registry[`api:${commandKey}`] = createRuntimeCommand(operation);
+    registry[`api:${commandKey}`] = createRuntimeCommand(operation, runtime?.version);
     for (const [topicCommandId, metadata] of getRuntimeTopicEntries(operation)) {
         const topicKey = `api:${topicCommandId.split(' ').join(':')}`;
         if (!registry[topicKey]) {

package/dist/lib/api-client.js

@@ -23,6 +23,8 @@ import { resolveServerRequestTarget } from './env-auth.js';
 import { fetchWithPreservedAuthRedirect } from './http-request.js';
 const CLI_REQUEST_SOURCE_HEADER = 'x-request-source';
 const CLI_REQUEST_SOURCE_VALUE = 'cli';
+const CLI_VERSION_HEADER = 'x-nb-cli-version';
+const SKILLS_VERSION_HEADER = 'x-nb-skills-version';
 function stripUtf8Bom(text) {
     return text.charCodeAt(0) === 0xfeff ? text.slice(1) : text;
 }
@@ -209,6 +211,10 @@ export async function executeApiRequest(options) {
     const { baseUrl, token } = await resolveServerRequestTarget(options);
     const headers = new Headers();
     headers.set(CLI_REQUEST_SOURCE_HEADER, CLI_REQUEST_SOURCE_VALUE);
+    headers.set(CLI_VERSION_HEADER, options.cliVersion);
+    if (options.skillsVersion) {
+        headers.set(SKILLS_VERSION_HEADER, options.skillsVersion);
+    }
     if (token) {
         headers.set('authorization', `Bearer ${token}`);
     }