feat(preload): add 'webUtils.getPathForFile' api

Author: alex8088

packages/preload/README.md

@@ -1,6 +1,6 @@
 # @electron-toolkit/preload
 
-> Easy to expose Electron APIs (ipcRenderer,webFrame,process) to renderer.
+> Easy to expose Electron APIs (ipcRenderer,webFrame,webUtils,process) to renderer.
 
 ---
 
@@ -93,6 +93,10 @@ declare global {
 - `setZoomFactor`
 - `setZoomLevel`
 
+### WebUtils
+
+- `getPathForFile`
+
 ### NodeProcess
 
 - `platform` property

packages/preload/src/index.ts

@@ -1,7 +1,7 @@
-import { ipcRenderer, webFrame, contextBridge } from 'electron'
+import { ipcRenderer, webFrame, webUtils, contextBridge } from 'electron'
 import { ElectronAPI } from './types'
 
-export type { ElectronAPI, IpcRenderer, IpcRendererListener, WebFrame, NodeProcess } from './types'
+export type { ElectronAPI, IpcRenderer, IpcRendererListener, WebFrame, WebUtils, NodeProcess } from './types'
 
 export const electronAPI: ElectronAPI = {
   ipcRenderer: {
@@ -64,6 +64,11 @@ export const electronAPI: ElectronAPI = {
       }
     }
   },
+  webUtils: {
+    getPathForFile(file) {
+      return webUtils.getPathForFile(file)
+    }
+  },
   process: {
     get platform() {
       return process.platform

packages/preload/src/types.ts

@@ -167,6 +167,21 @@ export interface WebFrame {
   setZoomLevel(level: number): void
 }
 
+export interface WebUtils {
+  // Docs: https://electronjs.org/docs/api/web-utils
+
+  /**
+   * The file system path that this `File` object points to. In the case where the
+   * object passed in is not a `File` object an exception is thrown. In the case
+   * where the File object passed in was constructed in JS and is not backed by a
+   * file on disk an empty string is returned.
+   *
+   * This method superseded the previous augmentation to the `File` object with the
+   * `path` property.  An example is included below.
+   */
+  getPathForFile(file: File): string
+}
+
 export interface NodeProcess {
   /**
    * The process.platform property returns a string identifying the operating system platform
@@ -188,5 +203,6 @@ export interface NodeProcess {
 export interface ElectronAPI {
   ipcRenderer: IpcRenderer
   webFrame: WebFrame
+  webUtils: WebUtils
   process: NodeProcess
 }