@s2-dev/streamstore 0.15.1 → 0.15.2

package/src/models/components/accountmetricset.ts

@@ -6,8 +6,8 @@ import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
 export const AccountMetricSet = {
-  ActiveBasins: "active_basins",
-  AccountOps: "account_ops",
+  ActiveBasins: "active-basins",
+  AccountOps: "account-ops",
 } as const;
 export type AccountMetricSet = ClosedEnum<typeof AccountMetricSet>;
 

package/src/models/components/accumulation.ts

@@ -31,12 +31,8 @@ export type Accumulation = {
    * Timeseries values.
    *
    * @remarks
-   *
-   * Each element is a tuple containing the seconds since Unix epoch, followed by the data
-   * point.
-   *
-   * The data point represented the accumulated value for a bucket of time, starting
-   * at the provided epoch, lasting for the duration of the `bucket_length` parameter above.
+   * Each element is a tuple of a timestamp in Unix epoch seconds and a data point.
+   * The data point represents the accumulated value for a bucket of time starting at the provided timestamp, lasting for the duration of the `bucket_length` parameter.
    */
   values: Array<Array<number | number>>;
 };

package/src/models/components/appendack.ts

@@ -14,7 +14,7 @@ import {
 } from "./streamposition.js";
 
 /**
- * Success response message to an Append request.
+ * Success response to an `append` request.
  */
 export type AppendAck = {
   /**

package/src/models/components/appendinput.ts

@@ -15,19 +15,19 @@ import {
 } from "./appendrecord.js";
 
 /**
- * Payload of an Append request message.
+ * Payload of an `append` request.
  */
 export type AppendInput = {
   /**
-   * Enforce a fencing token which must have been previously set by a `fence` command record.
+   * Enforce a fencing token, which starts out as an empty string that can be overridden by a `fence` command record.
    */
   fencingToken?: string | null | undefined;
   matchSeqNum?: number | null | undefined;
   /**
-   * Batch of records to append atomically, which must contain at least one record, and no more
+   * Batch of records to append atomically, which must contain at least one record, and no more than 1000.
    *
    * @remarks
-   * than 1000. The total size of a batch of records may not exceed 1MiB of metered bytes.
+   * The total size of a batch of records may not exceed 1 MiB of metered bytes.
    */
   records: Array<AppendRecord>;
 };

package/src/models/components/basinconfig.ts

@@ -16,17 +16,11 @@ import {
 
 export type BasinConfig = {
   /**
-   * Create stream on append if it doesn't exist,
-   *
-   * @remarks
-   * using the default stream configuration.
+   * Create stream on append if it doesn't exist, using the default stream configuration.
    */
   createStreamOnAppend?: boolean | undefined;
   /**
-   * Create stream on read if it doesn't exist,
-   *
-   * @remarks
-   * using the default stream configuration.
+   * Create stream on read if it doesn't exist, using the default stream configuration.
    */
   createStreamOnRead?: boolean | undefined;
   defaultStreamConfig?: StreamConfig | null | undefined;

package/src/models/components/basinmetricset.ts

@@ -7,11 +7,11 @@ import { ClosedEnum } from "../../types/enums.js";
 
 export const BasinMetricSet = {
   Storage: "storage",
-  AppendOps: "append_ops",
-  ReadOps: "read_ops",
-  ReadThroughput: "read_throughput",
-  AppendThroughput: "append_throughput",
-  BasinOps: "basin_ops",
+  AppendOps: "append-ops",
+  ReadOps: "read-ops",
+  ReadThroughput: "read-throughput",
+  AppendThroughput: "append-throughput",
+  BasinOps: "basin-ops",
 } as const;
 export type BasinMetricSet = ClosedEnum<typeof BasinMetricSet>;
 

package/src/models/components/createbasinrequest.ts

@@ -25,8 +25,7 @@ export type CreateBasinRequest = {
    * Basin name which must be globally unique.
    *
    * @remarks
-   * It can be between 8 and 48 characters in length,
-   * and comprise lowercase letters, numbers and hyphens.
+   * It can be between 8 and 48 characters in length, and comprise lowercase letters, numbers and hyphens.
    * It cannot begin or end with a hyphen.
    */
   basin: string;

package/src/models/components/gauge.ts

@@ -24,11 +24,8 @@ export type Gauge = {
    * Timeseries values.
    *
    * @remarks
-   *
-   * Each element is a tuple containing the seconds since Unix epoch, followed by the data
-   * point.
-   *
-   * The data point represents the value at the instant of the epoch.
+   * Each element is a tuple of a timestamp in Unix epoch seconds and a data point.
+   * The data point represents the value at the instant of the timestamp.
    */
   values: Array<Array<number | number>>;
 };

package/src/models/components/listaccesstokensresponse.ts

@@ -16,11 +16,11 @@ import {
 
 export type ListAccessTokensResponse = {
   /**
-   * Access tokens information.
+   * Matching access tokens.
    */
   accessTokens: Array<AccessTokenInfo>;
   /**
-   * Indicates that there are more results that can be listed with `start_after`.
+   * Indicates that there are more access tokens that match the criteria.
    */
   hasMore: boolean;
 };

package/src/models/components/listbasinsresponse.ts

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

package/src/models/components/liststreamsresponse.ts

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

package/src/models/components/metric.ts

@@ -32,21 +32,21 @@ import {
 } from "./scalar.js";
 
 /**
- * A set of string labels.
+ * Set of string labels.
  */
 export type Four = {
   label: Label;
 };
 
 /**
- * A named series of (timestamp, value) points each representing an instantaneous value.
+ * Named series of `(timestamp, value)` points each representing an instantaneous value.
  */
 export type Three = {
   gauge: Gauge;
 };
 
 /**
- * A named series of (timestamp, value) points representing an accumulation over a specified
+ * Named series of `(timestamp, value)` points representing an accumulation over a specified
  *
  * @remarks
  * bucket.
@@ -56,7 +56,7 @@ export type Two = {
 };
 
 /**
- * A single named value.
+ * Single named value.
  */
 export type Metric1 = {
   scalar: Scalar;

package/src/models/components/readbatch.ts

@@ -21,10 +21,10 @@ import {
 
 export type ReadBatch = {
   /**
-   * Records that are durably sequenced on the stream,
+   * Records that are durably sequenced on the stream, retrieved based on the requested criteria.
    *
    * @remarks
-   * retrieved based on the requested criteria.
+   * This can only be empty in response to a regular (non-SSE) read, if the request cannot be satisfied without violating an explicit limit.
    */
   records: Array<SequencedRecord>;
   tail?: StreamPosition | null | undefined;

package/src/models/components/readevent.ts

@@ -19,40 +19,24 @@ import {
   ReadBatch$Outbound,
   ReadBatch$outboundSchema,
 } from "./readbatch.js";
-import {
-  TailResponse,
-  TailResponse$inboundSchema,
-  TailResponse$Outbound,
-  TailResponse$outboundSchema,
-} from "./tailresponse.js";
 
-export const ReadEvent4Event = {
+export const ReadEvent3Event = {
   Ping: "ping",
 } as const;
-export type ReadEvent4Event = ClosedEnum<typeof ReadEvent4Event>;
+export type ReadEvent3Event = ClosedEnum<typeof ReadEvent3Event>;
 
 export type Ping = {
   data: PingEventData;
-  event: ReadEvent4Event;
-};
-
-export const ReadEvent3Event = {
-  Error: "error",
-} as const;
-export type ReadEvent3Event = ClosedEnum<typeof ReadEvent3Event>;
-
-export type ErrorT = {
-  data: string;
   event: ReadEvent3Event;
 };
 
 export const ReadEventEvent = {
-  Tail: "tail",
+  Error: "error",
 } as const;
 export type ReadEventEvent = ClosedEnum<typeof ReadEventEvent>;
 
-export type ReadEvent2 = {
-  data: TailResponse;
+export type ErrorT = {
+  data: string;
   event: ReadEventEvent;
 };
 
@@ -67,27 +51,27 @@ export type Batch = {
   id: string;
 };
 
-export type ReadEvent = ReadEvent2 | ErrorT | Ping | Batch;
+export type ReadEvent = Batch | ErrorT | Ping;
 
 /** @internal */
-export const ReadEvent4Event$inboundSchema: z.ZodNativeEnum<
-  typeof ReadEvent4Event
-> = z.nativeEnum(ReadEvent4Event);
+export const ReadEvent3Event$inboundSchema: z.ZodNativeEnum<
+  typeof ReadEvent3Event
+> = z.nativeEnum(ReadEvent3Event);
 
 /** @internal */
-export const ReadEvent4Event$outboundSchema: z.ZodNativeEnum<
-  typeof ReadEvent4Event
-> = ReadEvent4Event$inboundSchema;
+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 ReadEvent4Event$ {
-  /** @deprecated use `ReadEvent4Event$inboundSchema` instead. */
-  export const inboundSchema = ReadEvent4Event$inboundSchema;
-  /** @deprecated use `ReadEvent4Event$outboundSchema` instead. */
-  export const outboundSchema = ReadEvent4Event$outboundSchema;
+export namespace ReadEvent3Event$ {
+  /** @deprecated use `ReadEvent3Event$inboundSchema` instead. */
+  export const inboundSchema = ReadEvent3Event$inboundSchema;
+  /** @deprecated use `ReadEvent3Event$outboundSchema` instead. */
+  export const outboundSchema = ReadEvent3Event$outboundSchema;
 }
 
 /** @internal */
@@ -104,7 +88,7 @@ export const Ping$inboundSchema: z.ZodType<Ping, z.ZodTypeDef, unknown> = z
         return z.NEVER;
       }
     }).pipe(PingEventData$inboundSchema),
-    event: ReadEvent4Event$inboundSchema,
+    event: ReadEvent3Event$inboundSchema,
   });
 
 /** @internal */
@@ -117,7 +101,7 @@ export type Ping$Outbound = {
 export const Ping$outboundSchema: z.ZodType<Ping$Outbound, z.ZodTypeDef, Ping> =
   z.object({
     data: PingEventData$outboundSchema,
-    event: ReadEvent4Event$outboundSchema,
+    event: ReadEvent3Event$outboundSchema,
   });
 
 /**
@@ -148,31 +132,31 @@ export function pingFromJSON(
 }
 
 /** @internal */
-export const ReadEvent3Event$inboundSchema: z.ZodNativeEnum<
-  typeof ReadEvent3Event
-> = z.nativeEnum(ReadEvent3Event);
+export const ReadEventEvent$inboundSchema: z.ZodNativeEnum<
+  typeof ReadEventEvent
+> = z.nativeEnum(ReadEventEvent);
 
 /** @internal */
-export const ReadEvent3Event$outboundSchema: z.ZodNativeEnum<
-  typeof ReadEvent3Event
-> = ReadEvent3Event$inboundSchema;
+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 ReadEvent3Event$ {
-  /** @deprecated use `ReadEvent3Event$inboundSchema` instead. */
-  export const inboundSchema = ReadEvent3Event$inboundSchema;
-  /** @deprecated use `ReadEvent3Event$outboundSchema` instead. */
-  export const outboundSchema = ReadEvent3Event$outboundSchema;
+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: ReadEvent3Event$inboundSchema,
+    event: ReadEventEvent$inboundSchema,
   });
 
 /** @internal */
@@ -188,7 +172,7 @@ export const ErrorT$outboundSchema: z.ZodType<
   ErrorT
 > = z.object({
   data: z.string(),
-  event: ReadEvent3Event$outboundSchema,
+  event: ReadEventEvent$outboundSchema,
 });
 
 /**
@@ -218,90 +202,6 @@ export function errorFromJSON(
   );
 }
 
-/** @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 ReadEvent2$inboundSchema: z.ZodType<
-  ReadEvent2,
-  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(TailResponse$inboundSchema),
-  event: ReadEventEvent$inboundSchema,
-});
-
-/** @internal */
-export type ReadEvent2$Outbound = {
-  data: TailResponse$Outbound;
-  event: string;
-};
-
-/** @internal */
-export const ReadEvent2$outboundSchema: z.ZodType<
-  ReadEvent2$Outbound,
-  z.ZodTypeDef,
-  ReadEvent2
-> = z.object({
-  data: TailResponse$outboundSchema,
-  event: ReadEventEvent$outboundSchema,
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ReadEvent2$ {
-  /** @deprecated use `ReadEvent2$inboundSchema` instead. */
-  export const inboundSchema = ReadEvent2$inboundSchema;
-  /** @deprecated use `ReadEvent2$outboundSchema` instead. */
-  export const outboundSchema = ReadEvent2$outboundSchema;
-  /** @deprecated use `ReadEvent2$Outbound` instead. */
-  export type Outbound = ReadEvent2$Outbound;
-}
-
-export function readEvent2ToJSON(readEvent2: ReadEvent2): string {
-  return JSON.stringify(ReadEvent2$outboundSchema.parse(readEvent2));
-}
-
-export function readEvent2FromJSON(
-  jsonString: string,
-): SafeParseResult<ReadEvent2, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ReadEvent2$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ReadEvent2' from JSON`,
-  );
-}
-
 /** @internal */
 export const Event$inboundSchema: z.ZodNativeEnum<typeof Event> = z.nativeEnum(
   Event,
@@ -391,18 +291,16 @@ export const ReadEvent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  z.lazy(() => ReadEvent2$inboundSchema),
+  z.lazy(() => Batch$inboundSchema),
   z.lazy(() => ErrorT$inboundSchema),
   z.lazy(() => Ping$inboundSchema),
-  z.lazy(() => Batch$inboundSchema),
 ]);
 
 /** @internal */
 export type ReadEvent$Outbound =
-  | ReadEvent2$Outbound
+  | Batch$Outbound
   | ErrorT$Outbound
-  | Ping$Outbound
-  | Batch$Outbound;
+  | Ping$Outbound;
 
 /** @internal */
 export const ReadEvent$outboundSchema: z.ZodType<
@@ -410,10 +308,9 @@ export const ReadEvent$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ReadEvent
 > = z.union([
-  z.lazy(() => ReadEvent2$outboundSchema),
+  z.lazy(() => Batch$outboundSchema),
   z.lazy(() => ErrorT$outboundSchema),
   z.lazy(() => Ping$outboundSchema),
-  z.lazy(() => Batch$outboundSchema),
 ]);
 
 /**

package/src/models/components/retentionpolicy.ts

@@ -7,7 +7,19 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Age in seconds for automatic trimming of records older than this threshold.
+ *
+ * @remarks
+ * If this is set to 0, the stream will have infinite retention.
+ */
 export type One = {
+  /**
+   * Age in seconds for automatic trimming of records older than this threshold.
+   *
+   * @remarks
+   * If this is set to 0, the stream will have infinite retention.
+   */
   age: number;
 };
 

package/src/models/components/streamposition.ts

@@ -17,7 +17,7 @@ export type StreamPosition = {
    */
   seqNum: number;
   /**
-   * Timestamp, which may be user-specified or assigned by the service.
+   * Timestamp, which may be client-specified or assigned by the service.
    *
    * @remarks
    * If it is assigned by the service, it will represent milliseconds since Unix epoch.

package/src/models/components/timestampingconfig.ts

@@ -18,7 +18,7 @@ export type TimestampingConfig = {
    * Allow client-specified timestamps to exceed the arrival time.
    *
    * @remarks
-   * If this is false or not set, client timestamps will be capped at the arrival time.
+   * If this is `false` or not set, client timestamps will be capped at the arrival time.
    */
   uncapped?: boolean | null | undefined;
 };

package/src/models/errors/appendconditionfailed.ts

@@ -108,7 +108,7 @@ export class FencingToken extends S2Error {
 }
 
 /**
- * Failure response message when an Append is aborted due to a failed condition.
+ * Aborted due to a failed condition.
  */
 export type AppendConditionFailed = FencingToken | SeqNum;
 

package/src/models/operations/accountmetrics.ts

@@ -10,19 +10,19 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AccountMetricsRequest = {
   /**
-   * Metric type to return.
+   * Metric set to return.
    */
   set: components.AccountMetricSet;
   /**
-   * Start timestamp, in Unix epoch seconds, if applicable for metric set.
+   * Start timestamp as Unix epoch seconds, if applicable for the metric set.
    */
   start?: number | undefined;
   /**
-   * End timestamp, in Unix epoch seconds, if applicable for metric set.
+   * End timestamp as Unix epoch seconds, if applicable for the metric set.
    */
   end?: number | undefined;
   /**
-   * For timeseries metric sets, the interval to aggregate over.
+   * Interval to aggregate over for timeseries metric sets.
    */
   interval?: components.TimeseriesInterval | undefined;
 };

package/src/models/operations/append.ts

@@ -22,10 +22,11 @@ export type AppendRequest = {
    */
   stream: string;
   /**
-   * Define treatment of blob fields when exchanging records as JSON.
+   * Defines the interpretation of record data (header name, header value, and body) with the JSON content type.
    *
    * @remarks
-   * The default is `raw`.
+   * Use `raw` (default) for efficient transmission and storage of Unicode data — storage will be in UTF-8.
+   * Use `base64` for safe transmission with efficient storage of binary data.
    */
   s2Format?: components.S2Format | undefined;
   /**

package/src/models/operations/basinmetrics.ts

@@ -10,19 +10,19 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type BasinMetricsRequest = {
   /**
-   * Metric type to return.
+   * Metric set to return.
    */
   set: components.BasinMetricSet;
   /**
-   * Start timestamp, in Unix epoch seconds, if applicable for metric set.
+   * Start timestamp as Unix epoch seconds, if applicable for the metric set.
    */
   start?: number | undefined;
   /**
-   * End timestamp, in Unix epoch seconds, if applicable for metric set.
+   * End timestamp as Unix epoch seconds, if applicable for the metric set.
    */
   end?: number | undefined;
   /**
-   * For timeseries metric sets, the interval to aggregate over.
+   * Interval to aggregate over for timeseries metric sets.
    */
   interval?: components.TimeseriesInterval | undefined;
   /**

package/src/models/operations/createorreconfigurebasin.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CreateOrReconfigureBasinRequest = {
   /**
-   * Provide a client request token header for idempotent retry behaviour.
+   * Client-specified request token for idempotent retries.
    */
   s2RequestToken?: string | undefined;
   /**

package/src/models/operations/createorreconfigurestream.ts

@@ -22,7 +22,7 @@ export type CreateOrReconfigureStreamRequest = {
    */
   stream: string;
   /**
-   * Provide a client request token header for idempotent retry behaviour.
+   * Client-specified request token for idempotent retries.
    */
   s2RequestToken?: string | undefined;
   /**

package/src/models/operations/listaccesstokens.ts

@@ -10,11 +10,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListAccessTokensRequest = {
   /**
-   * List access tokens that begin with this prefix.
+   * Filter to access tokens whose ID begins with this prefix.
    */
   prefix?: string | undefined;
   /**
-   * Only return access tokens that lexicographically start after this ID.
+   * Filter to access tokens whose ID lexicographically starts after this string.
    */
   startAfter?: string | undefined;
   /**

package/src/models/operations/listbasins.ts

@@ -11,15 +11,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListBasinsRequest = {
   /**
-   * List basin names that begin with this prefix.
+   * Filter to basins whose names begin with this prefix.
    */
   prefix?: string | undefined;
   /**
-   * Only return basins names that lexicographically start after this name.
+   * Filter to basins whose names lexicographically start after this string.
    *
    * @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 that is specified.
+   * It must be greater than or equal to the `prefix` if specified.
    */
   startAfter?: string | undefined;
   /**