@nmmty/lazycanvas 0.6.0-dev.f33019 → 0.6.1

package/dist/structures/managers/RenderManager.js

@@ -19,9 +19,9 @@ class RenderManager {
     debug;
     /**
      * Constructs a new RenderManager instance.
-     * @param lazyCanvas {LazyCanvas} - The LazyCanvas instance to use for rendering.
-     * @param opts {Object} - Optional settings for the RenderManager.
-     * @param opts.debug {boolean} - Whether debugging is enabled.
+     * @param {LazyCanvas} [lazyCanvas] - The LazyCanvas instance to use for rendering.
+     * @param {Object} [opts] - Optional settings for the RenderManager.
+     * @param {boolean} [opts.debug] - Whether debugging is enabled.
      */
     constructor(lazyCanvas, opts) {
         this.lazyCanvas = lazyCanvas;
@@ -29,10 +29,10 @@ class RenderManager {
     }
     /**
      * Merges multiple ImageData objects into a single ImageData object.
-     * @param ctx {SKRSContext2D} - The canvas rendering context.
-     * @param imageDataList {ImageData[]} - The list of ImageData objects to merge.
-     * @param width {number} - The width of the resulting ImageData.
-     * @param height {number} - The height of the resulting ImageData.
+     * @param {SKRSContext2D} [ctx] - The canvas rendering context.
+     * @param {ImageData[]} [imageDataList] - The list of ImageData objects to merge.
+     * @param {number} [width] - The width of the resulting ImageData.
+     * @param {number} [height] - The height of the resulting ImageData.
      * @returns {ImageData} The merged ImageData object.
      */
     mergeImageData(ctx, imageDataList, width, height) {
@@ -59,7 +59,7 @@ class RenderManager {
     }
     /**
      * Renders a single layer or group of layers.
-     * @param layer {AnyLayer | Group} - The layer or group to render.
+     * @param {AnyLayer | Group} [layer] - The layer or group to render.
      * @returns {Promise<SKRSContext2D>} The canvas rendering context after rendering.
      */
     async renderLayer(layer) {
@@ -74,7 +74,7 @@ class RenderManager {
     }
     /**
      * Renders all layers statically and exports the result in the specified format.
-     * @param exportType {AnyExport} - The export format (e.g., buffer, SVG, or context).
+     * @param {AnyExport} [exportType] - The export format (e.g., buffer, SVG, or context).
      * @returns {Promise<Buffer | SKRSContext2D | string>} The rendered output in the specified format.
      */
     async renderStatic(exportType) {
@@ -114,7 +114,10 @@ class RenderManager {
         const { width, height } = this.lazyCanvas.options;
         const delay = 1000 / this.lazyCanvas.manager.animation.options.frameRate;
         const { loop, colorSpace, maxColors, transparency, utils } = this.lazyCanvas.manager.animation.options;
+        let frameNumber = 0;
         for (const layer of this.lazyCanvas.manager.layers.toArray()) {
+            // onAnimationFrame hook
+            this.lazyCanvas.manager.plugins.executeHook('onAnimationFrame', this.lazyCanvas, frameNumber);
             const ctx = await this.renderLayer(layer);
             frameBuffer.push(ctx.getImageData(0, 0, width, height));
             if (frameBuffer.length > utils.buffer.size) {
@@ -131,38 +134,50 @@ class RenderManager {
             });
             if (utils.clear)
                 ctx.clearRect(0, 0, width, height);
+            frameNumber++;
         }
         encoder.finish();
         return encoder.bytesView();
     }
     /**
      * Renders all layers and exports the result in the specified format.
-     * @param format {AnyExport} - The export format (e.g., buffer, context, SVG, or canvas).
+     * @param {AnyExport} [format] - The export format (e.g., buffer, context, SVG, or canvas).
      * @returns {Promise<Buffer | SKRSContext2D | Canvas | SvgCanvas | string>} The rendered output in the specified format.
      */
     async render(format) {
+        let result;
+        // beforeRender hook
+        this.lazyCanvas.manager.plugins.executeHook('beforeRender', this.lazyCanvas);
         switch (format) {
             case types_1.Export.BUFFER:
             case "buffer":
                 if (this.lazyCanvas.options.animated) {
-                    return await this.renderAnimation();
+                    result = await this.renderAnimation();
                 }
                 else {
-                    return await this.renderStatic(types_1.Export.BUFFER);
+                    result = await this.renderStatic(types_1.Export.BUFFER);
                 }
+                break;
             case types_1.Export.CTX:
             case "ctx":
-                return this.lazyCanvas.ctx;
+                result = this.lazyCanvas.ctx;
+                break;
             case types_1.Export.SVG:
             case "svg":
-                return this.renderStatic(types_1.Export.SVG);
+                result = await this.renderStatic(types_1.Export.SVG);
+                break;
             case types_1.Export.CANVAS:
             case "canvas":
                 await this.renderStatic(this.lazyCanvas.options.exportType === 'svg' ? types_1.Export.SVG : types_1.Export.BUFFER);
-                return this.lazyCanvas.canvas;
+                result = this.lazyCanvas.canvas;
+                break;
             default:
-                return this.renderStatic(types_1.Export.BUFFER);
+                result = await this.renderStatic(types_1.Export.BUFFER);
+                break;
         }
+        // afterRender hook
+        this.lazyCanvas.manager.plugins.executeHook('afterRender', this.lazyCanvas);
+        return result;
     }
 }
 exports.RenderManager = RenderManager;

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

@@ -0,0 +1,5 @@
+export * from './LayersManager';
+export * from './PluginManager';
+export * from './FontsManager';
+export * from './RenderManager';
+export * from './AnimationManager';

package/dist/structures/managers/index.js

@@ -0,0 +1,21 @@
+"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 __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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./LayersManager"), exports);
+__exportStar(require("./PluginManager"), exports);
+__exportStar(require("./FontsManager"), exports);
+__exportStar(require("./RenderManager"), exports);
+__exportStar(require("./AnimationManager"), exports);

package/dist/utils/utils.d.ts

@@ -1,7 +1,7 @@
 import type { AnyCentring, AnyLayer, AnyTextAlign, ColorType, PointNumber, ScaleType, Transform } from "../types";
 import { LayerType } from "../types";
 import { Canvas, SKRSContext2D, SvgCanvas } from "@napi-rs/canvas";
-import { LayersManager } from "../structures/managers/LayersManager";
+import { LayersManager } from "../structures/managers";
 import { Group } from "../structures/components";
 export declare function generateID(type: string): string;
 export declare function isColor(v: ColorType): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";

package/dist/utils/utils.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resizeLayers = exports.resize = exports.getBoundingBoxBezier = exports.centring = exports.isImageUrlValid = exports.generateRandomName = exports.transform = exports.parseFillStyle = exports.filters = exports.opacity = exports.drawShadow = exports.parser = exports.parseToNormal = exports.isColor = exports.generateID = void 0;
+exports.generateID = generateID;
+exports.isColor = isColor;
+exports.parseToNormal = parseToNormal;
+exports.parser = parser;
+exports.drawShadow = drawShadow;
+exports.opacity = opacity;
+exports.filters = filters;
+exports.parseFillStyle = parseFillStyle;
+exports.transform = transform;
+exports.generateRandomName = generateRandomName;
+exports.isImageUrlValid = isImageUrlValid;
+exports.centring = centring;
+exports.getBoundingBoxBezier = getBoundingBoxBezier;
+exports.resize = resize;
+exports.resizeLayers = resizeLayers;
 const types_1 = require("../types");
 const helpers_1 = require("../structures/helpers");
 const canvas_1 = require("@napi-rs/canvas");
@@ -9,7 +23,6 @@ const components_1 = require("../structures/components");
 function generateID(type) {
     return `${type}-${Math.random().toString(36).substr(2, 9)}`;
 }
-exports.generateID = generateID;
 let percentReg = /^(\d+)%$/;
 let pxReg = /^(\d+)px$/;
 let canvasReg = /^(vw|vh|vmin|vmax)$/;
@@ -22,7 +35,6 @@ let hslaReg = /^hsla\((\d+),\s*(\d+)%,\s*(\d+)%,\s*(0|0?\.\d+|1(\.0)?)\)$/;
 function isColor(v) {
     return typeof (v === 'string' && (hexReg.test(v) || rgbReg.test(v) || rgbaReg.test(v) || hslReg.test(v) || hslaReg.test(v))) || v instanceof helpers_1.Gradient || v instanceof helpers_1.Pattern;
 }
-exports.isColor = isColor;
 function parseToNormal(v, ctx, canvas, layer = { width: 0, height: 0 }, options = { vertical: false, layer: false }, manager) {
     if (typeof v === 'number')
         return v;
@@ -78,7 +90,6 @@ function parseToNormal(v, ctx, canvas, layer = { width: 0, height: 0 }, options
     }
     return 0;
 }
-exports.parseToNormal = parseToNormal;
 function getLayerWidth(anyLayer, ctx, canvas, manager, parserInstance) {
     if (anyLayer instanceof components_1.LineLayer || anyLayer instanceof components_1.BezierLayer || anyLayer instanceof components_1.QuadraticLayer) {
         return anyLayer.getBoundingBox(ctx, canvas, manager).width;
@@ -112,7 +123,6 @@ function parser(ctx, canvas, manager) {
         }
     };
 }
-exports.parser = parser;
 function drawShadow(ctx, shadow) {
     if (shadow) {
         ctx.shadowColor = shadow.color;
@@ -121,19 +131,16 @@ function drawShadow(ctx, shadow) {
         ctx.shadowOffsetY = shadow.offsetY || 0;
     }
 }
-exports.drawShadow = drawShadow;
 function opacity(ctx, opacity = 1) {
     if (opacity < 1) {
         ctx.globalAlpha = opacity;
     }
 }
-exports.opacity = opacity;
 function filters(ctx, filters) {
     if (filters) {
         ctx.filter = filters;
     }
 }
-exports.filters = filters;
 function parseFillStyle(ctx, color, opts) {
     if (!ctx)
         throw new LazyUtil_1.LazyError('The context is not defined');
@@ -144,7 +151,6 @@ function parseFillStyle(ctx, color, opts) {
     }
     return color;
 }
-exports.parseFillStyle = parseFillStyle;
 function transform(ctx, transform, layer = { width: 0, height: 0, x: 0, y: 0, type: types_1.LayerType.Morph }, extra = { text: '', textAlign: types_1.TextAlign.Left, fontSize: 0, multiline: false }) {
     if (transform) {
         if (transform.translate) {
@@ -197,11 +203,9 @@ function transform(ctx, transform, layer = { width: 0, height: 0, x: 0, y: 0, ty
         }
     }
 }
-exports.transform = transform;
 function generateRandomName() {
     return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
 }
-exports.generateRandomName = generateRandomName;
 function isImageUrlValid(src) {
     try {
         (0, canvas_1.loadImage)(src);
@@ -211,7 +215,6 @@ function isImageUrlValid(src) {
         return false;
     }
 }
-exports.isImageUrlValid = isImageUrlValid;
 function centring(centring, type, width, height, x, y) {
     switch (centring) {
         case types_1.Centring.Center:
@@ -307,7 +310,6 @@ function centring(centring, type, width, height, x, y) {
             return { x, y };
     }
 }
-exports.centring = centring;
 function quadraticBezier(p0, p1, p2, t) {
     const x = (1 - t) ** 2 * p0.x + 2 * (1 - t) * t * p1.x + t ** 2 * p2.x;
     const y = (1 - t) ** 2 * p0.y + 2 * (1 - t) * t * p1.y + t ** 2 * p2.y;
@@ -339,7 +341,6 @@ function getBoundingBoxBezier(points, steps = 100) {
     }
     return { min: { x: minX, y: minY }, max: { x: maxX, y: maxY }, center: { x: (minX + maxX) / 2, y: (minY + maxY) / 2 }, width: maxX - minX, height: maxY - minY };
 }
-exports.getBoundingBoxBezier = getBoundingBoxBezier;
 function resize(value, ratio) {
     if (typeof value === 'number') {
         return value * ratio;
@@ -358,7 +359,6 @@ function resize(value, ratio) {
     }
     return value;
 }
-exports.resize = resize;
 function resizeLayers(layers, ratio) {
     let newLayers = [];
     if (layers.length > 0) {
@@ -411,4 +411,3 @@ function resizeLayers(layers, ratio) {
     }
     return newLayers;
 }
-exports.resizeLayers = resizeLayers;

package/package.json

@@ -1,56 +1,59 @@
-{
-  "name": "@nmmty/lazycanvas",
-  "version": "0.6.0-dev.f33019",
-  "description": "A simple way to interact with @napi-rs/canvas in an advanced way!",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "scripts": {
-    "test": "tsc ./test/test.ts && node ./test/test.js",
-    "centring": "tsc ./test/centring.ts && node ./test/centring.js",
-    "logo": "tsc ./test/logo.ts && node ./test/logo.js",
-    "text": "tsc ./test/text.ts && node ./test/text.js",
-    "animation": "tsc ./test/animation.ts && node ./test/animation.js",
-    "iotest": "tsc ./test/iotest.ts && node ./test/iotest.js",
-    "gradient": "tsc ./test/gradient.ts && node ./test/gradient.js",
-    "doc": "tsx docgen.ts",
-    "font": "tsc ./scripts/font-gen.ts && node ./scripts/font-gen.js",
-    "build": "tsc"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/NMMTY/LazyCanvas.git"
-  },
-  "keywords": [
-    "canvas",
-    "@napi-rs/canvas",
-    "node-canvas",
-    "easy",
-    "simple"
-  ],
-  "author": "NMMTY",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/NMMTY/LazyCanvas/issues"
-  },
-  "homepage": "https://github.com/NMMTY/LazyCanvas#readme",
-  "dependencies": {
-    "@napi-rs/canvas": "^0.1.72",
-    "gifenc": "^1.0.3",
-    "js-yaml": "^4.1.0",
-    "path": "^0.12.7",
-    "svgson": "^5.3.1"
-  },
-  "devDependencies": {
-    "@hitomihiumi/colors.ts": "^1.0.3",
-    "@hitomihiumi/micro-docgen": "^0.3.0",
-    "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.10.2",
-    "ava": "^6.2.0",
-    "eslint": "^9.23.0",
-    "eslint-config-neon": "^0.2.7",
-    "lodash.merge": "^4.6.2",
-    "tslib": "^2.8.1",
-    "tsx": "^4.19.2",
-    "typescript": "^5.4.5"
-  }
-}
+{
+  "name": "@nmmty/lazycanvas",
+  "version": "0.6.1",
+  "description": "A simple way to interact with @napi-rs/canvas in an advanced way!",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NMMTY/LazyCanvas.git"
+  },
+  "keywords": [
+    "canvas",
+    "@napi-rs/canvas",
+    "node-canvas",
+    "easy",
+    "simple"
+  ],
+  "author": "NMMTY",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/NMMTY/LazyCanvas/issues"
+  },
+  "homepage": "https://github.com/NMMTY/LazyCanvas#readme",
+  "dependencies": {
+    "@napi-rs/canvas": "^0.1.72",
+    "gifenc": "^1.0.3",
+    "js-yaml": "^4.1.0",
+    "path": "^0.12.7",
+    "svgson": "^5.3.1"
+  },
+  "devDependencies": {
+    "@hitomihiumi/colors.ts": "^1.0.3",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.10.2",
+    "@typescript-eslint/utils": "^8.39.1",
+    "ava": "^6.2.0",
+    "eslint": "^9.23.0",
+    "eslint-config-neon": "^0.2.7",
+    "lodash.merge": "^4.6.2",
+    "tslib": "^2.8.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.4.5",
+    "@hitomihiumi/micro-docgen": "0.4.2"
+  },
+  "scripts": {
+    "test": "tsc ./test/test.ts && node ./test/test.js",
+    "centring": "tsc ./test/centring.ts && node ./test/centring.js",
+    "logo": "tsc ./test/logo.ts && node ./test/logo.js",
+    "text": "tsc ./test/text.ts && node ./test/text.js",
+    "animation": "tsc ./test/animation.ts && node ./test/animation.js",
+    "iotest": "tsc ./test/iotest.ts && node ./test/iotest.js",
+    "gradient": "tsc ./test/gradient.ts && node ./test/gradient.js",
+    "docgen": "tsx docgen.ts && tsx ./scripts/post-docgen.ts",
+    "lint": "eslint ./src --ext .ts",
+    "lint:fix": "eslint ./src --ext .ts --fix",
+    "font": "tsx ./scripts/font-gen.ts",
+    "build": "tsc && tsx ./scripts/post-build.ts"
+  }
+}