@nmmty/lazycanvas 0.3.6 → 0.5.0

package/dist/structures/managers/AnimationManager.d.ts

@@ -0,0 +1,120 @@
+import { AnyColorSpace } from "../../types";
+/**
+ * Interface representing the animation manager.
+ */
+export interface IAnimationManager {
+    /**
+     * The options for the animation manager.
+     */
+    options: IAnimationOptions;
+    /**
+     * Whether debugging is enabled.
+     */
+    debug: boolean;
+}
+/**
+ * Interface representing the animation options.
+ */
+export interface IAnimationOptions {
+    /**
+     * The frame rate of the animation.
+     */
+    frameRate: number;
+    /**
+     * The maximum number of colors in the animation.
+     */
+    maxColors: number;
+    /**
+     * The color space used in the animation.
+     */
+    colorSpace: AnyColorSpace;
+    /**
+     * Whether the animation should loop.
+     */
+    loop: boolean;
+    /**
+     * Whether the animation should have transparency.
+     */
+    transparency: boolean;
+    /**
+     * Utility options for the animation.
+     */
+    utils: {
+        /**
+         * Whether to clear the content of previous frames.
+         */
+        clear: boolean;
+        /**
+         * Buffer-related options.
+         */
+        buffer: {
+            /**
+             * The size of the frame buffer.
+             */
+            size: number;
+        };
+    };
+}
+/**
+ * Class representing the animation manager, which handles animation settings and options.
+ */
+export declare class AnimationManager implements IAnimationManager {
+    /**
+     * The options for the animation manager.
+     */
+    options: IAnimationOptions;
+    /**
+     * Whether debugging is enabled.
+     */
+    debug: boolean;
+    /**
+     * Constructs a new AnimationManager instance.
+     * @param opts {Object} - Optional settings for the animation manager.
+     * @param opts.debug {boolean} - Whether debugging is enabled.
+     * @param opts.settings {Object} - Additional settings for the animation manager.
+     * @param opts.settings.options {IAnimationOptions} - The animation options.
+     */
+    constructor(opts?: {
+        debug?: boolean;
+        settings?: {
+            options?: IAnimationOptions;
+        };
+    });
+    /**
+     * Sets the frame rate of the animation.
+     * @param frameRate {number} - The frame rate of the animation (default is 30).
+     * @returns {this} The current instance for chaining.
+     */
+    setFrameRate(frameRate: number): this;
+    /**
+     * Sets whether the animation should loop.
+     * @param loop {boolean} - Whether the animation should loop (default is true).
+     * @returns {this} The current instance for chaining.
+     */
+    setLoop(loop: boolean): this;
+    /**
+     * Sets whether the animation should have transparency.
+     * @param transparency {boolean} - Whether the animation should have transparency (default is true).
+     * @returns {this} The current instance for chaining.
+     */
+    setTransparent(transparency: boolean): this;
+    /**
+     * Sets the RGB format of the animation.
+     * @param rgb {ColorSpace} - The RGB format of the animation (default is RGB565).
+     * @returns {this} The current instance for chaining.
+     */
+    setRGBFormat(rgb: AnyColorSpace): this;
+    /**
+     * Sets the maximum number of colors in the animation.
+     * @param maxColors {number} - The maximum number of colors (default is 256).
+     * @returns {this} The current instance for chaining.
+     */
+    setMaxColors(maxColors: number): this;
+    /**
+     * Sets whether the content of previous frames will be cleared.
+     * @param clear {boolean} - Whether to clear the content of previous frames (default is true).
+     * @param bufferSize {number} - The size of the frame buffer (default is 0).
+     * @returns {this} The current instance for chaining.
+     */
+    setClear(clear: boolean, bufferSize?: number): this;
+}

package/dist/structures/managers/AnimationManager.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnimationManager = void 0;
+const types_1 = require("../../types");
+/**
+ * Class representing the animation manager, which handles animation settings and options.
+ */
+class AnimationManager {
+    /**
+     * The options for the animation manager.
+     */
+    options;
+    /**
+     * Whether debugging is enabled.
+     */
+    debug;
+    /**
+     * Constructs a new AnimationManager instance.
+     * @param opts {Object} - Optional settings for the animation manager.
+     * @param opts.debug {boolean} - Whether debugging is enabled.
+     * @param opts.settings {Object} - Additional settings for the animation manager.
+     * @param opts.settings.options {IAnimationOptions} - The animation options.
+     */
+    constructor(opts) {
+        this.options = opts?.settings?.options || {
+            frameRate: 30,
+            maxColors: 256,
+            colorSpace: types_1.ColorSpace.RGB565,
+            loop: true,
+            transparency: true,
+            utils: {
+                clear: true,
+                buffer: {
+                    size: 0
+                }
+            }
+        };
+        this.debug = opts?.debug || false;
+    }
+    /**
+     * Sets the frame rate of the animation.
+     * @param frameRate {number} - The frame rate of the animation (default is 30).
+     * @returns {this} The current instance for chaining.
+     */
+    setFrameRate(frameRate) {
+        this.options.frameRate = frameRate;
+        return this;
+    }
+    /**
+     * Sets whether the animation should loop.
+     * @param loop {boolean} - Whether the animation should loop (default is true).
+     * @returns {this} The current instance for chaining.
+     */
+    setLoop(loop) {
+        this.options.loop = loop;
+        return this;
+    }
+    /**
+     * Sets whether the animation should have transparency.
+     * @param transparency {boolean} - Whether the animation should have transparency (default is true).
+     * @returns {this} The current instance for chaining.
+     */
+    setTransparent(transparency) {
+        this.options.transparency = transparency;
+        return this;
+    }
+    /**
+     * Sets the RGB format of the animation.
+     * @param rgb {ColorSpace} - The RGB format of the animation (default is RGB565).
+     * @returns {this} The current instance for chaining.
+     */
+    setRGBFormat(rgb) {
+        this.options.colorSpace = rgb;
+        return this;
+    }
+    /**
+     * Sets the maximum number of colors in the animation.
+     * @param maxColors {number} - The maximum number of colors (default is 256).
+     * @returns {this} The current instance for chaining.
+     */
+    setMaxColors(maxColors) {
+        this.options.maxColors = maxColors;
+        return this;
+    }
+    /**
+     * Sets whether the content of previous frames will be cleared.
+     * @param clear {boolean} - Whether to clear the content of previous frames (default is true).
+     * @param bufferSize {number} - The size of the frame buffer (default is 0).
+     * @returns {this} The current instance for chaining.
+     */
+    setClear(clear, bufferSize) {
+        this.options.utils.clear = clear;
+        if (bufferSize) {
+            this.options.utils.buffer.size = bufferSize;
+        }
+        return this;
+    }
+}
+exports.AnimationManager = AnimationManager;

package/dist/structures/managers/FontsManager.d.ts

@@ -1,84 +1,128 @@
-import { IFonts, IFontsManager } from "../../types";
-import { Font } from "../helpers/Font";
+import { Font, IFonts } from "../helpers";
+/**
+ * Interface representing the FontsManager.
+ */
+export interface IFontsManager {
+    /**
+     * A map storing fonts with their family and weight as the key.
+     */
+    map: Map<string, Font>;
+    /**
+     * Whether debugging is enabled.
+     */
+    debug: boolean;
+}
+/**
+ * Class representing a manager for handling fonts.
+ */
 export declare class FontsManager implements IFontsManager {
+    /**
+     * A map storing fonts with their family and weight as the key.
+     */
     map: Map<string, Font>;
+    /**
+     * Whether debugging is enabled.
+     */
     debug: boolean;
-    constructor(debug?: boolean);
     /**
-     * Replace base fonts with custom fonts by special file.
-     * Use this method before loading fonts by `FontManager`.
-     * The file should be generated by the following instructions:
-     * @see https://github.com/NMMTY/LazyCanvas/blob/main/scripts/FontsGenerate.md
-     * @param fontList {IFonts[]} - The `fonts` to set
+     * Constructs a new FontsManager instance.
+     * @param opts {Object} - Optional settings for the FontsManager.
+     * @param opts.debug {boolean} - Whether debugging is enabled.
+     */
+    constructor(opts?: {
+        debug?: boolean;
+    });
+    /**
+     * Loads fonts into the manager from a given font list.
+     * @param fontList {IFonts} - The fonts to load into the manager.
+     * @returns {this} The current instance for chaining.
      */
     loadFonts(fontList: IFonts): this;
     /**
-     * Add a font to the map
-     * @param fonts {Font[]} - The `font` to add to the map
+     * Replace base fonts with custom fonts by special file.
+     * Use this method before loading fonts by `FontManager`.
+     * The file should be generated by the following instructions in MD file.
+     * @see https://github.com/NMMTY/LazyCanvas/blob/main/scripts/FontsGenerate.md
+     * @param fonts {Font[]} - The fonts to add to the manager.
+     * @returns {this} The current instance for chaining.
+     * @throws {LazyError} If required font properties are missing or the font already exists.
      */
     add(...fonts: Font[]): this;
     /**
-     * Remove a font from the map
-     * @param array {Array<{ family: string, weight: string }>} - The `family` and `weight` of the font to remove
+     * Removes fonts from the manager.
+     * @param array {Array<{ family: string, weight: string }>} - The family and weight of the fonts to remove.
+     * @returns {this} The current instance for chaining.
      */
     remove(...array: Array<{
         family: string;
         weight: string;
     }>): this;
     /**
-     * Clear all fonts from the map
+     * Clears all fonts from the manager.
+     * @returns {this} The current instance for chaining.
      */
     clear(): this;
     /**
-     * Get a font from the map
-     * @param family {string} - The `family` of the font to get
-     * @param weight {string} - The `weight` of the font to get
+     * Retrieves a font or fonts from the manager.
+     * @param family {string} - The family of the font to retrieve.
+     * @param weight {string} - The weight of the font to retrieve (optional).
+     * @returns {Font | Font[] | undefined} The retrieved font(s) or undefined if not found.
      */
     get(family: string, weight?: string): Font | Font[] | undefined;
     /**
-     * Check if a font exists in the map
-     * @param family {string} - The `family` of the font to check
-     * @param weight {string} - The `weight` of the font to check
+     * Checks if a font exists in the manager.
+     * @param family {string} - The family of the font to check.
+     * @param weight {string} - The weight of the font to check (optional).
+     * @returns {boolean} True if the font exists, false otherwise.
      */
     has(family: string, weight?: string): boolean;
     /**
-     * Get the size of the map
+     * Retrieves the number of fonts in the manager.
+     * @returns {number} The size of the font map.
      */
     size(): number;
     /**
-     * Get the values of the map
+     * Retrieves the values (fonts) from the manager.
+     * @returns {IterableIterator<Font>} An iterator for the font values.
      */
     values(): IterableIterator<Font>;
     /**
-     * Get the keys of the map
+     * Retrieves the keys (family and weight) from the manager.
+     * @returns {IterableIterator<string>} An iterator for the font keys.
      */
     keys(): IterableIterator<string>;
     /**
-     * Get the entries of the map
+     * Retrieves the entries (key-value pairs) from the manager.
+     * @returns {IterableIterator<[string, Font]>} An iterator for the font entries.
      */
     entries(): IterableIterator<[string, Font]>;
     /**
-     * Iterate over the map
-     * @param callbackfn {Function} - The function to execute on each font
-     * @param thisArg {any} - The `this` context to use
+     * Iterates over the fonts in the manager.
+     * @param callbackfn {Function} - The function to execute on each font.
+     * @param thisArg {any} - The `this` context to use (optional).
+     * @returns {this} The current instance for chaining.
      */
     forEach(callbackfn: (value: Font, key: string, map: Map<string, Font>) => void, thisArg?: any): this;
     /**
-     * Convert the map to a JSON object
+     * Converts the font map to a JSON object.
+     * @returns {object} The JSON representation of the font map.
      */
     toJSON(): object;
     /**
-     * Convert the map from a JSON object
-     * @param json {object} - The JSON object to convert
+     * Populates the font map from a JSON object.
+     * @param json {object} - The JSON object to populate the map from.
+     * @returns {this} The current instance for chaining.
      */
     fromJSON(json: object): this;
     /**
-     * Convert the map to an array
+     * Converts the font map to an array.
+     * @returns {Font[]} An array of fonts.
      */
     toArray(): Font[];
     /**
-     * Convert an array to the map
-     * @param array {Font[]} - The `array` to convert
+     * Populates the font map from an array of fonts.
+     * @param array {Font[]} - The array of fonts to populate the map from.
+     * @returns {this} The current instance for chaining.
      */
     fromArray(array: Font[]): this;
 }

package/dist/structures/managers/FontsManager.js

@@ -1,44 +1,56 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FontsManager = void 0;
-const Font_1 = require("../helpers/Font");
+const helpers_1 = require("../helpers");
 const LazyUtil_1 = require("../../utils/LazyUtil");
 const Fonts_1 = require("../../helpers/Fonts");
 const canvas_1 = require("@napi-rs/canvas");
+/**
+ * Class representing a manager for handling fonts.
+ */
 class FontsManager {
+    /**
+     * A map storing fonts with their family and weight as the key.
+     */
     map;
+    /**
+     * Whether debugging is enabled.
+     */
     debug;
-    constructor(debug = false) {
-        this.debug = debug;
+    /**
+     * Constructs a new FontsManager instance.
+     * @param opts {Object} - Optional settings for the FontsManager.
+     * @param opts.debug {boolean} - Whether debugging is enabled.
+     */
+    constructor(opts) {
         this.map = new Map();
+        this.debug = opts?.debug || false;
         this.loadFonts(Fonts_1.Fonts);
     }
     /**
-     * Replace base fonts with custom fonts by special file.
-     * Use this method before loading fonts by `FontManager`.
-     * The file should be generated by the following instructions:
-     * @see https://github.com/NMMTY/LazyCanvas/blob/main/scripts/FontsGenerate.md
-     * @param fontList {IFonts[]} - The `fonts` to set
+     * Loads fonts into the manager from a given font list.
+     * @param fontList {IFonts} - The fonts to load into the manager.
+     * @returns {this} The current instance for chaining.
      */
     loadFonts(fontList) {
-        for (const fontFamily in fontList) {
-            if (fontList.hasOwnProperty(fontFamily)) {
-                for (const weight in fontList[fontFamily]) {
-                    if (fontList[fontFamily].hasOwnProperty(weight)) {
-                        this.add(new Font_1.Font()
-                            .setFamily(fontFamily)
-                            .setWeight(Number(weight))
-                            // @ts-ignore
-                            .setBase64(fontList[fontFamily][weight]));
-                    }
-                }
-            }
-        }
+        this.add(...Object.entries(fontList).map(([fontFamily, fontWeights]) => {
+            return Object.entries(fontWeights).map(([weight, base64]) => {
+                return new helpers_1.Font()
+                    .setFamily(fontFamily)
+                    .setWeight(Number(weight))
+                    .setBase64(base64);
+            });
+        }).flat());
         return this;
     }
     /**
-     * Add a font to the map
-     * @param fonts {Font[]} - The `font` to add to the map
+     * Replace base fonts with custom fonts by special file.
+     * Use this method before loading fonts by `FontManager`.
+     * The file should be generated by the following instructions in MD file.
+     * @see https://github.com/NMMTY/LazyCanvas/blob/main/scripts/FontsGenerate.md
+     * @param fonts {Font[]} - The fonts to add to the manager.
+     * @returns {this} The current instance for chaining.
+     * @throws {LazyError} If required font properties are missing or the font already exists.
      */
     add(...fonts) {
         if (this.debug)
@@ -63,8 +75,9 @@ class FontsManager {
         return this;
     }
     /**
-     * Remove a font from the map
-     * @param array {Array<{ family: string, weight: string }>} - The `family` and `weight` of the font to remove
+     * Removes fonts from the manager.
+     * @param array {Array<{ family: string, weight: string }>} - The family and weight of the fonts to remove.
+     * @returns {this} The current instance for chaining.
      */
     remove(...array) {
         for (const font of array) {
@@ -73,16 +86,18 @@ class FontsManager {
         return this;
     }
     /**
-     * Clear all fonts from the map
+     * Clears all fonts from the manager.
+     * @returns {this} The current instance for chaining.
      */
     clear() {
         this.map.clear();
         return this;
     }
     /**
-     * Get a font from the map
-     * @param family {string} - The `family` of the font to get
-     * @param weight {string} - The `weight` of the font to get
+     * Retrieves a font or fonts from the manager.
+     * @param family {string} - The family of the font to retrieve.
+     * @param weight {string} - The weight of the font to retrieve (optional).
+     * @returns {Font | Font[] | undefined} The retrieved font(s) or undefined if not found.
      */
     get(family, weight) {
         if (weight)
@@ -90,9 +105,10 @@ class FontsManager {
         return Array.from(this.map.values()).filter(font => font.family === family);
     }
     /**
-     * Check if a font exists in the map
-     * @param family {string} - The `family` of the font to check
-     * @param weight {string} - The `weight` of the font to check
+     * Checks if a font exists in the manager.
+     * @param family {string} - The family of the font to check.
+     * @param weight {string} - The weight of the font to check (optional).
+     * @returns {boolean} True if the font exists, false otherwise.
      */
     has(family, weight) {
         if (weight)
@@ -100,61 +116,70 @@ class FontsManager {
         return Array.from(this.map.values()).some(font => font.family === family);
     }
     /**
-     * Get the size of the map
+     * Retrieves the number of fonts in the manager.
+     * @returns {number} The size of the font map.
      */
     size() {
         return this.map.size;
     }
     /**
-     * Get the values of the map
+     * Retrieves the values (fonts) from the manager.
+     * @returns {IterableIterator<Font>} An iterator for the font values.
      */
     values() {
         return this.map.values();
     }
     /**
-     * Get the keys of the map
+     * Retrieves the keys (family and weight) from the manager.
+     * @returns {IterableIterator<string>} An iterator for the font keys.
      */
     keys() {
         return this.map.keys();
     }
     /**
-     * Get the entries of the map
+     * Retrieves the entries (key-value pairs) from the manager.
+     * @returns {IterableIterator<[string, Font]>} An iterator for the font entries.
      */
     entries() {
         return this.map.entries();
     }
     /**
-     * Iterate over the map
-     * @param callbackfn {Function} - The function to execute on each font
-     * @param thisArg {any} - The `this` context to use
+     * Iterates over the fonts in the manager.
+     * @param callbackfn {Function} - The function to execute on each font.
+     * @param thisArg {any} - The `this` context to use (optional).
+     * @returns {this} The current instance for chaining.
      */
     forEach(callbackfn, thisArg) {
         this.map.forEach(callbackfn, thisArg);
         return this;
     }
     /**
-     * Convert the map to a JSON object
+     * Converts the font map to a JSON object.
+     * @returns {object} The JSON representation of the font map.
      */
     toJSON() {
         return Object.fromEntries(this.map);
     }
     /**
-     * Convert the map from a JSON object
-     * @param json {object} - The JSON object to convert
+     * Populates the font map from a JSON object.
+     * @param json {object} - The JSON object to populate the map from.
+     * @returns {this} The current instance for chaining.
      */
     fromJSON(json) {
         this.map = new Map(Object.entries(json));
         return this;
     }
     /**
-     * Convert the map to an array
+     * Converts the font map to an array.
+     * @returns {Font[]} An array of fonts.
      */
     toArray() {
         return Array.from(this.map.values());
     }
     /**
-     * Convert an array to the map
-     * @param array {Font[]} - The `array` to convert
+     * Populates the font map from an array of fonts.
+     * @param array {Font[]} - The array of fonts to populate the map from.
+     * @returns {this} The current instance for chaining.
      */
     fromArray(array) {
         for (const font of array) {