@syncfusion/ej2-querybuilder 24.2.9 → 25.1.35

package/dist/global/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 *  filename: index.d.ts
-*  version : 24.2.9
+*  version : 25.1.35
 *  Copyright Syncfusion Inc. 2001 - 2023. All rights reserved.
 *  Use of this code is subject to the terms of our license.
 *  A copy of the current license can be obtained at any time by e-mailing

package/package.json

@@ -1,8 +1,8 @@
 {
   "_from": "@syncfusion/ej2-querybuilder@*",
-  "_id": "@syncfusion/ej2-querybuilder@24.2.8",
+  "_id": "@syncfusion/ej2-querybuilder@18.24.1",
   "_inBundle": false,
-  "_integrity": "sha512-xNwR6dONcXxRCvZ32B9fD6m39auYyQnxbNRF5oPM2sKt5ado9TyQvIc5/9xxiZrDQ+FAlC/qDTsb88Q3ao4f1g==",
+  "_integrity": "sha512-ujZuYcmKu3KsFyS06QnLCHFo2iAoP/xGSfn5H5+Bz72cs7gO8fkLxDHEGZ/FAq5d3H5knyxsbczY4M/T4d/A0g==",
   "_location": "/@syncfusion/ej2-querybuilder",
   "_phantomChildren": {},
   "_requested": {
@@ -23,21 +23,21 @@
     "/@syncfusion/ej2-react-querybuilder",
     "/@syncfusion/ej2-vue-querybuilder"
   ],
-  "_resolved": "https://nexus.syncfusioninternal.com/repository/ej2-hotfix-new/@syncfusion/ej2-querybuilder/-/ej2-querybuilder-24.2.8.tgz",
-  "_shasum": "63932c8d748d6ddf307fa4a1cbed272d9bf9b6bc",
+  "_resolved": "https://nexus.syncfusioninternal.com/repository/ej2-release/@syncfusion/ej2-querybuilder/-/ej2-querybuilder-18.24.1.tgz",
+  "_shasum": "9c720eb30d9ffdbd3b0fdff5462862a88930b6ed",
   "_spec": "@syncfusion/ej2-querybuilder@*",
-  "_where": "/jenkins/workspace/elease-automation_release_24.1.1/packages/included",
+  "_where": "/jenkins/workspace/elease-automation_release_25.1.1/packages/included",
   "author": {
     "name": "Syncfusion Inc."
   },
   "bundleDependencies": false,
   "dependencies": {
-    "@syncfusion/ej2-base": "~24.2.7",
-    "@syncfusion/ej2-buttons": "~24.2.7",
-    "@syncfusion/ej2-calendars": "~24.2.9",
-    "@syncfusion/ej2-dropdowns": "~24.2.9",
-    "@syncfusion/ej2-inputs": "~24.2.9",
-    "@syncfusion/ej2-splitbuttons": "~24.2.7"
+    "@syncfusion/ej2-base": "~25.1.35",
+    "@syncfusion/ej2-buttons": "~25.1.35",
+    "@syncfusion/ej2-calendars": "~25.1.35",
+    "@syncfusion/ej2-dropdowns": "~25.1.35",
+    "@syncfusion/ej2-inputs": "~25.1.35",
+    "@syncfusion/ej2-splitbuttons": "~25.1.35"
   },
   "deprecated": false,
   "description": "Essential JS 2 QueryBuilder",
@@ -66,7 +66,7 @@
     "url": "https://github.com/syncfusion/ej2-javascript-ui-controls/tree/master/controls/querybuilder"
   },
   "typings": "index.d.ts",
-  "version": "24.2.9",
+  "version": "25.1.35",
   "sideEffects": false,
   "homepage": "https://www.syncfusion.com/javascript-ui-controls"
 }

package/src/global.js

@@ -1 +1,3 @@
+import * as index from './index';
+index.QueryBuilder.Inject(index.QueryLibrary);
 export * from './index';

package/src/query-builder/index.d.ts

@@ -3,3 +3,4 @@
  */
 export * from './query-builder';
 export * from './query-builder-model';
+export * from './query-library';

package/src/query-builder/index.js

@@ -2,3 +2,4 @@
  * QueryBuilder modules
  */
 export * from './query-builder';
+export * from './query-library';

package/src/query-builder/query-builder-model.d.ts

@@ -1,4 +1,4 @@
-import { Component, INotifyPropertyChanged, NotifyPropertyChanges, getComponent, MouseEventArgs, Browser, compile, append } from '@syncfusion/ej2-base';import { Property, ChildProperty, Complex, L10n, closest, extend, isNullOrUndefined, Collection, cldrData } from '@syncfusion/ej2-base';import { getInstance, addClass, removeClass, rippleEffect, detach, classList } from '@syncfusion/ej2-base';import { Internationalization, DateFormatOptions, KeyboardEventArgs, getUniqueID, select } from '@syncfusion/ej2-base';import { Button, CheckBox, RadioButton, ChangeEventArgs as ButtonChangeEventArgs, RadioButtonModel } from '@syncfusion/ej2-buttons';import { DropDownList, ChangeEventArgs as DropDownChangeEventArgs, FieldSettingsModel, CheckBoxSelection, DropDownTreeModel, DropDownTree } from '@syncfusion/ej2-dropdowns';import { MultiSelect, MultiSelectChangeEventArgs, PopupEventArgs, MultiSelectModel, DropDownListModel } from '@syncfusion/ej2-dropdowns';import { EmitType, Event, EventHandler, getValue, Animation, BaseEventArgs } from '@syncfusion/ej2-base';import { Query, Predicate, DataManager, Deferred } from '@syncfusion/ej2-data';import { TextBox, NumericTextBox, InputEventArgs, ChangeEventArgs as InputChangeEventArgs } from '@syncfusion/ej2-inputs';import { TextBoxModel, NumericTextBoxModel } from '@syncfusion/ej2-inputs';import { DatePicker, ChangeEventArgs as CalendarChangeEventArgs, DatePickerModel } from '@syncfusion/ej2-calendars';import { DropDownButton, ItemModel, MenuEventArgs } from '@syncfusion/ej2-splitbuttons';import { Tooltip, createSpinner, showSpinner, hideSpinner, TooltipEventArgs } from '@syncfusion/ej2-popups';import { compile as templateCompiler } from '@syncfusion/ej2-base';
+import { Component, INotifyPropertyChanged, NotifyPropertyChanges, getComponent, MouseEventArgs, Browser, compile, append, ModuleDeclaration, getDefaultDateObject } from '@syncfusion/ej2-base';import { Property, ChildProperty, Complex, L10n, closest, extend, isNullOrUndefined, Collection, cldrData } from '@syncfusion/ej2-base';import { getInstance, addClass, removeClass, rippleEffect, detach, classList } from '@syncfusion/ej2-base';import { Internationalization, DateFormatOptions, KeyboardEventArgs, getUniqueID, select } from '@syncfusion/ej2-base';import { Button, CheckBox, RadioButton, ChangeEventArgs as ButtonChangeEventArgs, RadioButtonModel } from '@syncfusion/ej2-buttons';import { DropDownList, ChangeEventArgs as DropDownChangeEventArgs, FieldSettingsModel, CheckBoxSelection, DropDownTreeModel, DropDownTree } from '@syncfusion/ej2-dropdowns';import { MultiSelect, MultiSelectChangeEventArgs, PopupEventArgs, MultiSelectModel, DropDownListModel } from '@syncfusion/ej2-dropdowns';import { EmitType, Event, EventHandler, getValue, Animation, BaseEventArgs } from '@syncfusion/ej2-base';import { Query, Predicate, DataManager, Deferred } from '@syncfusion/ej2-data';import { TextBox, NumericTextBox, InputEventArgs, ChangeEventArgs as InputChangeEventArgs } from '@syncfusion/ej2-inputs';import { TextBoxModel, NumericTextBoxModel } from '@syncfusion/ej2-inputs';import { DatePicker, ChangeEventArgs as CalendarChangeEventArgs, DatePickerModel } from '@syncfusion/ej2-calendars';import { DropDownButton, ItemModel, MenuEventArgs } from '@syncfusion/ej2-splitbuttons';import { Tooltip, createSpinner, showSpinner, hideSpinner, TooltipEventArgs } from '@syncfusion/ej2-popups';import { compile as templateCompiler } from '@syncfusion/ej2-base';
 import {TemplateColumn,Validation,FormatObject,ActionEventArgs,ChangeEventArgs,RuleChangeEventArgs,FieldMode,DisplayMode,SortDirection} from "./query-builder";
 import {ComponentModel} from '@syncfusion/ej2-base';
 
@@ -165,6 +165,13 @@ export interface RuleModel {
      */
     not?: boolean;
 
+    /**
+     * Specifies whether rule is locked or not.
+     *
+     * @default false
+     */
+    isLocked?: boolean;
+
 }
 
 /**
@@ -214,6 +221,34 @@ export interface ValueModel {
  */
 export interface ShowButtonsModel {
 
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    cloneRule?: boolean;
+
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    cloneGroup?: boolean;
+
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    lockRule?: boolean;
+
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    lockGroup?: boolean;
+
     /**
      * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
      *
@@ -443,6 +478,39 @@ export interface QueryBuilderModel extends ComponentModel{
      */
     readonly?: boolean;
 
+    /**
+     * Specifies a boolean value whether enable / disable the new rule adding while adding new groups.
+     *
+     * @remarks
+     * If this property is true, the empty rule is inserted while inserting new group.
+     * If set to false, the group is inserted without any rule.
+     *
+     * @default true
+     */
+    addRuleToNewGroups?: boolean;
+
+    /**
+     * Specifies a boolean value whether enable / disable the auto selection with the first value for the field.
+     *
+     * @remarks
+     * If this property is true, the field dropdown list will render with the first value of the dropdown list.
+     * If set to false, the dropdown list render with placeholder.
+     *
+     * @default false
+     */
+    autoSelectField?: boolean;
+
+    /**
+     * Specifies a boolean value whether enable / disable the auto selection with the first value for the operator.
+     *
+     * @remarks
+     * If this property is true, the operator dropdown list will render with the first value of the dropdown list.
+     * If set to false, the dropdown list render with placeholder.
+     *
+     * @default true
+     */
+    autoSelectOperator?: boolean;
+
     /**
      * Specifies the separator string for column.
      *

package/src/query-builder/query-builder.d.ts

@@ -1,7 +1,7 @@
 /**
  * Query Builder Source
  */
-import { Component, INotifyPropertyChanged } from '@syncfusion/ej2-base';
+import { Component, INotifyPropertyChanged, ModuleDeclaration } from '@syncfusion/ej2-base';
 import { ChildProperty } from '@syncfusion/ej2-base';
 import { QueryBuilderModel, ShowButtonsModel, ColumnsModel, RuleModel, ValueModel } from './query-builder-model';
 import { RadioButtonModel } from '@syncfusion/ej2-buttons';
@@ -152,6 +152,12 @@ export declare class Rule extends ChildProperty<Rule> {
      * @default false
      */
     not: boolean;
+    /**
+     * Specifies whether rule is locked or not.
+     *
+     * @default false
+     */
+    isLocked: boolean;
 }
 /**
  * Defines the property for value.
@@ -192,6 +198,30 @@ export declare class Value extends ChildProperty<Value> {
  * Defines the ruleDelete, groupInsert, and groupDelete options of Query Builder.
  */
 export declare class ShowButtons extends ChildProperty<ShowButtons> {
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    cloneRule: boolean;
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    cloneGroup: boolean;
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    lockRule: boolean;
+    /**
+     * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
+     *
+     * @default false
+     */
+    lockGroup: boolean;
     /**
      * Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
      *
@@ -303,6 +333,14 @@ export declare class QueryBuilder extends Component<HTMLDivElement> implements I
     private isGetNestedData;
     private isCustomOprCols;
     private dummyDropdownTreeDs;
+    private groupCounter;
+    private lockItems;
+    private groupIndex;
+    private ruleIndex;
+    private isLastGroup;
+    private cloneGrpBtnClick;
+    private isMiddleGroup;
+    private cloneRuleBtnClick;
     /**
      * Triggers when the component is created.
      *
@@ -477,6 +515,36 @@ export declare class QueryBuilder extends Component<HTMLDivElement> implements I
      * @default false
      */
     readonly: boolean;
+    /**
+     * Specifies a boolean value whether enable / disable the new rule adding while adding new groups.
+     *
+     * @remarks
+     * If this property is true, the empty rule is inserted while inserting new group.
+     * If set to false, the group is inserted without any rule.
+     *
+     * @default true
+     */
+    addRuleToNewGroups: boolean;
+    /**
+     * Specifies a boolean value whether enable / disable the auto selection with the first value for the field.
+     *
+     * @remarks
+     * If this property is true, the field dropdown list will render with the first value of the dropdown list.
+     * If set to false, the dropdown list render with placeholder.
+     *
+     * @default false
+     */
+    autoSelectField: boolean;
+    /**
+     * Specifies a boolean value whether enable / disable the auto selection with the first value for the operator.
+     *
+     * @remarks
+     * If this property is true, the operator dropdown list will render with the first value of the dropdown list.
+     * If set to false, the dropdown list render with placeholder.
+     *
+     * @default true
+     */
+    autoSelectOperator: boolean;
     /**
      * Specifies the separator string for column.
      *
@@ -500,6 +568,7 @@ export declare class QueryBuilder extends Component<HTMLDivElement> implements I
     reset(): void;
     private getWrapper;
     protected getModuleName(): string;
+    requiredModules(): ModuleDeclaration[];
     private GetRootColumnName;
     private initialize;
     private updateSubFieldsFromColumns;
@@ -742,7 +811,7 @@ export declare class QueryBuilder extends Component<HTMLDivElement> implements I
      * Sets the rules from the sql query.
      *
      * @param {string} sqlString - 'sql String' to be passed to set the rule.
-     * @param {boolean} sqlLocale -  Set `true` if Localization for Sql query.
+     * @param {boolean} sqlLocale - Optional. Set `true` if Localization for Sql query.
      * @returns {void}
      */
     setRulesFromSql(sqlString: string, sqlLocale?: boolean): void;
@@ -759,10 +828,85 @@ export declare class QueryBuilder extends Component<HTMLDivElement> implements I
      *
      * @param {RuleModel} rule - 'rule' to be passed to get the sql.
      * @param {boolean} allowEscape - Set `true` if it exclude the escape character.
-     *  @param {boolean} sqlLocale - Set `true` if Localization for Sql query.
-     * @returns {object} - Sql query from rules.
+     * @param {boolean} sqlLocale - Set `true` if Localization for Sql query.
+     * @returns {string} - Sql query from rules.
      */
     getSqlFromRules(rule?: RuleModel, allowEscape?: boolean, sqlLocale?: boolean): string;
+    /**
+     * Gets the parameter SQL query from rules.
+     *
+     * @param {RuleModel} rule – Specify the rule to be passed to get the parameter sql string.
+     * @returns {ParameterizedSql} – Parameterized SQL query from rules.
+     */
+    getParameterizedSql(rule?: RuleModel): ParameterizedSql;
+    /**
+     * Sets the rules from the parameter sql query.
+     *
+     * @param { ParameterizedSql} sqlQuery – Specifies the parameter SQL to be passed to set the rule and load it to the query builder.
+     * @returns {void}
+     */
+    setParameterizedSql(sqlQuery: ParameterizedSql): void;
+    /**
+     * Gets the named parameter SQL query from rules.
+     *
+     * @param {RuleModel} rule – Specify the rule to be passed to get the named parameter SQL string.
+     * @returns {ParameterizedNamedSql} – Parameterized Named SQL query from rules.
+     */
+    getParameterizedNamedSql(rule?: RuleModel): ParameterizedNamedSql;
+    /**
+     * Sets the rules from the named parameter SQL query.
+     *
+     * @param { ParameterizedNamedSql } sqlQuery – Specifies the named parameter SQL to be passed to set the rule and load it to the query builder.
+     * @returns {void}
+     */
+    setParameterizedNamedSql(sqlQuery: ParameterizedNamedSql): void;
+    /**
+     * Set the rules from Mongo query.
+     *
+     * @param {string} mongoQuery - 'sql String' to be passed to get the rule.
+     * @param {boolean} mongoLocale - Set `true` if Localization for Mongo query.
+     * @returns {void}
+     */
+    setMongoQuery(mongoQuery: string, mongoLocale?: boolean): void;
+    /**
+     * Gets the Mongo query from rules.
+     *
+     * @param {RuleModel} rule - 'rule' to be passed to get the sql.
+     * @returns {object} - Sql query from rules.
+     */
+    getMongoQuery(rule?: RuleModel): string;
+    /**
+     * Clones the rule based on the rule ID to the specific group.
+     *
+     * @param {string} ruleID - Specifies the ruleID that needs to be cloned.
+     * @param {string} groupID - Specifies the groupID in which the rule to be cloned.
+     * @param {number} index - Specifies the index to insert the cloned rule inside the group.
+     * @returns {void}
+     */
+    cloneRule(ruleID: string, groupID: string, index: number): void;
+    /**
+     * Clones the group based on the group ID to the specific group.
+     *
+     * @param {string} groupID - Specifies the groupID that needs to be cloned.
+     * @param {string} parentGroupID - Specifies the parentGroupID in which the group to be cloned.
+     * @param {number} index - Specifies the index to insert the cloned group inside the parent group.
+     * @returns {void}
+     */
+    cloneGroup(groupID: string, parentGroupID: string, index: number): void;
+    /**
+     * Locks the rule based on the rule ID.
+     *
+     * @param {string} ruleID - Specifies the ruleID that needs to be locked.
+     * @returns {void}
+     */
+    lockRule(ruleID: string): void;
+    /**
+     * Locks the group based on the group ID
+     *
+     * @param {string} groupID - Specifies the groupID that needs to be locked.
+     * @returns {void}
+     */
+    lockGroup(groupID: string): void;
     private sqlParser;
     private parseSqlStrings;
     private checkLiteral;
@@ -772,6 +916,19 @@ export declare class QueryBuilder extends Component<HTMLDivElement> implements I
     private getLabelFromColumn;
     private getLabelFromField;
     private processParser;
+    /**
+     * Clone the Group
+     *
+     * @param {Element | string} target - 'target' to be passed to clone the group.
+     * @returns {void}
+     */
+    private groupClone;
+    private ruleClone;
+    private ruleLock;
+    private groupLock;
+    private updateLockItems;
+    private disableHeaderControls;
+    private disableRuleControls;
 }
 export interface Level {
     [key: string]: number[];
@@ -865,3 +1022,31 @@ export interface ActionEventArgs extends BaseEventArgs {
     renderTemplate?: boolean;
     groupID?: string;
 }
+/**
+ * Interface to define the parameter SQL query.
+ *
+ */
+export interface ParameterizedSql {
+    /**
+     * Specifies the SQL `WHERE` clause with `?` placeholders for each value.
+     */
+    sql: string;
+    /**
+     * Specifies the parameter values in the same order their respective placeholders appear in the `sql` string.
+     */
+    params: object[];
+}
+/**
+ * Interface to define the parameterized named SQL query.
+ *
+ */
+export interface ParameterizedNamedSql {
+    /**
+     * Specifies the SQL `WHERE` clause with bind variable placeholders for each value.
+     */
+    sql: string;
+    /**
+     * Specifies the bind variable names from the `sql` string to the associated values.
+     */
+    params: Record<string, object>;
+}