@steedos/objectql 2.2.50 → 2.2.51-beta.4

package/src/formula/index.ts

@@ -1,81 +0,0 @@
-import { SteedosObjectTypeConfig, getObjectConfig, getSteedosSchema } from '../types';
-import { SteedosFormulaOptions } from './type';
-import { computeFormulaParams, pickFormulaVarFields, runFormula } from './core';
-import { isCurrentUserIdRequiredForFormulaVars } from './util';
-import { JsonMap } from "@salesforce/ts-types";
-
-export * from './type'
-export * from './util'
-export * from './field_formula'
-export * from './core'
-// export * from './triggers'
-export * from './recompute'
-/**
- * 根据公式内容，取出其中{}中的变量，返回计算后的公式引用集合
- * @param formula 
- * @param fieldConfig 
- * @param objectConfigs 
- */
-const computeFormulaVarsAndQuotes = async (formula: string, objectConfig: SteedosObjectTypeConfig) => {
-    return await getSteedosSchema().metadataBroker.call(`objects.getFormulaVarsAndQuotes`, {formula, objectConfig})
-}
-
-export async function checkFormula(formula: string, mainObjectName: string){
-
-    const mainObjectConfig = getObjectConfig(mainObjectName);
-
-    await computeFormulaVarsAndQuotes(formula, mainObjectConfig);
-}
-
-async function _computeFormula(formula: string, objectName:string, record: JsonMap, currentUserId: string, spaceId: string, options?: SteedosFormulaOptions)
-async function _computeFormula(formula: string, objectName:string, recordId: string, currentUserId: string, spaceId: string, options?: SteedosFormulaOptions)
-async function _computeFormula(formula: string, objectName:string, data: any, currentUserId: string, spaceId: string, options?: SteedosFormulaOptions) {
-    // 允许参数objectName为空，此时formula应该最多只引用了$user变量，未引用任何对象字段相关变量。
-    const objectConfig = objectName ? getObjectConfig(objectName) : null;
-    const varsAndQuotes = await computeFormulaVarsAndQuotes(formula, objectConfig);
-    const vars = varsAndQuotes.vars;
-    if (!currentUserId) {
-        const required = isCurrentUserIdRequiredForFormulaVars(vars);
-        if(required){
-            throw new Error(`The param 'currentUserId' is required for formula ${formula.replace("$", "\\$")}`);
-        }
-    }
-    let doc: any = {};
-
-    if(typeof data == "object" && data){
-        doc = data;
-    }else if(typeof data == "string"){
-        if(objectName && data){
-            const formulaVarFields = pickFormulaVarFields(vars);
-            doc = await getSteedosSchema().getObject(objectName).findOne(data, { fields: formulaVarFields });
-        }
-    }
-
-    if(spaceId){
-        doc.space = spaceId;
-    }
-    let params = await computeFormulaParams(doc, vars, currentUserId);
-    return runFormula(formula, params, options, {objectName});
-}
-
-export const computeFormula = _computeFormula 
-
-async function _computeSimpleFormula(formula: string, data: any, currentUserId?: string, spaceId?: string, options?: SteedosFormulaOptions) {
-    // objectConfig参数值设置为null传入computeFormulaVarsAndQuotes表示计算不带objectConfig参数的普通公式变量
-    const varsAndQuotes = await computeFormulaVarsAndQuotes(formula, null);
-    const vars = varsAndQuotes.vars;
-    if (!currentUserId) {
-        const required = isCurrentUserIdRequiredForFormulaVars(vars);
-        if(required){
-            throw new Error(`The param 'currentUserId' is required for formula ${formula.replace("$", "\\$")}`);
-        }
-    }
-    if(spaceId){
-        data.space = spaceId;
-    }
-
-    let params = await computeFormulaParams(data, vars, currentUserId);
-    return runFormula(formula, params, options);
-}
-
-export const computeSimpleFormula = _computeSimpleFormula 

package/src/formula/params.ts

@@ -1,197 +0,0 @@
-import _ = require('underscore');
-import { getObject } from '../types/object';
-import { SteedosFormulaBlankValue } from './type';
-
-export const enum FormulonDataType {
-    Text = 'text',
-    Number = 'number',
-    Date = 'date',
-    Datetime = 'datetime',
-    Time = 'time',
-    Checkbox = 'checkbox',
-    Picklist = 'picklist',
-    Multipicklist = 'multipicklist',
-    Geolocation = 'geolocation',
-    Null = 'null'
-}
-
-function getFieldSteedosType(field: any){
-    if(_.include(['formula', 'summary'], field.type)){
-        return field.data_type
-    }
-    return field.type
-}
-
-function getField(objectName: string, fieldName: string){
-    if(fieldName === '_id'){
-        return {type: 'text'}
-    }
-    return getObject(objectName).getField(fieldName);
-}
-
-function getSubstitutionDataType(objectName: string, fieldName: string, value: any){
-    const field: any = getField(objectName, fieldName);
-    const steedosType = getFieldSteedosType(field);
-    let dateType: FormulonDataType;
-    switch (steedosType) {
-        case 'text':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'textarea':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'html':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'password':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'autonumber':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'url':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'email':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'number':
-            dateType = FormulonDataType.Number;
-            break;
-        case 'currency':
-            dateType = FormulonDataType.Number;
-            break;
-        case 'percent':
-            dateType = FormulonDataType.Number;
-            break;
-        case 'date':
-            dateType = FormulonDataType.Date;
-            break;
-        case 'datetime':
-            dateType = FormulonDataType.Datetime;
-            break;
-        case 'boolean':
-            dateType = FormulonDataType.Checkbox;
-            break;
-        case 'select':
-            if(field.multiple){
-                dateType = FormulonDataType.Multipicklist;
-            }else{
-                dateType = FormulonDataType.Picklist;
-            }
-            break;
-        case 'lookup':
-            if(field.multiple){
-                dateType = FormulonDataType.Multipicklist;
-            }else{
-                dateType = FormulonDataType.Picklist;
-            }
-            break;
-        case 'master_detail':
-            dateType = FormulonDataType.Picklist;
-            break;
-        case 'geolocation':
-            dateType = FormulonDataType.Geolocation;
-            break;
-        case 'null':
-            dateType = FormulonDataType.Null
-            break;
-        default:
-            break;
-    }
-
-    // if(dateType == FormulonDataType.Number && (value === null || value === undefined)){
-    //     if(blankValue === SteedosFormulaBlankValue.blanks){
-    //         // 当值为空且配置为按空值处理时按NULL类型来处理空值
-    //         // 因为Number类型在公式引擎包中当值为空时始终ISBLANK及BLANKVALUE始终被判断为非空值
-    //         // 目前ISBLANK只支持字符串参数，只能用ISBLANK(TEXT(Amount))这种写法代替，但是这种写法又始终被判定为false，因为公式TEXT(null)运行结果为"NULL"
-    //         // 所以对于数值类型，即不能用ISBLANK(TEXT(Amount))也不能用ISBLANK(Amount)，
-    //         // 而应该用Amount > 0，当Amount为空时，即使设置formula_blank_value为"blanks"，其返回值也是false
-    //         // 实在要判断空值，可以用TEXT(Amount) == "NULL"来判断，而不可以用ISBLANK(TEXT(Amount))或ISBLANK(Amount)
-    //         return FormulonDataType.Null;
-    //     }
-    // }
-    return dateType;
-}
-
-function getSubstitutionOptions(objectName: string, fieldName: string, dataType: string){
-    const field: any = getField(objectName, fieldName);
-    const steedosType = getFieldSteedosType(field);
-    switch (dataType) {
-        case 'number':
-            let scale = 0;
-            if(_.has(field, 'scale')){
-                scale = field.scale;
-            }else{
-                // 数值类型默认按2位小数来计算
-                scale = 2;
-            }
-            if(steedosType === "percent"){
-                // 百分比类型参数，scale配置的是百分比的小数位数，计算时需要额外增加2位小数，比如scale配置为1时，像20.2%这样的数值计算时应该按0.202是三位小数参与计算。
-                scale += 2;
-            }
-            return { scale };
-        case 'text':
-            return {length: Number.MAX_VALUE};
-        case 'multipicklist':
-            // 暂时先不支持optionsFunctions的情况，只支持写死的options
-            if(field.options){
-                /*
-                直接返回类似下面的完整内容，方便需要的时候取label显示。
-                TEXT函数在我们的公式引擎及sf中都不支持multipicklist，只支持单选的picklist，所以下面的返回值暂时没找到什么地方可以用
-                [
-                    { label: 'K1', value: 'k1' },
-                    { label: 'K2', value: 'k2' },
-                    { label: 'K3', value: 'k3' }
-                ]
-                */
-                return {values: field.options};
-            }
-            else{
-                // 实测直接返回空值不影响INCLUDES函数，所以optionsFunctions等情况下直接返回空数组影响不大
-                // 至少返回空数组，否则公式会报错
-                return {values: []};
-            }
-        default:
-            return ;
-    }
-}
-
-function getSubstitutionValue(dataType: string, value: any, blankValue: SteedosFormulaBlankValue){
-    switch (dataType) {
-        case FormulonDataType.Text:
-            if(value === null || value === undefined){
-                return '';
-            }
-            break;
-        case FormulonDataType.Number:
-            if(value === null || value === undefined){
-                if(blankValue === SteedosFormulaBlankValue.blanks){
-                    return null;
-                }
-                else{
-                    return 0;
-                }
-            }
-            break;
-        case FormulonDataType.Multipicklist:
-            if(value === null || value === undefined){
-                return [];
-            }
-            break;
-        default:
-            break;
-    }
-    return value;
-}
-
-export function getFieldSubstitution(objectName: string, fieldName: string, value: any, blankValue: SteedosFormulaBlankValue){
-    let fieldSubstitution: any = {
-        type: 'literal',
-        value: value
-    }
-    fieldSubstitution.dataType = getSubstitutionDataType(objectName, fieldName, value);
-    fieldSubstitution.options = getSubstitutionOptions(objectName, fieldName, fieldSubstitution.dataType);
-    fieldSubstitution.value  = getSubstitutionValue(fieldSubstitution.dataType, value, blankValue);
-    return fieldSubstitution;
-}

package/src/formula/recompute.ts

@@ -1,65 +0,0 @@
-import { getSteedosSchema } from '../index';
-import { SteedosFieldFormulaTypeConfig } from './type';
-import { checkCurrentUserIdNotRequiredForFieldFormulas } from './util';
-import { getFieldFormulaConfig, getQuotedByFieldFormulaConfigs } from './field_formula';
-import { computeFieldFormulaValue, pickFieldFormulaVarFields, updateQuotedByObjectFieldFormulaValue } from './core';
-import { getQuotedByFieldSummaryConfigs, recomputeFieldSummaryValues } from '../summary';
-
-const runCurrentFieldFormulas = async function (fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any) {
-    const currentUserId = userSession ? userSession.userId : undefined;
-    const { field_name: fieldName, object_name: objectName } = fieldFormulaConfig;
-    const formulaVarFields = pickFieldFormulaVarFields(fieldFormulaConfig);
-    const docs = await getSteedosSchema().getObject(objectName).find({ filters: [], fields: formulaVarFields })
-    for (const doc of docs) {
-        const value = await computeFieldFormulaValue(doc, fieldFormulaConfig, currentUserId);
-        let setDoc = {};
-        setDoc[fieldName] = value;
-        await getSteedosSchema().getObject(objectName).directUpdate(doc._id, setDoc);
-        await runQuotedFieldFormulas(doc._id, fieldFormulaConfig, userSession);
-    }
-    await runQuotedFieldSummaries(fieldFormulaConfig, userSession);
-}
-
-const runQuotedFieldFormulas = async function (recordId: string, fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any) {
-    const formulaQuotedBys = await getQuotedByFieldFormulaConfigs(fieldFormulaConfig);
-    for (const config of formulaQuotedBys.allConfigs) {
-        await updateQuotedByObjectFieldFormulaValue(fieldFormulaConfig.object_name, recordId, config, userSession);
-    }
-}
-
-/**
- * 找到公式字段被哪些汇总字段引用，并重新计算汇总字段值（相当于点击一次界面上的“批量重算汇总值”按钮）
- * @param fieldFormulaConfig 
- * @param userSession 
- */
-const runQuotedFieldSummaries = async function (fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any) {
-    const summaryQuotedBys = await getQuotedByFieldSummaryConfigs(fieldFormulaConfig);
-    for (const config of summaryQuotedBys) {
-        await recomputeFieldSummaryValues(config, userSession);
-    }
-}
-
-/**
- * 重算指定公式字段Id对应的公式值
- * @param fieldId : ${objectApiName}.${fieldApiName}
- */
-export const recomputeFormulaValues = async (fieldId: string, userSession: any) => {
-    let config = await getFieldFormulaConfig(fieldId);
-    if (!config) {
-        throw new Error(`recomputeFormulaValues:${fieldId} not found in field_formula configs.`);
-    }
-    return await recomputeFieldFormulaValues(config, userSession);
-}
-
-/**
- * 重算指定公式字段的公式值
- * @param fieldFormulaConfig 
- */
-export const recomputeFieldFormulaValues = async (fieldFormulaConfig: SteedosFieldFormulaTypeConfig, userSession: any) => {
-    const currentUserId = userSession ? userSession.userId : undefined;
-    if (!currentUserId) {
-        checkCurrentUserIdNotRequiredForFieldFormulas(fieldFormulaConfig);
-    }
-    await runCurrentFieldFormulas(fieldFormulaConfig, userSession);
-    return true;
-}

package/src/formula/simple_params.ts

@@ -1,92 +0,0 @@
-import { SteedosFormulaBlankValue } from './type';
-import { FormulonDataType } from './params';
-
-const VALUE_TYPES_NOT_SUPPORTED = ["function"];
-
-function getSubstitutionDataType(value: any){
-    const valueType = typeof value;
-    let dateType: FormulonDataType;
-    if(VALUE_TYPES_NOT_SUPPORTED.indexOf(dateType) > -1){
-        throw new Error(`runFormula:Catch an error the param type "${valueType}" is not supported while eval formula with the params value: "${value}"`);
-    }
-    switch (valueType) {
-        case 'string':
-            dateType = FormulonDataType.Text;
-            break;
-        case 'number':
-            dateType = FormulonDataType.Number;
-            break;
-        case 'boolean':
-            dateType = FormulonDataType.Checkbox;
-            break;
-        case 'object':
-            if(value === null){
-                dateType = FormulonDataType.Null;
-            }
-            else if (value instanceof Date){
-                dateType = FormulonDataType.Datetime;
-            }
-            else{
-                throw new Error(`runFormula:Catch an error the param type "${valueType}" is not supported while eval formula with the params value: "${value}"`);
-            }
-            break;
-        case 'undefined':
-            dateType = FormulonDataType.Null;
-            break;
-        default:
-            break;
-    }
-    return dateType;
-}
-
-function getSubstitutionOptions(dataType: string, value: any){
-    switch (dataType) {
-        case FormulonDataType.Number:
-            let scale = 0;
-            let str = value.toString();
-            let dotStr = str.toString().split(".")[1];
-            let dotCount = dotStr && dotStr.length;
-            if(dotCount > 0){
-                scale = dotCount;
-            }
-            return { scale };
-        case FormulonDataType.Text:
-            return {length: Number.MAX_VALUE};
-        default:
-            return ;
-    }
-}
-
-function getSubstitutionValue(dataType: string, value: any, blankValue: SteedosFormulaBlankValue){
-    switch (dataType) {
-        case FormulonDataType.Text:
-            if(value === null || value === undefined){
-                return '';
-            }
-            break;
-        case FormulonDataType.Number:
-            if(value === null || value === undefined){
-                if(blankValue === SteedosFormulaBlankValue.blanks){
-                    return null;
-                }
-                else{
-                    return 0;
-                }
-            }
-            break;
-        default:
-            break;
-    }
-    return value;
-}
-
-export function getSimpleParamSubstitution(value: any, blankValue: SteedosFormulaBlankValue){
-    let fieldSubstitution: any = {
-        type: 'literal',
-        value: value
-    }
-    fieldSubstitution.dataType = getSubstitutionDataType(value);
-    fieldSubstitution.options = getSubstitutionOptions(fieldSubstitution.dataType, value);
-    fieldSubstitution.value  = getSubstitutionValue(fieldSubstitution.dataType, value, blankValue);
-    return fieldSubstitution;
-}

package/src/formula/type.ts

@@ -1,107 +0,0 @@
-// 公式内容中表示userSession变量的占位符
-export const FormulaUserKey = "$user";
-
-/**
- * 记录公式字段中引用的本对象或其他对象上的字段
- * 用于相关引用字段值变更时，能找到哪些公式字段需要级联变更
- * is_formula指field_name是否是公式字段
- * is_own指field_name是否引用的是本对象自身的字段（字段属于对象本身，且所对应的公式变量只有唯一一层引用，即直接引用当前对象自身上的字段）
- */
-export type SteedosFieldFormulaQuoteTypeConfig = {
-    object_name: string,
-    field_name: string,
-    is_formula?: boolean
-    is_own?: boolean
-}
-
-/**
- * 公式中的{}括起来的单个变量中的执行路径
- * {}中第一个reference_from肯定是指向当前对象
- * is_formula指field_name是否是公式字段
- */
-export type SteedosFormulaVarPathTypeConfig = {
-    field_name: string,
-    reference_from: string,
-    is_formula?: boolean
-}
-
-/**
- * 运行公式时，要注入的参数，经过计算每个SteedosFieldFormulaVarTypeConfig最终会转换为该结构作为参数注入公式中
- * 比如contacts对象中有公式{account.website}
- * 解析后的SteedosFieldFormulaVarTypeConfig为：
- * {
- *  key: "account.website",
- *  paths: [
- *   {field_name: "account", reference_from:"contacts"},
- *   {field_name: "website", reference_from:"accounts"},
- *  ]
- * }
- * 最终转换成的SteedosFieldFormulaParamTypeConfig为：
- * {
- *  key: "account.website",
- *  value: "www.abc.com"
- * }
- */
-export type SteedosFormulaParamTypeConfig = {
-    key: string,
-    path?: any,
-    value: any
-}
-
-/**
- * 公式中的{}括起来的单个变量
- * 比如contacts对象中有公式{account.website}
- * 则解析为：
- * {
- *  key: "account.website",
- *  paths: [
- *   {field_name: "account", reference_from:"contacts"},
- *   {field_name: "website", reference_from:"accounts"},
- *  ]
- * }
- */
-export type SteedosFormulaVarTypeConfig = {
-    key: string,
-    paths?: Array<SteedosFormulaVarPathTypeConfig>,
-    is_user_var?: boolean,
-    is_simple_var?: boolean //当不传入objectApiName时变量上设置该属性表示一个普通的变量，此时paths为空
-}
-
-export type SteedosFieldFormulaTypeConfig = {
-    _id: string, //低代码值为${objectConfig.name}.${fieldConfig.name}，零代码为数据库中的_id值
-    object_name: string,
-    field_name: string,
-    data_type: string,
-    formula_blank_value: SteedosFormulaBlankValue,
-    formula: string,
-    quotes: Array<SteedosFieldFormulaQuoteTypeConfig>,
-    vars: Array<SteedosFormulaVarTypeConfig>
-}
-
-/**
- * 获取对象在哪些字段公式中被引用时的返回结果
- * ownConfigs为引用关系为当前对象上的自身引用自身（即引用关系is_own为true）
- * otherConfigs为引用关系中排除ownConfigs后的其他引用关系（包括当前对象上is_own为false的引用关系）
- * allConfigs = ownConfigs + otherConfigs
- */
-export type SteedosQuotedByFieldFormulasTypeConfig = {
-    ownConfigs: Array<SteedosFieldFormulaTypeConfig>,
-    otherConfigs: Array<SteedosFieldFormulaTypeConfig>,
-    allConfigs: Array<SteedosFieldFormulaTypeConfig>
-}
-
-/**
- * 空白字段处理，只在公式类型返回值为number和currency类型时有效，默认为zeroes
- */
-export enum SteedosFormulaBlankValue {
-    zeroes = "zeroes",
-    blanks = "blanks"
-}
-
-/**
- * 内核函数runFormula的额外参数
- */
-export type SteedosFormulaOptions = {
-    returnType?: string,
-    blankValue?: SteedosFormulaBlankValue,
-}