@vizbeetv/homesso-sdk-qa 1.0.1

package/types/ui/VizbeeHomeSSOUIManager.d.ts

@@ -0,0 +1,105 @@
+/**
+ * @fileoverview Manages UI configuration for Vizbee Home SSO implementation
+ * Handles theme customization and modal preferences for different sign-in states
+ */
+import { CommonModalPreferenceOptions, InformationalSignInPreferenceOptions, ProgressSignInPreferenceOptions, SuccessSignInPreferenceOptions, VizbeeHomeSSOTheme } from './VizbeeHomeSSOUIConfig';
+/**
+ * Singleton class responsible for managing UI configurations for Home SSO experience
+ * Handles theme customization and specific modal configurations for different sign-in states
+ */
+export declare class VizbeeHomeSSOUIManager {
+    private static instance;
+    private themeConfig;
+    private commonModalConfig;
+    private informationalModalConfig;
+    private progressModalConfig;
+    private successModalConfig;
+    /**
+     * Private constructor to enforce singleton pattern
+     * Initializes configurations with default values using deep merge
+     */
+    private constructor();
+    /**
+     * Gets the singleton instance of VizbeeHomeSSOUIManager
+     * Creates a new instance if one doesn't exist
+     * @returns The singleton instance of VizbeeHomeSSOUIManager
+     */
+    static getInstance(): VizbeeHomeSSOUIManager;
+    /**
+     * Creates a deep clone of an object or array
+     * @param obj - Object to clone
+     * @returns Deep cloned copy of the input
+     */
+    private deepClone;
+    private fallbackDeepClone;
+    /**
+     * Performs a deep merge of multiple objects
+     * @param target - Base object to merge into
+     * @param sources - Array of objects to merge from
+     * @returns Merged object combining all sources into target
+     */
+    private deepMerge;
+    /**
+     * Maps theme configuration to modal configuration properties
+     * @param theme - Current theme configuration
+     * @returns Partial modal configuration based on theme
+     */
+    private mapThemeToModalConfig;
+    /**
+     * Returns default configurations for all modal types
+     * @returns Object containing default configs for informational, progress, and success modals
+     */
+    getDefaultConfig(): {
+        informational: InformationalSignInPreferenceOptions;
+        progress: ProgressSignInPreferenceOptions;
+        success: SuccessSignInPreferenceOptions;
+    };
+    /**
+     * Updates the current theme configuration
+     * @param theme - Partial theme configuration to merge with current theme
+     */
+    setTheme(theme: Partial<VizbeeHomeSSOTheme>): void;
+    /**
+     * Retrieves current theme configuration
+     * @returns Deep clone of current theme configuration
+     */
+    getTheme(): VizbeeHomeSSOTheme;
+    /**
+     * Updates common modal configuration applied to all modal types
+     * @param config - Partial configuration to merge with current common config
+     */
+    setCommonModalConfig(config: Partial<CommonModalPreferenceOptions>): void;
+    /**
+     * Updates informational sign-in modal configuration
+     * @param config - Partial configuration to merge with current informational config
+     */
+    setInformationalSignInModalConfig(config: Partial<InformationalSignInPreferenceOptions>): void;
+    /**
+     * Updates progress sign-in modal configuration
+     * @param config - Partial configuration to merge with current progress config
+     */
+    setProgressSignInModalConfig(config: Partial<ProgressSignInPreferenceOptions>): void;
+    /**
+     * Updates success sign-in modal configuration
+     * @param config - Partial configuration to merge with current success config
+     */
+    setSuccessSignInModalConfig(config: Partial<SuccessSignInPreferenceOptions>): void;
+    /**
+     * Retrieves complete configuration for informational sign-in modal
+     * Combines default, theme-based, common, and specific configurations
+     * @returns Complete informational modal configuration
+     */
+    getInformationalSignInModalConfig(): InformationalSignInPreferenceOptions;
+    /**
+     * Retrieves complete configuration for progress sign-in modal
+     * Combines default, theme-based, common, and specific configurations
+     * @returns Complete progress modal configuration
+     */
+    getProgressSignInModalConfig(): ProgressSignInPreferenceOptions;
+    /**
+     * Retrieves complete configuration for success sign-in modal
+     * Combines default, theme-based, common, and specific configurations
+     * @returns Complete success modal configuration
+     */
+    getSuccessSignInModalConfig(): SuccessSignInPreferenceOptions;
+}

package/types/ui/VizbeeSnackBar.d.ts

@@ -0,0 +1,100 @@
+/**
+ * @fileoverview A customizable snackbar component that displays messages with icons and animations.
+ * Supports multiple positions, animations, and responsive design based on screen size.
+ * Integrates with VizbeeHomeSSOUIManager for consistent theming and styling.
+ */
+/**
+ * Available positions for the snackbar on the screen
+ * Supports all four corners of the viewport
+ */
+export type SnackbarPosition = 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
+/**
+ * Reading/layout direction for the snackbar content.
+ * `'ltr'` (default) renders left-to-right with the icon leading on the left;
+ * `'rtl'` mirrors the layout for right-to-left locales — the icon moves to the
+ * trailing (right) side and text is right-aligned.
+ */
+export type ModalDirection = 'ltr' | 'rtl';
+/**
+ * Configuration options for displaying a snackbar
+ */
+export interface SnackbarOptions {
+    direction?: ModalDirection;
+    width?: string;
+    height?: string;
+    minHeight?: string;
+    padding?: string;
+    borderRadius?: string;
+    backgroundColor?: string;
+    edgeMargin?: string;
+    marginTop?: string;
+    marginRight?: string;
+    marginBottom?: string;
+    marginLeft?: string;
+    borderColor?: string;
+    borderWidth?: string;
+    boxShadow?: string;
+    iconBase64String?: string;
+    iconBase64Strings?: string[];
+    iconWidth?: string;
+    iconHeight?: string;
+    iconMarginRight?: string;
+    titleText?: string;
+    titleTextFontFamily?: string;
+    titleTextFontColor?: string;
+    titleTextFontSize?: string;
+    titleTextFontWeight?: string;
+    titleTextLineHeight?: string;
+    titleMarginBottom?: string;
+    descriptionText: string;
+    descriptionTextFontFamily?: string;
+    descriptionTextFontColor?: string;
+    descriptionTextFontSize?: string;
+    descriptionTextFontWeight?: string;
+    descriptionTextLineHeight?: string;
+    duration?: number;
+    position: SnackbarPosition;
+    shouldAnimateIcon?: boolean;
+}
+/**
+ * A class that manages the display of snackbar notifications with customizable styling and animations
+ */
+export declare class VizbeeSnackbar {
+    private container;
+    private timeoutId?;
+    private showSnackbarTimerId?;
+    private currentSnackbar?;
+    private animationInterval?;
+    private currentIconElement?;
+    private readonly uiManager;
+    private readonly BASE_DIMENSIONS;
+    /**
+     * Creates a new instance of VizbeeSnackbar
+     */
+    constructor();
+    /**
+     * Shows the snackbar with the specified options
+     */
+    show(options: SnackbarOptions): void;
+    /**
+     * Hides the currently displayed snackbar
+     */
+    hide(): void;
+    private getScreenScale;
+    private scaleValue;
+    private setupContainer;
+    private getSlideTransform;
+    private getPositionStyles;
+    private startIconAnimation;
+    private stopIconAnimation;
+    /**
+     * Whether the snackbar should render right-to-left.
+     * Defaults to LTR when no direction is provided.
+     */
+    private isRtl;
+    private createSnackbar;
+    private getSnackbarStyles;
+    private createContentWrapper;
+    private createIconWrapper;
+    private createTextWrapper;
+}

package/types/utils/Logger.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Logger
+ * A flexible logging system for TypeScript SDK with
+ * enable/disable capabilities and different log levels.
+ *
+ * Features:
+ * - Multiple severity levels from ERROR to TRACE
+ * - Colored console output with timestamps
+ * - Local storage persistence with size management
+ * - Environment-aware execution (handles environments without localStorage)
+ * - Export and clearing capabilities
+ */
+/**
+ * Defines logging severity levels in ascending order of verbosity.
+ * Lower values indicate higher severity. This hierarchy ensures
+ * that when a specific level is set, all logs of that level and
+ * higher severity (lower enum value) will be captured.
+ */
+export declare enum LogLevel {
+    /** Critical application errors that prevent proper functioning */
+    ERROR = 0,
+    /** Important issues that don't stop execution but require attention */
+    WARN = 1,
+    /** General operational information about system behavior */
+    INFO = 2,
+    /** Detailed diagnostic information for troubleshooting */
+    DEBUG = 3,
+    /** Extremely verbose execution flow information */
+    TRACE = 4
+}
+/**
+ * Configuration interface for customizing logger behavior.
+ * All settings can be modified at runtime through the setConfig method.
+ */
+export interface LoggerConfig {
+    /** Master switch to enable/disable all logging activity */
+    enabled: boolean;
+    /** Minimum severity threshold for capturing logs */
+    level: LogLevel;
+    /** Whether to include ISO timestamps in log messages */
+    useTimestamp: boolean;
+    /** Whether to apply color styling to console output when supported */
+    useColors: boolean;
+    /** Whether to output logs to the console */
+    logToConsole: boolean;
+    /** Whether to persist logs to localStorage (when available) */
+    logToStorage?: boolean;
+    /** Maximum number of entries to keep in storage (oldest removed first) */
+    maxStorageLogs?: number;
+}
+/**
+ * Type for additional data that can be attached to log entries.
+ * Using 'unknown' instead of 'any' for better type safety.
+ */
+export type LogData = unknown;
+/**
+ * Core logger implementation that provides multiple severity levels,
+ * configurable outputs, and flexible message formatting.
+ *
+ * The logger handles both console output and storage persistence,
+ * with environment detection to gracefully handle different contexts.
+ */
+export declare class Logger {
+    /**
+     * Current configuration controlling logger behavior.
+     * Modified through enable(), setLevel(), and setConfig() methods.
+     */
+    private config;
+    /**
+     * Storage key used for persisting logs in localStorage.
+     * Prefixed with 'vizbee_homesso_' to avoid collisions.
+     */
+    private storageKey;
+    /**
+     * Creates a new logger instance with optional custom configuration.
+     * The provided configuration is merged with default settings.
+     *
+     * @param config - Partial configuration to override default values
+     */
+    constructor(config?: Partial<LoggerConfig>);
+    /**
+     * Enables or disables all logging functionality.
+     * When disabled, no logs will be output regardless of level.
+     *
+     * @param enabled - Whether logging should be active (defaults to true)
+     */
+    enable(enabled?: boolean): void;
+    /**
+     * Sets the minimum severity level for capturing logs.
+     * Only logs at this level and more severe levels will be processed.
+     *
+     * @param level - The minimum LogLevel to capture
+     */
+    setLevel(level: LogLevel): void;
+    /**
+     * Returns a copy of the current logger configuration.
+     * Returns a new object to prevent accidental modification.
+     *
+     * @returns The complete current configuration
+     */
+    getConfig(): LoggerConfig;
+    /**
+     * Updates logger configuration with new settings.
+     * Merges the provided settings with the existing configuration.
+     *
+     * @param config - Partial configuration to apply
+     */
+    setConfig(config: Partial<LoggerConfig>): void;
+    /**
+     * Logs an error message (highest severity).
+     * Use for critical failures that prevent proper operation.
+     *
+     * @param message - The error message to log
+     * @param data - Optional supplementary information
+     */
+    error(message: string, ...data: LogData[]): void;
+    /**
+     * Logs a warning message.
+     * Use for potential issues that don't stop execution.
+     *
+     * @param message - The warning message to log
+     * @param data - Optional supplementary information
+     */
+    warn(message: string, ...data: LogData[]): void;
+    /**
+     * Logs an informational message.
+     * Use for general application state and noteworthy events.
+     *
+     * @param message - The info message to log
+     * @param data - Optional supplementary information
+     */
+    info(message: string, ...data: LogData[]): void;
+    /**
+     * Logs a debug message.
+     * Use for detailed information helpful during development.
+     *
+     * @param message - The debug message to log
+     * @param data - Optional supplementary information
+     */
+    debug(message: string, ...data: LogData[]): void;
+    /**
+     * Logs a trace message (lowest severity/highest verbosity).
+     * Use for extremely detailed execution path tracking.
+     *
+     * @param message - The trace message to log
+     * @param data - Optional supplementary information
+     */
+    trace(message: string, ...data: LogData[]): void;
+    /**
+     * Core logging method that handles level filtering and message routing.
+     * Formats the message and sends it to appropriate outputs based on configuration.
+     *
+     * @param level - Log severity level
+     * @param message - The message to log
+     * @param data - Additional data to include with the log
+     */
+    private log;
+    /**
+     * Handles console output with optional color styling.
+     * Applies different colors based on log level for better readability.
+     *
+     * @param level - Log severity level
+     * @param message - Formatted message to output
+     * @param data - Additional data to log
+     */
+    private logToConsole;
+    /**
+     * Determines CSS styling for console output based on log level.
+     * Returns different colors to visually distinguish log levels.
+     *
+     * @param level - Log severity level
+     * @returns CSS style string for console output
+     */
+    private getConsoleStyles;
+    /**
+     * Sets up localStorage for persisting logs if available.
+     * Creates the initial empty logs array if not already present.
+     * Gracefully handles environments without localStorage access.
+     */
+    private initializeStorage;
+    /**
+     * Persists a log entry to localStorage with rotation management.
+     * Removes oldest entries when the maximum count is exceeded.
+     * Handles storage errors gracefully.
+     *
+     * @param message - Formatted message to store
+     * @param data - Additional data to include
+     */
+    private logToStorage;
+    /**
+     * Exports all stored logs as a JSON string.
+     * Returns an empty array string if storage is unavailable.
+     *
+     * @returns JSON string containing all stored logs
+     */
+    exportLogs(): string;
+    /**
+     * Clears all logs from storage.
+     * Replaces the current logs with an empty array.
+     */
+    clearLogs(): void;
+}
+/**
+ * Default singleton logger instance with standard configuration.
+ * Available as a ready-to-use logger throughout the application.
+ * For custom configurations, create additional Logger instances.
+ */
+export declare const logger: Logger;

package/types/utils/constants.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @const VizbeeConstants
+ * @description Constants used throughout the Vizbee Home SSO implementation
+ */
+export declare const VizbeeConstants: {
+    readonly EVENT_SSO_NAME: "tv.vizbee.homesso.signin";
+    readonly KEY_SUB_TYPE: "sub_type";
+    readonly KEY_SIGN_IN_STATUS: "sstatus";
+    readonly KEY_STATE: "sstate";
+    readonly KEY_CUSTOM_DATA: "custom_data";
+    readonly KEY_REG_CODE: "regcode";
+    readonly KEY_START_SIGN_IN_INFO: "sinfo";
+    readonly KEY_IS_SIGNED_IN: "is_signed_in";
+    readonly KEY_SIGN_IN_TYPE: "stype";
+    readonly KEY_DEVICE_MODEL: "device_model";
+    readonly KEY_DEVICE_OS: "device_os";
+    readonly EVENT_SUBTYPE_START_SIGN_IN: "start_sign_in";
+    readonly EVENT_SUBTYPE_SIGN_IN_STATUS: "sign_in_status";
+    readonly VIZBEE_SESSION_READY: "vizbee-bicast-session-ready";
+};
+export declare enum VizbeeSignInState {
+    SIGN_IN_NOT_STARTED = "not_started",
+    SIGN_IN_IN_PROGRESS = "in_progress",
+    SIGN_IN_COMPLETED = "completed",
+    SIGN_IN_FAILED = "failed",
+    SIGN_IN_CANCELLED = "cancelled"
+}

package/types/utils/http-client.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @fileoverview A robust HTTP client implementation with retry mechanism, timeout handling,
+ * and type safety. Provides a wrapper around the Fetch API with additional features.
+ */
+/**
+ * Configuration options for HTTP requests, extending the native RequestInit interface
+ */
+export interface RequestConfig extends RequestInit {
+    /** Timeout in milliseconds */
+    timeout?: number;
+    /** Number of retry attempts */
+    retries?: number;
+    /** Delay between retries in milliseconds */
+    retryDelay?: number;
+}
+/**
+ * Standard HTTP response format with type safety
+ */
+export interface HttpResponse<T = any> {
+    /** Response data of type T */
+    data: T;
+    /** HTTP status code */
+    status: number;
+    /** Response headers */
+    headers: Headers;
+    /** Whether the request was successful */
+    ok: boolean;
+}
+/**
+ * Custom error class for HTTP-related errors
+ */
+export declare class HttpError extends Error {
+    message: string;
+    status?: number | undefined;
+    response?: any | undefined;
+    /**
+     * Creates a new HttpError instance
+     * @param message Error message
+     * @param status HTTP status code
+     * @param response Raw response data
+     */
+    constructor(message: string, status?: number | undefined, response?: any | undefined);
+}
+/**
+ * A feature-rich HTTP client with support for timeouts, retries, and type safety
+ */
+export declare class HttpClient {
+    private readonly baseUrl;
+    private readonly defaultConfig;
+    /**
+     * Creates a new HttpClient instance
+     * @param baseUrl Base URL for all requests
+     * @param defaultConfig Default configuration for all requests
+     */
+    constructor(baseUrl?: string, defaultConfig?: RequestConfig);
+    /**
+     * Performs a GET request
+     * @param endpoint API endpoint
+     * @param config Request configuration
+     * @returns Promise resolving to typed response
+     */
+    get<T = any>(endpoint: string, config?: RequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * Performs a POST request
+     * @param endpoint API endpoint
+     * @param data Request body data
+     * @param config Request configuration
+     * @returns Promise resolving to typed response
+     */
+    post<T = any>(endpoint: string, data?: any, config?: RequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * Performs a PUT request
+     * @param endpoint API endpoint
+     * @param data Request body data
+     * @param config Request configuration
+     * @returns Promise resolving to typed response
+     */
+    put<T = any>(endpoint: string, data?: any, config?: RequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * Performs a DELETE request
+     * @param endpoint API endpoint
+     * @param config Request configuration
+     * @returns Promise resolving to typed response
+     */
+    delete<T = any>(endpoint: string, config?: RequestConfig): Promise<HttpResponse<T>>;
+    /**
+     * Executes a fetch request with timeout handling
+     * @throws {HttpError} When request times out
+     */
+    private fetchWithTimeout;
+    /**
+     * Processes the response and handles errors
+     * @throws {HttpError} When response is not OK
+     */
+    private handleResponse;
+    /**
+     * Implements retry logic for failed requests
+     * @throws {HttpError} When all retry attempts fail
+     */
+    private retryRequest;
+    /**
+     * Determines if a request should be retried
+     */
+    private shouldRetry;
+    /**
+     * Creates a delay using Promise
+     */
+    private delay;
+    /**
+     * Builds the complete URL from base URL and endpoint
+     */
+    private buildUrl;
+}
+export declare const httpClient: HttpClient;