node-easywechat 2.9.3 → 3.0.0-alpha.1

package/dist/BaseService/Media/MediaClient.d.ts

@@ -1,57 +0,0 @@
-/// <reference types="node" />
-import BaseClient from '../../Core/BaseClient';
-import Stream from 'stream';
-export default class MediaClient extends BaseClient {
-    protected baseUrl: string;
-    protected allowTypes: Array<string>;
-    /**
-     * 上传图片到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadImage(file: string | Stream.Readable): Promise<any>;
-    /**
-     * 上传视频到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadVideo(file: string | Stream.Readable): Promise<any>;
-    /**
-     * 上传语音到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadVoice(file: string | Stream.Readable): Promise<any>;
-    /**
-     * 上传缩略图到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadThumb(file: string | Stream.Readable): Promise<any>;
-    /**
-     * 上传到临时素材
-     * @param type 类型，可选值：image,video,voice,thumb
-     * @param file 文件路径或可读stream
-     */
-    upload(type: string, file: string | Stream.Readable): Promise<any>;
-    /**
-     * 上传群发视频
-     * @param file 文件路径或可读stream
-     * @param title 标题
-     * @param description 描述
-     */
-    uploadVideoForBroadcasting(file: string | Stream.Readable, title: string, description: string): Promise<any>;
-    /**
-     * 创建群发消息
-     * @param media_id 上传视频得到 media_id
-     * @param title 标题
-     * @param description 描述
-     */
-    createVideoForBroadcasting(media_id: string, title: string, description: string): Promise<any>;
-    /**
-     * 获取临时素材内容
-     * @param media_id 上传视频得到 media_id
-     */
-    get(media_id: string): Promise<any>;
-    /**
-     * 获取 JSSDK 上传的高清语音
-     * @param media_id 上传视频得到 media_id
-     */
-    getJssdkMedia(media_id: string): Promise<any>;
-}

package/dist/BaseService/Media/MediaClient.js

@@ -1,151 +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"));
-const Utils_1 = require("../../Core/Utils");
-const StreamResponse_1 = __importDefault(require("../../Core/Http/StreamResponse"));
-class MediaClient extends BaseClient_1.default {
-    constructor() {
-        super(...arguments);
-        this.baseUrl = 'https://api.weixin.qq.com/cgi-bin/';
-        this.allowTypes = ['image', 'voice', 'video', 'thumb'];
-    }
-    /**
-     * 上传图片到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadImage(file) {
-        return this.upload('image', file);
-    }
-    /**
-     * 上传视频到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadVideo(file) {
-        return this.upload('video', file);
-    }
-    /**
-     * 上传语音到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadVoice(file) {
-        return this.upload('voice', file);
-    }
-    /**
-     * 上传缩略图到临时素材
-     * @param file 文件路径或可读stream
-     */
-    uploadThumb(file) {
-        return this.upload('thumb', file);
-    }
-    /**
-     * 上传到临时素材
-     * @param type 类型，可选值：image,video,voice,thumb
-     * @param file 文件路径或可读stream
-     */
-    upload(type, file) {
-        if (!file) {
-            throw new Error(`File does not exist, or the file is unreadable: '${file}'`);
-        }
-        if (!(0, Utils_1.inArray)(type, this.allowTypes)) {
-            throw new Error(`Unsupported media type: '${type}'`);
-        }
-        return this.httpUpload('media/upload', {
-            media: file
-        }, {}, {
-            type
-        });
-    }
-    /**
-     * 上传群发视频
-     * @param file 文件路径或可读stream
-     * @param title 标题
-     * @param description 描述
-     */
-    uploadVideoForBroadcasting(file, title, description) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let response = yield this.uploadVideo(file);
-            if (response['media_id']) {
-                return yield this.createVideoForBroadcasting(response['media_id'], title, description);
-            }
-            return response;
-        });
-    }
-    /**
-     * 创建群发消息
-     * @param media_id 上传视频得到 media_id
-     * @param title 标题
-     * @param description 描述
-     */
-    createVideoForBroadcasting(media_id, title, description) {
-        return this.httpPostJson('media/uploadvideo', {
-            media_id,
-            title,
-            description,
-        });
-    }
-    /**
-     * 获取临时素材内容
-     * @param media_id 上传视频得到 media_id
-     */
-    get(media_id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let res = yield this.requestRaw({
-                url: 'media/get',
-                method: 'GET',
-                params: {
-                    media_id,
-                }
-            });
-            if (res.getHeader('content-disposition').indexOf('attachment') > -1) {
-                return StreamResponse_1.default.buildFromResponse(res);
-            }
-            let content = res.getContent();
-            if (typeof content === 'string') {
-                try {
-                    content = JSON.parse(content);
-                }
-                catch (e) { }
-            }
-            return content;
-        });
-    }
-    /**
-     * 获取 JSSDK 上传的高清语音
-     * @param media_id 上传视频得到 media_id
-     */
-    getJssdkMedia(media_id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let res = yield this.requestRaw({
-                url: 'media/get/jssdk',
-                method: 'GET',
-                params: {
-                    media_id,
-                }
-            });
-            if (res.getHeader('content-disposition').indexOf('attachment') > -1) {
-                return StreamResponse_1.default.buildFromResponse(res);
-            }
-            let content = res.getContent();
-            if (typeof content === 'string') {
-                try {
-                    content = JSON.parse(content);
-                }
-                catch (e) { }
-            }
-            return content;
-        });
-    }
-}
-exports.default = MediaClient;

package/dist/BaseService/Qrcode/QrcodeClient.d.ts

@@ -1,28 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class QrcodeClient extends BaseClient {
-    DAY: number;
-    SCENE_MAX_VALUE: number;
-    SCENE_QR_CARD: string;
-    SCENE_QR_TEMPORARY: string;
-    SCENE_QR_TEMPORARY_STR: string;
-    SCENE_QR_FOREVER: string;
-    SCENE_QR_FOREVER_STR: string;
-    protected baseUrl: string;
-    /**
-     * 创建临时二维码
-     * @param sceneValue 业务标识
-     * @param expireSeconds 有效时间，单位：秒
-     */
-    temporary(sceneValue: any, expireSeconds?: number): Promise<any>;
-    /**
-     * 创建永久二维码
-     * @param sceneValue 业务标识
-     */
-    forever(sceneValue: any): Promise<any>;
-    /**
-     * 获取二维码地址
-     * @param ticket 通过temporary或forever方法获得
-     */
-    url(ticket: string): string;
-    protected create(actionName: string, actionInfo: any, temporary?: Boolean, expireSeconds?: number): Promise<any>;
-}

package/dist/BaseService/Qrcode/QrcodeClient.js

@@ -1,79 +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 BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-class QrcodeClient extends BaseClient_1.default {
-    constructor() {
-        super(...arguments);
-        this.DAY = 86400;
-        this.SCENE_MAX_VALUE = 100000;
-        this.SCENE_QR_CARD = 'QR_CARD';
-        this.SCENE_QR_TEMPORARY = 'QR_SCENE';
-        this.SCENE_QR_TEMPORARY_STR = 'QR_STR_SCENE';
-        this.SCENE_QR_FOREVER = 'QR_LIMIT_SCENE';
-        this.SCENE_QR_FOREVER_STR = 'QR_LIMIT_STR_SCENE';
-        this.baseUrl = 'https://api.weixin.qq.com/cgi-bin/';
-    }
-    /**
-     * 创建临时二维码
-     * @param sceneValue 业务标识
-     * @param expireSeconds 有效时间，单位：秒
-     */
-    temporary(sceneValue, expireSeconds = 0) {
-        let type = '', sceneKey = '';
-        if (typeof sceneValue == 'number' && sceneValue > 0) {
-            type = this.SCENE_QR_TEMPORARY;
-            sceneKey = 'scene_id';
-        }
-        else {
-            type = this.SCENE_QR_TEMPORARY_STR;
-            sceneKey = 'scene_str';
-        }
-        let scene = {};
-        scene[sceneKey] = sceneValue;
-        return this.create(type, scene, true, expireSeconds);
-    }
-    /**
-     * 创建永久二维码
-     * @param sceneValue 业务标识
-     */
-    forever(sceneValue) {
-        let type = '', sceneKey = '';
-        if (typeof sceneValue == 'number' && sceneValue > 0) {
-            type = this.SCENE_QR_FOREVER;
-            sceneKey = 'scene_id';
-        }
-        else {
-            type = this.SCENE_QR_FOREVER_STR;
-            sceneKey = 'scene_str';
-        }
-        let scene = {};
-        scene[sceneKey] = sceneValue;
-        return this.create(type, scene, false);
-    }
-    /**
-     * 获取二维码地址
-     * @param ticket 通过temporary或forever方法获得
-     */
-    url(ticket) {
-        return `https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=${ticket}`;
-    }
-    create(actionName, actionInfo, temporary = true, expireSeconds = 0) {
-        if (!expireSeconds || expireSeconds <= 0) {
-            expireSeconds = 7 * this.DAY;
-        }
-        let params = {
-            action_name: actionName,
-            action_info: {
-                scene: actionInfo,
-            },
-        };
-        if (temporary) {
-            params['expire_seconds'] = Math.min(expireSeconds, 30 * this.DAY);
-        }
-        return this.httpPostJson('qrcode/create', params);
-    }
-}
-exports.default = QrcodeClient;

package/dist/BaseService/Url/UrlClient.d.ts

@@ -1,9 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class UrlClient extends BaseClient {
-    protected baseUri: string;
-    /**
-     * 获取短网址
-     * @param long_url 原始URL地址
-     */
-    shorten(long_url: string): Promise<any>;
-}

package/dist/BaseService/Url/UrlClient.js

@@ -1,24 +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 BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-class UrlClient extends BaseClient_1.default {
-    constructor() {
-        super(...arguments);
-        this.baseUri = 'https://api.weixin.qq.com/';
-    }
-    /**
-     * 获取短网址
-     * @param long_url 原始URL地址
-     */
-    shorten(long_url) {
-        let data = {
-            action: 'long2short',
-            long_url
-        };
-        return this.httpPostJson('cgi-bin/shorturl', data);
-    }
-}
-exports.default = UrlClient;

package/dist/Core/BaseAccessToken.d.ts

@@ -1,89 +0,0 @@
-import BaseApplication from './BaseApplication';
-import HttpMixin from './Mixins/HttpMixin';
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-/**
- * 授权后的AccessToken对象
- */
-export declare class AccessToken {
-    /**
-     * 网页授权接口调用凭证
-     */
-    access_token: string;
-    /**
-     * 调用凭证的超时时间，单位（秒）
-     */
-    expires_in: number;
-    /**
-     * 刷新access_token
-     */
-    refresh_token: string;
-    /**
-     * 用户唯一标识，openid
-     */
-    openid: string;
-    /**
-     * 授权的作用域
-     */
-    scope: string;
-    constructor(info?: object);
-    /**
-     * 获取access_token
-     */
-    getToken(): string | Promise<string>;
-    /**
-     * 获取access_token
-     */
-    getAccessToken(): string;
-    /**
-     * 获取过期时间
-     */
-    getExpires(): number;
-    /**
-     * 获取refresh_token
-     */
-    getRefreshToken(): string;
-    /**
-     * 获取openid
-     */
-    getOpenid(): string;
-    /**
-     * 获取scope
-     */
-    getScope(): string;
-}
-declare abstract class BaseAccessToken implements HttpMixin {
-    protected requestMethod: string;
-    protected token: string;
-    protected queryName: string;
-    protected tokenKey: string;
-    protected endpointToGetToken: string;
-    protected app: BaseApplication;
-    constructor(app: BaseApplication);
-    protected getCredentials(): Promise<object>;
-    getEndpoint(): Promise<string>;
-    getCacheKey(): Promise<string>;
-    requestToken(credentials: object): Promise<any>;
-    /**
-     * 获取Token
-     * @param refresh 为true时表示强制刷新
-     */
-    getToken(refresh?: boolean): Promise<AccessToken>;
-    /**
-     * 设置Token
-     * @param access_token AccessToken
-     * @param expires_in 有效时间，单位：秒
-     */
-    setToken(access_token: string, expires_in?: number): Promise<this>;
-    /**
-     * 刷新Token
-     */
-    refresh(): Promise<this>;
-    /**
-     * 获取刷新后的Token
-     */
-    getRefreshedToken(): Promise<AccessToken>;
-    getTokenKey(): string;
-    applyToRequest(payload: AxiosRequestConfig): Promise<object>;
-    doRequest(payload: AxiosRequestConfig): Promise<AxiosResponse<any>>;
-}
-export default BaseAccessToken;

package/dist/Core/BaseAccessToken.js

@@ -1,206 +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 });
-exports.AccessToken = void 0;
-const HttpMixin_1 = __importDefault(require("./Mixins/HttpMixin"));
-const Utils_1 = require("./Utils");
-/**
- * 授权后的AccessToken对象
- */
-class AccessToken {
-    constructor(info = null) {
-        /**
-         * 网页授权接口调用凭证
-         */
-        this.access_token = '';
-        /**
-         * 调用凭证的超时时间，单位（秒）
-         */
-        this.expires_in = 0;
-        /**
-         * 刷新access_token
-         */
-        this.refresh_token = '';
-        /**
-         * 用户唯一标识，openid
-         */
-        this.openid = '';
-        /**
-         * 授权的作用域
-         */
-        this.scope = null;
-        if (info) {
-            this.access_token = info['access_token'] || info['accessToken'] || '';
-            this.expires_in = info['expires_in'] || info['expiresIn'] || 0;
-            this.refresh_token = info['refresh_token'] || info['refreshToken'] || '';
-            this.openid = info['openid'] || '';
-            this.scope = info['scope'] || '';
-        }
-    }
-    /**
-     * 获取access_token
-     */
-    getToken() {
-        return this.access_token;
-    }
-    /**
-     * 获取access_token
-     */
-    getAccessToken() {
-        return this.access_token;
-    }
-    /**
-     * 获取过期时间
-     */
-    getExpires() {
-        return this.expires_in;
-    }
-    /**
-     * 获取refresh_token
-     */
-    getRefreshToken() {
-        return this.refresh_token;
-    }
-    /**
-     * 获取openid
-     */
-    getOpenid() {
-        return this.openid;
-    }
-    /**
-     * 获取scope
-     */
-    getScope() {
-        return this.scope;
-    }
-}
-exports.AccessToken = AccessToken;
-;
-class BaseAccessToken {
-    constructor(app) {
-        this.requestMethod = 'GET';
-        this.token = '';
-        this.queryName = '';
-        this.tokenKey = 'access_token';
-        this.endpointToGetToken = '';
-        this.app = null;
-        this.app = app;
-    }
-    getCredentials() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return {};
-        });
-    }
-    getEndpoint() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.endpointToGetToken) {
-                throw new Error('Unset the endpoint of AccessToken');
-            }
-            return this.endpointToGetToken;
-        });
-    }
-    getCacheKey() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return 'easywechat.kernel.access_token.' + (0, Utils_1.createHash)(JSON.stringify(yield this.getCredentials()), 'md5');
-        });
-    }
-    requestToken(credentials) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let payload = {
-                url: yield this.getEndpoint(),
-                method: this.requestMethod,
-            };
-            if (this.requestMethod == 'POST') {
-                payload.data = credentials;
-            }
-            else {
-                payload.params = credentials;
-            }
-            let response = yield this.doRequest(payload);
-            return response.data;
-        });
-    }
-    ;
-    /**
-     * 获取Token
-     * @param refresh 为true时表示强制刷新
-     */
-    getToken(refresh = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let cacheKey = yield this.getCacheKey();
-            let cache = this.app.getCache();
-            if (!refresh && (yield cache.has(cacheKey))) {
-                let token = yield cache.get(cacheKey);
-                if (token)
-                    return new AccessToken(token);
-            }
-            let res = yield this.requestToken(yield this.getCredentials());
-            yield this.setToken(res, res.expires_in || 7200);
-            return res;
-        });
-    }
-    /**
-     * 设置Token
-     * @param access_token AccessToken
-     * @param expires_in 有效时间，单位：秒
-     */
-    setToken(access_token, expires_in = 7200) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let cacheKey = yield this.getCacheKey();
-            let cache = this.app.getCache();
-            yield cache.set(cacheKey, access_token, expires_in);
-            if (!cache.has(cacheKey)) {
-                throw new Error('Failed to cache access token.');
-            }
-            return this;
-        });
-    }
-    ;
-    /**
-     * 刷新Token
-     */
-    refresh() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.getToken(true);
-            return this;
-        });
-    }
-    /**
-     * 获取刷新后的Token
-     */
-    getRefreshedToken() {
-        return this.getToken(true);
-    }
-    getTokenKey() {
-        return this.tokenKey;
-    }
-    applyToRequest(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            payload.params = payload.params || {};
-            if (!payload.params[this.queryName || this.tokenKey]) {
-                payload.params[this.queryName || this.tokenKey] = (yield this.getToken())[this.tokenKey];
-            }
-            return payload;
-        });
-    }
-    // Rewrite by HttpMixin
-    doRequest(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return null;
-        });
-    }
-}
-;
-(0, Utils_1.applyMixins)(BaseAccessToken, [HttpMixin_1.default]);
-exports.default = BaseAccessToken;