@hellkite/pipkin 0.6.2 → 0.8.0

package/src/lib/template.ts

@@ -1,17 +1,17 @@
 import * as fs from 'fs';
 import { parse as parseCsv } from 'papaparse';
-import { Jimp, rgbaToInt } from 'jimp';
+import { Jimp } from 'jimp';
 import camelCase from 'lodash.camelcase';
 import concat from 'lodash.concat';
-import { registerFont } from 'canvas';
 import path from 'path';
 import {
-    drawBoundingBox,
+    placeBoundingBox,
     gridPackingFn,
     hboxPackingFn,
-    placeImage,
-    renderText,
+    htmlToImage,
     vboxPackingFn,
+    boundingBoxToPx,
+    toPx,
 } from './utils';
 import {
     DirectionContainerOptions,
@@ -31,37 +31,28 @@ import {
     LayerOptions,
     ContainerOptions,
     DEFAULT_CONTAINER_OPTIONS,
+    HyperNode,
+    ElementsFn,
+    ElementRef,
+    ImageLayerSpecificOptions,
+    TextLayerSpecificOptions,
+    SCALE_MODE_TO_OBJECT_FIT,
+    StaticImageRef,
+    TemplateOptions,
+    DEFAULT_TEMPLATE_OPTIONS,
 } from './types';
 import merge from 'lodash.merge';
 import { RequiredDeep } from 'type-fest';
+import { h } from 'virtual-dom';
+import flatten from 'lodash.flatten';
+import { ReplacementBuilder } from './replacement';
 
-type RequiredTemplateOptions = {
-    height: number;
-    width: number;
-    color: number;
-};
-
-type OptionalTemplateOptions = Partial<{
-    defaultFontFamily: string;
-    defaultAssetsPath: string;
-}>;
-
-export type TemplateOptions = RequiredTemplateOptions & OptionalTemplateOptions;
-
-const DEFAULT_TEMPLATE_OPTIONS: RequiredTemplateOptions = {
-    height: 1050,
-    width: 750,
-    color: rgbaToInt(255, 255, 255, 255),
-};
-
-export type LayerFnContext = {
-    debugMode: boolean;
-};
+export type LayerFnContext = {};
 
 export type LayerFn<EntryType> = (
     entry: EntryType,
     context: LayerFnContext,
-) => Promise<ImageType | undefined>;
+) => Promise<Array<HyperNode>>;
 
 export type TemplateLayerFn<EntryType extends Record<string, string>> = (
     template: Template<EntryType>,
@@ -70,8 +61,9 @@ export type TemplateLayerFn<EntryType extends Record<string, string>> = (
 export class Template<EntryType extends Record<string, string>> {
     private readonly fonts: Record<string, string> = {};
     private readonly layers: LayerFn<EntryType>[] = [];
+    private readonly debugPoints: Array<number> = [];
     private readonly background: ImageType;
-    private debugMode: boolean = false;
+    private renderBoundingBox?: boolean;
     private defaultFontFamily?: string;
     private defaultAssetsPath?: string;
 
@@ -102,13 +94,6 @@ export class Template<EntryType extends Record<string, string>> {
         });
     }
 
-    private shadowBackground(): ImageType {
-        return new Jimp({
-            width: this.background.width,
-            height: this.background.height,
-        });
-    }
-
     private get backgroundSize(): Size {
         return {
             width: this.background.width,
@@ -122,100 +107,113 @@ export class Template<EntryType extends Record<string, string>> {
     }
 
     template = (fn: TemplateLayerFn<EntryType>): this =>
-        this.layer(entry => {
+        this.layer(async entry => {
             const template = fn(this.shadowTemplate());
-            return template.render(entry);
+            const image = await template.render(entry);
+            return [
+                await this.placeImage({
+                    image,
+                    box: {
+                        left: 0,
+                        top: 0,
+                        ...this.backgroundSize,
+                    },
+                    options: DEFAULT_IMAGE_LAYER_OPTIONS,
+                }),
+            ];
         });
 
     container = (
-        imagesFn: (entry: EntryType) => Promise<Array<ImageType>>,
+        elementsFn: ElementsFn,
         box: BoundingBox,
         packingFn: PackingFn,
         options?: ContainerOptions<EntryType>,
     ): this =>
-        this.layer(async (entry: EntryType, { debugMode }) => {
+        this.layer(async (entry: EntryType) => {
             const mergedOptions: RequiredDeep<ContainerOptions<EntryType>> =
-                merge({}, DEFAULT_CONTAINER_OPTIONS, options);
+                merge(
+                    {},
+                    DEFAULT_CONTAINER_OPTIONS,
+                    { renderBoundingBox: this.renderBoundingBox },
+                    options,
+                );
             if (this.shouldSkipLayerForEntry(entry, mergedOptions)) {
-                return undefined;
+                return [];
             }
 
-            const images = await imagesFn(entry);
-            const result = await packingFn(
-                box,
-                this.shadowBackground(),
-                images,
+            const elementRefs = await elementsFn(entry);
+            const elements = await Promise.all(
+                elementRefs.map(elementRef =>
+                    this.elementFromElementRef(entry, elementRef),
+                ),
             );
+            const result = await packingFn(box, elements);
 
             // debug mode
-            if (debugMode) {
-                const debugImage = await drawBoundingBox(
-                    box,
-                    this.backgroundSize,
-                );
-                return debugImage.composite(result);
+            if (mergedOptions.renderBoundingBox) {
+                const debugImage = await placeBoundingBox(box);
+                return [result, debugImage];
             }
 
-            return result;
+            return [result];
         });
 
     hbox = (
-        imagesFn: (entry: EntryType) => Promise<Array<ImageType>>,
+        elementsFn: ElementsFn,
         box: BoundingBox,
         options?: DirectionContainerOptions<EntryType>,
-    ): this => this.container(imagesFn, box, hboxPackingFn(options), options);
+    ): this => this.container(elementsFn, box, hboxPackingFn(options), options);
 
     vbox = (
-        imagesFn: (entry: EntryType) => Promise<Array<ImageType>>,
+        elementsFn: ElementsFn,
         box: BoundingBox,
         options?: DirectionContainerOptions<EntryType>,
-    ): this => this.container(imagesFn, box, vboxPackingFn(options), options);
+    ): this => this.container(elementsFn, box, vboxPackingFn(options), options);
 
     grid = (
-        imagesFn: (entry: EntryType) => Promise<Array<ImageType>>,
+        elementsFn: ElementsFn,
         box: BoundingBox,
         options?: GridContainerOptions<EntryType>,
-    ): this => this.container(imagesFn, box, gridPackingFn(options), options);
+    ): this => this.container(elementsFn, box, gridPackingFn(options), options);
 
     image = (
         ref: ImageRef<EntryType>,
         box: BoundingBox,
         options: ImageLayerOptions<EntryType>,
     ): this =>
-        this.layer(async (entry, { debugMode }) => {
+        this.layer(async entry => {
             const mergedOptions: RequiredDeep<ImageLayerOptions<EntryType>> =
                 merge(
                     {},
                     DEFAULT_IMAGE_LAYER_OPTIONS,
-                    { assetsPath: this.defaultAssetsPath },
+                    {
+                        assetsPath: this.defaultAssetsPath,
+                        renderBoundingBox: this.renderBoundingBox,
+                    },
                     options,
                 );
             if (this.shouldSkipLayerForEntry(entry, mergedOptions)) {
-                return undefined;
+                return [];
             }
 
-            const image = await this.pathFromImageRef(
+            const image = await this.imageFromImageRef(
                 entry,
                 ref,
-                mergedOptions,
+                mergedOptions.assetsPath,
             );
-            const result = await placeImage({
+            const result = await this.placeImage({
                 image,
                 box,
-                backgroundSize: this.backgroundSize,
                 options: mergedOptions,
             });
 
             // debug mode
-            if (debugMode) {
-                const debugImage = await drawBoundingBox(
-                    box,
-                    this.backgroundSize,
-                );
-                return debugImage.composite(result);
+            if (mergedOptions.renderBoundingBox) {
+                const debugImage = await placeBoundingBox(box);
+                return [result, debugImage];
             }
 
-            return result;
+            return [result];
         });
 
     loadImage = async (imagePath: string | Buffer): Promise<ImageType> => {
@@ -228,7 +226,7 @@ export class Template<EntryType extends Record<string, string>> {
         box: BoundingBox,
         options?: TextLayerOptions<EntryType>,
     ): this =>
-        this.layer(async (entry, { debugMode }) => {
+        this.layer(async entry => {
             const mergedOptions = merge(
                 {},
                 DEFAULT_TEXT_LAYER_OPTIONS,
@@ -236,32 +234,28 @@ export class Template<EntryType extends Record<string, string>> {
                     font: {
                         family: this.defaultFontFamily,
                     },
+                    renderBoundingBox: this.renderBoundingBox,
                 } as FontOptions,
                 options,
             );
             if (this.shouldSkipLayerForEntry(entry, mergedOptions)) {
-                return undefined;
+                return [];
             }
 
             const text = this.textFromTextRef(entry, ref);
-            const result = await renderText(
+            const result = await this.placeText({
                 text,
                 box,
-                this.backgroundSize,
-                mergedOptions,
-                this.fonts,
-            );
+                options: mergedOptions,
+            });
 
             // debug mode
-            if (debugMode) {
-                const debugImage = await drawBoundingBox(
-                    box,
-                    this.backgroundSize,
-                );
-                return debugImage.composite(result);
+            if (mergedOptions.renderBoundingBox) {
+                const debugImage = await placeBoundingBox(box);
+                return [result, debugImage];
             }
 
-            return result;
+            return [result];
         });
 
     font(path: fs.PathLike, name: string): this {
@@ -270,31 +264,53 @@ export class Template<EntryType extends Record<string, string>> {
         return this;
     }
 
-    debug(): this {
-        this.debugMode = true;
+    debug = (): this => {
+        this.debugPoints.push(this.layers.length);
         return this;
-    }
+    };
 
-    private async renderLayers(entry: EntryType): Promise<Array<ImageType>> {
+    async render(entry: EntryType): Promise<ImageType> {
         const results = await Promise.all(
             this.layers.map(layerFn =>
                 layerFn(entry, {
-                    debugMode: this.debugMode,
+                    renderBoundingBox: this.renderBoundingBox,
                 }),
             ),
         );
-        return results.filter(result => !!result);
-    }
+        const buildDocument = (children: Array<HyperNode>) =>
+            h('html', [
+                h('head', [
+                    h(
+                        'style',
+                        Object.entries(this.fonts)
+                            .map(
+                                ([name, data]) =>
+                                    `@font-face {
+                                        font-family: '${name}';
+                                        src: url(data:font/ttf;base64,${data}) format('truetype');
+                                    }`,
+                            )
+                            .join('\n'),
+                    ),
+                ]),
+                h('body', children),
+            ]);
+
+        // TODO: move it to a proper place
+        for (const debugPoint of this.debugPoints) {
+            const debugRender = await htmlToImage(
+                buildDocument(flatten(results.slice(0, debugPoint))),
+                this.backgroundSize,
+            );
+            const debugImage: ImageType = await this.background.clone().composite(debugRender);
+            await debugImage.write('assets/debug-1.png');
+        }
 
-    async render(
-        entry: EntryType,
-        options?: RenderOptions<EntryType>,
-    ): Promise<ImageType> {
-        const renderedLayers = await this.renderLayers(entry);
-        return renderedLayers.reduce(
-            (acc, layerRender) => acc.composite(layerRender),
-            this.background.clone(),
+        const render = await htmlToImage(
+            buildDocument(flatten(results)),
+            this.backgroundSize,
         );
+        return this.background.clone().composite(render);
     }
 
     async renderAll(
@@ -305,7 +321,7 @@ export class Template<EntryType extends Record<string, string>> {
             entries.map(
                 entry =>
                     new Promise<Array<ImageType>>(resolve =>
-                        this.render(entry, options).then(image => {
+                        this.render(entry).then(image => {
                             if (!options?.duplication) {
                                 return resolve([image]);
                             }
@@ -353,14 +369,34 @@ export class Template<EntryType extends Record<string, string>> {
         });
     }
 
-    private pathFromImageRef = async (
+    private imageFromImageRef = async (
         entry: EntryType,
         ref: ImageRef<EntryType>,
-        options: RequiredDeep<ImageLayerOptions<EntryType>>,
+        assetsPath: string,
+    ): Promise<ImageType> => {
+        const pathSegments = [];
+        if (assetsPath.length) {
+            pathSegments.push(assetsPath);
+        }
+
+        if ('key' in ref) {
+            const fileName = entry[ref.key];
+            return this.loadImage(path.join(...pathSegments, fileName));
+        } else if ('pathFn' in ref) {
+            const fileName = ref.pathFn(entry);
+            return this.loadImage(path.join(...pathSegments, fileName));
+        } else {
+            return this.imageFromStaticImageRef(ref, assetsPath);
+        }
+    };
+
+    private imageFromStaticImageRef = async (
+        ref: StaticImageRef,
+        assetsPath: string,
     ): Promise<ImageType> => {
         const pathSegments = [];
-        if (options.assetsPath) {
-            pathSegments.push(options.assetsPath);
+        if (assetsPath.length) {
+            pathSegments.push(assetsPath);
         }
 
         if ('buffer' in ref) {
@@ -369,12 +405,6 @@ export class Template<EntryType extends Record<string, string>> {
             return this.loadImage(path.join(...pathSegments, ref.path));
         } else if ('absolutePath' in ref) {
             return this.loadImage(ref.absolutePath);
-        } else if ('key' in ref) {
-            const fileName = entry[ref.key];
-            return this.loadImage(path.join(...pathSegments, fileName));
-        } else if ('pathFn' in ref) {
-            const fileName = ref.pathFn(entry);
-            return this.loadImage(path.join(...pathSegments, fileName));
         } else {
             throw new Error('Unknown ImageRef variant');
         }
@@ -395,6 +425,33 @@ export class Template<EntryType extends Record<string, string>> {
         }
     };
 
+    private elementFromElementRef = async (
+        entry: EntryType,
+        ref: ElementRef<EntryType>,
+    ): Promise<HyperNode> => {
+        if ('text' in ref) {
+            const options = merge({}, DEFAULT_TEXT_LAYER_OPTIONS, ref.options);
+            return this.prepareText({
+                text: this.textFromTextRef(entry, ref.text),
+                options,
+            });
+        } else if ('image' in ref) {
+            const options = merge({}, DEFAULT_IMAGE_LAYER_OPTIONS, ref.options);
+            return this.prepareImage({
+                image: await this.imageFromImageRef(
+                    entry,
+                    ref.image,
+                    options.assetsPath,
+                ),
+                options,
+            });
+        } else if ('node' in ref) {
+            return ref.node;
+        } else {
+            throw new Error('Unknown TextRef variant');
+        }
+    };
+
     private shouldSkipLayerForEntry = (
         entry: EntryType,
         options: LayerOptions<EntryType>,
@@ -404,4 +461,169 @@ export class Template<EntryType extends Record<string, string>> {
         }
         return options.skip ?? false;
     };
+
+    private placeText = async ({
+        text,
+        box,
+        options,
+    }: {
+        text: string;
+        box: BoundingBox;
+        options: RequiredDeep<TextLayerOptions<EntryType>>;
+    }): Promise<HyperNode> => {
+        return h(
+            'div',
+            {
+                style: {
+                    display: 'flex',
+                    overflow: 'visible',
+                    position: 'absolute',
+
+                    justifyContent: options.justifyContent,
+                    alignItems: options.alignItems,
+
+                    ...boundingBoxToPx(box),
+                },
+            },
+            [
+                await this.prepareText({
+                    text,
+                    options,
+                }),
+            ],
+        );
+    };
+
+    private prepareText = async ({
+        text,
+        options,
+    }: {
+        text: string;
+        options: RequiredDeep<TextLayerSpecificOptions<EntryType>>;
+    }): Promise<HyperNode> => {
+        let textChildren: Array<string | HyperNode> = [text];
+        const replacementBuilder = new ReplacementBuilder();
+        options.replacementFn(replacementBuilder);
+        const replacementMap = replacementBuilder.build();
+        for (const [word, imageRef] of Object.entries(replacementMap)) {
+            const regex = new RegExp(word, 'gi');
+            const textOptions: RequiredDeep<ImageLayerOptions<EntryType>> =
+                merge(
+                    {},
+                    DEFAULT_IMAGE_LAYER_OPTIONS,
+                    { assetsPath: this.defaultAssetsPath },
+                    options,
+                );
+            const image = await this.imageFromStaticImageRef(
+                imageRef,
+                textOptions.assetsPath,
+            );
+            const imageBase64 = await image.getBase64('image/png');
+
+            let tmpChildren: Array<string | HyperNode> = [];
+            for (const textSegment of textChildren) {
+                if (typeof textSegment !== 'string') {
+                    continue;
+                }
+
+                const parts = (textSegment as string).split(regex);
+                for (let index = 0; index < parts.length; index++) {
+                    if (index > 0) {
+                        tmpChildren.push(
+                            h(
+                                'img',
+                                {
+                                    style: {
+                                        display: 'inline',
+                                        verticalAlign: 'middle',
+                                        height: toPx(options.font.size),
+                                        width: 'auto',
+                                    },
+                                    src: imageBase64,
+                                },
+                                [],
+                            ),
+                        );
+                    }
+                    tmpChildren.push(parts[index]);
+                }
+            }
+
+            textChildren = tmpChildren;
+        }
+
+        return h(
+            'div',
+            {
+                style: {
+                    overflow: 'visible',
+                    overflowWrap: 'word-wrap',
+                    whiteSpace: 'normal',
+
+                    color: options.color,
+                    fontFamily: options.font.family,
+                    fontSize: options.font.size,
+                    fontStyle: options.font.italic ? 'italic' : undefined,
+                    fontWeight: options.font.bold ? 'bold' : undefined,
+
+                    '-webkit-text-stroke': `${options.border.width}px ${options.border.color}`,
+                },
+            },
+            textChildren,
+        );
+    };
+
+    private placeImage = async ({
+        image,
+        box,
+        options,
+    }: {
+        image: ImageType;
+        box: BoundingBox;
+        options: RequiredDeep<ImageLayerOptions<EntryType>>;
+    }): Promise<HyperNode> => {
+        return h(
+            'div',
+            {
+                style: {
+                    display: 'flex',
+                    position: 'absolute',
+                    scale: 1,
+
+                    justifyContent: options.justifyContent,
+                    alignItems: options.alignItems,
+
+                    ...boundingBoxToPx(box),
+                },
+            },
+            [await this.prepareImage({ image, options })],
+        );
+    };
+
+    private prepareImage = async ({
+        image,
+        options,
+    }: {
+        image: ImageType;
+        options: RequiredDeep<ImageLayerSpecificOptions<EntryType>>;
+    }): Promise<HyperNode> => {
+        const imageBase64 = await image.getBase64('image/png');
+        const objectFit = SCALE_MODE_TO_OBJECT_FIT[options.scale];
+
+        return h(
+            'img',
+            {
+                style: {
+                    objectFit,
+                    flex: '1 1 auto',
+                    minWidth: 0,
+                    minHeight: 0,
+                    maxWidth: '100%',
+                    maxHeight: '100%',
+                },
+                src: imageBase64,
+            },
+            [],
+        );
+    };
 }

package/src/lib/types/containers.ts

@@ -1,8 +1,10 @@
 import { RequiredDeep } from 'type-fest';
 import { BoundingBox } from './boundingBox';
-import { ImageType } from './image';
+import { ImageLayerSpecificOptions, ImageRef, ImageType } from './image';
 import { ScaleMode } from './scale';
-import { LayerOptions } from './layer';
+import { DEFAULT_LAYER_OPTIONS, LayerOptions } from './layer';
+import { HyperNode } from './hypernode';
+import { TextLayerSpecificOptions, TextRef } from './text';
 
 export type ContainerOptions<EntryType extends Record<string, string>> =
     LayerOptions<EntryType> & {
@@ -23,11 +25,9 @@ export type ContainerOptions<EntryType extends Record<string, string>> =
 export const DEFAULT_CONTAINER_OPTIONS: RequiredDeep<
     ContainerOptions<Record<string, string>>
 > = {
+    ...DEFAULT_LAYER_OPTIONS,
     gap: 0,
-    justifyContent: 'normal',
-    alignItems: 'center',
     scale: 'none',
-    skip: false,
 };
 
 export type DirectionContainerOptions<
@@ -65,8 +65,24 @@ export const DEFAULT_GRID_CONTAINER_OPTIONS: RequiredDeep<
     direction: 'rows',
 };
 
+export type ElementRef<EntryType extends Record<string, string>> =
+    | {
+          image: ImageRef<EntryType>;
+          options?: ImageLayerSpecificOptions<EntryType>;
+      }
+    | {
+          text: TextRef<EntryType>;
+          options?: TextLayerSpecificOptions<EntryType>;
+      }
+    | {
+          node: HyperNode;
+      };
+
+export type ElementsFn = <EntryType extends Record<string, string>>(
+    entry: EntryType,
+) => Promise<Array<ElementRef<EntryType>>>;
+
 export type PackingFn = (
     box: BoundingBox,
-    background: ImageType,
-    images: Array<ImageType>,
-) => Promise<ImageType>;
+    elements: Array<HyperNode>,
+) => Promise<HyperNode>;

package/src/lib/types/hypernode.ts

@@ -0,0 +1,4 @@
+import { VNode } from "virtual-dom";
+
+export type HyperNode = VNode;
+