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

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 {
-    static readonly type = "api-file-manager-storage";
+export declare class FilePhysicalStoragePlugin<U extends FilePhysicalStoragePluginUploadParams = FilePhysicalStoragePluginUploadParams, D extends FilePhysicalStoragePluginDeleteParams = FilePhysicalStoragePluginDeleteParams> extends Plugin {
+    static readonly type: string;
     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/FilePhysicalStoragePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FilePhysicalStoragePlugin.ts"],"names":["FilePhysicalStoragePlugin","Plugin","constructor","params","_params","upload","WebinyError","delete"],"mappings":";;;;;;;;;;;AAAA;;AACA;;AAoBO,MAAMA,yBAAN,SAGGC,eAHH,CAGU;AAINC,EAAAA,WAAW,CAACC,MAAD,EAAgD;AAC9D;AAD8D;AAE9D,SAAKC,OAAL,GAAeD,MAAf;AACH;;AAEkB,QAANE,MAAM,CAACF,MAAD,EAA0B;AACzC,QAAI,CAAC,KAAKC,OAAL,CAAaC,MAAlB,EAA0B;AACtB,YAAM,IAAIC,cAAJ,CACD,qDADC,EAEF,qBAFE,CAAN;AAIH;;AACD,WAAO,KAAKF,OAAL,CAAaC,MAAb,CAAoBF,MAApB,CAAP;AACH;;AAEkB,QAANI,MAAM,CAACJ,MAAD,EAA0B;AACzC,QAAI,CAAC,KAAKC,OAAL,CAAaG,MAAlB,EAA0B;AACtB,YAAM,IAAID,cAAJ,CACD,qDADC,EAEF,qBAFE,CAAN;AAIH;;AACD,WAAO,KAAKF,OAAL,CAAaG,MAAb,CAAoBJ,MAApB,CAAP;AACH;;AA3BY;;;8BAHJH,yB,UAIsC,0B","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport WebinyError from \"@webiny/error\";\nimport { FileManagerSettings } from \"~/types\";\n\nexport interface FilePhysicalStoragePluginParams<\n    U extends FilePhysicalStoragePluginUploadParams,\n    D extends FilePhysicalStoragePluginDeleteParams\n> {\n    upload: (args: U) => Promise<any>;\n    delete: (args: D) => Promise<void>;\n}\n\nexport interface FilePhysicalStoragePluginUploadParams {\n    settings: FileManagerSettings;\n    buffer: Buffer;\n}\n\nexport interface FilePhysicalStoragePluginDeleteParams {\n    key: string;\n}\n\nexport class FilePhysicalStoragePlugin<\n    U extends FilePhysicalStoragePluginUploadParams = FilePhysicalStoragePluginUploadParams,\n    D extends FilePhysicalStoragePluginDeleteParams = FilePhysicalStoragePluginDeleteParams\n> extends Plugin {\n    public static override readonly type: string = \"api-file-manager-storage\";\n    private readonly _params: FilePhysicalStoragePluginParams<U, D>;\n\n    public constructor(params: FilePhysicalStoragePluginParams<U, D>) {\n        super();\n        this._params = params;\n    }\n\n    public async upload(params: U): Promise<any> {\n        if (!this._params.upload) {\n            throw new WebinyError(\n                `You must define the \"upload\" method of this plugin.`,\n                \"UPLOAD_METHOD_ERROR\"\n            );\n        }\n        return this._params.upload(params);\n    }\n\n    public async delete(params: D): Promise<any> {\n        if (!this._params.delete) {\n            throw new WebinyError(\n                `You must define the \"delete\" method of this plugin.`,\n                \"DELETE_METHOD_ERROR\"\n            );\n        }\n        return this._params.delete(params);\n    }\n}\n"]}

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>;
@@ -118,9 +118,9 @@ export interface Params {
     afterDelete?: (params: AfterDeleteParams) => Promise<void>;
 }
 export declare class FilePlugin extends Plugin {
-    static readonly type = "fm.file";
+    static readonly type: string;
     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,13 +49,19 @@ 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") {
+    const cb = this._params[callback];
+
+    if (typeof cb !== "function") {
       return;
     }
 
-    await this._params[callback](params);
+    await cb(params);
   }
 
 }

package/plugins/definitions/FilePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FilePlugin.ts"],"names":["FilePlugin","Plugin","constructor","params","_params","beforeCreate","_execute","afterCreate","beforeUpdate","afterUpdate","beforeBatchCreate","afterBatchCreate","beforeDelete","afterDelete","callback","cb"],"mappings":";;;;;;;;;;;AAAA;;AA2HO,MAAMA,UAAN,SAAyBC,eAAzB,CAAgC;AAI5BC,EAAAA,WAAW,CAACC,MAAD,EAA4B;AAC1C;AAD0C;AAE1C,SAAKC,OAAL,GAAeD,MAAM,IAAK,EAA1B;AACH;;AAEwB,QAAZE,YAAY,CAACF,MAAD,EAA4C;AACjE,UAAM,KAAKG,QAAL,CAAc,cAAd,EAA8BH,MAA9B,CAAN;AACH;;AAEuB,QAAXI,WAAW,CAACJ,MAAD,EAA2C;AAC/D,UAAM,KAAKG,QAAL,CAAc,aAAd,EAA6BH,MAA7B,CAAN;AACH;;AAEwB,QAAZK,YAAY,CAACL,MAAD,EAA4C;AACjE,UAAM,KAAKG,QAAL,CAAc,cAAd,EAA8BH,MAA9B,CAAN;AACH;;AAEuB,QAAXM,WAAW,CAACN,MAAD,EAA2C;AAC/D,UAAM,KAAKG,QAAL,CAAc,aAAd,EAA6BH,MAA7B,CAAN;AACH;;AAE6B,QAAjBO,iBAAiB,CAACP,MAAD,EAAiD;AAC3E,UAAM,KAAKG,QAAL,CAAc,mBAAd,EAAmCH,MAAnC,CAAN;AACH;;AAE4B,QAAhBQ,gBAAgB,CAACR,MAAD,EAAgD;AACzE,UAAM,KAAKG,QAAL,CAAc,kBAAd,EAAkCH,MAAlC,CAAN;AACH;;AAEwB,QAAZS,YAAY,CAACT,MAAD,EAA4C;AACjE,UAAM,KAAKG,QAAL,CAAc,cAAd,EAA8BH,MAA9B,CAAN;AACH;;AAEuB,QAAXU,WAAW,CAACV,MAAD,EAA2C;AAC/D,UAAM,KAAKG,QAAL,CAAc,aAAd,EAA6BH,MAA7B,CAAN;AACH;AACD;AACJ;AACA;;;AAC0B,QAARG,QAAQ,CAACQ,QAAD,EAAmCX,MAAnC,EAA+D;AACjF,UAAMY,EAAE,GAAG,KAAKX,OAAL,CAAaU,QAAb,CAAX;;AACA,QAAI,OAAOC,EAAP,KAAc,UAAlB,EAA8B;AAC1B;AACH;;AACD,UAAMA,EAAE,CAACZ,MAAD,CAAR;AACH;;AAjDkC;;;8BAA1BH,U,UACsC,S","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { File, FileManagerContext } from \"~/types\";\n\n/**\n * Parameters for beforeCreate lifecycle.\n */\nexport interface BeforeCreateParams {\n    context: FileManagerContext;\n    /**\n     * Data to be inserted into the storage.\n     */\n    data: File;\n}\n/**\n * Parameters for afterCreate lifecycle.\n */\nexport interface AfterCreateParams {\n    context: FileManagerContext;\n    /**\n     * Data that was inserted into the storage.\n     */\n    data: File;\n    /**\n     * Result of the storage operations create method.\n     * Possibly changed something on the \"data\".\n     */\n    file: File;\n}\n/**\n * Parameters for beforeUpdate lifecycle.\n */\nexport interface BeforeUpdateParams {\n    context: FileManagerContext;\n    /**\n     * Original file from the storage.\n     */\n    original: File;\n    /**\n     * Data to be updated to the storage.\n     */\n    data: File;\n}\n/**\n * Parameters for afterUpdate lifecycle.\n */\nexport interface AfterUpdateParams {\n    context: FileManagerContext;\n    /**\n     * Original file from the storage.\n     */\n    original: File;\n    /**\n     * Data that was updated in the storage.\n     */\n    data: File;\n    /**\n     * Result of the storage operations update method.\n     * Possibly changed something on the \"data\".\n     */\n    file: File;\n}\n/**\n * Parameters for beforeBatchCreate lifecycle.\n */\nexport interface BeforeBatchCreateParams {\n    context: FileManagerContext;\n    /**\n     * Files to be inserted into the storage.\n     */\n    data: File[];\n}\n\n/**\n * Parameters for afterBatchCreate lifecycle.\n */\nexport interface AfterBatchCreateParams {\n    context: FileManagerContext;\n    /**\n     * Files that were inserted into the storage.\n     */\n    data: File[];\n    /**\n     * Results of the insert.\n     */\n    files: File[];\n}\n/**\n * Parameters for beforeDelete lifecycle.\n */\nexport interface BeforeDeleteParams {\n    context: FileManagerContext;\n    /**\n     * File to be deleted from the storage.\n     */\n    file: File;\n}\n/**\n * Parameters for afterDelete lifecycle.\n */\nexport interface AfterDeleteParams {\n    context: FileManagerContext;\n    /**\n     * File that was deleted from the storage.\n     */\n    file: File;\n}\n\n/**\n * Definition for the constructor parameters of the FilePlugin.\n *\n * @category FilePlugin\n */\nexport interface FilePluginParams {\n    beforeCreate?: (params: BeforeCreateParams) => Promise<void>;\n    afterCreate?: (params: AfterCreateParams) => Promise<void>;\n    beforeUpdate?: (params: BeforeUpdateParams) => Promise<void>;\n    afterUpdate?: (params: AfterUpdateParams) => Promise<void>;\n    beforeBatchCreate?: (params: BeforeBatchCreateParams) => Promise<void>;\n    afterBatchCreate?: (params: AfterBatchCreateParams) => Promise<void>;\n    beforeDelete?: (params: BeforeDeleteParams) => Promise<void>;\n    afterDelete?: (params: AfterDeleteParams) => Promise<void>;\n}\n\nexport class FilePlugin extends Plugin {\n    public static override readonly type: string = \"fm.file\";\n    private readonly _params: FilePluginParams;\n\n    public constructor(params?: FilePluginParams) {\n        super();\n        this._params = params || ({} as any);\n    }\n\n    public async beforeCreate(params: BeforeCreateParams): Promise<void> {\n        await this._execute(\"beforeCreate\", params);\n    }\n\n    public async afterCreate(params: AfterCreateParams): Promise<void> {\n        await this._execute(\"afterCreate\", params);\n    }\n\n    public async beforeUpdate(params: BeforeUpdateParams): Promise<void> {\n        await this._execute(\"beforeUpdate\", params);\n    }\n\n    public async afterUpdate(params: AfterUpdateParams): Promise<void> {\n        await this._execute(\"afterUpdate\", params);\n    }\n\n    public async beforeBatchCreate(params: BeforeBatchCreateParams): Promise<void> {\n        await this._execute(\"beforeBatchCreate\", params);\n    }\n\n    public async afterBatchCreate(params: AfterBatchCreateParams): Promise<void> {\n        await this._execute(\"afterBatchCreate\", params);\n    }\n\n    public async beforeDelete(params: BeforeDeleteParams): Promise<void> {\n        await this._execute(\"beforeDelete\", params);\n    }\n\n    public async afterDelete(params: AfterDeleteParams): Promise<void> {\n        await this._execute(\"afterDelete\", params);\n    }\n    /**\n     * Keep any here because it can be a number of params. Method is internal so no need to complicate the code.\n     */\n    private async _execute(callback: keyof FilePluginParams, params: any): Promise<void> {\n        const cb = this._params[callback];\n        if (typeof cb !== \"function\") {\n            return;\n        }\n        await cb(params);\n    }\n}\n"]}

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";
+    static readonly type: string;
     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/FileStorageTransformPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FileStorageTransformPlugin.ts"],"names":["FileStorageTransformPlugin","Plugin","constructor","params","_params","toStorage","file","fromStorage"],"mappings":";;;;;;;;;;;AAAA;;AAwBO,MAAMA,0BAAN,SAAyCC,eAAzC,CAAgD;AAI5CC,EAAAA,WAAW,CAACC,MAAD,EAA2C;AACzD;AADyD;AAGzD,SAAKC,OAAL,GAAeD,MAAf;AACH;AAED;AACJ;AACA;AACA;;;AAC0B,QAATE,SAAS,CAClBF,MADkB,EAEiB;AACnC,QAAI,CAAC,KAAKC,OAAL,CAAaC,SAAlB,EAA6B;AACzB,aAAOF,MAAM,CAACG,IAAd;AACH;;AACD,WAAO,KAAKF,OAAL,CAAaC,SAAb,CAAuBF,MAAvB,CAAP;AACH;AACD;AACJ;AACA;AACA;AACA;;;AAC4B,QAAXI,WAAW,CACpBJ,MADoB,EAEe;AACnC,QAAI,CAAC,KAAKC,OAAL,CAAaG,WAAlB,EAA+B;AAC3B,aAAOJ,MAAM,CAACG,IAAd;AACH;;AACD,WAAO,KAAKF,OAAL,CAAaG,WAAb,CAAyBJ,MAAzB,CAAP;AACH;;AAlCkD;;;8BAA1CH,0B,UACsC,4B","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { File } from \"~/types\";\n\nexport interface FileStorageTransformPluginToParams {\n    /**\n     * File that is being sent to the storage operations method.\n     */\n    file: File & Record<string, any>;\n}\n\nexport interface FileStorageTransformPluginFromParams {\n    /**\n     * File that was fetched from the storage operations method.\n     */\n    file: File & Record<string, any>;\n}\n\nexport interface FileStorageTransformPluginParams {\n    toStorage?: (params: FileStorageTransformPluginToParams) => Promise<File & Record<string, any>>;\n    fromStorage?: (\n        params: FileStorageTransformPluginFromParams\n    ) => Promise<File & Record<string, any>>;\n}\n\nexport class FileStorageTransformPlugin extends Plugin {\n    public static override readonly type: string = \"fm.files.storage.transform\";\n    private readonly _params: FileStorageTransformPluginParams;\n\n    public constructor(params: FileStorageTransformPluginParams) {\n        super();\n\n        this._params = params;\n    }\n\n    /**\n     * Transform the file value into something that can be stored.\n     * Be aware that you must return the whole file object.\n     */\n    public async toStorage(\n        params: FileStorageTransformPluginToParams\n    ): Promise<File & Record<string, any>> {\n        if (!this._params.toStorage) {\n            return params.file;\n        }\n        return this._params.toStorage(params);\n    }\n    /**\n     * Transform the file value from the storage type to one required by our system.\n     * Be aware that you must return the whole file object.\n     * This method MUST reverse what ever toStorage method changed on the file object.\n     */\n    public async fromStorage(\n        params: FileStorageTransformPluginFromParams\n    ): Promise<File & Record<string, any>> {\n        if (!this._params.fromStorage) {\n            return params.file;\n        }\n        return this._params.fromStorage(params);\n    }\n}\n"]}

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>;
+    static readonly type: string;
+    abstract provide(params: FilesStorageOperationsProviderPluginParams): Promise<FileManagerFilesStorageOperations>;
 }

package/plugins/definitions/FilesStorageOperationsProviderPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FilesStorageOperationsProviderPlugin.ts"],"names":["FilesStorageOperationsProviderPlugin","Plugin"],"mappings":";;;;;;;;;;;AAAA;;AAOO,MAAeA,oCAAf,SAA4DC,eAA5D,CAAmE;;;8BAApDD,oC,UAC6B,oC","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { FileManagerContext, FileManagerFilesStorageOperations } from \"~/types\";\n\nexport interface FilesStorageOperationsProviderPluginParams {\n    context: FileManagerContext;\n}\n\nexport abstract class FilesStorageOperationsProviderPlugin extends Plugin {\n    public static override readonly type: string = \"fm.storageOperationsProvider.files\";\n\n    public abstract provide(\n        params: FilesStorageOperationsProviderPluginParams\n    ): Promise<FileManagerFilesStorageOperations>;\n}\n"]}

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";
+    static readonly type: string;
     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/InstallationPlugin.js

@@ -27,11 +27,13 @@ class InstallationPlugin extends _plugins.Plugin {
   }
 
   async _execute(callback, params) {
-    if (typeof this._config[callback] !== "function") {
+    const cb = this._config[callback];
+
+    if (!cb) {
       return;
     }
 
-    return this._config[callback](params);
+    return cb(params);
   }
 
 }

package/plugins/definitions/InstallationPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["InstallationPlugin.ts"],"names":["InstallationPlugin","Plugin","constructor","config","_config","beforeInstall","params","_execute","afterInstall","callback","cb"],"mappings":";;;;;;;;;;;AACA;;AAYO,MAAeA,kBAAf,SAA0CC,eAA1C,CAAiD;AAIpDC,EAAAA,WAAW,CAACC,MAAD,EAA6C;AACpD;AADoD;AAEpD,SAAKC,OAAL,GAAeD,MAAM,IAAI,EAAzB;AACH;;AAEyB,QAAbE,aAAa,CAACC,MAAD,EAAkD;AACxE,WAAO,KAAKC,QAAL,CAAc,eAAd,EAA+BD,MAA/B,CAAP;AACH;;AAEwB,QAAZE,YAAY,CAACF,MAAD,EAAkD;AACvE,WAAO,KAAKC,QAAL,CAAc,cAAd,EAA8BD,MAA9B,CAAP;AACH;;AAEqB,QAARC,QAAQ,CAClBE,QADkB,EAElBH,MAFkB,EAGL;AACb,UAAMI,EAAE,GAAG,KAAKN,OAAL,CAAaK,QAAb,CAAX;;AACA,QAAI,CAACC,EAAL,EAAS;AACL;AACH;;AACD,WAAOA,EAAE,CAACJ,MAAD,CAAT;AACH;;AA1BmD;;;8BAAlCN,kB,UAC6B,Y","sourcesContent":["import { FileManagerContext } from \"~/types\";\nimport { Plugin } from \"@webiny/plugins\";\n\nexport interface InstallationPluginParams {\n    context: FileManagerContext;\n}\nexport type CallbackFunction<TParams> = (params: TParams) => Promise<void>;\n\ninterface InstallationPluginConfig {\n    beforeInstall?: CallbackFunction<InstallationPluginParams>;\n    afterInstall?: CallbackFunction<InstallationPluginParams>;\n}\n\nexport abstract class InstallationPlugin extends Plugin {\n    public static override readonly type: string = \"fm.install\";\n    private readonly _config: Partial<InstallationPluginConfig>;\n\n    constructor(config?: Partial<InstallationPluginConfig>) {\n        super();\n        this._config = config || {};\n    }\n\n    public async beforeInstall(params: InstallationPluginParams): Promise<void> {\n        return this._execute(\"beforeInstall\", params);\n    }\n\n    public async afterInstall(params: InstallationPluginParams): Promise<void> {\n        return this._execute(\"afterInstall\", params);\n    }\n\n    private async _execute(\n        callback: keyof InstallationPluginConfig,\n        params: InstallationPluginParams\n    ): Promise<void> {\n        const cb = this._config[callback];\n        if (!cb) {\n            return;\n        }\n        return cb(params);\n    }\n}\n"]}

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>;
+    static readonly type: string;
+    abstract provide(params: SettingsStorageOperationsProviderPluginParams): Promise<FileManagerSettingsStorageOperations>;
 }

package/plugins/definitions/SettingsStorageOperationsProviderPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["SettingsStorageOperationsProviderPlugin.ts"],"names":["SettingsStorageOperationsProviderPlugin","Plugin"],"mappings":";;;;;;;;;;;AAAA;;AAOO,MAAeA,uCAAf,SAA+DC,eAA/D,CAAsE;;;8BAAvDD,uC,UAC6B,uC","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { FileManagerContext, FileManagerSettingsStorageOperations } from \"~/types\";\n\nexport interface SettingsStorageOperationsProviderPluginParams {\n    context: FileManagerContext;\n}\n\nexport abstract class SettingsStorageOperationsProviderPlugin extends Plugin {\n    public static override readonly type: string = \"fm.storageOperationsProvider.settings\";\n\n    public abstract provide(\n        params: SettingsStorageOperationsProviderPluginParams\n    ): Promise<FileManagerSettingsStorageOperations>;\n}\n"]}

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>;
+    static readonly type: string;
+    abstract provide(params: SystemStorageOperationsProviderPluginParams): Promise<FileManagerSystemStorageOperations>;
 }

package/plugins/definitions/SystemStorageOperationsProviderPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["SystemStorageOperationsProviderPlugin.ts"],"names":["SystemStorageOperationsProviderPlugin","Plugin"],"mappings":";;;;;;;;;;;AAAA;;AAOO,MAAeA,qCAAf,SAA6DC,eAA7D,CAAoE;;;8BAArDD,qC,UAC6B,qC","sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { FileManagerContext, FileManagerSystemStorageOperations } from \"~/types\";\n\nexport interface SystemStorageOperationsProviderPluginParams {\n    context: FileManagerContext;\n}\n\nexport abstract class SystemStorageOperationsProviderPlugin extends Plugin {\n    public static override readonly type: string = \"fm.storageOperationsProvider.system\";\n\n    public abstract provide(\n        params: SystemStorageOperationsProviderPluginParams\n    ): Promise<FileManagerSystemStorageOperations>;\n}\n"]}

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 {
@@ -60,6 +65,7 @@ const plugin = {
                 code: String
                 message: String
                 data: JSON
+                stack: String
             }
 
             type FileListResponse {
@@ -99,11 +105,13 @@ const plugin = {
             type FileManagerSettings {
                 uploadMinFileSize: Number
                 uploadMaxFileSize: Number
+                srcPrefix: String
             }
 
             input FileManagerSettingsInput {
                 uploadMinFileSize: Number
                 uploadMaxFileSize: Number
+                srcPrefix: String
             }
 
             type FileManagerSettingsResponse {
@@ -178,7 +186,7 @@ const plugin = {
       File: {
         async src(file, _, context) {
           const settings = await context.fileManager.settings.getSettings();
-          return settings.srcPrefix + file.key;
+          return ((settings === null || settings === void 0 ? void 0 : settings.srcPrefix) || "") + file.key;
         }
 
       },

package/plugins/graphql.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["graphql.ts"],"names":["emptyResolver","resolve","fn","Response","e","ErrorResponse","plugin","type","schema","typeDefs","resolvers","File","src","file","_","context","settings","fileManager","getSettings","srcPrefix","key","Query","Mutation","FmQuery","getFile","args","files","id","listFiles","data","meta","ListResponse","listTags","error","version","__","i18nContent","tenancy","getCurrentTenant","getCurrentLocale","system","getVersion","FmMutation","createFile","updateFile","createFiles","createFilesInBatch","deleteFile","storage","delete","install","upgrade","updateSettings"],"mappings":";;;;;;;AAAA;;AAIA,MAAMA,aAAa,GAAG,OAAO,EAAP,CAAtB;AAEA;AACA;AACA;AACA;;;AAKA,MAAMC,OAAO,GAAG,MAAOC,EAAP,IAA+B;AAC3C,MAAI;AACA,WAAO,IAAIC,wBAAJ,CAAa,MAAMD,EAAE,EAArB,CAAP;AACH,GAFD,CAEE,OAAOE,CAAP,EAAU;AACR,WAAO,IAAIC,6BAAJ,CAAkBD,CAAlB,CAAP;AACH;AACJ,CAND;;AAQA,MAAME,MAA+C,GAAG;AACpDC,EAAAA,IAAI,EAAE,gBAD8C;AAEpDC,EAAAA,MAAM,EAAE;AACJC,IAAAA,QAAQ;AAAE;AAAe;AACjC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SA3JY;AA4JJC,IAAAA,SAAS,EAAE;AACPC,MAAAA,IAAI,EAAE;AACF,cAAMC,GAAN,CAAUC,IAAV,EAAgBC,CAAhB,EAAmBC,OAAnB,EAAgD;AAC5C,gBAAMC,QAAQ,GAAG,MAAMD,OAAO,CAACE,WAAR,CAAoBD,QAApB,CAA6BE,WAA7B,EAAvB;AACA,iBAAO,CAAC,CAAAF,QAAQ,SAAR,IAAAA,QAAQ,WAAR,YAAAA,QAAQ,CAAEG,SAAV,KAAuB,EAAxB,IAA8BN,IAAI,CAACO,GAA1C;AACH;;AAJC,OADC;AAOPC,MAAAA,KAAK,EAAE;AACHJ,QAAAA,WAAW,EAAEjB;AADV,OAPA;AAUPsB,MAAAA,QAAQ,EAAE;AACNL,QAAAA,WAAW,EAAEjB;AADP,OAVH;AAaPuB,MAAAA,OAAO,EAAE;AACLC,QAAAA,OAAO,CAACV,CAAD,EAAIW,IAAJ,EAAeV,OAAf,EAAwB;AAC3B,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BF,OAA1B,CAAkCC,IAAI,CAACE,EAAvC,CAAP,CAAd;AACH,SAHI;;AAIL,cAAMC,SAAN,CAAgBd,CAAhB,EAAmBW,IAAnB,EAAwCV,OAAxC,EAAiD;AAC7C,cAAI;AACA,kBAAM,CAACc,IAAD,EAAOC,IAAP,IAAe,MAAMf,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BE,SAA1B,CAAoCH,IAApC,CAA3B;AACA,mBAAO,IAAIM,4BAAJ,CAAiBF,IAAjB,EAAuBC,IAAvB,CAAP;AACH,WAHD,CAGE,OAAO1B,CAAP,EAAU;AACR,mBAAO,IAAIC,6BAAJ,CAAkBD,CAAlB,CAAP;AACH;AACJ,SAXI;;AAYL,cAAM4B,QAAN,CAAelB,CAAf,EAAkBW,IAAlB,EAA6BV,OAA7B,EAAsC;AAClC,cAAI;AACA,mBAAO,MAAMA,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BM,QAA1B,CAAmCP,IAAI,IAAI,EAA3C,CAAb;AACH,WAFD,CAEE,OAAOQ,KAAP,EAAc;AACZ,mBAAO,IAAI5B,6BAAJ,CAAkB4B,KAAlB,CAAP;AACH;AACJ,SAlBI;;AAmBL,cAAMC,OAAN,CAAcpB,CAAd,EAAiBqB,EAAjB,EAAqBpB,OAArB,EAA8B;AAC1B,gBAAM;AAAEqB,YAAAA,WAAF;AAAeC,YAAAA,OAAf;AAAwBpB,YAAAA;AAAxB,cAAwCF,OAA9C;;AACA,cAAI,CAACsB,OAAO,CAACC,gBAAR,EAAD,IAA+B,CAACF,WAAW,CAACG,gBAAZ,EAApC,EAAoE;AAChE,mBAAO,IAAP;AACH;;AAED,iBAAO,MAAMtB,WAAW,CAACuB,MAAZ,CAAmBC,UAAnB,EAAb;AACH,SA1BI;;AA2BL,cAAMvB,WAAN,CAAkBJ,CAAlB,EAAqBqB,EAArB,EAAyBpB,OAAzB,EAAkC;AAC9B,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBD,QAApB,CAA6BE,WAA7B,EAAP,CAAd;AACH;;AA7BI,OAbF;AA4CPwB,MAAAA,UAAU,EAAE;AACR,cAAMC,UAAN,CAAiB7B,CAAjB,EAAoBW,IAApB,EAA+BV,OAA/B,EAAwC;AACpC,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BiB,UAA1B,CAAqClB,IAAI,CAACI,IAA1C,CAAP,CAAd;AACH,SAHO;;AAIR,cAAMe,UAAN,CAAiB9B,CAAjB,EAAoBW,IAApB,EAA+BV,OAA/B,EAAwC;AACpC,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BkB,UAA1B,CAAqCnB,IAAI,CAACE,EAA1C,EAA8CF,IAAI,CAACI,IAAnD,CAAP,CAAd;AACH,SANO;;AAOR,cAAMgB,WAAN,CAAkB/B,CAAlB,EAAqBW,IAArB,EAAgCV,OAAhC,EAAyC;AACrC,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BoB,kBAA1B,CAA6CrB,IAAI,CAACI,IAAlD,CAAP,CAAd;AACH,SATO;;AAUR,cAAMkB,UAAN,CAAiBjC,CAAjB,EAAoBW,IAApB,EAA+BV,OAA/B,EAAwC;AACpC,iBAAOd,OAAO,CAAC,YAAY;AACvB,kBAAMY,IAAI,GAAG,MAAME,OAAO,CAACE,WAAR,CAAoBS,KAApB,CAA0BF,OAA1B,CAAkCC,IAAI,CAACE,EAAvC,CAAnB;AACA,mBAAO,MAAMZ,OAAO,CAACE,WAAR,CAAoB+B,OAApB,CAA4BC,MAA5B,CAAmC;AAC5CtB,cAAAA,EAAE,EAAEd,IAAI,CAACc,EADmC;AAE5CP,cAAAA,GAAG,EAAEP,IAAI,CAACO;AAFkC,aAAnC,CAAb;AAIH,WANa,CAAd;AAOH,SAlBO;;AAmBR,cAAM8B,OAAN,CAAcpC,CAAd,EAAiBW,IAAjB,EAA4BV,OAA5B,EAAqC;AACjC,iBAAOd,OAAO,CAAC,MACXc,OAAO,CAACE,WAAR,CAAoBuB,MAApB,CAA2BU,OAA3B,CAAmC;AAAE/B,YAAAA,SAAS,EAAEM,IAAI,CAACN;AAAlB,WAAnC,CADU,CAAd;AAGH,SAvBO;;AAwBR,cAAMgC,OAAN,CAAcrC,CAAd,EAAiBW,IAAjB,EAA4BV,OAA5B,EAAqC;AACjC,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBuB,MAApB,CAA2BW,OAA3B,CAAmC1B,IAAI,CAACS,OAAxC,CAAP,CAAd;AACH,SA1BO;;AA2BR,cAAMkB,cAAN,CAAqBtC,CAArB,EAAwBW,IAAxB,EAAmCV,OAAnC,EAA4C;AACxC,iBAAOd,OAAO,CAAC,MAAMc,OAAO,CAACE,WAAR,CAAoBD,QAApB,CAA6BoC,cAA7B,CAA4C3B,IAAI,CAACI,IAAjD,CAAP,CAAd;AACH;;AA7BO;AA5CL;AA5JP;AAF4C,CAAxD;eA6OevB,M","sourcesContent":["import { Response, ErrorResponse, ListResponse } from \"@webiny/handler-graphql\";\nimport { FileManagerContext, FilesListOpts } from \"~/types\";\nimport { GraphQLSchemaPlugin } from \"@webiny/handler-graphql/types\";\n\nconst emptyResolver = () => ({});\n\n/**\n * Use any because it really can be any.\n * TODO @ts-refactor maybe use generics at some point?\n */\ninterface ResolveCallable {\n    (): Promise<any>;\n}\n\nconst resolve = async (fn: ResolveCallable) => {\n    try {\n        return new Response(await fn());\n    } catch (e) {\n        return new ErrorResponse(e);\n    }\n};\n\nconst plugin: GraphQLSchemaPlugin<FileManagerContext> = {\n    type: \"graphql-schema\",\n    schema: {\n        typeDefs: /* GraphQL */ `\n            type FmCreatedBy {\n                id: ID\n                displayName: String\n            }\n\n            input FileInput {\n                key: String\n                name: String\n                size: Int\n                type: String\n                tags: [String]\n                meta: JSON\n            }\n\n            type UploadFileResponseDataFile {\n                name: String\n                type: String\n                size: Int\n                key: String\n            }\n\n            type UploadFileResponseData {\n                # Contains data that is necessary for initiating a file upload.\n                data: JSON\n                file: UploadFileResponseDataFile\n            }\n\n            type FileListMeta {\n                cursor: String\n                totalCount: Int\n                hasMoreItems: Boolean\n            }\n\n            type FileError {\n                code: String\n                message: String\n                data: JSON\n                stack: String\n            }\n\n            type FileListResponse {\n                data: [File]\n                meta: FileListMeta\n                error: FileError\n            }\n\n            type FileResponse {\n                data: File\n                error: FileError\n            }\n\n            type CreateFilesResponse {\n                data: [File]!\n                error: FileError\n            }\n\n            type File {\n                id: ID\n                key: String\n                name: String\n                size: Int\n                type: String\n                src: String\n                tags: [String]\n                meta: JSON\n                createdOn: DateTime\n                createdBy: FmCreatedBy\n            }\n\n            type FileManagerBooleanResponse {\n                data: Boolean\n                error: FileError\n            }\n\n            type FileManagerSettings {\n                uploadMinFileSize: Number\n                uploadMaxFileSize: Number\n                srcPrefix: String\n            }\n\n            input FileManagerSettingsInput {\n                uploadMinFileSize: Number\n                uploadMaxFileSize: Number\n                srcPrefix: String\n            }\n\n            type FileManagerSettingsResponse {\n                data: FileManagerSettings\n                error: FileError\n            }\n\n            input FileWhereInput {\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: [ID!]\n                id: ID\n            }\n\n            type FmQuery {\n                getFile(id: ID, where: JSON, sort: String): FileResponse\n\n                listFiles(\n                    limit: Int\n                    after: String\n                    types: [String]\n                    tags: [String]\n                    ids: [ID]\n                    search: String\n                    where: FileWhereInput\n                ): FileListResponse\n\n                listTags: [String]\n\n                # Get installed version\n                version: String\n\n                getSettings: FileManagerSettingsResponse\n            }\n\n            type FilesDeleteResponse {\n                data: Boolean\n                error: FileError\n            }\n\n            type FmMutation {\n                createFile(data: FileInput!): FileResponse\n                createFiles(data: [FileInput]!): CreateFilesResponse\n                updateFile(id: ID!, data: FileInput!): FileResponse\n                deleteFile(id: ID!): FilesDeleteResponse\n\n                # Install File manager\n                install(srcPrefix: String): FileManagerBooleanResponse\n\n                upgrade(version: String!): FileManagerBooleanResponse\n\n                updateSettings(data: FileManagerSettingsInput): FileManagerSettingsResponse\n            }\n\n            input FilesInstallInput {\n                srcPrefix: String!\n            }\n\n            extend type Query {\n                fileManager: FmQuery\n            }\n\n            extend type Mutation {\n                fileManager: FmMutation\n            }\n        `,\n        resolvers: {\n            File: {\n                async src(file, _, context: FileManagerContext) {\n                    const settings = await context.fileManager.settings.getSettings();\n                    return (settings?.srcPrefix || \"\") + file.key;\n                }\n            },\n            Query: {\n                fileManager: emptyResolver\n            },\n            Mutation: {\n                fileManager: emptyResolver\n            },\n            FmQuery: {\n                getFile(_, args: any, context) {\n                    return resolve(() => context.fileManager.files.getFile(args.id));\n                },\n                async listFiles(_, args: FilesListOpts, context) {\n                    try {\n                        const [data, meta] = await context.fileManager.files.listFiles(args);\n                        return new ListResponse(data, meta);\n                    } catch (e) {\n                        return new ErrorResponse(e);\n                    }\n                },\n                async listTags(_, args: any, context) {\n                    try {\n                        return await context.fileManager.files.listTags(args || {});\n                    } catch (error) {\n                        return new ErrorResponse(error);\n                    }\n                },\n                async version(_, __, context) {\n                    const { i18nContent, tenancy, fileManager } = context;\n                    if (!tenancy.getCurrentTenant() || !i18nContent.getCurrentLocale()) {\n                        return null;\n                    }\n\n                    return await fileManager.system.getVersion();\n                },\n                async getSettings(_, __, context) {\n                    return resolve(() => context.fileManager.settings.getSettings());\n                }\n            },\n            FmMutation: {\n                async createFile(_, args: any, context) {\n                    return resolve(() => context.fileManager.files.createFile(args.data));\n                },\n                async updateFile(_, args: any, context) {\n                    return resolve(() => context.fileManager.files.updateFile(args.id, args.data));\n                },\n                async createFiles(_, args: any, context) {\n                    return resolve(() => context.fileManager.files.createFilesInBatch(args.data));\n                },\n                async deleteFile(_, args: any, context) {\n                    return resolve(async () => {\n                        const file = await context.fileManager.files.getFile(args.id);\n                        return await context.fileManager.storage.delete({\n                            id: file.id,\n                            key: file.key\n                        });\n                    });\n                },\n                async install(_, args: any, context) {\n                    return resolve(() =>\n                        context.fileManager.system.install({ srcPrefix: args.srcPrefix })\n                    );\n                },\n                async upgrade(_, args: any, context) {\n                    return resolve(() => context.fileManager.system.upgrade(args.version));\n                },\n                async updateSettings(_, args: any, context) {\n                    return resolve(() => context.fileManager.settings.updateSettings(args.data));\n                }\n            }\n        }\n    }\n};\n\nexport default plugin;\n"]}

package/plugins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"names":["systemCRUD","settingsCRUD","filesCRUD","storage","graphql"],"mappings":";;;;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AACA;;eAEe,MAAM,CACjBA,eADiB,EAEjBC,iBAFiB,EAGjBC,cAHiB,EAIjBC,gBAJiB,EAKjBC,gBALiB,EAMjB,0BANiB,C","sourcesContent":["import graphql from \"./graphql\";\nimport filesCRUD from \"./crud/files.crud\";\nimport fileValidationPlugin from \"./crud/files/validation\";\nimport settingsCRUD from \"./crud/settings.crud\";\nimport systemCRUD from \"./crud/system.crud\";\nimport storage from \"./storage\";\n\nexport default () => [\n    systemCRUD,\n    settingsCRUD,\n    filesCRUD,\n    storage,\n    graphql,\n    fileValidationPlugin()\n];\n"]}

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

@@ -23,21 +23,27 @@ class FileStorage {
   }) {
     (0, _defineProperty2.default)(this, "storagePlugin", void 0);
     (0, _defineProperty2.default)(this, "context", void 0);
-    this.storagePlugin = context.plugins.byType(storagePluginType).pop();
+    const storagePlugin = context.plugins.byType(storagePluginType).pop();
 
-    if (!this.storagePlugin) {
+    if (!storagePlugin) {
       throw new _error.default(`Missing plugin of type "${storagePluginType}".`, "STORAGE_PLUGIN_ERROR");
     }
 
+    this.storagePlugin = storagePlugin;
     this.context = context;
   }
 
-  async upload(args) {
-    const settings = await this.context.fileManager.settings.getSettings(); // Add file to cloud storage.
+  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(_objectSpread(_objectSpread({}, args), {}, {
+    } = await this.storagePlugin.upload(_objectSpread(_objectSpread({}, params), {}, {
       settings
     }));
     const {
@@ -46,19 +52,23 @@ 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) {
-    const settings = await this.context.fileManager.settings.getSettings(); // Upload files to cloud storage.
+  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 (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 +84,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/FileStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FileStorage.ts"],"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"],"mappings":";;;;;;;;;;;AACA;;;;;;AAKA,MAAMA,iBAAiB,GAAG,0BAA1B;;AAuBO,MAAMC,WAAN,CAAkB;AAIrBC,EAAAA,WAAW,CAAC;AAAEC,IAAAA;AAAF,GAAD,EAAiC;AAAA;AAAA;AACxC,UAAMC,aAAa,GAAGD,OAAO,CAACE,OAAR,CACjBC,MADiB,CACiBN,iBADjB,EAEjBO,GAFiB,EAAtB;;AAGA,QAAI,CAACH,aAAL,EAAoB;AAChB,YAAM,IAAII,cAAJ,CACD,2BAA0BR,iBAAkB,IAD3C,EAEF,sBAFE,CAAN;AAIH;;AACD,SAAKI,aAAL,GAAqBA,aAArB;AACA,SAAKD,OAAL,GAAeA,OAAf;AACH;;AAEW,QAANM,MAAM,CAACC,MAAD,EAAmD;AAC3D,UAAMC,QAAQ,GAAG,MAAM,KAAKR,OAAL,CAAaS,WAAb,CAAyBD,QAAzB,CAAkCE,WAAlC,EAAvB;;AACA,QAAI,CAACF,QAAL,EAAe;AACX,YAAM,IAAIH,cAAJ,CAAgB,gCAAhB,EAAkD,oBAAlD,CAAN;AACH,KAJ0D,CAK3D;;;AACA,UAAM;AAAEM,MAAAA,IAAI,EAAEC;AAAR,QAAqB,MAAM,KAAKX,aAAL,CAAmBK,MAAnB,iCAC1BC,MAD0B;AAE7BC,MAAAA;AAF6B,OAAjC;AAKA,UAAM;AAAEC,MAAAA;AAAF,QAAkB,KAAKT,OAA7B,CAX2D,CAa3D;;AACA,WAAO,MAAMS,WAAW,CAACI,KAAZ,CAAkBC,UAAlB,iCACLF,QADK;AAETG,MAAAA,IAAI,EAAE;AACFC,QAAAA,OAAO,EAAEC,OAAO,CAACV,MAAM,CAACW,iBAAR;AADd,OAFG;AAKTC,MAAAA,IAAI,EAAEC,KAAK,CAACC,OAAN,CAAcd,MAAM,CAACY,IAArB,IAA6BZ,MAAM,CAACY,IAApC,GAA2C;AALxC,OAAb;AAOH;;AAEgB,QAAXG,WAAW,CAACf,MAAD,EAA0C;AACvD,UAAMC,QAAQ,GAAG,MAAM,KAAKR,OAAL,CAAaS,WAAb,CAAyBD,QAAzB,CAAkCE,WAAlC,EAAvB;;AACA,QAAI,CAACF,QAAL,EAAe;AACX,YAAM,IAAIH,cAAJ,CAAgB,gCAAhB,EAAkD,oBAAlD,CAAN;AACH,KAJsD,CAKvD;;;AACA,UAAMkB,QAAQ,GAAG,EAAjB;;AACA,SAAK,MAAMC,IAAX,IAAmBjB,MAAM,CAACM,KAA1B,EAAiC;AAC7BU,MAAAA,QAAQ,CAACE,IAAT,CACI,KAAKxB,aAAL,CAAmBK,MAAnB,iCACOkB,IADP;AAEIhB,QAAAA;AAFJ,SADJ;AAMH,KAdsD,CAevD;;;AACA,UAAMkB,mBAAmB,GAAG,MAAMC,OAAO,CAACC,GAAR,CAAYL,QAAZ,CAAlC;AAEA,UAAMM,SAAS,GAAGH,mBAAmB,CAACI,GAApB,CAAwBC,QAAQ,IAAIA,QAAQ,CAACpB,IAA7C,CAAlB;AAEA,UAAM;AAAEF,MAAAA;AAAF,QAAkB,KAAKT,OAA7B,CApBuD,CAqBvD;;AACA,WAAOS,WAAW,CAACI,KAAZ,CAAkBmB,kBAAlB,CAAqCH,SAArC,CAAP;AACH;;AAEW,QAANI,MAAM,CAAC1B,MAAD,EAAkC;AAC1C,UAAM;AAAE2B,MAAAA,EAAF;AAAMC,MAAAA;AAAN,QAAc5B,MAApB;AACA,UAAM;AAAEE,MAAAA;AAAF,QAAkB,KAAKT,OAA7B,CAF0C,CAG1C;;AACA,UAAM,KAAKC,aAAL,CAAmBgC,MAAnB,CAA0B;AAC5BE,MAAAA;AAD4B,KAA1B,CAAN,CAJ0C,CAO1C;;AACA,WAAO,MAAM1B,WAAW,CAACI,KAAZ,CAAkBuB,UAAlB,CAA6BF,EAA7B,CAAb;AACH;;AA3EoB","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"]}

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/plugins/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"names":["fileStorageContextPlugin","ContextPlugin","context","fileManager","storage","FileStorage"],"mappings":";;;;;;;AACA;;AACA;;AAEA,MAAMA,wBAAwB,GAAG,IAAIC,sBAAJ,CAAsC,MAAMC,OAAN,IAAiB;AACpF,MAAI,CAACA,OAAO,CAACC,WAAb,EAA0B;AACtB;AACR;AACA;AACA;AACQD,IAAAA,OAAO,CAACC,WAAR,GAAsB,EAAtB;AACH;;AACDD,EAAAA,OAAO,CAACC,WAAR,CAAoBC,OAApB,GAA8B,IAAIC,wBAAJ,CAAgB;AAC1CH,IAAAA;AAD0C,GAAhB,CAA9B;AAGH,CAXgC,CAAjC;eAaeF,wB","sourcesContent":["import { FileManagerContext } from \"~/types\";\nimport { ContextPlugin } from \"@webiny/handler\";\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"]}

package/types.d.ts

@@ -39,7 +39,7 @@ export interface File {
 }
 export interface CreatedBy {
     id: string;
-    displayName: string;
+    displayName: string | null;
     type: string;
 }
 export interface FileInput {
@@ -48,7 +48,7 @@ export interface FileInput {
     size: number;
     type: string;
     meta: Record<string, any>;
-    tags: [string];
+    tags: string[];
 }
 export interface FileListWhereParams {
     search?: string;
@@ -71,8 +71,9 @@ export interface FilesListOpts {
     sort?: string[];
 }
 export interface FileListMeta {
-    cursor: string;
+    cursor: string | null;
     totalCount: number;
+    hasMoreItems: boolean;
 }
 interface FilesCrudListTagsWhere {
     tag?: string;
@@ -94,7 +95,7 @@ export interface FilesCRUD {
     createFilesInBatch(data: FileInput[]): Promise<File[]>;
 }
 export interface SystemCRUD {
-    getVersion(): Promise<string>;
+    getVersion(): Promise<string | null>;
     setVersion(version: string): Promise<void>;
     install(args: {
         srcPrefix: string;
@@ -112,7 +113,7 @@ export interface FileManagerSystem {
     tenant: string;
 }
 export declare type SettingsCRUD = {
-    getSettings(): Promise<FileManagerSettings>;
+    getSettings(): Promise<FileManagerSettings | null>;
     createSettings(data?: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
     updateSettings(data: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
     deleteSettings(): Promise<boolean>;
@@ -294,10 +295,10 @@ export interface FileManagerFilesStorageOperationsListParams {
  * @category FilesStorageOperations
  * @category FilesStorageOperationsParams
  */
-interface FileManagerFilesStorageOperationsListResponseMeta {
+export interface FileManagerFilesStorageOperationsListResponseMeta {
     hasMoreItems: boolean;
     totalCount: number;
-    cursor: string;
+    cursor: string | null;
 }
 export declare type FileManagerFilesStorageOperationsListResponse = [
     File[],
@@ -333,11 +334,11 @@ export interface FileManagerFilesStorageOperations {
     /**
      * Insert the file data into the database.
      */
-    create: (params: FileManagerFilesStorageOperationsCreateParams) => Promise<File | null>;
+    create: (params: FileManagerFilesStorageOperationsCreateParams) => Promise<File>;
     /**
      * Update the file data in the database.
      */
-    update: (params: FileManagerFilesStorageOperationsUpdateParams) => Promise<File | null>;
+    update: (params: FileManagerFilesStorageOperationsUpdateParams) => Promise<File>;
     /**
      * Delete the file from the database.
      */

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["utils.ts"],"names":["executeCallbacks","plugins","hook","args","plugin"],"mappings":";;;;;;;AAIO,MAAMA,gBAAgB,GAAG,OAG5BC,OAH4B,EAI5BC,IAJ4B,EAK5BC,IAL4B,KAM3B;AACD,OAAK,MAAMC,MAAX,IAAqBH,OAArB,EAA8B;AAC1B,QAAI,OAAOG,MAAM,CAACF,IAAD,CAAb,KAAwB,UAA5B,EAAwC;AACpC,YAAME,MAAM,CAACF,IAAD,CAAN,CAAaC,IAAb,CAAN;AACH;AACJ;AACJ,CAZM","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"]}