@webiny/api-file-manager 0.0.0-mt-2 → 0.0.0-unstable.0156a4c312

package/types.d.ts

@@ -1,357 +1,7 @@
-import { BaseI18NContentContext } from "@webiny/api-i18n-content/types";
-import { FileStorage } from "./plugins/storage/FileStorage";
-import { TenancyContext } from "@webiny/api-tenancy/types";
-import { SecurityContext, SecurityPermission } from "@webiny/api-security/types";
-import { ContextInterface } from "@webiny/handler/types";
-export interface FileManagerContext extends ContextInterface, SecurityContext, TenancyContext, BaseI18NContentContext {
-    fileManager: {
-        files: FilesCRUD;
-        settings: SettingsCRUD;
-        storage: FileStorage;
-        system: SystemCRUD;
-    };
-}
+import "@webiny/background-tasks/api/features/TaskController/augmentation.js";
+import type { SecurityPermission } from "@webiny/api-core/types/security.js";
 export interface FilePermission extends SecurityPermission {
     name: "fm.file";
     rwd?: string;
     own?: boolean;
 }
-export interface File {
-    id: string;
-    key: string;
-    size: number;
-    type: string;
-    name: string;
-    meta: Record<string, any>;
-    tags: string[];
-    createdOn: string;
-    createdBy: CreatedBy;
-    /**
-     * Added with new storage operations refactoring.
-     */
-    tenant: string;
-    locale: string;
-    webinyVersion: string;
-    /**
-     * User can add new fields to the File object so we must allow it in the types.
-     */
-    [key: string]: any;
-}
-export interface CreatedBy {
-    id: string;
-    displayName: string;
-    type: string;
-}
-export interface FileInput {
-    key: string;
-    name: string;
-    size: number;
-    type: string;
-    meta: Record<string, any>;
-    tags: [string];
-}
-export interface FileListWhereParams {
-    search?: string;
-    type?: string;
-    type_in?: string[];
-    tag?: string;
-    tag_in?: string[];
-    tag_and_in?: string[];
-    id_in?: string[];
-    id?: string;
-}
-export interface FilesListOpts {
-    search?: string;
-    types?: string[];
-    tags?: string[];
-    ids?: string[];
-    limit?: number;
-    after?: string;
-    where?: FileListWhereParams;
-    sort?: string[];
-}
-export interface FileListMeta {
-    cursor: string;
-    totalCount: number;
-}
-interface FilesCrudListTagsWhere {
-    tag?: string;
-    tag_contains?: string;
-    tag_in?: string[];
-}
-interface FilesCrudListTagsParams {
-    where?: FilesCrudListTagsWhere;
-    limit?: number;
-    after?: string;
-}
-export interface FilesCRUD {
-    getFile(id: string): Promise<File>;
-    listFiles(opts?: FilesListOpts): Promise<[File[], FileListMeta]>;
-    listTags(params: FilesCrudListTagsParams): Promise<string[]>;
-    createFile(data: FileInput): Promise<File>;
-    updateFile(id: string, data: Partial<FileInput>): Promise<File>;
-    deleteFile(id: string): Promise<boolean>;
-    createFilesInBatch(data: FileInput[]): Promise<File[]>;
-}
-export interface SystemCRUD {
-    getVersion(): Promise<string>;
-    setVersion(version: string): Promise<void>;
-    install(args: {
-        srcPrefix: string;
-    }): Promise<boolean>;
-    upgrade(version: string, data?: Record<string, any>): Promise<boolean>;
-}
-export interface FileManagerSettings {
-    key: string;
-    uploadMinFileSize: number;
-    uploadMaxFileSize: number;
-    srcPrefix: string;
-}
-export interface FileManagerSystem {
-    version: string;
-}
-export declare type SettingsCRUD = {
-    getSettings(): Promise<FileManagerSettings>;
-    createSettings(data?: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
-    updateSettings(data: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
-    deleteSettings(): Promise<boolean>;
-};
-/********
- * Storage operations
- *******/
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- * @category SystemStorageOperationsParams
- */
-export interface FileManagerSystemStorageOperationsUpdateParams {
-    /**
-     * The system data to be updated.
-     */
-    original: FileManagerSystem;
-    /**
-     * The system data with the updated fields.
-     */
-    data: FileManagerSystem;
-}
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- * @category SystemStorageOperationsParams
- */
-export interface FileManagerSystemStorageOperationsCreateParams {
-    /**
-     * The system fields.
-     */
-    data: FileManagerSystem;
-}
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- */
-export interface FileManagerSystemStorageOperations {
-    /**
-     * Get the FileManager system data.
-     */
-    get: () => Promise<FileManagerSystem | null>;
-    /**
-     * Update the FileManager system data..
-     */
-    update: (params: FileManagerSystemStorageOperationsUpdateParams) => Promise<FileManagerSystem>;
-    /**
-     * Create the FileManagerSystemData
-     */
-    create: (params: FileManagerSystemStorageOperationsCreateParams) => Promise<FileManagerSystem>;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- * @category SettingsStorageOperationsParams
- */
-export interface FileManagerSettingsStorageOperationsUpdateParams {
-    /**
-     * Original settings to be updated.
-     */
-    original: FileManagerSettings;
-    /**
-     * The settings with the updated fields.
-     */
-    data: FileManagerSettings;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- * @category SettingsStorageOperationsParams
- */
-export interface FileManagerSettingsStorageOperationsCreateParams {
-    /**
-     * The settings fields.
-     */
-    data: FileManagerSettings;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- */
-export interface FileManagerSettingsStorageOperations {
-    /**
-     * Get the FileManager system data.
-     */
-    get: () => Promise<FileManagerSettings | null>;
-    /**
-     * Create the FileManagerSettingsData
-     */
-    create: (params: FileManagerSettingsStorageOperationsCreateParams) => Promise<FileManagerSettings>;
-    /**
-     * Update the FileManager system data..
-     */
-    update: (params: FileManagerSettingsStorageOperationsUpdateParams) => Promise<FileManagerSettings>;
-    /**
-     * Delete the existing settings.
-     */
-    delete: () => Promise<void>;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsGetParams {
-    where: {
-        id: string;
-        tenant: string;
-        locale: string;
-    };
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsCreateParams {
-    file: File;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsUpdateParams {
-    original: File;
-    file: File;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsDeleteParams {
-    file: File;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsCreateBatchParams {
-    files: File[];
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListParamsWhere {
-    id?: string;
-    id_in?: string[];
-    name?: string;
-    name_contains?: string;
-    tag?: string;
-    tag_contains?: string;
-    tag_in?: string[];
-    createdBy?: string;
-    locale: string;
-    tenant: string;
-    private?: boolean;
-    type?: string;
-    type_in?: string[];
-    search?: string;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListParams {
-    where: FileManagerFilesStorageOperationsListParamsWhere;
-    sort: string[];
-    limit: number;
-    after: string | null;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-interface FileManagerFilesStorageOperationsListResponseMeta {
-    hasMoreItems: boolean;
-    totalCount: number;
-    cursor: string;
-}
-export declare type FileManagerFilesStorageOperationsListResponse = [
-    File[],
-    FileManagerFilesStorageOperationsListResponseMeta
-];
-export declare type FileManagerFilesStorageOperationsTagsResponse = [
-    string[],
-    FileManagerFilesStorageOperationsListResponseMeta
-];
-export interface FileManagerFilesStorageOperationsTagsParamsWhere extends FilesCrudListTagsWhere {
-    locale: string;
-    tenant: string;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsTagsParams {
-    where: FileManagerFilesStorageOperationsTagsParamsWhere;
-    limit: number;
-    after?: string;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- */
-export interface FileManagerFilesStorageOperations {
-    /**
-     * Get a single file with given ID from the storage.
-     */
-    get: (params: FileManagerFilesStorageOperationsGetParams) => Promise<File | null>;
-    /**
-     * Insert the file data into the database.
-     */
-    create: (params: FileManagerFilesStorageOperationsCreateParams) => Promise<File | null>;
-    /**
-     * Update the file data in the database.
-     */
-    update: (params: FileManagerFilesStorageOperationsUpdateParams) => Promise<File | null>;
-    /**
-     * Delete the file from the database.
-     */
-    delete: (params: FileManagerFilesStorageOperationsDeleteParams) => Promise<void>;
-    /**
-     * Store multiple files at once to the database.
-     */
-    createBatch: (params: FileManagerFilesStorageOperationsCreateBatchParams) => Promise<File[]>;
-    /**
-     * Get a list of files filtered by given parameters.
-     */
-    list: (params: FileManagerFilesStorageOperationsListParams) => Promise<FileManagerFilesStorageOperationsListResponse>;
-    /**
-     * Get a list of all file tags filtered by given parameters.
-     */
-    tags: (params: FileManagerFilesStorageOperationsTagsParams) => Promise<FileManagerFilesStorageOperationsTagsResponse>;
-}
-export {};

package/types.js

@@ -1,5 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+import "@webiny/background-tasks/api/features/TaskController/augmentation.js";

package/handlers/download/index.d.ts

@@ -1,3 +0,0 @@
-import { HandlerPlugin } from "@webiny/handler/types";
-declare const _default: () => HandlerPlugin;
-export default _default;

package/handlers/download/index.js

@@ -1,125 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
-
-var _sanitizeFilename = _interopRequireDefault(require("sanitize-filename"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _utils = require("../utils");
-
-var _loaders = _interopRequireDefault(require("../transform/loaders"));
-
-const MAX_RETURN_CONTENT_LENGTH = 5000000; // ~4.77MB
-
-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 {
-    filename: decodeURI(path),
-    options: event.queryStringParameters,
-    extension: _path.default.extname(path)
-  };
-};
-
-const getS3Object = async (event, s3, context) => {
-  const {
-    options,
-    filename,
-    extension
-  } = extractFilenameOptions(event);
-
-  for (let i = 0; i < _loaders.default.length; i++) {
-    const loader = _loaders.default[i];
-    const canProcess = loader.canProcess({
-      context,
-      s3,
-      options,
-      file: {
-        name: filename,
-        extension
-      }
-    });
-
-    if (canProcess) {
-      return loader.process({
-        context,
-        s3,
-        options,
-        file: {
-          name: filename,
-          extension
-        }
-      });
-    }
-  } // If no processors handled the file request, just return the S3 object by default.
-
-
-  const params = (0, _utils.getObjectParams)(filename);
-  return {
-    object: await s3.getObject(params).promise(),
-    params: params
-  };
-};
-
-var _default = () => ({
-  type: "handler",
-  name: "handler-download-file",
-
-  async handle(context) {
-    const event = context.invocationArgs;
-    const handler = (0, _utils.createHandler)(async event => {
-      const {
-        region
-      } = (0, _utils.getEnvironment)();
-      const s3 = new _s.default({
-        region
-      });
-      const {
-        params,
-        object
-      } = await getS3Object(event, s3, context);
-
-      if (object.ContentLength < MAX_RETURN_CONTENT_LENGTH) {
-        return {
-          data: object.Body,
-          headers: {
-            "Content-Type": object.ContentType,
-            "Cache-Control": "public, max-age=" + DEFAULT_CACHE_MAX_AGE
-          }
-        };
-      } // Lambda can return max 6MB of content, so if our object's size is larger, we are sending
-      // a 301 Redirect, redirecting the user to the public URL of the object in S3.
-
-
-      await s3.putObjectAcl({
-        Bucket: params.Bucket,
-        ACL: "public-read",
-        Key: params.Key
-      }).promise();
-      return {
-        statusCode: 301,
-        headers: {
-          Location: `https://${params.Bucket}.s3.amazonaws.com/${params.Key}`
-        }
-      };
-    });
-    return await handler(event);
-  }
-
-});
-
-exports.default = _default;

package/handlers/manage/index.d.ts

@@ -1,3 +0,0 @@
-import { HandlerPlugin } from "@webiny/handler/types";
-declare const _default: () => HandlerPlugin;
-export default _default;

package/handlers/manage/index.js

@@ -1,70 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _path = _interopRequireDefault(require("path"));
-
-var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
-
-var _utils = require("../utils");
-
-var _managers = _interopRequireDefault(require("../transform/managers"));
-
-var _default = () => ({
-  type: "handler",
-  name: "handler-download-file",
-
-  async handle(context) {
-    const event = context.invocationArgs;
-    const handler = (0, _utils.createHandler)(async event => {
-      const keys = [];
-
-      for (let i = 0; i < event.Records.length; i++) {
-        const record = event.Records[i];
-
-        if (typeof record.s3.object.key === "string") {
-          keys.push(record.s3.object.key);
-        }
-      }
-
-      const {
-        region
-      } = (0, _utils.getEnvironment)();
-      const s3 = new _s.default({
-        region
-      });
-
-      for (let i = 0; i < keys.length; i++) {
-        const key = keys[i];
-
-        const extension = _path.default.extname(key);
-
-        for (let j = 0; j < _managers.default.length; j++) {
-          const manager = _managers.default[j];
-          const canProcess = manager.canProcess({
-            s3,
-            key,
-            extension
-          });
-
-          if (canProcess) {
-            await manager.process({
-              s3,
-              key,
-              extension
-            });
-          }
-        }
-      }
-    });
-    return await handler(event);
-  }
-
-});
-
-exports.default = _default;

package/handlers/transform/index.d.ts

@@ -1,3 +0,0 @@
-import { HandlerPlugin } from "@webiny/handler/types";
-declare const _default: () => HandlerPlugin;
-export default _default;

package/handlers/transform/index.js

@@ -1,96 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
-
-var _transformImage = _interopRequireDefault(require("./transformImage"));
-
-var _optimizeImage = _interopRequireDefault(require("./optimizeImage"));
-
-var _utils = require("../utils");
-
-var _utils2 = require("./utils");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-var _default = () => ({
-  type: "handler",
-  name: "handler-download-file",
-
-  async handle(context) {
-    const event = context.invocationArgs;
-    const handler = (0, _utils.createHandler)(async ({
-      body: {
-        transformations,
-        key
-      }
-    }) => {
-      try {
-        const env = (0, _utils.getEnvironment)();
-        const s3 = new _s.default({
-          region: env.region
-        });
-        let optimizedImageObject;
-        const params = {
-          initial: (0, _utils.getObjectParams)(key),
-          optimized: (0, _utils.getObjectParams)((0, _utils2.getImageKey)({
-            key
-          })),
-          optimizedTransformed: (0, _utils.getObjectParams)((0, _utils2.getImageKey)({
-            key,
-            transformations
-          }))
-        }; // 1. Get optimized image.
-
-        try {
-          optimizedImageObject = await s3.getObject(params.optimized).promise();
-        } catch (e) {
-          // If not found, try to create it by loading the initially uploaded image.
-          optimizedImageObject = await s3.getObject(params.initial).promise();
-          await s3.putObject(_objectSpread(_objectSpread({}, params.optimized), {}, {
-            ContentType: optimizedImageObject.ContentType,
-            Body: await (0, _optimizeImage.default)(optimizedImageObject.Body, optimizedImageObject.ContentType)
-          })).promise();
-          optimizedImageObject = await s3.getObject(params.optimized).promise();
-        } // 2. If no transformations requested, just exit.
-
-
-        if (!transformations) {
-          return {
-            error: false,
-            message: ""
-          };
-        } // 3. If transformations requested, apply them in save it into the bucket.
-
-
-        await s3.putObject(_objectSpread(_objectSpread({}, params.optimizedTransformed), {}, {
-          ContentType: optimizedImageObject.ContentType,
-          Body: await (0, _transformImage.default)(optimizedImageObject.Body, transformations)
-        })).promise();
-        return {
-          error: false,
-          message: ""
-        };
-      } catch (e) {
-        return {
-          error: true,
-          message: e.message
-        };
-      }
-    });
-    return await handler(event);
-  }
-
-});
-
-exports.default = _default;

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

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