obsidian-typings 2.2.1-beta.13 → 2.2.1-beta.14

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/dist/obsidian-typings.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.47.5",
+    "toolVersion": "7.47.9",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -22707,6 +22707,110 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!LinkSuggestion:interface",
+          "docComment": "/**\n * Suggestion for a link to a file\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface LinkSuggestion "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/LinkSuggestion.d.ts",
+          "releaseTag": "Public",
+          "name": "LinkSuggestion",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!LinkSuggestion#alias:member",
+              "docComment": "/**\n * Resolved link note alias.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "alias?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "alias",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!LinkSuggestion#file:member",
+              "docComment": "/**\n * File that is suggested. `null` if the link cannot be resolved.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "file: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TFile",
+                  "canonicalReference": "obsidian!TFile:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "file",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!LinkSuggestion#path:member",
+              "docComment": "/**\n * Path to the file if the link can be resolved. Link text if the link cannot be resolved.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "path: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "path",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!LinkUpdate:interface",

package/dist/style-mod.d.cts

@@ -6,7 +6,7 @@
  * node_modules/@codemirror/view/dist/index.d.cts:3:40 - error TS7016: Could not find a declaration file for module 'style-mod'. 'F:/dev/projects/obsidian-typings/node_modules/style-mod/dist/style-mod.cjs' implicitly has an 'any' type.
  * If the 'style-mod' package actually exposes this module, try adding a new declaration (.d.ts) file containing `declare module 'style-mod';`
  * import { StyleModule, StyleSpec } from 'style-mod';
- * 
+ *
  * @note `export {}` omitted intentionally. This is needed only for dist
  */
 

package/dist/types.d.ts

@@ -3827,6 +3827,24 @@ export interface FileCacheEntry {
 	 */
 	size: number;
 }
+/** @public
+ * Suggestion for a link to a file
+ */
+export interface LinkSuggestion {
+	/**
+	 * File that is suggested. `null` if the link cannot be resolved.
+	 */
+	file: TFile | null;
+	/**
+	 * Path to the file if the link can be resolved.
+	 * Link text if the link cannot be resolved.
+	 */
+	path: string;
+	/**
+	 * Resolved link note alias.
+	 */
+	alias?: string;
+}
 /** @public */
 export interface MetadataCacheFileCacheRecord extends Record<string, FileCacheEntry> {
 }
@@ -3911,12 +3929,10 @@ declare module "obsidian" {
 		 */
 		getLinks(): Record<string, Reference[]>;
 		/**
-		 * Get all links (resolved or unresolved) in the vault
+		 * Get all links (resolved or unresolved) in the vault.
+		 * If the note has multiple aliases, it will be returned multiple times for each alias.
 		 */
-		getLinkSuggestions(): {
-			file: TFile | null;
-			path: string;
-		}[];
+		getLinkSuggestions(): LinkSuggestion[];
 		/**
 		 * Get all tags within the vault and their usage count
 		 */
@@ -6025,11 +6041,6 @@ export interface WidgetEditorView extends EmbeddedEditorView {
 	 */
 	showPreview(show?: boolean): void;
 }
-declare global {
-	interface DomElementInfo {
-		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
-	}
-}
 /** @todo Documentation incomplete */
 /** @public */
 export interface VimState {
@@ -6069,12 +6080,6 @@ export interface VimState {
 export interface VimEditor {
 	state: VimState;
 }
-declare module "@codemirror/view" {
-	/** @todo Documentation incomplete */
-	interface EditorView {
-		cm?: VimEditor;
-	}
-}
 declare module "obsidian" {
 	/** @todo Documentation incomplete */
 	interface ItemView extends View {
@@ -7114,6 +7119,17 @@ export interface AllPropertiesView extends ItemView {
 	/** @todo Documentation incomplete */
 	update(): void;
 }
+declare global {
+	interface DomElementInfo {
+		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
+	}
+}
+declare module "@codemirror/view" {
+	/** @todo Documentation incomplete */
+	interface EditorView {
+		cm?: VimEditor;
+	}
+}
 
 export {};
 import './style-mod.d.cts';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "2.2.1-beta.13",
+    "version": "2.2.1-beta.14",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "module": "",
@@ -48,16 +48,16 @@
         "obsidian": "^1.6.6"
     },
     "devDependencies": {
-        "@microsoft/api-extractor": "^7.47.5",
+        "@microsoft/api-extractor": "^7.47.9",
         "@tsconfig/strictest": "^2.0.5",
         "@types/node": "^18.17.0 || >=20.1.0",
         "builtin-modules": "^4.0.0",
-        "cspell": "^8.13.0",
-        "dprint": "^0.45.1",
+        "cspell": "^8.14.2",
+        "dprint": "^0.47.2",
         "dts-bundle-generator": "^9.5.1",
-        "esbuild": "^0.23.0",
+        "esbuild": "^0.23.1",
         "npm-run-all": "^4.1.5",
-        "ts-morph": "^22.0.0"
+        "ts-morph": "^23.0.0"
     },
     "scripts": {
         "build": "npm-run-all build:clean build:validate build:generate-index build:bundle-types build:implementations build:implementations:generate-types build:implementations:bundle-types build:style-mod build:extract-api",