kn-cli 1.0.91 → 1.0.92

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_jwt/public/src/components/Select/DepSelect → template_oa/public/src/components/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);
     })
   }, [])

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

@@ -1,7 +1,32 @@
-import { useRef,useState,useMemo, useEffect } from 'react';
+// @ts-ignore
+import React,{ useState } from 'react';
+
+
+/**
+ * @typedef {object} UseSearch
+ * @property {(pageInfo:Pagination,sorterInfo:any)=>Promise} onPaginationChange - 监听分页信息发生变更
+ * @property {Pagination} pagination - 当前分页信息
+ * @property {object} search - 当前分页查询参数
+ * @property {()=>Promise} btnSearch - 出发查询
+ * @property {(object)=>void} setSearch - 设置查询参数
+ * @property {(object)=>Promise<ServicesResponse>} refresh - 设置查询参数
+ * @property {()=>void} btnReset - 重置查询参数
+ * @property {(sorter:object)=>void} onSorter - 监听排序变更
+ * 
+ */
+
 
 /**
  * 管理表格数据的查询搜索及分页
+ * @param {object} props 
+ * @param {object} [props.initSearch={}] - 初始的分页搜索参数
+ * @param {(params)=>Promise} [props.service] - 分页接口提交方法
+ * @param {(params:any)=>object} [props.beforeSearch] - 参数拦截器
+ * @param {(params:any)=>object} [props.beforeService] - 提交接口前的参数拦截器
+ * @param {(response:any)=>void} [props.updateData] - 接口返回后的回调
+ * @param {Pagination} [props.pagination] - 接口返回后的回调
+ * 
+ * @returns {UseSearch}
  */
 const useSearch=(props)=>{
   const [search,setSearch] = useState(props.initSearch||{});
@@ -80,10 +105,11 @@ const useSearch=(props)=>{
     }
   }
   const btnReset=()=>{
+    // @ts-ignore
     formRef.resetFields();
   }
 
-  const refresh= async ({searchValue,pageValue,orderValue}={})=>{
+  const refresh= async ({searchValue=null,pageValue=null,orderValue=null}={})=>{
     searchValue = searchValue || search;
     pageValue = pageValue || pagination;
 

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

@@ -1,5 +1,10 @@
+// @ts-ignore
 import { useState, useMemo } from 'react';
 
+
+/**
+ * 更新计数器
+ */
 const useUpdate=()=>{
   const [count,setCount] = useState(1);
   const action = useMemo(()=>{

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

@@ -1,5 +1,8 @@
+// @ts-ignore
 import React from 'react';
+// @ts-ignore
 import ReactDOM from 'react-dom';
+// @ts-ignore
 import {HashRouter} from 'react-router-dom';
 // import {createRoot} from 'react-dom/client';
 // import { createHashRouter,RouterProvider } from 'react-router-dom';
@@ -7,33 +10,44 @@ import './_antd.less';
 import './_reset.less';
 import {RouteList} from './route';
 
-
+// @ts-ignore
 if(MOCK){
   let mock = require('@/mock');
   mock;
 }
 
+// @ts-ignore
 window.appLog=(txt)=>{
   console.log(txt);
 }
 
 /* eslint-disable */
+// @ts-ignore
 if(BUILD_ENV!='prod'){
+  // @ts-ignore
   let VConsole =  require('vconsole');
+  // @ts-ignore
   const vConsole = new VConsole();
   setTimeout(() => {
     vConsole.setSwitchPosition(70, 10);
   }, 2000);
 }
 
+// @ts-ignore
 if(BUILD_ENV){
+  // @ts-ignore
   window.appLog(`代码环境类型：${BUILD_ENV}`);
 }
+// @ts-ignore
 if (VERSION_HASH) {
+  // @ts-ignore
   window.appLog(`VERSION_HASH：${VERSION_HASH}`);
 }
+// @ts-ignore
 window.appLog(`log init`);
+// @ts-ignore
 window.appLog(`${location.href}`);
+// @ts-ignore
 window.appLog(`ua:${navigator.userAgent}`);
 /* eslint-enable */
 

package/templates/template_oa/public/src/pages/video/index.jsx

@@ -1,25 +1,29 @@
+// @ts-ignore
 import React, { useEffect, useState, useRef } from 'react';
-import { useParams, useSearchParams,useNavigate } from 'react-router-dom';
+// @ts-ignore
+import { useNavigate } from 'react-router-dom';
+// @ts-ignore
+import { Table, Input, Button, Form,Checkbox,Radio } from 'antd';
 
 import {usePaginationWithForm} from '@/hooks';
 import {GET_LIST} from '@/services/video';
 import {GET_STAFF_LIST,GET_DEP_LIST} from '@/services/common';
-
-import { Table, Input, Button, Form,Checkbox,Radio } from 'antd';
-import {FormBlockByTitle} from '@/components/Layout/FormBlock';
-import styles from './index.less';
+import {FormBlockByTitle} from '@/components/layout/formBlock';
 import PageTitle from '@/pages/components/pageTitle';
 import TotalRecord from '@/pages/components/totalRecord';
-import {ShowErrorAlert,ShowAlert,ShowConfirm} from '@/components/Dialog';
-import ShowToast from '@/components/Toast';
-import Empty from '@/components/Empty';
-import FormRow from '@/components/FormRow';
-import FormTable from '@/components/FormTable';
-import UploadHelper from '@/components/Upload';
-import StaffSelect from '@/components/Select/StaffSelect';
-import DepSelect from  '@/components/Select/DepSelect';
+import {ShowErrorAlert,ShowAlert,ShowConfirm} from '@/components/dialog';
+import ShowToast from '@/components/toast';
+import Empty from '@/components/empty';
+import FormRow from '@/components/formRow';
+import FormTable from '@/components/formTable';
+import UploadHelper from '@/components/upload';
+import StaffSelect from '@/components/select/staffSelect';
+import DepSelect from  '@/components/select/depSelect';
 import ProviderApp from '@/provider/app';
 
+// @ts-ignore
+import styles from './index.less';
+
 const Page = () => {
   const providerApp = ProviderApp.useContainer();
   const navigate= useNavigate();

package/templates/template_oa/public/src/provider/app.jsx

@@ -1,8 +1,27 @@
-import {  useState,useMemo, useEffect } from 'react';
+// @ts-ignore
+import {  useState,useMemo } from 'react';
+// @ts-ignore
 import {  useSearchParams,useNavigate } from 'react-router-dom';
+// @ts-ignore
+import { createContainer } from "unstated-next"
+
 import {setLogout} from '@/services';
 
-import { createContainer } from "unstated-next"
+
+
+/**
+ * @typedef AppContaniner
+ * @property {boolean} loading - 当前是否是加载状态
+ * @property {(open:boolean)=>void} setLoading - 设置加载状态
+ * @property {object} nav - 导航栏配置
+ * @property {(option:object)=>void} setNav - 设置导航栏配置
+ * @property {()=>Promise} logout - 注销病退回登录界面
+ * @property {(user:object)=>void} setUser - 注销病退回登录界面
+ * @property {object} user - 注销病退回登录界面
+ * 
+ */
+
+
 
 const useApp=() =>{
   const [search] = useSearchParams();
@@ -17,11 +36,14 @@ const useApp=() =>{
   }
 
   const logout=async ()=>{
+    // @ts-ignore
     if(BUILD_ENV=='localdebug'){
       navigate('/login');
     }else{
       let url = window.btoa(location.href);
+      // @ts-ignore
       let redirect=`${OA_HOST}/login?url=${url}`;
+      // @ts-ignore
       if(BUILD_ENV!='prod'){
         redirect+='&debug=1';
       }
@@ -47,6 +69,15 @@ const useApp=() =>{
   return action
 }
 
+/**
+ * @typedef {object} AppProvider
+ * @property {function():AppContaniner} useContainer
+ * @property {React.ComponentType<any>} Provider
+ */ 
+
+/**
+ * @type {AppProvider}
+ */
 const App = createContainer(useApp);
 
 export default App;

package/templates/template_oa/public/src/route.jsx

@@ -1,8 +1,10 @@
+// @ts-ignore
 import React,{Suspense} from 'react';
+// @ts-ignore
 import { Routes, Route, Navigate } from 'react-router-dom';
 
-import { LayoutBasic, Layout } from '@/components/Layout';
-import PageLoading from '@/components/Page/PageLoading';
+import { LayoutBasic, Layout } from '@/components/layout';
+import PageLoading from '@/components/page/pageLoading';
 
 import Login from '@/pages/login';
 // import {AuthLogin} from '@/components/Auth';

package/templates/template_oa/public/src/services/common.js

@@ -1,11 +1,13 @@
 
 import {GET_TOKEN,GET_DEFAULT_CROSS} from '@/services';
+// @ts-ignore
 import axios from 'axios';
 
 /**
  * 获取员工列表
  */
 export async function GET_STAFF_LIST() {
+  // @ts-ignore
   let ret = await GET_DEFAULT_CROSS(`${OA_HOST}/common/getNewUserList`);
   return ret;
   // let response = await axios({
@@ -23,6 +25,7 @@ export async function GET_STAFF_LIST() {
  * 所有部门信息
  */
 export async function GET_DEP_LIST() {
+  // @ts-ignore
   return GET_DEFAULT_CROSS(`${OA_HOST}/common/getBenefitDept`);
 }
 
@@ -31,6 +34,7 @@ export async function GET_DEP_LIST() {
  * @returns 
  */
 export function GET_COMPANY_LIST(){
+  // @ts-ignore
   return GET_DEFAULT_CROSS(`${OA_HOST}/filestore/list?status=1`);
 }
 
@@ -50,6 +54,7 @@ export async function POST_IMPORT_EXCEL(url, file, onProgress) {
     url: url,
     data: formdata,
     onUploadProgress: (e) => {
+      // @ts-ignore
       onProgress({ percent: `${e.loaded}/${e.total}` * 100 });
     },
   });
@@ -60,6 +65,7 @@ export async function POST_IMPORT_EXCEL(url, file, onProgress) {
  * 获取下载文件的url路径
  */
 export function GET_DOWNLOAD_FILE(s_name) {
+  // @ts-ignore
   return `${OA_HOST}/file/download?name=${s_name}`;
 }
 
@@ -80,6 +86,7 @@ export async function UPLOAD_FILE(file, param, onProgress) {
 
   let response = await axios({
     method: 'post',
+    // @ts-ignore
     url: `${OA_HOST}/file/upload`,
     data: formdata,
     xsrfCookieName: '',
@@ -87,6 +94,7 @@ export async function UPLOAD_FILE(file, param, onProgress) {
     withCredentials: true,
 
     onUploadProgress: (e) => {
+      // @ts-ignore
       let per = parseFloat((e.loaded / e.total) * 100).toFixed(0);
       onProgress({ percent: per });
     },
@@ -110,6 +118,9 @@ export async function UPLOAD_FILE(file, param, onProgress) {
  * types:array|string,['png','gif']|'png' 类型
  */
 export function CHECK_FILE_TYPE(types, filename) {
+  /**
+   * @type RegExp|string
+   */
   let reg = '';
 
   if (types.constructor === Array) {