@skillbuilder/minitool-core 0.0.0-beta-20261027053041051

package/types/utils/logger.d.ts

@@ -0,0 +1,27 @@
+import ora, { type Ora } from "ora";
+export declare class Logger {
+    c: {
+        _times: Map<any, any>;
+        log(a: string, ...args: string[]): void;
+    };
+    verboseEnabled: boolean;
+    constructor(options?: {
+        verbose?: boolean;
+    });
+    breakLine(): void;
+    log(...args: any): void;
+    info(msg: string): void;
+    success(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+    verbose(...args: any): void;
+    /**
+     * alias for verbose
+     */
+    debug(...args: any): void;
+    genClickableLink(link: string): string;
+    printClickableLink(link: string): void;
+    time(label: string, fn: Promise<any> | (() => Promise<any>)): Promise<any>;
+    spinner(text: string, color?: ora.Color): Ora;
+}
+export declare const logger: Logger;

package/types/utils/open-browser.d.ts

@@ -0,0 +1,2 @@
+/** 打开本地预览页。参数通过 execFileSync 的 argv 传递，不经过 shell。 */
+export declare function openBrowser(host: string, port: number): Promise<boolean>;

package/types/utils/output.d.ts

@@ -0,0 +1,7 @@
+export interface HelpCommand {
+    name: string;
+    description: string;
+}
+/** 通用 CLI 帮助格式化器；不再写死旧 rcb agent/fun/env 命令。 */
+export declare function formatHelpInfo(title: string, commands: HelpCommand[]): string;
+export declare function outputHelpInfo(title: string, commands: HelpCommand[]): void;

package/types/utils/port-finder.d.ts

@@ -0,0 +1,2 @@
+export declare function findAvailablePort(startPort: number): Promise<number>;
+export declare function isPortAvailable(port: number): Promise<boolean>;

package/types/utils/project-validator.d.ts

@@ -0,0 +1,25 @@
+/** 小工具产物校验；旧 Agent 云函数项目结构与上传预检不再适用。 */
+export declare function validateMiniToolArtifact(inputPath: string): {
+    filePath: string;
+    size: number;
+};
+/** 与旧校验器保持相同的 validate() 结果形态，校验目标改为小工具 ZIP。 */
+export declare class ProjectValidator {
+    private readonly artifactPath;
+    constructor(artifactPath: string);
+    validate(): Promise<{
+        valid: boolean;
+        errors: string[];
+    }>;
+}
+export interface InspectedMiniToolFile {
+    filePath: string;
+    type: "pkg" | "image";
+    format: string;
+    size: number;
+    md5: string;
+    sha256: string;
+    bytes: Buffer;
+}
+/** 先限制大小，再校验压缩目录与 CRC；返回与校验内容一致的上传快照。 */
+export declare function inspectMiniToolFile(inputPath: string, type: "pkg" | "image"): Promise<InspectedMiniToolFile>;

package/types/utils/request.d.ts

@@ -0,0 +1,26 @@
+export interface RequestOptions {
+    method?: "GET" | "POST" | "PUT" | "DELETE";
+    url: string;
+    data?: {
+        params?: Record<string, unknown>;
+        body?: unknown;
+        query?: Record<string, unknown>;
+    };
+    headers?: Record<string, string>;
+}
+export interface RequestResponse<T> {
+    status: number;
+    data: T;
+    headers: Headers;
+}
+export declare class Request {
+    private readonly request;
+    constructor(request?: typeof fetch);
+    fetch<T = unknown>(options: RequestOptions): Promise<RequestResponse<T>>;
+    handleHttpStatus<T>(response: RequestResponse<T>): T;
+    handleCode<T extends {
+        code: number;
+        msg: string;
+    }>(data: T): T;
+}
+export declare const request: Request;

package/types/utils/table.d.ts

@@ -0,0 +1,9 @@
+import { type TableOptions } from "cli-table3";
+/**
+ * 打印水平方向的表格
+ *
+ * @param head 表头
+ * @param data 行数据，每行是一个数组
+ * @param options 透传给 cli-table3 的配置
+ */
+export declare function printHorizontalTable(head: string[], data?: (string | number)[][], options?: TableOptions): void;

package/types/utils/to-hump.d.ts

@@ -0,0 +1 @@
+export declare const toHump: (str: string) => string;

package/types/utils/tracker/ai-apm.d.ts

@@ -0,0 +1,68 @@
+/**
+ * AI 助手服务统一点位：
+ * measurement_name 固定为 redminitool_ai_tool_usage，
+ * 通过 measurement_data.event 区分事件类型：
+ *   - session_run          : AI 对话请求开始（= 出码服务使用次数）
+ *   - turn_code_generated  : 每轮 AI 出码行数统计
+ *   - session_complete     : 整次对话完成汇总
+ *   - code_change_applied  : 用户接受单个 AI 代码变更（接受率分子）
+ *   - code_change_rejected : 用户拒绝单个 AI 代码变更（接受率分母）
+ *   - bulk_resolve         : 用户批量接受/拒绝所有变更
+ *   - message_sent         : 前端用户发送消息（来自浏览器端 APM 代理）
+ */
+export declare const AI_MEASUREMENT_NAME = "redminitool_ai_tool_usage";
+export type AiSessionStatus = "success" | "fail" | "aborted";
+export interface InitAiApmOptions {
+    userId?: string;
+}
+export declare function initAiApm(options?: InitAiApmOptions): void;
+export interface AiSessionRunMeta {
+    session_id: string;
+    model?: string;
+    dev_mode?: string;
+    /** 1 = 新 session，0 = 复用已有 session */
+    is_new_session?: 0 | 1;
+    message_length?: number;
+}
+export declare function reportAiSessionRun(meta: AiSessionRunMeta): void;
+export interface AiTurnCodeGeneratedMeta {
+    session_id?: string;
+    model?: string;
+    dev_mode?: string;
+    files_changed?: number;
+    lines_added?: number;
+    lines_removed?: number;
+}
+export declare function reportAiTurnCodeGenerated(meta: AiTurnCodeGeneratedMeta): void;
+export interface AiSessionCompleteMeta {
+    session_id: string;
+    model?: string;
+    dev_mode?: string;
+    duration_ms: number;
+    status: AiSessionStatus;
+    total_files_changed?: number;
+    total_lines_added?: number;
+    total_lines_removed?: number;
+    error_type?: string;
+}
+export declare function reportAiSessionComplete(meta: AiSessionCompleteMeta): void;
+export interface AiCodeChangeMeta {
+    session_id?: string;
+    /** "write" | "edit" */
+    tool_name?: string;
+}
+export declare function reportAiCodeChangeApplied(meta: AiCodeChangeMeta): void;
+export declare function reportAiCodeChangeRejected(meta: AiCodeChangeMeta): void;
+export interface AiBulkResolveMeta {
+    session_id?: string;
+    action: "accept" | "reject";
+    files_count?: number;
+}
+export declare function reportAiBulkResolve(meta: AiBulkResolveMeta): void;
+export interface AiMessageSentMeta {
+    session_id?: string;
+    mode?: string;
+    model?: string;
+    message_length?: number;
+}
+export declare function reportAiMessageSent(meta: AiMessageSentMeta): void;

package/types/utils/tracker/apm.d.ts

@@ -0,0 +1,21 @@
+import type { IBase } from "./tracker";
+export interface ApmOptions {
+    endpoint?: string;
+    /** 测试或平台适配器可自行提供传输；默认仅在配置 endpoint 时发送。 */
+    transport?: (payload: Record<string, unknown>[]) => Promise<void>;
+}
+/** 通用 APM 传输，不自动获取设备 ID、登录态或凭据。 */
+export declare class APM {
+    private readonly sessionId;
+    private sequence;
+    private appVersion;
+    private userId;
+    private base;
+    private readonly transport?;
+    private readonly pending;
+    constructor(options?: ApmOptions);
+    setContext(userId: string, base?: IBase): void;
+    setAppVersion(version: string): void;
+    report(measurement_name: string, measurement_data?: Record<string, unknown>): void;
+    flush(): Promise<void>;
+}

package/types/utils/tracker/cli-apm.d.ts

@@ -0,0 +1,47 @@
+/** CLI 通用埋点；不依赖小工具业务服务，也不读取本地凭据。 */
+export declare const CLI_MEASUREMENT_NAME = "redminitool_cli_usage";
+export type CliApmCommandStatus = 0 | 1;
+export type CliApmExceptionSource = "uncaughtException" | "unhandledRejection";
+export type CliApmErrorType = "auth" | "http" | "validation" | "biz" | "unknown";
+export interface CliApmEvent {
+    context_nameTracker: "nodeT";
+    context_platform: string;
+    context_appVersion: string;
+    context_matchedPath: "cli";
+    context_sdkSessionId: string;
+    context_sdkSeqId: number;
+    clientTime: number;
+    measurement_name: typeof CLI_MEASUREMENT_NAME;
+    measurement_data: Record<string, string | number | undefined>;
+}
+export interface CliApmTransport {
+    report(event: CliApmEvent): Promise<void> | void;
+}
+export interface InitCliApmOptions {
+    cliVersion?: string;
+    /** 未配置 endpoint/transport 时不发送；正式启用前由产品和服务端确认上报地址。 */
+    endpoint?: string;
+    /** 方便注入平台上报适配器和测试替身。 */
+    transport?: CliApmTransport;
+}
+export interface CliCommandMeta {
+    cmd_path: string;
+    cmd_root?: string;
+    params_count?: number;
+    options_keys?: string[];
+}
+export interface CliHttpErrorMeta {
+    method?: string;
+    url?: string;
+    status_code?: number;
+}
+export declare function initCliApm(options?: InitCliApmOptions): void;
+export declare function setCliApmCurrentCommand(cmdPath?: string): void;
+export declare function createCliCommandTracker(meta: CliCommandMeta): {
+    reportSuccess(durationMs: number): void;
+    reportFail(durationMs: number, err: unknown): void;
+};
+export declare function reportCliException(source: CliApmExceptionSource, err: unknown): void;
+export declare function reportCliHttpError(meta: CliHttpErrorMeta, err?: unknown): void;
+/** CLI 退出前最多等待一小段时间，超时后取消请求；上报失败永不影响命令结果。 */
+export declare function flushCliApm(timeoutMs?: number): Promise<void>;

package/types/utils/tracker/device.d.ts

@@ -0,0 +1,8 @@
+import type { IDeviceInfo, IDeviceUA } from "./tracker";
+/** 本地诊断信息；CLI APM 不会自动采集或发送这些字段。 */
+export declare function getDeviceInfo(): IDeviceInfo;
+export declare function deviceUA(): IDeviceUA;
+/**
+ * 旧版会读取硬件 UUID 并写 ~/.rcb/.device.json；该持久设备标识未获隐私评审，不再生成。
+ */
+export declare function machineId(): never;

package/types/utils/tracker/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./apm";
+export * from "./ai-apm";
+export * from "./cli-apm";
+export * from "./device";
+export * from "./tracker";

package/types/utils/tracker/tracker.d.ts

@@ -0,0 +1,22 @@
+export interface IDeviceInfo {
+    os_platform: string;
+    os_arch: string;
+    cpu_speed: number;
+    cpu_model: string;
+    machine_memory: number;
+    os_version: string;
+}
+export interface IDeviceUA {
+    login_user?: string;
+    node_version: string;
+}
+export interface IBase {
+    app_id?: string;
+    app_name?: string;
+    third_name?: string;
+    page_key?: string;
+    base_version?: string;
+    app_env?: number;
+    app_type?: number;
+    bundle_version?: string;
+}