@s2-dev/streamstore 0.2.5

package/src/funcs/streamCheckTail.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { S2Core } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { CheckTailServerList } from "../models/operations/checktail.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Check the tail.
+ */
+export async function streamCheckTail(
+  client: S2Core,
+  request: operations.CheckTailRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.CheckTailResponse,
+    | errors.ErrorResponse
+    | errors.ErrorResponse
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.CheckTailRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const baseURL = options?.serverURL
+    || pathToFunc(CheckTailServerList[0], { charEncoding: "percent" })({
+      basin: "my-favorite-basin",
+    });
+
+  const pathParams = {
+    stream: encodeSimple("stream", payload.stream, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/streams/{stream}/records/tail")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "check_tail",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: baseURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.CheckTailResponse,
+    | errors.ErrorResponse
+    | errors.ErrorResponse
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.CheckTailResponse$inboundSchema),
+    M.jsonErr([400, 401, 404], errors.ErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.ErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/streamRead.ts

@@ -0,0 +1,163 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { S2Core } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { ReadServerList } from "../models/operations/read.js";
+import { Result } from "../types/fp.js";
+
+export enum ReadAcceptEnum {
+  applicationJson = "application/json",
+  textEventStream = "text/event-stream",
+}
+
+/**
+ * Retrieve a batch of records.
+ */
+export async function streamRead(
+  client: S2Core,
+  request: operations.ReadRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: ReadAcceptEnum },
+): Promise<
+  Result<
+    operations.ReadResponse,
+    | errors.ErrorResponse
+    | errors.ErrorResponse
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ReadRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const baseURL = options?.serverURL
+    || pathToFunc(ReadServerList[0], { charEncoding: "percent" })({
+      basin: "my-favorite-basin",
+    });
+
+  const pathParams = {
+    stream: encodeSimple("stream", payload.stream, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/streams/{stream}/records")(pathParams);
+
+  const query = encodeFormQuery({
+    "limit": payload.limit,
+    "start_seq_num": payload.start_seq_num,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/event-stream;q=0",
+    "s2-format": encodeSimple("s2-format", payload["s2-format"], {
+      explode: false,
+      charEncoding: "none",
+    }),
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "read",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: baseURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ReadResponse,
+    | errors.ErrorResponse
+    | errors.ErrorResponse
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.ReadResponse$inboundSchema),
+    M.sse(200, operations.ReadResponse$inboundSchema),
+    M.jsonErr([400, 401, 404], errors.ErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.ErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/hooks/hooks.ts

@@ -0,0 +1,132 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { RequestInput } from "../lib/http.js";
+import {
+  AfterErrorContext,
+  AfterErrorHook,
+  AfterSuccessContext,
+  AfterSuccessHook,
+  BeforeCreateRequestContext,
+  BeforeCreateRequestHook,
+  BeforeRequestContext,
+  BeforeRequestHook,
+  Hook,
+  Hooks,
+  SDKInitHook,
+  SDKInitOptions,
+} from "./types.js";
+
+import { initHooks } from "./registration.js";
+
+export class SDKHooks implements Hooks {
+  sdkInitHooks: SDKInitHook[] = [];
+  beforeCreateRequestHooks: BeforeCreateRequestHook[] = [];
+  beforeRequestHooks: BeforeRequestHook[] = [];
+  afterSuccessHooks: AfterSuccessHook[] = [];
+  afterErrorHooks: AfterErrorHook[] = [];
+
+  constructor() {
+    const presetHooks: Array<Hook> = [];
+
+    for (const hook of presetHooks) {
+      if ("sdkInit" in hook) {
+        this.registerSDKInitHook(hook);
+      }
+      if ("beforeCreateRequest" in hook) {
+        this.registerBeforeCreateRequestHook(hook);
+      }
+      if ("beforeRequest" in hook) {
+        this.registerBeforeRequestHook(hook);
+      }
+      if ("afterSuccess" in hook) {
+        this.registerAfterSuccessHook(hook);
+      }
+      if ("afterError" in hook) {
+        this.registerAfterErrorHook(hook);
+      }
+    }
+    initHooks(this);
+  }
+
+  registerSDKInitHook(hook: SDKInitHook) {
+    this.sdkInitHooks.push(hook);
+  }
+
+  registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) {
+    this.beforeCreateRequestHooks.push(hook);
+  }
+
+  registerBeforeRequestHook(hook: BeforeRequestHook) {
+    this.beforeRequestHooks.push(hook);
+  }
+
+  registerAfterSuccessHook(hook: AfterSuccessHook) {
+    this.afterSuccessHooks.push(hook);
+  }
+
+  registerAfterErrorHook(hook: AfterErrorHook) {
+    this.afterErrorHooks.push(hook);
+  }
+
+  sdkInit(opts: SDKInitOptions): SDKInitOptions {
+    return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts);
+  }
+
+  beforeCreateRequest(
+    hookCtx: BeforeCreateRequestContext,
+    input: RequestInput,
+  ): RequestInput {
+    let inp = input;
+
+    for (const hook of this.beforeCreateRequestHooks) {
+      inp = hook.beforeCreateRequest(hookCtx, inp);
+    }
+
+    return inp;
+  }
+
+  async beforeRequest(
+    hookCtx: BeforeRequestContext,
+    request: Request,
+  ): Promise<Request> {
+    let req = request;
+
+    for (const hook of this.beforeRequestHooks) {
+      req = await hook.beforeRequest(hookCtx, req);
+    }
+
+    return req;
+  }
+
+  async afterSuccess(
+    hookCtx: AfterSuccessContext,
+    response: Response,
+  ): Promise<Response> {
+    let res = response;
+
+    for (const hook of this.afterSuccessHooks) {
+      res = await hook.afterSuccess(hookCtx, res);
+    }
+
+    return res;
+  }
+
+  async afterError(
+    hookCtx: AfterErrorContext,
+    response: Response | null,
+    error: unknown,
+  ): Promise<{ response: Response | null; error: unknown }> {
+    let res = response;
+    let err = error;
+
+    for (const hook of this.afterErrorHooks) {
+      const result = await hook.afterError(hookCtx, res, err);
+      res = result.response;
+      err = result.error;
+    }
+
+    return { response: res, error: err };
+  }
+}

package/src/hooks/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./hooks.js";
+export * from "./types.js";

package/src/hooks/registration.ts

@@ -0,0 +1,14 @@
+import { Hooks } from "./types.js";
+
+/*
+ * This file is only ever generated once on the first generation and then is free to be modified.
+ * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
+ * in this file or in separate files in the hooks folder.
+ */
+
+// @ts-expect-error remove this line when you add your first hook and hooks is used
+export function initHooks(hooks: Hooks) {
+  // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
+  // with an instance of a hook that implements that specific Hook interface
+  // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+}

package/src/hooks/types.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { HTTPClient, RequestInput } from "../lib/http.js";
+import { RetryConfig } from "../lib/retries.js";
+import { SecurityState } from "../lib/security.js";
+
+export type HookContext = {
+  operationID: string;
+  oAuth2Scopes?: string[];
+  securitySource?: any | (() => Promise<any>);
+  retryConfig: RetryConfig;
+  resolvedSecurity: SecurityState | null;
+};
+
+export type Awaitable<T> = T | Promise<T>;
+
+export type SDKInitOptions = {
+  baseURL: URL | null;
+  client: HTTPClient;
+};
+
+export type BeforeCreateRequestContext = HookContext & {};
+export type BeforeRequestContext = HookContext & {};
+export type AfterSuccessContext = HookContext & {};
+export type AfterErrorContext = HookContext & {};
+
+/**
+ * SDKInitHook is called when the SDK is initializing. The
+ * hook can return a new baseURL and HTTP client to be used by the SDK.
+ */
+export interface SDKInitHook {
+  sdkInit: (opts: SDKInitOptions) => SDKInitOptions;
+}
+
+export interface BeforeCreateRequestHook {
+  /**
+   * A hook that is called before the SDK creates a `Request` object. The hook
+   * can modify how a request is constructed since certain modifications, like
+   * changing the request URL, cannot be done on a request object directly.
+   */
+  beforeCreateRequest: (
+    hookCtx: BeforeCreateRequestContext,
+    input: RequestInput,
+  ) => RequestInput;
+}
+
+export interface BeforeRequestHook {
+  /**
+   * A hook that is called before the SDK sends a request. The hook can
+   * introduce instrumentation code such as logging, tracing and metrics or
+   * replace the request before it is sent or throw an error to stop the
+   * request from being sent.
+   */
+  beforeRequest: (
+    hookCtx: BeforeRequestContext,
+    request: Request,
+  ) => Awaitable<Request>;
+}
+
+export interface AfterSuccessHook {
+  /**
+   * A hook that is called after the SDK receives a response. The hook can
+   * introduce instrumentation code such as logging, tracing and metrics or
+   * modify the response before it is handled or throw an error to stop the
+   * response from being handled.
+   */
+  afterSuccess: (
+    hookCtx: AfterSuccessContext,
+    response: Response,
+  ) => Awaitable<Response>;
+}
+
+export interface AfterErrorHook {
+  /**
+   * A hook that is called after the SDK encounters an error, or a
+   * non-successful response. The hook can introduce instrumentation code such
+   * as logging, tracing and metrics or modify the response or error values.
+   */
+  afterError: (
+    hookCtx: AfterErrorContext,
+    response: Response | null,
+    error: unknown,
+  ) => Awaitable<{
+    response: Response | null;
+    error: unknown;
+  }>;
+}
+
+export interface Hooks {
+  /** Registers a hook to be used by the SDK for initialization event. */
+  registerSDKInitHook(hook: SDKInitHook): void;
+  /** Registers a hook to be used by the SDK for to modify `Request` construction. */
+  registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
+  /** Registers a hook to be used by the SDK for the before request event. */
+  registerBeforeRequestHook(hook: BeforeRequestHook): void;
+  /** Registers a hook to be used by the SDK for the after success event. */
+  registerAfterSuccessHook(hook: AfterSuccessHook): void;
+  /** Registers a hook to be used by the SDK for the after error event. */
+  registerAfterErrorHook(hook: AfterErrorHook): void;
+}
+
+export type Hook =
+  | SDKInitHook
+  | BeforeCreateRequestHook
+  | BeforeRequestHook
+  | AfterSuccessHook
+  | AfterErrorHook;

package/src/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./lib/config.js";
+export * as files from "./lib/files.js";
+export * from "./sdk/sdk.js";

package/src/lib/base64.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function bytesToBase64(u8arr: Uint8Array): string {
+  return btoa(String.fromCodePoint(...u8arr));
+}
+
+export function bytesFromBase64(encoded: string): Uint8Array {
+  return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
+}
+
+export function stringToBytes(str: string): Uint8Array {
+  return new TextEncoder().encode(str);
+}
+
+export function stringFromBytes(u8arr: Uint8Array): string {
+  return new TextDecoder().decode(u8arr);
+}
+
+export function stringToBase64(str: string): string {
+  return bytesToBase64(stringToBytes(str));
+}
+
+export function stringFromBase64(b64str: string): string {
+  return stringFromBytes(bytesFromBase64(b64str));
+}
+
+export const zodOutbound = z
+  .instanceof(Uint8Array)
+  .or(z.string().transform(stringToBytes));
+
+export const zodInbound = z
+  .instanceof(Uint8Array)
+  .or(z.string().transform(bytesFromBase64));

package/src/lib/config.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { HTTPClient } from "./http.js";
+import { Logger } from "./logger.js";
+import { RetryConfig } from "./retries.js";
+import { Params, pathToFunc } from "./url.js";
+
+/**
+ * Contains the list of servers available to the SDK
+ */
+export const ServerList = [
+  "https://aws.s2.dev/v1alpha",
+] as const;
+
+export type SDKOptions = {
+  bearerAuth?: string | (() => Promise<string>);
+
+  httpClient?: HTTPClient;
+  /**
+   * Allows overriding the default server used by the SDK
+   */
+  serverIdx?: number;
+  /**
+   * Allows overriding the default server URL used by the SDK
+   */
+  serverURL?: string;
+  /**
+   * Allows overriding the default retry config used by the SDK
+   */
+  retryConfig?: RetryConfig;
+  timeoutMs?: number;
+  debugLogger?: Logger;
+};
+
+export function serverURLFromOptions(options: SDKOptions): URL | null {
+  let serverURL = options.serverURL;
+
+  const params: Params = {};
+
+  if (!serverURL) {
+    const serverIdx = options.serverIdx ?? 0;
+    if (serverIdx < 0 || serverIdx >= ServerList.length) {
+      throw new Error(`Invalid server index ${serverIdx}`);
+    }
+    serverURL = ServerList[serverIdx] || "";
+  }
+
+  const u = pathToFunc(serverURL)(params);
+  return new URL(u);
+}
+
+export const SDK_METADATA = {
+  language: "typescript",
+  openapiDocVersion: "1.0.0",
+  sdkVersion: "0.2.5",
+  genVersion: "2.497.8",
+  userAgent: "speakeasy-sdk/typescript 0.2.5 2.497.8 1.0.0 @s2-dev/streamstore",
+} as const;