apexify.js 4.9.25 → 4.9.27

package/dist/cjs/tsconfig.cjs.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../lib/index.ts","../../lib/utils.ts","../../lib/canvas/apexpainter.ts","../../lib/canvas/utils/types.ts","../../lib/canvas/utils/utils.ts","../../lib/canvas/utils/background/bg.ts","../../lib/canvas/utils/charts/charts.ts","../../lib/canvas/utils/custom/customlines.ts","../../lib/canvas/utils/general/conversion.ts","../../lib/canvas/utils/general/general functions.ts","../../lib/canvas/utils/image/imageproperties.ts","../../lib/canvas/utils/texts/textproperties.ts"],"version":"5.7.3"}
+{"root":["../../lib/index.ts","../../lib/utils.ts","../../lib/canvas/apexpainter.ts","../../lib/canvas/utils/types.ts","../../lib/canvas/utils/utils.ts","../../lib/canvas/utils/background/bg.ts","../../lib/canvas/utils/charts/charts.ts","../../lib/canvas/utils/custom/customlines.ts","../../lib/canvas/utils/general/conversion.ts","../../lib/canvas/utils/general/general functions.ts","../../lib/canvas/utils/image/imagefilters.ts","../../lib/canvas/utils/image/imageproperties.ts","../../lib/canvas/utils/image/professionalimagefilters.ts","../../lib/canvas/utils/image/simpleprofessionalfilters.ts","../../lib/canvas/utils/patterns/enhancedpatternrenderer.ts","../../lib/canvas/utils/shapes/shapes.ts","../../lib/canvas/utils/texts/enhancedtextrenderer.ts","../../lib/canvas/utils/texts/textproperties.ts"],"version":"5.7.3"}

package/dist/cjs/utils.d.ts

@@ -1,3 +1,3 @@
-import { ApexPainter } from "./canvas/ApexPainter";
+import { ApexPainter } from "./Canvas/ApexPainter";
 export { ApexPainter };
 //# sourceMappingURL=utils.d.ts.map

package/dist/cjs/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApexPainter = void 0;
-const ApexPainter_1 = require("./canvas/ApexPainter");
+const ApexPainter_1 = require("./Canvas/ApexPainter");
 Object.defineProperty(exports, "ApexPainter", { enumerable: true, get: function () { return ApexPainter_1.ApexPainter; } });
 //# sourceMappingURL=utils.js.map

package/dist/esm/Canvas/ApexPainter.d.ts

@@ -0,0 +1,189 @@
+import { PathLike } from "fs";
+import { OutputFormat, CanvasConfig, TextProperties, ImageProperties, GIFOptions, GIFResults, CustomOptions, cropOptions, Frame, ExtractFramesOptions, ResizeOptions, MaskOptions, BlendOptions } from "./utils/utils";
+interface CanvasResults {
+    buffer: Buffer;
+    canvas: CanvasConfig;
+}
+export declare class ApexPainter {
+    #private;
+    private format?;
+    constructor({ type }?: OutputFormat);
+    /**
+     * Creates a canvas with the given configuration.
+     * Applies rotation, shadow, border effects, background, and stroke.
+     *
+     * @param canvas - Canvas configuration object containing:
+     *   - width: Canvas width in pixels
+     *   - height: Canvas height in pixels
+     *   - x: X position offset (default: 0)
+     *   - y: Y position offset (default: 0)
+     *   - colorBg: Solid color background (hex, rgb, rgba, hsl, etc.)
+     *   - gradientBg: Gradient background configuration
+     *   - customBg: Custom background image buffer
+     *   - zoom: Canvas zoom level (default: 1)
+     *   - pattern: Pattern background configuration
+     *   - noise: Noise effect configuration
+     *
+     * @returns Promise<CanvasResults> - Object containing canvas buffer and configuration
+     *
+     * @throws Error if canvas configuration is invalid or conflicting
+     *
+     * @example
+     * ```typescript
+     * const result = await painter.createCanvas({
+     *   width: 800,
+     *   height: 600,
+     *   colorBg: '#ffffff',
+     *   zoom: 1.5
+     * });
+     * const buffer = result.buffer;
+     * ```
+     */
+    createCanvas(canvas: CanvasConfig): Promise<CanvasResults>;
+    /**
+     * Draws one or more images (or shapes) on an existing canvas buffer.
+     *
+     * @param images - Single ImageProperties object or array of ImageProperties containing:
+     *   - source: Image path/URL/Buffer or ShapeType ('rectangle', 'circle', etc.)
+     *   - x: X position on canvas
+     *   - y: Y position on canvas
+     *   - width: Image/shape width (optional, defaults to original size)
+     *   - height: Image/shape height (optional, defaults to original size)
+     *   - inherit: Use original image dimensions (boolean)
+     *   - fit: Image fitting mode ('fill', 'contain', 'cover', 'scale-down', 'none')
+     *   - align: Image alignment ('center', 'start', 'end')
+     *   - rotation: Rotation angle in degrees (default: 0)
+     *   - opacity: Opacity level 0-1 (default: 1)
+     *   - blur: Blur radius in pixels (default: 0)
+     *   - borderRadius: Border radius or 'circular' (default: 0)
+     *   - borderPosition: Border position ('all', 'top', 'bottom', 'left', 'right')
+     *   - filters: Array of image filters to apply
+     *   - shape: Shape properties (when source is a shape)
+     *   - shadow: Shadow configuration
+     *   - stroke: Stroke configuration
+     *   - boxBackground: Background behind image/shape
+     *
+     * @param canvasBuffer - Existing canvas buffer (Buffer) or CanvasResults object
+     *
+     * @returns Promise<Buffer> - Updated canvas buffer in PNG format
+     *
+     * @throws Error if source, x, or y are missing
+     *
+     * @example
+     * ```typescript
+     * const result = await painter.createImage([
+     *   {
+     *     source: 'rectangle',
+     *     x: 100, y: 100,
+     *     width: 200, height: 150,
+     *     shape: { fill: true, color: '#ff6b6b' },
+     *     shadow: { color: 'rgba(0,0,0,0.3)', offsetX: 5, offsetY: 5, blur: 10 }
+     *   }
+     * ], canvasBuffer);
+     * ```
+     */
+    createImage(images: ImageProperties | ImageProperties[], canvasBuffer: CanvasResults | Buffer): Promise<Buffer>;
+    /**
+     * Creates text on an existing canvas buffer with enhanced styling options.
+     *
+     * @param textArray - Single TextProperties object or array of TextProperties containing:
+     *   - text: Text content to render (required)
+     *   - x: X position on canvas (required)
+     *   - y: Y position on canvas (required)
+     *   - fontPath: Path to custom font file (.ttf, .otf, .woff, etc.)
+     *   - fontName: Custom font name (used with fontPath)
+     *   - fontSize: Font size in pixels (default: 16)
+     *   - fontFamily: Font family name (e.g., 'Arial', 'Helvetica')
+     *   - bold: Make text bold (boolean)
+     *   - italic: Make text italic (boolean)
+     *   - underline: Add underline decoration (boolean)
+     *   - overline: Add overline decoration (boolean)
+     *   - strikethrough: Add strikethrough decoration (boolean)
+     *   - highlight: Highlight text with background color and opacity
+     *   - lineHeight: Line height multiplier (default: 1.4)
+     *   - letterSpacing: Space between letters in pixels
+     *   - wordSpacing: Space between words in pixels
+     *   - maxWidth: Maximum width for text wrapping
+     *   - maxHeight: Maximum height for text (truncates with ellipsis)
+     *   - textAlign: Horizontal text alignment ('left', 'center', 'right', 'start', 'end')
+     *   - textBaseline: Vertical text baseline ('alphabetic', 'bottom', 'hanging', 'ideographic', 'middle', 'top')
+     *   - color: Text color (hex, rgb, rgba, hsl, etc.)
+     *   - gradient: Gradient fill for text
+     *   - opacity: Text opacity (0-1, default: 1)
+     *   - glow: Text glow effect with color, intensity, and opacity
+     *   - shadow: Text shadow effect with color, offset, blur, and opacity
+     *   - stroke: Text stroke/outline with color, width, gradient, and opacity
+     *   - rotation: Text rotation in degrees
+     *
+     * @param canvasBuffer - Existing canvas buffer (Buffer) or CanvasResults object
+     *
+     * @returns Promise<Buffer> - Updated canvas buffer in PNG format
+     *
+     * @throws Error if text, x, or y are missing, or if canvas buffer is invalid
+     *
+     * @example
+     * ```typescript
+     * const result = await painter.createText([
+     *   {
+     *     text: "Hello World!",
+     *     x: 100, y: 100,
+     *     fontSize: 24,
+     *     bold: true,
+     *     color: '#ff6b6b',
+     *     shadow: { color: 'rgba(0,0,0,0.3)', offsetX: 2, offsetY: 2, blur: 4 },
+     *     underline: true,
+     *     highlight: { color: '#ffff00', opacity: 0.3 }
+     *   }
+     * ], canvasBuffer);
+     * ```
+     */
+    createText(textArray: TextProperties | TextProperties[], canvasBuffer: CanvasResults | Buffer): Promise<Buffer>;
+    createCustom(options: CustomOptions[], buffer: CanvasResults | Buffer): Promise<Buffer>;
+    createGIF(gifFrames: {
+        background: string;
+        duration: number;
+    }[], options: GIFOptions): Promise<GIFResults | any>;
+    resize(resizeOptions: ResizeOptions): Promise<Buffer<ArrayBufferLike>>;
+    imgConverter(source: string, newExtension: string): Promise<Buffer<ArrayBufferLike>>;
+    effects(source: string, filters: any[]): Promise<Buffer<ArrayBufferLike>>;
+    colorsFilter(source: string, filterColor: any, opacity?: number): Promise<any>;
+    colorAnalysis(source: string): Promise<{
+        color: string;
+        frequency: string;
+    }[]>;
+    colorsRemover(source: string, colorToRemove: {
+        red: number;
+        green: number;
+        blue: number;
+    }): Promise<Buffer<ArrayBufferLike> | undefined>;
+    removeBackground(imageURL: string, apiKey: string): Promise<Buffer<ArrayBufferLike> | undefined>;
+    blend(layers: {
+        image: string | Buffer;
+        blendMode: 'source-over' | 'source-in' | 'source-out' | 'source-atop' | 'destination-over' | 'destination-in' | 'destination-out' | 'destination-atop' | 'lighter' | 'copy' | 'xor' | 'multiply' | 'screen' | 'overlay' | 'darken' | 'lighten' | 'color-dodge' | 'color-burn' | 'hard-light' | 'soft-light' | 'difference' | 'exclusion' | 'hue' | 'saturation' | 'color' | 'luminosity';
+        position?: {
+            x: number;
+            y: number;
+        };
+        opacity?: number;
+    }[], baseImageBuffer: Buffer, defaultBlendMode?: 'source-over' | 'source-in' | 'source-out' | 'source-atop' | 'destination-over' | 'destination-in' | 'destination-out' | 'destination-atop' | 'lighter' | 'copy' | 'xor' | 'multiply' | 'screen' | 'overlay' | 'darken' | 'lighten' | 'color-dodge' | 'color-burn' | 'hard-light' | 'soft-light' | 'difference' | 'exclusion' | 'hue' | 'saturation' | 'color' | 'luminosity'): Promise<Buffer>;
+    createChart(data: any, type: {
+        chartType: string;
+        chartNumber: number;
+    }): Promise<Buffer<ArrayBufferLike> | undefined>;
+    cropImage(options: cropOptions): Promise<Buffer>;
+    private drawImage;
+    extractFrames(videoSource: string | Buffer, options: ExtractFramesOptions): Promise<any[]>;
+    masking(source: string | Buffer | PathLike | Uint8Array, maskSource: string | Buffer | PathLike | Uint8Array, options?: MaskOptions): Promise<Buffer>;
+    gradientBlend(source: string | Buffer | PathLike | Uint8Array, options: BlendOptions): Promise<Buffer>;
+    animate(frames: Frame[], defaultDuration: number, defaultWidth?: number, defaultHeight?: number, options?: {
+        gif?: boolean;
+        gifPath?: string;
+        onStart?: () => void;
+        onFrame?: (index: number) => void;
+        onEnd?: () => void;
+    }): Promise<Buffer[] | undefined>;
+    validHex(hexColor: string): any;
+    outPut(results: any): Promise<void | Buffer | string | Blob | Object | HTMLCanvasElement>;
+}
+export {};
+//# sourceMappingURL=ApexPainter.d.ts.map

package/dist/esm/Canvas/ApexPainter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApexPainter.d.ts","sourceRoot":"","sources":["../../../lib/Canvas/ApexPainter.ts"],"names":[],"mappings":"AAKA,OAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAElC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAc,cAAc,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAGC,KAAK,EACrH,oBAAoB,EAAa,aAAa,EAAE,WAAW,EAAE,YAAY,EAIzF,MAAM,eAAe,CAAC;AAKzB,UAAU,aAAa;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;CACtB;AAGH,qBAAa,WAAW;;IACtB,OAAO,CAAC,MAAM,CAAC,CAAe;gBAElB,EAAE,IAAI,EAAE,GAAE,YAAiC;IAoCvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACC,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IA4F9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,WAAW,CACf,MAAM,EAAE,eAAe,GAAG,eAAe,EAAE,EAC3C,YAAY,EAAE,aAAa,GAAG,MAAM,GACnC,OAAO,CAAC,MAAM,CAAC;IAgWlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACG,UAAU,CAAC,SAAS,EAAE,cAAc,GAAG,cAAc,EAAE,EAAE,YAAY,EAAE,aAAa,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkD/G,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE,MAAM,EAAE,aAAa,GAAG,MAAM,GAAK,OAAO,CAAC,MAAM,CAAC;IAmC3F,SAAS,CAAC,SAAS,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,GAAG,CAAC;IAwH9G,MAAM,CAAC,aAAa,EAAE,aAAa;IAInC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAIjD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE;IAItC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM;IAI/D,aAAa,CAAC,MAAM,EAAE,MAAM;;;;IAI5B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IAIzF,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAIjD,KAAK,CACT,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,SAAS,EAAE,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,GAC1D,kBAAkB,GAAG,gBAAgB,GAAG,iBAAiB,GACzD,kBAAkB,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAC/C,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAC5C,SAAS,GAAG,aAAa,GAAG,YAAY,GACxC,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,WAAW,GACxD,KAAK,GAAG,YAAY,GAAG,OAAO,GAAG,YAAY,CAAC;QACzD,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACpC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,EAAE,EACH,eAAe,EAAE,MAAM,EACvB,gBAAgB,GAAE,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,GAC1D,kBAAkB,GAAG,gBAAgB,GAAG,iBAAiB,GACzD,kBAAkB,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAC/C,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAC5C,SAAS,GAAG,aAAa,GAAG,YAAY,GACxC,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,WAAW,GACxD,KAAK,GAAG,YAAY,GAAG,OAAO,GAAG,YAA4B,GAC9E,OAAO,CAAC,MAAM,CAAC;IA4BZ,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAC;IA8CrE,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;YAkBzC,SAAS;IAMnB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA8E1F,OAAO,CACX,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,EAC/C,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,EACnD,OAAO,GAAE,WAA+B,GACvC,OAAO,CAAC,MAAM,CAAC;IA0CZ,aAAa,CACjB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,EAC/C,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,MAAM,CAAC;IAyCZ,OAAO,CACX,MAAM,EAAE,KAAK,EAAE,EACf,eAAe,EAAE,MAAM,EACvB,YAAY,GAAE,MAAY,EAC1B,aAAa,GAAE,MAAY,EAC3B,OAAO,CAAC,EAAE;QACN,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;QACrB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;QAClC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;KACtB,GACA,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;IA8HzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG;IAQvB,MAAM,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,iBAAiB,CAAC;CAoBxG"}