@gravitywelluk/aws/dist/s3/get-object-from-s3.js

Library of commonly used AWS wrapper functions to communicate with the AWS SDK

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (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;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getObjectFromS3 = void 0;
const Joi = __importStar(require("joi"));
const validation_utils_1 = require("@gravitywelluk/validation-utils");
const s3_configure_1 = require("./s3-configure");
const aws_error_1 = require("../utils/aws-error");
/**
 * Gets an object from AWS S3
 *
 * @param asStream - Whether to return a stream
 * @param getObjectParams - The parameters required to get the object from S3
 * @param awsS3ConfigOverrides - Configuration option overrides
 */
// @ts-ignore - TSC not clever enough to work out the return types, however, this is functionally correct
const getObjectFromS3 = async (asStream, getObjectParams, awsS3ConfigOverrides = {}) => {
    const s3 = (0, s3_configure_1.s3Configure)(awsS3ConfigOverrides);
    const { error } = Joi.object({
        bucket: Joi.string().required(),
        path: Joi.string().required()
    }).unknown(true).validate(getObjectParams);
    // Error if there any Joi validation errors
    if (error) {
        throw new validation_utils_1.JoiError(error);
    }
    // Return the S3 file as a stream
    if (asStream === true) {
        return s3.getObject({
            Bucket: getObjectParams.bucket,
            Key: getObjectParams.path
        }).createReadStream();
    }
    try {
        return await s3.getObject({
            Bucket: getObjectParams.bucket,
            Key: getObjectParams.path
        }).promise();
    }
    catch (error) {
        throw new aws_error_1.AwsError(error);
    }
};
exports.getObjectFromS3 = getObjectFromS3;