proxmox-sdk 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tchoupinax
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# proxmox-sdk
+
+## Motivation
+
+I would like to work with Proxmox API and I did not find serious project for having a good and typed SDK. Moreover, these SDK are only reproducing the REST api without any added value. Proxmox API has a lot of complexity to understand and this SDK aims to make developer's life easier.
+
+## Development
+
+Using [yalc](https://github.com/wclr/yalc), it's easy to make local update and to test the package in your project.
+
+- `yalc publish` # In the SDK repository
+- `yalc install proxmox-sdk@version` # In your project
+
+## Sources
+
+- https://medium.com/@the_nick_morgan/creating-an-npm-package-with-typescript-c38b97a793cf

package/dist/index.js

@@ -0,0 +1,20 @@
+"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 });
+exports.HttpProxmoxRepository = void 0;
+var http_proxmox_repository_1 = require("./src/http-proxmox.repository");
+Object.defineProperty(exports, "HttpProxmoxRepository", { enumerable: true, get: function () { return http_proxmox_repository_1.HttpProxmoxRepository; } });
+__exportStar(require("./src/types"), exports);

package/dist/src/http-proxmox.repository.js

@@ -0,0 +1,336 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpProxmoxRepository = void 0;
+const axios_1 = __importDefault(require("axios"));
+const encode_ssh_key_1 = require("./tools/encode-ssh-key");
+// authorize self signed cert if you do not use a valid SSL certificat
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+// https://pve.proxmox.com/wiki/Proxmox_VE_API#Authentication
+class HttpProxmoxRepository {
+    constructor(parameters, logger) {
+        this.parameters = parameters;
+        this.logger = logger;
+    }
+    getProxmoxVersion() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    url: this.computeUrl("/api2/json/version"),
+                    headers: yield this.prepareHeaders(),
+                });
+            }
+            catch (err) {
+                console.log(err);
+            }
+            return data.data.data.version;
+        });
+    }
+    listQemuMachines(node) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    url: this.computeUrl(`/api2/json/nodes/${node}/qemu`),
+                    headers: yield this.prepareHeaders(),
+                });
+            }
+            catch (err) {
+                console.log(err);
+            }
+            return data.data.data;
+        });
+    }
+    getQemuMachineVlanTag(node, vmid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    url: this.computeUrl(`/api2/json/nodes/${node}/qemu/${vmid}/config`),
+                    headers: yield this.prepareHeaders(),
+                });
+            }
+            catch (err) {
+                this.logger.error(err);
+                return 1;
+            }
+            const tag = data.data.data.net0.split(",").find((e) => e.startsWith("tag"));
+            if (tag) {
+                return parseInt(tag.split("=").at(1), 10);
+            }
+            return 1;
+        });
+    }
+    listQemuMachineIps(node, vmid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    url: this.computeUrl(`/api2/json/nodes/${node}/qemu/${vmid}/agent/network-get-interfaces`),
+                    headers: yield this.prepareHeaders(),
+                });
+            }
+            catch (err) {
+                this.logger.error(err);
+                return [];
+            }
+            const payload = (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+            console.log(payload);
+            const answer = payload.result
+                .map(eth => eth["ip-addresses"]
+                .filter(ip => ip["ip-address-type"] === "ipv4")
+                .map(ip => ip["ip-address"]))
+                .flat()
+                .filter(ip => !["127.0.0.1"].includes(ip));
+            return answer;
+        });
+    }
+    createQemuMachine(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            // According to this answer https://forum.proxmox.com/threads/can-not-create-vm-with-qcow2-format.114881/post-496759
+            // when your Proxmox uses a local-lvm, the logical block storage does not support qcow2, only raw.
+            const FORMAT = payload.localStorageName === "local" ? "qcow2" : "raw";
+            const proxmoxPayload = {
+                autostart: payload.autostart,
+                bios: payload.bios,
+                cores: payload.coreCount,
+                efidisk0: `${payload.localStorageName}:1,efitype=4m,pre-enrolled-keys=1,format=${FORMAT}`,
+                memory: payload.memory,
+                name: payload.name,
+                net0: "virtio,bridge=vmbr0,firewall=1,vlanid=10",
+                node: payload.node,
+                numa: 0,
+                ostype: payload.ostype,
+                scsi0: `${payload.localStorageName}:32,format=${FORMAT},iothread=on`,
+                scsihw: "virtio-scsi-single",
+                sockets: 1,
+                vmid: payload.vmid,
+            };
+            if (payload.isoName) {
+                proxmoxPayload.scsi2 = `${payload.localStorageName}:iso/${payload.isoName},media=cdrom`;
+            }
+            try {
+                data = yield (0, axios_1.default)({
+                    data: proxmoxPayload,
+                    headers: yield this.prepareHeaders(),
+                    method: "POST",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/qemu`),
+                });
+            }
+            catch (err) {
+                this.logger.error({ status: err.response.status, vmid: payload.vmid, errors: err.response.data.errors }, err.response.statusText);
+            }
+            return (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+        });
+    }
+    updateQemuMachine(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            let data;
+            // @ts-ignore
+            const proxmoxPayload = {
+                cores: payload.coreCount,
+                memory: payload.memory,
+                name: payload.name,
+                tags: payload.tags,
+                ipconfig0: "ip=dhcp",
+                // ide2: `local:${payload.vmid}/vm-${payload.vmid}-cloudinit.qcow2,media=cdrom`,
+                // overridenUsername: "toto",
+                // overridenPassword: "toto",
+                ciuser: payload.overridenUser,
+                cipassword: payload.overridenPassword,
+            };
+            if (payload.sshkey) {
+                proxmoxPayload.sshkeys = (0, encode_ssh_key_1.encodeSSHKey)(payload.sshkey);
+            }
+            if ((_a = payload.networks) === null || _a === void 0 ? void 0 : _a[0]) {
+                proxmoxPayload.net0 = `model=${payload.networks[0].model},bridge=${payload.networks[0].bridge},firewall=${payload.networks[0].firewall}`;
+                if (payload.networks[0].tag) {
+                    proxmoxPayload.net0 += `,tag=${payload.networks[0].tag}`;
+                }
+            }
+            try {
+                data = yield (0, axios_1.default)({
+                    data: proxmoxPayload,
+                    headers: yield this.prepareHeaders(),
+                    method: "PUT",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/qemu/${payload.vmid}/config`),
+                });
+            }
+            catch (err) {
+                this.logger.error({ status: err.response.status, vmid: payload.vmid, errors: err.response.data.errors }, err.response.statusText);
+            }
+            return (_b = data === null || data === void 0 ? void 0 : data.data) === null || _b === void 0 ? void 0 : _b.data;
+        });
+    }
+    deleteQemuMachine(port) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    headers: yield this.prepareHeaders(),
+                    method: "DELETE",
+                    url: this.computeUrl(`/api2/json/nodes/${port.node}/qemu/${port.vmid}`),
+                });
+            }
+            catch (err) {
+                this.logger.error({ status: err.response.status, vmid: port.vmid, errors: err.response.data.errors }, err.response.statusText);
+            }
+            const payload = (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+            return payload;
+        });
+    }
+    downloadISOImage(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const params = new URLSearchParams({
+                url: payload.url,
+                content: payload.content,
+                filename: payload.filename,
+            });
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    headers: yield this.prepareHeaders(),
+                    method: "POST",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/storage/${payload.storage}/download-url?${params.toString()}`),
+                });
+            }
+            catch (err) {
+                this.logger.error(Object.assign(Object.assign({ status: err.response.status }, payload), { errors: err.response.data.errors }), err.response.statusText);
+            }
+            return (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+        });
+    }
+    startQemuMachine(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    method: "POST",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/qemu/${payload.vmid}/status/start`),
+                    headers: yield this.prepareHeaders(),
+                });
+            }
+            catch (err) {
+                this.logger.error(Object.assign(Object.assign({ status: err.response.status }, payload), { errors: err.response.data.errors }), err.response.statusText);
+            }
+            return (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+        });
+    }
+    stopQemuMachine(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    method: "POST",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/qemu/${payload.vmid}/status/stop`),
+                    headers: yield this.prepareHeaders(),
+                });
+            }
+            catch (err) {
+                this.logger.error(Object.assign(Object.assign({ status: err.response.status }, payload), { errors: err.response.data.errors }), err.response.statusText);
+            }
+            return (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+        });
+    }
+    cloneQemuMarchine(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    method: "POST",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/qemu/${payload.vmid}/clone`),
+                    headers: Object.assign({}, yield this.prepareHeaders()),
+                    data: {
+                        full: 1,
+                        name: "azdzfaef2233",
+                        newid: payload.newid,
+                        target: payload.node,
+                    },
+                });
+            }
+            catch (err) {
+                this.logger.error(Object.assign(Object.assign({ status: err.response.status }, payload), { errors: err.response.data.errors }), err.response.statusText);
+            }
+            return (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+        });
+    }
+    resizeDisk(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let data;
+            try {
+                data = yield (0, axios_1.default)({
+                    method: "PUT",
+                    url: this.computeUrl(`/api2/json/nodes/${payload.node}/qemu/${payload.vmid}/resize`),
+                    headers: yield this.prepareHeaders(),
+                    data: {
+                        disk: payload.disk,
+                        size: `+${payload.size}G`
+                    }
+                });
+            }
+            catch (err) {
+                this.logger.error(Object.assign(Object.assign({ status: err.response.status }, payload), { errors: err.response.data.errors }), err.response.statusText);
+            }
+            return (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.data;
+        });
+    }
+    computeUrl(path) {
+        return `${this.parameters.host}${path}`;
+    }
+    prepareHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ticket = yield this.getTicket();
+            return {
+                CSRFPreventionToken: ticket.CSRFPreventionToken,
+                Cookie: `PVEAuthCookie=${ticket.ticket}`,
+            };
+        });
+    }
+    getTicket() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = new URLSearchParams({
+                username: this.parameters.username,
+                password: this.parameters.password,
+            });
+            let data;
+            try {
+                const url = this.computeUrl(`/api2/json/access/ticket?${params.toString()}`);
+                ({ data } = yield (0, axios_1.default)({
+                    url,
+                    method: "POST",
+                    headers: {
+                        "Content-Type": "application/x-www-form-urlencoded",
+                    },
+                }));
+            }
+            catch (err) {
+                console.log(err.response.status);
+                console.log(err.response.statusText);
+            }
+            return data.data;
+        });
+    }
+}
+exports.HttpProxmoxRepository = HttpProxmoxRepository;

package/dist/src/proxmox.provider.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProxmoxProvider = void 0;
+const config_1 = __importDefault(require("config"));
+const nestjs_pino_1 = require("nestjs-pino");
+const constants_1 = require("../../common/constants");
+const http_proxmox_repository_1 = require("./http-proxmox.repository");
+exports.ProxmoxProvider = {
+    provide: constants_1.PROXMOX_PROVIDER,
+    useFactory: (logger) => {
+        console.log(config_1.default.get('services.proxmox.weidian'));
+        const configuration = {
+            username: config_1.default.get("services.proxmox.weidian.username"),
+            password: config_1.default.get("services.proxmox.weidian.password"),
+            host: config_1.default.get("services.proxmox.weidian.url"),
+        };
+        return new http_proxmox_repository_1.HttpProxmoxRepository(configuration, logger);
+    },
+    inject: [nestjs_pino_1.Logger],
+};

package/dist/src/tools/encode-ssh-key.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeSSHKey = void 0;
+function encodeSSHKey(key) {
+    return encodeURIComponent(key);
+}
+exports.encodeSSHKey = encodeSSHKey;

package/dist/src/types/clone-qemu-machine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/create-qemu-machine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/delete-qemu-machine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/download-iso-image.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/index.js

@@ -0,0 +1,26 @@
+"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("./clone-qemu-machine"), exports);
+__exportStar(require("./create-qemu-machine"), exports);
+__exportStar(require("./delete-qemu-machine"), exports);
+__exportStar(require("./download-iso-image"), exports);
+__exportStar(require("./index"), exports);
+__exportStar(require("./ip"), exports);
+__exportStar(require("./list-qemu-machines"), exports);
+__exportStar(require("./start-qemu-machine"), exports);
+__exportStar(require("./stop-qemu-machine"), exports);
+__exportStar(require("./upid"), exports);

package/dist/src/types/ip.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/list-qemu-machines.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/start-qemu-machine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/stop-qemu-machine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/update-qemu-machine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/upid.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/index.ts

@@ -0,0 +1,2 @@
+export { HttpProxmoxRepository } from './src/http-proxmox.repository'
+export * from './src/types'

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "proxmox-sdk",
+  "version": "0.0.1",
+  "description": "Opiniated and abtracted Typescript SDK for Proxmox",
+  "author": "Tchoupinax <corentinfiloche@hotmail.fr> (https://corentinfiloche.xyz)",
+  "license": "MIT",
+  "keywords": [
+    "API",
+    "Proxmox",
+    "SDK"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Tchoupinax/proxmox-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/Tchoupinax/proxmox-sdk/issues"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@types/node": "20.14.9",
+    "typescript": "5.5.3"
+  },
+  "dependencies": {
+    "axios": "1.7.2",
+    "nestjs-pino": "4.1.0"
+  }
+}