@algolia/client-common 5.52.1 → 5.54.0

package/dist/common.d.cts

@@ -59,6 +59,67 @@ type FallbackableCacheOptions = {
     caches: Cache[];
 };
 
+/**
+ * Shared configuration for chunked helpers that poll for task completion.
+ */
+type ChunkedHelperOptions = {
+    /**
+     * The maximum number of retries when polling for task completion. 100 by default.
+     */
+    maxRetries?: number | undefined;
+};
+
+/**
+ * WHATWG-compliant Server-Sent Events parser.
+ *
+ * Three-layer architecture:
+ *   1. iterLines()    — byte chunking → line decoding
+ *   2. SSEDecoder     — line → SSE event decoding
+ *   3. iterSSEEvents  — top-level composer (exported)
+ *
+ * @see https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation
+ */
+type ServerSentEvent = {
+    /** Concatenated data: field values, joined by '\n'. */
+    data: string;
+    /** Event type from the event: field. Defaults to "" (empty string). */
+    event: string;
+    /** Last event ID. Persists across dispatches until changed. */
+    id: string | null;
+    /** Reconnection time in ms. Persists across dispatches until changed. */
+    retry: number | null;
+};
+/**
+ * Wrapper for a parsed SSE event, yielded by the typed `*Stream` methods.
+ *
+ * - `data` is the JSON-parsed payload when parsing succeeds, `null` otherwise.
+ * - `raw` is the original {@link ServerSentEvent} (always present).
+ * - `error` is set when JSON parsing of `event.data` failed.
+ */
+type StreamEvent<T = Record<string, unknown>> = {
+    /** Parsed data from the event, or `null` if parsing failed. */
+    data: T | null;
+    /** The original, unparsed SSE event. */
+    raw: ServerSentEvent;
+    /** The error that occurred while parsing `event.data`, if any. */
+    error?: Error;
+};
+/**
+ * Parses a byte stream as WHATWG Server-Sent Events.
+ *
+ * Accepts both ReadableStream<Uint8Array> (browser fetch) and
+ * AsyncIterable<Uint8Array> (Node.js streams / Buffer chunks).
+ *
+ * @example
+ * ```ts
+ * const response = await fetch(url);
+ * for await (const event of iterSSEEvents(response.body!)) {
+ *   console.log(event.event, event.data);
+ * }
+ * ```
+ */
+declare function iterSSEEvents(stream: ReadableStream<Uint8Array> | AsyncIterable<Uint8Array>): AsyncGenerator<ServerSentEvent>;
+
 type Host = {
     /**
      * The host URL.
@@ -173,6 +234,10 @@ type Requester = {
      * Sends the given `request` to the server.
      */
     send: (request: EndRequest) => Promise<Response>;
+    /**
+     * Sends the given `request` and returns a raw byte stream for streaming responses (e.g. SSE).
+     */
+    sendStream?: (request: EndRequest) => Promise<ReadableStream<Uint8Array>>;
 };
 
 type RequestOptions = Pick<Request, 'cacheable'> & {
@@ -316,6 +381,7 @@ type Transporter = TransporterOptions & {
      * The `baseRequest` and `baseRequestOptions` will be merged accordingly.
      */
     request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
+    requestStream: (baseRequest: Request, baseRequestOptions?: RequestOptions) => AsyncGenerator<ServerSentEvent>;
 };
 
 type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
@@ -474,4 +540,6 @@ declare function isSuccess({ status }: Pick<Response, 'status'>): boolean;
 declare function stackTraceWithoutCredentials(stackTrace: StackFrame[]): StackFrame[];
 declare function stackFrameWithoutCredentials(stackFrame: StackFrame): StackFrame;
 
-export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type StackFrame, type StatefulHost, type Timeouts, type Transporter, type TransporterOptions, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials };
+declare function validateRequired(field: string, method: string, value: unknown): void;
+
+export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ChunkedHelperOptions, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type ServerSentEvent, type StackFrame, type StatefulHost, type StreamEvent, type Timeouts, type Transporter, type TransporterOptions, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, iterSSEEvents, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials, validateRequired };

package/dist/common.d.ts

@@ -59,6 +59,67 @@ type FallbackableCacheOptions = {
     caches: Cache[];
 };
 
+/**
+ * Shared configuration for chunked helpers that poll for task completion.
+ */
+type ChunkedHelperOptions = {
+    /**
+     * The maximum number of retries when polling for task completion. 100 by default.
+     */
+    maxRetries?: number | undefined;
+};
+
+/**
+ * WHATWG-compliant Server-Sent Events parser.
+ *
+ * Three-layer architecture:
+ *   1. iterLines()    — byte chunking → line decoding
+ *   2. SSEDecoder     — line → SSE event decoding
+ *   3. iterSSEEvents  — top-level composer (exported)
+ *
+ * @see https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation
+ */
+type ServerSentEvent = {
+    /** Concatenated data: field values, joined by '\n'. */
+    data: string;
+    /** Event type from the event: field. Defaults to "" (empty string). */
+    event: string;
+    /** Last event ID. Persists across dispatches until changed. */
+    id: string | null;
+    /** Reconnection time in ms. Persists across dispatches until changed. */
+    retry: number | null;
+};
+/**
+ * Wrapper for a parsed SSE event, yielded by the typed `*Stream` methods.
+ *
+ * - `data` is the JSON-parsed payload when parsing succeeds, `null` otherwise.
+ * - `raw` is the original {@link ServerSentEvent} (always present).
+ * - `error` is set when JSON parsing of `event.data` failed.
+ */
+type StreamEvent<T = Record<string, unknown>> = {
+    /** Parsed data from the event, or `null` if parsing failed. */
+    data: T | null;
+    /** The original, unparsed SSE event. */
+    raw: ServerSentEvent;
+    /** The error that occurred while parsing `event.data`, if any. */
+    error?: Error;
+};
+/**
+ * Parses a byte stream as WHATWG Server-Sent Events.
+ *
+ * Accepts both ReadableStream<Uint8Array> (browser fetch) and
+ * AsyncIterable<Uint8Array> (Node.js streams / Buffer chunks).
+ *
+ * @example
+ * ```ts
+ * const response = await fetch(url);
+ * for await (const event of iterSSEEvents(response.body!)) {
+ *   console.log(event.event, event.data);
+ * }
+ * ```
+ */
+declare function iterSSEEvents(stream: ReadableStream<Uint8Array> | AsyncIterable<Uint8Array>): AsyncGenerator<ServerSentEvent>;
+
 type Host = {
     /**
      * The host URL.
@@ -173,6 +234,10 @@ type Requester = {
      * Sends the given `request` to the server.
      */
     send: (request: EndRequest) => Promise<Response>;
+    /**
+     * Sends the given `request` and returns a raw byte stream for streaming responses (e.g. SSE).
+     */
+    sendStream?: (request: EndRequest) => Promise<ReadableStream<Uint8Array>>;
 };
 
 type RequestOptions = Pick<Request, 'cacheable'> & {
@@ -316,6 +381,7 @@ type Transporter = TransporterOptions & {
      * The `baseRequest` and `baseRequestOptions` will be merged accordingly.
      */
     request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
+    requestStream: (baseRequest: Request, baseRequestOptions?: RequestOptions) => AsyncGenerator<ServerSentEvent>;
 };
 
 type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
@@ -474,4 +540,6 @@ declare function isSuccess({ status }: Pick<Response, 'status'>): boolean;
 declare function stackTraceWithoutCredentials(stackTrace: StackFrame[]): StackFrame[];
 declare function stackFrameWithoutCredentials(stackFrame: StackFrame): StackFrame;
 
-export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type StackFrame, type StatefulHost, type Timeouts, type Transporter, type TransporterOptions, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials };
+declare function validateRequired(field: string, method: string, value: unknown): void;
+
+export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ChunkedHelperOptions, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type ServerSentEvent, type StackFrame, type StatefulHost, type StreamEvent, type Timeouts, type Transporter, type TransporterOptions, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, iterSSEEvents, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials, validateRequired };

package/dist/common.js

@@ -14,42 +14,50 @@ function createBrowserLocalStorageCache(options) {
   function setNamespace(namespace) {
     getStorage().setItem(namespaceKey, JSON.stringify(namespace));
   }
-  function removeOutdatedCacheItems() {
+  function yieldToMain() {
+    return new Promise((resolve) => setTimeout(resolve, 0));
+  }
+  function getFilteredNamespace() {
     const timeToLive = options.timeToLive ? options.timeToLive * 1e3 : null;
     const namespace = getNamespace();
-    const filteredNamespaceWithoutOldFormattedCacheItems = Object.fromEntries(
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
+    let changed = false;
+    const filtered = Object.fromEntries(
       Object.entries(namespace).filter(([, cacheItem]) => {
-        return cacheItem.timestamp !== void 0;
-      })
-    );
-    setNamespace(filteredNamespaceWithoutOldFormattedCacheItems);
-    if (!timeToLive) {
-      return;
-    }
-    const filteredNamespaceWithoutExpiredItems = Object.fromEntries(
-      Object.entries(filteredNamespaceWithoutOldFormattedCacheItems).filter(([, cacheItem]) => {
-        const currentTimestamp = (/* @__PURE__ */ new Date()).getTime();
-        const isExpired = cacheItem.timestamp + timeToLive < currentTimestamp;
-        return !isExpired;
+        if (!cacheItem || cacheItem.timestamp === void 0) {
+          changed = true;
+          return false;
+        }
+        if (!timeToLive) {
+          return true;
+        }
+        if (cacheItem.timestamp + timeToLive < currentTime) {
+          changed = true;
+          return false;
+        }
+        return true;
       })
     );
-    setNamespace(filteredNamespaceWithoutExpiredItems);
+    return { namespace: filtered, changed };
   }
   return {
     get(key, defaultValue, events = {
       miss: () => Promise.resolve()
     }) {
-      return Promise.resolve().then(() => {
-        removeOutdatedCacheItems();
-        return getNamespace()[JSON.stringify(key)];
-      }).then((value) => {
-        return Promise.all([value ? value.value : defaultValue(), value !== void 0]);
-      }).then(([value, exists]) => {
-        return Promise.all([value, exists || events.miss(value)]);
-      }).then(([value]) => value);
+      return yieldToMain().then(() => {
+        const { namespace, changed } = getFilteredNamespace();
+        const cachedItem = namespace[JSON.stringify(key)];
+        if (changed) {
+          setNamespace(namespace);
+        }
+        if (cachedItem) {
+          return cachedItem.value;
+        }
+        return defaultValue().then((value) => events.miss(value).then(() => value));
+      });
     },
     set(key, value) {
-      return Promise.resolve().then(() => {
+      return yieldToMain().then(() => {
         const namespace = getNamespace();
         namespace[JSON.stringify(key)] = {
           timestamp: (/* @__PURE__ */ new Date()).getTime(),
@@ -60,7 +68,7 @@ function createBrowserLocalStorageCache(options) {
       });
     },
     delete(key) {
-      return Promise.resolve().then(() => {
+      return yieldToMain().then(() => {
         const namespace = getNamespace();
         delete namespace[JSON.stringify(key)];
         getStorage().setItem(namespaceKey, JSON.stringify(namespace));
@@ -255,6 +263,165 @@ function createNullLogger() {
   };
 }
 
+// src/sse.ts
+var MAX_LINE_BUFFER_SIZE = 10 * 1024 * 1024;
+async function* readableStreamToAsyncIterable(stream) {
+  const reader = stream.getReader();
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) return;
+      yield value;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+}
+function toAsyncIterable(stream) {
+  if (Symbol.asyncIterator in stream) {
+    return stream;
+  }
+  return readableStreamToAsyncIterable(stream);
+}
+async function* iterLines(stream) {
+  const decoder = new TextDecoder("utf-8");
+  const buffer = [];
+  let bufferSize = 0;
+  let trailingCR = false;
+  let isFirstLine = true;
+  for await (const chunk of toAsyncIterable(stream)) {
+    const text = decoder.decode(chunk, { stream: true });
+    let offset = 0;
+    if (trailingCR) {
+      trailingCR = false;
+      if (text.length > 0 && text[0] === "\n") {
+        offset = 1;
+      }
+    }
+    while (offset < text.length) {
+      const crIdx = text.indexOf("\r", offset);
+      const lfIdx = text.indexOf("\n", offset);
+      if (crIdx === -1 && lfIdx === -1) {
+        const remaining2 = text.slice(offset);
+        buffer.push(remaining2);
+        bufferSize += remaining2.length;
+        if (bufferSize > MAX_LINE_BUFFER_SIZE) {
+          throw new Error("SSE line buffer exceeded 10MB");
+        }
+        break;
+      }
+      let endIdx;
+      let skipLen;
+      if (crIdx !== -1 && (lfIdx === -1 || crIdx < lfIdx)) {
+        endIdx = crIdx;
+        if (crIdx + 1 < text.length) {
+          skipLen = text[crIdx + 1] === "\n" ? 2 : 1;
+        } else {
+          trailingCR = true;
+          skipLen = 1;
+        }
+      } else {
+        endIdx = lfIdx;
+        skipLen = 1;
+      }
+      const segment = text.slice(offset, endIdx);
+      buffer.push(segment);
+      let line = buffer.length === 1 ? buffer[0] : buffer.join("");
+      buffer.length = 0;
+      bufferSize = 0;
+      if (isFirstLine) {
+        if (line.startsWith("\uFEFF")) {
+          line = line.slice(1);
+        }
+        isFirstLine = false;
+      }
+      yield line;
+      offset = endIdx + skipLen;
+    }
+  }
+  const remaining = decoder.decode();
+  if (remaining) {
+    buffer.push(remaining);
+  }
+  if (buffer.length > 0) {
+    let line = buffer.join("");
+    if (isFirstLine && line.startsWith("\uFEFF")) {
+      line = line.slice(1);
+    }
+    yield line;
+  }
+}
+var SSEDecoder = class {
+  data = [];
+  eventType = "";
+  lastEventId = null;
+  retry = null;
+  decode(line) {
+    if (line === "") {
+      return this.dispatch();
+    }
+    if (line[0] === ":") {
+      return null;
+    }
+    const colonIdx = line.indexOf(":");
+    let field;
+    let value;
+    if (colonIdx === -1) {
+      field = line;
+      value = "";
+    } else {
+      field = line.slice(0, colonIdx);
+      value = line.slice(colonIdx + 1);
+      if (value[0] === " ") {
+        value = value.slice(1);
+      }
+    }
+    switch (field) {
+      case "data":
+        this.data.push(value);
+        break;
+      case "event":
+        this.eventType = value;
+        break;
+      case "id":
+        if (!value.includes("\0")) {
+          this.lastEventId = value;
+        }
+        break;
+      case "retry":
+        if (/^[0-9]+$/.test(value)) {
+          this.retry = parseInt(value, 10);
+        }
+        break;
+    }
+    return null;
+  }
+  dispatch() {
+    const currentEventType = this.eventType;
+    this.eventType = "";
+    if (this.data.length === 0) {
+      return null;
+    }
+    const event = {
+      data: this.data.join("\n"),
+      event: currentEventType,
+      id: this.lastEventId,
+      retry: this.retry
+    };
+    this.data = [];
+    return event;
+  }
+};
+async function* iterSSEEvents(stream) {
+  const decoder = new SSEDecoder();
+  for await (const line of iterLines(stream)) {
+    const event = decoder.decode(line);
+    if (event !== null) {
+      yield event;
+    }
+  }
+}
+
 // src/transporter/compress.ts
 var COMPRESSION_THRESHOLD = 750;
 
@@ -382,6 +549,9 @@ function serializeHeaders(baseHeaders, requestHeaders, requestOptionsHeaders) {
   return serializedHeaders;
 }
 function deserializeSuccess(response) {
+  if (response.status === 204 || response.content.length === 0) {
+    return void 0;
+  }
   try {
     return JSON.parse(response.content);
   } catch (e) {
@@ -590,6 +760,55 @@ function createTransporter({
       }
     );
   }
+  async function* requestStream(request, requestOptions = {}) {
+    if (!requester.sendStream) {
+      throw new Error("This requester does not support streaming");
+    }
+    const data = serializeData(request, requestOptions);
+    const headers = serializeHeaders(baseHeaders, request.headers, requestOptions.headers);
+    headers["accept"] = "text/event-stream";
+    const dataQueryParameters = request.method === "GET" ? {
+      ...request.data,
+      ...requestOptions.data
+    } : {};
+    const queryParameters = {
+      ...baseQueryParameters,
+      ...request.queryParameters,
+      ...dataQueryParameters
+    };
+    if (algoliaAgent.value) {
+      queryParameters["x-algolia-agent"] = algoliaAgent.value;
+    }
+    if (requestOptions && requestOptions.queryParameters) {
+      for (const key of Object.keys(requestOptions.queryParameters)) {
+        if (!requestOptions.queryParameters[key] || Object.prototype.toString.call(requestOptions.queryParameters[key]) === "[object Object]") {
+          queryParameters[key] = requestOptions.queryParameters[key];
+        } else {
+          queryParameters[key] = requestOptions.queryParameters[key].toString();
+        }
+      }
+    }
+    const isRead = request.useReadTransporter || request.method === "GET";
+    const compatibleHosts = hosts.filter(
+      (host2) => host2.accept === "readWrite" || (isRead ? host2.accept === "read" : host2.accept === "write")
+    );
+    const options = await createRetryableOptions(compatibleHosts);
+    const host = options.hosts[0];
+    if (!host) {
+      throw new RetryError([]);
+    }
+    const timeout = { ...timeouts, ...requestOptions.timeouts };
+    const payload = {
+      data,
+      headers,
+      method: request.method,
+      url: serializeUrl(host, request.path, queryParameters),
+      connectTimeout: timeout.connect,
+      responseTimeout: isRead ? timeout.read : timeout.write
+    };
+    const stream = await requester.sendStream(payload);
+    yield* iterSSEEvents(stream);
+  }
   return {
     hostsCache,
     requester,
@@ -600,6 +819,7 @@ function createTransporter({
     baseQueryParameters,
     hosts,
     request: createRequest,
+    requestStream,
     requestsCache,
     responsesCache
   };
@@ -611,6 +831,13 @@ var LogLevelEnum = {
   Info: 2,
   Error: 3
 };
+
+// src/validateParam.ts
+function validateRequired(field, method, value) {
+  if (value === null || value === void 0 || typeof value === "string" && value.length === 0) {
+    throw new Error(`Parameter \`${field}\` is required when calling \`${method}\`.`);
+  }
+}
 export {
   AlgoliaError,
   ApiError,
@@ -645,12 +872,14 @@ export {
   isNetworkError,
   isRetryable,
   isSuccess,
+  iterSSEEvents,
   serializeData,
   serializeHeaders,
   serializeQueryParameters,
   serializeUrl,
   shuffle,
   stackFrameWithoutCredentials,
-  stackTraceWithoutCredentials
+  stackTraceWithoutCredentials,
+  validateRequired
 };
 //# sourceMappingURL=common.js.map