@mapvx/web-js 1.0.0

package/dist/es/utils/error.js

@@ -0,0 +1,16 @@
+/**
+ * Convert an unknown error to an Error object.
+ * @group Utils
+ * @param error - The unknown error.
+ * @returns An Error object.
+ */
+export function convertToError(error) {
+    if (error instanceof Error) {
+        return error;
+    }
+    else {
+        const text = String(error);
+        return new Error(text);
+    }
+}
+//# sourceMappingURL=error.js.map

package/dist/es/utils/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/utils/error.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,OAAO,KAAK,CAAA;KACb;SAAM;QACL,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;QAC1B,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA;KACvB;AACH,CAAC"}

package/dist/es/utils/images.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Load an image as a data URL.
+ * @group Utils
+ * @param imgUrl - The URL of the image to load.
+ * @returns A promise that resolves to the data URL of the image.
+ */
+export declare function loadImageAsDataUrl(imgUrl: string): Promise<string>;
+//# sourceMappingURL=images.d.ts.map

package/dist/es/utils/images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../../src/utils/images.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAclE"}

package/dist/es/utils/images.js

@@ -0,0 +1,22 @@
+/**
+ * Load an image as a data URL.
+ * @group Utils
+ * @param imgUrl - The URL of the image to load.
+ * @returns A promise that resolves to the data URL of the image.
+ */
+export function loadImageAsDataUrl(imgUrl) {
+    return new Promise((resolve, reject) => {
+        fetch(imgUrl)
+            .then((response) => response.blob())
+            .then((blob) => {
+            const reader = new FileReader();
+            reader.onloadend = function () {
+                resolve(reader.result);
+            };
+            reader.onerror = reject;
+            reader.readAsDataURL(blob);
+        })
+            .catch(reject);
+    });
+}
+//# sourceMappingURL=images.js.map

package/dist/es/utils/images.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../../../src/utils/images.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,KAAK,CAAC,MAAM,CAAC;aACV,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;aACnC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;YAC/B,MAAM,CAAC,SAAS,GAAG;gBACjB,OAAO,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAA;YAClC,CAAC,CAAA;YACD,MAAM,CAAC,OAAO,GAAG,MAAM,CAAA;YACvB,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAC5B,CAAC,CAAC;aACD,KAAK,CAAC,MAAM,CAAC,CAAA;IAClB,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/es/utils/nav-functions.d.ts

@@ -0,0 +1,85 @@
+import { type LatLng } from "../domain/models/latLng";
+/**
+ * Converts an angle from degrees to radians.
+ * @group Utils
+ * @param degrees - The angle in degrees.
+ * @returns The angle converted to radians.
+ */
+export declare function toRadians(degrees: number): number;
+/**
+ * Converts an angle from radians to degrees.
+ * @group Utils
+ * @param radians - The angle in radians.
+ * @returns The angle converted to degrees.
+ */
+export declare function toDegrees(radians: number): number;
+/**
+ * Compare two geographic points.
+ * @group Utils
+ * @param location - The first point.
+ * @param otherLocation - The second point.
+ * @returns True if the points are the same, false otherwise.
+ */
+export declare function compareLatLng(location: LatLng, otherLocation: LatLng): boolean;
+/**
+ * NavFunctions is a class that contains static methods to calculate distances and angles between geographic points.
+ * @group Utils
+ */
+export declare abstract class NavFunctions {
+    /**
+     * The radius of the Earth in meters.
+     */
+    static readonly EARTH_RADIUS: number;
+    /**
+     * Calculate the distance between two geographic points using the haversine formula.
+     *
+     * @see [Haversine Formula](https://en.wikipedia.org/wiki/Haversine_formula)
+     *
+     * @param pointA A geographic point.
+     * @param pointB Another geographic point.
+     * @returns The distance between the two points.
+     */
+    static distance(pointA: LatLng, pointB: LatLng): number;
+    /**
+     *
+     * @param pointA
+     * @param pointB
+     * @param fraction A number between 0 to 1, 0 and 1 inclusive.
+     * @returns
+     */
+    static intermediatePointBetween(pointA: LatLng, pointB: LatLng, fraction: number): LatLng;
+    /**
+     * Calculate the angle of a line between two points.
+     * Relative to NORTH in positive degrees: 0 N, 90 E, 180 S, 270 O
+     * @param source The initial point
+     * @param destination The final
+     * @returns
+     */
+    static bearingInDegBetween(source: LatLng, destination: LatLng): number;
+    /**
+     * Calculate the bearing between two points in radians.
+     * @param source The initial point.
+     * @param destination The final point.
+     * @returns The bearing in radians.
+     */
+    static bearingInRadBetween(source: LatLng, destination: LatLng): number;
+    /**
+     * Calculate an intermediate angle between two given angles based on a specific fraction.
+     * The function returns an angle that is a certain fraction of the shortest arc between the initial and final angles.
+     *
+     * @remarks
+     *
+     * If the fraction is 0, the function returns the initial angle.
+     *
+     * If the fraction is 1, it returns the final angle.
+     *
+     * For fractions in between, it returns an angle that is a proportional distance between the two angles along the shortest arc.
+     *
+     * @param initialAngle The starting angle specified in degrees.
+     * @param finalAngle The ending angle specified in degrees.
+     * @param fraction A decimal value ranging from 0 to 1 indicating the fraction of the distance between the initial and final angles.
+     * @returns The calculated intermediate angle in degrees, within the range `[0, 360[`.
+     */
+    static intermediateAngleBetween(initialAngle: number, finalAngle: number, fraction: number): number;
+}
+//# sourceMappingURL=nav-functions.d.ts.map

package/dist/es/utils/nav-functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nav-functions.d.ts","sourceRoot":"","sources":["../../../src/utils/nav-functions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAiBrD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,UAExC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,UAExC;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAE9E;AAED;;;GAGG;AACH,8BAAsB,YAAY;IAChC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAU;IAE9C;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAavD;;;;;;OAMG;IACH,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IA2BzF;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IAKvE;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IAOvE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,wBAAwB,CAC7B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,MAAM;CAKV"}

package/dist/es/utils/nav-functions.js

@@ -0,0 +1,143 @@
+const { asin, atan2, cos, sin, pow, sqrt, PI } = Math;
+/**
+ * Return the haversine of a number.
+ * Haversine formula is a formula that calculates the distance
+ * between two points on a sphere given their longitudes and latitudes.
+ * @group Utils
+ * @see [Haversine Formula](https://en.wikipedia.org/wiki/Haversine_formula)
+ * @param angle A numeric expression that contains an angle measured in radians.
+ * @returns
+ */
+function hav(angle) {
+    return sin(angle / 2) * sin(angle / 2);
+}
+/**
+ * Converts an angle from degrees to radians.
+ * @group Utils
+ * @param degrees - The angle in degrees.
+ * @returns The angle converted to radians.
+ */
+export function toRadians(degrees) {
+    return degrees * (PI / 180);
+}
+/**
+ * Converts an angle from radians to degrees.
+ * @group Utils
+ * @param radians - The angle in radians.
+ * @returns The angle converted to degrees.
+ */
+export function toDegrees(radians) {
+    return radians * (180 / PI);
+}
+/**
+ * Compare two geographic points.
+ * @group Utils
+ * @param location - The first point.
+ * @param otherLocation - The second point.
+ * @returns True if the points are the same, false otherwise.
+ */
+export function compareLatLng(location, otherLocation) {
+    return location.lat === otherLocation.lat && location.lng === otherLocation.lng;
+}
+/**
+ * NavFunctions is a class that contains static methods to calculate distances and angles between geographic points.
+ * @group Utils
+ */
+export class NavFunctions {
+    /**
+     * Calculate the distance between two geographic points using the haversine formula.
+     *
+     * @see [Haversine Formula](https://en.wikipedia.org/wiki/Haversine_formula)
+     *
+     * @param pointA A geographic point.
+     * @param pointB Another geographic point.
+     * @returns The distance between the two points.
+     */
+    static distance(pointA, pointB) {
+        const radLatA = toRadians(pointA.lat);
+        const radLatB = toRadians(pointB.lat);
+        const radLongA = toRadians(pointA.lng);
+        const radLongB = toRadians(pointB.lng);
+        const deltaLat = radLatB - radLatA;
+        const deltaLng = radLongB - radLongA;
+        const haversine = hav(deltaLat) + cos(radLatA) * cos(radLatB) * hav(deltaLng);
+        return 2 * NavFunctions.EARTH_RADIUS * asin(sqrt(haversine));
+    }
+    /**
+     *
+     * @param pointA
+     * @param pointB
+     * @param fraction A number between 0 to 1, 0 and 1 inclusive.
+     * @returns
+     */
+    static intermediatePointBetween(pointA, pointB, fraction) {
+        const radLatA = toRadians(pointA.lat);
+        const radLatB = toRadians(pointB.lat);
+        const radLongA = toRadians(pointA.lng);
+        const radLongB = toRadians(pointB.lng);
+        const angDistance = NavFunctions.distance(pointA, pointB) / NavFunctions.EARTH_RADIUS;
+        const a = sin((1 - fraction) * angDistance) / sin(angDistance);
+        const b = sin(fraction * angDistance) / sin(angDistance);
+        const x = a * cos(radLatA) * cos(radLongA) + b * cos(radLatB) * cos(radLongB);
+        const y = a * cos(radLatA) * sin(radLongA) + b * cos(radLatB) * sin(radLongB);
+        const z = a * sin(radLatA) + b * sin(radLatB);
+        const radLat = atan2(z, sqrt(pow(x, 2) + pow(y, 2)));
+        const radLong = atan2(y, x);
+        const lat = toDegrees(radLat);
+        const lng = toDegrees(radLong);
+        return {
+            lat: lat,
+            lng: lng,
+        };
+    }
+    /**
+     * Calculate the angle of a line between two points.
+     * Relative to NORTH in positive degrees: 0 N, 90 E, 180 S, 270 O
+     * @param source The initial point
+     * @param destination The final
+     * @returns
+     */
+    static bearingInDegBetween(source, destination) {
+        const inRad = NavFunctions.bearingInRadBetween(source, destination);
+        return toDegrees(inRad);
+    }
+    /**
+     * Calculate the bearing between two points in radians.
+     * @param source The initial point.
+     * @param destination The final point.
+     * @returns The bearing in radians.
+     */
+    static bearingInRadBetween(source, destination) {
+        const x = destination.lng - source.lng;
+        const y = destination.lat - source.lat;
+        return (PI / 2 - atan2(y, x) + 2 * PI) % (2 * PI);
+    }
+    /**
+     * Calculate an intermediate angle between two given angles based on a specific fraction.
+     * The function returns an angle that is a certain fraction of the shortest arc between the initial and final angles.
+     *
+     * @remarks
+     *
+     * If the fraction is 0, the function returns the initial angle.
+     *
+     * If the fraction is 1, it returns the final angle.
+     *
+     * For fractions in between, it returns an angle that is a proportional distance between the two angles along the shortest arc.
+     *
+     * @param initialAngle The starting angle specified in degrees.
+     * @param finalAngle The ending angle specified in degrees.
+     * @param fraction A decimal value ranging from 0 to 1 indicating the fraction of the distance between the initial and final angles.
+     * @returns The calculated intermediate angle in degrees, within the range `[0, 360[`.
+     */
+    static intermediateAngleBetween(initialAngle, finalAngle, fraction) {
+        let delta = ((finalAngle - initialAngle + 180) % 360) - 180;
+        if (delta < -180)
+            delta += 360;
+        return (initialAngle + 360 + delta * fraction) % 360;
+    }
+}
+/**
+ * The radius of the Earth in meters.
+ */
+NavFunctions.EARTH_RADIUS = 6378000;
+//# sourceMappingURL=nav-functions.js.map

package/dist/es/utils/nav-functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nav-functions.js","sourceRoot":"","sources":["../../../src/utils/nav-functions.ts"],"names":[],"mappings":"AAEA,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,CAAA;AAErD;;;;;;;;GAQG;AACH,SAAS,GAAG,CAAC,KAAa;IACxB,OAAO,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,OAAO,OAAO,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,CAAA;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,OAAO,OAAO,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,aAAqB;IACnE,OAAO,QAAQ,CAAC,GAAG,KAAK,aAAa,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,KAAK,aAAa,CAAC,GAAG,CAAA;AACjF,CAAC;AAED;;;GAGG;AACH,MAAM,OAAgB,YAAY;IAMhC;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAc,EAAE,MAAc;QAC5C,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACrC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACtC,MAAM,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAA;QAClC,MAAM,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAEpC,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAA;QAE7E,OAAO,CAAC,GAAG,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,wBAAwB,CAAC,MAAc,EAAE,MAAc,EAAE,QAAgB;QAC9E,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACrC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAEtC,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,YAAY,CAAA;QAErF,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAA;QAC9D,MAAM,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAA;QAExD,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7E,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7E,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAA;QAE7C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QACpD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAE3B,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;QAC7B,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;QAE9B,OAAO;YACL,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,GAAG;SACT,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,WAAmB;QAC5D,MAAM,KAAK,GAAG,YAAY,CAAC,mBAAmB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACnE,OAAO,SAAS,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,WAAmB;QAC5D,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAA;QACtC,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAA;QAEtC,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;IACnD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,wBAAwB,CAC7B,YAAoB,EACpB,UAAkB,EAClB,QAAgB;QAEhB,IAAI,KAAK,GAAG,CAAC,CAAC,UAAU,GAAG,YAAY,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;QAC3D,IAAI,KAAK,GAAG,CAAC,GAAG;YAAE,KAAK,IAAI,GAAG,CAAA;QAC9B,OAAO,CAAC,YAAY,GAAG,GAAG,GAAG,KAAK,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAA;IACtD,CAAC;;AA/GD;;GAEG;AACa,yBAAY,GAAW,OAAO,CAAA"}