minerender 2.1.0-alpha.5 → 2.1.0-alpha.7

package/dist/browser/index.d.mts

@@ -60,7 +60,7 @@ declare function createCanvas(width: number, height: number): CompatCanvas;
 declare abstract class PersistentCache<B = unknown> {
     readonly backing: B;
     /** Bump to invalidate every persisted entry. */
-    static readonly VERSION = 1;
+    static readonly VERSION = 2;
     static open(name: string): PersistentCache;
     protected constructor(backing: B);
     abstract get<T>(key: string): Promise<T>;
@@ -534,14 +534,13 @@ declare class MinecraftFaceUV {
 }
 
 /**
- * Releases every long-lived timer MineRender holds, so a Node process can exit.
+ * Stops the shared Ticker and request queues, and clears the in-memory caches.
  *
- * Both `@inventivetalent/loading-cache` (cache expiry) and `jobqu` (request queue draining) use
- * self-rescheduling timers that are not unref'd, which keeps the event loop alive for as long as
- * the library is loaded. Browsers don't care, but anything headless - a render server, a CLI, a
- * test run - has to call this when it's done.
+ * Idle Node processes can exit without calling this: cache and Ticker timers are unref'd,
+ * and idle request queues hold no timer. Pending requests keep their normal timer references.
  *
- * The library stays usable afterwards; the caches and queues simply start over.
+ * Call this only when finished with MineRender. Waiting and future requests reject; requests
+ * already running can finish. Queue shutdown is permanent, and cache expiry timers do not restart.
  */
 declare function shutdown(): void;
 
@@ -621,6 +620,7 @@ declare class AssetLoader {
     static addSource(key: string, source: AssetSource, override?: boolean): void;
     static removeSource(key: string): Maybe<AssetSource>;
     static getAll<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<T[]>;
+    /** Returns the first defined result in source-priority order, without merging assets. */
     static get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<Maybe<T>>;
 }
 
@@ -1218,8 +1218,8 @@ declare class Caching {
     /**
      * Clears every cache and stops its expiry timer.
      *
-     * loading-cache reschedules that timer indefinitely, so a Node process will not exit until
-     * this is called - see {@link shutdown}.
+     * Expiry timers are unref'd in Node, so idle processes can exit without this cleanup.
+     * Use {@link shutdown} to also stop requests and the shared Ticker.
      */
     static end(): void;
     static get cacheSizes(): {};
@@ -1472,8 +1472,9 @@ declare class Requests {
         mcAsset: number;
     };
     /**
-     * Stops both queue timers. jobqu reschedules itself indefinitely, so a Node process will not
-     * exit until this is called - see {@link shutdown}.
+     * Permanently stops both queues and rejects waiting and future requests.
+     * Requests already running can finish. Idle queues hold no timer, so Node can exit without
+     * this cleanup. See {@link shutdown}.
      */
     static end(): void;
 }

package/dist/browser/index.d.ts

@@ -60,7 +60,7 @@ declare function createCanvas(width: number, height: number): CompatCanvas;
 declare abstract class PersistentCache<B = unknown> {
     readonly backing: B;
     /** Bump to invalidate every persisted entry. */
-    static readonly VERSION = 1;
+    static readonly VERSION = 2;
     static open(name: string): PersistentCache;
     protected constructor(backing: B);
     abstract get<T>(key: string): Promise<T>;
@@ -534,14 +534,13 @@ declare class MinecraftFaceUV {
 }
 
 /**
- * Releases every long-lived timer MineRender holds, so a Node process can exit.
+ * Stops the shared Ticker and request queues, and clears the in-memory caches.
  *
- * Both `@inventivetalent/loading-cache` (cache expiry) and `jobqu` (request queue draining) use
- * self-rescheduling timers that are not unref'd, which keeps the event loop alive for as long as
- * the library is loaded. Browsers don't care, but anything headless - a render server, a CLI, a
- * test run - has to call this when it's done.
+ * Idle Node processes can exit without calling this: cache and Ticker timers are unref'd,
+ * and idle request queues hold no timer. Pending requests keep their normal timer references.
  *
- * The library stays usable afterwards; the caches and queues simply start over.
+ * Call this only when finished with MineRender. Waiting and future requests reject; requests
+ * already running can finish. Queue shutdown is permanent, and cache expiry timers do not restart.
  */
 declare function shutdown(): void;
 
@@ -621,6 +620,7 @@ declare class AssetLoader {
     static addSource(key: string, source: AssetSource, override?: boolean): void;
     static removeSource(key: string): Maybe<AssetSource>;
     static getAll<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<T[]>;
+    /** Returns the first defined result in source-priority order, without merging assets. */
     static get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<Maybe<T>>;
 }
 
@@ -1218,8 +1218,8 @@ declare class Caching {
     /**
      * Clears every cache and stops its expiry timer.
      *
-     * loading-cache reschedules that timer indefinitely, so a Node process will not exit until
-     * this is called - see {@link shutdown}.
+     * Expiry timers are unref'd in Node, so idle processes can exit without this cleanup.
+     * Use {@link shutdown} to also stop requests and the shared Ticker.
      */
     static end(): void;
     static get cacheSizes(): {};
@@ -1472,8 +1472,9 @@ declare class Requests {
         mcAsset: number;
     };
     /**
-     * Stops both queue timers. jobqu reschedules itself indefinitely, so a Node process will not
-     * exit until this is called - see {@link shutdown}.
+     * Permanently stops both queues and rejects waiting and future requests.
+     * Requests already running can finish. Idle queues hold no timer, so Node can exit without
+     * this cleanup. See {@link shutdown}.
      */
     static end(): void;
 }

package/dist/browser/index.js

@@ -90,7 +90,7 @@ var require_dist = __commonJS({
       return false;
     };
     var PROTECTED_KEYS = ["__proto__"];
-    var merge11 = function() {
+    var merge10 = function() {
       var objects = [];
       for (var _i = 0; _i < arguments.length; _i++) {
         objects[_i] = arguments[_i];
@@ -101,9 +101,9 @@ var require_dist = __commonJS({
             return;
           }
           if (Array.isArray(result[key]) && Array.isArray(current[key])) {
-            result[key] = merge11.options.mergeArrays ? Array.from(new Set(result[key].concat(current[key]))) : current[key];
+            result[key] = merge10.options.mergeArrays ? Array.from(new Set(result[key].concat(current[key]))) : current[key];
           } else if (isObject(result[key]) && isObject(current[key])) {
-            result[key] = merge11(result[key], current[key]);
+            result[key] = merge10(result[key], current[key]);
           } else {
             result[key] = current[key];
           }
@@ -114,18 +114,18 @@ var require_dist = __commonJS({
     var defaultOptions = {
       mergeArrays: true
     };
-    merge11.options = defaultOptions;
-    merge11.withOptions = function(options) {
+    merge10.options = defaultOptions;
+    merge10.withOptions = function(options) {
       var objects = [];
       for (var _i = 1; _i < arguments.length; _i++) {
         objects[_i - 1] = arguments[_i];
       }
-      merge11.options = __assign({ mergeArrays: true }, options);
-      var result = merge11.apply(void 0, __spreadArray([], __read(objects), false));
-      merge11.options = defaultOptions;
+      merge10.options = __assign({ mergeArrays: true }, options);
+      var result = merge10.apply(void 0, __spreadArray([], __read(objects), false));
+      merge10.options = defaultOptions;
       return result;
     };
-    exports.default = merge11;
+    exports.default = merge10;
   }
 });
 
@@ -318,7 +318,7 @@ var _PersistentCache = class _PersistentCache {
   }
 };
 /** Bump to invalidate every persisted entry. */
-_PersistentCache.VERSION = 1;
+_PersistentCache.VERSION = 2;
 var PersistentCache = _PersistentCache;
 
 // src/env/browser/BrowserCache.ts
@@ -419,7 +419,8 @@ var BrowserEnv = class {
   }
   openCache(name, version) {
     return new BrowserCache(import_localforage.default.createInstance({
-      name,
+      // IndexedDB schema upgrades retain records; each cache generation needs its own database.
+      name: name + version,
       version
     }));
   }
@@ -575,8 +576,8 @@ var Caching = class {
   /**
    * Clears every cache and stops its expiry timer.
    *
-   * loading-cache reschedules that timer indefinitely, so a Node process will not exit until
-   * this is called - see {@link shutdown}.
+   * Expiry timers are unref'd in Node, so idle processes can exit without this cleanup.
+   * Use {@link shutdown} to also stop requests and the shared Ticker.
    */
   static end() {
     for (const cache of this.all) {
@@ -824,13 +825,14 @@ var _Requests = class _Requests {
   }
   static get queueSizes() {
     return {
-      generic: this.genericQueue.size,
-      mcAsset: this.mcAssetRequestQueue.size
+      generic: this.genericQueue.size + this.genericQueue.activeSize,
+      mcAsset: this.mcAssetRequestQueue.size + this.mcAssetRequestQueue.activeSize
     };
   }
   /**
-   * Stops both queue timers. jobqu reschedules itself indefinitely, so a Node process will not
-   * exit until this is called - see {@link shutdown}.
+   * Permanently stops both queues and rejects waiting and future requests.
+   * Requests already running can finish. Idle queues hold no timer, so Node can exit without
+   * this cleanup. See {@link shutdown}.
    */
   static end() {
     this.genericQueue.end();
@@ -1811,7 +1813,6 @@ var ArchiveAssetSource = class _ArchiveAssetSource extends AssetSource {
 };
 
 // src/assets/AssetLoader.ts
-var import_ts_deepmerge3 = __toESM(require_dist());
 var p5 = prefix("AssetLoader");
 var _AssetLoader = class _AssetLoader {
   static addSource(key, source, override = true) {
@@ -1835,7 +1836,6 @@ var _AssetLoader = class _AssetLoader {
     return void 0;
   }
   static async getAll(key, parser) {
-    console.log(this._SOURCES);
     let promises = [];
     for (const source of this._SOURCES) {
       promises.push(source.source.get(key, parser));
@@ -1844,24 +1844,16 @@ var _AssetLoader = class _AssetLoader {
       return results.filter((r) => r != void 0);
     });
   }
+  /** Returns the first defined result in source-priority order, without merging assets. */
   static async get(key, parser) {
-    console.log(this._SOURCES);
-    let promises = [];
-    for (const source of this._SOURCES) {
-      promises.push(source.source.get(key, parser));
-    }
-    return Promise.all(promises).then((results) => {
-      const fallback = results[results.length - 1];
-      for (const result of results) {
-        if (result) {
-          if (fallback) {
-            return (0, import_ts_deepmerge3.default)({}, fallback, result);
-          }
-          return result;
-        }
+    const sources = [...this._SOURCES];
+    for (const source of sources) {
+      const result = await source.source.get(key, parser);
+      if (result !== void 0) {
+        return result;
       }
-      return void 0;
-    });
+    }
+    return void 0;
   }
 };
 _AssetLoader.ROOT = DEFAULT_ROOT;
@@ -2683,7 +2675,7 @@ var MineRenderError = class _MineRenderError extends Error {
 };
 
 // src/renderer/SceneObject.ts
-var import_ts_deepmerge4 = __toESM(require_dist());
+var import_ts_deepmerge3 = __toESM(require_dist());
 var p7 = prefix("SceneObject");
 var _SceneObject = class _SceneObject extends import_three9.Object3D {
   constructor(options) {
@@ -2692,7 +2684,7 @@ var _SceneObject = class _SceneObject extends import_three9.Object3D {
     this.materialCallbacks = {};
     this._isInstanced = false;
     this._instanceCounter = 0;
-    this.options = (0, import_ts_deepmerge4.default)({}, _SceneObject.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge3.default)({}, _SceneObject.DEFAULT_OPTIONS, options ?? {});
     console.log("SceneObject options", this.options);
   }
   set scene(scene) {
@@ -3041,7 +3033,7 @@ var _SceneObject = class _SceneObject extends import_three9.Object3D {
   }
   //</editor-fold>
 };
-_SceneObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge4.default)({}, {
+_SceneObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge3.default)({}, {
   instanceMeshes: true,
   maxInstanceCount: 50,
   mergeMeshes: true,
@@ -3053,7 +3045,7 @@ function isSceneObject(obj) {
 }
 
 // src/entity/scene/EntityObject.ts
-var import_ts_deepmerge5 = __toESM(require_dist());
+var import_ts_deepmerge4 = __toESM(require_dist());
 var import_three11 = require("three");
 var THREE3 = __toESM(require("three"));
 var EntityObject = class extends SceneObject {
@@ -3062,7 +3054,7 @@ var EntityObject = class extends SceneObject {
     this.entity = entity;
     this.isEntityObject = true;
     this.meshesCreated = false;
-    this.options = (0, import_ts_deepmerge5.default)({}, SceneObject.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge4.default)({}, SceneObject.DEFAULT_OPTIONS, options ?? {});
   }
   async init() {
     this.createMeshes();
@@ -3129,7 +3121,7 @@ var EntityObject = class extends SceneObject {
     }
   }
 };
-EntityObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge5.default)({}, SceneObject.DEFAULT_OPTIONS, {});
+EntityObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge4.default)({}, SceneObject.DEFAULT_OPTIONS, {});
 function isEntityObject(obj) {
   return obj.isEntityObject;
 }
@@ -4120,7 +4112,7 @@ function computeMorphedAttributes(object) {
 }
 
 // src/model/scene/ModelObject.ts
-var import_ts_deepmerge6 = __toESM(require_dist());
+var import_ts_deepmerge5 = __toESM(require_dist());
 var p10 = prefix("ModelObject");
 var _ModelObject = class _ModelObject extends SceneObject {
   constructor(originalModel, options) {
@@ -4128,7 +4120,7 @@ var _ModelObject = class _ModelObject extends SceneObject {
     this.originalModel = originalModel;
     this.isModelObject = true;
     this.meshesCreated = false;
-    this.options = (0, import_ts_deepmerge6.default)({}, _ModelObject.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge5.default)({}, _ModelObject.DEFAULT_OPTIONS, options ?? {});
     console.log("ModelObject options", this.options);
   }
   async init() {
@@ -4226,14 +4218,14 @@ var _ModelObject = class _ModelObject extends SceneObject {
     }
   }
 };
-_ModelObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge6.default)({}, SceneObject.DEFAULT_OPTIONS, {});
+_ModelObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge5.default)({}, SceneObject.DEFAULT_OPTIONS, {});
 var ModelObject = _ModelObject;
 function isModelObject(obj) {
   return obj.isModelObject;
 }
 
 // src/model/block/scene/BlockObject.ts
-var import_ts_deepmerge7 = __toESM(require_dist());
+var import_ts_deepmerge6 = __toESM(require_dist());
 var import_three16 = require("three");
 var p11 = prefix("BlockObject");
 var _BlockObject = class _BlockObject extends SceneObject {
@@ -4249,7 +4241,7 @@ var _BlockObject = class _BlockObject extends SceneObject {
     this._instanceModel = [];
     this._variants = [];
     this._models = [];
-    this.options = (0, import_ts_deepmerge7.default)({}, _BlockObject.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge6.default)({}, _BlockObject.DEFAULT_OPTIONS, options ?? {});
   }
   async init() {
     if (this.options.applyDefaultState) {
@@ -4538,7 +4530,7 @@ var _BlockObject = class _BlockObject extends SceneObject {
   //TODO: should override rotation + scale methods
   //TODO
 };
-_BlockObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge7.default)({}, ModelObject.DEFAULT_OPTIONS, {
+_BlockObject.DEFAULT_OPTIONS = (0, import_ts_deepmerge6.default)({}, ModelObject.DEFAULT_OPTIONS, {
   applyDefaultState: true
 });
 var BlockObject = _BlockObject;
@@ -4588,7 +4580,7 @@ var StructureParser = class {
 
 // src/renderer/MineRenderScene.ts
 var import_three17 = require("three");
-var import_ts_deepmerge9 = __toESM(require_dist());
+var import_ts_deepmerge8 = __toESM(require_dist());
 
 // src/skin/SkinPart.ts
 var SkinPart = /* @__PURE__ */ ((SkinPart2) => {
@@ -5319,7 +5311,7 @@ var slimSkinGeometries = {
 };
 
 // src/skin/scene/SkinObject.ts
-var import_ts_deepmerge8 = __toESM(require_dist());
+var import_ts_deepmerge7 = __toESM(require_dist());
 var SkinObject = class extends SceneObject {
   constructor(options) {
     super();
@@ -5327,7 +5319,7 @@ var SkinObject = class extends SceneObject {
     this.legacy = false;
     this.skinTextureWidth = 64;
     this.skinTextureHeight = 64;
-    this.options = (0, import_ts_deepmerge8.default)({}, SceneObject.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge7.default)({}, SceneObject.DEFAULT_OPTIONS, options ?? {});
   }
   async init() {
     this.createMeshes();
@@ -5444,7 +5436,7 @@ var _MineRenderScene = class _MineRenderScene extends import_three17.Scene {
         this.dirty = true;
       }
     };
-    this.options = (0, import_ts_deepmerge9.default)({}, _MineRenderScene.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge8.default)({}, _MineRenderScene.DEFAULT_OPTIONS, options ?? {});
   }
   add(...objects) {
     for (const object of objects) {
@@ -5540,7 +5532,7 @@ var _MineRenderScene = class _MineRenderScene extends import_three17.Scene {
     return this.addSceneObject(entity, () => new EntityObject(entity, options), options, parent);
   }
 };
-_MineRenderScene.DEFAULT_OPTIONS = (0, import_ts_deepmerge9.default)({}, {});
+_MineRenderScene.DEFAULT_OPTIONS = (0, import_ts_deepmerge8.default)({}, {});
 var MineRenderScene = _MineRenderScene;
 function isMineRenderScene(obj) {
   return obj.isMineRenderScene;
@@ -5548,7 +5540,7 @@ function isMineRenderScene(obj) {
 
 // src/renderer/Renderer.ts
 var import_three19 = require("three");
-var import_ts_deepmerge10 = __toESM(require_dist());
+var import_ts_deepmerge9 = __toESM(require_dist());
 var import_stats = __toESM(require("stats.js"));
 var import_postprocessing = require("postprocessing");
 
@@ -6205,7 +6197,7 @@ var _Renderer = class _Renderer {
     this._changeListener = () => {
       this._dirty = true;
     };
-    this.options = (0, import_ts_deepmerge10.default)({}, _Renderer.DEFAULT_OPTIONS, options ?? {});
+    this.options = (0, import_ts_deepmerge9.default)({}, _Renderer.DEFAULT_OPTIONS, options ?? {});
     this._animationLoop = this.animate.bind(this);
     this._frameInterval = this.options.render.fpsLimit > 0 ? 1e3 / this.options.render.fpsLimit : void 0;
     this._scene = this.createScene();
@@ -6490,7 +6482,7 @@ var _Renderer = class _Renderer {
   }
   ///
 };
-_Renderer.DEFAULT_OPTIONS = (0, import_ts_deepmerge10.default)({}, {
+_Renderer.DEFAULT_OPTIONS = (0, import_ts_deepmerge9.default)({}, {
   camera: {
     type: "perspective",
     near: 1,