@8ms/helpers 1.1.9 → 1.1.10

package/dist/aws/s3/deleteFile.d.ts

@@ -1,10 +1,10 @@
 /**
  * Delete a single file.
  */
-declare const deleteFile: ({ S3Lib, bucket, client, file }: {
+declare const deleteFile: ({ S3Lib, bucket, client, key }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
+    key: string;
 }) => Promise<void>;
 export default deleteFile;

package/dist/aws/s3/deleteFile.js

@@ -40,7 +40,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Delete a single file.
  */
 var deleteFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var DeleteObjectCommand;
         return __generator(this, function (_b) {
@@ -49,7 +49,7 @@ var deleteFile = function (_a) {
                     DeleteObjectCommand = S3Lib.DeleteObjectCommand;
                     return [4 /*yield*/, client.send(new DeleteObjectCommand({
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                         }))];
                 case 1:
                     _b.sent();

package/dist/aws/s3/deleteFiles.d.ts

@@ -1,10 +1,10 @@
 /**
  * Delete multiple files.
  */
-declare const deleteFiles: ({ S3Lib, bucket, client, files }: {
+declare const deleteFiles: ({ S3Lib, bucket, client, keys }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    files: string[];
+    keys: string[];
 }) => Promise<void>;
 export default deleteFiles;

package/dist/aws/s3/deleteFiles.js

@@ -40,7 +40,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Delete multiple files.
  */
 var deleteFiles = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, files = _a.files;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, keys = _a.keys;
     return __awaiter(void 0, void 0, void 0, function () {
         var DeleteObjectsCommand;
         return __generator(this, function (_b) {
@@ -50,8 +50,8 @@ var deleteFiles = function (_a) {
                     return [4 /*yield*/, client.send(new DeleteObjectsCommand({
                             Bucket: bucket,
                             Delete: {
-                                Objects: files.map(function (file) { return ({
-                                    Key: file,
+                                Objects: keys.map(function (key) { return ({
+                                    Key: key,
                                 }); }),
                             },
                         }))];

package/dist/aws/s3/getPresignedPost.d.ts

@@ -4,17 +4,17 @@ declare type PresignedPostType = {
     client: any;
     conditions: any[];
     expires: number;
-    file: string;
     fields: {
         [key: string]: string;
     };
+    key: string;
 };
 /**
  * Returns a presigned post to upload a file directly to S3.
  * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_s3_presigned_post.html
  * https://github.com/8millionstories-organisation/test-vercel-upload-2/blob/50eb12fcb3870a59ab455811bfaa1bdcb886edf2/pages/api/upload-url.js
  */
-declare const getPresignedPost: ({ S3Lib, bucket, client, conditions, expires, file, fields }: PresignedPostType) => Promise<{
+declare const getPresignedPost: ({ S3Lib, bucket, client, conditions, expires, fields, key }: PresignedPostType) => Promise<{
     url: any;
     fields: any;
 }>;

package/dist/aws/s3/getPresignedPost.js

@@ -42,7 +42,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * https://github.com/8millionstories-organisation/test-vercel-upload-2/blob/50eb12fcb3870a59ab455811bfaa1bdcb886edf2/pages/api/upload-url.js
  */
 var getPresignedPost = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, conditions = _a.conditions, expires = _a.expires, file = _a.file, fields = _a.fields;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, conditions = _a.conditions, expires = _a.expires, fields = _a.fields, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var createPresignedPost, apiResponse;
         return __generator(this, function (_b) {
@@ -51,7 +51,7 @@ var getPresignedPost = function (_a) {
                     createPresignedPost = S3Lib.createPresignedPost;
                     return [4 /*yield*/, createPresignedPost(client, {
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                             Conditions: undefined === conditions ? [] : conditions,
                             Fields: undefined === fields ? {} : fields,
                             Expires: undefined === expires ? 60 : expires, // Seconds

package/dist/aws/s3/getSignedUrl.d.ts

@@ -5,11 +5,11 @@ declare type GetSignedUrlType = {
     bucket: string;
     client: any;
     expires: number;
-    file: string;
+    key: string;
 };
 /**
  * Returns a signed for URL to allow download of private buckets for a given duration.
  * Library: @aws-sdk/s3-request-presigner
  */
-declare const getSignedUrl: ({ S3Lib, S3PresignerLib, bucket, client, expires, file }: GetSignedUrlType) => Promise<ResponseType>;
+declare const getSignedUrl: ({ S3Lib, S3PresignerLib, bucket, client, expires, key }: GetSignedUrlType) => Promise<ResponseType>;
 export default getSignedUrl;

package/dist/aws/s3/getSignedUrl.js

@@ -53,7 +53,7 @@ var api_1 = require("../../api");
  * Library: @aws-sdk/s3-request-presigner
  */
 var getSignedUrl = function (_a) {
-    var S3Lib = _a.S3Lib, S3PresignerLib = _a.S3PresignerLib, bucket = _a.bucket, client = _a.client, expires = _a.expires, file = _a.file;
+    var S3Lib = _a.S3Lib, S3PresignerLib = _a.S3PresignerLib, bucket = _a.bucket, client = _a.client, expires = _a.expires, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var response, GetObjectCommand, getSignedUrl, command, awsResponse;
         return __generator(this, function (_b) {
@@ -64,7 +64,7 @@ var getSignedUrl = function (_a) {
                     getSignedUrl = S3PresignerLib.getSignedUrl;
                     command = new GetObjectCommand({
                         Bucket: bucket,
-                        Key: file,
+                        Key: key,
                     });
                     return [4 /*yield*/, getSignedUrl(client, command, { expiresIn: expires })];
                 case 1:

package/dist/aws/s3/readBuffer.d.ts

@@ -5,10 +5,10 @@ export declare type ReadBufferType = ReadType & {
 /**
  * Similar function to reading the S3 file, but instead of a text file return a buffer.
  */
-declare const readBuffer: ({ S3Lib, bucket, client, file }: {
+declare const readBuffer: ({ S3Lib, bucket, client, key }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
+    key: string;
 }) => Promise<ReadBufferType>;
 export default readBuffer;

package/dist/aws/s3/readBuffer.js

@@ -45,7 +45,7 @@ var isResponse200_1 = __importDefault(require("../isResponse200"));
  * Similar function to reading the S3 file, but instead of a text file return a buffer.
  */
 var readBuffer = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var response, GetObjectCommand, apiResponse, chunks_1, _b;
         return __generator(this, function (_c) {
@@ -71,7 +71,7 @@ var readBuffer = function (_a) {
                     GetObjectCommand = S3Lib.GetObjectCommand;
                     return [4 /*yield*/, client.send(new GetObjectCommand({
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                         }))];
                 case 1:
                     apiResponse = _c.sent();

package/dist/aws/s3/readFile.d.ts

@@ -20,11 +20,11 @@ export declare type ReadFileType = ReadType & {
 /**
  * Read a file from S3 and return either null, the content or JSON decoded.
  */
-declare const readFile: ({ S3Lib, bucket, client, file, isJson }: {
+declare const readFile: ({ S3Lib, bucket, client, key, isJson }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
+    key: string;
     isJson: boolean;
 }) => Promise<ReadFileType>;
 export default readFile;

package/dist/aws/s3/readFile.js

@@ -52,7 +52,7 @@ var isResponse200_1 = __importDefault(require("../isResponse200"));
  * Read a file from S3 and return either null, the content or JSON decoded.
  */
 var readFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file, isJson = _a.isJson;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key, isJson = _a.isJson;
     return __awaiter(void 0, void 0, void 0, function () {
         var response, GetObjectCommand, apiResponse, now, modified, _b;
         return __generator(this, function (_c) {
@@ -78,7 +78,7 @@ var readFile = function (_a) {
                     GetObjectCommand = S3Lib.GetObjectCommand;
                     return [4 /*yield*/, client.send(new GetObjectCommand({
                             Bucket: bucket,
-                            Key: file,
+                            Key: key,
                         }))];
                 case 1:
                     apiResponse = _c.sent();

package/dist/aws/s3/writeFile.d.ts

@@ -1,11 +1,11 @@
 /**
  * Write a file to S3.
  */
-export declare const writeFile: ({ S3Lib, bucket, client, file, content }: {
+export declare const writeFile: ({ S3Lib, bucket, client, data, key }: {
     S3Lib: any;
     bucket: string;
     client: any;
-    file: string;
-    content: any;
+    data: any;
+    key: string;
 }) => Promise<any>;
 export default writeFile;

package/dist/aws/s3/writeFile.js

@@ -41,7 +41,7 @@ exports.writeFile = void 0;
  * Write a file to S3.
  */
 var writeFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, file = _a.file, content = _a.content;
+    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, data = _a.data, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var PutObjectCommand, apiResponse;
         return __generator(this, function (_b) {
@@ -50,8 +50,8 @@ var writeFile = function (_a) {
                     PutObjectCommand = S3Lib.PutObjectCommand;
                     return [4 /*yield*/, client.send(new PutObjectCommand({
                             Bucket: bucket,
-                            Body: content,
-                            Key: file,
+                            Body: data,
+                            Key: key,
                         }))];
                 case 1:
                     apiResponse = _b.sent();

package/dist/aws/s3/writePresignedPost.d.ts

@@ -5,11 +5,11 @@ declare type WritePresignedPostType = {
     config: ConfigType;
     fields: any;
     file: any;
-    fileName: string;
+    key: string;
     url: string;
 };
 /**
  * Get a presigned post URL so we can upload directly to S3 via frontend.
  */
-declare const writePresignedPost: ({ bucket, config, fields, file, fileName, url }: WritePresignedPostType) => Promise<ResponseType>;
+declare const writePresignedPost: ({ bucket, config, fields, file, key, url }: WritePresignedPostType) => Promise<ResponseType>;
 export default writePresignedPost;

package/dist/aws/s3/writePresignedPost.js

@@ -52,7 +52,7 @@ var api_1 = require("../../api");
  * Get a presigned post URL so we can upload directly to S3 via frontend.
  */
 var writePresignedPost = function (_a) {
-    var bucket = _a.bucket, config = _a.config, fields = _a.fields, file = _a.file, fileName = _a.fileName, url = _a.url;
+    var bucket = _a.bucket, config = _a.config, fields = _a.fields, file = _a.file, key = _a.key, url = _a.url;
     return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_b) {
             return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
@@ -78,7 +78,7 @@ var writePresignedPost = function (_a) {
                                 if (upload.ok) {
                                     response.state = api_1.states.SUCCESS;
                                     response.body = {
-                                        url: "https://".concat(bucket, ".s3.").concat(config.region, ".amazonaws.com/").concat(fileName),
+                                        url: "https://".concat(bucket, ".s3.").concat(config.region, ".amazonaws.com/").concat(key),
                                     };
                                     resolve(response);
                                 }

package/dist/aws/s3cache/getCache.js

@@ -48,7 +48,7 @@ var getCache = function (_a) {
             switch (_b.label) {
                 case 0:
                     client = (0, s3_1.getClient)({ S3Lib: S3Lib, config: config });
-                    return [4 /*yield*/, (0, s3_1.readFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: key, isJson: isJson })];
+                    return [4 /*yield*/, (0, s3_1.readFile)({ S3Lib: S3Lib, bucket: bucket, client: client, key: key, isJson: isJson })];
                 case 1:
                     _b.sent();
                     return [2 /*return*/];

package/dist/aws/s3cache/saveCache.js

@@ -48,7 +48,7 @@ var saveCache = function (_a) {
             switch (_b.label) {
                 case 0:
                     client = (0, s3_1.getClient)({ S3Lib: S3Lib, config: config });
-                    return [4 /*yield*/, (0, s3_1.writeFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: key, content: data })];
+                    return [4 /*yield*/, (0, s3_1.writeFile)({ S3Lib: S3Lib, bucket: bucket, client: client, data: data, key: key })];
                 case 1:
                     _b.sent();
                     return [2 /*return*/];

package/dist/aws/s3cache/updateCache.js

@@ -52,7 +52,7 @@ var updateCache = function (_a) {
             switch (_b.label) {
                 case 0:
                     client = (0, s3_1.getClient)({ S3Lib: S3Lib, config: config });
-                    return [4 /*yield*/, (0, s3_1.deleteFile)({ S3Lib: S3Lib, bucket: bucket, client: client, file: key })];
+                    return [4 /*yield*/, (0, s3_1.deleteFile)({ S3Lib: S3Lib, bucket: bucket, client: client, key: key })];
                 case 1:
                     _b.sent();
                     return [4 /*yield*/, (0, saveCache_1.default)({ S3Lib: S3Lib, bucket: bucket, config: config, data: data, key: key })];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@8ms/helpers",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"