@ultikits/cli 1.1.0 → 2.0.0

package/dist/src/commands/modules.d.ts

@@ -1,2 +1,37 @@
 import { Command } from 'commander';
+import type { CommandDeps } from './publish.js';
+/** Exit code for a usage error or a refused confirmation; nothing was sent. */
+export declare const EXIT_USAGE = 2;
+export interface ManageDeps extends CommandDeps {
+    /** Overrides terminal detection (tests). */
+    interactive?: boolean;
+    /** Asks one question on the terminal (tests pass a stub). */
+    ask?: (question: string) => Promise<string>;
+}
+interface ApiUrlOption {
+    apiUrl?: string;
+}
+export interface CreateOptions extends ApiUrlOption {
+    id?: string;
+    name?: string;
+    shortDescription?: string;
+    categoryId?: string;
+}
+export interface UpdateOptions extends ApiUrlOption {
+    name?: string;
+    shortDescription?: string;
+    descriptionFile?: string;
+    categoryId?: string;
+}
+export interface DestructiveOptions extends ApiUrlOption {
+    confirm?: string;
+    yes?: boolean;
+}
 export declare function registerModulesCommand(program: Command): void;
+export declare function runModulesList(options: ApiUrlOption, deps?: ManageDeps): Promise<number>;
+export declare function runModulesInfo(identifier: string, options: ApiUrlOption, deps?: ManageDeps): Promise<number>;
+export declare function runModulesCreate(options: CreateOptions, deps?: ManageDeps): Promise<number>;
+export declare function runModulesUpdate(identifier: string, options: UpdateOptions, deps?: ManageDeps): Promise<number>;
+export declare function runModulesDelete(identifier: string, options: DestructiveOptions, deps?: ManageDeps): Promise<number>;
+export declare function runModulesRestore(identifier: string, options: ApiUrlOption, deps?: ManageDeps): Promise<number>;
+export {};

package/dist/src/commands/modules.js

@@ -1,92 +1,254 @@
-import inquirer from 'inquirer';
-import { readCredentials } from '../lib/config.js';
+import fs from 'node:fs';
+import { resolveAuth } from '../lib/config.js';
 import { ApiClient } from '../lib/api-client.js';
-import * as log from '../lib/logger.js';
+import { readProjectConfig } from '../lib/project-config.js';
+import { redact } from '../lib/mask.js';
+import { consoleIo } from '../lib/logger.js';
+import { fetchAllPages, MAX_PAGE_SIZE } from '../lib/paging.js';
+import { isInteractiveTerminal, requireConfirmation } from '../lib/confirm.js';
+import { describeCommandError } from '../lib/command-errors.js';
+/** Exit code for a usage error or a refused confirmation; nothing was sent. */
+export const EXIT_USAGE = 2;
+const API_URL_HELP = 'UltiCloud API URL (default: ULTIKITS_API_URL, stored login, or https://api.ultikits.com)';
+const MANAGE_NOTE = '(needs a manage credential: `ultikits login`, or a developer key rotated to the manage scope)';
 export function registerModulesCommand(program) {
     const modules = program
         .command('modules')
-        .description('Manage your marketplace modules');
+        .description('Manage your UltiCloud modules')
+        .addHelpText('after', '\nDeleted modules can be restored for 30 days with `ultikits modules restore <identifier>`.\n' +
+        'The web panel has no restore: the CLI (or the API) is the only way back.');
     modules
         .command('list')
         .description('List your modules')
-        .action(async () => {
-        const client = getClient();
-        const spin = log.spinner('Loading modules...');
-        spin.start();
-        const res = await client.get('/developer/modules');
-        if (res.code !== '200') {
-            spin.fail('Failed to list modules: ' + res.msg);
-            process.exit(1);
-        }
-        spin.stop();
-        const modulesList = res.data;
-        if (modulesList.length === 0) {
-            log.info('No modules found. Create one with `ultikits publish`.');
-            return;
-        }
-        console.log();
-        for (const mod of modulesList) {
-            const version = mod.latestVersion?.version ?? 'no versions';
-            console.log(`  ${mod.identifyString} — ${mod.name} (${version})`);
-        }
-        console.log();
-        log.info(`${modulesList.length} module(s)`);
+        .option('--api-url <url>', API_URL_HELP)
+        .action(async (options) => {
+        process.exitCode = await runModulesList(options);
     });
     modules
-        .command('info <identifyString>')
-        .description('Show module details')
-        .action(async (identifyString) => {
-        const client = getClient();
-        const res = await client.get(`/plugin/get?identifyString=${identifyString}`);
-        if (res.code !== '200' || !res.data) {
-            log.error('Module not found: ' + identifyString);
-            process.exit(1);
-        }
-        const mod = res.data;
-        console.log();
-        console.log(`  Name:        ${mod.name}`);
-        console.log(`  ID:          ${mod.identifyString}`);
-        console.log(`  Description: ${mod.shortDescription || 'N/A'}`);
-        console.log(`  Downloads:   ${mod.downloads ?? 0}`);
-        console.log(`  Version:     ${mod.latestVersion?.version ?? 'N/A'}`);
-        console.log();
+        .command('info <identifier>')
+        .description('Show one of your modules')
+        .option('--api-url <url>', API_URL_HELP)
+        .action(async (identifier, options) => {
+        process.exitCode = await runModulesInfo(identifier, options);
+    });
+    modules
+        .command('create')
+        .description(`Create a module ${MANAGE_NOTE}`)
+        .option('--id <identifier>', 'Module identifier (default: identifyString in ultikits.json)')
+        .option('--name <name>', 'Display name (default: name in ultikits.json)')
+        .option('--short-description <text>', 'Short description, up to 200 characters')
+        .option('--category-id <id>', 'Category id')
+        .option('--api-url <url>', API_URL_HELP)
+        .action(async (options) => {
+        process.exitCode = await runModulesCreate(options);
     });
     modules
-        .command('delete <identifyString>')
-        .description('Delete a module')
-        .action(async (identifyString) => {
-        const client = getClient();
-        // Get module ID first
-        const infoRes = await client.get(`/plugin/get?identifyString=${identifyString}`);
-        if (infoRes.code !== '200' || !infoRes.data) {
-            log.error('Module not found: ' + identifyString);
-            process.exit(1);
+        .command('update <identifier>')
+        .description(`Change a module's profile; only the options given are sent ${MANAGE_NOTE}`)
+        .option('--name <name>', 'New display name')
+        .option('--short-description <text>', 'New short description')
+        .option('--description-file <path>', 'File whose content becomes the long description')
+        .option('--category-id <id>', 'New category id')
+        .option('--api-url <url>', API_URL_HELP)
+        .action(async (identifier, options) => {
+        process.exitCode = await runModulesUpdate(identifier, options);
+    });
+    modules
+        .command('delete <identifier>')
+        .description(`Delete a module; restorable for 30 days with \`ultikits modules restore\` ${MANAGE_NOTE}`)
+        .option('--confirm <identifier>', 'Required with -y or without a terminal: the same identifier again')
+        .option('-y, --yes', 'Do not prompt (still requires --confirm)')
+        .option('--api-url <url>', API_URL_HELP)
+        .action(async (identifier, options) => {
+        process.exitCode = await runModulesDelete(identifier, options);
+    });
+    modules
+        .command('restore <identifier>')
+        .description(`Restore a module deleted in the last 30 days ${MANAGE_NOTE}`)
+        .option('--api-url <url>', API_URL_HELP)
+        .action(async (identifier, options) => {
+        process.exitCode = await runModulesRestore(identifier, options);
+    });
+}
+function authenticate(options, deps) {
+    const io = deps.io ?? consoleIo;
+    const auth = resolveAuth({ apiUrl: options.apiUrl, env: deps.env ?? process.env, configDir: deps.configDir });
+    if (!auth.ok) {
+        io.err(auth.message);
+        return null;
+    }
+    return { auth, client: new ApiClient({ apiUrl: auth.apiUrl, credential: auth.credential }), io };
+}
+function fail(a, err, ctx) {
+    a.io.err(redact(describeCommandError(err, { ...ctx, apiUrl: a.auth.apiUrl }), a.auth.credential));
+    return 1;
+}
+function listAll(client) {
+    return fetchAllPages((page) => client.listModules({ page, pageSize: MAX_PAGE_SIZE }));
+}
+/** Parses a positive integer option; returns undefined when absent, null when invalid. */
+function parseCategoryId(value) {
+    if (value === undefined)
+        return undefined;
+    return /^[1-9][0-9]{0,15}$/.test(value) ? Number(value) : null;
+}
+export async function runModulesList(options, deps = {}) {
+    const a = authenticate(options, deps);
+    if (!a)
+        return 1;
+    let items;
+    try {
+        items = await listAll(a.client);
+    }
+    catch (err) {
+        return fail(a, err, { op: 'list' });
+    }
+    if (items.length === 0) {
+        a.io.out('还没有模块：用 ultikits publish 发布（模块不存在时会自动创建），或 ultikits modules create。');
+        return 0;
+    }
+    for (const mod of items) {
+        a.io.out(`  ${mod.identifier} — ${mod.name} (${mod.latestVersion ?? '无已发布版本 / no versions'})`);
+    }
+    a.io.out(`共 ${items.length} 个模块 / ${items.length} module(s)`);
+    return 0;
+}
+export async function runModulesInfo(identifier, options, deps = {}) {
+    const a = authenticate(options, deps);
+    if (!a)
+        return 1;
+    let items;
+    try {
+        items = await listAll(a.client);
+    }
+    catch (err) {
+        return fail(a, err, { op: 'list', identifier });
+    }
+    const mod = items.find((m) => m.identifier === identifier);
+    if (!mod) {
+        a.io.err(`你的模块里没有 ${identifier}（用 ultikits modules list 查看；删除后 30 天内可 ultikits modules restore ${identifier}）。`);
+        return 1;
+    }
+    a.io.out(`  名称 / Name:          ${mod.name}`);
+    a.io.out(`  标识符 / Identifier:  ${mod.identifier}`);
+    a.io.out(`  简介 / Summary:       ${mod.shortDescription || '-'}`);
+    a.io.out(`  分类 / Category:      ${mod.category ? `${mod.category.name} (#${mod.category.id})` : '-'}`);
+    a.io.out(`  最新版本 / Latest:    ${mod.latestVersion ?? '无已发布版本 / none'}`);
+    a.io.out(`  下载 / Downloads:     ${mod.downloads}`);
+    a.io.out(`  更新 / Updated:       ${mod.updatedAt}`);
+    return 0;
+}
+export async function runModulesCreate(options, deps = {}) {
+    const io = deps.io ?? consoleIo;
+    const config = readProjectConfig(deps.cwd ?? process.cwd());
+    const identifier = options.id ?? config?.identifyString;
+    const name = options.name ?? config?.name;
+    if (!identifier || !name) {
+        io.err('需要模块标识符与名称：用 --id 与 --name 指定，或写进 ultikits.json（identifyString、name）。未发送任何请求。');
+        return EXIT_USAGE;
+    }
+    const flagCategory = parseCategoryId(options.categoryId);
+    if (flagCategory === null) {
+        io.err(`--category-id 必须是正整数：${options.categoryId}。未发送任何请求。`);
+        return EXIT_USAGE;
+    }
+    const a = authenticate(options, deps);
+    if (!a)
+        return 1;
+    try {
+        const created = await a.client.createModule({
+            name,
+            identifier,
+            shortDescription: options.shortDescription ?? config?.shortDescription ?? '',
+            description: null,
+            categoryId: flagCategory ?? config?.categoryId ?? null,
+            compatibleApiVersions: null,
+            tags: [],
+        });
+        a.io.out(`已创建模块 ${created.identifier}（${created.name}）。用 ultikits publish 发布第一个版本。`);
+        return 0;
+    }
+    catch (err) {
+        return fail(a, err, { op: 'create', identifier });
+    }
+}
+export async function runModulesUpdate(identifier, options, deps = {}) {
+    const io = deps.io ?? consoleIo;
+    const body = {};
+    if (options.name !== undefined)
+        body.name = options.name;
+    if (options.shortDescription !== undefined)
+        body.shortDescription = options.shortDescription;
+    if (options.descriptionFile !== undefined) {
+        try {
+            body.description = fs.readFileSync(options.descriptionFile, 'utf8');
         }
-        const { confirm } = await inquirer.prompt([
-            {
-                type: 'confirm',
-                name: 'confirm',
-                message: `Delete module "${identifyString}"? This cannot be undone.`,
-                default: false,
-            },
-        ]);
-        if (!confirm)
-            return;
-        const res = await client.delete(`/developer/modules/${infoRes.data.id}`);
-        if (res.code !== '200') {
-            log.error('Failed to delete: ' + res.msg);
-            process.exit(1);
+        catch {
+            io.err(`读不到描述文件：${options.descriptionFile}。未发送任何请求。`);
+            return EXIT_USAGE;
         }
-        log.success(`Deleted module: ${identifyString}`);
+    }
+    const category = parseCategoryId(options.categoryId);
+    if (category === null) {
+        io.err(`--category-id 必须是正整数：${options.categoryId}。未发送任何请求。`);
+        return EXIT_USAGE;
+    }
+    if (category !== undefined)
+        body.categoryId = category;
+    if (Object.keys(body).length === 0) {
+        io.err('没有要改的内容：至少给出 --name、--short-description、--description-file 或 --category-id 之一。未发送任何请求。');
+        return EXIT_USAGE;
+    }
+    const a = authenticate(options, deps);
+    if (!a)
+        return 1;
+    try {
+        await a.client.updateModule(identifier, body);
+        a.io.out(`已更新模块 ${identifier}：${Object.keys(body).join(', ')}。`);
+        return 0;
+    }
+    catch (err) {
+        return fail(a, err, { op: 'update', identifier });
+    }
+}
+export async function runModulesDelete(identifier, options, deps = {}) {
+    const io = deps.io ?? consoleIo;
+    const confirmed = await requireConfirmation({
+        expected: identifier,
+        flagValue: options.confirm,
+        yes: options.yes,
+        interactive: deps.interactive ?? isInteractiveTerminal(),
+        warning: `将删除模块 ${identifier}：它会立刻从目录、下载与你的模块列表中消失。` +
+            `30 天内可用 ultikits modules restore ${identifier} 恢复（网页面板不提供恢复），之后永久清除。`,
+        ask: deps.ask,
     });
+    if (!confirmed.ok) {
+        io.err(confirmed.reason);
+        return EXIT_USAGE;
+    }
+    const a = authenticate(options, deps);
+    if (!a)
+        return 1;
+    try {
+        const result = await a.client.deleteModule(identifier);
+        a.io.out(`已删除 ${identifier}。${result.restorableUntil} 前可用 ultikits modules restore ${identifier} 恢复（网页面板不提供恢复）。`);
+        return 0;
+    }
+    catch (err) {
+        return fail(a, err, { op: 'delete', identifier });
+    }
 }
-function getClient() {
-    const credentials = readCredentials();
-    const client = ApiClient.fromEnvOrCredentials(credentials);
-    if (!client) {
-        log.error('Not logged in. Run `ultikits login` or set ULTIKITS_TOKEN.');
-        process.exit(1);
-    }
-    return client;
+export async function runModulesRestore(identifier, options, deps = {}) {
+    const a = authenticate(options, deps);
+    if (!a)
+        return 1;
+    try {
+        const mod = await a.client.restoreModule(identifier);
+        a.io.out(`已恢复 ${mod.identifier}（${mod.name}）。`);
+        return 0;
+    }
+    catch (err) {
+        return fail(a, err, { op: 'restore', identifier });
+    }
 }
 //# sourceMappingURL=modules.js.map

package/dist/src/commands/publish.d.ts

@@ -1,5 +1,9 @@
 import { Command } from 'commander';
+import { ApiError } from '../lib/api-client.js';
+import { type Io } from '../lib/logger.js';
 import type { ModuleMetadata, ProjectConfig, PluginYml } from '../types.js';
+/** Upload limit from the contract (versionsCreate.sizeBytes maximum). */
+export declare const MAX_JAR_BYTES = 52428800;
 interface PublishFlags {
     id?: string;
     name?: string;
@@ -7,6 +11,30 @@ interface PublishFlags {
     changelog?: string;
     shortDescription?: string;
 }
+export interface PublishOptions extends PublishFlags {
+    yes?: boolean;
+    apiUrl?: string;
+}
+export interface CommandDeps {
+    env?: NodeJS.ProcessEnv;
+    configDir?: string;
+    cwd?: string;
+    io?: Io;
+    prompt?: (questions: any[]) => Promise<Record<string, any>>;
+}
 export declare function resolveMetadata(flags: PublishFlags, projectConfig: ProjectConfig | null, pluginYml: PluginYml | null): ModuleMetadata;
 export declare function registerPublishCommand(program: Command): void;
+export declare function runPublish(jarPath: string | undefined, options: PublishOptions, deps?: CommandDeps): Promise<number>;
+export interface PublishErrorContext {
+    identifier: string;
+    version: string;
+    apiUrl: string;
+    phase?: 'publish' | 'createModule';
+}
+/**
+ * One message per error code of the developer-client contract (keys must be codes
+ * that appear in tests/contract/.../schemas; DEVELOPER-CLIENT.md "错误码与客户端动作").
+ */
+export declare const PUBLISH_ERROR_MESSAGES: Record<string, (err: ApiError, ctx: PublishErrorContext) => string>;
+export declare function publishErrorMessage(err: unknown, ctx: PublishErrorContext): string;
 export {};