@internetarchive/fetch-handler 1.0.1 → 1.1.0-webdev-7731.2

package/.github/workflows/ci.yml

@@ -12,9 +12,14 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
     - uses: actions/setup-node@v4
       with:
         node-version: latest
+  
+    - name: Clean install (remove lockfile and node_modules)
+      run: |
+        rm -rf node_modules package-lock.json
 
     - name: Install dependencies
       run: npm install

package/.github/workflows/gh-pages-main.yml

@@ -18,10 +18,14 @@ jobs:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
+
       - uses: actions/setup-node@v4
         with:
           node-version: latest
 
+      - name: Clean install (remove lockfile and node_modules)
+        run: |
+          rm -rf node_modules package-lock.json
 
       - name: Install dependencies
         run: npm install

package/.github/workflows/pr-preview.yml

@@ -22,10 +22,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - uses: actions/setup-node@v4
         with:
           node-version: latest
 
+      - name: Clean install (remove lockfile and node_modules)
+        run: |
+          rm -rf node_modules package-lock.json
 
       - name: Install and Build
         run: |

package/README.md

@@ -1,23 +1,23 @@
-![Build Status](https://github.com/internetarchive/iaux-fetch-handler-service/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-fetch-handler-service/graph/badge.svg?token=ZOYRJ2BV9W)](https://codecov.io/gh/internetarchive/iaux-fetch-handler-service)
+![Build Status](https://github.com/internetarchive/iaux-fetch-handler/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-fetch-handler/graph/badge.svg?token=ZOYRJ2BV9W)](https://codecov.io/gh/internetarchive/iaux-fetch-handler)
 
 
-# Internet Archive Fetch Handler Service
+# Internet Archive Fetch Handler library
 
 
-A custom service for handling API requests.
+A custom library for handling API requests.
 
 
 ## Installation
 
 ```bash
-npm install @internetarchive/fetch-handler-service
+npm install @internetarchive/fetch-handler
 ```
 
 
 ## Sample Usage
 
 ```ts
-import { IaFetchHandler } from '../src/ia-fetch-handler';
+import { IaFetchHandler } from '@internetarchive/fetch-handler';
 
 @property({ type: Object }) data: any = null;
 @property({ type: String }) error: string = '';

package/demo/app-root.ts

@@ -1,7 +1,7 @@
 import { html, LitElement, css } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
 
-import { IaFetchHandler } from '../src/ia-fetch-handler';
+import { IaFetchHandler } from '../src/fetch-handler';
 
 @customElement('app-root')
 export class AppRoot extends LitElement {

package/dist/demo/app-root.d.ts

@@ -7,6 +7,6 @@ export declare class AppRoot extends LitElement {
     constructor();
     connectedCallback(): void;
     fetchData(): Promise<void>;
-    render(): import("lit").TemplateResult<1>;
+    render(): import("lit-html").TemplateResult<1>;
     static styles: import("lit").CSSResult;
 }

package/dist/demo/app-root.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { html, LitElement, css } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
-import { IaFetchHandler } from '../src/ia-fetch-handler';
+import { IaFetchHandler } from '../src/fetch-handler';
 let AppRoot = class AppRoot extends LitElement {
     constructor() {
         super();

package/dist/demo/app-root.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-root.js","sourceRoot":"","sources":["../../demo/app-root.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGlD,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,UAAU;IAOrC;QACE,KAAK,EAAE,CAAC;QAPkB,SAAI,GAAQ,IAAI,CAAC;QACjB,UAAK,GAAW,EAAE,CAAC;QAClB,YAAO,GAAY,KAAK,CAAC;QAMpD,IAAI,CAAC,YAAY,GAAG,IAAI,cAAc,CAAC;YACrC,YAAY,EAAE,qBAAqB;SACpC,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB;QACf,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,SAAS;QACb,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,MAAM,GACV,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;YAChE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,GAAG,wBAAwB,KAAK,EAAE,CAAC;QAC/C,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAA;;;UAGL,IAAI,CAAC,OAAO;YACZ,CAAC,CAAC,IAAI,CAAA,mBAAmB;YACzB,CAAC,CAAC,IAAI,CAAC,KAAK;gBACV,CAAC,CAAC,IAAI,CAAA,oBAAoB,IAAI,CAAC,KAAK,MAAM;gBAC1C,CAAC,CAAC,IAAI,CAAC,IAAI;oBACT,CAAC,CAAC,IAAI,CAAA,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ;oBACxD,CAAC,CAAC,IAAI,CAAA,2BAA2B;0BACrB,IAAI,CAAC,SAAS;;KAEnC,CAAC;IACJ,CAAC;;AAEM,cAAM,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BlB,AA3BY,CA2BX;AA3E0B;IAA3B,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;qCAAkB;AACjB;IAA3B,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;sCAAoB;AAClB;IAA5B,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;wCAA0B;AAH3C,OAAO;IADnB,aAAa,CAAC,UAAU,CAAC;GACb,OAAO,CA6EnB","sourcesContent":["import { html, LitElement, css } from 'lit';\nimport { customElement, property } from 'lit/decorators.js';\n\nimport { IaFetchHandler } from '../src/ia-fetch-handler';\n\n@customElement('app-root')\nexport class AppRoot extends LitElement {\n  @property({ type: Object }) data: any = null;\n  @property({ type: String }) error: string = '';\n  @property({ type: Boolean }) loading: boolean = false;\n\n  private fetchHandler: IaFetchHandler;\n\n  constructor() {\n    super();\n    this.fetchHandler = new IaFetchHandler({\n      iaApiBaseUrl: 'https://archive.org',\n    });\n  }\n\n  connectedCallback() {\n    super.connectedCallback();\n    this.fetchData();\n  }\n\n  async fetchData() {\n    this.loading = true;\n    this.error = '';\n    try {\n      const result =\n        await this.fetchHandler.fetchIAApiResponse('/metadata/goody');\n      this.data = result;\n    } catch (error) {\n      this.error = `Error fetching data: ${error}`;\n    } finally {\n      this.loading = false;\n    }\n  }\n\n  render() {\n    return html`\n      <div class=\"container\">\n        <h1>Fetch Data</h1>\n        ${this.loading\n          ? html`<p>Loading...</p>`\n          : this.error\n            ? html`<p class=\"error\">${this.error}</p>`\n            : this.data\n              ? html`<pre>${JSON.stringify(this.data, null, 2)}</pre>`\n              : html`<p>No data available.</p>`}\n        <button @click=\"${this.fetchData}\">Retry</button>\n      </div>\n    `;\n  }\n\n  static styles = css`\n    .container {\n      padding: 20px;\n      font-family: Arial, sans-serif;\n    }\n\n    h1 {\n      color: #333;\n    }\n\n    .error {\n      color: red;\n    }\n\n    button {\n      margin-top: 20px;\n      padding: 10px 20px;\n      background-color: #007bff;\n      color: white;\n      border: none;\n      cursor: pointer;\n      border-radius: 5px;\n    }\n\n    button:hover {\n      background-color: #0056b3;\n    }\n  `;\n}\n"]}
+{"version":3,"file":"app-root.js","sourceRoot":"","sources":["../../demo/app-root.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAG/C,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,UAAU;IAOrC;QACE,KAAK,EAAE,CAAC;QAPkB,SAAI,GAAQ,IAAI,CAAC;QACjB,UAAK,GAAW,EAAE,CAAC;QAClB,YAAO,GAAY,KAAK,CAAC;QAMpD,IAAI,CAAC,YAAY,GAAG,IAAI,cAAc,CAAC;YACrC,YAAY,EAAE,qBAAqB;SACpC,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB;QACf,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,SAAS;QACb,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,MAAM,GACV,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;YAChE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,GAAG,wBAAwB,KAAK,EAAE,CAAC;QAC/C,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAA;;;UAGL,IAAI,CAAC,OAAO;YACZ,CAAC,CAAC,IAAI,CAAA,mBAAmB;YACzB,CAAC,CAAC,IAAI,CAAC,KAAK;gBACV,CAAC,CAAC,IAAI,CAAA,oBAAoB,IAAI,CAAC,KAAK,MAAM;gBAC1C,CAAC,CAAC,IAAI,CAAC,IAAI;oBACT,CAAC,CAAC,IAAI,CAAA,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ;oBACxD,CAAC,CAAC,IAAI,CAAA,2BAA2B;0BACrB,IAAI,CAAC,SAAS;;KAEnC,CAAC;IACJ,CAAC;;AAEM,cAAM,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BlB,AA3BY,CA2BX;AA3E0B;IAA3B,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;qCAAkB;AACjB;IAA3B,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;sCAAoB;AAClB;IAA5B,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;wCAA0B;AAH3C,OAAO;IADnB,aAAa,CAAC,UAAU,CAAC;GACb,OAAO,CA6EnB","sourcesContent":["import { html, LitElement, css } from 'lit';\nimport { customElement, property } from 'lit/decorators.js';\n\nimport { IaFetchHandler } from '../src/fetch-handler';\n\n@customElement('app-root')\nexport class AppRoot extends LitElement {\n  @property({ type: Object }) data: any = null;\n  @property({ type: String }) error: string = '';\n  @property({ type: Boolean }) loading: boolean = false;\n\n  private fetchHandler: IaFetchHandler;\n\n  constructor() {\n    super();\n    this.fetchHandler = new IaFetchHandler({\n      iaApiBaseUrl: 'https://archive.org',\n    });\n  }\n\n  connectedCallback() {\n    super.connectedCallback();\n    this.fetchData();\n  }\n\n  async fetchData() {\n    this.loading = true;\n    this.error = '';\n    try {\n      const result =\n        await this.fetchHandler.fetchIAApiResponse('/metadata/goody');\n      this.data = result;\n    } catch (error) {\n      this.error = `Error fetching data: ${error}`;\n    } finally {\n      this.loading = false;\n    }\n  }\n\n  render() {\n    return html`\n      <div class=\"container\">\n        <h1>Fetch Data</h1>\n        ${this.loading\n          ? html`<p>Loading...</p>`\n          : this.error\n            ? html`<p class=\"error\">${this.error}</p>`\n            : this.data\n              ? html`<pre>${JSON.stringify(this.data, null, 2)}</pre>`\n              : html`<p>No data available.</p>`}\n        <button @click=\"${this.fetchData}\">Retry</button>\n      </div>\n    `;\n  }\n\n  static styles = css`\n    .container {\n      padding: 20px;\n      font-family: Arial, sans-serif;\n    }\n\n    h1 {\n      color: #333;\n    }\n\n    .error {\n      color: red;\n    }\n\n    button {\n      margin-top: 20px;\n      padding: 10px 20px;\n      background-color: #007bff;\n      color: white;\n      border: none;\n      cursor: pointer;\n      border-radius: 5px;\n    }\n\n    button:hover {\n      background-color: #0056b3;\n    }\n  `;\n}\n"]}

package/dist/index.d.ts

@@ -1,2 +1,7 @@
-export { IaFetchHandler } from './src/ia-fetch-handler';
+export { IaFetchHandler } from './src/fetch-handler';
 export { FetchHandlerInterface } from './src/fetch-handler-interface';
+export { FetchRetrier, FetchRetrierInterface, } from './src/fetch-retry/fetch-retrier';
+export { DefaultRetryConfiguration } from './src/fetch-retry/configuration/default-retry-configuration';
+export { NoRetryConfiguration } from './src/fetch-retry/configuration/no-retry-configuration';
+export type { RetryConfiguring } from './src/fetch-retry/configuration/retry-configuring';
+export type { FetchOptions } from './src/fetch-options';

package/dist/index.js

@@ -1,2 +1,5 @@
-export { IaFetchHandler } from './src/ia-fetch-handler';
+export { IaFetchHandler } from './src/fetch-handler';
+export { FetchRetrier, } from './src/fetch-retry/fetch-retrier';
+export { DefaultRetryConfiguration } from './src/fetch-retry/configuration/default-retry-configuration';
+export { NoRetryConfiguration } from './src/fetch-retry/configuration/no-retry-configuration';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC","sourcesContent":["export { IaFetchHandler } from './src/ia-fetch-handler';\nexport { FetchHandlerInterface } from './src/fetch-handler-interface';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EACL,YAAY,GAEb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6DAA6D,CAAC;AACxG,OAAO,EAAE,oBAAoB,EAAE,MAAM,wDAAwD,CAAC","sourcesContent":["export { IaFetchHandler } from './src/fetch-handler';\nexport { FetchHandlerInterface } from './src/fetch-handler-interface';\nexport {\n  FetchRetrier,\n  FetchRetrierInterface,\n} from './src/fetch-retry/fetch-retrier';\nexport { DefaultRetryConfiguration } from './src/fetch-retry/configuration/default-retry-configuration';\nexport { NoRetryConfiguration } from './src/fetch-retry/configuration/no-retry-configuration';\nexport type { RetryConfiguring } from './src/fetch-retry/configuration/retry-configuring';\nexport type { FetchOptions } from './src/fetch-options';\n"]}

package/dist/src/fetch-handler-interface.d.ts

@@ -1,11 +1,13 @@
+import type { FetchOptions } from './fetch-options';
+import type { RetryConfiguring } from './fetch-retry/configuration/retry-configuring';
 export interface FetchHandlerInterface {
     /**
      * Generic fetch function that handles retries and common IA parameters like `reCache=1`
      *
      * @param input RequestInfo
-     * @param init RequestInit
+     * @param options RequestInit | FetchOptions
      */
-    fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+    fetch(request: RequestInfo, options?: RequestInit | FetchOptions): Promise<Response>;
     /**
      * A helper function to fetch a response from an API and get a JSON object
      *
@@ -17,6 +19,7 @@ export interface FetchHandlerInterface {
         method?: string;
         body?: BodyInit;
         headers?: HeadersInit;
+        retryConfig?: RetryConfiguring;
     }): Promise<T>;
     /**
      * A helper function to fetch a response from the IA API and get a JSON object
@@ -25,9 +28,19 @@ export interface FetchHandlerInterface {
      * of the full URL. If you need a full URL, use `fetchApiResponse` instead.
      *
      * @param path string
-     * @param options?: { includeCredentials?: boolean }
+     * @param options?: {
+     *     includeCredentials?: boolean;
+     *     method?: string;
+     *     body?: BodyInit;
+     *     headers?: HeadersInit;
+     *     retryConfig?: RetryConfiguring;
+     *   }
      */
     fetchIAApiResponse<T>(path: string, options?: {
         includeCredentials?: boolean;
+        method?: string;
+        body?: BodyInit;
+        headers?: HeadersInit;
+        retryConfig?: RetryConfiguring;
     }): Promise<T>;
 }

package/dist/src/fetch-handler-interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetch-handler-interface.js","sourceRoot":"","sources":["../../src/fetch-handler-interface.ts"],"names":[],"mappings":"","sourcesContent":["export interface FetchHandlerInterface {\n  /**\n   * Generic fetch function that handles retries and common IA parameters like `reCache=1`\n   *\n   * @param input RequestInfo\n   * @param init RequestInit\n   */\n  fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;\n\n  /**\n   * A helper function to fetch a response from an API and get a JSON object\n   *\n   * @param path string\n   * @param options?: { includeCredentials?: boolean }\n   */\n  fetchApiResponse<T>(\n    url: string,\n    options?: {\n      includeCredentials?: boolean;\n      method?: string;\n      body?: BodyInit;\n      headers?: HeadersInit;\n    },\n  ): Promise<T>;\n\n  /**\n   * A helper function to fetch a response from the IA API and get a JSON object\n   *\n   * This allows you to just pass the path to the API and get the response instead\n   * of the full URL. If you need a full URL, use `fetchApiResponse` instead.\n   *\n   * @param path string\n   * @param options?: { includeCredentials?: boolean }\n   */\n  fetchIAApiResponse<T>(\n    path: string,\n    options?: { includeCredentials?: boolean },\n  ): Promise<T>;\n}\n"]}
+{"version":3,"file":"fetch-handler-interface.js","sourceRoot":"","sources":["../../src/fetch-handler-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { FetchOptions } from './fetch-options';\nimport type { RetryConfiguring } from './fetch-retry/configuration/retry-configuring';\n\nexport interface FetchHandlerInterface {\n  /**\n   * Generic fetch function that handles retries and common IA parameters like `reCache=1`\n   *\n   * @param input RequestInfo\n   * @param options RequestInit | FetchOptions\n   */\n  fetch(\n    request: RequestInfo,\n    options?: RequestInit | FetchOptions,\n  ): Promise<Response>;\n\n  /**\n   * A helper function to fetch a response from an API and get a JSON object\n   *\n   * @param path string\n   * @param options?: { includeCredentials?: boolean }\n   */\n  fetchApiResponse<T>(\n    url: string,\n    options?: {\n      includeCredentials?: boolean;\n      method?: string;\n      body?: BodyInit;\n      headers?: HeadersInit;\n      retryConfig?: RetryConfiguring;\n    },\n  ): Promise<T>;\n\n  /**\n   * A helper function to fetch a response from the IA API and get a JSON object\n   *\n   * This allows you to just pass the path to the API and get the response instead\n   * of the full URL. If you need a full URL, use `fetchApiResponse` instead.\n   *\n   * @param path string\n   * @param options?: {\n   *     includeCredentials?: boolean;\n   *     method?: string;\n   *     body?: BodyInit;\n   *     headers?: HeadersInit;\n   *     retryConfig?: RetryConfiguring;\n   *   }\n   */\n  fetchIAApiResponse<T>(\n    path: string,\n    options?: {\n      includeCredentials?: boolean;\n      method?: string;\n      body?: BodyInit;\n      headers?: HeadersInit;\n      retryConfig?: RetryConfiguring;\n    },\n  ): Promise<T>;\n}\n"]}

package/dist/src/{ia-fetch-handler.d.ts → fetch-handler.d.ts}

@@ -1,5 +1,7 @@
-import { FetchRetrierInterface } from './utils/fetch-retrier';
+import { FetchRetrierInterface } from './fetch-retry/fetch-retrier';
 import type { FetchHandlerInterface } from './fetch-handler-interface';
+import type { FetchOptions } from './fetch-options';
+import type { RetryConfiguring } from './fetch-retry/configuration/retry-configuring';
 /**
  * The FetchHandler adds some common helpers:
  * - retry the request if it fails
@@ -14,10 +16,15 @@ export declare class IaFetchHandler implements FetchHandlerInterface {
         iaApiBaseUrl?: string;
         fetchRetrier?: FetchRetrierInterface;
         searchParams?: string;
+        defaultRetryConfiguration?: RetryConfiguring;
     });
     /** @inheritdoc */
     fetchIAApiResponse<T>(path: string, options?: {
         includeCredentials?: boolean;
+        method?: string;
+        body?: BodyInit;
+        headers?: HeadersInit;
+        retryConfig?: RetryConfiguring;
     }): Promise<T>;
     /** @inheritdoc */
     fetchApiResponse<T>(url: string, options?: {
@@ -25,9 +32,10 @@ export declare class IaFetchHandler implements FetchHandlerInterface {
         method?: string;
         body?: BodyInit;
         headers?: HeadersInit;
+        retryConfig?: RetryConfiguring;
     }): Promise<T>;
     /** @inheritdoc */
-    fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+    fetch(request: RequestInfo, options?: RequestInit | FetchOptions): Promise<Response>;
     /**
      * Since RequestInfo can be either a `Request` or `string`, we need to change
      * the way we add search params to it depending on the input.

package/dist/src/{ia-fetch-handler.js → fetch-handler.js}

@@ -1,4 +1,4 @@
-import { FetchRetrier } from './utils/fetch-retrier';
+import { FetchRetrier, } from './fetch-retry/fetch-retrier';
 /**
  * The FetchHandler adds some common helpers:
  * - retry the request if it fails
@@ -35,36 +35,33 @@ export class IaFetchHandler {
             requestInit.body = options.body;
         if (options === null || options === void 0 ? void 0 : options.headers)
             requestInit.headers = options.headers;
-        const response = await this.fetch(url, requestInit);
+        const response = await this.fetch(url, {
+            requestInit: requestInit,
+            retryConfig: options === null || options === void 0 ? void 0 : options.retryConfig,
+        });
         const json = await response.json();
         return json;
     }
     /** @inheritdoc */
-    async fetch(input, init) {
-        let finalInput = input;
+    async fetch(request, options) {
+        let finalRequest = request;
         const urlParams = new URLSearchParams(this.searchParams);
         if (urlParams.get('reCache') === '1') {
-            finalInput = this.addSearchParams(input, { reCache: '1' });
+            const urlString = typeof request === 'string' ? request : request.url;
+            finalRequest = this.addSearchParams(urlString, { reCache: '1' });
         }
-        return this.fetchRetrier.fetchRetry(finalInput, init);
+        return this.fetchRetrier.fetchRetry(finalRequest, options);
     }
     /**
      * Since RequestInfo can be either a `Request` or `string`, we need to change
      * the way we add search params to it depending on the input.
      */
-    addSearchParams(input, params) {
-        const urlString = typeof input === 'string' ? input : input.url;
+    addSearchParams(urlString, params) {
         const url = new URL(urlString, window.location.href);
         for (const [key, value] of Object.entries(params)) {
             url.searchParams.set(key, value);
         }
-        if (typeof input === 'string') {
-            return url.href;
-        }
-        else {
-            const newRequest = new Request(url.href, input);
-            return newRequest;
-        }
+        return url.href;
     }
 }
-//# sourceMappingURL=ia-fetch-handler.js.map
+//# sourceMappingURL=fetch-handler.js.map

package/dist/src/fetch-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-handler.js","sourceRoot":"","sources":["../../src/fetch-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,GAEb,MAAM,6BAA6B,CAAC;AAKrC;;;;;GAKG;AACH,MAAM,OAAO,cAAc;IAOzB,YAAY,OAKX;QATO,iBAAY,GAA0B,IAAI,YAAY,EAAE,CAAC;QAU/D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACpE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACpE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,EAAE,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,kBAAkB,CACtB,IAAY,EACZ,OAMC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,gBAAgB,CACpB,GAAW,EACX,OAMC;QAED,MAAM,WAAW,GAAgB,EAAE,CAAC;QACpC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB;YAAE,WAAW,CAAC,WAAW,GAAG,SAAS,CAAC;QACrE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YAAE,WAAW,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACzD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI;YAAE,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACnD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;YAAE,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YACrC,WAAW,EAAE,WAAW;YACxB,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;SAClC,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,IAAS,CAAC;IACnB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,KAAK,CACT,OAAoB,EACpB,OAAoC;QAEpC,IAAI,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtE,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACK,eAAe,CACrB,SAAiB,EACjB,MAA8B;QAE9B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAErD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;CACF","sourcesContent":["import {\n  FetchRetrier,\n  FetchRetrierInterface,\n} from './fetch-retry/fetch-retrier';\nimport type { FetchHandlerInterface } from './fetch-handler-interface';\nimport type { FetchOptions } from './fetch-options';\nimport type { RetryConfiguring } from './fetch-retry/configuration/retry-configuring';\n\n/**\n * The FetchHandler adds some common helpers:\n * - retry the request if it fails\n * - add `reCache=1` to the request if it's in the current url so the backend sees it\n * - add convenience method for fetching/decoding an API response by just the path\n */\nexport class IaFetchHandler implements FetchHandlerInterface {\n  private iaApiBaseUrl?: string;\n\n  private fetchRetrier: FetchRetrierInterface = new FetchRetrier();\n\n  private searchParams?: string;\n\n  constructor(options?: {\n    iaApiBaseUrl?: string;\n    fetchRetrier?: FetchRetrierInterface;\n    searchParams?: string;\n    defaultRetryConfiguration?: RetryConfiguring;\n  }) {\n    if (options?.iaApiBaseUrl) this.iaApiBaseUrl = options.iaApiBaseUrl;\n    if (options?.fetchRetrier) this.fetchRetrier = options.fetchRetrier;\n    if (options?.searchParams) {\n      this.searchParams = options.searchParams;\n    } else {\n      this.searchParams = window.location.search;\n    }\n  }\n\n  /** @inheritdoc */\n  async fetchIAApiResponse<T>(\n    path: string,\n    options?: {\n      includeCredentials?: boolean;\n      method?: string;\n      body?: BodyInit;\n      headers?: HeadersInit;\n      retryConfig?: RetryConfiguring;\n    },\n  ): Promise<T> {\n    const url = `${this.iaApiBaseUrl}${path}`;\n    return this.fetchApiResponse(url, options);\n  }\n\n  /** @inheritdoc */\n  async fetchApiResponse<T>(\n    url: string,\n    options?: {\n      includeCredentials?: boolean;\n      method?: string;\n      body?: BodyInit;\n      headers?: HeadersInit;\n      retryConfig?: RetryConfiguring;\n    },\n  ): Promise<T> {\n    const requestInit: RequestInit = {};\n    if (options?.includeCredentials) requestInit.credentials = 'include';\n    if (options?.method) requestInit.method = options.method;\n    if (options?.body) requestInit.body = options.body;\n    if (options?.headers) requestInit.headers = options.headers;\n    const response = await this.fetch(url, {\n      requestInit: requestInit,\n      retryConfig: options?.retryConfig,\n    });\n    const json = await response.json();\n    return json as T;\n  }\n\n  /** @inheritdoc */\n  async fetch(\n    request: RequestInfo,\n    options?: RequestInit | FetchOptions,\n  ): Promise<Response> {\n    let finalRequest = request;\n    const urlParams = new URLSearchParams(this.searchParams);\n    if (urlParams.get('reCache') === '1') {\n      const urlString = typeof request === 'string' ? request : request.url;\n      finalRequest = this.addSearchParams(urlString, { reCache: '1' });\n    }\n    return this.fetchRetrier.fetchRetry(finalRequest, options);\n  }\n\n  /**\n   * Since RequestInfo can be either a `Request` or `string`, we need to change\n   * the way we add search params to it depending on the input.\n   */\n  private addSearchParams(\n    urlString: string,\n    params: Record<string, string>,\n  ): string {\n    const url = new URL(urlString, window.location.href);\n\n    for (const [key, value] of Object.entries(params)) {\n      url.searchParams.set(key, value);\n    }\n\n    return url.href;\n  }\n}\n"]}

package/dist/src/fetch-options.d.ts

@@ -0,0 +1,5 @@
+import type { RetryConfiguring } from './fetch-retry/configuration/retry-configuring';
+export type FetchOptions = {
+    requestInit?: RequestInit;
+    retryConfig?: RetryConfiguring;
+};

package/dist/src/fetch-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fetch-options.js.map

package/dist/src/fetch-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-options.js","sourceRoot":"","sources":["../../src/fetch-options.ts"],"names":[],"mappings":"","sourcesContent":["import type { RetryConfiguring } from './fetch-retry/configuration/retry-configuring';\n\nexport type FetchOptions = {\n  requestInit?: RequestInit;\n  retryConfig?: RetryConfiguring;\n};\n"]}

package/dist/src/fetch-retry/configuration/default-retry-configuration.d.ts

@@ -0,0 +1,10 @@
+import type { RetryConfiguring } from './retry-configuring';
+import type { Milliseconds } from './milliseconds';
+export declare class DefaultRetryConfiguration implements RetryConfiguring {
+    private readonly maxRetries;
+    constructor(options?: {
+        maxRetries?: number;
+    });
+    shouldRetry(response: Response | null, retryNumber: number): boolean;
+    retryDelay(retryNumber: number): Milliseconds;
+}

package/dist/src/fetch-retry/configuration/default-retry-configuration.js

@@ -0,0 +1,20 @@
+export class DefaultRetryConfiguration {
+    constructor(options) {
+        this.maxRetries = 2;
+        if ((options === null || options === void 0 ? void 0 : options.maxRetries) !== undefined) {
+            this.maxRetries = options.maxRetries;
+        }
+    }
+    shouldRetry(response, retryNumber) {
+        if (response === null)
+            return false;
+        if (retryNumber > this.maxRetries)
+            return false;
+        return response.status >= 500 && response.status < 600;
+    }
+    retryDelay(retryNumber) {
+        // Exponential backoff up to 10 seconds
+        return Math.min(500 * 2 ** retryNumber, 10000);
+    }
+}
+//# sourceMappingURL=default-retry-configuration.js.map

package/dist/src/fetch-retry/configuration/default-retry-configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-retry-configuration.js","sourceRoot":"","sources":["../../../../src/fetch-retry/configuration/default-retry-configuration.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,yBAAyB;IAGpC,YAAY,OAAiC;QAF5B,eAAU,GAAqB,CAAC,CAAC;QAGhD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,MAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,CAAC;IACH,CAAC;IAED,WAAW,CAAC,QAAyB,EAAE,WAAmB;QACxD,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QACpC,IAAI,WAAW,GAAG,IAAI,CAAC,UAAU;YAAE,OAAO,KAAK,CAAC;QAChD,OAAO,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC;IACzD,CAAC;IAED,UAAU,CAAC,WAAmB;QAC5B,uCAAuC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,IAAI,WAAW,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;CACF","sourcesContent":["import type { RetryConfiguring } from './retry-configuring';\nimport type { Milliseconds } from './milliseconds';\n\nexport class DefaultRetryConfiguration implements RetryConfiguring {\n  private readonly maxRetries: Readonly<number> = 2;\n\n  constructor(options?: { maxRetries?: number }) {\n    if (options?.maxRetries !== undefined) {\n      this.maxRetries = options.maxRetries;\n    }\n  }\n\n  shouldRetry(response: Response | null, retryNumber: number): boolean {\n    if (response === null) return false;\n    if (retryNumber > this.maxRetries) return false;\n    return response.status >= 500 && response.status < 600;\n  }\n\n  retryDelay(retryNumber: number): Milliseconds {\n    // Exponential backoff up to 10 seconds\n    return Math.min(500 * 2 ** retryNumber, 10000);\n  }\n}\n"]}

package/dist/src/fetch-retry/configuration/milliseconds.d.ts

@@ -0,0 +1 @@
+export type Milliseconds = number;

package/dist/src/fetch-retry/configuration/milliseconds.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=milliseconds.js.map

package/dist/src/fetch-retry/configuration/milliseconds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"milliseconds.js","sourceRoot":"","sources":["../../../../src/fetch-retry/configuration/milliseconds.ts"],"names":[],"mappings":"","sourcesContent":["export type Milliseconds = number;\n"]}

package/dist/src/fetch-retry/configuration/no-retry-configuration.d.ts

@@ -0,0 +1,6 @@
+import type { RetryConfiguring } from './retry-configuring';
+import type { Milliseconds } from './milliseconds';
+export declare class NoRetryConfiguration implements RetryConfiguring {
+    shouldRetry(): boolean;
+    retryDelay(): Milliseconds;
+}

package/dist/src/fetch-retry/configuration/no-retry-configuration.js

@@ -0,0 +1,9 @@
+export class NoRetryConfiguration {
+    shouldRetry() {
+        return false;
+    }
+    retryDelay() {
+        return 0;
+    }
+}
+//# sourceMappingURL=no-retry-configuration.js.map

package/dist/src/fetch-retry/configuration/no-retry-configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-retry-configuration.js","sourceRoot":"","sources":["../../../../src/fetch-retry/configuration/no-retry-configuration.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,oBAAoB;IAC/B,WAAW;QACT,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,CAAC,CAAC;IACX,CAAC;CACF","sourcesContent":["import type { RetryConfiguring } from './retry-configuring';\nimport type { Milliseconds } from './milliseconds';\n\nexport class NoRetryConfiguration implements RetryConfiguring {\n  shouldRetry(): boolean {\n    return false;\n  }\n\n  retryDelay(): Milliseconds {\n    return 0;\n  }\n}\n"]}

package/dist/src/fetch-retry/configuration/retry-configuring.d.ts

@@ -0,0 +1,5 @@
+import type { Milliseconds } from './milliseconds';
+export interface RetryConfiguring {
+    shouldRetry(response: Response | null, retryNumber: number, error?: unknown): boolean;
+    retryDelay(retryNumber: number): Milliseconds;
+}

package/dist/src/fetch-retry/configuration/retry-configuring.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=retry-configuring.js.map

package/dist/src/fetch-retry/configuration/retry-configuring.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-configuring.js","sourceRoot":"","sources":["../../../../src/fetch-retry/configuration/retry-configuring.ts"],"names":[],"mappings":"","sourcesContent":["import type { Milliseconds } from './milliseconds';\n\nexport interface RetryConfiguring {\n  shouldRetry(\n    response: Response | null,\n    retryNumber: number,\n    error?: unknown,\n  ): boolean;\n\n  retryDelay(retryNumber: number): Milliseconds;\n}\n"]}

package/dist/src/{utils → fetch-retry}/fetch-retrier.d.ts

@@ -1,4 +1,6 @@
 import type { AnalyticsHandlerInterface } from '@internetarchive/analytics-manager';
+import { type FetchOptions } from '../fetch-options';
+import type { RetryConfiguring } from './configuration/retry-configuring';
 /**
  * A class that retries a fetch request.
  */
@@ -6,31 +8,27 @@ export interface FetchRetrierInterface {
     /**
      * Execute a fetch with retry.
      *
-     * @param requestInfo RequestInfo
-     * @param init Optional RequestInit
-     * @param retries Optional number of retries to attempt
+     * @param request RequestInfo
+     * @param options Optional RequestInit | FetchOptions
      * @returns Promise<Response>
      */
-    fetchRetry(requestInfo: RequestInfo, init?: RequestInit, retries?: number): Promise<Response>;
+    fetchRetry(request: RequestInfo, options?: RequestInit | FetchOptions): Promise<Response>;
 }
 /** @inheritdoc */
 export declare class FetchRetrier implements FetchRetrierInterface {
-    private analyticsHandler;
-    private sleep;
-    private retryCount;
-    private retryDelay;
+    private analyticsHandler?;
+    private retryConfiguration;
     constructor(options?: {
         analyticsHandler?: AnalyticsHandlerInterface;
-        retryCount?: number;
-        retryDelay?: number;
-        sleepFn?: (ms: number) => Promise<void>;
+        retryConfiguration?: RetryConfiguring;
     });
     /** @inheritdoc */
-    fetchRetry(requestInfo: RequestInfo, init?: RequestInit, retries?: number): Promise<Response>;
+    fetchRetry(request: RequestInfo, options?: RequestInit | FetchOptions): Promise<Response>;
+    private fetchRetryWithOptions;
     private isContentBlockerError;
     private readonly eventCategory;
     private logRetryEvent;
     private logFailureEvent;
-    private log404Event;
+    private log4xxResponse;
     private logContentBlockingEvent;
 }

package/dist/src/fetch-retry/fetch-retrier.js

@@ -0,0 +1,97 @@
+import { promisedSleep } from '../utils/promised-sleep';
+import { legacyArgsAsFetchOptions } from './legacy-args';
+import { DefaultRetryConfiguration } from './configuration/default-retry-configuration';
+/** @inheritdoc */
+export class FetchRetrier {
+    constructor(options) {
+        this.retryConfiguration = new DefaultRetryConfiguration();
+        this.eventCategory = 'offshootFetchRetry';
+        if (options === null || options === void 0 ? void 0 : options.analyticsHandler)
+            this.analyticsHandler = options.analyticsHandler;
+        if (options === null || options === void 0 ? void 0 : options.retryConfiguration)
+            this.retryConfiguration = options.retryConfiguration;
+    }
+    /** @inheritdoc */
+    async fetchRetry(request, options) {
+        const fetchOptions = legacyArgsAsFetchOptions(options);
+        return await this.fetchRetryWithOptions(request, 0, fetchOptions);
+    }
+    async fetchRetryWithOptions(request, retryNumber, options) {
+        var _a, _b;
+        const urlString = typeof request === 'string' ? request : request.url;
+        try {
+            const response = await fetch(request, options === null || options === void 0 ? void 0 : options.requestInit);
+            if (response.ok)
+                return response;
+            if (response.status >= 400 && response.status < 500) {
+                this.log4xxResponse(response);
+            }
+            const retryConfig = (_a = options === null || options === void 0 ? void 0 : options.retryConfig) !== null && _a !== void 0 ? _a : this.retryConfiguration;
+            if (retryConfig.shouldRetry(response, retryNumber)) {
+                const delay = retryConfig.retryDelay(retryNumber);
+                await promisedSleep(delay);
+                this.logRetryEvent(urlString, retryNumber, response.statusText, response.status);
+                return this.fetchRetryWithOptions(request, retryNumber + 1, options);
+            }
+            this.logFailureEvent(urlString, response.status);
+            return response;
+        }
+        catch (error) {
+            // if a content blocker is detected, log it and don't retry
+            if (this.isContentBlockerError(error)) {
+                this.logContentBlockingEvent(urlString, error);
+                throw error;
+            }
+            const retryConfig = (_b = options === null || options === void 0 ? void 0 : options.retryConfig) !== null && _b !== void 0 ? _b : this.retryConfiguration;
+            if (retryConfig.shouldRetry(null, retryNumber)) {
+                const delay = retryConfig.retryDelay(retryNumber);
+                await promisedSleep(delay);
+                this.logRetryEvent(urlString, retryNumber, error, error);
+                return this.fetchRetryWithOptions(request, retryNumber + 1, options);
+            }
+            this.logFailureEvent(urlString, error);
+            throw error;
+        }
+    }
+    isContentBlockerError(error) {
+        // all of the content blocker errors are `TypeError`
+        if (!(error instanceof TypeError))
+            return false;
+        const message = error.message.toLowerCase();
+        return message.includes('content blocker');
+    }
+    logRetryEvent(urlString, retryNumber, status, code) {
+        var _a;
+        (_a = this.analyticsHandler) === null || _a === void 0 ? void 0 : _a.sendEvent({
+            category: this.eventCategory,
+            action: 'retryingFetch',
+            label: `retryNumber: ${retryNumber}, code: ${code}, status: ${status}, url: ${urlString}`,
+        });
+    }
+    logFailureEvent(urlString, error) {
+        var _a;
+        (_a = this.analyticsHandler) === null || _a === void 0 ? void 0 : _a.sendEvent({
+            category: this.eventCategory,
+            action: 'fetchFailed',
+            label: `error: ${error}, url: ${urlString}`,
+        });
+    }
+    log4xxResponse(response) {
+        var _a;
+        const status = response.status;
+        (_a = this.analyticsHandler) === null || _a === void 0 ? void 0 : _a.sendEvent({
+            category: this.eventCategory,
+            action: `status4xxResponse`,
+            label: `http status ${status}, url: ${response.url}`,
+        });
+    }
+    logContentBlockingEvent(urlString, error) {
+        var _a;
+        (_a = this.analyticsHandler) === null || _a === void 0 ? void 0 : _a.sendEvent({
+            category: this.eventCategory,
+            action: 'contentBlockerDetectedNotRetrying',
+            label: `error: ${error}, url: ${urlString}`,
+        });
+    }
+}
+//# sourceMappingURL=fetch-retrier.js.map

package/dist/src/fetch-retry/fetch-retrier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-retrier.js","sourceRoot":"","sources":["../../../src/fetch-retry/fetch-retrier.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAoBxF,kBAAkB;AAClB,MAAM,OAAO,YAAY;IAMvB,YAAY,OAGX;QANO,uBAAkB,GACxB,IAAI,yBAAyB,EAAE,CAAC;QA4EjB,kBAAa,GAAG,oBAAoB,CAAC;QAtEpD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB;YAC3B,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACnD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB;YAC7B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IACzD,CAAC;IAED,kBAAkB;IACX,KAAK,CAAC,UAAU,CACrB,OAAoB,EACpB,OAAoC;QAEpC,MAAM,YAAY,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACvD,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IACpE,CAAC;IAEO,KAAK,CAAC,qBAAqB,CACjC,OAAoB,EACpB,WAAmB,EACnB,OAAsB;;QAEtB,MAAM,SAAS,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;QAEtE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC,CAAC;YAC5D,IAAI,QAAQ,CAAC,EAAE;gBAAE,OAAO,QAAQ,CAAC;YAEjC,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACpD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC;YAED,MAAM,WAAW,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,IAAI,CAAC,kBAAkB,CAAC;YACpE,IAAI,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,CAAC;gBACnD,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;gBAClD,MAAM,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,aAAa,CAChB,SAAS,EACT,WAAW,EACX,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,MAAM,CAChB,CAAC;gBACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjD,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,2DAA2D;YAC3D,IAAI,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,uBAAuB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBAC/C,MAAM,KAAK,CAAC;YACd,CAAC;YAED,MAAM,WAAW,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,IAAI,CAAC,kBAAkB,CAAC;YACpE,IAAI,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;gBAClD,MAAM,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;gBACzD,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACvC,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,KAAc;QAC1C,oDAAoD;QACpD,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAChD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IAC7C,CAAC;IAIO,aAAa,CACnB,SAAiB,EACjB,WAAmB,EACnB,MAAe,EACf,IAAa;;QAEb,MAAA,IAAI,CAAC,gBAAgB,0CAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,eAAe;YACvB,KAAK,EAAE,gBAAgB,WAAW,WAAW,IAAI,aAAa,MAAM,UAAU,SAAS,EAAE;SAC1F,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,SAAiB,EAAE,KAAc;;QACvD,MAAA,IAAI,CAAC,gBAAgB,0CAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,UAAU,KAAK,UAAU,SAAS,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,QAAkB;;QACvC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAE/B,MAAA,IAAI,CAAC,gBAAgB,0CAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,mBAAmB;YAC3B,KAAK,EAAE,eAAe,MAAM,UAAU,QAAQ,CAAC,GAAG,EAAE;SACrD,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,SAAiB,EAAE,KAAc;;QAC/D,MAAA,IAAI,CAAC,gBAAgB,0CAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,mCAAmC;YAC3C,KAAK,EAAE,UAAU,KAAK,UAAU,SAAS,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type { AnalyticsHandlerInterface } from '@internetarchive/analytics-manager';\nimport { promisedSleep } from '../utils/promised-sleep';\nimport { type FetchOptions } from '../fetch-options';\nimport { legacyArgsAsFetchOptions } from './legacy-args';\nimport { DefaultRetryConfiguration } from './configuration/default-retry-configuration';\nimport type { RetryConfiguring } from './configuration/retry-configuring';\n\n/**\n * A class that retries a fetch request.\n */\nexport interface FetchRetrierInterface {\n  /**\n   * Execute a fetch with retry.\n   *\n   * @param request RequestInfo\n   * @param options Optional RequestInit | FetchOptions\n   * @returns Promise<Response>\n   */\n  fetchRetry(\n    request: RequestInfo,\n    options?: RequestInit | FetchOptions,\n  ): Promise<Response>;\n}\n\n/** @inheritdoc */\nexport class FetchRetrier implements FetchRetrierInterface {\n  private analyticsHandler?: AnalyticsHandlerInterface;\n\n  private retryConfiguration: RetryConfiguring =\n    new DefaultRetryConfiguration();\n\n  constructor(options?: {\n    analyticsHandler?: AnalyticsHandlerInterface;\n    retryConfiguration?: RetryConfiguring;\n  }) {\n    if (options?.analyticsHandler)\n      this.analyticsHandler = options.analyticsHandler;\n    if (options?.retryConfiguration)\n      this.retryConfiguration = options.retryConfiguration;\n  }\n\n  /** @inheritdoc */\n  public async fetchRetry(\n    request: RequestInfo,\n    options?: RequestInit | FetchOptions,\n  ): Promise<Response> {\n    const fetchOptions = legacyArgsAsFetchOptions(options);\n    return await this.fetchRetryWithOptions(request, 0, fetchOptions);\n  }\n\n  private async fetchRetryWithOptions(\n    request: RequestInfo,\n    retryNumber: number,\n    options?: FetchOptions,\n  ): Promise<Response> {\n    const urlString = typeof request === 'string' ? request : request.url;\n\n    try {\n      const response = await fetch(request, options?.requestInit);\n      if (response.ok) return response;\n\n      if (response.status >= 400 && response.status < 500) {\n        this.log4xxResponse(response);\n      }\n\n      const retryConfig = options?.retryConfig ?? this.retryConfiguration;\n      if (retryConfig.shouldRetry(response, retryNumber)) {\n        const delay = retryConfig.retryDelay(retryNumber);\n        await promisedSleep(delay);\n        this.logRetryEvent(\n          urlString,\n          retryNumber,\n          response.statusText,\n          response.status,\n        );\n        return this.fetchRetryWithOptions(request, retryNumber + 1, options);\n      }\n      this.logFailureEvent(urlString, response.status);\n      return response;\n    } catch (error) {\n      // if a content blocker is detected, log it and don't retry\n      if (this.isContentBlockerError(error)) {\n        this.logContentBlockingEvent(urlString, error);\n        throw error;\n      }\n\n      const retryConfig = options?.retryConfig ?? this.retryConfiguration;\n      if (retryConfig.shouldRetry(null, retryNumber)) {\n        const delay = retryConfig.retryDelay(retryNumber);\n        await promisedSleep(delay);\n        this.logRetryEvent(urlString, retryNumber, error, error);\n        return this.fetchRetryWithOptions(request, retryNumber + 1, options);\n      }\n      this.logFailureEvent(urlString, error);\n      throw error;\n    }\n  }\n\n  private isContentBlockerError(error: unknown): boolean {\n    // all of the content blocker errors are `TypeError`\n    if (!(error instanceof TypeError)) return false;\n    const message = error.message.toLowerCase();\n    return message.includes('content blocker');\n  }\n\n  private readonly eventCategory = 'offshootFetchRetry';\n\n  private logRetryEvent(\n    urlString: string,\n    retryNumber: number,\n    status: unknown,\n    code: unknown,\n  ) {\n    this.analyticsHandler?.sendEvent({\n      category: this.eventCategory,\n      action: 'retryingFetch',\n      label: `retryNumber: ${retryNumber}, code: ${code}, status: ${status}, url: ${urlString}`,\n    });\n  }\n\n  private logFailureEvent(urlString: string, error: unknown) {\n    this.analyticsHandler?.sendEvent({\n      category: this.eventCategory,\n      action: 'fetchFailed',\n      label: `error: ${error}, url: ${urlString}`,\n    });\n  }\n\n  private log4xxResponse(response: Response) {\n    const status = response.status;\n\n    this.analyticsHandler?.sendEvent({\n      category: this.eventCategory,\n      action: `status4xxResponse`,\n      label: `http status ${status}, url: ${response.url}`,\n    });\n  }\n\n  private logContentBlockingEvent(urlString: string, error: unknown) {\n    this.analyticsHandler?.sendEvent({\n      category: this.eventCategory,\n      action: 'contentBlockerDetectedNotRetrying',\n      label: `error: ${error}, url: ${urlString}`,\n    });\n  }\n}\n"]}

package/dist/src/fetch-retry/legacy-args.d.ts

@@ -0,0 +1,2 @@
+import type { FetchOptions } from '../fetch-options';
+export declare const legacyArgsAsFetchOptions: (options?: RequestInit | FetchOptions) => FetchOptions | undefined;

package/dist/src/fetch-retry/legacy-args.js

@@ -0,0 +1,11 @@
+export const legacyArgsAsFetchOptions = (options) => {
+    if (!options)
+        return undefined;
+    // if options is already FetchOptions, return it
+    if ('requestInit' in options || 'retryConfig' in options) {
+        return options;
+    }
+    // otherwise, it's RequestInit
+    return { requestInit: options };
+};
+//# sourceMappingURL=legacy-args.js.map

package/dist/src/fetch-retry/legacy-args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-args.js","sourceRoot":"","sources":["../../../src/fetch-retry/legacy-args.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,OAAoC,EACV,EAAE;IAC5B,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,gDAAgD;IAChD,IAAI,aAAa,IAAI,OAAO,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;QACzD,OAAO,OAAuB,CAAC;IACjC,CAAC;IACD,8BAA8B;IAC9B,OAAO,EAAE,WAAW,EAAE,OAAsB,EAAE,CAAC;AACjD,CAAC,CAAC","sourcesContent":["import type { FetchOptions } from '../fetch-options';\n\nexport const legacyArgsAsFetchOptions = (\n  options?: RequestInit | FetchOptions,\n): FetchOptions | undefined => {\n  if (!options) return undefined;\n  // if options is already FetchOptions, return it\n  if ('requestInit' in options || 'retryConfig' in options) {\n    return options as FetchOptions;\n  }\n  // otherwise, it's RequestInit\n  return { requestInit: options as RequestInit };\n};\n"]}