@finos/legend-query-builder 4.12.0 → 4.13.1

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

@@ -158,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/stores/QueryBuilderStateBuilder.ts

@@ -71,6 +71,7 @@ import {
   processTDSProjectExpression,
   processTDSProjectionColumnPropertyExpression,
   processTDSProjectionDerivationExpression,
+  processTDSSliceExpression,
   processTDSSortDirectionExpression,
   processTDSSortExpression,
   processTDSTakeExpression,
@@ -641,6 +642,15 @@ export class QueryBuilderValueSpecificationProcessor
         this.parentLambda,
       );
       return;
+    } else if (
+      matchFunctionName(functionName, QUERY_BUILDER_SUPPORTED_FUNCTIONS.SLICE)
+    ) {
+      processTDSSliceExpression(
+        valueSpecification,
+        this.queryBuilderState,
+        this.parentLambda,
+      );
+      return;
     } else if (
       matchFunctionName(functionName, [
         QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_ASC,

package/src/stores/fetch-structure/tds/QueryResultSetModifierState.ts

@@ -65,6 +65,7 @@ export class QueryResultSetModifierState implements Hashable {
   limit?: number | undefined;
   distinct = false;
   sortColumns: SortColumnState[] = [];
+  slice: [number, number] | undefined;
 
   constructor(tdsState: QueryBuilderTDSState) {
     makeObservable(this, {
@@ -72,12 +73,14 @@ export class QueryResultSetModifierState implements Hashable {
       limit: observable,
       distinct: observable,
       sortColumns: observable,
+      slice: observable.ref,
       setShowModal: action,
       setLimit: action,
       toggleDistinct: action,
       deleteSortColumn: action,
       addSortColumn: action,
       updateSortColumns: action,
+      setSlice: action,
       reset: action,
       hashCode: computed,
     });
@@ -111,6 +114,10 @@ export class QueryResultSetModifierState implements Hashable {
     );
   }
 
+  setSlice(slice: [number, number] | undefined): void {
+    this.slice = slice;
+  }
+
   reset(): void {
     this.sortColumns = [];
     this.distinct = false;

package/src/stores/fetch-structure/tds/projection/QueryBuilderProjectionStateBuilder.ts

@@ -27,11 +27,13 @@ import {
   V1_deserializeRawValueSpecification,
   V1_RawLambda,
   VariableExpression,
+  PrimitiveInstanceValue,
 } from '@finos/legend-graph';
 import {
   assertNonNullable,
   assertTrue,
   assertType,
+  guaranteeIsNumber,
   guaranteeNonNullable,
   guaranteeType,
   isNonNullable,
@@ -385,6 +387,68 @@ export const processTDSSortExpression = (
   );
 };
 
+export const processTDSSliceExpression = (
+  exp: SimpleFunctionExpression,
+  queryBuilderState: QueryBuilderState,
+  parentLambda: LambdaFunction,
+): void => {
+  // check parameters
+  assertTrue(
+    exp.parametersValues.length === 3,
+    `Can't process slice() expression: slice() expects 2 argument`,
+  );
+
+  // check preceding expression
+  const precedingExpression = guaranteeType(
+    exp.parametersValues[0],
+    SimpleFunctionExpression,
+    `Can't process slice() expression: only support slice() immediately following an expression`,
+  );
+  assertTrue(
+    matchFunctionName(precedingExpression.functionName, [
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_TAKE,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_DISTINCT,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_SORT,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_PROJECT,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_GROUP_BY,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_FILTER,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.OLAP_GROUPBY,
+    ]),
+    `Can't process slice() expression: only support slice() in TDS expression`,
+  );
+  QueryBuilderValueSpecificationProcessor.process(
+    precedingExpression,
+    parentLambda,
+    queryBuilderState,
+  );
+
+  // build state
+  if (
+    queryBuilderState.fetchStructureState.implementation instanceof
+    QueryBuilderTDSState
+  ) {
+    const tdsState = queryBuilderState.fetchStructureState.implementation;
+    const start = guaranteeIsNumber(
+      guaranteeType(
+        exp.parametersValues[1],
+        PrimitiveInstanceValue,
+        'Can`t process slice() function: first param should be a primitive instance value',
+      ).values[0],
+      'Can`t process slice() function: first param should be a number primitive instance value',
+    );
+
+    const end = guaranteeIsNumber(
+      guaranteeType(
+        exp.parametersValues[2],
+        PrimitiveInstanceValue,
+        'Can`t process slice() function: first param should be a primitive instance value',
+      ).values[0],
+      'Can`t process slice() function: first param should be a number primitive instance value',
+    );
+    tdsState.resultSetModifierState.setSlice([start, end]);
+  }
+};
+
 export const processTDSSortDirectionExpression = (
   expression: SimpleFunctionExpression,
   parentExpression: SimpleFunctionExpression | undefined,

package/src/stores/fetch-structure/tds/projection/QueryBuilderProjectionValueSpecificationBuilder.ts

@@ -136,6 +136,33 @@ const appendResultSetModifier = (
           takeFunction.parametersValues[1] = limit;
           currentExpression = takeFunction;
         }
+        // build slice()
+        if (resultModifierState.slice) {
+          const sliceStart = resultModifierState.slice[0];
+          const sliceEnd = resultModifierState.slice[1];
+          const startVal = new PrimitiveInstanceValue(
+            GenericTypeExplicitReference.create(
+              new GenericType(PrimitiveType.INTEGER),
+            ),
+          );
+          const endVal = new PrimitiveInstanceValue(
+            GenericTypeExplicitReference.create(
+              new GenericType(PrimitiveType.INTEGER),
+            ),
+          );
+          startVal.values = [sliceStart];
+          endVal.values = [sliceEnd];
+          const sliceFunction = new SimpleFunctionExpression(
+            extractElementNameFromPath(QUERY_BUILDER_SUPPORTED_FUNCTIONS.SLICE),
+          );
+          sliceFunction.parametersValues = [
+            currentExpression,
+            startVal,
+            endVal,
+          ];
+          currentExpression = sliceFunction;
+        }
+
         lambdaFunction.expressionSequence[0] = currentExpression;
         return lambdaFunction;
       }