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

package/types.d.ts

@@ -1,372 +1,6 @@
-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;
-}
+import type { SecurityPermission } from "@webiny/api-core/types/security.js";
 export interface FilePermission extends SecurityPermission {
     name: "fm.file";
     rwd?: string;
     own?: boolean;
 }
-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>;
-    location?: {
-        folderId: string;
-    };
-    tags: string[];
-    aliases: string[];
-    extensions?: Record<string, any>;
-}
-export interface FileListWhereParams {
-    AND?: FileListWhereParams[];
-    OR?: FileListWhereParams[];
-    [key: string]: any;
-}
-export interface FilesListOpts {
-    search?: string;
-    limit?: number;
-    after?: string;
-    where?: FileListWhereParams;
-    sort?: CmsEntryListSort;
-}
-export interface FileListMeta {
-    cursor: string | null;
-    totalCount: number;
-    hasMoreItems: boolean;
-}
-interface FilesCrudListTagsWhere {
-    tag?: string;
-    tag_contains?: string;
-    tag_in?: string[];
-    tag_not_startsWith?: string;
-    tag_startsWith?: string;
-}
-interface FilesCrudListTagsParams {
-    where?: FilesCrudListTagsWhere;
-    limit?: number;
-    after?: string;
-}
-export interface 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<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[], 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>;
-}
-export interface FileManagerSettings {
-    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 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
- *******/
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- * @category SystemStorageOperationsParams
- */
-export interface FileManagerSystemStorageOperationsUpdateParams {
-    /**
-     * The system data to be updated.
-     */
-    original: FileManagerSystem;
-    /**
-     * The system data with the updated fields.
-     */
-    data: FileManagerSystem;
-}
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- * @category SystemStorageOperationsParams
- */
-export interface FileManagerSystemStorageOperationsCreateParams {
-    /**
-     * The system fields.
-     */
-    data: FileManagerSystem;
-}
-export interface FileManagerSystemStorageOperationsGetParams {
-    tenant: string;
-}
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- */
-export interface FileManagerSystemStorageOperations {
-    /**
-     * Get the FileManager system data.
-     */
-    get: (params: FileManagerSystemStorageOperationsGetParams) => Promise<FileManagerSystem | null>;
-    /**
-     * Update the FileManager system data..
-     */
-    update: (params: FileManagerSystemStorageOperationsUpdateParams) => Promise<FileManagerSystem>;
-    /**
-     * Create the FileManagerSystemData
-     */
-    create: (params: FileManagerSystemStorageOperationsCreateParams) => Promise<FileManagerSystem>;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- * @category SettingsStorageOperationsParams
- */
-export interface FileManagerSettingsStorageOperationsUpdateParams {
-    /**
-     * Original settings to be updated.
-     */
-    original: FileManagerSettings;
-    /**
-     * The settings with the updated fields.
-     */
-    data: FileManagerSettings;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- * @category SettingsStorageOperationsParams
- */
-export interface FileManagerSettingsStorageOperationsCreateParams {
-    /**
-     * The settings fields.
-     */
-    data: FileManagerSettings;
-}
-export interface FileManagerStorageOperationsGetSettingsParams {
-    tenant: string;
-}
-export interface FileManagerStorageOperationsDeleteSettings {
-    tenant: string;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- */
-export interface FileManagerSettingsStorageOperations {
-    /**
-     * Get the FileManager system data.
-     */
-    get: (params: FileManagerStorageOperationsGetSettingsParams) => Promise<FileManagerSettings | null>;
-    /**
-     * Create the FileManagerSettingsData
-     */
-    create: (params: FileManagerSettingsStorageOperationsCreateParams) => Promise<FileManagerSettings>;
-    /**
-     * Update the FileManager system data..
-     */
-    update: (params: FileManagerSettingsStorageOperationsUpdateParams) => Promise<FileManagerSettings>;
-    /**
-     * Delete the existing settings.
-     */
-    delete: (params: FileManagerStorageOperationsDeleteSettings) => Promise<void>;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsGetParams {
-    where: {
-        id: string;
-        tenant: string;
-        locale: string;
-    };
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsCreateParams {
-    file: File;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsUpdateParams {
-    original: File;
-    file: File;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsDeleteParams {
-    file: File;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsCreateBatchParams {
-    files: File[];
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListParamsWhere {
-    [key: string]: any;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListParams {
-    where: FileManagerFilesStorageOperationsListParamsWhere;
-    sort: CmsEntryListSort;
-    limit: number;
-    after: string | null;
-    search?: string;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListResponseMeta {
-    hasMoreItems: boolean;
-    totalCount: number;
-    cursor: string | null;
-}
-export type FileManagerFilesStorageOperationsListResponse = [
-    File[],
-    FileManagerFilesStorageOperationsListResponseMeta
-];
-export interface FileManagerFilesStorageOperationsTagsResponse {
-    tag: string;
-    count: number;
-}
-export interface FileManagerFilesStorageOperationsTagsParamsWhere extends FilesCrudListTagsWhere {
-    locale: string;
-    tenant: string;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsTagsParams {
-    where: FileManagerFilesStorageOperationsTagsParamsWhere;
-    limit: number;
-    after?: string;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- */
-export interface FileManagerFilesStorageOperations {
-    /**
-     * Get a single file with given ID from the storage.
-     */
-    get: (params: FileManagerFilesStorageOperationsGetParams) => Promise<File | null>;
-    /**
-     * Insert the file data into the database.
-     */
-    create: (params: FileManagerFilesStorageOperationsCreateParams) => Promise<File>;
-    /**
-     * Update the file data in the database.
-     */
-    update: (params: FileManagerFilesStorageOperationsUpdateParams) => Promise<File>;
-    /**
-     * Delete the file from the database.
-     */
-    delete: (params: FileManagerFilesStorageOperationsDeleteParams) => Promise<void>;
-    /**
-     * Store multiple files at once to the database.
-     */
-    createBatch: (params: FileManagerFilesStorageOperationsCreateBatchParams) => Promise<File[]>;
-    /**
-     * Get a list of files filtered by given parameters.
-     */
-    list: (params: FileManagerFilesStorageOperationsListParams) => Promise<FileManagerFilesStorageOperationsListResponse>;
-    /**
-     * Get a list of all file tags filtered by given parameters.
-     */
-    tags: (params: FileManagerFilesStorageOperationsTagsParams) => Promise<FileManagerFilesStorageOperationsTagsResponse[]>;
-}
-export 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;
-}

package/types.js

@@ -1,29 +1,3 @@
-"use strict";
-
-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];
-    }
-  });
-});
+export {};
 
 //# sourceMappingURL=types.js.map

package/types.js.map

@@ -1 +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":[]}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { SecurityPermission } from \"@webiny/api-core/types/security.js\";\n\nexport interface FilePermission extends SecurityPermission {\n    name: \"fm.file\";\n    rwd?: string;\n    own?: boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/FileManagerContextSetup.d.ts

@@ -1,13 +0,0 @@
-import { type FileManagerContext } from "./types";
-import type { FileManagerConfig } from "./createFileManager/types";
-export declare class FileManagerContextSetup {
-    private readonly context;
-    constructor(context: FileManagerContext);
-    setupContext(storageOperations: FileManagerConfig["storageOperations"]): Promise<import("./types").FileManagerContextObject>;
-    private getLocaleCode;
-    private getIdentity;
-    private getTenantId;
-    private getPermissions;
-    private setupCmsStorageOperations;
-    private getModel;
-}

package/FileManagerContextSetup.js

@@ -1,115 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.FileManagerContextSetup = void 0;
-var _createFileManager = require("./createFileManager");
-var _FileStorage = require("./storage/FileStorage");
-var _error = _interopRequireDefault(require("@webiny/error"));
-var _file = require("./cmsFileStorage/file.model");
-var _CmsFilesStorage = require("./cmsFileStorage/CmsFilesStorage");
-var _CmsModelModifier = require("./modelModifier/CmsModelModifier");
-var _apiHeadlessCms = require("@webiny/api-headless-cms");
-var _FilesPermissions = require("./createFileManager/permissions/FilesPermissions");
-var _SettingsPermissions = require("./createFileManager/permissions/SettingsPermissions");
-class FileManagerContextSetup {
-  constructor(context) {
-    this.context = context;
-  }
-  async setupContext(storageOperations) {
-    if (storageOperations.beforeInit) {
-      await storageOperations.beforeInit(this.context);
-    }
-    const fileStorageOps = await this.context.security.withoutAuthorization(() => {
-      return this.setupCmsStorageOperations(storageOperations.aliases);
-    });
-    if (fileStorageOps) {
-      storageOperations.files = fileStorageOps;
-    }
-    const filesPermissions = new _FilesPermissions.FilesPermissions({
-      getIdentity: this.context.security.getIdentity,
-      getPermissions: () => this.context.security.getPermissions("fm.file"),
-      fullAccessPermissionName: "fm.*"
-    });
-    const settingsPermissions = new _SettingsPermissions.SettingsPermissions({
-      getIdentity: this.context.security.getIdentity,
-      getPermissions: () => this.context.security.getPermissions("fm.settings"),
-      fullAccessPermissionName: "fm.*"
-    });
-    return (0, _createFileManager.createFileManager)({
-      storageOperations,
-      filesPermissions,
-      settingsPermissions,
-      getTenantId: this.getTenantId.bind(this),
-      getLocaleCode: this.getLocaleCode.bind(this),
-      getIdentity: this.getIdentity.bind(this),
-      getPermissions: this.getPermissions.bind(this),
-      storage: new _FileStorage.FileStorage({
-        context: this.context
-      }),
-      // TODO: maybe this is no longer necessary, as this wil be managed by CMS?
-      WEBINY_VERSION: this.context.WEBINY_VERSION
-    });
-  }
-  getLocaleCode() {
-    const locale = this.context.i18n.getContentLocale();
-    if (!locale) {
-      throw new _error.default("Missing locale on context.i18n locale in File Manager API.", "LOCALE_ERROR");
-    }
-    return locale.code;
-  }
-  getIdentity() {
-    return this.context.security.getIdentity();
-  }
-  getTenantId() {
-    return this.context.tenancy.getCurrentTenant().id;
-  }
-  async getPermissions(name) {
-    return this.context.security.getPermissions(name);
-  }
-  async setupCmsStorageOperations(aliases) {
-    if (!(await (0, _apiHeadlessCms.isHeadlessCmsReady)(this.context))) {
-      console.log("Installation pending!");
-      return;
-    }
-    const withPrivateFiles = this.context.wcp.canUsePrivateFiles();
-
-    // This registers code plugins (model group, models)
-    const fileModelDefinition = (0, _file.createFileModel)({
-      withPrivateFiles
-    });
-    const modelModifiers = this.context.plugins.byType(_CmsModelModifier.CmsModelModifierPlugin.type);
-    for (const modifier of modelModifiers) {
-      await modifier.modifyModel(fileModelDefinition);
-    }
-
-    // Finally, register all plugins
-    this.context.plugins.register([new _apiHeadlessCms.CmsModelPlugin(fileModelDefinition)]);
-
-    // Now load the file model registered in the previous step
-    const fileModel = await this.getModel(_file.FILE_MODEL_ID);
-
-    // Overwrite the original `files` storage ops
-    return await _CmsFilesStorage.CmsFilesStorage.create({
-      fileModel,
-      cms: this.context.cms,
-      security: this.context.security,
-      aliases
-    });
-  }
-  async getModel(modelId) {
-    const model = await this.context.cms.getModel(modelId);
-    if (!model) {
-      throw new _error.default({
-        code: "MODEL_NOT_FOUND",
-        message: `Content model "${modelId}" was not found!`
-      });
-    }
-    return model;
-  }
-}
-exports.FileManagerContextSetup = FileManagerContextSetup;
-
-//# sourceMappingURL=FileManagerContextSetup.js.map

package/FileManagerContextSetup.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_createFileManager","require","_FileStorage","_error","_interopRequireDefault","_file","_CmsFilesStorage","_CmsModelModifier","_apiHeadlessCms","_FilesPermissions","_SettingsPermissions","FileManagerContextSetup","constructor","context","setupContext","storageOperations","beforeInit","fileStorageOps","security","withoutAuthorization","setupCmsStorageOperations","aliases","files","filesPermissions","FilesPermissions","getIdentity","getPermissions","fullAccessPermissionName","settingsPermissions","SettingsPermissions","createFileManager","getTenantId","bind","getLocaleCode","storage","FileStorage","WEBINY_VERSION","locale","i18n","getContentLocale","WebinyError","code","tenancy","getCurrentTenant","id","name","isHeadlessCmsReady","console","log","withPrivateFiles","wcp","canUsePrivateFiles","fileModelDefinition","createFileModel","modelModifiers","plugins","byType","CmsModelModifierPlugin","type","modifier","modifyModel","register","CmsModelPlugin","fileModel","getModel","FILE_MODEL_ID","CmsFilesStorage","create","cms","modelId","model","message","exports"],"sources":["FileManagerContextSetup.ts"],"sourcesContent":["import type { FileManagerAliasesStorageOperations, FilePermission } from \"~/types\";\nimport { type FileManagerContext, type SettingsPermission } from \"~/types\";\nimport type { FileManagerConfig } from \"~/createFileManager/types\";\nimport { createFileManager } from \"~/createFileManager\";\nimport { FileStorage } from \"~/storage/FileStorage\";\nimport WebinyError from \"@webiny/error\";\nimport type { SecurityPermission } from \"@webiny/api-security/types\";\nimport { createFileModel, FILE_MODEL_ID } from \"~/cmsFileStorage/file.model\";\nimport { CmsFilesStorage } from \"~/cmsFileStorage/CmsFilesStorage\";\nimport { CmsModelModifierPlugin } from \"~/modelModifier/CmsModelModifier\";\nimport { CmsModelPlugin, isHeadlessCmsReady } from \"@webiny/api-headless-cms\";\nimport { FilesPermissions } from \"~/createFileManager/permissions/FilesPermissions\";\nimport { SettingsPermissions } from \"~/createFileManager/permissions/SettingsPermissions\";\n\nexport class FileManagerContextSetup {\n    private readonly context: FileManagerContext;\n\n    constructor(context: FileManagerContext) {\n        this.context = context;\n    }\n\n    async setupContext(storageOperations: FileManagerConfig[\"storageOperations\"]) {\n        if (storageOperations.beforeInit) {\n            await storageOperations.beforeInit(this.context);\n        }\n\n        const fileStorageOps = await this.context.security.withoutAuthorization(() => {\n            return this.setupCmsStorageOperations(storageOperations.aliases);\n        });\n\n        if (fileStorageOps) {\n            storageOperations.files = fileStorageOps;\n        }\n\n        const filesPermissions = new FilesPermissions({\n            getIdentity: this.context.security.getIdentity,\n            getPermissions: () => this.context.security.getPermissions<FilePermission>(\"fm.file\"),\n            fullAccessPermissionName: \"fm.*\"\n        });\n\n        const settingsPermissions = new SettingsPermissions({\n            getIdentity: this.context.security.getIdentity,\n            getPermissions: () =>\n                this.context.security.getPermissions<SettingsPermission>(\"fm.settings\"),\n            fullAccessPermissionName: \"fm.*\"\n        });\n\n        return createFileManager({\n            storageOperations,\n            filesPermissions,\n            settingsPermissions,\n            getTenantId: this.getTenantId.bind(this),\n            getLocaleCode: this.getLocaleCode.bind(this),\n            getIdentity: this.getIdentity.bind(this),\n            getPermissions: this.getPermissions.bind(this),\n            storage: new FileStorage({\n                context: this.context\n            }),\n            // TODO: maybe this is no longer necessary, as this wil be managed by CMS?\n            WEBINY_VERSION: this.context.WEBINY_VERSION\n        });\n    }\n\n    private getLocaleCode() {\n        const locale = this.context.i18n.getContentLocale();\n        if (!locale) {\n            throw new WebinyError(\n                \"Missing locale on context.i18n locale in File Manager API.\",\n                \"LOCALE_ERROR\"\n            );\n        }\n        return locale.code;\n    }\n\n    private getIdentity() {\n        return this.context.security.getIdentity();\n    }\n\n    private getTenantId() {\n        return this.context.tenancy.getCurrentTenant().id;\n    }\n\n    private async getPermissions<T extends SecurityPermission = SecurityPermission>(\n        name: string\n    ): Promise<T[]> {\n        return this.context.security.getPermissions(name);\n    }\n\n    private async setupCmsStorageOperations(aliases: FileManagerAliasesStorageOperations) {\n        if (!(await isHeadlessCmsReady(this.context))) {\n            console.log(\"Installation pending!\");\n            return;\n        }\n\n        const withPrivateFiles = this.context.wcp.canUsePrivateFiles();\n\n        // This registers code plugins (model group, models)\n        const fileModelDefinition = createFileModel({ withPrivateFiles });\n\n        const modelModifiers = this.context.plugins.byType<CmsModelModifierPlugin>(\n            CmsModelModifierPlugin.type\n        );\n\n        for (const modifier of modelModifiers) {\n            await modifier.modifyModel(fileModelDefinition);\n        }\n\n        // Finally, register all plugins\n        this.context.plugins.register([new CmsModelPlugin(fileModelDefinition)]);\n\n        // Now load the file model registered in the previous step\n        const fileModel = await this.getModel(FILE_MODEL_ID);\n\n        // Overwrite the original `files` storage ops\n        return await CmsFilesStorage.create({\n            fileModel,\n            cms: this.context.cms,\n            security: this.context.security,\n            aliases\n        });\n    }\n\n    private async getModel(modelId: string) {\n        const model = await this.context.cms.getModel(modelId);\n        if (!model) {\n            throw new WebinyError({\n                code: \"MODEL_NOT_FOUND\",\n                message: `Content model \"${modelId}\" was not found!`\n            });\n        }\n\n        return model;\n    }\n}\n"],"mappings":";;;;;;;AAGA,IAAAA,kBAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAC,sBAAA,CAAAH,OAAA;AAEA,IAAAI,KAAA,GAAAJ,OAAA;AACA,IAAAK,gBAAA,GAAAL,OAAA;AACA,IAAAM,iBAAA,GAAAN,OAAA;AACA,IAAAO,eAAA,GAAAP,OAAA;AACA,IAAAQ,iBAAA,GAAAR,OAAA;AACA,IAAAS,oBAAA,GAAAT,OAAA;AAEO,MAAMU,uBAAuB,CAAC;EAGjCC,WAAWA,CAACC,OAA2B,EAAE;IACrC,IAAI,CAACA,OAAO,GAAGA,OAAO;EAC1B;EAEA,MAAMC,YAAYA,CAACC,iBAAyD,EAAE;IAC1E,IAAIA,iBAAiB,CAACC,UAAU,EAAE;MAC9B,MAAMD,iBAAiB,CAACC,UAAU,CAAC,IAAI,CAACH,OAAO,CAAC;IACpD;IAEA,MAAMI,cAAc,GAAG,MAAM,IAAI,CAACJ,OAAO,CAACK,QAAQ,CAACC,oBAAoB,CAAC,MAAM;MAC1E,OAAO,IAAI,CAACC,yBAAyB,CAACL,iBAAiB,CAACM,OAAO,CAAC;IACpE,CAAC,CAAC;IAEF,IAAIJ,cAAc,EAAE;MAChBF,iBAAiB,CAACO,KAAK,GAAGL,cAAc;IAC5C;IAEA,MAAMM,gBAAgB,GAAG,IAAIC,kCAAgB,CAAC;MAC1CC,WAAW,EAAE,IAAI,CAACZ,OAAO,CAACK,QAAQ,CAACO,WAAW;MAC9CC,cAAc,EAAEA,CAAA,KAAM,IAAI,CAACb,OAAO,CAACK,QAAQ,CAACQ,cAAc,CAAiB,SAAS,CAAC;MACrFC,wBAAwB,EAAE;IAC9B,CAAC,CAAC;IAEF,MAAMC,mBAAmB,GAAG,IAAIC,wCAAmB,CAAC;MAChDJ,WAAW,EAAE,IAAI,CAACZ,OAAO,CAACK,QAAQ,CAACO,WAAW;MAC9CC,cAAc,EAAEA,CAAA,KACZ,IAAI,CAACb,OAAO,CAACK,QAAQ,CAACQ,cAAc,CAAqB,aAAa,CAAC;MAC3EC,wBAAwB,EAAE;IAC9B,CAAC,CAAC;IAEF,OAAO,IAAAG,oCAAiB,EAAC;MACrBf,iBAAiB;MACjBQ,gBAAgB;MAChBK,mBAAmB;MACnBG,WAAW,EAAE,IAAI,CAACA,WAAW,CAACC,IAAI,CAAC,IAAI,CAAC;MACxCC,aAAa,EAAE,IAAI,CAACA,aAAa,CAACD,IAAI,CAAC,IAAI,CAAC;MAC5CP,WAAW,EAAE,IAAI,CAACA,WAAW,CAACO,IAAI,CAAC,IAAI,CAAC;MACxCN,cAAc,EAAE,IAAI,CAACA,cAAc,CAACM,IAAI,CAAC,IAAI,CAAC;MAC9CE,OAAO,EAAE,IAAIC,wBAAW,CAAC;QACrBtB,OAAO,EAAE,IAAI,CAACA;MAClB,CAAC,CAAC;MACF;MACAuB,cAAc,EAAE,IAAI,CAACvB,OAAO,CAACuB;IACjC,CAAC,CAAC;EACN;EAEQH,aAAaA,CAAA,EAAG;IACpB,MAAMI,MAAM,GAAG,IAAI,CAACxB,OAAO,CAACyB,IAAI,CAACC,gBAAgB,CAAC,CAAC;IACnD,IAAI,CAACF,MAAM,EAAE;MACT,MAAM,IAAIG,cAAW,CACjB,4DAA4D,EAC5D,cACJ,CAAC;IACL;IACA,OAAOH,MAAM,CAACI,IAAI;EACtB;EAEQhB,WAAWA,CAAA,EAAG;IAClB,OAAO,IAAI,CAACZ,OAAO,CAACK,QAAQ,CAACO,WAAW,CAAC,CAAC;EAC9C;EAEQM,WAAWA,CAAA,EAAG;IAClB,OAAO,IAAI,CAAClB,OAAO,CAAC6B,OAAO,CAACC,gBAAgB,CAAC,CAAC,CAACC,EAAE;EACrD;EAEA,MAAclB,cAAcA,CACxBmB,IAAY,EACA;IACZ,OAAO,IAAI,CAAChC,OAAO,CAACK,QAAQ,CAACQ,cAAc,CAACmB,IAAI,CAAC;EACrD;EAEA,MAAczB,yBAAyBA,CAACC,OAA4C,EAAE;IAClF,IAAI,EAAE,MAAM,IAAAyB,kCAAkB,EAAC,IAAI,CAACjC,OAAO,CAAC,CAAC,EAAE;MAC3CkC,OAAO,CAACC,GAAG,CAAC,uBAAuB,CAAC;MACpC;IACJ;IAEA,MAAMC,gBAAgB,GAAG,IAAI,CAACpC,OAAO,CAACqC,GAAG,CAACC,kBAAkB,CAAC,CAAC;;IAE9D;IACA,MAAMC,mBAAmB,GAAG,IAAAC,qBAAe,EAAC;MAAEJ;IAAiB,CAAC,CAAC;IAEjE,MAAMK,cAAc,GAAG,IAAI,CAACzC,OAAO,CAAC0C,OAAO,CAACC,MAAM,CAC9CC,wCAAsB,CAACC,IAC3B,CAAC;IAED,KAAK,MAAMC,QAAQ,IAAIL,cAAc,EAAE;MACnC,MAAMK,QAAQ,CAACC,WAAW,CAACR,mBAAmB,CAAC;IACnD;;IAEA;IACA,IAAI,CAACvC,OAAO,CAAC0C,OAAO,CAACM,QAAQ,CAAC,CAAC,IAAIC,8BAAc,CAACV,mBAAmB,CAAC,CAAC,CAAC;;IAExE;IACA,MAAMW,SAAS,GAAG,MAAM,IAAI,CAACC,QAAQ,CAACC,mBAAa,CAAC;;IAEpD;IACA,OAAO,MAAMC,gCAAe,CAACC,MAAM,CAAC;MAChCJ,SAAS;MACTK,GAAG,EAAE,IAAI,CAACvD,OAAO,CAACuD,GAAG;MACrBlD,QAAQ,EAAE,IAAI,CAACL,OAAO,CAACK,QAAQ;MAC/BG;IACJ,CAAC,CAAC;EACN;EAEA,MAAc2C,QAAQA,CAACK,OAAe,EAAE;IACpC,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACzD,OAAO,CAACuD,GAAG,CAACJ,QAAQ,CAACK,OAAO,CAAC;IACtD,IAAI,CAACC,KAAK,EAAE;MACR,MAAM,IAAI9B,cAAW,CAAC;QAClBC,IAAI,EAAE,iBAAiB;QACvB8B,OAAO,EAAE,kBAAkBF,OAAO;MACtC,CAAC,CAAC;IACN;IAEA,OAAOC,KAAK;EAChB;AACJ;AAACE,OAAA,CAAA7D,uBAAA,GAAAA,uBAAA","ignoreList":[]}

package/cmsFileStorage/CmsFilesStorage.d.ts

@@ -1,27 +0,0 @@
-import type { CmsModel, HeadlessCms } from "@webiny/api-headless-cms/types";
-import type { Security } from "@webiny/api-security/types";
-import type { File, FileManagerAliasesStorageOperations, FileManagerFilesStorageOperations, FileManagerFilesStorageOperationsCreateBatchParams, FileManagerFilesStorageOperationsCreateParams, FileManagerFilesStorageOperationsDeleteParams, FileManagerFilesStorageOperationsGetParams, FileManagerFilesStorageOperationsListParams, FileManagerFilesStorageOperationsListResponse, FileManagerFilesStorageOperationsTagsParams, FileManagerFilesStorageOperationsTagsResponse, FileManagerFilesStorageOperationsUpdateParams } from "../types";
-export declare class CmsFilesStorage implements FileManagerFilesStorageOperations {
-    private readonly cms;
-    private readonly security;
-    private readonly model;
-    private readonly aliases;
-    private readonly filesWhereProcessor;
-    private readonly tagsWhereProcessor;
-    static create(params: {
-        fileModel: CmsModel;
-        cms: HeadlessCms;
-        security: Security;
-        aliases: FileManagerAliasesStorageOperations;
-    }): Promise<CmsFilesStorage>;
-    private constructor();
-    private modelWithContext;
-    create({ file }: FileManagerFilesStorageOperationsCreateParams): Promise<File>;
-    createBatch({ files }: FileManagerFilesStorageOperationsCreateBatchParams): Promise<File[]>;
-    delete({ file }: FileManagerFilesStorageOperationsDeleteParams): Promise<void>;
-    get({ where }: FileManagerFilesStorageOperationsGetParams): Promise<File | null>;
-    list(params: FileManagerFilesStorageOperationsListParams): Promise<FileManagerFilesStorageOperationsListResponse>;
-    tags(params: FileManagerFilesStorageOperationsTagsParams): Promise<FileManagerFilesStorageOperationsTagsResponse[]>;
-    update({ file }: FileManagerFilesStorageOperationsUpdateParams): Promise<File>;
-    private getFileFieldValues;
-}