@mptool/all 0.6.0-beta.9 → 0.6.0

package/lib/index.d.mts

@@ -1,6 +1,103 @@
 declare const encode: (arraybuffer: ArrayBuffer) => string;
 declare const decode: (base64: string) => ArrayBuffer;
 
+declare const isQQ: boolean;
+declare const isWx: boolean;
+declare const isMp: boolean;
+
+type EventType = string | symbol;
+type Handler<T = unknown> = (event: T) => void | Promise<void>;
+type WildcardHandler<T = Record<string, unknown>> = (type: keyof T, event: T[keyof T]) => void | Promise<void>;
+type EventHandlerList<T = unknown> = Array<Handler<T>>;
+type WildCardEventHandlerList<T = Record<string, unknown>> = Array<WildcardHandler<T>>;
+type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<keyof Events | "*", EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>>;
+interface EmitterInstance<Events extends Record<EventType, unknown>> {
+    all: EventHandlerMap<Events>;
+    on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
+    on(type: "*", handler: WildcardHandler<Events>): void;
+    off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
+    off(type: "*", handler: WildcardHandler<Events>): void;
+    emit<Key extends keyof Events>(type: Key, event: Events[Key]): void;
+    emit<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): void;
+    emitAsync<Key extends keyof Events>(type: Key, event: Events[Key]): Promise<void>;
+    emitAsync<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): Promise<void>;
+}
+/**
+ * Tiny (~300b) functional event emitter / pubsub.
+ * @name emitter
+ * @returns Emitter
+ */
+declare function Emitter<Events extends Record<EventType, unknown>>(all?: EventHandlerMap<Events>): EmitterInstance<Events>;
+
+/** 写入普通日志 */
+declare const debug: (...args: any[]) => void;
+/** 写入信息日志 */
+declare const info: (...args: any[]) => void;
+/** 写入警告日志 */
+declare const warn: (...args: any[]) => void;
+/** 写入错误日志 */
+declare const error: (...args: any[]) => void;
+/**
+ * 写入过滤信息
+ *
+ * @param filterMsg 过滤信息
+ */
+declare const filter: (filterMsg: string) => void;
+
+declare const logger_debug: typeof debug;
+declare const logger_error: typeof error;
+declare const logger_filter: typeof filter;
+declare const logger_info: typeof info;
+declare const logger_warn: typeof warn;
+declare namespace logger {
+  export { logger_debug as debug, logger_error as error, logger_filter as filter, logger_info as info, logger_warn as warn };
+}
+
+/**
+ * 字符串参数解析
+ *
+ * @param queryString 需要解析的字符串
+ * @param [splitter='&'] 分隔符
+ *
+ * @returns 参数对象
+ */
+declare const parse: (queryString?: string, splitter?: string) => Record<string, string>;
+/**
+ * query 对象转换字符串
+ *
+ * @param params query 对象
+ * @param [splitter='&] 分隔符
+ * @param [unencoded=false] 是否已经解码
+ *
+ * @returns 解析的字符串
+ */
+declare const stringify: (params?: Record<string, string>, splitter?: string, unencoded?: boolean) => string;
+/**
+ * URL 添加 query
+ *
+ * @param path 前部分路径
+ * @param queries query对象
+ * @param unencoded 是否已经解码，默认为否
+ *
+ * @returns 处理过的 url
+ */
+declare const join: (path: string, queries: Record<string, string>, unencoded?: boolean) => string;
+
+declare const query_join: typeof join;
+declare const query_parse: typeof parse;
+declare const query_stringify: typeof stringify;
+declare namespace query {
+  export { query_join as join, query_parse as parse, query_stringify as stringify };
+}
+
+/**
+ * 获取变量类型
+ *
+ * @param obj 需要辨别的变量
+ * @returns 对象的类型
+ */
+declare const type: (obj: unknown) => string;
+
 /**
  * 包装函数，先执行 wrapper ，然后执行原函数
  *
@@ -111,99 +208,6 @@ declare class Queue {
  */
 declare const funcQueue: <A extends unknown[], T = unknown>(fn: (next: () => void, ...args: A) => void, capacity?: number) => (this: T, ...args: A) => void;
 
-type EventType = string | symbol;
-type Handler<T = unknown> = (event: T) => void | Promise<void>;
-type WildcardHandler<T = Record<string, unknown>> = (type: keyof T, event: T[keyof T]) => void | Promise<void>;
-type EventHandlerList<T = unknown> = Array<Handler<T>>;
-type WildCardEventHandlerList<T = Record<string, unknown>> = Array<WildcardHandler<T>>;
-type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<keyof Events | "*", EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>>;
-interface EmitterInstance<Events extends Record<EventType, unknown>> {
-    all: EventHandlerMap<Events>;
-    on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
-    on(type: "*", handler: WildcardHandler<Events>): void;
-    off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
-    off(type: "*", handler: WildcardHandler<Events>): void;
-    emit<Key extends keyof Events>(type: Key, event: Events[Key]): void;
-    emit<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): void;
-    emitAsync<Key extends keyof Events>(type: Key, event: Events[Key]): Promise<void>;
-    emitAsync<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): Promise<void>;
-}
-/**
- * Tiny (~300b) functional event emitter / pubsub.
- * @name emitter
- * @returns Emitter
- */
-declare function Emitter<Events extends Record<EventType, unknown>>(all?: EventHandlerMap<Events>): EmitterInstance<Events>;
-
-/** 写入普通日志 */
-declare const debug: (...args: any[]) => void;
-/** 写入信息日志 */
-declare const info: (...args: any[]) => void;
-/** 写入警告日志 */
-declare const warn: (...args: any[]) => void;
-/** 写入错误日志 */
-declare const error: (...args: any[]) => void;
-/**
- * 写入过滤信息
- *
- * @param filterMsg 过滤信息
- */
-declare const filter: (filterMsg: string) => void;
-
-declare const logger_debug: typeof debug;
-declare const logger_error: typeof error;
-declare const logger_filter: typeof filter;
-declare const logger_info: typeof info;
-declare const logger_warn: typeof warn;
-declare namespace logger {
-  export { logger_debug as debug, logger_error as error, logger_filter as filter, logger_info as info, logger_warn as warn };
-}
-
-/**
- * 字符串参数解析
- *
- * @param queryString 需要解析的字符串
- * @param [splitter='&'] 分隔符
- *
- * @returns 参数对象
- */
-declare const parse: (queryString?: string, splitter?: string) => Record<string, string>;
-/**
- * query 对象转换字符串
- *
- * @param params query 对象
- * @param [splitter='&] 分隔符
- * @param [unencoded=false] 是否已经解码
- *
- * @returns 解析的字符串
- */
-declare const stringify: (params?: Record<string, string>, splitter?: string, unencoded?: boolean) => string;
-/**
- * URL 添加 query
- *
- * @param path 前部分路径
- * @param queries query对象
- * @param unencoded 是否已经解码，默认为否
- *
- * @returns 处理过的 url
- */
-declare const join: (path: string, queries: Record<string, string>, unencoded?: boolean) => string;
-
-declare const query_join: typeof join;
-declare const query_parse: typeof parse;
-declare const query_stringify: typeof stringify;
-declare namespace query {
-  export { query_join as join, query_parse as parse, query_stringify as stringify };
-}
-
-/**
- * 获取变量类型
- *
- * @param obj 需要辨别的变量
- * @returns 对象的类型
- */
-declare const type: (obj: unknown) => string;
-
 type Props = Record<string, unknown>;
 type PropsOptions<Property = Props> = {
     [K in keyof Property]: PropItem<Property[K]> | null;
@@ -1157,11 +1161,11 @@ interface UrlInfo {
 }
 declare const getDomain: (domainOrURL: string) => string;
 declare const parseUrl: (url: string) => UrlInfo;
-type CookieStoreOptions = string | {
+type CookieOptions = string | {
     domain?: string;
     path?: string;
 };
-declare const getCookieOptions: (options?: CookieStoreOptions) => UrlInfo;
+declare const getCookieOptions: (options: CookieOptions) => UrlInfo;
 declare const parseCookieHeader: (setCookieHeader: string, domain: string) => Cookie[];
 
 type CookieMap = Map<string, Cookie>;
@@ -1192,7 +1196,7 @@ declare class CookieStore {
      * @param options Cookie 选项
      * @return cookie 对象
      */
-    get(name: string, options: CookieStoreOptions): Cookie | null;
+    get(name: string, options: CookieOptions): Cookie | null;
     /**
      * 获取 Cookie 值
      *
@@ -1200,7 +1204,7 @@ declare class CookieStore {
      * @param options Cookie 选项
      * @return Cookie 值
      */
-    getValue(name: string, options: CookieStoreOptions): string | undefined;
+    getValue(name: string, options: CookieOptions): string | undefined;
     /**
      * 是否有特定的 Cookie
      *
@@ -1208,7 +1212,7 @@ declare class CookieStore {
      * @param options Cookie 选项
      * @return 是否存在
      */
-    has(name: string, options: CookieStoreOptions): boolean;
+    has(name: string, options: CookieOptions): boolean;
     /**
      * 设置 cookie
      */
@@ -1230,7 +1234,7 @@ declare class CookieStore {
      * @param options Cookie 选项
      * @return Cookie 对象数组
      */
-    getCookies(options?: CookieStoreOptions): Cookie[];
+    getCookies(options: CookieOptions): Cookie[];
     /**
      * 获取所有 cookies 对象
      *
@@ -1242,7 +1246,7 @@ declare class CookieStore {
      *
      * @return 键值 Map
      */
-    getCookiesMap(options: CookieStoreOptions): Record<string, string>;
+    getCookiesMap(options: CookieOptions): Record<string, string>;
     /**
      * 应用 Cookies
      *
@@ -1261,21 +1265,21 @@ declare class CookieStore {
      * @param header 小程序 response header
      * @param domainOrURL Url 或域名
      */
-    applyHeader(header: WechatMiniprogram.IAnyObject, domainOrURL: string): void;
+    applyHeader(header: unknown, domainOrURL: string): void;
     /**
      * 应用响应 cookies
      *
      * @param response 小程序 response
      * @param domainOrURL Url 或域名
      */
-    applyResponse(response: WechatMiniprogram.RequestSuccessCallbackResult, domainOrURL: string): void;
+    applyResponse(response: unknown, domainOrURL: string): void;
     /**
      * 获取 request cookie header
      *
      * @param options Cookie 选项
      * @return request cookie header
      */
-    getHeader(options: CookieStoreOptions): string;
+    getHeader(options: CookieOptions): string;
     /**
      * 从 Storage 读取 cookies
      */
@@ -1406,9 +1410,9 @@ declare class URLSearchParams {
     [Symbol.iterator](): IterableIterator<[string, string]>;
 }
 
-declare const fetchCookieStore: CookieStore;
-type FetchBody = WechatMiniprogram.IAnyObject | ArrayBuffer | URLSearchParams | string | null;
-interface FetchOptions<T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>> extends Omit<WechatMiniprogram.RequestOption<T>, "url" | "method" | "header" | "data"> {
+declare const requestCookieStore: CookieStore;
+type RequestBody = WechatMiniprogram.IAnyObject | ArrayBuffer | URLSearchParams | string | null;
+interface RequestOptions<T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>> extends Omit<WechatMiniprogram.RequestOption<T>, "url" | "method" | "header" | "data"> {
     /**
      * 请求方法
      */
@@ -1420,7 +1424,7 @@ interface FetchOptions<T extends Record<never, never> | unknown[] | string | Arr
     /**
      * 请求主体
      */
-    body?: FetchBody;
+    body?: RequestBody;
     /**
      * Cookie 作用域
      */
@@ -1430,7 +1434,7 @@ interface FetchOptions<T extends Record<never, never> | unknown[] | string | Arr
      */
     cookieStore?: CookieStore;
 }
-interface FetchResponse<T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>> {
+interface RequestResponse<T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>> {
     /** Status Code */
     status: number;
     /** Response headers */
@@ -1438,15 +1442,13 @@ interface FetchResponse<T extends Record<never, never> | unknown[] | string | Ar
     /** Response data */
     data: T;
 }
-type FetchType = <T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>>(url: string, options?: FetchOptions<T>) => Promise<FetchResponse<T>>;
-interface FetchErrorInfo {
-    /** 错误信息 */
-    errMsg: string;
+interface RequestError extends Error {
     /** 错误码 */
-    errno: number;
+    errno?: number;
 }
-declare const mpFetch: <T extends string | ArrayBuffer | Record<never, never> | unknown[] = Record<string, any>>(url: string, { method, headers, body, cookieScope, cookieStore, ...options }?: FetchOptions<T>) => Promise<FetchResponse<T>>;
-interface FetchInitOptions extends Pick<WechatMiniprogram.RequestOption, "redirect" | "enableCache" | "enableChunked" | "enableHttp2" | "enableHttpDNS" | "enableQuic" | "httpDNSServiceId" | "forceCellularNetwork" | "timeout"> {
+type RequestType = <T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>>(url: string, options?: RequestOptions<T>) => Promise<RequestResponse<T>>;
+declare const request: <T extends string | ArrayBuffer | Record<never, never> | unknown[] = Record<string, any>>(url: string, { method, headers, body, cookieScope, cookieStore, ...options }?: RequestOptions<T>) => Promise<RequestResponse<T>>;
+interface RequestInitOptions extends Pick<WechatMiniprogram.RequestOption, "redirect" | "enableCache" | "enableChunked" | "enableHttp2" | "enableHttpDNS" | "enableQuic" | "httpDNSServiceId" | "forceCellularNetwork" | "timeout"> {
     /**
      * 访问的默认域名
      */
@@ -1458,26 +1460,29 @@ interface FetchInitOptions extends Pick<WechatMiniprogram.RequestOption, "redire
     /**
      * 响应处理器
      *
-     * @param response 响应
-     * @returns 数据
-     * @throws {Error} 自定义的错误数据
+     * @throws {RequestError} 自定义的错误数据
      */
     responseHandler?: <T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>>(
     /** 响应数据 */
-    response: FetchResponse<T>, 
+    response: RequestResponse<T>, 
     /** 请求地址 */
     url: string, 
     /** 请求配置 */
-    options: FetchOptions<T>) => FetchResponse<T>;
+    options: RequestOptions<T>) => RequestResponse<T>;
+    /**
+     * 错误处理器
+     *
+     * @throws {RequestError} 自定义的错误数据
+     */
     errorHandler?: <T extends Record<never, never> | unknown[] | string | ArrayBuffer = Record<string, any>>(
     /** 错误信息 */
-    errInfo: FetchErrorInfo, 
+    error: RequestError, 
     /** 请求地址 */
     url: string, 
     /** 请求配置 */
-    options: FetchOptions<T>) => FetchResponse<T> | never;
+    options: RequestOptions<T>) => RequestResponse<T> | never;
 }
-interface FetchFactory {
+interface RequestFactory {
     /**
      * Cookie 存储
      */
@@ -1485,11 +1490,11 @@ interface FetchFactory {
     /**
      * 请求方法
      */
-    fetch: FetchType;
+    request: RequestType;
 }
 /**
- * @param options fetch 配置选项
+ * @param options request 配置选项
  */
-declare const createMpFetch: ({ cookieStore, server, responseHandler, errorHandler, ...defaultOptions }?: FetchInitOptions) => FetchFactory;
+declare const createRequest: ({ cookieStore, server, responseHandler, errorHandler, ...defaultOptions }?: RequestInitOptions) => RequestFactory;
 
-export { $App, $Component, $Config, $Page, type AppConfig, type AppConstructor, type AppInstance, type AppOptions, type ComponentConstructor, type ComponentInstance, type ComponentLifetimes, type ComponentOptions, Cookie, type CookieMap, CookieStore, type CookieStoreOptions, type CookieStoreType, type CookieType, Emitter, type EmitterInstance, type EventHandlerList, type EventHandlerMap, type EventType, type ExtendedAppMethods, type ExtendedComponentMethods, type ExtendedComponentProperty, type ExtendsAppOptions, type FetchBody, type FetchErrorInfo, type FetchFactory, type FetchInitOptions, type FetchOptions, type FetchResponse, type FetchType, type Handler, Headers, type HeadersInit, type PageConstructor, type PageInstance, type PageOptions, type PageQuery, type PageState, type PropType, Queue, type RefMap, type SetCookieOptions, type StorageData, type Task, type TrivialComponentInstance, type TrivialComponentOptions, type TrivialPageInstance, type TrivialPageOptions, URLSearchParams, type UrlInfo, type WildCardEventHandlerList, type WildcardHandler, check, checkAsync, createMpFetch, decode as decodeBase64, dirname, userEmitter as emitter, encode as encodeBase64, exists, fetchCookieStore, funcQueue, get, getAsync, getCookieOptions, getCookieScopeDomain, getDomain, isDir, isFile, lock, logger, ls, mkdir, mpFetch, normalizeDomain, once, parseCookieHeader, parseUrl, put, query, readFile, readJSON, remove, removeAsync, rm, saveFile, saveOnlineFile, set, setAsync, storage, take, type, unzip, wrapFunction, writeFile, writeJSON };
+export { $App, $Component, $Config, $Page, type AppConfig, type AppConstructor, type AppInstance, type AppOptions, type ComponentConstructor, type ComponentInstance, type ComponentLifetimes, type ComponentOptions, Cookie, type CookieMap, type CookieOptions, CookieStore, type CookieStoreType, type CookieType, Emitter, type EmitterInstance, type EventHandlerList, type EventHandlerMap, type EventType, type ExtendedAppMethods, type ExtendedComponentMethods, type ExtendedComponentProperty, type ExtendsAppOptions, type Handler, Headers, type HeadersInit, type PageConstructor, type PageInstance, type PageOptions, type PageQuery, type PageState, type PropType, Queue, type RefMap, type RequestBody, type RequestError, type RequestFactory, type RequestInitOptions, type RequestOptions, type RequestResponse, type RequestType, type SetCookieOptions, type StorageData, type Task, type TrivialComponentInstance, type TrivialComponentOptions, type TrivialPageInstance, type TrivialPageOptions, URLSearchParams, type UrlInfo, type WildCardEventHandlerList, type WildcardHandler, check, checkAsync, createRequest, decode as decodeBase64, dirname, userEmitter as emitter, encode as encodeBase64, exists, funcQueue, get, getAsync, getCookieOptions, getCookieScopeDomain, getDomain, isDir, isFile, isMp, isQQ, isWx, lock, logger, ls, mkdir, normalizeDomain, once, parseCookieHeader, parseUrl, put, query, readFile, readJSON, remove, removeAsync, request, requestCookieStore, rm, saveFile, saveOnlineFile, set, setAsync, storage, take, type, unzip, wrapFunction, writeFile, writeJSON };