@versatiles/container 1.2.2 → 1.2.3

package/README.md

@@ -28,11 +28,11 @@ fs.writeFileSync('tile.' + header.tile_format, tile);
 ### 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-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L38">\[src]</a></sup>
+to access tile data, metadata, and other properties within the container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L73">\[src]</a></sup>
 
 #### Constructor: `new Container(source, options)`
 
-Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L59">\[src]</a></sup>
+Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L94">\[src]</a></sup>
 
 **Parameters:**
 
@@ -44,7 +44,7 @@ Constructs a new instance of the VersaTiles class. <sup><a href="https://github.
 
 #### Method: `getHeader()`
 
-Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L81">\[src]</a></sup>
+Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L116">\[src]</a></sup>
 
 **Returns:** <code>Promise<[Header](#interface_header)></code>
 
@@ -52,7 +52,7 @@ 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-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L128">\[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/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L163">\[src]</a></sup>
 
 **Returns:** <code>Promise\<undefined | string></code>
 
@@ -61,7 +61,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-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L155">\[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/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L190">\[src]</a></sup>
 
 **Parameters:**
 
@@ -79,7 +79,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-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L203">\[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/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L238">\[src]</a></sup>
 
 **Parameters:**
 

package/dist/index.d.ts

@@ -1,3 +1,38 @@
+/**
+ * @module
+ *
+ * This module provides functionality to interact with and retrieve tile data from `.versatiles` container files,
+ * typically used for storing geospatial tile data in a compressed, optimized format. The module supports
+ * multiple file and compression formats.
+ *
+ * Dependencies:
+ * - `HttpReader` and `FileReader`: Adapters for reading data from HTTP/HTTPS URLs or local files, respectively.
+ * - `decompress`: Utility for decompressing tile data in supported formats.
+ * - Type definitions (`Block`, `Compression`, `Format`, `Header`, `OpenOptions`, `Reader`, and `TileIndex`)
+ *   from the module's `interfaces.js` file to ensure type safety and consistency.
+ *
+ * Exported Constants:
+ * - `FORMATS`: Supported formats organized by version for different tile data, including image formats (e.g., PNG, JPG)
+ *   and vector formats (e.g., PBF).
+ * - `COMPRESSIONS`: Available compression types, including 'raw' (no compression), 'gzip', and 'br' (Brotli).
+ * - `MIMETYPES`: Maps supported tile formats to their respective MIME types for handling and delivery.
+ *
+ * Exported Types:
+ * - The module re-exports `Compression`, `Format`, `Header`, `OpenOptions`, and `Reader` types for use in other modules.
+ *
+ * Primary Class:
+ * - `Container`: A main wrapper class that provides methods to access tile data, metadata, and configuration settings
+ *   for `.versatiles` containers. Methods include `getHeader`, `getMetadata`, `getTile`, and `getTileUncompressed`,
+ *   which enable detailed control and retrieval of tile information, metadata, and decompressed content.
+ *
+ * @example
+ * ```ts
+ * import { Container } from '@versatiles/container';
+ * const container = new Container('path/to/versatiles-file');
+ * const tile = await container.getTile(12, 2200, 1343);
+ * const metadata = await container.getMetadata();
+ * ```
+ */
 import type { Block, Header, OpenOptions, Reader, TileIndex } from './lib/interfaces.js';
 export type { Compression, Format, Header, OpenOptions, Reader } from './lib/interfaces.js';
 /**

package/dist/index.js

@@ -1,3 +1,38 @@
+/**
+ * @module
+ *
+ * This module provides functionality to interact with and retrieve tile data from `.versatiles` container files,
+ * typically used for storing geospatial tile data in a compressed, optimized format. The module supports
+ * multiple file and compression formats.
+ *
+ * Dependencies:
+ * - `HttpReader` and `FileReader`: Adapters for reading data from HTTP/HTTPS URLs or local files, respectively.
+ * - `decompress`: Utility for decompressing tile data in supported formats.
+ * - Type definitions (`Block`, `Compression`, `Format`, `Header`, `OpenOptions`, `Reader`, and `TileIndex`)
+ *   from the module's `interfaces.js` file to ensure type safety and consistency.
+ *
+ * Exported Constants:
+ * - `FORMATS`: Supported formats organized by version for different tile data, including image formats (e.g., PNG, JPG)
+ *   and vector formats (e.g., PBF).
+ * - `COMPRESSIONS`: Available compression types, including 'raw' (no compression), 'gzip', and 'br' (Brotli).
+ * - `MIMETYPES`: Maps supported tile formats to their respective MIME types for handling and delivery.
+ *
+ * Exported Types:
+ * - The module re-exports `Compression`, `Format`, `Header`, `OpenOptions`, and `Reader` types for use in other modules.
+ *
+ * Primary Class:
+ * - `Container`: A main wrapper class that provides methods to access tile data, metadata, and configuration settings
+ *   for `.versatiles` containers. Methods include `getHeader`, `getMetadata`, `getTile`, and `getTileUncompressed`,
+ *   which enable detailed control and retrieval of tile information, metadata, and decompressed content.
+ *
+ * @example
+ * ```ts
+ * import { Container } from '@versatiles/container';
+ * const container = new Container('path/to/versatiles-file');
+ * const tile = await container.getTile(12, 2200, 1343);
+ * const metadata = await container.getMetadata();
+ * ```
+ */
 import HttpReader from './lib/reader_http.js';
 import FileReader from './lib/reader_file.js';
 import { decompress } from './lib/decompress.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/container",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "A client library for reading VersaTiles containers",
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.build.json",
@@ -49,18 +49,18 @@
     "versatiles"
   ],
   "devDependencies": {
-    "@types/jest": "^29.5.13",
-    "@types/node": "^22.5.5",
-    "@typescript-eslint/eslint-plugin": "^8.6.0",
-    "@typescript-eslint/parser": "^8.6.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.8.1",
+    "@typescript-eslint/eslint-plugin": "^8.11.0",
+    "@typescript-eslint/parser": "^8.11.0",
     "@versatiles/release-tool": "^1.2.6",
-    "eslint": "^9.11.0",
+    "eslint": "^9.13.0",
     "jest": "^29.7.0",
-    "npm-check-updates": "^17.1.3",
+    "npm-check-updates": "^17.1.6",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "tsx": "^4.19.1",
-    "typescript": "^5.6.2",
-    "typescript-eslint": "^8.6.0"
+    "tsx": "^4.19.2",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.11.0"
   }
 }