hibp
Version:
An unofficial TypeScript SDK for the 'Have I been pwned?' service.
97 lines • 3.73 kB
JavaScript
import { baseFetch } from '../base-fetch.js';
import { BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, TOO_MANY_REQUESTS } from './responses.js';
/**
* 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 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;
constructor(retryAfter, message, options) {
super(message, options);
this.name = this.constructor.name;
this.retryAfterSeconds =
typeof retryAfter === 'string' ? Number.parseInt(retryAfter, 10) : undefined;
}
}
function blockedWithRayId(rayId) {
return `Request blocked, contact haveibeenpwned.com if this continues (Ray ID: ${rayId})`;
}
/**
* Fetches data from the supplied API endpoint.
*
* HTTP status code 200 returns an Object (data found).
* HTTP status code 404 returns null (no data found).
* HTTP status code 400 throws an Error (bad request).
* HTTP status code 401 throws an Error (unauthorized).
* HTTP status code 403 throws an Error (forbidden).
* HTTP status code 429 throws an Error (too many requests).
*
* @internal
* @private
* @param {string} endpoint the API endpoint 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 {number} [options.timeoutMs] timeout for the request in milliseconds
* (default: none)
* @param {AbortSignal} [options.signal] an AbortSignal to cancel the request (default: none)
* @param {string} [options.userAgent] a custom string to send as the User-Agent
* field in the request headers (default: `hibp <version>`)
* @returns {Promise<ApiData>} a Promise which resolves to the data resulting
* from the query (or null for 404 Not Found responses), or rejects with an
* Error
*/
export async function fetchFromApi(endpoint, options = {}) {
const { apiKey, baseUrl = 'https://haveibeenpwned.com/api/v3', timeoutMs, signal, userAgent, } = options;
const headers = {};
if (apiKey)
headers['HIBP-API-Key'] = apiKey;
const response = await baseFetch({
baseUrl,
endpoint,
headers,
timeoutMs,
signal,
userAgent,
});
if (response.ok)
return response.json();
switch (response.status) {
case BAD_REQUEST.status: {
throw new Error(BAD_REQUEST.statusText);
}
case UNAUTHORIZED.status: {
const message = await response.text();
throw new Error(message);
}
case FORBIDDEN.status: {
const rayId = response.headers.get('cf-ray');
if (rayId)
throw new Error(blockedWithRayId(rayId));
throw new Error(FORBIDDEN.statusText);
}
case NOT_FOUND.status: {
return null;
}
case TOO_MANY_REQUESTS.status: {
const body = (await response.json());
const retryAfter = response.headers.get('retry-after');
throw new RateLimitError(retryAfter, body.message);
}
default: {
throw new Error(response.statusText);
}
}
}
//# sourceMappingURL=fetch-from-api.js.map