@aladinbs/react-guided-tour 1.0.1

package/dist/core/TourEngine.d.ts

@@ -0,0 +1,35 @@
+import { TourConfig, TourStep, TourState, TourEngineEvents, TourEventCallback } from '../types';
+export declare class TourEngine {
+    private config;
+    private state;
+    private storage;
+    private listeners;
+    constructor(config: TourConfig);
+    private initializeState;
+    getState(): TourState;
+    getConfig(): TourConfig;
+    start(): Promise<void>;
+    next(): Promise<void>;
+    previous(): Promise<void>;
+    goToStep(index: number): Promise<void>;
+    skip(): Promise<void>;
+    complete(): Promise<void>;
+    stop(): Promise<void>;
+    getCurrentStep(): TourStep | null;
+    isFirstStep(): boolean;
+    isLastStep(): boolean;
+    canGoNext(): boolean;
+    canGoPrevious(): boolean;
+    shouldShowTour(): boolean;
+    resetTourState(): void;
+    private waitForElement;
+    private markStepCompleted;
+    private markStepSkipped;
+    private handleError;
+    private setState;
+    on<K extends keyof TourEngineEvents>(event: K, callback: TourEventCallback<TourEngineEvents[K]>): void;
+    off<K extends keyof TourEngineEvents>(event: K, callback: TourEventCallback<TourEngineEvents[K]>): void;
+    private emit;
+    subscribe(callback: (state: TourState) => void): () => void;
+}
+//# sourceMappingURL=TourEngine.d.ts.map

package/dist/core/TourEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TourEngine.d.ts","sourceRoot":"","sources":["../../src/core/TourEngine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGhG,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,SAAS,CAAwD;gBAE7D,MAAM,EAAE,UAAU;IAM9B,OAAO,CAAC,eAAe;IAmBhB,QAAQ,IAAI,SAAS;IAIrB,SAAS,IAAI,UAAU;IAIjB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAkCrB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAUzB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA0CtC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA6BrB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBzB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,cAAc,IAAI,QAAQ,GAAG,IAAI;IAIjC,WAAW,IAAI,OAAO;IAItB,UAAU,IAAI,OAAO;IAIrB,SAAS,IAAI,OAAO;IAIpB,aAAa,IAAI,OAAO;IAIxB,cAAc,IAAI,OAAO;IAKzB,cAAc,IAAI,IAAI;YAOf,cAAc;IA6B5B,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,QAAQ;IAOT,EAAE,CAAC,CAAC,SAAS,MAAM,gBAAgB,EACxC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAC/C,IAAI;IAOA,GAAG,CAAC,CAAC,SAAS,MAAM,gBAAgB,EACzC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAC/C,IAAI;IAOP,OAAO,CAAC,IAAI;IAUL,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI;CAqBnE"}

package/dist/core/TourStorage.d.ts

@@ -0,0 +1,14 @@
+import { TourState } from '../types';
+export declare class TourStorage {
+    private key;
+    constructor(key: string);
+    saveState(state: TourState): void;
+    getState(): Partial<TourState> | null;
+    clearState(): void;
+    hasState(): boolean;
+    saveCompletion(): void;
+    saveSkip(): void;
+    isCompleted(): boolean;
+    isSkipped(): boolean;
+}
+//# sourceMappingURL=TourStorage.d.ts.map

package/dist/core/TourStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TourStorage.d.ts","sourceRoot":"","sources":["../../src/core/TourStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,qBAAa,WAAW;IACtB,OAAO,CAAC,GAAG,CAAS;gBAER,GAAG,EAAE,MAAM;IAIhB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAejC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI;IAYrC,UAAU,IAAI,IAAI;IAQlB,QAAQ,IAAI,OAAO;IAQnB,cAAc,IAAI,IAAI;IActB,QAAQ,IAAI,IAAI;IAchB,WAAW,IAAI,OAAO;IAStB,SAAS,IAAI,OAAO;CAQ5B"}

package/dist/hooks/useTourEngine.d.ts

@@ -0,0 +1,21 @@
+import { TourEngine } from '../core/TourEngine';
+import { TourActions } from '../core/TourActions';
+import { TourConfig, TourState, TourStep } from '../types';
+export interface UseTourEngineReturn {
+    state: TourState;
+    start: () => Promise<void>;
+    stop: () => Promise<void>;
+    next: () => Promise<void>;
+    previous: () => Promise<void>;
+    skip: () => Promise<void>;
+    goToStep: (index: number) => Promise<void>;
+    isFirstStep: boolean;
+    isLastStep: boolean;
+    canGoNext: boolean;
+    canGoPrevious: boolean;
+    currentStep: TourStep | null;
+    engine: TourEngine;
+    actions: TourActions;
+}
+export declare function useTourEngine(config: TourConfig): UseTourEngineReturn;
+//# sourceMappingURL=useTourEngine.d.ts.map

package/dist/hooks/useTourEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTourEngine.d.ts","sourceRoot":"","sources":["../../src/hooks/useTourEngine.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE3D,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,SAAS,CAAC;IACjB,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;CACtB;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,mBAAmB,CAgErE"}

package/dist/hooks/useTourHighlight.d.ts

@@ -0,0 +1,8 @@
+import { TourStep } from '../types';
+export interface UseTourHighlightReturn {
+    targetElement: HTMLElement | null;
+    highlightStyle: React.CSSProperties;
+    isVisible: boolean;
+}
+export declare function useTourHighlight(step: TourStep | null): UseTourHighlightReturn;
+//# sourceMappingURL=useTourHighlight.d.ts.map

package/dist/hooks/useTourHighlight.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTourHighlight.d.ts","sourceRoot":"","sources":["../../src/hooks/useTourHighlight.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAmB,MAAM,UAAU,CAAC;AAGrD,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,WAAW,GAAG,IAAI,CAAC;IAClC,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC;IACpC,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,GAAG,sBAAsB,CAwH9E"}

package/dist/index.d.ts

@@ -0,0 +1,326 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+interface TourStep {
+    id: string;
+    title: string;
+    content: string;
+    target?: string;
+    placement?: 'top' | 'bottom' | 'left' | 'right' | 'center';
+    action?: TourAction;
+    highlight?: HighlightConfig;
+    popover?: PopoverConfig;
+    beforeStep?: () => Promise<void> | void;
+    afterStep?: () => Promise<void> | void;
+    canSkip?: boolean;
+    waitForElement?: boolean;
+    waitTimeout?: number;
+}
+interface TourAction {
+    type: 'click' | 'navigate' | 'highlight' | 'tab-switch' | 'wizard-step' | 'custom';
+    target?: string;
+    value?: string | number | Record<string, string | number | boolean>;
+    handler?: () => Promise<void> | void;
+    delay?: number;
+}
+interface HighlightConfig {
+    selector?: string;
+    element?: HTMLElement;
+    padding?: number;
+    borderRadius?: number;
+    borderWidth?: number;
+    animate?: boolean;
+    className?: string;
+}
+interface PopoverConfig {
+    title?: string;
+    content?: string;
+    showProgress?: boolean;
+    showSkip?: boolean;
+    nextLabel?: string;
+    skipLabel?: string;
+    finishLabel?: string;
+    className?: string;
+}
+interface TourConfig {
+    id: string;
+    steps: TourStep[];
+    theme?: TourTheme;
+    onStart?: () => void;
+    onComplete?: () => void;
+    onSkip?: () => void;
+    onStepChange?: (step: TourStep, index: number) => void;
+    allowKeyboardNavigation?: boolean;
+    allowClickOutside?: boolean;
+    showProgress?: boolean;
+    storage?: {
+        key?: string;
+        remember?: boolean;
+    };
+}
+interface TourTheme {
+    primaryColor?: string;
+    backgroundColor?: string;
+    textColor?: string;
+    borderRadius?: string;
+    fontFamily?: string;
+    fontSize?: string;
+    zIndex?: number;
+    overlay?: {
+        backgroundColor?: string;
+        opacity?: number;
+    };
+    highlight?: {
+        borderColor?: string;
+        borderWidth?: string;
+        glowColor?: string;
+        animation?: string;
+    };
+    popover?: {
+        backgroundColor?: string;
+        borderColor?: string;
+        shadow?: string;
+        maxWidth?: string;
+    };
+}
+interface TourState {
+    isRunning: boolean;
+    currentStepIndex: number;
+    currentStep: TourStep | null;
+    totalSteps: number;
+    isLoading: boolean;
+    error: string | null;
+    completedSteps: string[];
+    skippedSteps: string[];
+    isCompleted?: boolean;
+    isSkipped?: boolean;
+    completedAt?: string;
+    skippedAt?: string;
+}
+interface Integration {
+    name: string;
+    canHandle: (action: TourAction) => boolean;
+    execute: (action: TourAction, element?: HTMLElement) => Promise<void>;
+}
+interface TourEngineEvents {
+    'step-change': {
+        step: TourStep;
+        index: number;
+    };
+    'tour-start': {
+        tourId: string;
+    };
+    'tour-complete': {
+        tourId: string;
+    };
+    'tour-skip': {
+        tourId: string;
+        stepIndex: number;
+    };
+    'error': {
+        error: Error;
+        step?: TourStep;
+    };
+    'state-change': TourState;
+}
+type TourEventCallback<T = unknown> = (data: T) => void;
+interface ElementPosition {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+    right: number;
+    bottom: number;
+}
+interface PopoverPosition {
+    top: number;
+    left: number;
+    placement: 'top' | 'bottom' | 'left' | 'right' | 'center';
+}
+
+declare class TourEngine {
+    private config;
+    private state;
+    private storage;
+    private listeners;
+    constructor(config: TourConfig);
+    private initializeState;
+    getState(): TourState;
+    getConfig(): TourConfig;
+    start(): Promise<void>;
+    next(): Promise<void>;
+    previous(): Promise<void>;
+    goToStep(index: number): Promise<void>;
+    skip(): Promise<void>;
+    complete(): Promise<void>;
+    stop(): Promise<void>;
+    getCurrentStep(): TourStep | null;
+    isFirstStep(): boolean;
+    isLastStep(): boolean;
+    canGoNext(): boolean;
+    canGoPrevious(): boolean;
+    shouldShowTour(): boolean;
+    resetTourState(): void;
+    private waitForElement;
+    private markStepCompleted;
+    private markStepSkipped;
+    private handleError;
+    private setState;
+    on<K extends keyof TourEngineEvents>(event: K, callback: TourEventCallback<TourEngineEvents[K]>): void;
+    off<K extends keyof TourEngineEvents>(event: K, callback: TourEventCallback<TourEngineEvents[K]>): void;
+    private emit;
+    subscribe(callback: (state: TourState) => void): () => void;
+}
+
+declare class TourActions {
+    private integrations;
+    registerIntegration(integration: Integration): void;
+    unregisterIntegration(name: string): void;
+    execute(action: TourAction, element?: HTMLElement): Promise<void>;
+    private findIntegration;
+    private executeDefault;
+    private handleClick;
+    private handleNavigate;
+    private sleep;
+    getRegisteredIntegrations(): string[];
+    hasIntegration(name: string): boolean;
+}
+
+declare class TourStorage {
+    private key;
+    constructor(key: string);
+    saveState(state: TourState): void;
+    getState(): Partial<TourState> | null;
+    clearState(): void;
+    hasState(): boolean;
+    saveCompletion(): void;
+    saveSkip(): void;
+    isCompleted(): boolean;
+    isSkipped(): boolean;
+}
+
+interface UseTourEngineReturn {
+    state: TourState;
+    start: () => Promise<void>;
+    stop: () => Promise<void>;
+    next: () => Promise<void>;
+    previous: () => Promise<void>;
+    skip: () => Promise<void>;
+    goToStep: (index: number) => Promise<void>;
+    isFirstStep: boolean;
+    isLastStep: boolean;
+    canGoNext: boolean;
+    canGoPrevious: boolean;
+    currentStep: TourStep | null;
+    engine: TourEngine;
+    actions: TourActions;
+}
+declare function useTourEngine(config: TourConfig): UseTourEngineReturn;
+
+interface TourContextValue extends UseTourEngineReturn {
+    config: TourConfig;
+    theme: TourTheme;
+}
+interface TourProviderProps {
+    config: TourConfig;
+    children: ReactNode;
+}
+declare function TourProvider({ config, children }: TourProviderProps): react_jsx_runtime.JSX.Element;
+declare function useTour(): TourContextValue;
+
+interface TourRunnerProps {
+    className?: string;
+}
+declare function TourRunner({ className }: TourRunnerProps): react_jsx_runtime.JSX.Element | null;
+
+interface TourOverlayProps {
+    className?: string;
+}
+declare function TourOverlay({ className }: TourOverlayProps): react_jsx_runtime.JSX.Element | null;
+
+interface TourPopoverProps {
+    className?: string;
+}
+declare function TourPopover({ className }: TourPopoverProps): react_jsx_runtime.JSX.Element | null;
+
+interface UseTourHighlightReturn {
+    targetElement: HTMLElement | null;
+    highlightStyle: React.CSSProperties;
+    isVisible: boolean;
+}
+declare function useTourHighlight(step: TourStep | null): UseTourHighlightReturn;
+
+declare class TabIntegration implements Integration {
+    name: string;
+    canHandle(action: TourAction): boolean;
+    execute(action: TourAction, element?: HTMLElement): Promise<void>;
+    private handleTabClick;
+    private isRadixTab;
+    private handleRadixTab;
+    private isMaterialUITab;
+    private handleMaterialUITab;
+    private isRouterTab;
+    private handleRouterTab;
+    private isCustomTab;
+    private handleCustomTab;
+    private handleGenericTab;
+    private waitForTabChange;
+    private waitForNavigation;
+}
+
+declare class WizardIntegration implements Integration {
+    name: string;
+    canHandle(action: TourAction): boolean;
+    execute(action: TourAction, element?: HTMLElement): Promise<void>;
+    private handleWizardNavigation;
+    private isFormWizard;
+    private handleFormWizard;
+    private isStepper;
+    private handleStepper;
+    private isCustomWizard;
+    private handleCustomWizard;
+    private handleGenericWizard;
+    private isNextButton;
+    private isPreviousButton;
+    private navigateToStep;
+    private findStepByIndex;
+    private getCurrentStepIndex;
+    private findNextButton;
+    private findPreviousButton;
+    private waitForStepTransition;
+}
+
+declare class NavigationIntegration implements Integration {
+    name: string;
+    canHandle(action: TourAction): boolean;
+    execute(action: TourAction, _element?: HTMLElement): Promise<void>;
+    private handleNavigation;
+    private handleHashNavigation;
+    private handlePathNavigation;
+    private handleQueryNavigation;
+    private handleUrlNavigation;
+    private handleRouterNavigation;
+    private handleSPANavigation;
+    private isSPA;
+    private hasReactRouter;
+    private hasVueRouter;
+    private hasNextRouter;
+    private hasGenericSPA;
+    private detectAndCallRouter;
+    private handleReactRouter;
+    private handleVueRouter;
+    private handleNextRouter;
+    private waitForNavigation;
+}
+
+declare function getElementPosition(element: HTMLElement): ElementPosition;
+declare function calculatePopoverPosition(targetElement: HTMLElement, popoverElement: HTMLElement, preferredPlacement?: 'top' | 'bottom' | 'left' | 'right' | 'center'): PopoverPosition;
+declare function scrollToElement(element: HTMLElement, behavior?: ScrollBehavior): void;
+declare function isElementInViewport(element: HTMLElement): boolean;
+declare function getViewportCenter(): {
+    x: number;
+    y: number;
+};
+
+export { NavigationIntegration, TabIntegration, TourActions, TourEngine, TourOverlay, TourPopover, TourProvider, TourRunner, TourStorage, WizardIntegration, calculatePopoverPosition, getElementPosition, getViewportCenter, isElementInViewport, scrollToElement, useTour, useTourEngine, useTourHighlight };
+export type { ElementPosition, HighlightConfig, Integration, PopoverConfig, PopoverPosition, TourAction, TourConfig, TourEngineEvents, TourEventCallback, TourState, TourStep, TourTheme, UseTourEngineReturn, UseTourHighlightReturn };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGvD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAG5D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAG7E,cAAc,qBAAqB,CAAC;AAGpC,YAAY,EACV,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,eAAe,EACf,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,eAAe,GAChB,MAAM,SAAS,CAAC;AAGjB,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC"}