kn-cli 1.0.91 → 1.0.93

package/templates/{template_oa_jwt/public/src/components/FormTable → template_oa/public/src/components/formTable}/index.jsx

@@ -1,7 +1,46 @@
+// @ts-ignore
 import React ,{useImperativeHandle,useState,forwardRef} from 'react';
+
+// @ts-ignore
 import uuid from 'js-uuid';
+
+// @ts-ignore
 import styles from './index.less';
 
+
+/**
+ * @typedef {object} ColumnsOptions
+ * @property {string} formItemName
+ * @property {(record:any,index:number,event:any)=>void} onDel
+ * @property {(record:any,index:number,event:any)=>void} onAdd
+ * @property {(record:any,index:number,event:any)=>void} onCopy
+ * @property {(initValue:[],event:any)=>void} onReset
+ */
+
+/**
+ * 表格表单组件
+ * @param {Object} props 
+ * @param {JSX.Element|any} props.Table - Table组件，一般为antd的Table组件 
+ * @param {Object} props.form - Form组件
+ * @param {string} props.formItemName - 表格FormItem的name
+ * @param {boolean} [props.saveLast=false] - 是否当没有数据时，默认保留一行数据
+ * @param {Object[]} [props.initialValue] - 初始数据
+ * 
+ * @param {(record:object,index:number)=>object[]} [props.onCopy] - 点击复制的回调
+ * @param {(record:object,index:number)=>object[]} [props.onAdd] - 点击添加的回调
+ * 
+ * @param {(value:any)=>void} [props.onChange] - 数据发生变动时的回调
+ * @param {(value:any)=>void} [props.onRefresh] - 刷新时的回调
+ * 
+ * @param {(options:ColumnsOptions)=>[]} props.columns - 获取列配置数据的回调
+ * 
+ * @param {Object} [props.newdata] - 添加新行的数据模版
+ * @param {Object} [props.antTableOptions] - antd的Table扩展参数
+ * 
+ * @param {any} ref 
+ * 
+ * @returns 
+ */
 const TableFormItem =(props,ref)=> {
   const {Table,form,formItemName,saveLast} = props;
   const getNewId=()=>{
@@ -121,7 +160,6 @@ const TableFormItem =(props,ref)=> {
   }));
 
   return (
-   
     <Table
       className={styles.table}
       {...{rowKey: '_rowKey',...props.antTableOptions}}

package/templates/template_oa/public/src/components/iconFont/index.jsx

@@ -0,0 +1,22 @@
+// @ts-ignore
+import React from "react";
+
+// @ts-ignore
+import styles from'./index.less';
+
+/**
+ * iconFont图标
+ * @param {object} props 
+ * @param {string} [props.icon] - 图标名称
+ * @param {string} [props.className] - 扩展类名
+ * @param {()=>void} [props.onClick] - 点击回调
+ * 
+ * @returns {JSX.Element}
+ */
+const IconFont=(props)=>{
+  const {icon,className,...others} = props;
+  return (
+    <span {...others} className={`iconfont icon-${icon} ${styles.iconBox} ${className||''}`} ></span>
+  )
+}
+export default IconFont;

package/templates/template_oa/public/src/components/{IFrame → iframe}/index.jsx

@@ -1,20 +1,34 @@
+// @ts-ignore
 import React, { useEffect,useState,useRef } from 'react';
+
+// @ts-ignore
 import styles from './index.less';
 
+/**
+ * iframe组件
+ * @param {object} props 
+ * @param {string} props.name - iframe的唯一名称
+ * @param {string} props.url - url地址
+ * 
+ * @param {string} [props.className] - 扩展样式名
+ * 
+ * @returns {JSX.Element}
+ */
 const Iframe=(props)=>{
-  const {className=''}=props;
+  const {className='',name,url}=props;
   const ref = useRef();
   const [height,setHeight] = useState('0px');
 
   useEffect(()=>{
     window.addEventListener('message',(e)=>{
       if(e?.data?.msg==='resize'){
-        if(e.data.id===props.name){
+        if(e.data.id===name){
           setHeight(e.data.height+2+'px');
         }
       }else if(e?.data?.msg==='link'){
         location.href=e.data.url;
       }else if(e?.data?.msg==='server'){
+        // @ts-ignore
         const url = `${OA_KSSO_HOST}?target=${encodeURIComponent(location.href)}`;
         location.href=url;
       }else{
@@ -27,9 +41,9 @@ const Iframe=(props)=>{
     <iframe 
       className={`${styles.iframeWrap} ${className}`}
     sandbox='allow-same-origin allow-scripts'
-      name={props.name}
+      name={name}
       ref={ref}
-      src={props.url}
+      src={url}
       style={{width:'100%',height:height,verticalAlign:'bottom'}}
       scrolling="none" 
       frameBorder="0" 

package/templates/template_oa/public/src/components/{Layout/Basic → layout/basic}/index.jsx

@@ -1,6 +1,11 @@
+// @ts-ignore
 import React from 'react';
+// @ts-ignore
 import {Outlet} from 'react-router-dom';
-import Iframe from '@/components/IFrame';
+
+import Iframe from '@/components/iframe';
+
+// @ts-ignore
 import styles from './index.less';
 
 
@@ -8,6 +13,7 @@ const LayoutBasic=(props)=>{
   const {nav=""} = props;
   return ( 
     <section className={styles.htmlWrap}>
+      {/* @ts-ignore */}
       <Iframe name='header' url={OA_MENU_HOST} className={styles.iframeHeader} />
       <section className={styles.headerSpace}></section>
 

package/templates/{template_oa_jwt/public/src/components/Layout/CenterBody → template_oa/public/src/components/layout/centerBody}/index.jsx

@@ -1,5 +1,7 @@
+// @ts-ignore
 import React from 'react';
 
+// @ts-ignore
 import styles from './index.less';
 
 

package/templates/{template_oa_jwt/public/src/components/Layout/FormBlock → template_oa/public/src/components/layout/formBlock}/index.jsx

@@ -1,6 +1,8 @@
+// @ts-ignore
 import React from 'react';
-import styles from './index.less';
 
+// @ts-ignore
+import styles from './index.less';
 
 
 export const FormBlockByTitle = (props) => {

package/templates/template_oa/public/src/components/{Layout → layout}/index.jsx

@@ -1,13 +1,19 @@
+// @ts-ignore
 import React from 'react';
-import ProviderApp from '@/provider/app';
-
-
+// @ts-ignore
 import {Outlet} from 'react-router-dom';
-import { ConfigProvider } from 'antd';
-import LayoutBasic from './Basic';
-import LayoutCenterBody from './CenterBody';
+// @ts-ignore
 import zhCN from 'antd/lib/locale/zh_CN';
+// @ts-ignore
+import { ConfigProvider } from 'antd';
+
+
+import ProviderApp from '@/provider/app';
+
+import LayoutBasic from './basic';
+import LayoutCenterBody from './centerBody';
 
+// @ts-ignore
 import styles from './index.less';
 styles;
 

package/templates/{template_oa_jwt/public/src/components/Layout/Provider → template_oa/public/src/components/layout/provider}/index.jsx

@@ -1,5 +1,9 @@
+// @ts-ignore
 import React from 'react';
+// @ts-ignore
 import {Outlet} from 'react-router-dom';
+
+
 import ProviderApp from '@/provider/app';
 
 const LayoutProvider=(props)=>{

package/templates/template_oa/public/src/components/{Link → link}/index.jsx

@@ -1,7 +1,23 @@
+// @ts-ignore
 import React  from 'react';
+
 import { openLink,jumpUrl } from '@/utils';
+
+// @ts-ignore
 import styles from './index.less';
 
+
+/**
+ * 超链接组件
+ * @param {object} [props] 
+ * @param {JSX.Element|string} [props.children] - 子组件
+ * @param {string} [props.className] - 扩展类样式名称
+ * @param {Function} [props.onClick] - 点击链接的回调
+ * @param {string} [props.href] - 跳转链接
+ * @param {string} [props.target] - 当target='_blank'时代表新窗口打开
+ * 
+ * @returns {JSX.Element}
+ */
 const Link=(props)=>{
   const {children,className='',onClick,href='',target=''} = props;
 

package/templates/template_oa/public/src/components/{Nav → nav}/index.jsx

@@ -1,9 +1,15 @@
-import { Menu } from 'antd';
+// @ts-ignore
 import React, { useEffect, useRef, useState } from 'react';
+// @ts-ignore
 import {matchPath,useLocation,useNavigate,} from 'react-router-dom';
+// @ts-ignore
+import { Menu } from 'antd';
+// @ts-ignore
 import { AppstoreOutlined, MailOutlined, SettingOutlined } from '@ant-design/icons';
+
 import {useLoading} from '@/hooks';
 
+// @ts-ignore
 import styles from './index.less';
 
 const ICON_NAME={
@@ -92,7 +98,7 @@ const LeftMenu=(props)=>{
     return item;
   }
 
-
+  // @ts-ignore
   window.matchPath=matchPath;
 
 

package/templates/{template_oa_jwt/public/src/components/Page/PageLoading → template_oa/public/src/components/page/pageLoading}/index.jsx

@@ -1,13 +1,27 @@
-import React,{useEffect, useState} from 'react';
+// @ts-ignore
+import React from 'react';
+// @ts-ignore
 import ReactDOM from 'react-dom';
-import CSS from './index.less';
-import Popup from '@/components/Popup';
+
+import Popup from '@/components/popup';
+
+// @ts-ignore
 import imgLoading from '@/assets/images/loading.svg';
 
+// @ts-ignore
+import CSS from './index.less';
+
+/**
+ * 页面Loading状态
+ * @param {object} [props] 
+ * @param {boolean} [props.visible=true] - 是否显示状态
+ * 
+ * @returns {JSX.Element}
+ */
 const PageLoading = (props) => {
   const {visible=true} = props;
   if(!visible){
-    return '';
+    return <></>;
   }
   return (
     <div className={CSS.wrap } >
@@ -18,6 +32,13 @@ const PageLoading = (props) => {
   );
 };
 
+/**
+ * 全屏置顶显示一个页面loading组件
+ * @param {object} [props] 
+ * @param {boolean} [props.canTouch=false] - 是否允许用户点击屏幕穿透到下面的组件
+ * 
+ * @returns {(string)=>void}
+ */
 export const ShowPageLoading=(props={canTouch:false})=>{
   let popup = Popup(()=>{},{cantouch:props.canTouch});
   ReactDOM.render(

package/templates/template_oa/public/src/components/{Popup → popup}/index.jsx

@@ -1,8 +1,21 @@
+// @ts-ignore
 import React from 'react';
+// @ts-ignore
 import ReactDOM from 'react-dom';
+
+// @ts-ignore
 import styles from './index.less';
 styles;
 
+/**
+ * 一个全屏置顶的遮罩层
+ * @param {(result)=>void} reslove - 遮罩层的关闭回调
+ * @param {Object} [options] - 参数
+ * @param {boolean} [options.cantouch=false] - 是否允许被点击穿透
+ * @param {boolean} [options.transparent=false] - 是否遮罩层完全透明
+ * 
+ * @returns { {dom:HTMLElement,destory:()=>void} }
+ */
 const Popup = (reslove,options) => {
   let rootDom = document.createElement('div');
   rootDom.className='popup-box';

package/templates/template_oa/public/src/components/{Select/DepSelect → select/depSelect}/index.jsx

@@ -1,8 +1,23 @@
+// @ts-ignore
 import React, { useState, useEffect } from 'react';
+// @ts-ignore
 import { Select } from 'antd';
 
+/**
+ * @typedef DepItem
+ * @property {string} ORG_ID - 部门ID
+ * @property {string} ORG_NAME - 部门名称
+ * 
+ */
+
 /**
  * 所属部门选择器
+ * @param {Object} props
+ * @param {string|string[]} [props.value] - 当前选中的部门数据
+ * @param {DepItem[]} props.list - 所有部门数据
+ * @param {(options:string|string[],selected:any|any[])=>void} props.onChange - 选中数据发生变更的回调
+ * 
+ * @returns { JSX.Element }
  */
 function DepSelect(props) {
   const [value, setValue] = useState(props?.value || '');

package/templates/template_oa/public/src/components/{Select/StaffSelect → select/staffSelect}/index.jsx

@@ -1,7 +1,34 @@
+// @ts-ignore
 import React, { useState, useEffect } from 'react';
+// @ts-ignore
 import { Select } from 'antd';
+// @ts-ignore
 import CSS from './index.less';
 CSS;
+
+/**
+ * @typedef StaffItem
+ * @property {string} USR_UID - 用户ID
+ * @property {string} USR_JOB_ID - 工号
+ * @property {string} REAL_NAME - 真实姓名
+ * @property {string} USR_CN - 姓名(带重名数字)
+ * 
+ * 
+ */
+
+/**
+ * 员工选择器
+ * @param {Object} props
+ * @param {StaffItem[]} props.userList - 所有员工数据
+ * @param {string|string[]} props.value - 当前选中的员工UID
+ * @param {string} [props.mode=false] - 单选/多选模式,multiple=多选
+ * @param {string} [props.valIsLabel=false] - value值的格式，true=姓名(工号),false=用户UID
+ * @param {string|string[]} [props.defaultValue] - 初始选中的员工UID
+ * @param {string|string[]} [props.ifnofound] - 当初始选中的员工数据中无法匹配到员工时，对应显示的文案
+ * @param {(options:string|string[],selected:any|any[])=>void} [props.onChange] - 选中数据发生变更的回调
+ * 
+ * @returns { JSX.Element }
+ */
 const StaffSelect = (props) => {
   const [userList, setUserList] = useState(props.userList || null);
   const [value, setValue] = useState(props?.defaultValue || []);

package/templates/template_oa/public/src/components/title/index.jsx

@@ -1,4 +1,7 @@
+// @ts-ignore
 import React from 'react';
+
+// @ts-ignore
 import CSS from './index.less';
 
 const PageTitle = (props) => {

package/templates/template_oa/public/src/components/{Toast → toast}/index.jsx

@@ -1,7 +1,14 @@
+// @ts-ignore
 import React,{useEffect} from 'react';
+// @ts-ignore
 import ReactDOM from 'react-dom';
+
+// @ts-ignore
+import Popup from '@/components/popup';
+
+// @ts-ignore
 import styles from './index.less';
-import Popup from '@/components/Popup/index.jsx';
+
 
 const toastList=[];
 const runNext=()=>{
@@ -43,12 +50,25 @@ const Toast=props=>{
   )
 }
 
+/**
+ * @typedef {object} ToastOptions
+ * @property {string} message - 吐司文案内容
+ * @property {number} [delay=2000] - 持续时间,毫秒
+ * @property {string} [position] - 显示位置,center|top|bottom
+ * @property {Function} [resolve] - 显示完毕的回调
+ */
 
+/**
+ * 显示一个吐司信息
+ * @param {ToastOptions|string} [props] - 文案内容或一个配置参数
+ * @returns { Promise }
+ */
 const ShowToast=props=>{
   if(typeof props === 'string'){
     props = {message:props}
   }
   return new Promise((resolve) => {
+    // @ts-ignore
     props.resolve = resolve;
     toastList.push(props);
     if(toastList.length===1){

package/templates/template_oa/public/src/components/{Upload → upload}/index.jsx

@@ -1,10 +1,14 @@
+// @ts-ignore
 import React, { useState,useEffect } from 'react';
+// @ts-ignore
 import { Upload, message,Button } from 'antd';
+// @ts-ignore
+import { UploadOutlined } from '@ant-design/icons';
+
 import { UPLOAD_FILE,GET_DOWNLOAD_FILE } from "@/services/common.js";
 // import {getUploadToken,setMediaInfo} from '@/services/common.js';
 // import COS  from 'cos-js-sdk-v5';
 
-import { UploadOutlined } from '@ant-design/icons';
 
 
 function DELAY(time){
@@ -67,12 +71,16 @@ function DELAY(time){
 // }
 
 function CHECK_FILE_TYPE(types, filename) {
+  /**
+   * @type RegExp|string
+   */
   let reg = '';
 
   if (types.constructor === Array) {
     types = types.join('|');
   }
   reg = `[.](${types})$`;
+  
   reg = new RegExp(reg, 'i');
   return reg.test(filename);
 }
@@ -87,6 +95,7 @@ const getImageInfo= async (file)=>{
       img.onload=()=>{
         resolve({width:img.width,height:img.height});
       }
+      // @ts-ignore
       img.src=reader.result;
     }
   })
@@ -98,9 +107,11 @@ const getVideoInfo= async (file)=>{
     reader.onload =()=>{
       let video = document.createElement('video');
       video.addEventListener('canplay',(e)=>{
+        // @ts-ignore
         const {videoWidth,videoHeight} = e.target;
         resolve({width:videoWidth,height:videoHeight});
       })
+      // @ts-ignore
       video.setAttribute('src',reader.result);
       // document.body.appendChild(img);
     }
@@ -184,8 +195,35 @@ export const uploadFile=async (props,detail)=>{
 }
 
 
+/**
+ * @typedef FileInfo
+ * @property {string} server_link - 文件唯一名
+ * @property {string} [client_name] - 文件显示名
+ * @property {string} [thumbUrl] - 预览图URL
+ * @property {any} [info] - 文件唯一ID
+ * 
+ */
+
+
 /**
  *
+ * 上传文件组件
+ * @param {Object} props
+ * @param {FileInfo|FileInfo[]} props.value - 当前值
+ * @param {FileInfo|FileInfo[]} props.defaultFile - 初始值
+ * @param {string} [props.thumbUrl] - 通用预览图
+ * @param {number} [props.maxSize] - 单个文件最大值，单位KB
+ * @param {(files:FileInfo[])=>void} [props.onChange] - 文件发生变化的回调
+ * @param {string} [props.listType] - 上传内容的类型,text=常规文件，上传图片
+ * @param {boolean} [props.multiple] - 是否支持多选
+ * @param {boolean} [props.disabled] - 是否禁用状态
+ * @param {string[]} [props.acceptTypes] - 允许上传的文件类型，如:['png','jpg']
+ * @param {()=>void} [props.onPreview] - 点击图片查看的回调 
+ * @param {boolean} [props.showUploadList] - 同antd upload组件内的showUploadList https://4x.ant.design/components/upload-cn/#API
+ * @param {string} [props.className] - 扩展类样式
+ * 
+ * 
+ * @returns {JSX.Element}
  * {
  *  uid:'',//唯一id，负数为默认文件
  *  url:'',//下载链接
@@ -206,14 +244,14 @@ const UploadHelper = (props) => {
     let defaultFile=[];
     let ret=[];
     if(props.value){
-      if(props.value.map){
+      if( Array.isArray(props.value) ){
         defaultFile=[...props.value];
       }else{
         defaultFile.push(props.value);
       }
     }
     else if(props.defaultFile){
-      if(props.defaultFile.map){
+      if( Array.isArray(props.defaultFile) ){
         defaultFile=[...props.defaultFile];
       }else{
         defaultFile.push(props.defaultFile);

package/templates/template_oa/public/src/hooks/index.jsx

@@ -6,6 +6,7 @@ import usePreload from './usePreload';
 import useSearch from './useSearch';
 import useUpdate from './useUpdate';
 import useLoading from './useLoading';
+// @ts-ignore
 import {usePagination,usePaginationWithForm} from 'kn-hooks';
 
 export {

package/templates/template_oa/public/src/hooks/useDelay.jsx

@@ -1,18 +1,23 @@
+// @ts-ignore
 import { useRef,useState,useMemo, useEffect } from 'react';
 
 const useDelay=()=>{
   const [loading,setLoading] = useState(false);
   const refSet = useRef();
+  // @ts-ignore
   refSet.current = setLoading;
   useEffect(()=>{
+    // @ts-ignore
     refSet.current = setLoading;
   },[setLoading]);
 
   const actions=useMemo(()=>{
     const wait=(ms)=>{
+      // @ts-ignore
       refSet.current(true);
       return new Promise(res=>{
         setTimeout(()=>{
+          // @ts-ignore
           refSet.current(false);
           res();
         }, ms);

package/templates/template_oa/public/src/hooks/useImageLoader.jsx

@@ -1,7 +1,6 @@
+// @ts-ignore
 import React, { useEffect,useState,useMemo } from 'react';
 
-
-
 const useImageLoader=(img_src)=>{
   const [src,setSrc] = useState('');
   useEffect(() => {

package/templates/template_oa/public/src/hooks/useLoading.jsx

@@ -1,5 +1,7 @@
+// @ts-ignore
 import { useRef,useState, useEffect } from 'react';
-import {ShowPageLoading} from '@/components/Page/PageLoading';
+
+import {ShowPageLoading} from '@/components/page/pageLoading';
 
 const useLoading=(props={})=>{
   const {canTouch=false} = props;
@@ -20,10 +22,12 @@ const useLoading=(props={})=>{
   useEffect(()=>{
     if(count > 0 ){
       if(!refPageLoading.current){
+        // @ts-ignore
         refPageLoading.current = ShowPageLoading({canTouch:canTouch});
       }
     }else{
       if(refPageLoading.current){
+        // @ts-ignore
         refPageLoading.current();//销毁
         refPageLoading.current=null;
       }

package/templates/template_oa/public/src/hooks/usePreload.jsx

@@ -1,4 +1,5 @@
-import React, { useEffect,useState,useMemo,useRef,useCallback } from 'react';
+// @ts-ignore
+import React, { useState,useMemo,useCallback } from 'react';
 
 const usePreload=(files)=>{
   const [list] = useState(files);

package/templates/template_oa/public/src/hooks/useScrollTop.jsx

@@ -1,8 +1,19 @@
+// @ts-ignore
 import { useState, useMemo, useEffect } from 'react'
+// @ts-ignore
 import { createContainer } from 'unstated-next'
 
+/**
+ * @typedef {[HTMLElement,Function]} UseStateElement
+ */
+
+
 const useActivity = () => {
   const [scrollTop, setScrollTop] = useState(0);
+
+  /**
+   * @type UseStateElement
+   */
   const [containerNode, setContainerNode] = useState();
   const [clientHeight, setClientHeight] = useState(0);
   const [titleRefs, setTitleRefs] = useState({});
@@ -12,6 +23,7 @@ const useActivity = () => {
     setContainerNode(node);
     setClientHeight(node.clientHeight)
     node.addEventListener('scroll', (e) => {
+      // @ts-ignore
       setScrollTop(e.target.scrollTop);
     })
   }, [])