@webda/core 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/services/resource.service.js

@@ -0,0 +1,301 @@
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+import * as fs from "fs";
+import * as mime from "mime-types";
+import * as path from "path";
+import * as WebdaError from "../errors/errors.js";
+import { Route } from "../rest/irest.js";
+import { Service } from "./service.js";
+import { ServiceParameters } from "../services/serviceparameters.js";
+/**
+ * ResourceService parameters
+ */
+export class ResourceServiceParameters extends ServiceParameters {
+    /**
+     * Folder to server
+     *
+     * @default "." + url
+     */
+    folder;
+    /**
+     * Add the / root to redirect to /{url}
+     *
+     * @default false
+     */
+    rootRedirect;
+    /**
+     * Index file
+     *
+     * @default index.html
+     */
+    index;
+    /**
+     * Return the index file for any unfound resource
+     * Useful for single page application
+     *
+     * @default true
+     */
+    indexFallback;
+    /**
+     * Cache control header to set
+     * @default "public, max-age=31536000"
+     */
+    cacheControl;
+    /**
+     * Cache control for index file
+     * SPA usually do not cache the index file
+     *
+     * @default "no-cache, no-store, must-revalidate"
+     */
+    indexCacheControl;
+    /**
+     * Serve also . prefixed files
+     * . files usually have some secrets and should not be served
+     *
+     * @default false
+     */
+    allowHiddenFiles;
+    /** Create a new ResourceServiceParameters
+     * @param params - the raw parameters
+     */
+    constructor(params) {
+        super();
+        if (params) {
+            this.load(params);
+        }
+    }
+    /**
+     * Load parameters, applying defaults and normalizing `url` and `folder`.
+     * The application builds parameters as `new Parameters().load(config)`, so
+     * this has to happen here rather than in the constructor.
+     * @param params - the raw parameters
+     * @returns this for chaining
+     */
+    load(params = {}) {
+        super.load(params);
+        this.url ??= "resources";
+        this.cacheControl ??= "public, max-age=31536000";
+        this.indexCacheControl ??= "no-cache, no-store, must-revalidate";
+        this.rootRedirect ??= false;
+        if (!this.url.startsWith("/")) {
+            this.url = "/" + this.url;
+        }
+        if (!this.url.endsWith("/")) {
+            this.url += "/";
+        }
+        this.folder ??= "." + this.url;
+        if (!this.folder.endsWith("/")) {
+            this.folder += "/";
+        }
+        this.index ??= "index.html";
+        this.indexFallback ??= true;
+        this.allowHiddenFiles ??= false;
+        return this;
+    }
+}
+/**
+ * This service expose a folder as web
+ *
+ * It is the same as `static` on `express`
+ *
+ * @category CoreServices
+ * @WebdaModda
+ */
+let ResourceService = (() => {
+    let _classSuper = Service;
+    let _instanceExtraInitializers = [];
+    let __serve_decorators;
+    return class ResourceService extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            __serve_decorators = [Route(".", ["GET"], {
+                    hidden: true,
+                    get: {
+                        description: "Get resources",
+                        summary: "Get file",
+                        operationId: "getResource",
+                        responses: {
+                            "200": { description: "" },
+                            "401": { description: "Illegal resource" },
+                            "404": { description: "File not found" }
+                        }
+                    }
+                }), Route("./{+resource}", ["GET"], {
+                    hidden: true,
+                    get: {
+                        description: "Get resources",
+                        summary: "Get file",
+                        operationId: "getResources",
+                        responses: {
+                            "200": { description: "" },
+                            "401": { description: "Illegal resource" },
+                            "404": { description: "File not found" }
+                        }
+                    }
+                })];
+            __esDecorate(this, null, __serve_decorators, { kind: "method", name: "_serve", static: false, private: false, access: { has: obj => "_serve" in obj, get: obj => obj._serve }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        /**
+         * Resolved path to the folder to serve
+         */
+        _resolved = __runInitializers(this, _instanceExtraInitializers);
+        /**
+         * If serving just one file
+         */
+        fileOnly;
+        /**
+         * Resolve resource folder
+         * @returns the result
+         */
+        resolve() {
+            super.resolve();
+            this.parameters.with(({ folder }) => {
+                this._resolved = path.resolve(folder);
+                this.fileOnly = !fs.lstatSync(this._resolved).isDirectory();
+            });
+            return this;
+        }
+        /**
+         * Register the optional rootRedirect route — kept programmatic because
+         * it's conditional on `parameters.rootRedirect`.
+         *
+         * @returns this for chaining
+         */
+        async init() {
+            await super.init();
+            // A folder is served at `url` with its trailing slash; send the bare URL
+            // there, where relative links in the index (`app.js`) resolve inside it
+            if (!this.fileOnly && this.parameters.url !== "/") {
+                this.addRoute(this.parameters.url.slice(0, -1), ["GET"], this._redirectToFolder, {
+                    hidden: true,
+                    get: {
+                        description: "Redirect to the exposed folder with its trailing slash",
+                        summary: "Redirect to resources",
+                        operationId: "redirectToResources",
+                        responses: {
+                            "302": {
+                                description: ""
+                            }
+                        }
+                    }
+                });
+            }
+            if (this.parameters.rootRedirect) {
+                this.addRoute("/", ["GET"], this._redirect, {
+                    hidden: true,
+                    get: {
+                        description: "Redirect / to the exposed url",
+                        summary: "Serve resource",
+                        operationId: "redirectRoottoResources",
+                        responses: {
+                            "302": {
+                                description: ""
+                            }
+                        }
+                    }
+                });
+            }
+            return this;
+        }
+        /**
+         * Handle / request and redirect to the resources folder
+         *
+         * @param ctx - the operation context
+         */
+        _redirect(ctx) {
+            ctx.setHeader("cache-control", this.parameters.cacheControl);
+            ctx.redirect(ctx.getHttpContext().getAbsoluteUrl(this.parameters.url));
+        }
+        /**
+         * Handle the folder URL without its trailing slash
+         *
+         * @param ctx - the operation context
+         */
+        _redirectToFolder(ctx) {
+            const http = ctx.getHttpContext();
+            ctx.redirect(http.getAbsoluteUrl(this.parameters.url + http.getSearch()));
+        }
+        /**
+         * Serve the folder by itself, doing the mime detection
+         *
+         * @param ctx - the operation context
+         * @returns the result
+         */
+        _serve(ctx) {
+            let file = this._resolved;
+            let cacheControl = this.parameters.cacheControl;
+            // If resource is not a file
+            if (!this.fileOnly) {
+                file = path.join(this._resolved, ctx.parameter("resource") || this.parameters.index);
+                if (!ctx.parameter("resource")) {
+                    cacheControl = this.parameters.indexCacheControl;
+                }
+                else if (ctx
+                    .parameter("resource")
+                    .split("/")
+                    .find(f => f.startsWith(".")) &&
+                    !this.parameters.allowHiddenFiles) {
+                    throw new WebdaError.NotFound("Hidden files are not allowed");
+                }
+            }
+            // Avoid path transversal
+            if (!path.resolve(file).startsWith(this._resolved)) {
+                throw new WebdaError.Unauthorized(file);
+            }
+            if (!fs.existsSync(file)) {
+                file = path.join(this._resolved, this.parameters.index);
+                // Catch All for SPA
+                if (!(this.parameters.indexFallback && fs.existsSync(file))) {
+                    throw new WebdaError.NotFound(file);
+                }
+                cacheControl = this.parameters.indexCacheControl;
+            }
+            let mimetype = mime.lookup(file) || "application/octet-stream";
+            if (mimetype.startsWith("text/")) {
+                mimetype += "; charset=UTF-8";
+            }
+            ctx.writeHead(200, {
+                "content-type": mimetype,
+                "content-length": fs.lstatSync(file).size,
+                "cache-control": cacheControl
+            });
+            // We could cache in memory some of the file to avoid I/O
+            return ctx.pipeline(fs.createReadStream(file));
+        }
+    };
+})();
+export { ResourceService };
+//# sourceMappingURL=resource.service.js.map

package/lib/services/resource.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.service.js","sourceRoot":"","sources":["../../src/services/resource.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,iBAAiB;IAO9D;;;;OAIG;IACH,MAAM,CAAU;IAChB;;;;OAIG;IACH,YAAY,CAAW;IACvB;;;;OAIG;IACH,KAAK,CAAU;IACf;;;;;OAKG;IACH,aAAa,CAAW;IACxB;;;OAGG;IACH,YAAY,CAAU;IACtB;;;;;OAKG;IACH,iBAAiB,CAAU;IAC3B;;;;;OAKG;IACH,gBAAgB,CAAW;IAE3B;;OAEG;IACH,YAAY,MAAY;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,GAAQ,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,KAAK,WAAW,CAAC;QACzB,IAAI,CAAC,YAAY,KAAK,0BAA0B,CAAC;QACjD,IAAI,CAAC,iBAAiB,KAAK,qCAAqC,CAAC;QACjE,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC;QAClB,CAAC;QACD,IAAI,CAAC,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC;QAC5B,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC;QAC5B,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;;;;GAOG;IACG,eAAe;sBAA0E,OAAO;;;iBAAhG,eAAiF,SAAQ,WAAU;;;kCA4FtG,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE;oBACnB,MAAM,EAAE,IAAI;oBACZ,GAAG,EAAE;wBACH,WAAW,EAAE,eAAe;wBAC5B,OAAO,EAAE,UAAU;wBACnB,WAAW,EAAE,aAAa;wBAC1B,SAAS,EAAE;4BACT,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;4BAC1B,KAAK,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE;4BAC1C,KAAK,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE;yBACzC;qBACF;iBACF,CAAC,EACD,KAAK,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,EAAE;oBAC/B,MAAM,EAAE,IAAI;oBACZ,GAAG,EAAE;wBACH,WAAW,EAAE,eAAe;wBAC5B,OAAO,EAAE,UAAU;wBACnB,WAAW,EAAE,cAAc;wBAC3B,SAAS,EAAE;4BACT,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;4BAC1B,KAAK,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE;4BAC1C,KAAK,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE;yBACzC;qBACF;iBACF,CAAC;YACF,qKAAA,MAAM,6DA2CL;;;QAhKD;;WAEG;QACH,SAAS,GAJL,mDAAe,CAID;QAClB;;WAEG;QACH,QAAQ,CAAU;QAElB;;;WAGG;QACH,OAAO;YACL,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;gBAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACtC,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,IAAI;YACR,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,yEAAyE;YACzE,wEAAwE;YACxE,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;gBAClD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE;oBAC/E,MAAM,EAAE,IAAI;oBACZ,GAAG,EAAE;wBACH,WAAW,EAAE,wDAAwD;wBACrE,OAAO,EAAE,uBAAuB;wBAChC,WAAW,EAAE,qBAAqB;wBAClC,SAAS,EAAE;4BACT,KAAK,EAAE;gCACL,WAAW,EAAE,EAAE;6BAChB;yBACF;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;gBACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE;oBAC1C,MAAM,EAAE,IAAI;oBACZ,GAAG,EAAE;wBACH,WAAW,EAAE,+BAA+B;wBAC5C,OAAO,EAAE,gBAAgB;wBACzB,WAAW,EAAE,yBAAyB;wBACtC,SAAS,EAAE;4BACT,KAAK,EAAE;gCACL,WAAW,EAAE,EAAE;6BAChB;yBACF;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;;WAIG;QACH,SAAS,CAAC,GAAgB;YACxB,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC7D,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACzE,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,GAAgB;YAChC,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;YAClC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED;;;;;WAKG;QA2BH,MAAM,CAAC,GAAgB;YACrB,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1B,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAChD,4BAA4B;YAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACrF,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC/B,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;gBACnD,CAAC;qBAAM,IACL,GAAG;qBACA,SAAS,CAAC,UAAU,CAAC;qBACrB,KAAK,CAAC,GAAG,CAAC;qBACV,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;oBAC/B,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EACjC,CAAC;oBACD,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;YAED,yBAAyB;YACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnD,MAAM,IAAI,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAC1C,CAAC;YAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACxD,oBAAoB;gBACpB,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAC5D,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC;gBACD,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;YACnD,CAAC;YACD,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC;YAC/D,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;gBACjC,QAAQ,IAAI,iBAAiB,CAAC;YAChC,CAAC;YACD,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;gBACjB,cAAc,EAAE,QAAQ;gBACxB,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI;gBACzC,eAAe,EAAE,YAAY;aAC9B,CAAC,CAAC;YACH,yDAAyD;YACzD,OAAO,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,CAAC;;;AAGH,OAAO,EAAE,eAAe,EAAE,CAAC"}