styled-map-package 2.2.0 → 3.0.0

package/bin/smp-download.js

@@ -4,9 +4,9 @@ import { input, number } from '@inquirer/prompts'
 import fs from 'fs'
 import { pipeline } from 'stream/promises'
 
-import download from '../lib/download.js'
-import { ttyReporter } from '../lib/reporters.js'
-import { isMapboxURL, API_URL as MAPBOX_API_URL } from '../lib/utils/mapbox.js'
+import { download } from '../dist/download.js'
+import { ttyReporter } from '../dist/reporters.js'
+import { isMapboxURL, API_URL as MAPBOX_API_URL } from '../dist/utils/mapbox.js'
 
 const program = new Command()
 

package/bin/smp-mbtiles.js

@@ -2,7 +2,7 @@
 import { Command } from 'commander'
 import { pipeline } from 'stream/promises'
 
-import fromMBTiles from '../lib/from-mbtiles.js'
+import { fromMBTiles } from '../dist/from-mbtiles.js'
 
 const program = new Command()
 

package/bin/smp-view.js

@@ -6,7 +6,7 @@ import openApp from 'open'
 
 import path from 'node:path'
 
-import smpServer from '../lib/server.js'
+import { createServer } from '../dist/server.js'
 
 const program = new Command()
 
@@ -45,7 +45,7 @@ function serve({ port = 3000, filepath }) {
     return reply.sendFile('index.html')
   })
 
-  server.register(smpServer, {
+  server.register(createServer, {
     filepath: path.relative(process.cwd(), filepath),
     prefix: '/map',
   })

package/dist/download.cjs

@@ -0,0 +1,101 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var download_exports = {};
+__export(download_exports, {
+  download: () => download
+});
+module.exports = __toCommonJS(download_exports);
+var import_readable_stream = require("readable-stream");
+var import_promises = require("stream/promises");
+var import_style_downloader = require('./style-downloader.cjs');
+var import_writer = require('./writer.cjs');
+function download({ bbox, maxzoom, styleUrl, onprogress, accessToken }) {
+  const downloader = new import_style_downloader.StyleDownloader(styleUrl, {
+    concurrency: 24,
+    mapboxAccessToken: accessToken
+  });
+  let start = Date.now();
+  let progress = {
+    tiles: { downloaded: 0, totalBytes: 0, total: 0, skipped: 0, done: false },
+    style: { done: false },
+    sprites: { downloaded: 0, done: false },
+    glyphs: { downloaded: 0, total: 0, totalBytes: 0, done: false },
+    output: { totalBytes: 0, done: false },
+    elapsedMs: 0
+  };
+  const sizeCounter = new import_readable_stream.Transform({
+    transform(chunk, encoding, cb) {
+      handleProgress({
+        output: {
+          totalBytes: progress.output.totalBytes + chunk.length,
+          done: false
+        }
+      });
+      cb(null, chunk);
+    },
+    final(cb) {
+      handleProgress({ output: { ...progress.output, done: true } });
+      cb();
+    }
+  });
+  function handleProgress(update) {
+    progress = { ...progress, ...update, elapsedMs: Date.now() - start };
+    onprogress?.(progress);
+  }
+  ;
+  (async () => {
+    const style = await downloader.getStyle();
+    const writer = new import_writer.Writer(style);
+    handleProgress({ style: { done: true } });
+    writer.outputStream.pipe(sizeCounter);
+    writer.on("error", (err) => sizeCounter.destroy(err));
+    try {
+      for await (const spriteInfo of downloader.getSprites()) {
+        await writer.addSprite(spriteInfo);
+        handleProgress({
+          sprites: { downloaded: progress.sprites.downloaded + 1, done: false }
+        });
+      }
+      handleProgress({ sprites: { ...progress.sprites, done: true } });
+      const tiles = downloader.getTiles({
+        bounds: bbox,
+        maxzoom,
+        onprogress: (tileStats) => handleProgress({ tiles: { ...tileStats, done: false } })
+      });
+      await (0, import_promises.pipeline)(tiles, writer.createTileWriteStream({ concurrency: 24 }));
+      handleProgress({ tiles: { ...progress.tiles, done: true } });
+      const glyphs = downloader.getGlyphs({
+        onprogress: (glyphStats) => handleProgress({ glyphs: { ...glyphStats, done: false } })
+      });
+      await (0, import_promises.pipeline)(glyphs, writer.createGlyphWriteStream());
+      handleProgress({ glyphs: { ...progress.glyphs, done: true } });
+      writer.finish();
+    } catch (err) {
+      writer.outputStream.destroy(
+        /** @type {Error} */
+        err
+      );
+    }
+  })();
+  return sizeCounter;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  download
+});

package/dist/download.d.cts

@@ -0,0 +1,65 @@
+import { GlyphDownloadStats } from './style-downloader.cjs';
+import { TileDownloadStats } from './tile-downloader.cjs';
+import { D as DownloadStream } from './types-B4Xn1F9K.cjs';
+import { BBox } from './utils/geo.cjs';
+import 'ky';
+import 'stream';
+import '@maplibre/maplibre-gl-style-spec';
+import './utils/fetch.cjs';
+import './utils/streams.cjs';
+import 'readable-stream';
+import 'geojson';
+import 'type-fest';
+import 'events';
+
+/**
+ * @typedef {object} DownloadProgress
+ * @property {import('./tile-downloader.js').TileDownloadStats & { done: boolean }} tiles
+ * @property {{ done: boolean }} style
+ * @property {{ downloaded: number, done: boolean }} sprites
+ * @property {import('./style-downloader.js').GlyphDownloadStats & { done: boolean }} glyphs
+ * @property {{ totalBytes: number, done: boolean }} output
+ * @property {number} elapsedMs
+ */
+/**
+ * Download a map style and its resources for a given bounding box and max zoom
+ * level. Returns a readable stream of a "styled map package", a zip file
+ * containing all the resources needed to serve the style offline.
+ *
+ * @param {object} opts
+ * @param {import("./utils/geo.js").BBox} opts.bbox Bounding box to download tiles for
+ * @param {number} opts.maxzoom Max zoom level to download tiles for
+ * @param {string} opts.styleUrl URL of the style to download
+ * @param { (progress: DownloadProgress) => void } [opts.onprogress] Optional callback for reporting progress
+ * @param {string} [opts.accessToken]
+ * @returns {import('./types.js').DownloadStream} Readable stream of the output styled map file
+ */
+declare function download({ bbox, maxzoom, styleUrl, onprogress, accessToken }: {
+    bbox: BBox;
+    maxzoom: number;
+    styleUrl: string;
+    onprogress?: ((progress: DownloadProgress) => void) | undefined;
+    accessToken?: string | undefined;
+}): DownloadStream;
+type DownloadProgress = {
+    tiles: TileDownloadStats & {
+        done: boolean;
+    };
+    style: {
+        done: boolean;
+    };
+    sprites: {
+        downloaded: number;
+        done: boolean;
+    };
+    glyphs: GlyphDownloadStats & {
+        done: boolean;
+    };
+    output: {
+        totalBytes: number;
+        done: boolean;
+    };
+    elapsedMs: number;
+};
+
+export { type DownloadProgress, download };

package/dist/{lib/download.d.ts → download.d.ts}

@@ -1,3 +1,17 @@
+import { GlyphDownloadStats } from './style-downloader.js';
+import { TileDownloadStats } from './tile-downloader.js';
+import { D as DownloadStream } from './types-B4Xn1F9K.js';
+import { BBox } from './utils/geo.js';
+import 'ky';
+import 'stream';
+import '@maplibre/maplibre-gl-style-spec';
+import './utils/fetch.js';
+import './utils/streams.js';
+import 'readable-stream';
+import 'geojson';
+import 'type-fest';
+import 'events';
+
 /**
  * @typedef {object} DownloadProgress
  * @property {import('./tile-downloader.js').TileDownloadStats & { done: boolean }} tiles
@@ -20,15 +34,15 @@
  * @param {string} [opts.accessToken]
  * @returns {import('./types.js').DownloadStream} Readable stream of the output styled map file
  */
-export default function download({ bbox, maxzoom, styleUrl, onprogress, accessToken, }: {
-    bbox: import("./utils/geo.js").BBox;
+declare function download({ bbox, maxzoom, styleUrl, onprogress, accessToken }: {
+    bbox: BBox;
     maxzoom: number;
     styleUrl: string;
     onprogress?: ((progress: DownloadProgress) => void) | undefined;
     accessToken?: string | undefined;
-}): import("./types.js").DownloadStream;
-export type DownloadProgress = {
-    tiles: import("./tile-downloader.js").TileDownloadStats & {
+}): DownloadStream;
+type DownloadProgress = {
+    tiles: TileDownloadStats & {
         done: boolean;
     };
     style: {
@@ -38,7 +52,7 @@ export type DownloadProgress = {
         downloaded: number;
         done: boolean;
     };
-    glyphs: import("./style-downloader.js").GlyphDownloadStats & {
+    glyphs: GlyphDownloadStats & {
         done: boolean;
     };
     output: {
@@ -47,3 +61,5 @@ export type DownloadProgress = {
     };
     elapsedMs: number;
 };
+
+export { type DownloadProgress, download };

package/dist/download.js

@@ -0,0 +1,77 @@
+import { Transform } from "readable-stream";
+import { pipeline } from "stream/promises";
+import { StyleDownloader } from "./style-downloader.js";
+import { Writer } from "./writer.js";
+function download({ bbox, maxzoom, styleUrl, onprogress, accessToken }) {
+  const downloader = new StyleDownloader(styleUrl, {
+    concurrency: 24,
+    mapboxAccessToken: accessToken
+  });
+  let start = Date.now();
+  let progress = {
+    tiles: { downloaded: 0, totalBytes: 0, total: 0, skipped: 0, done: false },
+    style: { done: false },
+    sprites: { downloaded: 0, done: false },
+    glyphs: { downloaded: 0, total: 0, totalBytes: 0, done: false },
+    output: { totalBytes: 0, done: false },
+    elapsedMs: 0
+  };
+  const sizeCounter = new Transform({
+    transform(chunk, encoding, cb) {
+      handleProgress({
+        output: {
+          totalBytes: progress.output.totalBytes + chunk.length,
+          done: false
+        }
+      });
+      cb(null, chunk);
+    },
+    final(cb) {
+      handleProgress({ output: { ...progress.output, done: true } });
+      cb();
+    }
+  });
+  function handleProgress(update) {
+    progress = { ...progress, ...update, elapsedMs: Date.now() - start };
+    onprogress?.(progress);
+  }
+  ;
+  (async () => {
+    const style = await downloader.getStyle();
+    const writer = new Writer(style);
+    handleProgress({ style: { done: true } });
+    writer.outputStream.pipe(sizeCounter);
+    writer.on("error", (err) => sizeCounter.destroy(err));
+    try {
+      for await (const spriteInfo of downloader.getSprites()) {
+        await writer.addSprite(spriteInfo);
+        handleProgress({
+          sprites: { downloaded: progress.sprites.downloaded + 1, done: false }
+        });
+      }
+      handleProgress({ sprites: { ...progress.sprites, done: true } });
+      const tiles = downloader.getTiles({
+        bounds: bbox,
+        maxzoom,
+        onprogress: (tileStats) => handleProgress({ tiles: { ...tileStats, done: false } })
+      });
+      await pipeline(tiles, writer.createTileWriteStream({ concurrency: 24 }));
+      handleProgress({ tiles: { ...progress.tiles, done: true } });
+      const glyphs = downloader.getGlyphs({
+        onprogress: (glyphStats) => handleProgress({ glyphs: { ...glyphStats, done: false } })
+      });
+      await pipeline(glyphs, writer.createGlyphWriteStream());
+      handleProgress({ glyphs: { ...progress.glyphs, done: true } });
+      writer.finish();
+    } catch (err) {
+      writer.outputStream.destroy(
+        /** @type {Error} */
+        err
+      );
+    }
+  })();
+  return sizeCounter;
+}
+export {
+  download
+};

package/dist/from-mbtiles.cjs

@@ -0,0 +1,91 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var from_mbtiles_exports = {};
+__export(from_mbtiles_exports, {
+  fromMBTiles: () => fromMBTiles
+});
+module.exports = __toCommonJS(from_mbtiles_exports);
+var import_mbtiles_reader = require("mbtiles-reader");
+var import_node_fs = __toESM(require("node:fs"), 1);
+var import_node_stream = require("node:stream");
+var import_node_stream2 = require("node:stream");
+var import_promises = require("node:stream/promises");
+var import_writer = require('./writer.cjs');
+const SOURCE_ID = "mbtiles-source";
+function fromMBTiles(mbtilesPath, outputPath) {
+  const reader = new import_mbtiles_reader.MBTiles(mbtilesPath);
+  if (reader.metadata.format === "pbf") {
+    throw new Error("Vector MBTiles are not yet supported");
+  }
+  const style = {
+    version: 8,
+    name: reader.metadata.name,
+    sources: {
+      [SOURCE_ID]: {
+        ...reader.metadata,
+        type: "raster"
+      }
+    },
+    layers: [
+      {
+        id: "background",
+        type: "background",
+        paint: {
+          "background-color": "white"
+        }
+      },
+      {
+        id: "raster",
+        type: "raster",
+        source: SOURCE_ID,
+        paint: {
+          "raster-opacity": 1
+        }
+      }
+    ]
+  };
+  const writer = new import_writer.Writer(style);
+  const returnValue = outputPath ? (0, import_promises.pipeline)(writer.outputStream, import_node_fs.default.createWriteStream(outputPath)) : writer.outputStream;
+  const tileWriteStream = writer.createTileWriteStream();
+  const transform = new import_node_stream.Transform({
+    objectMode: true,
+    transform({ z, x, y, data, format }, encoding, callback) {
+      callback(null, [data, { z, x, y, format, sourceId: SOURCE_ID }]);
+    }
+  });
+  (0, import_node_stream2.pipeline)(reader, transform, tileWriteStream, (err) => {
+    if (err) return writer.outputStream.destroy(err);
+    writer.finish();
+  });
+  return returnValue;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  fromMBTiles
+});

package/dist/from-mbtiles.d.cts

@@ -0,0 +1,17 @@
+import * as stream from 'stream';
+
+/**
+ * @overload
+ * @param {string} mbtilesPath
+ * @returns {import('stream').Readable}
+ */
+declare function fromMBTiles(mbtilesPath: string): stream.Readable;
+/**
+ * @overload
+ * @param {string} mbtilesPath
+ * @param {string} outputPath
+ * @returns {Promise<void>}
+ */
+declare function fromMBTiles(mbtilesPath: string, outputPath: string): Promise<void>;
+
+export { fromMBTiles };

package/dist/from-mbtiles.d.ts

@@ -0,0 +1,17 @@
+import * as stream from 'stream';
+
+/**
+ * @overload
+ * @param {string} mbtilesPath
+ * @returns {import('stream').Readable}
+ */
+declare function fromMBTiles(mbtilesPath: string): stream.Readable;
+/**
+ * @overload
+ * @param {string} mbtilesPath
+ * @param {string} outputPath
+ * @returns {Promise<void>}
+ */
+declare function fromMBTiles(mbtilesPath: string, outputPath: string): Promise<void>;
+
+export { fromMBTiles };

package/dist/from-mbtiles.js

@@ -0,0 +1,57 @@
+import { MBTiles } from "mbtiles-reader";
+import fs from "node:fs";
+import { Transform } from "node:stream";
+import { pipeline } from "node:stream";
+import { pipeline as pipelinePromise } from "node:stream/promises";
+import { Writer } from "./writer.js";
+const SOURCE_ID = "mbtiles-source";
+function fromMBTiles(mbtilesPath, outputPath) {
+  const reader = new MBTiles(mbtilesPath);
+  if (reader.metadata.format === "pbf") {
+    throw new Error("Vector MBTiles are not yet supported");
+  }
+  const style = {
+    version: 8,
+    name: reader.metadata.name,
+    sources: {
+      [SOURCE_ID]: {
+        ...reader.metadata,
+        type: "raster"
+      }
+    },
+    layers: [
+      {
+        id: "background",
+        type: "background",
+        paint: {
+          "background-color": "white"
+        }
+      },
+      {
+        id: "raster",
+        type: "raster",
+        source: SOURCE_ID,
+        paint: {
+          "raster-opacity": 1
+        }
+      }
+    ]
+  };
+  const writer = new Writer(style);
+  const returnValue = outputPath ? pipelinePromise(writer.outputStream, fs.createWriteStream(outputPath)) : writer.outputStream;
+  const tileWriteStream = writer.createTileWriteStream();
+  const transform = new Transform({
+    objectMode: true,
+    transform({ z, x, y, data, format }, encoding, callback) {
+      callback(null, [data, { z, x, y, format, sourceId: SOURCE_ID }]);
+    }
+  });
+  pipeline(reader, transform, tileWriteStream, (err) => {
+    if (err) return writer.outputStream.destroy(err);
+    writer.finish();
+  });
+  return returnValue;
+}
+export {
+  fromMBTiles
+};

package/dist/index.cjs

@@ -0,0 +1,49 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_exports = {};
+__export(index_exports, {
+  Reader: () => import_reader.Reader,
+  ReaderWatch: () => import_reader_watch.ReaderWatch,
+  StyleDownloader: () => import_style_downloader.StyleDownloader,
+  Writer: () => import_writer.Writer,
+  createServer: () => import_server.createServer,
+  download: () => import_download.download,
+  downloadTiles: () => import_tile_downloader.downloadTiles,
+  fromMBTiles: () => import_from_mbtiles.fromMBTiles
+});
+module.exports = __toCommonJS(index_exports);
+var import_reader = require('./reader.cjs');
+var import_reader_watch = require('./reader-watch.cjs');
+var import_writer = require('./writer.cjs');
+var import_server = require('./server.cjs');
+var import_style_downloader = require('./style-downloader.cjs');
+var import_tile_downloader = require('./tile-downloader.cjs');
+var import_download = require('./download.cjs');
+var import_from_mbtiles = require('./from-mbtiles.cjs');
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Reader,
+  ReaderWatch,
+  StyleDownloader,
+  Writer,
+  createServer,
+  download,
+  downloadTiles,
+  fromMBTiles
+});

package/dist/index.d.cts

@@ -0,0 +1,27 @@
+import { S as SMPSource$1, a as SMPStyle$1 } from './types-B4Xn1F9K.cjs';
+export { W as Writer } from './types-B4Xn1F9K.cjs';
+export { Reader } from './reader.cjs';
+export { ReaderWatch } from './reader-watch.cjs';
+export { createServer } from './server.cjs';
+export { StyleDownloader } from './style-downloader.cjs';
+export { downloadTiles } from './tile-downloader.cjs';
+export { download } from './download.cjs';
+export { fromMBTiles } from './from-mbtiles.cjs';
+import '@maplibre/maplibre-gl-style-spec';
+import 'geojson';
+import 'stream';
+import 'type-fest';
+import 'readable-stream';
+import 'events';
+import 'yauzl-promise';
+import 'http';
+import 'fastify';
+import 'ky';
+import './utils/geo.cjs';
+import './utils/fetch.cjs';
+import './utils/streams.cjs';
+
+type SMPSource = SMPSource$1;
+type SMPStyle = SMPStyle$1;
+
+export type { SMPSource, SMPStyle };

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { S as SMPSource$1, a as SMPStyle$1 } from './types-B4Xn1F9K.js';
+export { W as Writer } from './types-B4Xn1F9K.js';
+export { Reader } from './reader.js';
+export { ReaderWatch } from './reader-watch.js';
+export { createServer } from './server.js';
+export { StyleDownloader } from './style-downloader.js';
+export { downloadTiles } from './tile-downloader.js';
+export { download } from './download.js';
+export { fromMBTiles } from './from-mbtiles.js';
+import '@maplibre/maplibre-gl-style-spec';
+import 'geojson';
+import 'stream';
+import 'type-fest';
+import 'readable-stream';
+import 'events';
+import 'yauzl-promise';
+import 'http';
+import 'fastify';
+import 'ky';
+import './utils/geo.js';
+import './utils/fetch.js';
+import './utils/streams.js';
+
+type SMPSource = SMPSource$1;
+type SMPStyle = SMPStyle$1;
+
+export type { SMPSource, SMPStyle };

package/dist/index.js

@@ -0,0 +1,18 @@
+import { Reader } from "./reader.js";
+import { ReaderWatch } from "./reader-watch.js";
+import { Writer } from "./writer.js";
+import { createServer } from "./server.js";
+import { StyleDownloader } from "./style-downloader.js";
+import { downloadTiles } from "./tile-downloader.js";
+import { download } from "./download.js";
+import { fromMBTiles } from "./from-mbtiles.js";
+export {
+  Reader,
+  ReaderWatch,
+  StyleDownloader,
+  Writer,
+  createServer,
+  download,
+  downloadTiles,
+  fromMBTiles
+};