obsidian-typings 2.43.3 → 2.44.2

package/dist/cjs/implementations.d.cts

@@ -1,14 +1,13 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { SearchQuery } from '@codemirror/search';
-import { ChangeDesc, Extension } from '@codemirror/state';
-import { EditorView, ViewUpdate } from '@codemirror/view';
-import { App as App$1, BrowserWindow } from 'electron';
-import { default as 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 { HighlightOutliner } from 'pdfjs-dist/types/src/display/editor/drawers/highlight.js';
-import { Application, Container, Graphics, ICanvas, Text as Text$1, TextStyle } from 'pixi.js';
+import type { SearchQuery } from '@codemirror/search';
+import type { ChangeDesc, Extension } from '@codemirror/state';
+import type { EditorView, ViewUpdate } from '@codemirror/view';
+import type { App as App$1, BrowserWindow } from 'electron';
+import type { default as moment$1 } from 'moment';
+import type { FSWatcher } from 'node:fs';
+import type { 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, 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 type { Application, Container, Graphics, ICanvas, Text as Text$1, TextStyle } from 'pixi.js';
 
 /** @public */
 export class GraphColorGroup {
@@ -28,6 +27,72 @@ export declare class CustomArrayDictImpl<T> implements CustomArrayDict<T> {
 	count(): number;
 }
 /** @public */
+export declare class HighlightOutline extends Outline {
+	constructor(outlines: unknown, box: unknown, lastPoint: any);
+	lastPoint: unknown;
+	get box(): Object | null;
+	get classNamesForOutlining(): string[];
+	/**
+	 * Serialize the outlines into the PDF page coordinate system.
+	 *
+	 * @param bbox - the bounding box of the annotation.
+	 * @param rotation - the rotation of the annotation.
+	 * @returns Serialized outlines.
+	 */
+	serialize(bbox: [
+		blX: string,
+		blY: string,
+		trX: string,
+		trY: string
+	], rotation: number): Array<Array<number>>;
+}
+/** @public */
+export declare class HighlightOutliner {
+	/**
+	 * Construct an outliner.
+	 * @param boxes - An array of axis-aligned rectangles.
+	 * @param borderWidth - The width of the border of the boxes, it
+	 *   allows to make the boxes bigger (or smaller).
+	 * @param innerMargin - The margin between the boxes and the
+	 *   outlines. It's important to not have a null innerMargin when we want to
+	 *   draw the outline else the stroked outline could be clipped because of its
+	 *   width.
+	 * @param isLTR - true if we're in LTR mode. It's used to determine
+	 *   the last point of the boxes.
+	 */
+	constructor(boxes: Array<Object>, borderWidth?: number, innerMargin?: number, isLTR?: boolean);
+	getOutlines(): HighlightOutline;
+}
+/** @public */
+export declare class Outline {
+	static PRECISION: number;
+	/**
+	 * The bounding box of the outline.
+	 *
+	 * @returns The bounding box of the outline.
+	 */
+	get box(): Object | null;
+	serialize(bbox: [
+		blX: string,
+		blY: string,
+		trX: string,
+		trY: string
+	], rotation: number): void;
+	static _normalizePagePoint(x: unknown, y: unknown, rotation: unknown): unknown[];
+	static _normalizePoint(x: unknown, y: unknown, parentWidth: unknown, parentHeight: unknown, rotation: unknown): number[];
+	static _rescale(src: unknown, tx: unknown, ty: unknown, sx: unknown, sy: unknown, dest: unknown): unknown;
+	static _rescaleAndSwap(src: unknown, tx: unknown, ty: unknown, sx: unknown, sy: unknown, dest: unknown): unknown;
+	static _translate(src: unknown, tx: unknown, ty: unknown, dest: unknown): unknown;
+	static createBezierPoints(x1: unknown, y1: unknown, x2: unknown, y2: unknown, x3: unknown, y3: unknown): number[];
+	static svgRound(x: unknown): number;
+	/**
+	 * Converts the outline to an SVG path.
+	 *
+	 * @returns The SVG path of the outline.
+	 */
+	toSVGPath(): string;
+}
+/** @public */
 export declare const FileExtension: {
 	readonly _3gp: "3gp";
 	readonly avif: "avif";
@@ -5185,7 +5250,7 @@ export interface PdfViewConstructor extends TypedViewConstructor<PdfView> {
  * Due to limitations of TypeScript, we cannot extend the Platform constant directly.
  * @example
  * ```ts
- * import { Platform } from 'obsidian';
+ * import type { Platform } from 'obsidian';
  * import type { PlatformEx } from 'obsidian-typings';
  * const platformEx = Platform as PlatformEx;
  * console.log(platformEx.canDisplayRibbon);
@@ -5271,7 +5336,7 @@ export interface Plugins {
 	/**
 	 * Get a plugin by ID
 	 */
-	getPlugin(id: string): Plugin$1 | null;
+	getPlugin(id: string): Plugin | null;
 	/**
 	 * Get the folder where plugins are stored
 	 */
@@ -5299,7 +5364,7 @@ export interface Plugins {
 	/**
 	 * Load a plugin by its ID
 	 */
-	loadPlugin(id: string): Promise<Plugin$1>;
+	loadPlugin(id: string): Promise<Plugin>;
 	/** @internal */
 	onRaw(e: unknown): void;
 	/** @internal - Save current plugin configs */
@@ -5319,7 +5384,7 @@ export interface Plugins {
 export interface PluginsManifestsRecord extends Record<string, PluginManifest> {
 }
 /** @public */
-export interface PluginsPluginsRecord extends Record<string, Plugin$1> {
+export interface PluginsPluginsRecord extends Record<string, Plugin> {
 }
 /** @public */
 export interface Pointer {

package/dist/cjs/types.d.cts

@@ -17,7 +17,6 @@ import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
 import type { 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, ObsidianProtocolHandler, 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 type { default as pdfjsLib } from 'pdfjs-dist';
-import type { HighlightOutliner } from 'pdfjs-dist/types/src/display/editor/drawers/highlight.js';
 import type { Application, Container, Graphics, ICanvas, Text as Text$1, TextStyle, default as PIXI } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
 import type { default as scrypt$1 } from 'scrypt-js';
@@ -3266,6 +3265,72 @@ export declare class CustomArrayDictImpl<T> implements CustomArrayDict<T> {
 	count(): number;
 }
 /** @public */
+export declare class HighlightOutline extends Outline {
+	constructor(outlines: unknown, box: unknown, lastPoint: any);
+	lastPoint: unknown;
+	get box(): Object | null;
+	get classNamesForOutlining(): string[];
+	/**
+	 * Serialize the outlines into the PDF page coordinate system.
+	 *
+	 * @param bbox - the bounding box of the annotation.
+	 * @param rotation - the rotation of the annotation.
+	 * @returns Serialized outlines.
+	 */
+	serialize(bbox: [
+		blX: string,
+		blY: string,
+		trX: string,
+		trY: string
+	], rotation: number): Array<Array<number>>;
+}
+/** @public */
+export declare class HighlightOutliner {
+	/**
+	 * Construct an outliner.
+	 * @param boxes - An array of axis-aligned rectangles.
+	 * @param borderWidth - The width of the border of the boxes, it
+	 *   allows to make the boxes bigger (or smaller).
+	 * @param innerMargin - The margin between the boxes and the
+	 *   outlines. It's important to not have a null innerMargin when we want to
+	 *   draw the outline else the stroked outline could be clipped because of its
+	 *   width.
+	 * @param isLTR - true if we're in LTR mode. It's used to determine
+	 *   the last point of the boxes.
+	 */
+	constructor(boxes: Array<Object>, borderWidth?: number, innerMargin?: number, isLTR?: boolean);
+	getOutlines(): HighlightOutline;
+}
+/** @public */
+export declare class Outline {
+	static PRECISION: number;
+	/**
+	 * The bounding box of the outline.
+	 *
+	 * @returns The bounding box of the outline.
+	 */
+	get box(): Object | null;
+	serialize(bbox: [
+		blX: string,
+		blY: string,
+		trX: string,
+		trY: string
+	], rotation: number): void;
+	static _normalizePagePoint(x: unknown, y: unknown, rotation: unknown): unknown[];
+	static _normalizePoint(x: unknown, y: unknown, parentWidth: unknown, parentHeight: unknown, rotation: unknown): number[];
+	static _rescale(src: unknown, tx: unknown, ty: unknown, sx: unknown, sy: unknown, dest: unknown): unknown;
+	static _rescaleAndSwap(src: unknown, tx: unknown, ty: unknown, sx: unknown, sy: unknown, dest: unknown): unknown;
+	static _translate(src: unknown, tx: unknown, ty: unknown, dest: unknown): unknown;
+	static createBezierPoints(x1: unknown, y1: unknown, x2: unknown, y2: unknown, x3: unknown, y3: unknown): number[];
+	static svgRound(x: unknown): number;
+	/**
+	 * Converts the outline to an SVG path.
+	 *
+	 * @returns The SVG path of the outline.
+	 */
+	toSVGPath(): string;
+}
+/** @public */
 export declare const FileExtension: {
 	readonly _3gp: "3gp";
 	readonly avif: "avif";