@durable-streams/server 0.2.0 → 0.2.1

package/dist/index.d.cts

@@ -61,6 +61,20 @@ interface Stream {
   * Maps producer ID to their epoch and sequence state.
   */
   producers?: Map<string, ProducerState>;
+  /**
+  * Whether the stream is closed (no further appends permitted).
+  * Once set to true, this is permanent and durable.
+  */
+  closed?: boolean;
+  /**
+  * The producer tuple that closed this stream (for idempotent close).
+  * If set, duplicate close requests with this tuple return 204.
+  */
+  closedBy?: {
+    producerId: string;
+    epoch: number;
+    seq: number;
+  };
 }
 /**
 * Event data for stream lifecycle hooks.
@@ -177,6 +191,8 @@ type ProducerValidationResult = {
   status: `sequence_gap`;
   expectedSeq: number;
   receivedSeq: number;
+} | {
+  status: `stream_closed`;
 };
 /**
 * Pending long-poll request.
@@ -212,6 +228,7 @@ interface AppendOptions {
   producerId?: string;
   producerEpoch?: number;
   producerSeq?: number;
+  close?: boolean;
 }
 /**
 * Result of an append operation.
@@ -219,6 +236,7 @@ interface AppendOptions {
 interface AppendResult {
   message: StreamMessage | null;
   producerResult?: ProducerValidationResult;
+  streamClosed?: boolean;
 }
 declare class StreamStore {
   private streams;
@@ -247,6 +265,7 @@ declare class StreamStore {
     ttlSeconds?: number;
     expiresAt?: string;
     initialData?: Uint8Array;
+    closed?: boolean;
   }): Stream;
   /**
   * Get a stream by path.
@@ -299,6 +318,28 @@ declare class StreamStore {
   */
   appendWithProducer(path: string, data: Uint8Array, options: AppendOptions): Promise<AppendResult>;
   /**
+  * Close a stream without appending data.
+  * @returns The final offset, or null if stream doesn't exist
+  */
+  closeStream(path: string): {
+    finalOffset: string;
+    alreadyClosed: boolean;
+  } | null;
+  /**
+  * Close a stream with producer headers for idempotent close-only operations.
+  * Participates in producer sequencing for deduplication.
+  * @returns The final offset and producer result, or null if stream doesn't exist
+  */
+  closeStreamWithProducer(path: string, options: {
+    producerId: string;
+    producerEpoch: number;
+    producerSeq: number;
+  }): Promise<{
+    finalOffset: string;
+    alreadyClosed: boolean;
+    producerResult?: ProducerValidationResult;
+  } | null>;
+  /**
   * Get the current epoch for a producer on a stream.
   * Returns undefined if the producer doesn't exist or stream not found.
   */
@@ -324,6 +365,7 @@ declare class StreamStore {
   waitForMessages(path: string, offset: string, timeoutMs: number): Promise<{
     messages: Array<StreamMessage>;
     timedOut: boolean;
+    streamClosed?: boolean;
   }>;
   /**
   * Get the current offset for a stream.
@@ -345,6 +387,11 @@ declare class StreamStore {
   private appendToStream;
   private findOffsetIndex;
   private notifyLongPolls;
+  /**
+  * Notify pending long-polls that a stream has been closed.
+  * They should wake up immediately and return Stream-Closed: true.
+  */
+  private notifyLongPollsClosed;
   private cancelLongPollsForStream;
   private removePendingLongPoll;
 } //#endregion
@@ -421,6 +468,7 @@ declare class FileBackedStreamStore {
     ttlSeconds?: number;
     expiresAt?: string;
     initialData?: Uint8Array;
+    closed?: boolean;
   }): Promise<Stream>;
   get(streamPath: string): Stream | undefined;
   has(streamPath: string): boolean;
@@ -433,6 +481,28 @@ declare class FileBackedStreamStore {
   * This ensures that validation+append is atomic per producer.
   */
   appendWithProducer(streamPath: string, data: Uint8Array, options: AppendOptions): Promise<AppendResult>;
+  /**
+  * Close a stream without appending data.
+  * @returns The final offset, or null if stream doesn't exist
+  */
+  closeStream(streamPath: string): {
+    finalOffset: string;
+    alreadyClosed: boolean;
+  } | null;
+  /**
+  * Close a stream with producer headers for idempotent close-only operations.
+  * Participates in producer sequencing for deduplication.
+  * @returns The final offset and producer result, or null if stream doesn't exist
+  */
+  closeStreamWithProducer(streamPath: string, options: {
+    producerId: string;
+    producerEpoch: number;
+    producerSeq: number;
+  }): Promise<{
+    finalOffset: string;
+    alreadyClosed: boolean;
+    producerResult?: ProducerValidationResult;
+  } | null>;
   read(streamPath: string, offset?: string): {
     messages: Array<StreamMessage>;
     upToDate: boolean;
@@ -440,6 +510,7 @@ declare class FileBackedStreamStore {
   waitForMessages(streamPath: string, offset: string, timeoutMs: number): Promise<{
     messages: Array<StreamMessage>;
     timedOut: boolean;
+    streamClosed?: boolean;
   }>;
   /**
   * Format messages for response.
@@ -455,10 +526,14 @@ declare class FileBackedStreamStore {
   cancelAllWaits(): void;
   list(): Array<string>;
   private notifyLongPolls;
+  /**
+  * Notify pending long-polls that a stream has been closed.
+  * They should wake up immediately and return Stream-Closed: true.
+  */
+  private notifyLongPollsClosed;
   private cancelLongPollsForStream;
   private removePendingLongPoll;
 }
-
 //#endregion
 //#region src/server.d.ts
 /**

package/dist/index.d.ts

@@ -61,6 +61,20 @@ interface Stream {
   * Maps producer ID to their epoch and sequence state.
   */
   producers?: Map<string, ProducerState>;
+  /**
+  * Whether the stream is closed (no further appends permitted).
+  * Once set to true, this is permanent and durable.
+  */
+  closed?: boolean;
+  /**
+  * The producer tuple that closed this stream (for idempotent close).
+  * If set, duplicate close requests with this tuple return 204.
+  */
+  closedBy?: {
+    producerId: string;
+    epoch: number;
+    seq: number;
+  };
 }
 /**
 * Event data for stream lifecycle hooks.
@@ -177,6 +191,8 @@ type ProducerValidationResult = {
   status: `sequence_gap`;
   expectedSeq: number;
   receivedSeq: number;
+} | {
+  status: `stream_closed`;
 };
 /**
 * Pending long-poll request.
@@ -212,6 +228,7 @@ interface AppendOptions {
   producerId?: string;
   producerEpoch?: number;
   producerSeq?: number;
+  close?: boolean;
 }
 /**
 * Result of an append operation.
@@ -219,6 +236,7 @@ interface AppendOptions {
 interface AppendResult {
   message: StreamMessage | null;
   producerResult?: ProducerValidationResult;
+  streamClosed?: boolean;
 }
 declare class StreamStore {
   private streams;
@@ -247,6 +265,7 @@ declare class StreamStore {
     ttlSeconds?: number;
     expiresAt?: string;
     initialData?: Uint8Array;
+    closed?: boolean;
   }): Stream;
   /**
   * Get a stream by path.
@@ -299,6 +318,28 @@ declare class StreamStore {
   */
   appendWithProducer(path: string, data: Uint8Array, options: AppendOptions): Promise<AppendResult>;
   /**
+  * Close a stream without appending data.
+  * @returns The final offset, or null if stream doesn't exist
+  */
+  closeStream(path: string): {
+    finalOffset: string;
+    alreadyClosed: boolean;
+  } | null;
+  /**
+  * Close a stream with producer headers for idempotent close-only operations.
+  * Participates in producer sequencing for deduplication.
+  * @returns The final offset and producer result, or null if stream doesn't exist
+  */
+  closeStreamWithProducer(path: string, options: {
+    producerId: string;
+    producerEpoch: number;
+    producerSeq: number;
+  }): Promise<{
+    finalOffset: string;
+    alreadyClosed: boolean;
+    producerResult?: ProducerValidationResult;
+  } | null>;
+  /**
   * Get the current epoch for a producer on a stream.
   * Returns undefined if the producer doesn't exist or stream not found.
   */
@@ -324,6 +365,7 @@ declare class StreamStore {
   waitForMessages(path: string, offset: string, timeoutMs: number): Promise<{
     messages: Array<StreamMessage>;
     timedOut: boolean;
+    streamClosed?: boolean;
   }>;
   /**
   * Get the current offset for a stream.
@@ -345,6 +387,11 @@ declare class StreamStore {
   private appendToStream;
   private findOffsetIndex;
   private notifyLongPolls;
+  /**
+  * Notify pending long-polls that a stream has been closed.
+  * They should wake up immediately and return Stream-Closed: true.
+  */
+  private notifyLongPollsClosed;
   private cancelLongPollsForStream;
   private removePendingLongPoll;
 } //#endregion
@@ -421,6 +468,7 @@ declare class FileBackedStreamStore {
     ttlSeconds?: number;
     expiresAt?: string;
     initialData?: Uint8Array;
+    closed?: boolean;
   }): Promise<Stream>;
   get(streamPath: string): Stream | undefined;
   has(streamPath: string): boolean;
@@ -433,6 +481,28 @@ declare class FileBackedStreamStore {
   * This ensures that validation+append is atomic per producer.
   */
   appendWithProducer(streamPath: string, data: Uint8Array, options: AppendOptions): Promise<AppendResult>;
+  /**
+  * Close a stream without appending data.
+  * @returns The final offset, or null if stream doesn't exist
+  */
+  closeStream(streamPath: string): {
+    finalOffset: string;
+    alreadyClosed: boolean;
+  } | null;
+  /**
+  * Close a stream with producer headers for idempotent close-only operations.
+  * Participates in producer sequencing for deduplication.
+  * @returns The final offset and producer result, or null if stream doesn't exist
+  */
+  closeStreamWithProducer(streamPath: string, options: {
+    producerId: string;
+    producerEpoch: number;
+    producerSeq: number;
+  }): Promise<{
+    finalOffset: string;
+    alreadyClosed: boolean;
+    producerResult?: ProducerValidationResult;
+  } | null>;
   read(streamPath: string, offset?: string): {
     messages: Array<StreamMessage>;
     upToDate: boolean;
@@ -440,6 +510,7 @@ declare class FileBackedStreamStore {
   waitForMessages(streamPath: string, offset: string, timeoutMs: number): Promise<{
     messages: Array<StreamMessage>;
     timedOut: boolean;
+    streamClosed?: boolean;
   }>;
   /**
   * Format messages for response.
@@ -455,10 +526,14 @@ declare class FileBackedStreamStore {
   cancelAllWaits(): void;
   list(): Array<string>;
   private notifyLongPolls;
+  /**
+  * Notify pending long-polls that a stream has been closed.
+  * They should wake up immediately and return Stream-Closed: true.
+  */
+  private notifyLongPollsClosed;
   private cancelLongPollsForStream;
   private removePendingLongPoll;
 }
-
 //#endregion
 //#region src/server.d.ts
 /**