datatables.net-autofill 2.7.1 → 3.0.0

package/package.json

@@ -4,7 +4,7 @@
     "main": "js/dataTables.autoFill.js",
     "module": "js/dataTables.autoFill.mjs",
     "types": "./types/types.d.ts",
-    "version": "2.7.1",
+    "version": "3.0.0",
     "files": [
         "js/**/*.js",
         "js/**/*.mjs",
@@ -14,25 +14,13 @@
         "AutoFill",
         "Excel",
         "Datatables",
-        "jQuery",
         "table",
         "filter",
         "sort"
     ],
     "dependencies": {
-        "datatables.net": "1.11 - 2",
-        "jquery": ">=1.7"
+        "datatables.net": "^3"
     },
-    "moduleType": [
-        "globals",
-        "amd",
-        "node"
-    ],
-    "ignore": [
-        "composer.json",
-        "datatables.json",
-        "package.json"
-    ],
     "author": {
         "name": "SpryMedia Ltd",
         "url": "http://datatables.net"
@@ -42,6 +30,6 @@
     "license": "MIT",
     "repository": {
         "type": "git",
-        "url": "https://github.com/DataTables/Dist-DataTables-AutoFill.git"
+        "url": "git+https://github.com/DataTables/AutoFill.git"
     }
 }

package/types/types.d.ts

@@ -1,16 +1,189 @@
-// Type definitions for DataTables AutoFill
-//
-// Project: https://datatables.net/extensions/autofill/, https://datatables.net
-// Definitions by:
-//   SpryMedia
-//   Andy Ma <https://github.com/andy-maca>
+import DataTables__default, { ColumnSelector, Api, ApiCellMethods, CellIdxWithVisible, Dom, Context } from 'datatables.net';
+export * from 'datatables.net';
+export { default } from 'datatables.net';
+
+interface Classes {
+    btn: string;
+    close: string;
+    closeable: string;
+}
+interface Defaults {
+    /** Ask user what they want to do, even for a single option */
+    alwaysAsk: boolean;
+    /** Show a "Close" button in the list of options */
+    closeButton: boolean;
+    /** What will trigger a focus */
+    focus: 'click' | 'focus' | 'hover' | null;
+    /** Columns to provide auto fill for */
+    columns: ColumnSelector;
+    /** Enable AutoFill on load */
+    enable: boolean;
+    /** Update the cells after a drag */
+    update: boolean;
+    /** Editor instance for automatic submission */
+    editor: any;
+    /** Enable vertical fill */
+    vertical: boolean;
+    /** Enable horizontal fill */
+    horizontal: boolean;
+}
+interface Action {
+    available(dt: Api, cells: SelectedCells[][]): boolean;
+    option(dt: Api, cells: SelectedCells[][]): string;
+    execute(dt: Api, cells: SelectedCells[][], node: Dom | null): void | false;
+}
+interface SelectedCells {
+    cell: ApiCellMethods<any>;
+    data: any;
+    index: CellIdxWithVisible;
+    label: string;
+    set?: any;
+}
+
+/*! AutoFill for DataTables
+ * Copyright (c) SpryMedia Ltd - datatables.net/license
+ */
 
-/// <reference types="jquery" />
+declare class AutoFill {
+    /**
+     * AutoFill actions. The options here determine how AutoFill will fill the
+     * data in the table when the user has selected a range of cells. Please see
+     * the documentation on the DataTables site for full details on how to
+     * create plug- ins.
+     */
+    static actions: Record<string, Action>;
+    /** Class names used by AutoFill for customisation */
+    static classes: Classes;
+    /** Defaults */
+    static defaults: Defaults;
+    /** AutoFill version */
+    static version: string;
+    enabled(): boolean;
+    enable(flag?: boolean): this;
+    disable(): this;
+    private c;
+    private dom;
+    private s;
+    constructor(dt: Api | Context, opts?: Partial<Defaults>);
+    /**
+     * Initialise the RowReorder instance
+     */
+    private _init;
+    /**
+     * Display the AutoFill drag handle by appending it to a table cell. This is
+     * the opposite of the _detach method.
+     *
+     * @param node Cell to insert the handle into
+     */
+    private _attach;
+    /**
+     * Determine can the fill type should be. This can be automatic, or ask the
+     * end user.
+     *
+     * @param cells Information about the selected cells from the key up
+     *   function
+     */
+    private _actionSelector;
+    /**
+     * Remove the AutoFill handle from the document
+     */
+    private _detach;
+    /**
+     * Draw the selection outline by calculating the range between the start
+     * and end cells, then placing the highlighting elements to draw a rectangle
+     *
+     * @param target End cell
+     * @param e Originating event
+     * @private
+     */
+    private _drawSelection;
+    /**
+     * Use the Editor API to perform an update based on the new data for the
+     * cells
+     *
+     * @param cells Information about the selected cells from the key up
+     *   function
+     */
+    private _editor;
+    /**
+     * Emit an event on the DataTable for listeners
+     *
+     * @param name Event name
+     * @param args Event arguments
+     */
+    private _emitEvent;
+    /**
+     * Attach suitable listeners (based on the configuration) that will attach
+     * and detach the AutoFill handle in the document.
+     */
+    private _focusListener;
+    /**
+     * Clean up the event listeners
+     */
+    private _focusListenerRemove;
+    /**
+     * Get the position of a node, relative to another, including any scrolling
+     * offsets.
+     *
+     * @param node Node to get the position of
+     * @param targetHost Node to use as the parent
+     * @return Offset calculation
+     */
+    private _getPosition;
+    /**
+     * Start mouse drag - selects the start cell
+     *
+     * @param e Mouse down event
+     */
+    private _mousedown;
+    /**
+     * Mouse drag - selects the end cell and update the selection display for
+     * the end user
+     *
+     * @param e Mouse move event
+     */
+    private _mousemove;
+    /**
+     * End mouse drag - perform the update actions
+     *
+     * @param e Mouse up event
+     * @private
+     */
+    private _mouseup;
+    /**
+     * Create an array with a range of numbers defined by the start and end
+     * parameters passed in (inclusive!).
+     *
+     * @param start Start
+     * @param end End
+     */
+    private _range;
+    /**
+     * Move the window and DataTables scrolling during a drag to scroll new
+     * content into view. This is done by proximity to the edge of the scrolling
+     * container of the mouse - for example near the top edge of the window
+     * should scroll up. This is a little complicated as there are two elements
+     * that can be scrolled - the window and the DataTables scrolling view port
+     * (if scrollX and / or scrollY is enabled).
+     *
+     * @param e Mouse move event object
+     */
+    private _shiftScroll;
+    /**
+     * Update the DataTable after the user has selected what they want to do
+     *
+     * @param result Return from the `execute` method - can be false internally
+     *   to do nothing. This is not documented for plug-ins and is used only by
+     *   the cancel option.
+     * @param cells Information about the selected cells from the key up
+     *   function, augmented with the set values
+     */
+    private _update;
+}
+
+// Type definitions for DataTables AutoFill
 
-import DataTables, {Api} from 'datatables.net';
 
-export default DataTables;
-export * from 'datatables.net';
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * DataTables' types integration
@@ -20,7 +193,7 @@ declare module 'datatables.net' {
 		/**
 		 * autoFill extension options
 		 */
-		autoFill?: boolean | ConfigAutoFill;
+		autoFill?: boolean | Partial<Defaults>;
 	}
 
 	interface ConfigLanguage {
@@ -33,7 +206,7 @@ declare module 'datatables.net' {
 	interface Api<T> {
 		/**
 		 * AutoFill methods container
-		 * 
+		 *
 		 * @returns Api for chaining with the additional autoFill methods
 		 */
 		autoFill: ApiAutoFill<T>;
@@ -43,74 +216,14 @@ declare module 'datatables.net' {
 		/**
 		 * AutoFill class
 		 */
-		AutoFill: {
-			/**
-			 * Create a new AutoFill instance for the target DataTable
-			 */
-			new (dt: Api<any>, settings: boolean | ConfigAutoFill): AutoFill;
-
-			/**
-			 * AutoFill version
-			 */
-			version: string;
-
-			/**
-			 * Default configuration values
-			 */
-			defaults: ConfigAutoFill;
-		}
+		AutoFill: AutoFill;
 	}
 }
 
-
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Options
  */
 
-interface ConfigAutoFill {
-	/**
-	 * Always ask the end user if an action should be taken or not
-	 */
-	alwaysAsk?: boolean;
-
-	/**
-	 * Select the columns that can be auto filled
-	 */
-	columns?: string | number[];
-
-	/**
-	 *
-	 * Attach an Editor instance for database updating
-	 */
-	editor?: any;
-
-	/**
-	 *
-	 * Initial enablement state of AutoFill
-	 */
-	enable?: boolean;
-
-	/**
-	 * Action that will cause the auto fill drag handle to appear in a cell
-	 */
-	focus?: 'click' | 'focus' | 'hover' | null;
-
-	/**
-	 * Enable / disable user ability to horizontally drag and fill
-	 */
-	horizontal?: boolean;
-
-	/**
-	 * Control automatic update of data when a fill drag is completed
-	 */
-	 update?: boolean;
-
-	/**
-	 * Enable / disable user ability to vertically drag and fill
-	 */
-	vertical?: boolean;
-}
-
 interface ConfigAutoFillLanguage {
 	/**
 	 * Multi-fill selector button text
@@ -148,7 +261,6 @@ interface ConfigAutoFillLanguage {
 	info?: string;
 }
 
-
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * API
  */
@@ -160,14 +272,14 @@ interface ApiAutoFill<T> {
 interface ApiAutoFillMethods<T> extends Api<T> {
 	/**
 	 * Disable AutoFill. Please note that this disallows future interactions with the table (until re-enabled).
-	 * 
+	 *
 	 * @returns DataTables Api instance
 	 */
 	disable(): Api<T>;
 
 	/**
 	 * Enable end user and API modification of the focused cells in the DataTable. Differing levels of enablement are available via the optional parameter.
-	 * 
+	 *
 	 * @param flag can be true or false to signify whether to enable or disable
 	 * @returns DataTables Api instance
 	 */
@@ -175,7 +287,7 @@ interface ApiAutoFillMethods<T> extends Api<T> {
 
 	/**
 	 * This method will return a boolean value indicating if AutoFill is enabled or not on the selected table.
-	 * 
+	 *
 	 * @returns boolean signifying if autofill is enables
 	 */
 	enabled(): boolean;