react-achievements 2.2.2 → 3.0.1

package/dist/index.d.ts

@@ -1,8 +1,222 @@
-import { AchievementProvider, useAchievementContext as useAchievement } from './providers/AchievementProvider';
-import type { AchievementMetrics, AchievementConfiguration, AchievementDetails, AchievementUnlockCondition, AchievementMetricValue, InitialAchievementMetrics } from './types';
-import ConfettiWrapper from './components/ConfettiWrapper';
-import achievementReducer from './redux/achievementSlice';
-import notificationReducer from './redux/notificationSlice';
-import { useAchievementState } from './hooks/useAchievementState';
-export { AchievementProvider, useAchievement, ConfettiWrapper, achievementReducer, notificationReducer, useAchievementState, };
-export type { AchievementMetrics, AchievementConfiguration, AchievementDetails, AchievementUnlockCondition, AchievementMetricValue, InitialAchievementMetrics, };
+import React$1 from 'react';
+
+type AchievementMetricValue = number | string | boolean | Date | null | undefined;
+type AchievementMetricArrayValue = AchievementMetricValue | AchievementMetricValue[];
+interface AchievementMetrics {
+    [key: string]: AchievementMetricValue[];
+}
+interface AchievementDetails {
+    achievementId: string;
+    achievementTitle: string;
+    achievementDescription: string;
+    achievementIconKey?: string;
+}
+interface AchievementCondition {
+    isConditionMet: (value: AchievementMetricArrayValue, state: AchievementState) => boolean;
+    achievementDetails: {
+        achievementId: string;
+        achievementTitle: string;
+        achievementDescription: string;
+        achievementIconKey: string;
+    };
+}
+interface AchievementConfiguration {
+    [key: string]: AchievementCondition[];
+}
+interface InitialAchievementMetrics {
+    [key: string]: AchievementMetricValue;
+}
+interface AchievementState {
+    metrics: AchievementMetrics;
+    unlockedAchievements: string[];
+}
+interface AchievementStorage {
+    getMetrics(): AchievementMetrics;
+    setMetrics(metrics: AchievementMetrics): void;
+    getUnlockedAchievements(): string[];
+    setUnlockedAchievements(achievements: string[]): void;
+    clear(): void;
+}
+interface AchievementContextValue {
+    updateMetrics: (metrics: AchievementMetrics | ((prev: AchievementMetrics) => AchievementMetrics)) => void;
+    unlockedAchievements: string[];
+    resetStorage: () => void;
+}
+interface StylesProps {
+    badgesButton?: React.CSSProperties;
+    badgesModal?: {
+        overlay?: React.CSSProperties;
+        content?: React.CSSProperties;
+        header?: React.CSSProperties;
+        closeButton?: React.CSSProperties;
+        achievementList?: React.CSSProperties;
+        achievementItem?: React.CSSProperties;
+        achievementTitle?: React.CSSProperties;
+        achievementDescription?: React.CSSProperties;
+        achievementIcon?: React.CSSProperties;
+    };
+}
+interface AchievementProviderProps$1 {
+    children: React.ReactNode;
+    config: AchievementConfiguration;
+    initialState?: InitialAchievementMetrics & {
+        previouslyAwardedAchievements?: string[];
+    };
+    storageKey?: string;
+    badgesButtonPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+    styles?: Partial<StylesProps>;
+    icons?: Record<string, string>;
+    storage?: AchievementStorage;
+    onAchievementUnlocked?: (achievement: AchievementDetails) => void;
+}
+declare enum StorageType {
+    Local = "local",
+    Memory = "memory"
+}
+
+declare class LocalStorage implements AchievementStorage {
+    private storageKey;
+    constructor(storageKey: string);
+    private serializeValue;
+    private deserializeValue;
+    private serializeMetrics;
+    private deserializeMetrics;
+    private getStorageData;
+    private setStorageData;
+    getMetrics(): AchievementMetrics;
+    setMetrics(metrics: AchievementMetrics): void;
+    getUnlockedAchievements(): string[];
+    setUnlockedAchievements(achievements: string[]): void;
+    clear(): void;
+}
+
+interface BadgesButtonProps {
+    onClick: () => void;
+    position: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+    styles?: React$1.CSSProperties;
+    unlockedAchievements: AchievementDetails[];
+}
+declare const BadgesButton: React$1.FC<BadgesButtonProps>;
+
+interface BadgesModalProps {
+    isOpen: boolean;
+    onClose: () => void;
+    achievements: AchievementDetails[];
+    styles?: StylesProps['badgesModal'];
+    icons?: Record<string, string>;
+}
+declare const BadgesModal: React$1.FC<BadgesModalProps>;
+
+interface ConfettiWrapperProps {
+    show: boolean;
+}
+declare const ConfettiWrapper: React$1.FC<ConfettiWrapperProps>;
+
+interface AchievementContextType {
+    update: (metrics: Record<string, any>) => void;
+    achievements: {
+        unlocked: string[];
+        all: Record<string, any>;
+    };
+    reset: () => void;
+    getState: () => {
+        metrics: AchievementMetrics;
+        unlocked: string[];
+    };
+}
+declare const AchievementContext: React$1.Context<AchievementContextType | undefined>;
+interface AchievementProviderProps {
+    achievements: AchievementConfiguration;
+    storage?: AchievementStorage | StorageType;
+    children: React$1.ReactNode;
+    icons?: Record<string, string>;
+}
+declare const AchievementProvider: React$1.FC<AchievementProviderProps>;
+
+declare const useAchievements: () => AchievementContextType;
+
+declare const defaultStyles: Required<StylesProps>;
+
+declare const defaultAchievementIcons: {
+    levelUp: string;
+    questComplete: string;
+    monsterDefeated: string;
+    itemCollected: string;
+    challengeCompleted: string;
+    milestoneReached: string;
+    firstStep: string;
+    newBeginnings: string;
+    breakthrough: string;
+    growth: string;
+    shared: string;
+    liked: string;
+    commented: string;
+    followed: string;
+    invited: string;
+    communityMember: string;
+    supporter: string;
+    connected: string;
+    participant: string;
+    influencer: string;
+    activeDay: string;
+    activeWeek: string;
+    activeMonth: string;
+    earlyBird: string;
+    nightOwl: string;
+    streak: string;
+    dedicated: string;
+    punctual: string;
+    consistent: string;
+    marathon: string;
+    artist: string;
+    writer: string;
+    innovator: string;
+    creator: string;
+    expert: string;
+    master: string;
+    pioneer: string;
+    performer: string;
+    thinker: string;
+    explorer: string;
+    bronze: string;
+    silver: string;
+    gold: string;
+    diamond: string;
+    legendary: string;
+    epic: string;
+    rare: string;
+    common: string;
+    special: string;
+    hidden: string;
+    one: string;
+    ten: string;
+    hundred: string;
+    thousand: string;
+    clicked: string;
+    used: string;
+    found: string;
+    built: string;
+    solved: string;
+    discovered: string;
+    unlocked: string;
+    upgraded: string;
+    repaired: string;
+    defended: string;
+    default: string;
+    loading: string;
+    error: string;
+    success: string;
+    failure: string;
+    trophy: string;
+    star: string;
+    flag: string;
+    puzzle: string;
+    gem: string;
+    crown: string;
+    medal: string;
+    ribbon: string;
+    badge: string;
+    shield: string;
+};
+
+export { AchievementCondition, AchievementConfiguration, AchievementContext, AchievementContextValue, AchievementDetails, AchievementMetricArrayValue, AchievementMetricValue, AchievementMetrics, AchievementProvider, AchievementProviderProps$1 as AchievementProviderProps, AchievementState, AchievementStorage, BadgesButton, BadgesModal, ConfettiWrapper, InitialAchievementMetrics, LocalStorage, StorageType, StylesProps, defaultAchievementIcons, defaultStyles, useAchievements };