@nmmty/lazycanvas 0.4.0 → 0.5.0

package/dist/structures/helpers/Exporter.js

@@ -0,0 +1,168 @@
+"use strict";
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Exporter = void 0;
+const types_1 = require("../../types");
+const LazyUtil_1 = require("../../utils/LazyUtil");
+const fs = __importStar(require("fs"));
+const utils_1 = require("../../utils/utils");
+const _yaml = __importStar(require("js-yaml"));
+/**
+ * Class responsible for exporting a LazyCanvas instance to various formats.
+ */
+class Exporter {
+    /**
+     * The LazyCanvas instance to be exported.
+     */
+    canvas;
+    /**
+     * Constructs a new Exporter instance.
+     * @param canvas {LazyCanvas} - The LazyCanvas instance to be exported.
+     */
+    constructor(canvas) {
+        this.canvas = canvas;
+    }
+    /**
+     * Saves a file to the filesystem.
+     * @param buffer {any} - The data to be saved.
+     * @param extension {Extensions} - The file extension.
+     * @param name {string} - The name of the file (optional).
+     * @throws {LazyError} If the buffer or extension is not provided.
+     */
+    async saveFile(buffer, extension, name) {
+        if (!buffer)
+            throw new LazyUtil_1.LazyError('Buffer must be provided');
+        if (!extension)
+            throw new LazyUtil_1.LazyError('Extension must be provided');
+        fs.writeFileSync(`${name === undefined ? (0, utils_1.generateRandomName)() : name}.${extension}`, buffer);
+    }
+    /**
+     * Exports all layers from the LayersManager as an array of JSON objects.
+     * @param manager {LayersManager} - The LayersManager instance.
+     * @returns {any[]} An array of JSON representations of the layers.
+     */
+    exportLayers(manager) {
+        let arr = [];
+        for (const layer of Array.from(manager.map.values())) {
+            arr.push(layer.toJSON());
+        }
+        return arr;
+    }
+    /**
+     * Exports the canvas to the specified format.
+     * @param exportType {AnyExport} - The type of export (e.g., "png", "json").
+     * @param opts {Object} - Optional settings.
+     * @param opts.name {string} - The name of the file (optional).
+     * @param opts.saveAsFile {boolean} - Whether to save the export as a file (optional).
+     * @returns {Promise<Buffer | SKRSContext2D | Canvas | SvgCanvas | string>} The exported data.
+     * @throws {LazyError} If the export type is not supported.
+     */
+    async export(exportType, opts) {
+        switch (exportType) {
+            case types_1.Export.CTX:
+            case "ctx":
+                return await this.canvas.manager.render.render(exportType);
+            case types_1.Export.SVG:
+            case "svg":
+                const svg = await this.canvas.manager.render.render('svg');
+                if (opts?.saveAsFile) {
+                    await this.saveFile(svg, 'svg', opts.name);
+                }
+                return svg;
+            case types_1.Export.BUFFER:
+            case "buffer":
+                const buffer = await this.canvas.manager.render.render('buffer');
+                if (opts?.saveAsFile) {
+                    await this.saveFile(buffer, 'png', opts.name);
+                }
+                return buffer;
+            case types_1.Export.GIF:
+            case "gif":
+                const gif = await this.canvas.manager.render.render('buffer');
+                if (opts?.saveAsFile) {
+                    await this.saveFile(gif, 'gif', opts.name);
+                }
+                return gif;
+            case types_1.Export.WEBP:
+            case "webp":
+                const webp = await this.canvas.manager.render.render('buffer');
+                if (opts?.saveAsFile) {
+                    await this.saveFile(webp, 'webp', opts.name);
+                }
+                return webp;
+            case types_1.Export.JPEG:
+            case "jpeg":
+                const jpeg = await this.canvas.manager.render.render('buffer');
+                await this.saveFile(jpeg, 'jpeg', opts?.name);
+                return jpeg;
+            case types_1.Export.JPG:
+            case "jpg":
+                const jpg = await this.canvas.manager.render.render('buffer');
+                await this.saveFile(jpg, 'jpg', opts?.name);
+                return jpg;
+            case types_1.Export.PNG:
+            case "png":
+                const png = await this.canvas.manager.render.render('buffer');
+                await this.saveFile(png, 'png', opts?.name);
+                return png;
+            case types_1.Export.JSON:
+            case "json":
+                const json = this.syncExport(exportType);
+                if (opts?.saveAsFile) {
+                    await this.saveFile(JSON.stringify(json), 'json', opts.name);
+                }
+                return JSON.stringify(json);
+            case types_1.Export.CANVAS:
+            case "canvas":
+                return await this.canvas.manager.render.render(exportType);
+            case types_1.Export.YAML:
+            case "yaml":
+                const yaml = _yaml.dump(this.syncExport(types_1.Export.JSON));
+                if (opts?.saveAsFile) {
+                    await this.saveFile(yaml, 'yaml', opts.name);
+                }
+                return yaml;
+            default:
+                throw new LazyUtil_1.LazyError(`Export type ${exportType} is not supported`);
+        }
+    }
+    /**
+     * Synchronously exports the canvas to the specified format.
+     * @param exportType {AnyExport} - The type of export (e.g., "json").
+     * @returns {IOLazyCanvas | void} The exported data or void if the export type is unsupported.
+     */
+    syncExport(exportType) {
+        switch (exportType) {
+            case types_1.Export.JSON:
+            case "json":
+                return {
+                    options: this.canvas.options,
+                    animation: this.canvas.manager.animation.options,
+                    layers: this.exportLayers(this.canvas.manager.layers)
+                };
+        }
+    }
+}
+exports.Exporter = Exporter;

package/dist/structures/helpers/Font.d.ts

@@ -1,35 +1,89 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { AnyWeight } from "../../types";
-import { IFont } from "../../types";
+/**
+ * Interface representing a font.
+ */
+export interface IFont {
+    /**
+     * The font family.
+     */
+    family: string;
+    /**
+     * The weight of the font.
+     */
+    weight: AnyWeight;
+    /**
+     * The file path of the font (optional).
+     */
+    path?: string;
+    /**
+     * The base64 representation of the font (optional).
+     */
+    base64?: Buffer;
+}
+/**
+ * Interface representing a collection of fonts.
+ * Each font family maps to a record of font weights and their corresponding buffers.
+ */
+export interface IFonts {
+    [family: string]: Record<number, Buffer>;
+}
+/**
+ * Class representing a font with properties such as family, weight, path, and base64.
+ */
 export declare class Font implements IFont {
+    /**
+     * The font family.
+     */
     family: string;
+    /**
+     * The weight of the font.
+     */
     weight: AnyWeight;
+    /**
+     * The file path of the font (optional).
+     */
     path?: string;
+    /**
+     * The base64 representation of the font (optional).
+     */
     base64?: Buffer;
+    /**
+     * Constructs a new Font instance with default values.
+     */
     constructor();
     /**
-     * Set the font family
-     * @param family {string} - The `family` of the font
+     * Sets the font family.
+     * @param family {string} - The `family` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the family is not provided.
      */
     setFamily(family: string): this;
     /**
-     * Set the font weight
-     * @param weight {AnyWeight} - The `weight` of the font
+     * Sets the font weight.
+     * @param weight {AnyWeight} - The `weight` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the weight is not provided.
      */
     setWeight(weight: AnyWeight): this;
     /**
-     * Set the path of the font
-     * @param path {string} - The `path` of the font
+     * Sets the file path of the font.
+     * @param path {string} - The `path` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the path is not provided.
      */
     setPath(path: string): this;
     /**
-     * Set the base64 of the font
-     * @param base64 {string} - The `base64` of the font
+     * Sets the base64 representation of the font.
+     * @param base64 {Buffer} - The `base64` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the base64 is not provided.
      */
     setBase64(base64: Buffer): this;
     /**
-     * @returns {IFont}
+     * Converts the Font instance to a JSON representation.
+     * @returns {IFont} The JSON representation of the font.
      */
     toJSON(): IFont;
 }

package/dist/structures/helpers/Font.js

@@ -1,19 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Font = void 0;
-const enum_1 = require("../../types/enum");
+const types_1 = require("../../types");
+/**
+ * Class representing a font with properties such as family, weight, path, and base64.
+ */
 class Font {
+    /**
+     * The font family.
+     */
     family;
+    /**
+     * The weight of the font.
+     */
     weight;
+    /**
+     * The file path of the font (optional).
+     */
     path;
+    /**
+     * The base64 representation of the font (optional).
+     */
     base64;
+    /**
+     * Constructs a new Font instance with default values.
+     */
     constructor() {
         this.family = "Arial";
-        this.weight = enum_1.FontWeight.Regular;
+        this.weight = types_1.FontWeight.Regular;
     }
     /**
-     * Set the font family
-     * @param family {string} - The `family` of the font
+     * Sets the font family.
+     * @param family {string} - The `family` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the family is not provided.
      */
     setFamily(family) {
         if (!family)
@@ -22,8 +42,10 @@ class Font {
         return this;
     }
     /**
-     * Set the font weight
-     * @param weight {AnyWeight} - The `weight` of the font
+     * Sets the font weight.
+     * @param weight {AnyWeight} - The `weight` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the weight is not provided.
      */
     setWeight(weight) {
         if (!weight)
@@ -32,8 +54,10 @@ class Font {
         return this;
     }
     /**
-     * Set the path of the font
-     * @param path {string} - The `path` of the font
+     * Sets the file path of the font.
+     * @param path {string} - The `path` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the path is not provided.
      */
     setPath(path) {
         if (!path)
@@ -42,8 +66,10 @@ class Font {
         return this;
     }
     /**
-     * Set the base64 of the font
-     * @param base64 {string} - The `base64` of the font
+     * Sets the base64 representation of the font.
+     * @param base64 {Buffer} - The `base64` of the font.
+     * @returns {this} The current instance for chaining.
+     * @throws {Error} If the base64 is not provided.
      */
     setBase64(base64) {
         if (!base64)
@@ -52,7 +78,8 @@ class Font {
         return this;
     }
     /**
-     * @returns {IFont}
+     * Converts the Font instance to a JSON representation.
+     * @returns {IFont} The JSON representation of the font.
      */
     toJSON() {
         return {

package/dist/structures/helpers/Gradient.d.ts

@@ -1,28 +1,115 @@
-import { IGradient, GradientPoint, GradientColorStop, AnyGradientType } from "../../types";
+import { AnyGradientType, FillType } from "../../types";
 import { SKRSContext2D } from "@napi-rs/canvas";
+/**
+ * Interface representing a gradient.
+ */
+export interface IGradient {
+    /**
+     * The type of fill, which is always `Gradient` for this interface.
+     */
+    fillType: FillType;
+    /**
+     * The type of gradient (e.g., linear, radial, conic).
+     */
+    type: AnyGradientType;
+    /**
+     * The points defining the gradient.
+     */
+    points: Array<GradientPoint>;
+    /**
+     * The color stops for the gradient.
+     */
+    stops: Array<GradientColorStop>;
+}
+/**
+ * Interface representing a color stop in a gradient.
+ */
+export interface GradientColorStop {
+    /**
+     * The color of the stop in hexadecimal format.
+     */
+    color: string;
+    /**
+     * The offset of the stop, ranging from 0 to 1.
+     */
+    offset: number;
+}
+/**
+ * Interface representing a point in a gradient.
+ */
+export interface GradientPoint {
+    /**
+     * The x-coordinate of the point.
+     */
+    x: number;
+    /**
+     * The y-coordinate of the point.
+     */
+    y: number;
+    /**
+     * The radius of the point (optional, used for radial gradients).
+     */
+    r?: number;
+    /**
+     * The starting angle of the point (optional, used for conic gradients).
+     */
+    startAngle?: number;
+}
+/**
+ * Class representing a gradient with properties and methods to manipulate it.
+ */
 export declare class Gradient implements IGradient {
+    /**
+     * The type of fill, which is always `Gradient`.
+     */
+    fillType: FillType;
+    /**
+     * The type of gradient (e.g., linear, radial, conic).
+     */
     type: AnyGradientType;
+    /**
+     * The points defining the gradient.
+     */
     points: Array<GradientPoint>;
+    /**
+     * The color stops for the gradient.
+     */
     stops: Array<GradientColorStop>;
-    constructor();
     /**
-     * Set the type of the gradient
-     * @param type {AnyGradientType} - The `type` of the gradient. Can be `linear`, `radial`, or `conic`
+     * Constructs a new Gradient instance.
+     * @param opts {Object} - Optional properties for the gradient.
+     * @param opts.props {IGradient} - The gradient properties.
+     */
+    constructor(opts?: {
+        props?: IGradient;
+    });
+    /**
+     * Sets the type of the gradient.
+     * @param type {AnyGradientType} - The type of the gradient (e.g., linear, radial, conic).
+     * @returns {this} The current instance for chaining.
      */
     setType(type: AnyGradientType): this;
     /**
-     * Add a point to the gradient
-     * @param points {GradientPoint[]} - The `points` to add to the gradient. `{ x: number, y: number }`
+     * Adds points to the gradient.
+     * @param points {GradientPoint[]} - The points to add to the gradient.
+     * @returns {this} The current instance for chaining.
      */
     addPoints(...points: GradientPoint[]): this;
     /**
-     * Add a stop to the gradient
-     * @param stops {GradientColorStop[]} - The `stops` to add to the gradient. `{ color: string, position: number }`
+     * Adds color stops to the gradient.
+     * @param stops {GradientColorStop[]} - The color stops to add to the gradient.
+     * @returns {this} The current instance for chaining.
      */
     addStops(...stops: GradientColorStop[]): this;
+    /**
+     * Draws the gradient on a canvas context.
+     * @param ctx {SKRSContext2D} - The canvas rendering context.
+     * @returns {CanvasGradient} The created gradient.
+     */
     draw(ctx: SKRSContext2D): CanvasGradient;
     /**
-     * @returns {IGradient}
+     * Converts the gradient to a JSON representation.
+     * @returns {IGradient} The JSON representation of the gradient.
      */
     toJSON(): IGradient;
 }

package/dist/structures/helpers/Gradient.js

@@ -1,56 +1,85 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Gradient = void 0;
-const enum_1 = require("../../types/enum");
+const types_1 = require("../../types");
 const utils_1 = require("../../utils/utils");
+/**
+ * Class representing a gradient with properties and methods to manipulate it.
+ */
 class Gradient {
+    /**
+     * The type of fill, which is always `Gradient`.
+     */
+    fillType = types_1.FillType.Gradient;
+    /**
+     * The type of gradient (e.g., linear, radial, conic).
+     */
     type;
+    /**
+     * The points defining the gradient.
+     */
     points;
+    /**
+     * The color stops for the gradient.
+     */
     stops;
-    constructor() {
-        this.type = enum_1.GradientType.Linear;
-        this.points = [];
-        this.stops = [];
+    /**
+     * Constructs a new Gradient instance.
+     * @param opts {Object} - Optional properties for the gradient.
+     * @param opts.props {IGradient} - The gradient properties.
+     */
+    constructor(opts) {
+        this.type = opts?.props?.type || types_1.GradientType.Linear;
+        this.points = opts?.props?.points || [];
+        this.stops = opts?.props?.stops || [];
     }
     /**
-     * Set the type of the gradient
-     * @param type {AnyGradientType} - The `type` of the gradient. Can be `linear`, `radial`, or `conic`
+     * Sets the type of the gradient.
+     * @param type {AnyGradientType} - The type of the gradient (e.g., linear, radial, conic).
+     * @returns {this} The current instance for chaining.
      */
     setType(type) {
         this.type = type;
         return this;
     }
     /**
-     * Add a point to the gradient
-     * @param points {GradientPoint[]} - The `points` to add to the gradient. `{ x: number, y: number }`
+     * Adds points to the gradient.
+     * @param points {GradientPoint[]} - The points to add to the gradient.
+     * @returns {this} The current instance for chaining.
      */
     addPoints(...points) {
         this.points.push(...points);
         return this;
     }
     /**
-     * Add a stop to the gradient
-     * @param stops {GradientColorStop[]} - The `stops` to add to the gradient. `{ color: string, position: number }`
+     * Adds color stops to the gradient.
+     * @param stops {GradientColorStop[]} - The color stops to add to the gradient.
+     * @returns {this} The current instance for chaining.
      */
     addStops(...stops) {
         this.stops.push(...stops);
         return this;
     }
+    /**
+     * Draws the gradient on a canvas context.
+     * @param ctx {SKRSContext2D} - The canvas rendering context.
+     * @returns {CanvasGradient} The created gradient.
+     */
     draw(ctx) {
         let gradientData = this.toJSON();
         let gradient;
         switch (gradientData.type) {
-            case enum_1.GradientType.Linear:
+            case types_1.GradientType.Linear:
             case "linear":
                 gradient = ctx.createLinearGradient(gradientData.points[0].x, gradientData.points[0].y, gradientData.points[1].x, gradientData.points[1].y);
                 break;
-            case enum_1.GradientType.Radial:
+            case types_1.GradientType.Radial:
             case "radial":
-                gradient = ctx.createRadialGradient(gradientData.points[0].x, gradientData.points[0].y, (gradientData.points[0].r || 0), (gradientData.points[1].x || gradientData.points[0].x), (gradientData.points[1].y || gradientData.points[0].y), (gradientData.points[1].r || 0));
+                gradient = ctx.createRadialGradient(gradientData.points[0].x, gradientData.points[0].y, gradientData.points[0].r || 0, gradientData.points[1].x || gradientData.points[0].x, gradientData.points[1].y || gradientData.points[0].y, gradientData.points[1].r || 0);
                 break;
-            case enum_1.GradientType.Conic:
+            case types_1.GradientType.Conic:
             case "conic":
-                gradient = ctx.createConicGradient((gradientData.points[0].startAngle || 0), gradientData.points[0].x, gradientData.points[0].y);
+                gradient = ctx.createConicGradient(gradientData.points[0].startAngle || 0, gradientData.points[0].x, gradientData.points[0].y);
                 break;
             default:
                 gradient = ctx.createLinearGradient(gradientData.points[0].x, gradientData.points[0].y, gradientData.points[1].x, gradientData.points[1].y);
@@ -62,10 +91,12 @@ class Gradient {
         return gradient;
     }
     /**
-     * @returns {IGradient}
+     * Converts the gradient to a JSON representation.
+     * @returns {IGradient} The JSON representation of the gradient.
      */
     toJSON() {
         return {
+            fillType: this.fillType,
             type: this.type,
             points: this.points,
             stops: this.stops,

package/dist/structures/helpers/Link.d.ts

@@ -1,22 +1,66 @@
-import { AnyLinkType, ILink, ScaleType } from "../../types";
+import { AnyLinkType, ScaleType } from "../../types";
+/**
+ * Interface representing a link between layers.
+ */
+export interface ILink {
+    /**
+     * The source layer's ID.
+     */
+    source: string;
+    /**
+     * The type of the link (e.g., width, height, etc.).
+     */
+    type: AnyLinkType;
+    /**
+     * The additional spacing applied to the link.
+     */
+    additionalSpacing: ScaleType;
+}
+/**
+ * Class representing a link between layers with properties and methods to manipulate it.
+ */
 export declare class Link {
+    /**
+     * The source layer's ID.
+     */
     source: string;
+    /**
+     * The type of the link (e.g., width, height, etc.).
+     */
     type: AnyLinkType;
+    /**
+     * The additional spacing applied to the link.
+     */
     additionalSpacing: ScaleType;
-    constructor(props?: ILink);
     /**
-     * @description Sets the source of the link.
-     * @param source {string} - The `id` of the layer to link.
+     * Constructs a new Link instance.
+     * @param opts {Object} - Optional properties for the link.
+     * @param opts.props {ILink} - The link properties.
+     */
+    constructor(opts?: {
+        props?: ILink;
+    });
+    /**
+     * Sets the source of the link.
+     * @param source {string} - The ID of the layer to link.
+     * @returns {this} The current instance for chaining.
      */
     setSource(source: string): this;
     /**
-     * @description Sets the type of the link.
-     * @param type {AnyLinkType} - The `type` of the link.
+     * Sets the type of the link.
+     * @param type {AnyLinkType} - The type of the link.
+     * @returns {this} The current instance for chaining.
      */
     setType(type: AnyLinkType): this;
     /**
-     * @description Sets the additional spacing of the link.
-     * @param additionalSpacing {ScaleType} - The `additionalSpacing` of the link.
+     * Sets the additional spacing of the link.
+     * @param additionalSpacing {ScaleType} - The additional spacing of the link.
+     * @returns {this} The current instance for chaining.
      */
     setSpacing(additionalSpacing: ScaleType): this;
+    /**
+     * Converts the Link instance to a JSON representation.
+     * @returns {ILink} The JSON representation of the link.
+     */
+    toJSON(): ILink;
 }