@codification/cutwater-aws/lib/s3/S3Bucket.js

A library providing general functionality for TypeScript based AWS projects.

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
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.S3Bucket = void 0;
const client_s3_1 = require("@aws-sdk/client-s3");
const mime = __importStar(require("mime"));
const stream_1 = require("stream");
/**
 * @beta
 */
class S3Bucket {
    static toMimeType(key) {
        return mime.getType(key) || '';
    }
    constructor(bucketName, client) {
        this.bucketName = bucketName;
        this.s3Client = client ? client : new client_s3_1.S3();
    }
    setBucketName(name) {
        if (!name) {
            throw new Error('Bucket name is required.');
        }
        this.bucketName = name;
    }
    headObject(fileName) {
        return __awaiter(this, void 0, void 0, function* () {
            try {
                return yield this.s3Client.headObject({ Bucket: this.bucketName, Key: fileName });
            }
            catch (err) {
                if (err.code !== 'NotFound') {
                    throw err;
                }
            }
            return undefined;
        });
    }
    size(fileName) {
        return __awaiter(this, void 0, void 0, function* () {
            const head = yield this.headObject(fileName);
            return !!head ? head.ContentLength : undefined;
        });
    }
    exists(fileName) {
        return __awaiter(this, void 0, void 0, function* () {
            return !!(yield this.headObject(fileName));
        });
    }
    toDeleteObjectsRequest(keys) {
        return {
            Bucket: this.bucketName,
            Delete: {
                Objects: keys.map((key) => {
                    return { Key: key };
                }),
            },
        };
    }
    remove(...fileNames) {
        return __awaiter(this, void 0, void 0, function* () {
            if (fileNames.length < 1) {
                return;
            }
            yield this.s3Client.deleteObjects(this.toDeleteObjectsRequest(fileNames));
        });
    }
    loadBuffer(fileName) {
        return __awaiter(this, void 0, void 0, function* () {
            const output = yield this.load(fileName);
            if (!Buffer.isBuffer(output.Body)) {
                throw new Error(`Object is "${typeof output.Body}", not a Buffer.`);
            }
            return output.Body;
        });
    }
    toBaseObjectRequest(key) {
        return {
            Bucket: this.bucketName,
            Key: key,
        };
    }
    toPutObjectRequest(key, content, options = {}) {
        const Body = typeof content == 'string'
            ? stream_1.Readable.from(Buffer.from(content))
            : content instanceof Buffer
                ? stream_1.Readable.from(content)
                : content;
        const rval = Object.assign(Object.assign(Object.assign({}, this.toBaseObjectRequest(key)), { Body }), options);
        return rval;
    }
    load(fileName) {
        return __awaiter(this, void 0, void 0, function* () {
            return yield this.s3Client.getObject(this.toBaseObjectRequest(fileName));
        });
    }
    store(fileName, content, options) {
        return __awaiter(this, void 0, void 0, function* () {
            return yield this.s3Client.putObject(this.toPutObjectRequest(fileName, content, options));
        });
    }
}
exports.S3Bucket = S3Bucket;
//# sourceMappingURL=S3Bucket.js.map