@odoo/o-spreadsheet 15.2.0 → 16.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odoo/o-spreadsheet",
-  "version": "15.2.0",
+  "version": "16.1.0",
   "description": "A spreadsheet component",
   "main": "dist/o-spreadsheet.cjs.js",
   "browser": "dist/o-spreadsheet.iife.js",
@@ -11,20 +11,26 @@
     "dist/*.d.ts"
   ],
   "scripts": {
-    "serve": "live-server --open=demo --watch=dist,demo",
-    "dev": "npm-run-all build --parallel server serve \"build:* -- --watch\"",
+    "serve-static": "live-server --open=demo --watch=dist/o_spreadsheet.js,dist/o_spreadsheet.xml,demo",
+    "dev": "npm-run-all build --parallel server serve-static watch:*",
     "server": "node tools/server/main.js",
     "build:js": "tsc --module es6 --incremental",
-    "build:bundle": "rollup -c -m dev",
-    "build": "npm run build:js && npm run build:bundle",
+    "bundle:js": "rollup -c -m dev",
+    "bundle:xml": "node tools/bundle_xml/main.js",
+    "build": "npm-run-all build:js bundle:*",
     "doc": "typedoc",
     "precommit": "npm run prettier && npm run doc",
     "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": "tsc --module es6 --declaration --declarationDir dist/types && rollup -c",
-    "prepare": "husky install"
+    "prettier": "prettier . --write",
+    "check-formatting": "prettier . --check",
+    "dist": "tsc --module es6 --declaration --declarationDir dist/types && rollup -c && npm run bundle:xml",
+    "prepare": "husky install",
+    "watch:bundle": "npm run bundle:js -- --watch",
+    "watch:ts": "npm run build:js -- --watch",
+    "watch:xml": "node tools/bundle_xml/watch_xml_templates.js",
+    "unzipXlsx": "node tools/bundle_xlsx/unzip_xlsx_demo.js",
+    "zipXlsx": "node tools/bundle_xlsx/zip_xlsx_demo.js"
   },
   "browserslist": [
     "last 1 Chrome versions"
@@ -46,15 +52,19 @@
   },
   "homepage": "https://github.com/odoo/o-spreadsheet#readme",
   "devDependencies": {
+    "@prettier/plugin-xml": "^2.0.1",
     "@rollup/plugin-node-resolve": "^11.0.1",
     "@types/chart.js": "2.9.3",
     "@types/jest": "^27.0.1",
     "@types/node": "^13.13.23",
     "babel-eslint": "^10.1.0",
     "body-parser": "^1.19.0",
+    "chart.js": "2.9.3",
+    "chartjs-gauge": "0.3.0",
     "cors": "^2.8.5",
     "eslint": "^6.8.0",
     "express": "^4.17.1",
+    "express-form-data": "^2.0.19",
     "express-ws": "^4.0.0",
     "file-saver": "^2.0.5",
     "fs": "^0.0.1-security",
@@ -66,25 +76,29 @@
     "lint-staged": "^12.1.2",
     "live-server": "^1.2.1",
     "mockdate": "^3.0.2",
+    "node-watch": "^0.7.3",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.3.1",
-    "prettier-plugin-organize-imports": "^1.1.1",
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^3.1.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",
-    "typedoc": "0.22.5",
+    "typedoc": "0.23.15",
     "typedoc-plugin-markdown": "3.11.1",
-    "typescript": "^4.4.3",
+    "typescript": "^4.8.3",
     "xml-formatter": "^2.4.0"
   },
   "prettier": {
-    "printWidth": 100
+    "printWidth": 100,
+    "xmlWhitespaceSensitivity": "ignore",
+    "bracketSameLine": true,
+    "xmlSelfClosingSpace": false
   },
   "dependencies": {
-    "@odoo/owl": "^1.4.10",
-    "bootstrap": "^4.6.0"
+    "@odoo/owl": "2.0.3",
+    "bootstrap": "^5.1.3"
   },
   "jest": {
     "roots": [
@@ -115,6 +129,6 @@
     }
   },
   "lint-staged": {
-    "{src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,demo/*.js}": "prettier --write"
+    "*": "prettier --write"
   }
 }

package/readme.md

@@ -1,14 +1,44 @@
 # o-spreadsheet
 
-a.k.a. "Owly Sheet"
+A standalone spreadsheet for the web, easily integrable and extendable.
 
-Spreadsheet component, written in Owl.
+a.k.a. "[Owly](https://github.com/odoo/owl) Sheet" 🦉
 
-## Prerequisites
+- All basic features you can expect from a spreadsheet
+- Real time collaboration
+- Import/Export of excel file format
+- and more...
 
-install nodejs 12.0 at least
+Try it with the [live demo](https://odoo.github.io/o-spreadsheet/)!
 
-## Scripts
+![o-spreadsheet screenshot](doc/o-spreadsheet.png "o-spreadsheet demo")
+
+## Integrating o-spreadsheet
+
+1. [Getting started](doc/integrating/integration.md#getting-started)
+2. [Spreadsheet component props](doc/integrating/integration.md#spreadsheet-component-props)
+3. [Model creation](doc/integrating/integration.md#model-creation)
+4. [Collaborative edition](doc/integrating/integration.md#collaborative-edition)
+5. [Translation](doc/integrating/integration.md#translation)
+<!--
+
+- use with other UI library
+- use with Typescript
+  -->
+
+## Extending the functionalities of o-spreadsheet
+
+1. [Architecture](doc/extending/architecture.md)
+2. [Custom function](doc/add_function.md)
+3. [Business feature](doc/extending/business_feature.md)
+4. Menu items (under construction)
+5. Side panel (under construction)
+6. Notification (under construction)
+7. Export Excel (under construction)
+8. [Terminology](doc/o-spreadsheet_terminology.png)
+9. [API](doc/tsdoc/README.md)
+
+## Run it!
 
 ```bash
 # install dependencies
@@ -17,23 +47,20 @@ npm install
 # build o_spreadsheet.js in dist/
 npm run build
 
-# build stuff, start a live server, build with --watch
+# build stuff, start a live server, start a collaborative server, build with --watch
 npm run dev
 
 # run the test suite
 npm run test
 npm run test -- --watch
-```
 
-## Code
-
-Most of the code is contained in the following four modules:
+# build documentation
+npm run doc
+```
 
-- `formulas`
-- `functions`
-- `model`
-- `ui`
+## Contributing
 
-## Documentation
+- Open a pull request or an issue on this repository.
+- Make sure you have [signed the CLA](https://github.com/odoo/odoo/blob/16.0/doc/cla/sign-cla.md) on [odoo repository](https://github.com/odoo/odoo).
 
-See [documentation](doc/readme.md).
+Most of [odoo contribution guidelines](https://github.com/odoo/odoo/wiki/Contributing#making-pull-requests) apply here.