@rive-app/canvas 2.20.2 → 2.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas",
-  "version": "2.20.2",
+  "version": "2.21.0",
   "description": "Rive's canvas based web api.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -516,6 +516,44 @@ export declare class Rive {
      * @param path the path the input is located at an artboard level
      */
     fireStateAtPath(inputName: string, path: string): void;
+    private retrieveTextAtPath;
+    /**
+     * Retrieves the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param path The path to the text run within the artboard
+     * @returns The text value of the text run, or undefined if not found
+     *
+     * @example
+     * // Get the text value for a text run named "title" at one nested artboard deep
+     * const titleText = riveInstance.getTextRunValueAtPath("title", "artboard1");
+     *
+     * @example
+     * // Get the text value for a text run named "subtitle" within a nested group two artboards deep
+     * const subtitleText = riveInstance.getTextRunValueAtPath("subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    getTextRunValueAtPath(textName: string, path: string): string | undefined;
+    /**
+     * Sets the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param value The new text value to set
+     * @param path The path to the text run within the artboard
+     * @returns void
+     *
+     * @example
+     * // Set the text value for a text run named "title" at one nested artboard deep
+     * riveInstance.setTextRunValueAtPath("title", "New Title", "artboard1");
+     *
+     * @example
+     * // Set the text value for a text run named "subtitle" within a nested group two artboards deep
+     * riveInstance.setTextRunValueAtPath("subtitle", "New Subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    setTextRunValueAtPath(textName: string, value: string, path: string): void;
     get playingStateMachineNames(): string[];
     get playingAnimationNames(): string[];
     get pausedAnimationNames(): string[];

package/rive.js

@@ -738,7 +738,7 @@ function Ya(a, b) {
     return Xa(c, a, b);
   }));
 }
-var Za, $a, db = {437404:(a, b, c, d, e) => {
+var Za, $a, db = {437468:(a, b, c, d, e) => {
   if ("undefined" === typeof window || void 0 === (window.AudioContext || window.webkitAudioContext)) {
     return 0;
   }
@@ -801,9 +801,9 @@ var Za, $a, db = {437404:(a, b, c, d, e) => {
   }
   window.h.Aa += 1;
   return 1;
-}, 439582:() => {
+}, 439646:() => {
   "undefined" !== typeof window.h && (--window.h.Aa, 0 === window.h.Aa && delete window.h);
-}, 439746:() => void 0 !== navigator.mediaDevices && void 0 !== navigator.mediaDevices.getUserMedia, 439850:() => {
+}, 439810:() => void 0 !== navigator.mediaDevices && void 0 !== navigator.mediaDevices.getUserMedia, 439914:() => {
   try {
     var a = new (window.AudioContext || window.webkitAudioContext)(), b = a.sampleRate;
     a.close();
@@ -811,7 +811,7 @@ var Za, $a, db = {437404:(a, b, c, d, e) => {
   } catch (c) {
     return 0;
   }
-}, 440021:(a, b, c, d, e, f) => {
+}, 440085:(a, b, c, d, e, f) => {
   if ("undefined" === typeof window.h) {
     return -1;
   }
@@ -857,7 +857,7 @@ var Za, $a, db = {437404:(a, b, c, d, e) => {
   a == window.h.I.ya && g.Z.connect(g.J.destination);
   g.pb = f;
   return window.h.yc(g);
-}, 442898:a => window.h.ra(a).J.sampleRate, 442971:a => {
+}, 442962:a => window.h.ra(a).J.sampleRate, 443035:a => {
   a = window.h.ra(a);
   void 0 !== a.Z && (a.Z.onaudioprocess = function() {
   }, a.Z.disconnect(), a.Z = void 0);
@@ -865,13 +865,13 @@ var Za, $a, db = {437404:(a, b, c, d, e) => {
   a.J.close();
   a.J = void 0;
   a.pb = void 0;
-}, 443371:a => {
+}, 443435:a => {
   window.h.Cb(a);
-}, 443421:a => {
+}, 443485:a => {
   a = window.h.ra(a);
   a.J.resume();
   a.state = window.h.ga.xb;
-}, 443560:a => {
+}, 443624:a => {
   a = window.h.ra(a);
   a.J.suspend();
   a.state = window.h.ga.stopped;
@@ -3357,7 +3357,7 @@ Zd();
 /* 2 */
 /***/ ((module) => {
 
-module.exports = JSON.parse('{"name":"@rive-app/canvas","version":"2.20.2","description":"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 = JSON.parse('{"name":"@rive-app/canvas","version":"2.21.0","description":"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}}');
 
 /***/ }),
 /* 3 */
@@ -5899,6 +5899,78 @@ var Rive = /** @class */ (function () {
             console.warn("Input with name: '".concat(inputName, "', at path:'").concat(path, "' is not a trigger"));
         }
     };
+    // Returns the TextValueRun object for the provided name at the given path
+    Rive.prototype.retrieveTextAtPath = function (name, path) {
+        if (!name) {
+            console.warn("No text name provided for path '".concat(path, "'"));
+            return;
+        }
+        if (!path) {
+            console.warn("No path provided for text '".concat(name, "'"));
+            return;
+        }
+        if (!this.artboard) {
+            console.warn("Tried to access text: '".concat(name, "', at path: '").concat(path, "', but the Artboard is null"));
+            return;
+        }
+        var text = this.artboard.textByPath(name, path);
+        if (!text) {
+            console.warn("Could not access text with name: '".concat(name, "', at path:'").concat(path, "'"));
+            return;
+        }
+        return text;
+    };
+    /**
+     * Retrieves the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param path The path to the text run within the artboard
+     * @returns The text value of the text run, or undefined if not found
+     *
+     * @example
+     * // Get the text value for a text run named "title" at one nested artboard deep
+     * const titleText = riveInstance.getTextRunValueAtPath("title", "artboard1");
+     *
+     * @example
+     * // Get the text value for a text run named "subtitle" within a nested group two artboards deep
+     * const subtitleText = riveInstance.getTextRunValueAtPath("subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    Rive.prototype.getTextRunValueAtPath = function (textName, path) {
+        var run = this.retrieveTextAtPath(textName, path);
+        if (!run) {
+            console.warn("Could not get text with name: '".concat(textName, "', at path:'").concat(path, "'"));
+            return;
+        }
+        return run.text;
+    };
+    /**
+     * Sets the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param value The new text value to set
+     * @param path The path to the text run within the artboard
+     * @returns void
+     *
+     * @example
+     * // Set the text value for a text run named "title" at one nested artboard deep
+     * riveInstance.setTextRunValueAtPath("title", "New Title", "artboard1");
+     *
+     * @example
+     * // Set the text value for a text run named "subtitle" within a nested group two artboards deep
+     * riveInstance.setTextRunValueAtPath("subtitle", "New Subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    Rive.prototype.setTextRunValueAtPath = function (textName, value, path) {
+        var run = this.retrieveTextAtPath(textName, path);
+        if (!run) {
+            console.warn("Could not set text with name: '".concat(textName, "', at path:'").concat(path, "'"));
+            return;
+        }
+        run.text = value;
+    };
     Object.defineProperty(Rive.prototype, "playingStateMachineNames", {
         // Returns a list of playing machine names
         get: function () {