@juzhenfe/page-model 3.22.3 → 3.22.4

package/dist/components/form/type.d.ts

@@ -0,0 +1,166 @@
+import { ColProps, RowProps, CollapseProps, TabsProps, DrawerProps } from 'element-plus';
+import { Component } from 'vue';
+
+
+
+declare global {
+  namespace PageModel {
+
+    type FormMode = 'dialog' | 'fullpage' | 'drawer' | 'custom'
+  
+    type FormStatus = 'add' | 'edit' | 'view'
+
+    type ContainerMode = 'Col'
+  
+    type ModuleType = 'tabs'
+
+    type ModuleProps = Partial<CollapseProps & TabsProps>
+
+    type DialogProps = {
+      title: string | ((status: FormStatus) => string);
+      width: string | number;
+      fullscreen: boolean;
+      top: string;
+      modal: boolean;
+      appendToBody: boolean;
+      lockScroll: boolean;
+      customClass: string;
+      openDelay: number;
+      closeDelay: number;
+      closeOnClickModal: boolean;
+      closeOnPressEscape: boolean;
+      showClose: boolean;
+      beforeClose: (done: Function) => void;
+      draggable: boolean;
+      center: boolean;
+      destroyOnClose: boolean;
+    }
+
+    type FullPageProps = {
+      title?: string | ((status: FormStatus) => string);
+      show?: boolean;
+    }
+
+    type ServerValidateError = {
+      errors: { [key: string]: string[] };
+      status: number;
+      title: string;
+      type: string;
+      traceId: string;
+    }
+    
+    type ServerError = {
+      data: ServerValidateError
+    }
+  
+    type FormProps = {
+      rules: AnyObject;
+      inline: boolean;
+      labelPosition: 'left' | 'right' | 'top';
+      labelWidth: string;
+      labelSuffix: string;
+      hideRequiredAsterisk: boolean;
+      showMessage: boolean;
+      inlineMessage: boolean;
+      statusIcon: boolean;
+      size: Size;
+      disabled: boolean;
+      validateOnRuleChange: boolean;
+      class: string;
+    }
+
+    type ColLayout = {
+      col?: Partial<ColProps>
+    }
+
+    type FormRowProps = Partial<RowProps>
+
+    type GridLayout = {}
+
+    type FormItem<MODEL = AnyObject, CTX = any> = LinkedFormItem<MODEL, CTX> & ColLayout & GridLayout
+    
+
+    type Form<MODEL = AnyObject, CTX = any> = {
+      // 表单容器的显示模式
+      mode?: FormMode;
+      // 弹窗模式配置参数
+      dialogProps?: CreatePropsFromElement<Omit<DrawerProps, 'title'> & { title?: CreateDeType<string, CTX> }, undefined, CTX>;
+      // 抽屉的参数
+      drawerProps?: CreatePropsFromElement<(Omit<DrawerProps, 'title'>) & { title?: CreateDeType<string, CTX> }, undefined, CTX>;
+      // 全屏表单模式参数
+      fullpageProps?: FullPageProps;
+      // 容器组件
+      formContainer?: Component;
+      // 容器组件自定义样式
+      formContainerProps?: AnyObject;
+      // 表单参数
+      props?: Partial<FormProps>;
+      // 表单模块类型
+      moduleConfig?: {
+        type: ModuleType;
+        props?: ModuleProps;
+      };
+      // 块级配置
+      sectionConfig?: {
+        // 模式
+        mode?: 'card' | 'collapse';
+        // 是否可以折叠
+        collapse?: boolean
+        // 块的单独默认配置
+        sections?: {
+          [key: string]: {
+            // 是否可以折叠
+            collapse?: boolean
+            // 默认收缩
+            defaultCollapse?: boolean
+          }
+        }
+      }
+      
+      // 表单初始数据
+      initialData?: AnyObject;
+      
+      // 表单打开
+      onFormOpened?: (this: CTX) => void;
+
+      // 表单隐藏
+      onFormClosed?: (this: CTX) => void;
+
+      // 绑定前的处理函数
+      bindData?: CreateDePromiseResult<(this: CTX, data: MODEL) => AnyObject | false>;
+      
+      // 提交前的处理逻辑
+      beforeSubmit?: CreateDePromiseResult<(this: CTX, data: MODEL) => AnyObject | false>;
+
+      // 新增接口完成
+      onAdded?: (this: CTX, data: any) => any;
+      
+      // 更新接口完成
+      onUpdated?: (this: CTX, data: any) => any;
+
+      // 表单数据变化回调
+      onFormDataChange?: (this: CTX, data: MODEL) => void;
+  
+      // 表单字段校验
+      required?: (keyof MODEL)[];
+      
+      // 列表展示的模式
+      containerMode?: ContainerMode;
+
+      // row属性
+      rowProps?: FormRowProps;
+      
+      // 表单元素
+      els: FormItem<MODEL, CTX>[];
+
+      /**
+       * 是否离开前判断表单变化
+       */
+      leaveConfirm?: boolean;
+      /**
+       * 离开前提示信息
+       */
+      leaveConfirmMessage?: string | ((this: CTX, model: MODEL) => string);
+    }
+  }
+}

package/dist/components/normal-tab/type.d.ts

@@ -0,0 +1,18 @@
+import { TabsProps } from 'element-plus';
+
+
+declare global {
+  namespace PageModel {
+    type NormalTabItem = {
+      label: string;
+      value: AnyObject;
+      default?: boolean;
+    } & _Badge
+  
+    type NormalTab = {
+      props?: Partial<TabsProps>;
+      panes?: NormalTabItem[];
+      refreshOnChange?: boolean;
+    }
+  }
+}

package/dist/components/page-model/components/top-tabs/type.d.ts

@@ -0,0 +1,11 @@
+/// <reference path="../../../normal-tab/type.d.ts" />
+/// <reference path="../../../scenes-tab/type.d.ts" />
+
+declare namespace PageModel {
+  type Tabs = NormalTab & {
+    // 是否使用场景
+    useScene?: boolean;
+    // 场景
+    sceneTab?: ScenesTab;
+  }
+}

package/dist/components/page-model/type.d.ts

@@ -0,0 +1,339 @@
+import { default as ReflectRelation } from '../../utils/reflect/reflect-collector';
+import { Component, WatchStopHandle } from 'vue';
+import { default as FormManager } from '../form/constructor';
+import { default as SearchFormManager } from '../search-form/constructor';
+import { default as PageModelManager } from './constructor';
+
+
+declare global {
+  namespace PageModel {
+
+    type Size =	'large' | 'default' | 'small'
+  
+    type UrlMode = 'path' | 'params'
+  
+    type AjaxMethod = 'get' | 'post' | 'delete' | 'put' | 'patch' | 'head' | 'options' | 'connect' | 'trace'
+  
+    type ExportMode = 'get' | 'build'
+  
+    type RequestProcessFn<CTX = any> = (this: CTX, ...rest: any[]) => any;
+  
+    type GetReqResultProcessFn<CTX = any> = (this: CTX, ...rest: any[]) => {
+      total: number;
+      list: any[];
+    }
+
+    /**
+     * 可能返回promise的函数
+     */
+    type MayBeAPromiseFn<T extends (...args: any[]) => any> = T | ((...args: Parameters<T>) => Promise<ReturnType<T>>)
+
+    type PatchConfigFn = {
+      (this: PageModelManager, config: PageModel.Config | PageModel.UConfig): PageModel.Config | PageModel.UConfig
+    }
+  
+    type InnerPatchName = 'serverFormErrorHandler'
+  
+    type Patch = InnerPatchName | PatchConfigFn
+
+    type Reflections = {
+      [key: string]: any[];
+    }
+
+    type TreeProps = {
+      id: string;
+      pId: string;
+      children?: string;
+    }
+
+    type ReflectWatches = WatchStopHandle[] & {
+      reflect: ReflectRelation
+    }
+    type Config<MODEL = AnyObject, EXTENDS = any> = {
+      // 模块名称
+      name?: string;
+      /**
+       * 启用按钮权限
+       */
+      openAuthButton?: boolean;
+      /**
+       * 是否在config准备完毕后直接获取数据
+       */
+      getImmediate?: boolean;
+      /**
+       * 是否开启外置数据反射
+       */
+      reflect?: boolean;
+      /**
+       * 全局设置尺寸
+       */
+      size?: Size;
+      /**
+       * 阴影
+       */
+      shadow?: boolean;
+      /**
+       * 键盘事件
+       */
+      keyboardEvents?: {
+        [key: string]: (this: PageModelManager, e: KeyboardEvent) => any;
+      };
+
+      /**
+       * 基请求地址，增删改查接口基于此url构建restful风格地址
+       */
+      url?: string;
+      /**
+       * 删除接口、详情接口参数构建方式，path参与路径，params参数请求
+       */
+      urlMode?: UrlMode;
+
+      /**
+       * 获取API地址
+       */
+      getUrl?: string;
+      /**
+       * 获取method
+       */
+      getMethod?: AjaxMethod;
+
+      /**
+       * 自定义获取器
+       */
+      customGetter?: MayBeAPromiseFn<(this: PageModelManager, reqParams: AnyObject) => {
+        total: number;
+        data: MODEL[];
+      }>
+
+      /**
+       * 获取的其他参数
+       */
+      otherParams?: AnyObject;
+
+      /**
+       * 列表接口请求前回调
+       */
+      beforeGetRequest?: (this: PageModelManager, reqParams: AnyObject) => void;
+
+      /**
+       * 获取的数据拿取方式（处理不同请求返回数据列表的方法）
+       */
+      getReqResultProcessFn?: MayBeAPromiseFn<GetReqResultProcessFn<PageModelManager>>
+      
+      /**
+       * 请求参数回调处理
+       * @param this 
+       * @param data 列表数据
+       * @returns 列表数据
+       */
+      getDataCallback?: (this: PageModelManager, data: MODEL[]) => ExtendKeys<MODEL>[];
+
+      /**
+       * 树形数据配置
+       */
+      treeProps?: TreeProps;
+
+      /**
+       * 删除地址
+       */
+      delUrl?: string;
+      /**
+       * 从row中获取删除参数的key
+       */
+      delKey?: keyof MODEL;
+      /**
+       * 删除参数的rowKey键名称
+       */
+      delParamsKey?: keyof MODEL;
+      /**
+       * 删除method
+       */
+      delMethod?: AjaxMethod;
+      /**
+       * 删除参数
+       */
+      delParams?: AnyObject | ((this: PageModelManager, data: MODEL) => AnyObject);
+      /**
+       * 删除的参数处理方法
+       */
+      delReqDataProcessFn?: RequestProcessFn;
+      /**
+       * 删除的数据拿取方式
+       */
+      delReqResultProcessFn?: RequestProcessFn;
+  
+      // 更新地址
+      updUrl?: string;
+      // 更新方法
+      updMethod?: AjaxMethod;
+      // 更新的数据拿取方式
+      updReqResultProcessFn?: RequestProcessFn;
+  
+      // 新增地址
+      addUrl?: string;
+      // 新增方法
+      addMethod?: AjaxMethod;
+      // 新增的数据拿取方式
+      addReqResultProcessFn?: RequestProcessFn;
+      // 新增按钮的样式
+      addButton?: Pick<Button, 'text' | 'props'>;
+      // 新增按钮是否放置在多选操作
+      addButtonInSelectButtonsArea?: boolean;
+  
+      /**
+       * 详情地址
+       */
+      detailUrl?: string;
+      /**
+       * 提取详情参数的rowKey键名称
+       */
+      detailKey?: keyof MODEL;
+      /**
+       * 详情请求参数的rowKey键名称
+       */
+      detailParamsKey?: keyof MODEL;
+      /**
+       * 详情method
+       */
+      detailMethod?: string;
+      // 详情的参数获取方式
+      detailReqDataProcessFn?: RequestProcessFn;
+      // 详情的数据拿取方式
+      detailReqResultProcessFn?: RequestProcessFn;
+      // 详情是否显示记载中
+      detailLoading?: boolean;
+      // 是否使用详情
+      useDetail?: boolean;
+      
+      // 导入地址
+      importUrl?: string;
+      // 导入方法
+      importMethod?: AjaxMethod;
+      // 导入文件名称
+      importFileKey?: string;
+      // 导入参数
+      importParams?: AnyObject | ((this: any, data: MODEL) => AnyObject);
+
+      // 导出地址
+      exportUrl?: string;
+      // 导出的模式 后端构建 get 或者 前端构建 build
+      exportMode?: ExportMode;
+      // 导出参数
+      exportParams?: AnyObject | ((this: any, data: MODEL) => AnyObject);
+  
+      // 补丁，可以对config进行处理
+      patches?: Patch[];
+  
+      // 顶部布局参数，包含tab栏等
+      tabs?: Tabs;
+      
+      // config事件
+      events?: {
+        [key: string]: (this: PageModelManager, ...rest: any[]) => any;
+      }
+
+      // 搜索表单
+      searchForm?: SearchForm<MODEL, SearchFormManager>;
+  
+      // 表格
+      table: Table<MODEL, TableManager>;
+  
+      // 是否存在表单
+      hasForm?: boolean;
+  
+      // 表单配置
+      form?: Form<MODEL, FormManager<MODEL>>;
+    }
+  
+    // 使用配置
+    type UConfig<T = AnyObject, K = any> = Config<T, K> & {
+  
+    }
+  
+    // 注册时候的配置
+    type InstallOptions = {
+      // 请求对象 必须实现
+      request: IRequest;
+      // 捕获错误
+      errorHandler?: ErrorHandler;
+      // 默认配置
+      config?: Config<any, any>;
+      // patches
+      patches?: PatchConfigFn[];
+      // 文本配置
+      textConfig: TextConfig;
+      // 样式
+      style?: GlobalStyle;
+      // 导出excel的配置
+      excelExportConfig?: ExcelExportConfig;
+      // 保存配置
+      userSetting?: UserSetting
+      // 空内容组件
+      emptyData?: Component
+      /**
+       * 获取zIndex
+       */
+      getZIndex?: () => number;
+    }
+    
+
+    type ErrorHandler = {
+      (error: any): void;
+    }
+
+    type IRquestRquestMethods<T extends string, K> = {
+      [key in T]: K;
+    }
+  
+    type IRequest = IRquestRquestMethods<AjaxMethod, (url: string, ...rest: any[]) => Promise<any>>
+
+    type TextConfig = {
+      delTitle?: string;
+      delText?: string;
+      delSuccessText?: string;
+      addSuccessText?: string;
+      updSuccessText?: string;
+      importSuccessText?: string;
+      leaveConfirmTitle?: string;
+      leaveConfirmText?: string;
+    }
+
+    type GlobalStyle = {
+      searchFormItemWidth?: string;
+    }
+    
+    type ExcelExportConfig = {
+      fontFamily?: string;
+      fontSize?: number;
+    }
+
+    type PageModelUserConfig = {
+      /**
+       * 显示的行数，超出隐藏
+       */
+      showRowNumbers?: number;
+      /**
+       * 改变即刻搜索
+       */
+      searchOnValueChange?: boolean;
+      /**
+       * enter监听搜索
+       */
+      enterSearch?: boolean;
+    }
+
+    type userSettingMode = 'user' | 'server'
+
+    type UserSetting = {
+      // 配置的模式 本地 、服务端
+      mode?: userSettingMode;
+      // 提交的方法
+      serverUpdateFn?: (key: string, val: string) => Promise<boolean>;
+    }
+
+  }
+}
+
+export type Config<MODEL, EXTEND> = PageModel.Config<MODEL, EXTEND>
+
+export type InstallOptions = PageModel.InstallOptions

package/dist/components/scenes-tab/type.d.ts

@@ -0,0 +1,14 @@
+declare namespace PageModel {
+
+  type FetchSceneItem = {
+    id: number;
+    title: string;
+  }
+
+  type ScenesTab = {
+    // 自定义场景获取url
+    url: string;
+    // 场景列表
+    scenes?: FetchSceneItem[]
+  }
+}

package/dist/components/search-form/type.d.ts

@@ -0,0 +1,42 @@
+/// <reference path="../../types/common.d.ts" />
+
+
+declare namespace PageModel {
+
+  type SearchFormExpandMode = 'dialog' | 'expanded'
+
+  type SearchForm<MODEL = any, CTX = any> = {
+    // 更多的扩展形式
+    expandMode?: SearchFormExpandMode;
+    // 尺寸
+    size?: Size;
+    // label宽度
+    labelWidth?: string;
+    // 初始表单数据
+    initialData?: Partial<MODEL>;
+    // 成员
+    els: LinkedFormItem<MODEL, CTX>[];
+    // 处理函数
+    beforeSubmit?: (this: any, data: ExtendKeys<MODEL>) => ExtendKeys<MODEL> | false;
+
+    // 表单数据变化回调
+    onFormDataChange?: (this: CTX, data: MODEL) => void;
+
+    /**
+     * 是否值变化检索
+     */
+    searchOnValueChange?: boolean;
+    /**
+     * 是否设置私人配置
+     */
+    searchOnValueChangeSetted?: boolean;
+    /**
+     * 是否静态enter检索
+     */
+    enterSearch?: boolean;
+    /**
+     * 是否设置私人配置
+     */
+    enterSearchSetted?: boolean;
+  }
+}