ntpclient 1.1.1 → 1.1.3

package/cli.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -9,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander = require("commander");
+const commander_1 = require("commander");
 const fs = require("fs");
 const path = require("path");
 const _1 = require("./");
@@ -19,7 +20,7 @@ const packageJsonPath = fs.existsSync(defaultPackageJsonPath)
     : path.join(__dirname, '../package.json');
 const packageJson = fs.readFileSync(packageJsonPath, 'utf-8');
 const { bin, description, version } = JSON.parse(packageJson);
-commander
+commander_1.program
     .name(Object.keys(bin)[0])
     .version(version)
     .description(description)
@@ -27,7 +28,7 @@ commander
     .option('-p, --port <number>', 'Specify a custom NTP port')
     .option('-t, --timeout <number>', 'Specify the timeout in milliseconds')
     .parse(process.argv);
-const commanderOptions = commander.opts();
+const commanderOptions = commander_1.program.opts();
 void (() => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const date = yield new _1.NTPClient(Object.assign(Object.assign(Object.assign({}, (commanderOptions.server && { server: commanderOptions.server })), (commanderOptions.port && { port: commanderOptions.port })), (commanderOptions.timeout && { replyTimeout: commanderOptions.timeout }))).getNetworkTime();

package/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uCAAuC;AACvC,yBAAyB;AACzB,6BAA6B;AAE7B,yBAA6B;AAE7B,MAAM,sBAAsB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACpE,MAAM,eAAe,GAAG,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAC3D,CAAC,CAAC,sBAAsB;IACxB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;AAE5C,MAAM,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAC9D,MAAM,EAAC,GAAG,EAAE,WAAW,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAE5D,SAAS;KACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KACzB,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,qBAAqB,EAAE,6BAA6B,CAAC;KAC5D,MAAM,CAAC,qBAAqB,EAAE,2BAA2B,CAAC;KAC1D,MAAM,CAAC,wBAAwB,EAAE,qCAAqC,CAAC;KACvE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvB,MAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;AAE1C,KAAK,CAAC,GAAS,EAAE;IACf,IAAI;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,YAAS,+CAC3B,CAAC,gBAAgB,CAAC,MAAM,IAAI,EAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAC,CAAC,GAC9D,CAAC,gBAAgB,CAAC,IAAI,IAAI,EAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,EAAC,CAAC,GACxD,CAAC,gBAAgB,CAAC,OAAO,IAAI,EAAC,YAAY,EAAE,gBAAgB,CAAC,OAAO,EAAC,CAAC,EACzE,CAAC,cAAc,EAAE,CAAC;QAEpB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,EAAE,CAAC;KAChB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAA,CAAC,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,yCAA+C;AAC/C,yBAAyB;AACzB,6BAA6B;AAE7B,yBAA6B;AAE7B,MAAM,sBAAsB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACpE,MAAM,eAAe,GAAG,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAC3D,CAAC,CAAC,sBAAsB;IACxB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;AAE5C,MAAM,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAC9D,MAAM,EAAC,GAAG,EAAE,WAAW,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAE5D,mBAAS;KACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KACzB,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,qBAAqB,EAAE,6BAA6B,CAAC;KAC5D,MAAM,CAAC,qBAAqB,EAAE,2BAA2B,CAAC;KAC1D,MAAM,CAAC,wBAAwB,EAAE,qCAAqC,CAAC;KACvE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvB,MAAM,gBAAgB,GAAG,mBAAS,CAAC,IAAI,EAAE,CAAC;AAE1C,KAAK,CAAC,GAAS,EAAE;IACf,IAAI;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,YAAS,+CAC3B,CAAC,gBAAgB,CAAC,MAAM,IAAI,EAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAC,CAAC,GAC9D,CAAC,gBAAgB,CAAC,IAAI,IAAI,EAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,EAAC,CAAC,GACxD,CAAC,gBAAgB,CAAC,OAAO,IAAI,EAAC,YAAY,EAAE,gBAAgB,CAAC,OAAO,EAAC,CAAC,EACzE,CAAC,cAAc,EAAE,CAAC;QAEpB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,EAAE,CAAC;KAChB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAA,CAAC,EAAE,CAAC"}

package/package.json

@@ -3,71 +3,42 @@
   "bin": {
     "ntpclient": "cli.js"
   },
-  "deno": "edition-deno/src/index.ts",
   "dependencies": {
-    "commander": "7.1.0"
+    "commander": "9.4.1"
   },
   "description": "A TypeScript implementation of the NTP Client Protocol",
   "devDependencies": {
-    "@ffflorian/eslint-config": "0.6.2",
-    "@ffflorian/prettier-config": "0.1.2",
-    "@ffflorian/semantic-release-config": "0.5.0",
-    "@semantic-release/changelog": "5.0.1",
-    "@semantic-release/git": "9.0.0",
-    "@types/jasmine": "3.6.3",
-    "@types/node": "~14",
-    "@typescript-eslint/eslint-plugin": "4.0.0",
-    "@typescript-eslint/parser": "3.10.1",
+    "@evilmartians/lefthook": "1.2.1",
+    "@ffflorian/eslint-config": "0.8.3",
+    "@ffflorian/prettier-config": "0.1.4",
+    "@ffflorian/semantic-release-config": "0.5.2",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@types/jasmine": "4.3.0",
+    "@types/node": "~16",
+    "@typescript-eslint/eslint-plugin": "5.43.0",
+    "@typescript-eslint/parser": "5.43.0",
     "babel-eslint": "10.1.0",
     "cpx": "1.5.0",
-    "eslint": "7.20.0",
-    "eslint-config-prettier": "7.2.0",
-    "eslint-plugin-import": "2.22.1",
-    "eslint-plugin-jasmine": "4.1.2",
-    "eslint-plugin-jsdoc": "32.0.2",
-    "eslint-plugin-no-unsanitized": "3.1.4",
-    "eslint-plugin-prettier": "3.3.1",
-    "eslint-plugin-simple-import-sort": "7.0.0",
-    "eslint-plugin-sort-keys-fix": "1.1.1",
-    "eslint-plugin-typescript-sort-keys": "1.5.0",
-    "husky": "5.0.9",
-    "jasmine": "3.6.4",
-    "lint-staged": "10.5.4",
-    "make-deno-edition": "1.2.0",
-    "prettier": "2.2.1",
+    "eslint": "7.32.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jasmine": "4.1.3",
+    "eslint-plugin-jsdoc": "39.6.2",
+    "eslint-plugin-no-unsanitized": "4.0.1",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-simple-import-sort": "8.0.0",
+    "eslint-plugin-sort-keys-fix": "1.1.2",
+    "eslint-plugin-typescript-sort-keys": "2.1.0",
+    "eslint-plugin-unused-imports": "1.1.5",
+    "jasmine": "4.5.0",
+    "prettier": "2.7.1",
     "publish-flat": "1.4.1",
     "rimraf": "3.0.2",
-    "semantic-release": "17.3.9",
-    "ts-node": "9.1.1",
-    "typescript": "4.1.5"
+    "semantic-release": "19.0.5",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.3"
   },
-  "editions": [
-    {
-      "description": "TypeScript source code with import for modules",
-      "directory": "src",
-      "engines": false,
-      "entry": "src/index.ts",
-      "tags": [
-        "source",
-        "typescript",
-        "import"
-      ]
-    },
-    {
-      "description": "TypeScript source code made to be compatible with Deno",
-      "directory": "edition-deno",
-      "entry": "src/index.ts",
-      "tags": [
-        "typescript",
-        "import",
-        "deno"
-      ],
-      "engines": {
-        "deno": true,
-        "browsers": false
-      }
-    }
-  ],
   "engines": {
     "node": ">= 10.9"
   },
@@ -77,26 +48,10 @@
     "cli.js.map",
     "index.d.ts",
     "index.js",
-    "index.js.map"
-  ],
-  "keywords": [
-    "deno",
-    "deno-edition",
-    "deno-entry",
-    "denoland"
+    "index.js.map",
+    "src"
   ],
   "license": "GPL-3.0",
-  "lint-staged": {
-    "*.{json,md}": [
-      "prettier --write"
-    ],
-    "spec/**/*.ts": [
-      "eslint --config .eslintrc.spec.json --fix"
-    ],
-    "src/**/*.ts": [
-      "eslint --fix"
-    ]
-  },
   "main": "index.js",
   "name": "ntpclient",
   "prettier": "@ffflorian/prettier-config",
@@ -105,11 +60,10 @@
   },
   "repository": "https://github.com/ffflorian/ntpclient.git",
   "scripts": {
-    "build:deno": "make-deno-edition",
     "build:ts": "tsc",
-    "clear": "rimraf dist edition-deno",
+    "clear": "rimraf dist",
     "copy:source": "cpx \"src/*.ts\" flattened",
-    "dist": "yarn clear && yarn build:ts && yarn build:deno",
+    "dist": "yarn clear && yarn build:ts",
     "fix": "yarn fix:other && yarn fix:ts",
     "fix:other": "yarn prettier --write",
     "fix:ts": "yarn lint:ts --fix && yarn lint:ts:spec --fix",
@@ -119,10 +73,10 @@
     "lint:ts": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:ts:spec": "eslint --ignore-path .gitignore --ext .ts --config .eslintrc.spec.json spec/",
     "postversion": "node ../node_modules/publish-flat/cli-copy.js -i package.json -o ../package.json version",
-    "prettier": "prettier --ignore-path .gitignore \"*.{json,md}\"",
+    "prettier": "prettier \"*.{json,md,yml}\"",
     "release": "semantic-release",
     "start": "ts-node src/cli.ts",
     "test": "ts-node -P tsconfig.jasmine.json node_modules/.bin/jasmine"
   },
-  "version": "1.1.1"
+  "version": "1.1.3"
 }

package/src/cli.ts

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+import {program as commander} from 'commander';
+import * as fs from 'fs';
+import * as path from 'path';
+
+import {NTPClient} from './';
+
+const defaultPackageJsonPath = path.join(__dirname, 'package.json');
+const packageJsonPath = fs.existsSync(defaultPackageJsonPath)
+  ? defaultPackageJsonPath
+  : path.join(__dirname, '../package.json');
+
+const packageJson = fs.readFileSync(packageJsonPath, 'utf-8');
+const {bin, description, version} = JSON.parse(packageJson);
+
+commander
+  .name(Object.keys(bin)[0])
+  .version(version)
+  .description(description)
+  .option('-s, --server <host>', 'Specify a custom NTP server')
+  .option('-p, --port <number>', 'Specify a custom NTP port')
+  .option('-t, --timeout <number>', 'Specify the timeout in milliseconds')
+  .parse(process.argv);
+
+const commanderOptions = commander.opts();
+
+void (async () => {
+  try {
+    const date = await new NTPClient({
+      ...(commanderOptions.server && {server: commanderOptions.server}),
+      ...(commanderOptions.port && {port: commanderOptions.port}),
+      ...(commanderOptions.timeout && {replyTimeout: commanderOptions.timeout}),
+    }).getNetworkTime();
+
+    console.info(date.toString());
+    process.exit();
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+})();

package/src/index.ts

@@ -0,0 +1,127 @@
+/* eslint-disable no-magic-numbers */
+import * as dgram from 'dgram';
+
+const TEN_SECONDS_IN_MILLIS = 10_000;
+
+export interface NTPConfig {
+  /** Remote NTP Server port number */
+  port?: number;
+  /** Amount of acceptable time to await for a response from the remote server. */
+  replyTimeout?: number;
+  /** IP/Hostname of the remote NTP Server */
+  server?: string;
+}
+
+const defaultConfig: Required<NTPConfig> = {
+  port: 123,
+  replyTimeout: TEN_SECONDS_IN_MILLIS,
+  server: 'pool.ntp.org',
+};
+
+export class NTPClient {
+  private readonly config: Required<NTPConfig>;
+
+  constructor(server?: string, port?: number, timeout?: number);
+  constructor(config?: NTPConfig);
+  constructor(configOrServer?: string | NTPConfig, port?: number, replyTimeout?: number) {
+    this.config = defaultConfig;
+
+    if (typeof configOrServer === 'string') {
+      this.config.server = configOrServer;
+    } else {
+      this.config = {
+        ...this.config,
+        ...configOrServer,
+      };
+    }
+    if (port) {
+      this.config.port = port;
+    }
+    if (replyTimeout) {
+      this.config.replyTimeout = replyTimeout;
+    }
+  }
+
+  /** Fetches the current NTP Time from the given server and port. */
+  public getNetworkTime(ntpReplyTimeout?: number): Promise<Date> {
+    if (ntpReplyTimeout) {
+      this.config.replyTimeout = ntpReplyTimeout;
+    }
+
+    return new Promise((resolve, reject) => {
+      const client = dgram.createSocket('udp4');
+      const ntpData = Buffer.alloc(48);
+
+      // RFC 2030 -> LI = 0 (no warning, 2 bits), VN = 3 (IPv4 only, 3 bits), Mode = 3 (Client Mode, 3 bits) -> 1 byte
+      // -> rtol(LI, 6) ^ rotl(VN, 3) ^ rotl(Mode, 0)
+      // -> = 0x00 ^ 0x18 ^ 0x03
+      ntpData[0] = 0x1b;
+
+      const timeout = setTimeout(() => {
+        client.close();
+        reject(new Error('Timeout waiting for NTP response.'));
+        errorFired = true;
+      }, this.config.replyTimeout);
+
+      /*
+       * Some errors can happen before/after send() or cause send() to break.
+       * Some errors will also be given to send()
+       * NOTE: the error rejection is not generalised, as the client has to
+       * lose the connection also, apparently.
+       */
+      let errorFired = false;
+
+      client.on('error', err => {
+        if (errorFired) {
+          return;
+        }
+
+        errorFired = true;
+        clearTimeout(timeout);
+
+        return reject(err);
+      });
+
+      client.send(ntpData, 0, ntpData.length, this.config.port, this.config.server, err => {
+        if (err) {
+          if (errorFired) {
+            return;
+          }
+          clearTimeout(timeout);
+          errorFired = true;
+          client.close();
+          return reject(err);
+        }
+
+        client.once('message', msg => {
+          clearTimeout(timeout);
+          client.close();
+
+          // Offset to get to the "Transmit Timestamp" field (time at which the reply
+          // departed the server for the client, in 64-bit timestamp format.
+          const offsetTransmitTime = 40;
+          let intpart = 0;
+          let fractpart = 0;
+
+          // Get the seconds part
+          for (let index = 0; index <= 3; index++) {
+            intpart = 256 * intpart + msg[offsetTransmitTime + index];
+          }
+
+          // Get the seconds fraction
+          for (let index = 4; index <= 7; index++) {
+            fractpart = 256 * fractpart + msg[offsetTransmitTime + index];
+          }
+
+          const milliseconds = intpart * 1000 + (fractpart * 1000) / 0x100_000_000;
+
+          // **UTC** time
+          const date = new Date('Jan 01 1900 GMT');
+          date.setUTCMilliseconds(date.getUTCMilliseconds() + milliseconds);
+
+          return resolve(date);
+        });
+      });
+    });
+  }
+}

package/CHANGELOG.md

@@ -1,34 +0,0 @@
-# [1.1.0](https://github.com/ffflorian/ntpclient/compare/v1.0.2...v1.1.0) (2021-02-19)
-
-
-### Features
-
-* Deno edition ([#572](https://github.com/ffflorian/ntpclient/issues/572)) ([ab0b63f](https://github.com/ffflorian/ntpclient/commit/ab0b63fb51d1b986846ea92d99ad8053e1ec5bee))
-
-## [1.0.2](https://github.com/ffflorian/ntpclient/compare/v1.0.1...v1.0.2) (2019-09-06)
-
-### Bug Fixes
-
-- Use postversion when publishing ([762781c](https://github.com/ffflorian/ntpclient/commit/762781c))
-
-## [1.0.1](https://github.com/ffflorian/ntpclient/compare/v1.0.0...v1.0.1) (2019-06-14)
-
-### Bug Fixes
-
-- Use flattened dir to publish ([e431a72](https://github.com/ffflorian/ntpclient/commit/e431a72))
-
-# [1.0.0](https://github.com/ffflorian/ntpclient/compare/v0.8.0...v1.0.0) (2019-06-13)
-
-### Features
-
-- New import structure, remove webpack ([1b6b324](https://github.com/ffflorian/ntpclient/commit/1b6b324))
-
-### BREAKING CHANGES
-
-- NTPClient is not a default export anymore and the 'dist' directory is omitted
-
-# [0.8.0](https://github.com/ffflorian/ntpclient/compare/v0.7.3...v0.8.0) (2019-05-27)
-
-### Features
-
-- Force release ([a13fb26](https://github.com/ffflorian/ntpclient/commit/a13fb26))