coastlines 0.0.3-alpha.0 → 0.0.5-alpha.0

package/LICENSE

@@ -19,3 +19,11 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+---
+
+The code and documentation are MIT, above. The data ships under its own
+terms, unchanged: Natural Earth is public domain; the GSHHG shoreline is
+LGPL-3.0-or-later, with its copyright and permission notice at
+data/gshhg-licence.txt and the licence text at data/gshhg-copying-lesser.txt.
+The package's SPDX expression, `MIT AND LGPL-3.0-or-later`, names both.

package/README.md

@@ -20,7 +20,16 @@ const world = JSON.parse(await readFile(localUrl(entry), 'utf8'))
 ```
 
 The subpath `coastlines/data/<id>` resolves to the `.geojson` file for any
-tool that can load one; `manifest.json` and `charts.json` are plain JSON.
+tool that can load one; `manifest.json` and `charts.json` are plain JSON. A
+file in another format carries its extension, `coastlines/data/gshhg-land-h.shp`,
+and `shapefilePolygons` from the package reads it:
+
+```js
+import { find, localUrl, shapefilePolygons } from 'coastlines'
+
+const land = find('gshhg-land-h')               // { source: 'gshhg', format: 'shp', … }
+const polygons = shapefilePolygons(await readFile(localUrl(land)))  // 144,749 of [outerRing]
+```
 
 **See it:** [the basemap on GitHub Pages](https://mark-brannan.github.io/coastlines/),
 the three default charts, drawn with the styles the plugin will serve.
@@ -45,9 +54,12 @@ draws.
 
 ## The catalogue
 
-33 files. Every 50m and 110m file in the marine catalogue, and at 10m the
-coastline, the land and every other file that fits a 5 MB response body.
-The rest of 10m and the bathymetry set belong to companion packages.
+36 files from two sources. From Natural Earth, every 50m and 110m file in
+the marine catalogue, and at 10m the coastline, the land and every other file
+that fits a 5 MB response body; the rest of 10m and the bathymetry set belong
+to companion packages. From GSHHG 2.3.7, the "h" land polygons, the next rung
+of coastline above Natural Earth's 10m (vertex spacing median 707 m), as the
+published shapefile, with the two licence notices that travel with it.
 
 <!-- catalogue:start -->
 | Import `coastlines/data/…` | Layer | Scale | Geometry | Raw | Why a boat wants it |
@@ -70,6 +82,7 @@ The rest of 10m and the bathymetry set belong to companion packages.
 | `ne-admin-0-boundary-lines-maritime-indicator-50m` | admin_0_boundary_lines_maritime_indicator | 50m | lines | 193 KB | The maritime boundaries Natural Earth draws |
 | `ne-admin-0-countries-50m` | admin_0_countries | 50m | polygons | 2.9 MB | Courtesy flag, VHF scheme, customs |
 | `ne-populated-places-50m` | populated_places | 50m | points | 3.2 MB | Labels |
+| `ne-urban-areas-50m` | urban_areas | 50m | polygons | 1.2 MB | Built-up footprints of cities |
 | `ne-lakes-50m` | lakes | 50m | polygons | 855 KB | Inland context |
 | `ne-rivers-lake-centerlines-50m` | rivers_lake_centerlines | 50m | lines | 808 KB | Inland context |
 | `ne-glaciated-areas-50m` | glaciated_areas | 50m | polygons | 500 KB | Polar context |
@@ -85,17 +98,33 @@ The rest of 10m and the bathymetry set belong to companion packages.
 | `ne-admin-0-disputed-areas-10m` | admin_0_disputed_areas | 10m | polygons | 685 KB | Honesty on the borders layer |
 | `ne-ports-10m` | ports | 10m | points | 273 KB | Harbours |
 | `ne-antarctic-ice-shelves-polys-10m` | antarctic_ice_shelves_polys | 10m | polygons | 548 KB | Polar context |
+| `gshhg-land-h.shp` | land | h | polygons | 32.5 MB | Land, the GSHHS shoreline at high resolution; 144,749 polygons |
+| `gshhg-licence.txt` | — | — | — | 1 KB | The GSHHG copyright and permission notice; travels with every copy |
+| `gshhg-copying-lesser.txt` | — | — | — | 8 KB | The GNU Lesser General Public License, version 3 |
 <!-- catalogue:end -->
 
 ![Every file, rendered equirectangular](docs/layers.png)
 
 Ids follow the file: `ne-<layer>-<scale>` is `ne_<scale>_<layer>.geojson` in
-the Natural Earth tree. `coastlines/manifest.json` is the machine-readable
-form of this table, with the bytes and sha256 of each file.
+the Natural Earth tree; `gshhg-land-h` is `GSHHS_shp/h/GSHHS_h_L1.shp` inside
+the GSHHG zip. `coastlines/manifest.json` is the machine-readable form of this
+table, with the bytes and sha256 of each file and, under `sources`, of the
+zip itself.
+
+### Sources and licences
+
+Natural Earth is public domain. GSHHG (Wessel & Smith, the Global
+Self-consistent, Hierarchical, High-resolution Geography database) is
+LGPL-3.0-or-later with a permission notice that asks for the copyright and
+permission notice to appear in all copies; both ship unchanged as
+`data/gshhg-licence.txt` and `data/gshhg-copying-lesser.txt`, pinned like the
+data. Cite: Wessel, P., and W. H. F. Smith, A global, self-consistent,
+hierarchical, high-resolution shoreline database, _J. Geophys. Res._, 101(B4),
+8741–8743, 1996.
 
 ## The charts
 
-A plotter does not want 33 files; it wants a basemap to tick. `charts.json`
+A plotter does not want 36 files; it wants a basemap to tick. `charts.json`
 groups the files into three charts, each at one scale, and gives every layer
 its zoom range. `styles/<chart>.json` is a Mapbox style, hand-written, one
 per chart; the demo draws it over GeoJSON sources, and the plugin will serve
@@ -112,14 +141,14 @@ consumer written against one chart reads any.
 
 ## Provenance, and checking rather than trusting
 
-`data/` is not in git. `npm run sync` fetches each file from the pinned
+`data/` is not in git. `npm run sync` fetches each file from its pinned
 release and refuses any byte that disagrees with `manifest.json`; `npm pack`
 runs it first, so a tarball never ships a file the manifest did not promise.
 
 ```shell
-npm run sync          # fetch what is missing, verify everything (45 MB, ~15 s)
+npm run sync          # fetch what is missing, verify everything (45 MB + 149 MB zip)
 npm run sync:check    # verify only, no network
-npm run sync:refresh  # move the pin: refetch all and rewrite bytes and sha256
+npm run sync:refresh  # move the pins: refetch all and rewrite bytes and sha256
 ```
 
 To check a published tarball against Natural Earth yourself:
@@ -136,4 +165,8 @@ permission needed, no attribution required. Credited anyway:
 
 > Made with Natural Earth. Free vector and raster map data @ naturalearthdata.com
 
+The GSHHG shoreline is [LGPL-3.0-or-later][gshhg]; its notices ship beside it
+([Sources and licences](#sources-and-licences)).
+
 [ne]: https://www.naturalearthdata.com/
+[gshhg]: https://www.soest.hawaii.edu/pwessel/gshhg/

package/charts.json

@@ -10,9 +10,24 @@
       { "id": "ne-land-110m", "name": "land", "minzoom": 0, "maxzoom": 4 },
       { "id": "ne-glaciated-areas-110m", "name": "glaciated_areas", "minzoom": 2, "maxzoom": 4 },
       { "id": "ne-lakes-110m", "name": "lakes", "minzoom": 2, "maxzoom": 4 },
-      { "id": "ne-rivers-lake-centerlines-110m", "name": "rivers_lake_centerlines", "minzoom": 3, "maxzoom": 4 },
-      { "id": "ne-admin-0-countries-110m", "name": "admin_0_countries", "minzoom": 2, "maxzoom": 4 },
-      { "id": "ne-admin-0-boundary-lines-land-110m", "name": "admin_0_boundary_lines_land", "minzoom": 1, "maxzoom": 4 },
+      {
+        "id": "ne-rivers-lake-centerlines-110m",
+        "name": "rivers_lake_centerlines",
+        "minzoom": 3,
+        "maxzoom": 4
+      },
+      {
+        "id": "ne-admin-0-countries-110m",
+        "name": "admin_0_countries",
+        "minzoom": 2,
+        "maxzoom": 4
+      },
+      {
+        "id": "ne-admin-0-boundary-lines-land-110m",
+        "name": "admin_0_boundary_lines_land",
+        "minzoom": 1,
+        "maxzoom": 4
+      },
       { "id": "ne-coastline-110m", "name": "coastline", "minzoom": 0, "maxzoom": 4 },
       { "id": "ne-geographic-lines-110m", "name": "geographic_lines", "minzoom": 0, "maxzoom": 4 },
       { "id": "ne-populated-places-110m", "name": "populated_places", "minzoom": 2, "maxzoom": 4 }
@@ -27,13 +42,33 @@
     "layers": [
       { "id": "ne-ocean-50m", "name": "ocean", "minzoom": 0, "maxzoom": 7 },
       { "id": "ne-land-50m", "name": "land", "minzoom": 0, "maxzoom": 7 },
-      { "id": "ne-antarctic-ice-shelves-polys-50m", "name": "antarctic_ice_shelves_polys", "minzoom": 2, "maxzoom": 7 },
+      {
+        "id": "ne-antarctic-ice-shelves-polys-50m",
+        "name": "antarctic_ice_shelves_polys",
+        "minzoom": 2,
+        "maxzoom": 7
+      },
       { "id": "ne-glaciated-areas-50m", "name": "glaciated_areas", "minzoom": 3, "maxzoom": 7 },
       { "id": "ne-lakes-50m", "name": "lakes", "minzoom": 3, "maxzoom": 7 },
-      { "id": "ne-rivers-lake-centerlines-50m", "name": "rivers_lake_centerlines", "minzoom": 4, "maxzoom": 7 },
+      {
+        "id": "ne-rivers-lake-centerlines-50m",
+        "name": "rivers_lake_centerlines",
+        "minzoom": 4,
+        "maxzoom": 7
+      },
       { "id": "ne-admin-0-countries-50m", "name": "admin_0_countries", "minzoom": 3, "maxzoom": 7 },
-      { "id": "ne-admin-0-boundary-lines-land-50m", "name": "admin_0_boundary_lines_land", "minzoom": 2, "maxzoom": 7 },
-      { "id": "ne-admin-0-boundary-lines-maritime-indicator-50m", "name": "admin_0_boundary_lines_maritime_indicator", "minzoom": 3, "maxzoom": 7 },
+      {
+        "id": "ne-admin-0-boundary-lines-land-50m",
+        "name": "admin_0_boundary_lines_land",
+        "minzoom": 2,
+        "maxzoom": 7
+      },
+      {
+        "id": "ne-admin-0-boundary-lines-maritime-indicator-50m",
+        "name": "admin_0_boundary_lines_maritime_indicator",
+        "minzoom": 3,
+        "maxzoom": 7
+      },
       { "id": "ne-coastline-50m", "name": "coastline", "minzoom": 0, "maxzoom": 7 },
       { "id": "ne-geographic-lines-50m", "name": "geographic_lines", "minzoom": 0, "maxzoom": 7 },
       { "id": "ne-populated-places-50m", "name": "populated_places", "minzoom": 3, "maxzoom": 7 }
@@ -45,8 +80,6 @@
     "description": "The finest coastline alone, to zoom 12, the layer a distance-to-shore reads",
     "minzoom": 0,
     "maxzoom": 12,
-    "layers": [
-      { "id": "ne-coastline-10m", "name": "coastline", "minzoom": 0, "maxzoom": 12 }
-    ]
+    "layers": [{ "id": "ne-coastline-10m", "name": "coastline", "minzoom": 0, "maxzoom": 12 }]
   }
 ]

package/data/gshhg-copying-lesser.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/data/gshhg-land-h.shp

@@ -0,0 +1,4 @@
+[diffend] Oversized file quarantined before diffing.
+name: package/data/gshhg-land-h.shp
+size: 34129516 bytes
+sha256: d870bdbc90a074f87a8c09a9630abb5f18916314b9a196dba2e6866fd51ef325

package/data/gshhg-licence.txt

@@ -0,0 +1,23 @@
+$LastChangedDate: 2013-11-24 09:26:07 -1000 (Sun, 24 Nov 2013) $
+$Revision: 594 $
+
+As of GSHHG 2.2.2, GSHHG is distributed under the GNU Lesser General Public
+License (LGPL) version 3 or later. Copies of the The GNU General Public
+License (GPL) and the GNU Lesser General Public License (LGPL) are
+distributed along with the sources. Refer to the files COPYINGv3 and
+COPYING.LESSERv3.
+
+Permission to use, copy, modify, and distribute (with no more than a
+reasonable redistribution fee) this data and its documentation for
+any purpose is hereby granted, provided that the above copyright notice
+appear in all copies, that both that copyright notice and this
+permission notice appear in supporting documentation, and that the name
+of GSHHG not be used in advertising or publicity pertaining to
+distribution of the software without specific, written prior permission.
+ The GSHHG package may be included in a bundled distribution of software
+for which a fee may be charged. The University of Hawaii (UH) and the
+National Oceanic and Atmospheric Administration (NOAA) make no
+representations about the suitability of this software for any purpose. 
+It is provided "as is" without expressed or implied warranty.  It is
+provided with no support and without obligation on the part of UH or
+NOAA, to assist in its use, correction, modification, or enhancement.