@dpuse/dpuse-shared 0.3.840 → 0.3.851

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 (2) hide show
  1. package/README.md +29 -24
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -28,13 +28,17 @@ In addition, DPUse provides [Tools](https://www.dpuse.app) used by the applicati
28
28
 
29
29
  <!-- OPENING_END -->
30
30
 
31
+ <!-- USAGE_START -->
32
+
31
33
  ## Usage
32
34
 
33
- <!-- USAGE_START -->
35
+ This package is published to the [public npm registry](https://www.npmjs.com/package/@dpuse/dpuse-shared). Install it with:
34
36
 
35
- This connector is automatically uploaded to the DPUse Engine cloud once released and becomes instantly available to all new browser app instances, with existing instances notified of the update.
37
+ ```bash
38
+ npm install @dpuse/dpuse-shared
39
+ ```
36
40
 
37
- You may view or clone this repository for your own purposes, such as building a new, similar connector, though there is currently no process to accept third-party connectors into DPUse at this stage. Cloned or forked code is unsupported and isn't guaranteed to remain compatible with the DPUse Engine as it evolves.
41
+ To work on the source instead, clone this repository. Cloned or forked code is unsupported and isn't guaranteed to remain compatible with the DPUse Engine as it evolves.
38
42
 
39
43
  ```bash
40
44
  git clone https://github.com/dpuse/dpuse-shared.git
@@ -234,13 +238,24 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
234
238
 
235
239
  ## Security & Quality
236
240
 
237
- ### CodeQL
238
-
239
- [CodeQL](https://github.com/dpuse/dpuse-shared/security/code-scanning) static analysis runs on every push to `main` and on a weekly schedule, scanning TypeScript, JavaScript, Rust, and GitHub Actions workflow files for security vulnerabilities and coding errors.
240
-
241
- ### SonarCloud
242
-
243
- [SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-shared) performs continuous code quality and security analysis on every push, detecting bugs, code smells, and security vulnerabilities in the TypeScript source.
241
+ ### Checks & Settings
242
+
243
+ Read from the repository each time this README is generated, so the status is current as of the latest release.
244
+
245
+ |Check or setting|Status|What it does|
246
+ |:-|:-|:-|
247
+ |[CodeQL](https://github.com/dpuse/dpuse-shared/security/code-scanning)|✅ GitHub Actions, JavaScript/TypeScript|Static analysis for security vulnerabilities and coding errors, on every push and pull request to `main` and weekly.|
248
+ |[SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-shared)|✅ On|Code quality and security analysis on every push: bugs, code smells and vulnerabilities.|
249
+ |Unit tests|✅ On|Run in CI on every push to `main`.|
250
+ |Property-based tests|✅ fast-check|Fuzz testing: many random inputs per test to find edge cases, run with the unit tests.|
251
+ |npm audit|✅ On|Fails CI when any dependency has a known vulnerability.|
252
+ |[Socket.dev](https://socket.dev)|✅ On|Flags supply chain risk in dependencies: malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE.|
253
+ |Dependabot alerts|✅ On|Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database.|
254
+ |Dependabot security updates|❌ Off|Opens pull requests that update vulnerable dependencies.|
255
+ |Dependabot version updates|❌ Off|Opens pull requests for new dependency versions.|
256
+ |Secret scanning|✅ On|Detects credentials, such as API keys and tokens, committed to the repository.|
257
+ |Push protection|✅ On|Blocks pushes that contain credentials.|
258
+ |Private vulnerability reporting|✅ On|Lets anyone report a vulnerability privately. See [Reporting Vulnerabilities](#reporting-vulnerabilities).|
244
259
 
245
260
  ### Code Health
246
261
 
@@ -255,31 +270,21 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
255
270
  |Unused files|0.0%|
256
271
  |Unused exports|0.0%|
257
272
  |Duplicated code|0.0%|
258
- |Functions over the complexity limits|4 of 83|
273
+ |Functions over the complexity limits|0 of 83|
259
274
  |Unused dependencies|0|
260
275
  |Circular dependencies|0|
261
276
  |Hotspots (complex and often changed)|1|
262
277
 
263
- ### Vulnerability Scanning
264
-
265
- Two complementary tools continuously monitor dependencies for known vulnerabilities:
266
-
267
- - [npm audit](https://docs.npmjs.com/cli/v8/commands/npm-audit) runs on every push to `main` via the CI workflow, failing the build if any high or critical severity vulnerabilities are detected.
268
- - [GitHub Dependabot](https://docs.github.com/en/code-security/dependabot) automatically raises pull requests to update vulnerable dependencies, drawing on the GitHub Advisory Database which combines NVD and npm-specific advisories.
269
-
270
- ### Supply Chain Security
271
-
272
- [Socket.dev](https://socket.dev) monitors all dependencies for supply chain risk — detecting malicious packages, dependency confusion, typosquatting, and suspicious behaviour that may not yet have a CVE.
273
-
274
278
  ### Reporting Vulnerabilities
275
279
 
276
280
  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.
277
281
 
278
282
  ### OpenSSF 🚧
279
283
 
284
+ [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14952/badge)](https://www.bestpractices.dev/projects/14952)
280
285
  [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/dpuse/dpuse-shared/badge)](https://scorecard.dev/viewer/?uri=github.com/dpuse/dpuse-shared)
281
286
 
282
- 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/viewer/?uri=github.com/dpuse/dpuse-shared) provides an independent automated assessment of the project's security practices and is an ongoing area of improvement.
287
+ 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/viewer/?uri=github.com/dpuse/dpuse-shared) provides an independent automated assessment of the project's security practices and is an ongoing area of improvement. Apart from the Best Practices badge above, the remaining Scorecard gaps need multi-person review or a pull-request workflow, which this solo-maintained project doesn't use.
283
288
 
284
289
  ## Contributing
285
290
 
@@ -291,6 +296,6 @@ For security vulnerabilities, see [Reporting Vulnerabilities](#reporting-vulnera
291
296
 
292
297
  This project is licensed under the MIT License, permitting free use, modification, and distribution.
293
298
 
294
- [MIT](./LICENSE) © 2026-present Jonathan Terrell
299
+ [MIT](./LICENSE) © 2026 Jonathan Terrell
295
300
 
296
301
  <!-- GOVERNANCE_END -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dpuse/dpuse-shared",
3
- "version": "0.3.840",
3
+ "version": "0.3.851",
4
4
  "private": false,
5
5
  "description": "Common constants, types and utilities used across all DPUse projects.",
6
6
  "license": "MIT",
@@ -170,12 +170,12 @@
170
170
  "valibot": "^1.5.0"
171
171
  },
172
172
  "devDependencies": {
173
- "@dpuse/dpuse-development": "^0.3.741",
173
+ "@dpuse/dpuse-development": "^0.3.747",
174
174
  "@dpuse/eslint-config-dpuse": "^1.0.123",
175
- "@types/node": "^26.6.2",
175
+ "@types/node": "^26.6.3",
176
176
  "@vitest/coverage-v8": "^5.0.2",
177
177
  "eslint": "^10.11.0",
178
- "fallow": "^3.28.0",
178
+ "fallow": "^3.29.0",
179
179
  "fast-check": "^4.10.2",
180
180
  "prettier": "^3.9.9",
181
181
  "sonda": "^0.14.0",