obsidian-typings 4.42.0 → 4.44.0

package/dist/cjs/implementations.d.cts

@@ -1354,6 +1354,13 @@ export interface BasesContextConstructor extends ConstructorBase<[
  * @unofficial
  */
 export interface BasesControl {
+	/**
+	 * Render to.
+	 *
+	 * @param containerEl - The container element.
+	 * @param t - The data to render.
+	 */
+	renderTo(containerEl: HTMLElement, renderContext: RenderContext): void;
 }
 /**
  * Controller for the view.
@@ -1584,6 +1591,14 @@ export interface BasesController extends Component {
 	 */
 	updateCurrentFile(file: TFile): void;
 }
+/**
+ * Bases external link.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesExternalLink extends BasesControl {
+}
 /**
  * Bases file.
  *
@@ -1950,9 +1965,13 @@ export interface BasesList extends BasesControl {
  */
 export interface BasesLocal {
 	/**
-	 * Implicit file.
+	 * Implicit.
 	 */
 	implicit: BasesFile;
+	/**
+	 * Note.
+	 */
+	note: BasesNote;
 }
 /**
  * Bases view controller mock context.
@@ -1970,6 +1989,25 @@ export interface BasesMockContext {
  */
 export interface BasesNewItemMenu {
 }
+/**
+ * Bases note.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesNote {
+	/**
+	 * Data.
+	 */
+	data: Record<string, unknown>;
+	/**
+	 * Get control.
+	 *
+	 * @param key - The key.
+	 * @returns The control.
+	 */
+	get(key: string): BasesControl;
+}
 /**
  * Bases plugin.
  *
@@ -10123,6 +10161,14 @@ export interface ReleaseNotesView extends ItemView {
  */
 export interface ReleaseNotesViewConstructor extends TypedViewConstructor<ReleaseNotesView> {
 }
+/**
+ * Render context.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RenderContext {
+}
 /**
  * @todo Documentation incomplete.
  * @public

package/dist/cjs/types.d.cts

@@ -17,7 +17,7 @@ import * as fs from 'node:fs';
 import type { FSWatcher, Stats } from 'node:fs';
 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, FileManager, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, Keymap, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice, ObsidianProtocolHandler, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, request, requestUrl } from 'obsidian';
+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, ObsidianProtocolHandler, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, request, requestUrl } from 'obsidian';
 import type { default as pdfjsLib } from 'pdfjs-dist';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle, default as PIXI } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
@@ -13066,6 +13066,12 @@ declare module "obsidian" {
 		 * @unofficial
 		 */
 		plugins: Plugins;
+		/**
+		 * The render context.
+		 *
+		 * @unofficial
+		 */
+		renderContext: RenderContext;
 		/**
 		 * The scope object.
 		 *
@@ -17556,6 +17562,13 @@ export interface BasesContextConstructor extends ConstructorBase<[
  * @unofficial
  */
 export interface BasesControl {
+	/**
+	 * Render to.
+	 *
+	 * @param containerEl - The container element.
+	 * @param t - The data to render.
+	 */
+	renderTo(containerEl: HTMLElement, renderContext: RenderContext): void;
 }
 /**
  * Controller for the view.
@@ -17786,6 +17799,14 @@ export interface BasesController extends Component {
 	 */
 	updateCurrentFile(file: TFile): void;
 }
+/**
+ * Bases external link.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesExternalLink extends BasesControl {
+}
 /**
  * Bases file.
  *
@@ -18152,9 +18173,13 @@ export interface BasesList extends BasesControl {
  */
 export interface BasesLocal {
 	/**
-	 * Implicit file.
+	 * Implicit.
 	 */
 	implicit: BasesFile;
+	/**
+	 * Note.
+	 */
+	note: BasesNote;
 }
 /**
  * Bases view controller mock context.
@@ -18172,6 +18197,25 @@ export interface BasesMockContext {
  */
 export interface BasesNewItemMenu {
 }
+/**
+ * Bases note.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesNote {
+	/**
+	 * Data.
+	 */
+	data: Record<string, unknown>;
+	/**
+	 * Get control.
+	 *
+	 * @param key - The key.
+	 * @returns The control.
+	 */
+	get(key: string): BasesControl;
+}
 /**
  * Bases plugin.
  *
@@ -26325,6 +26369,14 @@ export interface ReleaseNotesView extends ItemView {
  */
 export interface ReleaseNotesViewConstructor extends TypedViewConstructor<ReleaseNotesView> {
 }
+/**
+ * Render context.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RenderContext {
+}
 /**
  * @todo Documentation incomplete.
  * @public

package/dist/obsidian-typings.api.json

@@ -8836,7 +8836,71 @@
           "releaseTag": "Public",
           "name": "BasesControl",
           "preserveMemberOrder": false,
-          "members": [],
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!BasesControl#renderTo:member(1)",
+              "docComment": "/**\n * Render to.\n *\n * @param containerEl - The container element.\n *\n * @param t - The data to render.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "renderTo(containerEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", renderContext: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RenderContext",
+                  "canonicalReference": "obsidian-typings!RenderContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "containerEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "renderContext",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "renderTo"
+            }
+          ],
           "extendsTokenRanges": []
         },
         {
@@ -10772,6 +10836,37 @@
             }
           ]
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!BasesExternalLink:interface",
+          "docComment": "/**\n * Bases external link.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface BasesExternalLink extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "BasesControl",
+              "canonicalReference": "obsidian-typings!BasesControl:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/InternalPlugins/Bases/BasesExternalLink.d.ts",
+          "releaseTag": "Public",
+          "name": "BasesExternalLink",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!BasesFile:interface",
@@ -13035,7 +13130,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!BasesLocal#implicit:member",
-              "docComment": "/**\n * Implicit file.\n */\n",
+              "docComment": "/**\n * Implicit.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13059,6 +13154,34 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!BasesLocal#note:member",
+              "docComment": "/**\n * Note.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "note: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BasesNote",
+                  "canonicalReference": "obsidian-typings!BasesNote:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "note",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": []
@@ -13097,6 +13220,102 @@
           "members": [],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!BasesNote:interface",
+          "docComment": "/**\n * Bases note.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface BasesNote "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/InternalPlugins/Bases/BasesNote.d.ts",
+          "releaseTag": "Public",
+          "name": "BasesNote",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!BasesNote#data:member",
+              "docComment": "/**\n * Data.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "data: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, unknown>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "data",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!BasesNote#get:member(1)",
+              "docComment": "/**\n * Get control.\n *\n * @param key - The key.\n *\n * @returns The control.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get(key: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BasesControl",
+                  "canonicalReference": "obsidian-typings!BasesControl:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "key",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "get"
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!BasesPlugin:interface",
@@ -105293,6 +105512,23 @@
             }
           ]
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!RenderContext:interface",
+          "docComment": "/**\n * Render context.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RenderContext "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/RenderContext.d.ts",
+          "releaseTag": "Public",
+          "name": "RenderContext",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!RendererSection:interface",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-typings",
-  "version": "4.42.0",
+  "version": "4.44.0",
   "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
   "main": "",
   "module": "",