@dpuse/dpuse-shared 1.0.245 → 1.0.248
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 +43 -27
- package/package.json +6 -5
- package/dist/dpuse-shared.es.js.map +0 -1
package/README.md
CHANGED
|
@@ -3,8 +3,12 @@
|
|
|
3
3
|
<!-- OPENING_START -->
|
|
4
4
|
|
|
5
5
|
[](./LICENSE)
|
|
6
|
-
[](https://www.npmjs.com/package/@dpuse/dpuse-shared)
|
|
7
6
|
[](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml)
|
|
7
|
+
[](https://github.com/dpuse/dpuse-shared/security/code-scanning)
|
|
8
|
+

|
|
9
|
+
[](./code-health-reports/fallow/index.md)
|
|
10
|
+
[](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-shared)
|
|
11
|
+
[](https://www.npmjs.com/package/@dpuse/dpuse-shared)
|
|
8
12
|
|
|
9
13
|
Common constants, types and utilities used across DPUse projects.
|
|
10
14
|
|
|
@@ -12,15 +16,15 @@ Common constants, types and utilities used across DPUse projects.
|
|
|
12
16
|
|
|
13
17
|
## About DPUse
|
|
14
18
|
|
|
15
|
-
|
|
19
|
+
DPUse (Data Positioning & Use) is a browser-based app that helps you prepare your data for use in two main steps: Sourcing and Contextualising. Once your data is contextualised, Presentations and Cookbooks give you two ways to put it to use.
|
|
16
20
|
|
|
17
|
-
**Sourcing** uses
|
|
21
|
+
**Sourcing** uses Connectors to link to applications, databases, file stores, and curated datasets. These Connections help you set up tabular Data Views from your sources.
|
|
18
22
|
|
|
19
|
-
**Contextualising**
|
|
23
|
+
**Contextualising** maps events from your Data Views to detailed Context Models. These models give the DPUse Engine the structure it needs to create clear transactions, facts, or observations.
|
|
20
24
|
|
|
21
|
-
**
|
|
25
|
+
**Presentations** use ready-made Presenters to show your contextualised data in a meaningful way as soon as it's ready.
|
|
22
26
|
|
|
23
|
-
|
|
27
|
+
**Cookbooks** of Recipes guide you in building Data Apps, and additional Presenters, with your contextualised data using your preferred tools.
|
|
24
28
|
|
|
25
29
|
## Introduction
|
|
26
30
|
|
|
@@ -40,6 +44,8 @@ This [package](https://www.npmjs.com/package/@dpuse/dpuse-shared) is available o
|
|
|
40
44
|
npm install @dpuse/dpuse-shared
|
|
41
45
|
```
|
|
42
46
|
|
|
47
|
+
_Requires [Node.js](https://nodejs.org/) 24 or later, [npm](https://www.npmjs.com/) 12 or later._
|
|
48
|
+
|
|
43
49
|
To work on the source instead, clone this repository.
|
|
44
50
|
|
|
45
51
|
```bash
|
|
@@ -48,10 +54,18 @@ cd dpuse-shared
|
|
|
48
54
|
npm install
|
|
49
55
|
```
|
|
50
56
|
|
|
51
|
-
|
|
57
|
+
_Working on the source also requires [TypeScript](https://www.typescriptlang.org/) 6.0.3 or a later 6.0 release. Later versions, including TypeScript 7, are not supported yet._
|
|
52
58
|
|
|
53
59
|
This repository is managed using the common set of actions provided by [@dpuse/dpuse-development](https://github.com/dpuse/dpuse-development). See the `scripts` block in [package.json](https://github.com/dpuse/dpuse-shared/blob/main/package.json) for details.
|
|
54
60
|
|
|
61
|
+
### Release Status
|
|
62
|
+
|
|
63
|
+
DPUse is a new product, and this package is a release candidate: complete and in use across DPUse, but not yet at its first stable release.
|
|
64
|
+
|
|
65
|
+
The last number of the version increases with every push to GitHub, whether or not that push is released, so the versions of consecutive releases can skip numbers, for example from 1.1.120 to 1.1.124. Until the first stable release, any release may include changes that need updates in the projects that use it, so depend on an exact version to avoid unexpected changes. Once stable, versions will follow [Semantic Versioning](https://semver.org): breaking changes in the first number, new features in the second and fixes in the last.
|
|
66
|
+
|
|
67
|
+
Every release is listed on the [Releases](https://github.com/dpuse/dpuse-shared/releases) page.
|
|
68
|
+
|
|
55
69
|
<!-- USAGE_END -->
|
|
56
70
|
|
|
57
71
|
### Example
|
|
@@ -291,37 +305,36 @@ This section is updated each time `npm run document` is run. Settings come from
|
|
|
291
305
|
|
|
292
306
|
### Testing
|
|
293
307
|
|
|
294
|
-
| Check | Status | What it does
|
|
295
|
-
| :------------------- | :----- |
|
|
296
|
-
| Unit tests | ✅ On | [Vitest](https://vitest.dev) runs the unit tests. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`.
|
|
297
|
-
| Property-based tests | ✅ On | [fast-check](https://fast-check.dev) runs many random inputs per test to find edge cases, alongside the unit tests. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`.
|
|
298
|
-
| Test coverage | ✅ On |
|
|
308
|
+
| Check | Status | What it does |
|
|
309
|
+
| :------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
310
|
+
| Unit tests | ✅ On | [Vitest](https://vitest.dev) runs the unit tests. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
311
|
+
| Property-based tests | ✅ On | [fast-check](https://fast-check.dev) runs many random inputs per test to find edge cases, alongside the unit tests. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
312
|
+
| Test coverage | ✅ On | [Vitest's V8 coverage](https://vitest.dev/guide/coverage) measures the share of source lines the unit tests run. |
|
|
299
313
|
|
|
300
314
|
### Code Quality
|
|
301
315
|
|
|
302
|
-
| Check | Status | What it does
|
|
303
|
-
| :------------ | :----- |
|
|
304
|
-
|
|
|
305
|
-
| Code
|
|
306
|
-
|
|
|
316
|
+
| Check | Status | What it does |
|
|
317
|
+
| :------------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
318
|
+
| Linting | ✅ On | [ESLint](https://eslint.org) checks the code for errors and style problems, and the [TypeScript](https://www.typescriptlang.org/) compiler type-checks the whole project. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
319
|
+
| Code health | ✅ On | [Fallow](https://github.com/fallow-rs/fallow) finds unused code, duplication, complexity and dependency problems. See the [report](./code-health-reports/fallow/index.md). |
|
|
320
|
+
| Code analysis | ✅ On | [SonarCloud](https://sonarcloud.io) checks every push for bugs, code smells and vulnerabilities. |
|
|
307
321
|
|
|
308
322
|
### Security Analysis
|
|
309
323
|
|
|
310
|
-
| Check | Status | What it does
|
|
311
|
-
| :-------------- | :----- |
|
|
312
|
-
| Push protection | ✅ On | [GitHub push protection](https://docs.github.com/en/code-security/secret-scanning/push-protection-for-repositories-and-organizations) blocks pushes that contain credentials.
|
|
313
|
-
| Static analysis | ✅ On | [
|
|
314
|
-
| Secret scanning | ✅ On | [GitHub secret scanning](https://docs.github.com/en/code-security/secret-scanning) detects credentials, such as API keys and tokens, committed to the repository.
|
|
324
|
+
| Check | Status | What it does |
|
|
325
|
+
| :-------------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
326
|
+
| Push protection | ✅ On | [GitHub push protection](https://docs.github.com/en/code-security/secret-scanning/push-protection-for-repositories-and-organizations) blocks pushes that contain credentials. |
|
|
327
|
+
| Static analysis | ✅ On | [GitHub CodeQL](https://codeql.github.com) scans GitHub Actions and JavaScript/TypeScript for security vulnerabilities, using the extended security queries, on every push and pull request to `main` and weekly. |
|
|
328
|
+
| Secret scanning | ✅ On | [GitHub secret scanning](https://docs.github.com/en/code-security/secret-scanning) detects credentials, such as API keys and tokens, committed to the repository. |
|
|
315
329
|
|
|
316
330
|
### Dependencies
|
|
317
331
|
|
|
318
332
|
| Check | Status | What it does |
|
|
319
333
|
| :------------------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
320
334
|
| Vulnerability audit | ✅ On | [npm audit](https://docs.npmjs.com/cli/commands/npm-audit) fails when a shipped dependency has any known vulnerability, or a development dependency has a high or critical one. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
321
|
-
| Supply chain risk | ✅ On | [Socket](https://socket.dev) flags malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE.
|
|
322
|
-
| Security alerts | ✅ On | [Dependabot](https://docs.github.com/en/code-security/dependabot) alerts when a dependency has a known vulnerability, using the GitHub Advisory Database.
|
|
323
|
-
|
|
|
324
|
-
| Version updates | ❌ Off | [Dependabot](https://docs.github.com/en/code-security/dependabot) opens pull requests for new dependency versions. These are handled manually. |
|
|
335
|
+
| Supply chain risk | ✅ On | [Socket.dev](https://socket.dev) flags malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE. |
|
|
336
|
+
| Security alerts | ✅ On | [GitHub Dependabot](https://docs.github.com/en/code-security/dependabot) alerts when a dependency has a known vulnerability, using the GitHub Advisory Database. |
|
|
337
|
+
| Dependency updates | ❌ Off | [GitHub Dependabot](https://docs.github.com/en/code-security/dependabot) can open pull requests for new and vulnerable dependency versions. Dependencies are updated by hand with `npm run check` instead. |
|
|
325
338
|
|
|
326
339
|
### OpenSSF 🚧
|
|
327
340
|
|
|
@@ -330,6 +343,9 @@ This section is updated each time `npm run document` is run. Settings come from
|
|
|
330
343
|
|
|
331
344
|
This project is working towards the [OpenSSF Best Practices](https://www.bestpractices.dev) Passing badge, a self-certification covering security policy, vulnerability reporting, build processes, code quality, and more. Currently the [OpenSSF Scorecard](https://scorecard.dev) provides an independent automated assessment of the project's security practices and is an ongoing area of improvement.
|
|
332
345
|
|
|
346
|
+
> [!NOTE]
|
|
347
|
+
> The Scorecard score is below the maximum for two reasons. The OpenSSF Best Practices badge above is not complete yet, and some checks need a second reviewer or a pull-request workflow, which a solo-maintained project cannot provide.
|
|
348
|
+
|
|
333
349
|
### Reporting Vulnerabilities
|
|
334
350
|
|
|
335
351
|
Please do not open public GitHub issues for security vulnerabilities. Use [GitHub private vulnerability reporting](https://github.com/dpuse/dpuse-shared/security/advisories/new) instead. See [SECURITY.md](./SECURITY.md) for the full disclosure policy, contact details, and expected response times.
|
|
@@ -340,7 +356,7 @@ Please do not open public GitHub issues for security vulnerabilities. Use [GitHu
|
|
|
340
356
|
|
|
341
357
|
## Contributing
|
|
342
358
|
|
|
343
|
-
This repository is maintained solely by its owner and does not, at present, accept external contributions
|
|
359
|
+
This repository is maintained solely by its owner and does not, at present, accept external contributions. Its source is published openly under the MIT License — every DPUse project is fully open source except DPUse Engine and DPUse API, which remain closed and proprietary.
|
|
344
360
|
|
|
345
361
|
For security vulnerabilities, see [Reporting Vulnerabilities](#reporting-vulnerabilities). For bugs, inconsistencies, or other feedback, [open a GitHub issue](https://github.com/dpuse/dpuse-shared/issues) — feedback is read, but responses and fixes are at the maintainer's discretion.
|
|
346
362
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dpuse/dpuse-shared",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.248",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Common constants, types and utilities used across DPUse projects.",
|
|
6
6
|
"license": "MIT",
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
}
|
|
25
25
|
},
|
|
26
26
|
"files": [
|
|
27
|
-
"dist"
|
|
27
|
+
"dist",
|
|
28
|
+
"!dist/**/*.map"
|
|
28
29
|
],
|
|
29
30
|
"engines": {
|
|
30
31
|
"node": ">=24",
|
|
@@ -64,13 +65,13 @@
|
|
|
64
65
|
"valibot": "^1.5.0"
|
|
65
66
|
},
|
|
66
67
|
"devDependencies": {
|
|
67
|
-
"@dpuse/dpuse-development": "^1.
|
|
68
|
-
"@dpuse/eslint-config-dpuse": "^1.
|
|
68
|
+
"@dpuse/dpuse-development": "^1.1.101",
|
|
69
|
+
"@dpuse/eslint-config-dpuse": "^1.1.107",
|
|
69
70
|
"@types/node": "^26.6.6",
|
|
70
71
|
"@types/trusted-types": "^2.0.7",
|
|
71
72
|
"@vitest/coverage-v8": "^5.1.1",
|
|
72
73
|
"eslint": "^10.15.0",
|
|
73
|
-
"fallow": "^3.
|
|
74
|
+
"fallow": "^3.45.0",
|
|
74
75
|
"fast-check": "^4.10.3",
|
|
75
76
|
"iconv-lite": "^0.7.3",
|
|
76
77
|
"jschardet": "^4.1.0",
|