Files
goodbuddy/src/preload/index.ts
T
mesalogo 098f21b47a feat: add in-app feedback submission
GoodBuddy previously had no direct way to send feedback from the desktop app. The About & Updates page now opens a bilingual, accessible feedback dialog for problems, feature requests, experience notes, and other feedback, with an optional email address and one screenshot.

Submissions use the narrow preload and trusted IPC boundary, a fixed production endpoint with strict TLS, bounded screenshot processing, an isolated resettable installation ID, preserved drafts, and idempotent manual retries. GoodBuddy does not automatically attach conversations, logs, files, settings, or credentials.

Release note: 现在可在“关于与更新”中直接提交问题、建议与体验反馈;邮箱和截图均可选,提交失败时会保留草稿供重试。
2026-08-25 08:01:42 +08:00

1472 lines
45 KiB
TypeScript

import { contextBridge, ipcRenderer, webUtils } from 'electron'
import {
type ApprovalDecision,
type AgentEvent,
type AgentQuestionAnswer,
type AgentRequest,
type AgentRuntimeDetection,
type AgentRuntimeStatus,
type AppInfo,
type BrowserLiveState,
type ContextAttachment,
type ContextFileSelectionProgress,
type DesktopApi,
type KnowledgeLibrary,
type KnowledgeSearchReference,
type KnowledgeSnapshot,
type PastedImageInput,
type RuntimeConversationCompactInput,
type RuntimeConversationCompactResult,
type RuntimeCustomizationSettings,
type RuntimeNativeSnapshot,
type RuntimeNativeSnapshotInput,
type RuntimeSettings,
type RuntimeSettingsInput,
type RuntimeConfigActionInput,
type RuntimeFileSelectionKind,
type RemoteProjectSaveProgress,
type RemoteProjectSaveRequest,
type WindowCaptureOption
} from '../shared/contracts'
import { ipcChannels } from '../shared/ipc-channels'
import type {
BrowserProfileCreateInput,
BrowserProfileRenameInput,
BuiltinMcpServerId,
CapabilityDiagnosticReport,
CapabilitySnapshot,
ComputerCapabilityId,
McpServerTestResult,
WebSearchTestResult
} from '../shared/capability-contracts'
import type {
AssistantProject,
AssistantArtifact,
AssistantMemory,
AssistantSchedule,
AssistantHeartbeatConfig,
AssistantHeartbeatEntry,
AssistantHeartbeatRun,
AssistantExpert,
AssistantTask,
TokenUsageSummary,
ConversationBranchInput,
ConversationSnapshot,
LocalConversationSaveBatch,
WorkspaceChanges,
WorkspaceDirectoryListing,
WorkspaceFilePreview,
ProjectCreateInput,
MemoryCreateInput,
ScheduleCreateInput,
HeartbeatCreateInput,
HeartbeatUpdateInput,
ExpertCreateInput,
ExpertUpdateInput
} from '../shared/assistant-contracts'
import type {
ChannelConnectionTestResult,
ChannelSettingsApply,
ChannelSettingsSnapshot,
CredentialChannel,
DingTalkChannelSettingsInput,
WeComChannelSettingsInput
} from '../shared/channel-settings-contracts'
import type {
ApplicationSettings,
ApplicationSettingsUpdate,
ModelDownloadSource,
VersionCheckResult
} from '../shared/application-settings-contracts'
import type { ReleaseNotesSnapshot } from '../shared/release-notes-contracts'
import type {
SpeechModelSnapshot,
SpeechTranscriptionInput,
SpeechTranscriptionResult
} from '../shared/speech-model-contracts'
import type {
EmbeddingDiagnosticResult,
EmbeddingModelSnapshot,
EmbeddingSettingsSnapshot,
KnowledgeEmbeddingIndexSnapshot
} from '../shared/embedding-contracts'
import type {
DocumentOcrAssets,
DocumentOcrFailure,
DocumentOcrModelProgressSnapshot,
DocumentOcrRequest,
DocumentOcrResult,
DocumentParsingDiagnostic,
DocumentParsingSettings,
DocumentParsingSnapshot,
DocumentParsingTestPurpose
} from '../shared/document-parsing-contracts'
import type { AgentRuntimeSelection } from '../shared/runtime-selection-contracts'
import type { WeixinBindingSnapshot } from '../shared/weixin-channel-contracts'
import type { RemoteChannelActivity } from '../shared/remote-channel-contracts'
import type {
SshHostDraftInspectionRequest,
SshDirectoryBrowseResult,
SshHostKeyInspection,
SshHostRemoteEnvironment,
SshHostsSnapshot,
SshHostValidationRequest,
SshHostValidationResult
} from '../shared/ssh-host-contracts'
import type {
MagicNoteAnalysisStreamEvent,
MagicNoteDraftAnalysis,
MagicNoteDetail,
MagicNotesSnapshot,
MagicTodoItem,
MagicTodoStatus,
MagicTodoUpdateResult,
MagicTodosSnapshot
} from '../shared/magic-notes-contracts'
import type {
KnowledgeChunkDeleteInput,
KnowledgeChunkPage,
KnowledgeChunkUpdateInput,
KnowledgeChunksListInput,
KnowledgeDocumentRebuildInput,
KnowledgeLibraryRebuildInput,
KnowledgeReferenceContext,
KnowledgeReferenceContextInput,
KnowledgeReferenceOpenInput,
KnowledgeRetrievalResponse,
KnowledgeRetrieveInput,
KnowledgeSettingsUpdateInput
} from '../shared/knowledge-contracts'
import type {
RuntimeExtensionAction,
RuntimeExtensionMarketplaceSnapshot
} from '../shared/runtime-extension-contracts'
import type {
GlobalShortcutSettings,
GlobalShortcutSettingsSnapshot,
GlobalShortcutSettingsUpdateResult
} from '../shared/shortcut'
import type {
FeedbackSubmitInput,
FeedbackSubmitResult
} from '../shared/feedback-contracts'
const desktopApi: DesktopApi = {
app: {
getInfo: () => ipcRenderer.invoke(ipcChannels.appInfo) as Promise<AppInfo>,
show: async () => {
await ipcRenderer.invoke(ipcChannels.appShow)
},
hide: async () => {
await ipcRenderer.invoke(ipcChannels.appHide)
},
minimize: async () => {
await ipcRenderer.invoke(ipcChannels.windowMinimize)
},
toggleMaximize: async () => {
await ipcRenderer.invoke(ipcChannels.windowToggleMaximize)
},
close: async () => {
await ipcRenderer.invoke(ipcChannels.windowClose)
},
isMaximized: () =>
ipcRenderer.invoke(ipcChannels.windowIsMaximized) as Promise<boolean>,
onMaximizedChanged: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
maximized: boolean
): void => listener(maximized)
ipcRenderer.on(ipcChannels.windowMaximizedChanged, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.windowMaximizedChanged,
handler
)
},
onBeforeQuit: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
requestId: string
): void => {
const acknowledge = (): void => {
void ipcRenderer.invoke(
ipcChannels.appRendererPersistenceComplete,
requestId
)
}
void listener().then(acknowledge, acknowledge)
}
ipcRenderer.on(
ipcChannels.appRendererPersistenceRequest,
handler
)
void ipcRenderer.invoke(ipcChannels.appRendererPersistenceReady)
return () =>
ipcRenderer.removeListener(
ipcChannels.appRendererPersistenceRequest,
handler
)
},
clearLocalData: async () => {
await ipcRenderer.invoke(ipcChannels.appClearLocalData)
},
onNewConversation: (listener) => {
const handler = (): void => listener()
ipcRenderer.on(ipcChannels.conversationNew, handler)
return () => ipcRenderer.removeListener(ipcChannels.conversationNew, handler)
},
onOpenSettings: (listener) => {
const handler = (): void => listener()
ipcRenderer.on(ipcChannels.settingsOpen, handler)
return () => ipcRenderer.removeListener(ipcChannels.settingsOpen, handler)
}
},
agent: {
getStatus: (selection) =>
ipcRenderer.invoke(
ipcChannels.agentStatus,
selection
) as Promise<AgentRuntimeStatus>,
run: async (request: AgentRequest) => {
await ipcRenderer.invoke(ipcChannels.agentRun, request)
},
cancel: async (requestId: string) => {
await ipcRenderer.invoke(ipcChannels.agentCancel, requestId)
},
respondApproval: async (
approvalId: string,
decision: ApprovalDecision
) => {
await ipcRenderer.invoke(ipcChannels.agentApprovalRespond, {
approvalId,
decision
})
},
respondQuestion: async (
questionId: string,
answers?: AgentQuestionAnswer[]
) => {
await ipcRenderer.invoke(ipcChannels.agentQuestionRespond, {
questionId,
answers: answers ?? []
})
},
compactConversation: (input: RuntimeConversationCompactInput) =>
ipcRenderer.invoke(
ipcChannels.agentCompactConversation,
input
) as Promise<RuntimeConversationCompactResult>,
onEvent: (listener) => {
const handler = (_event: Electron.IpcRendererEvent, payload: AgentEvent): void =>
listener(payload)
ipcRenderer.on(ipcChannels.agentEvent, handler)
return () => ipcRenderer.removeListener(ipcChannels.agentEvent, handler)
}
},
browser: {
interact: async (conversationId: string) => {
await ipcRenderer.invoke(
ipcChannels.browserInteract,
{ conversationId }
)
},
stop: async (conversationId: string) => {
await ipcRenderer.invoke(
ipcChannels.browserStop,
{ conversationId }
)
},
onState: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
payload: BrowserLiveState
): void => listener(payload)
ipcRenderer.on(ipcChannels.browserState, handler)
return () =>
ipcRenderer.removeListener(ipcChannels.browserState, handler)
}
},
settings: {
getRuntime: () =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsGet
) as Promise<RuntimeSettings>,
updateRuntime: (input: RuntimeSettingsInput) =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsUpdate,
input
) as Promise<RuntimeSettings>,
selectWorkspace: () =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsSelectWorkspace
) as Promise<string | undefined>,
detectAgentRuntimes: () =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsDetect
) as Promise<AgentRuntimeDetection>,
selectRuntimeFile: (kind: RuntimeFileSelectionKind) =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsSelectFile,
kind
) as Promise<string | undefined>,
openRuntimeConfig: async (input: RuntimeConfigActionInput) => {
await ipcRenderer.invoke(
ipcChannels.runtimeSettingsOpenConfig,
input
)
},
testModelConnection: (profileId: string) =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsTestModel,
profileId
) as Promise<AgentRuntimeStatus>,
testRuntime: (selection: AgentRuntimeSelection) =>
ipcRenderer.invoke(
ipcChannels.runtimeSettingsTest,
selection
) as Promise<AgentRuntimeStatus>
},
sshHosts: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.sshHostsGet
) as Promise<SshHostsSnapshot>,
remove: async (hostId: string) => {
await ipcRenderer.invoke(ipcChannels.sshHostsRemove, {
hostId
})
},
inspectDraftHostKey: (input: SshHostDraftInspectionRequest) =>
ipcRenderer.invoke(
ipcChannels.sshHostsInspectDraftKey,
input
) as Promise<SshHostKeyInspection>,
discardCandidate: async (candidateId: string) => {
await ipcRenderer.invoke(
ipcChannels.sshHostsDiscardCandidate,
{ candidateId }
)
},
validateAndSave: (input: SshHostValidationRequest) =>
ipcRenderer.invoke(
ipcChannels.sshHostsValidateAndSave,
input
) as Promise<SshHostValidationResult>,
getRemoteEnvironment: (hostId: string) =>
ipcRenderer.invoke(
ipcChannels.sshHostsRemoteEnvironment,
{ hostId }
) as Promise<SshHostRemoteEnvironment>,
browseDirectories: (hostId: string, path?: string) =>
ipcRenderer.invoke(ipcChannels.sshHostsBrowseDirectories, {
hostId,
...(path === undefined ? {} : { path })
}) as Promise<SshDirectoryBrowseResult>,
cancelDirectoryBrowse: async () => {
await ipcRenderer.invoke(
ipcChannels.sshHostsCancelDirectoryBrowse
)
}
},
channels: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.channelSettingsGet
) as Promise<ChannelSettingsSnapshot>,
apply: (input: ChannelSettingsApply) =>
ipcRenderer.invoke(
ipcChannels.channelSettingsApply,
input
) as Promise<ChannelSettingsSnapshot>,
testConnection: (
channel: CredentialChannel,
settings?: WeComChannelSettingsInput | DingTalkChannelSettingsInput
) =>
ipcRenderer.invoke(ipcChannels.channelSettingsTest, {
channel,
settings
}) as Promise<ChannelConnectionTestResult>,
getWeixinBinding: () =>
ipcRenderer.invoke(
ipcChannels.weixinBindingGet
) as Promise<WeixinBindingSnapshot>,
startWeixinBinding: () =>
ipcRenderer.invoke(
ipcChannels.weixinBindingStart
) as Promise<WeixinBindingSnapshot>,
submitWeixinVerification: (code: string) =>
ipcRenderer.invoke(
ipcChannels.weixinBindingVerify,
{ code }
) as Promise<WeixinBindingSnapshot>,
disconnectWeixin: () =>
ipcRenderer.invoke(
ipcChannels.weixinBindingDisconnect
) as Promise<WeixinBindingSnapshot>,
onWeixinBindingChanged: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
snapshot: WeixinBindingSnapshot
): void => listener(snapshot)
ipcRenderer.on(ipcChannels.weixinBindingChanged, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.weixinBindingChanged,
handler
)
},
onRemoteActivity: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
activity: RemoteChannelActivity
): void => listener(activity)
ipcRenderer.on(ipcChannels.remoteChannelActivity, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.remoteChannelActivity,
handler
)
}
},
updates: {
getSettings: () =>
ipcRenderer.invoke(
ipcChannels.applicationSettingsGet
) as Promise<ApplicationSettings>,
updateSettings: (input: ApplicationSettingsUpdate) =>
ipcRenderer.invoke(
ipcChannels.applicationSettingsUpdate,
input
) as Promise<ApplicationSettings>,
check: () =>
ipcRenderer.invoke(
ipcChannels.versionCheck
) as Promise<VersionCheckResult>,
openReleasePage: async () => {
await ipcRenderer.invoke(ipcChannels.versionOpenReleasePage)
},
onResult: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
result: VersionCheckResult
): void => listener(result)
ipcRenderer.on(ipcChannels.versionCheckResult, handler)
return () =>
ipcRenderer.removeListener(ipcChannels.versionCheckResult, handler)
}
},
feedback: {
submit: (input: FeedbackSubmitInput) =>
ipcRenderer.invoke(
ipcChannels.feedbackSubmit,
input
) as Promise<FeedbackSubmitResult>
},
shortcuts: {
getSettings: () =>
ipcRenderer.invoke(
ipcChannels.shortcutSettingsGet
) as Promise<GlobalShortcutSettingsSnapshot>,
updateSettings: (input: GlobalShortcutSettings) =>
ipcRenderer.invoke(
ipcChannels.shortcutSettingsUpdate,
input
) as Promise<GlobalShortcutSettingsUpdateResult>
},
releaseNotes: {
getPending: () =>
ipcRenderer.invoke(
ipcChannels.releaseNotesGetPending
) as Promise<ReleaseNotesSnapshot>,
acknowledge: async (version: string) => {
await ipcRenderer.invoke(
ipcChannels.releaseNotesAcknowledge,
{ version }
)
}
},
speechModels: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.speechModelsGet
) as Promise<SpeechModelSnapshot>,
install: (
modelId: string,
expectedDownloadSource: ModelDownloadSource
) =>
ipcRenderer.invoke(
ipcChannels.speechModelsInstall,
{ modelId, expectedDownloadSource }
) as Promise<SpeechModelSnapshot>,
cancel: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.speechModelsCancel,
{ modelId }
) as Promise<boolean>,
remove: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.speechModelsRemove,
{ modelId }
) as Promise<SpeechModelSnapshot>,
select: (modelId: string | null) =>
ipcRenderer.invoke(
ipcChannels.speechModelsSelect,
{ modelId }
) as Promise<SpeechModelSnapshot>,
importArchive: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.speechModelsImportArchive,
{ modelId }
) as Promise<SpeechModelSnapshot | undefined>,
exportArchive: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.speechModelsExportArchive,
{ modelId }
) as Promise<SpeechModelSnapshot | undefined>,
openRepository: async (modelId: string) => {
await ipcRenderer.invoke(
ipcChannels.speechModelsOpenRepository,
{ modelId }
)
},
openModelsDirectory: async () => {
await ipcRenderer.invoke(ipcChannels.speechModelsOpenDirectory)
}
},
speech: {
transcribe: (input: SpeechTranscriptionInput) =>
ipcRenderer.invoke(
ipcChannels.speechTranscribe,
input
) as Promise<SpeechTranscriptionResult>,
cancel: (requestId: string) =>
ipcRenderer.invoke(
ipcChannels.speechTranscriptionCancel,
requestId
) as Promise<boolean>
},
embeddings: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.embeddingSettingsGet
) as Promise<EmbeddingSettingsSnapshot>,
diagnose: (connectionId: string) =>
ipcRenderer.invoke(
ipcChannels.embeddingDiagnose,
{ connectionId }
) as Promise<EmbeddingDiagnosticResult>,
setCurrent: (connectionId: string) =>
ipcRenderer.invoke(
ipcChannels.embeddingSetCurrent,
{ connectionId }
) as Promise<EmbeddingSettingsSnapshot>,
installModel: (
modelId: string,
expectedDownloadSource: ModelDownloadSource
) =>
ipcRenderer.invoke(
ipcChannels.embeddingModelsInstall,
{ modelId, expectedDownloadSource }
) as Promise<EmbeddingModelSnapshot>,
cancelModelOperation: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.embeddingModelsCancel,
{ modelId }
) as Promise<boolean>,
importModelArchive: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.embeddingModelsImportArchive,
{ modelId }
) as Promise<EmbeddingModelSnapshot | undefined>,
removeModel: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.embeddingModelsRemove,
{ modelId }
) as Promise<EmbeddingModelSnapshot>
},
documentParsing: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.documentParsingGet
) as Promise<DocumentParsingSnapshot>,
getOcrModelProgress: () =>
ipcRenderer.invoke(
ipcChannels.documentOcrModelsProgress
) as Promise<DocumentOcrModelProgressSnapshot>,
update: (input: DocumentParsingSettings) =>
ipcRenderer.invoke(
ipcChannels.documentParsingUpdate,
input
) as Promise<DocumentParsingSnapshot>,
test: (purpose: DocumentParsingTestPurpose) =>
ipcRenderer.invoke(
ipcChannels.documentParsingTest,
{ purpose }
) as Promise<DocumentParsingDiagnostic | undefined>,
installOcrModel: (
modelId: string,
expectedDownloadSource: ModelDownloadSource
) =>
ipcRenderer.invoke(
ipcChannels.documentOcrModelsInstall,
{ modelId, expectedDownloadSource }
) as Promise<DocumentParsingSnapshot>,
cancelOcrModelOperation: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.documentOcrModelsCancel,
{ modelId }
) as Promise<boolean>,
removeOcrModel: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.documentOcrModelsRemove,
{ modelId }
) as Promise<DocumentParsingSnapshot>,
importOcrModelArchive: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.documentOcrModelsImportArchive,
{ modelId }
) as Promise<DocumentParsingSnapshot | undefined>,
exportOcrModelArchive: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.documentOcrModelsExportArchive,
{ modelId }
) as Promise<DocumentParsingSnapshot | undefined>,
openOcrModelRepository: async (modelId: string) => {
await ipcRenderer.invoke(
ipcChannels.documentOcrModelsOpenRepository,
{ modelId }
)
},
openOcrModelsDirectory: async () => {
await ipcRenderer.invoke(
ipcChannels.documentOcrModelsOpenDirectory
)
},
getOcrAssets: (modelId: string) =>
ipcRenderer.invoke(
ipcChannels.documentParsingOcrAssets,
{ modelId }
) as Promise<DocumentOcrAssets>,
respondOcr: async (
response: DocumentOcrResult | DocumentOcrFailure
) => {
await ipcRenderer.invoke(
ipcChannels.documentParsingOcrRespond,
response
)
},
onOcrRequest: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
request: DocumentOcrRequest
): void => listener(request)
ipcRenderer.on(ipcChannels.documentParsingOcrRequest, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.documentParsingOcrRequest,
handler
)
},
onOcrCancel: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
requestId: string
): void => listener(requestId)
ipcRenderer.on(ipcChannels.documentParsingOcrCancel, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.documentParsingOcrCancel,
handler
)
}
},
projects: {
list: (includeArchived = false) =>
ipcRenderer.invoke(
ipcChannels.projectsList,
includeArchived
) as Promise<AssistantProject[]>,
create: (input: ProjectCreateInput) =>
ipcRenderer.invoke(
ipcChannels.projectsCreate,
input
) as Promise<AssistantProject>,
update: (projectId: string, input: ProjectCreateInput) =>
ipcRenderer.invoke(
ipcChannels.projectsUpdate,
{ projectId, input }
) as Promise<AssistantProject>,
setArchived: async (projectId: string, archived: boolean) => {
await ipcRenderer.invoke(ipcChannels.projectsSetArchived, {
projectId,
archived
})
},
delete: async (projectId: string, confirmation: string) => {
await ipcRenderer.invoke(ipcChannels.projectsDelete, {
projectId,
confirmation
})
},
remote: {
activate: (projectId: string) =>
ipcRenderer.invoke(
ipcChannels.remoteProjectActivate,
projectId
) as Promise<AssistantProject>,
save: (input: RemoteProjectSaveRequest) =>
ipcRenderer.invoke(
ipcChannels.remoteProjectSave,
input
) as Promise<AssistantProject>,
cancelCurrent: async () => {
await ipcRenderer.invoke(ipcChannels.remoteProjectCancelCurrent)
},
onSaveProgress: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
progress: RemoteProjectSaveProgress
): void => listener(progress)
ipcRenderer.on(
ipcChannels.remoteProjectSaveProgress,
handler
)
return () =>
ipcRenderer.removeListener(
ipcChannels.remoteProjectSaveProgress,
handler
)
}
}
},
conversations: {
list: () =>
ipcRenderer.invoke(
ipcChannels.conversationsList
) as Promise<ConversationSnapshot[]>,
replace: async (conversations: ConversationSnapshot[]) => {
await ipcRenderer.invoke(
ipcChannels.conversationsReplace,
conversations
)
},
saveLocal: async (batch: LocalConversationSaveBatch) => {
await ipcRenderer.invoke(
ipcChannels.conversationsSaveLocal,
batch
)
},
branchLocal: (input: ConversationBranchInput) =>
ipcRenderer.invoke(
ipcChannels.conversationsBranchLocal,
input
) as Promise<ConversationSnapshot>,
deleteLocal: (conversationId: string) =>
ipcRenderer.invoke(
ipcChannels.conversationsDeleteLocal,
conversationId
) as Promise<boolean>,
onChanged: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
conversationId?: string
): void => listener(conversationId)
ipcRenderer.on(ipcChannels.conversationsChanged, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.conversationsChanged,
handler
)
}
},
conversationQueue: {
list: (conversationId?: string) =>
ipcRenderer.invoke(
ipcChannels.conversationQueueList,
conversationId
),
enqueueUser: (input) =>
ipcRenderer.invoke(
ipcChannels.conversationQueueEnqueueUser,
input
),
remove: async (itemId: string) => {
await ipcRenderer.invoke(
ipcChannels.conversationQueueRemove,
itemId
)
},
interruptAndRun: async (itemId: string) => {
await ipcRenderer.invoke(
ipcChannels.conversationQueueInterruptAndRun,
itemId
)
},
releaseUser: async (itemId: string) => {
await ipcRenderer.invoke(
ipcChannels.conversationQueueReleaseUser,
itemId
)
},
ready: async (conversationId: string) => {
await ipcRenderer.invoke(
ipcChannels.conversationQueueReady,
conversationId
)
},
onChanged: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
conversationId?: string
): void => listener(conversationId)
ipcRenderer.on(ipcChannels.conversationQueueChanged, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.conversationQueueChanged,
handler
)
},
onDispatch: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
dispatch: Parameters<typeof listener>[0]
): void => listener(dispatch)
ipcRenderer.on(ipcChannels.conversationQueueDispatch, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.conversationQueueDispatch,
handler
)
}
},
workspace: {
getChanges: (projectId: string) =>
ipcRenderer.invoke(
ipcChannels.workspaceChangesGet,
projectId
) as Promise<WorkspaceChanges>,
listDirectory: (projectId: string, path: string) =>
ipcRenderer.invoke(ipcChannels.workspaceDirectoryList, {
projectId,
path
}) as Promise<WorkspaceDirectoryListing>,
readFile: (projectId: string, path: string) =>
ipcRenderer.invoke(ipcChannels.workspaceFileRead, {
projectId,
path
}) as Promise<WorkspaceFilePreview>,
openPath: async (
projectId: string,
path: string,
type: 'file' | 'directory'
) => {
await ipcRenderer.invoke(ipcChannels.workspacePathOpen, {
projectId,
path,
type
})
}
},
tasks: {
list: () =>
ipcRenderer.invoke(ipcChannels.tasksList) as Promise<AssistantTask[]>,
setStatus: async (
taskId: string,
status: 'completed' | 'cancelled'
) => {
await ipcRenderer.invoke(ipcChannels.tasksSetStatus, {
taskId,
status
})
}
},
usage: {
getTokenSummary: () =>
ipcRenderer.invoke(
ipcChannels.tokenUsageSummary
) as Promise<TokenUsageSummary>
},
artifacts: {
list: (projectId?: string) =>
ipcRenderer.invoke(
ipcChannels.artifactsList,
projectId
) as Promise<AssistantArtifact[]>,
get: (artifactId: string) =>
ipcRenderer.invoke(
ipcChannels.artifactsGet,
artifactId
) as Promise<AssistantArtifact>,
importFiles: (projectId?: string) =>
ipcRenderer.invoke(
ipcChannels.artifactsImportFiles,
projectId
) as Promise<AssistantArtifact[]>
},
memory: {
list: (scopeId?: string) =>
ipcRenderer.invoke(
ipcChannels.memoryList,
scopeId
) as Promise<AssistantMemory[]>,
create: (input: MemoryCreateInput) =>
ipcRenderer.invoke(
ipcChannels.memoryCreate,
input
) as Promise<AssistantMemory>,
setStatus: async (
memoryId: string,
status: AssistantMemory['status']
) => {
await ipcRenderer.invoke(ipcChannels.memorySetStatus, {
memoryId,
status
})
},
remove: async (memoryId: string) => {
await ipcRenderer.invoke(ipcChannels.memoryRemove, memoryId)
}
},
schedules: {
list: (projectId?: string) =>
ipcRenderer.invoke(
ipcChannels.schedulesList,
projectId
) as Promise<AssistantSchedule[]>,
create: (input: ScheduleCreateInput) =>
ipcRenderer.invoke(
ipcChannels.schedulesCreate,
input
) as Promise<AssistantSchedule>,
setEnabled: async (scheduleId: string, enabled: boolean) => {
await ipcRenderer.invoke(ipcChannels.schedulesSetEnabled, {
scheduleId,
enabled
})
},
remove: async (scheduleId: string) => {
await ipcRenderer.invoke(ipcChannels.schedulesRemove, scheduleId)
},
runNow: async (scheduleId: string) => {
await ipcRenderer.invoke(ipcChannels.schedulesRunNow, scheduleId)
}
},
heartbeats: {
list: (projectId?: string) =>
ipcRenderer.invoke(ipcChannels.heartbeatsList, {
projectId
}) as Promise<AssistantHeartbeatConfig[]>,
create: (input: HeartbeatCreateInput) =>
ipcRenderer.invoke(
ipcChannels.heartbeatsCreate,
input
) as Promise<AssistantHeartbeatConfig>,
update: (heartbeatId: string, input: HeartbeatUpdateInput) =>
ipcRenderer.invoke(ipcChannels.heartbeatsUpdate, {
id: heartbeatId,
config: input
}) as Promise<AssistantHeartbeatConfig>,
setPaused: async (heartbeatId: string, paused: boolean) => {
await ipcRenderer.invoke(ipcChannels.heartbeatsSetPaused, {
id: heartbeatId,
paused
})
},
remove: async (heartbeatId: string) => {
await ipcRenderer.invoke(ipcChannels.heartbeatsRemove, {
id: heartbeatId
})
},
runNow: (heartbeatId: string) =>
ipcRenderer.invoke(ipcChannels.heartbeatsRunNow, {
id: heartbeatId,
idempotencyKey: crypto.randomUUID()
}) as Promise<AssistantHeartbeatRun>,
history: (heartbeatId?: string) =>
ipcRenderer.invoke(ipcChannels.heartbeatsHistory, {
configId: heartbeatId,
limit: 200
}) as Promise<{
runs: AssistantHeartbeatRun[]
entries: AssistantHeartbeatEntry[]
}>
},
experts: {
list: () =>
ipcRenderer.invoke(
ipcChannels.expertsList
) as Promise<AssistantExpert[]>,
create: (input: ExpertCreateInput) =>
ipcRenderer.invoke(
ipcChannels.expertsCreate,
input
) as Promise<AssistantExpert>,
update: (expertId: string, input: ExpertUpdateInput) =>
ipcRenderer.invoke(ipcChannels.expertsUpdate, {
expertId,
input
}) as Promise<AssistantExpert>,
remove: async (expertId: string) => {
await ipcRenderer.invoke(ipcChannels.expertsRemove, expertId)
}
},
capabilities: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.capabilitiesSnapshot
) as Promise<CapabilitySnapshot>,
importSkill: (kind) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesImportSkill,
kind
) as Promise<CapabilitySnapshot>,
removeSkill: (skillId) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesRemoveSkill,
skillId
) as Promise<CapabilitySnapshot>,
setSkillEnabled: (skillId, enabled) =>
ipcRenderer.invoke(ipcChannels.capabilitiesToggleSkill, {
skillId,
enabled
}) as Promise<CapabilitySnapshot>,
setSkillAssignments: (skillId, assignments) =>
ipcRenderer.invoke(ipcChannels.capabilitiesAssignSkill, {
skillId,
assignments
}) as Promise<CapabilitySnapshot>,
setBuiltinMcpServerEnabled: (
serverId: BuiltinMcpServerId,
enabled: boolean
) =>
ipcRenderer.invoke(ipcChannels.capabilitiesToggleBuiltinMcp, {
serverId,
enabled
}) as Promise<CapabilitySnapshot>,
setBuiltinMcpServerAssignments: (
serverId: BuiltinMcpServerId,
assignments
) =>
ipcRenderer.invoke(ipcChannels.capabilitiesAssignBuiltinMcp, {
serverId,
assignments
}) as Promise<CapabilitySnapshot>,
saveMcpServer: (serverId, input) =>
ipcRenderer.invoke(ipcChannels.capabilitiesSaveMcp, {
serverId,
input
}) as Promise<CapabilitySnapshot>,
removeMcpServer: (serverId) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesRemoveMcp,
serverId
) as Promise<CapabilitySnapshot>,
testMcpServer: (serverId) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesTestMcp,
serverId
) as Promise<McpServerTestResult>,
setWebSearchEnabled: (enabled: boolean) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesToggleWebSearch,
enabled
) as Promise<CapabilitySnapshot>,
testWebSearch: () =>
ipcRenderer.invoke(
ipcChannels.capabilitiesTestWebSearch
) as Promise<WebSearchTestResult>,
setComputerCapabilityEnabled: (
capabilityId: ComputerCapabilityId,
enabled: boolean
) =>
ipcRenderer.invoke(ipcChannels.capabilitiesToggleComputer, {
capabilityId,
enabled
}) as Promise<CapabilitySnapshot>,
setComputerCapabilityBrowserProfile: (
capabilityId: ComputerCapabilityId,
browserProfileId: string | null
) =>
ipcRenderer.invoke(ipcChannels.capabilitiesConfigureComputer, {
capabilityId,
browserProfileId
}) as Promise<CapabilitySnapshot>,
diagnoseComputerCapability: (capabilityId: ComputerCapabilityId) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesDiagnoseComputer,
capabilityId
) as Promise<CapabilityDiagnosticReport>,
createBrowserProfile: (input: BrowserProfileCreateInput) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesCreateBrowserProfile,
input
) as Promise<CapabilitySnapshot>,
renameBrowserProfile: (input: BrowserProfileRenameInput) =>
ipcRenderer.invoke(
ipcChannels.capabilitiesRenameBrowserProfile,
input
) as Promise<CapabilitySnapshot>,
setDefaultBrowserProfile: (profileId: string) =>
ipcRenderer.invoke(ipcChannels.capabilitiesDefaultBrowserProfile, {
profileId
}) as Promise<CapabilitySnapshot>,
removeBrowserProfile: (profileId: string) =>
ipcRenderer.invoke(ipcChannels.capabilitiesRemoveBrowserProfile, {
profileId
}) as Promise<CapabilitySnapshot>
},
runtimeExtensions: {
getSnapshot: () =>
ipcRenderer.invoke(
ipcChannels.runtimeExtensionsSnapshot
) as Promise<RuntimeExtensionMarketplaceSnapshot>,
apply: (action: RuntimeExtensionAction) =>
ipcRenderer.invoke(
ipcChannels.runtimeExtensionsApply,
action
) as Promise<RuntimeExtensionMarketplaceSnapshot>
},
runtimeCustomization: {
getSettings: () =>
ipcRenderer.invoke(
ipcChannels.runtimeCustomizationGet
) as Promise<RuntimeCustomizationSettings>,
updateSettings: (settings: RuntimeCustomizationSettings) =>
ipcRenderer.invoke(
ipcChannels.runtimeCustomizationUpdate,
settings
) as Promise<RuntimeCustomizationSettings>,
getNativeSnapshot: (input: RuntimeNativeSnapshotInput) =>
ipcRenderer.invoke(
ipcChannels.runtimeNativeSnapshot,
input
) as Promise<RuntimeNativeSnapshot>
},
context: {
selectFiles: () =>
ipcRenderer.invoke(
ipcChannels.contextSelectFiles
) as Promise<ContextAttachment[]>,
onFileSelectionProgress: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
progress: ContextFileSelectionProgress
): void => listener(progress)
ipcRenderer.on(ipcChannels.contextFileSelectionProgress, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.contextFileSelectionProgress,
handler
)
},
addPastedImage: (input: PastedImageInput) =>
ipcRenderer.invoke(
ipcChannels.contextAddPastedImage,
input
) as Promise<ContextAttachment>,
captureScreen: () =>
ipcRenderer.invoke(
ipcChannels.contextCaptureScreen
) as Promise<ContextAttachment>,
listWindows: () =>
ipcRenderer.invoke(
ipcChannels.contextListWindows
) as Promise<WindowCaptureOption[]>,
captureWindow: (sourceId) =>
ipcRenderer.invoke(
ipcChannels.contextCaptureWindow,
{ sourceId }
) as Promise<ContextAttachment>,
readClipboard: () =>
ipcRenderer.invoke(
ipcChannels.contextReadClipboard
) as Promise<ContextAttachment>,
remove: async (contextId: string) => {
await ipcRenderer.invoke(ipcChannels.contextRemove, contextId)
}
},
magicNotes: {
list: () =>
ipcRenderer.invoke(
ipcChannels.magicNotesList
) as Promise<MagicNotesSnapshot>,
get: (noteId: string) =>
ipcRenderer.invoke(ipcChannels.magicNotesGet, {
noteId
}) as Promise<MagicNoteDetail>,
create: (input) =>
ipcRenderer.invoke(
ipcChannels.magicNotesCreate,
input
) as Promise<MagicNoteDetail>,
update: (input) =>
ipcRenderer.invoke(
ipcChannels.magicNotesUpdate,
input
) as Promise<MagicNoteDetail>,
remove: async (noteId: string) => {
await ipcRenderer.invoke(ipcChannels.magicNotesDelete, { noteId })
},
createEntry: (input) =>
ipcRenderer.invoke(
ipcChannels.magicNotesCreateEntry,
input
) as Promise<MagicNoteDetail>,
updateEntry: (input) =>
ipcRenderer.invoke(
ipcChannels.magicNotesUpdateEntry,
input
) as Promise<MagicNoteDetail>,
removeEntry: (entryId: string) =>
ipcRenderer.invoke(ipcChannels.magicNotesDeleteEntry, {
entryId
}) as Promise<MagicNoteDetail>,
analyze: (entryId, options) =>
ipcRenderer.invoke(ipcChannels.magicNotesAnalyze, {
entryId,
...options
}) as Promise<MagicNoteDetail>,
analyzeDraft: (content, options) =>
ipcRenderer.invoke(
ipcChannels.magicNotesAnalyzeDraft,
{ content, ...options }
) as Promise<MagicNoteDraftAnalysis>,
listTodos: () =>
ipcRenderer.invoke(
ipcChannels.magicTodosList
) as Promise<MagicTodosSnapshot>,
getTodoStatus: () =>
ipcRenderer.invoke(
ipcChannels.magicTodosStatus
) as Promise<MagicTodoStatus>,
updateTodo: (input) =>
ipcRenderer.invoke(
ipcChannels.magicTodosUpdate,
input
) as Promise<MagicTodoUpdateResult>,
analyzeTodo: (todoId, options) =>
ipcRenderer.invoke(ipcChannels.magicTodosAnalyze, {
todoId,
...options
}) as Promise<MagicTodoItem>,
onAnalysisEvent: (listener) => {
const handler = (
_event: Electron.IpcRendererEvent,
payload: MagicNoteAnalysisStreamEvent
): void => listener(payload)
ipcRenderer.on(ipcChannels.magicNotesAnalysisEvent, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.magicNotesAnalysisEvent,
handler
)
},
onTodoStatusChanged: (listener) => {
const handler = (): void => listener()
ipcRenderer.on(ipcChannels.magicTodosStatusChanged, handler)
return () =>
ipcRenderer.removeListener(
ipcChannels.magicTodosStatusChanged,
handler
)
}
},
knowledge: {
getSnapshot: (libraryId?: string) =>
ipcRenderer.invoke(
ipcChannels.knowledgeSnapshot,
libraryId
) as Promise<KnowledgeSnapshot>,
createLibrary: (input) =>
ipcRenderer.invoke(
ipcChannels.knowledgeCreateLibrary,
input
) as Promise<KnowledgeLibrary>,
updateLibrary: async (libraryId, update) => {
await ipcRenderer.invoke(ipcChannels.knowledgeUpdateLibrary, {
libraryId,
...update
})
},
deleteLibrary: async (libraryId) => {
await ipcRenderer.invoke(
ipcChannels.knowledgeDeleteLibrary,
libraryId
)
},
reextractGraph: (libraryId) =>
ipcRenderer.invoke(
ipcChannels.knowledgeReextractGraph,
libraryId
) as Promise<void>,
selectFiles: async (libraryId, graphStrategy) => {
await ipcRenderer.invoke(ipcChannels.knowledgeSelectFiles, {
libraryId,
graphStrategy
})
},
selectDirectory: async (libraryId, graphStrategy) => {
await ipcRenderer.invoke(
ipcChannels.knowledgeSelectDirectory,
{ libraryId, graphStrategy }
)
},
importDroppedFiles: async (libraryId, files, graphStrategy) => {
const paths = files
.map((file) => webUtils.getPathForFile(file))
.filter(Boolean)
await ipcRenderer.invoke(ipcChannels.knowledgeImportPaths, {
libraryId,
paths,
graphStrategy
})
},
importUrl: async (libraryId, url, graphStrategy) => {
await ipcRenderer.invoke(ipcChannels.knowledgeImportUrl, {
libraryId,
url,
graphStrategy
})
},
syncSource: async (sourceId) => {
await ipcRenderer.invoke(ipcChannels.knowledgeSyncSource, sourceId)
},
pauseSource: async (sourceId) => {
await ipcRenderer.invoke(ipcChannels.knowledgePauseSource, sourceId)
},
retrySource: async (sourceId) => {
await ipcRenderer.invoke(ipcChannels.knowledgeRetrySource, sourceId)
},
removeSource: async (sourceId) => {
await ipcRenderer.invoke(ipcChannels.knowledgeRemoveSource, sourceId)
},
search: (libraryIds, query) =>
ipcRenderer.invoke(ipcChannels.knowledgeSearch, {
libraryIds,
query
}) as Promise<KnowledgeSearchReference[]>,
retrieve: (input: KnowledgeRetrieveInput) =>
ipcRenderer.invoke(
ipcChannels.knowledgeRetrieve,
input
) as Promise<KnowledgeRetrievalResponse>,
updateSettings: (input: KnowledgeSettingsUpdateInput) =>
ipcRenderer.invoke(
ipcChannels.knowledgeUpdateSettings,
input
) as Promise<KnowledgeLibrary>,
listChunks: (input: KnowledgeChunksListInput) =>
ipcRenderer.invoke(
ipcChannels.knowledgeListChunks,
input
) as Promise<KnowledgeChunkPage>,
updateChunk: async (input: KnowledgeChunkUpdateInput) => {
await ipcRenderer.invoke(ipcChannels.knowledgeUpdateChunk, input)
},
deleteChunk: async (input: KnowledgeChunkDeleteInput) => {
await ipcRenderer.invoke(ipcChannels.knowledgeDeleteChunk, input)
},
rebuildDocument: (input: KnowledgeDocumentRebuildInput) =>
ipcRenderer.invoke(
ipcChannels.knowledgeRebuildDocument,
input
) as Promise<KnowledgeSnapshot>,
rebuildLibrary: (input: KnowledgeLibraryRebuildInput) =>
ipcRenderer.invoke(
ipcChannels.knowledgeRebuildLibrary,
input
) as Promise<{ rebuilt: number; failed: number }>,
cancelRebuild: (knowledgeBaseId: string) =>
ipcRenderer.invoke(
ipcChannels.knowledgeCancelRebuild,
knowledgeBaseId
) as Promise<boolean>,
getEmbeddingIndex: (knowledgeBaseId: string) =>
ipcRenderer.invoke(ipcChannels.knowledgeEmbeddingIndexGet, {
knowledgeBaseId
}) as Promise<KnowledgeEmbeddingIndexSnapshot>,
rebuildEmbeddingIndex: (knowledgeBaseId: string) =>
ipcRenderer.invoke(
ipcChannels.knowledgeEmbeddingIndexRebuild,
{ knowledgeBaseId }
) as Promise<KnowledgeEmbeddingIndexSnapshot>,
cancelEmbeddingIndex: (
knowledgeBaseId: string,
jobId: string
) =>
ipcRenderer.invoke(
ipcChannels.knowledgeEmbeddingIndexCancel,
{ knowledgeBaseId, jobId }
) as Promise<boolean>,
cancelTask: (taskId: string) =>
ipcRenderer.invoke(
ipcChannels.knowledgeTaskCancel,
{ taskId }
) as Promise<boolean>,
retryTask: async (taskId: string) => {
await ipcRenderer.invoke(
ipcChannels.knowledgeTaskRetry,
{ taskId }
)
},
getReferenceContext: (input: KnowledgeReferenceContextInput) =>
ipcRenderer.invoke(
ipcChannels.knowledgeReferenceContext,
input
) as Promise<KnowledgeReferenceContext>,
openReferenceSource: async (input: KnowledgeReferenceOpenInput) => {
await ipcRenderer.invoke(
ipcChannels.knowledgeOpenReferenceSource,
input
)
},
createEntity: async (libraryId, input) => {
await ipcRenderer.invoke(ipcChannels.knowledgeCreateEntity, {
libraryId,
input
})
},
updateEntity: async (entityId, update) => {
await ipcRenderer.invoke(ipcChannels.knowledgeUpdateEntity, {
entityId,
update
})
},
moveEntity: async (entityId, position) => {
await ipcRenderer.invoke(ipcChannels.knowledgeMoveEntity, {
entityId,
position
})
},
deleteEntity: async (entityId) => {
await ipcRenderer.invoke(ipcChannels.knowledgeDeleteEntity, entityId)
},
mergeEntities: async (sourceEntityId, targetEntityId) => {
await ipcRenderer.invoke(ipcChannels.knowledgeMergeEntities, {
sourceEntityId,
targetEntityId
})
},
createRelation: async (libraryId, input) => {
await ipcRenderer.invoke(ipcChannels.knowledgeCreateRelation, {
libraryId,
input
})
},
updateRelation: async (relationId, input) => {
await ipcRenderer.invoke(ipcChannels.knowledgeUpdateRelation, {
relationId,
input
})
},
deleteRelation: async (relationId) => {
await ipcRenderer.invoke(
ipcChannels.knowledgeDeleteRelation,
relationId
)
}
}
}
contextBridge.exposeInMainWorld('goodbuddy', desktopApi)