@cogeotiff/core 7.2.1 → 8.0.1

package/build/cog.tiff.d.ts

@@ -1,52 +1,46 @@
-import { ChunkSource } from '@chunkd/core';
 import { CogTiffImage } from './cog.tiff.image.js';
 import { TiffVersion } from './const/tiff.version.js';
 import { CogTifGhostOptions } from './read/tiff.gdal.js';
 import { TiffIfdConfig } from './read/tiff.ifd.config.js';
+import { Source } from './source.js';
 export declare class CogTiff {
-    source: ChunkSource;
+    /** Read 16KB blocks at a time */
+    defaultReadSize: number;
+    /** Where this cog is fetching its data from */
+    source: Source;
+    /** Big or small Tiff */
     version: TiffVersion;
+    /** List of images, o is the base image */
     images: CogTiffImage[];
-    options: CogTifGhostOptions;
-    private cursor;
+    /** Ghost header options */
+    options?: CogTifGhostOptions;
+    /** Configuration for the size of the IFD */
     ifdConfig: TiffIfdConfig;
-    constructor(source: ChunkSource);
-    /** Create and initialize a CogTiff */
-    static create(source: ChunkSource): Promise<CogTiff>;
+    /** Is the tiff being read is little Endian */
+    isLittleEndian: boolean;
     /** Has init() been called */
     isInitialized: boolean;
-    _initPromise?: Promise<CogTiff>;
+    private _initPromise?;
+    constructor(source: Source);
+    /** Create a COG and initialize it by reading the COG headers */
+    static create(source: Source): Promise<CogTiff>;
     /**
      * Initialize the COG loading in the header and all image headers
-     *
-     * @param loadGeoKeys Whether to also initialize the GeoKeyDirectory
      */
-    init(loadGeoKeys?: boolean): Promise<CogTiff>;
-    private doInit;
-    private fetchIfd;
-    getImage(z: number): CogTiffImage;
+    init(): Promise<CogTiff>;
     /**
      * Find a image which has a resolution similar to the provided resolution
      *
      * @param resolution resolution to find
      */
     getImageByResolution(resolution: number): CogTiffImage;
+    /** Read the Starting header and all Image headers from the source */
+    private readHeader;
     /**
-     * Get the raw bytes for a tile at a given x,y, index.
-     *
-     * This may return null if the tile does not exist eg Sparse cogs,
+     * Read a IFD at a the provided offset
      *
-     * @param x tile x index
-     * @param y tile y index
-     * @param index image index
+     * @param offset file offset to read the header from
+     * @param view offset that contains the bytes for the header
      */
-    getTile(x: number, y: number, index: number): Promise<{
-        mimeType: string;
-        bytes: Uint8Array;
-    } | null>;
-    private processIfd;
     private readIfd;
-    /** Close the file source if it needs closing */
-    close(): Promise<void>;
 }
-//# sourceMappingURL=cog.tiff.d.ts.map

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

@@ -1,10 +1,8 @@
 import { CogTiff } from './cog.tiff.js';
 import { TiffMimeType } from './const/tiff.mime.js';
-import { TiffTag, TiffTagGeo } from './const/tiff.tag.id.js';
-import { CogTiffTagBase } from './read/tag/tiff.tag.base.js';
-import { CogTiffTagOffset } from './read/tag/tiff.tag.offset.js';
+import { TagId, TagGeoId } 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
@@ -15,6 +13,8 @@ export interface CogTiffImageTiledCount {
     /** Number of tiles on the y axis */
     y: number;
 }
+/** Tags that are commonly accessed for geotiffs */
+export declare const ImportantTags: Set<TagId>;
 /**
  * Size of a individual tile
  */
@@ -26,15 +26,15 @@ export interface CogTiffImageTileSize {
 }
 export declare class CogTiffImage {
     /** All IFD tags that have been read for the image */
-    tags: Map<TiffTag, CogTiffTagBase>;
+    tags: Map<TagId, Tag>;
     /** Id of the tif image, generally the image index inside the tif */
     id: number;
-    tif: CogTiff;
+    tiff: CogTiff;
     /** Has loadGeoTiffTags been called */
-    private tagsGeoLoaded;
+    isGeoTagsLoaded: boolean;
     /** Sub tags stored in TiffTag.GeoKeyDirectory */
-    tagsGeo: Map<TiffTagGeo, string | number>;
-    constructor(tif: CogTiff, id: number, tags: Map<TiffTag, CogTiffTagBase>);
+    tagsGeo: Map<TagGeoId, string | number>;
+    constructor(tiff: CogTiff, id: number, tags: Map<TagId, Tag>);
     /**
      * Force loading of important tags if they have not already been loaded
      *
@@ -44,7 +44,7 @@ export declare class CogTiffImage {
     /**
      * Get the value of a TiffTag if it exists null otherwise
      */
-    value<T>(tag: TiffTag): T | null;
+    value<T>(tag: TagId): T | null;
     /**
      * Load and unpack the GeoKeyDirectory
      */
@@ -52,12 +52,12 @@ export declare class CogTiffImage {
     /**
      * Get the associated GeoTiffTags
      */
-    valueGeo(tag: TiffTagGeo): string | number | undefined;
+    valueGeo(tag: TagGeoId): 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: TiffTag): Promise<T | null>;
+    fetch<T>(tag: TagId): Promise<T | null>;
     /**
      * Get the origin point for the image
      *
@@ -98,10 +98,6 @@ export declare class CogTiffImage {
      * @returns Size in pixels
      */
     get size(): Size;
-    /**
-     * Get the list of IFD tags that were read
-     */
-    get tagList(): string[];
     /**
      * Determine if this image is tiled
      */
@@ -121,7 +117,7 @@ export declare class CogTiffImage {
      *
      * @returns file offset to where the tiffs are stored
      */
-    get tileOffset(): CogTiffTagOffset;
+    get tileOffset(): TagOffset;
     /**
      * Get the number of strip's inside this tiff
      *
@@ -130,13 +126,6 @@ export declare class CogTiffImage {
      * @returns number of strips present
      */
     get stripCount(): number;
-    /**
-     * Get a pointer to a specific tile inside the tiff file
-     *
-     * @param index tile index
-     * @returns file offset of the specified tile
-     */
-    protected getTileOffset(index: number): Promise<number>;
     getTileBounds(x: number, y: number): BoundingBox;
     /**
      * Read a strip into a uint8 array
@@ -145,7 +134,7 @@ export declare class CogTiffImage {
      */
     getStrip(index: number): Promise<{
         mimeType: TiffMimeType;
-        bytes: Uint8Array;
+        bytes: ArrayBuffer;
     } | null>;
     /** The jpeg header is stored in the IFD, read the JPEG header and adjust the byte array to include it */
     private getJpegHeader;
@@ -161,7 +150,7 @@ export declare class CogTiffImage {
      */
     getTile(x: number, y: number): Promise<{
         mimeType: TiffMimeType;
-        bytes: Uint8Array;
+        bytes: ArrayBuffer;
     } | null>;
     /**
      * Does this tile exist in the tiff and does it actually have a value
@@ -173,9 +162,8 @@ export declare class CogTiffImage {
      * @returns if the tile exists and has data
      */
     hasTile(x: number, y: number): Promise<boolean>;
-    protected getTileSize(index: number): Promise<{
+    getTileSize(index: number): Promise<{
         offset: number;
         imageSize: number;
     }>;
 }
-//# sourceMappingURL=cog.tiff.image.d.ts.map