parse-tmx 2.3.0 → 2.4.1

package/LICENSE

@@ -1,201 +1,201 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2020-present Jimmy Chen
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-present Jimmy Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,125 +1,125 @@
-# parse-tmx
-
-[![Apache-2.0 licensed][badge-license]][url-license]
-[![NPM version][badge-npm-version]][url-npm]
-[![NPM downloads][badge-npm-downloads]][url-npm]
-[![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
-
-Inspired by [tmx-map-parser](https://github.com/praghus/tmx-map-parser).
-A parser for [Tiled Map Editor](http://www.mapeditor.org/) \*.tmx files.
-
-### Table of Contents
-
-- 🚀 [Getting Started](#getting-started)
-- 📖 [Documentation](#documentation)
-- ⚖️ [License](#license)
-
----
-
-## <a name="getting-started">🚀 Getting Started</a>
-
-```bash
-pnpm i parse-tmx
-```
-
-## <a name="documentation">📖 Documentation</a>
-
-We highly recommend you take a look at the [documentation](https://esposter.com/docs/modules/parse_tmx.html) to level up.
-
-### Usage
-
-The basic implementation:
-
-```ts
-import { parseTmx } from "parse-tmx";
-// The *.tmx file can be loaded as a string or URL encoded data
-import map from "map.tmx";
-
-// Translates the tile flips in the layer data (default: false)
-const translateFlips = true;
-
-const loadMap = async () => {
-  const data = await parseTmx(map, translateFlips);
-  ...
-};
-```
-
-### Example data
-
-[TMX Map Format documentation](https://doc.mapeditor.org/en/stable/reference/tmx-map-format/)
-
-```js
-{
-    tiledversion: "1.8.0",
-    tilewidth: 16,
-    tileheight: 16,
-    version: 1.8,
-    width: 512,
-    height: 128,
-    infinite: 0,
-    nextlayerid: 5,
-    nextobjectid: 165,
-    orientation: "orthogonal",
-    renderorder: "right-down",
-    properties: {
-        property1: 'value',
-        property2: 0.5
-    },
-    layers: [{
-        id: 1,
-        name: "layer name",
-        type: "layer",
-        visible: 1,
-        data: [0, 1, 1, 10, 10, 10, 1, 1, 0, 0, 0, 0, …],
-        // When the translateFlips parameter is enabled
-        flips: [
-            {H: false, V: false, D: false},
-            {H: true, V: false, D: true},
-            {H: false, V: false, D: false},
-            {…}
-        ],
-        width: 512,
-        height: 128,
-        opacity: 0.77,
-        properties: {
-           property1: 'value',
-           property2: false
-        }
-    }, {
-        id: 2,
-        name: "objects",
-        type: "objectgroup",
-        visible: 1,
-        objects: [{…}, {…}, {…}],
-        properties: {
-           property1: 'value',
-           property2: false
-        }
-    }, {
-        …
-    }],
-    tilesets: [{
-        columns: 32,
-        firstgid: 1,
-        image: {source: "tiles.png", width: 512, height: 512},
-        name: "tiles",
-        tilecount: 1024,
-        tilewidth: 16,
-        tileheight: 16,
-        tiles: [{…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}]
-    }, {
-        …
-    }]
-}
-```
-
-## <a name="license">⚖️ License</a>
-
-This project is licensed under the [Apache-2.0 license](https://github.com/Esposter/Esposter/blob/main/LICENSE).
-
-[badge-license]: https://img.shields.io/github/license/Esposter/Esposter.svg?color=blue
-[url-license]: https://github.com/Esposter/Esposter/blob/main/LICENSE
-[badge-npm-version]: https://img.shields.io/npm/v/parse-tmx/latest?color=brightgreen
-[url-npm]: https://www.npmjs.com/package/parse-tmx/v/latest
-[badge-npm-unpacked-size]: https://img.shields.io/npm/unpacked-size/parse-tmx/latest?label=npm
-[badge-npm-downloads]: https://img.shields.io/npm/dm/parse-tmx.svg
+# parse-tmx
+
+[![Apache-2.0 licensed][badge-license]][url-license]
+[![NPM version][badge-npm-version]][url-npm]
+[![NPM downloads][badge-npm-downloads]][url-npm]
+[![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
+
+Inspired by [tmx-map-parser](https://github.com/praghus/tmx-map-parser).
+A parser for [Tiled Map Editor](http://www.mapeditor.org/) \*.tmx files.
+
+### Table of Contents
+
+- 🚀 [Getting Started](#getting-started)
+- 📖 [Documentation](#documentation)
+- ⚖️ [License](#license)
+
+---
+
+## <a name="getting-started">🚀 Getting Started</a>
+
+```bash
+pnpm i parse-tmx
+```
+
+## <a name="documentation">📖 Documentation</a>
+
+We highly recommend you take a look at the [documentation](https://esposter.com/docs/modules/parse_tmx.html) to level up.
+
+### Usage
+
+The basic implementation:
+
+```ts
+import { parseTmx } from "parse-tmx";
+// The *.tmx file can be loaded as a string or URL encoded data
+import map from "map.tmx";
+
+// Translates the tile flips in the layer data (default: false)
+const translateFlips = true;
+
+const loadMap = async () => {
+  const data = await parseTmx(map, translateFlips);
+  ...
+};
+```
+
+### Example data
+
+[TMX Map Format documentation](https://doc.mapeditor.org/en/stable/reference/tmx-map-format/)
+
+```js
+{
+    tiledversion: "1.8.0",
+    tilewidth: 16,
+    tileheight: 16,
+    version: 1.8,
+    width: 512,
+    height: 128,
+    infinite: 0,
+    nextlayerid: 5,
+    nextobjectid: 165,
+    orientation: "orthogonal",
+    renderorder: "right-down",
+    properties: {
+        property1: 'value',
+        property2: 0.5
+    },
+    layers: [{
+        id: 1,
+        name: "layer name",
+        type: "layer",
+        visible: 1,
+        data: [0, 1, 1, 10, 10, 10, 1, 1, 0, 0, 0, 0, …],
+        // When the translateFlips parameter is enabled
+        flips: [
+            {H: false, V: false, D: false},
+            {H: true, V: false, D: true},
+            {H: false, V: false, D: false},
+            {…}
+        ],
+        width: 512,
+        height: 128,
+        opacity: 0.77,
+        properties: {
+           property1: 'value',
+           property2: false
+        }
+    }, {
+        id: 2,
+        name: "objects",
+        type: "objectgroup",
+        visible: 1,
+        objects: [{…}, {…}, {…}],
+        properties: {
+           property1: 'value',
+           property2: false
+        }
+    }, {
+        …
+    }],
+    tilesets: [{
+        columns: 32,
+        firstgid: 1,
+        image: {source: "tiles.png", width: 512, height: 512},
+        name: "tiles",
+        tilecount: 1024,
+        tilewidth: 16,
+        tileheight: 16,
+        tiles: [{…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}]
+    }, {
+        …
+    }]
+}
+```
+
+## <a name="license">⚖️ License</a>
+
+This project is licensed under the [Apache-2.0 license](https://github.com/Esposter/Esposter/blob/main/LICENSE).
+
+[badge-license]: https://img.shields.io/github/license/Esposter/Esposter.svg?color=blue
+[url-license]: https://github.com/Esposter/Esposter/blob/main/LICENSE
+[badge-npm-version]: https://img.shields.io/npm/v/parse-tmx/latest?color=brightgreen
+[url-npm]: https://www.npmjs.com/package/parse-tmx/v/latest
+[badge-npm-unpacked-size]: https://img.shields.io/npm/unpacked-size/parse-tmx/latest?label=npm
+[badge-npm-downloads]: https://img.shields.io/npm/dm/parse-tmx.svg

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 //#region src/models/tmx/parsed/TMXEditorSettingsParsed.d.ts
 interface TMXEditorSettingsParsed extends Record<string, unknown> {}
-
 //#endregion
 //#region src/models/tmx/parsed/TMXFlipsParsed.d.ts
 interface TMXFlipsParsed {
@@ -8,7 +7,6 @@ interface TMXFlipsParsed {
   H: boolean;
   V: boolean;
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXImageShared.d.ts
 interface TMXImageShared {
@@ -16,11 +14,9 @@ interface TMXImageShared {
   source: string;
   width: number;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXImageParsed.d.ts
 interface TMXImageParsed extends TMXImageShared {}
-
 //#endregion
 //#region src/models/Shape.d.ts
 declare enum Shape {
@@ -29,11 +25,9 @@ declare enum Shape {
   Polygon = "polygon",
   Rectangle = "rectangle",
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXPropertiesParsed.d.ts
 type TMXPropertiesParsed = Record<string, unknown>[];
-
 //#endregion
 //#region src/models/tmx/shared/TMXObjectShared.d.ts
 interface TMXObjectShared {
@@ -45,7 +39,6 @@ interface TMXObjectShared {
   x: number;
   y: number;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXObjectParsed.d.ts
 interface TMXObjectParsed extends TMXObjectShared {
@@ -57,7 +50,6 @@ interface TMXObjectParsed extends TMXObjectShared {
   text?: string;
   value: string;
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXLayerShared.d.ts
 interface TMXLayerShared {
@@ -77,7 +69,6 @@ interface TMXLayerShared {
   x?: number;
   y?: number;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXLayerParsed.d.ts
 interface TMXLayerParsed extends TMXLayerShared {
@@ -87,7 +78,6 @@ interface TMXLayerParsed extends TMXLayerShared {
   objects?: TMXObjectParsed[];
   properties?: TMXPropertiesParsed;
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXGroupLayerShared.d.ts
 interface TMXGroupLayerShared {
@@ -95,14 +85,12 @@ interface TMXGroupLayerShared {
   name: string;
   type: string;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXGroupLayerParsed.d.ts
 interface TMXGroupLayerParsed extends TMXGroupLayerShared {
   layers: TMXLayerParsed[];
   properties?: TMXPropertiesParsed;
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXTileShared.d.ts
 interface TMXTileShared {
@@ -110,7 +98,6 @@ interface TMXTileShared {
   id: number;
   probability?: number;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXTileParsed.d.ts
 interface TMXTileParsed extends TMXTileShared {
@@ -122,13 +109,11 @@ interface TMXTileParsed extends TMXTileShared {
   properties?: TMXPropertiesParsed;
   type: string;
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXBaseTilesetShared.d.ts
 interface TMXBaseTilesetShared {
   firstgid: number;
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXEmbeddedTilesetShared.d.ts
 interface TMXEmbeddedTilesetShared extends TMXBaseTilesetShared {
@@ -142,28 +127,23 @@ interface TMXEmbeddedTilesetShared extends TMXBaseTilesetShared {
   tileheight: number;
   tilewidth: number;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXEmbeddedTilesetParsed.d.ts
 interface TMXEmbeddedTilesetParsed extends TMXEmbeddedTilesetShared {
   image: TMXImageParsed;
   tiles: TMXTileParsed[];
 }
-
 //#endregion
 //#region src/models/tmx/shared/TMXExternalTilesetShared.d.ts
 interface TMXExternalTilesetShared extends TMXBaseTilesetShared {
   source: string;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXExternalTilesetParsed.d.ts
 interface TMXExternalTilesetParsed extends TMXExternalTilesetShared {}
-
 //#endregion
 //#region src/models/tmx/parsed/TMXTilesetParsed.d.ts
 type TMXTilesetParsed = TMXEmbeddedTilesetParsed | TMXExternalTilesetParsed;
-
 //#endregion
 //#region src/models/tmx/shared/TMXMapShared.d.ts
 declare class TMXMapShared {
@@ -179,7 +159,6 @@ declare class TMXMapShared {
   version: number;
   width: number;
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXMapParsed.d.ts
 declare class TMXMapParsed extends TMXMapShared {
@@ -189,32 +168,29 @@ declare class TMXMapParsed extends TMXMapShared {
   tilesets: TMXTilesetParsed[];
   constructor(init?: Partial<TMXMapParsed>);
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXParsed.d.ts
 declare class TMXParsed {
   map: TMXMapParsed;
   constructor(map?: TMXMapParsed);
 }
-
 //#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
 //#region src/models/Compression.d.ts
 declare enum Compression {
   Gzip = "gzip",
   Zlib = "zlib",
 }
-
 //#endregion
 //#region src/models/Encoding.d.ts
 declare enum Encoding {
   Base64 = "base64",
   Csv = "csv",
 }
-
 //#endregion
 //#region src/models/Flipped.d.ts
 declare enum Flipped {
@@ -222,25 +198,27 @@ declare enum Flipped {
   Horizontally = 2147483648,
   Vertically = 1073741824,
 }
-
 //#endregion
 //#region src/util/isExternalTileset.d.ts
 declare const isExternalTileset: (tileset: TMXEmbeddedTilesetShared | TMXExternalTilesetShared) => tileset is TMXExternalTilesetShared;
-
 //#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[];
 };
-
 //#endregion
 //#region src/models/tmx/node/TMXDataNode.d.ts
 interface TMXDataNode extends TMXNode<{
@@ -249,24 +227,22 @@ interface TMXDataNode extends TMXNode<{
 }> {
   _: string;
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXImageNode.d.ts
 interface TMXImageNode extends TMXNode<TMXImageShared> {}
-
 //#endregion
 //#region src/models/tmx/node/TMXPropertyNode.d.ts
 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;
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXPropertiesNode.d.ts
 interface TMXPropertiesNode extends TMXNode<Record<string, never>, TMXPropertyNode> {}
-
 //#endregion
 //#region src/models/tmx/node/TMXObjectNode.d.ts
 interface TMXObjectNode extends TMXNode<TMXObjectShared, TMXDataNode | TMXPropertiesNode> {
@@ -278,7 +254,6 @@ interface TMXObjectNode extends TMXNode<TMXObjectShared, TMXDataNode | TMXProper
   }[];
   text?: TMXDataNode[];
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXTileNode.d.ts
 interface TMXTileNode extends TMXNode<TMXTileShared, TMXPropertiesNode> {
@@ -288,21 +263,17 @@ interface TMXTileNode extends TMXNode<TMXTileShared, TMXPropertiesNode> {
     property: TMXPropertyNode[];
   }[];
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXEmbeddedTilesetNode.d.ts
 interface TMXEmbeddedTilesetNode extends TMXNode<TMXEmbeddedTilesetShared, TMXImageNode | TMXTileNode> {
   tile?: TMXTileNode[];
 }
-
 //#endregion
 //#region src/util/isTMXEmbeddedTilesetNode.d.ts
 declare const isTMXEmbeddedTilesetNode: (node: TMXDataNode | TMXEmbeddedTilesetNode) => node is TMXEmbeddedTilesetNode;
-
 //#endregion
 //#region src/util/parseFlips.d.ts
 declare const parseFlips: (gid: number) => TMXFlipsParsed;
-
 //#endregion
 //#region src/models/tmx/node/TMXLayerNode.d.ts
 interface TMXLayerNode extends TMXNode<TMXLayerShared, TMXDataNode | TMXEmbeddedTilesetNode | TMXPropertiesNode> {
@@ -313,7 +284,6 @@ interface TMXLayerNode extends TMXNode<TMXLayerShared, TMXDataNode | TMXEmbedded
     property: TMXPropertyNode[];
   }[];
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXGroupLayerNode.d.ts
 interface TMXGroupLayerNode extends TMXNode<TMXGroupLayerShared, TMXLayerNode> {
@@ -321,94 +291,73 @@ interface TMXGroupLayerNode extends TMXNode<TMXGroupLayerShared, TMXLayerNode> {
     property: TMXPropertyNode[];
   }[];
 }
-
 //#endregion
 //#region src/util/parseGroup.d.ts
 declare const parseGroup: (node: TMXGroupLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXGroupLayerParsed>;
-
 //#endregion
 //#region src/util/parseLayer.d.ts
 declare const parseLayer: (node: TMXLayerNode) => TMXLayerParsed;
-
 //#endregion
 //#region src/util/parseNode.d.ts
 declare const parseNode: <TNode extends TMXGroupLayerNode | TMXLayerNode, TParsedNode = (TNode extends TMXLayerNode ? TMXLayerParsed : TMXGroupLayerParsed)>(node: TNode, expectedCount: number, translateFlips: boolean) => Promise<TParsedNode> | TParsedNode;
-
 //#endregion
 //#region src/util/parseObject.d.ts
 declare const parseObject: (node: TMXObjectNode) => TMXObjectParsed;
-
 //#endregion
 //#region src/util/parseObjectShape.d.ts
 declare const parseObjectShape: (node: TMXObjectNode) => Shape;
-
 //#endregion
 //#region src/util/parseProperties.d.ts
 declare const parseProperties: (properties: {
   property: TMXPropertyNode[];
 }[]) => TMXPropertiesParsed;
-
 //#endregion
 //#region src/util/parseTile.d.ts
 declare const parseTile: (node: TMXTileNode) => TMXTileParsed;
-
 //#endregion
 //#region src/util/parseTileId.d.ts
 declare const parseTileId: (gid: number) => number;
-
 //#endregion
 //#region src/util/parseTileLayer.d.ts
 declare const parseTileLayer: (node: TMXLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXLayerParsed>;
-
 //#endregion
 //#region src/models/tmx/node/TMXExternalTilesetNode.d.ts
 interface TMXExternalTilesetNode extends TMXNode<TMXExternalTilesetShared> {}
-
 //#endregion
 //#region src/models/tmx/node/TMXTilesetNode.d.ts
 type TMXTilesetNode = TMXEmbeddedTilesetNode | TMXExternalTilesetNode;
-
 //#endregion
 //#region src/util/parseTileset.d.ts
 declare const parseTileset: (node: TMXTilesetNode) => TMXTilesetParsed;
-
 //#endregion
 //#region src/util/parseXmlString.d.ts
 declare const parseXmlString: <T extends object>(xmlString: string) => Promise<T>;
-
 //#endregion
 //#region src/util/parseXmlValue.d.ts
 declare const parseXmlValue: (value: string) => boolean | number | string;
-
 //#endregion
 //#region src/util/unpackTileBytes.d.ts
 declare const unpackTileBytes: (buffer: Buffer, expectedCount: number) => number[];
-
 //#endregion
 //#region src/models/tmx/shared/TMXExportShared.d.ts
 interface TMXExportShared {
   format: string;
   target: string;
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXExportNode.d.ts
 interface TMXExportNode extends TMXNode<TMXExportShared> {}
-
 //#endregion
 //#region src/models/tmx/node/TMXEditorSettingsNode.d.ts
 interface TMXEditorSettingsNode extends TMXNode<Record<string, never>, TMXExportNode> {}
-
 //#endregion
 //#region src/models/tmx/node/TMXMapNode.d.ts
 interface TMXMapNode extends TMXNode<TMXMapShared, TMXEditorSettingsNode | TMXGroupLayerNode | TMXPropertiesNode | TMXTilesetNode> {}
-
 //#endregion
 //#region src/models/tmx/node/TMX.d.ts
 interface TMX {
   map: TMXMapNode;
 }
-
 //#endregion
 //#region src/models/tmx/node/TMXNodeType.d.ts
 declare enum TMXNodeType {
@@ -425,10 +374,8 @@ declare enum TMXNodeType {
   Property = "property",
   Tileset = "tileset",
 }
-
 //#endregion
 //#region src/models/tmx/parsed/TMXExportParsed.d.ts
 interface TMXExportParsed extends TMXExportShared {}
-
 //#endregion
 export { BaseTMXNode, Compression, Encoding, Flipped, Shape, TMX, TMXBaseTilesetShared, TMXDataNode, TMXEditorSettingsNode, TMXEditorSettingsParsed, TMXEmbeddedTilesetNode, TMXEmbeddedTilesetParsed, TMXEmbeddedTilesetShared, TMXExportNode, TMXExportParsed, TMXExportShared, TMXExternalTilesetNode, TMXExternalTilesetParsed, TMXExternalTilesetShared, TMXFlipsParsed, TMXGroupLayerNode, TMXGroupLayerParsed, TMXGroupLayerShared, TMXImageNode, TMXImageParsed, TMXImageShared, TMXLayerNode, TMXLayerParsed, TMXLayerShared, TMXMapNode, TMXMapParsed, TMXMapShared, TMXNode, TMXNodeType, TMXObjectNode, TMXObjectParsed, TMXObjectShared, TMXParsed, TMXPropertiesNode, TMXPropertiesParsed, TMXPropertyNode, TMXTileNode, TMXTileParsed, TMXTileShared, TMXTilesetNode, TMXTilesetParsed, isExternalTileset, isTMXEmbeddedTilesetNode, parseFlips, parseGroup, parseLayer, parseNode, parseObject, parseObjectShape, parseProperties, parseTile, parseTileId, parseTileLayer, parseTileset, parseTmx, parseXmlString, parseXmlValue, unpackTileBytes };

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 {
@@ -58904,7 +58904,7 @@ var require_parser = __commonJS$1({ "../../node_modules/.pnpm/data-urls@5.0.0/no
 
 //#endregion
 //#region src/util/parseXmlString.ts
-var import_parser = __toESM$1(require_parser());
+var import_parser = __toESM$1(require_parser(), 1);
 const parseXmlString = (xmlString) => {
 	const xml = (0, import_parser.default)(xmlString) ?? xmlString;
 	return parseStringPromise(xml, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-tmx",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "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.1",
     "data-urls": "^5.0.0"
   },
   "devDependencies": {
     "@types/data-urls": "^3.0.4",
     "@types/xml2js": "^0.4.14"
   },
-  "gitHead": "5738dd0273ab8d7861296378a24903699b1fb4b8"
+  "gitHead": "a21ed2057213eae49ea366f8866dfae2e5041163"
 }