@masterteam/document-library 0.0.1

package/types/masterteam-document-library.d.ts

@@ -0,0 +1,288 @@
+import * as _angular_core from '@angular/core';
+import { TemplateRef } from '@angular/core';
+import { HttpContext } from '@angular/common/http';
+import { BreadcrumbItem } from '@masterteam/components/breadcrumb';
+import { ColumnDef } from '@masterteam/components/table';
+import { MTIcon } from '@masterteam/icons';
+import { Popover } from 'primeng/popover';
+import { Observable } from 'rxjs';
+
+type DocumentLibraryFolderId = number | string;
+interface DocumentLibraryLabel {
+    display?: string;
+    en?: string;
+    ar?: string;
+}
+interface DocumentLibraryFolder {
+    id: DocumentLibraryFolderId;
+    label: DocumentLibraryLabel;
+    parentId: DocumentLibraryFolderId | null;
+    isPrimaryFolder?: boolean;
+    isEditableFolder?: boolean;
+    isNameEditable?: boolean;
+}
+interface DocumentLibraryFile {
+    id: string;
+    name?: string | null;
+    fileName: string;
+    contentType: string;
+    size: number;
+    createdBy?: string | null;
+    created: string;
+    path?: string | null;
+}
+interface DocumentLibraryFolderEntry extends DocumentLibraryFolder {
+    isFolder: true;
+}
+interface DocumentLibraryFileEntry extends DocumentLibraryFile {
+    isFolder: false;
+}
+type DocumentLibraryEntry = DocumentLibraryFolderEntry | DocumentLibraryFileEntry;
+type DocumentLibraryAsyncResult<T> = T | Promise<T> | Observable<T>;
+interface DocumentLibraryCapabilities {
+    canCreateRootFolders?: boolean;
+    canUploadFiles?: boolean;
+    canDownloadFiles?: boolean;
+    canDeleteFiles?: boolean;
+}
+interface DocumentLibraryCreateFolderRequest {
+    parentId: DocumentLibraryFolderId | null;
+    folderName: string;
+}
+interface DocumentLibraryRenameFolderRequest {
+    folderId: DocumentLibraryFolderId;
+    folderName: string;
+}
+interface DocumentLibraryDeleteFolderRequest {
+    folderId: DocumentLibraryFolderId;
+}
+interface DocumentLibraryAddDocumentRequest {
+    folderId: DocumentLibraryFolderId;
+    documentGuid: string;
+}
+interface DocumentLibraryDeleteFileRequest {
+    fileId: string;
+}
+interface DocumentLibraryDownloadFileRequest {
+    file: DocumentLibraryFileEntry;
+}
+interface DocumentLibrarySelectionChangeEvent {
+    folder: DocumentLibraryFolder | null;
+    entry: DocumentLibraryEntry | null;
+}
+type DocumentLibraryActionName = 'open-folder' | 'create-folder' | 'rename-folder' | 'delete-folder' | 'upload-file' | 'download-file' | 'delete-file' | 'reload';
+interface DocumentLibraryApiError {
+    code?: string;
+    message?: string;
+    details?: unknown;
+}
+interface DocumentLibraryResponse<T> {
+    endpoint: string;
+    status: number;
+    code: number;
+    locale: string;
+    message?: string | null;
+    errors?: DocumentLibraryApiError | null;
+    data: T;
+    cacheSession?: string;
+}
+interface DocumentLibraryUploadedAsset {
+    id?: string | null;
+    name?: string | null;
+    fileName?: string | null;
+    contentType?: string | null;
+    size?: number | null;
+}
+interface DocumentLibraryActionEvent {
+    action: DocumentLibraryActionName;
+    target: DocumentLibraryFolder | DocumentLibraryEntry | null;
+}
+declare function isDocumentLibraryFolderEntry(entry: DocumentLibraryEntry | DocumentLibraryFolder | null | undefined): entry is DocumentLibraryFolderEntry;
+declare function isDocumentLibraryFileEntry(entry: DocumentLibraryEntry | null | undefined): entry is DocumentLibraryFileEntry;
+
+type DocumentLibraryUploadDialogMode = 'file' | 'folder';
+
+type DocumentLibraryBreadcrumbItem = BreadcrumbItem & {
+    folderId?: DocumentLibraryFolderId | null;
+};
+type DocumentLibraryTableRow = {
+    id: string;
+    entry: DocumentLibraryEntry;
+    name: string;
+    owner: string;
+    size: string;
+    updatedAt: string;
+};
+type DocumentLibraryActionItem = {
+    id?: string | number;
+    label: string;
+    icon?: MTIcon;
+    disabled?: boolean;
+    visible?: boolean;
+    separator?: boolean;
+    severity?: 'danger';
+    command?: () => void;
+};
+declare class DocumentLibrary {
+    private readonly api;
+    private readonly confirmationService;
+    private readonly modalService;
+    private readonly toast;
+    private readonly transloco;
+    readonly levelId: _angular_core.InputSignal<number>;
+    readonly levelDataId: _angular_core.InputSignal<number | null>;
+    readonly title: _angular_core.InputSignal<string>;
+    readonly description: _angular_core.InputSignal<string>;
+    readonly lang: _angular_core.InputSignal<"en" | "ar">;
+    readonly requestContext: _angular_core.InputSignal<HttpContext | undefined>;
+    readonly uploadEndPoint: _angular_core.InputSignal<string>;
+    readonly emptyTitle: _angular_core.InputSignal<string>;
+    readonly emptyDescription: _angular_core.InputSignal<string>;
+    readonly loaded: _angular_core.OutputEmitterRef<void>;
+    readonly errored: _angular_core.OutputEmitterRef<string>;
+    readonly selectionChanged: _angular_core.OutputEmitterRef<DocumentLibrarySelectionChangeEvent>;
+    readonly actionExecuted: _angular_core.OutputEmitterRef<DocumentLibraryActionEvent>;
+    readonly nameCellTpl: _angular_core.Signal<TemplateRef<any> | undefined>;
+    readonly updatedCellTpl: _angular_core.Signal<TemplateRef<any> | undefined>;
+    readonly actionsCellTpl: _angular_core.Signal<TemplateRef<any> | undefined>;
+    readonly addPopover: _angular_core.Signal<Popover | undefined>;
+    readonly folderPopover: _angular_core.Signal<Popover | undefined>;
+    readonly contextPopover: _angular_core.Signal<Popover | undefined>;
+    readonly roots: _angular_core.WritableSignal<DocumentLibraryFolder[]>;
+    readonly folderRegistry: _angular_core.WritableSignal<Map<string, DocumentLibraryFolder>>;
+    readonly folderEntriesCache: _angular_core.WritableSignal<Map<string, DocumentLibraryEntry[]>>;
+    readonly expandedFolderKeys: _angular_core.WritableSignal<Set<string>>;
+    readonly busyKeys: _angular_core.WritableSignal<Set<string>>;
+    readonly selectedFolderId: _angular_core.WritableSignal<DocumentLibraryFolderId | null>;
+    readonly selectedEntry: _angular_core.WritableSignal<DocumentLibraryEntry | null>;
+    readonly error: _angular_core.WritableSignal<string | null>;
+    readonly contextMenuItems: _angular_core.WritableSignal<DocumentLibraryActionItem[]>;
+    readonly railSearch: _angular_core.WritableSignal<string>;
+    readonly activeLanguage: _angular_core.Signal<string>;
+    readonly canMutateLevelData: _angular_core.Signal<boolean>;
+    readonly uiLang: _angular_core.Signal<"en" | "ar">;
+    readonly resolvedTitle: _angular_core.Signal<string>;
+    readonly resolvedEmptyTitle: _angular_core.Signal<string>;
+    readonly resolvedEmptyDescription: _angular_core.Signal<string>;
+    readonly capabilities: _angular_core.Signal<{
+        canCreateRootFolders: boolean;
+        canUploadFiles: boolean;
+        canDownloadFiles: boolean;
+        canDeleteFiles: boolean;
+    }>;
+    readonly columns: _angular_core.Signal<ColumnDef[]>;
+    readonly selectedFolder: _angular_core.Signal<DocumentLibraryFolder | null>;
+    readonly currentEntries: _angular_core.Signal<DocumentLibraryEntry[]>;
+    readonly tableRows: _angular_core.Signal<DocumentLibraryTableRow[]>;
+    readonly breadcrumbs: _angular_core.Signal<DocumentLibraryBreadcrumbItem[]>;
+    readonly currentFolderTitle: _angular_core.Signal<string>;
+    readonly currentFolderSubtitle: _angular_core.Signal<string>;
+    readonly rootSummary: _angular_core.Signal<string>;
+    readonly visibleRoots: _angular_core.Signal<DocumentLibraryFolder[]>;
+    readonly addMenuItems: _angular_core.Signal<DocumentLibraryActionItem[]>;
+    readonly currentFolderMenuItems: _angular_core.Signal<DocumentLibraryActionItem[]>;
+    constructor();
+    reload(): Promise<void>;
+    goToRoot(): Promise<void>;
+    openFolder(folder: DocumentLibraryFolder): Promise<void>;
+    toggleExpanded(folder: DocumentLibraryFolder): Promise<void>;
+    onRailFolderClick(folder: DocumentLibraryFolder): Promise<void>;
+    onRowClick(row: DocumentLibraryTableRow): Promise<void>;
+    openAddPopover(event: Event): void;
+    openFolderPopover(event: Event): void;
+    openContextMenu(event: MouseEvent, target: DocumentLibraryFolder | DocumentLibraryEntry): void;
+    executePopoverItem(item: DocumentLibraryActionItem, popover: Popover | undefined): void;
+    openCreateFolderDialog(parent: DocumentLibraryFolder | null): void;
+    openRenameFolderDialog(folder: DocumentLibraryFolder): void;
+    private createFolder;
+    private renameFolder;
+    confirmDeleteFolder(folder: DocumentLibraryFolder): void;
+    deleteFolder(folder: DocumentLibraryFolder): Promise<void>;
+    confirmDeleteFile(file: DocumentLibraryFileEntry): void;
+    deleteFile(file: DocumentLibraryFileEntry): Promise<void>;
+    downloadFile(file: DocumentLibraryFileEntry): Promise<void>;
+    openUploadDialog(mode?: DocumentLibraryUploadDialogMode): void;
+    foldersForRail(parentId: DocumentLibraryFolderId | null): DocumentLibraryFolder[];
+    isExpanded(folderId: DocumentLibraryFolderId): boolean;
+    isSelectedFolder(folderId: DocumentLibraryFolderId): boolean;
+    hasLoadedChildren(folderId: DocumentLibraryFolderId): boolean;
+    folderHasChildFolders(folderId: DocumentLibraryFolderId): boolean;
+    canCreateFolderInSelection(folder?: DocumentLibraryFolder | null): boolean;
+    canUploadIntoCurrentFolder(): boolean;
+    canUploadIntoFolder(folder: DocumentLibraryFolder | null): boolean;
+    canDeleteFolder(folder: DocumentLibraryFolder): boolean;
+    canDeleteFile(_file: DocumentLibraryFileEntry): boolean;
+    canDownloadFile(_file: DocumentLibraryFileEntry): boolean;
+    getFolderLabel(folder: DocumentLibraryFolder): string;
+    getEntryTitle(entry: DocumentLibraryEntry): string;
+    getEntryOwner(entry: DocumentLibraryEntry): string;
+    getEntryUpdatedAt(entry: DocumentLibraryEntry): string;
+    getEntryKey(entry: DocumentLibraryEntry): string;
+    getFolderMenuItems(folder: DocumentLibraryFolder): DocumentLibraryActionItem[];
+    getEntryMenuItems(entry: DocumentLibraryEntry): DocumentLibraryActionItem[];
+    getFolderIcon(folder: DocumentLibraryFolder): MTIcon;
+    getFileIcon(entry: DocumentLibraryFileEntry): MTIcon;
+    private getFileAvatarPalette;
+    getHomeAvatarStyle(): string;
+    getFolderAvatarStyle(folder: DocumentLibraryFolder): string;
+    getFileAvatarStyle(entry: DocumentLibraryFileEntry): string;
+    getActionAvatarStyle(): string;
+    getActionPopoverStyle(): Record<string, string>;
+    getActionItemButtonClass(item: DocumentLibraryActionItem): string;
+    getActionItemAvatarStyle(item: DocumentLibraryActionItem): string;
+    getVisibleActionItems(items: DocumentLibraryActionItem[]): DocumentLibraryActionItem[];
+    hasVisibleActionItems(items: DocumentLibraryActionItem[]): boolean;
+    trackActionItem(item: DocumentLibraryActionItem, index: number): string | number;
+    getIconButtonClass(): string;
+    getRailItemClass(active: boolean): string;
+    getFileExtension(entry: DocumentLibraryFileEntry): string;
+    formatFileSize(size: number): string;
+    onBreadcrumbClick(item: BreadcrumbItem): void;
+    isBusy(key: string): boolean;
+    createFolderBusyKey(folderId: DocumentLibraryFolderId | 'root'): string;
+    renameFolderBusyKey(folderId: DocumentLibraryFolderId): string;
+    loadFolderBusyKey(folderId: DocumentLibraryFolderId): string;
+    private openFolderDialog;
+    private loadFolderEntries;
+    private fetchFolderEntries;
+    private ensureFolderEntries;
+    private attachUploadedDocuments;
+    private createFolderInBackend;
+    private insertFolderIntoParent;
+    private replaceFolder;
+    private removeFolderTree;
+    private patchFolderEntries;
+    private upsertFolders;
+    private expandFolderPath;
+    private expandParentForNewFolder;
+    private syncSelectedFolderEntry;
+    private getFolderTrail;
+    private getParentFolder;
+    private resolveUploadTargetFolder;
+    private findOrCreateChildFolder;
+    private folderNameMatches;
+    private getUploadFolderSegments;
+    private mergeEntriesWithUploadedFiles;
+    private sortFolders;
+    private sortEntries;
+    private getTargetMenuItems;
+    private isEntryTarget;
+    private isSelectedFolderInTree;
+    private clearSelectionForRemovedFolders;
+    private canRenameFolder;
+    private collectFolderKeys;
+    private toFolderKey;
+    private deleteFolderBusyKey;
+    private deleteFileBusyKey;
+    private uploadBusyKey;
+    private withBusy;
+    private resolveAsync;
+    private handleError;
+    private translate;
+    private showPopover;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DocumentLibrary, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DocumentLibrary, "mt-document-library", never, { "levelId": { "alias": "levelId"; "required": true; "isSignal": true; }; "levelDataId": { "alias": "levelDataId"; "required": false; "isSignal": true; }; "title": { "alias": "title"; "required": false; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; "lang": { "alias": "lang"; "required": false; "isSignal": true; }; "requestContext": { "alias": "requestContext"; "required": false; "isSignal": true; }; "uploadEndPoint": { "alias": "uploadEndPoint"; "required": false; "isSignal": true; }; "emptyTitle": { "alias": "emptyTitle"; "required": false; "isSignal": true; }; "emptyDescription": { "alias": "emptyDescription"; "required": false; "isSignal": true; }; }, { "loaded": "loaded"; "errored": "errored"; "selectionChanged": "selectionChanged"; "actionExecuted": "actionExecuted"; }, never, never, true, never>;
+}
+
+export { DocumentLibrary, isDocumentLibraryFileEntry, isDocumentLibraryFolderEntry };
+export type { DocumentLibraryActionEvent, DocumentLibraryActionName, DocumentLibraryAddDocumentRequest, DocumentLibraryApiError, DocumentLibraryAsyncResult, DocumentLibraryCapabilities, DocumentLibraryCreateFolderRequest, DocumentLibraryDeleteFileRequest, DocumentLibraryDeleteFolderRequest, DocumentLibraryDownloadFileRequest, DocumentLibraryEntry, DocumentLibraryFile, DocumentLibraryFileEntry, DocumentLibraryFolder, DocumentLibraryFolderEntry, DocumentLibraryFolderId, DocumentLibraryLabel, DocumentLibraryRenameFolderRequest, DocumentLibraryResponse, DocumentLibrarySelectionChangeEvent, DocumentLibraryUploadedAsset };