@elqnt/kg 3.0.0 → 3.0.2

package/dist/transport/index.d.mts

@@ -0,0 +1,365 @@
+import { KGApiOptions } from '../api/index.mjs';
+import '@elqnt/api-client';
+import '@elqnt/types';
+import '../models/kg.mjs';
+import '../models/kg-designer.mjs';
+import '../models/index.mjs';
+
+/**
+ * Quick Ingestion SSE Transport
+ *
+ * Handles real-time progress updates for quick ingestion jobs.
+ *
+ * @example
+ * ```typescript
+ * import { createQuickIngestTransport } from "@elqnt/kg/transport";
+ *
+ * const transport = createQuickIngestTransport({ debug: true });
+ * await transport.connect({ baseUrl, orgId });
+ *
+ * transport.on("item_start", (event) => {
+ *   console.log("Started processing:", event.itemId);
+ * });
+ *
+ * transport.on("item_progress", (event) => {
+ *   console.log(`Progress: ${event.progress}% - ${event.text}`);
+ * });
+ *
+ * transport.on("item_complete", (event) => {
+ *   console.log(`Completed: ${event.articles} articles, ${event.topics} topics`);
+ * });
+ *
+ * transport.on("job_complete", (event) => {
+ *   console.log(`Job done: ${event.totalArticles} articles, ${event.totalTopics} topics`);
+ * });
+ *
+ * transport.subscribeToJob("qij_xyz789");
+ * ```
+ */
+
+/**
+ * Transport configuration
+ */
+interface QuickIngestTransportConfig {
+    /** Base URL for the API */
+    baseUrl: string;
+    /** Organization ID */
+    orgId: string;
+    /** Optional graph ID */
+    graphId?: string;
+    /** User ID for authentication */
+    userId?: string;
+}
+/**
+ * Transport options
+ */
+interface QuickIngestTransportOptions {
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Event when an item starts processing
+ */
+interface QuickIngestItemStartEvent {
+    type: "item_start";
+    itemId: string;
+    timestamp: number;
+}
+/**
+ * Event when an item has progress update
+ */
+interface QuickIngestItemProgressEvent {
+    type: "item_progress";
+    itemId: string;
+    progress: number;
+    text: string;
+    timestamp: number;
+}
+/**
+ * Event when an item completes successfully
+ */
+interface QuickIngestItemCompleteEvent {
+    type: "item_complete";
+    itemId: string;
+    articles: number;
+    topics: number;
+    timestamp: number;
+}
+/**
+ * Event when an item encounters an error
+ */
+interface QuickIngestItemErrorEvent {
+    type: "item_error";
+    itemId: string;
+    error: string;
+    timestamp: number;
+}
+/**
+ * Event when the entire job completes
+ */
+interface QuickIngestJobCompleteEvent {
+    type: "job_complete";
+    totalArticles: number;
+    totalTopics: number;
+    timestamp: number;
+}
+/**
+ * Union of all quick ingest events
+ */
+type QuickIngestEvent = QuickIngestItemStartEvent | QuickIngestItemProgressEvent | QuickIngestItemCompleteEvent | QuickIngestItemErrorEvent | QuickIngestJobCompleteEvent;
+/**
+ * Event handler function type
+ */
+type QuickIngestEventHandler<T = QuickIngestEvent> = (event: T) => void;
+/**
+ * Unsubscribe function
+ */
+type Unsubscribe = () => void;
+/**
+ * Quick Ingest Transport interface
+ */
+interface QuickIngestTransport {
+    /**
+     * Connect to the transport
+     */
+    connect(options: KGApiOptions): Promise<void>;
+    /**
+     * Subscribe to a specific job's events
+     */
+    subscribeToJob(jobId: string): void;
+    /**
+     * Subscribe to specific event type
+     */
+    on<T extends QuickIngestEvent["type"]>(eventType: T, handler: QuickIngestEventHandler<Extract<QuickIngestEvent, {
+        type: T;
+    }>>): Unsubscribe;
+    /**
+     * Disconnect from the transport
+     */
+    disconnect(): void;
+    /**
+     * Get current connection state
+     */
+    getState(): "disconnected" | "connecting" | "connected";
+}
+/**
+ * Create a Quick Ingest SSE transport
+ */
+declare function createQuickIngestTransport(options?: QuickIngestTransportOptions): QuickIngestTransport;
+
+/**
+ * Full Ingestion SSE Transport
+ *
+ * Handles real-time progress updates and node streaming for full ingestion extraction.
+ *
+ * @example
+ * ```typescript
+ * import { createFullIngestTransport } from "@elqnt/kg/transport";
+ *
+ * const transport = createFullIngestTransport({ debug: true });
+ * await transport.connect({ baseUrl, orgId });
+ *
+ * transport.on("progress", (event) => {
+ *   console.log(`Extracting page ${event.currentPage} of ${event.totalPages}`);
+ * });
+ *
+ * transport.on("node", (event) => {
+ *   console.log("Extracted node:", event.label, event.fields);
+ * });
+ *
+ * transport.on("complete", (event) => {
+ *   console.log(`Extraction done: ${event.totalNodes} nodes`);
+ * });
+ *
+ * transport.subscribeToJob("fij_extract_789");
+ * ```
+ */
+
+/**
+ * Transport configuration
+ */
+interface FullIngestTransportConfig {
+    /** Base URL for the API */
+    baseUrl: string;
+    /** Organization ID */
+    orgId: string;
+    /** Optional graph ID */
+    graphId?: string;
+    /** User ID for authentication */
+    userId?: string;
+}
+/**
+ * Transport options
+ */
+interface FullIngestTransportOptions {
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Event for extraction progress
+ */
+interface FullIngestProgressEvent {
+    type: "progress";
+    currentPage: number;
+    totalPages: number;
+    timestamp: number;
+}
+/**
+ * Event when a node is extracted
+ */
+interface FullIngestNodeEvent {
+    type: "node";
+    id: string;
+    label: string;
+    fields: Record<string, unknown>;
+    timestamp: number;
+}
+/**
+ * Event when consolidation is starting
+ */
+interface FullIngestConsolidatingEvent {
+    type: "consolidating";
+    message: string;
+    rawCount?: number;
+    timestamp: number;
+}
+/**
+ * Event when consolidation progress updates
+ */
+interface FullIngestConsolidateProgressEvent {
+    type: "consolidate_progress";
+    message: string;
+    timestamp: number;
+}
+/**
+ * Event when consolidation completes
+ */
+interface FullIngestConsolidatedEvent {
+    type: "consolidated";
+    totalNodes: number;
+    mergedCount: number;
+    message: string;
+    timestamp: number;
+}
+/**
+ * Event when linking/relationship extraction starts
+ */
+interface FullIngestLinkingEvent {
+    type: "linking";
+    message: string;
+    timestamp: number;
+}
+/**
+ * Event when linking completes
+ */
+interface FullIngestLinkedEvent {
+    type: "linked";
+    message: string;
+    timestamp: number;
+}
+/**
+ * Event when an edge is extracted
+ */
+interface FullIngestEdgeEvent {
+    type: "edge";
+    id: string;
+    fromLabel: string;
+    fromName: string;
+    toLabel: string;
+    toName: string;
+    edgeLabel: string;
+    confidence: number;
+    timestamp: number;
+}
+/**
+ * Event when extraction completes
+ */
+interface FullIngestCompleteEvent {
+    type: "complete";
+    totalNodes: number;
+    totalEdges?: number;
+    message?: string;
+    timestamp: number;
+}
+/**
+ * Event when extraction encounters an error
+ */
+interface FullIngestErrorEvent {
+    type: "error";
+    message: string;
+    timestamp: number;
+}
+/**
+ * Event when ingestion to KG starts
+ */
+interface FullIngestIngestingEvent {
+    type: "ingesting";
+    message: string;
+    totalNodes: number;
+    totalEdges: number;
+    timestamp: number;
+}
+/**
+ * Event for ingestion progress (node/edge being ingested)
+ */
+interface FullIngestIngestProgressEvent {
+    type: "ingest_progress";
+    message: string;
+    currentNode: number;
+    totalNodes: number;
+    currentEdge: number;
+    totalEdges: number;
+    timestamp: number;
+}
+/**
+ * Event when ingestion to KG completes
+ */
+interface FullIngestIngestCompleteEvent {
+    type: "ingest_complete";
+    message: string;
+    nodesIngested: number;
+    edgesIngested: number;
+    timestamp: number;
+}
+/**
+ * Union of all full ingest events
+ */
+type FullIngestEvent = FullIngestProgressEvent | FullIngestNodeEvent | FullIngestConsolidatingEvent | FullIngestConsolidateProgressEvent | FullIngestConsolidatedEvent | FullIngestLinkingEvent | FullIngestLinkedEvent | FullIngestEdgeEvent | FullIngestCompleteEvent | FullIngestErrorEvent | FullIngestIngestingEvent | FullIngestIngestProgressEvent | FullIngestIngestCompleteEvent;
+/**
+ * Event handler function type
+ */
+type FullIngestEventHandler<T = FullIngestEvent> = (event: T) => void;
+
+/**
+ * Full Ingest Transport interface
+ */
+interface FullIngestTransport {
+    /**
+     * Connect to the transport
+     */
+    connect(options: KGApiOptions): Promise<void>;
+    /**
+     * Subscribe to a specific job's events
+     */
+    subscribeToJob(jobId: string): void;
+    /**
+     * Subscribe to specific event type
+     */
+    on<T extends FullIngestEvent["type"]>(eventType: T, handler: FullIngestEventHandler<Extract<FullIngestEvent, {
+        type: T;
+    }>>): Unsubscribe;
+    /**
+     * Disconnect from the transport
+     */
+    disconnect(): void;
+    /**
+     * Get current connection state
+     */
+    getState(): "disconnected" | "connecting" | "connected";
+}
+/**
+ * Create a Full Ingest SSE transport
+ */
+declare function createFullIngestTransport(options?: FullIngestTransportOptions): FullIngestTransport;
+
+export { type FullIngestCompleteEvent, type FullIngestConsolidateProgressEvent, type FullIngestConsolidatedEvent, type FullIngestConsolidatingEvent, type FullIngestEdgeEvent, type FullIngestErrorEvent, type FullIngestEvent, type FullIngestEventHandler, type FullIngestIngestCompleteEvent, type FullIngestIngestProgressEvent, type FullIngestIngestingEvent, type FullIngestLinkedEvent, type FullIngestLinkingEvent, type FullIngestNodeEvent, type FullIngestProgressEvent, type FullIngestTransport, type FullIngestTransportConfig, type FullIngestTransportOptions, type QuickIngestEvent, type QuickIngestEventHandler, type QuickIngestItemCompleteEvent, type QuickIngestItemErrorEvent, type QuickIngestItemProgressEvent, type QuickIngestItemStartEvent, type QuickIngestJobCompleteEvent, type QuickIngestTransport, type QuickIngestTransportConfig, type QuickIngestTransportOptions, type Unsubscribe, createFullIngestTransport, createQuickIngestTransport };