@c9up/ream 0.2.18 → 0.2.19

package/dist/storage/StaticMiddleware.d.ts

@@ -1,27 +1,95 @@
 /**
  * Static file serving middleware.
  *
- * Serves files from a directory with cache headers and ETag support.
+ * The shape is `@adonisjs/static`'s, whose own work is done by `serve-static`:
+ * the same option names, the same defaults, the same response headers. Ream
+ * cannot delegate to `serve-static` itself —
+ *
+ * NAMED DEVIATION (NAPI): `serve-static` writes to a Node `ServerResponse`, and
+ * Ream's response crosses the NAPI boundary as a complete object; there is no
+ * such object to hand it. So the BEHAVIOUR is reproduced here rather than the
+ * code, and every deviation from it below is deliberate and marked.
+ *
+ * One deviation is a deliberate improvement, kept per the rule that we do not
+ * give up safety for parity: the file is opened with `O_NOFOLLOW` and its
+ * metadata read from the descriptor, so the bytes served are the ones that
+ * passed the containment checks. `serve-static` re-reads by path.
  *
  * Usage:
- *   server.use(new StaticMiddleware({ root: 'public' }))
+ *   server.use(new StaticMiddleware({ root: app.publicPath() }))
  *
  * @implements MISS-25
  */
+import * as fs from 'node:fs';
 import type { HttpContext } from '../http/HttpContext.js';
+/** How a request for a dotfile is answered (`send`'s `dotfiles`). */
+export type DotFilesPolicy = 'allow' | 'deny' | 'ignore';
 export interface StaticConfig {
     /** Root directory to serve files from. */
     root: string;
-    /** URL prefix (default: /static). */
-    prefix?: string;
-    /** Max-age for Cache-Control header in seconds (default: 86400 = 1 day). */
+    /** Serve at all. `false` makes every request fall through. Default `true`. */
+    enabled?: boolean;
+    /**
+     * Answer `Range` requests with `206`, and advertise `Accept-Ranges: bytes`.
+     * Default `true` — without it a browser cannot seek in audio or video, and
+     * an interrupted download restarts from zero.
+     */
+    acceptRanges?: boolean;
+    /**
+     * Emit `Cache-Control`. Default `true`. When `false`, `maxAge` and
+     * `immutable` are ignored, as upstream documents.
+     */
+    cacheControl?: boolean;
+    /**
+     * Dotfiles: `'ignore'` (fall through, the default), `'deny'` (403), or
+     * `'allow'` (serve). The default is why `.env` in the served root is not
+     * an accident waiting to happen.
+     */
+    dotFiles?: DotFilesPolicy;
+    /** Emit `ETag` and honour `If-None-Match`. Default `true`. */
+    etag?: boolean;
+    /**
+     * FALLBACK extensions, NOT an allowlist: when the requested path has no
+     * file, try appending each of these. `['html']` makes `/about` serve
+     * `about.html`. Default: none.
+     *
+     * The name and meaning are upstream's. An earlier version of this file used
+     * the same option as an allowlist — the opposite meaning — which silently
+     * restricted the server for anyone porting an AdonisJS config across, and
+     * refused formats the framework itself produces (`.avif`, from prism).
+     */
+    extensions?: string[] | false;
+    /** Add `immutable` to `Cache-Control`. Needs `maxAge`. Default `false`. */
+    immutable?: boolean;
+    /** Index file for a directory request. Default `'index.html'`; `false` disables. */
+    index?: string | string[] | false;
+    /** Emit `Last-Modified` and honour `If-Modified-Since`. Default `true`. */
+    lastModified?: boolean;
+    /** `Cache-Control: max-age`, in MILLISECONDS as upstream. Default `0`. */
     maxAge?: number;
-    /** File extensions to serve (default: common web assets). */
-    extensions?: string[];
+    /** Extra headers, per file. Runs last, so it can override the above. */
+    headers?: (filePath: string, stat: fs.Stats) => Record<string, string>;
+    /**
+     * Serve only under this URL prefix.
+     *
+     * NAMED DEVIATION: AdonisJS has no such option — its middleware is mounted at
+     * the URL root and falls through. Ream keeps it because the router is the
+     * same object the application writes to, and narrowing is occasionally what
+     * an application wants. The default is upstream's behaviour: no prefix.
+     */
+    prefix?: string;
 }
 export declare class StaticMiddleware {
     #private;
     constructor(config: StaticConfig);
     handle(ctx: HttpContext, next: () => Promise<void>): Promise<void>;
 }
+/**
+ * Static config with the defaults filled in — `@adonisjs/static`'s
+ * `defineConfig`, value for value.
+ *
+ *   // config/static.ts
+ *   export default defineStaticConfig({ maxAge: 86_400_000 })
+ */
+export declare function defineStaticConfig(config?: Partial<StaticConfig>): Partial<StaticConfig>;
 //# sourceMappingURL=StaticMiddleware.d.ts.map

package/dist/storage/StaticMiddleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StaticMiddleware.d.ts","sourceRoot":"","sources":["../../src/storage/StaticMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAOH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAGzD,MAAM,WAAW,YAAY;IAC3B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4EAA4E;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AA4BD,qBAAa,gBAAgB;;gBAMf,MAAM,EAAE,YAAY;IAO1B,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CA+HzE"}
+{"version":3,"file":"StaticMiddleware.d.ts","sourceRoot":"","sources":["../../src/storage/StaticMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAK7B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAGzD,qEAAqE;AACrE,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAA;AAExD,MAAM,WAAW,YAAY;IAC3B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IAEZ,8EAA8E;IAC9E,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IAE7B,2EAA2E;IAC3E,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB,oFAAoF;IACpF,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAA;IAEjC,2EAA2E;IAC3E,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,wEAAwE;IACxE,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEtE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAQD,qBAAa,gBAAgB;;gBAef,MAAM,EAAE,YAAY;IAqB1B,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CA0RzE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,GAAE,OAAO,CAAC,YAAY,CAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAE5F"}

package/dist/storage/StaticMiddleware.js

@@ -1,10 +1,22 @@
 /**
  * Static file serving middleware.
  *
- * Serves files from a directory with cache headers and ETag support.
+ * The shape is `@adonisjs/static`'s, whose own work is done by `serve-static`:
+ * the same option names, the same defaults, the same response headers. Ream
+ * cannot delegate to `serve-static` itself —
+ *
+ * NAMED DEVIATION (NAPI): `serve-static` writes to a Node `ServerResponse`, and
+ * Ream's response crosses the NAPI boundary as a complete object; there is no
+ * such object to hand it. So the BEHAVIOUR is reproduced here rather than the
+ * code, and every deviation from it below is deliberate and marked.
+ *
+ * One deviation is a deliberate improvement, kept per the rule that we do not
+ * give up safety for parity: the file is opened with `O_NOFOLLOW` and its
+ * metadata read from the descriptor, so the bytes served are the ones that
+ * passed the containment checks. `serve-static` re-reads by path.
  *
  * Usage:
- *   server.use(new StaticMiddleware({ root: 'public' }))
+ *   server.use(new StaticMiddleware({ root: app.publicPath() }))
  *
  * @implements MISS-25
  */
@@ -13,122 +25,273 @@ import * as fsp from 'node:fs/promises';
 import * as path from 'node:path';
 import { matchesIfNoneMatch, statTag } from '../http/etag.js';
 import { contentType } from '../http/mime.js';
-const DEFAULT_EXTENSIONS = [
-    '.html',
-    '.css',
-    '.js',
-    '.json',
-    '.xml',
-    '.txt',
-    '.png',
-    '.jpg',
-    '.jpeg',
-    '.gif',
-    '.svg',
-    '.ico',
-    '.webp',
-    '.woff',
-    '.woff2',
-    '.ttf',
-    '.eot',
-    '.mp4',
-    '.webm',
-    '.mp3',
-    '.ogg',
-    '.pdf',
-    '.zip',
-];
 export class StaticMiddleware {
     #root;
-    #prefix;
-    #maxAge;
+    #enabled;
+    #acceptRanges;
+    #cacheControl;
+    #dotFiles;
+    #etag;
     #extensions;
+    #immutable;
+    #index;
+    #lastModified;
+    #maxAge;
+    #headers;
+    #prefix;
     constructor(config) {
         this.#root = path.resolve(config.root);
-        this.#prefix = config.prefix ?? '/static';
-        this.#maxAge = config.maxAge ?? 86400;
-        this.#extensions = new Set(config.extensions ?? DEFAULT_EXTENSIONS);
+        this.#enabled = config.enabled ?? true;
+        this.#acceptRanges = config.acceptRanges ?? true;
+        this.#cacheControl = config.cacheControl ?? true;
+        this.#dotFiles = config.dotFiles ?? 'ignore';
+        this.#etag = config.etag ?? true;
+        this.#extensions = config.extensions === false ? [] : (config.extensions ?? []);
+        this.#immutable = config.immutable ?? false;
+        this.#index =
+            config.index === false
+                ? []
+                : typeof config.index === 'string'
+                    ? [config.index]
+                    : (config.index ?? ['index.html']);
+        this.#lastModified = config.lastModified ?? true;
+        this.#maxAge = config.maxAge ?? 0;
+        this.#headers = config.headers;
+        this.#prefix = config.prefix ?? '';
     }
     async handle(ctx, next) {
-        if (ctx.request.method() !== 'GET' && ctx.request.method() !== 'HEAD') {
+        if (!this.#enabled)
             return next();
+        const method = ctx.request.method();
+        if (method !== 'GET' && method !== 'HEAD')
+            return next();
+        const reqPath = ctx.request.path();
+        // A dotfile under `deny` is answered, not passed on: falling through would
+        // leak its existence through whatever the router answers next.
+        if (this.#dotFiles === 'deny' && this.#hasDotSegment(reqPath)) {
+            ctx.response.status(403).send('Forbidden');
+            return;
         }
-        const resolved = await this.#openServableFile(ctx.request.path());
+        const resolved = await this.#openServableFile(reqPath);
         if (!resolved)
             return next();
-        const { handle, ext, stat } = resolved;
-        // The handle is ours until the read stream takes it; every path that does
-        // not hand it over closes it, or the process leaks a descriptor per 304.
+        const { handle, filePath, stat } = resolved;
+        // The handle is ours until a read stream takes it; every path that does not
+        // hand it over closes it, or the process leaks a descriptor per 304.
         let owned = true;
         try {
-            const etag = statTag(stat);
-            if (matchesIfNoneMatch(ctx.request.header('if-none-match'), etag)) {
+            const etag = this.#etag ? statTag(stat) : undefined;
+            const lastModified = this.#lastModified ? stat.mtime.toUTCString() : undefined;
+            // One table for the whole package (`src/http/mime.ts`), generated from
+            // mime-db. A second hand-written one here is how `.js` came to be served
+            // as `application/javascript` from one path and `text/javascript` from
+            // the other.
+            ctx.response.header('Content-Type', contentType(path.extname(filePath).toLowerCase()) || 'application/octet-stream');
+            if (etag)
+                ctx.response.header('ETag', etag);
+            if (lastModified)
+                ctx.response.header('Last-Modified', lastModified);
+            if (this.#cacheControl)
+                ctx.response.header('Cache-Control', this.#cacheControlValue());
+            if (this.#acceptRanges)
+                ctx.response.header('Accept-Ranges', 'bytes');
+            if (this.#headers) {
+                for (const [name, value] of Object.entries(this.#headers(filePath, stat))) {
+                    ctx.response.header(name, value);
+                }
+            }
+            if (this.#isFresh(ctx, etag, stat)) {
+                // A 304 carries no body and no Content-Length: the client reuses the
+                // copy it already has.
                 ctx.response.status(304);
                 return;
             }
-            // One table for the whole package (`src/http/mime.ts`), generated from
-            // mime-db. A second hand-written one here is how `.js` came to be
-            // served as `application/javascript` from one code path and
-            // `text/javascript` from the other.
-            ctx.response.header('Content-Type', contentType(ext) || 'application/octet-stream');
-            ctx.response.header('Content-Length', String(stat.size));
-            ctx.response.header('Cache-Control', `public, max-age=${this.#maxAge}`);
-            ctx.response.header('ETag', etag);
-            if (ctx.request.method() === 'HEAD') {
-                ctx.response.status(200);
+            const range = this.#acceptRanges ? this.#resolveRange(ctx, stat, etag) : undefined;
+            if (range === 'unsatisfiable') {
+                ctx.response.header('Content-Range', `bytes */${stat.size}`);
+                ctx.response.status(416).send('');
+                return;
+            }
+            const length = range ? range.end - range.start + 1 : stat.size;
+            ctx.response.header('Content-Length', String(length));
+            if (range) {
+                ctx.response.header('Content-Range', `bytes ${range.start}-${range.end}/${stat.size}`);
+            }
+            if (method === 'HEAD') {
+                // HEAD carries the headers a GET would, and no body.
+                ctx.response.status(range ? 206 : 200);
                 return;
             }
-            // Streamed, not read whole.
-            //
-            // `readFileSync` stalled the event loop for EVERY concurrent request
-            // while one client asked for a file, and the allowed extensions include
-            // `.mp4`, `.zip` and `.pdf` — so one large asset became every other
-            // request's latency, and each request allocated the file again. The
-            // stream applies backpressure and holds one chunk at a time.
-            //
-            // The read stream owns the handle from here and closes it at end.
-            ctx.response.status(200);
+            // Streamed, not read whole. `readFileSync` stalled the event loop for
+            // every concurrent request while one client asked for a file, and one
+            // large asset became every other request's latency. The read stream owns
+            // the handle from here and closes it at end.
+            ctx.response.status(range ? 206 : 200);
             owned = false;
-            await ctx.response.stream(handle.createReadStream());
+            await ctx.response.stream(range
+                ? handle.createReadStream({ start: range.start, end: range.end })
+                : handle.createReadStream());
         }
         finally {
             if (owned)
                 await handle.close().catch(() => { });
         }
     }
+    /** `Cache-Control`, built the way `send` builds it. */
+    #cacheControlValue() {
+        const seconds = Math.floor(this.#maxAge / 1000);
+        let value = `public, max-age=${seconds}`;
+        // Upstream only honours `immutable` alongside a max-age: `immutable` on a
+        // response that expires immediately tells a cache two opposite things.
+        if (this.#immutable && seconds > 0)
+            value += ', immutable';
+        return value;
+    }
+    /**
+     * Is the client's copy still good? `If-None-Match` wins outright when
+     * present, and `If-Modified-Since` is only consulted in its absence — the
+     * order RFC 9110 §13.1.3 requires, and the reason a weak ETag plus a
+     * second-resolution mtime do not contradict each other.
+     */
+    #isFresh(ctx, etag, stat) {
+        const ifNoneMatch = ctx.request.header('if-none-match');
+        if (ifNoneMatch !== undefined && ifNoneMatch !== null) {
+            return etag !== undefined && matchesIfNoneMatch(ifNoneMatch, etag);
+        }
+        if (!this.#lastModified)
+            return false;
+        const since = ctx.request.header('if-modified-since');
+        if (since === undefined || since === null)
+            return false;
+        const sinceMs = Date.parse(Array.isArray(since) ? since[0] : String(since));
+        if (Number.isNaN(sinceMs))
+            return false;
+        // HTTP dates have one-second resolution; the file's mtime does not. Compare
+        // at the coarser one, or a file written mid-second looks modified forever.
+        return Math.floor(stat.mtimeMs / 1000) * 1000 <= sinceMs;
+    }
+    /**
+     * The range to serve, `undefined` for the whole file, or `'unsatisfiable'`
+     * for a 416.
+     *
+     * Only a single range is honoured. Multiple ranges require a
+     * `multipart/byteranges` body, which upstream supports and this does not —
+     * a request for several is served whole, which is a response every client
+     * accepts.
+     */
+    #resolveRange(ctx, stat, etag) {
+        const raw = ctx.request.header('range');
+        if (raw === undefined || raw === null)
+            return undefined;
+        const header = Array.isArray(raw) ? raw[0] : String(raw);
+        // `If-Range` guards against a resumed download stitching bytes from two
+        // different versions of the file: if the validator does not match, the
+        // whole current file is the honest answer.
+        const ifRange = ctx.request.header('if-range');
+        if (ifRange !== undefined && ifRange !== null) {
+            const value = Array.isArray(ifRange) ? ifRange[0] : String(ifRange);
+            const matchesEtag = etag !== undefined && value.trim() === etag;
+            const asDate = Date.parse(value);
+            const matchesDate = !Number.isNaN(asDate) && Math.floor(stat.mtimeMs / 1000) * 1000 <= asDate;
+            if (!matchesEtag && !matchesDate)
+                return undefined;
+        }
+        const match = /^bytes=(\d*)-(\d*)$/.exec(header.trim());
+        if (!match)
+            return undefined; // not a form we serve: send the whole file
+        const [, rawStart, rawEnd] = match;
+        if (rawStart === '' && rawEnd === '')
+            return undefined;
+        let start;
+        let end;
+        if (rawStart === '') {
+            // `bytes=-500`: the LAST 500 bytes, not the first.
+            const suffix = Number(rawEnd);
+            if (suffix === 0)
+                return 'unsatisfiable';
+            start = Math.max(stat.size - suffix, 0);
+            end = stat.size - 1;
+        }
+        else {
+            start = Number(rawStart);
+            end = rawEnd === '' ? stat.size - 1 : Math.min(Number(rawEnd), stat.size - 1);
+        }
+        if (!Number.isFinite(start) || !Number.isFinite(end) || start > end || start >= stat.size) {
+            return 'unsatisfiable';
+        }
+        return { start, end };
+    }
+    #hasDotSegment(reqPath) {
+        return reqPath.split('/').some((segment) => segment.length > 1 && segment.startsWith('.'));
+    }
     /**
-     * Open a request path as a real, in-root, regular file, or answer `null`
-     * when it is not servable (wrong prefix/extension, outside the root,
-     * missing, or a symlink escaping the root). `null` tells `handle` to call
-     * `next()`.
+     * Open a request path as a real, in-root, regular file, or answer `null` when
+     * it is not servable. `null` tells `handle` to call `next()`.
      *
      * The file is OPENED here rather than merely checked, and its metadata read
-     * from the descriptor: what gets served is then the same file that passed
-     * the checks, which a path re-read after the fact cannot promise.
+     * from the descriptor: what gets served is then the same file that passed the
+     * checks, which a path re-read after the fact cannot promise.
      */
     async #openServableFile(reqPath) {
-        // Match only when the prefix is followed by `/` or end-of-path —
-        // otherwise `/staticx/foo.js` would be intercepted when the configured
-        // prefix is `/static`, hijacking unrelated routes.
-        if (!(reqPath === this.#prefix || reqPath.startsWith(`${this.#prefix}/`))) {
+        if (this.#prefix !== '') {
+            // Match only when the prefix is followed by `/` or end-of-path —
+            // otherwise `/staticx/foo.js` would be intercepted when the configured
+            // prefix is `/static`, hijacking unrelated routes.
+            if (!(reqPath === this.#prefix || reqPath.startsWith(`${this.#prefix}/`)))
+                return null;
+            reqPath = reqPath.slice(this.#prefix.length) || '/';
+        }
+        if (this.#dotFiles === 'ignore' && this.#hasDotSegment(reqPath))
+            return null;
+        // The candidates, in upstream's order: the path itself, then the path with
+        // each fallback extension, then the index files for a directory request.
+        //
+        // Percent-decoding happens BEFORE resolution on purpose: `%2e%2e%2f` is
+        // `../` and has to be normalised away by `path.resolve` like any other
+        // traversal, not carried through as an opaque segment. `decodeURIComponent`
+        // THROWS on a malformed sequence (a lone `%`), which would otherwise become
+        // a 500 on a request anyone can send.
+        let decoded;
+        try {
+            decoded = decodeURIComponent(reqPath);
+        }
+        catch {
             return null;
         }
-        // Strip prefix and resolve file path
-        const relativePath = reqPath.slice(this.#prefix.length) || '/index.html';
-        const ext = path.extname(relativePath).toLowerCase();
-        if (!this.#extensions.has(ext))
+        // A NUL truncates the path in the syscall layer of some runtimes; Node
+        // rejects it, but refusing here keeps the decision in one place.
+        if (decoded.includes('\0'))
             return null;
-        const filePath = path.resolve(this.#root, relativePath.replace(/^\//, ''));
+        const relative = decoded.replace(/^\/+/, '');
+        const candidates = [];
+        if (relative !== '') {
+            candidates.push(relative);
+            for (const ext of this.#extensions) {
+                candidates.push(`${relative}.${ext.replace(/^\./, '')}`);
+            }
+        }
+        for (const index of this.#index) {
+            candidates.push(relative === '' ? index : `${relative}/${index}`);
+        }
+        for (const candidate of candidates) {
+            const opened = await this.#openInRoot(candidate);
+            if (opened)
+                return opened;
+        }
+        return null;
+    }
+    /** One candidate, fully contained and opened, or `null`. */
+    async #openInRoot(relative) {
+        const filePath = path.resolve(this.#root, relative);
         // Two containment checks. The first uses `path.sep` to reject sibling
-        // directories with a shared prefix (`/var/www-static-secret` slipping
-        // past a guard for `/var/www-static`). The second resolves symlinks
-        // via realpath so a symlink planted inside the root cannot point
-        // outside it. We do realpath AFTER the lexical check so a non-existent
-        // path returns `next()` rather than throwing.
+        // directories with a shared prefix (`/var/www-static-secret` slipping past
+        // a guard for `/var/www-static`). The second resolves symlinks via realpath
+        // so a symlink planted inside the root cannot point outside it. Realpath
+        // runs AFTER the lexical check so a non-existent path returns null rather
+        // than throwing.
         const rootWithSep = this.#root.endsWith(path.sep) ? this.#root : this.#root + path.sep;
-        if (filePath !== this.#root && !filePath.startsWith(rootWithSep)) {
+        if (filePath !== this.#root && !filePath.startsWith(rootWithSep))
             return null;
-        }
         let realFilePath;
         let realRoot;
         try {
@@ -139,9 +302,8 @@ export class StaticMiddleware {
             return null;
         }
         const realRootWithSep = realRoot.endsWith(path.sep) ? realRoot : realRoot + path.sep;
-        if (realFilePath !== realRoot && !realFilePath.startsWith(realRootWithSep)) {
+        if (realFilePath !== realRoot && !realFilePath.startsWith(realRootWithSep))
             return null;
-        }
         // O_NOFOLLOW closes the window the checks above leave open: between
         // `realpath` and the read, the last path component can be replaced by a
         // symlink pointing anywhere, and a read by name follows it. Refusing to
@@ -161,7 +323,7 @@ export class StaticMiddleware {
                 await handle.close();
                 return null;
             }
-            return { handle, ext, stat };
+            return { handle, filePath: realFilePath, stat };
         }
         catch {
             await handle.close().catch(() => { });
@@ -169,4 +331,14 @@ export class StaticMiddleware {
         }
     }
 }
+/**
+ * Static config with the defaults filled in — `@adonisjs/static`'s
+ * `defineConfig`, value for value.
+ *
+ *   // config/static.ts
+ *   export default defineStaticConfig({ maxAge: 86_400_000 })
+ */
+export function defineStaticConfig(config = {}) {
+    return { enabled: true, dotFiles: 'ignore', etag: true, lastModified: true, ...config };
+}
 //# sourceMappingURL=StaticMiddleware.js.map

package/dist/storage/StaticMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"StaticMiddleware.js","sourceRoot":"","sources":["../../src/storage/StaticMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAE7B,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAa7C,MAAM,kBAAkB,GAAG;IACzB,OAAO;IACP,MAAM;IACN,KAAK;IACL,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAA;AAED,MAAM,OAAO,gBAAgB;IAC3B,KAAK,CAAQ;IACb,OAAO,CAAQ;IACf,OAAO,CAAQ;IACf,WAAW,CAAa;IAExB,YAAY,MAAoB;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,SAAS,CAAA;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAA;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,IAAI,kBAAkB,CAAC,CAAA;IACrE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAgB,EAAE,IAAyB;QACtD,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;YACtE,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;QACjE,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,EAAE,CAAA;QAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAA;QAEtC,0EAA0E;QAC1E,yEAAyE;QACzE,IAAI,KAAK,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;YAE1B,IAAI,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;gBAClE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACxB,OAAM;YACR,CAAC;YAED,uEAAuE;YACvE,kEAAkE;YAClE,4DAA4D;YAC5D,oCAAoC;YACpC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAAC,CAAA;YACnF,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;YACxD,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,mBAAmB,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACvE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YAEjC,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;gBACpC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACxB,OAAM;YACR,CAAC;YAED,4BAA4B;YAC5B,EAAE;YACF,qEAAqE;YACrE,wEAAwE;YACxE,oEAAoE;YACpE,oEAAoE;YACpE,6DAA6D;YAC7D,EAAE;YACF,kEAAkE;YAClE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACxB,KAAK,GAAG,KAAK,CAAA;YACb,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACtD,CAAC;gBAAS,CAAC;YACT,IAAI,KAAK;gBAAE,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QACjD,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe;QAEf,iEAAiE;QACjE,uEAAuE;QACvE,mDAAmD;QACnD,IAAI,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAA;QACb,CAAC;QAED,qCAAqC;QACrC,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,aAAa,CAAA;QACxE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAA;QACpD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAA;QAE3C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;QAE1E,sEAAsE;QACtE,sEAAsE;QACtE,oEAAoE;QACpE,iEAAiE;QACjE,uEAAuE;QACvE,8CAA8C;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAA;QACtF,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACjE,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,YAAoB,CAAA;QACxB,IAAI,QAAgB,CAAA;QACpB,IAAI,CAAC;YACH,YAAY,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC3C,QAAQ,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,eAAe,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAA;QACpF,IAAI,YAAY,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YAC3E,OAAO,IAAI,CAAA;QACb,CAAC;QAED,oEAAoE;QACpE,wEAAwE;QACxE,wEAAwE;QACxE,sEAAsE;QACtE,0EAA0E;QAC1E,2EAA2E;QAC3E,IAAI,MAAkB,CAAA;QACtB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACxF,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;YAChC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;gBACpB,OAAO,IAAI,CAAA;YACb,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"StaticMiddleware.js","sourceRoot":"","sources":["../../src/storage/StaticMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAE7B,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AA+E7C,MAAM,OAAO,gBAAgB;IAClB,KAAK,CAAQ;IACb,QAAQ,CAAS;IACjB,aAAa,CAAS;IACtB,aAAa,CAAS;IACtB,SAAS,CAAgB;IACzB,KAAK,CAAS;IACd,WAAW,CAAU;IACrB,UAAU,CAAS;IACnB,MAAM,CAAU;IAChB,aAAa,CAAS;IACtB,OAAO,CAAQ;IACf,QAAQ,CAA+D;IACvE,OAAO,CAAQ;IAExB,YAAY,MAAoB;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAA;QACtC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,CAAA;QAChD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,CAAA;QAChD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAA;QAC5C,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAA;QAChC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAA;QAC/E,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,IAAI,KAAK,CAAA;QAC3C,IAAI,CAAC,MAAM;YACT,MAAM,CAAC,KAAK,KAAK,KAAK;gBACpB,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ;oBAChC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;oBAChB,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAA;QACxC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,CAAA;QAChD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,CAAA;QACjC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAgB,EAAE,IAAyB;QACtD,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,EAAE,CAAA;QACjC,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAA;QACnC,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM;YAAE,OAAO,IAAI,EAAE,CAAA;QAExD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;QAElC,2EAA2E;QAC3E,+DAA+D;QAC/D,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAC1C,OAAM;QACR,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;QACtD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,EAAE,CAAA;QAC5B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAA;QAE3C,4EAA4E;QAC5E,qEAAqE;QACrE,IAAI,KAAK,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YACnD,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;YAE9E,uEAAuE;YACvE,yEAAyE;YACzE,uEAAuE;YACvE,aAAa;YACb,GAAG,CAAC,QAAQ,CAAC,MAAM,CACjB,cAAc,EACd,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,0BAA0B,CAChF,CAAA;YACD,IAAI,IAAI;gBAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YAC3C,IAAI,YAAY;gBAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;YACpE,IAAI,IAAI,CAAC,aAAa;gBAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAA;YACvF,IAAI,IAAI,CAAC,aAAa;gBAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;YACrE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;oBAC1E,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBAClC,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACnC,qEAAqE;gBACrE,uBAAuB;gBACvB,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACxB,OAAM;YACR,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YAClF,IAAI,KAAK,KAAK,eAAe,EAAE,CAAC;gBAC9B,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,WAAW,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;gBAC5D,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBACjC,OAAM;YACR,CAAC;YAED,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;YAC9D,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;YACrD,IAAI,KAAK,EAAE,CAAC;gBACV,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;YACxF,CAAC;YAED,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,qDAAqD;gBACrD,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;gBACtC,OAAM;YACR,CAAC;YAED,sEAAsE;YACtE,sEAAsE;YACtE,yEAAyE;YACzE,6CAA6C;YAC7C,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;YACtC,KAAK,GAAG,KAAK,CAAA;YACb,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CACvB,KAAK;gBACH,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;gBACjE,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAC9B,CAAA;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,KAAK;gBAAE,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QACjD,CAAC;IACH,CAAC;IAED,uDAAuD;IACvD,kBAAkB;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;QAC/C,IAAI,KAAK,GAAG,mBAAmB,OAAO,EAAE,CAAA;QACxC,0EAA0E;QAC1E,uEAAuE;QACvE,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,GAAG,CAAC;YAAE,KAAK,IAAI,aAAa,CAAA;QAC1D,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,GAAgB,EAAE,IAAwB,EAAE,IAAc;QACjE,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;QACvD,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACtD,OAAO,IAAI,KAAK,SAAS,IAAI,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;QACpE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO,KAAK,CAAA;QACrC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAA;QACrD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,KAAK,CAAA;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAC3E,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;YAAE,OAAO,KAAK,CAAA;QACvC,4EAA4E;QAC5E,2EAA2E;QAC3E,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,OAAO,CAAA;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,GAAgB,EAChB,IAAc,EACd,IAAwB;QAExB,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACvC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,SAAS,CAAA;QACvD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAExD,wEAAwE;QACxE,uEAAuE;QACvE,2CAA2C;QAC3C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAC9C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACnE,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,CAAA;YAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAChC,MAAM,WAAW,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,MAAM,CAAA;YAC7F,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW;gBAAE,OAAO,SAAS,CAAA;QACpD,CAAC;QAED,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAA;QACvD,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAA,CAAC,2CAA2C;QACxE,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,KAAK,CAAA;QAClC,IAAI,QAAQ,KAAK,EAAE,IAAI,MAAM,KAAK,EAAE;YAAE,OAAO,SAAS,CAAA;QAEtD,IAAI,KAAa,CAAA;QACjB,IAAI,GAAW,CAAA;QACf,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;YACpB,mDAAmD;YACnD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;YAC7B,IAAI,MAAM,KAAK,CAAC;gBAAE,OAAO,eAAe,CAAA;YACxC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,MAAM,EAAE,CAAC,CAAC,CAAA;YACvC,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;QACrB,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;YACxB,GAAG,GAAG,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;QAC/E,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC1F,OAAO,eAAe,CAAA;QACxB,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IACvB,CAAC;IAED,cAAc,CAAC,OAAe;QAC5B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;YACxB,iEAAiE;YACjE,uEAAuE;YACvE,mDAAmD;YACnD,IAAI,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAA;YACtF,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,GAAG,CAAA;QACrD,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,KAAK,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;YAAE,OAAO,IAAI,CAAA;QAE5E,2EAA2E;QAC3E,yEAAyE;QACzE,EAAE;QACF,wEAAwE;QACxE,uEAAuE;QACvE,4EAA4E;QAC5E,4EAA4E;QAC5E,sCAAsC;QACtC,IAAI,OAAe,CAAA;QACnB,IAAI,CAAC;YACH,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;QACD,uEAAuE;QACvE,iEAAiE;QACjE,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAA;QACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;QAC5C,MAAM,UAAU,GAAa,EAAE,CAAA;QAC/B,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;YACpB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACzB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnC,UAAU,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;YAC1D,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,UAAU,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAA;QACnE,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;YAChD,IAAI,MAAM;gBAAE,OAAO,MAAM,CAAA;QAC3B,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,WAAW,CACf,QAAgB;QAEhB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAEnD,sEAAsE;QACtE,2EAA2E;QAC3E,4EAA4E;QAC5E,yEAAyE;QACzE,0EAA0E;QAC1E,iBAAiB;QACjB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAA;QACtF,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;YAAE,OAAO,IAAI,CAAA;QAE7E,IAAI,YAAoB,CAAA;QACxB,IAAI,QAAgB,CAAA;QACpB,IAAI,CAAC;YACH,YAAY,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC3C,QAAQ,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,eAAe,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAA;QACpF,IAAI,YAAY,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC;YAAE,OAAO,IAAI,CAAA;QAEvF,oEAAoE;QACpE,wEAAwE;QACxE,wEAAwE;QACxE,sEAAsE;QACtE,0EAA0E;QAC1E,2EAA2E;QAC3E,IAAI,MAAkB,CAAA;QACtB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACxF,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;YAChC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;gBACpB,OAAO,IAAI,CAAA;YACb,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAAgC,EAAE;IACnE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAA;AACzF,CAAC"}

package/dist/storage/StaticProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StaticProvider.d.ts","sourceRoot":"","sources":["../../src/storage/StaticProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAqB,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAE3E,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAED,qBAAa,cAAe,SAAQ,QAAQ;;gBAG9B,GAAG,EAAE,UAAU,EAAE,OAAO,GAAE,qBAA0B;IAKhE;;;;;;;;;OASG;IACY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAOtC;AAGD,eAAe,cAAc,CAAA"}
+{"version":3,"file":"StaticProvider.d.ts","sourceRoot":"","sources":["../../src/storage/StaticProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAqB,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAE3E,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAED,qBAAa,cAAe,SAAQ,QAAQ;;gBAG9B,GAAG,EAAE,UAAU,EAAE,OAAO,GAAE,qBAA0B;IAKhE;;;;;;;;;OASG;IACY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAkBtC;AAGD,eAAe,cAAc,CAAA"}

package/dist/storage/StaticProvider.js

@@ -30,10 +30,19 @@ export class StaticProvider extends Provider {
      * the app that meant to override it.
      */
     async start() {
-        const config = this.app.config.get('static');
-        const middleware = this.#override ?? (config?.root ? new StaticMiddleware(config) : undefined);
+        // `?? {}` rather than a default argument: a host may supply its own
+        // ConfigReader, and not every implementation honours the second parameter.
+        const config = this.app.config.get('static') ?? {};
+        // Registering the provider is the whole opt-in, as it is upstream: there,
+        // `node ace configure @adonisjs/static` adds the provider AND the
+        // middleware, and the middleware serves `public/` with no `root` named
+        // anywhere. Requiring a `root` before doing anything meant a provider
+        // could be registered and silently serve nothing.
+        const root = config.root ?? this.app.publicPath?.() ?? 'public';
+        const middleware = this.#override ??
+            (config.enabled === false ? undefined : new StaticMiddleware({ ...config, root }));
         if (!middleware)
-            return; // not configured — opt-out
+            return;
         const server = await this.app.container.make('server');
         server.use([(ctx, next) => middleware.handle(ctx, next)]);
     }

package/dist/storage/StaticProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"StaticProvider.js","sourceRoot":"","sources":["../../src/storage/StaticProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAqB,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAO3E,MAAM,OAAO,cAAe,SAAQ,QAAQ;IACjC,SAAS,CAAmB;IAErC,YAAY,GAAe,EAAE,UAAiC,EAAE;QAC9D,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,UAAU,CAAA;IACrC,CAAC;IAED;;;;;;;;;OASG;IACM,KAAK,CAAC,KAAK;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAe,QAAQ,CAAC,CAAA;QAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAC9F,IAAI,CAAC,UAAU;YAAE,OAAM,CAAC,2BAA2B;QACnD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAS,QAAQ,CAAC,CAAA;QAC9D,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IAC3D,CAAC;CACF;AAED,yKAAyK;AACzK,eAAe,cAAc,CAAA"}
+{"version":3,"file":"StaticProvider.js","sourceRoot":"","sources":["../../src/storage/StaticProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAqB,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAO3E,MAAM,OAAO,cAAe,SAAQ,QAAQ;IACjC,SAAS,CAAmB;IAErC,YAAY,GAAe,EAAE,UAAiC,EAAE;QAC9D,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,UAAU,CAAA;IACrC,CAAC;IAED;;;;;;;;;OASG;IACM,KAAK,CAAC,KAAK;QAClB,oEAAoE;QACpE,2EAA2E;QAC3E,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAe,QAAQ,CAAC,IAAK,EAAmB,CAAA;QAElF,0EAA0E;QAC1E,kEAAkE;QAClE,uEAAuE;QACvE,sEAAsE;QACtE,kDAAkD;QAClD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,IAAI,QAAQ,CAAA;QAC/D,MAAM,UAAU,GACd,IAAI,CAAC,SAAS;YACd,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QACpF,IAAI,CAAC,UAAU;YAAE,OAAM;QACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAS,QAAQ,CAAC,CAAA;QAC9D,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IAC3D,CAAC;CACF;AAED,yKAAyK;AACzK,eAAe,cAAc,CAAA"}