parse-tmx 2.3.0 → 2.4.0

package/dist/index.d.ts

@@ -199,6 +199,8 @@ declare class TMXParsed {
 
 //#endregion
 //#region src/parseTmx.d.ts
+// We will match phaser's tmx => json tilemap export transformation
+// but also support extra functionality like using external tilesets
 declare const parseTmx: (xmlString: string, translateFlips?: boolean) => Promise<TMXParsed>;
 
 //#endregion
@@ -229,14 +231,20 @@ declare const isExternalTileset: (tileset: TMXEmbeddedTilesetShared | TMXExterna
 
 //#endregion
 //#region src/models/tmx/node/BaseTMXNode.d.ts
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
 declare class BaseTMXNode<T> {
   #private;
+  // We add indexable signature because we can't access #name properly
+  // due to typescript shenanigans with private properties >:C
   [key: string]: unknown;
   $: T;
 }
 
 //#endregion
 //#region src/models/tmx/node/TMXNode.d.ts
+// For convenience's sake, we will assume that parsing xml will always have
+// explicitChildren && preserveChildrenOrder set to true and we will type that instead
+// We deal with dynamic xml data by typing it explicitly in the specific types that extend this interface
 type TMXNode<T, TChildNode extends BaseTMXNode<unknown> | undefined = undefined> = BaseTMXNode<T> & {
   $$: TChildNode extends undefined ? undefined : TChildNode[];
 };
@@ -260,6 +268,8 @@ interface TMXPropertyNode extends TMXNode<{
   name: string;
   value?: string;
 }> {
+  // Phaser stores string with special unicode values as data
+  // instead of the value attribute, which is why value can be undefined
   _: string;
 }
 

package/dist/index.js

@@ -407,7 +407,7 @@ const DefaultBuilderOptions = {
 var require_xmlbuilder2_min = __commonJS({ "../../node_modules/.pnpm/xmlbuilder2@3.1.1/node_modules/xmlbuilder2/lib/xmlbuilder2.min.js"(exports$1, module$1) {
 	(function(e, t) {
 		"object" == typeof exports$1 && "object" == typeof module$1 ? module$1.exports = t() : "function" == typeof define && define.amd ? define([], t) : "object" == typeof exports$1 ? exports$1.xmlbuilder2 = t() : e.xmlbuilder2 = t();
-	})(exports$1, function() {
+	})(void 0, function() {
 		return function(e) {
 			var t = {};
 			function r(n) {
@@ -21910,7 +21910,7 @@ var require_sax = __commonJS({ "../../node_modules/.pnpm/sax@1.4.1/node_modules/
 			});
 			else String.fromCodePoint = fromCodePoint;
 		})();
-	})(typeof exports$1 === "undefined" ? exports$1.sax = {} : exports$1);
+	})(typeof exports$1 === "undefined" ? (void 0).sax = {} : exports$1);
 } });
 var import_sax = __toESM(require_sax(), 1);
 var Parser = class {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-tmx",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "A parser for tmx.",
   "type": "module",
   "homepage": "https://github.com/Esposter/Esposter#readme",
@@ -35,12 +35,12 @@
     "export:gen": "ctix build --config ../configuration/.ctirc-ts"
   },
   "dependencies": {
-    "@esposter/xml2js": "2.3.0",
+    "@esposter/xml2js": "2.4.0",
     "data-urls": "^5.0.0"
   },
   "devDependencies": {
     "@types/data-urls": "^3.0.4",
     "@types/xml2js": "^0.4.14"
   },
-  "gitHead": "5738dd0273ab8d7861296378a24903699b1fb4b8"
+  "gitHead": "b17224ff11ad2688c5406413ca6e066f3e565abf"
 }