@adaptabletools/adaptable 11.2.0-canary.0 → 11.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.2.0-canary.0",
+  "version": "11.2.0",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1652263696641;
+declare const _default: 1652269439987;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1652263696641;
+exports.default = 1652269439987;

package/src/Api/EventApi.d.ts

@@ -205,12 +205,25 @@ export interface EventApi {
      * ```
      */
     on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;
+    /**
+     * Fired when Adaptable is destroyed
+     * @param eventName - AdaptableDestroy
+     * @param callback - A callback for listening to `AdaptableDestroy`
+     * @returns the unsubscribe function
+     *
+     * @example Use as
+     * ```
+     * adaptableApi.eventApi.on('AdaptableDestroy', () => { .....[do stuff]...})
+     * ```
+     */
+    on(eventName: 'AdaptableDestroy', callback: () => void): VoidFunction;
     /**
      * Unsubscribe from AdaptableReady
      */
     off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
+    emitSync(eventName: 'AdaptableDestroy'): any[];
     emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/Implementation/EventApiImpl.js

@@ -24,6 +24,7 @@ class EventApiImpl extends ApiBase_1.ApiBase {
         this.emitter = new Emitter_1.default();
     }
     destroy() {
+        this.emitSync('AdaptableDestroy');
         this.emitter.destroy();
     }
 }

package/src/Utilities/Emitter.js

@@ -18,6 +18,11 @@ function assertListener(listener) {
 }
 function getListeners(instance, eventName) {
     const events = eventsMap.get(instance);
+    if (!events) {
+        // we're hitting this case only when calling `off` after the instance has been destroyed (so extremely rarely)
+        // so we want to return an empty set in order not to make the code throw an error
+        return new Set();
+    }
     if (!events.has(eventName)) {
         events.set(eventName, new Set());
     }

package/src/View/Components/Popups/AdaptableToaster.js

@@ -7,10 +7,19 @@ const ObjectFactory_1 = tslib_1.__importDefault(require("../../../Utilities/Obje
 const AdaptablePopupAlert_1 = require("./AdaptablePopupAlert");
 const react_toastify_1 = require("react-toastify");
 exports.showToast = (props) => {
+    // we're doing this hack and not simply using props.api in order not to have a memory
+    // leak where the api is still kept around in memory by the toaster
+    let api = props.api;
+    const off = api.eventApi.on('AdaptableDestroy', () => {
+        api = null;
+    });
     const toastProps = ObjectFactory_1.default.CreateToastOptions(props.api.internalApi.getAdaptableOptions().notificationsOptions, {
         onClose: () => {
-            if (!props.api.isDestroyed()) {
-                props.api.internalApi.hidePopupAlert();
+            if (api) {
+                off();
+                if (!api.isDestroyed()) {
+                    api.internalApi.hidePopupAlert();
+                }
             }
         },
     });

package/src/metamodel/adaptable.metamodel.js

@@ -5195,6 +5195,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Fired when Adaptable is up and running - has no arguments.",
                 "uiLabel": "On"
             },
+            {
+                "name": "on",
+                "kind": "function",
+                "description": "Fired when Adaptable is destroyed",
+                "uiLabel": "On"
+            },
             {
                 "name": "on",
                 "kind": "function",

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.2.0-canary.0";
+declare const _default: "11.2.0";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.2.0-canary.0'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.2.0'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version