@versatiles/container 1.1.0 → 1.2.1

package/README.md

@@ -1,13 +1,16 @@
+[![Code Coverage](https://codecov.io/gh/versatiles-org/node-versatiles/branch/main/graph/badge.svg?token=IDHAI13M0K)](https://codecov.io/gh/versatiles-org/node-versatiles)
+[![GitHub Workflow Status)](https://img.shields.io/github/actions/workflow/status/versatiles-org/node-versatiles-container/ci.yml)](https://github.com/versatiles-org/node-versatiles-container/actions/workflows/ci.yml)
+
 A client library for [VersaTiles containers](https://github.com/versatiles-org/versatiles-spec).
 
 # Install
 
-`npm i versatiles`
+`npm i @versatiles/container"`
 
 # Usage Example
 
 ```js
-import VersaTiles from 'versatiles';
+import VersaTiles from '@versatiles/container"';
 import fs from 'fs';
 
 const container = new VersaTiles('https://example.org/planet.versatiles');
@@ -20,18 +23,16 @@ fs.writeFileSync('tile.' + header.tile_format, tile);
 
 <!--- This chapter is generated automatically --->
 
-<details>
+## Classes
 
-<summary><h2>Class: <code>Container</code><a id="class_container"></a></h2></summary>
+### Class: `Container`<a id="class_container"></a>
 
 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/99b1c91/versatiles-container/src/index.ts#L38">\[src]</a></sup>
-
-<details>
+to access tile data, metadata, and other properties within the container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/84e4c84/src/index.ts#L38">\[src]</a></sup>
 
-<summary><h3>Constructor: <code>new Container&#40;source, options&#41;</code></h3></summary>
+#### Constructor: `new Container(source, options)`
 
-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>
+Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/84e4c84/src/index.ts#L59">\[src]</a></sup>
 
 **Parameters:**
 
@@ -41,40 +42,26 @@ Constructs a new instance of the VersaTiles class. <sup><a href="https://github.
 * <code>options: [OpenOptions](#interface_openoptions)</code> (optional)\
   Optional settings that configure tile handling.
 
-**Returns:** <code>[Container](#class_container)</code>
-
-</details>
-
-<details>
+#### Method: `getHeader()`
 
-<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/99b1c91/versatiles-container/src/index.ts#L85">\[src]</a></sup>
+Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/84e4c84/src/index.ts#L81">\[src]</a></sup>
 
 **Returns:** <code>Promise<[Header](#interface_header)></code>
 
-</details>
-
-<details>
-
-<summary><h3>Method: <code>getMetadata&#40;&#41;</code></h3></summary>
+#### Method: `getMetadata()`
 
 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/99b1c91/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-container/blob/84e4c84/src/index.ts#L128">\[src]</a></sup>
 
 **Returns:** <code>Promise\<undefined | string></code>
 
-</details>
-
-<details>
-
-<summary><h3>Method: <code>getTile&#40;z, x, y&#41;</code></h3></summary>
+#### Method: `getTile(z, x, y)`
 
 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/99b1c91/versatiles-container/src/index.ts#L159">\[src]</a></sup>
+If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/84e4c84/src/index.ts#L155">\[src]</a></sup>
 
 **Parameters:**
 
@@ -87,16 +74,12 @@ If the specified tile does not exist, the method returns `null`. <sup><a href="h
 
 **Returns:** <code>Promise\<null | Buffer></code>
 
-</details>
-
-<details>
-
-<summary><h3>Method: <code>getTileUncompressed&#40;z, x, y&#41;</code></h3></summary>
+#### Method: `getTileUncompressed(z, x, y)`
 
 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/99b1c91/versatiles-container/src/index.ts#L207">\[src]</a></sup>
+If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/84e4c84/src/index.ts#L203">\[src]</a></sup>
 
 **Parameters:**
 
@@ -109,86 +92,48 @@ If the specified tile does not exist, the method returns `null`. <sup><a href="h
 
 **Returns:** <code>Promise\<null | Buffer></code>
 
-</details>
-
-</details>
-
-<details>
-
-<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/99b1c91/versatiles-container/src/interfaces.ts#L57">\[src]</a></sup>
-
-* <code>magic: string</code>\
-  Identifier for the container format, usually "versatiles\_v02".
-* <code>version: string</code>\
-  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>\
-  The minimum zoom level.
-* <code>zoomMax: number</code>\
-  The maximum zoom level.
-* <code>bbox: \[number, number, number, number]</code>\
-  Bounding box coordinates as \[lon\_min, lat\_min, lon\_max, lat\_max].
-* <code>metaOffset: number</code>\
-  The byte offset for metadata within the container.
-* <code>metaLength: number</code>\
-  The byte size of the metadata. A value of 0 means no metadata.
-* <code>blockIndexOffset: number</code>\
-  The byte offset for the block index within the container.
-* <code>blockIndexLength: number</code>\
-  The byte size of the block index. A value of 0 indicates no tiles in the container.
-
-</details>
-
-<details>
-
-<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/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.
+## Interfaces
+
+### Interface: `Header`<a id="interface_header"></a>
+
+```typescript
+interface {
+  bbox: [number, number, number, number];
+  blockIndexLength: number;
+  blockIndexOffset: number;
+  magic: string;
+  metaLength: number;
+  metaOffset: number;
+  tileCompression: [Compression](#type_compression);
+  tileFormat: [Format](#type_format);
+  tileMime: string;
+  version: string;
+  zoomMax: number;
+  zoomMin: number;
+}
+```
 
-</details>
+### Interface: `OpenOptions`<a id="interface_openoptions"></a>
 
-<details>
+```typescript
+interface {
+  tms: boolean;
+}
+```
 
-<summary><h2>Type: <code>Compression</code><a id="type_compression"></a></h2></summary>
+## Type Aliases
 
-Supported compression.\
-`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: `Compression`<a id="type_compression"></a>
 
 **Type:** <code>"br" | "gzip" | "raw"</code>
 
-</details>
-
-<details>
-
-<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/99b1c91/versatiles-container/src/interfaces.ts#L11">\[src]</a></sup>
-
-**Type:** <code>"avif" | "bin" | "geojson" | "jpeg" | "json" | "pbf" | "png" | "svg" | "topojson" | "webp"</code>
-
-</details>
-
-<details>
-
-<summary><h2>Type: <code>Reader</code><a id="type_reader"></a></h2></summary>
-
-Type definition for reading content from a VersaTiles container.
+### Type: `Format`<a id="type_format"></a>
 
-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>"avif" | "bin" | "geojson" | "jpg" | "json" | "pbf" | "png" | "svg" | "topojson" | "webp"</code>
 
-**Type:** <code>(position: number, length: number) => Promise<Buffer></code>
+### Type: `Reader`<a id="type_reader"></a>
 
-</details>
+**Type:** <code>(position: number, length: number) => Promise\<Buffer></code>
 
 # License
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { Block, Header, OpenOptions, Reader, TileIndex } from './interfaces.js';
-export type { Compression, Format, Header, OpenOptions, Reader } from './interfaces.js';
+import type { Block, Header, OpenOptions, Reader, TileIndex } from './lib/interfaces.js';
+export type { Compression, Format, Header, OpenOptions, Reader } from './lib/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.

package/dist/index.js

@@ -1,12 +1,12 @@
-import HttpReader from './reader_http.js';
-import FileReader from './reader_file.js';
-import { decompress } from './decompress.js';
+import HttpReader from './lib/reader_http.js';
+import FileReader from './lib/reader_file.js';
+import { decompress } from './lib/decompress.js';
 const FORMATS = {
-    'c01': ['png', 'jpeg', 'webp', null, null, null, null, null, null, null, null, null, null, null, null, null, 'pbf'],
-    'v01': ['png', 'jpeg', 'webp', 'pbf'],
+    'c01': ['png', 'jpg', 'webp', null, null, null, null, null, null, null, null, null, null, null, null, null, 'pbf'],
+    'v01': ['png', 'jpg', 'webp', 'pbf'],
     'v02': [
         'bin', null, null, null, null, null, null, null, null, null, null, null, null, null, null, null,
-        'png', 'jpeg', 'webp', 'avif', 'svg', null, null, null, null, null, null, null, null, null, null, null,
+        'png', 'jpg', 'webp', 'avif', 'svg', null, null, null, null, null, null, null, null, null, null, null,
         'pbf', 'geojson', 'topojson', 'json',
     ],
 };
@@ -15,7 +15,7 @@ const MIMETYPES = {
     'avif': 'image/avif',
     'bin': 'application/octet-stream',
     'geojson': 'application/geo+json; charset=utf-8',
-    'jpeg': 'image/jpeg',
+    'jpg': 'image/jpeg',
     'json': 'application/json; charset=utf-8',
     'pbf': 'application/x-protobuf',
     'png': 'image/png',
@@ -32,7 +32,6 @@ export class Container {
         tms: false,
     };
     #reader;
-    #decompress;
     #header;
     #metadata;
     #blockIndex;
@@ -61,7 +60,6 @@ export class Container {
         else {
             throw new Error('source must be a string or a Reader');
         }
-        this.#decompress = decompress;
     }
     /**
      * Asynchronously retrieves the header information from the `.versatiles` container.
@@ -119,7 +117,7 @@ export class Container {
         }
         else {
             let buffer = await this.read(header.metaOffset, header.metaLength);
-            buffer = await this.#decompress(buffer, header.tileCompression);
+            buffer = await decompress(buffer, header.tileCompression);
             this.#metadata = buffer.toString();
         }
         return this.#metadata;
@@ -183,7 +181,7 @@ export class Container {
         if (!tile)
             return null;
         const header = await this.getHeader();
-        return this.#decompress(tile, header.tileCompression);
+        return decompress(tile, header.tileCompression);
     }
     /**
      * Asynchronously retrieves a mapping of tile block indices. The map's keys are formatted as "{z},{x},{y}".
@@ -198,7 +196,7 @@ export class Container {
         const header = await this.getHeader();
         // read block_index buffer
         let data = await this.read(header.blockIndexOffset, header.blockIndexLength);
-        data = await this.#decompress(data, 'br');
+        data = await decompress(data, 'br');
         // read index from buffer
         const blocks = [];
         switch (header.version) {
@@ -257,7 +255,7 @@ export class Container {
         if (block.tileIndex)
             return block.tileIndex;
         let buffer = await this.read(block.tileIndexOffset, block.tileIndexLength);
-        buffer = await this.#decompress(buffer, 'br');
+        buffer = await decompress(buffer, 'br');
         const offsets = new Float64Array(block.tileCount);
         const lengths = new Float64Array(block.tileCount);
         for (let i = 0; i < block.tileCount; i++) {

package/dist/{interfaces.d.ts → lib/interfaces.d.ts}

@@ -7,7 +7,7 @@ export type Compression = 'br' | 'gzip' | 'raw';
 /**
  * Supported tile formats.
  */
-export type Format = 'avif' | 'bin' | 'geojson' | 'jpeg' | 'json' | 'pbf' | 'png' | 'svg' | 'topojson' | 'webp';
+export type Format = 'avif' | 'bin' | 'geojson' | 'jpg' | 'json' | 'pbf' | 'png' | 'svg' | 'topojson' | 'webp';
 /**
  * Type definition for a function that decompresses data.
  *

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@versatiles/container",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "A client library for reading VersaTiles containers",
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.build.json",
-    "check": "npm run lint && npm run test && npm run build",
+    "check": "npm run lint && npm run build && npm run test",
     "doc": "npx vrt ts2md src/index.ts tsconfig.build.json | npx vrt insertmd README.md '# API' true",
     "lint": "eslint . --color",
-    "prepublish": "npm run build && npm run doc",
-    "test": "cd ..; NODE_OPTIONS=--experimental-vm-modules jest --testPathPattern versatiles-container"
+    "prepack": "npm run build && npm run doc",
+    "release": "npx vrt release-npm",
+    "test-coverage": "NODE_OPTIONS=--experimental-vm-modules jest --coverage",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "upgrade": "npm-check-updates -u && rm -f package-lock.json; rm -rf node_modules; npm i && npm update"
   },
   "files": [
     "dist/**/*.js",
@@ -16,9 +19,9 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/versatiles-org/node-versatiles.git"
+    "url": "git+https://github.com/versatiles-org/node-versatiles-container.git"
   },
-  "homepage": "https://github.com/versatiles-org/node-versatiles/blob/main/versatiles-container/README.md",
+  "homepage": "https://github.com/versatiles-org/node-versatiles-container/blob/main/versatiles-container/README.md",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -46,9 +49,17 @@
     "versatiles"
   ],
   "devDependencies": {
-    "@types/node": "^20.9.1",
-    "tsx": "^4.1.3",
-    "typescript": "^5.2.2",
-    "@versatiles/release-tool": "^1.0.0"
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.20",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
+    "@versatiles/release-tool": "^1.2.2",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "npm-check-updates": "^16.14.15",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3"
   }
-}
+}