dotted-map 2.2.3 → 3.1.0

package/dist/types-F6gvGCSl.d.mts

@@ -0,0 +1,80 @@
+//#region src/types.d.ts
+type ProjectionName = 'mercator' | 'equirectangular' | 'robinson' | 'equalEarth' | 'mollweide' | 'miller' | 'sinusoidal' | 'orthographic' | 'gallPeters' | 'vanDerGrinten';
+interface Projection {
+  name: ProjectionName;
+  center?: {
+    lat: number;
+    lng: number;
+  };
+}
+interface Region {
+  lat: {
+    min: number;
+    max: number;
+  };
+  lng: {
+    min: number;
+    max: number;
+  };
+}
+interface MapSettings {
+  height?: number;
+  width?: number;
+  countries?: string[];
+  region?: Region;
+  grid?: 'vertical' | 'diagonal';
+  projection?: Projection;
+}
+interface DottedMapSettings extends MapSettings {
+  avoidOuterPins?: boolean;
+}
+interface DottedMapWithoutCountriesSettings {
+  map: MapData;
+  avoidOuterPins?: boolean;
+}
+interface SvgOptions {
+  color?: string;
+  radius?: number;
+}
+interface PinInput {
+  lat: number;
+  lng: number;
+  data?: unknown;
+  svgOptions?: SvgOptions;
+}
+interface SvgSettings {
+  shape?: 'circle' | 'hexagon';
+  color?: string;
+  backgroundColor?: string;
+  radius?: number;
+}
+interface Point {
+  x: number;
+  y: number;
+  lat?: number;
+  lng?: number;
+  data?: unknown;
+  svgOptions?: SvgOptions;
+}
+interface MapData {
+  points: Record<string, Point>;
+  X_MIN: number;
+  Y_MIN: number;
+  X_MAX: number;
+  Y_MAX: number;
+  X_RANGE: number;
+  Y_RANGE: number;
+  region: Region;
+  grid: 'vertical' | 'diagonal';
+  height: number;
+  width: number;
+  ystep: number;
+  projection?: Projection;
+}
+interface ImageInfo {
+  region: Region;
+  width: number;
+  height: number;
+}
+//#endregion
+export { MapSettings as a, Projection as c, SvgSettings as d, MapData as i, ProjectionName as l, DottedMapWithoutCountriesSettings as n, PinInput as o, ImageInfo as r, Point as s, DottedMapSettings as t, Region as u };

package/dist/types-vOcy-UuQ.d.cts

@@ -0,0 +1,80 @@
+//#region src/types.d.ts
+type ProjectionName = 'mercator' | 'equirectangular' | 'robinson' | 'equalEarth' | 'mollweide' | 'miller' | 'sinusoidal' | 'orthographic' | 'gallPeters' | 'vanDerGrinten';
+interface Projection {
+  name: ProjectionName;
+  center?: {
+    lat: number;
+    lng: number;
+  };
+}
+interface Region {
+  lat: {
+    min: number;
+    max: number;
+  };
+  lng: {
+    min: number;
+    max: number;
+  };
+}
+interface MapSettings {
+  height?: number;
+  width?: number;
+  countries?: string[];
+  region?: Region;
+  grid?: 'vertical' | 'diagonal';
+  projection?: Projection;
+}
+interface DottedMapSettings extends MapSettings {
+  avoidOuterPins?: boolean;
+}
+interface DottedMapWithoutCountriesSettings {
+  map: MapData;
+  avoidOuterPins?: boolean;
+}
+interface SvgOptions {
+  color?: string;
+  radius?: number;
+}
+interface PinInput {
+  lat: number;
+  lng: number;
+  data?: unknown;
+  svgOptions?: SvgOptions;
+}
+interface SvgSettings {
+  shape?: 'circle' | 'hexagon';
+  color?: string;
+  backgroundColor?: string;
+  radius?: number;
+}
+interface Point {
+  x: number;
+  y: number;
+  lat?: number;
+  lng?: number;
+  data?: unknown;
+  svgOptions?: SvgOptions;
+}
+interface MapData {
+  points: Record<string, Point>;
+  X_MIN: number;
+  Y_MIN: number;
+  X_MAX: number;
+  Y_MAX: number;
+  X_RANGE: number;
+  Y_RANGE: number;
+  region: Region;
+  grid: 'vertical' | 'diagonal';
+  height: number;
+  width: number;
+  ystep: number;
+  projection?: Projection;
+}
+interface ImageInfo {
+  region: Region;
+  width: number;
+  height: number;
+}
+//#endregion
+export { MapSettings as a, Projection as c, SvgSettings as d, MapData as i, ProjectionName as l, DottedMapWithoutCountriesSettings as n, PinInput as o, ImageInfo as r, Point as s, DottedMapSettings as t, Region as u };

package/dist/without-countries.cjs

@@ -0,0 +1,109 @@
+const require_chunk = require('./chunk-C0xms8kb.cjs');
+let proj4 = require("proj4");
+proj4 = require_chunk.__toESM(proj4);
+
+//#region src/without-countries.ts
+const PROJECTIONS = {
+	mercator: "+proj=merc +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	equirectangular: "+proj=eqc +lon_0={lng} +lat_ts=0 +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	robinson: "+proj=robin +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	equalEarth: "+proj=eqearth +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	mollweide: "+proj=moll +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	miller: "+proj=mill +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	sinusoidal: "+proj=sinu +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	orthographic: "+proj=ortho +lat_0={lat} +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	gallPeters: "+proj=cea +lon_0={lng} +lat_ts=45 +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	vanDerGrinten: "+proj=vandg +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m"
+};
+const DEFAULT_PROJECTION = { name: "mercator" };
+const getProj4String = (projection = DEFAULT_PROJECTION) => {
+	const template = PROJECTIONS[projection.name];
+	const lat = projection.center?.lat ?? 0;
+	const lng = projection.center?.lng ?? 0;
+	return template.replace("{lat}", String(lat)).replace("{lng}", String(lng));
+};
+var DottedMapWithoutCountries = class {
+	constructor({ map, avoidOuterPins = false }) {
+		this.points = map.points;
+		this.pins = [];
+		this.X_MIN = map.X_MIN;
+		this.Y_MAX = map.Y_MAX;
+		this.X_RANGE = map.X_RANGE;
+		this.Y_RANGE = map.Y_RANGE;
+		this.grid = map.grid;
+		this.width = map.width;
+		this.height = map.height;
+		this.ystep = map.ystep;
+		this.avoidOuterPins = avoidOuterPins;
+		this.proj4String = getProj4String(map.projection ?? DEFAULT_PROJECTION);
+		this.image = {
+			region: map.region,
+			width: map.width,
+			height: map.height
+		};
+	}
+	addPin({ lat, lng, data, svgOptions }) {
+		const pin = this.getPin({
+			lat,
+			lng
+		});
+		if (!pin) return void 0;
+		const point = {
+			...pin,
+			data,
+			svgOptions
+		};
+		this.pins.push(point);
+		return point;
+	}
+	getPin({ lat, lng }) {
+		const projected = (0, proj4.default)(this.proj4String, [lng, lat]);
+		if (!projected.every((v) => Number.isFinite(v))) return;
+		const [projX, projY] = projected;
+		if (this.avoidOuterPins) return;
+		let rawX = this.width * (projX - this.X_MIN) / this.X_RANGE;
+		const rawY = this.height * (this.Y_MAX - projY) / this.Y_RANGE;
+		const y = Math.round(rawY / this.ystep);
+		if (y % 2 === 0 && this.grid === "diagonal") rawX -= .5;
+		let localx = Math.round(rawX);
+		const localy = Math.round(y) * this.ystep;
+		if (y % 2 === 0 && this.grid === "diagonal") localx += .5;
+		const inverse = (0, proj4.default)(this.proj4String, "WGS84", [localx * this.X_RANGE / this.width + this.X_MIN, this.Y_MAX - localy * this.Y_RANGE / this.height]);
+		if (!inverse.every((v) => Number.isFinite(v))) return;
+		const [localLng, localLat] = inverse;
+		return {
+			x: localx,
+			y: localy,
+			lat: localLat,
+			lng: localLng
+		};
+	}
+	getPoints() {
+		return [...Object.values(this.points), ...this.pins];
+	}
+	getSVG({ shape = "circle", color = "current", backgroundColor = "transparent", radius = .5 } = {}) {
+		const getPoint = ({ x, y, svgOptions = {} }) => {
+			const pointRadius = svgOptions.radius || radius;
+			if (shape === "circle") return `<circle cx="${x}" cy="${y}" r="${pointRadius}" fill="${svgOptions.color || color}" />`;
+			else if (shape === "hexagon") {
+				const sqrt3radius = Math.sqrt(3) * pointRadius;
+				return `<polyline points="${[
+					[x + sqrt3radius, y - pointRadius],
+					[x + sqrt3radius, y + pointRadius],
+					[x, y + 2 * pointRadius],
+					[x - sqrt3radius, y + pointRadius],
+					[x - sqrt3radius, y - pointRadius],
+					[x, y - 2 * pointRadius]
+				].map((point) => point.join(",")).join(" ")}" fill="${svgOptions.color || color}" />`;
+			}
+			return "";
+		};
+		return `<svg viewBox="0 0 ${this.width} ${this.height}" xmlns="http://www.w3.org/2000/svg" style="background-color: ${backgroundColor}">
+        ${Object.values(this.points).map(getPoint).join("\n")}
+        ${this.pins.map(getPoint).join("\n")}
+      </svg>`;
+	}
+};
+
+//#endregion
+module.exports = DottedMapWithoutCountries;

package/dist/without-countries.d.cts

@@ -0,0 +1,44 @@
+import { c as Projection, d as SvgSettings, i as MapData, l as ProjectionName, n as DottedMapWithoutCountriesSettings, o as PinInput, r as ImageInfo, s as Point, u as Region } from "./types-vOcy-UuQ.cjs";
+
+//#region src/without-countries.d.ts
+declare class DottedMapWithoutCountries {
+  private points;
+  private X_MIN;
+  private Y_MAX;
+  private X_RANGE;
+  private Y_RANGE;
+  private grid;
+  private width;
+  private height;
+  private ystep;
+  private avoidOuterPins;
+  private pins;
+  private proj4String;
+  image: ImageInfo;
+  constructor({
+    map,
+    avoidOuterPins
+  }: DottedMapWithoutCountriesSettings);
+  addPin({
+    lat,
+    lng,
+    data,
+    svgOptions
+  }: PinInput): Point;
+  getPin({
+    lat,
+    lng
+  }: {
+    lat: number;
+    lng: number;
+  }): Point | undefined;
+  getPoints(): Point[];
+  getSVG({
+    shape,
+    color,
+    backgroundColor,
+    radius
+  }?: SvgSettings): string;
+}
+//#endregion
+export { type DottedMapWithoutCountriesSettings, type ImageInfo, type MapData, type PinInput, type Point, type Projection, type ProjectionName, type Region, type SvgSettings, DottedMapWithoutCountries as default };

package/dist/without-countries.d.mts

@@ -0,0 +1,44 @@
+import { c as Projection, d as SvgSettings, i as MapData, l as ProjectionName, n as DottedMapWithoutCountriesSettings, o as PinInput, r as ImageInfo, s as Point, u as Region } from "./types-F6gvGCSl.mjs";
+
+//#region src/without-countries.d.ts
+declare class DottedMapWithoutCountries {
+  private points;
+  private X_MIN;
+  private Y_MAX;
+  private X_RANGE;
+  private Y_RANGE;
+  private grid;
+  private width;
+  private height;
+  private ystep;
+  private avoidOuterPins;
+  private pins;
+  private proj4String;
+  image: ImageInfo;
+  constructor({
+    map,
+    avoidOuterPins
+  }: DottedMapWithoutCountriesSettings);
+  addPin({
+    lat,
+    lng,
+    data,
+    svgOptions
+  }: PinInput): Point;
+  getPin({
+    lat,
+    lng
+  }: {
+    lat: number;
+    lng: number;
+  }): Point | undefined;
+  getPoints(): Point[];
+  getSVG({
+    shape,
+    color,
+    backgroundColor,
+    radius
+  }?: SvgSettings): string;
+}
+//#endregion
+export { type DottedMapWithoutCountriesSettings, type ImageInfo, type MapData, type PinInput, type Point, type Projection, type ProjectionName, type Region, type SvgSettings, DottedMapWithoutCountries as default };

package/dist/without-countries.mjs

@@ -0,0 +1,107 @@
+import proj4 from "proj4";
+
+//#region src/without-countries.ts
+const PROJECTIONS = {
+	mercator: "+proj=merc +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	equirectangular: "+proj=eqc +lon_0={lng} +lat_ts=0 +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	robinson: "+proj=robin +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	equalEarth: "+proj=eqearth +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	mollweide: "+proj=moll +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	miller: "+proj=mill +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	sinusoidal: "+proj=sinu +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	orthographic: "+proj=ortho +lat_0={lat} +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	gallPeters: "+proj=cea +lon_0={lng} +lat_ts=45 +x_0=0 +y_0=0 +datum=WGS84 +units=m",
+	vanDerGrinten: "+proj=vandg +lon_0={lng} +x_0=0 +y_0=0 +datum=WGS84 +units=m"
+};
+const DEFAULT_PROJECTION = { name: "mercator" };
+const getProj4String = (projection = DEFAULT_PROJECTION) => {
+	const template = PROJECTIONS[projection.name];
+	const lat = projection.center?.lat ?? 0;
+	const lng = projection.center?.lng ?? 0;
+	return template.replace("{lat}", String(lat)).replace("{lng}", String(lng));
+};
+var DottedMapWithoutCountries = class {
+	constructor({ map, avoidOuterPins = false }) {
+		this.points = map.points;
+		this.pins = [];
+		this.X_MIN = map.X_MIN;
+		this.Y_MAX = map.Y_MAX;
+		this.X_RANGE = map.X_RANGE;
+		this.Y_RANGE = map.Y_RANGE;
+		this.grid = map.grid;
+		this.width = map.width;
+		this.height = map.height;
+		this.ystep = map.ystep;
+		this.avoidOuterPins = avoidOuterPins;
+		this.proj4String = getProj4String(map.projection ?? DEFAULT_PROJECTION);
+		this.image = {
+			region: map.region,
+			width: map.width,
+			height: map.height
+		};
+	}
+	addPin({ lat, lng, data, svgOptions }) {
+		const pin = this.getPin({
+			lat,
+			lng
+		});
+		if (!pin) return void 0;
+		const point = {
+			...pin,
+			data,
+			svgOptions
+		};
+		this.pins.push(point);
+		return point;
+	}
+	getPin({ lat, lng }) {
+		const projected = proj4(this.proj4String, [lng, lat]);
+		if (!projected.every((v) => Number.isFinite(v))) return;
+		const [projX, projY] = projected;
+		if (this.avoidOuterPins) return;
+		let rawX = this.width * (projX - this.X_MIN) / this.X_RANGE;
+		const rawY = this.height * (this.Y_MAX - projY) / this.Y_RANGE;
+		const y = Math.round(rawY / this.ystep);
+		if (y % 2 === 0 && this.grid === "diagonal") rawX -= .5;
+		let localx = Math.round(rawX);
+		const localy = Math.round(y) * this.ystep;
+		if (y % 2 === 0 && this.grid === "diagonal") localx += .5;
+		const inverse = proj4(this.proj4String, "WGS84", [localx * this.X_RANGE / this.width + this.X_MIN, this.Y_MAX - localy * this.Y_RANGE / this.height]);
+		if (!inverse.every((v) => Number.isFinite(v))) return;
+		const [localLng, localLat] = inverse;
+		return {
+			x: localx,
+			y: localy,
+			lat: localLat,
+			lng: localLng
+		};
+	}
+	getPoints() {
+		return [...Object.values(this.points), ...this.pins];
+	}
+	getSVG({ shape = "circle", color = "current", backgroundColor = "transparent", radius = .5 } = {}) {
+		const getPoint = ({ x, y, svgOptions = {} }) => {
+			const pointRadius = svgOptions.radius || radius;
+			if (shape === "circle") return `<circle cx="${x}" cy="${y}" r="${pointRadius}" fill="${svgOptions.color || color}" />`;
+			else if (shape === "hexagon") {
+				const sqrt3radius = Math.sqrt(3) * pointRadius;
+				return `<polyline points="${[
+					[x + sqrt3radius, y - pointRadius],
+					[x + sqrt3radius, y + pointRadius],
+					[x, y + 2 * pointRadius],
+					[x - sqrt3radius, y + pointRadius],
+					[x - sqrt3radius, y - pointRadius],
+					[x, y - 2 * pointRadius]
+				].map((point) => point.join(",")).join(" ")}" fill="${svgOptions.color || color}" />`;
+			}
+			return "";
+		};
+		return `<svg viewBox="0 0 ${this.width} ${this.height}" xmlns="http://www.w3.org/2000/svg" style="background-color: ${backgroundColor}">
+        ${Object.values(this.points).map(getPoint).join("\n")}
+        ${this.pins.map(getPoint).join("\n")}
+      </svg>`;
+	}
+};
+
+//#endregion
+export { DottedMapWithoutCountries as default };

package/package.json

@@ -1,15 +1,42 @@
 {
   "name": "dotted-map",
-  "version": "2.2.3",
+  "version": "3.1.0",
   "description": "Create a SVG map filled with dots for the world or countries",
-  "main": "./index.js",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
-    ".": "./index.js",
-    "./without-countries": "./without-countries.js"
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./without-countries": {
+      "import": {
+        "types": "./dist/without-countries.d.mts",
+        "default": "./dist/without-countries.mjs"
+      },
+      "require": {
+        "types": "./dist/without-countries.d.cts",
+        "default": "./dist/without-countries.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
   },
-  "module": "./src/with-countries.js",
   "scripts": {
-    "build": "webpack",
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
     "test": "node test.js"
   },
   "keywords": [
@@ -21,16 +48,24 @@
     "countries",
     "country"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NTag/dotted-map.git"
+  },
   "author": "Basile Bruneau <basile@bruneau.email>",
   "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/NTag/dotted-map/issues"
+  },
+  "homepage": "https://github.com/NTag/dotted-map",
   "dependencies": {
-    "@turf/boolean-point-in-polygon": "^6.0.1",
-    "proj4": "^2.6.1"
+    "@turf/boolean-point-in-polygon": "^7.3.4",
+    "proj4": "^2.20.2"
   },
   "devDependencies": {
-    "prettier": "^2.0.5",
-    "webpack": "^5.33.2",
-    "webpack-cli": "^4.6.0"
+    "prettier": "^3.8.1",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3"
   },
   "sideEffects": false
 }

package/.github/workflows/publish.yml

@@ -1,22 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm install
-      - run: npm run build
-      - run: npm test
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/index.d.ts

@@ -1,62 +0,0 @@
-namespace DottedMapLib {
-  interface Region {
-    lat: { min: number; max: number };
-    lng: { min: number; max: number };
-  }
-
-  interface MapSettings {
-    height?: number;
-    width?: number;
-    countries?: string[];
-    region?: Region;
-    grid?: 'vertical' | 'diagonal';
-  }
-
-  interface Settings extends MapSettings {
-    avoidOuterPins?: false | true;
-  }
-
-  interface SvgOptions {
-    color?: string;
-    radius?: number;
-  }
-
-  interface Pin {
-    lat: number;
-    lng: number;
-    data?: any;
-    svgOptions?: SvgOptions;
-  }
-
-  interface SvgSettings {
-    shape?: 'circle' | 'hexagon';
-    color?: string;
-    backgroundColor?: string;
-    radius?: number;
-  }
-
-  type Point = {
-    x: number;
-    y: number;
-    lat: number;
-    lng: number;
-    data?: any;
-    svgOptions?: SvgOptions;
-  };
-}
-
-export const getMapJSON: (settings: DottedMapLib.MapSettings) => string;
-
-export default class DottedMap {
-  constructor(settings: DottedMapLib.Settings);
-
-  addPin(pin: DottedMapLib.Pin): DottedMapLib.Point;
-  getPin(pin: DottedMapLib.Pin): DottedMapLib.Point;
-  getPoints(): DottedMapLib.Point[];
-  getSVG(settings: DottedMapLib.SvgSettings): string;
-  image: {
-    region: DottedMap.Region;
-    width: number;
-    height: number;
-  };
-}