@webiny/api-file-manager 0.0.0-unstable.eb196ccd2f → 0.0.0-unstable.eb81deee7e

package/types/file.lifecycle.d.ts

@@ -1,44 +0,0 @@
-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

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

package/types/file.lifecycle.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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":[]}