@dpuse/dpuse-shared 1.0.244 → 1.0.247

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 +15 -3
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -8,6 +8,8 @@
8
8
 
9
9
  Common constants, types and utilities used across DPUse projects.
10
10
 
11
+ **Release candidate.** See [Release Status](#release-status).
12
+
11
13
  [Report a Vulnerability](https://github.com/dpuse/dpuse-shared/security/advisories/new) · [Open an Issue](https://github.com/dpuse/dpuse-shared/issues)
12
14
 
13
15
  ## About DPUse
@@ -40,6 +42,8 @@ This [package](https://www.npmjs.com/package/@dpuse/dpuse-shared) is available o
40
42
  npm install @dpuse/dpuse-shared
41
43
  ```
42
44
 
45
+ _Requires [Node.js](https://nodejs.org/) 24 or later, [npm](https://www.npmjs.com/) 12 or later._
46
+
43
47
  To work on the source instead, clone this repository.
44
48
 
45
49
  ```bash
@@ -48,10 +52,18 @@ cd dpuse-shared
48
52
  npm install
49
53
  ```
50
54
 
51
- _Requires [Node.js](https://nodejs.org/) 24 or later, [npm](https://www.npmjs.com/) 12 or later, and [TypeScript](https://www.typescriptlang.org/) 6.0.3 or later._
55
+ _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
56
 
53
57
  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
58
 
59
+ ### Release Status
60
+
61
+ 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.
62
+
63
+ Each release increases the last number of the version, for example from 1.0.164 to 1.0.165. 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.
64
+
65
+ Every release is listed on the [Releases](https://github.com/dpuse/dpuse-shared/releases) page.
66
+
55
67
  <!-- USAGE_END -->
56
68
 
57
69
  ### Example
@@ -246,7 +258,7 @@ The October 2026 comparison of chardet and jschardet also used [chardet/test-dat
246
258
 
247
259
  ## Dependency Licenses
248
260
 
249
- License data is updated each time `npm run document` is run, using [license-checker](https://github.com/RSeidelsohn/license-checker-rseidelsohn). The following table lists every package whose code, styles or assets are included in this project's build, as recorded by the build itself. Modules loaded at run time are not included; each documents its own. These dependencies have been checked and confirmed to use MIT, all of which allow commercial use. All are used unmodified, so any licence conditions that apply only to modified versions are not triggered. Developers cloning this repository should independently verify development dependencies.
261
+ License data is updated each time `npm run document` is run, using [CycloneDX](https://github.com/CycloneDX/cyclonedx-node-npm). The following table lists every package whose code, styles or assets are included in this project's build, as recorded by the build itself. Modules loaded at run time are not included; each documents its own. These dependencies have been checked and confirmed to use MIT, all of which allow commercial use. All are used as published. Where the build has to adjust a dependency so it can be bundled, the adjustment only affects how its files are located and loaded, never what the code does. Developers cloning this repository should independently verify development dependencies.
250
262
 
251
263
  | Dependency | Version | License(s) | Document |
252
264
  | :------------------------------------------------ | :-----: | :--------- | :------------------------------------------------------ |
@@ -303,7 +315,7 @@ This section is updated each time `npm run document` is run. Settings come from
303
315
  | :------------ | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
304
316
  | Code health | ✅ On | [![Fallow code health](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fdpuse%2Fdpuse-shared%2Fmain%2Fcode-health-reports%2Ffallow%2Fbadge.json)](./code-health-reports/fallow/index.md) [Fallow](https://github.com/fallow-rs/fallow) finds unused code, duplication, complexity and dependency problems. |
305
317
  | Code analysis | ✅ On | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dpuse_dpuse-shared&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-shared) [SonarCloud](https://sonarcloud.io) checks every push for bugs, code smells and vulnerabilities. |
306
- | Linting | ✅ On | [ESLint](https://eslint.org) checks the code for errors and style problems. Part of the [CI workflow](https://github.com/dpuse/dpuse-shared/actions/workflows/ci.yml) on every push and pull request to `main`. |
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`. |
307
319
 
308
320
  ### Security Analysis
309
321
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dpuse/dpuse-shared",
3
- "version": "1.0.244",
3
+ "version": "1.0.247",
4
4
  "private": false,
5
5
  "description": "Common constants, types and utilities used across DPUse projects.",
6
6
  "license": "MIT",
@@ -64,14 +64,14 @@
64
64
  "valibot": "^1.5.0"
65
65
  },
66
66
  "devDependencies": {
67
- "@dpuse/dpuse-development": "^1.0.157",
68
- "@dpuse/eslint-config-dpuse": "^1.0.152",
67
+ "@dpuse/dpuse-development": "^1.0.169",
68
+ "@dpuse/eslint-config-dpuse": "^1.1.105",
69
69
  "@types/node": "^26.6.6",
70
70
  "@types/trusted-types": "^2.0.7",
71
71
  "@vitest/coverage-v8": "^5.1.1",
72
72
  "eslint": "^10.15.0",
73
- "fallow": "^3.43.2",
74
- "fast-check": "^4.10.2",
73
+ "fallow": "^3.44.0",
74
+ "fast-check": "^4.10.3",
75
75
  "iconv-lite": "^0.7.3",
76
76
  "jschardet": "^4.1.0",
77
77
  "prettier": "^3.10.1",