@drincs/pixi-vn 1.5.19 → 1.6.1

package/dist/canvas.d.cts

@@ -4,6 +4,7 @@ export { TextureSourceLike, Ticker as TickerValue } from '@drincs/pixi-vn/pixi.j
 import { ObjectTarget, AnimationOptions as AnimationOptions$1, At, SequenceOptions as SequenceOptions$1 } from 'motion';
 export { AnimationOptions as MotionAnimationOptions } from 'motion';
 import { Devtools } from '@pixi/devtools';
+import { OnErrorHandler } from '@drincs/pixi-vn/core';
 
 interface MotionComponentExtension {
     pivot?: number;
@@ -408,10 +409,12 @@ declare class CanvasBaseItem<T2 extends CanvasBaseItemMemory> {
     constructor(..._options: any);
     /**
      * This method return the memory of the canvas element.
+     * @throws {PixiError} when the method is not overridden in the subclass.
      */
     get memory(): T2;
     /**
      * This method set the memory of the canvas element.
+     * @throws {PixiError} when the method is not overridden in the subclass.
      */
     setMemory(_value: T2): Promise<void> | void;
     /**
@@ -425,23 +428,21 @@ declare class CanvasBaseItem<T2 extends CanvasBaseItemMemory> {
  */
 interface CanvasBaseItemMemory {
     pixivnId: string;
+    /**
+     * The index of the container in its parent, if it has one
+     */
+    index?: number;
+    /**
+     * The label of the parent container, if it has one
+     */
+    parentLabel?: string;
+    label?: string;
     zIndex?: number;
 }
 
 interface CanvasBaseInterface<T2 extends CanvasBaseItemMemory> extends CanvasBaseItem<T2>, Container$1 {
 }
 
-type PauseTickerType = {
-    /**
-     * Ticker ids excluded
-     */
-    tickerIdsExcluded?: string[];
-    /**
-     * Ticker ids included
-     */
-    tickerIdsIncluded?: string[];
-};
-
 /**
  * Interface exported canvas
  */
@@ -462,12 +463,6 @@ interface CanvasGameState {
      * @deprecated
      */
     elementAliasesOrder: string[];
-    /**
-     * @deprecated
-     */
-    tickersOnPause: {
-        [alias: string]: PauseTickerType;
-    };
     tickersToCompleteOnStepEnd: {
         tikersIds: {
             id: string;
@@ -755,6 +750,7 @@ interface CanvasManagerInterface {
         id: string | string[];
     }): void;
     /**
+     * @deprecated Use {@link findTicker}(id).paused
      * Check if a ticker is paused.
      * @param alias The alias of the canvas element that will use the ticker.
      * @param tickerId The ticker that will be checked.
@@ -1115,10 +1111,6 @@ interface AssetMemory {
 }
 
 interface SpriteBaseMemory extends SpriteOptions$1, CanvasBaseItemMemory, ListenerExtensionMemory, AdditionalPositionsExtensionProps {
-    /**
-     * @deprecated
-     */
-    textureImage?: AssetMemory;
     textureData?: AssetMemory;
 }
 /**
@@ -1338,14 +1330,6 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
      * The elements contained in this container
      */
     elements: CanvasBaseItemMemory[];
-    /**
-     * The index of the container in its parent, if it has one
-     */
-    index?: number;
-    /**
-     * The label of the parent container, if it has one
-     */
-    parentLabel?: string;
 }
 
 /**
@@ -1479,6 +1463,10 @@ declare class ImageContainer extends Container<ImageSprite, ImageContainerMemory
 declare class CanvasManagerStatic {
     private constructor();
     private static _app;
+    /**
+     * The Pixi.js application instance.
+     * @throws {PixiError} when the canvas has not been initialized yet (i.e. before calling `Game.init()`).
+     */
     static get app(): Application<_drincs_pixi_vn_pixi_js.Renderer>;
     static get gameLayer(): _drincs_pixi_vn_pixi_js.Container<_drincs_pixi_vn_pixi_js.ContainerChild>;
     /**
@@ -1543,12 +1531,6 @@ declare class CanvasManagerStatic {
             alias: string;
         }[];
     };
-    /**
-     * @deprecated
-     */
-    static _tickersOnPause: {
-        [aliasOrId: string]: PauseTickerType;
-    };
     static generateTickerId(...args: any[]): string;
     static addTickerTimeoutInfo(aliases: string | string[], ticker: string, timeout: string, canBeDeletedBeforeEnd: boolean): void;
     static removeTickerTimeoutInfo(timeout: NodeJS.Timeout | string): void;
@@ -1965,6 +1947,13 @@ declare function pushIn(alias: string, component?: TComponent, props?: PushInOut
  */
 declare function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
 
+/**
+ * Canvas error handler: when a `PixiError` contains `canvasElementInfo`,
+ * draw a simple `ErrorGraphics` placeholder on the canvas so the scene
+ * remains visible and debuggable.
+ */
+declare function drawCanvasErrorHandler(): OnErrorHandler;
+
 /**
  * Add a list of images in the container, after that, the images are added to the canvas.
  * Is the same that {@link showImageContainer}, but the image is not shown.
@@ -2001,6 +1990,7 @@ declare function showImageContainer(alias: string, imageUrls: string[], options?
  * @param imageUrl is the url of the image. If you don't provide the url, then the alias is used as the url.
  * @param options The options of the image.
  * @returns the container of the image.
+ * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let bunny1 = addImage("bunny1", "https://pixijs.com/assets/bunny1.png")
@@ -2017,6 +2007,7 @@ declare function addImage(alias: string, imageUrl?: string, options?: ImageSprit
  * @param imageUrl The url of the image.
  * @param options The options of the image.
  * @returns A promise that is resolved when the image is loaded.
+ * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let bunny1 = showImage("bunny1", "https://pixijs.com/assets/bunny1.png")
@@ -2042,9 +2033,10 @@ declare function showText(alias: string, text: string, options?: Omit<TextOption
 /**
  * Get a texture from a url.
  * @param textureAlias is the url of the file.
- * @returns the texture of the image or video, or a text with the error.
+ * @returns the texture of the image or video, or `undefined` when `textureAlias` is the `"EMPTY"` sentinel value.
+ * @throws {PixiError} when the alias is missing, the asset is not found in the cache/network, or the loaded resource is not a `Texture`.
  */
-declare function getTexture(textureAlias?: string): Promise<Texture$1 | void>;
+declare function getTexture(textureAlias?: string): Promise<Texture$1 | undefined>;
 
 /**
  * Add a video in the canvas.
@@ -2054,6 +2046,7 @@ declare function getTexture(textureAlias?: string): Promise<Texture$1 | void>;
  * @param videoUrl is the url of the video. If you don't provide the url, then the alias is used as the url.
  * @param options The options of the video.
  * @returns the container of the video.
+ * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let video1 = addVideo("video1", "https://pixijs.com/assets/video1.mp4")
@@ -2070,6 +2063,7 @@ declare function addVideo(alias: string, videoUrl?: string, options?: VideoSprit
  * @param videoUrl The url of the video.
  * @param options The options of the video.
  * @returns A promise that is resolved when the video is loaded.
+ * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let video1 = showVideo("video1", "https://pixijs.com/assets/video1.mp4")
@@ -2108,4 +2102,4 @@ declare const UPDATE_PRIORITY: typeof _drincs_pixi_vn_pixi_js.UPDATE_PRIORITY;
 
 declare const canvas: CanvasManagerInterface;
 
-export { type AdditionalPositionsExtension, type AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetMemory, Assets, type CanvasBaseInterface, CanvasBaseItem, type CanvasBaseItemMemory, type CanvasGameState, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, Color, type CommonTickerProps, Container, type ContainerChild, type ContainerMemory, type ContainerOptions, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type Layer, type ListenerExtension, type ListenerExtensionMemory, type MoveInOutProps, type OnEventsHandlers, type PauseType, type PushInOutProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, RegisteredTickers, type RepeatType, type ShakeEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, Text, type TextMemory, type TextOptions, TextStyle, Texture, type Ticker, type TickerArgs, TickerBase, type TickerHistory, type TickerInfo, type TickerProgrationExponential, type TickerProgrationLinear, type TickerProgrationType, type TickerTimeoutHistory, type TickersSequence, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type ZoomInOutProps, addImage, addImageCointainer, addListenerHandler, addVideo, analizePositionsExtensionProps, canvas, canvasComponentDecorator, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, tickerDecorator, zoomIn, zoomOut };
+export { type AdditionalPositionsExtension, type AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetMemory, Assets, type CanvasBaseInterface, CanvasBaseItem, type CanvasBaseItemMemory, type CanvasGameState, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, Color, type CommonTickerProps, Container, type ContainerChild, type ContainerMemory, type ContainerOptions, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type Layer, type ListenerExtension, type ListenerExtensionMemory, type MoveInOutProps, type OnEventsHandlers, type PauseType, type PushInOutProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, RegisteredTickers, type RepeatType, type ShakeEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, Text, type TextMemory, type TextOptions, TextStyle, Texture, type Ticker, type TickerArgs, TickerBase, type TickerHistory, type TickerInfo, type TickerProgrationExponential, type TickerProgrationLinear, type TickerProgrationType, type TickerTimeoutHistory, type TickersSequence, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type ZoomInOutProps, addImage, addImageCointainer, addListenerHandler, addVideo, analizePositionsExtensionProps, canvas, canvasComponentDecorator, drawCanvasErrorHandler, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, tickerDecorator, zoomIn, zoomOut };

package/dist/canvas.d.ts

@@ -4,6 +4,7 @@ export { TextureSourceLike, Ticker as TickerValue } from '@drincs/pixi-vn/pixi.j
 import { ObjectTarget, AnimationOptions as AnimationOptions$1, At, SequenceOptions as SequenceOptions$1 } from 'motion';
 export { AnimationOptions as MotionAnimationOptions } from 'motion';
 import { Devtools } from '@pixi/devtools';
+import { OnErrorHandler } from '@drincs/pixi-vn/core';
 
 interface MotionComponentExtension {
     pivot?: number;
@@ -408,10 +409,12 @@ declare class CanvasBaseItem<T2 extends CanvasBaseItemMemory> {
     constructor(..._options: any);
     /**
      * This method return the memory of the canvas element.
+     * @throws {PixiError} when the method is not overridden in the subclass.
      */
     get memory(): T2;
     /**
      * This method set the memory of the canvas element.
+     * @throws {PixiError} when the method is not overridden in the subclass.
      */
     setMemory(_value: T2): Promise<void> | void;
     /**
@@ -425,23 +428,21 @@ declare class CanvasBaseItem<T2 extends CanvasBaseItemMemory> {
  */
 interface CanvasBaseItemMemory {
     pixivnId: string;
+    /**
+     * The index of the container in its parent, if it has one
+     */
+    index?: number;
+    /**
+     * The label of the parent container, if it has one
+     */
+    parentLabel?: string;
+    label?: string;
     zIndex?: number;
 }
 
 interface CanvasBaseInterface<T2 extends CanvasBaseItemMemory> extends CanvasBaseItem<T2>, Container$1 {
 }
 
-type PauseTickerType = {
-    /**
-     * Ticker ids excluded
-     */
-    tickerIdsExcluded?: string[];
-    /**
-     * Ticker ids included
-     */
-    tickerIdsIncluded?: string[];
-};
-
 /**
  * Interface exported canvas
  */
@@ -462,12 +463,6 @@ interface CanvasGameState {
      * @deprecated
      */
     elementAliasesOrder: string[];
-    /**
-     * @deprecated
-     */
-    tickersOnPause: {
-        [alias: string]: PauseTickerType;
-    };
     tickersToCompleteOnStepEnd: {
         tikersIds: {
             id: string;
@@ -755,6 +750,7 @@ interface CanvasManagerInterface {
         id: string | string[];
     }): void;
     /**
+     * @deprecated Use {@link findTicker}(id).paused
      * Check if a ticker is paused.
      * @param alias The alias of the canvas element that will use the ticker.
      * @param tickerId The ticker that will be checked.
@@ -1115,10 +1111,6 @@ interface AssetMemory {
 }
 
 interface SpriteBaseMemory extends SpriteOptions$1, CanvasBaseItemMemory, ListenerExtensionMemory, AdditionalPositionsExtensionProps {
-    /**
-     * @deprecated
-     */
-    textureImage?: AssetMemory;
     textureData?: AssetMemory;
 }
 /**
@@ -1338,14 +1330,6 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
      * The elements contained in this container
      */
     elements: CanvasBaseItemMemory[];
-    /**
-     * The index of the container in its parent, if it has one
-     */
-    index?: number;
-    /**
-     * The label of the parent container, if it has one
-     */
-    parentLabel?: string;
 }
 
 /**
@@ -1479,6 +1463,10 @@ declare class ImageContainer extends Container<ImageSprite, ImageContainerMemory
 declare class CanvasManagerStatic {
     private constructor();
     private static _app;
+    /**
+     * The Pixi.js application instance.
+     * @throws {PixiError} when the canvas has not been initialized yet (i.e. before calling `Game.init()`).
+     */
     static get app(): Application<_drincs_pixi_vn_pixi_js.Renderer>;
     static get gameLayer(): _drincs_pixi_vn_pixi_js.Container<_drincs_pixi_vn_pixi_js.ContainerChild>;
     /**
@@ -1543,12 +1531,6 @@ declare class CanvasManagerStatic {
             alias: string;
         }[];
     };
-    /**
-     * @deprecated
-     */
-    static _tickersOnPause: {
-        [aliasOrId: string]: PauseTickerType;
-    };
     static generateTickerId(...args: any[]): string;
     static addTickerTimeoutInfo(aliases: string | string[], ticker: string, timeout: string, canBeDeletedBeforeEnd: boolean): void;
     static removeTickerTimeoutInfo(timeout: NodeJS.Timeout | string): void;
@@ -1965,6 +1947,13 @@ declare function pushIn(alias: string, component?: TComponent, props?: PushInOut
  */
 declare function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
 
+/**
+ * Canvas error handler: when a `PixiError` contains `canvasElementInfo`,
+ * draw a simple `ErrorGraphics` placeholder on the canvas so the scene
+ * remains visible and debuggable.
+ */
+declare function drawCanvasErrorHandler(): OnErrorHandler;
+
 /**
  * Add a list of images in the container, after that, the images are added to the canvas.
  * Is the same that {@link showImageContainer}, but the image is not shown.
@@ -2001,6 +1990,7 @@ declare function showImageContainer(alias: string, imageUrls: string[], options?
  * @param imageUrl is the url of the image. If you don't provide the url, then the alias is used as the url.
  * @param options The options of the image.
  * @returns the container of the image.
+ * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let bunny1 = addImage("bunny1", "https://pixijs.com/assets/bunny1.png")
@@ -2017,6 +2007,7 @@ declare function addImage(alias: string, imageUrl?: string, options?: ImageSprit
  * @param imageUrl The url of the image.
  * @param options The options of the image.
  * @returns A promise that is resolved when the image is loaded.
+ * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let bunny1 = showImage("bunny1", "https://pixijs.com/assets/bunny1.png")
@@ -2042,9 +2033,10 @@ declare function showText(alias: string, text: string, options?: Omit<TextOption
 /**
  * Get a texture from a url.
  * @param textureAlias is the url of the file.
- * @returns the texture of the image or video, or a text with the error.
+ * @returns the texture of the image or video, or `undefined` when `textureAlias` is the `"EMPTY"` sentinel value.
+ * @throws {PixiError} when the alias is missing, the asset is not found in the cache/network, or the loaded resource is not a `Texture`.
  */
-declare function getTexture(textureAlias?: string): Promise<Texture$1 | void>;
+declare function getTexture(textureAlias?: string): Promise<Texture$1 | undefined>;
 
 /**
  * Add a video in the canvas.
@@ -2054,6 +2046,7 @@ declare function getTexture(textureAlias?: string): Promise<Texture$1 | void>;
  * @param videoUrl is the url of the video. If you don't provide the url, then the alias is used as the url.
  * @param options The options of the video.
  * @returns the container of the video.
+ * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let video1 = addVideo("video1", "https://pixijs.com/assets/video1.mp4")
@@ -2070,6 +2063,7 @@ declare function addVideo(alias: string, videoUrl?: string, options?: VideoSprit
  * @param videoUrl The url of the video.
  * @param options The options of the video.
  * @returns A promise that is resolved when the video is loaded.
+ * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
  * @example
  * ```typescript
  * let video1 = showVideo("video1", "https://pixijs.com/assets/video1.mp4")
@@ -2108,4 +2102,4 @@ declare const UPDATE_PRIORITY: typeof _drincs_pixi_vn_pixi_js.UPDATE_PRIORITY;
 
 declare const canvas: CanvasManagerInterface;
 
-export { type AdditionalPositionsExtension, type AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetMemory, Assets, type CanvasBaseInterface, CanvasBaseItem, type CanvasBaseItemMemory, type CanvasGameState, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, Color, type CommonTickerProps, Container, type ContainerChild, type ContainerMemory, type ContainerOptions, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type Layer, type ListenerExtension, type ListenerExtensionMemory, type MoveInOutProps, type OnEventsHandlers, type PauseType, type PushInOutProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, RegisteredTickers, type RepeatType, type ShakeEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, Text, type TextMemory, type TextOptions, TextStyle, Texture, type Ticker, type TickerArgs, TickerBase, type TickerHistory, type TickerInfo, type TickerProgrationExponential, type TickerProgrationLinear, type TickerProgrationType, type TickerTimeoutHistory, type TickersSequence, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type ZoomInOutProps, addImage, addImageCointainer, addListenerHandler, addVideo, analizePositionsExtensionProps, canvas, canvasComponentDecorator, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, tickerDecorator, zoomIn, zoomOut };
+export { type AdditionalPositionsExtension, type AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetMemory, Assets, type CanvasBaseInterface, CanvasBaseItem, type CanvasBaseItemMemory, type CanvasGameState, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, Color, type CommonTickerProps, Container, type ContainerChild, type ContainerMemory, type ContainerOptions, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type Layer, type ListenerExtension, type ListenerExtensionMemory, type MoveInOutProps, type OnEventsHandlers, type PauseType, type PushInOutProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, RegisteredTickers, type RepeatType, type ShakeEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, Text, type TextMemory, type TextOptions, TextStyle, Texture, type Ticker, type TickerArgs, TickerBase, type TickerHistory, type TickerInfo, type TickerProgrationExponential, type TickerProgrationLinear, type TickerProgrationType, type TickerTimeoutHistory, type TickersSequence, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type ZoomInOutProps, addImage, addImageCointainer, addListenerHandler, addVideo, analizePositionsExtensionProps, canvas, canvasComponentDecorator, drawCanvasErrorHandler, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, tickerDecorator, zoomIn, zoomOut };