@coxwave/tap-sdk 0.2.8 → 0.3.1

package/index.ts

@@ -1,361 +0,0 @@
-/**
- * TapKit wrapper - npm package wrapper
- *
- * Simply loads the CDN loader which handles version management and SDK loading.
- * This keeps the npm package minimal and allows instant updates via CDN.
- */
-
-import type {
-  TapKitConfig,
-  TapKitInitParams,
-  Course,
-  ContainerStyle,
-  PositionType,
-  SeekTimelineParamsType,
-  AlarmMessageInstanceType,
-  AlarmType,
-} from "./types";
-
-// Version injected at build time via tsup define
-declare const __PACKAGE_VERSION__: string;
-
-const CDN_LOADER_URL = "https://files.edutap.ai/tap-sdk/loader.js";
-
-/**
- * Base TapKit instance interface
- * Shared properties and methods between core and wrapper
- */
-interface TapKitBaseInstance {
-  events: {
-    seekTimeline: (params: SeekTimelineParamsType) => void;
-    onTimelineSeek: (
-      callback: (clipPlayHead: number, clipId: string) => void
-    ) => void;
-    onChatInitiated: (handler: () => void) => void;
-    onChatOpened: (handler: () => void) => void;
-    onChatClosed: (handler: () => void) => void;
-    onAlarmFadeIn: (
-      handler: (messageInfo: AlarmMessageInstanceType) => void
-    ) => void;
-    onPopUpOpen: (handler: (popUpInfo: any) => void) => void;
-    onPdfOpen: (handler: () => void) => void;
-    onPdfClose: (handler: () => void) => void;
-  };
-  isOpen: boolean;
-  isInitialized: boolean;
-  ready: Promise<void>;
-  init(params: TapKitInitParams): Promise<void>;
-  destroy(): void;
-}
-
-/**
- * TapKit instance type from tap-kit-core
- * This matches the actual TapKit class exported from @coxwave/tap-kit-core
- * Exported for advanced use cases (e.g., when using window.TapKit directly)
- */
-export interface TapKitCoreInstance extends TapKitBaseInstance {}
-
-// Global namespace for loaded SDK
-// Export type for IIFE bundles loaded via window.TapKit
-export type TapKitConstructor = new (
-  config: TapKitConfig
-) => TapKitCoreInstance;
-
-declare global {
-  interface Window {
-    TapKit?: TapKitConstructor;
-    __TAP_KIT_LOADER_LOADED__?: boolean;
-    __TAP_KIT_LOADER_LOADING__?: Promise<void>;
-  }
-}
-
-/**
- * Public TapKit instance interface
- * This is what users interact with when using the SDK
- */
-export interface TapKitInstance extends TapKitBaseInstance {
-  // Wrapper-specific method
-  getVersion(): string;
-}
-
-/**
- * Creates a SDK checker function with timeout and retry logic
- */
-function createSDKChecker(
-  resolve: (value: void | PromiseLike<void>) => void,
-  reject: (reason?: any) => void
-): () => void {
-  const MAX_RETRIES = 26; // 26 * 150ms ≈ 4 seconds max
-  const TIMEOUT_MS = 4000; // 4 seconds total timeout
-  let retryCount = 0;
-  const startTime = Date.now();
-
-  const checkSDK = (): void => {
-    if (window.TapKit) {
-      window.__TAP_KIT_LOADER_LOADED__ = true;
-      window.__TAP_KIT_LOADER_LOADING__ = undefined;
-      resolve();
-      return;
-    }
-
-    retryCount++;
-    const elapsed = Date.now() - startTime;
-
-    // Check if exceeded timeout or max retries
-    if (elapsed > TIMEOUT_MS) {
-      window.__TAP_KIT_LOADER_LOADING__ = undefined;
-      reject(
-        new Error(
-          `TapKit loader timeout: SDK not available after ${TIMEOUT_MS}ms`
-        )
-      );
-      return;
-    }
-
-    if (retryCount >= MAX_RETRIES) {
-      window.__TAP_KIT_LOADER_LOADING__ = undefined;
-      reject(
-        new Error(
-          `TapKit loader failed: SDK not available after ${retryCount} retries`
-        )
-      );
-      return;
-    }
-
-    setTimeout(checkSDK, 150);
-  };
-
-  return checkSDK;
-}
-
-/**
- * Loads the CDN loader script
- * The loader will then fetch versions.json and load the appropriate SDK version
- */
-function loadCDNLoader(): Promise<void> {
-  // If already loaded, return immediately
-  if (window.__TAP_KIT_LOADER_LOADED__ && window.TapKit) {
-    return Promise.resolve();
-  }
-
-  // If currently loading, return the existing promise
-  if (window.__TAP_KIT_LOADER_LOADING__) {
-    return window.__TAP_KIT_LOADER_LOADING__;
-  }
-
-  // Create loading promise
-  const loadingPromise = new Promise<void>((resolve, reject) => {
-    if (typeof document === "undefined") {
-      reject(
-        new Error("TapKit requires browser environment (document is undefined)")
-      );
-      return;
-    }
-
-    const script = document.createElement("script");
-    script.src = CDN_LOADER_URL;
-    script.async = true;
-
-    script.onload = () => {
-      // The loader script will load the actual SDK
-      // We need to wait a bit for the loader to fetch and load the SDK
-      const checkSDK = createSDKChecker(resolve, reject);
-      checkSDK();
-    };
-
-    script.onerror = () => {
-      window.__TAP_KIT_LOADER_LOADING__ = undefined;
-      reject(new Error(`Failed to load TapKit CDN loader: ${CDN_LOADER_URL}`));
-    };
-
-    // Check if script already exists
-    const existingScript = document.querySelector(
-      `script[src="${CDN_LOADER_URL}"]`
-    );
-    if (existingScript) {
-      // Script already added but not yet loaded
-      existingScript.addEventListener("load", () => {
-        const checkSDK = createSDKChecker(resolve, reject);
-        checkSDK();
-      });
-      existingScript.addEventListener("error", () =>
-        reject(new Error(`Failed to load TapKit CDN loader: ${CDN_LOADER_URL}`))
-      );
-    } else {
-      document.head.appendChild(script);
-    }
-  });
-
-  window.__TAP_KIT_LOADER_LOADING__ = loadingPromise;
-  return loadingPromise;
-}
-
-// Use Symbol to hide SDK instance from enumeration
-const SDK_INSTANCE = Symbol("sdkInstance");
-const SDK_INSTANCE_LOADING = Symbol("sdkInstanceLoading");
-
-/**
- * TapKit Wrapper Class
- *
- * Loads the CDN loader and proxies all calls to the actual SDK
- */
-class TapKit implements TapKitInstance {
-  private [SDK_INSTANCE]?: TapKitCoreInstance;
-  private [SDK_INSTANCE_LOADING]: Promise<void>;
-
-  constructor(config: TapKitConfig) {
-    this[SDK_INSTANCE_LOADING] = this.loadAndInitialize(config);
-  }
-
-  private async loadAndInitialize(config: TapKitConfig): Promise<void> {
-    await loadCDNLoader();
-
-    if (!window.TapKit) {
-      throw new Error("TapKit not available after loading CDN loader");
-    }
-
-    this[SDK_INSTANCE] = new window.TapKit(config);
-  }
-
-  private async ensureLoaded(): Promise<TapKitCoreInstance> {
-    await this[SDK_INSTANCE_LOADING]; // Wait for SDK instance to be created
-
-    if (!this[SDK_INSTANCE]) {
-      throw new Error("TapKit instance not initialized");
-    }
-
-    return this[SDK_INSTANCE];
-  }
-
-  // Expose tap-kit-core's 'ready' promise as 'ready' for better API naming
-  // This resolves after init() is called and tap-kit-core is fully initialized
-  get ready(): Promise<void> {
-    return this.ensureLoaded().then((sdk) => sdk.ready);
-  }
-
-  // Public API - all methods proxy to the loaded SDK
-  get events() {
-    return {
-      seekTimeline: (params: SeekTimelineParamsType) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.seekTimeline(params))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to call seekTimeline:", error);
-          });
-      },
-      onTimelineSeek: (
-        callback: (clipPlayHead: number, clipId: string) => void
-      ) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onTimelineSeek(callback))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onTimelineSeek:", error);
-          });
-      },
-      onChatInitiated: (handler: () => void) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onChatInitiated(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onChatInitiated:", error);
-          });
-      },
-      onChatOpened: (handler: () => void) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onChatOpened(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onChatOpened:", error);
-          });
-      },
-      onChatClosed: (handler: () => void) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onChatClosed(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onChatClosed:", error);
-          });
-      },
-      onAlarmFadeIn: (
-        handler: (messageInfo: AlarmMessageInstanceType) => void
-      ) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onAlarmFadeIn(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onAlarmFadeIn:", error);
-          });
-      },
-      onPopUpOpen: (handler: (popUpInfo: any) => void) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onPopUpOpen(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onPopUpOpen:", error);
-          });
-      },
-      onPdfOpen: (handler: () => void) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onPdfOpen(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onPdfOpen:", error);
-          });
-      },
-      onPdfClose: (handler: () => void) => {
-        this.ensureLoaded()
-          .then((sdk) => sdk.events.onPdfClose(handler))
-          .catch((error) => {
-            console.error("[TapSDK] Failed to register onPdfClose:", error);
-          });
-      },
-    };
-  }
-
-  get isOpen(): boolean {
-    return this[SDK_INSTANCE]?.isOpen ?? false;
-  }
-
-  get isInitialized(): boolean {
-    return this[SDK_INSTANCE]?.isInitialized ?? false;
-  }
-
-  async init(params: TapKitInitParams): Promise<void> {
-    const sdk = await this.ensureLoaded();
-    return sdk.init(params);
-  }
-
-  destroy(): void {
-    if (this[SDK_INSTANCE]) {
-      this[SDK_INSTANCE].destroy();
-    }
-  }
-
-  getVersion(): string {
-    // tap-kit-core doesn't expose getVersion, return SDK wrapper version
-    // The actual implementation is loaded from CDN dynamically
-    if (!this[SDK_INSTANCE]) {
-      return "Not initialized";
-    }
-    return `Loaded from CDN (tap-sdk wrapper v${__PACKAGE_VERSION__})`;
-  }
-
-  /**
-   * Custom object tag for better console display
-   */
-  get [Symbol.toStringTag]() {
-    return "TapKit";
-  }
-}
-
-// Export the SDK class as default (for: import TapKit from '@coxwave/tap-sdk')
-export default TapKit;
-
-// TapKitInstance is already exported via the interface declaration above (line 72)
-// Users can import it via: import type { TapKitInstance } from '@coxwave/tap-sdk'
-
-// Re-export types for API compatibility
-export type {
-  TapKitConfig,
-  TapKitInitParams,
-  Course,
-  ContainerStyle,
-  PositionType,
-  SeekTimelineParamsType,
-  AlarmMessageInstanceType,
-  AlarmType,
-};

package/types.ts

@@ -1,65 +0,0 @@
-/**
- * TapKit Type Definitions
- *
- * Re-exported types for API compatibility with the loader.
- * These types match the actual SDK implementation in tap-kit-core.
- */
-
-// Re-export alarm types from tap-messages
-export type {
-  AlarmMessageInstanceType,
-  AlarmType,
-} from '@coxwave/tap-messages';
-
-// SDK Configuration
-export type TapKitConfig = {
-  apiKey: string;
-};
-
-// SDK Initialization Parameters
-export type TapKitInitParams = {
-  buttonId: string;
-  course: Course;
-  container?: ContainerStyle;
-};
-
-// Course Information
-export type Course = {
-  userId: string;
-  courseId: string;
-  clipId: string;
-  clipPlayHead?: number;
-};
-
-// Container Styling
-export type ContainerStyle = {
-  position?: PositionType;
-  width?: string;
-  height?: string;
-  borderRadius?: string;
-};
-
-export type PositionType = {
-  top?: string;
-  left?: string;
-  right?: string;
-  bottom?: string;
-};
-
-// Event Parameters
-export type SeekTimelineParamsType = {
-  clipId: string;
-  clipPlayHead: number;
-};
-
-// Container Visibility State
-export type ContainerVisibility = 'open' | 'closed';
-
-// Flattened container styles (backward compatibility)
-export type CustomStyles = ContainerStyle;
-
-// Shortcut Key Configuration
-export type ShortcutKeyPropertiesType = {
-  key: string;
-  modifier: 'ctrlKey' | 'altKey' | 'shiftKey' | 'metaKey' | '';
-};