@s2-dev/streamstore 0.15.9 → 0.15.12

package/src/models/operations/read.ts

@@ -43,30 +43,39 @@ export type ReadRequest = {
    */
   tailOffset?: number | undefined;
   /**
-   * Limit total records to return.
+   * Start reading from the tail if the requested position is beyond it.
    *
    * @remarks
-   * If this is provided, tailing will be disabled.
+   * Otherwise, a `416 Range Not Satisfiable` response is returned.
+   */
+  clamp?: boolean | undefined;
+  /**
+   * Record count limit.
+   *
+   * @remarks
+   * Non-streaming reads are capped by the default limit of 1000 records.
    */
   count?: number | undefined;
   /**
-   * Limit total metered bytes to return.
+   * Metered bytes limit.
    *
    * @remarks
-   * If this is provided, tailing will be disabled.
+   * Non-streaming reads are capped by the default limit of 1 MiB.
    */
   bytes?: number | undefined;
   /**
    * Exclusive timestamp to read until.
-   *
-   * @remarks
-   * If this is provided, tailing will be disabled.
    */
   until?: number | undefined;
   /**
-   * Clamp the start position at the tail position.
+   * Duration in seconds to wait for new records.
+   *
+   * @remarks
+   * The default duration is 0 if there is a bound on `count`, `bytes`, or `until`, and otherwise infinite.
+   * Non-streaming reads are always bounded on `count` and `bytes`, so you can achieve long poll semantics by specifying a non-zero duration up to 60 seconds.
+   * In the context of an SSE or S2S streaming read, the duration will bound how much time can elapse between records throughout the lifetime of the session.
    */
-  clamp?: boolean | undefined;
+  wait?: number | undefined;
   /**
    * Basin name for basin-specific endpoints
    */
@@ -88,10 +97,11 @@ export const ReadRequest$inboundSchema: z.ZodType<
   seq_num: z.number().int().optional(),
   timestamp: z.number().int().optional(),
   tail_offset: z.number().int().optional(),
+  clamp: z.boolean().optional(),
   count: z.number().int().optional(),
   bytes: z.number().int().optional(),
   until: z.number().int().optional(),
-  clamp: z.boolean().optional(),
+  wait: z.number().int().optional(),
   "s2-basin": z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -109,10 +119,11 @@ export type ReadRequest$Outbound = {
   seq_num?: number | undefined;
   timestamp?: number | undefined;
   tail_offset?: number | undefined;
+  clamp?: boolean | undefined;
   count?: number | undefined;
   bytes?: number | undefined;
   until?: number | undefined;
-  clamp?: boolean | undefined;
+  wait?: number | undefined;
   "s2-basin": string;
 };
 
@@ -127,10 +138,11 @@ export const ReadRequest$outboundSchema: z.ZodType<
   seqNum: z.number().int().optional(),
   timestamp: z.number().int().optional(),
   tailOffset: z.number().int().optional(),
+  clamp: z.boolean().optional(),
   count: z.number().int().optional(),
   bytes: z.number().int().optional(),
   until: z.number().int().optional(),
-  clamp: z.boolean().optional(),
+  wait: z.number().int().optional(),
   s2Basin: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -175,12 +187,14 @@ export const ReadResponse$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   components.ReadBatch$inboundSchema,
-  z.instanceof(ReadableStream<Uint8Array>).transform(stream => {
-    return new EventStream(stream, rawEvent => {
-      if (rawEvent.data === "[DONE]") return { done: true };
-      return { value: components.ReadEvent$inboundSchema.parse(rawEvent) };
-    });
-  }),
+  z
+    .instanceof(ReadableStream<Uint8Array>)
+    .transform(stream => {
+      return new EventStream(stream, rawEvent => {
+        if (rawEvent.data === "[DONE]") return { done: true };
+        return { value: components.ReadEvent$inboundSchema.parse(rawEvent) };
+      });
+    }),
 ]);
 
 /** @internal */