Merge pull request #100 from mapbox/readme_cleanup

sheindel · web-flow · commit 05fd55dd959d · 2023-08-21T08:55:02.000-04:00
Readme cleanup, final API state
diff --git a/.gitignore b/.gitignore
@@ -1 +1,6 @@
 shpwrite.js
+node_modules
+example/*.dbf
+example/*.shp
+example/*.shx
+yarn.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+
+
+<a name="0.4.0"></a>
+## [0.4.0](https://github.com/mapbox/shp-write/compare/v0.3.2...v0.4.0) (2023-08-20)
+
+* Upgrade JSZip and dbf dependencies
+* Added types
+* Added options for compression and type output to `zip` and `download`
+* Added deprecation warning to `download` (not needed for this library)
+* 
+
 <a name="0.3.2"></a>
 ## [0.3.2](https://github.com/mapbox/shp-write/compare/v0.3.1...v0.3.2) (2016-12-06)
 
diff --git a/README.md b/README.md
@@ -29,20 +29,56 @@ Or in a browser
 ```js
 var shpwrite = require("shp-write");
 
-// (minimal) set names for feature types and zipped folder
-var options = {
-  folder: "myshapes",
-  filename: "mydownload",
-  outputType: "base64",
+// a GeoJSON bridge for features
+const zipData = shpwrite.zip(
+  {
+    type: "FeatureCollection",
+    features: [
+      {
+        type: "Feature",
+        geometry: {
+          type: "Point",
+          coordinates: [0, 0],
+        },
+        properties: {
+          name: "Foo",
+        },
+      },
+      {
+        type: "Feature",
+        geometry: {
+          type: "Point",
+          coordinates: [0, 10],
+        },
+        properties: {
+          name: "Bar",
+        },
+      },
+    ],
+  }
+);
+
+```
+
+## Options Example
+
+```js
+var shpwrite = require("shp-write");
+
+const options = {
+  folder: "my_internal_shapes_folder",
+  filename: "my_zip_filename",
+  outputType: "blob",
   compression: "DEFLATE",
   types: {
     point: "mypoints",
     polygon: "mypolygons",
     line: "mylines",
   },
 };
+
 // a GeoJSON bridge for features
-shpwrite.download(
+const zipData = shpwrite.zip(
   {
     type: "FeatureCollection",
     features: [
@@ -70,7 +106,6 @@ shpwrite.download(
   },
   options
 );
-// triggers a download of a zip file with shapefiles contained within.
 ```
 
 ## API
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -19,7 +19,7 @@ declare module "shp-write" {
   export interface DownloadOptions {
     folder?: string;
     filename?: string;
-    types: {
+    types?: {
       point?: string;
       polygon?: string;
       line?: string;
@@ -48,19 +48,9 @@ declare module "shp-write" {
     outputType: OutputType
   }
 
-  DEFAULT_ZIP_OPTIONS = {
-    compression: 'STORE',
-    outputType: 'base64',
-    types: {
-      point: "mypoints",
-      polygon: "mypolygons",
-      line: "mylines",
-    },
-  };
-
   export function download(
     geojson: GeoJSON.FeatureCollection,
-    options?: DownloadOptions & ZipOptions = DEFAULT_ZIP_OPTIONS
+    options?: DownloadOptions & ZipOptions = {}
   ): void;
 
   export function write(
@@ -79,6 +69,6 @@ declare module "shp-write" {
 
   export function zip<T extends OutputType>(
     geojson: GeoJSON.FeatureCollection,
-    options: DownloadOptions & ZipOptions = DEFAULT_ZIP_OPTIONS,
+    options: DownloadOptions & ZipOptions = {},
     stream = false): Promise<OutputByType[T]>;
 }
diff --git a/example/point.js b/example/point.js
@@ -26,7 +26,7 @@ function finish(err, files) {
 }
 
 function toBuffer(ab) {
-    var buffer = new Buffer(ab.byteLength),
+    var buffer = Buffer.alloc(ab.byteLength),
         view = new Uint8Array(ab);
     for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }
     return buffer;
diff --git a/example/test.js b/example/test.js
@@ -27,7 +27,7 @@ function finish(err, files) {
 }
 
 function toBuffer(ab) {
-    var buffer = new Buffer(ab.byteLength),
+    var buffer = Buffer.alloc(ab.byteLength),
         view = new Uint8Array(ab);
     for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }
     return buffer;
diff --git a/example/test_linestring.js b/example/test_linestring.js
@@ -24,7 +24,7 @@ function finish(err, files) {
 }
 
 function toBuffer(ab) {
-    var buffer = new Buffer(ab.byteLength),
+    var buffer = Buffer.alloc(ab.byteLength),
         view = new Uint8Array(ab);
     for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }
     return buffer;
diff --git a/example/test_multiple_poly.js b/example/test_multiple_poly.js
@@ -22,7 +22,7 @@ function finish(err, files) {
 }
 
 function toBuffer(ab) {
-    var buffer = new Buffer(ab.byteLength),
+    var buffer = Buffer.alloc(ab.byteLength),
         view = new Uint8Array(ab);
     for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }
     return buffer;
diff --git a/example/test_polygon.js b/example/test_polygon.js
@@ -25,7 +25,7 @@ function finish(err, files) {
 }
 
 function toBuffer(ab) {
-    var buffer = new Buffer(ab.byteLength),
+    var buffer = Buffer.alloc(ab.byteLength),
         view = new Uint8Array(ab);
     for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }
     return buffer;
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "shp-write",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "write shapefiles from pure javascript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
diff --git a/src/download.js b/src/download.js
@@ -5,18 +5,7 @@ var saveAs = require("file-saver").saveAs;
  * @deprecated may be removed in a future version, please use an external 
  * download library
  */
-module.exports = function (
-    gj, 
-    options = {
-      compression: 'STORE',
-      outputType: 'base64',
-      types: {
-        point: "mypoints",
-        polygon: "mypolygons",
-        line: "mylines",
-      },
-    },
-) {
+module.exports = function (gj, options) {
   let filename = 'download';
 
   // since we only need a single filename object, we can use either the folder or
diff --git a/src/zip.js b/src/zip.js
@@ -5,19 +5,14 @@ var write = require("./write"),
 
 module.exports = function (
   gj,
-  options = {
-    compression: 'STORE',
-    outputType: 'base64',
-    types: {
-      point: "mypoints",
-      polygon: "mypolygons",
-      line: "mylines",
-    },
-  },
+  options,
   stream = false
 ) {
-  var zip = new JSZip(),
-    layers = zip.folder(options && options.folder ? options.folder : "layers");
+  let zip = new JSZip();
+  let zipTarget = zip;
+  if (options && options.folder) {
+    zipTarget = zip.folder(options.folder);
+  }
 
   [
     geojson.point(gj),
@@ -36,30 +31,34 @@ module.exports = function (
         l.geometries,
         function (err, files) {
           var fileName =
-            options && options.types[l.type.toLowerCase()]
+            options && options.types && options.types[l.type.toLowerCase()]
               ? options.types[l.type.toLowerCase()]
               : l.type;
-          layers.file(fileName + ".shp", files.shp.buffer, { binary: true });
-          layers.file(fileName + ".shx", files.shx.buffer, { binary: true });
-          layers.file(fileName + ".dbf", files.dbf.buffer, { binary: true });
-          layers.file(fileName + ".prj", prj);
+          zipTarget.file(fileName + ".shp", files.shp.buffer, { binary: true });
+          zipTarget.file(fileName + ".shx", files.shx.buffer, { binary: true });
+          zipTarget.file(fileName + ".dbf", files.dbf.buffer, { binary: true });
+          zipTarget.file(fileName + ".prj", prj);
         }
       );
     }
   });
 
-  var generateOptions = {};
-  if (options && options.outputType) {
-    generateOptions.type = options.outputType;
+  var zipOptions = {};
+  if (!options || !options.outputType) {
+    zipOptions.type = "base64";
+  } else {
+    zipOptions.type = options.outputType;
   }
 
-  if (options && options.compresssion) {
-    generateOptions.compression = options.compression;
+  if (!options || !options.compression) {
+    zipOptions.compression = "DEFLATE";
+  } else {
+    zipOptions.compression = options.compression;
   }
 
   if (stream) {
-    return zip.generateNodeStream({ ...generateOptions, streamFiles: true });
+    return zip.generateNodeStream({ ...zipOptions, streamFiles: true });
   }
 
-  return zip.generateAsync(generateOptions);
+  return zip.generateAsync(zipOptions);
 };

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ function finish(err, files) {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`function toBuffer(ab) {`
`29`		`- var buffer = new Buffer(ab.byteLength),`
	`29`	`+ var buffer = Buffer.alloc(ab.byteLength),`
`30`	`30`	`view = new Uint8Array(ab);`
`31`	`31`	`for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }`
`32`	`32`	`return buffer;`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ function finish(err, files) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`function toBuffer(ab) {`
`30`		`- var buffer = new Buffer(ab.byteLength),`
	`30`	`+ var buffer = Buffer.alloc(ab.byteLength),`
`31`	`31`	`view = new Uint8Array(ab);`
`32`	`32`	`for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }`
`33`	`33`	`return buffer;`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ function finish(err, files) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`function toBuffer(ab) {`
`27`		`- var buffer = new Buffer(ab.byteLength),`
	`27`	`+ var buffer = Buffer.alloc(ab.byteLength),`
`28`	`28`	`view = new Uint8Array(ab);`
`29`	`29`	`for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }`
`30`	`30`	`return buffer;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ function finish(err, files) {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`function toBuffer(ab) {`
`25`		`- var buffer = new Buffer(ab.byteLength),`
	`25`	`+ var buffer = Buffer.alloc(ab.byteLength),`
`26`	`26`	`view = new Uint8Array(ab);`
`27`	`27`	`for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }`
`28`	`28`	`return buffer;`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ function finish(err, files) {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`function toBuffer(ab) {`
`28`		`- var buffer = new Buffer(ab.byteLength),`
	`28`	`+ var buffer = Buffer.alloc(ab.byteLength),`
`29`	`29`	`view = new Uint8Array(ab);`
`30`	`30`	`for (var i = 0; i < buffer.length; ++i) { buffer[i] = view[i]; }`
`31`	`31`	`return buffer;`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "shp-write",`
`3`		`- "version": "0.3.2",`
	`3`	`+ "version": "0.4.0",`
`4`	`4`	`"description": "write shapefiles from pure javascript",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"types": "dist/index.d.ts",`