feat: streaming entities

Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>

src/types/entity.ts

@@ -157,4 +157,41 @@ export interface EntityTransmitRequest {
 export interface EntityTransmitResponse {
   id: string;
   status: 'queued' | 'sent';
-}
+}
+
+/**
+ * Entity stream
+ */
+export interface EntityStreamRequest {
+  sources?: SourceSelector;
+  filter?: ListFilter;
+  sort?: ListSort;
+  range?: ListRange;
+}
+
+export interface EntityStreamMetaLine {
+  type: 'meta';
+  version: number;
+  transaction: string;
+  status: 'success';
+}
+
+export interface EntityStreamEntityLine extends EntityInterface<MessageInterface> {
+  type: 'entity';
+}
+
+export interface EntityStreamDoneLine {
+  type: 'done';
+  total: number;
+}
+
+export interface EntityStreamErrorLine {
+  type: 'error';
+  message: string;
+}
+
+export type EntityStreamLine =
+  | EntityStreamMetaLine
+  | EntityStreamEntityLine
+  | EntityStreamDoneLine
+  | EntityStreamErrorLine;