datatables.net-searchbuilder 1.3.4 → 1.4.2

package/package.json

@@ -2,10 +2,12 @@
     "name": "datatables.net-searchbuilder",
     "description": "SearchBuilder for DataTables",
     "main": "js/dataTables.searchBuilder.js",
+    "module": "js/dataTables.searchBuilder.mjs",
     "types": "./types/types.d.ts",
-    "version": "1.3.4",
+    "version": "1.4.2",
     "files": [
         "js/**/*.js",
+        "js/**/*.mjs",
         "types/**/*.d.ts"
     ],
     "keywords": [
@@ -19,7 +21,7 @@
         "sort"
     ],
     "dependencies": {
-        "datatables.net": ">=1.11.3",
+        "datatables.net": ">=1.12.1",
         "jquery": ">=1.7"
     },
     "moduleType": [

package/types/criteria.d.ts

@@ -249,7 +249,7 @@ export default class Criteria {
      */
     private _populateCondition;
     /**
-     * Populates the data select element
+     * Populates the data / column select element
      */
     private _populateData;
     /**

package/types/index.d.ts

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

package/types/searchBuilder.bootstrap.d.ts

@@ -0,0 +1,4 @@
+/*! Bootstrap ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+*/
+declare var DataTable: any;

package/types/searchBuilder.bootstrap4.d.ts

@@ -0,0 +1,4 @@
+/*! Bootstrap 4 ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/searchBuilder.bootstrap5.d.ts

@@ -0,0 +1,4 @@
+/*! Bootstrap 5 ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/searchBuilder.bulma.d.ts

@@ -0,0 +1,4 @@
+/*! Bulma ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/searchBuilder.dataTables.d.ts

@@ -0,0 +1,4 @@
+/*! DataTables integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/searchBuilder.foundation.d.ts

@@ -0,0 +1,4 @@
+/*! Foundation ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/searchBuilder.jqueryui.d.ts

@@ -0,0 +1,4 @@
+/*! JQuery ui ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/searchBuilder.semanticui.d.ts

@@ -0,0 +1,4 @@
+/*! semantic ui integration for DataTables' SearchBuilder
+ * © SpryMedia Ltd - datatables.net/license
+ */
+declare var DataTable: any;

package/types/types.d.ts

@@ -1,40 +1,115 @@
+// Type definitions for DataTables SearchBuilder
+//
+// Project: https://datatables.net/extensions/searchbuilder/, https://datatables.net
+
 /// <reference types="jquery" />
-/// <reference types="datatables.net"/>
 
-import {IDefaults, IDetails} from './searchBuilder';
+import DataTables, {Api} from 'datatables.net';
+import {IDefaults, IDetails, II18n} from './searchBuilder';
 
-declare namespace DataTables {
+export default DataTables;
 
-	interface Settings {
-		searchBuilder?: boolean | string[] | IDefaults | IDefaults[];
-	}
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
 
-	interface LanguageSettings {
-		searchBuilder?: {}
-	}
 
-	interface Api<T> {
-		searchBuilder: SearchBuilderGlobalApi;
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * DataTables' types integration
+ */
+declare module 'datatables.net' {
+	interface Config {
+		/**
+		 * SearchBuilder extension options
+		 */
+		searchBuilder?: boolean | string[] | ConfigSearchBuilder | ConfigSearchBuilder[];
 	}
 
-	interface SearchBuilderGlobalApi {
+	interface ConfigLanguage {
 		/**
-		 * Returns the node of the SearchBuilder Container
+		 * SearchBuilder language options
 		 */
-		container(): JQuery<HTMLElement>;
+		searchBuilder?: ConfigSearchBuilderLanguage;
+	}
 
+	interface ConfigColumns {
+		searchBuilder?: {
+			/** Set a default condition for this column */
+			defaultCondition?: number | string;
+
+			/** Set values of orthogonal data for rendering functions */
+			orthogonal?: {[key: string]: string};
+		};
+
+		/** Set a custom title for a column in SearchBuilder */
+		searchBuilderTitle?: string;
+
+		/** Set the SearchBuilder type to use for a column */
+		searchBuilderType?: string;
+	}
+
+	interface Api<T> {
 		/**
-		 * Gets the details of the current SearchBuilder setup
+		 * SearchBuilder methods container
+		 * 
+		 * @returns Api for chaining with the additional SearchBuilder methods
 		 */
-		getDetails(): IDetails;
+		searchBuilder: ApiSearchBuilder<T>;
+	}
 
+	interface ApiStatic {
 		/**
-		 * 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
+		 * SearchBuilder class
 		 */
-		rebuild(state: IDetails): Api<any>;
+		SearchBuilder: {
+			/**
+			 * Create a new SearchBuilder instance for the target DataTable
+			 */
+			new (dt: Api<any>, settings: string[] | ConfigSearchBuilder | ConfigSearchBuilder[]);
+
+			/**
+			 * SearchBuilder version
+			 */
+			version: string;
+
+			/**
+			 * Default configuration values
+			 */
+			defaults: ConfigSearchBuilder;
+		}
 	}
 }
+
+
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Options
+ */
+
+interface ConfigSearchBuilder extends Partial<IDefaults> {}
+
+interface ConfigSearchBuilderLanguage extends DeepPartial<II18n> {}
+
+
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * API
+ */
+interface ApiSearchBuilder<T> extends Api<T> {
+	/**
+	 * 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 structure 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<T>;
+}