Merge pull request #1256 from adumesny/typescript

TS: doc/types cleanup

Author: adumesny

src/gridstack.ts

@@ -1024,8 +1024,8 @@ export class GridStack {
     return this;
   }
 
-  // @internal eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private _triggerEvent(name: string, data?: any): GridStack {
+  /** @internal */
+  private _triggerEvent(name: string, data?: GridStackNode[]): GridStack {
     let event = data ? new CustomEvent(name, {bubbles: false, detail: data}) : new Event(name);
     this.el.dispatchEvent(event);
     return this;
@@ -1290,7 +1290,7 @@ export class GridStack {
       node.el = target;
 
       if (node._isAboutToRemove) {
-        let gridToNotify = el.gridstackNode._grid;
+        let gridToNotify = el.gridstackNode.grid;
         if (gridToNotify._gsEventHandler[event.type]) {
           gridToNotify._gsEventHandler[event.type](event, target);
         }
@@ -1354,7 +1354,7 @@ export class GridStack {
   /** @internal */
   private _prepareElement(el: GridItemHTMLElement, triggerAddEvent = false): GridStack {
     el.classList.add(this.opts.itemClass);
-    let node = this._readAttr(el, { el: el, _grid: this });
+    let node = this._readAttr(el, { el: el, grid: this });
     node = this.engine.addNode(node, triggerAddEvent);
     el.gridstackNode = node;
 
@@ -1492,13 +1492,13 @@ export class GridStack {
       this.dd
         .on(trashZone, 'dropover', (event, el) => {
           let node = el.gridstackNode;
-          if (!node || node._grid !== this) return;
+          if (!node || node.grid !== this) return;
           el.dataset.inTrashZone = 'true';
           this._setupRemovingTimeout(el);
         })
         .on(trashZone, 'dropout', (event, el) => {
           let node = el.gridstackNode;
-          if (!node || node._grid !== this) return;
+          if (!node || node.grid !== this) return;
           delete el.dataset.inTrashZone;
           this._clearRemovingTimeout(el);
         });
@@ -1543,7 +1543,7 @@ export class GridStack {
       .droppable(this.el, {
         accept: (el: GridItemHTMLElement) => {
           let node: GridStackNode = el.gridstackNode;
-          if (node && node._grid === this) {
+          if (node && node.grid === this) {
             return false;
           }
           if (typeof this.opts.acceptWidgets === 'function') {
@@ -1604,7 +1604,7 @@ export class GridStack {
         }
         let node: GridStackNode = _el.gridstackNode;
         this.engine.cleanupNode(node);
-        node._grid = this;
+        node.grid = this;
         let originalNode = _el._gridstackNodeOrig;
         delete _el.gridstackNode;
         delete _el._gridstackNodeOrig;
@@ -1616,8 +1616,8 @@ export class GridStack {
         let el = _el.cloneNode(true) as GridItemHTMLElement;
 
         el.gridstackNode = node;
-        if (originalNode && originalNode._grid) {
-          originalNode._grid._triggerRemoveEvent();
+        if (originalNode && originalNode.grid) {
+          originalNode.grid._triggerRemoveEvent();
         }
         _el.remove();
         node.el = el;

src/types.ts

@@ -11,7 +11,8 @@ import { GridStackDragDropPlugin } from './gridstack-dragdrop-plugin';
 
 export type numberOrString = number | string;
 export interface GridItemHTMLElement extends HTMLElement {
-  gridstackNode?: GridStackNode; // grid items point back to node
+  /** pointer to grid node instance */
+  gridstackNode?: GridStackNode;
   /** @internal */
   _gridstackNodeOrig?: GridStackNode;
 }
@@ -223,28 +224,50 @@ export interface DDDragOpt {
  * internal descriptions describing the items in the grid
  */
 export interface GridStackNode extends GridstackWidget {
+  /** pointer back to HTML element */
   el?: GridItemHTMLElement;
-  /** @internal need to do that for each and use --stripInternal */
+  /** pointer back to Grid instance */
+  grid?: GridStack;
+  /** @internal */
   _id?: number;
-  _grid?: GridStack;
+  /** @internal */
   _dirty?: boolean;
+  /** @internal */
   _updating?: boolean;
+  /** @internal */
   _added?: boolean;
+  /** @internal */
   _temporary?: boolean;
+  /** @internal */
   _isOutOfGrid?: boolean;
+  /** @internal */
   _origX?: number;
+  /** @internal */
   _origY?: number;
+  /** @internal */
   _packY?: number;
+  /** @internal */
   _origW?: number;
+  /** @internal */
   _origH?: number;
+  /** @internal */
   _lastTriedX?: number;
+  /** @internal */
   _lastTriedY?: number;
+  /** @internal */
   _lastTriedWidth?: number;
+  /** @internal */
   _lastTriedHeight?: number;
+  /** @internal */
   _isAboutToRemove?: boolean;
+  /** @internal */
   _removeTimeout?: number;
+  /** @internal */
   _beforeDragX?: number;
+  /** @internal */
   _beforeDragY?: number;
+  /** @internal */
   _prevYPix?: number;
+  /** @internal */
   _temporaryRemoved?: boolean;
 }

src/utils.ts

@@ -216,7 +216,7 @@ export class Utils {
     return returnEl;
   }
 
-  /** @private */
+  /** @internal */
   static updateScrollPosition(el: HTMLElement, position: {top: number}, distance: number) {
     // is widget in view?
     let rect = el.getBoundingClientRect();

webpack.config.js

@@ -4,7 +4,7 @@ module.exports = {
   entry: {
     'gridstack.all': './src/index.ts'
   },
-  mode: 'development', // production vs development
+  mode: 'production', // production vs development
   module: {
     rules: [
       {