tilelive - npm Package Compare versions

Comparing version 3.0.2 to 4.0.0

package.json

 {
     "name"          : "tilelive",
-    "main"          : "./lib/tilelive/index",
-    "description"   : "Map server with backends for mapnik and mbtiles",
+    "version"       : "4.0.0",
+    "main"          : "./lib/tilelive.js",
+    "description"   : "Frontend for various tile backends, mapnik and mbtiles",
     "url"           : "http://github.com/mapbox/tilelive.js",
@@ -23,3 +24,4 @@ "keywords"      : ["map", "server", "mapnik", "tms"],
         "Dane Springmeyer <springmeyer>",
-        "Young Hahn <yhahn>"
+        "Young Hahn <yhahn>",
+        "Konstantin Käfer <kkaefer>"
     ],
@@ -30,2 +32,3 @@ "dependencies": {
         "step": "0.0.x",
+        "sphericalmercator": "1.0.0",
         "underscore": "1.1.x"
@@ -36,3 +39,5 @@ },
         "expresso": "0.7.x",
-        "jshint": "0.2.0"
+        "jshint": "0.2.0",
+        "mbtiles": "0.1.x",
+        "tilejson": "0.0.x"
     },
@@ -45,3 +50,2 @@ "bin": {
     },
-    "version"       : "3.0.2",
     "scripts": {
@@ -48,0 +52,0 @@ "pretest": "npm install --dev",

README.md

 # tilelive.js
 
-tilelive.js is a tile server for [node.js](http://nodejs.org/) which supports on-the-fly
-configuration and advanced interaction output. It can be used to add a tile server to an existing web application or wrapped with a light standalone web tile server.
+tilelive.js is an interface for tilestore modules for [node.js](http://nodejs.org/). It defines an [API](https://github.com/mapbox/tilelive.js/blob/master/API.md) to interact with implementations for a particular tile store.
 
 ## Backends
 
-tilelive.js supports backends for serving tiles and for storing them when creating [mbtiles](http://mbtiles.org) or other caches of tiles.
+- [MBTiles](https://github.com/mapbox/node-mbtiles)
+- [TileJSON](https://github.com/mapbox/node-tilejson)
+- [Mapnik](https://github.com/mapbox/tilelive-mapnik)
 
-Each backend is expected to export an object in the following form:
+## Usage
 
-    module.exports = {
-        // Return an object usable with the `Pool()` constructor from
-        // `generic-pool`. The resource will be pooled and passed back to
-        // other backend methods for serving and storing.
-        pool: function(datasource) {
-            return {
-                create: [Function],
-                destroy: [Function]
-            }
-        },
+Tilelive doesn't ship with any Tilestore backends by default. To use a particular backend, register it with tilelive using `require('[implementation]').registerProtocols(tilelive);`.
 
-        // For server backends.
-        // Serve a tile, grid, or other resource. The `callback` function
-        // should be called with `callback(err, data)` where `data` is an array
-        // such that `data[0]` is suitable as a response body and `data[1]`
-        // contains a hash of HTTP headers that describe the data.
-        serve: function(resource, options, callback) {},
+* `tilelive.list(source, callback)`: Lists all tilesets in a directory. `source` is a folder that is used by registered implementations to search for individual tilesets. `callback` receives an error object (or `null`) and a hash hash with keys being Tilestore IDs and values being Tilestore URIs. Example:
 
-        // For storage backends.
-        // Store tiles, grids, or perform other tasks related to batch tile
-        // generation. Steps called include: setup, metadata, tiles, grids,
-        // and finish.
-        setup: function(step, resource, data, callback) {}
-    }
+```javascript
+{
+    "world-light": "mbtiles:///path/to/file/world-light.mbtiles",
+    "mapquest": "tilejson:///path/to/file/mapquest.tilejson"
+}
+```
 
-To use tilelive to serve tiles from mbtiles install [mbtiles](http://github.com/mapbox/node-mbtiles). To serve dynamically rendered tiles using mapnik install [tilelive-mapnik](http://github.com/mapbox/tilelive-mapnik). To render tiles using mapnik and store them in the mbtiles format, install both.
+* `tilelive.findID(source, id, callback)`: Looks for a particular tileset ID in a directory. `callback` receives an error object (or `null`) and the URI of the tileset.
 
-## Install
 
-Install master:
+* `tilelive.load(uri, callback)`: Loads the Tilestore object associated with the specified `uri`. `callback` receives an error object (or `null`) and the Tilestore object.
 
-    git clone git://github.com/mapbox/tilelive.js.git tilelive
-    cd tilelive
-    npm install .
+* `tilelive.info(uri, callback)`: Loads the Tilestore object associated with the specified `uri` and retrieves its metadata in a [TileJSON](http://github.com/mapbox/tilejson) compliant format. `callback` receives an error object (or `null`), the metadata hash and the Tilestore object.
 
-Or install latest release via npm repositories:
+* `tilelive.all(source, callback)`: Loads metadata in a [TileJSON](http://github.com/mapbox/tilejson) compliant format for all tilesets in the `source` directory. `callback` receives an error object (or `null`) and an array with TileJSON metadata about each tileset in that directory.
 
-    npm install tilelive
 
-## tilebatch
+* `tilelive.verify(tilejson)`: Validates a TileJSON object and returns error objects for invalid entries.
 
-tilelive can be used to create `mbtiles` files or possibly other formats using the `tilebatch` command.
+* `tilelive.copy(args, callback)`: Copies data from one tilestore into another tilestore. `args` is a configuration hash with these keys:
 
-    tilebatch <datasource> <filepath>
+  * `source`: a Tilestore object that implements the Tilesource interface
+  * `sink`: a Tilestore object that implements the Tilesink interface
+  * `bbox`: an array with W/S/E/N boundaries in WGS84 format (-180...180, -90...90)
+  * `minZoom`: the minimum zoom for data to be copied (inclusive)
+  * `maxZoom`: the maximum zoom for data to be copied (inclusive)
+  * `concurrency`: (default: `100`) how many data objects should be copied simultaneously.
+  * `callback`: (optional) called when copying is complete
+  * `tiles`: copy tiles (`true` or `false`)
+  * `grids`: copy grids (`true` or `false`)
 
-For a full list of options, run `tilebatch --help`.
+  This function returns an EventEmitter that has these events emitted:
 
+  * `warning`: An error occurred during copying. `err` is the first argument.
+  * `error`: An error occured while initializing the tilesource/tilesink.
+  * `finished`: Copying completed
+
+  The EventEmitter also has these properties. They are updated continuously while copying. Check them occassionally to report status to the user.
+
+  * `copied`: Number of elements that have been copied so far
+  * `failed`: Number of elements that couldn't be copied.
+  * `total`: Total number of elements to be copied.
+  * `started`: Timestamp of when the action started in milliseconds after epoch
+
+## bin/tilelive
+
+tilelive can be used to copy data between tilestores. For a full list of options, run `bin/tilelive`.
+
 ## Tests
@@ -71,7 +77,15 @@
 
-# 3.0.0
+## 4.0.0
 
+* Updated to use Tilestore/Tilesink/Tilesource interface
+* Uses the TileJSON format internally
+* Switched to Tilestore URIs
+* Interfaces updated to XYZ. Order of parameters is now z, x, y
+* Added copy command
+
+## 3.0.0
+
 Split out `tilelive-mapnik`, `mbtiles` backends.
 
-# 2.0.3
+## 2.0.3
 
@@ -84,11 +98,11 @@ This release is all distribution fixes:
 
-# 2.0.2
+## 2.0.2
 
 * Now uses and requires node-mapnik 0.3.0
 
-# 2.0.1
+## 2.0.1
 
 Minor release: adds `Pool` argument to `Tile.getMap()`, to let users dispose of used maps.
 
-# 2.0.0
+## 2.0.0
 
@@ -100,3 +114,3 @@ * `node-sqlite3` replaces `node-sqlite` for better performance and stability.
 
-# 1.1.0
+## 1.1.0
 
@@ -103,0 +117,0 @@ * Tiles no longer accept `tile` as a scheme. TMS or XYZ are required; TMS is default.

New alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3656163

increased by11510.92%

Number of package files

27

increased by107.69%

Lines of code

4432

increased by677.54%

Number of lines in readme file

117

increased by13.59%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dependency count

5

increased by25%

Dev dependency count

5

increased by66.67%

Number of low license alerts

1

increased byInfinity%

License quality

80

decreased by-20%

Number of medium supply chain risk alerts

9

increased by800%

Dependency changes

• + Addedsphericalmercator@1.0.0

• + Addedsphericalmercator@1.0.0(transitive)