@webiny/api-file-manager 0.0.0-unstable.b14eaecf38 → 0.0.0-unstable.b6d7105cee

package/types.d.ts

@@ -1,360 +1,7 @@
-import { I18NContext } from "@webiny/api-i18n/types";
-import { FileStorage } from "./storage/FileStorage";
-import { TenancyContext } from "@webiny/api-tenancy/types";
-import { SecurityContext, SecurityPermission } from "@webiny/api-security/types";
-import { Context } from "@webiny/api/types";
-import { FileLifecycleEvents } from "./types/file.lifecycle";
-import { File } from "./types/file";
-import { Topic } from "@webiny/pubsub/types";
-export * from "./types/file.lifecycle";
-export * from "./types/file";
-export interface FileManagerContextObject extends FilesCRUD, SettingsCRUD, SystemCRUD {
-    storage: FileStorage;
-}
-export interface FileManagerContext extends Context, SecurityContext, TenancyContext, I18NContext {
-    fileManager: FileManagerContextObject;
-}
+import "@webiny/background-tasks/api/features/TaskController/augmentation.js";
+import type { SecurityPermission } from "@webiny/api-core/types/security.js";
 export interface FilePermission extends SecurityPermission {
     name: "fm.file";
     rwd?: string;
     own?: boolean;
 }
-export interface FileInput {
-    id: string;
-    key: string;
-    name: string;
-    size: number;
-    type: string;
-    meta: Record<string, any>;
-    tags: string[];
-    aliases: 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 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): Promise<File>;
-    updateFile(id: string, data: Partial<FileInput>): Promise<File>;
-    deleteFile(id: string): Promise<boolean>;
-    createFilesInBatch(data: FileInput[]): 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;
-    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;
-}
-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 {
-    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 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 FileManagerStorageOperations<TContext = FileManagerContext> {
-    beforeInit?: (context: TContext) => Promise<void>;
-    files: FileManagerFilesStorageOperations;
-    settings: FileManagerSettingsStorageOperations;
-    system: FileManagerSystemStorageOperations;
-}

package/types.js

@@ -1,27 +1 @@
-"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];
-    }
-  });
-});
+import "@webiny/background-tasks/api/features/TaskController/augmentation.js";

package/createFileManager/checkBasePermissions.d.ts

@@ -1,5 +0,0 @@
-import { GetPermission } from "@webiny/api-security/types";
-import { FilePermission } from "../types";
-export declare const checkBasePermissions: (getPermission: GetPermission, check?: {
-    rwd?: string;
-}) => Promise<FilePermission>;

package/createFileManager/checkBasePermissions.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.checkBasePermissions = void 0;
-var _apiSecurity = require("@webiny/api-security");
-const checkBasePermissions = async (getPermission, check = {}) => {
-  const filePermission = await getPermission("fm.file");
-  if (!filePermission) {
-    throw new _apiSecurity.NotAuthorizedError();
-  }
-  if (check.rwd && !hasRwd(filePermission, check.rwd)) {
-    throw new _apiSecurity.NotAuthorizedError();
-  }
-  return filePermission;
-};
-exports.checkBasePermissions = checkBasePermissions;
-const hasRwd = (filesFilePermission, rwd) => {
-  if (typeof filesFilePermission.rwd !== "string") {
-    return true;
-  }
-  return filesFilePermission.rwd.includes(rwd);
-};

package/createFileManager/checkBasePermissions.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["checkBasePermissions","getPermission","check","filePermission","NotAuthorizedError","rwd","hasRwd","filesFilePermission","includes"],"sources":["checkBasePermissions.ts"],"sourcesContent":["import { NotAuthorizedError } from \"@webiny/api-security\";\nimport { GetPermission } from \"@webiny/api-security/types\";\nimport { FilePermission } from \"~/types\";\n\nexport const checkBasePermissions = async (\n    getPermission: GetPermission,\n    check: { rwd?: string } = {}\n): Promise<FilePermission> => {\n    const filePermission = await getPermission<FilePermission>(\"fm.file\");\n\n    if (!filePermission) {\n        throw new NotAuthorizedError();\n    }\n    if (check.rwd && !hasRwd(filePermission, check.rwd)) {\n        throw new NotAuthorizedError();\n    }\n\n    return filePermission;\n};\n\nconst hasRwd = (filesFilePermission: FilePermission, rwd: string): boolean => {\n    if (typeof filesFilePermission.rwd !== \"string\") {\n        return true;\n    }\n\n    return filesFilePermission.rwd.includes(rwd);\n};\n"],"mappings":";;;;;;AAAA;AAIO,MAAMA,oBAAoB,GAAG,OAChCC,aAA4B,EAC5BC,KAAuB,GAAG,CAAC,CAAC,KACF;EAC1B,MAAMC,cAAc,GAAG,MAAMF,aAAa,CAAiB,SAAS,CAAC;EAErE,IAAI,CAACE,cAAc,EAAE;IACjB,MAAM,IAAIC,+BAAkB,EAAE;EAClC;EACA,IAAIF,KAAK,CAACG,GAAG,IAAI,CAACC,MAAM,CAACH,cAAc,EAAED,KAAK,CAACG,GAAG,CAAC,EAAE;IACjD,MAAM,IAAID,+BAAkB,EAAE;EAClC;EAEA,OAAOD,cAAc;AACzB,CAAC;AAAC;AAEF,MAAMG,MAAM,GAAG,CAACC,mBAAmC,EAAEF,GAAW,KAAc;EAC1E,IAAI,OAAOE,mBAAmB,CAACF,GAAG,KAAK,QAAQ,EAAE;IAC7C,OAAO,IAAI;EACf;EAEA,OAAOE,mBAAmB,CAACF,GAAG,CAACG,QAAQ,CAACH,GAAG,CAAC;AAChD,CAAC"}

package/createFileManager/files.crud.d.ts

@@ -1,3 +0,0 @@
-import { FilesCRUD } from "../types";
-import { FileManagerConfig } from "./index";
-export declare const createFilesCrud: (config: FileManagerConfig) => FilesCRUD;