@odoo/o-spreadsheet 17.4.14 → 17.4.15

package/dist/o-spreadsheet.cjs.js

@@ -2,9 +2,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.4.14
- * @date 2024-11-28T09:08:12.462Z
- * @hash 81bf386
+ * @version 17.4.15
+ * @date 2024-12-05T10:40:45.905Z
+ * @hash 9b13f22
  */
 
 'use strict';
@@ -306,8 +306,8 @@ const LINE_FILL_TRANSPARENCY = 0.4;
 const DEBOUNCE_TIME = 200;
 const MESSAGE_VERSION = 1;
 // Sheets
-const FORBIDDEN_SHEET_CHARS = ["'", "*", "?", "/", "\\", "[", "]"];
-const FORBIDDEN_IN_EXCEL_REGEX = /'|\*|\?|\/|\\|\[|\]/;
+const FORBIDDEN_SHEETNAME_CHARS = ["'", "*", "?", "/", "\\", "[", "]"];
+const FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX = /'|\*|\?|\/|\\|\[|\]/;
 // Cells
 const FORMULA_REF_IDENTIFIER = "|";
 // Components
@@ -353,6 +353,7 @@ const PIVOT_TABLE_CONFIG = {
 //------------------------------------------------------------------------------
 // Miscellaneous
 //------------------------------------------------------------------------------
+const sanitizeSheetNameRegex = new RegExp(FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX, "g");
 /**
  * Remove quotes from a quoted string
  * ```js
@@ -448,6 +449,10 @@ function getCanonicalSheetName(sheetName) {
     }
     return sheetName;
 }
+/** Replace the excel-excluded characters of a sheetName */
+function sanitizeSheetName(sheetName, replacementChar = " ") {
+    return sheetName.replace(sanitizeSheetNameRegex, replacementChar);
+}
 function clip(val, min, max) {
     return val < min ? min : val > max ? max : val;
 }
@@ -46727,13 +46732,12 @@ const MIGRATIONS = [
         to: 8,
         applyMigration(data) {
             const namesTaken = [];
-            const globalForbiddenInExcel = new RegExp(FORBIDDEN_IN_EXCEL_REGEX, "g");
             for (let sheet of data.sheets || []) {
                 if (!sheet.name) {
                     continue;
                 }
                 const oldName = sheet.name;
-                const escapedName = oldName.replace(globalForbiddenInExcel, "_");
+                const escapedName = sanitizeSheetName(oldName, "_");
                 let i = 1;
                 let newName = escapedName;
                 while (namesTaken.includes(newName)) {
@@ -51258,7 +51262,7 @@ class SheetPlugin extends CorePlugin {
         if (orderedSheetIds.find((id) => sheets[id]?.name.toLowerCase() === name && id !== cmd.sheetId)) {
             return "DuplicatedSheetName" /* CommandResult.DuplicatedSheetName */;
         }
-        if (FORBIDDEN_IN_EXCEL_REGEX.test(name)) {
+        if (FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX.test(name)) {
             return "ForbiddenCharactersInSheetName" /* CommandResult.ForbiddenCharactersInSheetName */;
         }
         return "Success" /* CommandResult.Success */;
@@ -56047,11 +56051,13 @@ class PivotUIPlugin extends UIPlugin {
             return EMPTY_PIVOT_CELL;
         }
         if (functionName === "PIVOT") {
-            const includeTotal = args[2] === false ? false : undefined;
-            const includeColumnHeaders = args[3] === false ? false : undefined;
+            const includeTotal = toScalar(args[2]);
+            const shouldIncludeTotal = includeTotal === undefined ? true : toBoolean(includeTotal);
+            const includeColumnHeaders = toScalar(args[3]);
+            const shouldIncludeColumnHeaders = includeColumnHeaders === undefined ? true : toBoolean(includeColumnHeaders);
             const pivotCells = pivot
                 .getTableStructure()
-                .getPivotCells(includeTotal, includeColumnHeaders);
+                .getPivotCells(shouldIncludeTotal, shouldIncludeColumnHeaders);
             const pivotCol = position.col - mainPosition.col;
             const pivotRow = position.row - mainPosition.row;
             return pivotCells[pivotCol][pivotRow];
@@ -58156,7 +58162,7 @@ class InsertPivotPlugin extends UIPlugin {
     getPivotDuplicateSheetName(pivotName) {
         let i = 1;
         const names = this.getters.getSheetIds().map((id) => this.getters.getSheetName(id));
-        const sanitizedName = pivotName.replace(new RegExp(FORBIDDEN_IN_EXCEL_REGEX, "g"), " ");
+        const sanitizedName = sanitizeSheetName(pivotName);
         let name = sanitizedName;
         while (names.includes(name)) {
             name = `${sanitizedName} (${i})`;
@@ -62197,7 +62203,7 @@ function interactiveRenameSheet(env, sheetId, name, errorCallback) {
         env.raiseError(_t("A sheet with the name %s already exists. Please select another name.", name), errorCallback);
     }
     else if (result.reasons.includes("ForbiddenCharactersInSheetName" /* CommandResult.ForbiddenCharactersInSheetName */)) {
-        env.raiseError(_t("Some used characters are not allowed in a sheet name (Forbidden characters are %s).", FORBIDDEN_SHEET_CHARS.join(" ")), errorCallback);
+        env.raiseError(_t("Some used characters are not allowed in a sheet name (Forbidden characters are %s).", FORBIDDEN_SHEETNAME_CHARS.join(" ")), errorCallback);
     }
 }
 
@@ -63456,7 +63462,7 @@ class ActionButton extends owl.Component {
     setup() {
         owl.onWillUpdateProps((nextProps) => {
             if (nextProps.action !== this.props.action) {
-                this.actionButton = createAction(this.props.action);
+                this.actionButton = createAction(nextProps.action);
             }
         });
     }
@@ -68589,6 +68595,7 @@ const helpers = {
     createPivotFormula,
     areDomainArgsFieldsValid,
     formatTickValue,
+    sanitizeSheetName,
 };
 const links = {
     isMarkdownLink,
@@ -68719,6 +68726,6 @@ exports.tokenColors = tokenColors;
 exports.tokenize = tokenize;
 
 
-__info__.version = "17.4.14";
-__info__.date = "2024-11-28T09:08:12.462Z";
-__info__.hash = "81bf386";
+__info__.version = "17.4.15";
+__info__.date = "2024-12-05T10:40:45.905Z";
+__info__.hash = "9b13f22";

package/dist/o-spreadsheet.d.ts

@@ -5548,6 +5548,8 @@ declare function createCurrencyFormat(currency: Partial<Currency>): Format;
  */
 declare function deepCopy<T>(obj: T): T;
 declare function unquote(string: string, quoteChar?: "'" | '"'): string;
+/** Replace the excel-excluded characters of a sheetName */
+declare function sanitizeSheetName(sheetName: string, replacementChar?: string): string;
 declare function isMarkdownLink(str: string): boolean;
 /**
  * Build a markdown link from a label and an url
@@ -11531,6 +11533,7 @@ declare const helpers: {
     createPivotFormula: typeof createPivotFormula;
     areDomainArgsFieldsValid: typeof areDomainArgsFieldsValid;
     formatTickValue: typeof formatTickValue;
+    sanitizeSheetName: typeof sanitizeSheetName;
 };
 declare const links: {
     isMarkdownLink: typeof isMarkdownLink;

package/dist/o-spreadsheet.esm.js

@@ -2,9 +2,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.4.14
- * @date 2024-11-28T09:08:12.462Z
- * @hash 81bf386
+ * @version 17.4.15
+ * @date 2024-12-05T10:40:45.905Z
+ * @hash 9b13f22
  */
 
 import { useEnv, useSubEnv, onWillUnmount, useComponent, status, Component, useRef, onMounted, useEffect, useState, onPatched, onWillPatch, onWillUpdateProps, useExternalListener, onWillStart, xml, useChildSubEnv, markRaw, toRaw } from '@odoo/owl';
@@ -304,8 +304,8 @@ const LINE_FILL_TRANSPARENCY = 0.4;
 const DEBOUNCE_TIME = 200;
 const MESSAGE_VERSION = 1;
 // Sheets
-const FORBIDDEN_SHEET_CHARS = ["'", "*", "?", "/", "\\", "[", "]"];
-const FORBIDDEN_IN_EXCEL_REGEX = /'|\*|\?|\/|\\|\[|\]/;
+const FORBIDDEN_SHEETNAME_CHARS = ["'", "*", "?", "/", "\\", "[", "]"];
+const FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX = /'|\*|\?|\/|\\|\[|\]/;
 // Cells
 const FORMULA_REF_IDENTIFIER = "|";
 // Components
@@ -351,6 +351,7 @@ const PIVOT_TABLE_CONFIG = {
 //------------------------------------------------------------------------------
 // Miscellaneous
 //------------------------------------------------------------------------------
+const sanitizeSheetNameRegex = new RegExp(FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX, "g");
 /**
  * Remove quotes from a quoted string
  * ```js
@@ -446,6 +447,10 @@ function getCanonicalSheetName(sheetName) {
     }
     return sheetName;
 }
+/** Replace the excel-excluded characters of a sheetName */
+function sanitizeSheetName(sheetName, replacementChar = " ") {
+    return sheetName.replace(sanitizeSheetNameRegex, replacementChar);
+}
 function clip(val, min, max) {
     return val < min ? min : val > max ? max : val;
 }
@@ -46725,13 +46730,12 @@ const MIGRATIONS = [
         to: 8,
         applyMigration(data) {
             const namesTaken = [];
-            const globalForbiddenInExcel = new RegExp(FORBIDDEN_IN_EXCEL_REGEX, "g");
             for (let sheet of data.sheets || []) {
                 if (!sheet.name) {
                     continue;
                 }
                 const oldName = sheet.name;
-                const escapedName = oldName.replace(globalForbiddenInExcel, "_");
+                const escapedName = sanitizeSheetName(oldName, "_");
                 let i = 1;
                 let newName = escapedName;
                 while (namesTaken.includes(newName)) {
@@ -51256,7 +51260,7 @@ class SheetPlugin extends CorePlugin {
         if (orderedSheetIds.find((id) => sheets[id]?.name.toLowerCase() === name && id !== cmd.sheetId)) {
             return "DuplicatedSheetName" /* CommandResult.DuplicatedSheetName */;
         }
-        if (FORBIDDEN_IN_EXCEL_REGEX.test(name)) {
+        if (FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX.test(name)) {
             return "ForbiddenCharactersInSheetName" /* CommandResult.ForbiddenCharactersInSheetName */;
         }
         return "Success" /* CommandResult.Success */;
@@ -56045,11 +56049,13 @@ class PivotUIPlugin extends UIPlugin {
             return EMPTY_PIVOT_CELL;
         }
         if (functionName === "PIVOT") {
-            const includeTotal = args[2] === false ? false : undefined;
-            const includeColumnHeaders = args[3] === false ? false : undefined;
+            const includeTotal = toScalar(args[2]);
+            const shouldIncludeTotal = includeTotal === undefined ? true : toBoolean(includeTotal);
+            const includeColumnHeaders = toScalar(args[3]);
+            const shouldIncludeColumnHeaders = includeColumnHeaders === undefined ? true : toBoolean(includeColumnHeaders);
             const pivotCells = pivot
                 .getTableStructure()
-                .getPivotCells(includeTotal, includeColumnHeaders);
+                .getPivotCells(shouldIncludeTotal, shouldIncludeColumnHeaders);
             const pivotCol = position.col - mainPosition.col;
             const pivotRow = position.row - mainPosition.row;
             return pivotCells[pivotCol][pivotRow];
@@ -58154,7 +58160,7 @@ class InsertPivotPlugin extends UIPlugin {
     getPivotDuplicateSheetName(pivotName) {
         let i = 1;
         const names = this.getters.getSheetIds().map((id) => this.getters.getSheetName(id));
-        const sanitizedName = pivotName.replace(new RegExp(FORBIDDEN_IN_EXCEL_REGEX, "g"), " ");
+        const sanitizedName = sanitizeSheetName(pivotName);
         let name = sanitizedName;
         while (names.includes(name)) {
             name = `${sanitizedName} (${i})`;
@@ -62195,7 +62201,7 @@ function interactiveRenameSheet(env, sheetId, name, errorCallback) {
         env.raiseError(_t("A sheet with the name %s already exists. Please select another name.", name), errorCallback);
     }
     else if (result.reasons.includes("ForbiddenCharactersInSheetName" /* CommandResult.ForbiddenCharactersInSheetName */)) {
-        env.raiseError(_t("Some used characters are not allowed in a sheet name (Forbidden characters are %s).", FORBIDDEN_SHEET_CHARS.join(" ")), errorCallback);
+        env.raiseError(_t("Some used characters are not allowed in a sheet name (Forbidden characters are %s).", FORBIDDEN_SHEETNAME_CHARS.join(" ")), errorCallback);
     }
 }
 
@@ -63454,7 +63460,7 @@ class ActionButton extends Component {
     setup() {
         onWillUpdateProps((nextProps) => {
             if (nextProps.action !== this.props.action) {
-                this.actionButton = createAction(this.props.action);
+                this.actionButton = createAction(nextProps.action);
             }
         });
     }
@@ -68587,6 +68593,7 @@ const helpers = {
     createPivotFormula,
     areDomainArgsFieldsValid,
     formatTickValue,
+    sanitizeSheetName,
 };
 const links = {
     isMarkdownLink,
@@ -68674,6 +68681,6 @@ const constants = {
 export { AbstractCellClipboardHandler, AbstractChart, AbstractFigureClipboardHandler, CellErrorType, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, PivotRuntimeDefinition, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, SpreadsheetPivotTable, UIPlugin, __info__, addFunction, addRenderingLayer, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, stores, tokenColors, tokenize };
 
 
-__info__.version = "17.4.14";
-__info__.date = "2024-11-28T09:08:12.462Z";
-__info__.hash = "81bf386";
+__info__.version = "17.4.15";
+__info__.date = "2024-12-05T10:40:45.905Z";
+__info__.hash = "9b13f22";

package/dist/o-spreadsheet.iife.js

@@ -2,9 +2,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.4.14
- * @date 2024-11-28T09:08:12.462Z
- * @hash 81bf386
+ * @version 17.4.15
+ * @date 2024-12-05T10:40:45.905Z
+ * @hash 9b13f22
  */
 
 (function (exports, owl) {
@@ -305,8 +305,8 @@
   const DEBOUNCE_TIME = 200;
   const MESSAGE_VERSION = 1;
   // Sheets
-  const FORBIDDEN_SHEET_CHARS = ["'", "*", "?", "/", "\\", "[", "]"];
-  const FORBIDDEN_IN_EXCEL_REGEX = /'|\*|\?|\/|\\|\[|\]/;
+  const FORBIDDEN_SHEETNAME_CHARS = ["'", "*", "?", "/", "\\", "[", "]"];
+  const FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX = /'|\*|\?|\/|\\|\[|\]/;
   // Cells
   const FORMULA_REF_IDENTIFIER = "|";
   // Components
@@ -352,6 +352,7 @@
   //------------------------------------------------------------------------------
   // Miscellaneous
   //------------------------------------------------------------------------------
+  const sanitizeSheetNameRegex = new RegExp(FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX, "g");
   /**
    * Remove quotes from a quoted string
    * ```js
@@ -447,6 +448,10 @@
       }
       return sheetName;
   }
+  /** Replace the excel-excluded characters of a sheetName */
+  function sanitizeSheetName(sheetName, replacementChar = " ") {
+      return sheetName.replace(sanitizeSheetNameRegex, replacementChar);
+  }
   function clip(val, min, max) {
       return val < min ? min : val > max ? max : val;
   }
@@ -46726,13 +46731,12 @@ stores.inject(MyMetaStore, storeInstance);
           to: 8,
           applyMigration(data) {
               const namesTaken = [];
-              const globalForbiddenInExcel = new RegExp(FORBIDDEN_IN_EXCEL_REGEX, "g");
               for (let sheet of data.sheets || []) {
                   if (!sheet.name) {
                       continue;
                   }
                   const oldName = sheet.name;
-                  const escapedName = oldName.replace(globalForbiddenInExcel, "_");
+                  const escapedName = sanitizeSheetName(oldName, "_");
                   let i = 1;
                   let newName = escapedName;
                   while (namesTaken.includes(newName)) {
@@ -51257,7 +51261,7 @@ stores.inject(MyMetaStore, storeInstance);
           if (orderedSheetIds.find((id) => sheets[id]?.name.toLowerCase() === name && id !== cmd.sheetId)) {
               return "DuplicatedSheetName" /* CommandResult.DuplicatedSheetName */;
           }
-          if (FORBIDDEN_IN_EXCEL_REGEX.test(name)) {
+          if (FORBIDDEN_SHEETNAME_CHARS_IN_EXCEL_REGEX.test(name)) {
               return "ForbiddenCharactersInSheetName" /* CommandResult.ForbiddenCharactersInSheetName */;
           }
           return "Success" /* CommandResult.Success */;
@@ -56046,11 +56050,13 @@ stores.inject(MyMetaStore, storeInstance);
               return EMPTY_PIVOT_CELL;
           }
           if (functionName === "PIVOT") {
-              const includeTotal = args[2] === false ? false : undefined;
-              const includeColumnHeaders = args[3] === false ? false : undefined;
+              const includeTotal = toScalar(args[2]);
+              const shouldIncludeTotal = includeTotal === undefined ? true : toBoolean(includeTotal);
+              const includeColumnHeaders = toScalar(args[3]);
+              const shouldIncludeColumnHeaders = includeColumnHeaders === undefined ? true : toBoolean(includeColumnHeaders);
               const pivotCells = pivot
                   .getTableStructure()
-                  .getPivotCells(includeTotal, includeColumnHeaders);
+                  .getPivotCells(shouldIncludeTotal, shouldIncludeColumnHeaders);
               const pivotCol = position.col - mainPosition.col;
               const pivotRow = position.row - mainPosition.row;
               return pivotCells[pivotCol][pivotRow];
@@ -58155,7 +58161,7 @@ stores.inject(MyMetaStore, storeInstance);
       getPivotDuplicateSheetName(pivotName) {
           let i = 1;
           const names = this.getters.getSheetIds().map((id) => this.getters.getSheetName(id));
-          const sanitizedName = pivotName.replace(new RegExp(FORBIDDEN_IN_EXCEL_REGEX, "g"), " ");
+          const sanitizedName = sanitizeSheetName(pivotName);
           let name = sanitizedName;
           while (names.includes(name)) {
               name = `${sanitizedName} (${i})`;
@@ -62196,7 +62202,7 @@ stores.inject(MyMetaStore, storeInstance);
           env.raiseError(_t("A sheet with the name %s already exists. Please select another name.", name), errorCallback);
       }
       else if (result.reasons.includes("ForbiddenCharactersInSheetName" /* CommandResult.ForbiddenCharactersInSheetName */)) {
-          env.raiseError(_t("Some used characters are not allowed in a sheet name (Forbidden characters are %s).", FORBIDDEN_SHEET_CHARS.join(" ")), errorCallback);
+          env.raiseError(_t("Some used characters are not allowed in a sheet name (Forbidden characters are %s).", FORBIDDEN_SHEETNAME_CHARS.join(" ")), errorCallback);
       }
   }
 
@@ -63455,7 +63461,7 @@ stores.inject(MyMetaStore, storeInstance);
       setup() {
           owl.onWillUpdateProps((nextProps) => {
               if (nextProps.action !== this.props.action) {
-                  this.actionButton = createAction(this.props.action);
+                  this.actionButton = createAction(nextProps.action);
               }
           });
       }
@@ -68588,6 +68594,7 @@ stores.inject(MyMetaStore, storeInstance);
       createPivotFormula,
       areDomainArgsFieldsValid,
       formatTickValue,
+      sanitizeSheetName,
   };
   const links = {
       isMarkdownLink,
@@ -68718,9 +68725,9 @@ stores.inject(MyMetaStore, storeInstance);
   exports.tokenize = tokenize;
 
 
-  __info__.version = "17.4.14";
-  __info__.date = "2024-11-28T09:08:12.462Z";
-  __info__.hash = "81bf386";
+  __info__.version = "17.4.15";
+  __info__.date = "2024-12-05T10:40:45.905Z";
+  __info__.hash = "9b13f22";
 
 
 })(this.o_spreadsheet = this.o_spreadsheet || {}, owl);