@s2-dev/streamstore 0.15.1 → 0.15.3

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,7 +39,7 @@ 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;
   /**
@@ -168,12 +169,9 @@ export const ReadResponse$inboundSchema: z.ZodType<
 > = 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);
-      },
+    return new EventStream(stream, rawEvent => {
+      if (rawEvent.data === "[DONE]") return { done: true };
+      return { value: components.ReadEvent$inboundSchema.parse(rawEvent) };
     });
   }),
 ]);

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}`);
 }