@hylid/env 3.3.0-alpha.13 → 3.3.0-alpha.19

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,26 @@
+import { CLIENT } from "../constants";
+export var mpChecker = [{
+  name: CLIENT.DEMO,
+  match: [/demo/]
+}, {
+  name: CLIENT.ALIPAY,
+  match: [/alipay/]
+}, {
+  name: CLIENT.ALIPAYHK,
+  match: [/hk/]
+}, {
+  name: CLIENT.TNGD,
+  match: [/tngd/]
+}, {
+  name: CLIENT.GCASH,
+  match: [/gcash/]
+}, {
+  name: CLIENT.TRUEMONEY,
+  match: [/tmn/]
+}, {
+  name: CLIENT.DANA,
+  match: [/dana/]
+}, {
+  name: CLIENT.TOSSPAY,
+  match: [/toss/]
+}];

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,26 @@
+import { CLIENT, HAVE_GRIVER, HAVE_MINIPROGRAM, NO_GRIVER } from "../constants";
+// 优先从 URL 里带过来 __app__ 参数进行识别
+export var mpWebChecker = [{
+  name: CLIENT.DEMO,
+  match: [/alipayIDE/i] // IDE 识别为 demo
+}, {
+  name: CLIENT.ALIPAYHK,
+  match: [HAVE_MINIPROGRAM, NO_GRIVER, /AlipayClientHK/]
+}, {
+  name: CLIENT.TNGD,
+  match: [HAVE_MINIPROGRAM, /TNGKit|Touch 'n Go/]
+}, {
+  name: CLIENT.GCASH,
+  match: [HAVE_MINIPROGRAM, HAVE_GRIVER, /GCash/]
+}, {
+  name: CLIENT.TRUEMONEY,
+  match: [HAVE_MINIPROGRAM, HAVE_GRIVER, /TrueMoney/]
+}, {
+  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,38 @@
+import { CLIENT, NO_MINIPROGRAM, NO_GRIVER, HAVE_GRIVER } from "../constants";
+export var webChecker = [{
+  name: CLIENT.ALIPAYHK,
+  match: [NO_MINIPROGRAM, NO_GRIVER, /AlipayClientHK/]
+}, {
+  name: CLIENT.TNGD,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /TNGKit|Touch 'n Go/]
+}, {
+  name: CLIENT.TNGD_H5NG,
+  match: [NO_MINIPROGRAM, /TNGKit|Touch 'n Go/, /IAPWebH5NG/]
+}, {
+  name: CLIENT.GCASH,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /GCash/]
+}, {
+  name: CLIENT.TRUEMONEY,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /TrueMoney/i]
+}, {
+  name: CLIENT.KAKAOPAY,
+  match: [NO_MINIPROGRAM, /PAYCLIENT|KAKAOTALK|KAKAOPAY/]
+}, {
+  name: CLIENT.KAKAOTALK,
+  match: [NO_MINIPROGRAM, /ALIPAYCONNECT_KAKAO_TALK/]
+}, {
+  name: CLIENT.NAVERPAY,
+  match: [NO_MINIPROGRAM, /NAVER/]
+}, {
+  name: CLIENT.MPAY,
+  match: [NO_MINIPROGRAM, /mpay|macaupay/i]
+}, {
+  name: CLIENT.TOSSPAY,
+  match: [NO_MINIPROGRAM, /Toss/i]
+}, {
+  name: CLIENT.ALIPAY,
+  match: [NO_MINIPROGRAM, NO_GRIVER, /AlipayClient/]
+}, {
+  name: CLIENT.DEMO,
+  match: [NO_MINIPROGRAM, HAVE_GRIVER, /GriverDemo/]
+}];

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,9 @@
+import { mpChecker } from "../checker";
+import { CLIENT } from "../constants";
+import { getMatchName } from "../utils";
+export function getName4MP() {
+  // 微信小程序
+  // @ts-ignore
+  if (typeof wx !== 'undefined') return CLIENT.WECHAT;
+  return getMatchName(mpChecker, my.getSystemInfoSync().app);
+}

package/lib/getClientName/getName4MpWeb.d.ts

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

package/lib/getClientName/getName4MpWeb.js

@@ -0,0 +1,5 @@
+import { mpWebChecker } from "../checker";
+import { getMatchName } from "../utils";
+export function getName4MpWeb() {
+  return getMatchName(mpWebChecker, window.navigator.userAgent);
+}

package/lib/getClientName/getName4Web.d.ts

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

package/lib/getClientName/getName4Web.js

@@ -0,0 +1,6 @@
+import { webChecker } from "../checker";
+import { CLIENT } from "../constants";
+import { getMatchName } from "../utils";
+export function getName4Web() {
+  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,16 @@
+import { ClientEnv, PlatformEnv } from './types';
+export declare function getDefaultDiscernEnv(): {
+    client: string | undefined;
+    platform: string | undefined;
+};
+declare let client: string | undefined, 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,56 @@
+import { createCommonEnv, getSettingName, isMP, notice } from "./utils";
+import { getName4MP, getName4MpWeb, getName4Web } from "./getClientName";
+import { CLIENT, PLATFORM } from "./constants";
+export function getDefaultDiscernEnv() {
+  var client;
+  var platform;
+  if (isMP()) {
+    client = getName4MP();
+    platform = PLATFORM.MP;
+  } else {
+    var setting = getSettingName();
+    if (setting.platform) {
+      platform = setting.platform;
+      client = setting.client || (platform === 'mpweb' ? getName4MpWeb() : getName4Web());
+    } else {
+      // 如果只设置了 client，默认是套壳场景
+      client = setting.client || getName4MpWeb();
+      if (client) {
+        platform = PLATFORM.MPWEB;
+      } else {
+        client = getName4Web();
+        platform = PLATFORM.WEB;
+      }
+    }
+  }
+  if (!platform || !client) {
+    notice('Cannot identify your client.');
+  }
+  return {
+    client: client,
+    platform: platform
+  };
+}
+var _a = getDefaultDiscernEnv(),
+  client = _a.client,
+  platform = _a.platform;
+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,6 @@
+import { Checker } from './types';
+export declare function isMP(): 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 getSettingName(): any;

package/lib/utils.js

@@ -0,0 +1,48 @@
+export function isMP() {
+  // @ts-ignore
+  if (typeof wx !== 'undefined') return true;
+  // 小程序一定有 my
+  if (typeof my === 'undefined') return false;
+  // 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 === source[key];
+    return env;
+  }, {});
+}
+export function notice(text) {
+  console.info("[hylid-env]: ".concat(text));
+}
+export function getSettingName() {
+  var _a;
+  var clientMatch = ((_a = window.location.search) === null || _a === void 0 ? void 0 : _a.match(/__app__=([^&]*)/)) || [];
+  var client = clientMatch[1];
+  var platform = (window.location.search.match(/[?&]__platform__=([^?&=]+)/) || [])[1];
+  if (client || platform) {
+    localStorage.setItem('__hy_env__', JSON.stringify({
+      client: client,
+      platform: platform
+    }));
+  }
+  var cached = localStorage.getItem('__hy_env__');
+  return cached ? JSON.parse(cached) : {};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hylid/env",
-  "version": "3.3.0-alpha.13",
+  "version": "3.3.0-alpha.19",
   "main": "lib/index.js",
   "files": [
     "lib"