node-lxc 1.0.0

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

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

package/lib/types/custom/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ConsoleSession"), exports);
+//# sourceMappingURL=index.js.map

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

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

package/lib/types/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+export * from "./bdev_specs";
+export * from "./LXC_ATTACH";
+export * from "./lxc_attach_env_policy";
+export * from "./lxc_attach_options";
+export * from "./LXC_CLONE";
+export * from "./lxc_clone_options";
+export * from "./lxc_console_log";
+export * from "./LXC_CREATE";
+export * from "./LXC_LOGLEVEL";
+export * from "./LXC_MIGRATE";
+export * from "./LXC_MOUNT";
+export * from "./lxc_snapshot";
+export * from "./migrate_opts";
+export * from "./Personality";
+export * from "./Image";
+export * from "./custom";

package/lib/types/index.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./bdev_specs"), exports);
+__exportStar(require("./LXC_ATTACH"), exports);
+__exportStar(require("./lxc_attach_env_policy"), exports);
+__exportStar(require("./lxc_attach_options"), exports);
+__exportStar(require("./LXC_CLONE"), exports);
+__exportStar(require("./lxc_clone_options"), exports);
+__exportStar(require("./lxc_console_log"), exports);
+__exportStar(require("./LXC_CREATE"), exports);
+__exportStar(require("./LXC_LOGLEVEL"), exports);
+__exportStar(require("./LXC_MIGRATE"), exports);
+__exportStar(require("./LXC_MOUNT"), exports);
+__exportStar(require("./lxc_snapshot"), exports);
+__exportStar(require("./migrate_opts"), exports);
+__exportStar(require("./Personality"), exports);
+__exportStar(require("./Image"), exports);
+__exportStar(require("./custom"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/types/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;AAEH,+CAA4B;AAC5B,+CAA4B;AAC5B,0DAAuC;AACvC,uDAAoC;AACpC,8CAA2B;AAC3B,sDAAmC;AACnC,oDAAiC;AACjC,+CAA4B;AAC5B,iDAA8B;AAC9B,gDAA6B;AAC7B,8CAA2B;AAC3B,iDAA8B;AAC9B,iDAA8B;AAC9B,gDAA6B;AAC7B,0CAAuB;AAEvB,2CAAwB"}

package/lib/types/lxc_attach_env_policy.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+export declare enum lxc_attach_env_policy {
+    LXC_ATTACH_KEEP_ENV = 0,/*!< Retain the environment */
+    LXC_ATTACH_CLEAR_ENV = 1
+}

package/lib/types/lxc_attach_env_policy.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lxc_attach_env_policy = void 0;
+var lxc_attach_env_policy;
+(function (lxc_attach_env_policy) {
+    lxc_attach_env_policy[lxc_attach_env_policy["LXC_ATTACH_KEEP_ENV"] = 0] = "LXC_ATTACH_KEEP_ENV";
+    lxc_attach_env_policy[lxc_attach_env_policy["LXC_ATTACH_CLEAR_ENV"] = 1] = "LXC_ATTACH_CLEAR_ENV";
+})(lxc_attach_env_policy || (exports.lxc_attach_env_policy = lxc_attach_env_policy = {}));
+//# sourceMappingURL=lxc_attach_env_policy.js.map

package/lib/types/lxc_attach_env_policy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lxc_attach_env_policy.js","sourceRoot":"","sources":["../../../lib/types/lxc_attach_env_policy.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC7B,+FAAuB,CAAA;IACvB,iGAAwB,CAAA;AAC5B,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC"}

package/lib/types/lxc_attach_options.d.ts

@@ -0,0 +1,99 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+import { Personality } from "./Personality";
+import { lxc_attach_env_policy } from "./lxc_attach_env_policy";
+export type lxc_attach_options = ({
+    /**
+     * If ClearEnv is true, the environment is cleared before running the command.
+     */
+    env_policy: lxc_attach_env_policy.LXC_ATTACH_CLEAR_ENV;
+    /**
+     * EnvToKeep specifies the environment of the process when ClearEnv is true.
+     */
+    extra_keep_env: string[];
+} | {
+    /**
+     *  Retain the environment
+     */
+    env_policy: lxc_attach_env_policy.LXC_ATTACH_KEEP_ENV;
+}) & {
+    /**
+     * Any combination of LXC_ATTACH_* flags
+     * @link [https://linuxcontainers.org/apidocs](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#a14f47c7faff4c413e05d4b0fa3e2fa6f)
+     */
+    attach_flags: number;
+    /**
+     * Specify the namespaces to attach to, as OR'ed list of clone flags (syscall.CLONE_NEWNS | syscall.CLONE_NEWUTS ...).
+     * @link [https://linuxcontainers.org/apidocs](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#a80a7d14f141d44e92cab818a473a51e4)
+     */
+    namespaces: number;
+    /**
+     * Specify the architecture which the kernel should appear to be running as to the command executed.
+     * Initial personality (LXC_ATTACH_DETECT_PERSONALITY to autodetect).
+     * @warning This may be ignored if lxc is compiled without personality support)
+     * @link [https://linuxcontainers.org/apidocs](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#a22232139102062bcf18e1f7ae6aea17d)
+     */
+    personality: Personality | -1 | bigint;
+    /**
+     * If the current directory does not exist in the container, the root directory will be used instead because of kernel defaults.
+     * @link [https://linuxcontainers.org/apidocs](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#ab6a000a4ac27f2ec3d861c55499eaff2)
+     */
+    initial_cwd?: string | undefined;
+    /**
+     * UID specifies the user id to run as.
+     * @note Set to -1 for default behaviour (init uid for userns containers or 0 (super-user) if detection fails).
+     * @link [https://linuxcontainers.org/apidocs](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#a8a62e9318622bc396fdd24ab1a89bf60)
+     */
+    uid?: number;
+    /**
+     * GID specifies the group id to run as.
+     * @link [https://linuxcontainers.org/apidocs](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#a7e54d34f03a8a366ff3a64306fd61dfe)
+     * @note Set to -1 for default behaviour (init gid for userns containers or 0 (super-user) if detection fails).
+     */
+    gid?: number;
+    /**
+     * Groups specifies the list of additional group ids to run with.
+     * The additional group GIDs to run with.
+     * If unset all additional groups are dropped.
+     * @link [](https://linuxcontainers.org/lxc/apidoc/structlxc__attach__options__t.html#af71a28922efb5b4003c20cec759b68fd)
+     */
+    groups?: number[];
+    /**
+     * [stdinfd, stdoutfd, stderrfd]
+     * stdinfd: specifies the fd to read input from.
+     * stdoutdf: specifies the fd to write output to.
+     * stderrfd: specifies the fd to write error output to.
+     */
+    stdio: [number, number, number];
+    /**
+     * Env specifies the environment of the process.
+     */
+    extra_env_vars: string[];
+    /**
+     * RemountSysProc remounts /sys and /proc for the executed command.
+     * This is required to reflect the container (PID) namespace context
+     * if the command does not attach to the container's mount namespace.
+     */
+    remount_sys_proc: boolean;
+    /**
+     * ElevatedPrivileges runs the command with elevated privileges.
+     * The capabilities, cgroup and security module restrictions of the container are not applied.
+     * @WARNING: This may leak privileges into the container.
+     */
+    elevated_privileges: boolean;
+    /**
+     * File descriptor to log output.
+     */
+    log_fd: number;
+    /**
+     * lsm label to set.
+     */
+    lsm_label?: string;
+};
+/**
+ * Default attach options to use
+ * @link [https://github.com/lxc/lxc](https://github.com/lxc/lxc/blob/main/src/lxc/attach_options.h#L161C9-L161C40)
+ */
+export declare const DEFAULT_ATTACH: lxc_attach_options;

package/lib/types/lxc_attach_options.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_ATTACH = void 0;
+const lxc_attach_env_policy_1 = require("./lxc_attach_env_policy");
+const LXC_ATTACH_1 = require("./LXC_ATTACH");
+/**
+ * Default attach options to use
+ * @link [https://github.com/lxc/lxc](https://github.com/lxc/lxc/blob/main/src/lxc/attach_options.h#L161C9-L161C40)
+ */
+exports.DEFAULT_ATTACH = {
+    attach_flags: LXC_ATTACH_1.LXC_ATTACH.DEFAULT,
+    namespaces: -1,
+    personality: -1,
+    initial_cwd: "/",
+    uid: -1,
+    gid: -1,
+    groups: [],
+    env_policy: lxc_attach_env_policy_1.lxc_attach_env_policy.LXC_ATTACH_KEEP_ENV,
+    extra_env_vars: [],
+    stdio: [process.stdin.fd, process.stdout.fd, process.stderr.fd],
+    remount_sys_proc: false,
+    elevated_privileges: false,
+    log_fd: -1,
+    lsm_label: undefined
+};
+//# sourceMappingURL=lxc_attach_options.js.map

package/lib/types/lxc_attach_options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lxc_attach_options.js","sourceRoot":"","sources":["../../../lib/types/lxc_attach_options.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,mEAA8D;AAC9D,6CAAwC;AAgGxC;;;GAGG;AACU,QAAA,cAAc,GAAuB;IAC9C,YAAY,EAAE,uBAAU,CAAC,OAAO;IAChC,UAAU,EAAE,CAAC,CAAC;IACd,WAAW,EAAE,CAAC,CAAC;IACf,WAAW,EAAE,GAAG;IAChB,GAAG,EAAE,CAAC,CAAC;IACP,GAAG,EAAE,CAAC,CAAC;IACP,MAAM,EAAE,EAAE;IACV,UAAU,EAAE,6CAAqB,CAAC,mBAAmB;IACrD,cAAc,EAAE,EAAE;IAClB,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/D,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,KAAK;IAC1B,MAAM,EAAE,CAAC,CAAC;IACV,SAAS,EAAE,SAAS;CACvB,CAAA"}

package/lib/types/lxc_clone_options.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+import { LXC_CLONE } from "./LXC_CLONE";
+export type lxc_clone_options = ({
+    /**
+     * New name for the container.
+     */
+    newname: string;
+    /**
+     * lxcpath in which to create the new container
+     * If undefined, the original container's lxcpath will be used.
+     * (XXX: should we use the default instead?)
+     */
+    lxcpath?: string;
+} | {
+    /**
+     * New name for the container.
+     * If undefined, the same name is used and a new lxcpath MUST be specified.
+     */
+    newname?: string;
+    /**
+     * lxcpath in which to create the new container
+     */
+    lxcpath: string;
+}) & {
+    /**
+     * Additional LXC_CLONE* flags to change the cloning behaviour:
+     */
+    flags?: number | LXC_CLONE;
+    /**
+     * Optionally force the cloned bdevtype to a specified plugin.
+     * By default, the original is used (subject to snapshot requirements).
+     */
+    bdevtype?: string;
+    /**
+     * Information about how to create the new storage (i.e. fstype and fsdata).
+     */
+    bdevdata?: string;
+    /**
+     * In case of a block device backing store, an optional size. If 0, the original backing store's size will be used if possible.
+     * @note
+     * this only applies to the rootfs.
+     * For any other filesystems, the original size will be duplicated.
+     */
+    newsize?: number;
+    /**
+     * Additional arguments to pass to the clone hook script.
+     */
+    hookargs?: string[];
+};

package/lib/types/lxc_clone_options.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=lxc_clone_options.js.map

package/lib/types/lxc_clone_options.js.map

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

package/lib/types/lxc_console_log.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+export type lxc_console_log = {
+    clear: boolean;
+    read: boolean;
+    read_max: bigint | number;
+    data: string;
+};

package/lib/types/lxc_console_log.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=lxc_console_log.js.map

package/lib/types/lxc_console_log.js.map

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

package/lib/types/lxc_snapshot.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+export type lxc_snapshot = {
+    name: string;
+    comment_pathname: string;
+    timestamp: string;
+    lxcpath: string;
+};

package/lib/types/lxc_snapshot.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=lxc_snapshot.js.map

package/lib/types/lxc_snapshot.js.map

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

package/lib/types/migrate_opts.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+export type migrate_opts = {
+    directory: string;
+    verbose: boolean;
+    stop: boolean;
+    predump_dir: string;
+    pageserver_address: string;
+    pageserver_port: string;
+    preserves_inodes: boolean;
+    action_script: string;
+    disable_skip_in_flight: boolean;
+    ghost_limit: bigint | number;
+    features_to_check: bigint | number;
+};

package/lib/types/migrate_opts.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=migrate_opts.js.map

package/lib/types/migrate_opts.js.map

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

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "node-lxc",
+  "version": "1.0.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": {
+    "type": "git",
+    "url": "git+https://github.com/SourceRegistry/node-lxc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/SourceRegistry/node-lxc/issues"
+  },
+  "keywords": [
+    "lxc",
+    "linux-containers",
+    "containers",
+    "virtualization",
+    "liblxc",
+    "native",
+    "napi",
+    "node-addon-api"
+  ],
+  "author": "ProjectSource V.O.F.",
+  "license": "Apache-2.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "bin",
+    "examples"
+  ],
+  "dependencies": {
+    "node-addon-api": "^8.5.0"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.8",
+    "@semantic-release/npm": "^13.1.5",
+    "@semantic-release/release-notes-generator": "^14.1.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.15.17",
+    "cmake-js": "^7.3.1",
+    "mocha": "^11.7.1",
+    "node-gyp": "^11.3.0",
+    "semantic-release": "^25.0.3",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.19"
+  },
+  "scripts": {
+    "setup": "./scripts/setup/setup.sh",
+    "test": "node --require ts-node/register --test tests/index.ts",
+    "test:watch": "node --require ts-node/register --test --watch tests/index.ts",
+    "test:build": "npm run build && npm run test",
+    "rebuild:dev": "node-gyp rebuild --debug && npx tsc",
+    "docs:build": "typedoc lib/index.ts --out generated/docs --name \"node-lxc\" --theme default --excludePrivate --excludeProtected --entryPointStrategy expand",
+    "build:dev": "node-gyp build --debug",
+    "build:test": "node-gyp build",
+    "dev:cpp": "npm run rebuild:dev && node ./tests/async_console.js",
+    "build": "./scripts/build/build.sh",
+    "clean": "node-gyp clean && npm run configure && npm run build",
+    "wipe": "node-gyp clean && npm run configure",
+    "configure": "node-gyp configure",
+    "preview": "npm run build && mkdir -p ./node_modules/@sourceregistry/node-lxc && cp -r ./package/* ./node_modules/@sourceregistry/node-lxc",
+    "package": "./scripts/package/package.sh",
+    "example:create": "ts-node examples/create/index.ts",
+    "example:console": "ts-node examples/console/index.ts",
+    "example:console_async": "ts-node examples/console_async/index.ts",
+    "example:attach": "ts-node examples/attach/index.ts",
+    "example:attach-streams": "ts-node examples/attach-streams/index.ts",
+    "example:checkpoint": "ts-node examples/checkpoint/index.ts",
+    "example:clone": "ts-node examples/clone/index.ts",
+    "example:concurrent_create": "ts-node examples/concurrent_create/index.ts",
+    "example:concurrent_destroy": "ts-node examples/concurrent_destroy/index.ts",
+    "example:concurrent_shutdown": "ts-node examples/concurrent_shutdown/index.ts",
+    "example:concurrent_start": "ts-node examples/concurrent_start/index.ts",
+    "example:concurrent_stop": "ts-node examples/concurrent_stop/index.ts",
+    "example:config": "ts-node examples/config/index.ts",
+    "example:execute": "ts-node examples/execute/index.ts",
+    "example:keys": "ts-node examples/list_keys/index.ts",
+    "example:images": "ts-node examples/images/index.ts"
+  },
+  "engines": {
+    "node": "~10 >=10.20 || >=12.17"
+  },
+  "gypfile": true
+}