@semiont/react-ui 0.2.43 → 0.2.46

package/dist/index.d.mts

@@ -14,17 +14,17 @@ import { WidgetType } from '@codemirror/view';
 import { TagSchema } from '@semiont/ontology';
 export { TAG_SCHEMAS, TagCategory, TagSchema, getAllTagSchemas, getSchemaCategory as getTagCategory, getTagSchema, getTagSchemasByDomain, isValidCategory } from '@semiont/ontology';
 
-type Annotation$n = components['schemas']['Annotation'];
+type Annotation$m = components['schemas']['Annotation'];
 /**
  * Collection of all annotation types for a resource.
  * Replaces separate highlights, references, assessments, comments, tags props.
  */
 interface AnnotationsCollection {
-    highlights: Annotation$n[];
-    references: Annotation$n[];
-    assessments: Annotation$n[];
-    comments: Annotation$n[];
-    tags: Annotation$n[];
+    highlights: Annotation$m[];
+    references: Annotation$m[];
+    assessments: Annotation$m[];
+    comments: Annotation$m[];
+    tags: Annotation$m[];
 }
 /**
  * Event handlers for annotation interactions.
@@ -32,7 +32,7 @@ interface AnnotationsCollection {
  */
 interface AnnotationHandlers {
     /** Unified click handler - routes based on annotation type and current mode */
-    onClick?: (annotation: Annotation$n, event?: React.MouseEvent) => void;
+    onClick?: (annotation: Annotation$m, event?: React.MouseEvent) => void;
     /** Unified hover handler for all annotation types */
     onHover?: (annotationId: string | null) => void;
     /** Hover handler specifically for comment panel highlighting */
@@ -81,7 +81,7 @@ interface UICreateAnnotationParams {
  * - linking: Shows Quick Reference popup FIRST, creates when user confirms
  */
 interface AnnotationCreationHandler {
-    onCreate?: (params: UICreateAnnotationParams) => void | Promise<void> | Promise<Annotation$n | undefined>;
+    onCreate?: (params: UICreateAnnotationParams) => void | Promise<void> | Promise<Annotation$m | undefined>;
 }
 /**
  * UI state for annotation toolbar and interactions.
@@ -114,7 +114,7 @@ interface AnnotationConfig {
     annotateMode?: boolean;
 }
 
-type Annotation$m = components['schemas']['Annotation'];
+type Annotation$l = components['schemas']['Annotation'];
 /**
  * Parameters for creating an annotation
  */
@@ -161,7 +161,7 @@ interface AnnotationManager {
      * @param params - Creation parameters (rUri, motivation, selector, body)
      * @returns Promise resolving to the created annotation, or undefined if creation fails
      */
-    createAnnotation: (params: CreateAnnotationParams) => Promise<Annotation$m | undefined>;
+    createAnnotation: (params: CreateAnnotationParams) => Promise<Annotation$l | undefined>;
     /**
      * Delete an annotation
      * @param params - Deletion parameters (annotationId, rUri)
@@ -265,7 +265,7 @@ interface NavigationProps {
  */
 
 type SemiontResource$4 = components['schemas']['ResourceDescriptor'];
-type Annotation$l = components['schemas']['Annotation'];
+type Annotation$k = components['schemas']['Annotation'];
 type Motivation$8 = components['schemas']['Motivation'];
 /**
  * Selection for creating annotations
@@ -293,7 +293,7 @@ interface TextSelection {
  * No aliasing, wrappers, or compatibility layers elsewhere.
  */
 
-type Annotation$k = components['schemas']['Annotation'];
+type Annotation$j = components['schemas']['Annotation'];
 type Motivation$7 = components['schemas']['Motivation'];
 /**
  * Detection configuration for SSE-based annotation detection
@@ -330,7 +330,7 @@ interface Annotator {
     isClickable: boolean;
     hasHoverInteraction: boolean;
     hasSidePanel: boolean;
-    matchesAnnotation: (annotation: Annotation$k) => boolean;
+    matchesAnnotation: (annotation: Annotation$j) => boolean;
     announceOnCreate: string;
     detection?: DetectionConfig;
     create: CreateConfig;
@@ -388,8 +388,7 @@ declare function useResources(): {
     };
     create: {
         useMutation: () => _tanstack_react_query.UseMutationResult<{
-            resource: _semiont_core.components["schemas"]["ResourceDescriptor"];
-            annotations: _semiont_core.components["schemas"]["Annotation"][];
+            resourceId: string;
         }, Error, {
             name: string;
             file: File | Buffer;
@@ -402,11 +401,7 @@ declare function useResources(): {
         }, unknown>;
     };
     update: {
-        useMutation: () => _tanstack_react_query.UseMutationResult<{
-            resource: _semiont_core.components["schemas"]["ResourceDescriptor"];
-            annotations: _semiont_core.components["schemas"]["Annotation"][];
-            entityReferences: _semiont_core.components["schemas"]["Annotation"][];
-        }, Error, {
+        useMutation: () => _tanstack_react_query.UseMutationResult<void, Error, {
             rUri: ResourceUri;
             data: Parameters<SemiontApiClient["updateResource"]>[1];
         }, unknown>;
@@ -426,8 +421,7 @@ declare function useResources(): {
     };
     createFromToken: {
         useMutation: () => _tanstack_react_query.UseMutationResult<{
-            resource: _semiont_core.components["schemas"]["ResourceDescriptor"];
-            annotations: _semiont_core.components["schemas"]["Annotation"][];
+            resourceId: string;
         }, Error, {
             token: string;
             name: string;
@@ -504,7 +498,7 @@ declare function useAnnotations(): {
     };
     create: {
         useMutation: () => _tanstack_react_query.UseMutationResult<{
-            annotation: _semiont_core.components["schemas"]["Annotation"];
+            annotationId: string;
         }, Error, {
             rUri: ResourceUri;
             data: Parameters<SemiontApiClient["createAnnotation"]>[1];
@@ -517,9 +511,7 @@ declare function useAnnotations(): {
         }, unknown>;
     };
     updateBody: {
-        useMutation: () => _tanstack_react_query.UseMutationResult<{
-            annotation: _semiont_core.components["schemas"]["Annotation"];
-        }, Error, {
+        useMutation: () => _tanstack_react_query.UseMutationResult<void, Error, {
             annotationUri: ResourceAnnotationUri;
             data: Parameters<SemiontApiClient["updateAnnotationBody"]>[1];
         }, unknown>;
@@ -562,16 +554,10 @@ declare function useEntityTypes(): {
         }, Error>;
     };
     add: {
-        useMutation: () => _tanstack_react_query.UseMutationResult<{
-            success: boolean;
-            entityTypes: string[];
-        }, Error, string, unknown>;
+        useMutation: () => _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
     };
     addBulk: {
-        useMutation: () => _tanstack_react_query.UseMutationResult<{
-            success: boolean;
-            entityTypes: string[];
-        }, Error, string[], unknown>;
+        useMutation: () => _tanstack_react_query.UseMutationResult<void, Error, string[], unknown>;
     };
 };
 /**
@@ -791,7 +777,7 @@ declare const jsonLightHighlightStyle: HighlightStyle;
  * clicks and hovers via a single set of delegated handlers.
  */
 
-type Annotation$j = components['schemas']['Annotation'];
+type Annotation$i = components['schemas']['Annotation'];
 /**
  * Reference Resolution Widget
  * Shows a small indicator next to references with hover preview.
@@ -800,10 +786,10 @@ type Annotation$j = components['schemas']['Annotation'];
  * and CodeMirrorRenderer handles events via container-level listeners.
  */
 declare class ReferenceResolutionWidget extends WidgetType {
-    readonly annotation: Annotation$j;
+    readonly annotation: Annotation$i;
     readonly targetDocumentName?: string | undefined;
     readonly isGenerating?: boolean | undefined;
-    constructor(annotation: Annotation$j, targetDocumentName?: string | undefined, isGenerating?: boolean | undefined);
+    constructor(annotation: Annotation$i, targetDocumentName?: string | undefined, isGenerating?: boolean | undefined);
     eq(other: ReferenceResolutionWidget): boolean;
     toDOM(): HTMLSpanElement;
     ignoreEvent(event: Event): boolean;
@@ -957,7 +943,7 @@ declare const QUERY_KEYS: {
  * the overlay spans — no markdown re-parse, no AST walk.
  */
 
-type Annotation$i = components['schemas']['Annotation'];
+type Annotation$h = components['schemas']['Annotation'];
 interface OverlayAnnotation {
     id: string;
     exact: string;
@@ -1012,7 +998,7 @@ declare function clearHighlights(container: HTMLElement): void;
  * Convert W3C Annotations to the simplified overlay format.
  * Extracts TextPositionSelector offsets and annotation type.
  */
-declare function toOverlayAnnotations(annotations: Annotation$i[]): OverlayAnnotation[];
+declare function toOverlayAnnotations(annotations: Annotation$h[]): OverlayAnnotation[];
 
 /**
  * Resource utilities
@@ -1325,6 +1311,29 @@ declare function useResourceEvents({ rUri, onEvent, onAnnotationAdded, onAnnotat
     isConnected: boolean;
 };
 
+/**
+ * React hook for subscribing to global system-level events via SSE
+ *
+ * Opens a long-lived SSE connection to GET /api/events/stream to receive
+ * domain events that are not scoped to a specific resource (e.g., entity type changes).
+ *
+ * Automatically invalidates relevant React Query caches when system events arrive.
+ *
+ * @example
+ * ```tsx
+ * // In your app layout:
+ * useGlobalEvents(); // That's it — auto-connects and invalidates queries
+ * ```
+ */
+declare function useGlobalEvents({ autoConnect }?: {
+    autoConnect?: boolean;
+}): {
+    status: StreamStatus;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+    isConnected: boolean;
+};
+
 interface UseRovingTabIndexOptions {
     orientation?: 'horizontal' | 'vertical' | 'grid';
     loop?: boolean;
@@ -1578,10 +1587,9 @@ declare function OpenResourcesProvider({ openResourcesManager, children }: {
  */
 declare function useOpenResources(): OpenResourcesManager;
 
-type Annotation$h = components['schemas']['Annotation'];
 interface ResourceAnnotationsContextType {
     newAnnotationIds: Set<string>;
-    createAnnotation: (rUri: ResourceUri, motivation: 'highlighting' | 'linking' | 'assessing' | 'commenting' | 'tagging', selector: Selector | Selector[], body?: any[]) => Promise<Annotation$h | undefined>;
+    createAnnotation: (rUri: ResourceUri, motivation: 'highlighting' | 'linking' | 'assessing' | 'commenting' | 'tagging', selector: Selector | Selector[], body?: any[]) => Promise<string | undefined>;
     clearNewAnnotationId: (id: AnnotationUri) => void;
     triggerSparkleAnimation: (annotationId: string) => void;
 }
@@ -3965,4 +3973,4 @@ interface BindFlowState {
  */
 declare function useBindFlow(rUri: ResourceUri): BindFlowState;
 
-export { ANNOTATORS, AUTH_EVENTS, AVAILABLE_LOCALES, AdminDevOpsPage, type AdminDevOpsPageProps, AdminSecurityPage, type AdminSecurityPageProps, type AdminUser, type AdminUserStats, AdminUsersPage, type AdminUsersPageProps, AnnotateReferencesProgressWidget, AnnotateToolbar, AnnotateView, type Annotation$l as Annotation, type AnnotationConfig, type AnnotationCreationHandler, type AnnotationHandlers, AnnotationHistory, type AnnotationManager, AnnotationOverlay, AnnotationProvider, type AnnotationProviderProps, type AnnotationUIState, type AnnotationsCollection, type Annotator, ApiClientProvider, type ApiClientProviderProps, AssessmentEntry, AssessmentPanel, AssistSection, AsyncErrorBoundary, AuthErrorDisplay, type AuthErrorDisplayProps, type AuthEventDetail, type AuthEventType, AuthTokenProvider, type AuthTokenProviderProps, type AvailableLocale, type BeckonFlowState, type BindFlowState, type BorderRadiusToken, BrowseView, Button, ButtonGroup, type ButtonGroupProps, type ButtonProps, COMMON_PANELS, type CacheManager, CacheProvider, type CacheProviderProps, type ClickAction, CodeMirrorRenderer, CollaborationPanel, CollapsibleResourceNavigation, type CollapsibleResourceNavigationProps, type ColorToken, CommentEntry, CommentsPanel, ComposeLoadingState, type ComposeLoadingStateProps, type ContextGatherFlowConfig, type ContextGatherFlowState, type CreateAnnotationParams, type CreateConfig, type DeleteAnnotationParams, type DetectionConfig, type DevOpsFeature, type DrawingMode, EntityTagsPage, type EntityTagsPageProps, EntityTypeBadges, ErrorBoundary, Footer, type GenerationOptions, HOVER_DELAY_MS, HighlightEntry, HighlightPanel, HistoryEvent, type HoverEmitterProps, type HoverHandlers, ImageURLSchema, ImageViewer, JsonLdPanel, JsonLdView, type KeyboardShortcut, KeyboardShortcutsHelpModal, LeftSidebar, type LinkComponentProps, LiveRegionProvider, type MarkFlowState, type Motivation$8 as Motivation, type NavigationItem, NavigationMenu, type NavigationMenuHelper, type NavigationProps, type OAuthProvider, type OAuthUser, OAuthUserSchema, ObservableLink, type ObservableLinkProps, type OpenResource, OpenResourcesManager, OpenResourcesProvider, type OverlayAnnotation, PageLayout, type PanelBrowseState, PanelHeader, PopupContainer, PopupHeader, ProposeEntitiesModal, QUERY_KEYS, RESOURCE_PANELS, RecentDocumentsPage, type RecentDocumentsPageProps, ReferenceEntry, ReferenceResolutionWidget, ReferencesPanel, ResizeHandle, type ResolvedTheme, ResourceAnnotationsProvider, ResourceCard, type ResourceCardProps, ResourceComposePage, type ResourceComposePageProps, ResourceDiscoveryPage, type ResourceDiscoveryPageProps, ResourceErrorState, type ResourceErrorStateProps, ResourceInfoPanel, ResourceLoadingState, ResourceSearchModal, type ResourceSearchModalProps, ResourceTagsInline, ResourceViewer, ResourceViewerPage, type ResourceViewerPageProps, type RouteBuilder, type SaveResourceParams, SearchModal, type SearchModalProps, SelectedTextDisplay, type SelectionMotivation, type SelectorType, SemiontBranding, SemiontFavicon, type SemiontResource$4 as SemiontResource, SessionExpiryBanner, SessionManager, SessionProvider, SessionTimer, SettingsPanel, type ShadowToken, type ShapeType, SignInForm, type SignInFormProps, SignUpForm, type SignUpFormProps, SimpleNavigation, type SimpleNavigationItem, type SimpleNavigationProps, SkipLinks, SortableResourceTab, type SortableResourceTabProps, type SpacingToken, StatisticsPanel, StatusDisplay, type StreamStatus, SvgDrawingCanvas, TagEntry, TagSchemasPage, type TagSchemasPageProps, TaggingPanel, type TextSegment, type TextSelection, type Theme, ThemeProvider, ToastContainer, type ToastMessage, ToastProvider, type ToastType, Toolbar, type ToolbarPanelType, type TransitionToken, TranslationManager, TranslationProvider, type TranslationProviderProps, type TypographyToken, type UICreateAnnotationParams, UnifiedAnnotationsPanel, UnifiedHeader, type UseResourceContentResult, UserMenuSkeleton, WelcomePage, type WelcomePageProps, type YieldFlowState, applyHighlights, buildSourceToRenderedMap, buildTextNodeIndex, buttonStyles, clearHighlights, createHoverHandlers, cssVariables, dispatch401Error, dispatch403Error, dispatchAuthEvent, faviconPaths, formatTime, generateCSSVariables, getResourceIcon, getSelectedShapeForSelectorType, getSelectorType, getShortcutDisplay, getSupportedShapes, hideWidgetPreview, isShapeSupported, jsonLightHighlightStyle, jsonLightTheme, onAuthEvent, resolveAnnotationRanges, sanitizeImageURL, saveSelectedShapeForSelectorType, showWidgetPreview, supportsDetection, toOverlayAnnotations, tokens, useAdmin, useAnnotationManager, useAnnotations, useApiClient, useAuthApi, useAuthToken, useBeckonFlow, useBindFlow, useCacheManager, useContextGatherFlow, useDebounce, useDebouncedCallback, useDocumentAnnouncements, useDoubleKeyPress, useDropdown, useEntityTypes, useEventSubscription, useEventSubscriptions, useFormAnnouncements, useHealth, useHoverDelay, useHoverEmitter, useIsTyping, useKeyboardShortcuts, useLanguageChangeAnnouncements, useLineNumbers, useLiveRegion, useLoadingState, useLocalStorage, useMarkFlow, useObservableExternalNavigation, useObservableRouter, useOpenResources, usePanelBrowse, usePanelWidth, usePreloadTranslations, useResourceAnnotations, useResourceContent, useResourceEvents, useResourceLoadingAnnouncements, useResources, useRovingTabIndex, useSearchAnnouncements, useSessionContext, useSessionExpiry, useTheme, useToast, useTranslations, useYieldFlow };
+export { ANNOTATORS, AUTH_EVENTS, AVAILABLE_LOCALES, AdminDevOpsPage, type AdminDevOpsPageProps, AdminSecurityPage, type AdminSecurityPageProps, type AdminUser, type AdminUserStats, AdminUsersPage, type AdminUsersPageProps, AnnotateReferencesProgressWidget, AnnotateToolbar, AnnotateView, type Annotation$k as Annotation, type AnnotationConfig, type AnnotationCreationHandler, type AnnotationHandlers, AnnotationHistory, type AnnotationManager, AnnotationOverlay, AnnotationProvider, type AnnotationProviderProps, type AnnotationUIState, type AnnotationsCollection, type Annotator, ApiClientProvider, type ApiClientProviderProps, AssessmentEntry, AssessmentPanel, AssistSection, AsyncErrorBoundary, AuthErrorDisplay, type AuthErrorDisplayProps, type AuthEventDetail, type AuthEventType, AuthTokenProvider, type AuthTokenProviderProps, type AvailableLocale, type BeckonFlowState, type BindFlowState, type BorderRadiusToken, BrowseView, Button, ButtonGroup, type ButtonGroupProps, type ButtonProps, COMMON_PANELS, type CacheManager, CacheProvider, type CacheProviderProps, type ClickAction, CodeMirrorRenderer, CollaborationPanel, CollapsibleResourceNavigation, type CollapsibleResourceNavigationProps, type ColorToken, CommentEntry, CommentsPanel, ComposeLoadingState, type ComposeLoadingStateProps, type ContextGatherFlowConfig, type ContextGatherFlowState, type CreateAnnotationParams, type CreateConfig, type DeleteAnnotationParams, type DetectionConfig, type DevOpsFeature, type DrawingMode, EntityTagsPage, type EntityTagsPageProps, EntityTypeBadges, ErrorBoundary, Footer, type GenerationOptions, HOVER_DELAY_MS, HighlightEntry, HighlightPanel, HistoryEvent, type HoverEmitterProps, type HoverHandlers, ImageURLSchema, ImageViewer, JsonLdPanel, JsonLdView, type KeyboardShortcut, KeyboardShortcutsHelpModal, LeftSidebar, type LinkComponentProps, LiveRegionProvider, type MarkFlowState, type Motivation$8 as Motivation, type NavigationItem, NavigationMenu, type NavigationMenuHelper, type NavigationProps, type OAuthProvider, type OAuthUser, OAuthUserSchema, ObservableLink, type ObservableLinkProps, type OpenResource, OpenResourcesManager, OpenResourcesProvider, type OverlayAnnotation, PageLayout, type PanelBrowseState, PanelHeader, PopupContainer, PopupHeader, ProposeEntitiesModal, QUERY_KEYS, RESOURCE_PANELS, RecentDocumentsPage, type RecentDocumentsPageProps, ReferenceEntry, ReferenceResolutionWidget, ReferencesPanel, ResizeHandle, type ResolvedTheme, ResourceAnnotationsProvider, ResourceCard, type ResourceCardProps, ResourceComposePage, type ResourceComposePageProps, ResourceDiscoveryPage, type ResourceDiscoveryPageProps, ResourceErrorState, type ResourceErrorStateProps, ResourceInfoPanel, ResourceLoadingState, ResourceSearchModal, type ResourceSearchModalProps, ResourceTagsInline, ResourceViewer, ResourceViewerPage, type ResourceViewerPageProps, type RouteBuilder, type SaveResourceParams, SearchModal, type SearchModalProps, SelectedTextDisplay, type SelectionMotivation, type SelectorType, SemiontBranding, SemiontFavicon, type SemiontResource$4 as SemiontResource, SessionExpiryBanner, SessionManager, SessionProvider, SessionTimer, SettingsPanel, type ShadowToken, type ShapeType, SignInForm, type SignInFormProps, SignUpForm, type SignUpFormProps, SimpleNavigation, type SimpleNavigationItem, type SimpleNavigationProps, SkipLinks, SortableResourceTab, type SortableResourceTabProps, type SpacingToken, StatisticsPanel, StatusDisplay, type StreamStatus, SvgDrawingCanvas, TagEntry, TagSchemasPage, type TagSchemasPageProps, TaggingPanel, type TextSegment, type TextSelection, type Theme, ThemeProvider, ToastContainer, type ToastMessage, ToastProvider, type ToastType, Toolbar, type ToolbarPanelType, type TransitionToken, TranslationManager, TranslationProvider, type TranslationProviderProps, type TypographyToken, type UICreateAnnotationParams, UnifiedAnnotationsPanel, UnifiedHeader, type UseResourceContentResult, UserMenuSkeleton, WelcomePage, type WelcomePageProps, type YieldFlowState, applyHighlights, buildSourceToRenderedMap, buildTextNodeIndex, buttonStyles, clearHighlights, createHoverHandlers, cssVariables, dispatch401Error, dispatch403Error, dispatchAuthEvent, faviconPaths, formatTime, generateCSSVariables, getResourceIcon, getSelectedShapeForSelectorType, getSelectorType, getShortcutDisplay, getSupportedShapes, hideWidgetPreview, isShapeSupported, jsonLightHighlightStyle, jsonLightTheme, onAuthEvent, resolveAnnotationRanges, sanitizeImageURL, saveSelectedShapeForSelectorType, showWidgetPreview, supportsDetection, toOverlayAnnotations, tokens, useAdmin, useAnnotationManager, useAnnotations, useApiClient, useAuthApi, useAuthToken, useBeckonFlow, useBindFlow, useCacheManager, useContextGatherFlow, useDebounce, useDebouncedCallback, useDocumentAnnouncements, useDoubleKeyPress, useDropdown, useEntityTypes, useEventSubscription, useEventSubscriptions, useFormAnnouncements, useGlobalEvents, useHealth, useHoverDelay, useHoverEmitter, useIsTyping, useKeyboardShortcuts, useLanguageChangeAnnouncements, useLineNumbers, useLiveRegion, useLoadingState, useLocalStorage, useMarkFlow, useObservableExternalNavigation, useObservableRouter, useOpenResources, usePanelBrowse, usePanelWidth, usePreloadTranslations, useResourceAnnotations, useResourceContent, useResourceEvents, useResourceLoadingAnnouncements, useResources, useRovingTabIndex, useSearchAnnouncements, useSessionContext, useSessionExpiry, useTheme, useToast, useTranslations, useYieldFlow };