node-easywechat 2.8.1 → 2.9.1

package/README.md

@@ -3,9 +3,11 @@
 
 [![Build Status](https://app.travis-ci.com/hpyer/node-easywechat.svg?branch=develop)](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的结构基本一致，就不升级大版本了)。若您需要 EasyWechat 的 3.x版本，请切换到 [1.x](https://github.com/hpyer/node-easywechat/tree/1.x) 分支。**
+**注：2.x分支针对 EasyWechat 的 5.x版本(由于4.x与5.x的结构基本一致，就不升级大版本了)。**
 
-[EasyWechat](https://github.com/overtrue/wechat) 是一个由 `安正超` 大神用 PHP 开发的开源的微信非官方 SDK。其功能强大，使用方便，个人一直很喜欢，所以近日将其在 Node.js 上实现。本人会尽量还原其配置项以及接口的调用方式，但毕竟语言环境不同，具体的实现方式会有些许差别，还请各位开发者见谅。
+~~若您需要 EasyWechat 的 3.x版本，请切换到 [1.x](https://github.com/hpyer/node-easywechat/tree/1.x) 分支。~~ **1.0版本已废弃**
+
+[EasyWechat](https://github.com/w7corp/easywechat) 是一个由 `安正超` 大神用 PHP 开发的开源的微信非官方 SDK（现由微擎团队团队维护）。其功能强大，使用方便，个人一直很喜欢，所以近日将其在 Node.js 上实现。本人会尽量还原其配置项以及接口的调用方式，但毕竟语言环境不同，具体的实现方式会有些许差别，还请各位开发者见谅。
 
 > 注：虽然也使用了 EasyWechat 这个名称，但是和 `安正超` 大神没有任何关系，请各位开发者不要因使用本包产生的疑惑而去打扰大神，如有疑问请在本项目中提 issue，谢谢~
 
@@ -36,7 +38,7 @@ let payment = new EasyWechat.Factory.Payment({
   // ...
 });
 
-// 微信支付
+// 开放平台
 let openPlatform = new EasyWechat.Factory.OpenPlatform({
   // ...
 });
@@ -51,6 +53,11 @@ let microMerchant = new EasyWechat.Factory.MicroMerchant({
   // ...
 });
 
+// 企业微信开放平台
+let openWork = new EasyWechat.Factory.OpenWork({
+  // ...
+});
+
 // 通用方式
 let app = EasyWechat.Factory.getInstance('OficialAccount', {
   // ...
@@ -147,6 +154,46 @@ let app = EasyWechat.Factory.getInstance('OficialAccount', {
 }
 ```
 
+``` 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] 公众号模块
@@ -154,7 +201,7 @@ let app = EasyWechat.Factory.getInstance('OficialAccount', {
 - [x] 小程序
 - [x] 开放平台
 - [x] 企业微信
-- [ ] 企业微信开放平台
+- [x] 企业微信开放平台
 - [x] 小微商户
 - [x] 自定义
 

package/dist/Core/Http/Request.js

@@ -110,7 +110,7 @@ class Request {
     get(key) {
         if (!this.isValid)
             throw new Error('Please set request first. app.rebind(\'request\', new EasyWechat.Request(ctx.req));');
-        if (this._get[key])
+        if (this._get[key] != undefined)
             return this._get[key];
         return this.post(key);
     }
@@ -135,7 +135,7 @@ class Request {
                     this._post = (0, Utils_1.parseQueryString)(this._content.toString());
                 }
             }
-            return this._post && this._post[key] ? this._post[key] : null;
+            return this._post && this._post[key] != undefined ? this._post[key] : null;
         });
     }
     getAllGet() {

package/dist/Core/ServerGuard.d.ts

@@ -35,8 +35,8 @@ export default class ServerGuard {
      * 处理消息
      */
     serve(): Promise<Response>;
-    protected validate(): Promise<this>;
-    protected forceValidate(): this;
+    validate(): Promise<this>;
+    forceValidate(): this;
     protected resolve(): Promise<Response>;
     protected shouldReturnRawResponse(): Promise<boolean>;
     protected buildResponse(to: string, from: string, message: any): Promise<string>;

package/dist/Core/Types.d.ts

@@ -49,7 +49,7 @@ export declare interface EasyWechatConfig {
     app_id?: string;
     /**
      * 应用 secret
-     * @scope BaseService | OfficialAccount | MiniProgram | Work
+     * @scope BaseService | OfficialAccount | MiniProgram | Work | OpenWork
      */
     secret?: string;
     /**
@@ -64,12 +64,12 @@ export declare interface EasyWechatConfig {
     file_cache?: EasyWechatConfigCacheFile;
     /**
      * 服务端接口验证 token
-     * @scope OfficialAccount | MiniProgram | OpenPlatform
+     * @scope OfficialAccount | MiniProgram | OpenPlatform | OpenWork
      */
     token?: string;
     /**
      * 服务端消息加解密密钥 aes_key
-     * @scope OfficialAccount | MiniProgram | OpenPlatform
+     * @scope OfficialAccount | MiniProgram | OpenPlatform | OpenWork
      */
     aes_key?: string;
     /**
@@ -154,7 +154,7 @@ export declare interface EasyWechatConfig {
     device_type?: string;
     /**
      * 企业id
-     * @scope Work
+     * @scope Work | OpenWork
      */
     corp_id?: string;
     /**
@@ -162,6 +162,36 @@ export declare interface EasyWechatConfig {
      * @scope Work
      */
     agent_id?: string;
+    /**
+     * 应用id
+     * @scope OpenWork
+     */
+    suite_id?: string;
+    /**
+     * 应用secret
+     * @scope OpenWork
+     */
+    suite_secret?: string;
+    /**
+     * 注册定制化模板ID
+     * @scope OpenWork
+     */
+    reg_template_id?: string;
+    /**
+     * 安装应用的回调url（可选）
+     * @scope OpenWork
+     */
+    redirect_uri_install?: string;
+    /**
+     * 单点登录回调url（可选）
+     * @scope OpenWork
+     */
+    redirect_uri_single?: string;
+    /**
+     * 网页授权第三方回调url（可选）
+     * @scope OpenWork
+     */
+    redirect_uri_oauth?: string;
 }
 /**
  * 服务端通知处理回调函数

package/dist/MiniProgram/Application.d.ts

@@ -21,6 +21,13 @@ import SoterClient from './Soter/SoterClient';
 import SubscribeMessageClient from './SubscribeMessage/SubscribeMessageClient';
 import RealtimeLogClient from './RealtimeLog/RealtimeLogClient';
 import SearchClient from './Search/SearchClient';
+import ShopAccoutClient from './Shop/AccoutClient';
+import ShopAftersaleClient from './Shop/AftersaleClient';
+import ShopBasicClient from './Shop/BasicClient';
+import ShopDeliveryClient from './Shop/DeliveryClient';
+import ShopOrderClient from './Shop/OrderClient';
+import ShopRegisterClient from './Shop/RegisterClient';
+import ShopSpuClient from './Shop/SpuClient';
 import ShortLinkClient from './ShortLink/ShortLinkClient';
 import MediaClient from '../BaseService/Media/MediaClient';
 import ContentSecurityClient from '../BaseService/ContentSecurity/ContentSecurityClient';
@@ -54,6 +61,13 @@ export default class MiniProgram extends BaseApplication {
     subscribe_message: SubscribeMessageClient;
     realtime_log: RealtimeLogClient;
     search: SearchClient;
+    shop_account: ShopAccoutClient;
+    shop_aftersale: ShopAftersaleClient;
+    shop_basic: ShopBasicClient;
+    shop_delivery: ShopDeliveryClient;
+    shop_order: ShopOrderClient;
+    shop_register: ShopRegisterClient;
+    shop_spu: ShopSpuClient;
     short_link: ShortLinkClient;
     media: MediaClient;
     content_security: ContentSecurityClient;

package/dist/MiniProgram/Application.js

@@ -35,6 +35,13 @@ const SoterClient_1 = __importDefault(require("./Soter/SoterClient"));
 const SubscribeMessageClient_1 = __importDefault(require("./SubscribeMessage/SubscribeMessageClient"));
 const RealtimeLogClient_1 = __importDefault(require("./RealtimeLog/RealtimeLogClient"));
 const SearchClient_1 = __importDefault(require("./Search/SearchClient"));
+const AccoutClient_1 = __importDefault(require("./Shop/AccoutClient"));
+const AftersaleClient_1 = __importDefault(require("./Shop/AftersaleClient"));
+const BasicClient_1 = __importDefault(require("./Shop/BasicClient"));
+const DeliveryClient_1 = __importDefault(require("./Shop/DeliveryClient"));
+const OrderClient_1 = __importDefault(require("./Shop/OrderClient"));
+const RegisterClient_1 = __importDefault(require("./Shop/RegisterClient"));
+const SpuClient_1 = __importDefault(require("./Shop/SpuClient"));
 const ShortLinkClient_1 = __importDefault(require("./ShortLink/ShortLinkClient"));
 const MediaClient_1 = __importDefault(require("../BaseService/Media/MediaClient"));
 const ContentSecurityClient_1 = __importDefault(require("../BaseService/ContentSecurity/ContentSecurityClient"));
@@ -69,6 +76,13 @@ class MiniProgram extends BaseApplication_1.default {
         this.subscribe_message = null;
         this.realtime_log = null;
         this.search = null;
+        this.shop_account = null;
+        this.shop_aftersale = null;
+        this.shop_basic = null;
+        this.shop_delivery = null;
+        this.shop_order = null;
+        this.shop_register = null;
+        this.shop_spu = null;
         this.short_link = null;
         this.media = null;
         this.content_security = null;
@@ -165,6 +179,27 @@ class MiniProgram extends BaseApplication_1.default {
         this.offsetSet('search', function (app) {
             return new SearchClient_1.default(app);
         });
+        this.offsetSet('shop_account', function (app) {
+            return new AccoutClient_1.default(app);
+        });
+        this.offsetSet('shop_aftersale', function (app) {
+            return new AftersaleClient_1.default(app);
+        });
+        this.offsetSet('shop_basic', function (app) {
+            return new BasicClient_1.default(app);
+        });
+        this.offsetSet('shop_delivery', function (app) {
+            return new DeliveryClient_1.default(app);
+        });
+        this.offsetSet('shop_order', function (app) {
+            return new OrderClient_1.default(app);
+        });
+        this.offsetSet('shop_register', function (app) {
+            return new RegisterClient_1.default(app);
+        });
+        this.offsetSet('shop_spu', function (app) {
+            return new SpuClient_1.default(app);
+        });
         this.offsetSet('short_link', function (app) {
             return new ShortLinkClient_1.default(app);
         });

package/dist/MiniProgram/Shop/AccoutClient.d.ts

@@ -0,0 +1,25 @@
+import BaseClient from '../../Core/BaseClient';
+export default class AccountClient extends BaseClient {
+    /**
+     * 获取商家类目列表
+     * @returns
+     */
+    getCategoryList(): Promise<any>;
+    /**
+     * 获取商家品牌列表
+     * @returns
+     */
+    getBrandList(): Promise<any>;
+    /**
+     * 更新商家信息
+     * @param path 小程序path
+     * @param phone 客服联系方式
+     * @returns
+     */
+    updateInfo(path: string, phone: string): Promise<any>;
+    /**
+     * 获取商家信息
+     * @returns
+     */
+    getInfo(): Promise<any>;
+}

package/dist/MiniProgram/Shop/AccoutClient.js

@@ -0,0 +1,42 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
+class AccountClient extends BaseClient_1.default {
+    /**
+     * 获取商家类目列表
+     * @returns
+     */
+    getCategoryList() {
+        return this.httpPostJson('shop/account/get_category_list');
+    }
+    /**
+     * 获取商家品牌列表
+     * @returns
+     */
+    getBrandList() {
+        return this.httpPostJson('shop/account/get_brand_list');
+    }
+    /**
+     * 更新商家信息
+     * @param path 小程序path
+     * @param phone 客服联系方式
+     * @returns
+     */
+    updateInfo(path, phone) {
+        return this.httpPostJson('shop/account/update_info', {
+            service_agent_path: path,
+            service_agent_phone: phone,
+        });
+    }
+    /**
+     * 获取商家信息
+     * @returns
+     */
+    getInfo() {
+        return this.httpPostJson('shop/account/get_info');
+    }
+}
+exports.default = AccountClient;

package/dist/MiniProgram/Shop/AftersaleClient.d.ts

@@ -0,0 +1,22 @@
+import BaseClient from '../../Core/BaseClient';
+export default class AftersaleClient extends BaseClient {
+    /**
+     * 创建售后
+     * @param aftersale 售后数据
+     * @returns
+     */
+    add(aftersale: object): Promise<any>;
+    /**
+     * 获取订单下售后单
+     * @param order 订单数据
+     * @returns
+     */
+    get(order: object): Promise<any>;
+    /**
+     * 更新售后
+     * @param order 订单数据
+     * @param aftersale 售后数据
+     * @returns
+     */
+    update(order: object, aftersale: object): Promise<any>;
+}

package/dist/MiniProgram/Shop/AftersaleClient.js

@@ -0,0 +1,35 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
+const Utils_1 = require("../../Core/Utils");
+class AftersaleClient extends BaseClient_1.default {
+    /**
+     * 创建售后
+     * @param aftersale 售后数据
+     * @returns
+     */
+    add(aftersale) {
+        return this.httpPostJson('shop/aftersale/add', aftersale);
+    }
+    /**
+     * 获取订单下售后单
+     * @param order 订单数据
+     * @returns
+     */
+    get(order) {
+        return this.httpPostJson('shop/aftersale/get', order);
+    }
+    /**
+     * 更新售后
+     * @param order 订单数据
+     * @param aftersale 售后数据
+     * @returns
+     */
+    update(order, aftersale) {
+        return this.httpPostJson('shop/aftersale/update', (0, Utils_1.merge)((0, Utils_1.merge)({}, order), aftersale));
+    }
+}
+exports.default = AftersaleClient;

package/dist/MiniProgram/Shop/BasicClient.d.ts

@@ -0,0 +1,39 @@
+import BaseClient from '../../Core/BaseClient';
+export default class BasicClient extends BaseClient {
+    /**
+     * 获取商品类目
+     * @returns
+     */
+    getCat(): Promise<any>;
+    /**
+     * 上传图片
+     * @param path
+     * @param respType
+     * @returns
+     */
+    imgUpload(path: string, respType?: number): Promise<any>;
+    /**
+     * 品牌审核
+     * @param brand
+     * @returns
+     */
+    auditBrand(brand: object): Promise<any>;
+    /**
+     * 类目审核
+     * @param category
+     * @returns
+     */
+    auditCategory(category: object): Promise<any>;
+    /**
+     * 获取审核结果
+     * @param auditId
+     * @returns
+     */
+    auditResult(auditId: string): Promise<any>;
+    /**
+     * 获取小程序资质
+     * @param reqType
+     * @returns
+     */
+    getMiniAppCertificate(reqType?: number): Promise<any>;
+}

package/dist/MiniProgram/Shop/BasicClient.js

@@ -0,0 +1,69 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
+class BasicClient extends BaseClient_1.default {
+    /**
+     * 获取商品类目
+     * @returns
+     */
+    getCat() {
+        return this.httpPostJson('shop/cat/get');
+    }
+    /**
+     * 上传图片
+     * @param path
+     * @param respType
+     * @returns
+     */
+    imgUpload(path, respType = 1) {
+        return this.httpUpload('customservice/kfaccount/uploadheadimg', {
+            media: path,
+        }, {
+            resp_type: respType,
+        });
+    }
+    /**
+     * 品牌审核
+     * @param brand
+     * @returns
+     */
+    auditBrand(brand) {
+        return this.httpPostJson('shop/audit/audit_brand', {
+            audit_req: brand,
+        });
+    }
+    /**
+     * 类目审核
+     * @param category
+     * @returns
+     */
+    auditCategory(category) {
+        return this.httpPostJson('shop/audit/audit_category', {
+            audit_req: category,
+        });
+    }
+    /**
+     * 获取审核结果
+     * @param auditId
+     * @returns
+     */
+    auditResult(auditId) {
+        return this.httpPostJson('shop/audit/result', {
+            audit_id: auditId,
+        });
+    }
+    /**
+     * 获取小程序资质
+     * @param reqType
+     * @returns
+     */
+    getMiniAppCertificate(reqType = 2) {
+        return this.httpPostJson('shop/audit/get_miniapp_certificate', {
+            req_type: reqType,
+        });
+    }
+}
+exports.default = BasicClient;

package/dist/MiniProgram/Shop/DeliveryClient.d.ts

@@ -0,0 +1,20 @@
+import BaseClient from '../../Core/BaseClient';
+export default class DeliveryClient extends BaseClient {
+    /**
+     * 获取快递公司列表
+     * @returns
+     */
+    getCompanyList(): Promise<any>;
+    /**
+     * 订单发货
+     * @param order
+     * @returns
+     */
+    send(order: object): Promise<any>;
+    /**
+     * 订单确认收货
+     * @param order
+     * @returns
+     */
+    recieve(order: object): Promise<any>;
+}

package/dist/MiniProgram/Shop/DeliveryClient.js

@@ -0,0 +1,32 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
+class DeliveryClient extends BaseClient_1.default {
+    /**
+     * 获取快递公司列表
+     * @returns
+     */
+    getCompanyList() {
+        return this.httpPostJson('shop/delivery/get_company_list');
+    }
+    /**
+     * 订单发货
+     * @param order
+     * @returns
+     */
+    send(order) {
+        return this.httpPostJson('shop/delivery/send', order);
+    }
+    /**
+     * 订单确认收货
+     * @param order
+     * @returns
+     */
+    recieve(order) {
+        return this.httpPostJson('shop/delivery/recieve', order);
+    }
+}
+exports.default = DeliveryClient;

package/dist/MiniProgram/Shop/OrderClient.d.ts

@@ -0,0 +1,32 @@
+import BaseClient from '../../Core/BaseClient';
+export default class OrderClient extends BaseClient {
+    /**
+     * 检查场景值是否在支付校验范围内
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/check_scene.html
+     * @param scene
+     * @returns
+     */
+    sceneCheck(scene: number): Promise<any>;
+    /**
+     * 生成订单
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/add_order.html
+     * @param order
+     * @returns
+     */
+    add(order: object): Promise<any>;
+    /**
+     * 获取订单详情
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/get_order.html
+     * @param openid 用户的openid
+     * @param orderIds {order_id, out_order_id} 二选一
+     * @returns
+     */
+    get(openid: string, orderIds: object): Promise<any>;
+    /**
+     * 同步订单支付结果
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/pay_order.html
+     * @param object
+     * @returns
+     */
+    pay(params: object): Promise<any>;
+}

package/dist/MiniProgram/Shop/OrderClient.js

@@ -0,0 +1,51 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
+const Utils_1 = require("../../Core/Utils");
+class OrderClient extends BaseClient_1.default {
+    /**
+     * 检查场景值是否在支付校验范围内
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/check_scene.html
+     * @param scene
+     * @returns
+     */
+    sceneCheck(scene) {
+        return this.httpPostJson('shop/scene/check', {
+            scene,
+        });
+    }
+    /**
+     * 生成订单
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/add_order.html
+     * @param order
+     * @returns
+     */
+    add(order) {
+        return this.httpPostJson('shop/order/add', order);
+    }
+    /**
+     * 获取订单详情
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/get_order.html
+     * @param openid 用户的openid
+     * @param orderIds {order_id, out_order_id} 二选一
+     * @returns
+     */
+    get(openid, orderIds) {
+        return this.httpPostJson('shop/order/get', (0, Utils_1.merge)((0, Utils_1.merge)({}, orderIds), {
+            openid,
+        }));
+    }
+    /**
+     * 同步订单支付结果
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/pay_order.html
+     * @param object
+     * @returns
+     */
+    pay(params) {
+        return this.httpPostJson('shop/order/pay', params);
+    }
+}
+exports.default = OrderClient;

package/dist/MiniProgram/Shop/RegisterClient.d.ts

@@ -0,0 +1,25 @@
+import BaseClient from '../../Core/BaseClient';
+export default class RegisterClient extends BaseClient {
+    /**
+     * 接入申请
+     * @returns
+     */
+    apply(): Promise<any>;
+    /**
+     * 获取接入状态
+     * @returns
+     */
+    check(): Promise<any>;
+    /**
+     * 完成接入任务
+     * @param accessInfoItem 6:完成spu接口，7:完成订单接口，8:完成物流接口，9:完成售后接口，10:测试完成，11:发版完成
+     * @returns
+     */
+    finishAccessInfo(accessInfoItem: number): Promise<any>;
+    /**
+     * 场景接入申请
+     * @param sceneGroupId 1:视频号、公众号场景
+     * @returns
+     */
+    applyScene(sceneGroupId: number): Promise<any>;
+}