@cogeotiff/core 8.0.1 → 8.1.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [8.1.0](https://github.com/blacha/cogeotiff/compare/core-v8.0.2...core-v8.1.0) (2023-08-23)
+
+
+### Features
+
+* **cli:** fetch all tiff tags with --fetch-tags ([#1155](https://github.com/blacha/cogeotiff/issues/1155)) ([4067751](https://github.com/blacha/cogeotiff/commit/406775184eed18ab10ae2816ecbedea9706b20f5))
+
+
+### Bug Fixes
+
+* **core:** do not read past the end of a file ([#1152](https://github.com/blacha/cogeotiff/issues/1152)) ([fd0be56](https://github.com/blacha/cogeotiff/commit/fd0be56eee6944239502cd8ffd7a6fe89e76b984))
+
+## [8.0.2](https://github.com/blacha/cogeotiff/compare/core-v8.0.1...core-v8.0.2) (2023-08-05)
+
+
+### Bug Fixes
+
+* **core:** expose TiffTag and TiffTagGeo ([d538bdc](https://github.com/blacha/cogeotiff/commit/d538bdc833bf76ba8d730a1062156916715585b4))
+
 ## [8.0.1](https://github.com/blacha/cogeotiff/compare/core-v8.0.0...core-v8.0.1) (2023-08-05)
 
 

package/build/__benchmark__/cog.read.benchmark.js

@@ -1,6 +1,7 @@
 import { readFile } from 'fs/promises';
 import { CogTiff } from '../cog.tiff.js';
 import { SourceMemory } from './source.memory.js';
+import { TiffTag } from '../index.js';
 // console.log = console.trace;
 /** Read a tile from every image inside of a tiff 300 tiles read */
 async function main() {
@@ -14,6 +15,9 @@ async function main() {
         // 6 images
         for (const img of tiff.images)
             await img.getTile(0, 0);
+        // Force loading all the byte arrays in which benchmarks the bulk array loading
+        await tiff.images[0].fetch(TiffTag.TileByteCounts);
+        await tiff.images[0].fetch(TiffTag.TileOffsets);
     }
 }
 main();

package/build/__benchmark__/cog.read.benchmark.js.map

@@ -1 +1 @@
-{"version":3,"file":"cog.read.benchmark.js","sourceRoot":"","sources":["../../src/__benchmark__/cog.read.benchmark.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,+BAA+B;AAC/B,mEAAmE;AACnE,KAAK,UAAU,IAAI;IACjB,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAK,EAAE,CAAC,EAAE,EAAE;QAC9B,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAElC,WAAW;QACX,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KACxD;AACH,CAAC;AAED,IAAI,EAAE,CAAC"}
+{"version":3,"file":"cog.read.benchmark.js","sourceRoot":"","sources":["../../src/__benchmark__/cog.read.benchmark.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,+BAA+B;AAC/B,mEAAmE;AACnE,KAAK,UAAU,IAAI;IACjB,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAK,EAAE,CAAC,EAAE,EAAE;QAC9B,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAElC,WAAW;QACX,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAEvD,+EAA+E;QAC/E,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;KACjD;AACH,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/__test__/cog.read.test.js

@@ -1,9 +1,10 @@
 import assert from 'node:assert';
 import { describe, it } from 'node:test';
+import { TestFileSource } from '../__benchmark__/source.file.js';
 import { CogTiff } from '../cog.tiff.js';
 import { TiffMimeType } from '../const/tiff.mime.js';
-import { TestFileSource } from '../__benchmark__/source.file.js';
 import { TiffVersion } from '../const/tiff.version.js';
+import { TiffTag, TiffTagGeo } from '../index.js';
 function validate(tif) {
     assert.equal(tif.images.length, 5);
     const [firstTif] = tif.images;
@@ -50,5 +51,18 @@ describe('CogRead', () => {
         await tiff.init();
         assert.equal(tiff.images.length, 5);
     });
+    it('should read ifds from anywhere in the file', async () => {
+        const source = new TestFileSource(new URL('../../data/DEM_BS28_2016_1000_1141.tif', import.meta.url));
+        const tiff = await CogTiff.create(source);
+        assert.equal(tiff.images.length, 1);
+        const im = tiff.images[0];
+        assert.equal(im.isGeoTagsLoaded, true);
+        assert.equal(im.epsg, 2193);
+        assert.equal(im.compression, TiffMimeType.None);
+        assert.equal(im.isTiled(), false);
+        assert.equal(im.tagsGeo.get(TiffTagGeo.GTCitationGeoKey), 'NZGD2000 / New Zealand Transverse Mercator 2000');
+        assert.equal(im.tagsGeo.get(TiffTagGeo.GeogCitationGeoKey), 'NZGD2000');
+        assert.deepEqual(await im.fetch(TiffTag.StripByteCounts), [8064, 8064, 8064, 8064, 8064, 8064, 8064, 5040]);
+    });
 });
 //# sourceMappingURL=cog.read.test.js.map

package/build/__test__/cog.read.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"cog.read.test.js","sourceRoot":"","sources":["../../src/__test__/cog.read.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,SAAS,QAAQ,CAAC,GAAY;IAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEnC,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC;IAC9B,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IACjE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,mCAAmC;IACnC,6CAA6C;IAC7C,8FAA8F;IAC9F,wCAAwC;IAExC,yBAAyB;IAEzB,gDAAgD;IAChD,uDAAuD;IACvD,sBAAsB;IACtB,MAAM;IAEN,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACvF,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAChD,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAC7C,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEf,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEpC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"cog.read.test.js","sourceRoot":"","sources":["../../src/__test__/cog.read.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAElD,SAAS,QAAQ,CAAC,GAAY;IAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEnC,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC;IAC9B,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IACjE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,mCAAmC;IACnC,6CAA6C;IAC7C,8FAA8F;IAC9F,wCAAwC;IAExC,yBAAyB;IAEzB,gDAAgD;IAChD,uDAAuD;IACvD,sBAAsB;IACtB,MAAM;IAEN,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACvF,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAChD,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAC7C,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEf,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEpC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,wCAAwC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACtG,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE1C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACpC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE1B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,iDAAiD,CAAC,CAAC;QAC7G,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,UAAU,CAAC,CAAC;QACxE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9G,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/cog.tiff.image.d.ts

@@ -1,8 +1,9 @@
 import { CogTiff } from './cog.tiff.js';
 import { TiffMimeType } from './const/tiff.mime.js';
-import { TagId, TagGeoId } from './const/tiff.tag.id.js';
+import { TiffTag, TiffTagGeo } from './const/tiff.tag.id.js';
 import { Tag, TagOffset } from './read/tiff.tag.js';
 import { BoundingBox, Size } from './vector.js';
+/** Invalid EPSG code */
 export declare const InvalidProjectionCode = 32767;
 /**
  * Number of tiles used inside this image
@@ -14,7 +15,7 @@ export interface CogTiffImageTiledCount {
     y: number;
 }
 /** Tags that are commonly accessed for geotiffs */
-export declare const ImportantTags: Set<TagId>;
+export declare const ImportantTags: Set<TiffTag>;
 /**
  * Size of a individual tile
  */
@@ -26,15 +27,21 @@ export interface CogTiffImageTileSize {
 }
 export declare class CogTiffImage {
     /** All IFD tags that have been read for the image */
-    tags: Map<TagId, Tag>;
-    /** Id of the tif image, generally the image index inside the tif */
+    tags: Map<TiffTag, Tag>;
+    /**
+     * Id of the tif image, generally the image index inside the tif
+     * where 0 is the root image, and every sub image is +1
+     *
+     * @example 0, 1, 2
+     */
     id: number;
+    /** Reference to the TIFF that owns this image */
     tiff: CogTiff;
     /** Has loadGeoTiffTags been called */
     isGeoTagsLoaded: boolean;
     /** Sub tags stored in TiffTag.GeoKeyDirectory */
-    tagsGeo: Map<TagGeoId, string | number>;
-    constructor(tiff: CogTiff, id: number, tags: Map<TagId, Tag>);
+    tagsGeo: Map<TiffTagGeo, string | number>;
+    constructor(tiff: CogTiff, id: number, tags: Map<TiffTag, Tag>);
     /**
      * Force loading of important tags if they have not already been loaded
      *
@@ -42,22 +49,34 @@ export declare class CogTiffImage {
      */
     init(loadGeoTags?: boolean): Promise<void>;
     /**
-     * Get the value of a TiffTag if it exists null otherwise
+     * Get the value of a TiffTag if it has been loaded, null otherwise
+     *
+     * if the value is not loaded @see {CogTiffImage.fetch}
+     * @returns value if loaded, null otherwise
      */
-    value<T>(tag: TagId): T | null;
+    value<T>(tag: TiffTag): T | null;
     /**
      * Load and unpack the GeoKeyDirectory
+     *
+     * @see {TiffTag.GeoKeyDirectory}
      */
     loadGeoTiffTags(): Promise<void>;
     /**
-     * Get the associated GeoTiffTags
+     * Get the associated TiffTagGeo
+     *
+     * @example
+     * ```typescript
+     * image.valueGeo(TiffTagGeo.GTRasterTypeGeoKey)
+     * ```
+     * @throws if {@link loadGeoTiffTags} has not been called
      */
-    valueGeo(tag: TagGeoId): string | number | undefined;
+    valueGeo(tag: TiffTagGeo): string | number | undefined;
     /**
      * Load a tag, if it is not currently loaded, fetch the required data for the tag.
+     *
      * @param tag tag to fetch
      */
-    fetch<T>(tag: TagId): Promise<T | null>;
+    fetch<T>(tag: TiffTag): Promise<T | null>;
     /**
      * Get the origin point for the image
      *
@@ -81,7 +100,7 @@ export declare class CogTiffImage {
     /**
      * Get the compression used by the tile
      *
-     * @see TiffCompression
+     * @see {@link TiffCompression}
      *
      * @returns Compression type eg webp
      */
@@ -128,7 +147,9 @@ export declare class CogTiffImage {
     get stripCount(): number;
     getTileBounds(x: number, y: number): BoundingBox;
     /**
-     * Read a strip into a uint8 array
+     * Read a strip into a ArrayBuffer
+     *
+     * Image has to be striped see {@link stripCount}
      *
      * @param index Strip index to read
      */
@@ -141,9 +162,9 @@ export declare class CogTiffImage {
     /** Read image bytes at the given offset */
     private getBytes;
     /**
-     * Load the tile buffer, this works best with webp
+     * Load a tile into a ArrayBuffer
      *
-     * This will also apply the JPEG compression tables
+     * if the tile compression is JPEG, This will also apply the JPEG compression tables to the resulting ArrayBuffer see {@link getJpegHeader}
      *
      * @param x Tile x offset
      * @param y Tile y offset
@@ -155,13 +176,20 @@ export declare class CogTiffImage {
     /**
      * Does this tile exist in the tiff and does it actually have a value
      *
-     * Sparse tiffs can have a lot of empty tiles, this checks to see if the tile actually has data.
+     * Sparse tiffs can have a lot of empty tiles, they set the tile size to `0 bytes` when the tile is empty
+     * this checks the tile byte size to validate if it actually has any data.
      *
      * @param x Tile x offset
      * @param y Tile y offset
+     *
      * @returns if the tile exists and has data
      */
     hasTile(x: number, y: number): Promise<boolean>;
+    /**
+     * Load the offset and byteCount of a tile
+     * @param index index in the tile array
+     * @returns Offset and byteCount for the tile
+     */
     getTileSize(index: number): Promise<{
         offset: number;
         imageSize: number;

package/build/cog.tiff.image.js

@@ -1,23 +1,23 @@
 import { getUint } from './util/bytes.js';
 import { TiffCompression, TiffMimeType } from './const/tiff.mime.js';
-import { TagId, TagGeoId } from './const/tiff.tag.id.js';
-import { fetchLazy, getValueAt } from './read/tiff.tag.factory.js';
-// /** Invalid EPSG code */
+import { TiffTag, TiffTagGeo } from './const/tiff.tag.id.js';
+import { fetchAllOffsets, fetchLazy, getValueAt } from './read/tiff.tag.factory.js';
+/** Invalid EPSG code */
 export const InvalidProjectionCode = 32767;
 /** Tags that are commonly accessed for geotiffs */
 export const ImportantTags = new Set([
-    TagId.Compression,
-    TagId.ImageHeight,
-    TagId.ImageWidth,
-    TagId.ModelPixelScale,
-    TagId.ModelTiePoint,
-    TagId.ModelTransformation,
-    TagId.TileHeight,
-    TagId.TileWidth,
-    TagId.GeoKeyDirectory,
-    TagId.GeoAsciiParams,
-    TagId.GeoDoubleParams,
-    TagId.TileOffsets,
+    TiffTag.Compression,
+    TiffTag.ImageHeight,
+    TiffTag.ImageWidth,
+    TiffTag.ModelPixelScale,
+    TiffTag.ModelTiePoint,
+    TiffTag.ModelTransformation,
+    TiffTag.TileHeight,
+    TiffTag.TileWidth,
+    TiffTag.GeoKeyDirectory,
+    TiffTag.GeoAsciiParams,
+    TiffTag.GeoDoubleParams,
+    TiffTag.TileOffsets,
 ]);
 export class CogTiffImage {
     constructor(tiff, id, tags) {
@@ -28,13 +28,19 @@ export class CogTiffImage {
             writable: true,
             value: void 0
         });
-        /** Id of the tif image, generally the image index inside the tif */
+        /**
+         * Id of the tif image, generally the image index inside the tif
+         * where 0 is the root image, and every sub image is +1
+         *
+         * @example 0, 1, 2
+         */
         Object.defineProperty(this, "id", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Reference to the TIFF that owns this image */
         Object.defineProperty(this, "tiff", {
             enumerable: true,
             configurable: true,
@@ -66,26 +72,29 @@ export class CogTiffImage {
      */
     async init(loadGeoTags = true) {
         const requiredTags = [
-            this.fetch(TagId.Compression),
-            this.fetch(TagId.ImageHeight),
-            this.fetch(TagId.ImageWidth),
-            this.fetch(TagId.ModelPixelScale),
-            this.fetch(TagId.ModelTiePoint),
-            this.fetch(TagId.ModelTransformation),
-            this.fetch(TagId.TileHeight),
-            this.fetch(TagId.TileWidth),
+            this.fetch(TiffTag.Compression),
+            this.fetch(TiffTag.ImageHeight),
+            this.fetch(TiffTag.ImageWidth),
+            this.fetch(TiffTag.ModelPixelScale),
+            this.fetch(TiffTag.ModelTiePoint),
+            this.fetch(TiffTag.ModelTransformation),
+            this.fetch(TiffTag.TileHeight),
+            this.fetch(TiffTag.TileWidth),
         ];
         if (loadGeoTags) {
-            requiredTags.push(this.fetch(TagId.GeoKeyDirectory));
-            requiredTags.push(this.fetch(TagId.GeoAsciiParams));
-            requiredTags.push(this.fetch(TagId.GeoDoubleParams));
+            requiredTags.push(this.fetch(TiffTag.GeoKeyDirectory));
+            requiredTags.push(this.fetch(TiffTag.GeoAsciiParams));
+            requiredTags.push(this.fetch(TiffTag.GeoDoubleParams));
         }
         await Promise.all(requiredTags);
         if (loadGeoTags)
             await this.loadGeoTiffTags();
     }
     /**
-     * Get the value of a TiffTag if it exists null otherwise
+     * Get the value of a TiffTag if it has been loaded, null otherwise
+     *
+     * if the value is not loaded @see {CogTiffImage.fetch}
+     * @returns value if loaded, null otherwise
      */
     value(tag) {
         const sourceTag = this.tags.get(tag);
@@ -97,12 +106,14 @@ export class CogTiffImage {
     }
     /**
      * Load and unpack the GeoKeyDirectory
+     *
+     * @see {TiffTag.GeoKeyDirectory}
      */
     async loadGeoTiffTags() {
         // Already loaded
         if (this.isGeoTagsLoaded)
             return;
-        const sourceTag = this.tags.get(TagId.GeoKeyDirectory);
+        const sourceTag = this.tags.get(TiffTag.GeoKeyDirectory);
         if (sourceTag == null) {
             this.isGeoTagsLoaded = true;
             return;
@@ -110,9 +121,9 @@ export class CogTiffImage {
         if (sourceTag.type === 'lazy' && sourceTag.value == null) {
             // Load all the required keys
             await Promise.all([
-                this.fetch(TagId.GeoKeyDirectory),
-                this.fetch(TagId.GeoAsciiParams),
-                this.fetch(TagId.GeoDoubleParams),
+                this.fetch(TiffTag.GeoKeyDirectory),
+                this.fetch(TiffTag.GeoAsciiParams),
+                this.fetch(TiffTag.GeoDoubleParams),
             ]);
         }
         this.isGeoTagsLoaded = true;
@@ -123,26 +134,32 @@ export class CogTiffImage {
             throw new Error('Invalid geo tags found');
         for (let i = 4; i <= geoTags[3] * 4; i += 4) {
             const key = geoTags[i];
-            const location = geoTags[i + 1];
+            const locationTagId = geoTags[i + 1];
             const offset = geoTags[i + 3];
-            if (location === 0) {
+            if (locationTagId === 0) {
                 this.tagsGeo.set(key, offset);
                 continue;
             }
-            const tag = this.tags.get(location);
+            const tag = this.tags.get(locationTagId);
             if (tag == null || tag.value == null)
                 continue;
             const count = geoTags[i + 2];
-            if (Array.isArray(tag.value)) {
-                this.tagsGeo.set(key, tag.value[offset + count - 1]);
-            }
-            else if (typeof tag.value === 'string') {
+            if (typeof tag.value === 'string') {
                 this.tagsGeo.set(key, tag.value.slice(offset, offset + count - 1).trim());
             }
+            else {
+                throw new Error('Failed to extract GeoTiffTags');
+            }
         }
     }
     /**
-     * Get the associated GeoTiffTags
+     * Get the associated TiffTagGeo
+     *
+     * @example
+     * ```typescript
+     * image.valueGeo(TiffTagGeo.GTRasterTypeGeoKey)
+     * ```
+     * @throws if {@link loadGeoTiffTags} has not been called
      */
     valueGeo(tag) {
         if (this.isGeoTagsLoaded === false)
@@ -151,6 +168,7 @@ export class CogTiffImage {
     }
     /**
      * Load a tag, if it is not currently loaded, fetch the required data for the tag.
+     *
      * @param tag tag to fetch
      */
     async fetch(tag) {
@@ -163,6 +181,8 @@ export class CogTiffImage {
             return fetchLazy(sourceTag, this.tiff);
         if (sourceTag.isLoaded)
             return sourceTag.value;
+        if (sourceTag.type === 'offset')
+            return fetchAllOffsets(this.tiff, sourceTag);
         throw new Error('Cannot fetch:' + tag);
     }
     /**
@@ -171,27 +191,27 @@ export class CogTiffImage {
      * @returns origin point of the image
      */
     get origin() {
-        const tiePoints = this.value(TagId.ModelTiePoint);
+        const tiePoints = this.value(TiffTag.ModelTiePoint);
         if (tiePoints != null && tiePoints.length === 6) {
             return [tiePoints[3], tiePoints[4], tiePoints[5]];
         }
-        const modelTransformation = this.value(TagId.ModelTransformation);
+        const modelTransformation = this.value(TiffTag.ModelTransformation);
         if (modelTransformation != null) {
             return [modelTransformation[3], modelTransformation[7], modelTransformation[11]];
         }
         // If this is a sub image, use the origin from the top level image
-        if (this.value(TagId.NewSubFileType) === 1 && this.id !== 0) {
+        if (this.value(TiffTag.NewSubFileType) === 1 && this.id !== 0) {
             return this.tiff.images[0].origin;
         }
         throw new Error('Image does not have a geo transformation.');
     }
     /** Is there enough geo information on this image to figure out where its actually located */
     get isGeoLocated() {
-        const isImageLocated = this.value(TagId.ModelPixelScale) != null || this.value(TagId.ModelTransformation) != null;
+        const isImageLocated = this.value(TiffTag.ModelPixelScale) != null || this.value(TiffTag.ModelTransformation) != null;
         if (isImageLocated)
             return true;
         // If this is a sub image, use the isGeoLocated from the top level image
-        if (this.value(TagId.NewSubFileType) === 1 && this.id !== 0)
+        if (this.value(TiffTag.NewSubFileType) === 1 && this.id !== 0)
             return this.tiff.images[0].isGeoLocated;
         return false;
     }
@@ -201,16 +221,16 @@ export class CogTiffImage {
      * @returns [x,y,z] pixel scale
      */
     get resolution() {
-        const modelPixelScale = this.value(TagId.ModelPixelScale);
+        const modelPixelScale = this.value(TiffTag.ModelPixelScale);
         if (modelPixelScale != null) {
             return [modelPixelScale[0], -modelPixelScale[1], modelPixelScale[2]];
         }
-        const modelTransformation = this.value(TagId.ModelTransformation);
+        const modelTransformation = this.value(TiffTag.ModelTransformation);
         if (modelTransformation != null) {
             return [modelTransformation[0], modelTransformation[5], modelTransformation[10]];
         }
         // If this is a sub image, use the resolution from the top level image
-        if (this.value(TagId.NewSubFileType) === 1 && this.id !== 0) {
+        if (this.value(TiffTag.NewSubFileType) === 1 && this.id !== 0) {
             const firstImg = this.tiff.images[0];
             const [resX, resY, resZ] = firstImg.resolution;
             const firstImgSize = firstImg.size;
@@ -241,12 +261,12 @@ export class CogTiffImage {
     /**
      * Get the compression used by the tile
      *
-     * @see TiffCompression
+     * @see {@link TiffCompression}
      *
      * @returns Compression type eg webp
      */
     get compression() {
-        const compression = this.value(TagId.Compression);
+        const compression = this.value(TiffTag.Compression);
         if (compression == null || typeof compression !== 'number')
             return null;
         return TiffCompression[compression];
@@ -257,7 +277,7 @@ export class CogTiffImage {
      * @returns EPSG Code if it exists
      */
     get epsg() {
-        const projection = this.valueGeo(TagGeoId.ProjectedCSTypeGeoKey);
+        const projection = this.valueGeo(TiffTagGeo.ProjectedCSTypeGeoKey);
         if (projection === InvalidProjectionCode)
             return null;
         return projection;
@@ -269,23 +289,23 @@ export class CogTiffImage {
      */
     get size() {
         return {
-            width: this.value(TagId.ImageWidth),
-            height: this.value(TagId.ImageHeight),
+            width: this.value(TiffTag.ImageWidth),
+            height: this.value(TiffTag.ImageHeight),
         };
     }
     /**
      * Determine if this image is tiled
      */
     isTiled() {
-        return this.value(TagId.TileWidth) !== null;
+        return this.value(TiffTag.TileWidth) !== null;
     }
     /**
      * Get size of individual tiles
      */
     get tileSize() {
         return {
-            width: this.value(TagId.TileWidth),
-            height: this.value(TagId.TileHeight),
+            width: this.value(TiffTag.TileWidth),
+            height: this.value(TiffTag.TileHeight),
         };
     }
     /**
@@ -306,7 +326,7 @@ export class CogTiffImage {
      * @returns file offset to where the tiffs are stored
      */
     get tileOffset() {
-        const tileOffset = this.tags.get(TagId.TileOffsets);
+        const tileOffset = this.tags.get(TiffTag.TileOffsets);
         if (tileOffset == null)
             throw new Error('No tile offsets found');
         return tileOffset;
@@ -319,7 +339,7 @@ export class CogTiffImage {
      * @returns number of strips present
      */
     get stripCount() {
-        const tileOffset = this.tags.get(TagId.StripByteCounts);
+        const tileOffset = this.tags.get(TiffTag.StripByteCounts);
         if (tileOffset == null)
             return 0;
         return tileOffset.count;
@@ -334,15 +354,17 @@ export class CogTiffImage {
         return { x: left, y: top, width, height };
     }
     /**
-     * Read a strip into a uint8 array
+     * Read a strip into a ArrayBuffer
+     *
+     * Image has to be striped see {@link stripCount}
      *
      * @param index Strip index to read
      */
     async getStrip(index) {
         if (this.isTiled())
             throw new Error('Cannot read stripes, tiff is tiled: ' + index);
-        const byteCounts = this.tags.get(TagId.StripByteCounts);
-        const offsets = this.tags.get(TagId.StripOffsets);
+        const byteCounts = this.tags.get(TiffTag.StripByteCounts);
+        const offsets = this.tags.get(TiffTag.StripOffsets);
         if (index >= byteCounts.count)
             throw new Error('Cannot read strip, index out of bounds');
         const [byteCount, offset] = await Promise.all([
@@ -355,7 +377,7 @@ export class CogTiffImage {
     getJpegHeader(bytes) {
         // Both the JPEGTable and the Bytes with have the start of image and end of image markers
         // StartOfImage 0xffd8 EndOfImage 0xffd9
-        const tables = this.value(TagId.JPEGTables);
+        const tables = this.value(TiffTag.JPEGTables);
         if (tables == null)
             throw new Error('Unable to find Jpeg header');
         // Remove EndOfImage marker
@@ -369,7 +391,7 @@ export class CogTiffImage {
     async getBytes(offset, byteCount) {
         const mimeType = this.compression;
         if (mimeType == null)
-            throw new Error('Unsupported compression: ' + this.value(TagId.Compression));
+            throw new Error('Unsupported compression: ' + this.value(TiffTag.Compression));
         if (byteCount === 0)
             return null;
         const bytes = await this.tiff.source.fetch(offset, byteCount);
@@ -381,9 +403,9 @@ export class CogTiffImage {
         return { mimeType, bytes };
     }
     /**
-     * Load the tile buffer, this works best with webp
+     * Load a tile into a ArrayBuffer
      *
-     * This will also apply the JPEG compression tables
+     * if the tile compression is JPEG, This will also apply the JPEG compression tables to the resulting ArrayBuffer see {@link getJpegHeader}
      *
      * @param x Tile x offset
      * @param y Tile y offset
@@ -395,7 +417,7 @@ export class CogTiffImage {
         if (tiles == null)
             throw new Error('Tiff is not tiled');
         if (mimeType == null)
-            throw new Error('Unsupported compression: ' + this.value(TagId.Compression));
+            throw new Error('Unsupported compression: ' + this.value(TiffTag.Compression));
         // TODO support GhostOptionTileOrder
         const nyTiles = Math.ceil(size.height / tiles.height);
         const nxTiles = Math.ceil(size.width / tiles.width);
@@ -407,16 +429,17 @@ export class CogTiffImage {
         if (idx >= totalTiles)
             throw new Error(`Tile index is outside of tile range: ${idx} >= ${totalTiles}`);
         const { offset, imageSize } = await this.getTileSize(idx);
-        // console.log({ x, y, offset, imageSize });
         return this.getBytes(offset, imageSize);
     }
     /**
      * Does this tile exist in the tiff and does it actually have a value
      *
-     * Sparse tiffs can have a lot of empty tiles, this checks to see if the tile actually has data.
+     * Sparse tiffs can have a lot of empty tiles, they set the tile size to `0 bytes` when the tile is empty
+     * this checks the tile byte size to validate if it actually has any data.
      *
      * @param x Tile x offset
      * @param y Tile y offset
+     *
      * @returns if the tile exists and has data
      */
     async hasTile(x, y) {
@@ -433,6 +456,11 @@ export class CogTiffImage {
         const ret = await this.getTileSize(idx);
         return ret.offset > 0;
     }
+    /**
+     * Load the offset and byteCount of a tile
+     * @param index index in the tile array
+     * @returns Offset and byteCount for the tile
+     */
     async getTileSize(index) {
         // GDAL optimizes tiles by storing the size of the tile in
         // the few bytes leading up to the tile
@@ -447,7 +475,7 @@ export class CogTiffImage {
             const bytes = await this.tiff.source.fetch(offset - leaderBytes, leaderBytes);
             return { offset, imageSize: getUint(new DataView(bytes), 0, leaderBytes, this.tiff.isLittleEndian) };
         }
-        const byteCounts = this.tags.get(TagId.TileByteCounts);
+        const byteCounts = this.tags.get(TiffTag.TileByteCounts);
         if (byteCounts == null)
             throw new Error('No tile byte counts found');
         const [offset, imageSize] = await Promise.all([
@@ -461,7 +489,7 @@ function getOffset(tiff, x, index) {
     if (index > x.count || index < 0)
         throw new Error('TagIndex: out of bounds ' + x.id + ' @ ' + index);
     if (x.type === 'inline') {
-        if (Array.isArray(x.value))
+        if (x.count > 1)
             return x.value[index];
         return x.value;
     }