open-board-format 1.0.5 → 1.1.0

package/dist/index.d.mts

@@ -63,7 +63,7 @@ declare const OBFLicenseSchema: z.ZodObject<{
   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.$loose>;
 type OBFLicense = z.infer<typeof OBFLicenseSchema>;
 /**
  * Common properties for media resources (images and sounds).
@@ -87,8 +87,8 @@ declare const OBFMediaSchema: z.ZodObject<{
     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.core.$loose>>;
+}, z.core.$loose>;
 type OBFMedia = z.infer<typeof OBFMediaSchema>;
 /**
  * Reference to a symbol in a proprietary symbol set (e.g., SymbolStix).
@@ -96,7 +96,7 @@ type OBFMedia = z.infer<typeof OBFMediaSchema>;
 declare const OBFSymbolInfoSchema: z.ZodObject<{
   set: z.ZodString;
   filename: z.ZodString;
-}, z.core.$strip>;
+}, z.core.$loose>;
 type OBFSymbolInfo = z.infer<typeof OBFSymbolInfoSchema>;
 /**
  * Image resource, extending {@link OBFMediaSchema} with optional
@@ -122,12 +122,12 @@ declare const OBFImageSchema: z.ZodIntersection<z.ZodObject<{
     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<{
+  }, z.core.$loose>>;
+}, z.core.$loose>, z.ZodObject<{
   symbol: z.ZodOptional<z.ZodObject<{
     set: z.ZodString;
     filename: z.ZodString;
-  }, z.core.$strip>>;
+  }, z.core.$loose>>;
   width: z.ZodOptional<z.ZodNumber>;
   height: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>>;
@@ -149,8 +149,8 @@ declare const OBFSoundSchema: z.ZodObject<{
     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.core.$loose>>;
+}, z.core.$loose>;
 type OBFSound = z.infer<typeof OBFSoundSchema>;
 /**
  * Reference to another board, resolved by ID, path, or URL.
@@ -161,7 +161,7 @@ declare const OBFLoadBoardSchema: z.ZodObject<{
   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>;
+}, z.core.$loose>;
 type OBFLoadBoard = z.infer<typeof OBFLoadBoardSchema>;
 /**
  * Interactive element on a board, optionally linked to images, sounds, and actions.
@@ -180,14 +180,14 @@ declare const OBFButtonSchema: z.ZodObject<{
     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>>;
+  }, 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.$strip>;
+}, z.core.$loose>;
 type OBFButton = z.infer<typeof OBFButtonSchema>;
 /**
  * Row-and-column layout that arranges buttons by their IDs.
@@ -196,7 +196,7 @@ 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>;
+}, z.core.$loose>;
 type OBFGrid = z.infer<typeof OBFGridSchema>;
 /**
  * Root object of an `.obf` file: the complete definition of a single communication board.
@@ -219,14 +219,14 @@ declare const OBFBoardSchema: z.ZodObject<{
       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>>;
+    }, 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.$strip>>;
+  }, 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>;
@@ -234,7 +234,7 @@ declare const OBFBoardSchema: 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>;
+  }, 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>;
@@ -249,12 +249,12 @@ declare const OBFBoardSchema: z.ZodObject<{
       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<{
+    }, z.core.$loose>>;
+  }, z.core.$loose>, z.ZodObject<{
     symbol: z.ZodOptional<z.ZodObject<{
       set: z.ZodString;
       filename: z.ZodString;
-    }, z.core.$strip>>;
+    }, z.core.$loose>>;
     width: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>>>>;
@@ -272,8 +272,8 @@ declare const OBFBoardSchema: z.ZodObject<{
       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.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>>>;
@@ -281,9 +281,9 @@ declare const OBFBoardSchema: z.ZodObject<{
     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.$loose>>;
   strings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
-}, z.core.$strip>;
+}, z.core.$loose>;
 type OBFBoard = z.infer<typeof OBFBoardSchema>;
 /**
  * Table of contents for an `.obz` package, mapping resource IDs to their archive paths.
@@ -295,8 +295,8 @@ declare const OBFManifestSchema: 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>;
+  }, z.core.$loose>;
+}, z.core.$loose>;
 type OBFManifest = z.infer<typeof OBFManifestSchema>;
 //#endregion
 //#region src/obf.d.ts

package/dist/index.mjs

@@ -57,7 +57,7 @@ const OBFButtonActionSchema = z.union([OBFSpellingActionSchema, OBFSpecialtyActi
 /**
 * License terms and attribution for a resource.
 */
-const OBFLicenseSchema = z.object({
+const OBFLicenseSchema = z.looseObject({
 	/** Type of the license, e.g., 'CC-BY-SA'. */
 	type: z.string(),
 	/** URL to the license terms. */
@@ -79,7 +79,7 @@ const OBFLicenseSchema = z.object({
 * 2. path
 * 3. url
 */
-const OBFMediaSchema = z.object({
+const OBFMediaSchema = z.looseObject({
 	/** Unique identifier for the media resource. */
 	id: OBFIDSchema,
 	/** Data URI containing the media data. */
@@ -98,7 +98,7 @@ const OBFMediaSchema = z.object({
 /**
 * Reference to a symbol in a proprietary symbol set (e.g., SymbolStix).
 */
-const OBFSymbolInfoSchema = z.object({
+const OBFSymbolInfoSchema = z.looseObject({
 	/** Name of the symbol set, e.g., 'symbolstix'. */
 	set: z.string(),
 	/** Filename of the symbol within the set. */
@@ -129,7 +129,7 @@ const OBFSoundSchema = OBFMediaSchema;
 /**
 * Reference to another board, resolved by ID, path, or URL.
 */
-const OBFLoadBoardSchema = z.object({
+const OBFLoadBoardSchema = z.looseObject({
 	/** Unique identifier of the board to load. */
 	id: OBFOptionalIDSchema,
 	/** Name of the board to load. */
@@ -144,7 +144,7 @@ const OBFLoadBoardSchema = z.object({
 /**
 * Interactive element on a board, optionally linked to images, sounds, and actions.
 */
-const OBFButtonSchema = z.object({
+const OBFButtonSchema = z.looseObject({
 	/** Unique identifier for the button. */
 	id: OBFIDSchema,
 	/** Label text displayed on the button. */
@@ -177,7 +177,7 @@ const OBFButtonSchema = z.object({
 /**
 * Row-and-column layout that arranges buttons by their IDs.
 */
-const OBFGridSchema = z.object({
+const OBFGridSchema = z.looseObject({
 	/** Number of rows in the grid. */
 	rows: z.number().int().min(1),
 	/** Number of columns in the grid. */
@@ -191,7 +191,7 @@ const OBFGridSchema = z.object({
 /**
 * Root object of an `.obf` file: the complete definition of a single communication board.
 */
-const OBFBoardSchema = z.object({
+const OBFBoardSchema = z.looseObject({
 	/** Format version of the Open Board Format, e.g., 'open-board-0.1'. */
 	format: OBFFormatVersionSchema,
 	/** Unique identifier for the board. */
@@ -220,13 +220,13 @@ const OBFBoardSchema = z.object({
 /**
 * Table of contents for an `.obz` package, mapping resource IDs to their archive paths.
 */
-const OBFManifestSchema = z.object({
+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.object({
+	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. */
@@ -440,15 +440,18 @@ function parseManifest(json) {
 * @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: {},
-			sounds: {}
+			images: imagePaths,
+			...Object.keys(soundPaths).length > 0 ? { sounds: soundPaths } : {}
 		}
 	});
 	const encoder = new TextEncoder();
@@ -461,6 +464,23 @@ async function createOBZ(boards, rootBoardId, resources) {
 	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");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "open-board-format",
   "type": "module",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Parse, validate, and create Open Board Format (OBF/OBZ) files for AAC applications.",
   "author": "Shay Cojocaru <shayc@outlook.com>",
   "license": "MIT",