vgavara / haversine-ts Goto Github PK

Add Haversine class a new method for calculating the coordinates of a destination point given a source point, a bearing and a distance.

Add suitable unit tests and update the documentation accordingly.

Sample:

  /**
   * Calculates the coordinates of a point given an start point, a distance and
   * a bearing
   *
   * @param {DDPoint} startPoint - Start point, in decimal degrees coordinates.
   * @param {number} distance - Distance from the start point to the targetted
   *   point, using as unit of measure that set in the class constructor
   *   (metres, kilometres or miles).
   * @param {number} bearing Bearing to the targetted point, in degrees (0 to
   *   360, clockwise from North).
   */
  getPoint(startPoint: DDPoint, distance: number, bearing: number): DDPoint {
    if (distance < 0)
      throw new Error("Distance out of range: Must be equal of higher than 0");
    if (bearing < 0 || bearing >= 360)
      throw new Error("Bearing out of range: Must be between 0 and < 360");

    const startLatitude = toRadians(startPoint.latitude);
    const startLongitude = toRadians(startPoint.longitude);
    const angularDistance = distance / this.sphereRadius;

    const targetLatitude = Math.asin(
      Math.sin(startLatitude) * Math.cos(angularDistance) +
        Math.cos(startLatitude) * Math.sin(angularDistance) * Math.cos(bearing)
    );
    const targetLongitude =
      startLongitude +
      Math.atan2(
        Math.sin(bearing) * Math.sin(angularDistance) * Math.cos(startLatitude),
        Math.cos(angularDistance) -
          Math.sin(startLatitude) * Math.sin(targetLatitude)
      );

    return new DDPoint(targetLatitude, targetLongitude);
  }

Add Haversine class a method to find the nearest/farthest point of a list of points to a given reference point:

havesine.getNearest(referencePoint: DDPoint, points: DDPoint[]) => DDPoint
havesine.getFarthest(referencePoint: DDPoint, points: DDPoint[]) => DDPoint

Create a Haversine static class supporting the calculation of the distance between two points.
Also create the Point class addressed to hold a sphere point latitude and longitude.

Create the file set needed for developing a typescript library able to be uploaded to NPM as package. The library must contain:

• Support to linter and prettier, including jsdoc-prettier, on commiting
• Support to unit tests

Coordinates range check must be fixed to validate that latitude ranges from -90 to 90 instead of -180 to 180.

This fix must be performed in both DD and DMS point classes

Create a GitHub workflow to be run when a PR to master/stable branches was created.
The workflow must build the project and run the tests

Add Haversine class a function for calculating the start and end bearings between two points in a sphere.

Add suitable unit tests and upgrade the documentation.

The step setting the npm version breaks, so it is necessary to remove it.

Perform these operations in README.md:

• Add npm, release and license badges
• Move the current heading information to a subsection called "About"
• Keep the current "At a glance" section but convert it into subseciton
• Create a subsection called "Installation"
• Create a subsection called "Usage" describing in detail each class
• Create a subsection called "Support" with a link to the repository issues
• Create a subsection called "License" including a link to the MIT
• Create a subsection called "Contact" with the repo owner email and a link to GitHub and LinkedIn.

Add support to Degrees Minutes Seconds (DMS) coordinates

Set as readonly these class members:

• DDPoint and DMSPoint: latitude and longitude;
• DMSCoordinate: degrees, minutes and seconds
• Haversine: uod and sphereRadius
• SphereBearing: start and end

Add required files, actions and secrets to allow an automatic deployment to NPM once a pull request was merged on branch stable and tagged.

Support @renovate in the repostiory

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency eslint to v8.57.0
• Update dependency prettier to v3.3.1
• Update dependency prettier-plugin-jsdoc to v1.3.0
• Update dependency @typescript-eslint/eslint-plugin to v7
• Update dependency chai to v5
• Update dependency eslint to v9
• Update dependency husky to v9
• Update dependency sinon to v18
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency @types/sinon to v10.0.20
• Update dependency sinon to v16.1.3
• Update dependency ts-node to v10.9.2
• Update dependency @typescript-eslint/eslint-plugin to v6.21.0
• Update dependency chai to v4.4.1 (chai, @types/chai)
• Update dependency eslint-plugin-prettier to v5.1.3
• Update dependency mocha to v10.4.0 (mocha, @types/mocha)
• Update actions/setup-node action to v4
• Update dependency @types/sinon to v17
• Update dependency lint-staged to v15
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency lint-staged to v13.3.0
• Update dependency eslint-config-prettier to v9
• Update dependency typescript to v5

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Add Haversine class a method (getInRange?) to find those points that are in a given distance range from a reference point:

havesine.getInRange(referencePoint: DDPoint, points: DDPoint[], distance: number) => DDPoint[]