parse-tmx 3.0.0 → 3.3.0

package/README.md

@@ -67,7 +67,8 @@ const loadMap = async () => {
         id: 1,
         name: "layer name",
         type: "layer",
-        visible: 1,
+        // Only written when the layer is hidden in Tiled
+        visible: 0,
         data: [0, 1, 1, 10, 10, 10, 1, 1, 0, 0, 0, 0, …],
         // When the translateFlips parameter is enabled
         flips: [
@@ -87,7 +88,6 @@ const loadMap = async () => {
         id: 2,
         name: "objects",
         type: "objectgroup",
-        visible: 1,
         objects: [{…}, {…}, {…}],
         properties: [
            {name: 'property1', value: 'value'},

package/dist/index.d.ts

@@ -215,7 +215,7 @@ export declare enum Flipped {
 }
 export declare const Flippeds: readonly Flipped[];
 //#endregion
-//#region src/util/checkIsExternalTileset.d.ts
+//#region src/services/checkIsExternalTileset.d.ts
 export declare const checkIsExternalTileset: (tileset: TMXEmbeddedTilesetShared | TMXExternalTilesetShared) => tileset is TMXExternalTilesetShared;
 //#endregion
 //#region src/models/tmx/node/TMXNodeType.d.ts
@@ -265,6 +265,11 @@ export interface TMXPropertyNode extends TMXNode<{
   _: string;
 }
 //#endregion
+//#region src/models/tmx/node/TMXPropertiesElement.d.ts
+export interface TMXPropertiesElement {
+  property: TMXPropertyNode[];
+}
+//#endregion
 //#region src/models/tmx/node/TMXPropertiesNode.d.ts
 export interface TMXPropertiesNode extends TMXNode<Record<string, never>, TMXPropertyNode> {}
 //#endregion
@@ -278,9 +283,7 @@ export interface TMXObjectNode extends TMXNode<TMXObjectShared, TMXDataNode | TM
   polygon?: TMXNode<{
     points: string;
   }>[];
-  properties?: {
-    property: TMXPropertyNode[];
-  }[];
+  properties?: TMXPropertiesElement[];
   text?: TMXTextNode[];
 }
 //#endregion
@@ -288,9 +291,7 @@ export interface TMXObjectNode extends TMXNode<TMXObjectShared, TMXDataNode | TM
 export interface TMXTileNode extends TMXNode<TMXTileShared, TMXPropertiesNode> {
   animation?: Record<string, TMXNode<number>[]>[];
   objectgroup?: Record<string, TMXObjectNode[]>[];
-  properties?: {
-    property: TMXPropertyNode[];
-  }[];
+  properties?: TMXPropertiesElement[];
 }
 //#endregion
 //#region src/models/tmx/node/TMXEmbeddedTilesetNode.d.ts
@@ -298,16 +299,19 @@ export interface TMXEmbeddedTilesetNode extends TMXNode<TMXEmbeddedTilesetShared
   tile?: TMXTileNode[];
 }
 //#endregion
-//#region src/util/checkIsTMXEmbeddedTilesetNode.d.ts
+//#region src/services/checkIsTMXEmbeddedTilesetNode.d.ts
 export declare const checkIsTMXEmbeddedTilesetNode: (node: TMXDataNode | TMXEmbeddedTilesetNode) => node is TMXEmbeddedTilesetNode;
 //#endregion
-//#region src/util/cloneNodeWithType.d.ts
+//#region src/services/cloneNodeWithType.d.ts
 export declare const cloneNodeWithType: <TParsed>(node: BaseTMXNode<unknown>) => TParsed;
 //#endregion
-//#region src/util/getDecompressedBytes.d.ts
+//#region src/services/decodeTileData.d.ts
+export declare const decodeTileData: (nodeData: TMXDataNode | TMXEmbeddedTilesetNode) => Promise<number[]>;
+//#endregion
+//#region src/services/getDecompressedBytes.d.ts
 export declare const getDecompressedBytes: (bytes: Uint8Array<ArrayBuffer>, compression: Compression.Gzip | Compression.Zlib) => Promise<Uint8Array<ArrayBuffer>>;
 //#endregion
-//#region src/util/parseFlips.d.ts
+//#region src/services/parseFlips.d.ts
 export declare const parseFlips: (gid: number) => TMXFlipsParsed;
 //#endregion
 //#region src/models/tmx/node/TMXLayerNode.d.ts
@@ -315,46 +319,37 @@ export interface TMXLayerNode extends TMXNode<TMXLayerShared, TMXDataNode | TMXE
   data?: TMXDataNode[] | TMXEmbeddedTilesetNode[];
   image?: TMXImageNode[];
   object?: TMXObjectNode[];
-  properties?: {
-    property: TMXPropertyNode[];
-  }[];
+  properties?: TMXPropertiesElement[];
 }
 //#endregion
+//#region src/services/parseLayer.d.ts
+export declare const parseLayer: (node: TMXLayerNode) => TMXLayerParsed;
+//#endregion
 //#region src/models/tmx/node/TMXGroupLayerNode.d.ts
 export interface TMXGroupLayerNode extends TMXNode<TMXGroupLayerShared, TMXLayerNode> {
-  properties?: {
-    property: TMXPropertyNode[];
-  }[];
+  properties?: TMXPropertiesElement[];
 }
 //#endregion
-//#region src/util/parseGroup.d.ts
-export declare const parseGroup: (node: TMXGroupLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXGroupLayerParsed>;
-//#endregion
-//#region src/util/parseLayer.d.ts
-export declare const parseLayer: (node: TMXLayerNode) => TMXLayerParsed;
+//#region src/services/parseNode.d.ts
+export declare const parseNode: <TNode extends TMXGroupLayerNode | TMXLayerNode, TParsedNode = TNode extends TMXLayerNode ? TMXLayerParsed : TMXGroupLayerParsed>(node: TNode, tileCount: number, translateFlips: boolean) => Promise<TParsedNode>;
 //#endregion
-//#region src/util/parseNode.d.ts
-export declare const parseNode: <TNode extends TMXGroupLayerNode | TMXLayerNode, TParsedNode = TNode extends TMXLayerNode ? TMXLayerParsed : TMXGroupLayerParsed>(node: TNode, expectedCount: number, translateFlips: boolean) => Promise<TParsedNode>;
-//#endregion
-//#region src/util/parseObject.d.ts
+//#region src/services/parseObject.d.ts
 export declare const parseObject: (node: TMXObjectNode) => TMXObjectParsed;
 //#endregion
-//#region src/util/parseObjectShape.d.ts
+//#region src/services/parseObjectShape.d.ts
 export declare const parseObjectShape: (node: TMXObjectNode) => Shape;
 //#endregion
-//#region src/util/parseProperties.d.ts
-export declare const parseProperties: (properties: {
-  property: TMXPropertyNode[];
-}[]) => TMXPropertiesParsed;
+//#region src/services/parseProperties.d.ts
+export declare const parseProperties: (properties: TMXPropertiesElement[]) => TMXPropertiesParsed;
 //#endregion
-//#region src/util/parseTile.d.ts
+//#region src/services/parseTile.d.ts
 export declare const parseTile: (node: TMXTileNode) => TMXTileParsed;
 //#endregion
-//#region src/util/parseTileId.d.ts
+//#region src/services/parseTileId.d.ts
 export declare const parseTileId: (gid: number) => number;
 //#endregion
-//#region src/util/parseTileLayer.d.ts
-export declare const parseTileLayer: (node: TMXLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXLayerParsed>;
+//#region src/services/parseTileLayer.d.ts
+export declare const parseTileLayer: (node: TMXLayerNode, tileCount: number, translateFlips: boolean) => Promise<TMXLayerParsed>;
 //#endregion
 //#region src/models/tmx/node/TMXExternalTilesetNode.d.ts
 export interface TMXExternalTilesetNode extends TMXNode<TMXExternalTilesetShared> {}
@@ -362,17 +357,17 @@ export interface TMXExternalTilesetNode extends TMXNode<TMXExternalTilesetShared
 //#region src/models/tmx/node/TMXTilesetNode.d.ts
 export type TMXTilesetNode = TMXEmbeddedTilesetNode | TMXExternalTilesetNode;
 //#endregion
-//#region src/util/parseTileset.d.ts
+//#region src/services/parseTileset.d.ts
 export declare const parseTileset: (node: TMXTilesetNode) => TMXTilesetParsed;
 //#endregion
-//#region src/util/parseXmlString.d.ts
+//#region src/services/parseXmlString.d.ts
 export declare const parseXmlString: <T extends object>(xmlString: string) => Promise<T>;
 //#endregion
-//#region src/util/parseXmlValue.d.ts
+//#region src/services/parseXmlValue.d.ts
 export declare const parseXmlValue: (value: string) => boolean | number | string;
 //#endregion
-//#region src/util/unpackTileBytes.d.ts
-export declare const unpackTileBytes: (bytes: Uint8Array, expectedCount: number) => number[];
+//#region src/services/unpackTileBytes.d.ts
+export declare const unpackTileBytes: (bytes: Uint8Array) => number[];
 //#endregion
 //#region src/models/tmx/node/TMXExportNode.d.ts
 export interface TMXExportNode extends TMXNode<TMXExportShared> {}

package/dist/index.js

@@ -1,6 +1,5 @@
 import { InvalidOperationError, Operation, exhaustiveGuard, normalizeString, takeOne } from "@esposter/shared";
 import { parseStringPromise } from "@esposter/xml2js";
-import parseDataUrl from "data-urls";
 //#region src/models/tmx/node/TMXNodeType.ts
 let TMXNodeType = /* @__PURE__ */ function(TMXNodeType) {
 	TMXNodeType["Data"] = "data";
@@ -53,19 +52,11 @@ var TMXParsed = class {
 	}
 };
 //#endregion
-//#region src/util/cloneNodeWithType.ts
+//#region src/services/cloneNodeWithType.ts
 const cloneNodeWithType = (node) => {
-	const parsed = structuredClone(node.$);
-	parsed.type = node["#name"];
-	return parsed;
-};
-//#endregion
-//#region src/util/parseGroup.ts
-const parseGroup = async (node, expectedCount, translateFlips) => {
-	const { $$ } = node;
-	const group = cloneNodeWithType(node);
-	group.layers = await Promise.all($$.map((l) => parseNode(l, expectedCount, translateFlips)));
-	return group;
+	const attributes = structuredClone(node.$);
+	attributes.type = node["#name"];
+	return attributes;
 };
 //#endregion
 //#region src/models/Flipped.ts
@@ -77,7 +68,7 @@ let Flipped = /* @__PURE__ */ function(Flipped) {
 }({});
 const Flippeds = Object.values(Flipped).filter((value) => typeof value === "number");
 //#endregion
-//#region src/util/parseFlips.ts
+//#region src/services/parseFlips.ts
 const parseFlips = (gid) => ({
 	Diagonal: Boolean(gid & 536870912),
 	Horizontal: Boolean(gid & 2147483648),
@@ -93,7 +84,7 @@ let Shape = /* @__PURE__ */ function(Shape) {
 	return Shape;
 }({});
 //#endregion
-//#region src/util/parseObjectShape.ts
+//#region src/services/parseObjectShape.ts
 const parseObjectShape = (node) => {
 	if ("point" in node) return "point";
 	else if ("ellipse" in node) return "ellipse";
@@ -101,17 +92,17 @@ const parseObjectShape = (node) => {
 	else return "rectangle";
 };
 //#endregion
-//#region src/util/parseProperties.ts
+//#region src/services/parseProperties.ts
 const parseProperties = (properties) => properties.flatMap(({ property }) => property.map(({ $: { name, value }, _ }) => ({
 	name,
 	value: value ?? _
 })));
 //#endregion
-//#region src/util/parseTileId.ts
+//#region src/services/parseTileId.ts
 const FLIPPED_MASK = ~Flippeds.reduce((accumulator, flipped) => accumulator | flipped, 0);
 const parseTileId = (gid) => gid & FLIPPED_MASK;
 //#endregion
-//#region src/util/parseObject.ts
+//#region src/services/parseObject.ts
 const parseObject = (node) => {
 	const { $, polygon, properties, text } = node;
 	const object = structuredClone($);
@@ -138,13 +129,12 @@ const parseObject = (node) => {
 	return object;
 };
 //#endregion
-//#region src/util/parseLayer.ts
+//#region src/services/parseLayer.ts
 const parseLayer = (node) => {
 	const { image, object, properties } = node;
 	const layer = cloneNodeWithType(node);
-	layer.visible = 1;
 	if (image) layer.image = structuredClone(takeOne(image).$);
-	if (object) layer.objects = object.map((o) => parseObject(o));
+	if (object) layer.objects = object.map((objectNode) => parseObject(objectNode));
 	if (properties) layer.properties = parseProperties(properties);
 	return layer;
 };
@@ -163,109 +153,108 @@ let Encoding = /* @__PURE__ */ function(Encoding) {
 	return Encoding;
 }({});
 //#endregion
-//#region src/util/checkIsTMXEmbeddedTilesetNode.ts
+//#region src/services/checkIsTMXEmbeddedTilesetNode.ts
 const checkIsTMXEmbeddedTilesetNode = (node) => "tile" in node;
 //#endregion
-//#region src/util/getDecompressedBytes.ts
+//#region src/services/getDecompressedBytes.ts
 const getDecompressedBytes = async (bytes, compression) => {
 	const format = compression === "gzip" ? "gzip" : "deflate";
 	const decompressedTileStream = new Blob([bytes]).stream().pipeThrough(new DecompressionStream(format));
 	return new Uint8Array(await new Response(decompressedTileStream).arrayBuffer());
 };
 //#endregion
-//#region src/util/unpackTileBytes.ts
-const unpackTileBytes = (bytes, expectedCount) => {
-	if (bytes.byteLength !== expectedCount) throw new InvalidOperationError(Operation.Read, "TMXLayer", `expected ${expectedCount} bytes of tile data, received ${bytes.byteLength}`);
+//#region src/services/unpackTileBytes.ts
+const unpackTileBytes = (bytes) => {
+	if (bytes.byteLength % Uint32Array.BYTES_PER_ELEMENT !== 0) throw new InvalidOperationError(Operation.Read, "TMXLayer", `expected whole ${Uint32Array.BYTES_PER_ELEMENT}-byte tiles, received ${bytes.byteLength} bytes`);
 	const unpackedTiles = [];
 	const dataView = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
-	for (let i = 0; i < expectedCount; i += 4) unpackedTiles.push(dataView.getUint32(i, true));
+	for (let byteIndex = 0; byteIndex < bytes.byteLength; byteIndex += Uint32Array.BYTES_PER_ELEMENT) unpackedTiles.push(dataView.getUint32(byteIndex, true));
 	return unpackedTiles;
 };
 //#endregion
-//#region src/util/parseTileLayer.ts
-const parseTileLayer = async (node, expectedCount, translateFlips) => {
+//#region src/services/decodeTileData.ts
+const decodeTileData = async (nodeData) => {
+	if (checkIsTMXEmbeddedTilesetNode(nodeData)) return nodeData.tile?.map(({ $ }) => $.gid ?? 0) ?? [];
+	const { $, _ } = nodeData;
+	const { compression, encoding } = $;
+	const layerData = normalizeString(_);
+	switch (encoding) {
+		case "base64": {
+			const bytes = Uint8Array.fromBase64(layerData);
+			switch (compression) {
+				case "gzip":
+				case "zlib": return unpackTileBytes(await getDecompressedBytes(bytes, compression));
+				case void 0: return unpackTileBytes(bytes);
+				default: return exhaustiveGuard(compression);
+			}
+		}
+		case "csv": return layerData.split(",").map(Number);
+		default: return exhaustiveGuard(encoding);
+	}
+};
+//#endregion
+//#region src/services/parseTileLayer.ts
+const parseTileLayer = async (node, tileCount, translateFlips) => {
 	const { data, properties } = node;
 	if (!data) throw new InvalidOperationError(Operation.Read, "TMXLayer", "data is missing");
 	const layer = cloneNodeWithType(node);
 	if (properties) layer.properties = parseProperties(properties);
 	const nodeData = takeOne(data);
-	if (checkIsTMXEmbeddedTilesetNode(nodeData)) layer.data = nodeData.tile?.map(({ $ }) => $.gid ?? 0) ?? [];
-	else {
-		const { $, _ } = nodeData;
-		const { compression, encoding } = $;
-		const layerData = normalizeString(_);
-		switch (encoding) {
-			case "base64": {
-				const bytes = Uint8Array.fromBase64(layerData);
-				switch (compression) {
-					case "gzip":
-					case "zlib":
-						layer.data = unpackTileBytes(await getDecompressedBytes(bytes, compression), expectedCount);
-						break;
-					case void 0:
-						layer.data = unpackTileBytes(bytes, expectedCount);
-						break;
-					default: exhaustiveGuard(compression);
-				}
-				break;
-			}
-			case "csv":
-				layer.data = layerData.split(",").map(Number);
-				break;
-			default: exhaustiveGuard(encoding);
-		}
-	}
+	const tiles = await decodeTileData(nodeData);
+	if (tiles.length !== tileCount) throw new InvalidOperationError(Operation.Read, "TMXLayer", `expected ${tileCount} tiles, received ${tiles.length}`);
 	if (translateFlips) {
-		layer.data ??= [];
-		layer.flips = layer.data.map((gid) => parseFlips(gid));
-		layer.data = layer.data.map((gid) => parseTileId(gid));
-	}
+		layer.data = tiles.map((gid) => parseTileId(gid));
+		layer.flips = tiles.map((gid) => parseFlips(gid));
+	} else layer.data = tiles;
 	return layer;
 };
 //#endregion
-//#region src/util/parseNode.ts
-const parseNode = (node, expectedCount, translateFlips) => {
+//#region src/services/parseNode.ts
+const parseGroup = async (node, tileCount, translateFlips) => {
+	const group = cloneNodeWithType(node);
+	group.layers = await Promise.all(node.$$.map((layerNode) => parseNode(layerNode, tileCount, translateFlips)));
+	return group;
+};
+const parseNode = (node, tileCount, translateFlips) => {
 	const tmxNodeType = node["#name"];
 	switch (tmxNodeType) {
-		case "group": return parseGroup(node, expectedCount, translateFlips);
+		case "group": return parseGroup(node, tileCount, translateFlips);
 		case "imagelayer":
 		case "objectgroup": return Promise.resolve(parseLayer(node));
-		case "layer": return parseTileLayer(node, expectedCount, translateFlips);
+		case "layer": return parseTileLayer(node, tileCount, translateFlips);
 		default: throw new InvalidOperationError(Operation.Read, parseNode.name, tmxNodeType);
 	}
 };
 //#endregion
-//#region src/util/checkIsExternalTileset.ts
+//#region src/services/checkIsExternalTileset.ts
 const checkIsExternalTileset = (tileset) => "source" in tileset;
 //#endregion
-//#region src/util/parseTile.ts
+//#region src/services/parseTile.ts
 const parseTile = (node) => {
 	const { $, animation, objectgroup, properties } = node;
 	const tile = structuredClone($);
 	if (animation) tile.animation = { frames: takeOne(takeOne(animation), "frame").map(({ $: frameData }) => structuredClone(frameData)) };
-	if (objectgroup) tile.objects = takeOne(takeOne(objectgroup), "object").map((o) => parseObject(o));
+	if (objectgroup) tile.objects = takeOne(takeOne(objectgroup), "object").map((objectNode) => parseObject(objectNode));
 	if (properties) tile.properties = parseProperties(properties);
 	return tile;
 };
 //#endregion
-//#region src/util/parseTileset.ts
+//#region src/services/parseTileset.ts
 const parseTileset = (node) => {
 	if (checkIsExternalTileset(node.$)) return structuredClone(node.$);
 	const { $, $$, tile } = node;
-	for (const childNode of $$) {
-		if (childNode["#name"] !== "image") continue;
-		const image = structuredClone(childNode.$);
-		const tiles = tile?.map((t) => parseTile(t)) ?? [];
-		return {
-			...$,
-			image,
-			tiles
-		};
-	}
-	throw new InvalidOperationError(Operation.Read, parseTileset.name, $.name);
+	const imageNode = $$.find((childNode) => childNode["#name"] === "image");
+	if (!imageNode) throw new InvalidOperationError(Operation.Read, parseTileset.name, $.name);
+	const image = structuredClone(imageNode.$);
+	const tiles = tile?.map((tileNode) => parseTile(tileNode)) ?? [];
+	return {
+		...$,
+		image,
+		tiles
+	};
 };
 //#endregion
-//#region src/util/parseXmlValue.ts
+//#region src/services/parseXmlValue.ts
 const NUMBER_REGEX = /^[+-]?\d+(?<decimal>\.\d+)?$/u;
 const parseXmlValue = (value) => {
 	if (value === "true") return true;
@@ -274,21 +263,18 @@ const parseXmlValue = (value) => {
 	else return value;
 };
 //#endregion
-//#region src/util/parseXmlString.ts
-const parseXmlString = (xmlString) => {
-	const xml = parseDataUrl(xmlString) ?? xmlString;
-	return parseStringPromise(xml, {
-		attrValueProcessors: [(value) => parseXmlValue(value)],
-		explicitChildren: true,
-		preserveChildrenOrder: true
-	});
-};
+//#region src/services/parseXmlString.ts
+const parseXmlString = (xmlString) => parseStringPromise(xmlString, {
+	attrValueProcessors: [(value) => parseXmlValue(value)],
+	explicitChildren: true,
+	preserveChildrenOrder: true
+});
 //#endregion
 //#region src/parseTmx.ts
 const parseTmx = async (xmlString, translateFlips = false) => {
 	const { map: { $, $$ } } = await parseXmlString(xmlString);
 	const map = new TMXMapParsed($);
-	const expectedCount = map.width * map.height * 4;
+	const tileCount = map.width * map.height;
 	for (const node of $$) {
 		const tmxNodeType = node["#name"];
 		switch (tmxNodeType) {
@@ -305,7 +291,7 @@ const parseTmx = async (xmlString, translateFlips = false) => {
 			case "imagelayer":
 			case "layer":
 			case "objectgroup": {
-				const layer = await parseNode(node, expectedCount, translateFlips);
+				const layer = await parseNode(node, tileCount, translateFlips);
 				map.layers.push(layer);
 				break;
 			}
@@ -328,4 +314,4 @@ var BaseTMXNode = class {
 	$;
 };
 //#endregion
-export { BaseTMXNode, Compression, Encoding, Flipped, Flippeds, Shape, TMXMapParsed, TMXMapShared, TMXNodeType, TMXParsed, checkIsExternalTileset, checkIsTMXEmbeddedTilesetNode, cloneNodeWithType, getDecompressedBytes, parseFlips, parseGroup, parseLayer, parseNode, parseObject, parseObjectShape, parseProperties, parseTile, parseTileId, parseTileLayer, parseTileset, parseTmx, parseXmlString, parseXmlValue, unpackTileBytes };
+export { BaseTMXNode, Compression, Encoding, Flipped, Flippeds, Shape, TMXMapParsed, TMXMapShared, TMXNodeType, TMXParsed, checkIsExternalTileset, checkIsTMXEmbeddedTilesetNode, cloneNodeWithType, decodeTileData, getDecompressedBytes, parseFlips, parseLayer, parseNode, parseObject, parseObjectShape, parseProperties, parseTile, parseTileId, parseTileLayer, parseTileset, parseTmx, parseXmlString, parseXmlValue, unpackTileBytes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-tmx",
-  "version": "3.0.0",
+  "version": "3.3.0",
   "description": "A parser for tmx.",
   "keywords": [
     "game-development",
@@ -52,19 +52,16 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@esposter/shared": "3.0.0",
-    "@esposter/xml2js": "3.0.0",
-    "data-urls": "^7.0.0"
+    "@esposter/shared": "3.3.0",
+    "@esposter/xml2js": "3.3.0"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@esposter/configuration": "3.0.0",
-    "@types/data-urls": "^3.0.5",
-    "@types/xml2js": "^0.4.14",
+    "@esposter/configuration": "3.3.0",
     "publint": "^0.3.24",
     "tsdown": "^0.23.0",
-    "type-fest": "^5.9.0",
-    "vitest": "^5.0.0"
+    "type-fest": "^5.10.0",
+    "vitest": "^5.0.2"
   },
-  "gitHead": "5ea72289bdd594e598aab8fefd5686df2a642a7e"
+  "gitHead": "5854a00717502d8de96adc8b44d3621ab85f9b57"
 }