@versatiles/container 1.2.0 → 1.2.2

package/README.md

@@ -5,12 +5,12 @@ A client library for [VersaTiles containers](https://github.com/versatiles-org/v
 
 # Install
 
-`npm i @versatiles/container"`
+`npm i @versatiles/container`
 
 # Usage Example
 
 ```js
-import VersaTiles from '@versatiles/container"';
+import VersaTiles from '@versatiles/container';
 import fs from 'fs';
 
 const container = new VersaTiles('https://example.org/planet.versatiles');
@@ -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/67a9864/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/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L38">\[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/67a9864/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/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L59">\[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/67a9864/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/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L81">\[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/67a9864/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/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L128">\[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/67a9864/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/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L155">\[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/67a9864/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/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L203">\[src]</a></sup>
 
 **Parameters:**
 

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
-import type { Block, Header, OpenOptions, Reader, TileIndex } from './lib/interfaces';
-export type { Compression, Format, Header, OpenOptions, Reader } from './lib/interfaces';
+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,6 +1,6 @@
-import HttpReader from './lib/reader_http';
-import FileReader from './lib/reader_file';
-import { decompress } from './lib/decompress';
+import HttpReader from './lib/reader_http.js';
+import FileReader from './lib/reader_file.js';
+import { decompress } from './lib/decompress.js';
 const FORMATS = {
     'c01': ['png', 'jpg', 'webp', null, null, null, null, null, null, null, null, null, null, null, null, null, 'pbf'],
     'v01': ['png', 'jpg', 'webp', 'pbf'],
@@ -224,7 +224,6 @@ export class Container {
         // build map
         this.#blockIndex = new Map(blocks.map(b => [`${b.level},${b.column},${b.row}`, b]));
         return this.#blockIndex;
-        // eslint-disable-next-line @typescript-eslint/max-params
         function addBlock(buffer, blockOffset, tileIndexOffset, tileIndexLength) {
             const block = {
                 level: buffer.readUInt8(0),

package/dist/lib/decompress.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import type { Compression } from './interfaces';
+import type { Compression } from './interfaces.js';
 /**
  * Decompresses a buffer using the specified compression algorithm. Currently supports 'br' for Brotli and 'gzip' for GZIP.
  * If the specified algorithm is not supported, the function resolves the promise with the original buffer.

package/dist/lib/interfaces.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /**
  * Supported compression.
  * `null` signifies that the data is uncompressed.

package/dist/lib/reader_file.d.ts

@@ -1,4 +1,4 @@
-import type { Reader } from './interfaces';
+import type { Reader } from './interfaces.js';
 /**
  * Creates a file reader function for reading chunks of data from a file. This reader abstracts
  * the file reading process and provides a simple async interface to read data from the specified file.

package/dist/lib/reader_http.d.ts

@@ -1,4 +1,4 @@
-import type { Reader } from './interfaces';
+import type { Reader } from './interfaces.js';
 /**
  * Creates a function capable of reading data from a specified URL, which can be used
  * to read data chunks in an HTTP GET request. This is particularly useful for

package/dist/lib/reader_http.js

@@ -34,7 +34,6 @@ export default function getHTTPReader(url) {
             throw new RangeError(`Invalid read length: ${length}. The read length must be a non-negative integer.`);
         }
         const headers = {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
             'user-agent': 'Mozilla/5.0 (compatible; versatiles; +https://www.npmjs.com/package/versatiles)',
             'range': `bytes=${position}-${position + length - 1}`,
         };
@@ -70,7 +69,7 @@ export default function getHTTPReader(url) {
         const contentRange = message.headers['content-range'];
         if (contentRange == null)
             throw Error('The response header does not contain "content-range"');
-        const parts = /^bytes (\d+)\-(\d+)\/(\d+)/i.exec(contentRange);
+        const parts = /^bytes (\d+)-(\d+)\/(\d+)/i.exec(contentRange);
         if (parts == null)
             throw Error('"content-range" in response header is malformed');
         if (position !== parseInt(parts[1], 10))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/container",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A client library for reading VersaTiles containers",
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.build.json",
@@ -19,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",
@@ -49,17 +49,18 @@
     "versatiles"
   ],
   "devDependencies": {
-    "@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",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "@versatiles/release-tool": "^1.2.6",
+    "eslint": "^9.11.0",
     "jest": "^29.7.0",
-    "npm-check-updates": "^16.14.15",
-    "ts-jest": "^29.1.2",
+    "npm-check-updates": "^17.1.3",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "tsx": "^4.7.1",
-    "typescript": "^5.3.3"
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.6.0"
   }
 }