@webiny/api-file-manager 0.0.0-mt-2 → 0.0.0-unstable.06b2ede40f

package/storage/FileStorage.d.ts

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

package/storage/FileStorage.js

@@ -0,0 +1,90 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FileStorage = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+const storagePluginType = "api-file-manager-storage";
+class FileStorage {
+  constructor({
+    context
+  }) {
+    this.context = context;
+  }
+  get storagePlugin() {
+    const storagePlugin = this.context.plugins.byType(storagePluginType).pop();
+    if (!storagePlugin) {
+      throw new _error.default(`Missing plugin of type "${storagePluginType}".`, "STORAGE_PLUGIN_ERROR");
+    }
+    return storagePlugin;
+  }
+  async upload(params) {
+    const settings = await this.context.fileManager.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({
+      ...params,
+      settings
+    });
+
+    // Save file in DB.
+    return this.context.fileManager.createFile({
+      ...fileData,
+      meta: {
+        private: Boolean(params.hideInFileManager)
+      },
+      tags: Array.isArray(params.tags) ? params.tags : []
+    });
+  }
+  async uploadFiles({
+    files
+  }) {
+    const settings = await this.context.fileManager.getSettings();
+    if (!settings) {
+      throw new _error.default("Missing File Manager Settings.", "FILE_MANAGER_ERROR");
+    }
+    const filesData = await Promise.all(files.map(async item => {
+      // TODO: improve types of this.storagePlugin.
+      const {
+        file
+      } = await this.storagePlugin.upload({
+        ...item,
+        settings
+      });
+      return {
+        ...file,
+        meta: {
+          private: Boolean(item.hideInFileManager)
+        },
+        tags: Array.isArray(item.tags) ? item.tags : []
+      };
+    }));
+    return this.context.fileManager.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.deleteFile(id);
+  }
+}
+exports.FileStorage = FileStorage;
+
+//# sourceMappingURL=FileStorage.js.map

package/storage/FileStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_error","_interopRequireDefault","require","storagePluginType","FileStorage","constructor","context","storagePlugin","plugins","byType","pop","WebinyError","upload","params","settings","fileManager","getSettings","file","fileData","createFile","meta","private","Boolean","hideInFileManager","tags","Array","isArray","uploadFiles","files","filesData","Promise","all","map","item","createFilesInBatch","delete","id","key","deleteFile","exports"],"sources":["FileStorage.ts"],"sourcesContent":["import type { FileManagerContext } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport type { FilePhysicalStoragePlugin } from \"~/plugins/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    size: number;\n    name: string;\n    type: string;\n    id?: string;\n    key?: string;\n    tags?: string[];\n    keyPrefix?: 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 context: FileManagerContext;\n\n    constructor({ context }: FileStorageParams) {\n        this.context = context;\n    }\n\n    get storagePlugin() {\n        const storagePlugin = this.context.plugins\n            .byType<FilePhysicalStoragePlugin>(storagePluginType)\n            .pop();\n\n        if (!storagePlugin) {\n            throw new WebinyError(\n                `Missing plugin of type \"${storagePluginType}\".`,\n                \"STORAGE_PLUGIN_ERROR\"\n            );\n        }\n\n        return storagePlugin;\n    }\n\n    async upload(params: FileStorageUploadParams): Promise<Result> {\n        const settings = await this.context.fileManager.getSettings();\n        if (!settings) {\n            throw new WebinyError(\"Missing File Manager Settings.\", \"FILE_MANAGER_ERROR\");\n        }\n\n        // Add file to cloud storage.\n        const { file: fileData } = await this.storagePlugin.upload({\n            ...params,\n            settings\n        });\n\n        // Save file in DB.\n        return this.context.fileManager.createFile({\n            ...fileData,\n            meta: {\n                private: Boolean(params.hideInFileManager)\n            },\n            tags: Array.isArray(params.tags) ? params.tags : []\n        });\n    }\n\n    async uploadFiles({ files }: FileStorageUploadMultipleParams) {\n        const settings = await this.context.fileManager.getSettings();\n        if (!settings) {\n            throw new WebinyError(\"Missing File Manager Settings.\", \"FILE_MANAGER_ERROR\");\n        }\n\n        const filesData = await Promise.all(\n            files.map(async item => {\n                // TODO: improve types of this.storagePlugin.\n                const { file } = await this.storagePlugin.upload({\n                    ...item,\n                    settings\n                });\n\n                return {\n                    ...file,\n                    meta: {\n                        private: Boolean(item.hideInFileManager)\n                    },\n                    tags: Array.isArray(item.tags) ? item.tags : []\n                };\n            })\n        );\n\n        return this.context.fileManager.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\n        // Delete file from the DB.\n        return await fileManager.deleteFile(id);\n    }\n}\n"],"mappings":";;;;;;;AACA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AAKA,MAAMC,iBAAiB,GAAG,0BAA0B;AAyB7C,MAAMC,WAAW,CAAC;EAGrBC,WAAWA,CAAC;IAAEC;EAA2B,CAAC,EAAE;IACxC,IAAI,CAACA,OAAO,GAAGA,OAAO;EAC1B;EAEA,IAAIC,aAAaA,CAAA,EAAG;IAChB,MAAMA,aAAa,GAAG,IAAI,CAACD,OAAO,CAACE,OAAO,CACrCC,MAAM,CAA4BN,iBAAiB,CAAC,CACpDO,GAAG,CAAC,CAAC;IAEV,IAAI,CAACH,aAAa,EAAE;MAChB,MAAM,IAAII,cAAW,CACjB,2BAA2BR,iBAAiB,IAAI,EAChD,sBACJ,CAAC;IACL;IAEA,OAAOI,aAAa;EACxB;EAEA,MAAMK,MAAMA,CAACC,MAA+B,EAAmB;IAC3D,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACR,OAAO,CAACS,WAAW,CAACC,WAAW,CAAC,CAAC;IAC7D,IAAI,CAACF,QAAQ,EAAE;MACX,MAAM,IAAIH,cAAW,CAAC,gCAAgC,EAAE,oBAAoB,CAAC;IACjF;;IAEA;IACA,MAAM;MAAEM,IAAI,EAAEC;IAAS,CAAC,GAAG,MAAM,IAAI,CAACX,aAAa,CAACK,MAAM,CAAC;MACvD,GAAGC,MAAM;MACTC;IACJ,CAAC,CAAC;;IAEF;IACA,OAAO,IAAI,CAACR,OAAO,CAACS,WAAW,CAACI,UAAU,CAAC;MACvC,GAAGD,QAAQ;MACXE,IAAI,EAAE;QACFC,OAAO,EAAEC,OAAO,CAACT,MAAM,CAACU,iBAAiB;MAC7C,CAAC;MACDC,IAAI,EAAEC,KAAK,CAACC,OAAO,CAACb,MAAM,CAACW,IAAI,CAAC,GAAGX,MAAM,CAACW,IAAI,GAAG;IACrD,CAAC,CAAC;EACN;EAEA,MAAMG,WAAWA,CAAC;IAAEC;EAAuC,CAAC,EAAE;IAC1D,MAAMd,QAAQ,GAAG,MAAM,IAAI,CAACR,OAAO,CAACS,WAAW,CAACC,WAAW,CAAC,CAAC;IAC7D,IAAI,CAACF,QAAQ,EAAE;MACX,MAAM,IAAIH,cAAW,CAAC,gCAAgC,EAAE,oBAAoB,CAAC;IACjF;IAEA,MAAMkB,SAAS,GAAG,MAAMC,OAAO,CAACC,GAAG,CAC/BH,KAAK,CAACI,GAAG,CAAC,MAAMC,IAAI,IAAI;MACpB;MACA,MAAM;QAAEhB;MAAK,CAAC,GAAG,MAAM,IAAI,CAACV,aAAa,CAACK,MAAM,CAAC;QAC7C,GAAGqB,IAAI;QACPnB;MACJ,CAAC,CAAC;MAEF,OAAO;QACH,GAAGG,IAAI;QACPG,IAAI,EAAE;UACFC,OAAO,EAAEC,OAAO,CAACW,IAAI,CAACV,iBAAiB;QAC3C,CAAC;QACDC,IAAI,EAAEC,KAAK,CAACC,OAAO,CAACO,IAAI,CAACT,IAAI,CAAC,GAAGS,IAAI,CAACT,IAAI,GAAG;MACjD,CAAC;IACL,CAAC,CACL,CAAC;IAED,OAAO,IAAI,CAAClB,OAAO,CAACS,WAAW,CAACmB,kBAAkB,CAACL,SAAS,CAAC;EACjE;EAEA,MAAMM,MAAMA,CAACtB,MAA+B,EAAE;IAC1C,MAAM;MAAEuB,EAAE;MAAEC;IAAI,CAAC,GAAGxB,MAAM;IAC1B,MAAM;MAAEE;IAAY,CAAC,GAAG,IAAI,CAACT,OAAO;IACpC;IACA,MAAM,IAAI,CAACC,aAAa,CAAC4B,MAAM,CAAC;MAC5BE;IACJ,CAAC,CAAC;;IAEF;IACA,OAAO,MAAMtB,WAAW,CAACuB,UAAU,CAACF,EAAE,CAAC;EAC3C;AACJ;AAACG,OAAA,CAAAnC,WAAA,GAAAA,WAAA","ignoreList":[]}

package/types/file.d.ts

@@ -0,0 +1,49 @@
+type PublicAccess = {
+    type: "public";
+};
+type PrivateAuthenticatedAccess = {
+    type: "private-authenticated";
+};
+export interface File {
+    id: string;
+    key: string;
+    size: number;
+    type: string;
+    name: string;
+    meta: Record<string, any>;
+    accessControl?: PublicAccess | PrivateAuthenticatedAccess;
+    location: {
+        folderId: string;
+    };
+    tags: string[];
+    aliases: string[];
+    createdOn: string;
+    modifiedOn: string | null;
+    savedOn: string;
+    createdBy: CreatedBy;
+    modifiedBy: CreatedBy | null;
+    savedBy: CreatedBy;
+    extensions?: Record<string, any>;
+    /**
+     * 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 FileAlias {
+    tenant: string;
+    locale: string;
+    fileId: string;
+    alias: string;
+}
+export interface CreatedBy {
+    id: string;
+    displayName: string | null;
+    type: string;
+}
+export {};

package/types/file.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=file.js.map

package/types/file.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["file.ts"],"sourcesContent":["type PublicAccess = {\n    type: \"public\";\n};\n\ntype PrivateAuthenticatedAccess = {\n    type: \"private-authenticated\";\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    accessControl?: PublicAccess | PrivateAuthenticatedAccess;\n    location: {\n        folderId: string;\n    };\n    tags: string[];\n    aliases: string[];\n\n    createdOn: string;\n    modifiedOn: string | null;\n    savedOn: string;\n    createdBy: CreatedBy;\n    modifiedBy: CreatedBy | null;\n    savedBy: CreatedBy;\n    extensions?: Record<string, any>;\n\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\n    [key: string]: any;\n}\n\nexport interface FileAlias {\n    tenant: string;\n    locale: string;\n    fileId: string;\n    alias: string;\n}\n\nexport interface CreatedBy {\n    id: string;\n    displayName: string | null;\n    type: string;\n}\n"],"mappings":"","ignoreList":[]}

package/types/file.lifecycle.d.ts

@@ -0,0 +1,44 @@
+import type { Topic } from "@webiny/pubsub/types";
+import type { File } from "./file";
+export interface OnFileBeforeCreateTopicParams<TFile extends File = File> {
+    file: TFile;
+    meta?: Record<string, any>;
+}
+export interface OnFileAfterCreateTopicParams<TFile extends File = File> {
+    file: TFile;
+    meta?: Record<string, any>;
+}
+export interface OnFileBeforeBatchCreateTopicParams<TFile extends File = File> {
+    files: TFile[];
+    meta?: Record<string, any>;
+}
+export interface OnFileAfterBatchCreateTopicParams<TFile extends File = File> {
+    files: TFile[];
+    meta?: Record<string, any>;
+}
+export interface OnFileBeforeUpdateTopicParams<TFile extends File = File> {
+    original: TFile;
+    file: TFile;
+    input: Record<string, any>;
+}
+export interface OnFileAfterUpdateTopicParams<TFile extends File = File> {
+    original: TFile;
+    file: TFile;
+    input: Record<string, any>;
+}
+export interface OnFileBeforeDeleteTopicParams<TFile extends File = File> {
+    file: TFile;
+}
+export interface OnFileAfterDeleteTopicParams<TFile extends File = File> {
+    file: TFile;
+}
+export interface FileLifecycleEvents {
+    onFileBeforeCreate: Topic<OnFileBeforeCreateTopicParams>;
+    onFileAfterCreate: Topic<OnFileAfterCreateTopicParams>;
+    onFileBeforeBatchCreate: Topic<OnFileBeforeBatchCreateTopicParams>;
+    onFileAfterBatchCreate: Topic<OnFileAfterBatchCreateTopicParams>;
+    onFileBeforeUpdate: Topic<OnFileBeforeUpdateTopicParams>;
+    onFileAfterUpdate: Topic<OnFileAfterUpdateTopicParams>;
+    onFileBeforeDelete: Topic<OnFileBeforeDeleteTopicParams>;
+    onFileAfterDelete: Topic<OnFileAfterDeleteTopicParams>;
+}

package/types/file.lifecycle.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=file.lifecycle.js.map

package/types/file.lifecycle.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["file.lifecycle.ts"],"sourcesContent":["import type { Topic } from \"@webiny/pubsub/types\";\nimport type { File } from \"./file\";\n\nexport interface OnFileBeforeCreateTopicParams<TFile extends File = File> {\n    file: TFile;\n    meta?: Record<string, any>;\n}\n\nexport interface OnFileAfterCreateTopicParams<TFile extends File = File> {\n    file: TFile;\n    meta?: Record<string, any>;\n}\n\nexport interface OnFileBeforeBatchCreateTopicParams<TFile extends File = File> {\n    files: TFile[];\n    meta?: Record<string, any>;\n}\n\nexport interface OnFileAfterBatchCreateTopicParams<TFile extends File = File> {\n    files: TFile[];\n    meta?: Record<string, any>;\n}\n\nexport interface OnFileBeforeUpdateTopicParams<TFile extends File = File> {\n    original: TFile;\n    file: TFile;\n    input: Record<string, any>;\n}\n\nexport interface OnFileAfterUpdateTopicParams<TFile extends File = File> {\n    original: TFile;\n    file: TFile;\n    input: Record<string, any>;\n}\n\nexport interface OnFileBeforeDeleteTopicParams<TFile extends File = File> {\n    file: TFile;\n}\n\nexport interface OnFileAfterDeleteTopicParams<TFile extends File = File> {\n    file: TFile;\n}\n\nexport interface FileLifecycleEvents {\n    onFileBeforeCreate: Topic<OnFileBeforeCreateTopicParams>;\n    onFileAfterCreate: Topic<OnFileAfterCreateTopicParams>;\n    onFileBeforeBatchCreate: Topic<OnFileBeforeBatchCreateTopicParams>;\n    onFileAfterBatchCreate: Topic<OnFileAfterBatchCreateTopicParams>;\n    onFileBeforeUpdate: Topic<OnFileBeforeUpdateTopicParams>;\n    onFileAfterUpdate: Topic<OnFileAfterUpdateTopicParams>;\n    onFileBeforeDelete: Topic<OnFileBeforeDeleteTopicParams>;\n    onFileAfterDelete: Topic<OnFileAfterDeleteTopicParams>;\n}\n"],"mappings":"","ignoreList":[]}

package/types.d.ts

@@ -1,120 +1,128 @@
-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 type { I18NContext } from "@webiny/api-i18n/types";
+import type { FileStorage } from "./storage/FileStorage";
+import type { TenancyContext } from "@webiny/api-tenancy/types";
+import type { SecurityContext, SecurityPermission } from "@webiny/api-security/types";
+import type { Context } from "@webiny/api/types";
+import type { FileLifecycleEvents } from "./types/file.lifecycle";
+import type { CreatedBy, File } from "./types/file";
+import type { Topic } from "@webiny/pubsub/types";
+import type { CmsContext, CmsEntryListSort } from "@webiny/api-headless-cms/types";
+import type { Context as TasksContext } from "@webiny/tasks/types";
+export * from "./types/file.lifecycle";
+export * from "./types/file";
+export * from "./types/file";
+export interface FileManagerContextObject extends FilesCRUD, SettingsCRUD, SystemCRUD {
+    storage: FileStorage;
+}
+export interface FileManagerContext extends Context, SecurityContext, TenancyContext, I18NContext, CmsContext, TasksContext {
+    fileManager: FileManagerContextObject;
 }
 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 SettingsPermission extends SecurityPermission {
+    name: "fm.setting";
 }
 export interface FileInput {
+    id: string;
+    createdOn?: string | Date | null;
+    modifiedOn?: string | Date | null;
+    savedOn?: string | Date | null;
+    createdBy?: CreatedBy | null;
+    modifiedBy?: CreatedBy | null;
+    savedBy?: CreatedBy | null;
     key: string;
     name: string;
     size: number;
     type: string;
     meta: Record<string, any>;
-    tags: [string];
+    location?: {
+        folderId: string;
+    };
+    tags: string[];
+    aliases: string[];
+    extensions?: Record<string, any>;
 }
 export interface FileListWhereParams {
-    search?: string;
-    type?: string;
-    type_in?: string[];
-    tag?: string;
-    tag_in?: string[];
-    tag_and_in?: string[];
-    id_in?: string[];
-    id?: string;
+    AND?: FileListWhereParams[];
+    OR?: FileListWhereParams[];
+    [key: string]: any;
 }
 export interface FilesListOpts {
     search?: string;
-    types?: string[];
-    tags?: string[];
-    ids?: string[];
     limit?: number;
     after?: string;
     where?: FileListWhereParams;
-    sort?: string[];
+    sort?: CmsEntryListSort;
 }
 export interface FileListMeta {
-    cursor: string;
+    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 {
+export interface ListTagsResponse {
+    tag: string;
+    count: number;
+}
+export interface FilesCRUD extends FileLifecycleEvents {
     getFile(id: string): Promise<File>;
     listFiles(opts?: FilesListOpts): Promise<[File[], FileListMeta]>;
-    listTags(params: FilesCrudListTagsParams): Promise<string[]>;
-    createFile(data: FileInput): Promise<File>;
+    listTags(params: FilesCrudListTagsParams): Promise<ListTagsResponse[]>;
+    createFile(data: FileInput, meta?: Record<string, any>): Promise<File>;
     updateFile(id: string, data: Partial<FileInput>): Promise<File>;
     deleteFile(id: string): Promise<boolean>;
-    createFilesInBatch(data: FileInput[]): Promise<File[]>;
+    createFilesInBatch(data: FileInput[], meta?: Record<string, any>): Promise<File[]>;
 }
 export interface SystemCRUD {
-    getVersion(): Promise<string>;
+    onSystemBeforeInstall: Topic;
+    onSystemAfterInstall: Topic;
+    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;
+    tenant: string;
     uploadMinFileSize: number;
     uploadMaxFileSize: number;
     srcPrefix: string;
 }
 export interface FileManagerSystem {
     version: string;
+    tenant: string;
+}
+export interface OnSettingsBeforeUpdateTopicParams {
+    input: Partial<FileManagerSettings>;
+    original: FileManagerSettings;
+    settings: FileManagerSettings;
+}
+export interface OnSettingsAfterUpdateTopicParams {
+    input: Partial<FileManagerSettings>;
+    original: FileManagerSettings;
+    settings: FileManagerSettings;
 }
-export declare type SettingsCRUD = {
-    getSettings(): Promise<FileManagerSettings>;
+export type SettingsCRUD = {
+    getSettings(): Promise<FileManagerSettings | null>;
     createSettings(data?: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
     updateSettings(data: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
     deleteSettings(): Promise<boolean>;
+    onSettingsBeforeUpdate: Topic<OnSettingsBeforeUpdateTopicParams>;
+    onSettingsAfterUpdate: Topic<OnSettingsAfterUpdateTopicParams>;
 };
 /********
  * Storage operations
@@ -145,6 +153,9 @@ export interface FileManagerSystemStorageOperationsCreateParams {
      */
     data: FileManagerSystem;
 }
+export interface FileManagerSystemStorageOperationsGetParams {
+    tenant: string;
+}
 /**
  * @category StorageOperations
  * @category SystemStorageOperations
@@ -153,7 +164,7 @@ export interface FileManagerSystemStorageOperations {
     /**
      * Get the FileManager system data.
      */
-    get: () => Promise<FileManagerSystem | null>;
+    get: (params: FileManagerSystemStorageOperationsGetParams) => Promise<FileManagerSystem | null>;
     /**
      * Update the FileManager system data..
      */
@@ -189,6 +200,12 @@ export interface FileManagerSettingsStorageOperationsCreateParams {
      */
     data: FileManagerSettings;
 }
+export interface FileManagerStorageOperationsGetSettingsParams {
+    tenant: string;
+}
+export interface FileManagerStorageOperationsDeleteSettings {
+    tenant: string;
+}
 /**
  * @category StorageOperations
  * @category SettingsStorageOperations
@@ -197,7 +214,7 @@ export interface FileManagerSettingsStorageOperations {
     /**
      * Get the FileManager system data.
      */
-    get: () => Promise<FileManagerSettings | null>;
+    get: (params: FileManagerStorageOperationsGetSettingsParams) => Promise<FileManagerSettings | null>;
     /**
      * Create the FileManagerSettingsData
      */
@@ -209,7 +226,7 @@ export interface FileManagerSettingsStorageOperations {
     /**
      * Delete the existing settings.
      */
-    delete: () => Promise<void>;
+    delete: (params: FileManagerStorageOperationsDeleteSettings) => Promise<void>;
 }
 /**
  * @category StorageOperations
@@ -262,20 +279,7 @@ export interface FileManagerFilesStorageOperationsCreateBatchParams {
  * @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;
+    [key: string]: any;
 }
 /**
  * @category StorageOperations
@@ -284,28 +288,29 @@ export interface FileManagerFilesStorageOperationsListParamsWhere {
  */
 export interface FileManagerFilesStorageOperationsListParams {
     where: FileManagerFilesStorageOperationsListParamsWhere;
-    sort: string[];
+    sort: CmsEntryListSort;
     limit: number;
     after: string | null;
+    search?: string;
 }
 /**
  * @category StorageOperations
  * @category FilesStorageOperations
  * @category FilesStorageOperationsParams
  */
-interface FileManagerFilesStorageOperationsListResponseMeta {
+export interface FileManagerFilesStorageOperationsListResponseMeta {
     hasMoreItems: boolean;
     totalCount: number;
-    cursor: string;
+    cursor: string | null;
 }
-export declare type FileManagerFilesStorageOperationsListResponse = [
+export type FileManagerFilesStorageOperationsListResponse = [
     File[],
     FileManagerFilesStorageOperationsListResponseMeta
 ];
-export declare type FileManagerFilesStorageOperationsTagsResponse = [
-    string[],
-    FileManagerFilesStorageOperationsListResponseMeta
-];
+export interface FileManagerFilesStorageOperationsTagsResponse {
+    tag: string;
+    count: number;
+}
 export interface FileManagerFilesStorageOperationsTagsParamsWhere extends FilesCrudListTagsWhere {
     locale: string;
     tenant: string;
@@ -332,11 +337,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.
      */
@@ -352,6 +357,16 @@ export interface FileManagerFilesStorageOperations {
     /**
      * Get a list of all file tags filtered by given parameters.
      */
-    tags: (params: FileManagerFilesStorageOperationsTagsParams) => Promise<FileManagerFilesStorageOperationsTagsResponse>;
+    tags: (params: FileManagerFilesStorageOperationsTagsParams) => Promise<FileManagerFilesStorageOperationsTagsResponse[]>;
+}
+export interface FileManagerAliasesStorageOperations {
+    storeAliases(file: File): Promise<void>;
+    deleteAliases(file: File): Promise<void>;
+}
+export interface FileManagerStorageOperations<TContext = FileManagerContext> {
+    beforeInit?: (context: TContext) => Promise<void>;
+    files: FileManagerFilesStorageOperations;
+    aliases: FileManagerAliasesStorageOperations;
+    settings: FileManagerSettingsStorageOperations;
+    system: FileManagerSystemStorageOperations;
 }
-export {};

package/types.js

@@ -2,4 +2,28 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+var _file = require("./types/file.lifecycle");
+Object.keys(_file).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _file[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _file[key];
+    }
+  });
+});
+var _file2 = require("./types/file");
+Object.keys(_file2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _file2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _file2[key];
+    }
+  });
+});
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_file","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_file2"],"sources":["types.ts"],"sourcesContent":["import type { I18NContext } from \"@webiny/api-i18n/types\";\nimport type { FileStorage } from \"./storage/FileStorage\";\nimport type { TenancyContext } from \"@webiny/api-tenancy/types\";\nimport type { SecurityContext, SecurityPermission } from \"@webiny/api-security/types\";\nimport type { Context } from \"@webiny/api/types\";\nimport type { FileLifecycleEvents } from \"./types/file.lifecycle\";\nimport type { CreatedBy, File } from \"./types/file\";\nimport type { Topic } from \"@webiny/pubsub/types\";\nimport type { CmsContext, CmsEntryListSort } from \"@webiny/api-headless-cms/types\";\nimport type { Context as TasksContext } from \"@webiny/tasks/types\";\n\nexport * from \"./types/file.lifecycle\";\nexport * from \"./types/file\";\nexport * from \"./types/file\";\n\nexport interface FileManagerContextObject extends FilesCRUD, SettingsCRUD, SystemCRUD {\n    storage: FileStorage;\n}\n\nexport interface FileManagerContext\n    extends Context,\n        SecurityContext,\n        TenancyContext,\n        I18NContext,\n        CmsContext,\n        TasksContext {\n    fileManager: FileManagerContextObject;\n}\n\nexport interface FilePermission extends SecurityPermission {\n    name: \"fm.file\";\n    rwd?: string;\n    own?: boolean;\n}\n\nexport interface SettingsPermission extends SecurityPermission {\n    name: \"fm.setting\";\n}\n\nexport interface FileInput {\n    id: string;\n\n    // In the background, we're actually mapping these to entry-level fields.\n    // This is fine since we don't use revisions for files.\n    createdOn?: string | Date | null;\n    modifiedOn?: string | Date | null;\n    savedOn?: string | Date | null;\n    createdBy?: CreatedBy | null;\n    modifiedBy?: CreatedBy | null;\n    savedBy?: CreatedBy | null;\n\n    key: string;\n    name: string;\n    size: number;\n    type: string;\n    meta: Record<string, any>;\n    location?: {\n        folderId: string;\n    };\n    tags: string[];\n    aliases: string[];\n    extensions?: Record<string, any>;\n}\n\nexport interface FileListWhereParams {\n    AND?: FileListWhereParams[];\n    OR?: FileListWhereParams[];\n    [key: string]: any;\n}\nexport interface FilesListOpts {\n    search?: string;\n    limit?: number;\n    after?: string;\n    where?: FileListWhereParams;\n    sort?: CmsEntryListSort;\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 ListTagsResponse {\n    tag: string;\n    count: number;\n}\nexport interface FilesCRUD extends FileLifecycleEvents {\n    getFile(id: string): Promise<File>;\n    listFiles(opts?: FilesListOpts): Promise<[File[], FileListMeta]>;\n    listTags(params: FilesCrudListTagsParams): Promise<ListTagsResponse[]>;\n    createFile(data: FileInput, meta?: Record<string, any>): Promise<File>;\n    updateFile(id: string, data: Partial<FileInput>): Promise<File>;\n    deleteFile(id: string): Promise<boolean>;\n    createFilesInBatch(data: FileInput[], meta?: Record<string, any>): Promise<File[]>;\n}\n\nexport interface SystemCRUD {\n    onSystemBeforeInstall: Topic;\n    onSystemAfterInstall: Topic;\n    getVersion(): Promise<string | null>;\n    setVersion(version: string): Promise<void>;\n    install(args: { srcPrefix: string }): Promise<boolean>;\n}\n\nexport interface FileManagerSettings {\n    tenant: string;\n    uploadMinFileSize: number;\n    uploadMaxFileSize: number;\n    srcPrefix: string;\n}\n\nexport interface FileManagerSystem {\n    version: string;\n    tenant: string;\n}\n\nexport interface OnSettingsBeforeUpdateTopicParams {\n    input: Partial<FileManagerSettings>;\n    original: FileManagerSettings;\n    settings: FileManagerSettings;\n}\n\nexport interface OnSettingsAfterUpdateTopicParams {\n    input: Partial<FileManagerSettings>;\n    original: FileManagerSettings;\n    settings: FileManagerSettings;\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    onSettingsBeforeUpdate: Topic<OnSettingsBeforeUpdateTopicParams>;\n    onSettingsAfterUpdate: Topic<OnSettingsAfterUpdateTopicParams>;\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\nexport interface FileManagerSystemStorageOperationsGetParams {\n    tenant: string;\n}\n\n/**\n * @category StorageOperations\n * @category SystemStorageOperations\n */\nexport interface FileManagerSystemStorageOperations {\n    /**\n     * Get the FileManager system data.\n     */\n    get: (params: FileManagerSystemStorageOperationsGetParams) => 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\nexport interface FileManagerStorageOperationsGetSettingsParams {\n    tenant: string;\n}\n\nexport interface FileManagerStorageOperationsDeleteSettings {\n    tenant: string;\n}\n\n/**\n * @category StorageOperations\n * @category SettingsStorageOperations\n */\nexport interface FileManagerSettingsStorageOperations {\n    /**\n     * Get the FileManager system data.\n     */\n    get: (\n        params: FileManagerStorageOperationsGetSettingsParams\n    ) => 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: (params: FileManagerStorageOperationsDeleteSettings) => 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    [key: string]: any;\n}\n/**\n * @category StorageOperations\n * @category FilesStorageOperations\n * @category FilesStorageOperationsParams\n */\nexport interface FileManagerFilesStorageOperationsListParams {\n    where: FileManagerFilesStorageOperationsListParamsWhere;\n    sort: CmsEntryListSort;\n    limit: number;\n    after: string | null;\n    search?: string;\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 interface FileManagerFilesStorageOperationsTagsResponse {\n    tag: string;\n    count: number;\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\nexport interface FileManagerAliasesStorageOperations {\n    storeAliases(file: File): Promise<void>;\n    deleteAliases(file: File): Promise<void>;\n}\n\nexport interface FileManagerStorageOperations<TContext = FileManagerContext> {\n    beforeInit?: (context: TContext) => Promise<void>;\n    files: FileManagerFilesStorageOperations;\n    aliases: FileManagerAliasesStorageOperations;\n    settings: FileManagerSettingsStorageOperations;\n    system: FileManagerSystemStorageOperations;\n}\n"],"mappings":";;;;;AAWA,IAAAA,KAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,KAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,KAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,KAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,MAAA,GAAAT,OAAA;AACAC,MAAA,CAAAC,IAAA,CAAAO,MAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,MAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,MAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/handlers/download/index.d.ts

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