@eggjs/static 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+# @eggjs/static
+
+[![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/eggjs/static/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/static/actions/workflows/nodejs.yml)
+[![Test coverage][codecov-image]][codecov-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/static.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/static.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/static
+[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/static.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/eggjs/static?branch=master
+[snyk-image]: https://snyk.io/test/npm/@eggjs/static/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/@eggjs/static
+[download-image]: https://img.shields.io/npm/dm/@eggjs/static.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/static
+
+Static server plugin for egg, base on [@eggjs/koa-static-cache](https://github.com/eggjs/koa-static-cache).
+
+## Install
+
+`@eggjs/static` is a plugin that has been built-in for egg. It is enabled by default.
+
+## Configuration
+
+`@eggjs/static` support all configurations in [@eggjs/koa-static-cache](https://github.com/eggjs/koa-static-cache).
+And with default configurations below:
+
+- prefix: `'/public/'`
+- dir: `path.join(appInfo.baseDir, 'app/public')`
+- dynamic: `true`
+- preload: `false`
+- maxAge: `31536000` in prod env, `0` in other envs
+- buffer: `true` in prod env, `false` in other envs
+
+`@eggjs/static` provides one more option:
+
+- maxFiles: the maximum value of cache items, only effective when dynamic is true, default is `1000`.
+
+**All static files in `$baseDir/app/public` can be visited with prefix `/public`, and all the files are lazy loaded.**
+
+- In non-production environment, assets won't be cached, your modification can take effect immediately.
+- In production environment, `@eggjs/static` will cache the assets after visited, you need to restart the process to update the assets.
+- Dir default is `$baseDir/app/public` but you can also define **multiple directory** by use `dir: [dir1, dir2, ...]` or `dir: [dir1, { prefix: '/static2', dir: dir2 }]`, static server will use all these directories.
+
+```ts
+// {app_root}/config/config.default.ts
+export default {
+  static: {
+    // maxAge: 31536000,
+  },
+};
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/static)](https://github.com/eggjs/static/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/app/middleware/static.d.ts

@@ -0,0 +1,5 @@
+import compose from 'koa-compose';
+import type { EggCore, Context } from '@eggjs/core';
+import type { StaticConfig } from '../../types.js';
+declare const _default: (options: StaticConfig, app: EggCore) => compose.ComposedMiddleware<Context>;
+export default _default;

package/dist/commonjs/app/middleware/static.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_fs_1 = require("node:fs");
+const koa_range_1 = __importDefault(require("koa-range"));
+const koa_compose_1 = __importDefault(require("koa-compose"));
+const koa_static_cache_1 = require("@eggjs/koa-static-cache");
+const ylru_1 = require("ylru");
+const is_type_of_1 = require("is-type-of");
+exports.default = (options, app) => {
+    const dirs = (options.dirs ?? []).concat(options.dir);
+    const prefixes = [];
+    function rangeMiddleware(ctx, next) {
+        // if match static file, and use range middleware.
+        const isMatch = prefixes.some(p => ctx.path.startsWith(p));
+        if (isMatch) {
+            return (0, koa_range_1.default)(ctx, next);
+        }
+        return next();
+    }
+    const middlewares = [rangeMiddleware];
+    for (const dirObj of dirs) {
+        (0, node_assert_1.default)((0, is_type_of_1.isObject)(dirObj) || typeof dirObj === 'string', '`config.static.dir` must be `string | Array<string|object>`');
+        let newOptions;
+        if (typeof dirObj === 'string') {
+            // copy origin options to new options ensure the safety of objects
+            newOptions = {
+                ...options,
+                dir: dirObj,
+            };
+        }
+        else {
+            (0, node_assert_1.default)(typeof dirObj.dir === 'string', '`config.static.dirs` should contains `[].dir` property when object style');
+            newOptions = {
+                ...options,
+                ...dirObj,
+            };
+        }
+        if (newOptions.dynamic && !newOptions.files) {
+            newOptions.files = new ylru_1.LRU(newOptions.maxFiles);
+        }
+        if (newOptions.prefix) {
+            prefixes.push(newOptions.prefix);
+        }
+        // ensure directory exists
+        if (!(0, node_fs_1.existsSync)(newOptions.dir)) {
+            (0, node_fs_1.mkdirSync)(newOptions.dir, { recursive: true });
+        }
+        middlewares.push((0, koa_static_cache_1.staticCache)(newOptions));
+        app.coreLogger.info('[@eggjs/static] starting static serve %s -> %s', newOptions.prefix, newOptions.dir);
+    }
+    return (0, koa_compose_1.default)(middlewares);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdGljLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9taWRkbGV3YXJlL3N0YXRpYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDhEQUFpQztBQUNqQyxxQ0FBZ0Q7QUFDaEQsMERBQThCO0FBQzlCLDhEQUFrQztBQUVsQyw4REFBc0Q7QUFDdEQsK0JBQTJCO0FBQzNCLDJDQUFzQztBQUd0QyxrQkFBZSxDQUFDLE9BQXFCLEVBQUUsR0FBWSxFQUFFLEVBQUU7SUFDckQsTUFBTSxJQUFJLEdBQUcsQ0FBQyxPQUFPLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7SUFFdEQsTUFBTSxRQUFRLEdBQWEsRUFBRSxDQUFDO0lBRTlCLFNBQVMsZUFBZSxDQUFDLEdBQVksRUFBRSxJQUFVO1FBQy9DLGtEQUFrRDtRQUNsRCxNQUFNLE9BQU8sR0FBRyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUMzRCxJQUFJLE9BQU8sRUFBRSxDQUFDO1lBQ1osT0FBTyxJQUFBLG1CQUFLLEVBQUMsR0FBVSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ2pDLENBQUM7UUFDRCxPQUFPLElBQUksRUFBRSxDQUFDO0lBQ2hCLENBQUM7SUFFRCxNQUFNLFdBQVcsR0FBRyxDQUFFLGVBQWUsQ0FBRSxDQUFDO0lBRXhDLEtBQUssTUFBTSxNQUFNLElBQUksSUFBSSxFQUFFLENBQUM7UUFDMUIsSUFBQSxxQkFBTSxFQUFDLElBQUEscUJBQVEsRUFBQyxNQUFNLENBQUMsSUFBSSxPQUFPLE1BQU0sS0FBSyxRQUFRLEVBQ25ELDZEQUE2RCxDQUFDLENBQUM7UUFFakUsSUFBSSxVQUE0QixDQUFDO1FBQ2pDLElBQUksT0FBTyxNQUFNLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDL0Isa0VBQWtFO1lBQ2xFLFVBQVUsR0FBRztnQkFDWCxHQUFHLE9BQU87Z0JBQ1YsR0FBRyxFQUFFLE1BQU07YUFDWixDQUFDO1FBQ0osQ0FBQzthQUFNLENBQUM7WUFDTixJQUFBLHFCQUFNLEVBQUMsT0FBTyxNQUFNLENBQUMsR0FBRyxLQUFLLFFBQVEsRUFDbkMsMEVBQTBFLENBQUMsQ0FBQztZQUM5RSxVQUFVLEdBQUc7Z0JBQ1gsR0FBRyxPQUFPO2dCQUNWLEdBQUcsTUFBTTthQUNWLENBQUM7UUFDSixDQUFDO1FBRUQsSUFBSSxVQUFVLENBQUMsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQzVDLFVBQVUsQ0FBQyxLQUFLLEdBQUcsSUFBSSxVQUFHLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQ2xELENBQUM7UUFFRCxJQUFJLFVBQVUsQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUN0QixRQUFRLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUNuQyxDQUFDO1FBRUQsMEJBQTBCO1FBQzFCLElBQUksQ0FBQyxJQUFBLG9CQUFVLEVBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDaEMsSUFBQSxtQkFBUyxFQUFDLFVBQVUsQ0FBQyxHQUFHLEVBQUUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztRQUNqRCxDQUFDO1FBQ0QsV0FBVyxDQUFDLElBQUksQ0FBQyxJQUFBLDhCQUFXLEVBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztRQUV6QyxHQUFXLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxnREFBZ0QsRUFDM0UsVUFBVSxDQUFDLE1BQU0sRUFBRSxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDdkMsQ0FBQztJQUVELE9BQU8sSUFBQSxxQkFBTyxFQUFDLFdBQVcsQ0FBQyxDQUFDO0FBQzlCLENBQUMsQ0FBQyJ9

package/dist/commonjs/app.d.ts

@@ -0,0 +1,6 @@
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+export default class AppBoot implements ILifecycleBoot {
+    private readonly app;
+    constructor(app: EggCore);
+    configWillLoad(): Promise<void>;
+}

package/dist/commonjs/app.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AppBoot {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async configWillLoad() {
+        const app = this.app;
+        // make sure static middleware is before bodyParser
+        const index = app.config.coreMiddleware.indexOf('bodyParser');
+        if (index === -1) {
+            app.config.coreMiddleware.push('static');
+        }
+        else {
+            app.config.coreMiddleware.splice(index, 0, 'static');
+        }
+    }
+}
+exports.default = AppBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUVBLE1BQXFCLE9BQU87SUFDVCxHQUFHLENBQUM7SUFDckIsWUFBWSxHQUFZO1FBQ3RCLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO0lBQ2pCLENBQUM7SUFDRCxLQUFLLENBQUMsY0FBYztRQUNsQixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDO1FBQ3JCLG1EQUFtRDtRQUNuRCxNQUFNLEtBQUssR0FBRyxHQUFHLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDOUQsSUFBSSxLQUFLLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQztZQUNqQixHQUFHLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDM0MsQ0FBQzthQUFNLENBQUM7WUFDTixHQUFHLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUMsRUFBRSxRQUFRLENBQUMsQ0FBQztRQUN2RCxDQUFDO0lBQ0gsQ0FBQztDQUNGO0FBZkQsMEJBZUMifQ==

package/dist/commonjs/config/config.default.d.ts

@@ -0,0 +1,6 @@
+import type { EggAppInfo } from '@eggjs/core';
+import type { StaticConfig } from '../types.js';
+declare const _default: (appInfo: EggAppInfo) => {
+    static: StaticConfig;
+};
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+exports.default = (appInfo) => {
+    return {
+        static: {
+            prefix: '/public/',
+            dir: node_path_1.default.join(appInfo.baseDir, 'app/public'),
+            // dirs: [ dir1, dir2 ] or [ dir1, { prefix: '/static2', dir: dir2 } ],
+            dirs: undefined,
+            // support lazy load
+            dynamic: true,
+            preload: false,
+            buffer: false,
+            maxFiles: 1000,
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsMERBQTZCO0FBSTdCLGtCQUFlLENBQUMsT0FBbUIsRUFBRSxFQUFFO0lBQ3JDLE9BQU87UUFDTCxNQUFNLEVBQUU7WUFDTixNQUFNLEVBQUUsVUFBVTtZQUNsQixHQUFHLEVBQUUsbUJBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxZQUFZLENBQUM7WUFDN0MsdUVBQXVFO1lBQ3ZFLElBQUksRUFBRSxTQUFTO1lBQ2Ysb0JBQW9CO1lBQ3BCLE9BQU8sRUFBRSxJQUFJO1lBQ2IsT0FBTyxFQUFFLEtBQUs7WUFDZCxNQUFNLEVBQUUsS0FBSztZQUNiLFFBQVEsRUFBRSxJQUFJO1NBQ0M7S0FDbEIsQ0FBQztBQUNKLENBQUMsQ0FBQyJ9

package/dist/commonjs/config/config.prod.d.ts

@@ -0,0 +1,5 @@
+import type { StaticConfig } from '../types.js';
+declare const _default: {
+    static: StaticConfig;
+};
+export default _default;

package/dist/commonjs/config/config.prod.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    static: {
+        maxAge: 31536000,
+        buffer: true,
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLnByb2QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5wcm9kLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBRUEsa0JBQWU7SUFDYixNQUFNLEVBQUU7UUFDTixNQUFNLEVBQUUsUUFBUTtRQUNoQixNQUFNLEVBQUUsSUFBSTtLQUNHO0NBQ2xCLENBQUMifQ==

package/dist/commonjs/index.d.ts

@@ -0,0 +1 @@
+import './types.js';

package/dist/commonjs/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("./types.js");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzQkFBb0IifQ==

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/types.d.ts

@@ -0,0 +1,60 @@
+import type { Options as StaticCacheOptions } from '@eggjs/koa-static-cache';
+export interface StaticDirOptions extends Omit<StaticCacheOptions, 'dir'> {
+    /**
+     * static files store dir
+     */
+    dir: string;
+    /**
+     * static files prefix
+     * Default to `'/public/'`
+     */
+    prefix: string;
+    /**
+     * cache max age in `seconds`
+     * Default to `0` on development, `31536000` on production
+     */
+    maxAge: number;
+    /**
+     * dynamic load file which not cached on initialization
+     * Default to `true
+     */
+    dynamic: boolean;
+    /**
+     * caches the assets on initialization or not,
+     * always work together with `options.dynamic`
+     * Default to `false`
+     */
+    preload: boolean;
+    /**
+     * buffer the file content or not
+     * Default to `false` on development, `true` on production
+     */
+    buffer: boolean;
+    /**
+     * max files count in store
+     * Default to `1000`
+     */
+    maxFiles: number;
+}
+/**
+ * Static file serve
+ * @member Config#static
+ * @see https://github.com/koajs/static-cache
+ */
+export interface StaticConfig extends Omit<StaticDirOptions, 'dir'> {
+    /**
+     * static files store dir
+     * Default to `${baseDir}/app/public`
+     */
+    dir: string | Array<string | StaticDirOptions>;
+    /**
+     * static files store dirs
+     * @deprecated use `dir` instead
+     */
+    dirs?: Array<string | StaticDirOptions>;
+}
+declare module '@eggjs/core' {
+    interface EggAppConfig {
+        static: StaticConfig;
+    }
+}

package/dist/commonjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/esm/app/middleware/static.d.ts

@@ -0,0 +1,5 @@
+import compose from 'koa-compose';
+import type { EggCore, Context } from '@eggjs/core';
+import type { StaticConfig } from '../../types.js';
+declare const _default: (options: StaticConfig, app: EggCore) => compose.ComposedMiddleware<Context>;
+export default _default;

package/dist/esm/app/middleware/static.js

@@ -0,0 +1,52 @@
+import assert from 'node:assert';
+import { mkdirSync, existsSync } from 'node:fs';
+import range from 'koa-range';
+import compose from 'koa-compose';
+import { staticCache } from '@eggjs/koa-static-cache';
+import { LRU } from 'ylru';
+import { isObject } from 'is-type-of';
+export default (options, app) => {
+    const dirs = (options.dirs ?? []).concat(options.dir);
+    const prefixes = [];
+    function rangeMiddleware(ctx, next) {
+        // if match static file, and use range middleware.
+        const isMatch = prefixes.some(p => ctx.path.startsWith(p));
+        if (isMatch) {
+            return range(ctx, next);
+        }
+        return next();
+    }
+    const middlewares = [rangeMiddleware];
+    for (const dirObj of dirs) {
+        assert(isObject(dirObj) || typeof dirObj === 'string', '`config.static.dir` must be `string | Array<string|object>`');
+        let newOptions;
+        if (typeof dirObj === 'string') {
+            // copy origin options to new options ensure the safety of objects
+            newOptions = {
+                ...options,
+                dir: dirObj,
+            };
+        }
+        else {
+            assert(typeof dirObj.dir === 'string', '`config.static.dirs` should contains `[].dir` property when object style');
+            newOptions = {
+                ...options,
+                ...dirObj,
+            };
+        }
+        if (newOptions.dynamic && !newOptions.files) {
+            newOptions.files = new LRU(newOptions.maxFiles);
+        }
+        if (newOptions.prefix) {
+            prefixes.push(newOptions.prefix);
+        }
+        // ensure directory exists
+        if (!existsSync(newOptions.dir)) {
+            mkdirSync(newOptions.dir, { recursive: true });
+        }
+        middlewares.push(staticCache(newOptions));
+        app.coreLogger.info('[@eggjs/static] starting static serve %s -> %s', newOptions.prefix, newOptions.dir);
+    }
+    return compose(middlewares);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdGljLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9taWRkbGV3YXJlL3N0YXRpYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLE1BQU0sTUFBTSxhQUFhLENBQUM7QUFDakMsT0FBTyxFQUFFLFNBQVMsRUFBRSxVQUFVLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFDaEQsT0FBTyxLQUFLLE1BQU0sV0FBVyxDQUFDO0FBQzlCLE9BQU8sT0FBTyxNQUFNLGFBQWEsQ0FBQztBQUVsQyxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFDdEQsT0FBTyxFQUFFLEdBQUcsRUFBRSxNQUFNLE1BQU0sQ0FBQztBQUMzQixPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBR3RDLGVBQWUsQ0FBQyxPQUFxQixFQUFFLEdBQVksRUFBRSxFQUFFO0lBQ3JELE1BQU0sSUFBSSxHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBRXRELE1BQU0sUUFBUSxHQUFhLEVBQUUsQ0FBQztJQUU5QixTQUFTLGVBQWUsQ0FBQyxHQUFZLEVBQUUsSUFBVTtRQUMvQyxrREFBa0Q7UUFDbEQsTUFBTSxPQUFPLEdBQUcsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDM0QsSUFBSSxPQUFPLEVBQUUsQ0FBQztZQUNaLE9BQU8sS0FBSyxDQUFDLEdBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNqQyxDQUFDO1FBQ0QsT0FBTyxJQUFJLEVBQUUsQ0FBQztJQUNoQixDQUFDO0lBRUQsTUFBTSxXQUFXLEdBQUcsQ0FBRSxlQUFlLENBQUUsQ0FBQztJQUV4QyxLQUFLLE1BQU0sTUFBTSxJQUFJLElBQUksRUFBRSxDQUFDO1FBQzFCLE1BQU0sQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksT0FBTyxNQUFNLEtBQUssUUFBUSxFQUNuRCw2REFBNkQsQ0FBQyxDQUFDO1FBRWpFLElBQUksVUFBNEIsQ0FBQztRQUNqQyxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQy9CLGtFQUFrRTtZQUNsRSxVQUFVLEdBQUc7Z0JBQ1gsR0FBRyxPQUFPO2dCQUNWLEdBQUcsRUFBRSxNQUFNO2FBQ1osQ0FBQztRQUNKLENBQUM7YUFBTSxDQUFDO1lBQ04sTUFBTSxDQUFDLE9BQU8sTUFBTSxDQUFDLEdBQUcsS0FBSyxRQUFRLEVBQ25DLDBFQUEwRSxDQUFDLENBQUM7WUFDOUUsVUFBVSxHQUFHO2dCQUNYLEdBQUcsT0FBTztnQkFDVixHQUFHLE1BQU07YUFDVixDQUFDO1FBQ0osQ0FBQztRQUVELElBQUksVUFBVSxDQUFDLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUM1QyxVQUFVLENBQUMsS0FBSyxHQUFHLElBQUksR0FBRyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUNsRCxDQUFDO1FBRUQsSUFBSSxVQUFVLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDdEIsUUFBUSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDbkMsQ0FBQztRQUVELDBCQUEwQjtRQUMxQixJQUFJLENBQUMsVUFBVSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ2hDLFNBQVMsQ0FBQyxVQUFVLENBQUMsR0FBRyxFQUFFLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7UUFDakQsQ0FBQztRQUNELFdBQVcsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUM7UUFFekMsR0FBVyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsZ0RBQWdELEVBQzNFLFVBQVUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ3ZDLENBQUM7SUFFRCxPQUFPLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUM5QixDQUFDLENBQUMifQ==

package/dist/esm/app.d.ts

@@ -0,0 +1,6 @@
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+export default class AppBoot implements ILifecycleBoot {
+    private readonly app;
+    constructor(app: EggCore);
+    configWillLoad(): Promise<void>;
+}

package/dist/esm/app.js

@@ -0,0 +1,18 @@
+export default class AppBoot {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async configWillLoad() {
+        const app = this.app;
+        // make sure static middleware is before bodyParser
+        const index = app.config.coreMiddleware.indexOf('bodyParser');
+        if (index === -1) {
+            app.config.coreMiddleware.push('static');
+        }
+        else {
+            app.config.coreMiddleware.splice(index, 0, 'static');
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxNQUFNLENBQUMsT0FBTyxPQUFPLE9BQU87SUFDVCxHQUFHLENBQUM7SUFDckIsWUFBWSxHQUFZO1FBQ3RCLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO0lBQ2pCLENBQUM7SUFDRCxLQUFLLENBQUMsY0FBYztRQUNsQixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDO1FBQ3JCLG1EQUFtRDtRQUNuRCxNQUFNLEtBQUssR0FBRyxHQUFHLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDOUQsSUFBSSxLQUFLLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQztZQUNqQixHQUFHLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDM0MsQ0FBQzthQUFNLENBQUM7WUFDTixHQUFHLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUMsRUFBRSxRQUFRLENBQUMsQ0FBQztRQUN2RCxDQUFDO0lBQ0gsQ0FBQztDQUNGIn0=

package/dist/esm/config/config.default.d.ts

@@ -0,0 +1,6 @@
+import type { EggAppInfo } from '@eggjs/core';
+import type { StaticConfig } from '../types.js';
+declare const _default: (appInfo: EggAppInfo) => {
+    static: StaticConfig;
+};
+export default _default;

package/dist/esm/config/config.default.js

@@ -0,0 +1,17 @@
+import path from 'node:path';
+export default (appInfo) => {
+    return {
+        static: {
+            prefix: '/public/',
+            dir: path.join(appInfo.baseDir, 'app/public'),
+            // dirs: [ dir1, dir2 ] or [ dir1, { prefix: '/static2', dir: dir2 } ],
+            dirs: undefined,
+            // support lazy load
+            dynamic: true,
+            preload: false,
+            buffer: false,
+            maxFiles: 1000,
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUk3QixlQUFlLENBQUMsT0FBbUIsRUFBRSxFQUFFO0lBQ3JDLE9BQU87UUFDTCxNQUFNLEVBQUU7WUFDTixNQUFNLEVBQUUsVUFBVTtZQUNsQixHQUFHLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLFlBQVksQ0FBQztZQUM3Qyx1RUFBdUU7WUFDdkUsSUFBSSxFQUFFLFNBQVM7WUFDZixvQkFBb0I7WUFDcEIsT0FBTyxFQUFFLElBQUk7WUFDYixPQUFPLEVBQUUsS0FBSztZQUNkLE1BQU0sRUFBRSxLQUFLO1lBQ2IsUUFBUSxFQUFFLElBQUk7U0FDQztLQUNsQixDQUFDO0FBQ0osQ0FBQyxDQUFDIn0=

package/dist/esm/config/config.prod.d.ts

@@ -0,0 +1,5 @@
+import type { StaticConfig } from '../types.js';
+declare const _default: {
+    static: StaticConfig;
+};
+export default _default;

package/dist/esm/config/config.prod.js

@@ -0,0 +1,7 @@
+export default {
+    static: {
+        maxAge: 31536000,
+        buffer: true,
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLnByb2QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5wcm9kLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLGVBQWU7SUFDYixNQUFNLEVBQUU7UUFDTixNQUFNLEVBQUUsUUFBUTtRQUNoQixNQUFNLEVBQUUsSUFBSTtLQUNHO0NBQ2xCLENBQUMifQ==

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+import './types.js';

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+import './types.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUMifQ==

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/types.d.ts

@@ -0,0 +1,60 @@
+import type { Options as StaticCacheOptions } from '@eggjs/koa-static-cache';
+export interface StaticDirOptions extends Omit<StaticCacheOptions, 'dir'> {
+    /**
+     * static files store dir
+     */
+    dir: string;
+    /**
+     * static files prefix
+     * Default to `'/public/'`
+     */
+    prefix: string;
+    /**
+     * cache max age in `seconds`
+     * Default to `0` on development, `31536000` on production
+     */
+    maxAge: number;
+    /**
+     * dynamic load file which not cached on initialization
+     * Default to `true
+     */
+    dynamic: boolean;
+    /**
+     * caches the assets on initialization or not,
+     * always work together with `options.dynamic`
+     * Default to `false`
+     */
+    preload: boolean;
+    /**
+     * buffer the file content or not
+     * Default to `false` on development, `true` on production
+     */
+    buffer: boolean;
+    /**
+     * max files count in store
+     * Default to `1000`
+     */
+    maxFiles: number;
+}
+/**
+ * Static file serve
+ * @member Config#static
+ * @see https://github.com/koajs/static-cache
+ */
+export interface StaticConfig extends Omit<StaticDirOptions, 'dir'> {
+    /**
+     * static files store dir
+     * Default to `${baseDir}/app/public`
+     */
+    dir: string | Array<string | StaticDirOptions>;
+    /**
+     * static files store dirs
+     * @deprecated use `dir` instead
+     */
+    dirs?: Array<string | StaticDirOptions>;
+}
+declare module '@eggjs/core' {
+    interface EggAppConfig {
+        static: StaticConfig;
+    }
+}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@eggjs/static",
+  "version": "3.0.0"
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@eggjs/static",
+  "version": "3.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "static server plugin for egg",
+  "eggPlugin": {
+    "name": "static",
+    "exports": {
+      "import": "./dist/esm",
+      "require": "./dist/commonjs",
+      "typescript": "./src"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eggjs/static.git"
+  },
+  "keywords": [
+    "egg",
+    "egg-plugin",
+    "eggPlugin",
+    "static"
+  ],
+  "author": "dead_horse",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 18.19.0"
+  },
+  "dependencies": {
+    "@eggjs/core": "^6.2.13",
+    "@eggjs/koa-static-cache": "^6.0.0",
+    "is-type-of": "^2.2.0",
+    "koa-compose": "^4.1.0",
+    "koa-range": "^0.3.0",
+    "ylru": "^2.0.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.1",
+    "@eggjs/bin": "7",
+    "@eggjs/mock": "^6.0.5",
+    "@eggjs/tsconfig": "1",
+    "@types/koa-compose": "^3.2.8",
+    "@types/koa-range": "^0.3.5",
+    "@types/mocha": "10",
+    "@types/node": "22",
+    "egg": "4",
+    "eslint": "8",
+    "eslint-config-egg": "14",
+    "rimraf": "6",
+    "tshy": "3",
+    "tshy-after": "1",
+    "typescript": "5"
+  },
+  "scripts": {
+    "lint": "eslint --cache src test --ext .ts",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "egg-bin test",
+    "preci": "npm run clean &&  npm run lint",
+    "ci": "egg-bin cov",
+    "postci": "npm run prepublishOnly && npm run clean",
+    "clean": "rimraf dist",
+    "prepublishOnly": "tshy && tshy-after && attw --pack"
+  },
+  "type": "module",
+  "tshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json"
+    }
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "types": "./dist/commonjs/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/esm/index.js"
+}

package/src/app/middleware/static.ts

@@ -0,0 +1,66 @@
+import assert from 'node:assert';
+import { mkdirSync, existsSync } from 'node:fs';
+import range from 'koa-range';
+import compose from 'koa-compose';
+import type { EggCore, Context, Next } from '@eggjs/core';
+import { staticCache } from '@eggjs/koa-static-cache';
+import { LRU } from 'ylru';
+import { isObject } from 'is-type-of';
+import type { StaticConfig, StaticDirOptions } from '../../types.js';
+
+export default (options: StaticConfig, app: EggCore) => {
+  const dirs = (options.dirs ?? []).concat(options.dir);
+
+  const prefixes: string[] = [];
+
+  function rangeMiddleware(ctx: Context, next: Next) {
+    // if match static file, and use range middleware.
+    const isMatch = prefixes.some(p => ctx.path.startsWith(p));
+    if (isMatch) {
+      return range(ctx as any, next);
+    }
+    return next();
+  }
+
+  const middlewares = [ rangeMiddleware ];
+
+  for (const dirObj of dirs) {
+    assert(isObject(dirObj) || typeof dirObj === 'string',
+      '`config.static.dir` must be `string | Array<string|object>`');
+
+    let newOptions: StaticDirOptions;
+    if (typeof dirObj === 'string') {
+      // copy origin options to new options ensure the safety of objects
+      newOptions = {
+        ...options,
+        dir: dirObj,
+      };
+    } else {
+      assert(typeof dirObj.dir === 'string',
+        '`config.static.dirs` should contains `[].dir` property when object style');
+      newOptions = {
+        ...options,
+        ...dirObj,
+      };
+    }
+
+    if (newOptions.dynamic && !newOptions.files) {
+      newOptions.files = new LRU(newOptions.maxFiles);
+    }
+
+    if (newOptions.prefix) {
+      prefixes.push(newOptions.prefix);
+    }
+
+    // ensure directory exists
+    if (!existsSync(newOptions.dir)) {
+      mkdirSync(newOptions.dir, { recursive: true });
+    }
+    middlewares.push(staticCache(newOptions));
+
+    (app as any).coreLogger.info('[@eggjs/static] starting static serve %s -> %s',
+      newOptions.prefix, newOptions.dir);
+  }
+
+  return compose(middlewares);
+};

package/src/app.ts

@@ -0,0 +1,18 @@
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+
+export default class AppBoot implements ILifecycleBoot {
+  private readonly app;
+  constructor(app: EggCore) {
+    this.app = app;
+  }
+  async configWillLoad() {
+    const app = this.app;
+    // make sure static middleware is before bodyParser
+    const index = app.config.coreMiddleware.indexOf('bodyParser');
+    if (index === -1) {
+      app.config.coreMiddleware.push('static');
+    } else {
+      app.config.coreMiddleware.splice(index, 0, 'static');
+    }
+  }
+}

package/src/config/config.default.ts

@@ -0,0 +1,19 @@
+import path from 'node:path';
+import type { EggAppInfo } from '@eggjs/core';
+import type { StaticConfig } from '../types.js';
+
+export default (appInfo: EggAppInfo) => {
+  return {
+    static: {
+      prefix: '/public/',
+      dir: path.join(appInfo.baseDir, 'app/public'),
+      // dirs: [ dir1, dir2 ] or [ dir1, { prefix: '/static2', dir: dir2 } ],
+      dirs: undefined,
+      // support lazy load
+      dynamic: true,
+      preload: false,
+      buffer: false,
+      maxFiles: 1000,
+    } as StaticConfig,
+  };
+};

package/src/config/config.prod.ts

@@ -0,0 +1,8 @@
+import type { StaticConfig } from '../types.js';
+
+export default {
+  static: {
+    maxAge: 31536000,
+    buffer: true,
+  } as StaticConfig,
+};

package/src/index.ts

@@ -0,0 +1 @@
+import './types.js';

package/src/types.ts

@@ -0,0 +1,64 @@
+import type { Options as StaticCacheOptions } from '@eggjs/koa-static-cache';
+
+export interface StaticDirOptions extends Omit<StaticCacheOptions, 'dir'> {
+  /**
+   * static files store dir
+   */
+  dir: string;
+  /**
+   * static files prefix
+   * Default to `'/public/'`
+   */
+  prefix: string;
+  /**
+   * cache max age in `seconds`
+   * Default to `0` on development, `31536000` on production
+   */
+  maxAge: number;
+  /**
+   * dynamic load file which not cached on initialization
+   * Default to `true
+   */
+  dynamic: boolean;
+  /**
+   * caches the assets on initialization or not,
+   * always work together with `options.dynamic`
+   * Default to `false`
+   */
+  preload: boolean;
+  /**
+   * buffer the file content or not
+   * Default to `false` on development, `true` on production
+   */
+  buffer: boolean;
+  /**
+   * max files count in store
+   * Default to `1000`
+   */
+  maxFiles: number;
+}
+
+/**
+ * Static file serve
+ * @member Config#static
+ * @see https://github.com/koajs/static-cache
+ */
+export interface StaticConfig extends Omit<StaticDirOptions, 'dir'> {
+  /**
+   * static files store dir
+   * Default to `${baseDir}/app/public`
+   */
+  dir: string | Array<string | StaticDirOptions>;
+  /**
+   * static files store dirs
+   * @deprecated use `dir` instead
+   */
+  dirs?: Array<string | StaticDirOptions>;
+}
+
+declare module '@eggjs/core' {
+  // add EggAppConfig overrides types
+  interface EggAppConfig {
+    static: StaticConfig;
+  }
+}

package/src/typings/index.d.ts

@@ -0,0 +1,4 @@
+// make sure to import egg typings and let typescript know about it
+// @see https://github.com/whxaxes/blog/issues/11
+// and https://www.typescriptlang.org/docs/handbook/declaration-merging.html
+import 'egg';