Compare commits
1 Commits
a9c31c8986
...
v0.6.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 5c052bc6d1 |
@@ -4,5 +4,5 @@ TRAEFIK_NETWORK=internal
|
||||
TRAEFIK_CERT_RESOLVER=netcup
|
||||
|
||||
# Keep these two values paired when deploying a newer published toolbox release.
|
||||
TOOLBOX_RELEASE_VERSION=0.5.0
|
||||
TOOLBOX_RELEASE_SHA256=375eccf44d8294839ae71f5fd54677f7771e7d865a23d447aebab7aeb40020a1
|
||||
TOOLBOX_RELEASE_VERSION=0.6.0
|
||||
TOOLBOX_RELEASE_SHA256=aa01a0dfd6681c6d94f00c5a83ddf9898f7393e3dc476d491680884d806fbaa0
|
||||
|
||||
@@ -2,8 +2,8 @@ ARG NGINX_IMAGE=nginxinc/nginx-unprivileged:1.31.3-alpine@sha256:18d67281256ded3
|
||||
|
||||
FROM ${NGINX_IMAGE} AS release
|
||||
|
||||
ARG TOOLBOX_RELEASE_VERSION=0.5.0
|
||||
ARG TOOLBOX_RELEASE_SHA256=375eccf44d8294839ae71f5fd54677f7771e7d865a23d447aebab7aeb40020a1
|
||||
ARG TOOLBOX_RELEASE_VERSION=0.6.0
|
||||
ARG TOOLBOX_RELEASE_SHA256=aa01a0dfd6681c6d94f00c5a83ddf9898f7393e3dc476d491680884d806fbaa0
|
||||
ARG TOOLBOX_RELEASE_BASE_URL=https://git.add-ideas.de/zemion/toolbox-portal/releases/download
|
||||
|
||||
RUN set -eu; \
|
||||
@@ -22,6 +22,7 @@ RUN set -eu; \
|
||||
test -f /tmp/toolbox/apps/xslt/toolbox-app.json; \
|
||||
test -f /tmp/toolbox/apps/onenote/toolbox-app.json; \
|
||||
test -f /tmp/toolbox/apps/av/toolbox-app.json; \
|
||||
test -f /tmp/toolbox/apps/regex/toolbox-app.json; \
|
||||
rm "/tmp/${archive}"
|
||||
|
||||
FROM ${NGINX_IMAGE}
|
||||
|
||||
40
README.md
40
README.md
@@ -1,7 +1,7 @@
|
||||
# add·ideas Toolbox Portal
|
||||
|
||||
`toolbox-portal` is the static launcher and release assembler for the add·ideas
|
||||
browser toolbox. Version `0.2.4` reads one same-origin catalogue, shows each app
|
||||
browser toolbox. Version `0.2.5` reads one same-origin catalogue, shows each app
|
||||
as a compact launch tile, and keeps personal pins, drag-and-drop ordering,
|
||||
visibility, and appearance in the current browser. Pinned tools have their own
|
||||
section; search, category, and clickable tag filters stay close to the tool
|
||||
@@ -36,7 +36,8 @@ the SDK and portal together.
|
||||
|
||||
Vite uses `base: './'`, so the built portal works at `/` or a nested static path.
|
||||
The development catalogue at `public/toolbox.catalog.json` points to assembled
|
||||
paths (`./apps/pdf/`, `./apps/xslt/`, `./apps/onenote/`, and `./apps/av/`).
|
||||
paths (`./apps/pdf/`, `./apps/xslt/`, `./apps/onenote/`, `./apps/av/`, and
|
||||
`./apps/regex/`).
|
||||
Those manifests will correctly appear as unavailable until an assembled release
|
||||
is being served.
|
||||
|
||||
@@ -68,7 +69,7 @@ privacy and executable-code warning. Light, dark, and system modes are supported
|
||||
## Production deployment behind Traefik
|
||||
|
||||
The committed `compose.yaml` is the shortest production path. Its release
|
||||
container downloads the immutable Toolbox 0.5.0 ZIP during the image build,
|
||||
container downloads the immutable Toolbox 0.6.0 ZIP during the image build,
|
||||
verifies SHA-256 before extracting it, and then copies only the verified static
|
||||
files into the pinned unprivileged nginx image. Node.js and a local portal
|
||||
assembly are not required on the deployment host.
|
||||
@@ -119,9 +120,11 @@ The app release should also publish a matching `.sha256` sidecar. The manifest
|
||||
must declare the pinned reverse-DNS id and version. Application and portal
|
||||
versions are independent.
|
||||
|
||||
`release/toolbox.lock.json` is the reviewed v0.5.0 lock. Its URLs and checksums
|
||||
`release/toolbox.lock.json` is the reviewed v0.6.0 lock. Its URLs and checksums
|
||||
pin the published PDF Tools 0.4.3, XSLT Tools 0.4.2, OneNote Tools 0.3.3, and
|
||||
Audio & Video Tools 0.1.0 release bytes. Use
|
||||
Audio & Video Tools 0.1.0 and Regex Tools 0.1.0 release bytes. Regex Tools
|
||||
v0.1.0 is the open-source, ECMAScript-only first flavour; later regex flavours
|
||||
remain separate roadmap work. Use
|
||||
`release/toolbox.lock.example.json` as the template for a future release and
|
||||
verify every downloaded asset before committing updated values. Artifacts may be:
|
||||
|
||||
@@ -142,7 +145,7 @@ npm run assemble -- \
|
||||
--lock release/toolbox.lock.json \
|
||||
--portal-dist dist \
|
||||
--output build/toolbox \
|
||||
--archive build/add-ideas-toolbox-0.5.0.zip
|
||||
--archive build/add-ideas-toolbox-0.6.0.zip
|
||||
```
|
||||
|
||||
Existing output is refused. Pass `--force` only when replacing those exact
|
||||
@@ -161,10 +164,11 @@ build/toolbox/
|
||||
├── pdf/
|
||||
├── xslt/
|
||||
├── onenote/
|
||||
└── av/
|
||||
├── av/
|
||||
└── regex/
|
||||
|
||||
build/add-ideas-toolbox-0.5.0.zip
|
||||
build/add-ideas-toolbox-0.5.0.zip.sha256
|
||||
build/add-ideas-toolbox-0.6.0.zip
|
||||
build/add-ideas-toolbox-0.6.0.zip.sha256
|
||||
```
|
||||
|
||||
The assembler verifies SHA-256 before opening an artifact, validates every app
|
||||
@@ -185,7 +189,7 @@ directory separately:
|
||||
```sh
|
||||
npm run package:static -- \
|
||||
--input build/toolbox \
|
||||
--output artifacts/add-ideas-toolbox-0.5.0.zip
|
||||
--output artifacts/add-ideas-toolbox-0.6.0.zip
|
||||
```
|
||||
|
||||
This also emits a `.sha256` sidecar.
|
||||
@@ -203,9 +207,9 @@ normal local XML/XSLT transformations do not require that permission.
|
||||
|
||||
```sh
|
||||
podman build -f Containerfile \
|
||||
-t git.add-ideas.de/zemion/toolbox:0.5.0 .
|
||||
-t git.add-ideas.de/zemion/toolbox:0.6.0 .
|
||||
podman run --rm -p 8080:8080 \
|
||||
git.add-ideas.de/zemion/toolbox:0.5.0
|
||||
git.add-ideas.de/zemion/toolbox:0.6.0
|
||||
```
|
||||
|
||||
For a direct-port local deployment after assembly, use the separate example:
|
||||
@@ -222,8 +226,8 @@ docker login git.add-ideas.de
|
||||
docker buildx build \
|
||||
--platform linux/amd64,linux/arm64 \
|
||||
--file Containerfile.release \
|
||||
--tag git.add-ideas.de/zemion/toolbox:0.5.0 \
|
||||
--tag git.add-ideas.de/zemion/toolbox:0.5 \
|
||||
--tag git.add-ideas.de/zemion/toolbox:0.6.0 \
|
||||
--tag git.add-ideas.de/zemion/toolbox:0.6 \
|
||||
--push .
|
||||
```
|
||||
|
||||
@@ -245,11 +249,11 @@ needs permission to push code, releases, and container packages to
|
||||
3. Verify downloaded app assets with `sha256sum -c <asset>.sha256`; copy those
|
||||
exact values into a reviewed toolbox lock.
|
||||
4. Run the assembler and serve `build/toolbox` from a nested test path. Open
|
||||
all four apps, switch between them, and confirm the encoded `toolbox`
|
||||
all five apps, switch between them, and confirm the encoded `toolbox`
|
||||
context.
|
||||
5. Verify the distribution with
|
||||
`(cd build && sha256sum -c add-ideas-toolbox-0.5.0.zip.sha256)`.
|
||||
6. Commit the reviewed lock, tag the toolbox release (for example `v0.5.0`), and
|
||||
`(cd build && sha256sum -c add-ideas-toolbox-0.6.0.zip.sha256)`.
|
||||
6. Commit the reviewed lock, tag the toolbox release (for example `v0.6.0`), and
|
||||
push the branch and tag to Gitea.
|
||||
7. In Gitea, open **Releases → New release**, select the tag, and upload the
|
||||
static ZIP plus its `.sha256` file. Do not use a mutable “latest” URL in a
|
||||
@@ -270,6 +274,7 @@ must not re-resolve app versions or substitute a newer release.
|
||||
| **`xslt-tools`** | Existing; dedicated repository | Develop, test and run XSLT transformations | XML/XSLT editors; transformation results; local files; saved projects; validation and diagnostics | Lazy SaxonJS loading; relocatable assets; useful handoffs to `data-tools`, `schema-tools` and `diff-tools` |
|
||||
| **`onenote-tools`** | Existing rich-reader release; dedicated repository | Open, browse, inspect and export OneNote sections and packages locally | Desktop/unfragmented FSSHTTPB `.one`/`.onetoc2`; none/LZX/MSZIP/Quantum and multi-cabinet `.onepkg`; trees, rich text, images, tables, ink, attachments and export | Native TypeScript worker with no Wasm; bounded parsing, rendering and export; fragmented FSSHTTP fails safely; no editing or pixel-perfect fidelity |
|
||||
| **`av-tools`** | Existing local-first v0.1.0 release; dedicated repository | Convert and lightly edit audio and video locally in the browser | Quick conversion; trim, split and concatenate; crop, resize, normalize, fades, waveform, metadata, chapters, subtitles, thumbnails, contact sheets, presets and export | Self-hosted ffmpeg.wasm 0.12.10 ST/MT cores; bounded queue, temporary storage and resource policy; isolation enables MT with automatic ST fallback; semver-versioned core assets are immutable |
|
||||
| **`regex-tools`** | Existing local-first v0.1.0 release; dedicated repository | Develop, explain, test and apply ECMAScript regular expressions | Deterministic syntax tree; native matching and exact captures; replacement and list previews; unit-test suites; project import, export and optional local persistence | Open-source regexpp parser and native browser engine in killable workers; explicit resource/presentation limits; ECMAScript-only first flavour; later engines remain roadmap work |
|
||||
|
||||
## Planned tools
|
||||
|
||||
@@ -283,7 +288,6 @@ must not re-resolve app versions or substitute a newer release.
|
||||
| **`midi-tools`** | Medium specialist app | MIDI event inspection and editing; transpose, quantize, tempo maps and controller data; device access should remain optional | |
|
||||
| **`3d-tools`** | Large specialist app | Inspect STL, OBJ and glTF; dimensions, bounding boxes, mesh simplification and common geometry defects; worker/GPU use and file limits | |
|
||||
| **`query-tools`** | High-value but large; dedicated repository | Analyse local tabular and relational data with SQL | CSV, JSON, NDJSON, Parquet and SQLite; schema inference; joins; aggregation; pivots; charts; export to common data formats | WASM memory and streaming; distinguish this analytical product from document-oriented `data-tools`; query work must remain local |
|
||||
| **`regex-tools`** | Planned; dedicated repository | Develop, test and apply regular expressions | Corpus mode; replacement preview; capture table; flavour comparison; performance visualization; generated test cases; failing-input minimization | Never claim exact equivalence across regex engines without qualification; bound execution; integrate with `text-tools`, `log-tools` and `minimize-tools` |
|
||||
| **`epub-tools`** | Medium app | EPUB inspection, metadata and cover editing, link validation, chapter extraction and structural repair; sanitize embedded HTML and SVG | |
|
||||
| **`scan-tools`** | Large app | Camera/document correction; crop, deskew and threshold; page assembly; local OCR; PDF output; model downloads and memory use must be explicit | |
|
||||
| **`office-tools`** | Medium-to-large app | Inspect rather than reproduce an office suite: package structure, relationships, metadata, comments, embedded images and basic repairs | |
|
||||
|
||||
@@ -3,7 +3,7 @@ services:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Containerfile
|
||||
image: git.add-ideas.de/zemion/toolbox:0.5.0
|
||||
image: git.add-ideas.de/zemion/toolbox:0.6.0
|
||||
restart: unless-stopped
|
||||
read_only: true
|
||||
ports:
|
||||
|
||||
@@ -6,9 +6,9 @@ services:
|
||||
context: .
|
||||
dockerfile: Containerfile.release
|
||||
args:
|
||||
TOOLBOX_RELEASE_VERSION: "${TOOLBOX_RELEASE_VERSION:-0.5.0}"
|
||||
TOOLBOX_RELEASE_SHA256: "${TOOLBOX_RELEASE_SHA256:-375eccf44d8294839ae71f5fd54677f7771e7d865a23d447aebab7aeb40020a1}"
|
||||
image: "git.add-ideas.de/zemion/toolbox:${TOOLBOX_RELEASE_VERSION:-0.5.0}"
|
||||
TOOLBOX_RELEASE_VERSION: "${TOOLBOX_RELEASE_VERSION:-0.6.0}"
|
||||
TOOLBOX_RELEASE_SHA256: "${TOOLBOX_RELEASE_SHA256:-aa01a0dfd6681c6d94f00c5a83ddf9898f7393e3dc476d491680884d806fbaa0}"
|
||||
image: "git.add-ideas.de/zemion/toolbox:${TOOLBOX_RELEASE_VERSION:-0.6.0}"
|
||||
restart: unless-stopped
|
||||
read_only: true
|
||||
tmpfs:
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@add-ideas/toolbox-portal",
|
||||
"version": "0.2.4",
|
||||
"version": "0.2.5",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@add-ideas/toolbox-portal",
|
||||
"version": "0.2.4",
|
||||
"version": "0.2.5",
|
||||
"license": "AGPL-3.0-only",
|
||||
"dependencies": {
|
||||
"@add-ideas/toolbox-contract": "^0.2.2",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@add-ideas/toolbox-portal",
|
||||
"version": "0.2.4",
|
||||
"version": "0.2.5",
|
||||
"license": "AGPL-3.0-only",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Corresponding source
|
||||
|
||||
The source code corresponding to add·ideas Toolbox Portal 0.2.4 is available at:
|
||||
The source code corresponding to add·ideas Toolbox Portal 0.2.5 is available at:
|
||||
|
||||
https://git.add-ideas.de/zemion/toolbox-portal/src/tag/v0.5.0
|
||||
https://git.add-ideas.de/zemion/toolbox-portal/src/tag/v0.6.0
|
||||
|
||||
Each bundled application contains its own `SOURCE.md`, license, and third-party
|
||||
license materials. The application sources are also linked from the portal.
|
||||
|
||||
@@ -24,6 +24,10 @@
|
||||
{
|
||||
"manifest": "./apps/av/toolbox-app.json",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"manifest": "./apps/regex/toolbox-app.json",
|
||||
"enabled": true
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"$schema": "./toolbox-release-lock.schema.json",
|
||||
"schemaVersion": 1,
|
||||
"releaseVersion": "0.5.0",
|
||||
"portalVersion": "0.2.4",
|
||||
"releaseVersion": "0.6.0",
|
||||
"portalVersion": "0.2.5",
|
||||
"catalogue": {
|
||||
"id": "de.add-ideas.toolbox",
|
||||
"name": "add·ideas Toolbox",
|
||||
@@ -40,6 +40,13 @@
|
||||
"artifact": "https://git.add-ideas.de/zemion/av-tools/releases/download/v0.1.0/av-tools-0.1.0.zip",
|
||||
"sha256": "a10889f80f8e30a71737125d8c05d3ff0264249726845700ab95bf37feb64595",
|
||||
"target": "av"
|
||||
},
|
||||
{
|
||||
"id": "de.add-ideas.regex-tools",
|
||||
"version": "0.1.0",
|
||||
"artifact": "https://git.add-ideas.de/zemion/regex-tools/releases/download/v0.1.0/regex-tools-0.1.0.zip",
|
||||
"sha256": "6d93fbc4baaad0decce939c020afc2edc011038d8f998b333373d55634e5487c",
|
||||
"target": "regex"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"$schema": "./toolbox-release-lock.schema.json",
|
||||
"schemaVersion": 1,
|
||||
"releaseVersion": "0.5.0",
|
||||
"portalVersion": "0.2.4",
|
||||
"releaseVersion": "0.6.0",
|
||||
"portalVersion": "0.2.5",
|
||||
"catalogue": {
|
||||
"id": "de.add-ideas.toolbox",
|
||||
"name": "add·ideas Toolbox",
|
||||
@@ -40,6 +40,13 @@
|
||||
"artifact": "https://git.add-ideas.de/zemion/av-tools/releases/download/v0.1.0/av-tools-0.1.0.zip",
|
||||
"sha256": "a10889f80f8e30a71737125d8c05d3ff0264249726845700ab95bf37feb64595",
|
||||
"target": "av"
|
||||
},
|
||||
{
|
||||
"id": "de.add-ideas.regex-tools",
|
||||
"version": "0.1.0",
|
||||
"artifact": "https://git.add-ideas.de/zemion/regex-tools/releases/download/v0.1.0/regex-tools-0.1.0.zip",
|
||||
"sha256": "6d93fbc4baaad0decce939c020afc2edc011038d8f998b333373d55634e5487c",
|
||||
"target": "regex"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -83,7 +83,7 @@ function makeLock(artifact: string, sha256: string) {
|
||||
return {
|
||||
schemaVersion: 1,
|
||||
releaseVersion: '0.1.0',
|
||||
portalVersion: '0.2.4',
|
||||
portalVersion: '0.2.5',
|
||||
catalogue: {
|
||||
id: 'de.add-ideas.toolbox',
|
||||
name: 'Test Toolbox',
|
||||
|
||||
@@ -82,7 +82,7 @@ describe('production deployment', () => {
|
||||
expect(containerfile).toContain(
|
||||
'COPY --from=release --chown=101:101 /tmp/toolbox/'
|
||||
);
|
||||
for (const app of ['pdf', 'xslt', 'onenote', 'av']) {
|
||||
for (const app of ['pdf', 'xslt', 'onenote', 'av', 'regex']) {
|
||||
expect(containerfile).toContain(
|
||||
`test -f /tmp/toolbox/apps/${app}/toolbox-app.json`
|
||||
);
|
||||
|
||||
@@ -121,6 +121,33 @@ describe('portal UI', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('uses the compact Regex presentation for the released tool', async () => {
|
||||
vi.stubGlobal(
|
||||
'fetch',
|
||||
vi.fn(
|
||||
catalogueFetch({
|
||||
'/toolbox.catalog.json': Response.json({
|
||||
...catalogue,
|
||||
apps: [
|
||||
...catalogue.apps,
|
||||
{ manifest: './apps/regex/toolbox-app.json', enabled: true },
|
||||
],
|
||||
}),
|
||||
})
|
||||
)
|
||||
);
|
||||
render(<App />);
|
||||
|
||||
await findToolLink();
|
||||
const card = screen.getByTestId('app-card-de.add-ideas.regex-tools');
|
||||
expect(within(card).getByRole('heading', { level: 3 })).toHaveTextContent(
|
||||
'Regex'
|
||||
);
|
||||
expect(
|
||||
within(card).getByText('Explain and test regex locally.')
|
||||
).toBeVisible();
|
||||
});
|
||||
|
||||
it('moves the full disclosure into an accessible modal', async () => {
|
||||
vi.stubGlobal('fetch', vi.fn(catalogueFetch()));
|
||||
const user = userEvent.setup();
|
||||
|
||||
@@ -489,9 +489,9 @@ export default function App() {
|
||||
</span>
|
||||
</p>
|
||||
<span>
|
||||
Portal v0.2.4 ·{' '}
|
||||
Portal v0.2.5 ·{' '}
|
||||
<a
|
||||
href="https://git.add-ideas.de/zemion/toolbox-portal/src/tag/v0.5.0"
|
||||
href="https://git.add-ideas.de/zemion/toolbox-portal/src/tag/v0.6.0"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
|
||||
@@ -65,6 +65,28 @@ export const onenoteManifest: ToolboxAppManifest = {
|
||||
},
|
||||
};
|
||||
|
||||
export const regexManifest: ToolboxAppManifest = {
|
||||
...pdfManifest,
|
||||
id: 'de.add-ideas.regex-tools',
|
||||
name: 'Regex Tools',
|
||||
version: '0.1.0',
|
||||
description:
|
||||
'Develop, explain, test and apply regular expressions locally in the browser.',
|
||||
icon: './regex.svg',
|
||||
categories: ['developer', 'text', 'regex'],
|
||||
tags: ['regular-expression', 'match', 'replace', 'explain', 'test'],
|
||||
requirements: {
|
||||
secureContext: false,
|
||||
workers: true,
|
||||
indexedDb: true,
|
||||
crossOriginIsolated: false,
|
||||
},
|
||||
source: {
|
||||
repository: 'https://git.add-ideas.de/zemion/regex-tools',
|
||||
license: 'GPL-3.0-or-later',
|
||||
},
|
||||
};
|
||||
|
||||
export const catalogue: ToolboxCatalog = {
|
||||
schemaVersion: 1,
|
||||
id: 'de.add-ideas.toolbox',
|
||||
@@ -94,6 +116,8 @@ export function catalogueFetch(overrides: Record<string, Response> = {}) {
|
||||
return Response.json(xsltManifest);
|
||||
if (url.pathname.endsWith('/apps/onenote/toolbox-app.json'))
|
||||
return Response.json(onenoteManifest);
|
||||
if (url.pathname.endsWith('/apps/regex/toolbox-app.json'))
|
||||
return Response.json(regexManifest);
|
||||
return new Response('Not found', { status: 404 });
|
||||
};
|
||||
}
|
||||
|
||||
@@ -13,6 +13,10 @@ const PRESENTATION: Record<string, { title: string; description: string }> = {
|
||||
title: 'OneNote',
|
||||
description: 'Open OneNote files locally.',
|
||||
},
|
||||
'de.add-ideas.regex-tools': {
|
||||
title: 'Regex',
|
||||
description: 'Explain and test regex locally.',
|
||||
},
|
||||
};
|
||||
|
||||
export function shortToolTitle(app: ResolvedApp): string {
|
||||
|
||||
Reference in New Issue
Block a user