@coxwave/tap-kit-types 2.10.0 → 2.10.2

package/dist/index.d.ts

@@ -396,6 +396,7 @@ interface ViewportResizeMessage {
  * - This message protocol mirrors the structure for serialization
  * - When updating ContainerConfig, update this structure accordingly
  */
+type ChatMode = "NORMAL" | "EXAM" | "STUDY";
 interface ConfigUpdateMessage {
     type: "config:update";
     apiKey?: string;
@@ -409,6 +410,8 @@ interface ConfigUpdateMessage {
     clipId?: string;
     clipPlayHead?: number;
     mode?: DisplayMode;
+    /** Chat interaction mode (staging feature: per-message override) */
+    chatMode?: ChatMode;
     /**
      * Allow user to toggle between floating and sidebar layouts
      * @default true
@@ -2290,6 +2293,7 @@ declare const ConfigUpdateSchema: ObjectSchema<{
     readonly clipId: OptionalSchema<StringSchema<undefined>, undefined>;
     readonly clipPlayHead: OptionalSchema<NumberSchema<undefined>, undefined>;
     readonly mode: OptionalSchema<UnionSchema<[LiteralSchema<"inline", undefined>, LiteralSchema<"floating", undefined>, LiteralSchema<"sidebar", undefined>], undefined>, undefined>;
+    readonly chatMode: OptionalSchema<UnionSchema<[LiteralSchema<"NORMAL", undefined>, LiteralSchema<"EXAM", undefined>, LiteralSchema<"STUDY", undefined>], undefined>, undefined>;
     readonly allowLayoutToggle: OptionalSchema<BooleanSchema<undefined>, undefined>;
     readonly container: OptionalSchema<ObjectSchema<{
         readonly floatingConfig: OptionalSchema<ObjectSchema<{
@@ -2401,6 +2405,7 @@ declare const TapMessageSchema: UnionSchema<[ObjectSchema<{
     readonly clipId: OptionalSchema<StringSchema<undefined>, undefined>;
     readonly clipPlayHead: OptionalSchema<NumberSchema<undefined>, undefined>;
     readonly mode: OptionalSchema<UnionSchema<[LiteralSchema<"inline", undefined>, LiteralSchema<"floating", undefined>, LiteralSchema<"sidebar", undefined>], undefined>, undefined>;
+    readonly chatMode: OptionalSchema<UnionSchema<[LiteralSchema<"NORMAL", undefined>, LiteralSchema<"EXAM", undefined>, LiteralSchema<"STUDY", undefined>], undefined>, undefined>;
     readonly allowLayoutToggle: OptionalSchema<BooleanSchema<undefined>, undefined>;
     readonly container: OptionalSchema<ObjectSchema<{
         readonly floatingConfig: OptionalSchema<ObjectSchema<{
@@ -2500,7 +2505,7 @@ type SyncableConfigKey = Exclude<ConfigUpdateKey, "apiKey" | "hostOrigin" | "tap
 type Course = {
     userId: string;
     courseId: string;
-    clipId: string;
+    clipId?: string;
     clipPlayHead?: number;
 };
 /**
@@ -2823,11 +2828,10 @@ interface TapKitInstance {
     hide(): void;
     /**
      * Update course information
-     * @param course - Course info (courseId and clipId required, userId and clipPlayHead optional)
+     * @param course - Course info (courseId required, clipId optional)
      */
     setCourse(course: Partial<Course> & {
         courseId: string;
-        clipId: string;
     }): void;
 }
 /** TapKit constructor type */
@@ -3463,10 +3467,10 @@ interface TapKitElement extends HTMLElement {
 
   /**
    * Update course information
-   * @param course - Partial course information (courseId and clipId required)
+   * @param course - Partial course information (courseId required, clipId optional)
    * @example kit.setCourse({ courseId: 'new', clipId: 'new-1' })
    */
-  setCourse(course: Partial<Course> & { courseId: string; clipId: string }): void;
+  setCourse(course: Partial<Course> & { courseId: string }): void;
 
   // ===== Delegate Properties (Read-only) =====
 
@@ -3608,6 +3612,9 @@ interface TapKitAttributes {
    */
   mode?: "inline" | "floating" | "sidebar";
 
+  /** Chat interaction mode (staging feature: per-message override) */
+  "chat-mode"?: "NORMAL" | "EXAM" | "STUDY";
+
   /**
    * Allow user to toggle between floating and sidebar layouts
    * Only applies when mode is "floating" or "sidebar"
@@ -3917,6 +3924,7 @@ declare global {
       language?: "ko" | "en";
       buttonId?: string;
       mode?: "inline" | "floating" | "sidebar";
+      chatMode?: "NORMAL" | "EXAM" | "STUDY";
       debug?: boolean;
       apiUrl?: string;
       tapUrl?: string;
@@ -3942,4 +3950,4 @@ declare global {
   function cancelIdleCallback(handle: number): void;
 }
 
-export { ALARM_DURATION, type AlarmClickMessage, AlarmClickSchema, type AlarmElement, type AlarmElementProps, AlarmElementPropsSchema, AlarmElementSchema, type AlarmFadeInMessage, AlarmFadeInSchema, AlarmMessageInstanceSchema, type AlarmMessageInstanceType, type AlarmPayload, type AlarmType, type CSSStyle, CSSStyleSchema, type ConfigRequestMessage, ConfigRequestSchema, type ConfigUpdateKey, type ConfigUpdateMessage, type ConfigUpdateOptions, type ConfigUpdatePayload, ConfigUpdateSchema, type ContainerConfig, type ContainerLayoutStateChangedMessage, ContainerLayoutStateChangedSchema, type ContainerModeChangeAckMessage, ContainerModeChangeAckSchema, type ContainerModeChangeMessage, ContainerModeChangeSchema, type ContainerVisibility, type Course, type DisplayMode, type EventManager, type FeatureFlagKey, type FeatureFlags, type FeatureFlagsUpdateMessage, type FloatingConfig, type GAEventMessage, GAEventSchema, type HtmlViewCloseMessage, HtmlViewCloseSchema, type HtmlViewConfig, type HtmlViewOpenMessage, HtmlViewOpenSchema, type ITapButtonElement, type ITapContainerElement, type ITapHtmlViewerElement, type ITapKitElement, type ITapMaterialViewerElement, TapKitInitializationError as InitializationError, type LayoutMode, type MaterialViewCloseMessage, MaterialViewCloseSchema, type MaterialViewConfig, type MaterialViewErrorMessage, MaterialViewErrorSchema, type MaterialViewOpenMessage, MaterialViewOpenSchema, MaterialViewerError, type PopUpCloseMessage, PopUpCloseSchema, type PopUpOpenMessage, PopUpOpenSchema, type PositionType, type SeekTimelineParamsType, type ShortcutKeyPropertiesType, type SidebarConfig, type SyncableConfigKey, TAP_BUTTON_CLICK_EVENT, TAP_ERROR_MARKER, type TapButtonAttributes, type TapButtonClickEventDetail, type TapCloseMessage, TapCloseSchema, type TapContainerAttributes, type TapErrorOptions, type TapHtmlViewerAttributes, type TapKitConfig, TapKitConfigurationError, type TapKitConstructor, type TapKitElement, type TapKitElementEventMap, TapKitError, TapKitIframeError, type TapKitInitParams, TapKitInitializationError, type TapKitInstance, TapKitLoaderError, TapKitMessageError, type TapMaterialViewerAttributes, type TapMessage, type TapMessageRecord, TapMessageSchema, type TapMessageType, type TapReadyMessage, TapReadySchema, type TimelineSeekMessage, TimelineSeekSchema, type TutorInfoMessage, TutorInfoSchema, type VideoController, type VideoPlayerAdapter, type VideoPlayerConfig, type ViewportResizeMessage, ViewportResizeSchema, isFeatureEnabled };
+export { ALARM_DURATION, type AlarmClickMessage, AlarmClickSchema, type AlarmElement, type AlarmElementProps, AlarmElementPropsSchema, AlarmElementSchema, type AlarmFadeInMessage, AlarmFadeInSchema, AlarmMessageInstanceSchema, type AlarmMessageInstanceType, type AlarmPayload, type AlarmType, type CSSStyle, CSSStyleSchema, type ChatMode, type ConfigRequestMessage, ConfigRequestSchema, type ConfigUpdateKey, type ConfigUpdateMessage, type ConfigUpdateOptions, type ConfigUpdatePayload, ConfigUpdateSchema, type ContainerConfig, type ContainerLayoutStateChangedMessage, ContainerLayoutStateChangedSchema, type ContainerModeChangeAckMessage, ContainerModeChangeAckSchema, type ContainerModeChangeMessage, ContainerModeChangeSchema, type ContainerVisibility, type Course, type DisplayMode, type EventManager, type FeatureFlagKey, type FeatureFlags, type FeatureFlagsUpdateMessage, type FloatingConfig, type GAEventMessage, GAEventSchema, type HtmlViewCloseMessage, HtmlViewCloseSchema, type HtmlViewConfig, type HtmlViewOpenMessage, HtmlViewOpenSchema, type ITapButtonElement, type ITapContainerElement, type ITapHtmlViewerElement, type ITapKitElement, type ITapMaterialViewerElement, TapKitInitializationError as InitializationError, type LayoutMode, type MaterialViewCloseMessage, MaterialViewCloseSchema, type MaterialViewConfig, type MaterialViewErrorMessage, MaterialViewErrorSchema, type MaterialViewOpenMessage, MaterialViewOpenSchema, MaterialViewerError, type PopUpCloseMessage, PopUpCloseSchema, type PopUpOpenMessage, PopUpOpenSchema, type PositionType, type SeekTimelineParamsType, type ShortcutKeyPropertiesType, type SidebarConfig, type SyncableConfigKey, TAP_BUTTON_CLICK_EVENT, TAP_ERROR_MARKER, type TapButtonAttributes, type TapButtonClickEventDetail, type TapCloseMessage, TapCloseSchema, type TapContainerAttributes, type TapErrorOptions, type TapHtmlViewerAttributes, type TapKitConfig, TapKitConfigurationError, type TapKitConstructor, type TapKitElement, type TapKitElementEventMap, TapKitError, TapKitIframeError, type TapKitInitParams, TapKitInitializationError, type TapKitInstance, TapKitLoaderError, TapKitMessageError, type TapMaterialViewerAttributes, type TapMessage, type TapMessageRecord, TapMessageSchema, type TapMessageType, type TapReadyMessage, TapReadySchema, type TimelineSeekMessage, TimelineSeekSchema, type TutorInfoMessage, TutorInfoSchema, type VideoController, type VideoPlayerAdapter, type VideoPlayerConfig, type ViewportResizeMessage, ViewportResizeSchema, isFeatureEnabled };

package/dist/index.js

@@ -855,6 +855,7 @@ var ConfigUpdateSchema = object({
   clipId: optional(string()),
   clipPlayHead: optional(number()),
   mode: optional(union([literal("inline"), literal("floating"), literal("sidebar")])),
+  chatMode: optional(union([literal("NORMAL"), literal("EXAM"), literal("STUDY")])),
   allowLayoutToggle: optional(boolean()),
   container: optional(
     object({