@myrmidon/paged-data-browsers 5.1.2 → 5.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myrmidon/paged-data-browsers",
-  "version": "5.1.2",
+  "version": "5.1.3",
   "description": "Generic simple paged data browsers.",
   "keywords": [
     "data browsers"

package/types/myrmidon-paged-data-browsers.d.ts

@@ -32,7 +32,7 @@ interface PagingInfo {
     total: number;
 }
 /**
- * A tree node with paging information, used in NodeBrowserStore.
+ * A tree node with paging information, used in PagedTreeStore.
  */
 interface PagedTreeNode<F extends TreeNodeFilter> extends TreeNode {
     paging: PagingInfo;
@@ -40,7 +40,7 @@ interface PagedTreeNode<F extends TreeNodeFilter> extends TreeNode {
     filter?: F;
 }
 /**
- * The interface to be implemented by the service used by NodeBrowserStore
+ * The interface to be implemented by the service used by PagedTreeStore
  * to load nodes.
  */
 interface PagedTreeStoreService<F extends TreeNodeFilter> {
@@ -194,9 +194,10 @@ declare class PagedTreeStore<E extends PagedTreeNode<F>, F extends TreeNodeFilte
      * Expand the node with the specified ID. If the node is not expandable,
      * or it is already expanded, this method does nothing.
      * @param node The ID of the node to expand.
+     * @param silent If true, don't clear hilites (used internally).
      * @returns Promise with true if the node was expanded, false otherwise.
      */
-    expand(id: number): Promise<boolean>;
+    expand(id: number, silent?: boolean): Promise<boolean>;
     /**
      * Expand all the descendants of the node with the specified ID.
      *
@@ -233,9 +234,10 @@ declare class PagedTreeStore<E extends PagedTreeNode<F>, F extends TreeNodeFilte
      * @param parentId The ID of the parent node whose children are inside the page
      * you want to change.
      * @param pageNumber The new page number.
+     * @param silent If true, don't clear hilites (used internally).
      * @returns Promise with true if the page was changed, false otherwise.
      */
-    changePage(parentId: number, pageNumber: number): Promise<boolean>;
+    changePage(parentId: number, pageNumber: number, silent?: boolean): Promise<boolean>;
     /**
      * Clear the store. The cache is cleared and the nodes are removed.
      */
@@ -277,10 +279,10 @@ declare class PagedTreeStore<E extends PagedTreeNode<F>, F extends TreeNodeFilte
      */
     private searchNodeAndDescendants;
     /**
-     * Ensure a node is visible by expanding all its ancestors.
-     * @param nodeId The ID of the node to make visible.
+     * Ensure all ancestors of a node are expanded (used internally by findLabels).
+     * @param nodeId The ID of the node whose ancestors should be expanded.
      */
-    private ensureNodeVisible;
+    private ensureAncestorsExpandedInternal;
     private get _isEditable();
     private get _editableService();
     /**
@@ -337,6 +339,58 @@ declare class PagedTreeStore<E extends PagedTreeNode<F>, F extends TreeNodeFilte
      * Clear all unsaved changes.
      */
     clearUnsavedChanges(): void;
+    /**
+     * Ensure that the node with the specified ID is visible in the tree.
+     * This method will:
+     * 1. Optionally refresh data by clearing cache
+     * 2. Find the node and determine which page it's on
+     * 3. Expand all ancestor nodes to make it visible
+     * 4. Navigate to the page containing the node
+     * 5. Optionally set the node's expanded/collapsed state
+     *
+     * @param id The ID of the node to make visible.
+     * @param expanded If true, expand the node; if false, collapse it; if undefined, don't change.
+     * @param refresh If true, clear cache to reload data from service.
+     * @returns Promise that resolves to true if successful, false otherwise.
+     */
+    ensureNodeVisible(id: number, expanded?: boolean, refresh?: boolean): Promise<boolean>;
+    /**
+     * Find and load a node that is not currently visible by querying the service
+     * to build the path from root to the target node, then expand only the nodes
+     * on that path.
+     * @param id The ID of the node to find.
+     * @returns The node if found, undefined otherwise.
+     */
+    private findAndLoadNode;
+    /**
+     * Find the path from root to a target node by querying the service.
+     * @param targetId The ID of the target node.
+     * @returns Array of nodes from root to target, or undefined if not found.
+     */
+    private findNodePath;
+    /**
+     * Ensure all ancestors of a node are expanded.
+     * @param nodeId The ID of the node whose ancestors should be expanded.
+     */
+    private ensureAncestorsExpanded;
+    /**
+     * Get all siblings of a node, including those not currently visible.
+     * @param node The node whose siblings to retrieve.
+     * @returns Array of all siblings.
+     */
+    private getAllSiblings;
+    /**
+     * Get the ID of the node that should be selected after deleting the
+     * node with the specified ID. This follows the priority:
+     * 1. Next sibling of the deleted node
+     * 2. Previous sibling of the deleted node
+     * 3. Parent node of the deleted node
+     * 4. null if none of the above exist
+     *
+     * @param id The ID of the node to be deleted.
+     * @returns The ID of the anchor node, or null if none can be determined.
+     */
+    getAnchorForDeletedNode(id: number): number | null;
 }
 
 declare class CompactPagerComponent {