@acorex/modules 19.4.3 → 19.4.5

package/document-management/lib/features/shared/document-manager.service.d.ts

@@ -7,6 +7,7 @@ import { AXFileService } from '@acorex/core/file';
 import { AXPPlatformScope, AXPQueryRequest } from '@acorex/platform/core';
 import { AXMDocumentManagementDocumentTypeEntityModel, AXMDocumentManagementFolderCreateDto, AXMDocumentService, AXMFolderService } from '../../entities';
 import { AXMDocumentExplorerBrowseMode, AXMDocumentExplorerNode, CreateFileDto, UpdateFileDto, UpdateFolderDto } from './document-manager.types';
+import { AXTranslationService } from '@acorex/core/translation';
 import * as i0 from "@angular/core";
 /**
  * Interface defining the contract for document drive service
@@ -35,10 +36,10 @@ export interface AXMDocumentManagerServiceInterface {
     updateFile(fileId: string, data: UpdateFileDto): Promise<AXMDocumentExplorerNode>;
     deleteFile(fileId: string): Promise<void>;
     deleteNodes(nodeIds: AXMDocumentExplorerNode[]): Promise<void>;
+    copy(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode>;
     showCreateFolderDialog(parentId?: string): Promise<AXMDocumentExplorerNode | null>;
     showDeleteNodesDialog(nodeIds: AXMDocumentExplorerNode[]): Promise<boolean>;
     showRenamePopup(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode | undefined>;
-    copy(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode>;
     searchFolders(searchTerm: string, scope: AXPPlatformScope, options?: {
         tenantId?: string;
         userId?: string;
@@ -88,46 +89,53 @@ export declare class AXMDocumentManagerService implements AXMDocumentManagerServ
     protected fileService: AXPFileStorageService;
     protected fileManagerService: AXFileService;
     protected workflow: AXPWorkflowService;
+    protected translate: AXTranslationService;
     private scopedDriveCache;
+    /**
+     * Creates a scoped drive service for the specified platform scope
+     */
     scope(scope: AXPPlatformScope, options?: {
         tenantId?: string;
         userId?: string;
     }): ScopedDriveService;
+    /**
+     * Generates a cache key for the scoped drive service
+     */
     private getScopeCacheKey;
     /**
      * Gets the platform root folder (top-level folder)
-     * @returns Root folder for the platform
      */
     private getPlatformRootFolder;
     /**
      * Gets the tenant root folder
-     * @param rootFolderId The platform root folder ID
-     * @param tenantId The tenant ID
-     * @returns Tenant root folder
      */
     private getTenantRootFolder;
     /**
      * Gets the user root folder
-     * @param tenantFolderId The tenant folder ID
-     * @param tenantId The tenant ID
-     * @param userId The user ID
-     * @returns User root folder
      */
     private getUserRootFolder;
+    /**
+     * Maps folder entity to document explorer node
+     */
     private mapFolderDtoToFolderNode;
+    /**
+     * Maps file entity to document explorer node
+     */
+    private mapFileToNode;
+    /**
+     * Maps document to media viewer data
+     */
+    private mapDocumentToMediaViewerData;
+    /**
+     * Builds navigation path for a node
+     */
     private buildPath;
-    showShareDialog(node: AXMDocumentExplorerNode): Promise<void>;
-    showShareWithEmailDialog(node: AXMDocumentExplorerNode): Promise<void>;
-    showLinkDialog(node: AXMDocumentExplorerNode): Promise<void>;
-    showLockDialog(node: AXMDocumentExplorerNode): Promise<void>;
-    showUnlockDialog(node: AXMDocumentExplorerNode): Promise<void>;
-    showFolderEditDialog(node: AXMDocumentExplorerNode): Promise<boolean>;
-    updateFileName(node: AXMDocumentExplorerNode, name: string): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Creates a copy name by adding " copy" before the extension
+     */
+    private createCopyName;
     /**
      * Gets the root folder based on the specified scope
-     * @param scope The drive scope (Platform, Tenant, User)
-     * @param options Optional parameters for tenant and user IDs
-     * @returns Root folder for the specified scope
      */
     getRoot(scope: AXPPlatformScope, options?: {
         tenantId?: string;
@@ -138,8 +146,6 @@ export declare class AXMDocumentManagerService implements AXMDocumentManagerServ
     }>;
     /**
      * Gets a specific folder by ID
-     * @param folderId The folder ID to retrieve
-     * @returns The requested folder
      */
     getFolder(scope: AXPPlatformScope, folderId: string, options?: {
         tenantId?: string;
@@ -148,68 +154,166 @@ export declare class AXMDocumentManagerService implements AXMDocumentManagerServ
         path: AXMDocumentExplorerNode[];
         result: AXMDocumentExplorerNode;
     }>;
+    /**
+     * Creates a new folder
+     */
     createFolder(data: AXMDocumentManagementFolderCreateDto): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Updates an existing folder
+     */
     updateFolder(folderId: string, data: UpdateFolderDto): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Deletes a folder
+     */
     deleteFolder(folderId: string): Promise<void>;
+    /**
+     * Gets available storage space
+     */
     getAvailableSpace(): Promise<number>;
-    private mapFileToNode;
+    /**
+     * Creates a new file
+     */
     createFile(data: CreateFileDto): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Updates an existing file
+     */
     updateFile(fileId: string, data: UpdateFileDto): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Deletes a file
+     */
     deleteFile(fileId: string): Promise<void>;
+    /**
+     * Opens a file
+     */
+    openFile(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Downloads a file
+     */
+    downloadFile(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Deletes multiple nodes (files and folders)
+     */
     deleteNodes(nodes: AXMDocumentExplorerNode[]): Promise<void>;
-    showCreateFolderDialog(parentId?: string): Promise<AXMDocumentExplorerNode | null>;
+    /**
+     * Creates a copy of a node (file or folder)
+     */
+    copy(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Moves a node to another location
+     */
     moveTo(options: {
         node: AXMDocumentExplorerNode;
+        scope: AXPPlatformScope;
         browseMode?: AXMDocumentExplorerBrowseMode;
         multiple?: boolean;
     }): Promise<boolean>;
+    /**
+     * Copies a node to another location
+     */
     copyTo(options: {
         node: AXMDocumentExplorerNode;
+        scope: AXPPlatformScope;
         browseMode?: AXMDocumentExplorerBrowseMode;
         multiple?: boolean;
     }): Promise<boolean>;
-    private mapDocumentToMediaViewerData;
-    showFileViewerPopup(node: AXMDocumentExplorerNode, options?: {
-        index?: number;
-        folderVituralfiles?: AXMDocumentExplorerNode[];
-    }): Promise<void>;
-    openFile(node: AXMDocumentExplorerNode): Promise<void>;
-    showRenamePopup(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode | undefined>;
-    showDeleteNodesDialog(nodeIds: AXMDocumentExplorerNode[]): Promise<boolean>;
+    /**
+     * Searches for folders by term within a scope
+     */
     searchFolders(searchTerm: string, scope: AXPPlatformScope, options?: {
         tenantId?: string;
         userId?: string;
     }): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Searches for files by term within a scope
+     */
     searchFiles(searchTerm: string, scope: AXPPlatformScope, options?: {
         tenantId?: string;
         userId?: string;
     }): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Searches for both files and folders by term within a scope
+     */
     searchNodes(searchTerm: string, scope: AXPPlatformScope, options?: {
         tenantId?: string;
         userId?: string;
     }): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Gets all folders
+     */
     getAllFolders(): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Gets all files with optional query
+     */
     getAllFiles(request?: AXPQueryRequest): Promise<AXMDocumentExplorerNode[]>;
-    getAllNodes(): Promise<AXMDocumentExplorerNode[]>;
-    showChooseFileDialog(scope: AXPPlatformScope): Promise<AXMDocumentExplorerNode[]>;
-    downloadFile(node: AXMDocumentExplorerNode): Promise<void>;
     /**
-     * Creates a copy of a node (file or folder)
-     * @param node The node to copy
-     * @returns The newly created copied node
+     * Gets all nodes (files and folders)
      */
-    copy(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode>;
+    getAllNodes(): Promise<AXMDocumentExplorerNode[]>;
     /**
-     * Creates a copy name by adding " copy" before the extension
-     * @param originalName The original filename
-     * @returns The new filename with " copy" added before the extension
+     * Uploads file by document type to a specific folder
      */
-    private createCopyName;
     uploadFileByType(folderId: string, docTypeId: string): Promise<boolean>;
+    /**
+     * Uploads virtual file by document type
+     */
     uploadFileVirtualByType(docType: AXMDocumentManagementDocumentTypeEntityModel): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Shows share dialog for a node
+     */
+    showShareDialog(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Shows share via email dialog for a node
+     */
+    showShareWithEmailDialog(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Shows link dialog for a node
+     */
+    showLinkDialog(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Shows lock dialog for a document
+     */
+    showLockDialog(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Shows unlock dialog for a document
+     */
+    showUnlockDialog(node: AXMDocumentExplorerNode): Promise<void>;
+    /**
+     * Shows folder edit dialog
+     */
+    showFolderEditDialog(node: AXMDocumentExplorerNode): Promise<boolean>;
+    /**
+     * Shows create folder dialog
+     */
+    showCreateFolderDialog(parentId?: string): Promise<AXMDocumentExplorerNode | null>;
+    /**
+     * Shows rename popup for a node
+     */
+    showRenamePopup(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode | undefined>;
+    /**
+     * Shows delete nodes confirmation dialog
+     */
+    showDeleteNodesDialog(nodeIds: AXMDocumentExplorerNode[]): Promise<boolean>;
+    /**
+     * Shows choose file dialog
+     */
+    showChooseFileDialog(scope: AXPPlatformScope): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Shows file viewer popup
+     */
+    showFileViewerPopup(node: AXMDocumentExplorerNode, options?: {
+        index?: number;
+        folderVirtualFiles?: AXMDocumentExplorerNode[];
+    }): Promise<void>;
+    /**
+     * Updates a file name
+     */
+    updateFileName(node: AXMDocumentExplorerNode, name: string): Promise<AXMDocumentExplorerNode>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXMDocumentManagerService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXMDocumentManagerService>;
 }
+/**
+ * Scoped drive service for specific platform scopes
+ */
 export declare class ScopedDriveService {
     private parent;
     private scope;
@@ -218,26 +322,54 @@ export declare class ScopedDriveService {
         tenantId?: string;
         userId?: string;
     } | undefined);
+    /**
+     * Validates the scope options are appropriate for the selected scope
+     */
     private validateScopeOptions;
+    /**
+     * Gets root folder for this scope
+     */
     getRoot(): Promise<{
         path: AXMDocumentExplorerNode[];
         result: AXMDocumentExplorerNode;
     }>;
+    /**
+     * Gets folder for this scope
+     */
     getFolder(folderId: string): Promise<{
         path: AXMDocumentExplorerNode[];
         result: AXMDocumentExplorerNode;
     }>;
+    /**
+     * Creates folder in this scope
+     */
     createFolder(data: Omit<AXMDocumentManagementFolderCreateDto, 'tenantId' | 'userId'>): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Updates folder in this scope
+     */
     updateFolder(folderId: string, data: UpdateFolderDto): Promise<AXMDocumentExplorerNode>;
+    /**
+     * Deletes folder in this scope
+     */
     deleteFolder(folderId: string): Promise<void>;
+    /**
+     * Gets available space for this scope
+     */
     getAvailableSpace(): Promise<number>;
+    /**
+     * Searches folders in this scope
+     */
     searchFolders(searchTerm: string): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Searches files in this scope
+     */
     searchFiles(searchTerm: string): Promise<AXMDocumentExplorerNode[]>;
+    /**
+     * Searches nodes in this scope
+     */
     searchNodes(searchTerm: string): Promise<AXMDocumentExplorerNode[]>;
     /**
-     * Creates a copy of a node (file or folder)
-     * @param node The node to copy
-     * @returns The newly created copied node
+     * Creates a copy of a node in this scope
      */
     copy(node: AXMDocumentExplorerNode): Promise<AXMDocumentExplorerNode>;
 }

package/document-management/lib/features/shared/document-manager.types.d.ts

@@ -1,4 +1,5 @@
 import { AXMDocumentManagementDocumentEntityModel, AXMDocumentManagementDocumentTypeEntityModel, AXMDocumentManagementFolderEntityModel } from '../../entities';
+import { AXMDocumentInheritanceType } from '../../entities/folder/folder.types';
 export interface AXMDocumentExplorerNode {
     id: string;
     name: string;
@@ -16,7 +17,7 @@ export interface AXMDocumentExplorerNode {
     meta?: {
         [key: string]: any;
     };
-    inherit?: boolean;
+    inherit?: AXMDocumentInheritanceType;
 }
 export interface AXMNodeType extends AXMDocumentManagementDocumentTypeEntityModel {
 }

package/document-management/lib/features/shared/index.d.ts

@@ -1,2 +1,3 @@
 export * from './document-manager.service';
 export * from './components';
+export * from './document-manager.types';