@webda/fs 4.0.0-beta.3

package/lib/filebinary.service.js

@@ -0,0 +1,467 @@
+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;
+};
+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;
+};
+import * as fs from "fs";
+import { join } from "path";
+import { BinaryNotFoundError, CloudBinary, CloudBinaryParameters, Inject, MemoryBinaryFile, WebContext, WebdaError } from "@webda/core";
+import { useModelId } from "@webda/core";
+/** Configuration parameters for the filesystem-backed binary storage service. */
+export class FileBinaryParameters extends CloudBinaryParameters {
+    /**
+     * Define the folder to store objects in
+     */
+    folder;
+    /**
+     * Maximum size to handle
+     * @default 10Mb
+     */
+    maxSize;
+    /**
+     * URL to use for direct download
+     */
+    url;
+    /**
+     * Load and normalize parameters, ensuring the folder path has a trailing slash.
+     *
+     * @param params - raw parameter values
+     * @returns this instance for chaining
+     */
+    load(params) {
+        super.load(params);
+        if (this.folder && !this.folder.endsWith("/")) {
+            this.folder += "/";
+        }
+        this.maxSize ??= 10 * 1024 * 1024;
+        // Remove trailing /
+        if (this.url && this.url.endsWith("/")) {
+            this.url = this.url.substring(0, this.url.length - 1);
+        }
+        return this;
+    }
+}
+/**
+ * FileBinary handles the storage of binary on a hard drive
+ *
+ * The structure used for now is
+ * /folder/{hash}/data
+ * /folder/{hash}/{targetStore}_{uuid}
+ * /folder/{hash}/challenge
+ *
+ * It takes one parameter
+ *  folder: "path"
+ *
+ * See Binary the general interface
+ * @category CoreServices
+ * @WebdaModda
+ */
+let FileBinary = (() => {
+    let _classSuper = CloudBinary;
+    let _cryptoService_decorators;
+    let _cryptoService_initializers = [];
+    let _cryptoService_extraInitializers = [];
+    return class FileBinary extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _cryptoService_decorators = [Inject("CryptoService")];
+            __esDecorate(null, null, _cryptoService_decorators, { kind: "field", name: "cryptoService", static: false, private: false, access: { has: obj => "cryptoService" in obj, get: obj => obj.cryptoService, set: (obj, value) => { obj.cryptoService = value; } }, metadata: _metadata }, _cryptoService_initializers, _cryptoService_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        /**
+         * Used for hmac
+         */
+        cryptoService = __runInitializers(this, _cryptoService_initializers, void 0);
+        /**
+         * Load parameters
+         *
+         * @param params - raw parameter values
+         * @returns the loaded parameters
+         */
+        loadParameters(params) {
+            return new FileBinaryParameters().load(params);
+        }
+        /**
+         * Create the storage folder if needed
+         */
+        computeParameters() {
+            super.computeParameters();
+            if (!fs.existsSync(this.parameters.folder)) {
+                fs.mkdirSync(this.parameters.folder, { recursive: true });
+            }
+        }
+        /**
+         * Register download/upload routes if a public URL is configured.
+         *
+         * Routes depend on the runtime `parameters.url` + content hash, so they're
+         * registered programmatically rather than via `@Route`.
+         *
+         * @returns this for chaining
+         */
+        async init() {
+            await super.init();
+            // We do not want to expose by default
+            if (this.parameters.url === undefined) {
+                return this;
+            }
+            // Will redirect to this URL for direct download
+            let url = this.parameters.url + "/download/data/{hash}{?token,content-disposition,content-type}";
+            const name = this.getOperationName();
+            this.addRoute(url, ["GET"], this.downloadBinaryLink, {
+                put: {
+                    operationId: `get${name}Binary`,
+                    description: "Download a binary to an object after challenge",
+                    summary: "Download a binary",
+                    responses: {
+                        "200": {
+                            description: "Content of binary"
+                        },
+                        "403": {
+                            description: "Wrong hash"
+                        }
+                    }
+                }
+            });
+            url = this.parameters.url + "/upload/data/{hash}{?token}";
+            this.addRoute(url, ["PUT"], this.storeBinary, {
+                put: {
+                    operationId: `put${name}Binary`,
+                    description: "Upload a binary to an object after challenge",
+                    summary: "Upload a binary",
+                    responses: {
+                        "204": {
+                            description: ""
+                        },
+                        "400": {
+                            description: "Wrong hash"
+                        },
+                        "404": {
+                            description: "Object does not exist or attachment does not exist"
+                        },
+                        "412": {
+                            description: "Provided hash does not match"
+                        }
+                    }
+                }
+            });
+            return this;
+        }
+        /**
+         * Download a binary with a challenge
+         *
+         * @param ctx - the web context
+         */
+        async downloadBinaryLink(ctx) {
+            const { hash } = ctx.getParameters();
+            // Verify token
+            try {
+                const dt = await this.cryptoService.jwtVerify(ctx.parameter("token"));
+                if (dt.hash !== hash) {
+                    throw new WebdaError.Forbidden("Wrong hash");
+                }
+            }
+            catch (err) {
+                throw new WebdaError.Forbidden("Incorrect JWT");
+            }
+            ctx.writeHead(200, {
+                "content-disposition": ctx.parameter("content-disposition"),
+                "content-type": ctx.parameter("content-type")
+            });
+            const map = await this.get({ hash });
+            // Fake a binary map for this case
+            return new Promise(async (resolve, reject) => {
+                const stream = await ctx.getOutputStream();
+                stream.on("error", reject).on("finish", resolve);
+                map.pipe(stream);
+            });
+        }
+        /**
+         * @override
+         */
+        async _get(info) {
+            const path = this._getPath(info.hash, "data");
+            if (!fs.existsSync(path)) {
+                throw new BinaryNotFoundError(info.hash, this.getName());
+            }
+            return fs.createReadStream(path);
+        }
+        /**
+         * Get signed url to download an element
+         *
+         * @param map - the binary map
+         * @param expires - expiration time in seconds
+         * @param context - the web context
+         * @returns the signed download URL
+         */
+        async getSignedUrlFromMap(map, expires, context) {
+            return `${context
+                .getHttpContext()
+                .getAbsoluteUrl(this.parameters.url + "/download/data/" + map.hash)}?token=${await this.getToken(map.hash, "GET", expires)}&content-type=${map.mimetype}&content-disposition=attachment`;
+        }
+        /**
+         * Get storage path for a hash
+         *
+         * @param hash - the content hash
+         * @param postfix - optional path suffix
+         * @returns the filesystem path
+         */
+        _getPath(hash, postfix = undefined) {
+            if (postfix === undefined) {
+                return this.parameters.folder + hash;
+            }
+            return this.parameters.folder + hash + "/" + postfix;
+        }
+        /**
+         * Create a file if it does not already exist, using the given permission mode.
+         *
+         * @param filePath - path of the file to create
+         * @param mode - file permission mode
+         */
+        _touch(filePath, mode = 0o600) {
+            try {
+                const fd = fs.openSync(filePath, fs.constants.O_CREAT | fs.constants.O_EXCL | fs.constants.O_RDWR, mode);
+                fs.closeSync(fd);
+            }
+            catch (e) {
+                // file existed
+            }
+        }
+        /**
+         * Get token for action
+         *
+         * @param hash - the content hash
+         * @param method - HTTP method (PUT or GET)
+         * @param expiresIn - token TTL in seconds
+         * @returns the signed JWT token
+         */
+        async getToken(hash, method, expiresIn = 60) {
+            return this.cryptoService.jwtSign({ hash, method }, {
+                expiresIn
+            });
+        }
+        /**
+         * Get put URL
+         *
+         * @param ctx - the operation context
+         * @returns the upload URL
+         */
+        async getPutUrl(ctx) {
+            const body = await ctx.getInput();
+            const token = await this.getToken(body.hash, "PUT");
+            if (ctx instanceof WebContext) {
+                return ctx.getHttpContext().getAbsoluteUrl(this.parameters.url + "/upload/data/" + body.hash + `?token=${token}`);
+            }
+            return this.parameters.url + "/upload/data/" + body.hash + `?token=${token}`;
+        }
+        /**
+         * Will give you the redirect url
+         *
+         * @param object - the model instance
+         * @param attribute - the binary attribute name
+         * @param info - optional binary file info
+         * @param context - the operation context
+         * @returns the redirect URL and method, or undefined if already stored
+         */
+        async putRedirectUrl(object, attribute, info, context) {
+            info ??= await context.getInput();
+            const result = { url: await this.getPutUrl(context), method: "PUT" };
+            const marker = `${useModelId(object.constructor)}_${object.getUUID()}_${attribute}`;
+            // Get the target object to add the mapping
+            await this.uploadSuccess(object, attribute, info);
+            if (fs.existsSync(this._getPath(info.hash, marker))) {
+                if (!fs.existsSync(this._getPath(info.hash, "data"))) {
+                    return result;
+                }
+                return;
+            }
+            if (!fs.existsSync(this._getPath(info.hash))) {
+                fs.mkdirSync(this._getPath(info.hash));
+            }
+            this._touch(this._getPath(info.hash, marker));
+            if (this.challenge(info.hash, info.challenge)) {
+                return;
+            }
+            return result;
+        }
+        /**
+         * Store the binary sent
+         *
+         * @param ctx - the web context
+         */
+        async storeBinary(ctx) {
+            const body = await ctx.getHttpContext().getRawBody(this.parameters.maxSize);
+            const result = await new MemoryBinaryFile(body, {
+                mimetype: (ctx.getHttpContext().getUniqueHeader("content-type") || "application/json").split(";")[0],
+                name: "",
+                size: parseInt(ctx.getHttpContext().getUniqueHeader("content-length"))
+            }).getHashes();
+            if (ctx.parameter("hash") !== result.hash) {
+                this.log("WARN", "Request hash differ", ctx.parameter("hash"), "!==", result.hash);
+                throw new WebdaError.BadRequest("Request hash differ");
+            }
+            try {
+                const dt = await this.cryptoService.jwtVerify(ctx.parameter("token"));
+                if (dt.hash !== result.hash) {
+                    this.log("WARN", "JWT hash differ", ctx.parameter("hash"), "!==", result.hash);
+                    throw new WebdaError.Forbidden("JWT hash differ");
+                }
+            }
+            catch (err) {
+                this.log("WARN", "Invalid JWT token");
+                throw new WebdaError.Forbidden("Invalid JWT token");
+            }
+            if (!fs.existsSync(this._getPath(result.hash))) {
+                throw new WebdaError.PreconditionFailed("No folder for hash " + result.hash);
+            }
+            const path = this._getPath(result.hash, "data");
+            if (!fs.existsSync(path)) {
+                fs.writeFileSync(path, body);
+            }
+            this._touch(this._getPath(result.hash, "_" + result.challenge));
+        }
+        /**
+         * @override
+         */
+        async getUsageCount(hash) {
+            const path = this._getPath(hash);
+            if (!fs.existsSync(path)) {
+                return 0;
+            }
+            const files = fs.readdirSync(path);
+            return files.length - 2;
+        }
+        /**
+         * Delete any usage marker and hash
+         *
+         * @param hash - the content hash to clean
+         */
+        async _cleanHash(hash) {
+            const p = this._getPath(hash);
+            if (!fs.existsSync(p))
+                return;
+            try {
+                const files = fs.readdirSync(p);
+                files.forEach(file => fs.unlinkSync(join(p, file)));
+                fs.rmdirSync(p);
+            }
+            catch (err) { }
+        }
+        /**
+         * @override
+         */
+        async _cleanUsage(hash, uuid, attribute) {
+            const p = this._getPath(hash);
+            if (!fs.existsSync(p))
+                return;
+            uuid = uuid.startsWith("_") ? uuid : `_${uuid}`;
+            const files = fs.readdirSync(p);
+            files
+                .filter(f => f.endsWith(attribute ? `_${attribute}${uuid}` : `${uuid}`))
+                .forEach(f => fs.unlinkSync(this._getPath(hash, f)));
+            if (files.length == 3) {
+                await this._cleanHash(hash);
+            }
+        }
+        /**
+         * @override
+         */
+        async delete(object, property, index) {
+            const hash = (index !== undefined ? object[property][index] : object[property]).hash;
+            await this.deleteSuccess(object, property, index);
+            await this._cleanUsage(hash, object.getUUID(), property);
+        }
+        /**
+         * Verify that a binary with the given hash exists and contains the expected challenge marker.
+         *
+         * @param hash - the content hash
+         * @param challenge - the challenge string
+         * @returns true if the challenge marker exists
+         */
+        challenge(hash, challenge) {
+            const path = this._getPath(hash);
+            return fs.existsSync(path) && fs.existsSync(`${path}/_${challenge}`);
+        }
+        /**
+         * @override
+         */
+        async cascadeDelete(info, uuid) {
+            return this._cleanUsage(info.hash, uuid);
+        }
+        /**
+         * Write a binary file's stream to the local filesystem under its content-hash directory.
+         *
+         * @param file - the binary file to store
+         * @param object - the model instance
+         * @param attribute - the binary attribute name
+         */
+        async _store(file, object, attribute) {
+            fs.mkdirSync(this._getPath(file.hash));
+            const map = await file.get();
+            await new Promise((resolve, reject) => {
+                map
+                    .pipe(fs.createWriteStream(this._getPath(file.hash, "data")))
+                    .on("error", reject)
+                    .on("finish", resolve);
+            });
+            this._touch(this._getPath(file.hash, "_" + file.challenge));
+            this._touch(this._getPath(file.hash, `${useModelId(object.constructor)}_${attribute}_${object.getUUID()}`));
+        }
+        /**
+         * @override
+         */
+        async store(object, property, file) {
+            await file.getHashes();
+            const storeName = useModelId(object.constructor);
+            const fileInfo = file.toBinaryFileInfo();
+            this.checkMap(object, property);
+            if (fs.existsSync(this._getPath(file.hash))) {
+                this._touch(this._getPath(file.hash, `${storeName}_${property}_${object.getUUID()}`));
+                await this.uploadSuccess(object, property, fileInfo);
+                return;
+            }
+            await this._store(file, object, property);
+            await this.uploadSuccess(object, property, fileInfo);
+        }
+        /**
+         * Clean all data
+         */
+        async ___cleanData() {
+            (await import("fs-extra")).emptyDirSync(this.parameters.folder);
+        }
+        constructor() {
+            super(...arguments);
+            __runInitializers(this, _cryptoService_extraInitializers);
+        }
+    };
+})();
+export { FileBinary };
+//# sourceMappingURL=filebinary.service.js.map

package/lib/filebinary.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filebinary.service.js","sourceRoot":"","sources":["../src/filebinary.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,OAAO,EAGL,mBAAmB,EAEnB,WAAW,EACX,qBAAqB,EAIrB,MAAM,EACN,gBAAgB,EAEhB,UAAU,EACV,UAAU,EACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,iFAAiF;AACjF,MAAM,OAAO,oBAAqB,SAAQ,qBAAqB;IAC7D;;OAEG;IACH,MAAM,CAAS;IACf;;;OAGG;IACH,OAAO,CAAU;IACjB;;OAEG;IACH,GAAG,CAAU;IAEb;;;;;OAKG;IACH,IAAI,CAAC,MAAW;QACd,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,OAAO,KAAK,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;QAClC,oBAAoB;QACpB,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AACD;;;;;;;;;;;;;;GAcG;IACU,UAAU;sBAAgE,WAAW;;;;iBAArF,UAAkE,SAAQ,WAAc;;;yCAIlG,MAAM,CAAC,eAAe,CAAC;YACxB,yLAAA,aAAa,6BAAb,aAAa,qGAAgB;;;QAJ7B;;WAEG;QAEH,aAAa,gEAAgB;QAC7B;;;;;WAKG;QACH,cAAc,CAAC,MAAW;YACxB,OAAU,IAAI,oBAAoB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;QAED;;WAEG;QACH,iBAAiB;YACf,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC1B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAED;;;;;;;WAOG;QACH,KAAK,CAAC,IAAI;YACR,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,sCAAsC;YACtC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;YACd,CAAC;YACD,gDAAgD;YAChD,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,gEAAgE,CAAC;YACjG,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,kBAAkB,EAAE;gBACnD,GAAG,EAAE;oBACH,WAAW,EAAE,MAAM,IAAI,QAAQ;oBAC/B,WAAW,EAAE,gDAAgD;oBAC7D,OAAO,EAAE,mBAAmB;oBAC5B,SAAS,EAAE;wBACT,KAAK,EAAE;4BACL,WAAW,EAAE,mBAAmB;yBACjC;wBACD,KAAK,EAAE;4BACL,WAAW,EAAE,YAAY;yBAC1B;qBACF;iBACF;aACF,CAAC,CAAC;YAEH,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,6BAA6B,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE;gBAC5C,GAAG,EAAE;oBACH,WAAW,EAAE,MAAM,IAAI,QAAQ;oBAC/B,WAAW,EAAE,8CAA8C;oBAC3D,OAAO,EAAE,iBAAiB;oBAC1B,SAAS,EAAE;wBACT,KAAK,EAAE;4BACL,WAAW,EAAE,EAAE;yBAChB;wBACD,KAAK,EAAE;4BACL,WAAW,EAAE,YAAY;yBAC1B;wBACD,KAAK,EAAE;4BACL,WAAW,EAAE,oDAAoD;yBAClE;wBACD,KAAK,EAAE;4BACL,WAAW,EAAE,8BAA8B;yBAC5C;qBACF;iBACF;aACF,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,kBAAkB,CAAC,GAA2C;YAClE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;YACrC,eAAe;YACf,IAAI,CAAC;gBACH,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtE,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACrB,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YAClD,CAAC;YACD,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;gBACjB,qBAAqB,EAAE,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC;gBAC3D,cAAc,EAAE,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC;aAC9C,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAe,CAAC,CAAC;YAClD,kCAAkC;YAClC,OAAO,IAAI,OAAO,CAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;gBACjD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,eAAe,EAAE,CAAC;gBAC3C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACjD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,IAAI,CAAC,IAAe;YACxB,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QAED;;;;;;;WAOG;QACH,KAAK,CAAC,mBAAmB,CAAC,GAAc,EAAE,OAAe,EAAE,OAAmB;YAC5E,OAAO,GAAG,OAAO;iBACd,cAAc,EAAE;iBAChB,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,iBAAiB,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,QAAQ,CAChG,GAAG,CAAC,IAAI,EACR,KAAK,EACL,OAAO,CACR,iBAAiB,GAAG,CAAC,QAAQ,iCAAiC,CAAC;QAClE,CAAC;QAED;;;;;;WAMG;QACH,QAAQ,CAAC,IAAY,EAAE,OAAO,GAAW,SAAS;YAChD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;YACvC,CAAC;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,GAAG,GAAG,GAAG,OAAO,CAAC;QACvD,CAAC;QAED;;;;;WAKG;QACH,MAAM,CAAC,QAAQ,EAAE,IAAI,GAAG,KAAK;YAC3B,IAAI,CAAC;gBACH,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACzG,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACnB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,eAAe;YACjB,CAAC;QACH,CAAC;QAED;;;;;;;WAOG;QACH,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,MAAqB,EAAE,SAAS,GAAW,EAAE;YACxE,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,EAChB;gBACE,SAAS;aACV,CACF,CAAC;QACJ,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,SAAS,CAAC,GAAiC;YAC/C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACpD,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;gBAC9B,OAAO,GAAG,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,GAAG,UAAU,KAAK,EAAE,CAAC,CAAC;YACpH,CAAC;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,GAAG,UAAU,KAAK,EAAE,CAAC;QAC/E,CAAC;QAED;;;;;;;;WAQG;QACH,KAAK,CAAC,cAAc,CAClB,MAAiB,EACjB,SAAiB,EACjB,IAAiB,EACjB,OAAsC;YAEtC,IAAI,KAAK,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;YACrE,MAAM,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,IAAI,SAAS,EAAE,CAAC;YAEpF,2CAA2C;YAC3C,MAAM,IAAI,CAAC,aAAa,CAAM,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAEvD,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;gBACpD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;oBACrD,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,OAAO;YACT,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC7C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACzC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAC9C,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9C,OAAO;YACT,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,WAAW,CAAC,GAAe;YAC/B,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,cAAc,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC5E,MAAM,MAAM,GAAG,MAAM,IAAI,gBAAgB,CAAC,IAAW,EAAE;gBACrD,QAAQ,EAAE,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,kBAAkB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBACpG,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;aACvE,CAAC,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC1C,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,qBAAqB,EAAE,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;gBACnF,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtE,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;oBAC5B,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;oBAC/E,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;gBACtC,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YACtD,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC/C,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/E,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAChD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAW,CAAC,CAAC;YACtC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAClE,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,aAAa,CAAC,IAAY;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,CAAC;YACX,CAAC;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC1B,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,UAAU,CAAC,IAAY;YAC3B,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBAAE,OAAO;YAC9B,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBAChC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpD,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;QAClB,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,IAAY,EAAE,SAAkB;YAC9D,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBAAE,OAAO;YAC9B,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAChC,KAAK;iBACF,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;iBACvE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAEvD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,MAAM,CAAC,MAA2B,EAAE,QAAgB,EAAE,KAAc;YACxE,MAAM,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAQ,CAAC,CAAC,IAAI,CAAC;YAC5F,MAAM,IAAI,CAAC,aAAa,CAAM,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC3D,CAAC;QAED;;;;;;WAMG;QACH,SAAS,CAAC,IAAI,EAAE,SAAS;YACvB,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjC,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,IAAI,KAAK,SAAS,EAAE,CAAC,CAAC;QACvE,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,aAAa,CAAC,IAAe,EAAE,IAAY;YAC/C,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC;QAED;;;;;;WAMG;QACH,KAAK,CAAC,MAAM,CAAC,IAAgB,EAAE,MAAiB,EAAE,SAAiB;YACjE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACvC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACpC,GAAG;qBACA,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;qBAC5D,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;qBACnB,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9G,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,KAAK,CAAC,MAAiB,EAAE,QAAgB,EAAE,IAAgB;YAC/D,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzC,IAAI,CAAC,QAAQ,CAAM,MAAM,EAAE,QAAQ,CAAC,CAAC;YACrC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,SAAS,IAAI,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;gBACtF,MAAM,IAAI,CAAC,aAAa,CAAM,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBAC1D,OAAO;YACT,CAAC;YACD,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,MAAM,IAAI,CAAC,aAAa,CAAM,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC5D,CAAC;QAED;;WAEG;QACH,KAAK,CAAC,YAAY;YAChB,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClE,CAAC;;;;;;;SAxYU,UAAU"}

package/lib/filequeue.service.d.ts

@@ -0,0 +1,62 @@
+import { Queue, QueueParameters } from "@webda/core";
+import type { MessageReceipt } from "@webda/core";
+/** Configuration parameters for the filesystem-backed FIFO queue. */
+export declare class FileQueueParameters extends QueueParameters {
+    /**
+     * Number of seconds before dropping message
+     *
+     * @default 30
+     */
+    expire?: number;
+    /**
+     * Where to store the queue
+     */
+    folder: string;
+    /** Set default expiration to 30 seconds and convert to milliseconds. */
+    default(): void;
+}
+/**
+ * FIFO Queue on filesystem
+ * @category CoreServices
+ * @WebdaModda
+ */
+export declare class FileQueue<T = any, K extends FileQueueParameters = FileQueueParameters> extends Queue<T, K> {
+    /**
+     * @override
+     */
+    loadParameters(params: any): K;
+    /**
+     * Create the storage folder if does not exist
+     */
+    computeParameters(): void;
+    /**
+     * @override
+     */
+    size(): Promise<number>;
+    /**
+     * Return file
+     *
+     * @param uid - the message unique identifier
+     * @returns the file path
+     */
+    getFile(uid: string): string;
+    /**
+     * @override
+     */
+    sendMessage(params: any): Promise<void>;
+    /**
+     * @override
+     */
+    receiveMessage<L>(proto?: {
+        new (): L;
+    }): Promise<MessageReceipt<L>[]>;
+    /**
+     * @override
+     */
+    deleteMessage(receipt: any): Promise<void>;
+    /**
+     * @inheritdoc
+     */
+    __clean(): Promise<void>;
+}
+//# sourceMappingURL=filequeue.service.d.ts.map

package/lib/filequeue.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filequeue.service.d.ts","sourceRoot":"","sources":["../src/filequeue.service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAErD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,qEAAqE;AACrE,qBAAa,mBAAoB,SAAQ,eAAe;IACtD;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,wEAAwE;IACxE,OAAO,SAGN;CACF;AAED;;;;GAIG;AACH,qBAAa,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,CAAE,SAAQ,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IACtG;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAE7B;IAED;;OAEG;IACH,iBAAiB,SAMhB;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAE5B;IAED;;;;;OAKG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3B;IAED;;OAEG;IACG,WAAW,CAAC,MAAM,KAAA,iBAQvB;IAED;;OAEG;IACG,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAyC3E;IAED;;OAEG;IACG,aAAa,CAAC,OAAO,KAAA,iBAQ1B;IAED;;OAEG;IACG,OAAO,kBAEZ;CACF"}