@editframe/api 0.26.3-beta.0 → 0.26.4-beta.0

package/src/resources/image-file.ts

@@ -1,205 +0,0 @@
-import debug from "debug";
-import { types } from "mime-types";
-import { z } from "zod";
-
-import type { Client } from "../client.js";
-import { uploadChunks } from "../uploadChunks.js";
-
-const log = debug("ef:api:image-file");
-
-const MAX_IMAGE_SIZE = 1024 * 1024 * 16; // 16MB
-
-export const ImageFileMimeTypes = z.enum([
-  "image/jpeg",
-  "image/png",
-  "image/jpg",
-  "image/webp",
-  "image/svg+xml",
-]);
-
-function getFileExtension(path: string) {
-  const match = path.match(/\.([^.]+)$/);
-  return match ? match[1] : null;
-}
-
-export 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),
-  })
-  .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"],
-      });
-    }
-  });
-
-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 | 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 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 const createImageFile = async (
-  client: Client,
-  payload: CreateImageFilePayload,
-) => {
-  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()) as CreateImageFileResult;
-  }
-
-  throw new Error(
-    `Failed to create file ${response.status} ${response.statusText}`,
-  );
-};
-
-export const uploadImageFile = (
-  client: Client,
-  uploadDetails: {
-    id: string;
-    byte_size: number;
-  },
-  fileStream: ReadableStream,
-  chunkSizeBytes?: number,
-) => {
-  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,
-  });
-};
-
-export const getImageFileMetadata = async (
-  client: Client,
-  id: string,
-): Promise<GetImageFileMetadataResult | null> => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/image_files/${id}.json`,
-    {
-      method: "GET",
-    },
-  );
-
-  if (response.ok) {
-    return (await response.json()) as LookupImageFileByMd5Result;
-  }
-
-  return null;
-};
-
-export const lookupImageFileByMd5 = async (
-  client: Client,
-  md5: string,
-): Promise<LookupImageFileByMd5Result | null> => {
-  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()) as LookupImageFileByMd5Result;
-  }
-
-  if (response.status === 404) {
-    return null;
-  }
-
-  throw new Error(
-    `Failed to lookup image by md5 ${md5} ${response.status} ${response.statusText}`,
-  );
-};

package/src/resources/isobmff-file.test.ts

@@ -1,159 +0,0 @@
-import { HttpResponse, http } from "msw";
-import { setupServer } from "msw/node";
-import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
-
-import { Client } from "../client.js";
-import { webReadableFromBuffers } from "../readableFromBuffers.js";
-import {
-  createISOBMFFFile,
-  lookupISOBMFFFileByMd5,
-  uploadFragmentIndex,
-} from "./isobmff-file.js";
-
-const server = setupServer();
-const client = new Client("ef_TEST_TOKEN", "http://localhost");
-
-describe("ISOBMFFFile", () => {
-  beforeAll(() => server.listen());
-  afterEach(() => server.resetHandlers());
-  afterAll(() => server.close());
-
-  describe("createISOBMFFFile", () => {
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/isobmff_files", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        createISOBMFFFile(client, {
-          md5: "test-md5",
-          filename: "test",
-        }),
-      ).rejects.toThrowError(
-        "Failed to create isobmff file 500 Internal Server Error",
-      );
-    });
-
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/isobmff_files", () =>
-          HttpResponse.json(
-            { id: "test-id" },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await createISOBMFFFile(client, {
-        md5: "test-md5",
-        filename: "test",
-      });
-
-      expect(response).toEqual({ id: "test-id" });
-    });
-  });
-
-  describe("uploadFragmentIndex", () => {
-    test("Throws when file size exceeds limit", async () => {
-      await expect(
-        uploadFragmentIndex(
-          client,
-          "test-id",
-          webReadableFromBuffers(Buffer.from("test")),
-          1024 * 1024 * 3,
-        ),
-      ).rejects.toThrowError("File size exceeds limit of 2097152 bytes");
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.post(
-          "http://localhost/api/v1/isobmff_files/test-id/index/upload",
-          () => HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        uploadFragmentIndex(
-          client,
-          "test-id",
-          webReadableFromBuffers(Buffer.from("test")),
-          4,
-        ),
-      ).rejects.toThrowError(
-        "Failed to create fragment index 500 Internal Server Error",
-      );
-    });
-
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.post(
-          "http://localhost/api/v1/isobmff_files/test-id/index/upload",
-          () =>
-            HttpResponse.json(
-              { fragment_index_complete: true },
-              { status: 200, statusText: "OK" },
-            ),
-        ),
-      );
-
-      const response = await uploadFragmentIndex(
-        client,
-        "test-id",
-        webReadableFromBuffers(Buffer.from("test")),
-        4,
-      );
-
-      expect(response).toEqual({ fragment_index_complete: true });
-    });
-  });
-
-  describe("lookupISOBMFFFileByMd5", () => {
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/isobmff_files/md5/test-md5", () =>
-          HttpResponse.json(
-            { id: "test-id", md5: "test-md5", fragment_index_complete: true },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await lookupISOBMFFFileByMd5(client, "test-md5");
-
-      expect(response).toEqual({
-        id: "test-id",
-        md5: "test-md5",
-        fragment_index_complete: true,
-      });
-    });
-
-    test("Returns null when file is not found", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/isobmff_files/md5/test-md5", () =>
-          HttpResponse.json({}, { status: 404 }),
-        ),
-      );
-
-      const response = await lookupISOBMFFFileByMd5(client, "test-md5");
-
-      expect(response).toBeNull();
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/isobmff_files/md5/test-md5", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        lookupISOBMFFFileByMd5(client, "test-md5"),
-      ).rejects.toThrowError(
-        "Failed to lookup isobmff file by md5 test-md5 500 Internal Server Error",
-      );
-    });
-  });
-});

package/src/resources/isobmff-file.ts

@@ -1,186 +0,0 @@
-import debug from "debug";
-import { z } from "zod";
-
-import type { Client } from "../client.js";
-
-const log = debug("ef:api:isobmff-file");
-const FILE_SIZE_LIMIT = 1024 * 1024 * 2; // 32MB
-
-export const CreateISOBMFFFilePayload = z.object({
-  md5: z.string(),
-  filename: z.string(),
-});
-
-export type CreateISOBMFFFilePayload = z.infer<typeof CreateISOBMFFFilePayload>;
-
-export interface CreateISOBMFFFileResult {
-  /**
-   * Whether the fragment index is complete. The fragment index is used internally by editframe to efficiently seek within files.
-   */
-  fragment_index_complete: boolean;
-  /**
-   * The filename of the isobmff file
-   */
-  filename: string;
-  /**
-   * The id of the isobmff file
-   */
-  id: string;
-  /**
-   * The md5 hash of the isobmff file
-   */
-  md5: string;
-}
-
-export interface LookupISOBMFFFileByMd5Result {
-  /**
-   * Whether the fragment index is complete
-   */
-  fragment_index_complete: boolean;
-  /**
-   * The filename of the isobmff file
-   */
-  filename: string;
-  id: string;
-  md5: string;
-}
-
-export interface GetISOBMFFFileTranscriptionResult {
-  id: string;
-  work_slice_ms: number;
-  isobmff_track: {
-    duration_ms: number;
-  };
-}
-
-export const createISOBMFFFile = async (
-  client: Client,
-  payload: CreateISOBMFFFilePayload,
-) => {
-  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()) as CreateISOBMFFFileResult;
-  }
-
-  throw new Error(
-    `Failed to create isobmff file ${response.status} ${response.statusText}`,
-  );
-};
-
-export const uploadFragmentIndex = async (
-  client: Client,
-  fileId: string,
-  fileStream: ReadableStream,
-  fileSize: number,
-) => {
-  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}`,
-  );
-};
-
-export const lookupISOBMFFFileByMd5 = async (
-  client: Client,
-  md5: string,
-): Promise<LookupISOBMFFFileByMd5Result | null> => {
-  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()) as LookupISOBMFFFileByMd5Result;
-  }
-
-  if (response.status === 404) {
-    return null;
-  }
-
-  throw new Error(
-    `Failed to lookup isobmff file by md5 ${md5} ${response.status} ${response.statusText}`,
-  );
-};
-
-export const getISOBMFFFileTranscription = async (
-  client: Client,
-  id: string,
-): Promise<GetISOBMFFFileTranscriptionResult | null> => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/isobmff_files/${id}/transcription`,
-  );
-
-  if (response.ok) {
-    return (await response.json()) as GetISOBMFFFileTranscriptionResult;
-  }
-
-  if (response.status === 404) {
-    return null;
-  }
-
-  throw new Error(
-    `Failed to get isobmff file transcription ${id} ${response.status} ${response.statusText}`,
-  );
-};
-
-export const TranscribeISOBMFFFilePayload = z.object({
-  trackId: z.string().optional(),
-});
-
-export type TranscribeISOBMFFFilePayload = z.infer<
-  typeof TranscribeISOBMFFFilePayload
->;
-
-export interface TranscribeISOBMFFFileResult {
-  id: string;
-  file_id: string;
-  track_id: number;
-}
-
-export const transcribeISOBMFFFile = async (
-  client: Client,
-  id: string,
-  payload: TranscribeISOBMFFFilePayload = {},
-) => {
-  const response = await client.authenticatedFetch(
-    `/api/v1/isobmff_files/${id}/transcribe`,
-    {
-      method: "POST",
-      body: JSON.stringify(payload),
-    },
-  );
-
-  if (response.ok) {
-    return (await response.json()) as TranscribeISOBMFFFileResult;
-  }
-
-  throw new Error(
-    `Failed to transcribe isobmff file ${id} ${response.status} ${response.statusText}`,
-  );
-};

package/src/resources/isobmff-track.test.ts

@@ -1,126 +0,0 @@
-import { createTestTrack } from "TEST/createTestTrack.js";
-import { HttpResponse, http } from "msw";
-import { setupServer } from "msw/node";
-import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
-import { Client } from "../client.js";
-import { webReadableFromBuffers } from "../readableFromBuffers.js";
-import { createISOBMFFTrack, uploadISOBMFFTrack } from "./isobmff-track.js";
-
-const server = setupServer();
-const client = new Client("ef_TEST_TOKEN", "http://localhost");
-
-const UploadMustContinue = (fileId = "test-file", trackId = 1) =>
-  http.get(
-    `http://localhost/api/v1/isobmff_tracks/${fileId}/${trackId}/upload`,
-    () => HttpResponse.json({}, { status: 202 }),
-  );
-
-describe("ISOBMFF Track", () => {
-  beforeAll(() => server.listen());
-  afterEach(() => server.resetHandlers());
-  afterAll(() => server.close());
-
-  describe("createISOBMFFTrack", () => {
-    test("Throws when track is too large", async () => {
-      await expect(
-        createISOBMFFTrack(
-          client,
-          createTestTrack({ byte_size: 1024 * 1024 * 1025 }),
-        ),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(`
-        [ZodError: [
-          {
-            "code": "too_big",
-            "maximum": 1073741824,
-            "type": "number",
-            "inclusive": true,
-            "exact": false,
-            "message": "Number must be less than or equal to 1073741824",
-            "path": [
-              "byte_size"
-            ]
-          }
-        ]]
-      `);
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/isobmff_tracks", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        createISOBMFFTrack(client, createTestTrack()),
-      ).rejects.toThrowError(
-        "Failed to create isobmff track 500 Internal Server Error",
-      );
-    });
-
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/isobmff_tracks", () =>
-          HttpResponse.json(
-            { testResponse: "test" },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await createISOBMFFTrack(
-        client,
-        createTestTrack({ byte_size: 1024 * 1024 * 5 }),
-      );
-
-      expect(response).toEqual({ testResponse: "test" });
-    });
-  });
-
-  describe("uploadISOBMFFTrack", () => {
-    test("Throws when server returns an error", async () => {
-      server.use(
-        UploadMustContinue("test-file", 1),
-        http.post(
-          "http://localhost/api/v1/isobmff_tracks/test-file/1/upload",
-          () => HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        uploadISOBMFFTrack(
-          client,
-          "test-file",
-          1,
-          webReadableFromBuffers(Buffer.from("test")),
-          4,
-        ).whenUploaded(),
-      ).rejects.toThrowError(
-        "Failed to upload chunk 0 for /api/v1/isobmff_tracks/test-file/1/upload 500 Internal Server Error",
-      );
-    });
-
-    test("Succeeds when server returns a success", async () => {
-      server.use(
-        UploadMustContinue("test-file", 1),
-        http.post(
-          "http://localhost/api/v1/isobmff_tracks/test-file/1/upload",
-          () => HttpResponse.json({}, { status: 201 }),
-        ),
-      );
-
-      await expect(
-        uploadISOBMFFTrack(
-          client,
-          "test-file",
-          1,
-          webReadableFromBuffers(Buffer.from("test")),
-          4,
-        ).whenUploaded(),
-      ).resolves.toEqual([
-        { type: "progress", progress: 0 },
-        { type: "progress", progress: 1 },
-      ]);
-    });
-  });
-});