@rive-app/canvas-lite 2.37.0 → 2.37.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas-lite",
-  "version": "2.37.0",
+  "version": "2.37.2",
   "description": "A lite version of Rive's canvas based web api.",
   "main": "rive.js",
   "homepage": "https://rive.app",
@@ -27,7 +27,9 @@
     "rive.wasm",
     "rive_fallback.wasm",
     "rive.d.ts",
-    "rive_advanced.mjs.d.ts"
+    "rive_advanced.mjs.d.ts",
+    "runtimeLoader.d.ts",
+    "utils"
   ],
   "typings": "rive.d.ts",
   "dependencies": {},

package/rive.d.ts

@@ -1,7 +1,7 @@
 import * as rc from "./rive_advanced.mjs";
 import { RuntimeLoader, type RuntimeCallback } from "./runtimeLoader";
 import { ImageWrapper, AudioWrapper, FontWrapper, RiveFont as RiveFontClassUtil } from "./utils";
-export type AssetLoadCallback = (asset: rc.FileAsset, bytes: Uint8Array) => Boolean;
+export type AssetLoadCallback = (asset: rc.FileAsset, bytes: Uint8Array) => boolean;
 export { RiveFontClassUtil as RiveFont };
 export type { FileAsset, AudioAsset, FontAsset, ImageAsset, } from "./rive_advanced.mjs";
 /**
@@ -285,7 +285,7 @@ export interface RiveParameters {
      */
     onloaderror?: EventCallback;
     /**
-     * @deprecated Use `onPoad()` instead
+     * @deprecated Use `onPlay()` instead
      */
     onplay?: EventCallback;
     /**

package/rive.js

@@ -155,6 +155,17 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */ });
 /* harmony import */ var _rive_advanced_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(4);
 /* harmony import */ var package_json__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(5);
+var __assign = (undefined && undefined.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 
 
 // Runtime singleton; use getInstance to provide a callback that returns the
@@ -165,12 +176,15 @@ var RuntimeLoader = /** @class */ (function () {
     }
     // Loads the runtime
     RuntimeLoader.loadRuntime = function () {
+        // Capture the URL at call time so the catch closure always refers to the
+        // URL this particular attempt used, even if wasmURL is mutated for a retry.
+        var attemptedUrl = RuntimeLoader.wasmURL;
+        var wasmBinary = RuntimeLoader.wasmBinary;
         if (RuntimeLoader.enablePerfMarks)
             performance.mark('rive:wasm-init:start');
-        _rive_advanced_mjs__WEBPACK_IMPORTED_MODULE_0__["default"]({
+        _rive_advanced_mjs__WEBPACK_IMPORTED_MODULE_0__["default"](__assign({ 
             // Loads Wasm bundle
-            locateFile: function () { return RuntimeLoader.wasmURL; },
-        })
+            locateFile: function () { return attemptedUrl; } }, (wasmBinary ? { wasmBinary: wasmBinary } : {})))
             .then(function (rive) {
             var _a;
             if (RuntimeLoader.enablePerfMarks) {
@@ -195,18 +209,30 @@ var RuntimeLoader = /** @class */ (function () {
             };
             // Log detailed error for debugging
             console.debug("Rive WASM load error details:", errorDetails);
-            // In case unpkg fails, or the wasm was not supported, we try to load the fallback module from jsdelivr.
-            // This `rive_fallback.wasm` is compiled to support older architecture.
-            // TODO: (Gordon): preemptively test browser support and load the correct wasm file. Then use jsdelvr only if unpkg fails.
-            var backupJsdelivrUrl = "https://cdn.jsdelivr.net/npm/".concat(package_json__WEBPACK_IMPORTED_MODULE_1__.name, "@").concat(package_json__WEBPACK_IMPORTED_MODULE_1__.version, "/rive_fallback.wasm");
-            if (RuntimeLoader.wasmURL.toLowerCase() !== backupJsdelivrUrl) {
-                console.warn("Failed to load WASM from ".concat(RuntimeLoader.wasmURL, " (").concat(errorDetails.message, "), trying jsdelivr as a backup"));
-                RuntimeLoader.setWasmUrl(backupJsdelivrUrl);
+            // In case the primary URL fails, or the wasm was not supported, try the
+            // fallback URL (a rive_fallback.wasm compiled for older architectures).
+            // The fallback can be customised or disabled via setWasmFallbackUrl().
+            // TODO: (Gordon): preemptively test browser support and load the correct wasm file. Then use the fallback only if the primary fails.
+            var fallbackUrl = RuntimeLoader.wasmFallbackURL;
+            var alreadyOnFallback = fallbackUrl !== null &&
+                attemptedUrl.toLowerCase() === fallbackUrl.toLowerCase();
+            if (fallbackUrl !== null && !alreadyOnFallback) {
+                console.warn("Failed to load WASM from ".concat(attemptedUrl, " (").concat(errorDetails.message, "), trying fallback URL: ").concat(fallbackUrl));
+                // Clear wasmBinary so the retry actually fetches via locateFile
+                // instead of re-using the same (failing) in-memory binary.
+                RuntimeLoader.wasmBinary = null;
+                RuntimeLoader.setWasmUrl(fallbackUrl);
                 RuntimeLoader.loadRuntime();
             }
             else {
+                // When alreadyOnFallback is true, wasmURL has already been overwritten
+                // with the fallback URL, so we can no longer recover the original
+                // primary URL here. The primary URL was logged in the earlier warning.
+                var triedUrls = alreadyOnFallback
+                    ? "the configured WASM URL or its fallback (".concat(fallbackUrl, ")")
+                    : attemptedUrl;
                 var errorMessage = [
-                    "Could not load Rive WASM file from ".concat(RuntimeLoader.wasmURL, " or ").concat(backupJsdelivrUrl, "."),
+                    "Could not load Rive WASM file from ".concat(triedUrls, "."),
                     "Possible reasons:",
                     "- Network connection is down",
                     "- WebAssembly is not supported in this environment",
@@ -252,6 +278,31 @@ var RuntimeLoader = /** @class */ (function () {
     RuntimeLoader.getWasmUrl = function () {
         return RuntimeLoader.wasmURL;
     };
+    /**
+     * Sets the URL used as a fallback when the primary WASM URL fails to load.
+     * Pass `null` to disable the fallback entirely.
+     *
+     * Defaults to pulling from the jsdelivr CDN.
+     */
+    RuntimeLoader.setWasmFallbackUrl = function (url) {
+        RuntimeLoader.wasmFallbackURL = url;
+    };
+    // Gets the current fallback wasm url (null means fallback is disabled)
+    RuntimeLoader.getWasmFallbackUrl = function () {
+        return RuntimeLoader.wasmFallbackURL;
+    };
+    // Manually sets the wasm binary or clears it with null
+    RuntimeLoader.setWasmBinary = function (value) {
+        if ((value instanceof ArrayBuffer) || value === null) {
+            RuntimeLoader.wasmBinary = value;
+            return;
+        }
+        console.error("setWasmBinary expects an ArrayBuffer or null");
+    };
+    // Gets the current wasm build as ArrayBuffer or null
+    RuntimeLoader.getWasmBinary = function () {
+        return RuntimeLoader.wasmBinary;
+    };
     // Flag to indicate that loading has started/completed
     RuntimeLoader.isLoading = false;
     // List of callbacks for the runtime that come in while loading
@@ -259,6 +310,10 @@ var RuntimeLoader = /** @class */ (function () {
     // Path to the Wasm file; default path works for testing only;
     // if embedded wasm is used then this is never used.
     RuntimeLoader.wasmURL = "https://unpkg.com/".concat(package_json__WEBPACK_IMPORTED_MODULE_1__.name, "@").concat(package_json__WEBPACK_IMPORTED_MODULE_1__.version, "/rive.wasm");
+    // Fallback WASM URL tried when the primary URL fails. Set to null to disable
+    // the fallback entirely. Defaults to pulling from the jsdelivr CDN.
+    RuntimeLoader.wasmFallbackURL = "https://cdn.jsdelivr.net/npm/".concat(package_json__WEBPACK_IMPORTED_MODULE_1__.name, "@").concat(package_json__WEBPACK_IMPORTED_MODULE_1__.version, "/rive_fallback.wasm");
+    RuntimeLoader.wasmBinary = null;
     /**
      * When true, performance.mark / performance.measure entries are emitted for
      * WASM initialization.
@@ -2474,7 +2529,7 @@ moduleRtn = da;
 /* 5 */
 /***/ ((module) => {
 
-module.exports = /*#__PURE__*/JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.37.0","description":"A lite version of Rive\'s canvas based web api.","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.wasm","rive_fallback.wasm","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.37.2","description":"A lite version of Rive\'s canvas based web api.","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.wasm","rive_fallback.wasm","rive.d.ts","rive_advanced.mjs.d.ts","runtimeLoader.d.ts","utils"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
 
 /***/ }),
 /* 6 */