feat: add setFile

Author: eduardoboucas

.nvmrc

@@ -0,0 +1 @@
+18.16

package-lock.json

@@ -3,16 +3,18 @@
   "version": "1.4.0",
   "description": "A JavaScript client for the Netlify Blob Store",
   "type": "module",
-  "main": "./dist/main.js",
-  "exports": "./dist/main.js",
+  "main": "./dist/src/main.js",
+  "exports": "./dist/src/main.js",
   "files": [
-    "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/src/**/*.js",
+    "dist/src/**/*.d.ts",
+    "!dist/src/**/*.test.d.ts"
   ],
   "scripts": {
     "build": "run-s build:*",
     "build:check": "tsc",
-    "build:transpile": "esbuild src/main.ts --bundle --outdir=dist --platform=node --format=esm",
+    "build:transpile": "esbuild src/main.ts --bundle --outdir=dist/src --platform=node --format=esm",
+    "dev": "esbuild src/main.ts --bundle --outdir=dist/src --platform=node --format=esm --watch",
     "prepare": "husky install node_modules/@netlify/eslint-config-node/.husky/",
     "prepublishOnly": "npm ci && npm test",
     "prepack": "npm run build",
@@ -29,8 +31,7 @@
     "test:ci": "run-s build test:ci:*",
     "test:dev:vitest": "vitest run",
     "test:dev:vitest:watch": "vitest watch",
-    "test:ci:vitest": "vitest run",
-    "watch": "tsc --watch"
+    "test:ci:vitest": "vitest run"
   },
   "config": {
     "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{js,ts,md,html}\" \"*.{js,ts,md,html}\"",
@@ -54,6 +55,7 @@
     "husky": "^8.0.0",
     "node-fetch": "^3.3.1",
     "semver": "^7.5.3",
+    "tmp-promise": "^3.0.3",
     "typescript": "^5.0.0",
     "vitest": "^0.33.0"
   },

package.json

@@ -1,6 +1,8 @@
-import { version as nodeVersion } from 'process'
+import { writeFile } from 'node:fs/promises'
+import { version as nodeVersion } from 'node:process'
 
 import semver from 'semver'
+import tmp from 'tmp-promise'
 import { describe, test, expect, beforeAll } from 'vitest'
 
 import { streamToString } from '../test/util.js'
@@ -310,6 +312,50 @@ describe('set', () => {
     await blobs.set(key, value, { ttl })
   })
 
+  test('Accepts a file', async () => {
+    expect.assertions(5)
+
+    const fileContents = 'Hello from a file'
+    const fetcher = async (...args: Parameters<typeof globalThis.fetch>) => {
+      const [url, options] = args
+      const headers = options?.headers as Record<string, string>
+
+      expect(options?.method).toBe('put')
+
+      if (url === `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=production`) {
+        const data = JSON.stringify({ url: signedURL })
+
+        expect(headers.authorization).toBe(`Bearer ${apiToken}`)
+
+        return new Response(data)
+      }
+
+      if (url === signedURL) {
+        expect(await streamToString(options?.body as unknown as NodeJS.ReadableStream)).toBe(fileContents)
+        expect(headers['cache-control']).toBe('max-age=0, stale-while-revalidate=60')
+
+        return new Response(value)
+      }
+
+      throw new Error(`Unexpected fetch call: ${url}`)
+    }
+
+    const { cleanup, path } = await tmp.file()
+
+    await writeFile(path, fileContents)
+
+    const blobs = new Blobs({
+      authentication: {
+        token: apiToken,
+      },
+      fetcher,
+      siteID,
+    })
+
+    await blobs.setFile(key, path)
+    await cleanup()
+  })
+
   test('Throws when the API returns a non-200 status code', async () => {
     const fetcher = async (...args: Parameters<typeof globalThis.fetch>) => {
       const [url, options] = args

src/main.test.ts

@@ -1,3 +1,7 @@
+import { createReadStream } from 'node:fs'
+import { stat } from 'node:fs/promises'
+import { Readable } from 'node:stream'
+
 interface APICredentials {
   apiURL?: string
   token: string
@@ -127,7 +131,19 @@ export class Blobs {
       headers['cache-control'] = 'max-age=0, stale-while-revalidate=60'
     }
 
-    const res = await this.fetcher(url, { body, headers, method })
+    const options: RequestInit = {
+      body,
+      headers,
+      method,
+    }
+
+    if (body instanceof ReadableStream) {
+      // @ts-expect-error Part of the spec, but not typed:
+      // https://fetch.spec.whatwg.org/#enumdef-requestduplex
+      options.duplex = 'half'
+    }
+
+    const res = await this.fetcher(url, options)
 
     if (res.status === 404 && method === HTTPMethod.Get) {
       return null
@@ -200,6 +216,17 @@ export class Blobs {
     await this.makeStoreRequest(key, HTTPMethod.Put, headers, data)
   }
 
+  async setFile(key: string, path: string, { ttl }: SetOptions = {}) {
+    const { size } = await stat(path)
+    const file = Readable.toWeb(createReadStream(path))
+    const headers = {
+      ...Blobs.getTTLHeaders(ttl),
+      'content-length': size.toString(),
+    }
+
+    await this.makeStoreRequest(key, HTTPMethod.Put, headers, file as ReadableStream)
+  }
+
   async setJSON(key: string, data: unknown, { ttl }: SetOptions = {}) {
     const payload = JSON.stringify(data)
     const headers = {