handsontable 12.1.2 → 12.2.0

package/plugins/formulas/engine/register.js

@@ -1,11 +1,8 @@
 "use strict";
 
 require("core-js/modules/es.symbol.js");
-
 require("core-js/modules/es.symbol.description.js");
-
 require("core-js/modules/es.symbol.iterator.js");
-
 exports.__esModule = true;
 exports.getRegisteredHotInstances = getRegisteredHotInstances;
 exports.registerCustomFunctions = registerCustomFunctions;
@@ -15,47 +12,26 @@ exports.registerNamedExpressions = registerNamedExpressions;
 exports.setupEngine = setupEngine;
 exports.setupSheet = setupSheet;
 exports.unregisterEngine = unregisterEngine;
-
 require("core-js/modules/es.array.iterator.js");
-
 require("core-js/modules/es.map.js");
-
 require("core-js/modules/es.object.to-string.js");
-
 require("core-js/modules/es.string.iterator.js");
-
 require("core-js/modules/web.dom-collections.iterator.js");
-
 require("core-js/modules/es.array.from.js");
-
 require("core-js/modules/es.array.map.js");
-
 require("core-js/modules/es.array.includes.js");
-
 require("core-js/modules/es.string.includes.js");
-
 require("core-js/modules/es.array.splice.js");
-
 require("core-js/modules/es.array.index-of.js");
-
 require("core-js/modules/web.dom-collections.for-each.js");
-
 require("core-js/modules/es.function.name.js");
-
 var _staticRegister = _interopRequireDefault(require("../../../utils/staticRegister"));
-
 var _mixed = require("../../../helpers/mixed");
-
 var _console = require("../../../helpers/console");
-
 var _formulas = require("../formulas");
-
 var _settings = require("./settings");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 /**
  * Prepares and returns the collection for the engine relationship with the HoT instances.
  *
@@ -64,30 +40,26 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 function getEngineRelationshipRegistry() {
   var registryKey = 'engine_relationship';
   var pluginStaticRegistry = (0, _staticRegister.default)(_formulas.PLUGIN_KEY);
-
   if (!pluginStaticRegistry.hasItem(registryKey)) {
     pluginStaticRegistry.register(registryKey, new Map());
   }
-
   return pluginStaticRegistry.getItem(registryKey);
 }
+
 /**
  * Prepares and returns the collection for the engine shared usage.
  *
  * @returns {Map}
  */
-
-
 function getSharedEngineUsageRegistry() {
   var registryKey = 'shared_engine_usage';
   var pluginStaticRegistry = (0, _staticRegister.default)(_formulas.PLUGIN_KEY);
-
   if (!pluginStaticRegistry.hasItem(registryKey)) {
     pluginStaticRegistry.register(registryKey, new Map());
   }
-
   return pluginStaticRegistry.getItem(registryKey);
 }
+
 /**
  * Setups the engine instance. It either creates a new (possibly shared) engine instance, or attaches
  * the plugin to an already-existing instance.
@@ -95,51 +67,43 @@ function getSharedEngineUsageRegistry() {
  * @param {Handsontable} hotInstance Handsontable instance.
  * @returns {null|object} Returns the engine instance if everything worked right and `null` otherwise.
  */
-
-
 function setupEngine(hotInstance) {
   var hotSettings = hotInstance.getSettings();
   var pluginSettings = hotSettings[_formulas.PLUGIN_KEY];
   var engineConfigItem = pluginSettings === null || pluginSettings === void 0 ? void 0 : pluginSettings.engine;
-
   if (pluginSettings === true) {
     return null;
   }
-
   if ((0, _mixed.isUndefined)(engineConfigItem)) {
     return null;
-  } // `engine.hyperformula` or `engine` is the engine class
-
+  }
 
+  // `engine.hyperformula` or `engine` is the engine class
   if (typeof engineConfigItem.hyperformula === 'function' || typeof engineConfigItem === 'function') {
     var _engineConfigItem$hyp;
+    return registerEngine((_engineConfigItem$hyp = engineConfigItem.hyperformula) !== null && _engineConfigItem$hyp !== void 0 ? _engineConfigItem$hyp : engineConfigItem, hotSettings, hotInstance);
 
-    return registerEngine((_engineConfigItem$hyp = engineConfigItem.hyperformula) !== null && _engineConfigItem$hyp !== void 0 ? _engineConfigItem$hyp : engineConfigItem, hotSettings, hotInstance); // `engine` is the engine instance
+    // `engine` is the engine instance
   } else if (_typeof(engineConfigItem) === 'object' && (0, _mixed.isUndefined)(engineConfigItem.hyperformula)) {
     var engineRelationship = getEngineRelationshipRegistry();
     var sharedEngineUsage = getSharedEngineUsageRegistry().get(engineConfigItem);
-
     if (!engineRelationship.has(engineConfigItem)) {
       engineRelationship.set(engineConfigItem, []);
     }
-
     engineRelationship.get(engineConfigItem).push(hotInstance);
-
     if (sharedEngineUsage) {
       sharedEngineUsage.push(hotInstance.guid);
     }
-
     if (!engineConfigItem.getConfig().licenseKey) {
       engineConfigItem.updateConfig({
         licenseKey: _settings.DEFAULT_LICENSE_KEY
       });
     }
-
     return engineConfigItem;
   }
-
   return null;
 }
+
 /**
  * Registers the engine in the global register and attaches the needed event listeners.
  *
@@ -148,22 +112,23 @@ function setupEngine(hotInstance) {
  * @param {Handsontable} hotInstance Handsontable instance.
  * @returns {object} Returns the engine instance.
  */
-
-
 function registerEngine(engineClass, hotSettings, hotInstance) {
   var pluginSettings = hotSettings[_formulas.PLUGIN_KEY];
   var engineSettings = (0, _settings.getEngineSettingsWithDefaultsAndOverrides)(hotSettings);
   var engineRegistry = getEngineRelationshipRegistry();
   var sharedEngineRegistry = getSharedEngineUsageRegistry();
   registerCustomFunctions(engineClass, pluginSettings.functions);
-  registerLanguage(engineClass, pluginSettings.language); // Create instance
+  registerLanguage(engineClass, pluginSettings.language);
 
-  var engineInstance = engineClass.buildEmpty(engineSettings); // Add it to global registry
+  // Create instance
+  var engineInstance = engineClass.buildEmpty(engineSettings);
 
+  // Add it to global registry
   engineRegistry.set(engineInstance, [hotInstance]);
   sharedEngineRegistry.set(engineInstance, [hotInstance.guid]);
-  registerNamedExpressions(engineInstance, pluginSettings.namedExpressions); // Add hooks needed for cross-referencing sheets
+  registerNamedExpressions(engineInstance, pluginSettings.namedExpressions);
 
+  // Add hooks needed for cross-referencing sheets
   engineInstance.on('sheetAdded', function () {
     engineInstance.rebuildAndRecalculate();
   });
@@ -172,23 +137,22 @@ function registerEngine(engineClass, hotSettings, hotInstance) {
   });
   return engineInstance;
 }
+
 /**
  * Returns the list of the Handsontable instances linked to the specific engine instance.
  *
  * @param {object} engine The engine instance.
  * @returns {Map<number, Handsontable>} Returns Map with Handsontable instances.
  */
-
-
 function getRegisteredHotInstances(engine) {
   var _engineRegistry$get;
-
   var engineRegistry = getEngineRelationshipRegistry();
   var hotInstances = engineRegistry.size === 0 ? [] : Array.from((_engineRegistry$get = engineRegistry.get(engine)) !== null && _engineRegistry$get !== void 0 ? _engineRegistry$get : []);
   return new Map(hotInstances.map(function (hot) {
     return [hot.getPlugin('formulas').sheetId, hot];
   }));
 }
+
 /**
  * Removes the HOT instance from the global register's engine usage array, and if there are no HOT instances left,
  * unregisters the engine itself.
@@ -196,26 +160,20 @@ function getRegisteredHotInstances(engine) {
  * @param {object} engine The engine instance.
  * @param {string} hotInstance The Handsontable instance.
  */
-
-
 function unregisterEngine(engine, hotInstance) {
   if (engine) {
     var engineRegistry = getEngineRelationshipRegistry();
     var engineHotRelationship = engineRegistry.get(engine);
     var sharedEngineRegistry = getSharedEngineUsageRegistry();
     var sharedEngineUsage = sharedEngineRegistry.get(engine);
-
     if (engineHotRelationship && engineHotRelationship.includes(hotInstance)) {
       engineHotRelationship.splice(engineHotRelationship.indexOf(hotInstance), 1);
-
       if (engineHotRelationship.length === 0) {
         engineRegistry.delete(engine);
       }
     }
-
     if (sharedEngineUsage && sharedEngineUsage.includes(hotInstance.guid)) {
       sharedEngineUsage.splice(sharedEngineUsage.indexOf(hotInstance.guid), 1);
-
       if (sharedEngineUsage.length === 0) {
         sharedEngineRegistry.delete(engine);
         engine.destroy();
@@ -223,21 +181,19 @@ function unregisterEngine(engine, hotInstance) {
     }
   }
 }
+
 /**
  * Registers the custom functions for the engine.
  *
  * @param {Function} engineClass The engine class.
  * @param {Array} customFunctions The custom functions array.
  */
-
-
 function registerCustomFunctions(engineClass, customFunctions) {
   if (customFunctions) {
     customFunctions.forEach(function (func) {
       var name = func.name,
-          plugin = func.plugin,
-          translations = func.translations;
-
+        plugin = func.plugin,
+        translations = func.translations;
       try {
         engineClass.registerFunction(name, plugin, translations);
       } catch (e) {
@@ -246,18 +202,16 @@ function registerCustomFunctions(engineClass, customFunctions) {
     });
   }
 }
+
 /**
  * Registers the provided language for the engine.
  *
  * @param {Function} engineClass The engine class.
  * @param {object} languageSetting The engine's language object.
  */
-
-
 function registerLanguage(engineClass, languageSetting) {
   if (languageSetting) {
     var langCode = languageSetting.langCode;
-
     try {
       engineClass.registerLanguage(langCode, languageSetting);
     } catch (e) {
@@ -265,23 +219,21 @@ function registerLanguage(engineClass, languageSetting) {
     }
   }
 }
+
 /**
  * Registers the provided named expressions in the engine instance.
  *
  * @param {object} engineInstance The engine instance.
  * @param {Array} namedExpressions Array of the named expressions to be registered.
  */
-
-
 function registerNamedExpressions(engineInstance, namedExpressions) {
   if (namedExpressions) {
     engineInstance.suspendEvaluation();
     namedExpressions.forEach(function (namedExp) {
       var name = namedExp.name,
-          expression = namedExp.expression,
-          scope = namedExp.scope,
-          options = namedExp.options;
-
+        expression = namedExp.expression,
+        scope = namedExp.scope,
+        options = namedExp.options;
       try {
         engineInstance.addNamedExpression(name, expression, scope, options);
       } catch (e) {
@@ -291,6 +243,7 @@ function registerNamedExpressions(engineInstance, namedExpressions) {
     engineInstance.resumeEvaluation();
   }
 }
+
 /**
  * Sets up a new sheet.
  *
@@ -298,12 +251,9 @@ function registerNamedExpressions(engineInstance, namedExpressions) {
  * @param {string} sheetName The new sheet name.
  * @returns {*}
  */
-
-
 function setupSheet(engineInstance, sheetName) {
   if ((0, _mixed.isUndefined)(sheetName) || !engineInstance.doesSheetExist(sheetName)) {
     sheetName = engineInstance.addSheet(sheetName);
   }
-
   return sheetName;
 }

package/plugins/formulas/engine/register.mjs

@@ -1,5 +1,4 @@
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 import "core-js/modules/es.array.iterator.js";
 import "core-js/modules/es.map.js";
 import "core-js/modules/es.object.to-string.js";
@@ -20,40 +19,34 @@ import staticRegister from "../../../utils/staticRegister.mjs";
 import { isUndefined } from "../../../helpers/mixed.mjs";
 import { warn } from "../../../helpers/console.mjs";
 import { PLUGIN_KEY } from "../formulas.mjs";
-import { DEFAULT_LICENSE_KEY, getEngineSettingsWithDefaultsAndOverrides } from "./settings.mjs";
-/**
- * Prepares and returns the collection for the engine relationship with the HoT instances.
- *
- * @returns {Map}
- */
-
+import { DEFAULT_LICENSE_KEY, getEngineSettingsWithDefaultsAndOverrides } from "./settings.mjs"; /**
+                                                                                                  * Prepares and returns the collection for the engine relationship with the HoT instances.
+                                                                                                  *
+                                                                                                  * @returns {Map}
+                                                                                                  */
 function getEngineRelationshipRegistry() {
   var registryKey = 'engine_relationship';
   var pluginStaticRegistry = staticRegister(PLUGIN_KEY);
-
   if (!pluginStaticRegistry.hasItem(registryKey)) {
     pluginStaticRegistry.register(registryKey, new Map());
   }
-
   return pluginStaticRegistry.getItem(registryKey);
 }
+
 /**
  * Prepares and returns the collection for the engine shared usage.
  *
  * @returns {Map}
  */
-
-
 function getSharedEngineUsageRegistry() {
   var registryKey = 'shared_engine_usage';
   var pluginStaticRegistry = staticRegister(PLUGIN_KEY);
-
   if (!pluginStaticRegistry.hasItem(registryKey)) {
     pluginStaticRegistry.register(registryKey, new Map());
   }
-
   return pluginStaticRegistry.getItem(registryKey);
 }
+
 /**
  * Setups the engine instance. It either creates a new (possibly shared) engine instance, or attaches
  * the plugin to an already-existing instance.
@@ -61,51 +54,43 @@ function getSharedEngineUsageRegistry() {
  * @param {Handsontable} hotInstance Handsontable instance.
  * @returns {null|object} Returns the engine instance if everything worked right and `null` otherwise.
  */
-
-
 export function setupEngine(hotInstance) {
   var hotSettings = hotInstance.getSettings();
   var pluginSettings = hotSettings[PLUGIN_KEY];
   var engineConfigItem = pluginSettings === null || pluginSettings === void 0 ? void 0 : pluginSettings.engine;
-
   if (pluginSettings === true) {
     return null;
   }
-
   if (isUndefined(engineConfigItem)) {
     return null;
-  } // `engine.hyperformula` or `engine` is the engine class
-
+  }
 
+  // `engine.hyperformula` or `engine` is the engine class
   if (typeof engineConfigItem.hyperformula === 'function' || typeof engineConfigItem === 'function') {
     var _engineConfigItem$hyp;
+    return registerEngine((_engineConfigItem$hyp = engineConfigItem.hyperformula) !== null && _engineConfigItem$hyp !== void 0 ? _engineConfigItem$hyp : engineConfigItem, hotSettings, hotInstance);
 
-    return registerEngine((_engineConfigItem$hyp = engineConfigItem.hyperformula) !== null && _engineConfigItem$hyp !== void 0 ? _engineConfigItem$hyp : engineConfigItem, hotSettings, hotInstance); // `engine` is the engine instance
+    // `engine` is the engine instance
   } else if (_typeof(engineConfigItem) === 'object' && isUndefined(engineConfigItem.hyperformula)) {
     var engineRelationship = getEngineRelationshipRegistry();
     var sharedEngineUsage = getSharedEngineUsageRegistry().get(engineConfigItem);
-
     if (!engineRelationship.has(engineConfigItem)) {
       engineRelationship.set(engineConfigItem, []);
     }
-
     engineRelationship.get(engineConfigItem).push(hotInstance);
-
     if (sharedEngineUsage) {
       sharedEngineUsage.push(hotInstance.guid);
     }
-
     if (!engineConfigItem.getConfig().licenseKey) {
       engineConfigItem.updateConfig({
         licenseKey: DEFAULT_LICENSE_KEY
       });
     }
-
     return engineConfigItem;
   }
-
   return null;
 }
+
 /**
  * Registers the engine in the global register and attaches the needed event listeners.
  *
@@ -114,21 +99,23 @@ export function setupEngine(hotInstance) {
  * @param {Handsontable} hotInstance Handsontable instance.
  * @returns {object} Returns the engine instance.
  */
-
 export function registerEngine(engineClass, hotSettings, hotInstance) {
   var pluginSettings = hotSettings[PLUGIN_KEY];
   var engineSettings = getEngineSettingsWithDefaultsAndOverrides(hotSettings);
   var engineRegistry = getEngineRelationshipRegistry();
   var sharedEngineRegistry = getSharedEngineUsageRegistry();
   registerCustomFunctions(engineClass, pluginSettings.functions);
-  registerLanguage(engineClass, pluginSettings.language); // Create instance
+  registerLanguage(engineClass, pluginSettings.language);
 
-  var engineInstance = engineClass.buildEmpty(engineSettings); // Add it to global registry
+  // Create instance
+  var engineInstance = engineClass.buildEmpty(engineSettings);
 
+  // Add it to global registry
   engineRegistry.set(engineInstance, [hotInstance]);
   sharedEngineRegistry.set(engineInstance, [hotInstance.guid]);
-  registerNamedExpressions(engineInstance, pluginSettings.namedExpressions); // Add hooks needed for cross-referencing sheets
+  registerNamedExpressions(engineInstance, pluginSettings.namedExpressions);
 
+  // Add hooks needed for cross-referencing sheets
   engineInstance.on('sheetAdded', function () {
     engineInstance.rebuildAndRecalculate();
   });
@@ -137,22 +124,22 @@ export function registerEngine(engineClass, hotSettings, hotInstance) {
   });
   return engineInstance;
 }
+
 /**
  * Returns the list of the Handsontable instances linked to the specific engine instance.
  *
  * @param {object} engine The engine instance.
  * @returns {Map<number, Handsontable>} Returns Map with Handsontable instances.
  */
-
 export function getRegisteredHotInstances(engine) {
   var _engineRegistry$get;
-
   var engineRegistry = getEngineRelationshipRegistry();
   var hotInstances = engineRegistry.size === 0 ? [] : Array.from((_engineRegistry$get = engineRegistry.get(engine)) !== null && _engineRegistry$get !== void 0 ? _engineRegistry$get : []);
   return new Map(hotInstances.map(function (hot) {
     return [hot.getPlugin('formulas').sheetId, hot];
   }));
 }
+
 /**
  * Removes the HOT instance from the global register's engine usage array, and if there are no HOT instances left,
  * unregisters the engine itself.
@@ -160,25 +147,20 @@ export function getRegisteredHotInstances(engine) {
  * @param {object} engine The engine instance.
  * @param {string} hotInstance The Handsontable instance.
  */
-
 export function unregisterEngine(engine, hotInstance) {
   if (engine) {
     var engineRegistry = getEngineRelationshipRegistry();
     var engineHotRelationship = engineRegistry.get(engine);
     var sharedEngineRegistry = getSharedEngineUsageRegistry();
     var sharedEngineUsage = sharedEngineRegistry.get(engine);
-
     if (engineHotRelationship && engineHotRelationship.includes(hotInstance)) {
       engineHotRelationship.splice(engineHotRelationship.indexOf(hotInstance), 1);
-
       if (engineHotRelationship.length === 0) {
         engineRegistry.delete(engine);
       }
     }
-
     if (sharedEngineUsage && sharedEngineUsage.includes(hotInstance.guid)) {
       sharedEngineUsage.splice(sharedEngineUsage.indexOf(hotInstance.guid), 1);
-
       if (sharedEngineUsage.length === 0) {
         sharedEngineRegistry.delete(engine);
         engine.destroy();
@@ -186,20 +168,19 @@ export function unregisterEngine(engine, hotInstance) {
     }
   }
 }
+
 /**
  * Registers the custom functions for the engine.
  *
  * @param {Function} engineClass The engine class.
  * @param {Array} customFunctions The custom functions array.
  */
-
 export function registerCustomFunctions(engineClass, customFunctions) {
   if (customFunctions) {
     customFunctions.forEach(function (func) {
       var name = func.name,
-          plugin = func.plugin,
-          translations = func.translations;
-
+        plugin = func.plugin,
+        translations = func.translations;
       try {
         engineClass.registerFunction(name, plugin, translations);
       } catch (e) {
@@ -208,17 +189,16 @@ export function registerCustomFunctions(engineClass, customFunctions) {
     });
   }
 }
+
 /**
  * Registers the provided language for the engine.
  *
  * @param {Function} engineClass The engine class.
  * @param {object} languageSetting The engine's language object.
  */
-
 export function registerLanguage(engineClass, languageSetting) {
   if (languageSetting) {
     var langCode = languageSetting.langCode;
-
     try {
       engineClass.registerLanguage(langCode, languageSetting);
     } catch (e) {
@@ -226,22 +206,21 @@ export function registerLanguage(engineClass, languageSetting) {
     }
   }
 }
+
 /**
  * Registers the provided named expressions in the engine instance.
  *
  * @param {object} engineInstance The engine instance.
  * @param {Array} namedExpressions Array of the named expressions to be registered.
  */
-
 export function registerNamedExpressions(engineInstance, namedExpressions) {
   if (namedExpressions) {
     engineInstance.suspendEvaluation();
     namedExpressions.forEach(function (namedExp) {
       var name = namedExp.name,
-          expression = namedExp.expression,
-          scope = namedExp.scope,
-          options = namedExp.options;
-
+        expression = namedExp.expression,
+        scope = namedExp.scope,
+        options = namedExp.options;
       try {
         engineInstance.addNamedExpression(name, expression, scope, options);
       } catch (e) {
@@ -251,6 +230,7 @@ export function registerNamedExpressions(engineInstance, namedExpressions) {
     engineInstance.resumeEvaluation();
   }
 }
+
 /**
  * Sets up a new sheet.
  *
@@ -258,11 +238,9 @@ export function registerNamedExpressions(engineInstance, namedExpressions) {
  * @param {string} sheetName The new sheet name.
  * @returns {*}
  */
-
 export function setupSheet(engineInstance, sheetName) {
   if (isUndefined(sheetName) || !engineInstance.doesSheetExist(sheetName)) {
     sheetName = engineInstance.addSheet(sheetName);
   }
-
   return sheetName;
 }