@steedos/objectql 2.2.55-beta.6 → 2.2.55

package/lib/formula/core.d.ts

@@ -1,48 +1,13 @@
 import { SteedosFieldFormulaTypeConfig, SteedosFormulaVarTypeConfig, SteedosFormulaParamTypeConfig, SteedosFormulaOptions, SteedosQuotedByFieldFormulasTypeConfig } from './type';
 import { JsonMap } from "@salesforce/ts-types";
 import { SteedosQueryFilters } from '../types';
-/**
- * 根据公式内容，取出其中{}中的变量
- * @param formula
- */
 export declare const pickFormulaVars: (formula: string) => Array<string>;
-/**
- * 根据公式内容，取出其中{}中的变量，并进一步取出这些变量中引用了当前对象的哪些字段
- * @param fieldFormulaConfig
- */
 export declare const pickFieldFormulaVarFields: (fieldFormulaConfigs: SteedosFieldFormulaTypeConfig | Array<SteedosFieldFormulaTypeConfig> | any) => Array<string>;
-/**
- * 根据公式内容已取出的{}中的变量，进一步取出这些变量中引用了当前对象的哪些字段
- * @param vars
- */
 export declare const pickFormulaVarFields: (vars: Array<SteedosFormulaVarTypeConfig>) => Array<string>;
-/**
- * 根据公式中的变量值，计算出跨对象引用的记录对应的字段值，作为公式运算的参数返回
- * @param doc
- * @param vars
- * return Array<SteedosFormulaParamTypeConfig>
- */
 export declare const computeFormulaParams: (doc: JsonMap, vars: Array<SteedosFormulaVarTypeConfig>, currentUserId: string) => Promise<SteedosFormulaParamTypeConfig[]>;
 export declare const computeFieldFormulaValue: (doc: JsonMap, fieldFormulaConfig: SteedosFieldFormulaTypeConfig, currentUserId: string) => Promise<any>;
 export declare const evalFieldFormula: (formula: string, formulaParams: object) => any;
-/**
- * 运行公式
- * @param formula 公式脚本内容
- * @param params 参数
- * @param options 公式返回类型，及空值配置
- * @param messageTag 用于显示错误日志的标识信息，可以是一个json对象
- */
 export declare const runFormula: (formula: string, params: Array<SteedosFormulaParamTypeConfig>, options?: SteedosFormulaOptions, messageTag?: any) => any;
-/**
- * 在所有字段引用关系（包括跨对象的字段引用关系）中找到引用了当前正在update的对象字段的公式字段并更新其字段值
- * 如果当前不是update而是insert则不需要调用该函数，因为这时这条记录不可能存在引用关系
- * @param objectName
- * @param recordId
- * @param currentUserId
- * @param options.fieldNames 传入该参数时，只查找和处理引用了该对象中这些指定字段的公式字段
- * @param options.escapeConfigs 传入该参数时，将额外跳过这些公式字段配置的运算，提高性能
- * @param options.quotedByConfigs 如果已经根据objectName和fieldNames查过相关配置了，请直接传入，可以避免重复查找，提高性能
- */
 export declare const runQuotedByObjectFieldFormulas: (objectName: string, recordId: string, userSession: any, options?: {
     fieldNames?: Array<string>;
     escapeConfigs?: Array<SteedosFieldFormulaTypeConfig> | Array<string>;
@@ -50,37 +15,9 @@ export declare const runQuotedByObjectFieldFormulas: (objectName: string, record
     onlyForOwn?: boolean;
     withoutCurrent?: boolean;
 }) => Promise<void>;
-/**
- * 找到当前正在insert/update的对象中的公式字段并更新其字段值
- * @param objectName
- * @param recordId
- * @param doc
- * @param currentUserId
- * @param needRefetchDoc 当doc不可信赖时，需要从数据库中重新抓取doc，请传入true值
- * @param configs 如果已经根据objectName查过相关配置了，请直接传入，可以避免重复查找，提高性能
- */
 export declare const runCurrentObjectFieldFormulas: (objectName: string, recordId: string, doc: JsonMap, currentUserId: string, needRefetchDoc?: boolean, configs?: Array<SteedosFieldFormulaTypeConfig>) => Promise<void>;
-/**
- * 找到当前正在update的对象多条记录的公式字段并更新其字段值
- * @param objectName
- * @param filters
- * @param currentUserId
- */
 export declare const runManyCurrentObjectFieldFormulas: (objectName: string, filters: SteedosQueryFilters, currentUserId: string) => Promise<void>;
-/**
- * 修改记录时，根据查到的引用了该记录相关字段公式配置，重新计算字段公式，并把计算结果更新到数据库相关记录中
- * @param objectName 当前修改的记录所属对象名称
- * @param recordId 当前修改的记录ID
- * @param fieldFormulaConfig 查到的引用了该记录所属对象的相关字段公式配置之一
- */
 export declare const updateQuotedByObjectFieldFormulaValue: (objectName: string, recordId: string, fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any, escapeConfigs?: Array<SteedosFieldFormulaTypeConfig> | Array<string>) => Promise<void>;
 export declare const updateDocsFieldFormulaValue: (docs: any, fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any, escapeConfigs?: Array<SteedosFieldFormulaTypeConfig> | Array<string>) => Promise<void>;
 export declare const updateQuotedByDocsForFormulaType: (docs: any, fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any, escapeConfigs?: Array<SteedosFieldFormulaTypeConfig> | Array<string>) => Promise<void>;
-/**
- * 某个对象上的公式字段是否引用了某个对象和字段
- * @param formulaObjectName 公式字段在所在对象名称
- * @param formulaFieldName 公式字段名称
- * @param object_name 是否引用了该对象
- * @param field_name 是否引用了该字段
- */
 export declare const isFormulaFieldQuotingObjectAndFields: (formulaObjectName: string, formulaFieldName: string, objectName: string, fieldNames?: Array<string>) => Promise<boolean>;