@coxwave/tap-kit-types 2.1.0 → 2.5.5

package/dist/index.d.ts

@@ -223,6 +223,8 @@ interface MaterialViewOpenMessage {
     pageStart: number;
     pageEnd: number;
     title?: string;
+    /** Text phrases to highlight in PDF (from reference_string parsing) */
+    highlightPhrases?: string[];
     nonce?: string | number;
 }
 /**
@@ -367,6 +369,8 @@ interface ConfigUpdateMessage {
             minViewportWidth?: number;
         };
     };
+    /** SDK source for deprecation tracking (temporary - remove after monitoring period) */
+    sdkSource?: "tap-kit" | "tap-sdk";
 }
 /**
  * Config Request Message (iframe → parent, call/handle pattern)
@@ -2226,6 +2230,7 @@ declare const ConfigUpdateSchema: ObjectSchema<{
             readonly minViewportWidth: OptionalSchema<NumberSchema<undefined>, undefined>;
         }, undefined>, undefined>;
     }, undefined>, undefined>;
+    readonly sdkSource: OptionalSchema<UnionSchema<[LiteralSchema<"tap-kit", undefined>, LiteralSchema<"tap-sdk", undefined>], undefined>, undefined>;
 }, undefined>;
 declare const ConfigRequestSchema: ObjectSchema<{
     readonly type: LiteralSchema<"config:request", undefined>;
@@ -2336,6 +2341,7 @@ declare const TapMessageSchema: UnionSchema<[ObjectSchema<{
             readonly minViewportWidth: OptionalSchema<NumberSchema<undefined>, undefined>;
         }, undefined>, undefined>;
     }, undefined>, undefined>;
+    readonly sdkSource: OptionalSchema<UnionSchema<[LiteralSchema<"tap-kit", undefined>, LiteralSchema<"tap-sdk", undefined>], undefined>, undefined>;
 }, undefined>, ObjectSchema<{
     readonly type: LiteralSchema<"config:request", undefined>;
     readonly nonce: OptionalSchema<UnionSchema<[StringSchema<undefined>, NumberSchema<undefined>], undefined>, undefined>;
@@ -2647,9 +2653,25 @@ type ContainerVisibility = "open" | "closed";
  *
  * @example
  * ```typescript
- * const adapter = {
+ * // Simple adapter (backward compatible)
+ * const simpleAdapter: VideoPlayerAdapter = {
  *   getCurrentTime: () => player.currentTime,
- *   setCurrentTime: (time) => { player.currentTime = time; }
+ *   setCurrentTime: (time) => {
+ *     player.currentTime = time;
+ *   }
+ * };
+ *
+ * // Cross-clip seeking adapter (recommended)
+ * const crossClipAdapter: VideoPlayerAdapter = {
+ *   getCurrentTime: () => player.currentTime,
+ *   setCurrentTime: (time, clipId) => {
+ *     // clipId enables cross-clip seeking (e.g., jump to different lecture)
+ *     if (clipId && clipId !== currentClipId) {
+ *       loadClip(clipId).then(() => player.currentTime = time);
+ *     } else {
+ *       player.currentTime = time;
+ *     }
+ *   }
  * };
  * ```
  */
@@ -2659,9 +2681,9 @@ interface VideoPlayerAdapter {
     /**
      * Set playback time in seconds
      * @param time - Playback time in seconds
-     * @param clipId - ClipId from the seek request (for cross-clip seeking)
+     * @param clipId - ClipId from the seek request (for cross-clip seeking). Optional for backward compatibility.
      */
-    setCurrentTime: (time: number, clipId: string) => void;
+    setCurrentTime: (time: number, clipId?: string) => void;
 }
 /**
  * Video Player Configuration
@@ -2673,10 +2695,13 @@ interface VideoPlayerAdapter {
  * const videoElement = document.querySelector('video');
  * sdk.video.bind(videoElement);  // clipId from SDK config, auto-updates with setCourse()
  *
- * // Custom Adapter
- * const adapter = {
+ * // Custom Adapter (YouTube, Vimeo, etc.)
+ * const adapter: VideoPlayerAdapter = {
  *   getCurrentTime: () => player.currentTime,
- *   setCurrentTime: (time) => { player.currentTime = time; }
+ *   setCurrentTime: (time, clipId) => {
+ *     // clipId enables cross-clip seeking (e.g., jump to different lecture)
+ *     player.currentTime = time;
+ *   }
  * };
  * sdk.video.bind(adapter);
  *

package/dist/index.js

@@ -878,7 +878,8 @@ var ConfigUpdateSchema = object({
         })
       )
     })
-  )
+  ),
+  sdkSource: optional(union([literal("tap-kit"), literal("tap-sdk")]))
 });
 var ConfigRequestSchema = object({
   type: literal("config:request"),