@rive-app/webgl-single 1.0.85 → 1.0.86

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/webgl-single",
-  "version": "1.0.85",
+  "version": "1.0.86",
   "description": "Rive's webgl based web api with bundled wasm.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -1,4 +1,4 @@
-import * as rc from './rive_advanced.mjs';
+import * as rc from "./rive_advanced.mjs";
 /**
  * Generic type for a parameterless void callback
  */
@@ -288,6 +288,15 @@ export declare class Rive {
     private alignRenderer;
     get fps(): number;
     get frameTime(): string | 0;
+    /**
+     * Cleans up all Wasm-generated objects that need to be manually destroyed:
+     * artboard instances, animation instances, state machine instances,
+     * renderer instance, file and runtime.
+     *
+     * Once this is called, you will need to initialise a new instance of the
+     * Rive class
+     */
+    cleanup(): void;
     /**
      * Cleans up any Wasm-generated objects that need to be manually destroyed:
      * artboard instances, animation instances, state machine instances.
@@ -295,7 +304,7 @@ export declare class Rive {
      * Once this is called, things will need to be reinitialized or bad things
      * might happen.
      */
-    cleanup(): void;
+    cleanupInstances(): void;
     play(animationNames?: string | string[], autoplay?: true): void;
     pause(animationNames?: string | string[]): void;
     scrub(animationNames?: string | string[], value?: number): void;

package/rive.js

@@ -167,7 +167,7 @@ if(h.preInit)for("function"==typeof h.preInit&&(h.preInit=[h.preInit]);0<h.preIn
 /* 2 */
 /***/ ((module) => {
 
-module.exports = JSON.parse('{"name":"@rive-app/webgl-single","version":"1.0.85","description":"Rive\'s webgl based web api with bundled wasm.","main":"rive.js","homepage":"https://rive.app","repository":{"type":"git","url":"https://github.com/rive-app/rive-wasm/tree/master/js"},"keywords":["rive","animation"],"author":"Rive","contributors":["Luigi Rosso <luigi@rive.app> (https://rive.app)","Maxwell Talbot <max@rive.app> (https://rive.app)","Arthur Vivian <arthur@rive.app> (https://rive.app)","Umberto Sonnino <umberto@rive.app> (https://rive.app)","Matthew Sullivan <matt.j.sullivan@gmail.com> (mailto:matt.j.sullivan@gmail.com)"],"license":"MIT","files":["rive.js","rive.js.map","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
+module.exports = JSON.parse('{"name":"@rive-app/webgl-single","version":"1.0.86","description":"Rive\'s webgl based web api with bundled wasm.","main":"rive.js","homepage":"https://rive.app","repository":{"type":"git","url":"https://github.com/rive-app/rive-wasm/tree/master/js"},"keywords":["rive","animation"],"author":"Rive","contributors":["Luigi Rosso <luigi@rive.app> (https://rive.app)","Maxwell Talbot <max@rive.app> (https://rive.app)","Arthur Vivian <arthur@rive.app> (https://rive.app)","Umberto Sonnino <umberto@rive.app> (https://rive.app)","Matthew Sullivan <matt.j.sullivan@gmail.com> (mailto:matt.j.sullivan@gmail.com)"],"license":"MIT","files":["rive.js","rive.js.map","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
 
 /***/ }),
 /* 3 */
@@ -431,7 +431,7 @@ var Layout = /** @class */ (function () {
     // Alternative constructor to build a Layout from an interface/object
     Layout.new = function (_a) {
         var fit = _a.fit, alignment = _a.alignment, minX = _a.minX, minY = _a.minY, maxX = _a.maxX, maxY = _a.maxY;
-        console.warn('This function is deprecated: please use `new Layout({})` instead');
+        console.warn("This function is deprecated: please use `new Layout({})` instead");
         return new Layout({ fit: fit, alignment: alignment, minX: minX, minY: minY, maxX: maxX, maxY: maxY });
     };
     /**
@@ -1264,7 +1264,7 @@ var Rive = /** @class */ (function () {
     }
     // Alternative constructor to build a Rive instance from an interface/object
     Rive.new = function (params) {
-        console.warn('This function is deprecated: please use `new Rive({})` instead');
+        console.warn("This function is deprecated: please use `new Rive({})` instead");
         return new Rive(params);
     };
     // Initializes the Rive object either from constructor or load()
@@ -1346,7 +1346,7 @@ var Rive = /** @class */ (function () {
                             this.loaded = true;
                             this.eventManager.fire({
                                 type: EventType.Load,
-                                data: (_a = this.src) !== null && _a !== void 0 ? _a : 'buffer',
+                                data: (_a = this.src) !== null && _a !== void 0 ? _a : "buffer",
                             });
                             // Flag ready for playback commands and clear the task queue; this order
                             // is important or it may infinitely recurse
@@ -1356,7 +1356,7 @@ var Rive = /** @class */ (function () {
                             return [2 /*return*/, Promise.resolve()];
                         }
                         else {
-                            msg = 'Problem loading file; may be corrupt!';
+                            msg = "Problem loading file; may be corrupt!";
                             console.warn(msg);
                             this.eventManager.fire({ type: EventType.LoadError, data: msg });
                             return [2 /*return*/, Promise.reject(msg)];
@@ -1374,7 +1374,7 @@ var Rive = /** @class */ (function () {
             : this.file.defaultArtboard();
         // Check we have a working artboard
         if (!rootArtboard) {
-            var msg = 'Invalid artboard name or no default artboard';
+            var msg = "Invalid artboard name or no default artboard";
             console.warn(msg);
             this.eventManager.fire({ type: EventType.LoadError, data: msg });
             return;
@@ -1382,7 +1382,7 @@ var Rive = /** @class */ (function () {
         this.artboard = rootArtboard;
         // Check that the artboard has at least 1 animation
         if (this.artboard.animationCount() < 1) {
-            var msg = 'Artboard has no animations';
+            var msg = "Artboard has no animations";
             this.eventManager.fire({ type: EventType.LoadError, data: msg });
             throw msg;
         }
@@ -1531,6 +1531,26 @@ var Rive = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Cleans up all Wasm-generated objects that need to be manually destroyed:
+     * artboard instances, animation instances, state machine instances,
+     * renderer instance, file and runtime.
+     *
+     * Once this is called, you will need to initialise a new instance of the
+     * Rive class
+     */
+    Rive.prototype.cleanup = function () {
+        // Stop the renderer if it hasn't already been stopped.
+        this.stopRendering();
+        // Clean up any artboard, animation or state machine instances.
+        this.cleanupInstances();
+        // Delete the renderer
+        this.renderer.delete();
+        // Delete the rive file
+        this.file.delete();
+        // Cleanup anything remaining on the runtime.
+        this.runtime.cleanup();
+    };
     /**
      * Cleans up any Wasm-generated objects that need to be manually destroyed:
      * artboard instances, animation instances, state machine instances.
@@ -1538,7 +1558,7 @@ var Rive = /** @class */ (function () {
      * Once this is called, things will need to be reinitialized or bad things
      * might happen.
      */
-    Rive.prototype.cleanup = function () {
+    Rive.prototype.cleanupInstances = function () {
         if (this.eventCleanup !== null) {
             this.eventCleanup();
         }
@@ -1620,7 +1640,7 @@ var Rive = /** @class */ (function () {
         var stateMachineNames = mapToStringArray(params === null || params === void 0 ? void 0 : params.stateMachines);
         var autoplay = (_a = params === null || params === void 0 ? void 0 : params.autoplay) !== null && _a !== void 0 ? _a : false;
         // Stop everything and clean up
-        this.cleanup();
+        this.cleanupInstances();
         // Reinitialize an artboard instance with the state
         this.initArtboard(artBoardName, animationNames, stateMachineNames, autoplay);
         this.taskQueue.process();
@@ -1969,7 +1989,7 @@ var Rive = /** @class */ (function () {
         configurable: true
     });
     // Error message for missing source or buffer
-    Rive.missingErrorMessage = 'Rive source file or data buffer required';
+    Rive.missingErrorMessage = "Rive source file or data buffer required";
     return Rive;
 }());
 
@@ -1996,7 +2016,7 @@ var loadRiveFile = function (src) { return __awaiter(void 0, void 0, void 0, fun
  * Utility function to ensure an object is a string array
  */
 var mapToStringArray = function (obj) {
-    if (typeof obj === 'string') {
+    if (typeof obj === "string") {
         return [obj];
     }
     else if (obj instanceof Array) {