@unisphere/genie-types 1.13.1 → 1.14.0

package/src/lib/types.d.ts

@@ -3,52 +3,114 @@ type SourceItemBaseType = {
     entry_id: string;
     title: string;
 };
+/**
+ * Video source item with duration.
+ */
 export type VideoSourceItemType = SourceItemBaseType & {
     type: 'video';
     duration: number;
 };
+/**
+ * Document source item.
+ */
 export type DocumentSourceItemType = SourceItemBaseType & {
     type: 'document';
     duration?: number | null;
 };
-export type SourcesItemType = VideoSourceItemType | DocumentSourceItemType;
+/**
+ * Web page source item.
+ */
+export type WebSourceItemType = {
+    type: 'web';
+    title: string;
+    url: string;
+};
+/**
+ * Union type for source items (video, document, or web page).
+ */
+export type SourcesItemType = VideoSourceItemType | DocumentSourceItemType | WebSourceItemType;
+/**
+ * Status values for Unisphere tools.
+ */
 export type UnisphereToolStatuses = 'loading' | 'ready' | 'error';
+/**
+ * Content data structure for responses.
+ */
 export type ContentDataType = {
+    /** Block visual context */
     blockContext?: BlockVisualContext;
+    /** Content title */
     title?: string;
+    /** Content summary */
     summary?: string;
+    /** Follow-up questions */
     followups?: string[];
+    /** Key points with citations */
     keypoints?: CardsDataType[];
 };
+/**
+ * Video clip data with timestamps and metadata.
+ */
 export type CardsVideoDataType = {
+    /** End time in seconds */
     end_time?: number;
+    /** Kaltura entry ID */
     entry_id?: string;
+    /** Source type */
     type?: 'CAPTION' | 'OCR' | 'DOCUMENT';
+    /** Last index */
     last_index?: number;
+    /** Start index */
     start_index?: number;
+    /** Start time in seconds */
     start_time?: number;
+    /** Thumbnail URL */
     thumbnail?: string;
+    /** Video link */
     video_link?: string;
+    /** Clip title */
     title?: string;
 };
+/**
+ * Card data with title, summary, and citations.
+ */
 export type CardsDataType = {
+    /** Card title */
     title?: string;
+    /** Card summary */
     summary?: string;
+    /** Citation information */
     citation?: {
+        /** Video clips */
         clips?: CardsVideoDataType[];
     };
 };
+/**
+ * Answer type options for Genie responses.
+ */
 export declare enum AnswerTypeEnum {
     Flashcards = "flashcards",
     Markdown = "markdown",
     Summary = "summarization"
 }
+/**
+ * Answer model performance options.
+ */
 export declare enum AnswerModelEnum {
     Fast = "fast",
     Smart = "smart"
 }
+/**
+ * Answer type (enum value or undefined).
+ */
 export type AnswerType = AnswerTypeEnum | undefined;
+/**
+ * Answer model (enum value or undefined).
+ */
 export type AnswerModel = AnswerModelEnum | undefined;
+/**
+ * Thread metadata for Genie conversations.
+ */
 export type Thread = {
     id?: string;
     title: string | null;
@@ -59,6 +121,9 @@ export type Thread = {
     user_id: string;
     status: number;
 };
+/**
+ * Response containing list of threads.
+ */
 export type ThreadListResponse = {
     objects: Thread[];
     totalCount: number;

package/src/lib/widget-types.d.ts

@@ -1 +1,2 @@
+/** Widget name constant for all Genie experiences */
 export declare const widgetName: "unisphere.widget.genie";