@s2-dev/streamstore 0.11.1 → 0.12.0

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

@@ -0,0 +1,79 @@
+/*
+ * 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";
+
+export const CheckTailServerList = [
+  /**
+   * Endpoint for the basin
+   */
+  "https://{basin}.b.aws.s2.dev/v1",
+] as const;
+
+export type CheckTailRequest = {
+  /**
+   * Stream name, which must be unique within the basin.
+   *
+   * @remarks
+   * It can be an arbitrary string up to 512 characters.
+   */
+  stream: string;
+};
+
+/** @internal */
+export const CheckTailRequest$inboundSchema: z.ZodType<
+  CheckTailRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  stream: z.string(),
+});
+
+/** @internal */
+export type CheckTailRequest$Outbound = {
+  stream: string;
+};
+
+/** @internal */
+export const CheckTailRequest$outboundSchema: z.ZodType<
+  CheckTailRequest$Outbound,
+  z.ZodTypeDef,
+  CheckTailRequest
+> = z.object({
+  stream: 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 CheckTailRequest$ {
+  /** @deprecated use `CheckTailRequest$inboundSchema` instead. */
+  export const inboundSchema = CheckTailRequest$inboundSchema;
+  /** @deprecated use `CheckTailRequest$outboundSchema` instead. */
+  export const outboundSchema = CheckTailRequest$outboundSchema;
+  /** @deprecated use `CheckTailRequest$Outbound` instead. */
+  export type Outbound = CheckTailRequest$Outbound;
+}
+
+export function checkTailRequestToJSON(
+  checkTailRequest: CheckTailRequest,
+): string {
+  return JSON.stringify(
+    CheckTailRequest$outboundSchema.parse(checkTailRequest),
+  );
+}
+
+export function checkTailRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckTailRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckTailRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckTailRequest' from JSON`,
+  );
+}

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",
   });
 });
 

package/src/models/operations/createorreconfigurestream.ts

@@ -21,15 +21,14 @@ export type CreateOrReconfigureStreamRequest = {
    * 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;
   /**
    * Provide a client request token header for idempotent retry behaviour.
    */
   s2RequestToken?: string | undefined;
-  streamConfig: components.StreamConfig;
+  streamConfig?: components.StreamConfig | null | undefined;
 };
 
 /** @internal */
@@ -40,7 +39,7 @@ export const CreateOrReconfigureStreamRequest$inboundSchema: z.ZodType<
 > = z.object({
   stream: z.string(),
   "s2-request-token": z.string().optional(),
-  StreamConfig: components.StreamConfig$inboundSchema,
+  StreamConfig: z.nullable(components.StreamConfig$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "s2-request-token": "s2RequestToken",
@@ -52,7 +51,7 @@ export const CreateOrReconfigureStreamRequest$inboundSchema: z.ZodType<
 export type CreateOrReconfigureStreamRequest$Outbound = {
   stream: string;
   "s2-request-token"?: string | undefined;
-  StreamConfig: components.StreamConfig$Outbound;
+  StreamConfig?: components.StreamConfig$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -63,7 +62,7 @@ export const CreateOrReconfigureStreamRequest$outboundSchema: z.ZodType<
 > = z.object({
   stream: z.string(),
   s2RequestToken: z.string().optional(),
-  streamConfig: components.StreamConfig$outboundSchema,
+  streamConfig: z.nullable(components.StreamConfig$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     s2RequestToken: "s2-request-token",

package/src/models/operations/createstream.ts

@@ -0,0 +1,10 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export const CreateStreamServerList = [
+  /**
+   * Endpoint for the basin
+   */
+  "https://{basin}.b.aws.s2.dev/v1",
+] as const;

package/src/models/operations/deletestream.ts

@@ -19,8 +19,7 @@ export type DeleteStreamRequest = {
    * 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/getstreamconfig.ts

@@ -19,8 +19,7 @@ export type GetStreamConfigRequest = {
    * 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/index.ts

@@ -2,8 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./append.js";
+export * from "./checktail.js";
 export * from "./createorreconfigurebasin.js";
 export * from "./createorreconfigurestream.js";
+export * from "./createstream.js";
 export * from "./deletebasin.js";
 export * from "./deletestream.js";
 export * from "./getbasinconfig.js";
@@ -11,6 +14,7 @@ export * from "./getstreamconfig.js";
 export * from "./listaccesstokens.js";
 export * from "./listbasins.js";
 export * from "./liststreams.js";
+export * from "./read.js";
 export * from "./reconfigurebasin.js";
 export * from "./reconfigurestream.js";
 export * from "./revokeaccesstoken.js";

package/src/models/operations/listbasins.ts

@@ -19,7 +19,7 @@ export type ListBasinsRequest = {
    *
    * @remarks
    * This can be the last basin name seen in a previous listing, to continue from there.
-   * It must be greater than or equal to the prefix if specified.
+   * It must be greater than or equal to the `prefix` if that is specified.
    */
   startAfter?: string | undefined;
   /**

package/src/models/operations/read.ts

@@ -0,0 +1,195 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { EventStream } from "../../lib/event-streams.js";
+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 ReadServerList = [
+  /**
+   * Endpoint for the basin
+   */
+  "https://{basin}.b.aws.s2.dev/v1",
+] as const;
+
+export type ReadRequest = {
+  /**
+   * 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;
+  /**
+   * Start from a sequence number.
+   */
+  seqNum?: number | undefined;
+  /**
+   * Start from a timestamp.
+   */
+  timestamp?: number | undefined;
+  /**
+   * Start from number of records before the tail, i.e. before the next sequence number.
+   */
+  tailOffset?: number | undefined;
+  /**
+   * Limit total records to return.
+   */
+  count?: number | undefined;
+  /**
+   * Limit total metered bytes to return.
+   */
+  bytes?: number | undefined;
+};
+
+export type ReadResponse =
+  | components.ReadBatch
+  | EventStream<components.ReadEvent>;
+
+/** @internal */
+export const ReadRequest$inboundSchema: z.ZodType<
+  ReadRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  stream: z.string(),
+  "s2-format": components.S2Format$inboundSchema.optional(),
+  seq_num: z.number().int().optional(),
+  timestamp: z.number().int().optional(),
+  tail_offset: z.number().int().optional(),
+  count: z.number().int().optional(),
+  bytes: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "s2-format": "s2Format",
+    "seq_num": "seqNum",
+    "tail_offset": "tailOffset",
+  });
+});
+
+/** @internal */
+export type ReadRequest$Outbound = {
+  stream: string;
+  "s2-format"?: string | undefined;
+  seq_num?: number | undefined;
+  timestamp?: number | undefined;
+  tail_offset?: number | undefined;
+  count?: number | undefined;
+  bytes?: number | undefined;
+};
+
+/** @internal */
+export const ReadRequest$outboundSchema: z.ZodType<
+  ReadRequest$Outbound,
+  z.ZodTypeDef,
+  ReadRequest
+> = z.object({
+  stream: z.string(),
+  s2Format: components.S2Format$outboundSchema.optional(),
+  seqNum: z.number().int().optional(),
+  timestamp: z.number().int().optional(),
+  tailOffset: z.number().int().optional(),
+  count: z.number().int().optional(),
+  bytes: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    s2Format: "s2-format",
+    seqNum: "seq_num",
+    tailOffset: "tail_offset",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReadRequest$ {
+  /** @deprecated use `ReadRequest$inboundSchema` instead. */
+  export const inboundSchema = ReadRequest$inboundSchema;
+  /** @deprecated use `ReadRequest$outboundSchema` instead. */
+  export const outboundSchema = ReadRequest$outboundSchema;
+  /** @deprecated use `ReadRequest$Outbound` instead. */
+  export type Outbound = ReadRequest$Outbound;
+}
+
+export function readRequestToJSON(readRequest: ReadRequest): string {
+  return JSON.stringify(ReadRequest$outboundSchema.parse(readRequest));
+}
+
+export function readRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ReadRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReadRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReadRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReadResponse$inboundSchema: z.ZodType<
+  ReadResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.ReadBatch$inboundSchema,
+  z.instanceof(ReadableStream<Uint8Array>).transform(stream => {
+    return new EventStream({
+      stream,
+      decoder(rawEvent) {
+        const schema = components.ReadEvent$inboundSchema;
+        return schema.parse(rawEvent);
+      },
+    });
+  }),
+]);
+
+/** @internal */
+export type ReadResponse$Outbound = components.ReadBatch$Outbound | never;
+
+/** @internal */
+export const ReadResponse$outboundSchema: z.ZodType<
+  ReadResponse$Outbound,
+  z.ZodTypeDef,
+  ReadResponse
+> = z.union([components.ReadBatch$outboundSchema, z.never()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReadResponse$ {
+  /** @deprecated use `ReadResponse$inboundSchema` instead. */
+  export const inboundSchema = ReadResponse$inboundSchema;
+  /** @deprecated use `ReadResponse$outboundSchema` instead. */
+  export const outboundSchema = ReadResponse$outboundSchema;
+  /** @deprecated use `ReadResponse$Outbound` instead. */
+  export type Outbound = ReadResponse$Outbound;
+}
+
+export function readResponseToJSON(readResponse: ReadResponse): string {
+  return JSON.stringify(ReadResponse$outboundSchema.parse(readResponse));
+}
+
+export function readResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ReadResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReadResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReadResponse' from JSON`,
+  );
+}

package/src/models/operations/reconfigurestream.ts

@@ -21,8 +21,7 @@ export type ReconfigureStreamRequest = {
    * 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;
   streamReconfiguration: components.StreamReconfiguration;

package/src/models/operations/revokeaccesstoken.ts

@@ -12,7 +12,7 @@ export type RevokeAccessTokenRequest = {
    * Access token ID.
    *
    * @remarks
-   * It must be unique to the account and between 1 and 50 characters.
+   * It must be unique to the account and between 1 and 96 characters.
    */
   id: string;
 };

package/src/sdk/basins.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { basinsCreateBasin } from "../funcs/basinsCreateBasin.js";
 import { basinsCreateOrReconfigureBasin } from "../funcs/basinsCreateOrReconfigureBasin.js";
 import { basinsDeleteBasin } from "../funcs/basinsDeleteBasin.js";
 import { basinsGetBasinConfig } from "../funcs/basinsGetBasinConfig.js";
@@ -28,6 +29,20 @@ export class Basins extends ClientSDK {
     ));
   }
 
+  /**
+   * Create a basin.
+   */
+  async createBasin(
+    request: components.CreateBasinRequest,
+    options?: RequestOptions,
+  ): Promise<components.BasinInfo> {
+    return unwrapAsync(basinsCreateBasin(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get basin config.
    */