@datapos/datapos-development 0.3.323 → 0.3.326
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.
- package/README.md +51 -26
- package/dist/datapos-development.es.js +126 -126
- package/dist/datapos-development.es.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,16 +5,7 @@
|
|
|
5
5
|
[](https://www.npmjs.com/package/@datapos/datapos-development)
|
|
6
6
|
[](./LICENSE)
|
|
7
7
|
|
|
8
|
-
A library of utilities
|
|
9
|
-
|
|
10
|
-
## Requirements
|
|
11
|
-
|
|
12
|
-
Ensure your environment meets the following prerequisites before using this library:
|
|
13
|
-
|
|
14
|
-
- **Node.js** version `>=22.0.0`,
|
|
15
|
-
- **npm** version `>=11.0.0`,
|
|
16
|
-
- A Unix-like shell (for command shortcuts, e.g., `bash`, `zsh`, or Git Bash on Windows),
|
|
17
|
-
- Access to the [npm registry](https://www.npmjs.com/) and [GitHub](https://github.com/) for publishing and syncing.
|
|
8
|
+
A library of utilities used to manage Data Positioning repositories.
|
|
18
9
|
|
|
19
10
|
## Installation
|
|
20
11
|
|
|
@@ -24,17 +15,16 @@ Install as a development (dev) dependency:
|
|
|
24
15
|
npm install --save-dev @datapos/datapos-development
|
|
25
16
|
```
|
|
26
17
|
|
|
27
|
-
|
|
18
|
+
Ensure your local `.env` file contains the following variables:
|
|
28
19
|
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
|
|
20
|
+
```bash
|
|
21
|
+
GITHUB_DOWNLOAD_LICENSE_API_TOKEN="<GITHUB_API_TOKEN>"
|
|
22
|
+
NPM_TOKEN="<NPM_TOKEN>"
|
|
23
|
+
OWASP_NVD_API_KEY="<NVD_API_KEY>"
|
|
32
24
|
```
|
|
33
25
|
|
|
34
26
|
## Utilities
|
|
35
27
|
|
|
36
|
-
Designed to be run from `package.json` scripts.
|
|
37
|
-
|
|
38
28
|
The `src/index.ts' file exposes the following utilities:
|
|
39
29
|
|
|
40
30
|
| Name | Notes |
|
|
@@ -51,6 +41,20 @@ The `src/index.ts' file exposes the following utilities:
|
|
|
51
41
|
| testProject | |
|
|
52
42
|
| updateDataPosDependencies | |
|
|
53
43
|
|
|
44
|
+
All of the above utilities are designed to be run from `package.json` scripts and assume that the repository follows the standard Data Positioning directory structure and includes a `config.json` file in the root directory.
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
...
|
|
49
|
+
"scripts": {
|
|
50
|
+
...
|
|
51
|
+
"build": "node -e \"import('@datapos/datapos-development').then(m => m.buildProject())\""
|
|
52
|
+
...
|
|
53
|
+
}
|
|
54
|
+
...
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
54
58
|
## Reports & Compliance
|
|
55
59
|
|
|
56
60
|
### Dependency Check Report
|
|
@@ -61,28 +65,48 @@ The OWASP Dependency Check Report identifies known vulnerabilities in project de
|
|
|
61
65
|
|
|
62
66
|
### Dependency Licenses
|
|
63
67
|
|
|
64
|
-
The following table lists top-level production and peer dependencies. All these dependencies
|
|
68
|
+
The following table lists the top-level production and peer dependencies. All of these dependencies—along with their transitive dependencies—have been recursively verified to use one of the following commercially friendly licenses: **Apache-2.0**, **BSD-2-Clause**, **CC0-1.0**, or **MIT**. Developers cloning this repository should independently verify all **development** and **optional** dependencies. This project is used solely to support development activities and is not used in production or distributed in any other form.
|
|
69
|
+
|
|
70
|
+
We use the `npm` packages [license-report](https://www.npmjs.com/package/license-report), [license-report-check](https://www.npmjs.com/package/license-report-check), [license-report-recursive](https://www.npmjs.com/package/license-report-recursive) and [license-downloader](https://www.npmjs.com/package/license-downloader) to identify all dependency licenses and include copies of them. We do not use any unlicensed dependencies in either production or development.
|
|
65
71
|
|
|
66
72
|
<!-- DEPENDENCY_LICENSES_START -->
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
|
71
|
-
|acorn
|
|
72
|
-
|acorn-
|
|
73
|
-
|
|
|
74
|
-
|
|
|
73
|
+
|
|
74
|
+
| Name | Type | Installed | Latest | Latest Release | Deps | Document |
|
|
75
|
+
| :---------------------- | :----------- | :-------: | :-----: | :-------------------------- | ---: | :---------------------------------------------------------------------------------------- |
|
|
76
|
+
| @datapos/datapos-shared | MIT | 0.3.298 | 0.3.298 | this month: 2025-12-09 | 3 | [LICENSE](https://raw.githubusercontent.com/data-positioning/datapos-shared/main/LICENSE) |
|
|
77
|
+
| acorn | MIT | 8.15.0 | 8.15.0 | 6 months ago: 2025-06-09 | 0 | ⚠️ No license file |
|
|
78
|
+
| acorn-typescript | MIT | 1.4.13 | 1.4.13 | 23 months ago: 2024-01-03❗ | 1 | [LICENSE](https://raw.githubusercontent.com/TyrealHu/acorn-typescript/master/LICENSE) |
|
|
79
|
+
| acorn-walk | MIT | 8.3.4 | 8.3.4 | 15 months ago: 2024-09-09❗ | 1 | ⚠️ No license file |
|
|
80
|
+
| dotenv | BSD-2-Clause | 17.2.3 | 17.2.3 | 2 months ago: 2025-09-29 | 0 | [LICENSE](https://raw.githubusercontent.com/motdotla/dotenv/master/LICENSE) |
|
|
81
|
+
| zod | MIT | 4.1.13 | 4.1.13 | this month: 2025-12-07 | 0 | [LICENSE](https://raw.githubusercontent.com/colinhacks/zod/main/LICENSE) |
|
|
75
82
|
|
|
76
83
|
<!-- DEPENDENCY_LICENSES_END -->
|
|
77
84
|
|
|
85
|
+
1. **Installed** column:
|
|
86
|
+
|
|
87
|
+
A ⚠️ symbol is used to highlight any installed version that does not match the latest available version.
|
|
88
|
+
|
|
89
|
+
1. **Latest Release** column:
|
|
90
|
+
|
|
91
|
+
A ⚠️ symbol is used to highlight any dependency that has gone **more than 6 months** without an update but **no more than 12 months**.
|
|
92
|
+
|
|
93
|
+
A **❗** symbol indicates a dependency that has gone **more than 12 months** without an update.
|
|
94
|
+
|
|
95
|
+
If a dependency has no, or only a small number of, transitive dependencies, then it may not require frequent updates. The **Deps** column shows the number of transitive dependencies. Full details for these dependencies can be found in [licenses/licenseTree.json](licenses/licenseTree.json).
|
|
96
|
+
|
|
97
|
+
1. **Document** column:
|
|
98
|
+
|
|
99
|
+
The message “⚠️ No license file” is used to highlight any dependency that does not include a license file.
|
|
100
|
+
|
|
78
101
|
### Bundle Analysis Report
|
|
79
102
|
|
|
80
103
|
The Bundle Analysis Report provides a detailed breakdown of the bundle's composition and module sizes, helping to identify which modules contribute most to the final build. It is generated automatically on each release using the `npm` package [rollup-plugin-visualizer](https://www.npmjs.com/package/rollup-plugin-visualizer).
|
|
81
104
|
|
|
82
105
|
[View the Bundle Analysis Report](https://data-positioning.github.io/datapos-development/stats.html)
|
|
83
106
|
|
|
84
|
-
## Repository
|
|
107
|
+
## Repository Management Commands
|
|
85
108
|
|
|
109
|
+
Implements the common Data Positioning repository management command detailed in
|
|
86
110
|
The table below lists the repository management commands available in this project.
|
|
87
111
|
For detailed implementation, see the `scripts` section in the `package.json` file.
|
|
88
112
|
|
|
@@ -102,6 +126,7 @@ For detailed implementation, see the `scripts` section in the `package.json` fil
|
|
|
102
126
|
## TODO
|
|
103
127
|
|
|
104
128
|
1. Enhance `uploadDirectoryToR2`to batch upload files so more efficient and performant.
|
|
129
|
+
2. Review if it is better to replace all `execCommand`calls with `spawnCommand` calls?
|
|
105
130
|
|
|
106
131
|
## License
|
|
107
132
|
|