@semiont/api-client 0.2.1 → 0.2.2

package/dist/sse/index.d.ts

@@ -1,343 +0,0 @@
-/**
- * SSE Client for Semiont Streaming Endpoints
- *
- * Provides type-safe methods for Server-Sent Events streaming.
- * Does NOT use ky - uses native fetch() for SSE support.
- */
-import type { DetectionProgress, GenerationProgress, HighlightDetectionProgress, AssessmentDetectionProgress, CommentDetectionProgress, TagDetectionProgress, ResourceEvent, SSEStream } from './types';
-import type { ResourceUri, AnnotationUri } from '../branded-types';
-import type { AccessToken, BaseUrl, EntityType } from '../branded-types';
-import type { components } from '../types';
-/**
- * Request body for detection stream
- */
-export interface DetectAnnotationsStreamRequest {
-    entityTypes: EntityType[];
-}
-/**
- * Request body for generation stream
- * Uses generated type from OpenAPI schema
- */
-export type GenerateResourceStreamRequest = components['schemas']['GenerateResourceStreamRequest'];
-/**
- * Request body for highlight detection stream
- */
-export interface DetectHighlightsStreamRequest {
-    instructions?: string;
-}
-/**
- * Request body for assessment detection stream
- */
-export interface DetectAssessmentsStreamRequest {
-    instructions?: string;
-}
-/**
- * Request body for comment detection stream
- */
-export interface DetectCommentsStreamRequest {
-    instructions?: string;
-    tone?: 'scholarly' | 'explanatory' | 'conversational' | 'technical';
-}
-/**
- * Request body for tag detection stream
- */
-export interface DetectTagsStreamRequest {
-    schemaId: string;
-    categories: string[];
-}
-/**
- * SSE Client configuration
- */
-export interface SSEClientConfig {
-    baseUrl: BaseUrl;
-    accessToken?: AccessToken;
-}
-/**
- * SSE Client for real-time streaming operations
- *
- * Separate from the main HTTP client to clearly mark streaming endpoints.
- * Uses native fetch() instead of ky for SSE support.
- *
- * @example
- * ```typescript
- * const sseClient = new SSEClient({
- *   baseUrl: 'http://localhost:4000',
- *   accessToken: 'your-token'
- * });
- *
- * const stream = sseClient.detectAnnotations(
- *   'http://localhost:4000/resources/doc-123',
- *   { entityTypes: ['Person', 'Organization'] }
- * );
- *
- * stream.onProgress((p) => console.log(p.message));
- * stream.onComplete((r) => console.log(`Found ${r.foundCount} entities`));
- * stream.onError((e) => console.error('Detection failed:', e));
- * ```
- */
-export declare class SSEClient {
-    private baseUrl;
-    private accessToken;
-    constructor(config: SSEClientConfig);
-    /**
-     * Set the access token for authenticated requests
-     */
-    setAccessToken(token: AccessToken): void;
-    /**
-     * Clear the access token
-     */
-    clearAccessToken(): void;
-    /**
-     * Get common headers for SSE requests
-     */
-    private getHeaders;
-    /**
-     * Extract resource ID from URI
-     *
-     * Handles both full URIs and plain IDs:
-     * - 'http://localhost:4000/resources/doc-123' -> 'doc-123'
-     * - 'doc-123' -> 'doc-123'
-     */
-    private extractId;
-    /**
-     * Detect annotations in a resource (streaming)
-     *
-     * Streams entity detection progress via Server-Sent Events.
-     *
-     * @param resourceId - Resource URI or ID
-     * @param request - Detection configuration (entity types to detect)
-     * @returns SSE stream controller with progress/complete/error callbacks
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.detectAnnotations(
-     *   'http://localhost:4000/resources/doc-123',
-     *   { entityTypes: ['Person', 'Organization'] }
-     * );
-     *
-     * stream.onProgress((progress) => {
-     *   console.log(`Scanning: ${progress.currentEntityType}`);
-     *   console.log(`Progress: ${progress.processedEntityTypes}/${progress.totalEntityTypes}`);
-     * });
-     *
-     * stream.onComplete((result) => {
-     *   console.log(`Detection complete! Found ${result.foundCount} entities`);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Detection failed:', error.message);
-     * });
-     *
-     * // Cleanup when done
-     * stream.close();
-     * ```
-     */
-    detectAnnotations(resourceId: ResourceUri, request: DetectAnnotationsStreamRequest): SSEStream<DetectionProgress, DetectionProgress>;
-    /**
-     * Generate resource from annotation (streaming)
-     *
-     * Streams resource generation progress via Server-Sent Events.
-     *
-     * @param resourceId - Source resource URI or ID
-     * @param annotationId - Annotation URI or ID to use as generation source
-     * @param request - Generation options (title, prompt, language)
-     * @returns SSE stream controller with progress/complete/error callbacks
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.generateResourceFromAnnotation(
-     *   'http://localhost:4000/resources/doc-123',
-     *   'http://localhost:4000/annotations/ann-456',
-     *   { language: 'es', title: 'Spanish Summary' }
-     * );
-     *
-     * stream.onProgress((progress) => {
-     *   console.log(`${progress.status}: ${progress.percentage}%`);
-     *   console.log(progress.message);
-     * });
-     *
-     * stream.onComplete((result) => {
-     *   console.log(`Generated resource: ${result.resourceId}`);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Generation failed:', error.message);
-     * });
-     *
-     * // Cleanup when done
-     * stream.close();
-     * ```
-     */
-    generateResourceFromAnnotation(resourceId: ResourceUri, annotationId: AnnotationUri, request: GenerateResourceStreamRequest): SSEStream<GenerationProgress, GenerationProgress>;
-    /**
-     * Detect highlights in a resource (streaming)
-     *
-     * Streams highlight detection progress via Server-Sent Events.
-     *
-     * @param resourceId - Resource URI or ID
-     * @param request - Detection configuration (optional instructions)
-     * @returns SSE stream controller with progress/complete/error callbacks
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.detectHighlights(
-     *   'http://localhost:4000/resources/doc-123',
-     *   { instructions: 'Focus on key technical points' }
-     * );
-     *
-     * stream.onProgress((progress) => {
-     *   console.log(`${progress.status}: ${progress.percentage}%`);
-     *   console.log(progress.message);
-     * });
-     *
-     * stream.onComplete((result) => {
-     *   console.log(`Detection complete! Created ${result.createdCount} highlights`);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Detection failed:', error.message);
-     * });
-     *
-     * // Cleanup when done
-     * stream.close();
-     * ```
-     */
-    detectHighlights(resourceId: ResourceUri, request?: DetectHighlightsStreamRequest): SSEStream<HighlightDetectionProgress, HighlightDetectionProgress>;
-    /**
-     * Detect assessments in a resource (streaming)
-     *
-     * Streams assessment detection progress via Server-Sent Events.
-     *
-     * @param resourceId - Resource URI or ID
-     * @param request - Detection configuration (optional instructions)
-     * @returns SSE stream controller with progress/complete/error callbacks
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.detectAssessments(
-     *   'http://localhost:4000/resources/doc-123',
-     *   { instructions: 'Evaluate claims for accuracy' }
-     * );
-     *
-     * stream.onProgress((progress) => {
-     *   console.log(`${progress.status}: ${progress.percentage}%`);
-     *   console.log(progress.message);
-     * });
-     *
-     * stream.onComplete((result) => {
-     *   console.log(`Detection complete! Created ${result.createdCount} assessments`);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Detection failed:', error.message);
-     * });
-     *
-     * // Cleanup when done
-     * stream.close();
-     * ```
-     */
-    detectAssessments(resourceId: ResourceUri, request?: DetectAssessmentsStreamRequest): SSEStream<AssessmentDetectionProgress, AssessmentDetectionProgress>;
-    /**
-     * Detect comments in a resource (streaming)
-     *
-     * Streams comment detection progress via Server-Sent Events.
-     * Uses AI to identify passages that would benefit from explanatory comments
-     * and creates comment annotations with contextual information.
-     *
-     * @param resourceId - Resource URI or ID
-     * @param request - Detection configuration (optional instructions and tone)
-     * @returns SSE stream controller with progress/complete/error callbacks
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.detectComments('http://localhost:4000/resources/doc-123', {
-     *   instructions: 'Focus on technical terminology',
-     *   tone: 'scholarly'
-     * });
-     *
-     * stream.onProgress((progress) => {
-     *   console.log(`${progress.status}: ${progress.percentage}%`);
-     * });
-     *
-     * stream.onComplete((result) => {
-     *   console.log(`Detection complete! Created ${result.createdCount} comments`);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Detection failed:', error.message);
-     * });
-     *
-     * // Cleanup when done
-     * stream.close();
-     * ```
-     */
-    detectComments(resourceId: ResourceUri, request?: DetectCommentsStreamRequest): SSEStream<CommentDetectionProgress, CommentDetectionProgress>;
-    /**
-     * Detect tags in a resource (streaming)
-     *
-     * Streams tag detection progress via Server-Sent Events.
-     * Uses AI to identify passages serving specific structural roles
-     * (e.g., IRAC, IMRAD, Toulmin) and creates tag annotations with dual-body structure.
-     *
-     * @param resourceId - Resource URI or ID
-     * @param request - Detection configuration (schema and categories to detect)
-     * @returns SSE stream controller with progress/complete/error callbacks
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.detectTags('http://localhost:4000/resources/doc-123', {
-     *   schemaId: 'legal-irac',
-     *   categories: ['Issue', 'Rule', 'Application', 'Conclusion']
-     * });
-     *
-     * stream.onProgress((progress) => {
-     *   console.log(`${progress.status}: ${progress.percentage}%`);
-     *   console.log(`Processing ${progress.currentCategory}...`);
-     * });
-     *
-     * stream.onComplete((result) => {
-     *   console.log(`Detection complete! Created ${result.tagsCreated} tags`);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Detection failed:', error.message);
-     * });
-     *
-     * // Cleanup when done
-     * stream.close();
-     * ```
-     */
-    detectTags(resourceId: ResourceUri, request: DetectTagsStreamRequest): SSEStream<TagDetectionProgress, TagDetectionProgress>;
-    /**
-     * Subscribe to resource events (long-lived stream)
-     *
-     * Opens a long-lived SSE connection to receive real-time events for a resource.
-     * Used for collaborative editing - see events from other users as they happen.
-     *
-     * This stream does NOT have a complete event - it stays open until explicitly closed.
-     *
-     * @param resourceId - Resource URI or ID to subscribe to
-     * @returns SSE stream controller with event callback
-     *
-     * @example
-     * ```typescript
-     * const stream = sseClient.resourceEvents('http://localhost:4000/resources/doc-123');
-     *
-     * stream.onProgress((event) => {
-     *   console.log(`Event: ${event.type}`);
-     *   console.log(`User: ${event.userId}`);
-     *   console.log(`Sequence: ${event.metadata.sequenceNumber}`);
-     *   console.log(`Payload:`, event.payload);
-     * });
-     *
-     * stream.onError((error) => {
-     *   console.error('Stream error:', error.message);
-     * });
-     *
-     * // Close when no longer needed (e.g., component unmount)
-     * stream.close();
-     * ```
-     */
-    resourceEvents(resourceId: ResourceUri): SSEStream<ResourceEvent, never>;
-}
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/sse/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,wBAAwB,EACxB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACV,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,+BAA+B,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,gBAAgB,GAAG,WAAW,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,WAAW,CAA4B;gBAEnC,MAAM,EAAE,eAAe;IAMnC;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAIxC;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;OAEG;IACH,OAAO,CAAC,UAAU;IAYlB;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;IAKjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,iBAAiB,CACf,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,8BAA8B,GACtC,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAmBlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,8BAA8B,CAC5B,UAAU,EAAE,WAAW,EACvB,YAAY,EAAE,aAAa,EAC3B,OAAO,EAAE,6BAA6B,GACrC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAoBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,gBAAgB,CACd,UAAU,EAAE,WAAW,EACvB,OAAO,GAAE,6BAAkC,GAC1C,SAAS,CAAC,0BAA0B,EAAE,0BAA0B,CAAC;IAmBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,iBAAiB,CACf,UAAU,EAAE,WAAW,EACvB,OAAO,GAAE,8BAAmC,GAC3C,SAAS,CAAC,2BAA2B,EAAE,2BAA2B,CAAC;IAmBtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,cAAc,CACZ,UAAU,EAAE,WAAW,EACvB,OAAO,GAAE,2BAAgC,GACxC,SAAS,CAAC,wBAAwB,EAAE,wBAAwB,CAAC;IAmBhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,UAAU,CACR,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,uBAAuB,GAC/B,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAmBxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,cAAc,CAAC,UAAU,EAAE,WAAW,GAAG,SAAS,CAAC,aAAa,EAAE,KAAK,CAAC;CAkBzE"}