loading-games 1.0.1 → 2.0.0

package/dist/vue/index.d.ts

@@ -1,7 +1,135 @@
 import * as vue from 'vue';
 import { Ref } from 'vue';
-import { GameName, GameSize, ExitAnimation, ThemeObject, Score, GameResult } from '../../types.js';
-export { ExitAnimation, GameName, GameResult, GameSize, LoadingGameOptions, Score, ThemeObject } from '../../types.js';
+
+/**
+ * loading-games — TypeScript Types
+ *
+ * This file is the single source of truth for all types.
+ * Re-export from here in all packages.
+ */
+/** All built-in game identifiers. 'random' selects a different game each time. */
+type GameName = 'snake' | 'brick-breaker' | 'flappy' | '2048' | 'wordle-lite' | 'asteroids' | 'memory-cards' | 'whack-a-mole' | 'random';
+/** Size presets. 'full' creates a full-viewport overlay. */
+type GameSize = 'sm' | 'md' | 'lg' | 'full';
+/** Animation played when loading completes and the game exits. */
+type ExitAnimation = 'fade' | 'slide' | 'none';
+/**
+ * Theme color tokens.
+ * All fields optional — unset values fall back to CSS variables or system defaults.
+ *
+ * @example
+ * { primary: '#6366F1', background: '#0F0F0F' }
+ */
+interface ThemeObject {
+    /** Main accent color — buttons, score, active game elements */
+    primary?: string;
+    /** Canvas / component background */
+    background?: string;
+    /** Card and panel surfaces */
+    surface?: string;
+    /** Primary text (labels, scores, UI) */
+    text?: string;
+    /** Secondary highlight / accent */
+    accent?: string;
+}
+/** Fired on every score change via onScore callback. */
+interface Score {
+    game: Exclude<GameName, 'random'>;
+    /** Current score in this session */
+    current: number;
+    /** All-time personal best (from localStorage) */
+    personalBest: number;
+    /** true if current just exceeded the previous personal best */
+    isNewRecord: boolean;
+}
+/** Fired when a game round ends (not when loading ends). */
+interface GameResult {
+    game: Exclude<GameName, 'random'>;
+    finalScore: number;
+    /** How long the game was active in milliseconds */
+    duration: number;
+    isNewRecord: boolean;
+}
+/**
+ * Complete configuration for a LoadingGame instance.
+ * All fields optional — sensible defaults apply.
+ *
+ * @example
+ * {
+ *   game: 'snake',
+ *   active: isLoading,
+ *   theme: { primary: '#6366F1', background: '#0F0F0F' },
+ *   onScore: (s) => console.log(s),
+ * }
+ */
+interface LoadingGameOptions {
+    /**
+     * Which game to render.
+     * 'random' selects a different game each activation.
+     * @default 'random'
+     */
+    game?: GameName;
+    /**
+     * Controls whether the game is shown.
+     * Set to true when loading begins, false when it ends.
+     * @default false
+     */
+    active?: boolean;
+    /**
+     * Theme color overrides.
+     * Merged with CSS variables and system color scheme.
+     */
+    theme?: ThemeObject;
+    /**
+     * Container size preset.
+     * 'full' renders a full-viewport overlay.
+     * @default 'md'
+     */
+    size?: GameSize;
+    /**
+     * Milliseconds to wait before showing the game.
+     * Prevents a jarring flash for fast loads.
+     * If loading completes before delay, game never renders.
+     * @default 800
+     */
+    delay?: number;
+    /**
+     * Minimum milliseconds to show the game once it appears.
+     * Prevents a confusing half-second flash.
+     * @default 0
+     */
+    minDisplay?: number;
+    /**
+     * Animation when the game exits after loading completes.
+     * @default 'fade'
+     */
+    exitAnimation?: ExitAnimation;
+    /**
+     * Persist personal bests in localStorage.
+     * @default true
+     */
+    saveScores?: boolean;
+    /**
+     * Namespace for score storage.
+     * Allows multiple instances to maintain separate leaderboards.
+     * @default undefined (global namespace)
+     */
+    namespace?: string;
+    /** Fires every time the score changes. */
+    onScore?: (score: Score) => void;
+    /** Fires when a game round ends (game over, not loading end). */
+    onGameOver?: (result: GameResult) => void;
+    /**
+     * Fires when loading completes and the game has fully exited.
+     * Use this to trigger post-load UI updates.
+     */
+    onComplete?: () => void;
+    /**
+     * Fires when loading fails.
+     * The game exits immediately, without animation.
+     */
+    onError?: (err: Error) => void;
+}
 
 /**
  * useLoadingGame — Vue 3 composable for programmatic control
@@ -154,4 +282,4 @@ declare const LoadingGame: vue.DefineComponent<vue.ExtractPropTypes<{
     namespace: string;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
-export { LoadingGame, type UseLoadingGameOptions, type UseLoadingGameReturn, LoadingGame as default, useLoadingGame };
+export { type ExitAnimation, type GameName, type GameResult, type GameSize, LoadingGame, type LoadingGameOptions, type Score, type ThemeObject, type UseLoadingGameOptions, type UseLoadingGameReturn, LoadingGame as default, useLoadingGame };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loading-games",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Playable mini-games that replace loading spinners",
   "license": "MIT",
   "type": "module",