node-easywechat 2.10.1 → 3.0.0-alpha.2

package/dist/OfficialAccount/JsApiTicket.js

@@ -0,0 +1,76 @@
+'use strict';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Utils_1 = require("../Core/Support/Utils");
+const AccessToken_1 = __importDefault(require("./AccessToken"));
+class JsApiTicket extends AccessToken_1.default {
+    /**
+     * 获取jsapi_ticket的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `official_account.jsapi_ticket.${this.appId}`;
+        }
+        return this.key;
+    }
+    /**
+     * 获取签名凭证jsapi_ticket
+     * @returns
+     */
+    getTicket() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let key = this.getKey();
+            let ticket = yield this.cache.get(key);
+            if (!!ticket && typeof ticket === 'string') {
+                return ticket;
+            }
+            let response = yield (yield this.httpClient.request('get', '/cgi-bin/ticket/getticket', {
+                params: {
+                    type: 'jsapi',
+                }
+            })).toObject(false);
+            if (!response['ticket']) {
+                throw new Error('Failed to get jssdk_ticket: ' + JSON.stringify(response));
+            }
+            yield this.cache.set(key, response['ticket'], parseInt(response['expires_in']));
+            return response['ticket'];
+        });
+    }
+    /**
+     * 获取签名配置
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    configSignature(url, nonce = null, timestamp = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            nonce = nonce || (0, Utils_1.randomString)(10);
+            timestamp = timestamp || (0, Utils_1.getTimestamp)();
+            let ticket = yield this.getTicket();
+            return {
+                url,
+                nonceStr: nonce,
+                timestamp,
+                appId: this.appId,
+                signature: this.getTicketSignature(ticket, nonce, timestamp, url),
+            };
+        });
+    }
+    getTicketSignature(ticket, nonce, timestamp, url) {
+        return (0, Utils_1.createHash)(`jsapi_ticket=${ticket}&noncestr=${nonce}&timestamp=${timestamp}&url=${url}`, 'sha1');
+    }
+}
+;
+module.exports = JsApiTicket;

package/dist/OfficialAccount/Message.d.ts

@@ -0,0 +1,4 @@
+import BaseMessage from '../Core/Message';
+declare class Message extends BaseMessage {
+}
+export = Message;

package/dist/OfficialAccount/Message.js

@@ -0,0 +1,8 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Message_1 = __importDefault(require("../Core/Message"));
+class Message extends Message_1.default {
+}
+module.exports = Message;

package/dist/OfficialAccount/Server.d.ts

@@ -0,0 +1,43 @@
+import ServerRequestInterface from '../Core/Http/Contracts/ServerRequestInterface';
+import Encryptor from '../Core/Encryptor';
+import ServerInterface from '../Core/Contracts/ServerInterface';
+import Response from '../Core/Http/Response';
+import Message from './Message';
+import HandlersMixin from '../Core/Mixins/HandlersMixin';
+import DecryptXmlMessageMixin from '../Core/Mixins/DecryptXmlMessageMixin';
+import { ServerEventType, ServerHandlerClosure, ServerMessageType } from '../Types/global';
+import ResponseXmlMessageMixin from '../Core/Mixins/ResponseXmlMessageMixin';
+declare class Server implements ServerInterface {
+    protected request: ServerRequestInterface;
+    protected encryptor: Encryptor;
+    constructor(request?: ServerRequestInterface, encryptor?: Encryptor);
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve(): Promise<Response>;
+    /**
+     * 添加普通消息处理器
+     * @param type
+     * @param handler
+     * @returns
+     */
+    addMessageListener(type: ServerMessageType, handler: ServerHandlerClosure): this;
+    /**
+     * 添加事件消息处理器
+     * @param event
+     * @param handler
+     * @returns
+     */
+    addEventListener(event: ServerEventType, handler: ServerHandlerClosure): this;
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
+    protected decryptRequestMessage(query: Record<string, any>): ServerHandlerClosure;
+}
+interface Server extends HandlersMixin, DecryptXmlMessageMixin, ResponseXmlMessageMixin {
+}
+export = Server;

package/dist/OfficialAccount/Server.js

@@ -0,0 +1,94 @@
+'use strict';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Response_1 = __importDefault(require("../Core/Http/Response"));
+const Message_1 = __importDefault(require("./Message"));
+const HandlersMixin_1 = __importDefault(require("../Core/Mixins/HandlersMixin"));
+const Utils_1 = require("../Core/Support/Utils");
+const DecryptXmlMessageMixin_1 = __importDefault(require("../Core/Mixins/DecryptXmlMessageMixin"));
+const ResponseXmlMessageMixin_1 = __importDefault(require("../Core/Mixins/ResponseXmlMessageMixin"));
+class Server {
+    constructor(request = null, encryptor = null) {
+        this.request = request;
+        this.encryptor = encryptor;
+        this.handlers = [];
+    }
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let echostr = this.request.getQueryParams()['echostr'] || '';
+            if (!!echostr) {
+                return new Response_1.default(200, {}, echostr);
+            }
+            let message = yield this.getRequestMessage(this.request);
+            let query = this.request.getQueryParams();
+            if (this.encryptor && query['msg_signature']) {
+                this.prepend(this.decryptRequestMessage(query));
+            }
+            let response = yield this.handle(new Response_1.default(200, {}, 'success'), message);
+            if (!(response instanceof Response_1.default)) {
+                response = yield this.transformToReply(response, message, this.encryptor);
+            }
+            return response;
+        });
+    }
+    /**
+     * 添加普通消息处理器
+     * @param type
+     * @param handler
+     * @returns
+     */
+    addMessageListener(type, handler) {
+        return this.withHandler(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.MsgType === type ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 添加事件消息处理器
+     * @param event
+     * @param handler
+     * @returns
+     */
+    addEventListener(event, handler) {
+        return this.withHandler(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.Event === event ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request = null) {
+        return Message_1.default.createFromRequest(request || this.request);
+    }
+    decryptRequestMessage(query) {
+        return (message, next) => __awaiter(this, void 0, void 0, function* () {
+            if (!this.encryptor)
+                return null;
+            yield this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
+            return next(message);
+        });
+    }
+}
+;
+;
+(0, Utils_1.applyMixins)(Server, [HandlersMixin_1.default, DecryptXmlMessageMixin_1.default, ResponseXmlMessageMixin_1.default]);
+module.exports = Server;

package/dist/OfficialAccount/Utils.d.ts

@@ -0,0 +1,7 @@
+import Application from './Application';
+declare class Utils {
+    protected app: Application;
+    constructor(app: Application);
+    buildJsSdkConfig(url: string, jsApiList?: string[], openTagList?: string[], debug?: boolean): Promise<Record<string, any>>;
+}
+export = Utils;

package/dist/OfficialAccount/{Server/Guard.js → Utils.js}

@@ -11,14 +11,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const ServerGuard_1 = __importDefault(require("../../Core/ServerGuard"));
-class Guard extends ServerGuard_1.default {
-    shouldReturnRawResponse() {
+const merge_1 = __importDefault(require("merge"));
+class Utils {
+    constructor(app) {
+        this.app = app;
+    }
+    buildJsSdkConfig(url, jsApiList = [], openTagList = [], debug = false) {
         return __awaiter(this, void 0, void 0, function* () {
-            return !((yield this.app.request.get('echostr')) == null);
+            return (0, merge_1.default)({
+                jsApiList,
+                openTagList,
+                debug,
+            }, yield this.app.getTicket().configSignature(url));
         });
     }
 }
-exports.default = Guard;
 ;
+module.exports = Utils;

package/dist/Types/global.d.ts

@@ -0,0 +1,343 @@
+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 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 OfficialAccountConfig {
+  /**
+   * 公众号 app_id
+   */
+  app_id?: string;
+
+  /**
+   * 公众号 secret
+   */
+  secret?: string;
+
+  /**
+   * 服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+
+  /**
+   * 网页授权相关配置
+   */
+  oauth?: OauthConfig;
+
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 小程序配置
+ */
+export declare interface MiniAppConfig {
+  /**
+   * 小程序 app_id
+   */
+  app_id?: string;
+
+  /**
+   * 小程序 secret
+   */
+  secret?: string;
+
+  /**
+   * 服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 微信支付配置
+ */
+export declare interface PayConfig {
+  /**
+   * 商户号
+   */
+  mch_id?: string;
+
+  /**
+   * pfx 证书路径（敏感接口（如退款、发送红包等）需要）
+   */
+  certificate?: string;
+
+  /**
+   * v3 API密钥
+   */
+  secret_key?: string;
+
+  /**
+   * v2 API密钥
+   */
+  v2_secret_key?: string;
+
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 开发平台配置
+ */
+export declare interface OpenPlatformConfig {
+  /**
+   * 开发平台 app_id
+   */
+  app_id?: string;
+
+  /**
+   * 开发平台 secret
+   */
+  secret?: string;
+
+  /**
+   * 开发平台服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 开发平台服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 企业微信配置
+ */
+export declare interface WorkConfig {
+  /**
+   * 企业微信 corp_id
+   */
+  corp_id?: string;
+
+  /**
+   * 企业微信 secret
+   */
+  secret?: string;
+
+  /**
+   * 企业微信服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 企业微信服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 企业微信开放平台配置
+ */
+export declare interface OpenWorkConfig {
+  /**
+   * 企业微信 corp_id
+   */
+  corp_id?: string;
+
+  /**
+   * 企业微信 secret
+   */
+  secret?: string;
+
+  /**
+   * 企业微信服务端接口验证 token
+   */
+  token?: string;
+
+  /**
+   * 企业微信服务端消息加解密密钥 aes_key
+   */
+  aes_key?: string;
+
+  /**
+   * 网络请求相关配置
+   */
+  http?: AxiosRequestConfig;
+
+  /**
+   * 文件缓存相关配置
+   */
+  file_cache?: CacheFileConfig;
+}
+
+/**
+ * 公众号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;

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

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

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

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

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "node-easywechat",
-  "version": "2.10.1",
+  "version": "3.0.0-alpha.2",
   "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;
-}