@plugin-light/shared 1.0.3 → 1.0.14

package/lib/landun/cos-sync-to-git.d.ts

@@ -0,0 +1,12 @@
+/**
+ * COS 同步到 Git 的选项
+ */
+export interface CosSyncToGitOptions {
+    /** 操作员名称 */
+    staffName?: string;
+}
+/**
+ * 将 COS 文件同步到 Git 仓库
+ * @param options - 同步选项
+ */
+export declare function cosSyncToGit({ staffName, }: CosSyncToGitOptions): Promise<void>;

package/lib/landun/index.d.ts

@@ -0,0 +1,2 @@
+export { cosSyncToGit, type CosSyncToGitOptions, } from './cos-sync-to-git';
+export { startPipelineByRawApi, type StartPipelineResult, } from './start';

package/lib/landun/start.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 启动流水线参数
+ */
+interface StartPipelineParams {
+    /** 流水线参数数据 */
+    data: Record<string, unknown>;
+    /** 流水线 ID */
+    pipelineId: string;
+    /** 用户名 */
+    userName?: string;
+    /** 项目 ID */
+    projectId?: string;
+}
+/**
+ * 启动流水线返回结果
+ */
+export interface StartPipelineResult {
+    /** 状态 */
+    status: boolean;
+    /** 错误消息 */
+    message?: string;
+    /** 返回数据 */
+    data: {
+        /** 构建 ID */
+        id: string;
+        /** 流水线 ID */
+        pipelineId: string;
+        /** 项目 ID */
+        projectId: string;
+        /** 构建编号 */
+        num: number;
+        /** 执行次数 */
+        executeCount: number;
+    };
+}
+/**
+ * 通过原始 API 启动蓝盾流水线
+ * @param params - 启动参数
+ * @returns 流水线执行结果
+ */
+export declare function startPipelineByRawApi({ data, pipelineId, userName, projectId: pId, }: StartPipelineParams): Promise<StartPipelineResult>;
+export {};

package/lib/mcp/auth.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 研发平台 MCP 公共认证模块
+ */
+/**
+ * 解析命令行参数
+ * @param defaultApiUrl 默认的 API URL
+ * @returns 包含 rid, rtoken, apiUrl 和所有其他参数的对象
+ */
+export declare function parseMCPCommandLineArgs(defaultApiUrl: string): {
+    rid: string;
+    rtoken: string;
+    apiUrl: string;
+    [key: string]: string;
+};
+/**
+ * 验证凭证
+ */
+export declare function validateMCPCredentials(rid: string, rtoken: string): {
+    content: {
+        type: "text";
+        text: string;
+    }[];
+    isError: boolean;
+} | null;

package/lib/mcp/http.d.ts

@@ -0,0 +1,34 @@
+/**
+ * HTTP 调用结果
+ */
+export interface ApiResult {
+    success: boolean;
+    message?: string;
+    data?: any;
+    code?: number;
+}
+/**
+ * 通用错误处理
+ */
+export declare function handleAxiosError(error: any, actionName: string): ApiResult;
+/**
+ * Package.json 结构
+ */
+interface PackageJson {
+    name: string;
+    version: string;
+    [key: string]: any;
+}
+/**
+ * 调用研发平台 API
+ * @param apiUrl API 地址
+ * @param requestBody 请求体
+ * @param rid 用户 rid
+ * @param rtoken 用户 token
+ * @param pkg package.json 对象（用于获取 MCP 名称和版本）
+ * @example
+ * import pkg from '../package.json';
+ * await callRdApi(apiUrl, requestBody, rid, rtoken, pkg);
+ */
+export declare function callRdMCPApi(apiUrl: string, requestBody: Record<string, unknown>, rid: string, rtoken: string, pkg: PackageJson): Promise<ApiResult>;
+export {};

package/lib/mcp/index.d.ts

@@ -0,0 +1,3 @@
+export { parseMCPCommandLineArgs, validateMCPCredentials, } from './auth';
+export { callRdMCPApi, handleAxiosError, type ApiResult, } from './http';
+export { getMcpName, getMcpVersion, } from './mcp';

package/lib/mcp/mcp.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Package.json 结构
+ */
+interface PackageJson {
+    name: string;
+    version: string;
+    [key: string]: any;
+}
+/**
+ * 获取 MCP 名称（去掉  前缀）
+ * @param pkg package.json 对象
+ * @returns MCP 名称
+ * @example
+ * import pkg from '../package.json';
+ * const mcpName = getMcpName(pkg);
+ */
+export declare function getMcpName(pkg: PackageJson): string;
+/**
+ * 获取 MCP 版本
+ * @param pkg package.json 对象
+ * @returns 版本号
+ * @example
+ * import pkg from '../package.json';
+ * const mcpVersion = getMcpVersion(pkg);
+ */
+export declare function getMcpVersion(pkg: PackageJson): string;
+export {};

package/lib/mp-ci/config.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 小程序 CI 模板 ID 映射
+ */
+export declare const TEMPLATE_ID_MAP: {
+    /** 微信小程序 CI 模板 ID */
+    readonly WX_MP_CI: "864ecf9343fb4748adfdecde92712401";
+    /** QQ 小程序 CI 模板 ID */
+    readonly QQ_MP_CI: "6c13205d64fe4a42889db131b5e47d03";
+    /** Cypress 自动化测试模板 ID */
+    readonly CYPRESS_AUTO_TEST: "f7b13cf8929343a1bd56949e5463dfc4";
+};

package/lib/mp-ci/helper.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 根据分支获取环境
+ * @param branch - 分支名称
+ * @returns 环境名称，release 分支返回 'release'，其他返回 'test'
+ */
+export declare function getEnvByBranch(branch: string): string;
+/**
+ * 解析发布原因，替换特殊字符
+ * @param str - 原始发布原因字符串
+ * @returns 处理后的发布原因字符串
+ */
+export declare function parsePublishReason(str?: string): string;

package/lib/mp-ci/index.d.ts

@@ -0,0 +1,5 @@
+export { getRainbowConfig, updateMpCiConfig, getAllMpPipeline, getMpCICommonConfig, getMpCIKeyConfig, } from './mp-ci';
+export { TEMPLATE_ID_MAP, } from './config';
+export { startMpCIPipeline, } from './start-from-mcp';
+export { addMPPublishRecord, } from './record';
+export { getEnvByBranch, parsePublishReason, } from './helper';

package/lib/mp-ci/mp-ci.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Rainbow 配置查询参数
+ */
+interface RainbowConfigParams {
+    /** 研发平台项目 ID */
+    rdProjectId?: string;
+    /** 项目名称 */
+    projectName?: string;
+    /** 子项目名称 */
+    subProject: string;
+}
+/**
+ * Rainbow 配置项
+ */
+interface RainbowConfigItem {
+    /** Rainbow Key */
+    rainbowKey: string;
+    /** 研发平台项目 ID */
+    rdProjectId?: string;
+    /** 子项目名称 */
+    subProject?: string;
+    [key: string]: any;
+}
+/**
+ * 获取小程序 CI 通用配置
+ * @returns 通用配置对象
+ */
+export declare function getMpCICommonConfig(): Promise<unknown>;
+/**
+ * 获取 Rainbow 配置
+ * @param params - 查询参数
+ * @returns Rainbow 配置项列表
+ */
+export declare function getRainbowConfig({ rdProjectId, projectName, subProject, }: RainbowConfigParams): Promise<RainbowConfigItem[]>;
+/**
+ * 更新小程序 CI 配置
+ * @param value - 配置值
+ * @param key - 配置 Key
+ */
+export declare function updateMpCiConfig(value: unknown, key: string): Promise<void>;
+/**
+ * 获取所有小程序流水线实例
+ * @returns 微信和 QQ 小程序流水线实例
+ */
+export declare function getAllMpPipeline(): Promise<{
+    wxInstances: {
+        templateId: string;
+        versionName: string;
+        version: number;
+        pipelineId: string;
+        pipelineName: string;
+        updateTime: number;
+        hasPermission: boolean;
+        status: string;
+    }[];
+    qqInstances: {
+        templateId: string;
+        versionName: string;
+        version: number;
+        pipelineId: string;
+        pipelineName: string;
+        updateTime: number;
+        hasPermission: boolean;
+        status: string;
+    }[];
+}>;
+/**
+ * 获取指定 Key 的小程序 CI 配置
+ * @param key - 配置 Key
+ * @returns 配置值
+ */
+export declare function getMpCIKeyConfig(key: string): Promise<unknown>;
+export {};

package/lib/mp-ci/record.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 添加小程序发布记录参数
+ */
+interface AddMPPublishRecordParams {
+    /** 操作员名称 */
+    staffName: string;
+    /** 仓库地址 */
+    repo: string;
+    /** 子项目名称 */
+    subProjectName: string;
+    /** 分支名称 */
+    branch: string;
+    /** 环境名称 */
+    env: string;
+    /** 是否为微信小程序 */
+    isWeixin?: boolean;
+    /** 流水线 ID */
+    pipelineId: string;
+    /** 流水线运行 ID */
+    pipelineRunId: string;
+    /** 发布原因 */
+    publishReason?: string;
+    /** 是否来自 MCP */
+    fromMcp?: boolean;
+    /** MCP 名称 */
+    mcpName?: string;
+    /** MCP 版本 */
+    version?: string;
+    /** 操作记录工具 */
+    operationTool: any;
+    /** MCP 数据库实例 */
+    mcpDB?: any;
+}
+/**
+ * 添加小程序发布记录
+ * @param params - 记录参数
+ */
+export declare function addMPPublishRecord({ staffName, repo, subProjectName, branch, env, isWeixin, pipelineId, pipelineRunId, publishReason, fromMcp, mcpName, version, operationTool, mcpDB, }: AddMPPublishRecordParams): Promise<void>;
+export {};

package/lib/mp-ci/start-from-mcp.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 启动小程序 CI 流水线参数
+ */
+interface StartMpCIPipelineParams {
+    /** 仓库地址 */
+    repo: string;
+    /** 子项目名称 */
+    subProject: string;
+    /** 分支名称 */
+    branch: string;
+    /** 操作员名称 */
+    staffName: string;
+    /** 是否为微信小程序 */
+    isWeixin?: boolean;
+    /** 发布原因 */
+    publishReason?: string;
+    /** MCP 名称 */
+    mcpName?: string;
+    /** MCP 版本 */
+    mcpVersion?: string;
+    /** 启动流水线函数 */
+    startPipeline: any;
+    /** 操作记录工具 */
+    operationTool: any;
+    /** MCP 数据库实例 */
+    mcpDB?: any;
+}
+/**
+ * 启动小程序 CI 流水线
+ * @param params - 启动参数
+ * @returns 执行结果
+ */
+export declare function startMpCIPipeline({ repo: rawRepo, subProject, branch, staffName, isWeixin, publishReason, mcpName, mcpVersion, startPipeline, operationTool, mcpDB, }: StartMpCIPipelineParams): Promise<{
+    r: number;
+    msg: string;
+    result?: undefined;
+} | {
+    r: any;
+    msg: any;
+    result: any;
+}>;
+export {};

package/lib/npm-publish/index.d.ts

@@ -0,0 +1 @@
+export { NPM_PACKAGES_LIST, type NpmPackageConfig } from '@plugin-light/const';

package/lib/pipeline/index.d.ts

@@ -0,0 +1 @@
+export { getPipelineRunLink } from './pipeline';

package/lib/pipeline/pipeline.d.ts

@@ -0,0 +1,4 @@
+export declare function getPipelineRunLink({ pipelineId, pipelineRunId, }: {
+    pipelineId: string;
+    pipelineRunId: string;
+}): string;

package/lib/pipeline-npm-publish/core.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 启动 NPM 发布流水线表单参数
+ */
+interface NPMPublishForm {
+    /** 分支名称 */
+    branch: string;
+    /** 发布原因 */
+    publishReason: string;
+    /** 版本类型 */
+    versionType: string;
+    /** 是否发布到外网 NPM */
+    publishExternalNPM?: boolean;
+    /** 发布的子包名称 */
+    publishPackage?: string;
+}
+/**
+ * 启动 NPM 发布流水线核心参数
+ */
+interface StartNPMPublishPipelineCoreParams {
+    /** 表单参数 */
+    form: NPMPublishForm;
+    /** 操作员名称 */
+    staffName: string;
+    /** 远程流水线 ID */
+    remotePipelineId: string;
+    /** 组件标题 */
+    componentTitle: string;
+    /** MCP 数据库实例 */
+    mcpDB?: any;
+    /** 是否来自 MCP */
+    fromMcp?: boolean;
+    /** MCP 名称 */
+    mcpName?: string;
+    /** MCP 版本 */
+    mcpVersion?: string;
+    /** 操作记录工具 */
+    operationTool: any;
+}
+/**
+ * 启动 NPM 发布流水线核心函数
+ * @param params - 启动参数
+ * @returns 执行结果
+ */
+export declare function startNPMPublishPipelineCore({ form, staffName, remotePipelineId, componentTitle, mcpDB, fromMcp, mcpName, mcpVersion, operationTool, }: StartNPMPublishPipelineCoreParams): Promise<{
+    r: number;
+    result: import("../landun/start").StartPipelineResult;
+    msg?: undefined;
+} | {
+    r: number;
+    msg: any;
+    result?: undefined;
+}>;
+export {};

package/lib/pipeline-npm-publish/helper.d.ts

@@ -0,0 +1,7 @@
+import { type NpmPackageConfig } from '@plugin-light/const';
+/**
+ * 根据 repo 获取组件配置
+ * @param repo 仓库地址，支持 SSH 和 HTTPS 格式
+ * @returns 组件配置，未找到则返回 null
+ */
+export declare function getComponentByRepo(repo: string): NpmPackageConfig | null;

package/lib/pipeline-npm-publish/index.d.ts

@@ -0,0 +1,2 @@
+export { startNPMPublishPipelineCore, } from './core';
+export { getComponentByRepo, } from './helper';

package/lib/repo/index.d.ts

@@ -0,0 +1 @@
+export { extractRepoPath } from './repo';

package/lib/repo/repo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 从 repo 地址中提取仓库路径
+ * 支持 git@git.aow.com:pmd-mobile/pmd-h5/plugin-light.git 和 https://github.com/novlan1/plugin-light 两种格式
+ * @param repo 仓库地址
+ * @returns 仓库路径，如 pmd-mobile/pmd-h5/plugin-light
+ */
+export declare function extractRepoPath(repo: string): string;

package/lib/tinypng/index.d.ts

@@ -0,0 +1 @@
+export { compressFileUseTinypng, } from './tinypng';

package/lib/tinypng/tinypng.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/**
+ * 文件输入接口
+ */
+export interface FileInput {
+    /** 文件路径 */
+    path?: string;
+    /** 文件缓冲区 */
+    buffer?: Buffer;
+}
+/**
+ * 使用 TinyPNG 压缩文件
+ * @param file - 输入文件
+ * @returns 压缩后的文件路径或缓冲区
+ * @throws 如果所有 API Key 都失败则抛出错误
+ */
+export declare function compressFileUseTinypng(file: FileInput): Promise<string | Buffer>;

package/lib/white-user/config.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 白名单类型项接口
+ */
+export interface WhiteTypeItem {
+    /** 显示标签 */
+    label: string;
+    /** 类型值 */
+    value: string;
+    /** 文件名 */
+    file?: string;
+    /** CDN 地址 */
+    cdn?: string;
+}
+/**
+ * 白名单 Rainbow 配置接口
+ */
+export interface WhiteRainbowConfig {
+    /** 白名单类型列表 */
+    whiteTypeList?: WhiteTypeItem[];
+    /** 白名单类型映射 */
+    whiteTypeMap: Record<string, WhiteTypeItem>;
+    [key: string]: any;
+}
+/**
+ * 白名单用户状态映射
+ */
+export declare const WHITE_USER_STATUS_MAP: {
+    /** 待处理 */
+    readonly PENDING: 0;
+    /** 成功 */
+    readonly SUCCESS: 1;
+    /** 失败 */
+    readonly FAIL: 2;
+};
+/**
+ * 白名单用户流水线 ID
+ */
+export declare const WHITE_USER_PIPELINE_ID = "p-cd935542953b4057884920da801d9feb";
+/**
+ * 白名单用户 CDN 刷新流水线 ID
+ */
+export declare const WHITE_USER_CDN_REFRESH_PIPELINE_ID = "p-24d52115511f4fb8bacdd95114ff044d";
+/**
+ * 获取白名单 Rainbow 配置
+ * @returns 白名单配置对象
+ */
+export declare function getWhiteRainbowConfig(): Promise<WhiteRainbowConfig>;
+/**
+ * 获取白名单类型描述
+ * @param whiteType - 白名单类型
+ * @returns 白名单类型的显示标签
+ */
+export declare function getWhiteTypeDesc(whiteType: string): Promise<string | undefined>;

package/lib/white-user/cron.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 创建更新白名单用户 COS 的定时任务参数
+ */
+interface CreateUpdateWhiteUserCosCronParams {
+    /** 白名单用户数据库实例 */
+    WhiteUserDB: any;
+    /** 启动流水线函数 */
+    startPipeline: any;
+}
+/**
+ * 创建更新白名单用户 COS 的定时任务
+ * @param params - 定时任务参数
+ */
+export declare function createUpdateWhiteUserCosCron({ WhiteUserDB, startPipeline, }: CreateUpdateWhiteUserCosCronParams): void;
+export {};

package/lib/white-user/index.d.ts

@@ -0,0 +1,3 @@
+export { WHITE_USER_STATUS_MAP, WHITE_USER_CDN_REFRESH_PIPELINE_ID, WHITE_USER_PIPELINE_ID, getWhiteTypeDesc, getWhiteRainbowConfig, type WhiteTypeItem, type WhiteRainbowConfig, } from './config';
+export { updateWhiteUserCosByDb, type UpdateCosByDbOptions, type WhiteUserItem, type FileInfo, } from './update-cos';
+export { createUpdateWhiteUserCosCron, } from './cron';

package/lib/white-user/update-cos.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 白名单用户项接口
+ */
+export interface WhiteUserItem {
+    /** 用户 OpenID */
+    openId: string;
+    /** 白名单类型 */
+    whiteType: string;
+    /** 开始时间戳 */
+    startTime: number;
+    /** 有效时长（秒） */
+    validTime: number;
+    /** 申请者 */
+    applyUser?: string;
+    [key: string]: any;
+}
+/**
+ * 文件信息接口
+ */
+export interface FileInfo {
+    /** 文件名 */
+    fileName: string;
+    /** 文件内容（OpenID 列表） */
+    fileContent: string[];
+    /** 显示标签 */
+    label?: string;
+    /** CDN 地址 */
+    cdn?: string;
+}
+/**
+ * 更新 COS 数据库选项
+ */
+export interface UpdateCosByDbOptions {
+    /** 构建 ID */
+    buildId?: string;
+    /** 是否来自定时任务 */
+    fromCron?: boolean;
+    /** 白名单用户数据库实例 */
+    WhiteUserDB: any;
+    /** 启动流水线函数 */
+    startPipeline: any;
+}
+/**
+ * 根据数据库更新白名单用户 COS 文件
+ * @param options - 更新选项
+ */
+export declare function updateWhiteUserCosByDb(options?: UpdateCosByDbOptions): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plugin-light/shared",
-  "version": "1.0.3",
+  "version": "1.0.14",
   "homepage": "https://novlan1.github.io/docs/plugin-light/zh/plugin-light-shared.html",
   "bugs": {
     "url": "https://github.com/novlan1/plugin-light/issues"
@@ -11,13 +11,35 @@
   },
   "license": "MIT",
   "author": "novlan1",
-  "main": "./lib/index",
+  "exports": {
+    ".": {
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.js"
+    }
+  },
+  "main": "lib/index.js",
+  "module": "lib/index.mjs",
   "files": [
     "lib/"
   ],
   "dependencies": {
+    "axios": "^1.7.0",
+    "croner": "^9.1.0",
+    "imapflow": "^1.0.172",
     "loader-utils": "^2.0.4",
-    "t-comm": "^3.0.22"
+    "mailparser": "^3.7.2",
+    "t-comm": "latest",
+    "tinify": "^1.8.2",
+    "turndown": "^7.2.2",
+    "@plugin-light/const": "^0.1.2"
+  },
+  "devDependencies": {
+    "@types/mailparser": "^3.4.5",
+    "@types/turndown": "^5.0.6"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
     "build": "rm -rf lib && rollup -c",