mazey 4.0.6 → 4.1.0

package/lib/browser.d.ts

@@ -0,0 +1,90 @@
+import type { BrowserInfo } from "./typing";
+/**
+ * EN: Detect the margin of Safety. Determine if it is a secure PWA environment that it can run.
+ *
+ * ZH: 判断是否是安全的 PWA 环境
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = isSafePWAEnv();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * @returns {boolean} true 是
+ * @category Browser Information
+ */
+export declare function isSafePWAEnv(): boolean;
+/**
+ * EN: Browser Information
+ *
+ * ZH: 返回浏览器信息
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = getBrowserInfo();
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * {"engine":"webkit","engineVs":"537.36","platform":"desktop","supporter":"chrome","supporterVs":"85.0.4183.121","system":"windows","systemVs":"10"}
+ * ```
+ *
+ * Results:
+ *
+ * | Attribute | Description | Type | Values |
+ * | :------------ | :------------ | :------------ | :------------ |
+ * | **system** | System | string | android, ios, windows, macos, linux |
+ * | systemVs | System version | string | Windows: 2000, xp, 2003, vista, 7, 8, 8.1, 10 macOS: ... |
+ * | platform | Platform | string | desktop, mobile |
+ * | engine | Engine | string | webkit, gecko, presto, trident |
+ * | engineVs | Engine version | string | - |
+ * | supporter | Supporter | string | edge, opera, chrome, safari, firefox, iexplore |
+ * | supporterVs | Supporter version | string | - |
+ * | shell | Shell | string | (Optional) wechat, qq_browser, qq_app, uc, 360, 2345, sougou, liebao, maxthon, bilibili |
+ * | shellVs | Shell version | string | (Optional) 20/... |
+ * | appleType | Apple device type | string | (Optional) ipad, iphone, ipod, iwatch |
+ *
+ * Example: Determine the environment of the mobile QQ.
+ *
+ * ```javascript
+ * const { system, shell } = getBrowserInfo();
+ * const isMobileQQ = ['android', 'ios'].includes(system) && ['qq_browser', 'qq_app'].includes(shell);
+ * ```
+ *
+ * @returns 浏览器信息
+ * @category Browser Information
+ */
+export declare function getBrowserInfo(): BrowserInfo;
+/**
+ * Detect webp support.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * isSupportWebp().then(res => {
+ *  console.log('isSupportWebp:', res);
+ * });
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * isSupportWebp: true
+ * ```
+ *
+ * Reference: [Detect WEBP Support with JavaScript](https://davidwalsh.name/detect-webp)
+ *
+ * @category Browser Information
+ */
+export declare function isSupportWebp(): Promise<boolean>;
+//# sourceMappingURL=browser.d.ts.map

package/lib/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAkB,MAAM,UAAU,CAAC;AAG5D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,IAAI,OAAO,CA4BtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,cAAc,IAAI,WAAW,CA+M5C;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAYhD"}

package/lib/calc.d.ts

@@ -0,0 +1,106 @@
+/**
+ * EN: Computes the longest common substring of two strings.
+ *
+ * ZH: 计算两个字符串的最长公共子串
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = longestComSubstring('fish', 'finish');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 3
+ * ```
+ *
+ * @param {string} aStr String
+ * @param {string} bStr String
+ * @returns {number} Length
+ * @category Calculate and Formula
+ */
+export declare function longestComSubstring(aStr: string, bStr: string): number;
+/**
+ * Alias of `longestComSubstring`.
+ *
+ * @hidden
+ */
+export declare function calLongestCommonSubstring(aStr: string, bStr: string): number;
+/**
+ * EN: Computes the longest common subsequence of two strings.
+ *
+ * ZH: 计算两个字符串的最长公共子序列
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = longestComSubsequence('fish', 'finish');
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * 4
+ * ```
+ *
+ * @param {string} aStr 字符串
+ * @param {string} bStr 字符串
+ * @returns {number} 长度
+ * @category Calculate and Formula
+ */
+export declare function longestComSubsequence(aStr: string, bStr: string): number;
+/**
+ * Alias of `longestComSubsequence`.
+ *
+ * @hidden
+ */
+export declare function calLongestCommonSubsequence(aStr: string, bStr: string): number;
+/**
+ * EN: Hit probability (1% ~ 100%).
+ *
+ * ZH: 百分位概率
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = isHit(0.5); // 0.01 ~ 1 true/false
+ * console.log(ret);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * true
+ * ```
+ *
+ * Example: Test the precision.
+ *
+ * ```javascript
+ * // Test
+ * let trueCount = 0;
+ * let falseCount = 0;
+ * new Array(1000000).fill(0).forEach(() => {
+ *   if (isHit(0.5)) {
+ *     trueCount++;
+ *   } else {
+ *     falseCount++;
+ *   }
+ * });
+ * console.log(trueCount, falseCount); // 499994 500006
+ * ```
+ *
+ * @param {number} rate -- 0.1 ~ 1 => 1% ~ 100%
+ * @returns {boolean} true 命中
+ * @category Calculate and Formula
+ */
+export declare function isHit(rate: number): boolean;
+/**
+ * Alias of `isHit`.
+ *
+ * @hidden
+ */
+export declare function inRate(rate: number): boolean;
+//# sourceMappingURL=calc.d.ts.map

package/lib/calc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calc.d.ts","sourceRoot":"","sources":["../src/calc.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAqBtE;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CA8BxE;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAK3C;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE5C"}

package/lib/debug.d.ts

@@ -0,0 +1,40 @@
+/**
+ * EN: Custom console printing (`console`).
+ *
+ * ZH: 生成自定义控制台打印
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const myConsole = genCustomConsole('MazeyLog:');
+ * myConsole.log('I am string.');
+ * myConsole.info('I am boolean.', true);
+ * myConsole.info('I am number.', 123, 456);
+ * myConsole.info('I am object.', { a: 123, b: 456});
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * MazeyLog: I am string.
+ * MazeyLog: I am boolean. true
+ * MazeyLog: I am number. 123 456
+ * MazeyLog: I am object. {a: 123, b: 456}
+ * ```
+ *
+ * @param {string} prefix 前缀
+ * @param {string} locales A locale string.
+ * @param {function} logFn The function with Log.
+ * @param {function} errorFn The function with Error.
+ * @returns {object} 新实例
+ * @category Debug
+ */
+export declare function genCustomConsole(prefix?: string, options?: {
+    isClosed?: boolean;
+    showWrap?: boolean;
+    showDate?: boolean;
+    locales?: string;
+    logFn?: () => void;
+    errorFn?: () => void;
+}): Console;
+//# sourceMappingURL=debug.d.ts.map

package/lib/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,SAAK,EACX,OAAO,GAAE;IACP,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CAQtB,GACA,OAAO,CA0ET"}

package/lib/dom.d.ts

@@ -0,0 +1,164 @@
+/**
+ * Modify `class`: determine `class`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const dom = document.querySelector('#box');
+ *
+ * // Determine `class`
+ * hasClass(dom, 'test');
+ * // Add `class`
+ * addClass(dom, 'test');
+ * // Remove `class`
+ * removeClass(dom, 'test');
+ * ```
+ *
+ * @category DOM
+ */
+export declare function hasClass(obj: HTMLElement, cls: string): boolean;
+/**
+ * Modify `class`: add `class`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const dom = document.querySelector('#box');
+ *
+ * // Determine `class`
+ * hasClass(dom, 'test');
+ * // Add `class`
+ * addClass(dom, 'test');
+ * // Remove `class`
+ * removeClass(dom, 'test');
+ * ```
+ *
+ * @category DOM
+ */
+export declare function addClass(obj: HTMLElement, cls: string): void;
+/**
+ * Alias of `addClass`.
+ *
+ * @hidden
+ */
+export declare function setClass(obj: HTMLElement, cls: string): void;
+/**
+ * Modify `class`: remove `class`.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const dom = document.querySelector('#box');
+ *
+ * // Determine `class`
+ * hasClass(dom, 'test');
+ * // Add `class`
+ * addClass(dom, 'test');
+ * // Remove `class`
+ * removeClass(dom, 'test');
+ * ```
+ *
+ * @category DOM
+ */
+export declare function removeClass(obj: HTMLElement, cls: string): void;
+/**
+ * EN: Add `<style>` in `<head>`.
+ *
+ * ZH: 添加样式标签; style: 样式标签内的字符串; id: `<style>` 标签的 `id`; 返回: 添加成功/失败
+ *
+ * Example 1: Add the `<style>` with `id`, and repeated invoking will update the content instead of adding a new one.
+ *
+ * ```javascript
+ * addStyle(
+ *   `
+ *     body {
+ *       background-color: #333;
+ *     }
+ *   `,
+ *   {
+ *     id: 'test',
+ *   }
+ * );
+ * // <style id="test">
+ * //   body {
+ * //     background-color: #333;
+ * //   }
+ * // </style>
+ * ```
+ *
+ * Example 2: Add the `<style>` without `id`, and repeated invoking will add a new one.
+ *
+ * ```javascript
+ * addStyle(
+ *   `
+ *     body {
+ *       background-color: #444;
+ *     }
+ *   `
+ * );
+ * // <style>
+ * //   body {
+ * //     background-color: #444;
+ * //   }
+ * // </style>
+ * ```
+ *
+ * @category DOM
+ */
+export declare function addStyle(style: string, options?: {
+    id?: string;
+}): boolean;
+/**
+ * Sets the width and height of all images on the page based on their `src` attribute.
+ * The `src` attribute should contain `width` and/or `height` values in the format "width=100" or "height=100".
+ * If jQuery is available, this function uses jQuery to select the images. Otherwise, it uses pure JavaScript.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * // Example images with `src` attributes containing `width` and/or `height` values
+ * const img1 = document.createElement('img');
+ * img1.setAttribute('src', 'https://example.com/example.png?width=2233&height=111');
+ * document.body.appendChild(img1);
+ *
+ * const img2 = document.createElement('img');
+ * img2.setAttribute('src', 'https://example.com/example.png?width=100%&height=auto');
+ * document.body.appendChild(img2);
+ * ```
+ *
+ * @returns {boolean} - Returns `true` if images were found and their dimensions were set, otherwise `false`.
+ * @category DOM
+ */
+export declare function setImgSizeBySrc(): boolean;
+/**
+ * Alias of `setImgSizeBySrc`.
+ *
+ * @hidden
+ */
+export declare function setImgWidHeiBySrc(): boolean;
+/**
+ * Generate the inline style string from the given parameters. The first parameter is the query selector, and the second parameter is the style array.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = genStyleString('.a', [ 'color:red' ]);
+ * const ret2 = genStyleString('#b', [ 'color:red', 'font-size:12px' ]);
+ * console.log(ret1);
+ * console.log(ret2);
+ * ```
+ *
+ * Output:
+ *
+ * ```text
+ * .a{color:red;}
+ * #b{color:red;font-size:12px;}
+ * ```
+ *
+ * @param {string} selector
+ * @param {array} styleArray
+ * @returns {string} The inline style string.
+ * @category DOM
+ */
+export declare function genStyleString(selector: string, styleArray: Array<string>): string;
+//# sourceMappingURL=dom.d.ts.map

package/lib/dom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../src/dom.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAS/D;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAiB5D;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAE5D;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAQ/D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAe,GAAG,OAAO,CAiCtF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,IAAI,OAAO,CA6CzC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAE3C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAMlF"}

package/lib/event.d.ts

@@ -0,0 +1,76 @@
+import type { DefineListeners, MazeyFn } from "./typing";
+/**
+ * Prevent bubbling.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret1 = cancelBubble(e);
+ * ```
+ *
+ * @category Event
+ */
+export declare function cancelBubble(e: Event): void;
+/**
+ * Get event container.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * const ret = getEventContainer();
+ * ```
+ *
+ * @category Event
+ * @hidden
+ */
+export declare function getDefineListeners(): DefineListeners;
+/**
+ * Add event.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * addEvent('test', (e) => {
+ *  console.log('test event:', e);
+ * });
+ * ```
+ *
+ * @param type
+ * @param fn
+ * @category Event
+ */
+export declare function addEvent(type: string, fn: MazeyFn): void;
+/**
+ * Invoke event.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * fireEvent('test');
+ * ```
+ *
+ * @param type
+ * @category Event
+ */
+export declare function fireEvent(type: string): void;
+/**
+ * Alias of `fireEvent`.
+ *
+ * @hidden
+ */
+export declare function invokeEvent(type: string): void;
+/**
+ * Remove event.
+ *
+ * Usage:
+ *
+ * ```javascript
+ * removeEvent('test');
+ * ```
+ *
+ * @param type
+ * @param fn
+ * @category Event
+ */
+export declare function removeEvent(type: string, fn: MazeyFn): void;
+//# sourceMappingURL=event.d.ts.map

package/lib/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../src/event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEzD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAS3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,IAAI,eAAe,CAOpD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAQxD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAY5C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAe3D"}

package/lib/global.d.ts

@@ -0,0 +1,87 @@
+import $ from 'jquery';
+
+/**
+ * @author Cheng
+ */
+
+interface BrowserInfo {
+  engine: string; // webkit gecko presto trident
+  engineVs: string;
+  platform: string; // desktop mobile
+  supporter: string; // chrome safari firefox opera iexplore edge
+  supporterVs: string;
+  system: string; // windows macos linux android ios
+  systemVs: string;
+  shell?: string; // wechat qq uc 360 2345 sougou liebao maxthon
+  shellVs?: string;
+  appleType?: string;
+}
+
+interface DefineListeners {
+  [key: string]: any;
+}
+
+/**
+ * @author Cheng
+ */
+
+
+declare global {
+  interface PerformanceEntry {
+    readonly processingStart?: DOMHighResTimeStamp;
+    readonly processingEnd?: DOMHighResTimeStamp;
+    readonly value?: number;
+  }
+
+  interface NetworkInformation {
+    readonly rtt?: number;
+    readonly downlink?: number;
+    readonly effectiveType?: string;
+    readonly saveData?: boolean;
+  }
+
+  interface Navigator {
+    readonly connection?: NetworkInformation;
+  }
+
+  interface HTMLLinkElement {
+    onreadystatechange: any;
+    readyState: any;
+    sheet: any;
+  }
+
+  interface HTMLScriptElement {
+    readyState: any;
+    onreadystatechange: any;
+    parentNode: any;
+  }
+
+  interface Console {
+    [key: string]: any;
+  }
+
+  interface ErrorEvent {
+    type?: string;
+    time?: number;
+    readonly message: string;
+    readonly filename: string; // Deprecated, but still supported.
+    fileName?: string;
+    readonly lineno: number; // Deprecated, but still supported.
+    line?: number;
+    readonly colno: number; // Deprecated, but still supported.
+    column?: number;
+    stack?: string;
+    name?: string;
+  }
+
+  interface Window {
+    // VAR
+    MAZEY_DEFINE_LISTENERS: {
+      [key: string]: DefineListeners;
+    };
+    MAZEY_BROWSER_INFO: BrowserInfo;
+    // LIB
+    $: typeof $;
+    jQuery: typeof $;
+  }
+}