@webiny/api-file-manager 0.0.0-mt-1

package/types.d.ts

@@ -0,0 +1,357 @@
+import { BaseI18NContentContext } from "@webiny/api-i18n-content/types";
+import { FileStorage } from "./plugins/storage/FileStorage";
+import { TenancyContext } from "@webiny/api-tenancy/types";
+import { SecurityContext, SecurityPermission } from "@webiny/api-security/types";
+import { ContextInterface } from "@webiny/handler/types";
+export interface FileManagerContext extends ContextInterface, SecurityContext, TenancyContext, BaseI18NContentContext {
+    fileManager: {
+        files: FilesCRUD;
+        settings: SettingsCRUD;
+        storage: FileStorage;
+        system: SystemCRUD;
+    };
+}
+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;
+    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;
+    totalCount: number;
+}
+interface FilesCrudListTagsWhere {
+    tag?: string;
+    tag_contains?: string;
+    tag_in?: 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>;
+    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;
+}
+export declare type SettingsCRUD = {
+    getSettings(): Promise<FileManagerSettings>;
+    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
+ */
+interface FileManagerFilesStorageOperationsListResponseMeta {
+    hasMoreItems: boolean;
+    totalCount: number;
+    cursor: string;
+}
+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 | null>;
+    /**
+     * Update the file data in the database.
+     */
+    update: (params: FileManagerFilesStorageOperationsUpdateParams) => Promise<File | null>;
+    /**
+     * 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

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/utils.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from "@webiny/plugins/types";
+declare type CallbackFallback = (args: any) => void | Promise<void>;
+export declare const executeCallbacks: <TCallbackFunction extends CallbackFallback = CallbackFallback>(plugins: Plugin[], hook: string, args: Parameters<TCallbackFunction>[0]) => Promise<void>;
+export {};

package/utils.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.executeCallbacks = void 0;
+
+const executeCallbacks = async (plugins, hook, args) => {
+  for (const plugin of plugins) {
+    if (typeof plugin[hook] === "function") {
+      await plugin[hook](args);
+    }
+  }
+};
+
+exports.executeCallbacks = executeCallbacks;