miniprogram-platform 0.0.1-beta → 1.0.0

package/README.md

@@ -0,0 +1,103 @@
+# miniprogram-platform
+
+零依赖、极简的跨小程序平台检测工具。将各平台特有的全局变量（`wx`、`my`、`tt` 等）统一抽象为 `{ mp, name }`，方便跨小程序库的开发。
+
+## 安装
+
+```bash
+npm install miniprogram-platform
+```
+
+## 使用
+
+```js
+import { getPlatform } from 'miniprogram-platform';
+
+const platform = getPlatform();
+
+if (platform) {
+  console.log(platform.name); // "WeChat" | "Alipay" | "ByteDance" | ...
+  console.log(platform.mp);   // wx | my | tt | ...
+
+  // 直接调用平台 API，无需关心当前是哪个小程序环境
+  platform.mp.request({ url: 'https://api.example.com/data' });
+}
+```
+
+> **注意**：`getPlatform()` 在首次调用时完成检测并缓存结果，后续调用均为 O(1)。
+
+TypeScript 中可将 `mp` 断言为目标平台类型以获得完整的类型提示：
+
+```ts
+if (platform?.name === 'WeChat') {
+  const wx = platform.mp as typeof wx;
+  wx.login({ ... });  // 完整的类型推断与补全
+}
+```
+
+JavaScript 中可通过 JSDoc 达到同样效果：
+
+```js
+if (platform?.name === 'WeChat') {
+  /** @type {typeof wx} */
+  const wx = platform.mp;
+  wx.login({ ... });  // VSCode 中同样有类型提示
+}
+```
+
+## API
+
+### `getPlatform()`
+
+返回当前运行环境的平台信息，若不在任何小程序环境中则返回 `undefined`。
+
+```ts
+function getPlatform(): { mp: unknown; name: string } | undefined;
+```
+
+| 属性   | 类型      | 说明                                        |
+| ------ | --------- | ------------------------------------------- |
+| `mp`   | `unknown` | 平台全局 API 对象（如 `wx`、`my`、`tt` 等） |
+| `name` | `string`  | 平台名称                                    |
+
+## 支持的平台
+
+| 平台名称  | 全局对象 | 说明              |
+| --------- | -------- | ----------------- |
+| WeChat    | `wx`     | 微信小程序        |
+| Alipay    | `my`     | 支付宝小程序      |
+| QQ        | `qq`     | QQ 小程序         |
+| JD        | `jd`     | 京东小程序        |
+| Baidu     | `swan`   | 百度智能小程序    |
+| ByteDance | `tt`     | 抖音 / 飞书小程序 |
+| Kwai      | `ks`     | 快手小程序        |
+| Qihu      | `qh`     | 360 小程序        |
+| RedNote   | `xhs`    | 小红书小程序      |
+| UniApp    | `uni`    | UniApp 跨端框架   |
+| Taro      | `Taro`   | Taro 跨端框架     |
+
+检测逻辑：按优先级依次检查各平台的全局对象是否存在，并验证该对象是否具有 `request` 方法。匹配到第一个即返回，若全部未匹配则返回 `undefined`。
+
+## License
+
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/index.js

@@ -1,7 +1,25 @@
 'use strict';
 
-var platform = require('./platform.js');
+// @ts-nocheck
+const platform = { value: null };
+function getPlatform() {
+    if (platform.value !== null)
+        return platform.value;
+    const u = "undefined", f = "function", r = "request";
+    platform.value =
+        (typeof wx !== u && typeof (wx === null || wx === void 0 ? void 0 : wx[r]) === f && wx && { mp: wx, name: "WeChat" }) || // 微信
+            (typeof my !== u && typeof (my === null || my === void 0 ? void 0 : my[r]) === f && my && { mp: my, name: "Alipay" }) || // 支付宝
+            (typeof qq !== u && typeof (qq === null || qq === void 0 ? void 0 : qq[r]) === f && qq && { mp: qq, name: "QQ" }) || // QQ
+            (typeof jd !== u && typeof (jd === null || jd === void 0 ? void 0 : jd[r]) === f && jd && { mp: jd, name: "JD" }) || // 京东
+            (typeof swan !== u && typeof (swan === null || swan === void 0 ? void 0 : swan[r]) === f && swan && { mp: swan, name: "Baidu" }) || // 百度
+            (typeof tt !== u && typeof (tt === null || tt === void 0 ? void 0 : tt[r]) === f && tt && { mp: tt, name: "ByteDance" }) || // 抖音 | 飞书
+            (typeof ks !== u && typeof (ks === null || ks === void 0 ? void 0 : ks[r]) === f && ks && { mp: ks, name: "Kwai" }) || // 快手
+            (typeof qh !== u && typeof (qh === null || qh === void 0 ? void 0 : qh[r]) === f && qh && { mp: qh, name: "Qihu" }) || // 360
+            (typeof xhs !== u && typeof (xhs === null || xhs === void 0 ? void 0 : xhs[r]) === f && xhs && { mp: xhs, name: "RedNote" }) || // 小红书
+            (typeof uni !== u && typeof (uni === null || uni === void 0 ? void 0 : uni[r]) === f && uni && { mp: uni, name: "UniApp" }) || // UniApp
+            (typeof Taro !== u && typeof (Taro === null || Taro === void 0 ? void 0 : Taro[r]) === f && Taro && { mp: Taro, name: "Taro" }) || // Taro
+            undefined;
+    return platform.value;
+}
 
-
-
-exports.getPlatform = platform.getPlatform;
+exports.getPlatform = getPlatform;

package/dist/esm/index.js

@@ -1 +1,23 @@
-export { getPlatform } from './platform.js';
+// @ts-nocheck
+const platform = { value: null };
+function getPlatform() {
+    if (platform.value !== null)
+        return platform.value;
+    const u = "undefined", f = "function", r = "request";
+    platform.value =
+        (typeof wx !== u && typeof (wx === null || wx === void 0 ? void 0 : wx[r]) === f && wx && { mp: wx, name: "WeChat" }) || // 微信
+            (typeof my !== u && typeof (my === null || my === void 0 ? void 0 : my[r]) === f && my && { mp: my, name: "Alipay" }) || // 支付宝
+            (typeof qq !== u && typeof (qq === null || qq === void 0 ? void 0 : qq[r]) === f && qq && { mp: qq, name: "QQ" }) || // QQ
+            (typeof jd !== u && typeof (jd === null || jd === void 0 ? void 0 : jd[r]) === f && jd && { mp: jd, name: "JD" }) || // 京东
+            (typeof swan !== u && typeof (swan === null || swan === void 0 ? void 0 : swan[r]) === f && swan && { mp: swan, name: "Baidu" }) || // 百度
+            (typeof tt !== u && typeof (tt === null || tt === void 0 ? void 0 : tt[r]) === f && tt && { mp: tt, name: "ByteDance" }) || // 抖音 | 飞书
+            (typeof ks !== u && typeof (ks === null || ks === void 0 ? void 0 : ks[r]) === f && ks && { mp: ks, name: "Kwai" }) || // 快手
+            (typeof qh !== u && typeof (qh === null || qh === void 0 ? void 0 : qh[r]) === f && qh && { mp: qh, name: "Qihu" }) || // 360
+            (typeof xhs !== u && typeof (xhs === null || xhs === void 0 ? void 0 : xhs[r]) === f && xhs && { mp: xhs, name: "RedNote" }) || // 小红书
+            (typeof uni !== u && typeof (uni === null || uni === void 0 ? void 0 : uni[r]) === f && uni && { mp: uni, name: "UniApp" }) || // UniApp
+            (typeof Taro !== u && typeof (Taro === null || Taro === void 0 ? void 0 : Taro[r]) === f && Taro && { mp: Taro, name: "Taro" }) || // Taro
+            undefined;
+    return platform.value;
+}
+
+export { getPlatform };

package/dist/index.d.ts

@@ -1,6 +1,9 @@
-declare function getPlatform(): {
-    mp: unknown;
-    name: string;
+declare const platform: {
+    value: null | {
+        mp: unknown;
+        name: string;
+    };
 };
+declare function getPlatform(): NonNullable<typeof platform.value> | undefined;
 
 export { getPlatform };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "miniprogram-platform",
-  "version": "0.0.1-beta",
+  "version": "1.0.0",
   "license": "MIT",
   "author": "Xingzeng Bao",
-  "homepage": "",
-  "description": "",
+  "homepage": "https://github.com/baoxingzeng/miniprogram-platform",
+  "description": "Zero-dependency platform detection for mini-program ecosystems.",
   "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/dist/cjs/platform.js

@@ -1,23 +0,0 @@
-'use strict';
-
-// @ts-nocheck
-function getPlatform() {
-    let u = "undefined", f = "function", r = "request";
-    let platform;
-    platform =
-        (typeof wx !== u && typeof (wx === null || wx === void 0 ? void 0 : wx[r]) === f && wx && { mp: wx, name: "WeChat" }) || // 微信
-            (typeof my !== u && typeof (my === null || my === void 0 ? void 0 : my[r]) === f && my && { mp: my, name: "Alipay" }) || // 支付宝
-            (typeof qq !== u && typeof (qq === null || qq === void 0 ? void 0 : qq[r]) === f && qq && { mp: qq, name: "QQ" }) || // QQ
-            (typeof jd !== u && typeof (jd === null || jd === void 0 ? void 0 : jd[r]) === f && jd && { mp: jd, name: "JD" }) || // 京东
-            (typeof swan !== u && typeof (swan === null || swan === void 0 ? void 0 : swan[r]) === f && swan && { mp: swan, name: "Baidu" }) || // 百度
-            (typeof tt !== u && typeof (tt === null || tt === void 0 ? void 0 : tt[r]) === f && tt && { mp: tt, name: "ByteDance" }) || // 抖音 | 飞书
-            (typeof ks !== u && typeof (ks === null || ks === void 0 ? void 0 : ks[r]) === f && ks && { mp: ks, name: "Kwai" }) || // 快手
-            (typeof qh !== u && typeof (qh === null || qh === void 0 ? void 0 : qh[r]) === f && qh && { mp: qh, name: "Qihu" }) || // 360
-            (typeof xhs !== u && typeof (xhs === null || xhs === void 0 ? void 0 : xhs[r]) === f && xhs && { mp: xhs, name: "RedNote" }) || // 小红书
-            (typeof uni !== u && typeof (uni === null || uni === void 0 ? void 0 : uni[r]) === f && uni && { mp: uni, name: "UniApp" }) || // UniApp
-            (typeof Taro !== u && typeof (Taro === null || Taro === void 0 ? void 0 : Taro[r]) === f && Taro && { mp: Taro, name: "Taro" }) || // Taro
-            undefined;
-    return platform;
-}
-
-exports.getPlatform = getPlatform;

package/dist/esm/platform.js

@@ -1,21 +0,0 @@
-// @ts-nocheck
-function getPlatform() {
-    let u = "undefined", f = "function", r = "request";
-    let platform;
-    platform =
-        (typeof wx !== u && typeof (wx === null || wx === void 0 ? void 0 : wx[r]) === f && wx && { mp: wx, name: "WeChat" }) || // 微信
-            (typeof my !== u && typeof (my === null || my === void 0 ? void 0 : my[r]) === f && my && { mp: my, name: "Alipay" }) || // 支付宝
-            (typeof qq !== u && typeof (qq === null || qq === void 0 ? void 0 : qq[r]) === f && qq && { mp: qq, name: "QQ" }) || // QQ
-            (typeof jd !== u && typeof (jd === null || jd === void 0 ? void 0 : jd[r]) === f && jd && { mp: jd, name: "JD" }) || // 京东
-            (typeof swan !== u && typeof (swan === null || swan === void 0 ? void 0 : swan[r]) === f && swan && { mp: swan, name: "Baidu" }) || // 百度
-            (typeof tt !== u && typeof (tt === null || tt === void 0 ? void 0 : tt[r]) === f && tt && { mp: tt, name: "ByteDance" }) || // 抖音 | 飞书
-            (typeof ks !== u && typeof (ks === null || ks === void 0 ? void 0 : ks[r]) === f && ks && { mp: ks, name: "Kwai" }) || // 快手
-            (typeof qh !== u && typeof (qh === null || qh === void 0 ? void 0 : qh[r]) === f && qh && { mp: qh, name: "Qihu" }) || // 360
-            (typeof xhs !== u && typeof (xhs === null || xhs === void 0 ? void 0 : xhs[r]) === f && xhs && { mp: xhs, name: "RedNote" }) || // 小红书
-            (typeof uni !== u && typeof (uni === null || uni === void 0 ? void 0 : uni[r]) === f && uni && { mp: uni, name: "UniApp" }) || // UniApp
-            (typeof Taro !== u && typeof (Taro === null || Taro === void 0 ? void 0 : Taro[r]) === f && Taro && { mp: Taro, name: "Taro" }) || // Taro
-            undefined;
-    return platform;
-}
-
-export { getPlatform };