obsidian-typings 4.46.0 → 4.48.0

package/dist/cjs/implementations.d.cts

@@ -2404,7 +2404,7 @@ export interface BookmarkItem {
 	/**
 	 * The items of the bookmark item.
 	 */
-	items: BookmarkItem[];
+	items?: BookmarkItem[];
 	/**
 	 * The path of the bookmark item.
 	 */
@@ -3831,7 +3831,7 @@ export interface ClipboardManager {
 	/**
 	 * Insert files from drop-event into the editor.
 	 */
-	insertFiles(files: ImportedAttachments[]): Promise<void>;
+	insertFiles(importedAttachments: ImportedAttachment[]): Promise<void>;
 	/**
 	 * Save an attachment of specified name and extension to the vault.
 	 *
@@ -7274,18 +7274,19 @@ export interface ImageView extends EditableFileView {
 export interface ImageViewConstructor extends TypedViewConstructor<ImageView> {
 }
 /**
- * @todo Documentation incomplete.
+ * Imported attachment.
+ *
  * @public
  * @unofficial
  */
-export interface ImportedAttachments {
-	/** @todo Documentation incomplete. */
+export interface ImportedAttachment {
+	/** Promise that resolves to the attachment file content. */
 	data: Promise<ArrayBuffer>;
-	/** @todo Documentation incomplete. */
+	/** An attachment file extension. */
 	extension: string;
-	/** @todo Documentation incomplete. */
-	filename: string;
-	/** @todo Documentation incomplete. */
+	/** An attachment file path. */
+	filepath: string;
+	/** An attachment file name. */
 	name: string;
 }
 /**

package/dist/cjs/types.d.cts

@@ -13223,9 +13223,12 @@ declare module "obsidian" {
 		/**
 		 * Import attachments into specified folder.
 		 *
+		 * @param attachmentsToImport - The attachments to import.
+		 * @param folder - The folder to import the attachments to.
+		 *
 		 * @unofficial
 		 */
-		importAttachments(imports: ImportedAttachments[], folder: TFolder | null): Promise<void>;
+		importAttachments(attachmentsToImport: ImportedAttachment[], folder: TFolder | null): Promise<void>;
 		/**
 		 * Initialize the entire application using the provided FS adapter
 		 *
@@ -18612,7 +18615,7 @@ export interface BookmarkItem {
 	/**
 	 * The items of the bookmark item.
 	 */
-	items: BookmarkItem[];
+	items?: BookmarkItem[];
 	/**
 	 * The path of the bookmark item.
 	 */
@@ -20039,7 +20042,7 @@ export interface ClipboardManager {
 	/**
 	 * Insert files from drop-event into the editor.
 	 */
-	insertFiles(files: ImportedAttachments[]): Promise<void>;
+	insertFiles(importedAttachments: ImportedAttachment[]): Promise<void>;
 	/**
 	 * Save an attachment of specified name and extension to the vault.
 	 *
@@ -23482,18 +23485,19 @@ export interface ImageView extends EditableFileView {
 export interface ImageViewConstructor extends TypedViewConstructor<ImageView> {
 }
 /**
- * @todo Documentation incomplete.
+ * Imported attachment.
+ *
  * @public
  * @unofficial
  */
-export interface ImportedAttachments {
-	/** @todo Documentation incomplete. */
+export interface ImportedAttachment {
+	/** Promise that resolves to the attachment file content. */
 	data: Promise<ArrayBuffer>;
-	/** @todo Documentation incomplete. */
+	/** An attachment file extension. */
 	extension: string;
-	/** @todo Documentation incomplete. */
-	filename: string;
-	/** @todo Documentation incomplete. */
+	/** An attachment file path. */
+	filepath: string;
+	/** An attachment file name. */
 	name: string;
 }
 /**

package/dist/obsidian-typings.api.json

@@ -16672,7 +16672,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "items: "
+                  "text": "items?: "
                 },
                 {
                   "kind": "Reference",
@@ -16689,7 +16689,7 @@
                 }
               ],
               "isReadonly": false,
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "items",
               "propertyTypeTokenRange": {
@@ -37617,12 +37617,12 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "insertFiles(files: "
+                  "text": "insertFiles(importedAttachments: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "ImportedAttachments",
-                  "canonicalReference": "obsidian-typings!ImportedAttachments:interface"
+                  "text": "ImportedAttachment",
+                  "canonicalReference": "obsidian-typings!ImportedAttachment:interface"
                 },
                 {
                   "kind": "Content",
@@ -37655,7 +37655,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "files",
+                  "parameterName": "importedAttachments",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 3
@@ -76104,23 +76104,23 @@
         },
         {
           "kind": "Interface",
-          "canonicalReference": "obsidian-typings!ImportedAttachments:interface",
-          "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "canonicalReference": "obsidian-typings!ImportedAttachment:interface",
+          "docComment": "/**\n * Imported attachment.\n *\n * @unofficial\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface ImportedAttachments "
+              "text": "export interface ImportedAttachment "
             }
           ],
-          "fileUrlPath": "src/obsidian/internals/ImportedAttachments.d.ts",
+          "fileUrlPath": "src/obsidian/internals/ImportedAttachment.d.ts",
           "releaseTag": "Public",
-          "name": "ImportedAttachments",
+          "name": "ImportedAttachment",
           "preserveMemberOrder": false,
           "members": [
             {
               "kind": "PropertySignature",
-              "canonicalReference": "obsidian-typings!ImportedAttachments#data:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "canonicalReference": "obsidian-typings!ImportedAttachment#data:member",
+              "docComment": "/**\n * Promise that resolves to the attachment file content.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -76160,8 +76160,8 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "obsidian-typings!ImportedAttachments#extension:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "canonicalReference": "obsidian-typings!ImportedAttachment#extension:member",
+              "docComment": "/**\n * An attachment file extension.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -76187,12 +76187,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "obsidian-typings!ImportedAttachments#filename:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "canonicalReference": "obsidian-typings!ImportedAttachment#filepath:member",
+              "docComment": "/**\n * An attachment file path.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "filename: "
+                  "text": "filepath: "
                 },
                 {
                   "kind": "Content",
@@ -76206,7 +76206,7 @@
               "isReadonly": false,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "filename",
+              "name": "filepath",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -76214,8 +76214,8 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "obsidian-typings!ImportedAttachments#name:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "canonicalReference": "obsidian-typings!ImportedAttachment#name:member",
+              "docComment": "/**\n * An attachment file name.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",

package/package.json

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