@webiny/api-file-manager 0.0.0-unstable.97a151f74d → 0.0.0-unstable.99666aeb00

package/types/file.lifecycle.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["file.lifecycle.ts"],"sourcesContent":["import { Topic } from \"@webiny/pubsub/types\";\nimport { 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":""}

package/types.d.ts

@@ -1,70 +1,46 @@
 import { I18NContext } from "@webiny/api-i18n/types";
-import { FileStorage } from "./plugins/storage/FileStorage";
+import { FileStorage } from "./storage/FileStorage";
 import { TenancyContext } from "@webiny/api-tenancy/types";
 import { SecurityContext, SecurityPermission } from "@webiny/api-security/types";
 import { Context } from "@webiny/api/types";
-export interface FileManagerContext extends Context, SecurityContext, TenancyContext, I18NContext {
-    fileManager: {
-        files: FilesCRUD;
-        settings: SettingsCRUD;
-        storage: FileStorage;
-        system: SystemCRUD;
-    };
+import { FileLifecycleEvents } from "./types/file.lifecycle";
+import { File } from "./types/file";
+import { Topic } from "@webiny/pubsub/types";
+import { CmsContext } from "@webiny/api-headless-cms/types";
+export * from "./types/file.lifecycle";
+export * from "./types/file";
+export interface FileManagerContextObject extends FilesCRUD, SettingsCRUD, SystemCRUD {
+    storage: FileStorage;
+}
+export interface FileManagerContext extends Context, SecurityContext, TenancyContext, I18NContext, CmsContext {
+    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 | null;
-    type: string;
-}
 export interface FileInput {
+    id: string;
     key: string;
     name: string;
     size: number;
     type: string;
     meta: Record<string, any>;
+    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;
@@ -87,24 +63,30 @@ interface FilesCrudListTagsParams {
     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 {
+    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 {
+    tenant: string;
     key: string;
     uploadMinFileSize: number;
     uploadMaxFileSize: number;
@@ -149,6 +131,9 @@ export interface FileManagerSystemStorageOperationsCreateParams {
      */
     data: FileManagerSystem;
 }
+export interface FileManagerSystemStorageOperationsGetParams {
+    tenant: string;
+}
 /**
  * @category StorageOperations
  * @category SystemStorageOperations
@@ -157,7 +142,7 @@ export interface FileManagerSystemStorageOperations {
     /**
      * Get the FileManager system data.
      */
-    get: () => Promise<FileManagerSystem | null>;
+    get: (params: FileManagerSystemStorageOperationsGetParams) => Promise<FileManagerSystem | null>;
     /**
      * Update the FileManager system data..
      */
@@ -193,6 +178,12 @@ export interface FileManagerSettingsStorageOperationsCreateParams {
      */
     data: FileManagerSettings;
 }
+export interface FileManagerStorageOperationsGetSettingsParams {
+    tenant: string;
+}
+export interface FileManagerStorageOperationsDeleteSettings {
+    tenant: string;
+}
 /**
  * @category StorageOperations
  * @category SettingsStorageOperations
@@ -201,7 +192,7 @@ export interface FileManagerSettingsStorageOperations {
     /**
      * Get the FileManager system data.
      */
-    get: () => Promise<FileManagerSettings | null>;
+    get: (params: FileManagerStorageOperationsGetSettingsParams) => Promise<FileManagerSettings | null>;
     /**
      * Create the FileManagerSettingsData
      */
@@ -213,7 +204,7 @@ export interface FileManagerSettingsStorageOperations {
     /**
      * Delete the existing settings.
      */
-    delete: () => Promise<void>;
+    delete: (params: FileManagerStorageOperationsDeleteSettings) => Promise<void>;
 }
 /**
  * @category StorageOperations
@@ -266,20 +257,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
@@ -291,6 +269,7 @@ export interface FileManagerFilesStorageOperationsListParams {
     sort: string[];
     limit: number;
     after: string | null;
+    search?: string;
 }
 /**
  * @category StorageOperations
@@ -306,10 +285,10 @@ export declare 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;
@@ -356,6 +335,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,26 @@
 
 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];
+    }
+  });
 });

package/types.js.map

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

package/plugins/crud/files/validation.d.ts

@@ -1,3 +0,0 @@
-import { FilePlugin } from "../../definitions/FilePlugin";
-declare const _default: () => FilePlugin[];
-export default _default;

package/plugins/crud/files/validation.js

@@ -1,41 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _FilePlugin = require("../../definitions/FilePlugin");
-
-var _createFileModel = _interopRequireDefault(require("../utils/createFileModel"));
-
-var _default = () => [new _FilePlugin.FilePlugin({
-  beforeCreate: async ({
-    data
-  }) => {
-    const FileModel = (0, _createFileModel.default)();
-    const fileData = new FileModel().populate(data);
-    await fileData.validate();
-  },
-  beforeUpdate: async ({
-    data
-  }) => {
-    const FileModel = (0, _createFileModel.default)(false);
-    const updatedFileData = new FileModel().populate(data);
-    await updatedFileData.validate();
-  },
-  beforeBatchCreate: async ({
-    data
-  }) => {
-    const FileModel = (0, _createFileModel.default)();
-
-    for (const input of data) {
-      const fileInstance = new FileModel().populate(input);
-      await fileInstance.validate();
-    }
-  }
-})];
-
-exports.default = _default;

package/plugins/crud/files/validation.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["FilePlugin","beforeCreate","data","FileModel","createFileModel","fileData","populate","validate","beforeUpdate","updatedFileData","beforeBatchCreate","input","fileInstance"],"sources":["validation.ts"],"sourcesContent":["import { FilePlugin } from \"~/plugins/definitions/FilePlugin\";\nimport createFileModel from \"~/plugins/crud/utils/createFileModel\";\n\nexport default (): FilePlugin[] => [\n    new FilePlugin({\n        beforeCreate: async ({ data }) => {\n            const FileModel = createFileModel();\n            const fileData = new FileModel().populate(data);\n            await fileData.validate();\n        },\n        beforeUpdate: async ({ data }) => {\n            const FileModel = createFileModel(false);\n            const updatedFileData = new FileModel().populate(data);\n            await updatedFileData.validate();\n        },\n        beforeBatchCreate: async ({ data }) => {\n            const FileModel = createFileModel();\n            for (const input of data) {\n                const fileInstance = new FileModel().populate(input);\n                await fileInstance.validate();\n            }\n        }\n    })\n];\n"],"mappings":";;;;;;;;;AAAA;;AACA;;eAEe,MAAoB,CAC/B,IAAIA,sBAAJ,CAAe;EACXC,YAAY,EAAE,OAAO;IAAEC;EAAF,CAAP,KAAoB;IAC9B,MAAMC,SAAS,GAAG,IAAAC,wBAAA,GAAlB;IACA,MAAMC,QAAQ,GAAG,IAAIF,SAAJ,GAAgBG,QAAhB,CAAyBJ,IAAzB,CAAjB;IACA,MAAMG,QAAQ,CAACE,QAAT,EAAN;EACH,CALU;EAMXC,YAAY,EAAE,OAAO;IAAEN;EAAF,CAAP,KAAoB;IAC9B,MAAMC,SAAS,GAAG,IAAAC,wBAAA,EAAgB,KAAhB,CAAlB;IACA,MAAMK,eAAe,GAAG,IAAIN,SAAJ,GAAgBG,QAAhB,CAAyBJ,IAAzB,CAAxB;IACA,MAAMO,eAAe,CAACF,QAAhB,EAAN;EACH,CAVU;EAWXG,iBAAiB,EAAE,OAAO;IAAER;EAAF,CAAP,KAAoB;IACnC,MAAMC,SAAS,GAAG,IAAAC,wBAAA,GAAlB;;IACA,KAAK,MAAMO,KAAX,IAAoBT,IAApB,EAA0B;MACtB,MAAMU,YAAY,GAAG,IAAIT,SAAJ,GAAgBG,QAAhB,CAAyBK,KAAzB,CAArB;MACA,MAAMC,YAAY,CAACL,QAAb,EAAN;IACH;EACJ;AAjBU,CAAf,CAD+B,C"}

package/plugins/crud/files.crud.d.ts

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