obsidian-typings 4.77.0 → 4.78.0

package/dist/cjs/implementations.d.cts

@@ -8,7 +8,7 @@ import type { Tree as LezerTree } from '@lezer/common';
 import type { App as App$1, BrowserWindow } from 'electron';
 import type { Mermaid } from 'mermaid';
 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, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1 } from 'obsidian';
+import type { App, BasesConfigFileFilter, 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, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1 } from 'obsidian';
 import type { default as pdfjsLib } from 'pdfjs-dist';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
@@ -1357,6 +1357,75 @@ export interface BacklinkView extends InfoFileView {
  */
 export interface BacklinkViewConstructor extends TypedViewConstructor<BacklinkView> {
 }
+/**
+ * BasesConfigFileFilter `and` clause.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesConfigFileFilterAndClause {
+	/**
+	 * All of the following filters must match.
+	 *
+	 * @public
+	 * @since 1.10.0
+	 * @example
+	 * ```ts
+	 * {
+	 *     and: [
+	 *         '*.md',
+	 *         '*.txt',
+	 *     ],
+	 * }
+	 */
+	and: BasesConfigFileFilter[];
+}
+/**
+ * BasesConfigFileFilter `not` clause.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesConfigFileFilterNotClause {
+	/**
+	 * None of the following filters should match.
+	 *
+	 * @public
+	 * @since 1.10.0
+	 * @example
+	 * ```ts
+	 * {
+	 *     not: [
+	 *         '*.md',
+	 *         '*.txt',
+	 *     ],
+	 * }
+	 */
+	not: BasesConfigFileFilter[];
+}
+/**
+ * BasesConfigFileFilter `or` clause.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesConfigFileFilterOrClause {
+	/**
+	 * Some of the following filters should match.
+	 *
+	 * @public
+	 * @since 1.10.0
+	 * @example
+	 * ```ts
+	 * {
+	 *     or: [
+	 *         '*.md',
+	 *         '*.txt',
+	 *     ],
+	 * }
+	 */
+	or: BasesConfigFileFilter[];
+}
 /**
  * Bases context
  *

package/dist/cjs/types.d.cts

@@ -16,7 +16,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, 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, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1, request, requestUrl } from 'obsidian';
+import type { App, BasesConfigFileFilter, 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, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1, 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';
@@ -2323,7 +2323,7 @@ declare module "obsidian" {
 	 *
 	 * @deprecated - Added only for typing purposes. Use {@link BasesConfigFileFilter} instead.
 	 */
-	type BasesConfigFileFilter__ = string | {} | {} | {};
+	type BasesConfigFileFilter__ = string | BasesConfigFileFilterAndClause | BasesConfigFileFilterOrClause | BasesConfigFileFilterNotClause;
 }
 declare module "obsidian" {
 	/**
@@ -5481,11 +5481,18 @@ declare module "obsidian" {
 		 */
 		app: App;
 		/**
-		 * Outermost HTML element on the setting tab.
+		 * HTML element for the setting tab content.
 		 *
 		 * @official
 		 */
 		containerEl: HTMLElement;
+		/**
+		 * The icon to display in the settings sidebar.
+		 *
+		 * @official
+		 * @since 1.11.0
+		 */
+		icon: IconName;
 		/**
 		 * Unique ID of the tab.
 		 *
@@ -5620,6 +5627,20 @@ declare module "obsidian" {
 		 * @official
 		 */
 		addColorPicker(cb: (component: ColorComponent) => any): this;
+		/**
+		 * Add a component to the setting.
+		 *
+		 * @param cb - The callback to add the component.
+		 * @returns The setting.
+		 * @example
+		 * ```ts
+		 * setting.addComponent((el) => {
+		 *     return new TextComponent(el);
+		 * });
+		 * @official
+		 * @since 1.11.0
+		 */
+		addComponent<T extends BaseComponent>(cb: (el: HTMLElement) => T): this;
 		/**
 		 * Add a dropdown component to the setting.
 		 *
@@ -10274,6 +10295,14 @@ declare module "obsidian" {
 		tags?: TagCache[];
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Can be any Lucide icon name or an internal icon name.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link IconName} instead.
+	 */
+	type IconName__ = string;
+}
 declare module "obsidian" {
 	/**
 	 * Collapsible container for other ViewOptions.
@@ -13479,6 +13508,66 @@ declare module "obsidian" {
 		top: number;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Setting group.
+	 *
+	 * @since 1.11.0
+	 */
+	interface SettingGroup {
+		/**
+		 * Add a CSS class to the setting group.
+		 *
+		 * @param cls - The CSS class to add.
+		 * @returns The setting group.
+		 * @example
+		 * ```ts
+		 * settingGroup.addClass('foo');
+		 * ```
+		 * @official
+		 * @since 1.11.0
+		 */
+		addClass(cls: string): this;
+		/**
+		 * Add a setting to the setting group.
+		 *
+		 * @param cb - The callback to add the setting.
+		 * @returns The setting group.
+		 * @example
+		 * ```ts
+		 * settingGroup.addSetting((setting) => {
+		 *     setting.setName('foo');
+		 * });
+		 * ```
+		 * @official
+		 * @since 1.11.0
+		 */
+		addSetting(cb: (setting: Setting) => void): this;
+		/**
+		 * Create a new setting group.
+		 *
+		 * @param containerEl - The container element.
+		 * @returns The setting group.
+		 * @official
+		 * @since 1.11.0
+		 * @deprecated - Added only for typing purposes. Use {@link constructor} instead.
+		 */
+		constructor__(containerEl: HTMLElement): this;
+		/**
+		 * Set the heading of the setting group.
+		 *
+		 * @param text - The text to set the heading to.
+		 * @returns The setting group.
+		 * @example
+		 * ```ts
+		 * settingGroup.setHeading('foo');
+		 * ```
+		 * @official
+		 * @since 1.11.0
+		 */
+		setHeading(text: string | DocumentFragment): this;
+	}
+}
 declare module "obsidian" {
 	/**
 	 * Slider option.
@@ -15153,14 +15242,6 @@ declare module "obsidian" {
 	 */
 	type EditorCommandName__ = "goUp" | "goDown" | "goLeft" | "goRight" | "goStart" | "goEnd" | "goWordLeft" | "goWordRight" | "indentMore" | "indentLess" | "newlineAndIndent" | "swapLineUp" | "swapLineDown" | "deleteLine" | "toggleFold" | "foldAll" | "unfoldAll";
 }
-declare module "obsidian" {
-	/**
-	 * The name of the icon.
-	 *
-	 * @deprecated - Added only for typing purposes. Use {@link IconName} instead.
-	 */
-	type IconName__ = string;
-}
 declare module "obsidian" {
 	/**
 	 * The object stored in the view plugin {@link livePreviewState}
@@ -19687,6 +19768,75 @@ export interface BacklinkView extends InfoFileView {
  */
 export interface BacklinkViewConstructor extends TypedViewConstructor<BacklinkView> {
 }
+/**
+ * BasesConfigFileFilter `and` clause.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesConfigFileFilterAndClause {
+	/**
+	 * All of the following filters must match.
+	 *
+	 * @public
+	 * @since 1.10.0
+	 * @example
+	 * ```ts
+	 * {
+	 *     and: [
+	 *         '*.md',
+	 *         '*.txt',
+	 *     ],
+	 * }
+	 */
+	and: BasesConfigFileFilter[];
+}
+/**
+ * BasesConfigFileFilter `not` clause.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesConfigFileFilterNotClause {
+	/**
+	 * None of the following filters should match.
+	 *
+	 * @public
+	 * @since 1.10.0
+	 * @example
+	 * ```ts
+	 * {
+	 *     not: [
+	 *         '*.md',
+	 *         '*.txt',
+	 *     ],
+	 * }
+	 */
+	not: BasesConfigFileFilter[];
+}
+/**
+ * BasesConfigFileFilter `or` clause.
+ *
+ * @public
+ * @unofficial
+ */
+export interface BasesConfigFileFilterOrClause {
+	/**
+	 * Some of the following filters should match.
+	 *
+	 * @public
+	 * @since 1.10.0
+	 * @example
+	 * ```ts
+	 * {
+	 *     or: [
+	 *         '*.md',
+	 *         '*.txt',
+	 *     ],
+	 * }
+	 */
+	or: BasesConfigFileFilter[];
+}
 /**
  * Bases context
  *

package/dist/obsidian-typings.api.json

@@ -8685,6 +8685,156 @@
             }
           ]
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!BasesConfigFileFilterAndClause:interface",
+          "docComment": "/**\n * BasesConfigFileFilter `and` clause.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface BasesConfigFileFilterAndClause "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/Bases/BasesConfigFileFilterAndClause.d.ts",
+          "releaseTag": "Public",
+          "name": "BasesConfigFileFilterAndClause",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!BasesConfigFileFilterAndClause#and:member",
+              "docComment": "/**\n * All of the following filters must match.\n *\n * @since\n *\n * 1.10.0\n *\n * @example\n *\n * ```ts { and: [ '*.md', '*.txt', ], }\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "and: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BasesConfigFileFilter",
+                  "canonicalReference": "obsidian!BasesConfigFileFilter:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "and",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!BasesConfigFileFilterNotClause:interface",
+          "docComment": "/**\n * BasesConfigFileFilter `not` clause.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface BasesConfigFileFilterNotClause "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/Bases/BasesConfigFileFilterNotClause.d.ts",
+          "releaseTag": "Public",
+          "name": "BasesConfigFileFilterNotClause",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!BasesConfigFileFilterNotClause#not:member",
+              "docComment": "/**\n * None of the following filters should match.\n *\n * @since\n *\n * 1.10.0\n *\n * @example\n *\n * ```ts { not: [ '*.md', '*.txt', ], }\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "not: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BasesConfigFileFilter",
+                  "canonicalReference": "obsidian!BasesConfigFileFilter:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "not",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!BasesConfigFileFilterOrClause:interface",
+          "docComment": "/**\n * BasesConfigFileFilter `or` clause.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface BasesConfigFileFilterOrClause "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/Bases/BasesConfigFileFilterOrClause.d.ts",
+          "releaseTag": "Public",
+          "name": "BasesConfigFileFilterOrClause",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!BasesConfigFileFilterOrClause#or:member",
+              "docComment": "/**\n * Some of the following filters should match.\n *\n * @since\n *\n * 1.10.0\n *\n * @example\n *\n * ```ts { or: [ '*.md', '*.txt', ], }\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "or: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BasesConfigFileFilter",
+                  "canonicalReference": "obsidian!BasesConfigFileFilter:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "or",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!BasesContext:interface",

package/package.json

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