@internxt/sdk 1.4.76 → 1.4.77

package/dist/drive/share/types.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { FolderChild } from '../storage/types';
 export interface GenerateShareLinkPayload {
     itemId: string;
     type: string;
@@ -64,6 +66,9 @@ export interface SharedDirectoryFile {
     size: number;
     encryptionKey: string;
 }
+export interface ShareDomainsResponse {
+    list: string[];
+}
 export declare type ListShareLinksItem = Pick<ShareLink, 'id' | 'token' | 'views' | 'timesValid' | 'active' | 'isFolder' | 'createdAt' | 'updatedAt' | 'fileSize'> & {
     item: unknown;
 };
@@ -76,3 +81,278 @@ export declare type ListShareLinksResponse = {
         orderBy?: string;
     };
 };
+export declare type ListPrivateSharedFoldersResponse = {
+    folders: FolderChild[];
+};
+export declare type SharedFolders = {
+    bucket: string | null;
+    createdAt: string;
+    dateShared: string;
+    deleted: boolean;
+    deletedAt: string | null;
+    encryptVersion: string;
+    encryptionKey: string;
+    id: number;
+    name: string;
+    parent: {
+        id: string;
+        size: number;
+        type: string;
+        uuid: string;
+    } | null;
+    parentId: number;
+    plainName: string;
+    removed: boolean;
+    removedAt: string | null;
+    sharedWithMe: boolean;
+    size: number;
+    type: string;
+    updatedAt: string;
+    user: {
+        avatar: string | null;
+        email: string;
+        lastname: string;
+        name: string;
+        uuid: string;
+    };
+    userId: number;
+    uuid: string;
+};
+export declare type SharedFiles = {
+    bucket: string | null;
+    createdAt: string;
+    deleted: boolean;
+    deletedAt: string | null;
+    encryptVersion: string;
+    fileiId: number;
+    folder: string | null;
+    folderId: number;
+    folderUuid: string;
+    id: number;
+    modificationTime: string;
+    name: string;
+    plainName: string;
+    removed: boolean;
+    removedAt: string | null;
+    shares: [];
+    size: string;
+    status: string;
+    thumbnails: [];
+    type: string;
+    updatedAt: string;
+    userId: number;
+    uuid: string;
+};
+export declare type ListSharedItemsResponse = {
+    credentials: {
+        networkPass: string;
+        networkUser: string;
+    };
+    items: SharedFiles[] | SharedFolders[];
+    token: string;
+};
+export declare type ListAllSharedFoldersResponse = {
+    credentials: {
+        networkPass: string;
+        networkUser: string;
+    };
+    files: SharedFiles[];
+    folders: SharedFolders[];
+    token: string;
+};
+export declare type ShareFolderWithUserPayload = {
+    itemId: string;
+    itemType: 'folder' | 'file';
+    notifyUser: boolean;
+    notificationMessage?: string;
+    sharedWith: string;
+    encryptionKey?: string;
+    encryptionAlgorithm?: string;
+    roleId: string;
+    persistPreviousSharing?: boolean;
+};
+export declare type CreateSharingPayload = {
+    itemId: string;
+    itemType: 'folder' | 'file';
+    encryptionKey: string;
+    encryptionAlgorithm: string;
+    encryptedCode: string;
+    persistPreviousSharing?: boolean;
+    encryptedPassword?: string;
+};
+export declare type PublicSharedItemInfo = {
+    plainName: string;
+    size: number;
+    type: string;
+};
+export declare type AcceptInvitationToSharedFolderPayload = {
+    encryptionKey: string;
+    encryptionAlgorithm: string;
+};
+export declare type PrivateSharingRole = {
+    id: string;
+    name: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export declare type PrivateSharingRolesResponse = {
+    roles: PrivateSharingRole[];
+};
+export declare type GrantSharePrivilegesToUserResponse = {
+    message: string;
+};
+export declare type UpdateUserRoleResponse = {
+    message: string;
+};
+export declare type UpdateUserRolePayload = {
+    sharingId: string;
+    newRoleId: string;
+};
+export declare type RemoveUserRolePayload = {
+    itemType: string;
+    itemId: string;
+    userId: string;
+};
+export declare type SharedFolderUser = {
+    avatar: string | null;
+    email: string;
+    grantedFrom: string;
+    grantedFromPlainName: string;
+    id: number;
+    lastname: string;
+    name: string;
+    roleId: string;
+    roleName: string;
+    uuid: string;
+};
+export declare type Role = {
+    id: string;
+    name: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export declare type getSharedFolderUsersResponse = {
+    users: SharedFolderUser[];
+};
+export declare type SharedFoldersInvitationsAsInvitedUserResponse = {
+    createdAt: Date;
+    encryptionAlgorithm: string;
+    encryptionKey: string;
+    id: string;
+    invited: {
+        avatar: string | null;
+        email: string;
+        lastname: string;
+        name: string;
+        uuid: string;
+    };
+    item: ItemInvitation;
+    itemId: string;
+    itemType: string;
+    roleId: string;
+    sharedWith: string;
+    type: string;
+    updatedAt: Date;
+};
+declare type ItemInvitation = {
+    bucket: string | null;
+    createdAt: Date;
+    deleted: boolean;
+    deletedAt: Date | null;
+    encryptVersion: string;
+    id: number;
+    name: string;
+    parent: null;
+    parentId: number;
+    plainName: string;
+    removed: boolean;
+    removedAt: Date | null;
+    size: number;
+    type: string;
+    updatedAt: Date;
+    user: {
+        avatar: string | null;
+        email: string;
+        lastname: string;
+        name: string;
+        uuid: string;
+    } | null;
+    userId: number;
+    uuid: string;
+};
+export declare type FolderUserInfo = {
+    avatar: string | null;
+    email: string;
+    grantedFrom: string;
+    grantedFromPlainName: string;
+    id: number;
+    lastname: string;
+    name: string;
+    roleId: string;
+    roleName: string;
+    uuid: string;
+};
+export declare type SharingInvitation = {
+    id: number;
+    userId: string;
+    name: string;
+    lastname: string;
+    email: string;
+    username: string;
+    bridgeUser: string;
+    password: string;
+    mnemonic: string;
+    rootFolderId: number;
+    hKey: Buffer | string;
+    secret_2FA: string;
+    errorLoginCount: number;
+    isEmailActivitySended: number;
+    referralCode: string;
+    referrer: string;
+    syncDate: Date;
+    uuid: string;
+    lastResend: Date;
+    credit: number;
+    welcomePack: boolean;
+    registerCompleted: boolean;
+    backupsBucket: string;
+    sharedWorkspace: boolean;
+    tempKey: string;
+    avatar: string;
+};
+export declare type SharingInvite = {
+    id: string;
+    itemId: string;
+    itemType: 'file' | 'folder';
+    sharedWith: string;
+    encryptionKey: string;
+    encryptionAlgorithm: string;
+    type: 'SELF' | 'OWNER';
+    roleId: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export declare type SharingMeta = {
+    id: string;
+    itemId: string;
+    itemType: 'file' | 'folder';
+    ownerId: string;
+    sharedWith: string;
+    encryptionKey: string;
+    encryptedCode: string;
+    encryptedPassword: string | null;
+    encryptionAlgorithm: string;
+    createdAt: Date;
+    updatedAt: Date;
+    type: 'public' | 'private';
+    item: SharedFiles | SharedFolders;
+    itemToken: string;
+};
+export declare type Sharing = {
+    type: string;
+    id: string;
+};
+export declare type SharedFolderSize = {
+    size: number;
+};
+export {};

package/dist/drive/storage/index.d.ts

@@ -1,6 +1,8 @@
-import { CreateFolderPayload, CreateFolderResponse, DeleteFilePayload, DriveFileData, FetchFolderContentResponse, FileEntry, MoveFilePayload, MoveFileResponse, MoveFolderPayload, MoveFolderResponse, UpdateFilePayload, UpdateFolderMetadataPayload, FetchLimitResponse, UsageResponse, AddItemsToTrashPayload, ThumbnailEntry, Thumbnail } from './types';
+import { CreateFolderPayload, CreateFolderResponse, DeleteFilePayload, DriveFileData, FetchFolderContentResponse, FileEntry, MoveFilePayload, MoveFileResponse, MoveFolderPayload, MoveFolderResponse, UpdateFilePayload, UpdateFolderMetadataPayload, FetchLimitResponse, UsageResponse, AddItemsToTrashPayload, ThumbnailEntry, Thumbnail, FetchPaginatedFolderContentResponse, FileMeta, SearchResultData, FolderAncestor, FolderMeta, ReplaceFile, FetchPaginatedFilesContent, FetchPaginatedFoldersContent, MoveFolderUuidPayload, MoveFileUuidPayload } from './types';
 import { ApiSecurity, ApiUrl, AppDetails } from '../../shared';
 import { RequestCanceler } from '../../shared/http/client';
+import { Token } from '../../auth';
+import { UUID } from '../../shared/types/userSettings';
 export * as StorageTypes from './types';
 export declare class Storage {
     private readonly client;
@@ -18,6 +20,11 @@ export declare class Storage {
      * @param payload
      */
     moveFolder(payload: MoveFolderPayload): Promise<MoveFolderResponse>;
+    /**
+     * Moves a specific folder to a new location
+     * @param payload
+     */
+    moveFolderByUuid(payload: MoveFolderUuidPayload): Promise<FolderMeta>;
     /**
      * Updates the metadata of a folder
      * @param payload
@@ -28,6 +35,55 @@ export declare class Storage {
      * @param folderId
      */
     getFolderContent(folderId: number, trash?: boolean): [Promise<FetchFolderContentResponse>, RequestCanceler];
+    /**
+     * Returns metadata of a specific file
+     * @param fileId
+     */
+    getFile(fileId: string): [Promise<FileMeta>, RequestCanceler];
+    /**
+     * Gets the files in a folder.
+     *
+     * @param {number} folderId - The ID of the folder.
+     * @param {number} [offset=0] - The position of the first file to return.
+     * @param {number} [limit=50] - The max number of files to be returned.
+     * @param {string} [sort=plainName] - The reference column to sort it.
+     * @param {string} [order=ASC] - The order to be followed.
+     * @returns {[Promise<FetchPaginatedFolderContentResponse>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
+     */
+    getFolderFiles(folderId: number, offset?: number, limit?: number, sort?: string, order?: string): [Promise<FetchPaginatedFolderContentResponse>, RequestCanceler];
+    /**
+     * Gets the files in a folder by its UUID.
+     *
+     * @param {UUID} folderUuid - The UUID of the folder.
+     * @param {number} [offset=0] - The position of the first file to return.
+     * @param {number} [limit=50] - The max number of files to be returned.
+     * @param {string} [sort=plainName] - The reference column to sort it.
+     * @param {string} [order=ASC] - The order to be followed.
+     * @returns {[Promise<FetchPaginatedFilesContent>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
+     */
+    getFolderFilesByUuid(folderUuid: UUID, offset?: number, limit?: number, sort?: string, order?: string): [Promise<FetchPaginatedFilesContent>, RequestCanceler];
+    /**
+     * Gets the subfolders of a folder.
+     *
+     * @param {number} folderId - The ID of the folder.
+     * @param {number} [offset=0] - The position of the first subfolder to return.
+     * @param {number} [limit=50] - The max number of subfolders to return.
+     * @param {string} [sort=plainName] - The reference column to sort it.
+     * @param {string} [order=ASC] - The order to be followed.
+     * @returns {[Promise<FetchPaginatedFolderContentResponse>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
+     */
+    getFolderFolders(folderId: number, offset?: number, limit?: number, sort?: string, order?: string): [Promise<FetchPaginatedFolderContentResponse>, RequestCanceler];
+    /**
+     * Gets the subfolders of a folder by its UUID.
+     *
+     * @param {UUID} folderUuid - The UUID of the folder.
+     * @param {number} [offset=0] - The position of the first subfolder to return.
+     * @param {number} [limit=50] - The max number of subfolders to return.
+     * @param {string} [sort=plainName] - The reference column to sort it.
+     * @param {string} [order=ASC] - The order to be followed.
+     * @returns {[Promise<FetchPaginatedFoldersContent>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
+     */
+    getFolderFoldersByUuid(folderUuid: UUID, offset?: number, limit?: number, sort?: string, order?: string): [Promise<FetchPaginatedFoldersContent>, RequestCanceler];
     /**
      * Removes a specific folder from the centralized persistence
      * @param folderId
@@ -42,17 +98,17 @@ export declare class Storage {
      * Creates a new file entry
      * @param fileEntry
      */
-    createFileEntry(fileEntry: FileEntry): Promise<DriveFileData>;
+    createFileEntry(fileEntry: FileEntry, resourcesToken?: Token): Promise<DriveFileData>;
     /**
      * Creates a new thumbnail entry
      * @param thumbnailEntry
      */
-    createThumbnailEntry(thumbnailEntry: ThumbnailEntry): Promise<Thumbnail>;
+    createThumbnailEntry(thumbnailEntry: ThumbnailEntry, resourcesToken?: Token): Promise<Thumbnail>;
     /**
      * Updates the details of a file entry
      * @param payload
      */
-    updateFile(payload: UpdateFilePayload): Promise<void>;
+    updateFile(payload: UpdateFilePayload, resourcesToken?: Token): Promise<void>;
     /**
      * Deletes a specific file entry
      * @param payload
@@ -63,6 +119,11 @@ export declare class Storage {
      * @param payload
      */
     moveFile(payload: MoveFilePayload): Promise<MoveFileResponse>;
+    /**
+     * Moves a specific file to a new location
+     * @param payload
+     */
+    moveFileByUuid(payload: MoveFileUuidPayload): Promise<FileMeta>;
     /**
      * Returns a list of the n most recent files
      * @param limit
@@ -76,7 +137,12 @@ export declare class Storage {
      * Add Items to Trash
      * @param payload
      */
-    addItemsToTrash(payload: AddItemsToTrashPayload): Promise<unknown>;
+    addItemsToTrash(payload: AddItemsToTrashPayload): Promise<void>;
+    /**
+     * Returns a list of the n most recent files
+     * @param limit
+     */
+    searchItemsByName(plain_name: string): Promise<DriveFileData[]>;
     /**
      * Returns the current space usage of the user
      */
@@ -85,9 +151,45 @@ export declare class Storage {
      * Returns the current space limit for the user
      */
     spaceLimit(): Promise<FetchLimitResponse>;
+    /**
+     * Get global search items.
+     *
+     * @param {string} search - The name of the item.
+     * @returns {[Promise<SearchResultData>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
+     */
+    getGlobalSearchItems(search: string): [Promise<SearchResultData>, RequestCanceler];
     /**
      * Returns the needed headers for the module requests
      * @private
      */
     private headers;
+    /**
+     * Gets the ancestors of a given folder UUID
+     *
+     * @param {string} folderUUID - UUID of the folder.
+     * @returns {Promise<FolderAncestor[]>}
+     */
+    getFolderAncestors(uuid: string): Promise<FolderAncestor[]>;
+    /**
+     * Gets the meta of a given folder UUID
+     *
+     * @param {string} folderUUID - UUID of the folder.
+     * @returns {Promise<FolderMeta>}
+     */
+    getFolderMeta(uuid: string): Promise<FolderMeta>;
+    /**
+     * Gets the meta of a given folder Id
+     *
+     * @param {number} folderId - Id of the folder.
+     * @returns {Promise<FolderMeta>}
+     */
+    getFolderMetaById(folderId: number): Promise<FolderMeta>;
+    /**
+     * Replaces a file with a new one.
+     *
+     * @param {string} uuid - UUID of the file.
+     * @param {ReplaceFile} payload
+     * @returns {Promise<DriveFileData>} - The replaced file data.
+     */
+    replaceFile(uuid: string, payload: ReplaceFile): Promise<DriveFileData>;
 }