@editframe/api 0.15.0-beta.8 → 0.16.0-beta.0

package/dist/ProgressIterator.d.ts

@@ -21,5 +21,6 @@ export declare class CompletionIterator extends BaseEventIterator<CompleteEvent
     private currentProgress;
     constructor(eventSource: StreamEventSource);
     private initializeListeners;
+    abort(): void;
 }
 export {};

package/dist/ProgressIterator.js

@@ -107,6 +107,9 @@ class CompletionIterator extends BaseEventIterator {
       this.resolversNext.reject(error);
     });
   }
+  abort() {
+    this.eventSource.abort();
+  }
 }
 export {
   CompletionIterator,

package/dist/StreamEventSource.d.ts

@@ -49,11 +49,13 @@ export declare class StreamEventSource {
     private decoder;
     private parser;
     private listeners;
-    constructor(stream: ReadableStream);
+    private abortController;
+    constructor(stream: ReadableStream, abortController: AbortController);
     on<K extends keyof StreamEventSourceEventMap>(event: K, callback: EventCallback<StreamEventSourceEventMap[K]>): this;
     off<K extends keyof StreamEventSourceEventMap>(event: K, callback: EventCallback<StreamEventSourceEventMap[K]>): this;
     protected emit<K extends keyof StreamEventSourceEventMap>(event: K, data: StreamEventSourceEventMap[K]): void;
     whenClosed(): Promise<void>;
     private startReading;
     close(): void;
+    abort(): void;
 }

package/dist/StreamEventSource.js

@@ -2,7 +2,7 @@ import debug from "debug";
 import { createParser } from "eventsource-parser";
 const log = debug("ef:StreamEventSource");
 class StreamEventSource {
-  constructor(stream) {
+  constructor(stream, abortController) {
     this.activeReader = null;
     this.decoder = new TextDecoder();
     this.listeners = {};
@@ -11,6 +11,7 @@ class StreamEventSource {
       throw new Error("Stream is required");
     }
     this.stream = stream;
+    this.abortController = abortController;
     this.parser = createParser({
       onError: (err) => {
         console.error("StreamEventSource: Parser error:", err);
@@ -71,6 +72,9 @@ class StreamEventSource {
       console.error("StreamEventSource: Error in startReading:", error);
       this.emit("error", error);
     });
+    this.abortController.signal.addEventListener("abort", () => {
+      this.close();
+    });
   }
   on(event, callback) {
     if (!this.listeners[event]) {
@@ -128,6 +132,9 @@ class StreamEventSource {
     }
     this.parser.reset();
   }
+  abort() {
+    this.abortController.abort();
+  }
 }
 export {
   StreamEventSource

package/dist/client.js

@@ -4,11 +4,15 @@ const log = debug("ef:api:client");
 class Client {
   constructor(token, efHost = "https://editframe.dev") {
     this.authenticatedEventSource = async (path, init = {}) => {
-      const response = await this.authenticatedFetch(path, init);
+      const abortController = new AbortController();
+      const response = await this.authenticatedFetch(path, {
+        ...init,
+        signal: abortController.signal
+      });
       if (response.body === null) {
         throw new Error("Could not create event source. Response body is null.");
       }
-      return new StreamEventSource(response.body);
+      return new StreamEventSource(response.body, abortController);
     };
     this.authenticatedFetch = async (path, init = {}) => {
       init.headers ||= {};

package/dist/index.d.ts

@@ -1,13 +1,13 @@
-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 { 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';
-export { createTranscription, CreateTranscriptionPayload, type CreateTranscriptionResult, getTranscriptionInfo, getTranscriptionProgress, type TranscriptionInfoResult, } from './resources/transcriptions.js';
-export { createURLToken, type URLTokenResult, } from './resources/url-token.js';
-export { createUnprocessedFile, CreateUnprocessedFilePayload, type CreateUnprocessedFileResult, uploadUnprocessedReadableStream, type LookupUnprocessedFileByMd5Result, lookupUnprocessedFileByMd5, processIsobmffFile, type ProcessIsobmffFileResult, type UnprocessedFileUploadDetails, type UnprocessedFile, } from './resources/unprocessed-file.js';
+export { createCaptionFile, CreateCaptionFilePayload, lookupCaptionFileByMd5, uploadCaptionFile, type CreateCaptionFileResult, type LookupCaptionFileByMd5Result, } from './resources/caption-file.js';
+export { createImageFile, CreateImageFilePayload, getImageFileMetadata, ImageFileMimeTypes, lookupImageFileByMd5, uploadImageFile, type CreateImageFileResult, type GetImageFileMetadataResult, type LookupImageFileByMd5Result, } from './resources/image-file.js';
+export { createISOBMFFFile, CreateISOBMFFFilePayload, getISOBMFFFileTranscription, lookupISOBMFFFileByMd5, transcribeISOBMFFFile, TranscribeISOBMFFFilePayload, uploadFragmentIndex, type CreateISOBMFFFileResult, type GetISOBMFFFileTranscriptionResult, type LookupISOBMFFFileByMd5Result, type TranscribeISOBMFFFileResult, } from './resources/isobmff-file.js';
+export { AudioTrackPayload, createISOBMFFTrack, CreateISOBMFFTrackPayload, uploadISOBMFFTrack, VideoTrackPayload, type AudioStreamSchema, type CreateISOBMFFTrackResult, type VideoStreamSchema, } from './resources/isobmff-track.js';
 export { getIsobmffProcessInfo, getIsobmffProcessProgress, type IsobmffProcessInfoResult, } from './resources/process-isobmff.js';
+export { createRender, CreateRenderPayload, downloadRender, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender, type CreateRenderResult, type LookupRenderByMd5Result, } from './resources/renders.js';
+export { createTranscription, CreateTranscriptionPayload, getTranscriptionInfo, getTranscriptionProgress, type CreateTranscriptionResult, type TranscriptionInfoResult, } from './resources/transcriptions.js';
+export { createUnprocessedFile, CreateUnprocessedFilePayload, lookupUnprocessedFileByMd5, processIsobmffFile, uploadUnprocessedReadableStream, type CreateUnprocessedFileResult, type LookupUnprocessedFileByMd5Result, type ProcessIsobmffFileResult, type UnprocessedFile, type UnprocessedFileUploadDetails, } from './resources/unprocessed-file.js';
+export { createURLToken, type URLTokenResult, } from './resources/url-token.js';
 export { Client } from './client.js';
+export type { CompletionIterator, ProgressIterator, } from './ProgressIterator.js';
 export type { IteratorWithPromise, UploadChunkEvent } from './uploadChunks.js';
-export type { ProgressIterator, CompletionIterator, } from './ProgressIterator.js';
-export type { StreamEventSource, ProgressEvent, CompletionEvent, StreamEventSourceEventMap, EventCallback, } from './StreamEventSource.js';
+export type { CompletionEvent, EventCallback, ProgressEvent, StreamEventSource, StreamEventSourceEventMap, } from './StreamEventSource.js';

package/dist/index.js

@@ -1,12 +1,12 @@
 import { CreateCaptionFilePayload, createCaptionFile, lookupCaptionFileByMd5, uploadCaptionFile } from "./resources/caption-file.js";
-import { CreateImageFilePayload, createImageFile, lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
+import { CreateImageFilePayload, ImageFileMimeTypes, 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 { getIsobmffProcessInfo, getIsobmffProcessProgress } from "./resources/process-isobmff.js";
 import { CreateRenderPayload, createRender, downloadRender, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender } from "./resources/renders.js";
 import { CreateTranscriptionPayload, createTranscription, getTranscriptionInfo, getTranscriptionProgress } from "./resources/transcriptions.js";
-import { createURLToken } from "./resources/url-token.js";
 import { CreateUnprocessedFilePayload, createUnprocessedFile, lookupUnprocessedFileByMd5, processIsobmffFile, uploadUnprocessedReadableStream } from "./resources/unprocessed-file.js";
-import { getIsobmffProcessInfo, getIsobmffProcessProgress } from "./resources/process-isobmff.js";
+import { createURLToken } from "./resources/url-token.js";
 import { Client } from "./client.js";
 export {
   AudioTrackPayload,
@@ -18,6 +18,7 @@ export {
   CreateRenderPayload,
   CreateTranscriptionPayload,
   CreateUnprocessedFilePayload,
+  ImageFileMimeTypes,
   TranscribeISOBMFFFilePayload,
   VideoTrackPayload,
   createCaptionFile,
@@ -30,6 +31,7 @@ export {
   createUnprocessedFile,
   downloadRender,
   getISOBMFFFileTranscription,
+  getImageFileMetadata,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,
   getRenderInfo,

package/dist/node.js

@@ -3,17 +3,17 @@ 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 { ImageFileMimeTypes, 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";
 import { CreateCaptionFilePayload, createCaptionFile, lookupCaptionFileByMd5, uploadCaptionFile } from "./resources/caption-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 { getIsobmffProcessInfo, getIsobmffProcessProgress } from "./resources/process-isobmff.js";
 import { CreateRenderPayload, createRender, downloadRender, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender } from "./resources/renders.js";
 import { CreateTranscriptionPayload, createTranscription, getTranscriptionInfo, getTranscriptionProgress } from "./resources/transcriptions.js";
 import { createURLToken } from "./resources/url-token.js";
-import { getIsobmffProcessInfo, getIsobmffProcessProgress } from "./resources/process-isobmff.js";
 import { Client } from "./client.js";
 const createImageFileFromPath = async (client, path) => {
   const fileInfo = await stat(path);
@@ -61,6 +61,7 @@ export {
   CreateRenderPayload,
   CreateTranscriptionPayload,
   CreateUnprocessedFilePayload,
+  ImageFileMimeTypes,
   TranscribeISOBMFFFilePayload,
   VideoTrackPayload,
   createCaptionFile,
@@ -76,6 +77,7 @@ export {
   createUnprocessedFileFromPath,
   downloadRender,
   getISOBMFFFileTranscription,
+  getImageFileMetadata,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,
   getRenderInfo,

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

@@ -1,22 +1,23 @@
 import { z } from 'zod';
 import { Client } from '../client.js';
-export declare const CreateImageFilePayload: z.ZodObject<{
+export declare const ImageFileMimeTypes: z.ZodEnum<["image/jpeg", "image/png", "image/jpg", "image/webp"]>;
+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 +27,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 {
@@ -57,17 +72,40 @@ 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 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,36 @@
 import debug from "debug";
+import { types } 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 ImageFileMimeTypes = z.enum([
+  "image/jpeg",
+  "image/png",
+  "image/jpg",
+  "image/webp"
+]);
+function getFileExtension(path) {
+  const match = path.match(/\.([^.]+)$/);
+  return match ? match[1] : null;
+}
 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: ImageFileMimeTypes.optional(),
   /**
    * The filename of the image file.
    */
@@ -28,6 +39,20 @@ const CreateImageFilePayload = z.object({
    * 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"]
+    });
+  }
 });
 const createImageFile = async (client, payload) => {
   log("Creating image file", payload);
@@ -44,15 +69,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}`,
@@ -73,7 +111,9 @@ const lookupImageFileByMd5 = async (client, md5) => {
 };
 export {
   CreateImageFilePayload,
+  ImageFileMimeTypes,
   createImageFile,
+  getImageFileMetadata,
   lookupImageFileByMd5,
   uploadImageFile
 };