@dbx-tools/lakebox 0.0.0-stage → 0.9.132

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,147 @@
-# Temporary Holding Version
+# @dbx-tools/lakebox
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Connect to, provision, and run commands on Databricks Lakeboxes.
+
+## Provision a Lakebox
+
+```ts
+import { client as authClient } from "@dbx-tools/auth";
+import { LakeboxClient } from "@dbx-tools/lakebox/rest";
+import { ensureLakeboxRunning } from "@dbx-tools/lakebox/lifecycle";
+
+const auth = await authClient.createAuthClient({ profile: "MY-PROFILE" });
+const api = new LakeboxClient({
+  host: auth.host,
+  ...(auth.workspaceId ? { workspaceId: auth.workspaceId } : {}),
+  authenticate: async (headers) => {
+    for (const [name, value] of Object.entries(await auth.headers())) {
+      headers.set(name, value);
+    }
+  },
+});
+const entry = await api.create();
+await api.setIdleTimeout(entry.sandboxId, 3_600);
+const running = await ensureLakeboxRunning(api, entry);
+```
+
+`LakeboxClient` accepts any credential object with `host` and
+`authenticate(headers)`. AppKit and the Databricks SDK
+`WorkspaceClient.config` satisfy this contract directly. The example adapts
+`@dbx-tools/auth` for an explicit local profile. Use the app service principal
+for lifecycle calls in a Databricks App.
+
+## Connect and run a command
+
+Create or load an SSH key, register it with the workspace, verify the gateway
+host key, and close the session when work finishes:
+
+```ts
+import { SshKeyStore } from "@dbx-tools/lakebox/key-store";
+import type { LakeboxClient, LakeboxEntry } from "@dbx-tools/lakebox/rest";
+import { SshSession } from "@dbx-tools/lakebox/session";
+
+export async function runCommand(
+  api: LakeboxClient,
+  running: LakeboxEntry,
+  user: { name: string; home: string },
+): Promise<void> {
+  const owner = "my-service";
+  const keys = new SshKeyStore();
+  const key = await keys.ensureRegistered(api, owner);
+  const gatewayHost = running.gatewayHost ?? key.gatewayHost;
+  if (!gatewayHost) {
+    throw new Error("The Lakebox API did not return an SSH gateway host");
+  }
+
+  const gatewayPort = 2_222;
+  const scope = await api.workspaceScope();
+  const knownHost = await keys.knownHost(scope, owner, gatewayHost, gatewayPort);
+  const session = new SshSession({
+    host: gatewayHost,
+    port: gatewayPort,
+    username: running.sandboxId,
+    privateKey: key.privateKey,
+    privateKeyPath: key.privateKeyPath,
+    knownHostsPath: keys.knownHostsPath(scope, owner, gatewayHost, gatewayPort),
+    connectTimeoutMs: 30_000,
+    sshTransport: "auto",
+    ssh2Patch: "auto",
+    ...(knownHost ? { knownHost } : {}),
+    rememberHost: (fingerprint, hostKey) =>
+      keys.rememberHost(scope, owner, gatewayHost, gatewayPort, fingerprint, hostKey),
+  });
+
+  try {
+    await session.connect();
+    const command = session.execute("sh", ["-lc", "uname -a"], {
+      user,
+      timeoutMs: 30_000,
+    });
+    const result = await command.result;
+    if (!result.success) {
+      throw new Error(result.stderr || `Command exited with ${result.exitCode}`);
+    }
+  } finally {
+    await session.close();
+  }
+}
+```
+
+Every command clears inherited Databricks credentials and SSH agent variables
+before it runs. `execute()` returns a live `SshCommand`. Its `stdout` and
+`stderr` fields are async iterables, awaiting the command returns its numeric
+exit code, and `result` returns captured output and timing metadata.
+
+The low-level package doesn't create Linux users. Pass an account that already
+exists on the Lakebox. `@dbx-tools/appkit-lakebox` creates and isolates
+application user accounts before it runs their commands.
+
+`forwardOut(host, port)` opens a forwarded TCP stream through a separate pool.
+Long-lived HTTP and WebSocket streams don't consume the warm command
+connection.
+
+## Stop or delete a Lakebox
+
+Use lifecycle convergence when you need to wait for a terminal state:
+
+```ts
+import { ensureLakeboxStopped } from "@dbx-tools/lakebox/lifecycle";
+import type { LakeboxClient, LakeboxEntry } from "@dbx-tools/lakebox/rest";
+
+export async function stopAndDelete(api: LakeboxClient, running: LakeboxEntry): Promise<void> {
+  const stopped = await ensureLakeboxStopped(api, running);
+  await api.delete(stopped.sandboxId);
+}
+```
+
+`stop()` preserves the persistent Lakebox filesystem. `delete()` permanently
+removes the Lakebox and its data.
+
+## Configuration
+
+| Field          | Values                    | Default                                   |
+| -------------- | ------------------------- | ----------------------------------------- |
+| `sshTransport` | `auto`, `openssh`, `ssh2` | `auto` prefers native OpenSSH with SOCKS5 |
+| `ssh2Patch`    | `auto`, `true`, `false`   | `auto` patches only in development        |
+
+`SshSessionOptions` also requires the gateway host and port, Lakebox ID as the
+SSH username, private key material, key and known-host paths, and a connection
+timeout. `SshKeyStore` stores keys and gateway fingerprints under
+`~/.dbx-tools/lakebox` unless you pass another root.
+
+## Understand lifecycle and transport limits
+
+- `ensureLakeboxRunning()` and `ensureLakeboxStopped()` poll for up to five
+  minutes.
+- The REST client doesn't map users, persist app resource identity, or manage
+  services. Use [@dbx-tools/appkit-lakebox](../appkit-lakebox/README.md) for
+  those application-level capabilities.
+- The command pool keeps one tested connection warm and grows to 10
+  connections. Forwarding uses a separate pool with no minimum.
+- Each borrowed SSH resource handles one operation and is destroyed after that
+  command or forwarded stream. A failed forwarding open retries once with a new
+  resource. Established streams and commands aren't replayed.
+- `auto` selects native OpenSSH when it is available and selects ssh2
+  otherwise. It doesn't switch transports after a runtime failure.
+- `close()` cancels active commands, closes transport pools, and waits for an
+  in-progress connection attempt to settle.

package/index.ts

@@ -0,0 +1,18 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+
+export const PACKAGE_IDENTIFIER = "@dbx-tools/lakebox";
+export const PACKAGE_VERSION = "0.9.132";
+export * as keyStore from "./src/key-store.ts";
+export * as lifecycle from "./src/lifecycle.ts";
+export * as rest from "./src/rest.ts";
+export * as session from "./src/session.ts";
+export * as transport from "./src/transport.ts";
+export { SshKeyStore } from "./src/key-store.ts";
+export { LakeboxEntrySchema, LakeboxSshKeySchema, LakeboxApiError, LakeboxClient } from "./src/rest.ts";
+export type { LakeboxEntry, LakeboxSshKey, LakeboxAuth } from "./src/rest.ts";
+export { SshSession } from "./src/session.ts";
+export type { SshSessionOptions } from "./src/session.ts";
+export { SshTransportModeSchema, Ssh2PatchModeSchema } from "./src/transport.ts";
+export type { SshTransportMode, Ssh2PatchMode } from "./src/transport.ts";

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+export declare const PACKAGE_IDENTIFIER = "@dbx-tools/lakebox";
+export declare const PACKAGE_VERSION = "0.9.132";
+export * as keyStore from "./src/key-store.ts";
+export * as lifecycle from "./src/lifecycle.ts";
+export * as rest from "./src/rest.ts";
+export * as session from "./src/session.ts";
+export * as transport from "./src/transport.ts";
+export { SshKeyStore } from "./src/key-store.ts";
+export { LakeboxEntrySchema, LakeboxSshKeySchema, LakeboxApiError, LakeboxClient } from "./src/rest.ts";
+export type { LakeboxEntry, LakeboxSshKey, LakeboxAuth } from "./src/rest.ts";
+export { SshSession } from "./src/session.ts";
+export type { SshSessionOptions } from "./src/session.ts";
+export { SshTransportModeSchema, Ssh2PatchModeSchema } from "./src/transport.ts";
+export type { SshTransportMode, Ssh2PatchMode } from "./src/transport.ts";

package/lib/index.js

@@ -0,0 +1,15 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+export const PACKAGE_IDENTIFIER = "@dbx-tools/lakebox";
+export const PACKAGE_VERSION = "0.9.132";
+export * as keyStore from "./src/key-store.js";
+export * as lifecycle from "./src/lifecycle.js";
+export * as rest from "./src/rest.js";
+export * as session from "./src/session.js";
+export * as transport from "./src/transport.js";
+export { SshKeyStore } from "./src/key-store.js";
+export { LakeboxEntrySchema, LakeboxSshKeySchema, LakeboxApiError, LakeboxClient } from "./src/rest.js";
+export { SshSession } from "./src/session.js";
+export { SshTransportModeSchema, Ssh2PatchModeSchema } from "./src/transport.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxvQkFBb0IsQ0FBQztBQUN2RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxRQUFRLE1BQU0sb0JBQW9CLENBQUM7QUFDL0MsT0FBTyxLQUFLLFNBQVMsTUFBTSxvQkFBb0IsQ0FBQztBQUNoRCxPQUFPLEtBQUssSUFBSSxNQUFNLGVBQWUsQ0FBQztBQUN0QyxPQUFPLEtBQUssT0FBTyxNQUFNLGtCQUFrQixDQUFDO0FBQzVDLE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQ2pELE9BQU8sRUFBRSxrQkFBa0IsRUFBRSxtQkFBbUIsRUFBRSxlQUFlLEVBQUUsYUFBYSxFQUFFLE1BQU0sZUFBZSxDQUFDO0FBRXhHLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUU5QyxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvbGFrZWJveFwiO1xuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfVkVSU0lPTiA9IFwiMC45LjEzMlwiO1xuZXhwb3J0ICogYXMga2V5U3RvcmUgZnJvbSBcIi4vc3JjL2tleS1zdG9yZS50c1wiO1xuZXhwb3J0ICogYXMgbGlmZWN5Y2xlIGZyb20gXCIuL3NyYy9saWZlY3ljbGUudHNcIjtcbmV4cG9ydCAqIGFzIHJlc3QgZnJvbSBcIi4vc3JjL3Jlc3QudHNcIjtcbmV4cG9ydCAqIGFzIHNlc3Npb24gZnJvbSBcIi4vc3JjL3Nlc3Npb24udHNcIjtcbmV4cG9ydCAqIGFzIHRyYW5zcG9ydCBmcm9tIFwiLi9zcmMvdHJhbnNwb3J0LnRzXCI7XG5leHBvcnQgeyBTc2hLZXlTdG9yZSB9IGZyb20gXCIuL3NyYy9rZXktc3RvcmUudHNcIjtcbmV4cG9ydCB7IExha2Vib3hFbnRyeVNjaGVtYSwgTGFrZWJveFNzaEtleVNjaGVtYSwgTGFrZWJveEFwaUVycm9yLCBMYWtlYm94Q2xpZW50IH0gZnJvbSBcIi4vc3JjL3Jlc3QudHNcIjtcbmV4cG9ydCB0eXBlIHsgTGFrZWJveEVudHJ5LCBMYWtlYm94U3NoS2V5LCBMYWtlYm94QXV0aCB9IGZyb20gXCIuL3NyYy9yZXN0LnRzXCI7XG5leHBvcnQgeyBTc2hTZXNzaW9uIH0gZnJvbSBcIi4vc3JjL3Nlc3Npb24udHNcIjtcbmV4cG9ydCB0eXBlIHsgU3NoU2Vzc2lvbk9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvc2Vzc2lvbi50c1wiO1xuZXhwb3J0IHsgU3NoVHJhbnNwb3J0TW9kZVNjaGVtYSwgU3NoMlBhdGNoTW9kZVNjaGVtYSB9IGZyb20gXCIuL3NyYy90cmFuc3BvcnQudHNcIjtcbmV4cG9ydCB0eXBlIHsgU3NoVHJhbnNwb3J0TW9kZSwgU3NoMlBhdGNoTW9kZSB9IGZyb20gXCIuL3NyYy90cmFuc3BvcnQudHNcIjtcbiJdfQ==

package/lib/src/_ssh.d.ts

@@ -0,0 +1,152 @@
+import { type Duplex, type Readable } from "node:stream";
+import type { LakeboxCommandResult } from "@dbx-tools/shared-lakebox";
+import { type Options } from "generic-pool";
+import type { Client as Ssh2Client } from "ssh2";
+import type { Ssh2PatchMode, SshTransportMode } from "./transport.ts";
+/** Maximum authenticated resources maintained by each SSH operation pool. */
+export declare const SSH_POOL_MAX = 10;
+/** One command execution request after the remote shell script is assembled. */
+export interface SshExecutionOptions {
+    timeoutMs: number;
+    signal?: AbortSignal;
+}
+/** Transport callbacks owned by one live SSH command. */
+export interface SshCommandExecution {
+    readonly signal: AbortSignal;
+    stdout(chunk: Buffer | string): void;
+    stderr(chunk: Buffer | string): void;
+    setCancel(cancel: () => void | Promise<void>): void;
+    follow(command: SshCommand): Promise<number>;
+}
+/** Live SSH command that streams output and awaits to its numeric exit code. */
+export declare class SshCommand implements Promise<number> {
+    readonly command: string;
+    readonly args: readonly string[];
+    readonly [Symbol.toStringTag] = "SshCommand";
+    /** Live standard output decoded as UTF-8 strings. */
+    readonly stdout: Readable & AsyncIterable<string>;
+    /** Live standard error decoded as UTF-8 strings. */
+    readonly stderr: Readable & AsyncIterable<string>;
+    /** Completed result with captured output, timing, and timeout metadata. */
+    readonly result: Promise<LakeboxCommandResult>;
+    /** Numeric exit code after completion. */
+    exitCode: number | undefined;
+    private readonly startedAt;
+    private readonly stdoutStream;
+    private readonly stderrStream;
+    private readonly stdoutDecoder;
+    private readonly stderrDecoder;
+    private readonly abortController;
+    private readonly completion;
+    private resolveCompletion;
+    private rejectCompletion;
+    private cancelBackend?;
+    private cancellation?;
+    private stdoutText;
+    private stderrText;
+    private settled;
+    private timedOut;
+    /** Creates a command and schedules its asynchronous setup and execution. */
+    constructor(command: string, args: readonly string[], options: SshExecutionOptions, start: (execution: SshCommandExecution) => Promise<number>);
+    /** Cancel the command once. Caller cancellation resolves with exit code 130. */
+    cancel(exitCode?: number): Promise<void>;
+    then<TResult1 = number, TResult2 = never>(onfulfilled?: ((value: number) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<number | TResult>;
+    finally(onfinally?: (() => void) | null): Promise<number>;
+    private invokeCancel;
+    private writeOutput;
+    private follow;
+    private pipe;
+    private finish;
+    private fail;
+    private closeOutput;
+}
+/** Connection details shared by native OpenSSH and the guarded ssh2 fallback. */
+export interface SshTransportOptions {
+    host: string;
+    connectHost: string;
+    port: number;
+    username: string;
+    privateKeyPath: string;
+    knownHostsPath: string;
+    connectTimeoutMs: number;
+    ssh2Client: Ssh2Client;
+    createSsh2CommandClient: () => Promise<Ssh2Client>;
+    transport?: SshTransportMode;
+    ssh2Patch?: Ssh2PatchMode;
+    sshCommand?: string;
+}
+/** Selected command and remote TCP transport for one verified SSH gateway. */
+export interface SshTransport {
+    readonly kind: "openssh" | "ssh2";
+    run(script: string, execution: SshCommandExecution): Promise<number>;
+    connect(remoteHost: string, remotePort: number): Promise<Duplex>;
+    close(): Promise<void>;
+}
+/** Async lifecycle used by both native OpenSSH and ssh2 connection pools. */
+export interface SshResourceLifecycle<T> {
+    create(): Promise<T>;
+    destroy(resource: T): Promise<void>;
+    test(resource: T): Promise<boolean>;
+}
+/** Optional pool overrides used by transport tests and constrained runtimes. */
+export type SshPoolOptions = Pick<Options, "max" | "acquireTimeoutMillis" | "idleTimeoutMillis" | "evictionRunIntervalMillis" | "numTestsPerEvictionRun">;
+/**
+ * Exclusive, single-operation SSH resource pool.
+ *
+ * The command pool keeps one authenticated resource warm. Forwarding uses a
+ * separate zero-minimum pool so long-lived WebSockets cannot consume the warm
+ * command connection. Every borrowed resource is destroyed after its command
+ * or forwarded stream because the Databricks Russh gateway may accept only one
+ * operation during a connection's lifetime.
+ */
+export declare abstract class PooledSshTransport<T> implements SshTransport {
+    private readonly lifecycle;
+    abstract readonly kind: "openssh" | "ssh2";
+    private readonly commandPool;
+    private readonly forwardingPool;
+    private readonly activeResources;
+    private readonly seededResources;
+    private lastCreateError;
+    private starting?;
+    private closing?;
+    private closed;
+    protected constructor(lifecycle: SshResourceLifecycle<T>, options?: SshPoolOptions);
+    /** Starts both pools and waits until one tested command resource is warm. */
+    start(): Promise<void>;
+    private startPools;
+    run(script: string, execution: SshCommandExecution): Promise<number>;
+    connect(remoteHost: string, remotePort: number): Promise<Duplex>;
+    close(): Promise<void>;
+    protected abstract runWithResource(resource: T, script: string, execution: SshCommandExecution): Promise<number>;
+    protected abstract connectWithResource(resource: T, remoteHost: string, remotePort: number): Promise<Duplex>;
+    private connectWithBorrowedResource;
+    private acquire;
+    private destroy;
+    private closePools;
+}
+/** Injectable transport constructors used to isolate policy selection in tests. */
+export interface SshTransportFactories {
+    supportsOpenSsh(command: string): Promise<boolean>;
+    createOpenSsh(options: SshTransportOptions, command: string): Promise<SshTransport>;
+    createSsh2(options: SshTransportOptions): Promise<SshTransport>;
+}
+/**
+ * Select one SSH transport from resolved policy and keep it for the session.
+ * Auto prefers native OpenSSH and otherwise selects ssh2.
+ */
+export declare function createSshTransport(options: SshTransportOptions, overrides?: Partial<SshTransportFactories>): Promise<SshTransport>;
+/**
+ * Account that runs one remote command.
+ *
+ * `user` targets a locked, non-sudo Lakebox account. `root` is reserved for
+ * fixed package-owned bootstrap scripts and is never reachable from REST,
+ * agent tools, or service definitions.
+ */
+export type SshCommandIdentity = {
+    kind: "user";
+    name: string;
+    home: string;
+} | {
+    kind: "root";
+};