@wemake4u/form-player 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +56 -11
  2. package/THIRD_PARTY_LICENSES.txt +65 -67
  3. package/fesm2022/wemake4u-form-player.mjs +583 -2049
  4. package/fesm2022/wemake4u-form-player.mjs.map +1 -1
  5. package/package.json +6 -14
  6. package/types/wemake4u-form-player.d.ts +95 -44
package/README.md CHANGED
@@ -14,8 +14,34 @@ This library provides a robust implementation of forms using the Sirio Angular L
14
14
 
15
15
  ## Installation
16
16
 
17
- Run `npm install @wemake4u/form-player` to install package.
17
+ Run `npm install @wemake4u/form-player` to install the package, with its peer dependencies.
18
18
 
19
+ ## Dependencies
20
+
21
+ As in `package.json`.
22
+
23
+ Peer dependencies, installed by the application:
24
+
25
+ | Package | Version | |
26
+ |---|---|---|
27
+ | `@angular/core`, `@angular/common`, `@angular/forms`, `@angular/router`, `@angular/platform-browser` | `^22.2.0` | Angular 22. |
28
+ | `rxjs` | `~7.8.0` | |
29
+ | `@wemake4u/form-controls` | `^2.0.3` | The Sirio controls, among them the data grid of the tables. |
30
+ | `@wemake4u/interact` | `^1.0.6` | Language, dialogs, downloads and files. |
31
+ | `ag-charts-angular`, `ag-charts-community` | `^11.3.2` | The `chart` component. |
32
+
33
+ The grid of the form is the Bootstrap 5.3 grid with 16 columns, compiled in the styles of the package when it is
34
+ built: the application does not need Bootstrap.
35
+
36
+ Dependencies, installed with the package:
37
+
38
+ | Package | Version | |
39
+ |---|---|---|
40
+ | `feelin` | `6.2.0` | Evaluation of the FEEL expressions of the form (conditions, values, validations). |
41
+ | `feelers` | `^1.5.1` | The templates with FEEL expressions in the texts. |
42
+ | `marked` | `15.0.7` | The Markdown texts. |
43
+ | `dompurify` | `^3.4.0` | Sanitization of the HTML shown by the form. |
44
+ | `tslib` | `^2.3.0` | TypeScript runtime helpers. |
19
45
 
20
46
  ## Scroll on form change
21
47
 
@@ -37,17 +63,36 @@ first field does not scroll the view again.
37
63
  <app-dynamic-form [schema]="schema" scrollOnNavigate="page" />
38
64
  ```
39
65
 
40
- ## Third-Party Licenses
66
+ ## Tables
41
67
 
42
- This project includes the following third-party components:
68
+ The `table` components are rendered by the data grid of `@wemake4u/form-controls` (`wm-sirio-data-grid`);
69
+ since version 2.0.3 form-player does not use ag-grid any more. The form JSON is unchanged.
43
70
 
44
- Runtime dependencies (MIT License)
71
+ The row source of a table can be:
45
72
 
46
- tslib — MIT
47
- feelers — MIT
48
- feelin — MIT
49
- marked — MIT
50
- mime-db — MIT
51
- sanitize-html — MIT
73
+ | Source | Rows |
74
+ | --- | --- |
75
+ | array | in memory |
76
+ | `Observable` | in memory, the first value |
77
+ | `IRowsSource` (`getRows(params: RowsRequest)`) | from the server by blocks, e.g. `DataService.queryOData(url)` or `queryRows` of `@wemake4u/remoting` |
78
+ | `SirioGridDataSource` | from the server by pages, e.g. `sirioRemoteGridSource` of `@wemake4u/form-controls` |
79
+
80
+ `RowsRequest` has the shape of the ag-grid `IGetRowsParams` (`startRow`, `endRow`, `sortModel`, `filterModel`,
81
+ `successCallback`, `failCallback`), so the sources written for ag-grid keep working.
82
+
83
+ `TableControl` (`getControlAs(name, TableControl)`) keeps its API: `setFilter` / `getFilter` / `clearFilter`,
84
+ `setOrder` / `getOrder`, `refresh`. Filters and sort use the ag-grid format (`FilterModel`, `OrderModel`, exported
85
+ by form-player).
86
+
87
+ Upgrading from 2.0.2 or earlier:
88
+
89
+ - remove the ag-grid packages from the application when it does not use them directly;
90
+ - import `FilterModel` from `@wemake4u/form-player` instead of `ag-grid-community`;
91
+ - `DataGridControl` is deprecated: use `TableControl`;
92
+ - the table states saved by the former ag-grid tables are ignored;
93
+ - the cells changed by the data are no longer highlighted (`enableCellChangeFlash` of ag-grid).
94
+
95
+ ## Third-Party Licenses
52
96
 
53
- All listed packages are licensed under MIT License and impose no additional restrictions.
97
+ The licenses of the dependencies, and of the Bootstrap grid compiled in the styles of the form, are listed in
98
+ THIRD_PARTY_LICENSES.txt. All are MIT, except `tslib` (0BSD) and `dompurify` (MPL-2.0 or Apache-2.0).
package/THIRD_PARTY_LICENSES.txt CHANGED
@@ -1,67 +1,65 @@
1
- Third-Party Licenses for @wemake4u/form-player-se
2
- =================================================
3
-
4
- This project includes third-party software components licensed under the
5
- terms described below.
6
-
7
- All dependencies listed here are used at runtime and are required by the
8
- functionality of this package. Unless otherwise stated, each component is
9
- licensed under the MIT License, which permits use, modification,
10
- distribution and private/commercial usage.
11
-
12
- -------------------------------------------------------
13
- tslib — MIT License
14
- © Microsoft
15
- https://github.com/Microsoft/tslib/blob/master/LICENSE.txt
16
- -------------------------------------------------------
17
-
18
- -------------------------------------------------------
19
- @types/mime-db — MIT License
20
- © DefinitelyTyped contributors
21
- https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/LICENSE
22
- -------------------------------------------------------
23
-
24
- -------------------------------------------------------
25
- @types/sanitize-html — MIT License
26
- © DefinitelyTyped contributors
27
- https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/LICENSE
28
- -------------------------------------------------------
29
-
30
- -------------------------------------------------------
31
- feelers — MIT License
32
- © Contributors
33
- https://github.com/bpmn-io/feelers/blob/master/LICENSE
34
- -------------------------------------------------------
35
-
36
- -------------------------------------------------------
37
- feelin — MIT License
38
- © Camunda Services GmbH
39
- https://github.com/camunda/feelin/blob/master/LICENSE
40
- -------------------------------------------------------
41
-
42
- -------------------------------------------------------
43
- marked — MIT License
44
- © MarkedJS and contributors
45
- https://github.com/markedjs/marked/blob/master/LICENSE.md
46
- -------------------------------------------------------
47
-
48
- -------------------------------------------------------
49
- mime-db — MIT License
50
- © Jonathan Ong and Contributors
51
- https://github.com/jshttp/mime-db/blob/master/LICENSE
52
- -------------------------------------------------------
53
-
54
- -------------------------------------------------------
55
- sanitize-html — MIT License
56
- © Apostrophe Technologies, Inc.
57
- https://github.com/apostrophecms/sanitize-html/blob/main/LICENSE
58
- -------------------------------------------------------
59
-
60
- -------------------------------------------------------
61
- date-fns — MIT License
62
- © 2021 Sasha Koss and Lesha Koss
63
- https://kossnocorp.mit-license.org/
64
- -------------------------------------------------------
65
-
66
- End of Third-Party License Report
67
- =================================================
1
+ Third-Party Licenses for @wemake4u/form-player
2
+ ==============================================
3
+
4
+ ==============================================================================
5
+ Dependencies (package.json)
6
+ ==============================================================================
7
+
8
+ Installed with the package, each with its own license file.
9
+
10
+ feelin (MIT License)
11
+ Copyright (c) 2019-present Nico Rehwaldt
12
+ https://github.com/nikku/feelin
13
+
14
+ feelers (MIT License)
15
+ Copyright (c) 2023-present Camunda Services GmbH
16
+ https://github.com/bpmn-io/feelers
17
+
18
+ marked (MIT License)
19
+ Copyright (c) 2018+, MarkedJS
20
+ https://github.com/markedjs/marked
21
+
22
+ dompurify (Mozilla Public License 2.0 or Apache License 2.0, dual licensed)
23
+ Copyright Cure53 and other contributors
24
+ https://github.com/cure53/DOMPurify
25
+
26
+ tslib (0BSD License)
27
+ Copyright (c) Microsoft Corporation
28
+ https://github.com/Microsoft/tslib
29
+
30
+ Peer dependencies, installed by the application:
31
+
32
+ @angular/core, @angular/common, @angular/forms, @angular/router, @angular/platform-browser
33
+ (MIT License, Copyright (c) Google LLC); rxjs (Apache License 2.0); ag-charts-angular,
34
+ ag-charts-community (MIT License, Copyright (c) 2015-2025 AG GRID LTD); @wemake4u/form-controls,
35
+ @wemake4u/interact (MIT License, Copyright (c) Ivan Senatore, Wemake Informatica srl).
36
+
37
+ ==============================================================================
38
+ Code included in this package
39
+ ==============================================================================
40
+
41
+ The styles of the form include the Bootstrap grid (bootstrap/scss/bootstrap-grid, with 16 columns),
42
+ compiled when the package is built. Its copyright and permission notice follow, as the MIT License
43
+ requires.
44
+
45
+ The MIT License (MIT)
46
+
47
+ Copyright (c) 2011-2024 The Bootstrap Authors
48
+
49
+ Permission is hereby granted, free of charge, to any person obtaining a copy
50
+ of this software and associated documentation files (the "Software"), to deal
51
+ in the Software without restriction, including without limitation the rights
52
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
53
+ copies of the Software, and to permit persons to whom the Software is
54
+ furnished to do so, subject to the following conditions:
55
+
56
+ The above copyright notice and this permission notice shall be included in
57
+ all copies or substantial portions of the Software.
58
+
59
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
60
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
61
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
62
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
63
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
64
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
65
+ THE SOFTWARE.