@whitesev/utils 2.5.6 → 2.5.8

package/dist/types/src/ModuleRaid.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Main moduleRaid class
+ * @link https://scriptcat.org/zh-CN/script-show-page/2628
+ */
+export class ModuleRaid {
+    /**
+     * moduleRaid constructor
+     *
+     * @example
+     * Constructing an instance without any arguments:
+     * ```ts
+     * const mR = new ModuleRaid()
+     * ```
+     *
+     * Constructing an instance with the optional `opts` object:
+     * ```ts
+     * const mR = new ModuleRaid({ entrypoint: 'webpackChunk_custom_name' })
+     * ```
+     *
+     * @param opts a object containing options to initialize moduleRaid with
+     *  - **opts:**
+     *    - _target_: the window object being searched for
+     *    - _entrypoint_: the Webpack entrypoint present on the global window object
+     *    - _debug_: whether debug mode is enabled or not
+     *    - _strict_: whether strict mode is enabled or not
+     */
+    constructor(opts: any);
+    /**
+     * A random generated module ID we use for injecting into Webpack
+     */
+    moduleID: string;
+    /**
+     * An array containing different argument injection methods for
+     * Webpack (before version 4), and subsequently pulling out methods and modules
+     * @internal
+     */
+    functionArguments: ((number[] | ((_e: any, _t: any, i: any) => void)[])[] | (number[] | string[][] | {
+        [x: string]: (_e: any, _t: any, i: any) => void;
+    })[])[];
+    modules: {};
+    constructors: any[];
+    get: any;
+    /**
+     * An array containing different argument injection methods for
+     * Webpack (after version 4), and subsequently pulling out methods and modules
+     * @internal
+     */
+    arrayArguments: ((number[] | ((_e: any, _t: any, i: any) => void)[])[] | {}[] | (number[] | string[][] | {
+        [x: string]: (_e: any, _t: any, i: any) => void;
+    })[])[];
+    target: Window & typeof globalThis;
+    entrypoint: string;
+    debug: boolean;
+    strict: boolean;
+    /**
+     * Debug logging method, outputs to the console when {@link ModuleRaid.debug} is true
+     *
+     * @param {*} message The message to be logged
+     * @internal
+     */
+    log(message: any): void;
+    /**
+     * Method to set an alternative getter if we weren't able to extract __webpack_require__
+     * from Webpack
+     * @internal
+     */
+    replaceGet(): void;
+    /**
+     * Method that will try to inject a module into Webpack or get modules
+     * depending on it's success it might be more or less brute about it
+     * @internal
+     */
+    fillModules(): void;
+    /**
+     * Method to hook into `window[this.entrypoint].push` adding a listener for new
+     * chunks being pushed into Webpack
+     *
+     * @example
+     * You can listen for newly pushed packages using the `moduleraid:webpack-push` event
+     * on `document`
+     *
+     * ```ts
+     * document.addEventListener('moduleraid:webpack-push', (e) => {
+     *   // e.detail contains the arguments push() was called with
+     *   console.log(e.detail)
+     * })
+     * ```
+     * @internal
+     */
+    setupPushEvent(): void;
+    /**
+     * Method to try autodetecting a Webpack JSONP entrypoint based on common naming
+     *
+     * If the default entrypoint, or the entrypoint that's passed to the moduleRaid constructor
+     * already matches, the method exits early
+     *
+     * If `options.strict` has been set in the constructor and the initial entrypoint cannot
+     * be found, this method will error, demanding a strictly set entrypoint
+     * @internal
+     */
+    detectEntrypoint(): void;
+    /**
+     * Recursive object-search function for modules
+     *
+     * @param object the object to search through
+     * @param query the query the object keys/values are searched for
+     * @returns boolean state of `object` containing `query` somewhere in it
+     * @internal
+     */
+    searchObject(object: any, query: any): boolean;
+    /**
+     * Method to search through the module object, searching for the fitting content
+     * if a string is supplied
+     *
+     * If query is supplied as a function, everything that returns true when passed
+     * to the query function will be returned
+     *
+     * @example
+     * With a string as query argument:
+     * ```ts
+     * const results = mR.findModule('feature')
+     * // => Array of module results
+     * ```
+     *
+     * With a function as query argument:
+     * ```ts
+     * const results = mR.findModule((module) => { typeof module === 'function' })
+     * // => Array of module results
+     * ```
+     *
+     * @param query query to search the module list for
+     * @return a list of modules fitting the query
+     */
+    findModule(query: any): any[];
+    /**
+     * Method to search through the constructor array, searching for the fitting content
+     * if a string is supplied
+     *
+     * If query is supplied as a function, everything that returns true when passed
+     * to the query function will be returned
+     *
+     * @example
+     * With a string as query argument:
+     * ```ts
+     * const results = mR.findConstructor('feature')
+     * // => Array of constructor/module tuples
+     * ```
+     *
+     * With a function as query argument:
+     * ```ts
+     * const results = mR.findConstructor((constructor) => { constructor.prototype.value !== undefined })
+     * // => Array of constructor/module tuples
+     * ```
+     *
+     * Accessing the resulting data:
+     * ```ts
+     * // With array destructuring (ES6)
+     * const [constructor, module] = results[0]
+     *
+     * // ...or...
+     *
+     * // regular access
+     * const constructor = results[0][0]
+     * const module = results[0][1]
+     * ```
+     *
+     * @param query query to search the constructor list for
+     * @returns a list of constructor/module tuples fitting the query
+     */
+    findConstructor(query: any): any[];
+}

package/dist/types/src/TryCatch.d.ts

@@ -5,12 +5,12 @@ export declare const TryCatch: (...args: any) => {
      * @param paramDetails 配置
      * @returns
      */
-    config(paramDetails: UtilsTryCatchConfig): any;
+    config(paramDetails: UtilsTryCatchConfig): /*elided*/ any;
     /**
      * 处理错误
      * @param handler
      */
-    error(handler: ((...args: any[]) => any) | string | Function): any;
+    error(handler: ((...args: any[]) => any) | string | Function): /*elided*/ any;
     /**
      * 执行传入的函数并捕获其可能抛出的错误，并通过传入的错误处理函数进行处理。
      * @param callback 待执行函数，可以是 function 或者 string 类型。如果是 string 类型，则会被当做代码进行执行。

package/dist/types/src/Utils.d.ts

@@ -14,6 +14,7 @@ import type { UtilsAjaxHookResult } from "./types/ajaxHooker";
 import { Vue } from "./Vue";
 import { type ArgsType, type JSTypeNames, type UtilsOwnObject } from "./types/global";
 import type { WindowApiOption } from "./types/WindowApi";
+import { ModuleRaid } from "./ModuleRaid";
 declare class Utils {
     private windowApi;
     constructor(option?: WindowApiOption);
@@ -1382,8 +1383,8 @@ declare class Utils {
      * > ()=>{throw new Error('测试错误')}出现错误
      */
     tryCatch: (...args: any) => {
-        config(paramDetails: import("./types/TryCatch").UtilsTryCatchConfig): any;
-        error(handler: ((...args: any[]) => any) | string | Function): any;
+        config(paramDetails: import("./types/TryCatch").UtilsTryCatchConfig): /*elided*/ any;
+        error(handler: ((...args: any[]) => any) | string | Function): /*elided*/ any;
         run<A extends any[], R>(callback: ((...args: A) => R) | string | Function, __context__?: any): import("./types/TryCatch").UtilsTryCatchType;
     };
     /**
@@ -1422,6 +1423,53 @@ declare class Utils {
      * await Utils.waitArrayLoopToEnd([callback,callback,callback],xxxcallback);
      **/
     waitArrayLoopToEnd(data: any[] | HTMLElement[], handleFunc: Function): Promise<void[]>;
+    /**
+     * 等待任意事件成立
+     *
+     * 运行方式为根据页面元素的改变而触发回调
+     * @param checkFn 检测的函数
+     * @param timeout 超时时间，默认0
+     * @param parent （可选）父元素，默认document
+     * @example
+     * Utils.wait(()=> {
+     *   let $test = document.querySelector("#test");
+     *   return {
+     *     success: $test !== null,
+     *     data:  $test
+     *   }
+     * })
+     */
+    wait<T extends any>(checkFn: (...args: any[]) => {
+        /**
+         * 是否检测成功
+         */
+        success: boolean;
+        /**
+         * 返回的值
+         */
+        data: T;
+    }, timeout?: null | undefined, parent?: Node | Element | Document | HTMLElement): Promise<T>;
+    wait<T extends any>(checkFn: (...args: any[]) => {
+        /**
+         * 是否检测成功
+         */
+        success: boolean;
+        /**
+         * 返回的值
+         */
+        data: T;
+    }, timeout?: number, parent?: Node | Element | Document | HTMLElement): Promise<T | null>;
+    /**
+     * 等待元素出现
+     * @param selectorFn 获取元素的函数
+     * @param timeout 超时时间，默认0
+     * @example
+     * Utils.waitNode(()=>document.querySelector("div"), 1000).then( $div =>{
+     *  console.log($div); // $div => HTMLDivELement | null
+     * })
+     */
+    waitNode<K extends any>(selectorFn: () => K | null | undefined): Promise<K>;
+    waitNode<K extends any>(selectorFn: () => K | null | undefined, timeout: number): Promise<K | null | undefined>;
     /**
      * 等待元素出现
      * @param selector CSS选择器
@@ -1430,7 +1478,7 @@ declare class Utils {
      * Utils.waitNode("div").then( $div =>{
      *  console.log($div); // div => HTMLDivELement
      * })
-     * Utils.waitNode("div",document).then( $div =>{
+     * Utils.waitNode("div", document).then( $div =>{
      *  console.log($div); // div => HTMLDivELement
      * })
      */
@@ -1444,7 +1492,7 @@ declare class Utils {
      * Utils.waitNode(["div"]).then( ([$div]) =>{
      *  console.log($div); // div => HTMLDivELement[]
      * })
-     * Utils.waitNode(["div"],document).then( ([$div]) =>{
+     * Utils.waitNode(["div"], document).then( ([$div]) =>{
      *  console.log($div); // div => HTMLDivELement[]
      * })
      */
@@ -1456,7 +1504,7 @@ declare class Utils {
      * @param parent 父元素，默认document
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNode("div",document,1000).then( $div =>{
+     * Utils.waitNode("div", document, 1000).then( $div =>{
      *  console.log($div); // $div => HTMLDivELement | null
      * })
      */
@@ -1468,7 +1516,7 @@ declare class Utils {
      * @param parent 父元素，默认document
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNode(["div"],document,1000).then( ([$div]) =>{
+     * Utils.waitNode(["div"], document, 1000).then( ([$div]) =>{
      *  console.log($div); // $div => HTMLDivELement[] | null
      * })
      */
@@ -1479,7 +1527,7 @@ declare class Utils {
      * @param selector CSS选择器
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNode("div",1000).then( $div =>{
+     * Utils.waitNode("div", 1000).then( $div =>{
      *  console.log($div); // $div => HTMLDivELement | null
      * })
      */
@@ -1490,7 +1538,7 @@ declare class Utils {
      * @param selectorList CSS选择器数组
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNode(["div"],1000).then( [$div] =>{
+     * Utils.waitNode(["div"], 1000).then( [$div] =>{
      *  console.log($div); // $div => HTMLDivELement[] | null
      * })
      */
@@ -1504,7 +1552,7 @@ declare class Utils {
      * Utils.waitAnyNode(["div","div"]).then( $div =>{
      *  console.log($div); // $div => HTMLDivELement 这里是第一个
      * })
-     * Utils.waitAnyNode(["a","div"],document).then( $a =>{
+     * Utils.waitAnyNode(["a","div"], document).then( $a =>{
      *  console.log($a); // $a => HTMLAnchorElement 这里是第一个
      * })
      */
@@ -1516,7 +1564,7 @@ declare class Utils {
      * @param parent 父元素，默认document
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitAnyNode(["div","div"],document,10000).then( $div =>{
+     * Utils.waitAnyNode(["div","div"], document, 10000).then( $div =>{
      *  console.log($div); // $div => HTMLDivELement | null
      * })
      */
@@ -1527,7 +1575,7 @@ declare class Utils {
      * @param selectorList CSS选择器数组
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitAnyNode(["div","div"],10000).then( $div =>{
+     * Utils.waitAnyNode(["div","div"], 10000).then( $div =>{
      *  console.log($div); // $div => HTMLDivELement | null
      * })
      */
@@ -1541,7 +1589,7 @@ declare class Utils {
      * Utils.waitNodeList("div").then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>
      * })
-     * Utils.waitNodeList("div",document).then( $result =>{
+     * Utils.waitNodeList("div", document).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>
      * })
      */
@@ -1555,7 +1603,7 @@ declare class Utils {
      * Utils.waitNodeList(["div"]).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>[]
      * })
-     * Utils.waitNodeList(["div"],document).then( $result =>{
+     * Utils.waitNodeList(["div"], document).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>[]
      * })
      */
@@ -1567,7 +1615,7 @@ declare class Utils {
      * @param parent 监听的父元素
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNodeList("div",document,10000).then( $result =>{
+     * Utils.waitNodeList("div", document, 10000).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement> | null
      * })
      */
@@ -1579,7 +1627,7 @@ declare class Utils {
      * @param parent 监听的父元素
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNodeList(["div"],document,10000).then( $result =>{
+     * Utils.waitNodeList(["div"], document, 10000).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>[] | null
      * })
      */
@@ -1590,7 +1638,7 @@ declare class Utils {
      * @param selector CSS选择器数组
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNodeList("div",10000).then( $result =>{
+     * Utils.waitNodeList("div", 10000).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement> | null
      * })
      */
@@ -1601,7 +1649,7 @@ declare class Utils {
      * @param selectorList CSS选择器数组
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitNodeList(["div"],10000).then( $result =>{
+     * Utils.waitNodeList(["div"], 10000).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>[] | null
      * })
      */
@@ -1615,7 +1663,7 @@ declare class Utils {
      * Utils.waitAnyNodeList(["div","a"]).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>
      * })
-     * Utils.waitAnyNodeList(["div","a"],document).then( $result =>{
+     * Utils.waitAnyNodeList(["div","a"], document).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement>
      * })
      */
@@ -1627,7 +1675,7 @@ declare class Utils {
      * @param parent 父元素，默认document
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitAnyNodeList(["div","a"],document,10000).then( $result =>{
+     * Utils.waitAnyNodeList(["div","a"], document, 10000).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement> | null
      * })
      */
@@ -1638,7 +1686,7 @@ declare class Utils {
      * @param selectorList CSS选择器数组
      * @param timeout 超时时间，默认0
      * @example
-     * Utils.waitAnyNodeList(["div","div"],10000).then( $result =>{
+     * Utils.waitAnyNodeList(["div","div"], 10000).then( $result =>{
      *  console.log($result); // $result => NodeListOf<HTMLDivElement> | null
      * })
      */
@@ -1768,6 +1816,7 @@ declare class Utils {
      * > "测试"
      */
     Vue: typeof Vue;
+    ModuleRaid: typeof ModuleRaid;
 }
 declare let utils: Utils;
 export { utils as Utils };

package/dist/types/src/types/global.d.ts

@@ -25,3 +25,4 @@ export declare interface AnyObject {
 export type PartialKeys<T, K extends keyof T> = {
 	[P in K]?: T[P];
 };
+export type Values<T> = T[keyof T];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whitesev/utils",
-  "version": "2.5.6",
+  "version": "2.5.8",
   "description": "一个常用的工具库",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",