@lengmoxxl/sdk 0.1.0 → 0.1.1

package/README.md

@@ -2,8 +2,8 @@
 The client SDK for [WangCai](https://github.com/lengmoXXL/WangCai), the terminal app. It reaches a machine, the one
 the app runs on or one over SSH, and drives its terminals, files and subprocesses through a single connection.
 
-A WangCai plugin compiles against this package, but at load time the app injects its own copy of this module, so a
-plugin never carries its own connection pool.
+A WangCai plugin compiles against this package for the types it uses; the machines belong to the app, which keeps
+one connection per machine and hands it to every plugin that asks for one.
 
 ## Install
 
@@ -16,9 +16,9 @@ npm install @lengmoxxl/sdk
 ## Use
 
 ```ts
-import { connect } from '@lengmoxxl/sdk';
+import { openMachine } from '@lengmoxxl/sdk';
 
-const connection = await connect({ type: 'local', binary: '/path/to/wangcai' });
+const connection = await openMachine({ type: 'local', binary: '/path/to/wangcai' });
 
 const sessions = await connection.pty.list();
 const session = await connection.pty.create({ rows: 24, cols: 80 }, '/repo');
@@ -30,9 +30,10 @@ const { stdout } = await connection.subprocess.exec('git', ['status'], { cwd: '/
 connection.disconnect();
 ```
 
-`connect` returns a `MachineConnection`. Connections are shared per target and reference counted, so two callers
-asking for the same SSH host drive one tunnel; the last `disconnect()` tears it down. `connect({ type: 'ssh', host,
-agent })` installs the carrier agent on the host first when `agent` is given.
+`openMachine` returns a `MachineConnection`; every call opens its own. Sharing one belongs to the caller: a
+connection is reference counted, so callers that hand the same one around keep it alive until the last
+`disconnect()`. `openMachine({ type: 'ssh', host, agent })` installs the carrier agent on the host first when
+`agent` is given.
 
 - `connection.pty` - `list`, `cwd`, `create`, `attach`, `close`
 - `connection.fs` - `stat`, `readDirectory`, `readFile`
@@ -50,4 +51,4 @@ npm run build
 
 From the repository root (the TypeScript and esbuild devDependencies live in the workspace root): esbuild bundles
 `index.ts` into `dist/index.cjs` with `ws` left external, then `tsc` emits the declarations. `npm publish` and
-`npm pack` run it for you.
+`npm pack` run it for you.

package/dist/channel.d.ts

@@ -1,4 +1,4 @@
-import type { AgentInfo } from './types';
+import type { MachineConnection } from './connection';
 export type Dispose = () => void | Promise<void>;
 /** A sidebar tab the window opens for a plugin: what it is called, and what it draws. */
 export interface TabOptions {
@@ -31,10 +31,11 @@ export interface MainContext {
         handle<T = unknown>(method: string, handler: (params: T) => unknown): Dispose;
         publish(topic: string, data: unknown): void;
     };
+    connect(machine: {
+        host?: string;
+    }, signal?: AbortSignal): Promise<MachineConnection>;
     host: {
         dataDirectory: string;
-        resourcesDirectory: string;
-        agent: AgentInfo;
         config: any;
     };
 }

package/dist/index.cjs

@@ -30,8 +30,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // index.ts
 var index_exports = {};
 __export(index_exports, {
-  connect: () => connect,
-  ensureAgent: () => ensureAgent
+  ensureAgent: () => ensureAgent,
+  openMachine: () => openMachine
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -489,19 +489,9 @@ var MachineConnection = class {
 };
 
 // index.ts
-var connections = /* @__PURE__ */ new Map();
-async function connect(options) {
+async function openMachine(options) {
   options.signal?.throwIfAborted();
-  const target = options.type === "ssh" ? `ssh:${options.host}` : `local:${options.binary ?? "wangcai"}`;
-  const shared = connections.get(target);
-  const machine = shared ?? new MachineConnection(options);
-  if (shared) machine.retain();
-  else {
-    connections.set(target, machine);
-    machine.onState((state) => {
-      if (state.status === "disconnected" && connections.get(target) === machine) connections.delete(target);
-    });
-  }
+  const machine = new MachineConnection(options);
   const aborted = new Promise((_, reject) => {
     options.signal?.addEventListener("abort", () => reject(new Error("Connection cancelled")), { once: true });
   });
@@ -515,6 +505,6 @@ async function connect(options) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  connect,
-  ensureAgent
+  ensureAgent,
+  openMachine
 });

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export type { AgentInfo, ConnectionOptions, FileClick, Machine, MachineState, Se
 export type { MachineConnection } from './connection';
 export type { Pty } from './pty';
 export { ensureAgent } from './agent';
-export declare function connect(options: ConnectionOptions): Promise<MachineConnection>;
+/** Opens one connection to a machine and waits for it to be ready. */
+export declare function openMachine(options: ConnectionOptions): Promise<MachineConnection>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lengmoxxl/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Client SDK for WangCai: connect to a local or remote machine and drive its pty, files and git",
   "license": "MIT",
   "repository": {