open-board-format 1.0.4 → 1.0.5

package/dist/index.mjs

@@ -1,6 +1,5 @@
 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
@@ -59,11 +58,17 @@ const OBFButtonActionSchema = z.union([OBFSpellingActionSchema, OBFSpecialtyActi
 * License terms and attribution for a resource.
 */
 const OBFLicenseSchema = z.object({
+	/** 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
 });
 /**
@@ -75,19 +80,28 @@ const OBFLicenseSchema = z.object({
 * 3. url
 */
 const OBFMediaSchema = z.object({
+	/** 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.object({
+	/** Name of the symbol set, e.g., 'symbolstix'. */
 	set: z.string(),
+	/** Filename of the symbol within the set. */
 	filename: z.string()
 });
 /**
@@ -101,8 +115,11 @@ const OBFSymbolInfoSchema = z.object({
 * 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()
 }));
 /**
@@ -113,69 +130,111 @@ const OBFSoundSchema = OBFMediaSchema;
 * Reference to another board, resolved by ID, path, or URL.
 */
 const OBFLoadBoardSchema = z.object({
+	/** 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.object({
+	/** 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.object({
+	/** 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.object({
+	/** 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.object({
+	/** 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.object({
+		/** 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 = "";
@@ -245,7 +304,6 @@ function validateOBF(data) {
 function stringifyOBF(board) {
 	return JSON.stringify(board, null, 2);
 }
-
 //#endregion
 //#region src/zip.ts
 /**
@@ -313,7 +371,6 @@ 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
 /**
@@ -419,6 +476,5 @@ function extractBoards(manifest, entries) {
 	}
 	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 };
+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

@@ -1,7 +1,7 @@
 {
   "name": "open-board-format",
   "type": "module",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Parse, validate, and create Open Board Format (OBF/OBZ) files for AAC applications.",
   "author": "Shay Cojocaru <shayc@outlook.com>",
   "license": "MIT",
@@ -35,14 +35,14 @@
     "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"
+    "@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.3.6"
+    "zod": "^4.4.3"
   }
 }