kn-cli 1.0.90 → 1.0.91

package/templates/template_admin/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_admin/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_admin/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){
+  // @ts-ignore
   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_admin/public/src/pages/material/index.jsx

@@ -1,6 +1,7 @@
 import React, { useEffect, useState, useRef } from 'react';
-import {usePaginationWithForm} from '@/hooks';
+import {usePaginationWithForm} from '@/hooks/index';
 import {GET_LIST} from '@/services/video';
+// @ts-ignore
 import {Table,Pagination,Form,Input,Button} from 'antd';
 
 const Page = () => {

package/templates/template_admin/public/src/pages/user/index.jsx

@@ -1,6 +1,11 @@
-import React, { useEffect, useState, useRef } from 'react';
-import Link from '@/components/Link';
+// @ts-ignore
+import React from 'react';
 
+import Link from '@/components/link';
+
+/**
+ * @returns {JSX.Element}
+ */
 const Page = () => {
   return (
     <div>

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

@@ -1,12 +1,36 @@
-import {  useState,useMemo, useEffect } from 'react';
+// @ts-ignore
+import {  useState,useMemo } from 'react';
+// @ts-ignore
 import {  useSearchParams,useNavigate } from 'react-router-dom';
-
-import { createContainer } from "unstated-next"
-import {useDelay} from '@/hooks';
+// @ts-ignore
+import { createContainer } from "unstated-next";
+// @ts-ignore
+import {useDelay} from '@/hooks/index';
 import {setJwt,setLogout} from '@/services';
 import {KSSO_LOGIN,LOGIN,LOGOUT} from '@/services/auth';
 import {jumpUrl} from '@/utils';
 
+
+/**
+ * @typedef AppContaniner
+ * @property {boolean} loading - 当前是否是加载状态
+ * @property {(open:boolean)=>void} setLoading - 设置加载状态
+ * @property {()=>Promise<boolean>} isLogin - 检查是否已登录状态
+ * @property {(username:string,password:string)=>Promise<boolean>} login - 触发登录
+ * @property {object} nav - 导航栏配置
+ * @property {(option:object)=>void} setNav - 设置导航栏配置
+ * @property {()=>Promise} logout - 注销病退回登录界面
+ * @property {(user:object)=>void} setUser - 注销病退回登录界面
+ * @property {object} user - 注销病退回登录界面
+ * @property {()=>Promise<boolean>} kssoLogin - 触发ksso登录
+ * 
+ */
+
+
+/**
+ * 应用全局Provider
+ * @returns 
+ */
 const useApp=() =>{
   const [search] = useSearchParams();
   const navigate= useNavigate();
@@ -25,6 +49,7 @@ const useApp=() =>{
           userData= JSON.parse(userData);
           if(userData){
             setUser(userData);
+            // @ts-ignore
             setJwt(userData.token);
             return true;
           }
@@ -114,6 +139,16 @@ 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_admin/public/src/provider/menu.jsx

@@ -1,5 +1,8 @@
-import {  useState,useMemo } from 'react';
+// @ts-ignore
+import React,{  useState,useMemo } from 'react';
+// @ts-ignore
 import { createContainer } from "unstated-next"
+
 import {GET_MENU} from '@/services/auth';
 
 const useProvider=() =>{

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

@@ -1,13 +1,16 @@
+
+// @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';
-import LeftMenu from '@/components/Menu';
-import TopMenu from '@/components/TopMenu';
+import {AuthLogin} from '@/components/auth';
+import LeftMenu from '@/components/menu';
+import TopMenu from '@/components/topMenu';
 
 import ProviderMenu from '@/provider/menu';
 

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

@@ -1,9 +1,14 @@
+// @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';
@@ -27,7 +32,7 @@ export const setJwt = (value) => {
   localStorage.setItem('jwt', value);
   jwt = value;
 };
-
+// @ts-ignore
 window.setJwt=setJwt;
 export const setLogout=(fn)=>{
   logout=fn;
@@ -95,6 +100,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();
@@ -127,6 +139,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' });
 
@@ -140,7 +158,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') {
@@ -150,7 +176,7 @@ export async function POST_DEFAULT(url, params, method, options) {
   // }
 
   let response = await axios({
-    method: method || 'POST',
+    method: 'POST',
     url: url,
     data,
     ...options,
@@ -159,6 +185,14 @@ 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' });

package/templates/template_admin/public/src/services/user.js

@@ -1,16 +1,16 @@
-import {GET_DEFAULT,PUT_DEFAULT,POST_DEFAULT,API_ROOT} from './index.js';
+import {GET_DEFAULT,POST_DEFAULT,API_ROOT} from './index.js';
 
 
 
 export function GET_USER(){
-  return GET_DEFAULT(`${HOST}/user`);
+  return GET_DEFAULT(`${API_ROOT}/user`);
 }
 
 export function SET_USER(params={
   name:'',
   age:''
 }){
-  return POST_DEFAULT(`${HOST}/user`,params)
+  return POST_DEFAULT(`${API_ROOT}/user`,params)
 }
 
 

package/templates/template_admin/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_admin/public/src/utils/index.js

@@ -1,10 +1,16 @@
 
-
+/**
+ * 打开一个第三方链接
+ * @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 +19,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 +70,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_app/cli.config.js

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

package/templates/template_app/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_app/package.json

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

package/templates/template_app/public/src/components/{Auth → auth}/index.jsx

@@ -1,8 +1,19 @@
+// @ts-ignore
 import React, { useEffect, useState } from 'react';
-import ProviderApp from '@/provider/app';
+// @ts-ignore
 import { useNavigate } from 'react-router-dom';
+
+import ProviderApp from '@/provider/app';
 import {useLoading} from '@/hooks';
 
+/**
+ * 检查用户是否带有某个权限
+ * @param {object} props 
+ * @param {string} [props.name] - 权限的名称
+ * @param {JSX.Element} [props.children] - 子组件
+ * 
+ * @returns {JSX.Element}
+ */
 export const AuthShow=(props)=>{
   const {name} = props;
   const app = ProviderApp.useContainer();
@@ -12,6 +23,13 @@ export const AuthShow=(props)=>{
   return <></>
 }
 
+/**
+ * 用户登录态校验
+ * @param {object} props 
+ * @param {JSX.Element} [props.children] - 当登录校验合法后显示的子组件
+ * 
+ * @returns {JSX.Element}
+ */
 export const AuthLogin=(props)=>{
   const navigate = useNavigate();
   const [pass,setPass] = useState(false)
@@ -32,7 +50,7 @@ export const AuthLogin=(props)=>{
       navigate('/login');
     }
   }
-  useEffect(check,[]);
+  useEffect(()=>{check()},[]);
 
   if(pass){
     return props.children;

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

@@ -1,7 +1,31 @@
+// @ts-ignore
 import React, { useEffect } from 'react';
-import IconFont from '../IconFont';
+// @ts-ignore
+import IconFont from '../iconFont';
+
+// @ts-ignore
 import styles from './index.less';
 
+/**
+ * 头部导航栏
+ * @param {object} props 
+ * @param {string} [props.visible=true] - 是否显示
+ * @param {string} [props.className] - 扩展类样式名称
+ * @param {string} [props.title] - 标题
+ * @param {string} [props.subTitle] - 副标题
+ * @param {string} [props.leftLabel] - 左侧操作按钮文案
+ * @param {string} [props.rightLabel] - 右侧操作按钮文案
+ * @param {JSX.Element|string} [props.left] - 左侧操作按钮组件
+ * @param {JSX.Element|string} [props.right] - 左侧操作按钮组件
+ * @param {JSX.Element|string} [props.syncDocumentTitle=false] - 是否将标题同步到网页<title>标签内
+ * @param {Function} [props.onLeftLabel] - 左侧操作按钮文案点击回调
+ * @param {Function} [props.onRight] - 右侧操作按钮ICON点击回调
+ * @param {Function} [props.onRightLabel] - 右侧操作按钮文案点击回调
+ * @param {Function} [props.onTitle] - 点击导航栏标题回调
+ * 
+ * 
+ * @returns {JSX.Element}
+ */
 const Header=(props)=>{
   const {
     visible=true,

package/templates/template_app/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_app/public/src/components/{Layout/App → layout/app}/index.jsx

@@ -1,10 +1,20 @@
+// @ts-ignore
 import React from 'react';
+// @ts-ignore
 import {Outlet} from 'react-router-dom';
-import Header from '@/components/Header';
+
+import Header from '@/components/header';
 import ProviderApp from '@/provider/app';
-import styles from './index.less';
 
+// @ts-ignore
+import styles from './index.less';
 
+/**
+ * APP框架layout
+ * @param {object} [props] 
+ * 
+ * @returns {JSX.Element}
+ */
 const LayoutApp=(props)=>{
   const providerApp = ProviderApp.useContainer();
   console.log('layoutApp.nav',providerApp.nav)

package/templates/template_app/public/src/components/layout/index.jsx

@@ -0,0 +1,6 @@
+// @ts-ignore
+import React from 'react';
+
+import LayoutApp from './app';
+import LayoutProvider from './provider';
+export { LayoutApp ,LayoutProvider};

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

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