Change getFileDataURI to getFileObject

Author: cyanzhong

README.md

@@ -19,7 +19,7 @@ Add `markedit-api` to your (TypeScript) project's devDependencies:
 ```json
 {
   "devDependencies": {
-    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.19.0"
+    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.20.0"
   }
 }
 ```
@@ -60,8 +60,8 @@ interface MarkEdit {
   listFiles(path: string): Promise<string[] | undefined>;
   // Get the content of a file.
   getFileContent(path?: string): Promise<string | undefined>;
-  // Get the data URI (base64 encoded) of a file.
-  getFileDataURI(path?: string): Promise<string | undefined>;
+  // Get the binary data and type information of a file.
+  getFileObject(path?: string): Promise<FileObject | undefined>;
   // Get the information of a file.
   getFileInfo(path?: string): Promise<FileInfo | undefined>;
   // Get the path of a standard directory.

index.d.ts

@@ -160,11 +160,11 @@ export interface MarkEdit {
   getFileContent(path?: string): Promise<string | undefined>;
 
   /**
-   * Get the data URI (base64 encoded) of a file.
+   * Get the binary data and type information of a file.
    * @param path The file path. The current file is used as a fallback.
-   * @returns The file data URI as a string, or undefined if failed.
+   * @returns The file object, or undefined if failed.
    */
-  getFileDataURI(path?: string): Promise<string | undefined>;
+  getFileObject(path?: string): Promise<FileObject | undefined>;
 
   /**
    * Get the information of a file.
@@ -415,6 +415,31 @@ export type TranslationResponse =
   | { succeeded: true; text: string }
   | { succeeded: false; error: string };
 
+/**
+ * Represents a file object with data and type information.
+ */
+export type FileObject = {
+  /**
+   * Base64 representation of the file.
+   */
+  data: string;
+
+  /**
+   * Uniform Type Identifier (UTI) of the file.
+   */
+  typeIdentifier?: string;
+
+  /**
+   * MIME type of the file.
+   */
+  mimeType?: string;
+
+  /**
+   * File extension of the file.
+   */
+  filenameExtension?: string;
+}
+
 /**
  * Information of a file in the file system.
  */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "markedit-api",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Type definitions for the latest MakrEdit API.",
   "main": "./index.cjs",
   "module": "./index.js",