kn-cli 1.0.91 → 1.0.93

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) {

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

@@ -1,9 +1,16 @@
+// @ts-ignore
 import Axios from 'axios';
+// @ts-ignore
 import qs from 'qs';
+// @ts-ignore
 import { message } from 'antd';
+
+
 const axios = Axios.create();
+// @ts-ignore
 console.log(`========API_ROOT:${API_HOST}========`);
 
+// @ts-ignore
 export const API_ROOT = API_HOST;
 const tokenMode='header';//header,cookie
 const tokenName='Authorization';
@@ -29,6 +36,7 @@ export const setJwt = (value) => {
   jwt = value;
 };
 
+// @ts-ignore
 window.setJwt=setJwt;
 export const setLogout=(fn)=>{
   logout=fn;
@@ -93,9 +101,23 @@ axios.interceptors.response.use(
 );
 
 
+/**
+ * @typedef RequestOptions 发送请求的扩展信息
+ * @property {number|boolean} ttl=false - 接口缓存周期，开启后默认为2秒，ttl单位为毫秒
+ * @property {string|boolean} noInterceptors=false - 关闭拦截类型，'all'为关闭包括401、403在内的所有异常，默认情况下只拦截response.code不为0的情况
+ * 
+ */
 
 
 let buffer = {};
+/**
+ * @function
+ * @description 发送一个GET请求
+ * @param {string} url - 请求地址 
+ * @param {Object} [param] - 请求的参数
+ * @param {RequestOptions} [options] - 扩展参数
+ * @returns {Promise<Object>}
+ */
 export async function GET_DEFAULT(url, param, options) {
   if (param) param = qs.stringify(param, { arrayFormat: 'indices' });
   let now = Date.now();
@@ -128,6 +150,13 @@ export async function GET_DEFAULT(url, param, options) {
   return response && response.data ? response.data : null;
 }
 
+/**
+ * @function
+ * @description 发送一个GET请求
+ * @param {string} url - 请求地址 
+ * @param {Object} [param] - 请求的参数
+ * @returns {Promise<Object>}
+ */
 export async function GET_DEFAULT_CROSS(url, param) {
   if (param) param = qs.stringify(param, { arrayFormat: 'indices' });
 
@@ -141,7 +170,14 @@ export async function GET_DEFAULT_CROSS(url, param) {
   return response && response.data ? response.data : null;
 }
 
-export async function POST_DEFAULT(url, params, method, options) {
+/**
+ * 发送一个POST请求
+ * @param {string} url - 请求地址 
+ * @param {Object} [params] - 请求的参数
+ * @param {RequestOptions} [options] - 扩展参数
+ * @returns {Promise<Object>}
+ */
+export async function POST_DEFAULT(url, params, options) {
   let data = params;
   // if (params) params = qs.stringify(params, { arrayFormat: 'indices' });
   // if (typeof params === 'string') {
@@ -151,7 +187,7 @@ export async function POST_DEFAULT(url, params, method, options) {
   // }
   let token= await GET_TOKEN();
   let response = await axios({
-    method: method || 'POST',
+    method: 'POST',
     url: url,
     data:{
       _token:token,
@@ -163,6 +199,12 @@ export async function POST_DEFAULT(url, params, method, options) {
   return response && response.data ? response.data : null;
 }
 
+/**
+ * 发送一个POST请求
+ * @param {string} url - 请求地址 
+ * @param {Object} [params] - 请求的参数
+ * @returns {Promise<Object>}
+ */
 export async function POST_DEFAULT_CROSS(url, params) {
   let token= await GET_TOKEN();
 

package/templates/template_oa/public/src/type.js

@@ -0,0 +1,48 @@
+
+/**
+ * 可自行扩展任意数量的属性
+ * @typedef {Object<string, any>} OtherAny
+ */
+
+/**
+ * 指向DOM节点的ref
+ * @typedef {object} RefDomElement
+ * @property {HTMLElement} current - DOM节点
+ */
+
+
+
+/**
+ * @typedef {object} FormDataInfo
+ * @property {string} btnControl
+ */
+
+/**
+ * @typedef {[FormDataInfo,Function]} UseStateFormData
+ */
+
+
+/**
+ * @typedef {FormDataInfo & OtherAny} TableContentData
+ */
+
+
+/**
+ * 分页
+ * @typedef {object} Pagination
+ * @property {number} current - 当前页码,1~N
+ * @property {number} pageSize=10 - 分页大小
+ * @property {number} total - 总记录条数
+ * @property {number} startIdx - 当前页面第一条的数据索引起始值
+ * 
+ */
+
+
+/**
+ * 接口response数据
+ * @typedef {object} ServicesResponse
+ * @property {number} code - 接口处理结果,0为成功
+ * @property {object} data - 接口返回的数据
+ * @property {Pagination} page - 分页数据
+ * 
+ */

package/templates/template_oa/public/src/utils/index.js

@@ -1,10 +1,17 @@
 
 
+/**
+ * 打开一个第三方链接
+ * @param {string} link - 链接地址
+ * @param {string} [target='_blank'] - 打开方式,_blank:新窗口打开 
+ */
 export const openLink = (link, target = '_blank') => {
   let domLink = document.createElement('a');
   domLink.href = link;
   domLink.setAttribute('target', target);
+  // @ts-ignore
   domLink.style.opacity = 0;
+  // @ts-ignore
   domLink.style.zIndex = -999;
   document.body.appendChild(domLink);
   domLink.click();
@@ -13,30 +20,38 @@ export const openLink = (link, target = '_blank') => {
   }, 200);
 }
 
+/**
+ * 判断当前是否为移动端
+ * @returns {boolean}
+ */
 export const isMobile = () => {
   return navigator.userAgent.match(
     /(phone|pad|pod|iPhone|iPod|ios|iPad|Android|Mobile|BlackBerry|IEMobile|MQQBrowser|JUC|Fennec|wOSBrowser|BrowserNG|WebOS|Symbian|Windows Phone)/i
-  )
+  )?true:false
 }
 
-export const toHref = (url, replace, newWindow) => {
-  if(window.knFeishu){
-    window.knFeishu.ToHref(url,replace,newWindow);
-    return;
-  }
-  if (newWindow) {
-    window.open(url);
-    return;
-  }
-  if (replace) {
-    location.replace(url);
-    return;
-  }
-  location.href = url;
-};
 
+/**
+ * 跳转URL-兼容飞书
+ * @param {string} url - 链接地址
+ * @param {object} [options] - 参数
+ * @param {boolean} [options.replace] - 是否要覆盖当前URL记录
+ * @param {boolean} [options.newWindow] - 是否新窗口中打开
+ * @param {boolean} [options.reload] - 是否重载当前页面
+ * 
+ * 
+ */
 export const jumpUrl=(url,options={})=>{
-  const {replace,newWindow,reload}= options;
+  const {replace=false,newWindow=false,reload=false}= options;
+  if(!reload){
+    // @ts-ignore
+    if(window.knFeishu){
+      // @ts-ignore
+      window.knFeishu.ToHref(url,replace,newWindow);
+      return;
+    }
+  }
+  
   if(reload){
     location.reload();
     return;
@@ -56,7 +71,9 @@ export const jumpUrl=(url,options={})=>{
 
 // 关闭页面
 export const closeWindow = () => {
+  // @ts-ignore
   if (window.knFeishu && window.knFeishu.closeWindow) {
+    // @ts-ignore
     window.knFeishu.closeWindow();
   } else {
     if (window.close) {

package/templates/template_oa_jwt/.gitignore

@@ -0,0 +1,6 @@
+**/node_modules
+**/package-lock.json
+**/.DS_Store
+**/dist
+**/release
+

package/templates/template_oa_jwt/jsconfig.json

@@ -3,8 +3,12 @@
     "baseUrl": ".",
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
+    "lib": ["dom", "ES2021"],
+    "allowJs":true,
+    "checkJs": true, 
+    "jsx": "react",
     "paths": {
       "@/*": ["./public/src/*"]
-    }
+    },
   }
 }