ls-pro-common 3.0.13 → 3.0.15

package/es/typing.d.ts

@@ -0,0 +1,53 @@
+/** @name 接口返回值 */
+export declare type ApiResponse = Record<string, any> & {
+    flag?: {
+        retCode?: string;
+        retMsg?: string;
+        retDetail?: string;
+        faultCode?: string;
+        requestId?: string;
+    };
+    rows?: [];
+    data?: any;
+    total?: 0;
+    id?: string;
+    billNo?: string;
+};
+export declare type TableToolbar = {
+    add?: boolean;
+    edit?: boolean;
+    remove?: boolean;
+    export?: boolean;
+    import?: boolean;
+    audit?: boolean;
+    config?: boolean;
+    print?: boolean;
+};
+/** 基础模块接口类型 */
+export declare type BaseApiType = {
+    /**加载数据api */
+    load?: string;
+    /**新增数据api */
+    add?: string;
+    /**更改数据api,如果跟新增接口一样，可不指定 */
+    edit?: string;
+    /**删除数据api */
+    delete?: string;
+    /**主从一起保存方法，新增，现改，删除共用一个接口 */
+    mstDtl?: string;
+    /**导入数据api */
+    import?: string;
+    /**导出数据api,如果跟加载数据api一致，可不指定 */
+    export?: string;
+    /** 审核接口 */
+    audit?: string;
+};
+/**请求后端接口方法 */
+export declare type MethodType = {
+    /**加载数据对应的方法，默认为get, 如果请求参数太长时，后端可能会改为post */
+    get: 'get' | 'post';
+    /** 更改数据的请求方法，默认为 put, 也可以是post，根据后端接口而定 */
+    edit: 'put' | 'post';
+    /** 删除数据的请求方法，默认为delete, 也可以是post,根据后端接口而定 */
+    delete: 'delete' | 'post';
+};

package/es/typing.js

@@ -0,0 +1 @@
+export {};

package/es/utils/index.d.ts

@@ -0,0 +1,258 @@
+import { ModalFuncProps } from 'antd';
+import ReactDOM from 'react-dom';
+import React from 'react';
+export { throttle, debounce } from 'lodash';
+export { getUrlQuery, setUrlQuery, toGatewayUrl, dateFormat, getResourceProps } from 'ls-pro-table';
+/**
+ * 设置文档title
+ * @param {*} title
+ * @returns
+ */
+export declare const setTitle: (title: string) => void;
+/**
+ * 日期格式化
+ * @param dt 日期
+ * @param showTime 是否显示时间 默认true
+ * @returns YYYY-MM-DD hh:mm:ss
+ */
+export declare const formatDate: (dt: Date | null | undefined, showTime?: boolean | undefined) => string;
+/**
+ * 返回当前日期
+ * @returns YYYY-MM-DD
+ */
+export declare const today: () => string;
+/**
+ * 返回当前日期时间
+ * @returns YYYY-MM-DD hh:mm:ss
+ */
+export declare const now: () => string;
+/**
+ * 时间加减
+ * @param dt 原始时间，传 null 为当前时间
+ * @param addDay 添加添数，可为负数
+ * @param addMonth 添加月数，可为负数
+ * @param addYear 添加年数，可以负责
+ * @returns YYYY-MM-DD hh:mm:ss
+ */
+export declare const dateAdd: (dt: Date | null, addDay: number, addMonth?: number, addYear?: number) => string;
+/**
+ * 当前时间加减
+ * @param addDay 添加添数，可为负数
+ * @param addMonth 添加月数，可为负数
+ * @param addYear 添加年数，可以负责
+ * @returns YYYY-MM-DD hh:mm:ss
+ */
+export declare const nowAdd: (addDay: number, addMonth?: number, addYear?: number) => string;
+/**
+ * 当前日期加减
+ * @param addDay 添加添数，可为负数
+ * @param addMonth 添加月数，可为负数
+ * @param addYear 添加年数，可以负责
+ * @returns YYYY-MM-DD
+ */
+export declare const todayAdd: (addDay: number, addMonth?: number, addYear?: number) => string;
+/**
+ * 千位符格式化数值
+ * @param num 数值
+ * @param dec 小数位数,默认为2位小数
+ * @returns xx,xxx.xx
+ */
+export declare const formatMoney: (num: number | string, dec?: number) => string;
+/**
+ * 获取Cookie
+ * @param {String} name cookie名
+ * @returns
+ */
+export declare const getCookie: (name: string) => string | null;
+/**
+ * 设置Cookie
+ * @param {*} key Cookie名称
+ * @param {*} value  Cookie 值
+ * @param { Number } day 有效天数 默认1天,
+ */
+export declare const setCookie: (key: string, value: string | number, day?: number, sameSite?: boolean) => void;
+/**
+ * 判断是否登录
+ * @returns
+ */
+export declare const isLogin: () => boolean;
+export declare const getFullScreenElement: () => any;
+/**
+ * 设置本地缓存
+ * @param { String } key 关键字
+ * @param { Object } data 值
+ * @param { Boolean } session 保存到 sessionStorage 还是 localStorage,默认 localStorage
+ */
+export declare const setCache: (key: string, data: any, session?: boolean) => void;
+/**
+ * 读取本地缓存
+ * @param { String } key 关键字
+ * @param { boolean } session 从 sessionStorage 取数还是从 localStorage 中取数 默认从 localStorage
+ * @returns 关键字对应的值
+ */
+export declare const getCache: (key: string, session?: boolean) => string | null;
+/**
+ * 读取本地缓存，优先从sessionStorage 取，取不到时再从 localStorage取
+ * @param key
+ * @returns
+ */
+export declare const getCacheSessionFirst: (key: string) => string | null;
+/**
+ *
+ * @param key 关键字，不传清除所有
+ * @param session 是否session storage , 默认 localStorage
+ */
+export declare const clearCache: (key?: string | undefined, session?: boolean) => void;
+/** @name 显示错误 */
+export declare const showError: (text: string, duration?: number) => void;
+/** @name 显示警示 */
+export declare const showWarn: (text: string, duration?: number) => void;
+/** @name 显示成功 */
+export declare const showSuccess: (text: string, duration?: number) => void;
+/**
+ * 弹框提示
+ * @param text 提示信息
+ * @param title 标题，默认 系统提示
+ * @param type 类型
+ * @param opts 附加参数
+ * @returns Promise<Boolean>
+ */
+export declare const showAlert: (text: React.ReactDOM | string, title?: string, type?: 'error' | 'info' | 'success' | 'warn', opts?: ModalFuncProps) => Promise<unknown>;
+export declare const httpError: (retMsg?: string | undefined, retCode?: string | undefined, faultCode?: string | undefined, opts?: ModalFuncProps) => Promise<unknown>;
+export declare const exitAlert: () => void;
+/** @name 显示确认 */
+export declare const showConfirm: (text: string, title?: string) => Promise<unknown>;
+/**
+ * token过期重新登录
+ * @returns
+ */
+export declare const reLogin: () => void;
+/**
+ * 日期组选择转换
+ * @param values 选择的值
+ * @param startField  第一个字段
+ * @param endField  第二个字段
+ * @param endSuffix
+ * @returns
+ */
+export declare const rangeToSearch: (values: any, startField: string, endField: string, endSuffix?: string, startSuffex?: string) => any;
+/** @name 状态列表 */
+export declare const statusList: {
+    value: number;
+    text: string;
+    label: string;
+}[];
+/** @name 是否列表 */
+export declare const yesnoList: {
+    value: number;
+    text: string;
+    label: string;
+}[];
+/**
+ * 遍历树
+ * @param list 树对象
+ * @param fn 回调函数
+ * @param children 树属性字段
+ */
+export declare const treeEach: (list: any[], fn: (item: any, index: any, list: any[]) => void, children?: string) => void;
+/**
+ * 查询数
+ * @param list 树对象
+ * @param key 查询属性
+ * @param val 查询值
+ * @param children 树属性字段
+ * @returns 返回符合条件的第一条对象
+ */
+export declare const treeFind: (list: any[], key: string, val: any, children?: string) => any;
+/**
+ * 处理普通的尺码横排
+ * @param orgSizeHeader 后端返回的原始尺码组表头
+ * @param typeWidth 尺码组宽 sizeTypeNo，默认120
+ * @param sizeWidth 尺码宽f1~f100， 默认100
+ * @returns 返回已处理好的表头[{dataIndex:sizeTypeNo,title:'国标码',width:120,children[...]},{dataIndex:'f1',...}...]
+ */
+export declare const handleSizeCols: (orgSizeHeader: any[], typeWidth?: number, sizeWidth?: number) => any[];
+/**
+ * 绑定事件
+ * @param eventName  事件名
+ * @param fn  调用函数
+ * @param el  源对象，默认为window
+ */
+export declare const on: (eventName: string, fn: Function, el: any | undefined) => void;
+/**
+ * 解绑事件
+ * @param eventName 事件名
+ * @param fn 调用函数
+ * @param el 源对象，默认为window
+ */
+export declare const off: (eventName: string, fn: Function, el: any | undefined) => void;
+/**
+ * 打印预览
+ * @param templateNo 打印模板编码
+ * @param reqUrl 业务请求api
+ * @param bodyParam Post传参数
+ * @param param get传参数
+ * @param method 请求方式，默认post
+ * @returns
+ */
+export declare const printView: (templateNo: string, reqUrl: string, bodyParam?: any, param?: any, method?: 'POST' | 'GET') => any;
+/**
+ * 直接打印
+ * @param taskName 打印任务名
+ * @param templateNo 打印模板
+ * @param reqUrl 业务请求api
+ * @param bodyParam Post传参数
+ * @param param get传参数
+ * @param method 请求方式，默认post
+ * @returns
+ */
+export declare const printAsync: (taskName: string, templateNo: string, reqUrl: string, bodyParam?: any, param?: any, method?: 'POST' | 'GET') => Promise<any>;
+export declare const isDev: boolean;
+export declare type UserType = {
+    id?: string;
+    userId?: string;
+    userName?: string;
+    loginName?: string;
+    companyId?: string;
+    companyCode?: string;
+    companyName?: string;
+    email?: string;
+    employeeAttr?: string;
+    expireTime?: string;
+    icon?: string;
+    idCard?: string;
+    ifAdmin?: number | string;
+    orgId?: string;
+    orgParentIds?: string;
+    phoneNumber?: string;
+    remarks?: string;
+};
+/** @name 用户信息 */
+export declare const getUserInfo: () => UserType | null;
+/** @name 用户名 */
+export declare const getUserName: () => string | undefined;
+/** @name 登录名 */
+export declare const getLoginName: () => string | undefined;
+/** @name 公司Id */
+export declare const getCompanyId: () => string | undefined;
+/** @name 微前端原生路径 */
+export declare const appPath: (path?: string) => any;
+/**
+ * 深度复制对象
+ * @param obj
+ * @returns
+ */
+export declare const deepClone: (obj: any) => any;
+/**
+ * 在主工程中打开模块
+ * @param option {path:模块路由,需要加工程编码, resourceId: 资源Id，两者传一个即可,data:参数}
+ */
+export declare const openPageInMain: (option: {
+    path?: string;
+    resourceId?: string;
+    data?: any;
+    ifRefreshTarget?: boolean;
+}) => void;
+export declare const showLoading: (text?: string) => void;
+export declare const exitLoading: () => void;
+export declare const handleTheme: () => void;