hibp 15.0.0 → 15.1.0

package/API.md

@@ -12,12 +12,27 @@
 without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts
 a valid API key on your behalf).</p>
 </dd>
+<dt><a href="#breachedDomain">breachedDomain(domain, [options])</a> ⇒ <code><a href="#breach--objectedDomainsByEmailAlias">Promise.&lt;BreachedDomainsByEmailAlias&gt;</a></code> | <code>Promise.&lt;null&gt;</code></dt>
+<dd><p>Fetches all breached email addresses for a domain.</p>
+<p>The result maps email aliases (the local-part before the &#39;@&#39;) to an array of
+breach names. For example, querying <code>example.com</code> could return an object like
+<code>{ &quot;john&quot;: [&quot;Adobe&quot;], &quot;jane&quot;: [&quot;Adobe&quot;, &quot;Gawker&quot;] }</code>, corresponding to
+<code>john@example.com</code> and <code>jane@example.com</code>.</p>
+<p>🔑 <code>haveibeenpwned.com</code> requires an API key from
+<a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>breacheddomain</code> endpoint. The
+<code>apiKey</code> option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts
+a valid API key on your behalf).</p>
+</dd>
 <dt><a href="#breaches">breaches([options])</a> ⇒ <code><a href="#breach--object">Promise.&lt;Array.&lt;Breach&gt;&gt;</a></code></dt>
 <dd><p>Fetches all breach events in the system.</p>
 </dd>
 <dt><a href="#dataClasses">dataClasses([options])</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> | <code>Promise.&lt;null&gt;</code></dt>
 <dd><p>Fetches all data classes in the system.</p>
 </dd>
+<dt><a href="#latestBreach">latestBreach([options])</a> ⇒ <code><a href="#breach--object">Promise.&lt;Breach&gt;</a></code> | <code>Promise.&lt;null&gt;</code></dt>
+<dd><p>Fetches the most recently added breach.</p>
+</dd>
 <dt><a href="#pasteAccount">pasteAccount(email, [options])</a> ⇒ <code><a href="#paste--object">Promise.&lt;Array.&lt;Paste&gt;&gt;</a></code> | <code>Promise.&lt;null&gt;</code></dt>
 <dd><p>Fetches paste data for a specific account (email address).</p>
 <p>🔑 <code>haveibeenpwned.com</code> requires an API key from
@@ -54,6 +69,48 @@ convenience method is designed to mimic.</p>
 required, but direct requests made without it will fail (unless you specify a
 <code>baseUrl</code> to a proxy that inserts a valid API key on your behalf).</p>
 </dd>
+<dt><a href="#stealerLogsByEmailDomain">stealerLogsByEmailDomain(emailDomain, [options])</a> ⇒ <code><a href="#StealerLogDomainsByEmailAlias">Promise.&lt;StealerLogDomainsByEmailAlias&gt;</a></code> | <code>Promise.&lt;null&gt;</code></dt>
+<dd><p>Fetches all stealer log email aliases for an email domain.</p>
+<p>The result maps email aliases (the local-part before the &#39;@&#39;) to an array of
+email domains found in stealer logs. For example, querying <code>example.com</code>
+could return an object like <code>{ &quot;andy&quot;: [&quot;netflix.com&quot;], &quot;jane&quot;: [&quot;netflix.com&quot;, &quot;spotify.com&quot;] }</code>, corresponding to <code>andy@example.com</code> and <code>jane@example.com</code>.</p>
+<p>🔑 <code>haveibeenpwned.com</code> requires an API key from
+<a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>stealerlogsbyemaildomain</code> endpoint.
+The <code>apiKey</code> option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts
+a valid API key on your behalf).</p>
+</dd>
+<dt><a href="#stealerLogsByEmail">stealerLogsByEmail(emailAddress, [options])</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> | <code>Promise.&lt;null&gt;</code></dt>
+<dd><p>Fetches all stealer log domains for an email address.</p>
+<p>Returns an array of domains for which stealer logs contain entries for the
+supplied email address.</p>
+<p>🔑 <code>haveibeenpwned.com</code> requires an API key from
+<a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>stealerlogsbyemail</code> endpoint. The
+<code>apiKey</code> option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts
+a valid API key on your behalf).</p>
+</dd>
+<dt><a href="#stealerLogsByWebsiteDomain">stealerLogsByWebsiteDomain(websiteDomain, [options])</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> | <code>Promise.&lt;null&gt;</code></dt>
+<dd><p>Fetches all stealer log email addresses for a website domain.</p>
+<p>The result is an array of strings representing email addresses found in
+stealer logs for the specified website domain (e.g., &quot;example.com&quot;).</p>
+<p>🔑 <code>haveibeenpwned.com</code> requires an API key from
+<a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>stealerlogsbywebsitedomain</code>
+endpoint. The <code>apiKey</code> option here is not explicitly required, but direct
+requests made without it will fail (unless you specify a <code>baseUrl</code> to a proxy
+that inserts a valid API key on your behalf).</p>
+</dd>
+<dt><a href="#subscribedDomains">subscribedDomains([options])</a> ⇒ <code><a href="#subscribeddomain--object">Promise.&lt;Array.&lt;SubscribedDomain&gt;&gt;</a></code></dt>
+<dd><p>Fetches all subscribed domains for your HIBP account.</p>
+<p>Returns domains that have been successfully added to the Domain Search dashboard
+after verifying control. Each domain includes metadata about breach counts and
+the next renewal date, where available.</p>
+<p>🔑 <code>haveibeenpwned.com</code> requires an API key from
+<a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>subscribeddomains</code> endpoint. The
+<code>apiKey</code> option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts
+a valid API key on your behalf).</p>
+</dd>
 <dt><a href="#subscriptionStatus">subscriptionStatus([options])</a> ⇒ <code><a href="#subscriptionstatus--object">Promise.&lt;SubscriptionStatus&gt;</a></code></dt>
 <dd><p>Fetches the current status of your HIBP subscription (API key).</p>
 <p>🔑 <code>haveibeenpwned.com</code> requires an API key from
@@ -70,6 +127,10 @@ a valid API key on your behalf).</p>
 <dt><a href="#breach--object">Breach</a> : <code>object</code></dt>
 <dd><p>An object representing a breach.</p>
 </dd>
+<dt><a href="#breach--objectedDomainsByEmailAlias">BreachedDomainsByEmailAlias</a> : <code>Object.&lt;string, Array.&lt;string&gt;&gt;</code></dt>
+<dd><p>An object mapping an email alias (local-part before the &#39;@&#39;) to the list of
+breach names that alias has appeared in for the specified domain.</p>
+</dd>
 <dt><a href="#Paste">Paste</a> : <code>object</code></dt>
 <dd><p>An object representing a paste.</p>
 </dd>
@@ -80,6 +141,14 @@ hash prefix) to how many times it occurred in the Pwned Passwords repository.</p
 <dt><a href="#SearchResults">SearchResults</a> : <code>object</code></dt>
 <dd><p>An object representing search results.</p>
 </dd>
+<dt><a href="#StealerLogDomainsByEmailAlias">StealerLogDomainsByEmailAlias</a> : <code>Object.&lt;string, Array.&lt;string&gt;&gt;</code></dt>
+<dd><p>An object mapping an email alias (local-part before the &#39;@&#39;) to the list of
+email domains that alias has appeared in within stealer logs for the specified
+email domain.</p>
+</dd>
+<dt><a href="#SubscribedDomain">SubscribedDomain</a> : <code>object</code></dt>
+<dd><p>An object representing a subscribed domain.</p>
+</dd>
 <dt><a href="#subscriptionstatus--object">SubscriptionStatus</a> : <code>object</code></dt>
 <dd><p>An object representing the status of your HIBP subscription.</p>
 </dd>
@@ -191,6 +260,49 @@ try {
   // ...
 }
 ```
+<a name="breachedDomain"></a>
+
+## breachedDomain(domain, [options]) ⇒ [<code>Promise.&lt;BreachedDomainsByEmailAlias&gt;</code>](#breach--objectedDomainsByEmailAlias) \| <code>Promise.&lt;null&gt;</code>
+Fetches all breached email addresses for a domain.
+
+The result maps email aliases (the local-part before the '@') to an array of
+breach names. For example, querying `example.com` could return an object like
+`{ "john": ["Adobe"], "jane": ["Adobe", "Gawker"] }`, corresponding to
+`john@example.com` and `jane@example.com`.
+
+🔑 `haveibeenpwned.com` requires an API key from
+https://haveibeenpwned.com/API/Key for the `breacheddomain` endpoint. The
+`apiKey` option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a `baseUrl` to a proxy that inserts
+a valid API key on your behalf).
+
+**Kind**: global function  
+**Returns**: [<code>Promise.&lt;BreachedDomainsByEmailAlias&gt;</code>](#breach--objectedDomainsByEmailAlias) \| <code>Promise.&lt;null&gt;</code> - a Promise which
+resolves to an object mapping aliases to breach name arrays (or null if no
+results were found), or rejects with an Error  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| domain | <code>string</code> | the domain to query (e.g., "example.com") |
+| [options] | <code>object</code> | a configuration object |
+| [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) |
+| [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) |
+| [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) |
+| [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) |
+
+**Example**  
+```js
+try {
+  const data = await breachedDomain("example.com", { apiKey: "my-api-key" });
+  if (data) {
+    // { "john": ["Adobe"], "jane": ["Adobe", "Gawker"] }
+  } else {
+    // no results
+  }
+} catch (err) {
+  // ...
+}
+```
 <a name="breaches"></a>
 
 ## breaches([options]) ⇒ <code><a href="#breach--object">Promise.&lt;Array.&lt;Breach&gt;&gt;</a></code>
@@ -264,6 +376,36 @@ try {
   // ...
 }
 ```
+<a name="latestBreach"></a>
+
+## latestBreach([options]) ⇒ [<code>Promise.&lt;Breach&gt;</code>](#breach--object) \| <code>Promise.&lt;null&gt;</code>
+Fetches the most recently added breach.
+
+**Kind**: global function  
+**Returns**: [<code>Promise.&lt;Breach&gt;</code>](#breach--object) \| <code>Promise.&lt;null&gt;</code> - a Promise which resolves to an
+object representing a breach (or null if no breach was found), or rejects
+with an Error  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | <code>object</code> | a configuration object |
+| [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) |
+| [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) |
+| [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) |
+
+**Example**  
+```js
+try {
+  const data = await latestBreach();
+  if (data) {
+    // ...
+  } else {
+    // ...
+  }
+} catch (err) {
+  // ...
+}
+```
 <a name="pasteAccount"></a>
 
 ## pasteAccount(email, [options]) ⇒ <code><a href="#paste--object">Promise.&lt;Array.&lt;Paste&gt;&gt;</a></code> \| <code>Promise.&lt;null&gt;</code>
@@ -469,6 +611,208 @@ try {
   // ...
 }
 ```
+<a name="stealerLogsByEmailDomain"></a>
+
+## stealerLogsByEmailDomain(emailDomain, [options]) ⇒ [<code>Promise.&lt;StealerLogDomainsByEmailAlias&gt;</code>](#StealerLogDomainsByEmailAlias) \| <code>Promise.&lt;null&gt;</code>
+Fetches all stealer log email aliases for an email domain.
+
+The result maps email aliases (the local-part before the '@') to an array of
+email domains found in stealer logs. For example, querying `example.com`
+could return an object like `{ "andy": ["netflix.com"], "jane": ["netflix.com",
+"spotify.com"] }`, corresponding to `andy@example.com` and `jane@example.com`.
+
+🔑 `haveibeenpwned.com` requires an API key from
+https://haveibeenpwned.com/API/Key for the `stealerlogsbyemaildomain` endpoint.
+The `apiKey` option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a `baseUrl` to a proxy that inserts
+a valid API key on your behalf).
+
+**Kind**: global function  
+**Returns**: [<code>Promise.&lt;StealerLogDomainsByEmailAlias&gt;</code>](#StealerLogDomainsByEmailAlias) \| <code>Promise.&lt;null&gt;</code> - a Promise
+which resolves to an object mapping aliases to stealer log email domain arrays
+(or null if no results were found), or rejects with an Error  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| emailDomain | <code>string</code> | the email domain to query (e.g., "example.com") |
+| [options] | <code>object</code> | a configuration object |
+| [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) |
+| [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) |
+| [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) |
+| [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) |
+
+**Example**  
+```js
+try {
+  const data = await stealerLogsByEmailDomain("example.com", { apiKey: "my-api-key" });
+  if (data) {
+    // { "andy": ["netflix.com"], "jane": ["netflix.com", "spotify.com"] }
+  } else {
+    // no results
+  }
+} catch (err) {
+  // ...
+}
+```
+<a name="stealerLogsByEmail"></a>
+
+## stealerLogsByEmail(emailAddress, [options]) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>Promise.&lt;null&gt;</code>
+Fetches all stealer log domains for an email address.
+
+Returns an array of domains for which stealer logs contain entries for the
+supplied email address.
+
+🔑 `haveibeenpwned.com` requires an API key from
+https://haveibeenpwned.com/API/Key for the `stealerlogsbyemail` endpoint. The
+`apiKey` option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a `baseUrl` to a proxy that inserts
+a valid API key on your behalf).
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>Promise.&lt;null&gt;</code> - a Promise which resolves to an
+array of domain strings (or null if none were found), or rejects with an
+Error  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| emailAddress | <code>string</code> | the email address to query |
+| [options] | <code>object</code> | a configuration object |
+| [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) |
+| [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) |
+| [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) |
+| [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) |
+
+**Example**  
+```js
+try {
+  const data = await stealerLogsByEmail("foo@bar.com", { apiKey: "my-api-key" });
+  if (data) {
+    // ...
+  } else {
+    // ...
+  }
+} catch (err) {
+  // ...
+}
+```
+**Example**  
+```js
+try {
+  const data = await stealerLogsByEmail("foo@bar.com", {
+    baseUrl: "https://my-hibp-proxy:8080",
+  });
+  if (data) {
+    // ...
+  } else {
+    // ...
+  }
+} catch (err) {
+  // ...
+}
+```
+<a name="stealerLogsByWebsiteDomain"></a>
+
+## stealerLogsByWebsiteDomain(websiteDomain, [options]) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>Promise.&lt;null&gt;</code>
+Fetches all stealer log email addresses for a website domain.
+
+The result is an array of strings representing email addresses found in
+stealer logs for the specified website domain (e.g., "example.com").
+
+🔑 `haveibeenpwned.com` requires an API key from
+https://haveibeenpwned.com/API/Key for the `stealerlogsbywebsitedomain`
+endpoint. The `apiKey` option here is not explicitly required, but direct
+requests made without it will fail (unless you specify a `baseUrl` to a proxy
+that inserts a valid API key on your behalf).
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>Promise.&lt;null&gt;</code> - a Promise which resolves to an
+array of email addresses (or null if no results were found), or rejects with
+an Error  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| websiteDomain | <code>string</code> | the website domain to query (e.g., "example.com") |
+| [options] | <code>object</code> | a configuration object |
+| [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) |
+| [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) |
+| [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) |
+| [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) |
+
+**Example**  
+```js
+try {
+  const data = await stealerLogsByWebsiteDomain("example.com", { apiKey: "my-api-key" });
+  if (data) {
+    // ["andy@gmail.com", "jane@gmail.com"]
+  } else {
+    // no results
+  }
+} catch (err) {
+  // ...
+}
+```
+**Example**  
+```js
+try {
+  const data = await stealerLogsByWebsiteDomain("example.com", {
+    baseUrl: "https://my-hibp-proxy:8080",
+  });
+  if (data) {
+    // ...
+  } else {
+    // ...
+  }
+} catch (err) {
+  // ...
+}
+```
+<a name="subscribedDomains"></a>
+
+## subscribedDomains([options]) ⇒ <code><a href="#subscribeddomain--object">Promise.&lt;Array.&lt;SubscribedDomain&gt;&gt;</a></code>
+Fetches all subscribed domains for your HIBP account.
+
+Returns domains that have been successfully added to the Domain Search dashboard
+after verifying control. Each domain includes metadata about breach counts and
+the next renewal date, where available.
+
+🔑 `haveibeenpwned.com` requires an API key from
+https://haveibeenpwned.com/API/Key for the `subscribeddomains` endpoint. The
+`apiKey` option here is not explicitly required, but direct requests made
+without it will fail (unless you specify a `baseUrl` to a proxy that inserts
+a valid API key on your behalf).
+
+**Kind**: global function  
+**Returns**: <code><a href="#subscribeddomain--object">Promise.&lt;Array.&lt;SubscribedDomain&gt;&gt;</a></code> - a Promise which resolves to an array of
+subscribed domain objects (an empty array if none), or rejects with an Error  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | <code>object</code> | a configuration object |
+| [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) |
+| [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) |
+| [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) |
+| [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) |
+
+**Example**  
+```js
+try {
+  const data = await subscribedDomains({ apiKey: "my-api-key" });
+  // ...
+} catch (err) {
+  // ...
+}
+```
+**Example**  
+```js
+try {
+  const data = await subscribedDomains({
+    baseUrl: "https://my-hibp-proxy:8080",
+  });
+  // ...
+} catch (err) {
+  // ...
+}
+```
 <a name="subscriptionStatus"></a>
 
 ## subscriptionStatus([options]) ⇒ [<code>Promise.&lt;SubscriptionStatus&gt;</code>](#subscriptionstatus--object)
@@ -540,6 +884,13 @@ An object representing a breach.
 | IsSubscriptionFree | <code>boolean</code> | 
 | LogoPath | <code>string</code> | 
 
+<a name="BreachedDomainsByEmailAlias"></a>
+
+## BreachedDomainsByEmailAlias : <code>Object.&lt;string, Array.&lt;string&gt;&gt;</code>
+An object mapping an email alias (local-part before the '@') to the list of
+breach names that alias has appeared in for the specified domain.
+
+**Kind**: global typedef  
 <a name="Paste"></a>
 
 ## Paste : <code>object</code>
@@ -576,6 +927,30 @@ An object representing search results.
 | breaches | [<code>Array.&lt;Breach&gt;</code>](#breach--object) \| <code>null</code> | 
 | pastes | [<code>Array.&lt;Paste&gt;</code>](#Paste) \| <code>null</code> | 
 
+<a name="StealerLogDomainsByEmailAlias"></a>
+
+## StealerLogDomainsByEmailAlias : <code>Object.&lt;string, Array.&lt;string&gt;&gt;</code>
+An object mapping an email alias (local-part before the '@') to the list of
+email domains that alias has appeared in within stealer logs for the specified
+email domain.
+
+**Kind**: global typedef  
+<a name="SubscribedDomain"></a>
+
+## SubscribedDomain : <code>object</code>
+An object representing a subscribed domain.
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| DomainName | <code>string</code> | the fully qualified domain name |
+| PwnCount | <code>number</code> \| <code>null</code> | total breached addresses at last search |
+| PwnCountExcludingSpamLists | <code>number</code> \| <code>null</code> | breached addresses excluding spam lists at last search |
+| PwnCountExcludingSpamListsAtLastSubscriptionRenewal | <code>number</code> \| <code>null</code> | breached addresses excluding spam lists at the time of last subscription renewal |
+| NextSubscriptionRenewal | <code>string</code> \| <code>null</code> | ISO 8601 datetime when the current subscription ends |
+
 <a name="SubscriptionStatus"></a>
 
 ## SubscriptionStatus : <code>object</code>
@@ -591,4 +966,5 @@ An object representing the status of your HIBP subscription.
 | SubscribedUntil | <code>string</code> | 
 | Rpm | <code>number</code> | 
 | DomainSearchMaxBreachedAccounts | <code>number</code> | 
+| IncludesStealerLogs | <code>boolean</code> | 
 

package/CHANGELOG.md

@@ -1,13 +1,37 @@
 # Change Log
 
+## 15.1.0
+
+### Minor Changes
+
+- [#543](https://github.com/wKovacs64/hibp/pull/543) [`70db0e1`](https://github.com/wKovacs64/hibp/commit/70db0e181d050b89eee34b326d6fb6247a5075bd) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `stealerLogsByEmailDomain` module.
+
+- [#541](https://github.com/wKovacs64/hibp/pull/541) [`655b473`](https://github.com/wKovacs64/hibp/commit/655b473741b6ef358684c2c56c0bd4746ba0baf5) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `stealerLogsByEmail` module.
+
+- [#542](https://github.com/wKovacs64/hibp/pull/542) [`682cff7`](https://github.com/wKovacs64/hibp/commit/682cff74c56322b348afab607da6786ff4c01691) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `stealerLogsByWebsiteDomain` module.
+
+- [#539](https://github.com/wKovacs64/hibp/pull/539) [`a0c6e9a`](https://github.com/wKovacs64/hibp/commit/a0c6e9a01ad25931320e8dc79993faf11b127524) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `subscribedDomains` module.
+
+- [#537](https://github.com/wKovacs64/hibp/pull/537) [`e15c6a7`](https://github.com/wKovacs64/hibp/commit/e15c6a7e053ded3e79ac407a33a213890d642454) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `latestBreach` module.
+
+- [#538](https://github.com/wKovacs64/hibp/pull/538) [`f08af27`](https://github.com/wKovacs64/hibp/commit/f08af2795aac451d2d4abd9bca144214554b2575) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `breachedDomain` module.
+
+### Patch Changes
+
+- [#535](https://github.com/wKovacs64/hibp/pull/535) [`d47d462`](https://github.com/wKovacs64/hibp/commit/d47d46252c96990e35e785239189ca4834a80b4a) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Add `IncludesStealerLogs` field to `SubscriptionStatus` interface and docs.
+
+## 15.0.1
+
+### Patch Changes
+
+- [#510](https://github.com/wKovacs64/hibp/pull/510) [`879fe9f`](https://github.com/wKovacs64/hibp/commit/879fe9fc3a7853eef69146841be32cdcfab0aa25) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Export the API data model types that were missing in v15.0.0.
+
 ## 15.0.0
 
 ### Major Changes
 
 - [#509](https://github.com/wKovacs64/hibp/pull/509) [`e8d4986`](https://github.com/wKovacs64/hibp/commit/e8d498622020fe0c99847f915839ce382bf4d817) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Drop support for Node 18 and remove the CommonJS and UMD builds:
-
   - Drop support for Node.js 18 as it is [end-of-life](https://nodejs.org/en/about/releases/), making the new minimum Node.js runtime v20.19.0. Please upgrade your Node.js environment if necessary, or continue using a previous release if you are unable to upgrade your environment.
-
     - This also allowed us to drop the `fetch` polyfill that was only necessary in Node 18, which reduced the bundle size by approximately 33%! 📉 The library now officially has **zero dependencies**. 🎉
 
   - Remove the CommonJS build since [you can now `require()` ESM as of Node v20.19.0](https://github.com/nodejs/node/releases/tag/v20.19.0). **Consumers in a CommonJS environment should still be able to use the library as before** (given the appropriate Node.js version).

package/MIGRATION.md

@@ -17,7 +17,6 @@
 #### 9.0.3 → 10.0.0
 
 - The production/minified versions of the browser build targets have been renamed:
-
   - ESM for Browsers (`<script type="module">`)
     - `dist/browser/hibp.esm.min.js` → `dist/browser/hibp.module.js`
   - UMD
@@ -38,7 +37,6 @@
 
 - Output files for all build targets have been consolidated under the `dist` directory. This should
   be transparent if you followed the documentation, but the changes are as follows:
-
   - CommonJS
     - `lib/hibp.js` → `dist/cjs/hibp.js`
   - ECMAScript Modules

package/README.md

@@ -36,14 +36,20 @@ browser.
 
 ## Features (🔑 = [requires][api-key-blog-post] an [API key][get-api-key])
 
+- Get the most recently added breach
 - Get a single breach event
 - Get all breaches for an account 🔑
+- Get all breached email addresses for a domain 🔑
 - Get all breach events in the system
 - Get all data classes
 - Get all pastes for an account 🔑
 - [Securely][search-by-range] check a password to see if it has been exposed in a data breach
 - Check a SHA-1 or NTLM prefix to see if it has been exposed in a data breach
 - Search for an account in both breaches and pastes at the same time 🔑
+- Get all stealer log domains for an email address 🔑
+- Get all stealer log email aliases for an email domain 🔑
+- Get all stealer log email addresses for a website domain 🔑
+- Get all subscribed domains 🔑
 - Get your subscription status 🔑
 - All queries return a Promise
 - Available server-side (e.g., Node.js) and client-side (browser)
@@ -63,12 +69,18 @@ The following modules are available:
 
 - [breach](API.md#breach)
 - [breachedAccount](API.md#breachedaccount)
+- [breachedDomain](API.md#breacheddomain)
 - [breaches](API.md#breaches)
 - [dataClasses](API.md#dataclasses)
+- [latestBreach](API.md#latestbreach)
 - [pasteAccount](API.md#pasteaccount)
 - [pwnedPassword](API.md#pwnedpassword)
 - [pwnedPasswordRange](API.md#pwnedpasswordrange)
 - [search](API.md#search)
+- [stealerLogsByEmail](API.md#stealerlogsbyemail)
+- [stealerLogsByEmailDomain](API.md#stealerlogsbyemaildomain)
+- [stealerLogsByWebsiteDomain](API.md#stealerlogsbywebsitedomain)
+- [subscribedDomains](API.md#subscribeddomains)
 - [subscriptionStatus](API.md#subscriptionstatus)
 
 Please see the [API reference](API.md) for more detailed usage information and examples.
@@ -170,7 +182,7 @@ This module is distributed under the [MIT License][license].
 [ci-url]: https://github.com/wKovacs64/hibp/actions?query=workflow%3Aci
 [coverage-image]: https://img.shields.io/codecov/c/github/wKovacs64/hibp/main.svg?style=flat-square
 [coverage-url]: https://codecov.io/gh/wKovacs64/hibp/branch/main
-[deno]: https://deno.land/
+[deno]: https://deno.com/
 [troy]: https://www.troyhunt.com
 [haveibeenpwned]: https://haveibeenpwned.com
 [haveibeenpwned-rate-limiting]: https://haveibeenpwned.com/API/v3#RateLimiting

package/dist/browser/hibp.module.js

@@ -1,2 +1,2 @@
-var w="hibp",y="15.0.0";var h={status:400,statusText:"Bad request \u2014 the account does not comply with an acceptable format."},P={status:401,body:`Your request to the API couldn't be authorised. Check you have the right value in the "hibp-api-key" header, refer to the documentation for more: https://haveibeenpwned.com/API/v3#Authorisation`},g={status:403,statusText:"Forbidden - access denied."};var x={status:404},U={headers:new Map([["retry-after","2"]]),status:429,body:{statusCode:429,message:"Rate limit is exceeded. Try again in 2 seconds."}};var d=class extends Error{retryAfterSeconds;constructor(t,r,n){super(r,n),this.name=this.constructor.name,this.retryAfterSeconds=typeof t=="string"?Number.parseInt(t,10):void 0}};function I(e){return`Request blocked, contact haveibeenpwned.com if this continues (Ray ID: ${e})`}async function u(e,t={}){let{apiKey:r,baseUrl:n="https://haveibeenpwned.com/api/v3",timeoutMs:o,userAgent:a}=t,i={};r&&(i["HIBP-API-Key"]=r),a&&(i["User-Agent"]=a),!a&&typeof navigator>"u"&&(i["User-Agent"]=`${w} ${y}`);let p={headers:i,...o?{signal:AbortSignal.timeout(o)}:{}},m=`${n.replace(/\/$/g,"")}${e}`,s=await fetch(m,p);if(s.ok)return s.json();switch(s.status){case h.status:throw new Error(h.statusText);case P.status:{let c=await s.text();throw new Error(c)}case g.status:{let c=s.headers.get("cf-ray");throw c?new Error(I(c)):new Error(g.statusText)}case x.status:return null;case U.status:{let c=await s.json(),f=s.headers.get("retry-after");throw new d(f,c.message)}default:throw new Error(s.statusText)}}function B(e,t={}){return u(`/breach/${encodeURIComponent(e)}`,t)}function l(e,t={}){let{apiKey:r,domain:n,includeUnverified:o=!0,timeoutMs:a,truncate:i=!0,baseUrl:p,userAgent:m}=t,s=`/breachedaccount/${encodeURIComponent(e)}?`,c=[];return n&&c.push(`domain=${encodeURIComponent(n)}`),o||c.push("includeUnverified=false"),i||c.push("truncateResponse=false"),u(`${s}${c.join("&")}`,{apiKey:r,baseUrl:p,timeoutMs:a,userAgent:m})}function M(e={}){let{domain:t,baseUrl:r,timeoutMs:n,userAgent:o}=e,a="/breaches?",i=[];return t&&i.push(`domain=${encodeURIComponent(t)}`),u(`${a}${i.join("&")}`,{baseUrl:r,timeoutMs:n,userAgent:o})}function T(e={}){return u("/dataclasses",e)}function b(e,t={}){return u(`/pasteaccount/${encodeURIComponent(e)}`,t)}var E={status:400,body:"The hash prefix was not in a valid format"};async function R(e,t={}){let{baseUrl:r="https://api.pwnedpasswords.com",timeoutMs:n,userAgent:o,addPadding:a=!1,mode:i="sha1"}=t,p={headers:{...o?{"User-Agent":o}:{},...a?{"Add-Padding":"true"}:{}},...n?{signal:AbortSignal.timeout(n)}:{}},m=`${r.replace(/\/$/g,"")}${e}?mode=${i}`,s=await fetch(m,p);if(s.ok)return s.text();if(s.status===E.status){let c=await s.text();throw new Error(c)}throw new Error(s.statusText)}async function A(e,t={}){let{baseUrl:r,timeoutMs:n,userAgent:o,addPadding:a=!1,mode:i="sha1"}=t;return(await R(`/range/${encodeURIComponent(e)}`,{baseUrl:r,timeoutMs:n,userAgent:o,addPadding:a,mode:i})).split(`
-`).filter(Boolean).reduce((s,c)=>{let[f,S]=c.split(":");return s[f]=Number.parseInt(S,10),s},{})}async function D(e,t={}){let[r,n]=await $(e);return(await A(r,t))[n]||0}async function $(e){if(typeof crypto=="object"&&crypto.subtle){let t=new TextEncoder().encode(e),r=await crypto.subtle.digest("SHA-1",t),o=Array.from(new Uint8Array(r)).map(a=>a.toString(16).padStart(2,"0")).join("").toUpperCase();return[o.slice(0,5),o.slice(5)]}throw new Error("The Web Crypto API is not available in this environment.")}async function v(e,t={}){let{apiKey:r,domain:n,truncate:o=!0,baseUrl:a,timeoutMs:i,userAgent:p}=t,[m,s]=await Promise.all([l(e,{apiKey:r,domain:n,truncate:o,baseUrl:a,timeoutMs:i,userAgent:p}),/^.+@.+$/.test(e)?b(e,{apiKey:r,baseUrl:a,timeoutMs:i,userAgent:p}):null]);return{breaches:m,pastes:s}}async function C(e={}){return u("/subscription/status",e)}export{d as RateLimitError,B as breach,l as breachedAccount,M as breaches,T as dataClasses,b as pasteAccount,D as pwnedPassword,A as pwnedPasswordRange,v as search,C as subscriptionStatus};
+var A="hibp",w="15.1.0";var g={status:400,statusText:"Bad request \u2014 the account does not comply with an acceptable format."},P={status:401,body:`Your request to the API couldn't be authorised. Check you have the right value in the "hibp-api-key" header, refer to the documentation for more: https://haveibeenpwned.com/API/v3#Authorisation`},f={status:403,statusText:"Forbidden - access denied."};var U={status:404},E={headers:new Map([["retry-after","2"]]),status:429,body:{statusCode:429,message:"Rate limit is exceeded. Try again in 2 seconds."}};var d=class extends Error{retryAfterSeconds;constructor(t,s,r){super(s,r),this.name=this.constructor.name,this.retryAfterSeconds=typeof t=="string"?Number.parseInt(t,10):void 0}};function R(e){return`Request blocked, contact haveibeenpwned.com if this continues (Ray ID: ${e})`}async function a(e,t={}){let{apiKey:s,baseUrl:r="https://haveibeenpwned.com/api/v3",timeoutMs:n,userAgent:o}=t,i={};s&&(i["HIBP-API-Key"]=s),o&&(i["User-Agent"]=o),!o&&typeof navigator>"u"&&(i["User-Agent"]=`${A} ${w}`);let c={headers:i,...n?{signal:AbortSignal.timeout(n)}:{}},u=`${r.replace(/\/$/g,"")}${e}`,m=await fetch(u,c);if(m.ok)return m.json();switch(m.status){case g.status:throw new Error(g.statusText);case P.status:{let p=await m.text();throw new Error(p)}case f.status:{let p=m.headers.get("cf-ray");throw p?new Error(R(p)):new Error(f.statusText)}case U.status:return null;case E.status:{let p=await m.json(),l=m.headers.get("retry-after");throw new d(l,p.message)}default:throw new Error(m.statusText)}}function S(e,t={}){return a(`/breach/${encodeURIComponent(e)}`,t)}function b(e,t={}){let{apiKey:s,domain:r,includeUnverified:n=!0,timeoutMs:o,truncate:i=!0,baseUrl:c,userAgent:u}=t,m=`/breachedaccount/${encodeURIComponent(e)}?`,p=[];return r&&p.push(`domain=${encodeURIComponent(r)}`),n||p.push("includeUnverified=false"),i||p.push("truncateResponse=false"),a(`${m}${p.join("&")}`,{apiKey:s,baseUrl:c,timeoutMs:o,userAgent:u})}function M(e,t={}){let{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o}=t,i=`/breacheddomain/${encodeURIComponent(e)}`;return a(i,{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o})}function I(e={}){let{domain:t,baseUrl:s,timeoutMs:r,userAgent:n}=e,o="/breaches?",i=[];return t&&i.push(`domain=${encodeURIComponent(t)}`),a(`${o}${i.join("&")}`,{baseUrl:s,timeoutMs:r,userAgent:n})}function v(e={}){return a("/dataclasses",e)}function K(e={}){return a("/latestbreach",e)}function h(e,t={}){return a(`/pasteaccount/${encodeURIComponent(e)}`,t)}var x={status:400,body:"The hash prefix was not in a valid format"};async function B(e,t={}){let{baseUrl:s="https://api.pwnedpasswords.com",timeoutMs:r,userAgent:n,addPadding:o=!1,mode:i="sha1"}=t,c={headers:{...n?{"User-Agent":n}:{},...o?{"Add-Padding":"true"}:{}},...r?{signal:AbortSignal.timeout(r)}:{}},u=`${s.replace(/\/$/g,"")}${e}?mode=${i}`,m=await fetch(u,c);if(m.ok)return m.text();if(m.status===x.status){let p=await m.text();throw new Error(p)}throw new Error(m.statusText)}async function y(e,t={}){let{baseUrl:s,timeoutMs:r,userAgent:n,addPadding:o=!1,mode:i="sha1"}=t;return(await B(`/range/${encodeURIComponent(e)}`,{baseUrl:s,timeoutMs:r,userAgent:n,addPadding:o,mode:i})).split(`
+`).filter(Boolean).reduce((m,p)=>{let[l,D]=p.split(":");return m[l]=Number.parseInt(D,10),m},{})}async function $(e,t={}){let[s,r]=await C(e);return(await y(s,t))[r]||0}async function C(e){if(typeof crypto=="object"&&crypto.subtle){let t=new TextEncoder().encode(e),s=await crypto.subtle.digest("SHA-1",t),n=Array.from(new Uint8Array(s)).map(o=>o.toString(16).padStart(2,"0")).join("").toUpperCase();return[n.slice(0,5),n.slice(5)]}throw new Error("The Web Crypto API is not available in this environment.")}async function T(e,t={}){let{apiKey:s,domain:r,truncate:n=!0,baseUrl:o,timeoutMs:i,userAgent:c}=t,[u,m]=await Promise.all([b(e,{apiKey:s,domain:r,truncate:n,baseUrl:o,timeoutMs:i,userAgent:c}),/^.+@.+$/.test(e)?h(e,{apiKey:s,baseUrl:o,timeoutMs:i,userAgent:c}):null]);return{breaches:u,pastes:m}}function F(e,t={}){let{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o}=t,i=`/stealerlogsbyemail/${encodeURIComponent(e)}`;return a(i,{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o})}function j(e,t={}){let{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o}=t,i=`/stealerlogsbyemaildomain/${encodeURIComponent(e)}`;return a(i,{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o})}function L(e,t={}){let{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o}=t,i=`/stealerlogsbywebsitedomain/${encodeURIComponent(e)}`;return a(i,{apiKey:s,baseUrl:r,timeoutMs:n,userAgent:o})}function O(e={}){let{apiKey:t,baseUrl:s,timeoutMs:r,userAgent:n}=e;return a("/subscribeddomains",{apiKey:t,baseUrl:s,timeoutMs:r,userAgent:n})}async function N(e={}){return a("/subscription/status",e)}export{d as RateLimitError,S as breach,b as breachedAccount,M as breachedDomain,I as breaches,v as dataClasses,K as latestBreach,h as pasteAccount,$ as pwnedPassword,y as pwnedPasswordRange,T as search,F as stealerLogsByEmail,j as stealerLogsByEmailDomain,L as stealerLogsByWebsiteDomain,O as subscribedDomains,N as subscriptionStatus};

package/dist/esm/api/haveibeenpwned/package-info.d.ts

@@ -1,2 +1,2 @@
 export declare const PACKAGE_NAME = "hibp";
-export declare const PACKAGE_VERSION = "15.0.0";
+export declare const PACKAGE_VERSION = "15.1.0";

package/dist/esm/api/haveibeenpwned/package-info.js

@@ -1,4 +1,4 @@
 // This file is auto-generated. Do not edit.
 export const PACKAGE_NAME = "hibp";
-export const PACKAGE_VERSION = "15.0.0";
+export const PACKAGE_VERSION = "15.1.0";
 //# sourceMappingURL=package-info.js.map

package/dist/esm/api/haveibeenpwned/types.d.ts

@@ -30,9 +30,14 @@ export interface SubscriptionStatus {
     SubscribedUntil: string;
     Rpm: number;
     DomainSearchMaxBreachedAccounts: number;
+    IncludesStealerLogs: boolean;
 }
-/**
- * All possible values that can be returned in the response body of an API query
- *
- * @internal
- */
+export interface SubscribedDomain {
+    DomainName: string;
+    PwnCount: number | null;
+    PwnCountExcludingSpamLists: number | null;
+    PwnCountExcludingSpamListsAtLastSubscriptionRenewal: number | null;
+    NextSubscriptionRenewal: string | null;
+}
+export type BreachedDomainsByEmailAlias = Record<string, string[]>;
+export type StealerLogDomainsByEmailAlias = Record<string, string[]>;

package/dist/esm/api/haveibeenpwned/types.js

@@ -2,10 +2,4 @@
 // Data Models from the API
 //
 export {};
-/**
- * All possible values that can be returned in the response body of an API query
- *
- * @internal
- */
-// export type ResponseBody = ApiData | ErrorData;
 //# sourceMappingURL=types.js.map

package/dist/esm/api/haveibeenpwned/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/haveibeenpwned/types.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,2BAA2B;AAC3B,EAAE;;AAiEF;;;;GAIG;AACH,kDAAkD"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/haveibeenpwned/types.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,2BAA2B;AAC3B,EAAE"}