proj4 2.16.2 → 2.19.0

package/README.md

@@ -146,6 +146,7 @@ WKT1 definitions can contain a `TOWGS84` parameter. For proj strings, `towgs84`
 
 ## Grid Based Datum Adjustments
 
+### NTV2 format (.gsb)
 To use `+nadgrids=` in a proj definition or a WKT2/PROJJSON `ABRIDGEDTRANSFORM` with an `NTv2` method, first read your NTv2 `.gsb` file (e.g. from https://github.com/OSGeo/proj-datumgrid) into an ArrayBuffer, then pass it to `proj4.nadgrid`. E.g:
 
 ```javascript
@@ -164,6 +165,17 @@ proj4.nadgrid('key', buffer, {includeErrorFields:false});
 
 If the options argument is omitted, `includeErrorFields` is assumed to be true.
 
+
+### GeoTIFF format (.tif)
+To use `+nadgrids=` in a proj definition or a WKT2/PROJJSON `ABRIDGEDTRANSFORM` with a `GeoTIFF` method, first read your `.tif` file (e.g. from https://github.com/OSGeo/PROJ-data or https://cdn.proj.org/) into a GeoTIFF instance from the [GeoTIFF.js library](https://github.com/geotiffjs/geotiff.js/), then pass it to `proj4.nadgrid`. E.g:
+```javascript
+import { fromUrl} from "geotiff";
+const tiff = await fromUrl('ca_nrc_NA83SCRS.tif');
+await proj4.nadgrid('ca_nrc_NA83SCRS.tif', tiff).ready;
+```
+
+Then use the given key in your definition, e.g. `proj4.defs("EPSG:32188","+proj=tmerc +lat_0=0 +lon_0=-73.5 +k=0.9999 +x_0=304800 +y_0=0 +ellps=GRS80 +nadgrids=ca_nrc_NA83SCRS.tif +units=m +no_defs +type=crs");` noting the `+nadgrids=ca_nrc_NA83SCRS.tif` parameter.
+
 ## TypeScript
 
 TypeScript implementation was added to the [DefinitelyTyped repository](https://github.com/DefinitelyTyped/DefinitelyTyped).

package/bower.json

@@ -1,6 +1,6 @@
 {
   "name": "proj4",
-  "version": "2.16.2",
+  "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://github.com/proj4js/proj4js",
   "main": "dist/proj4.js",

package/component.json

@@ -1,6 +1,6 @@
 {
   "name": "proj4",
-  "version": "2.16.2",
+  "version": "2.19.0",
   "description": "Proj4js is a JavaScript library to transform point coordinates from one coordinate system to another, including datum transformations.",
   "repo": "proj4js/proj4js",
   "keywords": [

package/dist/lib/Point.d.ts

@@ -0,0 +1,24 @@
+export default Point;
+/**
+ * @deprecated v3.0.0 - use proj4.toPoint instead
+ * @param {number | import('./core').TemplateCoordinates | string} x
+ * @param {number} [y]
+ * @param {number} [z]
+ */
+declare function Point(x: number | import("./core").TemplateCoordinates | string, y?: number, z?: number): Point;
+declare class Point {
+    /**
+     * @deprecated v3.0.0 - use proj4.toPoint instead
+     * @param {number | import('./core').TemplateCoordinates | string} x
+     * @param {number} [y]
+     * @param {number} [z]
+     */
+    constructor(x: number | import("./core").TemplateCoordinates | string, y?: number, z?: number);
+    x: string | number;
+    y: number;
+    z: number;
+    toMGRS(accuracy: any): any;
+}
+declare namespace Point {
+    function fromMGRS(mgrsStr: any): Point;
+}

package/dist/lib/Proj.d.ts

@@ -0,0 +1,71 @@
+export default Projection;
+export type DatumDefinition = {
+    /**
+     * - The type of datum.
+     */
+    datum_type: number;
+    /**
+     * - Semi-major axis of the ellipsoid.
+     */
+    a: number;
+    /**
+     * - Semi-minor axis of the ellipsoid.
+     */
+    b: number;
+    /**
+     * - Eccentricity squared of the ellipsoid.
+     */
+    es: number;
+    /**
+     * - Second eccentricity squared of the ellipsoid.
+     */
+    ep2: number;
+};
+/**
+ * @typedef {Object} DatumDefinition
+ * @property {number} datum_type - The type of datum.
+ * @property {number} a - Semi-major axis of the ellipsoid.
+ * @property {number} b - Semi-minor axis of the ellipsoid.
+ * @property {number} es - Eccentricity squared of the ellipsoid.
+ * @property {number} ep2 - Second eccentricity squared of the ellipsoid.
+ */
+/**
+ * @param {string | import('./core').PROJJSONDefinition | import('./defs').ProjectionDefinition} srsCode
+ * @param {(errorMessage?: string, instance?: Projection) => void} [callback]
+ */
+declare function Projection(srsCode: string | import("./core").PROJJSONDefinition | import("./defs").ProjectionDefinition, callback?: (errorMessage?: string, instance?: Projection) => void): Projection;
+declare class Projection {
+    /**
+     * @typedef {Object} DatumDefinition
+     * @property {number} datum_type - The type of datum.
+     * @property {number} a - Semi-major axis of the ellipsoid.
+     * @property {number} b - Semi-minor axis of the ellipsoid.
+     * @property {number} es - Eccentricity squared of the ellipsoid.
+     * @property {number} ep2 - Second eccentricity squared of the ellipsoid.
+     */
+    /**
+     * @param {string | import('./core').PROJJSONDefinition | import('./defs').ProjectionDefinition} srsCode
+     * @param {(errorMessage?: string, instance?: Projection) => void} [callback]
+     */
+    constructor(srsCode: string | import("./core").PROJJSONDefinition | import("./defs").ProjectionDefinition, callback?: (errorMessage?: string, instance?: Projection) => void);
+    /** @type {<T extends import('./core').TemplateCoordinates>(coordinates: T, enforceAxis?: boolean) => T} */
+    forward: <T extends import("./core").TemplateCoordinates>(coordinates: T, enforceAxis?: boolean) => T;
+    /** @type {<T extends import('./core').TemplateCoordinates>(coordinates: T, enforceAxis?: boolean) => T} */
+    inverse: <T extends import("./core").TemplateCoordinates>(coordinates: T, enforceAxis?: boolean) => T;
+    /** @type {string} */
+    name: string;
+    /** @type {string} */
+    title: string;
+    a: any;
+    b: any;
+    rf: any;
+    sphere: any;
+    es: number;
+    e: number;
+    ep2: number;
+    datum: DatumDefinition;
+}
+declare namespace Projection {
+    export { projections };
+}
+import projections from './projections';

package/dist/lib/adjust_axis.d.ts

@@ -0,0 +1 @@
+export default function _default(crs: any, denorm: any, point: any): import("./core").InterfaceCoordinates;

package/dist/lib/checkSanity.d.ts

@@ -0,0 +1 @@
+export default function _default(point: any): void;

package/dist/lib/common/acosh.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/adjust_lat.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): any;

package/dist/lib/common/adjust_lon.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): any;

package/dist/lib/common/adjust_zone.d.ts

@@ -0,0 +1 @@
+export default function _default(zone: any, lon: any): any;

package/dist/lib/common/asinh.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/asinhy.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/asinz.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/atanh.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/clens.d.ts

@@ -0,0 +1 @@
+export default function _default(pp: any, arg_r: any): number;

package/dist/lib/common/clens_cmplx.d.ts

@@ -0,0 +1 @@
+export default function _default(pp: any, arg_r: any, arg_i: any): number[];

package/dist/lib/common/cosh.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/e0fn.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/e1fn.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/e2fn.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/e3fn.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/fL.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any, L: any): number;

package/dist/lib/common/gN.d.ts

@@ -0,0 +1 @@
+export default function _default(a: any, e: any, sinphi: any): number;

package/dist/lib/common/gatg.d.ts

@@ -0,0 +1 @@
+export default function _default(pp: any, B: any): any;

package/dist/lib/common/hypot.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any, y: any): number;

package/dist/lib/common/imlfn.d.ts

@@ -0,0 +1 @@
+export default function _default(ml: any, e0: any, e1: any, e2: any, e3: any): number;

package/dist/lib/common/invlatiso.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, ts: any): number;

package/dist/lib/common/iqsfnz.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, q: any): number;

package/dist/lib/common/latiso.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, phi: any, sinphi: any): number;

package/dist/lib/common/log1py.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): any;

package/dist/lib/common/mlfn.d.ts

@@ -0,0 +1 @@
+export default function _default(e0: any, e1: any, e2: any, e3: any, phi: any): number;

package/dist/lib/common/msfnz.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, sinphi: any, cosphi: any): number;

package/dist/lib/common/phi2z.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, ts: any): number;

package/dist/lib/common/pj_enfn.d.ts

@@ -0,0 +1 @@
+export default function _default(es: any): number[];

package/dist/lib/common/pj_inv_mlfn.d.ts

@@ -0,0 +1 @@
+export default function _default(arg: any, es: any, en: any): any;

package/dist/lib/common/pj_mlfn.d.ts

@@ -0,0 +1 @@
+export default function _default(phi: any, sphi: any, cphi: any, en: any): number;

package/dist/lib/common/qsfnz.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, sinphi: any): number;

package/dist/lib/common/sign.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): 1 | -1;

package/dist/lib/common/sinh.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/srat.d.ts

@@ -0,0 +1 @@
+export default function _default(esinp: any, exp: any): number;

package/dist/lib/common/tanh.d.ts

@@ -0,0 +1 @@
+export default function _default(x: any): number;

package/dist/lib/common/toPoint.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {Array<number>} array
+ * @returns {import("../core").InterfaceCoordinates}
+ */
+export default function _default(array: Array<number>): import("../core").InterfaceCoordinates;

package/dist/lib/common/tsfnz.d.ts

@@ -0,0 +1 @@
+export default function _default(eccent: any, phi: any, sinphi: any): number;

package/dist/lib/common/vincenty.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Calculates the inverse geodesic problem using Vincenty's formulae.
+ * Computes the forward azimuth and ellipsoidal distance between two points
+ * specified by latitude and longitude on the surface of an ellipsoid.
+ *
+ * @param {number} lat1 Latitude of the first point in radians.
+ * @param {number} lon1 Longitude of the first point in radians.
+ * @param {number} lat2 Latitude of the second point in radians.
+ * @param {number} lon2 Longitude of the second point in radians.
+ * @param {number} a Semi-major axis of the ellipsoid (meters).
+ * @param {number} f Flattening of the ellipsoid.
+ * @returns {{ azi1: number, s12: number }} An object containing:
+ *   - azi1: Forward azimuth from the first point to the second point (radians).
+ *   - s12: Ellipsoidal distance between the two points (meters).
+ */
+export function vincentyInverse(lat1: number, lon1: number, lat2: number, lon2: number, a: number, f: number): {
+    azi1: number;
+    s12: number;
+};
+/**
+ * Solves the direct geodetic problem using Vincenty's formulae.
+ * Given a starting point, initial azimuth, and distance, computes the destination point on the ellipsoid.
+ *
+ * @param {number} lat1 Latitude of the starting point in radians.
+ * @param {number} lon1 Longitude of the starting point in radians.
+ * @param {number} azi1 Initial azimuth (forward azimuth) in radians.
+ * @param {number} s12 Distance to travel from the starting point in meters.
+ * @param {number} a Semi-major axis of the ellipsoid in meters.
+ * @param {number} f Flattening of the ellipsoid.
+ * @returns {{lat2: number, lon2: number}} The latitude and longitude (in radians) of the destination point.
+ */
+export function vincentyDirect(lat1: number, lon1: number, azi1: number, s12: number, a: number, f: number): {
+    lat2: number;
+    lon2: number;
+};