@geelato/gl-runtime-core 0.0.1

package/dist/types/actions/JsScriptExecutor.d.ts

@@ -0,0 +1,291 @@
+import { App, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentInternalInstance, VNode, RendererNode, RendererElement } from 'vue';
+import { IAction } from '@geelato/gl-types';
+import { default as PageProvideProxy } from '../components/PageProvideProxy.ts';
+import { Param, Geelato } from '../types/global.ts';
+import { EntityReader, EntitySaver } from '../api/EntityDataSource.ts';
+type OptionsType = {
+    [key: string]: any;
+};
+export declare class Ctx {
+    pageProxy?: PageProvideProxy;
+    [key: string]: any;
+}
+export declare class JsScriptExecutor {
+    app: App | undefined;
+    pageIds: string[];
+    $gl: {};
+    private activePageId;
+    constructor();
+    /**
+     * 设置整个vue的应用信息，一般在组件库插件初始化时调用
+     * @param app
+     */
+    setApp(app: App): void;
+    /**
+     * 设置当前执行页面的代理对象
+     * 一般在执行页面中调用该方法
+     * 支持多页面嵌套场景，每个页面是一个pageProxy，以pageComponentId进行标识区分
+     * @param pageComponentId 组件名为GlPage的组件id
+     * @param pageProxy
+     */
+    addPageProxy(pageComponentId: string, pageProxy: PageProvideProxy): void;
+    getPageProxy(pageComponentId: string): PageProvideProxy | undefined;
+    getPageProxyMapSize(): number;
+    getPageProxyMapKeys(): string[];
+    getPageProxyDebugStats(): {
+        size: number;
+        keys: string[];
+        pageIds: string[];
+        pages: Record<string, any>;
+        activePageId: string;
+    };
+    /**
+     * 设置当前激活的页面（多标签场景下）
+     * 在多标签切换时调用，用于解决组件ID重复时的事件映射问题
+     * @param pageComponentId 组件名为GlPage的组件id
+     */
+    setActivePage(pageComponentId: string): void;
+    /**
+     * 获取当前激活的页面ID
+     * @returns 当前激活页面的pageComponentId
+     */
+    getActivePageId(): string;
+    /**
+     * 清除当前激活的页面
+     * 在页面关闭时调用
+     */
+    clearActivePage(): void;
+    /**
+     * 删除当前执行页面的代理对象
+     * 一般在页面关闭时执行
+     * @param pageComponentId 组件名为GlPage的组件id
+     */
+    removePageProxy(pageComponentId: string): void;
+    /**
+     * 获取组件名称
+     * @param componentId
+     */
+    getComponentName(componentId: string): any;
+    /**
+     * 获取组件的方法
+     * 先从真实的组件中获取方法，获取不到，则从包装的组件GlComponent中获取公共方法
+     * @param componentId
+     * @param methodName
+     */
+    getComponentMethod(componentId: string, methodName: string): any;
+    /**
+     * 设置组件属性
+     * @param componentId
+     * @param props
+     */
+    setComponentProps(componentId: string, props: {
+        [key: string]: any;
+    }): void;
+    /**
+     * 获取组件属性
+     * @param componentId
+     */
+    getComponentProps(componentId: string): any;
+    /**
+     * 获取页面的参数
+     * @param pageComponentId
+     */
+    getParams(pageComponentId: string): Param[] | null;
+    /**
+     * 获取当前页面所有的参数
+     */
+    getPageParams($gl: Geelato): Param[] | null;
+    /**
+     * 获取当前页面的参数
+     * @param paramName
+     * @param $gl
+     */
+    getPageParam(paramName: string, $gl: Geelato): any;
+    /**
+     * 是否存在参数
+     * @param paramName
+     * @param $gl
+     */
+    hasPageParam(paramName: string, $gl: Geelato): boolean;
+    /**
+     * 触发组件的动作事件
+     * @param componentId
+     * @param actionName 动名名（注意，非事件名eventName，一个事件可以触发多个动作）
+     * @param ctx 上下文，用于传递参数，在ctx中不可以传入参数pageProxy
+     * @param callback
+     * @param gl
+     */
+    triggerComponentAction(componentId: string, actionName: string, ctx?: {
+        _triggerParam: any;
+        [key: string]: any;
+    }, callback?: Function, gl?: Geelato): Promise<any> | undefined;
+    /**
+     * 获取组件值
+     * @param componentId
+     */
+    getComponentValue(componentId: string): any;
+    private getVarsConvertFns;
+    private getFeedbackFns;
+    private getOtherFns;
+    private getI18nFns;
+    private getLogicFns;
+    private getComponentFns;
+    /**
+     * 获取组件值
+     * @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;
+    /**
+     * 点击等事件
+     * @param action 组件中的事件配置信息
+     * @param ctx 调用该方法的组件所在的上下文信息，如列表的行信息
+     * @param callback
+     * @param gl 如果多个表达式需要用同一下$gl时，可以传进来，不在本方法内创建
+     */
+    doAction(action: IAction, ctx: Ctx, callback?: Function, gl?: Geelato): Promise<any>;
+    /**
+     * 执行表达式
+     * @param expression 脚本信息，方法体
+     * @param ctx 调用该方法的组件所在的上下文信息，如列表的行信息
+     * @param callback
+     * @param gl 如果多个表达式需要用同一下$gl时，可以传进来，不在本方法内创建
+     * @param errorMessage 错误信息
+     * @param solutionDescription 错误的解决方案描述
+     */
+    evalExpression(expression: string, ctx: Ctx, callback?: Function, gl?: Geelato, errorMessage?: string, solutionDescription?: string): any;
+    /**
+     * 执行函数
+     * @param fnBodyScript 脚本信息，方法体
+     * @param ctx 调用该方法的组件所在的上下文信息，如列表的行信息
+     * @param callback
+     * @param gl 如果多个表达式需要用同一下$gl时，可以传进来，不在本方法内创建
+     * @param async 对于fnBody里有wait的场景，可以设置async为true
+     */
+    evalFn(fnBodyScript: string, ctx: Ctx, callback?: Function, gl?: Geelato, async?: boolean): any;
+    /**
+     * 执行参数，valueExpression值优先，将参数中的valueExpression值表达式计算结果保存到value中
+     * @param params
+     * @param ctx
+     * @param gl 如果多个表达式需要用同一下$gl时，可以传进来，不在本方法内创建
+     */
+    evalParams(params: Array<Param>, ctx: Ctx, gl?: Geelato): Param[];
+    /**
+     * 打开页面模板时，可动态设置模板的属性
+     * @param props 示例如下：
+     *        {
+     *             "label": "订单调账申请流程",
+     *             "procInstId": "1044706817799999999",
+     *             "procDefId": "5044706817716916224",
+     *             "_propsExpressions": {
+     *                 "bizId": "$gl.ctx.record.id"
+     *             }
+     *         }
+     * @param ctx
+     * @param gl
+     * @return Record 输出结果示例：
+     *         {
+     *             "label": "订单调账申请流程",
+     *             "procInstId": "1044706817799999999",
+     *             "procDefId": "5044706817716916224",
+     *             "bizId":"1231968177169162131",
+     *             "_propsExpressions": {
+     *                 "bizId": "$gl.ctx.record.id"
+     *             }
+     *         }
+     */
+    evalProps(props: Record<string, any>, ctx: Ctx, gl?: Geelato): Record<string, any>;
+    /**
+     * 数组参数格式转成对象参数格式
+     * 注意参数名不要重复
+     * @param params
+     */
+    convertParamsToObject(params: Array<Param>): Record<string, any>;
+    /**
+     *
+     * @param items
+     * @param ctx {pageProxy,...} 上下文中需要传输pageProxy
+     * @param gl 如果多个表达式需要用同一下$gl时，可以传进来，不在本方法内创建
+     */
+    evalValueExpressions(items: Array<{
+        value?: any;
+        valueExpression?: string;
+        [key: string]: any;
+    }>, ctx: Ctx, gl?: Geelato): {
+        [key: string]: any;
+        value?: any;
+        valueExpression?: string;
+    }[];
+    /**
+     * 转换选项中的表达式
+     * @param options
+     * @param ctx
+     * @param evalKeys 指定需要转换值的选项keys，如：['title', 'content']
+     * @param gl 如果多个表达式需要用同一下$gl时，可以传进来，不在本方法内创建
+     */
+    evalOptions(options: OptionsType, ctx: Ctx, evalKeys: string[], gl?: Geelato): OptionsType;
+    /**
+     * entityReader 的参数存在变量的情况，需要先进行转换
+     * @param entityReader
+     */
+    convertEntityReader(entityReader: EntityReader, $gl: Geelato): EntityReader;
+    /**
+     * entitySaver 的参数存在变量的情况，需要先进行转换
+     * @param entitySaver
+     * @param $gl
+     */
+    convertEntitySaver(entitySaver: EntitySaver, $gl: Geelato): EntitySaver;
+    /**
+     * 从多个pageProxy中获取ref
+     * 优先从当前激活页面获取（多标签场景下），解决组件ID重复问题
+     * @param componentId
+     */
+    getRef(componentId: string): ComponentInternalInstance | null;
+    /**
+     *  获取组件实例信息
+     *  提供两种组织方式，inst和insts，对于inst,key为组件id，对于insts的key为页面id
+     */
+    getRefs(): {
+        ref: object;
+        refs: object;
+    };
+    /**
+     * 获取组件配置实例信息
+     * 优先从当前激活页面获取（多标签场景下），解决组件ID重复问题
+     * @param componentId
+     */
+    getComponentInst(componentId: string): any;
+    /**
+     *  获取组件实例信息
+     *  提供两种组织方式，inst和insts，对于inst,key为组件id，对于insts的key为页面id
+     */
+    getComponentInsts(): {
+        inst: Record<string, any>;
+        insts: Record<string, any>;
+    };
+    /**
+     * 获取当前环境下，可执行的方法、全局变量
+     *
+     */
+    getGl(pageProxy?: PageProvideProxy): Geelato;
+    /**
+     * 加载页面
+     * @param pageId   页面ID
+     * @param extendId 应用页面树节点ID
+     * @param params
+     * @param pageStatus 页面状态
+     * @param pageTemplateName
+     * @param pageTemplateProps
+     */
+    loadPage(pageId: string, extendId: string, params: Array<Param>, pageStatus?: string, pageTemplateName?: string, pageTemplateProps?: object): VNode<RendererNode, RendererElement, {
+        [key: string]: any;
+    }>;
+    /**
+     *  加载全局注册的组件
+     */
+    loadComponent(componentName: string, props: Record<string, any>): VNode<RendererNode, RendererElement, {
+        [key: string]: any;
+    }>;
+}
+declare const jsScriptExecutor: JsScriptExecutor;
+export default jsScriptExecutor;

package/dist/types/actions/fns/datetime.d.ts

@@ -0,0 +1,22 @@
+export declare const useDateTimeFns: () => {
+    /**
+     * 格式化日期
+     * 没有参数，返回当前格式化时间。
+     * 有效时间，返回格式化后的日期。
+     * 无效时间、无效默认值，返回当前格式化时间。
+     * 无效时间、有效默认值，返回默认值。
+     * @param date 日期
+     * @param format 格式
+     * @param defaultValue 默认值
+     * @returns 格式化后的日期
+     */
+    dateText(date?: Date, format?: string, defaultValue?: string): string;
+    /**
+     * 获取日期范围，默认返回当前日期和当前日期加1天的范围。
+     * @param startDate 开始日期
+     * @param addSeconds 增加的秒数
+     * @param format 格式，默认'YYYY-MM-DD HH:mm:ss'
+     * @returns 格式化后的日期范围
+     */
+    dateBetween(startDate?: Date, addSeconds?: number, format?: string): string[];
+};

package/dist/types/actions/fns/device.d.ts

@@ -0,0 +1,23 @@
+import { Geelato } from '../../types/global';
+type ScanBarCodeResult = {
+    text: string | null;
+    result: unknown | null;
+    status: 'cancelled' | 'success';
+};
+type ScanBarCodeOptions = {
+    title?: string;
+    multiple?: boolean;
+    separator?: string;
+    scanKinds?: Array<'qr' | 'barcode'>;
+    barcodeFormats?: string[];
+    onSuccess?: (text: string, result: unknown) => void;
+    onScan?: (text: string, result: unknown, meta: {
+        duplicated: boolean;
+        index: number;
+    }) => void;
+    onComplete?: (text: string, result: unknown) => void;
+};
+export declare const useDeviceFns: ($gl: Geelato) => {
+    scanBarCode: (options?: ScanBarCodeOptions) => Promise<ScanBarCodeResult>;
+};
+export {};

package/dist/types/actions/fns/math.d.ts

@@ -0,0 +1,27 @@
+import { default as Big, BigSource } from 'big.js';
+export declare const useMathFns: () => {
+    newBig(value: BigSource): Big.Big;
+    plus(value1: BigSource, value2: BigSource): Big.Big;
+    minus(value1: BigSource, value2: BigSource): Big.Big;
+    times(value1: BigSource, value2: BigSource): Big.Big;
+    div(value1: BigSource, value2: BigSource): Big.Big;
+    abs(value: BigSource): Big.Big;
+    eq(value1: BigSource, value2: BigSource): boolean;
+    gt(value1: BigSource, value2: BigSource): boolean;
+    gte(value1: BigSource, value2: BigSource): boolean;
+    lt(value1: BigSource, value2: BigSource): boolean;
+    lte(value1: BigSource, value2: BigSource): boolean;
+    mod(value: BigSource, value2: BigSource): Big.Big;
+    neg(value: BigSource): Big.Big;
+    pow(value: BigSource, value2: number): Big.Big;
+    prec(sd: number, rm: number): Big.Big;
+    round(dp: number, rm: number): Big.Big;
+    sqrt(value: BigSource): Big.Big;
+    toExponential(dp: number, rm: number): string;
+    toFixed(dp: number, rm: number): string;
+    toFixedAsNumber(dp: number, rm: number): number;
+    toPrecision(sd: number, rm: number): string;
+    toNumber(value: BigSource): number;
+    toString(value: BigSource): string;
+    valueOf(value: BigSource): string;
+};

package/dist/types/api/EntityApi.d.ts

@@ -0,0 +1,143 @@
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse, AxiosStatic } from 'axios';
+import { EntityReader, EntitySaver, EntityDeleter } from './EntityDataSource.ts';
+import { MqlObject, EntityFullMetadata } from './EntityTypes';
+import { Geelato, ApiResult } from '../types/global.ts';
+export declare class EntityApi {
+    private readonly url;
+    private service;
+    private readonly VITE_API_BASE_URL;
+    private options?;
+    private queryService;
+    private saveService;
+    private deleteService;
+    private utilService;
+    constructor();
+    getAuthorization(): string | undefined;
+    setup(axios: AxiosStatic | AxiosInstance): void;
+    getAxios(): AxiosStatic | AxiosInstance;
+    queryByMql(mql: MqlObject | Array<MqlObject>, withMeta?: boolean, disabledClientQueryCache?: boolean, bizCode?: string): Promise<any>;
+    /**
+     * 对entityReader.params中的表达式进行求值
+     * 直接将修改后的值赋值给entityReader.params
+     * @param entityReader
+     */
+    parseEntityReaderParams(entityReader: EntityReader, ctx: Record<string, any>, gl?: Geelato): void;
+    /**
+     * 将entityReader转换为MqlObject
+     * !! 注意：转换后的MqlObject中，params中的表达式未被求值，若需转换参数表达式的值，需要先调用evalEntityReaderParams方法
+     * @param entityReader
+     */
+    convertEntityReaderToMql(entityReader: EntityReader): MqlObject;
+    queryById(entityName: string, id: string, fieldNames: string, withMeta?: boolean, disabledClientQueryCache?: boolean, bizCode?: string): Promise<any>;
+    queryByEntityReader(entityReader: EntityReader, disabledClientQueryCache?: boolean, bizCode?: string): Promise<any>;
+    queryOneByEntityReader(entityReader: EntityReader, disabledClientQueryCache?: boolean, bizCode?: string): Promise<any>;
+    getFirstRecordFromRes(res: any): any;
+    getRecordsFromRes(res: any): any;
+    query(entityName: string, fieldNames: string, params: Record<string, any>, withMeta?: boolean, disabledClientQueryCache?: boolean, bizCode?: string, order?: string): Promise<any>;
+    queryBatch(queryParamArray: Array<object>, withMeta: boolean): Promise<any>;
+    saveEntity(entitySaver: EntitySaver, biz?: string): Promise<AxiosResponse<any, any>>;
+    saveBatchEntity(entitySavers: EntitySaver[], biz?: string): Promise<AxiosResponse<any, any>>;
+    save(entityName: string, keyValues: object, biz?: string, successMsg?: string, errorMsg?: string): Promise<AxiosResponse<any, any>>;
+    saveByMql(biz: string, mql: MqlObject | Array<MqlObject>): Promise<AxiosResponse<any, any>>;
+    saveBatch(entityName: string, records: Array<Record<string, any>>, biz?: string): Promise<AxiosResponse<any, any>>;
+    delete(entityName: string, keyValues: object, biz?: string): Promise<ApiResult>;
+    deleteById(entityName: string, id: string, biz?: string): Promise<ApiResult>;
+    deleteByIds(entityName: string, ids: string[], biz?: string): Promise<ApiResult>;
+    deleteBatch(items: Array<{
+        entityName: string;
+        keyValues: object;
+    }>, biz?: string): Promise<ApiResult[]>;
+    deleteByDeleter(entityDeleter: EntityDeleter, biz?: string): Promise<ApiResult>;
+    deleteBatchDeleter(entityDeleters: EntityDeleter[], biz?: string): Promise<ApiResult[]>;
+    entityDataMappingHandler(data: Record<string, any>, dataMapping?: Record<string, any>): Record<string, any>;
+    queryMeta(entityName: string): Promise<AxiosResponse<any, any>>;
+    queryEntityNames(): Promise<AxiosResponse<any, any>>;
+    queryMetaFullDefined(entityName: string): Promise<AxiosResponse<ApiResult<EntityFullMetadata>>>;
+    queryEntityLiteMetas(appCode?: string): Promise<AxiosResponse<any, any>>;
+    removeCache(keys: string): Promise<AxiosResponse<any, any>> | undefined;
+    checkFieldUniqueness(entityName: string, filedName: string, fieldValue: any, id?: string): Promise<AxiosResponse<any, any>>;
+    executeSqlKey(sqlKey: string, connectId: string, params: Record<string, any>): Promise<AxiosResponse<any, any>>;
+    /**
+     * 用于运行时，返回不带源码的数据
+     * 带个性化页面配置信息、权限信息
+     * @param idType
+     * @param id
+     */
+    queryPageAndCustomById(idType: 'pageId' | 'extendId', id: string): Promise<AxiosResponse<any, any>>;
+    /**
+    * 用于运行时，返回不带源码的数据
+    * 带个性化页面配置信息、权限信息
+    * @param idType
+    * @param id
+    */
+    queryPageCustomById(idType: 'pageId' | 'extendId', id: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * 用于运行时，返回带语言的页面数据
+     * @param idType
+     * @param id
+     */
+    queryPageLangById(idType: 'pageId' | 'extendId', id: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * 查询当前租户所有的字典
+     * @param allStatus 是否查询全部状态，默认为false，即只查询启用状态的字典
+     */
+    queryAllDict(allStatus?: boolean): Promise<any>;
+    /**
+     *  查询某dictId下的字典项
+     * @param dictId 字典ID
+     * @param allStatus 查询全部状态，默认为false，即只查询启用状态的字典项
+     */
+    queryDictItems(dictId: string, allStatus?: boolean): Promise<any>;
+    /**
+     *  查询多个dictId下的字典项
+     * @param dictIds
+     * @param allStatus 查询全部状态，默认为false，即只查询启用状态的字典项
+     */
+    queryMultiDictItems(dictIds: string[], allStatus?: boolean): Promise<any>;
+    /**
+     *  查询字典项
+     * @param dictId 字典ID
+     * @param dictItemCode 字典项编码
+     */
+    queryDictItem(dictId: string, dictItemCode: string): Promise<any>;
+    /**
+     * 用于设计时，返回带有源码的数据
+     * 不带个性化页面配置信息、权限信息
+     * @param extendId
+     */
+    queryPageByExtendId(extendId: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * 用于设计时，返回带有源码的数据
+     * 不带个性化页面配置信息、权限信息
+     * @param pageId
+     */
+    queryPageById(pageId: string): Promise<AxiosResponse<any, any>>;
+    getService(): AxiosStatic | AxiosInstance;
+    getHeader(): Record<string, string>;
+    /**
+     * 解析URL
+     * 1. 如果url以http或https开头，直接返回
+     * 2. 否则，将url拼接到api基地址后，处理多余的斜杠
+     * @param url
+     */
+    resolveUrl(url: string): string;
+    /**
+     * 变更实体所有者
+     * 当前这条记录的所有者有这个变更权限，还有管理员有这个变更权限
+     * 例：
+     * changeOwner('1234567890123456789', {
+     *   'platform_dict': ['dict1', 'dict2'],
+     *   'platform_dict_item': ['item1', 'item2']
+     * })
+     * @param owner 新的所有者
+     * @param entityIdsMap 实体ID映射表，key为实体类型，value为实体ID数组
+     * @param config Axios请求配置
+     * @returns
+     */
+    changeOwner(owner: string, entityIdsMap: Record<string, Array<string>>, config?: AxiosRequestConfig): Promise<ApiResult>;
+    post<T = any, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<ApiResult>;
+    get<T = any, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<ApiResult>;
+}
+declare const entityApi: EntityApi;
+export { entityApi };
+export default EntityApi;