@xeonr/renderer-sdk 1.7.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
import { type ReactElement } from 'react';
|
|
2
|
-
import { type WorkerContext } from './worker.js';
|
|
2
|
+
import { type WorkerContext, type WorkerManifest } from './worker.js';
|
|
3
|
+
/**
|
|
4
|
+
* The canonical output contract for every renderer that uses
|
|
5
|
+
* defineRendererWorker — both thumbnails are required, image/png.
|
|
6
|
+
* Surfaced as a named export so renderers can drop a one-liner
|
|
7
|
+
* worker.manifest.yaml referring back to it (or skip the YAML entirely
|
|
8
|
+
* and let the SDK self-enforce). The vite plugin reads either form;
|
|
9
|
+
* having the constant here keeps the source of truth in one place.
|
|
10
|
+
*/
|
|
11
|
+
export declare const DEFAULT_RENDERER_WORKER_MANIFEST: WorkerManifest;
|
|
3
12
|
export interface RendererWorkerOptions {
|
|
4
13
|
/** Rendered container size in CSS pixels. Defaults to 1024×768 —
|
|
5
14
|
* matches what the old default-workers renderer pool drew at and
|
|
@@ -19,6 +28,13 @@ export type RendererWorkerRenderFn = (args: {
|
|
|
19
28
|
ctx: WorkerContext;
|
|
20
29
|
}) => ReactElement;
|
|
21
30
|
/** Register a renderer worker entry. Mounts the passed React element
|
|
22
|
-
* twice (light + dark) and ships each capture as a thumbnail.
|
|
31
|
+
* twice (light + dark) and ships each capture as a thumbnail.
|
|
32
|
+
*
|
|
33
|
+
* Both outputs are declared in DEFAULT_RENDERER_WORKER_MANIFEST and
|
|
34
|
+
* passed through to defineWorker so the SDK enforces required-output
|
|
35
|
+
* presence at handler exit — a renderer that crashes between the two
|
|
36
|
+
* captures fails the run with MissingOutputError rather than silently
|
|
37
|
+
* shipping only the light thumbnail.
|
|
38
|
+
*/
|
|
23
39
|
export declare function defineRendererWorker(render: RendererWorkerRenderFn, options?: RendererWorkerOptions): void;
|
|
24
40
|
//# sourceMappingURL=worker-renderer.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-renderer.d.ts","sourceRoot":"","sources":["../src/worker-renderer.tsx"],"names":[],"mappings":"AA0BA,OAAO,EAAc,KAAK,YAAY,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"worker-renderer.d.ts","sourceRoot":"","sources":["../src/worker-renderer.tsx"],"names":[],"mappings":"AA0BA,OAAO,EAAc,KAAK,YAAY,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,EAAgB,KAAK,aAAa,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAGpF;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC,EAAE,cAO9C,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACrC;;mEAE+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;4EACwE;IACxE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;+BAE2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE;IAC3C,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,GAAG,EAAE,aAAa,CAAC;CACnB,KAAK,YAAY,CAAC;AAEnB;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CACnC,MAAM,EAAE,sBAAsB,EAC9B,OAAO,GAAE,qBAA0B,GACjC,IAAI,CAyBN"}
|
package/dist/worker-renderer.js
CHANGED
|
@@ -27,27 +27,53 @@ import { createRoot } from 'react-dom/client';
|
|
|
27
27
|
import { StrictMode } from 'react';
|
|
28
28
|
import { defineWorker } from './worker.js';
|
|
29
29
|
import { WorkerRendererProvider } from './react/worker.js';
|
|
30
|
+
/**
|
|
31
|
+
* The canonical output contract for every renderer that uses
|
|
32
|
+
* defineRendererWorker — both thumbnails are required, image/png.
|
|
33
|
+
* Surfaced as a named export so renderers can drop a one-liner
|
|
34
|
+
* worker.manifest.yaml referring back to it (or skip the YAML entirely
|
|
35
|
+
* and let the SDK self-enforce). The vite plugin reads either form;
|
|
36
|
+
* having the constant here keeps the source of truth in one place.
|
|
37
|
+
*/
|
|
38
|
+
export const DEFAULT_RENDERER_WORKER_MANIFEST = {
|
|
39
|
+
outputs: [
|
|
40
|
+
{ slot: 'common:thumbnail_light', kind: 'blob', required: true, mimeHint: 'image/png',
|
|
41
|
+
description: 'Light-theme captured thumbnail.' },
|
|
42
|
+
{ slot: 'common:thumbnail_dark', kind: 'blob', required: true, mimeHint: 'image/png',
|
|
43
|
+
description: 'Dark-theme captured thumbnail.' },
|
|
44
|
+
],
|
|
45
|
+
};
|
|
30
46
|
/** Register a renderer worker entry. Mounts the passed React element
|
|
31
|
-
* twice (light + dark) and ships each capture as a thumbnail.
|
|
47
|
+
* twice (light + dark) and ships each capture as a thumbnail.
|
|
48
|
+
*
|
|
49
|
+
* Both outputs are declared in DEFAULT_RENDERER_WORKER_MANIFEST and
|
|
50
|
+
* passed through to defineWorker so the SDK enforces required-output
|
|
51
|
+
* presence at handler exit — a renderer that crashes between the two
|
|
52
|
+
* captures fails the run with MissingOutputError rather than silently
|
|
53
|
+
* shipping only the light thumbnail.
|
|
54
|
+
*/
|
|
32
55
|
export function defineRendererWorker(render, options = {}) {
|
|
33
|
-
defineWorker(
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
const
|
|
44
|
-
render
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
56
|
+
defineWorker({
|
|
57
|
+
manifest: DEFAULT_RENDERER_WORKER_MANIFEST,
|
|
58
|
+
handler: async (ctx) => {
|
|
59
|
+
const width = options.width ?? 1024;
|
|
60
|
+
const height = options.height ?? 768;
|
|
61
|
+
const pixelRatio = options.pixelRatio ?? 2;
|
|
62
|
+
const settleMs = options.settleMs ?? 500;
|
|
63
|
+
// html-to-image is a 30KB+ dep — lazy-load so portal/dashboard
|
|
64
|
+
// bundles don't pull it.
|
|
65
|
+
const { toPng } = await import('html-to-image');
|
|
66
|
+
for (const theme of ['light', 'dark']) {
|
|
67
|
+
ctx.log.info('render.theme.start', { theme });
|
|
68
|
+
const png = await renderAndCapture({
|
|
69
|
+
render: () => render({ theme, ctx }),
|
|
70
|
+
ctx, theme, width, height, pixelRatio, settleMs, toPng,
|
|
71
|
+
});
|
|
72
|
+
const outputName = theme === 'light' ? 'common:thumbnail_light' : 'common:thumbnail_dark';
|
|
73
|
+
await ctx.outputBlob(outputName, png, 'image/png');
|
|
74
|
+
ctx.log.info('render.theme.done', { theme, bytes: png.byteLength });
|
|
75
|
+
}
|
|
76
|
+
},
|
|
51
77
|
});
|
|
52
78
|
}
|
|
53
79
|
async function renderAndCapture(args) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-renderer.js","sourceRoot":"","sources":["../src/worker-renderer.tsx"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,qEAAqE;AACrE,qDAAqD;AACrD,EAAE;AACF,oDAAoD;AACpD,EAAE;AACF,gFAAgF;AAChF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,EAAE;AACF,6DAA6D;AAC7D,4BAA4B;AAC5B,sEAAsE;AACtE,kEAAkE;AAClE,mBAAmB;AACnB,qEAAqE;AACrE,oEAAoE;AACpE,EAAE;AACF,oEAAoE;AACpE,oEAAoE;AACpE,wEAAwE;AACxE,kEAAkE;AAClE,+DAA+D;AAE/D,OAAO,EAAE,UAAU,EAAa,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAqB,MAAM,OAAO,CAAC;AACtD,OAAO,EAAE,YAAY,
|
|
1
|
+
{"version":3,"file":"worker-renderer.js","sourceRoot":"","sources":["../src/worker-renderer.tsx"],"names":[],"mappings":";AAAA,qEAAqE;AACrE,qEAAqE;AACrE,qDAAqD;AACrD,EAAE;AACF,oDAAoD;AACpD,EAAE;AACF,gFAAgF;AAChF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,EAAE;AACF,6DAA6D;AAC7D,4BAA4B;AAC5B,sEAAsE;AACtE,kEAAkE;AAClE,mBAAmB;AACnB,qEAAqE;AACrE,oEAAoE;AACpE,EAAE;AACF,oEAAoE;AACpE,oEAAoE;AACpE,wEAAwE;AACxE,kEAAkE;AAClE,+DAA+D;AAE/D,OAAO,EAAE,UAAU,EAAa,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAqB,MAAM,OAAO,CAAC;AACtD,OAAO,EAAE,YAAY,EAA2C,MAAM,aAAa,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAmB;IAC/D,OAAO,EAAE;QACR,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW;YACpF,WAAW,EAAE,iCAAiC,EAAE;QACjD,EAAE,IAAI,EAAE,uBAAuB,EAAG,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW;YACpF,WAAW,EAAE,gCAAgC,EAAE;KAChD;CACD,CAAC;AAsBF;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CACnC,MAA8B,EAC9B,UAAiC,EAAE;IAEnC,YAAY,CAAC;QACZ,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACvB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC;YACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC;YACrC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,CAAC;YAEzC,+DAA+D;YAC/D,yBAAyB;YACzB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;YAEhD,KAAK,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,MAAM,CAAU,EAAE,CAAC;gBAChD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC9C,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC;oBAClC,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;oBACpC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK;iBACtD,CAAC,CAAC;gBACH,MAAM,UAAU,GAAG,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,uBAAuB,CAAC;gBAC1F,MAAM,GAAG,CAAC,UAAU,CAAC,UAAU,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;gBACnD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;YACrE,CAAC;QACD,CAAC;KACD,CAAC,CAAC;AACJ,CAAC;AAaD,KAAK,UAAU,gBAAgB,CAAC,IAAiB;IAChD,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAChD,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC;IAC1C,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC;IAC5C,SAAS,CAAC,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC;IACnC,SAAS,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;IAC1B,SAAS,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;IAC3B,SAAS,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACpC,gEAAgE;IAChE,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;IAC9B,qEAAqE;IACrE,SAAS,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACrC,SAAS,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAErC,IAAI,IAAI,GAAgB,IAAI,CAAC;IAC7B,IAAI,CAAC;QACJ,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;QAC7B,qEAAqE;QACrE,mEAAmE;QACnE,kEAAkE;QAClE,kEAAkE;QAClE,+DAA+D;QAC/D,mDAAmD;QACnD,IAAI,CAAC,MAAM,CACV,KAAC,UAAU,cACV,KAAC,sBAAsB,IAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,YACtD,IAAI,CAAC,MAAM,EAAE,GACU,GACb,CACb,CAAC;QAEF,qEAAqE;QACrE,iEAAiE;QACjE,MAAM,UAAU,EAAE,CAAC;QACnB,MAAM,UAAU,EAAE,CAAC;QACnB,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvD,kEAAkE;QAClE,mEAAmE;QACnE,MAAM,aAAa,CAAC,SAAS,CAAC,CAAC;QAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YAC3C,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,eAAe,EAAE,OAAO;SACxB,CAAC,CAAC;QACH,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;YAAS,CAAC;QACV,IAAI,CAAC;YAAC,IAAI,EAAE,OAAO,EAAE,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC,CAAC,yBAAyB,CAAC,CAAC;QAC5D,SAAS,CAAC,MAAM,EAAE,CAAC;IACpB,CAAC;AACF,CAAC;AAED,SAAS,UAAU;IAClB,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,IAAiB;IAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,MAAM,OAAO,CAAC,GAAG,CAChB,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAChB,IAAI,GAAG,CAAC,QAAQ;YAAE,OAAO;QACzB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACpC,GAAG,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9D,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CACF,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,OAAe;IACtC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,KAAK,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC3F,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACxC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,GAAG,CAAC;AACZ,CAAC"}
|