hibp 0.0.0-dev.0e634825

package/dist/esm/breachedAccount.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"breachedAccount.mjs","sources":["../../src/breachedAccount.ts"],"sourcesContent":["import type { Breach } from './api/haveibeenpwned/types';\nimport { fetchFromApi } from './api/haveibeenpwned';\n\n/**\n * Fetches breach data for a specific account.\n *\n * ***Warning (July 18, 2019):***\n *\n * `haveibeenpwned.com` now requires an API key from\n * https://haveibeenpwned.com/API/Key for the `breachedaccount` endpoint. The\n * `apiKey` option here is not explicitly required, but direct requests made\n * without it (that is, without specifying a `baseUrl` to a proxy that inserts a\n * valid API key on your behalf) will fail.\n *\n * @param {string} account a username or email address\n * @param {object} [options] a configuration object\n * @param {string} [options.apiKey] an API key from\n * https://haveibeenpwned.com/API/Key (default: undefined)\n * @param {string} [options.domain] a domain by which to filter the results\n * (default: all domains)\n * @param {boolean} [options.includeUnverified] include \"unverified\" breaches in\n * the results (default: true)\n * @param {boolean} [options.truncate] truncate the results to only include\n * the name of each breach (default: true)\n * @param {string} [options.baseUrl] a custom base URL for the\n * haveibeenpwned.com API endpoints (default:\n * `https://haveibeenpwned.com/api/v3`)\n * @param {string} [options.userAgent] a custom string to send as the User-Agent\n * field in the request headers (default: `hibp <version>`)\n * @returns {(Promise<Breach[]> | Promise<null>)} a Promise which resolves to an\n * array of breach objects (or null if no breaches were found), or rejects with\n * an Error\n * @example\n * breachedAccount('foo', { apiKey: 'my-api-key' })\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n * @example\n * breachedAccount('bar', {\n *   includeUnverified: false,\n *   baseUrl: 'https://my-hibp-proxy:8080',\n * })\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n * @example\n * breachedAccount('baz', {\n *   apiKey: 'my-api-key',\n *   domain: 'adobe.com',\n *   truncate: false,\n *   userAgent: 'my-app 1.0'\n * })\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n */\nexport function breachedAccount(\n  account: string,\n  options: {\n    apiKey?: string;\n    domain?: string;\n    includeUnverified?: boolean;\n    truncate?: boolean;\n    baseUrl?: string;\n    userAgent?: string;\n  } = {\n    includeUnverified: true,\n    truncate: true,\n  },\n): Promise<Breach[] | null> {\n  const endpoint = `/breachedaccount/${encodeURIComponent(account)}?`;\n  const params: Array<string> = [];\n  if (options.domain) {\n    params.push(`domain=${encodeURIComponent(options.domain)}`);\n  }\n  if (options.includeUnverified === false) {\n    params.push('includeUnverified=false');\n  }\n  if (options.truncate === false) {\n    params.push('truncateResponse=false');\n  }\n  return fetchFromApi(`${endpoint}${params.join('&')}`, {\n    apiKey: options.apiKey,\n    baseUrl: options.baseUrl,\n    userAgent: options.userAgent,\n  }) as Promise<Breach[] | null>;\n}\n"],"names":["breachedAccount","account","options","includeUnverified","truncate","endpoint","encodeURIComponent","params","domain","push","fetchFromApi","join","apiKey","baseUrl","userAgent"],"mappings":";;AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyEG;AACa,SAAAA,eAAeA,CAC7BC,OAAe,EACfC,OAOI,GAAA;EACFC,iBAAiB,EAAE,IAAI;EACvBC,QAAQ,EAAE;AACX,CAAA,EAAA;EAED,MAAMC,QAAQ,GAAuB,oBAAAC,kBAAkB,CAACL,OAAO,IAAI;EACnE,MAAMM,MAAM,GAAkB,EAAE;EAChC,IAAIL,OAAO,CAACM,MAAM,EAAE;IAClBD,MAAM,CAACE,IAAI,CAAC,UAAUH,kBAAkB,CAACJ,OAAO,CAACM,MAAM,CAAG,EAAA,CAAC;EAC5D;EACD,IAAIN,OAAO,CAACC,iBAAiB,KAAK,KAAK,EAAE;IACvCI,MAAM,CAACE,IAAI,CAAC,yBAAyB,CAAC;EACvC;EACD,IAAIP,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;IAC9BG,MAAM,CAACE,IAAI,CAAC,wBAAwB,CAAC;EACtC;EACD,OAAOC,YAAY,CAAI,GAAAL,QAAW,GAAAE,MAAM,CAACI,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;IACpDC,MAAM,EAAEV,OAAO,CAACU,MAAM;IACtBC,OAAO,EAAEX,OAAO,CAACW,OAAO;IACxBC,SAAS,EAAEZ,OAAO,CAACY;EACpB,CAAA,CAA6B;AAChC;"}

package/dist/esm/breaches.mjs

@@ -0,0 +1,53 @@
+import { fetchFromApi } from './api/haveibeenpwned/fetchFromApi.mjs';
+
+/**
+ * Fetches all breach events in the system.
+ *
+ * @param {object} [options] a configuration object
+ * @param {string} [options.domain] a domain by which to filter the results
+ * (default: all domains)
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {Promise<Breach[]>} a Promise which resolves to an array of breach
+ * objects (an empty array if no breaches were found), or rejects with an Error
+ * @example
+ * breaches()
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @example
+ * breaches({ domain: 'adobe.com' })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+function breaches(options = {}) {
+  const endpoint = '/breaches?';
+  const params = [];
+  if (options.domain) {
+    params.push(`domain=${encodeURIComponent(options.domain)}`);
+  }
+  return fetchFromApi(`${endpoint}${params.join('&')}`, {
+    baseUrl: options.baseUrl,
+    userAgent: options.userAgent
+  });
+}
+export { breaches };
+//# sourceMappingURL=breaches.mjs.map

package/dist/esm/breaches.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"breaches.mjs","sources":["../../src/breaches.ts"],"sourcesContent":["import type { Breach } from './api/haveibeenpwned/types';\nimport { fetchFromApi } from './api/haveibeenpwned';\n\n/**\n * Fetches all breach events in the system.\n *\n * @param {object} [options] a configuration object\n * @param {string} [options.domain] a domain by which to filter the results\n * (default: all domains)\n * @param {string} [options.baseUrl] a custom base URL for the\n * haveibeenpwned.com API endpoints (default:\n * `https://haveibeenpwned.com/api/v3`)\n * @param {string} [options.userAgent] a custom string to send as the User-Agent\n * field in the request headers (default: `hibp <version>`)\n * @returns {Promise<Breach[]>} a Promise which resolves to an array of breach\n * objects (an empty array if no breaches were found), or rejects with an Error\n * @example\n * breaches()\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n * @example\n * breaches({ domain: 'adobe.com' })\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n */\nexport function breaches(\n  options: {\n    domain?: string;\n    baseUrl?: string;\n    userAgent?: string;\n  } = {},\n): Promise<Breach[]> {\n  const endpoint = '/breaches?';\n  const params: Array<string> = [];\n  if (options.domain) {\n    params.push(`domain=${encodeURIComponent(options.domain)}`);\n  }\n  return fetchFromApi(`${endpoint}${params.join('&')}`, {\n    baseUrl: options.baseUrl,\n    userAgent: options.userAgent,\n  }) as Promise<Breach[]>;\n}\n"],"names":["breaches","options","endpoint","params","domain","push","encodeURIComponent","fetchFromApi","join","baseUrl","userAgent"],"mappings":";;AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCG;AACa,SAAAA,QAAQA,CACtBC,OAAA,GAII,EAAE,EAAA;EAEN,MAAMC,QAAQ,GAAG,YAAY;EAC7B,MAAMC,MAAM,GAAkB,EAAE;EAChC,IAAIF,OAAO,CAACG,MAAM,EAAE;IAClBD,MAAM,CAACE,IAAI,CAAC,UAAUC,kBAAkB,CAACL,OAAO,CAACG,MAAM,CAAG,EAAA,CAAC;EAC5D;EACD,OAAOG,YAAY,CAAI,GAAAL,QAAW,GAAAC,MAAM,CAACK,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;IACpDC,OAAO,EAAER,OAAO,CAACQ,OAAO;IACxBC,SAAS,EAAET,OAAO,CAACS;EACpB,CAAA,CAAsB;AACzB;"}

package/dist/esm/dataClasses.mjs

@@ -0,0 +1,32 @@
+import { fetchFromApi } from './api/haveibeenpwned/fetchFromApi.mjs';
+
+/**
+ * Fetches all data classes in the system.
+ *
+ * @param {object} [options] a configuration object
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {(Promise<string[]> | Promise<null>)} a Promise which resolves to an
+ * array of strings (or null if no data classes were found), or rejects with an
+ * Error
+ * @example
+ * dataClasses()
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+function dataClasses(options = {}) {
+  return fetchFromApi('/dataclasses', options);
+}
+export { dataClasses };
+//# sourceMappingURL=dataClasses.mjs.map

package/dist/esm/dataClasses.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataClasses.mjs","sources":["../../src/dataClasses.ts"],"sourcesContent":["import { fetchFromApi } from './api/haveibeenpwned';\n\n/**\n * Fetches all data classes in the system.\n *\n * @param {object} [options] a configuration object\n * @param {string} [options.baseUrl] a custom base URL for the\n * haveibeenpwned.com API endpoints (default:\n * `https://haveibeenpwned.com/api/v3`)\n * @param {string} [options.userAgent] a custom string to send as the User-Agent\n * field in the request headers (default: `hibp <version>`)\n * @returns {(Promise<string[]> | Promise<null>)} a Promise which resolves to an\n * array of strings (or null if no data classes were found), or rejects with an\n * Error\n * @example\n * dataClasses()\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n */\nexport function dataClasses(\n  options: { baseUrl?: string; userAgent?: string } = {},\n): Promise<string[] | null> {\n  return fetchFromApi('/dataclasses', options) as Promise<string[] | null>;\n}\n"],"names":["dataClasses","options","fetchFromApi"],"mappings":";;AAEA;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACa,SAAAA,WAAWA,CACzBC,OAAA,GAAoD,EAAE,EAAA;EAEtD,OAAOC,YAAY,CAAC,cAAc,EAAED,OAAO,CAA6B;AAC1E;"}

package/dist/esm/hibp.d.mts

@@ -0,0 +1,480 @@
+// Generated by dts-bundle-generator v7.2.0
+
+//
+// Data Models from the API
+//
+export interface Breach {
+	Name: string;
+	Title: string;
+	Domain: string;
+	BreachDate: string;
+	AddedDate: string;
+	ModifiedDate: string;
+	PwnCount: number;
+	Description: string;
+	LogoPath: string;
+	DataClasses: string[];
+	IsVerified: boolean;
+	IsFabricated: boolean;
+	IsSensitive: boolean;
+	IsRetired: boolean;
+	IsSpamList: boolean;
+}
+export interface Paste {
+	Id: string;
+	Source: string;
+	Title: string;
+	Date: string;
+	EmailCount: number;
+}
+/**
+ * An object representing a breach.
+ *
+ * @typedef {object} Breach
+ * @property {string} Name
+ * @property {string} Title
+ * @property {string} Domain
+ * @property {string} BreachDate
+ * @property {string} AddedDate
+ * @property {string} ModifiedDate
+ * @property {number} PwnCount
+ * @property {string} Description
+ * @property {string} LogoPath
+ * @property {string[]} DataClasses
+ * @property {boolean} IsVerified
+ * @property {boolean} IsFabricated
+ * @property {boolean} IsSensitive
+ * @property {boolean} IsRetired
+ * @property {boolean} IsSpamList
+ */
+/**
+ * Fetches data for a specific breach event.
+ *
+ * @param {string} breachName the name of a breach in the system
+ * @param {object} [options] a configuration object
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {(Promise<Breach>|Promise<null>)} a Promise which resolves to an
+ * object representing a breach (or null if no breach was found), or rejects
+ * with an Error
+ * @example
+ * breach('Adobe')
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+export declare function breach(breachName: string, options?: {
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<Breach | null>;
+/**
+ * Fetches breach data for a specific account.
+ *
+ * ***Warning (July 18, 2019):***
+ *
+ * `haveibeenpwned.com` now requires an API key from
+ * https://haveibeenpwned.com/API/Key for the `breachedaccount` endpoint. The
+ * `apiKey` option here is not explicitly required, but direct requests made
+ * without it (that is, without specifying a `baseUrl` to a proxy that inserts a
+ * valid API key on your behalf) will fail.
+ *
+ * @param {string} account a username or email address
+ * @param {object} [options] a configuration object
+ * @param {string} [options.apiKey] an API key from
+ * https://haveibeenpwned.com/API/Key (default: undefined)
+ * @param {string} [options.domain] a domain by which to filter the results
+ * (default: all domains)
+ * @param {boolean} [options.includeUnverified] include "unverified" breaches in
+ * the results (default: true)
+ * @param {boolean} [options.truncate] truncate the results to only include
+ * the name of each breach (default: true)
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {(Promise<Breach[]> | Promise<null>)} a Promise which resolves to an
+ * array of breach objects (or null if no breaches were found), or rejects with
+ * an Error
+ * @example
+ * breachedAccount('foo', { apiKey: 'my-api-key' })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @example
+ * breachedAccount('bar', {
+ *   includeUnverified: false,
+ *   baseUrl: 'https://my-hibp-proxy:8080',
+ * })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @example
+ * breachedAccount('baz', {
+ *   apiKey: 'my-api-key',
+ *   domain: 'adobe.com',
+ *   truncate: false,
+ *   userAgent: 'my-app 1.0'
+ * })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+export declare function breachedAccount(account: string, options?: {
+	apiKey?: string;
+	domain?: string;
+	includeUnverified?: boolean;
+	truncate?: boolean;
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<Breach[] | null>;
+/**
+ * Fetches all breach events in the system.
+ *
+ * @param {object} [options] a configuration object
+ * @param {string} [options.domain] a domain by which to filter the results
+ * (default: all domains)
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {Promise<Breach[]>} a Promise which resolves to an array of breach
+ * objects (an empty array if no breaches were found), or rejects with an Error
+ * @example
+ * breaches()
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @example
+ * breaches({ domain: 'adobe.com' })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+export declare function breaches(options?: {
+	domain?: string;
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<Breach[]>;
+/**
+ * Fetches all data classes in the system.
+ *
+ * @param {object} [options] a configuration object
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {(Promise<string[]> | Promise<null>)} a Promise which resolves to an
+ * array of strings (or null if no data classes were found), or rejects with an
+ * Error
+ * @example
+ * dataClasses()
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+export declare function dataClasses(options?: {
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<string[] | null>;
+/**
+ * An object representing a paste.
+ *
+ * @typedef {object} Paste
+ * @property {string} Id
+ * @property {string} Source
+ * @property {string} Title
+ * @property {string} Date
+ * @property {number} EmailCount
+ */
+/**
+ * Fetches paste data for a specific account (email address).
+ *
+ * ***Warning (July 18, 2019):***
+ *
+ * `haveibeenpwned.com` now requires an API key from
+ * https://haveibeenpwned.com/API/Key for the `pasteaccount` endpoint. The
+ * `apiKey` option here is not explicitly required, but direct requests made
+ * without it (that is, without specifying a `baseUrl` to a proxy that inserts a
+ * valid API key on your behalf) will fail.
+ *
+ * @param {string} email the email address to query
+ * @param {object} [options] a configuration object
+ * @param {string} [options.apiKey] an API key from
+ * https://haveibeenpwned.com/API/Key
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {(Promise<Paste[]> | Promise<null>)} a Promise which resolves to an
+ * array of paste objects (or null if no pastes were found), or rejects with an
+ * Error
+ * @example
+ * pasteAccount('foo@bar.com', { apiKey: 'my-api-key' })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+export declare function pasteAccount(email: string, options?: {
+	apiKey?: string;
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<Paste[] | null>;
+/**
+ * Fetches the number of times the the given password has been exposed in a
+ * breach (0 indicating no exposure). The password is given in plain text, but
+ * only the first 5 characters of its SHA-1 hash will be submitted to the API.
+ *
+ * @param {string} password a password in plain text
+ * @param {object} [options] a configuration object
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * pwnedpasswords.com API endpoints (default: `https://api.pwnedpasswords.com`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {Promise<number>} a Promise which resolves to the number of times
+ * the password has been exposed in a breach, or rejects with an Error
+ * @example
+ * pwnedPassword('f00b4r')
+ *   .then(numPwns => {
+ *     // truthy check or numeric condition
+ *     if (numPwns) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @see https://haveibeenpwned.com/api/v3#PwnedPasswords
+ */
+export declare function pwnedPassword(password: string, options?: {
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<number>;
+export interface PwnedPasswordSuffixes {
+	[suffix: string]: number;
+}
+/**
+ * An object mapping an exposed password hash suffix (corresponding to a given
+ * hash prefix) to how many times it occurred in the Pwned Passwords repository.
+ *
+ * @typedef {Object.<string, number>} PwnedPasswordSuffixes
+ */
+/**
+ * Fetches the SHA-1 hash suffixes for the given 5-character SHA-1 hash prefix.
+ *
+ * When a password hash with the same first 5 characters is found in the Pwned
+ * Passwords repository, the API will respond with an HTTP 200 and include the
+ * suffix of every hash beginning with the specified prefix, followed by a count
+ * of how many times it appears in the data set. This function parses the
+ * response and returns a more structured format.
+ *
+ * @param {string} prefix the first 5 characters of a SHA-1 password hash (case
+ * insensitive)
+ * @param {object} [options] a configuration object
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * pwnedpasswords.com API endpoints (default: `https://api.pwnedpasswords.com`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {Promise<PwnedPasswordSuffixes>} a Promise which resolves to an
+ * object mapping the `suffix` that when matched with the prefix composes the
+ * complete hash, to the `count` of how many times it appears in the breached
+ * password data set, or rejects with an Error
+ *
+ * @example
+ * pwnedPasswordRange('5BAA6')
+ *   .then(results => {
+ *     // results will have the following shape:
+ *     // {
+ *     //   "003D68EB55068C33ACE09247EE4C639306B": 3,
+ *     //   "012C192B2F16F82EA0EB9EF18D9D539B0DD": 1,
+ *     //   ...
+ *     // }
+ *   })
+ * @example
+ * const suffix = '1E4C9B93F3F0682250B6CF8331B7EE68FD8';
+ * pwnedPasswordRange('5BAA6')
+ *   .then(results => (results[suffix] || 0))
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @see https://haveibeenpwned.com/api/v3#SearchingPwnedPasswordsByRange
+ */
+export declare function pwnedPasswordRange(prefix: string, options?: {
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<PwnedPasswordSuffixes>;
+export interface SearchResults {
+	breaches: Breach[] | null;
+	pastes: Paste[] | null;
+}
+/**
+ * An object representing search results.
+ *
+ * @typedef {object} SearchResults
+ * @property {(Breach[] | null)} breaches
+ * @property {(Paste[] | null)} pastes
+ */
+/**
+ * Fetches all breaches and all pastes associated with the provided account
+ * (email address or username). Note that the remote API does not support
+ * querying pastes by username (only email addresses), so in the event the
+ * provided account is not a valid email address, only breach data is queried
+ * and the "pastes" field of the resulting object will always be null. This is
+ * exactly how searching via the current web interface behaves, which this
+ * convenience method is designed to mimic.
+ *
+ * ***Warning (July 18, 2019):***
+ *
+ * `haveibeenpwned.com` now requires an API key from
+ * https://haveibeenpwned.com/API/Key for the `breachedaccount` and
+ * `pasteaccount` endpoints. The  `apiKey` option here is not explicitly
+ * required, but direct requests made without it (that is, without specifying a
+ * `baseUrl` to a proxy that inserts a valid API key on your behalf) will fail.
+ *
+ * @param {string} account an email address or username
+ * @param {object} [breachOptions] a configuration object pertaining to breach
+ * queries
+ * @param {string} [breachOptions.apiKey] an API key from
+ * https://haveibeenpwned.com/API/Key
+ * @param {string} [breachOptions.domain] a domain by which to filter the
+ * results (default: all domains)
+ * @param {boolean} [breachOptions.truncate] truncate the results to only
+ * include the name of each breach (default: true)
+ * @param {string} [breachOptions.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [breachOptions.userAgent] a custom string to send as the
+ * User-Agent field in the request headers (default: `hibp <version>`)
+ * @returns {Promise<SearchResults>} a Promise which resolves to an object
+ * containing a "breaches" key (which can be null or an array of breach objects)
+ * and a "pastes" key (which can be null or an array of paste objects), or
+ * rejects with an Error
+ * @example
+ * search('foo', { apiKey: 'my-api-key' })
+ *   .then(data => {
+ *     if (data.breaches || data.pastes) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ * @example
+ * search('nobody@nowhere.com', { apiKey: 'my-api-key', truncate: false })
+ *   .then(data => {
+ *     if (data.breaches || data.pastes) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ *
+ * @see https://haveibeenpwned.com/
+ */
+export declare function search(account: string, breachOptions?: {
+	apiKey?: string;
+	domain?: string;
+	truncate?: boolean;
+	baseUrl?: string;
+	userAgent?: string;
+}): Promise<SearchResults>;
+/**
+ * Custom error thrown when the haveibeenpwned.com API responds with 429 Too
+ * Many Requests. See the `retryAfterSeconds` property for the number of seconds
+ * to wait before attempting the request again.
+ *
+ * @see https://haveibeenpwned.com/API/v3#RateLimiting
+ */
+export declare class RateLimitError extends Error {
+	/**
+	 * The number of seconds to wait before attempting the request again. May be
+	 * `undefined` if the API does not provide a `retry-after` header, but this
+	 * should never happen.
+	 */
+	retryAfterSeconds: number | undefined;
+	constructor(retryAfter: ReturnType<Headers["get"]>, message: string | undefined, options?: ErrorOptions);
+}
+export interface HIBP {
+	breach: typeof breach;
+	breachedAccount: typeof breachedAccount;
+	breaches: typeof breaches;
+	dataClasses: typeof dataClasses;
+	pasteAccount: typeof pasteAccount;
+	pwnedPassword: typeof pwnedPassword;
+	pwnedPasswordRange: typeof pwnedPasswordRange;
+	search: typeof search;
+	RateLimitError: typeof RateLimitError;
+}
+
+export as namespace hibp;
+
+export {};

package/dist/esm/hibp.mjs

@@ -0,0 +1,10 @@
+export { breach } from './breach.mjs';
+export { breachedAccount } from './breachedAccount.mjs';
+export { breaches } from './breaches.mjs';
+export { dataClasses } from './dataClasses.mjs';
+export { pasteAccount } from './pasteAccount.mjs';
+export { pwnedPassword } from './pwnedPassword.mjs';
+export { pwnedPasswordRange } from './pwnedPasswordRange.mjs';
+export { search } from './search.mjs';
+export { RateLimitError } from './api/haveibeenpwned/fetchFromApi.mjs';
+//# sourceMappingURL=hibp.mjs.map

package/dist/esm/hibp.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hibp.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/esm/package.json.mjs

@@ -0,0 +1,4 @@
+const name = "hibp";
+const version = "0.0.0-dev.0e634825";
+export { name, version };
+//# sourceMappingURL=package.json.mjs.map

package/dist/esm/package.json.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.json.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/esm/pasteAccount.mjs

@@ -0,0 +1,57 @@
+import { fetchFromApi } from './api/haveibeenpwned/fetchFromApi.mjs';
+
+/**
+ * An object representing a paste.
+ *
+ * @typedef {object} Paste
+ * @property {string} Id
+ * @property {string} Source
+ * @property {string} Title
+ * @property {string} Date
+ * @property {number} EmailCount
+ */
+/**
+ * Fetches paste data for a specific account (email address).
+ *
+ * ***Warning (July 18, 2019):***
+ *
+ * `haveibeenpwned.com` now requires an API key from
+ * https://haveibeenpwned.com/API/Key for the `pasteaccount` endpoint. The
+ * `apiKey` option here is not explicitly required, but direct requests made
+ * without it (that is, without specifying a `baseUrl` to a proxy that inserts a
+ * valid API key on your behalf) will fail.
+ *
+ * @param {string} email the email address to query
+ * @param {object} [options] a configuration object
+ * @param {string} [options.apiKey] an API key from
+ * https://haveibeenpwned.com/API/Key
+ * @param {string} [options.baseUrl] a custom base URL for the
+ * haveibeenpwned.com API endpoints (default:
+ * `https://haveibeenpwned.com/api/v3`)
+ * @param {string} [options.userAgent] a custom string to send as the User-Agent
+ * field in the request headers (default: `hibp <version>`)
+ * @returns {(Promise<Paste[]> | Promise<null>)} a Promise which resolves to an
+ * array of paste objects (or null if no pastes were found), or rejects with an
+ * Error
+ * @example
+ * pasteAccount('foo@bar.com', { apiKey: 'my-api-key' })
+ *   .then(data => {
+ *     if (data) {
+ *       // ...
+ *     } else {
+ *       // ...
+ *     }
+ *   })
+ *   .catch(err => {
+ *     // ...
+ *   });
+ */
+function pasteAccount(email, options = {}) {
+  return fetchFromApi(`/pasteaccount/${encodeURIComponent(email)}`, {
+    apiKey: options.apiKey,
+    baseUrl: options.baseUrl,
+    userAgent: options.userAgent
+  });
+}
+export { pasteAccount };
+//# sourceMappingURL=pasteAccount.mjs.map

package/dist/esm/pasteAccount.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pasteAccount.mjs","sources":["../../src/pasteAccount.ts"],"sourcesContent":["import type { Paste } from './api/haveibeenpwned/types';\nimport { fetchFromApi } from './api/haveibeenpwned';\n\n/**\n * An object representing a paste.\n *\n * @typedef {object} Paste\n * @property {string} Id\n * @property {string} Source\n * @property {string} Title\n * @property {string} Date\n * @property {number} EmailCount\n */\n\n/**\n * Fetches paste data for a specific account (email address).\n *\n * ***Warning (July 18, 2019):***\n *\n * `haveibeenpwned.com` now requires an API key from\n * https://haveibeenpwned.com/API/Key for the `pasteaccount` endpoint. The\n * `apiKey` option here is not explicitly required, but direct requests made\n * without it (that is, without specifying a `baseUrl` to a proxy that inserts a\n * valid API key on your behalf) will fail.\n *\n * @param {string} email the email address to query\n * @param {object} [options] a configuration object\n * @param {string} [options.apiKey] an API key from\n * https://haveibeenpwned.com/API/Key\n * @param {string} [options.baseUrl] a custom base URL for the\n * haveibeenpwned.com API endpoints (default:\n * `https://haveibeenpwned.com/api/v3`)\n * @param {string} [options.userAgent] a custom string to send as the User-Agent\n * field in the request headers (default: `hibp <version>`)\n * @returns {(Promise<Paste[]> | Promise<null>)} a Promise which resolves to an\n * array of paste objects (or null if no pastes were found), or rejects with an\n * Error\n * @example\n * pasteAccount('foo@bar.com', { apiKey: 'my-api-key' })\n *   .then(data => {\n *     if (data) {\n *       // ...\n *     } else {\n *       // ...\n *     }\n *   })\n *   .catch(err => {\n *     // ...\n *   });\n */\nexport function pasteAccount(\n  email: string,\n  options: { apiKey?: string; baseUrl?: string; userAgent?: string } = {},\n): Promise<Paste[] | null> {\n  return fetchFromApi(`/pasteaccount/${encodeURIComponent(email)}`, {\n    apiKey: options.apiKey,\n    baseUrl: options.baseUrl,\n    userAgent: options.userAgent,\n  }) as Promise<Paste[] | null>;\n}\n"],"names":["pasteAccount","email","options","fetchFromApi","encodeURIComponent","apiKey","baseUrl","userAgent"],"mappings":";;AAGA;;;;;;;;;AASG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCG;SACaA,YAAYA,CAC1BC,KAAa,EACbC,UAAqE,EAAE,EAAA;EAEvE,OAAOC,YAAY,CAAkB,iBAAAC,kBAAkB,CAACH,KAAK,GAAG,EAAE;IAChEI,MAAM,EAAEH,OAAO,CAACG,MAAM;IACtBC,OAAO,EAAEJ,OAAO,CAACI,OAAO;IACxBC,SAAS,EAAEL,OAAO,CAACK;EACpB,CAAA,CAA4B;AAC/B;"}