@runneth/cli 0.0.0-sha.19a36f654ef6.production

package/dist/ssh.d.ts

@@ -0,0 +1,129 @@
+import type { Readable, Writable } from "node:stream";
+import { type OAuthTokenResult } from "./oauth.js";
+export type RunnethSshAppMetadata = Readonly<{
+    authorizedKeysPath: string;
+    connectRoute: string;
+    ok: true;
+    sshUser: string;
+}>;
+export type RunnethSshInstallResponse = RunnethSshAppMetadata & Readonly<{
+    installed: boolean;
+}>;
+export type RunnethSshTargetPaths = Readonly<{
+    configPath: string;
+    hostAlias: string;
+    knownHostsPath: string;
+    privateKeyPath: string;
+    publicKeyPath: string;
+    targetDirectory: string;
+}>;
+export type RunnethSshGeneratedKeyMode = "shared" | "unique";
+export type RunnethSshKeyMode = RunnethSshGeneratedKeyMode | "custom";
+export type RunnethSshKeyPaths = Readonly<{
+    keyDirectory: string;
+    keyMode: RunnethSshKeyMode;
+    privateKeyPath: string;
+    publicKeyPath: string;
+}>;
+export type RunnethSshSetupOptions = Readonly<{
+    cliPath: string;
+    homePath?: string;
+    identityFilePath?: string;
+    keyMode?: RunnethSshGeneratedKeyMode;
+    oauthToken: OAuthTokenResult;
+    resourceUrl: string;
+    sshUrl?: string;
+    targetName?: string;
+}>;
+export type RunnethSshSetupResult = Readonly<{
+    authorizedKeysPath: string;
+    configPath: string;
+    connectRoute: string;
+    hostAlias: string;
+    installed: boolean;
+    keyMode: RunnethSshKeyMode;
+    knownHostsPath: string;
+    privateKeyPath: string;
+    publicKeyPath: string;
+    sshUrl: string;
+    sshUser: string;
+    targetName?: string;
+}>;
+export type RunnethSshProxyOptions = Readonly<{
+    homePath?: string;
+    resourceUrl: string;
+    sshUrl?: string;
+    streams?: RunnethSshProxyStreams;
+}>;
+export type RunnethSshProxyStreams = Readonly<{
+    stderr: Writable;
+    stdin: Readable;
+    stdout: Writable;
+}>;
+export type RunnethSshTarget = Readonly<{
+    createdAt: string;
+    name: string;
+    resourceUrl: string;
+    sshUrl: string;
+    updatedAt: string;
+}>;
+export type RunnethSshTargetStore = Readonly<{
+    defaultTarget?: string;
+    targets: readonly RunnethSshTarget[];
+    version: 1;
+}>;
+export type ResolvedRunnethSshTarget = Readonly<{
+    resourceUrl: string;
+    sshUrl: string;
+    targetName?: string;
+}>;
+export type OpenSshOptions = Readonly<{
+    readonly extraArgs: readonly string[];
+    readonly setup: RunnethSshSetupResult;
+}>;
+export declare const normalizeRunnethSshTargetName: (value: string) => string;
+export declare const resolveRunnethSshAppUrl: (input: {
+    readonly resourceUrl: string;
+    readonly sshUrl?: string;
+}) => string;
+export declare const resolveRunnethSshTargetsPath: (input: {
+    readonly homePath?: string;
+}) => string;
+export declare const resolveRunnethSshTargetPaths: (input: {
+    readonly homePath?: string;
+    readonly resourceUrl: string;
+    readonly sshUrl?: string;
+}) => RunnethSshTargetPaths;
+export declare const resolveRunnethSshSharedKeyPaths: (input: {
+    readonly homePath?: string;
+}) => RunnethSshKeyPaths;
+export declare const readRunnethSshTargetStore: (input: {
+    readonly homePath?: string;
+}) => Promise<RunnethSshTargetStore>;
+export declare const saveRunnethSshTarget: (input: {
+    readonly homePath?: string;
+    readonly makeDefault?: boolean;
+    readonly name: string;
+    readonly resourceUrl: string;
+    readonly sshUrl?: string;
+}) => Promise<Readonly<{
+    store: RunnethSshTargetStore;
+    target: RunnethSshTarget;
+}>>;
+export declare const setDefaultRunnethSshTarget: (input: {
+    readonly homePath?: string;
+    readonly name: string;
+}) => Promise<RunnethSshTargetStore>;
+export declare const removeRunnethSshTarget: (input: {
+    readonly homePath?: string;
+    readonly name: string;
+}) => Promise<RunnethSshTargetStore>;
+export declare const resolveRunnethSshTarget: (input: {
+    readonly homePath?: string;
+    readonly resourceUrl?: string;
+    readonly sshUrl?: string;
+    readonly targetName?: string;
+}) => Promise<ResolvedRunnethSshTarget>;
+export declare const installRunnethSshAccess: (options: RunnethSshSetupOptions) => Promise<RunnethSshSetupResult>;
+export declare const runRunnethSshProxy: (options: RunnethSshProxyOptions) => Promise<void>;
+export declare const runOpenSsh: (options: OpenSshOptions) => Promise<number>;