memshell-party-cli 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -263,6 +263,55 @@ declare const JDK_VERSIONS: Record<string, number>;
  */
 declare function resolveJreVersion(input: string | number | undefined): number | undefined;
 
+type OpCategory = "gen" | "probe" | "connect" | "exec" | "target";
+interface OpLogEntry {
+    /** ISO timestamp. */
+    ts: string;
+    category: OpCategory;
+    /** What happened: "gen" | "probe" | "connect" | "exec" | "save" | "note" | "remove". */
+    action: string;
+    /** Saved `project/shell` reference, when the operation used one. */
+    targetName?: string;
+    url?: string;
+    tool?: string;
+    ok: boolean;
+    durationMs?: number;
+    /** Short human-readable success detail. */
+    detail?: string;
+    error?: string;
+    /** exec only: the command line. */
+    command?: string;
+    /** exec only: remote output, truncated to OUTPUT_LIMIT. */
+    output?: string;
+    outputTruncated?: boolean;
+    /** Extra structured fields (target meta, gen params — never credentials). */
+    meta?: Record<string, unknown>;
+}
+/** exec output is truncated to this many characters in the log. */
+declare const OUTPUT_LIMIT = 2000;
+declare function opLogPath(): string;
+/** Append one entry. Never throws. */
+declare function logOp(entry: Omit<OpLogEntry, "ts">): void;
+interface OpFilter {
+    category?: OpCategory;
+    /**
+     * Match by saved target reference ("hw222" also matches "hw222/bh9060")
+     * or by a substring of the URL (e.g. a host).
+     */
+    target?: string;
+    /** Max entries returned (default 50). */
+    limit?: number;
+}
+/** Read entries matching the filter, newest first. */
+declare function readOps(filter?: OpFilter): OpLogEntry[];
+/** Truncate exec output for the log. */
+declare function truncateOutput(output: string): {
+    output: string;
+    truncated: boolean;
+};
+/** One-line rendering for `memparty log`. */
+declare function formatOp(e: OpLogEntry): string;
+
 declare function createMcpServer(client: MemPartyClient): McpServer;
 /** Start the MCP server over stdio. */
 declare function startMcpStdio(client: MemPartyClient): Promise<void>;
@@ -279,6 +328,18 @@ interface ConnectTestResult {
     error?: string;
     durationMs: number;
 }
+interface ExecResult {
+    ok: boolean;
+    tool: ConnectTool;
+    url: string;
+    /** The command line as executed remotely. */
+    command: string;
+    /** Decoded remote stdout+stderr (present on success). */
+    output?: string;
+    /** Human-readable failure reason. */
+    error?: string;
+    durationMs: number;
+}
 interface CommonConnectOptions {
     /**
      * MemShellParty shells are gated by a header check:
@@ -293,13 +354,111 @@ interface CommonConnectOptions {
     insecure?: boolean;
 }
 
+/** A saved shell connection profile, stored inside a project. */
+interface StoredShell {
+    url: string;
+    tool: ConnectTool;
+    pass?: string;
+    key?: string;
+    headerName?: string;
+    headerValue?: string;
+    extraHeaders?: Record<string, string>;
+    insecure?: boolean;
+    /** Free-form note for this shell (e.g. "DMZ 跳板机"). */
+    remark?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+type ShellInput = Omit<StoredShell, "createdAt" | "updatedAt">;
+/** A named group of shells with a remark and a category. */
+interface StoredProject {
+    remark?: string;
+    category?: string;
+    createdAt: string;
+    updatedAt: string;
+    shells: Record<string, StoredShell>;
+}
+declare function targetStorePath(): string;
+declare function listProjects(): Record<string, StoredProject>;
+declare function getProject(name: string): StoredProject | null;
+/** Create a project or update its remark/category (only given fields change). */
+declare function saveProjectMeta(name: string, meta: {
+    remark?: string;
+    category?: string;
+}): StoredProject;
+/** Save a shell under `<project>/<shell>`; creates the project if needed. */
+declare function saveShell(projectName: string, shellName: string, input: ShellInput): StoredShell;
+/** Remove a whole project. Returns false when it did not exist. */
+declare function removeProject(name: string): boolean;
+/** Remove one shell from a project. Returns false when it did not exist. */
+declare function removeShell(projectName: string, shellName: string): boolean;
+/** Set or clear (empty string) a shell's remark. */
+declare function saveShellMeta(projectName: string, shellName: string, meta: {
+    remark?: string;
+}): StoredShell;
+/** CLI/MCP flags that can override a stored shell's values. */
+interface ConnectionFlags {
+    url?: string;
+    tool?: string;
+    pass?: string;
+    key?: string;
+    headerName?: string;
+    headerValue?: string;
+    extraHeaders?: Record<string, string>;
+    insecure?: boolean;
+}
+interface ResolvedConnection {
+    url: string;
+    tool: ConnectTool;
+    pass?: string;
+    key?: string;
+    headerName?: string;
+    headerValue?: string;
+    extraHeaders: Record<string, string>;
+    insecure?: boolean;
+    /** Canonical `project/shell` reference, when resolved from the store. */
+    targetName?: string;
+}
+/**
+ * Merge an optional saved shell reference (`<project>/<shell>` or a bare
+ * project holding exactly one shell) with explicit flags.
+ * Priority: explicit flag > stored value.
+ */
+declare function resolveConnection(ref: string | undefined, flags: ConnectionFlags): ResolvedConnection;
+
 interface BehinderConnectOptions extends CommonConnectOptions {
     /** Request body encoding. Default: try base64, then raw AES bytes. */
     requestEncoding?: "base64" | "raw";
 }
 declare function testBehinder(url: string, pass: string, options?: BehinderConnectOptions): Promise<ConnectTestResult>;
+/**
+ * Behinder command execution — uploads the `Cmd` payload class with its
+ * static `cmd` field filled in (same `Params.getParamedClass` mechanism as
+ * the Echo payload). The payload picks `cmd.exe /c` or `/bin/sh -c` itself
+ * based on `os.name`, so no OS detection is needed here.
+ * The response is the usual Behinder envelope: base64(AES({status, msg})),
+ * where `msg` is the base64-encoded command output (stdout then stderr).
+ */
+declare function execBehinder(url: string, pass: string, command: string, options?: BehinderConnectOptions): Promise<ExecResult>;
 
 declare function testGodzilla(url: string, pass: string, key: string, options?: CommonConnectOptions): Promise<ConnectTestResult>;
+interface GodzillaExecOptions extends CommonConnectOptions {
+    /**
+     * Remote OS family, used to pick the shell wrapper (`cmd.exe /c` vs
+     * `/bin/sh -c`). "auto" (default) asks the payload's `getBasicsInfo`
+     * first — one extra request per exec.
+     */
+    os?: "auto" | "windows" | "linux";
+}
+/**
+ * Godzilla command execution — invokes the payload's `execCommand` method.
+ *
+ * Same transport as the connect test (payload upload + cookie relay), then:
+ *   methodName=execCommand, argsCount=N, arg-0..arg-(N-1) = argv
+ * The payload runs `Runtime.exec(argv)` (no shell of its own), so the
+ * command line is wrapped in `cmd.exe /c` or `/bin/sh -c` here.
+ */
+declare function execGodzilla(url: string, pass: string, key: string, command: string, options?: GodzillaExecOptions): Promise<ExecResult>;
 
 type Suo5Mode = "auto" | "v2" | "v1";
 interface Suo5ConnectOptions extends CommonConnectOptions {
@@ -321,4 +480,4 @@ declare function testSuo5(url: string, options?: Suo5ConnectOptions): Promise<Co
 
 declare const CLI_VERSION: string;
 
-export { ApiError, type ApiErrorResponse, type BehinderConnectOptions, CLI_VERSION, type CommandConfigVO, type CommonConnectOptions, type ConnectTestResult, type ConnectTool, DEFAULT_API_URL, ENV_VAR, type FetchLike, type InjectorConfig, JDK_VERSIONS, type MainConfig, MemPartyClient, type MemPartyClientOptions, type MemShellGenerateRequest, type MemShellGenerateResponse, type MemShellOptions, type MemShellResult, type OutputOptions, type OutputResult, type PackerOption, type PackerTree, type ProbeConfig, type ProbeContent, type ProbeContentConfig, type ProbeMethod, type ProbeOptions, type ProbeShellGenerateRequest, type ProbeShellGenerateResponse, type ProbeShellResult, type ServerConfig, type ShellConfig, type ShellToolConfig, type Suo5ConnectOptions, type Suo5Mode, type VersionInfo, buildMemShellRequest, buildProbeRequest, createMcpServer, emitPayload, marshalFrameBase64, marshalSuo5Map, resolveApiUrl, resolveJreVersion, shouldDecode, startMcpStdio, testBehinder, testGodzilla, testSuo5, unmarshalFrameBase64, unmarshalSuo5Map };
+export { ApiError, type ApiErrorResponse, type BehinderConnectOptions, CLI_VERSION, type CommandConfigVO, type CommonConnectOptions, type ConnectTestResult, type ConnectTool, type ConnectionFlags, DEFAULT_API_URL, ENV_VAR, type ExecResult, type FetchLike, type GodzillaExecOptions, type InjectorConfig, JDK_VERSIONS, type MainConfig, MemPartyClient, type MemPartyClientOptions, type MemShellGenerateRequest, type MemShellGenerateResponse, type MemShellOptions, type MemShellResult, OUTPUT_LIMIT, type OpCategory, type OpFilter, type OpLogEntry, type OutputOptions, type OutputResult, type PackerOption, type PackerTree, type ProbeConfig, type ProbeContent, type ProbeContentConfig, type ProbeMethod, type ProbeOptions, type ProbeShellGenerateRequest, type ProbeShellGenerateResponse, type ProbeShellResult, type ResolvedConnection, type ServerConfig, type ShellConfig, type ShellInput, type ShellToolConfig, type StoredProject, type StoredShell, type Suo5ConnectOptions, type Suo5Mode, type VersionInfo, buildMemShellRequest, buildProbeRequest, createMcpServer, emitPayload, execBehinder, execGodzilla, formatOp, getProject, listProjects, logOp, marshalFrameBase64, marshalSuo5Map, opLogPath, readOps, removeProject, removeShell, resolveApiUrl, resolveConnection, resolveJreVersion, saveProjectMeta, saveShell, saveShellMeta, shouldDecode, startMcpStdio, targetStorePath, testBehinder, testGodzilla, testSuo5, truncateOutput, unmarshalFrameBase64, unmarshalSuo5Map };