client.ts

src/ipc/client.ts

1. // The interface to Rust. Components only ever see this, so the same app runs
2. // against the real shell (tauri.ts) or in a plain browser on sample data
3. // (mock/mockClient.ts), which is how the UI tests and screenshots run.
4. import type { AppInfo } from './gen/AppInfo'
5. import type { AttachmentMeta } from './gen/AttachmentMeta'
6. import type { Conversation } from './gen/Conversation'
7. import type { ConversationSummary } from './gen/ConversationSummary'
8. import type { ConversationView } from './gen/ConversationView'
9. import type { Estimate } from './gen/Estimate'
10. import type { ExportResult } from './gen/ExportResult'
11. import type { KeySaved } from './gen/KeySaved'
12. import type { ModelsResponse } from './gen/ModelsResponse'
13. import type { Preset } from './gen/Preset'
14. import type { Provider } from './gen/Provider'
15. import type { SaveSettingsResult } from './gen/SaveSettingsResult'
16. import type { SearchHit } from './gen/SearchHit'
17. import type { SendAck } from './gen/SendAck'
18. import type { SendRequest } from './gen/SendRequest'
19. import type { Settings } from './gen/Settings'
20. import type { SpendSummary } from './gen/SpendSummary'
21. import type { StreamEvent } from './gen/StreamEvent'
22. import type { UsageReport } from './gen/UsageReport'
24. export type AppEvent =
25. | 'open-conversation'
26. | 'new-chat'
27. | 'open-settings'
28. | 'conversations-changed'
29. | 'models-updated'
30. | 'settings-changed'
31. | 'quick-shown'
33. export interface EstimateArgs {
34. conversationId: string | null
35. providerId: string
36. modelId: string
37. text: string
38. imageCount: number
39. extraText?: string
40. }
42. export interface IpcClient {
43. appInfo(): Promise<AppInfo>
44. windowReady(): Promise<void>
45. showMain(): Promise<void>
47. listProviders(): Promise<Provider[]>
48. saveProvider(provider: Provider): Promise<Provider>
49. deleteProvider(id: string): Promise<void>
50. setApiKey(providerId: string, key: string): Promise<KeySaved>
51. clearApiKey(providerId: string): Promise<void>
52. hasApiKey(providerId: string): Promise<boolean>
54. listModels(providerId: string): Promise<ModelsResponse>
55. refreshModels(providerId: string): Promise<ModelsResponse>
57. listConversations(includeArchived: boolean): Promise<ConversationSummary[]>
58. getConversation(id: string): Promise<ConversationView>
59. createConversation(
60. providerId: string,
61. modelId: string,
62. presetId: string | null,
63. origin: 'main' | 'quick',
64. ): Promise<Conversation>
65. renameConversation(id: string, title: string): Promise<void>
66. setPinned(id: string, pinned: boolean): Promise<void>
67. setArchived(id: string, archived: boolean): Promise<void>
68. deleteConversation(id: string): Promise<void>
69. setConversationModel(id: string, providerId: string, modelId: string): Promise<void>
70. setSystemPrompt(id: string, systemPrompt: string, presetId: string | null): Promise<void>
72. sendMessage(req: SendRequest, onEvent: (e: StreamEvent) => void): Promise<SendAck>
73. cancelStream(streamId: string): Promise<void>
74. truncateFrom(conversationId: string, messageId: string): Promise<void>
75. estimatePrompt(args: EstimateArgs): Promise<Estimate>
77. search(query: string): Promise<SearchHit[]>
78. spendSummary(): Promise<SpendSummary>
79. usageReport(days: number | null): Promise<UsageReport>
81. listPresets(): Promise<Preset[]>
82. savePreset(preset: Preset): Promise<Preset>
83. deletePreset(id: string): Promise<void>
85. getSettings(): Promise<Settings>
86. saveSettings(settings: Settings): Promise<SaveSettingsResult>
88. pickAttachments(imagesAllowed: boolean): Promise<AttachmentMeta[]>
89. attachBytes(filename: string, bytes: Uint8Array): Promise<AttachmentMeta>
90. attachmentBytes(id: string): Promise<ArrayBuffer>
91. discardAttachment(id: string): Promise<void>
93. exportConversation(id: string): Promise<ExportResult>
94. chooseVaultFolder(): Promise<string | null>
96. quickOpenInMain(conversationId: string): Promise<void>
97. hideQuick(): Promise<void>
98. resizeQuick(height: number): Promise<void>
100. openUrl(url: string): Promise<void>
101. on(event: AppEvent, handler: (payload: unknown) => void): Promise<() => void>
102. }