@editframe/api 0.15.0-beta.17 → 0.15.0-beta.19

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { createCaptionFile, CreateCaptionFilePayload, type CreateCaptionFileResult, uploadCaptionFile, type LookupCaptionFileByMd5Result, lookupCaptionFileByMd5, } from './resources/caption-file.js';
-export { createImageFile, CreateImageFilePayload, type CreateImageFileResult, uploadImageFile, type LookupImageFileByMd5Result, lookupImageFileByMd5, } from './resources/image-file.js';
+export { createImageFile, CreateImageFilePayload, type CreateImageFileResult, uploadImageFile, type LookupImageFileByMd5Result, lookupImageFileByMd5, type GetImageFileMetadataResult, getImageFileMetadata, } from './resources/image-file.js';
 export { createISOBMFFFile, CreateISOBMFFFilePayload, type CreateISOBMFFFileResult, uploadFragmentIndex, type LookupISOBMFFFileByMd5Result, lookupISOBMFFFileByMd5, type GetISOBMFFFileTranscriptionResult, getISOBMFFFileTranscription, type TranscribeISOBMFFFileResult, transcribeISOBMFFFile, TranscribeISOBMFFFilePayload, } from './resources/isobmff-file.js';
 export { createISOBMFFTrack, CreateISOBMFFTrackPayload, type CreateISOBMFFTrackResult, uploadISOBMFFTrack, AudioTrackPayload, type AudioStreamSchema, VideoTrackPayload, type VideoStreamSchema, } from './resources/isobmff-track.js';
 export { createRender, CreateRenderPayload, type CreateRenderResult, uploadRender, type LookupRenderByMd5Result, lookupRenderByMd5, getRenderProgress, getRenderInfo, downloadRender, } from './resources/renders.js';

package/dist/index.js

@@ -1,5 +1,5 @@
 import { CreateCaptionFilePayload, createCaptionFile, lookupCaptionFileByMd5, uploadCaptionFile } from "./resources/caption-file.js";
-import { CreateImageFilePayload, createImageFile, lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
+import { CreateImageFilePayload, createImageFile, getImageFileMetadata, lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
 import { CreateISOBMFFFilePayload, TranscribeISOBMFFFilePayload, createISOBMFFFile, getISOBMFFFileTranscription, lookupISOBMFFFileByMd5, transcribeISOBMFFFile, uploadFragmentIndex } from "./resources/isobmff-file.js";
 import { AudioTrackPayload, CreateISOBMFFTrackPayload, VideoTrackPayload, createISOBMFFTrack, uploadISOBMFFTrack } from "./resources/isobmff-track.js";
 import { CreateRenderPayload, createRender, downloadRender, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender } from "./resources/renders.js";
@@ -30,6 +30,7 @@ export {
   createUnprocessedFile,
   downloadRender,
   getISOBMFFFileTranscription,
+  getImageFileMetadata,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,
   getRenderInfo,

package/dist/node.js

@@ -3,7 +3,7 @@ import { basename } from "node:path";
 import mime from "mime";
 import { md5FilePath } from "@editframe/assets";
 import { createImageFile, CreateImageFilePayload } from "./resources/image-file.js";
-import { lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
+import { getImageFileMetadata, lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
 import { createUnprocessedFile, uploadUnprocessedReadableStream } from "./resources/unprocessed-file.js";
 import { CreateUnprocessedFilePayload, lookupUnprocessedFileByMd5, processIsobmffFile } from "./resources/unprocessed-file.js";
 import { createReadableStreamFromReadable } from "./utils/createReadableStreamFromReadable.js";
@@ -76,6 +76,7 @@ export {
   createUnprocessedFileFromPath,
   downloadRender,
   getISOBMFFFileTranscription,
+  getImageFileMetadata,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,
   getRenderInfo,

package/dist/resources/image-file.d.ts

@@ -1,22 +1,22 @@
 import { z } from 'zod';
 import { Client } from '../client.js';
-export declare const CreateImageFilePayload: z.ZodObject<{
+export declare const CreateImageFilePayload: z.ZodEffects<z.ZodObject<{
     /**
      * The md5 hash of the image file.
      */
-    md5: z.ZodNullable<z.ZodString>;
+    md5: z.ZodOptional<z.ZodString>;
     /**
      * The height of the image file in pixels.
      */
-    height: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
     /**
      * The width of the image file in pixels.
      */
-    width: z.ZodNullable<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
     /**
-     * The mime type of the image file.
+     * The mime type of the image file. Optional if the filename has a known file extension.
      */
-    mime_type: z.ZodEnum<["image/jpeg", "image/png", "image/jpg", "image/webp"]>;
+    mime_type: z.ZodOptional<z.ZodEnum<["image/jpeg", "image/png", "image/jpg", "image/webp"]>>;
     /**
      * The filename of the image file.
      */
@@ -26,19 +26,33 @@ export declare const CreateImageFilePayload: z.ZodObject<{
      */
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    width: number | null;
-    height: number | null;
     filename: string;
-    md5: string | null;
-    mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    md5?: string | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | undefined;
 }, {
-    width: number | null;
-    height: number | null;
     filename: string;
-    md5: string | null;
-    mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    md5?: string | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | undefined;
+}>, {
+    filename: string;
+    byte_size: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    md5?: string | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | undefined;
+}, {
+    filename: string;
+    byte_size: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    md5?: string | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | undefined;
 }>;
 export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 export interface CreateImageFileResult {
@@ -60,14 +74,37 @@ export interface CreateImageFileResult {
     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 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 declare const createImageFile: (client: Client, payload: CreateImageFilePayload) => Promise<CreateImageFileResult>;
 export declare const uploadImageFile: (client: Client, uploadDetails: {
     id: string;
     byte_size: number;
-}, fileStream: ReadableStream) => import('../uploadChunks.js').IteratorWithPromise<import('../uploadChunks.js').UploadChunkEvent>;
+}, fileStream: ReadableStream, chunkSizeBytes?: number) => import('../uploadChunks.js').IteratorWithPromise<import('../uploadChunks.js').UploadChunkEvent>;
+export declare const getImageFileMetadata: (client: Client, id: string) => Promise<GetImageFileMetadataResult | null>;
 export declare const lookupImageFileByMd5: (client: Client, md5: string) => Promise<LookupImageFileByMd5Result | null>;

package/dist/resources/image-file.js

@@ -1,25 +1,32 @@
 import debug from "debug";
+import mime from "mime-types";
 import { z } from "zod";
 import { uploadChunks } from "../uploadChunks.js";
 const log = debug("ef:api:image-file");
 const MAX_IMAGE_SIZE = 1024 * 1024 * 16;
+const acceptedTypes = z.enum([
+  "image/jpeg",
+  "image/png",
+  "image/jpg",
+  "image/webp"
+]);
 const CreateImageFilePayload = z.object({
   /**
    * The md5 hash of the image file.
    */
-  md5: z.string().nullable(),
+  md5: z.string().optional(),
   /**
    * The height of the image file in pixels.
    */
-  height: z.number().int().nullable(),
+  height: z.number().int().optional(),
   /**
    * The width of the image file in pixels.
    */
-  width: z.number().int().nullable(),
+  width: z.number().int().optional(),
   /**
-   * The mime type of the image file.
+   * The mime type of the image file. Optional if the filename has a known file extension.
    */
-  mime_type: z.enum(["image/jpeg", "image/png", "image/jpg", "image/webp"]),
+  mime_type: acceptedTypes.optional(),
   /**
    * The filename of the image file.
    */
@@ -28,6 +35,19 @@ const CreateImageFilePayload = z.object({
    * The byte size of the image file.
    */
   byte_size: z.number().int().max(MAX_IMAGE_SIZE)
+}).superRefine((data, ctx) => {
+  const mimeType = mime.lookup(data.filename);
+  const parsedMimeType = acceptedTypes.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"]
+    });
+  }
 });
 const createImageFile = async (client, payload) => {
   log("Creating image file", payload);
@@ -44,15 +64,28 @@ const createImageFile = async (client, payload) => {
     `Failed to create file ${response.status} ${response.statusText}`
   );
 };
-const uploadImageFile = (client, uploadDetails, fileStream) => {
+const uploadImageFile = (client, uploadDetails, fileStream, chunkSizeBytes) => {
   log("Uploading image file", uploadDetails.id);
   return uploadChunks(client, {
     url: `/api/v1/image_files/${uploadDetails.id}/upload`,
     fileSize: uploadDetails.byte_size,
     fileStream,
-    maxSize: MAX_IMAGE_SIZE
+    maxSize: MAX_IMAGE_SIZE,
+    chunkSizeBytes
   });
 };
+const getImageFileMetadata = async (client, id) => {
+  const response = await client.authenticatedFetch(
+    `/api/v1/image_files/${id}.json`,
+    {
+      method: "GET"
+    }
+  );
+  if (response.ok) {
+    return await response.json();
+  }
+  return null;
+};
 const lookupImageFileByMd5 = async (client, md5) => {
   const response = await client.authenticatedFetch(
     `/api/v1/image_files/md5/${md5}`,
@@ -74,6 +107,7 @@ const lookupImageFileByMd5 = async (client, md5) => {
 export {
   CreateImageFilePayload,
   createImageFile,
+  getImageFileMetadata,
   lookupImageFileByMd5,
   uploadImageFile
 };

package/dist/resources/renders.d.ts

@@ -53,6 +53,7 @@ export 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>;

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.17",
+  "version": "0.15.0-beta.19",
   "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.17",
+    "@editframe/assets": "0.15.0-beta.19",
     "@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 mime from "mime-types";
 import { z } from "zod";
 
 import type { Client } from "../client.js";
@@ -8,32 +9,57 @@ 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),
-});
+const acceptedTypes = z.enum([
+  "image/jpeg",
+  "image/png",
+  "image/jpg",
+  "image/webp",
+]);
+
+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: acceptedTypes.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 mimeType = mime.lookup(data.filename);
+    const parsedMimeType = acceptedTypes.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>;
 
@@ -57,12 +83,35 @@ export interface CreateImageFileResult {
 }
 
 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 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 +141,7 @@ export const uploadImageFile = (
     byte_size: number;
   },
   fileStream: ReadableStream,
+  chunkSizeBytes?: number,
 ) => {
   log("Uploading image file", uploadDetails.id);
 
@@ -100,9 +150,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/renders.ts

@@ -52,6 +52,7 @@ export interface LookupRenderByMd5Result {
   id: string;
   md5: string | null;
   status: "complete" | "created" | "failed" | "pending" | "rendering" | string;
+  metadata: Record<string, string>;
 }
 
 export const createRender = async (