@hebcal/noaa 0.8.6 → 0.8.8

package/README.md

@@ -66,7 +66,7 @@ GeoLocation constructor with parameters for all required fields.
 | --- | --- | --- |
 | name | <code>string</code> | The location name for display use such as &quot;Lakewood, NJ&quot; |
 | latitude | <code>number</code> | the latitude in a double format such as 40.095965 for Lakewood, NJ.            <b>Note: </b> For latitudes south of the equator, a negative value should be used. |
-| longitude | <code>number</code> | double the longitude in a double format such as -74.222130 for Lakewood, NJ.            <b>Note: </b> For longitudes east of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime            Meridian </a> (Greenwich), a negative value should be used. |
+| longitude | <code>number</code> | double the longitude in a double format such as -74.222130 for Lakewood, NJ.            <b>Note: </b> For longitudes west of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime            Meridian </a> (Greenwich), a negative value should be used. |
 | elevation | <code>number</code> | the elevation above sea level in Meters. Elevation is not used in most algorithms used for calculating            sunrise and set. |
 | timeZoneId | <code>string</code> | the <code>TimeZone</code> for the location. |
 

package/dist/{cjs/index.js → index.cjs}

@@ -29,24 +29,6 @@ const Long_MIN_VALUE = NaN;
  * @version 1.1
  */
 class GeoLocation {
-    /**
-     * GeoLocation constructor with parameters for all required fields.
-     *
-     * @param {string} name
-     *            The location name for display use such as "Lakewood, NJ"
-     * @param {number} latitude
-     *            the latitude in a double format such as 40.095965 for Lakewood, NJ.
-     *            <b>Note: </b> For latitudes south of the equator, a negative value should be used.
-     * @param {number} longitude
-     *            double the longitude in a double format such as -74.222130 for Lakewood, NJ.
-     *            <b>Note: </b> For longitudes east of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime
-     *            Meridian </a> (Greenwich), a negative value should be used.
-     * @param {number} elevation
-     *            the elevation above sea level in Meters. Elevation is not used in most algorithms used for calculating
-     *            sunrise and set.
-     * @param {string} timeZoneId
-     *            the <code>TimeZone</code> for the location.
-     */
     constructor(name, latitude, longitude, elevationOrTimeZoneId, timeZoneId) {
         /**
          * @private
@@ -139,7 +121,7 @@ class GeoLocation {
      * AstronomicalCalendar to output times in the expected offset. This situation will arise if the
      * AstronomicalCalendar is ever {@link AstronomicalCalendar#clone() cloned}.
      *
-     * @param {string} timeZone
+     * @param {string} timeZoneId
      *            The timeZone to set.
      */
     setTimeZone(timeZoneId) {

package/dist/index.d.ts

@@ -19,7 +19,7 @@ export declare class GeoLocation {
      *            <b>Note: </b> For latitudes south of the equator, a negative value should be used.
      * @param {number} longitude
      *            double the longitude in a double format such as -74.222130 for Lakewood, NJ.
-     *            <b>Note: </b> For longitudes east of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime
+     *            <b>Note: </b> For longitudes west of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime
      *            Meridian </a> (Greenwich), a negative value should be used.
      * @param {number} elevation
      *            the elevation above sea level in Meters. Elevation is not used in most algorithms used for calculating
@@ -28,6 +28,21 @@ export declare class GeoLocation {
      *            the <code>TimeZone</code> for the location.
      */
     constructor(name: string | null, latitude: number, longitude: number, elevation: number, timeZoneId?: string);
+    /**
+     * GeoLocation constructor with parameters for all required fields.
+     *
+     * @param {string} name
+     *            The location name for display use such as &quot;Lakewood, NJ&quot;
+     * @param {number} latitude
+     *            the latitude in a double format such as 40.095965 for Lakewood, NJ.
+     *            <b>Note: </b> For latitudes south of the equator, a negative value should be used.
+     * @param {number} longitude
+     *            double the longitude in a double format such as -74.222130 for Lakewood, NJ.
+     *            <b>Note: </b> For longitudes west of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime
+     *            Meridian </a> (Greenwich), a negative value should be used.
+     * @param {string} timeZoneId
+     *            the <code>TimeZone</code> for the location.
+     */
     constructor(name: string | null, latitude: number, longitude: number, timeZoneId: string);
     /**
      * @private
@@ -105,7 +120,7 @@ export declare class GeoLocation {
      * AstronomicalCalendar to output times in the expected offset. This situation will arise if the
      * AstronomicalCalendar is ever {@link AstronomicalCalendar#clone() cloned}.
      *
-     * @param {string} timeZone
+     * @param {string} timeZoneId
      *            The timeZone to set.
      */
     setTimeZone(timeZoneId: string): void;

package/dist/{esm/index.js → index.js}

@@ -26,31 +26,7 @@ const Long_MIN_VALUE = NaN;
  * @version 1.1
  */
 export class GeoLocation {
-    /**
-     * GeoLocation constructor with parameters for all required fields.
-     *
-     * @param {string} name
-     *            The location name for display use such as "Lakewood, NJ"
-     * @param {number} latitude
-     *            the latitude in a double format such as 40.095965 for Lakewood, NJ.
-     *            <b>Note: </b> For latitudes south of the equator, a negative value should be used.
-     * @param {number} longitude
-     *            double the longitude in a double format such as -74.222130 for Lakewood, NJ.
-     *            <b>Note: </b> For longitudes east of the <a href="http://en.wikipedia.org/wiki/Prime_Meridian">Prime
-     *            Meridian </a> (Greenwich), a negative value should be used.
-     * @param {number} elevation
-     *            the elevation above sea level in Meters. Elevation is not used in most algorithms used for calculating
-     *            sunrise and set.
-     * @param {string} timeZoneId
-     *            the <code>TimeZone</code> for the location.
-     */
     constructor(name, latitude, longitude, elevationOrTimeZoneId, timeZoneId) {
-        /**
-         * @private
-         * @see #getLocationName()
-         * @see #setLocationName(String)
-         */
-        this.locationName = null;
         let elevation = 0;
         if (timeZoneId) {
             elevation = elevationOrTimeZoneId;
@@ -64,6 +40,38 @@ export class GeoLocation {
         this.setElevation(elevation);
         this.setTimeZone(timeZoneId);
     }
+    /**
+     * @private
+     * @see #getLatitude()
+     * @see #setLatitude(double)
+     * @see #setLatitude(int, int, double, String)
+     */
+    latitude;
+    /**
+     * @private
+     * @see #getLongitude()
+     * @see #setLongitude(double)
+     * @see #setLongitude(int, int, double, String)
+     */
+    longitude;
+    /**
+     * @private
+     * @see #getLocationName()
+     * @see #setLocationName(String)
+     */
+    locationName = null;
+    /**
+     * @private
+     * @see #getTimeZone()
+     * @see #setTimeZone(TimeZone)
+     */
+    timeZoneId;
+    /**
+     * @private
+     * @see #getElevation()
+     * @see #setElevation(double)
+     */
+    elevation;
     /**
      * Method to get the elevation in Meters.
      *
@@ -136,7 +144,7 @@ export class GeoLocation {
      * AstronomicalCalendar to output times in the expected offset. This situation will arise if the
      * AstronomicalCalendar is ever {@link AstronomicalCalendar#clone() cloned}.
      *
-     * @param {string} timeZone
+     * @param {string} timeZoneId
      *            The timeZone to set.
      */
     setTimeZone(timeZoneId) {
@@ -190,6 +198,39 @@ export class NOAACalculator {
         this.date = date;
         this.geoLocation = geoLocation;
     }
+    /**
+     * The zenith of astronomical sunrise and sunset. The sun is 90&deg; from the vertical 0&deg;
+     * @private
+     */
+    static GEOMETRIC_ZENITH = 90;
+    /**
+     * Default value for Sun's zenith and true rise/set Zenith (used in this class and subclasses) is the angle that the
+     * center of the Sun makes to a line perpendicular to the Earth's surface. If the Sun were a point and the Earth
+     * were without an atmosphere, true sunset and sunrise would correspond to a 90&deg; zenith. Because the Sun is not
+     * a point, and because the atmosphere refracts light, this 90&deg; zenith does not, in fact, correspond to true
+     * sunset or sunrise, instead the center of the Sun's disk must lie just below the horizon for the upper edge to be
+     * obscured. This means that a zenith of just above 90&deg; must be used. The Sun subtends an angle of 16 minutes of
+     * arc (this can be changed via the {@link #setSunRadius(double)} method , and atmospheric refraction accounts for
+     * 34 minutes or so (this can be changed via the {@link #setRefraction(double)} method), giving a total of 50
+     * arcminutes. The total value for ZENITH is 90+(5/6) or 90.8333333&deg; for true sunrise/sunset.
+     */
+    // const ZENITH: number = GEOMETRIC_ZENITH + 5.0 / 6.0;
+    /** Sun's zenith at civil twilight (96&deg;). */
+    static CIVIL_ZENITH = 96;
+    /** Sun's zenith at nautical twilight (102&deg;). */
+    static NAUTICAL_ZENITH = 102;
+    /** Sun's zenith at astronomical twilight (108&deg;). */
+    static ASTRONOMICAL_ZENITH = 108;
+    /**
+     * The Java Calendar encapsulated by this class to track the current date used by the class
+     * @private
+     */
+    date;
+    /**
+     * the {@link GeoLocation} used for calculations.
+     * @private
+     */
+    geoLocation;
     /**
      * The getSunrise method Returns a `Date` representing the
      * {@link AstronomicalCalculator#getElevationAdjustment(double) elevation adjusted} sunrise time. The zenith used
@@ -540,6 +581,16 @@ export class NOAACalculator {
         }
         return adjustedZenith;
     }
+    /**
+     * The <a href="http://en.wikipedia.org/wiki/Julian_day">Julian day</a> of January 1, 2000
+     * @private
+     */
+    static JULIAN_DAY_JAN_1_2000 = 2451545;
+    /**
+     * Julian days per century
+     * @private
+     */
+    static JULIAN_DAYS_PER_CENTURY = 36525;
     /**
      * @see AstronomicalCalculator#getUTCSunrise(Calendar, GeoLocation, double, boolean)
      */
@@ -1050,36 +1101,3 @@ export class NOAACalculator {
         return timeUTC;
     }
 }
-/**
- * The zenith of astronomical sunrise and sunset. The sun is 90&deg; from the vertical 0&deg;
- * @private
- */
-NOAACalculator.GEOMETRIC_ZENITH = 90;
-/**
- * Default value for Sun's zenith and true rise/set Zenith (used in this class and subclasses) is the angle that the
- * center of the Sun makes to a line perpendicular to the Earth's surface. If the Sun were a point and the Earth
- * were without an atmosphere, true sunset and sunrise would correspond to a 90&deg; zenith. Because the Sun is not
- * a point, and because the atmosphere refracts light, this 90&deg; zenith does not, in fact, correspond to true
- * sunset or sunrise, instead the center of the Sun's disk must lie just below the horizon for the upper edge to be
- * obscured. This means that a zenith of just above 90&deg; must be used. The Sun subtends an angle of 16 minutes of
- * arc (this can be changed via the {@link #setSunRadius(double)} method , and atmospheric refraction accounts for
- * 34 minutes or so (this can be changed via the {@link #setRefraction(double)} method), giving a total of 50
- * arcminutes. The total value for ZENITH is 90+(5/6) or 90.8333333&deg; for true sunrise/sunset.
- */
-// const ZENITH: number = GEOMETRIC_ZENITH + 5.0 / 6.0;
-/** Sun's zenith at civil twilight (96&deg;). */
-NOAACalculator.CIVIL_ZENITH = 96;
-/** Sun's zenith at nautical twilight (102&deg;). */
-NOAACalculator.NAUTICAL_ZENITH = 102;
-/** Sun's zenith at astronomical twilight (108&deg;). */
-NOAACalculator.ASTRONOMICAL_ZENITH = 108;
-/**
- * The <a href="http://en.wikipedia.org/wiki/Julian_day">Julian day</a> of January 1, 2000
- * @private
- */
-NOAACalculator.JULIAN_DAY_JAN_1_2000 = 2451545;
-/**
- * Julian days per century
- * @private
- */
-NOAACalculator.JULIAN_DAYS_PER_CENTURY = 36525;

package/package.json

@@ -1,26 +1,31 @@
 {
   "name": "@hebcal/noaa",
-  "version": "0.8.6",
+  "version": "0.8.8",
   "description": "sunrise and sunset via NOAA algorithm with elevation, based on KosherJava",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "BehindTheMath (https://github.com/BehindTheMath)",
-    "Eliyahu Hershfeld (https://github.com/KosherJava)"
+    "Eliyahu Hershfeld (https://github.com/KosherJava)",
+    "Benny Powers (https://github.com/bennypowers)"
   ],
   "license": "LGPL-3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/hebcal/noaa.git"
   },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "type": "module",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs",
+    "types": "./dist/index.d.ts"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "npm run build:es6 && npm run build:cjs && npm run build:types",
-    "build:cjs": "tsc",
-    "build:es6": "tsc -p ./tsconfig-es6.json",
-    "build:types": "tsc -p ./tsconfig-types.json",
+    "build": "npm run build:cjs && mv dist/index.js dist/index.cjs && npm run build:es6",
+    "build:cjs": "tsc -p ./tsconfig-cjs.json",
+    "build:es6": "tsc",
     "lint": "gts lint",
     "clean": "gts clean",
     "compile": "tsc",
@@ -40,11 +45,11 @@
     "dist/*"
   ],
   "devDependencies": {
-    "@types/node": "20.9.4",
+    "@types/node": "20.10.0",
     "gts": "^5.2.0",
     "typescript": "^5.3.2"
   },
-  "dependencies": {
+  "peerDependencies": {
     "temporal-polyfill": "^0.1.1"
   }
 }