@odoo/o-spreadsheet 14.0.1 → 14.0.3

package/package.json

@@ -1,20 +1,28 @@
 {
   "name": "@odoo/o-spreadsheet",
-  "version": "14.0.1",
+  "version": "14.0.3",
   "description": "A spreadsheet component",
-  "main": "index.js",
+  "main": "dist/o-spreadsheet.cjs.js",
+  "browser": "dist/o-spreadsheet.iife.js",
+  "module": "dist/o-spreadsheet.es.js",
+  "types": "dist/o-spreadsheet.d.ts",
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts"
+  ],
   "scripts": {
-    "serve": "live-server --open=demo",
-    "dev": "npm-run-all  build --parallel serve \"build:* -- --watch\"",
-    "build:js": "tsc --module es6 --outDir dist/js --incremental",
-    "build:all": "tsc --module es6 --outDir dist/js",
-    "build:bundle": "rollup -c -m",
+    "serve-static": "live-server --open=demo --watch=build/o_spreadsheet.js,demo",
+    "dev": "npm-run-all --print-label build --parallel serve-static watch:*",
+    "build:js": "tsc --module es6 --incremental",
+    "build:bundle": "rollup -c -m --configDev",
+    "watch:ts": "npm run build:js -- --watch",
+    "watch:bundle": "npm run build:bundle -- --watch",
     "build": "npm run build:js && npm run build:bundle",
     "test": "jest",
     "test:watch": "jest --watch",
     "prettier": "prettier {src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,demo/*.js} --write",
     "check-formatting": "prettier {src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,demo/*.js} --check",
-    "dist": "npm run build:all && npm run build:bundle",
+    "dist": "tsc --module es6 --declaration --declarationDir dist/types && rollup -c",
     "prepare": "husky install"
   },
   "browserslist": [
@@ -23,10 +31,19 @@
   "keywords": [
     "owl",
     "spreadsheet",
+    "o-spreadsheet",
     "odoo"
   ],
-  "author": "Gery Debongnie",
+  "author": "Odoo",
   "license": "LGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/odoo/o-spreadsheet.git"
+  },
+  "bugs": {
+    "url": "https://github.com/odoo/o-spreadsheet/issues"
+  },
+  "homepage": "https://github.com/odoo/o-spreadsheet#readme",
   "devDependencies": {
     "@types/chart.js": "^2.9.24",
     "@types/jest": "^27.0.1",
@@ -43,6 +60,9 @@
     "npm-run-all": "^4.1.5",
     "prettier": "2.3.1",
     "rollup": "^2.38.5",
+    "rollup-plugin-dts": "^4.2.0",
+    "@rollup/plugin-terser": "^0.2.0",
+    "rollup-plugin-typescript2": "^0.34.1",
     "ts-jest": "^27.0.5",
     "typescript": "^4.4.3"
   },
@@ -74,5 +94,8 @@
   },
   "lint-staged": {
     "{src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,demo/*.js}": "prettier --write"
+  },
+  "publishConfig": {
+    "tag": "14-0"
   }
 }

package/readme.md

@@ -37,3 +37,13 @@ Most of the code is contained in the following four modules:
 ## Documentation
 
 See [documentation](doc/readme.md).
+
+## Workflow
+
+The repository relies on Github Workflows to automate the creation of releases
+as well as publishing the package on NPM.
+
+# test  the workflow
+The workflow can be run locally with the help of https://github.com/nektos/act
+Bear in mind that it is not a full sandbox, you can run actual commands (like
+npm publish). Make sure you adapt said commands to dry runs.

package/.eslintrc.json

@@ -1,20 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es6": true,
-        "jest": true
-    },
-    "extends": "eslint:recommended",
-    "globals": {
-        "owl": "readonly",
-        "o_spreadsheet": "readonly"
-    },
-    "parser": "babel-eslint",
-    "parserOptions": {
-        "ecmaVersion": 2018,
-        "sourceType": "module"
-    },
-    "rules": {
-
-    }
-}

package/.husky/post-checkout

@@ -1,9 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-if [ "$HUSKY_POST_CHECKOUT" != 0 ]; then
-    if [ "$1" != "$2" ]; then
-        rm -rf dist >/dev/null 2>&1
-        npm install >/dev/null 2>&1
-    fi
-fi

package/.husky/pre-commit

@@ -1,39 +0,0 @@
-#!/bin/sh
-
-# Husky Env Variables :
-# HUSKY_PRE_COMMIT : if set to 0, disable pre-commit hook
-# HUSKY_INPUT_ENV: if set to 0, disable the possibility of user input for the hook
-
-npx="npx"
-
-# For Windows
-if [ "$OSTYPE" = "msys" ]; then
-    export PATH="/usr/bin:/usr/local/bin:$PATH"
-    npx="npx.cmd"
-fi
-. "$(dirname "$0")/_/husky.sh"
-
-if [ "$HUSKY_PRE_COMMIT" != 0 ]; then
-    $npx lint-staged
-
-    consoleregexp='console\.|debugger'
-    if test $(git diff --cached | grep -nE $consoleregexp | wc -l) != 0
-    then
-        if [ "$HUSKY_INPUT_ENV" != 0 ] && [ "$OSTYPE" != "msys" ]; then
-            # activate user inputs
-            exec < /dev/tty
-            exec git diff --cached --color | grep -nE $consoleregexp -A 2 -B 2
-            read -p "There are some occurrences of forbidden patterns at your modification. Are you sure want to continue? (y/n)" yn
-            echo $yn | grep ^[Yy]$
-            if [ $? -eq 0 ]
-            then
-                exit 0; #THE USER WANTS TO CONTINUE
-            else
-                exit 1; # THE USER DONT WANT TO CONTINUE SO ROLLBACK
-            fi
-        else
-            echo -e "\033[1;31mWARNING: Some occurences of forbidden patterns were detected \033[0m"
-            exec git diff --cached --color | grep -nE $consoleregexp -A 2 -B 2
-        fi
-    fi
-fi

package/.prettierignore

@@ -1 +0,0 @@
-.husky/

package/demo/data.js

@@ -1,255 +0,0 @@
-/**
- * We export here two datasets, useful to test and play with o-spreadsheet:
- *
- * - a demo dataset (demoData)
- * . a perf focused dataset (created by function makeLargeDataset)
- */
-
-export const demoData = {
-  version: 5,
-  sheets: [
-    {
-      id: "Sheet1",
-      name: "Sheet1",
-      colNumber: 26,
-      rowNumber: 120,
-      cols: { 1: {}, 3: {} },
-      rows: {},
-      cells: {
-        A21: { content: "Sheet2 => B2:" },
-        B2: { content: "Owl is awesome", style: 1 },
-        B4: { content: "Numbers", style: 4 },
-        B21: { content: "=Sheet2!B2", style: 7 },
-        C1: { content: "CF =42" },
-        C4: { content: "12.4" },
-        C5: { content: "42" },
-        C7: { content: "3" },
-        B9: { content: "Formulas", style: 5 },
-        C9: { content: "= SUM ( C4 : C5 )" },
-        C10: { content: "=SUM(C4:C7)" },
-        D10: { content: "note that C7 is empty" },
-        C11: { content: "=-(3 + C7 *SUM(C4:C7))" },
-        C12: { content: "=SUM(C9:C11)" },
-        D12: { content: "this is a sum of sums" },
-        B14: { content: "Errors", style: 6 },
-        C14: { content: "=C14" },
-        C15: { content: "=(+" },
-        C16: { content: "=C15" },
-        F2: { content: "italic blablah", style: 2 },
-        F3: { content: "strikethrough", style: 3 },
-        H2: { content: "merged content" },
-        C20: { content: "left", border: 1 },
-        E20: { content: "top", border: 2 },
-        G20: { content: "all", border: 3 },
-        B17: { content: "=WAIT(1000)" },
-        G13: { content: "=A1+A2+A3+A4+A5+A6+A7+A8+A9+A10+A11+A12+A13+A14+A15+A16+A17+A18" },
-        C23: { content: "0.43", format: "0.00%" },
-        C24: { content: "10", format: "#,##0.00" },
-        C25: { content: "10.123", format: "#,##0.00" },
-        G1: { content: "CF color scale:" },
-        G2: { content: "5" },
-        G3: { content: "8" },
-        G4: { content: "9" },
-        G5: { content: "15" },
-        G6: { content: "22" },
-        G8: { content: "30" },
-        B26: { content: "first dataset" },
-        C26: { content: "second dataset" },
-        B27: { content: "12" },
-        B28: { content: "=floor(RAND()*50)" },
-        B29: { content: "=floor(RAND()*50)" },
-        B30: { content: "=floor(RAND()*50)" },
-        B31: { content: "=floor(RAND()*50)" },
-        B32: { content: "=floor(RAND()*50)" },
-        B33: { content: "=floor(RAND()*50)" },
-        B34: { content: "19" },
-        B35: { content: "=floor(RAND()*50)" },
-        C27: { content: "=floor(RAND()*50)" },
-        C28: { content: "=floor(RAND()*50)" },
-        C29: { content: "=floor(RAND()*50)" },
-        C30: { content: "=floor(RAND()*50)" },
-        C31: { content: "=floor(RAND()*50)" },
-        C32: { content: "=floor(RAND()*50)" },
-        C33: { content: "=floor(RAND()*50)" },
-        C34: { content: "=floor(RAND()*50)" },
-        C35: { content: "=floor(RAND()*50)" },
-        A27: { content: "Emily Anderson (Emmy)" },
-        A28: { content: "Sophie Allen (Saffi)" },
-        A29: { content: "Chloe Adams" },
-        A30: { content: "Megan Alexander (Meg)" },
-        A31: { content: "Lucy Arnold (Lulu)" },
-        A32: { content: "Hannah Alvarez" },
-        A33: { content: "Jessica Alcock (Jess)" },
-        A34: { content: "Charlotte Anaya" },
-        A35: { content: "Lauren Anthony" },
-        K3: { border: 5 },
-        K4: { border: 4 },
-        K5: { border: 4 },
-        K6: { border: 4 },
-        K7: { border: 4 },
-        K8: { border: 6 },
-      },
-      merges: ["H2:I5", "K3:K8"],
-      conditionalFormats: [
-        {
-          id: "1",
-          ranges: ["C1:C100"],
-          rule: {
-            values: ["42"],
-            operator: "Equal",
-            type: "CellIsRule",
-            style: { fillColor: "orange" },
-          },
-        },
-        {
-          id: "2",
-          ranges: ["G1:G100"],
-          rule: {
-            type: "ColorScaleRule",
-            minimum: { type: "value", color: 0xffffff },
-            maximum: { type: "value", color: 0xff0000 },
-          },
-        },
-      ],
-      figures: [
-        {
-          id: "1",
-          tag: "chart",
-          width: 400,
-          height: 300,
-          x: 800,
-          y: 230,
-          data: {
-            sheetId: "Sheet1",
-            type: "line",
-            title: "demo chart",
-            labelRange: "A27:A35",
-            dataSets: [
-              { labelCell: "B26", dataRange: "B27:B35" },
-              { labelCell: "C26", dataRange: "C27:C35" },
-            ],
-          },
-        },
-      ],
-    },
-    {
-      name: "Sheet2",
-      cells: {
-        B2: { content: "42" },
-      },
-      figures: [
-        {
-          id: "someId",
-          tag: "text",
-          width: 300,
-          height: 200,
-          x: 300,
-          y: 100,
-          data: "blablabla",
-        },
-        {
-          id: "someId2",
-          tag: "text",
-          width: 210,
-          height: 180,
-          x: 900,
-          y: 200,
-          data: "yip yip",
-        },
-      ],
-    },
-  ],
-  styles: {
-    1: { bold: true, textColor: "#3A3791", fontSize: 12 },
-    2: { italic: true },
-    3: { strikethrough: true },
-    4: { fillColor: "#e3efd9" },
-    5: { fillColor: "#c5e0b3" },
-    6: { fillColor: "#a7d08c" },
-    7: { align: "left" },
-  },
-  borders: {
-    1: { left: ["thin", "#000"] },
-    2: { top: ["thin", "#000"] },
-    3: {
-      top: ["thin", "#000"],
-      left: ["thin", "#000"],
-      bottom: ["thin", "#000"],
-      right: ["thin", "#000"],
-    },
-    4: { right: ["thin", "#000"], left: ["thin", "#000"] },
-    5: {
-      left: ["thin", "#000"],
-      right: ["thin", "#000"],
-      top: ["thin", "#000"],
-    },
-    6: {
-      left: ["thin", "#000"],
-      right: ["thin", "#000"],
-      bottom: ["thin", "#000"],
-    },
-  },
-};
-
-// Performance dataset
-function _getColumnLetter(number) {
-  return number !== -1
-    ? _getColumnLetter(Math.floor(number / 26) - 1) + String.fromCharCode(65 + (number % 26))
-    : "";
-}
-
-function computeCells(cols, rows) {
-  const cells = {};
-  for (let letter = 0; letter <= cols; letter++) {
-    const x = _getColumnLetter(letter);
-    if (letter === 0) {
-      cells[x + 3] = { content: letter.toString() };
-    } else {
-      const prev = _getColumnLetter(letter - 1);
-      cells[x + 3] = {
-        content: `=2*${prev}${rows}`,
-        formula: { text: "=2*|0|", dependencies: [`${prev}${rows}`] },
-      };
-    }
-    for (let index = 4; index <= rows; index++) {
-      cells[x + index] = {
-        content: `=${x}${index - 1}+1`,
-        formula: { text: "=|0|+1", dependencies: [`${x}${index - 1}`] },
-      };
-    }
-  }
-  const letter = _getColumnLetter(cols);
-  const nextLetter = _getColumnLetter(cols + 1);
-  for (let i = 3; i <= rows; i++) {
-    cells[nextLetter + i] = {
-      content: `=SUM(A${i}:${letter}${i})`,
-      formula: { text: "=SUM(|0|)", dependencies: [`A${i}:${letter}${i}`] },
-    };
-  }
-  return cells;
-}
-
-export function makeLargeDataset(cols, rows) {
-  return {
-    version: 1,
-    sheets: [
-      {
-        name: "Sheet1",
-        colNumber: 45,
-        rowNumber: 1000000,
-        cols: { 1: {}, 3: {} },
-        rows: {},
-        cells: computeCells(cols, rows),
-      },
-    ],
-    styles: {
-      1: { bold: true, textColor: "#3A3791", fontSize: 12 },
-      2: { italic: true },
-      3: { strikethrough: true },
-      4: { fillColor: "#e3efd9" },
-      5: { fillColor: "#c5e0b3" },
-      6: { fillColor: "#a7d08c" },
-    },
-    borders: {},
-  };
-}

package/demo/index.html

@@ -1,9 +0,0 @@
-<html>
-  <body>
-    <script src="../node_modules/@odoo/owl/dist/owl.iife.js"></script>
-    <script src="libs/Chart.bundle.js"></script>
-    <script src="../dist/o_spreadsheet.js"></script>
-    <script src="main.js" type="module"></script>
-    <title>o_spreadsheet</title>
-  </body>
-</html>