@dpuse/dpuse-tool-streamparser-json-parser 0.0.0-stage → 1.0.1
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/LICENSE +21 -0
- package/README.md +173 -2
- package/dist/dpuse-tool-streamparser-json-parser.es.js +2262 -0
- package/dist/dpuse-tool-streamparser-json-parser.es.js.map +1 -0
- package/dist/shipped-packages.json +8 -0
- package/dist/types/src/index.d.ts +24 -0
- package/dist/types/src/itemRecords.d.ts +19 -0
- package/dist/types/src/structureWalker.d.ts +51 -0
- package/package.json +79 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jonathan Terrell
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,174 @@
|
|
|
1
|
-
#
|
|
1
|
+
# DPUse Streamparser JSON Parser Tool
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<!-- OPENING_START -->
|
|
4
|
+
|
|
5
|
+
[](./LICENSE)
|
|
6
|
+
[](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/releases/latest)
|
|
7
|
+
[](https://www.npmjs.com/package/@dpuse/dpuse-tool-streamparser-json-parser)
|
|
8
|
+
[](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/actions/workflows/ci.yml)
|
|
9
|
+
|
|
10
|
+
Reads JSON and JSON Lines as a stream, and maps their structure for browsing and choosing tables.
|
|
11
|
+
|
|
12
|
+
[Report a Vulnerability](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/security/advisories/new) · [Open an Issue](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/issues)
|
|
13
|
+
|
|
14
|
+
## About DPUse
|
|
15
|
+
|
|
16
|
+
[DPUse](https://www.dpuse.app) (Data Positioning & Use) is an in-browser application that positions your data for use through three core activities: sourcing, contextualising, and publishing.
|
|
17
|
+
|
|
18
|
+
**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.
|
|
19
|
+
|
|
20
|
+
**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.
|
|
21
|
+
|
|
22
|
+
**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.
|
|
23
|
+
|
|
24
|
+
In addition, DPUse provides [Tools](https://www.dpuse.app) used by the application, and you can use them to construct connectors and presenters.
|
|
25
|
+
|
|
26
|
+
## Introduction
|
|
27
|
+
|
|
28
|
+
Reads JSON and JSON Lines as a stream, with constant memory however large the item. Maps a JSON item's structure, so a list inside it can be chosen as a table, and lists one level of the structure at a time for browsing.
|
|
29
|
+
|
|
30
|
+
<!-- OPENING_END -->
|
|
31
|
+
|
|
32
|
+
<!-- USAGE_START -->
|
|
33
|
+
|
|
34
|
+
## Usage
|
|
35
|
+
|
|
36
|
+
This [package](https://www.npmjs.com/package/@dpuse/dpuse-tool-streamparser-json-parser) is available on [npm](https://www.npmjs.com/). Install it with:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install @dpuse/dpuse-tool-streamparser-json-parser
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
To work on the source instead, clone this repository.
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
git clone https://github.com/dpuse/dpuse-tool-streamparser-json-parser.git
|
|
46
|
+
cd dpuse-tool-streamparser-json-parser
|
|
47
|
+
npm install
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
_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._
|
|
51
|
+
|
|
52
|
+
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-tool-streamparser-json-parser/blob/main/package.json) for details.
|
|
53
|
+
|
|
54
|
+
<!-- USAGE_END -->
|
|
55
|
+
|
|
56
|
+
<!-- DEPENDENCY_LICENSES_START -->
|
|
57
|
+
|
|
58
|
+
## Dependency Licenses
|
|
59
|
+
|
|
60
|
+
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.
|
|
61
|
+
|
|
62
|
+
| Dependency | Version | License(s) | Document |
|
|
63
|
+
| :-------------------------------------------------------------------- | :-----: | :--------- | :-------------------------------------------------------------------- |
|
|
64
|
+
| [@dpuse/dpuse-shared](https://github.com/dpuse/dpuse-shared) | 1.0.214 | MIT | [LICENSE](licenses/downloads/@dpuse/dpuse-shared@1.0.214-LICENSE.txt) |
|
|
65
|
+
| [@streamparser/json](https://github.com/juanjoDiaz/streamparser-json) | 0.0.26 | MIT | [LICENSE](licenses/downloads/@streamparser/json@0.0.26-LICENSE.txt) |
|
|
66
|
+
| [valibot](https://github.com/open-circle/valibot) | 1.5.0 | MIT | [LICENSE](licenses/downloads/valibot@1.5.0-LICENSE.txt) |
|
|
67
|
+
|
|
68
|
+
### Dependency Tree
|
|
69
|
+
|
|
70
|
+
The dependency tree below shows how each package in the table above is reached — direct and transitive — along with its installed version, release date, and update status. A package that does not ship itself, such as one whose parts are bundled separately, is left out and what ships beneath it is shown in its place. Packages flagged ❗ have a newer version available; ⚠️ indicates a package that hasn't been updated in the last 6 months or longer. Neither flag necessarily indicates a problem: we let new releases stabilise before upgrading, and some packages are mature and stable (have limited or no dependencies), so they require no active development.
|
|
71
|
+
|
|
72
|
+
- **[@dpuse/dpuse-shared](https://github.com/dpuse/dpuse-shared)** 1.0.214 — this month: 2026-11-12
|
|
73
|
+
- **[valibot](https://github.com/open-circle/valibot)** 1.5.0 — 2 mths ago: 2026-09-09
|
|
74
|
+
- **[@streamparser/json](https://github.com/juanjoDiaz/streamparser-json)** 0.0.26 — 2 mths ago: 2026-08-21
|
|
75
|
+
|
|
76
|
+
<!-- DEPENDENCY_LICENSES_END -->
|
|
77
|
+
|
|
78
|
+
<!-- BUNDLE_START -->
|
|
79
|
+
|
|
80
|
+
## Bundle Analysis
|
|
81
|
+
|
|
82
|
+
This report is updated with each release, from the bundle the release builds, 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.
|
|
83
|
+
|
|
84
|
+
_Note: Sonda's Vite reports currently exclude CSS files, since Vite does not generate source maps for CSS._
|
|
85
|
+
|
|
86
|
+
| Chunk/Module/File | Composition |
|
|
87
|
+
| :--------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------- |
|
|
88
|
+
| **dist/dpuse-tool-streamparser-json-parser.es.js** | 61.3 kB · gzip 13.8 kB · 100.0% of the build |
|
|
89
|
+
| @dpuse/dpuse-shared → dist/dpuse-shared.es.js | `███████░░░░░░░░░░░░░` 34.5% · 21.2 kB |
|
|
90
|
+
| @streamparser/json → dist/mjs/tokenizer.js + 5 more | `███████░░░░░░░░░░░░░` 33.6% · 20.6 kB |
|
|
91
|
+
| ↳ dist/mjs/tokenizer.js | `▒▒▒▒░░░░░░░░░░░░░░░░` 21.7% · 13.3 kB |
|
|
92
|
+
| ↳ dist/mjs/utils/utf-8.js | `▒▒░░░░░░░░░░░░░░░░░░` 8.1% · 5.0 kB |
|
|
93
|
+
| ↳ dist/mjs/utils/bufferedString.js | `▒░░░░░░░░░░░░░░░░░░░` 2.6% · 1.6 kB |
|
|
94
|
+
| ↳ 3 smaller files | `░░░░░░░░░░░░░░░░░░░░` 1.2% · 726 B |
|
|
95
|
+
| src → index.ts + 2 more | `████░░░░░░░░░░░░░░░░` 21.1% · 12.9 kB |
|
|
96
|
+
| ↳ index.ts | `▒▒░░░░░░░░░░░░░░░░░░` 10.7% · 6.6 kB |
|
|
97
|
+
| ↳ structureWalker.ts | `▒░░░░░░░░░░░░░░░░░░░` 6.8% · 4.2 kB |
|
|
98
|
+
| ↳ itemRecords.ts | `▒░░░░░░░░░░░░░░░░░░░` 3.6% · 2.2 kB |
|
|
99
|
+
| (bundler output, whitespace & JSON) | `██░░░░░░░░░░░░░░░░░░` 10.7% · 6.6 kB |
|
|
100
|
+
|
|
101
|
+
Bars show each row's share of its output file. ↳ rows are part of the row above.
|
|
102
|
+
|
|
103
|
+
- n more = the row also holds n more files from the same package or folder, each no larger than the one named. A package can appear under several output files, each holding different files, never the same file twice.
|
|
104
|
+
|
|
105
|
+
(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.
|
|
106
|
+
|
|
107
|
+
<!-- BUNDLE_END -->
|
|
108
|
+
|
|
109
|
+
<!-- QUALITY_SECURITY_START -->
|
|
110
|
+
|
|
111
|
+
## Quality & Security
|
|
112
|
+
|
|
113
|
+
This section is updated each time `npm run document` is run. Settings come from the repository's workflow files and GitHub. Test coverage and the Fallow score are measured at the same time.
|
|
114
|
+
|
|
115
|
+
### Testing
|
|
116
|
+
|
|
117
|
+
| Check | Status | What it does |
|
|
118
|
+
| :------------------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
119
|
+
| Unit tests | ✅ On | [Vitest](https://vitest.dev) runs the unit tests. Part of the [CI workflow](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
120
|
+
| Property-based tests | ❌ Off | [fast-check](https://fast-check.dev) runs many random inputs per test to find edge cases, alongside the unit tests. |
|
|
121
|
+
| Test coverage | ✅ On |  [Vitest's V8 coverage](https://vitest.dev/guide/coverage) measures the share of source lines the unit tests run. The target is 80%. |
|
|
122
|
+
|
|
123
|
+
### Code Quality
|
|
124
|
+
|
|
125
|
+
| Check | Status | What it does |
|
|
126
|
+
| :------------ | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
127
|
+
| Code analysis | ❌ Off | [SonarCloud](https://sonarcloud.io) checks every push for bugs, code smells and vulnerabilities. |
|
|
128
|
+
| Linting | ✅ On | [ESLint](https://eslint.org) checks the code for errors and style problems. Part of the [CI workflow](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
129
|
+
|
|
130
|
+
### Security Analysis
|
|
131
|
+
|
|
132
|
+
| Check | Status | What it does |
|
|
133
|
+
| :-------------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
134
|
+
| 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. |
|
|
135
|
+
| Static analysis | ✅ On | [](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/security/code-scanning) [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. |
|
|
136
|
+
| 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. |
|
|
137
|
+
|
|
138
|
+
### Dependencies
|
|
139
|
+
|
|
140
|
+
| Check | Status | What it does |
|
|
141
|
+
| :------------------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
142
|
+
| 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-tool-streamparser-json-parser/actions/workflows/ci.yml) on every push and pull request to `main`. |
|
|
143
|
+
| Supply chain risk | ✅ On | [Socket](https://socket.dev) flags malicious packages, typosquatting and suspicious behaviour that may not yet have a CVE. |
|
|
144
|
+
| 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. |
|
|
145
|
+
| Security updates | ❌ Off | [Dependabot](https://docs.github.com/en/code-security/dependabot) opens pull requests that update vulnerable dependencies. These are handled manually. |
|
|
146
|
+
| Version updates | ❌ Off | [Dependabot](https://docs.github.com/en/code-security/dependabot) opens pull requests for new dependency versions. These are handled manually. |
|
|
147
|
+
|
|
148
|
+
### OpenSSF 🚧
|
|
149
|
+
|
|
150
|
+
[](https://scorecard.dev/viewer/?uri=github.com/dpuse/dpuse-tool-streamparser-json-parser)
|
|
151
|
+
|
|
152
|
+
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.
|
|
153
|
+
|
|
154
|
+
### Reporting Vulnerabilities
|
|
155
|
+
|
|
156
|
+
Please do not open public GitHub issues for security vulnerabilities. Use [GitHub private vulnerability reporting](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/security/advisories/new) instead. See [SECURITY.md](./SECURITY.md) for the full disclosure policy, contact details, and expected response times.
|
|
157
|
+
|
|
158
|
+
<!-- QUALITY_SECURITY_END -->
|
|
159
|
+
|
|
160
|
+
<!-- CONTRIBUTING_LICENSE_START -->
|
|
161
|
+
|
|
162
|
+
## Contributing
|
|
163
|
+
|
|
164
|
+
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.
|
|
165
|
+
|
|
166
|
+
For security vulnerabilities, see [Reporting Vulnerabilities](#reporting-vulnerabilities). For bugs, inconsistencies, or other feedback, [open a GitHub issue](https://github.com/dpuse/dpuse-tool-streamparser-json-parser/issues) — feedback is read, but responses and fixes are at the maintainer's discretion.
|
|
167
|
+
|
|
168
|
+
## License
|
|
169
|
+
|
|
170
|
+
This project is licensed under the MIT License, permitting free use, modification, and distribution.
|
|
171
|
+
|
|
172
|
+
[MIT](./LICENSE) © 2026 Jonathan Terrell
|
|
173
|
+
|
|
174
|
+
<!-- CONTRIBUTING_LICENSE_END -->
|