Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2024-12-21 16:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

some ideas for new plugin api

Browse Source
This commit is contained in:
sawka 2024-02-15 09:03:23 -08:00
parent fb7f055449
commit 8af0b0b7ae
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
src/plugins/pluginapi.ts Normal file
View File

@ -0,0 +1,41 @@
// Copyright 2024, Command Line Inc.
// SPDX-License-Identifier: Apache-2.0
type CmdContextType = {
screenid: string;
lineid: string;
linenum: number;
ts: number;
cmdstr: string;
festate: Record<string, string>;
remoteptr: RemotePtrType;
cmdstatus: string;
exitcode: number;
durationms: number;
};
type DataUpdateType = {
pos: number;
data: Uint8Array;
eof: boolean;
};
type PluginApi = {
loadPtyData(): Promise<ExtFile>;
onDataUpdate(datatype: string, cb: (datatype: string, update: DataUpdateType) => void): void;
onCmdDone(cb: (cmdContext: CmdContextType) => void): void;
releaseFocus(): void;
setLineState(lineState: LineStateType): void;
writeRemoteFile(filePath: string, data: Uint8Array): Promise<void>;
readRemoteFile(filePath: string): ExtFile;
streamRemoteFile(filePath: string, cb: (data: DataUpdateType) => void): void;
};
type PluginProps = {
cmdContext: CmdContextType;
pluginDecl: RendererPluginType;
rendererOpts: RendererOpts;
lineState: LineStateType;
focusState: "none" | "selected" | "focused";
api: PluginApi;
};