styled-map-package-api 5.0.0-pre.0

package/dist/download.cjs

@@ -0,0 +1,100 @@
+"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_style_downloader = require('./style-downloader.cjs');
+var import_streams = require('./utils/streams.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
+  };
+  function handleProgress(update) {
+    progress = { ...progress, ...update, elapsedMs: Date.now() - start };
+    onprogress?.(progress);
+  }
+  const sizeCounter = new TransformStream({
+    transform(chunk, controller) {
+      handleProgress({
+        output: {
+          totalBytes: progress.output.totalBytes + chunk.byteLength,
+          done: false
+        }
+      });
+      controller.enqueue(chunk);
+    },
+    flush() {
+      handleProgress({ output: { ...progress.output, done: true } });
+    }
+  });
+  (async () => {
+    const style = await downloader.getStyle();
+    const writer = new import_writer.Writer(style);
+    handleProgress({ style: { done: true } });
+    writer.outputStream.pipeTo(sizeCounter.writable).catch(() => {
+    });
+    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_streams.readableFromAsync)(tiles).pipeTo(
+        writer.createTileWriteStream({ concurrency: 24 })
+      );
+      handleProgress({ tiles: { ...progress.tiles, done: true } });
+      const glyphs = downloader.getGlyphs({
+        onprogress: (glyphStats) => handleProgress({ glyphs: { ...glyphStats, done: false } })
+      });
+      await (0, import_streams.readableFromAsync)(glyphs).pipeTo(writer.createGlyphWriteStream());
+      handleProgress({ glyphs: { ...progress.glyphs, done: true } });
+      writer.finish();
+    } catch (err) {
+      writer.abort(
+        /** @type {Error} */
+        err
+      );
+    }
+  })();
+  return sizeCounter.readable;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  download
+});

package/dist/download.d.cts

@@ -0,0 +1,64 @@
+import { GlyphDownloadStats } from './style-downloader.cjs';
+import { TileDownloadStats } from './tile-downloader.cjs';
+import { D as DownloadStream } from './types-CJq90eOB.cjs';
+import { BBox } from './utils/geo.cjs';
+import 'ky';
+import '@maplibre/maplibre-gl-style-spec';
+import './utils/fetch.cjs';
+import './utils/streams.cjs';
+import 'stream/web';
+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/download.d.ts

@@ -0,0 +1,64 @@
+import { GlyphDownloadStats } from './style-downloader.js';
+import { TileDownloadStats } from './tile-downloader.js';
+import { D as DownloadStream } from './types-CJq90eOB.js';
+import { BBox } from './utils/geo.js';
+import 'ky';
+import '@maplibre/maplibre-gl-style-spec';
+import './utils/fetch.js';
+import './utils/streams.js';
+import 'stream/web';
+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/download.js

@@ -0,0 +1,76 @@
+import { StyleDownloader } from "./style-downloader.js";
+import { readableFromAsync } from "./utils/streams.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
+  };
+  function handleProgress(update) {
+    progress = { ...progress, ...update, elapsedMs: Date.now() - start };
+    onprogress?.(progress);
+  }
+  const sizeCounter = new TransformStream({
+    transform(chunk, controller) {
+      handleProgress({
+        output: {
+          totalBytes: progress.output.totalBytes + chunk.byteLength,
+          done: false
+        }
+      });
+      controller.enqueue(chunk);
+    },
+    flush() {
+      handleProgress({ output: { ...progress.output, done: true } });
+    }
+  });
+  (async () => {
+    const style = await downloader.getStyle();
+    const writer = new Writer(style);
+    handleProgress({ style: { done: true } });
+    writer.outputStream.pipeTo(sizeCounter.writable).catch(() => {
+    });
+    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 readableFromAsync(tiles).pipeTo(
+        writer.createTileWriteStream({ concurrency: 24 })
+      );
+      handleProgress({ tiles: { ...progress.tiles, done: true } });
+      const glyphs = downloader.getGlyphs({
+        onprogress: (glyphStats) => handleProgress({ glyphs: { ...glyphStats, done: false } })
+      });
+      await readableFromAsync(glyphs).pipeTo(writer.createGlyphWriteStream());
+      handleProgress({ glyphs: { ...progress.glyphs, done: true } });
+      writer.finish();
+    } catch (err) {
+      writer.abort(
+        /** @type {Error} */
+        err
+      );
+    }
+  })();
+  return sizeCounter.readable;
+}
+export {
+  download
+};

package/dist/from-mbtiles.cjs

@@ -0,0 +1,81 @@
+"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 from_mbtiles_exports = {};
+__export(from_mbtiles_exports, {
+  fromMBTiles: () => fromMBTiles
+});
+module.exports = __toCommonJS(from_mbtiles_exports);
+var import_mbtiles_reader = require("mbtiles-reader");
+var import_streams = require('./utils/streams.cjs');
+var import_writer = require('./writer.cjs');
+const SOURCE_ID = "mbtiles-source";
+function fromMBTiles(mbtilesPath) {
+  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);
+  (async () => {
+    try {
+      await (0, import_streams.readableFromAsync)(mbtilesToTileArgs(reader)).pipeTo(
+        writer.createTileWriteStream()
+      );
+      writer.finish();
+    } catch (err) {
+      writer.abort(err instanceof Error ? err : new Error(String(err)));
+    }
+  })();
+  return writer.outputStream;
+}
+async function* mbtilesToTileArgs(mbtiles) {
+  for (const { z, x, y, data, format } of mbtiles) {
+    yield [data, { z, x, y, format, sourceId: SOURCE_ID }];
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  fromMBTiles
+});

package/dist/from-mbtiles.d.cts

@@ -0,0 +1,10 @@
+/**
+ * Convert a MBTiles file to a styled map package, returned as a web
+ * ReadableStream.
+ *
+ * @param {string} mbtilesPath
+ * @returns {ReadableStream<Uint8Array>}
+ */
+declare function fromMBTiles(mbtilesPath: string): ReadableStream<Uint8Array>;
+
+export { fromMBTiles };

package/dist/from-mbtiles.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Convert a MBTiles file to a styled map package, returned as a web
+ * ReadableStream.
+ *
+ * @param {string} mbtilesPath
+ * @returns {ReadableStream<Uint8Array>}
+ */
+declare function fromMBTiles(mbtilesPath: string): ReadableStream<Uint8Array>;
+
+export { fromMBTiles };

package/dist/from-mbtiles.js

@@ -0,0 +1,57 @@
+import { MBTiles } from "mbtiles-reader";
+import { readableFromAsync } from "./utils/streams.js";
+import { Writer } from "./writer.js";
+const SOURCE_ID = "mbtiles-source";
+function fromMBTiles(mbtilesPath) {
+  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);
+  (async () => {
+    try {
+      await readableFromAsync(mbtilesToTileArgs(reader)).pipeTo(
+        writer.createTileWriteStream()
+      );
+      writer.finish();
+    } catch (err) {
+      writer.abort(err instanceof Error ? err : new Error(String(err)));
+    }
+  })();
+  return writer.outputStream;
+}
+async function* mbtilesToTileArgs(mbtiles) {
+  for (const { z, x, y, data, format } of mbtiles) {
+    yield [data, { z, x, y, format, sourceId: SOURCE_ID }];
+  }
+}
+export {
+  fromMBTiles
+};

package/dist/index.cjs

@@ -0,0 +1,46 @@
+"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,
+  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_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,
+  StyleDownloader,
+  Writer,
+  createServer,
+  download,
+  downloadTiles,
+  fromMBTiles
+});

package/dist/index.d.cts

@@ -0,0 +1,25 @@
+import { S as SMPSource$1, a as SMPStyle$1 } from './types-CJq90eOB.cjs';
+export { W as Writer } from './types-CJq90eOB.cjs';
+export { Reader } from './reader.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 'type-fest';
+import 'events';
+import '@gmaclennan/zip-reader';
+import 'itty-router';
+import 'itty-router/IttyRouter';
+import 'ky';
+import './utils/geo.cjs';
+import './utils/fetch.cjs';
+import './utils/streams.cjs';
+import 'stream/web';
+
+type SMPSource = SMPSource$1;
+type SMPStyle = SMPStyle$1;
+
+export type { SMPSource, SMPStyle };

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { S as SMPSource$1, a as SMPStyle$1 } from './types-CJq90eOB.js';
+export { W as Writer } from './types-CJq90eOB.js';
+export { Reader } from './reader.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 'type-fest';
+import 'events';
+import '@gmaclennan/zip-reader';
+import 'itty-router';
+import 'itty-router/IttyRouter';
+import 'ky';
+import './utils/geo.js';
+import './utils/fetch.js';
+import './utils/streams.js';
+import 'stream/web';
+
+type SMPSource = SMPSource$1;
+type SMPStyle = SMPStyle$1;
+
+export type { SMPSource, SMPStyle };

package/dist/index.js

@@ -0,0 +1,16 @@
+import { Reader } from "./reader.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,
+  StyleDownloader,
+  Writer,
+  createServer,
+  download,
+  downloadTiles,
+  fromMBTiles
+};