@ryuu-reinzz/haruka-lib 1.2.21 → 2.0.0

package/main/sticker-engine/java-script/internal/convert.js

@@ -0,0 +1,69 @@
+import sharp, { fit } from 'sharp';
+import videoToGif from './videoToGif';
+import { writeFile } from 'fs-extra';
+import { tmpdir } from 'os';
+import crop from './crop';
+import { StickerTypes } from './Metadata/StickerTypes';
+import { defaultBg } from '../Utils';
+const convert = async (data, mime, { quality = 100, background = defaultBg, type = StickerTypes.DEFAULT }) => {
+    const isVideo = mime.startsWith('video');
+    let image = isVideo ? await videoToGif(data) : data;
+    const isAnimated = isVideo || mime.includes('gif') || mime.includes('webp');
+    if (isAnimated && ['crop', 'circle', 'rouded'].includes(type)) {
+        const filename = `${tmpdir()}/${Math.random().toString(36)}.webp`;
+        await writeFile(filename, image);
+        [image, type] = [
+            await crop(filename),
+            type === StickerTypes.CIRCLE
+                ? StickerTypes.CIRCLE
+                : type === StickerTypes.ROUNDED
+                    ? StickerTypes.ROUNDED
+                    : StickerTypes.DEFAULT
+        ];
+    }
+    const img = sharp(image, { animated: isAnimated }).toFormat('webp');
+    switch (type) {
+        case StickerTypes.CROPPED:
+            img.resize(512, 512, {
+                fit: fit.cover
+            });
+            break;
+        case StickerTypes.FULL:
+            img.resize(512, 512, {
+                fit: fit.contain,
+                background
+            });
+            break;
+        case StickerTypes.CIRCLE:
+            img.resize(512, 512, {
+                fit: fit.cover
+            }).composite([
+                {
+                    input: Buffer.from(`<svg width="512" height="512"><circle cx="256" cy="256" r="256" fill="${background}"/></svg>`),
+                    blend: 'dest-in',
+                    gravity: 'northeast',
+                    tile: true
+                }
+            ]);
+            break;
+        case StickerTypes.ROUNDED:
+            img.resize(512, 512, {
+                fit: fit.cover
+            }).composite([
+                {
+                    input: Buffer.from(`<svg width="512" height="512"><rect rx="50" ry="50" width="512" height="512" fill="${background}"/></svg>`),
+                    blend: 'dest-in',
+                    gravity: 'northeast',
+                    tile: true
+                }
+            ]);
+            break;
+    }
+    return await img
+        .webp({
+        quality,
+        lossless: false
+    })
+        .toBuffer();
+};
+export default convert;

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

@@ -0,0 +1,2 @@
+declare const crop: (filename: string) => Promise<Buffer>;
+export default crop;

package/main/sticker-engine/java-script/internal/crop.js

@@ -0,0 +1,30 @@
+import Ffmpeg from 'fluent-ffmpeg';
+import { readFile } from 'fs-extra';
+import { tmpdir } from 'os';
+const crop = async (filename) => {
+    const file = await new Promise((resolve) => {
+        const name = `${tmpdir()}/${Math.random().toString(36)}.webp`;
+        Ffmpeg(filename)
+            // eslint-disable-next-line no-useless-escape
+            .outputOptions([
+            '-vcodec',
+            'libwebp',
+            '-vf',
+            // eslint-disable-next-line no-useless-escape
+            `crop=w='min(min(iw\,ih)\,500)':h='min(min(iw\,ih)\,500)',scale=500:500,setsar=1,fps=15`,
+            '-loop',
+            '0',
+            '-preset',
+            'default',
+            '-an',
+            '-vsync',
+            '0',
+            '-s',
+            '512:512'
+        ])
+            .save(name)
+            .on('end', () => resolve(name));
+    });
+    return await readFile(file);
+};
+export default crop;

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

@@ -0,0 +1,2 @@
+declare const imagesToWebp: (filename: string) => Promise<Buffer>;
+export default imagesToWebp;

package/main/sticker-engine/java-script/internal/imagesToWebp.js

@@ -0,0 +1,17 @@
+import Ffmpeg from 'fluent-ffmpeg';
+import { readFile } from 'fs-extra';
+import { tmpdir } from 'os';
+const imagesToWebp = async (filename) => {
+    const file = await new Promise((resolve) => {
+        const name = `${tmpdir()}/${Math.random().toString(36)}.webp`;
+        Ffmpeg(filename)
+            .outputOption('-lavfi split[v],palettegen,[v]paletteuse')
+            .outputOption('-vcodec libwebp')
+            .outputFPS(10)
+            .loop(0)
+            .save(name)
+            .on('end', () => resolve(name));
+    });
+    return await readFile(file);
+};
+export default imagesToWebp;

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

@@ -0,0 +1,3 @@
+/** https://stackoverflow.com/questions/52156713/fluent-ffmpeg-h264-to-gif-throwing-error-1 */
+declare const videoToGif: (data: Buffer) => Promise<Buffer>;
+export default videoToGif;

package/main/sticker-engine/java-script/internal/videoToGif.js

@@ -0,0 +1,16 @@
+import ffmpeg from 'fluent-ffmpeg';
+import { writeFile, readFile, unlink } from 'fs-extra';
+import { tmpdir } from 'os';
+/** https://stackoverflow.com/questions/52156713/fluent-ffmpeg-h264-to-gif-throwing-error-1 */
+const videoToGif = async (data) => {
+    const filename = `${tmpdir()}/${Math.random().toString(36)}`;
+    const [video, gif] = ['video', 'gif'].map((ext) => `${filename}.${ext}`);
+    await writeFile(video, data);
+    await new Promise((resolve) => {
+        ffmpeg(video).save(gif).on('end', resolve);
+    });
+    const buffer = await readFile(gif);
+    [video, gif].forEach((file) => unlink(file));
+    return buffer;
+};
+export default videoToGif;

package/main/sticker-engine/type-script/Sticker.ts

@@ -0,0 +1,206 @@
+import { existsSync, readFile, writeFile } from 'fs-extra'
+import { IStickerConfig, IStickerOptions } from './Types'
+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 { Categories, extractMetadata } from '.'
+import { Color } from 'sharp'
+
+/**
+ * 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(private data: string | Buffer, public metadata: Partial<IStickerOptions> = {}) {
+        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 as StickerTypes)
+            ? this.metadata.type
+            : StickerTypes.DEFAULT
+        this.metadata.background = this.metadata.background ?? defaultBg
+    }
+
+    private _parse = async (): Promise<Buffer> =>
+        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 as string, { responseType: 'arraybuffer' }).then(({ data }) => data))()
+
+    private _getMimeType = async (data: Buffer): Promise<string> => {
+        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()
+     */
+    public build = async (): Promise<Buffer> => {
+        const data = await this._parse()
+        const mime = await this._getMimeType(data)
+        return new Exif(this.metadata as IStickerConfig).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()
+     */
+    public toBuffer = this.build
+
+    public get defaultFilename(): string {
+        return `./${this.metadata.pack}-${this.metadata.author}.webp`
+    }
+
+    /**
+     * 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')
+     */
+    public toFile = async (filename = this.defaultFilename): Promise<string> => {
+        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()
+     */
+    public setPack = (pack: string): this => {
+        this.metadata.pack = pack
+        return this
+    }
+
+    /**
+     * Set the sticker pack author
+     * @param author - Sticker Pack Author
+     * @returns
+     */
+    public setAuthor = (author: string): this => {
+        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()
+     */
+    public setID = (id: string): this => {
+        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(['🌹'])
+     */
+    public setCategories = (categories: Categories[]): this => {
+        this.metadata.categories = categories
+        return this
+    }
+
+    /**
+     * Set the sticker type
+     * @param {StickerTypes|string}[type] - Sticker Type
+     * @returns {this}
+     */
+    public setType = (type: StickerTypes | string): this => {
+        this.metadata.type = type
+        return this
+    }
+
+    /**
+     * Set the sticker quality
+     * @param {number}[quality] - Sticker Quality
+     * @returns {this}
+     */
+    public setQuality = (quality: number): this => {
+        this.metadata.quality = quality
+        return this
+    }
+
+    /**
+     * Set the background color for `full` images
+     * @param {Color}[background] - Background color
+     * @returns {this}
+     */
+    public setBackground = (background: Color): this => {
+        this.metadata.background = background
+        return this
+    }
+
+    /**
+     * @deprecated
+     * Use the `Sticker.build()` method instead
+     */
+    public 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)
+     */
+    public toMessage = async (): Promise<{ sticker: Buffer }> => ({ sticker: await this.build() })
+
+    /**
+     * Extracts metadata from a WebP image.
+     * @param {Buffer}image - The image buffer to extract metadata from
+     */
+    public static 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: ConstructorParameters<typeof Sticker>): Promise<Buffer> => {
+    return new Sticker(...args).build()
+}

package/main/sticker-engine/type-script/Types.ts

@@ -0,0 +1,189 @@
+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

package/main/sticker-engine/type-script/Utils.ts

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

package/main/sticker-engine/type-script/extractMetadata.ts

@@ -0,0 +1,13 @@
+import { Image } from 'node-webpmux'
+import { IRawMetadata } from '.'
+
+/**
+ * Extracts metadata from a WebP image.
+ * @param {Buffer}image - The image buffer to extract metadata from
+ */
+export const extractMetadata = async (image: Buffer): Promise<Partial<IRawMetadata>> => {
+    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) ?? '{}') as IRawMetadata
+}

package/main/sticker-engine/type-script/index.ts

@@ -0,0 +1,9 @@
+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/type-script/internal/Metadata/Exif.ts

@@ -0,0 +1,39 @@
+import { Image } from 'node-webpmux'
+import { TextEncoder } from 'util'
+import { Metadata } from '../../Types'
+import RawMetadata from './RawMetadata'
+
+export default class Exif {
+    private data: RawMetadata
+    private exif: Buffer | null = null
+    constructor(options: Metadata) {
+        this.data = new RawMetadata(options)
+    }
+
+    build = (): Buffer => {
+        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
+    }
+
+    add = async (image: string | Buffer | Image): Promise<Buffer> => {
+        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)
+    }
+}

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

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