hudini 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CassinoDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+<img src="data/hudini.png" alt="hudini" />
+
+# 🎩 Hudini
+
+> _Magical Phaser UI components that appear when you need them most_
+
+**Hudini** is a collection of reusable, themeable UI components for Phaser games. Named after the famous magician Houdini and HUD (Head-Up Display), it provides a magical toolkit for building consistent game interfaces.
+
+## ✨ Features
+
+- 🎨 **Themeable** - Dark/light themes with full customization
+- 🔊 **Sound Integration** - Built-in sound effects for interactions
+- 📦 **Zero Dependencies** - Only requires Phaser as peer dependency
+- 🎯 **TypeScript First** - Full type safety and IntelliSense
+- 🧪 **Tested** - Comprehensive test coverage
+
+## 🚀 Quick Start
+
+```bash
+npm i --save hudini
+# or
+yarn add hudini
+# or
+pnpm add hudini
+```

package/dist/assert.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=assert.spec.d.ts.map

package/dist/assert.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.spec.d.ts","sourceRoot":"","sources":["../src/assert.spec.ts"],"names":[],"mappings":""}

package/dist/assert.spec.js

@@ -0,0 +1,7 @@
+import { describe, expect, it } from 'vitest';
+describe('assert', () => {
+    it('should be defined', () => {
+        expect(true).toBe(true);
+    });
+});
+//# sourceMappingURL=assert.spec.js.map

package/dist/assert.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.spec.js","sourceRoot":"","sources":["../src/assert.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/exports-phaser-wind.d.ts

@@ -0,0 +1,2 @@
+export * from 'phaser-wind';
+//# sourceMappingURL=exports-phaser-wind.d.ts.map

package/dist/exports-phaser-wind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports-phaser-wind.d.ts","sourceRoot":"","sources":["../src/exports-phaser-wind.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/exports-phaser-wind.js

@@ -0,0 +1,2 @@
+export * from 'phaser-wind';
+//# sourceMappingURL=exports-phaser-wind.js.map

package/dist/exports-phaser-wind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports-phaser-wind.js","sourceRoot":"","sources":["../src/exports-phaser-wind.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './exports-phaser-wind';
+export * from './plugin';
+export * from './scene';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './exports-phaser-wind';
+export * from './plugin';
+export * from './scene';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/plugin/index.d.ts

@@ -0,0 +1,2 @@
+export * from './plugin';
+//# sourceMappingURL=index.d.ts.map

package/dist/plugin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/dist/plugin/index.js

@@ -0,0 +1,2 @@
+export * from './plugin';
+//# sourceMappingURL=index.js.map

package/dist/plugin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/dist/plugin/plugin.d.ts

@@ -0,0 +1,68 @@
+import { Plugins } from 'phaser';
+import { BaseThemeConfig, PhaserWindPlugin, ThemeOverride } from 'phaser-wind';
+export declare const HUDINI_KEY: string;
+/**
+ * Plugin configuration data type.
+ *
+ * @typedef {Object} HudiniPluginData
+ * @property {BaseThemeConfig} [theme] - Custom theme created using createTheme(). If not provided,
+ *   the default light theme will be used
+ * @property {boolean} [darkMode=false] - When true, uses the default dark theme. Only takes effect
+ *   if no custom theme is provided
+ */
+export type HudiniPluginData<T = ThemeOverride> = {
+    theme?: T;
+    darkMode?: boolean;
+    phaserWindMappingKey?: string;
+};
+/**
+ * Phaser Wind Plugin class that manages theme configuration
+ * @extends Plugins.BasePlugin
+ */
+export declare class HudiniPlugin<T extends BaseThemeConfig> extends Plugins.BasePlugin {
+    /**
+     * The mapping key for the PhaserWind plugin
+     * @internal
+     * @deprecated Do not modify this value unless you know what you're doing.
+     * Changing this value can break the plugin's functionality.
+     */
+    private phaserWindMappingKey;
+    /**
+     * Creates an instance of HudiniPlugin
+     * @param pluginManager - Phaser plugin manager instance
+     */
+    constructor(pluginManager: Plugins.PluginManager);
+    /**
+     * Initializes the plugin with theme configuration
+     * @param theme - Custom theme configuration
+     * @param darkMode - Whether to use dark mode theme when no custom theme provided
+     * @example
+     * ```typescript
+     * const game = new Phaser.Game({
+     *   plugins: {
+     *     global: [
+     *       {
+     *         key: HUDINI_KEY,
+     *         plugin: HudiniPlugin,
+     *         mapping: HUDINI_KEY,
+     *         data: { theme: defaultLightTheme,  }
+     *       },
+     *     ],
+     *   },
+     * });
+     * ```
+     */
+    init({ theme, darkMode, 
+    /**
+     * @internal
+     * @deprecated Do not modify this value unless you know what you're doing.
+     * Changing this value can break the plugin's functionality.
+     */
+    phaserWindMappingKey, }: HudiniPluginData<T>): void;
+    /**
+     * Returns the PhaserWind plugin instance
+     * @returns PhaserWind plugin instance
+     */
+    get pw(): PhaserWindPlugin<T>;
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EACL,eAAe,EAIf,gBAAgB,EAChB,aAAa,EACd,MAAM,aAAa,CAAC;AAErB,eAAO,MAAM,UAAU,EAAE,MAAiB,CAAC;AAE3C;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,aAAa,IAAI;IAChD,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,qBAAa,YAAY,CACvB,CAAC,SAAS,eAAe,CACzB,SAAQ,OAAO,CAAC,UAAU;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB,CAA2B;IAEvD;;;OAGG;gBACS,aAAa,EAAE,OAAO,CAAC,aAAa;IAIhD;;;;;;;;;;;;;;;;;;;OAmBG;IAGM,IAAI,CAAC,EACZ,KAAK,EACL,QAAgB;IAChB;;;;OAIG;IACH,oBAAsC,GACvC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;IAqB7B;;;OAGG;IACH,IAAW,EAAE,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAInC;CACF"}

package/dist/plugin/plugin.js

@@ -0,0 +1,69 @@
+import { Plugins } from 'phaser';
+import { defaultDarkTheme, defaultLightTheme, PHASER_WIND_KEY, PhaserWindPlugin, } from 'phaser-wind';
+export const HUDINI_KEY = 'hudini';
+/**
+ * Phaser Wind Plugin class that manages theme configuration
+ * @extends Plugins.BasePlugin
+ */
+export class HudiniPlugin extends Plugins.BasePlugin {
+    /**
+     * The mapping key for the PhaserWind plugin
+     * @internal
+     * @deprecated Do not modify this value unless you know what you're doing.
+     * Changing this value can break the plugin's functionality.
+     */
+    phaserWindMappingKey = PHASER_WIND_KEY;
+    /**
+     * Creates an instance of HudiniPlugin
+     * @param pluginManager - Phaser plugin manager instance
+     */
+    constructor(pluginManager) {
+        super(pluginManager);
+    }
+    /**
+     * Initializes the plugin with theme configuration
+     * @param theme - Custom theme configuration
+     * @param darkMode - Whether to use dark mode theme when no custom theme provided
+     * @example
+     * ```typescript
+     * const game = new Phaser.Game({
+     *   plugins: {
+     *     global: [
+     *       {
+     *         key: HUDINI_KEY,
+     *         plugin: HudiniPlugin,
+     *         mapping: HUDINI_KEY,
+     *         data: { theme: defaultLightTheme,  }
+     *       },
+     *     ],
+     *   },
+     * });
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    init({ theme, darkMode = false, 
+    /**
+     * @internal
+     * @deprecated Do not modify this value unless you know what you're doing.
+     * Changing this value can break the plugin's functionality.
+     */
+    phaserWindMappingKey = PHASER_WIND_KEY, }) {
+        this.phaserWindMappingKey = phaserWindMappingKey;
+        // If the phaser-wind plugin is not installed, install it
+        if (!this.pluginManager.get(PHASER_WIND_KEY)) {
+            const chosenTheme = theme ?? (darkMode ? defaultDarkTheme : defaultLightTheme);
+            this.pluginManager.install(PHASER_WIND_KEY, PhaserWindPlugin, true, phaserWindMappingKey, {
+                theme: chosenTheme,
+                darkMode,
+            });
+        }
+    }
+    /**
+     * Returns the PhaserWind plugin instance
+     * @returns PhaserWind plugin instance
+     */
+    get pw() {
+        return this.pluginManager.get(this.phaserWindMappingKey);
+    }
+}
+//# sourceMappingURL=plugin.js.map

package/dist/plugin/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAEL,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,gBAAgB,GAEjB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,MAAM,UAAU,GAAW,QAAQ,CAAC;AAiB3C;;;GAGG;AACH,MAAM,OAAO,YAEX,SAAQ,OAAO,CAAC,UAAU;IAC1B;;;;;OAKG;IACK,oBAAoB,GAAW,eAAe,CAAC;IAEvD;;;OAGG;IACH,YAAY,aAAoC;QAC9C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IAEH,6DAA6D;IACpD,IAAI,CAAC,EACZ,KAAK,EACL,QAAQ,GAAG,KAAK;IAChB;;;;OAIG;IACH,oBAAoB,GAAG,eAAe,GAClB;QACpB,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAEjD,yDAAyD;QACzD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7C,MAAM,WAAW,GACf,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;YAE7D,IAAI,CAAC,aAAa,CAAC,OAAO,CACxB,eAAe,EACf,gBAAgB,EAChB,IAAI,EACJ,oBAAoB,EACpB;gBACE,KAAK,EAAE,WAAW;gBAClB,QAAQ;aACT,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAC3B,IAAI,CAAC,oBAAoB,CACH,CAAC;IAC3B,CAAC;CACF"}

package/dist/scene/index.d.ts

@@ -0,0 +1,2 @@
+export * from './scene-with-hudini';
+//# sourceMappingURL=index.d.ts.map

package/dist/scene/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/scene/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/dist/scene/index.js

@@ -0,0 +1,2 @@
+export * from './scene-with-hudini';
+//# sourceMappingURL=index.js.map

package/dist/scene/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/scene/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/dist/scene/scene-with-hudini.d.ts

@@ -0,0 +1,11 @@
+import { BaseThemeConfig, SceneWithPhaserWind } from 'phaser-wind';
+import { HudiniPlugin } from '../plugin/plugin';
+export declare abstract class SceneWithHudini<T extends BaseThemeConfig = BaseThemeConfig> extends SceneWithPhaserWind<T> {
+    /**
+     *
+     * @param config The scene key or scene specific configuration settings.
+     */
+    constructor(config?: string | Phaser.Types.Scenes.SettingsConfig);
+    hudini: HudiniPlugin<T>;
+}
+//# sourceMappingURL=scene-with-hudini.d.ts.map

package/dist/scene/scene-with-hudini.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scene-with-hudini.d.ts","sourceRoot":"","sources":["../../src/scene/scene-with-hudini.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD,8BAAsB,eAAe,CACnC,CAAC,SAAS,eAAe,GAAG,eAAe,CAC3C,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IAC9B;;;OAGG;gBACS,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc;IAIzD,MAAM,EAAG,YAAY,CAAC,CAAC,CAAC,CAAC;CACjC"}

package/dist/scene/scene-with-hudini.js

@@ -0,0 +1,12 @@
+import { SceneWithPhaserWind } from 'phaser-wind';
+export class SceneWithHudini extends SceneWithPhaserWind {
+    /**
+     *
+     * @param config The scene key or scene specific configuration settings.
+     */
+    constructor(config) {
+        super(config);
+    }
+    hudini;
+}
+//# sourceMappingURL=scene-with-hudini.js.map

package/dist/scene/scene-with-hudini.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scene-with-hudini.js","sourceRoot":"","sources":["../../src/scene/scene-with-hudini.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAInE,MAAM,OAAgB,eAEpB,SAAQ,mBAAsB;IAC9B;;;OAGG;IACH,YAAY,MAAoD;QAC9D,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEM,MAAM,CAAmB;CACjC"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "hudini",
+  "version": "0.1.0",
+  "description": "🎩 Magical Phaser UI components - Reusable HUD elements for game development. Is magic, like a wizard",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "phaser",
+    "ui",
+    "components",
+    "hud",
+    "game-development",
+    "typescript",
+    "button",
+    "modal",
+    "panel"
+  ],
+  "author": "CassinoDev",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/renatocassino/phaser-toolkit.git",
+    "directory": "packages/hudini"
+  },
+  "bugs": {
+    "url": "https://github.com/renatocassino/phaser-toolkit/issues"
+  },
+  "homepage": "https://github.com/renatocassino/phaser-toolkit/tree/main/packages/hudini#readme",
+  "devDependencies": {
+    "@eslint-recommended/eslint-config": "^28.0.0",
+    "@types/node": "^24.2.1",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^6.15.0",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-security": "^1.7.1",
+    "eslint-plugin-sonarjs": "^0.23.0",
+    "eslint-plugin-unicorn": "^50.0.1",
+    "tsx": "^4.20.3",
+    "typescript": "^5.3.0",
+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "phaser-wind": "*",
+    "font-awesome-for-phaser": "*"
+  },
+  "peerDependencies": {
+    "phaser": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "dev": "tsc --build --watch",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx --max-warnings 0",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "lint:report": "eslint src --ext .ts,.tsx --format html --output-file eslint-report.html",
+    "validate": "pnpm run lint && pnpm run typecheck && pnpm run test && lint-staged"
+  }
+}