@finos/legend-query-builder 4.14.8 → 4.14.10

package/src/stores/QueryBuilderState.ts

@@ -104,6 +104,7 @@ import {
 } from './QueryBuilderExecutionContextState.js';
 import type { QueryBuilderConfig } from '../graph-manager/QueryBuilderConfig.js';
 import { QUERY_BUILDER_EVENT } from '../__lib__/QueryBuilderEvent.js';
+import { QueryBuilderChangeHistoryState } from './QueryBuilderChangeHistoryState.js';
 
 export interface QuerySDLC {}
 
@@ -136,6 +137,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   resultState: QueryBuilderResultState;
   textEditorState: QueryBuilderTextEditorState;
   unsupportedQueryState: QueryBuilderUnsupportedQueryState;
+  changeHistoryState: QueryBuilderChangeHistoryState;
   showFunctionsExplorerPanel = false;
   showParametersPanel = false;
   isEditingWatermark = false;
@@ -184,6 +186,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       isCheckingEntitlments: observable,
       isCalendarEnabled: observable,
       changeDetectionState: observable,
+      changeHistoryState: observable,
       executionContextState: observable,
       class: observable,
       isQueryChatOpened: observable,
@@ -236,6 +239,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       this.graphManagerState.pluginManager.getPureGraphManagerPlugins(),
     );
     this.changeDetectionState = new QueryBuilderChangeDetectionState(this);
+    this.changeHistoryState = new QueryBuilderChangeHistoryState(this);
     this.config = config;
     this.sourceInfo = sourceInfo;
   }
@@ -441,6 +445,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     this.explorerState.refreshTreeData();
     this.fetchStructureState.implementation.onClassChange(val);
     this.milestoningState.updateMilestoningConfiguration();
+    this.changeHistoryState.cacheNewQuery(this.buildQuery());
   }
 
   changeMapping(val: Mapping, options?: { keepQueryContent?: boolean }): void {
@@ -553,6 +558,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     });
     this.resetQueryResult();
     this.changeDetectionState.initialize(query);
+    this.changeHistoryState.initialize(query);
   }
 
   /**

package/src/stores/explorer/QueryBuilderExplorerState.ts

@@ -72,6 +72,7 @@ import { QueryBuilderPropertySearchState } from './QueryBuilderPropertySearchSta
 import { QUERY_BUILDER_SUPPORTED_FUNCTIONS } from '../../graph/QueryBuilderMetaModelConst.js';
 import { propertyExpression_setFunc } from '../shared/ValueSpecificationModifierHelper.js';
 import { QueryBuilderTelemetryHelper } from '../../__lib__/QueryBuilderTelemetryHelper.js';
+import { createRef } from 'react';
 
 export enum QUERY_BUILDER_EXPLORER_TREE_DND_TYPE {
   ROOT = 'ROOT',
@@ -97,6 +98,7 @@ export interface QueryBuilderExplorerTreeDragSource {
 export abstract class QueryBuilderExplorerTreeNodeData implements TreeNodeData {
   isSelected?: boolean | undefined;
   isOpen?: boolean | undefined;
+  isHighlighting?: boolean | undefined;
   id: string;
   label: string;
   dndText: string;
@@ -104,6 +106,7 @@ export abstract class QueryBuilderExplorerTreeNodeData implements TreeNodeData {
   isPartOfDerivedPropertyBranch: boolean;
   type: Type;
   mappingData: QueryBuilderExplorerTreeNodeMappingData;
+  elementRef: React.RefObject<HTMLDivElement>;
 
   constructor(
     id: string,
@@ -114,7 +117,9 @@ export abstract class QueryBuilderExplorerTreeNodeData implements TreeNodeData {
     mappingData: QueryBuilderExplorerTreeNodeMappingData,
   ) {
     makeObservable(this, {
+      isHighlighting: observable,
       isSelected: observable,
+      setIsHighlighting: action,
       setIsSelected: action,
     });
 
@@ -124,11 +129,16 @@ export abstract class QueryBuilderExplorerTreeNodeData implements TreeNodeData {
     this.isPartOfDerivedPropertyBranch = isPartOfDerivedPropertyBranch;
     this.type = type;
     this.mappingData = mappingData;
+    this.elementRef = createRef();
   }
 
   setIsSelected(val: boolean | undefined): void {
     this.isSelected = val;
   }
+
+  setIsHighlighting(val: boolean | undefined): void {
+    this.isHighlighting = val;
+  }
 }
 
 export type QueryBuilderExplorerTreeNodeMappingData = {
@@ -663,6 +673,7 @@ export class QueryBuilderExplorerState {
       setHumanizePropertyName: action,
       setShowUnmappedProperties: action,
       setHighlightUsedProperties: action,
+      highlightTreeNode: action,
       analyzeMappingModelCoverage: flow,
       previewData: flow,
     });
@@ -717,6 +728,30 @@ export class QueryBuilderExplorerState {
     );
   }
 
+  highlightTreeNode(key: string): void {
+    const nodeToHighlight = this.treeData?.nodes.get(key);
+    if (nodeToHighlight instanceof QueryBuilderExplorerTreePropertyNodeData) {
+      let nodeToOpen: QueryBuilderExplorerTreeNodeData | null =
+        this.treeData?.nodes.get(nodeToHighlight.parentId) ?? null;
+      while (nodeToOpen !== null) {
+        if (!nodeToOpen.isOpen) {
+          nodeToOpen.isOpen = true;
+        }
+        nodeToOpen =
+          nodeToOpen instanceof QueryBuilderExplorerTreePropertyNodeData
+            ? this.treeData?.nodes.get(nodeToOpen.parentId) ?? null
+            : null;
+      }
+      this.refreshTree();
+      nodeToHighlight.setIsHighlighting(true);
+      // scrollIntoView must be called in a setTimeout because it must happen after
+      // the tree nodes are recursively opened and the tree is refreshed.
+      setTimeout(() => {
+        nodeToHighlight.elementRef.current?.scrollIntoView();
+      }, 0);
+    }
+  }
+
   *analyzeMappingModelCoverage(): GeneratorFn<void> {
     // We will only refetch if the analysis result's mapping has changed.
     // This makes the assumption that the mapping has not been edited, which is a valid assumption since query is not for editing mappings

package/tsconfig.json

@@ -56,6 +56,7 @@
     "./src/graph-manager/protocol/pure/v1/V1_QueryBuilder_PureGraphManagerExtension.ts",
     "./src/graph-manager/protocol/pure/v1/V1_QueryValueSpecificationBuilderHelper.ts",
     "./src/stores/QueryBuilderChangeDetectionState.ts",
+    "./src/stores/QueryBuilderChangeHistoryState.ts",
     "./src/stores/QueryBuilderCommand.ts",
     "./src/stores/QueryBuilderConfig.ts",
     "./src/stores/QueryBuilderConstantsState.ts",