koin.js 1.0.7 → 1.0.9

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as react from 'react';
+import react__default from 'react';
 import { Nostalgist } from 'nostalgist';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
@@ -443,6 +444,236 @@ declare function getAchievementBadgeUrl(badgeName: string, locked?: boolean): st
  */
 declare function getUserAvatarUrl(userPic: string): string;
 
+interface KoinTranslations {
+    controls: {
+        play: string;
+        pause: string;
+        reset: string;
+        rewind: string;
+        save: string;
+        load: string;
+        snap: string;
+        rec: string;
+        stopRec: string;
+        startRecord: string;
+        stopRecord: string;
+        mute: string;
+        unmute: string;
+        help: string;
+        full: string;
+        keys: string;
+        menuOpen: string;
+        menuClose: string;
+        gamepadConnected: string;
+        noGamepad: string;
+        press: string;
+        startBtn: string;
+        selectBtn: string;
+    };
+    common: {
+        disabledInHardcore: string;
+        notSupported: string;
+        playToEnableRewind: string;
+    };
+    settings: {
+        title: string;
+        general: string;
+        audio: string;
+        video: string;
+        input: string;
+        advanced: string;
+        fullscreen: string;
+        controls: string;
+        gamepad: string;
+        cheats: string;
+        retroAchievements: string;
+        shortcuts: string;
+        exit: string;
+        language: string;
+        selectLanguage: string;
+    };
+    overlay: {
+        play: string;
+        systemFirmware: string;
+        loading: string;
+        initializing: string;
+        loadingSave: string;
+        preparingSlot: string;
+        systemError: string;
+        failedInit: string;
+        retry: string;
+        slotReady: string;
+        paused: string;
+    };
+    notifications: {
+        saved: string;
+        loaded: string;
+        error: string;
+        recordingStarted: string;
+        recordingSaved: string;
+        downloaded: string;
+        loadedFile: string;
+        savedSlot: string;
+        loadedSlot: string;
+        deletedSlot: string;
+        emptySlot: string;
+        noSaveFound: string;
+        failedSave: string;
+        failedLoad: string;
+        failedDelete: string;
+        failedFetch: string;
+        controllerConnected: string;
+        controllerDisconnected: string;
+        controllerReady: string;
+        insertCoin: string;
+        insertCoinTitle: string;
+        controlsSaved: string;
+        controlsReset: string;
+    };
+    modals: {
+        shortcuts: {
+            title: string;
+            playerShortcuts: string;
+            overlays: string;
+            recording: string;
+            showHelp: string;
+            perfOverlay: string;
+            inputDisplay: string;
+            toggleRec: string;
+            toggleMute: string;
+            pressEsc: string;
+        };
+        controls: {
+            title: string;
+            keyboard: string;
+            description: string;
+            pressKey: string;
+            reset: string;
+            save: string;
+        };
+        gamepad: {
+            title: string;
+            noGamepad: string;
+            connected: string;
+            none: string;
+            player: string;
+            noController: string;
+            pressAny: string;
+            waiting: string;
+            pressButton: string;
+            pressEsc: string;
+            reset: string;
+            save: string;
+        };
+        cheats: {
+            title: string;
+            addCheat: string;
+            available: string;
+            emptyTitle: string;
+            emptyDesc: string;
+            copy: string;
+            active: string;
+            toggleHint: string;
+        };
+        saveSlots: {
+            title: string;
+            saveTitle: string;
+            loadTitle: string;
+            emptySlot: string;
+            subtitleSave: string;
+            subtitleLoad: string;
+            loading: string;
+            locked: string;
+            upgrade: string;
+            autoSave: string;
+            autoSaveDesc: string;
+            noData: string;
+            slot: string;
+            footerSave: string;
+            footerLoad: string;
+        };
+        bios: {
+            title: string;
+            description: string;
+            warningTitle: string;
+            warning: string;
+            systemDefault: string;
+            active: string;
+            defaultDesc: string;
+            emptyTitle: string;
+            emptyDesc: string;
+            footer: string;
+        };
+    };
+    retroAchievements: {
+        title: string;
+        login: string;
+        logout: string;
+        username: string;
+        password: string;
+        hardcore: string;
+        achievements: string;
+        locked: string;
+        unlocked: string;
+        mastered: string;
+        identifying: string;
+        achievementsAvailable: string;
+        gameNotSupported: string;
+        connect: string;
+        connected: string;
+        createAccount: string;
+        privacy: string;
+        privacyText: string;
+        connecting: string;
+        connectAccount: string;
+        poweredBy: string;
+        connectedStatus: string;
+        yourUsername: string;
+        yourPassword: string;
+        usernameRequired: string;
+        noGame: string;
+        loadGame: string;
+        noAchievements: string;
+        notSupported: string;
+        ptsRemaining: string;
+        filters: {
+            all: string;
+            locked: string;
+            unlocked: string;
+        };
+    };
+    overlays: {
+        performance: {
+            title: string;
+            fps: string;
+            frameTime: string;
+            memory: string;
+            core: string;
+            input: string;
+            active: string;
+        };
+        toast: {
+            saved: string;
+            loaded: string;
+            error: string;
+        };
+        recording: {
+            started: string;
+            stopped: string;
+            saved: string;
+            paused: string;
+            recording: string;
+            resume: string;
+            pause: string;
+            stop: string;
+            hover: string;
+        };
+    };
+}
+type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};
+
 interface SaveSlot {
     slot: number;
     timestamp: string;
@@ -514,6 +745,7 @@ interface GamePlayerProps {
     onRALogin?: (username: string, password: string) => Promise<boolean>;
     onRALogout?: () => void;
     onRAHardcoreChange?: (enabled: boolean) => void;
+    translations?: RecursivePartial<KoinTranslations>;
 }
 interface PlayerControlsProps {
     isPaused: boolean;
@@ -548,6 +780,7 @@ interface PlayerControlsProps {
     systemColor?: string;
     gamepadCount?: number;
     onGamepadSettings?: () => void;
+    onSettings?: () => void;
     volume?: number;
     isMuted?: boolean;
     onVolumeChange?: (volume: number) => void;
@@ -601,6 +834,7 @@ interface RAHardcodeRestrictions {
 declare const GamePlayer: react.NamedExoticComponent<GamePlayerProps & {
     controls?: KeyboardMapping;
     saveControls?: (controls: KeyboardMapping) => void;
+    initialLanguage?: "en" | "es" | "fr";
 }>;
 
 /**
@@ -862,4 +1096,17 @@ declare function useGameRecording({ getCanvasElement, }: UseGameRecordingProps):
 declare function getCachedRom(romId: string): Promise<Blob | null>;
 declare function fetchAndCacheRom(romId: string, url: string): Promise<Blob>;
 
-export { ALL_BUTTONS, AchievementPopup, BUTTON_GROUPS, BUTTON_LABELS, type ButtonId, CONSOLE_CAPABILITIES, CONSOLE_KEYBOARD_OVERRIDES, type Cheat, type CheatModalProps, type ConsoleCapabilities, type ControlConfig, type ControlMapperProps, type ControlMapping, type ControllerBrand, DEFAULT_CONTROLS, DEFAULT_GAMEPAD, DEFAULT_KEYBOARD, DPAD_BUTTONS, type EmulatorStatus, FACE_BUTTONS, GamePlayer, type GamePlayerProps, type GamepadInfo, type GamepadMapping, type KeyboardMapping, PERFORMANCE_TIER_1_SYSTEMS, PERFORMANCE_TIER_2_SYSTEMS, type PlayerControlsProps, type PlayerIndex, type RAAchievement, type RACredentials, type RAGame, type RAGameExtended, type RAHardcodeRestrictions, RASidebar, type RAUser, RA_MEDIA_BASE, type RetroAchievementsConfig, SHADER_PRESETS, SHOULDER_BUTTONS, STANDARD_AXIS_MAP, STANDARD_GAMEPAD_BUTTONS, STICK_BUTTONS, SUPPORTED_EXTENSIONS, SYSTEMS, SYSTEM_BUTTONS, type SaveSlot, type SaveSlotModalProps, type ShaderPresetId, ShaderSelector, ShortcutsReference, type ShowToastOptions, type SpeedMultiplier, type StandardAxis, type SystemConfig, TRIGGER_BUTTONS, type Toast, ToastContainer, type ToastType, type UseGamepadOptions, type UseGamepadReturn, type UseNostalgistReturn, type UseToastReturn, buildRetroArchConfig, clearAllControls, consoleHasButton, detectControllerBrand, detectSystem, fetchAndCacheRom, formatGamepadButton, formatKeyCode, gamepadToRetroArchConfig, getAchievementBadgeUrl, getCachedRom, getConsoleButtons, getConsoleCapabilities, getConsoleKeyboardDefaults, getCore, getDBSystemNames, getFullGamepadMapping, getFullKeyboardMapping, getSupportedExtensions, getSystem, getSystemByDbName, getSystemByKey, getSystemFromExtension, getSystemsList, getUserAvatarUrl, isSystemSupported, keyboardToRetroArchConfig, loadAllGamepadMappings, loadGamepadMapping, loadKeyboardMapping, normalizeSystemKey, saveGamepadMapping, saveKeyboardMapping, systemsMatch, useGameRecording, useGamepad, useNostalgist, useToast };
+declare const en: KoinTranslations;
+
+declare const es: KoinTranslations;
+
+declare const fr: KoinTranslations;
+
+interface KoinI18nProviderProps {
+    children: react__default.ReactNode;
+    translations?: RecursivePartial<KoinTranslations>;
+}
+declare const KoinI18nProvider: react__default.FC<KoinI18nProviderProps>;
+declare function useKoinTranslation(): KoinTranslations;
+
+export { ALL_BUTTONS, AchievementPopup, BUTTON_GROUPS, BUTTON_LABELS, type ButtonId, CONSOLE_CAPABILITIES, CONSOLE_KEYBOARD_OVERRIDES, type Cheat, type CheatModalProps, type ConsoleCapabilities, type ControlConfig, type ControlMapperProps, type ControlMapping, type ControllerBrand, DEFAULT_CONTROLS, DEFAULT_GAMEPAD, DEFAULT_KEYBOARD, DPAD_BUTTONS, type EmulatorStatus, FACE_BUTTONS, GamePlayer, type GamePlayerProps, type GamepadInfo, type GamepadMapping, type KeyboardMapping, KoinI18nProvider, type KoinTranslations, PERFORMANCE_TIER_1_SYSTEMS, PERFORMANCE_TIER_2_SYSTEMS, type PlayerControlsProps, type PlayerIndex, type RAAchievement, type RACredentials, type RAGame, type RAGameExtended, type RAHardcodeRestrictions, RASidebar, type RAUser, RA_MEDIA_BASE, type RecursivePartial, type RetroAchievementsConfig, SHADER_PRESETS, SHOULDER_BUTTONS, STANDARD_AXIS_MAP, STANDARD_GAMEPAD_BUTTONS, STICK_BUTTONS, SUPPORTED_EXTENSIONS, SYSTEMS, SYSTEM_BUTTONS, type SaveSlot, type SaveSlotModalProps, type ShaderPresetId, ShaderSelector, ShortcutsReference, type ShowToastOptions, type SpeedMultiplier, type StandardAxis, type SystemConfig, TRIGGER_BUTTONS, type Toast, ToastContainer, type ToastType, type UseGamepadOptions, type UseGamepadReturn, type UseNostalgistReturn, type UseToastReturn, buildRetroArchConfig, clearAllControls, consoleHasButton, detectControllerBrand, detectSystem, en, es, fetchAndCacheRom, formatGamepadButton, formatKeyCode, fr, gamepadToRetroArchConfig, getAchievementBadgeUrl, getCachedRom, getConsoleButtons, getConsoleCapabilities, getConsoleKeyboardDefaults, getCore, getDBSystemNames, getFullGamepadMapping, getFullKeyboardMapping, getSupportedExtensions, getSystem, getSystemByDbName, getSystemByKey, getSystemFromExtension, getSystemsList, getUserAvatarUrl, isSystemSupported, keyboardToRetroArchConfig, loadAllGamepadMappings, loadGamepadMapping, loadKeyboardMapping, normalizeSystemKey, saveGamepadMapping, saveKeyboardMapping, systemsMatch, useGameRecording, useGamepad, useKoinTranslation, useNostalgist, useToast };