node-easywechat 2.9.1 → 3.0.0-alpha.1

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":1650099715}

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

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "node-easywechat",
-  "version": "2.9.1",
+  "version": "3.0.0-alpha.1",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
-    "build": "rm -rf dist && npx tsc",
-    "docs": "rm -rf doc && npx typedoc --out docs --plugin typedoc-plugin-markdown ./src/",
-    "test": "npx mocha ./test/**/*.js"
+    "release": "npx package-release",
+    "build": "rm -rf dist && npx tsc && cp -r src/Types dist/",
+    "test": "npx mocha ./test/ --recursive --extension .test.js"
   },
   "repository": {
     "type": "git",
@@ -19,19 +19,19 @@
   "author": "Hpyer",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^17.0.8",
-    "mocha": "^9.2.0",
-    "sinon": "^12.0.1",
-    "typedoc": "^0.22.11",
-    "typedoc-plugin-markdown": "^3.11.9",
-    "typescript": "^4.5.4"
+    "@types/node": "^17.0.23",
+    "axios-mock-adapter": "^1.20.0",
+    "mocha": "^9.2.2",
+    "package-release": "^1.0.2",
+    "typescript": "^4.6.3"
   },
   "dependencies": {
-    "axios": "^0.24.0",
+    "axios": "^0.26.1",
     "form-data": "^4.0.0",
+    "merge": "^2.1.1",
     "node-socialite": "^1.2.5",
-    "qs": "^6.10.2",
-    "raw-body": "^2.4.2",
+    "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,46 +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.jssdk = null;
-        this.media = null;
-        this.qrcode = null;
-        this.url = null;
-        this.content_security = null;
-        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>;
-}

package/dist/BaseService/ContentSecurity/ContentSecurityClient.js

@@ -1,47 +0,0 @@
-'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 };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-class ContentSecurityClient extends BaseClient_1.default {
-    constructor() {
-        super(...arguments);
-        this.baseUrl = 'https://api.weixin.qq.com/wxa/';
-    }
-    /**
-     * 校验一段文本是否含有违法内容
-     * @param text 待校验文本
-     */
-    checkText(text) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.httpPostJson('msg_sec_check', {
-                content: text,
-            });
-        });
-    }
-    /**
-     * 校验一张图片是否含有敏感信息
-     * @param file 文件路径或可读stream
-     */
-    checkImage(file) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!file) {
-                throw new Error(`File does not exist, or the file is unreadable: '${file}'`);
-            }
-            return yield this.httpUpload('img_sec_check', {
-                media: file,
-            });
-        });
-    }
-}
-exports.default = ContentSecurityClient;

package/dist/BaseService/Jssdk/JssdkClient.d.ts

@@ -1,52 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class Client extends BaseClient {
-    protected url: string;
-    protected ticketEndpoint: string;
-    /**
-     * 获取签名凭证api_ticket
-     * @param refresh 是否强制刷新
-     * @param type 类型，默认：jsapi
-     */
-    getTicket(refresh?: boolean, type?: string): Promise<string>;
-    /**
-     * 获取JSSDK的配置
-     * @param jsApiList API列表
-     * @param debug 是否调试模式，默认：false
-     * @param beta 是否测试模式，默认：false
-     * @param json true时返回JSON字符串，默认：true
-     * @param openTagList 开放标签列表，默认：[]
-     * @param url 请求URL，默认：当前URL
-     */
-    buildConfig(jsApiList: Array<string>, debug?: Boolean, beta?: Boolean, json?: Boolean, openTagList?: Array<string>, url?: string): Promise<any>;
-    /**
-     * 获取JSSDK的配置对象
-     * @param jsApiList API列表
-     * @param debug 是否调试模式，默认：false
-     * @param beta 是否测试模式，默认：false
-     * @param openTagList 开放标签列表，默认：[]
-     * @param url 请求URL，默认：当前URL
-     */
-    getConfigArray(jsApiList: Array<string>, debug?: Boolean, beta?: Boolean, openTagList?: Array<string>, url?: string): Promise<any>;
-    /**
-     * 获取签名配置
-     * @param url 完整的URL地址
-     * @param nonce 随机字符串，默认：随机10位
-     * @param timestamp 时间戳，默认：当前时间
-     */
-    configSignature(url?: string, nonce?: string, timestamp?: string): Promise<object>;
-    protected getTicketSignature(ticket: string, nonce: string, timestamp: string, url: string): string;
-    protected dictionaryOrderSignature(args: Array<string>): string;
-    /**
-     * 设置当前URL
-     * @param url 完整的URL地址
-     */
-    setUrl(url: string): this;
-    /**
-     * 获取当前设置的URL
-     */
-    getUrl(): string;
-    /**
-     * 获取配置中的app_id
-     */
-    getAppId(): string;
-}