parse-tmx 3.0.0 → 3.2.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
@@ -298,16 +298,16 @@ 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/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
@@ -327,33 +327,33 @@ export interface TMXGroupLayerNode extends TMXNode<TMXGroupLayerShared, TMXLayer
   }[];
 }
 //#endregion
-//#region src/util/parseGroup.d.ts
+//#region src/services/parseGroup.d.ts
 export declare const parseGroup: (node: TMXGroupLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXGroupLayerParsed>;
 //#endregion
-//#region src/util/parseLayer.d.ts
+//#region src/services/parseLayer.d.ts
 export declare const parseLayer: (node: TMXLayerNode) => TMXLayerParsed;
 //#endregion
-//#region src/util/parseNode.d.ts
+//#region src/services/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
+//#region src/services/parseProperties.d.ts
 export declare const parseProperties: (properties: {
   property: TMXPropertyNode[];
 }[]) => 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
+//#region src/services/parseTileLayer.d.ts
 export declare const parseTileLayer: (node: TMXLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXLayerParsed>;
 //#endregion
 //#region src/models/tmx/node/TMXExternalTilesetNode.d.ts
@@ -362,16 +362,16 @@ 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
+//#region src/services/unpackTileBytes.d.ts
 export declare const unpackTileBytes: (bytes: Uint8Array, expectedCount: number) => number[];
 //#endregion
 //#region src/models/tmx/node/TMXExportNode.d.ts

package/dist/index.js

@@ -53,14 +53,14 @@ 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
+//#region src/services/parseGroup.ts
 const parseGroup = async (node, expectedCount, translateFlips) => {
 	const { $$ } = node;
 	const group = cloneNodeWithType(node);
@@ -77,7 +77,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 +93,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 +101,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,11 +138,10 @@ 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 (properties) layer.properties = parseProperties(properties);
@@ -163,17 +162,17 @@ 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
+//#region src/services/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}`);
 	const unpackedTiles = [];
@@ -182,7 +181,7 @@ const unpackTileBytes = (bytes, expectedCount) => {
 	return unpackedTiles;
 };
 //#endregion
-//#region src/util/parseTileLayer.ts
+//#region src/services/parseTileLayer.ts
 const parseTileLayer = async (node, expectedCount, translateFlips) => {
 	const { data, properties } = node;
 	if (!data) throw new InvalidOperationError(Operation.Read, "TMXLayer", "data is missing");
@@ -223,7 +222,7 @@ const parseTileLayer = async (node, expectedCount, translateFlips) => {
 	return layer;
 };
 //#endregion
-//#region src/util/parseNode.ts
+//#region src/services/parseNode.ts
 const parseNode = (node, expectedCount, translateFlips) => {
 	const tmxNodeType = node["#name"];
 	switch (tmxNodeType) {
@@ -235,20 +234,20 @@ const parseNode = (node, expectedCount, translateFlips) => {
 	}
 };
 //#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;
@@ -265,7 +264,7 @@ const parseTileset = (node) => {
 	throw new InvalidOperationError(Operation.Read, parseTileset.name, $.name);
 };
 //#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,7 +273,7 @@ const parseXmlValue = (value) => {
 	else return value;
 };
 //#endregion
-//#region src/util/parseXmlString.ts
+//#region src/services/parseXmlString.ts
 const parseXmlString = (xmlString) => {
 	const xml = parseDataUrl(xmlString) ?? xmlString;
 	return parseStringPromise(xml, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-tmx",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "A parser for tmx.",
   "keywords": [
     "game-development",
@@ -52,19 +52,19 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@esposter/shared": "3.0.0",
-    "@esposter/xml2js": "3.0.0",
+    "@esposter/shared": "3.2.0",
+    "@esposter/xml2js": "3.2.0",
     "data-urls": "^7.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@esposter/configuration": "3.0.0",
+    "@esposter/configuration": "3.2.0",
     "@types/data-urls": "^3.0.5",
     "@types/xml2js": "^0.4.14",
     "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.1"
   },
-  "gitHead": "5ea72289bdd594e598aab8fefd5686df2a642a7e"
+  "gitHead": "bc055ed2f154eff219a355016a6b586962dbfa9c"
 }