@s2-dev/streamstore 0.2.5

package/src/lib/event-streams.ts

@@ -0,0 +1,264 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type ServerEvent<T> = {
+  data?: T | undefined;
+  event?: string | undefined;
+  retry?: number | undefined;
+  id?: string | undefined;
+};
+const LF = 0x0a;
+const CR = 0x0d;
+const NEWLINE_CHARS = new Set([LF, CR]);
+const MESSAGE_BOUNDARIES = [
+  new Uint8Array([CR, LF, CR, LF]),
+  new Uint8Array([CR, CR]),
+  new Uint8Array([LF, LF]),
+];
+
+export class EventStream<Event extends ServerEvent<unknown>> {
+  private readonly stream: ReadableStream<Uint8Array>;
+  private readonly decoder: (rawEvent: ServerEvent<string>) => Event;
+
+  constructor(init: {
+    stream: ReadableStream<Uint8Array>;
+    decoder: (rawEvent: ServerEvent<string>) => Event;
+  }) {
+    this.stream = init.stream;
+    this.decoder = init.decoder;
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Event, void, unknown> {
+    const reader = this.stream.getReader();
+    let buffer = new Uint8Array([]);
+    let position = 0;
+
+    try {
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done) {
+          break;
+        }
+
+        const newBuffer = new Uint8Array(buffer.length + value.length);
+        newBuffer.set(buffer);
+        newBuffer.set(value, buffer.length);
+        buffer = newBuffer;
+
+        for (let i = position; i < buffer.length; i++) {
+          const boundary = findBoundary(buffer, i);
+          if (boundary == null) {
+            continue;
+          }
+
+          const chunk = buffer.slice(position, i);
+          position = i + boundary.length;
+          const event = parseEvent(chunk, this.decoder);
+          if (event != null) {
+            yield event;
+          }
+        }
+
+        if (position > 0) {
+          buffer = buffer.slice(position);
+          position = 0;
+        }
+      }
+
+      if (buffer.length > 0) {
+        const event = parseEvent(buffer, this.decoder);
+        if (event != null) {
+          yield event;
+        }
+      }
+    } catch (e: unknown) {
+      if (e instanceof Error && e.name === "AbortError") {
+        return;
+      }
+
+      throw e;
+    } finally {
+      reader.releaseLock();
+    }
+  }
+}
+
+function findBoundary(buffer: Uint8Array, start: number): Uint8Array | null {
+  const char1 = buffer[start];
+  const char2 = buffer[start + 1];
+
+  // Don't bother checking if the first two characters are not new line
+  // characters.
+  if (
+    char1 == null
+    || char2 == null
+    || !NEWLINE_CHARS.has(char1)
+    || !NEWLINE_CHARS.has(char2)
+  ) {
+    return null;
+  }
+
+  for (const s of MESSAGE_BOUNDARIES) {
+    const seq = peekSequence(start, buffer, s);
+    if (seq != null) {
+      return seq;
+    }
+  }
+
+  return null;
+}
+
+function peekSequence(
+  position: number,
+  buffer: Uint8Array,
+  sequence: Uint8Array,
+): Uint8Array | null {
+  if (sequence.length > buffer.length - position) {
+    return null;
+  }
+
+  for (let i = 0; i < sequence.length; i++) {
+    if (buffer[position + i] !== sequence[i]) {
+      return null;
+    }
+  }
+
+  return sequence;
+}
+
+function parseEvent<Event extends ServerEvent<unknown>>(
+  chunk: Uint8Array,
+  decoder: (rawEvent: ServerEvent<string>) => Event,
+) {
+  if (!chunk.length) {
+    return null;
+  }
+
+  const td = new TextDecoder();
+  const raw = td.decode(chunk);
+  const lines = raw.split(/\r?\n|\r/g);
+  let publish = false;
+  const rawEvent: ServerEvent<string> = {};
+
+  for (const line of lines) {
+    if (!line) {
+      continue;
+    }
+
+    const delim = line.indexOf(":");
+    // Lines starting with a colon are ignored.
+    if (delim === 0) {
+      continue;
+    }
+
+    const field = delim > 0 ? line.substring(0, delim) : "";
+    let value = delim > 0 ? line.substring(delim + 1) : "";
+    if (value.charAt(0) === " ") {
+      value = value.substring(1);
+    }
+
+    switch (field) {
+      case "event": {
+        publish = true;
+        rawEvent.event = value;
+        break;
+      }
+      case "data": {
+        publish = true;
+        rawEvent.data ??= "";
+        rawEvent.data += value + "\n";
+        break;
+      }
+      case "id": {
+        publish = true;
+        rawEvent.id = value;
+        break;
+      }
+      case "retry": {
+        const r = parseInt(value, 10);
+        if (!Number.isNaN(r)) {
+          publish = true;
+          rawEvent.retry = r;
+        }
+        break;
+      }
+    }
+  }
+
+  if (!publish) {
+    return null;
+  }
+
+  if (rawEvent.data != null) {
+    rawEvent.data = rawEvent.data.slice(0, -1);
+  }
+
+  return decoder(rawEvent);
+}
+
+export function discardSentinel(
+  stream: ReadableStream<Uint8Array>,
+  sentinel: string,
+): ReadableStream<Uint8Array> {
+  return new ReadableStream<Uint8Array>({
+    async start(controller) {
+      let buffer = new Uint8Array([]);
+      let position = 0;
+      let done = false;
+      let discard = false;
+      const rdr = stream.getReader();
+      try {
+        while (!done) {
+          const result = await rdr.read();
+          const value = result.value;
+          done = done || result.done;
+          // We keep consuming from the source to its completion so it can
+          // flush all its contents and release resources.
+          if (discard) {
+            continue;
+          }
+          if (typeof value === "undefined") {
+            continue;
+          }
+
+          const newBuffer = new Uint8Array(buffer.length + value.length);
+          newBuffer.set(buffer);
+          newBuffer.set(value, buffer.length);
+          buffer = newBuffer;
+
+          for (let i = position; i < buffer.length; i++) {
+            const boundary = findBoundary(buffer, i);
+            if (boundary == null) {
+              continue;
+            }
+
+            const start = position;
+            const chunk = buffer.slice(start, i);
+            position = i + boundary.length;
+            const event = parseEvent(chunk, id);
+            if (event?.data === sentinel) {
+              controller.enqueue(buffer.slice(0, start));
+              discard = true;
+            } else {
+              controller.enqueue(buffer.slice(0, position));
+              buffer = buffer.slice(position);
+              position = 0;
+            }
+          }
+        }
+      } catch (e) {
+        controller.error(e);
+      } finally {
+        // If the source stream terminates, flush its contents and terminate.
+        // If the sentinel event was found, flush everything up to its start.
+        controller.close();
+        rdr.releaseLock();
+      }
+    },
+  });
+}
+
+function id<T>(v: T): T {
+  return v;
+}

package/src/lib/files.ts

@@ -0,0 +1,40 @@
+/*
+ * 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;
+}

package/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/src/lib/is-plain-object.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/*
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+// Taken from https://github.com/sindresorhus/is-plain-obj/blob/97f38e8836f86a642cce98fc6ab3058bc36df181/index.js
+
+export function isPlainObject(value: unknown): value is object {
+  if (typeof value !== "object" || value === null) {
+    return false;
+  }
+
+  const prototype = Object.getPrototypeOf(value);
+  return (
+    (prototype === null ||
+      prototype === Object.prototype ||
+      Object.getPrototypeOf(prototype) === null) &&
+    !(Symbol.toStringTag in value) &&
+    !(Symbol.iterator in value)
+  );
+}

package/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;
+}