datatables.net-searchbuilder 1.2.0 → 1.3.1

package/package.json

@@ -3,9 +3,10 @@
     "description": "SearchBuilder for DataTables",
     "main": "js/dataTables.searchBuilder.js",
     "types": "./types/types.d.ts",
-    "version": "1.2.0",
+    "version": "1.3.1",
     "files": [
-        "js/**/*.js"
+        "js/**/*.js",
+        "types/**/*.d.ts"
     ],
     "keywords": [
         "SearchBuilder",
@@ -18,7 +19,7 @@
         "sort"
     ],
     "dependencies": {
-        "datatables.net": ">=1.10.25",
+        "datatables.net": ">=1.11.3",
         "jquery": ">=1.7"
     },
     "moduleType": [

package/types/criteria.d.ts

@@ -0,0 +1,255 @@
+/// <reference types="jquery" />
+/// <reference types="datatables.net" />
+import * as builderType from './searchBuilder';
+export interface IClasses {
+    button: string;
+    buttonContainer: string;
+    condition: string;
+    container: string;
+    data: string;
+    delete: string;
+    dropDown: string;
+    greyscale: string;
+    input: string;
+    italic: string;
+    joiner: string;
+    left: string;
+    notItalic: string;
+    option: string;
+    right: string;
+    select: string;
+    value: string;
+    vertical: string;
+}
+export interface ICondition {
+    conditionName: string | ((dt: any, i18n: any) => string);
+    init: (that?: Criteria, fn?: (thatAgain: Criteria, el: JQuery<HTMLElement>) => void, preDefined?: string[]) => JQuery<HTMLElement> | Array<JQuery<HTMLElement>> | void;
+    inputValue: (el: JQuery<HTMLElement>) => string[] | void;
+    isInputValid: (val: Array<JQuery<HTMLElement>>, that: Criteria) => boolean;
+    search: (value: string, comparison: string[], that: Criteria) => boolean;
+}
+export interface IOrthogonal {
+    display: string;
+    search: string;
+}
+export interface IDom {
+    buttons: JQuery<HTMLElement>;
+    condition: JQuery<HTMLElement>;
+    conditionTitle: JQuery<HTMLElement>;
+    container: JQuery<HTMLElement>;
+    data: JQuery<HTMLElement>;
+    dataTitle: JQuery<HTMLElement>;
+    defaultValue: JQuery<HTMLElement>;
+    delete: JQuery<HTMLElement>;
+    left: JQuery<HTMLElement>;
+    right: JQuery<HTMLElement>;
+    value: Array<JQuery<HTMLElement>>;
+    valueTitle: JQuery<HTMLElement>;
+}
+export interface IS {
+    condition: string;
+    conditions: {
+        [keys: string]: ICondition;
+    };
+    data: string;
+    dataIdx: number;
+    dataPoints: IDataOpt[];
+    dateFormat: string | boolean;
+    depth: number;
+    dt: any;
+    filled: boolean;
+    index: number;
+    origData: string;
+    topGroup: JQuery<HTMLElement>;
+    type: string;
+    value: string[];
+}
+export interface IDataOpt {
+    index: number;
+    origData: string;
+    text: string;
+}
+export interface IDetails {
+    condition?: string;
+    criteria?: Criteria;
+    data?: string;
+    index?: number;
+    logic?: string;
+    origData?: string;
+    type?: string;
+    value?: string[];
+}
+/**
+ * Sets the value of jQuery for use in the file
+ *
+ * @param jq the instance of jQuery to be set
+ */
+export declare function setJQuery(jq: any): void;
+/**
+ * The Criteria class is used within SearchBuilder to represent a search criteria
+ */
+export default class Criteria {
+    private static version;
+    private static classes;
+    classes: IClasses;
+    dom: IDom;
+    c: builderType.IDefaults;
+    s: IS;
+    constructor(table: any, opts: builderType.IDefaults, topGroup: JQuery<HTMLElement>, index?: number, depth?: number);
+    /**
+     * Escape html characters within a string
+     *
+     * @param txt the string to be escaped
+     * @returns the escaped string
+     */
+    private static _escapeHTML;
+    /**
+     * Default initialisation function for select conditions
+     */
+    private static initSelect;
+    /**
+     * Default initialisation function for select array conditions
+     *
+     * This exists because there needs to be different select functionality for contains/without and equals/not
+     */
+    private static initSelectArray;
+    /**
+     * Default initialisation function for input conditions
+     */
+    private static initInput;
+    /**
+     * Default initialisation function for conditions requiring 2 inputs
+     */
+    private static init2Input;
+    /**
+     * Default initialisation function for date conditions
+     */
+    private static initDate;
+    private static initNoValue;
+    private static init2Date;
+    /**
+     * Default function for select elements to validate condition
+     */
+    private static isInputValidSelect;
+    /**
+     * Default function for input and date elements to validate condition
+     */
+    private static isInputValidInput;
+    /**
+     * Default function for getting select conditions
+     */
+    private static inputValueSelect;
+    /**
+     * Default function for getting input conditions
+     */
+    private static inputValueInput;
+    /**
+     * Function that is run on each element as a call back when a search should be triggered
+     */
+    private static updateListener;
+    static dateConditions: {
+        [keys: string]: ICondition;
+    };
+    static momentDateConditions: {
+        [keys: string]: ICondition;
+    };
+    static luxonDateConditions: {
+        [keys: string]: ICondition;
+    };
+    static numConditions: {
+        [keys: string]: ICondition;
+    };
+    static numFmtConditions: {
+        [keys: string]: ICondition;
+    };
+    static stringConditions: {
+        [keys: string]: ICondition;
+    };
+    static arrayConditions: {
+        [keys: string]: ICondition;
+    };
+    private static defaults;
+    /**
+     * Adds the left button to the criteria
+     */
+    updateArrows(hasSiblings?: boolean, redraw?: boolean): void;
+    /**
+     * Destroys the criteria, removing listeners and container from the dom
+     */
+    destroy(): void;
+    /**
+     * Passes in the data for the row and compares it against this single criteria
+     *
+     * @param rowData The data for the row to be compared
+     * @returns boolean Whether the criteria has passed
+     */
+    search(rowData: any[], rowIdx: number): boolean;
+    /**
+     * Gets the details required to rebuild the criteria
+     */
+    getDetails(deFormatDates?: boolean): IDetails;
+    /**
+     * Getter for the node for the container of the criteria
+     *
+     * @returns JQuery<HTMLElement> the node for the container
+     */
+    getNode(): JQuery<HTMLElement>;
+    /**
+     * Populates the criteria data, condition and value(s) as far as has been selected
+     */
+    populate(): void;
+    /**
+     * Rebuilds the criteria based upon the details passed in
+     *
+     * @param loadedCriteria the details required to rebuild the criteria
+     */
+    rebuild(loadedCriteria: IDetails): void;
+    /**
+     * Sets the listeners for the criteria
+     */
+    setListeners(): void;
+    /**
+     * Adjusts the criteria to make SearchBuilder responsive
+     */
+    private _adjustCriteria;
+    /**
+     * Builds the elements of the dom together
+     */
+    private _buildCriteria;
+    /**
+     * Clears the condition select element
+     */
+    private _clearCondition;
+    /**
+     * Clears the value elements
+     */
+    private _clearValue;
+    /**
+     * Gets the options for the column
+     *
+     * @returns {object} The options for the column
+     */
+    private _getOptions;
+    /**
+     * Populates the condition dropdown
+     */
+    private _populateCondition;
+    /**
+     * Populates the data select element
+     */
+    private _populateData;
+    /**
+     * Populates the Value select element
+     *
+     * @param loadedCriteria optional, used to reload criteria from predefined filters
+     */
+    private _populateValue;
+    /**
+     * Provides throttling capabilities to SearchBuilder without having to use dt's _fnThrottle function
+     * This is because that function is not quite suitable for our needs as it runs initially rather than waiting
+     *
+     * @param args arguments supplied to the throttle function
+     * @returns Function that is to be run that implements the throttling
+     */
+    private _throttle;
+}

package/types/group.d.ts

@@ -0,0 +1,189 @@
+/// <reference types="jquery" />
+/// <reference types="datatables.net" />
+import Criteria, * as criteriaType from './criteria';
+import * as builderType from './searchBuilder';
+export interface IClassses {
+    add: string;
+    button: string;
+    clearGroup: string;
+    greyscale: string;
+    group: string;
+    inputButton: string;
+    logic: string;
+    logicContainer: string;
+}
+export interface IDom {
+    add: JQuery<HTMLElement>;
+    clear: JQuery<HTMLElement>;
+    container: JQuery<HTMLElement>;
+    logic: JQuery<HTMLElement>;
+    logicContainer: JQuery<HTMLElement>;
+}
+export interface IS {
+    criteria: ISCriteria[];
+    depth: number;
+    dt: any;
+    index: number;
+    isChild: boolean;
+    logic: string;
+    opts: builderType.IDefaults;
+    preventRedraw: boolean;
+    toDrop: Criteria;
+    topGroup: JQuery<HTMLElement>;
+}
+export interface ICriteria {
+    criteria: Array<IDetails | criteriaType.IDetails>;
+    index: number;
+}
+export interface ICriteriaDetails {
+    condition?: string;
+    data?: string;
+    logic?: string;
+    value?: string[];
+}
+export interface ISCriteria {
+    criteria: Group | Criteria;
+    index: number;
+    logic?: string;
+}
+export interface IDetails {
+    criteria?: ICriteriaDetails[];
+    index?: number;
+    logic?: string;
+}
+/**
+ * Sets the value of jQuery for use in the file
+ *
+ * @param jq the instance of jQuery to be set
+ */
+export declare function setJQuery(jq: any): void;
+/**
+ * The Group class is used within SearchBuilder to represent a group of criteria
+ */
+export default class Group {
+    private static version;
+    private static classes;
+    private static defaults;
+    classes: IClassses;
+    dom: IDom;
+    c: builderType.IDefaults;
+    s: IS;
+    constructor(table: any, opts: builderType.IDefaults, topGroup: JQuery<HTMLElement>, index?: number, isChild?: boolean, depth?: number);
+    /**
+     * Destroys the groups buttons, clears the internal criteria and removes it from the dom
+     */
+    destroy(): void;
+    /**
+     * Gets the details required to rebuild the group
+     */
+    getDetails(deFormatDates?: boolean): IDetails | {};
+    /**
+     * Getter for the node for the container of the group
+     *
+     * @returns Node for the container of the group
+     */
+    getNode(): JQuery<HTMLElement>;
+    /**
+     * Rebuilds the group based upon the details passed in
+     *
+     * @param loadedDetails the details required to rebuild the group
+     */
+    rebuild(loadedDetails: IDetails | criteriaType.IDetails): void;
+    /**
+     * Redraws the Contents of the searchBuilder Groups and Criteria
+     */
+    redrawContents(): void;
+    /**
+     * Resizes the logic button only rather than the entire dom.
+     */
+    redrawLogic(): void;
+    /**
+     * Search method, checking the row data against the criteria in the group
+     *
+     * @param rowData The row data to be compared
+     * @returns boolean The result of the search
+     */
+    search(rowData: any[], rowIdx: number): boolean;
+    /**
+     * Locates the groups logic button to the correct location on the page
+     */
+    setupLogic(): void;
+    /**
+     * Sets listeners on the groups elements
+     */
+    setListeners(): void;
+    /**
+     * Adds a criteria to the group
+     *
+     * @param crit Instance of Criteria to be added to the group
+     */
+    addCriteria(crit?: Criteria, redraw?: boolean): void;
+    /**
+     * Checks the group to see if it has any filled criteria
+     */
+    checkFilled(): boolean;
+    /**
+     * Gets the count for the number of criteria in this group and any sub groups
+     */
+    count(): number;
+    /**
+     * Rebuilds a sub group that previously existed
+     *
+     * @param loadedGroup The details of a group within this group
+     */
+    private _addPrevGroup;
+    /**
+     * Rebuilds a criteria of this group that previously existed
+     *
+     * @param loadedCriteria The details of a criteria within the group
+     */
+    private _addPrevCriteria;
+    /**
+     * Checks And the criteria using AND logic
+     *
+     * @param rowData The row data to be checked against the search criteria
+     * @returns boolean The result of the AND search
+     */
+    private _andSearch;
+    /**
+     * Checks And the criteria using OR logic
+     *
+     * @param rowData The row data to be checked against the search criteria
+     * @returns boolean The result of the OR search
+     */
+    private _orSearch;
+    /**
+     * Removes a criteria from the group
+     *
+     * @param criteria The criteria instance to be removed
+     */
+    private _removeCriteria;
+    /**
+     * Sets the listeners in group for a criteria
+     *
+     * @param criteria The criteria for the listeners to be set on
+     */
+    private _setCriteriaListeners;
+    /**
+     * Set's the listeners for the group clear button
+     */
+    private _setClearListener;
+    /**
+     * Sets listeners for sub groups of this group
+     *
+     * @param group The sub group that the listeners are to be set on
+     */
+    private _setGroupListeners;
+    /**
+     * Sets up the Group instance, setting listeners and appending elements
+     */
+    private _setup;
+    /**
+     * Sets the listener for the logic button
+     */
+    private _setLogicListener;
+    /**
+     * Toggles the logic for the group
+     */
+    private _toggleLogic;
+}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+/*! SearchBuilder 1.3.1
+ * ©SpryMedia Ltd - datatables.net/license/mit
+ */
+export {};

package/types/searchBuilder.d.ts

@@ -0,0 +1,153 @@
+/// <reference types="jquery" />
+/// <reference types="datatables.net" />
+/**
+ * Sets the value of jQuery for use in the file
+ *
+ * @param jq the instance of jQuery to be set
+ */
+export declare function setJQuery(jq: any): void;
+import * as criteriaType from './criteria';
+import Group from './group';
+export interface IDetails {
+    criteria: Group[];
+    logic: string;
+}
+export interface IClasses {
+    button: string;
+    clearAll: string;
+    container: string;
+    inputButton: string;
+    title: string;
+    titleRow: string;
+}
+export interface IDefaults {
+    columns: number[] | boolean;
+    conditions: {
+        [keys: string]: {
+            [keys: string]: criteriaType.ICondition;
+        };
+    };
+    depthLimit: boolean | number;
+    enterSearch: boolean;
+    filterChanged: (count: number, text: string) => void;
+    greyscale: boolean;
+    i18n: II18n;
+    logic: string;
+    orthogonal: criteriaType.IOrthogonal;
+    preDefined: boolean | IDetails;
+}
+export interface IDom {
+    clearAll: JQuery<HTMLElement>;
+    container: JQuery<HTMLElement>;
+    title: JQuery<HTMLElement>;
+    titleRow: JQuery<HTMLElement>;
+    topGroup: JQuery<HTMLElement>;
+}
+export interface II18n {
+    add: string;
+    button: {
+        0: string;
+        _: string;
+    };
+    clearAll: string;
+    condition: string;
+    conditions?: {
+        [s: string]: {
+            [t: string]: string;
+        };
+    };
+    data: string;
+    delete: string;
+    deleteTitle: string;
+    left: string;
+    leftTitle: string;
+    logicAnd: string;
+    logicOr: string;
+    right: string;
+    rightTitle: string;
+    title: {
+        0: string;
+        _: string;
+    };
+    value: string;
+    valueJoiner: string;
+}
+export interface IS {
+    dt: any;
+    opts: IDefaults;
+    search: (settings: any, searchData: any, dataIndex: any, origData: any) => boolean;
+    topGroup: Group;
+}
+/**
+ * SearchBuilder class for DataTables.
+ * Allows for complex search queries to be constructed and implemented on a DataTable
+ */
+export default class SearchBuilder {
+    private static version;
+    private static classes;
+    private static defaults;
+    classes: IClasses;
+    dom: IDom;
+    c: IDefaults;
+    s: IS;
+    constructor(builderSettings: any, opts: IDefaults);
+    /**
+     * Gets the details required to rebuild the SearchBuilder as it currently is
+     */
+    getDetails(deFormatDates?: boolean): IDetails | {};
+    /**
+     * Getter for the node of the container for the searchBuilder
+     *
+     * @returns JQuery<HTMLElement> the node of the container
+     */
+    getNode(): JQuery<HTMLElement>;
+    /**
+     * Rebuilds the SearchBuilder to a state that is provided
+     *
+     * @param details The details required to perform a rebuild
+     */
+    rebuild(details: any): SearchBuilder;
+    /**
+     * Applies the defaults to preDefined criteria
+     *
+     * @param preDef the array of criteria to be processed.
+     */
+    private _applyPreDefDefaults;
+    /**
+     * Set's up the SearchBuilder
+     */
+    private _setUp;
+    private _collapseArray;
+    /**
+     * Updates the title of the SearchBuilder
+     *
+     * @param count the number of filters in the SearchBuilder
+     */
+    private _updateTitle;
+    /**
+     * Builds all of the dom elements together
+     */
+    private _build;
+    /**
+     * Checks if the clearAll button should be added or not
+     */
+    private _checkClear;
+    /**
+     * Update the count in the title/button
+     *
+     * @param count Number of filters applied
+     */
+    private _filterChanged;
+    /**
+     * Set the listener for the clear button
+     */
+    private _setClearListener;
+    /**
+     * Set the listener for the Redraw event
+     */
+    private _setRedrawListener;
+    /**
+     * Sets listeners to check whether clearAll should be added or removed
+     */
+    private _setEmptyListener;
+}

package/types/types.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="jquery" />
+/// <reference types="datatables.net"/>
+
+import {IDefaults, IDetails} from './searchBuilder';
+
+declare namespace DataTables {
+
+	interface Settings {
+		searchBuilder?: boolean | string[] | IDefaults | IDefaults[];
+	}
+
+	interface LanguageSettings {
+		searchBuilder?: {}
+	}
+
+	interface Api<T> {
+		searchBuilder: SearchBuilderGlobalApi;
+	}
+
+	interface SearchBuilderGlobalApi {
+		/**
+		 * Returns the node of the SearchBuilder Container
+		 */
+		container(): JQuery<HTMLElement>;
+
+		/**
+		 * Gets the details of the current SearchBuilder setup
+		 */
+		getDetails(): IDetails;
+
+		/**
+		 * Rebuild the search to a given state.
+		 *
+		 * @param state Object of the same structue that is returned from searchBuilder.getDetails().
+		 * This contains all of the details needed to rebuild the state.
+		 * @returns self for chaining
+		 */
+		rebuild(state: IDetails): Api<any>;
+	}
+}