@tsparticles/engine 3.0.0-alpha.0 → 3.0.0-beta.0

package/esm/engine.js

@@ -1,175 +0,0 @@
-import { Container } from "./Core/Container";
-import { EventDispatcher } from "./Utils/EventDispatcher";
-import { Plugins } from "./Core/Utils/Plugins";
-import { generatedAttribute } from "./Core/Utils/Constants";
-import { getRandom } from "./Utils/NumberUtils";
-import { itemFromSingleOrMultiple } from "./Utils/Utils";
-async function getDataFromUrl(data) {
-    const url = itemFromSingleOrMultiple(data.url, data.index);
-    if (!url) {
-        return data.fallback;
-    }
-    const response = await fetch(url);
-    if (response.ok) {
-        return response.json();
-    }
-    console.error(`tsParticles - Error ${response.status} while retrieving config file`);
-    return data.fallback;
-}
-export class Engine {
-    constructor() {
-        this._configs = new Map();
-        this._domArray = [];
-        this._eventDispatcher = new EventDispatcher();
-        this.plugins = new Plugins(this);
-    }
-    get configs() {
-        const res = {};
-        for (const [name, config] of this._configs) {
-            res[name] = config;
-        }
-        return res;
-    }
-    addConfig(nameOrConfig, config) {
-        var _a;
-        if (typeof nameOrConfig === "string") {
-            if (config) {
-                config.name = nameOrConfig;
-                this._configs.set(nameOrConfig, config);
-            }
-        }
-        else {
-            this._configs.set((_a = nameOrConfig.name) !== null && _a !== void 0 ? _a : "default", nameOrConfig);
-        }
-    }
-    addEventListener(type, listener) {
-        this._eventDispatcher.addEventListener(type, listener);
-    }
-    async addInteractor(name, interactorInitializer) {
-        this.plugins.addInteractor(name, interactorInitializer);
-        await this.refresh();
-    }
-    async addMover(name, moverInitializer) {
-        this.plugins.addParticleMover(name, moverInitializer);
-        await this.refresh();
-    }
-    async addParticleUpdater(name, updaterInitializer) {
-        this.plugins.addParticleUpdater(name, updaterInitializer);
-        await this.refresh();
-    }
-    async addPathGenerator(name, generator) {
-        this.plugins.addPathGenerator(name, generator);
-        await this.refresh();
-    }
-    async addPlugin(plugin) {
-        this.plugins.addPlugin(plugin);
-        await this.refresh();
-    }
-    async addPreset(preset, options, override = false) {
-        this.plugins.addPreset(preset, options, override);
-        await this.refresh();
-    }
-    async addShape(shape, drawer, init, afterEffect, destroy) {
-        let customDrawer;
-        if (typeof drawer === "function") {
-            customDrawer = {
-                afterEffect: afterEffect,
-                destroy: destroy,
-                draw: drawer,
-                init: init,
-            };
-        }
-        else {
-            customDrawer = drawer;
-        }
-        this.plugins.addShapeDrawer(shape, customDrawer);
-        await this.refresh();
-    }
-    dispatchEvent(type, args) {
-        this._eventDispatcher.dispatchEvent(type, args);
-    }
-    dom() {
-        return this._domArray;
-    }
-    domItem(index) {
-        const dom = this.dom(), item = dom[index];
-        if (item && !item.destroyed) {
-            return item;
-        }
-        dom.splice(index, 1);
-    }
-    async load(params) {
-        var _a, _b, _c;
-        const id = (_a = params.id) !== null && _a !== void 0 ? _a : `tsparticles${Math.floor(getRandom() * 10000)}`, { index, url } = params, options = url
-            ? await getDataFromUrl({
-                fallback: params.options,
-                index,
-                url: url,
-            })
-            : params.options;
-        let domContainer = (_b = params.element) !== null && _b !== void 0 ? _b : document.getElementById(id);
-        if (!domContainer) {
-            domContainer = document.createElement("div");
-            domContainer.id = id;
-            (_c = document.querySelector("body")) === null || _c === void 0 ? void 0 : _c.append(domContainer);
-        }
-        const currentOptions = itemFromSingleOrMultiple(options, index), dom = this.dom(), oldIndex = dom.findIndex((v) => v.id === id);
-        if (oldIndex >= 0) {
-            const old = this.domItem(oldIndex);
-            if (old && !old.destroyed) {
-                old.destroy();
-                dom.splice(oldIndex, 1);
-            }
-        }
-        let canvasEl;
-        if (domContainer.tagName.toLowerCase() === "canvas") {
-            canvasEl = domContainer;
-            canvasEl.dataset[generatedAttribute] = "false";
-        }
-        else {
-            const existingCanvases = domContainer.getElementsByTagName("canvas");
-            if (existingCanvases.length) {
-                canvasEl = existingCanvases[0];
-                canvasEl.dataset[generatedAttribute] = "false";
-            }
-            else {
-                canvasEl = document.createElement("canvas");
-                canvasEl.dataset[generatedAttribute] = "true";
-                domContainer.appendChild(canvasEl);
-            }
-        }
-        if (!canvasEl.style.width) {
-            canvasEl.style.width = "100%";
-        }
-        if (!canvasEl.style.height) {
-            canvasEl.style.height = "100%";
-        }
-        const newItem = new Container(this, id, currentOptions);
-        if (oldIndex >= 0) {
-            dom.splice(oldIndex, 0, newItem);
-        }
-        else {
-            dom.push(newItem);
-        }
-        newItem.canvas.loadCanvas(canvasEl);
-        await newItem.start();
-        return newItem;
-    }
-    async refresh() {
-        for (const instance of this.dom()) {
-            await instance.refresh();
-        }
-    }
-    removeEventListener(type, listener) {
-        this._eventDispatcher.removeEventListener(type, listener);
-    }
-    setOnClickHandler(callback) {
-        const dom = this.dom();
-        if (!dom.length) {
-            throw new Error("Can only set click handlers after calling tsParticles.load()");
-        }
-        for (const domItem of dom) {
-            domItem.addClickHandler(callback);
-        }
-    }
-}

package/types/Core/Interfaces/IParticleOverride.d.ts

@@ -1,6 +0,0 @@
-export interface IParticleOverride {
-    fill?: string | CanvasGradient | CanvasPattern;
-    opacity?: number;
-    radius?: number;
-    stroke?: string | CanvasGradient | CanvasPattern;
-}

package/types/Core/Interfaces/IParticlesMover.d.ts

@@ -1,7 +0,0 @@
-import type { IDelta } from "./IDelta";
-import type { Particle } from "../Particle";
-export interface IParticleMover {
-    init(particle: Particle): void;
-    isEnabled(particle: Particle): boolean;
-    move(particle: Particle, delta: IDelta): void;
-}

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

@@ -1,6 +0,0 @@
-import type { Container } from "../Container";
-export declare class FrameManager {
-    private readonly container;
-    constructor(container: Container);
-    nextFrame(timestamp: DOMHighResTimeStamp): Promise<void>;
-}

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

@@ -1,51 +0,0 @@
-import type { Container } from "../Container";
-import type { Engine } from "../../engine";
-import type { IContainerPlugin } from "../Interfaces/IContainerPlugin";
-import type { IInteractor } from "../Interfaces/IInteractor";
-import type { IMovePathGenerator } from "../Interfaces/IMovePathGenerator";
-import type { IParticleMover } from "../Interfaces/IParticleMover";
-import type { IParticleUpdater } from "../Interfaces/IParticleUpdater";
-import type { IParticlesOptions } from "../../Options/Interfaces/Particles/IParticlesOptions";
-import type { IPlugin } from "../Interfaces/IPlugin";
-import type { IShapeDrawer } from "../Interfaces/IShapeDrawer";
-import type { ISourceOptions } from "../../Types/ISourceOptions";
-import type { Options } from "../../Options/Classes/Options";
-import type { ParticlesOptions } from "../../Options/Classes/Particles/ParticlesOptions";
-import type { RecursivePartial } from "../../Types/RecursivePartial";
-import type { SingleOrMultiple } from "../../Types/SingleOrMultiple";
-type GenericInitializer<T> = (container: Container) => T;
-type InteractorInitializer = GenericInitializer<IInteractor>;
-type MoverInitializer = GenericInitializer<IParticleMover>;
-type UpdaterInitializer = GenericInitializer<IParticleUpdater>;
-export declare class Plugins {
-    readonly drawers: Map<string, IShapeDrawer>;
-    readonly interactors: Map<Container, IInteractor[]>;
-    readonly movers: Map<Container, IParticleMover[]>;
-    readonly pathGenerators: Map<string, IMovePathGenerator>;
-    readonly plugins: IPlugin[];
-    readonly presets: Map<string, RecursivePartial<import("../..").IOptions>>;
-    readonly updaters: Map<Container, IParticleUpdater[]>;
-    private readonly _engine;
-    private readonly _initializers;
-    constructor(engine: Engine);
-    addInteractor(name: string, initInteractor: InteractorInitializer): void;
-    addParticleMover(name: string, initMover: MoverInitializer): void;
-    addParticleUpdater(name: string, initUpdater: UpdaterInitializer): void;
-    addPathGenerator(type: string, pathGenerator: IMovePathGenerator): void;
-    addPlugin(plugin: IPlugin): void;
-    addPreset(presetKey: string, options: ISourceOptions, override?: boolean): void;
-    addShapeDrawer(types: SingleOrMultiple<string>, drawer: IShapeDrawer): void;
-    destroy(container: Container): void;
-    getAvailablePlugins(container: Container): Map<string, IContainerPlugin>;
-    getInteractors(container: Container, force?: boolean): IInteractor[];
-    getMovers(container: Container, force?: boolean): IParticleMover[];
-    getPathGenerator(type: string): IMovePathGenerator | undefined;
-    getPlugin(plugin: string): IPlugin | undefined;
-    getPreset(preset: string): ISourceOptions | undefined;
-    getShapeDrawer(type: string): IShapeDrawer | undefined;
-    getSupportedShapes(): IterableIterator<string>;
-    getUpdaters(container: Container, force?: boolean): IParticleUpdater[];
-    loadOptions(options: Options, sourceOptions: ISourceOptions): void;
-    loadParticlesOptions(container: Container, options: ParticlesOptions, ...sourceOptions: (RecursivePartial<IParticlesOptions> | undefined)[]): void;
-}
-export {};

package/types/Options/Interfaces/Particles/Shape/ICharacterShape.d.ts

@@ -1,8 +0,0 @@
-import type { IShapeValues } from "./IShapeValues";
-import type { SingleOrMultiple } from "../../../../Types/SingleOrMultiple";
-export interface ICharacterShape extends IShapeValues {
-    font: string;
-    style: string;
-    value: SingleOrMultiple<string>;
-    weight: string;
-}

package/types/Options/Interfaces/Particles/Shape/IImageShape.d.ts

@@ -1,8 +0,0 @@
-import type { IShapeValues } from "./IShapeValues";
-export interface IImageShape extends IShapeValues {
-    height: number;
-    replaceColor: boolean;
-    replace_color: boolean;
-    src: string;
-    width: number;
-}

package/types/Options/Interfaces/Particles/Shape/IPolygonShape.d.ts

@@ -1,5 +0,0 @@
-import type { IShapeValues } from "./IShapeValues";
-export interface IPolygonShape extends IShapeValues {
-    nb_sides: number;
-    sides: number;
-}

package/types/Options/Interfaces/Particles/Shape/IShapeValues.d.ts

@@ -1 +0,0 @@
-export * from "../../../../Core/Interfaces/IShapeValues";

package/types/Options/Interfaces/Particles/Shape/IStarShape.d.ts

@@ -1,6 +0,0 @@
-import type { IShapeValues } from "./IShapeValues";
-export interface IStarShape extends IShapeValues {
-    inset: number;
-    nb_sides: number;
-    sides: number;
-}

package/types/engine.d.ts

@@ -1,39 +0,0 @@
-import type { ShapeDrawerAfterEffectFunction, ShapeDrawerDestroyFunction, ShapeDrawerDrawFunction, ShapeDrawerInitFunction } from "./Types/ShapeDrawerFunctions";
-import { Container } from "./Core/Container";
-import type { CustomEventArgs } from "./Types/CustomEventArgs";
-import type { CustomEventListener } from "./Types/CustomEventListener";
-import type { IInteractor } from "./Core/Interfaces/IInteractor";
-import type { ILoadParams } from "./Core/Interfaces/ILoadParams";
-import type { IMovePathGenerator } from "./Core/Interfaces/IMovePathGenerator";
-import type { IParticleMover } from "./Core/Interfaces/IParticlesMover";
-import type { IParticleUpdater } from "./Core/Interfaces/IParticleUpdater";
-import type { IPlugin } from "./Core/Interfaces/IPlugin";
-import type { IShapeDrawer } from "./Core/Interfaces/IShapeDrawer";
-import type { ISourceOptions } from "./Types/ISourceOptions";
-import type { Particle } from "./Core/Particle";
-import { Plugins } from "./Core/Utils/Plugins";
-import type { SingleOrMultiple } from "./Types/SingleOrMultiple";
-export declare class Engine {
-    readonly plugins: Plugins;
-    private readonly _configs;
-    private readonly _domArray;
-    private readonly _eventDispatcher;
-    constructor();
-    get configs(): Record<string, ISourceOptions>;
-    addConfig(nameOrConfig: string | ISourceOptions, config?: ISourceOptions): void;
-    addEventListener(type: string, listener: CustomEventListener): void;
-    addInteractor(name: string, interactorInitializer: (container: Container) => IInteractor): Promise<void>;
-    addMover(name: string, moverInitializer: (container: Container) => IParticleMover): Promise<void>;
-    addParticleUpdater(name: string, updaterInitializer: (container: Container) => IParticleUpdater): Promise<void>;
-    addPathGenerator(name: string, generator: IMovePathGenerator): Promise<void>;
-    addPlugin(plugin: IPlugin): Promise<void>;
-    addPreset(preset: string, options: ISourceOptions, override?: boolean): Promise<void>;
-    addShape(shape: SingleOrMultiple<string>, drawer: IShapeDrawer | ShapeDrawerDrawFunction, init?: ShapeDrawerInitFunction, afterEffect?: ShapeDrawerAfterEffectFunction, destroy?: ShapeDrawerDestroyFunction): Promise<void>;
-    dispatchEvent(type: string, args: CustomEventArgs): void;
-    dom(): Container[];
-    domItem(index: number): Container | undefined;
-    load(params: ILoadParams): Promise<Container | undefined>;
-    refresh(): Promise<void>;
-    removeEventListener(type: string, listener: CustomEventListener): void;
-    setOnClickHandler(callback: (e: Event, particles?: Particle[]) => void): void;
-}

package/umd/Core/Utils/FrameManager.js

@@ -1,56 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.FrameManager = void 0;
-    function initDelta(value, fpsLimit = 60, smooth = false) {
-        return {
-            value,
-            factor: smooth ? 60 / fpsLimit : (60 * value) / 1000,
-        };
-    }
-    class FrameManager {
-        constructor(container) {
-            this.container = container;
-        }
-        async nextFrame(timestamp) {
-            var _a;
-            try {
-                const container = this.container;
-                if (!container.smooth &&
-                    container.lastFrameTime !== undefined &&
-                    timestamp < container.lastFrameTime + 1000 / container.fpsLimit) {
-                    container.draw(false);
-                    return;
-                }
-                (_a = container.lastFrameTime) !== null && _a !== void 0 ? _a : (container.lastFrameTime = timestamp);
-                const delta = initDelta(timestamp - container.lastFrameTime, container.fpsLimit, container.smooth);
-                container.lifeTime += delta.value;
-                container.lastFrameTime = timestamp;
-                if (delta.value > 1000) {
-                    container.draw(false);
-                    return;
-                }
-                await container.particles.draw(delta);
-                if (container.duration > 0 && container.lifeTime > container.duration) {
-                    container.destroy();
-                    return;
-                }
-                if (container.getAnimationStatus()) {
-                    container.draw(false);
-                }
-            }
-            catch (e) {
-                console.error("tsParticles error in animation loop", e);
-            }
-        }
-    }
-    exports.FrameManager = FrameManager;
-});

package/umd/Core/Utils/Plugins.js

@@ -1,126 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../../Utils/Utils"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.Plugins = void 0;
-    const Utils_1 = require("../../Utils/Utils");
-    function getItemsFromInitializer(container, map, initializers, force = false) {
-        let res = map.get(container);
-        if (!res || force) {
-            res = [...initializers.values()].map((t) => t(container));
-            map.set(container, res);
-        }
-        return res;
-    }
-    class Plugins {
-        constructor(engine) {
-            this._engine = engine;
-            this.plugins = [];
-            this._initializers = {
-                interactors: new Map(),
-                movers: new Map(),
-                updaters: new Map(),
-            };
-            this.interactors = new Map();
-            this.movers = new Map();
-            this.updaters = new Map();
-            this.presets = new Map();
-            this.drawers = new Map();
-            this.pathGenerators = new Map();
-        }
-        addInteractor(name, initInteractor) {
-            this._initializers.interactors.set(name, initInteractor);
-        }
-        addParticleMover(name, initMover) {
-            this._initializers.movers.set(name, initMover);
-        }
-        addParticleUpdater(name, initUpdater) {
-            this._initializers.updaters.set(name, initUpdater);
-        }
-        addPathGenerator(type, pathGenerator) {
-            if (!this.getPathGenerator(type)) {
-                this.pathGenerators.set(type, pathGenerator);
-            }
-        }
-        addPlugin(plugin) {
-            if (!this.getPlugin(plugin.id)) {
-                this.plugins.push(plugin);
-            }
-        }
-        addPreset(presetKey, options, override = false) {
-            if (override || !this.getPreset(presetKey)) {
-                this.presets.set(presetKey, options);
-            }
-        }
-        addShapeDrawer(types, drawer) {
-            (0, Utils_1.executeOnSingleOrMultiple)(types, (type) => {
-                if (!this.getShapeDrawer(type)) {
-                    this.drawers.set(type, drawer);
-                }
-            });
-        }
-        destroy(container) {
-            this.updaters.delete(container);
-            this.movers.delete(container);
-            this.interactors.delete(container);
-        }
-        getAvailablePlugins(container) {
-            const res = new Map();
-            for (const plugin of this.plugins) {
-                if (!plugin.needsPlugin(container.actualOptions)) {
-                    continue;
-                }
-                res.set(plugin.id, plugin.getPlugin(container));
-            }
-            return res;
-        }
-        getInteractors(container, force = false) {
-            return getItemsFromInitializer(container, this.interactors, this._initializers.interactors, force);
-        }
-        getMovers(container, force = false) {
-            return getItemsFromInitializer(container, this.movers, this._initializers.movers, force);
-        }
-        getPathGenerator(type) {
-            return this.pathGenerators.get(type);
-        }
-        getPlugin(plugin) {
-            return this.plugins.find((t) => t.id === plugin);
-        }
-        getPreset(preset) {
-            return this.presets.get(preset);
-        }
-        getShapeDrawer(type) {
-            return this.drawers.get(type);
-        }
-        getSupportedShapes() {
-            return this.drawers.keys();
-        }
-        getUpdaters(container, force = false) {
-            return getItemsFromInitializer(container, this.updaters, this._initializers.updaters, force);
-        }
-        loadOptions(options, sourceOptions) {
-            for (const plugin of this.plugins) {
-                plugin.loadOptions(options, sourceOptions);
-            }
-        }
-        loadParticlesOptions(container, options, ...sourceOptions) {
-            const updaters = this.updaters.get(container);
-            if (!updaters) {
-                return;
-            }
-            for (const updater of updaters) {
-                if (updater.loadOptions) {
-                    updater.loadOptions(options, ...sourceOptions);
-                }
-            }
-        }
-    }
-    exports.Plugins = Plugins;
-});

package/umd/Options/Interfaces/Particles/Shape/ICharacterShape.js

@@ -1,12 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-});

package/umd/Options/Interfaces/Particles/Shape/IImageShape.js

@@ -1,12 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-});

package/umd/Options/Interfaces/Particles/Shape/IPolygonShape.js

@@ -1,12 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-});

package/umd/Options/Interfaces/Particles/Shape/IShapeValues.js

@@ -1,27 +0,0 @@
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../../../../Core/Interfaces/IShapeValues"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    __exportStar(require("../../../../Core/Interfaces/IShapeValues"), exports);
-});

package/umd/Options/Interfaces/Particles/Shape/IStarShape.js

@@ -1,12 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-});