open-board-format 1.0.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,209 @@
+# open-board-format
+
+A type-safe toolkit to parse, validate, and create Open Board Format (OBF/OBZ) files for Augmentative and Alternative Communication (AAC) applications.
+
+## What is Open Board Format?
+
+[Open Board Format](https://www.openboardformat.org/) is an open standard for representing AAC communication boards — grids of labeled buttons that a person taps to communicate. It defines two file types:
+
+- **OBF** (`.obf`) — A JSON file describing a single communication board: its buttons, images, sounds, grid layout, and metadata.
+- **OBZ** (`.obz`) — A ZIP archive containing one or more `.obf` boards along with their images, sounds, and a `manifest.json` that ties everything together.
+
+The format enables users and practitioners to **move boards between AAC apps** without starting from scratch — a common pain point in the AAC community.
+
+## Features
+
+- **Parse & validate** OBF boards from JSON strings, objects, or `File` handles
+- **Create & extract** OBZ packages (ZIP archives with boards, images, and sounds)
+- **[Zod](https://zod.dev/) schemas** for every OBF type — use them for runtime validation, form building, or API contracts
+- **Full TypeScript types** inferred from schemas — no separate type maintenance
+- **Spec-compliant coercion** — numeric IDs are coerced to strings, empty strings become `undefined`, and UTF-8 BOM is handled automatically
+- **Tree-shakeable** ESM build with no side effects (`"sideEffects": false` in `package.json`)
+
+## Install
+
+```bash
+npm install open-board-format
+```
+
+> Zero peer dependencies. Powered by [zod](https://zod.dev/) for validation and [fflate](https://github.com/101arrowz/fflate) for ZIP — both listed as standard `dependencies` in `package.json`, so your bundler deduplicates them normally.
+
+## Quick start
+
+All examples below assume the following imports:
+
+```ts
+import {
+  parseOBF,
+  validateOBF,
+  stringifyOBF,
+  loadOBF,
+  extractOBZ,
+  loadOBZ,
+  createOBZ,
+  OBFBoardSchema,
+} from "open-board-format";
+import type { OBFBoard, ParsedOBZ } from "open-board-format";
+```
+
+### Parse a single board (OBF)
+
+```ts
+// Parse from a JSON string
+const board = parseOBF(jsonString);
+
+console.log(board.name); // "My Board"
+console.log(board.buttons[0]); // { id: "1", label: "hello", image_id: "img1" }
+
+// Validate an unknown object (throws on failure)
+const validated = validateOBF(untrustedData);
+
+// Serialize back to a formatted JSON string
+const json = stringifyOBF(board);
+
+// Load from a File object (e.g. browser file-input)
+const fromFile = await loadOBF(file);
+```
+
+### Extract an OBZ package
+
+```ts
+// From a File (e.g. drag-and-drop)
+const { manifest, boards, files }: ParsedOBZ = await loadOBZ(file);
+
+// Or from an ArrayBuffer (e.g. fetch response)
+const parsed = await extractOBZ(buffer);
+
+// Access boards by ID
+const rootPath = parsed.manifest.root; // "boards/1.obf"
+const homeBoard = parsed.boards.get("1");
+
+// Access raw files (images, sounds, etc.)
+const imageBytes = parsed.files.get("images/logo.png");
+```
+
+`ParsedOBZ` has the following shape:
+
+```ts
+interface ParsedOBZ {
+  manifest: OBFManifest; // Validated manifest.json
+  boards: Map<string, OBFBoard>; // Board ID → parsed board
+  files: Map<string, Uint8Array>; // File path → raw bytes
+}
+```
+
+### Create an OBZ package
+
+```ts
+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"]] },
+  },
+];
+
+// Optional: include image/sound resources
+const resources = new Map([["images/logo.png", pngBytes]]);
+
+const blob = await createOBZ(boards, "board-1", resources);
+// blob is a Blob you can download, upload, or store
+```
+
+### Use Zod schemas directly
+
+Every OBF type is exported as both a **Zod schema** (for runtime validation) and a **TypeScript type** (for static analysis):
+
+```ts
+// Safe parsing (returns { success, data, error })
+const result = OBFBoardSchema.safeParse(data);
+
+if (result.success) {
+  console.log(result.data.buttons);
+} else {
+  console.error(result.error.issues);
+}
+```
+
+## API reference
+
+### OBF functions
+
+| Signature                                | Description                                                    |
+| ---------------------------------------- | -------------------------------------------------------------- |
+| `parseOBF(json: string): OBFBoard`       | Parse a JSON string into a validated board. Handles UTF-8 BOM. |
+| `validateOBF(data: unknown): OBFBoard`   | Validate an unknown value against the board schema.            |
+| `stringifyOBF(board: OBFBoard): string`  | Serialize a board to a formatted JSON string.                  |
+| `loadOBF(file: File): Promise<OBFBoard>` | Read and parse a board from a `File` object.                   |
+
+### OBZ functions
+
+| Signature                                                                                                | Description                                               |
+| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `extractOBZ(buffer: ArrayBuffer): Promise<ParsedOBZ>`                                                    | Extract boards and files from an OBZ archive buffer.      |
+| `loadOBZ(file: File): Promise<ParsedOBZ>`                                                                | Read and extract an OBZ package from a `File` object.     |
+| `createOBZ(boards: OBFBoard[], rootBoardId: string, resources?: Map<string, Uint8Array>): Promise<Blob>` | Create an OBZ archive from boards and optional resources. |
+| `parseManifest(json: string): OBFManifest`                                                               | Parse and validate a `manifest.json` string.              |
+
+### ZIP utilities
+
+| Signature                                                      | Description                                             |
+| -------------------------------------------------------------- | ------------------------------------------------------- |
+| `zip(files): Promise<Uint8Array>`                              | Create a ZIP archive from a map of paths to content.    |
+| `unzip(buffer: ArrayBuffer): Promise<Map<string, Uint8Array>>` | Extract files from a ZIP archive.                       |
+| `isZip(buffer: ArrayBuffer): boolean`                          | Check whether a buffer starts with the ZIP magic bytes. |
+
+### Schemas & types
+
+<details>
+<summary><strong>All exported schemas & types</strong></summary>
+
+| Schema                      | Type                  | Description                                     |
+| --------------------------- | --------------------- | ----------------------------------------------- |
+| `OBFBoardSchema`            | `OBFBoard`            | Root board object                               |
+| `OBFButtonSchema`           | `OBFButton`           | Button with label, action, colors, positioning  |
+| `OBFGridSchema`             | `OBFGrid`             | Grid layout (rows, columns, order)              |
+| `OBFImageSchema`            | `OBFImage`            | Image resource with dimensions and symbol info  |
+| `OBFSoundSchema`            | `OBFSound`            | Sound resource                                  |
+| `OBFMediaSchema`            | `OBFMedia`            | Common media base (shared by images & sounds)   |
+| `OBFLicenseSchema`          | `OBFLicense`          | Licensing and attribution                       |
+| `OBFManifestSchema`         | `OBFManifest`         | OBZ manifest (`manifest.json`)                  |
+| `OBFLoadBoardSchema`        | `OBFLoadBoard`        | Reference to another board                      |
+| `OBFButtonActionSchema`     | `OBFButtonAction`     | Spelling or specialty action                    |
+| `OBFSpellingActionSchema`   | `OBFSpellingAction`   | Spelling action (`+a`, `+oo`, …)                |
+| `OBFSpecialtyActionSchema`  | `OBFSpecialtyAction`  | Specialty action (`:clear`, `:home`, …)         |
+| `OBFIDSchema`               | `OBFID`               | Unique identifier (string, coerced from number) |
+| `OBFFormatVersionSchema`    | `OBFFormatVersion`    | Format version string                           |
+| `OBFLocaleCodeSchema`       | `OBFLocaleCode`       | BCP 47 locale code                              |
+| `OBFLocalizedStringsSchema` | `OBFLocalizedStrings` | Key-value string translations                   |
+| `OBFStringsSchema`          | `OBFStrings`          | Multi-locale string map                         |
+| `OBFSymbolInfoSchema`       | `OBFSymbolInfo`       | Proprietary symbol set reference                |
+
+</details>
+
+## Spec notes
+
+This library targets the **`open-board-0.1`** format version. Key behaviors:
+
+- **ID coercion** — Numeric IDs (common in real-world files) are automatically coerced to strings, per the spec's parsing guidelines.
+- **Media resolution order** — When an image or sound has multiple references, resolve in order: `data` → `path` → `url` → `symbol`.
+- **Grid validation** — The `order` array must have exactly `rows` sub-arrays, each with exactly `columns` entries.
+- **Extensions** — Properties prefixed with `ext_` are passed through. The schemas rely on Zod's default object parsing behavior, which preserves unrecognized keys — so custom `ext_` fields survive parsing and serialization without throwing validation errors.
+
+## 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,345 @@
+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 identifier as a string. Must be a non-empty string or number (coerced to 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>;
+/**
+ * Mapping of string keys to localized string values.
+ */
+declare const OBFLocalizedStringsSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+type OBFLocalizedStrings = z.infer<typeof OBFLocalizedStringsSchema>;
+/**
+ * String translations for multiple locales.
+ */
+declare const OBFStringsSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>;
+type OBFStrings = z.infer<typeof OBFStringsSchema>;
+/**
+ * Represents custom actions for spelling.
+ * Prefixed with '+' followed by the text to append.
+ */
+declare const OBFSpellingActionSchema: z.ZodString;
+type OBFSpellingAction = z.infer<typeof OBFSpellingActionSchema>;
+/**
+ * Represents specialty actions.
+ * Standard actions are prefixed with ':'.
+ * Custom actions start with ':ext_'.
+ */
+declare const OBFSpecialtyActionSchema: z.ZodString;
+type OBFSpecialtyAction = z.infer<typeof OBFSpecialtyActionSchema>;
+/**
+ * Possible actions associated with a button.
+ */
+declare const OBFButtonActionSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+type OBFButtonAction = z.infer<typeof OBFButtonActionSchema>;
+/**
+ * Licensing information 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.$strip>;
+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.$strip>>;
+}, z.core.$strip>;
+type OBFMedia = z.infer<typeof OBFMediaSchema>;
+/**
+ * Information about a symbol from a proprietary symbol set.
+ */
+declare const OBFSymbolInfoSchema: z.ZodObject<{
+  set: z.ZodString;
+  filename: z.ZodString;
+}, z.core.$strip>;
+type OBFSymbolInfo = z.infer<typeof OBFSymbolInfoSchema>;
+/**
+ * Represents an image resource.
+ *
+ * When resolving the image, if multiple references are provided, they should be used in the following 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.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+  symbol: z.ZodOptional<z.ZodObject<{
+    set: z.ZodString;
+    filename: z.ZodString;
+  }, z.core.$strip>>;
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;
+type OBFImage = z.infer<typeof OBFImageSchema>;
+/**
+ * Represents a sound resource.
+ */
+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.$strip>>;
+}, z.core.$strip>;
+type OBFSound = z.infer<typeof OBFSoundSchema>;
+/**
+ * Information needed to load another board.
+ */
+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.$strip>;
+type OBFLoadBoard = z.infer<typeof OBFLoadBoardSchema>;
+/**
+ * Represents a button on the board.
+ */
+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.$strip>>;
+  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.$strip>;
+type OBFButton = z.infer<typeof OBFButtonSchema>;
+/**
+ * Grid layout information for the board.
+ */
+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.$strip>;
+type OBFGrid = z.infer<typeof OBFGridSchema>;
+/**
+ * Represents the root object of an OBF file, defining the structure and layout of a 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.$strip>>;
+    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.$strip>>;
+  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.$strip>;
+  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.$strip>>;
+  }, z.core.$strip>, z.ZodObject<{
+    symbol: z.ZodOptional<z.ZodObject<{
+      set: z.ZodString;
+      filename: z.ZodString;
+    }, z.core.$strip>>;
+    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.$strip>>;
+  }, z.core.$strip>>>;
+  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.$strip>>;
+  strings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, z.core.$strip>;
+type OBFBoard = z.infer<typeof OBFBoardSchema>;
+/**
+ * Manifest file in an .obz package.
+ */
+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.$strip>;
+}, z.core.$strip>;
+type OBFManifest = z.infer<typeof OBFManifestSchema>;
+//#endregion
+//#region src/obf.d.ts
+declare function parseOBF(json: string): OBFBoard;
+declare function loadOBF(file: File): Promise<OBFBoard>;
+declare function validateOBF(data: unknown): OBFBoard;
+declare function stringifyOBF(board: OBFBoard): string;
+//#endregion
+//#region src/obz.d.ts
+interface ParsedOBZ {
+  manifest: OBFManifest;
+  boards: Map<string, OBFBoard>;
+  files: Map<string, Uint8Array>;
+}
+/**
+ * Load OBZ package from File
+ * @param file - File object
+ * @returns Parsed OBZ with manifest, boards, and files
+ */
+declare function loadOBZ(file: File): Promise<ParsedOBZ>;
+/**
+ * Extract OBZ package from ArrayBuffer
+ * @param buffer - OBZ file as ArrayBuffer
+ * @returns Parsed OBZ with manifest, boards, and files
+ */
+declare function extractOBZ(buffer: ArrayBuffer): Promise<ParsedOBZ>;
+/**
+ * Parse manifest.json from OBZ package
+ * @param json - Manifest JSON string
+ * @returns Validated Manifest object
+ */
+declare function parseManifest(json: string): OBFManifest;
+/**
+ * Create OBZ package from boards and resources
+ * @param boards - Array of Board objects
+ * @param rootBoardId - ID of the root board
+ * @param resources - Optional map of resource paths to buffers
+ * @returns OBZ package as Blob
+ */
+declare function createOBZ(boards: OBFBoard[], rootBoardId: string, resources?: Map<string, Uint8Array | ArrayBuffer>): Promise<Blob>;
+//#endregion
+//#region src/zip.d.ts
+declare function unzip(buffer: ArrayBuffer): Promise<Map<string, Uint8Array>>;
+declare function zip(files: Map<string, Uint8Array | ArrayBuffer>): Promise<Uint8Array>;
+declare function isZip(buffer: 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,315 @@
+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 identifier as a string. Must be a non-empty string or number (coerced to 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();
+/**
+* Mapping of string keys to localized string values.
+*/
+const OBFLocalizedStringsSchema = z.record(z.string(), z.string());
+/**
+* String translations for multiple locales.
+*/
+const OBFStringsSchema = z.record(z.string(), OBFLocalizedStringsSchema);
+/**
+* Represents custom actions for spelling.
+* Prefixed with '+' followed by the text to append.
+*/
+const OBFSpellingActionSchema = z.string().regex(/^\+.+$/);
+/**
+* Represents specialty actions.
+* Standard actions are prefixed with ':'.
+* Custom actions start with ':ext_'.
+*/
+const OBFSpecialtyActionSchema = z.string().regex(/^:[a-z][a-z0-9_-]*$/i);
+/**
+* Possible actions associated with a button.
+*/
+const OBFButtonActionSchema = z.union([OBFSpellingActionSchema, OBFSpecialtyActionSchema]);
+/**
+* Licensing information for a resource.
+*/
+const OBFLicenseSchema = z.object({
+	type: z.string(),
+	copyright_notice_url: OBFOptionalUrlSchema,
+	source_url: OBFOptionalUrlSchema,
+	author_name: z.string().optional(),
+	author_url: OBFOptionalUrlSchema,
+	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.object({
+	id: OBFIDSchema,
+	data: z.string().optional(),
+	path: z.string().optional(),
+	data_url: OBFOptionalUrlSchema,
+	url: OBFOptionalUrlSchema,
+	content_type: z.string().optional(),
+	license: OBFLicenseSchema.optional()
+});
+/**
+* Information about a symbol from a proprietary symbol set.
+*/
+const OBFSymbolInfoSchema = z.object({
+	set: z.string(),
+	filename: z.string()
+});
+/**
+* Represents an image resource.
+*
+* When resolving the image, if multiple references are provided, they should be used in the following order:
+* 1. data
+* 2. path
+* 3. url
+* 4. symbol
+*/
+const OBFImageSchema = OBFMediaSchema.and(z.object({
+	symbol: OBFSymbolInfoSchema.optional(),
+	width: z.number().optional(),
+	height: z.number().optional()
+}));
+/**
+* Represents a sound resource.
+*/
+const OBFSoundSchema = OBFMediaSchema;
+/**
+* Information needed to load another board.
+*/
+const OBFLoadBoardSchema = z.object({
+	id: OBFOptionalIDSchema,
+	name: z.string().optional(),
+	data_url: OBFOptionalUrlSchema,
+	url: OBFOptionalUrlSchema,
+	path: z.string().optional()
+});
+/**
+* Represents a button on the board.
+*/
+const OBFButtonSchema = z.object({
+	id: OBFIDSchema,
+	label: z.string().optional(),
+	vocalization: z.string().optional(),
+	image_id: OBFOptionalIDSchema,
+	sound_id: OBFOptionalIDSchema,
+	action: OBFButtonActionSchema.optional(),
+	actions: z.array(OBFButtonActionSchema).optional(),
+	load_board: OBFLoadBoardSchema.optional(),
+	background_color: z.string().optional(),
+	border_color: z.string().optional(),
+	top: z.number().min(0).max(1).optional(),
+	left: z.number().min(0).max(1).optional(),
+	width: z.number().min(0).max(1).optional(),
+	height: z.number().min(0).max(1).optional()
+});
+/**
+* Grid layout information for the board.
+*/
+const OBFGridSchema = z.object({
+	rows: z.number().int().min(1),
+	columns: z.number().int().min(1),
+	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" });
+/**
+* Represents the root object of an OBF file, defining the structure and layout of a board.
+*/
+const OBFBoardSchema = z.object({
+	format: OBFFormatVersionSchema,
+	id: OBFIDSchema,
+	locale: OBFLocaleCodeSchema.optional(),
+	buttons: z.array(OBFButtonSchema),
+	url: OBFOptionalUrlSchema,
+	name: z.string().optional(),
+	description_html: z.string().optional(),
+	grid: OBFGridSchema,
+	images: z.array(OBFImageSchema).optional(),
+	sounds: z.array(OBFSoundSchema).optional(),
+	license: OBFLicenseSchema.optional(),
+	strings: OBFStringsSchema.optional()
+});
+/**
+* Manifest file in an .obz package.
+*/
+const OBFManifestSchema = z.object({
+	format: OBFFormatVersionSchema,
+	root: z.string(),
+	paths: z.object({
+		boards: z.record(z.string(), z.string()),
+		images: z.record(z.string(), z.string()),
+		sounds: z.record(z.string(), z.string()).optional()
+	})
+});
+
+//#endregion
+//#region src/obf.ts
+const UTF8_BOM = "";
+function parseOBF(json) {
+	const trimmed = json.startsWith(UTF8_BOM) ? json.slice(1) : json;
+	let data;
+	try {
+		data = JSON.parse(trimmed);
+	} catch (error) {
+		throw new Error(`Invalid OBF: JSON parse failed${error?.message ? ` — ${error.message}` : ""}`);
+	}
+	return validateOBF(data);
+}
+async function loadOBF(file) {
+	return parseOBF(await file.text());
+}
+function validateOBF(data) {
+	const result = OBFBoardSchema.safeParse(data);
+	if (!result.success) throw new Error(`Invalid OBF: ${result.error.message}`);
+	return result.data;
+}
+function stringifyOBF(board) {
+	return JSON.stringify(board, null, 2);
+}
+
+//#endregion
+//#region src/zip.ts
+function unzip(buffer) {
+	return new Promise((resolve, reject) => {
+		unzip$1(new Uint8Array(buffer), (error, result) => {
+			if (error) {
+				reject(/* @__PURE__ */ new Error(`Failed to unzip: ${error.message ?? String(error)}`));
+				return;
+			}
+			const files = /* @__PURE__ */ new Map();
+			for (const [path, bytes] of Object.entries(result)) files.set(path, bytes);
+			resolve(files);
+		});
+	});
+}
+function zip(files) {
+	return new Promise((resolve, reject) => {
+		const input = {};
+		for (const [path, content] of files) input[path] = content instanceof Uint8Array ? content : new Uint8Array(content);
+		zip$1(input, { level: 6 }, (error, result) => {
+			if (error) {
+				reject(/* @__PURE__ */ new Error(`Failed to zip: ${error.message ?? String(error)}`));
+				return;
+			}
+			resolve(result);
+		});
+	});
+}
+function isZip(buffer) {
+	const view = new Uint8Array(buffer);
+	return view.length >= 2 && view[0] === 80 && view[1] === 75;
+}
+
+//#endregion
+//#region src/obz.ts
+/**
+* Load OBZ package from File
+* @param file - File object
+* @returns Parsed OBZ with manifest, boards, and files
+*/
+async function loadOBZ(file) {
+	return extractOBZ(await file.arrayBuffer());
+}
+/**
+* Extract OBZ package from ArrayBuffer
+* @param buffer - OBZ file as ArrayBuffer
+* @returns Parsed OBZ with manifest, boards, and files
+*/
+async function extractOBZ(buffer) {
+	if (!isZip(buffer)) throw new Error("Invalid OBZ: not a ZIP file");
+	const files = await unzip(buffer);
+	const manifestBuffer = files.get("manifest.json");
+	if (!manifestBuffer) throw new Error("Invalid OBZ: missing manifest.json");
+	const manifest = parseManifest(new TextDecoder().decode(manifestBuffer));
+	const boards = /* @__PURE__ */ new Map();
+	for (const [id, path] of Object.entries(manifest.paths.boards)) {
+		const boardBuffer = files.get(path);
+		if (!boardBuffer) {
+			console.warn(`Board ${id} not found at ${path}`);
+			continue;
+		}
+		const board = parseOBF(new TextDecoder().decode(boardBuffer));
+		boards.set(id, board);
+	}
+	return {
+		manifest,
+		boards,
+		files
+	};
+}
+/**
+* Parse manifest.json from OBZ package
+* @param json - Manifest JSON string
+* @returns Validated Manifest object
+*/
+function parseManifest(json) {
+	const data = JSON.parse(json);
+	const result = OBFManifestSchema.safeParse(data);
+	if (!result.success) throw new Error(`Invalid manifest: ${result.error.message}`);
+	return result.data;
+}
+/**
+* Create OBZ package from boards and resources
+* @param boards - Array of Board objects
+* @param rootBoardId - ID of the root board
+* @param resources - Optional map of resource paths to buffers
+* @returns OBZ package as Blob
+*/
+async function createOBZ(boards, rootBoardId, resources) {
+	const files = /* @__PURE__ */ new Map();
+	const manifest = OBFManifestSchema.parse({
+		format: "open-board-0.1",
+		root: `boards/${rootBoardId}.obf`,
+		paths: {
+			boards: Object.fromEntries(boards.map((board) => [board.id, `boards/${board.id}.obf`])),
+			images: {},
+			sounds: {}
+		}
+	});
+	const manifestJSON = JSON.stringify(manifest, null, 2);
+	files.set("manifest.json", new TextEncoder().encode(manifestJSON).buffer);
+	for (const board of boards) {
+		const boardJSON = JSON.stringify(board, null, 2);
+		const path = `boards/${board.id}.obf`;
+		files.set(path, new TextEncoder().encode(boardJSON).buffer);
+	}
+	if (resources) for (const [path, buffer] of resources.entries()) files.set(path, buffer);
+	const zipBuffer = await zip(files);
+	return new Blob([new Uint8Array(zipBuffer)], { type: "application/zip" });
+}
+
+//#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,48 @@
+{
+  "name": "open-board-format",
+  "type": "module",
+  "version": "1.0.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.3.0",
+    "bumpp": "^10.4.1",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "fflate": "^0.8.2",
+    "zod": "^4.3.6"
+  }
+}