@rive-app/canvas-single 2.42.2 → 2.43.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas-single",
-  "version": "2.42.2",
+  "version": "2.43.0",
   "description": "Rive's high-level canvas based web api all in one js file.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -131,7 +131,7 @@ export declare class StateMachineInput {
     delete(): void;
 }
 /**
- * @deprecated Rive Events are deprecated and will be removed in a future major
+ * @deprecated Subscribing to Rive Events at runtime is deprecated and will be removed in a future major
  * version: please use data binding instead. See
  * {@link https://rive.app/docs/runtimes/web/rive-events} for how to migrate.
  */
@@ -177,14 +177,15 @@ export declare enum EventType {
     Draw = "draw",
     Advance = "advance",
     /**
-     * @deprecated State change events are deprecated and will be removed in a
-     * future major version. Use data binding (view model property observers) or
-     * state machine actions to react to changes from your graphic instead. See
+     * @deprecated Subscribing to state change events at runtime is deprecated
+     * and will be removed in a future major version: use data binding (view model
+     * property observers) or state machine actions to react to changes from your
+     * graphic instead. See
      * {@link https://rive.app/docs/editor/state-machine/states#actions} for more details.
      */
     StateChange = "statechange",
     /**
-     * @deprecated Rive Events are deprecated and will be removed in a future
+     * @deprecated Subscribing to Rive Events at runtime is deprecated and will be removed in a future
      * major version: please use data binding instead. See
      * {@link https://rive.app/docs/runtimes/web/rive-events} for how to migrate.
      */
@@ -192,11 +193,36 @@ export declare enum EventType {
     AudioStatusChange = "audiostatuschange"
 }
 /**
- * @deprecated Rive Events are deprecated and will be removed in a future major
+ * @deprecated Subscribing to Rive Events at runtime is deprecated and will be removed in a future major
  * version: please use data binding instead. See
  * {@link https://rive.app/docs/runtimes/web/rive-events} for how to migrate.
  */
 export type RiveEventPayload = rc.RiveEvent | rc.OpenUrlEvent;
+/**
+ * The deprecations this runtime warns about. Each warning prints its own id, so
+ * the value can be copied straight out of the console into
+ * {@link Rive.suppressDeprecationWarnings}.
+ */
+export declare const DeprecationKeys: {
+    readonly animationNames: "animation-names";
+    readonly animationsParam: "animations-param";
+    readonly defaultStateMachine: "default-state-machine";
+    readonly legacyConstructors: "legacy-constructors";
+    readonly legacyUnsubscribe: "legacy-unsubscribe";
+    readonly loopEvents: "loop-events";
+    readonly namesArray: "names-array";
+    readonly riveEvents: "rive-events";
+    readonly scrub: "scrub";
+    readonly stateChangeEvents: "state-change-events";
+    readonly stateMachineInputs: "state-machine-inputs";
+    readonly stateMachinesParam: "state-machines-param";
+    readonly textRuns: "text-runs";
+};
+/**
+ * An id accepted by {@link Rive.suppressDeprecationWarnings}, as either a
+ * {@link DeprecationKeys} entry or the string literal it holds.
+ */
+export type DeprecationId = (typeof DeprecationKeys)[keyof typeof DeprecationKeys];
 export interface Event {
     type: EventType;
     data?: string | string[] | LoopEvent | number | RiveEventPayload | RiveFile;
@@ -358,7 +384,7 @@ export interface RiveParameters {
      * This means any special Rive Event will have to be handled manually by subscribing to
      * EventType.RiveEvent
      *
-     * @deprecated Rive Events are deprecated and will be removed in a future
+     * @deprecated Subscribing to Rive Events at runtime is deprecated and will be removed in a future
      * major version: please use data binding instead. See
      * {@link https://rive.app/docs/runtimes/web/rive-events} for how to migrate.
      */
@@ -412,9 +438,10 @@ export interface RiveParameters {
      */
     onLoop?: EventCallback;
     /**
-     * @deprecated State change events are deprecated and will be removed in a
-     * future major version: use use data binding (view model property observers) or
-     * state machine actions to react to changes from your graphic instead. See
+     * @deprecated Subscribing to state change events at runtime is deprecated
+     * and will be removed in a future major version: use data binding (view model
+     * property observers) or state machine actions to react to changes from your
+     * graphic instead. See
      * {@link https://rive.app/docs/editor/state-machine/states#actions} for how
      * to migrate.
      */
@@ -666,6 +693,19 @@ export declare class Rive {
     private assetLoader;
     private static readonly missingErrorMessage;
     private static readonly cleanupErrorMessage;
+    /**
+     * Deprecation warnings to silence, by {@link DeprecationId}. Each warning
+     * prints the id needed to silence it, so you can copy it out of the console.
+     *
+     * ```ts
+     * Rive.suppressDeprecationWarnings = ["rive-events", "text-runs"];
+     * ```
+     *
+     * Assigning replaces the whole list.
+     * There is no option to silence everything
+     */
+    static get suppressDeprecationWarnings(): readonly DeprecationId[];
+    static set suppressDeprecationWarnings(ids: readonly DeprecationId[]);
     private shouldDisableRiveListeners;
     private automaticallyHandleEvents;
     private dispatchPointerExit;