feat: streaming entities

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

src/services/entityService.ts

@@ -2,7 +2,7 @@
  * Entity management service
  */
 
-import { transceivePost } from './transceive';
+import { transceivePost, transceiveStream } from './transceive';
 import type {
   EntityListRequest,
   EntityListResponse,
@@ -21,6 +21,10 @@ import type {
   EntityTransmitRequest,
   EntityTransmitResponse,
   EntityInterface,
+  EntityStreamRequest,
+  EntityStreamLine,
+  EntityStreamEntityLine,
+  EntityStreamDoneLine,
 } from '../types/entity';
 import { useIntegrationStore } from '@KTXC/stores/integrationStore';
 import { EntityObject } from '../models';
@@ -157,6 +161,41 @@ export const entityService = {
   async transmit(request: EntityTransmitRequest): Promise<EntityTransmitResponse> {
     return await transceivePost<EntityTransmitRequest, EntityTransmitResponse>('entity.transmit', request);
   },
+
+  /**
+   * Stream entities as NDJSON, invoking onEntity for each entity as it arrives.
+   *
+   * The server emits one entity per line so the caller receives entities
+   * progressively rather than waiting for the full collection to load.
+   *
+   * @param request  - stream request parameters (same shape as list)
+   * @param onEntity - called synchronously for each entity as it is received
+   *
+   * @returns Promise resolving to { total } when the stream completes
+   */
+  async stream(
+    request: EntityStreamRequest,
+    onEntity: (entity: EntityObject) => void
+  ): Promise<{ total: number }> {
+    let total = 0;
+
+    await transceiveStream<EntityStreamRequest, EntityStreamLine>(
+      'entity.stream',
+      request,
+      (line) => {
+        if (line.type === 'entity') {
+          onEntity(createEntityObject(line as EntityStreamEntityLine));
+        } else if (line.type === 'done') {
+          total = (line as EntityStreamDoneLine).total;
+        } else if (line.type === 'error') {
+          throw new Error(`[entity.stream] ${line.message}`);
+        }
+        // 'meta' lines are silently consumed
+      }
+    );
+
+    return { total };
+  },
 };
 
 export default entityService;

src/services/transceive.ts

@@ -48,3 +48,68 @@ export async function transceivePost<TRequest, TResponse>(
   
   return response.data;
 }
+
+/**
+ * Stream an NDJSON API response, calling onLine for each parsed line.
+ *
+ * The server emits one JSON object per line with a `type` discriminant
+ * (meta / entity / done / error). The caller interprets each line via onLine.
+ * Throwing inside onLine aborts the stream.
+ *
+ * @param operation - Operation name, e.g. 'entity.stream'
+ * @param data      - Operation-specific request data
+ * @param onLine    - Synchronous callback invoked for every parsed line.
+ *                    May throw to abort the stream.
+ * @param user      - Optional user identifier override
+ */
+export async function transceiveStream<TRequest, TLine = any>(
+  operation: string,
+  data: TRequest,
+  onLine: (line: TLine) => void,
+  user?: string
+): Promise<void> {
+  const request: ApiRequest<TRequest> = {
+    version: API_VERSION,
+    transaction: generateTransactionId(),
+    operation,
+    data,
+    user,
+  };
+
+  await fetchWrapper.post(API_URL, request, {
+    //headers: { 'Accept': 'application/x-ndjson' },
+    headers: { 'Accept': 'application/json' },
+    onStream: async (response) => {
+      if (!response.body) {
+        throw new Error(`[${operation}] Response body is not readable`);
+      }
+
+      const reader = response.body.getReader();
+      const decoder = new TextDecoder();
+      let buffer = '';
+
+      try {
+        while (true) {
+          const { done, value } = await reader.read();
+          if (done) break;
+
+          buffer += decoder.decode(value, { stream: true });
+          const lines = buffer.split('\n');
+          buffer = lines.pop()!; // retain any incomplete trailing chunk
+
+          for (const line of lines) {
+            if (!line.trim()) continue;
+            onLine(JSON.parse(line) as TLine);
+          }
+        }
+
+        // flush any remaining bytes still in the buffer
+        if (buffer.trim()) {
+          onLine(JSON.parse(buffer) as TLine);
+        }
+      } finally {
+        reader.releaseLock();
+      }
+    },
+  });
+}

src/stores/entitiesStore.ts

@@ -6,7 +6,7 @@ import { ref, computed, readonly } from 'vue'
 import { defineStore } from 'pinia'
 import { entityService } from '../services'
 import { EntityObject } from '../models'
-import type { EntityTransmitRequest, EntityTransmitResponse } from '../types/entity'
+import type { EntityTransmitRequest, EntityTransmitResponse, EntityStreamRequest } from '../types/entity'
 import type { SourceSelector, ListFilter, ListSort, ListRange } from '../types/common'
 
 export const useEntitiesStore = defineStore('mailEntitiesStore', () => {
@@ -103,26 +103,16 @@ export const useEntitiesStore = defineStore('mailEntitiesStore', () => {
   async function list(sources?: SourceSelector, filter?: ListFilter, sort?: ListSort, range?: ListRange): Promise<Record<string, EntityObject>> {
     transceiving.value = true
     try {
-      const response = await entityService.list({ sources, filter, sort, range })
+      const added: Record<string, EntityObject> = {}
 
-      // Flatten nested structure: provider:service:collection:entity -> "provider:service:collection:entity": object
-      const entities: Record<string, EntityObject> = {}
-      Object.entries(response).forEach(([providerId, providerServices]) => {
-        Object.entries(providerServices).forEach(([serviceId, serviceCollections]) => {
-          Object.entries(serviceCollections).forEach(([collectionId, collectionEntities]) => {
-            Object.entries(collectionEntities).forEach(([entityId, entityData]) => {
-              const key = identifierKey(providerId, serviceId, collectionId, entityId)
-              entities[key] = entityData
-            })
-          })
-        })
+      await entityService.stream({ sources, filter, sort, range }, (entity: EntityObject) => {
+        const key = identifierKey(entity.provider, entity.service, entity.collection, entity.identifier)
+        _entities.value[key] = entity
+        added[key] = entity
       })
 
-      // Merge retrieved entities into state
-      _entities.value = { ..._entities.value, ...entities }
-
-      console.debug('[Mail Manager][Store] - Successfully retrieved', Object.keys(entities).length, 'entities')
-      return entities
+      console.debug('[Mail Manager][Store] - Successfully retrieved', Object.keys(added).length, 'entities')
+      return added
     } catch (error: any) {
       console.error('[Mail Manager][Store] - Failed to retrieve entities:', error)
       throw error
@@ -346,6 +336,42 @@ export const useEntitiesStore = defineStore('mailEntitiesStore', () => {
     }
   }
 
+  /**
+   * Stream entities progressively, merging each entity into the store as it arrives.
+   *
+   * Unlike list(), which waits for the full response before updating the store,
+   * stream() updates reactive state entity-by-entity so UI renders incrementally.
+   *
+   * @param sources - optional source selector
+   * @param filter  - optional list filter
+   * @param sort    - optional list sort
+   * @param range   - optional list range
+   *
+   * @returns Promise resolving to { total } when the stream completes
+   */
+  async function stream(
+    sources?: SourceSelector,
+    filter?: ListFilter,
+    sort?: ListSort,
+    range?: ListRange
+  ): Promise<{ total: number }> {
+    transceiving.value = true
+    try {
+      const request: EntityStreamRequest = { sources, filter, sort, range }
+      const result = await entityService.stream(request, (entity: EntityObject) => {
+        const key = identifierKey(entity.provider, entity.service, entity.collection, entity.identifier)
+        _entities.value[key] = entity
+      })
+      console.debug('[Mail Manager][Store] - Successfully streamed', result.total, 'entities')
+      return result
+    } catch (error: any) {
+      console.error('[Mail Manager][Store] - Failed to stream entities:', error)
+      throw error
+    } finally {
+      transceiving.value = false
+    }
+  }
+
   // Return public API
   return {
     // State (readonly)
@@ -365,5 +391,6 @@ export const useEntitiesStore = defineStore('mailEntitiesStore', () => {
     delete: remove,
     delta,
     transmit,
+    stream,
   }
 })

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;