@remotion/renderer 4.0.0-webhook.27 → 4.1.0-alpha2

package/dist/puppeteer-screenshot.js

@@ -24,52 +24,25 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.screenshot = void 0;
-const assert = __importStar(require("assert"));
+const assert = __importStar(require("node:assert"));
 const screenshot_task_1 = require("./screenshot-task");
-const screenshot = (page, options) => {
-    let screenshotType = null;
-    // options.type takes precedence over inferring the type from options.path
-    // because it may be a 0-length file with no extension created beforehand
-    // (i.e. as a temp file).
-    if (options.type) {
-        assert.ok(options.type === 'png' || options.type === 'jpeg', 'Unknown options.type value: ' + options.type);
-        screenshotType = options.type;
+const screenshot = (options) => {
+    if (options.jpegQuality) {
+        assert.ok(typeof options.jpegQuality === 'number', 'Expected options.quality to be a number but found ' +
+            typeof options.jpegQuality);
+        assert.ok(Number.isInteger(options.jpegQuality), 'Expected options.quality to be an integer');
+        assert.ok(options.jpegQuality >= 0 && options.jpegQuality <= 100, 'Expected options.quality to be between 0 and 100 (inclusive), got ' +
+            options.jpegQuality);
     }
-    else if (options.path) {
-        const filePath = options.path;
-        const extension = filePath
-            .slice(filePath.lastIndexOf('.') + 1)
-            .toLowerCase();
-        if (extension === 'png')
-            screenshotType = 'png';
-        else if (extension === 'jpg' || extension === 'jpeg')
-            screenshotType = 'jpeg';
-        assert.ok(screenshotType, `Unsupported screenshot type for extension \`.${extension}\``);
-    }
-    if (!screenshotType)
-        screenshotType = 'png';
-    if (options.quality) {
-        assert.ok(screenshotType === 'jpeg', 'options.quality is unsupported for the ' +
-            screenshotType +
-            ' screenshots');
-        assert.ok(typeof options.quality === 'number', 'Expected options.quality to be a number but found ' +
-            typeof options.quality);
-        assert.ok(Number.isInteger(options.quality), 'Expected options.quality to be an integer');
-        assert.ok(options.quality >= 0 && options.quality <= 100, 'Expected options.quality to be between 0 and 100 (inclusive), got ' +
-            options.quality);
-    }
-    if (options.clip) {
-        assert.ok(typeof options.clip.x === 'number', 'Expected options.clip.x to be a number but found ' +
-            typeof options.clip.x);
-        assert.ok(typeof options.clip.y === 'number', 'Expected options.clip.y to be a number but found ' +
-            typeof options.clip.y);
-        assert.ok(typeof options.clip.width === 'number', 'Expected options.clip.width to be a number but found ' +
-            typeof options.clip.width);
-        assert.ok(typeof options.clip.height === 'number', 'Expected options.clip.height to be a number but found ' +
-            typeof options.clip.height);
-        assert.ok(options.clip.width !== 0, 'Expected options.clip.width not to be 0.');
-        assert.ok(options.clip.height !== 0, 'Expected options.clip.height not to be 0.');
-    }
-    return page.screenshotTaskQueue.postTask(() => (0, screenshot_task_1._screenshotTask)(page, screenshotType, options));
+    return options.page.screenshotTaskQueue.postTask(() => (0, screenshot_task_1.screenshotTask)({
+        page: options.page,
+        format: options.type,
+        height: options.height,
+        width: options.width,
+        omitBackground: options.omitBackground,
+        path: options.path,
+        jpegQuality: options.type === 'jpeg' ? options.jpegQuality : undefined,
+        clipRegion: options.clipRegion,
+    }));
 };
 exports.screenshot = screenshot;

package/dist/redirect-status-codes.d.ts

@@ -0,0 +1 @@
+export declare const redirectStatusCodes: number[];

package/dist/redirect-status-codes.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redirectStatusCodes = void 0;
+// Don't handle 304 status code (Not Modified) as a redirect,
+// since the browser will display the right page.
+exports.redirectStatusCodes = [301, 302, 303, 307, 308];

package/dist/render-frames.d.ts

@@ -1,45 +1,60 @@
 /// <reference types="node" />
-import type { SmallTCompMetadata } from 'remotion';
+import type { AnySmallCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
-import type { DownloadMap } from './assets/download-map';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
-import type { Browser } from './browser/Browser';
-import type { FfmpegExecutable } from './ffmpeg-executable';
+import type { HeadlessBrowser } from './browser/Browser';
 import type { FrameRange } from './frame-range';
-import type { ImageFormat } from './image-format';
-import type { ServeUrlOrWebpackBundle } from './legacy-webpack-config';
+import type { VideoImageFormat } from './image-format';
 import type { CancelSignal } from './make-cancel-signal';
 import type { ChromiumOptions } from './open-browser';
+import type { RemotionServer } from './prepare-server';
 import type { OnStartData, RenderFramesOutput } from './types';
-declare type ConfigOrComposition = {
-    /**
-     * @deprecated This field has been renamed to `composition`
-     */
-    config: SmallTCompMetadata;
-} | {
-    composition: SmallTCompMetadata;
-};
-declare type ConcurrencyOrParallelism = {
-    concurrency?: number | null;
-} | {
-    /**
-     * @deprecated This field has been renamed to `concurrency`
-     */
-    parallelism?: number | null;
+export type InternalRenderFramesOptions = {
+    onStart: null | ((data: OnStartData) => void);
+    onFrameUpdate: null | ((framesRendered: number, frameIndex: number, timeToRenderInMilliseconds: number) => void);
+    outputDir: string | null;
+    inputProps: Record<string, unknown>;
+    envVariables: Record<string, string>;
+    imageFormat: VideoImageFormat;
+    jpegQuality: number;
+    frameRange: FrameRange | null;
+    everyNthFrame: number;
+    dumpBrowserLogs: boolean;
+    puppeteerInstance: HeadlessBrowser | undefined;
+    browserExecutable: BrowserExecutable | null;
+    onBrowserLog: null | ((log: BrowserLog) => void);
+    onFrameBuffer: null | ((buffer: Buffer, frame: number) => void);
+    onDownload: RenderMediaOnDownload | null;
+    timeoutInMilliseconds: number;
+    chromiumOptions: ChromiumOptions;
+    scale: number;
+    port: number | null;
+    cancelSignal: CancelSignal | undefined;
+    composition: AnySmallCompMetadata;
+    indent: boolean;
+    server: RemotionServer | undefined;
+    muted: boolean;
+    concurrency: number | string | null;
+    webpackBundleOrServeUrl: string;
+    verbose: boolean;
 };
-declare type RenderFramesOptions = {
+export type RenderFramesOptions = {
     onStart: (data: OnStartData) => void;
-    onFrameUpdate: (framesRendered: number, frameIndex: number) => void;
+    onFrameUpdate: (framesRendered: number, frameIndex: number, timeToRenderInMilliseconds: number) => void;
     outputDir: string | null;
-    inputProps: unknown;
+    inputProps: Record<string, unknown>;
     envVariables?: Record<string, string>;
-    imageFormat: ImageFormat;
-    quality?: number;
+    imageFormat?: VideoImageFormat;
+    /**
+     * @deprecated Renamed to "jpegQuality"
+     */
+    quality?: never;
+    jpegQuality?: number;
     frameRange?: FrameRange | null;
     everyNthFrame?: number;
     dumpBrowserLogs?: boolean;
-    puppeteerInstance?: Browser;
+    puppeteerInstance?: HeadlessBrowser;
     browserExecutable?: BrowserExecutable;
     onBrowserLog?: (log: BrowserLog) => void;
     onFrameBuffer?: (buffer: Buffer, frame: number) => void;
@@ -47,15 +62,17 @@ declare type RenderFramesOptions = {
     timeoutInMilliseconds?: number;
     chromiumOptions?: ChromiumOptions;
     scale?: number;
-    ffmpegExecutable?: FfmpegExecutable;
-    ffprobeExecutable?: FfmpegExecutable;
     port?: number | null;
     cancelSignal?: CancelSignal;
-    /**
-     * @deprecated Only for Remotion internal usage
-     */
-    downloadMap?: DownloadMap;
+    composition: AnySmallCompMetadata;
     muted?: boolean;
-} & ConfigOrComposition & ConcurrencyOrParallelism & ServeUrlOrWebpackBundle;
+    concurrency?: number | string | null;
+    serveUrl: string;
+    verbose?: boolean;
+};
+export declare const internalRenderFrames: ({ browserExecutable, cancelSignal, chromiumOptions, composition, concurrency, dumpBrowserLogs, envVariables, everyNthFrame, frameRange, imageFormat, indent, inputProps, jpegQuality, muted, onBrowserLog, onDownload, onFrameBuffer, onFrameUpdate, onStart, outputDir, port, puppeteerInstance, scale, server, timeoutInMilliseconds, verbose, webpackBundleOrServeUrl, }: InternalRenderFramesOptions) => Promise<RenderFramesOutput>;
+/**
+ * @description Renders a series of images using Puppeteer and computes information for mixing audio.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
+ */
 export declare const renderFrames: (options: RenderFramesOptions) => Promise<RenderFramesOutput>;
-export {};