@s2-dev/streamstore 0.15.0 → 0.15.2

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/tailresponse.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { S2Error } from "./s2error.js";
 
 export type TailResponseData = {
   /**
@@ -12,7 +13,7 @@ export type TailResponseData = {
   tail: components.StreamPosition;
 };
 
-export class TailResponse extends Error {
+export class TailResponse extends S2Error {
   /**
    * Position of a record in a stream.
    */
@@ -21,13 +22,15 @@ export class TailResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: TailResponseData;
 
-  constructor(err: TailResponseData) {
+  constructor(
+    err: TailResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.tail = err.tail;
 
     this.name = "TailResponse";
@@ -41,9 +44,16 @@ export const TailResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   tail: components.StreamPosition$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new TailResponse(v);
+    return new TailResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

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;
   /**

package/src/models/operations/liststreams.ts

@@ -18,15 +18,14 @@ export const ListStreamsServerList = [
 
 export type ListStreamsRequest = {
   /**
-   * List stream names that begin with this prefix.
+   * Filter to streams whose name begins with this prefix.
    */
   prefix?: string | undefined;
   /**
-   * Only return stream names that lexicographically start after this name.
+   * Filter to streams whose name begins with this prefix.
    *
    * @remarks
-   * This can be the last stream 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 specified.
    */
   startAfter?: string | undefined;
   /**

package/src/models/operations/read.ts

@@ -23,10 +23,11 @@ export type ReadRequest = {
    */
   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;
   /**
@@ -38,17 +39,30 @@ export type ReadRequest = {
    */
   timestamp?: number | undefined;
   /**
-   * Start from number of records before the tail, i.e. before the next sequence number.
+   * Start from number of records before the next sequence number.
    */
   tailOffset?: number | undefined;
   /**
    * Limit total records to return.
+   *
+   * @remarks
+   * If this is provided, tailing will be disabled.
    */
   count?: number | undefined;
   /**
    * Limit total metered bytes to return.
+   *
+   * @remarks
+   * If this is provided, tailing will be disabled.
    */
   bytes?: number | undefined;
+  /**
+   * Exclusive timestamp to read until.
+   *
+   * @remarks
+   * If this is provided, tailing will be disabled.
+   */
+  until?: number | undefined;
   /**
    * Basin name for basin-specific endpoints
    */
@@ -72,6 +86,7 @@ export const ReadRequest$inboundSchema: z.ZodType<
   tail_offset: z.number().int().optional(),
   count: z.number().int().optional(),
   bytes: z.number().int().optional(),
+  until: z.number().int().optional(),
   "s2-basin": z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -91,6 +106,7 @@ export type ReadRequest$Outbound = {
   tail_offset?: number | undefined;
   count?: number | undefined;
   bytes?: number | undefined;
+  until?: number | undefined;
   "s2-basin": string;
 };
 
@@ -107,6 +123,7 @@ export const ReadRequest$outboundSchema: z.ZodType<
   tailOffset: z.number().int().optional(),
   count: z.number().int().optional(),
   bytes: z.number().int().optional(),
+  until: z.number().int().optional(),
   s2Basin: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/sdk/basins.ts

@@ -44,7 +44,7 @@ export class Basins extends ClientSDK {
   }
 
   /**
-   * Get basin config.
+   * Get basin configuration.
    */
   async getBasinConfig(
     request: operations.GetBasinConfigRequest,

package/src/sdk/metrics.ts

@@ -12,7 +12,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Metrics extends ClientSDK {
   /**
-   * Get account level metrics.
+   * Account-level metrics.
    */
   async accountMetrics(
     request: operations.AccountMetricsRequest,
@@ -26,7 +26,7 @@ export class Metrics extends ClientSDK {
   }
 
   /**
-   * Get metrics for a basin.
+   * Basin-level metrics.
    */
   async basinMetrics(
     request: operations.BasinMetricsRequest,
@@ -40,7 +40,7 @@ export class Metrics extends ClientSDK {
   }
 
   /**
-   * Get metrics for a stream.
+   * Stream-level metrics.
    */
   async streamMetrics(
     request: operations.StreamMetricsRequest,

package/src/sdk/records.ts

@@ -14,10 +14,7 @@ export { ReadAcceptEnum } from "../funcs/recordsRead.js";
 
 export class Records extends ClientSDK {
   /**
-   * Retrieve records.
-   *
-   * @remarks
-   * Retrieve a batch of records, or set `Accept: text/event-stream` to stream using server-sent events.
+   * Read records.
    */
   async read(
     request: operations.ReadRequest,
@@ -32,9 +29,6 @@ export class Records extends ClientSDK {
 
   /**
    * Append records.
-   *
-   * @remarks
-   * Append a batch of records to a stream.
    */
   async append(
     request: operations.AppendRequest,
@@ -49,9 +43,6 @@ export class Records extends ClientSDK {
 
   /**
    * Check the tail.
-   *
-   * @remarks
-   * Check the tail of a stream.
    */
   async checkTail(
     request: operations.CheckTailRequest,

package/src/types/constdatetime.ts

@@ -11,5 +11,5 @@ export function constDateTime(
     return (
       typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
     );
-  }, `Value must be equivelant to ${val}`);
+  }, `Value must be equivalent to ${val}`);
 }