mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-03-20 15:41:39 +00:00
Despite still being in development, the `tauri-specta` project already proves to be quite useful. It allows us to generate TypeScript bindings for our commands and events, creating a type-safe contract between the frontend and the backend. For example, this ensures that the TypeScript code calls a command actually with the required parameters and thus avoids runtime failures. Similarly, the frontend can listen on type-safe events without having to use any magic strings.
176 lines
5.6 KiB
TypeScript
176 lines
5.6 KiB
TypeScript
/* eslint-disable */
|
|
/* tslint:disable */
|
|
|
|
// This file was generated by [tauri-specta](https://github.com/oscartbeaumont/tauri-specta). Do not edit this file manually.
|
|
|
|
/** user-defined commands **/
|
|
|
|
|
|
export const commands = {
|
|
async clearLogs() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("clear_logs") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async exportLogs() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("export_logs") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async applyAdvancedSettings(settings: AdvancedSettings) : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("apply_advanced_settings", { settings }) };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async resetAdvancedSettings() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("reset_advanced_settings") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async applyGeneralSettings(settings: GeneralSettingsForm) : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("apply_general_settings", { settings }) };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async resetGeneralSettings() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("reset_general_settings") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async signIn() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("sign_in") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async signOut() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("sign_out") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
},
|
|
async updateState() : Promise<Result<null, Error>> {
|
|
try {
|
|
return { status: "ok", data: await TAURI_INVOKE("update_state") };
|
|
} catch (e) {
|
|
if(e instanceof Error) throw e;
|
|
else return { status: "error", error: e as any };
|
|
}
|
|
}
|
|
}
|
|
|
|
/** user-defined events **/
|
|
|
|
|
|
export const events = __makeEvents__<{
|
|
advancedSettingsChanged: AdvancedSettingsChanged,
|
|
generalSettingsChanged: GeneralSettingsChanged,
|
|
logsRecounted: LogsRecounted,
|
|
sessionChanged: SessionChanged
|
|
}>({
|
|
advancedSettingsChanged: "advanced-settings-changed",
|
|
generalSettingsChanged: "general-settings-changed",
|
|
logsRecounted: "logs-recounted",
|
|
sessionChanged: "session-changed"
|
|
})
|
|
|
|
/** user-defined constants **/
|
|
|
|
|
|
|
|
/** user-defined types **/
|
|
|
|
export type AdvancedSettings = { auth_url: string; api_url: string; log_filter: string }
|
|
export type AdvancedSettingsChanged = AdvancedSettingsViewModel
|
|
export type AdvancedSettingsViewModel = { auth_url: string; auth_url_is_managed: boolean; api_url: string; api_url_is_managed: boolean; log_filter: string; log_filter_is_managed: boolean }
|
|
export type Error = string
|
|
export type FileCount = { bytes: number; files: number }
|
|
export type GeneralSettingsChanged = GeneralSettingsViewModel
|
|
export type GeneralSettingsForm = { start_minimized: boolean; start_on_login: boolean; connect_on_start: boolean; account_slug: string }
|
|
export type GeneralSettingsViewModel = { start_minimized: boolean; start_on_login: boolean; connect_on_start: boolean; connect_on_start_is_managed: boolean; account_slug: string; account_slug_is_managed: boolean }
|
|
export type LogsRecounted = FileCount
|
|
export type SessionChanged = SessionViewModel
|
|
export type SessionViewModel = { SignedIn: { account_slug: string; actor_name: string } } | "Loading" | "SignedOut"
|
|
|
|
/** tauri-specta globals **/
|
|
|
|
import {
|
|
invoke as TAURI_INVOKE,
|
|
Channel as TAURI_CHANNEL,
|
|
} from "@tauri-apps/api/core";
|
|
import * as TAURI_API_EVENT from "@tauri-apps/api/event";
|
|
import { type WebviewWindow as __WebviewWindow__ } from "@tauri-apps/api/webviewWindow";
|
|
|
|
type __EventObj__<T> = {
|
|
listen: (
|
|
cb: TAURI_API_EVENT.EventCallback<T>,
|
|
) => ReturnType<typeof TAURI_API_EVENT.listen<T>>;
|
|
once: (
|
|
cb: TAURI_API_EVENT.EventCallback<T>,
|
|
) => ReturnType<typeof TAURI_API_EVENT.once<T>>;
|
|
emit: null extends T
|
|
? (payload?: T) => ReturnType<typeof TAURI_API_EVENT.emit>
|
|
: (payload: T) => ReturnType<typeof TAURI_API_EVENT.emit>;
|
|
};
|
|
|
|
export type Result<T, E> =
|
|
| { status: "ok"; data: T }
|
|
| { status: "error"; error: E };
|
|
|
|
function __makeEvents__<T extends Record<string, any>>(
|
|
mappings: Record<keyof T, string>,
|
|
) {
|
|
return new Proxy(
|
|
{} as unknown as {
|
|
[K in keyof T]: __EventObj__<T[K]> & {
|
|
(handle: __WebviewWindow__): __EventObj__<T[K]>;
|
|
};
|
|
},
|
|
{
|
|
get: (_, event) => {
|
|
const name = mappings[event as keyof T];
|
|
|
|
return new Proxy((() => {}) as any, {
|
|
apply: (_, __, [window]: [__WebviewWindow__]) => ({
|
|
listen: (arg: any) => window.listen(name, arg),
|
|
once: (arg: any) => window.once(name, arg),
|
|
emit: (arg: any) => window.emit(name, arg),
|
|
}),
|
|
get: (_, command: keyof __EventObj__<any>) => {
|
|
switch (command) {
|
|
case "listen":
|
|
return (arg: any) => TAURI_API_EVENT.listen(name, arg);
|
|
case "once":
|
|
return (arg: any) => TAURI_API_EVENT.once(name, arg);
|
|
case "emit":
|
|
return (arg: any) => TAURI_API_EVENT.emit(name, arg);
|
|
}
|
|
},
|
|
});
|
|
},
|
|
},
|
|
);
|
|
}
|