@rive-app/webgl-single 2.15.6 → 2.17.0

package/package.json

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

package/rive.d.ts

@@ -123,7 +123,7 @@ export declare enum EventType {
 export type RiveEventPayload = rc.RiveEvent | rc.OpenUrlEvent;
 export interface Event {
     type: EventType;
-    data?: string | string[] | LoopEvent | number | RiveEventPayload;
+    data?: string | string[] | LoopEvent | number | RiveEventPayload | RiveFile;
 }
 /**
  * Looping types: one-shot, loop, and ping-pong
@@ -189,6 +189,7 @@ export interface RiveParameters {
     canvas: HTMLCanvasElement | OffscreenCanvas;
     src?: string;
     buffer?: ArrayBuffer;
+    riveFile?: RiveFile;
     artboard?: string;
     animations?: string | string[];
     stateMachines?: string | string[];
@@ -265,6 +266,7 @@ export interface RiveParameters {
 export interface RiveLoadParameters {
     src?: string;
     buffer?: ArrayBuffer;
+    riveFile?: RiveFile;
     autoplay?: boolean;
     artboard?: string;
     animations?: string | string[];
@@ -278,6 +280,50 @@ export interface RiveResetParameters {
     stateMachines?: string | string[];
     autoplay?: boolean;
 }
+export interface RiveFileParameters {
+    src?: string;
+    buffer?: ArrayBuffer;
+    assetLoader?: AssetLoadCallback;
+    enableRiveAssetCDN?: boolean;
+    onLoad?: EventCallback;
+    onLoadError?: EventCallback;
+}
+export declare class RiveFile {
+    private static readonly missingErrorMessage;
+    private static readonly fileLoadErrorMessage;
+    private src;
+    private buffer;
+    private runtime;
+    private file;
+    private assetLoader;
+    private enableRiveAssetCDN;
+    private eventManager;
+    private referenceCount;
+    constructor(params: RiveFileParameters);
+    private initData;
+    init(): Promise<void>;
+    /**
+     * Subscribe to Rive-generated events
+     * @param type the type of event to subscribe to
+     * @param callback callback to fire when the event occurs
+     */
+    on(type: EventType, callback: EventCallback): void;
+    /**
+     * Unsubscribes from a Rive-generated event
+     * @param type the type of event to unsubscribe from
+     * @param callback the callback to unsubscribe
+     */
+    off(type: EventType, callback: EventCallback): void;
+    cleanup(): void;
+    /**
+     * Unsubscribes all Rive listeners from an event type, or everything if no type is
+     * given
+     * @param type the type of event to unsubscribe from, or all types if
+     * undefined
+     */
+    removeAllRiveEventListeners(type?: EventType): void;
+    getInstance(): rc.File;
+}
 export declare class Rive {
     private readonly canvas;
     private src;
@@ -298,6 +344,7 @@ export declare class Rive {
     private artboard;
     private eventCleanup;
     private file;
+    private riveFile;
     private eventManager;
     private taskQueue;
     private animator;
@@ -448,6 +495,27 @@ export declare class Rive {
      * @returns the inputs for the named state machine
      */
     stateMachineInputs(name: string): StateMachineInput[];
+    private retrieveInputAtPath;
+    /**
+     * Set the boolean input with the provided name at the given path with value
+     * @param input the state machine input name
+     * @param value the value to set the input to
+     * @param path the path the input is located at an artboard level
+     */
+    setBooleanStateAtPath(inputName: string, value: boolean, path: string): void;
+    /**
+     * Set the number input with the provided name at the given path with value
+     * @param input the state machine input name
+     * @param value the value to set the input to
+     * @param path the path the input is located at an artboard level
+     */
+    setNumberStateAtPath(inputName: string, value: number, path: string): void;
+    /**
+     * Fire the trigger with the provided name at the given path
+     * @param input the state machine input name
+     * @param path the path the input is located at an artboard level
+     */
+    fireStateAtPath(inputName: string, path: string): void;
     get playingStateMachineNames(): string[];
     get playingAnimationNames(): string[];
     get pausedAnimationNames(): string[];