@lottiefiles/dotlottie-web 0.43.0 → 0.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/dotlottie-player.wasm +0 -0
  2. package/dist/index.cjs +19 -19
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +30 -11
  5. package/dist/index.d.ts +30 -11
  6. package/dist/index.js +17 -18
  7. package/dist/index.js.map +1 -1
  8. package/package.json +3 -2
package/dist/index.d.cts CHANGED
@@ -1,17 +1,17 @@
1
- interface Marker {
2
- duration: number;
1
+ type Marker = {
3
2
  name: string;
4
3
  time: number;
5
- }
4
+ duration: number;
5
+ };
6
6
 
7
7
  /**
8
8
  * Represents the different types of events that can be dispatched.
9
9
  */
10
- type EventType = 'complete' | 'frame' | 'load' | 'loadError' | 'loop' | 'pause' | 'play' | 'stop' | 'destroy' | 'freeze' | 'unfreeze' | 'render' | 'ready';
10
+ type EventType = 'complete' | 'frame' | 'load' | 'loadError' | 'renderError' | 'loop' | 'pause' | 'play' | 'stop' | 'destroy' | 'freeze' | 'unfreeze' | 'render' | 'ready';
11
11
  /**
12
12
  * Maps an event type string to its respective event interface.
13
13
  */
14
- type EventByType<T> = T extends 'complete' ? CompleteEvent : T extends 'frame' ? FrameEvent : T extends 'load' ? LoadEvent : T extends 'loadError' ? LoadErrorEvent : T extends 'loop' ? LoopEvent : T extends 'pause' ? PauseEvent : T extends 'play' ? PlayEvent : T extends 'stop' ? StopEvent : T extends 'destroy' ? DestroyEvent : T extends 'freeze' ? FreezeEvent : T extends 'unfreeze' ? UnfreezeEvent : T extends 'render' ? RenderEvent : T extends 'ready' ? ReadyEvent : never;
14
+ type EventByType<T> = T extends 'complete' ? CompleteEvent : T extends 'frame' ? FrameEvent : T extends 'load' ? LoadEvent : T extends 'loadError' ? LoadErrorEvent : T extends 'renderError' ? RenderErrorEvent : T extends 'loop' ? LoopEvent : T extends 'pause' ? PauseEvent : T extends 'play' ? PlayEvent : T extends 'stop' ? StopEvent : T extends 'destroy' ? DestroyEvent : T extends 'freeze' ? FreezeEvent : T extends 'unfreeze' ? UnfreezeEvent : T extends 'render' ? RenderEvent : T extends 'ready' ? ReadyEvent : never;
15
15
  /**
16
16
  * Base interface for all events.
17
17
  */
@@ -58,6 +58,13 @@ interface LoadErrorEvent extends BaseEvent {
58
58
  error: Error;
59
59
  type: 'loadError';
60
60
  }
61
+ /**
62
+ * Event fired when a loading error occurs.
63
+ */
64
+ interface RenderErrorEvent extends BaseEvent {
65
+ error: Error;
66
+ type: 'renderError';
67
+ }
61
68
  /**
62
69
  * Event fired when a completion action occurs.
63
70
  */
@@ -91,7 +98,7 @@ interface ReadyEvent extends BaseEvent {
91
98
  /**
92
99
  * Type representing all possible event types.
93
100
  */
94
- type Event = LoopEvent | FrameEvent | LoadEvent | LoadErrorEvent | CompleteEvent | PauseEvent | PlayEvent | StopEvent | DestroyEvent | FreezeEvent | UnfreezeEvent | RenderEvent | ReadyEvent;
101
+ type Event = LoopEvent | FrameEvent | LoadEvent | LoadErrorEvent | RenderErrorEvent | CompleteEvent | PauseEvent | PlayEvent | StopEvent | DestroyEvent | FreezeEvent | UnfreezeEvent | RenderEvent | ReadyEvent;
95
102
  interface EventListener<T extends EventType> {
96
103
  (event: EventByType<T>): void;
97
104
  }
@@ -119,9 +126,10 @@ interface Layout {
119
126
  fit?: Fit;
120
127
  }
121
128
  interface Config {
129
+ animationId?: string;
122
130
  autoplay?: boolean;
123
131
  backgroundColor?: string;
124
- canvas: HTMLCanvasElement;
132
+ canvas: HTMLCanvasElement | OffscreenCanvas;
125
133
  data?: Data;
126
134
  layout?: Layout;
127
135
  loop?: boolean;
@@ -151,6 +159,10 @@ interface Manifest {
151
159
  version?: string;
152
160
  }
153
161
 
162
+ interface RenderSurface {
163
+ height: number;
164
+ width: number;
165
+ }
154
166
  declare class DotLottie {
155
167
  private readonly _canvas;
156
168
  private _context;
@@ -167,11 +179,14 @@ declare class DotLottie {
167
179
  private readonly _pointerMoveMethod;
168
180
  private readonly _pointerEnterMethod;
169
181
  private readonly _pointerExitMethod;
170
- constructor(config: Config);
182
+ constructor(config: Omit<Config, 'canvas'> & {
183
+ canvas: HTMLCanvasElement | OffscreenCanvas | RenderSurface;
184
+ });
171
185
  private _dispatchError;
172
186
  private _fetchData;
173
187
  private _loadFromData;
174
188
  private _loadFromSrc;
189
+ get buffer(): Uint8Array | null;
175
190
  get activeAnimationId(): string | undefined;
176
191
  get activeThemeId(): string | undefined;
177
192
  get layout(): Layout | undefined;
@@ -196,7 +211,7 @@ declare class DotLottie {
196
211
  get totalFrames(): number;
197
212
  get duration(): number;
198
213
  get segmentDuration(): number;
199
- get canvas(): HTMLCanvasElement | OffscreenCanvas;
214
+ get canvas(): HTMLCanvasElement | OffscreenCanvas | RenderSurface;
200
215
  load(config: Omit<Config, 'canvas'>): void;
201
216
  private _render;
202
217
  private _draw;
@@ -340,7 +355,7 @@ declare class DotLottieWorker {
340
355
  get duration(): number;
341
356
  get isReady(): boolean;
342
357
  get mode(): Mode;
343
- get canvas(): HTMLCanvasElement | null;
358
+ get canvas(): HTMLCanvasElement | OffscreenCanvas | null;
344
359
  get autoplay(): boolean;
345
360
  get backgroundColor(): string;
346
361
  get loop(): boolean;
@@ -375,6 +390,10 @@ declare class DotLottieWorker {
375
390
  setMarker(marker: string): Promise<void>;
376
391
  setThemeData(themeData: string): Promise<boolean>;
377
392
  setViewport(x: number, y: number, width: number, height: number): Promise<boolean>;
393
+ animationSize(): Promise<{
394
+ height: number;
395
+ width: number;
396
+ }>;
378
397
  private _sendMessage;
379
398
  addEventListener<T extends EventType>(type: T, listener: EventListener<T>): void;
380
399
  removeEventListener<T extends EventType>(type: T, listener?: EventListener<T>): void;
@@ -394,4 +413,4 @@ declare class DotLottieWorker {
394
413
  private _cleanupStateMachineListeners;
395
414
  }
396
415
 
397
- export { type BaseEvent, type CompleteEvent, type Config, type Data, type DestroyEvent, DotLottie, type DotLottieInstanceState, DotLottieWorker, type Event, type EventListener, EventManager, type EventType, type Fit, type FrameEvent, type FreezeEvent, type Layout, type LoadErrorEvent, type LoadEvent, type LoopEvent, type Manifest, type Mode, type PauseEvent, type PlayEvent, type ReadyEvent, type RenderConfig, type RenderEvent, type StopEvent, type UnfreezeEvent };
416
+ export { type BaseEvent, type CompleteEvent, type Config, type Data, type DestroyEvent, DotLottie, type DotLottieInstanceState, DotLottieWorker, type Event, type EventListener, EventManager, type EventType, type Fit, type FrameEvent, type FreezeEvent, type Layout, type LoadErrorEvent, type LoadEvent, type LoopEvent, type Manifest, type Mode, type PauseEvent, type PlayEvent, type ReadyEvent, type RenderConfig, type RenderErrorEvent, type RenderEvent, type StopEvent, type UnfreezeEvent };
package/dist/index.d.ts CHANGED
@@ -1,17 +1,17 @@
1
- interface Marker {
2
- duration: number;
1
+ type Marker = {
3
2
  name: string;
4
3
  time: number;
5
- }
4
+ duration: number;
5
+ };
6
6
 
7
7
  /**
8
8
  * Represents the different types of events that can be dispatched.
9
9
  */
10
- type EventType = 'complete' | 'frame' | 'load' | 'loadError' | 'loop' | 'pause' | 'play' | 'stop' | 'destroy' | 'freeze' | 'unfreeze' | 'render' | 'ready';
10
+ type EventType = 'complete' | 'frame' | 'load' | 'loadError' | 'renderError' | 'loop' | 'pause' | 'play' | 'stop' | 'destroy' | 'freeze' | 'unfreeze' | 'render' | 'ready';
11
11
  /**
12
12
  * Maps an event type string to its respective event interface.
13
13
  */
14
- type EventByType<T> = T extends 'complete' ? CompleteEvent : T extends 'frame' ? FrameEvent : T extends 'load' ? LoadEvent : T extends 'loadError' ? LoadErrorEvent : T extends 'loop' ? LoopEvent : T extends 'pause' ? PauseEvent : T extends 'play' ? PlayEvent : T extends 'stop' ? StopEvent : T extends 'destroy' ? DestroyEvent : T extends 'freeze' ? FreezeEvent : T extends 'unfreeze' ? UnfreezeEvent : T extends 'render' ? RenderEvent : T extends 'ready' ? ReadyEvent : never;
14
+ type EventByType<T> = T extends 'complete' ? CompleteEvent : T extends 'frame' ? FrameEvent : T extends 'load' ? LoadEvent : T extends 'loadError' ? LoadErrorEvent : T extends 'renderError' ? RenderErrorEvent : T extends 'loop' ? LoopEvent : T extends 'pause' ? PauseEvent : T extends 'play' ? PlayEvent : T extends 'stop' ? StopEvent : T extends 'destroy' ? DestroyEvent : T extends 'freeze' ? FreezeEvent : T extends 'unfreeze' ? UnfreezeEvent : T extends 'render' ? RenderEvent : T extends 'ready' ? ReadyEvent : never;
15
15
  /**
16
16
  * Base interface for all events.
17
17
  */
@@ -58,6 +58,13 @@ interface LoadErrorEvent extends BaseEvent {
58
58
  error: Error;
59
59
  type: 'loadError';
60
60
  }
61
+ /**
62
+ * Event fired when a loading error occurs.
63
+ */
64
+ interface RenderErrorEvent extends BaseEvent {
65
+ error: Error;
66
+ type: 'renderError';
67
+ }
61
68
  /**
62
69
  * Event fired when a completion action occurs.
63
70
  */
@@ -91,7 +98,7 @@ interface ReadyEvent extends BaseEvent {
91
98
  /**
92
99
  * Type representing all possible event types.
93
100
  */
94
- type Event = LoopEvent | FrameEvent | LoadEvent | LoadErrorEvent | CompleteEvent | PauseEvent | PlayEvent | StopEvent | DestroyEvent | FreezeEvent | UnfreezeEvent | RenderEvent | ReadyEvent;
101
+ type Event = LoopEvent | FrameEvent | LoadEvent | LoadErrorEvent | RenderErrorEvent | CompleteEvent | PauseEvent | PlayEvent | StopEvent | DestroyEvent | FreezeEvent | UnfreezeEvent | RenderEvent | ReadyEvent;
95
102
  interface EventListener<T extends EventType> {
96
103
  (event: EventByType<T>): void;
97
104
  }
@@ -119,9 +126,10 @@ interface Layout {
119
126
  fit?: Fit;
120
127
  }
121
128
  interface Config {
129
+ animationId?: string;
122
130
  autoplay?: boolean;
123
131
  backgroundColor?: string;
124
- canvas: HTMLCanvasElement;
132
+ canvas: HTMLCanvasElement | OffscreenCanvas;
125
133
  data?: Data;
126
134
  layout?: Layout;
127
135
  loop?: boolean;
@@ -151,6 +159,10 @@ interface Manifest {
151
159
  version?: string;
152
160
  }
153
161
 
162
+ interface RenderSurface {
163
+ height: number;
164
+ width: number;
165
+ }
154
166
  declare class DotLottie {
155
167
  private readonly _canvas;
156
168
  private _context;
@@ -167,11 +179,14 @@ declare class DotLottie {
167
179
  private readonly _pointerMoveMethod;
168
180
  private readonly _pointerEnterMethod;
169
181
  private readonly _pointerExitMethod;
170
- constructor(config: Config);
182
+ constructor(config: Omit<Config, 'canvas'> & {
183
+ canvas: HTMLCanvasElement | OffscreenCanvas | RenderSurface;
184
+ });
171
185
  private _dispatchError;
172
186
  private _fetchData;
173
187
  private _loadFromData;
174
188
  private _loadFromSrc;
189
+ get buffer(): Uint8Array | null;
175
190
  get activeAnimationId(): string | undefined;
176
191
  get activeThemeId(): string | undefined;
177
192
  get layout(): Layout | undefined;
@@ -196,7 +211,7 @@ declare class DotLottie {
196
211
  get totalFrames(): number;
197
212
  get duration(): number;
198
213
  get segmentDuration(): number;
199
- get canvas(): HTMLCanvasElement | OffscreenCanvas;
214
+ get canvas(): HTMLCanvasElement | OffscreenCanvas | RenderSurface;
200
215
  load(config: Omit<Config, 'canvas'>): void;
201
216
  private _render;
202
217
  private _draw;
@@ -340,7 +355,7 @@ declare class DotLottieWorker {
340
355
  get duration(): number;
341
356
  get isReady(): boolean;
342
357
  get mode(): Mode;
343
- get canvas(): HTMLCanvasElement | null;
358
+ get canvas(): HTMLCanvasElement | OffscreenCanvas | null;
344
359
  get autoplay(): boolean;
345
360
  get backgroundColor(): string;
346
361
  get loop(): boolean;
@@ -375,6 +390,10 @@ declare class DotLottieWorker {
375
390
  setMarker(marker: string): Promise<void>;
376
391
  setThemeData(themeData: string): Promise<boolean>;
377
392
  setViewport(x: number, y: number, width: number, height: number): Promise<boolean>;
393
+ animationSize(): Promise<{
394
+ height: number;
395
+ width: number;
396
+ }>;
378
397
  private _sendMessage;
379
398
  addEventListener<T extends EventType>(type: T, listener: EventListener<T>): void;
380
399
  removeEventListener<T extends EventType>(type: T, listener?: EventListener<T>): void;
@@ -394,4 +413,4 @@ declare class DotLottieWorker {
394
413
  private _cleanupStateMachineListeners;
395
414
  }
396
415
 
397
- export { type BaseEvent, type CompleteEvent, type Config, type Data, type DestroyEvent, DotLottie, type DotLottieInstanceState, DotLottieWorker, type Event, type EventListener, EventManager, type EventType, type Fit, type FrameEvent, type FreezeEvent, type Layout, type LoadErrorEvent, type LoadEvent, type LoopEvent, type Manifest, type Mode, type PauseEvent, type PlayEvent, type ReadyEvent, type RenderConfig, type RenderEvent, type StopEvent, type UnfreezeEvent };
416
+ export { type BaseEvent, type CompleteEvent, type Config, type Data, type DestroyEvent, DotLottie, type DotLottieInstanceState, DotLottieWorker, type Event, type EventListener, EventManager, type EventType, type Fit, type FrameEvent, type FreezeEvent, type Layout, type LoadErrorEvent, type LoadEvent, type LoopEvent, type Manifest, type Mode, type PauseEvent, type PlayEvent, type ReadyEvent, type RenderConfig, type RenderErrorEvent, type RenderEvent, type StopEvent, type UnfreezeEvent };