@signageos/lib 23.8.1 → 23.8.2-master.4405

package/dist/AWS/S3.d.ts

@@ -0,0 +1,95 @@
+import { S3ClientConfig } from '@aws-sdk/client-s3';
+import { BucketExistsArgs, CreateBucketArgs, CreateBucketResponse, DeleteBucketArgs, DeleteFileArgs, DeleteObjectArgs, DownloadFileArgs, GetMetadataArgs, GetObjectArgs, GetObjectResponse, GetPresignedUrlArgs, HeadObject, ListFilesArgs, PutBucketPolicyArgs, UploadContentArgs, UploadFileArgs, UploadStreamArgs } from './S3Types';
+/**
+ * Wrapper for AWS S3 client
+ *
+ * All commonly used operations with S3 will be implemented here to provide a consistent interface across the codebase.
+ */
+export interface IAwsS3 {
+    /**
+     * Upload a local file to S3
+     */
+    uploadFile(args: UploadFileArgs): Promise<void>;
+    /**
+     * Upload contents of a file stored in memory directly to S3
+     */
+    uploadContent(args: UploadContentArgs): Promise<void>;
+    /**
+     * Upload stream to S3
+     */
+    uploadStream(args: UploadStreamArgs): Promise<void>;
+    /**
+     * Download a file from S3 to local file system
+     */
+    downloadFile({ bucket, remotePath, filePath }: DownloadFileArgs): Promise<void>;
+    /**
+     * List files in a particular path in a bucket
+     */
+    listFiles({ bucket, remotePath }: ListFilesArgs): Promise<string[]>;
+    /**
+     * Delete a file from S3
+     */
+    deleteFile(args: DeleteFileArgs): Promise<void>;
+    /**
+     * Get object head
+     */
+    getObjectHead({ bucket, remotePath }: GetMetadataArgs): Promise<HeadObject>;
+    /**
+     * Gets an object from a bucket
+     */
+    getObject({ bucket, key }: GetObjectArgs): Promise<GetObjectResponse>;
+    /**
+     * Removes an object from a bucket
+     */
+    deleteObject({ bucket, key }: DeleteObjectArgs): Promise<void>;
+    /**
+     * Creates a S3 bucket
+     */
+    createBucket({ bucket }: CreateBucketArgs): Promise<CreateBucketResponse>;
+    /**
+     * Removes a S3 bucket
+     */
+    deleteBucket({ bucket }: DeleteBucketArgs): Promise<void>;
+    /**
+     * Checks if S3 bucket exists
+     */
+    bucketExists({ bucket }: BucketExistsArgs): Promise<boolean>;
+    /**
+     * Sets a permission policy on a S3 bucket
+     */
+    putBucketPolicy({ bucket, policy }: PutBucketPolicyArgs): Promise<void>;
+    /**
+     * Get a pre-signed URL for an object in a bucket
+     * @param bucket - bucket name
+     * @param remotePath - path to the object in the bucket
+     * @param expiration - URL expiration time in seconds
+     */
+    getPresignedUrl({ bucket, remotePath, expirationInSec }: GetPresignedUrlArgs): Promise<string>;
+}
+/**
+ * Wrapper for AWS S3 client
+ *
+ * All commonly used operations with S3 will be implemented here to provide a consistent interface across the codebase.
+ */
+export declare class AwsS3 implements IAwsS3 {
+    private client;
+    /**
+     * @param config.forcePathStyle - Whether to use path style URLs for S3 requests.
+     * Defaults to the value of the `AWS_S3_FORCE_PATH_STYLE_URLS` environment variable or false if not set.
+     */
+    constructor(config?: S3ClientConfig);
+    uploadFile({ filePath, bucket, remotePath, contentType, metadata }: UploadFileArgs): Promise<void>;
+    uploadContent({ content, bucket, remotePath, contentType, metadata }: UploadContentArgs): Promise<void>;
+    uploadStream({ bucket, remotePath, stream }: UploadStreamArgs): Promise<void>;
+    downloadFile({ bucket, remotePath, filePath }: DownloadFileArgs): Promise<void>;
+    listFiles({ bucket, remotePath, maxKeys, startAfterKey }: ListFilesArgs): Promise<string[]>;
+    deleteFile({ bucket, remotePath }: DeleteFileArgs): Promise<void>;
+    getObjectHead({ bucket, remotePath }: GetMetadataArgs): Promise<HeadObject>;
+    getObject({ bucket, key }: GetObjectArgs): Promise<GetObjectResponse>;
+    deleteObject({ bucket, key }: DeleteObjectArgs): Promise<void>;
+    createBucket({ bucket }: CreateBucketArgs): Promise<CreateBucketResponse>;
+    deleteBucket({ bucket }: DeleteBucketArgs): Promise<void>;
+    bucketExists({ bucket }: BucketExistsArgs): Promise<boolean>;
+    putBucketPolicy({ bucket, policy }: PutBucketPolicyArgs): Promise<void>;
+    getPresignedUrl({ bucket, remotePath, expirationInSec }: GetPresignedUrlArgs): Promise<string>;
+}

package/dist/AWS/S3.js

@@ -0,0 +1,448 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwsS3 = void 0;
+var fs_1 = require("fs");
+var client_s3_1 = require("@aws-sdk/client-s3");
+var fs_extra_1 = require("fs-extra");
+var debugDecorator_1 = require("../Debug/debugDecorator");
+var config_1 = require("./config");
+var lib_storage_1 = require("@aws-sdk/lib-storage");
+var s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
+var DEBUG_NAMESPACE = '@signageos/lib:AWS:S3';
+/**
+ * Wrapper for AWS S3 client
+ *
+ * All commonly used operations with S3 will be implemented here to provide a consistent interface across the codebase.
+ */
+var AwsS3 = /** @class */ (function () {
+    /**
+     * @param config.forcePathStyle - Whether to use path style URLs for S3 requests.
+     * Defaults to the value of the `AWS_S3_FORCE_PATH_STYLE_URLS` environment variable or false if not set.
+     */
+    function AwsS3(config) {
+        if (config === void 0) { config = {}; }
+        config = (0, config_1.getUpdatedS3ClientConfigWithCustomEnvVars)(config);
+        this.client = new client_s3_1.S3Client(config);
+    }
+    AwsS3.prototype.uploadFile = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var fileStream, upload;
+            var filePath = _b.filePath, bucket = _b.bucket, remotePath = _b.remotePath, contentType = _b.contentType, metadata = _b.metadata;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        fileStream = (0, fs_1.createReadStream)(filePath);
+                        upload = new lib_storage_1.Upload({
+                            client: this.client,
+                            params: { Bucket: bucket, Key: remotePath, Body: fileStream, ContentType: contentType, Metadata: metadata },
+                        });
+                        return [4 /*yield*/, upload.done()];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.uploadContent = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var upload;
+            var content = _b.content, bucket = _b.bucket, remotePath = _b.remotePath, contentType = _b.contentType, metadata = _b.metadata;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        upload = new lib_storage_1.Upload({
+                            client: this.client,
+                            params: { Bucket: bucket, Key: remotePath, Body: content, ContentType: contentType, Metadata: metadata },
+                        });
+                        return [4 /*yield*/, upload.done()];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.uploadStream = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var upload;
+            var bucket = _b.bucket, remotePath = _b.remotePath, stream = _b.stream;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        upload = new lib_storage_1.Upload({
+                            client: this.client,
+                            params: {
+                                Bucket: bucket,
+                                Key: remotePath,
+                                Body: stream,
+                            },
+                        });
+                        return [4 /*yield*/, upload.done()];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.downloadFile = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command, body, response, nodejsWriteStream;
+            var bucket = _b.bucket, remotePath = _b.remotePath, filePath = _b.filePath;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.GetObjectCommand({
+                            Bucket: bucket,
+                            Key: remotePath,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        body = (_c.sent()).Body;
+                        if (body === undefined) {
+                            throw new Error('Body is undefined');
+                        }
+                        response = body;
+                        nodejsWriteStream = (0, fs_extra_1.createWriteStream)(filePath);
+                        response.pipe(nodejsWriteStream);
+                        return [4 /*yield*/, new Promise(function (resolve, reject) {
+                                nodejsWriteStream.on('finish', resolve);
+                                nodejsWriteStream.on('error', reject);
+                            })];
+                    case 2:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.listFiles = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command, contents;
+            var bucket = _b.bucket, remotePath = _b.remotePath, maxKeys = _b.maxKeys, startAfterKey = _b.startAfterKey;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.ListObjectsV2Command({
+                            Bucket: bucket,
+                            Prefix: remotePath.endsWith('/') ? remotePath : remotePath + '/',
+                            MaxKeys: maxKeys,
+                            StartAfter: startAfterKey,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        contents = (_c.sent()).Contents;
+                        if (contents === undefined) {
+                            return [2 /*return*/, []];
+                        }
+                        return [2 /*return*/, contents.map(function (content) { return content.Key; }).filter(function (key) { return key !== undefined; })];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.deleteFile = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket, remotePath = _b.remotePath;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.DeleteObjectCommand({
+                            Bucket: bucket,
+                            Key: remotePath,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.getObjectHead = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket, remotePath = _b.remotePath;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.HeadObjectCommand({
+                            Bucket: bucket,
+                            Key: remotePath,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1: return [2 /*return*/, _c.sent()];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.getObject = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command, response;
+            var bucket = _b.bucket, key = _b.key;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.GetObjectCommand({
+                            Bucket: bucket,
+                            Key: key,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        response = _c.sent();
+                        return [2 /*return*/, {
+                                Body: response.Body,
+                                ContentType: response.ContentType,
+                            }];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.deleteObject = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket, key = _b.key;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.DeleteObjectCommand({
+                            Bucket: bucket,
+                            Key: key,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.createBucket = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.CreateBucketCommand({
+                            Bucket: bucket,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1: return [2 /*return*/, _c.sent()];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.deleteBucket = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.DeleteBucketCommand({
+                            Bucket: bucket,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.bucketExists = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command, e_1;
+            var bucket = _b.bucket;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.HeadBucketCommand({
+                            Bucket: bucket,
+                        });
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 2:
+                        _c.sent();
+                        return [2 /*return*/, true];
+                    case 3:
+                        e_1 = _c.sent();
+                        return [2 /*return*/, false];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.putBucketPolicy = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket, policy = _b.policy;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.PutBucketPolicyCommand({
+                            Bucket: bucket,
+                            Policy: policy,
+                        });
+                        return [4 /*yield*/, this.client.send(command)];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AwsS3.prototype.getPresignedUrl = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b) {
+            var command;
+            var bucket = _b.bucket, remotePath = _b.remotePath, expirationInSec = _b.expirationInSec;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        command = new client_s3_1.GetObjectCommand({
+                            Bucket: bucket,
+                            Key: remotePath,
+                        });
+                        return [4 /*yield*/, (0, s3_request_presigner_1.getSignedUrl)(this.client, command, { expiresIn: expirationInSec })];
+                    case 1: return [2 /*return*/, _c.sent()];
+                }
+            });
+        });
+    };
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "uploadFile", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "uploadContent", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "uploadStream", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "downloadFile", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "listFiles", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "deleteFile", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "getObjectHead", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "getObject", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "deleteObject", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "createBucket", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "deleteBucket", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "bucketExists", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "putBucketPolicy", null);
+    __decorate([
+        (0, debugDecorator_1.debug)(DEBUG_NAMESPACE),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], AwsS3.prototype, "getPresignedUrl", null);
+    return AwsS3;
+}());
+exports.AwsS3 = AwsS3;
+//# sourceMappingURL=S3.js.map

package/dist/AWS/S3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3.js","sourceRoot":"","sources":["../../src/AWS/S3.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yBAAsC;AACtC,gDAW4B;AAC5B,qCAA6C;AAG7C,0DAAgD;AAChD,mCAAqE;AAqBrE,oDAA8C;AAC9C,sEAA6D;AAE7D,IAAM,eAAe,GAAG,uBAAuB,CAAC;AAkFhD;;;;GAIG;AACH;IAGC;;;OAGG;IACH,eAAY,MAA2B;QAA3B,uBAAA,EAAA,WAA2B;QACtC,MAAM,GAAG,IAAA,kDAAyC,EAAC,MAAM,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,GAAG,IAAI,oBAAQ,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAGY,0BAAU,GAAV;4DAAW,EAAuE;;gBAArE,QAAQ,cAAA,EAAE,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,WAAW,iBAAA,EAAE,QAAQ,cAAA;;;;wBACtE,UAAU,GAAG,IAAA,qBAAgB,EAAC,QAAQ,CAAC,CAAC;wBACxC,MAAM,GAAG,IAAI,oBAAM,CAAC;4BACzB,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE;yBAC3G,CAAC,CAAC;wBACH,qBAAM,MAAM,CAAC,IAAI,EAAE,EAAA;;wBAAnB,SAAmB,CAAC;;;;;KACpB;IAGY,6BAAa,GAAb;4DAAc,EAAyE;;gBAAvE,OAAO,aAAA,EAAE,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,WAAW,iBAAA,EAAE,QAAQ,cAAA;;;;wBACxE,MAAM,GAAG,IAAI,oBAAM,CAAC;4BACzB,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE;yBACxG,CAAC,CAAC;wBACH,qBAAM,MAAM,CAAC,IAAI,EAAE,EAAA;;wBAAnB,SAAmB,CAAC;;;;;KACpB;IAGY,4BAAY,GAAZ;4DAAa,EAAgD;;gBAA9C,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,MAAM,YAAA;;;;wBAC/C,MAAM,GAAG,IAAI,oBAAM,CAAC;4BACzB,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,MAAM,EAAE;gCACP,MAAM,EAAE,MAAM;gCACd,GAAG,EAAE,UAAU;gCACf,IAAI,EAAE,MAAM;6BACZ;yBACD,CAAC,CAAC;wBAEH,qBAAM,MAAM,CAAC,IAAI,EAAE,EAAA;;wBAAnB,SAAmB,CAAC;;;;;KACpB;IAGY,4BAAY,GAAZ;4DAAa,EAAkD;;gBAAhD,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,QAAQ,cAAA;;;;wBACjD,OAAO,GAAG,IAAI,4BAAgB,CAAC;4BACpC,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,UAAU;yBACf,CAAC,CAAC;wBAEoB,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAAxC,IAAI,GAAK,CAAA,SAA+B,CAAA,KAApC;wBAElB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;4BACxB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;wBACtC,CAAC;wBACK,QAAQ,GAAG,IAAkC,CAAC;wBAE9C,iBAAiB,GAAG,IAAA,4BAAiB,EAAC,QAAQ,CAAC,CAAC;wBACtD,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;wBACjC,qBAAM,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;gCACjC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gCACxC,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;4BACvC,CAAC,CAAC,EAAA;;wBAHF,SAGE,CAAC;;;;;KACH;IAGY,yBAAS,GAAT;4DAAU,EAA6D;;gBAA3D,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,OAAO,aAAA,EAAE,aAAa,mBAAA;;;;wBAC5D,OAAO,GAAG,IAAI,gCAAoB,CAAC;4BACxC,MAAM,EAAE,MAAM;4BACd,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG;4BAChE,OAAO,EAAE,OAAO;4BAChB,UAAU,EAAE,aAAa;yBACzB,CAAC,CAAC;wBAE4B,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA5C,QAAQ,GAAK,CAAA,SAA+B,CAAA,SAApC;wBAE1B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;4BAC5B,sBAAO,EAAE,EAAC;wBACX,CAAC;wBAED,sBAAO,QAAQ,CAAC,GAAG,CAAC,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,GAAG,EAAX,CAAW,CAAC,CAAC,MAAM,CAAC,UAAC,GAAG,IAAoB,OAAA,GAAG,KAAK,SAAS,EAAjB,CAAiB,CAAC,EAAC;;;;KAChG;IAGY,0BAAU,GAAV;4DAAW,EAAsC;;gBAApC,MAAM,YAAA,EAAE,UAAU,gBAAA;;;;wBACrC,OAAO,GAAG,IAAI,+BAAmB,CAAC;4BACvC,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,UAAU;yBACf,CAAC,CAAC;wBAEH,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;;;;;KAChC;IAGY,6BAAa,GAAb;4DAAc,EAAuC;;gBAArC,MAAM,YAAA,EAAE,UAAU,gBAAA;;;;wBACxC,OAAO,GAAG,IAAI,6BAAiB,CAAC;4BACrC,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,UAAU;yBACf,CAAC,CAAC;wBAEI,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;4BAAtC,sBAAO,SAA+B,EAAC;;;;KACvC;IAGY,yBAAS,GAAT;4DAAU,EAA8B;;gBAA5B,MAAM,YAAA,EAAE,GAAG,SAAA;;;;wBAC7B,OAAO,GAAG,IAAI,4BAAgB,CAAC;4BACpC,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,GAAG;yBACR,CAAC,CAAC;wBACc,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA1C,QAAQ,GAAG,SAA+B;wBAChD,sBAAO;gCACN,IAAI,EAAE,QAAQ,CAAC,IAA6B;gCAC5C,WAAW,EAAE,QAAQ,CAAC,WAAW;6BACjC,EAAC;;;;KACF;IAGY,4BAAY,GAAZ;4DAAa,EAAiC;;gBAA/B,MAAM,YAAA,EAAE,GAAG,SAAA;;;;wBAChC,OAAO,GAAG,IAAI,+BAAmB,CAAC;4BACvC,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,GAAG;yBACR,CAAC,CAAC;wBACH,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;;;;;KAChC;IAGY,4BAAY,GAAZ;4DAAa,EAA4B;;gBAA1B,MAAM,YAAA;;;;wBAC3B,OAAO,GAAG,IAAI,+BAAmB,CAAC;4BACvC,MAAM,EAAE,MAAM;yBACd,CAAC,CAAC;wBACI,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;4BAAtC,sBAAO,SAA+B,EAAC;;;;KACvC;IAGY,4BAAY,GAAZ;4DAAa,EAA4B;;gBAA1B,MAAM,YAAA;;;;wBAC3B,OAAO,GAAG,IAAI,+BAAmB,CAAC;4BACvC,MAAM,EAAE,MAAM;yBACd,CAAC,CAAC;wBACH,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;;;;;KAChC;IAGY,4BAAY,GAAZ;4DAAa,EAA4B;;gBAA1B,MAAM,YAAA;;;;wBAC3B,OAAO,GAAG,IAAI,6BAAiB,CAAC;4BACrC,MAAM,EAAE,MAAM;yBACd,CAAC,CAAC;;;;wBAEF,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;wBAChC,sBAAO,IAAI,EAAC;;;wBAEZ,sBAAO,KAAK,EAAC;;;;;KAEd;IAGY,+BAAe,GAAf;4DAAgB,EAAuC;;gBAArC,MAAM,YAAA,EAAE,MAAM,YAAA;;;;wBACtC,OAAO,GAAG,IAAI,kCAAsB,CAAC;4BAC1C,MAAM,EAAE,MAAM;4BACd,MAAM,EAAE,MAAM;yBACd,CAAC,CAAC;wBACH,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;;;;;KAChC;IAGY,+BAAe,GAAf;4DAAgB,EAA4D;;gBAA1D,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,eAAe,qBAAA;;;;wBAC3D,OAAO,GAAG,IAAI,4BAAgB,CAAC;4BACpC,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,UAAU;yBACf,CAAC,CAAC;wBAEI,qBAAM,IAAA,mCAAY,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,EAAA;4BAA/E,sBAAO,SAAwE,EAAC;;;;KAChF;IAhKY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;2CAQtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;8CAOtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;6CAYtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;6CAoBtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;0CAgBtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;2CAQtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;8CAQtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;0CAWtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;6CAOtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;6CAMtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;6CAMtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;6CAWtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;gDAOtB;IAGY;QADZ,IAAA,sBAAK,EAAC,eAAe,CAAC;;;;gDAQtB;IACF,YAAC;CAAA,AA9KD,IA8KC;AA9KY,sBAAK"}

package/dist/AWS/S3Types.d.ts

@@ -0,0 +1,113 @@
+import { Readable } from 'stream';
+export interface UploadFileArgs {
+    /** Path to local file */
+    filePath: string;
+    /** Destination bucket to upload the file to */
+    bucket: string;
+    /** Path in the bucket to upload the file to */
+    remotePath: string;
+    /**
+     * A standard MIME type describing the format of the contents
+     * @see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
+     */
+    contentType?: string;
+    /**
+     * Metadata to be stored with the file.
+     * all keys must start with "x-amz-meta-" prefix
+     * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#UserMetadata
+     */
+    metadata?: Record<string, string>;
+}
+export interface UploadContentArgs {
+    /** Content of the file to upload */
+    content: string;
+    /** Destination bucket to upload the file to */
+    bucket: string;
+    /** Path in the bucket to upload the file to */
+    remotePath: string;
+    /**
+     * A standard MIME type describing the format of the contents
+     * @see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
+     */
+    contentType?: string;
+    /**
+     * Metadata to be stored with the file.
+     * all keys must start with "x-amz-meta-" prefix
+     * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#UserMetadata
+     */
+    metadata?: Record<string, string>;
+}
+export interface DownloadFileArgs {
+    bucket: string;
+    remotePath: string;
+    filePath: string;
+}
+export interface ListFilesArgs {
+    bucket: string;
+    remotePath: string;
+    maxKeys?: number;
+    startAfterKey?: string;
+}
+export interface GetMetadataArgs {
+    bucket: string;
+    remotePath: string;
+}
+export interface DeleteFileArgs {
+    bucket: string;
+    remotePath: string;
+}
+export interface UploadStreamArgs {
+    bucket: string;
+    remotePath: string;
+    stream: Readable;
+}
+export interface BucketExistsArgs {
+    bucket: string;
+}
+export interface CreateBucketArgs {
+    bucket: string | undefined;
+}
+export interface CreateBucketResponse {
+    Location?: string;
+}
+export interface DeleteBucketArgs {
+    bucket: string | undefined;
+}
+export interface PutBucketPolicyArgs {
+    bucket: string | undefined;
+    policy: string | undefined;
+}
+export interface HeadObject {
+    AcceptRanges?: string;
+    LastModified?: Date;
+    ContentLength?: number;
+    ETag?: string;
+    ContentType?: string;
+    Metadata?: Record<string, string>;
+    StorageClass?: string;
+}
+export interface GetObjectArgs {
+    bucket: string | undefined;
+    key: string | undefined;
+}
+export interface GetObjectResponseBody extends Readable {
+    transformToByteArray(): Promise<Uint8Array>;
+    transformToString(): Promise<string>;
+    transformToWebStream(): ReadableStream;
+}
+export interface GetObjectResponse {
+    Body?: GetObjectResponseBody;
+    ContentType?: string;
+}
+export interface DeleteObjectArgs {
+    bucket: string | undefined;
+    key: string | undefined;
+}
+export interface GetPresignedUrlArgs {
+    /** The bucket the signed URL belongs to */
+    bucket: string;
+    /** The key of the object the signed URL belongs to */
+    remotePath: string;
+    /** The expiration time of the signed URL in seconds */
+    expirationInSec: number;
+}

package/dist/AWS/S3Types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=S3Types.js.map

package/dist/AWS/S3Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3Types.js","sourceRoot":"","sources":["../../src/AWS/S3Types.ts"],"names":[],"mappings":""}

package/dist/AWS/config.d.ts

@@ -0,0 +1,2 @@
+import { S3ClientConfig } from '@aws-sdk/client-s3';
+export declare function getUpdatedS3ClientConfigWithCustomEnvVars(originalConfig: S3ClientConfig): S3ClientConfig;