kn-cli 1.0.90 → 1.0.92

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/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/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_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_oa_jwt/public/src/components/dialog/index.jsx

@@ -0,0 +1,237 @@
+// @ts-ignore
+import React from 'react';
+// @ts-ignore
+import ReactDOM from 'react-dom';
+// @ts-ignore
+import { Button } from 'antd';
+
+import IconFont from '@/components/iconFont';
+
+import Popup from '@/components/popup';
+// @ts-ignore
+import styles from './index.less';
+
+
+/**
+ * 对话框组件
+ * @param {object} props 
+ * @param {string} props.title - 对话框的标题内容
+ * @param {string} [props.okText='确认'] - 确认按钮文案
+ * @param {string} [props.cancelText='取消'] - 取消按钮文案
+ * @param {boolean} [props.noCancel=false] - 不显示取消按钮
+ * @param {()=>Promise<boolean>} [props.onOk] - 点击确认按钮回调
+ * @param {()=>Promise<boolean>} [props.onClose] - 点击关闭的回调
+ * @param {()=>void} [props.destory] - 对话框销毁的回调
+ * @param {JSX.Element|any} [props.children] - 子组件
+ * 
+ * @returns {JSX.Element}
+ */
+const Dialog = (props) => {
+  const {
+    title='',
+    okText='确认',
+    cancelText='取消',
+    noCancel=false,
+    onOk:fnOnOk,
+    onClose:fnOnClose,
+    destory,
+    children
+  }= props;
+  async function onClose() {
+    if (fnOnClose) {
+      let ret = await fnOnClose();
+      if (ret) {
+        destory();
+      }
+    } else {
+      destory();
+    }
+  }
+  async function onOk() {
+    if (fnOnOk) {
+      let ret = await fnOnOk();
+      if (ret) {
+        destory();
+      }
+    } else {
+      destory();
+    }
+  }
+  return (
+    <section className={styles.body}>
+      <div className={styles.mask} />
+      <section className={styles.wrap}>
+        <div className={styles.header}>
+          <span>{title}</span>
+          <IconFont icon='close' className={styles.close} onClick={onClose} />
+        </div>
+
+        {children}
+
+        <div className={styles.footer}>
+          <Button type='primary' onClick={onOk}>
+            {okText}
+          </Button>
+          {noCancel ? (
+            ''
+          ) : (
+            <Button onClick={onClose} style={{ marginLeft: '10px' }}>
+              {cancelText}
+            </Button>
+          )}
+        </div>
+      </section>
+    </section>
+  );
+};
+
+/**
+ * 显示一个对话框
+ * @param {Object} props 
+ * @param {string} props.title - 对话框标题
+ * @param {string} [props.okText='确认'] - 确认按钮文案
+ * @param {string} [props.cancelText='取消'] - 取消按钮文案
+ * @param {boolean} [props.noCancel=false] - 不显示取消按钮
+ * @param {()=>Promise<boolean>} [props.onOk] - 点击确认按钮回调
+ * @param {()=>Promise<boolean>} [props.onClose] - 点击关闭的回调
+ * @param {JSX.Element|any} [props.component] - 对话框内的实际内容
+ * 
+ * @returns {Promise<boolean>}
+ */
+export const ShowDialog = (props={title:''}) => {
+  const {title,onOk,okText,cancelText,noCancel,onClose,component}= props;
+  return new Promise((reslove) => {
+    let popup = Popup(reslove);
+    ReactDOM.render(
+      <Dialog
+        title={title}
+        destory={popup.destory}
+        onOk={onOk}
+        okText={okText}
+        cancelText={cancelText}
+        noCancel={noCancel}
+        onClose={onClose}
+      >
+        {component}
+      </Dialog>,
+      popup.dom
+    );
+  });
+};
+
+/**
+ * 一个带确认和取消的确认对话框
+ * @param {Object} props 
+ * @param {string} props.title - 对话框标题
+ * @param {string} [props.okText='确认'] - 确认按钮文案
+ * @param {string} [props.cancelText='取消'] - 取消按钮文案
+ * @param {boolean} [props.noCancel=false] - 不显示取消按钮
+ * @param {JSX.Element|any} [props.content] - 对话框内的实际内容
+ * @returns {Promise<boolean>}
+ */
+export const ShowConfirm = async (props) => {
+  if (typeof props === 'string') {
+    // @ts-ignore
+    props = { content: props };
+  }
+  const {title='注意',okText='确认',cancelText='取消',noCancel=false,content}= props;
+
+  let result = false;
+  await ShowDialog({
+    title: title || '注意',
+    okText: okText || '确认',
+    cancelText: cancelText || '取消',
+    noCancel: noCancel,
+    onClose: async () => {
+      result = false;
+      return Promise.resolve(true);
+    },
+    onOk: async () => {
+      result = true;
+      return Promise.resolve(true);
+    },
+    component: (
+      <div className={styles.confirmWrap}>
+        {content}
+      </div>
+    ),
+  });
+  return result;
+};
+
+/**
+ * 一个只有确认按钮的提示框
+ * @param {Object} props 
+ * @param {string} [props.okText='确认'] - 确认按钮文案
+ * @param {JSX.Element|any} [props.content] - 对话框内的实际内容
+ * @param {()=>void} [props.onOk] - 点击确认的回调
+ * @param {()=>void} props.destory - 关闭对话框的回调
+ * @param {string} [props.type='error'] - 警告类型,'error'|'suuccess'
+ * 
+ * @returns {JSX.Element}
+ */
+const Alert = (props) => {
+  const {onOk:fnOnOk,destory,type,content,okText='确认'}= props;
+  function onOk() {
+    if (fnOnOk) fnOnOk();
+    destory();
+  }
+  return (
+    <section className={styles.body }>
+      <div className={styles.mask} />
+      <section className={styles.wrapAlert}>
+        <div className={styles.alertContent}>
+          <div className={type === 'success' ? styles.iconSuccess : styles.iconError} />
+          <span>{content}</span>
+        </div>
+        <div className={styles.alertFooter}>
+          <span onClick={onOk}>{okText}</span>
+        </div>
+      </section>
+    </section>
+  );
+};
+
+/**
+ * 显示一个alert
+ * @param {Object} props 
+ * @param {JSX.Element|any} [props.content] - 对话框内的实际内容
+ * @param {()=>void} [props.onOk] - 点击确认的回调
+ * @param {string} [props.type='success'] - 警告类型,'error'|'suuccess'
+ * 
+ * @returns {Promise<void>}
+ */
+export const ShowAlert = (props) => {
+  if (props.constructor === String) {
+    // @ts-ignore
+    props = { content: props };
+  }
+
+  const {type='success',onOk,content}=props;
+
+  return new Promise((reslove) => {
+    let popup = Popup(reslove);
+
+    ReactDOM.render(
+      <Alert destory={popup.destory} type={type} onOk={onOk} content={content} />,
+      popup.dom
+    );
+  });
+};
+
+/**
+ * 显示一个错误提示alert
+ * @param {Object} props 
+ * @param {JSX.Element|any} [props.content] - 对话框内的实际内容
+ * @param {()=>void} [props.onOk] - 点击确认的回调
+ * 
+ * @returns {Promise<void>}
+ */
+export const ShowErrorAlert = (props) => {
+  if (props.constructor === String) {
+    props = { content: props };
+  }
+  return ShowAlert({ ...props, type: 'fail' });
+};
+
+export default Dialog;

package/templates/{template_oa/public/src/components/Empty → template_oa_jwt/public/src/components/empty}/index.jsx

@@ -1,9 +1,18 @@
+// @ts-ignore 
 import React from 'react';
+// @ts-ignore 
 import { Empty, Button } from 'antd';
+
+// @ts-ignore 
 import styles from './index.less';
 
 /**
  * 当table数据为空时下方有“添加数据”按钮
+ * @param {object} props 
+ * @param {()=>void} [props.onClick] - 点击添加数据的回调
+ * @param {boolean} [props.editmode] - 是否允许编辑模式，允许的话就会有添加数据的按钮
+ * 
+ * @returns {JSX.Element}
  */
 function TableEmpty(props) {
   return (

package/templates/{template_oa/public/src/components/FormRow → template_oa_jwt/public/src/components/formRow}/index.jsx

@@ -1,6 +1,16 @@
-import React, { useState } from 'react';
+// @ts-ignore
+import React from 'react';
+
+// @ts-ignore
 import styles from './index.less';
 
+/**
+ * 表单的行组件,用于将子组件按照一行2列方式排列
+ * @param {Object} props 
+ * @param {JSX.Element[]|JSX.Element} props.children
+ * 
+ * @returns {JSX.Element}
+ */
 const FormRow = (props) => {
   function createCol(item, idx) {
     if (!item) return '';
@@ -9,6 +19,7 @@ const FormRow = (props) => {
       <div key={idx} className={styles.formRow}>
         <hgroup className={styles.row}>
           <div className={styles.title}>
+            {/* @ts-ignore */}
             <div required={editmode && item.props.required}>{item.props.label}</div>
           </div>
           <div className={styles.data}>{item}</div>
@@ -18,20 +29,31 @@ const FormRow = (props) => {
   }
   return (
     <section className={styles.formRowBody}>
+      {/* @ts-ignore */}
       {props.children.length > 0 ? props.children.map(createCol) : createCol(props.children)}
     </section>
   );
 };
 
+/**
+ * 表单的行组件中的列组件
+ * @param {Object} props 
+ * @param {JSX.Element[]|JSX.Element} props.children
+ * @param {boolean} [props.editmode=true] - 可编辑模式
+ * @param {string} [props.txtdata='-'] - 列的标题
+ * @param {boolean} [props.textarea=false] - 是否多行显示文本
+ * 
+ * @returns {JSX.Element|JSX.Element[]|any}
+ */
 function HocEditControl(props) {
   const { editmode = true, txtdata ,textarea} = props;
   if (editmode) {
     return props.children;
   }
   if(textarea){
-    return <span style={{whiteSpace:'pre-wrap'}}>{txtdata||'-'}</span>
+    return <span style={{whiteSpace:'pre-wrap'}}>{txtdata}</span>
   }
-  return <span>{txtdata || '-'}</span>;
+  return <span>{txtdata}</span>;
 }
 
 FormRow.Col = HocEditControl;

package/templates/{template_oa/public/src/components/FormTable → template_oa_jwt/public/src/components/formTable}/index.jsx

@@ -1,6 +1,46 @@
+// @ts-ignore
 import React ,{useImperativeHandle,useState,forwardRef} from 'react';
+
+// @ts-ignore
 import uuid from 'js-uuid';
 
+// @ts-ignore
+import styles from './index.less';
+
+
+/**
+ * @typedef {object} ColumnsOptions
+ * @property {string} formItemName
+ * @property {(record:any,index:number,event:any)=>void} onDel
+ * @property {(record:any,index:number,event:any)=>void} onAdd
+ * @property {(record:any,index:number,event:any)=>void} onCopy
+ * @property {(initValue:[],event:any)=>void} onReset
+ */
+
+/**
+ * 表格表单组件
+ * @param {Object} props 
+ * @param {JSX.Element|any} props.Table - Table组件，一般为antd的Table组件 
+ * @param {Object} props.form - Form组件
+ * @param {string} props.formItemName - 表格FormItem的name
+ * @param {boolean} [props.saveLast=false] - 是否当没有数据时，默认保留一行数据
+ * @param {Object[]} [props.initialValue] - 初始数据
+ * 
+ * @param {(record:object,index:number)=>object[]} [props.onCopy] - 点击复制的回调
+ * @param {(record:object,index:number)=>object[]} [props.onAdd] - 点击添加的回调
+ * 
+ * @param {(value:any)=>void} [props.onChange] - 数据发生变动时的回调
+ * @param {(value:any)=>void} [props.onRefresh] - 刷新时的回调
+ * 
+ * @param {(options:ColumnsOptions)=>[]} props.columns - 获取列配置数据的回调
+ * 
+ * @param {Object} [props.newdata] - 添加新行的数据模版
+ * @param {Object} [props.antTableOptions] - antd的Table扩展参数
+ * 
+ * @param {any} ref 
+ * 
+ * @returns 
+ */
 const TableFormItem =(props,ref)=> {
   const {Table,form,formItemName,saveLast} = props;
   const getNewId=()=>{
@@ -119,10 +159,9 @@ const TableFormItem =(props,ref)=> {
     onReset,
   }));
 
-
   return (
-   
     <Table
+      className={styles.table}
       {...{rowKey: '_rowKey',...props.antTableOptions}}
       dataSource={value}
       columns={props.columns({formItemName,onDel, onAdd,onReset,onCopy})}

package/templates/template_oa_jwt/public/src/components/formTable/index.less

@@ -0,0 +1,18 @@
+.table {
+  tr {
+    th, th>div {
+      text-align: center;
+      &[required]:before {
+        font-size: 0.12rem;
+        content: '*';
+        color: #f04134;
+        margin-right: 10px;
+      }
+    }
+  }
+  :global {
+    .ant-form-item-explain-error {
+      text-align: left;
+    }
+  }
+}

package/templates/template_oa_jwt/public/src/components/iconFont/index.jsx

@@ -0,0 +1,22 @@
+// @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] - 扩展类名
+ * @param {()=>void} [props.onClick] - 点击回调
+ * 
+ * @returns {JSX.Element}
+ */
+const IconFont=(props)=>{
+  const {icon,className,...others} = props;
+  return (
+    <span {...others} className={`iconfont icon-${icon} ${styles.iconBox} ${className||''}`} ></span>
+  )
+}
+export default IconFont;