@editframe/api 0.24.1-beta.0 → 0.25.0-beta.0

package/dist/resources/renders.d.ts

@@ -1,422 +1,284 @@
-import { z } from 'zod';
-import { Client } from '../client.js';
-import { CompletionIterator } from '../ProgressIterator.js';
-export declare const RenderOutputConfiguration: z.ZodDiscriminatedUnion<"container", [z.ZodObject<{
+import { Client } from "../client.js";
+import { CompletionIterator } from "../ProgressIterator.js";
+import { z } from "zod";
+
+//#region src/resources/renders.d.ts
+declare const RenderOutputConfiguration: z.ZodDiscriminatedUnion<"container", [z.ZodObject<{
+  container: z.ZodLiteral<"mp4">;
+  video: z.ZodObject<{
+    codec: z.ZodLiteral<"h264">;
+  }, "strip", z.ZodTypeAny, {
+    codec: "h264";
+  }, {
+    codec: "h264";
+  }>;
+  audio: z.ZodObject<{
+    codec: z.ZodLiteral<"aac">;
+  }, "strip", z.ZodTypeAny, {
+    codec: "aac";
+  }, {
+    codec: "aac";
+  }>;
+}, "strip", z.ZodTypeAny, {
+  audio: {
+    codec: "aac";
+  };
+  video: {
+    codec: "h264";
+  };
+  container: "mp4";
+}, {
+  audio: {
+    codec: "aac";
+  };
+  video: {
+    codec: "h264";
+  };
+  container: "mp4";
+}>, z.ZodObject<{
+  container: z.ZodLiteral<"jpeg">;
+  quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+  container: "jpeg";
+  quality?: number | undefined;
+}, {
+  container: "jpeg";
+  quality?: number | undefined;
+}>, z.ZodObject<{
+  container: z.ZodLiteral<"png">;
+  compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+  transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+  container: "png";
+  compression?: number | undefined;
+  transparency?: boolean | undefined;
+}, {
+  container: "png";
+  compression?: number | undefined;
+  transparency?: boolean | undefined;
+}>, z.ZodObject<{
+  container: z.ZodLiteral<"webp">;
+  quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+  compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+  transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+  container: "webp";
+  quality?: number | undefined;
+  compression?: number | undefined;
+  transparency?: boolean | undefined;
+}, {
+  container: "webp";
+  quality?: number | undefined;
+  compression?: number | undefined;
+  transparency?: boolean | undefined;
+}>]>;
+type RenderOutputConfiguration = z.infer<typeof RenderOutputConfiguration>;
+declare const CreateRenderPayload: z.ZodObject<{
+  md5: z.ZodOptional<z.ZodString>;
+  fps: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+  work_slice_ms: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+  html: z.ZodOptional<z.ZodString>;
+  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  duration_ms: z.ZodOptional<z.ZodNumber>;
+  strategy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["v1"]>>>;
+  output: z.ZodOptional<z.ZodDefault<z.ZodDiscriminatedUnion<"container", [z.ZodObject<{
     container: z.ZodLiteral<"mp4">;
     video: z.ZodObject<{
-        codec: z.ZodLiteral<"h264">;
+      codec: z.ZodLiteral<"h264">;
     }, "strip", z.ZodTypeAny, {
-        codec: "h264";
+      codec: "h264";
     }, {
-        codec: "h264";
+      codec: "h264";
     }>;
     audio: z.ZodObject<{
-        codec: z.ZodLiteral<"aac">;
+      codec: z.ZodLiteral<"aac">;
     }, "strip", z.ZodTypeAny, {
-        codec: "aac";
+      codec: "aac";
     }, {
-        codec: "aac";
+      codec: "aac";
     }>;
-}, "strip", z.ZodTypeAny, {
+  }, "strip", z.ZodTypeAny, {
     audio: {
-        codec: "aac";
+      codec: "aac";
     };
     video: {
-        codec: "h264";
+      codec: "h264";
     };
     container: "mp4";
-}, {
+  }, {
     audio: {
-        codec: "aac";
+      codec: "aac";
     };
     video: {
-        codec: "h264";
+      codec: "h264";
     };
     container: "mp4";
-}>, z.ZodObject<{
+  }>, z.ZodObject<{
     container: z.ZodLiteral<"jpeg">;
     quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-}, "strip", z.ZodTypeAny, {
+  }, "strip", z.ZodTypeAny, {
     container: "jpeg";
     quality?: number | undefined;
-}, {
+  }, {
     container: "jpeg";
     quality?: number | undefined;
-}>, z.ZodObject<{
+  }>, z.ZodObject<{
     container: z.ZodLiteral<"png">;
     compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-}, "strip", z.ZodTypeAny, {
+  }, "strip", z.ZodTypeAny, {
     container: "png";
     compression?: number | undefined;
     transparency?: boolean | undefined;
-}, {
+  }, {
     container: "png";
     compression?: number | undefined;
     transparency?: boolean | undefined;
-}>, z.ZodObject<{
+  }>, z.ZodObject<{
     container: z.ZodLiteral<"webp">;
     quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-}, "strip", z.ZodTypeAny, {
+  }, "strip", z.ZodTypeAny, {
     container: "webp";
     quality?: number | undefined;
     compression?: number | undefined;
     transparency?: boolean | undefined;
-}, {
+  }, {
     container: "webp";
     quality?: number | undefined;
     compression?: number | undefined;
     transparency?: boolean | undefined;
-}>]>;
-export type RenderOutputConfiguration = z.infer<typeof RenderOutputConfiguration>;
-export declare const CreateRenderPayload: z.ZodObject<{
-    md5: z.ZodOptional<z.ZodString>;
-    fps: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    width: z.ZodOptional<z.ZodNumber>;
-    height: z.ZodOptional<z.ZodNumber>;
-    work_slice_ms: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    html: z.ZodOptional<z.ZodString>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    duration_ms: z.ZodOptional<z.ZodNumber>;
-    strategy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["v1"]>>>;
-    output: z.ZodOptional<z.ZodDefault<z.ZodDiscriminatedUnion<"container", [z.ZodObject<{
-        container: z.ZodLiteral<"mp4">;
-        video: z.ZodObject<{
-            codec: z.ZodLiteral<"h264">;
-        }, "strip", z.ZodTypeAny, {
-            codec: "h264";
-        }, {
-            codec: "h264";
-        }>;
-        audio: z.ZodObject<{
-            codec: z.ZodLiteral<"aac">;
-        }, "strip", z.ZodTypeAny, {
-            codec: "aac";
-        }, {
-            codec: "aac";
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    }, {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    }>, z.ZodObject<{
-        container: z.ZodLiteral<"jpeg">;
-        quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    }, "strip", z.ZodTypeAny, {
-        container: "jpeg";
-        quality?: number | undefined;
-    }, {
-        container: "jpeg";
-        quality?: number | undefined;
-    }>, z.ZodObject<{
-        container: z.ZodLiteral<"png">;
-        compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    }, "strip", z.ZodTypeAny, {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }, {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }>, z.ZodObject<{
-        container: z.ZodLiteral<"webp">;
-        quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    }, "strip", z.ZodTypeAny, {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }, {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }>]>>>;
+  }>]>>>;
 }, "strip", z.ZodTypeAny, {
-    width?: number | undefined;
-    height?: number | undefined;
-    md5?: string | undefined;
-    strategy?: "v1" | undefined;
-    duration_ms?: number | undefined;
-    fps?: number | undefined;
-    work_slice_ms?: number | undefined;
-    html?: string | undefined;
-    metadata?: Record<string, string> | undefined;
-    output?: {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    } | {
-        container: "jpeg";
-        quality?: number | undefined;
-    } | {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | undefined;
-}, {
-    width?: number | undefined;
-    height?: number | undefined;
-    md5?: string | undefined;
-    strategy?: "v1" | undefined;
-    duration_ms?: number | undefined;
-    fps?: number | undefined;
-    work_slice_ms?: number | undefined;
-    html?: string | undefined;
-    metadata?: Record<string, string> | undefined;
-    output?: {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    } | {
-        container: "jpeg";
-        quality?: number | undefined;
-    } | {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | undefined;
-}>;
-export declare const CreateRenderPayloadWithOutput: z.ZodObject<{
-    md5: z.ZodOptional<z.ZodString>;
-    fps: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    width: z.ZodOptional<z.ZodNumber>;
-    height: z.ZodOptional<z.ZodNumber>;
-    work_slice_ms: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    html: z.ZodOptional<z.ZodString>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    duration_ms: z.ZodOptional<z.ZodNumber>;
-    strategy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["v1"]>>>;
-} & {
-    output: z.ZodDiscriminatedUnion<"container", [z.ZodObject<{
-        container: z.ZodLiteral<"mp4">;
-        video: z.ZodObject<{
-            codec: z.ZodLiteral<"h264">;
-        }, "strip", z.ZodTypeAny, {
-            codec: "h264";
-        }, {
-            codec: "h264";
-        }>;
-        audio: z.ZodObject<{
-            codec: z.ZodLiteral<"aac">;
-        }, "strip", z.ZodTypeAny, {
-            codec: "aac";
-        }, {
-            codec: "aac";
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    }, {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    }>, z.ZodObject<{
-        container: z.ZodLiteral<"jpeg">;
-        quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    }, "strip", z.ZodTypeAny, {
-        container: "jpeg";
-        quality?: number | undefined;
-    }, {
-        container: "jpeg";
-        quality?: number | undefined;
-    }>, z.ZodObject<{
-        container: z.ZodLiteral<"png">;
-        compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    }, "strip", z.ZodTypeAny, {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }, {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }>, z.ZodObject<{
-        container: z.ZodLiteral<"webp">;
-        quality: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        compression: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        transparency: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    }, "strip", z.ZodTypeAny, {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }, {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    output: {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    } | {
-        container: "jpeg";
-        quality?: number | undefined;
-    } | {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
+  md5?: string | undefined;
+  height?: number | undefined;
+  width?: number | undefined;
+  duration_ms?: number | undefined;
+  fps?: number | undefined;
+  work_slice_ms?: number | undefined;
+  html?: string | undefined;
+  metadata?: Record<string, string> | undefined;
+  strategy?: "v1" | undefined;
+  output?: {
+    audio: {
+      codec: "aac";
+    };
+    video: {
+      codec: "h264";
     };
-    width?: number | undefined;
-    height?: number | undefined;
-    md5?: string | undefined;
-    strategy?: "v1" | undefined;
-    duration_ms?: number | undefined;
-    fps?: number | undefined;
-    work_slice_ms?: number | undefined;
-    html?: string | undefined;
-    metadata?: Record<string, string> | undefined;
+    container: "mp4";
+  } | {
+    container: "jpeg";
+    quality?: number | undefined;
+  } | {
+    container: "png";
+    compression?: number | undefined;
+    transparency?: boolean | undefined;
+  } | {
+    container: "webp";
+    quality?: number | undefined;
+    compression?: number | undefined;
+    transparency?: boolean | undefined;
+  } | undefined;
 }, {
-    output: {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    } | {
-        container: "jpeg";
-        quality?: number | undefined;
-    } | {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
+  md5?: string | undefined;
+  height?: number | undefined;
+  width?: number | undefined;
+  duration_ms?: number | undefined;
+  fps?: number | undefined;
+  work_slice_ms?: number | undefined;
+  html?: string | undefined;
+  metadata?: Record<string, string> | undefined;
+  strategy?: "v1" | undefined;
+  output?: {
+    audio: {
+      codec: "aac";
+    };
+    video: {
+      codec: "h264";
     };
-    width?: number | undefined;
-    height?: number | undefined;
-    md5?: string | undefined;
-    strategy?: "v1" | undefined;
-    duration_ms?: number | undefined;
-    fps?: number | undefined;
-    work_slice_ms?: number | undefined;
-    html?: string | undefined;
-    metadata?: Record<string, string> | undefined;
+    container: "mp4";
+  } | {
+    container: "jpeg";
+    quality?: number | undefined;
+  } | {
+    container: "png";
+    compression?: number | undefined;
+    transparency?: boolean | undefined;
+  } | {
+    container: "webp";
+    quality?: number | undefined;
+    compression?: number | undefined;
+    transparency?: boolean | undefined;
+  } | undefined;
 }>;
-export declare class OutputConfiguration {
-    readonly output: RenderOutputConfiguration;
-    static parse(input?: any): OutputConfiguration;
-    constructor(output: RenderOutputConfiguration);
-    get isStill(): boolean;
-    get isVideo(): boolean;
-    get fileExtension(): "mp4" | "jpeg" | "png" | "webp";
-    get contentType(): string;
-    get container(): "mp4" | "jpeg" | "png" | "webp";
-    get jpegConfig(): {
-        container: "jpeg";
-        quality?: number | undefined;
-    } | null;
-    get pngConfig(): {
-        container: "png";
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | null;
-    get webpConfig(): {
-        container: "webp";
-        quality?: number | undefined;
-        compression?: number | undefined;
-        transparency?: boolean | undefined;
-    } | null;
-    get mp4Config(): {
-        audio: {
-            codec: "aac";
-        };
-        video: {
-            codec: "h264";
-        };
-        container: "mp4";
-    } | null;
+declare class OutputConfiguration {
+  readonly output: RenderOutputConfiguration;
+  static parse(input?: any): OutputConfiguration;
+  constructor(output: RenderOutputConfiguration);
+  get isStill(): boolean;
+  get isVideo(): boolean;
+  get fileExtension(): "mp4" | "jpeg" | "png" | "webp";
+  get contentType(): string;
+  get container(): "mp4" | "jpeg" | "png" | "webp";
+  get jpegConfig(): {
+    container: "jpeg";
+    quality?: number | undefined;
+  } | null;
+  get pngConfig(): {
+    container: "png";
+    compression?: number | undefined;
+    transparency?: boolean | undefined;
+  } | null;
+  get webpConfig(): {
+    container: "webp";
+    quality?: number | undefined;
+    compression?: number | undefined;
+    transparency?: boolean | undefined;
+  } | null;
+  get mp4Config(): {
+    audio: {
+      codec: "aac";
+    };
+    video: {
+      codec: "h264";
+    };
+    container: "mp4";
+  } | null;
 }
-export interface CreateRenderPayload {
-    md5?: string;
-    fps?: number;
-    width?: number;
-    height?: number;
-    work_slice_ms?: number;
-    html?: string;
-    duration_ms?: number;
-    metadata?: Record<string, string>;
-    strategy?: "v1";
-    output?: z.infer<typeof RenderOutputConfiguration>;
+interface CreateRenderPayload {
+  md5?: string;
+  fps?: number;
+  width?: number;
+  height?: number;
+  work_slice_ms?: number;
+  html?: string;
+  duration_ms?: number;
+  metadata?: Record<string, string>;
+  strategy?: "v1";
+  output?: z.infer<typeof RenderOutputConfiguration>;
 }
-export interface CreateRenderResult {
-    id: string;
-    md5: string | null;
-    status: "complete" | "created" | "failed" | "pending" | "rendering" | string;
-    metadata: Record<string, string>;
+interface CreateRenderResult {
+  id: string;
+  md5: string | null;
+  status: "complete" | "created" | "failed" | "pending" | "rendering" | string;
+  metadata: Record<string, string>;
 }
-export interface LookupRenderByMd5Result {
-    id: string;
-    md5: string | null;
-    status: "complete" | "created" | "failed" | "pending" | "rendering" | string;
-    metadata: Record<string, string>;
+interface LookupRenderByMd5Result {
+  id: string;
+  md5: string | null;
+  status: "complete" | "created" | "failed" | "pending" | "rendering" | string;
+  metadata: Record<string, string>;
 }
-export declare const createRender: (client: Client, payload: CreateRenderPayload) => Promise<CreateRenderResult>;
-export declare const uploadRender: (client: Client, renderId: string, fileStream: ReadableStream) => Promise<any>;
-export declare const getRenderInfo: (client: Client, id: string) => Promise<LookupRenderByMd5Result>;
-export declare const lookupRenderByMd5: (client: Client, md5: string) => Promise<LookupRenderByMd5Result | null>;
-export declare const getRenderProgress: (client: Client, id: string) => Promise<CompletionIterator>;
-export declare const downloadRender: (client: Client, id: string) => Promise<Response>;
+declare const createRender: (client: Client, payload: CreateRenderPayload) => Promise<CreateRenderResult>;
+declare const uploadRender: (client: Client, renderId: string, fileStream: ReadableStream) => Promise<any>;
+declare const getRenderInfo: (client: Client, id: string) => Promise<LookupRenderByMd5Result>;
+declare const lookupRenderByMd5: (client: Client, md5: string) => Promise<LookupRenderByMd5Result | null>;
+declare const getRenderProgress: (client: Client, id: string) => Promise<CompletionIterator>;
+declare const downloadRender: (client: Client, id: string) => Promise<Response>;
+//#endregion
+export { CreateRenderPayload, CreateRenderResult, LookupRenderByMd5Result, OutputConfiguration, RenderOutputConfiguration, createRender, downloadRender, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender };
+//# sourceMappingURL=renders.d.ts.map