@volley/vwr-loader 1.4.0 → 1.6.0

package/src/getDeviceId.ts

@@ -1,224 +0,0 @@
-import { v4 as uuidv4 } from "uuid"
-
-import { logger } from "./logger"
-import type { LGDeviceIdResponse, MobileExtendedWindow } from "./types"
-
-/**
- * Get a unique device identifier for the current platform.
- *
- * This function attempts to retrieve a device ID from platform-specific APIs.
- *
- * Platform handling:
- * - FireTV: DeviceInfo (Capacitor plugin)
- * - Android/iOS: window.iosAppContext / window.androidAppContext (phoneDeviceId)
- * - Samsung TV: webapis
- * - LG TV: webOS Luna service
- * - Web: localStorage (with generated UUID fallback)
- *
- * @param platform - Platform identifier ('FIRE_TV', 'SAMSUNG_TV', 'LG_TV', 'ANDROID_MOBILE', 'IOS_MOBILE', 'WEB')
- * @param logger - Optional logger for error reporting. Defaults to defaultLogger.
- * @returns A promise that resolves to a unique device identifier string, or null if retrieval fails
- *
- * @example
- * ```typescript
- * const deviceId = await getDeviceId('SAMSUNG_TV', logger)
- * if (!deviceId) {
- *   // Handle error
- * }
- * ```
- */
-export async function getDeviceId(platform: string): Promise<string | null> {
-    const normalizedPlatform = platform.toUpperCase()
-    switch (normalizedPlatform) {
-        case "FIRE_TV":
-            return await getFireTVDeviceId()
-        case "SAMSUNG_TV":
-            return await getSamsungDeviceId()
-        case "LG_TV":
-            return await getLGDeviceId()
-        case "ANDROID_MOBILE":
-        case "IOS_MOBILE":
-            return await getMobileDeviceId()
-        case "WEB":
-            return getLocalStorageDeviceId()
-        default:
-            const message = `[getDeviceId] Unknown platform: ${platform}`
-            logger.error(message)
-            return null
-    }
-}
-
-/**
- * Get or create device ID from localStorage (for Web platform)
- */
-function getLocalStorageDeviceId(): string {
-    const existingDeviceId = localStorage.getItem("volley_device_id")
-    if (existingDeviceId) {
-        return existingDeviceId
-    }
-
-    const newDeviceId = uuidv4()
-    localStorage.setItem("volley_device_id", newDeviceId)
-    return newDeviceId
-}
-
-/**
- * Attempt to get device ID from Capacitor DeviceInfo plugin (FireTV)
- */
-async function getFireTVDeviceId(): Promise<string | null> {
-    try {
-        if (!window.Capacitor?.Plugins?.DeviceInfo?.getAndroidId) {
-            return null
-        }
-
-        const result = await window.Capacitor.Plugins.DeviceInfo.getAndroidId()
-        if (result?.androidId && result.androidId.trim()) {
-            return result.androidId
-        } else {
-            logger.error(
-                "Capacitor.Plugins.DeviceInfo.getAndroidId returned empty"
-            )
-        }
-    } catch (error) {
-        const message = "Capacitor.Plugins.DeviceInfo.getAndroidId failed:"
-        logger.error(message, { error })
-    }
-    return null
-}
-
-/**
- * Attempt to get device ID from mobile app context (Android/iOS)
- *
- * iOS exposes phoneDeviceId via window.iosAppContext
- * Android exposes phoneDeviceId via window.androidAppContext (also check window.top for iframes)
- */
-function getMobileDeviceId(): string | null {
-    // Try iOS first
-    const iosId = (window as MobileExtendedWindow).iosAppContext?.phoneDeviceId
-    if (iosId && iosId.trim()) {
-        return iosId
-    }
-
-    // Try Android (check both window and window.top for iframe scenarios)
-    const androidContext = (window as MobileExtendedWindow).androidAppContext
-    try {
-        const androidId =
-            androidContext?.phoneDeviceId ??
-            (window.top as MobileExtendedWindow | null)?.androidAppContext
-                ?.phoneDeviceId
-        if (androidId && androidId.trim()) {
-            return androidId
-        }
-    } catch {
-        // window.top access can throw if cross-origin
-        const androidId = androidContext?.phoneDeviceId
-        if (androidId && androidId.trim()) {
-            return androidId
-        }
-    }
-
-    logger.error("[VWR:MobileDeviceId] phoneDeviceId not found", {
-        iosAppContext: !!(window as MobileExtendedWindow).iosAppContext,
-        androidAppContext: !!androidContext,
-    })
-    return null
-}
-
-/**
- * Attempt to get device ID from Samsung TV webapis
- */
-async function getSamsungDeviceId(): Promise<string | null> {
-    try {
-        if (!window.webapis?.productinfo?.getDuid) {
-            return null
-        }
-
-        const id = window.webapis.productinfo.getDuid()
-        if (id && id.trim()) {
-            return id
-        } else {
-            logger.error("Samsung webapis.getDuid returned empty")
-        }
-    } catch (error) {
-        const message = "Samsung webapis.getDuid failed:"
-        logger.error(message, { error })
-    }
-    return null
-}
-
-/**
- * Attempt to get device ID from LG TV using Luna Service.
- *
- * This implementation is copied from PSDK's LGTVDeviceInfo to ensure
- * the shell and SDK return the exact same device ID.
- *
- * TODO: In the future, PSDK should import this function from vwr-loader
- * to maintain a single source of truth for LG device ID retrieval.
- */
-const LG_LUNA_SERVICE_TIMEOUT = 5000
-
-async function getLGDeviceId(): Promise<string | null> {
-    if (!window.webOS?.service?.request) {
-        const message = "LG webOS service request not available"
-        logger.error(message)
-        return null
-    }
-
-    return new Promise((resolve) => {
-        let timeoutId: ReturnType<typeof setTimeout> | undefined
-        let request: { cancel: () => void } | undefined
-        let resolved = false
-
-        const cleanup = () => {
-            if (timeoutId) {
-                clearTimeout(timeoutId)
-                timeoutId = undefined
-            }
-            request?.cancel()
-        }
-
-        const finish = (value: string | null) => {
-            if (resolved) return
-            resolved = true
-            cleanup()
-            resolve(value)
-        }
-
-        timeoutId = setTimeout(() => {
-            const message = "LG Luna service timed out"
-            logger.error(message)
-            finish(null)
-        }, LG_LUNA_SERVICE_TIMEOUT)
-
-        try {
-            request = window.webOS?.service?.request(
-                "luna://com.webos.service.sm",
-                {
-                    method: "deviceid/getIDs",
-                    parameters: { idType: ["LGUDID"] },
-                    onSuccess: (response: LGDeviceIdResponse) => {
-                        const deviceId = response.idList?.[0]?.idValue
-                        if (!deviceId) {
-                            const message =
-                                "LG Luna service returned no device ID"
-                            logger.error(message)
-                        }
-                        finish(deviceId || null)
-                    },
-                    onFailure: (error) => {
-                        const message = "LG Luna service failed:"
-                        logger.error(message, { error })
-                        finish(null)
-                    },
-                    subscribe: false,
-                }
-            )
-        } catch (error) {
-            const message = "LG Luna service request threw error:"
-            logger.error(message, { error })
-            finish(null)
-        }
-    })
-}
-
-// Types imported from ./types.ts

package/src/types.ts

@@ -1,92 +0,0 @@
-/**
- * Shared type definitions for vwr-loader platform APIs
- */
-
-/**
- * Extended window interface for mobile app context.
- * Matches the types from @volley/sdk ExtendedWindow.ts
- */
-export interface MobileExtendedWindow extends Window {
-    iosAppContext?: {
-        appVersion: string
-        environment?: string
-        phoneDeviceId?: string
-    }
-    androidAppContext?: {
-        appVersion: string
-        environment?: string
-        phoneDeviceId?: string
-    }
-}
-
-/**
- * Global type declarations for platform APIs
- */
-declare global {
-    interface Window {
-        Capacitor?: {
-            Plugins?: {
-                DeviceInfo?: {
-                    getDeviceInfo(): Promise<{
-                        versionName?: string
-                        [key: string]: any
-                    }>
-                    getAndroidId(): Promise<{
-                        androidId?: string
-                        [key: string]: any
-                    }>
-                    getNativeShellAppEnvironment(): Promise<{
-                        environment?: string
-                    }>
-                    [key: string]: any
-                }
-                [key: string]: any
-            }
-            [key: string]: any
-        }
-        webapis?: {
-            productinfo?: {
-                getDuid: () => string
-            }
-        }
-        webOS?: {
-            service?: {
-                request: (
-                    uri: string,
-                    options: {
-                        method?: string
-                        parameters?: Record<string, unknown>
-                        onSuccess?: (response: LGDeviceIdResponse) => void
-                        onFailure?: (error: { errorText?: string }) => void
-                        subscribe?: boolean
-                    }
-                ) => {
-                    cancel: () => void
-                }
-            }
-            fetchAppInfo?: (
-                callback: (appInfo?: { version?: string }) => void
-            ) => void
-            platformBack?: () => void
-        }
-        tizen?: {
-            application?: {
-                getAppInfo: () => { version?: string }
-                getCurrentApplication: () => {
-                    exit: () => void
-                }
-            }
-        }
-    }
-}
-
-/**
- * LG Luna service response for device ID
- */
-export interface LGDeviceIdResponse {
-    idList?: Array<{
-        idType?: string
-        idValue?: string
-    }>
-    returnValue?: boolean
-}