@finos/legend-query-builder 4.14.30 → 4.14.32

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

@@ -0,0 +1,103 @@
+/**
+ * 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 LambdaFunction,
+  SimpleFunctionExpression,
+  matchFunctionName,
+  ColSpecArrayInstance,
+} from '@finos/legend-graph';
+import { FETCH_STRUCTURE_IMPLEMENTATION } from '../../QueryBuilderFetchStructureImplementationState.js';
+import { assertTrue, assertType, guaranteeType } from '@finos/legend-shared';
+import {
+  QUERY_BUILDER_LAMBDA_WRITER_MODE,
+  type QueryBuilderState,
+} from '../../../QueryBuilderState.js';
+import {
+  QUERY_BUILDER_SUPPORTED_FUNCTIONS,
+  QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS,
+} from '../../../../graph/QueryBuilderMetaModelConst.js';
+import { QueryBuilderValueSpecificationProcessor } from '../../../QueryBuilderStateBuilder.js';
+
+export const processTypedTDSProjectExpression = (
+  expression: SimpleFunctionExpression,
+  queryBuilderState: QueryBuilderState,
+  parentLambda: LambdaFunction,
+): void => {
+  // check parameters
+  assertTrue(
+    expression.parametersValues.length === 2,
+    `Can't process typed project() expression: typed project() expects 2 arguments`,
+  );
+  // update fetch-structure
+  queryBuilderState.fetchStructureState.changeImplementation(
+    FETCH_STRUCTURE_IMPLEMENTATION.TABULAR_DATA_STRUCTURE,
+  );
+
+  // check preceding expression
+  const precedingExpression = guaranteeType(
+    expression.parametersValues[0],
+    SimpleFunctionExpression,
+    `Can't process typed project() expression: only support typed project() immediately following an expression`,
+  );
+  assertTrue(
+    matchFunctionName(precedingExpression.functionName, [
+      QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL,
+      QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL_VERSIONS,
+      QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL_VERSIONS_IN_RANGE,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.FILTER,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.WATERMARK,
+    ]),
+    `Can't process typed project() expression: only support typed project() immediately following either getAll(), filter(), or forWatermark()`,
+  );
+  QueryBuilderValueSpecificationProcessor.process(
+    precedingExpression,
+    parentLambda,
+    queryBuilderState,
+  );
+  // check columns
+  const classInstance = expression.parametersValues[1];
+  assertType(
+    classInstance,
+    ColSpecArrayInstance,
+    `Can't process typed project() expression: typed project() expects argument #1 to be a ColSpec Array Instance`,
+  );
+  queryBuilderState.setLambdaWriteMode(
+    QUERY_BUILDER_LAMBDA_WRITER_MODE.TYPED_FETCH_STRUCTURE,
+  );
+  QueryBuilderValueSpecificationProcessor.processChild(
+    classInstance,
+    expression,
+    parentLambda,
+    queryBuilderState,
+  );
+};
+
+export const isTypedProjectionExpression = (
+  expression: SimpleFunctionExpression,
+): boolean => {
+  if (
+    matchFunctionName(expression.functionName, [
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_PROJECT,
+      QUERY_BUILDER_SUPPORTED_FUNCTIONS.RELATION_PROJECT,
+    ])
+  ) {
+    if (expression.parametersValues.length === 2) {
+      return expression.parametersValues[1] instanceof ColSpecArrayInstance;
+    }
+  }
+  return false;
+};

package/src/stores/query-workflow/QueryBuilderWorkFlowState.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { QueryBuilderState } from '../QueryBuilderState.js';
+
+export interface FetchStructureLayoutConfig {
+  label: string;
+  showInFetchPanel: boolean;
+}
+
+export abstract class QueryBuilderWorkflowState {
+  abstract get showStatusBar(): boolean;
+
+  abstract getFetchStructureLayoutConfig(
+    state: QueryBuilderState,
+  ): FetchStructureLayoutConfig;
+}
+
+export class QueryBuilderAdvancedWorkflowState extends QueryBuilderWorkflowState {
+  get showStatusBar(): boolean {
+    return true;
+  }
+
+  override getFetchStructureLayoutConfig(
+    state: QueryBuilderState,
+  ): FetchStructureLayoutConfig {
+    return {
+      label: 'fetch structure',
+      showInFetchPanel: true,
+    };
+  }
+
+  static INSTANCE = new QueryBuilderAdvancedWorkflowState();
+}
+
+export class QueryBuilderDataBrowserWorkflow extends QueryBuilderWorkflowState {
+  override get showStatusBar(): boolean {
+    return false;
+  }
+
+  override getFetchStructureLayoutConfig(
+    state: QueryBuilderState,
+  ): FetchStructureLayoutConfig {
+    return {
+      label: state.fetchStructureState.implementation.fetchLabel,
+      showInFetchPanel: false,
+    };
+  }
+
+  static readonly INSTANCE = new QueryBuilderDataBrowserWorkflow();
+}

package/src/stores/workflows/FunctionQueryBuilderState.ts

@@ -21,7 +21,7 @@ import type {
 } from '@finos/legend-graph';
 import { ClassQueryBuilderState } from './ClassQueryBuilderState.js';
 import type { QueryBuilderConfig } from '../../graph-manager/QueryBuilderConfig.js';
-import type { QueryBuilderWorkflowState } from '../workflow/QueryBuilderWorkFlowState.js';
+import type { QueryBuilderWorkflowState } from '../query-workflow/QueryBuilderWorkFlowState.js';
 
 // Note: We may want to move it to extend QueryBuilderState directly
 // but for now we will use the same setup as class as class, mapping, runtime are editable

package/src/stores/workflows/MappingQueryBuilderState.ts

@@ -28,7 +28,7 @@ import { getNullableFirstEntry } from '@finos/legend-shared';
 import { renderMappingQueryBuilderSetupPanelContent } from '../../components/workflows/MappingQueryBuilder.js';
 import { QueryBuilderState } from '../QueryBuilderState.js';
 import type { QueryBuilderConfig } from '../../graph-manager/QueryBuilderConfig.js';
-import type { QueryBuilderWorkflowState } from '../workflow/QueryBuilderWorkFlowState.js';
+import type { QueryBuilderWorkflowState } from '../query-workflow/QueryBuilderWorkFlowState.js';
 
 export class MappingQueryBuilderState extends QueryBuilderState {
   readonly onMappingChange?: ((val: Mapping) => void) | undefined;

package/src/stores/workflows/ServiceQueryBuilderState.ts

@@ -34,7 +34,7 @@ import { action, makeObservable, observable } from 'mobx';
 import { renderServiceQueryBuilderSetupPanelContent } from '../../components/workflows/ServiceQueryBuilder.js';
 import { QueryBuilderState } from '../QueryBuilderState.js';
 import type { QueryBuilderConfig } from '../../graph-manager/QueryBuilderConfig.js';
-import type { QueryBuilderWorkflowState } from '../workflow/QueryBuilderWorkFlowState.js';
+import type { QueryBuilderWorkflowState } from '../query-workflow/QueryBuilderWorkFlowState.js';
 
 export type ServiceExecutionContext = {
   key: string;

package/tsconfig.json

@@ -92,6 +92,7 @@
     "./src/stores/fetch-structure/graph-fetch/QueryBuilderGraphFetchTreeStateBuilder.ts",
     "./src/stores/fetch-structure/graph-fetch/QueryBuilderGraphFetchTreeUtil.ts",
     "./src/stores/fetch-structure/graph-fetch/QueryBuilderGraphFetchTreeValueSpecificationBuilder.ts",
+    "./src/stores/fetch-structure/tds/QueryBuilderAdvancedWorkflowState.ts",
     "./src/stores/fetch-structure/tds/QueryBuilderTDSColumnState.ts",
     "./src/stores/fetch-structure/tds/QueryBuilderTDSHelper.ts",
     "./src/stores/fetch-structure/tds/QueryBuilderTDSState.ts",
@@ -134,6 +135,8 @@
     "./src/stores/fetch-structure/tds/projection/QueryBuilderProjectionColumnState.ts",
     "./src/stores/fetch-structure/tds/projection/QueryBuilderProjectionStateBuilder.ts",
     "./src/stores/fetch-structure/tds/projection/QueryBuilderProjectionValueSpecificationBuilder.ts",
+    "./src/stores/fetch-structure/tds/projection/QueryBuilderRelationProjectValueSpecBuidler.ts",
+    "./src/stores/fetch-structure/tds/projection/QueryBuilderTypedProjectionStateBuilder.ts",
     "./src/stores/fetch-structure/tds/window/QueryBuilderWindowGroupByOperatorLoader.ts",
     "./src/stores/fetch-structure/tds/window/QueryBuilderWindowState.ts",
     "./src/stores/fetch-structure/tds/window/QueryBuilderWindowStateBuilder.ts",
@@ -170,6 +173,7 @@
     "./src/stores/milestoning/QueryBuilderMilestoningImplementation.ts",
     "./src/stores/milestoning/QueryBuilderMilestoningState.ts",
     "./src/stores/milestoning/QueryBuilderProcessingTemporalMilestoningImplementation.ts",
+    "./src/stores/query-workflow/QueryBuilderWorkFlowState.ts",
     "./src/stores/shared/LambdaEditorState.ts",
     "./src/stores/shared/LambdaParameterState.ts",
     "./src/stores/shared/ValueSpecificationEditorHelper.ts",
@@ -177,7 +181,6 @@
     "./src/stores/watermark/QueryBuilderWatermarkState.ts",
     "./src/stores/watermark/QueryBuilderWatermarkStateBuilder.ts",
     "./src/stores/watermark/QueryBuilderWatermarkValueSpecificationBuilder.ts",
-    "./src/stores/workflow/QueryBuilderWorkFlowState.ts",
     "./src/stores/workflows/ClassQueryBuilderState.ts",
     "./src/stores/workflows/FunctionQueryBuilderState.ts",
     "./src/stores/workflows/MappingQueryBuilderState.ts",

package/lib/stores/workflow/QueryBuilderWorkFlowState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryBuilderWorkFlowState.d.ts","sourceRoot":"","sources":["../../../src/stores/workflow/QueryBuilderWorkFlowState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,8BAAsB,yBAAyB;IAC7C,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC;CACvC;AAED,qBAAa,iCAAkC,SAAQ,yBAAyB;IAC9E,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED,MAAM,CAAC,QAAQ,oCAA2C;CAC3D"}

package/lib/stores/workflow/QueryBuilderWorkFlowState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryBuilderWorkFlowState.js","sourceRoot":"","sources":["../../../src/stores/workflow/QueryBuilderWorkFlowState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,OAAgB,yBAAyB;CAE9C;AAED,MAAM,OAAO,iCAAkC,SAAQ,yBAAyB;IAC9E,IAAI,aAAa;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,QAAQ,GAAG,IAAI,iCAAiC,EAAE,CAAC"}