@superrouteca/smap 0.0.0-stage → 1.0.1

package/dist/vendor-licenses.txt

@@ -0,0 +1,116 @@
+Copyright (c) 2023, MapLibre contributors
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of MapLibre GL JS nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+-------------------------------------------------------------------------------
+
+Contains code from mapbox-gl-js v1.13 and earlier
+
+Version v1.13 of mapbox-gl-js and earlier are licensed under a BSD-3-Clause license
+
+Copyright (c) 2020, Mapbox
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of Mapbox GL JS nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+-------------------------------------------------------------------------------
+
+Contains code from glfx.js
+
+Copyright (C) 2011 by Evan Wallace
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+Contains a portion of d3-color https://github.com/d3/d3-color
+
+Copyright 2010-2016 Mike Bostock
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author nor the names of contributors may be used to
+  endorse or promote products derived from this software without specific prior
+  written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/package.json

@@ -1,6 +1,69 @@
 {
   "name": "@superrouteca/smap",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "sMap for the web: maps from Superroute's sMap service, the Web SDK (map view) and the JS client (tokens, nearest node, styles, tiles).",
+  "license": "MIT",
+  "author": "Goodneo Solutions",
+  "homepage": "https://github.com/Goodneo-Solutions/smap-sdk/tree/main/js#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Goodneo-Solutions/smap-sdk.git",
+    "directory": "js"
+  },
+  "keywords": [
+    "map",
+    "maps",
+    "vector-tiles",
+    "smap",
+    "superroute"
+  ],
+  "sideEffects": [
+    "*.css"
+  ],
+  "main": "./dist/smap.cjs",
+  "module": "./dist/smap.mjs",
+  "types": "./types/smap.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/smap.d.mts",
+        "default": "./dist/smap.mjs"
+      },
+      "require": {
+        "types": "./types/smap.d.cts",
+        "default": "./dist/smap.cjs"
+      }
+    },
+    "./client": {
+      "import": {
+        "types": "./dist/smap-client.d.mts",
+        "default": "./dist/smap-client.mjs"
+      },
+      "require": {
+        "types": "./dist/smap-client.d.cts",
+        "default": "./dist/smap-client.cjs"
+      }
+    },
+    "./smap.css": "./dist/smap.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "types",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "node build.mjs",
+    "prepack": "cp ../LICENSE LICENSE",
+    "test": "node --test test/*.test.mjs test/*.test.cjs"
+  },
+  "devDependencies": {
+    "esbuild": "0.28.2",
+    "maplibre-gl": "6.16.0"
+  }
+}

package/types/smap.d.cts

@@ -0,0 +1,185 @@
+// Types of the sMap Web SDK (`@superrouteca/smap`). Kept by hand beside the generated code in dist/; smap.d.mts and
+// smap.d.cts hold the same text (test/types.test.mjs checks).
+
+export type StyleFlavor = 'light' | 'white' | 'grayscale' | 'dark' | 'black';
+
+/** A position as [longitude, latitude]. */
+export type LngLatLike = [number, number] | { lng: number; lat: number } | { lon: number; lat: number };
+
+export type GeoJSONGeometry = { type: string; coordinates?: unknown; geometries?: unknown[] };
+export interface GeoJSONFeature<P = Record<string, unknown>> {
+  type: 'Feature';
+  id?: string | number;
+  properties: P | null;
+  geometry: GeoJSONGeometry;
+}
+export interface GeoJSONFeatureCollection<P = Record<string, unknown>> {
+  type: 'FeatureCollection';
+  features: GeoJSONFeature<P>[];
+}
+
+/** A point given as an object: `{lng, lat}` (or `lon` / `longitude` / `latitude`, or `coordinates`) plus properties. */
+export interface PointInput {
+  lat?: number;
+  lng?: number;
+  lon?: number;
+  latitude?: number;
+  longitude?: number;
+  coordinates?: [number, number];
+  id?: string | number;
+  [property: string]: unknown;
+}
+
+/** Layer data: GeoJSON (a FeatureCollection or a Feature) or an array of points or features. */
+export type LayerData = GeoJSONFeatureCollection | GeoJSONFeature | Array<PointInput | GeoJSONFeature> | null | undefined;
+
+/** The event of a click on a layer's feature (the engine's map mouse event). */
+export interface LayerClickEvent {
+  lngLat: { lng: number; lat: number };
+  point: { x: number; y: number };
+  features?: GeoJSONFeature[];
+  originalEvent?: Event;
+  [key: string]: unknown;
+}
+
+interface CommonLayerOptions {
+  /** Higher draws on top; equal values keep the order added. */
+  zIndex?: number;
+  minzoom?: number;
+  maxzoom?: number;
+  /** A feature property used as the feature id. */
+  idProperty?: string;
+  /**
+   * A popup opened on click, from the clicked feature's properties: an HTML string, inserted as it is and never
+   * sanitized (so it must be trusted; escape any feature data you put in it), or a DOM node.
+   */
+  popup?: (properties: Record<string, unknown>, feature: GeoJSONFeature) => string | Node | null | undefined | false;
+  onClick?: (feature: GeoJSONFeature, event: LayerClickEvent) => void;
+}
+
+export interface PointOptions extends CommonLayerOptions {
+  /** Groups nearby points into circles sized by their count; a click zooms in to split them. */
+  cluster?: boolean | { radius?: number; maxZoom?: number };
+  clusterColor?: string;
+  color?: string;
+  radius?: number;
+  strokeColor?: string;
+  strokeWidth?: number;
+  /** An image URL drawn instead of a circle. */
+  icon?: string;
+  iconSize?: number;
+  iconAnchor?: string;
+  /** The property written under each point. */
+  label?: string;
+}
+
+export interface LineOptions extends CommonLayerOptions {
+  color?: string;
+  width?: number;
+  /** Dash and gap lengths in line widths, e.g. [2, 2]. */
+  dash?: number[];
+  opacity?: number;
+}
+
+export interface PolygonOptions extends CommonLayerOptions {
+  fill?: string;
+  color?: string;
+  opacity?: number;
+  outline?: string;
+  outlineWidth?: number;
+  /** Draws the areas in 3D: a height and a base in metres, each a number or the name of a property. */
+  extrude?: { height?: number | string; base?: number | string };
+}
+
+export interface BuildingsOptions {
+  color?: string;
+  opacity?: number;
+}
+
+export interface MapOptions {
+  /** The element (or its id) the map is drawn in. */
+  container: string | HTMLElement;
+  /** A map token; or */
+  token?: string;
+  /** Called at start and again two minutes before each token expires. */
+  getToken?: () => string | Promise<string>;
+  /** A map key (`smk_…`) whose allowlist names this site; with a token both are sent and the token is checked first. */
+  apiKey?: string;
+  /** A colour scheme, or a style URL or object of your own. */
+  style?: StyleFlavor | string | Record<string, unknown>;
+  /** Label language as a BCP-47 tag (`en`, `fr`, `zh-Hans`, …); the browser language by default. */
+  language?: string;
+  /** The map service, `https://tile.srsr.ca` by default. */
+  baseUrl?: string;
+  /** Read from the nearest service node (default true). */
+  nearest?: boolean;
+  /** Node URLs known in advance, used while `baseUrl` is down. */
+  nodes?: string[];
+  projection?: 'mercator' | 'globe';
+  center?: LngLatLike;
+  zoom?: number;
+  bearing?: number;
+  pitch?: number;
+  minZoom?: number;
+  maxZoom?: number;
+  /** Every other option goes to the rendering engine. */
+  [engineOption: string]: unknown;
+}
+
+export interface FlyToOptions {
+  center?: LngLatLike;
+  zoom?: number;
+  bearing?: number;
+  pitch?: number;
+  duration?: number;
+  [engineOption: string]: unknown;
+}
+
+export interface FitOptions {
+  padding?: number | { top?: number; bottom?: number; left?: number; right?: number };
+  maxZoom?: number;
+  duration?: number;
+  [engineOption: string]: unknown;
+}
+
+/** A map. Create it in a browser only (the constructor throws elsewhere). */
+export declare class Map {
+  constructor(options: MapOptions);
+  /** Resolves once the first style has loaded. */
+  readonly ready: Promise<Map>;
+  /** The rendering engine's map, for anything the SDK does not wrap (set once `ready` resolves). */
+  readonly engine: any;
+  setStyle(style: StyleFlavor | string | Record<string, unknown>): this;
+  setLanguage(language: string): this;
+  setProjection(projection: 'mercator' | 'globe'): this;
+  setBuildings3D(on: boolean, options?: BuildingsOptions): this;
+  addPoints(id: string, data: LayerData, options?: PointOptions): this;
+  addLines(id: string, data: LayerData, options?: LineOptions): this;
+  addPolygons(id: string, data: LayerData, options?: PolygonOptions): this;
+  setData(id: string, data: LayerData): this;
+  setVisible(id: string, visible: boolean): this;
+  removeLayer(id: string): this;
+  /** Layer ids in draw order, bottom first. */
+  layers(): string[];
+  fitLayer(id: string, options?: FitOptions): this;
+  flyTo(options: FlyToOptions): this;
+  on(type: string, ...args: any[]): this;
+  off(type: string, ...args: any[]): this;
+  once(type: string, ...args: any[]): any;
+  remove(): void;
+}
+
+/** The SDK version. */
+export declare const version: string;
+/** The colour schemes. */
+export declare const styles: StyleFlavor[];
+/** The bundled rendering engine, for anything the SDK does not wrap (loaded on the first call). */
+export declare function getEngine(): any;
+
+declare const sMap: {
+  Map: typeof Map;
+  version: string;
+  styles: StyleFlavor[];
+  getEngine: typeof getEngine;
+};
+export default sMap;

package/types/smap.d.mts

@@ -0,0 +1,185 @@
+// Types of the sMap Web SDK (`@superrouteca/smap`). Kept by hand beside the generated code in dist/; smap.d.mts and
+// smap.d.cts hold the same text (test/types.test.mjs checks).
+
+export type StyleFlavor = 'light' | 'white' | 'grayscale' | 'dark' | 'black';
+
+/** A position as [longitude, latitude]. */
+export type LngLatLike = [number, number] | { lng: number; lat: number } | { lon: number; lat: number };
+
+export type GeoJSONGeometry = { type: string; coordinates?: unknown; geometries?: unknown[] };
+export interface GeoJSONFeature<P = Record<string, unknown>> {
+  type: 'Feature';
+  id?: string | number;
+  properties: P | null;
+  geometry: GeoJSONGeometry;
+}
+export interface GeoJSONFeatureCollection<P = Record<string, unknown>> {
+  type: 'FeatureCollection';
+  features: GeoJSONFeature<P>[];
+}
+
+/** A point given as an object: `{lng, lat}` (or `lon` / `longitude` / `latitude`, or `coordinates`) plus properties. */
+export interface PointInput {
+  lat?: number;
+  lng?: number;
+  lon?: number;
+  latitude?: number;
+  longitude?: number;
+  coordinates?: [number, number];
+  id?: string | number;
+  [property: string]: unknown;
+}
+
+/** Layer data: GeoJSON (a FeatureCollection or a Feature) or an array of points or features. */
+export type LayerData = GeoJSONFeatureCollection | GeoJSONFeature | Array<PointInput | GeoJSONFeature> | null | undefined;
+
+/** The event of a click on a layer's feature (the engine's map mouse event). */
+export interface LayerClickEvent {
+  lngLat: { lng: number; lat: number };
+  point: { x: number; y: number };
+  features?: GeoJSONFeature[];
+  originalEvent?: Event;
+  [key: string]: unknown;
+}
+
+interface CommonLayerOptions {
+  /** Higher draws on top; equal values keep the order added. */
+  zIndex?: number;
+  minzoom?: number;
+  maxzoom?: number;
+  /** A feature property used as the feature id. */
+  idProperty?: string;
+  /**
+   * A popup opened on click, from the clicked feature's properties: an HTML string, inserted as it is and never
+   * sanitized (so it must be trusted; escape any feature data you put in it), or a DOM node.
+   */
+  popup?: (properties: Record<string, unknown>, feature: GeoJSONFeature) => string | Node | null | undefined | false;
+  onClick?: (feature: GeoJSONFeature, event: LayerClickEvent) => void;
+}
+
+export interface PointOptions extends CommonLayerOptions {
+  /** Groups nearby points into circles sized by their count; a click zooms in to split them. */
+  cluster?: boolean | { radius?: number; maxZoom?: number };
+  clusterColor?: string;
+  color?: string;
+  radius?: number;
+  strokeColor?: string;
+  strokeWidth?: number;
+  /** An image URL drawn instead of a circle. */
+  icon?: string;
+  iconSize?: number;
+  iconAnchor?: string;
+  /** The property written under each point. */
+  label?: string;
+}
+
+export interface LineOptions extends CommonLayerOptions {
+  color?: string;
+  width?: number;
+  /** Dash and gap lengths in line widths, e.g. [2, 2]. */
+  dash?: number[];
+  opacity?: number;
+}
+
+export interface PolygonOptions extends CommonLayerOptions {
+  fill?: string;
+  color?: string;
+  opacity?: number;
+  outline?: string;
+  outlineWidth?: number;
+  /** Draws the areas in 3D: a height and a base in metres, each a number or the name of a property. */
+  extrude?: { height?: number | string; base?: number | string };
+}
+
+export interface BuildingsOptions {
+  color?: string;
+  opacity?: number;
+}
+
+export interface MapOptions {
+  /** The element (or its id) the map is drawn in. */
+  container: string | HTMLElement;
+  /** A map token; or */
+  token?: string;
+  /** Called at start and again two minutes before each token expires. */
+  getToken?: () => string | Promise<string>;
+  /** A map key (`smk_…`) whose allowlist names this site; with a token both are sent and the token is checked first. */
+  apiKey?: string;
+  /** A colour scheme, or a style URL or object of your own. */
+  style?: StyleFlavor | string | Record<string, unknown>;
+  /** Label language as a BCP-47 tag (`en`, `fr`, `zh-Hans`, …); the browser language by default. */
+  language?: string;
+  /** The map service, `https://tile.srsr.ca` by default. */
+  baseUrl?: string;
+  /** Read from the nearest service node (default true). */
+  nearest?: boolean;
+  /** Node URLs known in advance, used while `baseUrl` is down. */
+  nodes?: string[];
+  projection?: 'mercator' | 'globe';
+  center?: LngLatLike;
+  zoom?: number;
+  bearing?: number;
+  pitch?: number;
+  minZoom?: number;
+  maxZoom?: number;
+  /** Every other option goes to the rendering engine. */
+  [engineOption: string]: unknown;
+}
+
+export interface FlyToOptions {
+  center?: LngLatLike;
+  zoom?: number;
+  bearing?: number;
+  pitch?: number;
+  duration?: number;
+  [engineOption: string]: unknown;
+}
+
+export interface FitOptions {
+  padding?: number | { top?: number; bottom?: number; left?: number; right?: number };
+  maxZoom?: number;
+  duration?: number;
+  [engineOption: string]: unknown;
+}
+
+/** A map. Create it in a browser only (the constructor throws elsewhere). */
+export declare class Map {
+  constructor(options: MapOptions);
+  /** Resolves once the first style has loaded. */
+  readonly ready: Promise<Map>;
+  /** The rendering engine's map, for anything the SDK does not wrap (set once `ready` resolves). */
+  readonly engine: any;
+  setStyle(style: StyleFlavor | string | Record<string, unknown>): this;
+  setLanguage(language: string): this;
+  setProjection(projection: 'mercator' | 'globe'): this;
+  setBuildings3D(on: boolean, options?: BuildingsOptions): this;
+  addPoints(id: string, data: LayerData, options?: PointOptions): this;
+  addLines(id: string, data: LayerData, options?: LineOptions): this;
+  addPolygons(id: string, data: LayerData, options?: PolygonOptions): this;
+  setData(id: string, data: LayerData): this;
+  setVisible(id: string, visible: boolean): this;
+  removeLayer(id: string): this;
+  /** Layer ids in draw order, bottom first. */
+  layers(): string[];
+  fitLayer(id: string, options?: FitOptions): this;
+  flyTo(options: FlyToOptions): this;
+  on(type: string, ...args: any[]): this;
+  off(type: string, ...args: any[]): this;
+  once(type: string, ...args: any[]): any;
+  remove(): void;
+}
+
+/** The SDK version. */
+export declare const version: string;
+/** The colour schemes. */
+export declare const styles: StyleFlavor[];
+/** The bundled rendering engine, for anything the SDK does not wrap (loaded on the first call). */
+export declare function getEngine(): any;
+
+declare const sMap: {
+  Map: typeof Map;
+  version: string;
+  styles: StyleFlavor[];
+  getEngine: typeof getEngine;
+};
+export default sMap;