@geelato/gl-runtime-core 0.0.1

package/dist/types/components/AppProvideProxy.d.ts

@@ -0,0 +1,21 @@
+import { default as PageProvideProxy } from './PageProvideProxy';
+export declare const AppProvideKey = "AppProvideKey";
+export default class AppProvideProxy {
+    appId: string;
+    pageProvideProxyMap: {
+        [key: string]: PageProvideProxy | null;
+    };
+    constructor();
+    /**
+     * 页面内子组件引用
+     * @param pageComponentId
+     * @param vueInst vue实组件实例
+     */
+    addPageProvideProxy(pageComponentId: string, pageProvideProxy: PageProvideProxy | null): void;
+    removePageProvideProxy(pageComponentId: string): void;
+    /**
+     * 基于组件获取页面内的vue组件实例
+     * @param pageComponentId
+     */
+    getPageProvideProxy(pageComponentId: string): PageProvideProxy | null;
+}

package/dist/types/components/ComponentTreeParser.d.ts

@@ -0,0 +1,17 @@
+import { IComponentInstance } from '@geelato/gl-types';
+/**
+ *  不计入需统计已加载完成的组件
+ */
+export declare const ignoreComponents: string[];
+/**
+ * 提取树形结构中所有组件的ids，形成列表
+ * 深度优先遍历，先遍历子节点，后遍历父节点，同级节点倒序遍历
+ * 生成的示例数据：['1.2', '1.1.2', '1.1.1.2', '1.1.1.1', '1.1.1', '1.1', '1']
+ * @param tree
+ */
+export declare const extractTreeIds: (tree: IComponentInstance) => {
+    allIds: string[];
+    normalIds: string[];
+    unRenderedIds: string[];
+    innerIds: string[];
+};

package/dist/types/components/FormProvideProxy.d.ts

@@ -0,0 +1,35 @@
+import { Ref } from 'vue';
+export type FormParamType = {
+    pName: string;
+    pValue: any;
+    pType: string;
+};
+export declare const FormProvideKey = "FormProvideKey";
+export declare const FormProvideKeyNotBlockForm = "FormProvideKeyNotBlockForm";
+export default class FormProvideProxy {
+    id: string;
+    entityName: string;
+    state: Ref<{
+        [key: string]: any;
+    }, {
+        [key: string]: any;
+    }>;
+    recordId: Ref<string, string>;
+    setRecordId(id: string): void;
+    getRecordIdRef(): Ref<string, string>;
+    getRecordId(): string;
+    /**
+     * 设置整个表单的值
+     * @param formValues
+     */
+    setValues(formValues: any): void;
+    setFieldValue(fieldName: string, value: any): void;
+    getFieldValue(fieldName: string): any;
+    destroy(): void;
+}
+export declare class SubmitFormResult {
+    id: string;
+    entity: string;
+    record: Record<string, any>;
+    success: boolean;
+}

package/dist/types/components/Hooks.d.ts

@@ -0,0 +1,7 @@
+import { IComponentInstance } from '@geelato/gl-types';
+/**
+ *  检查作为表单项的组件是否显示标题
+ *  如组件放在layout等容器组件时，需要进行是否展示formItem的检查
+ *  @return true:表示显示，false：表示不显示
+ */
+export declare const useCheckShowFormItemLabel: (inst: IComponentInstance) => boolean;

package/dist/types/components/PageDataSourceManager.d.ts

@@ -0,0 +1,28 @@
+import { Ref } from 'vue';
+import { EntityReader } from '../api/EntityDataSource';
+export type DataSourceStatus = 'idle' | 'loading' | 'loaded' | 'error';
+export interface PageDataSource<T = any> {
+    key: string;
+    data: T[];
+    status: DataSourceStatus;
+    meta?: Record<string, any>;
+    error?: any;
+}
+export interface EntityReaderDataSourceOptions<T = any> {
+    reader?: EntityReader;
+    meta?: Record<string, any>;
+    disabledClientQueryCache?: boolean;
+    bizCode?: string;
+}
+export declare class PageDataSourceManager {
+    private refs;
+    ensureRef(key: string): Ref<PageDataSource<any>, PageDataSource<any>>;
+    getRef<T = any>(key: string): Ref<PageDataSource<T>> | undefined;
+    setLoading(key: string, meta?: Record<string, any>): void;
+    setLoaded<T = any>(key: string, data?: T[], meta?: Record<string, any>): void;
+    setError(key: string, error: any): void;
+    setEntityReaderDataSource<T = any>(key: string, options: EntityReaderDataSourceOptions<T>): Promise<Ref<PageDataSource<T>>>;
+    setStaticDataSource<T = any>(key: string, staticData?: T[], meta?: Record<string, any>): Promise<Ref<PageDataSource<T>>>;
+    destroy(): void;
+}
+export default PageDataSourceManager;

package/dist/types/components/PageLoader.d.ts

@@ -0,0 +1,6 @@
+import { PageConfig } from '../types/global';
+/**
+ * 加载页面，可作为drawer或modal的content
+ * @param pageConfig
+ */
+export declare const loadPageContent: (pageConfig: PageConfig) => any;

package/dist/types/components/PageProvideProxy.d.ts

@@ -0,0 +1,413 @@
+import { Ref, ComponentInternalInstance, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions } from 'vue';
+import { InstPermission, Param, ParamMeta } from '../types/global';
+import { PageStatus } from '../types/options';
+import { IComponentInstance, IInnerComponentPosition } from '@geelato/gl-types';
+import { PageDataSource, EntityReaderDataSourceOptions } from './PageDataSourceManager';
+import { default as FormProvideProxy } from './FormProvideProxy';
+export type PageParamConfigType = {
+    pName: string;
+    pValue: any;
+    pType: string;
+};
+export interface PageCustomType {
+    id: string;
+    pageId: string;
+    cfg: Record<string, any>;
+}
+/**
+ *  页面模板数据对象
+ */
+export interface IPageTemplate {
+    type: string;
+    addEventListener: Function;
+    removeEventListener: Function;
+    dispatchEvent: Function;
+    [key: string]: any;
+}
+/**
+ *  页面模板的默认实现
+ */
+export declare class PageTemplate implements IPageTemplate {
+    private _eventListeners;
+    type: string;
+    constructor(type?: string);
+    /**
+     * 添加事件监听器，由模板组件内的嵌套组件调用，如表单组件
+     * @param eventType
+     * @param callback
+     */
+    addEventListener(eventType: string, callback: Function): void;
+    /**
+     * 删除事件监听器
+     * @param eventType
+     * @param callback
+     */
+    removeEventListener(eventType: string, callback: Function): void;
+    /**
+     * 触发事件，由模板组件或模板嵌套的组件调用
+     * 实现模板与嵌套组件之间的通讯
+     * @param eventType
+     * @param args
+     */
+    dispatchEvent(eventType: string, ...args: any[]): void;
+}
+/**
+ *  基于状态机的工作流状态转换对象
+ */
+export declare class StateWorkflowTransfer {
+    id: string;
+    name: string;
+    procDefId: string;
+    appId: string;
+    srcStateId: string;
+    targetStateId: string;
+    isReject: boolean | null;
+    tranCondition: null;
+    remark: null;
+}
+/**
+ *  如作为工作流模板时，用于注入到表单等组件中，如可在提交表单时，表单获取到该template对象，清楚下一步是审批通过还是审批不通过
+ */
+export declare class WorkflowPageTemplate extends PageTemplate {
+    constructor(type?: string);
+    onBeforeSubmit?: Function;
+    isReject?: boolean;
+    selectedTran?: StateWorkflowTransfer;
+    remark?: string;
+    attachIds?: string;
+}
+export declare const isImplementsWorkflowPageTemplate: (obj: any) => boolean;
+/**
+ * 页面权限管理
+ */
+export declare class PagePermission {
+    perms: InstPermission[];
+    setPermissions(perms: InstPermission[]): void;
+    /**
+     * 是否有查看权限
+     * @param instId 组件实例id
+     */
+    hasReadPermission(instId: string): boolean;
+    /**
+     * 是否有编辑权限
+     * @param instId 组件实例id
+     */
+    hasWritePermission(instId: string): boolean;
+}
+/**
+ * 记录哪些组件使用了内置
+ */
+export declare const innerComponents: Record<string, IInnerComponentPosition[]>;
+export declare function addInnerComponentPosition(componentName: string, positions: IInnerComponentPosition[]): void;
+export declare const PageProvideKey = "PageProvideKey";
+export declare const PageParamsKey = "PageParamsKey";
+export declare const PageProvideKeyNotBlockPage = "PageProvideKeyNotBlockPage";
+/**
+ * 参数据对象序列化，形成代码块
+ * @param params
+ */
+export declare const paramStringify: (params: Array<PageParamConfigType>) => string;
+declare enum PageRenderStatus {
+    none = 0,
+    mounted = 2
+}
+/**
+ * 页面组件中注入的对象
+ * TODO 每个组件有哪些内置组件id，在卸载组件时，需同步卸载其内置组件
+ */
+export default class PageProvideProxy {
+    id: string;
+    pageId: string;
+    pageStatus: PageStatus;
+    pageHeight: string;
+    pageHeightRef: Ref<string>;
+    pageCustom?: PageCustomType;
+    pagePermission?: PagePermission;
+    pageTemplateName?: string;
+    pageTemplate: IPageTemplate;
+    pageInst: IComponentInstance;
+    pageVueInst: ComponentInternalInstance | null;
+    pageParams: Array<Param>;
+    pageParamsMeta: Array<ParamMeta>;
+    pageCtx: object;
+    vueRefMap: {
+        [key: string]: ComponentInternalInstance | null;
+    };
+    componentInstMap: {
+        [key: string]: IComponentInstance;
+    };
+    formProxyMap: {
+        [key: string]: FormProvideProxy;
+    };
+    pageRenderStatus: PageRenderStatus;
+    pageMountedEvents: Function[];
+    componentMountedEventMap: {
+        [key: string]: Function[];
+    };
+    normalIdList: string[];
+    normalIdMap: {
+        [key: string]: boolean;
+    };
+    allIds: string[];
+    unRenderedIdMap: {
+        [key: string]: boolean;
+    };
+    innerIds: string[];
+    innerIdMap: {
+        [key: string]: boolean;
+    };
+    mountedNormalIdMap: {
+        [key: string]: boolean;
+    };
+    mountedInnerIdMap: {
+        [key: string]: boolean;
+    };
+    mountedAndExecutedFnIdMap: {
+        [key: string]: boolean;
+    };
+    private _eventListeners;
+    /**
+     * 页面级数据源管理器
+     */
+    private _dataSourceManager;
+    constructor(pageInst: IComponentInstance, pageVueInst: ComponentInternalInstance);
+    /**
+     * 添加事件监听器，由模板组件内的嵌套组件调用，如表单组件
+     * @param eventType
+     * @param callback
+     */
+    addEventListener(eventType: string, callback: Function): void;
+    /**
+     * 删除事件监听器
+     * @param eventType
+     * @param callback
+     */
+    removeEventListener(eventType: string, callback: Function): void;
+    /**
+     * 触发事件，由模板组件或模板嵌套的组件调用
+     * 实现模板与嵌套组件之间的通讯
+     * @param eventType
+     * @param args
+     */
+    dispatchEvent(eventType: string, ...args: any[]): void;
+    addPageMountedEvent(fn: Function): void;
+    removePageMountedEvent(): void;
+    /**
+     * 添加组件mounted时，执行的事件
+     * 每个组件只添加一次，重复添加将把最新的覆盖旧的
+     * @param componentId
+     * @param fns 要执行的函数列表
+     */
+    setComponentMountedEvent(componentId: string, fns: Function[]): void;
+    /**
+     * 移除组件mounted时，执行的事件
+     * @param componentId 按组件id移除
+     */
+    removeComponentMountedEvent(componentId: string): void;
+    /**
+     * 页面内子组件引用（在组件mounted之后执行）
+     * 同时计算有多少组件还未mounted，记录在unMountedIds
+     *
+     * 注意！！！
+     * 本方法可在gl-component的setup先执行一次，再在onMounted再执行一次
+     * 第一次执行是为了确保基础组件的VueRef都已创建，便于后续的组件在事件中引用前端创建的组件
+     * 第二次在onMounted中再执行一次，是为了确保像table这类复合的组件在create时，vueRef的refs为{}，无实际的组件实例，需要onMounted时才产生
+     * @param componentId
+     * @param vueRef vue实组件实例，这里的vueRef为GlComponent动态组件实例，需再进一步通过refs[componentId]获取最终的实例
+     */
+    setVueRef(componentId: string, vueRef: ComponentInternalInstance | null): void;
+    /**
+     * 尝试触发组件的onMounted事件
+     * 只有在检测到该页面的所有组件都已onMounted时，才触发页面onMounted事件
+     * 加载检查是否完成时，不包括组件内部的组件加载事项
+     * 加载检查
+     * @param componentId
+     * @param vueRef
+     */
+    tryTriggerMounted(componentInst: IComponentInstance, vueRef: ComponentInternalInstance | null): void;
+    /**
+     * 移除页面内的vue组件实例时，清除相应的数据
+     * GlComponent的onBeforeUnmount事件中执行
+     * @param componentId
+     */
+    removeVueInst(componentId: string): void;
+    /**
+     * 基于组件获取页面内的vue组件实例
+     * @param componentId
+     */
+    getRef(componentId: string): ComponentInternalInstance | null;
+    /**
+     *  基于组件获取页面内的vue组件实例
+     */
+    getRefs(): {
+        [key: string]: ComponentInternalInstance | null;
+    };
+    /**
+     *  获取当前页面在下所有的组件配置实例
+     */
+    getInsts(): {
+        [key: string]: IComponentInstance;
+    };
+    getDebugStats(): {
+        id: string;
+        pageId: string;
+        pageStatus: PageStatus;
+        pageRenderStatus: PageRenderStatus;
+        vueRefCount: number;
+        componentInstCount: number;
+        formProxyCount: number;
+        pageMountedEventCount: number;
+        componentMountedEventCount: number;
+        mountedNormalCount: number;
+        mountedInnerCount: number;
+        unRenderedCount: number;
+        allIdCount: number;
+        normalIdCount: number;
+        innerIdCount: number;
+        eventListenerTypeCount: number;
+        eventListenerCount: number;
+    };
+    /**
+     * 检查参数格式，看是否需要进行转换
+     * @param params
+     */
+    isParamNeedConvert(params: Array<PageParamConfigType | Param>): boolean;
+    paramStringify: (params: Array<PageParamConfigType>) => string;
+    /**
+     * 设置页面参数定义
+     * @param paramsMeta
+     */
+    setParamsMeta(paramsMeta: Array<ParamMeta>): void;
+    setPateTemplateName(pageTemplateName?: string): void;
+    setPateTemplate(pageTemplate: IPageTemplate): void;
+    getPageTemplate(): IPageTemplate;
+    /**
+     *  获取页面参数定义
+     */
+    getParamsMeta(): Array<ParamMeta>;
+    /**
+     * 设置页面参数，这里设置的是已完成解析的，键值对，不是参数配置信息
+     * @param params
+     */
+    setParams(params: Array<Param>): void;
+    /**
+     *  在动作面板中配置的页面参数，如recordId
+     */
+    getParams(): Array<Param>;
+    /**
+     *  获取页面参数中，带有开头信息的参数，形成参数数组
+     *  如：prefix为form时，取的是form.xxx的参数，并形成一个对象返回
+     */
+    getParamsByPrefixAsArray(prefix: string): {
+        [key: string]: any;
+    }[];
+    /**
+     *  获取页面参数中，带有开头信息的参数，形成参数对象
+     *  如：prefix为form时，取的是form.xxx的参数，并形成一个对象返回
+     */
+    getParamsByPrefixAsObject(prefix: string): {
+        [key: string]: any;
+    };
+    /**
+     *  获取在动作面板中配置的页面参数值
+     */
+    getParamValue(paramName: string): any;
+    /**
+     * 是否存在参数
+     * @param paramName
+     */
+    hasPageParam(paramName: string): boolean;
+    /**
+     * 设置组件值glComponentInst.value
+     * @param componentId
+     * @param value
+     */
+    setComponentValue(componentId: string, value: any): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null | undefined;
+    /**
+     * 获取组件实例信息glComponentInst
+     * @param componentId
+     */
+    getComponentInst(componentId: string): any;
+    /**
+     * 获取组件值glComponentInst.value
+     * @param componentId
+     */
+    getComponentValue(componentId: string): any;
+    /**
+     * 设置组件GlComponent的属性，即glComponentInst.props
+     * @param componentId
+     * @param props 按一个个的属性值进行设置
+     */
+    setComponentProps(componentId: string, props: {
+        [key: string]: any;
+    }): any;
+    /**
+     * 获取组件属性
+     * @param componentId
+     */
+    getComponentProps(componentId: string): any;
+    /**
+     * 获取vue组件实例对外开放的方法
+     * @param componentId
+     * @param methodName
+     */
+    getMethod(componentId: string, methodName: string): Function | null;
+    setPageStatus(pageStatus: PageStatus): void;
+    setPageCustom(pageCustom?: PageCustomType): void;
+    getPageCustom(): PageCustomType | undefined;
+    setPageHeight(pageHeight: string): void;
+    getPageHeight(): string;
+    getPageHeightRef(): Ref<string, string>;
+    setPagePermission(pagePermission?: PagePermission): void;
+    getPagePermission(): PagePermission | undefined;
+    /**
+     * 获取数据源的响应式引用
+     */
+    getDataSourceRef<T = any>(key: string): Ref<PageDataSource<T>> | undefined;
+    /**
+     * 获取数据源的当前值
+     */
+    getDataSource<T = any>(key: string): PageDataSource<T> | undefined;
+    /**
+     * 通过 EntityReader 加载数据源
+     */
+    setEntityReaderDataSource<T = any>(key: string, options: EntityReaderDataSourceOptions<T>): Promise<Ref<PageDataSource<T>, PageDataSource<T>>>;
+    /**
+     * 设置静态数据源
+     */
+    setStaticDataSource<T = any>(key: string, staticData?: T[], meta?: Record<string, any>): Promise<Ref<PageDataSource<T>, PageDataSource<T>>>;
+    isPageStatusRead(): boolean;
+    isPageStatusCreate(): boolean;
+    isPageStatusCopyCreate(): boolean;
+    isPageStatusCreateOrCopyCreate(): boolean;
+    isPageStatusUpdate(): boolean;
+    isPageStatusCreateOrUpdate(): boolean;
+    /**
+     *
+     * @param formComponentId
+     * @param formProvideProxy
+     */
+    setFormProxy(formComponentId: string, formProvideProxy: FormProvideProxy): void;
+    /**
+     * 获取表单代理
+     * @param formComponentId
+     */
+    getFormProxy(formComponentId: string): FormProvideProxy | undefined;
+    /**
+     * 获取表单字段值
+     * @param formComponentId 表单组件Id
+     * @param fieldName
+     */
+    getFieldValue(formComponentId: string, fieldName: string): any | undefined;
+    /**
+     * 通过实体名称获取表单字段值，注意如果有多
+     * @param entityName 实体名称
+     * @param fieldName 字段名称
+     */
+    getFieldValueByEntityName(entityName: string, fieldName: string): any | undefined;
+    /**
+     *  在销毁之前调用
+     */
+    destroy(): void;
+}
+export {};

package/dist/types/components/UiEventNames.d.ts

@@ -0,0 +1,15 @@
+declare const UiEventNames: {
+    Base: {
+        SelectComponent: string;
+    };
+    EntityForm: {
+        createdEntitySavers: string;
+        onSubmitted: string;
+        changedFormData: string;
+    };
+    StateWorkFlow: {
+        selectSwfTransfer: string;
+        getSwfTitle: string;
+    };
+};
+export default UiEventNames;

package/dist/types/components/gl-chart/GlChart.vue.d.ts

@@ -0,0 +1,135 @@
+import { PropType, DefineComponent, ExtractPropTypes, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { EntityReader } from '../../api/EntityDataSource.ts';
+import { IComponentInstance } from '@geelato/gl-types';
+import { ComponentInstance } from '@geelato/gl-ui-schema';
+import { PageCustomType, PagePermission } from '../PageProvideProxy.ts';
+declare const _default: DefineComponent<ExtractPropTypes<{
+    parentId: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    glComponentInst: {
+        type: PropType< IComponentInstance>;
+        default(): ComponentInstance;
+    };
+    glChildren: {
+        type: PropType<Array< IComponentInstance>>;
+        default(): never[];
+    };
+    glCtx: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    glIsRuntime: {
+        type: BooleanConstructor;
+        default(): boolean;
+    };
+    glRuntimeFlag: {
+        type: StringConstructor;
+        default(): string;
+    };
+    glIndex: {
+        type: NumberConstructor;
+    };
+    glLoopItem: ObjectConstructor;
+    glLoopIndex: NumberConstructor;
+    glIgnoreInjectPageProxy: {
+        type: BooleanConstructor;
+        default(): boolean;
+    };
+    componentStoreId: {
+        type: StringConstructor;
+        default(): string;
+    };
+    pageCustom: PropType< PageCustomType>;
+    pagePermission: PropType< PagePermission>;
+    glDoAction: {
+        type: FunctionConstructor;
+        required: boolean;
+    };
+    type: {
+        type: StringConstructor;
+        default(): string;
+    };
+    label: StringConstructor;
+    hideLabel: BooleanConstructor;
+    subText: StringConstructor;
+    titleProps: ObjectConstructor;
+    legend: ObjectConstructor;
+    entityReader: {
+        type: PropType<EntityReader>;
+        required: true;
+    };
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    "update:modelValue": (...args: any[]) => void;
+}, string, PublicProps, Readonly< ExtractPropTypes<{
+    parentId: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    glComponentInst: {
+        type: PropType< IComponentInstance>;
+        default(): ComponentInstance;
+    };
+    glChildren: {
+        type: PropType<Array< IComponentInstance>>;
+        default(): never[];
+    };
+    glCtx: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    glIsRuntime: {
+        type: BooleanConstructor;
+        default(): boolean;
+    };
+    glRuntimeFlag: {
+        type: StringConstructor;
+        default(): string;
+    };
+    glIndex: {
+        type: NumberConstructor;
+    };
+    glLoopItem: ObjectConstructor;
+    glLoopIndex: NumberConstructor;
+    glIgnoreInjectPageProxy: {
+        type: BooleanConstructor;
+        default(): boolean;
+    };
+    componentStoreId: {
+        type: StringConstructor;
+        default(): string;
+    };
+    pageCustom: PropType< PageCustomType>;
+    pagePermission: PropType< PagePermission>;
+    glDoAction: {
+        type: FunctionConstructor;
+        required: boolean;
+    };
+    type: {
+        type: StringConstructor;
+        default(): string;
+    };
+    label: StringConstructor;
+    hideLabel: BooleanConstructor;
+    subText: StringConstructor;
+    titleProps: ObjectConstructor;
+    legend: ObjectConstructor;
+    entityReader: {
+        type: PropType<EntityReader>;
+        required: true;
+    };
+}>> & Readonly<{
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}>, {
+    type: string;
+    glComponentInst: IComponentInstance;
+    glChildren: IComponentInstance[];
+    glCtx: Record<string, any>;
+    glIsRuntime: boolean;
+    glRuntimeFlag: string;
+    glIgnoreInjectPageProxy: boolean;
+    componentStoreId: string;
+    hideLabel: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {
+    glChart: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;