angular-slickgrid 6.6.2 → 6.6.3

package/fesm2022/angular-slickgrid.mjs

@@ -1056,6 +1056,13 @@ class AngularSlickgridComponent {
         if (!this.gridOptions || !this.columnDefinitions) {
             throw new Error('Using `<angular-slickgrid>` requires [gridOptions] and [columnDefinitions], it seems that you might have forgot to provide them since at least of them is undefined.');
         }
+        // save resource refs to register before the grid options are merged and possibly deep copied
+        // since a deep copy of grid options would lose original resource refs but we want to keep them as singleton
+        this._registeredResources = this.gridOptions?.externalResources || this.gridOptions?.registerExternalResources || [];
+        /* istanbul ignore if */
+        if (this.gridOptions?.registerExternalResources) {
+            console.warn('[Angular-Slickgrid] Please note that the grid option `registerExternalResources` was deprecated and will be removed in next major, please use `externalResources` instead.');
+        }
         this.initialization(this._eventHandler);
         this._isGridInitialized = true;
         // recheck the empty warning message after grid is shown so that it works in every use case
@@ -1078,15 +1085,7 @@ class AngularSlickgridComponent {
         });
         this.serviceList = [];
         // dispose all registered external resources
-        if (Array.isArray(this._registeredResources)) {
-            while (this._registeredResources.length > 0) {
-                const resource = this._registeredResources.pop();
-                if (resource?.dispose) {
-                    resource.dispose();
-                }
-            }
-            this._registeredResources = [];
-        }
+        this.disposeExternalResources();
         // dispose the Components
         this.slickEmptyWarning?.dispose();
         this.slickFooter?.dispose();
@@ -1126,6 +1125,17 @@ class AngularSlickgridComponent {
         this._angularGridInstances = undefined;
         this.slickGrid = undefined;
     }
+    disposeExternalResources() {
+        if (Array.isArray(this._registeredResources)) {
+            while (this._registeredResources.length > 0) {
+                const res = this._registeredResources.pop();
+                if (res?.dispose) {
+                    res.dispose();
+                }
+            }
+        }
+        this._registeredResources = [];
+    }
     emptyGridContainerElm() {
         const gridContainerId = this.gridOptions?.gridContainerId ?? 'grid1';
         const gridContainerElm = document.querySelector(`#${gridContainerId}`);
@@ -1438,7 +1448,7 @@ class AngularSlickgridComponent {
         return showing;
     }
     //
-    // private functions
+    // protected functions
     // ------------------
     /**
      * Loop through all column definitions and copy the original optional `width` properties optionally provided by the user.
@@ -1845,9 +1855,19 @@ class AngularSlickgridComponent {
         }
         return options;
     }
+    /** Add a register a new external resource, user could also optional dispose all previous resources before pushing any new resources to the resources array list. */
+    registerExternalResources(resources, disposePreviousResources = false) {
+        if (disposePreviousResources) {
+            this.disposeExternalResources();
+        }
+        resources.forEach(res => this._registeredResources.push(res));
+        this.initializeExternalResources(resources);
+    }
+    resetExternalResources() {
+        this._registeredResources = [];
+    }
     /** Pre-Register any Resource that don't require SlickGrid to be instantiated (for example RxJS Resource & RowDetail) */
     preRegisterResources() {
-        this._registeredResources = this.gridOptions.registerExternalResources || [];
         // Angular-Slickgrid requires RxJS, so we'll register it as the first resource
         this.registerRxJsResource(new RxJsResource());
         if (this.gridOptions.enableRowDetailView) {
@@ -1857,6 +1877,15 @@ class AngularSlickgridComponent {
             this.extensionService.addExtensionToList(ExtensionName.rowDetailView, { name: ExtensionName.rowDetailView, instance: this.slickRowDetailView });
         }
     }
+    initializeExternalResources(resources) {
+        if (Array.isArray(resources)) {
+            for (const resource of resources) {
+                if (this.slickGrid && typeof resource.init === 'function') {
+                    resource.init(this.slickGrid, this.containerService);
+                }
+            }
+        }
+    }
     registerResources() {
         // at this point, we consider all the registered services as external services, anything else registered afterward aren't external
         if (Array.isArray(this._registeredResources)) {
@@ -1881,13 +1910,7 @@ class AngularSlickgridComponent {
         this._registeredResources.push(this.slickEmptyWarning);
         // bind & initialize all Components/Services that were tagged as enabled
         // register all services by executing their init method and providing them with the Grid object
-        if (Array.isArray(this._registeredResources)) {
-            for (const resource of this._registeredResources) {
-                if (this.slickGrid && typeof resource.init === 'function') {
-                    resource.init(this.slickGrid, this.containerService);
-                }
-            }
-        }
+        this.initializeExternalResources(this._registeredResources);
     }
     /** Register the RxJS Resource in all necessary services which uses */
     registerRxJsResource(resource) {