@cogeotiff/core 7.2.0 → 8.0.1

package/src/__test__/cog.read.test.ts

@@ -1,90 +1,68 @@
-import o from 'ospec';
-import * as path from 'path';
-import 'source-map-support/register.js';
-
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { CogTiff } from '../cog.tiff.js';
-import { TiffVersion } from '../const/tiff.version.js';
 import { TiffMimeType } from '../const/tiff.mime.js';
-import { TestFileChunkSource } from '@chunkd/core/build/__test__/chunk.source.fake.js';
-import { fileURLToPath } from 'url';
-
-const __dirname = fileURLToPath(import.meta.url);
-
-o.spec('CogRead', () => {
-    // TODO this does not load 100% yet
-    // o('should read big endian', async () => {
-    //     const source = new TestFileChunkSource(path.join(__dirname, '../../../test/data/be_cog.tif'))
-    //     const tif = new CogTif(source);
-
-    //     await tif.init();
+import { TestFileSource } from '../__benchmark__/source.file.js';
+import { TiffVersion } from '../const/tiff.version.js';
 
-    //     o(source.isLittleEndian).equals(false);
-    //     o(source.version).equals(TiffVersion.Tiff);
-    //     o(tif.images.length).equals(5)
-    //     const [firstTif] = tif.images;
-    //     o(firstTif.isTiled()).equals(true);
-    //
-    //     // o(firstTif.compression).equals('image/jpeg')
-    // })
+function validate(tif: CogTiff): void {
+  assert.equal(tif.images.length, 5);
 
-    function validate(tif: CogTiff): void {
-        o(tif.images.length).equals(5);
+  const [firstTif] = tif.images;
+  assert.equal(firstTif.isTiled(), true);
+  assert.deepEqual(firstTif.tileSize, { width: 256, height: 256 });
+  assert.deepEqual(firstTif.size, { width: 64, height: 64 });
+}
 
-        const [firstTif] = tif.images;
-        o(firstTif.isTiled()).equals(true);
-        o(firstTif.tileSize).deepEquals({ width: 256, height: 256 });
-        o(firstTif.size).deepEquals({ width: 64, height: 64 });
-    }
+describe('CogRead', () => {
+  // TODO this does not load 100% yet
+  // it('should read big endian', async () => {
+  //     const source = new TestFileSource(new URL('../../data/big_cog.tiff', import.meta.url));
+  //     const tiff = new CogTiff(source);
 
-    o('should read big tiff', async () => {
-        const source = new TestFileChunkSource(path.join(__dirname, '../../../data/big_cog.tif'));
-        const tiff = new CogTiff(source);
+  //     await tiff.init();
 
-        await tiff.init();
+  //     assert.equal(tiff.isLittleEndian, false);
+  //     assert.equal(tiff.version, TiffVersion.BigTiff);
+  //     validate(tiff);
+  // });
 
-        o(source.isLittleEndian).equals(true);
-        o(tiff.version).equals(TiffVersion.BigTiff);
-        validate(tiff);
-    });
+  it('should read big tiff', async () => {
+    const source = new TestFileSource(new URL('../../data/big_cog.tiff', import.meta.url));
+    const tiff = new CogTiff(source);
 
-    o('should read tiff', async () => {
-        const source = new TestFileChunkSource(path.join(__dirname, '../../../data/cog.tif'));
-        const tiff = new CogTiff(source);
+    await tiff.init();
 
-        await tiff.init();
+    assert.equal(tiff.isLittleEndian, true);
+    assert.equal(tiff.version, TiffVersion.BigTiff);
+    validate(tiff);
+  });
 
-        o(source.isLittleEndian).equals(true);
-        o(tiff.version).equals(TiffVersion.Tiff);
-        validate(tiff);
+  it('should read tiff', async () => {
+    const source = new TestFileSource(new URL('../../data/cog.tiff', import.meta.url));
+    const tiff = new CogTiff(source);
 
-        const [firstTif] = tiff.images;
-        o(firstTif.compression).equals(TiffMimeType.JPEG);
-    });
+    await tiff.init();
 
-    o('should allow multiple init', async () => {
-        const source = new TestFileChunkSource(path.join(__dirname, '../../../data/cog.tif'));
-        const tiff = new CogTiff(source);
+    assert.equal(tiff.isLittleEndian, true);
+    assert.equal(tiff.version, TiffVersion.Tiff);
+    validate(tiff);
 
-        o(tiff.isInitialized).equals(false);
-        await tiff.init();
-        o(tiff.isInitialized).equals(true);
-        o(tiff.images.length).equals(5);
+    const [firstTif] = tiff.images;
+    assert.equal(firstTif.compression, TiffMimeType.Jpeg);
+  });
 
-        o(tiff.isInitialized).equals(true);
-        await tiff.init();
-        o(tiff.images.length).equals(5);
-    });
+  it('should allow multiple init', async () => {
+    const source = new TestFileSource(new URL('../../data/cog.tiff', import.meta.url));
+    const tiff = new CogTiff(source);
 
-    o('should close a source', async () => {
-        const source = new TestFileChunkSource(path.join(__dirname, '../../../data/cog.tif'));
-        const tiff = new CogTiff(source);
-        // Should not close if there is no close
-        source.close = undefined;
-        await tiff.close();
+    assert.equal(tiff.isInitialized, false);
+    await tiff.init();
+    assert.equal(tiff.isInitialized, true);
+    assert.equal(tiff.images.length, 5);
 
-        const closeSpy = o.spy(() => Promise.resolve());
-        source.close = closeSpy;
-        await tiff.close();
-        o(closeSpy.callCount).equals(1);
-    });
+    assert.equal(tiff.isInitialized, true);
+    await tiff.init();
+    assert.equal(tiff.images.length, 5);
+  });
 });

package/src/__test__/example.ts

@@ -0,0 +1,31 @@
+import { SourceHttp } from '@chunkd/source-http';
+import { CogTiff } from '../index.js';
+
+async function main(): Promise<void> {
+  const source = new SourceHttp('https://example.com/cog.tif');
+  const tiff = await CogTiff.create(source);
+
+  /** Load a specific tile from a specific image */
+  const tile = await tiff.images[5].getTile(2, 2);
+  if (tile != null) {
+    tile.bytes; // Raw image buffer or null if tile doesn't exist
+  }
+
+  /** Load the 5th image in the Tiff */
+  const img = tiff.images[5];
+  if (img.isTiled()) {
+    /** Load tile x:10 y:10 */
+    const tile = await img.getTile(10, 10);
+    if (tile != null) {
+      tile.mimeType; // image/jpeg
+      tile.bytes; // Raw image buffer
+    }
+  }
+
+  /** Get the origin point of the tiff */
+  img.origin;
+  /** Bounding box of the tiff */
+  img.bbox;
+}
+
+main();