kn-cli 1.0.90 → 1.0.92

package/templates/template_oa_jwt/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_jwt/public/src/pages/demo/index.jsx

@@ -1,25 +1,31 @@
+// @ts-ignore
 import React, { useEffect, useState, useRef } from 'react';
+// @ts-ignore
 import { useParams, useSearchParams,useNavigate } from 'react-router-dom';
+// @ts-ignore
+import { Table, Input, Button, Form,Checkbox,Radio } from 'antd';
 
 import {usePaginationWithForm} from '@/hooks';
 import {GET_LIST,TEST_AUTH} from '@/services/demo';
 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_jwt/public/src/provider/app.jsx

@@ -1,9 +1,29 @@
+// @ts-ignore
 import {  useState,useMemo, useEffect } from 'react';
+// @ts-ignore
 import {  useSearchParams,useNavigate } from 'react-router-dom';
+// @ts-ignore
+import { createContainer } from "unstated-next"
+
 import {setLogout,setToLogin,setRefreshToken} from '@/services/token';
 import { setJwt } 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 {(redirectUrl:string)=>Promise} toLogin - 登录并跳转
+ * @property {(user:object)=>void} setUser - 注销病退回登录界面
+ * @property {object} user - 注销病退回登录界面
+ * 
+ */
+
+
 const useApp=() =>{
   const [search] = useSearchParams();
   const navigate= useNavigate();
@@ -61,6 +81,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_jwt/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_jwt/public/src/services/common.js

@@ -1,11 +1,14 @@
+// @ts-ignore
+import axios from 'axios';
 
 import {GET_TOKEN,GET_DEFAULT_CROSS} from '@/services';
-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 +26,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 +35,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`);
 }
 
@@ -51,6 +56,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 });
     },
   });
@@ -61,6 +67,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}`;
 }
 
@@ -81,6 +88,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: '',
@@ -88,6 +96,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 });
     },
@@ -111,6 +120,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_jwt/public/src/services/index.js

@@ -1,9 +1,15 @@
+// @ts-ignore
 import Axios from 'axios';
+// @ts-ignore
 import qs from 'qs';
+// @ts-ignore
 import { message } from 'antd';
+
 import { toHref, exportExcel } from '@/utils';
 import { CHANGE_TOKEN, setRefreshToken ,toLogin} from './token';
 const axios = Axios.create();
+
+// @ts-ignore
 console.log(`========API_HOST:${API_HOST}========`);
 
 const tokenMode='header';//header,cookie
@@ -95,10 +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();
@@ -131,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' });
 
@@ -143,6 +169,14 @@ export async function GET_DEFAULT_CROSS(url, param) {
   });
   return response && response.data ? response.data : null;
 }
+
+/**
+ * 导出EXCEL
+ * @param {string} url - 接口地址
+ * @param {any} param - 接口参数
+ * @param {any} user - 用户信息 
+ * @returns {Promise} 
+ */
 export async function EXPORT_DEFAULT_CROSS(url, param, user) {
   if (param) param = qs.stringify(param, { arrayFormat: 'indices' });
 
@@ -158,7 +192,14 @@ export async function EXPORT_DEFAULT_CROSS(url, param, user) {
   exportExcel(response, user);
 }
 
-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') {
@@ -168,7 +209,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,
@@ -180,6 +221,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();
 
@@ -246,13 +293,10 @@ export function FORMAT_RESPONSE_NO_PAGINATION(response){
   return req;
 }
 
-/**
- * 
- * @param {} error 业务接口401时，用 refreshToken 重新获取token，再重试当前接口
- * @returns 
- */
+
 const refreshAndRetry = async (error) => {
   if (!localStorage.getItem('refreshToken')) {
+    // @ts-ignore
     if(toLogin)toLogin(error.response.data.data.auth_url);
     return;
   }

package/templates/template_oa_jwt/public/src/services/token.js

@@ -1,5 +1,8 @@
+// @ts-ignore
 import Axios from 'axios';
+// @ts-ignore
 import { message } from 'antd';
+
 import { toHref } from '@/utils';
 const axios = Axios.create();
 
@@ -30,6 +33,7 @@ export const setRefreshToken = (value) => {
 
 export let logout = ()=>{}
 export const setLogout=(fn)=>{
+  // @ts-ignore
   window.logout=fn;
   logout=fn;
 }
@@ -71,11 +75,13 @@ axios.interceptors.response.use(
     }
     console.log('token error：', JSON.stringify(error));
     const url = error.response.data.data.auth_url;
+    // @ts-ignore
     if(toLogin)toLogin(url);
     return;
     // jwt失效
     if (error.response.status === 401) {
       const url = error.response.data.data.auth_url;
+      // @ts-ignore
       if(toLogin)toLogin(url);
       return;
     } else if (error.response.status === 403) {
@@ -127,6 +133,7 @@ async function POST_DEFAULT_CROSS(url, params) {
  */
 export async function CHANGE_TOKEN(params){
   let values = params ? params : {refresh_token: refreshToken};
+  // @ts-ignore
   const res = await POST_DEFAULT_CROSS(`${KSSO_HOST}/oauth/ksso/exchange`, values);
   return res;
 }

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

@@ -1,10 +1,19 @@
+// @ts-ignore
 import moment from 'moment';
 
+
+/**
+ * 打开一个第三方链接
+ * @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,50 +22,60 @@ 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;
-};
 
-export const jumpUrl = (url, options = {}) => {
-  const { replace, newWindow, reload } = options;
-  if (reload) {
+/**
+ * 跳转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=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;
   }
-  if (replace) {
+  if(replace){
     location.replace(url);
     return;
   }
-  if (newWindow) {
+  if(newWindow){
     window.open(url);
     return;
   }
-  location.href = url;
+  location.href=url;
 
 }
 
 
 // 关闭页面
 export const closeWindow = () => {
+  // @ts-ignore
   if (window.knFeishu && window.knFeishu.closeWindow) {
+    // @ts-ignore
     window.knFeishu.closeWindow();
   } else {
     if (window.close) {
@@ -66,6 +85,26 @@ export const closeWindow = () => {
 };
 
 
+
+export const toHref = (url, replace, newWindow) => {
+  // @ts-ignore
+  if (window.knFeishu) {
+    // @ts-ignore
+    window.knFeishu.ToHref(url, replace, newWindow);
+    return;
+  }
+  if (newWindow) {
+    window.open(url);
+    return;
+  }
+  if (replace) {
+    location.replace(url);
+    return;
+  }
+  location.href = url;
+};
+
+
 export function formatMoney(s, n = 2) {
   if (typeof s === 'undefined' || s === '') {
     return '-'
@@ -99,6 +138,7 @@ export const isEditAuth = (user) => {
 }
 
 export const exportExcel = (response, user) => {
+  // @ts-ignore
   const blob = new Blob([response.data], { type: `${type},charset=UTF-8` });
   const disposition = response.headers.get('content-disposition');
   const fileName = `管理系统-${user.usr_username}-${moment().format('YYYY-MM-DD')}.xlsx`;

package/templates/template_offcial/cli.config.js

@@ -1,6 +1,6 @@
 
 module.exports = {
-  name:'template-offical',
+  name:'projectName',
   version:'1.0',
   registryType:'npm',//npm镜像源,taobao|npm
   less:{

package/templates/template_offcial/jsconfig.json

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

package/templates/template_offcial/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "template-offical",
+  "name": "projectName",
   "version": "1.0.0",
   "main": "lib/index",
   "scripts": {

package/templates/template_offcial/public/src/components/{Footer → footer}/index.jsx

@@ -1,8 +1,20 @@
+// @ts-ignore
 import React, { useEffect, useState } from 'react';
-import styles from './index.less';
+
 import { isMobile } from '@/utils';
 
+// @ts-ignore
+import styles from './index.less';
+
 
+/**
+ * 页脚
+ * @param {object} props 
+ * @param {string} [props.name='footer'] - 页脚名称
+ * @param {string} [props.defaultHeight='100%'] - 默认footer高度
+ * 
+ * @returns {JSX.Element}
+ */
 const Footer = (props) => {
   const {name='footer',defaultHeight='100%'}=props;
   const [url, setUrl] = useState('');
@@ -17,9 +29,11 @@ const Footer = (props) => {
     })
 
     if(isMobile()){
+      // @ts-ignore
       setUrl(`${MICRO_FRONT}/offcial-footer/mobileFooter.html`);
       return;
     }
+    // @ts-ignore
     setUrl(`${MICRO_FRONT}/offcial-footer/pcFooter.html`)
   }, [])
   return (

package/templates/template_offcial/public/src/components/{Header → header}/index.jsx

@@ -1,7 +1,15 @@
+// @ts-ignore
 import React, { useEffect, useRef, useState } from 'react';
+
 import useScroll from '@/hooks/useScroll';
+
+// @ts-ignore
 import styles from './index.less';
 
+/**
+ * 头部导航栏
+ * @returns {JSX.Element}
+ */
 const Header = () => {
   const scroll = useScroll();
   const menu = [
@@ -14,7 +22,9 @@ const Header = () => {
   const refSetActiveMenu = useRef();
   const refScroll = useRef();
 
+  // @ts-ignore
   refScroll.current=scroll;
+  // @ts-ignore
   refSetActiveMenu.current=setActiveMenu;
   
   const onClick = (type) => {
@@ -30,18 +40,22 @@ const Header = () => {
 
     scroll.addEventListener('scroll',(top)=>{
       if(top==0){
+        // @ts-ignore
         refSetActiveMenu.current(menu[0].type);
         return;
       }
       for(let i=menusDom.length-1;i>0;i--){
         if( menusDom[i] ){
           let currentTop= menusDom[i].offsetTop;
+          // @ts-ignore
           if(top+refScroll.current.height*0.6 >= currentTop){
+            // @ts-ignore
             refSetActiveMenu.current(menu[i].type);
             return;
           }
         }
       }
+      // @ts-ignore
       refSetActiveMenu.current(menu[0].type);
 
     })

package/templates/{template_app/public/src/components/IconFont → template_offcial/public/src/components/iconFont}/index.jsx

@@ -1,6 +1,16 @@
+// @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] - 扩展类名
+ * 
+ * @returns {JSX.Element}
+ */
 const IconFont=(props)=>{
   const {icon,className,...others} = props;
   return (

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

@@ -1,10 +1,17 @@
-import React, { useEffect } from 'react';
-import ProviderApp from '@/provider/app';
+// @ts-ignore
+import React from 'react';
+// @ts-ignore
 import {Outlet} from 'react-router-dom';
 
+import ProviderApp from '@/provider/app';
+
+// @ts-ignore
 import styles from './index.less';
 
-// 站点最基础的layout，用于控制一些全局环境变量
+/**
+ * 注入AppProvider
+ * @returns {JSX.Element}
+ */
 const Layout = (props) => {    
   return (
     <ProviderApp.Provider>

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

@@ -1,7 +1,14 @@
+// @ts-ignore
 import React from 'react';
+// @ts-ignore
 import {Outlet} from 'react-router-dom';
+
 import ProviderApp from '@/provider/app';
 
+/**
+ * 注入AppProvider
+ * @returns {JSX.Element}
+ */
 const LayoutProvider=(props)=>{
   return ( 
     <ProviderApp.Provider>