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

package/README.md

@@ -0,0 +1,90 @@
+# styled-map-package-api
+
+JavaScript API for reading, writing, and serving Styled Map Package (`.smp`) files. Works in both Node.js and browsers.
+
+An `.smp` file is a ZIP archive containing all the resources needed to serve a MapLibre vector styled map offline: style JSON, vector and raster tiles, glyphs (fonts), sprites, and metadata.
+
+## Installation
+
+```sh
+npm install styled-map-package-api
+```
+
+## Usage
+
+### Reading an SMP file
+
+```js
+import { Reader } from 'styled-map-package-api/reader'
+
+const reader = new Reader('path/to/map.smp')
+const style = await reader.getStyle()
+```
+
+### Writing an SMP file
+
+```js
+import { Writer } from 'styled-map-package-api/writer'
+
+const writer = new Writer(style, sources)
+const stream = writer.outputStream
+// Pipe stream to a file or other writable destination
+await writer.finish()
+```
+
+### Serving over HTTP
+
+```js
+import { Reader } from 'styled-map-package-api/reader'
+import { createServer } from 'styled-map-package-api/server'
+
+const reader = new Reader('path/to/map.smp')
+const server = createServer()
+// server.fetch(request, reader) returns a WHATWG Response
+```
+
+### Downloading a map for offline use
+
+```js
+import { download } from 'styled-map-package-api/download'
+
+const stream = download({
+  styleUrl: 'https://demotiles.maplibre.org/style.json',
+  bbox: [-180, -80, 180, 80],
+  maxzoom: 5,
+})
+// Pipe the ReadableStream to a file
+```
+
+### Converting from MBTiles
+
+```js
+import { fromMBTiles } from 'styled-map-package-api/from-mbtiles'
+
+const stream = fromMBTiles('path/to/tiles.mbtiles')
+// Pipe the ReadableStream to an .smp file
+```
+
+## API
+
+### Exports
+
+| Export path                               | Description                                                       |
+| ----------------------------------------- | ----------------------------------------------------------------- |
+| `styled-map-package-api`                  | Main entry — `Reader`, `Writer`, `createServer`, `download`, etc. |
+| `styled-map-package-api/reader`           | `Reader` class for reading `.smp` files                           |
+| `styled-map-package-api/writer`           | `Writer` class for creating `.smp` files                          |
+| `styled-map-package-api/server`           | `createServer()` — HTTP handler using WHATWG Request/Response     |
+| `styled-map-package-api/download`         | `download()` — download an online map style for offline use       |
+| `styled-map-package-api/style-downloader` | `StyleDownloader` — downloads styles, sprites, and glyphs         |
+| `styled-map-package-api/tile-downloader`  | `downloadTiles()` — downloads tile data                           |
+| `styled-map-package-api/from-mbtiles`     | `fromMBTiles()` — convert MBTiles to SMP stream                   |
+| `styled-map-package-api/utils/mapbox`     | Mapbox URL detection and API utilities                            |
+
+### Browser support
+
+All stream APIs use WHATWG `ReadableStream`, making the library compatible with both Node.js and browser environments. The `Reader` class accepts either a file path (Node.js) or a `ZipReader` instance (browser).
+
+## License
+
+MIT

package/dist/download.d.cts

@@ -1,6 +1,6 @@
 import { GlyphDownloadStats } from './style-downloader.cjs';
 import { TileDownloadStats } from './tile-downloader.cjs';
-import { D as DownloadStream } from './types-CJq90eOB.cjs';
+import { D as DownloadStream } from './types-DPei6PMF.cjs';
 import { BBox } from './utils/geo.cjs';
 import 'ky';
 import '@maplibre/maplibre-gl-style-spec';
@@ -9,7 +9,6 @@ import './utils/streams.cjs';
 import 'stream/web';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /**
  * @typedef {object} DownloadProgress

package/dist/download.d.ts

@@ -1,6 +1,6 @@
 import { GlyphDownloadStats } from './style-downloader.js';
 import { TileDownloadStats } from './tile-downloader.js';
-import { D as DownloadStream } from './types-CJq90eOB.js';
+import { D as DownloadStream } from './types-DPei6PMF.js';
 import { BBox } from './utils/geo.js';
 import 'ky';
 import '@maplibre/maplibre-gl-style-spec';
@@ -9,7 +9,6 @@ import './utils/streams.js';
 import 'stream/web';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /**
  * @typedef {object} DownloadProgress

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { S as SMPSource$1, a as SMPStyle$1 } from './types-CJq90eOB.cjs';
-export { W as Writer } from './types-CJq90eOB.cjs';
+import { S as SMPSource$1, a as SMPStyle$1 } from './types-DPei6PMF.cjs';
+export { W as Writer } from './types-DPei6PMF.cjs';
 export { Reader } from './reader.cjs';
 export { createServer } from './server.cjs';
 export { StyleDownloader } from './style-downloader.cjs';
@@ -9,7 +9,6 @@ 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';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { S as SMPSource$1, a as SMPStyle$1 } from './types-CJq90eOB.js';
-export { W as Writer } from './types-CJq90eOB.js';
+import { S as SMPSource$1, a as SMPStyle$1 } from './types-DPei6PMF.js';
+export { W as Writer } from './types-DPei6PMF.js';
 export { Reader } from './reader.js';
 export { createServer } from './server.js';
 export { StyleDownloader } from './style-downloader.js';
@@ -9,7 +9,6 @@ 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';

package/dist/reader.d.cts

@@ -1,9 +1,8 @@
-import { a as SMPStyle } from './types-CJq90eOB.cjs';
+import { a as SMPStyle } from './types-DPei6PMF.cjs';
 import * as _gmaclennan_zip_reader from '@gmaclennan/zip-reader';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /**
  * @typedef {object} Resource

package/dist/reader.d.ts

@@ -1,9 +1,8 @@
-import { a as SMPStyle } from './types-CJq90eOB.js';
+import { a as SMPStyle } from './types-DPei6PMF.js';
 import * as _gmaclennan_zip_reader from '@gmaclennan/zip-reader';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /**
  * @typedef {object} Resource

package/dist/server.d.cts

@@ -1,11 +1,10 @@
 import { RequestLike } from 'itty-router';
 import { Reader } from './reader.cjs';
 import { IttyRouter } from 'itty-router/IttyRouter';
-import './types-CJq90eOB.cjs';
+import './types-DPei6PMF.cjs';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 import '@gmaclennan/zip-reader';
 
 /**

package/dist/server.d.ts

@@ -1,11 +1,10 @@
 import { RequestLike } from 'itty-router';
 import { Reader } from './reader.js';
 import { IttyRouter } from 'itty-router/IttyRouter';
-import './types-CJq90eOB.js';
+import './types-DPei6PMF.js';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 import '@gmaclennan/zip-reader';
 
 /**

package/dist/style-downloader.d.cts

@@ -1,11 +1,10 @@
 import * as ky from 'ky';
 import { BBox } from './utils/geo.cjs';
-import { b as StyleInlinedSources, G as GlyphInfo, T as TileInfo } from './types-CJq90eOB.cjs';
+import { b as StyleInlinedSources, G as GlyphInfo, T as TileInfo } from './types-DPei6PMF.cjs';
 import { TileDownloadStats } from './tile-downloader.cjs';
 import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 import './utils/fetch.cjs';
 import './utils/streams.cjs';
 import 'stream/web';

package/dist/style-downloader.d.ts

@@ -1,11 +1,10 @@
 import * as ky from 'ky';
 import { BBox } from './utils/geo.js';
-import { b as StyleInlinedSources, G as GlyphInfo, T as TileInfo } from './types-CJq90eOB.js';
+import { b as StyleInlinedSources, G as GlyphInfo, T as TileInfo } from './types-DPei6PMF.js';
 import { TileDownloadStats } from './tile-downloader.js';
 import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 import './utils/fetch.js';
 import './utils/streams.js';
 import 'stream/web';

package/dist/tile-downloader.d.cts

@@ -1,10 +1,9 @@
-import { T as TileInfo$1 } from './types-CJq90eOB.cjs';
+import { T as TileInfo$1 } from './types-DPei6PMF.cjs';
 import { BBox } from './utils/geo.cjs';
 import { FetchQueue } from './utils/fetch.cjs';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 import './utils/streams.cjs';
 import 'stream/web';
 

package/dist/tile-downloader.d.ts

@@ -1,10 +1,9 @@
-import { T as TileInfo$1 } from './types-CJq90eOB.js';
+import { T as TileInfo$1 } from './types-DPei6PMF.js';
 import { BBox } from './utils/geo.js';
 import { FetchQueue } from './utils/fetch.js';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 import './utils/streams.js';
 import 'stream/web';
 

package/dist/{types-CJq90eOB.d.cts → types-DPei6PMF.d.cts}

@@ -1,7 +1,6 @@
 import { StyleSpecification, SourceSpecification, GeoJSONSourceSpecification, VectorSourceSpecification, RasterSourceSpecification, RasterDEMSourceSpecification } from '@maplibre/maplibre-gl-style-spec';
 import { GeoJSON, BBox } from 'geojson';
 import { SetRequired } from 'type-fest';
-import { EventEmitter } from 'events';
 
 /** @typedef {string | Uint8Array | ReadableStream } Source */
 /** @typedef {`${number}-${number}`} GlyphRange */
@@ -34,7 +33,7 @@ declare const SUPPORTED_SOURCE_TYPES: readonly ["raster", "vector", "geojson"];
  * `witer.finish()` and then wait for your writable stream to `finish` before
  * using the output.
  */
-declare class Writer extends EventEmitter<[never]> {
+declare class Writer {
     static SUPPORTED_SOURCE_TYPES: readonly ["raster", "vector", "geojson"];
     /**
      * @param {any} style A v7 or v8 MapLibre style. v7 styles will be migrated to

package/dist/{types-CJq90eOB.d.ts → types-DPei6PMF.d.ts}

@@ -1,7 +1,6 @@
 import { StyleSpecification, SourceSpecification, GeoJSONSourceSpecification, VectorSourceSpecification, RasterSourceSpecification, RasterDEMSourceSpecification } from '@maplibre/maplibre-gl-style-spec';
 import { GeoJSON, BBox } from 'geojson';
 import { SetRequired } from 'type-fest';
-import { EventEmitter } from 'events';
 
 /** @typedef {string | Uint8Array | ReadableStream } Source */
 /** @typedef {`${number}-${number}`} GlyphRange */
@@ -34,7 +33,7 @@ declare const SUPPORTED_SOURCE_TYPES: readonly ["raster", "vector", "geojson"];
  * `witer.finish()` and then wait for your writable stream to `finish` before
  * using the output.
  */
-declare class Writer extends EventEmitter<[never]> {
+declare class Writer {
     static SUPPORTED_SOURCE_TYPES: readonly ["raster", "vector", "geojson"];
     /**
      * @param {any} style A v7 or v8 MapLibre style. v7 styles will be migrated to

package/dist/utils/file-formats.d.cts

@@ -1,8 +1,7 @@
-import { c as TileFormat } from '../types-CJq90eOB.cjs';
+import { c as TileFormat } from '../types-DPei6PMF.cjs';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /**
  * For a given buffer, determine the tile format based on the magic bytes.

package/dist/utils/file-formats.d.ts

@@ -1,8 +1,7 @@
-import { c as TileFormat } from '../types-CJq90eOB.js';
+import { c as TileFormat } from '../types-DPei6PMF.js';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /**
  * For a given buffer, determine the tile format based on the magic bytes.

package/dist/utils/style.d.cts

@@ -1,10 +1,9 @@
 import { BBox } from './geo.cjs';
-import { I as InlinedSource } from '../types-CJq90eOB.cjs';
+import { I as InlinedSource } from '../types-DPei6PMF.cjs';
 import * as _maplibre_maplibre_gl_style_spec from '@maplibre/maplibre-gl-style-spec';
 import { StyleSpecification, ValidationError } from '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /** @import {StyleSpecification, ExpressionSpecification, ValidationError} from '@maplibre/maplibre-gl-style-spec' */
 /**

package/dist/utils/style.d.ts

@@ -1,10 +1,9 @@
 import { BBox } from './geo.js';
-import { I as InlinedSource } from '../types-CJq90eOB.js';
+import { I as InlinedSource } from '../types-DPei6PMF.js';
 import * as _maplibre_maplibre_gl_style_spec from '@maplibre/maplibre-gl-style-spec';
 import { StyleSpecification, ValidationError } from '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';
-import 'events';
 
 /** @import {StyleSpecification, ExpressionSpecification, ValidationError} from '@maplibre/maplibre-gl-style-spec' */
 /**

package/dist/utils/templates.d.cts

@@ -1,8 +1,7 @@
 import * as type_fest from 'type-fest';
-import { d as GlyphRange, T as TileInfo, c as TileFormat } from '../types-CJq90eOB.cjs';
+import { d as GlyphRange, T as TileInfo, c as TileFormat } from '../types-DPei6PMF.cjs';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
-import 'events';
 
 /**
  * @param {string} path

package/dist/utils/templates.d.ts

@@ -1,8 +1,7 @@
 import * as type_fest from 'type-fest';
-import { d as GlyphRange, T as TileInfo, c as TileFormat } from '../types-CJq90eOB.js';
+import { d as GlyphRange, T as TileInfo, c as TileFormat } from '../types-DPei6PMF.js';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
-import 'events';
 
 /**
  * @param {string} path

package/dist/writer.cjs

@@ -24,7 +24,6 @@ __export(writer_exports, {
 module.exports = __toCommonJS(writer_exports);
 var import_maplibre_gl_style_spec = require("@maplibre/maplibre-gl-style-spec");
 var import_bbox = require("@turf/bbox");
-var import_events = require("events");
 var import_filter_obj = require("filter-obj");
 var import_zip_writer = require("zip-writer");
 var import_file_formats = require('./utils/file-formats.cjs');
@@ -41,7 +40,7 @@ const SUPPORTED_SOURCE_TYPES = (
     "geojson"
   ]
 );
-class Writer extends import_events.EventEmitter {
+class Writer {
   #zipWriter = new import_zip_writer.ZipWriter();
   /** @type {Set<string>} */
   #addedFiles = /* @__PURE__ */ new Set();
@@ -64,7 +63,6 @@ class Writer extends import_events.EventEmitter {
    * this is typed as `any` and validated internally)
    */
   constructor(style) {
-    super();
     if (!style || !("version" in style)) {
       throw new Error("Invalid style");
     }

package/dist/writer.d.cts

@@ -1,5 +1,4 @@
-export { G as GlyphInfo, d as GlyphRange, e as SUPPORTED_SOURCE_TYPES, f as Source, g as SourceInfo, c as TileFormat, T as TileInfo, W as Writer } from './types-CJq90eOB.cjs';
-import 'events';
+export { G as GlyphInfo, d as GlyphRange, e as SUPPORTED_SOURCE_TYPES, f as Source, g as SourceInfo, c as TileFormat, T as TileInfo, W as Writer } from './types-DPei6PMF.cjs';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';

package/dist/writer.d.ts

@@ -1,5 +1,4 @@
-export { G as GlyphInfo, d as GlyphRange, e as SUPPORTED_SOURCE_TYPES, f as Source, g as SourceInfo, c as TileFormat, T as TileInfo, W as Writer } from './types-CJq90eOB.js';
-import 'events';
+export { G as GlyphInfo, d as GlyphRange, e as SUPPORTED_SOURCE_TYPES, f as Source, g as SourceInfo, c as TileFormat, T as TileInfo, W as Writer } from './types-DPei6PMF.js';
 import '@maplibre/maplibre-gl-style-spec';
 import 'geojson';
 import 'type-fest';

package/dist/writer.js

@@ -1,6 +1,5 @@
 import { validateStyleMin, migrate } from "@maplibre/maplibre-gl-style-spec";
 import { bbox } from "@turf/bbox";
-import { EventEmitter } from "events";
 import { excludeKeys } from "filter-obj";
 import { ZipWriter } from "zip-writer";
 import { getTileFormatFromStream } from "./utils/file-formats.js";
@@ -29,7 +28,7 @@ const SUPPORTED_SOURCE_TYPES = (
     "geojson"
   ]
 );
-class Writer extends EventEmitter {
+class Writer {
   #zipWriter = new ZipWriter();
   /** @type {Set<string>} */
   #addedFiles = /* @__PURE__ */ new Set();
@@ -52,7 +51,6 @@ class Writer extends EventEmitter {
    * this is typed as `any` and validated internally)
    */
   constructor(style) {
-    super();
     if (!style || !("version" in style)) {
       throw new Error("Invalid style");
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "styled-map-package-api",
-  "version": "5.0.0-pre.0",
+  "version": "5.0.0-pre.1",
   "description": "JavaScript API for reading, writing, and serving Styled Map Package (.smp) files",
   "type": "module",
   "main": "./dist/index.cjs",