geonet/dist/src/utils/QuakeMapUtil.js

A Node.js API wrapper for GeoNet — Aotearoa's geological hazard monitoring system.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.QuakeMapUtil = void 0;
const common_1 = require("../../@types/common");
/**
 * Utility class for generating GeoNet earthquake map URLs.
 *
 * @since 1.0.0
 */
class QuakeMapUtil {
    baseMapURL = "https://static.geonet.org.nz/maps/4/quake/xxxhdpi/";
    /**
     * Generates a link to the GeoNet quake map URL for a given set of coordinates and MMI.
     *
     * @param {Geometry["coordinates"]} coordinates - The coordinates of the quake. Position 0 is the longitude, and position 1 is the latitude.
     * @param {MMI} mmi - The New Zealand Modified Mercalli Intensity of the quake.
     * @returns {string} - The URL string for the quake map.
     * @throws {Error} - Throws an error if the coordinates are invalid or if the MMI is not provided.
     * @since 1.0.0
     */
    generateMapURL(coordinates, mmi) {
        if (!coordinates || !Array.isArray(coordinates) || coordinates.length !== 2) {
            throw new Error("Invalid coordinates provided.");
        }
        if (isNaN(coordinates[0]) || isNaN(coordinates[1])) {
            throw new Error("Coordinates must be an integer.");
        }
        if (mmi === undefined || (!Object.values(common_1.MMI).includes(mmi)))
            throw new Error("MMI not provided, or was not a valid MMI.");
        const formattedCoordinates = Math.round(coordinates[0]) + "E" + Math.abs(Math.round(coordinates[1])) + "S";
        let intensity;
        switch (mmi) {
            case common_1.MMI.Weak:
                intensity = "weak";
                break;
            case common_1.MMI.Light:
                intensity = "light";
                break;
            case common_1.MMI.Moderate:
                intensity = "moderate";
                break;
            case common_1.MMI.Strong:
                intensity = "strong";
                break;
            case common_1.MMI.Severe:
                intensity = "severe";
                break;
            case common_1.MMI.Extreme:
                intensity = "extreme";
                break;
            default:
                intensity = "unnoticeable";
                break;
        }
        return `${this.baseMapURL}${formattedCoordinates}-${intensity}.png`;
    }
    /**
     * Generates a colour code for a given MMI, which corresponds to the marker colour on GeoNet maps.
     *
     * @param {MMI} mmi - The New Zealand Modified Mercalli Intensity of the quake.
     * @returns {string} - The hex code colour for the earthquake based off of the MMI.
     * @throws {Error} - Throws an error if the MMI is not provided, or is invalid.
     * @since 1.1.0
     */
    generateColourCode(mmi) {
        if (mmi === undefined || (!Object.values(common_1.MMI).includes(mmi)))
            throw new Error("MMI not provided, or was not a valid MMI.");
        let colour;
        switch (mmi) {
            case common_1.MMI.Weak:
                colour = "#FDD0A2";
                break;
            case common_1.MMI.Light:
                colour = "#FDAE6B";
                break;
            case common_1.MMI.Moderate:
                colour = "#FD8D3C";
                break;
            case common_1.MMI.Strong:
                colour = "#F16913";
                break;
            case common_1.MMI.Severe:
                colour = "#F03B20";
                break;
            case common_1.MMI.Extreme:
                colour = "#8C2D04";
                break;
            default:
                colour = "#FEECDE";
                break;
        }
        return colour;
    }
}
exports.QuakeMapUtil = QuakeMapUtil;