Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 zemion
|
a8eb8e53b3 |
@@ -0,0 +1,39 @@
|
||||
name: Verify
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: verify-${{ gitea.repository }}-${{ gitea.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
verify:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 45
|
||||
env:
|
||||
CI: "true"
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "22"
|
||||
cache: npm
|
||||
- name: Select declared npm version
|
||||
run: npm install --global npm@11.17.0
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Audit runtime dependencies
|
||||
run: npm audit --omit=dev --audit-level=moderate
|
||||
- name: Check, test, and build
|
||||
run: npm run check
|
||||
- name: Install browser engines
|
||||
run: npx playwright install --with-deps chromium firefox webkit
|
||||
- name: Browser tests
|
||||
run: npm run test:browser
|
||||
@@ -1,5 +1,19 @@
|
||||
# Changelog
|
||||
|
||||
## 0.2.0 - 2026-09-02
|
||||
|
||||
- Adopted `@add-ideas/toolbox-helpers` 0.2.0 for deterministic byte-size
|
||||
display, safe downloads and the cancellable worker-job/progress/deadline
|
||||
protocol.
|
||||
- Kept domain-specific structured-data parsing and diagnostics inside Data
|
||||
Tools while removing its duplicate worker lifecycle implementation.
|
||||
- Added explicit modular import/export adapter registries for every supported
|
||||
structured-data format.
|
||||
- Added bounded sample-based JSON Schema inference with field presence,
|
||||
nullability and exact numeric-representation evidence.
|
||||
- Added immutable RFC 6901 structural edits with a reviewed source-format
|
||||
preview and mandatory acknowledgement of known serialization loss.
|
||||
|
||||
## 0.1.0 - 2026-09-01
|
||||
|
||||
- Added exact-number JSON, YAML 1.2, TOML, hardened XML, CSV, TSV and NDJSON parsing.
|
||||
|
||||
@@ -2,15 +2,20 @@
|
||||
|
||||
Inspect, format, query, flatten and convert structured data locally in the browser. Data Tools is a standalone application in the [add·ideas Toolbox](https://git.add-ideas.de/lotobo/toolbox-portal); input text and files never leave the current browser.
|
||||
|
||||
## Version 0.1.0
|
||||
## Version 0.2.0
|
||||
|
||||
- Detect or explicitly select JSON, YAML 1.2, TOML, XML, CSV, TSV and NDJSON.
|
||||
- Keep JSON integer and decimal lexemes exact, including values beyond IEEE-754 range.
|
||||
- Inspect a bounded typed tree, a tabular projection and flattened scalar leaves.
|
||||
- Query with RFC 6901 JSON Pointer or a deliberately small, non-evaluating path subset.
|
||||
- Infer a bounded, sample-labelled JSON Schema with field presence, nullability, mixed types and exact-number provenance.
|
||||
- Preview immutable RFC 6901 add/replace/remove edits, inspect the source-format serialization disclosure, and explicitly accept any loss before applying it.
|
||||
- Format and convert between every supported output with a visible loss/coercion report.
|
||||
- Drive import, export and format selectors from one ordered adapter catalogue with a concrete parser and writer registry for every advertised format.
|
||||
- Export CSV/TSV with opt-in spreadsheet formula neutralisation, enabled by default.
|
||||
- Open UTF-8 files or edit text directly; parsing runs in a disposable module worker and the previous valid result remains visible while a replacement is analysed.
|
||||
- Open UTF-8 files or edit text directly; parsing runs through the shared
|
||||
cancellable disposable-worker protocol with a hard deadline, while the
|
||||
previous valid result remains visible until a replacement is ready.
|
||||
|
||||
### Format semantics
|
||||
|
||||
@@ -27,7 +32,7 @@ The safe path subset supports `$`, `.key`, `['key']`, `[index]` and `[*]`. It in
|
||||
|
||||
### Resource limits
|
||||
|
||||
The current production limits are 16 MiB of UTF-8 input, 8 million JavaScript characters, 100,000 model nodes, depth 128, 50,000 delimited rows, 2,000 columns, 250,000 cells, 1 million characters per field, 4,096 query characters, 1,000 query matches and 16 million generated characters. Disposable parses have a 30-second deadline. UI previews are smaller than the model and state when they are truncated.
|
||||
The current production limits are 16 MiB of UTF-8 input, 8 million JavaScript characters, 100,000 model nodes, depth 128, 50,000 delimited rows, 2,000 columns, 250,000 cells, 1 million characters per field/edit value, 5,000 inference samples/fields, 4,096 query or edit-pointer characters, 1,000 query matches and 16 million generated characters. Disposable parses have a 30-second deadline. UI previews are smaller than the model and state when they are truncated.
|
||||
|
||||
See [Architecture](docs/ARCHITECTURE.md), [Privacy and security](docs/PRIVACY-SECURITY.md) and [Accessibility](docs/ACCESSIBILITY.md) for the design and threat model.
|
||||
|
||||
@@ -43,7 +48,7 @@ npm run test:browser
|
||||
|
||||
## Release
|
||||
|
||||
`npm run release:artifact` creates a deterministic `release/data-tools-0.1.0.zip` and checksum sidecar.
|
||||
`npm run release:artifact` creates a deterministic `release/data-tools-0.2.0.zip` and checksum sidecar.
|
||||
|
||||
## Licence
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Corresponding source
|
||||
|
||||
The corresponding source for Data Tools 0.1.0 is available at:
|
||||
The corresponding source for Data Tools 0.2.0 is available at:
|
||||
|
||||
https://git.add-ideas.de/lotobo/data-tools/src/tag/v0.1.0
|
||||
https://git.add-ideas.de/lotobo/data-tools/src/tag/v0.2.0
|
||||
|
||||
Build with Node.js 22, npm 11, `npm ci`, and `npm run release:artifact`.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Data Tools is GPL-3.0-or-later. Runtime dependencies retain their own licences:
|
||||
|
||||
- add·ideas Toolbox contract and React shell 0.2.3 — Apache-2.0
|
||||
- add·ideas Toolbox contract and React shell 0.3.0 — Apache-2.0
|
||||
- React and React DOM 19.2.8 — MIT
|
||||
- lossless-json 4.3.1 — MIT
|
||||
- yaml 2.9.0 — ISC
|
||||
|
||||
+21
-4
@@ -6,9 +6,13 @@ Data Tools is a relocatable static React application. There is no application se
|
||||
|
||||
1. The UI checks the local file size before decoding and passes text, the selected format and the optional filename to a fresh module worker.
|
||||
2. The worker applies byte/character and structural preflight limits, including a streaming dimension pass before delimited parsing, then parses with format-specific defensive options and converts the result into a serialisable typed node model.
|
||||
3. The model is measured again for node count and depth before it is returned. A newer request terminates the older worker, and a 30-second deadline terminates a stalled parse. The UI retains the last successful model until a new one is ready.
|
||||
3. The model is measured again for node count and depth before it is returned.
|
||||
The shared worker-job protocol filters results by job ID, terminates a
|
||||
superseded worker and enforces a 30-second hard deadline. The UI retains the
|
||||
last successful model until a new one is ready.
|
||||
4. Tree, table, flattened and query projections operate on the model with their own preview/result caps.
|
||||
5. Serialisers create a new string and a structured list of notices, coercions and losses. Output is capped before it reaches copy or download actions.
|
||||
6. Schema inference samples the same bounded model. Structural edits clone only the addressed path, remeasure the result, then serialize it through the source adapter for review before source replacement.
|
||||
|
||||
The node model has explicit null, boolean, string, number, date, array and ordered-object variants. Number nodes retain a source representation (`exact`, `bigint` or `binary`) and an exact display lexeme. Objects use ordered entry arrays rather than assigning untrusted keys to ordinary JavaScript objects.
|
||||
|
||||
@@ -18,6 +22,19 @@ XML deliberately does not pretend to be a JSON object. It is represented as expl
|
||||
|
||||
Runtime versions are pinned exactly: `lossless-json` 4.3.1, `yaml` 2.9.0, `smol-toml` 1.8.0, `@xmldom/xmldom` 0.9.12 and `papaparse` 5.7.0. No imported value is rendered as HTML or executed.
|
||||
|
||||
Version 0.1 keeps its bounded data-model functions as pure app modules rather
|
||||
than introducing a runtime helper dependency. They are intentionally shaped
|
||||
for later replacement by the shared limits and download APIs.
|
||||
Bounded data-model and parser functions remain pure app modules because exact
|
||||
scalar spelling and XML namespace metadata are domain decisions. Generic
|
||||
byte-size display, safe downloads and cancellable worker lifecycle come from
|
||||
`@add-ideas/toolbox-helpers` 0.2.0.
|
||||
|
||||
`src/core/adapters.ts` is the public ordered capability catalogue. `parse.ts`
|
||||
and `convert.ts` expose concrete registries that must cover every descriptor;
|
||||
tests make missing import/export implementations fail visibly. `schema.ts`
|
||||
never turns exact decimal lexemes into binary range constraints. `edit.ts`
|
||||
implements immutable RFC 6901 traversal and rejects prototype-affecting keys,
|
||||
non-canonical array indices and any result outside the normal model ceilings.
|
||||
|
||||
An edit is not applied immediately: it is first passed through the current
|
||||
format's export adapter. The UI shows the proposed source and all conversion
|
||||
events, and requires a separate acknowledgement when any event is classified
|
||||
as loss.
|
||||
|
||||
@@ -15,6 +15,8 @@ Input files are read with the browser File API and decoded as UTF-8. Text is cop
|
||||
- XML rejects `DOCTYPE`, entity declarations and XInclude before parsing. The parser is not used to load external resources, and imported markup is never inserted into the DOM.
|
||||
- CSV/TSV dynamic typing is disabled. Spreadsheet-safe export prefixes cells beginning with `=`, `+`, `-`, `@`, tab or carriage return; disabling it produces a warning in the conversion report.
|
||||
- The safe query language has no evaluator, functions, filters, recursive descent or scripts.
|
||||
- Schema inference is capped by sampled nodes/fields and is labelled as inference, not validation.
|
||||
- Structural edits use strict JSON Pointer traversal, reject prototype-affecting keys, and cannot bypass the parsed-node/depth ceilings. Lossy source serialization requires a separate acknowledgement.
|
||||
|
||||
Conversion is not sanitisation. XML-to-object conventions, typed-scalar coercions, nested CSV cell encoding, TOML null handling and unsafe numeric conversions are reported alongside the generated result. Users should inspect that report before relying on converted output.
|
||||
|
||||
|
||||
Generated
+24
-16
@@ -1,16 +1,17 @@
|
||||
{
|
||||
"name": "data-tools",
|
||||
"version": "0.1.0",
|
||||
"version": "0.2.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "data-tools",
|
||||
"version": "0.1.0",
|
||||
"version": "0.2.0",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"dependencies": {
|
||||
"@add-ideas/toolbox-contract": "0.2.3",
|
||||
"@add-ideas/toolbox-shell-react": "0.2.3",
|
||||
"@add-ideas/toolbox-contract": "0.3.0",
|
||||
"@add-ideas/toolbox-helpers": "0.2.0",
|
||||
"@add-ideas/toolbox-shell-react": "0.3.0",
|
||||
"@xmldom/xmldom": "0.9.12",
|
||||
"lossless-json": "4.3.1",
|
||||
"papaparse": "5.7.0",
|
||||
@@ -20,7 +21,7 @@
|
||||
"yaml": "2.9.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@add-ideas/toolbox-testkit": "0.2.3",
|
||||
"@add-ideas/toolbox-testkit": "0.3.0",
|
||||
"@eslint/js": "10.0.1",
|
||||
"@playwright/test": "1.62.1",
|
||||
"@testing-library/jest-dom": "6.9.1",
|
||||
@@ -47,18 +48,25 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@add-ideas/toolbox-contract": {
|
||||
"version": "0.2.3",
|
||||
"resolved": "https://git.add-ideas.de/api/packages/lotobo/npm/%40add-ideas%2Ftoolbox-contract/-/0.2.3/toolbox-contract-0.2.3.tgz",
|
||||
"integrity": "sha512-T0PVSuMT40GjTDfQJhEEY3ZawQq8zz1/ry95JdKI6W39CdLacaRXdGnEpDCMHt+jUbf1Jz7Nat/M5dFCgKVM9A==",
|
||||
"version": "0.3.0",
|
||||
"resolved": "https://git.add-ideas.de/api/packages/lotobo/npm/%40add-ideas%2Ftoolbox-contract/-/0.3.0/toolbox-contract-0.3.0.tgz",
|
||||
"integrity": "sha512-dKrK7BjOFwqJaBfJuhKxZKIld4sH0AKjEn6a0yLnbdMUFY+fFv4VSLGV2tNSBD016gumc2iNqOjUj/ld7x4rtA==",
|
||||
"license": "Apache-2.0"
|
||||
},
|
||||
"node_modules/@add-ideas/toolbox-helpers": {
|
||||
"version": "0.2.0",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"engines": {
|
||||
"node": ">=22"
|
||||
}
|
||||
},
|
||||
"node_modules/@add-ideas/toolbox-shell-react": {
|
||||
"version": "0.2.3",
|
||||
"resolved": "https://git.add-ideas.de/api/packages/lotobo/npm/%40add-ideas%2Ftoolbox-shell-react/-/0.2.3/toolbox-shell-react-0.2.3.tgz",
|
||||
"integrity": "sha512-DT5lQDH48BFkFcmFLZnQh7+Cm73JzBPcmp5WzUXypfkUXpEyDYHzaXgmW4kZ0edSwh4RK4sPmx+JPtK0X4aKCQ==",
|
||||
"version": "0.3.0",
|
||||
"resolved": "https://git.add-ideas.de/api/packages/lotobo/npm/%40add-ideas%2Ftoolbox-shell-react/-/0.3.0/toolbox-shell-react-0.3.0.tgz",
|
||||
"integrity": "sha512-74p6JzAOG0YCAKdlc1hLofV4ZIko7vb448S75cIiM88PKm93EHl5VD7g8YVyfM56Ui97UY9dmy+Whiq4sGzpsg==",
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {
|
||||
"@add-ideas/toolbox-contract": "0.2.3"
|
||||
"@add-ideas/toolbox-contract": "0.3.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"react": ">=18 <20",
|
||||
@@ -66,13 +74,13 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@add-ideas/toolbox-testkit": {
|
||||
"version": "0.2.3",
|
||||
"resolved": "https://git.add-ideas.de/api/packages/lotobo/npm/%40add-ideas%2Ftoolbox-testkit/-/0.2.3/toolbox-testkit-0.2.3.tgz",
|
||||
"integrity": "sha512-sq1MwhKWfFKen+N+124hl74qQimRSvmQ9sOU7jdcI+2qCKZ67+2B8rWyezeV80uTFu4Jv6deHksfYQ/tKNV6XQ==",
|
||||
"version": "0.3.0",
|
||||
"resolved": "https://git.add-ideas.de/api/packages/lotobo/npm/%40add-ideas%2Ftoolbox-testkit/-/0.3.0/toolbox-testkit-0.3.0.tgz",
|
||||
"integrity": "sha512-4Fk+oSvZFspOMIXr8Xy040nhAaBsIQAzsGyXWSpjn3+k3yBKq7nB1r5zCHhsXzfdLzvPDAx2KcmSNOhM330D9w==",
|
||||
"dev": true,
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {
|
||||
"@add-ideas/toolbox-contract": "0.2.3"
|
||||
"@add-ideas/toolbox-contract": "0.3.0"
|
||||
},
|
||||
"bin": {
|
||||
"toolbox-check": "dist/cli.js"
|
||||
|
||||
+6
-5
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "data-tools",
|
||||
"version": "0.1.0",
|
||||
"description": "Inspect, query and convert structured data locally in the browser.",
|
||||
"version": "0.2.0",
|
||||
"description": "Inspect, infer, edit, query and loss-aware convert structured data locally.",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"author": "Albrecht Degering",
|
||||
"repository": {
|
||||
@@ -39,8 +39,9 @@
|
||||
"release:artifact": "npm run check && npm run test:browser && npm run package:release -- --force"
|
||||
},
|
||||
"dependencies": {
|
||||
"@add-ideas/toolbox-contract": "0.2.3",
|
||||
"@add-ideas/toolbox-shell-react": "0.2.3",
|
||||
"@add-ideas/toolbox-contract": "0.3.0",
|
||||
"@add-ideas/toolbox-helpers": "0.2.0",
|
||||
"@add-ideas/toolbox-shell-react": "0.3.0",
|
||||
"@xmldom/xmldom": "0.9.12",
|
||||
"lossless-json": "4.3.1",
|
||||
"papaparse": "5.7.0",
|
||||
@@ -50,7 +51,7 @@
|
||||
"yaml": "2.9.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@add-ideas/toolbox-testkit": "0.2.3",
|
||||
"@add-ideas/toolbox-testkit": "0.3.0",
|
||||
"@eslint/js": "10.0.1",
|
||||
"@playwright/test": "1.62.1",
|
||||
"@testing-library/jest-dom": "6.9.1",
|
||||
|
||||
+20
-2
@@ -15,7 +15,25 @@ export default defineConfig({
|
||||
timeout: 180_000,
|
||||
},
|
||||
projects: [
|
||||
{ name: "chromium", use: { ...devices["Desktop Chrome"] } },
|
||||
{ name: "firefox", use: { ...devices["Desktop Firefox"] } },
|
||||
{
|
||||
name: "chromium",
|
||||
testIgnore: /responsive\.spec\.ts/,
|
||||
use: { ...devices["Desktop Chrome"] },
|
||||
},
|
||||
{
|
||||
name: "firefox",
|
||||
testIgnore: /responsive\.spec\.ts/,
|
||||
use: { ...devices["Desktop Firefox"] },
|
||||
},
|
||||
{
|
||||
name: "webkit",
|
||||
testIgnore: /responsive\.spec\.ts/,
|
||||
use: { ...devices["Desktop Safari"] },
|
||||
},
|
||||
{
|
||||
name: "mobile-chromium",
|
||||
testMatch: /responsive\.spec\.ts/,
|
||||
use: { ...devices["Pixel 5"] },
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
@@ -1,5 +1,19 @@
|
||||
# Changelog
|
||||
|
||||
## 0.2.0 - 2026-09-02
|
||||
|
||||
- Adopted `@add-ideas/toolbox-helpers` 0.2.0 for deterministic byte-size
|
||||
display, safe downloads and the cancellable worker-job/progress/deadline
|
||||
protocol.
|
||||
- Kept domain-specific structured-data parsing and diagnostics inside Data
|
||||
Tools while removing its duplicate worker lifecycle implementation.
|
||||
- Added explicit modular import/export adapter registries for every supported
|
||||
structured-data format.
|
||||
- Added bounded sample-based JSON Schema inference with field presence,
|
||||
nullability and exact numeric-representation evidence.
|
||||
- Added immutable RFC 6901 structural edits with a reviewed source-format
|
||||
preview and mandatory acknowledgement of known serialization loss.
|
||||
|
||||
## 0.1.0 - 2026-09-01
|
||||
|
||||
- Added exact-number JSON, YAML 1.2, TOML, hardened XML, CSV, TSV and NDJSON parsing.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
==============================================================================
|
||||
@add-ideas/toolbox-contract@0.2.3
|
||||
@add-ideas/toolbox-contract@0.3.0
|
||||
Declared licence: Apache-2.0
|
||||
==============================================================================
|
||||
--- LICENSE ---
|
||||
@@ -198,7 +198,688 @@ Declared licence: Apache-2.0
|
||||
|
||||
|
||||
==============================================================================
|
||||
@add-ideas/toolbox-shell-react@0.2.3
|
||||
@add-ideas/toolbox-helpers@0.2.0
|
||||
Declared licence: GPL-3.0-or-later
|
||||
==============================================================================
|
||||
--- LICENSE ---
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
|
||||
==============================================================================
|
||||
@add-ideas/toolbox-shell-react@0.3.0
|
||||
Declared licence: Apache-2.0
|
||||
==============================================================================
|
||||
--- LICENSE ---
|
||||
|
||||
+9
-4
@@ -2,15 +2,20 @@
|
||||
|
||||
Inspect, format, query, flatten and convert structured data locally in the browser. Data Tools is a standalone application in the [add·ideas Toolbox](https://git.add-ideas.de/lotobo/toolbox-portal); input text and files never leave the current browser.
|
||||
|
||||
## Version 0.1.0
|
||||
## Version 0.2.0
|
||||
|
||||
- Detect or explicitly select JSON, YAML 1.2, TOML, XML, CSV, TSV and NDJSON.
|
||||
- Keep JSON integer and decimal lexemes exact, including values beyond IEEE-754 range.
|
||||
- Inspect a bounded typed tree, a tabular projection and flattened scalar leaves.
|
||||
- Query with RFC 6901 JSON Pointer or a deliberately small, non-evaluating path subset.
|
||||
- Infer a bounded, sample-labelled JSON Schema with field presence, nullability, mixed types and exact-number provenance.
|
||||
- Preview immutable RFC 6901 add/replace/remove edits, inspect the source-format serialization disclosure, and explicitly accept any loss before applying it.
|
||||
- Format and convert between every supported output with a visible loss/coercion report.
|
||||
- Drive import, export and format selectors from one ordered adapter catalogue with a concrete parser and writer registry for every advertised format.
|
||||
- Export CSV/TSV with opt-in spreadsheet formula neutralisation, enabled by default.
|
||||
- Open UTF-8 files or edit text directly; parsing runs in a disposable module worker and the previous valid result remains visible while a replacement is analysed.
|
||||
- Open UTF-8 files or edit text directly; parsing runs through the shared
|
||||
cancellable disposable-worker protocol with a hard deadline, while the
|
||||
previous valid result remains visible until a replacement is ready.
|
||||
|
||||
### Format semantics
|
||||
|
||||
@@ -27,7 +32,7 @@ The safe path subset supports `$`, `.key`, `['key']`, `[index]` and `[*]`. It in
|
||||
|
||||
### Resource limits
|
||||
|
||||
The current production limits are 16 MiB of UTF-8 input, 8 million JavaScript characters, 100,000 model nodes, depth 128, 50,000 delimited rows, 2,000 columns, 250,000 cells, 1 million characters per field, 4,096 query characters, 1,000 query matches and 16 million generated characters. Disposable parses have a 30-second deadline. UI previews are smaller than the model and state when they are truncated.
|
||||
The current production limits are 16 MiB of UTF-8 input, 8 million JavaScript characters, 100,000 model nodes, depth 128, 50,000 delimited rows, 2,000 columns, 250,000 cells, 1 million characters per field/edit value, 5,000 inference samples/fields, 4,096 query or edit-pointer characters, 1,000 query matches and 16 million generated characters. Disposable parses have a 30-second deadline. UI previews are smaller than the model and state when they are truncated.
|
||||
|
||||
See [Architecture](docs/ARCHITECTURE.md), [Privacy and security](docs/PRIVACY-SECURITY.md) and [Accessibility](docs/ACCESSIBILITY.md) for the design and threat model.
|
||||
|
||||
@@ -43,7 +48,7 @@ npm run test:browser
|
||||
|
||||
## Release
|
||||
|
||||
`npm run release:artifact` creates a deterministic `release/data-tools-0.1.0.zip` and checksum sidecar.
|
||||
`npm run release:artifact` creates a deterministic `release/data-tools-0.2.0.zip` and checksum sidecar.
|
||||
|
||||
## Licence
|
||||
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
# Corresponding source
|
||||
|
||||
The corresponding source for Data Tools 0.1.0 is available at:
|
||||
The corresponding source for Data Tools 0.2.0 is available at:
|
||||
|
||||
https://git.add-ideas.de/lotobo/data-tools/src/tag/v0.1.0
|
||||
https://git.add-ideas.de/lotobo/data-tools/src/tag/v0.2.0
|
||||
|
||||
Build with Node.js 22, npm 11, `npm ci`, and `npm run release:artifact`.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Data Tools is GPL-3.0-or-later. Runtime dependencies retain their own licences:
|
||||
|
||||
- add·ideas Toolbox contract and React shell 0.2.3 — Apache-2.0
|
||||
- add·ideas Toolbox contract and React shell 0.3.0 — Apache-2.0
|
||||
- React and React DOM 19.2.8 — MIT
|
||||
- lossless-json 4.3.1 — MIT
|
||||
- yaml 2.9.0 — ISC
|
||||
|
||||
@@ -6,9 +6,13 @@ Data Tools is a relocatable static React application. There is no application se
|
||||
|
||||
1. The UI checks the local file size before decoding and passes text, the selected format and the optional filename to a fresh module worker.
|
||||
2. The worker applies byte/character and structural preflight limits, including a streaming dimension pass before delimited parsing, then parses with format-specific defensive options and converts the result into a serialisable typed node model.
|
||||
3. The model is measured again for node count and depth before it is returned. A newer request terminates the older worker, and a 30-second deadline terminates a stalled parse. The UI retains the last successful model until a new one is ready.
|
||||
3. The model is measured again for node count and depth before it is returned.
|
||||
The shared worker-job protocol filters results by job ID, terminates a
|
||||
superseded worker and enforces a 30-second hard deadline. The UI retains the
|
||||
last successful model until a new one is ready.
|
||||
4. Tree, table, flattened and query projections operate on the model with their own preview/result caps.
|
||||
5. Serialisers create a new string and a structured list of notices, coercions and losses. Output is capped before it reaches copy or download actions.
|
||||
6. Schema inference samples the same bounded model. Structural edits clone only the addressed path, remeasure the result, then serialize it through the source adapter for review before source replacement.
|
||||
|
||||
The node model has explicit null, boolean, string, number, date, array and ordered-object variants. Number nodes retain a source representation (`exact`, `bigint` or `binary`) and an exact display lexeme. Objects use ordered entry arrays rather than assigning untrusted keys to ordinary JavaScript objects.
|
||||
|
||||
@@ -18,6 +22,19 @@ XML deliberately does not pretend to be a JSON object. It is represented as expl
|
||||
|
||||
Runtime versions are pinned exactly: `lossless-json` 4.3.1, `yaml` 2.9.0, `smol-toml` 1.8.0, `@xmldom/xmldom` 0.9.12 and `papaparse` 5.7.0. No imported value is rendered as HTML or executed.
|
||||
|
||||
Version 0.1 keeps its bounded data-model functions as pure app modules rather
|
||||
than introducing a runtime helper dependency. They are intentionally shaped
|
||||
for later replacement by the shared limits and download APIs.
|
||||
Bounded data-model and parser functions remain pure app modules because exact
|
||||
scalar spelling and XML namespace metadata are domain decisions. Generic
|
||||
byte-size display, safe downloads and cancellable worker lifecycle come from
|
||||
`@add-ideas/toolbox-helpers` 0.2.0.
|
||||
|
||||
`src/core/adapters.ts` is the public ordered capability catalogue. `parse.ts`
|
||||
and `convert.ts` expose concrete registries that must cover every descriptor;
|
||||
tests make missing import/export implementations fail visibly. `schema.ts`
|
||||
never turns exact decimal lexemes into binary range constraints. `edit.ts`
|
||||
implements immutable RFC 6901 traversal and rejects prototype-affecting keys,
|
||||
non-canonical array indices and any result outside the normal model ceilings.
|
||||
|
||||
An edit is not applied immediately: it is first passed through the current
|
||||
format's export adapter. The UI shows the proposed source and all conversion
|
||||
events, and requires a separate acknowledgement when any event is classified
|
||||
as loss.
|
||||
|
||||
@@ -15,6 +15,8 @@ Input files are read with the browser File API and decoded as UTF-8. Text is cop
|
||||
- XML rejects `DOCTYPE`, entity declarations and XInclude before parsing. The parser is not used to load external resources, and imported markup is never inserted into the DOM.
|
||||
- CSV/TSV dynamic typing is disabled. Spreadsheet-safe export prefixes cells beginning with `=`, `+`, `-`, `@`, tab or carriage return; disabling it produces a warning in the conversion report.
|
||||
- The safe query language has no evaluator, functions, filters, recursive descent or scripts.
|
||||
- Schema inference is capped by sampled nodes/fields and is labelled as inference, not validation.
|
||||
- Structural edits use strict JSON Pointer traversal, reject prototype-affecting keys, and cannot bypass the parsed-node/depth ceilings. Lossy source serialization requires a separate acknowledgement.
|
||||
|
||||
Conversion is not sanitisation. XML-to-object conventions, typed-scalar coercions, nested CSV cell encoding, TOML null handling and unsafe numeric conversions are reported alongside the generated result. Users should inspect that report before relying on converted output.
|
||||
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
const CACHE_PREFIX = "data-tools-shell-";
|
||||
const CACHE_NAME = CACHE_PREFIX + "0.1.0";
|
||||
const CACHE_NAME = CACHE_PREFIX + "0.2.0";
|
||||
const CORE = ["./", "./manifest.webmanifest", "./favicon.svg"];
|
||||
self.addEventListener("install", (event) => {
|
||||
event.waitUntil(
|
||||
|
||||
+82
-4
@@ -3,12 +3,23 @@
|
||||
"schemaVersion": 1,
|
||||
"id": "de.add-ideas.data-tools",
|
||||
"name": "Data Tools",
|
||||
"version": "0.1.0",
|
||||
"description": "Inspect, query and convert structured data locally in the browser.",
|
||||
"version": "0.2.0",
|
||||
"description": "Inspect, infer, edit, query and loss-aware convert structured data locally.",
|
||||
"entry": "./",
|
||||
"icon": "./favicon.svg",
|
||||
"categories": ["data", "developer", "documents"],
|
||||
"tags": ["json", "yaml", "toml", "xml", "csv", "tsv", "ndjson"],
|
||||
"tags": [
|
||||
"json",
|
||||
"yaml",
|
||||
"toml",
|
||||
"xml",
|
||||
"csv",
|
||||
"tsv",
|
||||
"ndjson",
|
||||
"schema",
|
||||
"convert",
|
||||
"edit"
|
||||
],
|
||||
"integration": {
|
||||
"contextVersion": 1,
|
||||
"launchModes": ["navigate", "new-tab"],
|
||||
@@ -21,9 +32,76 @@
|
||||
"crossOriginIsolated": false,
|
||||
"topLevelContext": false
|
||||
},
|
||||
"io": {
|
||||
"accepts": [
|
||||
{
|
||||
"mediaType": "application/json",
|
||||
"extensions": [".json"],
|
||||
"label": "JSON"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/yaml",
|
||||
"extensions": [".yaml", ".yml"],
|
||||
"label": "YAML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/toml",
|
||||
"extensions": [".toml"],
|
||||
"label": "TOML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/xml",
|
||||
"extensions": [".xml"],
|
||||
"label": "XML"
|
||||
},
|
||||
{
|
||||
"mediaType": "text/csv",
|
||||
"extensions": [".csv", ".tsv"],
|
||||
"label": "CSV and TSV"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/x-ndjson",
|
||||
"extensions": [".ndjson", ".jsonl"],
|
||||
"label": "NDJSON"
|
||||
}
|
||||
],
|
||||
"produces": [
|
||||
{
|
||||
"mediaType": "application/json",
|
||||
"extensions": [".json"],
|
||||
"label": "JSON and inferred JSON Schema"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/yaml",
|
||||
"extensions": [".yaml"],
|
||||
"label": "YAML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/toml",
|
||||
"extensions": [".toml"],
|
||||
"label": "TOML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/xml",
|
||||
"extensions": [".xml"],
|
||||
"label": "XML"
|
||||
},
|
||||
{
|
||||
"mediaType": "text/csv",
|
||||
"extensions": [".csv", ".tsv"],
|
||||
"label": "CSV and TSV"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/x-ndjson",
|
||||
"extensions": [".ndjson"],
|
||||
"label": "NDJSON"
|
||||
}
|
||||
]
|
||||
},
|
||||
"capabilities": { "required": ["workers"], "optional": [] },
|
||||
"privacy": {
|
||||
"processing": "local",
|
||||
"fileUploads": false,
|
||||
"fileUploads": true,
|
||||
"telemetry": false,
|
||||
"label": "Inputs stay in this browser; nothing is uploaded."
|
||||
},
|
||||
|
||||
@@ -45,6 +45,12 @@ export function HelpDialog({
|
||||
declarations with external semantics are rejected, and spreadsheet-safe
|
||||
CSV/TSV output is enabled by default.
|
||||
</p>
|
||||
<p>
|
||||
The schema view performs bounded, sample-based JSON Schema inference and
|
||||
records field presence, nullability and exact number representations.
|
||||
Structural edits use strict RFC 6901 pointers and show the source-format
|
||||
serialization and its loss report before anything is applied.
|
||||
</p>
|
||||
</dialog>
|
||||
);
|
||||
}
|
||||
|
||||
+264
-24
@@ -1,3 +1,4 @@
|
||||
import { formatBytes, triggerBlobDownload } from "@add-ideas/toolbox-helpers";
|
||||
import {
|
||||
useCallback,
|
||||
useEffect,
|
||||
@@ -10,12 +11,19 @@ import {
|
||||
type KeyboardEvent,
|
||||
} from "react";
|
||||
import { convertDocument } from "../core/convert";
|
||||
import { DATA_ADAPTERS } from "../core/adapters";
|
||||
import {
|
||||
applyNodeEdit,
|
||||
parseEditValue,
|
||||
type EditOperation,
|
||||
type EditValueKind,
|
||||
} from "../core/edit";
|
||||
import { assertBoundedFile, DATA_LIMITS } from "../core/limits";
|
||||
import { scalarText } from "../core/model";
|
||||
import { flattenRows, runQuery, tableFromNode, treeRows } from "../core/query";
|
||||
import { createParseTask, type ParseTask } from "../core/worker-client";
|
||||
import { inferSchema, serializeSchema } from "../core/schema";
|
||||
import {
|
||||
DATA_FORMATS,
|
||||
DataToolsError,
|
||||
type ConversionResult,
|
||||
type DataFormat,
|
||||
@@ -38,6 +46,7 @@ const views = [
|
||||
{ id: "tree", label: "Tree", short: "Paths & types" },
|
||||
{ id: "table", label: "Table", short: "Rows & columns" },
|
||||
{ id: "query", label: "Query", short: "Pointer & safe path" },
|
||||
{ id: "schema", label: "Schema & edit", short: "Infer & change safely" },
|
||||
{ id: "convert", label: "Convert", short: "Output & disclosure" },
|
||||
] as const;
|
||||
|
||||
@@ -50,9 +59,7 @@ function initialView(): ViewId {
|
||||
}
|
||||
|
||||
function formatSize(bytes: number): string {
|
||||
if (bytes < 1_024) return `${bytes} B`;
|
||||
if (bytes < 1_048_576) return `${(bytes / 1_024).toFixed(1)} KiB`;
|
||||
return `${(bytes / 1_048_576).toFixed(1)} MiB`;
|
||||
return formatBytes(bytes, { fractionDigits: bytes < 1_024 ? 0 : 1 });
|
||||
}
|
||||
|
||||
function extension(format: DataFormat): string {
|
||||
@@ -60,20 +67,10 @@ function extension(format: DataFormat): string {
|
||||
}
|
||||
|
||||
function downloadText(text: string, format: DataFormat): void {
|
||||
const blob = new Blob([text], { type: "text/plain;charset=utf-8" });
|
||||
const url = URL.createObjectURL(blob);
|
||||
const anchor = document.createElement("a");
|
||||
anchor.href = url;
|
||||
anchor.download = `converted.${extension(format)}`;
|
||||
anchor.rel = "noopener";
|
||||
anchor.hidden = true;
|
||||
document.body.append(anchor);
|
||||
try {
|
||||
anchor.click();
|
||||
} finally {
|
||||
anchor.remove();
|
||||
window.setTimeout(() => URL.revokeObjectURL(url), 0);
|
||||
}
|
||||
triggerBlobDownload(
|
||||
new Blob([text], { type: "text/plain;charset=utf-8" }),
|
||||
`converted.${extension(format)}`,
|
||||
);
|
||||
}
|
||||
|
||||
function Diagnostics({ diagnostics }: { diagnostics: Diagnostic[] }) {
|
||||
@@ -228,11 +225,239 @@ function ConversionDisclosure({ result }: { result: ConversionResult }) {
|
||||
);
|
||||
}
|
||||
|
||||
function SchemaEditor({
|
||||
document,
|
||||
onApply,
|
||||
}: {
|
||||
document?: ParsedDocument;
|
||||
onApply: (source: string) => void;
|
||||
}) {
|
||||
const [operation, setOperation] = useState<EditOperation>("replace");
|
||||
const [pointer, setPointer] = useState("");
|
||||
const [kind, setKind] = useState<EditValueKind>("string");
|
||||
const [raw, setRaw] = useState("");
|
||||
const [error, setError] = useState("");
|
||||
const [accepted, setAccepted] = useState(false);
|
||||
const [pending, setPending] = useState<ConversionResult>();
|
||||
const inference = useMemo(
|
||||
() => (document ? inferSchema(document.root) : undefined),
|
||||
[document],
|
||||
);
|
||||
|
||||
function previewEdit(): void {
|
||||
if (!document) return;
|
||||
try {
|
||||
const root = applyNodeEdit(document.root, {
|
||||
operation,
|
||||
pointer,
|
||||
value: operation === "remove" ? undefined : parseEditValue(kind, raw),
|
||||
});
|
||||
const result = convertDocument({ ...document, root }, document.format, {
|
||||
spreadsheetSafe: true,
|
||||
});
|
||||
setPending(result);
|
||||
setAccepted(false);
|
||||
setError("");
|
||||
} catch (reason) {
|
||||
setPending(undefined);
|
||||
setError(
|
||||
reason instanceof Error ? reason.message : "The edit is invalid.",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const hasLoss =
|
||||
pending?.events.some((event) => event.severity === "loss") ?? false;
|
||||
return (
|
||||
<>
|
||||
<div className="section-heading">
|
||||
<div>
|
||||
<p className="eyebrow">Sample-based, bounded</p>
|
||||
<h2>Schema inference</h2>
|
||||
</div>
|
||||
<button
|
||||
type="button"
|
||||
disabled={!inference}
|
||||
onClick={() =>
|
||||
inference &&
|
||||
triggerBlobDownload(
|
||||
new Blob([serializeSchema(inference)], {
|
||||
type: "application/schema+json;charset=utf-8",
|
||||
}),
|
||||
"inferred.schema.json",
|
||||
)
|
||||
}
|
||||
>
|
||||
Download JSON Schema
|
||||
</button>
|
||||
</div>
|
||||
{inference ? (
|
||||
<>
|
||||
<ul className="schema-notices">
|
||||
{inference.notices.map((notice) => (
|
||||
<li key={notice}>{notice}</li>
|
||||
))}
|
||||
</ul>
|
||||
<div
|
||||
className="table-scroll"
|
||||
tabIndex={0}
|
||||
role="region"
|
||||
aria-label="Inferred fields"
|
||||
>
|
||||
<table>
|
||||
<caption className="sr-only">Inferred fields</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Pointer</th>
|
||||
<th>Types</th>
|
||||
<th>Presence</th>
|
||||
<th>Required</th>
|
||||
<th>Representation</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{inference.fields.slice(0, 500).map((field) => (
|
||||
<tr key={field.pointer}>
|
||||
<th scope="row">
|
||||
<code>{field.pointer || "(root)"}</code>
|
||||
</th>
|
||||
<td>{field.types.join(" · ")}</td>
|
||||
<td>
|
||||
{field.present} / {field.samples}
|
||||
</td>
|
||||
<td>{field.required ? "yes" : "no"}</td>
|
||||
<td>{field.representations.join(" · ") || "—"}</td>
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
{inference.fields.length > 500 ? (
|
||||
<p className="preview-note">
|
||||
The UI shows 500 of {inference.fields.length.toLocaleString()}{" "}
|
||||
inferred fields; the download retains the full bounded schema.
|
||||
</p>
|
||||
) : null}
|
||||
</>
|
||||
) : (
|
||||
<p className="empty-state">Analyze valid input to infer a schema.</p>
|
||||
)}
|
||||
|
||||
<div className="section-heading schema-edit-heading">
|
||||
<div>
|
||||
<p className="eyebrow">RFC 6901 addressing</p>
|
||||
<h2>Preview a structural edit</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div className="edit-grid">
|
||||
<label className="field">
|
||||
<span>Operation</span>
|
||||
<select
|
||||
value={operation}
|
||||
onChange={(event) =>
|
||||
setOperation(event.target.value as EditOperation)
|
||||
}
|
||||
>
|
||||
<option value="replace">Replace existing</option>
|
||||
<option value="add">Add / insert</option>
|
||||
<option value="remove">Remove</option>
|
||||
</select>
|
||||
</label>
|
||||
<label className="field">
|
||||
<span>JSON Pointer (empty = root)</span>
|
||||
<input
|
||||
value={pointer}
|
||||
onChange={(event) => setPointer(event.target.value)}
|
||||
placeholder="/people/0/name"
|
||||
spellCheck={false}
|
||||
/>
|
||||
</label>
|
||||
{operation !== "remove" ? (
|
||||
<>
|
||||
<label className="field">
|
||||
<span>Value type</span>
|
||||
<select
|
||||
value={kind}
|
||||
onChange={(event) =>
|
||||
setKind(event.target.value as EditValueKind)
|
||||
}
|
||||
>
|
||||
<option value="string">String</option>
|
||||
<option value="number">Exact number</option>
|
||||
<option value="boolean">Boolean</option>
|
||||
<option value="null">Null</option>
|
||||
<option value="date">ISO date/time</option>
|
||||
<option value="json">JSON value</option>
|
||||
</select>
|
||||
</label>
|
||||
{kind !== "null" ? (
|
||||
<label className="field edit-value-field">
|
||||
<span>Value</span>
|
||||
<textarea
|
||||
value={raw}
|
||||
onChange={(event) => setRaw(event.target.value)}
|
||||
spellCheck={false}
|
||||
/>
|
||||
</label>
|
||||
) : null}
|
||||
</>
|
||||
) : null}
|
||||
</div>
|
||||
<div className="button-row">
|
||||
<button
|
||||
type="button"
|
||||
className="primary-button"
|
||||
disabled={!document}
|
||||
onClick={previewEdit}
|
||||
>
|
||||
Preview edit
|
||||
</button>
|
||||
</div>
|
||||
{error ? (
|
||||
<p className="field-error" role="alert">
|
||||
{error}
|
||||
</p>
|
||||
) : null}
|
||||
{pending ? (
|
||||
<div className="edit-preview">
|
||||
<label className="field output-field">
|
||||
<span>Serialized source preview</span>
|
||||
<textarea readOnly value={pending.text} spellCheck={false} />
|
||||
</label>
|
||||
<ConversionDisclosure result={pending} />
|
||||
{hasLoss ? (
|
||||
<label className="toggle">
|
||||
<input
|
||||
type="checkbox"
|
||||
checked={accepted}
|
||||
onChange={(event) => setAccepted(event.target.checked)}
|
||||
/>
|
||||
<span>
|
||||
<strong>Accept disclosed loss</strong>
|
||||
<small>The original source is still untouched.</small>
|
||||
</span>
|
||||
</label>
|
||||
) : null}
|
||||
<button
|
||||
type="button"
|
||||
className="primary-button"
|
||||
disabled={hasLoss && !accepted}
|
||||
onClick={() => onApply(pending.text)}
|
||||
>
|
||||
Apply preview to source
|
||||
</button>
|
||||
</div>
|
||||
) : null}
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
export function Workbench() {
|
||||
const [source, setSource] = useState(DEFAULT_SAMPLE);
|
||||
const [selection, setSelection] = useState<FormatSelection>("auto");
|
||||
const [filename, setFilename] = useState<string>();
|
||||
const [documentModel, setDocumentModel] = useState<ParsedDocument>();
|
||||
const [documentRevision, setDocumentRevision] = useState(0);
|
||||
const [failureDiagnostics, setFailureDiagnostics] = useState<Diagnostic[]>(
|
||||
[],
|
||||
);
|
||||
@@ -262,6 +487,7 @@ export function Workbench() {
|
||||
.then((parsed) => {
|
||||
if (sequence !== requestSequence.current) return;
|
||||
setDocumentModel(parsed);
|
||||
setDocumentRevision(sequence);
|
||||
setFailureDiagnostics([]);
|
||||
setStatus("ready");
|
||||
setStatusMessage(
|
||||
@@ -516,9 +742,9 @@ export function Workbench() {
|
||||
data-testid="format-select"
|
||||
>
|
||||
<option value="auto">Detect automatically</option>
|
||||
{DATA_FORMATS.map((format) => (
|
||||
<option value={format} key={format}>
|
||||
{format.toUpperCase()}
|
||||
{DATA_ADAPTERS.map((adapter) => (
|
||||
<option value={adapter.format} key={adapter.format}>
|
||||
{adapter.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
@@ -757,6 +983,20 @@ export function Workbench() {
|
||||
)}
|
||||
</>
|
||||
) : null}
|
||||
{active === "schema" ? (
|
||||
<SchemaEditor
|
||||
key={documentRevision}
|
||||
document={documentModel}
|
||||
onApply={(nextSource) => {
|
||||
setSource(nextSource);
|
||||
setFilename(undefined);
|
||||
setSelection(documentModel?.format ?? "auto");
|
||||
setActionNotice(
|
||||
"Applied the reviewed edit to the source editor.",
|
||||
);
|
||||
}}
|
||||
/>
|
||||
) : null}
|
||||
{active === "convert" ? (
|
||||
<>
|
||||
<div className="section-heading">
|
||||
@@ -794,9 +1034,9 @@ export function Workbench() {
|
||||
setTarget(event.target.value as DataFormat)
|
||||
}
|
||||
>
|
||||
{DATA_FORMATS.map((format) => (
|
||||
<option key={format} value={format}>
|
||||
{format.toUpperCase()}
|
||||
{DATA_ADAPTERS.map((adapter) => (
|
||||
<option key={adapter.format} value={adapter.format}>
|
||||
{adapter.label}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
import type { DataFormat, ParsedDocument } from "./types";
|
||||
|
||||
export interface DataAdapterDescriptor {
|
||||
readonly format: DataFormat;
|
||||
readonly label: string;
|
||||
readonly extensions: readonly string[];
|
||||
readonly model: ParsedDocument["model"];
|
||||
readonly import: true;
|
||||
readonly export: true;
|
||||
readonly fidelityNote: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Public, ordered adapter catalogue used by parsing, conversion and the UI.
|
||||
* Implementations live next to the parser/writer that owns their safety rules;
|
||||
* the registries in parse.ts and convert.ts must cover every descriptor.
|
||||
*/
|
||||
export const DATA_ADAPTERS: readonly DataAdapterDescriptor[] = Object.freeze([
|
||||
{
|
||||
format: "json",
|
||||
label: "JSON",
|
||||
extensions: ["json"],
|
||||
model: "native",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote: "Exact decimal lexemes are retained.",
|
||||
},
|
||||
{
|
||||
format: "yaml",
|
||||
label: "YAML 1.2",
|
||||
extensions: ["yaml", "yml"],
|
||||
model: "native",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote: "Core schema only; tags and merges remain disabled.",
|
||||
},
|
||||
{
|
||||
format: "toml",
|
||||
label: "TOML",
|
||||
extensions: ["toml"],
|
||||
model: "native",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote: "Integers and typed dates are retained explicitly.",
|
||||
},
|
||||
{
|
||||
format: "xml",
|
||||
label: "XML",
|
||||
extensions: ["xml"],
|
||||
model: "xml-explicit",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote:
|
||||
"Elements, namespaces, attributes and child order use an explicit model.",
|
||||
},
|
||||
{
|
||||
format: "csv",
|
||||
label: "CSV",
|
||||
extensions: ["csv"],
|
||||
model: "tabular",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote: "Every imported cell remains a string.",
|
||||
},
|
||||
{
|
||||
format: "tsv",
|
||||
label: "TSV",
|
||||
extensions: ["tsv", "tab"],
|
||||
model: "tabular",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote: "Every imported cell remains a string.",
|
||||
},
|
||||
{
|
||||
format: "ndjson",
|
||||
label: "NDJSON",
|
||||
extensions: ["ndjson", "jsonl"],
|
||||
model: "native",
|
||||
import: true,
|
||||
export: true,
|
||||
fidelityNote: "Each non-blank line is one exact JSON value.",
|
||||
},
|
||||
]);
|
||||
|
||||
export function adapterDescriptor(format: DataFormat): DataAdapterDescriptor {
|
||||
const descriptor = DATA_ADAPTERS.find((item) => item.format === format);
|
||||
if (!descriptor)
|
||||
throw new TypeError(`No data adapter is registered for ${format}.`);
|
||||
return descriptor;
|
||||
}
|
||||
+66
-39
@@ -7,6 +7,7 @@ import Papa from "papaparse";
|
||||
import { stringify as stringifyToml, TomlDate } from "smol-toml";
|
||||
import { stringify as stringifyYaml } from "yaml";
|
||||
import { assertBoundedOutput } from "./limits";
|
||||
import { adapterDescriptor, type DataAdapterDescriptor } from "./adapters";
|
||||
import { objectValue, scalarText } from "./model";
|
||||
import type {
|
||||
ConversionOptions,
|
||||
@@ -452,6 +453,70 @@ function ndjsonText(node: DataNode, events: LossEvent[]): string {
|
||||
return `${items.map((item) => jsonText(item, events, 0).replace(/\n/gu, "")).join("\n")}\n`;
|
||||
}
|
||||
|
||||
export interface ExportAdapter {
|
||||
readonly descriptor: DataAdapterDescriptor;
|
||||
readonly serialize: (
|
||||
document: ParsedDocument,
|
||||
options: ConversionOptions,
|
||||
events: LossEvent[],
|
||||
) => string;
|
||||
}
|
||||
|
||||
/** Concrete export registry: every adapter owns its disclosure-producing writer. */
|
||||
export const EXPORT_ADAPTERS: Readonly<Record<DataFormat, ExportAdapter>> = {
|
||||
json: {
|
||||
descriptor: adapterDescriptor("json"),
|
||||
serialize: (document, _options, events) =>
|
||||
`${jsonText(document.root, events, 2)}\n`,
|
||||
},
|
||||
yaml: {
|
||||
descriptor: adapterDescriptor("yaml"),
|
||||
serialize: (document, _options, events) =>
|
||||
stringifyYaml(interoperableValue(document.root, "yaml", events, ""), {
|
||||
version: "1.2",
|
||||
schema: "core",
|
||||
indent: 2,
|
||||
lineWidth: 0,
|
||||
}),
|
||||
},
|
||||
toml: {
|
||||
descriptor: adapterDescriptor("toml"),
|
||||
serialize: (document, _options, events) => {
|
||||
let value = interoperableValue(document.root, "toml", events, "");
|
||||
if (document.root.type !== "object") {
|
||||
addEvent(events, {
|
||||
code: "toml.root-table",
|
||||
message:
|
||||
"TOML requires a root table; the value is placed in a ‘value’ field.",
|
||||
path: "",
|
||||
severity: "coercion",
|
||||
});
|
||||
value = { value };
|
||||
}
|
||||
return stringifyToml(value as never);
|
||||
},
|
||||
},
|
||||
xml: {
|
||||
descriptor: adapterDescriptor("xml"),
|
||||
serialize: (document, _options, events) => xmlText(document, events),
|
||||
},
|
||||
csv: {
|
||||
descriptor: adapterDescriptor("csv"),
|
||||
serialize: (document, options, events) =>
|
||||
delimitedText(document, "csv", options, events),
|
||||
},
|
||||
tsv: {
|
||||
descriptor: adapterDescriptor("tsv"),
|
||||
serialize: (document, options, events) =>
|
||||
delimitedText(document, "tsv", options, events),
|
||||
},
|
||||
ndjson: {
|
||||
descriptor: adapterDescriptor("ndjson"),
|
||||
serialize: (document, _options, events) =>
|
||||
ndjsonText(document.root, events),
|
||||
},
|
||||
};
|
||||
|
||||
export function convertDocument(
|
||||
document: ParsedDocument,
|
||||
target: DataFormat,
|
||||
@@ -467,44 +532,6 @@ export function convertDocument(
|
||||
severity: "notice",
|
||||
});
|
||||
}
|
||||
let text: string;
|
||||
switch (target) {
|
||||
case "json":
|
||||
text = `${jsonText(document.root, events, 2)}\n`;
|
||||
break;
|
||||
case "yaml":
|
||||
text = stringifyYaml(
|
||||
interoperableValue(document.root, "yaml", events, ""),
|
||||
{ version: "1.2", schema: "core", indent: 2, lineWidth: 0 },
|
||||
);
|
||||
break;
|
||||
case "toml": {
|
||||
let value = interoperableValue(document.root, "toml", events, "");
|
||||
if (document.root.type !== "object") {
|
||||
addEvent(events, {
|
||||
code: "toml.root-table",
|
||||
message:
|
||||
"TOML requires a root table; the value is placed in a ‘value’ field.",
|
||||
path: "",
|
||||
severity: "coercion",
|
||||
});
|
||||
value = { value };
|
||||
}
|
||||
text = stringifyToml(value as never);
|
||||
break;
|
||||
}
|
||||
case "xml":
|
||||
text = xmlText(document, events);
|
||||
break;
|
||||
case "csv":
|
||||
text = delimitedText(document, "csv", options, events);
|
||||
break;
|
||||
case "tsv":
|
||||
text = delimitedText(document, "tsv", options, events);
|
||||
break;
|
||||
case "ndjson":
|
||||
text = ndjsonText(document.root, events);
|
||||
break;
|
||||
}
|
||||
const text = EXPORT_ADAPTERS[target].serialize(document, options, events);
|
||||
return { text: assertBoundedOutput(text), events, target };
|
||||
}
|
||||
|
||||
@@ -0,0 +1,186 @@
|
||||
import { DATA_LIMITS, measureNode } from "./limits";
|
||||
import { unescapePointerToken } from "./model";
|
||||
import { parseDataDocument } from "./parse";
|
||||
import type { DataNode } from "./types";
|
||||
|
||||
export type EditOperation = "add" | "replace" | "remove";
|
||||
export type EditValueKind =
|
||||
"string" | "number" | "boolean" | "null" | "date" | "json";
|
||||
|
||||
export interface NodeEdit {
|
||||
readonly operation: EditOperation;
|
||||
readonly pointer: string;
|
||||
readonly value?: DataNode;
|
||||
}
|
||||
|
||||
const DANGEROUS_KEYS = new Set(["__proto__", "constructor", "prototype"]);
|
||||
const JSON_NUMBER = /^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/u;
|
||||
|
||||
export function parseEditValue(kind: EditValueKind, raw: string): DataNode {
|
||||
if (raw.length > DATA_LIMITS.maxEditCharacters)
|
||||
throw new RangeError(
|
||||
`Edit value exceeds ${DATA_LIMITS.maxEditCharacters.toLocaleString()} characters.`,
|
||||
);
|
||||
if (kind === "string") return { type: "string", value: raw };
|
||||
if (kind === "null") return { type: "null" };
|
||||
if (kind === "boolean") {
|
||||
if (raw !== "true" && raw !== "false")
|
||||
throw new SyntaxError(
|
||||
"Boolean edit values must be exactly true or false.",
|
||||
);
|
||||
return { type: "boolean", value: raw === "true" };
|
||||
}
|
||||
if (kind === "number") {
|
||||
if (!JSON_NUMBER.test(raw))
|
||||
throw new SyntaxError(
|
||||
"Number edit values must use strict JSON number syntax.",
|
||||
);
|
||||
return { type: "number", raw, representation: "exact" };
|
||||
}
|
||||
if (kind === "date") {
|
||||
const dateKind = /^\d{4}-\d{2}-\d{2}$/u.test(raw)
|
||||
? "local-date"
|
||||
: /^\d{2}:\d{2}/u.test(raw)
|
||||
? "local-time"
|
||||
: /(?:Z|[+-]\d{2}:\d{2})$/u.test(raw)
|
||||
? "offset-date-time"
|
||||
: "local-date-time";
|
||||
if (
|
||||
!/^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?(?:Z|[+-]\d{2}:\d{2})?)?$|^\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?$/u.test(
|
||||
raw,
|
||||
)
|
||||
)
|
||||
throw new SyntaxError(
|
||||
"Date/time edit value must use an ISO 8601 lexical form.",
|
||||
);
|
||||
return { type: "date", value: raw, dateKind };
|
||||
}
|
||||
return parseDataDocument({ source: raw, format: "json" }).root;
|
||||
}
|
||||
|
||||
export function applyNodeEdit(root: DataNode, edit: NodeEdit): DataNode {
|
||||
const tokens = pointerTokens(edit.pointer);
|
||||
if (edit.operation !== "remove" && !edit.value)
|
||||
throw new TypeError(`${edit.operation} requires a value.`);
|
||||
if (!tokens.length) {
|
||||
if (edit.operation === "remove")
|
||||
throw new SyntaxError("The document root cannot be removed.");
|
||||
const replacement = edit.value!;
|
||||
measureNode(replacement, 0, 0);
|
||||
return replacement;
|
||||
}
|
||||
const next = updateAt(root, tokens, 0, edit);
|
||||
measureNode(next, 0, 0);
|
||||
return next;
|
||||
}
|
||||
|
||||
function updateAt(
|
||||
node: DataNode,
|
||||
tokens: string[],
|
||||
depth: number,
|
||||
edit: NodeEdit,
|
||||
): DataNode {
|
||||
const token = tokens[depth]!;
|
||||
const leaf = depth === tokens.length - 1;
|
||||
if (node.type === "object") {
|
||||
if (DANGEROUS_KEYS.has(token))
|
||||
throw new SyntaxError(`The key “${token}” is prohibited.`);
|
||||
const index = node.entries.findIndex((entry) => entry.key === token);
|
||||
if (leaf) {
|
||||
if (edit.operation === "remove") {
|
||||
if (index < 0)
|
||||
throw new RangeError(`Pointer member “${token}” does not exist.`);
|
||||
return {
|
||||
type: "object",
|
||||
entries: node.entries.filter((_, item) => item !== index),
|
||||
};
|
||||
}
|
||||
if (edit.operation === "replace" && index < 0)
|
||||
throw new RangeError(`Pointer member “${token}” does not exist.`);
|
||||
const replacement = { key: token, value: edit.value! };
|
||||
return {
|
||||
type: "object",
|
||||
entries:
|
||||
index < 0
|
||||
? [...node.entries, replacement]
|
||||
: node.entries.map((entry, item) =>
|
||||
item === index ? replacement : entry,
|
||||
),
|
||||
};
|
||||
}
|
||||
if (index < 0)
|
||||
throw new RangeError(`Pointer member “${token}” does not exist.`);
|
||||
return {
|
||||
type: "object",
|
||||
entries: node.entries.map((entry, item) =>
|
||||
item === index
|
||||
? { ...entry, value: updateAt(entry.value, tokens, depth + 1, edit) }
|
||||
: entry,
|
||||
),
|
||||
};
|
||||
}
|
||||
if (node.type === "array") {
|
||||
const index = arrayIndex(
|
||||
token,
|
||||
node.items.length,
|
||||
leaf && edit.operation === "add",
|
||||
);
|
||||
if (leaf) {
|
||||
if (edit.operation === "add") {
|
||||
const items = node.items.slice();
|
||||
items.splice(index, 0, edit.value!);
|
||||
return { type: "array", items };
|
||||
}
|
||||
if (index >= node.items.length)
|
||||
throw new RangeError(`Array index ${index} does not exist.`);
|
||||
if (edit.operation === "remove")
|
||||
return {
|
||||
type: "array",
|
||||
items: node.items.filter((_, item) => item !== index),
|
||||
};
|
||||
return {
|
||||
type: "array",
|
||||
items: node.items.map((item, position) =>
|
||||
position === index ? edit.value! : item,
|
||||
),
|
||||
};
|
||||
}
|
||||
if (index >= node.items.length)
|
||||
throw new RangeError(`Array index ${index} does not exist.`);
|
||||
return {
|
||||
type: "array",
|
||||
items: node.items.map((item, position) =>
|
||||
position === index ? updateAt(item, tokens, depth + 1, edit) : item,
|
||||
),
|
||||
};
|
||||
}
|
||||
throw new TypeError(
|
||||
`Pointer traverses through a ${node.type} value at segment ${depth + 1}.`,
|
||||
);
|
||||
}
|
||||
|
||||
function pointerTokens(pointer: string): string[] {
|
||||
if (pointer.length > DATA_LIMITS.maxQueryCharacters)
|
||||
throw new RangeError("Edit pointer exceeds the bounded query length.");
|
||||
if (pointer === "") return [];
|
||||
if (!pointer.startsWith("/"))
|
||||
throw new SyntaxError("Edit pointer must be an RFC 6901 JSON Pointer.");
|
||||
const tokens = pointer.slice(1).split("/").map(unescapePointerToken);
|
||||
if (tokens.length > DATA_LIMITS.maxDepth)
|
||||
throw new RangeError("Edit pointer exceeds the structural depth limit.");
|
||||
return tokens;
|
||||
}
|
||||
|
||||
function arrayIndex(token: string, length: number, allowEnd: boolean): number {
|
||||
if (token === "-" && allowEnd) return length;
|
||||
if (!/^(?:0|[1-9]\d*)$/u.test(token))
|
||||
throw new SyntaxError(`Invalid array index “${token}”.`);
|
||||
const index = Number(token);
|
||||
if (
|
||||
!Number.isSafeInteger(index) ||
|
||||
index > length ||
|
||||
(!allowEnd && index === length)
|
||||
)
|
||||
throw new RangeError(`Array index ${token} is outside the bounded array.`);
|
||||
return index;
|
||||
}
|
||||
@@ -15,6 +15,9 @@ export const DATA_LIMITS = Object.freeze({
|
||||
parseTimeoutMs: 30_000,
|
||||
maxPreviewRows: 250,
|
||||
maxPreviewColumns: 100,
|
||||
maxSchemaSamples: 5_000,
|
||||
maxSchemaFields: 5_000,
|
||||
maxEditCharacters: 1_000_000,
|
||||
});
|
||||
|
||||
export class DataLimitError extends RangeError {
|
||||
|
||||
+41
-30
@@ -8,6 +8,7 @@ import Papa from "papaparse";
|
||||
import { parse as parseToml } from "smol-toml";
|
||||
import { parseDocument as parseYamlDocument } from "yaml";
|
||||
import { detectContentFormat, detectFormat } from "./detect";
|
||||
import { adapterDescriptor, type DataAdapterDescriptor } from "./adapters";
|
||||
import {
|
||||
assertBoundedSource,
|
||||
DATA_LIMITS,
|
||||
@@ -553,6 +554,43 @@ function selectedDetection(request: ParseRequest): {
|
||||
return { selected, detection, diagnostics };
|
||||
}
|
||||
|
||||
export interface ImportAdapter {
|
||||
readonly descriptor: DataAdapterDescriptor;
|
||||
readonly parse: (source: string, diagnostics: Diagnostic[]) => DataNode;
|
||||
}
|
||||
|
||||
/** Concrete import registry: adding a format requires an explicit bounded parser. */
|
||||
export const IMPORT_ADAPTERS: Readonly<Record<DataFormat, ImportAdapter>> = {
|
||||
json: {
|
||||
descriptor: adapterDescriptor("json"),
|
||||
parse: (source) => parseJson(source),
|
||||
},
|
||||
yaml: {
|
||||
descriptor: adapterDescriptor("yaml"),
|
||||
parse: parseYaml,
|
||||
},
|
||||
toml: {
|
||||
descriptor: adapterDescriptor("toml"),
|
||||
parse: parseTomlDocument,
|
||||
},
|
||||
xml: {
|
||||
descriptor: adapterDescriptor("xml"),
|
||||
parse: parseXml,
|
||||
},
|
||||
csv: {
|
||||
descriptor: adapterDescriptor("csv"),
|
||||
parse: (source, diagnostics) => parseDelimited(source, ",", diagnostics),
|
||||
},
|
||||
tsv: {
|
||||
descriptor: adapterDescriptor("tsv"),
|
||||
parse: (source, diagnostics) => parseDelimited(source, "\t", diagnostics),
|
||||
},
|
||||
ndjson: {
|
||||
descriptor: adapterDescriptor("ndjson"),
|
||||
parse: parseNdjson,
|
||||
},
|
||||
};
|
||||
|
||||
export function parseDataDocument(request: ParseRequest): ParsedDocument {
|
||||
let bytes: number;
|
||||
try {
|
||||
@@ -563,31 +601,9 @@ export function parseDataDocument(request: ParseRequest): ParsedDocument {
|
||||
throw parserFailure(message, "limit.input", request.source);
|
||||
}
|
||||
const { selected, detection, diagnostics } = selectedDetection(request);
|
||||
let root: DataNode;
|
||||
try {
|
||||
switch (selected) {
|
||||
case "json":
|
||||
root = parseJson(request.source);
|
||||
break;
|
||||
case "yaml":
|
||||
root = parseYaml(request.source, diagnostics);
|
||||
break;
|
||||
case "toml":
|
||||
root = parseTomlDocument(request.source, diagnostics);
|
||||
break;
|
||||
case "xml":
|
||||
root = parseXml(request.source, diagnostics);
|
||||
break;
|
||||
case "csv":
|
||||
root = parseDelimited(request.source, ",", diagnostics);
|
||||
break;
|
||||
case "tsv":
|
||||
root = parseDelimited(request.source, "\t", diagnostics);
|
||||
break;
|
||||
case "ndjson":
|
||||
root = parseNdjson(request.source, diagnostics);
|
||||
break;
|
||||
}
|
||||
const adapter = IMPORT_ADAPTERS[selected];
|
||||
const root = adapter.parse(request.source, diagnostics);
|
||||
const stats = measureNode(root, bytes, request.source.length);
|
||||
return {
|
||||
format: selected,
|
||||
@@ -595,12 +611,7 @@ export function parseDataDocument(request: ParseRequest): ParsedDocument {
|
||||
root,
|
||||
diagnostics,
|
||||
stats,
|
||||
model:
|
||||
selected === "xml"
|
||||
? "xml-explicit"
|
||||
: selected === "csv" || selected === "tsv"
|
||||
? "tabular"
|
||||
: "native",
|
||||
model: adapter.descriptor.model,
|
||||
};
|
||||
} catch (error) {
|
||||
if (error instanceof DataToolsError) throw error;
|
||||
|
||||
@@ -0,0 +1,204 @@
|
||||
import { assertBoundedOutput, DATA_LIMITS } from "./limits";
|
||||
import { escapePointerToken } from "./model";
|
||||
import type { DataNode } from "./types";
|
||||
|
||||
export interface InferredField {
|
||||
readonly pointer: string;
|
||||
readonly types: readonly string[];
|
||||
readonly present: number;
|
||||
readonly samples: number;
|
||||
readonly required: boolean;
|
||||
readonly nullable: boolean;
|
||||
readonly representations: readonly string[];
|
||||
}
|
||||
|
||||
export interface SchemaInference {
|
||||
readonly schemaVersion: 1;
|
||||
readonly sampledNodes: number;
|
||||
readonly truncated: boolean;
|
||||
readonly fields: readonly InferredField[];
|
||||
readonly notices: readonly string[];
|
||||
readonly jsonSchema: Record<string, unknown>;
|
||||
}
|
||||
|
||||
interface InferenceState {
|
||||
sampledNodes: number;
|
||||
truncated: boolean;
|
||||
fields: InferredField[];
|
||||
}
|
||||
|
||||
export function inferSchema(root: DataNode): SchemaInference {
|
||||
const state: InferenceState = {
|
||||
sampledNodes: 0,
|
||||
truncated: false,
|
||||
fields: [],
|
||||
};
|
||||
const schema = inferMany([root], "", state, 0);
|
||||
return {
|
||||
schemaVersion: 1,
|
||||
sampledNodes: state.sampledNodes,
|
||||
truncated: state.truncated,
|
||||
fields: state.fields,
|
||||
notices: [
|
||||
"This is sample-based inference, not proof that future documents conform.",
|
||||
"Exact number lexemes are not converted into binary minimum/maximum constraints.",
|
||||
...(state.truncated
|
||||
? [
|
||||
`Inference stopped at the ${DATA_LIMITS.maxSchemaSamples.toLocaleString()}-node sample budget.`,
|
||||
]
|
||||
: []),
|
||||
],
|
||||
jsonSchema: {
|
||||
$schema: "https://json-schema.org/draft/2020-12/schema",
|
||||
$comment:
|
||||
"Generated locally from bounded samples. x-add-ideas-* members preserve inference provenance.",
|
||||
...schema,
|
||||
"x-add-ideas-sampled-nodes": state.sampledNodes,
|
||||
"x-add-ideas-truncated": state.truncated,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function serializeSchema(inference: SchemaInference): string {
|
||||
return assertBoundedOutput(
|
||||
`${JSON.stringify(inference.jsonSchema, null, 2)}\n`,
|
||||
);
|
||||
}
|
||||
|
||||
function inferMany(
|
||||
candidates: readonly DataNode[],
|
||||
pointer: string,
|
||||
state: InferenceState,
|
||||
depth: number,
|
||||
): Record<string, unknown> {
|
||||
if (depth > DATA_LIMITS.maxDepth) return {};
|
||||
const nodes = candidates.slice(0, remainingSamples(state));
|
||||
if (nodes.length < candidates.length) state.truncated = true;
|
||||
state.sampledNodes += nodes.length;
|
||||
if (!nodes.length) return {};
|
||||
|
||||
const groups = new Map<string, DataNode[]>();
|
||||
for (const node of nodes) {
|
||||
const type = schemaType(node);
|
||||
const group = groups.get(type) ?? [];
|
||||
group.push(node);
|
||||
groups.set(type, group);
|
||||
}
|
||||
const schemas = [...groups.entries()].map(([type, grouped]) =>
|
||||
inferType(type, grouped, pointer, state, depth),
|
||||
);
|
||||
return schemas.length === 1 ? schemas[0]! : { anyOf: schemas };
|
||||
}
|
||||
|
||||
function inferType(
|
||||
type: string,
|
||||
nodes: readonly DataNode[],
|
||||
pointer: string,
|
||||
state: InferenceState,
|
||||
depth: number,
|
||||
): Record<string, unknown> {
|
||||
if (type === "null" || type === "boolean" || type === "string")
|
||||
return { type };
|
||||
if (type === "integer" || type === "number") {
|
||||
const representations = [
|
||||
...new Set(
|
||||
nodes.flatMap((node) =>
|
||||
node.type === "number" ? [node.representation] : [],
|
||||
),
|
||||
),
|
||||
].sort();
|
||||
return {
|
||||
type,
|
||||
"x-add-ideas-number-representations": representations,
|
||||
"x-add-ideas-number-examples": nodes
|
||||
.flatMap((node) => (node.type === "number" ? [node.raw] : []))
|
||||
.slice(0, 3),
|
||||
};
|
||||
}
|
||||
if (type.startsWith("date:")) {
|
||||
const kind = type.slice(5);
|
||||
const format =
|
||||
kind === "local-date"
|
||||
? "date"
|
||||
: kind === "local-time"
|
||||
? "time"
|
||||
: "date-time";
|
||||
return { type: "string", format, "x-add-ideas-date-kind": kind };
|
||||
}
|
||||
if (type === "array") {
|
||||
const arrays = nodes.filter(
|
||||
(node): node is Extract<DataNode, { type: "array" }> =>
|
||||
node.type === "array",
|
||||
);
|
||||
const items = arrays.flatMap((node) => node.items);
|
||||
return {
|
||||
type: "array",
|
||||
items: items.length
|
||||
? inferMany(items, `${pointer}/*`, state, depth + 1)
|
||||
: {},
|
||||
"x-add-ideas-array-samples": arrays.length,
|
||||
"x-add-ideas-empty-array-observed": arrays.some(
|
||||
(node) => node.items.length === 0,
|
||||
),
|
||||
};
|
||||
}
|
||||
const objects = nodes.filter(
|
||||
(node): node is Extract<DataNode, { type: "object" }> =>
|
||||
node.type === "object",
|
||||
);
|
||||
const keys: string[] = [];
|
||||
for (const object of objects)
|
||||
for (const entry of object.entries)
|
||||
if (!keys.includes(entry.key)) keys.push(entry.key);
|
||||
const properties: Record<string, unknown> = Object.create(null) as Record<
|
||||
string,
|
||||
unknown
|
||||
>;
|
||||
const required: string[] = [];
|
||||
for (const key of keys) {
|
||||
if (state.fields.length >= DATA_LIMITS.maxSchemaFields) {
|
||||
state.truncated = true;
|
||||
break;
|
||||
}
|
||||
const values = objects.flatMap((object) => {
|
||||
const entry = object.entries.find((candidate) => candidate.key === key);
|
||||
return entry ? [entry.value] : [];
|
||||
});
|
||||
const childPointer = `${pointer}/${escapePointerToken(key)}`;
|
||||
state.fields.push({
|
||||
pointer: childPointer,
|
||||
types: [...new Set(values.map(schemaType))].sort(),
|
||||
present: values.length,
|
||||
samples: objects.length,
|
||||
required: values.length === objects.length,
|
||||
nullable: values.some((value) => value.type === "null"),
|
||||
representations: [
|
||||
...new Set(
|
||||
values.flatMap((value) =>
|
||||
value.type === "number" ? [value.representation] : [],
|
||||
),
|
||||
),
|
||||
].sort(),
|
||||
});
|
||||
properties[key] = inferMany(values, childPointer, state, depth + 1);
|
||||
if (values.length === objects.length) required.push(key);
|
||||
}
|
||||
return {
|
||||
type: "object",
|
||||
properties,
|
||||
...(required.length ? { required } : {}),
|
||||
additionalProperties: true,
|
||||
"x-add-ideas-object-samples": objects.length,
|
||||
};
|
||||
}
|
||||
|
||||
function schemaType(node: DataNode): string {
|
||||
if (node.type === "number")
|
||||
return /^-?(?:0|[1-9]\d*)$/u.test(node.raw) ? "integer" : "number";
|
||||
if (node.type === "date") return `date:${node.dateKind}`;
|
||||
return node.type;
|
||||
}
|
||||
|
||||
function remainingSamples(state: InferenceState): number {
|
||||
return Math.max(0, DATA_LIMITS.maxSchemaSamples - state.sampledNodes);
|
||||
}
|
||||
+39
-54
@@ -1,3 +1,7 @@
|
||||
import {
|
||||
startWorkerJob,
|
||||
WorkerJobTimeoutError,
|
||||
} from "@add-ideas/toolbox-helpers";
|
||||
import { parseDataDocument } from "./parse";
|
||||
import { DATA_LIMITS } from "./limits";
|
||||
import {
|
||||
@@ -6,15 +10,7 @@ import {
|
||||
type ParseRequest,
|
||||
} from "./types";
|
||||
|
||||
interface WorkerResponseOk {
|
||||
id: number;
|
||||
ok: true;
|
||||
document: ParsedDocument;
|
||||
}
|
||||
|
||||
interface WorkerResponseError {
|
||||
id: number;
|
||||
ok: false;
|
||||
interface SerializedParseError {
|
||||
message: string;
|
||||
diagnostics: DataToolsError["diagnostics"];
|
||||
}
|
||||
@@ -24,10 +20,7 @@ export interface ParseTask {
|
||||
cancel(): void;
|
||||
}
|
||||
|
||||
let requestId = 0;
|
||||
|
||||
export function createParseTask(request: ParseRequest): ParseTask {
|
||||
const id = ++requestId;
|
||||
if (typeof Worker === "undefined") {
|
||||
let cancelled = false;
|
||||
return {
|
||||
@@ -45,14 +38,20 @@ export function createParseTask(request: ParseRequest): ParseTask {
|
||||
new URL("../workers/data.worker.ts", import.meta.url),
|
||||
{ type: "module", name: "data-tools-parser" },
|
||||
);
|
||||
let settled = false;
|
||||
let rejectPromise: ((reason?: unknown) => void) | undefined;
|
||||
const timeout = globalThis.setTimeout(() => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
worker.terminate();
|
||||
rejectPromise?.(
|
||||
new DataToolsError(
|
||||
const task = startWorkerJob<
|
||||
ParseRequest,
|
||||
ParsedDocument,
|
||||
never,
|
||||
SerializedParseError
|
||||
>(worker, request, {
|
||||
timeoutMs: DATA_LIMITS.parseTimeoutMs,
|
||||
deserializeError: (error) =>
|
||||
new DataToolsError(error.message, error.diagnostics),
|
||||
workerFailureMessage: "The parser worker failed.",
|
||||
});
|
||||
const promise = task.promise.catch((error: unknown) => {
|
||||
if (error instanceof WorkerJobTimeoutError) {
|
||||
throw new DataToolsError(
|
||||
`Parsing exceeded the ${DATA_LIMITS.parseTimeoutMs / 1000}-second safety limit.`,
|
||||
[
|
||||
{
|
||||
@@ -62,45 +61,31 @@ export function createParseTask(request: ParseRequest): ParseTask {
|
||||
severity: "error",
|
||||
},
|
||||
],
|
||||
),
|
||||
);
|
||||
}, DATA_LIMITS.parseTimeoutMs);
|
||||
const finish = () => {
|
||||
if (settled) return false;
|
||||
settled = true;
|
||||
globalThis.clearTimeout(timeout);
|
||||
worker.terminate();
|
||||
return true;
|
||||
};
|
||||
const promise = new Promise<ParsedDocument>((resolve, reject) => {
|
||||
rejectPromise = reject;
|
||||
worker.onmessage = (
|
||||
event: MessageEvent<WorkerResponseOk | WorkerResponseError>,
|
||||
) => {
|
||||
if (event.data.id !== id || !finish()) return;
|
||||
if (event.data.ok) resolve(event.data.document);
|
||||
else
|
||||
reject(new DataToolsError(event.data.message, event.data.diagnostics));
|
||||
};
|
||||
worker.onerror = (event) => {
|
||||
if (!finish()) return;
|
||||
reject(
|
||||
new DataToolsError(event.message || "The parser worker failed.", [
|
||||
{
|
||||
code: "worker.failure",
|
||||
message: event.message || "The parser worker failed.",
|
||||
severity: "error",
|
||||
},
|
||||
]),
|
||||
);
|
||||
};
|
||||
worker.postMessage({ id, request });
|
||||
}
|
||||
if (
|
||||
error instanceof DataToolsError ||
|
||||
(error instanceof DOMException && error.name === "AbortError")
|
||||
)
|
||||
throw error;
|
||||
throw new DataToolsError(
|
||||
error instanceof Error ? error.message : "The parser worker failed.",
|
||||
[
|
||||
{
|
||||
code: "worker.failure",
|
||||
message:
|
||||
error instanceof Error
|
||||
? error.message
|
||||
: "The parser worker failed.",
|
||||
severity: "error",
|
||||
},
|
||||
],
|
||||
);
|
||||
});
|
||||
return {
|
||||
promise,
|
||||
cancel() {
|
||||
if (!finish()) return;
|
||||
rejectPromise?.(new DOMException("Parsing cancelled.", "AbortError"));
|
||||
task.cancel("Parsing cancelled.");
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
+54
-1
@@ -753,6 +753,54 @@ body {
|
||||
gap: 0.45rem;
|
||||
}
|
||||
|
||||
.schema-notices {
|
||||
margin: 0 0 0.85rem;
|
||||
padding-left: 1.15rem;
|
||||
color: var(--toolbox-muted);
|
||||
font-size: 0.78rem;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
.schema-edit-heading {
|
||||
margin-top: 1.4rem;
|
||||
padding-top: 1rem;
|
||||
border-top: 1px solid var(--toolbox-border);
|
||||
}
|
||||
|
||||
.edit-grid {
|
||||
display: grid;
|
||||
grid-template-columns: minmax(8rem, 0.65fr) minmax(14rem, 1.4fr) minmax(
|
||||
8rem,
|
||||
0.65fr
|
||||
);
|
||||
gap: 0.7rem;
|
||||
align-items: end;
|
||||
margin-bottom: 0.75rem;
|
||||
}
|
||||
|
||||
.edit-value-field {
|
||||
grid-column: 1 / -1;
|
||||
}
|
||||
|
||||
.edit-value-field textarea {
|
||||
min-height: 6rem;
|
||||
font-family: var(--toolbox-font-mono);
|
||||
}
|
||||
|
||||
.edit-preview {
|
||||
display: grid;
|
||||
gap: 0.75rem;
|
||||
margin-top: 0.9rem;
|
||||
padding: 0.85rem;
|
||||
border: 1px solid var(--toolbox-border);
|
||||
border-radius: 0.7rem;
|
||||
background: var(--toolbox-surface-soft);
|
||||
}
|
||||
|
||||
.edit-preview > button {
|
||||
justify-self: start;
|
||||
}
|
||||
|
||||
.disclosure {
|
||||
margin-top: 0.75rem;
|
||||
padding: 0.75rem;
|
||||
@@ -864,9 +912,14 @@ body {
|
||||
}
|
||||
.editor-toolbar,
|
||||
.query-controls,
|
||||
.conversion-controls {
|
||||
.conversion-controls,
|
||||
.edit-grid {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
|
||||
.edit-value-field {
|
||||
grid-column: auto;
|
||||
}
|
||||
.editor-toolbar > :not(.format-field) {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
@@ -3,12 +3,23 @@
|
||||
"schemaVersion": 1,
|
||||
"id": "de.add-ideas.data-tools",
|
||||
"name": "Data Tools",
|
||||
"version": "0.1.0",
|
||||
"description": "Inspect, query and convert structured data locally in the browser.",
|
||||
"version": "0.2.0",
|
||||
"description": "Inspect, infer, edit, query and loss-aware convert structured data locally.",
|
||||
"entry": "./",
|
||||
"icon": "./favicon.svg",
|
||||
"categories": ["data", "developer", "documents"],
|
||||
"tags": ["json", "yaml", "toml", "xml", "csv", "tsv", "ndjson"],
|
||||
"tags": [
|
||||
"json",
|
||||
"yaml",
|
||||
"toml",
|
||||
"xml",
|
||||
"csv",
|
||||
"tsv",
|
||||
"ndjson",
|
||||
"schema",
|
||||
"convert",
|
||||
"edit"
|
||||
],
|
||||
"integration": {
|
||||
"contextVersion": 1,
|
||||
"launchModes": ["navigate", "new-tab"],
|
||||
@@ -21,9 +32,79 @@
|
||||
"crossOriginIsolated": false,
|
||||
"topLevelContext": false
|
||||
},
|
||||
"io": {
|
||||
"accepts": [
|
||||
{
|
||||
"mediaType": "application/json",
|
||||
"extensions": [".json"],
|
||||
"label": "JSON"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/yaml",
|
||||
"extensions": [".yaml", ".yml"],
|
||||
"label": "YAML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/toml",
|
||||
"extensions": [".toml"],
|
||||
"label": "TOML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/xml",
|
||||
"extensions": [".xml"],
|
||||
"label": "XML"
|
||||
},
|
||||
{
|
||||
"mediaType": "text/csv",
|
||||
"extensions": [".csv", ".tsv"],
|
||||
"label": "CSV and TSV"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/x-ndjson",
|
||||
"extensions": [".ndjson", ".jsonl"],
|
||||
"label": "NDJSON"
|
||||
}
|
||||
],
|
||||
"produces": [
|
||||
{
|
||||
"mediaType": "application/json",
|
||||
"extensions": [".json"],
|
||||
"label": "JSON and inferred JSON Schema"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/yaml",
|
||||
"extensions": [".yaml"],
|
||||
"label": "YAML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/toml",
|
||||
"extensions": [".toml"],
|
||||
"label": "TOML"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/xml",
|
||||
"extensions": [".xml"],
|
||||
"label": "XML"
|
||||
},
|
||||
{
|
||||
"mediaType": "text/csv",
|
||||
"extensions": [".csv", ".tsv"],
|
||||
"label": "CSV and TSV"
|
||||
},
|
||||
{
|
||||
"mediaType": "application/x-ndjson",
|
||||
"extensions": [".ndjson"],
|
||||
"label": "NDJSON"
|
||||
}
|
||||
]
|
||||
},
|
||||
"capabilities": {
|
||||
"required": ["workers"],
|
||||
"optional": []
|
||||
},
|
||||
"privacy": {
|
||||
"processing": "local",
|
||||
"fileUploads": false,
|
||||
"fileUploads": true,
|
||||
"telemetry": false,
|
||||
"label": "Inputs stay in this browser; nothing is uploaded."
|
||||
},
|
||||
|
||||
+1
-1
@@ -1 +1 @@
|
||||
export const APP_VERSION = "0.1.0";
|
||||
export const APP_VERSION = "0.2.0";
|
||||
|
||||
+14
-27
@@ -1,4 +1,5 @@
|
||||
/// <reference lib="webworker" />
|
||||
import { createWorkerJobMessageHandler } from "@add-ideas/toolbox-helpers";
|
||||
import { parseDataDocument } from "../core/parse";
|
||||
import {
|
||||
DataToolsError,
|
||||
@@ -6,29 +7,16 @@ import {
|
||||
type ParseRequest,
|
||||
} from "../core/types";
|
||||
|
||||
interface WorkerRequest {
|
||||
id: number;
|
||||
request: ParseRequest;
|
||||
}
|
||||
|
||||
type WorkerResponse =
|
||||
| { id: number; ok: true; document: ParsedDocument }
|
||||
| {
|
||||
id: number;
|
||||
ok: false;
|
||||
message: string;
|
||||
diagnostics: DataToolsError["diagnostics"];
|
||||
};
|
||||
|
||||
self.onmessage = (event: MessageEvent<WorkerRequest>) => {
|
||||
const { id, request } = event.data;
|
||||
let response: WorkerResponse;
|
||||
try {
|
||||
response = { id, ok: true, document: parseDataDocument(request) };
|
||||
} catch (error) {
|
||||
response = {
|
||||
id,
|
||||
ok: false,
|
||||
self.onmessage = createWorkerJobMessageHandler<
|
||||
ParseRequest,
|
||||
ParsedDocument,
|
||||
never,
|
||||
{ message: string; diagnostics: DataToolsError["diagnostics"] }
|
||||
>(
|
||||
(request) => parseDataDocument(request),
|
||||
(response) => self.postMessage(response),
|
||||
{
|
||||
serializeError: (error) => ({
|
||||
message:
|
||||
error instanceof Error
|
||||
? error.message
|
||||
@@ -46,9 +34,8 @@ self.onmessage = (event: MessageEvent<WorkerRequest>) => {
|
||||
severity: "error",
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
self.postMessage(response);
|
||||
};
|
||||
}),
|
||||
},
|
||||
);
|
||||
|
||||
export {};
|
||||
|
||||
@@ -109,6 +109,32 @@ test("shows a hardened XML error while retaining the last successful model", asy
|
||||
).toBeVisible();
|
||||
});
|
||||
|
||||
test("infers a schema and applies a reviewed exact-number edit", async ({
|
||||
page,
|
||||
}) => {
|
||||
await page.goto("/deep/nested/data/");
|
||||
await expect(page.getByText(/Parsed as JSON/iu)).toBeVisible();
|
||||
await page.getByRole("tab", { name: /Schema & edit/iu }).click();
|
||||
await expect(
|
||||
page.getByRole("heading", { name: "Schema inference" }),
|
||||
).toBeVisible();
|
||||
await expect(page.getByRole("rowheader", { name: "/project" })).toBeVisible();
|
||||
await page.getByLabel(/JSON Pointer/iu).fill("/exactInteger");
|
||||
await page.getByLabel("Value type").selectOption("number");
|
||||
await page
|
||||
.locator(".edit-value-field textarea")
|
||||
.fill("9007199254740993123456790");
|
||||
await page.getByRole("button", { name: "Preview edit" }).click();
|
||||
await expect(
|
||||
page.getByText("No known loss or coercion in this conversion."),
|
||||
).toBeVisible();
|
||||
await page.getByRole("button", { name: "Apply preview to source" }).click();
|
||||
await expect(page.getByTestId("source-editor")).toHaveValue(
|
||||
/9007199254740993123456790/u,
|
||||
);
|
||||
await expect(page.getByText(/Parsed as JSON/iu)).toBeVisible();
|
||||
});
|
||||
|
||||
test("serves the release identity and hardened headers", async ({
|
||||
request,
|
||||
}) => {
|
||||
@@ -124,7 +150,7 @@ test("serves the release identity and hardened headers", async ({
|
||||
const manifest = await request.get("/deep/nested/data/toolbox-app.json");
|
||||
await expect(manifest.json()).resolves.toMatchObject({
|
||||
id: "de.add-ideas.data-tools",
|
||||
version: "0.1.0",
|
||||
version: "0.2.0",
|
||||
entry: "./",
|
||||
});
|
||||
});
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
|
||||
test("keeps the primary workspace inside a narrow viewport", async ({
|
||||
page,
|
||||
}) => {
|
||||
await page.goto("/deep/nested/data/");
|
||||
await expect(page.locator("main").first()).toBeVisible();
|
||||
await expect(
|
||||
page.locator("main .loading, main .workbench-loading"),
|
||||
).toHaveCount(0);
|
||||
|
||||
const widths = await page.evaluate(() => ({
|
||||
content: document.documentElement.scrollWidth,
|
||||
viewport: document.documentElement.clientWidth,
|
||||
}));
|
||||
expect(widths.viewport).toBeLessThanOrEqual(430);
|
||||
expect(widths.content).toBeLessThanOrEqual(widths.viewport + 1);
|
||||
});
|
||||
@@ -9,7 +9,7 @@ async function renderReady() {
|
||||
vi.fn(async () => new Response("Not found", { status: 404 })),
|
||||
);
|
||||
render(<App />);
|
||||
await screen.findByText(/Parsed as JSON/iu, {}, { timeout: 2_000 });
|
||||
await screen.findByText(/Parsed as JSON/iu, {}, { timeout: 4_000 });
|
||||
}
|
||||
|
||||
describe("Data Tools workbench", () => {
|
||||
@@ -31,7 +31,7 @@ describe("Data Tools workbench", () => {
|
||||
await screen.findByText(
|
||||
/Unexpected|invalid|property/iu,
|
||||
{},
|
||||
{ timeout: 2_000 },
|
||||
{ timeout: 4_000 },
|
||||
);
|
||||
await user.click(screen.getByRole("tab", { name: /Tree/iu }));
|
||||
expect(screen.getByText("project")).toBeVisible();
|
||||
|
||||
@@ -0,0 +1,115 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { DATA_ADAPTERS } from "../../src/core/adapters";
|
||||
import { EXPORT_ADAPTERS, convertDocument } from "../../src/core/convert";
|
||||
import { applyNodeEdit, parseEditValue } from "../../src/core/edit";
|
||||
import { normalizeValue } from "../../src/core/model";
|
||||
import { IMPORT_ADAPTERS, parseDataDocument } from "../../src/core/parse";
|
||||
import { inferSchema, serializeSchema } from "../../src/core/schema";
|
||||
import { DATA_FORMATS } from "../../src/core/types";
|
||||
|
||||
describe("modular adapters", () => {
|
||||
it("has an explicit import and export implementation for every descriptor", () => {
|
||||
expect(DATA_ADAPTERS.map((adapter) => adapter.format)).toEqual(
|
||||
DATA_FORMATS,
|
||||
);
|
||||
expect(Object.keys(IMPORT_ADAPTERS)).toEqual([...DATA_FORMATS]);
|
||||
expect(Object.keys(EXPORT_ADAPTERS)).toEqual([...DATA_FORMATS]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("loss-aware schema inference", () => {
|
||||
it("merges record samples, presence and exact numeric representation", () => {
|
||||
const document = parseDataDocument({
|
||||
source:
|
||||
'{"people":[{"id":9007199254740993123456789,"name":"Ada"},{"id":2,"nickname":null}]}',
|
||||
format: "json",
|
||||
});
|
||||
const inference = inferSchema(document.root);
|
||||
expect(inference.fields).toEqual(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
pointer: "/people/*/id",
|
||||
required: true,
|
||||
types: ["integer"],
|
||||
}),
|
||||
expect.objectContaining({ pointer: "/people/*/name", required: false }),
|
||||
expect.objectContaining({
|
||||
pointer: "/people/*/nickname",
|
||||
nullable: true,
|
||||
}),
|
||||
]),
|
||||
);
|
||||
const schema = JSON.parse(serializeSchema(inference)) as Record<
|
||||
string,
|
||||
unknown
|
||||
>;
|
||||
expect(schema.$schema).toBe("https://json-schema.org/draft/2020-12/schema");
|
||||
expect(JSON.stringify(schema)).toContain("9007199254740993123456789");
|
||||
});
|
||||
|
||||
it("enforces the field budget across nested objects", () => {
|
||||
const branch = (prefix: string) =>
|
||||
Object.fromEntries(
|
||||
Array.from({ length: 3_000 }, (_, index) => [
|
||||
`${prefix}${index}`,
|
||||
index,
|
||||
]),
|
||||
);
|
||||
const inference = inferSchema(
|
||||
normalizeValue({ left: branch("a"), right: branch("b") }),
|
||||
);
|
||||
expect(inference.fields).toHaveLength(5_000);
|
||||
expect(inference.truncated).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("reviewable structural editing", () => {
|
||||
const document = parseDataDocument({
|
||||
source: '{"items":[1,2],"name":"before"}',
|
||||
format: "json",
|
||||
});
|
||||
|
||||
it("uses strict scalar syntax and immutable RFC 6901 operations", () => {
|
||||
const replaced = applyNodeEdit(document.root, {
|
||||
operation: "replace",
|
||||
pointer: "/name",
|
||||
value: parseEditValue("string", "after"),
|
||||
});
|
||||
const inserted = applyNodeEdit(replaced, {
|
||||
operation: "add",
|
||||
pointer: "/items/1",
|
||||
value: parseEditValue("number", "9007199254740993123456789"),
|
||||
});
|
||||
expect(
|
||||
convertDocument({ ...document, root: inserted }, "json").text,
|
||||
).toContain("9007199254740993123456789");
|
||||
expect(convertDocument(document, "json").text).toContain(
|
||||
'"name": "before"',
|
||||
);
|
||||
expect(() => parseEditValue("number", "01")).toThrow(/strict JSON/iu);
|
||||
expect(() =>
|
||||
applyNodeEdit(document.root, {
|
||||
operation: "add",
|
||||
pointer: "/__proto__",
|
||||
value: parseEditValue("null", ""),
|
||||
}),
|
||||
).toThrow(/prohibited/iu);
|
||||
});
|
||||
|
||||
it("exposes serialization loss before an edit is applied", () => {
|
||||
const toml = parseDataDocument({
|
||||
source: "answer = 42\n",
|
||||
format: "toml",
|
||||
});
|
||||
const edited = applyNodeEdit(toml.root, {
|
||||
operation: "add",
|
||||
pointer: "/missing",
|
||||
value: parseEditValue("null", ""),
|
||||
});
|
||||
expect(convertDocument({ ...toml, root: edited }, "toml").events).toEqual(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({ code: "toml.null", severity: "loss" }),
|
||||
]),
|
||||
);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user