node-easywechat 3.7.3 → 3.7.5

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # CHANGELOG
 
 
+## v3.7.5 (2024-11-16)
+
+- Feat: 企业微信开放平台模块，新增生成授权页地址、获取企业永久授权码两个方法
+
+- Fix: 更新说明文档
+
+## v3.7.4 (2024-08-14)
+
+- Fix: 更新依赖包
+
 ## v3.7.3 (2024-07-26)
 
 - Fix: 修复各模块获取服务端消息时，未能获取最新请求导致解密异常的问题。(#88)

package/README.md

@@ -20,7 +20,7 @@
 
 ### 使用说明
 
-绝大部分API都可以根据 [EasyWeChat 的文档](https://www.easywechat.com/5.x/) 来使用。小部分（如获取请求相关数据、返回响应数据、支付证书等）的操作，由于语言环境的不同，会有不同处理。具体可以查看 [node-easywechat-demo](https://github.com/hpyer/node-easywechat-demo/) 以及下方的[自定义模块说明](#自定义模块模块替换使用方法) 。如果仍有疑问，请提issue，谢谢～
+请参考 [文档](https://hpyer.github.io/node-easywechat/) 来使用。如有需要可以查看 [示例代码](https://github.com/hpyer/node-easywechat-demo/)。如果仍有疑问，请提issue，谢谢～
 
 从 `3.x` 起 SDK 中不再内置具体业务的接口，仅封装底层基础部分，如认证、授权和 API 客户端。至于为什么不再封装业务接口，可以查看 [EasyWeChat 给出说明](https://easywechat.com/6.x/introduction.html#不再封装业务接口)。
 

package/dist/Core/Encryptor.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 declare class Encryptor {
     protected appId: string;
     protected token: string;

package/dist/Core/Http/Contracts/MessageInterface.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 declare abstract class MessageInterface {
     /**
      * 获取 HTTP 协议版本，如：'1.1', '1.0'

package/dist/Core/Http/Minxins/MessageMixin.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 declare class MessageMixin {
     protected headers: Record<string, any>;
     protected protocal: string;

package/dist/Core/Http/ServerRequest.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { IncomingMessage } from "http";
 import ServerRequestInterface from "./Contracts/ServerRequestInterface";
 import MessageMixin from "./Minxins/MessageMixin";

package/dist/Core/HttpClient/Mixins/PresetMixin.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { AxiosRequestConfig, Method } from "axios";
 import fs from "fs";
 declare class PresetMixin {

package/dist/Core/Support/AES.d.ts

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import { CipherGCMTypes, BinaryLike, CipherKey } from 'crypto';
 export declare class AES {
     /**

package/dist/Core/Support/PKCS.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 declare class PKCS7 {
     /**
      * 对需要加密的明文进行填充补位

package/dist/Core/Support/PrivateKey.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export declare class PrivateKey {
     protected passphrase?: string;
     protected key: Buffer;

package/dist/Core/Support/PublicKey.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export declare class PublicKey {
     protected certificate: Buffer;
     protected serialNo: string;

package/dist/Core/Support/RSA.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import crypto, { BinaryToTextEncoding } from 'crypto';
 declare class RSA {
     protected publicKey: crypto.KeyObject;

package/dist/Core/Support/Utils.d.ts

@@ -1,7 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import Crypto from 'crypto';
 import Stream from 'stream';
 import Fs from 'fs';

package/dist/OpenWork/Application.d.ts

@@ -96,6 +96,23 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     createPreAuthorizationCode(suiteAccessToken?: SuiteAccessToken): Promise<import("../Types/global").WeixinResponse>;
+    /**
+     * 生成授权页地址
+     * @see https://developer.work.weixin.qq.com/document/path/90597#从服务商网站发起
+     * @param callbackUrl 授权后的回调地址
+     * @param pre_auth_code 预授权码，不传则系统自动调用 createPreAuthorizationCode 获取
+     * @param state
+     * @returns
+     */
+    createPreAuthorizationUrl(callbackUrl: string, pre_auth_code?: string, state?: string): Promise<string>;
+    /**
+     * 获取企业永久授权码
+     * @see https://developer.work.weixin.qq.com/document/path/90603
+     * @param authCode 临时授权码
+     * @param suiteAccessToken
+     * @returns
+     */
+    getPermanentCode(authCode: string, suiteAccessToken?: SuiteAccessToken): Promise<import("../Types/global").WeixinResponse>;
     /**
      * 获取企业授权令牌
      * @param corpId

package/dist/OpenWork/Application.js

@@ -211,6 +211,49 @@ class Application {
         }
         return response;
     }
+    /**
+     * 生成授权页地址
+     * @see https://developer.work.weixin.qq.com/document/path/90597#从服务商网站发起
+     * @param callbackUrl 授权后的回调地址
+     * @param pre_auth_code 预授权码，不传则系统自动调用 createPreAuthorizationCode 获取
+     * @param state
+     * @returns
+     */
+    async createPreAuthorizationUrl(callbackUrl, pre_auth_code, state) {
+        let optional = {
+            pre_auth_code,
+            state,
+        };
+        if (!optional['pre_auth_code']) {
+            optional.pre_auth_code = (await this.createPreAuthorizationCode()).pre_auth_code;
+        }
+        let queries = (0, merge_1.default)({
+            suite_id: this.getAccount().getSuiteId(),
+            redirect_uri: callbackUrl,
+        }, optional);
+        return `https://open.work.weixin.qq.com/3rdapp/install?${(0, Utils_1.buildQueryString)(queries)}`;
+    }
+    /**
+     * 获取企业永久授权码
+     * @see https://developer.work.weixin.qq.com/document/path/90603
+     * @param authCode 临时授权码
+     * @param suiteAccessToken
+     * @returns
+     */
+    async getPermanentCode(authCode, suiteAccessToken = null) {
+        if (!suiteAccessToken)
+            suiteAccessToken = this.getSuiteAccessToken();
+        let response = (await this.getClient().request('post', '/cgi-bin/service/get_permanent_code', {
+            params: {
+                auth_code: authCode,
+                suite_access_token: await suiteAccessToken.getToken(),
+            }
+        })).toObject();
+        if (!response['permanent_code']) {
+            throw new Error('Failed to get permanent_code: ' + JSON.stringify(response));
+        }
+        return response;
+    }
     /**
      * 获取企业授权令牌
      * @param corpId

package/dist/OpenWork/Encryptor.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import BaseEncryptor from '../Core/Encryptor';
 declare class Encryptor extends BaseEncryptor {
     protected corpId: string;

package/dist/OpenWork/SuiteEncryptor.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import BaseEncryptor from '../Core/Encryptor';
 declare class SuiteEncryptor extends BaseEncryptor {
     protected suiteId: string;

package/dist/Pay/Client.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import fs from 'fs';
 import { Method, AxiosRequestConfig, AxiosInstance } from "axios";
 import HttpClientInterface from "../Core/HttpClient/Contracts/HttpClientInterface";

package/dist/Pay/Encryptor.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { PrivateKey } from "../Core/Support/PrivateKey";
 import { PublicKey } from "../Core/Support/PublicKey";
 import RSA from "../Core/Support/RSA";

package/dist/Work/Encryptor.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import BaseEncryptor from '../Core/Encryptor';
 declare class Encryptor extends BaseEncryptor {
     protected corpId: string;

package/dist/index.js

@@ -3,7 +3,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.definePaymentScannedHandler = exports.definePaymentRefundedHandler = exports.definePaymentPaidHandler = exports.definePaymentAlertHandler = exports.definePaymentFailHandler = exports.defineHttpClientFailureJudgeClosure = exports.defineChannelServerHandler = exports.defineOpenWorkServerHandler = exports.defineOpenPlatformServerHandler = exports.defineWorkServerHandler = exports.defineMiniAppServerHandler = exports.defineOfficeAccountServerHandler = exports.defineLogHandler = exports.defineChannelConfig = exports.defineOpenWorkConfig = exports.defineWorkConfig = exports.defineOpenPlatformConfig = exports.definePayConfig = exports.defineMiniAppConfig = exports.defineOfficialAccountConfig = exports.FormData = exports.PrivateKey = exports.PublicKey = exports.ServerRequest = exports.CacheInterface = exports.Channel = exports.OpenWork = exports.Work = exports.OpenPlatform = exports.Pay = exports.MiniApp = exports.OfficialAccount = void 0;
+exports.FormData = exports.PrivateKey = exports.PublicKey = exports.ServerRequest = exports.CacheInterface = exports.Channel = exports.OpenWork = exports.Work = exports.OpenPlatform = exports.Pay = exports.MiniApp = exports.OfficialAccount = void 0;
+exports.defineOfficialAccountConfig = defineOfficialAccountConfig;
+exports.defineMiniAppConfig = defineMiniAppConfig;
+exports.definePayConfig = definePayConfig;
+exports.defineOpenPlatformConfig = defineOpenPlatformConfig;
+exports.defineWorkConfig = defineWorkConfig;
+exports.defineOpenWorkConfig = defineOpenWorkConfig;
+exports.defineChannelConfig = defineChannelConfig;
+exports.defineLogHandler = defineLogHandler;
+exports.defineOfficeAccountServerHandler = defineOfficeAccountServerHandler;
+exports.defineMiniAppServerHandler = defineMiniAppServerHandler;
+exports.defineWorkServerHandler = defineWorkServerHandler;
+exports.defineOpenPlatformServerHandler = defineOpenPlatformServerHandler;
+exports.defineOpenWorkServerHandler = defineOpenWorkServerHandler;
+exports.defineChannelServerHandler = defineChannelServerHandler;
+exports.defineHttpClientFailureJudgeClosure = defineHttpClientFailureJudgeClosure;
+exports.definePaymentFailHandler = definePaymentFailHandler;
+exports.definePaymentAlertHandler = definePaymentAlertHandler;
+exports.definePaymentPaidHandler = definePaymentPaidHandler;
+exports.definePaymentRefundedHandler = definePaymentRefundedHandler;
+exports.definePaymentScannedHandler = definePaymentScannedHandler;
 const Application_1 = __importDefault(require("./OfficialAccount/Application"));
 exports.OfficialAccount = Application_1.default;
 const Application_2 = __importDefault(require("./MiniApp/Application"));
@@ -35,7 +55,6 @@ Object.defineProperty(exports, "PrivateKey", { enumerable: true, get: function (
 function defineOfficialAccountConfig(config) {
     return config;
 }
-exports.defineOfficialAccountConfig = defineOfficialAccountConfig;
 /**
  * 定义小程序配置
  * @param config
@@ -43,7 +62,6 @@ exports.defineOfficialAccountConfig = defineOfficialAccountConfig;
 function defineMiniAppConfig(config) {
     return config;
 }
-exports.defineMiniAppConfig = defineMiniAppConfig;
 /**
  * 定义支付配置
  * @param config
@@ -51,7 +69,6 @@ exports.defineMiniAppConfig = defineMiniAppConfig;
 function definePayConfig(config) {
     return config;
 }
-exports.definePayConfig = definePayConfig;
 /**
  * 定义开放平台配置
  * @param config
@@ -59,7 +76,6 @@ exports.definePayConfig = definePayConfig;
 function defineOpenPlatformConfig(config) {
     return config;
 }
-exports.defineOpenPlatformConfig = defineOpenPlatformConfig;
 /**
  * 定义企业微信配置
  * @param config
@@ -67,7 +83,6 @@ exports.defineOpenPlatformConfig = defineOpenPlatformConfig;
 function defineWorkConfig(config) {
     return config;
 }
-exports.defineWorkConfig = defineWorkConfig;
 /**
  * 定义企业微信开放平台配置
  * @param config
@@ -75,7 +90,6 @@ exports.defineWorkConfig = defineWorkConfig;
 function defineOpenWorkConfig(config) {
     return config;
 }
-exports.defineOpenWorkConfig = defineOpenWorkConfig;
 /**
  * 定义视频号配置
  * @param config
@@ -83,7 +97,6 @@ exports.defineOpenWorkConfig = defineOpenWorkConfig;
 function defineChannelConfig(config) {
     return config;
 }
-exports.defineChannelConfig = defineChannelConfig;
 /**
  * 定义日志处理函数
  * @param func
@@ -91,7 +104,6 @@ exports.defineChannelConfig = defineChannelConfig;
 function defineLogHandler(func) {
     return func;
 }
-exports.defineLogHandler = defineLogHandler;
 /**
  * 定义公众号服务端消息处理函数
  * @param func
@@ -99,7 +111,6 @@ exports.defineLogHandler = defineLogHandler;
 function defineOfficeAccountServerHandler(func) {
     return func;
 }
-exports.defineOfficeAccountServerHandler = defineOfficeAccountServerHandler;
 /**
  * 定义小程序服务端消息处理函数
  * @param func
@@ -107,7 +118,6 @@ exports.defineOfficeAccountServerHandler = defineOfficeAccountServerHandler;
 function defineMiniAppServerHandler(func) {
     return func;
 }
-exports.defineMiniAppServerHandler = defineMiniAppServerHandler;
 /**
  * 定义企业微信服务端消息处理函数
  * @param func
@@ -115,7 +125,6 @@ exports.defineMiniAppServerHandler = defineMiniAppServerHandler;
 function defineWorkServerHandler(func) {
     return func;
 }
-exports.defineWorkServerHandler = defineWorkServerHandler;
 /**
  * 定义开放平台服务端消息处理函数
  * @param func
@@ -123,7 +132,6 @@ exports.defineWorkServerHandler = defineWorkServerHandler;
 function defineOpenPlatformServerHandler(func) {
     return func;
 }
-exports.defineOpenPlatformServerHandler = defineOpenPlatformServerHandler;
 /**
  * 定义企业微信开放平台服务端消息处理函数
  * @param func
@@ -131,7 +139,6 @@ exports.defineOpenPlatformServerHandler = defineOpenPlatformServerHandler;
 function defineOpenWorkServerHandler(func) {
     return func;
 }
-exports.defineOpenWorkServerHandler = defineOpenWorkServerHandler;
 /**
  * 定义视频号服务端消息处理函数
  * @param func
@@ -139,7 +146,6 @@ exports.defineOpenWorkServerHandler = defineOpenWorkServerHandler;
 function defineChannelServerHandler(func) {
     return func;
 }
-exports.defineChannelServerHandler = defineChannelServerHandler;
 /**
  * 定义HttpClient错误判定回调
  * @param func
@@ -147,7 +153,6 @@ exports.defineChannelServerHandler = defineChannelServerHandler;
 function defineHttpClientFailureJudgeClosure(func) {
     return func;
 }
-exports.defineHttpClientFailureJudgeClosure = defineHttpClientFailureJudgeClosure;
 /**
  * 定义支付通知错误处理函数
  * @param func
@@ -155,7 +160,6 @@ exports.defineHttpClientFailureJudgeClosure = defineHttpClientFailureJudgeClosur
 function definePaymentFailHandler(func) {
     return func;
 }
-exports.definePaymentFailHandler = definePaymentFailHandler;
 /**
  * 定义支付业务错误处理函数
  * @param func
@@ -163,7 +167,6 @@ exports.definePaymentFailHandler = definePaymentFailHandler;
 function definePaymentAlertHandler(func) {
     return func;
 }
-exports.definePaymentAlertHandler = definePaymentAlertHandler;
 /**
  * 定义支付结果处理回调函数
  * @param func
@@ -171,7 +174,6 @@ exports.definePaymentAlertHandler = definePaymentAlertHandler;
 function definePaymentPaidHandler(func) {
     return func;
 }
-exports.definePaymentPaidHandler = definePaymentPaidHandler;
 /**
  * 定义退款结果处理回调函数
  * @param func
@@ -179,7 +181,6 @@ exports.definePaymentPaidHandler = definePaymentPaidHandler;
 function definePaymentRefundedHandler(func) {
     return func;
 }
-exports.definePaymentRefundedHandler = definePaymentRefundedHandler;
 /**
  * 定义扫码支付结果处理回调函数
  * @param func
@@ -187,4 +188,3 @@ exports.definePaymentRefundedHandler = definePaymentRefundedHandler;
 function definePaymentScannedHandler(func) {
     return func;
 }
-exports.definePaymentScannedHandler = definePaymentScannedHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "3.7.3",
+  "version": "3.7.5",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
@@ -22,19 +22,19 @@
     "node": ">=15.6.0"
   },
   "devDependencies": {
-    "@types/node": "^20.11.28",
+    "@types/node": "^20.14.15",
     "axios-mock-adapter": "^1.22.0",
     "mocha": "^9.2.2",
     "package-release": "^1.0.3",
-    "typescript": "^5.4.2"
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "axios": "^1.6.8",
-    "axios-retry": "^4.0.0",
+    "axios": "^1.7.4",
+    "axios-retry": "^4.5.0",
     "form-data": "^4.0.0",
     "merge": "^2.1.1",
     "node-socialite": "^1.4.1",
-    "qs": "^6.12.0",
+    "qs": "^6.13.0",
     "raw-body": "^2.5.2",
     "xml2js": "^0.6.2"
   }