@webiny/api-file-manager-s3 0.0.0-mt-1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# @webiny/api-file-manager-s3

package/index.d.ts

@@ -0,0 +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)[];
+export default _default;

package/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _graphqlFileStorageS = _interopRequireDefault(require("./plugins/graphqlFileStorageS3"));
+
+var _fileStorageS = _interopRequireDefault(require("./plugins/fileStorageS3"));
+
+var _default = () => [(0, _fileStorageS.default)(), _graphqlFileStorageS.default];
+
+exports.default = _default;

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@webiny/api-file-manager-s3",
+	"version": "0.0.0-mt-1",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "File storage S3 plugin for the @webiny/api-file-manager.",
+	"author": "Webiny Ltd",
+	"license": "MIT",
+	"dependencies": {
+		"@webiny/api-file-manager": "0.0.0-mt-1",
+		"@webiny/handler-graphql": "0.0.0-mt-1",
+		"@webiny/validation": "0.0.0-mt-1",
+		"form-data": "3.0.1",
+		"node-fetch": "2.6.5",
+		"sanitize-filename": "1.6.3",
+		"uniqid": "5.4.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.5.5",
+		"@babel/core": "^7.5.5",
+		"@webiny/cli": "^0.0.0-mt-1",
+		"@webiny/project-utils": "^0.0.0-mt-1",
+		"rimraf": "^3.0.2",
+		"typescript": "^4.1.3"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "37736d8456a6ecb342a6c3645060bd9a3f2d4bb0"
+}

package/plugins/fileStorageS3.d.ts

@@ -0,0 +1,3 @@
+import { FilePhysicalStoragePlugin } from "@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin";
+declare const _default: () => FilePhysicalStoragePlugin;
+export default _default;

package/plugins/fileStorageS3.js

@@ -0,0 +1,59 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
+
+var _getPresignedPostPayload = _interopRequireDefault(require("../utils/getPresignedPostPayload"));
+
+var _uploadFileToS = _interopRequireDefault(require("../utils/uploadFileToS3"));
+
+var _FilePhysicalStoragePlugin = require("@webiny/api-file-manager/plugins/definitions/FilePhysicalStoragePlugin");
+
+const _excluded = ["settings", "buffer"];
+const S3_BUCKET = process.env.S3_BUCKET;
+
+var _default = () => {
+  return new _FilePhysicalStoragePlugin.FilePhysicalStoragePlugin({
+    upload: async args => {
+      const {
+        settings,
+        buffer
+      } = args,
+            data = (0, _objectWithoutProperties2.default)(args, _excluded);
+      const {
+        data: preSignedPostPayload,
+        file
+      } = await (0, _getPresignedPostPayload.default)(data, settings);
+      const response = await (0, _uploadFileToS.default)(buffer, preSignedPostPayload);
+
+      if (!response.ok) {
+        throw Error("Unable to upload file.");
+      }
+
+      return {
+        data: preSignedPostPayload,
+        file
+      };
+    },
+    delete: async args => {
+      const {
+        key
+      } = args;
+      const s3 = new _s.default();
+      await s3.deleteObject({
+        Bucket: S3_BUCKET,
+        Key: key
+      }).promise();
+    }
+  });
+};
+
+exports.default = _default;

package/plugins/graphqlFileStorageS3.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql/types";
+import { FileManagerContext } from "@webiny/api-file-manager/types";
+declare const plugin: GraphQLSchemaPlugin<FileManagerContext>;
+export default plugin;

package/plugins/graphqlFileStorageS3.js

@@ -0,0 +1,135 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _responses = require("@webiny/handler-graphql/responses");
+
+var _checkBasePermissions = _interopRequireDefault(require("@webiny/api-file-manager/plugins/crud/utils/checkBasePermissions"));
+
+var _getPresignedPostPayload = _interopRequireDefault(require("../utils/getPresignedPostPayload"));
+
+const BATCH_UPLOAD_MAX_FILES = 20;
+const plugin = {
+  type: "graphql-schema",
+  name: "graphql-schema-api-file-manager-s3",
+  schema: {
+    typeDefs:
+    /* GraphQL */
+    `
+            input PreSignedPostPayloadInput {
+                name: String!
+                type: String!
+                size: Int!
+            }
+
+            type GetPreSignedPostPayloadResponseDataFile {
+                name: String
+                type: String
+                size: Int
+                key: String
+            }
+
+            type GetPreSignedPostPayloadResponseData {
+                # Contains data that is necessary for initiating a file upload.
+                data: JSON
+                file: UploadFileResponseDataFile
+            }
+
+            type GetPreSignedPostPayloadResponse {
+                error: FileError
+                data: GetPreSignedPostPayloadResponseData
+            }
+
+            type GetPreSignedPostPayloadsResponse {
+                error: FileError
+                data: [GetPreSignedPostPayloadResponseData]!
+            }
+
+            extend type FmQuery {
+                getPreSignedPostPayload(
+                    data: PreSignedPostPayloadInput!
+                ): GetPreSignedPostPayloadResponse
+                getPreSignedPostPayloads(
+                    data: [PreSignedPostPayloadInput]!
+                ): GetPreSignedPostPayloadsResponse
+            }
+        `,
+    resolvers: {
+      FmQuery: {
+        getPreSignedPostPayload: async (_, args, context) => {
+          try {
+            await (0, _checkBasePermissions.default)(context, {
+              rwd: "w"
+            });
+            const {
+              data
+            } = args;
+            const settings = await context.fileManager.settings.getSettings();
+            const response = await (0, _getPresignedPostPayload.default)(data, settings);
+            return new _responses.Response(response);
+          } catch (e) {
+            return new _responses.ErrorResponse({
+              message: e.message,
+              code: e.code,
+              data: e.data
+            });
+          }
+        },
+        getPreSignedPostPayloads: async (_, args, context) => {
+          await (0, _checkBasePermissions.default)(context, {
+            rwd: "w"
+          });
+          const {
+            data: files
+          } = args;
+
+          if (!Array.isArray(files)) {
+            return new _responses.ErrorResponse({
+              code: "UPLOAD_FILES_NON_ARRAY",
+              message: `"data" argument must be an array.`
+            });
+          }
+
+          if (files.length === 0) {
+            return new _responses.ErrorResponse({
+              code: "UPLOAD_FILES_MIN_FILES",
+              message: `"data" argument must contain at least one file.`
+            });
+          }
+
+          if (files.length > BATCH_UPLOAD_MAX_FILES) {
+            return new _responses.ErrorResponse({
+              code: "UPLOAD_FILES_MAX_FILES",
+              message: `"data" argument must not contain more than ${BATCH_UPLOAD_MAX_FILES} files.`
+            });
+          }
+
+          try {
+            const settings = await context.fileManager.settings.getSettings();
+            const promises = [];
+
+            for (let i = 0; i < files.length; i++) {
+              const item = files[i];
+              promises.push((0, _getPresignedPostPayload.default)(item, settings));
+            }
+
+            return new _responses.Response(await Promise.all(promises));
+          } catch (e) {
+            return new _responses.ErrorResponse({
+              message: e.message,
+              code: e.code,
+              data: e.data
+            });
+          }
+        }
+      }
+    }
+  }
+};
+var _default = plugin;
+exports.default = _default;

package/types.js

@@ -0,0 +1 @@
+"use strict";

package/utils/getPresignedPostPayload.d.ts

@@ -0,0 +1,11 @@
+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;
+    };
+}>;
+export default _default;

package/utils/getPresignedPostPayload.js

@@ -0,0 +1,86 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _uniqid = _interopRequireDefault(require("uniqid"));
+
+var _sanitizeFilename = _interopRequireDefault(require("sanitize-filename"));
+
+var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
+
+var _validation = require("@webiny/validation");
+
+const S3_BUCKET = process.env.S3_BUCKET;
+const UPLOAD_MAX_FILE_SIZE_DEFAULT = 26214400; // 25MB
+
+const sanitizeFileSizeValue = (value, defaultValue) => {
+  try {
+    _validation.validation.validateSync(value, "required,numeric,gte:0");
+
+    return value;
+  } catch (e) {
+    return defaultValue;
+  }
+};
+
+var _default = async (data, settings) => {
+  // If type is missing, let's use the default "application/octet-stream" type,
+  // which is also the default type that the Amazon S3 would use.
+  if (!data.type) {
+    data.type = "application/octet-stream";
+  }
+
+  const contentType = data.type;
+
+  if (!contentType) {
+    throw Error(`File's content type could not be resolved.`);
+  }
+
+  let key = (0, _sanitizeFilename.default)(data.name);
+
+  if (key) {
+    key = (0, _uniqid.default)() + "-" + key;
+  }
+
+  if (data.keyPrefix) {
+    key = `${(0, _sanitizeFilename.default)(data.keyPrefix)}-${key}`;
+  } // Replace all whitespace.
+
+
+  key = key.replace(/\s/g, "");
+  const uploadMinFileSize = sanitizeFileSizeValue(settings.uploadMinFileSize, 0);
+  const uploadMaxFileSize = sanitizeFileSizeValue(settings.uploadMaxFileSize, UPLOAD_MAX_FILE_SIZE_DEFAULT);
+  const params = {
+    Expires: 60,
+    Bucket: S3_BUCKET,
+    Conditions: [["content-length-range", uploadMinFileSize, uploadMaxFileSize]],
+    // 0 Bytes - 25MB
+    Fields: {
+      "Content-Type": contentType,
+      key
+    }
+  };
+
+  if (params.Fields.key.startsWith("/")) {
+    params.Fields.key = params.Fields.key.substr(1);
+  }
+
+  const s3 = new _s.default();
+  const payload = s3.createPresignedPost(params);
+  return {
+    data: payload,
+    file: {
+      name: key,
+      key,
+      type: contentType,
+      size: data.size
+    }
+  };
+};
+
+exports.default = _default;

package/utils/uploadFileToS3.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (buffer: any, preSignedPostPayload: any) => Promise<import("node-fetch").Response>;
+export default _default;

package/utils/uploadFileToS3.js

@@ -0,0 +1,29 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _formData = _interopRequireDefault(require("form-data"));
+
+var _nodeFetch = _interopRequireDefault(require("node-fetch"));
+
+var _default = async (buffer, preSignedPostPayload) => {
+  const formData = new _formData.default(); // Add all pre signed payload field to "FormData".
+
+  Object.keys(preSignedPostPayload.fields).forEach(key => {
+    formData.append(key, preSignedPostPayload.fields[key]);
+  }); // Add file content to "FormData".
+
+  formData.append("file", buffer); // Finally make the upload request to S3.
+
+  return (0, _nodeFetch.default)(preSignedPostPayload.url, {
+    method: "POST",
+    body: formData
+  });
+};
+
+exports.default = _default;