@editframe/api 0.7.0-beta.8 → 0.8.0-beta.1

package/dist/resources/unprocessed-file.js

@@ -0,0 +1,142 @@
+import { Readable } from "node:stream";
+import { basename } from "node:path";
+import { createReadStream } from "node:fs";
+import { z } from "zod";
+import debug from "debug";
+import { md5Buffer, md5FilePath } from "@editframe/assets";
+const log = debug("ef:api:unprocessed-file");
+const FileProcessors = z.array(z.union([z.literal("isobmff"), z.literal("captions")])).refine(
+  (value) => {
+    return new Set(value).size === value.length;
+  },
+  {
+    message: "Processors list must not include duplicates"
+  }
+);
+const CreateUnprocessedFilePayload = z.object({
+  id: z.string(),
+  filename: z.string(),
+  processes: FileProcessors.optional()
+});
+const UpdateUnprocessedFilePayload = z.object({
+  processes: FileProcessors.optional()
+});
+const createUnprocessedFile = async (client, payload) => {
+  log("Creating an unprocessed file", payload);
+  const response = await client.authenticatedFetch(
+    "/api/v1/unprocessed_files",
+    {
+      method: "POST",
+      body: JSON.stringify(payload)
+    }
+  );
+  log(
+    "Unprocessed file created",
+    response.status,
+    response.statusText,
+    response.headers
+  );
+  switch (response.status) {
+    case 200: {
+      return await response.json();
+    }
+    default: {
+      console.error(
+        `Failed to create file ${response.status} ${response.statusText}`
+      );
+      console.error(await response.text());
+      throw new Error("Failed to create unprocessed file");
+    }
+  }
+};
+const updateUnprocessedFile = async (client, fileId, payload) => {
+  log("Updating unprocessed file", fileId, payload);
+  const response = await client.authenticatedFetch(
+    `/api/v1/unprocessed_files/${fileId}`,
+    {
+      method: "POST",
+      body: JSON.stringify(payload)
+    }
+  );
+  log("Unprocessed file updated", response);
+  switch (response.status) {
+    case 200: {
+      return await response.json();
+    }
+    default: {
+      console.error(
+        `Failed to update file ${response.status} ${response.statusText}`
+      );
+      throw new Error("Failed to update unprocessed file");
+    }
+  }
+};
+const uploadUnprocessedFile = async (client, fileId, fileStream) => {
+  log("Uploading unprocessed file", fileId);
+  const unprocessedFile = await client.authenticatedFetch(
+    `/api/v1/unprocessed_files/${fileId}/upload`,
+    {
+      method: "POST",
+      body: fileStream
+    }
+  );
+  log("Unprocessed file track uploaded", unprocessedFile);
+  switch (unprocessedFile.status) {
+    case 200: {
+      return unprocessedFile.json();
+    }
+    default: {
+      console.error("Failed to upload unprocessed file");
+      console.error(unprocessedFile.status, unprocessedFile.statusText);
+      throw new Error("Failed to upload unprocessed file");
+    }
+  }
+};
+const processAVFileBuffer = async (client, buffer, filename = "buffer") => {
+  log("Processing AV file buffer");
+  const fileId = md5Buffer(buffer);
+  log("File ID", fileId);
+  await createUnprocessedFile(client, {
+    id: fileId,
+    processes: [],
+    filename
+  });
+  const readStream = new Readable({
+    read() {
+      readStream.push(buffer);
+      readStream.push(null);
+    }
+  });
+  await uploadUnprocessedFile(client, fileId, readStream);
+  const fileInformation = await updateUnprocessedFile(client, fileId, {
+    processes: ["isobmff"]
+  });
+  log("File processed", fileInformation);
+  return fileInformation;
+};
+const processAVFile = async (client, filePath) => {
+  log("Processing AV file", filePath);
+  const fileId = await md5FilePath(filePath);
+  log("File ID", fileId);
+  await createUnprocessedFile(client, {
+    id: fileId,
+    processes: [],
+    filename: basename(filePath)
+  });
+  const readStream = createReadStream(filePath);
+  await uploadUnprocessedFile(client, fileId, readStream);
+  const fileInformation = await updateUnprocessedFile(client, fileId, {
+    processes: ["isobmff"]
+  });
+  log("File processed", fileInformation);
+  return fileInformation;
+};
+export {
+  CreateUnprocessedFilePayload,
+  UpdateUnprocessedFilePayload,
+  createUnprocessedFile,
+  processAVFile,
+  processAVFileBuffer,
+  updateUnprocessedFile,
+  uploadUnprocessedFile
+};

package/package.json

@@ -1,16 +1,12 @@
 {
   "name": "@editframe/api",
-  "version": "0.7.0-beta.8",
+  "version": "0.8.0-beta.1",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
       "import": {
-        "default": "./dist/index.js",
-        "types": "./dist/index.d.ts"
-      },
-      "require": {
-        "default": "./dist/index.cjs",
-        "types": "./dist/index.d.ts"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       }
     }
   },
@@ -23,15 +19,18 @@
   "author": "",
   "license": "UNLICENSED",
   "devDependencies": {
-    "@types/node": "^20.14.9",
-    "typescript": "^5.2.2",
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/node": "^20.14.13",
+    "typescript": "^5.5.4",
     "vite": "^5.2.11",
     "vite-plugin-dts": "^3.9.1",
     "vite-tsconfig-paths": "^4.3.2"
   },
   "dependencies": {
-    "@editframe/assets": "0.7.0-beta.8",
+    "@editframe/assets": "0.8.0-beta.1",
     "debug": "^4.3.5",
+    "jsonwebtoken": "^9.0.2",
+    "node-fetch": "^3.3.2",
     "zod": "^3.23.8"
   }
 }

package/src/resources/caption-file.ts

@@ -3,7 +3,7 @@ import type { Readable } from "node:stream";
 import { z } from "zod";
 import debug from "debug";
 
-import type { Client } from "../client";
+import type { Client } from "../client.ts";
 
 const log = debug("ef:api:caption-file");
 

package/src/resources/image-file.ts

@@ -3,7 +3,7 @@ import type { Readable } from "node:stream";
 import { z } from "zod";
 import debug from "debug";
 
-import type { Client } from "../client";
+import type { Client } from "../client.ts";
 
 const log = debug("ef:api:image-file");
 

package/src/resources/isobmff-file.ts

@@ -3,7 +3,7 @@ import type { Readable } from "node:stream";
 import { z } from "zod";
 import debug from "debug";
 
-import type { Client } from "../client";
+import type { Client } from "../client.ts";
 
 const log = debug("ef:api:isobmff-file");
 

package/src/resources/isobmff-track.ts

@@ -5,7 +5,7 @@ import debug from "debug";
 
 import { AudioStreamSchema, VideoStreamSchema } from "@editframe/assets";
 
-import type { Client } from "../client";
+import type { Client } from "../client.ts";
 
 const log = debug("ef:api:isobmff-track");
 

package/src/resources/renders.ts

@@ -3,7 +3,7 @@ import type { Readable } from "node:stream";
 import { z } from "zod";
 import debug from "debug";
 
-import type { Client } from "../client";
+import type { Client } from "../client.ts";
 
 const log = debug("ef:api:renders");
 

package/src/resources/signed-url.ts

@@ -0,0 +1,27 @@
+import debug from "debug";
+
+import type { Client } from "../client.ts";
+
+const log = debug("ef:api:signed-url");
+
+export interface SignedURLResult {
+  url: string;
+}
+
+export const createSignedURL = async (client: Client, url: string) => {
+  log("Creating signed url for", url);
+  const response = await client.authenticatedFetch("/api/v1/signed-url", {
+    method: "POST",
+    body: JSON.stringify({
+      url,
+    }),
+  });
+
+  if (!response.ok) {
+    throw new Error(
+      `Failed to create signed url: ${response.status} ${response.statusText} ${await response.text()}`,
+    );
+  }
+
+  return ((await response.json()) as SignedURLResult).url;
+};

package/src/resources/unprocessed-file.ts

@@ -0,0 +1,192 @@
+import { Readable } from "node:stream";
+import { basename } from "node:path";
+import { createReadStream } from "node:fs";
+
+import { z } from "zod";
+import debug from "debug";
+
+import { md5FilePath, md5Buffer } from "@editframe/assets";
+
+import type { Client } from "../client.ts";
+
+const log = debug("ef:api:unprocessed-file");
+
+const FileProcessors = z
+  .array(z.union([z.literal("isobmff"), z.literal("captions")]))
+  .refine(
+    (value) => {
+      return new Set(value).size === value.length;
+    },
+    {
+      message: "Processors list must not include duplicates",
+    },
+  );
+
+export const CreateUnprocessedFilePayload = z.object({
+  id: z.string(),
+  filename: z.string(),
+  processes: FileProcessors.optional(),
+});
+
+export const UpdateUnprocessedFilePayload = z.object({
+  processes: FileProcessors.optional(),
+});
+
+export interface CreateUnprocessedFileResult {
+  byte_size: number;
+  last_received_byte: number;
+  id: string;
+  processes: z.infer<typeof FileProcessors>;
+}
+
+export interface UpdateUnprocessedFileResult {
+  byte_size: number;
+  last_received_byte: number;
+  id: string;
+  processes: z.infer<typeof FileProcessors>;
+}
+
+export const createUnprocessedFile = async (
+  client: Client,
+  payload: z.infer<typeof CreateUnprocessedFilePayload>,
+) => {
+  log("Creating an unprocessed file", payload);
+  const response = await client.authenticatedFetch(
+    "/api/v1/unprocessed_files",
+    {
+      method: "POST",
+      body: JSON.stringify(payload),
+    },
+  );
+
+  log(
+    "Unprocessed file created",
+    response.status,
+    response.statusText,
+    response.headers,
+  );
+
+  switch (response.status) {
+    case 200: {
+      return (await response.json()) as CreateUnprocessedFileResult;
+    }
+    default: {
+      console.error(
+        `Failed to create file ${response.status} ${response.statusText}`,
+      );
+      console.error(await response.text());
+      throw new Error("Failed to create unprocessed file");
+    }
+  }
+};
+
+export const updateUnprocessedFile = async (
+  client: Client,
+  fileId: string,
+  payload: Partial<z.infer<typeof UpdateUnprocessedFilePayload>>,
+) => {
+  log("Updating unprocessed file", fileId, payload);
+  const response = await client.authenticatedFetch(
+    `/api/v1/unprocessed_files/${fileId}`,
+    {
+      method: "POST",
+      body: JSON.stringify(payload),
+    },
+  );
+
+  log("Unprocessed file updated", response);
+
+  switch (response.status) {
+    case 200: {
+      return (await response.json()) as UpdateUnprocessedFileResult;
+    }
+    default: {
+      console.error(
+        `Failed to update file ${response.status} ${response.statusText}`,
+      );
+      throw new Error("Failed to update unprocessed file");
+    }
+  }
+};
+
+export const uploadUnprocessedFile = async (
+  client: Client,
+  fileId: string,
+  fileStream: Readable,
+) => {
+  log("Uploading unprocessed file", fileId);
+  const unprocessedFile = await client.authenticatedFetch(
+    `/api/v1/unprocessed_files/${fileId}/upload`,
+    {
+      method: "POST",
+      body: fileStream,
+    },
+  );
+
+  log("Unprocessed file track uploaded", unprocessedFile);
+  switch (unprocessedFile.status) {
+    case 200: {
+      return unprocessedFile.json();
+    }
+    default: {
+      console.error("Failed to upload unprocessed file");
+      console.error(unprocessedFile.status, unprocessedFile.statusText);
+      throw new Error("Failed to upload unprocessed file");
+    }
+  }
+};
+
+export const processAVFileBuffer = async (
+  client: Client,
+  buffer: Buffer,
+  filename = "buffer",
+) => {
+  log("Processing AV file buffer");
+  const fileId = md5Buffer(buffer);
+
+  log("File ID", fileId);
+  await createUnprocessedFile(client, {
+    id: fileId,
+    processes: [],
+    filename,
+  });
+
+  const readStream = new Readable({
+    read() {
+      readStream.push(buffer);
+      readStream.push(null);
+    },
+  });
+
+  await uploadUnprocessedFile(client, fileId, readStream);
+
+  const fileInformation = await updateUnprocessedFile(client, fileId, {
+    processes: ["isobmff"],
+  });
+
+  log("File processed", fileInformation);
+  return fileInformation;
+};
+
+export const processAVFile = async (client: Client, filePath: string) => {
+  log("Processing AV file", filePath);
+  const fileId = await md5FilePath(filePath);
+
+  log("File ID", fileId);
+  await createUnprocessedFile(client, {
+    id: fileId,
+    processes: [],
+    filename: basename(filePath),
+  });
+
+  const readStream = createReadStream(filePath);
+
+  await uploadUnprocessedFile(client, fileId, readStream);
+
+  const fileInformation = await updateUnprocessedFile(client, fileId, {
+    processes: ["isobmff"],
+  });
+
+  log("File processed", fileInformation);
+  return fileInformation;
+};

package/dist/client.cjs

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const debug = require("debug");
-const fetch = require("node-fetch");
-const log = debug("ef:api:client");
-class Client {
-  constructor(token, efHost) {
-    this.token = token;
-    this.efHost = efHost;
-    this.authenticatedFetch = async (path, init = {}) => {
-      init.headers ||= {};
-      log(
-        "Authenticated fetch",
-        { path, init },
-        "(Token will be added as Bearer token)"
-      );
-      Object.assign(init.headers, {
-        Authorization: `Bearer ${this.token}`,
-        "Content-Type": "application/json"
-      });
-      const url = new URL(path, this.efHost);
-      const response = await fetch(url, init);
-      log("Authenticated fetch response", response.status, response.statusText);
-      return response;
-    };
-    log("Creating client with efHost", efHost, "and !!token", !!token);
-  }
-}
-exports.Client = Client;

package/dist/index.cjs

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const captionFile = require("./resources/caption-file.cjs");
-const imageFile = require("./resources/image-file.cjs");
-const isobmffFile = require("./resources/isobmff-file.cjs");
-const isobmffTrack = require("./resources/isobmff-track.cjs");
-const renders = require("./resources/renders.cjs");
-const client = require("./client.cjs");
-exports.CreateCaptionFilePayload = captionFile.CreateCaptionFilePayload;
-exports.createCaptionFile = captionFile.createCaptionFile;
-exports.uploadCaptionFile = captionFile.uploadCaptionFile;
-exports.CreateImageFilePayload = imageFile.CreateImageFilePayload;
-exports.createImageFile = imageFile.createImageFile;
-exports.uploadImageFile = imageFile.uploadImageFile;
-exports.CreateISOBMFFFilePayload = isobmffFile.CreateISOBMFFFilePayload;
-exports.createISOBMFFFile = isobmffFile.createISOBMFFFile;
-exports.uploadFragmentIndex = isobmffFile.uploadFragmentIndex;
-exports.CreateISOBMFFTrackPayload = isobmffTrack.CreateISOBMFFTrackPayload;
-exports.createISOBMFFTrack = isobmffTrack.createISOBMFFTrack;
-exports.uploadISOBMFFTrack = isobmffTrack.uploadISOBMFFTrack;
-exports.CreateRenderPayload = renders.CreateRenderPayload;
-exports.createRender = renders.createRender;
-exports.uploadRender = renders.uploadRender;
-exports.Client = client.Client;

package/dist/resources/caption-file.cjs

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const zod = require("zod");
-const debug = require("debug");
-const log = debug("ef:api:caption-file");
-const CreateCaptionFilePayload = zod.z.object({
-  id: zod.z.string(),
-  filename: zod.z.string()
-});
-const createCaptionFile = async (client, payload) => {
-  log("Creating caption file", payload);
-  const fileCreation = await client.authenticatedFetch(
-    "/api/video2/caption_files",
-    {
-      method: "POST",
-      body: JSON.stringify(payload)
-    }
-  );
-  log("Caption file created", fileCreation);
-  switch (fileCreation.status) {
-    case 200: {
-      return await fileCreation.json();
-    }
-    default: {
-      console.error(
-        `Failed to create file ${fileCreation.status} ${fileCreation.statusText}`
-      );
-      return;
-    }
-  }
-};
-const uploadCaptionFile = async (client, fileId, fileStream) => {
-  log("Uploading caption file", fileId);
-  const fileIndex = await client.authenticatedFetch(
-    `/api/video2/caption_files/${fileId}/upload`,
-    {
-      method: "POST",
-      body: fileStream
-    }
-  );
-  log("Caption file uploaded", fileIndex);
-  switch (fileIndex.status) {
-    case 200: {
-      return fileIndex.json();
-    }
-    default: {
-      console.error(
-        `Failed to upload caption ${fileIndex.status} ${fileIndex.statusText}`
-      );
-      return;
-    }
-  }
-};
-exports.CreateCaptionFilePayload = CreateCaptionFilePayload;
-exports.createCaptionFile = createCaptionFile;
-exports.uploadCaptionFile = uploadCaptionFile;

package/dist/resources/image-file.cjs

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const zod = require("zod");
-const debug = require("debug");
-const log = debug("ef:api:image-file");
-const CreateImageFilePayload = zod.z.object({
-  id: zod.z.string(),
-  height: zod.z.number().int(),
-  width: zod.z.number().int(),
-  mime_type: zod.z.enum(["image/jpeg", "image/png", "image/jpg", "image/webp"]),
-  filename: zod.z.string()
-});
-const createImageFile = async (client, payload) => {
-  log("Creating image file", payload);
-  const response = await client.authenticatedFetch("/api/video2/image_files", {
-    method: "POST",
-    body: JSON.stringify(payload)
-  });
-  log("Image file created", response);
-  switch (response.status) {
-    case 200: {
-      return await response.json();
-    }
-    default: {
-      console.error(
-        `Failed to create file ${response.status} ${response.statusText}`
-      );
-      return;
-    }
-  }
-};
-const uploadImageFile = async (client, fileId, fileStream) => {
-  const fileIndex = await client.authenticatedFetch(
-    `/api/video2/image_files/${fileId}/upload`,
-    {
-      method: "POST",
-      body: fileStream
-    }
-  );
-  switch (fileIndex.status) {
-    case 200: {
-      return fileIndex.json();
-    }
-    default: {
-      console.error("Failed to upload image");
-      return;
-    }
-  }
-};
-exports.CreateImageFilePayload = CreateImageFilePayload;
-exports.createImageFile = createImageFile;
-exports.uploadImageFile = uploadImageFile;

package/dist/resources/isobmff-file.cjs

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const zod = require("zod");
-const debug = require("debug");
-const log = debug("ef:api:isobmff-file");
-const CreateISOBMFFFilePayload = zod.z.object({
-  id: zod.z.string(),
-  filename: zod.z.string()
-});
-const createISOBMFFFile = async (client, payload) => {
-  log("Creating isobmff file", payload);
-  const response = await client.authenticatedFetch(
-    "/api/video2/isobmff_files",
-    {
-      method: "POST",
-      body: JSON.stringify(payload)
-    }
-  );
-  log("ISOBMFF file created", response);
-  switch (response.status) {
-    case 200: {
-      return await response.json();
-    }
-    default: {
-      console.error(
-        `Failed to create file ${response.status} ${response.statusText}`
-      );
-      return;
-    }
-  }
-};
-const uploadFragmentIndex = async (client, fileId, fileStream) => {
-  log("Uploading fragment index", fileId);
-  const fileIndex = await client.authenticatedFetch(
-    `/api/video2/isobmff_files/${fileId}/index/upload`,
-    {
-      method: "POST",
-      body: fileStream
-    }
-  );
-  log("Fragment index uploaded", fileIndex);
-  switch (fileIndex.status) {
-    case 200: {
-      return fileIndex.json();
-    }
-    default: {
-      console.error(
-        `Failed to create fragment index ${fileIndex.status} ${fileIndex.statusText}`
-      );
-      return;
-    }
-  }
-};
-exports.CreateISOBMFFFilePayload = CreateISOBMFFFilePayload;
-exports.createISOBMFFFile = createISOBMFFFile;
-exports.uploadFragmentIndex = uploadFragmentIndex;