handsontable 0.0.0-next-9ec04ce-20221121

package/plugins/formulas/engine/register.mjs

@@ -0,0 +1,247 @@
+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";
+import "core-js/modules/es.string.iterator.js";
+import "core-js/modules/web.dom-collections.iterator.js";
+import "core-js/modules/es.array.from.js";
+import "core-js/modules/es.array.map.js";
+import "core-js/modules/es.array.includes.js";
+import "core-js/modules/es.string.includes.js";
+import "core-js/modules/es.array.splice.js";
+import "core-js/modules/es.array.index-of.js";
+import "core-js/modules/web.dom-collections.for-each.js";
+import "core-js/modules/es.function.name.js";
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.symbol.description.js";
+import "core-js/modules/es.symbol.iterator.js";
+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}
+ */
+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.
+ *
+ * @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
+  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);
+
+    // `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.
+ *
+ * @param {Function} engineClass The engine class.
+ * @param {object} hotSettings The Handsontable settings.
+ * @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
+  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
+  engineInstance.on('sheetAdded', function () {
+    engineInstance.rebuildAndRecalculate();
+  });
+  engineInstance.on('sheetRemoved', function () {
+    engineInstance.rebuildAndRecalculate();
+  });
+  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.
+ *
+ * @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();
+      }
+    }
+  }
+}
+
+/**
+ * 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;
+      try {
+        engineClass.registerFunction(name, plugin, translations);
+      } catch (e) {
+        warn(e.message);
+      }
+    });
+  }
+}
+
+/**
+ * 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) {
+      warn(e.message);
+    }
+  }
+}
+
+/**
+ * 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;
+      try {
+        engineInstance.addNamedExpression(name, expression, scope, options);
+      } catch (e) {
+        warn(e.message);
+      }
+    });
+    engineInstance.resumeEvaluation();
+  }
+}
+
+/**
+ * Sets up a new sheet.
+ *
+ * @param {object} engineInstance The engine instance.
+ * @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;
+}

package/plugins/formulas/engine/settings.js

@@ -0,0 +1,115 @@
+"use strict";
+
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.object.get-own-property-descriptor.js");
+require("core-js/modules/web.dom-collections.for-each.js");
+require("core-js/modules/es.object.get-own-property-descriptors.js");
+exports.__esModule = true;
+exports.DEFAULT_LICENSE_KEY = void 0;
+exports.getEngineSettingsOverrides = getEngineSettingsOverrides;
+exports.getEngineSettingsWithDefaultsAndOverrides = getEngineSettingsWithDefaultsAndOverrides;
+exports.getEngineSettingsWithOverrides = getEngineSettingsWithOverrides;
+require("core-js/modules/es.array.reduce.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.object.keys.js");
+var _formulas = require("../formulas");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+var DEFAULT_LICENSE_KEY = 'internal-use-in-handsontable';
+exports.DEFAULT_LICENSE_KEY = DEFAULT_LICENSE_KEY;
+var DEFAULT_SETTINGS = {
+  licenseKey: DEFAULT_LICENSE_KEY,
+  useArrayArithmetic: true,
+  useColumnIndex: false,
+  useStats: false,
+  evaluateNullToZero: true,
+  precisionEpsilon: 1e-13,
+  precisionRounding: 14,
+  smartRounding: true,
+  leapYear1900: true,
+  nullDate: {
+    year: 1899,
+    month: 12,
+    day: 31
+  },
+  nullYear: 30,
+  dateFormats: ['DD/MM/YYYY', 'DD/MM/YY'],
+  timeFormats: ['hh:mm', 'hh:mm:ss.sss'],
+  matchWholeCell: true,
+  useRegularExpressions: false,
+  useWildcards: true,
+  functionArgSeparator: ',',
+  thousandSeparator: '',
+  decimalSeparator: '.',
+  language: 'enGB'
+};
+
+/**
+ * Gets a set of engine settings to be applied on top of the provided settings, based on user's Handsontable settings.
+ *
+ * @param {object} hotSettings Handsontable settings object.
+ * @returns {object} Object containing the overriding options.
+ */
+function getEngineSettingsOverrides(hotSettings) {
+  var _hotSettings$PLUGIN_K, _hotSettings$PLUGIN_K2;
+  return {
+    maxColumns: hotSettings.maxColumns,
+    maxRows: hotSettings.maxRows,
+    language: (_hotSettings$PLUGIN_K = hotSettings[_formulas.PLUGIN_KEY]) === null || _hotSettings$PLUGIN_K === void 0 ? void 0 : (_hotSettings$PLUGIN_K2 = _hotSettings$PLUGIN_K.language) === null || _hotSettings$PLUGIN_K2 === void 0 ? void 0 : _hotSettings$PLUGIN_K2.langCode
+  };
+}
+
+/**
+ * Drop `hyperformula` key from object if it exists.
+ *
+ * @param {object} pluginSettings Formulas plugin settings.
+ * @returns {object}
+ */
+function cleanEngineSettings(pluginSettings) {
+  return Object.keys(pluginSettings).reduce(function (obj, key) {
+    if (key !== 'hyperformula') {
+      obj[key] = pluginSettings[key];
+    }
+    return obj;
+  }, {});
+}
+
+/**
+ * Takes the default, user and overriding settings and merges them into a single object to be passed to the engine.
+ *
+ * The final object gets its parameters in the following order,
+ * with properties attached to objects listed in the lower levels of the list overriding the
+ * ones above them:
+ *
+ * 1. Default settings
+ * 2. User settings
+ * 3. Overrides.
+ *
+ * Meant to be used during *initialization* of the engine.
+ *
+ * @param {object} hotSettings The Handsontable settings.
+ * @returns {object} The final engine settings.
+ */
+function getEngineSettingsWithDefaultsAndOverrides(hotSettings) {
+  var _pluginSettings$engin;
+  var pluginSettings = hotSettings[_formulas.PLUGIN_KEY];
+  var userSettings = cleanEngineSettings(pluginSettings !== null && pluginSettings !== void 0 && (_pluginSettings$engin = pluginSettings.engine) !== null && _pluginSettings$engin !== void 0 && _pluginSettings$engin.hyperformula ? pluginSettings.engine : {});
+  var overrides = getEngineSettingsOverrides(hotSettings);
+  return _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_SETTINGS), userSettings), overrides);
+}
+
+/**
+ * Get engine settings from a Handsontable settings object with overrides.
+ *
+ * @param {object} hotSettings Handsontable settings object.
+ * @returns {object}
+ */
+function getEngineSettingsWithOverrides(hotSettings) {
+  var _pluginSettings$engin2;
+  var pluginSettings = hotSettings[_formulas.PLUGIN_KEY];
+  var userSettings = cleanEngineSettings(pluginSettings !== null && pluginSettings !== void 0 && (_pluginSettings$engin2 = pluginSettings.engine) !== null && _pluginSettings$engin2 !== void 0 && _pluginSettings$engin2.hyperformula ? pluginSettings.engine : {});
+  var overrides = getEngineSettingsOverrides(hotSettings);
+  return _objectSpread(_objectSpread({}, userSettings), overrides);
+}

package/plugins/formulas/engine/settings.mjs

@@ -0,0 +1,107 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+import "core-js/modules/es.array.reduce.js";
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/es.object.keys.js";
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.array.filter.js";
+import "core-js/modules/es.object.get-own-property-descriptor.js";
+import "core-js/modules/web.dom-collections.for-each.js";
+import "core-js/modules/es.object.get-own-property-descriptors.js";
+import { PLUGIN_KEY } from "../formulas.mjs";
+export var DEFAULT_LICENSE_KEY = 'internal-use-in-handsontable';
+var DEFAULT_SETTINGS = {
+  licenseKey: DEFAULT_LICENSE_KEY,
+  useArrayArithmetic: true,
+  useColumnIndex: false,
+  useStats: false,
+  evaluateNullToZero: true,
+  precisionEpsilon: 1e-13,
+  precisionRounding: 14,
+  smartRounding: true,
+  leapYear1900: true,
+  nullDate: {
+    year: 1899,
+    month: 12,
+    day: 31
+  },
+  nullYear: 30,
+  dateFormats: ['DD/MM/YYYY', 'DD/MM/YY'],
+  timeFormats: ['hh:mm', 'hh:mm:ss.sss'],
+  matchWholeCell: true,
+  useRegularExpressions: false,
+  useWildcards: true,
+  functionArgSeparator: ',',
+  thousandSeparator: '',
+  decimalSeparator: '.',
+  language: 'enGB'
+};
+
+/**
+ * Gets a set of engine settings to be applied on top of the provided settings, based on user's Handsontable settings.
+ *
+ * @param {object} hotSettings Handsontable settings object.
+ * @returns {object} Object containing the overriding options.
+ */
+export function getEngineSettingsOverrides(hotSettings) {
+  var _hotSettings$PLUGIN_K, _hotSettings$PLUGIN_K2;
+  return {
+    maxColumns: hotSettings.maxColumns,
+    maxRows: hotSettings.maxRows,
+    language: (_hotSettings$PLUGIN_K = hotSettings[PLUGIN_KEY]) === null || _hotSettings$PLUGIN_K === void 0 ? void 0 : (_hotSettings$PLUGIN_K2 = _hotSettings$PLUGIN_K.language) === null || _hotSettings$PLUGIN_K2 === void 0 ? void 0 : _hotSettings$PLUGIN_K2.langCode
+  };
+}
+
+/**
+ * Drop `hyperformula` key from object if it exists.
+ *
+ * @param {object} pluginSettings Formulas plugin settings.
+ * @returns {object}
+ */
+function cleanEngineSettings(pluginSettings) {
+  return Object.keys(pluginSettings).reduce(function (obj, key) {
+    if (key !== 'hyperformula') {
+      obj[key] = pluginSettings[key];
+    }
+    return obj;
+  }, {});
+}
+
+/**
+ * Takes the default, user and overriding settings and merges them into a single object to be passed to the engine.
+ *
+ * The final object gets its parameters in the following order,
+ * with properties attached to objects listed in the lower levels of the list overriding the
+ * ones above them:
+ *
+ * 1. Default settings
+ * 2. User settings
+ * 3. Overrides.
+ *
+ * Meant to be used during *initialization* of the engine.
+ *
+ * @param {object} hotSettings The Handsontable settings.
+ * @returns {object} The final engine settings.
+ */
+export function getEngineSettingsWithDefaultsAndOverrides(hotSettings) {
+  var _pluginSettings$engin;
+  var pluginSettings = hotSettings[PLUGIN_KEY];
+  var userSettings = cleanEngineSettings(pluginSettings !== null && pluginSettings !== void 0 && (_pluginSettings$engin = pluginSettings.engine) !== null && _pluginSettings$engin !== void 0 && _pluginSettings$engin.hyperformula ? pluginSettings.engine : {});
+  var overrides = getEngineSettingsOverrides(hotSettings);
+  return _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_SETTINGS), userSettings), overrides);
+}
+
+/**
+ * Get engine settings from a Handsontable settings object with overrides.
+ *
+ * @param {object} hotSettings Handsontable settings object.
+ * @returns {object}
+ */
+export function getEngineSettingsWithOverrides(hotSettings) {
+  var _pluginSettings$engin2;
+  var pluginSettings = hotSettings[PLUGIN_KEY];
+  var userSettings = cleanEngineSettings(pluginSettings !== null && pluginSettings !== void 0 && (_pluginSettings$engin2 = pluginSettings.engine) !== null && _pluginSettings$engin2 !== void 0 && _pluginSettings$engin2.hyperformula ? pluginSettings.engine : {});
+  var overrides = getEngineSettingsOverrides(hotSettings);
+  return _objectSpread(_objectSpread({}, userSettings), overrides);
+}

package/plugins/formulas/formulas.d.ts

@@ -0,0 +1,31 @@
+import {
+  CellType as HyperFormulaCellType,
+  ConfigParams,
+  HyperFormula,
+} from 'hyperformula';
+import Core from '../../core';
+import { CellValue } from '../../common';
+import { BasePlugin } from '../base';
+
+export interface HyperFormulaSettings extends Partial<ConfigParams> {
+  hyperformula: typeof HyperFormula | HyperFormula;
+}
+export interface DetailedSettings {
+  engine: typeof HyperFormula | HyperFormula | HyperFormulaSettings;
+}
+
+export type Settings = DetailedSettings;
+
+export class Formulas extends BasePlugin {
+  constructor(hotInstance: Core);
+
+  engine: HyperFormula | null;
+  sheetName: string | null;
+  get sheetId(): number | null;
+
+  isEnabled(): boolean;
+  addSheet(sheetName?: string | null, sheetData?: CellValue[][]): string | boolean;
+  switchSheet(sheetName: string): void;
+  getCellType(row: number, column: number, sheet?: number): HyperFormulaCellType;
+  isFormulaCellType(row: number, column: number, sheet?: number): boolean;
+}