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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/api",
-  "version": "0.26.2-beta.0",
+  "version": "0.26.4-beta.0",
   "description": "API functions for EditFrame",
   "type": "module",
   "scripts": {
@@ -19,7 +19,7 @@
     "typescript": "^5.5.4"
   },
   "dependencies": {
-    "@editframe/assets": "0.26.2-beta.0",
+    "@editframe/assets": "0.26.4-beta.0",
     "@vitejs/plugin-react": "^4.3.4",
     "debug": "^4.3.5",
     "eventsource-parser": "^3.0.0",
@@ -53,7 +53,8 @@
         "default": "./dist/resources/renders.bundle.js"
       }
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./types.json": "./types.json"
   },
   "publishConfig": {
     "exports": {

package/tsdown.config.ts

@@ -6,5 +6,8 @@ export default defineConfig(
   createTsdownConfig({
     entry: ["src/index.ts", "src/node.ts", "src/resources/renders.bundle.ts"],
     platform: "node",
+    additionalExports: {
+      "./types.json": "./types.json",
+    },
   }),
 );

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

@@ -1,172 +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 {
-  createCaptionFile,
-  lookupCaptionFileByMd5,
-  uploadCaptionFile,
-} from "./caption-file.js";
-
-const server = setupServer();
-const client = new Client("ef_TEST_TOKEN", "http://localhost");
-
-describe("CaptionFile", () => {
-  beforeAll(() => server.listen());
-  afterEach(() => server.resetHandlers());
-  afterAll(() => server.close());
-
-  describe("createCaptionFile", () => {
-    test("Throws when file is too large", async () => {
-      await expect(
-        createCaptionFile(client, {
-          md5: "test-md5",
-          filename: "test",
-          byte_size: 1024 * 1024 * 3,
-        }),
-      ).rejects.toThrowError(
-        "File size 3145728 bytes exceeds limit 2097152 bytes",
-      );
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/caption_files", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        createCaptionFile(client, {
-          md5: "test-md5",
-          filename: "test",
-          byte_size: 4,
-        }),
-      ).rejects.toThrowError(
-        "Failed to create caption 500 Internal Server Error",
-      );
-    });
-
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/caption_files", () =>
-          HttpResponse.json(
-            { id: "test-id" },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await createCaptionFile(client, {
-        md5: "test-md5",
-        filename: "test",
-        byte_size: 4,
-      });
-
-      expect(response).toEqual({ id: "test-id" });
-    });
-  });
-
-  describe("uploadCaptionFile", () => {
-    test("Throws when file is too large", async () => {
-      await expect(
-        uploadCaptionFile(
-          client,
-          "test-id",
-          webReadableFromBuffers(Buffer.from("test")),
-          1024 * 1024 * 3,
-        ),
-      ).rejects.toThrowError(
-        "File size 3145728 bytes exceeds limit 2097152 bytes",
-      );
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/caption_files/test-id/upload", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        uploadCaptionFile(
-          client,
-          "test-id",
-          webReadableFromBuffers(Buffer.from("nice")),
-          4,
-        ),
-      ).rejects.toThrowError(
-        "Failed to upload caption 500 Internal Server Error",
-      );
-    });
-
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/caption_files/test-id/upload", () =>
-          HttpResponse.json(
-            { id: "test-id" },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await uploadCaptionFile(
-        client,
-        "test-id",
-        webReadableFromBuffers(Buffer.from("nice")),
-        4,
-      );
-
-      expect(response).toEqual({ id: "test-id" });
-    });
-  });
-
-  describe("lookupCaptionFileByMd5", () => {
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/caption_files/md5/test-md5", () =>
-          HttpResponse.json(
-            { id: "test-id", md5: "test-md5", complete: true },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await lookupCaptionFileByMd5(client, "test-md5");
-
-      expect(response).toEqual({
-        id: "test-id",
-        md5: "test-md5",
-        complete: true,
-      });
-    });
-
-    test("Returns null when file is not found", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/caption_files/md5/test-md5", () =>
-          HttpResponse.json({}, { status: 404 }),
-        ),
-      );
-
-      const response = await lookupCaptionFileByMd5(client, "test-md5");
-
-      expect(response).toBeNull();
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/caption_files/md5/test-md5", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        lookupCaptionFileByMd5(client, "test-md5"),
-      ).rejects.toThrowError(
-        "Failed to lookup caption by md5 test-md5 500 Internal Server Error",
-      );
-    });
-  });
-});

package/src/resources/caption-file.ts

@@ -1,154 +0,0 @@
-import debug from "debug";
-import { z } from "zod";
-
-import type { Client } from "../client.js";
-
-const log = debug("ef:api:caption-file");
-
-const MAX_CAPTION_SIZE = 1024 * 1024 * 2; // 2MB
-
-export 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),
-});
-
-export type CreateCaptionFilePayload = z.infer<typeof CreateCaptionFilePayload>;
-
-export interface CreateCaptionFileResult {
-  /**
-   * Whether the caption file is complete
-   */
-  complete: boolean | null;
-  /**
-   * The id of the caption file
-   */
-  id: string;
-  /**
-   * The md5 hash of the caption file
-   */
-  md5: string;
-}
-
-export interface LookupCaptionFileByMd5Result {
-  /**
-   * Whether the caption file is complete
-   */
-  complete: boolean | null;
-  /**
-   * The id of the caption file
-   */
-  id: string;
-  /**
-   * The md5 hash of the caption file
-   */
-  md5: string;
-}
-
-const restrictSize = (size: number) => {
-  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
- */
-export const createCaptionFile = async (
-  client: Client,
-  payload: CreateCaptionFilePayload,
-) => {
-  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()) as CreateCaptionFileResult;
-  }
-
-  throw new Error(
-    `Failed to create caption ${response.status} ${response.statusText}`,
-  );
-};
-
-export const uploadCaptionFile = async (
-  client: Client,
-  fileId: string,
-  fileStream: ReadableStream,
-  fileSize: number,
-) => {
-  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}`,
-  );
-};
-
-export const lookupCaptionFileByMd5 = async (
-  client: Client,
-  md5: string,
-): Promise<LookupCaptionFileByMd5Result | null> => {
-  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()) as LookupCaptionFileByMd5Result;
-  }
-
-  if (response.status === 404) {
-    return null;
-  }
-
-  throw new Error(
-    `Failed to lookup caption by md5 ${md5} ${response.status} ${response.statusText}`,
-  );
-};

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

@@ -1,220 +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 {
-  CreateImageFilePayload,
-  createImageFile,
-  lookupImageFileByMd5,
-  uploadImageFile,
-} from "./image-file.js";
-
-const server = setupServer();
-const client = new Client("ef_TEST_TOKEN", "http://localhost");
-
-const UploadMustContinue = (id = "test-file") =>
-  http.get(`http://localhost/api/v1/image_files/${id}/upload`, () =>
-    HttpResponse.json({}, { status: 202 }),
-  );
-
-describe("CreateImageFilePayload", () => {
-  test("parses mime type from filename", () => {
-    const payload = CreateImageFilePayload.parse({
-      byte_size: 100,
-      filename: "test.jpg",
-    });
-
-    expect(payload.mime_type).toBe("image/jpeg");
-  });
-
-  test("rejects unsupported mime types", () => {
-    const payload = CreateImageFilePayload.safeParse({
-      byte_size: 100,
-      filename: "test.txt",
-    });
-
-    expect(
-      payload.error?.issues.some((issue) => issue.path.includes("mime_type")),
-    ).toBe(true);
-  });
-});
-
-describe("ImageFile", () => {
-  beforeAll(() => server.listen());
-  afterEach(() => server.resetHandlers());
-  afterAll(() => server.close());
-
-  describe("createImageFile", () => {
-    test("Throws when file is too large", async () => {
-      await expect(
-        createImageFile(client, {
-          md5: "test-md5",
-          filename: "test",
-          byte_size: 1024 * 1024 * 17,
-          height: 100,
-          width: 100,
-          mime_type: "image/jpeg",
-        }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(`
-        [ZodError: [
-          {
-            "code": "too_big",
-            "maximum": 16777216,
-            "type": "number",
-            "inclusive": true,
-            "exact": false,
-            "message": "Number must be less than or equal to 16777216",
-            "path": [
-              "byte_size"
-            ]
-          }
-        ]]
-      `);
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/image_files", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        createImageFile(client, {
-          md5: "test-md5",
-          filename: "test",
-          byte_size: 4,
-          height: 100,
-          width: 100,
-          mime_type: "image/jpeg",
-        }),
-      ).rejects.toThrowError("Failed to create file 500 Internal Server Error");
-    });
-
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.post("http://localhost/api/v1/image_files", () =>
-          HttpResponse.json(
-            { md5: "test-md5" },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await createImageFile(client, {
-        md5: "test-md5",
-        filename: "test",
-        byte_size: 4,
-        height: 100,
-        width: 100,
-        mime_type: "image/jpeg",
-      });
-
-      expect(response).toEqual({ md5: "test-md5" });
-    });
-  });
-
-  describe("uploadImageFile", () => {
-    test("Throws when file is too large", async () => {
-      await expect(
-        uploadImageFile(
-          client,
-          { id: "test-file-id", byte_size: 1024 * 1024 * 17 },
-          webReadableFromBuffers(Buffer.from("test")),
-        ).whenUploaded(),
-      ).rejects.toThrowError(
-        "File size 17825792 bytes exceeds limit 16777216 bytes",
-      );
-    });
-
-    test("Throws if upload fails", async () => {
-      server.use(
-        UploadMustContinue("test-file-id"),
-        http.post(
-          "http://localhost/api/v1/image_files/test-file-id/upload",
-          () => HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        uploadImageFile(
-          client,
-          { id: "test-file-id", byte_size: 4 },
-          webReadableFromBuffers(Buffer.from("test")),
-        ).whenUploaded(),
-      ).rejects.toThrowError(
-        "Failed to upload chunk 0 for /api/v1/image_files/test-file-id/upload 500 Internal Server Error",
-      );
-    });
-
-    test("Uploads file", async () => {
-      server.use(
-        UploadMustContinue("test-file-id"),
-        http.post(
-          "http://localhost/api/v1/image_files/test-file-id/upload",
-          () => HttpResponse.json(null, { status: 201 }),
-        ),
-      );
-
-      await expect(
-        uploadImageFile(
-          client,
-          { id: "test-file-id", byte_size: 4 },
-          webReadableFromBuffers(Buffer.from("test")),
-        ).whenUploaded(),
-      ).resolves.toEqual([
-        { type: "progress", progress: 0 },
-        { type: "progress", progress: 1 },
-      ]);
-    });
-  });
-
-  describe("lookupImageFileByMd5", () => {
-    test("Returns json data from the http response", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/image_files/md5/test-md5", () =>
-          HttpResponse.json(
-            { id: "test-id", md5: "test-md5", complete: true },
-            { status: 200, statusText: "OK" },
-          ),
-        ),
-      );
-
-      const response = await lookupImageFileByMd5(client, "test-md5");
-
-      expect(response).toEqual({
-        id: "test-id",
-        md5: "test-md5",
-        complete: true,
-      });
-    });
-
-    test("Returns null when file is not found", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/image_files/md5/test-md5", () =>
-          HttpResponse.json({}, { status: 404 }),
-        ),
-      );
-
-      const response = await lookupImageFileByMd5(client, "test-md5");
-
-      expect(response).toBeNull();
-    });
-
-    test("Throws when server returns an error", async () => {
-      server.use(
-        http.get("http://localhost/api/v1/image_files/md5/test-md5", () =>
-          HttpResponse.text("Internal Server Error", { status: 500 }),
-        ),
-      );
-
-      await expect(
-        lookupImageFileByMd5(client, "test-md5"),
-      ).rejects.toThrowError(
-        "Failed to lookup image by md5 test-md5 500 Internal Server Error",
-      );
-    });
-  });
-});