node-easywechat 2.10.2 → 3.0.0-beta.1

package/dist/Types/global.d.ts

@@ -0,0 +1,322 @@
+import { AxiosRequestConfig } from 'axios';
+import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
+import OfficialAccountApplicationInterface from '../OfficialAccount/Contracts/ApplicationInterface';
+import Message from '../Core/Message';
+import HttpClientResponseInterface from '../Core/HttpClient/Contracts/HttpClientResponseInterface';
+
+declare module 'axios' {
+  export interface AxiosRequestConfig {
+    /**
+     * 要发送的xml数据，会自动解析并赋值到data属性，同时设置content-type=text/xml
+     */
+    xml?: string | Record<string, any>;
+    /**
+     * 要发送的json数据，会自动解析并赋值到data属性，同时设置content-type=application/json
+     */
+    json?: string | Record<string, any>;
+  }
+}
+
+/**
+ * 微信接口响应数据格式
+ */
+export declare interface WeixinResponse extends Record<string, any> {
+  /**
+   * 错误代码
+   */
+  errcode?: string,
+
+  /**
+   * 错误信息
+   */
+  errmsg?: string,
+}
+
+/**
+ * 公众号网页授权相关配置
+ */
+export declare interface OauthConfig {
+  /**
+   * 网页授权权限，可选值：snsapi_userinfo、snsapi_base
+   */
+  scope: string;
+
+  /**
+   * 网页授权回调地址，完整URL
+   */
+  redirect_url: string;
+}
+
+/**
+ * 文件缓存相关配置
+ */
+export declare interface CacheFileConfig {
+  /**
+   * 缓存文件保存路径，默认：./
+   */
+  path: string,
+  /**
+   * 缓存文件所在目录权限，默认：0o777
+   */
+  dirMode: string | number,
+  /**
+   * 缓存文件的权限，默认：0o666
+   */
+  fileMode: string | number,
+  /**
+   * 缓存文件的后缀，“.”号开头，默认：.cache
+   */
+  ext: string
+}
+
+/**
+ * 基础配置
+ */
+export declare interface BaseConfig {
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 公众号配置
+ */
+export declare interface OfficialAccountConfig extends BaseConfig {
+  /**
+   * 公众号 app_id
+   */
+  app_id?: string;
+
+  /**
+   * 公众号 secret
+   */
+  secret?: string;
+
+  /**
+   * 服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+
+  /**
+   * 网页授权相关配置
+   */
+  oauth?: OauthConfig;
+}
+
+/**
+ * 小程序配置
+ */
+export declare interface MiniAppConfig extends BaseConfig {
+  /**
+   * 小程序 app_id
+   */
+  app_id?: string;
+
+  /**
+   * 小程序 secret
+   */
+  secret?: string;
+
+  /**
+   * 服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+}
+
+/**
+ * 微信支付配置
+ */
+export declare interface PayConfig extends BaseConfig {
+  /**
+   * 商户号
+   */
+  mch_id?: string;
+
+  /**
+   * pfx 证书路径（敏感接口（如退款、发送红包等）需要）
+   */
+  certificate?: string;
+
+  /**
+   * v3 API密钥
+   */
+  secret_key?: string;
+
+  /**
+   * v2 API密钥
+   */
+  v2_secret_key?: string;
+}
+
+/**
+ * 开发平台配置
+ */
+export declare interface OpenPlatformConfig extends BaseConfig {
+  /**
+   * 开发平台 app_id
+   */
+  app_id?: string;
+
+  /**
+   * 开发平台 secret
+   */
+  secret?: string;
+
+  /**
+   * 开发平台服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 开发平台服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+}
+
+/**
+ * 企业微信配置
+ */
+export declare interface WorkConfig extends BaseConfig {
+  /**
+   * 企业微信 corp_id
+   */
+  corp_id?: string;
+
+  /**
+   * 企业微信 secret
+   */
+  secret?: string;
+
+  /**
+   * 企业微信服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 企业微信服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+}
+
+/**
+ * 企业微信开放平台配置
+ */
+export declare interface OpenWorkConfig extends BaseConfig {
+  /**
+   * 企业微信 corp_id
+   */
+  corp_id?: string;
+
+  /**
+   * 企业微信 secret
+   */
+  secret?: string;
+
+  /**
+   * 企业微信服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 企业微信服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+}
+
+/**
+ * 公众号OAuth工厂方法
+ * @param app 公众号应用实例
+ * @returns OAuth服务供应商实例
+ */
+export declare type OfficialAccountOAuthFactory = (app: OfficialAccountApplicationInterface) => ProviderInterface;
+
+/**
+ * 服务端通知处理项
+ */
+export declare interface ServerHandlerItem {
+  hash: string;
+  handler: ServerHandlerClosure;
+};
+
+/**
+ * 服务端普通消息类型
+ */
+export declare type ServerMessageType = 'text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location';
+
+/**
+ * 服务端事件消息类型
+ */
+export declare type ServerEventType = 'subscribe' | 'unsubscribe' | 'SCAN' | 'LOCATION' | 'CLICK' | 'VIEW';
+
+/**
+ * 服务端消息处理器
+ * @param message 微信信息
+ * @param next 下一个消息处理器
+ */
+export declare type ServerHandlerClosure = (message: Message, next?: ServerHandlerClosure) => any;
+
+/**
+ * HttpClient错误判定回调
+ * @param response 响应对象
+ */
+export declare type HttpClientFailureJudgeClosure = (response: HttpClientResponseInterface) => boolean;
+
+/**
+ * Payment通知错误处理
+ * @param error 错误信息
+ */
+export declare type PaymentFailHandler = (error: string) => void;
+
+/**
+ * Payment业务错误处理
+ * @param error 错误信息
+ */
+export declare type PaymentAlertHandler = (error: string) => void;
+
+/**
+ * Payment支付结果处理回调函数
+ * @param message 微信通知信息
+ * @param fail 通知错误处理函数
+ */
+export declare type PaymentPaidHandler = (message: Message, fail: PaymentFailHandler) => void;
+
+/**
+ * Payment退款结果处理回调函数
+ * @param message 微信通知信息
+ * @param reqInfo 微信通知信息中 req_info 解密后的信息
+ * @param fail 通知错误处理函数
+ */
+export declare type PaymentRefundedHandler = (message: Message, reqInfo: object, fail: PaymentFailHandler) => void;
+
+/**
+ * Payment扫码支付结果处理回调函数
+ * @param message 微信通知信息
+ * @param fail 通知错误处理函数
+ * @param alert 业务错误处理函数
+ */
+export declare type PaymentScannedHandler = (message: Message, fail: PaymentFailHandler, alert: PaymentAlertHandler) => void;
+
+/**
+ * 日志处理方法
+ * @param type before：请求前，after：请求后
+ * @param options 请求选项
+ * @param usedTime 请求耗时，单位ms，仅在 type 为 after 时返回
+ * @param response 响应对象，仅在 type 为 after 时返回
+ */
+export declare type LogHandler = (type: 'before' | 'after', options: AxiosRequestConfig, usedTime?: number, response?: AxiosResponse) => void | Promise<void>;

package/dist/index.d.ts

@@ -1,119 +1,6 @@
+import { OfficialAccountConfig, MiniAppConfig, LogHandler } from './Types/global';
 import OfficialAccount from './OfficialAccount/Application';
-import BaseService from './BaseService/Application';
-import MiniProgram from './MiniProgram/Application';
-import OpenPlatform from './OpenPlatform/Application';
-import OpenWork from './OpenWork/Application';
-import Payment from './Payment/Application';
-import Work from './Work/Application';
-import MicroMerchant from './MicroMerchant/Application';
+import MiniApp from './MiniApp/Application';
 import CacheInterface from './Core/Contracts/CacheInterface';
-import FinallResult from './Core/Decorators/FinallResult';
-import TerminateResult from './Core/Decorators/TerminateResult';
-import Request from './Core/Http/Request';
-import Response from './Core/Http/Response';
-import StreamResponse from './Core/Http/StreamResponse';
-import * as Messages from './Core/Messages';
-import { EasyWechatConfig } from './Core/Types';
-/**
- * 通用获取实例方法
- * @param service 服务名称，可选值：'BaseService' | 'OfficialAccount' | 'MiniProgram' | 'OpenPlatform' | 'OpenWork' | 'Payment' | 'Work'
- * @param config 对应的配置参数
- */
-declare function getInstance(service: 'OfficialAccount', config?: EasyWechatConfig): OfficialAccount;
-declare function getInstance(service: 'BaseService', config?: EasyWechatConfig): BaseService;
-declare function getInstance(service: 'MiniProgram', config?: EasyWechatConfig): MiniProgram;
-declare function getInstance(service: 'OpenPlatform', config?: EasyWechatConfig): OpenPlatform;
-declare function getInstance(service: 'OpenWork', config?: EasyWechatConfig): OpenWork;
-declare function getInstance(service: 'Payment', config?: EasyWechatConfig): Payment;
-declare function getInstance(service: 'Work', config?: EasyWechatConfig): Work;
-declare function getInstance(service: 'MicroMerchant', config?: EasyWechatConfig): MicroMerchant;
-declare class EasyWechat {
-    /**
-     * 实例工厂
-     */
-    Factory: {
-        /**
-         * 公众号类
-         */
-        OfficialAccount: typeof OfficialAccount;
-        /**
-         * 基础类
-         */
-        BaseService: typeof BaseService;
-        /**
-         * 小程序类
-         */
-        MiniProgram: typeof MiniProgram;
-        /**
-         * 开放平台类
-         */
-        OpenPlatform: typeof OpenPlatform;
-        /**
-         * 企业微信开放平台类
-         */
-        OpenWork: typeof OpenWork;
-        /**
-         * 支付类
-         */
-        Payment: typeof Payment;
-        /**
-         * 企业微信类
-         */
-        Work: typeof Work;
-        /**
-         * 小微商户类
-         */
-        MicroMerchant: typeof MicroMerchant;
-        /**
-         * 通用获取实例方法
-         * @param service 服务名称，可选值：'BaseService' | 'OfficialAccount' | 'MiniProgram' | 'OpenPlatform' | 'OpenWork' | 'Payment' | 'Work'
-         * @param config 对应的配置参数
-         */
-        getInstance: typeof getInstance;
-    };
-    /**
-     * 自定义缓存接口
-     */
-    CacheInterface: typeof CacheInterface;
-    /**
-     * 修饰对象，用于服务端事件处理
-     */
-    Decorator: {
-        FinallResult: typeof FinallResult;
-        TerminateResult: typeof TerminateResult;
-    };
-    /**
-     * 网络相关对象
-     */
-    Http: {
-        /**
-         * 请求对象
-         */
-        Request: typeof Request;
-        /**
-         * 响应对象
-         */
-        Response: typeof Response;
-        /**
-         * 响应对象（Stream）
-         */
-        StreamResponse: typeof StreamResponse;
-    };
-    /**
-     * @deprecated 即将作废，请使用 Messages 代替
-     */
-    Message: typeof Messages;
-    /**
-     * 消息类型
-     */
-    Messages: typeof Messages;
-    constructor();
-    /**
-     * 声明配置项
-     * @param config
-     * @returns
-     */
-    defineConfig: (config: EasyWechatConfig) => EasyWechatConfig;
-}
-declare const _default: EasyWechat;
-export = _default;
+import ServerRequest from './Core/Http/ServerRequest';
+export { OfficialAccount, OfficialAccountConfig, MiniApp, MiniAppConfig, CacheInterface, ServerRequest, LogHandler, };

package/dist/index.js

@@ -1,90 +1,14 @@
-'use strict';
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+"use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-const Utils_1 = require("./Core/Utils");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerRequest = exports.CacheInterface = exports.MiniApp = exports.OfficialAccount = void 0;
 const Application_1 = __importDefault(require("./OfficialAccount/Application"));
-const Application_2 = __importDefault(require("./BaseService/Application"));
-const Application_3 = __importDefault(require("./MiniProgram/Application"));
-const Application_4 = __importDefault(require("./OpenPlatform/Application"));
-const Application_5 = __importDefault(require("./OpenWork/Application"));
-const Application_6 = __importDefault(require("./Payment/Application"));
-const Application_7 = __importDefault(require("./Work/Application"));
-const Application_8 = __importDefault(require("./MicroMerchant/Application"));
+exports.OfficialAccount = Application_1.default;
+const Application_2 = __importDefault(require("./MiniApp/Application"));
+exports.MiniApp = Application_2.default;
 const CacheInterface_1 = __importDefault(require("./Core/Contracts/CacheInterface"));
-const FinallResult_1 = __importDefault(require("./Core/Decorators/FinallResult"));
-const TerminateResult_1 = __importDefault(require("./Core/Decorators/TerminateResult"));
-const Request_1 = __importDefault(require("./Core/Http/Request"));
-const Response_1 = __importDefault(require("./Core/Http/Response"));
-const StreamResponse_1 = __importDefault(require("./Core/Http/StreamResponse"));
-const Messages = __importStar(require("./Core/Messages"));
-function getInstance(service, config) {
-    try {
-        let s = (0, Utils_1.strStudly)(service);
-        let applicationClass = this[s];
-        return new applicationClass(config);
-    }
-    catch (e) {
-        console.log(e);
-    }
-}
-;
-class EasyWechat {
-    constructor() {
-        /**
-         * 声明配置项
-         * @param config
-         * @returns
-         */
-        this.defineConfig = function (config) {
-            return config;
-        };
-        this.Factory = {
-            OfficialAccount: Application_1.default,
-            BaseService: Application_2.default,
-            MiniProgram: Application_3.default,
-            OpenPlatform: Application_4.default,
-            OpenWork: Application_5.default,
-            Payment: Application_6.default,
-            Work: Application_7.default,
-            MicroMerchant: Application_8.default,
-            getInstance: getInstance,
-        };
-        this.CacheInterface = CacheInterface_1.default;
-        this.Decorator = {
-            FinallResult: FinallResult_1.default,
-            TerminateResult: TerminateResult_1.default,
-        };
-        this.Http = {
-            Request: Request_1.default,
-            Response: Response_1.default,
-            StreamResponse: StreamResponse_1.default,
-        };
-        this.Messages = Messages;
-    }
-}
-;
-module.exports = new EasyWechat;
+exports.CacheInterface = CacheInterface_1.default;
+const ServerRequest_1 = __importDefault(require("./Core/Http/ServerRequest"));
+exports.ServerRequest = ServerRequest_1.default;

package/mini_app.access_token.mock-access_token-appid.cache

@@ -0,0 +1 @@
+{"data":"mock-access_token","lifeTime":1655744193}

package/official_account.access_token.mock-access_token-appid.cache

@@ -0,0 +1 @@
+{"data":"mock-access_token","lifeTime":1655744193}

package/official_account.jsapi_ticket.mock-ticket-appid.cache

@@ -0,0 +1 @@
+{"data":"mock-ticket","lifeTime":1655749893}

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "node-easywechat",
-  "version": "2.10.2",
+  "version": "3.0.0-beta.1",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
     "release": "npx package-release",
-    "build": "rm -rf dist && npx tsc",
-    "dev": "npx tsc -w",
-    "test": "npx mocha ./test/**/*.js"
+    "build": "rm -rf dist && npx tsc && cp -r src/Types dist/",
+    "test": "npx mocha ./test/ --recursive --extension .test.js"
   },
   "repository": {
     "type": "git",
@@ -21,15 +20,16 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^17.0.23",
+    "axios-mock-adapter": "^1.20.0",
     "mocha": "^9.2.2",
     "package-release": "^1.0.2",
-    "sinon": "^12.0.1",
     "typescript": "^4.6.3"
   },
   "dependencies": {
     "axios": "^0.26.1",
     "form-data": "^4.0.0",
-    "node-socialite": "^1.2.6",
+    "merge": "^2.1.1",
+    "node-socialite": "^1.2.5",
     "qs": "^6.10.3",
     "raw-body": "^2.5.1",
     "xml2js": "^0.4.23"

package/dist/BaseService/Application.d.ts

@@ -1,17 +0,0 @@
-import BaseApplication from '../Core/BaseApplication';
-import JssdkClient from './Jssdk/JssdkClient';
-import MediaClient from './Media/MediaClient';
-import QrcodeClient from './Qrcode/QrcodeClient';
-import UrlClient from './Url/UrlClient';
-import ContentSecurityClient from './ContentSecurity/ContentSecurityClient';
-import { EasyWechatConfig } from '../Core/Types';
-export default class BaseService extends BaseApplication {
-    protected defaultConfig: EasyWechatConfig;
-    jssdk: JssdkClient;
-    media: MediaClient;
-    qrcode: QrcodeClient;
-    url: UrlClient;
-    content_security: ContentSecurityClient;
-    constructor(config?: EasyWechatConfig, prepends?: Object, id?: String);
-    registerProviders(): void;
-}

package/dist/BaseService/Application.js

@@ -1,41 +0,0 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseApplication_1 = __importDefault(require("../Core/BaseApplication"));
-const JssdkClient_1 = __importDefault(require("./Jssdk/JssdkClient"));
-const MediaClient_1 = __importDefault(require("./Media/MediaClient"));
-const QrcodeClient_1 = __importDefault(require("./Qrcode/QrcodeClient"));
-const UrlClient_1 = __importDefault(require("./Url/UrlClient"));
-const ContentSecurityClient_1 = __importDefault(require("./ContentSecurity/ContentSecurityClient"));
-class BaseService extends BaseApplication_1.default {
-    constructor(config = null, prepends = {}, id = null) {
-        super(config, prepends, id);
-        this.defaultConfig = {
-            app_id: '',
-            secret: '',
-        };
-        this.registerProviders();
-    }
-    registerProviders() {
-        super.registerCommonProviders();
-        this.offsetSet('jssdk', function (app) {
-            return new JssdkClient_1.default(app);
-        });
-        this.offsetSet('media', function (app) {
-            return new MediaClient_1.default(app);
-        });
-        this.offsetSet('qrcode', function (app) {
-            return new QrcodeClient_1.default(app);
-        });
-        this.offsetSet('url', function (app) {
-            return new UrlClient_1.default(app);
-        });
-        this.offsetSet('content_security', function (app) {
-            return new ContentSecurityClient_1.default(app);
-        });
-    }
-}
-exports.default = BaseService;
-;

package/dist/BaseService/ContentSecurity/ContentSecurityClient.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import BaseClient from '../../Core/BaseClient';
-import Stream from 'stream';
-export default class ContentSecurityClient extends BaseClient {
-    protected baseUrl: string;
-    /**
-     * 校验一段文本是否含有违法内容
-     * @param text 待校验文本
-     */
-    checkText(text: string): Promise<any>;
-    /**
-     * 校验一张图片是否含有敏感信息
-     * @param file 文件路径或可读stream
-     */
-    checkImage(file: string | Stream.Readable): Promise<any>;
-}