Add leap seconds, TAI, etc. (#8)

* Added leap second handling and TAI/TDT support.
* Now supports Universal Time with smooth, integrated transition between calculated UT1, proleptic UTC, and official UTC.
* Uses timezone data generated by @tubular/time-tzdb.
* Added jde, mjde, jdu, mjdu, and deltaTai fields to DateAndTime.
* Case-insensitive timezone lookup.
* Added ability to add/subtract TAI time.
* Added negative length option to toIsoString().
* Deprecated utcTimeMillis and utcTimeSeconds in favor of utcMillis and utcSeconds.
* Added Timezone.version.

Author: kshetline

.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

.npmignore

@@ -15,3 +15,4 @@
 *.tgz
 /test.html
 .travis.yml
+.coveralls.yml

.nycrc

@@ -0,0 +1,3 @@
+{
+  "exclude": ["src/zone-*.ts"]
+}

.travis.yml

@@ -1,3 +1,4 @@
 language: node_js
 node_js:
   - "14"
+after_success: npm run coverage

README.md

@@ -1,6 +1,6 @@
 {
   "name": "@tubular/time",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Date/time, IANA timezones, calendar with settable Julian/Gregorian switchover",
   "browser": "dist/web/index.js",
   "browser-es5": "dist/web5/index.js",
@@ -12,7 +12,8 @@
   "sideEffects": false,
   "scripts": {
     "build": "rimraf dist/ && tsc && tsc --build tsconfig.es6.json && tsc --build tsconfig.es5.json && webpack && webpack --env esver=5 && ts-node make-remote-zone-data.ts",
-    "prepublishOnly": "npm run build",
+    "coverage": "nyc report --reporter=text-lcov | coveralls",
+    "prepack": "npm run build",
     "lint": "eslint 'src/**/*.ts' '**/*.cjs'",
     "test": "TS_NODE_FILES=true nyc --reporter=html mocha --require ts-node/register src/**/*.spec.ts",
     "document": "typedoc --name \"ks-date-time-zone\" --module commonjs --exclude \"**/*+(e2e|spec|index).ts\" --excludePrivate --excludeProtected --readme README.md --target ES5 --out docs src"
@@ -23,8 +24,10 @@
     "gregorian",
     "iana",
     "julian",
+    "leap second",
     "moment",
     "olson",
+    "tai",
     "time",
     "time zone",
     "timezone",
@@ -35,21 +38,22 @@
   "license": "MIT",
   "dependencies": {
     "@tubular/math": "^2.2.1",
-    "@tubular/util": "^3.5.0"
+    "@tubular/util": "^3.6.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.13.8",
-    "@babel/preset-env": "^7.13.9",
-    "@babel/register": "^7.13.8",
-    "@types/chai": "^4.2.14",
-    "@types/mocha": "^8.0.4",
-    "@types/node": "^14.14.22",
-    "@typescript-eslint/eslint-plugin": "^4.16.1",
-    "@typescript-eslint/parser": "^4.16.1",
+    "@babel/core": "^7.13.15",
+    "@babel/preset-env": "^7.13.15",
+    "@babel/register": "^7.13.14",
+    "@types/chai": "^4.2.16",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "^14.14.41",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
     "babel-loader": "^8.2.2",
     "by-request": "^1.2.0",
     "chai": "^4.2.0",
-    "eslint": "^7.21.0",
+    "coveralls": "^3.1.0",
+    "eslint": "^7.24.0",
     "eslint-plugin-chai-friendly": "^0.6.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-node": "^11.1.0",
@@ -60,9 +64,9 @@
     "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^4.2.3",
     "ts-node": "^9.1.1",
-    "typescript": "^4.2.2",
-    "webpack": "^5.24.2",
-    "webpack-cli": "^4.5.0",
+    "typescript": "^4.2.4",
+    "webpack": "^5.34.0",
+    "webpack-cli": "^4.6.0",
     "webpack-node-externals": "^2.5.2"
   },
   "repository": "github:kshetline/tubular_time.git"

package-lock.json

@@ -1,12 +1,17 @@
 import { assert, expect } from 'chai';
-import { getISOFormatDate, Calendar, LAST, getDayNumber_SGC, getDayNumberGregorian, getDayNumberJulian, isValidDate_SGC } from './calendar';
+import {
+  getISOFormatDate, Calendar, LAST, getDayNumber_SGC, getDayNumberGregorian, getDayNumberJulian, isValidDate_SGC,
+  getLastDateInMonth_SGC, getDaysInMonth_SGC, getDayOfWeek_SGC, getDayOfWeekInMonthCount_SGC, getDayOnOrBefore_SGC,
+  WEDNESDAY, MONDAY, getDayOnOrAfter_SGC
+} from './calendar';
 import { YMDDate } from './common';
 import { DateTime } from './date-time';
 
 describe('Calendar', () => {
-  const calendar = new Calendar();
+  let calendar: Calendar;
 
   beforeEach(() => {
+    calendar = new Calendar();
     DateTime.setDefaultLocale('en-us');
     DateTime.setDefaultTimezone('America/New_York');
   });
@@ -26,6 +31,8 @@ describe('Calendar', () => {
     expect(getDayNumberGregorian({ y: 2021, dy: 40 })).to.equal(18667);
     expect(getDayNumberGregorian({ n: 34567 })).to.equal(34567);
     expect(getDayNumberGregorian({ n: -234567 })).to.equal(-234567);
+    expect(getDayNumberJulian({ y: 2021, m: 0, d: 31 })).to.equal(18640);
+    expect(getDayNumberJulian({ y: 2020, m: 13, d: 1 })).to.equal(18641);
     expect(getDayNumberJulian({ y: 2021 })).to.equal(18641);
     expect(getDayNumberJulian({ y: 2021, m: 3 })).to.equal(18700);
     expect(getDayNumberJulian({ y: 2021, m: 3, d: 2 })).to.equal(18701);
@@ -35,8 +42,11 @@ describe('Calendar', () => {
     expect(() => getDayNumber_SGC({})).to.throw('Calendar: Invalid date arguments');
     expect(getDayNumber_SGC({ y: 2021, j: false })).to.equal(18628);
     expect(getDayNumber_SGC({ y: 2021, j: true })).to.equal(18641);
+    expect(getDayNumber_SGC({ y: 2021, m: 0, d: 31 })).to.equal(18627);
+    expect(getDayNumber_SGC({ y: 2020, m: 13, d: 1 })).to.equal(18628);
     expect(isValidDate_SGC({ y: 1582, m: 10, d: 7 })).to.be.false;
     expect(isValidDate_SGC({ y: 1582, m: 10, d: 7, j: true })).to.be.true;
+    expect(calendar.isValidDate([1582, 10, 7])).to.be.false;
   });
 
   it('should consistently convert the date for a day number back to the same day number.', () => {
@@ -62,6 +72,7 @@ describe('Calendar', () => {
 
   it('should return Saturday (6) for 1962-10-13.', () => {
     expect(calendar.getDayOfWeek(1962, 10, 13)).to.equal(6);
+    expect(getDayOfWeek_SGC(1962, 10, 13)).to.equal(6);
   });
 
   it('should return Friday (5) for 2016-12-16.', () => {
@@ -72,10 +83,35 @@ describe('Calendar', () => {
     expect(calendar.getDateOfNthWeekdayOfMonth(2016, 11, 4, 4)).to.equal(24);
   });
 
+  it('should get proper last day for February.', () => {
+    expect(calendar.getLastDateInMonth(1900, 2)).to.equal(28);
+    expect(calendar.getLastDateInMonth(1904, 2)).to.equal(29);
+    expect(calendar.getLastDateInMonth(1905, 2)).to.equal(28);
+    expect(calendar.getLastDateInMonth(2000, 2)).to.equal(29);
+    expect(calendar.getDaysInMonth(1900, 2)).to.equal(28);
+    expect(calendar.getDaysInMonth(1904, 2)).to.equal(29);
+    expect(calendar.getDaysInMonth(1905, 2)).to.equal(28);
+    expect(calendar.getDaysInMonth(2000, 2)).to.equal(29);
+    calendar.setPureJulian(true);
+    expect(calendar.isPureJulian()).to.be.true;
+    expect(calendar.getLastDateInMonth(1900, 2)).to.equal(29);
+
+    expect(getLastDateInMonth_SGC(1900, 2)).to.equal(28);
+    expect(getLastDateInMonth_SGC(1904, 2)).to.equal(29);
+    expect(getLastDateInMonth_SGC(1905, 2)).to.equal(28);
+    expect(getLastDateInMonth_SGC(2000, 2)).to.equal(29);
+    expect(getDaysInMonth_SGC(1900, 2)).to.equal(28);
+    expect(getDaysInMonth_SGC(1904, 2)).to.equal(29);
+    expect(getDaysInMonth_SGC(1905, 2)).to.equal(28);
+    expect(getDaysInMonth_SGC(2000, 2)).to.equal(29);
+  });
+
   it('should return a series of Tuesdays at the correct index for each month.', () => {
     let match = true;
     let countMatch = true;
+    let countMatch2 = true;
     let count = 0;
+    let count2 = 0;
     let expectedCount = 0;
     let month = 1;
     let day: number;
@@ -89,8 +125,10 @@ describe('Calendar', () => {
         ++index;
       else {
         count = calendar.getDayOfWeekInMonthCount(lastYmd?.y, lastYmd?.m, 2);
+        count2 = getDayOfWeekInMonthCount_SGC(lastYmd?.y, lastYmd?.m, 2);
         expectedCount = index;
         countMatch = (count === expectedCount);
+        countMatch2 = (count2 === expectedCount);
         index = 1;
         month = ymd.m;
       }
@@ -102,20 +140,21 @@ describe('Calendar', () => {
 
     assert(match, getISOFormatDate(ymd) + ' -> ' + index + ': ' + day);
     assert(countMatch, getISOFormatDate(lastYmd) + ' -> ' + count + ' counted, ' + expectedCount + ' expected.');
+    assert(countMatch2, getISOFormatDate(lastYmd) + ' -> ' + count2 + ' counted, ' + expectedCount + ' expected.');
   });
 
   it('should have only 19 days in September 1752 when most of North America switched to the Gregorian calendar.', () => {
     calendar.setGregorianChange(1752, 9, 14);
     expect(calendar.getDaysInMonth(1752, 9)).to.equal(19);
   });
 
-  // Proceeding with modified Gregorian Calendar change...
-
   it('should return 30 as the third Saturday of 1752/09.', () => {
+    calendar.setGregorianChange(1752, 9, 14);
     expect(calendar.getDateOfNthWeekdayOfMonth(1752, 9, 6, 3)).to.equal(30);
   });
 
   it('should return 30 as the last Saturday of 1752/09.', () => {
+    calendar.setGregorianChange(1752, 9, 14);
     expect(calendar.getDateOfNthWeekdayOfMonth(1752, 9, 6, LAST)).to.equal(30);
   });
 
@@ -152,4 +191,36 @@ describe('Calendar', () => {
     expect(calendar.getYearWeekAndWeekday([2021,  1,  3])).to.eql([2020, 53, 7]);
     expect(calendar.getYearWeekAndWeekday([2021,  1,  4])).to.eql([2021,  1, 1]);
   });
+
+  it('should properly handle various Julian/Gregorian crossovers.', () => {
+    calendar = new Calendar([1752, 9, 14]);
+    expect(calendar.getDaysInMonth(1752, 9)).to.equal(19);
+    expect(calendar.getDaysInMonth(1752, 10)).to.equal(31);
+    expect(calendar.getMissingDateRange(1752, 9)).to.eql([3, 13]);
+
+    const dayNum = calendar.getDayNumber(1752, 9, 2);
+
+    calendar.setPureGregorian(true);
+    expect(calendar.isPureGregorian()).to.be.true;
+    expect(calendar.getDateFromDayNumber(dayNum)).to.include({ y: 1752, m: 9, d: 13 });
+    expect(calendar.getMissingDateRange(1752, 9)).to.equal(null);
+    calendar.setPureGregorian(false);
+    expect(calendar.getDateFromDayNumber(dayNum)).to.include({ y: 1752, m: 9, d: 13 });
+    calendar.setGregorianChange('j');
+    expect(calendar.getDateFromDayNumber(dayNum)).to.include({ y: 1752, m: 9, d: 2 });
+  });
+
+  it('should properly handle getDayOnOrAfter.', () => {
+    expect(getDayOnOrAfter_SGC(2022, 8, MONDAY, 1)).to.equal(1);
+    expect(calendar.getDayOnOrAfter(2022, 8, MONDAY, 1)).to.equal(1);
+    expect(getDayOnOrAfter_SGC(2022, 8, MONDAY, 2)).to.equal(8);
+    expect(calendar.getDayOnOrAfter(2022, 8, MONDAY, 2)).to.equal(8);
+  });
+
+  it('should properly handle getDayOnOrBefore.', () => {
+    expect(getDayOnOrBefore_SGC(2021, 4, WEDNESDAY, 21)).to.equal(21);
+    expect(calendar.getDayOnOrBefore(2021, 4, WEDNESDAY, 21)).to.equal(21);
+    expect(getDayOnOrBefore_SGC(2021, 4, WEDNESDAY, 20)).to.equal(14);
+    expect(calendar.getDayOnOrBefore(2021, 4, WEDNESDAY, 20)).to.equal(14);
+  });
 });

package.json

@@ -348,7 +348,7 @@ export function getDayOfWeekInMonthCount_SGC(year: number, month: number, dayOfT
   const firstDay = getDayNumber_SGC(year, month, getDateOfNthWeekdayOfMonth_SGC(year, month, dayOfTheWeek, 1));
   const nextMonth = getDayNumber_SGC(year, month + 1, 1);
 
-  return (nextMonth - firstDay - 1) / 7 + 1;
+  return div_tt0(nextMonth - firstDay - 1, 7) + 1;
 }
 
 export function getDayOnOrAfter_SGC(year: number, month: number, dayOfTheWeek: number, minDate: number): number {
@@ -921,13 +921,17 @@ export class Calendar {
     return dates;
   }
 
+  isValidDate(year: number, month: number, day: number): boolean;
+  isValidDate(yearOrDate: YMDDate | number[]): boolean;
   isValidDate(yearOrDate: YearOrDate, month?: number, day?: number): boolean {
     let year: number; [year, month, day] = handleVariableDateArgs(yearOrDate, month, day, this, true);
     const ymd = this.getDateFromDayNumber(this.getDayNumber(year, month, day));
 
     return (year === ymd.y && month === ymd.m && day === ymd.d);
   }
 
+  normalizeDate(year: number, month: number, day: number): YMDDate;
+  normalizeDate(yearOrDate: YMDDate | number[]): YMDDate;
   normalizeDate(yearOrDate: YearOrDate, month?: number, day?: number): YMDDate {
     let year: number; [year, month, day] = handleVariableDateArgs(yearOrDate, month, day, this, true);
 

src/calendar.spec.ts

@@ -3,7 +3,20 @@ import { getDateFromDayNumber_SGC, getDayNumber_SGC } from './calendar';
 import { isNumber, toNumber } from '@tubular/util';
 
 export const MIN_YEAR = -271820;
-export const MAX_YEAR = 275759;
+export const MAX_YEAR =  275759;
+
+export const MINUTE_MSEC =     60_000;
+export const HOUR_MSEC   =  3_600_000;
+export const DAY_MSEC    = 86_400_000;
+export const DAY_SEC     =     86_400;
+export const DAY_MINUTES =       1440;
+
+export const UNIX_TIME_ZERO_AS_JULIAN_DAY = 2440587.5;
+export const JD_J2000 = 2451545.0; // Julian date for the J2000.0 epoch.
+export const DELTA_TDT_SEC = 32.184;
+export const DELTA_TDT_MSEC = 32184;
+export const DELTA_TDT_DAYS = DELTA_TDT_SEC / DAY_SEC;
+export const DELTA_MJD = 2400000.5;
 
 /**
  * Specifies a calendar date by year, month, and day. Optionally provides day number and boolean flag indicating Julian
@@ -70,6 +83,16 @@ export interface DateAndTime extends YMDDate {
   utcOffset?: number;
   dstOffset?: number;
   occurrence?: number;
+  deltaTai?: number;
+
+  /** Julian days, ephemeris. */
+  jde?: number;
+  /** Modified Julian days, ephemeris. */
+  mjde?: number;
+  /** Julian days, UT. */
+  jdu?: number;
+  /** Modified Julian days, UT. */
+  mjdu?: number;
 }
 
 const altFields = [
@@ -88,9 +111,9 @@ const fieldOrder = [
   'ywl', 'wl', 'dwl',
   'yearByWeekLocale', 'weekLocale', 'dayByWeekLocale',
   'hrs', 'min', 'sec',
-  'hour', 'minute', 'second',
-  'millis',
-  'utcOffset', 'dstOffset', 'occurrence',
+  'hour', 'minute', 'second', 'millis',
+  'utcOffset', 'dstOffset', 'occurrence', 'deltaTai',
+  'jde', 'mjde', 'jdu', 'mjdu',
   'error'
 ];
 
@@ -128,27 +151,29 @@ export function orderFields<T extends YMDDate | DateAndTime>(obj: T): T {
 }
 
 export function validateDateAndTime(obj: YMDDate | DateAndTime): void {
+  const dt = obj as DateAndTime;
+
   Object.keys(obj).forEach(key => {
     if (key !== 'j' && key !== 'isJulian') {
       const value = obj[key];
 
-      if (value != null && !isNumber(value) || value !== floor(value))
-        throw new Error(`${key} must be an integer value (${value})`);
+      if (value != null) {
+        if (/^(m?(jde|jdu))$/.test(key)) {
+          if (!isNumber(value))
+            throw new Error(`${key} must be a numeric value (${value})`);
+        }
+        else if (!isNumber(value) || value !== floor(value))
+          throw new Error(`${key} must be an integer value (${value})`);
+      }
     }
   });
 
   if (obj.y == null && obj.year == null && obj.yw == null && obj.yearByWeek == null &&
       obj.ywl == null && obj.yearByWeekLocale == null && obj.n == null && obj.epochDay == null &&
-      (obj as DateAndTime).hrs == null && (obj as DateAndTime).hour == null)
-    throw new Error('A year value, an epoch day, or an hour value must be specified');
+      dt.hrs == null && dt.hour == null && dt.jde == null && dt.mjde == null && dt.jdu == null && dt.mjdu == null)
+    throw new Error('A year value, an epoch day, an hour value, or a Julian date value must be specified');
 }
 
-export const MINUTE_MSEC =    60000;
-export const HOUR_MSEC   =  3600000;
-export const DAY_MSEC    = 86400000;
-
-export const DAY_MINUTES = 1440;
-
 export function millisFromDateTime_SGC(year: number, month: number, day: number, hour: number, minute: number, second?: number, millis?: number): number {
   millis = millis || 0;
   second = second || 0;
@@ -161,7 +186,7 @@ export function millisFromDateTime_SGC(year: number, month: number, day: number,
 }
 
 export function dateAndTimeFromMillis_SGC(ticks: number): DateAndTime {
-  const wallTime = getDateFromDayNumber_SGC(div_rd(ticks, 86400000)) as DateAndTime;
+  const wallTime = getDateFromDayNumber_SGC(div_rd(ticks, DAY_MSEC)) as DateAndTime;
 
   wallTime.millis = mod(ticks, 1000);
   ticks = div_rd(ticks, 1000);