@algolia/requester-browser-xhr 5.8.1 → 5.9.0

package/dist/requester.xhr.d.ts

@@ -1,5 +1,3 @@
-import { Requester } from '@algolia/client-common';
+function m(){function r(t){return new Promise(s=>{let e=new XMLHttpRequest;e.open(t.method,t.url,!0),Object.keys(t.headers).forEach(n=>e.setRequestHeader(n,t.headers[n]));let i=(n,a)=>setTimeout(()=>{e.abort(),s({status:0,content:a,isTimedOut:!0});},n),u=i(t.connectTimeout,"Connection timeout"),o;e.onreadystatechange=()=>{e.readyState>e.OPENED&&o===void 0&&(clearTimeout(u),o=i(t.responseTimeout,"Socket timeout"));},e.onerror=()=>{e.status===0&&(clearTimeout(u),clearTimeout(o),s({content:e.responseText||"Network request failed",status:e.status,isTimedOut:!1}));},e.onload=()=>{clearTimeout(u),clearTimeout(o),s({content:e.responseText,status:e.status,isTimedOut:!1});},e.send(t.data);})}return {send:r}}
 
-declare function createXhrRequester(): Requester;
-
-export { createXhrRequester };
+export { m as createXhrRequester };

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist/requester.xhr';

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./dist/requester.xhr.js');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/requester-browser-xhr",
-  "version": "5.8.1",
+  "version": "5.9.0",
   "description": "Promise-based request library for browser using xhr.",
   "repository": {
     "type": "git",
@@ -21,8 +21,8 @@
   "react-native": "./dist/requester.xhr.js",
   "files": [
     "dist",
-    "src",
-    "index.ts"
+    "index.d.ts",
+    "index.js"
   ],
   "scripts": {
     "build": "yarn clean && yarn tsup",
@@ -31,15 +31,15 @@
     "test:bundle": "publint . && attw --pack . --ignore-rules cjs-resolves-to-esm"
   },
   "dependencies": {
-    "@algolia/client-common": "5.8.1"
+    "@algolia/client-common": "5.9.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@types/node": "22.7.4",
+    "@types/node": "22.7.5",
     "jsdom": "25.0.1",
     "publint": "0.2.11",
     "tsup": "8.3.0",
-    "typescript": "5.6.2",
+    "typescript": "5.6.3",
     "vitest": "2.1.2",
     "xhr-mock": "2.5.1"
   },

package/index.ts

@@ -1 +0,0 @@
-export * from './src/createXhrRequester';

package/src/__tests__/browser-xhr-requester.test.ts

@@ -1,229 +0,0 @@
-import type http from 'http';
-import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, test } from 'vitest';
-import type { MockRequest, MockResponse } from 'xhr-mock';
-import mock from 'xhr-mock';
-
-import type { EndRequest } from '@algolia/client-common';
-
-import { createXhrRequester } from '../..';
-import {
-  BASE_URL,
-  createTestServer,
-  getStringifiedBody,
-  headers,
-  requestStub,
-  timeoutRequest,
-} from '../../../../tests/utils';
-
-const requester = createXhrRequester();
-
-describe('status code handling', () => {
-  beforeEach(() => {
-    mock.setup();
-  });
-  afterEach(() => {
-    mock.teardown();
-  });
-
-  test('sends requests', async () => {
-    mock.post(BASE_URL, (req: MockRequest, res: MockResponse): MockResponse => {
-      expect(req.method()).toEqual('POST');
-      expect(req.header('content-type')).toEqual('text/plain');
-      expect(req.body()).toEqual(JSON.stringify({ foo: 'bar' }));
-
-      return res.status(200);
-    });
-
-    await requester.send(requestStub);
-  });
-
-  test('resolves status 200', async () => {
-    const body = getStringifiedBody();
-
-    mock.post(BASE_URL, {
-      status: 200,
-      body: requestStub.data,
-    });
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(200);
-    expect(response.content).toBe(body);
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('resolves status 300', async () => {
-    const reason = 'Multiple Choices';
-
-    mock.post(BASE_URL, {
-      status: 300,
-      reason,
-    });
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(300);
-    expect(response.content).toBe(''); // No body returned here on xhr
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('resolves status 400', async () => {
-    const body = getStringifiedBody({
-      message: 'Invalid Application-Id or API-Key',
-    });
-
-    mock.post(BASE_URL, {
-      status: 400,
-      body,
-    });
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(400);
-    expect(response.content).toBe(body);
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('handles the protocol', async () => {
-    const body = getStringifiedBody();
-
-    mock.post('http://localhost/', {
-      status: 200,
-      body,
-    });
-
-    const response = await requester.send({
-      ...requestStub,
-      url: 'http://localhost',
-    });
-
-    expect(response.status).toBe(200);
-    expect(response.content).toBe(body);
-    expect(response.isTimedOut).toBe(false);
-  });
-});
-
-describe('timeout handling', () => {
-  let server: http.Server;
-  // setup http server to test timeout
-  beforeAll(() => {
-    server = createTestServer();
-
-    server.listen('1111');
-  });
-
-  afterAll(
-    () =>
-      new Promise((done) => {
-        done();
-      }),
-  );
-
-  test('connection timeouts with the given 1 seconds connection timeout', async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...timeoutRequest,
-      connectTimeout: 1000,
-      url: 'http://localhost:1111/connection_timeout',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Connection timeout');
-    expect(now - before).toBeGreaterThanOrEqual(999);
-    expect(now - before).toBeLessThanOrEqual(1200);
-  });
-
-  test('connection timeouts with the given 2 seconds connection timeout', async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...timeoutRequest,
-      connectTimeout: 2000,
-      url: 'http://localhost:1111/connection_timeout',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Connection timeout');
-    expect(now - before).toBeGreaterThanOrEqual(1990);
-    expect(now - before).toBeLessThanOrEqual(2200);
-  });
-
-  test("socket timeouts if response don't appears before the timeout with 2 seconds timeout", async () => {
-    const before = Date.now();
-
-    const response = await requester.send({
-      ...timeoutRequest,
-      responseTimeout: 2000,
-      url: 'http://localhost:1111',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Socket timeout');
-    expect(now - before).toBeGreaterThanOrEqual(1990);
-    expect(now - before).toBeLessThanOrEqual(2200);
-  });
-
-  test("socket timeouts if response don't appears before the timeout with 3 seconds timeout", async () => {
-    const before = Date.now();
-
-    const response = await requester.send({
-      ...timeoutRequest,
-      responseTimeout: 3000,
-      url: 'http://localhost:1111',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Socket timeout');
-    expect(now - before).toBeGreaterThanOrEqual(2999);
-    expect(now - before).toBeLessThanOrEqual(3200);
-  });
-
-  test('do not timeouts if response appears before the timeout', async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...requestStub,
-      responseTimeout: 6000,
-      url: 'http://localhost:1111',
-    });
-
-    const now = Date.now();
-
-    expect(response.isTimedOut).toBe(false);
-    expect(response.status).toBe(200);
-    expect(response.content).toBe('{"foo": "bar"}');
-    expect(now - before).toBeGreaterThanOrEqual(4999);
-    expect(now - before).toBeLessThanOrEqual(5200);
-  }, 10000); // This is a long-running test, default server timeout is set to 5000ms
-});
-
-describe('error handling', () => {
-  test('resolves dns not found', async () => {
-    const request: EndRequest = {
-      url: 'https://this-dont-exist.algolia.com',
-      method: 'POST',
-      headers,
-      data: getStringifiedBody(),
-      responseTimeout: 2000,
-      connectTimeout: 1000,
-    };
-
-    const response = await requester.send(request);
-
-    expect(response.status).toBe(0);
-    expect(response.content).toBe('Network request failed');
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('resolves general network errors', async () => {
-    mock.post(BASE_URL, () => Promise.reject(new Error('This is a general error')));
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(0);
-    expect(response.content).toBe('Network request failed');
-    expect(response.isTimedOut).toBe(false);
-  });
-});

package/src/createXhrRequester.ts

@@ -1,67 +0,0 @@
-import type { EndRequest, Requester, Response } from '@algolia/client-common';
-
-type Timeout = ReturnType<typeof setTimeout>;
-
-export function createXhrRequester(): Requester {
-  function send(request: EndRequest): Promise<Response> {
-    return new Promise((resolve) => {
-      const baseRequester = new XMLHttpRequest();
-      baseRequester.open(request.method, request.url, true);
-
-      Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
-
-      const createTimeout = (timeout: number, content: string): Timeout => {
-        return setTimeout(() => {
-          baseRequester.abort();
-
-          resolve({
-            status: 0,
-            content,
-            isTimedOut: true,
-          });
-        }, timeout);
-      };
-
-      const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
-
-      let responseTimeout: Timeout | undefined;
-
-      baseRequester.onreadystatechange = (): void => {
-        if (baseRequester.readyState > baseRequester.OPENED && responseTimeout === undefined) {
-          clearTimeout(connectTimeout);
-
-          responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
-        }
-      };
-
-      baseRequester.onerror = (): void => {
-        // istanbul ignore next
-        if (baseRequester.status === 0) {
-          clearTimeout(connectTimeout);
-          clearTimeout(responseTimeout!);
-
-          resolve({
-            content: baseRequester.responseText || 'Network request failed',
-            status: baseRequester.status,
-            isTimedOut: false,
-          });
-        }
-      };
-
-      baseRequester.onload = (): void => {
-        clearTimeout(connectTimeout);
-        clearTimeout(responseTimeout!);
-
-        resolve({
-          content: baseRequester.responseText,
-          status: baseRequester.status,
-          isTimedOut: false,
-        });
-      };
-
-      baseRequester.send(request.data);
-    });
-  }
-
-  return { send };
-}