@s2-dev/streamstore 0.11.1 → 0.12.0

package/src/models/components/listaccesstokensresponse.ts

@@ -16,13 +16,13 @@ import {
 
 export type ListAccessTokensResponse = {
   /**
-   * If set, indicates there are more results that can be listed with `start_after`.
+   * Access tokens information.
    */
-  hasMore: boolean;
+  accessTokens: Array<AccessTokenInfo>;
   /**
-   * Access tokens information.
+   * Indicates that there are more results that can be listed with `start_after`.
    */
-  tokens: Array<AccessTokenInfo>;
+  hasMore: boolean;
 };
 
 /** @internal */
@@ -31,18 +31,19 @@ export const ListAccessTokensResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  access_tokens: z.array(AccessTokenInfo$inboundSchema),
   has_more: z.boolean(),
-  tokens: z.array(AccessTokenInfo$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
+    "access_tokens": "accessTokens",
     "has_more": "hasMore",
   });
 });
 
 /** @internal */
 export type ListAccessTokensResponse$Outbound = {
+  access_tokens: Array<AccessTokenInfo$Outbound>;
   has_more: boolean;
-  tokens: Array<AccessTokenInfo$Outbound>;
 };
 
 /** @internal */
@@ -51,10 +52,11 @@ export const ListAccessTokensResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListAccessTokensResponse
 > = z.object({
+  accessTokens: z.array(AccessTokenInfo$outboundSchema),
   hasMore: z.boolean(),
-  tokens: z.array(AccessTokenInfo$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
+    accessTokens: "access_tokens",
     hasMore: "has_more",
   });
 });

package/src/models/components/listbasinsresponse.ts

@@ -20,7 +20,7 @@ export type ListBasinsResponse = {
    */
   basins: Array<BasinInfo>;
   /**
-   * If set, indicates there are more results that can be listed with `start_after`.
+   * Indicates that there are more results that can be listed with `start_after`.
    */
   hasMore: boolean;
 };

package/src/models/components/liststreamsresponse.ts

@@ -16,7 +16,7 @@ import {
 
 export type ListStreamsResponse = {
   /**
-   * If set, indicates there are more results that can be listed with `start_after`.
+   * Indicates that there are more results that can be listed with `start_after`.
    */
   hasMore: boolean;
   /**

package/src/models/components/readbatch.ts

@@ -0,0 +1,68 @@
+/*
+ * 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 {
+  SequencedRecord,
+  SequencedRecord$inboundSchema,
+  SequencedRecord$Outbound,
+  SequencedRecord$outboundSchema,
+} from "./sequencedrecord.js";
+
+export type ReadBatch = {
+  records: Array<SequencedRecord>;
+};
+
+/** @internal */
+export const ReadBatch$inboundSchema: z.ZodType<
+  ReadBatch,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  records: z.array(SequencedRecord$inboundSchema),
+});
+
+/** @internal */
+export type ReadBatch$Outbound = {
+  records: Array<SequencedRecord$Outbound>;
+};
+
+/** @internal */
+export const ReadBatch$outboundSchema: z.ZodType<
+  ReadBatch$Outbound,
+  z.ZodTypeDef,
+  ReadBatch
+> = z.object({
+  records: z.array(SequencedRecord$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReadBatch$ {
+  /** @deprecated use `ReadBatch$inboundSchema` instead. */
+  export const inboundSchema = ReadBatch$inboundSchema;
+  /** @deprecated use `ReadBatch$outboundSchema` instead. */
+  export const outboundSchema = ReadBatch$outboundSchema;
+  /** @deprecated use `ReadBatch$Outbound` instead. */
+  export type Outbound = ReadBatch$Outbound;
+}
+
+export function readBatchToJSON(readBatch: ReadBatch): string {
+  return JSON.stringify(ReadBatch$outboundSchema.parse(readBatch));
+}
+
+export function readBatchFromJSON(
+  jsonString: string,
+): SafeParseResult<ReadBatch, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReadBatch$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReadBatch' from JSON`,
+  );
+}

package/src/models/components/readevent.ts

@@ -0,0 +1,243 @@
+/*
+ * 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 {
+  ReadBatch,
+  ReadBatch$inboundSchema,
+  ReadBatch$Outbound,
+  ReadBatch$outboundSchema,
+} from "./readbatch.js";
+
+export type Ping = {
+  data: string;
+  event: string;
+};
+
+export type ErrorT = {
+  data: string;
+  event: string;
+};
+
+export type Batch = {
+  data: ReadBatch;
+  event: string;
+};
+
+export type ReadEvent = Batch | ErrorT | Ping;
+
+/** @internal */
+export const Ping$inboundSchema: z.ZodType<Ping, z.ZodTypeDef, unknown> = z
+  .object({
+    data: z.string(),
+    event: z.string(),
+  });
+
+/** @internal */
+export type Ping$Outbound = {
+  data: string;
+  event: string;
+};
+
+/** @internal */
+export const Ping$outboundSchema: z.ZodType<Ping$Outbound, z.ZodTypeDef, Ping> =
+  z.object({
+    data: z.string(),
+    event: 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 Ping$ {
+  /** @deprecated use `Ping$inboundSchema` instead. */
+  export const inboundSchema = Ping$inboundSchema;
+  /** @deprecated use `Ping$outboundSchema` instead. */
+  export const outboundSchema = Ping$outboundSchema;
+  /** @deprecated use `Ping$Outbound` instead. */
+  export type Outbound = Ping$Outbound;
+}
+
+export function pingToJSON(ping: Ping): string {
+  return JSON.stringify(Ping$outboundSchema.parse(ping));
+}
+
+export function pingFromJSON(
+  jsonString: string,
+): SafeParseResult<Ping, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Ping$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Ping' from JSON`,
+  );
+}
+
+/** @internal */
+export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
+  .object({
+    data: z.string(),
+    event: z.string(),
+  });
+
+/** @internal */
+export type ErrorT$Outbound = {
+  data: string;
+  event: string;
+};
+
+/** @internal */
+export const ErrorT$outboundSchema: z.ZodType<
+  ErrorT$Outbound,
+  z.ZodTypeDef,
+  ErrorT
+> = z.object({
+  data: z.string(),
+  event: 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 ErrorT$ {
+  /** @deprecated use `ErrorT$inboundSchema` instead. */
+  export const inboundSchema = ErrorT$inboundSchema;
+  /** @deprecated use `ErrorT$outboundSchema` instead. */
+  export const outboundSchema = ErrorT$outboundSchema;
+  /** @deprecated use `ErrorT$Outbound` instead. */
+  export type Outbound = ErrorT$Outbound;
+}
+
+export function errorToJSON(errorT: ErrorT): string {
+  return JSON.stringify(ErrorT$outboundSchema.parse(errorT));
+}
+
+export function errorFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorT, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorT$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorT' from JSON`,
+  );
+}
+
+/** @internal */
+export const Batch$inboundSchema: z.ZodType<Batch, z.ZodTypeDef, unknown> = z
+  .object({
+    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(ReadBatch$inboundSchema),
+    event: z.string(),
+  });
+
+/** @internal */
+export type Batch$Outbound = {
+  data: ReadBatch$Outbound;
+  event: string;
+};
+
+/** @internal */
+export const Batch$outboundSchema: z.ZodType<
+  Batch$Outbound,
+  z.ZodTypeDef,
+  Batch
+> = z.object({
+  data: ReadBatch$outboundSchema,
+  event: 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 Batch$ {
+  /** @deprecated use `Batch$inboundSchema` instead. */
+  export const inboundSchema = Batch$inboundSchema;
+  /** @deprecated use `Batch$outboundSchema` instead. */
+  export const outboundSchema = Batch$outboundSchema;
+  /** @deprecated use `Batch$Outbound` instead. */
+  export type Outbound = Batch$Outbound;
+}
+
+export function batchToJSON(batch: Batch): string {
+  return JSON.stringify(Batch$outboundSchema.parse(batch));
+}
+
+export function batchFromJSON(
+  jsonString: string,
+): SafeParseResult<Batch, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Batch$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Batch' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReadEvent$inboundSchema: z.ZodType<
+  ReadEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => Batch$inboundSchema),
+  z.lazy(() => ErrorT$inboundSchema),
+  z.lazy(() => Ping$inboundSchema),
+]);
+
+/** @internal */
+export type ReadEvent$Outbound =
+  | Batch$Outbound
+  | ErrorT$Outbound
+  | Ping$Outbound;
+
+/** @internal */
+export const ReadEvent$outboundSchema: z.ZodType<
+  ReadEvent$Outbound,
+  z.ZodTypeDef,
+  ReadEvent
+> = z.union([
+  z.lazy(() => Batch$outboundSchema),
+  z.lazy(() => ErrorT$outboundSchema),
+  z.lazy(() => Ping$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReadEvent$ {
+  /** @deprecated use `ReadEvent$inboundSchema` instead. */
+  export const inboundSchema = ReadEvent$inboundSchema;
+  /** @deprecated use `ReadEvent$outboundSchema` instead. */
+  export const outboundSchema = ReadEvent$outboundSchema;
+  /** @deprecated use `ReadEvent$Outbound` instead. */
+  export type Outbound = ReadEvent$Outbound;
+}
+
+export function readEventToJSON(readEvent: ReadEvent): string {
+  return JSON.stringify(ReadEvent$outboundSchema.parse(readEvent));
+}
+
+export function readEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ReadEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReadEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReadEvent' from JSON`,
+  );
+}

package/src/models/components/s2format.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const S2Format = {
+  Json: "json",
+  JsonBinsafe: "json-binsafe",
+} as const;
+export type S2Format = ClosedEnum<typeof S2Format>;
+
+/** @internal */
+export const S2Format$inboundSchema: z.ZodNativeEnum<typeof S2Format> = z
+  .nativeEnum(S2Format);
+
+/** @internal */
+export const S2Format$outboundSchema: z.ZodNativeEnum<typeof S2Format> =
+  S2Format$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace S2Format$ {
+  /** @deprecated use `S2Format$inboundSchema` instead. */
+  export const inboundSchema = S2Format$inboundSchema;
+  /** @deprecated use `S2Format$outboundSchema` instead. */
+  export const outboundSchema = S2Format$outboundSchema;
+}

package/src/models/components/sequencedrecord.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 {
+  Header,
+  Header$inboundSchema,
+  Header$Outbound,
+  Header$outboundSchema,
+} from "./header.js";
+
+/**
+ * Record that is durably sequenced on a stream.
+ */
+export type SequencedRecord = {
+  /**
+   * Body of the record.
+   */
+  body?: string | undefined;
+  /**
+   * Series of name-value pairs for this record.
+   */
+  headers?: Array<Header> | undefined;
+  seqNum: number;
+  timestamp: number;
+};
+
+/** @internal */
+export const SequencedRecord$inboundSchema: z.ZodType<
+  SequencedRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.string().optional(),
+  headers: z.array(Header$inboundSchema).optional(),
+  seq_num: z.number().int(),
+  timestamp: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "seq_num": "seqNum",
+  });
+});
+
+/** @internal */
+export type SequencedRecord$Outbound = {
+  body?: string | undefined;
+  headers?: Array<Header$Outbound> | undefined;
+  seq_num: number;
+  timestamp: number;
+};
+
+/** @internal */
+export const SequencedRecord$outboundSchema: z.ZodType<
+  SequencedRecord$Outbound,
+  z.ZodTypeDef,
+  SequencedRecord
+> = z.object({
+  body: z.string().optional(),
+  headers: z.array(Header$outboundSchema).optional(),
+  seqNum: z.number().int(),
+  timestamp: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    seqNum: "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 SequencedRecord$ {
+  /** @deprecated use `SequencedRecord$inboundSchema` instead. */
+  export const inboundSchema = SequencedRecord$inboundSchema;
+  /** @deprecated use `SequencedRecord$outboundSchema` instead. */
+  export const outboundSchema = SequencedRecord$outboundSchema;
+  /** @deprecated use `SequencedRecord$Outbound` instead. */
+  export type Outbound = SequencedRecord$Outbound;
+}
+
+export function sequencedRecordToJSON(
+  sequencedRecord: SequencedRecord,
+): string {
+  return JSON.stringify(SequencedRecord$outboundSchema.parse(sequencedRecord));
+}
+
+export function sequencedRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<SequencedRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SequencedRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SequencedRecord' from JSON`,
+  );
+}

package/src/models/components/streamconfig.ts

@@ -18,26 +18,17 @@ import {
   StorageClass$inboundSchema,
   StorageClass$outboundSchema,
 } from "./storageclass.js";
+import {
+  TimestampingConfig,
+  TimestampingConfig$inboundSchema,
+  TimestampingConfig$Outbound,
+  TimestampingConfig$outboundSchema,
+} from "./timestampingconfig.js";
 
 export type StreamConfig = {
-  /**
-   * Controls how to handle timestamps when they are not provided by the client.
-   *
-   * @remarks
-   *  If this is false (or not set), the record's arrival time in milliseconds since Unix epoch
-   * will be assigned as its timestamp. If this is true, then any append without a
-   * client-specified timestamp will be rejected as invalid.
-   */
-  requireClientTimestamps?: boolean | null | undefined;
   retentionPolicy?: RetentionPolicy | null | undefined;
   storageClass?: StorageClass | null | undefined;
-  /**
-   * Allow client timestamps to exceed the arrival time in milliseconds since Unix epoch.
-   *
-   * @remarks
-   * If this is false (or not set), client timestamps will be capped at the arrival time.
-   */
-  uncappedClientTimestamps?: boolean | null | undefined;
+  timestamping?: TimestampingConfig | null | undefined;
 };
 
 /** @internal */
@@ -46,25 +37,21 @@ export const StreamConfig$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  require_client_timestamps: z.nullable(z.boolean()).optional(),
   retention_policy: z.nullable(RetentionPolicy$inboundSchema).optional(),
   storage_class: z.nullable(StorageClass$inboundSchema).optional(),
-  uncapped_client_timestamps: z.nullable(z.boolean()).optional(),
+  timestamping: z.nullable(TimestampingConfig$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
-    "require_client_timestamps": "requireClientTimestamps",
     "retention_policy": "retentionPolicy",
     "storage_class": "storageClass",
-    "uncapped_client_timestamps": "uncappedClientTimestamps",
   });
 });
 
 /** @internal */
 export type StreamConfig$Outbound = {
-  require_client_timestamps?: boolean | null | undefined;
   retention_policy?: RetentionPolicy$Outbound | null | undefined;
   storage_class?: string | null | undefined;
-  uncapped_client_timestamps?: boolean | null | undefined;
+  timestamping?: TimestampingConfig$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -73,16 +60,13 @@ export const StreamConfig$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StreamConfig
 > = z.object({
-  requireClientTimestamps: z.nullable(z.boolean()).optional(),
   retentionPolicy: z.nullable(RetentionPolicy$outboundSchema).optional(),
   storageClass: z.nullable(StorageClass$outboundSchema).optional(),
-  uncappedClientTimestamps: z.nullable(z.boolean()).optional(),
+  timestamping: z.nullable(TimestampingConfig$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
-    requireClientTimestamps: "require_client_timestamps",
     retentionPolicy: "retention_policy",
     storageClass: "storage_class",
-    uncappedClientTimestamps: "uncapped_client_timestamps",
   });
 });
 

package/src/models/components/streaminfo.ts

@@ -10,11 +10,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type StreamInfo = {
   /**
-   * Creation time in seconds since Unix epoch.
+   * Creation time in ISO 8601 format.
    */
   createdAt: string;
   /**
-   * Deletion time in seconds since Unix epoch, if the stream is being deleted.
+   * Deletion time in ISO 8601 format, if the stream is being deleted.
    */
   deletedAt?: string | null | undefined;
   /**

package/src/models/components/streamposition.ts

@@ -0,0 +1,87 @@
+/*
+ * 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";
+
+/**
+ * Position of a record in a stream.
+ */
+export type StreamPosition = {
+  /**
+   * Sequence number assigned by the service.
+   */
+  seqNum: number;
+  /**
+   * Timestamp, which may be user-specified or assigned by the service.
+   *
+   * @remarks
+   * If it is assigned by the service, it will represent milliseconds since Unix epoch.
+   */
+  timestamp: number;
+};
+
+/** @internal */
+export const StreamPosition$inboundSchema: z.ZodType<
+  StreamPosition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  seq_num: z.number().int(),
+  timestamp: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "seq_num": "seqNum",
+  });
+});
+
+/** @internal */
+export type StreamPosition$Outbound = {
+  seq_num: number;
+  timestamp: number;
+};
+
+/** @internal */
+export const StreamPosition$outboundSchema: z.ZodType<
+  StreamPosition$Outbound,
+  z.ZodTypeDef,
+  StreamPosition
+> = z.object({
+  seqNum: z.number().int(),
+  timestamp: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    seqNum: "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 StreamPosition$ {
+  /** @deprecated use `StreamPosition$inboundSchema` instead. */
+  export const inboundSchema = StreamPosition$inboundSchema;
+  /** @deprecated use `StreamPosition$outboundSchema` instead. */
+  export const outboundSchema = StreamPosition$outboundSchema;
+  /** @deprecated use `StreamPosition$Outbound` instead. */
+  export type Outbound = StreamPosition$Outbound;
+}
+
+export function streamPositionToJSON(streamPosition: StreamPosition): string {
+  return JSON.stringify(StreamPosition$outboundSchema.parse(streamPosition));
+}
+
+export function streamPositionFromJSON(
+  jsonString: string,
+): SafeParseResult<StreamPosition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreamPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreamPosition' from JSON`,
+  );
+}