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

package/dist/commands/license/env.js

@@ -0,0 +1,94 @@
+/**
+ * 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 { Command, Flags } from '@oclif/core';
+import { getEnvAsync } from '@nocobase/license-kit';
+import { validateTcpPort } from "../../lib/prompt-validators.js";
+import { licenseJsonFlag, withLicenseEnvVars } from './shared.js';
+function trimValue(value) {
+    const text = String(value ?? '').trim();
+    return text || undefined;
+}
+function formatMissingFieldsMessage(missing) {
+    return [
+        'Missing database settings for license environment inspection.',
+        `Required: ${missing.join(', ')}.`,
+        'Pass all required `--db-*` flags explicitly.',
+    ].join('\n');
+}
+export default class LicenseEnv extends Command {
+    static hidden = true;
+    static flags = {
+        'db-dialect': Flags.string({
+            description: 'Database dialect: postgres, kingbase, mysql, or mariadb.',
+            options: ['postgres', 'kingbase', 'mysql', 'mariadb'],
+        }),
+        'db-host': Flags.string({
+            description: 'Database host name or IP address.',
+        }),
+        'db-port': Flags.string({
+            description: 'Database TCP port.',
+        }),
+        'db-database': Flags.string({
+            description: 'Database name.',
+        }),
+        'db-user': Flags.string({
+            description: 'Database username.',
+        }),
+        'db-password': Flags.string({
+            description: 'Database password.',
+        }),
+        json: licenseJsonFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(LicenseEnv);
+        const envVars = {
+            DB_DIALECT: trimValue(flags['db-dialect']),
+            DB_HOST: trimValue(flags['db-host']),
+            DB_PORT: trimValue(flags['db-port']),
+            DB_DATABASE: trimValue(flags['db-database']),
+            DB_USER: trimValue(flags['db-user']),
+            DB_PASSWORD: flags['db-password'] !== undefined ? String(flags['db-password']) : undefined,
+        };
+        const missing = [];
+        if (!envVars.DB_DIALECT) {
+            missing.push('--db-dialect');
+        }
+        if (!envVars.DB_HOST) {
+            missing.push('--db-host');
+        }
+        if (!envVars.DB_PORT) {
+            missing.push('--db-port');
+        }
+        if (!envVars.DB_DATABASE) {
+            missing.push('--db-database');
+        }
+        if (!envVars.DB_USER) {
+            missing.push('--db-user');
+        }
+        if (!envVars.DB_PASSWORD) {
+            missing.push('--db-password');
+        }
+        if (missing.length > 0) {
+            this.error(formatMissingFieldsMessage(missing));
+        }
+        const portError = validateTcpPort(envVars.DB_PORT);
+        if (portError) {
+            this.error(portError);
+        }
+        const env = await withLicenseEnvVars(envVars, async () => await getEnvAsync());
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                env,
+            }, null, 2));
+            return;
+        }
+        this.log(JSON.stringify(env, null, 2));
+    }
+}

package/dist/commands/license/generate-id.js

@@ -0,0 +1,108 @@
+/**
+ * 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 { Command, Flags } from '@oclif/core';
+import { validateTcpPort } from "../../lib/prompt-validators.js";
+import { generateValidatedInstanceIdFromEnvVars, licenseJsonFlag } from './shared.js';
+function trimValue(value) {
+    const text = String(value ?? '').trim();
+    return text || undefined;
+}
+function formatMissingFieldsMessage(missing) {
+    return [
+        'Missing database settings for instance ID generation.',
+        `Required: ${missing.join(', ')}.`,
+        'Pass all required `--db-*` flags explicitly.',
+    ].join('\n');
+}
+export default class LicenseGenerateId extends Command {
+    static hidden = true;
+    static summary = 'Generate a commercial license instance ID from explicit database settings';
+    static description = 'Generate the commercial licensing instance ID from explicit `--db-*` flags. This command only prints the generated ID and does not save it.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --db-dialect postgres --db-host 127.0.0.1 --db-port 5432 --db-database nocobase --db-user nocobase --db-password secret',
+        '<%= config.bin %> <%= command.id %> --db-dialect postgres --db-host 127.0.0.1 --db-port 5432 --db-database nocobase --db-user nocobase --db-password secret --json',
+    ];
+    static flags = {
+        'db-dialect': Flags.string({
+            description: 'Database dialect: postgres, kingbase, mysql, or mariadb.',
+            options: ['postgres', 'kingbase', 'mysql', 'mariadb'],
+            required: false,
+        }),
+        'db-host': Flags.string({
+            description: 'Database host name or IP address.',
+        }),
+        'db-port': Flags.string({
+            description: 'Database TCP port.',
+        }),
+        'db-database': Flags.string({
+            description: 'Database name.',
+        }),
+        'db-user': Flags.string({
+            description: 'Database username.',
+        }),
+        'db-password': Flags.string({
+            description: 'Database password.',
+        }),
+        json: licenseJsonFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(LicenseGenerateId);
+        const dbConfig = {
+            dbDialect: trimValue(flags['db-dialect']),
+            dbHost: trimValue(flags['db-host']),
+            dbPort: trimValue(flags['db-port']),
+            dbDatabase: trimValue(flags['db-database']),
+            dbUser: trimValue(flags['db-user']),
+            dbPassword: flags['db-password'] !== undefined ? String(flags['db-password']) : undefined,
+        };
+        const missing = [];
+        if (!dbConfig.dbDialect) {
+            missing.push('--db-dialect');
+        }
+        if (!dbConfig.dbHost) {
+            missing.push('--db-host');
+        }
+        if (!dbConfig.dbPort) {
+            missing.push('--db-port');
+        }
+        if (!dbConfig.dbDatabase) {
+            missing.push('--db-database');
+        }
+        if (!dbConfig.dbUser) {
+            missing.push('--db-user');
+        }
+        if (!dbConfig.dbPassword) {
+            missing.push('--db-password');
+        }
+        if (missing.length > 0) {
+            this.error(formatMissingFieldsMessage(missing));
+        }
+        const portError = validateTcpPort(dbConfig.dbPort);
+        if (portError) {
+            this.error(portError);
+        }
+        const envVars = {
+            DB_DIALECT: dbConfig.dbDialect,
+            DB_HOST: dbConfig.dbHost,
+            DB_PORT: dbConfig.dbPort,
+            DB_DATABASE: dbConfig.dbDatabase,
+            DB_USER: dbConfig.dbUser,
+            DB_PASSWORD: dbConfig.dbPassword,
+        };
+        const instanceId = await generateValidatedInstanceIdFromEnvVars(envVars);
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                instanceId,
+            }, null, 2));
+            return;
+        }
+        this.log(instanceId);
+    }
+}

package/dist/commands/license/id.js

@@ -0,0 +1,56 @@
+/**
+ * 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 { Command, Flags } from '@oclif/core';
+import { generateAndSaveInstanceId, licenseEnvFlag, licenseJsonFlag, readSavedInstanceId, requireLicenseRuntime, resolveInstanceIdFile, } from './shared.js';
+import { announceTargetEnv } from '../../lib/ui.js';
+export default class LicenseId extends Command {
+    static summary = 'Show the instance ID for the selected env';
+    static description = 'Show the commercial licensing instance ID for the selected env, generating and saving it if needed.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --force',
+        '<%= config.bin %> <%= command.id %> --env app1 --json',
+    ];
+    static flags = {
+        env: licenseEnvFlag,
+        json: licenseJsonFlag,
+        force: Flags.boolean({
+            description: 'Force regenerate the instance ID even if one is already saved',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(LicenseId);
+        const runtime = await requireLicenseRuntime(flags.env);
+        if (!flags.json) {
+            announceTargetEnv(runtime.envName);
+        }
+        const savedBefore = await readSavedInstanceId(runtime);
+        const shouldGenerate = Boolean(flags.force) || !savedBefore;
+        const instanceId = shouldGenerate
+            ? await generateAndSaveInstanceId(runtime)
+            : savedBefore;
+        const filePath = resolveInstanceIdFile(runtime);
+        const generated = shouldGenerate;
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                env: runtime.envName,
+                kind: runtime.kind,
+                instanceId,
+                filePath,
+                generated,
+            }, null, 2));
+            return;
+        }
+        this.log(`Instance ID for env "${runtime.envName}": ${instanceId}`);
+        this.log(`${generated ? 'Saved' : 'Loaded'} instance ID at ${filePath}`);
+    }
+}

package/dist/commands/license/index.js

@@ -0,0 +1,20 @@
+/**
+ * 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 { Command, loadHelpClass } from '@oclif/core';
+export default class License extends Command {
+    static summary = 'Manage NocoBase commercial licensing';
+    async run() {
+        await this.parse(License);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'license',
+            ...this.argv,
+        ]);
+    }
+}

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

@@ -0,0 +1,101 @@
+/**
+ * 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 { Command, Flags } from '@oclif/core';
+import pc from 'picocolors';
+import { licenseEnvFlag, licenseJsonFlag, licensePkgUrlFlag, requireLicenseRuntime } from '../shared.js';
+import { cleanLicensedPlugins } from './shared.js';
+import { resolvePluginStoragePath } from '../../../lib/plugin-storage.js';
+import { announceTargetEnv } from '../../../lib/ui.js';
+function formatActionLabel(action) {
+    switch (action) {
+        case 'removed':
+            return pc.yellow('removed');
+        case 'skipped':
+            return pc.dim('skipped');
+    }
+}
+export default class LicensePluginsClean extends Command {
+    static summary = 'Remove downloaded commercial plugins for the selected env';
+    static description = 'Remove local commercial plugin downloads for the selected env without changing license activation.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --dry-run',
+        '<%= config.bin %> <%= command.id %> --env app1 --verbose',
+        '<%= config.bin %> <%= command.id %> --env app1 --json',
+    ];
+    static flags = {
+        env: licenseEnvFlag,
+        json: licenseJsonFlag,
+        'pkg-url': licensePkgUrlFlag,
+        'dry-run': Flags.boolean({
+            description: 'Preview which commercial plugins would be removed without deleting anything',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed per-plugin clean logs',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(LicensePluginsClean);
+        const runtime = await requireLicenseRuntime(flags.env);
+        if (!flags.json) {
+            announceTargetEnv(runtime.envName);
+        }
+        const shouldStreamLogs = !flags.json && Boolean(flags.verbose);
+        const pluginStoragePath = resolvePluginStoragePath(runtime.env.storagePath);
+        if (!flags.json) {
+            this.log(pc.bold(flags['dry-run']
+                ? `Commercial plugin clean preview for env "${runtime.envName}"`
+                : `Commercial plugin clean for env "${runtime.envName}"`));
+            this.log(pc.dim(`Plugin storage path: ${pluginStoragePath}`));
+        }
+        const result = await cleanLicensedPlugins(runtime, {
+            pkgUrl: flags['pkg-url'],
+            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.action === 'removed') {
+                        this.log(pc.dim(`  symlink: ${detail.removedSymlink ? 'removed' : 'not found'}`));
+                    }
+                }
+                : undefined,
+        });
+        const payload = {
+            ok: true,
+            env: runtime.envName,
+            kind: runtime.kind,
+            dryRun: Boolean(flags['dry-run']),
+            ...result,
+        };
+        if (flags.json) {
+            this.log(JSON.stringify(payload, null, 2));
+            return;
+        }
+        if (!flags.verbose) {
+            const changes = [];
+            if (result.removed.length > 0) {
+                changes.push(pc.yellow(`${result.removed.length} removed`));
+            }
+            if (result.skipped.length > 0) {
+                changes.push(pc.dim(`${result.skipped.length} skipped`));
+            }
+            if (changes.length === 0) {
+                changes.push(pc.dim('no plugin changes'));
+            }
+            this.log(`Result: ${changes.join(', ')}`);
+        }
+        else {
+            this.log(`Summary: ${result.removed.length} removed, ${result.skipped.length} skipped`);
+        }
+    }
+}

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

@@ -0,0 +1,20 @@
+/**
+ * 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 { Command, loadHelpClass } from '@oclif/core';
+export default class LicensePlugins extends Command {
+    static summary = 'List or synchronize commercial plugins allowed by the current license';
+    async run() {
+        await this.parse(LicensePlugins);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'license plugins',
+            ...this.argv,
+        ]);
+    }
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { Command } from '@oclif/core';
+import { licenseEnvFlag, licenseJsonFlag, licensePkgUrlFlag, requireLicenseRuntime } from '../shared.js';
+import { fetchLicensedPluginPackages } from './shared.js';
+import { renderTable } from '../../../lib/ui.js';
+export default class LicensePluginsList extends Command {
+    static summary = 'List commercial plugins available to the selected env';
+    static description = 'Show the commercial plugins associated with the current saved license key for the selected env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --json',
+    ];
+    static flags = {
+        env: licenseEnvFlag,
+        json: licenseJsonFlag,
+        'pkg-url': licensePkgUrlFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(LicensePluginsList);
+        const runtime = await requireLicenseRuntime(flags.env);
+        const { commercialPlugins, licensedPlugins } = await fetchLicensedPluginPackages(runtime, {
+            pkgUrl: flags['pkg-url'],
+        });
+        const payload = {
+            ok: true,
+            env: runtime.envName,
+            kind: runtime.kind,
+            commercialPlugins,
+            licensedPlugins,
+        };
+        if (flags.json) {
+            this.log(JSON.stringify(payload, null, 2));
+            return;
+        }
+        const rows = commercialPlugins.map((pluginName) => [
+            pluginName,
+            licensedPlugins.includes(pluginName) ? 'licensed' : 'unlicensed',
+        ]);
+        this.log(`Commercial plugins for env "${runtime.envName}"`);
+        this.log(renderTable(['Package', 'Status'], rows));
+    }
+}