From c8c77a2967c03662a30c324202426ace19622b8c Mon Sep 17 00:00:00 2001
From: braks <78412429+bcakmakoglu@users.noreply.github.com>
Date: Mon, 5 Feb 2024 13:30:48 +0100
Subject: [PATCH] refactor(core): deprecate getters

---
 packages/core/src/types/store.ts | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/packages/core/src/types/store.ts b/packages/core/src/types/store.ts
index 5e99d9a0..b7a807aa 100644
--- a/packages/core/src/types/store.ts
+++ b/packages/core/src/types/store.ts
@@ -321,11 +321,20 @@ export interface Getters {
   getEdgeTypes: Record<keyof DefaultEdgeTypes | string, EdgeComponent>
   /** returns object containing current node types */
   getNodeTypes: Record<keyof DefaultNodeTypes | string, NodeComponent>
-  /** get all elements (filters hidden elements) */
+  /**
+   * @deprecated - will be removed in next major version
+   * get all elements (filters hidden elements)
+   */
   getElements: FlowElements
-  /** filters hidden nodes */
+  /**
+   * @deprecated - will be removed in next major version; use `useVisibleNodes` instead
+   * all visible nodes
+   */
   getNodes: GraphNode[]
-  /** filters hidden edges */
+  /**
+   * @deprecated - will be removed in next major version; use `useVisibleEdges` instead
+   * all visible edges
+   */
   getEdges: GraphEdge[]
   /** @deprecated use {@link Actions.findNode} instead; returns a node by id */
   getNode: (id: string) => GraphNode | undefined
@@ -337,9 +346,15 @@ export interface Getters {
   getSelectedNodes: GraphNode[]
   /** returns all currently selected edges */
   getSelectedEdges: GraphEdge[]
-  /** returns all nodes that are initialized, i.e. they have actual dimensions */
+  /**
+   * @deprecated - will be removed in next major version; use `useNodesInitialized` instead
+   * returns all nodes that are initialized, i.e. they have actual dimensions
+   */
   getNodesInitialized: GraphNode[]
-  /** returns a boolean flag whether all current nodes are initialized */
+  /**
+   * @deprecated - will be removed in next major version; use `useNodesInitialized` instead
+   * returns a boolean flag whether all current nodes are initialized
+   */
   areNodesInitialized: boolean
 }