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

package/handlers/download/index.d.ts

@@ -1,4 +1,8 @@
 import { HandlerPlugin } from "@webiny/handler/types";
 import { ArgsContext } from "@webiny/handler-args/types";
-declare const _default: () => HandlerPlugin<ArgsContext>;
+import { DownloadHandlerEventArgs } from "../types";
+import { ClientContext } from "@webiny/handler-client/types";
+interface Context extends ClientContext, ArgsContext<DownloadHandlerEventArgs> {
+}
+declare const _default: () => HandlerPlugin<Context>;
 export default _default;

package/handlers/download/index.js

@@ -25,7 +25,6 @@ const DEFAULT_CACHE_MAX_AGE = 30758400; // 1 year
  * Based on given path, extracts file key and additional options sent via query params.
  * @param event
  */
-
 const extractFilenameOptions = event => {
   const path = (0, _sanitizeFilename.default)(event.pathParameters.path);
   return {
@@ -42,8 +41,7 @@ const getS3Object = async (event, s3, context) => {
     extension
   } = extractFilenameOptions(event);
 
-  for (let i = 0; i < _loaders.default.length; i++) {
-    const loader = _loaders.default[i];
+  for (const loader of _loaders.default) {
     const canProcess = loader.canProcess({
       context,
       s3,
@@ -54,17 +52,19 @@ const getS3Object = async (event, s3, context) => {
       }
     });
 
-    if (canProcess) {
-      return loader.process({
-        context,
-        s3,
-        options,
-        file: {
-          name: filename,
-          extension
-        }
-      });
+    if (!canProcess) {
+      continue;
     }
+
+    return loader.process({
+      context,
+      s3,
+      options,
+      file: {
+        name: filename,
+        extension
+      }
+    });
   } // If no processors handled the file request, just return the S3 object by default.
 
 
@@ -80,8 +80,7 @@ var _default = () => ({
   name: "handler-download-file",
 
   async handle(context) {
-    const event = context.invocationArgs;
-    const handler = (0, _utils.createHandler)(async event => {
+    const eventHandler = async event => {
       const {
         region
       } = (0, _utils.getEnvironment)();
@@ -95,6 +94,9 @@ var _default = () => ({
 
       if (object.ContentLength < MAX_RETURN_CONTENT_LENGTH) {
         return {
+          /**
+           * It is safe to cast as buffer or unknown
+           */
           data: object.Body,
           headers: {
             "Content-Type": object.ContentType,
@@ -111,13 +113,16 @@ var _default = () => ({
         Key: params.Key
       }).promise();
       return {
+        data: null,
         statusCode: 301,
         headers: {
           Location: `https://${params.Bucket}.s3.amazonaws.com/${params.Key}`
         }
       };
-    });
-    return await handler(event);
+    };
+
+    const handler = (0, _utils.createHandler)(eventHandler);
+    return await handler(context.invocationArgs);
   }
 
 });

package/handlers/manage/index.d.ts

@@ -1,4 +1,5 @@
 import { HandlerPlugin } from "@webiny/handler/types";
 import { ArgsContext } from "@webiny/handler-args/types";
-declare const _default: () => HandlerPlugin<ArgsContext>;
+import { ManageHandlerEventArgs } from "../types";
+declare const _default: () => HandlerPlugin<ArgsContext<ManageHandlerEventArgs>>;
 export default _default;

package/handlers/manage/index.js

@@ -20,8 +20,9 @@ var _default = () => ({
   name: "handler-download-file",
 
   async handle(context) {
-    const event = context.invocationArgs;
-    const handler = (0, _utils.createHandler)(async event => {
+    // TODO @ts-refactor check in createHandler for returns types that eventHandler must return
+    // @ts-ignore
+    const eventHandler = async event => {
       const keys = [];
 
       for (let i = 0; i < event.Records.length; i++) {
@@ -39,30 +40,30 @@ var _default = () => ({
         region
       });
 
-      for (let i = 0; i < keys.length; i++) {
-        const key = keys[i];
-
+      for (const key of keys) {
         const extension = _path.default.extname(key);
 
-        for (let j = 0; j < _managers.default.length; j++) {
-          const manager = _managers.default[j];
+        for (const manager of _managers.default) {
           const canProcess = manager.canProcess({
-            s3,
             key,
             extension
           });
 
-          if (canProcess) {
-            await manager.process({
-              s3,
-              key,
-              extension
-            });
+          if (!canProcess) {
+            continue;
           }
+
+          await manager.process({
+            s3,
+            key,
+            extension
+          });
         }
       }
-    });
-    return await handler(event);
+    };
+
+    const handler = (0, _utils.createHandler)(eventHandler);
+    return await handler(context.invocationArgs);
   }
 
 });

package/handlers/transform/index.d.ts

@@ -1,4 +1,5 @@
 import { HandlerPlugin } from "@webiny/handler/types";
 import { ArgsContext } from "@webiny/handler-args/types";
-declare const _default: () => HandlerPlugin<ArgsContext>;
+import { TransformHandlerEventArgs } from "../types";
+declare const _default: () => HandlerPlugin<ArgsContext<TransformHandlerEventArgs>>;
 export default _default;

package/handlers/transform/index.js

@@ -28,8 +28,9 @@ var _default = () => ({
   name: "handler-download-file",
 
   async handle(context) {
-    const event = context.invocationArgs;
-    const handler = (0, _utils.createHandler)(async ({
+    // TODO @ts-refactor check in createHandler for returns types that eventHandler must return
+    // @ts-ignore
+    const eventHandler = async ({
       body: {
         transformations,
         key
@@ -87,8 +88,10 @@ var _default = () => ({
           message: e.message
         };
       }
-    });
-    return await handler(event);
+    };
+
+    const handler = (0, _utils.createHandler)(eventHandler);
+    return await handler(context.invocationArgs);
   }
 
 });

package/handlers/transform/loaders/imageLoader.d.ts

@@ -1,13 +1,29 @@
+import { ClientContext } from "@webiny/handler-client/types";
+import S3 from "aws-sdk/clients/s3";
+interface File {
+    extension: string;
+    name: string;
+}
+interface Options {
+    width: string;
+}
+export interface CanProcessParams {
+    s3: S3;
+    file: File;
+    options: Options;
+    context: ClientContext;
+}
+export interface ProcessParams {
+    s3: S3;
+    file: File;
+    options: Options;
+    context: ClientContext;
+}
 declare const _default: {
-    canProcess: (opts: any) => boolean;
-    process({ s3, file, options, context }: {
-        s3: any;
-        file: any;
-        options: any;
-        context: any;
-    }): Promise<{
-        object: any;
-        params: any;
+    canProcess: (params: CanProcessParams) => boolean;
+    process({ s3, file, options, context }: ProcessParams): Promise<{
+        object: import("aws-sdk/lib/request").PromiseResult<S3.GetObjectOutput, import("aws-sdk/lib/error").AWSError>;
+        params: import("../../utils/getObjectParams").ObjectParamsResponse;
     }>;
 };
 export default _default;

package/handlers/transform/loaders/imageLoader.js

@@ -33,8 +33,8 @@ const callImageTransformerLambda = async ({
 };
 
 var _default = {
-  canProcess: opts => {
-    return _utils2.SUPPORTED_IMAGES.includes(opts.file.extension);
+  canProcess: params => {
+    return _utils2.SUPPORTED_IMAGES.includes(params.file.extension);
   },
 
   async process({

package/handlers/transform/loaders/index.d.ts

@@ -1,13 +1,8 @@
 declare const _default: {
-    canProcess: (opts: any) => boolean;
-    process({ s3, file, options, context }: {
-        s3: any;
-        file: any;
-        options: any;
-        context: any;
-    }): Promise<{
-        object: any;
-        params: any;
+    canProcess: (params: import("./imageLoader").CanProcessParams) => boolean;
+    process({ s3, file, options, context }: import("./imageLoader").ProcessParams): Promise<{
+        object: import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").GetObjectOutput, import("aws-sdk/lib/error").AWSError>;
+        params: import("../../utils/getObjectParams").ObjectParamsResponse;
     }>;
 }[];
 export default _default;

package/handlers/transform/loaders/sanitizeImageTransformations.d.ts

@@ -1,6 +1,10 @@
-declare const _default: (args: any) => {
-    [key: string]: any;
-};
+export interface SanitizeImageArgs {
+    width?: string;
+}
+export interface SanitizeImageTransformations {
+    width: number;
+}
+declare const _default: (args: SanitizeImageArgs) => SanitizeImageTransformations;
 /**
  * Takes only allowed transformations into consideration, and discards the rest.
  */

package/handlers/transform/loaders/sanitizeImageTransformations.js

@@ -5,43 +5,50 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 const SUPPORTED_IMAGE_RESIZE_WIDTHS = [100, 300, 500, 750, 1000, 1500, 2500];
+
 /**
  * Takes only allowed transformations into consideration, and discards the rest.
  */
-
 var _default = args => {
   const transformations = {};
 
-  if (args) {
-    const width = parseInt(args.width);
+  if (!args || !args.width) {
+    return null;
+  }
 
-    if (width > 0) {
-      transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[0];
-      let i = SUPPORTED_IMAGE_RESIZE_WIDTHS.length;
+  const width = parseInt(args.width);
 
-      while (i >= 0) {
-        if (width === SUPPORTED_IMAGE_RESIZE_WIDTHS[i]) {
-          transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[i];
-          break;
-        }
+  if (width <= 0) {
+    return null;
+  }
 
-        if (width > SUPPORTED_IMAGE_RESIZE_WIDTHS[i]) {
-          // Use next larger width. If there isn't any, use current.
-          transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[i + 1];
+  transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[0];
+  let i = SUPPORTED_IMAGE_RESIZE_WIDTHS.length;
 
-          if (!transformations.width) {
-            transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[i];
-          }
+  while (i >= 0) {
+    if (width === SUPPORTED_IMAGE_RESIZE_WIDTHS[i]) {
+      transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[i];
+      break;
+    }
 
-          break;
-        }
+    if (width > SUPPORTED_IMAGE_RESIZE_WIDTHS[i]) {
+      // Use next larger width. If there isn't any, use current.
+      transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[i + 1];
 
-        i--;
+      if (!transformations.width) {
+        transformations.width = SUPPORTED_IMAGE_RESIZE_WIDTHS[i];
       }
+
+      break;
     }
+
+    i--;
   }
 
   if (Object.keys(transformations).length > 0) {
+    /**
+     * It is safe to cast.
+     */
     return transformations;
   }
 

package/handlers/transform/managers/imageManager.d.ts

@@ -1,9 +1,15 @@
+import S3 from "aws-sdk/clients/s3";
+export interface ImageManagerCanProcessParams {
+    key: string;
+    extension: string;
+}
+export interface ImageManagerProcessParams {
+    s3: S3;
+    key: string;
+    extension: string;
+}
 declare const _default: {
-    canProcess: (opts: any) => boolean;
-    process({ s3, key, extension }: {
-        s3: any;
-        key: any;
-        extension: any;
-    }): Promise<void>;
+    canProcess: (params: ImageManagerCanProcessParams) => boolean;
+    process({ s3, key, extension }: ImageManagerProcessParams): Promise<void>;
 };
 export default _default;

package/handlers/transform/managers/imageManager.js

@@ -10,21 +10,17 @@ var _utils = require("../../utils");
 var _utils2 = require("../utils");
 
 var _default = {
-  canProcess: opts => {
+  canProcess: params => {
     const {
       key,
       extension
-    } = opts;
+    } = params;
 
-    if (!_utils2.SUPPORTED_IMAGES.includes(extension)) {
+    if (_utils2.SUPPORTED_IMAGES.includes(extension) === false) {
       return false;
     }
 
-    if (key.startsWith(_utils2.OPTIMIZED_IMAGE_PREFIX || key.startsWith(_utils2.OPTIMIZED_TRANSFORMED_IMAGE_PREFIX))) {
-      return false;
-    }
-
-    return true;
+    return key.startsWith(_utils2.OPTIMIZED_IMAGE_PREFIX) || key.startsWith(_utils2.OPTIMIZED_TRANSFORMED_IMAGE_PREFIX);
   },
 
   async process({
@@ -37,17 +33,18 @@ var _default = {
       key
     }))).promise(); // 2. Search for all transformed images and delete those too.
 
-    if (_utils2.SUPPORTED_TRANSFORMABLE_IMAGES.includes(extension)) {
-      const env = (0, _utils.getEnvironment)();
-      const imagesList = await s3.listObjects({
-        Bucket: env.bucket,
-        Prefix: (0, _utils2.getOptimizedTransformedImageKeyPrefix)(key)
-      }).promise();
-
-      for (let i = 0; i < imagesList.Contents.length; i++) {
-        const imageObject = imagesList.Contents[i];
-        await s3.deleteObject((0, _utils.getObjectParams)(imageObject.Key)).promise();
-      }
+    if (_utils2.SUPPORTED_TRANSFORMABLE_IMAGES.includes(extension) === false) {
+      return;
+    }
+
+    const env = (0, _utils.getEnvironment)();
+    const imagesList = await s3.listObjects({
+      Bucket: env.bucket,
+      Prefix: (0, _utils2.getOptimizedTransformedImageKeyPrefix)(key)
+    }).promise();
+
+    for (const imageObject of imagesList.Contents) {
+      await s3.deleteObject((0, _utils.getObjectParams)(imageObject.Key)).promise();
     }
   }
 

package/handlers/transform/managers/index.d.ts

@@ -1,9 +1,5 @@
 declare const _default: {
-    canProcess: (opts: any) => boolean;
-    process({ s3, key, extension }: {
-        s3: any;
-        key: any;
-        extension: any;
-    }): Promise<void>;
+    canProcess: (params: import("./imageManager").ImageManagerCanProcessParams) => boolean;
+    process({ s3, key, extension }: import("./imageManager").ImageManagerProcessParams): Promise<void>;
 }[];
 export default _default;

package/handlers/transform/optimizeImage.d.ts

@@ -1,2 +1,3 @@
-declare const _default: (buffer: any, type: any) => Promise<any>;
+import { Body } from "aws-sdk/clients/s3";
+declare const _default: (buffer: Body, type: string) => Promise<Body>;
 export default _default;

package/handlers/transform/optimizeImage.js

@@ -9,6 +9,9 @@ exports.default = void 0;
 
 var _sharp = _interopRequireDefault(require("sharp"));
 
+/**
+ * Sharp is included in the AWS Lambda layer
+ */
 // @ts-ignore
 var _default = async (buffer, type) => {
   switch (type) {

package/handlers/transform/transformImage.d.ts

@@ -1,9 +1,10 @@
-declare const _default: (buffer: any, transformations: any) => Promise<any>;
+import { Body } from "aws-sdk/clients/s3";
+interface Transformation {
+    width: string;
+}
+declare const _default: (buffer: Body, transformations: Transformation) => Promise<Body>;
 /**
  * Only processing "width" at the moment.
  * Check "sanitizeImageTransformations.js" to allow additional image processing transformations.
- * @param buffer
- * @param transformations
- * @returns {Promise<Buffer>}
  */
 export default _default;

package/handlers/transform/transformImage.js

@@ -9,14 +9,14 @@ exports.default = void 0;
 
 var _sharp = _interopRequireDefault(require("sharp"));
 
+/**
+ * Sharp is included in the AWS Lambda layer
+ */
 // @ts-ignore
 
 /**
  * Only processing "width" at the moment.
  * Check "sanitizeImageTransformations.js" to allow additional image processing transformations.
- * @param buffer
- * @param transformations
- * @returns {Promise<Buffer>}
  */
 var _default = async (buffer, transformations) => {
   const {

package/handlers/transform/utils.d.ts

@@ -2,8 +2,8 @@ declare const SUPPORTED_IMAGES: string[];
 declare const SUPPORTED_TRANSFORMABLE_IMAGES: string[];
 declare const OPTIMIZED_TRANSFORMED_IMAGE_PREFIX = "img-o-t-";
 declare const OPTIMIZED_IMAGE_PREFIX = "img-o-";
-declare const getOptimizedImageKeyPrefix: (key: any) => string;
-declare const getOptimizedTransformedImageKeyPrefix: (key: any) => string;
+declare const getOptimizedImageKeyPrefix: (key: string) => string;
+declare const getOptimizedTransformedImageKeyPrefix: (key: string) => string;
 interface GetImageKeyParams {
     key: string;
     transformations?: any;

package/handlers/types.d.ts

@@ -0,0 +1,33 @@
+export interface HandlerEventArgs {
+    httpMethod: "POST" | "OPTIONS";
+}
+interface S3Record {
+    s3: {
+        object: {
+            key?: string;
+        };
+    };
+}
+export interface ManageHandlerEventArgs extends HandlerEventArgs {
+    Records: S3Record[];
+}
+export interface DownloadHandlerEventArgs extends HandlerEventArgs {
+    pathParameters: {
+        path: string;
+    };
+    queryStringParameters?: {
+        width: string;
+    };
+}
+export interface TransformHandlerEventArgs extends HandlerEventArgs {
+    body: {
+        key: string;
+        transformations: {
+            width: string;
+        };
+    };
+}
+export interface HandlerHeaders {
+    [key: string]: string | boolean;
+}
+export {};

package/handlers/types.js

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

package/handlers/utils/createHandler.d.ts

@@ -1,24 +1,24 @@
-declare const _default: (handler: any) => (event: any) => Promise<{
-    body: string;
+import { HandlerEventArgs, HandlerHeaders } from "../types";
+import { Body } from "aws-sdk/clients/s3";
+interface EventHandlerResponse {
+    data: Body;
+    statusCode?: number;
+    headers: HandlerHeaders;
+}
+export interface EventHandlerCallable<T> {
+    (event: T): Promise<EventHandlerResponse>;
+}
+export declare const createHandler: <T extends HandlerEventArgs>(eventHandler: EventHandlerCallable<T>) => (event: T) => Promise<{
+    isBase64Encoded: boolean;
     statusCode: number;
     headers: {
-        "Cache-Control": string;
-        "Access-Control-Allow-Origin": string;
-        "Access-Control-Allow-Credentials": boolean;
+        [x: string]: string | boolean;
     };
-    isBase64Encoded?: undefined;
-} | {
-    isBase64Encoded: boolean;
-    statusCode: any;
-    headers: any;
-    body: any;
+    body: string;
 } | {
     statusCode: number;
-    headers: {
-        "Access-Control-Allow-Origin": string;
-        "Access-Control-Allow-Credentials": boolean;
-    };
+    headers: HandlerHeaders;
     body: string;
     isBase64Encoded?: undefined;
 }>;
-export default _default;
+export {};

package/handlers/utils/createHandler.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.createHandler = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -15,7 +15,6 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 /**
  * We need to respond with adequate CORS headers.
- * @type {{"Access-Control-Allow-Origin": string, "Access-Control-Allow-Credentials": boolean}}
  */
 const baseHeaders = {
   "Access-Control-Allow-Origin": "*",
@@ -23,46 +22,48 @@ const baseHeaders = {
 };
 const DEFAULT_CACHE_MAX_AGE = 30758400; // 1 year
 
-var _default = handler => async event => {
-  if (event.httpMethod === "OPTIONS") {
-    return {
-      body: "",
-      statusCode: 204,
-      headers: _objectSpread(_objectSpread({}, baseHeaders), {}, {
-        "Cache-Control": "public, max-age=" + DEFAULT_CACHE_MAX_AGE
-      })
-    };
-  }
+const createHandler = eventHandler => {
+  return async event => {
+    if (event.httpMethod === "OPTIONS") {
+      return {
+        body: "",
+        statusCode: 204,
+        headers: _objectSpread(_objectSpread({}, baseHeaders), {}, {
+          "Cache-Control": "public, max-age=" + DEFAULT_CACHE_MAX_AGE
+        })
+      };
+    }
 
-  try {
-    const {
-      data,
-      statusCode,
-      headers = {}
-    } = await handler(event);
-    const isBuffer = Buffer.isBuffer(data);
-    const body = isBuffer ? data.toString("base64") : JSON.stringify({
-      error: false,
-      data,
-      message: null
-    });
-    return {
-      isBase64Encoded: isBuffer,
-      statusCode: statusCode || 200,
-      headers: _objectSpread(_objectSpread({}, baseHeaders), headers),
-      body
-    };
-  } catch (e) {
-    return {
-      statusCode: 500,
-      headers: baseHeaders,
-      body: JSON.stringify({
-        error: true,
-        data: null,
-        message: e.message
-      })
-    };
-  }
+    try {
+      const {
+        data,
+        statusCode,
+        headers = {}
+      } = await eventHandler(event);
+      const isBuffer = Buffer.isBuffer(data);
+      const body = isBuffer ? data.toString("base64") : JSON.stringify({
+        error: false,
+        data,
+        message: null
+      });
+      return {
+        isBase64Encoded: isBuffer,
+        statusCode: statusCode || 200,
+        headers: _objectSpread(_objectSpread({}, baseHeaders), headers),
+        body
+      };
+    } catch (e) {
+      return {
+        statusCode: 500,
+        headers: baseHeaders,
+        body: JSON.stringify({
+          error: true,
+          data: null,
+          message: e.message
+        })
+      };
+    }
+  };
 };
 
-exports.default = _default;
+exports.createHandler = createHandler;

package/handlers/utils/getObjectParams.d.ts

@@ -1,10 +1,9 @@
-declare const _default: (filename: any) => {
+export interface ObjectParamsResponse {
     Bucket: string;
     Key: string;
-};
+}
+declare const _default: (filename: string) => ObjectParamsResponse;
 /**
  * Returns website's Bucket and file's Key values.
- * @param filename
- * @returns {{Bucket: string, Key: string}}
  */
 export default _default;

package/handlers/utils/getObjectParams.js

@@ -11,8 +11,6 @@ var _getEnvironment = _interopRequireDefault(require("./getEnvironment"));
 
 /**
  * Returns website's Bucket and file's Key values.
- * @param filename
- * @returns {{Bucket: string, Key: string}}
  */
 var _default = filename => {
   const {

package/handlers/utils/index.d.ts

@@ -1,3 +1,3 @@
 export { default as getEnvironment } from "./getEnvironment";
-export { default as createHandler } from "./createHandler";
+export * from "./createHandler";
 export { default as getObjectParams } from "./getObjectParams";

package/handlers/utils/index.js

@@ -5,12 +5,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "createHandler", {
-  enumerable: true,
-  get: function () {
-    return _createHandler.default;
-  }
-});
+var _exportNames = {
+  getEnvironment: true,
+  getObjectParams: true
+};
 Object.defineProperty(exports, "getEnvironment", {
   enumerable: true,
   get: function () {
@@ -26,6 +24,18 @@ Object.defineProperty(exports, "getObjectParams", {
 
 var _getEnvironment = _interopRequireDefault(require("./getEnvironment"));
 
-var _createHandler = _interopRequireDefault(require("./createHandler"));
+var _createHandler = require("./createHandler");
+
+Object.keys(_createHandler).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _createHandler[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _createHandler[key];
+    }
+  });
+});
 
 var _getObjectParams = _interopRequireDefault(require("./getObjectParams"));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api-file-manager",
-	"version": "5.23.0",
+	"version": "5.24.0-beta.0",
 	"main": "index.js",
 	"keywords": [
 		"fm:base"
@@ -20,18 +20,18 @@
 	"dependencies": {
 		"@babel/runtime": "7.16.7",
 		"@commodo/fields": "1.1.2-beta.20",
-		"@webiny/api-i18n-content": "5.23.0",
-		"@webiny/api-security": "5.23.0",
-		"@webiny/api-tenancy": "5.23.0",
-		"@webiny/api-upgrade": "5.23.0",
-		"@webiny/error": "5.23.0",
-		"@webiny/handler": "5.23.0",
-		"@webiny/handler-args": "5.23.0",
-		"@webiny/handler-client": "5.23.0",
-		"@webiny/handler-graphql": "5.23.0",
-		"@webiny/plugins": "5.23.0",
-		"@webiny/project-utils": "5.23.0",
-		"@webiny/validation": "5.23.0",
+		"@webiny/api-i18n-content": "5.24.0-beta.0",
+		"@webiny/api-security": "5.24.0-beta.0",
+		"@webiny/api-tenancy": "5.24.0-beta.0",
+		"@webiny/api-upgrade": "5.24.0-beta.0",
+		"@webiny/error": "5.24.0-beta.0",
+		"@webiny/handler": "5.24.0-beta.0",
+		"@webiny/handler-args": "5.24.0-beta.0",
+		"@webiny/handler-client": "5.24.0-beta.0",
+		"@webiny/handler-graphql": "5.24.0-beta.0",
+		"@webiny/plugins": "5.24.0-beta.0",
+		"@webiny/project-utils": "5.24.0-beta.0",
+		"@webiny/validation": "5.24.0-beta.0",
 		"aws-sdk": "2.1066.0",
 		"commodo-fields-object": "1.0.6",
 		"mdbid": "1.0.0",
@@ -45,9 +45,9 @@
 		"@babel/plugin-transform-runtime": "^7.16.4",
 		"@babel/preset-env": "^7.16.4",
 		"@babel/preset-typescript": "^7.16.0",
-		"@webiny/api-i18n": "^5.23.0",
-		"@webiny/api-i18n-ddb": "^5.23.0",
-		"@webiny/cli": "^5.23.0",
+		"@webiny/api-i18n": "^5.24.0-beta.0",
+		"@webiny/api-i18n-ddb": "^5.24.0-beta.0",
+		"@webiny/cli": "^5.24.0-beta.0",
 		"jest": "^26.6.3",
 		"rimraf": "^3.0.2",
 		"ttypescript": "^1.5.12",
@@ -72,5 +72,5 @@
 			]
 		}
 	},
-	"gitHead": "eaa0003e39194d687ab5397c08eeccdb3557fb28"
+	"gitHead": "05b90b92bbaf2ef3adf275d008c4641580cf5f42"
 }

package/plugins/crud/settings.crud.js

@@ -23,6 +23,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
+// TODO @ts-refactor verify that this is not used and remove it
 const SETTINGS_KEY = "file-manager";
 exports.SETTINGS_KEY = SETTINGS_KEY;
 const CreateDataModel = (0, _fields.withFields)({

package/plugins/crud/utils/createFileModel.d.ts

@@ -1,2 +1,5 @@
 declare const _default: (create?: boolean) => any;
+/**
+ * TODO @ts-refactor change for JOI or some other validation library
+ */
 export default _default;

package/plugins/crud/utils/createFileModel.js

@@ -11,6 +11,19 @@ var _commodoFieldsObject = require("commodo-fields-object");
 
 var _validation = require("@webiny/validation");
 
+/**
+ * Package @commodo/fields does not have types
+ */
+// @ts-ignore
+
+/**
+ * Package commodo-fields-object does not have types
+ */
+// @ts-ignore
+
+/**
+ * TODO @ts-refactor change for JOI or some other validation library
+ */
 var _default = (create = true) => {
   return (0, _fields.withFields)({
     key: (0, _fields.string)({

package/plugins/crud/utils/lifecycleEvents.d.ts

@@ -1,6 +1,6 @@
-import { FilePlugin } from "../../definitions/FilePlugin";
+import { FilePlugin, FilePluginParams } from "../../definitions/FilePlugin";
 import { FileManagerContext } from "../../../types";
-export declare const runLifecycleEvent: (hook: string, params: {
+export declare const runLifecycleEvent: (hook: keyof FilePluginParams, params: {
     context: FileManagerContext;
     plugins: FilePlugin[];
 } & Record<string, any>) => Promise<void>;

package/plugins/crud/utils/lifecycleEvents.js

@@ -11,6 +11,7 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 const _excluded = ["plugins"];
 
+// TODO @ts-refactor introduce pubsub methods
 const runLifecycleEvent = async (hook, params) => {
   const {
     plugins
@@ -25,6 +26,10 @@ const runLifecycleEvent = async (hook, params) => {
     if (!plugin[hook]) {
       continue;
     }
+    /**
+     * Keep any because we do not know which hook needs to be executed. This will be removed, so it does not matter.
+     */
+
 
     await plugin[hook](rest);
   }

package/plugins/definitions/FilePhysicalStoragePlugin.d.ts

@@ -1,22 +1,21 @@
 /// <reference types="node" />
 import { Plugin } from "@webiny/plugins";
 import { FileManagerSettings } from "../../types";
-export interface Params {
-    upload: (args: UploadParams) => Promise<any>;
-    delete: (args: DeleteParams) => Promise<void>;
+export interface FilePhysicalStoragePluginParams<U extends FilePhysicalStoragePluginUploadParams, D extends FilePhysicalStoragePluginDeleteParams> {
+    upload: (args: U) => Promise<any>;
+    delete: (args: D) => Promise<void>;
 }
-export interface UploadParams {
+export interface FilePhysicalStoragePluginUploadParams {
     settings: FileManagerSettings;
     buffer: Buffer;
-    [key: string]: any;
 }
-export interface DeleteParams {
+export interface FilePhysicalStoragePluginDeleteParams {
     key: string;
 }
-export declare class FilePhysicalStoragePlugin extends Plugin {
+export declare class FilePhysicalStoragePlugin<U extends FilePhysicalStoragePluginUploadParams = FilePhysicalStoragePluginUploadParams, D extends FilePhysicalStoragePluginDeleteParams = FilePhysicalStoragePluginDeleteParams> extends Plugin {
     static readonly type = "api-file-manager-storage";
     private readonly _params;
-    constructor(params: Params);
-    upload(params: UploadParams): Promise<any>;
-    delete(params: DeleteParams): Promise<any>;
+    constructor(params: FilePhysicalStoragePluginParams<U, D>);
+    upload(params: U): Promise<any>;
+    delete(params: D): Promise<any>;
 }

package/plugins/definitions/FilePlugin.d.ts

@@ -107,7 +107,7 @@ export interface AfterDeleteParams {
  *
  * @category FilePlugin
  */
-export interface Params {
+export interface FilePluginParams {
     beforeCreate?: (params: BeforeCreateParams) => Promise<void>;
     afterCreate?: (params: AfterCreateParams) => Promise<void>;
     beforeUpdate?: (params: BeforeUpdateParams) => Promise<void>;
@@ -120,7 +120,7 @@ export interface Params {
 export declare class FilePlugin extends Plugin {
     static readonly type = "fm.file";
     private readonly _params;
-    constructor(params?: Params);
+    constructor(params?: FilePluginParams);
     beforeCreate(params: BeforeCreateParams): Promise<void>;
     afterCreate(params: AfterCreateParams): Promise<void>;
     beforeUpdate(params: BeforeUpdateParams): Promise<void>;
@@ -129,5 +129,8 @@ export declare class FilePlugin extends Plugin {
     afterBatchCreate(params: AfterBatchCreateParams): Promise<void>;
     beforeDelete(params: BeforeDeleteParams): Promise<void>;
     afterDelete(params: AfterDeleteParams): Promise<void>;
+    /**
+     * Keep any here because it can be a number of params. Method is internal so no need to complicate the code.
+     */
     private _execute;
 }

package/plugins/definitions/FilePlugin.js

@@ -49,6 +49,10 @@ class FilePlugin extends _plugins.Plugin {
   async afterDelete(params) {
     await this._execute("afterDelete", params);
   }
+  /**
+   * Keep any here because it can be a number of params. Method is internal so no need to complicate the code.
+   */
+
 
   async _execute(callback, params) {
     if (typeof this._params[callback] !== "function") {

package/plugins/definitions/FileStorageTransformPlugin.d.ts

@@ -1,34 +1,34 @@
 import { Plugin } from "@webiny/plugins";
 import { File } from "../../types";
-export interface ToParams {
+export interface FileStorageTransformPluginToParams {
     /**
      * File that is being sent to the storage operations method.
      */
     file: File & Record<string, any>;
 }
-export interface FromParams {
+export interface FileStorageTransformPluginFromParams {
     /**
      * File that was fetched from the storage operations method.
      */
     file: File & Record<string, any>;
 }
-export interface Params {
-    toStorage?: (params: ToParams) => Promise<File & Record<string, any>>;
-    fromStorage?: (params: FromParams) => Promise<File & Record<string, any>>;
+export interface FileStorageTransformPluginParams {
+    toStorage?: (params: FileStorageTransformPluginToParams) => Promise<File & Record<string, any>>;
+    fromStorage?: (params: FileStorageTransformPluginFromParams) => Promise<File & Record<string, any>>;
 }
 export declare class FileStorageTransformPlugin extends Plugin {
     static readonly type = "fm.files.storage.transform";
     private readonly _params;
-    constructor(params: Params);
+    constructor(params: FileStorageTransformPluginParams);
     /**
      * Transform the file value into something that can be stored.
      * Be aware that you must return the whole file object.
      */
-    toStorage(params: ToParams): Promise<File & Record<string, any>>;
+    toStorage(params: FileStorageTransformPluginToParams): Promise<File & Record<string, any>>;
     /**
      * Transform the file value from the storage type to one required by our system.
      * Be aware that you must return the whole file object.
      * This method MUST reverse what ever toStorage method changed on the file object.
      */
-    fromStorage(params: FromParams): Promise<File & Record<string, any>>;
+    fromStorage(params: FileStorageTransformPluginFromParams): Promise<File & Record<string, any>>;
 }

package/plugins/definitions/FilesStorageOperationsProviderPlugin.d.ts

@@ -1,9 +1,9 @@
 import { Plugin } from "@webiny/plugins";
 import { FileManagerContext, FileManagerFilesStorageOperations } from "../../types";
-export interface Params {
+export interface FilesStorageOperationsProviderPluginParams {
     context: FileManagerContext;
 }
 export declare abstract class FilesStorageOperationsProviderPlugin extends Plugin {
     static readonly type = "fm.storageOperationsProvider.files";
-    abstract provide(params: Params): Promise<FileManagerFilesStorageOperations>;
+    abstract provide(params: FilesStorageOperationsProviderPluginParams): Promise<FileManagerFilesStorageOperations>;
 }

package/plugins/definitions/InstallationPlugin.d.ts

@@ -1,19 +1,19 @@
 import { FileManagerContext } from "../../types";
 import { Plugin } from "@webiny/plugins";
-export declare type CallbackFunction<TParams> = (params: TParams) => Promise<void>;
-export interface Params {
+export interface InstallationPluginParams {
     context: FileManagerContext;
 }
-interface Config {
-    beforeInstall?: CallbackFunction<Params>;
-    afterInstall?: CallbackFunction<Params>;
+export declare type CallbackFunction<TParams> = (params: TParams) => Promise<void>;
+interface InstallationPluginConfig {
+    beforeInstall?: CallbackFunction<InstallationPluginParams>;
+    afterInstall?: CallbackFunction<InstallationPluginParams>;
 }
 export declare abstract class InstallationPlugin extends Plugin {
     static readonly type = "fm.install";
     private readonly _config;
-    constructor(config?: Partial<Config>);
-    beforeInstall(params: Params): Promise<void>;
-    afterInstall(params: Params): Promise<void>;
+    constructor(config?: Partial<InstallationPluginConfig>);
+    beforeInstall(params: InstallationPluginParams): Promise<void>;
+    afterInstall(params: InstallationPluginParams): Promise<void>;
     private _execute;
 }
 export {};

package/plugins/definitions/SettingsStorageOperationsProviderPlugin.d.ts

@@ -1,9 +1,9 @@
 import { Plugin } from "@webiny/plugins";
 import { FileManagerContext, FileManagerSettingsStorageOperations } from "../../types";
-export interface Params {
+export interface SettingsStorageOperationsProviderPluginParams {
     context: FileManagerContext;
 }
 export declare abstract class SettingsStorageOperationsProviderPlugin extends Plugin {
     static readonly type = "fm.storageOperationsProvider.settings";
-    abstract provide(params: Params): Promise<FileManagerSettingsStorageOperations>;
+    abstract provide(params: SettingsStorageOperationsProviderPluginParams): Promise<FileManagerSettingsStorageOperations>;
 }

package/plugins/definitions/SystemStorageOperationsProviderPlugin.d.ts

@@ -1,9 +1,9 @@
 import { Plugin } from "@webiny/plugins";
 import { FileManagerContext, FileManagerSystemStorageOperations } from "../../types";
-export interface Params {
+export interface SystemStorageOperationsProviderPluginParams {
     context: FileManagerContext;
 }
 export declare abstract class SystemStorageOperationsProviderPlugin extends Plugin {
     static readonly type = "fm.storageOperationsProvider.system";
-    abstract provide(params: Params): Promise<FileManagerSystemStorageOperations>;
+    abstract provide(params: SystemStorageOperationsProviderPluginParams): Promise<FileManagerSystemStorageOperations>;
 }

package/plugins/graphql.js

@@ -8,6 +8,11 @@ exports.default = void 0;
 var _handlerGraphql = require("@webiny/handler-graphql");
 
 const emptyResolver = () => ({});
+/**
+ * Use any because it really can be any.
+ * TODO @ts-refactor maybe use generics at some point?
+ */
+
 
 const resolve = async fn => {
   try {
@@ -99,11 +104,13 @@ const plugin = {
             type FileManagerSettings {
                 uploadMinFileSize: Number
                 uploadMaxFileSize: Number
+                srcPrefix: String
             }
 
             input FileManagerSettingsInput {
                 uploadMinFileSize: Number
                 uploadMaxFileSize: Number
+                srcPrefix: String
             }
 
             type FileManagerSettingsResponse {

package/plugins/storage/FileStorage.d.ts

@@ -1,31 +1,30 @@
 /// <reference types="node" />
 import { FileManagerContext } from "../../types";
-export declare type Args = {
-    name: string;
-    type: string;
-    size: number;
+export declare type Result = Record<string, any>;
+export interface FileStorageUploadParams {
     buffer: Buffer;
-    keyPrefix?: string;
-    hideInFileManager?: boolean;
+    hideInFileManager: boolean | string;
     tags?: string[];
-};
-export declare type Result = Record<string, any>;
-export interface FileStoragePlugin {
-    upload: (args: Args) => Promise<Result>;
-    delete: (args: {
-        key: string;
-    }) => Promise<void>;
+    size: number;
+    name: string;
+    keyPrefix: string;
+    type: string;
 }
-export declare class FileStorage {
-    storagePlugin: FileStoragePlugin;
+export interface FileStorageDeleteParams {
+    id: string;
+    key: string;
+}
+export interface FileStorageUploadMultipleParams {
+    files: FileStorageUploadParams[];
+}
+export interface FileStorageParams {
     context: FileManagerContext;
-    constructor({ context }: {
-        context: any;
-    });
-    upload(args: any): Promise<Result>;
-    uploadFiles(args: any): Promise<import("../../types").File[]>;
-    delete(args: {
-        id: string;
-        key: string;
-    }): Promise<boolean>;
+}
+export declare class FileStorage {
+    private readonly storagePlugin;
+    private readonly context;
+    constructor({ context }: FileStorageParams);
+    upload(params: FileStorageUploadParams): Promise<Result>;
+    uploadFiles(params: FileStorageUploadMultipleParams): Promise<import("../../types").File[]>;
+    delete(params: FileStorageDeleteParams): Promise<boolean>;
 }

package/plugins/storage/FileStorage.js

@@ -32,12 +32,12 @@ class FileStorage {
     this.context = context;
   }
 
-  async upload(args) {
+  async upload(params) {
     const settings = await this.context.fileManager.settings.getSettings(); // Add file to cloud storage.
 
     const {
       file: fileData
-    } = await this.storagePlugin.upload(_objectSpread(_objectSpread({}, args), {}, {
+    } = await this.storagePlugin.upload(_objectSpread(_objectSpread({}, params), {}, {
       settings
     }));
     const {
@@ -46,19 +46,18 @@ class FileStorage {
 
     return await fileManager.files.createFile(_objectSpread(_objectSpread({}, fileData), {}, {
       meta: {
-        private: Boolean(args.hideInFileManager)
+        private: Boolean(params.hideInFileManager)
       },
-      tags: Array.isArray(args.tags) ? args.tags : []
+      tags: Array.isArray(params.tags) ? params.tags : []
     }));
   }
 
-  async uploadFiles(args) {
+  async uploadFiles(params) {
     const settings = await this.context.fileManager.settings.getSettings(); // Upload files to cloud storage.
 
     const promises = [];
 
-    for (let i = 0; i < args.files.length; i++) {
-      const item = args.files[i];
+    for (const item of params.files) {
       promises.push(this.storagePlugin.upload(_objectSpread(_objectSpread({}, item), {}, {
         settings
       })));
@@ -74,11 +73,11 @@ class FileStorage {
     return fileManager.files.createFilesInBatch(filesData);
   }
 
-  async delete(args) {
+  async delete(params) {
     const {
       id,
       key
-    } = args;
+    } = params;
     const {
       fileManager
     } = this.context; // Delete file from cloud storage.

package/plugins/storage/index.js

@@ -11,6 +11,10 @@ var _FileStorage = require("./FileStorage");
 
 const fileStorageContextPlugin = new _handler.ContextPlugin(async context => {
   if (!context.fileManager) {
+    /**
+     * We need to define the fileManager initial property as empty object.
+     * When casting as FileManagerContext, typescript is complaining.
+     */
     context.fileManager = {};
   }
 

package/types.d.ts

@@ -294,7 +294,7 @@ export interface FileManagerFilesStorageOperationsListParams {
  * @category FilesStorageOperations
  * @category FilesStorageOperationsParams
  */
-interface FileManagerFilesStorageOperationsListResponseMeta {
+export interface FileManagerFilesStorageOperationsListResponseMeta {
     hasMoreItems: boolean;
     totalCount: number;
     cursor: string;