Merge pull request #65 from sor4chi/feat/remove-file-polyfill

RE: fix: remove File polyfill from core

.changeset/light-clocks-attend.md

@@ -0,0 +1,10 @@
+---
+"@hono-storage/core": patch
+---
+
+fix: remove `File` (`@web-std/file`) polyfill from `@hono-storage/core` package
+
+This changes means that **stop Node.js v18 support** for `@hono-storage/core` package.
+
+`@web-std/file` is a polyfill for the `File` class, but for web compatibility, it's not necessary to adapt the `File` class to Node.js.
+So if you want to Hono Storage to work on older Node.js versions, you can use the `@web-std/file` package manually.

packages/core/package.json

@@ -28,9 +28,6 @@
   },
   "author": "sor4chi",
   "license": "MIT",
-  "dependencies": {
-    "@web-std/file": "^3.0.3"
-  },
   "devDependencies": {
     "hono": "^4.3.2"
   },

packages/core/src/file.ts

@@ -1,5 +1,3 @@
-import { File } from "@web-std/file";
-
 type Field = {
   name: string;
   type: "single" | "multiple";
@@ -8,7 +6,7 @@ type Field = {
 export class HonoStorageFile extends File {
   field: Field;
 
-  constructor(file: Blob | File, field: Field) {
+  constructor(file: File, field: Field) {
     super([file], file.name);
     this.field = field;
   }

packages/core/src/storage.ts

@@ -25,9 +25,7 @@ export type FieldSchema = SingleFieldSchema | MultipleFieldSchema;
 export type FieldValue = string | File;
 
 const isFile = (value: unknown): value is File => {
-  if (typeof value !== "object" || value === null) return false;
-  // HELP ME: instanceof File is not working because node <= 20 doesn't have File :(
-  return value instanceof Blob && value.constructor.name === "File";
+  return value instanceof File;
 };
 
 export const FILES_KEY = "files";

packages/core/tests/file.test.ts

@@ -1,5 +1,3 @@
-import { File } from "@web-std/file";
-
 import { HonoStorageFile } from "../src/file";
 
 describe("HonoStorageFile", () => {

packages/core/tests/storage.test.ts

@@ -1,4 +1,3 @@
-import { File } from "@web-std/file";
 import { Hono } from "hono";
 
 import { HonoStorage, FieldValue, Errors } from "../src";
@@ -71,7 +70,7 @@ describe("HonoStorage", () => {
 
       expect(res.status).toBe(200);
       expect(storageHandler).toBeCalledTimes(1);
-      expect(actualFieldValue).toBeInstanceOf(Blob);
+      expect(actualFieldValue).toBeInstanceOf(File);
     });
 
     it("should through if no form data is provided", async () => {
@@ -127,7 +126,7 @@ describe("HonoStorage", () => {
 
       expect(res.status).toBe(200);
       expect(storageHandler).toBeCalledTimes(1); // 2 file, but 1 is string
-      expect(actualFieldValue1).toBeInstanceOf(Blob);
+      expect(actualFieldValue1).toBeInstanceOf(File);
       expect(actualFieldValue2).toBe(file2);
     });
   });
@@ -265,7 +264,7 @@ describe("HonoStorage", () => {
       });
 
       expect(storageHandler).toBeCalledTimes(1);
-      expect(actualFieldValue).toBeInstanceOf(Blob);
+      expect(actualFieldValue).toBeInstanceOf(File);
     });
 
     it("should work with a multiple field", async () => {
@@ -363,10 +362,10 @@ describe("HonoStorage", () => {
       });
 
       expect(storageHandler).toBeCalledTimes(3);
-      expect(actualFieldValue1).toBeInstanceOf(Blob);
+      expect(actualFieldValue1).toBeInstanceOf(File);
       expect(actualFieldValue2).toHaveLength(2);
       expect((actualFieldValue2 as unknown as FieldValue[])[0]).toBeInstanceOf(
-        Blob,
+        File,
       );
     });
   });

packages/memory/src/index.ts

@@ -9,7 +9,7 @@ export type HonoMemoryStorageOptions = {
 };
 
 export class HonoMemoryStorage extends HonoStorage {
-  buffer: Map<string, Blob>;
+  buffer: Map<string, File>;
   key: HMSFunction;
 
   constructor(options: HonoMemoryStorageOptions = {}) {

packages/memory/tests/index.test.ts

@@ -22,12 +22,18 @@ describe("HonoMemoryStorage", () => {
 
     const formData = new FormData();
 
-    const file1 = new Blob(["Hello World 1"], { type: "text/plain" });
-    const file2 = new Blob(["Hello World 2"], { type: "text/plain" });
-    const file3 = new Blob(["Hello World 3"], { type: "text/plain" });
-    formData.append("file", file1, "sample1.txt");
-    formData.append("file2", file2, "sample2.txt");
-    formData.append("file2", file3, "sample1.txt");
+    const file1 = new File(["Hello World 1"], "sample1.txt", {
+      type: "text/plain",
+    });
+    const file2 = new File(["Hello World 2"], "sample2.txt", {
+      type: "text/plain",
+    });
+    const file3 = new File(["Hello World 3"], "sample1.txt", {
+      type: "text/plain",
+    });
+    formData.append("file", file1);
+    formData.append("file2", file2);
+    formData.append("file2", file3);
 
     const res = await app.request("http://localhost/upload", {
       method: "POST",
@@ -63,12 +69,18 @@ describe("HonoMemoryStorage", () => {
 
     const formData = new FormData();
 
-    const file1 = new Blob(["Hello World 1"], { type: "text/plain" });
-    const file2 = new Blob(["Hello World 2"], { type: "text/plain" });
-    const file3 = new Blob(["Hello World 3"], { type: "text/plain" });
-    formData.append("file", file1, "sample1.txt");
-    formData.append("file2", file2, "sample2.txt");
-    formData.append("file2", file3, "sample1.txt");
+    const file1 = new File(["Hello World 1"], "sample1.txt", {
+      type: "text/plain",
+    });
+    const file2 = new File(["Hello World 2"], "sample2.txt", {
+      type: "text/plain",
+    });
+    const file3 = new File(["Hello World 3"], "sample1.txt", {
+      type: "text/plain",
+    });
+    formData.append("file", file1);
+    formData.append("file2", file2);
+    formData.append("file2", file3);
 
     const res = await app.request("http://localhost/upload?store=1", {
       method: "POST",

packages/s3/tests/index.test.ts

@@ -77,7 +77,7 @@ describe("HonoS3Storage", () => {
       });
 
       expect(putToS3).toHaveBeenCalledTimes(1);
-      expect(actualFile).toBeInstanceOf(Blob);
+      expect(actualFile).toBeInstanceOf(File);
       expect(actualSignedURL).toBe(undefined);
     });
 
@@ -121,7 +121,7 @@ describe("HonoS3Storage", () => {
       expect(getSignedURLFromS3.mock.calls[0][1]).toMatchObject({
         expiresIn: 60,
       });
-      expect(actualFile).toBeInstanceOf(Blob);
+      expect(actualFile).toBeInstanceOf(File);
       expect(actualSignedURL).toBe("https://example.com");
     });
   });
@@ -163,7 +163,7 @@ describe("HonoS3Storage", () => {
       expect(actualFiles).toHaveLength(2);
       assert(
         Array.isArray(actualFiles) &&
-          actualFiles.every((v) => v instanceof Blob),
+          actualFiles.every((v) => v instanceof File),
       );
       expect(actualSignedURL).toBe(undefined);
     });
@@ -214,7 +214,7 @@ describe("HonoS3Storage", () => {
       expect(actualFiles).toHaveLength(2);
       assert(
         Array.isArray(actualFiles) &&
-          actualFiles.every((v) => v instanceof Blob),
+          actualFiles.every((v) => v instanceof File),
       );
       expect(actualSignedURL).toBeInstanceOf(Array);
       expect(actualSignedURL).toHaveLength(2);
@@ -274,12 +274,12 @@ describe("HonoS3Storage", () => {
 
       expect(putToS3).toHaveBeenCalledTimes(3);
       expect(getSignedURLFromS3).toHaveBeenCalledTimes(0);
-      expect(actualImage).toBeInstanceOf(Blob);
+      expect(actualImage).toBeInstanceOf(File);
       expect(actualImages).toBeInstanceOf(Array);
       expect(actualImages).toHaveLength(2);
       assert(
         Array.isArray(actualImages) &&
-          actualImages.every((v) => v instanceof Blob),
+          actualImages.every((v) => v instanceof File),
       );
       expect(actualSignedURL).toBeInstanceOf(Object);
     });
@@ -342,12 +342,12 @@ describe("HonoS3Storage", () => {
       expect(getSignedURLFromS3.mock.calls[1][1]).toMatchObject({
         expiresIn: 60,
       });
-      expect(actualImage).toBeInstanceOf(Blob);
+      expect(actualImage).toBeInstanceOf(File);
       expect(actualImages).toBeInstanceOf(Array);
       expect(actualImages).toHaveLength(2);
       assert(
         Array.isArray(actualImages) &&
-          actualImages.every((v) => v instanceof Blob),
+          actualImages.every((v) => v instanceof File),
       );
       expect(actualSignedURL).toBeInstanceOf(Object);
       expect(actualSignedURL).toMatchObject({