@earendil-works/pi-env 0.0.1 → 1.0.4

package/dist/remote-env.d.ts

@@ -0,0 +1,67 @@
+import { type PlatformPath } from "node:path";
+import type { Context } from "@earendil-works/chord";
+import { type BinaryReader, type DirReader, type ExecutionEnv, ExecutionError, FileError, type FileInfo, type FileWatcher, type Result, type ShellExecOptions, type ShellExecResult, type TextLineReader, type WatchChange, type WatchTarget } from "@earendil-works/pi-durable/env";
+import { type Connection, type RemoteInfo } from "./connection.ts";
+import { type RemoteWatchOptions } from "./watch.ts";
+export interface RemoteExecutionEnvOptions {
+    connection: Connection;
+    /** The file namespace: equal ids see the same files (`FileSystem.id`), e.g. `pi-env:<env name>`. */
+    id: string;
+    cwd: string;
+    shellPath?: string;
+    /** Added to the remote environment of every command that inherits it, like `NodeExecutionEnv`'s `shellEnv`. */
+    shellEnv?: Record<string, string>;
+    /** How the daemon watches, like `NodeExecutionEnv`'s `watch` option. */
+    watch?: RemoteWatchOptions;
+}
+/** Node's path rules of the remote system. */
+export declare function remotePath(connection: Connection): Promise<PlatformPath>;
+/**
+ * An `ExecutionEnv` on another machine, reached through a pi-env daemon. Results match `NodeExecutionEnv` running on
+ * that machine: the daemon performs the system calls, and this class applies Node's path, error, and result rules.
+ */
+export declare class RemoteExecutionEnv implements ExecutionEnv {
+    #private;
+    readonly id: string;
+    cwd: string;
+    readonly connection: Connection;
+    constructor(options: RemoteExecutionEnvOptions);
+    absolutePath(path: string, _context: Context): Promise<Result<string, FileError>>;
+    joinPath(parts: string[], _context: Context): Promise<Result<string, FileError>>;
+    readTextFile(path: string, context: Context): Promise<Result<string, FileError>>;
+    readBinaryFile(path: string, context: Context): Promise<Result<Uint8Array, FileError>>;
+    openBinaryReader(path: string, options: {
+        noFollow?: boolean;
+    } | undefined, context: Context): Promise<Result<BinaryReader, FileError>>;
+    openTextLineReader(path: string, context: Context): Promise<Result<TextLineReader, FileError>>;
+    readTextLines(path: string, options: {
+        maxLines?: number;
+    } | undefined, context: Context): Promise<Result<string[], FileError>>;
+    writeFile(path: string, content: string | Uint8Array, context: Context): Promise<Result<void, FileError>>;
+    appendFile(path: string, content: string | Uint8Array, context: Context): Promise<Result<void, FileError>>;
+    truncateFile(path: string, size: number, context: Context): Promise<Result<void, FileError>>;
+    flushFile(path: string, context: Context): Promise<Result<void, FileError>>;
+    renameFile(sourcePath: string, destinationPath: string, context: Context): Promise<Result<void, FileError>>;
+    fileInfo(path: string, context: Context): Promise<Result<FileInfo, FileError>>;
+    listDir(path: string, context: Context): Promise<Result<FileInfo[], FileError>>;
+    openDirReader(path: string, context: Context): Promise<Result<DirReader, FileError>>;
+    canonicalPath(path: string, context: Context): Promise<Result<string, FileError>>;
+    exists(path: string, context: Context): Promise<Result<boolean, FileError>>;
+    createDir(path: string, options: {
+        recursive?: boolean;
+    } | undefined, context: Context): Promise<Result<void, FileError>>;
+    remove(path: string, options: {
+        recursive?: boolean;
+        force?: boolean;
+    } | undefined, context: Context): Promise<Result<void, FileError>>;
+    createTempDir(prefix: string | undefined, context: Context): Promise<Result<string, FileError>>;
+    createTempFile(options: {
+        prefix?: string;
+        suffix?: string;
+    } | undefined, context: Context): Promise<Result<string, FileError>>;
+    watch(targets: readonly WatchTarget[], onChange: (change: WatchChange) => void, context: Context): Promise<Result<FileWatcher, FileError>>;
+    exec(command: string | readonly string[], options: ShellExecOptions | undefined, context: Context): Promise<Result<ShellExecResult, ExecutionError>>;
+    cleanup(_context: Context): Promise<void>;
+}
+export type { RemoteInfo };
+//# sourceMappingURL=remote-env.d.ts.map

package/dist/remote-env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-env.d.ts","sourceRoot":"","sources":["../src/remote-env.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,YAAY,EAAgB,MAAM,WAAW,CAAC;AAG5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,cAAc,EAEd,SAAS,EACT,KAAK,QAAQ,EAEb,KAAK,WAAW,EAGhB,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,eAAe,EAKpB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,KAAK,UAAU,EAA0B,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE3F,OAAO,EAAiB,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAiBpE,MAAM,WAAW,yBAAyB;IACzC,UAAU,EAAE,UAAU,CAAC;IACvB,oGAAoG;IACpG,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+GAA+G;IAC/G,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,wEAAwE;IACxE,KAAK,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAMD,8CAA8C;AAC9C,wBAAsB,UAAU,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAE9E;AAwRD;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,YAAY;;IACtD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAOhC,YAAY,OAAO,EAAE,yBAAyB,EAO7C;IAgEK,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAMtF;IAEK,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAMrF;IA6EK,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAErF;IAEK,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAE3F;IAEK,gBAAgB,CACrB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,EAC3C,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAW1C;IAEK,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAWnG;IAEK,aAAa,CAClB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,EAC1C,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,CAAC,CAAC,CAgBtC;IA+CD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAExG;IAED,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAEzG;IAEK,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAYjG;IAED,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAS1E;IAEK,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAiBhH;IAEK,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAMnF;IAED,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,CAAC,CA8B9E;IAOK,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CASzF;IAED,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAKhF;IAEK,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAKhF;IAED,SAAS,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,EAC5C,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAIlC;IAED,MAAM,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,EAC7D,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAQlC;IAEK,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAWpG;IAEK,cAAc,CACnB,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,EACzD,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAiBpC;IAEK,KAAK,CACV,OAAO,EAAE,SAAS,WAAW,EAAE,EAC/B,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,EACvC,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAmBzC;IAEK,IAAI,CACT,OAAO,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,EACnC,OAAO,EAAE,gBAAgB,GAAG,SAAS,EACrC,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC,CA4FlD;IAEK,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9C;CACD;AAED,YAAY,EAAE,UAAU,EAAE,CAAC"}