@coxwave/tap-kit-types 2.0.7 → 2.0.9

package/dist/index.d.ts

@@ -123,7 +123,7 @@ type PositionType = {
 type FloatingConfig = {
     /** Position (default: top: "50px", right: "24px") */
     position?: PositionType;
-    /** Width (default: "340px") */
+    /** Width (default: "430px") */
     width?: string;
     /** Height (default: "calc(100% - 116px)") */
     height?: string;
@@ -178,8 +178,8 @@ type ContainerConfig = {
     sidebarConfig?: SidebarConfig;
 };
 
-type TapMessageType = "tap:ready" | "tap:close" | "timeline:seek" | "alarm:click" | "alarm:fadeIn" | "popUp:open" | "popUp:close" | "material:view:open" | "material:view:close" | "material:view:error" | "html:view:open" | "html:view:close" | "container:mode:change" | "container:mode:change:ack" | "container:layout:state:changed" | "viewport:resize" | "config:update" | "GA_EVENT";
-type TapMessage = TapReadyMessage | TapCloseMessage | TimelineSeekMessage | AlarmClickMessage | AlarmFadeInMessage | PopUpOpenMessage | PopUpCloseMessage | MaterialViewOpenMessage | MaterialViewCloseMessage | MaterialViewErrorMessage | HtmlViewOpenMessage | HtmlViewCloseMessage | ContainerModeChangeMessage | ContainerModeChangeAckMessage | ContainerLayoutStateChangedMessage | ViewportResizeMessage | ConfigUpdateMessage | GAEventMessage;
+type TapMessageType = "tap:ready" | "tap:close" | "timeline:seek" | "alarm:click" | "alarm:fadeIn" | "popUp:open" | "popUp:close" | "material:view:open" | "material:view:close" | "material:view:error" | "html:view:open" | "html:view:close" | "container:mode:change" | "container:mode:change:ack" | "container:layout:state:changed" | "viewport:resize" | "config:update" | "config:request" | "GA_EVENT" | "tutor:info";
+type TapMessage = TapReadyMessage | TapCloseMessage | TimelineSeekMessage | AlarmClickMessage | AlarmFadeInMessage | PopUpOpenMessage | PopUpCloseMessage | MaterialViewOpenMessage | MaterialViewCloseMessage | MaterialViewErrorMessage | HtmlViewOpenMessage | HtmlViewCloseMessage | ContainerModeChangeMessage | ContainerModeChangeAckMessage | ContainerLayoutStateChangedMessage | ViewportResizeMessage | ConfigUpdateMessage | ConfigRequestMessage | GAEventMessage | TutorInfoMessage;
 interface TapReadyMessage {
     type: "tap:ready";
     gaId: string;
@@ -222,6 +222,7 @@ interface MaterialViewOpenMessage {
     presignedUrl: string;
     pageStart: number;
     pageEnd: number;
+    title?: string;
     nonce?: string | number;
 }
 /**
@@ -367,6 +368,21 @@ interface ConfigUpdateMessage {
         };
     };
 }
+/**
+ * Config Request Message (iframe → parent, call/handle pattern)
+ *
+ * Used for self-heal when iframe misses initial config:update.
+ * Response: ConfigUpdateMessage fields via :ack (auto-generated by call/handle)
+ *
+ * @example
+ * // iframe requests config
+ * const config = await messenger.call("config:request", {});
+ * // → receives config:request:ack with ConfigUpdateMessage fields
+ */
+interface ConfigRequestMessage {
+    type: "config:request";
+    nonce?: string | number;
+}
 /**
  * Google Analytics Event Message (iframe → parent)
  * Sent from edutap iframe to tap-kit-core for analytics tracking
@@ -375,6 +391,15 @@ interface GAEventMessage {
     type: "GA_EVENT";
     payload: Record<string, unknown>;
 }
+/**
+ * Tutor Info Message (iframe → parent)
+ * Sent from edutap after tutor_setting API response
+ * Contains tutor name for button tooltip customization
+ */
+interface TutorInfoMessage {
+    type: "tutor:info";
+    tutorName: string;
+}
 
 /**
  * Fallback type.
@@ -2202,10 +2227,18 @@ declare const ConfigUpdateSchema: ObjectSchema<{
         }, undefined>, undefined>;
     }, undefined>, undefined>;
 }, undefined>;
+declare const ConfigRequestSchema: ObjectSchema<{
+    readonly type: LiteralSchema<"config:request", undefined>;
+    readonly nonce: OptionalSchema<UnionSchema<[StringSchema<undefined>, NumberSchema<undefined>], undefined>, undefined>;
+}, undefined>;
 declare const GAEventSchema: ObjectSchema<{
     readonly type: LiteralSchema<"GA_EVENT", undefined>;
     readonly payload: RecordSchema<StringSchema<undefined>, AnySchema, undefined>;
 }, undefined>;
+declare const TutorInfoSchema: ObjectSchema<{
+    readonly type: LiteralSchema<"tutor:info", undefined>;
+    readonly tutorName: StringSchema<undefined>;
+}, undefined>;
 declare const TapMessageSchema: UnionSchema<[ObjectSchema<{
     readonly type: LiteralSchema<"tap:ready", undefined>;
     readonly gaId: StringSchema<undefined>;
@@ -2303,9 +2336,15 @@ declare const TapMessageSchema: UnionSchema<[ObjectSchema<{
             readonly minViewportWidth: OptionalSchema<NumberSchema<undefined>, undefined>;
         }, undefined>, undefined>;
     }, undefined>, undefined>;
+}, undefined>, ObjectSchema<{
+    readonly type: LiteralSchema<"config:request", undefined>;
+    readonly nonce: OptionalSchema<UnionSchema<[StringSchema<undefined>, NumberSchema<undefined>], undefined>, undefined>;
 }, undefined>, ObjectSchema<{
     readonly type: LiteralSchema<"GA_EVENT", undefined>;
     readonly payload: RecordSchema<StringSchema<undefined>, AnySchema, undefined>;
+}, undefined>, ObjectSchema<{
+    readonly type: LiteralSchema<"tutor:info", undefined>;
+    readonly tutorName: StringSchema<undefined>;
 }, undefined>], undefined>;
 
 type TapMessageRecord = TapMessage;
@@ -2617,8 +2656,12 @@ type ContainerVisibility = "open" | "closed";
 interface VideoPlayerAdapter {
     /** Get current playback time in seconds */
     getCurrentTime: () => number;
-    /** Set playback time in seconds */
-    setCurrentTime: (time: number) => void;
+    /**
+     * Set playback time in seconds
+     * @param time - Playback time in seconds
+     * @param clipId - ClipId from the seek request (for cross-clip seeking)
+     */
+    setCurrentTime: (time: number, clipId: string) => void;
 }
 /**
  * Video Player Configuration
@@ -3583,6 +3626,16 @@ interface MaterialViewConfig {
    * Ending page number (1-indexed)
    */
   pageEnd: number;
+
+  /**
+   * Text phrases to highlight in PDF (from reference_string parsing)
+   */
+  highlightPhrases?: string[];
+
+  /**
+   * Optional title for the viewer header
+   */
+  title?: string;
 }
 
 /**
@@ -3616,6 +3669,19 @@ interface ITapMaterialViewerElement extends HTMLElement {
    */
   open(config: MaterialViewConfig): Promise<void>;
 
+  /**
+   * Open material viewer with HTML URL
+   *
+   * Loads HTML content directly in iframe without PDF processing.
+   * Useful for viewing HTML documents or web pages.
+   *
+   * @param url - URL of the HTML content to display
+   * @param materialId - Optional identifier for the material (defaults to 'html')
+   * @fires error - When HTML loading fails
+   * @fires open - When HTML is successfully displayed
+   */
+  openHtml(url: string, materialId?: string): void;
+
   /**
    * Close material viewer and cleanup resources
    *
@@ -3781,4 +3847,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 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 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 VideoController, type VideoPlayerAdapter, type VideoPlayerConfig, type ViewportResizeMessage, ViewportResizeSchema };
+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 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 };

package/dist/index.js

@@ -733,10 +733,7 @@ function union(options, message2) {
 }
 
 // src/protocol/schema.ts
-var CSSStyleSchema = record(
-  string(),
-  union([string(), number()])
-);
+var CSSStyleSchema = record(string(), union([string(), number()]));
 var AlarmElementPropsSchema = object({
   style: optional(CSSStyleSchema),
   className: optional(string()),
@@ -811,12 +808,7 @@ var MaterialViewCloseSchema = object({
 var MaterialViewErrorSchema = object({
   type: literal("material:view:error"),
   materialId: string(),
-  error: union([
-    literal("fetch_failed"),
-    literal("expired_url"),
-    literal("extraction_failed"),
-    literal("unknown")
-  ]),
+  error: union([literal("fetch_failed"), literal("expired_url"), literal("extraction_failed"), literal("unknown")]),
   message: optional(string())
 });
 var HtmlViewOpenSchema = object({
@@ -836,11 +828,7 @@ var ContainerModeChangeSchema = object({
 var ContainerModeChangeAckSchema = object({
   type: literal("container:mode:change:ack"),
   success: boolean(),
-  currentMode: union([
-    literal("floating"),
-    literal("sidebar"),
-    literal("floating-forced")
-  ]),
+  currentMode: union([literal("floating"), literal("sidebar"), literal("floating-forced")]),
   nonce: optional(union([string(), number()]))
 });
 var ContainerLayoutStateChangedSchema = object({
@@ -858,22 +846,13 @@ var ConfigUpdateSchema = object({
   hostOrigin: optional(string()),
   tapUrl: optional(string()),
   apiUrl: optional(string()),
-  environment: optional(
-    union([
-      literal("dev"),
-      literal("prod"),
-      literal("demo"),
-      literal("staging")
-    ])
-  ),
+  environment: optional(union([literal("dev"), literal("prod"), literal("demo"), literal("staging")])),
   language: optional(string()),
   userId: optional(string()),
   courseId: optional(string()),
   clipId: optional(string()),
   clipPlayHead: optional(number()),
-  mode: optional(
-    union([literal("inline"), literal("floating"), literal("sidebar")])
-  ),
+  mode: optional(union([literal("inline"), literal("floating"), literal("sidebar")])),
   allowLayoutToggle: optional(boolean()),
   container: optional(
     object({
@@ -901,11 +880,19 @@ var ConfigUpdateSchema = object({
     })
   )
 });
+var ConfigRequestSchema = object({
+  type: literal("config:request"),
+  nonce: optional(union([string(), number()]))
+});
 var GAEventSchema = object({
   type: literal("GA_EVENT"),
   payload: record(string(), any())
   // 유연한 payload 구조
 });
+var TutorInfoSchema = object({
+  type: literal("tutor:info"),
+  tutorName: string()
+});
 var TapMessageSchema = union([
   TapReadySchema,
   TapCloseSchema,
@@ -924,12 +911,14 @@ var TapMessageSchema = union([
   ContainerLayoutStateChangedSchema,
   ViewportResizeSchema,
   ConfigUpdateSchema,
-  GAEventSchema
+  ConfigRequestSchema,
+  GAEventSchema,
+  TutorInfoSchema
 ]);
 
 // src/tap-button.d.ts
 var TAP_BUTTON_CLICK_EVENT = "tap-button:click";
 
-export { ALARM_DURATION, AlarmClickSchema, AlarmElementPropsSchema, AlarmElementSchema, AlarmFadeInSchema, AlarmMessageInstanceSchema, CSSStyleSchema, ConfigUpdateSchema, ContainerLayoutStateChangedSchema, ContainerModeChangeAckSchema, ContainerModeChangeSchema, GAEventSchema, HtmlViewCloseSchema, HtmlViewOpenSchema, TapKitInitializationError as InitializationError, MaterialViewCloseSchema, MaterialViewErrorSchema, MaterialViewOpenSchema, MaterialViewerError, PopUpCloseSchema, PopUpOpenSchema, TAP_BUTTON_CLICK_EVENT, TAP_ERROR_MARKER, TapCloseSchema, TapKitConfigurationError, TapKitError, TapKitIframeError, TapKitInitializationError, TapKitLoaderError, TapKitMessageError, TapMessageSchema, TapReadySchema, TimelineSeekSchema, ViewportResizeSchema };
+export { ALARM_DURATION, AlarmClickSchema, AlarmElementPropsSchema, AlarmElementSchema, AlarmFadeInSchema, AlarmMessageInstanceSchema, CSSStyleSchema, ConfigRequestSchema, ConfigUpdateSchema, ContainerLayoutStateChangedSchema, ContainerModeChangeAckSchema, ContainerModeChangeSchema, GAEventSchema, HtmlViewCloseSchema, HtmlViewOpenSchema, TapKitInitializationError as InitializationError, MaterialViewCloseSchema, MaterialViewErrorSchema, MaterialViewOpenSchema, MaterialViewerError, PopUpCloseSchema, PopUpOpenSchema, TAP_BUTTON_CLICK_EVENT, TAP_ERROR_MARKER, TapCloseSchema, TapKitConfigurationError, TapKitError, TapKitIframeError, TapKitInitializationError, TapKitLoaderError, TapKitMessageError, TapMessageSchema, TapReadySchema, TimelineSeekSchema, TutorInfoSchema, ViewportResizeSchema };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map