@orq-ai/node 4.11.0-rc.9 → 4.11.0

package/packages/orq-rc/src/lib/event-streams.ts

@@ -0,0 +1,191 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+// Some environments' type definitions do not include ReadableStream's async
+// iterator, even though the runtime supports it or this class polyfills it.
+// Declare the method here so Stream can override it and preserve T in for-await.
+declare global {
+  interface ReadableStream<R = any> {
+    [Symbol.asyncIterator](): {
+      next(): Promise<IteratorResult<R, undefined>>;
+      throw?(e?: unknown): Promise<IteratorResult<R, undefined>>;
+      return?(): Promise<IteratorResult<R, undefined>>;
+      [Symbol.asyncIterator](): any;
+    };
+  }
+}
+
+export type SseMessage<T> = {
+  data?: T | undefined;
+  event?: string | null | undefined;
+  id?: string | null | undefined;
+  retry?: number | null | undefined;
+};
+export class EventStream<T extends SseMessage<unknown>>
+  extends ReadableStream<T>
+{
+  constructor(
+    responseBody: ReadableStream<Uint8Array>,
+    parse: (x: SseMessage<string>) => IteratorResult<T, undefined>,
+    opts?: { dataRequired?: boolean },
+  ) {
+    const upstream = responseBody.getReader();
+    let buffer: Uint8Array = new Uint8Array(4096);
+    let bufferLen = 0;
+    let searchStart = 0;
+    const state = { eventId: undefined as string | undefined };
+    const dataRequired = opts?.dataRequired ?? true;
+    super({
+      async pull(downstream) {
+        try {
+          while (true) {
+            const match = findBoundary(buffer, bufferLen, searchStart);
+            if (!match) {
+              // Bytes before the trailing MAX_BOUNDARY_LEN-1 were already
+              // scanned with full lookahead and cannot start a boundary even
+              // once more data arrives, so the next scan can skip them.
+              searchStart = Math.max(0, bufferLen - MAX_BOUNDARY_LEN + 1);
+              const chunk = await upstream.read();
+              if (chunk.done) return downstream.close();
+              if (bufferLen + chunk.value.length > buffer.length) {
+                const grown = new Uint8Array(
+                  Math.max(buffer.length * 2, bufferLen + chunk.value.length),
+                );
+                grown.set(buffer.subarray(0, bufferLen));
+                buffer = grown;
+              }
+              buffer.set(chunk.value, bufferLen);
+              bufferLen += chunk.value.length;
+              continue;
+            }
+            const message = buffer.slice(0, match.index);
+            buffer.copyWithin(0, match.index + match.length, bufferLen);
+            bufferLen -= match.index + match.length;
+            if (buffer.length > 4096 && bufferLen <= buffer.length >> 2) {
+              // Release oversized capacity retained after an unusually large
+              // event so long-lived streams do not hold peak memory.
+              const shrunk = new Uint8Array(Math.max(4096, bufferLen * 2));
+              shrunk.set(buffer.subarray(0, bufferLen));
+              buffer = shrunk;
+            }
+            searchStart = 0;
+            const item = parseMessage(message, parse, state, dataRequired);
+            if (item && !item.done) return downstream.enqueue(item.value);
+            if (item?.done) {
+              await upstream.cancel("done");
+              return downstream.close();
+            }
+          }
+        } catch (e) {
+          downstream.error(e);
+          await upstream.cancel(e);
+        }
+      },
+      cancel: reason => upstream.cancel(reason),
+    });
+  }
+
+  // Use ReadableStream's iterator return type instead of `any` so stream events
+  // keep their generated type in for-await loops.
+  override [Symbol.asyncIterator](): ReturnType<
+    ReadableStream<T>[typeof Symbol.asyncIterator]
+  > {
+    const fn = (ReadableStream.prototype as any)[Symbol.asyncIterator];
+    if (typeof fn === "function") return fn.call(this);
+    const reader = this.getReader();
+    return {
+      next: async () => {
+        const r = await reader.read();
+        if (r.done) {
+          reader.releaseLock();
+          return { done: true, value: undefined };
+        }
+        return { done: false, value: r.value };
+      },
+      throw: async (e) => {
+        await reader.cancel(e);
+        reader.releaseLock();
+        return { done: true, value: undefined };
+      },
+      return: async () => {
+        await reader.cancel("done");
+        reader.releaseLock();
+        return { done: true, value: undefined };
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+    } as ReturnType<ReadableStream<T>[typeof Symbol.asyncIterator]>;
+  }
+}
+
+const CR = 13;
+const LF = 10;
+const BOUNDARIES = [
+  [CR, LF, CR, LF], // \r\n\r\n
+  [CR, LF, CR], // \r\n\r
+  [CR, LF, LF], // \r\n\n
+  [CR, CR, LF], // \r\r\n
+  [LF, CR, LF], // \n\r\n
+  [CR, CR], // \r\r
+  [LF, CR], // \n\r
+  [LF, LF], // \n\n
+];
+const MAX_BOUNDARY_LEN = BOUNDARIES.reduce((m, b) => Math.max(m, b.length), 0);
+
+function findBoundary(
+  buf: Uint8Array,
+  len: number,
+  from: number,
+): { index: number; length: number } | null {
+  for (let i = from; i < len; i++) {
+    if (buf[i] !== CR && buf[i] !== LF) continue;
+    for (const boundary of BOUNDARIES) {
+      if (i + boundary.length > len) continue;
+      let match = true;
+      for (let j = 0; j < boundary.length; j++) {
+        if (buf[i + j] !== boundary[j]) {
+          match = false;
+          break;
+        }
+      }
+      if (match) return { index: i, length: boundary.length };
+    }
+  }
+  return null;
+}
+function parseMessage<T extends SseMessage<unknown>>(
+  chunk: Uint8Array,
+  parse: (x: SseMessage<string>) => IteratorResult<T, undefined>,
+  state: { eventId: string | undefined },
+  dataRequired: boolean,
+) {
+  const text = new TextDecoder().decode(chunk);
+  const lines = text.split(/\r\n|\r|\n/);
+  const dataLines: string[] = [];
+  const ret: SseMessage<string> = {};
+  let ignore = true;
+  for (const line of lines) {
+    if (!line || line.startsWith(":")) continue;
+    ignore = false;
+    const i = line.indexOf(":");
+    let field = line;
+    let value = "";
+    if (i > 0) {
+      field = line.slice(0, i);
+      value = line[i + 1] === " " ? line.slice(i + 2) : line.slice(i + 1);
+    }
+    if (field === "data") dataLines.push(value);
+    else if (field === "event") ret.event = value;
+    else if (field === "id" && !value.includes("\0")) state.eventId = value;
+    else if (field === "retry" && /^\d+$/.test(value)) {
+      ret.retry = Number(value);
+    }
+  }
+  if (ignore) return;
+  ret.id = state.eventId;
+  if (dataLines.length) ret.data = dataLines.join("\n");
+  else if (dataRequired) return; // skip data-less events when data is required
+  return parse(ret);
+}

package/packages/orq-rc/src/lib/files.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Consumes a stream and returns a concatenated array buffer. Useful in
+ * situations where we need to read the whole file because it forms part of a
+ * larger payload containing other fields, and we can't modify the underlying
+ * request structure.
+ */
+export async function readableStreamToArrayBuffer(
+  readable: ReadableStream<Uint8Array>,
+): Promise<ArrayBuffer> {
+  const reader = readable.getReader();
+  const chunks: Uint8Array[] = [];
+
+  let totalLength = 0;
+  let done = false;
+
+  while (!done) {
+    const { value, done: doneReading } = await reader.read();
+
+    if (doneReading) {
+      done = true;
+    } else {
+      chunks.push(value);
+      totalLength += value.length;
+    }
+  }
+
+  const concatenatedChunks = new Uint8Array(totalLength);
+  let offset = 0;
+
+  for (const chunk of chunks) {
+    concatenatedChunks.set(chunk, offset);
+    offset += chunk.length;
+  }
+
+  return concatenatedChunks.buffer as ArrayBuffer;
+}
+
+/**
+ * Determines the MIME content type based on a file's extension.
+ * Returns null if the extension is not recognized.
+ */
+export function getContentTypeFromFileName(fileName: string): string | null {
+  if (!fileName) return null;
+
+  const ext = fileName.toLowerCase().split(".").pop();
+  if (!ext) return null;
+
+  const mimeTypes: Record<string, string> = {
+    json: "application/json",
+    xml: "application/xml",
+    html: "text/html",
+    htm: "text/html",
+    txt: "text/plain",
+    csv: "text/csv",
+    pdf: "application/pdf",
+    png: "image/png",
+    jpg: "image/jpeg",
+    jpeg: "image/jpeg",
+    gif: "image/gif",
+    svg: "image/svg+xml",
+    js: "application/javascript",
+    css: "text/css",
+    zip: "application/zip",
+    tar: "application/x-tar",
+    gz: "application/gzip",
+    mp4: "video/mp4",
+    mp3: "audio/mpeg",
+    wav: "audio/wav",
+    webp: "image/webp",
+    ico: "image/x-icon",
+    woff: "font/woff",
+    woff2: "font/woff2",
+    ttf: "font/ttf",
+    otf: "font/otf",
+  };
+
+  return mimeTypes[ext] || null;
+}
+
+/**
+ * Creates a Blob from file content with the given MIME type.
+ *
+ * Node.js Buffers are Uint8Array subclasses that may share a pooled
+ * ArrayBuffer (byteOffset > 0, byteLength < buffer.byteLength). Passing
+ * such a Buffer directly to `new Blob([buf])` can include the entire
+ * underlying pool on some runtimes, producing a Blob with extra bytes
+ * that corrupts multipart uploads.
+ *
+ * Copying into a standalone Uint8Array ensures the Blob receives only the
+ * intended bytes regardless of runtime behaviour.
+ */
+export function bytesToBlob(
+  content: Uint8Array<ArrayBufferLike> | ArrayBuffer | Blob | string,
+  contentType: string,
+): Blob {
+  if (content instanceof Uint8Array) {
+    return new Blob([new Uint8Array(content)], { type: contentType });
+  }
+  return new Blob([content as BlobPart], { type: contentType });
+}

package/packages/orq-rc/src/lib/http.ts

@@ -0,0 +1,323 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type Fetcher = (
+  input: RequestInfo | URL,
+  init?: RequestInit,
+) => Promise<Response>;
+
+export type Awaitable<T> = T | Promise<T>;
+
+const DEFAULT_FETCHER: Fetcher = (input, init) => {
+  // If input is a Request and init is undefined, Bun will discard the method,
+  // headers, body and other options that were set on the request object.
+  // Node.js and browers would ignore an undefined init value. This check is
+  // therefore needed for interop with Bun.
+  if (init == null) {
+    return fetch(input);
+  } else {
+    return fetch(input, init);
+  }
+};
+
+export type RequestInput = {
+  /**
+   * The URL the request will use.
+   */
+  url: URL;
+  /**
+   * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request).
+   */
+  options?: RequestInit | undefined;
+};
+
+export interface HTTPClientOptions {
+  fetcher?: Fetcher;
+}
+
+export type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
+export type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
+export type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
+
+export class HTTPClient {
+  private fetcher: Fetcher;
+  private requestHooks: BeforeRequestHook[] = [];
+  private requestErrorHooks: RequestErrorHook[] = [];
+  private responseHooks: ResponseHook[] = [];
+
+  constructor(private options: HTTPClientOptions = {}) {
+    this.fetcher = options.fetcher || DEFAULT_FETCHER;
+  }
+
+  async request(request: Request): Promise<Response> {
+    let req = request;
+    for (const hook of this.requestHooks) {
+      const nextRequest = await hook(req);
+      if (nextRequest) {
+        req = nextRequest;
+      }
+    }
+
+    try {
+      const res = await this.fetcher(req);
+
+      for (const hook of this.responseHooks) {
+        await hook(res, req);
+      }
+
+      return res;
+    } catch (err) {
+      for (const hook of this.requestErrorHooks) {
+        await hook(err, req);
+      }
+
+      throw err;
+    }
+  }
+
+  /**
+   * Registers a hook that is called before a request is made. The hook function
+   * can mutate the request or return a new request. This may be useful to add
+   * additional information to request such as request IDs and tracing headers.
+   */
+  addHook(hook: "beforeRequest", fn: BeforeRequestHook): this;
+  /**
+   * Registers a hook that is called when a request cannot be made due to a
+   * network error.
+   */
+  addHook(hook: "requestError", fn: RequestErrorHook): this;
+  /**
+   * Registers a hook that is called when a response has been received from the
+   * server.
+   */
+  addHook(hook: "response", fn: ResponseHook): this;
+  addHook(
+    ...args:
+      | [hook: "beforeRequest", fn: BeforeRequestHook]
+      | [hook: "requestError", fn: RequestErrorHook]
+      | [hook: "response", fn: ResponseHook]
+  ) {
+    if (args[0] === "beforeRequest") {
+      this.requestHooks.push(args[1]);
+    } else if (args[0] === "requestError") {
+      this.requestErrorHooks.push(args[1]);
+    } else if (args[0] === "response") {
+      this.responseHooks.push(args[1]);
+    } else {
+      throw new Error(`Invalid hook type: ${args[0]}`);
+    }
+    return this;
+  }
+
+  /** Removes a hook that was previously registered with `addHook`. */
+  removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this;
+  /** Removes a hook that was previously registered with `addHook`. */
+  removeHook(hook: "requestError", fn: RequestErrorHook): this;
+  /** Removes a hook that was previously registered with `addHook`. */
+  removeHook(hook: "response", fn: ResponseHook): this;
+  removeHook(
+    ...args:
+      | [hook: "beforeRequest", fn: BeforeRequestHook]
+      | [hook: "requestError", fn: RequestErrorHook]
+      | [hook: "response", fn: ResponseHook]
+  ): this {
+    let target: unknown[];
+    if (args[0] === "beforeRequest") {
+      target = this.requestHooks;
+    } else if (args[0] === "requestError") {
+      target = this.requestErrorHooks;
+    } else if (args[0] === "response") {
+      target = this.responseHooks;
+    } else {
+      throw new Error(`Invalid hook type: ${args[0]}`);
+    }
+
+    const index = target.findIndex((v) => v === args[1]);
+    if (index >= 0) {
+      target.splice(index, 1);
+    }
+
+    return this;
+  }
+
+  clone(): HTTPClient {
+    const child = new HTTPClient(this.options);
+    child.requestHooks = this.requestHooks.slice();
+    child.requestErrorHooks = this.requestErrorHooks.slice();
+    child.responseHooks = this.responseHooks.slice();
+
+    return child;
+  }
+}
+
+export type StatusCodePredicate = number | string | (number | string)[];
+
+// A semicolon surrounded by optional whitespace characters is used to separate
+// segments in a media type string.
+const mediaParamSeparator = /\s*;\s*/g;
+
+export function matchContentType(response: Response, pattern: string): boolean {
+  // `*` is a special case which means anything is acceptable.
+  if (pattern === "*") {
+    return true;
+  }
+
+  let contentType =
+    response.headers.get("content-type")?.trim() || "application/octet-stream";
+  contentType = contentType.toLowerCase();
+
+  const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator);
+  const [wantType = "", ...wantParams] = wantParts;
+
+  if (wantType.split("/").length !== 2) {
+    return false;
+  }
+
+  const gotParts = contentType.split(mediaParamSeparator);
+  const [gotType = "", ...gotParams] = gotParts;
+
+  const [type = "", subtype = ""] = gotType.split("/");
+  if (!type || !subtype) {
+    return false;
+  }
+
+  if (
+    wantType !== "*/*" &&
+    gotType !== wantType &&
+    `${type}/*` !== wantType &&
+    `*/${subtype}` !== wantType
+  ) {
+    return false;
+  }
+
+  if (gotParams.length < wantParams.length) {
+    return false;
+  }
+
+  const params = new Set(gotParams);
+  for (const wantParam of wantParams) {
+    if (!params.has(wantParam)) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+const codeRangeRE = new RegExp("^[0-9]xx$", "i");
+
+export function matchStatusCode(
+  response: Response,
+  codes: StatusCodePredicate,
+): boolean {
+  const actual = `${response.status}`;
+  const expectedCodes = Array.isArray(codes) ? codes : [codes];
+  if (!expectedCodes.length) {
+    return false;
+  }
+
+  return expectedCodes.some((ec) => {
+    const code = `${ec}`;
+
+    if (code === "default") {
+      return true;
+    }
+
+    if (!codeRangeRE.test(`${code}`)) {
+      return code === actual;
+    }
+
+    const expectFamily = code.charAt(0);
+    if (!expectFamily) {
+      throw new Error("Invalid status code range");
+    }
+
+    const actualFamily = actual.charAt(0);
+    if (!actualFamily) {
+      throw new Error(`Invalid response status code: ${actual}`);
+    }
+
+    return actualFamily === expectFamily;
+  });
+}
+
+export function matchResponse(
+  response: Response,
+  code: StatusCodePredicate,
+  contentTypePattern: string,
+): boolean {
+  return (
+    matchStatusCode(response, code) &&
+    matchContentType(response, contentTypePattern)
+  );
+}
+
+/**
+ * Uses various heurisitics to determine if an error is a connection error.
+ */
+export function isConnectionError(err: unknown): boolean {
+  if (typeof err !== "object" || err == null) {
+    return false;
+  }
+
+  // Covers fetch in Deno as well
+  const isBrowserErr =
+    err instanceof TypeError &&
+    err.message.toLowerCase().startsWith("failed to fetch");
+
+  const isNodeErr =
+    err instanceof TypeError &&
+    err.message.toLowerCase().startsWith("fetch failed");
+
+  const isBunErr = "name" in err && err.name === "ConnectionError";
+
+  const isGenericErr =
+    "code" in err &&
+    typeof err.code === "string" &&
+    err.code.toLowerCase() === "econnreset";
+
+  return isBrowserErr || isNodeErr || isGenericErr || isBunErr;
+}
+
+/**
+ * Uses various heurisitics to determine if an error is a timeout error.
+ */
+export function isTimeoutError(err: unknown): boolean {
+  if (typeof err !== "object" || err == null) {
+    return false;
+  }
+
+  // Fetch in browser, Node.js, Bun, Deno
+  const isNative = "name" in err && err.name === "TimeoutError";
+  const isLegacyNative = "code" in err && err.code === 23;
+
+  // Node.js HTTP client and Axios
+  const isGenericErr =
+    "code" in err &&
+    typeof err.code === "string" &&
+    err.code.toLowerCase() === "econnaborted";
+
+  return isNative || isLegacyNative || isGenericErr;
+}
+
+/**
+ * Uses various heurisitics to determine if an error is a abort error.
+ */
+export function isAbortError(err: unknown): boolean {
+  if (typeof err !== "object" || err == null) {
+    return false;
+  }
+
+  // Fetch in browser, Node.js, Bun, Deno
+  const isNative = "name" in err && err.name === "AbortError";
+  const isLegacyNative = "code" in err && err.code === 20;
+
+  // Node.js HTTP client and Axios
+  const isGenericErr =
+    "code" in err &&
+    typeof err.code === "string" &&
+    err.code.toLowerCase() === "econnaborted";
+
+  return isNative || isLegacyNative || isGenericErr;
+}

package/packages/orq-rc/src/lib/logger.ts

@@ -0,0 +1,9 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export interface Logger {
+  group(label?: string): void;
+  groupEnd(): void;
+  log(message: any, ...args: any[]): void;
+}