@gct-paas/core 0.1.6-dev.4 → 0.1.6-dev.40

package/es/interface/i-dictionary/i-dictionary-item.d.ts

@@ -51,4 +51,84 @@ export interface IDictionaryItem {
      * @type {*}
      */
     data?: any;
+    /**
+     * 激活图标
+     *
+     * @type {string}
+     */
+    activeIcon?: string;
+    /**
+     * 提示信息
+     *
+     * @type {string}
+     */
+    tooltip?: string;
+    /**
+     * 可以树形嵌套的子项
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:16
+     * @type {ICodeItem[]}
+     */
+    children?: ICodeItem[];
+}
+/**
+ * 代码表项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-27 13:03:24
+ * @export
+ * @interface ICodeItem
+ */
+export interface ICodeItem {
+    /**
+     * 名称
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:41
+     * @type {string}
+     */
+    label: string;
+    /**
+     * 图标
+     *
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 激活图标
+     *
+     * @type {string}
+     */
+    activeIcon?: string;
+    /**
+     * 提示信息
+     *
+     * @type {string}
+     */
+    tooltip?: string;
+    /**
+     * 值
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 13:03:46
+     * @type {(string | number)}
+     */
+    value: string | number;
+    /**
+     * 是否禁用
+     *
+     * @author zhanghanrui
+     * @date 2024-10-16 09:10:22
+     * @type {boolean}
+     */
+    disabled?: boolean;
+    /**
+     * 可以树形嵌套的子项
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:16
+     * @type {ICodeItem[]}
+     */
+    children?: ICodeItem[];
 }

package/es/interface/i-kit-plugin-module/i-kit-plugin-module.d.ts

@@ -17,7 +17,7 @@ export interface IPluginKitModule {
      * 每次创建独立的 Vue 应用实例时调用，进行组件注册等操作
      *
      * @param {App} app
-     * @return {*}  {Promise<void>}
+     * @return {*}  {void}
      */
-    createAppVue(app: App): Promise<void>;
+    createAppVue(app: App): void;
 }

package/es/interface/i-pinia-action/i-global-actions.d.ts

@@ -1,3 +1,4 @@
+import { UserLoginResp } from '@gct-paas/api/platform';
 import { ProjectName } from '../../enums';
 import { IAppContext } from '..';
 /**
@@ -19,6 +20,12 @@ export interface IGlobalActions {
      * @param {ProjectName} name
      */
     setProjectName(name: ProjectName): void;
+    /**
+     * 设置页面加载状态
+     *
+     * @param {boolean} loading
+     */
+    setPageLoading(loading: boolean): void;
     /**
      * 设置租户标识
      *
@@ -36,4 +43,6 @@ export interface IGlobalActions {
     setContext(state: Partial<IAppContext>): void;
     /**设置应用标识 */
     setAid(aid: string): void;
+    /** 更新个人信息 */
+    updateUserInfo(info: UserLoginResp): void;
 }

package/es/interface/i-pinia-getter/i-global-getters.d.ts

@@ -8,7 +8,28 @@ import { IGlobalState } from '../i-pinia-state/i-global-state';
  * @extends {_GettersTree<IGlobalState>}
  */
 export interface IGlobalGetters extends _GettersTree<IGlobalState> {
+    /**
+     * 当前项目名称
+     *
+     * @return {*}  {string}
+     */
     getProjectName(): string;
-    /**返回空值显示 */
+    /**
+     * 空值显示内容
+     *
+     * @return {*}  {string}
+     */
     getEmptyDisplay(): string;
+    /**
+     * 获取用户信息
+     *
+     * @return {*}  {IObject}
+     */
+    getAppInfo(): IObject;
+    /**
+     * 获取页面加载状态
+     *
+     * @return {*}  {boolean}
+     */
+    getPageLoading(): boolean;
 }

package/es/interface/i-pinia-state/i-global-state.d.ts

@@ -2,6 +2,7 @@ import { StateTree } from 'pinia';
 import { ProjectName, nullDisplayEnum } from '../../enums';
 import { IAppContext } from '../i-app-context/i-app-context';
 import { UserLoginResp } from '@gct-paas/api/platform';
+import { GetAppResponse } from '@gct-paas/api/apaas';
 /**
  * 全局 store 状态
  *
@@ -21,12 +22,18 @@ export interface IGlobalState extends StateTree {
      * @type {ProjectName}
      */
     projectName: ProjectName;
+    /**
+     * setting 中的页面加载配置开启时，路由守卫中会触发 loading
+     *
+     * @type {boolean}
+     */
+    pageLoading: boolean;
     /**
      * 应用信息, todo: 等 api 包完成后，实际类型从 api 导入
      *
-     * @type {IObject}
+     * @type {GetAppResponse}
      */
-    appInfo: IObject;
+    appInfo: GetAppResponse;
     /**
      * 用户信息（user.store.ts 中加载后赋值）
      *

package/es/interface/index.d.ts

@@ -1,7 +1,7 @@
 export type * from './i-app-context/i-app-context';
 export type { IGlobalRegister } from './i-global-register/i-global-register';
 export type { IDictionary } from './i-dictionary/i-dictionary';
-export type { IDictionaryItem } from './i-dictionary/i-dictionary-item';
+export type { IDictionaryItem, ICodeItem, } from './i-dictionary/i-dictionary-item';
 export type { IFieldCodeChain } from './i-field-code-chain/i-field-code-chain';
 export type { GlobalVar } from './i-global-var/i-global-var';
 export type { IMobileHomeMenuItem } from './i-mobile-home-menu-item/i-mobile-home-menu-item';
@@ -10,6 +10,7 @@ export type { IGlobalActions } from './i-pinia-action/i-global-actions';
 export type { IGlobalGetters } from './i-pinia-getter/i-global-getters';
 export type { IGlobalState, emptyDisplayType, } from './i-pinia-state/i-global-state';
 export type { IPopoverOptions } from './i-popover-options/i-popover-options';
+export type { IActionItem } from './i-action-item/i-action-item';
 export type * from './model-designer/entity';
 export * from './model-designer/serial';
 export type * from './open-util';

package/es/interface/open-util/i-confirm-util/i-confirm-util.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 确认工具接口
+ *
+ * @export
+ * @interface IConfirmParams
+ */
+export interface IConfirmParams {
+    /**
+     * 确认框标题
+     *
+     * @type {string}
+     */
+    title: string;
+    /**
+     * 确认框内容
+     *
+     * @type {string}
+     */
+    content: string;
+    /**
+     * 确认框确认按钮文本
+     *
+     * @type {string}
+     */
+    okText?: string;
+    /**
+     * 确认框取消按钮文本
+     *
+     * @type {string}
+     */
+    cancelText?: string;
+}
+/**
+ * 确认工具接口
+ *
+ * @export
+ * @interface IConfirmUtil
+ */
+export interface IConfirmUtil {
+    /**
+     * 弹出确认框
+     *
+     */
+    confirm(options: IConfirmParams): Promise<boolean>;
+    /**
+     * 弹出信息提示框
+     *
+     */
+    info(options: IConfirmParams): Promise<void>;
+    /**
+     * 弹出成功提示框
+     *
+     */
+    success(options: IConfirmParams): Promise<void>;
+    /**
+     * 弹出警告提示框
+     *
+     */
+    warning(options: IConfirmParams): Promise<void>;
+    /**
+     * 弹出错误提示框
+     *
+     */
+    error(options: IConfirmParams): Promise<void>;
+}

package/es/interface/open-util/i-drawer-options/i-drawer-options.d.ts

@@ -0,0 +1,298 @@
+import { CSSProperties } from 'vue';
+/**
+ * 模态飘窗配置项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-29 13:03:31
+ * @export
+ * @interface IDrawerOptions
+ */
+export interface IDrawerOptions {
+    /**
+     * 抽屉展开后是否将焦点切换至其 Dom 节点
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:51
+     * @type {boolean}
+     */
+    autofocus?: boolean;
+    /**
+     * 可用于设置 Drawer 内容部分的样式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:26
+     * @type {CSSProperties}
+     */
+    bodyStyle?: CSSProperties;
+    /**
+     * 对话框外层容器的类名
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:57
+     * @type {string}
+     */
+    class?: string;
+    /**
+     * 是否显示左上角的关闭按钮
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:23
+     * @type {boolean}
+     */
+    closable?: boolean;
+    /**
+     * 自定义关闭图标
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:30
+     * @type {*}
+     */
+    closeIcon?: unknown;
+    /**
+     * 可用于设置 Drawer 包裹内容部分的样式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:39
+     * @type {CSSProperties}
+     */
+    contentWrapperStyle?: CSSProperties;
+    /**
+     * 关闭时销毁 Drawer 里的子元素
+     *
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:25
+     * @type {boolean}
+     */
+    destroyOnClose?: boolean;
+    /**
+     * 用于设置 Drawer 弹出层的样式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:52
+     * @type {Object}
+     */
+    drawerStyle?: object;
+    /**
+     * 抽屉右上角的操作区域
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:16
+     * @type {(VNode | slot)}
+     */
+    extra?: unknown;
+    /**
+     * 抽屉的页脚
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:04
+     * @type {(VNode | slot)}
+     */
+    footer?: unknown;
+    /**
+     * 抽屉页脚部件的样式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:23
+     * @type {CSSProperties}
+     */
+    footerStyle?: CSSProperties;
+    /**
+     * 预渲染 Drawer 内元素
+     *
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:10
+     * @type {boolean}
+     */
+    forceRender?: boolean;
+    /**
+     * 指定 Drawer 挂载的 HTML 节点
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:49
+     */
+    getContainer?: HTMLElement;
+    /**
+     * 用于设置 Drawer 头部的样式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:25
+     * @type {CSSProperties}
+     */
+    headerStyle?: CSSProperties;
+    /**
+     * 高度, 在 placement 为 top 或 bottom 时使用
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:40
+     * @type {(string | number)}
+     */
+    height?: string | number;
+    /**
+     * 是否支持键盘 esc 关闭
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:54
+     * @type {boolean}
+     */
+    keyboard?: boolean;
+    /**
+     * 是否展示遮罩
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:17
+     * @type {boolean}
+     */
+    mask?: boolean;
+    /**
+     * 点击蒙层是否允许关闭
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:34
+     * @type {boolean}
+     */
+    maskClosable?: boolean;
+    /**
+     * 遮罩样式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:49
+     * @type {CSSProperties}
+     */
+    maskStyle?: CSSProperties;
+    /**
+     * 抽屉的方向
+     *
+     * @default 'right'
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:05
+     * @type {('top' | 'right' | 'bottom' | 'left')}
+     */
+    placement?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * 用于设置多层 Drawer 的推动行为
+     *
+     * @default { distance: 180 }
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:27
+     * @type {(boolean | { distance: string | number })}
+     */
+    push?: boolean | {
+        distance: string | number;
+    };
+    /**
+     * 预设抽屉宽度（或高度）
+     *
+     * @default 'default'
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:01
+     * @type {('default' | 'large')}
+     */
+    size?: 'default' | 'large';
+    /**
+     * 可用于设置 Drawer 最外层容器的样式，和 drawerStyle 的区别是作用节点包括 mask
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:23
+     * @type {CSSProperties}
+     */
+    style?: CSSProperties;
+    /**
+     * 抽屉的标题
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:32
+     * @type {string}
+     */
+    title?: string;
+    /**
+     * (v-model)	Drawer 是否可见
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:41
+     * @type {boolean}
+     */
+    visible?: boolean;
+    /**
+     * 宽度
+     *
+     * @default 378
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:58
+     * @type {(string | number)}
+     */
+    width?: string | number;
+    /**
+     * 设置 Drawer 的 z-index
+     *
+     * @default 1000
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:21
+     * @type {number}
+     */
+    zIndex?: number;
+    /**
+     * 是否为详情模式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:34
+     * @type {boolean}
+     */
+    isDetail?: boolean;
+    /**
+     * loading 状态
+     *
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:48
+     * @type {boolean}
+     */
+    loading?: boolean;
+    /**
+     * loading 文本
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 13:03:02
+     * @type {string}
+     */
+    loadingText?: string;
+    /**
+     * isDetail=true 状态下是否显示返回按钮
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-03-29 14:03:03
+     * @type {boolean}
+     */
+    showDetailBack?: boolean;
+    /**
+     * 自定义关闭函数，返回true关闭，否则不关闭
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 14:03:42
+     */
+    closeFunc?: () => Promise<boolean>;
+    /**
+     * 是否显示底部
+     *
+     * @author zhanghanrui
+     * @date 2024-03-29 14:03:55
+     * @type {boolean}
+     */
+    showFooter?: boolean;
+    /**
+     * 底部区域高度
+     *
+     * @default 60
+     * @author zhanghanrui
+     * @date 2024-03-29 14:03:22
+     * @type {number}
+     */
+    footerHeight?: number;
+}

package/es/interface/open-util/i-modal/i-modal.d.ts

@@ -32,6 +32,18 @@ export interface IModal {
      * @type {IModalHooks}
      */
     hooks: IModalHooks;
+    /**
+     * 模态界面状态
+     *
+     * @type {{
+     *     okDisabled?: boolean; // 确认按钮是否禁用
+     *     cancelDisabled?: boolean; // 取消按钮是否禁用
+     *   }}
+     */
+    state: {
+        okDisabled?: boolean;
+        cancelDisabled?: boolean;
+    };
     /**
      * 统一关闭入口
      *
@@ -58,8 +70,9 @@ export interface IModal {
      * @author zhanghanrui
      * @date 2024-03-29 11:03:03
      * @param {(() => Promise<IModalData | null>)} ok
+     * @param {(() => Promise<boolean>)} [cancel]
      */
-    callback(ok: () => Promise<IModalData | null>): void;
+    callback(ok: () => Promise<IModalData | null>, cancel?: () => Promise<boolean>): void;
     /**
      * 取消操作
      *

package/es/interface/open-util/i-modal-data/i-modal-data.d.ts

@@ -6,7 +6,7 @@
  * @export
  * @interface IModalData
  */
-export interface IModalData {
+export interface IModalData<T = IData> {
     /**
      * 关闭模态窗时是否操作成功
      *
@@ -26,9 +26,9 @@ export interface IModalData {
      *
      * @author zhanghanrui
      * @date 2024-03-19 20:03:44
-     * @type {IData[]}
+     * @type {T[]}
      */
-    data?: IData[];
+    data?: T[];
     /**
      * 额外参数
      *

package/es/interface/open-util/i-modal-options/i-modal-options.d.ts

@@ -1,3 +1,4 @@
+import { VNode } from 'vue';
 /**
  * 模态打开参数，此为具体端实现，具体扩充参数由各端定义
  *
@@ -6,7 +7,7 @@
  */
 export interface IModalOptions {
     [key: string]: any;
-    title?: string;
+    title?: string | VNode;
     width?: string | number;
     zIndex?: number;
 }

package/es/interface/open-util/i-overlay-controller/i-overlay-controller.d.ts

@@ -2,6 +2,7 @@ import { ComputePositionConfig } from '@floating-ui/dom';
 import { IOverlayContainer } from '../i-overlay-container/i-overlay-container';
 import { IModalOptions } from '../i-modal-options/i-modal-options';
 import { IModalData } from '../i-modal-data/i-modal-data';
+import { IDrawerOptions } from '../i-drawer-options/i-drawer-options';
 import { IPopoverOptions } from '../../i-popover-options/i-popover-options';
 import { IOverlayPopoverContainer } from '../i-overlay-popover-container/i-overlay-popover-container';
 import { IAppFullScreenContainerOptions } from '../i-app-full-screen-container-options/i-app-full-screen-container-options';
@@ -38,6 +39,14 @@ export interface IOverlayController {
      * @return {*}  {IOverlayContainer}
      */
     createModal(component: unknown, props?: IParams, opts?: IModalOptions): IOverlayContainer;
+    /**
+     * 抽屉打开组件
+     */
+    drawer<T = IModalData>(component: unknown, props?: IParams, opts?: IDrawerOptions): Promise<T>;
+    /**
+     * 创建全局抽屉容器
+     */
+    createDrawer(component: unknown, props?: IParams, opts?: IDrawerOptions): IOverlayContainer;
     /**
      * 飘窗打开组件
      *

package/es/interface/open-util/index.d.ts

@@ -1,4 +1,6 @@
+export type { IDrawerOptions } from './i-drawer-options/i-drawer-options';
 export type { IAppFullScreenContainerOptions } from './i-app-full-screen-container-options/i-app-full-screen-container-options';
+export type { IConfirmParams, IConfirmUtil, } from './i-confirm-util/i-confirm-util';
 export type { IMessageParams, IMessageUtil, } from './i-message-util/i-message-util';
 export type { IModal } from './i-modal/i-modal';
 export type { IModalData } from './i-modal-data/i-modal-data';

package/es/locale/auto-register.d.ts

@@ -0,0 +1,2 @@
+/** 注册 core 包的 locale 多语言资源 */
+export declare function registerCoreLocale(): void;

package/es/locale/auto-register.mjs

@@ -0,0 +1,13 @@
+import { model_exports } from "./sys/model.mjs";
+import { sys_exports } from "./sys.mjs";
+//#region src/locale/auto-register.ts
+var localeModules = /* @__PURE__ */ Object.assign({
+	"./sys/model.ts": model_exports,
+	"./sys.ts": sys_exports
+});
+/** 注册 core 包的 locale 多语言资源 */
+function registerCoreLocale() {
+	_gct.i18nUtil.autoRegisterLocale(localeModules);
+}
+//#endregion
+export { registerCoreLocale };