parse-tmx 1.20.2 → 1.21.0

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Jimmy Chen
+   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.

package/README.md

@@ -1,15 +1,39 @@
-# parse-tmx [![NPM Version](https://img.shields.io/npm/v/parse-tmx.svg?style=flat)](https://www.npmjs.org/package/parse-tmx)
+# parse-tmx
+
+<p>
+  <a href="https://www.npmjs.com/package/parse-tmx">
+    <img src="https://img.shields.io/npm/v/parse-tmx.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version">
+  </a>
+  <a href="https://www.npmjs.com/package/parse-tmx">
+    <img src="https://img.shields.io/npm/dm/parse-tmx.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads">
+  </a>
+  <a href="https://github.com/Esposter/Esposter/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/Esposter/Esposter.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License">
+  </a>
+</p>
 
 Inspired by [tmx-map-parser](https://github.com/praghus/tmx-map-parser).
 A parser for [Tiled Map Editor](http://www.mapeditor.org/) \*.tmx files.
 
-## Installation
+### Table of Contents
+
+- 🚀 [Getting Started](#getting-started)
+- 📖 [Documentation](#documentation)
+- ⚖️ [License](#license)
+
+---
 
-```sh
+## <a name="getting-started">🚀 Getting Started</a>
+
+```bash
 pnpm i parse-tmx
 ```
 
-## Usage
+## <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:
 
@@ -28,11 +52,11 @@ const loadMap = async () => {
 };
 ```
 
-### Important
+#### Important
 
 Parser only supports embedded tilesets. At the moment, external tilesets are not supported!
 
-## Example data
+### Example data
 
 [TMX Map Format documentation](https://doc.mapeditor.org/en/stable/reference/tmx-map-format/)
 
@@ -101,6 +125,6 @@ Parser only supports embedded tilesets. At the moment, external tilesets are not
 }
 ```
 
-## License
+## <a name="license">⚖️ License</a>
 
-[Apache-2.0 licensed](../../LICENSE).
+[Apache-2.0 licensed](https://github.com/Esposter/Esposter/blob/main/LICENSE)

package/dist/index.d.ts

@@ -177,6 +177,7 @@ declare const isExternalTileset: (tileset: TMXEmbeddedTilesetShared | TMXExterna
 interface BaseTMXNode<T> extends Record<string, unknown> {
     $: T;
 }
+
 type TMXNode<T, TChildNode extends BaseTMXNode<unknown> | undefined = undefined> = {
     $$: TChildNode extends undefined ? undefined : TChildNode[];
 } & BaseTMXNode<T>;
@@ -306,4 +307,4 @@ declare enum TMXNodeType {
 interface TMXExportParsed extends TMXExportShared {
 }
 
-export { Compression, Encoding, Flipped, Shape, type TMX, type TMXBaseTilesetShared, type TMXDataNode, type TMXEditorSettingsNode, type TMXEditorSettingsParsed, type TMXEmbeddedTilesetNode, type TMXEmbeddedTilesetParsed, type TMXEmbeddedTilesetShared, type TMXExportNode, type TMXExportParsed, type TMXExportShared, type TMXExternalTilesetNode, type TMXExternalTilesetParsed, type TMXExternalTilesetShared, type TMXFlipsParsed, type TMXGroupLayerNode, type TMXGroupLayerParsed, type TMXGroupLayerShared, type TMXImageNode, type TMXImageParsed, type TMXImageShared, type TMXLayerNode, type TMXLayerParsed, type TMXLayerShared, type TMXMapNode, TMXMapParsed, TMXMapShared, type TMXNode, TMXNodeType, type TMXObjectNode, type TMXObjectParsed, type TMXObjectShared, type TMXParsed, type TMXPropertiesNode, type TMXPropertiesParsed, type TMXPropertyNode, type TMXTileNode, type TMXTileParsed, type TMXTileShared, type TMXTilesetNode, type TMXTilesetParsed, isExternalTileset, isTMXEmbeddedTilesetNode, parseFlips, parseGroup, parseLayer, parseNode, parseObject, parseObjectShape, parseProperties, parseTile, parseTileId, parseTileLayer, parseTileset, parseTmx, unpackTileBytes };
+export { type BaseTMXNode, Compression, Encoding, Flipped, Shape, type TMX, type TMXBaseTilesetShared, type TMXDataNode, type TMXEditorSettingsNode, type TMXEditorSettingsParsed, type TMXEmbeddedTilesetNode, type TMXEmbeddedTilesetParsed, type TMXEmbeddedTilesetShared, type TMXExportNode, type TMXExportParsed, type TMXExportShared, type TMXExternalTilesetNode, type TMXExternalTilesetParsed, type TMXExternalTilesetShared, type TMXFlipsParsed, type TMXGroupLayerNode, type TMXGroupLayerParsed, type TMXGroupLayerShared, type TMXImageNode, type TMXImageParsed, type TMXImageShared, type TMXLayerNode, type TMXLayerParsed, type TMXLayerShared, type TMXMapNode, TMXMapParsed, TMXMapShared, type TMXNode, TMXNodeType, type TMXObjectNode, type TMXObjectParsed, type TMXObjectShared, type TMXParsed, type TMXPropertiesNode, type TMXPropertiesParsed, type TMXPropertyNode, type TMXTileNode, type TMXTileParsed, type TMXTileShared, type TMXTilesetNode, type TMXTilesetParsed, isExternalTileset, isTMXEmbeddedTilesetNode, parseFlips, parseGroup, parseLayer, parseNode, parseObject, parseObjectShape, parseProperties, parseTile, parseTileId, parseTileLayer, parseTileset, parseTmx, unpackTileBytes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-tmx",
-  "version": "1.20.2",
+  "version": "1.21.0",
   "description": "A parser for tmx.",
   "type": "module",
   "main": "dist/index.js",
@@ -30,11 +30,11 @@
     "export:gen": "ctix build --config ../configuration/.ctirc-ts"
   },
   "dependencies": {
-    "@esposter/shared": "1.20.2"
+    "@esposter/shared": "1.21.0"
   },
   "devDependencies": {
-    "@esposter/configuration": "1.20.2",
+    "@esposter/configuration": "1.21.0",
     "@types/node": "^22.5.4"
   },
-  "gitHead": "8baf8385b82b7f8364086f758365c76bb35aeb9f"
+  "gitHead": "7139886b76bdc28925380145ca16319d1f4824ae"
 }