@finos/legend-query-builder 4.14.19 → 4.14.21

package/src/components/result/tds/QueryBuilderTDSGridResult.tsx

@@ -99,7 +99,7 @@ const getLocalColDefs = (
       enableValue: true,
       ...getAggregationTDSColumnCustomizations(executionResult, colName),
     } as DataGridColumnDefinition;
-    const persistedColumn = resultState.gridConfig.columns.find(
+    const persistedColumn = resultState.gridConfig?.columns.find(
       (c) => c.colId === colName,
     );
     if (persistedColumn) {
@@ -240,6 +240,7 @@ export const QueryBuilderTDSGridResult = observer(
       resultState.setGridConfig({
         columns: columnAPi.getColumnState(),
         isPivotModeEnabled: columnAPi.isPivotMode(),
+        isLocalModeEnabled: true,
       });
     };
 
@@ -351,7 +352,7 @@ export const QueryBuilderTDSGridResult = observer(
               onGridReady={(params): void => {
                 setColumnApi(params.columnApi);
                 params.columnApi.setPivotMode(
-                  resultState.gridConfig.isPivotModeEnabled,
+                  Boolean(resultState.gridConfig?.isPivotModeEnabled),
                 );
               }}
               gridOptions={{

package/src/stores/QueryBuilderResultState.ts

@@ -31,6 +31,7 @@ import {
   type ExecutionResult,
   type RawLambda,
   type EXECUTION_SERIALIZATION_FORMAT,
+  type QueryGridConfig,
   GRAPH_MANAGER_EVENT,
   buildRawLambdaFromLambdaFunction,
   reportGraphAnalytics,
@@ -79,7 +80,8 @@ export interface QueryBuilderTDSResultCellCoordinate {
 
 type QueryBuilderDataGridConfig = {
   columns: DataGridColumnState[];
-  isPivotModeEnabled: boolean;
+  isPivotModeEnabled: boolean | undefined;
+  isLocalModeEnabled: boolean | undefined;
 };
 
 export class QueryBuilderResultState {
@@ -101,7 +103,7 @@ export class QueryBuilderResultState {
   mousedOverCell: QueryBuilderTDSResultCellData | null = null;
   isSelectingCells: boolean;
 
-  gridConfig!: QueryBuilderDataGridConfig;
+  gridConfig: QueryBuilderDataGridConfig | undefined;
 
   constructor(queryBuilderState: QueryBuilderState) {
     makeObservable(this, {
@@ -128,6 +130,7 @@ export class QueryBuilderResultState {
       setMouseOverCell: action,
       setQueryRunPromise: action,
       setIsQueryUsageViewerOpened: action,
+      handlePreConfiguredGridConfig: action,
       exportData: flow,
       runQuery: flow,
       cancelQuery: flow,
@@ -136,10 +139,7 @@ export class QueryBuilderResultState {
     this.isSelectingCells = false;
 
     this.selectedCells = [];
-    this.gridConfig = {
-      columns: [],
-      isPivotModeEnabled: false,
-    };
+    this.gridConfig = undefined;
     this.queryBuilderState = queryBuilderState;
     this.executionPlanState = new ExecutionPlanState(
       this.queryBuilderState.applicationStore,
@@ -147,7 +147,7 @@ export class QueryBuilderResultState {
     );
   }
 
-  setGridConfig(val: QueryBuilderDataGridConfig): void {
+  setGridConfig(val: QueryBuilderDataGridConfig | undefined): void {
     this.gridConfig = val;
   }
 
@@ -191,6 +191,26 @@ export class QueryBuilderResultState {
     this.isQueryUsageViewerOpened = val;
   }
 
+  handlePreConfiguredGridConfig(config: QueryGridConfig): void {
+    const newConfig = {
+      columns: config.columns as DataGridColumnState[],
+      isPivotModeEnabled: Boolean(config.isPivotModeEnabled),
+      isLocalModeEnabled: Boolean(config.isLocalModeEnabled),
+    };
+    this.setGridConfig(newConfig);
+  }
+
+  getQueryGridConfig(): QueryGridConfig | undefined {
+    if (this.gridConfig) {
+      return {
+        columns: this.gridConfig.columns as object[],
+        isPivotModeEnabled: Boolean(this.gridConfig.isPivotModeEnabled),
+        isLocalModeEnabled: Boolean(this.gridConfig.isLocalModeEnabled),
+      };
+    }
+    return undefined;
+  }
+
   get checkForStaleResults(): boolean {
     if (this.latestRunHashCode !== this.queryBuilderState.hashCode) {
       return true;

package/src/stores/QueryBuilderState.ts

@@ -53,6 +53,7 @@ import {
   type GraphManagerState,
   type ValueSpecification,
   type Type,
+  type QueryGridConfig,
   GRAPH_MANAGER_EVENT,
   CompilationError,
   extractSourceInformationCoordinates,
@@ -393,7 +394,10 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     );
   }
 
-  resetQueryResult(options?: { preserveResult?: boolean | undefined }): void {
+  resetQueryResult(options?: {
+    preserveResult?: boolean | undefined;
+    gridConfig?: QueryGridConfig | undefined;
+  }): void {
     const resultState = new QueryBuilderResultState(this);
     resultState.setPreviewLimit(this.resultState.previewLimit);
     if (options?.preserveResult) {
@@ -401,6 +405,10 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       resultState.setExecutionDuration(this.resultState.executionDuration);
       resultState.latestRunHashCode = this.resultState.latestRunHashCode;
     }
+    if (options?.gridConfig) {
+      this.isLocalModeEnabled = true;
+      resultState.handlePreConfiguredGridConfig(options.gridConfig);
+    }
     this.resultState = resultState;
   }
 
@@ -476,6 +484,14 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     return undefined;
   }
 
+  getGridConfig(): QueryGridConfig | undefined {
+    // for now we will only save in local mode
+    if (this.isLocalModeEnabled && this.resultState.gridConfig) {
+      return this.resultState.getQueryGridConfig();
+    }
+    return undefined;
+  }
+
   buildQuery(options?: { keepSourceInformation: boolean }): RawLambda {
     if (!this.isQuerySupported) {
       const parameters = this.parametersState.parameterStates.map((e) =>
@@ -552,11 +568,12 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   initializeWithQuery(
     query: RawLambda,
     defaultParameterValues?: Map<string, ValueSpecification>,
+    gridConfig?: QueryGridConfig,
   ): void {
     this.rebuildWithQuery(query, {
       defaultParameterValues,
     });
-    this.resetQueryResult();
+    this.resetQueryResult({ gridConfig });
     this.changeDetectionState.initialize(query);
     this.changeHistoryState.initialize(query);
   }

package/src/stores/QueryBuilder_LegendApplicationPlugin_Extension.ts

@@ -16,12 +16,29 @@
 
 import type { LegendApplicationPlugin } from '@finos/legend-application';
 import type { QueryBuilderState } from './QueryBuilderState.js';
-import type { QuerySearchSpecification } from '@finos/legend-graph';
+import type { QuerySearchSpecification, RawLambda } from '@finos/legend-graph';
 import type {
   DataAccessState,
   DatasetAccessInfo,
 } from './data-access/DataAccessState.js';
 
+export type CuratedTemplateQuery = {
+  title: string;
+  description: string | undefined;
+  query: RawLambda;
+  executionContextKey: string;
+};
+
+export type CuratedTemplateQuerySpecification = {
+  getCuratedTemplateQueries(
+    queryBuilderState: QueryBuilderState,
+  ): CuratedTemplateQuery[];
+  loadCuratedTemplateQuery(
+    templateQuery: CuratedTemplateQuery,
+    queryBuilderState: QueryBuilderState,
+  ): void;
+};
+
 export type LoadQueryFilterOption = {
   key: string;
   label: (queryBuilderState: QueryBuilderState) => string | undefined;
@@ -59,11 +76,23 @@ export type TemplateQueryPanelContentRenderer = (
 
 export interface QueryBuilder_LegendApplicationPlugin_Extension
   extends LegendApplicationPlugin {
+  /**
+   * Get the list of template query specifications
+   */
+  getCuratedTemplateQuerySpecifications?(): CuratedTemplateQuerySpecification[];
+
   /**
    * Get the list of filter options for query loader.
    */
   getExtraLoadQueryFilterOptions?(): LoadQueryFilterOption[];
 
+  /**
+   * Get the list of filter options related to template query
+   */
+  getQueryFilterOptionsRelatedToTemplateQuery?(): (
+    queryBuilderState: QueryBuilderState,
+  ) => string[];
+
   /**
    * Get the list of warehouse entitlement configurations
    */

package/src/stores/QueryLoaderState.ts

@@ -19,12 +19,13 @@ import {
   type GenericLegendApplicationStore,
 } from '@finos/legend-application';
 import {
-  type LightQuery,
   QuerySearchSpecification,
+  GRAPH_MANAGER_EVENT,
   type QueryInfo,
+  type LightQuery,
   type BasicGraphManagerState,
   type Query,
-  GRAPH_MANAGER_EVENT,
+  type RawLambda,
 } from '@finos/legend-graph';
 import {
   ActionState,
@@ -36,6 +37,7 @@ import {
 import { makeObservable, observable, action, flow } from 'mobx';
 import type { QueryBuilderState } from './QueryBuilderState.js';
 import type {
+  CuratedTemplateQuerySpecification,
   LoadQueryFilterOption,
   QueryBuilder_LegendApplicationPlugin_Extension,
 } from './QueryBuilder_LegendApplicationPlugin_Extension.js';
@@ -72,12 +74,15 @@ export class QueryLoaderState {
   showCurrentUserQueriesOnly = false; // TODO: if we start having more native filters, we should make them part of `extraFilters`
   extraFilters = new Map<string, boolean>();
   extraFilterOptions: LoadQueryFilterOption[] = [];
+  extraQueryFilterOptionsRelatedToTemplateQuery: string[] = [];
   queries: LightQuery[] = [];
+  curatedTemplateQuerySepcifications: CuratedTemplateQuerySpecification[] = [];
 
   isQueryLoaderDialogOpen = false;
+  isCuratedTemplateToggled = false;
   showingDefaultQueries = true;
   showPreviewViewer = false;
-  queryPreviewContent?: QueryInfo;
+  queryPreviewContent?: QueryInfo | { name: string; content: string };
 
   constructor(
     applicationStore: GenericLegendApplicationStore,
@@ -107,11 +112,14 @@ export class QueryLoaderState {
       showCurrentUserQueriesOnly: observable,
       showPreviewViewer: observable,
       searchText: observable,
+      isCuratedTemplateToggled: observable,
+      curatedTemplateQuerySepcifications: observable,
       setSearchText: action,
       setQueryLoaderDialogOpen: action,
       setQueries: action,
       setShowCurrentUserQueriesOnly: action,
       setShowPreviewViewer: action,
+      setIsCuratedTemplateToggled: action,
       searchQueries: flow,
       getPreviewQueryContent: flow,
       deleteQuery: flow,
@@ -134,6 +142,10 @@ export class QueryLoaderState {
       options.handleFetchDefaultQueriesFailure;
   }
 
+  setIsCuratedTemplateToggled(val: boolean): void {
+    this.isCuratedTemplateToggled = val;
+  }
+
   setSearchText(val: string): void {
     this.searchText = val;
   }
@@ -156,6 +168,7 @@ export class QueryLoaderState {
 
   reset(): void {
     this.setShowCurrentUserQueriesOnly(false);
+    this.setIsCuratedTemplateToggled(false);
   }
 
   *initialize(queryBuilderState: QueryBuilderState): GeneratorFn<void> {
@@ -168,12 +181,32 @@ export class QueryLoaderState {
             plugin as QueryBuilder_LegendApplicationPlugin_Extension
           ).getExtraLoadQueryFilterOptions?.() ?? [],
       );
+    this.extraQueryFilterOptionsRelatedToTemplateQuery =
+      this.applicationStore.pluginManager
+        .getApplicationPlugins()
+        .flatMap(
+          (plugin) =>
+            (plugin as QueryBuilder_LegendApplicationPlugin_Extension)
+              .getQueryFilterOptionsRelatedToTemplateQuery?.()(
+                guaranteeNonNullable(this.queryBuilderState),
+              )
+              .flat() ?? [],
+        );
     const extraFilters = this.extraFilterOptions.map((filterOption) =>
       filterOption.label(guaranteeNonNullable(this.queryBuilderState)),
     );
     extraFilters.forEach(
       (filter) => filter && this.extraFilters.set(filter, false),
     );
+    this.curatedTemplateQuerySepcifications =
+      this.applicationStore.pluginManager
+        .getApplicationPlugins()
+        .flatMap(
+          (plugin) =>
+            (
+              plugin as QueryBuilder_LegendApplicationPlugin_Extension
+            ).getCuratedTemplateQuerySpecifications?.() ?? [],
+        );
   }
 
   *searchQueries(searchText: string): GeneratorFn<void> {
@@ -287,17 +320,36 @@ export class QueryLoaderState {
     }
   }
 
-  *getPreviewQueryContent(queryId: string): GeneratorFn<void> {
+  *getPreviewQueryContent(
+    queryId: string | undefined,
+    template?: {
+      queryName: string;
+      queryContent: RawLambda;
+    },
+  ): GeneratorFn<void> {
     this.previewQueryState.inProgress();
     try {
-      const queryInfo = (yield this.graphManagerState.graphManager.getQueryInfo(
-        queryId,
-      )) as QueryInfo;
-      this.queryPreviewContent = queryInfo;
-      this.queryPreviewContent.content =
-        (yield this.graphManagerState.graphManager.prettyLambdaContent(
-          queryInfo.content,
-        )) as string;
+      if (queryId) {
+        const queryInfo =
+          (yield this.graphManagerState.graphManager.getQueryInfo(
+            queryId,
+          )) as QueryInfo;
+        this.queryPreviewContent = queryInfo;
+        this.queryPreviewContent.content =
+          (yield this.graphManagerState.graphManager.prettyLambdaContent(
+            queryInfo.content,
+          )) as string;
+      } else if (template) {
+        this.queryPreviewContent = {
+          name: template.queryName,
+          content: '',
+        } as QueryInfo;
+        this.queryPreviewContent.content =
+          (yield this.graphManagerState.graphManager.lambdaToPureCode(
+            template.queryContent,
+            true,
+          )) as string;
+      }
       this.previewQueryState.pass();
     } catch (error) {
       assertErrorThrown(error);