@versatiles/container 1.0.1 → 1.1.0

package/README.md

@@ -22,26 +22,26 @@ fs.writeFileSync('tile.' + header.tile_format, tile);
 
 <details>
 
-<summary><h2>Class: <code>VersaTiles</code><a id="class_versatiles"></a></h2></summary>
+<summary><h2>Class: <code>Container</code><a id="class_container"></a></h2></summary>
 
 The `VersaTiles` class is a wrapper around a `.versatiles` container file. It provides methods\
-to access tile data, metadata, and other properties within the container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/index.ts#L27">\[src]</a></sup>
+to access tile data, metadata, and other properties within the container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/index.ts#L38">\[src]</a></sup>
 
 <details>
 
-<summary><h3>Constructor: <code>new VersaTiles&#40;source, options&#41;</code></h3></summary>
+<summary><h3>Constructor: <code>new Container&#40;source, options&#41;</code></h3></summary>
 
-Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/index.ts#L50">\[src]</a></sup>
+Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/index.ts#L61">\[src]</a></sup>
 
 **Parameters:**
 
 * <code>source: string | [Reader](#type_reader)</code>\
   The data source for the tiles. This can be a URL starting with `http://` or `https://`,
   a path to a local file, or a custom `Reader` function that reads data chunks based on offset and length.
-* <code>options: [Options](#interface_options)</code> (optional)\
+* <code>options: [OpenOptions](#interface_openoptions)</code> (optional)\
   Optional settings that configure tile handling.
 
-**Returns:** <code>[VersaTiles](#class_versatiles)</code>
+**Returns:** <code>[Container](#class_container)</code>
 
 </details>
 
@@ -49,7 +49,7 @@ Constructs a new instance of the VersaTiles class. <sup><a href="https://github.
 
 <summary><h3>Method: <code>getHeader&#40;&#41;</code></h3></summary>
 
-Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/index.ts#L74">\[src]</a></sup>
+Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/index.ts#L85">\[src]</a></sup>
 
 **Returns:** <code>Promise<[Header](#interface_header)></code>
 
@@ -61,9 +61,9 @@ Asynchronously retrieves the header information from the `.versatiles` container
 
 Asynchronously retrieves the metadata associated with the `.versatiles` container.\
 Metadata typically includes information about `vector_layers` for vector tiles.
-If the container does not include metadata, this method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/index.ts#L132">\[src]</a></sup>
+If the container does not include metadata, this method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/index.ts#L132">\[src]</a></sup>
 
-**Returns:** <code>Promise\<null | object></code>
+**Returns:** <code>Promise\<undefined | string></code>
 
 </details>
 
@@ -74,7 +74,7 @@ If the container does not include metadata, this method returns `null`. <sup><a
 Asynchronously retrieves a specific tile's data as a Buffer. If the tile data is compressed as\
 defined in the container header, the returned Buffer will contain the compressed data.
 To obtain uncompressed data, use the `getTileUncompressed` method.
-If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/index.ts#L158">\[src]</a></sup>
+If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/index.ts#L159">\[src]</a></sup>
 
 **Parameters:**
 
@@ -96,7 +96,7 @@ If the specified tile does not exist, the method returns `null`. <sup><a href="h
 Asynchronously retrieves a specific tile's uncompressed data as a Buffer. This method first\
 retrieves the compressed tile data using `getTile` and then decompresses it based on the
 compression setting in the container header.
-If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/index.ts#L206">\[src]</a></sup>
+If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/index.ts#L207">\[src]</a></sup>
 
 **Parameters:**
 
@@ -117,7 +117,7 @@ If the specified tile does not exist, the method returns `null`. <sup><a href="h
 
 <summary><h2>Interface: <code>Header</code><a id="interface_header"></a></h2></summary>
 
-Interface for the metadata header of a `*.Versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/interfaces.ts#L56">\[src]</a></sup>
+Interface for the metadata header of a `*.Versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/interfaces.ts#L57">\[src]</a></sup>
 
 * <code>magic: string</code>\
   Identifier for the container format, usually "versatiles\_v02".
@@ -125,6 +125,8 @@ Interface for the metadata header of a `*.Versatiles` container. <sup><a href="h
   Version of the container format, typically "v02".
 * <code>tileFormat: [Format](#type_format)</code>\
   The format used for storing tiles.
+* <code>tileMime: string</code>\
+  The MIME type of the tiles.
 * <code>tileCompression: [Compression](#type_compression)</code>\
   The type of compression applied to tiles.
 * <code>zoomMin: number</code>\
@@ -146,9 +148,9 @@ Interface for the metadata header of a `*.Versatiles` container. <sup><a href="h
 
 <details>
 
-<summary><h2>Interface: <code>Options</code><a id="interface_options"></a></h2></summary>
+<summary><h2>Interface: <code>OpenOptions</code><a id="interface_openoptions"></a></h2></summary>
 
-Interface for defining the options available for reading a container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/interfaces.ts#L123">\[src]</a></sup>
+Interface for defining the options available for reading a container. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/interfaces.ts#L125">\[src]</a></sup>
 
 * <code>tms: boolean</code>\
   If set to true, uses the [TMS (Tile Map Service) tile ordering](https://wiki.openstreetmap.org/wiki/TMS) where y=0 is the southernmost point.
@@ -160,9 +162,9 @@ Interface for defining the options available for reading a container. <sup><a hr
 <summary><h2>Type: <code>Compression</code><a id="type_compression"></a></h2></summary>
 
 Supported compression.\
-`null` signifies that the data is uncompressed. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/interfaces.ts#L5">\[src]</a></sup>
+`null` signifies that the data is uncompressed. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/interfaces.ts#L5">\[src]</a></sup>
 
-**Type:** <code>"br" | "gzip" | null</code>
+**Type:** <code>"br" | "gzip" | "raw"</code>
 
 </details>
 
@@ -170,9 +172,9 @@ Supported compression.\
 
 <summary><h2>Type: <code>Format</code><a id="type_format"></a></h2></summary>
 
-Supported tile formats. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/interfaces.ts#L11">\[src]</a></sup>
+Supported tile formats. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/interfaces.ts#L11">\[src]</a></sup>
 
-**Type:** <code>"avif" | "bin" | "geojson" | "jpeg" | "json" | "pbf" | "png" | "svg" | "topojson" | "webp" | null</code>
+**Type:** <code>"avif" | "bin" | "geojson" | "jpeg" | "json" | "pbf" | "png" | "svg" | "topojson" | "webp"</code>
 
 </details>
 
@@ -182,7 +184,7 @@ Supported tile formats. <sup><a href="https://github.com/versatiles-org/node-ver
 
 Type definition for reading content from a VersaTiles container.
 
-This is useful for implementing new container readers, e.g. reading over other network protocols. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/8921e07/versatiles-container/src/interfaces.ts#L37">\[src]</a></sup>
+This is useful for implementing new container readers, e.g. reading over other network protocols. <sup><a href="https://github.com/versatiles-org/node-versatiles/blob/99b1c91/versatiles-container/src/interfaces.ts#L37">\[src]</a></sup>
 
 **Type:** <code>(position: number, length: number) => Promise<Buffer></code>
 

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { Block, Header, Options, Reader, TileIndex } from './interfaces.js';
-export type { Compression, Format, Header, Options, Reader } from './interfaces.js';
+import type { Block, Header, OpenOptions, Reader, TileIndex } from './interfaces.js';
+export type { Compression, Format, Header, OpenOptions, Reader } from './interfaces.js';
 /**
  * The `VersaTiles` class is a wrapper around a `.versatiles` container file. It provides methods
  * to access tile data, metadata, and other properties within the container.
  */
-export declare class VersaTiles {
+export declare class Container {
     #private;
     /**
      * Constructs a new instance of the VersaTiles class.
@@ -15,7 +15,7 @@ export declare class VersaTiles {
      * @param options - Optional settings that configure tile handling.
      * @throws Will throw an error if the provided source is neither a string nor a Reader function.
      */
-    constructor(source: Reader | string, options?: Options);
+    constructor(source: Reader | string, options?: OpenOptions);
     /**
      * Asynchronously retrieves the header information from the `.versatiles` container.
      *
@@ -28,9 +28,9 @@ export declare class VersaTiles {
      * Metadata typically includes information about `vector_layers` for vector tiles.
      * If the container does not include metadata, this method returns `null`.
      *
-     * @returns A promise that resolves with an object representing the metadata, or null if no metadata is present.
+     * @returns A promise that resolves with an object representing the metadata.
      */
-    getMetadata(): Promise<object | null>;
+    getMetadata(): Promise<string | undefined>;
     /**
      * Asynchronously retrieves a specific tile's data as a Buffer. If the tile data is compressed as
      * defined in the container header, the returned Buffer will contain the compressed data.

package/dist/index.js

@@ -10,12 +10,24 @@ const FORMATS = {
         'pbf', 'geojson', 'topojson', 'json',
     ],
 };
-const COMPRESSIONS = [null, 'gzip', 'br'];
+const COMPRESSIONS = ['raw', 'gzip', 'br'];
+const MIMETYPES = {
+    'avif': 'image/avif',
+    'bin': 'application/octet-stream',
+    'geojson': 'application/geo+json; charset=utf-8',
+    'jpeg': 'image/jpeg',
+    'json': 'application/json; charset=utf-8',
+    'pbf': 'application/x-protobuf',
+    'png': 'image/png',
+    'svg': 'image/svg+xml; charset=utf-8',
+    'topojson': 'application/topo+json; charset=utf-8',
+    'webp': 'image/webp',
+};
 /**
  * The `VersaTiles` class is a wrapper around a `.versatiles` container file. It provides methods
  * to access tile data, metadata, and other properties within the container.
  */
-export class VersaTiles {
+export class Container {
     #options = {
         tms: false,
     };
@@ -66,41 +78,29 @@ export class VersaTiles {
         if (!/^versatiles_v0[12]$/.test(data.toString('utf8', 0, 14))) {
             throw new Error('Invalid Container');
         }
+        const magic = data.toString('utf8', 0, 14);
         const version = data.toString('utf8', 11, 14);
+        const tileFormat = FORMATS[version][data.readUInt8(14)] ?? 'bin';
+        const tileMime = MIMETYPES[tileFormat];
+        const tileCompression = COMPRESSIONS[data.readUInt8(15)] ?? 'raw';
+        const zoomMin = data.readUInt8(16);
+        const zoomMax = data.readUInt8(17);
+        let bbox;
+        const metaOffset = Number(data.readBigUInt64BE(34));
+        const metaLength = Number(data.readBigUInt64BE(42));
+        const blockIndexOffset = Number(data.readBigUInt64BE(50));
+        const blockIndexLength = Number(data.readBigUInt64BE(58));
         switch (version) {
             case 'v01':
-                this.#header = {
-                    magic: data.toString('utf8', 0, 14),
-                    version: version,
-                    tileFormat: FORMATS[version][data.readUInt8(14)] ?? 'bin',
-                    tileCompression: COMPRESSIONS[data.readUInt8(15)] ?? null,
-                    zoomMin: data.readUInt8(16),
-                    zoomMax: data.readUInt8(17),
-                    bbox: [data.readFloatBE(18), data.readFloatBE(22), data.readFloatBE(26), data.readFloatBE(30)],
-                    metaOffset: Number(data.readBigUInt64BE(34)),
-                    metaLength: Number(data.readBigUInt64BE(42)),
-                    blockIndexOffset: Number(data.readBigUInt64BE(50)),
-                    blockIndexLength: Number(data.readBigUInt64BE(58)),
-                };
+                bbox = [data.readFloatBE(18), data.readFloatBE(22), data.readFloatBE(26), data.readFloatBE(30)];
                 break;
             case 'v02':
-                this.#header = {
-                    magic: data.toString('utf8', 0, 14),
-                    version: version,
-                    tileFormat: FORMATS[version][data.readUInt8(14)] ?? 'bin',
-                    tileCompression: COMPRESSIONS[data.readUInt8(15)] ?? null,
-                    zoomMin: data.readUInt8(16),
-                    zoomMax: data.readUInt8(17),
-                    bbox: [data.readInt32BE(18) / 1e7, data.readInt32BE(22) / 1e7, data.readInt32BE(26) / 1e7, data.readInt32BE(30) / 1e7],
-                    metaOffset: Number(data.readBigUInt64BE(34)),
-                    metaLength: Number(data.readBigUInt64BE(42)),
-                    blockIndexOffset: Number(data.readBigUInt64BE(50)),
-                    blockIndexLength: Number(data.readBigUInt64BE(58)),
-                };
+                bbox = [data.readInt32BE(18) / 1e7, data.readInt32BE(22) / 1e7, data.readInt32BE(26) / 1e7, data.readInt32BE(30) / 1e7];
                 break;
             default:
                 throw new Error('Invalid Container');
         }
+        this.#header = { magic, version, tileFormat, tileMime, tileCompression, zoomMin, zoomMax, bbox, metaOffset, metaLength, blockIndexOffset, blockIndexLength };
         return this.#header;
     }
     /**
@@ -108,19 +108,19 @@ export class VersaTiles {
      * Metadata typically includes information about `vector_layers` for vector tiles.
      * If the container does not include metadata, this method returns `null`.
      *
-     * @returns A promise that resolves with an object representing the metadata, or null if no metadata is present.
+     * @returns A promise that resolves with an object representing the metadata.
      */
     async getMetadata() {
         if (this.#metadata !== undefined)
             return this.#metadata;
         const header = await this.getHeader();
         if (header.metaLength === 0) {
-            this.#metadata = null;
+            this.#metadata = undefined;
         }
         else {
             let buffer = await this.read(header.metaOffset, header.metaLength);
             buffer = await this.#decompress(buffer, header.tileCompression);
-            this.#metadata = JSON.parse(buffer.toString());
+            this.#metadata = buffer.toString();
         }
         return this.#metadata;
     }

package/dist/interfaces.d.ts

@@ -3,11 +3,11 @@
  * Supported compression.
  * `null` signifies that the data is uncompressed.
  */
-export type Compression = 'br' | 'gzip' | null;
+export type Compression = 'br' | 'gzip' | 'raw';
 /**
  * Supported tile formats.
  */
-export type Format = 'avif' | 'bin' | 'geojson' | 'jpeg' | 'json' | 'pbf' | 'png' | 'svg' | 'topojson' | 'webp' | null;
+export type Format = 'avif' | 'bin' | 'geojson' | 'jpeg' | 'json' | 'pbf' | 'png' | 'svg' | 'topojson' | 'webp';
 /**
  * Type definition for a function that decompresses data.
  *
@@ -35,6 +35,7 @@ export type Reader = (position: number, length: number) => Promise<Buffer>;
  * @property {string} magic - Identifier for the container format, usually "versatiles_v02".
  * @property {string} version - Version of the container format, typically "v02".
  * @property {Format} tileFormat - The format used for storing tiles.
+ * @property {string} tileMime - The MIME type of the tiles.
  * @property {Compression} tileCompression - The type of compression applied to tiles.
  * @property {number} zoomMin - The minimum zoom level.
  * @property {number} zoomMax - The maximum zoom level.
@@ -48,6 +49,7 @@ export interface Header {
     magic: string;
     version: string;
     tileFormat: Format;
+    tileMime: string;
     tileCompression: Compression;
     zoomMin: number;
     zoomMax: number;
@@ -102,6 +104,6 @@ export interface TileIndex {
  * Interface for defining the options available for reading a container.
  * @property {boolean} tms - If set to true, uses the [TMS (Tile Map Service) tile ordering](https://wiki.openstreetmap.org/wiki/TMS) where y=0 is the southernmost point.
  */
-export interface Options {
+export interface OpenOptions {
     tms: boolean;
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@versatiles/container",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A client library for reading VersaTiles containers",
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.build.json",
-    "check": "cd ..; npm run check",
+    "check": "npm run lint && npm run test && npm run build",
     "doc": "npx vrt ts2md src/index.ts tsconfig.build.json | npx vrt insertmd README.md '# API' true",
-    "lint": "cd ..; npm run lint",
+    "lint": "eslint . --color",
     "prepublish": "npm run build && npm run doc",
-    "test": "cd ..; npm run test"
+    "test": "cd ..; NODE_OPTIONS=--experimental-vm-modules jest --testPathPattern versatiles-container"
   },
   "files": [
     "dist/**/*.js",
@@ -18,7 +18,7 @@
     "type": "git",
     "url": "git+https://github.com/versatiles-org/node-versatiles.git"
   },
-  "homepage": "https://github.com/versatiles-org/node-versatiles/blob/main/container/README.md",
+  "homepage": "https://github.com/versatiles-org/node-versatiles/blob/main/versatiles-container/README.md",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -46,8 +46,8 @@
     "versatiles"
   ],
   "devDependencies": {
-    "@types/node": "^20.9.0",
-    "tsx": "^4.1.0",
+    "@types/node": "^20.9.1",
+    "tsx": "^4.1.3",
     "typescript": "^5.2.2",
     "@versatiles/release-tool": "^1.0.0"
   }