@semiont/api-client 0.1.0-build.6

package/dist/sse/types.d.ts

@@ -0,0 +1,295 @@
+/**
+ * TypeScript types for Server-Sent Events (SSE) streaming
+ *
+ * These types match the event payloads sent by backend SSE endpoints.
+ * They are not validated (per SSE-VALIDATION-CONSIDERATIONS.md) but provide
+ * type safety for client code consuming the streams.
+ */
+/**
+ * Progress event for entity detection stream
+ *
+ * Sent by POST /resources/:id/detect-annotations-stream
+ *
+ * @example
+ * ```typescript
+ * stream.onProgress((progress: DetectionProgress) => {
+ *   if (progress.status === 'scanning') {
+ *     console.log(`Scanning for ${progress.currentEntityType}...`);
+ *     console.log(`Progress: ${progress.processedEntityTypes}/${progress.totalEntityTypes}`);
+ *   }
+ * });
+ * ```
+ */
+export interface DetectionProgress {
+    /** Current status of detection operation */
+    status: 'started' | 'scanning' | 'complete' | 'error';
+    /** Resource ID being scanned */
+    resourceId: string;
+    /** Currently scanning for this entity type (only present during 'scanning') */
+    currentEntityType?: string;
+    /** Total number of entity types to scan */
+    totalEntityTypes: number;
+    /** Number of entity types processed so far */
+    processedEntityTypes: number;
+    /** Human-readable status message */
+    message?: string;
+    /** Total entities found (only present in 'complete') */
+    foundCount?: number;
+}
+/**
+ * Progress event for resource generation stream
+ *
+ * Sent by POST /resources/:resourceId/annotations/:annotationId/generate-resource-stream
+ *
+ * @example
+ * ```typescript
+ * stream.onProgress((progress: GenerationProgress) => {
+ *   console.log(`${progress.status}: ${progress.percentage}%`);
+ *   console.log(progress.message);
+ * });
+ * ```
+ */
+export interface GenerationProgress {
+    /** Current stage of generation operation */
+    status: 'started' | 'fetching' | 'generating' | 'creating' | 'complete' | 'error';
+    /** Annotation ID being used as source */
+    referenceId: string;
+    /** Name of resource being generated */
+    resourceName?: string;
+    /** ID of generated resource (only present in 'complete') */
+    resourceId?: string;
+    /** ID of source resource */
+    sourceResourceId?: string;
+    /** Percentage complete (0-100) */
+    percentage: number;
+    /** Human-readable status message */
+    message?: string;
+}
+/**
+ * Progress event for highlight detection stream
+ *
+ * Sent by POST /resources/:id/detect-highlights-stream
+ *
+ * @example
+ * ```typescript
+ * stream.onProgress((progress: HighlightDetectionProgress) => {
+ *   if (progress.status === 'analyzing') {
+ *     console.log(`Analyzing: ${progress.percentage}%`);
+ *   }
+ * });
+ * ```
+ */
+export interface HighlightDetectionProgress {
+    /** Current status of highlight detection operation */
+    status: 'started' | 'analyzing' | 'creating' | 'complete' | 'error';
+    /** Resource ID being analyzed */
+    resourceId: string;
+    /** Current stage of processing */
+    stage?: 'analyzing' | 'creating';
+    /** Percentage complete (0-100) */
+    percentage?: number;
+    /** Human-readable status message */
+    message?: string;
+    /** Total highlights found */
+    foundCount?: number;
+    /** Total highlights created */
+    createdCount?: number;
+}
+/**
+ * Progress event for assessment detection stream
+ *
+ * Sent by POST /resources/:id/detect-assessments-stream
+ *
+ * @example
+ * ```typescript
+ * stream.onProgress((progress: AssessmentDetectionProgress) => {
+ *   if (progress.status === 'analyzing') {
+ *     console.log(`Analyzing: ${progress.percentage}%`);
+ *   }
+ * });
+ * ```
+ */
+export interface AssessmentDetectionProgress {
+    /** Current status of assessment detection operation */
+    status: 'started' | 'analyzing' | 'creating' | 'complete' | 'error';
+    /** Resource ID being analyzed */
+    resourceId: string;
+    /** Current stage of processing */
+    stage?: 'analyzing' | 'creating';
+    /** Percentage complete (0-100) */
+    percentage?: number;
+    /** Human-readable status message */
+    message?: string;
+    /** Total assessments found */
+    foundCount?: number;
+    /** Total assessments created */
+    createdCount?: number;
+}
+/**
+ * Progress event for comment detection stream
+ *
+ * Sent by POST /resources/:id/detect-comments-stream
+ *
+ * @example
+ * ```typescript
+ * stream.onProgress((progress: CommentDetectionProgress) => {
+ *   if (progress.status === 'analyzing') {
+ *     console.log(`Analyzing: ${progress.percentage}%`);
+ *   }
+ * });
+ * ```
+ */
+export interface CommentDetectionProgress {
+    /** Current status of comment detection operation */
+    status: 'started' | 'analyzing' | 'creating' | 'complete' | 'error';
+    /** Resource ID being analyzed */
+    resourceId: string;
+    /** Current stage of processing */
+    stage?: 'analyzing' | 'creating';
+    /** Percentage complete (0-100) */
+    percentage?: number;
+    /** Human-readable status message */
+    message?: string;
+    /** Total comments found */
+    foundCount?: number;
+    /** Total comments created */
+    createdCount?: number;
+}
+/**
+ * Progress event for tag detection stream
+ *
+ * Sent by POST /resources/:id/detect-tags-stream
+ *
+ * @example
+ * ```typescript
+ * stream.onProgress((progress: TagDetectionProgress) => {
+ *   if (progress.status === 'analyzing') {
+ *     console.log(`Analyzing ${progress.currentCategory}: ${progress.percentage}%`);
+ *   }
+ * });
+ * ```
+ */
+export interface TagDetectionProgress {
+    /** Current status of tag detection operation */
+    status: 'started' | 'analyzing' | 'creating' | 'complete' | 'error';
+    /** Resource ID being analyzed */
+    resourceId: string;
+    /** Current stage of processing */
+    stage?: 'analyzing' | 'creating';
+    /** Percentage complete (0-100) */
+    percentage?: number;
+    /** Currently processing this category */
+    currentCategory?: string;
+    /** Number of categories processed */
+    processedCategories?: number;
+    /** Total number of categories */
+    totalCategories?: number;
+    /** Human-readable status message */
+    message?: string;
+    /** Total tags found */
+    tagsFound?: number;
+    /** Total tags created */
+    tagsCreated?: number;
+    /** Tags found by category */
+    byCategory?: Record<string, number>;
+}
+/**
+ * Resource event from real-time event stream
+ *
+ * Sent by GET /resources/:id/events/stream
+ *
+ * This represents a single event from the event store, broadcast in real-time
+ * as it occurs. Used for real-time collaboration - multiple users see each
+ * other's changes as they happen.
+ *
+ * @example
+ * ```typescript
+ * stream.onEvent((event: ResourceEvent) => {
+ *   console.log(`Event: ${event.type}`);
+ *   console.log(`User: ${event.userId}`);
+ *   console.log(`Payload:`, event.payload);
+ *   console.log(`Sequence: ${event.metadata.sequenceNumber}`);
+ * });
+ * ```
+ */
+export interface ResourceEvent {
+    /** Event ID (unique) */
+    id: string;
+    /** Event type (e.g., 'resource.created', 'annotation.created', etc.) */
+    type: string;
+    /** ISO 8601 timestamp */
+    timestamp: string;
+    /** User ID who triggered the event */
+    userId: string;
+    /** Resource ID this event relates to */
+    resourceId: string;
+    /** Event-specific payload (varies by event type) */
+    payload: any;
+    /** Event store metadata */
+    metadata: {
+        /** Monotonically increasing sequence number */
+        sequenceNumber: number;
+        /** SHA-256 hash of previous event (for integrity) */
+        prevEventHash: string;
+        /** SHA-256 checksum of this event */
+        checksum: string;
+    };
+}
+/**
+ * SSE stream controller interface
+ *
+ * Returned by all SSE methods. Provides callback registration and cleanup.
+ *
+ * @typeParam TProgress - Type of progress events
+ * @typeParam TComplete - Type of completion event
+ *
+ * @example
+ * ```typescript
+ * const stream: SSEStream<DetectionProgress, DetectionProgress> =
+ *   client.sse.detectAnnotations(resourceId, { entityTypes: ['Person'] });
+ *
+ * stream.onProgress((p) => console.log(p.message));
+ * stream.onComplete((r) => console.log(`Done! Found ${r.foundCount} entities`));
+ * stream.onError((e) => console.error('Failed:', e.message));
+ *
+ * // Cleanup when done
+ * stream.close();
+ * ```
+ */
+export interface SSEStream<TProgress, TComplete> {
+    /**
+     * Register callback for progress events
+     *
+     * Called for each progress update (e.g., detection-started, detection-progress)
+     */
+    onProgress(callback: (progress: TProgress) => void): void;
+    /**
+     * Register callback for completion event
+     *
+     * Called once when operation completes successfully (e.g., detection-complete)
+     */
+    onComplete(callback: (result: TComplete) => void): void;
+    /**
+     * Register callback for error events
+     *
+     * Called if operation fails or stream encounters an error
+     */
+    onError(callback: (error: Error) => void): void;
+    /**
+     * Close the SSE stream and abort the connection
+     *
+     * Should be called to cleanup resources when stream is no longer needed.
+     * Safe to call multiple times.
+     *
+     * @example
+     * ```typescript
+     * // React cleanup
+     * useEffect(() => {
+     *   const stream = client.sse.detectAnnotations(...);
+     *   return () => stream.close();
+     * }, []);
+     * ```
+     */
+    close(): void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/sse/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/sse/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,iBAAiB;IAChC,4CAA4C;IAC5C,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IACtD,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2CAA2C;IAC3C,gBAAgB,EAAE,MAAM,CAAC;IACzB,8CAA8C;IAC9C,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IAClF,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,0BAA0B;IACzC,sDAAsD;IACtD,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IACpE,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,KAAK,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACjC,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,2BAA2B;IAC1C,uDAAuD;IACvD,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IACpE,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,KAAK,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACjC,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,wBAAwB;IACvC,oDAAoD;IACpD,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IACpE,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,KAAK,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACjC,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,oBAAoB;IACnC,gDAAgD;IAChD,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IACpE,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,KAAK,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACjC,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qCAAqC;IACrC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,iCAAiC;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,aAAa;IAC5B,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,OAAO,EAAE,GAAG,CAAC;IACb,2BAA2B;IAC3B,QAAQ,EAAE;QACR,+CAA+C;QAC/C,cAAc,EAAE,MAAM,CAAC;QACvB,qDAAqD;QACrD,aAAa,EAAE,MAAM,CAAC;QACtB,qCAAqC;QACrC,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,SAAS,CAAC,SAAS,EAAE,SAAS;IAC7C;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,GAAG,IAAI,CAAC;IAExD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IAEhD;;;;;;;;;;;;;;OAcG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}

package/dist/sse/types.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * TypeScript types for Server-Sent Events (SSE) streaming
+ *
+ * These types match the event payloads sent by backend SSE endpoints.
+ * They are not validated (per SSE-VALIDATION-CONSIDERATIONS.md) but provide
+ * type safety for client code consuming the streams.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/sse/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/sse/types.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}