@s2-dev/streamstore 0.13.3 → 0.14.0

package/src/models/components/readevent.ts

@@ -4,8 +4,15 @@
 
 import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PingEventData,
+  PingEventData$inboundSchema,
+  PingEventData$Outbound,
+  PingEventData$outboundSchema,
+} from "./pingeventdata.js";
 import {
   ReadBatch,
   ReadBatch$inboundSchema,
@@ -13,41 +20,88 @@ import {
   ReadBatch$outboundSchema,
 } from "./readbatch.js";
 
+export const ReadEvent3Event = {
+  Ping: "ping",
+} as const;
+export type ReadEvent3Event = ClosedEnum<typeof ReadEvent3Event>;
+
 export type Ping = {
-  data: string;
-  event: string;
+  data: PingEventData;
+  event: ReadEvent3Event;
 };
 
+export const ReadEventEvent = {
+  Error: "error",
+} as const;
+export type ReadEventEvent = ClosedEnum<typeof ReadEventEvent>;
+
 export type ErrorT = {
   data: string;
-  event: string;
+  event: ReadEventEvent;
 };
 
+export const Event = {
+  Batch: "batch",
+} as const;
+export type Event = ClosedEnum<typeof Event>;
+
 export type Batch = {
   data: ReadBatch;
-  event: string;
+  event: Event;
+  id: string;
 };
 
-export type ReadEvent = Batch | ErrorT | Ping;
+export type ReadEvent = ErrorT | Ping | Batch;
+
+/** @internal */
+export const ReadEvent3Event$inboundSchema: z.ZodNativeEnum<
+  typeof ReadEvent3Event
+> = z.nativeEnum(ReadEvent3Event);
+
+/** @internal */
+export const ReadEvent3Event$outboundSchema: z.ZodNativeEnum<
+  typeof ReadEvent3Event
+> = ReadEvent3Event$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReadEvent3Event$ {
+  /** @deprecated use `ReadEvent3Event$inboundSchema` instead. */
+  export const inboundSchema = ReadEvent3Event$inboundSchema;
+  /** @deprecated use `ReadEvent3Event$outboundSchema` instead. */
+  export const outboundSchema = ReadEvent3Event$outboundSchema;
+}
 
 /** @internal */
 export const Ping$inboundSchema: z.ZodType<Ping, z.ZodTypeDef, unknown> = z
   .object({
-    data: z.string(),
-    event: z.string(),
+    data: z.string().transform((v, ctx) => {
+      try {
+        return JSON.parse(v);
+      } catch (err) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: `malformed json: ${err}`,
+        });
+        return z.NEVER;
+      }
+    }).pipe(PingEventData$inboundSchema),
+    event: ReadEvent3Event$inboundSchema,
   });
 
 /** @internal */
 export type Ping$Outbound = {
-  data: string;
+  data: PingEventData$Outbound;
   event: string;
 };
 
 /** @internal */
 export const Ping$outboundSchema: z.ZodType<Ping$Outbound, z.ZodTypeDef, Ping> =
   z.object({
-    data: z.string(),
-    event: z.string(),
+    data: PingEventData$outboundSchema,
+    event: ReadEvent3Event$outboundSchema,
   });
 
 /**
@@ -77,11 +131,32 @@ export function pingFromJSON(
   );
 }
 
+/** @internal */
+export const ReadEventEvent$inboundSchema: z.ZodNativeEnum<
+  typeof ReadEventEvent
+> = z.nativeEnum(ReadEventEvent);
+
+/** @internal */
+export const ReadEventEvent$outboundSchema: z.ZodNativeEnum<
+  typeof ReadEventEvent
+> = ReadEventEvent$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReadEventEvent$ {
+  /** @deprecated use `ReadEventEvent$inboundSchema` instead. */
+  export const inboundSchema = ReadEventEvent$inboundSchema;
+  /** @deprecated use `ReadEventEvent$outboundSchema` instead. */
+  export const outboundSchema = ReadEventEvent$outboundSchema;
+}
+
 /** @internal */
 export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
   .object({
     data: z.string(),
-    event: z.string(),
+    event: ReadEventEvent$inboundSchema,
   });
 
 /** @internal */
@@ -97,7 +172,7 @@ export const ErrorT$outboundSchema: z.ZodType<
   ErrorT
 > = z.object({
   data: z.string(),
-  event: z.string(),
+  event: ReadEventEvent$outboundSchema,
 });
 
 /**
@@ -127,6 +202,26 @@ export function errorFromJSON(
   );
 }
 
+/** @internal */
+export const Event$inboundSchema: z.ZodNativeEnum<typeof Event> = z.nativeEnum(
+  Event,
+);
+
+/** @internal */
+export const Event$outboundSchema: z.ZodNativeEnum<typeof Event> =
+  Event$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Event$ {
+  /** @deprecated use `Event$inboundSchema` instead. */
+  export const inboundSchema = Event$inboundSchema;
+  /** @deprecated use `Event$outboundSchema` instead. */
+  export const outboundSchema = Event$outboundSchema;
+}
+
 /** @internal */
 export const Batch$inboundSchema: z.ZodType<Batch, z.ZodTypeDef, unknown> = z
   .object({
@@ -141,13 +236,15 @@ export const Batch$inboundSchema: z.ZodType<Batch, z.ZodTypeDef, unknown> = z
         return z.NEVER;
       }
     }).pipe(ReadBatch$inboundSchema),
-    event: z.string(),
+    event: Event$inboundSchema,
+    id: z.string(),
   });
 
 /** @internal */
 export type Batch$Outbound = {
   data: ReadBatch$Outbound;
   event: string;
+  id: string;
 };
 
 /** @internal */
@@ -157,7 +254,8 @@ export const Batch$outboundSchema: z.ZodType<
   Batch
 > = z.object({
   data: ReadBatch$outboundSchema,
-  event: z.string(),
+  event: Event$outboundSchema,
+  id: z.string(),
 });
 
 /**
@@ -193,16 +291,16 @@ export const ReadEvent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  z.lazy(() => Batch$inboundSchema),
   z.lazy(() => ErrorT$inboundSchema),
   z.lazy(() => Ping$inboundSchema),
+  z.lazy(() => Batch$inboundSchema),
 ]);
 
 /** @internal */
 export type ReadEvent$Outbound =
-  | Batch$Outbound
   | ErrorT$Outbound
-  | Ping$Outbound;
+  | Ping$Outbound
+  | Batch$Outbound;
 
 /** @internal */
 export const ReadEvent$outboundSchema: z.ZodType<
@@ -210,9 +308,9 @@ export const ReadEvent$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ReadEvent
 > = z.union([
-  z.lazy(() => Batch$outboundSchema),
   z.lazy(() => ErrorT$outboundSchema),
   z.lazy(() => Ping$outboundSchema),
+  z.lazy(() => Batch$outboundSchema),
 ]);
 
 /**

package/src/models/components/s2format.ts

@@ -6,8 +6,8 @@ import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
 export const S2Format = {
-  Json: "json",
-  JsonBinsafe: "json-binsafe",
+  Raw: "raw",
+  Base64: "base64",
 } as const;
 export type S2Format = ClosedEnum<typeof S2Format>;
 

package/src/models/operations/append.ts

@@ -18,18 +18,14 @@ export const AppendServerList = [
 
 export type AppendRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**
-   * Recognized when the Content-Type is `application/json`.
+   * Define treatment of blob fields when exchanging records as JSON.
    *
    * @remarks
-   * json: UTF-8 data
-   * json-binsafe: Base64-encoded binary data
+   * The default is `raw`.
    */
   s2Format?: components.S2Format | undefined;
   /**

package/src/models/operations/checktail.ts

@@ -17,10 +17,7 @@ export const CheckTailServerList = [
 
 export type CheckTailRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/createorreconfigurebasin.ts

@@ -15,11 +15,7 @@ export type CreateOrReconfigureBasinRequest = {
    */
   s2RequestToken?: string | undefined;
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
   createOrReconfigureBasinRequest?:

package/src/models/operations/createorreconfigurestream.ts

@@ -18,10 +18,7 @@ export const CreateOrReconfigureStreamServerList = [
 
 export type CreateOrReconfigureStreamRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/deletebasin.ts

@@ -9,11 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type DeleteBasinRequest = {
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
 };

package/src/models/operations/deletestream.ts

@@ -17,10 +17,7 @@ export const DeleteStreamServerList = [
 
 export type DeleteStreamRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/getbasinconfig.ts

@@ -9,11 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetBasinConfigRequest = {
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
 };

package/src/models/operations/getstreamconfig.ts

@@ -17,10 +17,7 @@ export const GetStreamConfigServerList = [
 
 export type GetStreamConfigRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/read.ts

@@ -19,18 +19,14 @@ export const ReadServerList = [
 
 export type ReadRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**
-   * Recognized when the Content-Type is `application/json`.
+   * Define treatment of blob fields when exchanging records as JSON.
    *
    * @remarks
-   * json: UTF-8 data
-   * json-binsafe: Base64-encoded binary data
+   * The default is `raw`.
    */
   s2Format?: components.S2Format | undefined;
   /**

package/src/models/operations/reconfigurebasin.ts

@@ -11,11 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ReconfigureBasinRequest = {
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
   basinReconfiguration: components.BasinReconfiguration;

package/src/models/operations/reconfigurestream.ts

@@ -18,10 +18,7 @@ export const ReconfigureStreamServerList = [
 
 export type ReconfigureStreamRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/revokeaccesstoken.ts

@@ -10,9 +10,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type RevokeAccessTokenRequest = {
   /**
    * Access token ID.
-   *
-   * @remarks
-   * It must be unique to the account and between 1 and 96 characters.
    */
   id: string;
 };