@tsparticles/engine 3.0.3 → 3.2.0

package/types/Core/Particles.d.ts

@@ -4,14 +4,16 @@ import type { ICoordinates } from "./Interfaces/ICoordinates.js";
 import type { IDelta } from "./Interfaces/IDelta.js";
 import type { IDimension } from "./Interfaces/IDimension.js";
 import type { IMouseData } from "./Interfaces/IMouseData.js";
+import type { IParticleMover } from "./Interfaces/IParticleMover.js";
+import type { IParticleUpdater } from "./Interfaces/IParticleUpdater.js";
 import type { IParticlesOptions } from "../Options/Interfaces/Particles/IParticlesOptions.js";
-import { Particle } from "./Particle.js";
+import type { Particle } from "./Particle.js";
 import { QuadTree } from "./Utils/QuadTree.js";
 import type { RecursivePartial } from "../Types/RecursivePartial.js";
 export declare class Particles {
-    movers: import("./Interfaces/IParticleMover.js").IParticleMover[];
+    movers: IParticleMover[];
     quadTree: QuadTree;
-    updaters: import("./Interfaces/IParticleUpdater.js").IParticleUpdater[];
+    updaters: IParticleUpdater[];
     private _array;
     private readonly _container;
     private readonly _engine;
@@ -21,13 +23,14 @@ export declare class Particles {
     private _limit;
     private _needsSort;
     private _nextId;
+    private _pluginsInitialized;
     private readonly _pool;
     private _resizeFactor?;
     private _zArray;
     constructor(engine: Engine, container: Container);
     get count(): number;
-    addManualParticles(): void;
-    addParticle(position?: ICoordinates, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string, initializer?: (particle: Particle) => boolean): Particle | undefined;
+    addManualParticles(): Promise<void>;
+    addParticle(position?: ICoordinates, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string, initializer?: (particle: Particle) => boolean): Promise<Particle | undefined>;
     clear(): void;
     destroy(): void;
     draw(delta: IDelta): Promise<void>;
@@ -35,13 +38,14 @@ export declare class Particles {
     find(condition: (particle: Particle) => boolean): Particle | undefined;
     get(index: number): Particle | undefined;
     handleClickMode(mode: string): void;
-    init(): void;
-    push(nb: number, mouse?: IMouseData, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string): void;
+    init(): Promise<void>;
+    initPlugins(): Promise<void>;
+    push(nb: number, mouse?: IMouseData, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string): Promise<void>;
     redraw(): Promise<void>;
     remove(particle: Particle, group?: string, override?: boolean): void;
     removeAt(index: number, quantity?: number, group?: string, override?: boolean): void;
     removeQuantity(quantity: number, group?: string): void;
-    setDensity(): void;
+    setDensity(): Promise<void>;
     setLastZIndex(zIndex: number): void;
     setResizeFactor(factor: IDimension): void;
     update(delta: IDelta): Promise<void>;

package/types/Core/Utils/Constants.d.ts

@@ -11,3 +11,6 @@ export declare const touchCancelEvent = "touchcancel";
 export declare const resizeEvent = "resize";
 export declare const visibilityChangeEvent = "visibilitychange";
 export declare const errorPrefix = "tsParticles - Error";
+export declare const percentDenominator = 100;
+export declare const halfRandom = 0.5;
+export declare const millisecondsToSeconds = 1000;

package/types/Core/Utils/ExternalInteractorBase.d.ts

@@ -4,8 +4,8 @@ import type { IExternalInteractor } from "../Interfaces/IExternalInteractor.js";
 import { InteractorType } from "../../Enums/Types/InteractorType.js";
 import type { Particle } from "../Particle.js";
 export declare abstract class ExternalInteractorBase<TContainer extends Container = Container, TParticle extends Particle = Particle> implements IExternalInteractor<TParticle> {
-    protected readonly container: TContainer;
     type: InteractorType;
+    protected readonly container: TContainer;
     protected constructor(container: TContainer);
     abstract clear(particle: TParticle, delta: IDelta): void;
     abstract init(): void;

package/types/Core/Utils/InteractionManager.d.ts

@@ -6,12 +6,12 @@ export declare class InteractionManager {
     private readonly container;
     private readonly _engine;
     private _externalInteractors;
-    private readonly _interactors;
+    private _interactors;
     private _particleInteractors;
     constructor(engine: Engine, container: Container);
     externalInteract(delta: IDelta): Promise<void>;
     handleClickMode(mode: string): void;
-    init(): void;
+    init(): Promise<void>;
     particlesInteract(particle: Particle, delta: IDelta): Promise<void>;
-    reset(particle: Particle): Promise<void>;
+    reset(particle: Particle): void;
 }

package/types/Core/Utils/ParticlesInteractorBase.d.ts

@@ -4,8 +4,8 @@ import type { IParticlesInteractor } from "../Interfaces/IParticlesInteractor.js
 import { InteractorType } from "../../Enums/Types/InteractorType.js";
 import type { Particle } from "../Particle.js";
 export declare abstract class ParticlesInteractorBase<TContainer extends Container = Container, TParticle extends Particle = Particle> implements IParticlesInteractor<TParticle> {
-    protected readonly container: TContainer;
     type: InteractorType;
+    protected readonly container: TContainer;
     protected constructor(container: TContainer);
     abstract clear(particle: TParticle, delta: IDelta): void;
     abstract init(): void;

package/types/Core/Utils/Point.d.ts

@@ -1,7 +1,7 @@
 import type { ICoordinates } from "../Interfaces/ICoordinates.js";
 import type { Particle } from "../Particle.js";
 export declare class Point {
-    readonly position: ICoordinates;
     readonly particle: Particle;
+    readonly position: ICoordinates;
     constructor(position: ICoordinates, particle: Particle);
 }

package/types/Enums/Modes/OutMode.d.ts

@@ -1,10 +1,7 @@
 export declare const enum OutMode {
     bounce = "bounce",
-    bounceHorizontal = "bounce-horizontal",
-    bounceVertical = "bounce-vertical",
     none = "none",
     out = "out",
     destroy = "destroy",
     split = "split"
 }
-export type OutModeAlt = "bounce-horizontal" | "bounce-vertical";

package/types/Options/Classes/BackgroundMask/BackgroundMaskCover.d.ts

@@ -3,7 +3,8 @@ import type { IOptionLoader } from "../../Interfaces/IOptionLoader.js";
 import { OptionsColor } from "../OptionsColor.js";
 import type { RecursivePartial } from "../../../Types/RecursivePartial.js";
 export declare class BackgroundMaskCover implements IBackgroundMaskCover, IOptionLoader<IBackgroundMaskCover> {
-    color: OptionsColor;
+    color?: OptionsColor;
+    image?: string;
     opacity: number;
     constructor();
     load(data?: RecursivePartial<IBackgroundMaskCover> | undefined): void;

package/types/Options/Classes/Options.d.ts

@@ -29,6 +29,7 @@ export declare class Options implements IOptions, IOptionLoader<IOptions> {
     fpsLimit: number;
     readonly fullScreen: FullScreen;
     readonly interactivity: Interactivity;
+    key?: string;
     manualParticles: ManualParticle[];
     name?: string;
     readonly particles: import("./Particles/ParticlesOptions.js").ParticlesOptions;

package/types/Options/Classes/Particles/Move/Move.d.ts

@@ -1,11 +1,10 @@
+import { MoveDirection, type MoveDirectionAlt } from "../../../../Enums/Directions/MoveDirection.js";
 import type { IDistance } from "../../../../Core/Interfaces/IDistance.js";
 import type { IMove } from "../../../Interfaces/Particles/Move/IMove.js";
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader.js";
 import { MoveAngle } from "./MoveAngle.js";
 import { MoveAttract } from "./MoveAttract.js";
 import { MoveCenter } from "./MoveCenter.js";
-import { MoveDirection } from "../../../../Enums/Directions/MoveDirection.js";
-import type { MoveDirectionAlt } from "../../../../Enums/Directions/MoveDirection.js";
 import { MoveGravity } from "./MoveGravity.js";
 import { MovePath } from "./Path/MovePath.js";
 import { MoveTrail } from "./MoveTrail.js";

package/types/Options/Classes/Particles/Move/OutModes.d.ts

@@ -1,14 +1,13 @@
 import type { IOptionLoader } from "../../../Interfaces/IOptionLoader.js";
 import type { IOutModes } from "../../../Interfaces/Particles/Move/IOutModes.js";
 import { OutMode } from "../../../../Enums/Modes/OutMode.js";
-import type { OutModeAlt } from "../../../../Enums/Modes/OutMode.js";
 import type { RecursivePartial } from "../../../../Types/RecursivePartial.js";
 export declare class OutModes implements IOutModes, IOptionLoader<IOutModes> {
-    bottom?: OutMode | keyof typeof OutMode | OutModeAlt;
-    default: OutMode | keyof typeof OutMode | OutModeAlt;
-    left?: OutMode | keyof typeof OutMode | OutModeAlt;
-    right?: OutMode | keyof typeof OutMode | OutModeAlt;
-    top?: OutMode | keyof typeof OutMode | OutModeAlt;
+    bottom?: OutMode | keyof typeof OutMode;
+    default: OutMode | keyof typeof OutMode;
+    left?: OutMode | keyof typeof OutMode;
+    right?: OutMode | keyof typeof OutMode;
+    top?: OutMode | keyof typeof OutMode;
     constructor();
     load(data?: RecursivePartial<IOutModes>): void;
 }

package/types/Options/Interfaces/BackgroundMask/IBackgroundMask.d.ts

@@ -1,7 +1,8 @@
 import type { IBackgroundMaskCover } from "./IBackgroundMaskCover.js";
 import type { IColor } from "../../../Core/Interfaces/Colors.js";
+import type { RecursivePartial } from "../../../Types/RecursivePartial.js";
 export interface IBackgroundMask {
     composite: GlobalCompositeOperation;
-    cover: IBackgroundMaskCover | IColor | string;
+    cover: RecursivePartial<IBackgroundMaskCover> | IColor | string;
     enable: boolean;
 }

package/types/Options/Interfaces/BackgroundMask/IBackgroundMaskCover.d.ts

@@ -1,5 +1,6 @@
 import type { IOptionsColor } from "../IOptionsColor.js";
 export interface IBackgroundMaskCover {
-    color: string | IOptionsColor;
+    color?: string | IOptionsColor;
+    image?: string;
     opacity: number;
 }

package/types/Options/Interfaces/IOptions.d.ts

@@ -21,6 +21,7 @@ export interface IOptions {
     fpsLimit: number;
     fullScreen: RecursivePartial<IFullScreen> | boolean;
     interactivity: IInteractivity;
+    key?: string;
     manualParticles: IManualParticle[];
     name?: string;
     particles: IParticlesOptions;

package/types/Options/Interfaces/Interactivity/Modes/IModes.d.ts

@@ -1,3 +1 @@
-export interface IModes {
-    [name: string]: unknown;
-}
+export type IModes = Record<string, unknown>;

package/types/Options/Interfaces/Particles/Move/IMove.d.ts

@@ -1,5 +1,4 @@
 import type { MoveDirection, MoveDirectionAlt } from "../../../../Enums/Directions/MoveDirection.js";
-import type { OutMode, OutModeAlt } from "../../../../Enums/Modes/OutMode.js";
 import type { IDistance } from "../../../../Core/Interfaces/IDistance.js";
 import type { IMoveAngle } from "./IMoveAngle.js";
 import type { IMoveAttract } from "./IMoveAttract.js";
@@ -9,6 +8,7 @@ import type { IMovePath } from "./Path/IMovePath.js";
 import type { IMoveTrail } from "./IMoveTrail.js";
 import type { IOutModes } from "./IOutModes.js";
 import type { ISpin } from "./ISpin.js";
+import type { OutMode } from "../../../../Enums/Modes/OutMode.js";
 import type { RangeValue } from "../../../../Types/RangeValue.js";
 export interface IMove {
     angle: number | IMoveAngle;
@@ -20,7 +20,7 @@ export interface IMove {
     drift: RangeValue;
     enable: boolean;
     gravity: IMoveGravity;
-    outModes: IOutModes | OutMode | keyof typeof OutMode | OutModeAlt;
+    outModes: IOutModes | OutMode | keyof typeof OutMode;
     path: IMovePath;
     random: boolean;
     size: boolean;

package/types/Options/Interfaces/Particles/Move/IOutModes.d.ts

@@ -1,8 +1,8 @@
-import type { OutMode, OutModeAlt } from "../../../../Enums/Modes/OutMode.js";
+import type { OutMode } from "../../../../Enums/Modes/OutMode.js";
 export interface IOutModes {
-    bottom?: OutMode | keyof typeof OutMode | OutModeAlt;
-    default: OutMode | keyof typeof OutMode | OutModeAlt;
-    left?: OutMode | keyof typeof OutMode | OutModeAlt;
-    right?: OutMode | keyof typeof OutMode | OutModeAlt;
-    top?: OutMode | keyof typeof OutMode | OutModeAlt;
+    bottom?: OutMode | keyof typeof OutMode;
+    default: OutMode | keyof typeof OutMode;
+    left?: OutMode | keyof typeof OutMode;
+    right?: OutMode | keyof typeof OutMode;
+    top?: OutMode | keyof typeof OutMode;
 }

package/types/Types/CustomEventArgs.d.ts

@@ -1,5 +1,5 @@
 import type { Container } from "../Core/Container.js";
-export type CustomEventArgs = {
+export interface CustomEventArgs {
     container?: Container;
     data?: unknown;
-};
+}

package/types/Types/ExportResult.d.ts

@@ -1,5 +1,5 @@
-export type ExportResult = {
+export interface ExportResult {
     blob?: Blob;
     error?: Error;
     supported: boolean;
-};
+}

package/types/Types/ParticlesGroups.d.ts

@@ -1,4 +1,2 @@
 import type { IParticlesOptions } from "../Options/Interfaces/Particles/IParticlesOptions.js";
-export type ParticlesGroups = {
-    [name: string]: IParticlesOptions;
-};
+export type ParticlesGroups = Record<string, IParticlesOptions>;

package/types/Types/PathOptions.d.ts

@@ -1,3 +1 @@
-export type PathOptions = {
-    [key: string]: unknown;
-};
+export type PathOptions = Record<string, unknown>;

package/types/Types/ShapeData.d.ts

@@ -1,5 +1,3 @@
 import type { IShapeValues } from "../Core/Interfaces/IShapeValues.js";
 import type { SingleOrMultiple } from "./SingleOrMultiple.js";
-export type ShapeData = {
-    [type: string]: SingleOrMultiple<IShapeValues>;
-};
+export type ShapeData = Record<string, SingleOrMultiple<IShapeValues>>;

package/types/Utils/CanvasUtils.d.ts

@@ -11,25 +11,26 @@ export declare function drawLine(context: CanvasRenderingContext2D, begin: ICoor
 export declare function paintBase(context: CanvasRenderingContext2D, dimension: IDimension, baseColor?: string): void;
 export declare function paintImage(context: CanvasRenderingContext2D, dimension: IDimension, image: HTMLImageElement | undefined, opacity: number): void;
 export declare function clear(context: CanvasRenderingContext2D, dimension: IDimension): void;
-export declare function drawParticle(data: IDrawParticleParams): void;
-type DrawShapeData = {
+export declare function drawParticle(data: IDrawParticleParams): Promise<void>;
+interface DrawShapeData {
     container: Container;
     context: CanvasRenderingContext2D;
     delta: IDelta;
     opacity: number;
     particle: Particle;
     radius: number;
+    strokeWidth: number;
     transformData: {
         a: number;
         b: number;
         c: number;
         d: number;
     };
-};
-export declare function drawEffect(data: DrawShapeData): void;
-export declare function drawShape(data: DrawShapeData): void;
-export declare function drawShapeAfterDraw(data: DrawShapeData): void;
-export declare function drawPlugin(context: CanvasRenderingContext2D, plugin: IContainerPlugin, delta: IDelta): void;
-export declare function drawParticlePlugin(context: CanvasRenderingContext2D, plugin: IContainerPlugin, particle: Particle, delta: IDelta): void;
+}
+export declare function drawEffect(data: DrawShapeData): Promise<void>;
+export declare function drawShape(data: DrawShapeData): Promise<void>;
+export declare function drawShapeAfterDraw(data: DrawShapeData): Promise<void>;
+export declare function drawPlugin(context: CanvasRenderingContext2D, plugin: IContainerPlugin, delta: IDelta): Promise<void>;
+export declare function drawParticlePlugin(context: CanvasRenderingContext2D, plugin: IContainerPlugin, particle: Particle, delta: IDelta): Promise<void>;
 export declare function alterHsl(color: IHsl, type: AlterType, value: number): IHsl;
 export {};

package/types/Utils/ColorUtils.d.ts

@@ -1,8 +1,11 @@
 import type { IColor, IHsl, IHsla, IRangeColor, IRgb, IRgba } from "../Core/Interfaces/Colors.js";
 import type { HslAnimation } from "../Options/Classes/HslAnimation.js";
 import type { IColorManager } from "../Core/Interfaces/IColorManager.js";
+import type { IDelta } from "../Core/Interfaces/IDelta.js";
 import type { IOptionsColor } from "../Options/Interfaces/IOptionsColor.js";
+import type { IParticleColorAnimation } from "../Core/Interfaces/IParticleValueAnimation.js";
 import type { IParticleHslAnimation } from "../Core/Interfaces/IParticleHslAnimation.js";
+import type { IRangeValue } from "../Core/Interfaces/IRangeValue.js";
 import type { Particle } from "../Core/Particle.js";
 export declare function addColorManager(manager: IColorManager): void;
 export declare function rangeColorToRgb(input?: string | IRangeColor, index?: number, useIndex?: boolean): IRgb | undefined;
@@ -22,3 +25,5 @@ export declare function getLinkColor(p1: Particle, p2?: Particle, linkColor?: st
 export declare function getLinkRandomColor(optColor: string | IOptionsColor, blink: boolean, consent: boolean): IRgb | string | undefined;
 export declare function getHslFromAnimation(animation?: IParticleHslAnimation): IHsl | undefined;
 export declare function getHslAnimationFromHsl(hsl: IHsl, animationOptions: HslAnimation | undefined, reduceFactor: number): IParticleHslAnimation;
+export declare function updateColorValue(data: IParticleColorAnimation, range: IRangeValue, decrease: boolean, delta: IDelta): void;
+export declare function updateColor(color: IParticleHslAnimation | undefined, delta: IDelta): void;

package/types/Utils/NumberUtils.d.ts

@@ -1,8 +1,7 @@
 import type { EasingType, EasingTypeAlt } from "../Enums/Types/EasingType.js";
 import type { IPositionFromSizeParams, IRangedPositionFromSizeParams } from "../Core/Interfaces/IPositionFromSizeParams.js";
+import { MoveDirection, type MoveDirectionAlt } from "../Enums/Directions/MoveDirection.js";
 import type { ICoordinates } from "../Core/Interfaces/ICoordinates.js";
-import { MoveDirection } from "../Enums/Directions/MoveDirection.js";
-import type { MoveDirectionAlt } from "../Enums/Directions/MoveDirection.js";
 import type { RangeValue } from "../Types/RangeValue.js";
 import { Vector } from "../Core/Utils/Vector.js";
 type EasingFunction = (value: number) => number;
@@ -23,6 +22,7 @@ export declare function getDistances(pointA: ICoordinates, pointB: ICoordinates)
     dy: number;
 };
 export declare function getDistance(pointA: ICoordinates, pointB: ICoordinates): number;
+export declare function degToRad(degrees: number): number;
 export declare function getParticleDirectionAngle(direction: MoveDirection | keyof typeof MoveDirection | MoveDirectionAlt | number, position: ICoordinates, center: ICoordinates): number;
 export declare function getParticleBaseVelocity(direction: number): Vector;
 export declare function collisionVelocity(v1: Vector, v2: Vector, m1: number, m2: number): Vector;

package/types/Utils/Utils.d.ts

@@ -1,8 +1,10 @@
 import type { ICoordinates, ICoordinatesWithMode } from "../Core/Interfaces/ICoordinates.js";
 import type { IDimension, IDimensionWithMode } from "../Core/Interfaces/IDimension.js";
+import { DestroyType } from "../Enums/Types/DestroyType.js";
 import type { DivEvent } from "../Options/Classes/Interactivity/Events/DivEvent.js";
 import type { IBounds } from "../Core/Interfaces/IBounds.js";
 import type { ICircleBouncer } from "../Core/Interfaces/ICircleBouncer.js";
+import type { IDelta } from "../Core/Interfaces/IDelta.js";
 import type { IModeDiv } from "../Options/Interfaces/Interactivity/Modes/IModeDiv.js";
 import type { IParticleNumericValueAnimation } from "../Core/Interfaces/IParticleValueAnimation.js";
 import { OutModeDirection } from "../Enums/Directions/OutModeDirection.js";
@@ -10,12 +12,12 @@ import type { Particle } from "../Core/Particle.js";
 import type { RangedAnimationValueWithRandom } from "../Options/Classes/ValueWithRandom.js";
 import type { SingleOrMultiple } from "../Types/SingleOrMultiple.js";
 interface ILogger {
-    debug(message?: unknown, ...optionalParams: unknown[]): void;
-    error(message?: unknown, ...optionalParams: unknown[]): void;
-    info(message?: unknown, ...optionalParams: unknown[]): void;
-    log(message?: unknown, ...optionalParams: unknown[]): void;
-    verbose(message?: unknown, ...optionalParams: unknown[]): void;
-    warning(message?: unknown, ...optionalParams: unknown[]): void;
+    debug(this: void, message?: unknown, ...optionalParams: unknown[]): void;
+    error(this: void, message?: unknown, ...optionalParams: unknown[]): void;
+    info(this: void, message?: unknown, ...optionalParams: unknown[]): void;
+    log(this: void, message?: unknown, ...optionalParams: unknown[]): void;
+    verbose(this: void, message?: unknown, ...optionalParams: unknown[]): void;
+    warning(this: void, message?: unknown, ...optionalParams: unknown[]): void;
 }
 export declare function setLogger(logger: ILogger): void;
 export declare function getLogger(): ILogger;
@@ -51,4 +53,5 @@ export declare function isNumber(arg: unknown): arg is number;
 export declare function isFunction(arg: unknown): arg is Function;
 export declare function isObject<T extends object>(arg: unknown): arg is T;
 export declare function isArray<T>(arg: unknown): arg is T[];
+export declare function updateAnimation(particle: Particle, data: IParticleNumericValueAnimation, changeDirection: boolean, destroyType: DestroyType | keyof typeof DestroyType, delta: IDelta): void;
 export {};