node-lxc 1.0.1 → 1.1.0

package/README.md

@@ -23,19 +23,15 @@
 - **Memory-safe** — no leaks; all heap buffers freed, all async captures by value
 - **TypeScript** — full type declarations included
 
-## Prerequisites
+## Requirements
 
-| Requirement | Version |
-|---|---|
-| Node.js | ≥ 12.17 |
-| LXC | ≥ 4.0 |
-| liblxc-dev | (same as LXC) |
-| g++ | ≥ 7 |
+- Node.js ≥ 12.17
+- LXC ≥ 4.0 (runtime library only)
 
 Install LXC on Debian/Ubuntu:
 
 ```sh
-sudo apt install lxc lxc-dev
+sudo apt install lxc
 ```
 
 Verify your kernel supports LXC features:
@@ -50,7 +46,14 @@ lxc-checkconfig
 npm install node-lxc
 ```
 
-The package ships a pre-built binary for `x86_64-linux-gnu`. No compilation step is required for this platform.
+Pre-built binaries are included for the following platforms — no compilation step required:
+
+| Architecture | GNU triplet |
+|---|---|
+| x86-64 | `x86_64-linux-gnu` |
+| ARM64 | `aarch64-linux-gnu` |
+
+Other Linux architectures must be [built from source](#building-from-source).
 
 ## Quick Start
 
@@ -163,6 +166,18 @@ await c.save(alt_file)
 // Run a command; returns its exit code
 await c.exec({ argv: string[], ...lxc_attach_options })  // → number
 
+// Run a command and capture all output
+const { exitCode, stdout, stderr } = await c.execOutput({ argv: ["/bin/hostname"] });
+
+// Run a command and stream output as events
+const session = await c.execAsync({ argv: ["/usr/bin/top", "-b", "-n1"] });
+session
+  .on("stdout", (chunk: Buffer) => process.stdout.write(chunk))
+  .on("stderr", (chunk: Buffer) => process.stderr.write(chunk))
+  .on("exit",   (code: number)  => console.log("exit:", code));
+session.kill();          // send SIGTERM
+session.kill(9);         // send SIGKILL
+
 // Open a shell; returns the shell's exit code
 await c.attach(options?)                                  // → number
 
@@ -277,20 +292,29 @@ npm run example:execute
 npm run example:console_async
 ```
 
+---
+
 ## Building from Source
 
-```sh
-# Install system dependencies (Debian/Ubuntu)
-sudo apt install g++ lxc lxc-dev
+Required additional dependencies:
 
-# Install npm dependencies
-npm install
+| Tool | Version |
+|---|---|
+| liblxc-dev | same as LXC |
+| g++ | ≥ 7 |
+| cmake | any recent |
+
+```sh
+sudo apt install lxc lxc-dev g++ cmake
+```
 
-# Configure and build the native addon
-node-gyp configure
-node-gyp build
+Clone and build:
 
-# Compile TypeScript
+```sh
+git clone https://github.com/SourceRegistry/node-lxc.git
+cd node-lxc
+npm install
+npx node-gyp configure && npx node-gyp build
 npx tsc --build
 ```
 
@@ -325,4 +349,4 @@ Please ensure:
 
 - [LXC API documentation](https://linuxcontainers.org/lxc/apidoc/structlxc__container.html)
 - [LXC C header (GitHub)](https://github.com/lxc/lxc/blob/main/src/lxc/lxccontainer.h)
-- [Linux Containers](https://linuxcontainers.org)
+- [Linux Containers](https://linuxcontainers.org)

package/lib/binding.js

@@ -21,12 +21,15 @@ if (!is_package) {
     addonPath = path_1.default.join(__dirname, '..', 'build', mode, `${base_name}.node`);
 }
 else {
-    if (platform === 'linux' && arch === 'x64') {
-        addonPath = path_1.default.join(__dirname, '..', 'bin', 'x86_64-linux-gnu', `${base_name}.node`);
-    }
-    else {
+    const archToTriplet = {
+        x64: 'x86_64-linux-gnu',
+        arm64: 'aarch64-linux-gnu',
+    };
+    const triplet = platform === 'linux' ? archToTriplet[arch] : undefined;
+    if (!triplet) {
         throw new Error(`Unsupported platform or architecture: ${platform}-${arch}`);
     }
+    addonPath = path_1.default.join(__dirname, '..', 'bin', triplet, `${base_name}.node`);
 }
 exports.default = require(addonPath);
 //# sourceMappingURL=binding.js.map

package/lib/binding.js.map

@@ -1 +1 @@
-{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../lib/binding.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,gDAAwB;AAExB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAE1B,MAAM,SAAS,GAAG,UAAU,CAAA;AAC5B,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;AACtD,IAAI,SAAS,CAAC;AACd,IAAI,CAAC,UAAU,EAAE,CAAC;IACd,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC;IACD,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAC,OAAO,EAAE,IAAI,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;AAC9E,CAAC;KAAM,CAAC;IACJ,IAAI,QAAQ,KAAK,OAAO,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACzC,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;IAC3F,CAAC;SAAM,CAAC;QACJ,MAAM,IAAI,KAAK,CAAC,yCAAyC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;IACjF,CAAC;AACL,CAAC;AAGD,kBAAe,OAAO,CAAC,SAAS,CAAC,CAAA"}
+{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../lib/binding.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,gDAAwB;AAExB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAE1B,MAAM,SAAS,GAAG,UAAU,CAAA;AAC5B,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;AACtD,IAAI,SAAS,CAAC;AACd,IAAI,CAAC,UAAU,EAAE,CAAC;IACd,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC;IACD,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAC,OAAO,EAAE,IAAI,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;AAC9E,CAAC;KAAM,CAAC;IACJ,MAAM,aAAa,GAA2B;QAC1C,GAAG,EAAI,kBAAkB;QACzB,KAAK,EAAE,mBAAmB;KAC7B,CAAC;IACF,MAAM,OAAO,GAAG,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,yCAAyC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;IACjF,CAAC;IACD,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;AAChF,CAAC;AAGD,kBAAe,OAAO,CAAC,SAAS,CAAC,CAAA"}

package/lib/index.d.ts

@@ -2,7 +2,7 @@
  * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
  * @date 03-07-2024
  */
-import { bdev_specs, lxc_attach_options, lxc_clone_options, lxc_console_log, LXC_CREATE, LXC_MIGRATE, LXC_MOUNT, lxc_mount, lxc_snapshot, migrate_opts, ConsoleSession } from "./types";
+import { bdev_specs, lxc_attach_options, lxc_clone_options, lxc_console_log, LXC_CREATE, LXC_MIGRATE, LXC_MOUNT, lxc_mount, lxc_snapshot, migrate_opts, ConsoleSession, ExecOutputResult, ExecSession } from "./types";
 export * from "./types";
 export type ContainerState = "STOPPED" | "STARTING" | "RUNNING" | "STOPPING" | "ABORTING" | "FREEZING" | "FROZEN" | "THAWED";
 export type ContainerStats = {
@@ -498,6 +498,40 @@ export type Container = {
     exec(options: Partial<lxc_attach_options> & {
         argv: string[];
     }): Promise<number>;
+    /**
+     * Run a command inside the container and capture its output.
+     * Internally creates pipes for stdout and stderr so the child never writes
+     * to the caller's terminal.  Both streams are collected in memory and
+     * returned when the process exits.
+     * @param options.argv {string[]} Command and arguments.
+     * @param options {Partial<lxc_attach_options>} Attach options (uid, gid, env, …). `stdio` is ignored.
+     * @returns {Promise<ExecOutputResult>} `{ exitCode, stdout, stderr }`.
+     */
+    execOutput(options: Omit<Partial<lxc_attach_options>, 'stdio'> & {
+        argv: string[];
+    }): Promise<ExecOutputResult>;
+    /**
+     * Run a command inside the container and stream its output as events.
+     * Resolves with a session object once the process has started.
+     * Register all listeners **before** the first `await` after this call so
+     * no output is lost between process start and listener registration.
+     *
+     * @example
+     * ```typescript
+     * const session = await c.execAsync({ argv: ['/usr/bin/top', '-b', '-n1'] });
+     * session
+     *   .on('stdout', chunk => process.stdout.write(chunk))
+     *   .on('stderr', chunk => process.stderr.write(chunk))
+     *   .on('exit',   code  => console.log('exit:', code));
+     * ```
+     *
+     * @param options.argv {string[]} Command and arguments.
+     * @param options {Partial<lxc_attach_options>} Attach options. `stdio` is ignored.
+     * @returns {Promise<ExecSession>} Active streaming session.
+     */
+    execAsync(options: Omit<Partial<lxc_attach_options>, 'stdio'> & {
+        argv: string[];
+    }): Promise<ExecSession>;
     /**
      * Set a global timeout for LXC operations on this container.
      * After the timeout expires LXC will abort the operation with an error.

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;AAQH,0CAAuB;AAEvB,wDAA+B;AAqqBlB,QAAA,GAAG,GAAQ,iBAAO,CAAC;AAG5B,kBAAU,GASV,WAAG,aARH,2BAAmB,GAQnB,WAAG,sBAPH,yBAAiB,GAOjB,WAAG,oBANH,gCAAwB,GAMxB,WAAG,2BALH,+BAAuB,GAKvB,WAAG,0BAJH,6BAAqB,GAIrB,WAAG,wBAHH,uBAAe,GAGf,WAAG,kBAFH,qBAAa,GAEb,WAAG,gBADH,iBAAS,GACT,WAAG,WAAA;AAEM,QAAA,MAAM,GAAG;IAElB,YAAY,EAAE;QACV,eAAe,EAAE;YACb,UAAU,EAAE,oCAAoC;YAChD,YAAY,EAAE,sEAAsE;YACpF,YAAY,EAAE,qEAAqE;SACtF;KACK;IAEV,KAAK,CAAC,IAAI,CAAC,aAA+C,iBAAiB;QACvE,MAAM,QAAQ,GAAG,cAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,GAAG,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;QACpG,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,MAAM,EAAE,UAAU,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC7F,IAAI,MAAM,EAAE,QAAQ,KAAK,iBAAiB;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC3G,IAAI,MAAM,EAAE,MAAM,KAAK,cAAc;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACjG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAC/I,OAAO,MAAM,CAAC,QAAiC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,aAA+C,iBAAiB;QAC5E,MAAM,QAAQ,GAAG,cAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,QAAQ,GAAG,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;QAC1G,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,EAAE,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACvE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACtI,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,KAAK,iBAAiB;YAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;QACrI,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc;YAAE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QAC3H,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,sFAAsF,CAAC,CAAC;QAC5L,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAoB,CAAC;IACrD,CAAC;CACJ,CAAA;AAGD,0CAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;AAQH,0CAAuB;AAEvB,wDAA+B;AAqsBlB,QAAA,GAAG,GAAQ,iBAAO,CAAC;AAG5B,kBAAU,GASV,WAAG,aARH,2BAAmB,GAQnB,WAAG,sBAPH,yBAAiB,GAOjB,WAAG,oBANH,gCAAwB,GAMxB,WAAG,2BALH,+BAAuB,GAKvB,WAAG,0BAJH,6BAAqB,GAIrB,WAAG,wBAHH,uBAAe,GAGf,WAAG,kBAFH,qBAAa,GAEb,WAAG,gBADH,iBAAS,GACT,WAAG,WAAA;AAEM,QAAA,MAAM,GAAG;IAElB,YAAY,EAAE;QACV,eAAe,EAAE;YACb,UAAU,EAAE,oCAAoC;YAChD,YAAY,EAAE,sEAAsE;YACpF,YAAY,EAAE,qEAAqE;SACtF;KACK;IAEV,KAAK,CAAC,IAAI,CAAC,aAA+C,iBAAiB;QACvE,MAAM,QAAQ,GAAG,cAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,GAAG,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;QACpG,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,MAAM,EAAE,UAAU,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC7F,IAAI,MAAM,EAAE,QAAQ,KAAK,iBAAiB;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC3G,IAAI,MAAM,EAAE,MAAM,KAAK,cAAc;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACjG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAC/I,OAAO,MAAM,CAAC,QAAiC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,aAA+C,iBAAiB;QAC5E,MAAM,QAAQ,GAAG,cAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,QAAQ,GAAG,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;QAC1G,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,EAAE,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACvE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACtI,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,KAAK,iBAAiB;YAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;QACrI,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc;YAAE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QAC3H,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,sFAAsF,CAAC,CAAC;QAC5L,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAoB,CAAC;IACrD,CAAC;CACJ,CAAA;AAGD,0CAAuB"}

package/lib/types/custom/ExecSession.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Result returned by {@link Container.execOutput}.
+ */
+export interface ExecOutputResult {
+    /** Process exit code, or -1 if the process was killed by a signal. */
+    exitCode: number;
+    /** All data written to stdout, as a UTF-8 string. */
+    stdout: string;
+    /** All data written to stderr, as a UTF-8 string. */
+    stderr: string;
+}
+/**
+ * Streaming exec session returned by {@link Container.execAsync}.
+ *
+ * Register listeners before yielding control back to the event loop so no
+ * output is missed.  The session closes automatically when the process exits.
+ */
+export interface ExecSession {
+    /** Subscribe to a stdout chunk, stderr chunk, or process exit. */
+    on(event: 'stdout', listener: (chunk: Buffer) => void): this;
+    on(event: 'stderr', listener: (chunk: Buffer) => void): this;
+    on(event: 'exit', listener: (exitCode: number) => void): this;
+    /**
+     * Send a signal to the attached process.
+     * @param signal - Signal number (default: SIGTERM = 15).
+     */
+    kill(signal?: number): void;
+    /** `true` once the process has exited and all resources have been freed. */
+    get closed(): boolean;
+}

package/lib/types/custom/ExecSession.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ExecSession.js.map

package/lib/types/custom/ExecSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExecSession.js","sourceRoot":"","sources":["../../../../lib/types/custom/ExecSession.ts"],"names":[],"mappings":""}

package/lib/types/custom/index.d.ts

@@ -1 +1,2 @@
 export * from "./ConsoleSession";
+export * from "./ExecSession";

package/lib/types/custom/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ConsoleSession"), exports);
+__exportStar(require("./ExecSession"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/custom/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/types/custom/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/types/custom/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,gDAA6B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-lxc",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Node.js native bindings for LXC (Linux Containers) — a complete, production-ready wrapper around liblxc built with N-API",
   "homepage": "https://github.com/SourceRegistry/node-lxc#readme",
   "repository": {
@@ -26,8 +26,7 @@
   "types": "lib/index.d.ts",
   "files": [
     "lib",
-    "bin",
-    "examples"
+    "bin"
   ],
   "dependencies": {
     "node-addon-api": "^8.5.0"
@@ -83,5 +82,6 @@
   },
   "engines": {
     "node": "~10 >=10.20 || >=12.17"
-  }
+  },
+  "gypfile": false
 }

package/examples/attach/index.ts

@@ -1,29 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-    const c = new Container(name);
-    if (!c.defined) {
-        console.log("Container creating...");
-        await c.create({
-            template: "download",
-            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
-        });
-        console.log("Created");
-    }
-    if (!c.running) {
-        await c.start();
-    }
-    console.log(`Attaching to container '${name}'`)
-    await c.attach({
-        stdio: [process.stdin.fd, process.stdout.fd, process.stderr.fd],
-    });
-    console.warn(`Destroying '${name}'`)
-    await c.destroy({force: true});
-}
-
-main().catch(console.error);

package/examples/attach-streams/index.ts

@@ -1,34 +0,0 @@
-import {Container} from "../../lib";
-import {openSync} from "node:fs";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-    const c = new Container(name);
-    if (!c.defined) {
-        console.log("Container creating...");
-        await c.create({
-            template: "download",
-            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
-        });
-        console.log("Created");
-    }
-    if (!c.running) {
-        await c.start();
-    }
-    console.log(`Attaching to container '${name}'`);
-
-    const stdoutFd = openSync("examples/attach-streams/stdout", "w+"); //TODO: Check if this works
-    const stderrFd = openSync("examples/attach-streams/stderr", "w+"); //TODO: Check if this works
-
-
-    await c.attach({stdio: [process.stdin.fd, stdoutFd, stderrFd]});  //TODO: Check if this works
-
-    console.warn(`Destroying '${name}'`)
-    await c.destroy({force: true});
-}
-
-main().catch(console.error);

package/examples/checkpoint/index.ts

@@ -1,34 +0,0 @@
-import {Container, LXC_LOGLEVEL} from "../../lib";
-import {readdir} from "node:fs/promises";
-
-const name = "test-ct"
-const checkpointDir = `/tmp/${name}`
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-    const c = new Container(name);
-
-    c.setConfigItem("lxc.log.file", `./${name}/.log`);
-    c.setConfigItem("lxc.log.level", LXC_LOGLEVEL.TRACE);
-
-    if (!c.defined) {
-        console.log("Container creating...");
-        await c.create({
-            template: "download",
-            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
-        });
-        console.log("Created");
-    }
-    if (!c.running) {
-        await c.start();
-    }
-    console.log(`Creating lcone for container '${name}' in directory '${checkpointDir}'`);
-    await c.checkpoint(checkpointDir, true, true); //TODO
-
-    console.table(await readdir(checkpointDir));
-
-}
-
-main().catch(console.error);

package/examples/clone/index.ts

@@ -1,34 +0,0 @@
-import {Container, LXC_LOGLEVEL} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-    const c = new Container(name);
-
-    c.setConfigItem("lxc.log.file", `./${name}/.log`);
-    c.setConfigItem("lxc.log.level", LXC_LOGLEVEL.TRACE);
-
-    if (!c.defined) {
-        console.log("Container creating...");
-        await c.create({
-            template: "download",
-            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
-        });
-        console.log("Created");
-    }
-    if (c.running) {
-        console.warn("Container needs to be stopped to create a clone")
-        console.log("Container shutting down...");
-        await c.shutdown();
-        console.log("Done");
-
-    }
-    console.log("Creating clone...")
-    await c.clone({newname: name + "2"});
-    console.log("Done");
-}
-
-main().catch(console.error);

package/examples/concurrent_create/index.ts

@@ -1,30 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-
-    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
-            const c = new Container(name + i);
-            if(!c.defined) {
-                await c.create({
-                    template: "download", argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
-                });
-                console.log(`Created ${c.name}`);
-            }else{
-                console.warn(`Container ${c.name} already defined`);
-            }
-            return c;
-        }
-    ));
-
-    console.table(containers.map((c) => {
-        return {name: c.name, state: c.state}
-    }));
-
-}
-
-main().catch(console.error);

package/examples/concurrent_destroy/index.ts

@@ -1,23 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-
-    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
-            let c = new Container(name + i);
-            if (c.defined) {
-                console.log(`Destroying ${c.name}`);
-                await c.destroy();
-            } else {
-                console.warn(`Container ${c.name} not defined`);
-            }
-            return c;
-        }
-    ));
-}
-
-main().catch(console.error);

package/examples/concurrent_shutdown/index.ts

@@ -1,28 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-
-    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
-            let c = new Container(name + i);
-            if (c.defined) {
-                console.log(`Shutting down ${c.name}`);
-                await c.shutdown();
-            } else {
-                console.warn(`Container ${c.name} not defined`);
-            }
-            return c;
-        }
-    ));
-
-    console.table(containers.map((c) => {
-        return {name: c.name, state: c.state}
-    }));
-
-}
-
-main().catch(console.error);

package/examples/concurrent_start/index.ts

@@ -1,28 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-
-    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
-            const c = new Container(name + i);
-            if (!c.running) {
-                await c.start();
-                console.log(`Started ${c.name}`);
-            } else {
-                console.warn(`Container ${c.name} already running`);
-            }
-            return c;
-        }
-    ));
-
-    console.table(containers.map((c) => {
-        return {name: c.name, state: c.state}
-    }));
-
-}
-
-main().catch(console.error);

package/examples/concurrent_stop/index.ts

@@ -1,28 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-
-    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
-            const c = new Container(name + i);
-            if (c.running) {
-                await c.stop();
-                console.log(`Stopped ${c.name}`);
-            } else {
-                console.warn(`Container ${c.name} already stopped`);
-            }
-            return c;
-        }
-    ));
-
-    console.table(containers.map((c) => {
-        return {name: c.name, state: c.state}
-    }));
-
-}
-
-main().catch(console.error);

package/examples/config/index.ts

@@ -1,18 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "test-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-
-    const c = new Container(name);
-    c.setConfigItem("lxc.utsname", "test-host1");
-
-    const rootfs  = c.getConfigItem("lxc.rootfs");
-    console.log("Root FS: ", rootfs);
-
-}
-
-main().catch(console.error);

package/examples/console/index.ts

@@ -1,17 +0,0 @@
-import {Container} from "../../lib";
-
-const name = "node-ct"
-
-/**
- * In this example, a container is created and the calling process stdio is attached.
- */
-async function main() {
-    const c = new Container(name);
-    if (c.defined && c.running) {
-        await c.console(0, [process.stdin.fd, process.stdout.fd, process.stderr.fd], 1);
-    } else {
-        console.warn(`Container '${name}' not defined or not running`);
-    }
-}
-
-main().catch(console.error);

package/examples/console_async/index.ts

@@ -1,101 +0,0 @@
-import {Container} from "../../lib";
-
-const containerName = 'node-ct'; // Change to your container name
-
-async function main() {
-    const container = new Container(containerName);
-    container.setConfigItem('lxc.log.file', `./${containerName}/container.log`)
-
-
-    if (!container.defined || !container.running) {
-        console.error(`Container '${containerName}' is not defined or not running.`);
-        process.exit(1);
-    }
-
-    console.log(`📎 Attaching to console of container '${containerName}' (TTY 0)`);
-    console.log(`💡 Type commands, press Ctrl+C or Ctrl+D to exit.\n`);
-
-    try {
-
-        // console.log(container.initPIDFd())
-
-        // Open console
-        const session = await container.consoleAsync(0);
-
-        // Ensure we're in raw mode
-        if (!process.stdin.isTTY) {
-            console.error('Stdin is not a TTY');
-            process.exit(1);
-        }
-
-        process.stdin.setRawMode(true);
-        process.stdin.setEncoding('utf8');
-
-        // Disable line buffering
-        process.stdin.resume();
-
-        // Handle data from container → stdout
-        session.on('data', (chunk) => {
-            process.stdout.write(chunk);
-        });
-
-        session.on('close', () => {
-            process.exit(0);
-        })
-
-        // Handle input from user → container
-        process.stdin.on('data', (data) => {
-            if (data.toString() === '\x04') {
-                // Ctrl+D
-                session.close();
-                process.exit(0);
-            } else {
-                session.write(data);
-            }
-
-        });
-
-        // Handle terminal resize
-        function handleResize() {
-            const cols = process.stdout.columns || 80;
-            const rows = process.stdout.rows || 24;
-            try {
-                session.resize(cols, rows);
-            } catch (e) {
-                // Ignore resize errors
-            }
-        }
-
-        // Initial resize
-        handleResize();
-
-        // Watch for resize events
-        process.stdout.on('resize', handleResize);
-
-        // Optional: send SIGWINCH on SIGHUP, SIGTERM
-        process.on('SIGINT', () => session.close());
-        process.on('SIGTERM', () => session.close());
-
-        // Cleanup on exit
-        const cleanup = () => {
-            session.close();
-            process.stdin.setRawMode(false);
-            process.exit(0);
-        };
-
-        process.on('exit', cleanup);
-        process.on('SIGINT', cleanup);
-        process.on('SIGTERM', cleanup);
-
-        console.log('✅ Connected. You can now type inside the container.\n');
-    } catch (err) {
-        // @ts-ignore
-        console.error('❌ Console error:', err?.message || err);
-        process.exit(1);
-    }
-}
-
-main().catch(err => {
-    console.error('❌ Unexpected error:', err);
-    process.exit(1);
-});

package/examples/create/index.ts

@@ -1,12 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (!c.defined) {
-        console.log("Container creating...")
-        await c.create({template: "download", argv: ["--dist", "ubuntu", "--release", "jammy", "--arch", "amd64"]});
-        console.log("Done")
-    }
-}
-
-main().catch(console.error)

package/examples/create_snapshot/index.ts

@@ -1,10 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined) {
-        await c.snapshot("./test") //TODO: Check if this works
-    }
-}
-
-main().catch(console.error)

package/examples/destroy/index.ts

@@ -1,10 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined && !c.running) {
-        await c.destroy();
-    }
-}
-
-main().catch(console.error)

package/examples/destroy_snapshots/index.ts

@@ -1,10 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined && !c.running) {
-        await c.snapshotDestroy(true);
-    }
-}
-
-main().catch(console.error)

package/examples/device_add_remove/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined && c.running) {
-        await c.addDeviceNode("/dev/network_latency");
-        await c.removeDeviceNode("/dev/network_latency");
-    }
-}
-
-main().catch(console.error)

package/examples/execute/index.ts

@@ -1,10 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined && c.running) {
-        await c.exec({argv: ['uname', '-a']})
-    }
-}
-
-main().catch(console.error)

package/examples/freeze/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined && c.running) {
-        await c.freeze();
-        console.log("Container frozen");
-    }
-}
-
-main().catch(console.error)

package/examples/images/index.ts

@@ -1,10 +0,0 @@
-import {Images} from "../../lib";
-
-async function main() {
-    const available = await Images.Available()
-    console.log(available)
-    const list = await Images.List()
-    console.log(list)
-}
-
-main().catch(console.error)

package/examples/interfaces/index.ts

@@ -1,10 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined) {
-        console.log(await c.getInterfaces());
-    }
-}
-
-main().catch(console.error)

package/examples/ipaddress/index.ts

@@ -1,12 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (c.defined) {
-        console.table(Promise.all((await c.getInterfaces()).map(async (inf) => {
-            return {interface: inf, ipv4: await c.getIPs(inf, "inet"), ipv6: await c.getIPs(inf, "inet6", 0)}
-        })));
-    }
-}
-
-main().catch(console.error)

package/examples/limit/index.ts

@@ -1,15 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    const limitInBytes = Number(c.getCGroupItem("memory.limit_in_bytes"));
-    console.log(`current limitInBytes ${limitInBytes}`);
-    const swapMemoryLimitInBytes = Number(c.getCGroupItem("memory.memsw.limit_in_bytes"));
-    console.log(`current swapMemoryLimitInBytes ${swapMemoryLimitInBytes}`);
-
-    c.setCGroupItem("memory.limit_in_bytes", (limitInBytes/4).toString())
-    c.setCGroupItem("memory.memsw.limit_in_bytes", (swapMemoryLimitInBytes/4).toString())
-
-}
-
-main().catch(console.error)

package/examples/list/index.ts

@@ -1,12 +0,0 @@
-import {LXC} from "../../lib";
-
-async function main() {
-    console.log("===== ACTIVE =====");
-    LXC.ListAllActiveContainers().forEach(console.log)
-    console.log("===== DEFINED =====");
-    LXC.ListAllDefinedContainers().forEach(console.log)
-    console.log("===== ALL =====");
-    LXC.ListAllContainers().forEach(console.log)
-}
-
-main().catch(console.error)

package/examples/list_keys/index.ts

@@ -1,10 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    c.getKeys().forEach((key) => {
-        console.log(key, "=", c.getConfigItem(key)?.trim())
-    })
-}
-
-main().catch(console.error)

package/examples/list_snapshots/index.ts

@@ -1,9 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    const list = await c.snapshotList();
-    console.table(list);
-}
-
-main().catch(console.error)

package/examples/reboot/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if(!c.defined){
-        throw "Container not defined"
-    }
-    c.shutdown().then(()=> console.log("Container shutdown"))
-}
-
-main().catch(console.error)

package/examples/rename/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if(!c.defined){
-        throw "Container not defined"
-    }
-    c.name = "new-name";
-}
-
-main().catch(console.error)

package/examples/restore_snapshot/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (!c.defined) {
-        throw "Container not defined"
-    }
-    await c.snapshotRestore("snap0", "node-ct-restored");
-}
-
-main().catch(console.error)

package/examples/shutdown/index.ts

@@ -1,19 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (!c.defined) {
-        throw "Container not defined"
-    }
-
-    console.log("Shutting down the container...\n")
-    await c.shutdown(30).then(
-        () =>
-            console.log("Container shutdown"),
-        (reason) => {
-            console.warn("Failed to shutdown container reason:", reason);
-            return c.stop();
-        })
-}
-
-main().catch(console.error)

package/examples/start/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if(!c.defined){
-        throw "Container not defined"
-    }
-    c.start().then(()=> console.log("Container started"))
-}
-
-main().catch(console.error)

package/examples/stats/index.ts

@@ -1,48 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (!c.defined) {
-        throw "Container not defined"
-    }
-    const memUsed = c.getCGroupItem("memory.usage_in_bytes");
-    console.log("MemoryUsage:", memUsed);
-
-    const memLimit = c.getConfigItem("memory.limit_in_bytes");
-    console.log("MemoryLimit:", memLimit);
-
-    const kmemUsed = c.getConfigItem("memory.kmem.usage_in_bytes");
-    console.log("KernelMemoryUsage:", kmemUsed);
-
-    const kmemLimit = c.getConfigItem("memory.kmem.limit_in_bytes");
-    console.log("KernelMemoryLimit:", kmemLimit);
-
-    const swapUsed = c.getConfigItem("memory.memsw.usage_in_bytes");
-    console.log("MemorySwapUsage:", swapUsed);
-
-    const swapLimit = c.getConfigItem("memory.memsw.limit_in_bytes");
-    console.log("MemorySwapLimit:", swapUsed);
-
-    const blkioUsage = c.getConfigItem("blkio.throttle.io_service_bytes"); //TODO: Go bindings more complex on nested items and io services
-    console.log("BlkioUsage:", blkioUsage);
-
-    const cpuTime = c.getConfigItem("cpuacct.usage");
-    console.log("cpuacct.usage:", cpuTime);
-
-    const cpuTimePerCPU = c.getConfigItem("cpuacct.usage_percpu");  //TODO: Go bindings more complex on nested cpuTimes
-    console.log("cpuacct.usage_percpu:", cpuTimePerCPU);
-
-
-    const cpuStats = c.getConfigItem("cpuacct.usage_percpu");  //TODO: CPUStats returns the number of CPU cycles (in the units defined by USER_HZ on the system)
-                                                                   //TODO: consumed by tasks in this cgroup and its children in both user mode and system (kernel) mode.
-    console.log("cpuacct.stat:", cpuStats);
-
-
-    const interfaceStats = c.getConfigItem("cpuacct.usage"); //TODO: InterfaceStats returns the stats about container's network interfaces
-                                                                 // @see https://github.com/lxc/go-lxc/blob/v2/container.go#L1707
-    console.log("InterfaceStats:", interfaceStats);
-
-
-}
-
-main().catch(console.error)

package/examples/stop/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if(!c.defined){
-        throw "Container not defined"
-    }
-    c.stop().then(()=> console.log("Container stopped"))
-}
-
-main().catch(console.error)

package/examples/unfreeze/index.ts

@@ -1,11 +0,0 @@
-import {Container} from "../../lib";
-
-async function main() {
-    const c = new Container("node-ct");
-    if (!c.defined) {
-        throw "Container not defined"
-    }
-    c.unfreeze().then(() => console.log("Container thawed"))
-}
-
-main().catch(console.error)