🎉 feat: 0.7.1

Author: SaltyAom

CHANGELOG.md

@@ -1,3 +1,26 @@
+# 0.7.1 - 23 Sep 2023
+Improvement:
+- [#10](https://github.com/elysiajs/elysia-static/issues/10) onError is not triggered when page is not found and file resolution is dynamic
+- [#7](https://github.com/elysiajs/elysia-static/issues/8) add `headers` config
+- using new plugin model instead of functional callback
+
+Change:
+- Minimum support for Elysia is now set to 0.7.9
+
+Bug fix:
+- [#8](https://github.com/elysiajs/elysia-static/issues/8) set `noUncheckedIndexedAccess` to `true`
+
+# 0.7.0 - 20 Sep 2023
+- Add support for Elysia 0.7
+
+# 0.7.0-beta.0 - 18 Sep 2023
+- Add support for Elysia 0.7
+
+# 0.6.0 - 6 Aug 2023
+- Add support for Elysia 0.6
+
+# 0.6.0-rc.0 - 6 Aug 2023
+- Add support for Elysia 0.6
 # 0.5.0 - 15 May 2023
 - Add support for Elysia 0.5
 - Add CommonJS support

bun.lockb

@@ -1,7 +1,12 @@
 import { Elysia } from 'elysia'
 import { staticPlugin } from '../src'
 
+const a = async () => {
+    return new Elysia()
+}
+
 const app = new Elysia()
+    .use(a())
     .use(
         staticPlugin({
             ignorePatterns: [/takodachi.png$/]
@@ -13,12 +18,4 @@ const app = new Elysia()
             ignorePatterns: [/takodachi.png$/]
         })
     )
-    .listen(8080)
-
-// const file1 = await app.handle(req('/public/takodachi.png'))
-// const file2 = await app.handle(req('/public/tako.png'))
-// const blob1 = await file1.blob()
-// const blob2 = await file2.blob()
-
-// expect(await blob1.text()).toBe('NOT_FOUND')
-// expect(await blob2.text()).toEqual(takodachi)
+    .listen(300)

example/a.ts

@@ -2,6 +2,10 @@ import { Elysia } from 'elysia'
 
 import { staticPlugin } from '../src/index'
 
+const a = async () => {
+    return new Elysia()
+}
+
 const app = new Elysia()
     .use(
         staticPlugin({
@@ -14,9 +18,8 @@ const app = new Elysia()
             prefix: '/public'
         })
     )
-    .listen(8080)
+    .listen(3000)
 
 await app.modules
 
-// @ts-ignore
-console.log(app.router.history)
+console.log(app.routes)

example/bench.ts

@@ -1,6 +1,6 @@
 {
   "name": "@elysiajs/static",
-  "version": "0.5.3",
+  "version": "0.7.1",
   "author": {
     "name": "saltyAom",
     "url": "https://github.com/SaltyAom",
@@ -13,15 +13,14 @@
   "main": "./dist/index.js",
   "devDependencies": {
     "@types/node": "^20.1.4",
-    "bun-types": "^0.5.8",
-    "elysia": "0.5.12",
+    "bun-types": "^1.0.2",
+    "elysia": "^0.7.9",
     "eslint": "^8.40.0",
-    "mitata": "^0.1.6",
-    "rimraf": "4.3",
-    "typescript": "^5.0.4"
+    "rimraf": "4.4.1",
+    "typescript": "^5.2.2"
   },
   "peerDependencies": {
-    "elysia": ">= 0.5.12"
+    "elysia": ">= 0.7.9"
   },
   "exports": {
     "bun": "./dist/index.js",
@@ -41,7 +40,7 @@
   "license": "MIT",
   "scripts": {
     "dev": "bun run --hot example/index.ts",
-    "test": "bun wiptest && npm run test:node",
+    "test": "bun test && npm run test:node",
     "test:node": "npm install --prefix ./test/node/cjs/ && npm install --prefix ./test/node/esm/ && node ./test/node/cjs/index.js && node ./test/node/esm/index.js",
     "build": "rimraf dist && tsc --project tsconfig.esm.json && tsc --project tsconfig.cjs.json",
     "release": "npm run build && npm run test && npm publish --access public"

example/index.ts

@@ -1,9 +1,9 @@
-import type { Elysia } from 'elysia'
+import { NotFoundError, Elysia } from 'elysia'
 
 import { readdir, stat } from 'fs/promises'
 import { resolve, resolve as resolveFn, join } from 'path'
 
-const getFiles = async (dir: string): Promise<string[]> => {
+const listFiles = async (dir: string): Promise<string[]> => {
     const files = await readdir(dir)
 
     const all = await Promise.all(
@@ -12,7 +12,7 @@ const getFiles = async (dir: string): Promise<string[]> => {
             const stats = await stat(file)
 
             return stats && stats.isDirectory()
-                ? await getFiles(file)
+                ? await listFiles(file)
                 : [resolve(dir, file)]
         })
     )
@@ -28,7 +28,8 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
         alwaysStatic = false,
         ignorePatterns = ['.DS_Store', '.git', '.env'],
         noExtension = false,
-        resolve = resolveFn
+        resolve = resolveFn,
+        headers = {}
     }: {
         /**
          * @default "public"
@@ -74,17 +75,22 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
          * Nodejs resolve function
          */
         resolve?: (...pathSegments: string[]) => string
+        /**
+         * Set headers
+         */
+        headers?: Record<string, string> | undefined
     } = {
         assets: 'public',
         prefix: '/public' as Prefix,
         staticLimit: 1024,
         alwaysStatic: process.env.NODE_ENV === 'production',
         ignorePatterns: [],
         noExtension: false,
-        resolve: resolveFn
+        resolve: resolveFn,
+        headers: {}
     }
 ) => {
-    const files = await getFiles(resolveFn(assets))
+    const files = await listFiles(resolveFn(assets))
 
     if (prefix === '/') prefix = '' as Prefix
 
@@ -97,58 +103,71 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
         })
     }
 
-    return (app: Elysia) => {
-        if (
-            alwaysStatic ||
-            (process.env.ENV === 'production' && files.length <= staticLimit)
-        )
-            for (let i = 0; i < files.length; i++) {
-                const file = files[i]
-                if (shouldIgnore(file)) continue
+    const app = new Elysia({
+        name: 'static',
+        seed: {
+            assets,
+            prefix,
+            staticLimit,
+            alwaysStatic,
+            ignorePatterns,
+            noExtension,
+            resolve: resolve.toString()
+        }
+    })
+
+    if (
+        alwaysStatic ||
+        (process.env.ENV === 'production' && files.length <= staticLimit)
+    )
+        for (let i = 0; i < files.length; i++) {
+            const file = files[i]
+            if (!file || shouldIgnore(file)) continue
 
-                const response = () => new Response(Bun.file(file))
-                let fileName = file
-                    .replace(resolve(), '')
-                    .replace(`${assets}/`, '')
+            const response = Object.keys(headers).length
+                ? () =>
+                      new Response(Bun.file(file), {
+                          headers
+                      })
+                : () => new Response(Bun.file(file))
 
-                if (noExtension) {
-                    const temp = fileName.split('.')
-                    temp.splice(-1)
+            let fileName = file.replace(resolve(), '').replace(`${assets}/`, '')
 
-                    fileName = temp.join('.')
-                }
+            if (noExtension) {
+                const temp = fileName.split('.')
+                temp.splice(-1)
 
-                app.get(join(prefix, fileName), response)
+                fileName = temp.join('.')
             }
-        else {
-            if (
-                // @ts-ignore
-                !app.routes.find(
-                    ({ method, path }) =>
-                        path === `${prefix}/*` && method === 'GET'
-                )
-            )
-                app.get(`${prefix}/*`, (c) => {
-                    const file = `${assets}/${(c.params as any)['*']}`
-
-                    if (shouldIgnore(file))
-                        return new Response('NOT_FOUND', {
-                            status: 404
-                        })
-
-                    return stat(file)
-                        .then((status) => new Response(Bun.file(file)))
-                        .catch(
-                            (error) =>
-                                new Response('NOT_FOUND', {
-                                    status: 404
-                                })
-                        )
-                })
-        }
 
-        return app
+            app.get(join(prefix, fileName), response)
+        }
+    else {
+        if (
+            // @ts-ignore
+            !app.routes.find(
+                ({ method, path }) => path === `${prefix}/*` && method === 'GET'
+            )
+        )
+            app.onError(() => {}).get(`${prefix}/*`, async ({ params }) => {
+                const file = `${assets}/${(params as any)['*']}`
+
+                if (shouldIgnore(file)) throw new NotFoundError()
+
+                return stat(file)
+                    .then(
+                        (status) =>
+                            new Response(Bun.file(file), {
+                                headers
+                            })
+                    )
+                    .catch((error) => {
+                        throw new NotFoundError()
+                    })
+            })
     }
+
+    return app
 }
 
 export default staticPlugin

package.json

@@ -95,7 +95,7 @@ describe('Static Plugin', () => {
     })
 
     it('ignore string pattern', async () => {
-        const app = new Elysia().use(
+        const app = new Elysia({ forceErrorEncapsulation: true }).use(
             staticPlugin({
                 ignorePatterns: ['public/takodachi.png']
             })
@@ -104,17 +104,15 @@ describe('Static Plugin', () => {
         await app.modules
 
         const res = await app.handle(req('/public/takodachi.png'))
-        const blob = await res.blob()
-        expect(await blob.text()).toBe('NOT_FOUND')
+        expect(res.status).toBe(404)
     })
 
     it('ignore regex pattern', async () => {
-        const app = new Elysia()
-            .use(
-                staticPlugin({
-                    ignorePatterns: [/takodachi.png$/]
-                })
-            )
+        const app = new Elysia().use(
+            staticPlugin({
+                ignorePatterns: [/takodachi.png$/]
+            })
+        )
 
         const file = await app.handle(req('/public/takodachi.png'))
 
@@ -155,4 +153,43 @@ describe('Static Plugin', () => {
 
         expect(res).toBe(takodachi)
     })
+
+    it('return custom headers', async () => {
+        const app = new Elysia().use(
+            staticPlugin({
+                alwaysStatic: true,
+                noExtension: true,
+                headers: {
+                    ['x-powered-by']: 'Takodachi'
+                }
+            })
+        )
+
+        await app.modules
+
+        const res = await app.handle(req('/public/takodachi'))
+
+        expect(res.headers.get('x-powered-by')).toBe('Takodachi')
+        expect(res.status).toBe(200)
+    })
+
+    it('call onError when using dynamic mode', async () => {
+        let called = false
+
+        const app = new Elysia()
+            .onError(({ code }) => {
+                if (code === 'NOT_FOUND') called = true
+            })
+            .use(
+                staticPlugin({
+                    alwaysStatic: false
+                })
+            )
+
+        await app.modules
+
+        const res = await app.handle(req('/public/not-found'))
+
+        expect(called).toBe(true)
+    })
 })

src/index.ts

@@ -90,7 +90,7 @@
     // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
     // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
     // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
     // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
     // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
     // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */