import { HTTPError } from '../errors/HTTPError.js'; import { TimeoutError } from '../errors/TimeoutError.js'; import { mergeHeaders, mergeHooks } from '../utils/merge.js'; import { normalizeRequestMethod, normalizeRetryOptions } from '../utils/normalize.js'; import timeout from '../utils/timeout.js'; import delay from '../utils/delay.js'; import { findUnknownOptions } from '../utils/options.js'; import { maxSafeTimeout, responseTypes, stop, supportsAbortController, supportsFormData, supportsResponseStreams, supportsRequestStreams, } from './constants.js'; export class Ky { static create(input, options) { const ky = new Ky(input, options); const function_ = async () => { if (typeof ky._options.timeout === 'number' && ky._options.timeout > maxSafeTimeout) { throw new RangeError(`The \`timeout\` option cannot be greater than ${maxSafeTimeout}`); } // Delay the fetch so that body method shortcuts can set the Accept header await Promise.resolve(); let response = await ky._fetch(); for (const hook of ky._options.hooks.afterResponse) { // eslint-disable-next-line no-await-in-loop const modifiedResponse = await hook(ky.request, ky._options, ky._decorateResponse(response.clone())); if (modifiedResponse instanceof globalThis.Response) { response = modifiedResponse; } } ky._decorateResponse(response); if (!response.ok && ky._options.throwHttpErrors) { let error = new HTTPError(response, ky.request, ky._options); for (const hook of ky._options.hooks.beforeError) { // eslint-disable-next-line no-await-in-loop error = await hook(error); } throw error; } // If `onDownloadProgress` is passed, it uses the stream API internally /* istanbul ignore next */ if (ky._options.onDownloadProgress) { if (typeof ky._options.onDownloadProgress !== 'function') { throw new TypeError('The `onDownloadProgress` option must be a function'); } if (!supportsResponseStreams) { throw new Error('Streams are not supported in your environment. `ReadableStream` is missing.'); } return ky._stream(response.clone(), ky._options.onDownloadProgress); } return response; }; const isRetriableMethod = ky._options.retry.methods.includes(ky.request.method.toLowerCase()); const result = (isRetriableMethod ? ky._retry(function_) : function_()); for (const [type, mimeType] of Object.entries(responseTypes)) { result[type] = async () => { // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing ky.request.headers.set('accept', ky.request.headers.get('accept') || mimeType); const awaitedResult = await result; const response = awaitedResult.clone(); if (type === 'json') { if (response.status === 204) { return ''; } const arrayBuffer = await response.clone().arrayBuffer(); const responseSize = arrayBuffer.byteLength; if (responseSize === 0) { return ''; } if (options.parseJson) { return options.parseJson(await response.text()); } } return response[type](); }; } return result; } request; abortController; _retryCount = 0; _input; _options; // eslint-disable-next-line complexity constructor(input, options = {}) { this._input = input; this._options = { ...options, headers: mergeHeaders(this._input.headers, options.headers), hooks: mergeHooks({ beforeRequest: [], beforeRetry: [], beforeError: [], afterResponse: [], }, options.hooks), method: normalizeRequestMethod(options.method ?? this._input.method), // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing prefixUrl: String(options.prefixUrl || ''), retry: normalizeRetryOptions(options.retry), throwHttpErrors: options.throwHttpErrors !== false, timeout: options.timeout ?? 10_000, fetch: options.fetch ?? globalThis.fetch.bind(globalThis), }; if (typeof this._input !== 'string' && !(this._input instanceof URL || this._input instanceof globalThis.Request)) { throw new TypeError('`input` must be a string, URL, or Request'); } if (this._options.prefixUrl && typeof this._input === 'string') { if (this._input.startsWith('/')) { throw new Error('`input` must not begin with a slash when using `prefixUrl`'); } if (!this._options.prefixUrl.endsWith('/')) { this._options.prefixUrl += '/'; } this._input = this._options.prefixUrl + this._input; } if (supportsAbortController) { this.abortController = new globalThis.AbortController(); const originalSignal = this._options.signal ?? this._input.signal; originalSignal?.addEventListener('abort', () => { this.abortController.abort(originalSignal.reason); }); this._options.signal = this.abortController.signal; } if (supportsRequestStreams) { // @ts-expect-error - Types are outdated. this._options.duplex = 'half'; } if (this._options.json !== undefined) { this._options.body = this._options.stringifyJson?.(this._options.json) ?? JSON.stringify(this._options.json); this._options.headers.set('content-type', this._options.headers.get('content-type') ?? 'application/json'); } this.request = new globalThis.Request(this._input, this._options); if (this._options.searchParams) { // eslint-disable-next-line unicorn/prevent-abbreviations const textSearchParams = typeof this._options.searchParams === 'string' ? this._options.searchParams.replace(/^\?/, '') : new URLSearchParams(this._options.searchParams).toString(); // eslint-disable-next-line unicorn/prevent-abbreviations const searchParams = '?' + textSearchParams; const url = this.request.url.replace(/(?:\?.*?)?(?=#|$)/, searchParams); // To provide correct form boundary, Content-Type header should be deleted each time when new Request instantiated from another one if (((supportsFormData && this._options.body instanceof globalThis.FormData) || this._options.body instanceof URLSearchParams) && !(this._options.headers && this._options.headers['content-type'])) { this.request.headers.delete('content-type'); } // The spread of `this.request` is required as otherwise it misses the `duplex` option for some reason and throws. this.request = new globalThis.Request(new globalThis.Request(url, { ...this.request }), this._options); } } _calculateRetryDelay(error) { this._retryCount++; if (this._retryCount > this._options.retry.limit || error instanceof TimeoutError) { throw error; } if (error instanceof HTTPError) { if (!this._options.retry.statusCodes.includes(error.response.status)) { throw error; } const retryAfter = error.response.headers.get('Retry-After') ?? error.response.headers.get('RateLimit-Reset') ?? error.response.headers.get('X-RateLimit-Reset') // GitHub ?? error.response.headers.get('X-Rate-Limit-Reset'); // Twitter if (retryAfter && this._options.retry.afterStatusCodes.includes(error.response.status)) { let after = Number(retryAfter) * 1000; if (Number.isNaN(after)) { after = Date.parse(retryAfter) - Date.now(); } else if (after >= Date.parse('2024-01-01')) { // A large number is treated as a timestamp (fixed threshold protects against clock skew) after -= Date.now(); } const max = this._options.retry.maxRetryAfter ?? after; return after < max ? after : max; } if (error.response.status === 413) { throw error; } } const retryDelay = this._options.retry.delay(this._retryCount); return Math.min(this._options.retry.backoffLimit, retryDelay); } _decorateResponse(response) { if (this._options.parseJson) { response.json = async () => this._options.parseJson(await response.text()); } return response; } async _retry(function_) { try { return await function_(); } catch (error) { const ms = Math.min(this._calculateRetryDelay(error), maxSafeTimeout); if (this._retryCount < 1) { throw error; } await delay(ms, { signal: this._options.signal }); for (const hook of this._options.hooks.beforeRetry) { // eslint-disable-next-line no-await-in-loop const hookResult = await hook({ request: this.request, options: this._options, error: error, retryCount: this._retryCount, }); // If `stop` is returned from the hook, the retry process is stopped if (hookResult === stop) { return; } } return this._retry(function_); } } async _fetch() { for (const hook of this._options.hooks.beforeRequest) { // eslint-disable-next-line no-await-in-loop const result = await hook(this.request, this._options); if (result instanceof Request) { this.request = result; break; } if (result instanceof Response) { return result; } } const nonRequestOptions = findUnknownOptions(this.request, this._options); // Cloning is done here to prepare in advance for retries const mainRequest = this.request; this.request = mainRequest.clone(); if (this._options.timeout === false) { return this._options.fetch(mainRequest, nonRequestOptions); } return timeout(mainRequest, nonRequestOptions, this.abortController, this._options); } /* istanbul ignore next */ _stream(response, onDownloadProgress) { const totalBytes = Number(response.headers.get('content-length')) || 0; let transferredBytes = 0; if (response.status === 204) { if (onDownloadProgress) { onDownloadProgress({ percent: 1, totalBytes, transferredBytes }, new Uint8Array()); } return new globalThis.Response(null, { status: response.status, statusText: response.statusText, headers: response.headers, }); } return new globalThis.Response(new globalThis.ReadableStream({ async start(controller) { const reader = response.body.getReader(); if (onDownloadProgress) { onDownloadProgress({ percent: 0, transferredBytes: 0, totalBytes }, new Uint8Array()); } async function read() { const { done, value } = await reader.read(); if (done) { controller.close(); return; } if (onDownloadProgress) { transferredBytes += value.byteLength; const percent = totalBytes === 0 ? 0 : transferredBytes / totalBytes; onDownloadProgress({ percent, transferredBytes, totalBytes }, value); } controller.enqueue(value); await read(); } await read(); }, }), { status: response.status, statusText: response.statusText, headers: response.headers, }); } } //# sourceMappingURL=Ky.js.map