@topconsultnpm/sdkui-react 6.17.0-test9

package/lib/components/features/documents/TMRelationViewer.d.ts

@@ -0,0 +1,121 @@
+import React from 'react';
+import { DcmtTypeDescriptor, SearchResultDescriptor, DataColumnDescriptor } from "@topconsultnpm/sdk-ts";
+import { DcmtInfo } from '../../../ts';
+import { ITMTreeItem } from '../../base/TMTreeView';
+/**
+ * Tree item structure for relations
+ */
+export interface RelationTreeItem extends ITMTreeItem {
+    tid?: number;
+    did?: number;
+    dtd?: DcmtTypeDescriptor;
+    relationId?: number;
+    isManyToMany?: boolean;
+    isDcmt?: boolean;
+    isZero?: boolean;
+    isRoot?: boolean;
+    isMaster?: boolean;
+    isCorrelated?: boolean;
+    isLoaded?: boolean;
+    isSeparator?: boolean;
+    values?: any;
+    searchResult?: SearchResultDescriptor[];
+    itemsCount?: number;
+}
+/**
+ * Props for TMRelationViewer component
+ */
+export interface TMRelationViewerProps {
+    /** Array of input documents to display relations for */
+    inputDcmts: DcmtInfo[];
+    /** If true, loads master documents instead of detail documents */
+    isForMaster?: boolean;
+    /** Show current document indicator (pointing finger icon) */
+    showCurrentDcmtIndicator?: boolean;
+    /** Allow showing documents with 0 instances */
+    allowShowZeroDcmts?: boolean;
+    /** Initial state for showing zero documents */
+    initialShowZeroDcmts?: boolean;
+    /** Array of allowed TIDs to filter relations. If undefined, shows all */
+    allowedTIDs?: number[];
+    /** Allow multiple selection */
+    allowMultipleSelection?: boolean;
+    /** Currently focused item (controlled) */
+    focusedItem?: RelationTreeItem | null;
+    /** Currently selected items (controlled) */
+    selectedItems?: RelationTreeItem[];
+    /** Callback when focused item changes */
+    onFocusedItemChanged?: (item: RelationTreeItem | null) => void;
+    /** Callback when selected items change */
+    onSelectedItemsChanged?: (items: RelationTreeItem[]) => void;
+    /** Callback when a document is double-clicked */
+    onDocumentDoubleClick?: (tid: number, did: number, name?: string) => void;
+    /** Custom item renderer (full control). Return undefined to use default renderer. */
+    customItemRender?: (item: RelationTreeItem | null) => JSX.Element | undefined;
+    /** Custom document style function */
+    customDocumentStyle?: (item: RelationTreeItem) => React.CSSProperties;
+    /**
+     * Custom content renderer for the main container (when showMainDocument is false).
+     * Allows full control over the main container rendering including style and content.
+     * This replaces only the main container content, not the detail containers.
+     */
+    customMainContainerContent?: (item: RelationTreeItem, defaultContent: JSX.Element) => JSX.Element;
+    /** Custom document content renderer (partial control - replaces only metadata display) */
+    customDocumentContent?: (item: RelationTreeItem, defaultMetadataContent: JSX.Element) => JSX.Element;
+    /**
+     * Show metadata names before values (default: false).
+     * When true, displays "MetadataName: Value", otherwise just "Value".
+     * Value rendering respects DataDomain (uses TMDataListItemViewer for lists, TMUserIdViewer for users, etc.)
+     */
+    showMetadataNames?: boolean;
+    /** Maximum depth level for recursive loading (default: 2) */
+    maxDepthLevel?: number;
+    /**
+     * If true (default), when isForMaster=true shows: detail doc → master docs as children (inverted navigation)
+     * If false, when isForMaster=true shows: master docs → detail docs as children (original navigation)
+     */
+    invertMasterNavigation?: boolean;
+    /**
+     * Additional static items to append at the end of the tree.
+     * These items are not loaded dynamically - they must already contain all data.
+     * Useful for showing pre-calculated documents (e.g., additional documents in dossiers).
+     * Can include a separator item by marking it with `isSeparator: true`.
+     */
+    additionalStaticItems?: RelationTreeItem[];
+    /**
+     * If false, hides the main document node and shows detail containers directly under the main container.
+     * Default: true (show main document as intermediate node)
+     */
+    showMainDocument?: boolean;
+    /**
+     * Custom label for the main container when showMainDocument is false.
+     * If not provided, uses the document type name.
+     */
+    labelMainContainer?: string;
+}
+/**
+ * Check if document type has detail relations
+ */
+export declare const hasDetailRelations: (mTID: number | undefined) => Promise<boolean>;
+/**
+ * Check if document type has master relations
+ */
+export declare const hasMasterRelations: (dTID: number | undefined) => Promise<boolean>;
+/**
+ * Get metadata keys excluding system metadata
+ */
+export declare const getMetadataKeys: (obj: any) => string[];
+/**
+ * Get display value keys for a document (max 5, prioritize SYS_Abstract)
+ */
+export declare const getDcmtDisplayValue: (obj: any) => string[];
+/**
+ * Get display value formatted by column type
+ */
+export declare const getDisplayValueByColumn: (col: DataColumnDescriptor | undefined, value: any) => any;
+/**
+ * Convert SearchResultDescriptor to structured data source with metadata
+ */
+export declare const searchResultToDataSource: (searchResult: SearchResultDescriptor | undefined, hideSysMetadata?: boolean) => Promise<any[]>;
+declare const TMRelationViewer: React.FC<TMRelationViewerProps>;
+export default TMRelationViewer;