@webiny/api-file-manager-s3 5.23.1-beta.0 → 5.24.0

package/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: () => (import("@webiny/handler-graphql/types").GraphQLSchemaPlugin<import("@webiny/api-file-manager/types").FileManagerContext> | import("@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin").FilePhysicalStoragePlugin)[];
+declare const _default: () => (import("@webiny/handler-graphql/types").GraphQLSchemaPlugin<import("@webiny/api-file-manager/types").FileManagerContext> | import("@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin").FilePhysicalStoragePlugin<import("@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin").FilePhysicalStoragePluginUploadParams, import("@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin").FilePhysicalStoragePluginDeleteParams>)[];
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api-file-manager-s3",
-	"version": "5.23.1-beta.0",
+	"version": "5.24.0",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -10,9 +10,9 @@
 	"author": "Webiny Ltd",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/api-file-manager": "5.23.1-beta.0",
-		"@webiny/handler-graphql": "5.23.1-beta.0",
-		"@webiny/validation": "5.23.1-beta.0",
+		"@webiny/api-file-manager": "5.24.0",
+		"@webiny/handler-graphql": "5.24.0",
+		"@webiny/validation": "5.24.0",
 		"form-data": "3.0.1",
 		"node-fetch": "2.6.7",
 		"sanitize-filename": "1.6.3",
@@ -21,8 +21,8 @@
 	"devDependencies": {
 		"@babel/cli": "^7.16.0",
 		"@babel/core": "^7.16.0",
-		"@webiny/cli": "^5.23.1-beta.0",
-		"@webiny/project-utils": "^5.23.1-beta.0",
+		"@webiny/cli": "^5.24.0",
+		"@webiny/project-utils": "^5.24.0",
 		"rimraf": "^3.0.2",
 		"typescript": "^4.1.3"
 	},
@@ -34,5 +34,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "05db67aebc2de3c33ba0622f730157ae14143b95"
+	"gitHead": "be0cbfcaa9247c658c44179af7943cc5d6d71bc7"
 }

package/plugins/fileStorageS3.d.ts

@@ -1,3 +1,6 @@
-import { FilePhysicalStoragePlugin } from "@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin";
+import { FilePhysicalStoragePlugin, FilePhysicalStoragePluginUploadParams } from "@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin";
+import { PresignedPostPayloadData } from "../types";
+export interface S3FilePhysicalStoragePluginUploadParams extends FilePhysicalStoragePluginUploadParams, PresignedPostPayloadData {
+}
 declare const _default: () => FilePhysicalStoragePlugin;
 export default _default;

package/plugins/fileStorageS3.js

@@ -21,13 +21,17 @@ const _excluded = ["settings", "buffer"];
 const S3_BUCKET = process.env.S3_BUCKET;
 
 var _default = () => {
+  /**
+   * We need to extends the type for FilePhysicalStoragePlugin.
+   * Otherwise the getPresignedPostPayload does not know it has all required values in params.
+   */
   return new _FilePhysicalStoragePlugin.FilePhysicalStoragePlugin({
-    upload: async args => {
+    upload: async params => {
       const {
         settings,
         buffer
-      } = args,
-            data = (0, _objectWithoutProperties2.default)(args, _excluded);
+      } = params,
+            data = (0, _objectWithoutProperties2.default)(params, _excluded);
       const {
         data: preSignedPostPayload,
         file
@@ -43,10 +47,10 @@ var _default = () => {
         file
       };
     },
-    delete: async args => {
+    delete: async params => {
       const {
         key
-      } = args;
+      } = params;
       const s3 = new _s.default();
       await s3.deleteObject({
         Bucket: S3_BUCKET,

package/plugins/graphqlFileStorageS3.js

@@ -113,8 +113,7 @@ const plugin = {
             const settings = await context.fileManager.settings.getSettings();
             const promises = [];
 
-            for (let i = 0; i < files.length; i++) {
-              const item = files[i];
+            for (const item of files) {
               promises.push((0, _getPresignedPostPayload.default)(item, settings));
             }
 

package/types.d.ts

@@ -0,0 +1,16 @@
+import S3 from "aws-sdk/clients/s3";
+export interface PresignedPostPayloadData {
+    name: string;
+    type: string;
+    size: number;
+    keyPrefix: string;
+}
+export interface PresignedPostPayloadDataResponse {
+    data: S3.PresignedPost;
+    file: {
+        name: string;
+        key: string;
+        type: string;
+        size: number;
+    };
+}

package/types.js

@@ -1 +1,5 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/utils/getPresignedPostPayload.d.ts

@@ -1,11 +1,4 @@
-import S3 from "aws-sdk/clients/s3";
-declare const _default: (data: any, settings: any) => Promise<{
-    data: S3.PresignedPost;
-    file: {
-        name: string;
-        key: string;
-        type: any;
-        size: any;
-    };
-}>;
+import { PresignedPostPayloadData, PresignedPostPayloadDataResponse } from "../types";
+import { FileManagerSettings } from "@webiny/api-file-manager/types";
+declare const _default: (data: PresignedPostPayloadData, settings: FileManagerSettings) => Promise<PresignedPostPayloadDataResponse>;
 export default _default;

package/utils/getPresignedPostPayload.js

@@ -24,6 +24,7 @@ const sanitizeFileSizeValue = (value, defaultValue) => {
 
     return value;
   } catch (e) {
+    // TODO @ts-refactor No need to log the error?
     return defaultValue;
   }
 };

package/utils/uploadFileToS3.d.ts

@@ -1,2 +1,5 @@
-declare const _default: (buffer: any, preSignedPostPayload: any) => Promise<import("node-fetch").Response>;
+/// <reference types="node" />
+import { Response } from "node-fetch";
+import S3 from "aws-sdk/clients/s3";
+declare const _default: (buffer: Buffer, preSignedPostPayload: S3.PresignedPost) => Promise<Response>;
 export default _default;