@hairy/wechat-jssdk 1.47.0 → 1.49.0

package/dist/index.cjs

@@ -1,277 +1,243 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let _hairy_utils = require("@hairy/utils");
 
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  WechatJssdk: () => WechatJssdk
-});
-module.exports = __toCommonJS(index_exports);
-
-// src/internal/load_script.ts
-var import_utils = require("@hairy/utils");
-function loadScript(source, onLoaded = import_utils.noop, options = {}) {
-  const {
-    type = "text/javascript",
-    async = true,
-    crossOrigin,
-    referrerPolicy,
-    noModule,
-    defer,
-    waitForScriptLoad = true
-  } = options;
-  return new Promise((resolve, reject) => {
-    let shouldAppend = false;
-    let element = document.querySelector(`script[src="${source}"]`);
-    if (!element) {
-      element = document.createElement("script");
-      element.type = type;
-      element.async = async;
-      element.src = source;
-      if (defer)
-        element.defer = defer;
-      if (crossOrigin)
-        element.crossOrigin = crossOrigin;
-      if (noModule)
-        element.noModule = noModule;
-      if (referrerPolicy)
-        element.referrerPolicy = referrerPolicy;
-      shouldAppend = true;
-    } else if (Object.hasOwn(element.dataset, "loaded")) {
-      resolve(element);
-    }
-    element.addEventListener("error", (event) => reject(event));
-    element.addEventListener("abort", (event) => reject(event));
-    element.addEventListener("load", () => {
-      element.dataset.loaded = "true";
-      onLoaded(element);
-      resolve(element);
-    });
-    if (shouldAppend)
-      element = document.head.appendChild(element);
-    if (!waitForScriptLoad)
-      resolve(element);
-  });
+//#region src/internal/load_script.ts
+function loadScript(source, onLoaded = _hairy_utils.noop, options = {}) {
+	const { type = "text/javascript", async = true, crossOrigin, referrerPolicy, noModule, defer, waitForScriptLoad = true } = options;
+	return new Promise((resolve, reject) => {
+		let shouldAppend = false;
+		let element = document.querySelector(`script[src="${source}"]`);
+		if (!element) {
+			element = document.createElement("script");
+			element.type = type;
+			element.async = async;
+			element.src = source;
+			if (defer) element.defer = defer;
+			if (crossOrigin) element.crossOrigin = crossOrigin;
+			if (noModule) element.noModule = noModule;
+			if (referrerPolicy) element.referrerPolicy = referrerPolicy;
+			shouldAppend = true;
+		} else if (Object.hasOwn(element.dataset, "loaded")) resolve(element);
+		element.addEventListener("error", (event) => reject(event));
+		element.addEventListener("abort", (event) => reject(event));
+		element.addEventListener("load", () => {
+			element.dataset.loaded = "true";
+			onLoaded(element);
+			resolve(element);
+		});
+		if (shouldAppend) element = document.head.appendChild(element);
+		if (!waitForScriptLoad) resolve(element);
+	});
 }
 
-// src/helper.ts
+//#endregion
+//#region src/helper.ts
+/**
+* jssdk 的前置处理类
+* @constructor 加载配置（apiHost，appId，config，version，jssdk）
+* @function implement 提供 wxApi 执行器（等待 config 与 ready 结束，在调用 api）
+* @function config 加载配置，提供 promise 式返回
+* @function ready wx.ready，提供 promise 式返回
+*/
 var WechatJssdkHelper = class {
-  version;
-  isReady = false;
-  requestConfig;
-  loadPromise;
-  configPromise;
-  readyPromise;
-  loadJssdk() {
-    const scriptUrl = `https://res.wx.qq.com/open/js/jweixin-${this.version}.js`;
-    this.loadPromise = loadScript(scriptUrl).then(() => {
-      this.loadPromise = void 0;
-    });
-  }
-  constructor(options) {
-    const { immediate = true, version, requestConfig } = options;
-    this.version = version || "1.3.0";
-    this.requestConfig = requestConfig;
-    this.loadJssdk();
-    if (immediate)
-      this.config();
-  }
-  async config() {
-    if (this.configPromise)
-      return this.configPromise;
-    if (this.loadPromise)
-      await this.loadPromise;
-    this.configPromise = (async () => {
-      wx.config(await this.requestConfig());
-    })();
-    return this.configPromise;
-  }
-  async ready() {
-    if (this.readyPromise)
-      return this.readyPromise;
-    if (this.loadPromise)
-      await this.loadPromise;
-    if (this.isReady)
-      return;
-    this.readyPromise = new Promise((resolve, reject) => {
-      wx.ready(() => {
-        this.isReady = true;
-        this.readyPromise = void 0;
-        resolve();
-      });
-      wx.error((error) => {
-        this.isReady = false;
-        this.readyPromise = void 0;
-        reject(error);
-      });
-    });
-    return this.readyPromise;
-  }
-  async error() {
-    return this.ready().catch((error) => error);
-  }
-  async implement(key, options) {
-    if (this.configPromise)
-      await this.configPromise;
-    await this.ready();
-    wx[key](options);
-  }
+	version;
+	isReady = false;
+	requestConfig;
+	loadPromise;
+	configPromise;
+	readyPromise;
+	loadJssdk() {
+		this.loadPromise = loadScript(`https://res.wx.qq.com/open/js/jweixin-${this.version}.js`).then(() => {
+			this.loadPromise = void 0;
+		});
+	}
+	constructor(options) {
+		const { immediate = true, version, requestConfig } = options;
+		this.version = version || "1.3.0";
+		this.requestConfig = requestConfig;
+		this.loadJssdk();
+		if (immediate) this.config();
+	}
+	async config() {
+		if (this.configPromise) return this.configPromise;
+		if (this.loadPromise) await this.loadPromise;
+		this.configPromise = (async () => {
+			wx.config(await this.requestConfig());
+		})();
+		return this.configPromise;
+	}
+	async ready() {
+		if (this.readyPromise) return this.readyPromise;
+		if (this.loadPromise) await this.loadPromise;
+		if (this.isReady) return;
+		this.readyPromise = new Promise((resolve, reject) => {
+			wx.ready(() => {
+				this.isReady = true;
+				this.readyPromise = void 0;
+				resolve();
+			});
+			wx.error((error) => {
+				this.isReady = false;
+				this.readyPromise = void 0;
+				reject(error);
+			});
+		});
+		return this.readyPromise;
+	}
+	async error() {
+		return this.ready().catch((error) => error);
+	}
+	async implement(key, options) {
+		if (this.configPromise) await this.configPromise;
+		await this.ready();
+		wx[key](options);
+	}
 };
 
-// src/index.ts
+//#endregion
+//#region src/index.ts
+/**
+* @description WechatJssdk Api 封装，与 [jssdk 文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html) 保持一致，主要以下改动
+* @description 内置请求，读取 config 配置，初始化自动调用 wx.config
+* @description 所有 api 的 promise 化处理（仅等待 wx.ready）
+* @description 简易化初始化构建，config 处理
+* @description 可指定加载 jssdk 版本（默认 1.3.0）
+* @template `const wxJssdk = new WechatJssdk({env, config})`
+*/
 var WechatJssdk = class extends WechatJssdkHelper {
-  constructor(options) {
-    super(options);
-  }
-  // --- 1.4.0 API start ---
-  updateAppMessageShareData(options) {
-    return this.implement("updateAppMessageShareData", options);
-  }
-  updateTimelineShareData(options) {
-    return this.implement("updateTimelineShareData", options);
-  }
-  // --- 1.4.0 API end ---
-  addCard() {
-    return this.implement("addCard");
-  }
-  checkJsApi(options) {
-    return this.implement("checkJsApi", options);
-  }
-  chooseCard(options) {
-    return this.implement("chooseCard", options);
-  }
-  chooseImage(options) {
-    return this.implement("chooseImage", options);
-  }
-  chooseWXPay(options) {
-    return this.implement("chooseWXPay", options);
-  }
-  closeWindow() {
-    return this.implement("closeWindow");
-  }
-  consumeAndShareCard(options) {
-    return this.implement("consumeAndShareCard", options);
-  }
-  downloadImage(options) {
-    return this.implement("downloadImage", options);
-  }
-  downloadVoice(options) {
-    return this.implement("downloadVoice", options);
-  }
-  getLocalImgData(options) {
-    return this.implement("getLocalImgData", options);
-  }
-  getLocation(options) {
-    return this.implement("getLocation", options);
-  }
-  getNetworkType(options) {
-    return this.implement("getNetworkType", options);
-  }
-  hideAllNonBaseMenuItem() {
-    return this.implement("hideAllNonBaseMenuItem");
-  }
-  hideMenuItems(options) {
-    return this.implement("hideMenuItems", options);
-  }
-  hideOptionMenu() {
-    return this.implement("hideOptionMenu");
-  }
-  onMenuShareAppMessage(options) {
-    return this.implement("onMenuShareAppMessage", options);
-  }
-  onMenuShareQQ(options) {
-    return this.implement("onMenuShareQQ", options);
-  }
-  onMenuShareQZone(options) {
-    return this.implement("onMenuShareQZone", options);
-  }
-  onMenuShareTimeline(options) {
-    return this.implement("onMenuShareTimeline", options);
-  }
-  onMenuShareWeibo(options) {
-    return this.implement("onMenuShareWeibo", options);
-  }
-  onSearchBeacons(options) {
-    return this.implement("onSearchBeacons", options);
-  }
-  onVoicePlayEnd(options) {
-    return this.implement("onVoicePlayEnd", options);
-  }
-  onVoiceRecordEnd(options) {
-    return this.implement("onVoiceRecordEnd", options);
-  }
-  openCard(options) {
-    return this.implement("openCard", options);
-  }
-  openLocation(options) {
-    return this.implement("openLocation", options);
-  }
-  openProductSpecificView(options) {
-    return this.implement("openProductSpecificView", options);
-  }
-  pauseVoice(options) {
-    return this.implement("pauseVoice", options);
-  }
-  playVoice(options) {
-    return this.implement("playVoice", options);
-  }
-  previewImage(options) {
-    return this.implement("previewImage", options);
-  }
-  scanQRCode(options) {
-    return this.implement("scanQRCode", options);
-  }
-  showAllNonBaseMenuItem() {
-    return this.implement("showAllNonBaseMenuItem");
-  }
-  showMenuItems(options) {
-    return this.implement("showMenuItems", options);
-  }
-  showOptionMenu() {
-    return this.implement("showOptionMenu");
-  }
-  startRecord() {
-    return this.implement("startRecord");
-  }
-  startSearchBeacons(options) {
-    return this.implement("startSearchBeacons", options);
-  }
-  stopRecord(options) {
-    return this.implement("stopRecord", options);
-  }
-  stopSearchBeacons(options) {
-    return this.implement("stopSearchBeacons", options);
-  }
-  stopVoice(options) {
-    return this.implement("stopVoice", options);
-  }
-  translateVoice(options) {
-    return this.implement("translateVoice", options);
-  }
-  uploadImage(options) {
-    return this.implement("uploadImage", options);
-  }
-  uploadVoice(options) {
-    return this.implement("uploadVoice", options);
-  }
+	constructor(options) {
+		super(options);
+	}
+	updateAppMessageShareData(options) {
+		return this.implement("updateAppMessageShareData", options);
+	}
+	updateTimelineShareData(options) {
+		return this.implement("updateTimelineShareData", options);
+	}
+	addCard() {
+		return this.implement("addCard");
+	}
+	checkJsApi(options) {
+		return this.implement("checkJsApi", options);
+	}
+	chooseCard(options) {
+		return this.implement("chooseCard", options);
+	}
+	chooseImage(options) {
+		return this.implement("chooseImage", options);
+	}
+	chooseWXPay(options) {
+		return this.implement("chooseWXPay", options);
+	}
+	closeWindow() {
+		return this.implement("closeWindow");
+	}
+	consumeAndShareCard(options) {
+		return this.implement("consumeAndShareCard", options);
+	}
+	downloadImage(options) {
+		return this.implement("downloadImage", options);
+	}
+	downloadVoice(options) {
+		return this.implement("downloadVoice", options);
+	}
+	getLocalImgData(options) {
+		return this.implement("getLocalImgData", options);
+	}
+	getLocation(options) {
+		return this.implement("getLocation", options);
+	}
+	getNetworkType(options) {
+		return this.implement("getNetworkType", options);
+	}
+	hideAllNonBaseMenuItem() {
+		return this.implement("hideAllNonBaseMenuItem");
+	}
+	hideMenuItems(options) {
+		return this.implement("hideMenuItems", options);
+	}
+	hideOptionMenu() {
+		return this.implement("hideOptionMenu");
+	}
+	onMenuShareAppMessage(options) {
+		return this.implement("onMenuShareAppMessage", options);
+	}
+	onMenuShareQQ(options) {
+		return this.implement("onMenuShareQQ", options);
+	}
+	onMenuShareQZone(options) {
+		return this.implement("onMenuShareQZone", options);
+	}
+	onMenuShareTimeline(options) {
+		return this.implement("onMenuShareTimeline", options);
+	}
+	onMenuShareWeibo(options) {
+		return this.implement("onMenuShareWeibo", options);
+	}
+	onSearchBeacons(options) {
+		return this.implement("onSearchBeacons", options);
+	}
+	onVoicePlayEnd(options) {
+		return this.implement("onVoicePlayEnd", options);
+	}
+	onVoiceRecordEnd(options) {
+		return this.implement("onVoiceRecordEnd", options);
+	}
+	openCard(options) {
+		return this.implement("openCard", options);
+	}
+	openLocation(options) {
+		return this.implement("openLocation", options);
+	}
+	openProductSpecificView(options) {
+		return this.implement("openProductSpecificView", options);
+	}
+	pauseVoice(options) {
+		return this.implement("pauseVoice", options);
+	}
+	playVoice(options) {
+		return this.implement("playVoice", options);
+	}
+	previewImage(options) {
+		return this.implement("previewImage", options);
+	}
+	scanQRCode(options) {
+		return this.implement("scanQRCode", options);
+	}
+	showAllNonBaseMenuItem() {
+		return this.implement("showAllNonBaseMenuItem");
+	}
+	showMenuItems(options) {
+		return this.implement("showMenuItems", options);
+	}
+	showOptionMenu() {
+		return this.implement("showOptionMenu");
+	}
+	startRecord() {
+		return this.implement("startRecord");
+	}
+	startSearchBeacons(options) {
+		return this.implement("startSearchBeacons", options);
+	}
+	stopRecord(options) {
+		return this.implement("stopRecord", options);
+	}
+	stopSearchBeacons(options) {
+		return this.implement("stopSearchBeacons", options);
+	}
+	stopVoice(options) {
+		return this.implement("stopVoice", options);
+	}
+	translateVoice(options) {
+		return this.implement("translateVoice", options);
+	}
+	uploadImage(options) {
+		return this.implement("uploadImage", options);
+	}
+	uploadVoice(options) {
+		return this.implement("uploadVoice", options);
+	}
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  WechatJssdk
-});
+
+//#endregion
+exports.WechatJssdk = WechatJssdk;

package/dist/index.d.cts

@@ -0,0 +1,117 @@
+import * as WxType from "jweixin";
+
+//#region src/types.d.ts
+declare module 'jweixin' {
+  type v4ApiMethod = 'updateTimelineShareData' | 'updateAppMessageShareData';
+  function config(config_: {
+    debug?: boolean | undefined;
+    appId: string;
+    timestamp: number;
+    nonceStr: string;
+    signature: string;
+    jsApiList: (WxType.ApiMethod | v4ApiMethod)[];
+  }): void;
+}
+declare global {
+  const wx: typeof WxType;
+}
+type WechatJssdkConfig = Omit<Parameters<typeof wx.config>[0], 'catch' | 'finally' | 'then'>;
+interface WechatJssdkOptions {
+  /**
+   * 初始化请求配置
+   */
+  requestConfig: () => Promise<WechatJssdkConfig> | WechatJssdkConfig;
+  /**
+   * 是否立即加载 config
+   *
+   * @default true
+   */
+  immediate?: boolean;
+  /**
+   * wechat-jssdk 版本
+   *
+   * @default 1.3.0
+   */
+  version?: '1.2.0' | '1.3.0' | '1.4.0' | '1.5.0' | '1.6.0';
+}
+//#endregion
+//#region src/helper.d.ts
+/**
+ * jssdk 的前置处理类
+ * @constructor 加载配置（apiHost，appId，config，version，jssdk）
+ * @function implement 提供 wxApi 执行器（等待 config 与 ready 结束，在调用 api）
+ * @function config 加载配置，提供 promise 式返回
+ * @function ready wx.ready，提供 promise 式返回
+ */
+declare class WechatJssdkHelper {
+  private version;
+  private isReady;
+  private requestConfig;
+  private loadPromise?;
+  private configPromise?;
+  private readyPromise?;
+  private loadJssdk;
+  constructor(options: WechatJssdkOptions);
+  config(): Promise<void>;
+  ready(): Promise<void>;
+  error(): Promise<any>;
+  protected implement<Key extends keyof typeof wx | string>(key: Key, options?: any): Promise<void>;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * @description WechatJssdk Api 封装，与 [jssdk 文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html) 保持一致，主要以下改动
+ * @description 内置请求，读取 config 配置，初始化自动调用 wx.config
+ * @description 所有 api 的 promise 化处理（仅等待 wx.ready）
+ * @description 简易化初始化构建，config 处理
+ * @description 可指定加载 jssdk 版本（默认 1.3.0）
+ * @template `const wxJssdk = new WechatJssdk({env, config})`
+ */
+declare class WechatJssdk extends WechatJssdkHelper {
+  constructor(options: WechatJssdkOptions);
+  updateAppMessageShareData(options: WxType.IonMenuShareAppMessage): Promise<void>;
+  updateTimelineShareData(options: WxType.IonMenuShareAppMessage): Promise<void>;
+  addCard(): Promise<void>;
+  checkJsApi(options: WxType.IcheckJsApi): Promise<void>;
+  chooseCard(options: WxType.IchooseCard): Promise<void>;
+  chooseImage(options: WxType.IchooseImage): Promise<void>;
+  chooseWXPay(options: WxType.IchooseWXPay): Promise<void>;
+  closeWindow(): Promise<void>;
+  consumeAndShareCard(options: WxType.IconsumeAndShareCard): Promise<void>;
+  downloadImage(options: WxType.IdownloadImage): Promise<void>;
+  downloadVoice(options: WxType.IupdownloadVoice): Promise<void>;
+  getLocalImgData(options: WxType.IgetLocalImgData): Promise<void>;
+  getLocation(options: WxType.IgetLocation): Promise<void>;
+  getNetworkType(options: WxType.IgetNetworkType): Promise<void>;
+  hideAllNonBaseMenuItem(): Promise<void>;
+  hideMenuItems(options: WxType.IhideMenuItems): Promise<void>;
+  hideOptionMenu(): Promise<void>;
+  onMenuShareAppMessage(options: WxType.IonMenuShareAppMessage): Promise<void>;
+  onMenuShareQQ(options: WxType.IonMenuShareQQ): Promise<void>;
+  onMenuShareQZone(options: WxType.IonMenuShareQZone): Promise<void>;
+  onMenuShareTimeline(options: WxType.IonMenuShareTimeline): Promise<void>;
+  onMenuShareWeibo(options: WxType.IonMenuShareWeibo): Promise<void>;
+  onSearchBeacons(options: WxType.IonSearchBeacons): Promise<void>;
+  onVoicePlayEnd(options: WxType.IonVoicePlayEnd): Promise<void>;
+  onVoiceRecordEnd(options: WxType.IonVoiceRecordEnd): Promise<void>;
+  openCard(options: WxType.IopenCard): Promise<void>;
+  openLocation(options: WxType.IopenLocation): Promise<void>;
+  openProductSpecificView(options: WxType.IopenProductSpecificView): Promise<void>;
+  pauseVoice(options: WxType.IplaypausestopVoice): Promise<void>;
+  playVoice(options: WxType.IplaypausestopVoice): Promise<void>;
+  previewImage(options: WxType.IpreviewImage): Promise<void>;
+  scanQRCode(options: WxType.IscanQRCode): Promise<void>;
+  showAllNonBaseMenuItem(): Promise<void>;
+  showMenuItems(options: WxType.IshowMenuItems): Promise<void>;
+  showOptionMenu(): Promise<void>;
+  startRecord(): Promise<void>;
+  startSearchBeacons(options: WxType.IstartSearchBeacons): Promise<void>;
+  stopRecord(options: WxType.IstopRecord): Promise<void>;
+  stopSearchBeacons(options: WxType.IstopSearchBeacons): Promise<void>;
+  stopVoice(options: WxType.IplaypausestopVoice): Promise<void>;
+  translateVoice(options: WxType.ItranslateVoice): Promise<void>;
+  uploadImage(options: WxType.IuploadImage): Promise<void>;
+  uploadVoice(options: WxType.IupdownloadVoice): Promise<void>;
+}
+//#endregion
+export { WechatJssdk };