@webiny/api-file-manager 0.0.0-ee-vpcs.549378cf03

package/plugins/storage/FileStorage.js

@@ -0,0 +1,103 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FileStorage = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+const storagePluginType = "api-file-manager-storage";
+
+class FileStorage {
+  constructor({
+    context
+  }) {
+    (0, _defineProperty2.default)(this, "storagePlugin", void 0);
+    (0, _defineProperty2.default)(this, "context", void 0);
+    const storagePlugin = context.plugins.byType(storagePluginType).pop();
+
+    if (!storagePlugin) {
+      throw new _error.default(`Missing plugin of type "${storagePluginType}".`, "STORAGE_PLUGIN_ERROR");
+    }
+
+    this.storagePlugin = storagePlugin;
+    this.context = context;
+  }
+
+  async upload(params) {
+    const settings = await this.context.fileManager.settings.getSettings();
+
+    if (!settings) {
+      throw new _error.default("Missing File Manager Settings.", "FILE_MANAGER_ERROR");
+    } // Add file to cloud storage.
+
+
+    const {
+      file: fileData
+    } = await this.storagePlugin.upload((0, _objectSpread2.default)((0, _objectSpread2.default)({}, params), {}, {
+      settings
+    }));
+    const {
+      fileManager
+    } = this.context; // Save file in DB.
+
+    return await fileManager.files.createFile((0, _objectSpread2.default)((0, _objectSpread2.default)({}, fileData), {}, {
+      meta: {
+        private: Boolean(params.hideInFileManager)
+      },
+      tags: Array.isArray(params.tags) ? params.tags : []
+    }));
+  }
+
+  async uploadFiles(params) {
+    const settings = await this.context.fileManager.settings.getSettings();
+
+    if (!settings) {
+      throw new _error.default("Missing File Manager Settings.", "FILE_MANAGER_ERROR");
+    } // Upload files to cloud storage.
+
+
+    const promises = [];
+
+    for (const item of params.files) {
+      promises.push(this.storagePlugin.upload((0, _objectSpread2.default)((0, _objectSpread2.default)({}, item), {}, {
+        settings
+      })));
+    } // Wait for all to resolve.
+
+
+    const uploadFileResponses = await Promise.all(promises);
+    const filesData = uploadFileResponses.map(response => response.file);
+    const {
+      fileManager
+    } = this.context; // Save files in DB.
+
+    return fileManager.files.createFilesInBatch(filesData);
+  }
+
+  async delete(params) {
+    const {
+      id,
+      key
+    } = params;
+    const {
+      fileManager
+    } = this.context; // Delete file from cloud storage.
+
+    await this.storagePlugin.delete({
+      key
+    }); // Delete file from the DB.
+
+    return await fileManager.files.deleteFile(id);
+  }
+
+}
+
+exports.FileStorage = FileStorage;

package/plugins/storage/FileStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["storagePluginType","FileStorage","constructor","context","storagePlugin","plugins","byType","pop","WebinyError","upload","params","settings","fileManager","getSettings","file","fileData","files","createFile","meta","private","Boolean","hideInFileManager","tags","Array","isArray","uploadFiles","promises","item","push","uploadFileResponses","Promise","all","filesData","map","response","createFilesInBatch","delete","id","key","deleteFile"],"sources":["FileStorage.ts"],"sourcesContent":["import { FileManagerContext } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport { FilePhysicalStoragePlugin } from \"~/plugins/definitions/FilePhysicalStoragePlugin\";\n\nexport type Result = Record<string, any>;\n\nconst storagePluginType = \"api-file-manager-storage\";\n\nexport interface FileStorageUploadParams {\n    buffer: Buffer;\n    hideInFileManager: boolean | string;\n    tags?: string[];\n    size: number;\n    name: string;\n    keyPrefix: string;\n    type: string;\n}\nexport interface FileStorageDeleteParams {\n    id: string;\n    key: string;\n}\n\nexport interface FileStorageUploadMultipleParams {\n    files: FileStorageUploadParams[];\n}\n\nexport interface FileStorageParams {\n    context: FileManagerContext;\n}\nexport class FileStorage {\n    private readonly storagePlugin: FilePhysicalStoragePlugin;\n    private readonly context: FileManagerContext;\n\n    constructor({ context }: FileStorageParams) {\n        const storagePlugin = context.plugins\n            .byType<FilePhysicalStoragePlugin>(storagePluginType)\n            .pop();\n        if (!storagePlugin) {\n            throw new WebinyError(\n                `Missing plugin of type \"${storagePluginType}\".`,\n                \"STORAGE_PLUGIN_ERROR\"\n            );\n        }\n        this.storagePlugin = storagePlugin;\n        this.context = context;\n    }\n\n    async upload(params: FileStorageUploadParams): Promise<Result> {\n        const settings = await this.context.fileManager.settings.getSettings();\n        if (!settings) {\n            throw new WebinyError(\"Missing File Manager Settings.\", \"FILE_MANAGER_ERROR\");\n        }\n        // Add file to cloud storage.\n        const { file: fileData } = await this.storagePlugin.upload({\n            ...params,\n            settings\n        });\n\n        const { fileManager } = this.context;\n\n        // Save file in DB.\n        return await fileManager.files.createFile({\n            ...(fileData as any),\n            meta: {\n                private: Boolean(params.hideInFileManager)\n            },\n            tags: Array.isArray(params.tags) ? params.tags : []\n        });\n    }\n\n    async uploadFiles(params: FileStorageUploadMultipleParams) {\n        const settings = await this.context.fileManager.settings.getSettings();\n        if (!settings) {\n            throw new WebinyError(\"Missing File Manager Settings.\", \"FILE_MANAGER_ERROR\");\n        }\n        // Upload files to cloud storage.\n        const promises = [];\n        for (const item of params.files) {\n            promises.push(\n                this.storagePlugin.upload({\n                    ...item,\n                    settings\n                })\n            );\n        }\n        // Wait for all to resolve.\n        const uploadFileResponses = await Promise.all(promises);\n\n        const filesData = uploadFileResponses.map(response => response.file);\n\n        const { fileManager } = this.context;\n        // Save files in DB.\n        return fileManager.files.createFilesInBatch(filesData);\n    }\n\n    async delete(params: FileStorageDeleteParams) {\n        const { id, key } = params;\n        const { fileManager } = this.context;\n        // Delete file from cloud storage.\n        await this.storagePlugin.delete({\n            key\n        });\n        // Delete file from the DB.\n        return await fileManager.files.deleteFile(id);\n    }\n}\n"],"mappings":";;;;;;;;;;;;;AACA;;AAKA,MAAMA,iBAAiB,GAAG,0BAA1B;;AAuBO,MAAMC,WAAN,CAAkB;EAIrBC,WAAW,CAAC;IAAEC;EAAF,CAAD,EAAiC;IAAA;IAAA;IACxC,MAAMC,aAAa,GAAGD,OAAO,CAACE,OAAR,CACjBC,MADiB,CACiBN,iBADjB,EAEjBO,GAFiB,EAAtB;;IAGA,IAAI,CAACH,aAAL,EAAoB;MAChB,MAAM,IAAII,cAAJ,CACD,2BAA0BR,iBAAkB,IAD3C,EAEF,sBAFE,CAAN;IAIH;;IACD,KAAKI,aAAL,GAAqBA,aAArB;IACA,KAAKD,OAAL,GAAeA,OAAf;EACH;;EAEW,MAANM,MAAM,CAACC,MAAD,EAAmD;IAC3D,MAAMC,QAAQ,GAAG,MAAM,KAAKR,OAAL,CAAaS,WAAb,CAAyBD,QAAzB,CAAkCE,WAAlC,EAAvB;;IACA,IAAI,CAACF,QAAL,EAAe;MACX,MAAM,IAAIH,cAAJ,CAAgB,gCAAhB,EAAkD,oBAAlD,CAAN;IACH,CAJ0D,CAK3D;;;IACA,MAAM;MAAEM,IAAI,EAAEC;IAAR,IAAqB,MAAM,KAAKX,aAAL,CAAmBK,MAAnB,6DAC1BC,MAD0B;MAE7BC;IAF6B,GAAjC;IAKA,MAAM;MAAEC;IAAF,IAAkB,KAAKT,OAA7B,CAX2D,CAa3D;;IACA,OAAO,MAAMS,WAAW,CAACI,KAAZ,CAAkBC,UAAlB,6DACLF,QADK;MAETG,IAAI,EAAE;QACFC,OAAO,EAAEC,OAAO,CAACV,MAAM,CAACW,iBAAR;MADd,CAFG;MAKTC,IAAI,EAAEC,KAAK,CAACC,OAAN,CAAcd,MAAM,CAACY,IAArB,IAA6BZ,MAAM,CAACY,IAApC,GAA2C;IALxC,GAAb;EAOH;;EAEgB,MAAXG,WAAW,CAACf,MAAD,EAA0C;IACvD,MAAMC,QAAQ,GAAG,MAAM,KAAKR,OAAL,CAAaS,WAAb,CAAyBD,QAAzB,CAAkCE,WAAlC,EAAvB;;IACA,IAAI,CAACF,QAAL,EAAe;MACX,MAAM,IAAIH,cAAJ,CAAgB,gCAAhB,EAAkD,oBAAlD,CAAN;IACH,CAJsD,CAKvD;;;IACA,MAAMkB,QAAQ,GAAG,EAAjB;;IACA,KAAK,MAAMC,IAAX,IAAmBjB,MAAM,CAACM,KAA1B,EAAiC;MAC7BU,QAAQ,CAACE,IAAT,CACI,KAAKxB,aAAL,CAAmBK,MAAnB,6DACOkB,IADP;QAEIhB;MAFJ,GADJ;IAMH,CAdsD,CAevD;;;IACA,MAAMkB,mBAAmB,GAAG,MAAMC,OAAO,CAACC,GAAR,CAAYL,QAAZ,CAAlC;IAEA,MAAMM,SAAS,GAAGH,mBAAmB,CAACI,GAApB,CAAwBC,QAAQ,IAAIA,QAAQ,CAACpB,IAA7C,CAAlB;IAEA,MAAM;MAAEF;IAAF,IAAkB,KAAKT,OAA7B,CApBuD,CAqBvD;;IACA,OAAOS,WAAW,CAACI,KAAZ,CAAkBmB,kBAAlB,CAAqCH,SAArC,CAAP;EACH;;EAEW,MAANI,MAAM,CAAC1B,MAAD,EAAkC;IAC1C,MAAM;MAAE2B,EAAF;MAAMC;IAAN,IAAc5B,MAApB;IACA,MAAM;MAAEE;IAAF,IAAkB,KAAKT,OAA7B,CAF0C,CAG1C;;IACA,MAAM,KAAKC,aAAL,CAAmBgC,MAAnB,CAA0B;MAC5BE;IAD4B,CAA1B,CAAN,CAJ0C,CAO1C;;IACA,OAAO,MAAM1B,WAAW,CAACI,KAAZ,CAAkBuB,UAAlB,CAA6BF,EAA7B,CAAb;EACH;;AA3EoB"}

package/plugins/storage/index.d.ts

@@ -0,0 +1,4 @@
+import { FileManagerContext } from "../../types";
+import { ContextPlugin } from "@webiny/api";
+declare const fileStorageContextPlugin: ContextPlugin<FileManagerContext>;
+export default fileStorageContextPlugin;

package/plugins/storage/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _api = require("@webiny/api");
+
+var _FileStorage = require("./FileStorage");
+
+const fileStorageContextPlugin = new _api.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 = {};
+  }
+
+  context.fileManager.storage = new _FileStorage.FileStorage({
+    context
+  });
+});
+var _default = fileStorageContextPlugin;
+exports.default = _default;

package/plugins/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["fileStorageContextPlugin","ContextPlugin","context","fileManager","storage","FileStorage"],"sources":["index.ts"],"sourcesContent":["import { FileManagerContext } from \"~/types\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport { FileStorage } from \"./FileStorage\";\n\nconst fileStorageContextPlugin = new ContextPlugin<FileManagerContext>(async context => {\n    if (!context.fileManager) {\n        /**\n         * We need to define the fileManager initial property as empty object.\n         * When casting as FileManagerContext, typescript is complaining.\n         */\n        context.fileManager = {} as any;\n    }\n    context.fileManager.storage = new FileStorage({\n        context\n    });\n});\n\nexport default fileStorageContextPlugin;\n"],"mappings":";;;;;;;AACA;;AACA;;AAEA,MAAMA,wBAAwB,GAAG,IAAIC,kBAAJ,CAAsC,MAAMC,OAAN,IAAiB;EACpF,IAAI,CAACA,OAAO,CAACC,WAAb,EAA0B;IACtB;AACR;AACA;AACA;IACQD,OAAO,CAACC,WAAR,GAAsB,EAAtB;EACH;;EACDD,OAAO,CAACC,WAAR,CAAoBC,OAApB,GAA8B,IAAIC,wBAAJ,CAAgB;IAC1CH;EAD0C,CAAhB,CAA9B;AAGH,CAXgC,CAAjC;eAaeF,wB"}

package/types.d.ts

@@ -0,0 +1,361 @@
+import { I18NContext } from "@webiny/api-i18n/types";
+import { FileStorage } from "./plugins/storage/FileStorage";
+import { TenancyContext } from "@webiny/api-tenancy/types";
+import { SecurityContext, SecurityPermission } from "@webiny/api-security/types";
+import { Context } from "@webiny/api/types";
+export interface FileManagerContext extends Context, SecurityContext, TenancyContext, I18NContext {
+    fileManager: {
+        files: FilesCRUD;
+        settings: SettingsCRUD;
+        storage: FileStorage;
+        system: SystemCRUD;
+    };
+}
+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 | null;
+    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 | null;
+    totalCount: number;
+    hasMoreItems: boolean;
+}
+interface FilesCrudListTagsWhere {
+    tag?: string;
+    tag_contains?: string;
+    tag_in?: string[];
+    tag_not_startsWith?: string;
+    tag_startsWith?: 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 | null>;
+    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;
+    tenant: string;
+}
+export declare type SettingsCRUD = {
+    getSettings(): Promise<FileManagerSettings | null>;
+    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
+ */
+export interface FileManagerFilesStorageOperationsListResponseMeta {
+    hasMoreItems: boolean;
+    totalCount: number;
+    cursor: string | null;
+}
+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>;
+    /**
+     * Update the file data in the database.
+     */
+    update: (params: FileManagerFilesStorageOperationsUpdateParams) => Promise<File>;
+    /**
+     * 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

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

package/types.js.map

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

package/utils.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from "@webiny/plugins/types";
+declare type CallbackFallback = (args: any) => void | Promise<void>;
+export declare const executeCallbacks: <TCallbackFunction extends CallbackFallback = CallbackFallback>(plugins: Plugin[], hook: string, args: Parameters<TCallbackFunction>[0]) => Promise<void>;
+export {};

package/utils.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.executeCallbacks = void 0;
+
+const executeCallbacks = async (plugins, hook, args) => {
+  for (const plugin of plugins) {
+    if (typeof plugin[hook] === "function") {
+      await plugin[hook](args);
+    }
+  }
+};
+
+exports.executeCallbacks = executeCallbacks;

package/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["executeCallbacks","plugins","hook","args","plugin"],"sources":["utils.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins/types\";\n\ntype CallbackFallback = (args: any) => void | Promise<void>;\n\nexport const executeCallbacks = async <\n    TCallbackFunction extends CallbackFallback = CallbackFallback\n>(\n    plugins: Plugin[],\n    hook: string,\n    args: Parameters<TCallbackFunction>[0]\n) => {\n    for (const plugin of plugins) {\n        if (typeof plugin[hook] === \"function\") {\n            await plugin[hook](args);\n        }\n    }\n};\n"],"mappings":";;;;;;;AAIO,MAAMA,gBAAgB,GAAG,OAG5BC,OAH4B,EAI5BC,IAJ4B,EAK5BC,IAL4B,KAM3B;EACD,KAAK,MAAMC,MAAX,IAAqBH,OAArB,EAA8B;IAC1B,IAAI,OAAOG,MAAM,CAACF,IAAD,CAAb,KAAwB,UAA5B,EAAwC;MACpC,MAAME,MAAM,CAACF,IAAD,CAAN,CAAaC,IAAb,CAAN;IACH;EACJ;AACJ,CAZM"}