Updated types

Author: Developer-Mike

src/@types/Canvas.d.ts

@@ -1,4 +1,21 @@
-import { TFile } from "obsidian"
+import { TFile, View } from "obsidian"
+
+export interface Size {
+  width: number
+  height: number
+}
+
+export interface Position {
+  x: number
+  y: number
+}
+
+export interface BBox {
+  minX: number
+  maxX: number
+  minY: number
+  maxY: number
+}
 
 export interface Canvas {
   view: CanvasView
@@ -7,50 +24,49 @@ export interface Canvas {
   getData(): CanvasData
 
   nodes: Map<string, CanvasNode>
-  menu: PopupMenu
-  nodeInteractionLayer: NodeInteractionLayer
+  edges: Map<string, CanvasEdge>
+  getEdgesForNode(node: CanvasNode): CanvasEdge[]
 
   wrapperEl: HTMLElement
+  menu: PopupMenu
   cardMenuEl: HTMLElement
   canvasControlsEl: HTMLElement
   quickSettingsButton: HTMLElement
+  nodeInteractionLayer: NodeInteractionLayer
 
   canvasRect: DOMRect
+  getViewportBBox(): BBox
+  setViewport(tx: number, ty: number, tZoom: number): void
+  markViewportChanged(): void
+
   x: number
-  tx: number
   y: number
-  ty: number
   zoom: number
+
+  tx: number
+  ty: number
   tZoom: number
 
+  zoomToBbox(bbox: BBox): void
+  zoomToSelection(): void
+
   readonly: boolean
   setReadonly(readonly: boolean): void
 
   selection: Set<CanvasNode>
   getSelectionData(): SelectionData
   deselectAll(): void
 
-  getEdgesForNode(node: CanvasNode): CanvasEdge[]
-
+  dragTempNode(dragEvent: any, nodeSize: Size, onDropped: (position: Position) => void): void
   createTextNode(options: TextNodeOptions): CanvasNode
   createGroupNode(options: GroupNodeOptions): CanvasNode
   createFileNode(options: FileNodeOptions): CanvasNode
   removeNode(node: CanvasNode): void
 
-  dragTempNode(dragEvent: any, nodeSize: Size, onDropped: (position: Position) => void): void
-
-  setViewport(tx: number, ty: number, tZoom: number): void
-  markViewportChanged(): void
-
-  getViewportBBox(): BBox
-  zoomToBbox(bbox: BBox): void
-  zoomToSelection(): void
-
   undo(): void
   redo(): void
 
   handlePaste(): void
-  requestPushHistory(data: CanvasData): void
   requestSave(): void
 
   // Custom
@@ -70,29 +86,10 @@ export interface CanvasConfig {
   defaultTextNodeDimensions: Size
 }
 
-export interface CanvasView {
+export interface CanvasView extends View {
   file: TFile
 }
 
-export interface Size {
-  width: number
-  height: number
-}
-
-export interface Position {
-  x: number
-  y: number
-}
-
-export interface BBox {
-  minX: number
-  maxX: number
-  minY: number
-  maxY: number
-}
-
-type Side = 'top' | 'right' | 'bottom' | 'left'
-
 export interface NodeOptions {
   pos: Position
   size: Size
@@ -114,10 +111,11 @@ export interface FileNodeOptions extends NodeOptions {
 }
 
 export interface CanvasData {
-  nodes: CanvasNode[]
-  edges: CanvasEdge[]
+  nodes: CanvasNodeData[]
+  edges: CanvasEdgeData[]
 }
 
+export type CanvasNodeType = 'text' | 'group' | 'file' | 'link'
 export interface CanvasNodeData {
   type: CanvasNodeType
   shape: string
@@ -129,28 +127,24 @@ export interface CanvasNodeData {
 export interface CanvasNode {
   canvas: Canvas
   nodeEl: HTMLElement
-  bbox: BBox
   getBBox(): BBox
-  text?: string
+
   color: string
+
+  /** @deprecated Use `canvas.setNodeData` instead */
   setData(data: CanvasNodeData): void
   getData(): CanvasNodeData
 }
 
-export interface CanvasNodeUnknownData {
-}
-
-export type CanvasNodeType = 'text' | 'group' | 'file'
-
+type Side = 'top' | 'right' | 'bottom' | 'left'
 export interface CanvasEdgeData {
+  id: string
+
   fromNode: string
   toNode: string
 
   fromSide: Side
   toSide: Side
-
-  id: string
-  label?: string
 }
 
 export interface CanvasEdge {
@@ -172,11 +166,4 @@ export interface NodeInteractionLayer {
 export interface PopupMenu {
   menuEl: HTMLElement
   render(): void
-}
-
-export interface BBox {
-  minX: number
-  minY: number
-  maxX: number
-  maxY: number
 }

src/@types/Obsidian.d.ts

@@ -3,28 +3,28 @@ export * from "obsidian"
 declare module "obsidian" {
   export default interface App {
     /** @public */
-    keymap: Keymap;
+    keymap: Keymap
     /** @public */
-    scope: Scope;
-
+    scope: Scope
     /** @public */
-    vault: Vault;
+    vault: Vault
     /** @public */
-    metadataCache: MetadataCache;
-
+    metadataCache: MetadataCache
     /** @public */
-    fileManager: FileManager;
-
+    fileManager: FileManager
     /**
      * The last known user interaction event, to help commands find out what modifier keys are pressed.
      * @public
      */
-    lastEvent: UserEvent | null;
+    lastEvent: UserEvent | null
 
+    // Custom
     /** @public */
-    workspace:  Workspace & {
-      on(name: string, callback: (...args: any) => void): EventRef
-    }
+    workspace: Workspace & ExtendedWorkspace
+  }
+
+  export interface ExtendedWorkspace {
+    on(name: string, callback: (...args: any) => void): EventRef
   }
 
   export interface EventRef {

src/canvas-extensions/presentation-canvas-extension.ts

@@ -146,20 +146,20 @@ export default class PresentationCanvasExtension {
     if (animationDurationMs > 0 && fromNode) {
       const animationIntensity = this.plugin.settingsManager.getSetting('slideTransitionAnimationIntensity')
 
-      const currentNodeBBoxEnlarged = CanvasHelper.scaleBBox(fromNode.bbox, animationIntensity)
+      const currentNodeBBoxEnlarged = CanvasHelper.scaleBBox(fromNode.getBBox(), animationIntensity)
       if (useCustomZoomFunction) CanvasHelper.zoomToBBox(canvas, currentNodeBBoxEnlarged)
       else canvas.zoomToBbox(currentNodeBBoxEnlarged)
 
       await delay(animationDurationMs / 2)
 
-      const nextNodeBBoxEnlarged = CanvasHelper.scaleBBox(toNode.bbox, animationIntensity)
+      const nextNodeBBoxEnlarged = CanvasHelper.scaleBBox(toNode.getBBox(), animationIntensity)
       if (useCustomZoomFunction) CanvasHelper.zoomToBBox(canvas, nextNodeBBoxEnlarged)
       else canvas.zoomToBbox(nextNodeBBoxEnlarged)
 
       await delay(animationDurationMs / 2)
     }
 
-    let nodeBBox = toNode.bbox
+    let nodeBBox = toNode.getBBox()
     if (useCustomZoomFunction) CanvasHelper.zoomToBBox(canvas, nodeBBox)
     else canvas.zoomToBbox(nodeBBox)
   }