mirror of
https://github.com/tauri-apps/tauri.git
synced 2024-12-22 02:01:49 +03:00
125 lines
3.5 KiB
TypeScript
125 lines
3.5 KiB
TypeScript
// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
/**
|
|
* Invoke your custom commands.
|
|
*
|
|
* This package is also accessible with `window.__TAURI__.tauri` when `tauri.conf.json > build > withGlobalTauri` is set to true.
|
|
* @module
|
|
*/
|
|
|
|
/** @ignore */
|
|
declare global {
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
interface Window {
|
|
__TAURI_IPC__: (message: any) => void
|
|
ipc: {
|
|
postMessage: (args: string) => void
|
|
}
|
|
}
|
|
}
|
|
|
|
/** @ignore */
|
|
function uid(): number {
|
|
return window.crypto.getRandomValues(new Uint32Array(1))[0]
|
|
}
|
|
|
|
/**
|
|
* Transforms a callback function to a string identifier that can be passed to the backend.
|
|
* The backend uses the identifier to `eval()` the callback.
|
|
*
|
|
* @return A unique identifier associated with the callback function.
|
|
*/
|
|
function transformCallback(
|
|
callback?: (response: any) => void,
|
|
once = false
|
|
): number {
|
|
const identifier = uid()
|
|
const prop = `_${identifier}`
|
|
|
|
Object.defineProperty(window, prop, {
|
|
value: (result: any) => {
|
|
if (once) {
|
|
Reflect.deleteProperty(window, prop)
|
|
}
|
|
|
|
return callback?.(result)
|
|
},
|
|
writable: false,
|
|
configurable: true
|
|
})
|
|
|
|
return identifier
|
|
}
|
|
|
|
/** Command arguments. */
|
|
interface InvokeArgs {
|
|
[key: string]: unknown
|
|
}
|
|
|
|
/**
|
|
* Sends a message to the backend.
|
|
*
|
|
* @param cmd The command name.
|
|
* @param args The optional arguments to pass to the command.
|
|
* @return A promise resolving or rejecting to the backend response.
|
|
*/
|
|
async function invoke<T>(cmd: string, args: InvokeArgs = {}): Promise<T> {
|
|
return new Promise((resolve, reject) => {
|
|
const callback = transformCallback((e: T) => {
|
|
resolve(e)
|
|
Reflect.deleteProperty(window, error)
|
|
}, true)
|
|
const error = transformCallback((e) => {
|
|
reject(e)
|
|
Reflect.deleteProperty(window, callback)
|
|
}, true)
|
|
|
|
window.__TAURI_IPC__({
|
|
cmd,
|
|
callback,
|
|
error,
|
|
...args
|
|
})
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Convert a device file path to an URL that can be loaded by the webview.
|
|
* Note that `asset:` and `https://asset.localhost` must be allowed on the `csp` value configured on `tauri.conf.json > tauri > security`.
|
|
* Example CSP value: `"csp": "default-src 'self'; img-src 'self' asset: https://asset.localhost"` to use the asset protocol on image sources.
|
|
*
|
|
* Additionally, the `asset` must be allowlisted under `tauri.conf.json > tauri > allowlist > protocol`,
|
|
* and its access scope must be defined on the `assetScope` array on the same `protocol` object.
|
|
*
|
|
* @param filePath The file path.
|
|
* @param protocol The protocol to use. Defaults to `asset`. You only need to set this when using a custom protocol.
|
|
* @example
|
|
* ```typescript
|
|
* import { appDir, join } from '@tauri-apps/api/path'
|
|
* import { convertFileSrc } from '@tauri-apps/api/tauri'
|
|
* const appDirPath = await appDir()
|
|
* const filePath = await join(appDir, 'assets/video.mp4')
|
|
* const assetUrl = convertFileSrc(filePath)
|
|
*
|
|
* const video = document.getElementById('my-video')
|
|
* const source = document.createElement('source')
|
|
* source.type = 'video/mp4'
|
|
* source.src = assetUrl
|
|
* video.appendChild(source)
|
|
* video.load()
|
|
* ```
|
|
*
|
|
* @return the URL that can be used as source on the webview.
|
|
*/
|
|
function convertFileSrc(filePath: string, protocol = 'asset'): string {
|
|
return navigator.userAgent.includes('Windows')
|
|
? `https://${protocol}.localhost/${filePath}`
|
|
: `${protocol}://${filePath}`
|
|
}
|
|
|
|
export type { InvokeArgs }
|
|
|
|
export { transformCallback, invoke, convertFileSrc }
|