open-board-format 1.0.1 → 1.0.2

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.
Files changed (2) hide show
  1. package/README.md +3 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,9 +12,8 @@ A type-safe toolkit to parse, validate, and create Open Board Format (OBF/OBZ) f
12
12
 
13
13
  ## Features
14
14
 
15
- - **Parse & Validate:** Parse OBF boards from JSON strings, objects, or `File` handles.
16
- - **Create & Extract:** Create and extract OBZ packages (ZIP archives with boards, images, and sounds).
17
- - **Spec-Compliant Coercion:** Numeric IDs are coerced to strings, empty strings become `undefined`, and UTF-8 BOM is handled automatically.
15
+ - **Parse & Validate:** Parse and validate OBF boards from JSON strings, objects, or `File` handles.
16
+ - **Create & Extract:** Serialize boards to JSON, and create or extract OBZ packages (ZIP archives with boards, images, and sounds).
18
17
  - **Zod Schemas:** Every OBF type has a corresponding [Zod](https://zod.dev/) schema for runtime validation or API contracts, with full TypeScript types inferred directly.
19
18
 
20
19
  ## Install
@@ -121,8 +120,6 @@ if (result.success) {
121
120
 
122
121
  ### Types
123
122
 
124
- Every type has a companion Zod schema export (e.g., `OBFBoard` → `OBFBoardSchema`).
125
-
126
123
  | Type | Description |
127
124
  | --------------------- | ----------------------------------------------------------------------- |
128
125
  | `OBFBoard` | A single communication board |
@@ -134,7 +131,7 @@ Every type has a companion Zod schema export (e.g., `OBFBoard` → `OBFBoardSche
134
131
  | `OBFLoadBoard` | Reference to load another board |
135
132
  | `OBFMedia` | Common media properties (base for `OBFImage` and `OBFSound`) |
136
133
  | `OBFImage` | An image resource (extends `OBFMedia`) |
137
- | `OBFSound` | A sound resource |
134
+ | `OBFSound` | A sound resource (extends `OBFMedia`) |
138
135
  | `OBFSymbolInfo` | Symbol set reference |
139
136
  | `OBFManifest` | OBZ package manifest |
140
137
  | `ParsedOBZ` | Return type of `extractOBZ` / `loadOBZ` — `{ manifest, boards, files }` |
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "open-board-format",
3
3
  "type": "module",
4
- "version": "1.0.1",
4
+ "version": "1.0.2",
5
5
  "description": "Parse, validate, and create Open Board Format (OBF/OBZ) files for AAC applications.",
6
6
  "author": "Shay Cojocaru <shayc@outlook.com>",
7
7
  "license": "MIT",