@nmmty/lazycanvas 0.4.0 → 0.5.1

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, StringColorType } 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: StringColorType;
+    /**
+     * 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,71 +1,101 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Gradient = void 0;
-const enum_1 = require("../../types/enum");
-const utils_1 = require("../../utils/utils");
+const types_1 = require("../../types");
+/**
+ * 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);
                 break;
         }
         for (let stop of gradientData.stops) {
-            gradient.addColorStop(stop.offset, (0, utils_1.parseHex)(stop.color));
+            gradient.addColorStop(stop.offset, stop.color);
         }
         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 layers 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 layers 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;
 }

package/dist/structures/helpers/Link.js

@@ -1,39 +1,70 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Link = void 0;
-const enum_1 = require("../../types/enum");
+const types_1 = require("../../types");
+/**
+ * Class representing a link between layers with properties and methods to manipulate it.
+ */
 class Link {
+    /**
+     * The source layers ID.
+     */
     source;
+    /**
+     * The type of the link (e.g., width, height, etc.).
+     */
     type;
+    /**
+     * The additional spacing applied to the link.
+     */
     additionalSpacing;
-    constructor(props) {
-        this.source = props?.source || '';
-        this.type = props?.type || enum_1.LinkType.Width;
-        this.additionalSpacing = props?.additionalSpacing || 0;
+    /**
+     * Constructs a new Link instance.
+     * @param opts {Object} - Optional properties for the link.
+     * @param opts.props {ILink} - The link properties.
+     */
+    constructor(opts) {
+        this.source = opts?.props?.source || '';
+        this.type = opts?.props?.type || types_1.LinkType.Width;
+        this.additionalSpacing = opts?.props?.additionalSpacing || 0;
     }
     /**
-     * @description Sets the source of the link.
-     * @param source {string} - The `id` of the layer to link.
+     * 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) {
         this.source = source;
         return 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) {
         this.type = type;
         return 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) {
         this.additionalSpacing = additionalSpacing;
         return this;
     }
+    /**
+     * Converts the Link instance to a JSON representation.
+     * @returns {ILink} The JSON representation of the link.
+     */
+    toJSON() {
+        return {
+            source: this.source,
+            type: this.type,
+            additionalSpacing: this.additionalSpacing
+        };
+    }
 }
 exports.Link = Link;

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

@@ -1,23 +1,68 @@
-import { IPattern, AnyPatternType } from "../../types";
+import { FillType, AnyPatternType } from "../../types";
 import { LazyCanvas } from "../LazyCanvas";
 import { SKRSContext2D } from "@napi-rs/canvas";
+/**
+ * Interface representing a pattern.
+ */
+export interface IPattern {
+    /**
+     * The type of fill, which is always `Pattern` for this interface.
+     */
+    fillType: FillType;
+    /**
+     * The type of the pattern (e.g., repeat, no-repeat, etc.).
+     */
+    type: AnyPatternType;
+    /**
+     * The source of the pattern, which can be a string (URL or path) or a LazyCanvas instance.
+     */
+    src: string | LazyCanvas;
+}
+/**
+ * Class representing a pattern with properties and methods to manipulate it.
+ */
 export declare class Pattern implements IPattern {
+    /**
+     * The type of fill, which is always `Pattern`.
+     */
+    fillType: FillType;
+    /**
+     * The type of the pattern (e.g., repeat, no-repeat, etc.).
+     */
     type: AnyPatternType;
+    /**
+     * The source of the pattern, which can be a string (URL or path) or a LazyCanvas instance.
+     */
     src: string | LazyCanvas;
-    constructor();
     /**
-     * Set the type of the pattern
-     * @param type {AnyPatternType} - The `type` of the pattern
+     * Constructs a new Pattern instance.
+     * @param opts {Object} - Optional properties for the pattern.
+     * @param opts.props {IPattern} - The pattern properties.
+     */
+    constructor(opts?: {
+        props?: IPattern;
+    });
+    /**
+     * Sets the type of the pattern.
+     * @param type {AnyPatternType} - The type of the pattern (e.g., repeat, no-repeat).
+     * @returns {this} The current instance for chaining.
      */
     setType(type: AnyPatternType): this;
     /**
-     * Set the source of the pattern
-     * @param src {string | LazyCanvas} - The `src` of the pattern
+     * Sets the source of the pattern.
+     * @param src {string | LazyCanvas} - The source of the pattern, which can be a string (URL or path) or a LazyCanvas instance.
+     * @returns {this} The current instance for chaining.
      */
     setSrc(src: string | LazyCanvas): this;
+    /**
+     * Draws the pattern on a canvas context.
+     * @param ctx {SKRSContext2D} - The canvas rendering context.
+     * @returns {Promise<CanvasPattern>} The created pattern.
+     */
     draw(ctx: SKRSContext2D): Promise<CanvasPattern>;
     /**
-     * @returns {IPattern}
+     * Converts the Pattern instance to a JSON representation.
+     * @returns {IPattern} The JSON representation of the pattern.
      */
     toJSON(): IPattern;
 }