@ray-js/api 1.6.9 → 1.6.11

package/@types/api-extend.d.ts

@@ -228,8 +228,19 @@ interface WebviewContext {
 }
 
 interface SocketTask {
-  send(option: { data: string | ArrayBuffer; success?: () => void; fail?: () => void; complete?: () => void }): void
-  close(option: { code?: number; reason?: string; success?: () => void; fail?: () => void; complete?: () => void }): void
+  send(option: {
+    data: string | ArrayBuffer
+    success?: () => void
+    fail?: () => void
+    complete?: () => void
+  }): void
+  close(option: {
+    code?: number
+    reason?: string
+    success?: () => void
+    fail?: () => void
+    complete?: () => void
+  }): void
   onOpen(callback: () => void): void
   onClose(callback: () => void): void
   onError(callback: () => void): void
@@ -237,15 +248,15 @@ interface SocketTask {
 }
 
 interface ConnectSocketProps {
-  url: string;
-  protocols?: string[];
-  header?: Record<string, string>;
-  timeout?: number;
-  tcpNoDelay?: boolean;
-  perMessageDeflate?: boolean;
-  forceCellularNetwork?: boolean;
-  success?: () => void;
-  fail?: () => void;
+  url: string
+  protocols?: string[]
+  header?: Record<string, string>
+  timeout?: number
+  tcpNoDelay?: boolean
+  perMessageDeflate?: boolean
+  forceCellularNetwork?: boolean
+  success?: () => void
+  fail?: () => void
   complete?: () => void
 }
 
@@ -315,6 +326,13 @@ declare namespace ty {
    * @returns 是否可用
    */
   export function canIUse(schema: string): boolean
+  type IRegionCode = 'AY' | 'AZ' | 'EU' | 'IN' | 'UE' | 'WE' | 'RU'
+
+  /**
+   * 获取当前小程序的区域码
+   * @returns 区域码 可选值：AY, AZ, EU, IN, RU, UE, WE
+   */
+  export function getRegionCode(): IRegionCode
 }
 
 declare namespace WechatMiniprogram {

package/lib/getCdnUrl/index.d.ts

@@ -1,2 +1,22 @@
-export default function getCdnUrl(path: string, cdnMap?: Record<string, string>, region?: string): string;
-export declare function getCdnUrlAsync(path: string, cdnMap?: Record<string, string>, region?: string): Promise<string>;
+type IRegionCode = 'AY' | 'AZ' | 'EU' | 'IN' | 'UE' | 'WE' | 'RU';
+type ICdnMap = Record<string, string> | Record<IRegionCode, Record<string, string>>;
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 及以上版本推荐使用此方法，可以准确获取区域码。
+ *             基础库 2.26.0 以下版本请使用 getCdnUrlAsync 方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
+export default function getCdnUrl(path: string, cdnMap?: ICdnMap, region?: IRegionCode): string;
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 以下版本请使用此方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
+export declare function getCdnUrlAsync(path: string, cdnMap?: ICdnMap, region?: IRegionCode): Promise<string>;
+export {};

package/lib/getCdnUrl/index.js

@@ -1,6 +1,24 @@
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 及以上版本推荐使用此方法，可以准确获取区域码。
+ *             基础库 2.26.0 以下版本请使用 getCdnUrlAsync 方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
 export default function getCdnUrl(path) {
   return path;
 }
+
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 以下版本请使用此方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
 export async function getCdnUrlAsync(path) {
   // 暂未实现获取cdn方法，将直接返回path
   return Promise.resolve(path);

package/lib/getCdnUrl/index.thing.d.ts

@@ -1,3 +1,23 @@
-export declare function getRegionCode(): Promise<string>;
-export default function getCdnUrl(path: string, cdnMap?: Record<string, string>, region?: string): string;
-export declare function getCdnUrlAsync(path: string, cdnMap?: Record<string, string>, region?: string): Promise<string>;
+type IRegionCode = 'AY' | 'AZ' | 'EU' | 'IN' | 'UE' | 'WE' | 'RU';
+type ICdnMap = Record<string, string> | Record<IRegionCode, Record<string, string>>;
+export declare function getRegionCode(): Promise<IRegionCode>;
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 及以上版本推荐使用此方法，可以准确获取区域码。
+ *             基础库 2.26.0 以下版本请使用 getCdnUrlAsync 方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
+export default function getCdnUrl(path: string, cdnMap?: ICdnMap, region?: IRegionCode): string;
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 以下版本请使用此方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
+export declare function getCdnUrlAsync(path: string, cdnMap?: ICdnMap, region?: IRegionCode): Promise<string>;
+export {};

package/lib/getCdnUrl/index.thing.js

@@ -1,28 +1,36 @@
+import get from 'lodash/get';
 const regionMap = {
-  AY: 'images.tuyacn.com',
-  AZ: 'usimagesd1448c85ulz2o4.cdn5th.com',
-  EU: 'euimagesd2h2yqnfpu4gl5.cdn5th.com',
-  IN: 'inimagesd1jqokb9wptk2t.cdn5th.com',
-  RU: 'euimagesd2h2yqnfpu4gl5.cdn5th.com',
-  WE: 'weimages57vdxnr.cdn5th.com',
-  UE: 'ueimages58yny2.cdn5th.com'
+  AY: 'https://images.tuyacn.com',
+  AZ: 'https://usimagesd1448c85ulz2o4.cdn5th.com',
+  EU: 'https://euimagesd2h2yqnfpu4gl5.cdn5th.com',
+  IN: 'https://inimagesd1jqokb9wptk2t.cdn5th.com',
+  RU: 'https://euimagesd2h2yqnfpu4gl5.cdn5th.com',
+  WE: 'https://weimages57vdxnr.cdn5th.com',
+  UE: 'https://ueimages58yny2.cdn5th.com'
 };
-let _regionCode;
-let getInternalRegionCode = () => {
-  if (!_regionCode) {
+let _globalRegionCode;
+const getInternalRegionCode = () => {
+  if (!_globalRegionCode) {
+    // 2.26.0 基础库才加上的方法
+
+    if (typeof ty.getRegionCode === 'function') {
+      _globalRegionCode = ty.getRegionCode();
+      return _globalRegionCode || 'EU';
+    }
     ty.getAppInfo({
       success(res) {
-        _regionCode = res.regionCode;
+        _globalRegionCode = res.regionCode;
       }
     });
   }
-  return 'EU';
+  // FIXME: 第一次调用时，_regionCode 为 undefined 时，返回 'EU'
+  return _globalRegionCode || 'EU';
 };
 export function getRegionCode() {
   return new Promise((resolve, reject) => {
     ty.getAppInfo({
       success(res) {
-        _regionCode = res.regionCode;
+        _globalRegionCode = res.regionCode;
         resolve(res.regionCode);
       },
       fail(err) {
@@ -31,24 +39,62 @@ export function getRegionCode() {
     });
   });
 }
+const concatRegionOrigin = (regionCode, path) => {
+  const regionOrigin = get(regionMap, [regionCode]) || get(regionMap, ['EU']);
+  if (path.indexOf('/') === 0) {
+    return "".concat(regionOrigin).concat(path);
+  }
+  return "".concat(regionOrigin, "/").concat(path);
+};
+const isEmptyOrUndefined = obj => {
+  return !obj || Object.keys(obj).length === 0;
+};
+
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 及以上版本推荐使用此方法，可以准确获取区域码。
+ *             基础库 2.26.0 以下版本请使用 getCdnUrlAsync 方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
 export default function getCdnUrl(path, cdnMap, region) {
-  if (!cdnMap) {
-    console.warn('Please pass in cdnMap');
-    return path;
+  const regionCode = region || getInternalRegionCode();
+  if (isEmptyOrUndefined(cdnMap)) {
+    // 如果未提供 cdnMap，则使用 regionMap 直接与 path 进行拼接
+    return concatRegionOrigin(regionCode, path);
   }
-  const cdnShortPath = cdnMap[path];
+
+  // 总是使用 EU 进行兜底
+  const cdnShortPath = get(cdnMap, [regionCode, path]) || get(cdnMap, ['EU', path]) || get(cdnMap, [path]);
   if (!cdnShortPath) {
     console.warn("[App] cdn \"".concat(path, "\" is not exist."));
     return path;
   }
-  return "https://".concat(regionMap[region || getInternalRegionCode()], "/").concat(cdnShortPath);
+  if (cdnShortPath.indexOf('http') === 0 || cdnShortPath.indexOf('//') === 0) {
+    return cdnShortPath;
+  }
+  if (cdnShortPath.indexOf('/') === 0) {
+    return "".concat(regionMap[regionCode]).concat(cdnShortPath);
+  }
+  return "".concat(regionMap[regionCode], "/").concat(cdnShortPath);
 }
+
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 以下版本请使用此方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
 export async function getCdnUrlAsync(path, cdnMap, region) {
-  if (!cdnMap) {
-    console.warn('Please pass in cdnMap');
-    return path;
+  let _regionCode = _globalRegionCode || 'EU';
+  if (isEmptyOrUndefined(cdnMap)) {
+    // 如果未提供 cdnMap，则使用 regionMap 直接与 path 进行拼接
+    return concatRegionOrigin(_regionCode, path);
   }
-  let _regionCode = 'EU';
   if (region) {
     _regionCode = region;
   } else {
@@ -58,10 +104,5 @@ export async function getCdnUrlAsync(path, cdnMap, region) {
       console.warn('[App] getRegionCode error, use default region EU', error);
     }
   }
-  const cdnShortPath = cdnMap[path];
-  if (!cdnShortPath) {
-    console.warn("[App] cdn \"".concat(path, "\" is not exist."));
-    return path;
-  }
-  return "https://".concat(regionMap[_regionCode], "/").concat(cdnShortPath);
+  return getCdnUrl(path, cdnMap, _regionCode);
 }

package/lib/getCdnUrl/index.wechat.d.ts

@@ -1,2 +1,22 @@
-export default function getCdnUrl(path: string, cdnMap?: Record<string, string>, region?: string): string;
-export declare function getCdnUrlAsync(path: string, cdnMap?: Record<string, string>, region?: string): Promise<string>;
+type IRegionCode = 'AY' | 'AZ' | 'EU' | 'IN' | 'UE' | 'WE' | 'RU';
+type ICdnMap = Record<string, string> | Record<IRegionCode, Record<string, string>>;
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 及以上版本推荐使用此方法，可以准确获取区域码。
+ *             基础库 2.26.0 以下版本请使用 getCdnUrlAsync 方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
+export default function getCdnUrl(path: string, cdnMap?: ICdnMap, region?: IRegionCode): string;
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 以下版本请使用此方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
+export declare function getCdnUrlAsync(path: string, cdnMap?: ICdnMap, region?: IRegionCode): Promise<string>;
+export {};

package/lib/getCdnUrl/index.wechat.js

@@ -1,6 +1,24 @@
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 及以上版本推荐使用此方法，可以准确获取区域码。
+ *             基础库 2.26.0 以下版本请使用 getCdnUrlAsync 方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
 export default function getCdnUrl(path) {
   return path;
 }
+
+/**
+ * 获取 CDN 地址
+ * @description 基础库 2.26.0 以下版本请使用此方法，以避免区域码获取不准确的问题。
+ * @param path - 图片路径
+ * @param cdnMap - CDN 地址映射表，若未提供，则使用内置 regionMap 直接与 path 进行拼接
+ * @param region - 区域代码，若未提供，则使用内置方法获取，EU 兜底
+ * @returns CDN 完整地址
+ */
 export async function getCdnUrlAsync(path) {
   // 暂未实现获取cdn方法，将直接返回path
   return Promise.resolve(path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.6.9",
+  "version": "1.6.11",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,14 +29,14 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.6.9",
-    "@ray-js/router": "1.6.9",
+    "@ray-js/framework": "1.6.11",
+    "@ray-js/router": "1.6.11",
     "@ray-js/wechat": "^0.2.19",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.6.9",
+    "@ray-js/cli": "1.6.11",
     "art-template": "^4.13.2",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.3",
@@ -46,5 +46,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.com"
   },
-  "gitHead": "443512d1bc0bda8f5b8c37b757f57581dbd8f66f"
+  "gitHead": "8fa280821fd6a139ffadcd31e985ed9df5683736"
 }