@editframe/api 0.14.0-beta.2 → 0.15.0-beta.1

package/dist/ProgressIterator.js

@@ -41,8 +41,8 @@ class BaseEventIterator {
           if (!item) {
             throw new Error("Queue is corrupted");
           }
-          yield item;
           this.index++;
+          yield item;
         }
       }
     } finally {
@@ -94,6 +94,9 @@ class CompletionIterator extends BaseEventIterator {
           progress: this.currentProgress / this.totalSize
         }
       });
+      if (this.currentProgress >= this.totalSize) {
+        this.isComplete = true;
+      }
     });
     this.eventSource.on("complete", (event) => {
       this.isComplete = true;

package/dist/StreamEventSource.d.ts

@@ -4,6 +4,7 @@ export type StreamEventSourceEventMap = {
     complete: CompleteEvent;
     size: SizeEvent;
     completion: CompletionEvent;
+    heartbeat: HeartbeatEvent;
     message: {
         id: string | undefined;
         data: string;
@@ -36,6 +37,12 @@ export type CompletionEvent = {
         count: number;
     };
 };
+export type HeartbeatEvent = {
+    type: "heartbeat";
+    data: {
+        timestamp: string;
+    };
+};
 export declare class StreamEventSource {
     private stream;
     private activeReader;

package/dist/StreamEventSource.js

@@ -19,6 +19,12 @@ class StreamEventSource {
       onEvent: (event) => {
         if (event.event) {
           switch (event.event) {
+            case "heartbeat":
+              this.emit("heartbeat", {
+                type: "heartbeat",
+                data: JSON.parse(event.data)
+              });
+              break;
             case "size":
               this.emit("size", {
                 type: "size",

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { createCaptionFile, CreateCaptionFilePayload, type CreateCaptionFileResu
 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, } from './resources/renders.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';

package/dist/index.js

@@ -2,7 +2,7 @@ import { CreateCaptionFilePayload, createCaptionFile, lookupCaptionFileByMd5, up
 import { CreateImageFilePayload, createImageFile, 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, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender } from "./resources/renders.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";
@@ -28,6 +28,7 @@ export {
   createTranscription,
   createURLToken,
   createUnprocessedFile,
+  downloadRender,
   getISOBMFFFileTranscription,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,

package/dist/node.js

@@ -10,7 +10,7 @@ import { createReadableStreamFromReadable } from "./utils/createReadableStreamFr
 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 { CreateRenderPayload, createRender, getRenderInfo, getRenderProgress, lookupRenderByMd5, uploadRender } from "./resources/renders.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";
@@ -74,6 +74,7 @@ export {
   createURLToken,
   createUnprocessedFile,
   createUnprocessedFileFromPath,
+  downloadRender,
   getISOBMFFFileTranscription,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,

package/dist/resources/renders.d.ts

@@ -50,3 +50,4 @@ export declare const uploadRender: (client: Client, renderId: string, fileStream
 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>;

package/dist/resources/renders.js

@@ -71,9 +71,19 @@ const getRenderProgress = async (client, id) => {
   );
   return new CompletionIterator(eventSource);
 };
+const downloadRender = async (client, id) => {
+  const response = await client.authenticatedFetch(`/api/v1/renders/${id}.mp4`);
+  if (response.ok) {
+    return response;
+  }
+  throw new Error(
+    `Failed to download render ${id} ${response.status} ${response.statusText}`
+  );
+};
 export {
   CreateRenderPayload,
   createRender,
+  downloadRender,
   getRenderInfo,
   getRenderProgress,
   lookupRenderByMd5,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/api",
-  "version": "0.14.0-beta.2",
+  "version": "0.15.0-beta.1",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
@@ -39,7 +39,7 @@
     "vite-plugin-dts": "^4.0.3"
   },
   "dependencies": {
-    "@editframe/assets": "0.14.0-beta.2",
+    "@editframe/assets": "0.15.0-beta.1",
     "@vitejs/plugin-react": "^4.3.4",
     "vite-tsconfig-paths": "^4.3.2",
     "vite": "^5.4.11",

package/src/resources/renders.ts

@@ -134,3 +134,15 @@ export const getRenderProgress = async (client: Client, id: string) => {
 
   return new CompletionIterator(eventSource);
 };
+
+export const downloadRender = async (client: Client, id: string) => {
+  const response = await client.authenticatedFetch(`/api/v1/renders/${id}.mp4`);
+
+  if (response.ok) {
+    return response;
+  }
+
+  throw new Error(
+    `Failed to download render ${id} ${response.status} ${response.statusText}`,
+  );
+};