obsidian-typings 4.88.0 → 4.89.0

package/README.md

@@ -70,7 +70,7 @@ To make it easier to adapt to these differences, this package provides typings f
 Typings for each `Obsidian` version can be found in their own git branches: namely `release/obsidian-public/*` and `release/obsidian-catalyst/*`:
 
 - Latest `public` release: [`release/obsidian-public/1.10.6`](https://github.com/Fevol/obsidian-typings/tree/release/obsidian-public/1.10.6)
-- Latest `catalyst` release: [`release/obsidian-catalyst/1.11.1`](https://github.com/Fevol/obsidian-typings/tree/release/obsidian-catalyst/1.11.1)
+- Latest `catalyst` release: [`release/obsidian-catalyst/1.11.4`](https://github.com/Fevol/obsidian-typings/tree/release/obsidian-catalyst/1.11.4)
 
 Older versions of the package are available, but support for them is limited.
 In most cases, we recommend to always use the latest release.

package/dist/cjs/types.d.cts

@@ -5082,6 +5082,7 @@ declare module "obsidian" {
 		 * Add warning styling to the menu item.
 		 *
 		 * @param warning - Whether the menu item should be styled as a warning.
+		 * If set to `true` the MenuItem's title and icon will become red. Or whatever color is applied to the class 'is-warning' by a theme.
 		 * @unofficial
 		 * @since 0.15.0
 		 */
@@ -5458,6 +5459,46 @@ declare module "obsidian" {
 		score: number;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * A secret storage.
+	 * @since 1.11.4
+	 */
+	interface SecretStorage {
+		/**
+		 * @official
+		 * @since 1.11.4
+		 */
+		loadSecrets: unknown;
+		/**
+		 * Gets a secret from storage
+		 *
+		 * @param id - the secret ID
+		 * @returns the secret value or null if not found
+		 * @official
+		 * @since 1.11.4
+		 */
+		getSecret(id: string): string | null;
+		/**
+		 * Lists all secrets in storage
+		 *
+		 * @returns array of secret IDs
+		 * @official
+		 * @since 1.11.4
+		 */
+		listSecrets(): string[];
+		/**
+		 * Sets a secret in the storage.
+		 *
+		 * @param id - lowercase alphanumeric ID with optional dashes
+		 * @param secret - the secret value to store
+		 * @throws Error if ID is invalid
+		 * @official
+		 * @since 1.11.4
+		 */
+		setSecret(id: string, secret: string): void;
+	}
+}
 declare module "obsidian" {
 	/**
 	 * A separator for the menu.
@@ -10461,6 +10502,46 @@ declare module "obsidian" {
 		setValueRgb(rgb: RGB): this;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Component for a secret input.
+	 *
+	 * @since 1.11.1
+	 */
+	interface SecretComponent extends BaseComponent {
+		/**
+		 * Creates a new secret component.
+		 *
+		 * @param app - the application instance.
+		 * @param containerEl - the container element.
+		 * @returns the secret component instance.
+		 * @official
+		 * @since 1.11.1
+		 * @deprecated - Added only for typing purposes. Use {@link constructor} instead.
+		 */
+		constructor__(app: App, containerEl: HTMLElement): this;
+		/**
+		 * Sets the callback function to be called when the value of the secret component changes.
+		 *
+		 * @param cb - the callback function.
+		 * @returns the secret component instance.
+		 * @public
+		 * @since 1.11.4
+		 * @unofficial ERROR: Missing `@unofficial` or `@official` tag
+		 */
+		onChange(cb: (value: string) => unknown): this;
+		/**
+		 * Sets the value of the secret component.
+		 *
+		 * @param value - the value to set.
+		 * @returns the secret component instance.
+		 * @public
+		 * @since 1.11.4
+		 * @unofficial ERROR: Missing `@unofficial` or `@official` tag
+		 */
+		setValue(value: string): this;
+	}
+}
 declare module "obsidian" {
 	/**
 	 * Component for a text input or text area.
@@ -13518,6 +13599,25 @@ declare module "obsidian" {
 		 * @since 1.11.0
 		 */
 		addClass(cls: string): this;
+		/**
+		 * Add an extra button to the setting group.
+		 *
+		 * @param cb - the callback function.
+		 * @returns the setting group.
+		 * @official
+		 * @since 1.11.0
+		 */
+		addExtraButton(cb: (component: ExtraButtonComponent) => any): this;
+		/**
+		 * Add a search input at the beginning of the setting group. Useful for filtering
+		 * results or adding an input for quick entry.
+		 *
+		 * @param cb - the callback function.
+		 * @returns the setting group.
+		 * @official
+		 * @since 1.11.0
+		 */
+		addSearch(cb: (component: SearchComponent) => any): this;
 		/**
 		 * Add a setting to the setting group.
 		 *
@@ -14634,6 +14734,14 @@ declare module "obsidian" {
 		 * @since 0.9.7
 		 */
 		scope: Scope;
+		/**
+		 * The secret storage.
+		 *
+		 * @public
+		 * @since 1.11.4
+		 * @unofficial ERROR: Missing `@unofficial` or `@official` tag
+		 */
+		secretStorage: SecretStorage;
 		/**
 		 * Manages the settings modal and its tabs.
 		 *
@@ -15833,7 +15941,7 @@ declare module "obsidian" {
 	 * @official
 	 * @deprecated - Added only for typing purposes. Use {@link livePreviewState} instead.
 	 */
-	const livePreviewState__: ViewPlugin<LivePreviewStateType>;
+	const livePreviewState__: ViewPlugin<LivePreviewStateType, undefined>;
 	/**
 	 * An instance of `Moment.js` library.
 	 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-typings",
-  "version": "4.88.0",
+  "version": "4.89.0",
   "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
   "main": "",
   "module": "",
@@ -126,6 +126,7 @@
     "build:extract-api": "api-extractor run --local",
     "commit": "cz",
     "format": "bun run scripts/sort-interfaces.ts ./src/ && bun dprint fmt",
+    "format:fast": "bun run scripts/format-fast.ts",
     "postinstall": "node scripts/postinstall.mjs",
     "prepare": "husky",
     "release": "git show origin/main:workflow-scripts/release.ts | bun -",