@finos/legend-query-builder 4.14.36 → 4.14.38

package/src/components/workflows/MappingQueryBuilder.tsx

@@ -17,6 +17,7 @@
 import {
   CustomSelectorInput,
   PanelHeader,
+  compareLabelFn,
   createFilter,
 } from '@finos/legend-art';
 import { observer } from 'mobx-react-lite';
@@ -59,7 +60,7 @@ const MappingQueryBuilderSetupPanelContent = observer(
     // mapping
     const mappingOptions = queryBuilderState.graphManagerState.usableMappings
       .map(buildElementOption)
-      .sort((a, b) => a.label.localeCompare(b.label));
+      .sort(compareLabelFn);
     const selectedMappingOption = queryBuilderState.executionContextState
       .mapping
       ? buildElementOption(queryBuilderState.executionContextState.mapping)
@@ -93,7 +94,7 @@ const MappingQueryBuilderSetupPanelContent = observer(
           new RuntimePointer(PackageableElementExplicitReference.create(rt)),
       )
       .map(buildRuntimeValueOption)
-      .sort((a, b) => a.label.localeCompare(b.label));
+      .sort(compareLabelFn);
     const selectedRuntimeOption = queryBuilderState.executionContextState
       .runtimeValue
       ? buildRuntimeValueOption(

package/src/components/workflows/ServiceQueryBuilder.tsx

@@ -14,7 +14,11 @@
  * limitations under the License.
  */
 
-import { CustomSelectorInput, PanelHeader } from '@finos/legend-art';
+import {
+  CustomSelectorInput,
+  PanelHeader,
+  compareLabelFn,
+} from '@finos/legend-art';
 import { observer } from 'mobx-react-lite';
 import { getMappingCompatibleClasses, type Service } from '@finos/legend-graph';
 import { useApplicationStore } from '@finos/legend-application';
@@ -57,7 +61,7 @@ const ServiceQueryBuilderSetupPanelContent = observer(
     const serviceOptions =
       queryBuilderState.usableServices
         ?.map(buildElementOption)
-        .sort((a, b) => a.label.localeCompare(b.label)) ?? [];
+        .sort(compareLabelFn) ?? [];
     const selectedServiceOption = buildElementOption(queryBuilderState.service);
     const onServiceOptionChange = (
       option: PackageableElementOption<Service>,
@@ -71,7 +75,7 @@ const ServiceQueryBuilderSetupPanelContent = observer(
     // execution context
     const executionContextOptions = queryBuilderState.executionContexts
       .map(buildExecutionContextOption)
-      .sort((a, b) => a.label.localeCompare(b.label));
+      .sort(compareLabelFn);
     const selectedExecutionContextOption =
       queryBuilderState.selectedExecutionContext
         ? buildExecutionContextOption(

package/src/stores/QueryBuilderTextEditorState.ts

@@ -67,6 +67,7 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
    * TODO: consider moving this to another state if we need to simplify the logic of text-mode
    */
   readOnlylambdaJson = '';
+  isReadOnly: boolean | undefined;
 
   constructor(queryBuilderState: QueryBuilderState) {
     super('', '');
@@ -75,7 +76,9 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
       rawLambdaState: observable,
       isConvertingLambdaToString: observable,
       mode: observable,
+      isReadOnly: observable,
       setQueryRawLambdaState: action,
+      setIsReadOnly: action,
       setMode: action,
       openModal: action,
       closeModal: flow,
@@ -89,10 +92,23 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
     return buildSourceInformationSourceId(['query-builder']);
   }
 
+  get text(): string | undefined {
+    if (this.mode === QueryBuilderTextEditorMode.TEXT) {
+      return this.fullLambdaString;
+    } else if (this.mode === QueryBuilderTextEditorMode.JSON) {
+      return this.readOnlylambdaJson;
+    }
+    return undefined;
+  }
+
   setQueryRawLambdaState(rawLambdaState: QueryBuilderRawLambdaState): void {
     this.rawLambdaState = rawLambdaState;
   }
 
+  setIsReadOnly(val: boolean | undefined): void {
+    this.isReadOnly = val;
+  }
+
   setMode(openModal: QueryBuilderTextEditorMode | undefined): void {
     this.mode = openModal;
   }
@@ -170,7 +186,7 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
     }
   }
 
-  openModal(mode: QueryBuilderTextEditorMode): void {
+  openModal(mode: QueryBuilderTextEditorMode, isReadOnly?: boolean): void {
     try {
       const rawLambda = this.queryBuilderState.buildQuery();
       if (mode === QueryBuilderTextEditorMode.TEXT) {
@@ -190,6 +206,7 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
         );
       }
       this.setMode(mode);
+      this.setIsReadOnly(isReadOnly);
     } catch (error) {
       assertErrorThrown(error);
       this.queryBuilderState.applicationStore.notificationService.notifyError(
@@ -200,7 +217,7 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
 
   *closeModal(): GeneratorFn<void> {
     this.closingQueryState.inProgress();
-    if (this.mode === QueryBuilderTextEditorMode.TEXT) {
+    if (this.mode === QueryBuilderTextEditorMode.TEXT && !this.isReadOnly) {
       yield flowResult(this.convertLambdaGrammarStringToObject());
       if (this.parserError) {
         this.queryBuilderState.applicationStore.notificationService.notifyError(
@@ -215,6 +232,7 @@ export class QueryBuilderTextEditorState extends LambdaEditorState {
       }
       return;
     }
+    this.setIsReadOnly(undefined);
     this.closingQueryState.complete();
 
     this.setMode(undefined);

package/src/stores/QueryBuilder_LegendApplicationPlugin_Extension.ts

@@ -83,6 +83,17 @@ export type QueryBuilderHeaderActionConfiguration = {
   ) => React.ReactNode | undefined;
 };
 
+export type QueryBuilderMenuActionConfiguration = {
+  key: string;
+  title?: string;
+  label: string;
+  onClick: (queryBuilderState: QueryBuilderState) => void;
+  icon?: React.ReactNode;
+  renderExtraComponent?: (
+    queryBuilderState: QueryBuilderState,
+  ) => React.ReactNode;
+};
+
 export interface QueryBuilder_LegendApplicationPlugin_Extension
   extends LegendApplicationPlugin {
   /**
@@ -136,4 +147,14 @@ export interface QueryBuilder_LegendApplicationPlugin_Extension
    * Get the list of action configurations
    */
   getExtraQueryBuilderHeaderTitleConfigurations?(): QueryBuilderHeaderActionConfiguration[];
+
+  /**
+   * Get the list of help menu action configurations
+   */
+  getExtraQueryBuilderHelpMenuActionConfigurations?(): QueryBuilderMenuActionConfiguration[];
+
+  /**
+   * Get the list of export menu action configurations
+   */
+  getExtraQueryBuilderExportMenuActionConfigurations?(): QueryBuilderMenuActionConfiguration[];
 }

package/src/stores/QueryLoaderState.ts

@@ -65,7 +65,7 @@ export class QueryLoaderState {
 
   readonly isReadOnly?: boolean | undefined;
   readonly onQueryRenamed?: ((query: LightQuery) => void) | undefined;
-  readonly onQueryDeleted?: ((query: LightQuery) => void) | undefined;
+  readonly onQueryDeleted?: ((query: string) => void) | undefined;
   readonly handleFetchDefaultQueriesFailure?: (() => void) | undefined;
 
   queryBuilderState?: QueryBuilderState | undefined;
@@ -100,7 +100,7 @@ export class QueryLoaderState {
 
       isReadOnly?: boolean | undefined;
       onQueryRenamed?: ((query: LightQuery) => void) | undefined;
-      onQueryDeleted?: ((query: LightQuery) => void) | undefined;
+      onQueryDeleted?: ((query: string) => void) | undefined;
       handleFetchDefaultQueriesFailure?: (() => void) | undefined;
     },
   ) {
@@ -304,11 +304,9 @@ export class QueryLoaderState {
   *deleteQuery(queryId: string): GeneratorFn<void> {
     this.deleteQueryState.inProgress();
     try {
-      const query = (yield this.graphManagerState.graphManager.deleteQuery(
-        queryId,
-      )) as Query;
-      this.onQueryDeleted?.(query);
-      this.applicationStore.notificationService.notify(
+      yield this.graphManagerState.graphManager.deleteQuery(queryId);
+      this.onQueryDeleted?.(queryId);
+      this.applicationStore.notificationService.notifySuccess(
         'Deleted query successfully',
       );
       this.deleteQueryState.pass();

package/src/stores/explorer/QueryFunctionsExplorerState.ts

@@ -30,7 +30,11 @@ import {
 } from '@finos/legend-shared';
 import { action, makeObservable, observable } from 'mobx';
 import type { QueryBuilderState } from '../QueryBuilderState.js';
-import type { TreeNodeData, TreeData } from '@finos/legend-art';
+import {
+  type TreeNodeData,
+  type TreeData,
+  compareLabelFn,
+} from '@finos/legend-art';
 
 export const QUERY_BUILDER_FUNCTION_DND_TYPE = 'QUERY_BUILDER_FUNCTION';
 
@@ -206,7 +210,7 @@ export const getFunctionsExplorerTreeNodeChildren = (
   return node.childrenIds
     .map((id) => data.nodes.get(id))
     .filter(isNonNullable)
-    .sort((a, b) => a.label.localeCompare(b.label))
+    .sort(compareLabelFn)
     .sort(
       (a, b) =>
         (b.packageableElement instanceof Package ? 1 : 0) -

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

@@ -146,6 +146,7 @@ export class QueryBuilderTDSState
       TEMPORARY__showPostFetchStructurePanel: computed,
       derivations: computed,
       hasParserError: computed,
+      isQueryOptionsSet: computed,
       addColumn: action,
       moveColumn: action,
       removeAllColumns: action,
@@ -356,6 +357,16 @@ export class QueryBuilderTDSState
     return fetchStructureValidationIssues;
   }
 
+  get isQueryOptionsSet(): boolean {
+    return (
+      this.resultSetModifierState.limit !== undefined ||
+      this.queryBuilderState.milestoningState.isMilestonedQuery ||
+      this.resultSetModifierState.slice !== undefined ||
+      this.resultSetModifierState.sortColumns.length > 0 ||
+      this.resultSetModifierState.distinct
+    );
+  }
+
   get tdsColumns(): QueryBuilderTDSColumnState[] {
     const aggregationStateCols = this.aggregationState.columns.map(
       (c) => c.projectionColumnState,

package/src/stores/milestoning/QueryBuilderMilestoningState.ts

@@ -75,7 +75,7 @@ export class QueryBuilderMilestoningState implements Hashable {
       startDate: observable,
       endDate: observable,
       showMilestoningEditor: observable,
-      isMilestonedQuery: computed,
+
       setProcessingDate: action,
       setBusinessDate: action,
       setStartDate: action,
@@ -87,6 +87,10 @@ export class QueryBuilderMilestoningState implements Hashable {
       initializeAllVersionsInRangeParameters: action,
       clearAllVersionsInRangeParameters: action,
       clearGetAllParameters: action,
+
+      isAllVersionsEnabled: computed,
+      isAllVersionsInRangeEnabled: computed,
+      isMilestonedQuery: computed,
       hashCode: computed,
     });
 
@@ -380,9 +384,9 @@ export class QueryBuilderMilestoningState implements Hashable {
         this.queryBuilderState.parametersState.parameterStates.find(
           (p) => p.parameter === this.startDate,
         );
-      this.queryBuilderState.parametersState.removeParameter(
-        guaranteeNonNullable(paramState),
-      );
+      if (paramState) {
+        this.queryBuilderState.parametersState.removeParameter(paramState);
+      }
     }
     if (
       this.endDate instanceof VariableExpression &&
@@ -394,9 +398,9 @@ export class QueryBuilderMilestoningState implements Hashable {
         this.queryBuilderState.parametersState.parameterStates.find(
           (p) => p.parameter === this.endDate,
         );
-      this.queryBuilderState.parametersState.removeParameter(
-        guaranteeNonNullable(paramState),
-      );
+      if (paramState) {
+        this.queryBuilderState.parametersState.removeParameter(paramState);
+      }
     }
     this.setStartDate(undefined);
     this.setEndDate(undefined);