@lightsoft/js-sdk 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1,8 +1,87 @@
+import { Ref } from 'vue';
+
+type RequestOptions = {
+    data?: Document | XMLHttpRequestBodyInit | null;
+    headers?: {
+        [key: string]: string;
+    };
+    async?: boolean;
+};
+type RequestType = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'TRACE' | 'CONNECT';
+
+declare class Request {
+    private readonly xhr;
+    private beforeRequestOptions;
+    private beforeResponseCallback;
+    constructor();
+    create(): XMLHttpRequest;
+    useState(state: 'SUCCESS' | 'FAIL' | 'PENDING'): boolean;
+    send(type: RequestType, url: string, options?: RequestOptions): Promise<unknown>;
+    transformResponse(response: XMLHttpRequest): {
+        data: any;
+        code: number;
+        message: string;
+    };
+    transformQuery(url: string, query: any): string;
+    beforeSend(callback: () => RequestOptions): void;
+    beforeResponse(callback: (...args: any) => void): void;
+    abort(): void;
+    get(url: string, query?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    post(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    put(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    delete(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    patch(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    options(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    head(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    trace(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+    connect(url: string, data?: any, headers?: RequestOptions['headers']): Promise<unknown>;
+}
+declare class RequestChain {
+    private fieldList;
+    private responses;
+    constructor(...args: Record<string, any>[]);
+    getParams(type: 'query' | 'body', data: any, fields: any): string | Record<string, any>;
+    setParams(...args: Record<string, any>[]): void;
+    chain(list: any[]): any;
+}
+
+interface CountDown {
+    countdownText: Ref<string>;
+    disabled: Ref<boolean>;
+    send: () => void;
+}
+/**
+ *
+ * @param {number} num 倒计时时间
+ * @param {string} text 按钮文本
+ * @returns { object } countdownText 倒计时文本 isDisabled 是否禁用 send 发送验证码方法
+ * @description 发送验证码倒计时
+ */
+declare function useCountDown(num: number, text?: string): CountDown;
+
 declare enum RecordType {
     AUDIO = "audio",
     VIDEO = "video",
     SCREEN = "screen"
 }
+declare enum LOGIN_TYPE {
+    CODE = "CODE",
+    ACCOUNT = "ACCOUNT"
+}
+declare enum LENGTH_LIMIT {
+    MIN_11 = 11,
+    MAX_11 = 11,
+    MIN_18 = 18,
+    MAX_18 = 18,
+    MIN_15 = 15,
+    MAX_15 = 15
+}
+declare enum HAS_FEILD {
+    LABEL = "label",
+    VALUE = "value",
+    CHILDREN = "children",
+    LEAF = "leaf"
+}
 
 interface Tag {
     type: 'node' | 'content';
@@ -15,6 +94,187 @@ interface Tag {
     $class?: string;
     $disabledFor?: boolean;
 }
+type typeIsNull = string | number | boolean | null | undefined;
+interface ISectoralTable {
+    address: string;
+    appletQr: string;
+    hasChildren?: boolean;
+    cldOrgDepts?: ISectoralTable[];
+    deptAlias: string;
+    initialPinyin: string;
+    deptCode: string;
+    deptName: string;
+    email: string;
+    leader: string;
+    mark: string;
+    officialQr: string;
+    orgCode: string;
+    parentCode: string;
+    phone: string;
+    pk: string;
+    sort: number;
+    status: number;
+}
+
+/**
+ * 对象数组转为字符串
+ * @param {object} obj  目标对象
+ * @param {string | string[]} keys  键名
+ * @param {string} splitter  分隔符
+ */
+declare function objectArrayToString(obj: {
+    [key: string]: any;
+}, keys: string | string[], splitter?: string): {
+    [key: string]: any;
+};
+/**
+ * 防抖
+ * @param {Function} fn 回调函数
+ * @param {number} delay 延迟时间
+ */
+declare function debounce(fn: <T>(v: T) => void, delay: number): (value: string) => void;
+/**
+ *
+ * 判断是否移动端
+ * @return {boolean}
+ */
+declare function isMobileDevice(): boolean;
+/**
+ * 节流
+ * @param {Function} fn 回调函数
+ * @param {number} delay 延迟时间
+ */
+declare function throttle(fn: <T>(v: T) => void, delay: number): (value: string) => void;
+/**
+ * 深度合并对象
+ * @param target 目标对象
+ * @param source 源对象
+ */
+declare function deepMerge<T>(target: T, source: T): T;
+/**
+ * input类型验证
+ */
+declare class InputLegalityValidate {
+    private _phoneReg;
+    private _mailReg;
+    private _idCardReg;
+    /**
+     * 验证手机号
+     * @param phone 手机号
+     */
+    phone(phone: string): boolean;
+    /**
+     * 验证邮箱
+     * @param email 手机号
+     */
+    email(email: string): boolean;
+    /**
+     * 验证身份证
+     * @param idCard 身份证号
+     */
+    idCard(idCard: string): boolean;
+}
+/**
+ * input长度验证
+ */
+declare class InputLengthValidate {
+    private validators;
+    private checkLength;
+    private maxLength;
+    constructor();
+    limitLength(value: string, limit: number): string;
+}
+/**
+ * 检查值是否为空
+ * @param value 要检查的值
+ * @return {boolean} 如果值为空返回 true，否则返回 false
+ */
+declare function isNull(value: typeIsNull): boolean;
+/**
+ * 对数型结构进行数据处理和映射关系
+ */
+type Mapping = Record<string, string>;
+declare class dataHandler {
+    private fields;
+    private node;
+    private mapping;
+    constructor(fields: typeof HAS_FEILD, node: any, mapping: Mapping);
+    private processNode;
+    private processAllNodes;
+    getProcessedData(): any;
+}
+/**
+ * @param data 树形数据
+ * @param targetDeptCode 子节点DeptCode
+ * @returns 查找叶子节点并返回路径
+ */
+declare function findTreeDataNode(data: ISectoralTable[], targetDeptCode: string): string | null;
+/**
+ * @param dept 树形数据
+ * @param queryString 子节点DeptCode
+ * @param results 查找结果集
+ */
+declare function findTreeDataNodeName(dept: ISectoralTable, queryString: string, results: ISectoralTable[]): void;
+
+declare class Mask {
+    private task;
+    private selectors;
+    private opacity;
+    private elementIndex;
+    constructor(selectors: string[], opacity?: number);
+    start(): void;
+    process(handle: (resolve: any, index: number, element: Element) => void): this;
+    open(element?: Element): void;
+    close(): void;
+}
+
+type TourPlaceholder = {
+    title: string;
+    text: string;
+    next: string;
+};
+declare class Tour {
+    private selectors;
+    private elementIndex;
+    private tourTargetElement;
+    private tourElement;
+    private tourElementContentTemplate;
+    private placeholder;
+    private config;
+    constructor(selectors: string[]);
+    setPlaceholder(placeholder: TourPlaceholder): void;
+    setContentTemplate(template: string): void;
+    setConfig(config: Partial<typeof this.config>): void;
+    start(): void;
+    layout(element: HTMLElement): void;
+    close(): void;
+}
+
+type WebSocketState = 'CONNECTING' | 'OPEN' | 'CLOSING' | 'CLOSED';
+interface WebSocketConfig {
+    timeout?: number;
+    reconnect: boolean;
+    reconnectTime?: number;
+    maxReconnectNumber?: number;
+}
+declare function createWebSocket(url: string, config: WebSocketConfig | null, onOpen?: Function | null): WebSocket;
+declare function useSendMessage(ws: WebSocket, data: any): void;
+declare function useWebSocketMessage(ws: WebSocket, callback: Function): void;
+declare function useWebSocketClose(ws: WebSocket, code?: number, message?: string): void;
+declare function getState(ws: WebSocket, type: WebSocketState): boolean;
+
+/**
+ * 匹配中文字母数字
+ */
+declare const ZN_LETTER_NUMBER: RegExp;
+/**
+ * 匹配 IP
+ */
+declare const IP: RegExp;
+/**
+ * 匹配手机号
+ */
+declare const PHONE: RegExp;
 
-export { RecordType };
-export type { Tag };
+export { HAS_FEILD, IP, InputLegalityValidate, InputLengthValidate, LENGTH_LIMIT, LOGIN_TYPE, Mask, PHONE, RecordType, Request, RequestChain, Tour, ZN_LETTER_NUMBER, createWebSocket, dataHandler, debounce, deepMerge, findTreeDataNode, findTreeDataNodeName, getState, isMobileDevice, isNull, objectArrayToString, throttle, useCountDown, useSendMessage, useWebSocketClose, useWebSocketMessage };
+export type { ISectoralTable, Tag, typeIsNull };