@coxwave/tap-kit-types 2.10.3 → 2.10.4

package/dist/index.d.ts

@@ -207,8 +207,8 @@ type FeatureFlags = Partial<Record<FeatureFlagKey, boolean>>;
 /** Check if a feature is enabled. Falls back to FLAG_DEFAULTS. */
 declare function isFeatureEnabled(flags: FeatureFlags | undefined, key: FeatureFlagKey): boolean;
 
-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;
+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" | "host:context";
+type TapMessage = TapReadyMessage | TapCloseMessage | TimelineSeekMessage | AlarmClickMessage | AlarmFadeInMessage | PopUpOpenMessage | PopUpCloseMessage | MaterialViewOpenMessage | MaterialViewCloseMessage | MaterialViewErrorMessage | HtmlViewOpenMessage | HtmlViewCloseMessage | ContainerModeChangeMessage | ContainerModeChangeAckMessage | ContainerLayoutStateChangedMessage | ViewportResizeMessage | ConfigUpdateMessage | ConfigRequestMessage | GAEventMessage | TutorInfoMessage | HostContextMessage;
 interface TapReadyMessage {
     type: "tap:ready";
     gaId: string;
@@ -438,6 +438,26 @@ interface TutorInfoMessage {
     type: "tutor:info";
     tutorName: string;
 }
+/**
+ * Host Context Message (parent → iframe)
+ * Generic channel for host application to send contextual data to the iframe.
+ * Uses contextType discriminator for different context kinds (quiz answers, reading progress, etc.)
+ *
+ * @example
+ * ```typescript
+ * // Passage answer submission
+ * messenger.post({
+ *   type: "host:context",
+ *   contextType: "passage:answer:submit",
+ *   payload: { passageId, question, selectedOptionId, isCorrect }
+ * });
+ * ```
+ */
+interface HostContextMessage {
+    type: "host:context";
+    contextType: string;
+    payload: Record<string, unknown>;
+}
 
 /**
  * Fallback type.
@@ -2279,6 +2299,11 @@ declare const TutorInfoSchema: ObjectSchema<{
     readonly type: LiteralSchema<"tutor:info", undefined>;
     readonly tutorName: StringSchema<undefined>;
 }, undefined>;
+declare const HostContextSchema: ObjectSchema<{
+    readonly type: LiteralSchema<"host:context", undefined>;
+    readonly contextType: StringSchema<undefined>;
+    readonly payload: RecordSchema<StringSchema<undefined>, AnySchema, undefined>;
+}, undefined>;
 declare const TapMessageSchema: UnionSchema<[ObjectSchema<{
     readonly type: LiteralSchema<"tap:ready", undefined>;
     readonly gaId: StringSchema<undefined>;
@@ -2387,6 +2412,10 @@ declare const TapMessageSchema: UnionSchema<[ObjectSchema<{
 }, undefined>, ObjectSchema<{
     readonly type: LiteralSchema<"tutor:info", undefined>;
     readonly tutorName: StringSchema<undefined>;
+}, undefined>, ObjectSchema<{
+    readonly type: LiteralSchema<"host:context", undefined>;
+    readonly contextType: StringSchema<undefined>;
+    readonly payload: RecordSchema<StringSchema<undefined>, AnySchema, undefined>;
 }, undefined>], undefined>;
 
 type TapMessageRecord = TapMessage;
@@ -2786,6 +2815,12 @@ interface TapKitInstance {
     setCourse(course: Partial<Course> & {
         courseId: string;
     }): void;
+    /**
+     * Send contextual data from host application to the iframe
+     * @param contextType - Discriminator for context kind (e.g., "passage:answer:submit")
+     * @param payload - Arbitrary data payload
+     */
+    sendContext(contextType: string, payload: Record<string, unknown>): void;
 }
 /** TapKit constructor type */
 type TapKitConstructor = new (config: TapKitConfig) => TapKitInstance;
@@ -3425,6 +3460,27 @@ interface TapKitElement extends HTMLElement {
    */
   setCourse(course: Partial<Course> & { courseId: string }): void;
 
+  /**
+   * Send contextual data from host application to the iframe (AI tutor)
+   *
+   * Generic channel for passing host context (quiz answers, reading progress, etc.)
+   * to the iframe. Uses contextType discriminator for different context kinds.
+   *
+   * @param contextType - Discriminator string (e.g., "passage:answer:submit")
+   * @param payload - Arbitrary data payload
+   *
+   * @example
+   * ```typescript
+   * kit.sendContext("passage:answer:submit", {
+   *   passageId: "p1",
+   *   question: "What is...?",
+   *   selectedOptionId: "A",
+   *   isCorrect: true,
+   * });
+   * ```
+   */
+  sendContext(contextType: string, payload: Record<string, unknown>): void;
+
   // ===== Delegate Properties (Read-only) =====
 
   /**
@@ -3903,4 +3959,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 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, FLAG_DEFAULTS, type FeatureFlagKey, type FeatureFlags, 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, FLAG_DEFAULTS, type FeatureFlagKey, type FeatureFlags, type FloatingConfig, type GAEventMessage, GAEventSchema, type HostContextMessage, HostContextSchema, 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

@@ -908,6 +908,11 @@ var TutorInfoSchema = object({
   type: literal("tutor:info"),
   tutorName: string()
 });
+var HostContextSchema = object({
+  type: literal("host:context"),
+  contextType: string(),
+  payload: record(string(), any())
+});
 var TapMessageSchema = union([
   TapReadySchema,
   TapCloseSchema,
@@ -928,12 +933,13 @@ var TapMessageSchema = union([
   ConfigUpdateSchema,
   ConfigRequestSchema,
   GAEventSchema,
-  TutorInfoSchema
+  TutorInfoSchema,
+  HostContextSchema
 ]);
 
 // src/tap-button.d.ts
 var TAP_BUTTON_CLICK_EVENT = "tap-button:click";
 
-export { ALARM_DURATION, AlarmClickSchema, AlarmElementPropsSchema, AlarmElementSchema, AlarmFadeInSchema, AlarmMessageInstanceSchema, CSSStyleSchema, ConfigRequestSchema, ConfigUpdateSchema, ContainerLayoutStateChangedSchema, ContainerModeChangeAckSchema, ContainerModeChangeSchema, FLAG_DEFAULTS, 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, isFeatureEnabled };
+export { ALARM_DURATION, AlarmClickSchema, AlarmElementPropsSchema, AlarmElementSchema, AlarmFadeInSchema, AlarmMessageInstanceSchema, CSSStyleSchema, ConfigRequestSchema, ConfigUpdateSchema, ContainerLayoutStateChangedSchema, ContainerModeChangeAckSchema, ContainerModeChangeSchema, FLAG_DEFAULTS, GAEventSchema, HostContextSchema, 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, isFeatureEnabled };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map