ntpclient 1.6.5 → 1.7.0

package/README.md

@@ -9,7 +9,7 @@ TypeScript implementation of the NTP Client Protocol. Based on [node-ntp-client]
 
 ## Installation
 
-ℹ️ This is a hybrid [CommonJS](https://nodejs.org/docs/latest/api/modules.html#modules-commonjs-modules) / [ESM](https://nodejs.org/api/esm.html#introduction) module.
+ℹ️ This is a pure [ESM](https://nodejs.org/api/esm.html#introduction) module.
 
 Run `yarn add ntpclient` or `npm i ntpclient`.
 

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

@@ -1,9 +1,13 @@
 #!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { program as commander } from 'commander';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
 import { NTPClient } from './index.js';
-const { bin, description, version } = require('../package.json');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJsonPath = path.join(__dirname, '../package.json');
+const { bin, description, version } = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
 commander
     .name(Object.keys(bin)[0])
     .version(version)

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

@@ -1,4 +1,4 @@
-import * as dgram from 'dgram';
+import * as dgram from 'node:dgram';
 const TEN_SECONDS_IN_MILLIS = 10000;
 const defaultConfig = {
     port: 123,

package/package.json

@@ -1,43 +1,34 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
-  "bin": "dist/cjs/cli.js",
+  "bin": "dist/cli.js",
   "dependencies": {
     "commander": "12.1.0"
   },
   "description": "A TypeScript implementation of the NTP Client Protocol",
   "devDependencies": {
-    "rimraf": "5.0.7",
-    "typescript": "5.5.2",
-    "vitest": "1.6.0"
+    "rimraf": "6.0.1",
+    "typescript": "5.5.4",
+    "vitest": "2.0.5"
   },
   "engines": {
     "node": ">= 18.0"
   },
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    }
-  },
+  "exports": "./dist/index.js",
   "files": [
     "dist"
   ],
   "license": "GPL-3.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "module": "dist/index.js",
   "name": "ntpclient",
   "repository": "https://github.com/ffflorian/node-packages/tree/main/packages/ntpclient",
   "scripts": {
-    "build": "yarn build:cjs && yarn build:esm && yarn generate:packagejson",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "generate:packagejson": "../../bin/generate-hybrid-package-json.sh",
     "start": "node --loader ts-node/esm src/cli.ts",
     "test": "vitest run"
   },
   "type": "module",
-  "version": "1.6.5",
-  "gitHead": "f7a6a79286e4eb85392b5f2d33942ab166142109"
+  "version": "1.7.0",
+  "gitHead": "f1a74d8ec9721d5b52a00e41b2ec73278e048290"
 }

package/dist/cjs/cli.js

@@ -1,30 +0,0 @@
-#!/usr/bin/env node
-import { program as commander } from 'commander';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-import { NTPClient } from './index.js';
-const { bin, description, version } = require('../package.json');
-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/dist/cjs/index.js

@@ -1,94 +0,0 @@
-import * as dgram from 'dgram';
-const TEN_SECONDS_IN_MILLIS = 10000;
-const defaultConfig = {
-    port: 123,
-    replyTimeout: TEN_SECONDS_IN_MILLIS,
-    server: 'pool.ntp.org',
-};
-export class NTPClient {
-    constructor(configOrServer, port, replyTimeout) {
-        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. */
-    getNetworkTime(ntpReplyTimeout) {
-        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) / 4294967296;
-                    // **UTC** time
-                    const date = new Date('Jan 01 1900 GMT');
-                    date.setUTCMilliseconds(date.getUTCMilliseconds() + milliseconds);
-                    return resolve(date);
-                });
-            });
-        });
-    }
-}

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/esm/cli.d.ts

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

package/dist/esm/index.d.ts

@@ -1,15 +0,0 @@
-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;
-}
-export declare class NTPClient {
-    private readonly config;
-    constructor(server?: string, port?: number, timeout?: number);
-    constructor(config?: NTPConfig);
-    /** Fetches the current NTP Time from the given server and port. */
-    getNetworkTime(ntpReplyTimeout?: number): Promise<Date>;
-}

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}