@editframe/api 0.15.0-beta.9 → 0.16.0-beta.1

package/dist/resources/isobmff-track.d.ts

@@ -10,14 +10,14 @@ export declare const AudioStreamSchema: z.ZodObject<{
     sample_fmt: z.ZodString;
     sample_rate: z.ZodString;
     channels: z.ZodNumber;
-    channel_layout: z.ZodString;
+    channel_layout: z.ZodOptional<z.ZodString>;
     bits_per_sample: z.ZodNumber;
     initial_padding: z.ZodOptional<z.ZodNumber>;
     r_frame_rate: z.ZodString;
     avg_frame_rate: z.ZodString;
     time_base: z.ZodString;
-    start_pts: z.ZodNumber;
-    start_time: z.ZodNumber;
+    start_pts: z.ZodOptional<z.ZodNumber>;
+    start_time: z.ZodOptional<z.ZodNumber>;
     duration_ts: z.ZodNumber;
     duration: z.ZodNumber;
     bit_rate: z.ZodString;
@@ -32,18 +32,18 @@ export declare const AudioStreamSchema: z.ZodObject<{
     sample_fmt: string;
     sample_rate: string;
     channels: number;
-    channel_layout: string;
     bits_per_sample: number;
     r_frame_rate: string;
     avg_frame_rate: string;
     time_base: string;
-    start_pts: number;
-    start_time: number;
     duration_ts: number;
     duration: number;
     bit_rate: string;
     disposition: Record<string, unknown>;
+    channel_layout?: string | undefined;
     initial_padding?: number | undefined;
+    start_pts?: number | undefined;
+    start_time?: number | undefined;
 }, {
     index: number;
     codec_name: string;
@@ -54,18 +54,18 @@ export declare const AudioStreamSchema: z.ZodObject<{
     sample_fmt: string;
     sample_rate: string;
     channels: number;
-    channel_layout: string;
     bits_per_sample: number;
     r_frame_rate: string;
     avg_frame_rate: string;
     time_base: string;
-    start_pts: number;
-    start_time: number;
     duration_ts: number;
     duration: number;
     bit_rate: string;
     disposition: Record<string, unknown>;
+    channel_layout?: string | undefined;
     initial_padding?: number | undefined;
+    start_pts?: number | undefined;
+    start_time?: number | undefined;
 }>;
 export interface AudioStreamSchema {
     /** The index of the stream in the file */
@@ -87,7 +87,7 @@ export interface AudioStreamSchema {
     /** The number of channels */
     channels: number;
     /** The channel layout */
-    channel_layout: string;
+    channel_layout?: string;
     /** The number of bits per sample */
     bits_per_sample: number;
     /** The initial padding */
@@ -99,9 +99,9 @@ export interface AudioStreamSchema {
     /** The time base */
     time_base: string;
     /** The start presentation timestamp */
-    start_pts: number;
+    start_pts?: number;
     /** The start time */
-    start_time: number;
+    start_time?: number;
     /** The duration timestamp */
     duration_ts: number;
     /** The duration */
@@ -226,14 +226,14 @@ export declare const AudioTrackPayload: z.ZodObject<{
         sample_fmt: z.ZodString;
         sample_rate: z.ZodString;
         channels: z.ZodNumber;
-        channel_layout: z.ZodString;
+        channel_layout: z.ZodOptional<z.ZodString>;
         bits_per_sample: z.ZodNumber;
         initial_padding: z.ZodOptional<z.ZodNumber>;
         r_frame_rate: z.ZodString;
         avg_frame_rate: z.ZodString;
         time_base: z.ZodString;
-        start_pts: z.ZodNumber;
-        start_time: z.ZodNumber;
+        start_pts: z.ZodOptional<z.ZodNumber>;
+        start_time: z.ZodOptional<z.ZodNumber>;
         duration_ts: z.ZodNumber;
         duration: z.ZodNumber;
         bit_rate: z.ZodString;
@@ -248,18 +248,18 @@ export declare const AudioTrackPayload: z.ZodObject<{
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     }, {
         index: number;
         codec_name: string;
@@ -270,18 +270,18 @@ export declare const AudioTrackPayload: z.ZodObject<{
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     }>;
     duration_ms: z.ZodNumber;
     codec_name: z.ZodString;
@@ -302,18 +302,18 @@ export declare const AudioTrackPayload: z.ZodObject<{
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     };
     duration_ms: number;
 }, {
@@ -332,18 +332,18 @@ export declare const AudioTrackPayload: z.ZodObject<{
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     };
     duration_ms: number;
 }>;
@@ -504,14 +504,14 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
         sample_fmt: z.ZodString;
         sample_rate: z.ZodString;
         channels: z.ZodNumber;
-        channel_layout: z.ZodString;
+        channel_layout: z.ZodOptional<z.ZodString>;
         bits_per_sample: z.ZodNumber;
         initial_padding: z.ZodOptional<z.ZodNumber>;
         r_frame_rate: z.ZodString;
         avg_frame_rate: z.ZodString;
         time_base: z.ZodString;
-        start_pts: z.ZodNumber;
-        start_time: z.ZodNumber;
+        start_pts: z.ZodOptional<z.ZodNumber>;
+        start_time: z.ZodOptional<z.ZodNumber>;
         duration_ts: z.ZodNumber;
         duration: z.ZodNumber;
         bit_rate: z.ZodString;
@@ -526,18 +526,18 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     }, {
         index: number;
         codec_name: string;
@@ -548,18 +548,18 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     }>;
     duration_ms: z.ZodNumber;
     codec_name: z.ZodString;
@@ -580,18 +580,18 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     };
     duration_ms: number;
 }, {
@@ -610,18 +610,18 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
         sample_fmt: string;
         sample_rate: string;
         channels: number;
-        channel_layout: string;
         bits_per_sample: number;
         r_frame_rate: string;
         avg_frame_rate: string;
         time_base: string;
-        start_pts: number;
-        start_time: number;
         duration_ts: number;
         duration: number;
         bit_rate: string;
         disposition: Record<string, unknown>;
+        channel_layout?: string | undefined;
         initial_padding?: number | undefined;
+        start_pts?: number | undefined;
+        start_time?: number | undefined;
     };
     duration_ms: number;
 }>, z.ZodObject<{

package/dist/resources/isobmff-track.js

@@ -11,14 +11,14 @@ const AudioStreamSchema = z.object({
   sample_fmt: z.string(),
   sample_rate: z.string(),
   channels: z.number(),
-  channel_layout: z.string(),
+  channel_layout: z.string().optional(),
   bits_per_sample: z.number(),
   initial_padding: z.number().optional(),
   r_frame_rate: z.string(),
   avg_frame_rate: z.string(),
   time_base: z.string(),
-  start_pts: z.number(),
-  start_time: z.coerce.number(),
+  start_pts: z.number().optional(),
+  start_time: z.coerce.number().optional(),
   duration_ts: z.number(),
   duration: z.coerce.number(),
   bit_rate: z.string(),

package/dist/resources/process-isobmff.d.ts

@@ -6,7 +6,7 @@ export interface IsobmffProcessInfoResult {
     completed_at: string | null;
     failed_at: string | null;
     isobmff_file_id: string | null;
-    unprocessed_file_id: string;
+    unprocessed_file_id: string | null;
 }
 export declare const getIsobmffProcessProgress: (client: Client, id: string) => Promise<ProgressIterator>;
 export declare const getIsobmffProcessInfo: (client: Client, id: string) => Promise<IsobmffProcessInfoResult>;

package/dist/resources/renders.d.ts

@@ -8,6 +8,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     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"]>>>;
 }, "strip", z.ZodTypeAny, {
@@ -19,6 +20,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     fps?: number | undefined;
     work_slice_ms?: number | undefined;
     html?: string | undefined;
+    metadata?: Record<string, string> | undefined;
 }, {
     width?: number | undefined;
     height?: number | undefined;
@@ -28,6 +30,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     fps?: number | undefined;
     work_slice_ms?: number | undefined;
     html?: string | undefined;
+    metadata?: Record<string, string> | undefined;
 }>;
 export interface CreateRenderPayload {
     md5?: string;
@@ -37,17 +40,20 @@ export interface CreateRenderPayload {
     work_slice_ms?: number;
     html?: string;
     duration_ms?: number;
+    metadata?: Record<string, string>;
     strategy?: "v1";
 }
 export interface CreateRenderResult {
     id: string;
-    md5: string;
+    md5: string | null;
     status: "complete" | "created" | "failed" | "pending" | "rendering" | string;
+    metadata: Record<string, string>;
 }
 export interface LookupRenderByMd5Result {
     id: string;
-    md5: 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>;

package/dist/resources/renders.js

@@ -9,6 +9,7 @@ const CreateRenderPayload = z.object({
   height: z.number().int().min(2).optional(),
   work_slice_ms: z.number().int().min(1e3).max(1e4).default(4e3).optional(),
   html: z.string().optional(),
+  metadata: z.record(z.string(), z.string()).optional(),
   duration_ms: z.number().int().optional(),
   strategy: z.enum(["v1"]).default("v1").optional()
 });

package/dist/uploadChunks.js

@@ -49,6 +49,7 @@ function uploadChunks(client, {
     }
     log("Checking upload status", url);
     const uploadStatus = await client.authenticatedFetch(url);
+    console.log("UPLOAD STATUS", url, uploadStatus);
     yield { type: "progress", progress: 0 };
     if (uploadStatus.status === 200) {
       log("Chunk already uploaded");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/api",
-  "version": "0.15.0-beta.9",
+  "version": "0.16.0-beta.1",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
@@ -38,23 +38,25 @@
   "license": "UNLICENSED",
   "devDependencies": {
     "@types/jsonwebtoken": "^9.0.6",
+    "@types/mime-types": "^2.1.4",
     "@types/node": "^20.14.13",
     "typedoc": "^0.26.5",
     "typescript": "^5.5.4",
     "vite-plugin-dts": "^4.0.3"
   },
   "dependencies": {
-    "@editframe/assets": "0.15.0-beta.9",
+    "@editframe/assets": "0.16.0-beta.1",
     "@vitejs/plugin-react": "^4.3.4",
-    "vite-tsconfig-paths": "^4.3.2",
-    "vite": "^5.4.11",
     "debug": "^4.3.5",
     "eventsource-parser": "^3.0.0",
     "jsonwebtoken": "^9.0.2",
     "mime": "^4.0.4",
+    "mime-types": "^2.1.35",
     "node-fetch": "^3.3.2",
     "tar": "^7.4.3",
+    "vite": "^5.4.11",
     "vite-plugin-singlefile": "^2.1.0",
+    "vite-tsconfig-paths": "^4.3.2",
     "zod": "^3.23.8"
   }
 }

package/src/resources/image-file.test.ts

@@ -6,6 +6,7 @@ import { ZodError } from "zod";
 import { Client } from "../client.js";
 import { webReadableFromBuffers } from "../readableFromBuffers.js";
 import {
+  CreateImageFilePayload,
   createImageFile,
   lookupImageFileByMd5,
   uploadImageFile,
@@ -19,6 +20,28 @@ const UploadMustContinue = (id = "test-file") =>
     HttpResponse.json({}, { status: 202 }),
   );
 
+describe("CreateImageFilePayload", () => {
+  test("parses mime type from filename", () => {
+    const payload = CreateImageFilePayload.parse({
+      byte_size: 100,
+      filename: "test.jpg",
+    });
+
+    expect(payload.mime_type).toBe("image/jpeg");
+  });
+
+  test("rejects unsupported mime types", () => {
+    const payload = CreateImageFilePayload.safeParse({
+      byte_size: 100,
+      filename: "test.txt",
+    });
+
+    expect(
+      payload.error?.issues.some((issue) => issue.path.includes("mime_type")),
+    ).toBe(true);
+  });
+});
+
 describe("ImageFile", () => {
   beforeAll(() => server.listen());
   afterEach(() => server.resetHandlers());

package/src/resources/image-file.ts

@@ -1,4 +1,5 @@
 import debug from "debug";
+import { types } from "mime-types";
 import { z } from "zod";
 
 import type { Client } from "../client.js";
@@ -8,32 +9,63 @@ const log = debug("ef:api:image-file");
 
 const MAX_IMAGE_SIZE = 1024 * 1024 * 16; // 16MB
 
-export const CreateImageFilePayload = z.object({
-  /**
-   * The md5 hash of the image file.
-   */
-  md5: z.string().nullable(),
-  /**
-   * The height of the image file in pixels.
-   */
-  height: z.number().int().nullable(),
-  /**
-   * The width of the image file in pixels.
-   */
-  width: z.number().int().nullable(),
-  /**
-   * The mime type of the image file.
-   */
-  mime_type: z.enum(["image/jpeg", "image/png", "image/jpg", "image/webp"]),
-  /**
-   * The filename of the image file.
-   */
-  filename: z.string(),
-  /**
-   * The byte size of the image file.
-   */
-  byte_size: z.number().int().max(MAX_IMAGE_SIZE),
-});
+export const ImageFileMimeTypes = z.enum([
+  "image/jpeg",
+  "image/png",
+  "image/jpg",
+  "image/webp",
+]);
+
+function getFileExtension(path: string) {
+  const match = path.match(/\.([^.]+)$/);
+  return match ? match[1] : null;
+}
+
+export const CreateImageFilePayload = z
+  .object({
+    /**
+     * The md5 hash of the image file.
+     */
+    md5: z.string().optional(),
+    /**
+     * The height of the image file in pixels.
+     */
+    height: z.number().int().optional(),
+    /**
+     * The width of the image file in pixels.
+     */
+    width: z.number().int().optional(),
+    /**
+     * The mime type of the image file. Optional if the filename has a known file extension.
+     */
+    mime_type: ImageFileMimeTypes.optional(),
+    /**
+     * The filename of the image file.
+     */
+    filename: z.string(),
+    /**
+     * The byte size of the image file.
+     */
+    byte_size: z.number().int().max(MAX_IMAGE_SIZE),
+  })
+  .superRefine((data, ctx) => {
+    const extension = getFileExtension(data.filename);
+    const mimeType = extension ? types[extension] : null;
+    const parsedMimeType = ImageFileMimeTypes.safeParse(mimeType).data;
+
+    if (parsedMimeType) {
+      data.mime_type = parsedMimeType;
+    }
+
+    if (!parsedMimeType && !data.mime_type) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "mime_type is required when filename extension doesn't match a known image type",
+        path: ["mime_type"],
+      });
+    }
+  });
 
 export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 
@@ -53,16 +85,39 @@ export interface CreateImageFileResult {
   /**
    * The md5 hash of the image file.
    */
-  md5: string;
+  md5: string | null;
 }
 
 export interface LookupImageFileByMd5Result {
+  /**
+   * Whether the image file has been fully uploaded.
+   */
   complete: boolean | null;
+  /**
+   * The byte size of the image file.
+   */
   byte_size: number;
+  /**
+   * The id of the image file.
+   */
   id: string;
-  md5: string;
+  /**
+   * md5 hash of the image file.
+   */
+  md5: string | null;
+  /**
+   * The height of the image file in pixels.
+   */
+  height: number | null;
+  /**
+   * The width of the image file in pixels.
+   */
+  width: number | null;
 }
 
+export interface GetImageFileMetadataResult
+  extends LookupImageFileByMd5Result {}
+
 export const createImageFile = async (
   client: Client,
   payload: CreateImageFilePayload,
@@ -92,6 +147,7 @@ export const uploadImageFile = (
     byte_size: number;
   },
   fileStream: ReadableStream,
+  chunkSizeBytes?: number,
 ) => {
   log("Uploading image file", uploadDetails.id);
 
@@ -100,9 +156,28 @@ export const uploadImageFile = (
     fileSize: uploadDetails.byte_size,
     fileStream,
     maxSize: MAX_IMAGE_SIZE,
+    chunkSizeBytes,
   });
 };
 
+export const getImageFileMetadata = async (
+  client: Client,
+  id: string,
+): Promise<GetImageFileMetadataResult | null> => {
+  const response = await client.authenticatedFetch(
+    `/api/v1/image_files/${id}.json`,
+    {
+      method: "GET",
+    },
+  );
+
+  if (response.ok) {
+    return (await response.json()) as LookupImageFileByMd5Result;
+  }
+
+  return null;
+};
+
 export const lookupImageFileByMd5 = async (
   client: Client,
   md5: string,

package/src/resources/isobmff-track.ts

@@ -14,14 +14,14 @@ export const AudioStreamSchema = z.object({
   sample_fmt: z.string(),
   sample_rate: z.string(),
   channels: z.number(),
-  channel_layout: z.string(),
+  channel_layout: z.string().optional(),
   bits_per_sample: z.number(),
   initial_padding: z.number().optional(),
   r_frame_rate: z.string(),
   avg_frame_rate: z.string(),
   time_base: z.string(),
-  start_pts: z.number(),
-  start_time: z.coerce.number(),
+  start_pts: z.number().optional(),
+  start_time: z.coerce.number().optional(),
   duration_ts: z.number(),
   duration: z.coerce.number(),
   bit_rate: z.string(),
@@ -48,7 +48,7 @@ export interface AudioStreamSchema {
   /** The number of channels */
   channels: number;
   /** The channel layout */
-  channel_layout: string;
+  channel_layout?: string;
   /** The number of bits per sample */
   bits_per_sample: number;
   /** The initial padding */
@@ -60,9 +60,9 @@ export interface AudioStreamSchema {
   /** The time base */
   time_base: string;
   /** The start presentation timestamp */
-  start_pts: number;
+  start_pts?: number;
   /** The start time */
-  start_time: number;
+  start_time?: number;
   /** The duration timestamp */
   duration_ts: number;
   /** The duration */

package/src/resources/process-isobmff.ts

@@ -7,7 +7,7 @@ export interface IsobmffProcessInfoResult {
   completed_at: string | null;
   failed_at: string | null;
   isobmff_file_id: string | null;
-  unprocessed_file_id: string;
+  unprocessed_file_id: string | null;
 }
 
 export const getIsobmffProcessProgress = async (client: Client, id: string) => {