@editframe/api 0.14.0-beta.3 → 0.15.0-beta.10

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/image-file.d.ts

@@ -4,15 +4,15 @@ export declare const CreateImageFilePayload: z.ZodObject<{
     /**
      * The md5 hash of the image file.
      */
-    md5: z.ZodString;
+    md5: z.ZodNullable<z.ZodString>;
     /**
      * The height of the image file in pixels.
      */
-    height: z.ZodNumber;
+    height: z.ZodNullable<z.ZodNumber>;
     /**
      * The width of the image file in pixels.
      */
-    width: z.ZodNumber;
+    width: z.ZodNullable<z.ZodNumber>;
     /**
      * The mime type of the image file.
      */
@@ -26,25 +26,37 @@ export declare const CreateImageFilePayload: z.ZodObject<{
      */
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    width: number;
-    height: number;
+    width: number | null;
+    height: number | null;
     filename: string;
-    md5: string;
+    md5: string | null;
     mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
 }, {
-    width: number;
-    height: number;
+    width: number | null;
+    height: number | null;
     filename: string;
-    md5: string;
+    md5: string | null;
     mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
 }>;
 export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 export interface CreateImageFileResult {
+    /**
+     * 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;
+    /**
+     * The md5 hash of the image file.
+     */
     md5: string;
 }
 export interface LookupImageFileByMd5Result {

package/dist/resources/image-file.js

@@ -7,15 +7,15 @@ const CreateImageFilePayload = z.object({
   /**
    * The md5 hash of the image file.
    */
-  md5: z.string(),
+  md5: z.string().nullable(),
   /**
    * The height of the image file in pixels.
    */
-  height: z.number().int(),
+  height: z.number().int().nullable(),
   /**
    * The width of the image file in pixels.
    */
-  width: z.number().int(),
+  width: z.number().int().nullable(),
   /**
    * The mime type of the image file.
    */

package/dist/resources/renders.bundle.js

@@ -1,15 +1,14 @@
 import path from "node:path";
 import { PassThrough } from "node:stream";
 import react from "@vitejs/plugin-react";
+import * as tar from "tar";
 import { build } from "vite";
 import { viteSingleFile } from "vite-plugin-singlefile";
-import tsconfigPaths from "vite-tsconfig-paths";
-import * as tar from "tar";
+import tsconfigPathsPlugin from "vite-tsconfig-paths";
 import { randomUUID } from "node:crypto";
 import { createReadableStreamFromReadable } from "../utils/createReadableStreamFromReadable.js";
 const bundleRender = async (options) => {
   const outDir = path.join(process.cwd(), "renders", randomUUID());
-  console.log("outDir", outDir);
   await build({
     root: options.root,
     define: {
@@ -22,7 +21,7 @@ const bundleRender = async (options) => {
       }
     },
     plugins: [
-      tsconfigPaths(),
+      tsconfigPathsPlugin(),
       react({
         include: "**/*.{jsx,js,tsx,ts}",
         jsxRuntime: "automatic"
@@ -37,7 +36,6 @@ const bundleRender = async (options) => {
     },
     ["."]
   );
-  console.log("outDir", outDir);
   const passthrough = new PassThrough();
   tarStream.pipe(passthrough);
   const tarReadStream = createReadableStreamFromReadable(passthrough);

package/dist/resources/renders.d.ts

@@ -7,6 +7,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     width: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
     work_slice_ms: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    html: z.ZodOptional<z.ZodString>;
     duration_ms: z.ZodOptional<z.ZodNumber>;
     strategy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["v1"]>>>;
 }, "strip", z.ZodTypeAny, {
@@ -17,6 +18,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     duration_ms?: number | undefined;
     fps?: number | undefined;
     work_slice_ms?: number | undefined;
+    html?: string | undefined;
 }, {
     width?: number | undefined;
     height?: number | undefined;
@@ -25,6 +27,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     duration_ms?: number | undefined;
     fps?: number | undefined;
     work_slice_ms?: number | undefined;
+    html?: string | undefined;
 }>;
 export interface CreateRenderPayload {
     md5?: string;
@@ -32,6 +35,7 @@ export interface CreateRenderPayload {
     width?: number;
     height?: number;
     work_slice_ms?: number;
+    html?: string;
     duration_ms?: number;
     strategy?: "v1";
 }
@@ -50,3 +54,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

@@ -8,6 +8,7 @@ const CreateRenderPayload = z.object({
   width: z.number().int().min(2).optional(),
   height: z.number().int().min(2).optional(),
   work_slice_ms: z.number().int().min(1e3).max(1e4).default(4e3).optional(),
+  html: z.string().optional(),
   duration_ms: z.number().int().optional(),
   strategy: z.enum(["v1"]).default("v1").optional()
 });
@@ -71,9 +72,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.3",
+  "version": "0.15.0-beta.10",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
@@ -20,6 +20,11 @@
         "types": "./dist/resources/renders.bundle.d.ts",
         "default": "./dist/resources/renders.bundle.js"
       }
+    },
+    "./types.json": {
+      "import": {
+        "default": "./types.json"
+      }
     }
   },
   "type": "module",
@@ -27,7 +32,7 @@
     "typecheck": "tsc --noEmit --emitDeclarationOnly false",
     "build": "vite build",
     "build:watch": "vite build --watch",
-    "typedoc": "typedoc --json ../../docs/api.json --plugin typedoc-plugin-zod --excludeExternals ./src"
+    "typedoc": "typedoc --json ./types.json --plugin typedoc-plugin-zod --excludeExternals ./src && jq -c . ./types.json > ./types.tmp.json && mv ./types.tmp.json ./types.json"
   },
   "author": "",
   "license": "UNLICENSED",
@@ -39,7 +44,7 @@
     "vite-plugin-dts": "^4.0.3"
   },
   "dependencies": {
-    "@editframe/assets": "0.14.0-beta.3",
+    "@editframe/assets": "0.15.0-beta.10",
     "@vitejs/plugin-react": "^4.3.4",
     "vite-tsconfig-paths": "^4.3.2",
     "vite": "^5.4.11",

package/src/resources/image-file.ts

@@ -12,15 +12,15 @@ export const CreateImageFilePayload = z.object({
   /**
    * The md5 hash of the image file.
    */
-  md5: z.string(),
+  md5: z.string().nullable(),
   /**
    * The height of the image file in pixels.
    */
-  height: z.number().int(),
+  height: z.number().int().nullable(),
   /**
    * The width of the image file in pixels.
    */
-  width: z.number().int(),
+  width: z.number().int().nullable(),
   /**
    * The mime type of the image file.
    */
@@ -38,9 +38,21 @@ export const CreateImageFilePayload = z.object({
 export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 
 export interface CreateImageFileResult {
+  /**
+   * 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;
+  /**
+   * The md5 hash of the image file.
+   */
   md5: string;
 }
 

package/src/resources/renders.bundle.ts

@@ -2,11 +2,10 @@ import path from "node:path";
 import { PassThrough } from "node:stream";
 
 import react from "@vitejs/plugin-react";
+import * as tar from "tar";
 import { build } from "vite";
 import { viteSingleFile } from "vite-plugin-singlefile";
-import tsconfigPaths from "vite-tsconfig-paths";
-
-import * as tar from "tar";
+import tsconfigPathsPlugin from "vite-tsconfig-paths";
 
 import { randomUUID } from "node:crypto";
 import { createReadableStreamFromReadable } from "../utils/createReadableStreamFromReadable.ts";
@@ -19,8 +18,6 @@ interface BundlerOptions {
 export const bundleRender = async (options: BundlerOptions) => {
   const outDir = path.join(process.cwd(), "renders", randomUUID());
 
-  console.log("outDir", outDir);
-
   await build({
     root: options.root,
     define: {
@@ -33,7 +30,7 @@ export const bundleRender = async (options: BundlerOptions) => {
       },
     },
     plugins: [
-      tsconfigPaths(),
+      tsconfigPathsPlugin(),
       react({
         include: "**/*.{jsx,js,tsx,ts}",
         jsxRuntime: "automatic",
@@ -50,8 +47,6 @@ export const bundleRender = async (options: BundlerOptions) => {
     ["."],
   );
 
-  console.log("outDir", outDir);
-
   const passthrough = new PassThrough();
   tarStream.pipe(passthrough);
   const tarReadStream = createReadableStreamFromReadable(passthrough);

package/src/resources/renders.ts

@@ -19,6 +19,7 @@ export const CreateRenderPayload = z.object({
     .max(10_000)
     .default(4_000)
     .optional(),
+  html: z.string().optional(),
   duration_ms: z.number().int().optional(),
   strategy: z.enum(["v1"]).default("v1").optional(),
 });
@@ -29,6 +30,7 @@ export interface CreateRenderPayload {
   width?: number;
   height?: number;
   work_slice_ms?: number;
+  html?: string;
   duration_ms?: number;
   strategy?: "v1";
 }
@@ -134,3 +136,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}`,
+  );
+};