Merge pull request #1132 from moment/typescript-fixes

Fix and update all TypeScript definitions

Author: gilmoreorless

builds/moment-timezone-with-data-10-year-range.d.ts

@@ -0,0 +1,3 @@
+import moment = require('../index');
+
+export = moment;

builds/moment-timezone-with-data-1970-2030.d.ts

@@ -0,0 +1,3 @@
+import moment = require('../index');
+
+export = moment;

builds/moment-timezone-with-data-2012-2022.d.ts

@@ -0,0 +1,3 @@
+import moment = require('../index');
+
+export = moment;

builds/moment-timezone-with-data.d.ts

@@ -0,0 +1,3 @@
+import moment = require('../index');
+
+export = moment;

index.d.ts

@@ -1,16 +1,26 @@
-// Type definitions for moment-timezone.js 0.5
+// Type definitions for moment-timezone.js
 // Project: http://momentjs.com/timezone/
 // Definitions by: Michel Salib <https://github.com/michelsalib>
 //                 Alan Brazil Lins <https://github.com/alanblins>
 //                 Agustin Carrasco <https://github.com/asermax>
 //                 Borys Kupar <https://github.com/borys-kupar>
 //                 Anthony Rainer <https://github.com/pristinesource>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// Migrated here from DefinitelyTyped in release moment-timezone@0.5.30
+// Original source: https://github.com/DefinitelyTyped/DefinitelyTyped
+// Migrated here from DefinitelyTyped in release moment-timezone@0.5.30,
+// then maintained by the Moment team
 
 import moment = require('moment');
 
 declare module 'moment' {
+    /** Parsed / unpacked zone data. */
+    interface UnpackedZone {
+        name: string;
+        abbrs: string[];
+        untils: number[];
+        offsets: number[];
+        population?: number;
+    }
+
     interface MomentZone {
         name: string;
         abbrs: string[];
@@ -19,9 +29,13 @@ declare module 'moment' {
         population: number;
 
         abbr(timestamp: number): string;
+        /**
+         * @deprecated use `.utcOffset()`
+         */
         offset(timestamp: number): number;
         utcOffset(timestamp: number): number;
         parse(timestamp: number): number;
+        countries(): string[];
     }
 
     interface MomentZoneOffset {
@@ -32,26 +46,27 @@ declare module 'moment' {
     interface MomentTimezone {
         (): moment.Moment;
         (timezone: string): moment.Moment;
-        (date: number, timezone: string): moment.Moment;
-        (date: number[], timezone: string): moment.Moment;
-        (date: string, timezone: string): moment.Moment;
+        (date: moment.MomentInput, timezone: string): moment.Moment;
         (date: string, format: moment.MomentFormatSpecification, timezone: string): moment.Moment;
         (date: string, format: moment.MomentFormatSpecification, strict: boolean, timezone: string): moment.Moment;
         (date: string, format: moment.MomentFormatSpecification, language: string, timezone: string): moment.Moment;
         (date: string, format: moment.MomentFormatSpecification, language: string, strict: boolean, timezone: string): moment.Moment;
-        (date: Date, timezone: string): moment.Moment;
-        (date: moment.Moment, timezone: string): moment.Moment;
-        (date: any, timezone: string): moment.Moment;
+
+        version: string;
+        dataVersion: string;
+        moveInvalidForward: boolean;
+        moveAmbiguousForward: boolean;
 
         zone(timezone: string): MomentZone | null;
+        Zone(packedZoneString?: string): MomentZone;
 
         add(packedZoneString: string): void;
         add(packedZoneString: string[]): void;
 
         link(packedLinkString: string): void;
         link(packedLinkString: string[]): void;
 
-        load(data: { version: string; links: string[]; zones: string[] }): void;
+        load(data: { version: string; links: string[]; zones: string[]; countries?: string[] }): void;
 
         names(): string[];
         zonesForCountry<T extends true>(country: string, with_offset: T): T extends true ? MomentZoneOffset[] : never;
@@ -60,8 +75,10 @@ declare module 'moment' {
         countries(): string[];
         guess(ignoreCache?: boolean): string;
 
-        setDefault(timezone?: string): Moment;
-        dataVersion: string;
+        setDefault(timezone?: string): typeof moment;
+
+        unpack(packedZoneString: string): UnpackedZone;
+        unpackBase60(packedString: string): number;
     }
 
     interface Moment {

moment-timezone-utils.d.ts

@@ -1,34 +1,27 @@
-import moment = require('moment');
-import { MomentTimezone } from "./index";
+import moment = require('./index');
 
 declare module 'moment' {
 
-    /** Parsed / unpacked zone data. */
-    interface UnpackedZone {
-        /** The uniquely identifying name of the time zone. */
-        name: string;
-        /** zone abbreviations */
-        abbrs: Array<string>;
-        /** (measured in milliseconds) */
-        untils: Array<number | null>;
-        /** (measured in minutes) */
-        offsets: Array<number>;
-    }
-
-    /** Bundle of zone data and links for multiple timezones */
+    /** Bundle of packed zone data and links for multiple timezones */
     interface PackedZoneBundle {
         version: string;
-        zones: Array<string>;
-        links: Array<string>;
+        zones: string[];
+        links: string[];
     }
 
-    /** Bundle of zone data and links for multiple timezones */
+    /** Bundle of raw zone data and links for multiple timezones */
     interface UnpackedZoneBundle {
         version: string;
-        zones: Array<UnpackedZone>;
-        links: Array<string>;
+        zones: UnpackedZone[];
+        links: string[];
     }
-    
+
+    /** Bundle of timezones for a single country */
+    interface UnpackedCountryData {
+        name: string;
+        zones: string[];
+    }
+
     /** extends MomentTimezone declared in index */
     interface MomentTimezone {
         /** Converts zone data in the unpacked format to the packed format. */
@@ -37,7 +30,11 @@ declare module 'moment' {
         /** Convert a base 10 number to a base 60 string. */
         packBase60(input: number, precision?: number): string;
 
-        /** Create links out of two zones that share data.
+        /** Converts country data in the unpacked format to a packed format. */
+        packCountry(unpacked: UnpackedCountryData): string;
+
+        /**
+         * Create links out of two or more zones that share data.
          * @returns A new ZoneBundle with duplicate zone data replaced by links
          */
         createLinks(unlinked: UnpackedZoneBundle): PackedZoneBundle;

moment-timezone.d.ts

@@ -0,0 +1,3 @@
+import moment = require('./index');
+
+export = moment;

tasks/builds.js

@@ -18,11 +18,13 @@ function staleDataWarning() {
 
 module.exports = function (grunt) {
 	grunt.registerMultiTask('build', 'Build minified versions with data included.', function () {
-		var dest   = 'builds/' + this.target + '.js',
-			data   = require('../data/unpacked/latest.json'),
-			source = grunt.file.read('moment-timezone.js'),
-			start  = 0,
-			end    = 9999;
+		var dest      = 'builds/' + this.target + '.js',
+			typesDest = 'builds/' + this.target + '.d.ts',
+			data      = require('../data/unpacked/latest.json'),
+			source    = grunt.file.read('moment-timezone.js'),
+			typesSrc  = grunt.file.read('moment-timezone.d.ts'),
+			start     = 0,
+			end       = 9999;
 
 		if (this.data && this.data[0]) {
 			start = this.data[0];
@@ -45,5 +47,8 @@ module.exports = function (grunt) {
 		source = source.replace('// INJECT DATA', data);
 
 		grunt.file.write(dest, source);
+
+		typesSrc = typesSrc.replace("'./index'", "'../index'");
+		grunt.file.write(typesDest, typesSrc);
 	});
 };