@caperjs/core 0.1.0

package/lib/plugins/DevToolsPlugin.d.ts

@@ -0,0 +1,97 @@
+import { Application } from 'pixi.js';
+import { Plugin, IPlugin } from './Plugin';
+/**
+ * Interface for the DevTools plugin providing development debugging capabilities.
+ * Enables PIXI.js developer tools integration for enhanced debugging and inspection.
+ */
+export interface IDevToolsPlugin extends IPlugin {
+    /**
+     * Initializes the PIXI DevTools for the given application instance.
+     * Enables the browser developer tools extension for PIXI.js debugging.
+     *
+     * @param app - The PIXI Application instance to attach devtools to
+     *
+     * @example
+     * ```typescript
+     * const devToolsPlugin = app.plugins.get<IDevToolsPlugin>('DevToolsPlugin');
+     * if (devToolsPlugin && process.env.NODE_ENV === 'development') {
+     *   devToolsPlugin.initializeDevTools(pixiApp);
+     * }
+     * ```
+     */
+    initializeDevTools(app: Application): void;
+}
+/**
+ * Developer tools plugin for enhanced PIXI.js debugging and inspection.
+ *
+ * Integrates the official PIXI.js developer tools browser extension, providing
+ * visual debugging capabilities, scene graph inspection, and performance monitoring
+ * directly in the browser's developer tools panel.
+ *
+ * Features:
+ * - Scene graph visualization and navigation
+ * - Real-time property inspection and editing
+ * - Performance metrics and rendering statistics
+ * - Texture atlas and asset inspection
+ * - Interactive debugging tools
+ *
+ * @example
+ * ```typescript
+ * // Plugin is typically initialized automatically in development builds
+ * // Manual initialization example:
+ * const devToolsPlugin = app.plugins.get<IDevToolsPlugin>('DevToolsPlugin');
+ * if (devToolsPlugin && process.env.NODE_ENV === 'development') {
+ *   devToolsPlugin.initializeDevTools(pixiApp);
+ * }
+ *
+ * // The devtools will then be available in browser developer tools
+ * // Look for the "PIXI" tab in Chrome/Firefox developer tools
+ * ```
+ *
+ * @remarks
+ * - Should only be enabled in development environments
+ * - Requires the PIXI DevTools browser extension to be installed
+ * - May impact performance and should be disabled in production builds
+ * - Provides comprehensive debugging capabilities for PIXI.js applications
+ */
+export declare class DevToolsPlugin extends Plugin implements IDevToolsPlugin {
+    /** Plugin identifier for framework registration */
+    readonly id = "DevToolsPlugin";
+    /**
+     * Initializes the DevTools plugin.
+     * Sets up the plugin for later DevTools activation when needed.
+     *
+     * @example
+     * ```typescript
+     * // Called automatically by the plugin system
+     * // No manual initialization required
+     * ```
+     */
+    initialize(): Promise<void>;
+    /**
+     * Initializes and activates PIXI DevTools for the specified application.
+     * Connects the application to the browser's PIXI DevTools extension for debugging.
+     *
+     * @param app - The PIXI Application instance to enable debugging for
+     *
+     * @example
+     * ```typescript
+     * // Typically called conditionally based on environment
+     * const pixiApp = new PIXI.Application();
+     * const devToolsPlugin = app.plugins.get<IDevToolsPlugin>('DevToolsPlugin');
+     *
+     * if (devToolsPlugin && process.env.NODE_ENV === 'development') {
+     *   devToolsPlugin.initializeDevTools(pixiApp);
+     *   console.log('PIXI DevTools enabled - check browser developer tools');
+     * }
+     * ```
+     *
+     * @remarks
+     * - Should only be called in development environments
+     * - Requires the PIXI DevTools browser extension to be installed
+     * - Once initialized, debugging tools will be available in the browser's developer tools
+     * - The extension provides a "PIXI" tab with comprehensive debugging features
+     */
+    initializeDevTools(app: Application): void;
+}
+//# sourceMappingURL=DevToolsPlugin.d.ts.map

package/lib/plugins/DevToolsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevToolsPlugin.d.ts","sourceRoot":"","sources":["../../src/plugins/DevToolsPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAAC;CAC5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,cAAe,SAAQ,MAAO,YAAW,eAAe;IACnE,mDAAmD;IACnD,SAAgB,EAAE,oBAAoB;IAEtC;;;;;;;;;OASG;IACG,UAAU;IAEhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,kBAAkB,CAAC,GAAG,EAAE,WAAW;CAG3C"}

package/lib/plugins/FullScreenPlugin.d.ts

@@ -0,0 +1,240 @@
+import { Application } from '../core/Application';
+import { Signal } from '../signals';
+import { IPlugin, Plugin } from './Plugin';
+/**
+ * Interface for the FullScreen plugin providing cross-browser fullscreen functionality.
+ * Handles fullscreen mode management with comprehensive browser compatibility.
+ */
+export interface IFullScreenPlugin extends IPlugin {
+    /** Current fullscreen state */
+    isFullScreen: boolean;
+    /** The HTML element or Window object used for fullscreen operations */
+    fullScreenElement: HTMLElement | Window | null;
+    /** Signal emitted when fullscreen state changes */
+    onFullScreenChange: Signal<(isFullscreen: boolean) => void>;
+    /** Toggles between fullscreen and windowed mode */
+    toggleFullScreen: () => void;
+    /** Sets the fullscreen state explicitly */
+    setFullScreen: (value: boolean) => void;
+    /** Sets the element to be used for fullscreen operations */
+    setFullScreenElement: (element: HTMLElement | Window | null) => void;
+    /** Whether the current environment supports fullscreen functionality */
+    readonly canFullscreen: boolean;
+}
+/**
+ * Cross-browser fullscreen functionality plugin for web applications.
+ *
+ * Provides comprehensive fullscreen mode management with automatic browser
+ * compatibility handling, event management, and flexible element targeting.
+ * Supports all major browsers including Chrome, Firefox, Safari, and Edge.
+ *
+ * Key Features:
+ * - Cross-browser fullscreen API compatibility
+ * - Automatic event handling and state synchronization
+ * - Flexible element targeting (container, window, or custom elements)
+ * - Signal-based event system for reactive programming
+ * - Graceful fallback handling for unsupported browsers
+ * - Automatic cleanup and error handling
+ *
+ * @example
+ * ```typescript
+ * // Get the fullscreen plugin
+ * const fullscreen = app.plugins.get<IFullScreenPlugin>('fullscreen');
+ *
+ * // Listen for fullscreen changes
+ * fullscreen.onFullScreenChange.connect((isFullscreen) => {
+ *   console.log('Fullscreen state:', isFullscreen);
+ *   updateUIForFullscreen(isFullscreen);
+ * });
+ *
+ * // Toggle fullscreen mode
+ * document.getElementById('fullscreenBtn').addEventListener('click', () => {
+ *   if (fullscreen.canFullscreen) {
+ *     fullscreen.toggleFullScreen();
+ *   } else {
+ *     console.warn('Fullscreen not supported');
+ *   }
+ * });
+ *
+ * // Set custom element for fullscreen
+ * const gameContainer = document.getElementById('gameContainer');
+ * fullscreen.setFullScreenElement(gameContainer);
+ * fullscreen.setFullScreen(true);
+ * ```
+ */
+export declare class FullScreenPlugin extends Plugin implements IFullScreenPlugin {
+    /** Plugin identifier for framework registration */
+    readonly id = "fullscreen";
+    /**
+     * Signal emitted when fullscreen state changes.
+     * Provides the new fullscreen state as a boolean parameter.
+     */
+    onFullScreenChange: Signal<(isFullscreen: boolean) => void>;
+    /** Internal fullscreen state tracking */
+    private _isFullScreen;
+    /** Internal reference to the fullscreen target element */
+    private _fullScreenElement;
+    /**
+     * Sets the fullscreen state and triggers the appropriate fullscreen operation.
+     * @param value - True to enter fullscreen, false to exit
+     */
+    set isFullScreen(value: boolean);
+    /**
+     * Gets the current fullscreen state.
+     * @returns True if currently in fullscreen mode
+     */
+    get isFullScreen(): boolean;
+    /**
+     * Sets the element to be used for fullscreen operations.
+     * @param value - The HTML element or Window object to use for fullscreen
+     */
+    set fullScreenElement(value: HTMLElement | Window | null);
+    /**
+     * Gets the current fullscreen target element.
+     * @returns The element currently set for fullscreen operations
+     */
+    get fullScreenElement(): HTMLElement | Window | null;
+    /**
+     * Creates the fullscreen plugin instance.
+     * Binds all methods to maintain proper context when used as event handlers.
+     */
+    constructor();
+    /**
+     * Gets the application instance.
+     * @returns The singleton Application instance
+     */
+    get app(): Application;
+    /**
+     * Initializes the fullscreen plugin by setting up browser event listeners.
+     * Registers listeners for all major browser fullscreen change events.
+     *
+     * @example
+     * ```typescript
+     * // Called automatically by the plugin system
+     * // Registers listeners for: fullscreenchange, webkitfullscreenchange,
+     * // mozfullscreenchange, msfullscreenchange
+     * ```
+     */
+    initialize(): void;
+    /**
+     * Cleans up the plugin by removing all event listeners.
+     * Called automatically when the plugin is destroyed.
+     */
+    destroy(): void;
+    /**
+     * Toggles between fullscreen and windowed mode.
+     *
+     * @example
+     * ```typescript
+     * // Toggle fullscreen on button click
+     * button.addEventListener('click', () => {
+     *   fullscreenPlugin.toggleFullScreen();
+     * });
+     *
+     * // Keyboard shortcut for fullscreen
+     * document.addEventListener('keydown', (e) => {
+     *   if (e.key === 'F11') {
+     *     e.preventDefault();
+     *     fullscreenPlugin.toggleFullScreen();
+     *   }
+     * });
+     * ```
+     */
+    toggleFullScreen(): void;
+    /**
+     * Sets the fullscreen state explicitly.
+     *
+     * @param value - True to enter fullscreen, false to exit fullscreen
+     *
+     * @example
+     * ```typescript
+     * // Enter fullscreen mode
+     * fullscreenPlugin.setFullScreen(true);
+     *
+     * // Exit fullscreen mode
+     * fullscreenPlugin.setFullScreen(false);
+     *
+     * // Conditional fullscreen based on game state
+     * if (gameState === 'playing') {
+     *   fullscreenPlugin.setFullScreen(true);
+     * }
+     * ```
+     */
+    setFullScreen(value: boolean): void;
+    /**
+     * Sets the element to be used for fullscreen operations.
+     * If no element is provided, uses the default application container.
+     *
+     * @param value - The HTML element or Window to use for fullscreen operations
+     *
+     * @example
+     * ```typescript
+     * // Use a specific game container
+     * const gameDiv = document.getElementById('game-container');
+     * fullscreenPlugin.setFullScreenElement(gameDiv);
+     *
+     * // Use the entire window
+     * fullscreenPlugin.setFullScreenElement(window);
+     *
+     * // Reset to default (application container)
+     * fullscreenPlugin.setFullScreenElement(null);
+     * ```
+     */
+    setFullScreenElement(value: HTMLElement | Window | null): void;
+    /**
+     * Checks if the current environment and element support fullscreen functionality.
+     *
+     * @returns True if fullscreen is supported and available
+     *
+     * @example
+     * ```typescript
+     * if (fullscreenPlugin.canFullscreen) {
+     *   // Show fullscreen button
+     *   fullscreenButton.style.display = 'block';
+     * } else {
+     *   // Hide fullscreen button or show alternative
+     *   fullscreenButton.style.display = 'none';
+     *   console.log('Fullscreen not supported on this device');
+     * }
+     * ```
+     */
+    get canFullscreen(): boolean;
+    /**
+     * Checks if the document is currently in fullscreen mode.
+     * Uses browser-specific properties for cross-browser compatibility.
+     *
+     * @returns True if any element is currently in fullscreen mode
+     */
+    get isFullscreen(): boolean;
+    /**
+     * Gets the core signals exposed by this plugin.
+     * @returns Array of signal names available on the plugin
+     * @protected
+     */
+    protected getCoreSignals(): string[];
+    /**
+     * Gets the core functions exposed by this plugin.
+     * @returns Array of function names available on the plugin
+     * @protected
+     */
+    protected getCoreFunctions(): string[];
+    /**
+     * Requests fullscreen mode using the appropriate browser API.
+     * Handles cross-browser compatibility and error cases.
+     * @private
+     */
+    private _requestFullscreen;
+    /**
+     * Exits fullscreen mode using the appropriate browser API.
+     * Handles cross-browser compatibility for fullscreen exit.
+     * @private
+     */
+    private _exitFullscreen;
+    /**
+     * Handles browser fullscreen change events.
+     * Updates internal state and emits the onFullScreenChange signal.
+     * @private
+     */
+    private _onFullScreenChange;
+}
+//# sourceMappingURL=FullScreenPlugin.d.ts.map

package/lib/plugins/FullScreenPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FullScreenPlugin.d.ts","sourceRoot":"","sources":["../../src/plugins/FullScreenPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,OAAO;IAChD,+BAA+B;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,uEAAuE;IACvE,iBAAiB,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/C,mDAAmD;IACnD,kBAAkB,EAAE,MAAM,CAAC,CAAC,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC;IAC5D,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,IAAI,CAAC;IAC7B,2CAA2C;IAC3C,aAAa,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,4DAA4D;IAC5D,oBAAoB,EAAE,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IACrE,wEAAwE;IACxE,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,gBAAiB,SAAQ,MAAO,YAAW,iBAAiB;IACvE,mDAAmD;IACnD,SAAgB,EAAE,gBAAgB;IAElC;;;OAGG;IACI,kBAAkB,EAAE,MAAM,CAAC,CAAC,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC,CAAiD;IAEnH,yCAAyC;IACzC,OAAO,CAAC,aAAa,CAAkB;IACvC,0DAA0D;IAC1D,OAAO,CAAC,kBAAkB,CAAqC;IAE/D;;;OAGG;IACH,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,EAG9B;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,EAEvD;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,WAAW,GAAG,MAAM,GAAG,IAAI,CAEnD;IAED;;;OAGG;;IAMH;;;OAGG;IACH,IAAI,GAAG,IAAI,WAAW,CAErB;IAED;;;;;;;;;;OAUG;IACI,UAAU,IAAI,IAAI;IAQzB;;;OAGG;IACI,OAAO;IAQd;;;;;;;;;;;;;;;;;;OAkBG;IACI,gBAAgB;IAIvB;;;;;;;;;;;;;;;;;;OAkBG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO;IASnC;;;;;;;;;;;;;;;;;;OAkBG;IACI,oBAAoB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI;IAO9D;;;;;;;;;;;;;;;;OAgBG;IACH,IAAW,aAAa,IAAI,OAAO,CAWlC;IAED;;;;;OAKG;IACH,IAAW,YAAY,IAAI,OAAO,CAOjC;IAED;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM,EAAE;IAIpC;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,IAAI,MAAM,EAAE;IAItC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAwB1B;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAYvB;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;CAG5B"}