@s2-dev/streamstore 0.2.5

package/src/lib/security.ts

@@ -0,0 +1,254 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as components from "../models/components/index.js";
+import { env } from "./env.js";
+
+type OAuth2PasswordFlow = {
+  username: string;
+  password?: string | undefined;
+  clientID: string;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
+
+export enum SecurityErrorCode {
+  Incomplete = "incomplete",
+  UnrecognisedSecurityType = "unrecognized_security_type",
+}
+
+export class SecurityError extends Error {
+  constructor(
+    public code: SecurityErrorCode,
+    message: string,
+  ) {
+    super(message);
+    this.name = "SecurityError";
+  }
+
+  static incomplete(): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.Incomplete,
+      "Security requirements not met in order to perform the operation",
+    );
+  }
+  static unrecognizedType(type: string): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.UnrecognisedSecurityType,
+      `Unrecognised security type: ${type}`,
+    );
+  }
+}
+
+export type SecurityState = {
+  basic: { username?: string | undefined; password?: string | undefined };
+  headers: Record<string, string>;
+  queryParams: Record<string, string>;
+  cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
+};
+
+type SecurityInputBasic = {
+  type: "http:basic";
+  value:
+    | { username?: string | undefined; password?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputBearer = {
+  type: "http:bearer";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputAPIKey = {
+  type: "apiKey:header" | "apiKey:query" | "apiKey:cookie";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOIDC = {
+  type: "openIdConnect";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2 = {
+  type: "oauth2";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2ClientCredentials = {
+  type: "oauth2:client_credentials";
+  value:
+    | { clientID?: string | undefined; clientSecret?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputOAuth2PasswordCredentials = {
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
+  fieldName: string;
+};
+
+type SecurityInputCustom = {
+  type: "http:custom";
+  value: any | null | undefined;
+  fieldName: string;
+};
+
+export type SecurityInput =
+  | SecurityInputBasic
+  | SecurityInputBearer
+  | SecurityInputAPIKey
+  | SecurityInputOAuth2
+  | SecurityInputOAuth2ClientCredentials
+  | SecurityInputOAuth2PasswordCredentials
+  | SecurityInputOIDC
+  | SecurityInputCustom;
+
+export function resolveSecurity(
+  ...options: SecurityInput[][]
+): SecurityState | null {
+  const state: SecurityState = {
+    basic: {},
+    headers: {},
+    queryParams: {},
+    cookies: {},
+    oauth2: { type: "none" },
+  };
+
+  const option = options.find((opts) => {
+    return opts.every((o) => {
+      if (o.value == null) {
+        return false;
+      } else if (o.type === "http:basic") {
+        return o.value.username != null || o.value.password != null;
+      } else if (o.type === "http:custom") {
+        return null;
+      } else if (o.type === "oauth2:password") {
+        return (
+          typeof o.value === "string" && !!o.value
+        );
+      } else if (o.type === "oauth2:client_credentials") {
+        return o.value.clientID != null || o.value.clientSecret != null;
+      } else if (typeof o.value === "string") {
+        return !!o.value;
+      } else {
+        throw new Error(
+          `Unrecognized security type: ${o.type} (value type: ${typeof o
+            .value})`,
+        );
+      }
+    });
+  });
+  if (option == null) {
+    return null;
+  }
+
+  option.forEach((spec) => {
+    if (spec.value == null) {
+      return;
+    }
+
+    const { type } = spec;
+
+    switch (type) {
+      case "apiKey:header":
+        state.headers[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:query":
+        state.queryParams[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:cookie":
+        state.cookies[spec.fieldName] = spec.value;
+        break;
+      case "http:basic":
+        applyBasic(state, spec);
+        break;
+      case "http:custom":
+        break;
+      case "http:bearer":
+        applyBearer(state, spec);
+        break;
+      case "oauth2":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:password":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:client_credentials":
+        break;
+      case "openIdConnect":
+        applyBearer(state, spec);
+        break;
+      default:
+        spec satisfies never;
+        throw SecurityError.unrecognizedType(type);
+    }
+  });
+
+  return state;
+}
+
+function applyBasic(
+  state: SecurityState,
+  spec: SecurityInputBasic,
+) {
+  if (spec.value == null) {
+    return;
+  }
+
+  state.basic = spec.value;
+}
+
+function applyBearer(
+  state: SecurityState,
+  spec:
+    | SecurityInputBearer
+    | SecurityInputOAuth2
+    | SecurityInputOIDC
+    | SecurityInputOAuth2PasswordCredentials,
+) {
+  if (typeof spec.value !== "string" || !spec.value) {
+    return;
+  }
+
+  let value = spec.value;
+  if (value.slice(0, 7).toLowerCase() !== "bearer ") {
+    value = `Bearer ${value}`;
+  }
+
+  state.headers[spec.fieldName] = value;
+}
+
+export function resolveGlobalSecurity(
+  security: Partial<components.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearerAuth ?? env().S2_BEARER_AUTH,
+      },
+    ],
+  );
+}
+
+export async function extractSecurity<
+  T extends string | Record<string, unknown>,
+>(sec: T | (() => Promise<T>) | undefined): Promise<T | undefined> {
+  if (sec == null) {
+    return;
+  }
+
+  return typeof sec === "function" ? sec() : sec;
+}

package/src/lib/url.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const hasOwn = Object.prototype.hasOwnProperty;
+
+export type Params = Partial<Record<string, string | number>>;
+
+export function pathToFunc(
+  pathPattern: string,
+  options?: { charEncoding?: "percent" | "none" },
+): (params?: Params) => string {
+  const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
+
+  return function buildURLPath(params: Record<string, unknown> = {}): string {
+    return pathPattern.replace(paramRE, function (_, placeholder) {
+      if (!hasOwn.call(params, placeholder)) {
+        throw new Error(`Parameter '${placeholder}' is required`);
+      }
+
+      const value = params[placeholder];
+      if (typeof value !== "string" && typeof value !== "number") {
+        throw new Error(
+          `Parameter '${placeholder}' must be a string or number`,
+        );
+      }
+
+      return options?.charEncoding === "percent"
+        ? encodeURIComponent(`${value}`)
+        : `${value}`;
+    });
+  };
+}

package/src/models/components/appendinput.ts

@@ -0,0 +1,102 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AppendRecord,
+  AppendRecord$inboundSchema,
+  AppendRecord$Outbound,
+  AppendRecord$outboundSchema,
+} from "./appendrecord.js";
+
+/**
+ * Input for append requests.
+ */
+export type AppendInput = {
+  /**
+   * Enforce a fencing token which must have been previously set by a `fence` command record.
+   */
+  fencingToken?: string | null | undefined;
+  /**
+   * Enforce that the sequence number issued to the first record matches.
+   */
+  matchSeqNum?: number | null | undefined;
+  /**
+   * Batch of records to append atomically, which must contain at least one record, and no more than 1000.
+   *
+   * @remarks
+   * The total size of a batch of records may not exceed 1MiB of metered bytes.
+   */
+  records: Array<AppendRecord>;
+};
+
+/** @internal */
+export const AppendInput$inboundSchema: z.ZodType<
+  AppendInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fencing_token: z.nullable(z.string()).optional(),
+  match_seq_num: z.nullable(z.number().int()).optional(),
+  records: z.array(AppendRecord$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "fencing_token": "fencingToken",
+    "match_seq_num": "matchSeqNum",
+  });
+});
+
+/** @internal */
+export type AppendInput$Outbound = {
+  fencing_token?: string | null | undefined;
+  match_seq_num?: number | null | undefined;
+  records: Array<AppendRecord$Outbound>;
+};
+
+/** @internal */
+export const AppendInput$outboundSchema: z.ZodType<
+  AppendInput$Outbound,
+  z.ZodTypeDef,
+  AppendInput
+> = z.object({
+  fencingToken: z.nullable(z.string()).optional(),
+  matchSeqNum: z.nullable(z.number().int()).optional(),
+  records: z.array(AppendRecord$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    fencingToken: "fencing_token",
+    matchSeqNum: "match_seq_num",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppendInput$ {
+  /** @deprecated use `AppendInput$inboundSchema` instead. */
+  export const inboundSchema = AppendInput$inboundSchema;
+  /** @deprecated use `AppendInput$outboundSchema` instead. */
+  export const outboundSchema = AppendInput$outboundSchema;
+  /** @deprecated use `AppendInput$Outbound` instead. */
+  export type Outbound = AppendInput$Outbound;
+}
+
+export function appendInputToJSON(appendInput: AppendInput): string {
+  return JSON.stringify(AppendInput$outboundSchema.parse(appendInput));
+}
+
+export function appendInputFromJSON(
+  jsonString: string,
+): SafeParseResult<AppendInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppendInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppendInput' from JSON`,
+  );
+}

package/src/models/components/appendoutput.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Output from append response.
+ */
+export type AppendOutput = {
+  /**
+   * Sequence number of last record appended + 1.
+   *
+   * @remarks
+   * `end_seq_num - start_seq_num` will be the number of records in the batch.
+   */
+  endSeqNum: number;
+  /**
+   * Sequence number of last durable record on the stream + 1.
+   *
+   * @remarks
+   * This can be greater than `end_seq_num` in case of concurrent appends.
+   */
+  nextSeqNum: number;
+  /**
+   * Sequence number of first record appended.
+   */
+  startSeqNum: number;
+};
+
+/** @internal */
+export const AppendOutput$inboundSchema: z.ZodType<
+  AppendOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  end_seq_num: z.number().int(),
+  next_seq_num: z.number().int(),
+  start_seq_num: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "end_seq_num": "endSeqNum",
+    "next_seq_num": "nextSeqNum",
+    "start_seq_num": "startSeqNum",
+  });
+});
+
+/** @internal */
+export type AppendOutput$Outbound = {
+  end_seq_num: number;
+  next_seq_num: number;
+  start_seq_num: number;
+};
+
+/** @internal */
+export const AppendOutput$outboundSchema: z.ZodType<
+  AppendOutput$Outbound,
+  z.ZodTypeDef,
+  AppendOutput
+> = z.object({
+  endSeqNum: z.number().int(),
+  nextSeqNum: z.number().int(),
+  startSeqNum: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    endSeqNum: "end_seq_num",
+    nextSeqNum: "next_seq_num",
+    startSeqNum: "start_seq_num",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppendOutput$ {
+  /** @deprecated use `AppendOutput$inboundSchema` instead. */
+  export const inboundSchema = AppendOutput$inboundSchema;
+  /** @deprecated use `AppendOutput$outboundSchema` instead. */
+  export const outboundSchema = AppendOutput$outboundSchema;
+  /** @deprecated use `AppendOutput$Outbound` instead. */
+  export type Outbound = AppendOutput$Outbound;
+}
+
+export function appendOutputToJSON(appendOutput: AppendOutput): string {
+  return JSON.stringify(AppendOutput$outboundSchema.parse(appendOutput));
+}
+
+export function appendOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<AppendOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppendOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppendOutput' from JSON`,
+  );
+}

package/src/models/components/appendrecord.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Record to be appended to a stream.
+ */
+export type AppendRecord = {
+  /**
+   * Body of this record.
+   */
+  body: string;
+  /**
+   * Series of name-value pairs for this record.
+   */
+  headers?: Array<Array<string>> | undefined;
+};
+
+/** @internal */
+export const AppendRecord$inboundSchema: z.ZodType<
+  AppendRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.string(),
+  headers: z.array(z.array(z.string())).optional(),
+});
+
+/** @internal */
+export type AppendRecord$Outbound = {
+  body: string;
+  headers?: Array<Array<string>> | undefined;
+};
+
+/** @internal */
+export const AppendRecord$outboundSchema: z.ZodType<
+  AppendRecord$Outbound,
+  z.ZodTypeDef,
+  AppendRecord
+> = z.object({
+  body: z.string(),
+  headers: z.array(z.array(z.string())).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppendRecord$ {
+  /** @deprecated use `AppendRecord$inboundSchema` instead. */
+  export const inboundSchema = AppendRecord$inboundSchema;
+  /** @deprecated use `AppendRecord$outboundSchema` instead. */
+  export const outboundSchema = AppendRecord$outboundSchema;
+  /** @deprecated use `AppendRecord$Outbound` instead. */
+  export type Outbound = AppendRecord$Outbound;
+}
+
+export function appendRecordToJSON(appendRecord: AppendRecord): string {
+  return JSON.stringify(AppendRecord$outboundSchema.parse(appendRecord));
+}
+
+export function appendRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<AppendRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppendRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppendRecord' from JSON`,
+  );
+}