@webiny/api-file-manager 0.0.0-unstable.bca7b3e350 → 0.0.0-unstable.c27f4d8a31

package/permissions/schema.d.ts

@@ -0,0 +1,73 @@
+import type { Permissions } from "@webiny/api-core/features/security/permissions/index.js";
+declare const schema: {
+    readonly prefix: "fm";
+    readonly fullAccess: true;
+    readonly entities: readonly [{
+        readonly id: "file";
+        readonly permission: "fm.file";
+        readonly scopes: readonly ["full", "own"];
+        readonly actions: readonly [{
+            readonly name: "rwd";
+        }];
+    }, {
+        readonly id: "settings";
+        readonly permission: "fm.settings";
+        readonly scopes: readonly ["full"];
+    }];
+};
+type FmSchema = typeof schema;
+export declare const FmPermissions: {
+    Abstraction: import("@webiny/di").Abstraction<import("@webiny/api-core/features/security/permissions/types").PermissionsTyped<{
+        readonly prefix: "fm";
+        readonly fullAccess: true;
+        readonly entities: readonly [{
+            readonly id: "file";
+            readonly permission: "fm.file";
+            readonly scopes: readonly ["full", "own"];
+            readonly actions: readonly [{
+                readonly name: "rwd";
+            }];
+        }, {
+            readonly id: "settings";
+            readonly permission: "fm.settings";
+            readonly scopes: readonly ["full"];
+        }];
+    }>>;
+    Implementation: import("@webiny/di").Constructor<import("@webiny/api-core/features/security/permissions/types").PermissionsTyped<{
+        readonly prefix: "fm";
+        readonly fullAccess: true;
+        readonly entities: readonly [{
+            readonly id: "file";
+            readonly permission: "fm.file";
+            readonly scopes: readonly ["full", "own"];
+            readonly actions: readonly [{
+                readonly name: "rwd";
+            }];
+        }, {
+            readonly id: "settings";
+            readonly permission: "fm.settings";
+            readonly scopes: readonly ["full"];
+        }];
+    }>> & {
+        __abstraction: import("@webiny/di").Abstraction<import("@webiny/api-core/features/security/permissions/types").PermissionsTyped<{
+            readonly prefix: "fm";
+            readonly fullAccess: true;
+            readonly entities: readonly [{
+                readonly id: "file";
+                readonly permission: "fm.file";
+                readonly scopes: readonly ["full", "own"];
+                readonly actions: readonly [{
+                    readonly name: "rwd";
+                }];
+            }, {
+                readonly id: "settings";
+                readonly permission: "fm.settings";
+                readonly scopes: readonly ["full"];
+            }];
+        }>>;
+    };
+};
+export declare namespace FmPermissions {
+    type Interface = Permissions<FmSchema>;
+}
+export {};

package/permissions/schema.js

@@ -0,0 +1,20 @@
+import { createPermissions } from "@webiny/api-core/features/security/permissions/index.js";
+const schema = {
+  prefix: "fm",
+  fullAccess: true,
+  entities: [{
+    id: "file",
+    permission: "fm.file",
+    scopes: ["full", "own"],
+    actions: [{
+      name: "rwd"
+    }]
+  }, {
+    id: "settings",
+    permission: "fm.settings",
+    scopes: ["full"]
+  }]
+};
+export const FmPermissions = createPermissions(schema);
+
+//# sourceMappingURL=schema.js.map

package/permissions/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createPermissions","schema","prefix","fullAccess","entities","id","permission","scopes","actions","name","FmPermissions"],"sources":["schema.ts"],"sourcesContent":["import { createPermissions } from \"@webiny/api-core/features/security/permissions/index.js\";\nimport type { Permissions } from \"@webiny/api-core/features/security/permissions/index.js\";\n\nconst schema = {\n    prefix: \"fm\",\n    fullAccess: true,\n    entities: [\n        {\n            id: \"file\",\n            permission: \"fm.file\",\n            scopes: [\"full\", \"own\"],\n            actions: [{ name: \"rwd\" }]\n        },\n        {\n            id: \"settings\",\n            permission: \"fm.settings\",\n            scopes: [\"full\"]\n        }\n    ]\n} as const;\n\ntype FmSchema = typeof schema;\n\nexport const FmPermissions = createPermissions(schema);\n\nexport namespace FmPermissions {\n    export type Interface = Permissions<FmSchema>;\n}\n"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,yDAAyD;AAG3F,MAAMC,MAAM,GAAG;EACXC,MAAM,EAAE,IAAI;EACZC,UAAU,EAAE,IAAI;EAChBC,QAAQ,EAAE,CACN;IACIC,EAAE,EAAE,MAAM;IACVC,UAAU,EAAE,SAAS;IACrBC,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;IACvBC,OAAO,EAAE,CAAC;MAAEC,IAAI,EAAE;IAAM,CAAC;EAC7B,CAAC,EACD;IACIJ,EAAE,EAAE,UAAU;IACdC,UAAU,EAAE,aAAa;IACzBC,MAAM,EAAE,CAAC,MAAM;EACnB,CAAC;AAET,CAAU;AAIV,OAAO,MAAMG,aAAa,GAAGV,iBAAiB,CAACC,MAAM,CAAC","ignoreList":[]}

package/types.d.ts

@@ -1,361 +1,6 @@
-import { I18NContext } from "@webiny/api-i18n/types";
-import { FileStorage } from "./plugins/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 type { SecurityPermission } from "@webiny/api-core/types/security.js";
 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 {
-    key: string;
-    name: string;
-    size: number;
-    type: string;
-    meta: Record<string, any>;
-    tags: string[];
-}
-export interface FileListWhereParams {
-    search?: string;
-    type?: string;
-    type_in?: string[];
-    tag?: string;
-    tag_in?: string[];
-    tag_and_in?: string[];
-    id_in?: string[];
-    id?: string;
-}
-export interface FilesListOpts {
-    search?: string;
-    types?: string[];
-    tags?: string[];
-    ids?: string[];
-    limit?: number;
-    after?: string;
-    where?: FileListWhereParams;
-    sort?: string[];
-}
-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 FilesCRUD {
-    getFile(id: string): Promise<File>;
-    listFiles(opts?: FilesListOpts): Promise<[File[], FileListMeta]>;
-    listTags(params: FilesCrudListTagsParams): Promise<string[]>;
-    createFile(data: FileInput): Promise<File>;
-    updateFile(id: string, data: Partial<FileInput>): Promise<File>;
-    deleteFile(id: string): Promise<boolean>;
-    createFilesInBatch(data: FileInput[]): Promise<File[]>;
-}
-export interface SystemCRUD {
-    getVersion(): Promise<string | null>;
-    setVersion(version: string): Promise<void>;
-    install(args: {
-        srcPrefix: string;
-    }): Promise<boolean>;
-    upgrade(version: string, data?: Record<string, any>): Promise<boolean>;
-}
-export interface FileManagerSettings {
-    key: string;
-    uploadMinFileSize: number;
-    uploadMaxFileSize: number;
-    srcPrefix: string;
-}
-export interface FileManagerSystem {
-    version: string;
-    tenant: string;
-}
-export declare type SettingsCRUD = {
-    getSettings(): Promise<FileManagerSettings | null>;
-    createSettings(data?: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
-    updateSettings(data: Partial<FileManagerSettings>): Promise<FileManagerSettings>;
-    deleteSettings(): Promise<boolean>;
-};
-/********
- * 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;
-}
-/**
- * @category StorageOperations
- * @category SystemStorageOperations
- */
-export interface FileManagerSystemStorageOperations {
-    /**
-     * Get the FileManager system data.
-     */
-    get: () => 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;
-}
-/**
- * @category StorageOperations
- * @category SettingsStorageOperations
- */
-export interface FileManagerSettingsStorageOperations {
-    /**
-     * Get the FileManager system data.
-     */
-    get: () => 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: () => 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 {
-    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;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListParams {
-    where: FileManagerFilesStorageOperationsListParamsWhere;
-    sort: string[];
-    limit: number;
-    after: string | null;
-}
-/**
- * @category StorageOperations
- * @category FilesStorageOperations
- * @category FilesStorageOperationsParams
- */
-export interface FileManagerFilesStorageOperationsListResponseMeta {
-    hasMoreItems: boolean;
-    totalCount: number;
-    cursor: string | null;
-}
-export declare type FileManagerFilesStorageOperationsListResponse = [
-    File[],
-    FileManagerFilesStorageOperationsListResponseMeta
-];
-export declare type FileManagerFilesStorageOperationsTagsResponse = [
-    string[],
-    FileManagerFilesStorageOperationsListResponseMeta
-];
-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 {};

package/types.js

@@ -1,5 +1,3 @@
-"use strict";
+export {};
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+//# sourceMappingURL=types.js.map

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 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/handlers/download/index.d.ts

@@ -1,3 +0,0 @@
-import { RoutePlugin } from "@webiny/handler-aws/gateway";
-import { Context } from "@webiny/handler/types";
-export declare const createDownloadFilePlugins: () => RoutePlugin<Context>[];

package/handlers/download/index.js

@@ -1,132 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createDownloadFilePlugins = void 0;
-
-var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
-
-var _sanitizeFilename = _interopRequireDefault(require("sanitize-filename"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _utils = require("../utils");
-
-var _loaders = _interopRequireDefault(require("../transform/loaders"));
-
-var _gateway = require("@webiny/handler-aws/gateway");
-
-const MAX_RETURN_CONTENT_LENGTH = 5000000; // ~4.77MB
-
-const DEFAULT_CACHE_MAX_AGE = 30758400; // 1 year
-
-const PRESIGNED_URL_EXPIRATION = 900; // 15 minutes
-
-/**
- * Based on given path, extracts file key and additional options sent via query params.
- */
-
-const extractFilenameOptions = request => {
-  const path = (0, _sanitizeFilename.default)(request.params.path);
-  return {
-    filename: decodeURI(path),
-    options: request.query,
-    extension: _path.default.extname(path)
-  };
-};
-
-const getS3Object = async (request, s3, context) => {
-  const {
-    options,
-    filename,
-    extension
-  } = extractFilenameOptions(request);
-  const params = (0, _utils.getObjectParams)(filename);
-  const objectHead = await s3.headObject(params).promise();
-  const contentLength = objectHead.ContentLength ? objectHead.ContentLength : 0;
-
-  for (const loader of _loaders.default) {
-    const canProcess = loader.canProcess({
-      context,
-      s3,
-      options,
-      file: {
-        name: filename,
-        extension,
-        contentLength
-      }
-    });
-
-    if (!canProcess) {
-      continue;
-    }
-
-    return loader.process({
-      context,
-      s3,
-      options,
-      file: {
-        name: filename,
-        extension,
-        contentLength
-      }
-    });
-  } // If no processors handled the file request, just return the S3 object taking its size into consideration.
-
-
-  let object;
-
-  if (contentLength < MAX_RETURN_CONTENT_LENGTH) {
-    object = await s3.getObject(params).promise();
-  }
-
-  return {
-    object,
-    params
-  };
-};
-
-const createDownloadFilePlugins = () => {
-  return [new _gateway.RoutePlugin(({
-    onGet,
-    context
-  }) => {
-    onGet("/files/:path", async (request, reply) => {
-      const {
-        region
-      } = (0, _utils.getEnvironment)();
-      const s3 = new _s.default({
-        region
-      });
-      const {
-        params,
-        object
-      } = await getS3Object(request, s3, context); // If there's an "object", it means we can return its body directly.
-
-      if (object) {
-        return reply.headers({
-          "Content-Type": object.ContentType,
-          "Cache-Control": `public, max-age=${DEFAULT_CACHE_MAX_AGE}`,
-          "x-webiny-base64-encoded": true
-        }).send(object.Body || "");
-      }
-
-      const presignedUrl = s3.getSignedUrl("getObject", {
-        Bucket: params.Bucket,
-        Key: params.Key,
-        Expires: PRESIGNED_URL_EXPIRATION
-      }); // Lambda can return max 6MB of content, so if our object's size is larger, we are sending
-      // a 301 Redirect, redirecting the user to the public URL of the object in S3.
-
-      return reply.code(301).headers({
-        Location: presignedUrl,
-        "Cache-Control": "public, max-age=" + PRESIGNED_URL_EXPIRATION
-      }).send("");
-    });
-  })];
-};
-
-exports.createDownloadFilePlugins = createDownloadFilePlugins;

package/handlers/download/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["MAX_RETURN_CONTENT_LENGTH","DEFAULT_CACHE_MAX_AGE","PRESIGNED_URL_EXPIRATION","extractFilenameOptions","request","path","sanitizeFilename","params","filename","decodeURI","options","query","extension","pathLib","extname","getS3Object","s3","context","getObjectParams","objectHead","headObject","promise","contentLength","ContentLength","loader","loaders","canProcess","file","name","process","object","getObject","createDownloadFilePlugins","RoutePlugin","onGet","reply","region","getEnvironment","S3","headers","ContentType","send","Body","presignedUrl","getSignedUrl","Bucket","Key","Expires","code","Location"],"sources":["index.ts"],"sourcesContent":["import S3 from \"aws-sdk/clients/s3\";\nimport sanitizeFilename from \"sanitize-filename\";\nimport pathLib from \"path\";\nimport { getEnvironment, getObjectParams } from \"../utils\";\nimport loaders from \"../transform/loaders\";\nimport { RoutePlugin } from \"@webiny/handler-aws/gateway\";\nimport { Context, Request } from \"@webiny/handler/types\";\nimport { ObjectParamsResponse } from \"~/handlers/utils/getObjectParams\";\n\nconst MAX_RETURN_CONTENT_LENGTH = 5000000; // ~4.77MB\nconst DEFAULT_CACHE_MAX_AGE = 30758400; // 1 year\nconst PRESIGNED_URL_EXPIRATION = 900; // 15 minutes\n/**\n * Based on given path, extracts file key and additional options sent via query params.\n */\nconst extractFilenameOptions = (request: Request) => {\n    const path = sanitizeFilename((request.params as any).path);\n    return {\n        filename: decodeURI(path),\n        options: request.query as any,\n        extension: pathLib.extname(path)\n    };\n};\n\ninterface S3Object {\n    object?: S3.Types.GetObjectOutput;\n    params: ObjectParamsResponse;\n}\n\nconst getS3Object = async (request: Request, s3: S3, context: Context): Promise<S3Object> => {\n    const { options, filename, extension } = extractFilenameOptions(request);\n    const params = getObjectParams(filename);\n    const objectHead = await s3.headObject(params).promise();\n    const contentLength = objectHead.ContentLength ? objectHead.ContentLength : 0;\n\n    for (const loader of loaders) {\n        const canProcess = loader.canProcess({\n            context,\n            s3,\n            options,\n            file: {\n                name: filename,\n                extension,\n                contentLength\n            }\n        });\n\n        if (!canProcess) {\n            continue;\n        }\n        return loader.process({\n            context,\n            s3,\n            options,\n            file: {\n                name: filename,\n                extension,\n                contentLength\n            }\n        });\n    }\n\n    // If no processors handled the file request, just return the S3 object taking its size into consideration.\n    let object;\n    if (contentLength < MAX_RETURN_CONTENT_LENGTH) {\n        object = await s3.getObject(params).promise();\n    }\n\n    return { object, params };\n};\n\nexport const createDownloadFilePlugins = () => {\n    return [\n        new RoutePlugin(({ onGet, context }) => {\n            onGet(\"/files/:path\", async (request, reply) => {\n                const { region } = getEnvironment();\n                const s3 = new S3({ region });\n\n                const { params, object } = await getS3Object(request, s3, context);\n\n                // If there's an \"object\", it means we can return its body directly.\n                if (object) {\n                    return reply\n                        .headers({\n                            \"Content-Type\": object.ContentType,\n                            \"Cache-Control\": `public, max-age=${DEFAULT_CACHE_MAX_AGE}`,\n                            \"x-webiny-base64-encoded\": true\n                        })\n                        .send(object.Body || \"\");\n                }\n\n                const presignedUrl = s3.getSignedUrl(\"getObject\", {\n                    Bucket: params.Bucket,\n                    Key: params.Key,\n                    Expires: PRESIGNED_URL_EXPIRATION\n                });\n\n                // Lambda can return max 6MB of content, so if our object's size is larger, we are sending\n                // a 301 Redirect, redirecting the user to the public URL of the object in S3.\n                return reply\n                    .code(301)\n                    .headers({\n                        Location: presignedUrl,\n                        \"Cache-Control\": \"public, max-age=\" + PRESIGNED_URL_EXPIRATION\n                    })\n                    .send(\"\");\n            });\n        })\n    ];\n};\n"],"mappings":";;;;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AACA;;AAIA,MAAMA,yBAAyB,GAAG,OAAlC,C,CAA2C;;AAC3C,MAAMC,qBAAqB,GAAG,QAA9B,C,CAAwC;;AACxC,MAAMC,wBAAwB,GAAG,GAAjC,C,CAAsC;;AACtC;AACA;AACA;;AACA,MAAMC,sBAAsB,GAAIC,OAAD,IAAsB;EACjD,MAAMC,IAAI,GAAG,IAAAC,yBAAA,EAAkBF,OAAO,CAACG,MAAT,CAAwBF,IAAzC,CAAb;EACA,OAAO;IACHG,QAAQ,EAAEC,SAAS,CAACJ,IAAD,CADhB;IAEHK,OAAO,EAAEN,OAAO,CAACO,KAFd;IAGHC,SAAS,EAAEC,aAAA,CAAQC,OAAR,CAAgBT,IAAhB;EAHR,CAAP;AAKH,CAPD;;AAcA,MAAMU,WAAW,GAAG,OAAOX,OAAP,EAAyBY,EAAzB,EAAiCC,OAAjC,KAAyE;EACzF,MAAM;IAAEP,OAAF;IAAWF,QAAX;IAAqBI;EAArB,IAAmCT,sBAAsB,CAACC,OAAD,CAA/D;EACA,MAAMG,MAAM,GAAG,IAAAW,sBAAA,EAAgBV,QAAhB,CAAf;EACA,MAAMW,UAAU,GAAG,MAAMH,EAAE,CAACI,UAAH,CAAcb,MAAd,EAAsBc,OAAtB,EAAzB;EACA,MAAMC,aAAa,GAAGH,UAAU,CAACI,aAAX,GAA2BJ,UAAU,CAACI,aAAtC,GAAsD,CAA5E;;EAEA,KAAK,MAAMC,MAAX,IAAqBC,gBAArB,EAA8B;IAC1B,MAAMC,UAAU,GAAGF,MAAM,CAACE,UAAP,CAAkB;MACjCT,OADiC;MAEjCD,EAFiC;MAGjCN,OAHiC;MAIjCiB,IAAI,EAAE;QACFC,IAAI,EAAEpB,QADJ;QAEFI,SAFE;QAGFU;MAHE;IAJ2B,CAAlB,CAAnB;;IAWA,IAAI,CAACI,UAAL,EAAiB;MACb;IACH;;IACD,OAAOF,MAAM,CAACK,OAAP,CAAe;MAClBZ,OADkB;MAElBD,EAFkB;MAGlBN,OAHkB;MAIlBiB,IAAI,EAAE;QACFC,IAAI,EAAEpB,QADJ;QAEFI,SAFE;QAGFU;MAHE;IAJY,CAAf,CAAP;EAUH,CA/BwF,CAiCzF;;;EACA,IAAIQ,MAAJ;;EACA,IAAIR,aAAa,GAAGtB,yBAApB,EAA+C;IAC3C8B,MAAM,GAAG,MAAMd,EAAE,CAACe,SAAH,CAAaxB,MAAb,EAAqBc,OAArB,EAAf;EACH;;EAED,OAAO;IAAES,MAAF;IAAUvB;EAAV,CAAP;AACH,CAxCD;;AA0CO,MAAMyB,yBAAyB,GAAG,MAAM;EAC3C,OAAO,CACH,IAAIC,oBAAJ,CAAgB,CAAC;IAAEC,KAAF;IAASjB;EAAT,CAAD,KAAwB;IACpCiB,KAAK,CAAC,cAAD,EAAiB,OAAO9B,OAAP,EAAgB+B,KAAhB,KAA0B;MAC5C,MAAM;QAAEC;MAAF,IAAa,IAAAC,qBAAA,GAAnB;MACA,MAAMrB,EAAE,GAAG,IAAIsB,UAAJ,CAAO;QAAEF;MAAF,CAAP,CAAX;MAEA,MAAM;QAAE7B,MAAF;QAAUuB;MAAV,IAAqB,MAAMf,WAAW,CAACX,OAAD,EAAUY,EAAV,EAAcC,OAAd,CAA5C,CAJ4C,CAM5C;;MACA,IAAIa,MAAJ,EAAY;QACR,OAAOK,KAAK,CACPI,OADE,CACM;UACL,gBAAgBT,MAAM,CAACU,WADlB;UAEL,iBAAkB,mBAAkBvC,qBAAsB,EAFrD;UAGL,2BAA2B;QAHtB,CADN,EAMFwC,IANE,CAMGX,MAAM,CAACY,IAAP,IAAe,EANlB,CAAP;MAOH;;MAED,MAAMC,YAAY,GAAG3B,EAAE,CAAC4B,YAAH,CAAgB,WAAhB,EAA6B;QAC9CC,MAAM,EAAEtC,MAAM,CAACsC,MAD+B;QAE9CC,GAAG,EAAEvC,MAAM,CAACuC,GAFkC;QAG9CC,OAAO,EAAE7C;MAHqC,CAA7B,CAArB,CAjB4C,CAuB5C;MACA;;MACA,OAAOiC,KAAK,CACPa,IADE,CACG,GADH,EAEFT,OAFE,CAEM;QACLU,QAAQ,EAAEN,YADL;QAEL,iBAAiB,qBAAqBzC;MAFjC,CAFN,EAMFuC,IANE,CAMG,EANH,CAAP;IAOH,CAhCI,CAAL;EAiCH,CAlCD,CADG,CAAP;AAqCH,CAtCM"}

package/handlers/manage/index.d.ts

@@ -1,5 +0,0 @@
-import { S3EventHandler } from "@webiny/handler-aws";
-/**
- * This handler must be run through @webiny/handler-aws/s3
- */
-export declare const createManageFilePlugins: () => S3EventHandler<void>[];