@editframe/api 0.16.7-beta.0 → 0.17.6-beta.0

package/dist/node.js

@@ -1,11 +1,5 @@
-import { stat } from "node:fs/promises";
-import { basename } from "node:path";
-import mime from "mime";
-import { md5FilePath } from "@editframe/assets";
-import { createImageFile, CreateImageFilePayload } 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 { CreateImageFilePayload, ImageFileMimeTypes, createImageFile, getImageFileMetadata, lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
+import { CreateUnprocessedFilePayload, createUnprocessedFile, lookupUnprocessedFileByMd5, processIsobmffFile, uploadUnprocessedReadableStream } 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";
@@ -15,89 +9,39 @@ import { CreateRenderPayload, OutputConfiguration, RenderOutputConfiguration, cr
 import { CreateTranscriptionPayload, createTranscription, getTranscriptionInfo, getTranscriptionProgress } from "./resources/transcriptions.js";
 import { createURLToken } from "./resources/url-token.js";
 import { Client } from "./client.js";
-const createImageFileFromPath = async (client, path) => {
-  const fileInfo = await stat(path);
-  const byte_size = fileInfo.size;
-  const md5 = await md5FilePath(path);
-  const mime_type = mime.getType(path);
-  return createImageFile(client, {
-    ...CreateImageFilePayload.parse({
-      md5,
-      height: 0,
-      width: 0,
-      mime_type,
-      filename: basename(path),
-      byte_size
-    })
-  });
-};
-const createUnprocessedFileFromPath = async (client, path) => {
-  const fileInfo = await stat(path);
-  const byte_size = fileInfo.size;
-  const md5 = await md5FilePath(path);
-  return createUnprocessedFile(client, {
-    md5,
-    filename: basename(path),
-    byte_size
-  });
+import "./index.js";
+import { stat } from "node:fs/promises";
+import { basename } from "node:path";
+import mime from "mime";
+import { md5FilePath } from "@editframe/assets";
+const createImageFileFromPath = async (client, path$1) => {
+	const fileInfo = await stat(path$1);
+	const byte_size = fileInfo.size;
+	const md5 = await md5FilePath(path$1);
+	const mime_type = mime.getType(path$1);
+	return createImageFile(client, { ...CreateImageFilePayload.parse({
+		md5,
+		height: 0,
+		width: 0,
+		mime_type,
+		filename: basename(path$1),
+		byte_size
+	}) });
 };
-const uploadUnprocessedFile = async (client, uploadDetails, path) => {
-  const { createReadStream } = await import("node:fs");
-  const readStream = createReadStream(path);
-  const { createReadableStreamFromReadable: createReadableStreamFromReadable2 } = await import("./utils/createReadableStreamFromReadable.js");
-  return uploadUnprocessedReadableStream(
-    client,
-    uploadDetails,
-    createReadableStreamFromReadable2(readStream)
-  );
+const createUnprocessedFileFromPath = async (client, path$1) => {
+	const fileInfo = await stat(path$1);
+	const byte_size = fileInfo.size;
+	const md5 = await md5FilePath(path$1);
+	return createUnprocessedFile(client, {
+		md5,
+		filename: basename(path$1),
+		byte_size
+	});
 };
-export {
-  AudioTrackPayload,
-  Client,
-  CreateCaptionFilePayload,
-  CreateISOBMFFFilePayload,
-  CreateISOBMFFTrackPayload,
-  CreateImageFilePayload,
-  CreateRenderPayload,
-  CreateTranscriptionPayload,
-  CreateUnprocessedFilePayload,
-  ImageFileMimeTypes,
-  OutputConfiguration,
-  RenderOutputConfiguration,
-  TranscribeISOBMFFFilePayload,
-  VideoTrackPayload,
-  createCaptionFile,
-  createISOBMFFFile,
-  createISOBMFFTrack,
-  createImageFile,
-  createImageFileFromPath,
-  createReadableStreamFromReadable,
-  createRender,
-  createTranscription,
-  createURLToken,
-  createUnprocessedFile,
-  createUnprocessedFileFromPath,
-  downloadRender,
-  getISOBMFFFileTranscription,
-  getImageFileMetadata,
-  getIsobmffProcessInfo,
-  getIsobmffProcessProgress,
-  getRenderInfo,
-  getRenderProgress,
-  getTranscriptionInfo,
-  getTranscriptionProgress,
-  lookupCaptionFileByMd5,
-  lookupISOBMFFFileByMd5,
-  lookupImageFileByMd5,
-  lookupRenderByMd5,
-  lookupUnprocessedFileByMd5,
-  processIsobmffFile,
-  transcribeISOBMFFFile,
-  uploadCaptionFile,
-  uploadFragmentIndex,
-  uploadISOBMFFTrack,
-  uploadImageFile,
-  uploadRender,
-  uploadUnprocessedFile,
-  uploadUnprocessedReadableStream
+const uploadUnprocessedFile = async (client, uploadDetails, path$1) => {
+	const { createReadStream } = await import("node:fs");
+	const readStream = createReadStream(path$1);
+	const { createReadableStreamFromReadable: createReadableStreamFromReadable$1 } = await import("./utils/createReadableStreamFromReadable.js");
+	return uploadUnprocessedReadableStream(client, uploadDetails, createReadableStreamFromReadable$1(readStream));
 };
+export { AudioTrackPayload, Client, CreateCaptionFilePayload, CreateISOBMFFFilePayload, CreateISOBMFFTrackPayload, CreateImageFilePayload, CreateRenderPayload, CreateTranscriptionPayload, CreateUnprocessedFilePayload, ImageFileMimeTypes, OutputConfiguration, RenderOutputConfiguration, TranscribeISOBMFFFilePayload, VideoTrackPayload, createCaptionFile, createISOBMFFFile, createISOBMFFTrack, createImageFile, createImageFileFromPath, createReadableStreamFromReadable, createRender, createTranscription, createURLToken, createUnprocessedFile, createUnprocessedFileFromPath, downloadRender, getISOBMFFFileTranscription, getImageFileMetadata, getIsobmffProcessInfo, getIsobmffProcessProgress, getRenderInfo, getRenderProgress, getTranscriptionInfo, getTranscriptionProgress, lookupCaptionFileByMd5, lookupISOBMFFFileByMd5, lookupImageFileByMd5, lookupRenderByMd5, lookupUnprocessedFileByMd5, processIsobmffFile, transcribeISOBMFFFile, uploadCaptionFile, uploadFragmentIndex, uploadISOBMFFTrack, uploadImageFile, uploadRender, uploadUnprocessedFile, uploadUnprocessedReadableStream };

package/dist/resources/caption-file.js

@@ -3,82 +3,58 @@ import { z } from "zod";
 const log = debug("ef:api:caption-file");
 const MAX_CAPTION_SIZE = 1024 * 1024 * 2;
 const CreateCaptionFilePayload = z.object({
-  /**
-   * The md5 hash of the caption file
-   */
-  md5: z.string(),
-  /**
-   * The filename of the caption file
-   */
-  filename: z.string(),
-  /**
-   * The size of the caption file in bytes
-   */
-  byte_size: z.number().int().max(MAX_CAPTION_SIZE)
+	md5: z.string(),
+	filename: z.string(),
+	byte_size: z.number().int().max(MAX_CAPTION_SIZE)
 });
 const restrictSize = (size) => {
-  if (size > MAX_CAPTION_SIZE) {
-    throw new Error(
-      `File size ${size} bytes exceeds limit ${MAX_CAPTION_SIZE} bytes
-`
-    );
-  }
+	if (size > MAX_CAPTION_SIZE) throw new Error(`File size ${size} bytes exceeds limit ${MAX_CAPTION_SIZE} bytes\n`);
 };
+/**
+* Create a caption file
+* @param client - The authenticated client to use for the request
+* @param payload -  The payload to send to the server
+* @returns The result of the request
+* @example
+* ```ts
+* const result = await createCaptionFile(client, {
+*  id: "123",
+* filename: "caption.srt",
+* });
+* console.log(result);
+* ```
+* @category CaptionFile
+* @resource
+* @beta
+*/
 const createCaptionFile = async (client, payload) => {
-  log("Creating caption file", payload);
-  restrictSize(payload.byte_size);
-  const response = await client.authenticatedFetch("/api/v1/caption_files", {
-    method: "POST",
-    body: JSON.stringify(payload)
-  });
-  log("Caption file created", response);
-  if (response.ok) {
-    return await response.json();
-  }
-  throw new Error(
-    `Failed to create caption ${response.status} ${response.statusText}`
-  );
+	log("Creating caption file", payload);
+	restrictSize(payload.byte_size);
+	const response = await client.authenticatedFetch("/api/v1/caption_files", {
+		method: "POST",
+		body: JSON.stringify(payload)
+	});
+	log("Caption file created", response);
+	if (response.ok) return await response.json();
+	throw new Error(`Failed to create caption ${response.status} ${response.statusText}`);
 };
 const uploadCaptionFile = async (client, fileId, fileStream, fileSize) => {
-  log("Uploading caption file", fileId);
-  restrictSize(fileSize);
-  const response = await client.authenticatedFetch(
-    `/api/v1/caption_files/${fileId}/upload`,
-    {
-      method: "POST",
-      body: fileStream,
-      duplex: "half"
-    }
-  );
-  log("Caption file uploaded", response);
-  if (response.ok) {
-    return response.json();
-  }
-  throw new Error(
-    `Failed to upload caption ${response.status} ${response.statusText}`
-  );
+	log("Uploading caption file", fileId);
+	restrictSize(fileSize);
+	const response = await client.authenticatedFetch(`/api/v1/caption_files/${fileId}/upload`, {
+		method: "POST",
+		body: fileStream,
+		duplex: "half"
+	});
+	log("Caption file uploaded", response);
+	if (response.ok) return response.json();
+	throw new Error(`Failed to upload caption ${response.status} ${response.statusText}`);
 };
 const lookupCaptionFileByMd5 = async (client, md5) => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/caption_files/md5/${md5}`,
-    {
-      method: "GET"
-    }
-  );
-  log("Caption file lookup", response);
-  if (response.ok) {
-    return await response.json();
-  }
-  if (response.status === 404) {
-    return null;
-  }
-  throw new Error(
-    `Failed to lookup caption by md5 ${md5} ${response.status} ${response.statusText}`
-  );
-};
-export {
-  CreateCaptionFilePayload,
-  createCaptionFile,
-  lookupCaptionFileByMd5,
-  uploadCaptionFile
+	const response = await client.authenticatedFetch(`/api/v1/caption_files/md5/${md5}`, { method: "GET" });
+	log("Caption file lookup", response);
+	if (response.ok) return await response.json();
+	if (response.status === 404) return null;
+	throw new Error(`Failed to lookup caption by md5 ${md5} ${response.status} ${response.statusText}`);
 };
+export { CreateCaptionFilePayload, createCaptionFile, lookupCaptionFileByMd5, uploadCaptionFile };

package/dist/resources/image-file.js

@@ -1,119 +1,68 @@
+import { uploadChunks } from "../uploadChunks.js";
 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"
+	"image/jpeg",
+	"image/png",
+	"image/jpg",
+	"image/webp"
 ]);
 function getFileExtension(path) {
-  const match = path.match(/\.([^.]+)$/);
-  return match ? match[1] : null;
+	const match = path.match(/\.([^.]+)$/);
+	return match ? match[1] : null;
 }
 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)
+	md5: z.string().optional(),
+	height: z.number().int().optional(),
+	width: z.number().int().optional(),
+	mime_type: ImageFileMimeTypes.optional(),
+	filename: z.string(),
+	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 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);
-  CreateImageFilePayload.parse(payload);
-  const response = await client.authenticatedFetch("/api/v1/image_files", {
-    method: "POST",
-    body: JSON.stringify(payload)
-  });
-  log("Image file created", response);
-  if (response.ok) {
-    return await response.json();
-  }
-  throw new Error(
-    `Failed to create file ${response.status} ${response.statusText}`
-  );
+	log("Creating image file", payload);
+	CreateImageFilePayload.parse(payload);
+	const response = await client.authenticatedFetch("/api/v1/image_files", {
+		method: "POST",
+		body: JSON.stringify(payload)
+	});
+	log("Image file created", response);
+	if (response.ok) return await response.json();
+	throw new Error(`Failed to create file ${response.status} ${response.statusText}`);
 };
 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,
-    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,
+		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 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}`,
-    {
-      method: "GET"
-    }
-  );
-  log("Image file lookup", response);
-  if (response.ok) {
-    return await response.json();
-  }
-  if (response.status === 404) {
-    return null;
-  }
-  throw new Error(
-    `Failed to lookup image by md5 ${md5} ${response.status} ${response.statusText}`
-  );
-};
-export {
-  CreateImageFilePayload,
-  ImageFileMimeTypes,
-  createImageFile,
-  getImageFileMetadata,
-  lookupImageFileByMd5,
-  uploadImageFile
+	const response = await client.authenticatedFetch(`/api/v1/image_files/md5/${md5}`, { method: "GET" });
+	log("Image file lookup", response);
+	if (response.ok) return await response.json();
+	if (response.status === 404) return null;
+	throw new Error(`Failed to lookup image by md5 ${md5} ${response.status} ${response.statusText}`);
 };
+export { CreateImageFilePayload, ImageFileMimeTypes, createImageFile, getImageFileMetadata, lookupImageFileByMd5, uploadImageFile };

package/dist/resources/isobmff-file.js

@@ -3,100 +3,51 @@ import { z } from "zod";
 const log = debug("ef:api:isobmff-file");
 const FILE_SIZE_LIMIT = 1024 * 1024 * 2;
 const CreateISOBMFFFilePayload = z.object({
-  md5: z.string(),
-  filename: z.string()
+	md5: z.string(),
+	filename: z.string()
 });
 const createISOBMFFFile = async (client, payload) => {
-  log("Creating isobmff file", payload);
-  const response = await client.authenticatedFetch("/api/v1/isobmff_files", {
-    method: "POST",
-    body: JSON.stringify(payload)
-  });
-  log("ISOBMFF file created", response);
-  if (response.ok) {
-    return await response.json();
-  }
-  throw new Error(
-    `Failed to create isobmff file ${response.status} ${response.statusText}`
-  );
+	log("Creating isobmff file", payload);
+	const response = await client.authenticatedFetch("/api/v1/isobmff_files", {
+		method: "POST",
+		body: JSON.stringify(payload)
+	});
+	log("ISOBMFF file created", response);
+	if (response.ok) return await response.json();
+	throw new Error(`Failed to create isobmff file ${response.status} ${response.statusText}`);
 };
 const uploadFragmentIndex = async (client, fileId, fileStream, fileSize) => {
-  log("Uploading fragment index", fileId);
-  if (fileSize > FILE_SIZE_LIMIT) {
-    throw new Error(`File size exceeds limit of ${FILE_SIZE_LIMIT} bytes`);
-  }
-  const response = await client.authenticatedFetch(
-    `/api/v1/isobmff_files/${fileId}/index/upload`,
-    {
-      method: "POST",
-      body: fileStream,
-      duplex: "half"
-    }
-  );
-  log("Fragment index uploaded", response);
-  if (response.ok) {
-    return response.json();
-  }
-  throw new Error(
-    `Failed to create fragment index ${response.status} ${response.statusText}`
-  );
+	log("Uploading fragment index", fileId);
+	if (fileSize > FILE_SIZE_LIMIT) throw new Error(`File size exceeds limit of ${FILE_SIZE_LIMIT} bytes`);
+	const response = await client.authenticatedFetch(`/api/v1/isobmff_files/${fileId}/index/upload`, {
+		method: "POST",
+		body: fileStream,
+		duplex: "half"
+	});
+	log("Fragment index uploaded", response);
+	if (response.ok) return response.json();
+	throw new Error(`Failed to create fragment index ${response.status} ${response.statusText}`);
 };
 const lookupISOBMFFFileByMd5 = async (client, md5) => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/isobmff_files/md5/${md5}`,
-    {
-      method: "GET"
-    }
-  );
-  log("ISOBMFF file lookup", response);
-  if (response.ok) {
-    return await response.json();
-  }
-  if (response.status === 404) {
-    return null;
-  }
-  throw new Error(
-    `Failed to lookup isobmff file by md5 ${md5} ${response.status} ${response.statusText}`
-  );
+	const response = await client.authenticatedFetch(`/api/v1/isobmff_files/md5/${md5}`, { method: "GET" });
+	log("ISOBMFF file lookup", response);
+	if (response.ok) return await response.json();
+	if (response.status === 404) return null;
+	throw new Error(`Failed to lookup isobmff file by md5 ${md5} ${response.status} ${response.statusText}`);
 };
 const getISOBMFFFileTranscription = async (client, id) => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/isobmff_files/${id}/transcription`
-  );
-  if (response.ok) {
-    return await response.json();
-  }
-  if (response.status === 404) {
-    return null;
-  }
-  throw new Error(
-    `Failed to get isobmff file transcription ${id} ${response.status} ${response.statusText}`
-  );
+	const response = await client.authenticatedFetch(`/api/v1/isobmff_files/${id}/transcription`);
+	if (response.ok) return await response.json();
+	if (response.status === 404) return null;
+	throw new Error(`Failed to get isobmff file transcription ${id} ${response.status} ${response.statusText}`);
 };
-const TranscribeISOBMFFFilePayload = z.object({
-  trackId: z.string().optional()
-});
+const TranscribeISOBMFFFilePayload = z.object({ trackId: z.string().optional() });
 const transcribeISOBMFFFile = async (client, id, payload = {}) => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/isobmff_files/${id}/transcribe`,
-    {
-      method: "POST",
-      body: JSON.stringify(payload)
-    }
-  );
-  if (response.ok) {
-    return await response.json();
-  }
-  throw new Error(
-    `Failed to transcribe isobmff file ${id} ${response.status} ${response.statusText}`
-  );
-};
-export {
-  CreateISOBMFFFilePayload,
-  TranscribeISOBMFFFilePayload,
-  createISOBMFFFile,
-  getISOBMFFFileTranscription,
-  lookupISOBMFFFileByMd5,
-  transcribeISOBMFFFile,
-  uploadFragmentIndex
+	const response = await client.authenticatedFetch(`/api/v1/isobmff_files/${id}/transcribe`, {
+		method: "POST",
+		body: JSON.stringify(payload)
+	});
+	if (response.ok) return await response.json();
+	throw new Error(`Failed to transcribe isobmff file ${id} ${response.status} ${response.statusText}`);
 };
+export { CreateISOBMFFFilePayload, TranscribeISOBMFFFilePayload, createISOBMFFFile, getISOBMFFFileTranscription, lookupISOBMFFFileByMd5, transcribeISOBMFFFile, uploadFragmentIndex };