@shayc/open-board-format 1.3.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +2 -2
- package/package.json +7 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @shayc/open-board-format
|
|
2
2
|
|
|
3
|
+
## 1.3.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 3041ae2: Improve npm presentation: README leads with what the package does, states the measured bundle size (~11 kB min+gzip including fflate), and surfaces AAC Board AI as a production user; package description and keywords expanded for npm search.
|
|
8
|
+
|
|
3
9
|
## 1.3.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
[](https://github.com/shayc/open-board-format/actions/workflows/ci.yml)
|
|
5
5
|
[](LICENSE)
|
|
6
6
|
|
|
7
|
-
A TypeScript toolkit
|
|
7
|
+
A TypeScript toolkit that parses, validates, and creates [Open Board Format](https://www.openboardformat.org/) files — the open standard for Augmentative and Alternative Communication (AAC) boards. OBF (`.obf`) is a JSON file describing a single communication board: buttons, images, sounds, grid layout, metadata. OBZ (`.obz`) is a ZIP archive bundling one or more boards with their media and a `manifest.json`. This package handles both, and powers [AAC Board AI](https://aacboard.app), an offline-first AAC web app.
|
|
8
8
|
|
|
9
9
|
```
|
|
10
10
|
my-board.obz
|
|
@@ -21,7 +21,7 @@ my-board.obz
|
|
|
21
21
|
- **Browser and Node.js 22+** — pure ESM, works against `File`, `Blob`, `ArrayBuffer`, or any typed-array view (e.g. Node's `Buffer`).
|
|
22
22
|
- **One entry point for either format** — `loadBoard` sniffs the bytes and tells you whether it found an `.obf` board or an `.obz` package.
|
|
23
23
|
- **Spec-faithful round trips** — unknown fields are preserved rather than stripped, so vendor extensions allowed by the OBF spec survive `parseOBF` → `stringifyOBF`.
|
|
24
|
-
- **Small footprint** —
|
|
24
|
+
- **Small footprint** — ~11 kB min+gzip including the single runtime dependency ([fflate](https://github.com/101arrowz/fflate)); Zod is a peer, and the package is tree-shakeable with no side effects.
|
|
25
25
|
|
|
26
26
|
**Contents:** [Install](#install) · [Quick start](#quick-start) · [Usage](#usage) · [API](#api) · [Errors](#errors) · [Security](#security) · [Scope](#scope) · [Versioning](#versioning) · [Contributing](#contributing) · [Related](#related) · [License](#license)
|
|
27
27
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shayc/open-board-format",
|
|
3
|
-
"version": "1.3.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.3.1",
|
|
4
|
+
"description": "Parse, validate, and create Open Board Format (.obf/.obz) files — the open standard for Augmentative and Alternative Communication (AAC) boards. TypeScript, browser and Node.js.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Shay Cojocaru <shayc@outlook.com>",
|
|
7
7
|
"homepage": "https://github.com/shayc/open-board-format#readme",
|
|
@@ -16,10 +16,14 @@
|
|
|
16
16
|
"aac",
|
|
17
17
|
"aac-board",
|
|
18
18
|
"assistive-technology",
|
|
19
|
+
"augmentative-alternative-communication",
|
|
19
20
|
"communication-board",
|
|
20
21
|
"obf",
|
|
21
22
|
"obz",
|
|
22
|
-
"open-board-format"
|
|
23
|
+
"open-board-format",
|
|
24
|
+
"parser",
|
|
25
|
+
"validator",
|
|
26
|
+
"zod"
|
|
23
27
|
],
|
|
24
28
|
"type": "module",
|
|
25
29
|
"sideEffects": false,
|