@s2-dev/streamstore 0.11.2 → 0.12.0

package/src/models/components/tailresponse.ts

@@ -0,0 +1,71 @@
+/*
+ * 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";
+import {
+  StreamPosition,
+  StreamPosition$inboundSchema,
+  StreamPosition$Outbound,
+  StreamPosition$outboundSchema,
+} from "./streamposition.js";
+
+export type TailResponse = {
+  /**
+   * Position of a record in a stream.
+   */
+  tail: StreamPosition;
+};
+
+/** @internal */
+export const TailResponse$inboundSchema: z.ZodType<
+  TailResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tail: StreamPosition$inboundSchema,
+});
+
+/** @internal */
+export type TailResponse$Outbound = {
+  tail: StreamPosition$Outbound;
+};
+
+/** @internal */
+export const TailResponse$outboundSchema: z.ZodType<
+  TailResponse$Outbound,
+  z.ZodTypeDef,
+  TailResponse
+> = z.object({
+  tail: StreamPosition$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TailResponse$ {
+  /** @deprecated use `TailResponse$inboundSchema` instead. */
+  export const inboundSchema = TailResponse$inboundSchema;
+  /** @deprecated use `TailResponse$outboundSchema` instead. */
+  export const outboundSchema = TailResponse$outboundSchema;
+  /** @deprecated use `TailResponse$Outbound` instead. */
+  export type Outbound = TailResponse$Outbound;
+}
+
+export function tailResponseToJSON(tailResponse: TailResponse): string {
+  return JSON.stringify(TailResponse$outboundSchema.parse(tailResponse));
+}
+
+export function tailResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TailResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TailResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TailResponse' from JSON`,
+  );
+}

package/src/models/errors/appendconditionfailed.ts

@@ -0,0 +1,249 @@
+/*
+ * 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 "./sdkvalidationerror.js";
+
+/**
+ * Sequence number did not match the tail of the stream.
+ *
+ * @remarks
+ * The expected next sequence number is returned.
+ */
+export type TwoData = {
+  /**
+   * Sequence number did not match the tail of the stream.
+   *
+   * @remarks
+   * The expected next sequence number is returned.
+   */
+  seqNumMismatch: number;
+};
+
+/**
+ * Sequence number did not match the tail of the stream.
+ *
+ * @remarks
+ * The expected next sequence number is returned.
+ */
+export class Two extends Error {
+  /**
+   * Sequence number did not match the tail of the stream.
+   *
+   * @remarks
+   * The expected next sequence number is returned.
+   */
+  seqNumMismatch: number;
+
+  /** The original data that was passed to this error instance. */
+  data$: TwoData;
+
+  constructor(err: TwoData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.seqNumMismatch = err.seqNumMismatch;
+
+    this.name = "Two";
+  }
+}
+
+/**
+ * Fencing token did not match.
+ *
+ * @remarks
+ * The expected fencing token is returned.
+ */
+export type OneData = {
+  /**
+   * Fencing token did not match.
+   *
+   * @remarks
+   * The expected fencing token is returned.
+   */
+  fencingTokenMismatch: string;
+};
+
+/**
+ * Fencing token did not match.
+ *
+ * @remarks
+ * The expected fencing token is returned.
+ */
+export class One extends Error {
+  /**
+   * Fencing token did not match.
+   *
+   * @remarks
+   * The expected fencing token is returned.
+   */
+  fencingTokenMismatch: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: OneData;
+
+  constructor(err: OneData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.fencingTokenMismatch = err.fencingTokenMismatch;
+
+    this.name = "One";
+  }
+}
+
+/**
+ * Failure response message when an Append is aborted due to a failed condition.
+ */
+export type AppendConditionFailed = One | Two;
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    SeqNumMismatch: z.number().int(),
+  })
+  .transform((v) => {
+    const remapped = remap$(v, {
+      "SeqNumMismatch": "seqNumMismatch",
+    });
+
+    return new Two(remapped);
+  });
+
+/** @internal */
+export type Two$Outbound = {
+  SeqNumMismatch: number;
+};
+
+/** @internal */
+export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
+  .instanceof(Two)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      seqNumMismatch: z.number().int(),
+    }).transform((v) => {
+      return remap$(v, {
+        seqNumMismatch: "SeqNumMismatch",
+      });
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Two$ {
+  /** @deprecated use `Two$inboundSchema` instead. */
+  export const inboundSchema = Two$inboundSchema;
+  /** @deprecated use `Two$outboundSchema` instead. */
+  export const outboundSchema = Two$outboundSchema;
+  /** @deprecated use `Two$Outbound` instead. */
+  export type Outbound = Two$Outbound;
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    FencingTokenMismatch: z.string(),
+  })
+  .transform((v) => {
+    const remapped = remap$(v, {
+      "FencingTokenMismatch": "fencingTokenMismatch",
+    });
+
+    return new One(remapped);
+  });
+
+/** @internal */
+export type One$Outbound = {
+  FencingTokenMismatch: string;
+};
+
+/** @internal */
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
+  .instanceof(One)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      fencingTokenMismatch: z.string(),
+    }).transform((v) => {
+      return remap$(v, {
+        fencingTokenMismatch: "FencingTokenMismatch",
+      });
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace One$ {
+  /** @deprecated use `One$inboundSchema` instead. */
+  export const inboundSchema = One$inboundSchema;
+  /** @deprecated use `One$outboundSchema` instead. */
+  export const outboundSchema = One$outboundSchema;
+  /** @deprecated use `One$Outbound` instead. */
+  export type Outbound = One$Outbound;
+}
+
+/** @internal */
+export const AppendConditionFailed$inboundSchema: z.ZodType<
+  AppendConditionFailed,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+
+/** @internal */
+export type AppendConditionFailed$Outbound = One$Outbound | Two$Outbound;
+
+/** @internal */
+export const AppendConditionFailed$outboundSchema: z.ZodType<
+  AppendConditionFailed$Outbound,
+  z.ZodTypeDef,
+  AppendConditionFailed
+> = z.union([
+  z.lazy(() => One$outboundSchema),
+  z.lazy(() => Two$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppendConditionFailed$ {
+  /** @deprecated use `AppendConditionFailed$inboundSchema` instead. */
+  export const inboundSchema = AppendConditionFailed$inboundSchema;
+  /** @deprecated use `AppendConditionFailed$outboundSchema` instead. */
+  export const outboundSchema = AppendConditionFailed$outboundSchema;
+  /** @deprecated use `AppendConditionFailed$Outbound` instead. */
+  export type Outbound = AppendConditionFailed$Outbound;
+}
+
+export function appendConditionFailedToJSON(
+  appendConditionFailed: AppendConditionFailed,
+): string {
+  return JSON.stringify(
+    AppendConditionFailed$outboundSchema.parse(appendConditionFailed),
+  );
+}
+
+export function appendConditionFailedFromJSON(
+  jsonString: string,
+): SafeParseResult<AppendConditionFailed, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppendConditionFailed$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppendConditionFailed' from JSON`,
+  );
+}

package/src/models/errors/index.ts

@@ -3,7 +3,10 @@
  */
 
 export * from "./apierror.js";
+export * from "./appendconditionfailed.js";
 export * from "./errorresponse.js";
 export * from "./httpclienterrors.js";
+export * from "./notfounderror.js";
 export * from "./retryableerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./tailresponse.js";

package/src/models/errors/notfounderror.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type NotFoundErrorData = {
+  error: string;
+};
+
+export class NotFoundError extends Error {
+  error: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: NotFoundErrorData;
+
+  constructor(err: NotFoundErrorData) {
+    const message = err.error || "API error occurred";
+    super(message);
+    this.data$ = err;
+
+    this.error = err.error;
+
+    this.name = "NotFoundError";
+  }
+}
+
+/** @internal */
+export const NotFoundError$inboundSchema: z.ZodType<
+  NotFoundError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+})
+  .transform((v) => {
+    return new NotFoundError(v);
+  });
+
+/** @internal */
+export type NotFoundError$Outbound = {
+  error: string;
+};
+
+/** @internal */
+export const NotFoundError$outboundSchema: z.ZodType<
+  NotFoundError$Outbound,
+  z.ZodTypeDef,
+  NotFoundError
+> = z.instanceof(NotFoundError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotFoundError$ {
+  /** @deprecated use `NotFoundError$inboundSchema` instead. */
+  export const inboundSchema = NotFoundError$inboundSchema;
+  /** @deprecated use `NotFoundError$outboundSchema` instead. */
+  export const outboundSchema = NotFoundError$outboundSchema;
+  /** @deprecated use `NotFoundError$Outbound` instead. */
+  export type Outbound = NotFoundError$Outbound;
+}

package/src/models/errors/tailresponse.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+
+export type TailResponseData = {
+  /**
+   * Position of a record in a stream.
+   */
+  tail: components.StreamPosition;
+};
+
+export class TailResponse extends Error {
+  /**
+   * Position of a record in a stream.
+   */
+  tail: components.StreamPosition;
+
+  /** The original data that was passed to this error instance. */
+  data$: TailResponseData;
+
+  constructor(err: TailResponseData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.tail = err.tail;
+
+    this.name = "TailResponse";
+  }
+}
+
+/** @internal */
+export const TailResponse$inboundSchema: z.ZodType<
+  TailResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tail: components.StreamPosition$inboundSchema,
+})
+  .transform((v) => {
+    return new TailResponse(v);
+  });
+
+/** @internal */
+export type TailResponse$Outbound = {
+  tail: components.StreamPosition$Outbound;
+};
+
+/** @internal */
+export const TailResponse$outboundSchema: z.ZodType<
+  TailResponse$Outbound,
+  z.ZodTypeDef,
+  TailResponse
+> = z.instanceof(TailResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    tail: components.StreamPosition$outboundSchema,
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TailResponse$ {
+  /** @deprecated use `TailResponse$inboundSchema` instead. */
+  export const inboundSchema = TailResponse$inboundSchema;
+  /** @deprecated use `TailResponse$outboundSchema` instead. */
+  export const outboundSchema = TailResponse$outboundSchema;
+  /** @deprecated use `TailResponse$Outbound` instead. */
+  export type Outbound = TailResponse$Outbound;
+}

package/src/models/operations/append.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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const AppendServerList = [
+  /**
+   * Endpoint for the basin
+   */
+  "https://{basin}.b.aws.s2.dev/v1",
+] as const;
+
+export type AppendRequest = {
+  /**
+   * Stream name, which must be unique within the basin.
+   *
+   * @remarks
+   * It can be an arbitrary string up to 512 characters.
+   */
+  stream: string;
+  /**
+   * Recognized when the Content-Type is `application/json`.
+   *
+   * @remarks
+   * json: UTF-8 data
+   * json-binsafe: Base64-encoded binary data
+   */
+  s2Format?: components.S2Format | undefined;
+  appendInput: components.AppendInput;
+};
+
+/** @internal */
+export const AppendRequest$inboundSchema: z.ZodType<
+  AppendRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  stream: z.string(),
+  "s2-format": components.S2Format$inboundSchema.optional(),
+  AppendInput: components.AppendInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "s2-format": "s2Format",
+    "AppendInput": "appendInput",
+  });
+});
+
+/** @internal */
+export type AppendRequest$Outbound = {
+  stream: string;
+  "s2-format"?: string | undefined;
+  AppendInput: components.AppendInput$Outbound;
+};
+
+/** @internal */
+export const AppendRequest$outboundSchema: z.ZodType<
+  AppendRequest$Outbound,
+  z.ZodTypeDef,
+  AppendRequest
+> = z.object({
+  stream: z.string(),
+  s2Format: components.S2Format$outboundSchema.optional(),
+  appendInput: components.AppendInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    s2Format: "s2-format",
+    appendInput: "AppendInput",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppendRequest$ {
+  /** @deprecated use `AppendRequest$inboundSchema` instead. */
+  export const inboundSchema = AppendRequest$inboundSchema;
+  /** @deprecated use `AppendRequest$outboundSchema` instead. */
+  export const outboundSchema = AppendRequest$outboundSchema;
+  /** @deprecated use `AppendRequest$Outbound` instead. */
+  export type Outbound = AppendRequest$Outbound;
+}
+
+export function appendRequestToJSON(appendRequest: AppendRequest): string {
+  return JSON.stringify(AppendRequest$outboundSchema.parse(appendRequest));
+}
+
+export function appendRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AppendRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppendRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppendRequest' from JSON`,
+  );
+}

package/src/models/operations/checktail.ts

@@ -19,8 +19,7 @@ export type CheckTailRequest = {
    * Stream name, which must be unique within the basin.
    *
    * @remarks
-   * It can be an arbitrary string upto 512 characters.
-   * Backslash (`/`) is recommended as a delimiter for hierarchical naming.
+   * It can be an arbitrary string up to 512 characters.
    */
   stream: string;
 };

package/src/models/operations/createorreconfigurebasin.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CreateOrReconfigureBasinRequest = {
+  /**
+   * Provide a client request token header for idempotent retry behaviour.
+   */
+  s2RequestToken?: string | undefined;
   /**
    * Basin name, which must be globally unique.
    *
@@ -18,11 +22,10 @@ export type CreateOrReconfigureBasinRequest = {
    * letters, numbers and hyphens. It cannot begin or end with a hyphen.
    */
   basin: string;
-  /**
-   * Provide a client request token header for idempotent retry behaviour.
-   */
-  s2RequestToken?: string | undefined;
-  createBasinRequest: components.CreateBasinRequest;
+  createOrReconfigureBasinRequest?:
+    | components.CreateOrReconfigureBasinRequest
+    | null
+    | undefined;
 };
 
 /** @internal */
@@ -31,21 +34,26 @@ export const CreateOrReconfigureBasinRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  basin: z.string(),
   "s2-request-token": z.string().optional(),
-  CreateBasinRequest: components.CreateBasinRequest$inboundSchema,
+  basin: z.string(),
+  CreateOrReconfigureBasinRequest: z.nullable(
+    components.CreateOrReconfigureBasinRequest$inboundSchema,
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "s2-request-token": "s2RequestToken",
-    "CreateBasinRequest": "createBasinRequest",
+    "CreateOrReconfigureBasinRequest": "createOrReconfigureBasinRequest",
   });
 });
 
 /** @internal */
 export type CreateOrReconfigureBasinRequest$Outbound = {
-  basin: string;
   "s2-request-token"?: string | undefined;
-  CreateBasinRequest: components.CreateBasinRequest$Outbound;
+  basin: string;
+  CreateOrReconfigureBasinRequest?:
+    | components.CreateOrReconfigureBasinRequest$Outbound
+    | null
+    | undefined;
 };
 
 /** @internal */
@@ -54,13 +62,15 @@ export const CreateOrReconfigureBasinRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateOrReconfigureBasinRequest
 > = z.object({
-  basin: z.string(),
   s2RequestToken: z.string().optional(),
-  createBasinRequest: components.CreateBasinRequest$outboundSchema,
+  basin: z.string(),
+  createOrReconfigureBasinRequest: z.nullable(
+    components.CreateOrReconfigureBasinRequest$outboundSchema,
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     s2RequestToken: "s2-request-token",
-    createBasinRequest: "CreateBasinRequest",
+    createOrReconfigureBasinRequest: "CreateOrReconfigureBasinRequest",
   });
 });