Merge branch 'release/1.0.0'

Author: jansiegel

.github/workflows/audit.yml

@@ -6,7 +6,7 @@ jobs:
   build:
     strategy:
       matrix:
-        node-version: [ '14' ]
+        node-version: [ '15' ]
         os: [ 'ubuntu-latest' ]
     name: AUDIT
     runs-on: ${{ matrix.os }}
@@ -20,4 +20,4 @@ jobs:
 
       - name: Run audit
         run: |
-          npm audit
+          npm audit --omit='dev'

.npmignore

@@ -7,6 +7,6 @@
 !dist/**/*
 !es/**/*
 !typings/**/*
-!non-commercial-license.pdf
 !github-hf-logo-blue.svg
-!agpl-3.0.txt
+!gpl-3.0.txt
+!CHANGELOG.md

.typedoc.md.ts

@@ -2,7 +2,7 @@ module.exports = {
   ...require('./.typedoc.ts'),
   "theme": "./docs/.vuepress/subtheme",
   "out": "docs/api",
-  "name": "Introduction",
+  "name": "HyperFormula API reference",
   "categorizeByGroup": true,
   "readme": "./docs/api-template.md",
   "plugin": ["typedoc-plugin-markdown"],

CHANGELOG.md

@@ -6,6 +6,78 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] - 2021-07-15
+
+### Changed
+- **Breaking change**: Changed API of many sheet-related methods to take sheetId instead of sheetName as an argument. (#645)
+- **Breaking change**: Removed support for matrix formulas (`{=FORMULA}`) notation. Engine now supports formulas returning array of values (instead of only scalars). (#652)
+- **Breaking change**: Removed numeric matrix detection along with matrixDetection and matrixDetectionThreshold config options. (#669)
+- **Breaking change**: Changed API of the following methods to take `SimpleCellRange` type argument: `copy`,  `cut`, `getCellDependents`, `getCellPrecedents`, `getFillRangeData`, `getRangeFormulas`,  `getRangeSerialized`, `getRangeValues`, `isItPossibleToMoveCells`, `isItPossibleToSetCellContents`, `moveCells`. (#687)
+- **Breaking change**: Changed the AGPLv3 license to GPLv3.
+- **Breaking change**: Removed the free non-commercial license.
+- **Breaking change**: Changed behaviour of `setCellContents` so that it is possible to override space occupied by spilled array. (#708)
+- **Breaking change**: Changed behaviour of `addRows/removeRows` so that it is possible to add/remove rows across spilled array without changing array size. (#708)
+- **Breaking change**: Changed behaviour of `addColumns/removeColumns` so that it is possible to add/remove columns across spilled array without changing array size. (#732)
+- **Breaking change**: Changed config options (#747):
+
+| before                | after                |
+|-----------------------|----------------------|
+| matrixColumnSeparator | arrayColumnSeparator |
+| matrixRowSeparator    | arrayRowSeparator    |
+
+- **Breaking change**: Changed CellType.MATRIX to CellType.ARRAY (#747)
+- **Breaking change**: Changed API methods (#747):
+
+| before             | after             |
+|--------------------|-------------------|
+| matrixMapping      | arrrayMapping     |
+| isCellPartOfMatrix | isCellPartOfArray |
+
+- **Breaking change**: Changed Exceptions (#747):
+
+| before                       | after                       |
+|------------------------------|-----------------------------|
+| SourceLocationHasMatrixError | SourceLocationHasArrayError |
+| TargetLocationHasMatrixError | TargetLocationHasArrayError |
+
+- Changed SWITCH function, so it takes array as its first argument.
+- Changed TRANSPOSE function, so it works with data of any type. (#708)
+- Changed the way how we include `gpu.js` making it even more optional (#753)
+
+### Added
+- Added support for array arithmetic. (#628)
+- Added performance improvements for array handling. (#629)
+- Added ARRAYFORMULA function. (#630)
+- Added FILTER function. (#668)
+- Added ARRAY_CONSTRAIN function. (#661)
+- Added casting to scalars from non-range arrays. (#663)
+- Added support for range interpolation. (#665)
+- Added parsing of arrays in formulas (together with respective config options for separators). (#671)
+- Added support for vectorization of scalar functions. (#673)
+- Added support for time in JS `Date()` objects on the input. (#648)
+- Added validation of API argument types for simple types. (#654)
+- Added named expression handling to engine factories. (#680)
+- Added `getAllNamedExpressionsSerialized` method. (#680)
+- Added parsing of arrays in formulas (together with respective config options for separators). (#671)
+- Added utility function for filling ranges with source from other range. (#678)
+- Added pretty print for detailedCellError. (#712)
+- Added `simpleCellRangeFromString` and `simpleCellRangeToString` helpers. (#720)
+- Added `CellError` to exports. (#736)
+- Added mapping policies to the exports:   `AlwaysDense`, `AlwaysSparse`, `DenseSparseChooseBasedOnThreshold`. (#747)
+- Added `#SPILL!` error type. (#708)
+- Added large tests for CRUD interactions. (#755)
+- Added support for array arithmetic in plugins. (#766)
+- Added a flag to `getFillRangeData` to support different types of offsetting. (#767)
+
+### Fixed
+- Fixed an issue with arrays and cruds. (#651)
+- Fixed handling of arrays for ROWS/COLUMNS functions. (#677)
+- Fixed an issue with nested namedexpressions. (#679)
+- Fixed an issue with matrixDetection + number parsing. (#686)
+- Fixed an issue with NOW and TODAY functions. (#709)
+- Fixed an issue with MIN/MAX function caches. (#711)
+- Fixed an issue with caching and order of evaluation. (#735)
+
 ## [0.6.2] - 2021-05-26
 
 ### Changed

LICENSE.txt

@@ -6,19 +6,15 @@ registered with the National Court Register under number 538651,
 EU tax ID number: PL5862294002, share capital: PLN 62,800.00.
 
 This software is protected by applicable copyright laws, including
-international treaties, and triple-licensed.
+international treaties, and double-licensed.
 
-First, if your use involves only such purposes as education, research, study,
-and personal use, testing and demonstration, you agree to be bound by
-the terms included in the “non-commercial-license.pdf” file, available
-in the main directory of this software repository.
-
-Second, commercial purposes dictate more individual approach
+First, commercial purposes dictate individual approach
 and the terms of such use are subject to negotiations.
 
-Third, at your option, your use of this Software – either commercial, non-commercial, or both –
-may be subject to the GNU Affero General Public License
-in such version as included in the “agpl-3.0.txt” file,
+Second, at your option, your use of this Software –
+either commercial, non-commercial, or both –
+may be subject to the GNU General Public License
+in such version as included in the “gpl-3.0.txt” file,
 available in the main directory of this software repository.
 
 HANDSONCODE PROVIDES THIS SOFTWARE ON AN “AS IS” BASIS,

README.md

@@ -62,7 +62,7 @@ import { HyperFormula } from 'hyperformula';
 
 // define the options
 const options = {
-  licenseKey: 'agpl-v3',
+  licenseKey: 'gpl-v3',
 };
 
 // define the data
@@ -116,23 +116,19 @@ Your help is much appreciated in any of the following topics:
 
 ## License
 
-HyperFormula is a triple-licensed software. You can use it under the
-open source [AGPLv3 license](https://github.com/handsontable/hyperformula/blob/master/agpl-3.0.txt),
-or a [free license](https://github.com/handsontable/hyperformula/blob/master/non-commercial-license.pdf)
-in all your non-commercial projects. There is also a
-[commercial license](https://handsontable.github.io/hyperformula/guide/contact.html),
-and support services available.
+HyperFormula is a double-licensed software. In all your non-commercial projects, you can use it under the
+open source [GPLv3 license](https://github.com/handsontable/hyperformula/blob/master/gpl-3.0.txt). Additionally, there is also a [commercial license](https://handsontable.github.io/hyperformula/guide/contact.html), and support services available.
 
-## Acknowledgements
+## Acknowledgments 
 
 You should know that this project wouldn’t exist without co-financing from European Union funds under the European Regional Development Funds as a part of the Smart Growth Operational Programme. Project implemented as a part of the Polish National Centre for Research and Development: “Fast Track”.
 
 - Name of the programme: Smart Growth Operational Programme 2014-2020
 - Project name: “Development of the high-performance calculation engine for processing tabular data of the significant size on mobile devices and workstations using parallel computing and GPU.”
 - Project number: POIR.01.01.01-00-0223/18-00
 - Beneficiary: Handsoncode sp. z o.o.
-- Total budget: PLN 1 121 375.00 (USD ~295 000)
-- Amount of grant: PLN 774 742.00 (USD ~204 000)
+- Total budget: PLN 1 117 275.87 (USD ~295 000)
+- Amount of grant: PLN 771 807.73 (USD ~204 000)
 - Duration: 2018-2019
 
 ![eu-funds](docs/.vuepress/public/eu-logos.png)

docs/.vuepress/config.js

@@ -148,7 +148,6 @@ module.exports = {
             ['/guide/supported-browsers', 'Supported browsers'],
             ['/guide/dependencies', 'Dependencies'],
             ['/guide/licensing', 'Licensing'],
-            ['/guide/changelog', 'Changelog'],
             ['/guide/support', 'Support'],
           ]
         },
@@ -216,9 +215,18 @@ module.exports = {
             ['/guide/building', 'Building'],
             ['/guide/testing', 'Testing'],
             ['/guide/custom-functions', 'Custom functions'],
+            ['/guide/arrays', 'Arrays'],
             ['/guide/performance', 'Performance'],
           ]
         },
+        {
+          title: 'Upgrade and migration',
+          collapsable: false,
+          children: [
+            ['/guide/release-notes', 'Release notes'],
+            ['/guide/migration-from-0.6-to-1.0', 'Migrating from 0.6 to 1.0'],
+          ]
+        },
         {
           title: 'Miscellaneous',
           collapsable: false,
@@ -229,7 +237,7 @@ module.exports = {
             ['/guide/acknowledgements', 'Acknowledgments'],
             ['/guide/contact', 'Contact'],
           ]
-        }
+        },
       ],
     },
   }

docs/README.md

@@ -0,0 +1,64 @@
+# HyperFormula documentation
+
+HyperFormula comes with a dedicated, regularly-updated documentation portal.
+
+View the documentation's latest production version at https://handsontable.com/docs/hyperformula.
+
+## About HyperFormula documentation
+
+The HyperFormula documentation is built with [VuePress](https://vuepress.vuejs.org/), a Vue-powered Static Site Generator.
+
+When editing the docs, you can use features described [here](https://vuepress.vuejs.org/guide/markdown.html).
+
+## Getting started with HyperFormula documentation
+
+To start a local HyperFormula docs server:
+
+1. Make sure you're running [Node.js](https://nodejs.org/en/) 14+.
+2. From the main `hyperformula` directory, install the docs dependencies:
+    ```bash
+    npm install
+    ```
+3. From the main `hyperformula` directory, build HyperFormula:
+   ```bash
+   npm run bundle-all
+   ```   
+4. From the main `hyperformula` directory, generate the API reference:
+   ```bash
+   npm run docs:api
+   ```   
+5. From the main `hyperformula` directory, start your local docs server:
+   ```bash
+   npm run docs:dev
+   ```
+6. In your browser, go to: http://localhost:8080/hyperformula/.
+
+## HyperFormula documentation npm scripts
+
+From the `hyperformula` directory, you can run the following npm scripts:
+
+* `npm run docs:dev` - Starts a local docs server at http://localhost:8080/hyperformula/.
+* `npm run docs:api` - Generates the HyperFormula API reference into `/docs/api`.
+* `npm run docs:build` - Builds the docs output into `/docs/.vuepress/dist`.
+* `npm run docs` - Builds both the API reference and the docs output.
+
+## HyperFormula docs directory structure
+
+```bash
+docs                            # All documentation files
+├── .vuepress                   # All VuePress files
+│   ├── components              # Vue components
+│   ├── dist                    # The docs output. Both the docs and the API reference are built into this folder.
+│   ├── public                  # Public assets
+│   ├── styles                  # Style-related files
+│   ├── subtheme                # Subtheme files
+│   ├── templates               # HTML templates
+│   ├── config.js               # VuePress configuration
+│   ├── enhanceApp.js           # VuePress app-level enhancements
+│   └── highlight.js            # Code highlight configuration
+├── api                         # The API reference files, generated automatically from JsDoc. Do not edit!
+├── guide                       # The docs source files: Markdown content
+├── api-template.md             # The API reference welcome page
+├── index.md                    # The main docs portal welcome page
+└── README.md                   # The file you're looking at right now!
+```

docs/api-template.md

@@ -1,4 +1,4 @@
-Welcome to HyperFormula `v{{ $page.version }}` API!
+Welcome to the HyperFormula `v{{ $page.version }}` API!
 
 The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.
 
@@ -28,7 +28,7 @@ This section contains information about options that allow you to configure the
 An example set of options:
 ```javascript
 const options = {
-  licenseKey: 'agpl-v3',
+  licenseKey: 'gpl-v3',
   precisionRounding: 10,
   nullDate: { year: 1900, month: 1, day: 1 },
   functionArgSeparator: '.'

docs/guide/acknowledgements.md

@@ -12,8 +12,8 @@ engine for processing tabular data of the significant size on mobile
 devices and workstations using parallel computing and GPU."
 * Project number: POIR.01.01.01-00-0223/18-00
 * Beneficiary: Handsoncode sp. z o.o.
-* Total budget: PLN 1 121 375.00
-* Amount of grant: PLN 774 742.00
+* Total budget: PLN 1 117 275.87 (USD ~295 000)
+* Amount of grant: PLN 771 807.73 (USD ~204 000)
 * Duration: 2018-2019
 
-<img :src="$withBase('/eu-logos.png')">
+<img :src="$withBase('/eu-logos.png')">