@flighthq/tilemap-formats 0.3.0 → 0.3.1-next.1041.35b950c

package/dist/tiledProject.d.ts

@@ -1,3 +1,3 @@
-import type { TiledMap, TiledTilesetResolver, TilemapData } from '@flighthq/types/contract';
-export declare function buildTilemapLayersFromTiled(map: Readonly<TiledMap>, layerIndex: number, resolveTileset: TiledTilesetResolver): TilemapData[] | null;
+import type { ImportDiagnostic, TiledMap, TiledTilesetResolver, TilemapData } from '@flighthq/types/contract';
+export declare function buildTilemapLayersFromTiled(map: Readonly<TiledMap>, layerIndex: number, resolveTileset: TiledTilesetResolver, diagnostics?: ImportDiagnostic[]): TilemapData[] | null;
 //# sourceMappingURL=tiledProject.d.ts.map

package/dist/tiledProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tiledProject.d.ts","sourceRoot":"","sources":["../src/tiledProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAmB5F,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,EACvB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,oBAAoB,GACnC,WAAW,EAAE,GAAG,IAAI,CAgDtB"}
+{"version":3,"file":"tiledProject.d.ts","sourceRoot":"","sources":["../src/tiledProject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAoB9G,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,EACvB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,oBAAoB,EACpC,WAAW,CAAC,EAAE,gBAAgB,EAAE,GAC/B,WAAW,EAAE,GAAG,IAAI,CAmFtB"}

package/dist/tiledProject.js

@@ -1,4 +1,6 @@
+import { reportImportDiagnostic } from '@flighthq/importdiagnostics/contract';
 import { createTilemapData } from '@flighthq/tilemap/contract';
+import { ImportDiagnosticSeverity } from '@flighthq/types/contract';
 import { decodeTiledGid, getTiledTilesetRefForGid } from './tiledGid';
 // Projects one Tiled tile layer into runtime `TilemapData`, split by tileset. A Flight `Tilemap`
 // batches a single tileset per draw, so a layer that draws from N tilesets becomes N single-tileset
@@ -15,7 +17,7 @@ import { decodeTiledGid, getTiledTilesetRefForGid } from './tiledGid';
 // Returns null when `layerIndex` is out of range or not a tile layer, or when resolution fails
 // wholesale (no referenced tileset resolves). A ref that resolves to null when others succeed has its
 // tiles left empty (`-1`) rather than failing the whole projection.
-export function buildTilemapLayersFromTiled(map, layerIndex, resolveTileset) {
+export function buildTilemapLayersFromTiled(map, layerIndex, resolveTileset, diagnostics) {
     const layer = map.layers[layerIndex];
     if (layer === undefined || layer.type !== 'tilelayer')
         return null;
@@ -25,13 +27,21 @@ export function buildTilemapLayersFromTiled(map, layerIndex, resolveTileset) {
     const groups = [];
     const byFirstGid = new Map();
     let anyResolved = false;
+    // Counted per cell and reported ONCE after the loop. The seam's perf contract forbids a per-element
+    // call in a hot loop, and a layer is width x height cells — a map with a broken tileset would
+    // otherwise emit one crumb per tile and drown the very report it was meant to make.
+    let cellsWithoutTileset = 0;
+    let cellsLeftEmpty = 0;
+    const unresolvedTilesets = new Set();
     for (let i = 0; i < cellCount; i++) {
         const { tileId } = decodeTiledGid(data[i]);
         if (tileId <= 0)
             continue;
         const ref = getTiledTilesetRefForGid(map, tileId);
-        if (ref === null)
+        if (ref === null) {
+            cellsWithoutTileset++;
             continue;
+        }
         let group = byFirstGid.get(ref.firstGid);
         if (group === undefined) {
             const layout = resolveTileset(ref);
@@ -47,10 +57,22 @@ export function buildTilemapLayersFromTiled(map, layerIndex, resolveTileset) {
                 groups.push(group);
             }
         }
-        if (group === null)
+        if (group === null) {
+            cellsLeftEmpty++;
+            unresolvedTilesets.add(ref.firstGid);
             continue;
+        }
         group.tiles[i] = tileId - group.firstGid;
     }
+    // Reported before the wholesale-failure return, so a map that loses SOME tiles and a map that loses
+    // all of them are distinguishable: the first returns layers with holes in them, and without this the
+    // caller sees a successful projection whose grid is quietly short of the tiles the file authored.
+    if (cellsWithoutTileset > 0) {
+        reportImportDiagnostic(diagnostics, ImportDiagnosticSeverity.Drop, 'tiled.tile-outside-every-tileset', 'buildTilemapLayersFromTiled', { cells: cellsWithoutTileset, layerIndex });
+    }
+    if (cellsLeftEmpty > 0) {
+        reportImportDiagnostic(diagnostics, ImportDiagnosticSeverity.Drop, 'tiled.tileset-unresolved', 'buildTilemapLayersFromTiled', { cells: cellsLeftEmpty, layerIndex, tilesets: unresolvedTilesets.size });
+    }
     if (!anyResolved)
         return null;
     return groups.map((group) => createTilemapData({

package/dist/tiledProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"tiledProject.js","sourceRoot":"","sources":["../src/tiledProject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAG/D,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAEtE,iGAAiG;AACjG,oGAAoG;AACpG,iGAAiG;AACjG,4FAA4F;AAC5F,mBAAmB;AACnB,EAAE;AACF,+FAA+F;AAC/F,wGAAwG;AACxG,mGAAmG;AACnG,mGAAmG;AACnG,8DAA8D;AAC9D,EAAE;AACF,+FAA+F;AAC/F,sGAAsG;AACtG,oEAAoE;AACpE,MAAM,UAAU,2BAA2B,CACzC,GAAuB,EACvB,UAAkB,EAClB,cAAoC;IAEpC,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC;IAEnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACtC,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;IAEjC,iGAAiG;IACjG,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,MAAM,UAAU,GAAG,IAAI,GAAG,EAA+B,CAAC;IAC1D,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,MAAM,IAAI,CAAC;YAAE,SAAS;QAC1B,MAAM,GAAG,GAAG,wBAAwB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAClD,IAAI,GAAG,KAAK,IAAI;YAAE,SAAS;QAE3B,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,+EAA+E;gBAC/E,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACnC,KAAK,GAAG,IAAI,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,IAAI,CAAC;gBACnB,KAAK,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtF,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACpC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,IAAI;YAAE,SAAS;QAC7B,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAE9B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC1B,iBAAiB,CAAC;QAChB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU;QACnC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;QACjC,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,CAAC,CACH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"tiledProject.js","sourceRoot":"","sources":["../src/tiledProject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAEtE,iGAAiG;AACjG,oGAAoG;AACpG,iGAAiG;AACjG,4FAA4F;AAC5F,mBAAmB;AACnB,EAAE;AACF,+FAA+F;AAC/F,wGAAwG;AACxG,mGAAmG;AACnG,mGAAmG;AACnG,8DAA8D;AAC9D,EAAE;AACF,+FAA+F;AAC/F,sGAAsG;AACtG,oEAAoE;AACpE,MAAM,UAAU,2BAA2B,CACzC,GAAuB,EACvB,UAAkB,EAClB,cAAoC,EACpC,WAAgC;IAEhC,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC;IAEnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACtC,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;IAEjC,iGAAiG;IACjG,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,MAAM,UAAU,GAAG,IAAI,GAAG,EAA+B,CAAC;IAC1D,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,oGAAoG;IACpG,8FAA8F;IAC9F,oFAAoF;IACpF,IAAI,mBAAmB,GAAG,CAAC,CAAC;IAC5B,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;IAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,MAAM,IAAI,CAAC;YAAE,SAAS;QAC1B,MAAM,GAAG,GAAG,wBAAwB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAClD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,mBAAmB,EAAE,CAAC;YACtB,SAAS;QACX,CAAC;QAED,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,+EAA+E;gBAC/E,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACnC,KAAK,GAAG,IAAI,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,IAAI,CAAC;gBACnB,KAAK,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtF,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACpC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,cAAc,EAAE,CAAC;YACjB,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACrC,SAAS;QACX,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC3C,CAAC;IAED,oGAAoG;IACpG,qGAAqG;IACrG,kGAAkG;IAClG,IAAI,mBAAmB,GAAG,CAAC,EAAE,CAAC;QAC5B,sBAAsB,CACpB,WAAW,EACX,wBAAwB,CAAC,IAAI,EAC7B,kCAAkC,EAClC,6BAA6B,EAC7B,EAAE,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,CAC3C,CAAC;IACJ,CAAC;IACD,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QACvB,sBAAsB,CACpB,WAAW,EACX,wBAAwB,CAAC,IAAI,EAC7B,0BAA0B,EAC1B,6BAA6B,EAC7B,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,kBAAkB,CAAC,IAAI,EAAE,CACzE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAE9B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC1B,iBAAiB,CAAC;QAChB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU;QACnC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;QACjC,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,CAAC,CACH,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flighthq/tilemap-formats",
-  "version": "0.3.0",
+  "version": "0.3.1-next.1041.35b950c",
   "author": "Joshua Granick and other contributors",
   "license": "MIT",
   "repository": {
@@ -38,9 +38,10 @@
     "clean:dist": "tsx ../../scripts/clean-package-dist.ts"
   },
   "dependencies": {
-    "@flighthq/tilemap": "0.3.0",
-    "@flighthq/types": "0.3.0",
-    "@flighthq/xml": "0.3.0"
+    "@flighthq/importdiagnostics": "0.3.1-next.1041.35b950c",
+    "@flighthq/tilemap": "0.3.1-next.1041.35b950c",
+    "@flighthq/types": "0.3.1-next.1041.35b950c",
+    "@flighthq/xml": "0.3.1-next.1041.35b950c"
   },
   "devDependencies": {
     "typescript": "^5.3.0"

package/src/tiledProject.test.ts

@@ -1,4 +1,4 @@
-import type { TiledTilesetResolver } from '@flighthq/types/contract';
+import type { ImportDiagnostic, TiledTilesetResolver } from '@flighthq/types/contract';
 import { describe, expect, it } from 'vitest';
 
 import { buildTilemapLayersFromTiled } from './tiledProject';
@@ -25,6 +25,18 @@ const resolve: TiledTilesetResolver = (ref) => {
 };
 
 describe('buildTilemapLayersFromTiled', () => {
+  // A clean parse is two claims: the values are right AND THE PROJECTION IS NOT COMPLAINING. Every other
+  // test here checks the first. This checks the second — the one that catches a layer that projected into
+  // plausible-looking tile arrays while quietly reporting that it could not place some of them.
+  it('raises no diagnostic at all for a well-formed layer', () => {
+    const diagnostics: ImportDiagnostic[] = [];
+
+    buildTilemapLayersFromTiled(mapWithLayerData('1,2,1,2')!, 0, resolve, diagnostics);
+
+    const complaints = diagnostics.map((diagnostic) => diagnostic.kind);
+    expect(complaints, `a good Tiled layer made the projection complain: ${complaints.join(', ')}`).toEqual([]);
+  });
+
   it('splits a two-tileset layer into one TilemapData per tileset with local ids', () => {
     const map = mapWithLayerData('1,5,2147483649,6')!;
     const result = buildTilemapLayersFromTiled(map, 0, resolve)!;
@@ -57,6 +69,57 @@ describe('buildTilemapLayersFromTiled', () => {
     expect(Array.from(result[0].tiles)).toEqual([0, -1, 0, -1]);
   });
 
+  it('reports the tiles an unresolved tileset left empty instead of dropping them silently', () => {
+    const diagnostics: ImportDiagnostic[] = [];
+    const map = mapWithLayerData('1,5,1,5')!;
+    const onlyA: TiledTilesetResolver = (ref) => (ref.firstGid === 1 ? tilesetA : null);
+    const result = buildTilemapLayersFromTiled(map, 0, onlyA, diagnostics)!;
+
+    // The projection SUCCEEDS and the grid looks complete — the holes are -1 cells that no count
+    // distinguishes from genuinely empty ones, which is what earns the crumb.
+    expect(Array.from(result[0].tiles)).toEqual([0, -1, 0, -1]);
+    expect(diagnostics).toMatchObject([
+      { detail: { cells: 2, layerIndex: 0, tilesets: 1 }, kind: 'tiled.tileset-unresolved', severity: 'Drop' },
+    ]);
+  });
+
+  it('reports a tile whose gid falls outside every declared tileset', () => {
+    const diagnostics: ImportDiagnostic[] = [];
+    const map = parseTiledTmx(
+      '<map version="1" width="2" height="1" tilewidth="16" tileheight="16">' +
+        '<tileset firstgid="5" source="b.tsx"/>' +
+        '<layer id="1" name="g" width="2" height="1"><data encoding="csv">1,5</data></layer>' +
+        '</map>',
+    )!;
+    buildTilemapLayersFromTiled(map, 0, () => tilesetA, diagnostics);
+
+    expect(diagnostics).toMatchObject([
+      { detail: { cells: 1, layerIndex: 0 }, kind: 'tiled.tile-outside-every-tileset', severity: 'Drop' },
+    ]);
+  });
+
+  it('reports once for a whole layer rather than once per cell', () => {
+    const diagnostics: ImportDiagnostic[] = [];
+    const map = mapWithLayerData('5,5,5,5')!;
+    const onlyA: TiledTilesetResolver = (ref) => (ref.firstGid === 1 ? tilesetA : null);
+    buildTilemapLayersFromTiled(map, 0, onlyA, diagnostics);
+
+    // A layer is width x height cells, so a per-cell crumb would drown the report it is making. The
+    // count carries the scale instead.
+    expect(diagnostics).toHaveLength(1);
+    expect(diagnostics[0]!.detail).toMatchObject({ cells: 4 });
+  });
+
+  it('stays silent for a layer whose tilesets all resolve', () => {
+    const diagnostics: ImportDiagnostic[] = [];
+    const map = mapWithLayerData('1,5,1,5')!;
+    const result = buildTilemapLayersFromTiled(map, 0, resolve, diagnostics)!;
+
+    // Asserting the projected tiles keeps the silence from being vacuous.
+    expect(result).toHaveLength(2);
+    expect(diagnostics).toEqual([]);
+  });
+
   it('returns null when no referenced tileset resolves', () => {
     const map = mapWithLayerData('1,5,2147483649,6')!;
     expect(buildTilemapLayersFromTiled(map, 0, () => null)).toBeNull();