@finos/legend-query-builder 4.14.18 → 4.14.20

package/src/stores/QueryBuilderConstantsState.ts

@@ -45,6 +45,7 @@ import {
   changeEntry,
   assertTrue,
   ActionState,
+  deepClone,
 } from '@finos/legend-shared';
 import { action, makeObservable, observable } from 'mobx';
 import { QUERY_BUILDER_STATE_HASH_STRUCTURE } from './QueryBuilderStateHashUtils.js';
@@ -386,3 +387,14 @@ export class QueryBuilderConstantsState implements Hashable {
     ]);
   }
 }
+
+export const cloneQueryBuilderConstantLambdaEditorState = (
+  state: QueryBuilderConstantLambdaEditorState,
+): QueryBuilderConstantLambdaEditorState => {
+  const clonedState = new QueryBuilderConstantLambdaEditorState(
+    deepClone(state.calculatedState),
+  );
+  clonedState.lambdaString = state.lambdaString;
+  clonedState.parserError = deepClone(state.parserError);
+  return clonedState;
+};

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;
@@ -53,13 +70,29 @@ export type QueryChatRenderer = (
   queryBuilderState: QueryBuilderState,
 ) => React.ReactNode;
 
+export type TemplateQueryPanelContentRenderer = (
+  queryBuilderState: QueryBuilderState,
+) => React.ReactNode;
+
 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
    */
@@ -79,4 +112,9 @@ export interface QueryBuilder_LegendApplicationPlugin_Extension
    * Get the list of query chat configurations
    */
   getExtraQueryChatRenderers?(): QueryChatRenderer[];
+
+  /**
+   * Get the list of template query panel content render
+   */
+  getExtraTemplateQueryPanelContentRenderer?(): TemplateQueryPanelContentRenderer[];
 }

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);

package/src/stores/watermark/QueryBuilderWatermarkState.ts

@@ -39,8 +39,6 @@ export class QueryBuilderWatermarkState implements Hashable {
       value: observable,
       isEditingWatermark: observable,
       setValue: action,
-      resetValue: action,
-      enableWatermark: action,
       setIsEditingWatermark: action,
       hashCode: computed,
     });
@@ -48,7 +46,7 @@ export class QueryBuilderWatermarkState implements Hashable {
     this.queryBuilderState = queryBuilderState;
   }
 
-  resetValue(): void {
+  getDefaultValue(): ValueSpecification {
     const watermarkConstant = new PrimitiveInstanceValue(
       GenericTypeExplicitReference.create(
         new GenericType(PrimitiveType.STRING),
@@ -56,21 +54,13 @@ export class QueryBuilderWatermarkState implements Hashable {
     );
 
     watermarkConstant.values = ['watermarkValue'];
-    this.setValue(watermarkConstant);
+    return watermarkConstant;
   }
 
   setIsEditingWatermark(val: boolean): void {
     this.isEditingWatermark = val;
   }
 
-  enableWatermark(): void {
-    if (this.value) {
-      this.setValue(undefined);
-    } else {
-      this.resetValue();
-    }
-  }
-
   setValue(val: ValueSpecification | undefined): void {
     this.value = val
       ? observe_ValueSpecification(val, this.queryBuilderState.observerContext)