chore(core): cleanup deprecation notices (#1527)

* chore(core): cleanup `getNodes` usage from Pane

* chore(core): cleanup deprecation notices

Author: bcakmakoglu

packages/core/src/container/Pane/Pane.vue

@@ -12,7 +12,7 @@ const { isSelecting, selectionKeyPressed } = defineProps<{ isSelecting: boolean;
 
 const {
   vueFlowRef,
-  getNodes,
+  nodes,
   viewport,
   emits,
   userSelectionActive,
@@ -171,7 +171,7 @@ function onPointerMove(event: PointerEvent) {
   }
 
   const selectedNodes = getNodesInside(
-    getNodes.value,
+    nodes.value,
     nextUserSelectRect,
     viewport.value,
     selectionMode.value === SelectionMode.Partial,

packages/core/src/types/flow.ts

@@ -122,18 +122,30 @@ export enum SelectionMode {
 }
 
 export interface FlowExportObject {
+  /** exported nodes */
   nodes: Node[]
+  /** exported edges */
   edges: Edge[]
-  /** @deprecated use `viewport` instead */
+  /**
+   * exported viewport position
+   * @deprecated use {@link FlowExportObject.viewport} instead
+   */
   position: [x: number, y: number]
-  /** @deprecated use `viewport` instead */
+  /**
+   * exported zoom level
+   * @deprecated use {@link FlowExportObject.viewport} instead
+   */
   zoom: number
+  /** exported viewport (position + zoom) */
   viewport: ViewportTransform
 }
 
 export interface FlowProps {
   id?: string
-  /** @deprecated use `nodes` & `edges` instead */
+  /**
+   * all elements (nodes + edges)
+   * @deprecated use {@link FlowProps.nodes} & {@link FlowProps.nodes} instead
+   */
   modelValue?: Elements
   nodes?: Node[]
   edges?: Edge[]
@@ -186,13 +198,13 @@ export interface FlowProps {
   /** allow connection with click handlers, i.e. support touch devices */
   connectOnClick?: boolean
   /**
-   * @deprecated - will be removed in the next major version, changes will not be auto applied in the future
    * apply default change handlers for position, dimensions, adding/removing nodes. set this to false if you want to apply the changes manually
+   * @deprecated - will be removed in the next major version, changes will not be auto applied in the future
    */
   applyDefault?: boolean
   /**
-   * @deprecated - will be removed in the next major version
    * automatically create an edge when connection is triggered
+   * @deprecated - will be removed in the next major version
    */
   autoConnect?: boolean | Connector
   noDragClassName?: string
@@ -213,8 +225,10 @@ export interface FlowProps {
   autoPanOnNodeDrag?: boolean
 }
 
-// Todo: Remove in next major version
-/** @deprecated use `FlowProps` instead */
+/**
+ * All available VueFlow options
+ * @deprecated use the {@link FlowProps} type instead
+ */
 export type FlowOptions = FlowProps
 
 export interface FlowEmits {

packages/core/src/types/store.ts

@@ -8,6 +8,7 @@ import type {
   FlowElements,
   FlowExportObject,
   FlowOptions,
+  FlowProps,
   Rect,
   SelectionMode,
   SelectionRect,
@@ -41,7 +42,7 @@ export interface UpdateNodeDimensionsParams {
   forceUpdate?: boolean
 }
 
-export interface State extends Omit<FlowOptions, 'id' | 'modelValue'> {
+export interface State extends Omit<FlowProps, 'id' | 'modelValue'> {
   /** Vue flow element ref */
   vueFlowRef: HTMLDivElement | null
   /** Vue flow viewport element */
@@ -259,8 +260,8 @@ export interface Actions extends Omit<ViewportHelper, 'viewportInitialized'> {
   /** applies default node change handler */
   applyNodeChanges: (changes: NodeChange[]) => GraphNode[]
   /**
-   * @deprecated will be removed in the next major, use `addSelectedNodes`/`addSelectedEdges` instead
    * manually select elements and add to state
+   * @deprecated will be removed in the next major, use {@link Actions.addSelectedNodes} or {@link Actions.addSelectedEdges} instead
    */
   addSelectedElements: (elements: FlowElements) => void
   /** manually select edges and add to state */
@@ -334,23 +335,23 @@ export interface Getters {
   /** returns object containing current node types */
   getNodeTypes: Record<keyof DefaultNodeTypes | string, NodeComponent>
   /**
+   * get all elements
    * @deprecated - will be removed in next major version
-   * get all elements (filters hidden elements)
    */
   getElements: FlowElements
-  /**
-   * @deprecated - will be removed in next major version; use `useVisibleNodes` instead
-   * all visible nodes
-   */
+  /** all visible node */
   getNodes: GraphNode[]
+  /** all visible edges */
+  getEdges: GraphEdge[]
   /**
-   * @deprecated - will be removed in next major version; use `useVisibleEdges` instead
-   * all visible edges
+   * returns a node by id
+   * @deprecated use {@link Actions.findNode} instead
    */
-  getEdges: GraphEdge[]
-  /** @deprecated use {@link Actions.findNode} instead; returns a node by id */
   getNode: (id: string) => GraphNode | undefined
-  /** @deprecated use {@link Actions.findEdge} instead; returns an edge by id */
+  /**
+   * returns an edge by id
+   * @deprecated use {@link Actions.findEdge} instead
+   */
   getEdge: (id: string) => GraphEdge | undefined
   /** returns all currently selected elements */
   getSelectedElements: FlowElements
@@ -359,13 +360,13 @@ export interface Getters {
   /** returns all currently selected edges */
   getSelectedEdges: GraphEdge[]
   /**
-   * @deprecated - will be removed in next major version; use `useNodesInitialized` instead
    * returns all nodes that are initialized, i.e. they have actual dimensions
+   * @deprecated - will be removed in next major version; use {@link useNodesInitialized} instead
    */
   getNodesInitialized: GraphNode[]
   /**
-   * @deprecated - will be removed in next major version; use `useNodesInitialized` instead
    * returns a boolean flag whether all current nodes are initialized
+   * @deprecated - will be removed in next major version; use {@link useNodesInitialized} instead
    */
   areNodesInitialized: boolean
 }