@ryuu-reinzz/haruka-lib 1.2.20 → 2.0.0

package/main/index.js

@@ -1,9 +1,12 @@
 import addProperty from "./socket.js";
 import useSQLiteAuthState from "./sqliteAuth.js";
+import Sticker from './sticker-engine/java-script/index.js';
 
 const haruka = {
   addProperty,
   useSQLiteAuthState
 };
 
-export default haruka;
+export default haruka;
+
+export { Sticker };

package/main/socket.js

@@ -4,8 +4,7 @@ import fs from "fs";
 import path from "path";
 import { fileURLToPath } from 'url';
 import { dirname } from 'path';
-import stkPkg from 'wa-sticker-formatter';
-const { Sticker } = stkPkg;
+import Sticker from './sticker-engine/java-script/index.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
@@ -171,6 +170,7 @@ Object.assign(socket, {
                     image = null,
                     video = null,
                     document = null,
+                    fileName = null,
                     mimetype = null,
                     jpegThumbnail = null,
                     location = null,

package/main/sticker-engine/java-script/Sticker.d.ts

@@ -0,0 +1,130 @@
+import { IStickerOptions } from './Types';
+import { StickerTypes } from './internal/Metadata/StickerTypes';
+import { Categories } from '.';
+import { Color } from 'sharp';
+/**
+ * Sticker class
+ */
+export declare class Sticker {
+    private data;
+    metadata: Partial<IStickerOptions>;
+    /**
+     * Sticker Constructor
+     * @param {string|Buffer} [data] - File path, url or Buffer of the image/video to be converted
+     * @param {IStickerOptions} [options] - Sticker options
+     */
+    constructor(data: string | Buffer, metadata?: Partial<IStickerOptions>);
+    private _parse;
+    private _getMimeType;
+    /**
+     * Builds the sticker
+     * @returns {Promise<Buffer>} A promise that resolves to the sticker buffer
+     * @example
+     * const sticker = new Sticker('./image.png')
+     * const buffer = sticker.build()
+     */
+    build: () => Promise<Buffer>;
+    /**
+     * Alias for `.build()`
+     * @param {string} [type] - How you want your sticker to look like
+     * @returns {Promise<Buffer>} A promise that resolves to the sticker buffer
+     * @example
+     * const sticker = new Sticker('./image.png')
+     * const buffer = sticker.build()
+     */
+    toBuffer: () => Promise<Buffer>;
+    get defaultFilename(): string;
+    /**
+     * Saves the sticker to a file
+     * @param [filename] - Filename to save the sticker to
+     * @returns filename
+     * @example
+     * const sticker = new Sticker('./image.png')
+     * sticker.toFile('./image.webp')
+     */
+    toFile: (filename?: string) => Promise<string>;
+    /**
+     * Set the sticker pack title
+     * @param pack - Sticker Pack Title
+     * @returns {this}
+     * @example
+     * const sticker = new Sticker('./image.png')
+     * sticker.setPack('My Sticker Pack')
+     * sticker.build()
+     */
+    setPack: (pack: string) => this;
+    /**
+     * Set the sticker pack author
+     * @param author - Sticker Pack Author
+     * @returns
+     */
+    setAuthor: (author: string) => this;
+    /**
+     * Set the sticker pack ID
+     * @param id - Sticker Pack ID
+     * @returns {this}
+     * @example
+     * const sticker = new Sticker('./image.png')
+     * sticker.setID('my-sticker-pack')
+     * sticker.build()
+     */
+    setID: (id: string) => this;
+    /**
+     * Set the sticker category
+     * @param categories - Sticker Category
+     * @returns {this}
+     * @example
+     * const sticker = new Sticker('./image.png')
+     * sticker.setCategories(['🌹'])
+     */
+    setCategories: (categories: Categories[]) => this;
+    /**
+     * Set the sticker type
+     * @param {StickerTypes|string}[type] - Sticker Type
+     * @returns {this}
+     */
+    setType: (type: StickerTypes | string) => this;
+    /**
+     * Set the sticker quality
+     * @param {number}[quality] - Sticker Quality
+     * @returns {this}
+     */
+    setQuality: (quality: number) => this;
+    /**
+     * Set the background color for `full` images
+     * @param {Color}[background] - Background color
+     * @returns {this}
+     */
+    setBackground: (background: Color) => this;
+    /**
+     * @deprecated
+     * Use the `Sticker.build()` method instead
+     */
+    get: () => Promise<Buffer>;
+    /**
+     * Get BaileysMD-compatible message object
+     * @returns {{ sticker: Buffer }}
+     * @example
+     * import { create } from '@adiwajshing/baileys-md'
+     * const conn = create()
+     * ...
+     * const sticker = new Sticker('./image.png', { pack: 'My Sticker Pack', author: 'Me' })
+     * const message = await sticker.toMessage()
+     * conn.sendMessage(jid, message)
+     */
+    toMessage: () => Promise<{
+        sticker: Buffer;
+    }>;
+    /**
+     * Extracts metadata from a WebP image.
+     * @param {Buffer}image - The image buffer to extract metadata from
+     */
+    static extractMetadata: (image: Buffer) => Promise<Partial<import("./Types").IRawMetadata>>;
+}
+/**
+ *
+ * @param {string|Buffer} data - File path, url or Buffer of the image/video to be converted
+ * @param {IStickerOptions} [options] - Sticker options
+ * @returns {Promise<Buffer>} A promise that resolves to the sticker buffer
+ */
+export declare const createSticker: (...args: ConstructorParameters<typeof Sticker>) => Promise<Buffer>;

package/main/sticker-engine/java-script/Sticker.js

@@ -0,0 +1,187 @@
+import { existsSync, readFile, writeFile } from 'fs-extra';
+import axios from 'axios';
+import Utils, { defaultBg } from './Utils';
+import { fromBuffer } from 'file-type';
+import convert from './internal/convert';
+import Exif from './internal/Metadata/Exif';
+import { StickerTypes } from './internal/Metadata/StickerTypes';
+import { extractMetadata } from '.';
+/**
+ * Sticker class
+ */
+export class Sticker {
+    /**
+     * Sticker Constructor
+     * @param {string|Buffer} [data] - File path, url or Buffer of the image/video to be converted
+     * @param {IStickerOptions} [options] - Sticker options
+     */
+    constructor(data, metadata = {}) {
+        this.data = data;
+        this.metadata = metadata;
+        this._parse = async () => Buffer.isBuffer(this.data)
+            ? this.data
+            : this.data.trim().startsWith('<svg')
+                ? Buffer.from(this.data)
+                : (async () => existsSync(this.data)
+                    ? readFile(this.data)
+                    : axios.get(this.data, { responseType: 'arraybuffer' }).then(({ data }) => data))();
+        this._getMimeType = async (data) => {
+            const type = await fromBuffer(data);
+            if (!type) {
+                if (typeof this.data === 'string')
+                    return 'image/svg+xml';
+                throw new Error('Invalid file type');
+            }
+            return type.mime;
+        };
+        /**
+         * Builds the sticker
+         * @returns {Promise<Buffer>} A promise that resolves to the sticker buffer
+         * @example
+         * const sticker = new Sticker('./image.png')
+         * const buffer = sticker.build()
+         */
+        this.build = async () => {
+            const data = await this._parse();
+            const mime = await this._getMimeType(data);
+            return new Exif(this.metadata).add(await convert(data, mime, this.metadata));
+        };
+        /**
+         * Alias for `.build()`
+         * @param {string} [type] - How you want your sticker to look like
+         * @returns {Promise<Buffer>} A promise that resolves to the sticker buffer
+         * @example
+         * const sticker = new Sticker('./image.png')
+         * const buffer = sticker.build()
+         */
+        this.toBuffer = this.build;
+        /**
+         * Saves the sticker to a file
+         * @param [filename] - Filename to save the sticker to
+         * @returns filename
+         * @example
+         * const sticker = new Sticker('./image.png')
+         * sticker.toFile('./image.webp')
+         */
+        this.toFile = async (filename = this.defaultFilename) => {
+            await writeFile(filename, await this.build());
+            return filename;
+        };
+        /**
+         * Set the sticker pack title
+         * @param pack - Sticker Pack Title
+         * @returns {this}
+         * @example
+         * const sticker = new Sticker('./image.png')
+         * sticker.setPack('My Sticker Pack')
+         * sticker.build()
+         */
+        this.setPack = (pack) => {
+            this.metadata.pack = pack;
+            return this;
+        };
+        /**
+         * Set the sticker pack author
+         * @param author - Sticker Pack Author
+         * @returns
+         */
+        this.setAuthor = (author) => {
+            this.metadata.author = author;
+            return this;
+        };
+        /**
+         * Set the sticker pack ID
+         * @param id - Sticker Pack ID
+         * @returns {this}
+         * @example
+         * const sticker = new Sticker('./image.png')
+         * sticker.setID('my-sticker-pack')
+         * sticker.build()
+         */
+        this.setID = (id) => {
+            this.metadata.id = id;
+            return this;
+        };
+        /**
+         * Set the sticker category
+         * @param categories - Sticker Category
+         * @returns {this}
+         * @example
+         * const sticker = new Sticker('./image.png')
+         * sticker.setCategories(['🌹'])
+         */
+        this.setCategories = (categories) => {
+            this.metadata.categories = categories;
+            return this;
+        };
+        /**
+         * Set the sticker type
+         * @param {StickerTypes|string}[type] - Sticker Type
+         * @returns {this}
+         */
+        this.setType = (type) => {
+            this.metadata.type = type;
+            return this;
+        };
+        /**
+         * Set the sticker quality
+         * @param {number}[quality] - Sticker Quality
+         * @returns {this}
+         */
+        this.setQuality = (quality) => {
+            this.metadata.quality = quality;
+            return this;
+        };
+        /**
+         * Set the background color for `full` images
+         * @param {Color}[background] - Background color
+         * @returns {this}
+         */
+        this.setBackground = (background) => {
+            this.metadata.background = background;
+            return this;
+        };
+        /**
+         * @deprecated
+         * Use the `Sticker.build()` method instead
+         */
+        this.get = this.build;
+        /**
+         * Get BaileysMD-compatible message object
+         * @returns {{ sticker: Buffer }}
+         * @example
+         * import { create } from '@adiwajshing/baileys-md'
+         * const conn = create()
+         * ...
+         * const sticker = new Sticker('./image.png', { pack: 'My Sticker Pack', author: 'Me' })
+         * const message = await sticker.toMessage()
+         * conn.sendMessage(jid, message)
+         */
+        this.toMessage = async () => ({ sticker: await this.build() });
+        this.metadata.author = this.metadata.author ?? '';
+        this.metadata.pack = this.metadata.pack ?? '';
+        this.metadata.id = this.metadata.id ?? Utils.generateStickerID();
+        this.metadata.quality = this.metadata.quality ?? 100;
+        this.metadata.type = Object.values(StickerTypes).includes(this.metadata.type)
+            ? this.metadata.type
+            : StickerTypes.DEFAULT;
+        this.metadata.background = this.metadata.background ?? defaultBg;
+    }
+    get defaultFilename() {
+        return `./${this.metadata.pack}-${this.metadata.author}.webp`;
+    }
+}
+/**
+ * Extracts metadata from a WebP image.
+ * @param {Buffer}image - The image buffer to extract metadata from
+ */
+Sticker.extractMetadata = extractMetadata;
+/**
+ *
+ * @param {string|Buffer} data - File path, url or Buffer of the image/video to be converted
+ * @param {IStickerOptions} [options] - Sticker options
+ * @returns {Promise<Buffer>} A promise that resolves to the sticker buffer
+ */
+export const createSticker = async (...args) => {
+    return new Sticker(...args).build();
+};

package/main/sticker-engine/java-script/Types.d.ts

@@ -0,0 +1,43 @@
+import sharp, { Color } from 'sharp';
+import { StickerTypes } from './internal/Metadata/StickerTypes';
+/** Sticker metadata config */
+export interface IStickerConfig {
+    /** Sticker Pack title*/
+    pack?: string;
+    /** Sticker Pack Author*/
+    author?: string;
+    /** Sticker Pack ID*/
+    id?: string;
+    /** Sticker Category*/
+    categories?: Categories[];
+}
+export interface IStickerOptions extends IStickerConfig {
+    /** How you want your sticker to look like
+     * Can be crop or full. Defaults to 'default' (no changes)
+     */
+    type?: StickerTypes | string;
+    /**
+     * Quality of the output webp image. Must be an integer from 0 to 100 (defaults to 100
+     */
+    quality?: sharp.WebpOptions['quality'];
+    /**
+     * Background Color of the sticker (only for type full)
+     */
+    background?: Color;
+}
+export interface IRawMetadata {
+    emojis: string[];
+    'sticker-pack-id': string;
+    'sticker-pack-name': string;
+    'sticker-pack-publisher': string;
+}
+export type Metadata = IStickerConfig | IStickerOptions;
+type Love = '❤' | '😍' | '😘' | '💕' | '😻' | '💑' | '👩‍❤‍👩' | '👨‍❤‍👨' | '💏' | '👩‍❤‍💋‍👩' | '👨‍❤‍💋‍👨' | '🧡' | '💛' | '💚' | '💙' | '💜' | '🖤' | '💔' | '❣' | '💞' | '💓' | '💗' | '💖' | '💘' | '💝' | '💟' | '♥' | '💌' | '💋' | '👩‍❤️‍💋‍👩' | '👨‍❤️‍💋‍👨' | '👩‍❤️‍👨' | '👩‍❤️‍👩' | '👨‍❤️‍👨' | '👩‍❤️‍💋‍👨' | '👬' | '👭' | '👫' | '🥰' | '😚' | '😙' | '👄' | '🌹' | '😽' | '❣️' | '❤️';
+type Happy = '😀' | '😃' | '😄' | '😁' | '😆' | '😅' | '😂' | '🤣' | '🙂' | '😛' | '😝' | '😜' | '🤪' | '🤗' | '😺' | '😸' | '😹' | '☺' | '😌' | '😉' | '🤗' | '😊';
+type Sad = '☹' | '😣' | '😖' | '😫' | '😩' | '😢' | '😭' | '😞' | '😔' | '😟' | '😕' | '😤' | '😠' | '😥' | '😰' | '😨' | '😿' | '😾' | '😓' | '🙍‍♂' | '🙍‍♀' | '💔' | '🙁' | '🥺' | '🤕' | '☔️' | '⛈' | '🌩' | '🌧';
+type Angry = '😯' | '😦' | '😧' | '😮' | '😲' | '🙀' | '😱' | '🤯' | '😳' | '❗' | '❕' | '🤬' | '😡' | '😠' | '🙄' | '👿' | '😾' | '😤' | '💢' | '👺' | '🗯️' | '😒' | '🥵';
+type Greet = '👋';
+type Celebrate = '🎊' | '🎉' | '🎁' | '🎈' | '👯‍♂️' | '👯' | '👯‍♀️' | '💃' | '🕺' | '🔥' | '⭐️' | '✨' | '💫' | '🎇' | '🎆' | '🍻' | '🥂' | '🍾' | '🎂' | '🍰';
+/** Sticker Category. Learn More: https://github.com/WhatsApp/stickers/wiki/Tag-your-stickers-with-Emojis*/
+export type Categories = Love | Happy | Sad | Angry | Greet | Celebrate;
+export {};

package/main/sticker-engine/java-script/Types.js

@@ -0,0 +1 @@
+export {};

package/main/sticker-engine/java-script/Utils.d.ts

@@ -0,0 +1,9 @@
+export default abstract class Utils {
+    static generateStickerID: () => string;
+}
+export declare const defaultBg: {
+    r: number;
+    g: number;
+    b: number;
+    alpha: number;
+};

package/main/sticker-engine/java-script/Utils.js

@@ -0,0 +1,11 @@
+import { randomBytes } from 'crypto';
+class Utils {
+}
+Utils.generateStickerID = () => randomBytes(32).toString('hex');
+export default Utils;
+export const defaultBg = {
+    r: 0,
+    g: 0,
+    b: 0,
+    alpha: 0
+};

package/main/sticker-engine/java-script/extractMetadata.d.ts

@@ -0,0 +1,6 @@
+import { IRawMetadata } from '.';
+/**
+ * Extracts metadata from a WebP image.
+ * @param {Buffer}image - The image buffer to extract metadata from
+ */
+export declare const extractMetadata: (image: Buffer) => Promise<Partial<IRawMetadata>>;

package/main/sticker-engine/java-script/extractMetadata.js

@@ -0,0 +1,11 @@
+import { Image } from 'node-webpmux';
+/**
+ * Extracts metadata from a WebP image.
+ * @param {Buffer}image - The image buffer to extract metadata from
+ */
+export const extractMetadata = async (image) => {
+    const img = new Image();
+    await img.load(image);
+    const exif = img.exif?.toString('utf-8') ?? '{}';
+    return JSON.parse(exif.substring(exif.indexOf('{'), exif.lastIndexOf('}') + 1) ?? '{}');
+};

package/main/sticker-engine/java-script/index.d.ts

@@ -0,0 +1,8 @@
+import { Sticker } from './Sticker';
+export * from './Sticker';
+export * from './extractMetadata';
+export * from './Types';
+export { default as StickerMetadata } from './internal/Metadata/StickerMetadata';
+export { default as Exif } from './internal/Metadata/Exif';
+export * from './internal/Metadata/StickerTypes';
+export default Sticker;

package/main/sticker-engine/java-script/index.js

@@ -0,0 +1,8 @@
+import { Sticker } from './Sticker';
+export * from './Sticker';
+export * from './extractMetadata';
+export * from './Types';
+export { default as StickerMetadata } from './internal/Metadata/StickerMetadata';
+export { default as Exif } from './internal/Metadata/Exif';
+export * from './internal/Metadata/StickerTypes';
+export default Sticker;

package/main/sticker-engine/java-script/internal/Metadata/Exif.d.ts

@@ -0,0 +1,9 @@
+import { Image } from 'node-webpmux';
+import { Metadata } from '../../Types';
+export default class Exif {
+    private data;
+    private exif;
+    constructor(options: Metadata);
+    build: () => Buffer;
+    add: (image: string | Buffer | Image) => Promise<Buffer>;
+}

package/main/sticker-engine/java-script/internal/Metadata/Exif.js

@@ -0,0 +1,34 @@
+import { Image } from 'node-webpmux';
+import { TextEncoder } from 'util';
+import RawMetadata from './RawMetadata';
+export default class Exif {
+    constructor(options) {
+        this.exif = null;
+        this.build = () => {
+            const data = JSON.stringify(this.data);
+            const exif = Buffer.concat([
+                Buffer.from([
+                    0x49, 0x49, 0x2a, 0x00, 0x08, 0x00, 0x00, 0x00, 0x01, 0x00, 0x41, 0x57, 0x07, 0x00, 0x00, 0x00, 0x00,
+                    0x00, 0x16, 0x00, 0x00, 0x00
+                ]),
+                Buffer.from(data, 'utf-8')
+            ]);
+            exif.writeUIntLE(new TextEncoder().encode(data).length, 14, 4);
+            return exif;
+        };
+        this.add = async (image) => {
+            const exif = this.exif || this.build();
+            image =
+                image instanceof Image
+                    ? image
+                    : await (async () => {
+                        const img = new Image();
+                        await img.load(image);
+                        return img;
+                    })();
+            image.exif = exif;
+            return await image.save(null);
+        };
+        this.data = new RawMetadata(options);
+    }
+}

package/main/sticker-engine/java-script/internal/Metadata/RawMetadata.d.ts

@@ -0,0 +1,8 @@
+import { IRawMetadata, Metadata } from '../../Types';
+export default class RawMetadata implements IRawMetadata {
+    emojis: string[];
+    'sticker-pack-id': string;
+    'sticker-pack-name': string;
+    'sticker-pack-publisher': string;
+    constructor(options: Metadata);
+}

package/main/sticker-engine/java-script/internal/Metadata/RawMetadata.js

@@ -0,0 +1,9 @@
+import Utils from '../../Utils';
+export default class RawMetadata {
+    constructor(options) {
+        this['sticker-pack-id'] = options.id || Utils.generateStickerID();
+        this['sticker-pack-name'] = options.pack || '';
+        this['sticker-pack-publisher'] = options.author || '';
+        this.emojis = options.categories || [];
+    }
+}

package/main/sticker-engine/java-script/internal/Metadata/StickerMetadata.d.ts

@@ -0,0 +1,18 @@
+import { Categories, IStickerConfig, IStickerOptions } from '../../Types';
+export default class StickerMetadata implements IStickerOptions {
+    pack: string;
+    author: string;
+    categories: Categories[];
+    id: string;
+    crop: boolean;
+    full: boolean;
+    constructor(pack?: string, author?: string, categories?: Categories[], id?: string);
+    static from: (object: Partial<StickerMetadata>) => StickerMetadata;
+    setPack: (title: string) => this;
+    setAuthor: (author: string) => this;
+    setId: (id: string) => this;
+    setCrop: (value: boolean) => this;
+    setFull: (value: boolean) => this;
+    setCategories: (categories: string | string[]) => this;
+    toJSON: () => IStickerConfig;
+}

package/main/sticker-engine/java-script/internal/Metadata/StickerMetadata.js

@@ -0,0 +1,49 @@
+import Utils from '../../Utils';
+class StickerMetadata {
+    constructor(pack = '', author = '', categories = [], id = Utils.generateStickerID()) {
+        this.pack = pack;
+        this.author = author;
+        this.categories = categories;
+        this.id = id;
+        this.crop = false;
+        this.full = false;
+        this.setPack = (title) => {
+            this.pack = title;
+            return this;
+        };
+        this.setAuthor = (author) => {
+            this.author = author;
+            return this;
+        };
+        this.setId = (id) => {
+            this.id = id;
+            return this;
+        };
+        this.setCrop = (value) => {
+            this.crop = value;
+            this.full = !value;
+            return this;
+        };
+        this.setFull = (value) => {
+            this.crop = !value;
+            this.full = value;
+            return this;
+        };
+        this.setCategories = (categories) => {
+            this.categories = (typeof categories === 'string' ? categories.split(',').map((emoji) => emoji.trim()) : categories);
+            return this;
+        };
+        this.toJSON = () => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const obj = {};
+            Object.keys(this)
+                .filter((key) => typeof this[key] !== 'function')
+                .forEach((key) => (obj[key] = this[key]));
+            return obj;
+        };
+    }
+}
+StickerMetadata.from = (object) => {
+    return new StickerMetadata(object.pack, object.author, object.categories, object.id);
+};
+export default StickerMetadata;

package/main/sticker-engine/java-script/internal/Metadata/StickerTypes.d.ts

@@ -0,0 +1,7 @@
+export declare enum StickerTypes {
+    DEFAULT = "default",
+    CROPPED = "crop",
+    FULL = "full",
+    CIRCLE = "circle",
+    ROUNDED = "rounded"
+}

package/main/sticker-engine/java-script/internal/Metadata/StickerTypes.js

@@ -0,0 +1,8 @@
+export var StickerTypes;
+(function (StickerTypes) {
+    StickerTypes["DEFAULT"] = "default";
+    StickerTypes["CROPPED"] = "crop";
+    StickerTypes["FULL"] = "full";
+    StickerTypes["CIRCLE"] = "circle";
+    StickerTypes["ROUNDED"] = "rounded";
+})(StickerTypes || (StickerTypes = {}));

package/main/sticker-engine/java-script/internal/convert.d.ts

@@ -0,0 +1,3 @@
+import { IStickerOptions } from '..';
+declare const convert: (data: Buffer, mime: string, { quality, background, type }: IStickerOptions) => Promise<Buffer>;
+export default convert;