@webda/core 2.0.0-beta.3 → 2.1.0

package/lib/services/binary.js

@@ -5,39 +5,27 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Binary = exports.BinaryParameters = exports.BinaryMap = exports.MemoryBinaryFile = exports.LocalBinaryFile = exports.BinaryFile = exports.BinaryNotFoundError = void 0;
-const crypto = require("crypto");
-const fs = require("fs");
-const mime = require("mime-types");
-const path = require("path");
-const stream_1 = require("stream");
-const __1 = require("..");
-const coremodel_1 = require("../models/coremodel");
-const store_1 = require("../stores/store");
-const service_1 = require("./service");
+import * as crypto from "crypto";
+import * as fs from "fs";
+import * as mime from "mime-types";
+import * as path from "path";
+import { Readable } from "stream";
+import { WebdaError } from "../index.js";
+import { NotEnumerable } from "../models/coremodel.js";
+import { Store } from "../stores/store.js";
+import { Service, ServiceParameters } from "./service.js";
 /**
  * Emitted if binary does not exist
  */
-class BinaryNotFoundError extends __1.WebdaError {
+export class BinaryNotFoundError extends WebdaError {
     constructor(hash, storeName) {
         super("BINARY_NOTFOUND", `Binary not found ${hash} BinaryService(${storeName})`);
     }
 }
-exports.BinaryNotFoundError = BinaryNotFoundError;
 /**
  * Represent a file to store
  */
-class BinaryFile {
+export class BinaryFile {
     constructor(info) {
         this.name = info.name;
         this.challenge = info.challenge;
@@ -64,37 +52,34 @@ class BinaryFile {
      * @param buffer
      * @returns
      */
-    getHashes() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.hash) {
-                // Using MD5 as S3 content verification use md5
-                const hash = crypto.createHash("md5");
-                const challenge = crypto.createHash("md5");
-                const stream = yield this.get();
-                challenge.update("WEBDA");
-                yield new Promise((resolve, reject) => {
-                    stream.on("error", err => reject(err));
-                    stream.on("end", () => {
-                        this.hash = hash.digest("hex");
-                        this.challenge = challenge.digest("hex");
-                        resolve();
-                    });
-                    stream.on("data", chunk => {
-                        let buffer = Buffer.from(chunk);
-                        hash.update(buffer);
-                        challenge.update(buffer);
-                    });
+    async getHashes() {
+        if (!this.hash) {
+            // Using MD5 as S3 content verification use md5
+            const hash = crypto.createHash("md5");
+            const challenge = crypto.createHash("md5");
+            const stream = await this.get();
+            challenge.update("WEBDA");
+            await new Promise((resolve, reject) => {
+                stream.on("error", err => reject(err));
+                stream.on("end", () => {
+                    this.hash = hash.digest("hex");
+                    this.challenge = challenge.digest("hex");
+                    resolve();
                 });
-            }
-            return {
-                hash: this.hash,
-                challenge: this.challenge
-            };
-        });
+                stream.on("data", chunk => {
+                    let buffer = Buffer.from(chunk);
+                    hash.update(buffer);
+                    challenge.update(buffer);
+                });
+            });
+        }
+        return {
+            hash: this.hash,
+            challenge: this.challenge
+        };
     }
 }
-exports.BinaryFile = BinaryFile;
-class LocalBinaryFile extends BinaryFile {
+export class LocalBinaryFile extends BinaryFile {
     constructor(filePath) {
         super({
             name: path.basename(filePath),
@@ -106,14 +91,11 @@ class LocalBinaryFile extends BinaryFile {
     /**
      * @override
      */
-    get() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return fs.createReadStream(this.path);
-        });
+    async get() {
+        return fs.createReadStream(this.path);
     }
 }
-exports.LocalBinaryFile = LocalBinaryFile;
-class MemoryBinaryFile extends BinaryFile {
+export class MemoryBinaryFile extends BinaryFile {
     constructor(buffer, info) {
         super(info);
         this.buffer = buffer;
@@ -121,22 +103,19 @@ class MemoryBinaryFile extends BinaryFile {
     /**
      * @override
      */
-    get() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return stream_1.Readable.from(this.buffer);
-        });
+    async get() {
+        return Readable.from(this.buffer);
     }
 }
-exports.MemoryBinaryFile = MemoryBinaryFile;
 /**
  * This is a map used to retrieve binary
  *
  * @class BinaryMap
  */
-class BinaryMap extends BinaryFile {
+export class BinaryMap extends BinaryFile {
     constructor(service, obj) {
         super(obj);
-        for (var i in obj) {
+        for (let i in obj) {
             this[i] = obj[i];
         }
         this.__store = service;
@@ -169,10 +148,8 @@ class BinaryMap extends BinaryFile {
      *
      * @param filename
      */
-    downloadTo(filename) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.__store.downloadTo(this, filename);
-        });
+    async downloadTo(filename) {
+        return this.__store.downloadTo(this, filename);
     }
     /**
      * Set the http context
@@ -183,23 +160,20 @@ class BinaryMap extends BinaryFile {
     }
 }
 __decorate([
-    coremodel_1.NotEnumerable
+    NotEnumerable
 ], BinaryMap.prototype, "__ctx", void 0);
 __decorate([
-    coremodel_1.NotEnumerable
+    NotEnumerable
 ], BinaryMap.prototype, "__store", void 0);
-exports.BinaryMap = BinaryMap;
-class BinaryParameters extends service_1.ServiceParameters {
+export class BinaryParameters extends ServiceParameters {
     constructor(params, _service) {
-        var _a;
         super(params);
         if (this.expose) {
             this.expose.restrict = this.expose.restrict || {};
         }
-        (_a = this.map) !== null && _a !== void 0 ? _a : (this.map = {});
+        this.map ?? (this.map = {});
     }
 }
-exports.BinaryParameters = BinaryParameters;
 /**
  * This is an abstract service to represent a storage of files
  * The binary allow you to expose this service as HTTP
@@ -223,21 +197,19 @@ exports.BinaryParameters = BinaryParameters;
  * @abstract
  * @class Binary
  */
-class Binary extends service_1.Service {
+class Binary extends Service {
     /**
      * Get a binary
      *
      * @param {Object} info The reference stored in your target object
      * @emits 'binaryGet'
      */
-    get(info) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.emitSync("Binary.Get", {
-                object: info,
-                service: this
-            });
-            return this._get(info);
+    async get(info) {
+        await this.emitSync("Binary.Get", {
+            object: info,
+            service: this
         });
+        return this._get(info);
     }
     /**
      * Download a binary to a file
@@ -245,29 +217,29 @@ class Binary extends service_1.Service {
      * @param {Object} info The reference stored in your target object
      * @param {String} filepath to save the binary to
      */
-    downloadTo(info, filename) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.emitSync("Binary.Get", {
-                object: info,
-                service: this
+    async downloadTo(info, filename) {
+        await this.emitSync("Binary.Get", {
+            object: info,
+            service: this
+        });
+        let readStream = await this._get(info);
+        let writeStream = fs.createWriteStream(filename);
+        return new Promise((resolve, reject) => {
+            writeStream.on("finish", _src => {
+                return resolve();
             });
-            var readStream = yield this._get(info);
-            var writeStream = fs.createWriteStream(filename);
-            return new Promise((resolve, reject) => {
-                writeStream.on("finish", _src => {
-                    return resolve();
-                });
-                writeStream.on("error", src => {
-                    try {
-                        fs.unlinkSync(filename);
-                    }
-                    catch (err) {
-                        this._webda.log("ERROR", err);
-                    }
-                    return reject(src);
-                });
-                readStream.pipe(writeStream);
+            writeStream.on("error", src => {
+                try {
+                    fs.unlinkSync(filename);
+                    // Stubing the fs module in ESM seems complicated for now
+                    /* c8 ignore next 3 */
+                }
+                catch (err) {
+                    this._webda.log("ERROR", err);
+                }
+                return reject(src);
             });
+            readStream.pipe(writeStream);
         });
     }
     /**
@@ -291,7 +263,7 @@ class Binary extends service_1.Service {
         Object.keys(map).forEach(prop => {
             this._lowercaseMaps[prop.toLowerCase()] = prop;
             let reverseStore = this._webda.getService(prop);
-            if (reverseStore === undefined || !(reverseStore instanceof store_1.Store)) {
+            if (reverseStore === undefined || !(reverseStore instanceof Store)) {
                 this._webda.log("WARN", "Can't setup mapping as store ", prop, " doesn't exist");
                 map[prop]["-onerror"] = "NoStore";
                 return;
@@ -300,13 +272,13 @@ class Binary extends service_1.Service {
                 reverseStore.addReverseMap(map[prop][i], this);
             }
             // Cascade delete
-            reverseStore.on("Store.Deleted", (evt) => __awaiter(this, void 0, void 0, function* () {
+            reverseStore.on("Store.Deleted", async (evt) => {
                 let infos = [];
                 if (evt.object[map[prop]]) {
                     infos.push(...evt.object[map[prop]]);
                 }
-                yield Promise.all(infos.map(info => this.cascadeDelete(info, evt.object.getUuid())));
-            }));
+                await Promise.all(infos.map(info => this.cascadeDelete(info, evt.object.getUuid())));
+            });
         });
     }
     /**
@@ -314,7 +286,7 @@ class Binary extends service_1.Service {
      * @param obj
      * @returns
      */
-    initModel(obj) {
+    newModel(obj) {
         return new BinaryMap(this, obj);
     }
     /**
@@ -339,7 +311,7 @@ class Binary extends service_1.Service {
      * @param property
      */
     checkMap(name, property) {
-        var map = this.parameters.map[this._lowercaseMaps[name.toLowerCase()]];
+        let map = this.parameters.map[this._lowercaseMaps[name.toLowerCase()]];
         if (map === undefined) {
             throw Error("Unknown mapping");
         }
@@ -350,20 +322,18 @@ class Binary extends service_1.Service {
     /**
      * Ensure events are sent correctly after an upload and update the BinaryFileInfo in targetted object
      */
-    uploadSuccess(object, property, file) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var object_uid = object.getUuid();
-            yield this.emitSync("Binary.UploadSuccess", {
-                object: file,
-                service: this,
-                target: object
-            });
-            yield object.getStore().upsertItemToCollection(object_uid, property, file);
-            yield this.emitSync("Binary.Create", {
-                object: file,
-                service: this,
-                target: object
-            });
+    async uploadSuccess(object, property, file) {
+        let object_uid = object.getUuid();
+        await this.emitSync("Binary.UploadSuccess", {
+            object: file,
+            service: this,
+            target: object
+        });
+        await object.getStore().upsertItemToCollection(object_uid, property, file);
+        await this.emitSync("Binary.Create", {
+            object: file,
+            service: this,
+            target: object
         });
     }
     /**
@@ -374,31 +344,27 @@ class Binary extends service_1.Service {
      * @param index
      * @returns
      */
-    deleteSuccess(object, property, index) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var info = object[property][index];
-            let update = object.getStore().deleteItemFromCollection(object.getUuid(), property, index, info.hash, "hash");
-            yield this.emitSync("Binary.Delete", {
-                object: info,
-                service: this
-            });
-            return update;
+    async deleteSuccess(object, property, index) {
+        let info = object[property][index];
+        let update = object.getStore().deleteItemFromCollection(object.getUuid(), property, index, info.hash, "hash");
+        await this.emitSync("Binary.Delete", {
+            object: info,
+            service: this
         });
+        return update;
     }
     /**
      * Get file either from multipart post or raw
      * @param req
      * @returns
      */
-    _getFile(req) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let file = yield req.getHttpContext().getRawBody(10 * 1024 * 1024);
-            // TODO Check if we have other type
-            return new MemoryBinaryFile(Buffer.from(file), {
-                mimetype: req.getHttpContext().getUniqueHeader("Content-Type", "application/octet-stream"),
-                size: parseInt(req.getHttpContext().getUniqueHeader("Content-Length")) || file.length,
-                name: ""
-            });
+    async _getFile(req) {
+        let file = await req.getHttpContext().getRawBody(10 * 1024 * 1024);
+        // TODO Check if we have other type
+        return new MemoryBinaryFile(Buffer.from(file), {
+            mimetype: req.getHttpContext().getUniqueHeader("Content-Type", "application/octet-stream"),
+            size: parseInt(req.getHttpContext().getUniqueHeader("Content-Length")) || file.length,
+            name: ""
         });
     }
     /**
@@ -558,14 +524,14 @@ class Binary extends service_1.Service {
     _verifyMapAndStore(ctx) {
         let store = ctx.parameter("store").toLowerCase();
         // To avoid any probleme lowercase everything
-        var map = this.parameters.map[this._lowercaseMaps[store]];
+        let map = this.parameters.map[this._lowercaseMaps[store]];
         if (map === undefined) {
             throw 404;
         }
         if (map.indexOf(ctx.parameter("property")) == -1) {
             throw 404;
         }
-        var targetStore = this.getService(store);
+        let targetStore = this.getService(store);
         if (targetStore === undefined) {
             throw 404;
         }
@@ -576,125 +542,126 @@ class Binary extends service_1.Service {
      *
      * @param ctx
      */
-    putRedirectUrl(_ctx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Dont handle the redirect url
-            throw 404;
-        });
+    async putRedirectUrl(_ctx) {
+        // Dont handle the redirect url
+        throw 404;
     }
     /**
      * Mechanism to add a data based on challenge
      */
-    httpChallenge(ctx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let body = yield ctx.getRequestBody();
-            if (!body.hash || !body.challenge) {
-                throw 400;
-            }
-            // First verify if map exist
-            let targetStore = this._verifyMapAndStore(ctx);
-            // Get the object
-            let object = yield targetStore.get(ctx.parameter("uid"), ctx);
-            if (object === undefined) {
-                throw 404;
-            }
-            yield object.canAct(ctx, "attach_binary");
-            let url = yield this.putRedirectUrl(ctx);
-            let base64String = Buffer.from(body.hash, "hex").toString("base64");
-            ctx.write(Object.assign(Object.assign({}, url), { done: url === undefined, md5: base64String }));
+    async httpChallenge(ctx) {
+        let body = await ctx.getRequestBody();
+        if (!body.hash || !body.challenge) {
+            throw 400;
+        }
+        // First verify if map exist
+        let targetStore = this._verifyMapAndStore(ctx);
+        // Get the object
+        let object = await targetStore.get(ctx.parameter("uid"), ctx);
+        if (object === undefined) {
+            throw 404;
+        }
+        await object.canAct(ctx, "attach_binary");
+        let url = await this.putRedirectUrl(ctx);
+        let base64String = Buffer.from(body.hash, "hex").toString("base64");
+        ctx.write({
+            ...url,
+            done: url === undefined,
+            md5: base64String
         });
     }
     /**
      * Manage the different routes
      * @param ctx
      */
-    httpRoute(ctx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // First verify if map exist
-            let targetStore = this._verifyMapAndStore(ctx);
-            // Get the object
-            let object = yield targetStore.get(ctx.parameter("uid"), ctx);
-            if (object === undefined) {
-                throw 404;
-            }
-            let property = ctx.parameter("property");
-            let index = ctx.parameter("index");
-            // Should be an array
-            if (!Array.isArray(object[property]) || object[property].length <= index) {
-                throw 404;
-            }
-            // Check permissions
-            let action = "unknown";
-            if (ctx.getHttpContext().getMethod() === "GET") {
-                action = "get_binary";
-            }
-            else if (ctx.getHttpContext().getMethod() === "DELETE") {
-                action = "detach_binary";
-            }
-            else if (ctx.getHttpContext().getMethod() === "POST") {
-                action = "attach_binary";
+    async httpRoute(ctx) {
+        // First verify if map exist
+        let targetStore = this._verifyMapAndStore(ctx);
+        // Get the object
+        let object = await targetStore.get(ctx.parameter("uid"), ctx);
+        if (object === undefined) {
+            throw 404;
+        }
+        let property = ctx.parameter("property");
+        let index = ctx.parameter("index");
+        // Should be an array
+        if (!Array.isArray(object[property]) || object[property].length <= index) {
+            throw 404;
+        }
+        // Check permissions
+        let action = "unknown";
+        if (ctx.getHttpContext().getMethod() === "GET") {
+            action = "get_binary";
+        }
+        else if (ctx.getHttpContext().getMethod() === "DELETE") {
+            action = "detach_binary";
+        }
+        else if (ctx.getHttpContext().getMethod() === "POST") {
+            action = "attach_binary";
+        }
+        else if (ctx.getHttpContext().getMethod() === "PUT") {
+            action = "update_binary_metadata";
+        }
+        await object.canAct(ctx, action);
+        // Now do the action
+        if (ctx.getHttpContext().getMethod() === "GET") {
+            // Most implementation override this to do a REDIRECT to a GET url
+            let file = object[property][index];
+            ctx.writeHead(200, {
+                "Content-Type": file.mimetype === undefined ? "application/octet-steam" : file.mimetype,
+                "Content-Length": file.size
+            });
+            let readStream = await this.get(file);
+            try {
+                await new Promise((resolve, reject) => {
+                    // We replaced all the event handlers with a simple call to readStream.pipe()
+                    ctx._stream.on("finish", resolve);
+                    ctx._stream.on("error", reject);
+                    readStream.pipe(ctx._stream);
+                });
             }
-            else if (ctx.getHttpContext().getMethod() === "PUT") {
-                action = "update_binary_metadata";
+            catch (err) {
+                this.log("ERROR", err);
+                throw 500;
             }
-            yield object.canAct(ctx, action);
-            // Now do the action
-            if (ctx.getHttpContext().getMethod() === "GET") {
-                // Most implementation override this to do a REDIRECT to a GET url
-                var file = object[property][index];
-                ctx.writeHead(200, {
-                    "Content-Type": file.mimetype === undefined ? "application/octet-steam" : file.mimetype,
-                    "Content-Length": file.size
-                });
-                let readStream = yield this.get(file);
-                try {
-                    yield new Promise((resolve, reject) => {
-                        // We replaced all the event handlers with a simple call to readStream.pipe()
-                        ctx._stream.on("finish", resolve);
-                        ctx._stream.on("error", reject);
-                        readStream.pipe(ctx._stream);
-                    });
-                }
-                catch (err) {
-                    this.log("ERROR", err);
-                    throw 500;
-                }
+        }
+        else {
+            if (ctx.getHttpContext().getMethod() === "POST") {
+                await this.store(object, property, await this._getFile(ctx), await ctx.getRequestBody());
             }
             else {
-                if (ctx.getHttpContext().getMethod() === "POST") {
-                    yield this.store(object, property, yield this._getFile(ctx), yield ctx.getRequestBody());
+                if (object[property][index].hash !== ctx.parameter("hash")) {
+                    throw 412;
                 }
-                else {
-                    if (object[property][index].hash !== ctx.parameter("hash")) {
-                        throw 412;
-                    }
-                    if (ctx.getHttpContext().getMethod() === "DELETE") {
-                        yield this.delete(object, property, index);
-                    }
-                    else if (ctx.getHttpContext().getMethod() === "PUT") {
-                        let metadata = yield ctx.getRequestBody();
-                        // Limit metadata to 4kb
-                        if (JSON.stringify(metadata).length >= 4096) {
-                            throw 400;
-                        }
-                        let evt = {
-                            service: this,
-                            object: object[property][index],
-                            target: object
-                        };
-                        yield this.emitSync("Binary.MetadataUpdate", Object.assign(Object.assign({}, evt), { metadata }));
-                        object[property][index].metadata = metadata;
-                        // Update mapper on purpose
-                        yield object.getStore().patch({
-                            [object.__class.getUuidField()]: object.getUuid(),
-                            [property]: object[property].map(b => b.toJSON())
-                        }, false);
-                        yield this.emitSync("Binary.MetadataUpdated", evt);
+                if (ctx.getHttpContext().getMethod() === "DELETE") {
+                    await this.delete(object, property, index);
+                }
+                else if (ctx.getHttpContext().getMethod() === "PUT") {
+                    let metadata = await ctx.getRequestBody();
+                    // Limit metadata to 4kb
+                    if (JSON.stringify(metadata).length >= 4096) {
+                        throw 400;
                     }
+                    let evt = {
+                        service: this,
+                        object: object[property][index],
+                        target: object
+                    };
+                    await this.emitSync("Binary.MetadataUpdate", {
+                        ...evt,
+                        metadata
+                    });
+                    object[property][index].metadata = metadata;
+                    // Update mapper on purpose
+                    await object.getStore().patch({
+                        [object.__class.getUuidField()]: object.getUuid(),
+                        [property]: object[property].map(b => b.toJSON())
+                    }, false);
+                    await this.emitSync("Binary.MetadataUpdated", evt);
                 }
             }
-        });
+        }
     }
 }
-exports.Binary = Binary;
+export { Binary };
 //# sourceMappingURL=binary.js.map