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

package/dist/utils/streams.js

@@ -0,0 +1,73 @@
+function readableFromAsync(iterable) {
+  if (typeof ReadableStream.from === "function") {
+    return ReadableStream.from(iterable);
+  }
+  const iterator = iterable[Symbol.asyncIterator]();
+  return new ReadableStream({
+    async pull(controller) {
+      const { value, done } = await iterator.next();
+      if (done) {
+        controller.close();
+      } else {
+        controller.enqueue(value);
+      }
+    },
+    async cancel(reason) {
+      await iterator.return?.(reason);
+    }
+  });
+}
+function writeStreamFromAsync(fn, { concurrency = 16 } = {}) {
+  const pending = /* @__PURE__ */ new Set();
+  return new WritableStream(
+    {
+      write(chunk) {
+        const p = fn(...chunk);
+        pending.add(p);
+        p.finally(() => pending.delete(p));
+        if (pending.size >= concurrency) {
+          return Promise.race(pending);
+        }
+      },
+      async close() {
+        await Promise.all(pending);
+      }
+    },
+    new CountQueuingStrategy({ highWaterMark: concurrency })
+  );
+}
+class ProgressStream {
+  #byteLength = 0;
+  #ts;
+  /**
+   * @param {{ onprogress?: ProgressCallback }} [opts]
+   */
+  constructor({ onprogress } = {}) {
+    const self = this;
+    this.#ts = new TransformStream({
+      transform(chunk, controller) {
+        self.#byteLength += chunk.byteLength;
+        onprogress?.({
+          totalBytes: self.#byteLength,
+          chunkBytes: chunk.byteLength
+        });
+        controller.enqueue(chunk);
+      }
+    });
+  }
+  get readable() {
+    return this.#ts.readable;
+  }
+  get writable() {
+    return this.#ts.writable;
+  }
+  /** Total bytes that have passed through this stream */
+  get byteLength() {
+    return this.#byteLength;
+  }
+}
+export {
+  ProgressStream,
+  readableFromAsync,
+  writeStreamFromAsync
+};

package/dist/utils/style.cjs

@@ -0,0 +1,126 @@
+"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 style_exports = {};
+__export(style_exports, {
+  assertTileJSON: () => assertTileJSON,
+  isInlinedSource: () => isInlinedSource,
+  mapFontStacks: () => mapFontStacks,
+  replaceFontStacks: () => replaceFontStacks,
+  validateStyle: () => validateStyle
+});
+module.exports = __toCommonJS(style_exports);
+var import_maplibre_gl_style_spec = require("@maplibre/maplibre-gl-style-spec");
+function replaceFontStacks(style, fonts) {
+  const mappedLayers = mapFontStacks(style.layers, (fontStack) => {
+    let match;
+    for (const font of fontStack) {
+      if (fonts.includes(font)) {
+        match = font;
+        break;
+      }
+    }
+    return [match || fonts[0]];
+  });
+  style.layers = mappedLayers;
+  return style;
+}
+function mapFontStacks(layers, callbackFn) {
+  return layers.map((layer) => {
+    if (layer.type !== "symbol" || !layer.layout || !layer.layout["text-font"])
+      return layer;
+    const textFont = layer.layout["text-font"];
+    let mappedValue;
+    if (isExpression(textFont)) {
+      mappedValue = mapArrayExpressionValue(textFont, callbackFn);
+    } else if (Array.isArray(textFont)) {
+      mappedValue = callbackFn(textFont);
+    } else {
+      console.warn(
+        "Deprecated function definitions are not supported, font stack has not been transformed."
+      );
+      console.dir(textFont, { depth: null });
+      return layer;
+    }
+    return {
+      ...layer,
+      layout: {
+        ...layer.layout,
+        "text-font": mappedValue
+      }
+    };
+  });
+}
+function isExpression(value) {
+  return Array.isArray(value) && value.length > 0 && typeof value[0] === "string" && value[0] in import_maplibre_gl_style_spec.expressions;
+}
+function mapArrayExpressionValue(expression, callbackFn) {
+  if (expression[0] === "literal" && Array.isArray(expression[1])) {
+    return ["literal", callbackFn(expression[1])];
+  } else {
+    return [
+      expression[0],
+      ...expression.slice(1).map(
+        // @ts-ignore
+        (x) => {
+          if (isExpression(x)) {
+            return mapArrayExpressionValue(x, callbackFn);
+          } else {
+            return x;
+          }
+        }
+      )
+    ];
+  }
+}
+function assertTileJSON(tilejson) {
+  if (typeof tilejson !== "object" || tilejson === null) {
+    throw new Error("Invalid TileJSON");
+  }
+  if (!("tiles" in tilejson) || !Array.isArray(tilejson.tiles) || tilejson.tiles.length === 0 || tilejson.tiles.some((tile) => typeof tile !== "string")) {
+    throw new Error("Invalid TileJSON: missing or invalid tiles property");
+  }
+}
+const validateStyle = (
+  /** @type {{ (style: unknown): style is StyleSpecification, errors: ValidationError[] }} */
+  ((style) => {
+    validateStyle.errors = (0, import_maplibre_gl_style_spec.validateStyleMin)(
+      /** @type {StyleSpecification} */
+      style
+    );
+    if (validateStyle.errors.length) return false;
+    return true;
+  })
+);
+function isInlinedSource(source) {
+  if (source.type === "geojson") {
+    return typeof source.data === "object";
+  } else if (source.type === "vector" || source.type === "raster" || source.type === "raster-dem") {
+    return "tiles" in source;
+  } else {
+    return true;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  assertTileJSON,
+  isInlinedSource,
+  mapFontStacks,
+  replaceFontStacks,
+  validateStyle
+});

package/dist/utils/style.d.cts

@@ -0,0 +1,67 @@
+import { BBox } from './geo.cjs';
+import { I as InlinedSource } from '../types-CJq90eOB.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' */
+/**
+ * For a given style, replace all font stacks (`text-field` properties) with the
+ * provided fonts. If no matching font is found, the first font in the stack is
+ * used.
+ *
+ * *Modifies the input style object*
+ *
+ * @param {StyleSpecification} style
+ * @param {string[]} fonts
+ */
+declare function replaceFontStacks(style: StyleSpecification, fonts: string[]): StyleSpecification;
+/**
+ * From given style layers, create a new style by calling the provided callback
+ * function on every font stack defined in the style.
+ *
+ * @param {StyleSpecification['layers']} layers
+ * @param {(fontStack: string[]) => string[]} callbackFn
+ * @returns {StyleSpecification['layers']}
+ */
+declare function mapFontStacks(layers: StyleSpecification["layers"], callbackFn: (fontStack: string[]) => string[]): StyleSpecification["layers"];
+/**
+ * @typedef {object} TileJSONPartial
+ * @property {string[]} tiles
+ * @property {string} [description]
+ * @property {string} [attribution]
+ * @property {object[]} [vector_layers]
+ * @property {import('./geo.js').BBox} [bounds]
+ * @property {number} [maxzoom]
+ * @property {number} [minzoom]
+ */
+/**
+ *
+ * @param {unknown} tilejson
+ * @returns {asserts tilejson is TileJSONPartial}
+ */
+declare function assertTileJSON(tilejson: unknown): asserts tilejson is TileJSONPartial;
+/**
+ * Check whether a source is already inlined (e.g. does not reference a TileJSON or GeoJSON url)
+ *
+ * @param {import('@maplibre/maplibre-gl-style-spec').SourceSpecification} source
+ * @returns {source is import('../types.js').InlinedSource}
+ */
+declare function isInlinedSource(source: _maplibre_maplibre_gl_style_spec.SourceSpecification): source is InlinedSource;
+declare const validateStyle: {
+    (style: unknown): style is StyleSpecification;
+    errors: ValidationError[];
+};
+type TileJSONPartial = {
+    tiles: string[];
+    description?: string | undefined;
+    attribution?: string | undefined;
+    vector_layers?: object[] | undefined;
+    bounds?: BBox | undefined;
+    maxzoom?: number | undefined;
+    minzoom?: number | undefined;
+};
+
+export { type TileJSONPartial, assertTileJSON, isInlinedSource, mapFontStacks, replaceFontStacks, validateStyle };

package/dist/utils/style.d.ts

@@ -0,0 +1,67 @@
+import { BBox } from './geo.js';
+import { I as InlinedSource } from '../types-CJq90eOB.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' */
+/**
+ * For a given style, replace all font stacks (`text-field` properties) with the
+ * provided fonts. If no matching font is found, the first font in the stack is
+ * used.
+ *
+ * *Modifies the input style object*
+ *
+ * @param {StyleSpecification} style
+ * @param {string[]} fonts
+ */
+declare function replaceFontStacks(style: StyleSpecification, fonts: string[]): StyleSpecification;
+/**
+ * From given style layers, create a new style by calling the provided callback
+ * function on every font stack defined in the style.
+ *
+ * @param {StyleSpecification['layers']} layers
+ * @param {(fontStack: string[]) => string[]} callbackFn
+ * @returns {StyleSpecification['layers']}
+ */
+declare function mapFontStacks(layers: StyleSpecification["layers"], callbackFn: (fontStack: string[]) => string[]): StyleSpecification["layers"];
+/**
+ * @typedef {object} TileJSONPartial
+ * @property {string[]} tiles
+ * @property {string} [description]
+ * @property {string} [attribution]
+ * @property {object[]} [vector_layers]
+ * @property {import('./geo.js').BBox} [bounds]
+ * @property {number} [maxzoom]
+ * @property {number} [minzoom]
+ */
+/**
+ *
+ * @param {unknown} tilejson
+ * @returns {asserts tilejson is TileJSONPartial}
+ */
+declare function assertTileJSON(tilejson: unknown): asserts tilejson is TileJSONPartial;
+/**
+ * Check whether a source is already inlined (e.g. does not reference a TileJSON or GeoJSON url)
+ *
+ * @param {import('@maplibre/maplibre-gl-style-spec').SourceSpecification} source
+ * @returns {source is import('../types.js').InlinedSource}
+ */
+declare function isInlinedSource(source: _maplibre_maplibre_gl_style_spec.SourceSpecification): source is InlinedSource;
+declare const validateStyle: {
+    (style: unknown): style is StyleSpecification;
+    errors: ValidationError[];
+};
+type TileJSONPartial = {
+    tiles: string[];
+    description?: string | undefined;
+    attribution?: string | undefined;
+    vector_layers?: object[] | undefined;
+    bounds?: BBox | undefined;
+    maxzoom?: number | undefined;
+    minzoom?: number | undefined;
+};
+
+export { type TileJSONPartial, assertTileJSON, isInlinedSource, mapFontStacks, replaceFontStacks, validateStyle };

package/dist/utils/style.js

@@ -0,0 +1,98 @@
+import { expressions, validateStyleMin } from "@maplibre/maplibre-gl-style-spec";
+function replaceFontStacks(style, fonts) {
+  const mappedLayers = mapFontStacks(style.layers, (fontStack) => {
+    let match;
+    for (const font of fontStack) {
+      if (fonts.includes(font)) {
+        match = font;
+        break;
+      }
+    }
+    return [match || fonts[0]];
+  });
+  style.layers = mappedLayers;
+  return style;
+}
+function mapFontStacks(layers, callbackFn) {
+  return layers.map((layer) => {
+    if (layer.type !== "symbol" || !layer.layout || !layer.layout["text-font"])
+      return layer;
+    const textFont = layer.layout["text-font"];
+    let mappedValue;
+    if (isExpression(textFont)) {
+      mappedValue = mapArrayExpressionValue(textFont, callbackFn);
+    } else if (Array.isArray(textFont)) {
+      mappedValue = callbackFn(textFont);
+    } else {
+      console.warn(
+        "Deprecated function definitions are not supported, font stack has not been transformed."
+      );
+      console.dir(textFont, { depth: null });
+      return layer;
+    }
+    return {
+      ...layer,
+      layout: {
+        ...layer.layout,
+        "text-font": mappedValue
+      }
+    };
+  });
+}
+function isExpression(value) {
+  return Array.isArray(value) && value.length > 0 && typeof value[0] === "string" && value[0] in expressions;
+}
+function mapArrayExpressionValue(expression, callbackFn) {
+  if (expression[0] === "literal" && Array.isArray(expression[1])) {
+    return ["literal", callbackFn(expression[1])];
+  } else {
+    return [
+      expression[0],
+      ...expression.slice(1).map(
+        // @ts-ignore
+        (x) => {
+          if (isExpression(x)) {
+            return mapArrayExpressionValue(x, callbackFn);
+          } else {
+            return x;
+          }
+        }
+      )
+    ];
+  }
+}
+function assertTileJSON(tilejson) {
+  if (typeof tilejson !== "object" || tilejson === null) {
+    throw new Error("Invalid TileJSON");
+  }
+  if (!("tiles" in tilejson) || !Array.isArray(tilejson.tiles) || tilejson.tiles.length === 0 || tilejson.tiles.some((tile) => typeof tile !== "string")) {
+    throw new Error("Invalid TileJSON: missing or invalid tiles property");
+  }
+}
+const validateStyle = (
+  /** @type {{ (style: unknown): style is StyleSpecification, errors: ValidationError[] }} */
+  ((style) => {
+    validateStyle.errors = validateStyleMin(
+      /** @type {StyleSpecification} */
+      style
+    );
+    if (validateStyle.errors.length) return false;
+    return true;
+  })
+);
+function isInlinedSource(source) {
+  if (source.type === "geojson") {
+    return typeof source.data === "object";
+  } else if (source.type === "vector" || source.type === "raster" || source.type === "raster-dem") {
+    return "tiles" in source;
+  } else {
+    return true;
+  }
+}
+export {
+  assertTileJSON,
+  isInlinedSource,
+  mapFontStacks,
+  replaceFontStacks,
+  validateStyle
+};

package/dist/utils/templates.cjs

@@ -0,0 +1,124 @@
+"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 templates_exports = {};
+__export(templates_exports, {
+  FONTS_FOLDER: () => FONTS_FOLDER,
+  FORMAT_VERSION: () => FORMAT_VERSION,
+  GLYPH_URI: () => GLYPH_URI,
+  SOURCES_FOLDER: () => SOURCES_FOLDER,
+  STYLE_FILE: () => STYLE_FILE,
+  URI_BASE: () => URI_BASE,
+  URI_SCHEME: () => URI_SCHEME,
+  VERSION_FILE: () => VERSION_FILE,
+  getContentType: () => getContentType,
+  getGlyphFilename: () => getGlyphFilename,
+  getResourceType: () => getResourceType,
+  getSpriteFilename: () => getSpriteFilename,
+  getSpriteUri: () => getSpriteUri,
+  getTileFilename: () => getTileFilename,
+  getTileUri: () => getTileUri,
+  replaceVariables: () => replaceVariables
+});
+module.exports = __toCommonJS(templates_exports);
+const URI_SCHEME = "smp";
+const URI_BASE = URI_SCHEME + "://maps.v1/";
+const VERSION_FILE = "VERSION";
+const FORMAT_VERSION = "1.0";
+const STYLE_FILE = "style.json";
+const SOURCES_FOLDER = "s";
+const SPRITES_FOLDER = "sprites";
+const FONTS_FOLDER = "fonts";
+const TILE_FILE = SOURCES_FOLDER + "/{sourceId}/{z}/{x}/{y}{ext}";
+const SPRITE_FILE = SPRITES_FOLDER + "/{id}/sprite{pixelRatio}{ext}";
+const GLYPH_FILE = FONTS_FOLDER + "/{fontstack}/{range}.pbf.gz";
+const GLYPH_URI = URI_BASE + GLYPH_FILE;
+const pathToResouceType = (
+  /** @type {const} */
+  {
+    [TILE_FILE.split("/")[0] + "/"]: "tile",
+    [SPRITE_FILE.split("/")[0] + "/"]: "sprite",
+    [GLYPH_FILE.split("/")[0] + "/"]: "glyph"
+  }
+);
+function getResourceType(path) {
+  if (path === "style.json") return "style";
+  for (const [prefix, type] of Object.entries(pathToResouceType)) {
+    if (path.startsWith(prefix)) return type;
+  }
+  throw new Error(`Unknown resource type for path: ${path}`);
+}
+function getContentType(path) {
+  if (path.endsWith(".json")) return "application/json; charset=utf-8";
+  if (path.endsWith(".pbf.gz") || path.endsWith(".pbf"))
+    return "application/x-protobuf";
+  if (path.endsWith(".png")) return "image/png";
+  if (path.endsWith(".jpg")) return "image/jpeg";
+  if (path.endsWith(".webp")) return "image/webp";
+  if (path.endsWith(".mvt.gz") || path.endsWith(".mvt"))
+    return "application/vnd.mapbox-vector-tile";
+  throw new Error(`Unknown content type for path: ${path}`);
+}
+function getTileFilename({ sourceId, z, x, y, format }) {
+  const ext = "." + format + (format === "mvt" ? ".gz" : "");
+  return replaceVariables(TILE_FILE, { sourceId, z, x, y, ext });
+}
+function getSpriteFilename({ id, pixelRatio, ext }) {
+  return replaceVariables(SPRITE_FILE, {
+    id,
+    pixelRatio: getPixelRatioString(pixelRatio),
+    ext
+  });
+}
+function getGlyphFilename({ fontstack, range }) {
+  return replaceVariables(GLYPH_FILE, { fontstack, range });
+}
+function getSpriteUri(id = "default") {
+  return URI_BASE + replaceVariables(SPRITE_FILE, { id, pixelRatio: "", ext: "" });
+}
+function getTileUri({ sourceId, format }) {
+  const ext = "." + format + (format === "mvt" ? ".gz" : "");
+  return URI_BASE + TILE_FILE.replace("{sourceId}", sourceId).replace("{ext}", ext);
+}
+function getPixelRatioString(pixelRatio) {
+  return pixelRatio === 1 ? "" : `@${pixelRatio}x`;
+}
+function replaceVariables(template, variables) {
+  return template.replace(/{(.*?)}/g, (match, varName) => {
+    return varName in variables ? String(variables[varName]) : match;
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FONTS_FOLDER,
+  FORMAT_VERSION,
+  GLYPH_URI,
+  SOURCES_FOLDER,
+  STYLE_FILE,
+  URI_BASE,
+  URI_SCHEME,
+  VERSION_FILE,
+  getContentType,
+  getGlyphFilename,
+  getResourceType,
+  getSpriteFilename,
+  getSpriteUri,
+  getTileFilename,
+  getTileUri,
+  replaceVariables
+});

package/dist/utils/templates.d.cts

@@ -0,0 +1,80 @@
+import * as type_fest from 'type-fest';
+import { d as GlyphRange, T as TileInfo, c as TileFormat } from '../types-CJq90eOB.cjs';
+import '@maplibre/maplibre-gl-style-spec';
+import 'geojson';
+import 'events';
+
+/**
+ * @param {string} path
+ * @returns
+ */
+declare function getResourceType(path: string): "sprite" | "style" | "tile" | "glyph";
+/**
+ * Determine the content type of a file based on its extension.
+ *
+ * @param {string} path
+ */
+declare function getContentType(path: string): "application/json; charset=utf-8" | "application/x-protobuf" | "image/png" | "image/jpeg" | "image/webp" | "application/vnd.mapbox-vector-tile";
+/**
+ * Get the filename for a tile, given the TileInfo
+ *
+ * @param {import("type-fest").SetRequired<import("../writer.js").TileInfo, 'format'>} tileInfo
+ * @returns
+ */
+declare function getTileFilename({ sourceId, z, x, y, format }: type_fest.SetRequired<TileInfo, "format">): string;
+/**
+ * Get a filename for a sprite file, given the sprite id, pixel ratio and extension
+ *
+ * @param {{ id: string, pixelRatio: number, ext: '.json' | '.png'}} spriteInfo
+ */
+declare function getSpriteFilename({ id, pixelRatio, ext }: {
+    id: string;
+    pixelRatio: number;
+    ext: ".json" | ".png";
+}): string;
+/**
+ * Get the filename for a glyph file, given the fontstack and range
+ *
+ * @param {object} options
+ * @param {string} options.fontstack
+ * @param {import("../writer.js").GlyphRange} options.range
+ */
+declare function getGlyphFilename({ fontstack, range }: {
+    fontstack: string;
+    range: GlyphRange;
+}): string;
+/**
+ * Get the URI template for the sprites in the style
+ */
+declare function getSpriteUri(id?: string): string;
+/**
+ * Get the URI template for tiles in the style
+ *
+ * @param {object} opts
+ * @param {string} opts.sourceId
+ * @param {import("../writer.js").TileFormat} opts.format
+ * @returns
+ */
+declare function getTileUri({ sourceId, format }: {
+    sourceId: string;
+    format: TileFormat;
+}): string;
+/**
+ * Replaces variables in a string with values provided in an object. Variables
+ * in the string are denoted by curly braces, e.g., {variableName}.
+ *
+ * @param {string} template - The string containing variables wrapped in curly braces.
+ * @param {Record<string, string | number>} variables - An object where the keys correspond to variable names and values correspond to the replacement values.
+ * @returns {string} The string with the variables replaced by their corresponding values.
+ */
+declare function replaceVariables(template: string, variables: Record<string, string | number>): string;
+declare const URI_SCHEME: "smp";
+declare const URI_BASE: string;
+declare const VERSION_FILE: "VERSION";
+declare const FORMAT_VERSION: "1.0";
+declare const STYLE_FILE: "style.json";
+declare const SOURCES_FOLDER: "s";
+declare const FONTS_FOLDER: "fonts";
+declare const GLYPH_URI: string;
+
+export { FONTS_FOLDER, FORMAT_VERSION, GLYPH_URI, SOURCES_FOLDER, STYLE_FILE, URI_BASE, URI_SCHEME, VERSION_FILE, getContentType, getGlyphFilename, getResourceType, getSpriteFilename, getSpriteUri, getTileFilename, getTileUri, replaceVariables };