@finos/legend-query-builder 0.0.1

package/lib/stores/QueryBuilderValueSpecificationBuilderHelper.js

@@ -0,0 +1,161 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { functionExpression_setParametersValues, propertyExpression_setParametersValue, } from '@finos/legend-application';
+import { AbstractPropertyExpression, Class, DerivedProperty, getMilestoneTemporalStereotype, INTERNAL__PropagatedValue, matchFunctionName, MILESTONING_STEREOTYPE, SimpleFunctionExpression, TYPICAL_MULTIPLICITY_TYPE, } from '@finos/legend-graph';
+import { getNullableFirstElement, guaranteeNonNullable, guaranteeType, } from '@finos/legend-shared';
+import { QUERY_BUILDER_SUPPORTED_FUNCTIONS } from '../graphManager/QueryBuilderSupportedFunctions.js';
+import { getDerivedPropertyMilestoningSteoreotype } from './QueryBuilderPropertyEditorState.js';
+/**
+ * Checks if the provided property expression match the criteria for default
+ * date propagation so we know whether we need to fill in values for the parameter
+ * or just propgate values from the parent's expression
+ *
+ * NOTE: this takes date propgation into account. See the table below for all
+ * the combination:
+ *
+ *             | [source] |          |          |          |          |
+ * ----------------------------------------------------------------------
+ *   [target]  |          |   NONE   |  PR_TMP  |  BI_TMP  |  BU_TMP  |
+ * ----------------------------------------------------------------------
+ *             |   NONE   |   N.A.   |   PRD    | PRD,BUD  |    BUD   |
+ * ----------------------------------------------------------------------
+ *             |  PR_TMP  |   N.A.   |    X     | PRD,BUD  |    BUD   |
+ * ----------------------------------------------------------------------
+ *             |  BI_TMP  |   N.A.   |    X     |    X     |    X     |
+ * ----------------------------------------------------------------------
+ *             |  BU_TMP  |   N.A.   |   PRD    | PRD,BUD  |    X     |
+ * ----------------------------------------------------------------------
+ *
+ * Annotations:
+ *
+ * [source]: source temporal type
+ * [target]: target temporal type
+ *
+ * PR_TMP  : processing temporal
+ * BI_TMP  : bitemporal
+ * BU_TMP  : business temporal
+ *
+ * X       : no default date propagated
+ * PRD     : default processing date is propagated
+ * BUD     : default business date is propgated
+ */
+const isDefaultDatePropagationSupported = (currentPropertyExpression, queryBuilderState, prevPropertyExpression) => {
+    const property = currentPropertyExpression.func;
+    const graph = queryBuilderState.graphManagerState.graph;
+    // Default date propagation is not supported for current expression when the previous property expression is a derived property.
+    if (prevPropertyExpression &&
+        prevPropertyExpression.func instanceof DerivedProperty &&
+        prevPropertyExpression.func._OWNER.derivedProperties.includes(prevPropertyExpression.func)) {
+        return false;
+    }
+    // Default date propagation is not supported for current expression when the milestonedParameterValues of
+    // the previous property expression doesn't match with the global milestonedParameterValues
+    if (prevPropertyExpression &&
+        prevPropertyExpression.func.genericType.value.rawType instanceof Class) {
+        const milestoningStereotype = getMilestoneTemporalStereotype(prevPropertyExpression.func.genericType.value.rawType, graph);
+        if (milestoningStereotype &&
+            !prevPropertyExpression.parametersValues
+                .slice(1)
+                .every((parameterValue) => parameterValue instanceof INTERNAL__PropagatedValue)) {
+            return false;
+        }
+    }
+    if (property.genericType.value.rawType instanceof Class) {
+        // the stereotype of source class of current property expression.
+        const sourceStereotype = property instanceof DerivedProperty
+            ? getDerivedPropertyMilestoningSteoreotype(property, graph)
+            : undefined;
+        // Default date propagation is always supported if the source is `bitemporal`
+        if (sourceStereotype === MILESTONING_STEREOTYPE.BITEMPORAL) {
+            return true;
+        }
+        // the stereotype (if exists) of the generic type of current property expression.
+        const targetStereotype = getMilestoneTemporalStereotype(property.genericType.value.rawType, graph);
+        // Default date propagation is supported when stereotype of both source and target matches
+        if (sourceStereotype && targetStereotype) {
+            return sourceStereotype === targetStereotype;
+        }
+    }
+    return false;
+};
+export const buildPropertyExpressionChain = (propertyExpression, queryBuilderState, 
+/**
+ * As of now, we don't support date propagation for aggregation-class functions
+ * so we have this temporary flag to disable date propagation, there could be other
+ * functions that we need to handle, then we will revise this approach
+ * See https://github.com/finos/legend-studio/issues/1471
+ */
+TEMPORARY__disableDatePropagation) => {
+    const graph = queryBuilderState.graphManagerState.graph;
+    const newPropertyExpression = new AbstractPropertyExpression('', graph.getTypicalMultiplicity(TYPICAL_MULTIPLICITY_TYPE.ONE));
+    newPropertyExpression.func = propertyExpression.func;
+    newPropertyExpression.parametersValues = propertyExpression.parametersValues;
+    let nextExpression;
+    let currentExpression = newPropertyExpression;
+    while (currentExpression instanceof AbstractPropertyExpression) {
+        nextExpression = getNullableFirstElement(currentExpression.parametersValues);
+        if (nextExpression instanceof AbstractPropertyExpression) {
+            const parameterValue = new AbstractPropertyExpression('', graph.getTypicalMultiplicity(TYPICAL_MULTIPLICITY_TYPE.ONE));
+            parameterValue.func = nextExpression.func;
+            parameterValue.parametersValues = nextExpression.parametersValues;
+            nextExpression = parameterValue;
+            currentExpression.parametersValues[0] = parameterValue;
+        }
+        if (currentExpression.func instanceof DerivedProperty) {
+            const parameterValues = currentExpression.parametersValues.slice(1);
+            parameterValues.forEach((parameterValue, index) => {
+                if (parameterValue instanceof INTERNAL__PropagatedValue) {
+                    // Replace with argumentless derived property expression only when default date propagation is supported
+                    if (!TEMPORARY__disableDatePropagation &&
+                        isDefaultDatePropagationSupported(guaranteeType(currentExpression, AbstractPropertyExpression), queryBuilderState, nextExpression instanceof AbstractPropertyExpression
+                            ? nextExpression
+                            : undefined)) {
+                        // NOTE: For `bitemporal` property check if the property expression has parameters which are not instance of
+                        // `INTERNAL_PropagatedValue` then pass the parameters as user explicitly changed values of either of the parameters.
+                        if ((index === 1 &&
+                            guaranteeType(currentExpression, AbstractPropertyExpression)
+                                .parametersValues.length === 3) ||
+                            (index === 0 &&
+                                guaranteeType(currentExpression, AbstractPropertyExpression)
+                                    .parametersValues.length === 3 &&
+                                !(guaranteeType(currentExpression, AbstractPropertyExpression)
+                                    .parametersValues[2] instanceof INTERNAL__PropagatedValue))) {
+                            propertyExpression_setParametersValue(guaranteeType(currentExpression, AbstractPropertyExpression), index + 1, parameterValue.getValue(), queryBuilderState.observableContext);
+                        }
+                        else {
+                            functionExpression_setParametersValues(guaranteeType(currentExpression, AbstractPropertyExpression), [
+                                guaranteeNonNullable(guaranteeType(currentExpression, AbstractPropertyExpression)
+                                    .parametersValues[0]),
+                            ], queryBuilderState.observableContext);
+                        }
+                    }
+                    else {
+                        propertyExpression_setParametersValue(guaranteeType(currentExpression, AbstractPropertyExpression), index + 1, parameterValue.getValue(), queryBuilderState.observableContext);
+                    }
+                }
+            });
+        }
+        currentExpression = nextExpression;
+        // Take care of chains of subtype (a pattern that is not useful, but we want to support and rectify)
+        // $x.employees->subType(@Person)->subType(@Staff)
+        while (currentExpression instanceof SimpleFunctionExpression &&
+            matchFunctionName(currentExpression.functionName, QUERY_BUILDER_SUPPORTED_FUNCTIONS.SUBTYPE)) {
+            currentExpression = getNullableFirstElement(currentExpression.parametersValues);
+        }
+    }
+    return newPropertyExpression;
+};
+//# sourceMappingURL=QueryBuilderValueSpecificationBuilderHelper.js.map

package/lib/stores/QueryBuilderValueSpecificationBuilderHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilderValueSpecificationBuilderHelper.js","sourceRoot":"","sources":["../../src/stores/QueryBuilderValueSpecificationBuilderHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,sCAAsC,EACtC,qCAAqC,GACtC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,0BAA0B,EAC1B,KAAK,EACL,eAAe,EACf,8BAA8B,EAC9B,yBAAyB,EACzB,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,GAE1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,aAAa,GACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,iCAAiC,EAAE,MAAM,mDAAmD,CAAC;AACtG,OAAO,EAAE,wCAAwC,EAAE,MAAM,sCAAsC,CAAC;AAGhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,iCAAiC,GAAG,CACxC,yBAAqD,EACrD,iBAAoC,EACpC,sBAA+D,EACtD,EAAE;IACX,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC;IAChD,MAAM,KAAK,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,KAAK,CAAC;IACxD,gIAAgI;IAChI,IACE,sBAAsB;QACtB,sBAAsB,CAAC,IAAI,YAAY,eAAe;QACtD,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAC3D,sBAAsB,CAAC,IAAI,CAC5B,EACD;QACA,OAAO,KAAK,CAAC;KACd;IACD,yGAAyG;IACzG,2FAA2F;IAC3F,IACE,sBAAsB;QACtB,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,YAAY,KAAK,EACtE;QACA,MAAM,qBAAqB,GAAG,8BAA8B,CAC1D,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EACrD,KAAK,CACN,CAAC;QACF,IACE,qBAAqB;YACrB,CAAC,sBAAsB,CAAC,gBAAgB;iBACrC,KAAK,CAAC,CAAC,CAAC;iBACR,KAAK,CACJ,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,YAAY,yBAAyB,CACtD,EACH;YACA,OAAO,KAAK,CAAC;SACd;KACF;IACD,IAAI,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,YAAY,KAAK,EAAE;QACvD,iEAAiE;QACjE,MAAM,gBAAgB,GACpB,QAAQ,YAAY,eAAe;YACjC,CAAC,CAAC,wCAAwC,CAAC,QAAQ,EAAE,KAAK,CAAC;YAC3D,CAAC,CAAC,SAAS,CAAC;QAChB,6EAA6E;QAC7E,IAAI,gBAAgB,KAAK,sBAAsB,CAAC,UAAU,EAAE;YAC1D,OAAO,IAAI,CAAC;SACb;QACD,iFAAiF;QACjF,MAAM,gBAAgB,GAAG,8BAA8B,CACrD,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EAClC,KAAK,CACN,CAAC;QACF,0FAA0F;QAC1F,IAAI,gBAAgB,IAAI,gBAAgB,EAAE;YACxC,OAAO,gBAAgB,KAAK,gBAAgB,CAAC;SAC9C;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,kBAA8C,EAC9C,iBAAoC;AACpC;;;;;GAKG;AACH,iCAA2C,EACvB,EAAE;IACtB,MAAM,KAAK,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,KAAK,CAAC;IACxD,MAAM,qBAAqB,GAAG,IAAI,0BAA0B,CAC1D,EAAE,EACF,KAAK,CAAC,sBAAsB,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAC5D,CAAC;IACF,qBAAqB,CAAC,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC;IACrD,qBAAqB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC;IAE7E,IAAI,cAA8C,CAAC;IACnD,IAAI,iBAAiB,GAAmC,qBAAqB,CAAC;IAC9E,OAAO,iBAAiB,YAAY,0BAA0B,EAAE;QAC9D,cAAc,GAAG,uBAAuB,CACtC,iBAAiB,CAAC,gBAAgB,CACnC,CAAC;QACF,IAAI,cAAc,YAAY,0BAA0B,EAAE;YACxD,MAAM,cAAc,GAAG,IAAI,0BAA0B,CACnD,EAAE,EACF,KAAK,CAAC,sBAAsB,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAC5D,CAAC;YACF,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;YAC1C,cAAc,CAAC,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC;YAClE,cAAc,GAAG,cAAc,CAAC;YAChC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;SACxD;QACD,IAAI,iBAAiB,CAAC,IAAI,YAAY,eAAe,EAAE;YACrD,MAAM,eAAe,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACpE,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE;gBAChD,IAAI,cAAc,YAAY,yBAAyB,EAAE;oBACvD,wGAAwG;oBACxG,IACE,CAAC,iCAAiC;wBAClC,iCAAiC,CAC/B,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC,EAC5D,iBAAiB,EACjB,cAAc,YAAY,0BAA0B;4BAClD,CAAC,CAAC,cAAc;4BAChB,CAAC,CAAC,SAAS,CACd,EACD;wBACA,4GAA4G;wBAC5G,qHAAqH;wBACrH,IACE,CAAC,KAAK,KAAK,CAAC;4BACV,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC;iCACzD,gBAAgB,CAAC,MAAM,KAAK,CAAC,CAAC;4BACnC,CAAC,KAAK,KAAK,CAAC;gCACV,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC;qCACzD,gBAAgB,CAAC,MAAM,KAAK,CAAC;gCAChC,CAAC,CACC,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC;qCACzD,gBAAgB,CAAC,CAAC,CAAC,YAAY,yBAAyB,CAC5D,CAAC,EACJ;4BACA,qCAAqC,CACnC,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC,EAC5D,KAAK,GAAG,CAAC,EACT,cAAc,CAAC,QAAQ,EAAE,EACzB,iBAAiB,CAAC,iBAAiB,CACpC,CAAC;yBACH;6BAAM;4BACL,sCAAsC,CACpC,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC,EAC5D;gCACE,oBAAoB,CAClB,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC;qCACzD,gBAAgB,CAAC,CAAC,CAAC,CACvB;6BACF,EACD,iBAAiB,CAAC,iBAAiB,CACpC,CAAC;yBACH;qBACF;yBAAM;wBACL,qCAAqC,CACnC,aAAa,CAAC,iBAAiB,EAAE,0BAA0B,CAAC,EAC5D,KAAK,GAAG,CAAC,EACT,cAAc,CAAC,QAAQ,EAAE,EACzB,iBAAiB,CAAC,iBAAiB,CACpC,CAAC;qBACH;iBACF;YACH,CAAC,CAAC,CAAC;SACJ;QACD,iBAAiB,GAAG,cAAc,CAAC;QACnC,oGAAoG;QACpG,kDAAkD;QAClD,OACE,iBAAiB,YAAY,wBAAwB;YACrD,iBAAiB,CACf,iBAAiB,CAAC,YAAY,EAC9B,iCAAiC,CAAC,OAAO,CAC1C,EACD;YACA,iBAAiB,GAAG,uBAAuB,CACzC,iBAAiB,CAAC,gBAAgB,CACnC,CAAC;SACH;KACF;IACD,OAAO,qBAAqB,CAAC;AAC/B,CAAC,CAAC"}

package/lib/stores/QueryBuilderValueSpecificationHelper.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type PureModel, type ValueSpecification, LambdaFunctionInstanceValue, PRIMITIVE_TYPE, type Type, SimpleFunctionExpression, AbstractPropertyExpression } from '@finos/legend-graph';
+export declare const getNonCollectionValueSpecificationType: (valueSpecification: ValueSpecification) => Type | undefined;
+export declare const getCollectionValueSpecificationType: (graph: PureModel, values: ValueSpecification[]) => Type | undefined;
+export declare const unwrapNotExpression: (expression: SimpleFunctionExpression) => SimpleFunctionExpression | undefined;
+export declare const buildNotExpression: (graph: PureModel, expression: ValueSpecification) => ValueSpecification;
+export declare const isPropertyExpressionChainOptional: (expression: ValueSpecification | undefined) => boolean;
+export declare const isTypeCompatibleForAssignment: (type: Type | undefined, assignmentType: Type) => boolean;
+export declare const generateDefaultValueForPrimitiveType: (type: PRIMITIVE_TYPE) => unknown;
+export declare const buildGenericLambdaFunctionInstanceValue: (lambdaParameterName: string, lambdaBodyExpressions: ValueSpecification[], graph: PureModel) => LambdaFunctionInstanceValue;
+/**
+ * Checks if the milestoning property expression is valid in terms of number of parameter values provided
+ * in relation to its milestoning type.
+ *
+ * NOTE: this takes date propgation into account. See the table below for all
+ * the combination:
+ *
+ *             | [source] |          |          |          |          |
+ * ----------------------------------------------------------------------
+ *   [target]  |          |   NONE   |  PR_TMP  |  BI_TMP  |  BU_TMP  |
+ * ----------------------------------------------------------------------
+ *             |   NONE   |   N.A.   |   PRD    | PRD,BUD  |    BUD   |
+ * ----------------------------------------------------------------------
+ *             |  PR_TMP  |   N.A.   |    X     | PRD,BUD  |    BUD   |
+ * ----------------------------------------------------------------------
+ *             |  BI_TMP  |   N.A.   |    X     |    X     |    X     |
+ * ----------------------------------------------------------------------
+ *             |  BU_TMP  |   N.A.   |   PRD    | PRD,BUD  |    X     |
+ * ----------------------------------------------------------------------
+ *
+ * Annotations:
+ *
+ * [source]: source temporal type
+ * [target]: target temporal type
+ *
+ * PR_TMP  : processing temporal
+ * BI_TMP  : bitemporal
+ * BU_TMP  : business temporal
+ *
+ * X       : no default date propagated
+ * PRD     : default processing date is propagated
+ * BUD     : default business date is propgated
+ */
+export declare const validatePropertyExpressionChain: (propertyExpression: AbstractPropertyExpression, graph: PureModel) => void;
+export declare const extractNullableStringFromInstanceValue: (value: ValueSpecification) => string | undefined;
+export declare const extractNullableNumberFromInstanceValue: (value: ValueSpecification) => number | undefined;
+//# sourceMappingURL=QueryBuilderValueSpecificationHelper.d.ts.map

package/lib/stores/QueryBuilderValueSpecificationHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilderValueSpecificationHelper.d.ts","sourceRoot":"","sources":["../../src/stores/QueryBuilderValueSpecificationHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,KAAK,SAAS,EACd,KAAK,kBAAkB,EAIvB,2BAA2B,EAC3B,cAAc,EAMd,KAAK,IAAI,EAGT,wBAAwB,EAIxB,0BAA0B,EAM3B,MAAM,qBAAqB,CAAC;AAa7B,eAAO,MAAM,sCAAsC,uBAC7B,kBAAkB,KACrC,IAAI,GAAG,SAWT,CAAC;AAEF,eAAO,MAAM,mCAAmC,UACvC,SAAS,UACR,kBAAkB,EAAE,KAC3B,IAAI,GAAG,SA4CT,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAClB,wBAAwB,KACnC,wBAAwB,GAAG,SAa7B,CAAC;AAEF,eAAO,MAAM,kBAAkB,UACtB,SAAS,cACJ,kBAAkB,KAC7B,kBAUF,CAAC;AAEF,eAAO,MAAM,iCAAiC,eAChC,kBAAkB,GAAG,SAAS,KACzC,OAiBF,CAAC;AAEF,eAAO,MAAM,6BAA6B,SAClC,IAAI,GAAG,SAAS,kBACN,IAAI,KACnB,OA6BF,CAAC;AAEF,eAAO,MAAM,oCAAoC,SACzC,cAAc,KACnB,OAqBF,CAAC;AAEF,eAAO,MAAM,uCAAuC,wBAC7B,MAAM,yBACJ,kBAAkB,EAAE,SACpC,SAAS,KACf,2BAgBF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,+BAA+B,uBACtB,0BAA0B,SACvC,SAAS,KACf,IAmDF,CAAC;AAEF,eAAO,MAAM,sCAAsC,UAC1C,kBAAkB,KACxB,MAAM,GAAG,SAKX,CAAC;AAEF,eAAO,MAAM,sCAAsC,UAC1C,kBAAkB,KACxB,MAAM,GAAG,SAKX,CAAC"}

package/lib/stores/QueryBuilderValueSpecificationHelper.js

@@ -0,0 +1,235 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CORE_PURE_PATH, FunctionType, LambdaFunction, LambdaFunctionInstanceValue, PRIMITIVE_TYPE, TYPICAL_MULTIPLICITY_TYPE, VariableExpression, DATE_FORMAT, DATE_TIME_FORMAT, matchFunctionName, PrimitiveInstanceValue, EnumValueInstanceValue, SimpleFunctionExpression, extractElementNameFromPath, AbstractPropertyExpression, isSuperType, Class, getMilestoneTemporalStereotype, DerivedProperty, MILESTONING_STEREOTYPE, } from '@finos/legend-graph';
+import { addUniqueEntry, guaranteeNonNullable, guaranteeType, isNumber, isString, UnsupportedOperationError, } from '@finos/legend-shared';
+import { format } from 'date-fns';
+import { QUERY_BUILDER_SUPPORTED_FUNCTIONS } from '../graphManager/QueryBuilderSupportedFunctions.js';
+import { getDerivedPropertyMilestoningSteoreotype } from './QueryBuilderPropertyEditorState.js';
+export const getNonCollectionValueSpecificationType = (valueSpecification) => {
+    if (valueSpecification instanceof PrimitiveInstanceValue) {
+        return valueSpecification.genericType.value.rawType;
+    }
+    else if (valueSpecification instanceof EnumValueInstanceValue) {
+        return guaranteeNonNullable(valueSpecification.values[0]).value._OWNER;
+    }
+    else if (valueSpecification instanceof VariableExpression) {
+        return valueSpecification.genericType?.value.rawType;
+    }
+    else if (valueSpecification instanceof SimpleFunctionExpression) {
+        return valueSpecification.genericType?.value.rawType;
+    }
+    return undefined;
+};
+export const getCollectionValueSpecificationType = (graph, values) => {
+    if (values.every((val) => val instanceof PrimitiveInstanceValue)) {
+        const valuePrimitiveTypes = [];
+        values.forEach((val) => {
+            const primitiveType = val.genericType.value.rawType;
+            switch (primitiveType.path) {
+                case PRIMITIVE_TYPE.STRING:
+                    addUniqueEntry(valuePrimitiveTypes, graph.getPrimitiveType(PRIMITIVE_TYPE.STRING));
+                    break;
+                case PRIMITIVE_TYPE.INTEGER:
+                case PRIMITIVE_TYPE.DECIMAL:
+                case PRIMITIVE_TYPE.FLOAT:
+                case PRIMITIVE_TYPE.NUMBER:
+                    addUniqueEntry(valuePrimitiveTypes, graph.getPrimitiveType(PRIMITIVE_TYPE.NUMBER));
+                    break;
+                default:
+                    valuePrimitiveTypes.push(undefined);
+                    break;
+            }
+        });
+        if (valuePrimitiveTypes.length > 1) {
+            return undefined;
+        }
+        return valuePrimitiveTypes[0];
+    }
+    else if (values.every((val) => val instanceof EnumValueInstanceValue)) {
+        const valueEnumerationTypes = [];
+        values.forEach((val) => {
+            addUniqueEntry(valueEnumerationTypes, guaranteeNonNullable(val.values[0]).value._OWNER);
+        });
+        if (valueEnumerationTypes.length > 1) {
+            return undefined;
+        }
+        return valueEnumerationTypes[0];
+    }
+    return undefined;
+};
+export const unwrapNotExpression = (expression) => {
+    if (matchFunctionName(expression.functionName, QUERY_BUILDER_SUPPORTED_FUNCTIONS.NOT)) {
+        return guaranteeType(expression.parametersValues[0], SimpleFunctionExpression);
+    }
+    return undefined;
+};
+export const buildNotExpression = (graph, expression) => {
+    const multiplicityOne = graph.getTypicalMultiplicity(TYPICAL_MULTIPLICITY_TYPE.ONE);
+    const expressionNot = new SimpleFunctionExpression(extractElementNameFromPath(QUERY_BUILDER_SUPPORTED_FUNCTIONS.NOT), multiplicityOne);
+    expressionNot.parametersValues.push(expression);
+    return expressionNot;
+};
+export const isPropertyExpressionChainOptional = (expression) => {
+    let isOptional = false;
+    let propertyExpression = expression;
+    while (propertyExpression &&
+        propertyExpression instanceof AbstractPropertyExpression) {
+        if (propertyExpression.func.multiplicity.lowerBound === 0) {
+            isOptional = true;
+            break;
+        }
+        propertyExpression = propertyExpression.parametersValues.at(0);
+        while (propertyExpression instanceof SimpleFunctionExpression) {
+            propertyExpression = propertyExpression.parametersValues.at(0);
+        }
+    }
+    return isOptional;
+};
+export const isTypeCompatibleForAssignment = (type, assignmentType) => {
+    const NUMERIC_PRIMITIVE_TYPES = [
+        PRIMITIVE_TYPE.NUMBER,
+        PRIMITIVE_TYPE.INTEGER,
+        PRIMITIVE_TYPE.DECIMAL,
+        PRIMITIVE_TYPE.FLOAT,
+    ];
+    const DATE_PRIMITIVE_TYPES = [
+        PRIMITIVE_TYPE.DATE,
+        PRIMITIVE_TYPE.DATETIME,
+        PRIMITIVE_TYPE.STRICTDATE,
+        PRIMITIVE_TYPE.LATESTDATE,
+    ];
+    // When changing the return type for LHS, the RHS value should be adjusted accordingly.
+    return (type !== undefined &&
+        // Numeric value is handled loosely because of autoboxing
+        // e.g. LHS (integer) = RHS (float) is acceptable
+        ((NUMERIC_PRIMITIVE_TYPES.includes(type.path) &&
+            NUMERIC_PRIMITIVE_TYPES.includes(assignmentType.path)) ||
+            // Date value is handled loosely as well if the LHS is of type DateTime
+            // This is because we would simulate auto-boxing for date by altering the
+            // Pure function used for the operation
+            // e.g. LHS(DateTime) = RHS(Date) -> we use isOnDay() instead of is()
+            DATE_PRIMITIVE_TYPES.includes(type.path) ||
+            type === assignmentType ||
+            isSuperType(assignmentType, type)));
+};
+export const generateDefaultValueForPrimitiveType = (type) => {
+    switch (type) {
+        case PRIMITIVE_TYPE.STRING:
+            return '';
+        case PRIMITIVE_TYPE.BOOLEAN:
+            return false;
+        case PRIMITIVE_TYPE.NUMBER:
+        case PRIMITIVE_TYPE.DECIMAL:
+        case PRIMITIVE_TYPE.FLOAT:
+        case PRIMITIVE_TYPE.INTEGER:
+            return 0;
+        case PRIMITIVE_TYPE.DATE:
+        case PRIMITIVE_TYPE.STRICTDATE:
+            return format(new Date(Date.now()), DATE_FORMAT);
+        case PRIMITIVE_TYPE.DATETIME:
+            return format(new Date(Date.now()), DATE_TIME_FORMAT);
+        default:
+            throw new UnsupportedOperationError(`Can't generate default value for primitive type '${type}'`);
+    }
+};
+export const buildGenericLambdaFunctionInstanceValue = (lambdaParameterName, lambdaBodyExpressions, graph) => {
+    const multiplicityOne = graph.getTypicalMultiplicity(TYPICAL_MULTIPLICITY_TYPE.ONE);
+    const typeAny = graph.getType(CORE_PURE_PATH.ANY);
+    const functionInstanceValue = new LambdaFunctionInstanceValue(multiplicityOne);
+    const functionType = new FunctionType(typeAny, multiplicityOne);
+    functionType.parameters.push(new VariableExpression(lambdaParameterName, multiplicityOne));
+    const lambdaFunction = new LambdaFunction(functionType);
+    lambdaFunction.expressionSequence = lambdaBodyExpressions;
+    functionInstanceValue.values.push(lambdaFunction);
+    return functionInstanceValue;
+};
+/**
+ * Checks if the milestoning property expression is valid in terms of number of parameter values provided
+ * in relation to its milestoning type.
+ *
+ * NOTE: this takes date propgation into account. See the table below for all
+ * the combination:
+ *
+ *             | [source] |          |          |          |          |
+ * ----------------------------------------------------------------------
+ *   [target]  |          |   NONE   |  PR_TMP  |  BI_TMP  |  BU_TMP  |
+ * ----------------------------------------------------------------------
+ *             |   NONE   |   N.A.   |   PRD    | PRD,BUD  |    BUD   |
+ * ----------------------------------------------------------------------
+ *             |  PR_TMP  |   N.A.   |    X     | PRD,BUD  |    BUD   |
+ * ----------------------------------------------------------------------
+ *             |  BI_TMP  |   N.A.   |    X     |    X     |    X     |
+ * ----------------------------------------------------------------------
+ *             |  BU_TMP  |   N.A.   |   PRD    | PRD,BUD  |    X     |
+ * ----------------------------------------------------------------------
+ *
+ * Annotations:
+ *
+ * [source]: source temporal type
+ * [target]: target temporal type
+ *
+ * PR_TMP  : processing temporal
+ * BI_TMP  : bitemporal
+ * BU_TMP  : business temporal
+ *
+ * X       : no default date propagated
+ * PRD     : default processing date is propagated
+ * BUD     : default business date is propgated
+ */
+export const validatePropertyExpressionChain = (propertyExpression, graph) => {
+    if (propertyExpression.func.genericType.value.rawType instanceof Class &&
+        propertyExpression.func._OWNER._generatedMilestonedProperties.length !== 0) {
+        const name = propertyExpression.func.name;
+        const func = propertyExpression.func._OWNER._generatedMilestonedProperties.find((e) => e.name === name);
+        if (func) {
+            const targetStereotype = getMilestoneTemporalStereotype(propertyExpression.func.genericType.value.rawType, graph);
+            if (targetStereotype) {
+                const sourceStereotype = getDerivedPropertyMilestoningSteoreotype(guaranteeType(func, DerivedProperty), graph);
+                if (sourceStereotype !== MILESTONING_STEREOTYPE.BITEMPORAL &&
+                    targetStereotype !== sourceStereotype) {
+                    if (targetStereotype === MILESTONING_STEREOTYPE.BITEMPORAL) {
+                        if (propertyExpression.parametersValues.length !== 3 &&
+                            !sourceStereotype) {
+                            throw new UnsupportedOperationError(`Property of milestoning sterotype '${MILESTONING_STEREOTYPE.BITEMPORAL}' should have exactly two parameters`);
+                        }
+                        else if (propertyExpression.parametersValues.length < 2) {
+                            throw new UnsupportedOperationError(`Property of milestoning sterotype '${MILESTONING_STEREOTYPE.BITEMPORAL}' should have at least one parameter`);
+                        }
+                        else if (propertyExpression.parametersValues.length > 3) {
+                            throw new UnsupportedOperationError(`Property of milestoning sterotype '${MILESTONING_STEREOTYPE.BITEMPORAL}' should not have more than two parameters`);
+                        }
+                    }
+                    else if (propertyExpression.parametersValues.length !== 2) {
+                        throw new UnsupportedOperationError(`Property of milestoning sterotype '${targetStereotype}' should have exactly one parameter`);
+                    }
+                }
+            }
+        }
+    }
+};
+export const extractNullableStringFromInstanceValue = (value) => {
+    if (value instanceof PrimitiveInstanceValue && isString(value.values[0])) {
+        return value.values[0];
+    }
+    return undefined;
+};
+export const extractNullableNumberFromInstanceValue = (value) => {
+    if (value instanceof PrimitiveInstanceValue && isNumber(value.values[0])) {
+        return value.values[0];
+    }
+    return undefined;
+};
+//# sourceMappingURL=QueryBuilderValueSpecificationHelper.js.map

package/lib/stores/QueryBuilderValueSpecificationHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilderValueSpecificationHelper.js","sourceRoot":"","sources":["../../src/stores/QueryBuilderValueSpecificationHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAGL,cAAc,EACd,YAAY,EACZ,cAAc,EACd,2BAA2B,EAC3B,cAAc,EACd,yBAAyB,EACzB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EAEjB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EAGxB,0BAA0B,EAC1B,0BAA0B,EAC1B,WAAW,EACX,KAAK,EACL,8BAA8B,EAC9B,eAAe,EACf,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,yBAAyB,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,iCAAiC,EAAE,MAAM,mDAAmD,CAAC;AACtG,OAAO,EAAE,wCAAwC,EAAE,MAAM,sCAAsC,CAAC;AAEhG,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,kBAAsC,EACpB,EAAE;IACpB,IAAI,kBAAkB,YAAY,sBAAsB,EAAE;QACxD,OAAO,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;KACrD;SAAM,IAAI,kBAAkB,YAAY,sBAAsB,EAAE;QAC/D,OAAO,oBAAoB,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;KACxE;SAAM,IAAI,kBAAkB,YAAY,kBAAkB,EAAE;QAC3D,OAAO,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC;KACtD;SAAM,IAAI,kBAAkB,YAAY,wBAAwB,EAAE;QACjE,OAAO,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC;KACtD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,KAAgB,EAChB,MAA4B,EACV,EAAE;IACpB,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,YAAY,sBAAsB,CAAC,EAAE;QAChE,MAAM,mBAAmB,GAAkC,EAAE,CAAC;QAC7D,MAAmC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnD,MAAM,aAAa,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;YACpD,QAAQ,aAAa,CAAC,IAAI,EAAE;gBAC1B,KAAK,cAAc,CAAC,MAAM;oBACxB,cAAc,CACZ,mBAAmB,EACnB,KAAK,CAAC,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,CAC9C,CAAC;oBACF,MAAM;gBACR,KAAK,cAAc,CAAC,OAAO,CAAC;gBAC5B,KAAK,cAAc,CAAC,OAAO,CAAC;gBAC5B,KAAK,cAAc,CAAC,KAAK,CAAC;gBAC1B,KAAK,cAAc,CAAC,MAAM;oBACxB,cAAc,CACZ,mBAAmB,EACnB,KAAK,CAAC,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,CAC9C,CAAC;oBACF,MAAM;gBACR;oBACE,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBACpC,MAAM;aACT;QACH,CAAC,CAAC,CAAC;QACH,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;YAClC,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,mBAAmB,CAAC,CAAC,CAAkB,CAAC;KAChD;SAAM,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,YAAY,sBAAsB,CAAC,EAAE;QACvE,MAAM,qBAAqB,GAAkB,EAAE,CAAC;QAC/C,MAAmC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnD,cAAc,CACZ,qBAAqB,EACrB,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CACjD,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAI,qBAAqB,CAAC,MAAM,GAAG,CAAC,EAAE;YACpC,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,qBAAqB,CAAC,CAAC,CAAC,CAAC;KACjC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,UAAoC,EACE,EAAE;IACxC,IACE,iBAAiB,CACf,UAAU,CAAC,YAAY,EACvB,iCAAiC,CAAC,GAAG,CACtC,EACD;QACA,OAAO,aAAa,CAClB,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAC9B,wBAAwB,CACzB,CAAC;KACH;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAgB,EAChB,UAA8B,EACV,EAAE;IACtB,MAAM,eAAe,GAAG,KAAK,CAAC,sBAAsB,CAClD,yBAAyB,CAAC,GAAG,CAC9B,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,wBAAwB,CAChD,0BAA0B,CAAC,iCAAiC,CAAC,GAAG,CAAC,EACjE,eAAe,CAChB,CAAC;IACF,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAChD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAC/C,UAA0C,EACjC,EAAE;IACX,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,kBAAkB,GAAG,UAAU,CAAC;IACpC,OACE,kBAAkB;QAClB,kBAAkB,YAAY,0BAA0B,EACxD;QACA,IAAI,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,KAAK,CAAC,EAAE;YACzD,UAAU,GAAG,IAAI,CAAC;YAClB,MAAM;SACP;QACD,kBAAkB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/D,OAAO,kBAAkB,YAAY,wBAAwB,EAAE;YAC7D,kBAAkB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SAChE;KACF;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,IAAsB,EACtB,cAAoB,EACX,EAAE;IACX,MAAM,uBAAuB,GAAG;QAC9B,cAAc,CAAC,MAAM;QACrB,cAAc,CAAC,OAAO;QACtB,cAAc,CAAC,OAAO;QACtB,cAAc,CAAC,KAAK;KACT,CAAC;IACd,MAAM,oBAAoB,GAAG;QAC3B,cAAc,CAAC,IAAI;QACnB,cAAc,CAAC,QAAQ;QACvB,cAAc,CAAC,UAAU;QACzB,cAAc,CAAC,UAAU;KACd,CAAC;IAEd,uFAAuF;IACvF,OAAO,CACL,IAAI,KAAK,SAAS;QAClB,yDAAyD;QACzD,iDAAiD;QACjD,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3C,uBAAuB,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YACtD,uEAAuE;YACvE,yEAAyE;YACzE,uCAAuC;YACvC,qEAAqE;YACrE,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YACxC,IAAI,KAAK,cAAc;YACvB,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,CACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,IAAoB,EACX,EAAE;IACX,QAAQ,IAAI,EAAE;QACZ,KAAK,cAAc,CAAC,MAAM;YACxB,OAAO,EAAE,CAAC;QACZ,KAAK,cAAc,CAAC,OAAO;YACzB,OAAO,KAAK,CAAC;QACf,KAAK,cAAc,CAAC,MAAM,CAAC;QAC3B,KAAK,cAAc,CAAC,OAAO,CAAC;QAC5B,KAAK,cAAc,CAAC,KAAK,CAAC;QAC1B,KAAK,cAAc,CAAC,OAAO;YACzB,OAAO,CAAC,CAAC;QACX,KAAK,cAAc,CAAC,IAAI,CAAC;QACzB,KAAK,cAAc,CAAC,UAAU;YAC5B,OAAO,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC;QACnD,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC;QACxD;YACE,MAAM,IAAI,yBAAyB,CACjC,oDAAoD,IAAI,GAAG,CAC5D,CAAC;KACL;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CACrD,mBAA2B,EAC3B,qBAA2C,EAC3C,KAAgB,EACa,EAAE;IAC/B,MAAM,eAAe,GAAG,KAAK,CAAC,sBAAsB,CAClD,yBAAyB,CAAC,GAAG,CAC9B,CAAC;IACF,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,qBAAqB,GAAG,IAAI,2BAA2B,CAC3D,eAAe,CAChB,CAAC;IACF,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAChE,YAAY,CAAC,UAAU,CAAC,IAAI,CAC1B,IAAI,kBAAkB,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAC7D,CAAC;IACF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,YAAY,CAAC,CAAC;IACxD,cAAc,CAAC,kBAAkB,GAAG,qBAAqB,CAAC;IAC1D,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAClD,OAAO,qBAAqB,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC7C,kBAA8C,EAC9C,KAAgB,EACV,EAAE;IACR,IACE,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,YAAY,KAAK;QAClE,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,8BAA8B,CAAC,MAAM,KAAK,CAAC,EAC1E;QACA,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC1C,MAAM,IAAI,GACR,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,8BAA8B,CAAC,IAAI,CAChE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CACvB,CAAC;QACJ,IAAI,IAAI,EAAE;YACR,MAAM,gBAAgB,GAAG,8BAA8B,CACrD,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EACjD,KAAK,CACN,CAAC;YAEF,IAAI,gBAAgB,EAAE;gBACpB,MAAM,gBAAgB,GAAG,wCAAwC,CAC/D,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,EACpC,KAAK,CACN,CAAC;gBACF,IACE,gBAAgB,KAAK,sBAAsB,CAAC,UAAU;oBACtD,gBAAgB,KAAK,gBAAgB,EACrC;oBACA,IAAI,gBAAgB,KAAK,sBAAsB,CAAC,UAAU,EAAE;wBAC1D,IACE,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,KAAK,CAAC;4BAChD,CAAC,gBAAgB,EACjB;4BACA,MAAM,IAAI,yBAAyB,CACjC,sCAAsC,sBAAsB,CAAC,UAAU,sCAAsC,CAC9G,CAAC;yBACH;6BAAM,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;4BACzD,MAAM,IAAI,yBAAyB,CACjC,sCAAsC,sBAAsB,CAAC,UAAU,sCAAsC,CAC9G,CAAC;yBACH;6BAAM,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;4BACzD,MAAM,IAAI,yBAAyB,CACjC,sCAAsC,sBAAsB,CAAC,UAAU,4CAA4C,CACpH,CAAC;yBACH;qBACF;yBAAM,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;wBAC3D,MAAM,IAAI,yBAAyB,CACjC,sCAAsC,gBAAgB,qCAAqC,CAC5F,CAAC;qBACH;iBACF;aACF;SACF;KACF;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,KAAyB,EACL,EAAE;IACtB,IAAI,KAAK,YAAY,sBAAsB,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QACxE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACxB;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,KAAyB,EACL,EAAE;IACtB,IAAI,KAAK,YAAY,sBAAsB,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QACxE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACxB;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

package/lib/stores/explorer/QueryBuilderExplorerState.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { TreeNodeData, TreeData } from '@finos/legend-art';
+import { ActionState, type GeneratorFn } from '@finos/legend-shared';
+import { type AbstractProperty, type PureModel, type Type, type MappingModelCoverageAnalysisResult, type MappedEntity, AbstractPropertyExpression, Class, Multiplicity } from '@finos/legend-graph';
+import type { QueryBuilderState } from '../QueryBuilderState.js';
+import { type QueryBuilderPreviewData } from '../QueryBuilderPreviewDataHelper.js';
+import { QueryBuilderPropertySearchState } from './QueryBuilderPropertySearchState.js';
+export declare enum QUERY_BUILDER_EXPLORER_TREE_DND_TYPE {
+    ROOT = "ROOT",
+    CLASS_PROPERTY = "CLASS_PROPERTY",
+    ENUM_PROPERTY = "ENUM_PROPERTY",
+    PRIMITIVE_PROPERTY = "PRIMITIVE_PROPERTY"
+}
+export declare const generateExplorerTreePropertyNodeID: (parentId: string, propertyName: string) => string;
+export declare const generateExplorerTreeSubtypeNodeID: (parentId: string, subClassPath: string) => string;
+export interface QueryBuilderExplorerTreeDragSource {
+    node: QueryBuilderExplorerTreePropertyNodeData;
+}
+export declare abstract class QueryBuilderExplorerTreeNodeData implements TreeNodeData {
+    isSelected?: boolean | undefined;
+    isOpen?: boolean | undefined;
+    id: string;
+    label: string;
+    dndText: string;
+    childrenIds: string[];
+    isPartOfDerivedPropertyBranch: boolean;
+    type: Type;
+    mappingData: QueryBuilderExplorerTreeNodeMappingData;
+    constructor(id: string, label: string, dndText: string, isPartOfDerivedPropertyBranch: boolean, type: Type, mappingData: QueryBuilderExplorerTreeNodeMappingData);
+    setIsSelected(val: boolean | undefined): void;
+}
+export declare type QueryBuilderExplorerTreeNodeMappingData = {
+    mapped: boolean;
+    mappedEntity?: MappedEntity | undefined;
+};
+export declare class QueryBuilderExplorerTreeRootNodeData extends QueryBuilderExplorerTreeNodeData {
+}
+export declare class QueryBuilderExplorerTreePropertyNodeData extends QueryBuilderExplorerTreeNodeData {
+    property: AbstractProperty;
+    parentId: string;
+    constructor(id: string, label: string, dndText: string, property: AbstractProperty, parentId: string, isPartOfDerivedPropertyBranch: boolean, mappingData: QueryBuilderExplorerTreeNodeMappingData);
+}
+export declare class QueryBuilderExplorerTreeSubTypeNodeData extends QueryBuilderExplorerTreeNodeData {
+    subclass: Class;
+    parentId: string;
+    multiplicity: Multiplicity;
+    constructor(id: string, label: string, dndText: string, subclass: Class, parentId: string, isPartOfDerivedPropertyBranch: boolean, mappingData: QueryBuilderExplorerTreeNodeMappingData, multiplicity: Multiplicity);
+}
+export declare const buildPropertyExpressionFromExplorerTreeNodeData: (treeData: TreeData<QueryBuilderExplorerTreeNodeData>, node: QueryBuilderExplorerTreePropertyNodeData, graph: PureModel, allMappedPropertyNodes: QueryBuilderExplorerTreeNodeData[]) => AbstractPropertyExpression;
+export declare const generatePropertyNodeMappingData: (property: AbstractProperty, parentMappingData: QueryBuilderExplorerTreeNodeMappingData, modelCoverageAnalysisResult: MappingModelCoverageAnalysisResult) => QueryBuilderExplorerTreeNodeMappingData;
+export declare const generateSubtypeNodeMappingData: (subclass: Class, parentMappingData: QueryBuilderExplorerTreeNodeMappingData, modelCoverageAnalysisResult: MappingModelCoverageAnalysisResult) => QueryBuilderExplorerTreeNodeMappingData;
+export declare const getRootMappingData: (_class: Class, modelCoverageAnalysisResult: MappingModelCoverageAnalysisResult) => QueryBuilderExplorerTreeNodeMappingData;
+export declare const getQueryBuilderPropertyNodeData: (property: AbstractProperty, parentNode: QueryBuilderExplorerTreeNodeData, modelCoverageAnalysisResult: MappingModelCoverageAnalysisResult) => QueryBuilderExplorerTreePropertyNodeData | undefined;
+export declare const getQueryBuilderSubTypeNodeData: (subclass: Class, parentNode: QueryBuilderExplorerTreeNodeData, modelCoverageAnalysisResult: MappingModelCoverageAnalysisResult) => QueryBuilderExplorerTreeSubTypeNodeData;
+export declare class QueryBuilderExplorerPreviewDataState {
+    isGeneratingPreviewData: boolean;
+    propertyName: string;
+    previewData?: QueryBuilderPreviewData | undefined;
+    constructor();
+    setPropertyName(val: string): void;
+    setIsGeneratingPreviewData(val: boolean): void;
+    setPreviewData(val: QueryBuilderPreviewData | undefined): void;
+}
+export declare class QueryBuilderExplorerState {
+    queryBuilderState: QueryBuilderState;
+    previewDataState: QueryBuilderExplorerPreviewDataState;
+    treeData?: TreeData<QueryBuilderExplorerTreeNodeData> | undefined;
+    humanizePropertyName: boolean;
+    showUnmappedProperties: boolean;
+    highlightUsedProperties: boolean;
+    propertySearchState: QueryBuilderPropertySearchState;
+    mappingModelCoverageAnalysisResult?: MappingModelCoverageAnalysisResult;
+    mappingModelCoverageAnalysisState: ActionState;
+    constructor(queryBuilderState: QueryBuilderState);
+    get nonNullableTreeData(): TreeData<QueryBuilderExplorerTreeNodeData>;
+    setTreeData(val: TreeData<QueryBuilderExplorerTreeNodeData> | undefined): void;
+    refreshTree(): void;
+    setHumanizePropertyName(val: boolean): void;
+    setShowUnmappedProperties(val: boolean): void;
+    setHighlightUsedProperties(val: boolean): void;
+    refreshTreeData(): void;
+    analyzeMappingModelCoverage(): GeneratorFn<void>;
+    previewData(node: QueryBuilderExplorerTreePropertyNodeData): GeneratorFn<void>;
+}
+//# sourceMappingURL=QueryBuilderExplorerState.d.ts.map

package/lib/stores/explorer/QueryBuilderExplorerState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilderExplorerState.d.ts","sourceRoot":"","sources":["../../../src/stores/explorer/QueryBuilderExplorerState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAGL,WAAW,EAEX,KAAK,WAAW,EAGjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,IAAI,EACT,KAAK,kCAAkC,EAEvC,KAAK,YAAY,EAEjB,0BAA0B,EAC1B,KAAK,EAWL,YAAY,EAcb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAUjE,OAAO,EAGL,KAAK,uBAAuB,EAC7B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAGvF,oBAAY,oCAAoC;IAC9C,IAAI,SAAS;IACb,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,kBAAkB,uBAAuB;CAC1C;AAED,eAAO,MAAM,kCAAkC,aACnC,MAAM,gBACF,MAAM,KACnB,MAA4D,CAAC;AAEhE,eAAO,MAAM,iCAAiC,aAClC,MAAM,gBACF,MAAM,KACnB,MAAwE,CAAC;AAE5E,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,wCAAwC,CAAC;CAChD;AAED,8BAAsB,gCAAiC,YAAW,YAAY;IAC5E,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAM;IAC3B,6BAA6B,EAAE,OAAO,CAAC;IACvC,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,uCAAuC,CAAC;gBAGnD,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,6BAA6B,EAAE,OAAO,EACtC,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,uCAAuC;IAetD,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;CAG9C;AAED,oBAAY,uCAAuC,GAAG;IACpD,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,qBAAa,oCAAqC,SAAQ,gCAAgC;CAAG;AAE7F,qBAAa,wCAAyC,SAAQ,gCAAgC;IAC5F,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;gBAGf,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,MAAM,EAChB,6BAA6B,EAAE,OAAO,EACtC,WAAW,EAAE,uCAAuC;CAavD;AAED,qBAAa,uCAAwC,SAAQ,gCAAgC;IAC3F,QAAQ,EAAE,KAAK,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,YAAY,CAAC;gBAGzB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,MAAM,EAChB,6BAA6B,EAAE,OAAO,EACtC,WAAW,EAAE,uCAAuC,EACpD,YAAY,EAAE,YAAY;CAc7B;AAED,eAAO,MAAM,+CAA+C,aAChD,SAAS,gCAAgC,CAAC,QAC9C,wCAAwC,SACvC,SAAS,0BACQ,gCAAgC,EAAE,KACzD,0BAqFF,CAAC;AAEF,eAAO,MAAM,+BAA+B,aAChC,gBAAgB,qBACP,uCAAuC,+BAC7B,kCAAkC,KAC9D,uCAyBF,CAAC;AAEF,eAAO,MAAM,8BAA8B,aAC/B,KAAK,qBACI,uCAAuC,+BAC7B,kCAAkC,KAC9D,uCAsDF,CAAC;AAEF,eAAO,MAAM,kBAAkB,WACrB,KAAK,+BACgB,kCAAkC,KAC9D,uCAQF,CAAC;AAmBF,eAAO,MAAM,+BAA+B,aAChC,gBAAgB,cACd,gCAAgC,+BACf,kCAAkC,KAC9D,wCAAwC,GAAG,SAiD7C,CAAC;AAEF,eAAO,MAAM,8BAA8B,aAC/B,KAAK,cACH,gCAAgC,+BACf,kCAAkC,KAC9D,uCAqCF,CAAC;AAsDF,qBAAa,oCAAoC;IAC/C,uBAAuB,UAAS;IAChC,YAAY,SAAe;IAC3B,WAAW,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;;IAWlD,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIlC,0BAA0B,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI9C,cAAc,CAAC,GAAG,EAAE,uBAAuB,GAAG,SAAS,GAAG,IAAI;CAG/D;AAED,qBAAa,yBAAyB;IACpC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,gBAAgB,uCAA8C;IAC9D,QAAQ,CAAC,EAAE,QAAQ,CAAC,gCAAgC,CAAC,GAAG,SAAS,CAAC;IAClE,oBAAoB,UAAQ;IAC5B,sBAAsB,UAAS;IAC/B,uBAAuB,UAAQ;IAC/B,mBAAmB,EAAE,+BAA+B,CAAC;IACrD,kCAAkC,CAAC,EAAE,kCAAkC,CAAC;IACxE,iCAAiC,cAAwB;gBAE7C,iBAAiB,EAAE,iBAAiB;IAsBhD,IAAI,mBAAmB,IAAI,QAAQ,CAAC,gCAAgC,CAAC,CAKpE;IAED,WAAW,CACT,GAAG,EAAE,QAAQ,CAAC,gCAAgC,CAAC,GAAG,SAAS,GAC1D,IAAI;IAIP,WAAW,IAAI,IAAI;IAMnB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI3C,yBAAyB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI7C,0BAA0B,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAI9C,eAAe,IAAI,IAAI;IAatB,2BAA2B,IAAI,WAAW,CAAC,IAAI,CAAC;IAqBhD,WAAW,CACV,IAAI,EAAE,wCAAwC,GAC7C,WAAW,CAAC,IAAI,CAAC;CA4GrB"}