hudini 0.18.1 → 0.19.0

package/dist/scene/index.d.ts

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

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

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

package/dist/scene/index.js

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

package/dist/scene/index.js.map

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

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

@@ -1,8 +1,31 @@
 import { BaseThemeConfig, SceneWithPhaserWind } from 'phaser-wind';
 import { HudiniPlugin } from '../plugin/plugin';
+/**
+ * @deprecated Use {@link withHudini} instead.
+ *
+ * Forces single inheritance, which conflicts with any user-defined `BaseScene`
+ * or other libraries that ship their own scene base class. It also relies on a
+ * non-null assertion (`hudini!`) that lies to TypeScript about when the plugin
+ * is available — touching `this.hudini` before the plugin mounts throws at
+ * runtime.
+ *
+ * Prefer the `withHudini(scene)` accessor:
+ *
+ * ```ts
+ * import { withHudini } from 'hudini';
+ * import type { ThemeType } from './theme';
+ *
+ * class MyScene extends Phaser.Scene {
+ *   create() {
+ *     const hudini = withHudini<ThemeType>(this);
+ *   }
+ * }
+ * ```
+ *
+ * Kept exported to avoid breaking existing consumers.
+ */
 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);

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,8BAAsB,eAAe,CACnC,CAAC,SAAS,eAAe,GAAG,eAAe,CAC3C,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IAC9B;;OAEG;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

@@ -1,7 +1,30 @@
 import { SceneWithPhaserWind } from 'phaser-wind';
+/**
+ * @deprecated Use {@link withHudini} instead.
+ *
+ * Forces single inheritance, which conflicts with any user-defined `BaseScene`
+ * or other libraries that ship their own scene base class. It also relies on a
+ * non-null assertion (`hudini!`) that lies to TypeScript about when the plugin
+ * is available — touching `this.hudini` before the plugin mounts throws at
+ * runtime.
+ *
+ * Prefer the `withHudini(scene)` accessor:
+ *
+ * ```ts
+ * import { withHudini } from 'hudini';
+ * import type { ThemeType } from './theme';
+ *
+ * class MyScene extends Phaser.Scene {
+ *   create() {
+ *     const hudini = withHudini<ThemeType>(this);
+ *   }
+ * }
+ * ```
+ *
+ * Kept exported to avoid breaking existing consumers.
+ */
 export class SceneWithHudini extends SceneWithPhaserWind {
     /**
-     *
      * @param config The scene key or scene specific configuration settings.
      */
     constructor(config) {

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAgB,eAEpB,SAAQ,mBAAsB;IAC9B;;OAEG;IACH,YAAY,MAAoD;QAC9D,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEM,MAAM,CAAmB;CACjC"}

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

@@ -0,0 +1,35 @@
+import type { Scene } from 'phaser';
+import type { BaseThemeConfig } from 'phaser-wind';
+import { HudiniPlugin } from '../plugin/plugin';
+/**
+ * Accessor for the Hudini plugin from within a Phaser scene.
+ *
+ * Preferred over {@link SceneWithHudini} (inheritance) and over module
+ * augmentation of `Phaser.Scene`, because it:
+ * - Composes with any existing base scene (no forced inheritance).
+ * - Keeps the theme type explicit at the call site (no silent `any`).
+ * - Doesn't rely on non-null assertions that lie about lifecycle.
+ *
+ * Call it inside `create()` / `update()` (after the plugin has been installed).
+ *
+ * @typeParam T - The theme config type. Pass your `ThemeType` to get
+ *   type-narrowed access to your custom tokens (through `hudini.pw`).
+ * @param scene - The Phaser scene instance.
+ * @returns The Hudini plugin instance bound to the given theme type.
+ *
+ * @example
+ * ```ts
+ * import { withHudini } from 'hudini';
+ * import type { ThemeType } from './theme';
+ *
+ * class MyScene extends Phaser.Scene {
+ *   create() {
+ *     const hudini = withHudini<ThemeType>(this);
+ *     const pw = hudini.pw;
+ *     this.cameras.main.setBackgroundColor(pw.color.rgb('background'));
+ *   }
+ * }
+ * ```
+ */
+export declare const withHudini: <T extends BaseThemeConfig = BaseThemeConfig>(scene: Scene) => HudiniPlugin<T>;
+//# sourceMappingURL=with-hudini.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"with-hudini.d.ts","sourceRoot":"","sources":["../../src/scene/with-hudini.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAc,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,eAAe,GAAG,eAAe,EACpE,OAAO,KAAK,KACX,YAAY,CAAC,CAAC,CAC4C,CAAC"}

package/dist/scene/with-hudini.js

@@ -0,0 +1,33 @@
+import { HUDINI_KEY } from '../plugin/plugin';
+/**
+ * Accessor for the Hudini plugin from within a Phaser scene.
+ *
+ * Preferred over {@link SceneWithHudini} (inheritance) and over module
+ * augmentation of `Phaser.Scene`, because it:
+ * - Composes with any existing base scene (no forced inheritance).
+ * - Keeps the theme type explicit at the call site (no silent `any`).
+ * - Doesn't rely on non-null assertions that lie about lifecycle.
+ *
+ * Call it inside `create()` / `update()` (after the plugin has been installed).
+ *
+ * @typeParam T - The theme config type. Pass your `ThemeType` to get
+ *   type-narrowed access to your custom tokens (through `hudini.pw`).
+ * @param scene - The Phaser scene instance.
+ * @returns The Hudini plugin instance bound to the given theme type.
+ *
+ * @example
+ * ```ts
+ * import { withHudini } from 'hudini';
+ * import type { ThemeType } from './theme';
+ *
+ * class MyScene extends Phaser.Scene {
+ *   create() {
+ *     const hudini = withHudini<ThemeType>(this);
+ *     const pw = hudini.pw;
+ *     this.cameras.main.setBackgroundColor(pw.color.rgb('background'));
+ *   }
+ * }
+ * ```
+ */
+export const withHudini = (scene) => scene.plugins.get(HUDINI_KEY);
+//# sourceMappingURL=with-hudini.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"with-hudini.js","sourceRoot":"","sources":["../../src/scene/with-hudini.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAgB,MAAM,kBAAkB,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAY,EACK,EAAE,CACnB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAA+B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hudini",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "description": "🎩 Magical Phaser UI components - Reusable HUD elements for game development. Is magic, like a wizard",
   "type": "module",
   "main": "./dist/index.js",
@@ -62,7 +62,7 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "phaser-wind": "0.9.1",
+    "phaser-wind": "0.10.0",
     "font-awesome-for-phaser": "0.10.0"
   },
   "peerDependencies": {