@gravitywelluk/aws/dist/s3/delete-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.deleteObjectFromS3 = void 0;
const Joi = __importStar(require("joi"));
const validation_utils_1 = require("@gravitywelluk/validation-utils");
const utils_1 = require("../utils");
const s3_configure_1 = require("./s3-configure");
/**
 * Deletes an object from AWS S3
 *
 * @param deleteObjectParams - The parameters required to delete the object from S3
 * @param awsS3ConfigOverrides - Configuration option overrides
 */
const deleteObjectFromS3 = async (deleteObjectParams, awsS3ConfigOverrides = {}) => {
    const s3 = (0, s3_configure_1.s3Configure)(awsS3ConfigOverrides);
    const { error } = Joi.object({
        bucket: Joi.string().required(),
        key: Joi.string().required()
    }).unknown(true).validate(deleteObjectParams);
    // Error if there any Joi validation errors
    if (error) {
        throw new validation_utils_1.JoiError(error);
    }
    try {
        return await s3.deleteObject({
            Bucket: deleteObjectParams.bucket,
            Key: deleteObjectParams.key
        }).promise();
    }
    catch (error) {
        throw new utils_1.AwsError(error);
    }
};
exports.deleteObjectFromS3 = deleteObjectFromS3;