@meonode/canvas 1.5.6 → 1.6.0-beta.2

package/dist/esm/canvas/worker.types.d.ts

@@ -0,0 +1,76 @@
+import type { ExportFormat, ExportOptions, SaveOptions, RenderOptions } from 'skia-canvas';
+import type { RootProps } from '../canvas/canvas.type.js';
+export interface CanvasCallMap {
+    toBuffer: {
+        args: [ExportFormat, ExportOptions?];
+        result: Buffer;
+    };
+    toURL: {
+        args: [ExportFormat, ExportOptions?];
+        result: string;
+    };
+    toFile: {
+        args: [string, SaveOptions?];
+        result: void;
+    };
+    toSharp: {
+        args: [RenderOptions?];
+        result: Buffer;
+    };
+}
+export type CanvasCallMethod = keyof CanvasCallMap;
+export type CallArgs<M extends CanvasCallMethod> = CanvasCallMap[M]['args'];
+export type CallResult<M extends CanvasCallMethod> = CanvasCallMap[M]['result'];
+export interface WorkerRenderRequest {
+    type: 'render';
+    taskId: number;
+    props: RootProps;
+}
+/** Discriminated union — narrows args alongside method in switch statements */
+export type WorkerCallRequest = {
+    type: 'call';
+    taskId: number;
+    canvasId: number;
+    method: 'toBuffer';
+    args: CallArgs<'toBuffer'>;
+} | {
+    type: 'call';
+    taskId: number;
+    canvasId: number;
+    method: 'toURL';
+    args: CallArgs<'toURL'>;
+} | {
+    type: 'call';
+    taskId: number;
+    canvasId: number;
+    method: 'toFile';
+    args: CallArgs<'toFile'>;
+} | {
+    type: 'call';
+    taskId: number;
+    canvasId: number;
+    method: 'toSharp';
+    args: CallArgs<'toSharp'>;
+};
+export interface WorkerReleaseRequest {
+    type: 'release';
+    canvasId: number;
+}
+export type WorkerRequest = WorkerRenderRequest | WorkerCallRequest | WorkerReleaseRequest;
+export interface WorkerRenderResponse {
+    taskId: number;
+    canvasId: number;
+    buffer: Buffer;
+    width: number;
+    height: number;
+}
+export interface WorkerCallResponse {
+    taskId: number;
+    result: Buffer | string | void;
+}
+export interface WorkerErrorResponse {
+    taskId: number;
+    error: string;
+}
+export type WorkerResponse = WorkerRenderResponse | WorkerCallResponse | WorkerErrorResponse;
+//# sourceMappingURL=worker.types.d.ts.map

package/dist/esm/canvas/worker.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.types.d.ts","sourceRoot":"","sources":["../../../src/canvas/worker.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC1F,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAMxD,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE;QAAE,IAAI,EAAE,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAClE,KAAK,EAAE;QAAE,IAAI,EAAE,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/D,MAAM,EAAE;QAAE,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAA;IACtD,OAAO,EAAE;QAAE,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CACpD;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAA;AAClD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,gBAAgB,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAC3E,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,gBAAgB,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;AAM/E,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,SAAS,CAAA;CACjB;AAED,+EAA+E;AAC/E,MAAM,MAAM,iBAAiB,GACzB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;CAAE,GAClG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;CAAE,GAC5F;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;CAAE,GAC9F;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;CAAE,CAAA;AAEpG,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,oBAAoB,CAAA;AAM1F,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,kBAAkB,GAAG,mBAAmB,CAAA"}

package/dist/esm/index.d.ts

@@ -3,7 +3,8 @@ export * from './canvas/canvas.type.js';
 export { Box, Column, Row, type BoxNode } from './canvas/layout.canvas.util.js';
 export { Image } from './canvas/image.canvas.util.js';
 export { Text } from './canvas/text.canvas.util.js';
-export { Root } from './canvas/root.canvas.util.js';
+export { Root, configure } from './canvas/root.canvas.util.js';
+export { GridItem } from './canvas/grid.canvas.util.js';
 export { Grid } from './canvas/grid.canvas.util.js';
 export { Chart } from './canvas/chart.canvas.util.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,yBAAyB,CAAA;AACvC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO,EAAE,MAAM,gCAAgC,CAAA;AAC/E,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,yBAAyB,CAAA;AACvC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO,EAAE,MAAM,gCAAgC,CAAA;AAC/E,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AACnD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA"}

package/dist/esm/index.js

@@ -2,7 +2,7 @@ export { Border, Style } from './constant/common.const.js';
 export { Box, Column, Row } from './canvas/layout.canvas.util.js';
 export { Image } from './canvas/image.canvas.util.js';
 export { Text } from './canvas/text.canvas.util.js';
-export { Root } from './canvas/root.canvas.util.js';
-export { Grid } from './canvas/grid.canvas.util.js';
+export { Root, configure } from './canvas/root.canvas.util.js';
+export { Grid, GridItem } from './canvas/grid.canvas.util.js';
 export { Chart } from './canvas/chart.canvas.util.js';
 export * from 'yoga-layout';

package/dist/esm/render.worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=render.worker.d.ts.map

package/dist/esm/render.worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.worker.d.ts","sourceRoot":"","sources":["../../src/render.worker.ts"],"names":[],"mappings":""}

package/dist/esm/render.worker.js

@@ -0,0 +1,70 @@
+import { parentPort } from 'worker_threads';
+import { RootNode } from './canvas/root.canvas.util.js';
+
+/**
+ * Worker thread entry point for off-main-thread canvas rendering.
+ *
+ * Message protocol (main → worker):
+ *   { type: 'render', taskId, props }                      — render and keep Canvas alive
+ *   { type: 'call',   taskId, canvasId, method, args }     — call a method on a live Canvas
+ *   { type: 'release', canvasId }                          — free Canvas from memory
+ *
+ * Responses (worker → main):
+ *   WorkerRenderResponse  — render complete (includes pre-encoded PNG buffer)
+ *   WorkerCallResponse    — method call result
+ *   WorkerErrorResponse   — any failure
+ */
+if (!parentPort) {
+    throw new Error('[render.worker] Must be run as a worker thread');
+}
+const canvases = new Map();
+let nextCanvasId = 0;
+function reply(msg) {
+    parentPort.postMessage(msg);
+}
+parentPort.on('message', async (msg) => {
+    if (msg.type === 'render') {
+        try {
+            const canvas = await new RootNode(msg.props).render();
+            const canvasId = nextCanvasId++;
+            canvases.set(canvasId, canvas);
+            reply({ taskId: msg.taskId, canvasId, buffer: canvas.toBufferSync('png'), width: canvas.width, height: canvas.height });
+        }
+        catch (err) {
+            reply({ taskId: msg.taskId, error: String(err) });
+        }
+    }
+    else if (msg.type === 'call') {
+        const canvas = canvases.get(msg.canvasId);
+        if (!canvas) {
+            reply({ taskId: msg.taskId, error: `[render.worker] Canvas ${msg.canvasId} not found` });
+            return;
+        }
+        try {
+            let result;
+            switch (msg.method) {
+                case 'toBuffer':
+                    result = await canvas.toBuffer(...msg.args);
+                    break;
+                case 'toURL':
+                    result = await canvas.toURL(...msg.args);
+                    break;
+                case 'toFile':
+                    result = await canvas.toFile(...msg.args);
+                    break;
+                case 'toSharp':
+                    // Sharp instances can't be transferred across threads — serialize to buffer
+                    result = await canvas.toSharp(...msg.args).toBuffer();
+                    break;
+            }
+            reply({ taskId: msg.taskId, result });
+        }
+        catch (err) {
+            reply({ taskId: msg.taskId, error: String(err) });
+        }
+    }
+    else {
+        // type === 'release'
+        canvases.delete(msg.canvasId);
+    }
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meonode/canvas",
-  "version": "1.5.6",
+  "version": "1.6.0-beta.2",
   "description": "A declarative, component-based library for server-side canvas image generation. Write complex visuals with simple functions, similar to the composition style of @meonode/ui.",
   "keywords": [
     "canvas",