@nocobase/cli 2.1.0-beta.24 → 2.1.0-beta.25

package/dist/lib/runtime-generator.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.
+ */
 /**
  * This file is part of the NocoBase (R) project.
  * Copyright (c) 2020-2024 NocoBase Co., Ltd.
@@ -60,12 +68,59 @@ function toGeneratedParameter(parameter, usedFlagNames) {
         required: parameter.required,
         description: parameter.description,
         type: inferParameterType(parameter.schema),
+        format: parameter.schema?.format,
         isArray: parameter.schema?.type === 'array',
+        isFile: parameter.schema?.type === 'string' && parameter.schema?.format === 'binary',
     };
 }
 function getJsonRequestSchema(requestBody) {
     return requestBody?.content?.['application/json']?.schema;
 }
+function getMultipartRequestSchema(requestBody) {
+    return requestBody?.content?.['multipart/form-data']?.schema;
+}
+function getRequestContentType(requestBody) {
+    if (!requestBody || '$ref' in requestBody) {
+        return undefined;
+    }
+    if (requestBody.content?.['multipart/form-data']) {
+        return 'multipart/form-data';
+    }
+    if (requestBody.content?.['application/json']) {
+        return 'application/json';
+    }
+    return undefined;
+}
+function getRequestSchema(requestBody) {
+    return getMultipartRequestSchema(requestBody) ?? getJsonRequestSchema(requestBody);
+}
+function isBinarySchema(schema) {
+    if (!schema || typeof schema !== 'object') {
+        return false;
+    }
+    if (schema.type === 'string' && schema.format === 'binary') {
+        return true;
+    }
+    return [...(schema.oneOf ?? []), ...(schema.anyOf ?? []), ...(schema.allOf ?? [])].some(isBinarySchema);
+}
+function getResponseType(operation) {
+    for (const response of Object.values(operation.responses ?? {})) {
+        const content = response?.content ?? {};
+        const mediaTypes = Object.keys(content);
+        const hasJson = mediaTypes.some((mediaType) => mediaType.includes('json'));
+        if (hasJson) {
+            return 'json';
+        }
+        const hasBinary = mediaTypes.some((mediaType) => {
+            const schema = content[mediaType]?.schema;
+            return mediaType === 'application/octet-stream' || mediaType.includes('zip') || isBinarySchema(schema);
+        });
+        if (hasBinary) {
+            return 'binary';
+        }
+    }
+    return undefined;
+}
 function normalizeCompositeSchema(schema) {
     if (!schema || typeof schema !== 'object') {
         return schema;
@@ -139,7 +194,7 @@ function describeSchemaShape(schema, options = {}) {
     return type;
 }
 function extractBodyParameters(requestBody, usedFlagNames) {
-    const schema = getJsonRequestSchema(requestBody);
+    const schema = getRequestSchema(requestBody);
     const properties = normalizeCompositeSchema(schema)?.properties;
     const required = new Set(normalizeCompositeSchema(schema)?.required ?? []);
     return Object.entries(properties ?? {}).map(([name, propertySchema]) => ({
@@ -149,7 +204,9 @@ function extractBodyParameters(requestBody, usedFlagNames) {
         required: required.has(name),
         description: propertySchema.description,
         type: inferParameterType(propertySchema),
+        format: propertySchema.format,
         isArray: propertySchema.type === 'array',
+        isFile: propertySchema.type === 'string' && propertySchema.format === 'binary',
         jsonEncoded: propertySchema.type === 'object' || propertySchema.type === 'array',
         jsonShape: describeSchemaShape(propertySchema),
     }));
@@ -179,6 +236,9 @@ function formatFlagExample(parameter) {
     if (parameter.type === 'boolean') {
         return `--${parameter.flagName}`;
     }
+    if (parameter.isFile) {
+        return `--${parameter.flagName} <path>`;
+    }
     if (parameter.type === 'object' || parameter.jsonEncoded) {
         if (parameter.type === 'array' || parameter.isArray) {
             return `--${parameter.flagName} '[]'`;
@@ -216,12 +276,13 @@ export function buildExamples(commandId, operation) {
     const requiredParameters = operation.parameters.filter((parameter) => parameter.required);
     const requiredFlags = requiredParameters.map(formatFlagExample);
     const requiredNonBodyFlags = requiredParameters.filter((parameter) => parameter.in !== 'body').map(formatFlagExample);
-    const examples = [`nb api ${commandId}${requiredFlags.length ? ` ${requiredFlags.join(' ')}` : ''}`];
+    const outputFlag = operation.responseType === 'binary' ? ' --output <path>' : '';
+    const examples = [`nb api ${commandId}${requiredFlags.length ? ` ${requiredFlags.join(' ')}` : ''}${outputFlag}`];
     const firstOptional = operation.parameters.find((parameter) => !parameter.required);
     if (firstOptional) {
-        examples.push(`${examples[0]} ${formatFlagExample(firstOptional)}`);
+        examples.push(`${examples[0]} ${formatFlagExample(firstOptional)}`.trim());
     }
-    if (operation.hasBody) {
+    if (operation.hasBody && operation.requestContentType !== 'multipart/form-data') {
         const prefix = `nb api ${commandId}${requiredNonBodyFlags.length ? ` ${requiredNonBodyFlags.join(' ')}` : ''}`;
         examples.push(`${prefix} --body '${buildSampleBody(operation.parameters)}'`);
     }
@@ -248,9 +309,17 @@ function buildDescription(operation) {
     }
     if (operation.hasBody) {
         const bodyFlags = operation.parameters.filter((parameter) => parameter.in === 'body').map((parameter) => `--${parameter.flagName}`);
-        sections.push(bodyFlags.length
-            ? `Request body: use body field flags (${bodyFlags.join(', ')}) or pass raw JSON via \`--body\` / \`--body-file\`.`
-            : 'Request body: JSON via `--body` or `--body-file`.');
+        if (operation.requestContentType === 'multipart/form-data') {
+            sections.push(bodyFlags.length ? `Request body: multipart form fields (${bodyFlags.join(', ')}).` : 'Request body: multipart form data.');
+        }
+        else {
+            sections.push(bodyFlags.length
+                ? `Request body: use body field flags (${bodyFlags.join(', ')}) or pass raw JSON via \`--body\` / \`--body-file\`.`
+                : 'Request body: JSON via `--body` or `--body-file`.');
+        }
+    }
+    if (operation.responseType === 'binary') {
+        sections.push('Response body: binary download written to `--output`.');
     }
     return sections.join('\n\n');
 }
@@ -357,6 +426,8 @@ export async function generateRuntime(document, configFile, baseUrl) {
         const bodyParameters = extractBodyParameters(operation.requestBody, usedFlagNames);
         const allParameters = [...parameters, ...bodyParameters];
         const hasBody = Boolean(operation.requestBody && !('$ref' in operation.requestBody));
+        const requestContentType = getRequestContentType(operation.requestBody);
+        const responseType = getResponseType(operation);
         const moduleDisplayName = moduleConfig.name ?? moduleKey;
         const moduleDescription = moduleConfig.description;
         const resourceDisplayName = resourceConfig?.name ?? resourceKey;
@@ -366,9 +437,11 @@ export async function generateRuntime(document, configFile, baseUrl) {
             description: operation.description,
         });
         const resourceSegments = toResourceSegments(pathTemplate);
-        const mappedResourceSegments = resourceSegments.length && resourceConfig?.name
-            ? [toKebabCase(resourceConfig.name), ...resourceSegments.slice(1)]
-            : resourceSegments;
+        const mappedResourceSegments = resourceSegments.length && resourceConfig?.segments?.length
+            ? [...resourceConfig.segments.map(toKebabCase), ...resourceSegments.slice(1)]
+            : resourceSegments.length && resourceConfig?.name
+                ? [toKebabCase(resourceConfig.name), ...resourceSegments.slice(1)]
+                : resourceSegments;
         const segments = [
             ...(resourceConfig?.topLevel ? [] : [toKebabCase(moduleDisplayName)]),
             ...mappedResourceSegments,
@@ -397,15 +470,21 @@ export async function generateRuntime(document, configFile, baseUrl) {
                 tags: operation.tags,
                 description: operationText.description,
                 hasBody,
+                requestContentType,
+                responseType,
                 parameters: allParameters,
             }),
             examples: buildExamples(segments.join(' '), {
                 parameters: allParameters,
                 hasBody,
+                requestContentType,
+                responseType,
             }),
             parameters: allParameters,
             hasBody,
             bodyRequired: operation.requestBody && !('$ref' in operation.requestBody) ? operation.requestBody.required : undefined,
+            requestContentType,
+            responseType,
         });
     }
     const schemaHash = createHash('sha1').update(JSON.stringify(document)).digest('hex').slice(0, 8);

package/dist/lib/self-manager.js

@@ -7,11 +7,14 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import fs from 'node:fs';
+import fsp from 'node:fs/promises';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { resolveCliHomeDir } from './cli-home.js';
 import { commandOutput, run } from './run-npm.js';
 const DEFAULT_PACKAGE_NAME = '@nocobase/cli';
 const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..');
+const INSTALL_METHOD_CACHE_FILE = 'self-install-methods.json';
 function normalizePath(value) {
     return path.resolve(value);
 }
@@ -115,6 +118,38 @@ function detectInstallMethod(packageRoot, globalPrefix) {
     }
     return 'unknown';
 }
+function getInstallMethodCacheFile() {
+    return path.join(resolveCliHomeDir('global'), INSTALL_METHOD_CACHE_FILE);
+}
+function getInstallMethodCacheKey(packageRoot) {
+    return normalizePath(path.join(packageRoot, 'bin', 'run.js'));
+}
+async function readInstallMethodCache() {
+    try {
+        const raw = await fsp.readFile(getInstallMethodCacheFile(), 'utf8');
+        return JSON.parse(raw);
+    }
+    catch {
+        return {};
+    }
+}
+async function writeInstallMethodCache(state) {
+    const filePath = getInstallMethodCacheFile();
+    await fsp.mkdir(path.dirname(filePath), { recursive: true });
+    await fsp.writeFile(filePath, JSON.stringify(state, null, 2));
+}
+async function readCachedInstallMethod(packageRoot) {
+    const state = await readInstallMethodCache();
+    return state.entries?.[getInstallMethodCacheKey(packageRoot)];
+}
+async function writeCachedInstallMethod(packageRoot, entry) {
+    const state = await readInstallMethodCache();
+    const entries = {
+        ...(state.entries ?? {}),
+        [getInstallMethodCacheKey(packageRoot)]: entry,
+    };
+    await writeInstallMethodCache({ entries });
+}
 async function readGlobalPrefix(commandOutputFn) {
     try {
         return (await commandOutputFn('npm', ['prefix', '-g'], {
@@ -177,14 +212,34 @@ export function formatSelfUpdateUnavailableMessage(status) {
 export function getSelfUpdatePackageSpec(status) {
     return `${status.packageName}@${status.channel}`;
 }
+export async function inspectSelfInstall(options = {}) {
+    const packageRoot = options.packageRoot ? normalizePath(options.packageRoot) : PACKAGE_ROOT;
+    const commandOutputFn = options.commandOutputFn ?? commandOutput;
+    const cachedInstallMethod = await readCachedInstallMethod(packageRoot);
+    const globalPrefix = cachedInstallMethod?.globalPrefix ?? await readGlobalPrefix(commandOutputFn);
+    const installMethod = cachedInstallMethod?.installMethod ?? detectInstallMethod(packageRoot, globalPrefix);
+    if (!cachedInstallMethod) {
+        await writeCachedInstallMethod(packageRoot, {
+            installMethod,
+            globalPrefix,
+        });
+    }
+    return {
+        packageRoot,
+        installMethod,
+        globalPrefix,
+    };
+}
 export async function inspectSelfStatus(options = {}) {
     const packageRoot = options.packageRoot ? normalizePath(options.packageRoot) : PACKAGE_ROOT;
     const packageName = options.packageName ?? DEFAULT_PACKAGE_NAME;
     const currentVersion = options.currentVersion ?? readCurrentVersion(packageRoot);
     const channel = options.channel && options.channel !== 'auto' ? options.channel : detectChannel(currentVersion);
     const commandOutputFn = options.commandOutputFn ?? commandOutput;
-    const globalPrefix = await readGlobalPrefix(commandOutputFn);
-    const installMethod = detectInstallMethod(packageRoot, globalPrefix);
+    const { installMethod, globalPrefix } = await inspectSelfInstall({
+        packageRoot,
+        commandOutputFn,
+    });
     let latestVersion;
     let registryError;
     try {

package/dist/lib/skills-manager.js

@@ -10,7 +10,7 @@ import fsp from 'node:fs/promises';
 import path from 'node:path';
 import { resolveCliHomeDir } from './cli-home.js';
 import { compareVersions } from './self-manager.js';
-import { commandOutput, run } from './run-npm.js';
+import { commandOutput, commandOutputViaFile, run } from './run-npm.js';
 export const NOCOBASE_SKILLS_SOURCE = 'nocobase/skills';
 export const NOCOBASE_SKILLS_PACKAGE_NAME = '@nocobase/skills';
 const NOCOBASE_SKILLS_NAME_PREFIX = 'nocobase-';
@@ -57,7 +57,7 @@ async function writeManagedSkillsState(workspaceRoot, state) {
 export async function listGlobalSkills(options = {}) {
     const globalRoot = resolveSkillsRoot(options);
     await ensureSkillsWorkspaceRoot(globalRoot);
-    const output = await (options.commandOutputFn ?? commandOutput)('npx', ['-y', 'skills', 'list', '-g', '--json'], {
+    const output = await (options.commandOutputFn ?? commandOutputViaFile)('npx', ['-y', 'skills', 'list', '-g', '--json'], {
         cwd: globalRoot,
         errorName: 'skills list',
     });

package/dist/lib/startup-update.js

@@ -8,8 +8,9 @@
  */
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import * as p from '@clack/prompts';
-import { inspectSelfStatus, } from './self-manager.js';
+import { inspectSelfInstall, inspectSelfStatus, } from './self-manager.js';
 import { inspectSkillsStatus } from './skills-manager.js';
 import { resolveCliHomeDir } from './cli-home.js';
 import { isInteractiveTerminal, printWarning } from './ui.js';
@@ -19,7 +20,33 @@ const NB_SKIP_STARTUP_UPDATE_ENV = 'NB_SKIP_STARTUP_UPDATE';
 function getStateFile() {
     return path.join(resolveCliHomeDir('global'), STARTUP_UPDATE_STATE_FILE);
 }
+function getCurrentInstallBinPath() {
+    return path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..', 'bin', 'run.js');
+}
+function getCurrentInstallEntry(state) {
+    return state.entries?.[getCurrentInstallBinPath()];
+}
 function todayStamp(now = new Date()) {
+    const timeZone = String(process.env.TZ ?? '').trim();
+    if (timeZone) {
+        try {
+            const parts = new Intl.DateTimeFormat('en-CA', {
+                timeZone,
+                year: 'numeric',
+                month: '2-digit',
+                day: '2-digit',
+            }).formatToParts(now);
+            const year = parts.find((part) => part.type === 'year')?.value;
+            const month = parts.find((part) => part.type === 'month')?.value;
+            const day = parts.find((part) => part.type === 'day')?.value;
+            if (year && month && day) {
+                return `${year}-${month}-${day}`;
+            }
+        }
+        catch {
+            // Fall back to the host local timezone.
+        }
+    }
     const year = now.getFullYear();
     const month = String(now.getMonth() + 1).padStart(2, '0');
     const day = String(now.getDate()).padStart(2, '0');
@@ -49,8 +76,46 @@ async function writeState(state) {
     await fs.mkdir(path.dirname(filePath), { recursive: true });
     await fs.writeFile(filePath, JSON.stringify(state, null, 2));
 }
+function readCurrentInstallLastCheckedDate(state) {
+    return getCurrentInstallEntry(state)?.lastCheckedDate ?? state.lastCheckedDate;
+}
+async function writeCurrentInstallEntry(updater) {
+    const state = await readState();
+    const installBinPath = getCurrentInstallBinPath();
+    const nextEntry = updater(getCurrentInstallEntry(state), state);
+    await writeState({
+        ...state,
+        entries: {
+            ...(state.entries ?? {}),
+            [installBinPath]: nextEntry,
+        },
+    });
+}
 async function markChecked(now = new Date()) {
-    await writeState({ lastCheckedDate: todayStamp(now) });
+    await writeCurrentInstallEntry((current, state) => {
+        return {
+            policy: current?.policy ?? 'daily',
+            lastCheckedDate: todayStamp(now),
+        };
+    });
+}
+async function disableStartupUpdateForCurrentInstall() {
+    await writeCurrentInstallEntry((current, state) => {
+        return {
+            policy: 'disabled',
+            lastCheckedDate: current?.lastCheckedDate
+                ?? state.lastCheckedDate,
+        };
+    });
+}
+async function enableDailyStartupUpdateForCurrentInstall() {
+    await writeCurrentInstallEntry((current, state) => {
+        return {
+            policy: 'daily',
+            lastCheckedDate: current?.lastCheckedDate
+                ?? state.lastCheckedDate,
+        };
+    });
 }
 export async function shouldRunStartupUpdateCheck(argv, now = new Date()) {
     if (process.env[NB_SKIP_STARTUP_UPDATE_ENV] === '1') {
@@ -60,7 +125,20 @@ export async function shouldRunStartupUpdateCheck(argv, now = new Date()) {
         return false;
     }
     const state = await readState();
-    return state.lastCheckedDate !== todayStamp(now);
+    const currentEntry = getCurrentInstallEntry(state);
+    if (currentEntry?.policy === 'disabled') {
+        return false;
+    }
+    if (currentEntry?.policy === 'daily') {
+        return readCurrentInstallLastCheckedDate(state) !== todayStamp(now);
+    }
+    const selfInstall = await inspectSelfInstall();
+    if (!shouldEnableStartupUpdateForInstallMethod(selfInstall.installMethod)) {
+        await disableStartupUpdateForCurrentInstall();
+        return false;
+    }
+    await enableDailyStartupUpdateForCurrentInstall();
+    return readCurrentInstallLastCheckedDate(state) !== todayStamp(now);
 }
 export function shouldEnableStartupUpdateForInstallMethod(installMethod) {
     return installMethod === 'npm-global';
@@ -176,9 +254,6 @@ export async function maybeRunStartupUpdatePrompt(argv) {
         return { kind: 'skipped' };
     }
     const selfStatus = await inspectSelfStatus();
-    if (!shouldEnableStartupUpdateForInstallMethod(selfStatus.installMethod)) {
-        return { kind: 'skipped' };
-    }
     const skillsStatus = await inspectSkillsStatus();
     if (!hasPendingUpdates(selfStatus, skillsStatus)) {
         await markChecked();

package/dist/lib/ui.js

@@ -88,6 +88,9 @@ export function printInfo(message) {
     }
     console.log(pc.cyan(message));
 }
+export function announceTargetEnv(envName) {
+    printInfo(`Target env: ${envName}`);
+}
 export function printVerbose(message) {
     if (!verboseMode) {
         return;

package/dist/locale/en-US.json

@@ -80,10 +80,6 @@
         },
         "scope": {
           "message": "Where should this connection be saved?",
-          "autoLabel": "Auto",
-          "autoHint": "project if this repo already has .nocobase, otherwise global",
-          "projectLabel": "Project",
-          "projectHint": ".nocobase in this repo",
           "globalLabel": "Global",
           "globalHint": "user-level config"
         },

package/dist/locale/zh-CN.json

@@ -80,10 +80,6 @@
         },
         "scope": {
           "message": "这个连接要保存到哪里？",
-          "autoLabel": "自动",
-          "autoHint": "当前仓库已有 .nocobase 时保存到项目内，否则保存到全局",
-          "projectLabel": "项目内",
-          "projectHint": "保存在当前仓库的 .nocobase 中",
           "globalLabel": "全局",
           "globalHint": "保存在用户级配置中"
         },

package/nocobase-ctl.config.json

@@ -215,6 +215,88 @@
         }
       }
     },
+    "backup": {
+      "name": "backup",
+      "description": "Create, inspect, download, remove, and restore NocoBase backups.",
+      "include": true,
+      "resources": {
+        "includes": ["backup"],
+        "excludes": [],
+        "overrides": {
+          "backup": {
+            "name": "backup",
+            "description": "Manage backup and restore files.",
+            "topLevel": true,
+            "operations": {
+              "includes": [
+                "backup:list",
+                "backup:create",
+                "backup:status",
+                "backup:download",
+                "backup:remove",
+                "backup:restore",
+                "backup:restoreUpload",
+                "backup:restoreStatus"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "migration": {
+      "name": "migration",
+      "description": "Create, check, execute, and inspect migration packages.",
+      "include": true,
+      "resources": {
+        "includes": ["migration", "migrationLog", "migrationRule", "migrationRules"],
+        "excludes": [],
+        "overrides": {
+          "migration": {
+            "name": "migration",
+            "description": "Manage migration files and executions.",
+            "topLevel": true,
+            "operations": {
+              "includes": [
+                "migration:list",
+                "migration:get",
+                "migration:create",
+                "migration:download",
+                "migration:remove",
+                "migration:check",
+                "migration:execute"
+              ]
+            }
+          },
+          "migrationRule": {
+            "name": "migration rules",
+            "segments": ["migration", "rules"],
+            "description": "Create migration rules with global user/system policies.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationRule:create"]
+            }
+          },
+          "migrationRules": {
+            "name": "migration rules",
+            "segments": ["migration", "rules"],
+            "description": "List and inspect migration rules.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationRules:list", "migrationRules:get"]
+            }
+          },
+          "migrationLog": {
+            "name": "migration logs",
+            "segments": ["migration", "logs"],
+            "description": "List, inspect, and download migration logs.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationLog:list", "migrationLog:get", "migrationLog:download"]
+            }
+          }
+        }
+      }
+    },
     "system-settings": {
       "name": "system-settings",
       "description": "Adjust system title, logo, language, and other global settings.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.0-beta.24",
+  "version": "2.1.0-beta.25",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
@@ -58,6 +58,12 @@
       "env": {
         "description": "Manage NocoBase project environments, status, details, and command runtimes."
       },
+      "license": {
+        "description": "Manage NocoBase commercial licensing and licensed plugins."
+      },
+      "config": {
+        "description": "Manage CLI configuration defaults."
+      },
       "self": {
         "description": "Inspect or update the NocoBase CLI itself."
       },
@@ -75,6 +81,7 @@
   },
   "dependencies": {
     "@clack/prompts": "^0.9.1",
+    "@nocobase/license-kit": "^0.3.8",
     "@oclif/core": "^4.10.4",
     "cross-spawn": "^7.0.6",
     "lodash": "^4.17.21",
@@ -83,16 +90,18 @@
     "openapi-types": "^12.1.3",
     "ora": "^8.2.0",
     "pg": "^8.14.1",
-    "picocolors": "^1.1.1"
+    "picocolors": "^1.1.1",
+    "tar": "^7.4.3"
   },
   "devDependencies": {
     "@types/node": "^18.19.130",
     "tsx": "^4.20.6",
-    "typescript": "^6.0.2"
+    "typescript": "^6.0.2",
+    "vitest": "^1.5.0"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "f77b85530a2d127d9bfe4dca3a26fbb02c1139ba"
+  "gitHead": "824f8b8200e9fe086135768934d3ef427b212446"
 }