masterplan-optimizer-frontend / appSettingsApi

Variable: appSettingsApi¶

const appSettingsApi: object

Defined in: src/lib/api.ts:2381

Client wrapper for local app settings such as OAuth, solver, publish, and shortcuts.

Type Declaration¶

deleteGoogleOAuth¶

deleteGoogleOAuth: () => Promise\<void>

Delete Google OAuth client credentials from local app settings.

Returns¶

Promise\<void>

getGoogleOAuth¶

getGoogleOAuth: () => Promise\<{ client_id_preview: string | null; client_secret_available?: boolean; configured: boolean; credential_storage_available?: boolean; }>

Get whether Google OAuth credentials are configured.

Returns¶

Promise\<{ client_id_preview: string | null; client_secret_available?: boolean; configured: boolean; credential_storage_available?: boolean; }>

getPublishTarget¶

getPublishTarget: () => Promise\<{ targets: PublishTarget; }>

Fetch the configured publish target.

Returns¶

Promise\<{ targets: PublishTarget; }>

getShortcuts¶

getShortcuts: () => Promise\<{ shortcuts: ShortcutOverrides; }>

Fetch persisted keyboard shortcut overrides.

Returns¶

Promise\<{ shortcuts: ShortcutOverrides; }>

getSolverSettings¶

getSolverSettings: () => Promise\<{ break_recovery_bonus: number; break_threshold_min: number; fatigue_scale: number; max_time_seconds: number; }>

Fetch solver tuning settings used by optimisation jobs.

Returns¶

Promise\<{ break_recovery_bonus: number; break_threshold_min: number; fatigue_scale: number; max_time_seconds: number; }>

resetShortcuts¶

resetShortcuts: () => Promise\<void>

Clear all persisted keyboard shortcut overrides.

Returns¶

Promise\<void>

resetSolverSettings¶

resetSolverSettings: () => Promise\<void>

Reset solver tuning settings to backend defaults.

Returns¶

Promise\<void>

setGoogleOAuth¶

setGoogleOAuth: (clientId, clientSecret) => Promise\<void>

Save Google OAuth client credentials in local app settings.

Parameters¶

clientId¶

string

clientSecret¶

string

Returns¶

Promise\<void>

setPublishTarget¶

setPublishTarget: (targets) => Promise\<{ targets: PublishTarget; }>

Save the configured publish target.

Parameters¶

targets¶

PublishTarget

Returns¶

Promise\<{ targets: PublishTarget; }>

setShortcuts¶

setShortcuts: (shortcuts) => Promise\<{ shortcuts: ShortcutOverrides; }>

Save persisted keyboard shortcut overrides.

Parameters¶

shortcuts¶

ShortcutOverrides

Returns¶

Promise\<{ shortcuts: ShortcutOverrides; }>

setSolverSettings¶

setSolverSettings: (settings) => Promise\<{ break_recovery_bonus: number; break_threshold_min: number; fatigue_scale: number; max_time_seconds: number; }>

Save solver tuning settings used by optimisation jobs.

Parameters¶

settings¶

break_recovery_bonus¶

number

break_threshold_min¶

number

fatigue_scale¶

number

max_time_seconds¶

number

Returns¶

Promise\<{ break_recovery_bonus: number; break_threshold_min: number; fatigue_scale: number; max_time_seconds: number; }>