chore: convert project source to ESM (#420)

.bundlewatch.config.json

@@ -0,0 +1,80 @@
+{
+  "files": [
+    {
+      "//": "Pre-bundled for Browser (UMD)",
+      "path": "dist/browser/hibp.umd.js",
+      "maxSize": "8.9 kB"
+    },
+    {
+      "//": "Pre-bundled for Browser (ESM)",
+      "path": "dist/browser/hibp.module.js",
+      "maxSize": "4.9 kB"
+    },
+    {
+      "//": "Bundled with Webpack (CJS)",
+      "path": "dist/cjs/breach.js",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/cjs/breached-account.js",
+      "maxSize": "1.2 kB"
+    },
+    {
+      "path": "dist/cjs/breaches.js",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/cjs/data-classes.js",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/cjs/paste-account.js",
+      "maxSize": "1.1 kB"
+    },
+    {
+      "path": "dist/cjs/pwned-password.js",
+      "maxSize": "1.1 kB"
+    },
+    {
+      "path": "dist/cjs/pwned-password-range.js",
+      "maxSize": "1.3 kB"
+    },
+    {
+      "path": "dist/cjs/search.js",
+      "maxSize": "1.5 kB"
+    },
+    {
+      "//": "Bundled with Webpack (ESM)",
+      "path": "dist/esm/breach.mjs",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/esm/breached-account.mjs",
+      "maxSize": "1.1 kB"
+    },
+    {
+      "path": "dist/esm/breaches.mjs",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/esm/data-classes.mjs",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/esm/paste-account.mjs",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/esm/pwned-password.mjs",
+      "maxSize": "1 kB"
+    },
+    {
+      "path": "dist/esm/pwned-password-range.mjs",
+      "maxSize": "1.3 kB"
+    },
+    {
+      "path": "dist/esm/search.mjs",
+      "maxSize": "1.4 kB"
+    }
+  ]
+}

.github/workflows/bundlewatch-pr.yml

@@ -12,5 +12,5 @@ jobs:
       - uses: bahmutov/npm-install@v1
       - uses: jackyef/bundlewatch-gh-action@0.2.1
         with:
-          bundlewatch-config: .bundlewatch.config.js
+          bundlewatch-config: .bundlewatch.config.json
           bundlewatch-github-token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

.github/workflows/bundlewatch-push.yml

@@ -14,5 +14,5 @@ jobs:
       - uses: jackyef/bundlewatch-gh-action@0.2.1
         with:
           branch-base: main
-          bundlewatch-config: .bundlewatch.config.js
+          bundlewatch-config: .bundlewatch.config.json
           bundlewatch-github-token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

package.json

@@ -28,6 +28,7 @@
     },
     "./package.json": "./package.json"
   },
+  "type": "module",
   "main": "dist/cjs/hibp.js",
   "module": "dist/esm/hibp.mjs",
   "unpkg": "dist/browser/hibp.umd.js",
@@ -55,7 +56,7 @@
     "prebuild": "npm run --silent clean",
     "prepare": "npm run --silent build",
     "prepublishOnly": "run-s --silent lint typecheck test test:browser:run",
-    "size": "bundlewatch --config .bundlewatch.config.js",
+    "size": "bundlewatch --config .bundlewatch.config.json",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "pretest:browser:open": "npm run --silent build:lib",

playwright/tests/browser.spec.ts

@@ -1,6 +1,6 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import { test, expect } from '@playwright/test';
-import type * as hibp from '../../src/hibp';
+import type * as hibp from '../../src/hibp.js';
 
 declare global {
   interface Window {

prettier.config.js

@@ -1,5 +1,3 @@
-const prettierConfig = require('@wkovacs64/prettier-config');
+import prettierConfig from '@wkovacs64/prettier-config';
 
-module.exports = {
-  ...prettierConfig,
-};
+export default prettierConfig;

scripts/fix-api-docs.js

@@ -1,4 +1,4 @@
-const fs = require('fs');
+import fs from 'node:fs';
 
 const filename = 'API.md';
 const generatedApiDocs = fs.readFileSync(filename, 'utf8');
@@ -14,4 +14,5 @@ const newApiDocs = generatedApiDocs
     /(Promise\.<Array\.<([A-Z].*)>>)/g,
     (_match, g1, g2) => `<a href="#${g2.toLowerCase()}--object">${g1}</a>`,
   );
+
 fs.writeFileSync(filename, newApiDocs, 'utf8');

src/__tests__/breach.test.ts

@@ -1,8 +1,8 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { VERIFIED_BREACH } from '../../test/fixtures';
-import { NOT_FOUND } from '../api/haveibeenpwned/responses';
-import { breach } from '../breach';
+import { server } from '../mocks/server.js';
+import { VERIFIED_BREACH } from '../../test/fixtures.js';
+import { NOT_FOUND } from '../api/haveibeenpwned/responses.js';
+import { breach } from '../breach.js';
 
 describe('breach', () => {
   describe('found', () => {

src/__tests__/breached-account.test.ts

@@ -1,9 +1,9 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { VERIFIED_BREACH, UNVERIFIED_BREACH } from '../../test/fixtures';
-import { UNAUTHORIZED } from '../api/haveibeenpwned/responses';
-import type { ErrorData } from '../api/haveibeenpwned/types';
-import { breachedAccount } from '../breached-account';
+import { server } from '../mocks/server.js';
+import { VERIFIED_BREACH, UNVERIFIED_BREACH } from '../../test/fixtures.js';
+import { UNAUTHORIZED } from '../api/haveibeenpwned/responses.js';
+import type { ErrorData } from '../api/haveibeenpwned/types.js';
+import { breachedAccount } from '../breached-account.js';
 
 describe('breachedAccount', () => {
   const apiKey = 'my-api-key';

src/__tests__/breaches.test.ts

@@ -1,7 +1,7 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { VERIFIED_BREACH } from '../../test/fixtures';
-import { breaches } from '../breaches';
+import { server } from '../mocks/server.js';
+import { VERIFIED_BREACH } from '../../test/fixtures.js';
+import { breaches } from '../breaches.js';
 
 describe('breaches', () => {
   const BREACHES = [VERIFIED_BREACH];

src/__tests__/data-classes.test.ts

@@ -1,6 +1,6 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { dataClasses } from '../data-classes';
+import { server } from '../mocks/server.js';
+import { dataClasses } from '../data-classes.js';
 
 describe('dataClasses', () => {
   const DATA_CLASSES = ['some', 'data', 'classes'];

src/__tests__/hibp.test.ts

@@ -1,4 +1,4 @@
-import * as hibp from '../hibp';
+import * as hibp from '../hibp.js';
 
 describe('hibp', () => {
   it('exports an object containing the advertised functions', () => {

src/__tests__/paste-account.test.ts

@@ -1,9 +1,9 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { EXAMPLE_PASTE } from '../../test/fixtures';
-import { NOT_FOUND, UNAUTHORIZED } from '../api/haveibeenpwned/responses';
-import type { ErrorData } from '../api/haveibeenpwned/types';
-import { pasteAccount } from '../paste-account';
+import { server } from '../mocks/server.js';
+import { EXAMPLE_PASTE } from '../../test/fixtures.js';
+import { NOT_FOUND, UNAUTHORIZED } from '../api/haveibeenpwned/responses.js';
+import type { ErrorData } from '../api/haveibeenpwned/types.js';
+import { pasteAccount } from '../paste-account.js';
 
 describe('pasteAccount', () => {
   const PASTE_ACCOUNT_DATA = [EXAMPLE_PASTE];

src/__tests__/pwned-password-range.test.ts

@@ -1,7 +1,7 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { EXAMPLE_PASSWORD_HASHES } from '../../test/fixtures';
-import { pwnedPasswordRange } from '../pwned-password-range';
+import { server } from '../mocks/server.js';
+import { EXAMPLE_PASSWORD_HASHES } from '../../test/fixtures.js';
+import { pwnedPasswordRange } from '../pwned-password-range.js';
 
 describe('pwnedPasswordRange', () => {
   describe('valid range', () => {

src/__tests__/pwned-password.test.ts

@@ -1,7 +1,7 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { EXAMPLE_PASSWORD_HASHES } from '../../test/fixtures';
-import { pwnedPassword } from '../pwned-password';
+import { server } from '../mocks/server.js';
+import { EXAMPLE_PASSWORD_HASHES } from '../../test/fixtures.js';
+import { pwnedPassword } from '../pwned-password.js';
 
 describe('pwnedPassword', () => {
   describe('pwned', () => {

src/__tests__/search.test.ts

@@ -1,9 +1,9 @@
 import { http } from 'msw';
-import { server } from '../mocks/server';
-import { VERIFIED_BREACH, EXAMPLE_PASTE } from '../../test/fixtures';
-import { search } from '../search';
-import { UNAUTHORIZED } from '../api/haveibeenpwned/responses';
-import type { ErrorData } from '../api/haveibeenpwned/types';
+import { server } from '../mocks/server.js';
+import { VERIFIED_BREACH, EXAMPLE_PASTE } from '../../test/fixtures.js';
+import { search } from '../search.js';
+import { UNAUTHORIZED } from '../api/haveibeenpwned/responses.js';
+import type { ErrorData } from '../api/haveibeenpwned/types.js';
 
 describe('search', () => {
   const BREACHES = [{ Name: VERIFIED_BREACH.Name }];

src/api/haveibeenpwned/__tests__/fetch-from-api.test.ts

@@ -1,14 +1,14 @@
 import { http } from 'msw';
-import { server } from '../../../mocks/server';
+import { server } from '../../../mocks/server.js';
 import {
   OK,
   BAD_REQUEST,
   UNAUTHORIZED,
   FORBIDDEN,
   BLOCKED,
   TOO_MANY_REQUESTS,
-} from '../responses';
-import { fetchFromApi } from '../fetch-from-api';
+} from '../responses.js';
+import { fetchFromApi } from '../fetch-from-api.js';
 
 describe('internal (haveibeenpwned): fetchFromApi', () => {
   const apiKey = 'my-api-key';

src/api/haveibeenpwned/fetch-from-api.ts

@@ -1,13 +1,13 @@
-import fetch from '../web-fetch';
+import fetch from '../web-fetch.js';
 import { name, version } from '../../../package.json';
 import {
   BAD_REQUEST,
   UNAUTHORIZED,
   FORBIDDEN,
   NOT_FOUND,
   TOO_MANY_REQUESTS,
-} from './responses';
-import type { ApiData, ErrorData } from './types';
+} from './responses.js';
+import type { ApiData, ErrorData } from './types.js';
 
 /**
  * Custom error thrown when the haveibeenpwned.com API responds with 429 Too

src/api/haveibeenpwned/responses.ts

@@ -10,7 +10,7 @@
  * descriptive error for the consumer. (They are also leveraged in our tests.)
  */
 
-import type { ResponseBody } from './types';
+import type { ResponseBody } from './types.js';
 
 /** @internal */
 export interface HaveIBeenPwnedApiResponse {

src/api/pwnedpasswords/__tests__/fetch-from-api.test.ts

@@ -1,7 +1,7 @@
 import { http } from 'msw';
-import { server } from '../../../mocks/server';
-import { BAD_REQUEST, OK } from '../responses';
-import { fetchFromApi } from '../fetch-from-api';
+import { server } from '../../../mocks/server.js';
+import { BAD_REQUEST, OK } from '../responses.js';
+import { fetchFromApi } from '../fetch-from-api.js';
 
 describe('internal (pwnedpassword): fetchFromApi', () => {
   describe('request failure', () => {

src/api/pwnedpasswords/fetch-from-api.ts

@@ -1,5 +1,5 @@
-import fetch from '../web-fetch';
-import { BAD_REQUEST } from './responses';
+import fetch from '../web-fetch.js';
+import { BAD_REQUEST } from './responses.js';
 
 /**
  * Fetches data from the supplied API endpoint.

src/breach.ts

@@ -1,5 +1,5 @@
-import type { Breach } from './api/haveibeenpwned/types';
-import { fetchFromApi } from './api/haveibeenpwned/fetch-from-api';
+import type { Breach } from './api/haveibeenpwned/types.js';
+import { fetchFromApi } from './api/haveibeenpwned/fetch-from-api.js';
 
 /**
  * An object representing a breach.