@kitsra/kavio-render-worker 0.1.0

package/LICENSE

@@ -0,0 +1,94 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other
+notices of the licensor in the software. Any use of the licensor's trademarks
+is subject to applicable law.
+
+Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software.
+
+If you or your company make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license for the software
+granted under these terms ends immediately. If your company makes such a claim,
+your patent license ends immediately for work on behalf of your company.
+
+Notices
+
+You must ensure that anyone who gets a copy of any part of the software from
+you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+No Liability
+
+As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.
+
+Definitions
+
+The licensor is the entity offering these terms, and the software is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+you refers to the individual or entity agreeing to these terms.
+
+your company is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that organization.
+control means ownership of substantially all the assets of an entity, or the
+power to direct its management and policies by vote, contract, or otherwise.
+Control can be direct or indirect.
+
+your licenses are all the licenses granted to you for the software under these
+terms.
+
+use means anything you do with the software requiring one of your licenses.
+
+trademark means trademarks, service marks, and similar rights.

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+import type { KavioAudioCodec, KavioDocument, KavioExportCodec, KavioExportFormat, KavioExportPreset, KavioJsonValue } from "@kitsra/kavio-schema";
+export type BrowserDriverKind = "playwright" | "puppeteer" | "cloud-browser";
+export type BrowserEngine = "chromium";
+export type BrowserScreenshotFormat = "png";
+export type BrowserScreenshotMimeType = "image/png";
+export type ChromiumColorProfile = "srgb";
+export declare const DEFAULT_BROWSER_DRIVER_KIND = "playwright";
+export declare const DEFAULT_BROWSER_ENGINE = "chromium";
+export declare const DEFAULT_BROWSER_SCREENSHOT_FORMAT = "png";
+export declare const DEFAULT_BROWSER_SCREENSHOT_MIME_TYPE = "image/png";
+export declare const DEFAULT_BROWSER_DEVICE_SCALE_FACTOR = 1;
+export declare const DEFAULT_CHROMIUM_COLOR_PROFILE = "srgb";
+export declare const DETERMINISTIC_CHROMIUM_FLAGS: readonly ["--disable-gpu", "--disable-gpu-compositing", "--disable-font-subpixel-positioning", "--force-color-profile=srgb", "--font-render-hinting=none"];
+export interface BrowserViewport {
+    width: number;
+    height: number;
+    deviceScaleFactor: number;
+}
+export interface BrowserOpenOptions {
+    viewport?: BrowserViewport;
+}
+export interface BrowserFrameCaptureOptions {
+    omitBackground?: boolean;
+}
+export interface BrowserFrameCapture {
+    frame: number;
+    bytes: Uint8Array;
+    format: BrowserScreenshotFormat;
+    mimeType: BrowserScreenshotMimeType;
+    width: number;
+    height: number;
+    omitBackground: boolean;
+}
+export interface DeterministicChromiumLaunchOptions {
+    headless: true;
+    args: readonly string[];
+}
+export declare const DEFAULT_CHROMIUM_LAUNCH_OPTIONS: {
+    readonly headless: true;
+    readonly args: readonly ["--disable-gpu", "--disable-gpu-compositing", "--disable-font-subpixel-positioning", "--force-color-profile=srgb", "--font-render-hinting=none"];
+};
+export declare const DEFAULT_BROWSER_FRAME_CAPTURE_OPTIONS: {
+    readonly omitBackground: true;
+};
+export interface BrowserLaunchMetadata {
+    engine: BrowserEngine;
+    chromiumRevision: string;
+    headless: true;
+    args: readonly string[];
+    colorProfile: ChromiumColorProfile;
+    deviceScaleFactor: number;
+}
+export interface BrowserDriverMetadata {
+    kind: BrowserDriverKind;
+    name: string;
+    version?: string;
+    launch: BrowserLaunchMetadata;
+}
+export interface BrowserDriverMetadataOptions {
+    kind?: BrowserDriverKind;
+    name?: string;
+    version?: string;
+    chromiumRevision: string;
+    launchOptions?: DeterministicChromiumLaunchOptions;
+    deviceScaleFactor?: number;
+    colorProfile?: ChromiumColorProfile;
+}
+export interface BrowserDriver {
+    open(composition: KavioDocument, options?: BrowserOpenOptions): Promise<void>;
+    renderFrame(frame: number, options?: BrowserFrameCaptureOptions): Promise<BrowserFrameCapture>;
+    close(): Promise<void>;
+}
+export declare function createBrowserViewport(composition: KavioDocument, deviceScaleFactor?: number): BrowserViewport;
+export declare function createBrowserDriverMetadata(options: BrowserDriverMetadataOptions): BrowserDriverMetadata;
+export declare function createPngFrameCapture(options: {
+    frame: number;
+    bytes: Uint8Array;
+    viewport: BrowserViewport;
+    omitBackground?: boolean;
+}): BrowserFrameCapture;
+export type RenderChecksumAlgorithm = "sha256" | "sha512";
+export type RenderCleanupReason = "success" | "failure" | "manual";
+export type RenderCleanupScope = "browser-context" | "temporary-frames" | "temporary-file" | "custom";
+export type RenderPropValues = Record<string, KavioJsonValue>;
+export type RenderBatchPresetInput = string | KavioExportPreset;
+export interface RenderChecksum {
+    algorithm: RenderChecksumAlgorithm;
+    value: string;
+    bytes?: number;
+}
+export interface RenderOutputReference {
+    name: string;
+    path?: string;
+    format: KavioExportFormat;
+}
+export interface RenderOutputDimensions {
+    width: number;
+    height: number;
+}
+export interface RenderOutputDuration {
+    frames: number;
+    fps: number;
+    seconds: number;
+}
+export interface RenderOutputCodecs {
+    video: KavioExportCodec | null;
+    audio: KavioAudioCodec | null;
+}
+export interface RenderToolMetadata {
+    ffmpeg: {
+        version: string;
+    };
+    chromium: {
+        revision: string;
+    };
+}
+export interface RenderOutputMetadata {
+    version: "0.1";
+    output: RenderOutputReference;
+    dimensions: RenderOutputDimensions;
+    duration: RenderOutputDuration;
+    codecs: RenderOutputCodecs;
+    checksums: RenderChecksum[];
+    tools: RenderToolMetadata;
+    createdAt: string;
+}
+export interface CreateRenderMetadataOptions {
+    composition: KavioDocument["composition"];
+    preset: KavioExportPreset;
+    outputName?: string;
+    outputPath?: string;
+    checksums?: RenderChecksum | readonly RenderChecksum[];
+    ffmpegVersion: string;
+    chromiumRevision: string;
+    createdAt?: string;
+}
+export interface RenderCleanupContext {
+    reason: RenderCleanupReason;
+    error?: unknown;
+}
+export interface RenderCleanupTask {
+    id: string;
+    scope: RenderCleanupScope;
+    cleanup(context: RenderCleanupContext): void | Promise<void>;
+}
+export interface RenderCleanupRecord {
+    id: string;
+    scope: RenderCleanupScope;
+}
+export interface RenderCleanupFailure extends RenderCleanupRecord {
+    error: unknown;
+}
+export interface RenderCleanupReport {
+    reason: RenderCleanupReason;
+    cleaned: RenderCleanupRecord[];
+    failures: RenderCleanupFailure[];
+}
+export interface RenderBatchRow {
+    id?: string;
+    props?: RenderPropValues;
+}
+export type FrameCaptureProgressPhase = "open" | "capture" | "frame-error" | "complete";
+export interface FrameCaptureProgress {
+    phase: FrameCaptureProgressPhase;
+    frame?: number;
+    totalFrames: number;
+    completedFrames: number;
+    capturedFrames: number;
+    failedFrames: number;
+    bytesCaptured: number;
+    error?: unknown;
+}
+export interface FrameCaptureFrameError {
+    frame: number;
+    error: unknown;
+}
+export interface CaptureFramesOptions {
+    driver: BrowserDriver;
+    composition: KavioDocument;
+    openOptions?: BrowserOpenOptions;
+    captureOptions?: BrowserFrameCaptureOptions;
+    startFrame?: number;
+    frameCount?: number;
+    continueOnFrameError?: boolean;
+    onProgress?: (progress: FrameCaptureProgress) => void | Promise<void>;
+    onFrame?: (capture: BrowserFrameCapture, progress: FrameCaptureProgress) => void | Promise<void>;
+    onFrameError?: (failure: FrameCaptureFrameError, progress: FrameCaptureProgress) => void | Promise<void>;
+}
+export interface CaptureFramesResult {
+    captures: BrowserFrameCapture[];
+    errors: FrameCaptureFrameError[];
+    totalFrames: number;
+    completedFrames: number;
+    capturedFrames: number;
+    failedFrames: number;
+    bytesCaptured: number;
+}
+export interface RenderBatchInput {
+    template: KavioDocument;
+    rows: readonly RenderBatchRow[];
+    presets?: readonly RenderBatchPresetInput[];
+    outputDirectory?: string;
+    outputNamePrefix?: string;
+}
+export interface RenderBatchJob {
+    id: string;
+    rowIndex: number;
+    rowId: string;
+    presetIndex: number;
+    presetName: string;
+    props: RenderPropValues;
+    preset: KavioExportPreset;
+    document: KavioDocument;
+    outputName: string;
+    outputPath?: string;
+}
+export declare class RenderCleanupStack {
+    private tasks;
+    private closed;
+    defer(task: RenderCleanupTask): RenderCleanupTask;
+    release(id: string): boolean;
+    cleanup(reason: RenderCleanupReason, error?: unknown): Promise<RenderCleanupReport>;
+}
+export declare function createRenderMetadata(options: CreateRenderMetadataOptions): RenderOutputMetadata;
+export declare function createBrowserContextCleanupTask(driver: Pick<BrowserDriver, "close">, id?: string): RenderCleanupTask;
+export declare function createTemporaryFramesCleanupTask(cleanup: (context: RenderCleanupContext) => void | Promise<void>, id?: string): RenderCleanupTask;
+export declare function withRenderCleanup<T>(operation: (cleanup: RenderCleanupStack) => T | Promise<T>): Promise<T>;
+export declare function captureFrames(options: CaptureFramesOptions): Promise<CaptureFramesResult>;
+export declare function expandRenderBatch(input: RenderBatchInput): RenderBatchJob[];
+export declare function createStableOutputName(options: {
+    prefix?: string;
+    row: RenderBatchRow;
+    rowIndex: number;
+    preset: KavioExportPreset;
+    presetIndex: number;
+}): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACf,MAAM,sBAAsB,CAAC;AAG9B,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,eAAe,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC;AACvC,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAC5C,MAAM,MAAM,yBAAyB,GAAG,WAAW,CAAC;AACpD,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,eAAO,MAAM,2BAA2B,eAA2C,CAAC;AACpF,eAAO,MAAM,sBAAsB,aAAqC,CAAC;AACzE,eAAO,MAAM,iCAAiC,QAA0C,CAAC;AACzF,eAAO,MAAM,oCAAoC,cAAkD,CAAC;AACpG,eAAO,MAAM,mCAAmC,IAAI,CAAC;AACrD,eAAO,MAAM,8BAA8B,SAAwC,CAAC;AAEpF,eAAO,MAAM,4BAA4B,4JAM/B,CAAC;AAEX,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,uBAAuB,CAAC;IAChC,QAAQ,EAAE,yBAAyB,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD,QAAQ,EAAE,IAAI,CAAC;IACf,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB;AAED,eAAO,MAAM,+BAA+B;;;CAGW,CAAC;AAExD,eAAO,MAAM,qCAAqC;;CAEH,CAAC;AAEhD,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,aAAa,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,IAAI,CAAC;IACf,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACxB,YAAY,EAAE,oBAAoB,CAAC;IACnC,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,kCAAkC,CAAC;IACnD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC/F,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,aAAa,EAAE,iBAAiB,SAAsC,GAAG,eAAe,CAU1I;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,4BAA4B,GAAG,qBAAqB,CA6BxG;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,eAAe,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,GAAG,mBAAmB,CActB;AAED,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAC1D,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;AACnE,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,QAAQ,CAAC;AACtG,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAC9D,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAEhE,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,uBAAuB,CAAC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC/B,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,EAAE,qBAAqB,CAAC;IAC9B,UAAU,EAAE,sBAAsB,CAAC;IACnC,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IAC1C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,cAAc,GAAG,SAAS,cAAc,EAAE,CAAC;IACvD,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,kBAAkB,CAAC;IAC1B,OAAO,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG,SAAS,GAAG,aAAa,GAAG,UAAU,CAAC;AAExF,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,yBAAyB,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,aAAa,CAAC;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,cAAc,CAAC,EAAE,0BAA0B,CAAC;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjG,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1G;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,MAAM,EAAE,sBAAsB,EAAE,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,aAAa,CAAC;IACxB,IAAI,EAAE,SAAS,cAAc,EAAE,CAAC;IAChC,OAAO,CAAC,EAAE,SAAS,sBAAsB,EAAE,CAAC;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,gBAAgB,CAAC;IACxB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,KAAK,CAA2B;IACxC,OAAO,CAAC,MAAM,CAAS;IAEvB,KAAK,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB;IASjD,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IActB,OAAO,CAAC,MAAM,EAAE,mBAAmB,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAuB1F;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,oBAAoB,CA4C/F;AAED,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EACpC,EAAE,SAAoB,GACrB,iBAAiB,CAMnB;AAED,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAChE,EAAE,SAAqB,GACtB,iBAAiB,CAMnB;AAED,wBAAsB,iBAAiB,CAAC,CAAC,EACvC,SAAS,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,CAAC,CAAC,CAuBZ;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAgF/F;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,cAAc,EAAE,CAkD3E;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,cAAc,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB,GAAG,MAAM,CAQT"}

package/dist/index.js

@@ -0,0 +1,462 @@
+import { extensionForFormat } from "@kitsra/kavio-schema";
+export const DEFAULT_BROWSER_DRIVER_KIND = "playwright";
+export const DEFAULT_BROWSER_ENGINE = "chromium";
+export const DEFAULT_BROWSER_SCREENSHOT_FORMAT = "png";
+export const DEFAULT_BROWSER_SCREENSHOT_MIME_TYPE = "image/png";
+export const DEFAULT_BROWSER_DEVICE_SCALE_FACTOR = 1;
+export const DEFAULT_CHROMIUM_COLOR_PROFILE = "srgb";
+export const DETERMINISTIC_CHROMIUM_FLAGS = [
+    "--disable-gpu",
+    "--disable-gpu-compositing",
+    "--disable-font-subpixel-positioning",
+    "--force-color-profile=srgb",
+    "--font-render-hinting=none"
+];
+export const DEFAULT_CHROMIUM_LAUNCH_OPTIONS = {
+    headless: true,
+    args: DETERMINISTIC_CHROMIUM_FLAGS
+};
+export const DEFAULT_BROWSER_FRAME_CAPTURE_OPTIONS = {
+    omitBackground: true
+};
+export function createBrowserViewport(composition, deviceScaleFactor = DEFAULT_BROWSER_DEVICE_SCALE_FACTOR) {
+    assertPositiveInteger(composition.composition.width, "composition.composition.width");
+    assertPositiveInteger(composition.composition.height, "composition.composition.height");
+    assertPositiveNumber(deviceScaleFactor, "deviceScaleFactor");
+    return {
+        width: composition.composition.width,
+        height: composition.composition.height,
+        deviceScaleFactor
+    };
+}
+export function createBrowserDriverMetadata(options) {
+    const launchOptions = options.launchOptions ?? DEFAULT_CHROMIUM_LAUNCH_OPTIONS;
+    const deviceScaleFactor = options.deviceScaleFactor ?? DEFAULT_BROWSER_DEVICE_SCALE_FACTOR;
+    const colorProfile = options.colorProfile ?? DEFAULT_CHROMIUM_COLOR_PROFILE;
+    assertNonEmptyString(options.chromiumRevision, "chromiumRevision");
+    assertPositiveNumber(deviceScaleFactor, "deviceScaleFactor");
+    const launch = {
+        engine: DEFAULT_BROWSER_ENGINE,
+        chromiumRevision: options.chromiumRevision,
+        headless: launchOptions.headless,
+        args: [...launchOptions.args],
+        colorProfile,
+        deviceScaleFactor
+    };
+    const metadataBase = {
+        kind: options.kind ?? DEFAULT_BROWSER_DRIVER_KIND,
+        name: options.name ?? DEFAULT_BROWSER_DRIVER_KIND,
+        launch
+    };
+    if (options.version === undefined) {
+        return metadataBase;
+    }
+    return {
+        ...metadataBase,
+        version: options.version
+    };
+}
+export function createPngFrameCapture(options) {
+    assertNonNegativeInteger(options.frame, "frame");
+    assertPositiveInteger(options.viewport.width, "viewport.width");
+    assertPositiveInteger(options.viewport.height, "viewport.height");
+    return {
+        frame: options.frame,
+        bytes: options.bytes,
+        format: DEFAULT_BROWSER_SCREENSHOT_FORMAT,
+        mimeType: DEFAULT_BROWSER_SCREENSHOT_MIME_TYPE,
+        width: options.viewport.width,
+        height: options.viewport.height,
+        omitBackground: options.omitBackground ?? true
+    };
+}
+export class RenderCleanupStack {
+    tasks = [];
+    closed = false;
+    defer(task) {
+        if (this.closed) {
+            throw new Error("Cannot register render cleanup after cleanup has started.");
+        }
+        assertNonEmptyString(task.id, "task.id");
+        this.tasks.push(task);
+        return task;
+    }
+    release(id) {
+        if (this.closed) {
+            throw new Error("Cannot release render cleanup after cleanup has started.");
+        }
+        const index = this.tasks.findIndex((task) => task.id === id);
+        if (index === -1) {
+            return false;
+        }
+        this.tasks.splice(index, 1);
+        return true;
+    }
+    async cleanup(reason, error) {
+        this.closed = true;
+        const cleaned = [];
+        const failures = [];
+        const context = createCleanupContext(reason, error);
+        for (let index = this.tasks.length - 1; index >= 0; index -= 1) {
+            const task = this.tasks[index];
+            if (!task) {
+                continue;
+            }
+            try {
+                await task.cleanup(context);
+                cleaned.push({ id: task.id, scope: task.scope });
+            }
+            catch (cleanupError) {
+                failures.push({ id: task.id, scope: task.scope, error: cleanupError });
+            }
+        }
+        this.tasks = [];
+        return { reason, cleaned, failures };
+    }
+}
+export function createRenderMetadata(options) {
+    assertPositiveInteger(options.composition.durationFrames, "composition.durationFrames");
+    assertPositiveInteger(options.preset.width, "preset.width");
+    assertPositiveInteger(options.preset.height, "preset.height");
+    assertPositiveNumber(options.preset.fps ?? options.composition.fps, "fps");
+    assertNonEmptyString(options.ffmpegVersion, "ffmpegVersion");
+    assertNonEmptyString(options.chromiumRevision, "chromiumRevision");
+    const fps = options.preset.fps ?? options.composition.fps;
+    const output = {
+        name: options.outputName ?? defaultOutputName(options.preset),
+        format: options.preset.format
+    };
+    if (options.outputPath !== undefined) {
+        output.path = options.outputPath;
+    }
+    return {
+        version: "0.1",
+        output,
+        dimensions: {
+            width: options.preset.width,
+            height: options.preset.height
+        },
+        duration: {
+            frames: options.composition.durationFrames,
+            fps,
+            seconds: options.composition.durationFrames / fps
+        },
+        codecs: {
+            video: options.preset.codec ?? defaultVideoCodec(options.preset.format),
+            audio: options.preset.audioCodec ?? null
+        },
+        checksums: normalizeChecksums(options.checksums),
+        tools: {
+            ffmpeg: {
+                version: options.ffmpegVersion
+            },
+            chromium: {
+                revision: options.chromiumRevision
+            }
+        },
+        createdAt: options.createdAt ?? new Date().toISOString()
+    };
+}
+export function createBrowserContextCleanupTask(driver, id = "browser-context") {
+    return {
+        id,
+        scope: "browser-context",
+        cleanup: () => driver.close()
+    };
+}
+export function createTemporaryFramesCleanupTask(cleanup, id = "temporary-frames") {
+    return {
+        id,
+        scope: "temporary-frames",
+        cleanup
+    };
+}
+export async function withRenderCleanup(operation) {
+    const cleanup = new RenderCleanupStack();
+    let result;
+    let operationError;
+    let completed = false;
+    try {
+        result = await operation(cleanup);
+        completed = true;
+    }
+    catch (error) {
+        operationError = error;
+    }
+    const report = await cleanup.cleanup(completed ? "success" : "failure", operationError);
+    if (report.failures.length > 0) {
+        throw createCleanupFailureError(report, operationError);
+    }
+    if (operationError !== undefined) {
+        throw operationError;
+    }
+    return result;
+}
+export async function captureFrames(options) {
+    const range = resolveFrameCaptureRange(options.composition, options.startFrame, options.frameCount);
+    const captureOptions = {
+        ...DEFAULT_BROWSER_FRAME_CAPTURE_OPTIONS,
+        ...options.captureOptions
+    };
+    const captures = [];
+    const errors = [];
+    let completedFrames = 0;
+    let capturedFrames = 0;
+    let failedFrames = 0;
+    let bytesCaptured = 0;
+    const createProgress = (phase, frame, error) => {
+        const progress = {
+            phase,
+            totalFrames: range.totalFrames,
+            completedFrames,
+            capturedFrames,
+            failedFrames,
+            bytesCaptured
+        };
+        if (frame !== undefined) {
+            progress.frame = frame;
+        }
+        if (error !== undefined) {
+            progress.error = error;
+        }
+        return progress;
+    };
+    await withRenderCleanup(async (cleanup) => {
+        cleanup.defer(createBrowserContextCleanupTask(options.driver));
+        await emitCaptureProgress(options.onProgress, createProgress("open"));
+        await options.driver.open(options.composition, {
+            viewport: createBrowserViewport(options.composition),
+            ...options.openOptions
+        });
+        for (let frame = range.startFrame; frame < range.endFrame; frame += 1) {
+            let capture;
+            try {
+                capture = await options.driver.renderFrame(frame, captureOptions);
+            }
+            catch (error) {
+                const failure = { frame, error };
+                errors.push(failure);
+                failedFrames += 1;
+                completedFrames += 1;
+                const progress = createProgress("frame-error", frame, error);
+                await emitCaptureFrameError(options.onFrameError, failure, progress);
+                await emitCaptureProgress(options.onProgress, progress);
+                if (options.continueOnFrameError !== true) {
+                    throw createFrameCaptureError(failure);
+                }
+                continue;
+            }
+            captures.push(capture);
+            capturedFrames += 1;
+            completedFrames += 1;
+            bytesCaptured += capture.bytes.byteLength;
+            const progress = createProgress("capture", frame);
+            await emitCapturedFrame(options.onFrame, capture, progress);
+            await emitCaptureProgress(options.onProgress, progress);
+        }
+        await emitCaptureProgress(options.onProgress, createProgress("complete"));
+    });
+    return {
+        captures,
+        errors,
+        totalFrames: range.totalFrames,
+        completedFrames,
+        capturedFrames,
+        failedFrames,
+        bytesCaptured
+    };
+}
+export function expandRenderBatch(input) {
+    if (input.rows.length === 0) {
+        throw new Error("Render batch must include at least one prop row.");
+    }
+    const presets = resolveBatchPresets(input.template, input.presets);
+    if (presets.length === 0) {
+        throw new Error("Render batch must include at least one export preset.");
+    }
+    const jobs = [];
+    input.rows.forEach((row, rowIndex) => {
+        const rowId = stableRowId(row, rowIndex);
+        presets.forEach((preset, presetIndex) => {
+            const presetName = stableNamePart(preset.name, `preset-${formatIndex(presetIndex)}`);
+            const outputNameOptions = {
+                row,
+                rowIndex,
+                preset,
+                presetIndex
+            };
+            const outputName = createStableOutputName(input.outputNamePrefix === undefined
+                ? outputNameOptions
+                : {
+                    ...outputNameOptions,
+                    prefix: input.outputNamePrefix
+                });
+            const outputPath = joinOutputPath(input.outputDirectory, outputName);
+            const props = cloneJsonObject(row.props ?? {});
+            const job = {
+                id: `${rowId}:${presetName}`,
+                rowIndex,
+                rowId,
+                presetIndex,
+                presetName,
+                props,
+                preset: cloneJsonObject(preset),
+                document: cloneDocumentForPreset(input.template, preset),
+                outputName
+            };
+            if (outputPath !== undefined) {
+                job.outputPath = outputPath;
+            }
+            jobs.push(job);
+        });
+    });
+    return jobs;
+}
+export function createStableOutputName(options) {
+    const parts = [
+        options.prefix === undefined ? undefined : stableNamePart(options.prefix, "batch"),
+        stableRowId(options.row, options.rowIndex),
+        stableNamePart(options.preset.name, `preset-${formatIndex(options.presetIndex)}`)
+    ].filter((part) => part !== undefined && part.length > 0);
+    return `${parts.join("-")}.${extensionForFormat(options.preset.format)}`;
+}
+function resolveFrameCaptureRange(composition, startFrame = 0, frameCount = composition.composition.durationFrames - startFrame) {
+    assertPositiveInteger(composition.composition.durationFrames, "composition.composition.durationFrames");
+    assertNonNegativeInteger(startFrame, "startFrame");
+    assertPositiveInteger(frameCount, "frameCount");
+    const endFrame = startFrame + frameCount;
+    if (startFrame >= composition.composition.durationFrames) {
+        throw new Error("startFrame must be less than composition.composition.durationFrames.");
+    }
+    if (endFrame > composition.composition.durationFrames) {
+        throw new Error("frame capture range must not exceed composition.composition.durationFrames.");
+    }
+    return {
+        startFrame,
+        endFrame,
+        totalFrames: frameCount
+    };
+}
+async function emitCaptureProgress(onProgress, progress) {
+    if (onProgress !== undefined) {
+        await onProgress(progress);
+    }
+}
+async function emitCapturedFrame(onFrame, capture, progress) {
+    if (onFrame !== undefined) {
+        await onFrame(capture, progress);
+    }
+}
+async function emitCaptureFrameError(onFrameError, failure, progress) {
+    if (onFrameError !== undefined) {
+        await onFrameError(failure, progress);
+    }
+}
+function createFrameCaptureError(failure) {
+    if (failure.error instanceof Error) {
+        return new Error(`Failed to capture frame ${failure.frame}: ${failure.error.message}`, { cause: failure.error });
+    }
+    return new Error(`Failed to capture frame ${failure.frame}.`, { cause: failure.error });
+}
+function createCleanupContext(reason, error) {
+    if (error === undefined) {
+        return { reason };
+    }
+    return { reason, error };
+}
+function createCleanupFailureError(report, operationError) {
+    const cleanupErrors = report.failures.map((failure) => failure.error);
+    if (operationError !== undefined) {
+        return new AggregateError([operationError, ...cleanupErrors], "Render operation failed and one or more cleanup tasks failed.");
+    }
+    return new AggregateError(cleanupErrors, "One or more render cleanup tasks failed.");
+}
+function resolveBatchPresets(template, presets) {
+    const inputs = presets ?? template.exports;
+    return inputs.map((preset) => {
+        if (typeof preset !== "string") {
+            return cloneJsonObject(preset);
+        }
+        const match = template.exports.find((candidate) => candidate.name === preset);
+        if (!match) {
+            throw new Error(`Unknown export preset "${preset}".`);
+        }
+        return cloneJsonObject(match);
+    });
+}
+function cloneDocumentForPreset(template, preset) {
+    return {
+        ...cloneJsonObject(template),
+        exports: [cloneJsonObject(preset)]
+    };
+}
+function stableRowId(row, rowIndex) {
+    const indexPart = `row-${formatIndex(rowIndex)}`;
+    if (row.id === undefined || row.id.length === 0) {
+        return indexPart;
+    }
+    return `${indexPart}-${stableNamePart(row.id, "item")}`;
+}
+function stableNamePart(value, fallback) {
+    const normalized = value
+        .trim()
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "-")
+        .replace(/^-+|-+$/g, "")
+        .replace(/-{2,}/g, "-");
+    return normalized.length === 0 ? fallback : normalized;
+}
+function formatIndex(index) {
+    return String(index + 1).padStart(3, "0");
+}
+function joinOutputPath(directory, outputName) {
+    if (directory === undefined || directory.length === 0) {
+        return undefined;
+    }
+    return `${directory.replace(/\/+$/g, "")}/${outputName}`;
+}
+function defaultOutputName(preset) {
+    return `${stableNamePart(preset.name, "render")}.${extensionForFormat(preset.format)}`;
+}
+function defaultVideoCodec(format) {
+    switch (format) {
+        case "mp4":
+            return "h264";
+        case "webm":
+            return "vp9";
+        case "mov":
+            return "prores";
+        case "gif":
+        case "png-sequence":
+            return null;
+    }
+}
+function normalizeChecksums(checksums) {
+    if (checksums === undefined) {
+        return [];
+    }
+    return (Array.isArray(checksums) ? checksums : [checksums]).map((checksum) => ({ ...checksum }));
+}
+function cloneJsonObject(value) {
+    return JSON.parse(JSON.stringify(value));
+}
+function assertNonEmptyString(value, name) {
+    if (value.length === 0) {
+        throw new Error(`${name} must not be empty.`);
+    }
+}
+function assertPositiveInteger(value, name) {
+    if (!Number.isInteger(value) || value <= 0) {
+        throw new Error(`${name} must be a positive integer.`);
+    }
+}
+function assertNonNegativeInteger(value, name) {
+    if (!Number.isInteger(value) || value < 0) {
+        throw new Error(`${name} must be a non-negative integer.`);
+    }
+}
+function assertPositiveNumber(value, name) {
+    if (!Number.isFinite(value) || value <= 0) {
+        throw new Error(`${name} must be a positive number.`);
+    }
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@kitsra/kavio-render-worker",
+  "version": "0.1.0",
+  "description": "Browser automation and frame capture worker for Kavio.",
+  "license": "Elastic-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@kitsra/kavio-schema": "0.1.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.tsbuildinfo",
+    "!dist/self-check.*"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "test": "tsc -p tsconfig.json && node dist/self-check.js"
+  }
+}