baja-lite 1.0.36 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "baja-lite",
-  "version": "1.0.36",
+  "version": "1.1.0",
   "description": "some util for self",
   "homepage": "https://github.com/void-soul/util-man",
   "repository": {
@@ -15,8 +15,10 @@
       "types": "./index.d.ts",
       "import": "./index.js"
     },
-    "./boot.js":"./boot.js",
-    "./boot-remote.js":"./boot-remote.js"
+    "./boot.js": "./boot.js",
+    "./boot-remote.js": "./boot-remote.js",
+    "./wx/mini.js": "./wx/mini.js",
+    "./wx/organ.js": "./wx/organ.js"
   },
   "types": "./index.d.ts",
   "bin": {
@@ -34,6 +36,8 @@
   },
   "dependencies": {
     "@msgpack/msgpack": "3.0.0-beta3",
+    "@types/request-promise": "^4.1.51",
+    "axios": "1.7.9",
     "decimal.js": "10.5.0",
     "html-parse-stringify": "3.0.1",
     "iterare": "1.2.1",
@@ -42,6 +46,7 @@
     "pino": "9.6.0",
     "pino-pretty": "13.0.0",
     "reflect-metadata": "0.2.2",
+    "request-promise": "^4.2.6",
     "sql-formatter": "15.4.10",
     "sqlstring": "2.3.3",
     "tslib": "2.8.1"

package/wx/base.d.ts

@@ -0,0 +1,11 @@
+export declare abstract class BaseWx {
+    protected authErrorCodes: number[];
+    protected name: string;
+    protected tokenUrl: string;
+    private tokenData;
+    protected mock: boolean;
+    protected getToken(force?: boolean): Promise<string>;
+    protected fetch(uri: (token: string) => string, method: 'get' | 'post', data: {
+        [key: string]: any;
+    }, needToken?: boolean, buffer?: boolean): Promise<any>;
+}

package/wx/base.js

@@ -0,0 +1,78 @@
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+import * as rp from 'request-promise';
+import { Throw } from '../error.js';
+import pino from 'pino';
+const logger = process.env['NODE_ENV'] !== 'production' ? pino({
+    name: 'wx',
+    transport: {
+        target: 'pino-pretty'
+    }
+}) : pino({ name: 'wx' });
+export class BaseWx {
+    constructor() {
+        this.authErrorCodes = [40001, 40014, 41001, 42001];
+        this.name = '';
+        this.tokenUrl = '';
+        this.tokenData = '';
+        this.mock = false;
+    }
+    async getToken(force) {
+        let token = '';
+        const now = +new Date();
+        let need = force === true;
+        if (this.tokenData) {
+            const datas = this.tokenData.split('^_^');
+            token = datas[0];
+            const lastTime = datas[1];
+            const spliceTime = datas[2];
+            if (now - parseInt(lastTime, 10) - parseInt(spliceTime, 10) > 0) {
+                need = true;
+            }
+        }
+        else {
+            need = true;
+        }
+        if (need === true) {
+            const data = await this.fetch(() => this.tokenUrl, 'get', {}, false);
+            token = data.access_token;
+            this.tokenData = `${token}^_^${now}^_^${data.expires_in * 1000}`;
+        }
+        return token;
+    }
+    async fetch(uri, method, data, needToken = true, buffer = false) {
+        if (this.mock === true) {
+            return {};
+        }
+        let token = needToken ? await this.getToken() : '';
+        if (!needToken || token) {
+            const start = +new Date();
+            let url = uri(token);
+            const param = method === 'get' ? {
+                method,
+                json: buffer ? false : true,
+                qs: data,
+                encoding: buffer ? null : undefined
+            } : {
+                json: data,
+                method,
+                encoding: buffer ? null : undefined
+            };
+            let response = await rp.default({
+                uri: url,
+                ...param
+            });
+            if (this.authErrorCodes.includes(response.errcode)) {
+                token = await this.getToken(true);
+                url = uri(token);
+                response = await rp.default({
+                    uri: url,
+                    ...param
+                });
+                Throw.if(response.errcode && response.errcode - 0 !== 0, `${url}-${response.errcode}-${response.errmsg}`);
+            }
+            Throw.if(response.errcode && response.errcode - 0 !== 0, `${url}-${response.errcode}-${response.errmsg}`);
+            logger.info(`fetch data ${+new Date() - start} ms`);
+            return response;
+        }
+    }
+}

package/wx/mini.d.ts

@@ -0,0 +1,45 @@
+import { BaseWx } from './base';
+import { WxMiniConfig, WxLiveInfo, WxLiveReplay } from './types.js';
+export declare class WxMini extends BaseWx {
+    protected name: string;
+    private config;
+    private templNameCache;
+    private templKeyCache;
+    constructor(config: WxMiniConfig);
+    getUnlimited({ scene, model, page, fullpath, png, width, lineColor }: {
+        scene: string;
+        model?: string;
+        page?: string;
+        fullpath?: string;
+        png?: '0' | '1' | 0 | 1 | true | false | 'true' | 'false';
+        width?: number;
+        lineColor?: {
+            r: number;
+            g: number;
+            b: number;
+        };
+    }): Promise<any>;
+    sendMs({ openids, name, data, scene }: {
+        openids: string[];
+        name: string;
+        data: {
+            [key: string]: string | number;
+        };
+        scene: string;
+    }): Promise<void>;
+    code2session(code: string): Promise<{
+        openid: string;
+        session_key: string;
+        unionid?: string;
+    }>;
+    getTemplIds(): {
+        [key: string]: string[];
+    };
+    decrypt<T>({ sessionKey, encryptedData, iv }: {
+        iv: string;
+        sessionKey: string;
+        encryptedData: string;
+    }): T | undefined;
+    getLiveInfo(start: number, limit: number): Promise<WxLiveInfo[]>;
+    getLiveReplay(room_id: number, start: number, limit: number): Promise<WxLiveReplay[]>;
+}

package/wx/mini.js

@@ -0,0 +1,102 @@
+import { BaseWx } from './base';
+import crypto from 'crypto';
+import { Throw } from '../error.js';
+export class WxMini extends BaseWx {
+    constructor(config) {
+        super();
+        this.name = 'wxMini';
+        this.config = config;
+        this.tokenUrl = `https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=${this.config.appId}&secret=${this.config.appSecret}`;
+        this.templNameCache = {};
+        this.templKeyCache = {};
+        if (this.config.messages) {
+            for (const item of this.config.messages) {
+                if (!this.templNameCache[item.name]) {
+                    this.templNameCache[item.name] = [];
+                }
+                this.templNameCache[item.name].push({
+                    tmplId: item.tmplId,
+                    page: `pages/${item.model}/${item.page}/${item.page}`
+                });
+                for (const key of item.keys) {
+                    if (!this.templKeyCache[key]) {
+                        this.templKeyCache[key] = [];
+                    }
+                    this.templKeyCache[key].push(item.tmplId);
+                }
+            }
+        }
+    }
+    async getUnlimited({ scene, model, page, fullpath, png, width, lineColor }) {
+        Throw.if(!fullpath && (!model || !page), '路径不完整,fullpath或者model+page必须传一个');
+        const pageto = fullpath ?? `pages/${model}/${page}/${page}`;
+        return await this.fetch((token) => `https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=${token}`, 'post', {
+            scene,
+            page: pageto,
+            line_color: lineColor ?? this.config.qrcode?.lineColor,
+            is_hyaline: png === 'true' || png === '1' || png === true || png === 1,
+            width: width ?? this.config.qrcode?.width ?? 500
+        }, true, true);
+    }
+    async sendMs({ openids, name, data, scene }) {
+        const temps = this.templNameCache[name];
+        const dataSend = {};
+        for (const [key, value] of Object.entries(data)) {
+            dataSend[key] = { value: value ?? '' };
+        }
+        if (scene) {
+            scene = `?${scene}`;
+        }
+        else {
+            scene = '';
+        }
+        for (const temp of temps) {
+            for (const touser of openids) {
+                await this.fetch((token) => `https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=${token}`, 'post', {
+                    touser,
+                    data: dataSend,
+                    template_id: temp.tmplId,
+                    page: `${temp.page}${scene}`
+                });
+            }
+        }
+    }
+    async code2session(code) {
+        const data = await this.fetch(() => `https://api.weixin.qq.com/sns/jscode2session?appid=${this.config.appId}&secret=${this.config.appSecret}&js_code=${code}&grant_type=authorization_code`, 'get', {}, false);
+        return {
+            openid: data.openid,
+            session_key: data.session_key,
+            unionid: data.unionid
+        };
+    }
+    getTemplIds() {
+        return this.templKeyCache;
+    }
+    decrypt({ sessionKey, encryptedData, iv }) {
+        Throw.if(!sessionKey, '会话过期，请重新登陆!');
+        const sessionKeyBuf = Buffer.from(sessionKey, 'base64');
+        const encryptedDataBuf = Buffer.from(encryptedData, 'base64');
+        const ivBuf = Buffer.from(iv, 'base64');
+        try {
+            // 解密
+            const decipher = crypto.createDecipheriv('aes-128-cbc', sessionKeyBuf, ivBuf);
+            // 设置自动 padding 为 true，删除填充补位
+            decipher.setAutoPadding(true);
+            const decoded = decipher.update(encryptedDataBuf, undefined, 'utf8') + decipher.final('utf8');
+            const decodedData = JSON.parse(decoded);
+            Throw.if(decodedData.watermark.appid !== this.config.appId, '加密验证失败');
+            return decodedData;
+        }
+        catch (err) {
+            throw new Error('加密验证失败');
+        }
+    }
+    async getLiveInfo(start, limit) {
+        const data = await this.fetch((token) => `https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=${token}`, 'post', { start, limit });
+        return data.room_info;
+    }
+    async getLiveReplay(room_id, start, limit) {
+        const data = await this.fetch((token) => `https://api.weixin.qq.com/wxa/business/getliveinfo?access_token=${token}`, 'post', { room_id, start, limit, action: 'get_replay' });
+        return data.live_replay;
+    }
+}

package/wx/organ.d.ts

@@ -0,0 +1,65 @@
+import { BaseWx } from './base';
+import { WxOrganConfig, WxDepartment, WxOrganUser, WxOrganUserSimply, WxOrganText, WxOrganImage, WxOrganVoice, WxOrganVideo, WxOrganFile, WxOrganTextCard, WxOrganNews, WxOrganMpNews, WxOrganMarkDown, WxOrganTaskCard, WxOrganMini } from './types.js';
+export declare class WxOrgan extends BaseWx {
+    protected name: string;
+    private config;
+    private miniMessCache;
+    private messCache;
+    constructor(config: WxOrganConfig);
+    createDepartment(param: WxDepartment): Promise<number>;
+    updateDepartment(param: WxDepartment): Promise<void>;
+    deleteDepartment(id: number): Promise<void>;
+    getDepartmentList(id?: number): Promise<WxDepartment[]>;
+    createUser(param: WxOrganUser): Promise<string | number>;
+    getUser(userid: number | string): Promise<WxOrganUser>;
+    updateUser(param: WxOrganUser): Promise<void>;
+    deleteUser(userid: number | string): Promise<void>;
+    batchDeleteUser(useridlist: Array<number | string>): Promise<void>;
+    getDeptUserSimply(department_id: number, fetch_child: boolean): Promise<WxOrganUserSimply[]>;
+    getDeptUser(department_id: number, fetch_child: boolean): Promise<WxOrganUser[]>;
+    userid2openid(userid: number | string): Promise<string>;
+    openid2userid(openid: string): Promise<number | string>;
+    authsucc(userid: string): Promise<void>;
+    inviteUsers({ user, party, tag }: {
+        user?: Array<number | string>;
+        party?: number[];
+        tag?: number[];
+    }): Promise<{
+        invaliduser?: Array<number | string>;
+        invalidparty?: number[];
+        invalidtag?: number[];
+    }>;
+    createTag(tagname: string, tagid: number): Promise<number>;
+    updateTag(tagname: string, tagid: number): Promise<void>;
+    deleteTag(tagid: number): Promise<void>;
+    createTagUser(tagid: number, userlist: Array<string | number>): Promise<void>;
+    deleteTagUser(tagid: number, userlist: Array<string | number>): Promise<void>;
+    getTagUser(tagid: number): Promise<{
+        tagname: string;
+        userlist: Array<{
+            userid: string | number;
+            name: string;
+        }>;
+        partylist: number[];
+    }>;
+    getTag(): Promise<Array<{
+        tagid: number;
+        tagname: string;
+    }>>;
+    updateTaskCard(userids: Array<string | number>, task_id: string, clicked_key: string): Promise<void>;
+    sendMiniMs({ touser, toparty, totag, name, scene, ms }: {
+        touser?: Array<number | string>;
+        toparty?: number[];
+        totag?: number[];
+        name: string;
+        scene?: string;
+        ms: WxOrganMini;
+    }): Promise<void>;
+    sendMs({ touser, toparty, totag, name, ms }: {
+        touser?: Array<number | string>;
+        toparty?: number[];
+        totag?: number[];
+        name: string;
+        ms: WxOrganText | WxOrganImage | WxOrganVoice | WxOrganVideo | WxOrganFile | WxOrganTextCard | WxOrganNews | WxOrganMpNews | WxOrganMarkDown | WxOrganTaskCard;
+    }): Promise<void>;
+}

package/wx/organ.js

@@ -0,0 +1,171 @@
+import { BaseWx } from './base';
+export class WxOrgan extends BaseWx {
+    // private aesKey: Buffer | undefined;
+    // private iv: Buffer | undefined;
+    constructor(config) {
+        super();
+        this.name = 'wxOrgan';
+        this.config = config;
+        this.tokenUrl = `https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=${this.config.corpid}&corpsecret=${this.config.corpsecret}`;
+        this.miniMessCache = {};
+        this.messCache = {};
+        // if (this.config.msHook) {
+        //   this.aesKey = Buffer.from(this.config.encodingAESKey + '=', 'base64');
+        //   this.iv = this.aesKey.slice(0, 16);
+        // }
+        if (this.config.miniMessages) {
+            for (const item of this.config.miniMessages) {
+                if (!this.miniMessCache[item.name]) {
+                    this.miniMessCache[item.name] = [];
+                }
+                this.miniMessCache[item.name].push({
+                    appid: this.config.appid,
+                    page: `pages/${item.model}/${item.page}/${item.page}`
+                });
+            }
+        }
+        if (this.config.messages) {
+            for (const item of this.config.messages) {
+                if (!this.messCache[item.name]) {
+                    this.messCache[item.name] = [];
+                }
+                this.messCache[item.name].push({
+                    agentid: this.config.agentid,
+                    ...item
+                });
+            }
+        }
+        this.mock = this.config.mock === true;
+    }
+    async createDepartment(param) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=${token}`, 'post', param);
+        return data.id;
+    }
+    async updateDepartment(param) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/department/update?access_token=${token}`, 'post', param);
+    }
+    async deleteDepartment(id) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/department/delete?access_token=${token}`, 'get', { id });
+    }
+    async getDepartmentList(id) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=${token}`, 'get', { id });
+        return data.department;
+    }
+    async createUser(param) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=${token}`, 'post', param);
+        return data.id;
+    }
+    async getUser(userid) {
+        return await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=${token}`, 'get', { userid });
+    }
+    async updateUser(param) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=${token}`, 'post', param);
+    }
+    async deleteUser(userid) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/delete?access_token=${token}`, 'get', { userid });
+    }
+    async batchDeleteUser(useridlist) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/batchdelete?access_token=${token}`, 'post', { useridlist });
+    }
+    async getDeptUserSimply(department_id, fetch_child) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=${token}`, 'get', { department_id, fetch_child: fetch_child ? 'FETCH_CHILD' : undefined });
+        return data.userlist;
+    }
+    async getDeptUser(department_id, fetch_child) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=${token}`, 'get', { department_id, fetch_child: fetch_child ? 'FETCH_CHILD' : undefined });
+        return data.userlist;
+    }
+    async userid2openid(userid) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_openid?access_token=${token}`, 'post', { userid });
+        return data.openid;
+    }
+    async openid2userid(openid) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_userid?access_token=${token}`, 'post', { openid });
+        return data.userid;
+    }
+    async authsucc(userid) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/user/authsucc?access_token=${token}`, 'get', { userid });
+    }
+    async inviteUsers({ user, party, tag }) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/batch/invite?access_token=${token}`, 'post', { user, party, tag });
+        return {
+            invaliduser: data.invaliduser,
+            invalidparty: data.invalidparty,
+            invalidtag: data.invalidtag
+        };
+    }
+    async createTag(tagname, tagid) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=${token}`, 'post', { tagname, tagid });
+        return data.id;
+    }
+    async updateTag(tagname, tagid) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=${token}`, 'post', { tagname, tagid });
+    }
+    async deleteTag(tagid) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=${token}`, 'get', { tagid });
+    }
+    async createTagUser(tagid, userlist) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=${token}`, 'post', { tagid, userlist });
+    }
+    async deleteTagUser(tagid, userlist) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=${token}`, 'post', { tagid, userlist });
+    }
+    async getTagUser(tagid) {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=${token}`, 'get', { tagid });
+        return data;
+    }
+    async getTag() {
+        const data = await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/tag/list?access_token=${token}`, 'get', {});
+        return data.taglist;
+    }
+    async updateTaskCard(userids, task_id, clicked_key) {
+        await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/message/update_taskcard?access_token=${token}`, 'post', { userids, task_id, clicked_key });
+    }
+    async sendMiniMs({ touser, toparty, totag, name, scene, ms }) {
+        const touser_ = touser ? touser.join('|') : undefined;
+        const toparty_ = toparty ? toparty.join('|') : undefined;
+        const totag_ = totag ? totag.join('|') : undefined;
+        if (scene) {
+            scene = `?${scene}`;
+        }
+        else {
+            scene = '';
+        }
+        if (ms.content_item) {
+            for (const [key, value] of Object.entries(ms.content_item)) {
+                ms.content_item[key] = value ?? '';
+            }
+        }
+        const temps = this.miniMessCache[name];
+        for (const item of temps) {
+            await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=${token}`, 'post', {
+                touser: touser_,
+                toparty: toparty_,
+                totag: totag_,
+                'msgtype': 'miniprogram_notice',
+                miniprogram_notice: {
+                    ...item,
+                    page: `${item.page}${scene}`,
+                    ...ms
+                },
+                enable_id_trans: 0
+            });
+        }
+    }
+    async sendMs({ touser, toparty, totag, name, ms }) {
+        const touser_ = touser ? touser.join('|') : undefined;
+        const toparty_ = toparty ? toparty.join('|') : undefined;
+        const totag_ = totag ? totag.join('|') : undefined;
+        const temps = this.messCache[name];
+        for (const item of temps) {
+            await this.fetch((token) => `https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=${token}`, 'post', {
+                touser: touser_,
+                toparty: toparty_,
+                totag: totag_,
+                ...item,
+                [item.msgtype]: ms,
+                enable_id_trans: 0
+            });
+        }
+    }
+}

package/wx/types.d.ts

@@ -0,0 +1,844 @@
+/**
+ * 企业微信员工
+ */
+export interface WxOrganUser {
+    userid: number;
+    name: string;
+    alias?: string;
+    mobile: string;
+    department: number[];
+    order?: number[];
+    is_leader_in_dept?: Array<0 | 1>;
+    position?: string;
+    gender?: 1 | 0;
+    email?: string;
+    telephone?: string;
+    avatar_mediaid?: string;
+    enable?: 1 | 0;
+    extattr?: {
+        [key: string]: string | number;
+    };
+    to_invite?: boolean;
+    external_profile?: {
+        [key: string]: string | number;
+    };
+    external_position?: string;
+    address?: string;
+}
+export interface WxOrganUserRead extends WxOrganUser {
+    status?: 1 | 2 | 4;
+    avatar?: string;
+    thumb_avatar?: string;
+    qr_code?: string;
+}
+export interface WxOrganUserSimply {
+    userid: number;
+    name: string;
+    department: number[];
+}
+/**
+ *
+ * 企业微信部门
+ * @interface WxDepartment
+ */
+export interface WxDepartment {
+    name: string;
+    parentid: number;
+    order?: number;
+    id: number;
+}
+export interface WxLiveReplay {
+    expire_time: string;
+    create_time: string;
+    media_url: string;
+}
+export interface WxOrgan {
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90205
+     * @param {WxDepartment} param
+     * @returns {Promise<number>}
+     * @memberof WxOrgan
+     */
+    createDepartment(param: WxDepartment): Promise<number>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90206
+     * @param {WxDepartment} param
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    updateDepartment(param: WxDepartment): Promise<void>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90207
+     * @param {number} id
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    deleteDepartment(id: number): Promise<void>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90208
+     * @param {number} [id]
+     * @returns {Promise<WxDepartment[]>}
+     * @memberof WxOrgan
+     */
+    getDepartmentList(id?: number): Promise<WxDepartment[]>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90195
+     * @param {WxOrganUser} param
+     * @returns {Promise<number>}
+     * @memberof WxOrgan
+     */
+    createUser(param: WxOrganUser): Promise<number | string>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90197
+     * @param {WxOrganUser} param
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    updateUser(param: WxOrganUser): Promise<void>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90198
+     * @param {(number | string)} userid
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    deleteUser(userid: number | string): Promise<void>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90199
+     * @param {(Array<number | string>)} useridlist
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    batchDeleteUser(useridlist: Array<number | string>): Promise<void>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90196
+     * @param {(number | string)} userid
+     * @returns {Promise<WxOrganUser>}
+     * @memberof WxOrgan
+     */
+    getUser(userid: number | string): Promise<WxOrganUserRead>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90200
+     * @param {number} department_id
+     * @param {boolean} fetch_child
+     * @returns {Promise<WxOrganUserSimply[]>}
+     * @memberof WxOrgan
+     */
+    getDeptUserSimply(department_id: number, fetch_child: boolean): Promise<WxOrganUserSimply[]>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90201
+     * @param {number} department_id
+     * @param {boolean} fetch_child
+     * @returns {Promise<WxOrganUser[]>}
+     * @memberof WxOrgan
+     */
+    getDeptUser(department_id: number, fetch_child: boolean): Promise<WxOrganUserRead[]>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90975
+     * @param {({user?: Array<number | string>, party?: number[], tag?: number[]})} {user, party, tag}
+     * @returns {(Promise<{invaliduser?: Array<number | string>, invalidparty?: number[], invalidtag?: number[]}>)}
+     * @memberof WxOrgan
+     */
+    inviteUsers({ user, party, tag }: {
+        user?: Array<number | string>;
+        party?: number[];
+        tag?: number[];
+    }): Promise<{
+        invaliduser?: Array<number | string>;
+        invalidparty?: number[];
+        invalidtag?: number[];
+    }>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90202
+     * @param {(number | string)} userid
+     * @returns {Promise<string>}
+     * @memberof WxOrgan
+     */
+    userid2openid(userid: number | string): Promise<string>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90202
+     * @param {string} openid
+     * @returns {(Promise<number | string>)}
+     * @memberof WxOrgan
+     */
+    openid2userid(openid: string): Promise<number | string>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90203
+     * @param {string} userid
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    authsucc(userid: string): Promise<void>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90205
+     * @param {string} tagname
+     * @param {number} tagid
+     * @returns {Promise<number>}
+     * @memberof WxOrgan
+     */
+    createTag(tagname: string, tagid: number): Promise<number>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90211
+     *
+     * @param {string} tagname
+     * @param {number} tagid
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    updateTag(tagname: string, tagid: number): Promise<void>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90212
+     *
+     * @param {number} tagid
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    deleteTag(tagid: number): Promise<void>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90214
+     * @param {number} tagid
+     * @param {(Array<string | number>)} userlist
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    createTagUser(tagid: number, userlist: Array<string | number>): Promise<void>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90215
+     *
+     * @param {number} tagid
+     * @param {(Array<string | number>)} userlist
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    deleteTagUser(tagid: number, userlist: Array<string | number>): Promise<void>;
+    /**
+     *https://work.weixin.qq.com/api/doc#90000/90135/90213
+     *
+     * @param {number} tagid
+     * @returns {(Promise<{tagname: string; userlist: Array<{userid: string | number; name: string}>; partylist: number[]}>)}
+     * @memberof WxOrgan
+     */
+    getTagUser(tagid: number): Promise<{
+        tagname: string;
+        userlist: Array<{
+            userid: string | number;
+            name: string;
+        }>;
+        partylist: number[];
+    }>;
+    /**
+     * https://work.weixin.qq.com/api/doc#90000/90135/90216
+     *
+     * @returns {Promise<Array<{tagid: number; tagname: string}>>}
+     * @memberof WxOrgan
+     */
+    getTag(): Promise<Array<{
+        tagid: number;
+        tagname: string;
+    }>>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/91579
+     * @param {(Array<string | number>)} userids
+     * @param {string} task_id
+     * @param {string} clicked_key
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    updateTaskCard(userids: Array<string | number>, task_id: string, clicked_key: string): Promise<void>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90236/%E5%B0%8F%E7%A8%8B%E5%BA%8F%E9%80%9A%E7%9F%A5%E6%B6%88%E6%81%AF
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    sendMiniMs(param: {
+        touser?: Array<number | string>;
+        toparty?: number[];
+        totag?: number[];
+        name: string;
+        scene?: string;
+        ms: WxOrganMini;
+    }): Promise<void>;
+    /**
+     *
+     * https://work.weixin.qq.com/api/doc#90000/90135/90236
+     * @returns {Promise<void>}
+     * @memberof WxOrgan
+     */
+    sendMs(param: {
+        touser?: Array<number | string>;
+        toparty?: number[];
+        totag?: number[];
+        name: string;
+        ms: WxOrganText | WxOrganImage | WxOrganVoice | WxOrganVideo | WxOrganFile | WxOrganTextCard | WxOrganNews | WxOrganMpNews | WxOrganMarkDown | WxOrganTaskCard;
+    }): Promise<void>;
+}
+export interface WxConfig {
+    corpid: string;
+    appSecret: string;
+}
+export type WxPayType = 'JSAPI' | 'NATIVE' | 'APP' | 'MWEB';
+export interface WxPayOption {
+    /** 小程序id、公众号id、企业微信id */
+    appid: string;
+    /** 商户号 */
+    mch_id: string;
+    /** 商户平台密钥 */
+    appSecret: string;
+    /** 证书名称(文件名+后缀)，需要放在 app/cert 目录中  */
+    cert: string;
+    /** 支付方式：微信内网页环境使用JSAPI,微信外网页环境使用MWEB;用户扫码使用NATIVE  */
+    trade_type: WxPayType;
+}
+export interface WxCreatedorder {
+    device_info?: string;
+    body: string;
+    detail?: string;
+    out_trade_no: string;
+    total_fee: number;
+    spbill_create_ip: string;
+    time_start?: string;
+    time_expire?: string;
+    goods_tag?: string;
+    product_id?: string;
+    limit_pay?: string;
+    openid: string;
+    receipt?: string;
+    scene_info?: {
+        store_info: {
+            id: string;
+            name: string;
+            area_code: string;
+            address: string;
+        };
+    };
+}
+export interface WxPayToUserResponse {
+    payment_no: string;
+    partner_trade_no: string;
+    payment_time: string;
+}
+export interface WxPayToUser {
+    partner_trade_no: string;
+    openid: string;
+    check_name: 'NO_CHECK' | 'FORCE_CHECK';
+    re_user_name?: string;
+    amount: number;
+    desc?: string;
+    spbill_create_ip?: string;
+}
+export interface WxCreateOrderJSAPI {
+    appId: string;
+    timeStamp: string;
+    nonceStr: string;
+    package: string;
+    signType: string;
+    paySign: string;
+}
+export interface WxCreateOrderAPP {
+    appid: string;
+    partnerid: string;
+    prepayid: string;
+    package: string;
+    noncestr: string;
+    timestamp: string;
+    sign: string;
+}
+/** 微信支付预创建订单返回结果 */
+export interface WxCreateOrderResult {
+    /** jsapi支付方式 */
+    jsapi?: WxCreateOrderJSAPI;
+    /** app支付方式 */
+    app?: WxCreateOrderAPP;
+    prepay_id: string;
+    code_url?: string;
+    mweb_url?: string;
+    dataCacheId?: string;
+    devCacheId?: string;
+} /** 微信退款返回结果 */
+export interface WxRefResult {
+    dataCacheId?: string;
+    devCacheId?: string;
+}
+export interface WxOrderQuery {
+    transaction_id?: string;
+    out_trade_no?: string;
+}
+export interface WxOrder {
+    device_info?: string;
+    openid: string;
+    is_subscribe: 'Y' | 'N';
+    trade_type: WxPayType;
+    trade_state: 'SUCCESS' | 'REFUND' | 'NOTPAY' | 'CLOSED' | 'REVOKED' | 'USERPAYING' | 'PAYERROR';
+    bank_type: string;
+    total_fee: number;
+    settlement_total_fee?: number;
+    fee_type?: string;
+    cash_fee: number;
+    cash_fee_type?: string;
+    coupon_fee?: number;
+    coupon_count?: number;
+    transaction_id: string;
+    out_trade_no: string;
+    attach?: string;
+    time_end: string;
+    trade_state_desc: string;
+    children?: Array<{
+        coupon_type: string;
+        coupon_id: string;
+        coupon_fee: number;
+    }>;
+}
+export interface WxCreateRefundOrder {
+    transaction_id?: string;
+    out_trade_no?: string;
+    out_refund_no: string;
+    total_fee: number;
+    refund_fee: number;
+    refund_desc: string;
+    refund_account?: 'REFUND_SOURCE_UNSETTLED_FUNDS' | 'REFUND_SOURCE_RECHARGE_FUNDS';
+}
+export interface WxRefundOrderQuery {
+    transaction_id?: string;
+    out_trade_no?: string;
+    out_refund_no?: string;
+    refund_id?: string;
+    offset?: number;
+}
+export interface WxRefundOrder {
+    total_refund_count?: number;
+    transaction_id: string;
+    out_trade_no: string;
+    total_fee: number;
+    settlement_total_fee?: number;
+    fee_type?: string;
+    cash_fee: number;
+    refund_count: number;
+    children?: Array<{
+        out_refund_no: string;
+        refund_id: string;
+        refund_channel?: 'ORIGINAL' | 'BALANCE' | 'OTHER_BALANCE' | 'OTHER_BANKCARD';
+        refund_fee: number;
+        settlement_refund_fee?: number;
+        coupon_refund_fee?: number;
+        coupon_refund_count?: number;
+        refund_status: 'SUCCESS' | 'REFUNDCLOSE' | 'PROCESSING' | 'CHANGE';
+        refund_account?: 'REFUND_SOURCE_RECHARGE_FUNDS' | 'REFUND_SOURCE_UNSETTLED_FUNDS';
+        refund_recv_accout: string;
+        refund_success_time?: string;
+        children?: Array<{
+            coupon_type: string;
+            coupon_refund_id: string;
+            coupon_refund_fee: number;
+        }>;
+    }>;
+}
+export interface WxPayHook {
+    device_info?: string;
+    openid: string;
+    is_subscribe: 'Y' | 'N';
+    bank_type: string;
+    total_fee: number;
+    settlement_total_fee?: number;
+    fee_type?: string;
+    cash_fee: number;
+    cash_fee_type?: string;
+    coupon_fee?: string;
+    coupon_count?: number;
+    children?: Array<{
+        coupon_type: string;
+        coupon_id: string;
+        coupon_fee: number;
+    }>;
+    transaction_id: string;
+    out_trade_no: string;
+    attach?: string;
+    time_end: string;
+}
+export interface WxRefHook {
+    transaction_id: string;
+    out_trade_no: string;
+    refund_id: string;
+    out_refund_no: string;
+    total_fee: number;
+    settlement_total_fee?: number;
+    refund_fee: number;
+    settlement_refund_fee: string;
+    refund_status: 'SUCCESS' | 'CHANGE' | 'REFUNDCLOSE';
+    success_time?: string;
+    refund_recv_accout: string;
+    refund_account: 'REFUND_SOURCE_RECHARGE_FUNDS' | 'REFUND_SOURCE_UNSETTLED_FUNDS';
+    refund_request_source: 'API' | 'VENDOR_PLATFORM';
+}
+export interface WxPay {
+    /**
+   * 企业付款到零钱
+   * https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=14_2
+   *
+   * option中的amount单位是元
+   * 处理失败时返回异常
+   * @memberof WxPay
+   */
+    transfers(option: WxPayToUser): Promise<WxPayToUserResponse>;
+    /**
+     * 统一下单接口参数定义
+     * https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1
+     * 其中未定义到此处的参数，说明框架会给出默认值
+     *
+     * 会将dataCache存放到redis中
+     * 在支付回调中将dataCache取出传回业务方法
+     *
+     * 每一个支付应用都有自己的：支付成功、支付失败、退款成功、退款失败回调
+     * 所以如果有不同的业务，最好将这些业务都分层不同的支付应用
+     * 每个应用实现独立的同步消息通知（sub-async）
+     *
+     * devid 是当前支付发起的用户token
+     * 在支付回调时，由于请求是由微信服务器发起的,因此上下文中不存在 用户对象
+     * 通过这个参数可以将 当前支付发起时用户 追加到回调的上下文中
+     * @memberof WxPay
+     */
+    unifiedorder(wxOrderOption: WxCreatedorder, dataCache?: {
+        [key: string]: any;
+    }, devid?: string): Promise<WxCreateOrderResult>;
+    /**
+     *
+     * https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2
+     * @param {WxOrderQuery} option
+     * @returns {Promise<WxOrder>}
+     * @memberof WxPay
+     */
+    orderquery(option: WxOrderQuery): Promise<WxOrder>;
+    /**
+     *
+     * https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_3
+     * @param {string} out_trade_no
+     * @returns {Promise<void>}
+     * @memberof WxPay
+     */
+    closeorder(out_trade_no: string): Promise<void>;
+    /**
+     * 取消订单
+     * 用于用户取消支付导致的取消订单场景
+     * 此方法会清除调起支付时缓存的dataCache
+     * 同时会向微信提交关闭订单的申请
+     * @param {string} out_trade_no
+     * @returns {Promise<void>}
+     * @memberof WxPay
+     */
+    cancelorder(out_trade_no: string): Promise<void>;
+    /**
+     *
+     * https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
+     *
+     * 会将dataCache存放到redis中
+     * 在回调中将dataCache取出传回业务方法
+     *
+     * devid 是当前退款发起的用户token
+     * 在退款回调时，由于请求是由微信服务器发起的,因此上下文中不存在 用户对象
+     * 通过这个参数可以将 当前退款发起时用户 追加到回调的上下文中
+     *
+     * @param {WxCreateRefundOrder} option
+     * @returns {Promise<void>}
+     * @memberof WxPay
+     */
+    refund(option: WxCreateRefundOrder, dataCache?: {
+        [key: string]: any;
+    }, devid?: string): Promise<WxRefResult>;
+    /**
+     *
+     * https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5
+     * @param {WxRefundOrderQuery} option
+     * @returns {Promise<void>}
+     * @memberof WxPay
+     */
+    refundquery(option: WxRefundOrderQuery): Promise<WxRefundOrder>;
+    /**
+     * 修改支付、退款时缓存的业务对象
+     * @param dataCache
+     * @param dataCacheId
+     */
+    resetDataCache(dataCache: {
+        [key: string]: any;
+    }, dataCacheId: string): Promise<void>;
+    /**
+     * 修改支付、退款时缓存的会话id
+     * @param devid
+     * @param devCacheId
+     */
+    resetDevIdCache(devid: string, devCacheId: string): Promise<void>;
+}
+export interface WxMiniConfig {
+    appId: string;
+    appSecret: string;
+    /** 小程序二维码设置 */
+    qrcode?: {
+        /** 线条颜色 */
+        lineColor?: {
+            r: number;
+            g: number;
+            b: number;
+        };
+        /** 宽度 */
+        width?: number;
+    };
+    /**
+     *
+     * 微信订阅消息场景
+     * 当传递此参数后,会自动创建路由
+     *
+     * keys 表示场景,在前端申请订阅场景权限时使用,同一个key将一次性申请订阅权限
+     *      每一个模板可以在不同的场景中被申请
+     * model=页面所在分包名
+     * page=页面名称
+     * name=模板消息标识符,调用this.app.wxSendMs时使用,同一个name将同时发出
+     * tmplId=模板id
+     *
+     * /wx-mini-ms-id.json 得到所有模板消息id数组
+     * 返回 {key: [模板id数组]}
+     */
+    messages?: Array<{
+        keys: string[];
+        name: string;
+        tmplId: string;
+        model: string;
+        page: string;
+    }>;
+}
+export interface WxMini {
+    /**
+     *
+     * 路径传递： model+page 或者 fullpath
+     * @param {{scene: string, model?: string, page?: string, fullpath?: string, png?: boolean, width?: number, lineColor?: {r: number; g: number; b: number}}} param
+     * @returns {Promise<Buffer>}
+     * @memberof WxMini
+     */
+    getUnlimited(param: {
+        scene: string;
+        model?: string;
+        page?: string;
+        fullpath?: string;
+        png?: boolean;
+        width?: number;
+        lineColor?: {
+            r: number;
+            g: number;
+            b: number;
+        };
+    }): Promise<Buffer>;
+    /** https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html */
+    sendMs(param: {
+        openids: string[];
+        name: string;
+        data: {
+            [key: string]: string | number;
+        };
+        scene: string;
+    }): Promise<void>;
+    /** https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/login/auth.code2Session.html */
+    code2session(code: string): Promise<{
+        openid: string;
+        session_key: string;
+        unionid?: string;
+    }>;
+    /** 获取提前配置好的订阅消息id */
+    getTemplIds(): {
+        [key: string]: string[];
+    };
+    /** https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95 */
+    decrypt<T>({ sessionKey, encryptedData, iv }: {
+        iv: string;
+        sessionKey: string;
+        encryptedData: string;
+    }): T | undefined;
+    /** https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/live-player-plugin.html */
+    getLiveInfo(start: number, limit: number): Promise<WxLiveInfo[]>;
+    /** https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/live-player-plugin.html */
+    getLiveReplay(room_id: number, start: number, limit: number): Promise<WxLiveReplay[]>;
+}
+export interface WxOrganConfig {
+    /**
+     *
+     * 应用自定义编码
+     * 用于消息回调的url拼接
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    appCode?: string;
+    /**
+     *
+     * 企业编号 或者 suiteid
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    corpid: string;
+    /**
+     *
+     * 应用密钥
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    corpsecret: string;
+    /**
+     *
+     * 当应用是小程序应用,并需要发送小程序消息时,需要指定appid
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    appid?: string;
+    /**
+     *
+     * 当应用是自建应用,且需要发送应用消息时,需要指定应用id
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    agentid?: number;
+    /**
+     *
+     * 是否开启消息回调?
+     * 当开启时，必须指定token\encodingAesKey
+     * 访问地址: /wx-organ/appCode.json
+     * @type {boolean}
+     * @memberof WxOrganConfig
+     */
+    msHook?: boolean;
+    /**
+     *
+     * 消息回调解密token
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    token?: string;
+    /**
+     *
+     * 消息回调解密 key
+     * @type {string}
+     * @memberof WxOrganConfig
+     */
+    encodingAESKey?: string;
+    /**
+     *
+     * 小程序消息模板
+     * 发送时只要指定name即可
+     * 一个name可以有多个消息
+     * @memberof WxOrganConfig
+     */
+    miniMessages?: Array<{
+        name: string;
+        model: string;
+        page: string;
+    }>;
+    /**
+     *
+     * 非小程序消息模板
+     * 发送时只要指定name即可
+     * 一个name可以有多个消息
+     * https://work.weixin.qq.com/api/doc#90000/90135/90236
+     * @memberof WxOrganConfig
+     */
+    messages?: Array<{
+        name: string;
+        msgtype: 'text' | 'image' | 'voice' | 'video' | 'file' | 'textcard' | 'news' | 'mpnews' | 'markdown' | 'taskcard';
+        safe?: 0 | 1;
+    }>;
+    /**
+     *
+     * 接口模拟调用?
+     * 默认false
+     * @type {boolean}
+     * @memberof WxOrganConfig
+     */
+    mock?: boolean;
+}
+export interface WxOrganMini {
+    title: string;
+    description?: string;
+    content_item?: {
+        [key: string]: string;
+    };
+    emphasis_first_item?: boolean;
+}
+export interface WxOrganText {
+    content: string;
+}
+export interface WxOrganImage {
+    media_id: string;
+}
+export interface WxOrganVoice {
+    media_id: string;
+}
+export interface WxOrganVideo {
+    media_id: string;
+    title?: string;
+    description?: string;
+}
+export interface WxOrganFile {
+    media_id: string;
+}
+export interface WxOrganTextCard {
+    url: string;
+    title: string;
+    description: string;
+    btntxt?: string;
+}
+export interface WxOrganNews {
+    articles: Array<{
+        title: string;
+        description?: string;
+        url: string;
+        picurl?: string;
+    }>;
+}
+export interface WxOrganMpNews {
+    articles: Array<{
+        title: string;
+        thumb_media_id: string;
+        author?: string;
+        content_source_url?: string;
+        content: string;
+        digest?: string;
+    }>;
+}
+export interface WxOrganMarkDown {
+    content: string;
+}
+export interface WxOrganTaskCard {
+    title: string;
+    description: string;
+    url?: string;
+    task_id: string;
+    btn: Array<{
+        key: string;
+        name: string;
+        replace_name?: string;
+        color?: 'red' | 'blue';
+        is_bold?: boolean;
+    }>;
+}
+export interface WxLiveInfo {
+    name: string;
+    roomid: number;
+    cover_img: string;
+    live_satus: number;
+    start_time: number;
+    end_time: number;
+    anchor_name: string;
+    anchor_img: string;
+    goods: Array<{
+        cover_img: string;
+        url: string;
+        price: number;
+        name: string;
+    }>;
+}

package/wx/types.js

@@ -0,0 +1 @@
+export {};