obsidian-typings 2.41.3 → 2.42.0

package/README.md

@@ -88,7 +88,7 @@ Be aware that the typings currently only cover a subset of the full API: while m
 To access types from the `obsidian` module, the import syntax does not change:
 
 ```ts
-import { App } from 'obsidian';
+import type { App } from 'obsidian';
 
 function printInternalPlugins(app: App): void {
   console.log(app.internalPlugins);
@@ -100,7 +100,7 @@ function printInternalPlugins(app: App): void {
 Additional interfaces added by this package (which do not exist in the official API), can be imported using:
 
 ```ts
-import { InternalPlugins } from 'obsidian-typings';
+import type { InternalPlugins } from 'obsidian-typings';
 
 const internalPlugins: InternalPlugins = this.app.internalPlugins;
 ```

package/dist/cjs/implementations.d.cts

@@ -7,7 +7,7 @@ import { App as App$1, BrowserWindow } from 'electron';
 import moment$1 from 'moment';
 import { FSWatcher } from 'node:fs';
 import { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Platform, Plugin as Plugin$1, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
-import { Application, Container, Graphics, Text as Text$1 } from 'pixi.js';
+import { Application, Container, Graphics, ICanvas, Text as Text$1, TextStyle } from 'pixi.js';
 
 /** @public */
 export class GraphColorGroup {
@@ -3333,6 +3333,15 @@ export interface GraphColorGroupOptionsGroup {
 	el: HTMLDivElement;
 	query: TextComponent;
 }
+/**
+ * Graph data.
+ *
+ * @public
+ */
+export interface GraphData {
+	nodes: Record<string, GraphNode>;
+	weights: Record<string, number>;
+}
 /** @public */
 export interface GraphDisplayOptions extends GraphOptions {
 }
@@ -3405,6 +3414,17 @@ export interface GraphFilterOptions extends GraphOptions {
 /** @public */
 export interface GraphForceOptions extends GraphOptions {
 }
+/**
+ * Graph forces.
+ *
+ * @public
+ */
+export interface GraphForces {
+	centerStrength?: number;
+	linkDistance?: number;
+	linkStrength?: number;
+	repelStrength?: number;
+}
 /** @public */
 export interface GraphLink {
 	/** @internal */
@@ -3489,11 +3509,21 @@ export interface GraphNode {
 	 * @returns The size of the node
 	 */
 	getSize(): number;
+	/**
+	 * Get the text style of the node.
+	 *
+	 * @returns The text style of the node.
+	 */
+	getTextStyle(): TextStyle;
 	/**
 	 * Initialize the node, text, listeners, and add them to the scene
 	 * @internal
 	 */
 	initGraphics(): void;
+	/**
+	 * Render the node.
+	 */
+	render(): void;
 }
 /** @public */
 export interface GraphOptions extends TreeItem<unknown> {
@@ -3553,42 +3583,60 @@ export interface GraphPluginInstanceOptions {
 export interface GraphRenderer {
 	/** @internal */
 	colors: Record<GraphColor, GraphColorAttributes>;
+	containerEl: HTMLDivElement;
 	/** @internal */
 	dragNode: GraphNode | null;
 	/** @internal */
 	fLineSizeMult: number;
 	/** @internal */
 	fNodeSizeMult: number;
+	fShowArrow: boolean;
+	fTextShowMult: number;
 	/** @internal */
 	hanger: Container;
 	/** @internal */
 	height: number;
+	hidePowerTag: boolean;
+	highlightNode: GraphNode | null;
 	/** @internal */
 	idleFrames: number;
 	/** @internal */
+	iframeEl: HTMLIFrameElement;
+	/** @internal */
 	interactiveEl: HTMLCanvasElement;
+	keyboardActions: KeyboardActions;
 	/** @internal */
 	links: GraphLink[];
+	mouseX: null;
+	mouseY: null;
+	nodeLookup: Record<string, GraphNode>;
 	/** @internal */
 	nodes: GraphNode[];
 	/** @internal */
 	nodeScale: number;
+	panning: boolean;
+	panvX: number;
+	panvY: number;
 	/** @internal */
 	panX: number;
 	/** @internal */
 	panY: number;
+	powerTag: PowerTag;
 	/** @internal */
 	px: Application;
+	renderTimer: null | number;
 	/** @internal */
 	scale: number;
 	/** @internal */
 	targetScale: number;
+	textAlpha: number;
 	/** @internal */
 	viewport: Coords;
 	/** @internal */
 	width: number;
 	/** @internal */
 	worker: Worker;
+	workerResults: WorkerResults;
 	/** @internal */
 	zoomCenterX: number;
 	/** @internal */
@@ -3596,15 +3644,42 @@ export interface GraphRenderer {
 	/**
 	 * Specify that the renderer has changed and needs to be rendered again
 	 */
-	changed(): unknown;
+	changed(): void;
+	destroy(): void;
+	/** @internal */
+	destroyGraphics(): void;
+	getBackgroundScreenshot(): HTMLCanvasElement;
 	/** @internal */
-	getHighlightNode(): GraphNode;
+	getHighlightNode(): GraphNode | null;
+	getTransparentScreenshot(): ICanvas;
+	/** @internal */
+	initGraphics(): void;
+	onIframeLoad(): void;
+	onIframeUnload(): void;
+	onMouseMove(evt: MouseEvent): void;
+	onNodeClick(evt: MouseEvent, id: string, type: string): void;
+	onNodeHover(evt: MouseEvent, id: string, type: string): void;
+	onNodeRightClick(evt: MouseEvent, id: string, type: string): void;
+	onNodeUnhover(): void;
+	onPointerDown(renderer: GraphRenderer, evt: PointerEvent): void;
+	onPointerOut(): void;
+	onPointerOver(renderer: GraphRenderer, evt: PointerEvent): void;
+	onResize(): void;
+	onWheel(evt: WheelEvent): void;
+	queueRender(): void;
 	/** @internal */
 	renderCallback(): void;
+	resetPan(): void;
+	setData(data: GraphData): void;
+	setForces(forces: GraphForces): void;
 	/** @internal */
 	setPan(panX: number, panY: number): void;
+	setRenderOptions(options: GraphPluginInstanceOptions): void;
 	/** @internal */
 	setScale(scale: number): void;
+	testCSS(): void;
+	updateZoom(): void;
+	zoomTo(scale: number, pointer: Pointer): void;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -4019,6 +4094,20 @@ export interface KeyScope {
 	 */
 	func(): void;
 }
+/**
+ * Keyboard actions.
+ *
+ * @public
+ */
+export interface KeyboardActions {
+	down?: boolean;
+	left?: boolean;
+	right?: boolean;
+	shift?: boolean;
+	up?: boolean;
+	zoomin?: boolean;
+	zoomout?: boolean;
+}
 /** @todo Documentation incomplete */
 /** @public */
 export interface LeafEntry {
@@ -5209,6 +5298,20 @@ export interface Pointer {
 /** @public */
 export interface PositionedReference extends Reference, CacheItem {
 }
+/**
+ * Power tag.
+ *
+ * @public
+ */
+export interface PowerTag {
+	rendered: boolean;
+	renderer: GraphRenderer;
+	text: Text$1;
+	clearGraphics(): void;
+	getTextStyle(): TextStyle;
+	initGraphics(): void;
+	render(): void;
+}
 /** @public */
 export interface PromisedQueue {
 	promise: Promise<unknown>;
@@ -6583,6 +6686,16 @@ export interface WordCountPluginInstance extends InternalPluginInstance<WordCoun
 	defaultOn: true;
 	plugin: WordCountPlugin;
 }
+/**
+ * Worker results.
+ *
+ * @public
+ */
+export interface WorkerResults {
+	buffer: SharedArrayBuffer;
+	id: number[];
+	v?: number;
+}
 /** @public */
 export interface WorkspaceHoverLinkSourcesRecord extends Record<string, HoverLinkSource> {
 }

package/dist/cjs/types.d.cts

@@ -12,7 +12,7 @@ import { FSWatcher, Stats } from 'node:fs';
 import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
 import { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, Constructor, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice as _Notice, ObsidianProtocolData, PaneType, Platform, Plugin as Plugin, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, request as _request, requestUrl as _requestUrl } from 'obsidian';
-import { Application, Container, Graphics, Text as Text$1 } from 'pixi.js';
+import { Application, Container, Graphics, ICanvas, Text as Text$1, TextStyle } from 'pixi.js';
 import _TurndownService from 'turndown';
 
 declare global {
@@ -370,7 +370,6 @@ declare module "obsidian" {
 		 * @param normalizedNewPath New path to file
 		 * @param shouldSkipDeletionTimeout Whether the deletion timeout should be skipped (default: `true`)
 		 * @returns A promise that resolves when the file is reconciled
-		 *
 		 * @internal
 		 */
 		reconcileDeletion(normalizedPath: string, normalizedNewPath: string, shouldSkipDeletionTimeout?: boolean): Promise<void>;
@@ -381,7 +380,6 @@ declare module "obsidian" {
 		 * @param normalizedNewPath New path to file
 		 * @param shouldSkipDeletionTimeout Whether the deletion timeout should be skipped - applies only to {@link reconcileDeletion}
 		 * @returns A promise that resolves when the file is reconciled
-		 *
 		 * @internal
 		 */
 		reconcileFile(normalizedPath: string, normalizedNewPath: string, shouldSkipDeletionTimeout?: boolean): Promise<void>;
@@ -1191,9 +1189,13 @@ declare module "obsidian" {
 		 */
 		insertBlock(start: string, end: string): void;
 		/**
-		 * Get the closest character position to the specified coordinates
+		 * Get the closest character position to the specified coordinates.
+		 *
+		 * @param x - The `x` coordinate.
+		 * @param y - The `y` coordinate.
+		 * @returns The closest character position to the specified coordinates.
 		 */
-		posAtCoords(coords: CoordsLeftTop): EditorPosition;
+		posAtCoords(x: number, y: number): EditorPosition;
 		/**
 		 * Removes all highlights of specified class
 		 */
@@ -6613,6 +6615,15 @@ export interface GraphColorGroupOptionsGroup {
 	el: HTMLDivElement;
 	query: TextComponent;
 }
+/**
+ * Graph data.
+ *
+ * @public
+ */
+export interface GraphData {
+	nodes: Record<string, GraphNode>;
+	weights: Record<string, number>;
+}
 /** @public */
 export interface GraphDisplayOptions extends GraphOptions {
 }
@@ -6685,6 +6696,17 @@ export interface GraphFilterOptions extends GraphOptions {
 /** @public */
 export interface GraphForceOptions extends GraphOptions {
 }
+/**
+ * Graph forces.
+ *
+ * @public
+ */
+export interface GraphForces {
+	centerStrength?: number;
+	linkDistance?: number;
+	linkStrength?: number;
+	repelStrength?: number;
+}
 /** @public */
 export interface GraphLink {
 	/** @internal */
@@ -6769,11 +6791,21 @@ export interface GraphNode {
 	 * @returns The size of the node
 	 */
 	getSize(): number;
+	/**
+	 * Get the text style of the node.
+	 *
+	 * @returns The text style of the node.
+	 */
+	getTextStyle(): TextStyle;
 	/**
 	 * Initialize the node, text, listeners, and add them to the scene
 	 * @internal
 	 */
 	initGraphics(): void;
+	/**
+	 * Render the node.
+	 */
+	render(): void;
 }
 /** @public */
 export interface GraphOptions extends TreeItem<unknown> {
@@ -6833,42 +6865,60 @@ export interface GraphPluginInstanceOptions {
 export interface GraphRenderer {
 	/** @internal */
 	colors: Record<GraphColor, GraphColorAttributes>;
+	containerEl: HTMLDivElement;
 	/** @internal */
 	dragNode: GraphNode | null;
 	/** @internal */
 	fLineSizeMult: number;
 	/** @internal */
 	fNodeSizeMult: number;
+	fShowArrow: boolean;
+	fTextShowMult: number;
 	/** @internal */
 	hanger: Container;
 	/** @internal */
 	height: number;
+	hidePowerTag: boolean;
+	highlightNode: GraphNode | null;
 	/** @internal */
 	idleFrames: number;
 	/** @internal */
+	iframeEl: HTMLIFrameElement;
+	/** @internal */
 	interactiveEl: HTMLCanvasElement;
+	keyboardActions: KeyboardActions;
 	/** @internal */
 	links: GraphLink[];
+	mouseX: null;
+	mouseY: null;
+	nodeLookup: Record<string, GraphNode>;
 	/** @internal */
 	nodes: GraphNode[];
 	/** @internal */
 	nodeScale: number;
+	panning: boolean;
+	panvX: number;
+	panvY: number;
 	/** @internal */
 	panX: number;
 	/** @internal */
 	panY: number;
+	powerTag: PowerTag;
 	/** @internal */
 	px: Application;
+	renderTimer: null | number;
 	/** @internal */
 	scale: number;
 	/** @internal */
 	targetScale: number;
+	textAlpha: number;
 	/** @internal */
 	viewport: Coords;
 	/** @internal */
 	width: number;
 	/** @internal */
 	worker: Worker;
+	workerResults: WorkerResults;
 	/** @internal */
 	zoomCenterX: number;
 	/** @internal */
@@ -6876,15 +6926,42 @@ export interface GraphRenderer {
 	/**
 	 * Specify that the renderer has changed and needs to be rendered again
 	 */
-	changed(): unknown;
+	changed(): void;
+	destroy(): void;
 	/** @internal */
-	getHighlightNode(): GraphNode;
+	destroyGraphics(): void;
+	getBackgroundScreenshot(): HTMLCanvasElement;
+	/** @internal */
+	getHighlightNode(): GraphNode | null;
+	getTransparentScreenshot(): ICanvas;
+	/** @internal */
+	initGraphics(): void;
+	onIframeLoad(): void;
+	onIframeUnload(): void;
+	onMouseMove(evt: MouseEvent): void;
+	onNodeClick(evt: MouseEvent, id: string, type: string): void;
+	onNodeHover(evt: MouseEvent, id: string, type: string): void;
+	onNodeRightClick(evt: MouseEvent, id: string, type: string): void;
+	onNodeUnhover(): void;
+	onPointerDown(renderer: GraphRenderer, evt: PointerEvent): void;
+	onPointerOut(): void;
+	onPointerOver(renderer: GraphRenderer, evt: PointerEvent): void;
+	onResize(): void;
+	onWheel(evt: WheelEvent): void;
+	queueRender(): void;
 	/** @internal */
 	renderCallback(): void;
+	resetPan(): void;
+	setData(data: GraphData): void;
+	setForces(forces: GraphForces): void;
 	/** @internal */
 	setPan(panX: number, panY: number): void;
+	setRenderOptions(options: GraphPluginInstanceOptions): void;
 	/** @internal */
 	setScale(scale: number): void;
+	testCSS(): void;
+	updateZoom(): void;
+	zoomTo(scale: number, pointer: Pointer): void;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -7299,6 +7376,20 @@ export interface KeyScope {
 	 */
 	func(): void;
 }
+/**
+ * Keyboard actions.
+ *
+ * @public
+ */
+export interface KeyboardActions {
+	down?: boolean;
+	left?: boolean;
+	right?: boolean;
+	shift?: boolean;
+	up?: boolean;
+	zoomin?: boolean;
+	zoomout?: boolean;
+}
 /** @todo Documentation incomplete */
 /** @public */
 export interface LeafEntry {
@@ -8489,6 +8580,20 @@ export interface Pointer {
 /** @public */
 export interface PositionedReference extends Reference, CacheItem {
 }
+/**
+ * Power tag.
+ *
+ * @public
+ */
+export interface PowerTag {
+	rendered: boolean;
+	renderer: GraphRenderer;
+	text: Text$1;
+	clearGraphics(): void;
+	getTextStyle(): TextStyle;
+	initGraphics(): void;
+	render(): void;
+}
 /** @public */
 export interface PromisedQueue {
 	promise: Promise<unknown>;
@@ -9863,6 +9968,16 @@ export interface WordCountPluginInstance extends InternalPluginInstance<WordCoun
 	defaultOn: true;
 	plugin: WordCountPlugin;
 }
+/**
+ * Worker results.
+ *
+ * @public
+ */
+export interface WorkerResults {
+	buffer: SharedArrayBuffer;
+	id: number[];
+	v?: number;
+}
 /** @public */
 export interface WorkspaceHoverLinkSourcesRecord extends Record<string, HoverLinkSource> {
 }