@dpuse/dpuse-development 0.3.749 → 0.3.751

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.
@@ -0,0 +1,9 @@
1
+ # Version-update pull requests are switched off (limit 0): dependencies are updated with 'npm run check' instead. The
2
+ # file is kept because OpenSSF Scorecard looks for it when checking that a dependency update tool is used.
3
+ version: 2
4
+ updates:
5
+ - package-ecosystem: npm
6
+ directory: /
7
+ schedule:
8
+ interval: weekly
9
+ open-pull-requests-limit: 0
@@ -0,0 +1,15 @@
1
+ # Version-update pull requests are switched off (limit 0): dependencies are updated with 'npm run check' instead. The
2
+ # file is kept because OpenSSF Scorecard looks for it when checking that a dependency update tool is used.
3
+ version: 2
4
+ updates:
5
+ - package-ecosystem: npm
6
+ directory: /
7
+ schedule:
8
+ interval: weekly
9
+ open-pull-requests-limit: 0
10
+
11
+ - package-ecosystem: github-actions
12
+ directory: /
13
+ schedule:
14
+ interval: weekly
15
+ open-pull-requests-limit: 0
@@ -0,0 +1,67 @@
1
+ name: Publish
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ permissions:
8
+ contents: read
9
+
10
+ jobs:
11
+ publish:
12
+ name: Publish to Cloudflare
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - name: Checkout
16
+ uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
17
+
18
+ # TODO: When the Node version below ships with npm 12, keep only the later 'Setup Node with npm cache' step, renamed
19
+ # 'Setup Node', and remove this step and 'Setup npm'. Until then Node is set up twice: first with caching off, because
20
+ # setup-node checks the cache with the npm bundled with Node (11), which 'devEngines' in package.json rejects. Caching
21
+ # must be switched off explicitly, as setup-node turns it on by itself when package.json names a package manager.
22
+ - name: Setup Node
23
+ uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
24
+ with:
25
+ node-version: 24
26
+ package-manager-cache: false
27
+
28
+ # Replaces the bundled npm with npm 12, unpacked from a download checked against a pinned hash. Not installed with
29
+ # 'npm install -g', which OpenSSF Scorecard always counts as unpinned. Runs in the temp folder to keep the download
30
+ # out of the checkout. When changing the version, update the URL and take the new hash from:
31
+ # npm view npm@<version> dist.integrity | base64 -d | xxd -p | tr -d '\n'
32
+ - name: Setup npm
33
+ run: |
34
+ curl --proto '=https' -fsSLo npm.tgz https://registry.npmjs.org/npm/-/npm-12.1.0.tgz
35
+ echo "17286eeb6a4dc7bd180acff9f9d1262504c556648ac2fa39080d2abc19060d1a686f8d8c27a1b6450dad77178a3389d89c8643aa4600c4482ab687a39fd406b5 npm.tgz" | sha512sum -c -
36
+ npm_directory="$(dirname "$(dirname "$(command -v node)")")/lib/node_modules/npm"
37
+ rm -rf "$npm_directory" && mkdir "$npm_directory"
38
+ tar -xzf npm.tgz -C "$npm_directory" --strip-components=1
39
+ npm --version
40
+ working-directory: ${{ runner.temp }}
41
+
42
+ # The same Node again, now with npm 12, so the npm cache can be used.
43
+ - name: Setup Node with npm cache
44
+ uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
45
+ with:
46
+ node-version: 24
47
+ cache: npm
48
+
49
+ - name: Install dependencies
50
+ run: npm ci --ignore-scripts
51
+
52
+ - name: Build
53
+ run: npm run build
54
+
55
+ # Repeats the CI checks: a release is created straight after its push, so this runs alongside CI rather than
56
+ # after it, and must not publish a commit that fails them.
57
+ - name: Lint
58
+ run: npm run lint
59
+
60
+ - name: Test
61
+ run: npm test
62
+
63
+ - name: Publish
64
+ run: npm run publish
65
+ env:
66
+ CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
67
+ CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
@@ -0,0 +1,64 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: ['main']
6
+ pull_request:
7
+ branches: ['main']
8
+
9
+ permissions:
10
+ contents: read
11
+
12
+ jobs:
13
+ ci:
14
+ name: Lint, test & audit
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - name: Checkout
18
+ uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
19
+
20
+ # TODO: When the Node version below ships with npm 12, keep only the later 'Setup Node with npm cache' step, renamed
21
+ # 'Setup Node', and remove this step and 'Setup npm'. Until then Node is set up twice: first with caching off, because
22
+ # setup-node checks the cache with the npm bundled with Node (11), which 'devEngines' in package.json rejects. Caching
23
+ # must be switched off explicitly, as setup-node turns it on by itself when package.json names a package manager.
24
+ - name: Setup Node
25
+ uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
26
+ with:
27
+ node-version: 24
28
+ package-manager-cache: false
29
+
30
+ # Replaces the bundled npm with npm 12, unpacked from a download checked against a pinned hash. Not installed with
31
+ # 'npm install -g', which OpenSSF Scorecard always counts as unpinned. Runs in the temp folder to keep the download
32
+ # out of the checkout. When changing the version, update the URL and take the new hash from:
33
+ # npm view npm@<version> dist.integrity | base64 -d | xxd -p | tr -d '\n'
34
+ - name: Setup npm
35
+ run: |
36
+ curl --proto '=https' -fsSLo npm.tgz https://registry.npmjs.org/npm/-/npm-12.1.0.tgz
37
+ echo "17286eeb6a4dc7bd180acff9f9d1262504c556648ac2fa39080d2abc19060d1a686f8d8c27a1b6450dad77178a3389d89c8643aa4600c4482ab687a39fd406b5 npm.tgz" | sha512sum -c -
38
+ npm_directory="$(dirname "$(dirname "$(command -v node)")")/lib/node_modules/npm"
39
+ rm -rf "$npm_directory" && mkdir "$npm_directory"
40
+ tar -xzf npm.tgz -C "$npm_directory" --strip-components=1
41
+ npm --version
42
+ working-directory: ${{ runner.temp }}
43
+
44
+ # The same Node again, now with npm 12, so the npm cache can be used.
45
+ - name: Setup Node with npm cache
46
+ uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
47
+ with:
48
+ node-version: 24
49
+ cache: npm
50
+
51
+ - name: Install dependencies
52
+ run: npm ci --ignore-scripts
53
+
54
+ - name: Build
55
+ run: npm run build
56
+
57
+ - name: Lint
58
+ run: npm run lint
59
+
60
+ - name: Test
61
+ run: npm test
62
+
63
+ - name: Audit
64
+ run: npm run audit
@@ -0,0 +1,44 @@
1
+ name: 'CodeQL Advanced'
2
+
3
+ on:
4
+ push:
5
+ branches: ['main']
6
+ pull_request:
7
+ branches: ['main']
8
+ schedule:
9
+ - cron: '28 18 * * 6'
10
+
11
+ permissions: {}
12
+
13
+ jobs:
14
+ analyze:
15
+ name: Analyze (${{ matrix.language }})
16
+ runs-on: ubuntu-latest
17
+ permissions:
18
+ security-events: write
19
+ packages: read
20
+ contents: read
21
+
22
+ strategy:
23
+ fail-fast: false
24
+ matrix:
25
+ include:
26
+ - language: actions
27
+ build-mode: none
28
+ - language: javascript-typescript
29
+ build-mode: none
30
+
31
+ steps:
32
+ - name: Checkout repository
33
+ uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
34
+
35
+ - name: Initialize CodeQL
36
+ uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
37
+ with:
38
+ languages: ${{ matrix.language }}
39
+ build-mode: ${{ matrix.build-mode }}
40
+
41
+ - name: Perform CodeQL Analysis
42
+ uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
43
+ with:
44
+ category: '/language:${{matrix.language}}'
@@ -0,0 +1,66 @@
1
+ name: Publish
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ permissions:
8
+ contents: read
9
+ id-token: write
10
+
11
+ jobs:
12
+ publish:
13
+ name: Publish to npm
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - name: Checkout
17
+ uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
18
+
19
+ # TODO: When the Node version below ships with npm 12, keep only the later 'Setup Node with npm cache' step, renamed
20
+ # 'Setup Node', and remove this step and 'Setup npm'. Until then Node is set up twice: first with caching off, because
21
+ # setup-node checks the cache with the npm bundled with Node (11), which 'devEngines' in package.json rejects. Caching
22
+ # must be switched off explicitly, as setup-node turns it on by itself when package.json names a package manager.
23
+ - name: Setup Node
24
+ uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
25
+ with:
26
+ node-version: 24
27
+ package-manager-cache: false
28
+
29
+ # Replaces the bundled npm with npm 12, unpacked from a download checked against a pinned hash. Not installed with
30
+ # 'npm install -g', which OpenSSF Scorecard always counts as unpinned. Runs in the temp folder to keep the download
31
+ # out of the checkout. When changing the version, update the URL and take the new hash from:
32
+ # npm view npm@<version> dist.integrity | base64 -d | xxd -p | tr -d '\n'
33
+ - name: Setup npm
34
+ run: |
35
+ curl --proto '=https' -fsSLo npm.tgz https://registry.npmjs.org/npm/-/npm-12.1.0.tgz
36
+ echo "17286eeb6a4dc7bd180acff9f9d1262504c556648ac2fa39080d2abc19060d1a686f8d8c27a1b6450dad77178a3389d89c8643aa4600c4482ab687a39fd406b5 npm.tgz" | sha512sum -c -
37
+ npm_directory="$(dirname "$(dirname "$(command -v node)")")/lib/node_modules/npm"
38
+ rm -rf "$npm_directory" && mkdir "$npm_directory"
39
+ tar -xzf npm.tgz -C "$npm_directory" --strip-components=1
40
+ npm --version
41
+ working-directory: ${{ runner.temp }}
42
+
43
+ # The same Node again, now with npm 12, so the npm cache can be used.
44
+ - name: Setup Node with npm cache
45
+ uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
46
+ with:
47
+ node-version: 24
48
+ cache: npm
49
+ registry-url: https://registry.npmjs.org
50
+
51
+ - name: Install dependencies
52
+ run: npm ci --ignore-scripts
53
+
54
+ - name: Build
55
+ run: npm run build
56
+
57
+ # Repeats the CI checks: a release is created straight after its push, so this runs alongside CI rather than
58
+ # after it, and must not publish a commit that fails them.
59
+ - name: Lint
60
+ run: npm run lint
61
+
62
+ - name: Test
63
+ run: npm test
64
+
65
+ - name: Publish
66
+ run: npm publish --provenance
@@ -0,0 +1,44 @@
1
+ name: Scorecard supply-chain security
2
+ on:
3
+ branch_protection_rule:
4
+ schedule:
5
+ - cron: '41 12 * * 4'
6
+ push:
7
+ branches: ['main']
8
+
9
+ permissions: {}
10
+
11
+ jobs:
12
+ analysis:
13
+ name: Scorecard analysis
14
+ runs-on: ubuntu-latest
15
+ if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request'
16
+ permissions:
17
+ contents: read
18
+ security-events: write
19
+ id-token: write
20
+
21
+ steps:
22
+ - name: 'Checkout code'
23
+ uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
24
+ with:
25
+ persist-credentials: false
26
+
27
+ - name: 'Run analysis'
28
+ uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
29
+ with:
30
+ results_file: results.sarif
31
+ results_format: sarif
32
+ publish_results: true
33
+
34
+ - name: 'Upload artifact'
35
+ uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
36
+ with:
37
+ name: SARIF file
38
+ path: results.sarif
39
+ retention-days: 5
40
+
41
+ - name: 'Upload to code-scanning'
42
+ uses: github/codeql-action/upload-sarif@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
43
+ with:
44
+ sarif_file: results.sarif
package/README.md CHANGED
@@ -53,77 +53,51 @@ _Requires [Node.js](https://nodejs.org/) 24 or later, [npm](https://www.npmjs.co
53
53
 
54
54
  This repository provides these commands to every DPUse project, and uses them itself:
55
55
 
56
- |Command|What it does|
57
- |:-|:-|
58
- |`npm run build`|Builds the project.|
59
- |`npm test`|Runs the tests.|
60
- |`npm run lint`|Checks the code with ESLint.|
61
- |`npm run format`|Formats the code with Prettier.|
62
- |`npm run audit`|Checks dependencies for known vulnerabilities with npm audit.|
63
- |`npm run check`|Checks configuration files against the DPUse templates and lists outdated dependencies.|
64
- |`npm run update`|Updates the DPUse packages this project depends on to their latest versions.|
65
- |`npm run document`|Regenerates the README's generated sections.|
66
- |`npm run documentOpening`|Regenerates the README's opening section.|
67
- |`npm run documentUsage`|Regenerates the README's Usage section.|
68
- |`npm run documentDependencies`|Regenerates the README's dependency licence report.|
69
- |`npm run documentBundleSizes`|Regenerates the README's bundle size report.|
70
- |`npm run documentGovernance`|Regenerates the README's Security & Quality, Contributing and License sections.|
71
- |`npm run sync`|Bumps the version, then commits and pushes to GitHub.|
72
- |`npm run release`|Bumps the version, commits and pushes, and creates a GitHub release.|
56
+ | Command | What it does |
57
+ | :----------------------------- | :-------------------------------------------------------------------------------------- |
58
+ | `npm run build` | Builds the project. |
59
+ | `npm test` | Runs the tests. |
60
+ | `npm run lint` | Checks the code with ESLint. |
61
+ | `npm run format` | Formats the code with Prettier. |
62
+ | `npm run audit` | Checks dependencies for known vulnerabilities with npm audit. |
63
+ | `npm run check` | Checks configuration files against the DPUse templates and lists outdated dependencies. |
64
+ | `npm run update` | Updates the DPUse packages this project depends on to their latest versions. |
65
+ | `npm run document` | Regenerates the README's generated sections. |
66
+ | `npm run documentOpening` | Regenerates the README's opening section. |
67
+ | `npm run documentUsage` | Regenerates the README's Usage section. |
68
+ | `npm run documentDependencies` | Regenerates the README's dependency licence report. |
69
+ | `npm run documentBundleSizes` | Regenerates the README's bundle size report. |
70
+ | `npm run documentGovernance` | Regenerates the README's Security & Quality, Contributing and License sections. |
71
+ | `npm run sync` | Bumps the version, then commits and pushes to GitHub. |
72
+ | `npm run release` | Bumps the version, commits and pushes, and creates a GitHub release. |
73
73
 
74
74
  <!-- USAGE_END -->
75
75
 
76
- ## DPUse Projects
77
-
78
- Entry/top level projects...
79
-
80
- | Name | Description |
81
- | ------ | ------------------------------- |
82
- | app | Frontend or client application. |
83
- | api | Backend API. |
84
- | engine | |
85
- | shared | |
86
-
87
- Plugin project groupings...
88
-
89
- | Name | Description |
90
- | ---------- | ------------------------------------------------------------------------------------------------------------------------------- |
91
- | connectors | Connections... |
92
- | contexts | Areas,Models... Dimensions, Entities, Secondary Measures... Hierarchies, Levels... Characteristics, Events, Primary Measures... |
93
- | presenters | Presentations... |
94
- | cookbooks | Recipes... |
95
- | tools | |
96
-
97
- Support projects...
98
-
99
- | Name | Description |
100
- | ----------- | ----------------------------------------- |
101
- | development | This package. |
102
- | kb | Knowledge content and deployment scripts. |
103
- | resources | Sample data and deployment scripts. |
104
-
105
- ## Actions
76
+ ## Architecture
106
77
 
107
78
  The package implements the following actions:
108
79
 
109
80
  | Name | Notes |
110
81
  | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
111
82
  | auditDependencies | Audit the project's dependencies for known security vulnerabilities. uses the owasp-dependency-check module to perform the checks. Updates the OWASP badge(s) at the top of this page. Also runs the 'npm outdated`command. |
112
- | buildDirectoryIndex | Build an index for the specified directory path. |
113
- | buildProject | Builds the package using Vite. Output to '/dist' directory. Wrangler for api. Nuxt for app-nuxt. Builds bundle analysis reports. |
83
+ | checkConfigFiles | |
114
84
  | checkDependencies | Identifies outdated dependencies using npm `outdated` and `npm-check-updates` with option to automatically install latest versions. |
85
+ | documentBundleSizes | |
115
86
  | documentDependencies | Identify licenses of the project's production and peer dependencies. Updates the table in the **Dependency Licenses** section of this page and summary files licenses.json and licenseTree.json in th licenses directory of this repository. Also downloads a copy of dependency license to `licenses/downloads'.. |
87
+ | documentGovernance | |
88
+ | documentActions | |
89
+ | documentOpening | |
90
+ | documentUsage | |
116
91
  | formatCode | Uses `prettier` to enforce formatting style rules. |
117
92
  | lintCode | Uses `eslint` to check the code for potential errors and enforces coding style rules. |
93
+ | uploadDirectoryToR2 | |
94
+ | buildProject | Builds the package using Vite. Output to '/dist' directory. Wrangler for api. Nuxt for app-nuxt. Builds bundle analysis reports. |
95
+ | publishProject | |
118
96
  | releaseProject | Bump version, builds config, builds project, synchronise with `GitHub` and publish to `npm` or Cloudflare. |
119
97
  | syncProjectWithGitHub | Synchronise the local repository with the main GitHub repository. |
120
- | testProject | ❌ Not implemented. |
98
+ | testProject | |
121
99
 
122
- ### Usage
123
-
124
- All utilities are designed to be run from `package.json` scripts and assume that the project follows the standard DPUse directory structure and that it includes a `config.json` file in the root directory.
125
-
126
- Please see other DPUse repositories for actual usage.
100
+ All actions are designed to be run from `package.json` scripts and assume that the project follows the standard DPUse directory structure and that it includes a `config.json` file in the root directory.
127
101
 
128
102
  <!-- DEPENDENCY_LICENSES_START -->
129
103
 
@@ -144,17 +118,17 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
144
118
 
145
119
  |Chunk/Module/File|Composition|
146
120
  |:------ |:-----------|
147
- | dist/dpuse-development.es.js | 321.9 kB · gzip 82.8 kB |
148
- | &nbsp;&nbsp;&nbsp;&nbsp;acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 40.6% |
149
- | &nbsp;&nbsp;&nbsp;&nbsp;acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 35.6% |
150
- | &nbsp;&nbsp;&nbsp;&nbsp;src | `███░░░░░░░░░░░░░░░░░` 13.2% |
121
+ | dist/dpuse-development.es.js | 323.0 kB · gzip 83.1 kB |
122
+ | &nbsp;&nbsp;&nbsp;&nbsp;acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 40.5% |
123
+ | &nbsp;&nbsp;&nbsp;&nbsp;acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 35.5% |
124
+ | &nbsp;&nbsp;&nbsp;&nbsp;src | `███░░░░░░░░░░░░░░░░░` 13.5% |
151
125
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentGovernance.ts | `░░░░░░░░░░░░░░░░░░░░` 2.5% |
152
126
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
153
127
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;manageProject.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
154
128
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index.ts | `░░░░░░░░░░░░░░░░░░░░` 1.6% |
155
129
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 1.4% |
156
130
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.4% |
157
- | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 0.8% |
131
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 1.2% |
158
132
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
159
133
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
160
134
  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
@@ -182,20 +156,20 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
182
156
 
183
157
  Read from the repository each time this README is generated, so the status is current as of the latest release.
184
158
 
185
- |Check or setting|Status|What it does|
186
- |:-|:-|:-|
187
- |[CodeQL](https://github.com/dpuse/dpuse-development/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.|
188
- |[SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development)|✅ On|Code quality and security analysis on every push: bugs, code smells and vulnerabilities.|
189
- |Unit tests|✅ On|Run in CI on every push to `main`.|
190
- |Property-based tests|✅ fast-check|Fuzz testing: many random inputs per test to find edge cases, run with the unit tests.|
191
- |npm audit|✅ On|Fails CI when any dependency has a known vulnerability.|
192
- |[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.|
193
- |Dependabot alerts|✅ On|Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database.|
194
- |Dependabot security updates|❌ Off|Opens pull requests that update vulnerable dependencies.|
195
- |Dependabot version updates|❌ Off|Opens pull requests for new dependency versions.|
196
- |Secret scanning|✅ On|Detects credentials, such as API keys and tokens, committed to the repository.|
197
- |Push protection|✅ On|Blocks pushes that contain credentials.|
198
- |Private vulnerability reporting|✅ On|Lets anyone report a vulnerability privately. See [Reporting Vulnerabilities](#reporting-vulnerabilities).|
159
+ | Check or setting | Status | What it does |
160
+ | :------------------------------------------------------------------------------ | :--------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- |
161
+ | [CodeQL](https://github.com/dpuse/dpuse-development/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. |
162
+ | [SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development) | ✅ On | Code quality and security analysis on every push: bugs, code smells and vulnerabilities. |
163
+ | Unit tests | ✅ On | Run in CI on every push to `main`. |
164
+ | Property-based tests | ✅ fast-check | Fuzz testing: many random inputs per test to find edge cases, run with the unit tests. |
165
+ | npm audit | ✅ On | Fails CI when any dependency has a known vulnerability. |
166
+ | [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. |
167
+ | Dependabot alerts | ✅ On | Alerts when a dependency has a known vulnerability, using the GitHub Advisory Database. |
168
+ | Dependabot security updates | ❌ Off | Opens pull requests that update vulnerable dependencies. |
169
+ | Dependabot version updates | ❌ Off | Opens pull requests for new dependency versions. |
170
+ | Secret scanning | ✅ On | Detects credentials, such as API keys and tokens, committed to the repository. |
171
+ | Push protection | ✅ On | Blocks pushes that contain credentials. |
172
+ | Private vulnerability reporting | ✅ On | Lets anyone report a vulnerability privately. See [Reporting Vulnerabilities](#reporting-vulnerabilities). |
199
173
 
200
174
  ### Reporting Vulnerabilities
201
175
 
@@ -205,7 +179,10 @@ Please do not open public GitHub issues for security vulnerabilities. Use [GitHu
205
179
 
206
180
  [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/dpuse/dpuse-development/badge)](https://scorecard.dev/viewer/?uri=github.com/dpuse/dpuse-development)
207
181
 
208
- 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-development) 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.
182
+ 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.
183
+
184
+ > [!NOTE]
185
+ > 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.
209
186
 
210
187
  ## Contributing
211
188
 
package/SECURITY.md ADDED
@@ -0,0 +1,22 @@
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ Only the latest released version of this package is actively maintained and receives security fixes.
6
+
7
+ ## Reporting a Vulnerability
8
+
9
+ Please do not report security vulnerabilities through public GitHub issues.
10
+
11
+ Instead, use one of the following:
12
+
13
+ - [Report a vulnerability](https://github.com/dpuse/dpuse-development/security/advisories/new) via GitHub private vulnerability reporting
14
+ - Email [terrell.jm@gmail.com](mailto:terrell.jm@gmail.com) with the subject line `[SECURITY] dpuse-development`
15
+
16
+ Include:
17
+
18
+ - A description of the vulnerability and its potential impact
19
+ - Steps to reproduce or a proof-of-concept
20
+ - Any suggested remediation if known
21
+
22
+ You can expect an acknowledgement within **7 days** and a resolution or status update within **30 days**.