@dpuse/dpuse-development 0.3.726 → 0.3.740
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 +64 -42
- package/dist/dpuse-development.es.js +607 -617
- package/dist/dpuse-development.es.js.map +1 -1
- package/dist/types/src/utilities/index.d.ts +6 -0
- package/package.json +7 -2
- package/vite.config.default.ts +1 -1
- package/vite.config.tool.ts +1 -1
- package/vite.config.wasm.ts +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,52 @@
|
|
|
1
1
|
# DPUse Development
|
|
2
2
|
|
|
3
|
+
<!-- OPENING_START -->
|
|
4
|
+
|
|
3
5
|
[](./LICENSE)
|
|
4
|
-
[](https://github.com/dpuse/dpuse-development/releases/latest)
|
|
7
|
+
[](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml)
|
|
5
8
|
[](https://github.com/dpuse/dpuse-development/actions/workflows/codeql.yml)
|
|
6
9
|
[](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development)
|
|
7
|
-
[](https://github.com/dpuse/dpuse-development/actions/workflows/ci.yml)
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
[Documentation](https://www.dpuse.app) · [Report a Vulnerability](https://github.com/dpuse/dpuse-development/security/advisories/new) · [Open an Issue](https://github.com/dpuse/dpuse-development/issues)
|
|
12
|
+
|
|
13
|
+
## About DPUse
|
|
14
|
+
|
|
15
|
+
DPUse (Data Positioning & Use) is an in-browser application that positions your data for use through three core activities: sourcing, contextualising, and publishing.
|
|
16
|
+
|
|
17
|
+
**Sourcing** uses a library of [Connectors](https://www.dpuse.app/connectors) to establish [Connections](https://www.dpuse.app) to applications, databases, file stores, and curated datasets; these connections are subsequently used to configure structured [Data Views](https://www.dpuse.app) from the underlying sources.
|
|
18
|
+
|
|
19
|
+
**Contextualising** extracts chronological events from those [Data Views](https://www.dpuse.app) and maps them into comprehensive [Context Models](https://www.dpuse.app). This gives the DPUse Engine the structural framework needed to generate deterministic transactions, facts, or observations.
|
|
20
|
+
|
|
21
|
+
**Publishing** uses a library of [Presenters](https://www.dpuse.app) to render standard [Presentations](https://www.dpuse.app) immediately using the contextualised data; additionally, [Cookbooks](https://www.dpuse.app) of [Recipes](https://www.dpuse.app) let you build Data Apps using your preferred tools.
|
|
10
22
|
|
|
11
|
-
|
|
23
|
+
In addition, DPUse provides [Tools](https://www.dpuse.app) used by the application, and you can use them to construct connectors and presenters.
|
|
24
|
+
|
|
25
|
+
## Introduction
|
|
12
26
|
|
|
13
27
|
Actions for managing DPUse projects.
|
|
14
28
|
|
|
15
|
-
<!--
|
|
29
|
+
<!-- OPENING_END -->
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
<!-- USAGE_START -->
|
|
34
|
+
|
|
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.
|
|
36
|
+
|
|
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.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
git clone https://github.com/dpuse/dpuse-development.git
|
|
41
|
+
cd dpuse-development
|
|
42
|
+
npm install
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
_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._
|
|
16
46
|
|
|
17
|
-
|
|
47
|
+
<!-- USAGE_END -->
|
|
48
|
+
|
|
49
|
+
### OLD Installation
|
|
18
50
|
|
|
19
51
|
> [!WARNING]
|
|
20
52
|
> This project is currently published to npm, but is not designed for general use. It is custom built for the DPUse CI/CD process. You are welcome to clone and customise it for your own purposes, but you will need to adapt it to your own project structure and tooling.
|
|
@@ -71,58 +103,44 @@ All utilities are designed to be run from `package.json` scripts and assume that
|
|
|
71
103
|
|
|
72
104
|
Please see other DPUse repositories for actual usage.
|
|
73
105
|
|
|
74
|
-
## Dependency Licenses
|
|
75
|
-
|
|
76
106
|
<!-- DEPENDENCY_LICENSES_START -->
|
|
77
|
-
> [!WARNING]
|
|
78
|
-
> Dependency licenses are not documented here: @dpuse/dpuse-development is a development-only tool and is never part of a production release
|
|
79
|
-
<!-- DEPENDENCY_LICENSES_END -->
|
|
80
107
|
|
|
81
|
-
|
|
108
|
+
## Dependency Licenses
|
|
82
109
|
|
|
83
|
-
<!-- DEPENDENCY_TREE_START -->
|
|
84
110
|
> [!WARNING]
|
|
85
|
-
> Dependency licenses are not documented here: @dpuse/dpuse-development is a development-only tool and is never part of a production release
|
|
86
|
-
<!-- DEPENDENCY_TREE_END -->
|
|
87
|
-
|
|
88
|
-
## Bundle Analysis
|
|
111
|
+
> Dependency licenses are not documented here: @dpuse/dpuse-development is a development-only tool and is never part of a production release.
|
|
89
112
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
- **[rollup-plugin-visualizer](https://github.com/btd/rollup-plugin-visualizer/tree/master)** — generates a static treemap/sunburst view based on pre-build module estimates, useful for a quick visual scan of overall bundle composition, including CSS assets.
|
|
93
|
-
- **[Sonda](https://sonda.dev/)** — analyses final source maps to capture the effects of tree-shaking and minification, rather than relying on pre-build estimates. This gives a more accurate picture of what's actually shipped, traces module-level dependencies, and shows the size of each module after tree-shaking and minification for more precise insight into what's driving bundle size. Note: Sonda's Vite reports currently exclude CSS files, since Vite does not generate source maps for CSS.
|
|
94
|
-
|
|
95
|
-
[View the rollup-plugin-visualizer Report](https://dpuse.github.io/dpuse-connector-file-store-emulator/bundle-analysis-reports/rollup-visualiser/index.html).
|
|
96
|
-
|
|
97
|
-
[View the Sonda Report](https://dpuse.github.io/dpuse-connector-file-store-emulator/bundle-analysis-reports/sonda/index.html).
|
|
113
|
+
<!-- DEPENDENCY_LICENSES_END -->
|
|
98
114
|
|
|
99
115
|
<!-- BUNDLE_START -->
|
|
100
116
|
|
|
117
|
+
## Bundle Analysis
|
|
118
|
+
|
|
101
119
|
The Bundle Analysis Report is generated automatically on each release using [Sonda](https://sonda.dev/), which analyses final source maps to reveal the actual effects of tree-shaking and minification rather than relying on pre-build estimates.
|
|
102
120
|
|
|
103
121
|
_Note: Sonda's Vite reports currently exclude CSS files, since Vite does not generate source maps for CSS._
|
|
104
122
|
|
|
105
123
|
|Chunk/Module/File|Composition|
|
|
106
124
|
|:------ |:-----------|
|
|
107
|
-
| dist/dpuse-development.es.js |
|
|
108
|
-
| acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 41.
|
|
109
|
-
| acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 36.
|
|
110
|
-
| src | `██░░░░░░░░░░░░░░░░░░` 10.
|
|
111
|
-
| manageProject.ts | `░░░░░░░░░░░░░░░░░░░░` 1.8% |
|
|
125
|
+
| dist/dpuse-development.es.js | 312.7 kB · gzip 79.7 kB |
|
|
126
|
+
| acorn → dist/acorn.mjs | `████████░░░░░░░░░░░░` 41.8% |
|
|
127
|
+
| acorn-typescript → lib/index.mjs | `███████░░░░░░░░░░░░░` 36.6% |
|
|
128
|
+
| src | `██░░░░░░░░░░░░░░░░░░` 10.6% |
|
|
112
129
|
| documentDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 1.8% |
|
|
113
|
-
|
|
|
114
|
-
|
|
|
130
|
+
| manageProject.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
|
|
131
|
+
| index.ts | `░░░░░░░░░░░░░░░░░░░░` 1.7% |
|
|
132
|
+
| documentBundleSizes.ts | `░░░░░░░░░░░░░░░░░░░░` 1.4% |
|
|
115
133
|
| checkConfigFiles.ts | `░░░░░░░░░░░░░░░░░░░░` 0.9% |
|
|
116
|
-
| documentGovernance.ts | `░░░░░░░░░░░░░░░░░░░░` 0.
|
|
134
|
+
| documentGovernance.ts | `░░░░░░░░░░░░░░░░░░░░` 0.6% |
|
|
117
135
|
| documentActions.ts | `░░░░░░░░░░░░░░░░░░░░` 0.6% |
|
|
118
|
-
| documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
|
|
119
136
|
| cloudflare.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
|
|
120
137
|
| checkDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.5% |
|
|
121
138
|
| documentUsage.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
|
|
139
|
+
| documentOpening.ts | `░░░░░░░░░░░░░░░░░░░░` 0.4% |
|
|
122
140
|
| formatCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
123
141
|
| auditDependencies.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
124
142
|
| lintCode.ts | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
125
|
-
| (
|
|
143
|
+
| (bundler output, whitespace & JSON) | `█░░░░░░░░░░░░░░░░░░░` 7.2% |
|
|
126
144
|
| @dpuse/dpuse-shared | `█░░░░░░░░░░░░░░░░░░░` 3.6% |
|
|
127
145
|
| dist/componentConfig.schema-DT3mO5rS.js | `█░░░░░░░░░░░░░░░░░░░` 2.7% |
|
|
128
146
|
| dist/dpuse-shared-componentModuleConnector.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.7% |
|
|
@@ -130,10 +148,12 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
|
|
|
130
148
|
| dist/dpuse-shared-componentModulePresenter.es.js | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
131
149
|
| valibot → dist/index.mjs | `░░░░░░░░░░░░░░░░░░░░` 0.1% |
|
|
132
150
|
|
|
133
|
-
(
|
|
151
|
+
(bundler output, whitespace & JSON) = bytes Sonda can't trace to a source file: whitespace (indentation and line breaks), code the bundler generates (region comments, the combined import/export lines, its small runtime helper and wrappers), and imported JSON such as `config.json`, which the bundler doesn't map. The JSON and the generated code are real bytes that ship; the whitespace mostly disappears once compressed.
|
|
134
152
|
|
|
135
153
|
<!-- BUNDLE_END -->
|
|
136
154
|
|
|
155
|
+
<!-- GOVERNANCE_START -->
|
|
156
|
+
|
|
137
157
|
## Security & Quality
|
|
138
158
|
|
|
139
159
|
### CodeQL
|
|
@@ -142,14 +162,14 @@ _Note: Sonda's Vite reports currently exclude CSS files, since Vite does not gen
|
|
|
142
162
|
|
|
143
163
|
### SonarCloud
|
|
144
164
|
|
|
145
|
-
[SonarCloud](https://sonarcloud.io/summary/new_code?id=
|
|
165
|
+
[SonarCloud](https://sonarcloud.io/summary/new_code?id=dpuse_dpuse-development) performs continuous code quality and security analysis on every push, detecting bugs, code smells, and security vulnerabilities in the TypeScript source.
|
|
146
166
|
|
|
147
167
|
### Vulnerability Scanning
|
|
148
168
|
|
|
149
169
|
Two complementary tools continuously monitor dependencies for known vulnerabilities:
|
|
150
170
|
|
|
151
|
-
-
|
|
152
|
-
-
|
|
171
|
+
- [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.
|
|
172
|
+
- [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.
|
|
153
173
|
|
|
154
174
|
### Supply Chain Security
|
|
155
175
|
|
|
@@ -163,16 +183,18 @@ Please do not open public GitHub issues for security vulnerabilities. Use [GitHu
|
|
|
163
183
|
|
|
164
184
|
[](https://scorecard.dev/viewer/?uri=github.com/dpuse/dpuse-development)
|
|
165
185
|
|
|
166
|
-
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.
|
|
186
|
+
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.
|
|
167
187
|
|
|
168
188
|
## Contributing
|
|
169
189
|
|
|
170
|
-
This repository is maintained solely by its owner and does not accept external contributions.
|
|
190
|
+
This repository is maintained solely by its owner and does not, at present, accept external contributions into the canonical repo. Its source is published openly under the MIT License — every DPUse project is fully open source except DPUse Engine, which remains closed and proprietary.
|
|
171
191
|
|
|
172
|
-
|
|
192
|
+
For security vulnerabilities, see [Reporting Vulnerabilities](#reporting-vulnerabilities). For bugs, inconsistencies, or other feedback, [open a GitHub issue](https://github.com/dpuse/dpuse-development/issues) — feedback is read, but responses and fixes are at the maintainer's discretion.
|
|
173
193
|
|
|
174
194
|
## License
|
|
175
195
|
|
|
176
196
|
This project is licensed under the MIT License, permitting free use, modification, and distribution.
|
|
177
197
|
|
|
178
198
|
[MIT](./LICENSE) © 2026-present Jonathan Terrell
|
|
199
|
+
|
|
200
|
+
<!-- GOVERNANCE_END -->
|