@hylid/env 2.12.0-alpha.18

package/README.md

@@ -0,0 +1,17 @@
+# @hylid/env
+
+## Install
+
+```bash
+npm i @hylid/env --save
+```
+
+## API
+
+```ts
+import { getAppEnv, getPlatformEnv, getAppName, getPlatformName, APP, PLATFORM } from '@hylid/env';
+```
+
+## License
+
+MIT

package/lib/checker/index.d.ts

@@ -0,0 +1,3 @@
+export { mpChecker } from './mp';
+export { mpWebChecker } from './mpWeb';
+export { webChecker } from './web';

package/lib/checker/index.js

@@ -0,0 +1,3 @@
+export { mpChecker } from "./mp";
+export { mpWebChecker } from "./mpWeb";
+export { webChecker } from "./web";

package/lib/checker/mp.d.ts

@@ -0,0 +1,2 @@
+import { Checker } from '../types';
+export declare const mpChecker: Checker[];

package/lib/checker/mp.js

@@ -0,0 +1,23 @@
+import { CLIENT } from "../constants";
+export var mpChecker = [{
+  name: CLIENT.DEMO,
+  match: [/demo/i]
+}, {
+  name: CLIENT.ALIPAY,
+  match: [/alipay/i]
+}, {
+  name: CLIENT.ALIPAYHK,
+  match: [/hk/i]
+}, {
+  name: CLIENT.TNGD,
+  match: [/tngd/i]
+}, {
+  name: CLIENT.GCASH,
+  match: [/gcash/i]
+}, {
+  name: CLIENT.TRUEMONEY,
+  match: [/tmn/i]
+}, {
+  name: CLIENT.DANA,
+  match: [/dana/i]
+}];

package/lib/checker/mpWeb.d.ts

@@ -0,0 +1,2 @@
+import { Checker } from '../types';
+export declare const mpWebChecker: Checker[];

package/lib/checker/mpWeb.js

@@ -0,0 +1,13 @@
+import { CLIENT, HAVE_GRIVER, HAVE_MINIPROGRAM, NO_GRIVER } from "../constants";
+export var mpWebChecker = [{
+  name: CLIENT.DEMO,
+  match: [/alipayIDE/i] // IDE 识别为 demo
+}, {
+  name: CLIENT.ALIPAY,
+  match: [HAVE_MINIPROGRAM, NO_GRIVER, /alipay/i]
+},
+// TODO: A+ 钱包套壳 UA 待真机测试后补充
+{
+  name: CLIENT.DEMO,
+  match: [HAVE_MINIPROGRAM, HAVE_GRIVER]
+}];

package/lib/checker/web.d.ts

@@ -0,0 +1,2 @@
+import { Checker } from '../types';
+export declare const webChecker: Checker[];

package/lib/checker/web.js

@@ -0,0 +1,35 @@
+import { CLIENT, NO_MINIPROGRAM, NO_GRIVER, HAVE_GRIVER } from "../constants";
+export var webChecker = [{
+  name: CLIENT.ALIPAY,
+  match: [NO_MINIPROGRAM, NO_GRIVER, /AlipayClient/i]
+}, {
+  name: CLIENT.ALIPAYHK,
+  match: [NO_MINIPROGRAM, NO_GRIVER, /AlipayClientHK/i]
+}, {
+  name: CLIENT.TNGD,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /TNGKit|Touch 'n Go/i]
+}, {
+  name: CLIENT.TNGD_H5NG,
+  match: [NO_MINIPROGRAM, /TNGKit|Touch 'n Go/i, /IAPWebH5NG/i]
+}, {
+  name: CLIENT.GCASH,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /GCash/i]
+}, {
+  name: CLIENT.TRUEMONEY,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /TrueMoney/i]
+}, {
+  name: CLIENT.KAKAOPAY,
+  match: [NO_MINIPROGRAM, /PAYCLIENT|KAKAOTALK|KAKAOPAY/i]
+}, {
+  name: CLIENT.KAKAOTALK,
+  match: [NO_MINIPROGRAM, /ALIPAYCONNECT_KAKAO_TALK/i]
+}, {
+  name: CLIENT.NAVERPAY,
+  match: [NO_MINIPROGRAM, /NAVER/i]
+}, {
+  name: CLIENT.MPAY,
+  match: [NO_MINIPROGRAM, /mpay|macaupay/i]
+}, {
+  name: CLIENT.TOSSPAY,
+  match: [NO_MINIPROGRAM, /Toss/i]
+}];

package/lib/constants.d.ts

@@ -0,0 +1,35 @@
+export declare const PLATFORM: {
+    WEB: string;
+    MPWEB: string;
+    MP: string;
+};
+export declare const CLIENT: {
+    DEMO: string;
+    ALIPAY: string;
+    ALIPAYHK: string;
+    TNGD: string;
+    GCASH: string;
+    TRUEMONEY: string;
+    DANA: string;
+    KAKAOPAY: string;
+    KAKAOTALK: string;
+    NAVERPAY: string;
+    MPAY: string;
+    TOSSPAY: string;
+    HIPAY: string;
+    CHOPE: string;
+    VODAPAY: string;
+    CHANGIPAY: string;
+    OCBC: string;
+    MANDIRI: string;
+    NAYAPAY: string;
+    TINABA: string;
+    KASPI: string;
+    H5: string;
+    WECHAT: string;
+    TNGD_H5NG: string;
+};
+export declare const HAVE_MINIPROGRAM: RegExp;
+export declare const NO_MINIPROGRAM: RegExp;
+export declare const HAVE_GRIVER: RegExp;
+export declare const NO_GRIVER: RegExp;

package/lib/constants.js

@@ -0,0 +1,36 @@
+export var PLATFORM = {
+  WEB: 'web',
+  MPWEB: 'mpweb',
+  MP: 'mp'
+};
+// bridge 下面新增加客户端时，文件夹名称和配置名称需要和这里保持对齐
+export var CLIENT = {
+  DEMO: 'demo',
+  ALIPAY: 'alipay',
+  ALIPAYHK: 'alipayhk',
+  TNGD: 'tngd',
+  GCASH: 'gcash',
+  TRUEMONEY: 'truemoney',
+  DANA: 'dana',
+  KAKAOPAY: 'kakaopay',
+  KAKAOTALK: 'kakaotalk',
+  NAVERPAY: 'naverpay',
+  MPAY: 'mpay',
+  TOSSPAY: 'toss',
+  HIPAY: 'hipay',
+  CHOPE: 'chope',
+  VODAPAY: 'vodapay',
+  CHANGIPAY: 'changipay',
+  OCBC: 'ocbc',
+  MANDIRI: 'mandiri',
+  NAYAPAY: 'nayapay',
+  TINABA: 'tinaba',
+  KASPI: 'kaspi',
+  H5: 'h5',
+  WECHAT: 'wechat',
+  TNGD_H5NG: 'tngdh5ng'
+};
+export var HAVE_MINIPROGRAM = /miniprogram/i;
+export var NO_MINIPROGRAM = /^((?!miniprogram).)*$/i;
+export var HAVE_GRIVER = /griver/i;
+export var NO_GRIVER = /^((?!griver).)*$/i;

package/lib/getClientName/getName4Mp.d.ts

@@ -0,0 +1 @@
+export declare function getName4MP(): string | undefined;

package/lib/getClientName/getName4Mp.js

@@ -0,0 +1,11 @@
+import { mpChecker } from "../checker";
+import { CLIENT } from "../constants";
+import { getMatchName, isNotMP } from "../utils";
+export function getName4MP() {
+  // 微信小程序
+  // @ts-ignore
+  if (typeof wx !== 'undefined') return CLIENT.WECHAT;
+  // 支付宝系小程序
+  if (isNotMP()) return;
+  return getMatchName(mpChecker, my.getSystemInfoSync().app);
+}

package/lib/getClientName/getName4MpWeb.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 1. 优先从 URL 解析 __app__
+ * 2. 其次从 Storage 解析 __app__
+ * 3. 再之解析 userAgent
+ */
+export declare function getName4MpWeb(): string | undefined;

package/lib/getClientName/getName4MpWeb.js

@@ -0,0 +1,20 @@
+import { mpChecker, mpWebChecker } from "../checker";
+import { CLIENT } from "../constants";
+import { getMatchName, getUrlClientName, getStorageClientName } from "../utils";
+/**
+ * 1. 优先从 URL 解析 __app__
+ * 2. 其次从 Storage 解析 __app__
+ * 3. 再之解析 userAgent
+ */
+export function getName4MpWeb() {
+  var appName = getUrlClientName() || getStorageClientName();
+  if (appName) {
+    // 如果 hylid-bridge 的 client 枚举值找到了 app，则优先用 hylid-bridge 的
+    if (Object.keys(CLIENT).find(function (i) {
+      return CLIENT[i] === appName;
+    })) return appName;
+    // 套壳的 __app__ 参数，一般是壳子拼的，值从 getSystemInfoSync 取的，所以使用 mpChecker
+    return getMatchName(mpChecker, appName);
+  }
+  return getMatchName(mpWebChecker, window.navigator.userAgent);
+}

package/lib/getClientName/getName4Web.d.ts

@@ -0,0 +1 @@
+export declare function getName4Web(): string | undefined;

package/lib/getClientName/getName4Web.js

@@ -0,0 +1,16 @@
+import { webChecker, mpChecker } from "../checker";
+import { CLIENT } from "../constants";
+import { getMatchName, getUrlClientName, getStorageClientName } from "../utils";
+export function getName4Web() {
+  var appName = getUrlClientName() || getStorageClientName();
+  // 无法识别的，可以手动指定 __app__ 参数
+  if (appName) {
+    // 如果 hylid-bridge 的 client 枚举值找到了 app，则优先用 hylid-bridge 的
+    if (Object.keys(CLIENT).find(function (i) {
+      return CLIENT[i] === appName;
+    })) return appName;
+    // 指定的 __app__ 和小程序返回值对齐
+    return getMatchName(mpChecker, appName);
+  }
+  return getMatchName(webChecker, window.navigator.userAgent) || CLIENT.H5;
+}

package/lib/getClientName/index.d.ts

@@ -0,0 +1,3 @@
+export { getName4MP } from './getName4Mp';
+export { getName4MpWeb } from './getName4MpWeb';
+export { getName4Web } from './getName4Web';

package/lib/getClientName/index.js

@@ -0,0 +1,3 @@
+export { getName4MP } from "./getName4Mp";
+export { getName4MpWeb } from "./getName4MpWeb";
+export { getName4Web } from "./getName4Web";

package/lib/index.d.ts

@@ -0,0 +1,13 @@
+import { ClientEnv, PlatformEnv } from './types';
+declare let client: string | undefined;
+declare let platform: string | undefined;
+interface CustomEnv {
+    client?: string;
+    platform?: string;
+}
+export declare function customEnv(config: CustomEnv | ((env: CustomEnv) => CustomEnv)): void;
+declare const clientEnv: ClientEnv;
+declare const platformEnv: PlatformEnv;
+export { CLIENT, PLATFORM } from './constants';
+export { client, platform, clientEnv, platformEnv };
+export type { ClientEnv, PlatformEnv, CustomEnv };

package/lib/index.js

@@ -0,0 +1,51 @@
+import { createCommonEnv, notice } from "./utils";
+import { getName4MP, getName4MpWeb, getName4Web } from "./getClientName";
+import { CLIENT, PLATFORM } from "./constants";
+var client;
+var platform;
+/**
+ * 优先判断小程序，根据 my.SDKVersion 是否存在进行判断
+ * 其次判断套壳 H5，根据 UA 是否存在 miniprogram 字段进行判断
+ * 再者判断端内 H5，UA 不存在 miniprogram 且含有钱包特征值进行判断
+ * 不满足上面的条件时，判断为端外 H5
+ */
+// 小程序
+client = getName4MP();
+if (client) {
+  platform = PLATFORM.MP;
+} else {
+  // 套壳 H5
+  client = getName4MpWeb();
+  if (client) {
+    platform = PLATFORM.MPWEB;
+  } else {
+    // 端内/端外 H5
+    client = getName4Web();
+    if (client) {
+      platform = PLATFORM.WEB;
+    }
+  }
+}
+if (!platform) {
+  notice('Cannot identify your client.');
+}
+export function customEnv(config) {
+  var custom = typeof config === 'function' ? config({
+    client: client,
+    platform: platform
+  }) : config;
+  if (custom.client) {
+    client = custom.client;
+    // @ts-ignore
+    clientEnv["is".concat(client.toUpperCase())] = true;
+  }
+  if (custom.platform) {
+    platform = custom.platform;
+    // @ts-ignore
+    platformEnv["is".concat(platform.toUpperCase())] = true;
+  }
+}
+var clientEnv = createCommonEnv(CLIENT, client);
+var platformEnv = createCommonEnv(PLATFORM, platform);
+export { CLIENT, PLATFORM } from "./constants";
+export { client, platform, clientEnv, platformEnv };

package/lib/types.d.ts

@@ -0,0 +1,14 @@
+import { CLIENT, PLATFORM } from './constants';
+export interface Checker {
+    name: string;
+    match: RegExp[];
+}
+declare type isClientEnv = `is${keyof typeof CLIENT}`;
+declare type isPlatformEnv = `is${keyof typeof PLATFORM}`;
+export declare type ClientEnv = {
+    [key in isClientEnv]: boolean;
+};
+export declare type PlatformEnv = {
+    [key in isPlatformEnv]: boolean;
+};
+export {};

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/lib/utils.d.ts

@@ -0,0 +1,7 @@
+import { Checker } from './types';
+export declare function isNotMP(): boolean;
+export declare function getMatchName(checks: Checker[], pattern: string): string | undefined;
+export declare function createCommonEnv<T>(source: Record<string, string>, current?: string): T;
+export declare function notice(text: string): void;
+export declare function getUrlClientName(): string;
+export declare function getStorageClientName(): string | null;

package/lib/utils.js

@@ -0,0 +1,39 @@
+export function isNotMP() {
+  // 小程序一定有 my
+  if (typeof my == 'undefined') return true;
+  // SDKVersion 只在小程序有
+  if (typeof my.SDKVersion !== 'string') return true;
+  return false;
+}
+export function getMatchName(checks, pattern) {
+  var matches = checks.filter(function (check) {
+    return check.match.every(function (reg) {
+      return reg.test(pattern);
+    });
+  });
+  if (!matches.length) return;
+  var defaultName = matches[0].name;
+  if (matches.length > 1) {
+    var matchedName = matches.map(function (i) {
+      return i.name;
+    }).join(',');
+    notice("Multiple clients have been identified\uFF08".concat(matchedName, "\uFF09, and the first one\uFF08").concat(defaultName, "\uFF09is used by default."));
+  }
+  return defaultName;
+}
+export function createCommonEnv(source, current) {
+  return Object.keys(source).reduce(function (env, key) {
+    env["is".concat(key)] = current === key;
+    return env;
+  }, {});
+}
+export function notice(text) {
+  console.info("[hylid-env]: ".concat(text));
+}
+export function getUrlClientName() {
+  return (window.location.search.match(/[?&]__app__=([^?&=]+)/) || [])[1];
+}
+export function getStorageClientName() {
+  // __app__ 值和 getSystemInfo 里的 app 保持对齐
+  return localStorage.getItem('__app__');
+}

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@hylid/env",
+  "version": "2.12.0-alpha.18",
+  "main": "lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "registry": "https://registry.npmjs.org/",
+  "repository": "https://code.alipay.com/ant-ife/hylid-bridge.git"
+}