node-easywechat 2.10.1 → 3.0.0-alpha.2

package/CHANGELOG.md

@@ -1,203 +1,14 @@
 # CHANGELOG
 
 
-## v2.10.0 (2022-05-18)
+## v3.0.0-alpha.2 (2022-06-08)
 
-- Feat: 开放平台代理小程序新增小程序用户隐私保护指引相关接口
-- Feat: 开放平台代理小程序新增获取永久素材接口
-- Feat: 企业微信新增商品图册相关接口
-- Feat: 企业微信新增敏感词相关接口
-- Feat: 新增新版企业微信开发平台根据unionid查询external_userid方法
+- Perf: 优化消息对象的提示信息
 
-- Fix: 企业微信注册敏感词管理、产品图册管理两个模块
+- Refactor: 简化构造函数的写法
 
-## v2.9.7 (2022-05-16)
+## v3.0.0-alpha.1 (2022-04-16)
 
-- Fix: 修复开放平台代理的小程序、公众号实例中没有开放平台专属API的问题 (#22)
+- Feat: 新增框架架构和公众号模块
 
-## v2.9.6 (2022-05-16)
-
-- Fix: 修复第三方平台获取代理的小程序、公众号实例后，无对应方法和token的 (#22)
-
-- Docs: 更新企业微信支付证书说明
-
-## v2.9.5 (2022-04-23)
-
-- Fix: 修复企业微信获取注册定制化URL接口未自动获取到注册码的问题
-- Fix: 修复企业微信扫码授权登录回调配置项错误的问题 (#19)
-
-## v2.9.4 (2022-04-22)
-
-- Fix: 修复开放平台、企业微信开放平台获取授权AccessToken异常的问题 (#18)
-
-## v2.9.3 (2022-03-25)
-
-- Fix: 修复发送图文客服消息失败的问题 (#17)
-
-## v2.9.2 (2022-03-23)
-
-- Feat: 新增企业微信客户群「加入群聊」管理相关接口
-- Feat: 新增物流服务退货相关接口
-- Feat: 新增获取订单列表接口
-- Feat: 新增小程序绑定、解绑物流账号接口
-- Feat: 增加查询openAPI调用次数
-
-- Docs: 移除api文档
-
-## v2.9.1 (2022-02-09)
-
-## v2.9.0 (2022-01-28)
-
-- Feat: 新增企业微信开放平台
-
-- Fix: 修复开放平台构建移动端授权链接的方法
-- Fix: 调整消息通知处理类的方法作用域
-
-## v2.8.3 (2022-01-20)
-
-- Feat: 小程序新增自定义版交易组件及开放接口
-
-## v2.8.2 (2022-01-12)
-
-- Feat: 企业微信朋友圈优化相关接口
-- Feat: 企业微信增加上传附件资源接口
-- Feat: 新增企业微信客服相关接口
-- Feat: 优化企业微信群聊数据统计相关接口
-- Feat: 优化客户联系「联系我」相关接口
-- Feat: 完善企业互联相关接口
-- Feat: 新增应用工作台相关接口
-
-## v2.8.1 (2022-01-07)
-
-- Feat: 增加获取小程序短链接功能
-- Feat: 新增企业微信客户id转换相关接口
-
-## v2.8.0 (2022-01-06)
-
-- Feat: 新增小程序获取用户手机号功能
-- Feat: 微信支付jssdk增加生成联系人配置和小程序红包配置
-- Feat: 增加小程序联盟定向计划推广接口
-- Feat: 企业微信新增群发相关接口
-- Feat: 新增小程序链接模块
-- Feat: 企业微信获取客户群详情增加need_name参数
-
-- Fix: 修复批量获取客户详情参数错误
-
-## v2.7.2 (2021-10-01)
-
-- Fix: 修复自动回复消息格式异常的问题 (#13)
-
-## v2.7.1 (2021-09-08)
-
-## v2.7.0 (2021-08-31)
-
-- Feat: 新增小微商户相关接口
-
-- Fix: 重命名RSA加密解密文件
-- Fix: 移除无效文件
-- Fix: 封装构建xml的方法
-
-## v2.6.10 (2021-08-03)
-
-- Fix: 配置项中增加debug参数，以控制是否显示日志 (#12)
-
-## v2.6.9 (2021-07-29)
-
-- Feat: 新增获取所有绑定的物流账号
-
-- Fix: 修复提现到零钱时签名错误的问题 (#10)
-
-## v2.6.8 (2021-07-13)
-
-- Feat: 新增发送小程序红包接口
-- Feat: 补全客户联系相关接口
-
-## v2.6.7 (2021-07-02)
-
-- Feat: 新增获取小程序启动性能，运行性能等数据的接口
-- Feat: 增加小程序联盟查询联盟精选商品接口
-- Feat: 增加开放平台小程序代码模板template_type参数
-
-- Fix: 修复小程序风控接口请求异常的问题
-- Fix: 修复获取资源时错误信息的反馈异常的问题
-- Fix: 企业微信新增上传永久图片、获取高清语音素材接口
-
-## v2.6.6 (2021-06-01)
-
-- Feat: 新增消息类型interactive_taskcard和update_taskcard
-
-## v2.6.5 (2021-05-21)
-
-- Fix: 添加markdown和miniprogram_notice两种消息类型 (#9)
-
-## v2.6.4 (2021-05-20)
-
-- Fix: 修复获取企业微信accesstoken异常的问题
-
-## v2.6.3 (2021-05-19)
-
-- Feat: 新增公众号订阅消息功能
-
-- Fix: 增加小程序订阅消息的小程序类型参数，默认正式版
-
-## v2.6.2 (2021-04-28)
-
-- Feat: 新增小程序联盟相关接口
-- Feat: 新增入群欢迎语素材管理
-- Feat: 完善OCR识别相关接口
-
-## v2.6.1 (2021-04-13)
-
-- Feat: 增加声明配置项的方法
-
-- Fix: 取消企业微信中消息回复时media_id的必填设置
-
-## v2.6.0 (2021-03-22)
-
-- Feat: 新增小程序直播相关接口
-- Feat: 新增小程序风险控制相关接口
-- Feat: 新增小程序scheme码相关接口
-- Feat: 移除EasyWechat.Message
-- Feat: 网页授权模块改用node-socialite
-- Feat: 将request模块替换为axios
-- Feat: 添加企业微信模块
-- Feat: 完善企业微信接口
-- Feat: 新增企业微信的网页授权功能
-- Feat: 添加小程序相关接口
-- Feat: 注册已添加的企业微信接口
-- Feat: 新增企业微信群机器人接口
-- Feat: 新增企业微信日程管理接口
-- Feat: 增加企业微信的服务端消息处理功能
-- Feat: 增加企业微信回话内容模块
-- Feat: 增加企业微信的消息处理功能
-- Feat: 增加企业微信的用户管理、用户标签管理
-
-- Fix: 取消发送企业微信新客户欢迎语时的media_id必填限制
-- Fix: 修复变量错误的问题
-- Fix: 修复企业微信消息继承类错误的问题
-- Fix: 修复网页授权的功能，提升各模块的兼容性
-- Fix: OAuth支持设置code和AccessToken
-- Fix: 修复类名错误
-- Fix: 调整变量类型
-- Fix: 调整公众号服务端判断是否为接口验证请求的逻辑
-- Fix: 优化微信支付的一些小问题
-- Fix: 补充微信支付的沙盒模式参数
-- Fix: 修复支付时签约的接口地址异常问题
-- Fix: 修复非签约时统一下单接口地址有误的问题 #6
-- Fix: 修复微信支付通知中，业务逻辑有异常时无法返回正确结果的问题
-- Fix: 优化AES加密解密方法
-- Fix: 增加支持设置xml格式的request内容
-- Fix: 修复存在默认值导致读取请求内容异常的情况 #5
-- Fix: 当请求url包含域名时，则忽略base_url
-- Fix: 避免变量冲突导致异常
-- Fix: 修复无法合并类实例对象的问题
-- Fix: 移除merge依赖包
-
-- Docs: 修改注释
-
-- Perf: 优化服务端通知的回调函数提醒
-- Perf: 优化文件缓存操作类
-- Perf: 优化返回this的类型推导
-- Perf: 调整测试用例框架结构，完善测试用例中的类型推导
-- Perf: 调整总对象实现方式，优化服务类型推导
-- Perf: 增加配置类型声明、精简代码（如去除“* as”、配置项改为".xx"方式）
+- Docs: 更新3.x说明文档

package/README.md

@@ -1,11 +1,11 @@
 
 ## EasyWechat for Node.js
 
-[![Build Status](https://app.travis-ci.com/hpyer/node-easywechat.svg?branch=2.x)](https://app.travis-ci.com/hpyer/node-easywechat) [![npm](https://img.shields.io/npm/v/node-easywechat.svg)](https://www.npmjs.com/package/node-easywechat) [![License](https://img.shields.io/npm/l/node-easywechat.svg)](LICENSE)
+[![Build Status](https://app.travis-ci.com/hpyer/node-easywechat.svg?branch=3.x)](https://app.travis-ci.com/hpyer/node-easywechat) [![npm](https://img.shields.io/npm/v/node-easywechat.svg)](https://www.npmjs.com/package/node-easywechat) [![License](https://img.shields.io/npm/l/node-easywechat.svg)](LICENSE)
 
-**注：2.x分支针对 EasyWechat 的 5.x版本(由于4.x与5.x的结构基本一致，就不升级大版本了)。**
+**注：3.x分支针对 EasyWechat 的 6.x版本。**
 
-~~若您需要 EasyWechat 的 3.x版本，请切换到 [1.x](https://github.com/hpyer/node-easywechat/tree/1.x) 分支。~~ **1.0版本已废弃**
+~~若您需要 EasyWechat 的 5.x版本，请切换到 [2.x](https://github.com/hpyer/node-easywechat/tree/2.x) 分支。~~
 
 [EasyWechat](https://github.com/w7corp/easywechat) 是一个由 `安正超` 大神用 PHP 开发的开源的微信非官方 SDK（现由微擎团队团队维护）。其功能强大，使用方便，个人一直很喜欢，所以近日将其在 Node.js 上实现。本人会尽量还原其配置项以及接口的调用方式，但毕竟语言环境不同，具体的实现方式会有些许差别，还请各位开发者见谅。
 
@@ -14,51 +14,29 @@
 
 ### 安装
 
-`npm install -S node-easywechat`
+`npm install -S node-easywechat@next`
 
 ### 使用说明
 
 绝大部分API都可以根据 [EasyWechat 的文档](https://www.easywechat.com/5.x/) 来使用。小部分（如获取请求相关数据、返回响应数据、支付证书等）的操作，由于语言环境的不同，会有不同处理。具体可以查看 [node-easywechat-demo](https://github.com/hpyer/node-easywechat-demo/) 以及下方的[自定义模块说明](#自定义模块模块替换使用方法) 。如果仍有疑问，请提issue，谢谢～
 
 ```js
+// 按需引入所需要的模块
 // 公众号
-let officialAccount = new EasyWechat.Factory.OfficialAccount({
-  // ...
-});
-
-// 小程序
-let miniProgram = new EasyWechat.Factory.MiniProgram({
-  // ...
-});
-
-// 微信支付
-let payment = new EasyWechat.Factory.Payment({
-  // ...
-});
-
-// 开放平台
-let openPlatform = new EasyWechat.Factory.OpenPlatform({
-  // ...
-});
+const Application = require('node-easywechat/OfficialAccount/Application');
 
-// 企业微信
-let openPlatform = new EasyWechat.Factory.Work({
+// 实例化应用
+let app = new Application({
   // ...
 });
 
-// 小微商户
-let microMerchant = new EasyWechat.Factory.MicroMerchant({
-  // ...
-});
-
-// 企业微信开放平台
-let openWork = new EasyWechat.Factory.OpenWork({
-  // ...
-});
+// 获取 api 调用客户端
+let client = app.getClient();
 
-// 通用方式
-let app = EasyWechat.Factory.getInstance('OficialAccount', {
-  // ...
+// 请求 api
+let response = await client.post('/cgi-bin/user/info/updateremark', {
+  openid: 'xxxx',
+  remark: 'xxxx',
 });
 ```
 
@@ -96,251 +74,12 @@ let app = EasyWechat.Factory.getInstance('OficialAccount', {
 }
 ```
 
-``` js
-// 微信支付配置
-{
-  // 应用的 app_id
-  app_id: 'xxx',
-  // 商户号
-  mch_id: 'your-mch-id',
-  // 签名密钥
-  key: 'key-for-signature',
-  // 默认回调地址，也可以在下单时单独设置来覆盖它，完整URL，不带参数
-  notify_url: 'http://xxx.com/pay/notify',
-  // 证书地址，Node.js 只需要 apiclient_cert.p12 证书文件即可
-  cert_path: 'path/to/your/apiclient_cert.p12', // XXX: 绝对路径！！！！
-}
-```
-
-``` js
-// 小程序配置
-{
-  // appId
-  app_id: 'your-app-id',
-  // appSecret
-  secret: 'your-app-secret'
-}
-```
-
-``` js
-// 企业微信配置
-{
-  // corpId
-  corp_id: 'your-corp-id',
-  // agentId
-  agent_id: 'your-agent-id',
-  // appSecret
-  secret: 'your-app-secret'
-}
-```
-
-``` js
-// 小微商户配置
-{
-  // 商户号
-  mch_id: 'your-mch-id',
-  // 签名密钥
-  key: 'key-for-signature',
-  // V3版本签名密钥
-  apiv3_key: 'apiv3_key-for-signature',
-  // 证书地址，Node.js 只需要 apiclient_cert.p12 证书文件即可
-  cert_path: 'path/to/your/apiclient_cert.p12', // XXX: 绝对路径！！！！
-
-  // 以下两项配置在获取证书接口时可为空，在调用入驻接口前请先调用获取证书接口获取以下两项配置,如果获取过证书可以直接在这里配置，也可参照本文档获取平台证书章节中示例
-  // serial_no: '获取证书接口获取到的平台证书序列号',
-  // certificate: '获取证书接口获取到的证书内容'
-}
-```
-
-``` js
-// 开放平台
-{
-  // 开放平台APPID
-  app_id: 'your-app-id',
-  // 开放平台Secret
-  secret: 'your-secret',
-  // 开放平台Token
-  token: 'your-token',
-  // 开放平台AES KEY
-  aes_key: 'your-aes_key',
-}
-```
-
-``` js
-// 企业微信开放平台
-{
-  // 服务商的corpid
-  corp_id: 'your-corp_id',
-  // 服务商的secret
-  secret: 'your-secret',
-  // 应用id
-  suite_id: 'your-suite_id',
-  // 应用secret
-  suite_secret: 'your-suite_secret',
-  // 应用Token
-  token: 'your-token',
-  // 应用AESKey
-  aes_key: 'your-aes_key',
-  // 注册定制化模板ID
-  reg_template_id: 'your-tpl_id',
-  // 安装应用的回调url（可选）
-  redirect_uri_install: 'your-uri_install',
-  // 单点登录回调url（可选）
-  redirect_uri_single: 'your-uri_single',
-  // 网页授权第三方回调url（可选）
-  redirect_uri_oauth: 'your-uri_oauth',
-}
-```
-
 ### 模块支持情况
 
 - [x] 公众号模块
-- [x] 微信支付
-- [x] 小程序
-- [x] 开放平台
-- [x] 企业微信
-- [x] 企业微信开放平台
-- [x] 小微商户
-- [x] 自定义
-
-### 自定义模块（模块替换）使用方法
-
-使用自定义模块的主要目的，是为了消除不同框架、不同软件包的使用方法所带来的差异，以提升 node-easywechat 的使用效率。下面就来说说几个主要模块的自定义方法。
-
-##### 日志模块（log）
-
-> 注：自 `2.6.10` 版本起，配置项中新增了 `debug` 字段，默认为 `false`。设置为 `true` 时，程序才会打印相关日志。所以，如果你只是希望关闭日志的话，更新到 `2.6.10` 即可。
-
-```js
-// 创建实例
-const Easywechat = require('node-easywechat');
-let officialAccount = new Easywechat.Factory.OfficialAccount({
-  ...
-});
-
-// 自定义日志处理方法
-const myLogger = (app) => {
-  // 注意：这里返回的方法不能使用箭头函数，否则会导致获取到的 arguments 异常
-  // 若需要关闭日志，则返回空的函数即可
-  return function() {
-    // 判断是否开启了 debug
-    if (!app['config']['debug']) return true;
-
-    let args = arguments;
-    args[0] = 'myLogger: ' + args[0];
-    return console.log.apply(null, arguments);
-  }
-}
-
-// 使用 rebind 方法，将 myLogger 绑定为 log 模块
-officialAccount.rebind('log', myLogger);
-```
-
-##### 请求模块（request）
-
-```js
-// request 模块需实例化 EasyWechat.Http.Request 类
-// 实例化时，需要传入 IncomingMessage 实例
-let request = new EasyWechat.Http.Request(req);
-
-// 当然，由于 IncomingMessage 的 body 流的特殊性，某些框架（目前已知：fastify）
-// 可能会自动读取后挂载到上下文中，从而导致 node-easywechat 去尝试读取时报错。
-// 这时可以选择传入第二个参数，即post的内容
-// 支持 Buffer、object对象、JSON字符串、XML字符串、QueryString格式的POST内容字符串
-let request = new EasyWechat.Http.Request(req, content);
-
-// 若此法方法仍不能满足你的需求，可以选择继承 EasyWechat.Http.Request 类，
-// 并重写其中相关的方法
-// 参考：https://github.com/hpyer/node-easywechat/issues/5
-
-// 使用 rebind 方法，绑定 request 实例
-officialAccount.rebind('request', request);
-```
-
-##### 缓存模块（cache）
-
-```js
-// cache 模块需要您继承并实例化 EasyWechat.CacheInterface 接口
-// 以 redis 为例
-const Redis = require('redis');
-const BlueBird = require('bluebird');
-
-BlueBird.promisifyAll(Redis.RedisClient.prototype);
-BlueBird.promisifyAll(Redis.Multi.prototype);
-
-class RedisCache extends EasyWechat.CacheInterface
-{
-  constructor (options)
-  {
-    super();
-
-    this.$client = null;
-    try {
-      this.$client = Redis.createClient(options);
-    }
-    catch (e) {
-      console.log('无法创建Redis客户端', e);
-    }
-  }
-
-  async get(id)
-  {
-    if (!this.$client) return false;
-    let content = null;
-    try {
-      content = JSON.parse(await this.$client.getAsync(id));
-    }
-    catch (e) {
-      console.log('获取Redis缓存失败', id, e);
-      return false;
-    }
-    return content;
-  }
-
-  async has(id)
-  {
-    if (!this.$client) return false;
-    try {
-      let res = await this.$client.existsAsync(id);
-      return res == 1;
-    }
-    catch (e) {
-      return false;
-    }
-  }
-
-  async set(id, data = null, lifeTime = 0)
-  {
-    if (!this.$client) return false;
-    try {
-      if (lifeTime > 0) {
-        await this.$client.setAsync(id, JSON.stringify(data), 'EX', lifeTime);
-      }
-      else {
-        await this.$client.setAsync(id, JSON.stringify(data));
-      }
-    }
-    catch (e) {
-      console.log('设置Redis缓存失败', id, data, e);
-      return false;
-    }
-    return true;
-  }
-
-  async delete(id)
-  {
-    if (!this.$client) return false;
-    try {
-      let res = await this.$client.delAsync(id);
-      return true;
-    }
-    catch (e) {
-      return false;
-    }
-  }
-}
-let redisCache = new RedisCache(req);
-
-// 使用 rebind 方法，绑定 cache 实例
-officialAccount.rebind('cache', redisCache);
-```
+- [ ] 微信支付
+- [ ] 小程序
+- [ ] 开放平台
+- [ ] 企业微信
+- [ ] 企业微信开放平台
+- [ ] 自定义

package/dist/Core/Cache/FileCache.d.ts

@@ -1,12 +1,13 @@
 import CacheInterface from '../Contracts/CacheInterface';
-import { EasyWechatConfigCacheFile } from '../Types';
-export default class FileCache implements CacheInterface {
+import { CacheFileConfig } from '../../Types/global';
+declare class FileCache implements CacheInterface {
     private options;
-    constructor(options?: EasyWechatConfigCacheFile);
-    getCacheFile(id: string): string;
-    getCacheContent(file: string): string;
+    constructor(options?: CacheFileConfig);
+    protected getCacheFile(id: string): string;
+    protected getCacheContent(file: string): string;
     get(id: string): Promise<any>;
     has(id: string): Promise<boolean>;
     set(id: string, data?: any, lifeTime?: number): Promise<boolean>;
     delete(id: string): Promise<boolean>;
 }
+export = FileCache;

package/dist/Core/Cache/FileCache.js

@@ -11,10 +11,10 @@ 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 path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
-const Utils_1 = require("../Utils");
+const merge_1 = __importDefault(require("merge"));
+const Utils_1 = require("../Support/Utils");
 class FileCache {
     constructor(options = null) {
         this.options = {
@@ -24,7 +24,7 @@ class FileCache {
             ext: '.cache'
         };
         if (options && typeof options == 'object') {
-            this.options = (0, Utils_1.merge)({
+            this.options = (0, merge_1.default)({
                 path: './',
                 dirMode: 0o777,
                 fileMode: 0o666,
@@ -45,7 +45,7 @@ class FileCache {
         }
     }
     getCacheFile(id) {
-        return this.options.path + 'node-easywechat.file_cache.' + id + this.options.ext;
+        return this.options.path + id + this.options.ext;
     }
     getCacheContent(file) {
         let dataItem = JSON.parse(fs_1.default.readFileSync(file, {
@@ -116,5 +116,5 @@ class FileCache {
         });
     }
 }
-exports.default = FileCache;
 ;
+module.exports = FileCache;

package/dist/Core/Config.d.ts

@@ -0,0 +1,66 @@
+import { OfficialAccountConfig, MiniAppConfig, PayConfig, OpenPlatformConfig, WorkConfig, OpenWorkConfig } from "../Types/global";
+import ConfigInterface from "./Contracts/ConfigInterface";
+declare class Config implements ConfigInterface {
+    protected items: OfficialAccountConfig | MiniAppConfig | PayConfig | OpenPlatformConfig | WorkConfig | OpenWorkConfig;
+    protected requiredKeys: string[];
+    constructor(items?: OfficialAccountConfig | MiniAppConfig | PayConfig | OpenPlatformConfig | WorkConfig | OpenWorkConfig);
+    /**
+     * 检查是否有配置项缺失
+     * @returns
+     */
+    checkMissingKeys(): boolean;
+    /**
+     * 获取所有配置项
+     * @returns
+     */
+    all(): object;
+    /**
+     * 判断配置项是否存在
+     * @param key
+     * @returns
+     */
+    has(key: string): boolean;
+    /**
+     * 设置配置项
+     * @param key
+     * @param value
+     */
+    set(key: string, value: any): void;
+    /**
+     * 获取配置项
+     * @param key
+     * @param defaultValue
+     * @returns
+     */
+    get(key: string | string[] | Record<string, any>, defaultValue?: any): any;
+    /**
+     * 获取多个配置项
+     * @param keys 键名列表 或者 {键名:默认值} 格式的对象
+     * @returns
+     */
+    getMany(keys: string[] | Record<string, any>): object;
+    /**
+     * 判断配置项是否存在
+     * @param key
+     * @returns
+     */
+    offsetExists(key: any): boolean;
+    /**
+     * 获取配置项
+     * @param key
+     * @returns
+     */
+    offsetGet(key: any): any;
+    /**
+     * 设置配置项
+     * @param key
+     * @param value
+     */
+    offsetSet(key: any, value: any): void;
+    /**
+     * 删除配置项
+     * @param key
+     */
+    offsetUnset(key: any): void;
+}
+export = Config;