kn-cli 1.0.89 → 1.0.91

package/templates/template_oa/cli.config.js

@@ -1,6 +1,6 @@
 
 module.exports = {
-  name:'template-oa',
+  name:'projectName',
   registryType:'npm',//npm镜像源,taobao|npm
   less:{
     javascriptEnabled:true,//是否开启less js

package/templates/template_oa/package.json

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

package/templates/template_oa_jwt/cli.config.js

@@ -1,6 +1,6 @@
 
 module.exports = {
-  name:'template-oa-jwt',
+  name:'projectName',
   registryType:'npm',//npm镜像源,taobao|npm
   less:{
     javascriptEnabled:true,//是否开启less js

package/templates/template_oa_jwt/package.json

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

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_offcial/public/src/components/{IconFont → 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>

package/templates/template_offcial/public/src/components/link/index.jsx

@@ -0,0 +1,39 @@
+// @ts-ignore
+import React  from 'react';
+
+import { openLink } 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;
+
+  const onLink=()=>{
+    if(href){
+      if(target=='_blank'){
+        openLink(href);
+        // window.open(href);
+      }else{
+        location.href=href;
+      }
+      return;
+    }
+    if(onClick)onClick();
+  }
+  return (
+    <span onClick={onLink} className={`${styles.linkWrap} ${className}`}>{children}</span>
+  )
+}
+export default React.memo(Link);

package/templates/template_offcial/public/src/components/{Page/PageLoading → 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_offcial/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_admin/public/src/components/Toast → template_offcial/public/src/components/toast}/index.jsx

@@ -1,7 +1,13 @@
+// @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 +49,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_offcial/public/src/hooks/index.jsx

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

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

@@ -1,3 +1,4 @@
+// @ts-ignore
 import React, { useEffect,useState,useMemo } from 'react';
 
 

package/templates/template_offcial/public/src/hooks/useInToView.jsx

@@ -1,3 +1,4 @@
+// @ts-ignore
 import React, { useEffect,useState,useMemo,useRef,useCallback } from 'react';
 
 
@@ -9,6 +10,7 @@ const useInToView=(props)=>{
 
   const destory=()=>{
     if(refObserver.current){
+      // @ts-ignore
       refObserver.current=disconnect();
       refObserver.current=null;
     }
@@ -34,6 +36,7 @@ const useInToView=(props)=>{
       setVisibled(true);
     });
     observe.observe(refDom.current);
+    // @ts-ignore
     refObserver.current=observe;
   }
   const setDom=(dom)=>{

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

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

package/templates/template_offcial/public/src/hooks/useScroll.jsx

@@ -1,3 +1,4 @@
+// @ts-ignore
 import React, { useEffect, useState, useRef } from 'react';
 
 
@@ -12,7 +13,9 @@ const useScroll=(targetDom='#appLayout')=>{
   const refScrollDom = useRef();
   const refSetIsScroll = useRef();
   const refIsScroll = useRef();
+  // @ts-ignore
   refIsScroll.current= isScroll;
+  // @ts-ignore
   refSetIsScroll.current= setIsScroll;
 
   useEffect(()=>{
@@ -22,15 +25,18 @@ const useScroll=(targetDom='#appLayout')=>{
       refScrollDom.current = targetDom;
     }
     let dom = refScrollDom.current;
+    // @ts-ignore
     setHeight(dom.clientHeight)
 
     const fn=(e)=>{
       if(e.target.scrollTop>0){
         if(!refIsScroll.current){
+          // @ts-ignore
           refSetIsScroll.current(true);
         }
       }else{
         if(refIsScroll.current){
+          // @ts-ignore
           refSetIsScroll.current(false);
         }
       }
@@ -38,8 +44,10 @@ const useScroll=(targetDom='#appLayout')=>{
         fn(e.target.scrollTop);
       })
     }
+    // @ts-ignore
     dom.addEventListener('scroll',fn);
     return ()=>{
+      // @ts-ignore
       dom.removeEventListener('scroll',fn);
     }
   },[]);

package/templates/template_offcial/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,43 @@ 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_offcial/public/src/pages/index.jsx

@@ -1,10 +1,17 @@
+// @ts-ignore
 import React, { useState, useEffect } from 'react';
-import { isMobile } from '@/utils';
+// @ts-ignore
 import { useNavigate } from 'react-router-dom';
 
+import { isMobile } from '@/utils';
+
 
 
 
+/**
+ * 
+ * @returns {JSX.Element}
+ */
 const Home = () => {
   console.log('🌹🌹🌹 Home 🌹🌹🌹')
   const navigate = useNavigate();

package/templates/template_offcial/public/src/pages/pc/index.jsx

@@ -1,8 +1,10 @@
 
 import React, { useState, useEffect } from 'react';
-import Header from '@/components/Header';
+import Header from '@/components/header';
+
+// @ts-ignore
 import styles from './index.less';
-import Footer from '@/components/Footer';
+import Footer from '@/components/footer';
 import useInToView from '@/hooks/useInToView';
 
 const PcHome=()=>{

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

@@ -1,7 +1,28 @@
-import {  useState,useMemo, useEffect } from 'react';
-import {  useSearchParams,useNavigate } from 'react-router-dom';
+// @ts-ignore
+import {  useState,useMemo } from 'react';
+// @ts-ignore
+import { useNavigate } from 'react-router-dom';
+// @ts-ignore
 import { createContainer } from "unstated-next"
 
+
+
+/**
+ * @typedef AppContaniner
+ * @property {boolean} loading - 当前是否是加载状态
+ * @property {(open:boolean)=>void} setLoading - 设置加载状态
+ * @property {object} nav - 导航栏配置
+ * @property {(option:object)=>void} setNav - 设置导航栏配置
+ * 
+ */
+
+/**
+ * @typedef {object} AppProvider
+ * @property {function():AppContaniner} useContainer
+ * @property {React.ComponentType<any>} Provider
+ */ 
+
+
 const useApp=() =>{
   const navigate= useNavigate();
   const [loading,setLoading] = useState(true);
@@ -21,6 +42,11 @@ const useApp=() =>{
   return action
 }
 
+
+
+/**
+ * @type {AppProvider}
+ */
 const App = createContainer(useApp);
 
 export default App;

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

@@ -1,8 +1,10 @@
+// @ts-ignore
 import React,{Suspense} from 'react';
+// @ts-ignore
 import { Routes, Route } from 'react-router-dom';
 
-import {Layout} from '@/components/Layout';
-import PageLoading from '@/components/Page/PageLoading';
+import {Layout} from '@/components/layout';
+import PageLoading from '@/components/page/pageLoading';
 
 import Home from '@/pages/index.jsx';
 

package/templates/template_offcial/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
@@ -29,6 +36,7 @@ export const setJwt = (value) => {
   jwt = value;
 };
 
+// @ts-ignore
 window.setJwt=setJwt;
 export const setLogout=(fn)=>{
   logout=fn;
@@ -96,6 +104,13 @@ axios.interceptors.response.use(
 
 
 let buffer = {};
+/**
+ * GET请求
+ * @param {string} url - 接口地址 
+ * @param {Object} [param] - 接口参数
+ * @param {Object} [options] - 扩展参数
+ * @returns Promise<ServicesResponse>
+ */
 export async function GET_DEFAULT(url, param, options) {
   if (param) param = qs.stringify(param, { arrayFormat: 'indices' });
   let now = Date.now();
@@ -128,6 +143,12 @@ export async function GET_DEFAULT(url, param, options) {
   return response && response.data ? response.data : null;
 }
 
+/**
+ * GET请求
+ * @param {string} url - 接口地址 
+ * @param {Object} [param] - 接口参数
+ * @returns Promise<ServicesResponse>
+ */
 export async function GET_DEFAULT_CROSS(url, param) {
   if (param) param = qs.stringify(param, { arrayFormat: 'indices' });
 
@@ -141,7 +162,15 @@ 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 {Object} [options] - 特殊参数
+ * 
+ * @returns Promise<ServicesResponse>
+ */
+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 +180,7 @@ export async function POST_DEFAULT(url, params, method, options) {
   // }
 
   let response = await axios({
-    method: method || 'POST',
+    method: 'POST',
     url: url,
     data,
     ...options,
@@ -160,6 +189,13 @@ 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<ServicesResponse>
+ */
 export async function POST_DEFAULT_CROSS(url, params) {
   let data = {};
   // if (params) params = qs.stringify(params, { arrayFormat: 'indices' });