obsidian-typings 3.15.0 → 3.16.0

package/dist/cjs/implementations.d.cts

@@ -4374,21 +4374,36 @@ export interface ElectronWindow extends BrowserWindow {
 	devToolsWebContents: unknown;
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded audio file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedAudioComponent extends Component {
+export interface EmbedAudioComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded canvas file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedCanvasComponent extends Component {
+export interface EmbedCanvasComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * The component that renders the embedded file.
+ *
+ * @public
+ * @unofficial
+ */
+export interface EmbedComponent extends Component {
+	/**
+	 * Load the file into the component.
+	 */
+	loadFile(): void;
+}
+/**
+ * A context to configure embedding of a file.
+ *
  * @public
  * @unofficial
  */
@@ -4425,28 +4440,32 @@ export interface EmbedContext {
 	state?: unknown;
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded image file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedImageComponent extends Component {
+export interface EmbedImageComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded markdown file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedMarkdownComponent extends Component {
+export interface EmbedMarkdownComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded PDF file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedPdfComponent extends Component {
+export interface EmbedPdfComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A registry for embeddable files components.
+ *
  * @public
  * @unofficial
  */
@@ -4458,7 +4477,7 @@ export interface EmbedRegistry extends Events {
 	/**
 	 * Get the embed constructor for a specific file type.
 	 */
-	getEmbedCreator(file: TFile): EmbeddableConstructor | null;
+	getEmbedCreator(file: TFile): EmbedCreator | null;
 	/**
 	 * Check whether a file extension has a registered embed constructor.
 	 */
@@ -4466,11 +4485,11 @@ export interface EmbedRegistry extends Events {
 	/**
 	 * Register an embed constructor for a specific file extension.
 	 */
-	registerExtension(extension: string, embedCreator: EmbeddableConstructor): void;
+	registerExtension(extension: string, embedCreator: EmbedCreator): void;
 	/**
 	 * Register an embed constructor for a list of file extensions.
 	 */
-	registerExtensions(extensions: string[], embedCreator: EmbeddableConstructor): void;
+	registerExtensions(extensions: string[], embedCreator: EmbedCreator): void;
 	/**
 	 * Unregister an embed constructor for a specific file extension.
 	 */
@@ -4481,66 +4500,116 @@ export interface EmbedRegistry extends Events {
 	unregisterExtensions(extensions: string[]): void;
 }
 /**
- * @todo Documentation incomplete.
+ * A record of embeddable file extensions and their creators.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, EmbeddableConstructor> {
-	/** @todo Documentation incomplete. */
+export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, EmbedCreator> {
+	/**
+	 * Creates an embed component for a 3GP file.
+	 */
 	[FileExtension._3gp]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an AVIF file.
+	 */
 	[FileExtension.avif]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a BMP file.
+	 */
 	[FileExtension.bmp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a canvas file.
+	 */
 	[FileExtension.canvas]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedCanvasComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a FLAC file.
+	 */
 	[FileExtension.flac]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a GIF file.
+	 */
 	[FileExtension.gif]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a JPEG file.
+	 */
 	[FileExtension.jpeg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a JPG file.
+	 */
 	[FileExtension.jpg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an M4A file.
+	 */
 	[FileExtension.m4a]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a markdown file.
+	 */
 	[FileExtension.md]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedMarkdownComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a MKV file.
+	 */
 	[FileExtension.mkv]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a MOV file.
+	 */
 	[FileExtension.mov]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an MP3 file.
+	 */
 	[FileExtension.mp3]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an MP4 file.
+	 */
 	[FileExtension.mp4]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OGA file.
+	 */
 	[FileExtension.oga]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OGG file.
+	 */
 	[FileExtension.ogg]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OGV file.
+	 */
 	[FileExtension.ogv]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OPUS file.
+	 */
 	[FileExtension.opus]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a PDF file.
+	 */
 	[FileExtension.pdf]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedPdfComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a PNG file.
+	 */
 	[FileExtension.png]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an SVG file.
+	 */
 	[FileExtension.svg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a WAV file.
+	 */
 	[FileExtension.wav]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a WEBM file.
+	 */
 	[FileExtension.webm]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a WEBP file.
+	 */
 	[FileExtension.webp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded video file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedVideoComponent extends Component {
+export interface EmbedVideoComponent extends EmbedComponent {
 }
 /**
  * @todo Documentation incomplete.
@@ -9812,13 +9881,9 @@ export interface SuggestionContainer<T> {
 	 * @remark Prefer setSelectedItem, which clamps the index to within suggestions array.
 	 */
 	forceSetSelectedItem(index: number, event: Event): void;
-	/**
-	 * @todo Documentation incomplete.
-	 */
+	/** @todo Documentation incomplete. */
 	getSelectedElement(): HTMLElement | null;
-	/**
-	 * @todo Documentation incomplete.
-	 */
+	/** @todo Documentation incomplete. */
 	getSelectedValue(): SearchResult | null;
 	/**
 	 * Move selected item to next suggestion.
@@ -11427,12 +11492,17 @@ export type ContentPosition = [
 	endOffset: number
 ];
 /**
- * @todo Documentation incomplete.
+ * Creates an embed component for a given file.
+ *
+ * @param context - Context used to embed the file.
+ * @param file - File to embed.
+ * @param subpath - Optional subpath within the file.
+ * @returns An embed component.
  *
  * @public
  * @unofficial
  */
-export type EmbeddableConstructor = (context: EmbedContext, file: TFile, subpath?: string) => Component;
+export type EmbedCreator = (context: EmbedContext, file: TFile, subpath?: string) => EmbedComponent;
 /**
  * @todo Documentation incomplete.
  *

package/dist/cjs/types.d.cts

@@ -20519,21 +20519,36 @@ export interface ElectronWindow extends BrowserWindow {
 	devToolsWebContents: unknown;
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded audio file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedAudioComponent extends Component {
+export interface EmbedAudioComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded canvas file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedCanvasComponent extends Component {
+export interface EmbedCanvasComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * The component that renders the embedded file.
+ *
+ * @public
+ * @unofficial
+ */
+export interface EmbedComponent extends Component {
+	/**
+	 * Load the file into the component.
+	 */
+	loadFile(): void;
+}
+/**
+ * A context to configure embedding of a file.
+ *
  * @public
  * @unofficial
  */
@@ -20570,28 +20585,32 @@ export interface EmbedContext {
 	state?: unknown;
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded image file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedImageComponent extends Component {
+export interface EmbedImageComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded markdown file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedMarkdownComponent extends Component {
+export interface EmbedMarkdownComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded PDF file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedPdfComponent extends Component {
+export interface EmbedPdfComponent extends EmbedComponent {
 }
 /**
- * @todo Documentation incomplete.
+ * A registry for embeddable files components.
+ *
  * @public
  * @unofficial
  */
@@ -20603,7 +20622,7 @@ export interface EmbedRegistry extends Events {
 	/**
 	 * Get the embed constructor for a specific file type.
 	 */
-	getEmbedCreator(file: TFile): EmbeddableConstructor | null;
+	getEmbedCreator(file: TFile): EmbedCreator | null;
 	/**
 	 * Check whether a file extension has a registered embed constructor.
 	 */
@@ -20611,11 +20630,11 @@ export interface EmbedRegistry extends Events {
 	/**
 	 * Register an embed constructor for a specific file extension.
 	 */
-	registerExtension(extension: string, embedCreator: EmbeddableConstructor): void;
+	registerExtension(extension: string, embedCreator: EmbedCreator): void;
 	/**
 	 * Register an embed constructor for a list of file extensions.
 	 */
-	registerExtensions(extensions: string[], embedCreator: EmbeddableConstructor): void;
+	registerExtensions(extensions: string[], embedCreator: EmbedCreator): void;
 	/**
 	 * Unregister an embed constructor for a specific file extension.
 	 */
@@ -20626,66 +20645,116 @@ export interface EmbedRegistry extends Events {
 	unregisterExtensions(extensions: string[]): void;
 }
 /**
- * @todo Documentation incomplete.
+ * A record of embeddable file extensions and their creators.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, EmbeddableConstructor> {
-	/** @todo Documentation incomplete. */
+export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, EmbedCreator> {
+	/**
+	 * Creates an embed component for a 3GP file.
+	 */
 	[FileExtension._3gp]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an AVIF file.
+	 */
 	[FileExtension.avif]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a BMP file.
+	 */
 	[FileExtension.bmp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a canvas file.
+	 */
 	[FileExtension.canvas]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedCanvasComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a FLAC file.
+	 */
 	[FileExtension.flac]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a GIF file.
+	 */
 	[FileExtension.gif]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a JPEG file.
+	 */
 	[FileExtension.jpeg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a JPG file.
+	 */
 	[FileExtension.jpg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an M4A file.
+	 */
 	[FileExtension.m4a]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a markdown file.
+	 */
 	[FileExtension.md]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedMarkdownComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a MKV file.
+	 */
 	[FileExtension.mkv]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a MOV file.
+	 */
 	[FileExtension.mov]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an MP3 file.
+	 */
 	[FileExtension.mp3]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an MP4 file.
+	 */
 	[FileExtension.mp4]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OGA file.
+	 */
 	[FileExtension.oga]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OGG file.
+	 */
 	[FileExtension.ogg]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OGV file.
+	 */
 	[FileExtension.ogv]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an OPUS file.
+	 */
 	[FileExtension.opus]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a PDF file.
+	 */
 	[FileExtension.pdf]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedPdfComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a PNG file.
+	 */
 	[FileExtension.png]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for an SVG file.
+	 */
 	[FileExtension.svg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a WAV file.
+	 */
 	[FileExtension.wav]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a WEBM file.
+	 */
 	[FileExtension.webm]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Creates an embed component for a WEBP file.
+	 */
 	[FileExtension.webp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
 }
 /**
- * @todo Documentation incomplete.
+ * A component that renders an embedded video file.
+ *
  * @public
  * @unofficial
  */
-export interface EmbedVideoComponent extends Component {
+export interface EmbedVideoComponent extends EmbedComponent {
 }
 /**
  * @todo Documentation incomplete.
@@ -25957,13 +26026,9 @@ export interface SuggestionContainer<T> {
 	 * @remark Prefer setSelectedItem, which clamps the index to within suggestions array.
 	 */
 	forceSetSelectedItem(index: number, event: Event): void;
-	/**
-	 * @todo Documentation incomplete.
-	 */
+	/** @todo Documentation incomplete. */
 	getSelectedElement(): HTMLElement | null;
-	/**
-	 * @todo Documentation incomplete.
-	 */
+	/** @todo Documentation incomplete. */
 	getSelectedValue(): SearchResult | null;
 	/**
 	 * Move selected item to next suggestion.
@@ -27421,12 +27486,17 @@ export type ContentPosition = [
 	endOffset: number
 ];
 /**
- * @todo Documentation incomplete.
+ * Creates an embed component for a given file.
+ *
+ * @param context - Context used to embed the file.
+ * @param file - File to embed.
+ * @param subpath - Optional subpath within the file.
+ * @returns An embed component.
  *
  * @public
  * @unofficial
  */
-export type EmbeddableConstructor = (context: EmbedContext, file: TFile, subpath?: string) => Component;
+export type EmbedCreator = (context: EmbedContext, file: TFile, subpath?: string) => EmbedComponent;
 /**
  * @todo Documentation incomplete.
  *