parse-tmx 2.38.0 → 2.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.ts +135 -5
  2. package/dist/index.js +65 -61879
  3. package/package.json +21 -14
package/dist/index.d.ts CHANGED
@@ -1,22 +1,35 @@
1
+ //#region src/models/tmx/parsed/TMXEditorSettingsParsed.d.ts
1
2
  export interface TMXEditorSettingsParsed extends Record<string, unknown> {}
3
+ //#endregion
4
+ //#region src/models/tmx/parsed/TMXFlipsParsed.d.ts
2
5
  export interface TMXFlipsParsed {
3
6
  Diagonal: boolean;
4
7
  Horizontal: boolean;
5
8
  Vertical: boolean;
6
9
  }
10
+ //#endregion
11
+ //#region src/models/tmx/shared/TMXImageShared.d.ts
7
12
  export interface TMXImageShared {
8
13
  height: number;
9
14
  source: string;
10
15
  width: number;
11
16
  }
17
+ //#endregion
18
+ //#region src/models/tmx/parsed/TMXImageParsed.d.ts
12
19
  export interface TMXImageParsed extends TMXImageShared {}
20
+ //#endregion
21
+ //#region src/models/Shape.d.ts
13
22
  export declare enum Shape {
14
23
  Ellipse = "ellipse",
15
24
  Point = "point",
16
25
  Polygon = "polygon",
17
26
  Rectangle = "rectangle"
18
27
  }
28
+ //#endregion
29
+ //#region src/models/tmx/parsed/TMXPropertiesParsed.d.ts
19
30
  export type TMXPropertiesParsed = Record<string, unknown>[];
31
+ //#endregion
32
+ //#region src/models/tmx/shared/TMXObjectShared.d.ts
20
33
  export interface TMXObjectShared {
21
34
  gid: number;
22
35
  height: number;
@@ -26,6 +39,8 @@ export interface TMXObjectShared {
26
39
  x: number;
27
40
  y: number;
28
41
  }
42
+ //#endregion
43
+ //#region src/models/tmx/parsed/TMXObjectParsed.d.ts
29
44
  export interface TMXObjectParsed extends TMXObjectShared {
30
45
  flips?: TMXFlipsParsed;
31
46
  name: string;
@@ -35,6 +50,8 @@ export interface TMXObjectParsed extends TMXObjectShared {
35
50
  text?: string;
36
51
  value: string;
37
52
  }
53
+ //#endregion
54
+ //#region src/models/tmx/shared/TMXLayerShared.d.ts
38
55
  export interface TMXLayerShared {
39
56
  height: number;
40
57
  id: number;
@@ -52,6 +69,8 @@ export interface TMXLayerShared {
52
69
  x?: number;
53
70
  y?: number;
54
71
  }
72
+ //#endregion
73
+ //#region src/models/tmx/parsed/TMXLayerParsed.d.ts
55
74
  export interface TMXLayerParsed extends TMXLayerShared {
56
75
  data?: number[];
57
76
  flips?: TMXFlipsParsed[];
@@ -59,20 +78,28 @@ export interface TMXLayerParsed extends TMXLayerShared {
59
78
  objects?: TMXObjectParsed[];
60
79
  properties?: TMXPropertiesParsed;
61
80
  }
81
+ //#endregion
82
+ //#region src/models/tmx/shared/TMXGroupLayerShared.d.ts
62
83
  export interface TMXGroupLayerShared {
63
84
  id: number;
64
85
  name: string;
65
86
  type: string;
66
87
  }
88
+ //#endregion
89
+ //#region src/models/tmx/parsed/TMXGroupLayerParsed.d.ts
67
90
  export interface TMXGroupLayerParsed extends TMXGroupLayerShared {
68
91
  layers: TMXLayerParsed[];
69
92
  properties?: TMXPropertiesParsed;
70
93
  }
94
+ //#endregion
95
+ //#region src/models/tmx/shared/TMXTileShared.d.ts
71
96
  export interface TMXTileShared {
72
97
  gid?: number;
73
98
  id: number;
74
99
  probability?: number;
75
100
  }
101
+ //#endregion
102
+ //#region src/models/tmx/parsed/TMXTileParsed.d.ts
76
103
  export interface TMXTileParsed extends TMXTileShared {
77
104
  animation?: {
78
105
  frames: number[];
@@ -82,9 +109,13 @@ export interface TMXTileParsed extends TMXTileShared {
82
109
  properties?: TMXPropertiesParsed;
83
110
  type: string;
84
111
  }
112
+ //#endregion
113
+ //#region src/models/tmx/shared/TMXBaseTilesetShared.d.ts
85
114
  export interface TMXBaseTilesetShared {
86
115
  firstgid: number;
87
116
  }
117
+ //#endregion
118
+ //#region src/models/tmx/shared/TMXEmbeddedTilesetShared.d.ts
88
119
  export interface TMXEmbeddedTilesetShared extends TMXBaseTilesetShared {
89
120
  columns: number;
90
121
  imageheight: number;
@@ -96,15 +127,25 @@ export interface TMXEmbeddedTilesetShared extends TMXBaseTilesetShared {
96
127
  tileheight: number;
97
128
  tilewidth: number;
98
129
  }
130
+ //#endregion
131
+ //#region src/models/tmx/parsed/TMXEmbeddedTilesetParsed.d.ts
99
132
  export interface TMXEmbeddedTilesetParsed extends TMXEmbeddedTilesetShared {
100
133
  image: TMXImageParsed;
101
134
  tiles: TMXTileParsed[];
102
135
  }
136
+ //#endregion
137
+ //#region src/models/tmx/shared/TMXExternalTilesetShared.d.ts
103
138
  export interface TMXExternalTilesetShared extends TMXBaseTilesetShared {
104
139
  source: string;
105
140
  }
141
+ //#endregion
142
+ //#region src/models/tmx/parsed/TMXExternalTilesetParsed.d.ts
106
143
  export interface TMXExternalTilesetParsed extends TMXExternalTilesetShared {}
144
+ //#endregion
145
+ //#region src/models/tmx/parsed/TMXTilesetParsed.d.ts
107
146
  export type TMXTilesetParsed = TMXEmbeddedTilesetParsed | TMXExternalTilesetParsed;
147
+ //#endregion
148
+ //#region src/models/tmx/shared/TMXMapShared.d.ts
108
149
  export declare class TMXMapShared {
109
150
  height: number;
110
151
  infinite: number;
@@ -118,6 +159,8 @@ export declare class TMXMapShared {
118
159
  version: number;
119
160
  width: number;
120
161
  }
162
+ //#endregion
163
+ //#region src/models/tmx/parsed/TMXMapParsed.d.ts
121
164
  export declare class TMXMapParsed extends TMXMapShared {
122
165
  editorsettings: TMXEditorSettingsParsed;
123
166
  layers: (TMXGroupLayerParsed | TMXLayerParsed)[];
@@ -125,25 +168,40 @@ export declare class TMXMapParsed extends TMXMapShared {
125
168
  tilesets: TMXTilesetParsed[];
126
169
  constructor(init?: Partial<TMXMapParsed>);
127
170
  }
171
+ //#endregion
172
+ //#region src/models/tmx/parsed/TMXParsed.d.ts
128
173
  export declare class TMXParsed {
129
174
  map: TMXMapParsed;
130
175
  constructor(map?: TMXMapParsed);
131
176
  }
177
+ //#endregion
178
+ //#region src/parseTmx.d.ts
132
179
  export declare const parseTmx: (xmlString: string, translateFlips?: boolean) => Promise<TMXParsed>;
180
+ //#endregion
181
+ //#region src/models/Compression.d.ts
133
182
  export declare enum Compression {
134
183
  Gzip = "gzip",
135
184
  Zlib = "zlib"
136
185
  }
186
+ //#endregion
187
+ //#region src/models/Encoding.d.ts
137
188
  export declare enum Encoding {
138
189
  Base64 = "base64",
139
190
  Csv = "csv"
140
191
  }
192
+ //#endregion
193
+ //#region src/models/Flipped.d.ts
141
194
  export declare enum Flipped {
142
195
  Diagonally = 536870912,
143
196
  Vertically = 1073741824,
144
197
  Horizontally = 2147483648
145
198
  }
146
199
  export declare const Flippeds: readonly Flipped[];
200
+ //#endregion
201
+ //#region src/util/checkIsExternalTileset.d.ts
202
+ export declare const checkIsExternalTileset: (tileset: TMXEmbeddedTilesetShared | TMXExternalTilesetShared) => tileset is TMXExternalTilesetShared;
203
+ //#endregion
204
+ //#region src/models/tmx/node/TMXNodeType.d.ts
147
205
  export declare enum TMXNodeType {
148
206
  Data = "data",
149
207
  EditorSettings = "editorsettings",
@@ -158,31 +216,42 @@ export declare enum TMXNodeType {
158
216
  Property = "property",
159
217
  Tileset = "tileset"
160
218
  }
219
+ //#endregion
220
+ //#region src/models/tmx/node/BaseTMXNode.d.ts
161
221
  export declare class BaseTMXNode<T> {
162
222
  [key: string]: unknown;
163
223
  readonly "#name": TMXNodeType;
164
224
  $: T;
165
225
  }
166
- export declare const cloneNodeWithType: <TParsed>(node: BaseTMXNode<unknown>) => TParsed;
167
- export declare const getDecompressedBytes: (bytes: Uint8Array, compression: Compression.Gzip | Compression.Zlib) => Promise<Uint8Array>;
168
- export declare const isExternalTileset: (tileset: TMXEmbeddedTilesetShared | TMXExternalTilesetShared) => tileset is TMXExternalTilesetShared;
226
+ //#endregion
227
+ //#region src/models/tmx/node/TMXNode.d.ts
169
228
  export type TMXNode<T, TChildNode extends BaseTMXNode<unknown> | undefined = undefined> = BaseTMXNode<T> & {
170
229
  $$: TChildNode extends undefined ? undefined : TChildNode[];
171
230
  };
231
+ //#endregion
232
+ //#region src/models/tmx/node/TMXDataNode.d.ts
172
233
  export interface TMXDataNode extends TMXNode<{
173
234
  compression?: Compression;
174
235
  encoding: Encoding;
175
236
  }> {
176
237
  _: string;
177
238
  }
239
+ //#endregion
240
+ //#region src/models/tmx/node/TMXImageNode.d.ts
178
241
  export interface TMXImageNode extends TMXNode<TMXImageShared> {}
242
+ //#endregion
243
+ //#region src/models/tmx/node/TMXPropertyNode.d.ts
179
244
  export interface TMXPropertyNode extends TMXNode<{
180
245
  name: string;
181
246
  value?: string;
182
247
  }> {
183
248
  _: string;
184
249
  }
250
+ //#endregion
251
+ //#region src/models/tmx/node/TMXPropertiesNode.d.ts
185
252
  export interface TMXPropertiesNode extends TMXNode<Record<string, never>, TMXPropertyNode> {}
253
+ //#endregion
254
+ //#region src/models/tmx/node/TMXObjectNode.d.ts
186
255
  export interface TMXObjectNode extends TMXNode<TMXObjectShared, TMXDataNode | TMXPropertiesNode> {
187
256
  polygon?: TMXNode<{
188
257
  points: string;
@@ -192,6 +261,8 @@ export interface TMXObjectNode extends TMXNode<TMXObjectShared, TMXDataNode | TM
192
261
  }[];
193
262
  text?: TMXDataNode[];
194
263
  }
264
+ //#endregion
265
+ //#region src/models/tmx/node/TMXTileNode.d.ts
195
266
  export interface TMXTileNode extends TMXNode<TMXTileShared, TMXPropertiesNode> {
196
267
  animation?: Record<string, TMXNode<number>[]>[];
197
268
  objectgroup?: Record<string, TMXObjectNode[]>[];
@@ -199,11 +270,25 @@ export interface TMXTileNode extends TMXNode<TMXTileShared, TMXPropertiesNode> {
199
270
  property: TMXPropertyNode[];
200
271
  }[];
201
272
  }
273
+ //#endregion
274
+ //#region src/models/tmx/node/TMXEmbeddedTilesetNode.d.ts
202
275
  export interface TMXEmbeddedTilesetNode extends TMXNode<TMXEmbeddedTilesetShared, TMXImageNode | TMXTileNode> {
203
276
  tile?: TMXTileNode[];
204
277
  }
205
- export declare const isTMXEmbeddedTilesetNode: (node: TMXDataNode | TMXEmbeddedTilesetNode) => node is TMXEmbeddedTilesetNode;
278
+ //#endregion
279
+ //#region src/util/checkIsTMXEmbeddedTilesetNode.d.ts
280
+ export declare const checkIsTMXEmbeddedTilesetNode: (node: TMXDataNode | TMXEmbeddedTilesetNode) => node is TMXEmbeddedTilesetNode;
281
+ //#endregion
282
+ //#region src/util/cloneNodeWithType.d.ts
283
+ export declare const cloneNodeWithType: <TParsed>(node: BaseTMXNode<unknown>) => TParsed;
284
+ //#endregion
285
+ //#region src/util/getDecompressedBytes.d.ts
286
+ export declare const getDecompressedBytes: (bytes: Uint8Array<ArrayBuffer>, compression: Compression.Gzip | Compression.Zlib) => Promise<Uint8Array<ArrayBuffer>>;
287
+ //#endregion
288
+ //#region src/util/parseFlips.d.ts
206
289
  export declare const parseFlips: (gid: number) => TMXFlipsParsed;
290
+ //#endregion
291
+ //#region src/models/tmx/node/TMXLayerNode.d.ts
207
292
  export interface TMXLayerNode extends TMXNode<TMXLayerShared, TMXDataNode | TMXEmbeddedTilesetNode | TMXPropertiesNode> {
208
293
  data?: TMXDataNode[] | TMXEmbeddedTilesetNode[];
209
294
  image?: TMXImageNode[];
@@ -212,36 +297,81 @@ export interface TMXLayerNode extends TMXNode<TMXLayerShared, TMXDataNode | TMXE
212
297
  property: TMXPropertyNode[];
213
298
  }[];
214
299
  }
300
+ //#endregion
301
+ //#region src/models/tmx/node/TMXGroupLayerNode.d.ts
215
302
  export interface TMXGroupLayerNode extends TMXNode<TMXGroupLayerShared, TMXLayerNode> {
216
303
  properties?: {
217
304
  property: TMXPropertyNode[];
218
305
  }[];
219
306
  }
307
+ //#endregion
308
+ //#region src/util/parseGroup.d.ts
220
309
  export declare const parseGroup: (node: TMXGroupLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXGroupLayerParsed>;
310
+ //#endregion
311
+ //#region src/util/parseLayer.d.ts
221
312
  export declare const parseLayer: (node: TMXLayerNode) => TMXLayerParsed;
313
+ //#endregion
314
+ //#region src/util/parseNode.d.ts
222
315
  export declare const parseNode: <TNode extends TMXGroupLayerNode | TMXLayerNode, TParsedNode = TNode extends TMXLayerNode ? TMXLayerParsed : TMXGroupLayerParsed>(node: TNode, expectedCount: number, translateFlips: boolean) => Promise<TParsedNode>;
316
+ //#endregion
317
+ //#region src/util/parseObject.d.ts
223
318
  export declare const parseObject: (node: TMXObjectNode) => TMXObjectParsed;
319
+ //#endregion
320
+ //#region src/util/parseObjectShape.d.ts
224
321
  export declare const parseObjectShape: (node: TMXObjectNode) => Shape;
322
+ //#endregion
323
+ //#region src/util/parseProperties.d.ts
225
324
  export declare const parseProperties: (properties: {
226
325
  property: TMXPropertyNode[];
227
326
  }[]) => TMXPropertiesParsed;
327
+ //#endregion
328
+ //#region src/util/parseTile.d.ts
228
329
  export declare const parseTile: (node: TMXTileNode) => TMXTileParsed;
330
+ //#endregion
331
+ //#region src/util/parseTileId.d.ts
229
332
  export declare const parseTileId: (gid: number) => number;
333
+ //#endregion
334
+ //#region src/util/parseTileLayer.d.ts
230
335
  export declare const parseTileLayer: (node: TMXLayerNode, expectedCount: number, translateFlips: boolean) => Promise<TMXLayerParsed>;
336
+ //#endregion
337
+ //#region src/models/tmx/node/TMXExternalTilesetNode.d.ts
231
338
  export interface TMXExternalTilesetNode extends TMXNode<TMXExternalTilesetShared> {}
339
+ //#endregion
340
+ //#region src/models/tmx/node/TMXTilesetNode.d.ts
232
341
  export type TMXTilesetNode = TMXEmbeddedTilesetNode | TMXExternalTilesetNode;
342
+ //#endregion
343
+ //#region src/util/parseTileset.d.ts
233
344
  export declare const parseTileset: (node: TMXTilesetNode) => TMXTilesetParsed;
345
+ //#endregion
346
+ //#region src/util/parseXmlString.d.ts
234
347
  export declare const parseXmlString: <T extends object>(xmlString: string) => Promise<T>;
348
+ //#endregion
349
+ //#region src/util/parseXmlValue.d.ts
235
350
  export declare const parseXmlValue: (value: string) => boolean | number | string;
351
+ //#endregion
352
+ //#region src/util/unpackTileBytes.d.ts
236
353
  export declare const unpackTileBytes: (bytes: Uint8Array, expectedCount: number) => number[];
354
+ //#endregion
355
+ //#region src/models/tmx/shared/TMXExportShared.d.ts
237
356
  export interface TMXExportShared {
238
357
  format: string;
239
358
  target: string;
240
359
  }
360
+ //#endregion
361
+ //#region src/models/tmx/node/TMXExportNode.d.ts
241
362
  export interface TMXExportNode extends TMXNode<TMXExportShared> {}
363
+ //#endregion
364
+ //#region src/models/tmx/node/TMXEditorSettingsNode.d.ts
242
365
  export interface TMXEditorSettingsNode extends TMXNode<Record<string, never>, TMXExportNode> {}
366
+ //#endregion
367
+ //#region src/models/tmx/node/TMXMapNode.d.ts
243
368
  export interface TMXMapNode extends TMXNode<TMXMapShared, TMXEditorSettingsNode | TMXGroupLayerNode | TMXPropertiesNode | TMXTilesetNode> {}
369
+ //#endregion
370
+ //#region src/models/tmx/node/TMX.d.ts
244
371
  export interface TMX {
245
372
  map: TMXMapNode;
246
373
  }
247
- export interface TMXExportParsed extends TMXExportShared {}
374
+ //#endregion
375
+ //#region src/models/tmx/parsed/TMXExportParsed.d.ts
376
+ export interface TMXExportParsed extends TMXExportShared {}
377
+ //#endregion