@coxwave/tap-kit-types 2.0.3 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +92 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2371,6 +2371,76 @@ type SeekTimelineParamsType = {
|
|
|
2371
2371
|
clipId: string;
|
|
2372
2372
|
clipPlayHead: number;
|
|
2373
2373
|
};
|
|
2374
|
+
/**
|
|
2375
|
+
* TapKit Ready Event - Fired when iframe is initialized and ready
|
|
2376
|
+
*
|
|
2377
|
+
* @example
|
|
2378
|
+
* ```typescript
|
|
2379
|
+
* document.addEventListener('tapkit:ready', (e) => {
|
|
2380
|
+
* console.log('TapKit ready! GA ID:', e.detail.gaId);
|
|
2381
|
+
* });
|
|
2382
|
+
* ```
|
|
2383
|
+
*/
|
|
2384
|
+
interface TapKitReadyEvent extends CustomEvent<{
|
|
2385
|
+
gaId: string;
|
|
2386
|
+
}> {
|
|
2387
|
+
}
|
|
2388
|
+
/**
|
|
2389
|
+
* TapKit Close Event - Fired when chat is closed from within iframe
|
|
2390
|
+
*
|
|
2391
|
+
* @example
|
|
2392
|
+
* ```typescript
|
|
2393
|
+
* document.addEventListener('tapkit:close', () => {
|
|
2394
|
+
* console.log('Chat closed');
|
|
2395
|
+
* });
|
|
2396
|
+
* ```
|
|
2397
|
+
*/
|
|
2398
|
+
interface TapKitCloseEvent extends CustomEvent<undefined> {
|
|
2399
|
+
}
|
|
2400
|
+
/**
|
|
2401
|
+
* TapKit Timeline Seek Event - Fired when user clicks timeline in chat
|
|
2402
|
+
*
|
|
2403
|
+
* @example
|
|
2404
|
+
* ```typescript
|
|
2405
|
+
* document.addEventListener('tapkit:timeline:seek', (e) => {
|
|
2406
|
+
* videoElement.currentTime = e.detail.clipPlayHead;
|
|
2407
|
+
* });
|
|
2408
|
+
* ```
|
|
2409
|
+
*/
|
|
2410
|
+
interface TapKitTimelineSeekEvent extends CustomEvent<{
|
|
2411
|
+
clipId: string;
|
|
2412
|
+
clipPlayHead: number;
|
|
2413
|
+
}> {
|
|
2414
|
+
}
|
|
2415
|
+
/**
|
|
2416
|
+
* TapKit Material View Open Event - Fired when PDF/document viewer opens
|
|
2417
|
+
*
|
|
2418
|
+
* @example
|
|
2419
|
+
* ```typescript
|
|
2420
|
+
* document.addEventListener('tapkit:material:view:open', (e) => {
|
|
2421
|
+
* console.log('Material opened:', e.detail.materialId);
|
|
2422
|
+
* });
|
|
2423
|
+
* ```
|
|
2424
|
+
*/
|
|
2425
|
+
interface TapKitMaterialViewOpenEvent extends CustomEvent<{
|
|
2426
|
+
materialId: string;
|
|
2427
|
+
presignedUrl: string;
|
|
2428
|
+
pageStart?: number;
|
|
2429
|
+
pageEnd?: number;
|
|
2430
|
+
}> {
|
|
2431
|
+
}
|
|
2432
|
+
/**
|
|
2433
|
+
* TapKit Material View Close Event - Fired when PDF/document viewer closes
|
|
2434
|
+
*
|
|
2435
|
+
* @example
|
|
2436
|
+
* ```typescript
|
|
2437
|
+
* document.addEventListener('tapkit:material:view:close', () => {
|
|
2438
|
+
* console.log('Material viewer closed');
|
|
2439
|
+
* });
|
|
2440
|
+
* ```
|
|
2441
|
+
*/
|
|
2442
|
+
interface TapKitMaterialViewCloseEvent extends CustomEvent<undefined> {
|
|
2443
|
+
}
|
|
2374
2444
|
/**
|
|
2375
2445
|
* Shortcut Key Configuration
|
|
2376
2446
|
*/
|
|
@@ -3342,6 +3412,28 @@ interface TapMaterialViewerAttributes {
|
|
|
3342
3412
|
|
|
3343
3413
|
|
|
3344
3414
|
declare global {
|
|
3415
|
+
/**
|
|
3416
|
+
* TapKit CustomEvent types for document.addEventListener
|
|
3417
|
+
*
|
|
3418
|
+
* @example
|
|
3419
|
+
* ```typescript
|
|
3420
|
+
* document.addEventListener('tapkit:ready', (e) => {
|
|
3421
|
+
* console.log(e.detail.gaId); // Type-safe!
|
|
3422
|
+
* });
|
|
3423
|
+
*
|
|
3424
|
+
* document.addEventListener('tapkit:timeline:seek', (e) => {
|
|
3425
|
+
* videoElement.currentTime = e.detail.clipPlayHead; // Type-safe!
|
|
3426
|
+
* });
|
|
3427
|
+
* ```
|
|
3428
|
+
*/
|
|
3429
|
+
interface DocumentEventMap {
|
|
3430
|
+
"tapkit:ready": TapKitReadyEvent;
|
|
3431
|
+
"tapkit:close": TapKitCloseEvent;
|
|
3432
|
+
"tapkit:timeline:seek": TapKitTimelineSeekEvent;
|
|
3433
|
+
"tapkit:material:view:open": TapKitMaterialViewOpenEvent;
|
|
3434
|
+
"tapkit:material:view:close": TapKitMaterialViewCloseEvent;
|
|
3435
|
+
}
|
|
3436
|
+
|
|
3345
3437
|
interface Window {
|
|
3346
3438
|
TapKit?: TapKitConstructor;
|
|
3347
3439
|
createTapKit?: (config: {
|