@needle-tools/engine 4.16.1 → 4.16.2

package/lib/engine-components/ReflectionProbe.js

@@ -4,16 +4,19 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { CubeTexture, EquirectangularReflectionMapping, LinearSRGBColorSpace, Texture, Vector3 } from "three";
+import { Box3, CubeTexture, EquirectangularReflectionMapping, LinearSRGBColorSpace, Quaternion, Texture, Vector3 } from "three";
+import { CreateWireCube } from "../engine/engine_gizmos.js";
 import { MaterialPropertyBlock } from "../engine/engine_materialpropertyblock.js";
 import { loadPMREM } from "../engine/engine_pmrem.js";
 import { serializable } from "../engine/engine_serialization.js";
+import { getBoundingBox } from "../engine/engine_three_utils.js";
 import { getParam, resolveUrl } from "../engine/engine_utils.js";
-import { BoxHelperComponent } from "./BoxHelperComponent.js";
 import { Behaviour } from "./Component.js";
 import { EventList } from "./EventList.js";
 export const debug = getParam("debugreflectionprobe");
 const disable = getParam("noreflectionprobe");
+let box = null;
+const _identityRotation = new Quaternion();
 const $reflectionProbeKey = Symbol("reflectionProbeKey");
 /**
  * The [ReflectionProbe](https://engine.needle.tools/docs/api/ReflectionProbe) provides environment reflection data to materials within its defined area.
@@ -41,8 +44,10 @@ const $reflectionProbeKey = Symbol("reflectionProbeKey");
  */
 export class ReflectionProbe extends Behaviour {
     static _probes = new Map();
+    static testBox = new Box3();
     /**
-     * Checks if the given material is currently using a reflection probe. This is determined by checking for an override on the material's "envMap" property, which is set by the Renderer component when applying a reflection probe.
+     * Checks if the given material is currently using a reflection probe.
+     * This is determined by checking for an override on the material's "envMap" property, which is set by the Renderer component when applying a reflection probe.
      */
     static isUsingReflectionProbe(material) {
         return !!material[$reflectionProbeKey];
@@ -99,7 +104,10 @@ export class ReflectionProbe extends Behaviour {
     _texture;
     _textureUrlInFlight;
     /**
-     * The cubemap or HDR texture used for reflections. Can be assigned directly or via a URL string. When assigning via URL, the texture will be loaded asynchronously and applied once ready.
+     * The cubemap or HDR texture used for reflections. Can be assigned directly or via a URL string.
+     * When assigning via URL, the texture will be loaded asynchronously and applied once ready.
+     * @param tex The texture or URL to assign to this reflection probe
+     * @default null
      */
     set texture(tex) {
         if (this._texture === tex)
@@ -140,22 +148,38 @@ export class ReflectionProbe extends Behaviour {
     get texture() {
         return this._texture;
     }
+    /**
+     * The intensity of the reflection probe's influence.
+     *  Higher values will make reflections brighter, while lower values will make them dimmer.
+     * The default value is 1, which means the reflections will be applied at their original brightness. Adjust this value to achieve the desired look for your scene.
+     * @default 1
+     */
     intensity = 1;
     /**
-     * Defines the center and size of the reflection probe's influence area.
+     * Defines the center of the reflection probe's influence area relative to the GameObject's position.
+     * The probe will affect objects within a box defined by this center and the `size` property.
+     * Note: The actual influence area is determined by both the `center` and `size` properties. The `center` defines the offset from the GameObject's position, while the `size` defines the dimensions of the box around that center. Objects within this box will be influenced by the reflection probe.
      */
-    center;
+    center = new Vector3();
     /**
      * Defines the size of the reflection probe's influence area. Objects within this box will be affected by the probe's reflections.
+     * Note: The actual influence area is determined by both the `center` and `size` properties. The `center` defines the offset from the GameObject's position, while the `size` defines the dimensions of the box around that center. Objects within this box will be influenced by the reflection probe.
      */
-    size;
+    size = new Vector3(1, 1, 1);
     /**
      * Workaround for lightmap. Compensates for the fact that lightmaps are pre-multiplied by intensity, while reflection probes are not. This means that if you use both lightmaps and reflection probes, you may need to adjust this value to get the correct balance between them. The default value of `Math.PI` is a good starting point for most cases, but you may need to tweak it based on your specific lighting setup and artistic needs.
      */
     __lightmapIntensityScale = true;
-    _boxHelper;
     isInBox(obj) {
-        return this._boxHelper?.isInBox(obj);
+        box ??= new Box3();
+        box.setFromCenterAndSize(this.gameObject.worldPosition.add(this.center), this.gameObject.worldScale.multiply(this.size));
+        getBoundingBox([obj], undefined, undefined, ReflectionProbe.testBox);
+        if (ReflectionProbe.testBox.isEmpty()) {
+            return box.containsPoint(obj.worldPosition);
+        }
+        else {
+            return box?.intersectsBox(ReflectionProbe.testBox);
+        }
     }
     constructor() {
         super();
@@ -164,12 +188,14 @@ export class ReflectionProbe extends Behaviour {
         }
         ReflectionProbe._probes.get(this.context)?.push(this);
     }
+    _gizmo = null;
+    _color = null;
     /** @internal */
     awake() {
-        this._boxHelper = this.gameObject.addComponent(BoxHelperComponent);
-        this._boxHelper.updateBox(true);
-        if (debug)
-            this._boxHelper.showHelper(0x555500, true);
+        if (debug) {
+            this._gizmo = CreateWireCube(0x555500);
+            this.gameObject.add(this._gizmo);
+        }
         if (this._texture) {
             this._texture.mapping = EquirectangularReflectionMapping;
             this._texture.colorSpace = LinearSRGBColorSpace;
@@ -177,6 +203,16 @@ export class ReflectionProbe extends Behaviour {
         }
     }
     /** @internal */
+    update() {
+        if (this._gizmo) {
+            if (this.center)
+                this._gizmo.position.copy(this.center);
+            if (this.size)
+                this._gizmo.scale.copy(this.size);
+            this._gizmo.worldQuaternion = _identityRotation.identity();
+        }
+    }
+    /** @internal */
     onEnable() {
         ReflectionProbe.onEnabled?.invoke(this);
     }
@@ -201,7 +237,10 @@ export class ReflectionProbe extends Behaviour {
         }
     }
     /**
-     * Applies this reflection probe to the given object by setting material property overrides for "envMap", "envMapRotation", and "envMapIntensity". This is typically called by the Renderer component when determining which reflection probe to use for a given object.
+     * Applies this reflection probe to the given object by setting material property overrides for "envMap", "envMapRotation", and "envMapIntensity".
+     * This is typically called by the Renderer component when determining which reflection probe to use for a given object.
+     * @param object The object to apply the reflection probe to
+     * @see {@link unapply} for the corresponding method to remove the probe's influence from an object.
      */
     apply(object) {
         if (disable)
@@ -221,7 +260,10 @@ export class ReflectionProbe extends Behaviour {
         propertyBlock.setOverride("envMapIntensity", intensity);
     }
     /**
-     * Removes the reflection probe overrides from the given object. This is typically called by the Renderer component when an object is no longer influenced by this probe or when the probe is disabled.
+     * Removes the reflection probe overrides from the given object.
+     * This is typically called by the Renderer component when an object is no longer influenced by this probe or when the probe is disabled.
+     * @param object The object to remove the reflection probe overrides from
+     * @see {@link apply} for the corresponding method to apply the probe's influence to an object.
      */
     unapply(obj) {
         const block = MaterialPropertyBlock.get(obj);

package/lib/engine-components/ReflectionProbe.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReflectionProbe.js","sourceRoot":"","sources":["../../src/engine-components/ReflectionProbe.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,gCAAgC,EAAE,oBAAoB,EAAsB,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAElI,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AACtD,MAAM,OAAO,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAE9C,MAAM,mBAAmB,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;AACzD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAElC,MAAM,CAAC,OAAO,GAAoC,IAAI,GAAG,EAAE,CAAC;IAGpE;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,QAAkB;QAC5C,OAAO,CAAC,CAAE,QAAgB,CAAC,mBAAmB,CAAC,CAAC;IACpD,CAAC;IAGD;;;OAGG;IACH,MAAM,CAAU,SAAS,GAA+B,IAAI,SAAS,EAAE,CAAC;IACxE;;;OAGG;IACH,MAAM,CAAU,UAAU,GAA+B,IAAI,SAAS,EAAE,CAAC;IAEzE;;;;;;;;;;OAUG;IACI,MAAM,CAAC,GAAG,CAAC,MAAmC,EAAE,OAAgB,EAAE,QAAiB,EAAE,MAAiB;QACzG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QACvD,IAAI,OAAO;YAAE,OAAO,IAAI,CAAC;QACzB,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,MAAM,EAAE,CAAC;YACT,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,CAAC,KAAK,CAAC,UAAU;oBAAE,KAAK,CAAC,eAAe,EAAE,CAAC;gBAC/C,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;oBACzB,IAAI,MAAM,EAAE,CAAC;wBACT,IAAI,KAAK,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;4BAC9B,OAAO,KAAK,CAAC;wBACjB,CAAC;oBACL,CAAC;yBACI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC7B,IAAI,KAAK;4BAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;wBAC1E,OAAO,KAAK,CAAC;oBACjB,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QACD,IAAI,KAAK;YACL,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,QAAQ,CAAkB;IAC1B,mBAAmB,CAAU;IAErC;;OAEG;IAEH,IAAI,OAAO,CAAC,GAAmB;QAC3B,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG;YAAE,OAAO;QAElC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC1B,IAAG,KAAK;gBAAE,OAAO,CAAC,KAAK,CAAC,gEAAgE,GAAG,EAAE,CAAC,CAAC;YAC/F,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;YAC/B,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAClD,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACvD,IAAI,IAAI,CAAC,mBAAmB,KAAK,GAAG,IAAI,MAAM,EAAE,CAAC;oBAC7C,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;oBACrC,IAAI,KAAK;wBAAE,OAAO,CAAC,KAAK,CAAC,mEAAmE,GAAG,EAAE,CAAC,CAAC;oBACnG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;gBAC1B,CAAC;YACL,CAAC,CAAC,CAAC;YACH,OAAO;QACX,CAAC;QAED,0FAA0F;QAC1F,4GAA4G;QAC5G,sQAAsQ;QACtQ,IAAG,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;QAEzD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QAEpB,IAAI,KAAK;YAAE,OAAO,CAAC,KAAK,CAAC,iDAAiD,GAAG,CAAC,GAAG,EAAE,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC;QAEzG,IAAI,GAAG,EAAE,CAAC;YACN,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;YACjC,CAAC;iBACI,IAAI,GAAG,CAAC,OAAO,KAAK,gCAAgC,EAAE,CAAC;gBACxD,GAAG,CAAC,OAAO,GAAG,gCAAgC,CAAC;YACnD,CAAC;YACD,GAAG,CAAC,UAAU,GAAG,oBAAoB,CAAC;YACtC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC;QAC3B,CAAC;IACL,CAAC;IACD,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAGD,SAAS,GAAW,CAAC,CAAC;IAEtB;;OAEG;IAEH,MAAM,CAAW;IAEjB;;OAEG;IAEH,IAAI,CAAW;IAEf;;OAEG;IACH,wBAAwB,GAAY,IAAI,CAAC;IAEjC,UAAU,CAAsB;IAEhC,OAAO,CAAC,GAAa;QACzB,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED,gBAAgB;IAChB,KAAK;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAuB,CAAC;QACzF,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK;YACL,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE/C,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,gCAAgC,CAAC;YACzD,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,oBAAoB,CAAC;YAChD,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;QACrC,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,QAAQ;QACJ,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IAChB,SAAS;QACL,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,gBAAgB;IAChB,KAAK;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,uJAAuJ,CAAC,CAAC;QAC1K,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,SAAS;QACL,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACb,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAgB;QAClB,IAAI,OAAO;YAAE,OAAO;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,MAAM,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxD,aAAa,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,aAAa,CAAC,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEtE,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,IAAI,CAAC,wBAAwB,IAAI,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,kFAAkF;YAClF,SAAS,IAAI,IAAI,CAAC,EAAE,CAAC;QACzB,CAAC;QACD,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,GAAa;QACjB,MAAM,KAAK,GAAG,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,KAAK,EAAE,CAAC;YACR,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;YACnD,IAAI,OAAO,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC3B,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAClC,CAAC;QACL,CAAC;IACL,CAAC;;AAlJD;IADC,YAAY,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;8CAoC/B;AAMD;IADC,YAAY,EAAE;kDACO;AAMtB;IADC,YAAY,CAAC,OAAO,CAAC;+CACL;AAMjB;IADC,YAAY,CAAC,OAAO,CAAC;6CACP"}
+{"version":3,"file":"ReflectionProbe.js","sourceRoot":"","sources":["../../src/engine-components/ReflectionProbe.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,IAAI,EAAS,WAAW,EAAE,gCAAgC,EAAE,oBAAoB,EAAoC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEzK,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAoB,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AACtD,MAAM,OAAO,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAE9C,IAAI,GAAG,GAAgB,IAAI,CAAC;AAC5B,MAAM,iBAAiB,GAAG,IAAI,UAAU,EAAE,CAAC;AAE3C,MAAM,mBAAmB,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;AACzD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAElC,MAAM,CAAC,OAAO,GAAoC,IAAI,GAAG,EAAE,CAAC;IAC5D,MAAM,CAAC,OAAO,GAAS,IAAI,IAAI,EAAE,CAAC;IAE1C;;;OAGG;IACH,MAAM,CAAC,sBAAsB,CAAC,QAAkB;QAC5C,OAAO,CAAC,CAAE,QAAgB,CAAC,mBAAmB,CAAC,CAAC;IACpD,CAAC;IAGD;;;OAGG;IACH,MAAM,CAAU,SAAS,GAA+B,IAAI,SAAS,EAAE,CAAC;IACxE;;;OAGG;IACH,MAAM,CAAU,UAAU,GAA+B,IAAI,SAAS,EAAE,CAAC;IAEzE;;;;;;;;;;OAUG;IACI,MAAM,CAAC,GAAG,CAAC,MAAmC,EAAE,OAAgB,EAAE,QAAiB,EAAE,MAAiB;QACzG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QACvD,IAAI,OAAO;YAAE,OAAO,IAAI,CAAC;QACzB,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,MAAM,EAAE,CAAC;YACT,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,CAAC,KAAK,CAAC,UAAU;oBAAE,KAAK,CAAC,eAAe,EAAE,CAAC;gBAC/C,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;oBACzB,IAAI,MAAM,EAAE,CAAC;wBACT,IAAI,KAAK,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;4BAC9B,OAAO,KAAK,CAAC;wBACjB,CAAC;oBACL,CAAC;yBACI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC7B,IAAI,KAAK;4BAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;wBAC1E,OAAO,KAAK,CAAC;oBACjB,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QACD,IAAI,KAAK;YACL,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,QAAQ,CAAkB;IAC1B,mBAAmB,CAAU;IAErC;;;;;OAKG;IAEH,IAAI,OAAO,CAAC,GAAmB;QAC3B,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG;YAAE,OAAO;QAElC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC1B,IAAI,KAAK;gBAAE,OAAO,CAAC,KAAK,CAAC,gEAAgE,GAAG,EAAE,CAAC,CAAC;YAChG,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;YAC/B,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAClD,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACvD,IAAI,IAAI,CAAC,mBAAmB,KAAK,GAAG,IAAI,MAAM,EAAE,CAAC;oBAC7C,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;oBACrC,IAAI,KAAK;wBAAE,OAAO,CAAC,KAAK,CAAC,mEAAmE,GAAG,EAAE,CAAC,CAAC;oBACnG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;gBAC1B,CAAC;YACL,CAAC,CAAC,CAAC;YACH,OAAO;QACX,CAAC;QAED,0FAA0F;QAC1F,4GAA4G;QAC5G,sQAAsQ;QACtQ,IAAI,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;QAE1D,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QAEpB,IAAI,KAAK;YAAE,OAAO,CAAC,KAAK,CAAC,iDAAiD,GAAG,CAAC,GAAG,EAAE,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC;QAEzG,IAAI,GAAG,EAAE,CAAC;YACN,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;YACjC,CAAC;iBACI,IAAI,GAAG,CAAC,OAAO,KAAK,gCAAgC,EAAE,CAAC;gBACxD,GAAG,CAAC,OAAO,GAAG,gCAAgC,CAAC;YACnD,CAAC;YACD,GAAG,CAAC,UAAU,GAAG,oBAAoB,CAAC;YACtC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC;QAC3B,CAAC;IACL,CAAC;IACD,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IAEH,SAAS,GAAW,CAAC,CAAC;IAEtB;;;;OAIG;IAEH,MAAM,GAAY,IAAI,OAAO,EAAE,CAAC;IAEhC;;;OAGG;IAEH,IAAI,GAAY,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAErC;;OAEG;IACH,wBAAwB,GAAY,IAAI,CAAC;IAGjC,OAAO,CAAC,GAAa;QAEzB,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC;QACnB,GAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1H,cAAc,CAAC,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;QAErE,IAAI,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;aACI,CAAC;YACF,OAAO,GAAG,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;IACL,CAAC;IAED;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAEO,MAAM,GAAwB,IAAI,CAAC;IACnC,MAAM,GAAiB,IAAI,CAAC;IAEpC,gBAAgB;IAChB,KAAK;QACD,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,gCAAgC,CAAC;YACzD,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,oBAAoB,CAAC;YAChD,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;QACrC,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,MAAM;QACF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,MAAM;gBAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxD,IAAI,IAAI,CAAC,IAAI;gBAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC/D,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,QAAQ;QACJ,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IAChB,SAAS;QACL,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,gBAAgB;IAChB,KAAK;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,uJAAuJ,CAAC,CAAC;QAC1K,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,SAAS;QACL,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACb,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAgB;QAClB,IAAI,OAAO;YAAE,OAAO;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,MAAM,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxD,aAAa,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,aAAa,CAAC,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEtE,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,IAAI,CAAC,wBAAwB,IAAI,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,kFAAkF;YAClF,SAAS,IAAI,IAAI,CAAC,EAAE,CAAC;QACzB,CAAC;QACD,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,GAAa;QACjB,MAAM,KAAK,GAAG,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,KAAK,EAAE,CAAC;YACR,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;YACnD,IAAI,OAAO,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC3B,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAClC,CAAC;QACL,CAAC;IACL,CAAC;;AAvLD;IADC,YAAY,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;8CAoC/B;AAYD;IADC,YAAY,EAAE;kDACO;AAQtB;IADC,YAAY,CAAC,OAAO,CAAC;+CACU;AAOhC;IADC,YAAY,CAAC,OAAO,CAAC;6CACe"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/engine",
-  "version": "4.16.1",
+  "version": "4.16.2",
   "description": "Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.",
   "main": "dist/needle-engine.min.js",
   "exports": {
@@ -13,21 +13,29 @@
     "./components.json": "./components.needle.json",
     "./asap": "./lib/asap/needle-asap.js",
     "./vite": {
-      "types": "./plugins/types/vite.d.ts",
+      "types": "./plugins/vite/index.d.ts",
       "import": "./plugins/vite/index.js",
       "require": "./plugins/vite/index.js"
     },
     "./next": {
-      "types": "./plugins/types/next.d.ts",
+      "types": "./plugins/next/next.d.ts",
       "import": "./plugins/next/index.js",
       "require": "./plugins/next/index.js"
     },
+    "./plugins/vite": {
+      "types": "./plugins/vite/index.d.ts",
+      "default": "./plugins/vite/index.js"
+    },
     "./plugins/vite/index.js": {
-      "types": "./plugins/types/vite.d.ts",
+      "types": "./plugins/vite/index.d.ts",
       "default": "./plugins/vite/index.js"
     },
+    "./plugins/next": {
+      "types": "./plugins/next/next.d.ts",
+      "default": "./plugins/next/index.js"
+    },
     "./plugins/next/index.js": {
-      "types": "./plugins/types/next.d.ts",
+      "types": "./plugins/next/next.d.ts",
       "default": "./plugins/next/index.js"
     }
   },
@@ -48,10 +56,11 @@
   "readme": "README.md",
   "scripts": {
     "dev": "npm-watch",
-    "build": "npm run build:src && npm run build:dist",
+    "build": "npm run build:plugin-types && npm run build:src && npm run build:dist",
     "build:dist": "vite build",
     "build:src": "tsc -p tsconfig.build.json --rootDir ./src --outDir ./lib --noEmit false --declaration",
     "build:license": "node plugins/publish/create-license.mjs",
+    "build:plugin-types": "tsc -p tsconfig.plugins.json && cp .plugin-types-tmp/plugins/vite/*.d.ts plugins/vite/ && cp .plugin-types-tmp/plugins/next/*.d.ts plugins/next/ && rm -rf .plugin-types-tmp",
     "build:components-data": "node plugins/publish/create-component-types.now.mjs",
     "test": "node plugins/test/test.mjs",
     "test:circular-imports": "node plugins/test/check-circular-imports.mjs",

package/plugins/next/next.d.ts

@@ -0,0 +1,8 @@
+/** Integrates Needle Engine into a Next.js project.
+ * Pass a nextConfig object in to add the needle specific settings.
+ * Optionally omit nextConfig and it will be created for you.
+ * @param {import('next').NextConfig} [nextConfig]
+ * @param {import('../types').userSettings} [userSettings]
+ * @returns {Promise<import('next').NextConfig>}
+ */
+export function needleNext(nextConfig?: any, userSettings?: import("../types").userSettings): Promise<any>;

package/plugins/next/next.js

@@ -12,13 +12,14 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 
-/** Pass a nextConfig object in to add the needle specific settings. 
+/** Integrates Needle Engine into a Next.js project.
+ * Pass a nextConfig object in to add the needle specific settings.
  * Optionally omit nextConfig and it will be created for you.
- * @param {import('next').NextConfig} nextConfig
- * @param {import('../types').userSettings} userSettings
- * @returns {import('next').NextConfig}
+ * @param {import('next').NextConfig} [nextConfig]
+ * @param {import('../types').userSettings} [userSettings]
+ * @returns {Promise<import('next').NextConfig>}
  */
-export const needleNext = async (nextConfig, userSettings) => {
+export async function needleNext(nextConfig, userSettings) {
     console.log("Apply 🌵 needle next config");
 
     if (!nextConfig) {
@@ -138,4 +139,4 @@ export const needleNext = async (nextConfig, userSettings) => {
 
 
     return nextConfig;
-};
+}

package/plugins/types/userconfig.d.ts

@@ -98,9 +98,10 @@ export type userSettings = {
     */
     posterGenerationMode?: "default" | "once";
 
-    /** Pass in a mix of VitePWA and NeedlePWA options, true to enable with defaults or "false" to disable */
-    /** @type {import("vite-plugin-pwa").VitePWAOptions & Partial<NeedlePWAOptions> | boolean} */
-    pwa?: undefined;
+    /** Pass in PWA options, `true` to enable with defaults, or `false` to disable.
+     * Options are forwarded to `vite-plugin-pwa`.
+     */
+    pwa?: Record<string, unknown> | boolean;
 
     /** used by nextjs config to forward the webpack module */
     modules?: needleModules;
@@ -164,9 +165,6 @@ export type userSettings = {
      */
     openBrowser?: boolean;
 
-    /** Automatically import MaterialX for needle engine in 'main.ts' */
-    loadMaterialX?: boolean;
-
     disableLogging?: boolean;
 
     /** Set to true to disable the plugin that ensures VSCode workspace settings for custom-elements.json data */

package/plugins/vite/ai.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Needle Engine Claude skill installer.
+ *
+ * Writes a Needle Engine skill to `.claude/skills/needle-engine/SKILL.md`.
+ * Claude Code auto-loads skills based on their description frontmatter, so
+ * Claude will automatically have Needle Engine context when working in the project.
+ *
+ * The skill is only written if `.claude/` already exists in the project root
+ * (i.e. the developer is already using Claude Code). Old skill files are
+ * always overwritten so the skill stays up to date with the engine version.
+ *
+ * @param {"build" | "serve"} command
+ * @param {{} | undefined | null} config
+ * @param {import('../types/index.js').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleAI(command: "build" | "serve", config: {} | undefined | null, userSettings: import("../types/index.js").userSettings): import("vite").Plugin | null;

package/plugins/vite/ai.js

@@ -23,7 +23,7 @@ const pluginName = "needle-ai";
  * @param {import('../types/index.js').userSettings} userSettings
  * @returns {import('vite').Plugin | null}
  */
-export const needleAI = (command, config, userSettings) => {
+export function needleAI(command, config, userSettings) {
     return {
         name: pluginName,
         enforce: "pre",
@@ -34,7 +34,7 @@ export const needleAI = (command, config, userSettings) => {
             installClaudeSkill();
         },
     };
-};
+}
 
 function writeSkill(claudeDir) {
     const skillDir = join(claudeDir, "skills", "needle-engine");

package/plugins/vite/alias.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | import('vite').Plugin[] | undefined}
+ */
+export function needleViteAlias(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin | import("vite").Plugin[] | undefined;
+export type PackageResolveValue = "auto-resolve" | ((res: string, packageName: string, index: number, path: string) => string | null | void);

package/plugins/vite/alias.js

@@ -67,9 +67,12 @@ const packages_to_resolve = {
 }
 
 /**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | import('vite').Plugin[] | undefined}
  */
-export const needleViteAlias = (command, config, userSettings) => {
+export function needleViteAlias(command, config, userSettings) {
 
     if (config?.noAlias === true || userSettings?.noAlias === true)
         return;
@@ -199,4 +202,4 @@ export const needleViteAlias = (command, config, userSettings) => {
             }
         }
     }
-};
+}

package/plugins/vite/asap.d.ts

@@ -0,0 +1,7 @@
+/** Injects needle asap script into the index.html for when the main needle engine bundle is still being downloaded.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {Promise<import('vite').Plugin[] | null>}
+ */
+export function needleAsap(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): Promise<import("vite").Plugin[] | null>;

package/plugins/vite/asap.js

@@ -9,13 +9,13 @@ const code = `import('@needle-tools/engine/src/asap/needle-asap.ts');`
 
 
 
-/**
- * Injects needle asap script into the index.html for when the main needle engine bundle is still being downloaded
+/** Injects needle asap script into the index.html for when the main needle engine bundle is still being downloaded.
  * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
  * @returns {Promise<import('vite').Plugin[] | null>}
  */
-export const needleAsap = async (command, config, userSettings) => {
+export async function needleAsap(command, config, userSettings) {
 
     if (userSettings.noAsap) return null;
 

package/plugins/vite/build-pipeline.d.ts

@@ -0,0 +1,15 @@
+export function waitForBuildPipelineToFinish(): Promise<void>;
+/** Runs the needle build pipeline as part of the vite build process.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export function needleBuildPipeline(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin;
+export type BuildPipelinePayload = {
+    event?: string;
+    phase?: string;
+    target?: string;
+    message?: string;
+    level?: string;
+};

package/plugins/vite/build-pipeline.js

@@ -75,14 +75,13 @@ function increaseMaxWaitTime(debugLog) {
     }
 }
 
-/**
- * Runs the needle build pipeline as part of the vite build process
- * @param {string} command
- * @param {import('vite').UserConfig} config
+/** Runs the needle build pipeline as part of the vite build process.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
- * @returns {Promise<import('vite').Plugin | null>}
+ * @returns {import('vite').Plugin}
  */
-export const needleBuildPipeline = async (command, config, userSettings) => {
+export async function needleBuildPipeline(command, config, userSettings) {
 
     // we only want to run compression here if this is a distribution build
     // this is handled however in the `apply` hook

package/plugins/vite/build.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export function needleBuild(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin;

package/plugins/vite/build.js

@@ -1,8 +1,11 @@
 
-/** 
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
  * @returns {import('vite').Plugin}
  */
-export const needleBuild = (command, config, userSettings) => {
+export function needleBuild(command, config, userSettings) {
 
     // TODO: need to set this when building a dist
     const isDeployOnlyBuild = config?.deployOnly === true;

package/plugins/vite/buildinfo.d.ts

@@ -0,0 +1,7 @@
+/** Create a buildinfo file in the build directory.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleBuildInfo(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin | null;

package/plugins/vite/buildinfo.js

@@ -6,11 +6,13 @@ import { needleBlue, needleDim, needleLog, needleSupportsColor } from './logging
 
 let level = 0;
 
-/** Create a buildinfo file in the build directory
+/** Create a buildinfo file in the build directory.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
  * @returns {import('vite').Plugin | null}
  */
-export const needleBuildInfo = (command, config, userSettings) => {
+export function needleBuildInfo(command, config, userSettings) {
 
     if (userSettings?.noBuildInfo) return null;
 

package/plugins/vite/config.d.ts

@@ -0,0 +1,13 @@
+/** Load the codegen meta file.
+ * @param {string | null} path
+ * @returns {Promise<import("../types/needleConfig").needleMeta | null>}
+ */
+export function loadConfig(path?: string | null): Promise<import("../types/needleConfig").needleMeta | null>;
+/** get the needle.config.json
+ * @returns {import("../types/needleConfig").needleConfig | null}
+ */
+export function tryLoadProjectConfig(): import("../types/needleConfig").needleConfig | null;
+/** "assets" -> the directory name inside the output directory to put e.g. glb files into */
+export function builtAssetsDirectory(): string;
+/** @returns the fullpath of the build */
+export function getOutputDirectory(): string;

package/plugins/vite/config.js

@@ -3,7 +3,7 @@ import path from 'path';
 
 let didLogCanNotFindConfig = false;
 
-/**  the codegen meta file
+/** Load the codegen meta file.
  * @param {string | null} path
  * @returns {Promise<import("../types/needleConfig").needleMeta | null>}
  */

package/plugins/vite/copyfiles.d.ts

@@ -0,0 +1,7 @@
+/** Copy files on build from assets to dist.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleCopyFiles(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin | null;

package/plugins/vite/copyfiles.js

@@ -8,11 +8,13 @@ import { needleBlue, needleDim, needleLog, needleSupportsColor } from './logging
 const pluginName = "needle-copy-files";
 
 
-/** copy files on build from assets to dist 
+/** Copy files on build from assets to dist.
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
  * @returns {import('vite').Plugin | null}
  */
-export const needleCopyFiles = (command, config, userSettings) => {
+export function needleCopyFiles(command, config, userSettings) {
 
     if (config?.noCopy === true || userSettings?.noCopy === true) {
         return null;

package/plugins/vite/custom-element-data.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Ensure the repo workspace or .vscode settings include Needle Engine custom HTML data if they exist.
+ * Copies custom-elements.json to the project and merges with existing user content.
+ * - Copies/merges `custom-elements.json` to project root
+ * - Adds `./custom-elements.json` to `.code-workspace settings.html.customData`
+ * - Adds `./custom-elements.json` to `.vscode/settings.json html.customData`
+ * @param {"build" | "serve"} _command
+ * @param {import('../types').needleMeta | null} _config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleCustomElementData(_command: "build" | "serve", _config: import("../types").needleMeta | null, userSettings?: import("../types").userSettings): import("vite").Plugin | null;
+export default needleCustomElementData;
+export type CustomElementData = {
+    version?: number;
+    tags?: {
+        name: string;
+        [key: string]: unknown;
+    }[];
+    valueSets?: {
+        name: string;
+        [key: string]: unknown;
+    }[];
+    globalAttributes?: unknown[];
+};

package/plugins/vite/custom-element-data.js

@@ -64,8 +64,9 @@ function mergeCustomElementData(sourceData, targetData) {
  * @param {"build" | "serve"} _command
  * @param {import('../types').needleMeta | null} _config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
  */
-export const needleCustomElementData = (_command, _config, userSettings = {}) => {
+export function needleCustomElementData(_command, _config, userSettings = {}) {
     // Allow disabling the workspace updater
     if (userSettings?.noCustomElementData === true) return null;
 

package/plugins/vite/defines.d.ts

@@ -0,0 +1,10 @@
+/** used to pass config variables into vite.config.define
+ * for example "useRapier"
+ */
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} needleEngineConfig
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export function needleDefines(command: "build" | "serve", needleEngineConfig: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin;

package/plugins/vite/defines.js

@@ -12,11 +12,12 @@ import { needleLog } from "./logging.js";
 // https://vitejs.dev/config/#using-environment-variables-in-config
 
 /**
- * @param {string} command
- * @param {{ generator?: string, useRapier?: boolean } | null | undefined} needleEngineConfig
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} needleEngineConfig
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
  */
-export const needleDefines = (command, needleEngineConfig, userSettings) => {
+export function needleDefines(command, needleEngineConfig, userSettings) {
 
     if (!userSettings) userSettings = {};
 

package/plugins/vite/dependencies.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Returns true when \`@needle-tools/engine\` is installed as a local package
+ * (i.e. it has its own nested `node_modules`). Vite's optimiser must skip such
+ * packages, otherwise it tries to pre-bundle source that was never meant to be
+ * pre-bundled and fails at dev-server start.
+ *
+ * @param {string} [root] – project root; defaults to `process.cwd()`.
+ * @returns {boolean}
+ */
+export function isLocalNeedleEngineInstalled(root?: string): boolean;
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin[]}
+ */
+export function needleDependencies(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin[];
+/**
+ * @type {string[]}
+ */
+export const preloadScriptPaths: string[];