@vue-start/pro 0.5.19 → 0.5.21

package/dist/index.d.ts

@@ -1,12 +1,13 @@
 /// <reference types="lodash" />
 import * as vue from 'vue';
-import { VNode, ExtractPropTypes, PropType, App, UnwrapNestedRefs as UnwrapNestedRefs$1, Ref as Ref$1 } from 'vue';
+import { VNode, ExtractPropTypes, PropType, DefineComponent, App, UnwrapNestedRefs as UnwrapNestedRefs$1, Ref as Ref$1 } from 'vue';
 import * as _vue_reactivity from '@vue/reactivity';
 import { UnwrapNestedRefs, Ref, ComputedRef } from '@vue/reactivity';
 import { Subject } from 'rxjs';
 import { IRequestActor } from '@vue-start/request';
 import * as _vue_start_store from '@vue-start/store';
 import { TUpdater } from '@vue-start/store';
+import { Router, RouteLocationNormalizedLoaded } from 'vue-router';
 import { TConvert } from '@vue-start/hooks';
 import * as lodash from 'lodash';
 
@@ -82,6 +83,84 @@ interface FieldNames {
     children?: string;
 }
 
+/**
+ * eg:
+ * args:[{id:'111',name:'zx',age:18}]
+ * {type$: "data$", name$:"args", namePath$:"0.id"}
+ *
+ * 转换后
+ *
+ * '111'
+ */
+declare type TDataType = {
+    /**
+     * 取值源对象
+     * name$
+     * state:      当前module的state对象；
+     * data：      当前module的data（普通obj，仅存储数据使用）对象；
+     * args：      当前方法中的参数；缺省取该值
+     */
+    type$: "data$";
+    name$: string;
+    namePath$?: string;
+};
+declare type TParamItem = any | TDataType;
+/**
+ * args:[{id:'111',name:'zx',age:18}]
+ * eg1:
+ {
+   "type$": "obj",
+   "query$": [
+     "pick$",
+     {
+       "type$": "data$",
+       "name$": "args",
+       "namePath$": "0"
+     },
+     "id"
+   ],
+   "name": "QuotaDetail"
+ }
+ *
+ * eg2:
+ {
+    "type$": "obj",
+    "query.id$": {
+      "type$": "data$",
+      "name$": "args",
+      "namePath$": "0.id"
+    },
+    "name": "QuotaDetail"
+  }
+ *
+ * eg1 和 eg2 转换后的结果都为：
+ *
+ * {
+ *   name:"QuotaDetail",
+ *   query:{
+ *     id:'111
+ *   }
+ * }
+ */
+declare type TObjItem = {
+    type$: "obj";
+    /**
+     * 以"$"符结尾的属性可以设置为 TFunItem | TDataType | TObjItem，最终将为去除$的属性赋值
+     */
+    [key: string]: TParamItem | TFunItem;
+};
+/**
+ * 第一个项：调用模块的方法名称，以"$"结尾
+ * eg:
+ * ["pick$", {"id":"111", "name":"name"}, "id"]
+ *
+ * 转换后的结果
+ *
+ * {id:"111"}
+ */
+declare type TFunItem = (string | TParamItem | TObjItem)[];
+declare type TExpression = TFunItem | TDataType | TObjItem;
+
 /***************************************** curd模式 *****************************************/
 /**
  * 获取Column的valueType，默认"text"
@@ -111,14 +190,18 @@ declare const getItemEl: <T extends TColumn>(elementMap: any, column: T, value:
 /***************************************** 通用模式 *****************************************/
 declare type InternalNamePath = (string | number)[];
 declare type NamePath = string | number | InternalNamePath;
+declare type TExecuteName = "store" | "router" | "request";
+declare type TExecuteFunName = string;
+declare type TExecuteItem = (TExecuteName | TExecuteFunName | TParamItem | TObjItem | TFunItem)[];
 interface IHighConfig {
     registerStateList?: {
         name: NamePath;
         mapName?: NamePath;
+        target?: "prop" | "slot";
     }[];
     registerEventList?: {
         name: string;
-        sendEventName?: TActionEvent["type"];
+        executeList?: TExecuteItem[];
     }[];
     registerPropsTrans?: {
         name: NamePath;
@@ -134,7 +217,7 @@ interface IElementConfig {
     elementId: string;
     elementProps?: Record<string, any>;
     slots?: {
-        [name: string]: ((...params$: any[]) => any) | (IElementConfig & {
+        [name: string]: string | number | ((...params$: any[]) => any) | (IElementConfig & {
             needParams?: boolean;
         });
     };
@@ -142,6 +225,7 @@ interface IElementConfig {
     childrenSlotName?: string;
     highConfig$?: IHighConfig;
 }
+declare const isValidConfig: (elementConfig: any) => boolean;
 declare const renderElements: (elementMap: TElementMap, elementConfigs: IElementConfig[]) => (VNode | null)[];
 /**
  *
@@ -174,8 +258,11 @@ interface IProModuleProvide {
     sendEvent: (action: TActionEvent) => void;
     state: UnwrapNestedRefs<Record<string, any>>;
     dispatch: (action: TActionState) => void;
+    data: Record<string, any>;
     requests: IRequestOpts[];
     sendRequest: (requestNameOrAction: string, ...params: any[]) => void;
+    executeExp: (param: TExpression, args: any) => any;
+    execute: (executeList: TExecuteItem[], args: any[]) => void;
 }
 declare const useProModule: () => IProModuleProvide;
 declare const provideProModule: (ctx: IProModuleProvide) => void;
@@ -190,9 +277,13 @@ interface IRequestOpts {
     stateName?: string;
     loadingName?: string;
     convertParams?: (...params: any[]) => Record<string, any>;
+    convertParamsEx?: TExpression;
     convertData?: (actor: IRequestActor) => Record<string, any>;
+    convertDataEx?: TExpression;
     onSuccess?: (actor?: IRequestActor) => void;
+    onSuccessEx?: TExecuteItem[];
     onFailed?: (actor?: IRequestActor) => void;
+    onFailedEx?: TExecuteItem[];
 }
 declare const RequestAction: {
     Success: string;
@@ -205,6 +296,21 @@ declare const proModuleProps: () => {
     state: {
         type: PropType<Record<string, any>>;
     };
+    initState: {
+        type: PropType<object>;
+    };
+    /**
+     * store names
+     */
+    storeKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * meta names
+     */
+    metasKeys: {
+        type: PropType<string[]>;
+    };
     /**
      * 组件集
      */
@@ -215,11 +321,14 @@ declare const proModuleProps: () => {
      * 组件描述（树）
      */
     elementConfigs: {
-        type: PropType<IElementConfig[]>;
+        type: PropType<IElementConfig | IElementConfig[]>;
     };
     /**
      * requests
      */
+    actors: {
+        type: PropType<IRequestActor<any, any, any>[]>;
+    };
     requests: {
         type: PropType<IRequestOpts[]>;
     };
@@ -232,6 +341,21 @@ declare const ProModule: vue.DefineComponent<Partial<ExtractPropTypes<{
     state: {
         type: PropType<Record<string, any>>;
     };
+    initState: {
+        type: PropType<object>;
+    };
+    /**
+     * store names
+     */
+    storeKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * meta names
+     */
+    metasKeys: {
+        type: PropType<string[]>;
+    };
     /**
      * 组件集
      */
@@ -242,11 +366,14 @@ declare const ProModule: vue.DefineComponent<Partial<ExtractPropTypes<{
      * 组件描述（树）
      */
     elementConfigs: {
-        type: PropType<IElementConfig[]>;
+        type: PropType<IElementConfig | IElementConfig[]>;
     };
     /**
      * requests
      */
+    actors: {
+        type: PropType<IRequestActor<any, any, any>[]>;
+    };
     requests: {
         type: PropType<IRequestOpts[]>;
     };
@@ -257,6 +384,21 @@ declare const ProModule: vue.DefineComponent<Partial<ExtractPropTypes<{
     state: {
         type: PropType<Record<string, any>>;
     };
+    initState: {
+        type: PropType<object>;
+    };
+    /**
+     * store names
+     */
+    storeKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * meta names
+     */
+    metasKeys: {
+        type: PropType<string[]>;
+    };
     /**
      * 组件集
      */
@@ -267,16 +409,35 @@ declare const ProModule: vue.DefineComponent<Partial<ExtractPropTypes<{
      * 组件描述（树）
      */
     elementConfigs: {
-        type: PropType<IElementConfig[]>;
+        type: PropType<IElementConfig | IElementConfig[]>;
     };
     /**
      * requests
      */
+    actors: {
+        type: PropType<IRequestActor<any, any, any>[]>;
+    };
     requests: {
         type: PropType<IRequestOpts[]>;
     };
 }>>>, {}>;
 
+declare type TConfigData = {
+    initState?: Record<string, any>;
+    initExecuteList?: TExecuteItem[];
+    storeKeys?: string[];
+    requests?: Omit<IRequestOpts, "actor"> & {
+        actor: string;
+    }[];
+    elementConfigs?: IElementConfig | IElementConfig[];
+};
+declare const createModule: ({ actors, configData, configDataExtra, Logic, }: {
+    actors?: IRequestActor<any, any, any>[] | undefined;
+    configData?: TConfigData | undefined;
+    configDataExtra?: Record<string, any> | undefined;
+    Logic?: DefineComponent<{}, {}, {}, vue.ComputedOptions, vue.MethodOptions, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{}>>, {}> | undefined;
+}) => DefineComponent<unknown, () => JSX.Element | null, {}, vue.ComputedOptions, vue.MethodOptions, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<unknown>, {}>;
+
 declare type TInitialState<T> = T | (() => T);
 declare type TRegisterStore = {
     key: string;
@@ -322,6 +483,17 @@ declare type TMeta = {
 declare const useDispatchMeta: () => (actorName: string) => void;
 declare const useMetaRegister: (registerMetaMap: IProConfigProvide["registerMetaMap"], registerActorMap: IProConfigProvide["registerActorMap"]) => void;
 
+declare type TOpen = (url?: string | URL, target?: string, features?: string) => WindowProxy | null;
+declare type TOpenMenu = (menu: any) => void;
+declare type TRouter = Router & {
+    open: TOpen;
+    openMenu: TOpenMenu;
+};
+declare const useProRouter: () => {
+    router: TRouter;
+    route: RouteLocationNormalizedLoaded;
+};
+
 declare const proBasePropsFn: () => {
     /**
      * 组件集
@@ -390,6 +562,10 @@ interface IProConfigProvide {
      * @param extra
      */
     dispatchRequest: ProDispatchRequestType;
+    convertRouter?: (router: Router) => TRouter;
+    expressionMethods: {
+        [key: string]: (...params: any[]) => any;
+    };
 }
 declare const proConfigProps: () => {
     elementMap: {
@@ -412,6 +588,14 @@ declare const proConfigProps: () => {
     registerMetas: {
         type: PropType<TMeta[]>;
     };
+    convertRouter: {
+        type: PropType<(router: Router) => TRouter>;
+    };
+    expressionMethods: {
+        type: PropType<{
+            [key: string]: (...params: any[]) => any;
+        }>;
+    };
 };
 declare const useProConfig: () => IProConfigProvide;
 declare type ProConfigProps = Partial<ExtractPropTypes<ReturnType<typeof proConfigProps>>>;
@@ -439,6 +623,14 @@ declare const ProConfig: vue.DefineComponent<Partial<ExtractPropTypes<{
     registerMetas: {
         type: PropType<TMeta[]>;
     };
+    convertRouter: {
+        type: PropType<(router: Router) => TRouter>;
+    };
+    expressionMethods: {
+        type: PropType<{
+            [key: string]: (...params: any[]) => any;
+        }>;
+    };
 }>>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, vue.EmitsOptions, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<Partial<ExtractPropTypes<{
     elementMap: {
         type: PropType<TElementMap>;
@@ -460,6 +652,14 @@ declare const ProConfig: vue.DefineComponent<Partial<ExtractPropTypes<{
     registerMetas: {
         type: PropType<TMeta[]>;
     };
+    convertRouter: {
+        type: PropType<(router: Router) => TRouter>;
+    };
+    expressionMethods: {
+        type: PropType<{
+            [key: string]: (...params: any[]) => any;
+        }>;
+    };
 }>>>, {}>;
 /**
  * app.use 方式注册
@@ -2063,4 +2263,4 @@ declare const getSignValue: <T = any>(item: TColumn, signName: string) => T;
  */
 declare const filterSlotsByPrefix: (slots: Record<string, any>, prefix: string) => lodash.Dictionary<any>;
 
-export { AddButton, BooleanObjType, BooleanRulesObjType, ColumnSetting, CurdAction, CurdAddAction, CurdCurrentMode, CurdMethods, CurdSubAction, ElementKeys, FieldNames, FormAction, FormItemProps, FormRulePrefixMap, IAccess, ICurdAction, ICurdAddAction, ICurdCurrentMode, ICurdOperateOpts, ICurdState, ICurdSubAction, IElementConfig, IHighConfig, IListData, IOpeItem, IOperateItem, IPer, IProConfigProvide, IProCurdProvide, IProFormProvideExtra, IProModuleProvide, IProTableProvide, IProTableProvideExtra, IRequestOpts, ISearchMode, ITableOperate, IUser, InternalNamePath, LogonUser, LogonUserKey, MustLogon, NamePath, PageHeaderProps, PaginationSlotProps, PerSuffix, Permission, PermissionProps, ProBaseProps, ProColumnSettingProps, ProConfig, ProConfigProps, ProCurd, ProCurdDesc, ProCurdDescConnect, ProCurdDescProps, ProCurdForm, ProCurdFormConnect, ProCurdFormProps, ProCurdList, ProCurdListConnect, ProCurdListProps, ProCurdModal, ProCurdModalForm, ProCurdModalFormConnect, ProCurdModalProps, ProCurdProps, ProDesc, ProDescProps, ProDispatchRequestType, ProForm, ProFormItemProps, ProFormList, ProFormListProps, ProFormProps, ProGrid, ProGridProps, ProLayout, ProList, ProListProps, ProModalCurd, ProModalCurdProps, ProModule, ProModuleProps, ProOperate, ProOperateProps, ProPage, ProPageCurd, ProPageCurdProps, ProPageProps, ProSearchForm, ProSearchFormProps, ProShowDate, ProShowDigit, ProShowOptions, ProShowText, ProShowTree, ProTable, ProTableProps, ProTypography, ProTypographyProps, ProUploaderText, RequestAction, SearchMode, SearchSlotProps, TAccess, TActionEvent, TActionState, TColumn, TColumns, TCurdActionEvent, TDefaultValueType, TElementMap, TFile, TFormExtraMap, TInitialState, TLogonUserProvide, TMeta, TOption, TOptions, TPageState, TProFormOperate, TRegisterStore, TRegisterStoreMap, TTableColumn, TTableColumns, TValueType, TreeOption, TreeOptions, UploadList, Wrapper, convertPathToList, convertResData, createExpose, createExposeObj, createFormItemCompFn, createProConfig, defaultPage, filterSlotsByPrefix, getColumnFormItemName, getColumnValueType, getFirstPropName, getFormItemEl, getItemEl, getSignValue, getValidValues, mergeStateToList, proBaseProps, provideProCurd, provideProFormList, provideProModule, renderElement, renderElements, useAccess, useAccessMgr, useComposeRequestActor, useDispatchMeta, useDispatchStore, useDoneRequestActor, useFailedRequestActor, useGetCompByKey, useHasPer, useLogonUser, useMetaRegister, useModuleEvent, useProConfig, useProCurd, useProForm, useProFormList, useProModule, useProTable, useReadStore };
+export { AddButton, BooleanObjType, BooleanRulesObjType, ColumnSetting, CurdAction, CurdAddAction, CurdCurrentMode, CurdMethods, CurdSubAction, ElementKeys, FieldNames, FormAction, FormItemProps, FormRulePrefixMap, IAccess, ICurdAction, ICurdAddAction, ICurdCurrentMode, ICurdOperateOpts, ICurdState, ICurdSubAction, IElementConfig, IHighConfig, IListData, IOpeItem, IOperateItem, IPer, IProConfigProvide, IProCurdProvide, IProFormProvideExtra, IProModuleProvide, IProTableProvide, IProTableProvideExtra, IRequestOpts, ISearchMode, ITableOperate, IUser, InternalNamePath, LogonUser, LogonUserKey, MustLogon, NamePath, PageHeaderProps, PaginationSlotProps, PerSuffix, Permission, PermissionProps, ProBaseProps, ProColumnSettingProps, ProConfig, ProConfigProps, ProCurd, ProCurdDesc, ProCurdDescConnect, ProCurdDescProps, ProCurdForm, ProCurdFormConnect, ProCurdFormProps, ProCurdList, ProCurdListConnect, ProCurdListProps, ProCurdModal, ProCurdModalForm, ProCurdModalFormConnect, ProCurdModalProps, ProCurdProps, ProDesc, ProDescProps, ProDispatchRequestType, ProForm, ProFormItemProps, ProFormList, ProFormListProps, ProFormProps, ProGrid, ProGridProps, ProLayout, ProList, ProListProps, ProModalCurd, ProModalCurdProps, ProModule, ProModuleProps, ProOperate, ProOperateProps, ProPage, ProPageCurd, ProPageCurdProps, ProPageProps, ProSearchForm, ProSearchFormProps, ProShowDate, ProShowDigit, ProShowOptions, ProShowText, ProShowTree, ProTable, ProTableProps, ProTypography, ProTypographyProps, ProUploaderText, RequestAction, SearchMode, SearchSlotProps, TAccess, TActionEvent, TActionState, TColumn, TColumns, TConfigData, TCurdActionEvent, TDefaultValueType, TElementMap, TExecuteFunName, TExecuteItem, TExecuteName, TFile, TFormExtraMap, TInitialState, TLogonUserProvide, TMeta, TOpen, TOpenMenu, TOption, TOptions, TPageState, TProFormOperate, TRegisterStore, TRegisterStoreMap, TRouter, TTableColumn, TTableColumns, TValueType, TreeOption, TreeOptions, UploadList, Wrapper, convertPathToList, convertResData, createExpose, createExposeObj, createFormItemCompFn, createModule, createProConfig, defaultPage, filterSlotsByPrefix, getColumnFormItemName, getColumnValueType, getFirstPropName, getFormItemEl, getItemEl, getSignValue, getValidValues, isValidConfig, mergeStateToList, proBaseProps, provideProCurd, provideProFormList, provideProModule, renderElement, renderElements, useAccess, useAccessMgr, useComposeRequestActor, useDispatchMeta, useDispatchStore, useDoneRequestActor, useFailedRequestActor, useGetCompByKey, useHasPer, useLogonUser, useMetaRegister, useModuleEvent, useProConfig, useProCurd, useProForm, useProFormList, useProModule, useProRouter, useProTable, useReadStore };