@shayc/open-board-format 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shay Cojocaru
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,160 @@
+# @shayc/open-board-format
+
+[![npm version](https://img.shields.io/npm/v/@shayc/open-board-format)](https://www.npmjs.com/package/@shayc/open-board-format)
+[![license](https://img.shields.io/npm/l/@shayc/open-board-format)](LICENSE)
+
+A type-safe toolkit to parse, validate, and create Open Board Format (OBF/OBZ) files for Augmentative and Alternative Communication (AAC) applications.
+
+[Open Board Format](https://www.openboardformat.org/) is an open standard for representing AAC communication boards. It defines two file types:
+
+- **OBF** (`.obf`) — A JSON file describing a single communication board (buttons, images, sounds, grid layout, metadata).
+- **OBZ** (`.obz`) — A ZIP archive containing one or more `.obf` boards along with their associated media and a `manifest.json`.
+
+## Features
+
+- **Parse & Validate:** Parse and validate OBF boards from JSON strings, objects, or `File` handles.
+- **Create & Extract:** Serialize boards to JSON, and create or extract OBZ packages (ZIP archives with boards, images, and sounds).
+- **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.
+
+## Install
+
+```bash
+npm install @shayc/open-board-format
+```
+
+## Quick start
+
+### Parse a single board (OBF)
+
+```ts
+import { parseOBF, validateOBF, loadOBF } from "@shayc/open-board-format";
+
+// Parse from a JSON string
+const board = parseOBF(jsonString);
+console.log(board.name); // "My Board"
+
+// Validate an unknown object (throws on failure)
+const validated = validateOBF(untrustedData);
+
+// Load from a browser File object
+const fromFile = await loadOBF(file);
+```
+
+### Extract an OBZ package
+
+```ts
+import { loadOBZ, extractOBZ } from "@shayc/open-board-format";
+
+// From a File (e.g. drag-and-drop)
+const { manifest, boards, resources } = await loadOBZ(file);
+
+// Or from an ArrayBuffer (e.g. fetch response)
+const parsed = await extractOBZ(buffer);
+
+// Access boards and resources
+const homeBoard = parsed.boards.get("1");
+const imageBytes = parsed.resources.get("images/logo.png");
+```
+
+### Create an OBZ package
+
+```ts
+import { createOBZ } from "@shayc/open-board-format";
+import type { OBFBoard } from "@shayc/open-board-format";
+
+const boards: OBFBoard[] = [
+  {
+    format: "open-board-0.1",
+    id: "board-1",
+    buttons: [{ id: "btn-1", label: "Hello" }],
+    grid: { rows: 1, columns: 1, order: [["btn-1"]] },
+  },
+];
+
+const pngBytes = new Uint8Array(/* ... */);
+const resources = new Map([["images/logo.png", pngBytes]]);
+const blob = await createOBZ(boards, "board-1", resources);
+```
+
+### Use Zod schemas directly
+
+```ts
+import { OBFBoardSchema } from "@shayc/open-board-format";
+
+const result = OBFBoardSchema.safeParse(data);
+
+if (result.success) {
+  console.log(result.data.buttons);
+} else {
+  console.error(result.error.issues);
+}
+```
+
+## API
+
+### OBF (single board)
+
+| Function              | Description                                                  |
+| --------------------- | ------------------------------------------------------------ |
+| `parseOBF(json)`      | Parse a JSON string into a validated `OBFBoard`              |
+| `validateOBF(data)`   | Validate an unknown object as `OBFBoard` (throws on failure) |
+| `stringifyOBF(board)` | Serialize an `OBFBoard` to a JSON string                     |
+| `loadOBF(file)`       | Load an `OBFBoard` from a browser `File`                     |
+
+### OBZ (board package)
+
+| Function                                | Description                                                   |
+| --------------------------------------- | ------------------------------------------------------------- |
+| `loadOBZ(file)`                         | Load an OBZ package from a browser `File`                     |
+| `extractOBZ(archive)`                   | Extract boards, manifest, and resources from an `ArrayBuffer` |
+| `createOBZ(boards, rootId, resources?)` | Create an OBZ package as a `Blob`                             |
+| `parseManifest(json)`                   | Parse a `manifest.json` string into a validated `OBFManifest` |
+
+### Utilities
+
+| Function        | Description                                              |
+| --------------- | -------------------------------------------------------- |
+| `isZip(archive)` | Check if an `ArrayBuffer` starts with a ZIP magic number |
+| `zip(entries)`   | Create a ZIP from a map of paths to buffers              |
+| `unzip(archive)` | Extract a ZIP into a map of paths to `Uint8Array`        |
+
+### Types
+
+| Type                  | Description                                                             |
+| --------------------- | ----------------------------------------------------------------------- |
+| `OBFBoard`            | A single communication board                                            |
+| `OBFGrid`             | Grid layout (rows, columns, order)                                      |
+| `OBFButton`           | A button on the board                                                   |
+| `OBFButtonAction`     | Button action (spelling or specialty)                                   |
+| `OBFSpellingAction`   | Spelling action (e.g., `+s`)                                            |
+| `OBFSpecialtyAction`  | Specialty action (e.g., `:clear`)                                       |
+| `OBFLoadBoard`        | Reference to load another board                                         |
+| `OBFMedia`            | Common media properties (base for `OBFImage` and `OBFSound`)            |
+| `OBFImage`            | An image resource (extends `OBFMedia`)                                  |
+| `OBFSound`            | A sound resource (extends `OBFMedia`)                                   |
+| `OBFSymbolInfo`       | Symbol set reference                                                    |
+| `OBFManifest`         | OBZ package manifest                                                    |
+| `ParsedOBZ`           | Return type of `extractOBZ` / `loadOBZ` — `{ manifest, boards, resources }` |
+| `OBFID`               | Unique identifier (string, coerced from number)                         |
+| `OBFFormatVersion`    | Format version string (e.g., `open-board-0.1`)                          |
+| `OBFLicense`          | Licensing information                                                   |
+| `OBFLocaleCode`       | BCP 47 locale code                                                      |
+| `OBFLocalizedStrings` | Key-value string translations                                           |
+| `OBFStrings`          | Multi-locale string translations                                        |
+
+## Development
+
+```bash
+npm install       # Install dependencies
+npm test          # Run tests (vitest)
+npm run build     # Build for production (tsdown)
+npm run typecheck # Type-check without emitting
+```
+
+## Related
+
+- [Open Board Format specification](https://www.openboardformat.org/docs) — Official standard and format documentation
+
+## License
+
+[MIT](LICENSE) © Shay Cojocaru

package/dist/index.d.mts

@@ -0,0 +1,436 @@
+import { z } from "zod";
+
+//#region src/schema.d.ts
+/**
+* Open Board Format (OBF) Zod Schemas
+*
+* These schemas represent the Open Board Format, designed for sharing communication boards and board sets
+* between Augmentative and Alternative Communication (AAC) applications.
+*
+* Official OBF specification: https://www.openboardformat.org/docs
+*
+* @author Shay Cojocaru
+* @license MIT
+*/
+/** Unique board-element identifier, coerced to a non-empty string. */
+declare const OBFIDSchema: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+type OBFID = z.infer<typeof OBFIDSchema>;
+/**
+ * Format version of the Open Board Format, e.g., 'open-board-0.1'.
+ */
+declare const OBFFormatVersionSchema: z.ZodString;
+type OBFFormatVersion = z.infer<typeof OBFFormatVersionSchema>;
+/**
+ * Locale code as per BCP 47 language tags, e.g., 'en', 'en-US', 'fr-CA'.
+ */
+declare const OBFLocaleCodeSchema: z.ZodString;
+type OBFLocaleCode = z.infer<typeof OBFLocaleCodeSchema>;
+/**
+ * Key–value pairs mapping symbolic names to their translations in a single locale.
+ */
+declare const OBFLocalizedStringsSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+type OBFLocalizedStrings = z.infer<typeof OBFLocalizedStringsSchema>;
+/**
+ * Locale-keyed dictionary of translated strings,
+ * e.g., `{ en: { greeting: "Hello" }, fr: { greeting: "Bonjour" } }`.
+ */
+declare const OBFStringsSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>;
+type OBFStrings = z.infer<typeof OBFStringsSchema>;
+/**
+ * Spelling action: a `+` prefix followed by the text to append,
+ * e.g., `"+hello"`.
+ */
+declare const OBFSpellingActionSchema: z.ZodString;
+type OBFSpellingAction = z.infer<typeof OBFSpellingActionSchema>;
+/**
+ * Specialty action prefixed with `:`, e.g., `":clear"`.
+ * Custom extensions use the `:ext_` prefix.
+ */
+declare const OBFSpecialtyActionSchema: z.ZodString;
+type OBFSpecialtyAction = z.infer<typeof OBFSpecialtyActionSchema>;
+/**
+ * Union of spelling and specialty actions that a button can trigger.
+ */
+declare const OBFButtonActionSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+type OBFButtonAction = z.infer<typeof OBFButtonActionSchema>;
+/**
+ * License terms and attribution for a resource.
+ */
+declare const OBFLicenseSchema: z.ZodObject<{
+  type: z.ZodString;
+  copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  author_name: z.ZodOptional<z.ZodString>;
+  author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+}, z.core.$loose>;
+type OBFLicense = z.infer<typeof OBFLicenseSchema>;
+/**
+ * Common properties for media resources (images and sounds).
+ *
+ * When multiple references are provided, they should be used in the following order:
+ * 1. data
+ * 2. path
+ * 3. url
+ */
+declare const OBFMediaSchema: z.ZodObject<{
+  id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+  data: z.ZodOptional<z.ZodString>;
+  path: z.ZodOptional<z.ZodString>;
+  data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  content_type: z.ZodOptional<z.ZodString>;
+  license: z.ZodOptional<z.ZodObject<{
+    type: z.ZodString;
+    copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_name: z.ZodOptional<z.ZodString>;
+    author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  }, z.core.$loose>>;
+}, z.core.$loose>;
+type OBFMedia = z.infer<typeof OBFMediaSchema>;
+/**
+ * Reference to a symbol in a proprietary symbol set (e.g., SymbolStix).
+ */
+declare const OBFSymbolInfoSchema: z.ZodObject<{
+  set: z.ZodString;
+  filename: z.ZodString;
+}, z.core.$loose>;
+type OBFSymbolInfo = z.infer<typeof OBFSymbolInfoSchema>;
+/**
+ * Image resource, extending {@link OBFMediaSchema} with optional
+ * symbol and dimension properties.
+ *
+ * When resolving the image, consumers should prefer sources in this order:
+ * 1. `data`
+ * 2. `path`
+ * 3. `url`
+ * 4. `symbol`
+ */
+declare const OBFImageSchema: z.ZodIntersection<z.ZodObject<{
+  id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+  data: z.ZodOptional<z.ZodString>;
+  path: z.ZodOptional<z.ZodString>;
+  data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  content_type: z.ZodOptional<z.ZodString>;
+  license: z.ZodOptional<z.ZodObject<{
+    type: z.ZodString;
+    copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_name: z.ZodOptional<z.ZodString>;
+    author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  }, z.core.$loose>>;
+}, z.core.$loose>, z.ZodObject<{
+  symbol: z.ZodOptional<z.ZodObject<{
+    set: z.ZodString;
+    filename: z.ZodString;
+  }, z.core.$loose>>;
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;
+type OBFImage = z.infer<typeof OBFImageSchema>;
+/**
+ * Audio resource. Identical to {@link OBFMediaSchema} — no additional properties.
+ */
+declare const OBFSoundSchema: z.ZodObject<{
+  id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+  data: z.ZodOptional<z.ZodString>;
+  path: z.ZodOptional<z.ZodString>;
+  data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  content_type: z.ZodOptional<z.ZodString>;
+  license: z.ZodOptional<z.ZodObject<{
+    type: z.ZodString;
+    copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_name: z.ZodOptional<z.ZodString>;
+    author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  }, z.core.$loose>>;
+}, z.core.$loose>;
+type OBFSound = z.infer<typeof OBFSoundSchema>;
+/**
+ * Reference to another board, resolved by ID, path, or URL.
+ */
+declare const OBFLoadBoardSchema: z.ZodObject<{
+  id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+  name: z.ZodOptional<z.ZodString>;
+  data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  path: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type OBFLoadBoard = z.infer<typeof OBFLoadBoardSchema>;
+/**
+ * Interactive element on a board, optionally linked to images, sounds, and actions.
+ */
+declare const OBFButtonSchema: z.ZodObject<{
+  id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+  label: z.ZodOptional<z.ZodString>;
+  vocalization: z.ZodOptional<z.ZodString>;
+  image_id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+  sound_id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+  action: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>;
+  actions: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>>;
+  load_board: z.ZodOptional<z.ZodObject<{
+    id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+    name: z.ZodOptional<z.ZodString>;
+    data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    path: z.ZodOptional<z.ZodString>;
+  }, z.core.$loose>>;
+  background_color: z.ZodOptional<z.ZodString>;
+  border_color: z.ZodOptional<z.ZodString>;
+  top: z.ZodOptional<z.ZodNumber>;
+  left: z.ZodOptional<z.ZodNumber>;
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+type OBFButton = z.infer<typeof OBFButtonSchema>;
+/**
+ * Row-and-column layout that arranges buttons by their IDs.
+ */
+declare const OBFGridSchema: z.ZodObject<{
+  rows: z.ZodNumber;
+  columns: z.ZodNumber;
+  order: z.ZodArray<z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>, z.ZodNull]>>>;
+}, z.core.$loose>;
+type OBFGrid = z.infer<typeof OBFGridSchema>;
+/**
+ * Root object of an `.obf` file: the complete definition of a single communication board.
+ */
+declare const OBFBoardSchema: z.ZodObject<{
+  format: z.ZodString;
+  id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+  locale: z.ZodOptional<z.ZodString>;
+  buttons: z.ZodArray<z.ZodObject<{
+    id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    vocalization: z.ZodOptional<z.ZodString>;
+    image_id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+    sound_id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+    action: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>>;
+    load_board: z.ZodOptional<z.ZodObject<{
+      id: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string | undefined, string | number>>>;
+      name: z.ZodOptional<z.ZodString>;
+      data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      path: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+    background_color: z.ZodOptional<z.ZodString>;
+    border_color: z.ZodOptional<z.ZodString>;
+    top: z.ZodOptional<z.ZodNumber>;
+    left: z.ZodOptional<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+  }, z.core.$loose>>;
+  url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  name: z.ZodOptional<z.ZodString>;
+  description_html: z.ZodOptional<z.ZodString>;
+  grid: z.ZodObject<{
+    rows: z.ZodNumber;
+    columns: z.ZodNumber;
+    order: z.ZodArray<z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>, z.ZodNull]>>>;
+  }, z.core.$loose>;
+  images: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{
+    id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+    data: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    content_type: z.ZodOptional<z.ZodString>;
+    license: z.ZodOptional<z.ZodObject<{
+      type: z.ZodString;
+      copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      author_name: z.ZodOptional<z.ZodString>;
+      author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>, z.ZodObject<{
+    symbol: z.ZodOptional<z.ZodObject<{
+      set: z.ZodString;
+      filename: z.ZodString;
+    }, z.core.$loose>>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+  }, z.core.$strip>>>>;
+  sounds: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    id: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+    data: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    data_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    content_type: z.ZodOptional<z.ZodString>;
+    license: z.ZodOptional<z.ZodObject<{
+      type: z.ZodString;
+      copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      author_name: z.ZodOptional<z.ZodString>;
+      author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+      author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>>>;
+  license: z.ZodOptional<z.ZodObject<{
+    type: z.ZodString;
+    copyright_notice_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    source_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_name: z.ZodOptional<z.ZodString>;
+    author_url: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodURL, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+    author_email: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodEmail, z.ZodLiteral<"">]>, z.ZodTransform<string | undefined, string>>>;
+  }, z.core.$loose>>;
+  strings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, z.core.$loose>;
+type OBFBoard = z.infer<typeof OBFBoardSchema>;
+/**
+ * Table of contents for an `.obz` package, mapping resource IDs to their archive paths.
+ */
+declare const OBFManifestSchema: z.ZodObject<{
+  format: z.ZodString;
+  root: z.ZodString;
+  paths: z.ZodObject<{
+    boards: z.ZodRecord<z.ZodString, z.ZodString>;
+    images: z.ZodRecord<z.ZodString, z.ZodString>;
+    sounds: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  }, z.core.$loose>;
+}, z.core.$loose>;
+type OBFManifest = z.infer<typeof OBFManifestSchema>;
+//#endregion
+//#region src/obf.d.ts
+/**
+ * Parse a JSON string into a validated OBF board.
+ *
+ * Strips an optional UTF-8 BOM prefix before parsing and throws a
+ * descriptive error if the input is malformed or fails schema validation.
+ *
+ * @param json - The JSON string to parse.
+ * @returns The validated board object.
+ *
+ * @throws {Error} If the JSON is malformed or does not conform to the OBF schema.
+ */
+declare function parseOBF(json: string): OBFBoard;
+/**
+ * Read a `File` and parse its contents as a validated OBF board.
+ *
+ * This relies on the browser `File` API; for Node environments,
+ * read the file to a string and pass it to {@link parseOBF} instead.
+ *
+ * @param file - A `File` handle pointing to an `.obf` file.
+ * @returns The validated board object.
+ *
+ * @throws {Error} If the file content is malformed or fails schema validation.
+ */
+declare function loadOBF(file: File): Promise<OBFBoard>;
+/**
+ * Validate an unknown value against the OBF board schema.
+ *
+ * @param data - The value to validate.
+ * @returns The validated board object.
+ *
+ * @throws {Error} If the value does not conform to the OBF schema.
+ */
+declare function validateOBF(data: unknown): OBFBoard;
+/**
+ * Stringify an OBF board to a pretty-printed JSON string.
+ *
+ * @param board - The board to stringify.
+ * @returns A JSON string with two-space indentation.
+ */
+declare function stringifyOBF(board: OBFBoard): string;
+//#endregion
+//#region src/obz.d.ts
+/**
+ * Fully extracted contents of an `.obz` archive.
+ *
+ * @property manifest  - The package table of contents.
+ * @property boards    - Board ID → validated board object.
+ * @property resources - Archive path → raw binary content (images, sounds, etc.).
+ */
+interface ParsedOBZ {
+  manifest: OBFManifest;
+  boards: Map<string, OBFBoard>;
+  resources: Map<string, Uint8Array>;
+}
+/**
+ * Read a `File` and extract its contents as a parsed OBZ package.
+ *
+ * This relies on the browser `File` API; for Node environments,
+ * read the file to an `ArrayBuffer` and pass it to {@link extractOBZ} instead.
+ *
+ * @param file - A `File` handle pointing to an `.obz` archive.
+ * @returns The parsed manifest, boards, and binary resources.
+ *
+ * @throws {Error} If the file is not a valid ZIP or the manifest is missing.
+ */
+declare function loadOBZ(file: File): Promise<ParsedOBZ>;
+/**
+ * Decompress an OBZ archive and return its manifest, boards, and resources.
+ *
+ * @param archive - The OBZ archive as an `ArrayBuffer`.
+ * @returns The parsed manifest, a map of board IDs to validated boards,
+ *          and a map of file paths to their binary content.
+ *
+ * @throws {Error} If the archive is not a valid ZIP or the manifest is missing.
+ */
+declare function extractOBZ(archive: ArrayBuffer): Promise<ParsedOBZ>;
+/**
+ * Parse and validate an OBZ manifest — the table of contents that maps
+ * board IDs to their file paths within the archive.
+ *
+ * @param json - A JSON string representing the manifest.
+ * @returns The validated manifest object.
+ *
+ * @throws {Error} If the JSON is malformed or fails schema validation.
+ */
+declare function parseManifest(json: string): OBFManifest;
+/**
+ * Bundle boards and optional resources into a compressed OBZ archive.
+ *
+ * A manifest is generated automatically from the supplied boards,
+ * using the `rootBoardId` to designate the entry-point board.
+ *
+ * @param boards - The boards to include in the archive.
+ * @param rootBoardId - The ID of the board that serves as the archive's entry point.
+ * @param resources - Optional map of file paths to binary content (images, sounds, etc.).
+ * @returns A `Blob` containing the compressed OBZ archive.
+ *
+ * @throws {Error} If `rootBoardId` does not match any of the supplied boards.
+ */
+declare function createOBZ(boards: OBFBoard[], rootBoardId: string, resources?: Map<string, Uint8Array | ArrayBuffer>): Promise<Blob>;
+//#endregion
+//#region src/zip.d.ts
+/**
+ * Decompress a ZIP archive into a map of file paths to raw bytes.
+ *
+ * @param archive - The ZIP archive as an `ArrayBuffer`.
+ * @returns A map of file paths to their decompressed content.
+ *
+ * @throws {Error} If decompression fails.
+ */
+declare function unzip(archive: ArrayBuffer): Promise<Map<string, Uint8Array>>;
+/**
+ * Compress a map of file paths and contents into a single ZIP archive.
+ *
+ * Accepts both `Uint8Array` and `ArrayBuffer` values so callers can
+ * pass the output of {@link unzip} directly or supply raw `ArrayBuffer`s
+ * without converting first.
+ *
+ * @param entries - A map of file paths to their content bytes.
+ * @returns The compressed archive as a `Uint8Array`.
+ *
+ * @throws {Error} If compression fails.
+ */
+declare function zip(entries: Map<string, Uint8Array | ArrayBuffer>): Promise<Uint8Array>;
+/**
+ * Test whether an `ArrayBuffer` begins with the two-byte ZIP magic
+ * prefix (`PK`).
+ *
+ * @param archive - The buffer to inspect.
+ * @returns `true` if the buffer starts with the ZIP signature.
+ */
+declare function isZip(archive: ArrayBuffer): boolean;
+//#endregion
+export { type OBFBoard, OBFBoardSchema, type OBFButton, type OBFButtonAction, OBFButtonActionSchema, OBFButtonSchema, type OBFFormatVersion, OBFFormatVersionSchema, type OBFGrid, OBFGridSchema, type OBFID, OBFIDSchema, type OBFImage, OBFImageSchema, type OBFLicense, OBFLicenseSchema, type OBFLoadBoard, OBFLoadBoardSchema, type OBFLocaleCode, OBFLocaleCodeSchema, type OBFLocalizedStrings, OBFLocalizedStringsSchema, type OBFManifest, OBFManifestSchema, type OBFMedia, OBFMediaSchema, type OBFSound, OBFSoundSchema, type OBFSpecialtyAction, OBFSpecialtyActionSchema, type OBFSpellingAction, OBFSpellingActionSchema, type OBFStrings, OBFStringsSchema, type OBFSymbolInfo, OBFSymbolInfoSchema, type ParsedOBZ, createOBZ, extractOBZ, isZip, loadOBF, loadOBZ, parseManifest, parseOBF, stringifyOBF, unzip, validateOBF, zip };

package/dist/index.mjs

@@ -0,0 +1,500 @@
+import { z } from "zod";
+import { unzip as unzip$1, zip as zip$1 } from "fflate";
+//#region src/schema.ts
+/**
+* Open Board Format (OBF) Zod Schemas
+*
+* These schemas represent the Open Board Format, designed for sharing communication boards and board sets
+* between Augmentative and Alternative Communication (AAC) applications.
+*
+* Official OBF specification: https://www.openboardformat.org/docs
+*
+* @author Shay Cojocaru
+* @license MIT
+*/
+/** Optional URL that treats empty strings as undefined. */
+const OBFOptionalUrlSchema = z.union([z.url(), z.literal("")]).transform((val) => val === "" ? void 0 : val).optional();
+/** Optional email that treats empty strings as undefined. */
+const OBFOptionalEmailSchema = z.union([z.email(), z.literal("")]).transform((val) => val === "" ? void 0 : val).optional();
+/** Optional ID that treats empty strings as undefined. */
+const OBFOptionalIDSchema = z.union([z.string(), z.number()]).transform((val) => {
+	const str = String(val);
+	return str === "" ? void 0 : str;
+}).optional();
+/** Unique board-element identifier, coerced to a non-empty string. */
+const OBFIDSchema = z.union([z.string(), z.number()]).transform((val) => String(val)).pipe(z.string().min(1));
+/**
+* Format version of the Open Board Format, e.g., 'open-board-0.1'.
+*/
+const OBFFormatVersionSchema = z.string().regex(/^open-board-.+$/);
+/**
+* Locale code as per BCP 47 language tags, e.g., 'en', 'en-US', 'fr-CA'.
+*/
+const OBFLocaleCodeSchema = z.string();
+/**
+* Key–value pairs mapping symbolic names to their translations in a single locale.
+*/
+const OBFLocalizedStringsSchema = z.record(z.string(), z.string());
+/**
+* Locale-keyed dictionary of translated strings,
+* e.g., `{ en: { greeting: "Hello" }, fr: { greeting: "Bonjour" } }`.
+*/
+const OBFStringsSchema = z.record(z.string(), OBFLocalizedStringsSchema);
+/**
+* Spelling action: a `+` prefix followed by the text to append,
+* e.g., `"+hello"`.
+*/
+const OBFSpellingActionSchema = z.string().regex(/^\+.+$/);
+/**
+* Specialty action prefixed with `:`, e.g., `":clear"`.
+* Custom extensions use the `:ext_` prefix.
+*/
+const OBFSpecialtyActionSchema = z.string().regex(/^:[a-z][a-z0-9_-]*$/i);
+/**
+* Union of spelling and specialty actions that a button can trigger.
+*/
+const OBFButtonActionSchema = z.union([OBFSpellingActionSchema, OBFSpecialtyActionSchema]);
+/**
+* License terms and attribution for a resource.
+*/
+const OBFLicenseSchema = z.looseObject({
+	/** Type of the license, e.g., 'CC-BY-SA'. */
+	type: z.string(),
+	/** URL to the license terms. */
+	copyright_notice_url: OBFOptionalUrlSchema,
+	/** Source URL of the resource. */
+	source_url: OBFOptionalUrlSchema,
+	/** Name of the author. */
+	author_name: z.string().optional(),
+	/** URL of the author's webpage. */
+	author_url: OBFOptionalUrlSchema,
+	/** Email address of the author. */
+	author_email: OBFOptionalEmailSchema
+});
+/**
+* Common properties for media resources (images and sounds).
+*
+* When multiple references are provided, they should be used in the following order:
+* 1. data
+* 2. path
+* 3. url
+*/
+const OBFMediaSchema = z.looseObject({
+	/** Unique identifier for the media resource. */
+	id: OBFIDSchema,
+	/** Data URI containing the media data. */
+	data: z.string().optional(),
+	/** Path to the media file within an .obz package. */
+	path: z.string().optional(),
+	/** Data URL to fetch the media programmatically. */
+	data_url: OBFOptionalUrlSchema,
+	/** URL to the media resource. */
+	url: OBFOptionalUrlSchema,
+	/** MIME type of the media, e.g., 'image/png', 'audio/mpeg'. */
+	content_type: z.string().optional(),
+	/** Licensing information for the media. */
+	license: OBFLicenseSchema.optional()
+});
+/**
+* Reference to a symbol in a proprietary symbol set (e.g., SymbolStix).
+*/
+const OBFSymbolInfoSchema = z.looseObject({
+	/** Name of the symbol set, e.g., 'symbolstix'. */
+	set: z.string(),
+	/** Filename of the symbol within the set. */
+	filename: z.string()
+});
+/**
+* Image resource, extending {@link OBFMediaSchema} with optional
+* symbol and dimension properties.
+*
+* When resolving the image, consumers should prefer sources in this order:
+* 1. `data`
+* 2. `path`
+* 3. `url`
+* 4. `symbol`
+*/
+const OBFImageSchema = OBFMediaSchema.and(z.object({
+	/** Information about a symbol from a proprietary symbol set. */
+	symbol: OBFSymbolInfoSchema.optional(),
+	/** Width of the image in pixels. */
+	width: z.number().optional(),
+	/** Height of the image in pixels. */
+	height: z.number().optional()
+}));
+/**
+* Audio resource. Identical to {@link OBFMediaSchema} — no additional properties.
+*/
+const OBFSoundSchema = OBFMediaSchema;
+/**
+* Reference to another board, resolved by ID, path, or URL.
+*/
+const OBFLoadBoardSchema = z.looseObject({
+	/** Unique identifier of the board to load. */
+	id: OBFOptionalIDSchema,
+	/** Name of the board to load. */
+	name: z.string().optional(),
+	/** Data URL to fetch the board programmatically. */
+	data_url: OBFOptionalUrlSchema,
+	/** URL to access the board via a web browser. */
+	url: OBFOptionalUrlSchema,
+	/** Path to the board within an .obz package. */
+	path: z.string().optional()
+});
+/**
+* Interactive element on a board, optionally linked to images, sounds, and actions.
+*/
+const OBFButtonSchema = z.looseObject({
+	/** Unique identifier for the button. */
+	id: OBFIDSchema,
+	/** Label text displayed on the button. */
+	label: z.string().optional(),
+	/** Alternative text for vocalization when the button is activated. */
+	vocalization: z.string().optional(),
+	/** Identifier of the image associated with the button. */
+	image_id: OBFOptionalIDSchema,
+	/** Identifier of the sound associated with the button. */
+	sound_id: OBFOptionalIDSchema,
+	/** Action associated with the button. */
+	action: OBFButtonActionSchema.optional(),
+	/** List of multiple actions for the button, executed in order. */
+	actions: z.array(OBFButtonActionSchema).optional(),
+	/** Information to load another board when this button is activated. */
+	load_board: OBFLoadBoardSchema.optional(),
+	/** Background color of the button in 'rgb' or 'rgba' format. */
+	background_color: z.string().optional(),
+	/** Border color of the button in 'rgb' or 'rgba' format. */
+	border_color: z.string().optional(),
+	/** Vertical position for absolute positioning (0.0 to 1.0). */
+	top: z.number().min(0).max(1).optional(),
+	/** Horizontal position for absolute positioning (0.0 to 1.0). */
+	left: z.number().min(0).max(1).optional(),
+	/** Width of the button for absolute positioning (0.0 to 1.0). */
+	width: z.number().min(0).max(1).optional(),
+	/** Height of the button for absolute positioning (0.0 to 1.0). */
+	height: z.number().min(0).max(1).optional()
+});
+/**
+* Row-and-column layout that arranges buttons by their IDs.
+*/
+const OBFGridSchema = z.looseObject({
+	/** Number of rows in the grid. */
+	rows: z.number().int().min(1),
+	/** Number of columns in the grid. */
+	columns: z.number().int().min(1),
+	/**
+	* 2D array representing the order of buttons by their IDs.
+	* Each sub-array corresponds to a row, and each element is a button ID or null for empty slots.
+	*/
+	order: z.array(z.array(z.union([OBFIDSchema, z.null()])))
+}).refine((g) => g.order.length === g.rows, { message: "Grid order length must match rows" }).refine((g) => g.order.every((row) => row.length === g.columns), { message: "Each grid row must have length equal to columns" });
+/**
+* Root object of an `.obf` file: the complete definition of a single communication board.
+*/
+const OBFBoardSchema = z.looseObject({
+	/** Format version of the Open Board Format, e.g., 'open-board-0.1'. */
+	format: OBFFormatVersionSchema,
+	/** Unique identifier for the board. */
+	id: OBFIDSchema,
+	/** Locale of the board as a BCP 47 language tag, e.g., 'en', 'en-US'. */
+	locale: OBFLocaleCodeSchema.optional(),
+	/** List of buttons on the board. */
+	buttons: z.array(OBFButtonSchema),
+	/** URL where the board can be accessed or downloaded. */
+	url: OBFOptionalUrlSchema,
+	/** Name of the board. */
+	name: z.string().optional(),
+	/** Description of the board in HTML format. */
+	description_html: z.string().optional(),
+	/** Grid layout information for arranging buttons. */
+	grid: OBFGridSchema,
+	/** List of images used in the board. */
+	images: z.array(OBFImageSchema).optional(),
+	/** List of sounds used in the board. */
+	sounds: z.array(OBFSoundSchema).optional(),
+	/** Licensing information for the board. */
+	license: OBFLicenseSchema.optional(),
+	/** String translations for multiple locales. */
+	strings: OBFStringsSchema.optional()
+});
+/**
+* Table of contents for an `.obz` package, mapping resource IDs to their archive paths.
+*/
+const OBFManifestSchema = z.looseObject({
+	/** Format version of the Open Board Format, e.g., 'open-board-0.1'. */
+	format: OBFFormatVersionSchema,
+	/** Path to the root board within the .obz package. */
+	root: z.string(),
+	/** Mapping of IDs to paths for boards, images, and sounds. */
+	paths: z.looseObject({
+		/** Mapping of board IDs to their file paths. */
+		boards: z.record(z.string(), z.string()),
+		/** Mapping of image IDs to their file paths. */
+		images: z.record(z.string(), z.string()),
+		/** Mapping of sound IDs to their file paths. */
+		sounds: z.record(z.string(), z.string()).optional()
+	})
+});
+//#endregion
+//#region src/obf.ts
+const UTF8_BOM = "";
+/** Strip a leading UTF-8 BOM, which some editors silently prepend. */
+function stripBom(text) {
+	return text.startsWith(UTF8_BOM) ? text.slice(1) : text;
+}
+/** Build a descriptive parse-failure message, preserving the engine's reason when available. */
+function buildParseErrorMessage(error) {
+	const reason = error instanceof Error ? error.message : "";
+	return reason ? `Invalid OBF: JSON parse failed — ${reason}` : "Invalid OBF: JSON parse failed";
+}
+/**
+* Parse a JSON string into a validated OBF board.
+*
+* Strips an optional UTF-8 BOM prefix before parsing and throws a
+* descriptive error if the input is malformed or fails schema validation.
+*
+* @param json - The JSON string to parse.
+* @returns The validated board object.
+*
+* @throws {Error} If the JSON is malformed or does not conform to the OBF schema.
+*/
+function parseOBF(json) {
+	const sanitized = stripBom(json);
+	let rawBoard;
+	try {
+		rawBoard = JSON.parse(sanitized);
+	} catch (error) {
+		throw new Error(buildParseErrorMessage(error));
+	}
+	return validateOBF(rawBoard);
+}
+/**
+* Read a `File` and parse its contents as a validated OBF board.
+*
+* This relies on the browser `File` API; for Node environments,
+* read the file to a string and pass it to {@link parseOBF} instead.
+*
+* @param file - A `File` handle pointing to an `.obf` file.
+* @returns The validated board object.
+*
+* @throws {Error} If the file content is malformed or fails schema validation.
+*/
+async function loadOBF(file) {
+	return parseOBF(await file.text());
+}
+/**
+* Validate an unknown value against the OBF board schema.
+*
+* @param data - The value to validate.
+* @returns The validated board object.
+*
+* @throws {Error} If the value does not conform to the OBF schema.
+*/
+function validateOBF(data) {
+	const result = OBFBoardSchema.safeParse(data);
+	if (!result.success) throw new Error(`Invalid OBF: ${result.error.message}`);
+	return result.data;
+}
+/**
+* Stringify an OBF board to a pretty-printed JSON string.
+*
+* @param board - The board to stringify.
+* @returns A JSON string with two-space indentation.
+*/
+function stringifyOBF(board) {
+	return JSON.stringify(board, null, 2);
+}
+//#endregion
+//#region src/zip.ts
+/**
+* First two bytes of every ZIP archive — the ASCII letters `PK`,
+* after Phil Katz, creator of the format.
+*
+* Only the 2-byte prefix is checked intentionally: this keeps the
+* test lightweight and sufficient for distinguishing ZIP from JSON.
+*/
+const ZIP_MAGIC = [80, 75];
+/** Balanced speed-vs-size deflate level used by fflate (1–9 scale). */
+const COMPRESSION_LEVEL = 6;
+/**
+* Decompress a ZIP archive into a map of file paths to raw bytes.
+*
+* @param archive - The ZIP archive as an `ArrayBuffer`.
+* @returns A map of file paths to their decompressed content.
+*
+* @throws {Error} If decompression fails.
+*/
+function unzip(archive) {
+	return new Promise((resolve, reject) => {
+		unzip$1(new Uint8Array(archive), (error, entries) => {
+			if (error) {
+				reject(/* @__PURE__ */ new Error(`Failed to unzip: ${error.message ?? String(error)}`));
+				return;
+			}
+			resolve(new Map(Object.entries(entries)));
+		});
+	});
+}
+/**
+* Compress a map of file paths and contents into a single ZIP archive.
+*
+* Accepts both `Uint8Array` and `ArrayBuffer` values so callers can
+* pass the output of {@link unzip} directly or supply raw `ArrayBuffer`s
+* without converting first.
+*
+* @param entries - A map of file paths to their content bytes.
+* @returns The compressed archive as a `Uint8Array`.
+*
+* @throws {Error} If compression fails.
+*/
+function zip(entries) {
+	return new Promise((resolve, reject) => {
+		const pathToBytes = {};
+		for (const [path, content] of entries) pathToBytes[path] = content instanceof Uint8Array ? content : new Uint8Array(content);
+		zip$1(pathToBytes, { level: COMPRESSION_LEVEL }, (error, result) => {
+			if (error) {
+				reject(/* @__PURE__ */ new Error(`Failed to zip: ${error.message ?? String(error)}`));
+				return;
+			}
+			resolve(result);
+		});
+	});
+}
+/**
+* Test whether an `ArrayBuffer` begins with the two-byte ZIP magic
+* prefix (`PK`).
+*
+* @param archive - The buffer to inspect.
+* @returns `true` if the buffer starts with the ZIP signature.
+*/
+function isZip(archive) {
+	const bytes = new Uint8Array(archive);
+	return bytes.length >= ZIP_MAGIC.length && ZIP_MAGIC.every((byte, index) => bytes[index] === byte);
+}
+//#endregion
+//#region src/obz.ts
+/**
+* Read a `File` and extract its contents as a parsed OBZ package.
+*
+* This relies on the browser `File` API; for Node environments,
+* read the file to an `ArrayBuffer` and pass it to {@link extractOBZ} instead.
+*
+* @param file - A `File` handle pointing to an `.obz` archive.
+* @returns The parsed manifest, boards, and binary resources.
+*
+* @throws {Error} If the file is not a valid ZIP or the manifest is missing.
+*/
+async function loadOBZ(file) {
+	return extractOBZ(await file.arrayBuffer());
+}
+/**
+* Decompress an OBZ archive and return its manifest, boards, and resources.
+*
+* @param archive - The OBZ archive as an `ArrayBuffer`.
+* @returns The parsed manifest, a map of board IDs to validated boards,
+*          and a map of file paths to their binary content.
+*
+* @throws {Error} If the archive is not a valid ZIP or the manifest is missing.
+*/
+async function extractOBZ(archive) {
+	if (!isZip(archive)) throw new Error("Invalid OBZ: not a ZIP file");
+	const entries = await unzip(archive);
+	const manifest = extractManifest(entries);
+	return {
+		manifest,
+		boards: extractBoards(manifest, entries),
+		resources: entries
+	};
+}
+/**
+* Parse and validate an OBZ manifest — the table of contents that maps
+* board IDs to their file paths within the archive.
+*
+* @param json - A JSON string representing the manifest.
+* @returns The validated manifest object.
+*
+* @throws {Error} If the JSON is malformed or fails schema validation.
+*/
+function parseManifest(json) {
+	let data;
+	try {
+		data = JSON.parse(json);
+	} catch (error) {
+		throw new Error(`Invalid manifest: JSON parse failed${error?.message ? ` — ${error.message}` : ""}`);
+	}
+	const result = OBFManifestSchema.safeParse(data);
+	if (!result.success) throw new Error(`Invalid manifest: ${result.error.message}`);
+	return result.data;
+}
+/**
+* Bundle boards and optional resources into a compressed OBZ archive.
+*
+* A manifest is generated automatically from the supplied boards,
+* using the `rootBoardId` to designate the entry-point board.
+*
+* @param boards - The boards to include in the archive.
+* @param rootBoardId - The ID of the board that serves as the archive's entry point.
+* @param resources - Optional map of file paths to binary content (images, sounds, etc.).
+* @returns A `Blob` containing the compressed OBZ archive.
+*
+* @throws {Error} If `rootBoardId` does not match any of the supplied boards.
+*/
+async function createOBZ(boards, rootBoardId, resources) {
+	if (!boards.some((board) => board.id === rootBoardId)) throw new Error(`Invalid OBZ: rootBoardId "${rootBoardId}" does not match any supplied board`);
+	const entries = /* @__PURE__ */ new Map();
+	const boardPaths = Object.fromEntries(boards.map((board) => [board.id, `boards/${board.id}.obf`]));
+	const imagePaths = collectMediaPaths(boards, "images");
+	const soundPaths = collectMediaPaths(boards, "sounds");
+	const manifest = OBFManifestSchema.parse({
+		format: "open-board-0.1",
+		root: `boards/${rootBoardId}.obf`,
+		paths: {
+			boards: boardPaths,
+			images: imagePaths,
+			...Object.keys(soundPaths).length > 0 ? { sounds: soundPaths } : {}
+		}
+	});
+	const encoder = new TextEncoder();
+	entries.set("manifest.json", encoder.encode(JSON.stringify(manifest, null, 2)));
+	for (const board of boards) {
+		const path = `boards/${board.id}.obf`;
+		entries.set(path, encoder.encode(JSON.stringify(board, null, 2)));
+	}
+	if (resources) for (const [path, bytes] of resources) entries.set(path, bytes);
+	const compressed = await zip(entries);
+	return new Blob([new Uint8Array(compressed)], { type: "application/zip" });
+}
+/**
+* Walk every board's media collection and produce the `{ id -> path }` map
+* the spec calls "redundant but still required" for the OBZ manifest.
+*
+* Throws when two boards declare the same media id with conflicting paths
+* — a silent OBZ that points at a non-existent file is worse than a clear error.
+*/
+function collectMediaPaths(boards, kind) {
+	const paths = {};
+	for (const board of boards) for (const media of board[kind] ?? []) {
+		if (media.path === void 0) continue;
+		const existing = paths[media.id];
+		if (existing !== void 0 && existing !== media.path) throw new Error(`Invalid OBZ: ${kind} id "${media.id}" maps to conflicting paths "${existing}" and "${media.path}"`);
+		paths[media.id] = media.path;
+	}
+	return paths;
+}
+function extractManifest(entries) {
+	const manifestBytes = entries.get("manifest.json");
+	if (!manifestBytes) throw new Error("Invalid OBZ: missing manifest.json");
+	return parseManifest(new TextDecoder().decode(manifestBytes));
+}
+function extractBoards(manifest, entries) {
+	const boards = /* @__PURE__ */ new Map();
+	for (const [id, path] of Object.entries(manifest.paths.boards)) {
+		const boardBytes = entries.get(path);
+		if (!boardBytes) throw new Error(`Board "${id}" declared in manifest but missing at path "${path}"`);
+		const boardJson = new TextDecoder().decode(boardBytes);
+		boards.set(id, parseOBF(boardJson));
+	}
+	return boards;
+}
+//#endregion
+export { OBFBoardSchema, OBFButtonActionSchema, OBFButtonSchema, OBFFormatVersionSchema, OBFGridSchema, OBFIDSchema, OBFImageSchema, OBFLicenseSchema, OBFLoadBoardSchema, OBFLocaleCodeSchema, OBFLocalizedStringsSchema, OBFManifestSchema, OBFMediaSchema, OBFSoundSchema, OBFSpecialtyActionSchema, OBFSpellingActionSchema, OBFStringsSchema, OBFSymbolInfoSchema, createOBZ, extractOBZ, isZip, loadOBF, loadOBZ, parseManifest, parseOBF, stringifyOBF, unzip, validateOBF, zip };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@shayc/open-board-format",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "Parse, validate, and create Open Board Format (OBF/OBZ) files for AAC applications.",
+  "author": "Shay Cojocaru <shayc@outlook.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/shayc/open-board-format#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shayc/open-board-format.git"
+  },
+  "bugs": {
+    "url": "https://github.com/shayc/open-board-format/issues"
+  },
+  "keywords": [
+    "aac",
+    "open-board-format",
+    "communication-board"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^25.7.0",
+    "bumpp": "^11.1.0",
+    "tsdown": "^0.22.0",
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.6"
+  },
+  "dependencies": {
+    "fflate": "^0.8.2",
+    "zod": "^4.4.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}