Promise ⏏Promise.<Breach> | Promise.<null> ⏏Fetches data for a specific breach event.
Promise ⏏Promise.<Array.<Breach>> | Promise.<null> ⏏Fetches breach data for a specific account.
Promise ⏏Promise.<Array.<Breach>> ⏏Fetches all breach events in the system.
Promise ⏏Promise.<Array.<string>> | Promise.<null> ⏏Fetches all data classes in the system.
Promise ⏏Promise.<Array.<Paste>> | Promise.<null> ⏏Fetches paste data for a specific account (email address).
Promise ⏏Promise.<number> ⏏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.
Promise ⏏Promise.<Array.<PwnedPasswordSuffix>> ⏏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 @@ -69,7 +69,7 @@ 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.
Promise ⏏Promise.<SearchResults> ⏏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 @@ -80,6 +80,25 @@ convenience method is designed to mimic.
objectAn object representing a breach.
+objectAn object representing a paste.
+objectAn object representing an exposed password hash suffix (corresponding to a +given hash prefix) and how many times it occurred in the Pwned Passwords +repository.
+objectAn object representing search results.
+Promise ⏏
+### breach(breachName) ⇒ [Promise.<Breach>](#breach--object) \| Promise.<null> ⏏
Fetches data for a specific breach event.
**Kind**: global method of [breach](#module_breach)
-**Returns**: Promise - a Promise which resolves to an object representing a
-breach (or null if no breach was found), or rejects with an Error
+**Returns**: [Promise.<Breach>](#breach--object) \| Promise.<null> - 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 |
| --- | --- | --- |
@@ -127,17 +147,18 @@ import { breachedAccount } from 'hibp';
```
-### breachedAccount(account, [options]) ⇒ Promise ⏏
+### breachedAccount(account, [options]) ⇒ Promise.<Array.<Breach>> \| Promise.<null> ⏏
Fetches breach data for a specific account.
**Kind**: global method of [breachedAccount](#module_breachedAccount)
-**Returns**: Promise - a Promise which resolves to an array of breach objects
-(or null if no breaches were found), or rejects with an Error
+**Returns**: Promise.<Array.<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
| Param | Type | Description |
| --- | --- | --- |
| account | string | a username or email address |
-| [options] | Object | a configuration object |
+| [options] | object | a configuration object |
| [options.domain] | string | a domain by which to filter the results (default: all domains) |
| [options.truncate] | boolean | truncate the results to only include the name of each breach (default: false) |
@@ -194,16 +215,16 @@ import { breaches } from 'hibp';
```
-### breaches([options]) ⇒ Promise ⏏
+### breaches([options]) ⇒ Promise.<Array.<Breach>> ⏏
Fetches all breach events in the system.
**Kind**: global method of [breaches](#module_breaches)
-**Returns**: Promise - a Promise which resolves to an array of breach objects
-(an empty array if no breaches were found), or rejects with an Error
+**Returns**: Promise.<Array.<Breach>> - a Promise which resolves to an array of breach
+objects (an empty array if no breaches were found), or rejects with an Error
| Param | Type | Description |
| --- | --- | --- |
-| [options] | Object | a configuration object |
+| [options] | object | a configuration object |
| [options.domain] | string | a domain by which to filter the results (default: all domains) |
**Example**
@@ -245,12 +266,13 @@ import { dataClasses } from 'hibp';
```
-### dataClasses() ⇒ Promise ⏏
+### dataClasses() ⇒ Promise.<Array.<string>> \| Promise.<null> ⏏
Fetches all data classes in the system.
**Kind**: global method of [dataClasses](#module_dataClasses)
-**Returns**: Promise - a Promise which resolves to an array of strings (or
-null if no data classes were found), or rejects with an Error
+**Returns**: Promise.<Array.<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**
```js
dataClasses()
@@ -276,12 +298,13 @@ import { pasteAccount } from 'hibp';
```
-### pasteAccount(email) ⇒ Promise ⏏
+### pasteAccount(email) ⇒ Promise.<Array.<Paste>> \| Promise.<null> ⏏
Fetches paste data for a specific account (email address).
**Kind**: global method of [pasteAccount](#module_pasteAccount)
-**Returns**: Promise - a Promise which resolves to an array of paste objects
-(or null if no pastes were found), or rejects with an Error
+**Returns**: Promise.<Array.<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
| Param | Type | Description |
| --- | --- | --- |
@@ -313,14 +336,14 @@ import { pwnedPassword } from 'hibp';
```
-### pwnedPassword(password) ⇒ Promise ⏏
+### pwnedPassword(password) ⇒ Promise.<number> ⏏
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.
**Kind**: global method of [pwnedPassword](#module_pwnedPassword)
-**Returns**: Promise - a Promise which resolves to the number of times the
-password has been exposed in a breach, or rejects with an Error
+**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
**See**: https://haveibeenpwned.com/API/v2#PwnedPasswords
| Param | Type | Description |
@@ -354,7 +377,7 @@ import { pwnedPasswordRange } from 'hibp';
```
-### pwnedPasswordRange(prefix) ⇒ Promise ⏏
+### pwnedPasswordRange(prefix) ⇒ Promise.<Array.<PwnedPasswordSuffix>> ⏏
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
@@ -364,10 +387,10 @@ of how many times it appears in the data set. This function parses the
response and returns a more structured format.
**Kind**: global method of [pwnedPasswordRange](#module_pwnedPasswordRange)
-**Returns**: Promise - a Promise which resolves to an array of objects, each
-containing the `suffix` that when matched with the prefix composes the
-complete hash, and a `count` of how many times it appears in the breached
-password data set, or rejects with an Error
+**Returns**: Promise.<Array.<PwnedPasswordSuffix>> - a Promise which resolves to an array
+of objects, each containing the `suffix` that when matched with the prefix
+composes the complete hash, and a `count` of how many times it appears in the
+breached password data set, or rejects with an Error
**See**: https://haveibeenpwned.com/API/v2#SearchingPwnedPasswordsByRange
| Param | Type | Description |
@@ -410,7 +433,7 @@ import { search } from 'hibp';
```
-### search(account, [breachOptions]) ⇒ Promise ⏏
+### search(account, [breachOptions]) ⇒ [Promise.<SearchResults>](#SearchResults) ⏏
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
@@ -420,16 +443,16 @@ exactly how searching via the current web interface behaves, which this
convenience method is designed to mimic.
**Kind**: global method of [search](#module_search)
-**Returns**: Promise - 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
+**Returns**: [Promise.<SearchResults>](#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
**See**: https://haveibeenpwned.com/
| Param | Type | Description |
| --- | --- | --- |
| account | string | an email address or username |
-| [breachOptions] | Object | a configuration object pertaining to breach queries |
+| [breachOptions] | object | a configuration object pertaining to breach queries |
| [breachOptions.domain] | string | a domain by which to filter the results (default: all domains) |
| [breachOptions.truncate] | boolean | truncate the results to only include the name of each breach (default: false) |
@@ -473,3 +496,73 @@ import * as hibp from 'hibp';
// Now all hibp functions are available on the hibp object:
hibp.dataClasses().then(...)
```
+
+
+## Breach : object
+An object representing a breach.
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| Name | string |
+| Title | string |
+| Domain | string |
+| BreachDate | string |
+| AddedDate | string |
+| ModifiedDate | string |
+| PwnCount | number |
+| Description | string |
+| LogoPath | string |
+| DataClasses | Array.<string> |
+| IsVerified | boolean |
+| IsFabricated | boolean |
+| IsSensitive | boolean |
+| IsRetired | boolean |
+| IsSpamList | boolean |
+
+
+
+## Paste : object
+An object representing a paste.
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| Id | string |
+| Source | string |
+| Title | string |
+| Date | string |
+| EmailCount | number |
+
+
+
+## PwnedPasswordSuffix : object
+An object representing an exposed password hash suffix (corresponding to a
+given hash prefix) and how many times it occurred in the Pwned Passwords
+repository.
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| suffix | string |
+| count | number |
+
+
+
+## SearchResults : object
+An object representing search results.
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| breaches | [Array.<Breach>](#breach--object) \| null |
+| pastes | [Array.<Paste>](#Paste) \| null |
+
diff --git a/cypress/integration/browser.spec.js b/cypress/integration/browser.spec.ts
similarity index 100%
rename from cypress/integration/browser.spec.js
rename to cypress/integration/browser.spec.ts
diff --git a/cypress/tsconfig.json b/cypress/tsconfig.json
new file mode 100644
index 00000000..76d60acd
--- /dev/null
+++ b/cypress/tsconfig.json
@@ -0,0 +1,8 @@
+{
+ "compilerOptions": {
+ "noEmit": true,
+ "strict": true,
+ "types": ["cypress", "jsdom"]
+ },
+ "include": ["."]
+}
diff --git a/cypress/types/hibp-umd.d.ts b/cypress/types/hibp-umd.d.ts
new file mode 100644
index 00000000..03f6ca97
--- /dev/null
+++ b/cypress/types/hibp-umd.d.ts
@@ -0,0 +1,14 @@
+// Augment the Window interface so we can use cy.window().its('hibp.breach')
+// (for example) in tests.
+
+interface Window {
+ hibp: object;
+ 'hibp.breach': () => any;
+ 'hibp.breachedAccount': () => any;
+ 'hibp.breaches': () => any;
+ 'hibp.dataClasses': () => any;
+ 'hibp.pasteAccount': () => any;
+ 'hibp.pwnedPassword': () => any;
+ 'hibp.pwnedPasswordRange': () => any;
+ 'hibp.search': () => any;
+}
diff --git a/jest.config.js b/jest.config.js
index e46b326c..0e0a3adf 100644
--- a/jest.config.js
+++ b/jest.config.js
@@ -4,6 +4,10 @@ module.exports = {
coveragePathIgnorePatterns: ['