@zero-library/common 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,356 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode } from 'react';
+import dayjs from 'dayjs';
+import Decimal from 'decimal.js';
+import { ResponseType } from 'axios';
+import { ThemeConfig } from 'antd/lib';
+
+interface Props$9 {
+    fileUrl: string;
+}
+declare const _default$b: ({ fileUrl }: Props$9) => react_jsx_runtime.JSX.Element;
+
+interface Props$8 {
+    suffix?: string;
+    fontSize?: number;
+}
+declare const _default$a: ({ suffix, fontSize }: Props$8) => react_jsx_runtime.JSX.Element;
+
+interface Props$7 {
+    fileUrl: string;
+    suffix?: string;
+    password?: string;
+    searchValue?: string;
+    pdfParams?: {
+        pageNo?: number;
+        scale?: number;
+        isHasThumbnails?: boolean;
+        onSetPageNo?: (pageNo: number) => void;
+    };
+    fileParams?: ObjectType<string>;
+    onSetPassSuccess?: () => void;
+}
+declare const _default$9: ({ suffix, fileUrl, pdfParams, password, searchValue }: Props$7) => react_jsx_runtime.JSX.Element;
+
+interface Props$6 {
+    open: boolean;
+    onClose: () => void;
+    title?: string;
+    fileUrl: string;
+    suffix?: string;
+    password?: string;
+    fileParams?: ObjectType<string>;
+    pdfParams?: {
+        pageNo?: number;
+        scale?: number;
+        isHasThumbnails?: boolean;
+        onSetPageNo?: (pageNo: number) => void;
+    };
+    onSetPassSuccess?: () => void;
+}
+declare const _default$8: ({ open, fileUrl, suffix, title, onClose, password, fileParams, pdfParams, onSetPassSuccess }: Props$6) => react_jsx_runtime.JSX.Element;
+
+interface Props$5 {
+    fileUrl: string;
+    searchValue?: string;
+}
+declare const _default$7: ({ fileUrl, searchValue }: Props$5) => react_jsx_runtime.JSX.Element;
+
+interface Props$4 {
+    fileUrl: string;
+    pageNo?: number;
+    scale?: number;
+    isHasThumbnails?: boolean;
+    password?: string;
+    onSetPassword?: (password: string) => void;
+    onSetPageNo?: (pageNo: number) => void;
+}
+declare const _default$6: ({ password, fileUrl, pageNo, scale, isHasThumbnails, onSetPassword, onSetPageNo }: Props$4) => react_jsx_runtime.JSX.Element;
+
+interface Props$3 {
+    fileUrl: string;
+}
+declare const _default$5: ({ fileUrl }: Props$3) => react_jsx_runtime.JSX.Element;
+
+interface IframeProps {
+    id?: string;
+    src: string;
+    className?: string;
+    onLoad?: () => void;
+}
+declare const _default$4: react.ForwardRefExoticComponent<IframeProps & react.RefAttributes<HTMLIFrameElement>>;
+
+type ComponentMapType = Record<string, () => Promise<{
+    default: React.ComponentType<any>;
+}>>;
+type Props$2 = {
+    type: string;
+    customComponents?: ComponentMapType;
+    [key: string]: any;
+};
+declare const _default$3: ({ type, customComponents, ...rest }: Props$2) => react_jsx_runtime.JSX.Element;
+
+interface Props$1 {
+    content?: string;
+    searchValue?: string;
+    customComponents?: ComponentMapType;
+    onChange?: (value: string) => void;
+    onPartialChange?: (oldValue: string, newValue: string) => void;
+}
+declare const _default$2: ({ content, searchValue, customComponents, onChange, onPartialChange }: Props$1) => react_jsx_runtime.JSX.Element;
+
+type RenderControl<C, P = ObjectType<any>> = boolean | {
+    visible?: boolean;
+    render?: (ctx: C) => React.ReactNode;
+    props?: P;
+};
+interface RenderWrapperProps<C, P> {
+    control?: RenderControl<C, P> | null;
+    ctx?: C;
+    DefaultComponent?: React.ReactNode | ((props: P) => React.ReactNode);
+}
+declare function RenderWrapper<C = any, P = any>({ control, ctx, DefaultComponent }: RenderWrapperProps<C, P>): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<react.ReactNode>;
+declare const shouldRender: (control?: RenderControl<any, any> | null) => boolean;
+declare function propsMerge(control?: RenderControl<any, any> | null, props?: ObjectType<any>): {
+    props: any;
+};
+
+interface Props {
+    avatarSrc?: string;
+    userName?: string;
+    size?: number;
+}
+declare const _default$1: ({ size, avatarSrc, userName }: Props) => react_jsx_runtime.JSX.Element;
+
+/**
+ * 通用的 Valtio Context 工厂
+ * 支持：
+ *  - useStore() 获取 store 实例
+ */
+declare function createValtioContext<T extends object>(): {
+    ValtioProvider: ({ store, children }: {
+        store: T;
+        children?: ReactNode;
+    }) => react_jsx_runtime.JSX.Element;
+    useValtioStore: () => T;
+};
+
+type Params = Record<string, any>;
+/**
+ * 通知当前页面的父页面或者顶级窗口
+ */
+declare function emit(type: string, data?: Params, to?: 'parent' | 'top'): void;
+/**
+ * 通知某个子 iframe 窗口（必须传入 iframe.contentWindow）
+ */
+declare function emitToChild(iframeWindow: Window | null, type: string, data?: Params, origin?: string): void;
+
+type Handler<P = Params> = (params: P, source?: MessageEventSource | null, origin?: string) => void;
+declare function useIframeRelayBridge(allowedOrigins?: string[]): {
+    on: (type: string, handler: Handler<Params>) => void;
+    off: (type: string, handler: Handler<Params>) => void;
+};
+
+/**
+ * 防抖hook
+ * @param func 需要执行的函数
+ * @param wait 延迟时间
+ */
+declare function useDebounce<A extends Array<any>, R = void>(func: (..._args: A) => R, wait?: number): {
+    (..._args: A): Promise<R>;
+    flush: () => any;
+    cancel: () => void;
+};
+
+/**
+ * useDeepEffect
+ * 深层对比依赖项的 useEffect
+ */
+declare function useDeepEffect(effect: React.EffectCallback, deps: any[]): void;
+
+declare function useRefState<T>(init: T): readonly [T, (newVal: T) => void, () => T];
+
+declare const useSyncInput: <T>(storeValue: T, setStoreValue: (value: T) => void) => {
+    inputValue: T;
+    setInputValue: (value: T) => void;
+};
+
+/**
+ * 节流hook
+ * @param func 需要执行的函数
+ * @param wait 延迟时间
+ */
+declare function useThrottle<A extends Array<any>, R = void>(func: (..._args: A) => R, wait: number): {
+    (..._args: A): Promise<R>;
+    flush: () => any;
+    cancel: () => void;
+};
+
+interface UseWebSocketParams {
+    url: string;
+    onMessage: (message: any) => void;
+    onClose?: () => void;
+    heartbeatInterval?: number;
+    heartbeatMessage?: string;
+    clientHeartbeat?: boolean;
+    reconnectInterval?: number;
+    maxReconnectAttempts?: number;
+    isReconnect?: boolean;
+}
+interface UseWebSocketReturn {
+    sendMessage: (message: string) => void;
+    socketReadyState: number | null;
+}
+declare const useWebSocket: ({ url, onMessage, onClose, heartbeatInterval, heartbeatMessage, clientHeartbeat, reconnectInterval, maxReconnectAttempts, isReconnect }: UseWebSocketParams) => UseWebSocketReturn;
+
+declare const deepCopy: <T>(arg: T, isJson?: boolean) => T;
+declare function deepEqual(a: any, b: any): boolean;
+declare const deepMerge: <T extends Record<string, any>>(base: T, override: Partial<T>) => T;
+declare const objToOptions: (obj: ObjectType<string>) => {
+    label: string;
+    value: number;
+}[];
+declare const arrToObj: <T>(arr: T[], key: string) => {
+    [key: string]: T;
+};
+interface NsSetIntervalReturnType {
+    isRun: () => boolean;
+    cancel: () => void;
+}
+declare const nsSetInterval: (fn: () => void, t: number) => NsSetIntervalReturnType;
+declare const genNonDuplicateID: () => string;
+declare const copyText: (text: string) => Promise<void>;
+/**
+ * 把后台接口字段，返回的关于金额的数字，转换为千分符号分隔的数字
+ * return string
+ */
+declare function formatNumberWithCommas(number: number | string): string | number;
+declare const generateRandomNumbers: (min: number, max: number, count: number) => number[];
+declare const getFileName: (filePath: string) => string;
+declare const textAreaView: (con?: string) => string;
+/**
+ * 将对象转换为 URL 查询参数字符串
+ * @param obj - 要转换的对象
+ * @param url - 要拼接的 URL，如果未提供，则返回查询参数字符串
+ * @returns URL 查询参数字符串
+ */
+declare const buildUrlParams: (obj: Record<string, any>, url?: string) => string;
+declare const downloadFile: (url: string, name?: string) => void;
+/**
+ * 给URL路径最后加/
+ */
+declare const addUrlLastSlash: (url?: string) => string;
+/**
+ * 给url增加mainSource参数
+ */
+declare const getUrlMainSource: (url: string, preHref?: string) => string;
+/**
+ * 获取 WebSocket 地址
+ * @param path WebSocket 服务路径，比如 "/ws" 或 "/socket"
+ * @param customHost 可选，指定 host:port；默认取当前 window.location.host
+ */
+declare const getWebSocketUrl: (path: string, customHost?: string) => string;
+
+type DateType = string | number | Date | dayjs.Dayjs | null;
+declare const DateFormatType = "YYYY-MM-DD HH:mm:ss";
+declare const DateFormatType2 = "YYYY-MM-DD";
+/**
+ * 获取一天的最早时间 '2023/10/17 00:00:00' 的时间戳
+ */
+declare const getStartOfTimestamp: (date?: DateType, unit?: dayjs.OpUnitType) => number;
+/**
+ * 获取一天的最晚时间 '2023/10/17 23:59:59' 的时间戳
+ */
+declare const getEndOfTimestamp: (date?: DateType, unit?: dayjs.OpUnitType) => number;
+declare const formatDate: (date: Date | number | string, fmt?: string) => string;
+declare const getTimestamp: (date?: DateType) => number;
+declare const isExpire: (date?: DateType) => boolean;
+
+declare function is(val: unknown, type: string): boolean;
+declare function isUnDef<T = unknown>(val?: T): val is T;
+declare function isDef<T = unknown>(val?: T): val is T;
+declare function isObject(val: any): val is Record<any, any>;
+declare function isEmptyObj<T = unknown>(val: T): boolean;
+declare function isDate(val: unknown): val is Date;
+declare function isNull(val: unknown): val is null;
+declare function isNullOrUnDef(val: unknown): val is null | undefined;
+declare function isNumber(val: unknown): val is number;
+declare function isNumberNoNaN(val: unknown): val is number;
+declare function isString(val: unknown): val is string;
+declare function isFunction(val: unknown): boolean;
+declare function isPromise<T = any>(val: unknown): val is Promise<T>;
+declare function isBoolean(val: unknown): val is boolean;
+declare function isRegExp(val: unknown): val is RegExp;
+declare function isArray(val: any): val is Array<any>;
+declare function isEmpty<T = unknown>(val: T): val is T;
+declare function isWindow(val: any): val is Window;
+declare function isElement(val: unknown): val is Element;
+declare function isMap(val: unknown): val is Map<any, any>;
+declare const isServer: boolean;
+declare const isClient: boolean;
+/**
+ * 判断是否是外链
+ * @param {string} path
+ * @returns {Boolean}
+ * @author LiQingSong
+ */
+declare const isExternal: (path: string) => boolean;
+declare const isBlob: (val: unknown) => boolean;
+
+declare function setCurrentUser(userInfo: any): void;
+declare function getCurrentUser(): any;
+declare function clearCurrentUser(): void;
+declare function getDeviceId(): string;
+
+type OperatorType = '+' | '-' | '*' | '/';
+declare const calculate: (operator: OperatorType, ...args: Decimal.Value[]) => string;
+declare const plus: (...args: Decimal.Value[]) => string;
+declare const minus: (...args: Decimal.Value[]) => string;
+declare const times: (...args: Decimal.Value[]) => string;
+declare const dividedBy: (...args: Decimal.Value[]) => string;
+declare const decimalPlaces: (arg1: Decimal.Value) => number;
+declare const precision: (arg1: Decimal.Value) => number;
+declare const absVal: (arg1: Decimal.Value) => string;
+declare const compareNum: (arg1: Decimal.Value, arg2: Decimal.Value, type: string) => boolean;
+declare const toFixed: (num: Decimal.Value, decimals?: number, fill?: boolean) => string;
+declare const isInteger: (num: Decimal.Value) => boolean;
+declare const isNegative: (num: Decimal.Value) => boolean;
+
+declare const OK = 200;
+declare const OK2 = "S0000";
+declare const ERROR = 500;
+declare const MISSING_PARAMETER = 400;
+declare const UNAUTHORIZED = 401;
+declare const FORBIDDEN = 403;
+declare const NOT_FOUND = 404;
+declare const ILLEGAL_PARAMETER = 901;
+declare const PERMISSION_DENIED = 13001;
+declare const LoginPastCode = 11200;
+declare const FacePastCode = 11201;
+declare const formType = "form";
+declare const jsonType = "json";
+interface Options {
+    reqType?: 'json' | 'form';
+    timeout?: number;
+    responseType?: ResponseType;
+    showError?: boolean;
+}
+declare const _default: {
+    get: (url: string, params?: any, options?: Options) => Promise<any>;
+    post: (url: string, data?: any, options?: Options) => Promise<any>;
+    put: (url: string, data?: any, options?: Options) => Promise<any>;
+    delete: (url: string, data?: any, options?: Options) => Promise<any>;
+};
+
+declare const TOKEN_KEY = "NS-TOKEN";
+declare function setToken(accessToken: string): void;
+declare function getUrlToken(): string;
+declare function getToken(): string;
+declare function clearToken(): void;
+declare function getSignPath(): string;
+
+declare const LgPrimaryColor: string;
+declare const themeConfig: ThemeConfig;
+
+export { _default$b as AudioPlayer, DateFormatType, DateFormatType2, ERROR, FORBIDDEN, FacePastCode, _default$a as FileIcon, _default$9 as FilePreview, _default$8 as FilePreviewDrawer, ILLEGAL_PARAMETER, _default$4 as Iframe, _default$3 as LazyComponent, LgPrimaryColor, LoginPastCode, MISSING_PARAMETER, _default$7 as MarkdownPreview, NOT_FOUND, type NsSetIntervalReturnType, OK, OK2, PERMISSION_DENIED, type Params, _default$6 as PdfPreview, type RenderControl, _default$2 as RenderMarkdown, RenderWrapper, TOKEN_KEY, UNAUTHORIZED, _default$1 as UserAvatar, _default$5 as VideoPlayer, absVal, addUrlLastSlash, arrToObj, buildUrlParams, calculate, clearCurrentUser, clearToken, compareNum, copyText, createValtioContext, decimalPlaces, deepCopy, deepEqual, deepMerge, dividedBy, downloadFile, emit, emitToChild, formType, formatDate, formatNumberWithCommas, genNonDuplicateID, generateRandomNumbers, getCurrentUser, getDeviceId, getEndOfTimestamp, getFileName, getSignPath, getStartOfTimestamp, getTimestamp, getToken, getUrlMainSource, getUrlToken, getWebSocketUrl, is, isArray, isBlob, isBoolean, isClient, isDate, isDef, isElement, isEmpty, isEmptyObj, isExpire, isExternal, isFunction, isInteger, isMap, isNegative, isNull, isNullOrUnDef, isNumber, isNumberNoNaN, isObject, isPromise, isRegExp, isServer, isString, isUnDef, isWindow, jsonType, minus, nsSetInterval, objToOptions, plus, precision, propsMerge, _default as request, setCurrentUser, setToken, shouldRender, textAreaView, themeConfig, times, toFixed, useDebounce, useDeepEffect, useIframeRelayBridge, useRefState, useSyncInput, useThrottle, useWebSocket };