@finos/legend-query-builder 4.11.17 → 4.13.0

package/src/components/explorer/QueryBuilderMilestoningEditor.tsx

@@ -22,7 +22,6 @@ import {
   type VariableExpression,
   GenericType,
   GenericTypeExplicitReference,
-  MILESTONING_STEREOTYPE,
   observe_PrimitiveInstanceValue,
   PrimitiveInstanceValue,
   PRIMITIVE_TYPE,
@@ -38,6 +37,7 @@ import {
   ModalFooterButton,
   ModalHeader,
   PanelEntryDropZonePlaceholder,
+  PanelFormBooleanField,
   PanelFormSection,
 } from '@finos/legend-art';
 import { generateDefaultValueForPrimitiveType } from '../../stores/QueryBuilderValueSpecificationHelper.js';
@@ -52,18 +52,15 @@ import { VariableSelector } from '../shared/QueryBuilderVariableSelector.js';
 const MilestoningParameterEditor = observer(
   (props: {
     queryBuilderState: QueryBuilderState;
-    stereotype: MILESTONING_STEREOTYPE;
+    parameter: ValueSpecification;
+    setParameter: (val: ValueSpecification) => void;
   }) => {
-    const { queryBuilderState, stereotype } = props;
+    const { queryBuilderState, parameter, setParameter } = props;
     const handleDrop = useCallback(
       (item: QueryBuilderVariableDragSource): void => {
-        if (stereotype === MILESTONING_STEREOTYPE.BUSINESS_TEMPORAL) {
-          queryBuilderState.milestoningState.setBusinessDate(item.variable);
-        } else {
-          queryBuilderState.milestoningState.setProcessingDate(item.variable);
-        }
+        setParameter(item.variable);
       },
-      [queryBuilderState, stereotype],
+      [setParameter],
     );
     const [{ isDragOver }, dropConnector] = useDrop<
       QueryBuilderVariableDragSource,
@@ -85,18 +82,8 @@ const MilestoningParameterEditor = observer(
       }),
       [handleDrop],
     );
-    let milestoningParameter;
-    if (stereotype === MILESTONING_STEREOTYPE.BUSINESS_TEMPORAL) {
-      milestoningParameter = guaranteeNonNullable(
-        queryBuilderState.milestoningState.businessDate,
-      );
-    } else {
-      milestoningParameter = guaranteeNonNullable(
-        queryBuilderState.milestoningState.processingDate,
-      );
-    }
     const resetMilestoningParameter = (): void => {
-      const parameter = observe_PrimitiveInstanceValue(
+      const param = observe_PrimitiveInstanceValue(
         new PrimitiveInstanceValue(
           GenericTypeExplicitReference.create(
             new GenericType(PrimitiveType.STRICTDATE),
@@ -105,15 +92,11 @@ const MilestoningParameterEditor = observer(
         queryBuilderState.observerContext,
       );
       instanceValue_setValues(
-        parameter,
+        param,
         [generateDefaultValueForPrimitiveType(PRIMITIVE_TYPE.STRICTDATE)],
         queryBuilderState.observerContext,
       );
-      if (stereotype === MILESTONING_STEREOTYPE.BUSINESS_TEMPORAL) {
-        queryBuilderState.milestoningState.setBusinessDate(parameter);
-      } else {
-        queryBuilderState.milestoningState.setProcessingDate(parameter);
-      }
+      setParameter(param);
     };
 
     return (
@@ -123,20 +106,18 @@ const MilestoningParameterEditor = observer(
           label="Change Milestoning Parameter Value"
         >
           <BasicValueSpecificationEditor
-            valueSpecification={milestoningParameter}
+            valueSpecification={parameter}
             graph={queryBuilderState.graphManagerState.graph}
             obseverContext={queryBuilderState.observerContext}
             setValueSpecification={(val: ValueSpecification): void =>
-              stereotype === MILESTONING_STEREOTYPE.BUSINESS_TEMPORAL
-                ? queryBuilderState.milestoningState.setBusinessDate(val)
-                : queryBuilderState.milestoningState.setProcessingDate(val)
+              setParameter(val)
             }
             typeCheckOption={{
               expectedType: PrimitiveType.DATE,
             }}
             resetValue={resetMilestoningParameter}
             isConstant={queryBuilderState.constantState.isValueSpecConstant(
-              milestoningParameter,
+              parameter,
             )}
           />
         </PanelEntryDropZonePlaceholder>
@@ -156,7 +137,12 @@ const BiTemporalMilestoningEditor = observer(
           </div>
           <MilestoningParameterEditor
             queryBuilderState={queryBuilderState}
-            stereotype={MILESTONING_STEREOTYPE.PROCESSING_TEMPORAL}
+            parameter={guaranteeNonNullable(
+              queryBuilderState.milestoningState.processingDate,
+            )}
+            setParameter={(val: ValueSpecification): void =>
+              queryBuilderState.milestoningState.setProcessingDate(val)
+            }
           />
         </PanelFormSection>
         <PanelFormSection>
@@ -165,7 +151,12 @@ const BiTemporalMilestoningEditor = observer(
           </div>
           <MilestoningParameterEditor
             queryBuilderState={queryBuilderState}
-            stereotype={MILESTONING_STEREOTYPE.BUSINESS_TEMPORAL}
+            parameter={guaranteeNonNullable(
+              queryBuilderState.milestoningState.businessDate,
+            )}
+            setParameter={(val: ValueSpecification): void =>
+              queryBuilderState.milestoningState.setBusinessDate(val)
+            }
           />
         </PanelFormSection>
       </>
@@ -184,7 +175,12 @@ const BusinessTemporalMilestoningEditor = observer(
         <MilestoningParameterEditor
           key="BusinessDate"
           queryBuilderState={queryBuilderState}
-          stereotype={MILESTONING_STEREOTYPE.BUSINESS_TEMPORAL}
+          parameter={guaranteeNonNullable(
+            queryBuilderState.milestoningState.businessDate,
+          )}
+          setParameter={(val: ValueSpecification): void =>
+            queryBuilderState.milestoningState.setBusinessDate(val)
+          }
         />
       </PanelFormSection>
     );
@@ -202,7 +198,12 @@ const ProcessingTemporalMilestoningEditor = observer(
         <MilestoningParameterEditor
           key="BusinessDate"
           queryBuilderState={queryBuilderState}
-          stereotype={MILESTONING_STEREOTYPE.PROCESSING_TEMPORAL}
+          parameter={guaranteeNonNullable(
+            queryBuilderState.milestoningState.processingDate,
+          )}
+          setParameter={(val: ValueSpecification): void =>
+            queryBuilderState.milestoningState.setProcessingDate(val)
+          }
         />
       </PanelFormSection>
     );
@@ -238,6 +239,45 @@ const TemporalMilestoningEditor: React.FC<{
   }
 };
 
+const AllVersionsInRangelMilestoningParametersEditor = observer(
+  (props: { queryBuilderState: QueryBuilderState }) => {
+    const { queryBuilderState } = props;
+
+    return (
+      <div className="query-builder__milestoning-panel__all-versions-in-range-editor">
+        <PanelFormSection>
+          <div className="panel__content__form__section__header__label">
+            Start Date
+          </div>
+          <MilestoningParameterEditor
+            queryBuilderState={queryBuilderState}
+            parameter={guaranteeNonNullable(
+              queryBuilderState.milestoningState.startDate,
+            )}
+            setParameter={(val: ValueSpecification): void =>
+              queryBuilderState.milestoningState.setStartDate(val)
+            }
+          />
+        </PanelFormSection>
+        <PanelFormSection>
+          <div className="panel__content__form__section__header__label">
+            End Date
+          </div>
+          <MilestoningParameterEditor
+            queryBuilderState={queryBuilderState}
+            parameter={guaranteeNonNullable(
+              queryBuilderState.milestoningState.endDate,
+            )}
+            setParameter={(val: ValueSpecification): void =>
+              queryBuilderState.milestoningState.setEndDate(val)
+            }
+          />
+        </PanelFormSection>
+      </div>
+    );
+  },
+);
+
 export const MilestoningParametersEditor = observer(
   (props: { queryBuilderState: QueryBuilderState }) => {
     const { queryBuilderState } = props;
@@ -267,6 +307,37 @@ export const MilestoningParametersEditor = observer(
         >
           <ModalHeader title="Milestoning Parameters" />
           <ModalBody className="query-builder__variables__modal__body">
+            {milestoningState.isCurrentClassMilestoned && (
+              <PanelFormBooleanField
+                isReadOnly={false}
+                value={milestoningState.isAllVersionsEnabled}
+                name="all Versions"
+                prompt="Query All Milestoned Versions of the Root Class"
+                update={(value: boolean | undefined): void =>
+                  milestoningState.setAllVersions(value)
+                }
+              />
+            )}
+            {milestoningState.isAllVersionsEnabled &&
+              milestoningState.isCurrentClassSupportsVersionsInRange && (
+                <>
+                  <PanelFormBooleanField
+                    isReadOnly={false}
+                    value={milestoningState.isAllVersionsInRangeEnabled}
+                    name=" All Versions In Range"
+                    prompt="Optionally apply a date range to get All Versions for"
+                    update={(value: boolean | undefined): void =>
+                      milestoningState.setAllVersionsInRange(value)
+                    }
+                  />
+
+                  {milestoningState.isAllVersionsInRangeEnabled && (
+                    <AllVersionsInRangelMilestoningParametersEditor
+                      queryBuilderState={queryBuilderState}
+                    />
+                  )}
+                </>
+              )}
             <TemporalMilestoningEditor queryBuilderState={queryBuilderState} />
             <PanelFormSection>
               <div className="panel__content__form__section__header__label">

package/src/components/fetch-structure/QueryBuilderResultModifierPanel.tsx

@@ -202,6 +202,40 @@ export const QueryResultModifierModal = observer(
       );
     };
 
+    const handleSliceStartChange = (start: number, end: number): void => {
+      const slice: [number, number] = [start, end];
+      resultSetModifierState.setSlice(slice);
+    };
+
+    const clearSlice = (): void => {
+      resultSetModifierState.setSlice(undefined);
+    };
+
+    const addSlice = (): void => {
+      resultSetModifierState.setSlice([0, 1]);
+    };
+
+    const changeSliceStart: React.ChangeEventHandler<HTMLInputElement> = (
+      event,
+    ) => {
+      const currentSlice = resultSetModifierState.slice;
+      const val = event.target.value;
+      const start = typeof val === 'number' ? val : parseInt(val, 10);
+      if (currentSlice) {
+        handleSliceStartChange(start, currentSlice[1]);
+      }
+    };
+    const changeSliceEnd: React.ChangeEventHandler<HTMLInputElement> = (
+      event,
+    ) => {
+      const currentSlice = resultSetModifierState.slice;
+      const val = event.target.value;
+      const end = typeof val === 'number' ? val : parseInt(val, 10);
+      if (currentSlice) {
+        handleSliceStartChange(currentSlice[0], end);
+      }
+    };
+
     return (
       <Dialog
         open={Boolean(resultSetModifierState.showModal)}
@@ -258,6 +292,56 @@ export const QueryResultModifierModal = observer(
                   onChange={changeValue}
                 />
               </div>
+              <div className="panel__content__form__section">
+                <div className="panel__content__form__section__header__label">
+                  Slice
+                </div>
+                <div className="panel__content__form__section__header__prompt">
+                  Reduce the number of rows in the provided TDS, selecting the
+                  set of rows in the specified range between start and stop
+                </div>
+                {resultSetModifierState.slice ? (
+                  <>
+                    <div className="query-builder__result__slice">
+                      <input
+                        className="input--dark query-builder__result__slice__input"
+                        spellCheck={false}
+                        value={resultSetModifierState.slice[0]}
+                        onChange={changeSliceStart}
+                        type="number"
+                      />
+                      <div className="query-builder__result__slice__range">
+                        ..
+                      </div>
+                      <input
+                        className="input--dark query-builder__result__slice__input"
+                        spellCheck={false}
+                        value={resultSetModifierState.slice[1]}
+                        onChange={changeSliceEnd}
+                        type="number"
+                      />
+                      <button
+                        className="query-builder__projection__options__sort__remove-btn btn--dark btn--caution"
+                        onClick={clearSlice}
+                        tabIndex={-1}
+                        title="Remove"
+                      >
+                        <TimesIcon />
+                      </button>
+                    </div>
+                  </>
+                ) : (
+                  <div className="panel__content__form__section__list__new-item__add">
+                    <button
+                      className="panel__content__form__section__list__new-item__add-btn btn btn--dark"
+                      onClick={addSlice}
+                      tabIndex={-1}
+                    >
+                      Add Slice
+                    </button>
+                  </div>
+                )}
+              </div>
             </div>
           </ModalBody>
           <ModalFooter>

package/src/components/fetch-structure/QueryBuilderTDSPanel.tsx

@@ -1142,6 +1142,19 @@ export const QueryBuilderTDSPanel = observer(
                 )}
               </div>
             )}
+            {tdsState.resultSetModifierState.slice && (
+              <div className="query-builder__projection__result-modifier-prompt__group">
+                <div className="query-builder__projection__result-modifier-prompt__group__label">
+                  Slice
+                </div>
+                <div
+                  className="query-builder__projection__result-modifier-prompt__group__content"
+                  onClick={openResultSetModifierEditor}
+                >
+                  {`${tdsState.resultSetModifierState.slice[0]},${tdsState.resultSetModifierState.slice[1]}`}
+                </div>
+              </div>
+            )}
           </div>
           <div className="query-builder__projection__toolbar__actions">
             <button

package/src/graph/QueryBuilderMetaModelConst.ts

@@ -62,12 +62,16 @@ export enum QUERY_BUILDER_SUPPORTED_CALENDAR_AGGREGATION_FUNCTIONS {
   CALENDAR_YTD = 'meta::pure::functions::date::calendar::ytd',
 }
 
+export enum QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS {
+  GET_ALL = 'meta::pure::functions::collection::getAll',
+  GET_ALL_VERSIONS = 'meta::pure::functions::collection::getAllVersions',
+  GET_ALL_VERSIONS_IN_RANGE = 'meta::pure::functions::collection::getAllVersionsInRange',
+}
+
 export enum QUERY_BUILDER_SUPPORTED_FUNCTIONS {
   AND = 'meta::pure::functions::boolean::and',
   EXISTS = 'meta::pure::functions::collection::exists',
   FILTER = 'meta::pure::functions::collection::filter',
-  GET_ALL = 'meta::pure::functions::collection::getAll',
-  GET_ALL_VERSIONS = 'meta::pure::functions::collection::getAllVersions',
   NOT = 'meta::pure::functions::boolean::not',
   OR = 'meta::pure::functions::boolean::or',
   TAKE = 'meta::pure::functions::collection::take',
@@ -154,6 +158,9 @@ export enum QUERY_BUILDER_SUPPORTED_FUNCTIONS {
   // TOTDS
   TABLE_TO_TDS = 'meta::pure::tds::tableToTDS',
   TABLE_REFERENCE = 'meta::relational::functions::database::tableReference',
+
+  // SLICE
+  SLICE = 'meta::pure::functions::collection::slice',
 }
 
 export enum TDS_COLUMN_GETTER {

package/src/graph-manager/protocol/pure/QueryBuilder_PureProtocolProcessorPlugin.ts

@@ -19,6 +19,8 @@ import {
   V1_buildExistsFunctionExpression,
   V1_buildFilterFunctionExpression,
   V1_buildGetAllFunctionExpression,
+  V1_buildGetAllVersionsFunctionExpression,
+  V1_buildGetAllVersionsInRangeFunctionExpression,
   V1_buildGroupByFunctionExpression,
   V1_buildOLAPGroupByFunctionExpression,
   V1_buildProjectFunctionExpression,
@@ -45,6 +47,7 @@ import {
 import {
   QUERY_BUILDER_SUPPORTED_CALENDAR_AGGREGATION_FUNCTIONS,
   QUERY_BUILDER_SUPPORTED_FUNCTIONS,
+  QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS,
 } from '../../../graph/QueryBuilderMetaModelConst.js';
 
 export class QueryBuilder_PureProtocolProcessorPlugin extends PureProtocolProcessorPlugin {
@@ -67,7 +70,7 @@ export class QueryBuilder_PureProtocolProcessorPlugin extends PureProtocolProces
         if (
           matchFunctionName(
             functionName,
-            QUERY_BUILDER_SUPPORTED_FUNCTIONS.GET_ALL,
+            QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL,
           )
         ) {
           return V1_buildGetAllFunctionExpression(
@@ -77,6 +80,32 @@ export class QueryBuilder_PureProtocolProcessorPlugin extends PureProtocolProces
             compileContext,
             processingContext,
           );
+        } else if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL_VERSIONS_IN_RANGE,
+          )
+        ) {
+          return V1_buildGetAllVersionsInRangeFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        } else if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL_VERSIONS,
+          )
+        ) {
+          return V1_buildGetAllVersionsFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
         } else if (
           matchFunctionName(functionName, [
             QUERY_BUILDER_SUPPORTED_FUNCTIONS.FILTER,

package/src/graph-manager/protocol/pure/v1/V1_QueryValueSpecificationBuilderHelper.ts

@@ -390,6 +390,71 @@ export const V1_buildGetAllFunctionExpression = (
   return expression;
 };
 
+export const V1_buildGetAllVersionsInRangeFunctionExpression = (
+  functionName: string,
+  parameters: V1_ValueSpecification[],
+  openVariables: string[],
+  compileContext: V1_GraphBuilderContext,
+  processingContext: V1_ProcessingContext,
+): SimpleFunctionExpression => {
+  const expression = V1_buildGenericFunctionExpression(
+    functionName,
+    parameters,
+    openVariables,
+    compileContext,
+    processingContext,
+  );
+  const precedingExpression = expression.parametersValues[0];
+
+  assertType(
+    precedingExpression,
+    InstanceValue,
+    `Can't build getAllVersionsInRange() expression: only support getAllVersionsInRange() immediately following a class`,
+  );
+  const parameterValues = expression.parametersValues;
+  assertTrue(
+    parameterValues.length === 3,
+    `Can't build getAllVersionsInRange() expression: only support getAllVersionsRange() with start and end date`,
+  );
+  expression.genericType = precedingExpression.genericType;
+  expression.multiplicity = precedingExpression.multiplicity;
+
+  return expression;
+};
+
+export const V1_buildGetAllVersionsFunctionExpression = (
+  functionName: string,
+  parameters: V1_ValueSpecification[],
+  openVariables: string[],
+  compileContext: V1_GraphBuilderContext,
+  processingContext: V1_ProcessingContext,
+): SimpleFunctionExpression => {
+  const expression = V1_buildGenericFunctionExpression(
+    functionName,
+    parameters,
+    openVariables,
+    compileContext,
+    processingContext,
+  );
+  const precedingExpression = expression.parametersValues[0];
+
+  assertType(
+    precedingExpression,
+    InstanceValue,
+    `Can't build getAllVersions() expression: only support getAllVersions() immediately following a class`,
+  );
+
+  const parameterValues = expression.parametersValues;
+  assertTrue(
+    parameterValues.length === 1,
+    `Can't build getAllVersions() expression: only support getAllVersions() with no paremters`,
+  );
+  expression.genericType = precedingExpression.genericType;
+  expression.multiplicity = precedingExpression.multiplicity;
+
+  return expression;
+};
+
 export const V1_buildExistsFunctionExpression = (
   functionName: string,
   parameters: V1_ValueSpecification[],

package/src/stores/QueryBuilderState.ts

@@ -93,7 +93,10 @@ import { QueryBuilderWatermarkState } from './watermark/QueryBuilderWatermarkSta
 import { QueryBuilderConstantsState } from './QueryBuilderConstantsState.js';
 import { QueryBuilderCheckEntitlementsState } from './entitlements/QueryBuilderCheckEntitlementsState.js';
 import { QueryBuilderTDSState } from './fetch-structure/tds/QueryBuilderTDSState.js';
-import { QUERY_BUILDER_PURE_PATH } from '../graph/QueryBuilderMetaModelConst.js';
+import {
+  QUERY_BUILDER_PURE_PATH,
+  QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS,
+} from '../graph/QueryBuilderMetaModelConst.js';
 import type { QueryBuilderInternalizeState } from './QueryBuilderInternalizeState.js';
 import {
   QueryBuilderExternalExecutionContextState,
@@ -142,6 +145,8 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   isLocalModeEnabled = false;
 
   class?: Class | undefined;
+  getAllFunction: QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS =
+    QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL;
   executionContextState: QueryBuilderExecutionContextState;
   internalizeState?: QueryBuilderInternalizeState | undefined;
 
@@ -168,6 +173,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       fetchStructureState: observable,
       filterState: observable,
       watermarkState: observable,
+      milestoningState: observable,
       checkEntitlementsState: observable,
       resultState: observable,
       textEditorState: observable,
@@ -182,6 +188,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       class: observable,
       isQueryChatOpened: observable,
       isLocalModeEnabled: observable,
+      getAllFunction: observable,
 
       sideBarClassName: computed,
       isQuerySupported: computed,
@@ -195,6 +202,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       setClass: action,
       setIsQueryChatOpened: action,
       setIsLocalModeEnabled: action,
+      setGetAllFunction: action,
 
       resetQueryResult: action,
       resetQueryContent: action,
@@ -339,6 +347,10 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     this.executionContextState = val;
   }
 
+  setGetAllFunction(val: QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS): void {
+    this.getAllFunction = val;
+  }
+
   get isQuerySupported(): boolean {
     return !this.unsupportedQueryState.rawLambda;
   }
@@ -356,13 +368,19 @@ export abstract class QueryBuilderState implements CommandRegistrar {
 
   // Used to determine if variable is used within query
   // For places where we don't know, we will assume the variable is not used (i.e projection derivation column)
-  isVariableUsed(variable: VariableExpression): boolean {
-    return (
-      this.milestoningState.isVariableUsed(variable) ||
+  isVariableUsed(
+    variable: VariableExpression,
+    options?: {
+      exculdeMilestoningState: boolean;
+    },
+  ): boolean {
+    const isVariableUsedInBody =
       this.filterState.isVariableUsed(variable) ||
       this.watermarkState.isVariableUsed(variable) ||
-      this.fetchStructureState.implementation.isVariableUsed(variable)
-    );
+      this.fetchStructureState.implementation.isVariableUsed(variable);
+    return options?.exculdeMilestoningState
+      ? isVariableUsedInBody
+      : this.milestoningState.isVariableUsed(variable) || isVariableUsedInBody;
   }
 
   deregisterCommands(): void {
@@ -418,6 +436,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   changeClass(val: Class): void {
     this.resetQueryResult();
     this.resetQueryContent();
+    this.setGetAllFunction(QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL);
     this.setClass(val);
     this.explorerState.refreshTreeData();
     this.fetchStructureState.implementation.onClassChange(val);