mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-01-31 00:45:24 +01:00
cf4d7d4e6c
* chore: adjust prettier config, .gitignore and use taplo to format toml files This brings the plugins-workspace repository to the same code style of the main tauri repo * format toml * ignore examples gen dir * add .vscode/extensions.json * remove packageManager field * fmt * fix audit * taplo ignore permissions autogenerated files * remove create dummy dist * fix prettier workflow * install fmt in prettier workflow --------- Co-authored-by: Lucas Nogueira <lucas@tauri.app>
78 lines
1.8 KiB
TypeScript
78 lines
1.8 KiB
TypeScript
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
import { invoke } from '@tauri-apps/api/core'
|
|
|
|
export enum BiometryType {
|
|
None = 0,
|
|
// Apple TouchID or Android fingerprint
|
|
TouchID = 1,
|
|
// Apple FaceID or Android face authentication
|
|
FaceID = 2,
|
|
// Android iris authentication
|
|
Iris = 3
|
|
}
|
|
|
|
export interface Status {
|
|
isAvailable: boolean
|
|
biometryType: BiometryType
|
|
error?: string
|
|
errorCode?:
|
|
| 'appCancel'
|
|
| 'authenticationFailed'
|
|
| 'invalidContext'
|
|
| 'notInteractive'
|
|
| 'passcodeNotSet'
|
|
| 'systemCancel'
|
|
| 'userCancel'
|
|
| 'userFallback'
|
|
| 'biometryLockout'
|
|
| 'biometryNotAvailable'
|
|
| 'biometryNotEnrolled'
|
|
}
|
|
|
|
export interface AuthOptions {
|
|
allowDeviceCredential?: boolean
|
|
cancelTitle?: string
|
|
|
|
// iOS options
|
|
fallbackTitle?: string
|
|
|
|
// android options
|
|
title?: string
|
|
subtitle?: string
|
|
confirmationRequired?: boolean
|
|
maxAttemps?: number
|
|
}
|
|
|
|
/**
|
|
* Checks if the biometric authentication is available.
|
|
* @returns a promise resolving to an object containing all the information about the status of the biometry.
|
|
*/
|
|
export async function checkStatus(): Promise<Status> {
|
|
return await invoke('plugin:biometric|status')
|
|
}
|
|
|
|
/**
|
|
* Prompts the user for authentication using the system interface (touchID, faceID or Android Iris).
|
|
* Rejects if the authentication fails.
|
|
*
|
|
* ```javascript
|
|
* import { authenticate } from "@tauri-apps/plugin-biometric";
|
|
* await authenticate('Open your wallet');
|
|
* ```
|
|
* @param reason
|
|
* @param options
|
|
* @returns
|
|
*/
|
|
export async function authenticate(
|
|
reason: string,
|
|
options?: AuthOptions
|
|
): Promise<void> {
|
|
await invoke('plugin:biometric|authenticate', {
|
|
reason,
|
|
...options
|
|
})
|
|
}
|