rename

mappable-world · Oct 25, 2023 · 6d01f4c · 6d01f4c
1 parent 2799af2
commit 6d01f4c
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 31 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,7 +1,7 @@
 <!-- BUGS: Please use this template -->
-<!-- QUESTIONS: This is not a general support forum! Ask Qs at http://stackoverflow.com/questions/tagged/@mappable-world/mappable-spherical-mercator-projection -->
+<!-- QUESTIONS: This is not a general support forum! Ask Qs at http://stackoverflow.com/questions/tagged/mappable-web-mercator-projection -->
 
-**@mappable-world/mappable-spherical-mercator-projection Version:**  xxxxx
+**@mappable-world/mappable-web-mercator-projection Version:**  xxxxx
 
 **Browser:**  <!-- Chrome/IE/Safary/FF -->
 **OS:**  <!-- Windows/Mac/Linux -->

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# @mappable-world/mappable-spherical-mercator-projection package
+# @mappable-world/mappable-web-mercator-projection package
 
 ---
 
 Mappable JS API package
 
-[![npm version](https://badge.fury.io/js/@mappable-world%2Fmappable-spherical-mercator-projection.svg)](https://badge.fury.io/js/@mappable-world%2Fmappable-spherical-mercator-projection)
-[![npm](https://img.shields.io/npm/dm/@mappable-world/mappable-spherical-mercator-projection.svg)](https://www.npmjs.com/package/@mappable-world/mappable-spherical-mercator-projection)
+[![npm version](https://badge.fury.io/js/@mappable-world%2Fmappable-web-mercator-projection.svg)](https://badge.fury.io/js/@mappable-world%2Fmappable-web-mercator-projection)
+[![npm](https://img.shields.io/npm/dm/@mappable-world/mappable-web-mercator-projection.svg)](https://www.npmjs.com/package/@mappable-world/mappable-web-mercator-projection)
 [![Build Status](https://github.com/mappable-world/mappable-cartesian-projection/workflows/Run%20tests/badge.svg)](https://github.com/mappable-world/mappable-cartesian-projection/actions/workflows/tests.yml)
 
 ## How use
@@ -20,7 +20,7 @@ to use Mappable JS Module you need to add your module loading handler to JS API
 
 ```js
 mappable.import.loaders.unshift(async (pkg) => {
-  if (!pkg.includes('@mappable-world/mappable-spherical-mercator-projection')) {
+  if (!pkg.includes('@mappable-world/mappable-web-mercator-projection')) {
     return;
   }
 
@@ -38,5 +38,5 @@ mappable.import.loaders.unshift(async (pkg) => {
 and in your final code just use `mappable.import`
 
 ```js
-const pkg = await mappable.import('@mappable-world/mappable-spherical-mercator-projection')
+const pkg = await mappable.import('@mappable-world/mappable-web-mercator-projection')
 ```
diff --git a/example/common.js b/example/common.js
@@ -1,5 +1,5 @@
 mappable.import.loaders.unshift(async (pkg) => {
-    if (!pkg.includes('@mappable-world/mappable-spherical-mercator-projection')) {
+    if (!pkg.includes('@mappable-world/mappable-web-mercator-projection')) {
         return;
     }
 

diff --git a/example/react.html b/example/react.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
     <head>
-        <title>React example @mappable-world/mappable-spherical-mercator-projection</title>
+        <title>React example @mappable-world/mappable-web-mercator-projection</title>
         <meta charset="UTF-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
         <script crossorigin src="https://unpkg.com/react@17/umd/react.production.min.js"></script>
@@ -25,8 +25,8 @@
                 const {MMapZoomControl} = reactify.module(await mappable.import('@mappable-world/mappable-controls@0.0.1'));
                 const {MMapDefaultMarker} = reactify.module(await mappable.import('@mappable-world/mappable-markers@0.0.1'));
 
-                const {SphericalMercator} = await mappable.import('@mappable-world/mappable-spherical-mercator-projection');
-                const projection = new SphericalMercator();
+                const {WebMercator} = await mappable.import('@mappable-world/mappable-web-mercator-projection');
+                const projection = new WebMercator();
 
                 ReactDOM.render(
                     <React.StrictMode>

diff --git a/example/vanilla.html b/example/vanilla.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
     <head>
-        <title>Vanila example @mappable-world/mappable-spherical-mercator-projection</title>
+        <title>Vanila example @mappable-world/mappable-web-mercator-projection</title>
         <meta charset="UTF-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
         <script src="https://js.api.mappable.world/3.0/?apikey=%APIKEY%&lang=en_US"></script>
@@ -17,8 +17,8 @@
                 const {MMapZoomControl} = await mappable.import('@mappable-world/mappable-controls@0.0.1');
                 const {MMapDefaultMarker} = await mappable.import('@mappable-world/mappable-markers@0.0.1');
 
-                const {SphericalMercator} = await mappable.import('@mappable-world/mappable-spherical-mercator-projection');
-                const projection = new SphericalMercator();
+                const {WebMercator} = await mappable.import('@mappable-world/mappable-web-mercator-projection');
+                const projection = new WebMercator();
 
                 const map = new MMap(document.getElementById('app'), {
                     location: LOCATION,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "version": "0.0.1-beta.2",
-    "name": "@mappable-world/mappable-spherical-mercator-projection",
-    "description": "Mappable Maps JS API 3.0 example @mappable-world/mappable-spherical-mercator-projection",
+    "name": "@mappable-world/mappable-web-mercator-projection",
+    "description": "Mappable Maps JS API 3.0 example @mappable-world/mappable-web-mercator-projection",
     "types": "./dist/types/index.d.ts",
     "main": "./dist/esm/index.js",
     "scripts": {

diff --git a/src/index.ts b/src/index.ts
@@ -1 +1 @@
-export * from './spherical-mercator';
+export * from './web-mercator';
diff --git a/src/spherical-mercator.test.ts → src/web-mercator.test.ts b/src/spherical-mercator.test.ts → src/web-mercator.test.ts
@@ -1,11 +1,11 @@
 import type {LngLat} from '@mappable-world/mappable-types';
 import * as turf from '@turf/projection';
 import {restrict, cycleRestrict, RAD_TO_DEG} from './utils';
-import {SphericalMercator} from './spherical-mercator';
+import {WebMercator} from './web-mercator';
 
-describe('sphericalMercator transformations', () => {
+describe('webMercator transformations', () => {
     const WORLD_TO_METRIC = 6378137.0 * Math.PI;
-    const sphericalMercator = new SphericalMercator();
+    const webMercator = new WebMercator();
 
     const maxLat = Math.atan(Math.sinh(Math.PI)) * RAD_TO_DEG;
     const lngWorld = [
@@ -40,7 +40,7 @@ describe('sphericalMercator transformations', () => {
     it('check toWorldCoordinates', () => {
         lngWorld.map(([lng, worldX]) => {
             latWorld.map(([lat, worldY]) => {
-                const world = sphericalMercator.toWorldCoordinates([lng, lat]);
+                const world = webMercator.toWorldCoordinates([lng, lat]);
                 expect(world.x).toBeCloseTo(worldX, 9);
                 expect(world.y).toBeCloseTo(worldY, 9);
 
@@ -54,7 +54,7 @@ describe('sphericalMercator transformations', () => {
     it('check fromWorldCoordinates', () => {
         lngWorld.map(([lng, worldX]) => {
             latWorld.map(([lat, worldY]) => {
-                const lngLat = sphericalMercator.fromWorldCoordinates({x: worldX, y: worldY});
+                const lngLat = webMercator.fromWorldCoordinates({x: worldX, y: worldY});
                 expect(lngLat[0]).toBeCloseTo(cycleRestrict(lng, -180, 180), 9);
                 expect(lngLat[1]).toBeCloseTo(restrict(lat, -maxLat, maxLat), 9);
 
@@ -70,8 +70,8 @@ describe('sphericalMercator transformations', () => {
             for (let lat = -100; lat < 100; lat++) {
                 const lngLat: LngLat = [cycleRestrict(lng, -180, 180), restrict(lat, -maxLat, maxLat)];
 
-                const world = sphericalMercator.toWorldCoordinates(lngLat);
-                const lngLatAfter = sphericalMercator.fromWorldCoordinates(world);
+                const world = webMercator.toWorldCoordinates(lngLat);
+                const lngLatAfter = webMercator.fromWorldCoordinates(world);
                 expect(lngLat[0]).toBeCloseTo(lngLatAfter[0], 9);
                 expect(lngLat[1]).toBeCloseTo(lngLatAfter[1], 9);
             }

diff --git a/src/spherical-mercator.ts → src/web-mercator.ts b/src/spherical-mercator.ts → src/web-mercator.ts
@@ -4,18 +4,18 @@ import {cycleRestrict, restrict, DEG_TO_RAD, RAD_TO_DEG} from './utils'
 /**
  * @class Mercator projection onto a sphere.
  * Used by many mapping services, in particular OpenStreetMap.
- * @name projection.sphericalMercator
+ * @name projection.webMercator
  * @augments Projection
  * @static
  * @example
  * ```js
  * const {MMap, MMapTileDataSource, MMapLayer} = mappable;
- * const {SphericalMercator} = await mappable.import('@mappable-world/mappable-spherical-mercator-projection');
+ * const {WebMercator} = await mappable.import('@mappable-world/mappable-web-mercator-projection');
  *
- * // Create a map in the spherical Mercator projection
+ * // Create a map in the web Mercator projection
  * const map = new MMap(document.getElementById('map_id'), {
  *     // ...
- *     projection: new SphericalMercator()
+ *     projection: new WebMercator()
  * });
  *
  * // Add osm tiles
@@ -38,7 +38,7 @@ import {cycleRestrict, restrict, DEG_TO_RAD, RAD_TO_DEG} from './utils'
  * ```
  */
 
-export class SphericalMercator implements Projection {
+export class WebMercator implements Projection {
     private _maxLatitudeRad = Math.atan(Math.sinh(Math.PI));
 
     toWorldCoordinates(coords: LngLat): WorldCoordinates {