Changed from commonJS module to ESM.

senbar · senbar · commit 36cd5e9523b1 · 2024-01-08T09:38:52.000Z
diff --git a/.eslintrc b/.eslintrc
@@ -3,6 +3,9 @@
   "env": {
     "es6": true
   },
+  "parserOptions": {
+    "sourceType": "module"
+  },
   "rules": {
     "no-var": 2,
     "no-const-assign": 2,
diff --git a/package.json b/package.json
@@ -2,7 +2,8 @@
   "name": "web-push",
   "version": "3.6.6",
   "description": "Web Push library for Node.js",
-  "main": "src/index.js",
+  "type": "module",
+  "exports": "./src/index.js",
   "bin": {
     "web-push": "src/cli.js"
   },
diff --git a/src/cli.js b/src/cli.js
@@ -1,9 +1,7 @@
 #! /usr/bin/env node
 /* eslint consistent-return:0 */
-
-'use strict';
-
-const webPush = require('../src/index.js');
+import * as webPush from '../src/index.js';
+import minimist from 'minimist';
 
 const printUsageDetails = () => {
   const actions = [
@@ -80,7 +78,7 @@ const sendNotification = args => {
     options.TTL = args.ttl;
   }
 
-  if (argv['vapid-subject'] || argv['vapid-pubkey'] || argv['vapid-pvtkey']) {
+  if (args['vapid-subject'] || args['vapid-pubkey'] || args['vapid-pvtkey']) {
     options.vapidDetails = {
       subject: args['vapid-subject'] || null,
       publicKey: args['vapid-pubkey'] || null,
@@ -112,20 +110,24 @@ const sendNotification = args => {
   });
 };
 
-const action = process.argv[2];
-const argv = require('minimist')(process.argv.slice(3));
-switch (action) {
-  case 'send-notification':
-    if (!argv.endpoint) {
-      return printUsageDetails();
-    }
+const executeCliAction = () => {
+  const action = process.argv[2];
+  const argv = minimist(process.argv.slice(3));
+  switch (action) {
+    case 'send-notification':
+      if (!argv.endpoint) {
+        return printUsageDetails();
+      }
+
+      sendNotification(argv);
+      break;
+    case 'generate-vapid-keys':
+      generateVapidKeys(argv.json || false);
+      break;
+    default:
+      printUsageDetails();
+      break;
+  }
+};
 
-    sendNotification(argv);
-    break;
-  case 'generate-vapid-keys':
-    generateVapidKeys(argv.json || false);
-    break;
-  default:
-    printUsageDetails();
-    break;
-}
+executeCliAction();
diff --git a/src/encryption-helper.js b/src/encryption-helper.js
@@ -1,9 +1,7 @@
-'use strict';
+import crypto from 'crypto';
+import ece from 'http_ece';
 
-const crypto = require('crypto');
-const ece = require('http_ece');
-
-const encrypt = function(userPublicKey, userAuth, payload, contentEncoding) {
+export function encrypt(userPublicKey, userAuth, payload, contentEncoding) {
   if (!userPublicKey) {
     throw new Error('No user public key provided for encryption.');
   }
@@ -55,8 +53,4 @@ const encrypt = function(userPublicKey, userAuth, payload, contentEncoding) {
     salt: salt,
     cipherText: cipherText
   };
-};
-
-module.exports = {
-  encrypt: encrypt
-};
+}
diff --git a/src/index.js b/src/index.js
@@ -1,21 +1,23 @@
-'use strict';
-
-const vapidHelper = require('./vapid-helper.js');
-const encryptionHelper = require('./encryption-helper.js');
-const WebPushLib = require('./web-push-lib.js');
-const WebPushError = require('./web-push-error.js');
-const WebPushConstants = require('./web-push-constants.js');
+import { getVapidHeaders, generateVAPIDKeys } from './vapid-helper.js';
+import { encrypt } from './encryption-helper.js';
+import { WebPushLib } from './web-push-lib.js';
+import WebPushError from './web-push-error.js';
+import WebPushConstants from './web-push-constants.js';
 
 const webPush = new WebPushLib();
 
-module.exports = {
-  WebPushError: WebPushError,
-  supportedContentEncodings: WebPushConstants.supportedContentEncodings,
-  encrypt: encryptionHelper.encrypt,
-  getVapidHeaders: vapidHelper.getVapidHeaders,
-  generateVAPIDKeys: vapidHelper.generateVAPIDKeys,
-  setGCMAPIKey: webPush.setGCMAPIKey,
-  setVapidDetails: webPush.setVapidDetails,
-  generateRequestDetails: webPush.generateRequestDetails,
-  sendNotification: webPush.sendNotification.bind(webPush)
+const { supportedContentEncodings } = WebPushConstants;
+const { setGCMAPIKey, setVapidDetails, generateRequestDetails } = webPush;
+const sendNotification = webPush.sendNotification.bind(webPush);
+
+export {
+  WebPushError,
+  supportedContentEncodings,
+  encrypt,
+  getVapidHeaders,
+  generateVAPIDKeys,
+  setGCMAPIKey,
+  setVapidDetails,
+  generateRequestDetails,
+  sendNotification
 };
diff --git a/src/urlsafe-base64-helper.js b/src/urlsafe-base64-helper.js
@@ -1,13 +1,7 @@
-'use strict';
-
 /**
  * @param {string} base64
  * @returns {boolean}
  */
-function validate(base64) {
+export function validate(base64) {
   return /^[A-Za-z0-9\-_]+$/.test(base64);
 }
-
-module.exports = {
-  validate: validate
-};
diff --git a/src/vapid-helper.js b/src/vapid-helper.js
@@ -1,12 +1,10 @@
-'use strict';
+import crypto from 'crypto';
+import asn1 from 'asn1.js';
+import jws from 'jws';
+import { URL } from 'url';
 
-const crypto = require('crypto');
-const asn1 = require('asn1.js');
-const jws = require('jws');
-const { URL } = require('url');
-
-const WebPushConstants = require('./web-push-constants.js');
-const urlBase64Helper = require('./urlsafe-base64-helper');
+import WebPushConstants from './web-push-constants.js';
+import * as urlBase64Helper from './urlsafe-base64-helper.js';
 
 /**
  * DEFAULT_EXPIRATION is set to seconds in 12 hours
@@ -37,7 +35,7 @@ function toPEM(key) {
   });
 }
 
-function generateVAPIDKeys() {
+export function generateVAPIDKeys() {
   const curve = crypto.createECDH('prime256v1');
   curve.generateKeys();
 
@@ -65,7 +63,7 @@ function generateVAPIDKeys() {
   };
 }
 
-function validateSubject(subject) {
+export function validateSubject(subject) {
   if (!subject) {
     throw new Error('No subject set in vapidDetails.subject.');
   }
@@ -91,7 +89,7 @@ function validateSubject(subject) {
     }
 }
 
-function validatePublicKey(publicKey) {
+export function validatePublicKey(publicKey) {
   if (!publicKey) {
     throw new Error('No key set vapidDetails.publicKey');
   }
@@ -112,7 +110,7 @@ function validatePublicKey(publicKey) {
   }
 }
 
-function validatePrivateKey(privateKey) {
+export function validatePrivateKey(privateKey) {
   if (!privateKey) {
     throw new Error('No key set in vapidDetails.privateKey');
   }
@@ -141,7 +139,7 @@ function validatePrivateKey(privateKey) {
  * @param {Number} numSeconds Number of seconds to be added
  * @return {Number} Future expiration in seconds
  */
-function getFutureExpirationTimestamp(numSeconds) {
+export function getFutureExpirationTimestamp(numSeconds) {
   const futureExp = new Date();
   futureExp.setSeconds(futureExp.getSeconds() + numSeconds);
   return Math.floor(futureExp.getTime() / 1000);
@@ -153,7 +151,7 @@ function getFutureExpirationTimestamp(numSeconds) {
  *
  * @param {Number} expiration Expiration seconds from Epoch to be validated
  */
-function validateExpiration(expiration) {
+export function validateExpiration(expiration) {
   if (!Number.isInteger(expiration)) {
     throw new Error('`expiration` value must be a number');
   }
@@ -184,7 +182,7 @@ function validateExpiration(expiration) {
  * @return {Object}                 Returns an Object with the Authorization and
  * 'Crypto-Key' values to be used as headers.
  */
-function getVapidHeaders(audience, subject, publicKey, privateKey, contentEncoding, expiration) {
+export function getVapidHeaders(audience, subject, publicKey, privateKey, contentEncoding, expiration) {
   if (!audience) {
     throw new Error('No audience could be generated for VAPID.');
   }
@@ -243,13 +241,3 @@ function getVapidHeaders(audience, subject, publicKey, privateKey, contentEncodi
 
   throw new Error('Unsupported encoding type specified.');
 }
-
-module.exports = {
-  generateVAPIDKeys: generateVAPIDKeys,
-  getFutureExpirationTimestamp: getFutureExpirationTimestamp,
-  getVapidHeaders: getVapidHeaders,
-  validateSubject: validateSubject,
-  validatePublicKey: validatePublicKey,
-  validatePrivateKey: validatePrivateKey,
-  validateExpiration: validateExpiration
-};
diff --git a/src/web-push-constants.js b/src/web-push-constants.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const WebPushConstants = {};
 
 WebPushConstants.supportedContentEncodings = {
@@ -14,4 +12,4 @@ WebPushConstants.supportedUrgency = {
   HIGH: 'high'
 };
 
-module.exports = WebPushConstants;
+export default WebPushConstants;
diff --git a/src/web-push-error.js b/src/web-push-error.js
@@ -1,6 +1,6 @@
-'use strict';
+import util from 'util';
 
-function WebPushError(message, statusCode, headers, body, endpoint) {
+export default function WebPushError(message, statusCode, headers, body, endpoint) {
   Error.captureStackTrace(this, this.constructor);
 
   this.name = this.constructor.name;
@@ -11,6 +11,4 @@ function WebPushError(message, statusCode, headers, body, endpoint) {
   this.endpoint = endpoint;
 }
 
-require('util').inherits(WebPushError, Error);
-
-module.exports = WebPushError;
+util.inherits(WebPushError, Error);
diff --git a/src/web-push-lib.js b/src/web-push-lib.js
@@ -1,21 +1,19 @@
-'use strict';
+import url from 'url';
+import https from 'https';
 
-const url = require('url');
-const https = require('https');
-
-const WebPushError = require('./web-push-error.js');
-const vapidHelper = require('./vapid-helper.js');
-const encryptionHelper = require('./encryption-helper.js');
-const webPushConstants = require('./web-push-constants.js');
-const urlBase64Helper = require('./urlsafe-base64-helper');
+import WebPushError from './web-push-error.js';
+import * as vapidHelper from './vapid-helper.js';
+import * as encryptionHelper from './encryption-helper.js';
+import webPushConstants from './web-push-constants.js';
+import * as urlBase64Helper from './urlsafe-base64-helper.js';
 
 // Default TTL is four weeks.
 const DEFAULT_TTL = 2419200;
 
 let gcmAPIKey = '';
 let vapidDetails;
 
-function WebPushLib() {
+export function WebPushLib() {
 
 }
 
@@ -405,9 +403,5 @@ WebPushLib.prototype.sendNotification = function(subscription, payload, options)
       if (requestDetails.body) {
         pushRequest.write(requestDetails.body);
       }
-
-      pushRequest.end();
-    });
-  };
-
-module.exports = WebPushLib;
+  });
+};
diff --git a/test/.eslintrc b/test/.eslintrc
@@ -5,5 +5,8 @@
   "rules": {
     "max-len": 0,
     "global-require": 0
+  },
+  "parserOptions": {
+    "sourceType": "module"
   }
 }
diff --git a/test/data/demo/service-worker.js b/test/data/demo/service-worker.js
@@ -1,8 +1,6 @@
 /* Needed because of https://github.com/airbnb/javascript/issues/1632 */
 /* eslint no-restricted-globals: 0 */
 
-'use strict';
-
 let port;
 let pushMessage;
 
diff --git a/test/helpers/create-server.js b/test/helpers/create-server.js
@@ -1,11 +1,9 @@
-'use strict';
+import http from 'http';
+import portfinder from 'portfinder';
+import fs from 'fs';
+import path from 'path';
 
-const http = require('http');
-const portfinder = require('portfinder');
-const fs = require('fs');
-const path = require('path');
-
-function createServer() {
+export function createServer() {
   const demoPath = 'test/data/demo';
 
   const server = http.createServer(function(req, res) {
@@ -55,5 +53,3 @@ function createServer() {
     });
   });
 }
-
-module.exports = createServer;
diff --git a/test/helpers/download-test-browsers.js b/test/helpers/download-test-browsers.js
@@ -1,7 +1,5 @@
-'use strict';
-
-const os = require('os');
-const seleniumAssistant = require('selenium-assistant');
+import os from 'os';
+import seleniumAssistant from 'selenium-assistant';
 
 const MAX_RETRIES = 3;
 let expiration;
diff --git a/test/test-cli.js b/test/test-cli.js
@@ -1,4 +1,5 @@
-'use strict';
+import assert from 'assert';
+import { spawn } from 'child_process';
 
 (function() {
   const invalidNodeVersions = /0.(10|12).(\d+)/;
@@ -7,9 +8,6 @@
     return;
   }
 
-  const assert = require('assert');
-  const spawn = require('child_process').spawn;
-
   const cliPath = 'src/cli.js';
 
   suite('Test CLI', function() {
diff --git a/test/test-encryption-helper.js b/test/test-encryption-helper.js
diff --git a/test/test-generate-request-details.js b/test/test-generate-request-details.js
diff --git a/test/test-set-vapid-details.js b/test/test-set-vapid-details.js
diff --git a/test/test-vapid-helper.js b/test/test-vapid-helper.js
diff --git a/test/testSelenium.js b/test/testSelenium.js
diff --git a/test/testSendNotification.js b/test/testSendNotification.js
diff --git a/test/testSetGCMAPIKey.js b/test/testSetGCMAPIKey.js
