@alpha2-sh/editor 0.0.0 → 0.1.0

package/dist/browser/runtime/extension-import.d.ts

@@ -0,0 +1,196 @@
+/**
+ * Whether the start of a file could be an SVG, a GIF, an animated WebP, an APNG, a Lottie or
+ * dotLottie, or an OpenEXR image.
+ */
+export function mayBeExtension(head: any): boolean;
+/**
+ * The most bytes the engine reads of a file that could be one of the document formats a provider
+ * parses whole, by its start, with what the file is called: a dotLottie package (a ZIP,
+ * `MAX_PROVIDER_DOCUMENT_BYTES`), a Lottie animation (a JSON object, `MAX_LOTTIE_DOCUMENT_BYTES`)
+ * or an SVG (XML, `MAX_SVG_DOCUMENT_BYTES`); `null` for any other file. A larger file is refused
+ * before it is read.
+ */
+export function providerDocumentLimit(head: any): {
+    limit: number;
+    what: string;
+} | null;
+/** The duration of a provider's timing in seconds, or 0 for a still. */
+export function timingSeconds(timing: any): number;
+/**
+ * A small preview of a rendered frame (premultiplied, sRGB RGBA8 or linear half floats) as an image
+ * URL, {@link THUMBNAIL_WIDTH} wide at most. Only one pixel per thumbnail pixel is converted.
+ */
+export function thumbnailOf(frame: any): Promise<{
+    dataUrl: any;
+    width: number;
+    height: number;
+}>;
+/**
+ * The provider a relinked file opens with: the defaults {@link stageProviderFile} staged it with,
+ * carrying the choices the project `recorded` for that source where the new file still offers them.
+ * A package's animation stays while the package has it; an OpenEXR still's primaries stay while the
+ * file is one whose primaries can be chosen.
+ */
+export function keepProviderChoices(recorded: any, staged: any, report: any): any;
+/**
+ * What import reads of a file with the provider module `extensions`: the provider that claims its
+ * `bytes`, what probing found, and a thumbnail of its first frame; `null` when no provider claims
+ * them. The source is opened as import records it, so a file that probes but does not open is
+ * refused here.
+ *
+ * @throws When a provider claims the bytes and cannot read them.
+ */
+export function readProviderFile(extensions: any, bytes: any): Promise<{
+    report: any;
+    provider: {
+        format: any;
+    } | {
+        animation?: any;
+        format: string;
+    };
+    thumbnail: {
+        dataUrl: any;
+        width: number;
+        height: number;
+    };
+} | null>;
+/**
+ * The diagnostics an SVG's report gives when it is opened with `fonts`, the stack its text draws
+ * with: which of its text no font draws (`missing_font`).
+ */
+export function svgDiagnostics(extensions: any, provider: any, bytes: any, fonts: any): any;
+/**
+ * Stages a file a provider claimed, from what {@link readProviderFile} read of it: a still SVG is
+ * an image source, an animation a video source of one cycle (repetition is the clip's).
+ */
+export function stageProviderFile(file: any, { report, provider, thumbnail }: {
+    report: any;
+    provider: any;
+    thumbnail: any;
+}, fingerprint: any): {
+    dispose(): void;
+    fingerprint?: any;
+    runtime: {
+        report: any;
+        id: `${string}-${string}-${string}-${string}-${string}`;
+        kind: string;
+        name: any;
+        file: any;
+        provider: any;
+        width: any;
+        height: any;
+        duration: number;
+        hasAudio: boolean;
+        fit: string;
+        thumbnail: any;
+    };
+    description: {
+        id: `${string}-${string}-${string}-${string}-${string}`;
+        kind: string;
+        name: any;
+        type: any;
+        size: any;
+        lastModified: any;
+        width: any;
+        height: any;
+        duration: number;
+        provider: any;
+    };
+};
+/**
+ * How numbered files make one image sequence, from their names alone: the frame number each name
+ * ends with, before its extension, fixes the order. Answers the first and last numbers, how many
+ * frames the sequence has (every number between them), how many of those no file has, and the first
+ * few of them; or, when the names cannot make a sequence, why: a name without a number, a number
+ * listed twice, a number past 2^53 - 1 (a project document cannot hold it exactly), or more numbers
+ * between the first and last than a sequence may have. Nothing here walks the numbers between them.
+ *
+ * @param {readonly string[]} names
+ * @returns {{ ok: true, first: number, last: number, frames: number, missing: number, gaps: number[] } | { ok: false, code: string, message: string }}
+ */
+export function sequenceNumbering(names: readonly string[]): {
+    ok: true;
+    first: number;
+    last: number;
+    frames: number;
+    missing: number;
+    gaps: number[];
+} | {
+    ok: false;
+    code: string;
+    message: string;
+};
+/**
+ * Stages numbered PNGs or OpenEXR images as one image sequence at `frameRate`. The numbers fix the
+ * order and the first frame; a gap is refused unless `missing` says to hold or blank it, and every
+ * frame must be the first one's format and size. `openExr(file)` answers what the provider module
+ * makes of an OpenEXR sequence's first frame (see {@link exrFirstFrame}): its thumbnail and report.
+ * `id` names the source (a relink stages under the asset's own), a new one by default.
+ */
+export function stageSequence(files: any, { frameRate, missing, openExr, id }: {
+    frameRate: any;
+    missing?: string | undefined;
+    openExr: any;
+    id?: `${string}-${string}-${string}-${string}-${string}` | undefined;
+}): Promise<{
+    runtime: {
+        report?: any;
+        id: `${string}-${string}-${string}-${string}-${string}`;
+        kind: string;
+        name: string;
+        provider: {
+            format: string;
+            frames: any[];
+            frame_rate: any;
+            start_number: number;
+            missing: string;
+        };
+        frameFiles: Map<any, any>;
+        width: number;
+        height: number;
+        frameRate: number;
+        duration: number;
+        hasAudio: boolean;
+        fit: string;
+        thumbnail: any;
+    };
+    name: string;
+    description: {
+        id: `${string}-${string}-${string}-${string}-${string}`;
+        kind: string;
+        name: string;
+        width: number;
+        height: number;
+        duration: number;
+        provider: {
+            format: string;
+            frames: any[];
+            frame_rate: any;
+            start_number: number;
+            missing: string;
+        };
+    };
+    fingerprint: {
+        streams: {
+            video: {
+                width: number;
+                height: number;
+                frame_rate: any;
+            };
+        };
+        duration_ticks: number;
+    };
+    dispose(): void;
+}>;
+/**
+ * An OpenEXR frame's thumbnail, sampled from the frame the provider module `extensions` renders at
+ * its own size from `bytes`, and what the provider reports of it.
+ */
+export function exrFirstFrame(extensions: any, bytes: any): Promise<{
+    thumbnail: {
+        dataUrl: any;
+        width: number;
+        height: number;
+    };
+    report: any;
+}>;