@umituz/react-native-settings 5.3.36 → 5.3.38

package/dist/presentation/screens/types/SettingsConfig.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Main Settings Configuration Type
+ * Combines all feature configurations
+ */
+import type { FeatureVisibility } from "./BaseTypes";
+import type { AppearanceConfig, LanguageConfig, NotificationsConfig, AboutConfig, LegalConfig, DisclaimerConfig } from "./ContentConfig";
+import type { UserProfileConfig, FeedbackConfig, RatingConfig, FAQConfig, CloudSyncConfig, SubscriptionConfig, WalletConfig, GamificationItemConfig, VideoTutorialConfig } from "./UserFeatureConfig";
+import type { SettingsTranslations } from "./SettingsTranslations";
+/**
+ * Main Settings Configuration
+ *
+ * Controls which settings features are visible in the SettingsScreen.
+ * Each feature can be configured with:
+ * - Simple: boolean | 'auto' (quick setup)
+ * - Advanced: Detailed config object (full control)
+ *
+ * @example
+ * // Simple configuration
+ * const config: SettingsConfig = {
+ *   appearance: true,
+ *   notifications: 'auto',
+ *   about: false,
+ * };
+ *
+ * @example
+ * // Advanced configuration
+ * const config: SettingsConfig = {
+ *   appearance: {
+ *     enabled: true,
+ *     route: 'CustomAppearance',
+ *     showTheme: true,
+ *   },
+ *   notifications: {
+ *     enabled: 'auto',
+ *     showToggle: true,
+ *     initialValue: false,
+ *   },
+ * };
+ */
+export interface SettingsConfig {
+    /**
+     * Application-wide translations
+     */
+    translations?: SettingsTranslations;
+    /**
+     * Appearance settings (Theme customization)
+     * @default 'auto'
+     */
+    appearance?: FeatureVisibility | AppearanceConfig;
+    /**
+     * Language settings
+     * @default 'auto'
+     */
+    language?: FeatureVisibility | LanguageConfig;
+    /**
+     * Notifications settings
+     * @default 'auto'
+     */
+    notifications?: FeatureVisibility | NotificationsConfig;
+    /**
+     * About settings
+     * @default 'auto'
+     */
+    about?: FeatureVisibility | AboutConfig;
+    /**
+     * Legal settings (Terms, Privacy Policy)
+     * @default 'auto'
+     */
+    legal?: FeatureVisibility | LegalConfig;
+    /**
+     * Disclaimer settings (Important notices)
+     * @default false
+     */
+    disclaimer?: FeatureVisibility | DisclaimerConfig;
+    /**
+     * User profile header settings
+     * @default false
+     */
+    userProfile?: boolean | UserProfileConfig;
+    /**
+     * Feedback settings
+     * @default 'auto'
+     */
+    feedback?: FeatureVisibility | FeedbackConfig;
+    /**
+     * Rating settings configuration
+     */
+    rating?: FeatureVisibility | RatingConfig;
+    /**
+     * FAQ settings configuration
+     */
+    faqs?: FeatureVisibility | FAQConfig;
+    /**
+     * Cloud sync settings configuration
+     * @default false
+     */
+    cloudSync?: FeatureVisibility | CloudSyncConfig;
+    /**
+     * Subscription settings configuration
+     * @default false
+     */
+    subscription?: FeatureVisibility | SubscriptionConfig;
+    /**
+     * Wallet settings configuration
+     * @default false
+     */
+    wallet?: FeatureVisibility | WalletConfig;
+    /**
+     * Gamification settings configuration
+     * @default 'auto'
+     */
+    gamification?: FeatureVisibility | GamificationItemConfig;
+    /**
+     * Video tutorial settings configuration
+     * @default 'auto'
+     */
+    videoTutorial?: FeatureVisibility | VideoTutorialConfig;
+    /**
+     * Custom empty state text when no settings are available
+     */
+    emptyStateText?: string;
+}

package/dist/presentation/screens/types/SettingsTranslations.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Settings Translations Type
+ * Defines all translation keys for the settings package
+ */
+/**
+ * Global Settings Translations
+ */
+export interface SettingsTranslations {
+    title?: string;
+    profile?: {
+        anonymousName?: string;
+        signIn?: string;
+        signInDescription?: string;
+        anonymousBenefits?: {
+            title?: string;
+            items?: string[];
+        };
+    };
+    account?: {
+        editProfile?: string;
+        logout?: string;
+        deleteAccount?: string;
+        logoutConfirmTitle?: string;
+        logoutConfirmMessage?: string;
+        deleteConfirmTitle?: string;
+        deleteConfirmMessage?: string;
+        deleteAccountTitle?: string;
+        deleteAccountMessage?: string;
+        deleteErrorTitle?: string;
+        deleteErrorMessage?: string;
+        cancel?: string;
+        delete?: string;
+    };
+    sections?: {
+        app?: string;
+        progress?: string;
+        about?: string;
+        support?: string;
+        subscription?: string;
+    };
+    features?: {
+        appearance?: {
+            title?: string;
+            description?: string;
+            themeModes?: {
+                light?: string;
+                dark?: string;
+                auto?: string;
+            };
+        };
+        language?: {
+            title?: string;
+            description?: string;
+            searchPlaceholder?: string;
+        };
+        notifications?: {
+            title?: string;
+            description?: string;
+            masterToggleTitle?: string;
+            masterToggleDescription?: string;
+            soundTitle?: string;
+            soundDescription?: string;
+            vibrationTitle?: string;
+            vibrationDescription?: string;
+            remindersTitle?: string;
+            remindersDescription?: string;
+            quietHoursTitle?: string;
+            quietHoursDescription?: string;
+            quietHours?: {
+                title?: string;
+                description?: string;
+                startTimeLabel?: string;
+                endTimeLabel?: string;
+                enabledLabel?: string;
+            };
+        };
+        about?: {
+            title?: string;
+            description?: string;
+            contact?: string;
+            more?: string;
+            developer?: string;
+            email?: string;
+            website?: string;
+            moreApps?: string;
+            versionPrefix?: string;
+        };
+        legal?: {
+            title?: string;
+            description?: string;
+            documentsHeader?: string;
+            privacyTitle?: string;
+            privacyDescription?: string;
+            termsTitle?: string;
+            termsDescription?: string;
+            eulaTitle?: string;
+            eulaDescription?: string;
+        };
+        feedback?: {
+            title?: string;
+            description?: string;
+        };
+        rating?: {
+            title?: string;
+            description?: string;
+        };
+        faqs?: {
+            title?: string;
+            description?: string;
+            searchPlaceholder?: string;
+            emptySearchTitle?: string;
+            emptySearchMessage?: string;
+            headerTitle?: string;
+        };
+        languageSelection?: {
+            searchPlaceholder?: string;
+        };
+        subscription?: {
+            title?: string;
+            description?: string;
+        };
+        videoTutorial?: {
+            title?: string;
+            description?: string;
+        };
+        gamification?: {
+            title?: string;
+            description?: string;
+        };
+    };
+    feedbackModal?: {
+        title?: string;
+        ratingLabel?: string;
+        descriptionPlaceholder?: string;
+        submitButton?: string;
+        submittingButton?: string;
+        types?: {
+            general?: string;
+            bugReport?: string;
+            featureRequest?: string;
+            improvement?: string;
+            other?: string;
+        };
+    };
+    noOptionsAvailable?: string;
+    footer?: {
+        version?: string;
+    };
+    errors?: {
+        common?: string;
+        unknown?: string;
+        unknownError?: string;
+        appStoreUrlMissing?: string;
+        appStoreUrlNotConfigured?: string;
+        unableToOpenAppStore?: string;
+        failedToOpenAppStore?: string;
+        deleteAccountError?: string;
+    };
+}

package/dist/presentation/screens/types/UserFeatureConfig.d.ts

@@ -0,0 +1,178 @@
+/**
+ * User Feature Configuration Types
+ * Types for user-related features (Profile, Feedback, FAQ, etc.)
+ */
+import type { FeatureVisibility } from "./BaseTypes";
+import type { FeedbackType } from "../../../domains/feedback/domain/entities/FeedbackEntity";
+import type { FAQCategory } from "../../../domains/faqs/domain/entities/FAQEntity";
+import type { SettingsStackParamList } from "../../navigation/types";
+/**
+ * User Profile Settings Configuration
+ */
+export interface UserProfileConfig {
+    /** Show user profile header */
+    enabled?: boolean;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Custom display name for anonymous users */
+    anonymousDisplayName?: string;
+    /** Custom avatar service URL */
+    avatarServiceUrl?: string;
+    /** Navigation route for account settings (shows chevron if set) */
+    accountSettingsRoute?: string;
+}
+/**
+ * Feedback Settings Configuration
+ */
+export interface FeedbackConfig {
+    /** Enable feedback feature */
+    enabled?: FeatureVisibility;
+    /** Custom title for the feedback section */
+    title?: string;
+    /** Custom label for the feedback item */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Initial feedback type */
+    initialType?: FeedbackType;
+    /** Feedback submission handler */
+    onSubmit?: (data: {
+        type: FeedbackType;
+        rating: number;
+        description: string;
+        title: string;
+    }) => Promise<void>;
+    /** Custom handler to open feedback screen (overrides default modal) */
+    onPress?: () => void;
+}
+/**
+ * FAQ Settings Configuration
+ */
+export interface FAQConfig {
+    /** Enable FAQ feature */
+    enabled?: FeatureVisibility;
+    /** Custom title for the FAQ section */
+    title?: string;
+    /** Custom label for the FAQ button */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** FAQ items passed from app */
+    items?: FAQCategory[];
+    /** Handler to open FAQ screen */
+    onPress?: () => void;
+}
+/**
+ * Rating Settings Configuration
+ */
+export interface RatingConfig {
+    /** Enable rating feature */
+    enabled?: FeatureVisibility;
+    /** Custom title for the rating section */
+    title?: string;
+    /** Custom label for the rate app button */
+    description?: string;
+    /** Store URL for direct linking (optional) */
+    storeUrl?: string;
+    /** Custom handler for rating action (e.g. open store review) */
+    onRate?: () => void;
+}
+/**
+ * Cloud Sync Settings Configuration
+ */
+export interface CloudSyncConfig {
+    /** Enable cloud sync feature */
+    enabled?: FeatureVisibility;
+    /** Custom title for the sync section */
+    title?: string;
+    /** Custom description for the sync toggle */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Firestore collection name */
+    collectionName?: string;
+}
+/**
+ * Subscription Settings Configuration
+ */
+export interface SubscriptionConfig {
+    /** Show subscription section */
+    enabled?: FeatureVisibility;
+    /** Custom title for the subscription section */
+    title?: string;
+    /** Custom label for the subscription item */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Navigation route for subscription screen (preferred over onPress) */
+    route?: keyof SettingsStackParamList;
+    /** Handler to open subscription screen (use route instead for stack navigation) */
+    onPress?: () => void;
+    /** Whether user is premium (to show active status) */
+    isPremium?: boolean;
+}
+/**
+ * Wallet Settings Configuration
+ */
+export interface WalletConfig {
+    /** Show wallet section */
+    enabled?: FeatureVisibility;
+    /** Custom title for the wallet section */
+    title?: string;
+    /** Custom label for the wallet item */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Navigation route for wallet screen */
+    route?: keyof SettingsStackParamList;
+    /** Current balance to display */
+    balance?: number;
+}
+/**
+ * Gamification Settings Item Configuration
+ */
+export interface GamificationItemConfig {
+    /** Show gamification section */
+    enabled?: FeatureVisibility;
+    /** Custom title for the gamification section */
+    title?: string;
+    /** Custom label for the gamification item */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Navigation route for gamification screen */
+    route?: keyof SettingsStackParamList;
+    /** Achievements to display */
+    achievementsCount?: number;
+}
+/**
+ * Video Tutorial Settings Configuration
+ */
+export interface VideoTutorialConfig {
+    /** Enable video tutorial feature */
+    enabled?: FeatureVisibility;
+    /** Custom title for the video tutorial section */
+    title?: string;
+    /** Custom label for the video tutorial item */
+    description?: string;
+    /** Custom icon name (Ionicons) */
+    icon?: string;
+    /** Custom section title for grouping */
+    sectionTitle?: string;
+    /** Handler to open video tutorial screen */
+    onPress?: () => void;
+    /** Navigation route for video tutorial screen */
+    route?: keyof SettingsStackParamList;
+}

package/dist/presentation/screens/types/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Settings Types - Public API
+ * Exports all settings-related types
+ */
+export type { FeatureVisibility } from "./BaseTypes";
+export type { AboutConfig, LegalConfig, DisclaimerConfig, AppearanceConfig, LanguageConfig, NotificationsConfig, } from "./ContentConfig";
+export type { UserProfileConfig, FeedbackConfig, FAQConfig, RatingConfig, CloudSyncConfig, SubscriptionConfig, WalletConfig, GamificationItemConfig, VideoTutorialConfig, } from "./UserFeatureConfig";
+export type { GamificationSettingsConfig as GamificationConfig } from "../../../domains/gamification";
+export type { SettingsConfig } from "./SettingsConfig";
+export type { SettingsTranslations } from "./SettingsTranslations";
+export type { CustomSettingsSection } from "./CustomSection";

package/dist/presentation/screens/utils/normalizeConfig.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Config Normalization Utilities
+ * Single Responsibility: Normalize config values to consistent format
+ */
+import type { AppearanceConfig, LanguageConfig, NotificationsConfig, AboutConfig, LegalConfig, DisclaimerConfig, UserProfileConfig, FeedbackConfig, RatingConfig, FAQConfig, SubscriptionConfig, WalletConfig, GamificationItemConfig, VideoTutorialConfig, SettingsConfig } from "../types";
+export interface NormalizedConfig {
+    appearance: {
+        enabled: boolean;
+        config?: AppearanceConfig;
+    };
+    language: {
+        enabled: boolean;
+        config?: LanguageConfig;
+    };
+    notifications: {
+        enabled: boolean;
+        config?: NotificationsConfig;
+    };
+    about: {
+        enabled: boolean;
+        config?: AboutConfig;
+    };
+    legal: {
+        enabled: boolean;
+        config?: LegalConfig;
+    };
+    disclaimer: {
+        enabled: boolean;
+        config?: DisclaimerConfig;
+    };
+    userProfile: {
+        enabled: boolean;
+        config?: UserProfileConfig;
+    };
+    feedback: {
+        enabled: boolean;
+        config?: FeedbackConfig;
+    };
+    rating: {
+        enabled: boolean;
+        config?: RatingConfig;
+    };
+    faqs: {
+        enabled: boolean;
+        config?: FAQConfig;
+    };
+    subscription: {
+        enabled: boolean;
+        config?: SubscriptionConfig;
+    };
+    wallet: {
+        enabled: boolean;
+        config?: WalletConfig;
+    };
+    gamification: {
+        enabled: boolean;
+        config?: GamificationItemConfig;
+    };
+    videoTutorial: {
+        enabled: boolean;
+        config?: VideoTutorialConfig;
+    };
+    translations?: import("../types").SettingsTranslations;
+}
+/**
+ * Normalize entire SettingsConfig to consistent format
+ */
+export declare function normalizeSettingsConfig(config: SettingsConfig | undefined): NormalizedConfig;

package/dist/presentation/utils/accountConfigUtils.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Account Configuration Utilities
+ *
+ * Helper functions for creating account screen configurations.
+ */
+import type { AccountConfig } from "../navigation/types";
+export interface AccountTranslations {
+    editProfile?: string;
+    logout: string;
+    deleteAccount: string;
+    logoutConfirmTitle: string;
+    logoutConfirmMessage: string;
+    deleteConfirmTitle: string;
+    deleteConfirmMessage: string;
+    deleteErrorTitle?: string;
+    deleteErrorMessage?: string;
+    cancel: string;
+}
+export interface CreateAccountConfigParams {
+    displayName?: string;
+    userId?: string;
+    photoURL?: string;
+    isAnonymous?: boolean;
+    avatarUrl?: string;
+    onSignIn: () => void;
+    onLogout: () => Promise<void>;
+    onDeleteAccount: () => Promise<void>;
+    translations?: AccountTranslations;
+    PasswordPromptComponent?: React.ReactNode;
+}
+/**
+ * Create account screen configuration
+ */
+export declare function createAccountConfig(params: CreateAccountConfigParams): AccountConfig;

package/dist/presentation/utils/config-creators/base-configs.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Base Settings Config Creators
+ * Standard settings: appearance, language, notifications, about, legal
+ * Refactored to use configFactory pattern for consistency
+ */
+import type { AppearanceConfig, LanguageConfig, NotificationsConfig, AboutConfig, LegalConfig } from "../../screens/types";
+/**
+ * Create appearance configuration
+ */
+export declare const createAppearanceConfig: (routeOrOnPress?: string | (() => void)) => AppearanceConfig;
+/**
+ * Create language configuration
+ */
+export declare const createLanguageConfig: (routeOrOnPress?: string | (() => void)) => LanguageConfig;
+/**
+ * Create notifications configuration
+ */
+export declare const createNotificationsConfig: (routeOrOnPress?: string | (() => void)) => NotificationsConfig;
+/**
+ * Create about configuration
+ */
+export declare const createAboutConfig: (routeOrOnPress?: string | (() => void)) => AboutConfig;
+/**
+ * Create legal configuration
+ */
+export declare const createLegalConfig: (routeOrOnPress?: string | (() => void)) => LegalConfig;

package/dist/presentation/utils/config-creators/feature-configs.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Feature Settings Config Creators
+ * Subscription, gamification
+ */
+import type { SubscriptionConfig } from "../../screens/types";
+import type { GamificationConfig, AchievementDefinition, LevelDefinition } from "../../../domains/gamification/types";
+import type { SettingsStackParamList } from "../../navigation/types";
+/**
+ * Create subscription configuration
+ * @param route - Navigation route name (preferred for stack navigation)
+ * @param onPress - Callback function (use route instead when possible)
+ */
+export declare const createSubscriptionConfig: (isPremium: boolean, routeOrOnPress: keyof SettingsStackParamList | (() => void)) => SubscriptionConfig;
+/**
+ * Create gamification configuration
+ */
+export declare const createGamificationConfig: (storageKey: string, achievements: AchievementDefinition[], levels: LevelDefinition[], enabled?: boolean) => GamificationConfig;

package/dist/presentation/utils/config-creators/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Config Creators - Barrel export
+ */
+export type { TranslationFunction, FeedbackFormData } from "./types";
+export { createAppearanceConfig, createLanguageConfig, createNotificationsConfig, createAboutConfig, createLegalConfig, } from "./base-configs";
+export { createFeedbackConfig, createRatingConfig, createFAQConfig, } from "./support-configs";
+export { createSubscriptionConfig, createGamificationConfig, } from "./feature-configs";

package/dist/presentation/utils/config-creators/support-configs.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Support Settings Config Creators
+ * Feedback, rating, FAQ
+ */
+import type { FeedbackConfig, RatingConfig, FAQConfig } from "../../screens/types";
+import type { FeedbackFormData } from "./types";
+/**
+ * Create feedback configuration
+ */
+export declare const createFeedbackConfig: (onSubmit: (data: FeedbackFormData) => Promise<void>) => FeedbackConfig;
+/**
+ * Create rating configuration
+ */
+export declare const createRatingConfig: (onRate: () => void, storeUrl?: string) => RatingConfig;
+/**
+ * Create FAQ configuration
+ * Navigation is handled internally by the package - no callback needed
+ */
+export declare const createFAQConfig: () => FAQConfig;

package/dist/presentation/utils/config-creators/types.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Config Creator Types
+ */
+/**
+ * Translation options for i18n parameters
+ */
+export type TranslationOptions = Record<string, string | number | boolean>;
+/**
+ * Translation function type
+ */
+export type TranslationFunction = (key: string, options?: TranslationOptions) => string;
+/**
+ * Feedback form data interface
+ */
+export interface FeedbackFormData {
+    type: string;
+    rating: number;
+    description: string;
+    title: string;
+}

package/dist/presentation/utils/faqTranslator.d.ts

@@ -0,0 +1,3 @@
+import type { FAQData } from "../navigation/types";
+import type { AppInfo } from "../navigation/types";
+export declare const translateFAQData: (faqData: FAQData | undefined, _appInfo: AppInfo) => FAQData | undefined;

package/dist/presentation/utils/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Presentation Utilities
+ */
+export * from "./config-creators";
+export * from "./userProfileUtils";
+export * from "./accountConfigUtils";
+export * from "./faqTranslator";
+export * from "./settingsConfigFactory";