proj4 2.17.0 → 2.19.0

package/lib/projections/omerc.js

@@ -4,6 +4,29 @@ import phi2z from '../common/phi2z';
 import { EPSLN, HALF_PI, TWO_PI, FORTPI } from '../constants/values';
 import { getNormalizedProjName } from '../projections';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {boolean} no_off
+ * @property {boolean} no_rot
+ * @property {number} rectified_grid_angle
+ * @property {number} es
+ * @property {number} A
+ * @property {number} B
+ * @property {number} E
+ * @property {number} e
+ * @property {number} lam0
+ * @property {number} singam
+ * @property {number} cosgam
+ * @property {number} sinrot
+ * @property {number} cosrot
+ * @property {number} rB
+ * @property {number} ArB
+ * @property {number} BrA
+ * @property {number} u_0
+ * @property {number} v_pole_n
+ * @property {number} v_pole_s
+ */
+
 var TOL = 1e-7;
 
 function isTypeA(P) {
@@ -13,8 +36,10 @@ function isTypeA(P) {
   return 'no_uoff' in P || 'no_off' in P || typeAProjections.indexOf(projectionName) !== -1 || typeAProjections.indexOf(getNormalizedProjName(projectionName)) !== -1;
 }
 
-/* Initialize the Oblique Mercator  projection
-    ------------------------------------------ */
+/**
+ * Initialize the Oblique Mercator  projection
+ * @this {import('../defs.js').ProjectionDefinition & LocalThis}
+ */
 export function init() {
   var con, com, cosph0, D, F, H, L, sinph0, p, J, gamma = 0,
     gamma0, lamc = 0, lam1 = 0, lam2 = 0, phi1 = 0, phi2 = 0, alpha_c = 0;
@@ -107,9 +132,9 @@ export function init() {
     J = (J - L * H) / (J + L * H);
     con = lam1 - lam2;
 
-    if (con < -Math.pi) {
+    if (con < -Math.PI) {
       lam2 -= TWO_PI;
-    } else if (con > Math.pi) {
+    } else if (con > Math.PI) {
       lam2 += TWO_PI;
     }
 

package/lib/projections/ortho.js

@@ -2,6 +2,13 @@ import adjust_lon from '../common/adjust_lon';
 import asinz from '../common/asinz';
 import { EPSLN, HALF_PI } from '../constants/values';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} sin_p14
+ * @property {number} cos_p14
+ */
+
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   // double temp;      /* temporary variable    */
 

package/lib/projections/poly.js

@@ -8,8 +8,22 @@ import mlfn from '../common/mlfn';
 import { EPSLN } from '../constants/values';
 
 import gN from '../common/gN';
+
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} temp
+ * @property {number} es
+ * @property {number} e
+ * @property {number} e0
+ * @property {number} e1
+ * @property {number} e2
+ * @property {number} e3
+ * @property {number} ml0
+ */
+
 var MAX_ITER = 20;
 
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   /* Place parameters in static storage for common use
       ------------------------------------------------- */

package/lib/projections/qsc.js

@@ -3,6 +3,16 @@
 
 import { EPSLN, TWO_PI, SPI, HALF_PI, FORTPI } from '../constants/values';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} face
+ * @property {number} x0
+ * @property {number} y0
+ * @property {number} es
+ * @property {number} one_minus_f
+ * @property {number} one_minus_f_squared
+ */
+
 /* constants */
 var FACE_ENUM = {
   FRONT: 1,
@@ -20,6 +30,7 @@ var AREA_ENUM = {
   AREA_3: 4
 };
 
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   this.x0 = this.x0 || 0;
   this.y0 = this.y0 || 0;

package/lib/projections/sinu.js

@@ -8,6 +8,17 @@ import { EPSLN, HALF_PI } from '../constants/values';
 
 import asinz from '../common/asinz';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {Array<number>} en
+ * @property {number} n
+ * @property {number} m
+ * @property {number} C_y
+ * @property {number} C_x
+ * @property {number} es
+ */
+
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   /* Place parameters in static storage for common use
     ------------------------------------------------- */

package/lib/projections/somerc.js

@@ -6,6 +6,16 @@
     http://www.swisstopo.admin.ch/internet/swisstopo/fr/home/topics/survey/sys/refsys/switzerland.parsysrelated1.31216.downloadList.77004.DownloadFile.tmp/swissprojectionfr.pdf
   */
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} lambda0
+ * @property {number} e
+ * @property {number} R
+ * @property {number} b0
+ * @property {number} K
+ */
+
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   var phy0 = this.lat0;
   this.lambda0 = this.long0;

package/lib/projections/stere.js

@@ -6,11 +6,25 @@ import tsfnz from '../common/tsfnz';
 import phi2z from '../common/phi2z';
 import adjust_lon from '../common/adjust_lon';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} coslat0
+ * @property {number} sinlat0
+ * @property {number} ms1
+ * @property {number} X0
+ * @property {number} cosX0
+ * @property {number} sinX0
+ * @property {number} con
+ * @property {number} cons
+ * @property {number} e
+ */
+
 export function ssfn_(phit, sinphi, eccen) {
   sinphi *= eccen;
   return (Math.tan(0.5 * (HALF_PI + phit)) * Math.pow((1 - sinphi) / (1 + sinphi), 0.5 * eccen));
 }
 
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   // setting default parameters
   this.x0 = this.x0 || 0;
@@ -43,7 +57,7 @@ export function init() {
       this.k0 = 0.5 * this.cons * msfnz(this.e, Math.sin(this.lat_ts), Math.cos(this.lat_ts)) / tsfnz(this.e, this.con * this.lat_ts, this.con * Math.sin(this.lat_ts));
     }
     this.ms1 = msfnz(this.e, this.sinlat0, this.coslat0);
-    this.X0 = 2 * Math.atan(this.ssfn_(this.lat0, this.sinlat0, this.e)) - HALF_PI;
+    this.X0 = 2 * Math.atan(ssfn_(this.lat0, this.sinlat0, this.e)) - HALF_PI;
     this.cosX0 = Math.cos(this.X0);
     this.sinX0 = Math.sin(this.X0);
   }
@@ -72,7 +86,7 @@ export function forward(p) {
     p.y = this.a * A * (this.coslat0 * sinlat - this.sinlat0 * coslat * Math.cos(dlon)) + this.y0;
     return p;
   } else {
-    X = 2 * Math.atan(this.ssfn_(lat, sinlat, this.e)) - HALF_PI;
+    X = 2 * Math.atan(ssfn_(lat, sinlat, this.e)) - HALF_PI;
     cosX = Math.cos(X);
     sinX = Math.sin(X);
     if (Math.abs(this.coslat0) <= EPSLN) {

package/lib/projections/sterea.js

@@ -2,6 +2,16 @@ import gauss from './gauss';
 import adjust_lon from '../common/adjust_lon';
 import hypot from '../common/hypot';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} sinc0
+ * @property {number} cosc0
+ * @property {number} R2
+ * @property {number} rc
+ * @property {number} phic0
+ */
+
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   gauss.init.apply(this);
   if (!this.rc) {

package/lib/projections/tmerc.js

@@ -9,6 +9,14 @@ import adjust_lon from '../common/adjust_lon';
 import { EPSLN, HALF_PI } from '../constants/values';
 import sign from '../common/sign';
 
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} es
+ * @property {Array<number>} en
+ * @property {number} ml0
+ */
+
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   this.x0 = this.x0 !== undefined ? this.x0 : 0;
   this.y0 = this.y0 !== undefined ? this.y0 : 0;

package/lib/projections/tpers.js

@@ -1,3 +1,26 @@
+import { D2R, HALF_PI, EPSLN } from '../constants/values';
+import hypot from '../common/hypot';
+
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} mode
+ * @property {number} sinph0
+ * @property {number} cosph0
+ * @property {number} pn1
+ * @property {number} h
+ * @property {number} rp
+ * @property {number} p
+ * @property {number} h1
+ * @property {number} pfact
+ * @property {number} es
+ * @property {number} tilt
+ * @property {number} azi
+ * @property {number} cg
+ * @property {number} sg
+ * @property {number} cw
+ * @property {number} sw
+ */
+
 var mode = {
   N_POLE: 0,
   S_POLE: 1,
@@ -5,9 +28,6 @@ var mode = {
   OBLIQ: 3
 };
 
-import { D2R, HALF_PI, EPSLN } from '../constants/values';
-import hypot from '../common/hypot';
-
 var params = {
   h: { def: 100000, num: true }, // default is Karman line, no default in PROJ.7
   azi: { def: 0, num: true, degrees: true }, // default is North
@@ -16,6 +36,7 @@ var params = {
   lat0: { def: 0, num: true } // default is Equator, conversion to rad is automatic
 };
 
+/** @this {import('../defs.js').ProjectionDefinition & LocalThis} */
 export function init() {
   Object.keys(params).forEach(function (p) {
     if (typeof this[p] === 'undefined') {

package/lib/projections/utm.js

@@ -3,6 +3,7 @@ import etmerc from './etmerc';
 export var dependsOn = 'etmerc';
 import { D2R } from '../constants/values';
 
+/** @this {import('../defs.js').ProjectionDefinition} */
 export function init() {
   var zone = adjust_zone(this.zone, this.long0);
   if (zone === undefined) {

package/lib/projections/vandg.js

@@ -4,8 +4,15 @@ import { HALF_PI, EPSLN } from '../constants/values';
 
 import asinz from '../common/asinz';
 
-/* Initialize the Van Der Grinten projection
-  ---------------------------------------- */
+/**
+ * @typedef {Object} LocalThis
+ * @property {number} R - Radius of the Earth
+ */
+
+/**
+ * Initialize the Van Der Grinten projection
+ * @this {import('../defs.js').ProjectionDefinition & LocalThis}
+ */
 export function init() {
   // this.R = 6370997; //Radius of earth
   this.R = this.a;

package/lib/transform.js

@@ -11,6 +11,13 @@ function checkNotWGS(source, dest) {
   || ((dest.datum.datum_type === PJD_3PARAM || dest.datum.datum_type === PJD_7PARAM || dest.datum.datum_type === PJD_GRIDSHIFT) && source.datumCode !== 'WGS84');
 }
 
+/**
+ * @param {import('./defs').ProjectionDefinition} source
+ * @param {import('./defs').ProjectionDefinition} dest
+ * @param {import('./core').TemplateCoordinates} point
+ * @param {boolean} enforceAxis
+ * @returns {import('./core').InterfaceCoordinates | undefined}
+ */
 export default function transform(source, dest, point, enforceAxis) {
   var wgs84;
   if (Array.isArray(point)) {
@@ -67,6 +74,8 @@ export default function transform(source, dest, point, enforceAxis) {
     return;
   }
 
+  point = /** @type {import('./core').InterfaceCoordinates} */ (point);
+
   // Adjust for the prime meridian if necessary
   if (dest.from_greenwich) {
     point = {

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "proj4",
-  "version": "2.17.0",
+  "version": "2.19.0",
   "description": "Proj4js is a JavaScript library to transform point coordinates from one coordinate system to another, including datum transformations.",
   "homepage": "https://proj4js.github.io/proj4js/",
   "main": "dist/proj4-src.js",
   "module": "lib/index.js",
+  "types": "dist/lib/index.js",
   "scripts": {
-    "prepare": "npm run build && npm run test:all",
+    "prepare": "npm run test",
     "build": "grunt && npm run rollup",
     "build:tmerc": "grunt build:tmerc && npm run rollup",
     "rollup": "rollup -c",
-    "pretest": "npm run lint",
+    "pretest": "npm run lint && npm run types",
     "lint": "eslint *.js *.mjs scripts lib test",
     "format": "npm run lint -- --fix",
     "test": "npm run build && npm run test:all",
     "test:coverage": "nyc npm run test:ci",
     "test:all": "npm run test:ci && npm run test:browser",
     "test:browser": "node test/puppeteer-tests.mjs",
-    "test:ci": "npx -y mocha test/test-ci.mjs --reporter dot"
+    "test:ci": "npx -y mocha test/test-ci.mjs --reporter dot",
+    "types": "tsc"
   },
   "repository": {
     "type": "git",
@@ -40,10 +42,10 @@
     "mocha": "^10.2.0",
     "nyc": "^17.1.0",
     "puppeteer": "^24.2.0",
-    "rollup": "^4.9.6"
+    "rollup": "^4.9.6",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "geographiclib-geodesic": "^2.1.1",
     "mgrs": "1.0.0",
     "wkt-parser": "^1.5.1"
   }

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "skipLibCheck": true,
+    "emitDeclarationOnly": true,
+    "declaration": true,
+    "declarationDir": "dist",
+  },
+  "include": [
+    "lib/index.d.ts",
+    "lib/**/*.js",
+  ],
+}

package/.github/workflows/build-and-test.yml

@@ -1,69 +0,0 @@
-name: Node.js CI
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  build:
-    name: Build and test
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js 22.x
-      uses: actions/setup-node@v3
-      with:
-        node-version: 22.x
-        cache: 'npm'
-    - run: npm ci
-    - uses: actions/upload-artifact@v4
-      with:
-        name: dist
-        path: dist/
-
-  test-coverage:
-    name: Test coverage
-    needs: build
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/download-artifact@v4
-      with:
-        name: dist
-        path: dist
-    - name: Use Node.js 22.x
-      uses: actions/setup-node@v3
-      with:
-        node-version: 22.x
-        cache: 'npm'
-    - run: npm install --no-save nyc chai
-    - run: npm run test:coverage
-
-  
-  test-node:
-    name: Test older node versions
-    needs: build
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x, 20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/download-artifact@v4
-      with:
-        name: dist
-        path: dist/
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm install --no-save chai
-    - run: npm run test:ci

package/.nyc_output/6b047fc9-1bf2-4565-9e8a-9c0defc09dd7.json

@@ -1 +0,0 @@
-{}