styled-map-package 3.0.0 → 4.0.0

package/bin/smp-view.js

@@ -1,11 +1,13 @@
 #!/usr/bin/env node
 import fastifyStatic from '@fastify/static'
+import { createServerAdapter } from '@whatwg-node/server'
 import { Command } from 'commander'
 import fastify from 'fastify'
 import openApp from 'open'
 
 import path from 'node:path'
 
+import { Reader } from '../dist/reader.js'
 import { createServer } from '../dist/server.js'
 
 const program = new Command()
@@ -35,6 +37,12 @@ program.parseAsync(process.argv)
  * @returns
  */
 function serve({ port = 3000, filepath }) {
+  const reader = new Reader(path.relative(process.cwd(), filepath))
+  const smpServer = createServer({ base: '/map' })
+  const serverAdapter = createServerAdapter((request) => {
+    return smpServer.fetch(request, reader)
+  })
+
   const server = fastify()
 
   server.register(fastifyStatic, {
@@ -45,9 +53,12 @@ function serve({ port = 3000, filepath }) {
     return reply.sendFile('index.html')
   })
 
-  server.register(createServer, {
-    filepath: path.relative(process.cwd(), filepath),
-    prefix: '/map',
+  server.route({
+    url: '/map/*',
+    method: ['GET', 'HEAD', 'OPTIONS'],
+    handler: (req, reply) => {
+      return serverAdapter.handleNodeRequestAndResponse(req, reply)
+    },
   })
   return server.listen({ port })
 }

package/dist/index.d.cts

@@ -14,8 +14,8 @@ import 'type-fest';
 import 'readable-stream';
 import 'events';
 import 'yauzl-promise';
-import 'http';
-import 'fastify';
+import 'itty-router';
+import 'itty-router/IttyRouter';
 import 'ky';
 import './utils/geo.cjs';
 import './utils/fetch.cjs';

package/dist/index.d.ts

@@ -14,8 +14,8 @@ import 'type-fest';
 import 'readable-stream';
 import 'events';
 import 'yauzl-promise';
-import 'http';
-import 'fastify';
+import 'itty-router';
+import 'itty-router/IttyRouter';
 import 'ky';
 import './utils/geo.js';
 import './utils/fetch.js';

package/dist/server.cjs

@@ -1,9 +1,7 @@
 "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)
@@ -17,61 +15,63 @@ var __copyProps = (to, from, except, desc) => {
   }
   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 server_exports = {};
 __export(server_exports, {
   createServer: () => createServer
 });
 module.exports = __toCommonJS(server_exports);
-var import_http_errors = __toESM(require("http-errors"), 1);
-var import_reader = require('./reader.cjs');
+var import_IttyRouter = require("itty-router/IttyRouter");
+var import_StatusError = require("itty-router/StatusError");
+var import_createResponse = require("itty-router/createResponse");
+var import_node_stream = require("node:stream");
 var import_errors = require('./utils/errors.cjs');
-var import_misc = require('./utils/misc.cjs');
-function sendResource(reply, resource) {
-  reply.type(resource.contentType).header("content-length", resource.contentLength);
+function resourceResponse(resource, options = {}) {
+  const response = new Response(
+    // @ts-expect-error Some discrepancy between Typescript lib dom typings and @types/node typings
+    import_node_stream.Readable.toWeb(resource.stream),
+    options
+  );
+  response.headers.set("Content-Type", resource.contentType);
+  response.headers.set("Content-Length", resource.contentLength.toString());
   if (resource.contentEncoding) {
-    reply.header("content-encoding", resource.contentEncoding);
+    response.headers.set("Content-Encoding", resource.contentEncoding);
   }
-  return reply.send(resource.stream);
+  return response;
 }
-function createServer(fastify, opts, done) {
-  const reader = "reader" in opts ? opts.reader : new import_reader.Reader(opts.filepath);
-  if (!("reader" in opts)) {
-    fastify.addHook("onClose", () => reader.close().catch(import_misc.noop));
-  }
-  fastify.get("/style.json", async () => {
-    try {
-      const baseUrl = new URL(fastify.prefix, fastify.listeningOrigin);
-      const style = await reader.getStyle(baseUrl.href);
-      return style;
-    } catch (error) {
-      if ((0, import_errors.isFileNotThereError)(error)) {
-        throw (0, import_http_errors.default)(404, error.message);
-      }
-      throw error;
-    }
+const jsonRaw = (0, import_createResponse.createResponse)("application/json; charset=utf-8");
+const encoder = new TextEncoder();
+function json(obj) {
+  const data = encoder.encode(JSON.stringify(obj));
+  return jsonRaw(data, {
+    headers: { "Content-Length": data.length.toString() }
   });
-  fastify.get("*", async (request, reply) => {
-    const path = request.params["*"];
-    try {
-      const resource = await reader.getResource(path);
-      return sendResource(reply, resource);
-    } catch (error) {
-      if ((0, import_errors.isFileNotThereError)(error)) {
-        throw (0, import_http_errors.default)(404, error.message);
-      }
-      throw error;
-    }
+}
+function createServer({ base = "/" } = {}) {
+  base = base.endsWith("/") ? base : base + "/";
+  const router = (0, import_IttyRouter.IttyRouter)({
+    base
+  }).get("/style.json", async (request, reader) => {
+    const baseUrl = new URL(base, request.url);
+    const style = await reader.getStyle(baseUrl.href);
+    return json(style);
+  }).get("*", async (request, reader) => {
+    const url = new URL(request.url);
+    const path = decodeURIComponent(url.pathname.slice(base.length - 1));
+    const resource = await reader.getResource(path);
+    return resourceResponse(resource);
   });
-  done();
+  return {
+    fetch: (request, reader) => {
+      return router.fetch(request, reader).catch((err) => {
+        if ((0, import_errors.isFileNotThereError)(err)) {
+          throw new import_StatusError.StatusError(404, "Not Found");
+        } else {
+          throw err;
+        }
+      });
+    }
+  };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/server.d.cts

@@ -1,6 +1,6 @@
-import * as http from 'http';
-import * as fastify from 'fastify';
+import { RequestLike } from 'itty-router';
 import { Reader } from './reader.cjs';
+import { IttyRouter } from 'itty-router/IttyRouter';
 import 'stream';
 import './types-B4Xn1F9K.cjs';
 import '@maplibre/maplibre-gl-style-spec';
@@ -10,28 +10,39 @@ import 'readable-stream';
 import 'events';
 import 'yauzl-promise';
 
-declare function createServer(instance: fastify.FastifyInstance<fastify.RawServerDefault, http.IncomingMessage, http.ServerResponse<http.IncomingMessage>, fastify.FastifyBaseLogger, fastify.FastifyTypeProviderDefault>, opts: PluginOptions, done: (err
 /**
- * Fastify plugin for serving a styled map package.
+ * Create a server for serving styled map packages (SMP) over http. The server
+ * is a `fetch` handler that must be provided a WHATWG `Request` and a SMP
+ * `Reader` instance. Use `@whatwg-node/server` to use with Node.js HTTP server.
  *
- * If you provide a `Reader` (or `ReaderWatch`) instance via the `reader` opt,
- * you must manually close the instance yourself.
+ * To handle errors, catch errors from `fetch` and return appropriate HTTP responses.
+ * You can use `itty-router/error` for this.
  *
- * @type {FastifyPluginCallback<PluginOptions>}
+ * @example
+ * ```js
+ * import { createServer } from 'node:http'
+ * import { error } from 'itty-router/error'
+ * import { createServerAdapter } from '@whatwg-node/server'
+ * import { createServer as createSMPServer } from 'styled-map-package/server'
+ * import { Reader } from 'styled-map-package/reader'
+ *
+ * const reader = new Reader('path/to/your-style.smp')
+ * const smpServer = createSMPServer()
+ * const httpServer = createServer(createServerAdapter((request) => {
+ *   return smpServer.fetch(request, reader).catch(error)
+ * }))
+ * ```
+ *
+ * @param {object} [options]
+ * @param {string} [options.base='/'] Base path for the server routes
+ * @returns {{ fetch: (request: RequestLike, reader: ReaderLike) => Promise<Response> }} server instance
  */
-?: Error) => void): void;
-type PluginOptionsFilepath = {
-    /**
-     * Path to styled map package (`.smp`) file
-     */
-    filepath: string;
-};
-type PluginOptionsReader = {
-    /**
-     * SMP Reader interface (also supports ReaderWatch)
-     */
-    reader: Pick<Reader, keyof Reader>;
+declare function createServer({ base }?: {
+    base?: string | undefined;
+}): {
+    fetch: (request: RequestLike, reader: ReaderLike) => Promise<Response>;
 };
-type PluginOptions = PluginOptionsFilepath | PluginOptionsReader;
+type ReaderLike = Pick<Reader, keyof Reader>;
+type RouterType = typeof IttyRouter<IRequestStrict, [ReaderLike], Response>;
 
-export { type PluginOptions, type PluginOptionsFilepath, type PluginOptionsReader, createServer };
+export { type ReaderLike, type RouterType, createServer };

package/dist/server.d.ts

@@ -1,6 +1,6 @@
-import * as http from 'http';
-import * as fastify from 'fastify';
+import { RequestLike } from 'itty-router';
 import { Reader } from './reader.js';
+import { IttyRouter } from 'itty-router/IttyRouter';
 import 'stream';
 import './types-B4Xn1F9K.js';
 import '@maplibre/maplibre-gl-style-spec';
@@ -10,28 +10,39 @@ import 'readable-stream';
 import 'events';
 import 'yauzl-promise';
 
-declare function createServer(instance: fastify.FastifyInstance<fastify.RawServerDefault, http.IncomingMessage, http.ServerResponse<http.IncomingMessage>, fastify.FastifyBaseLogger, fastify.FastifyTypeProviderDefault>, opts: PluginOptions, done: (err
 /**
- * Fastify plugin for serving a styled map package.
+ * Create a server for serving styled map packages (SMP) over http. The server
+ * is a `fetch` handler that must be provided a WHATWG `Request` and a SMP
+ * `Reader` instance. Use `@whatwg-node/server` to use with Node.js HTTP server.
  *
- * If you provide a `Reader` (or `ReaderWatch`) instance via the `reader` opt,
- * you must manually close the instance yourself.
+ * To handle errors, catch errors from `fetch` and return appropriate HTTP responses.
+ * You can use `itty-router/error` for this.
  *
- * @type {FastifyPluginCallback<PluginOptions>}
+ * @example
+ * ```js
+ * import { createServer } from 'node:http'
+ * import { error } from 'itty-router/error'
+ * import { createServerAdapter } from '@whatwg-node/server'
+ * import { createServer as createSMPServer } from 'styled-map-package/server'
+ * import { Reader } from 'styled-map-package/reader'
+ *
+ * const reader = new Reader('path/to/your-style.smp')
+ * const smpServer = createSMPServer()
+ * const httpServer = createServer(createServerAdapter((request) => {
+ *   return smpServer.fetch(request, reader).catch(error)
+ * }))
+ * ```
+ *
+ * @param {object} [options]
+ * @param {string} [options.base='/'] Base path for the server routes
+ * @returns {{ fetch: (request: RequestLike, reader: ReaderLike) => Promise<Response> }} server instance
  */
-?: Error) => void): void;
-type PluginOptionsFilepath = {
-    /**
-     * Path to styled map package (`.smp`) file
-     */
-    filepath: string;
-};
-type PluginOptionsReader = {
-    /**
-     * SMP Reader interface (also supports ReaderWatch)
-     */
-    reader: Pick<Reader, keyof Reader>;
+declare function createServer({ base }?: {
+    base?: string | undefined;
+}): {
+    fetch: (request: RequestLike, reader: ReaderLike) => Promise<Response>;
 };
-type PluginOptions = PluginOptionsFilepath | PluginOptionsReader;
+type ReaderLike = Pick<Reader, keyof Reader>;
+type RouterType = typeof IttyRouter<IRequestStrict, [ReaderLike], Response>;
 
-export { type PluginOptions, type PluginOptionsFilepath, type PluginOptionsReader, createServer };
+export { type ReaderLike, type RouterType, createServer };

package/dist/server.js

@@ -1,44 +1,54 @@
-import createError from "http-errors";
-import { Reader } from "./reader.js";
+import { IttyRouter } from "itty-router/IttyRouter";
+import { StatusError } from "itty-router/StatusError";
+import { createResponse } from "itty-router/createResponse";
+import { Readable } from "node:stream";
 import { isFileNotThereError } from "./utils/errors.js";
-import { noop } from "./utils/misc.js";
-function sendResource(reply, resource) {
-  reply.type(resource.contentType).header("content-length", resource.contentLength);
+function resourceResponse(resource, options = {}) {
+  const response = new Response(
+    // @ts-expect-error Some discrepancy between Typescript lib dom typings and @types/node typings
+    Readable.toWeb(resource.stream),
+    options
+  );
+  response.headers.set("Content-Type", resource.contentType);
+  response.headers.set("Content-Length", resource.contentLength.toString());
   if (resource.contentEncoding) {
-    reply.header("content-encoding", resource.contentEncoding);
+    response.headers.set("Content-Encoding", resource.contentEncoding);
   }
-  return reply.send(resource.stream);
+  return response;
 }
-function createServer(fastify, opts, done) {
-  const reader = "reader" in opts ? opts.reader : new Reader(opts.filepath);
-  if (!("reader" in opts)) {
-    fastify.addHook("onClose", () => reader.close().catch(noop));
-  }
-  fastify.get("/style.json", async () => {
-    try {
-      const baseUrl = new URL(fastify.prefix, fastify.listeningOrigin);
-      const style = await reader.getStyle(baseUrl.href);
-      return style;
-    } catch (error) {
-      if (isFileNotThereError(error)) {
-        throw createError(404, error.message);
-      }
-      throw error;
-    }
+const jsonRaw = createResponse("application/json; charset=utf-8");
+const encoder = new TextEncoder();
+function json(obj) {
+  const data = encoder.encode(JSON.stringify(obj));
+  return jsonRaw(data, {
+    headers: { "Content-Length": data.length.toString() }
   });
-  fastify.get("*", async (request, reply) => {
-    const path = request.params["*"];
-    try {
-      const resource = await reader.getResource(path);
-      return sendResource(reply, resource);
-    } catch (error) {
-      if (isFileNotThereError(error)) {
-        throw createError(404, error.message);
-      }
-      throw error;
-    }
+}
+function createServer({ base = "/" } = {}) {
+  base = base.endsWith("/") ? base : base + "/";
+  const router = IttyRouter({
+    base
+  }).get("/style.json", async (request, reader) => {
+    const baseUrl = new URL(base, request.url);
+    const style = await reader.getStyle(baseUrl.href);
+    return json(style);
+  }).get("*", async (request, reader) => {
+    const url = new URL(request.url);
+    const path = decodeURIComponent(url.pathname.slice(base.length - 1));
+    const resource = await reader.getResource(path);
+    return resourceResponse(resource);
   });
-  done();
+  return {
+    fetch: (request, reader) => {
+      return router.fetch(request, reader).catch((err) => {
+        if (isFileNotThereError(err)) {
+          throw new StatusError(404, "Not Found");
+        } else {
+          throw err;
+        }
+      });
+    }
+  };
 }
 export {
   createServer

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "styled-map-package",
-  "version": "3.0.0",
-  "description": "",
+  "version": "4.0.0",
+  "description": "A Styled Map Package (`.smp`) file is a Zip archive containing all the resources needed to serve a Maplibre vector styled map offline. This includes the style JSON, vector and raster tiles, glyphs (fonts), the sprite image, and the sprite metadata.",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -100,8 +100,8 @@
     "./package.json": "./package.json"
   },
   "bin": {
-    "styled-map-package": "./bin/smp.js",
-    "smp": "./bin/smp.js"
+    "styled-map-package": "bin/smp.js",
+    "smp": "bin/smp.js"
   },
   "files": [
     "bin",
@@ -121,23 +121,24 @@
   "license": "MIT",
   "dependencies": {
     "@commander-js/extra-typings": "^12.1.0",
-    "@fastify/static": "^7.0.4",
+    "@fastify/static": "^8.3.0",
     "@inquirer/prompts": "^6.0.1",
     "@mapbox/sphericalmercator": "^1.2.0",
     "@maplibre/maplibre-gl-style-spec": "^20.3.1",
     "@placemarkio/check-geojson": "^0.1.12",
     "@turf/bbox": "^7.2.0",
     "@turf/helpers": "^7.2.0",
+    "@whatwg-node/server": "^0.10.17",
     "ansi-diff": "^1.2.0",
     "archiver": "^7.0.1",
     "buffer-peek-stream": "^1.1.0",
     "chalk": "^5.4.1",
     "commander": "^12.1.0",
-    "fastify": "^4.28.1",
+    "fastify": "^5.6.2",
     "filter-obj": "^6.1.0",
-    "http-errors": "^2.0.0",
     "into-stream": "^8.0.1",
     "is-stream": "^4.0.1",
+    "itty-router": "^5.0.22",
     "ky": "^1.7.5",
     "log-symbols": "^7.0.0",
     "map-obj": "^5.0.2",
@@ -163,7 +164,7 @@
     "@types/geojson": "^7946.0.16",
     "@types/http-errors": "^2.0.4",
     "@types/mapbox__sphericalmercator": "^1.2.3",
-    "@types/node": "^20.16.3",
+    "@types/node": "^18.19.130",
     "@types/readable-stream": "^4.0.18",
     "@types/yauzl-promise": "^4.0.1",
     "ava": "^6.2.0",
@@ -183,7 +184,7 @@
     "tempy": "^3.1.0",
     "tsup": "^8.4.0",
     "type-fest": "^4.35.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.9.3"
   },
   "prettier": {
     "semi": false,
@@ -202,5 +203,16 @@
       "eslint --cache --fix"
     ],
     "*.{js,css,md}": "prettier --write"
+  },
+  "directories": {
+    "lib": "lib",
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/digidem/styled-map-package.git"
+  },
+  "bugs": {
+    "url": "https://github.com/digidem/styled-map-package/issues"
   }
 }