@cyberalien/deploy-utils 0.0.1 → 0.0.3

package/lib/commands/config.d.ts

@@ -0,0 +1,3 @@
+declare const stableNodeVersion = 24;
+declare const defaultNVMVersion = "0.40.5";
+export { defaultNVMVersion, stableNodeVersion };

package/lib/commands/config.js

@@ -0,0 +1,3 @@
+const stableNodeVersion = 24;
+const defaultNVMVersion = "0.40.5";
+export { defaultNVMVersion, stableNodeVersion };

package/lib/commands/node.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Various commands to install Node and its tools
+ */
+declare const nodeInstallCommands: {
+  nvm: (version?: string) => string[];
+  node: (version?: number | string) => string;
+  corepack: string;
+  pm2: string;
+};
+/**
+ * Reinstall and restart app using pm2
+ */
+declare const nodeRestartAppCommand = "rm -rf node_modules pnpm-lock.yaml && npx pnpm i && pm2 restart all --time";
+export { nodeInstallCommands, nodeRestartAppCommand };

package/lib/commands/node.js

@@ -0,0 +1,15 @@
+import { defaultNVMVersion } from "./config.js";
+/**
+* Various commands to install Node and its tools
+*/
+const nodeInstallCommands = {
+	nvm: (version = defaultNVMVersion) => [`curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v${version}/install.sh | bash`, "source ~/.bashrc"],
+	node: (version = 24) => `nvm install ${version} && nvm use ${version} && nvm alias default ${version}`,
+	corepack: "npm i -g corepack@latest && corepack enable",
+	pm2: "npm install -g pm2"
+};
+/**
+* Reinstall and restart app using pm2
+*/
+const nodeRestartAppCommand = "rm -rf node_modules pnpm-lock.yaml && npx pnpm i && pm2 restart all --time";
+export { nodeInstallCommands, nodeRestartAppCommand };

package/lib/commands/ubuntu.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Command to update packages in Ubuntu
+ */
+declare const ubuntoUpdateCommand = "apt-get update -y && apt-get --with-new-pkgs upgrade -y";
+export { ubuntoUpdateCommand };

package/lib/commands/ubuntu.js

@@ -0,0 +1,5 @@
+/**
+* Command to update packages in Ubuntu
+*/
+const ubuntoUpdateCommand = "apt-get update -y && apt-get --with-new-pkgs upgrade -y";
+export { ubuntoUpdateCommand };

package/lib/index.d.ts

@@ -1,5 +1,9 @@
-import { connectToSSH } from "./ssh/connect.js";
+import { connectToSSH, connectToSSHWithKeys } from "./ssh/connect.js";
+import { SSHExecResult, execSFTPCommand } from "./ssh/exec.js";
+import { startSFTPSession } from "./ssh/sftp.js";
+import { getSFTPFile } from "./ssh/get.js";
 import { readSFTPDir } from "./ssh/readdir.js";
-import { uploadSFTPFile } from "./ssh/upload.js";
+import { putSFTPFile, uploadSFTPFile } from "./ssh/upload.js";
+import { putSFTPFiles, uploadSFTPFiles } from "./ssh/upload-files.js";
 import { initTokens } from "./misc/tokens.js";
-export { connectToSSH, initTokens, readSFTPDir, uploadSFTPFile };
+export { SSHExecResult, connectToSSH, connectToSSHWithKeys, execSFTPCommand, getSFTPFile, initTokens, putSFTPFile, putSFTPFiles, readSFTPDir, startSFTPSession, uploadSFTPFile, uploadSFTPFiles };

package/lib/index.js

@@ -1,5 +1,9 @@
-import { connectToSSH } from "./ssh/connect.js";
+import { connectToSSH, connectToSSHWithKeys } from "./ssh/connect.js";
+import { execSFTPCommand } from "./ssh/exec.js";
+import { startSFTPSession } from "./ssh/sftp.js";
+import { getSFTPFile } from "./ssh/get.js";
 import { readSFTPDir } from "./ssh/readdir.js";
-import { uploadSFTPFile } from "./ssh/upload.js";
+import { putSFTPFile, uploadSFTPFile } from "./ssh/upload.js";
+import { putSFTPFiles, uploadSFTPFiles } from "./ssh/upload-files.js";
 import { initTokens } from "./misc/tokens.js";
-export { connectToSSH, initTokens, readSFTPDir, uploadSFTPFile };
+export { connectToSSH, connectToSSHWithKeys, execSFTPCommand, getSFTPFile, initTokens, putSFTPFile, putSFTPFiles, readSFTPDir, startSFTPSession, uploadSFTPFile, uploadSFTPFiles };

package/lib/ssh/connect.d.ts

@@ -3,4 +3,10 @@ import { Client, ConnectConfig } from "ssh2";
  * Connect to SSH
  */
 declare function connectToSSH(config: ConnectConfig): Promise<Client>;
-export { connectToSSH };
+/**
+ * Connect with keys
+ *
+ * Keys can be provided as keys or as files to load keys from
+ */
+declare function connectToSSHWithKeys(host: string, username: string, keysOrFilenames: string | string[]): Promise<Client>;
+export { connectToSSH, connectToSSHWithKeys };

package/lib/ssh/connect.js

@@ -1,3 +1,4 @@
+import { readFile } from "node:fs/promises";
 import { Client } from "ssh2";
 /**
 * Connect to SSH
@@ -16,4 +17,32 @@ function connectToSSH(config) {
 		}
 	});
 }
-export { connectToSSH };
+/**
+* Connect with keys
+*
+* Keys can be provided as keys or as files to load keys from
+*/
+async function connectToSSHWithKeys(host, username, keysOrFilenames) {
+	const keys = [];
+	for (const key of Array.isArray(keysOrFilenames) ? keysOrFilenames : [keysOrFilenames]) {
+		if (key.startsWith("-----BEGIN")) {
+			keys.push(key);
+			continue;
+		}
+		const files = key.split(",").map((file) => file.trim());
+		for (const file of files) {
+			const content = await readFile(file, "utf-8");
+			keys.push(content);
+		}
+	}
+	for (const privateKey of keys) try {
+		return await connectToSSH({
+			host,
+			port: 22,
+			username,
+			privateKey
+		});
+	} catch (err) {}
+	throw new Error(`Failed to connect to ${host} with provided API keys`);
+}
+export { connectToSSH, connectToSSHWithKeys };

package/lib/ssh/exec.d.ts

@@ -0,0 +1,10 @@
+import { Client } from "ssh2";
+import { ExecResult } from "@cyberalien/git-utils/lib/misc/exec.js";
+interface SSHExecResult extends ExecResult {
+  code: number;
+}
+/**
+ * Execute command, optionally log output immediately
+ */
+declare function execSFTPCommand(client: Client, cmd: string, log?: boolean): Promise<SSHExecResult>;
+export { SSHExecResult, execSFTPCommand };

package/lib/ssh/exec.js

@@ -0,0 +1,31 @@
+/**
+* Execute command, optionally log output immediately
+*/
+function execSFTPCommand(client, cmd, log = false) {
+	return new Promise((resolve, reject) => {
+		client.exec(cmd, (err, stream) => {
+			if (err) {
+				reject(err);
+				return;
+			}
+			let stdout = "";
+			let stderr = "";
+			stream.on("close", (code) => {
+				resolve({
+					stdout,
+					stderr,
+					code
+				});
+			});
+			stream.stdout.on("data", (data) => {
+				if (log) console.log(`${data}`);
+				stdout += `${data}`;
+			});
+			stream.stderr.on("data", (data) => {
+				if (log) console.error(`${data}`);
+				stderr += `${data}`;
+			});
+		});
+	});
+}
+export { execSFTPCommand };

package/lib/ssh/get.d.ts

@@ -0,0 +1,9 @@
+import { SFTPWrapper } from "ssh2";
+/**
+ * Get file, optionally save it
+ *
+ * returnLength is intended to be used to download/save binary buffers without converting them as string.
+ * If set, it will return length of data (as string) instead of data itself.
+ */
+declare function getSFTPFile(sftp: SFTPWrapper, path: string, saveAs?: string, returnLength?: boolean): Promise<string>;
+export { getSFTPFile };

package/lib/ssh/get.js

@@ -0,0 +1,19 @@
+import { createFile } from "@cyberalien/git-utils/lib/misc/write.js";
+/**
+* Get file, optionally save it
+*
+* returnLength is intended to be used to download/save binary buffers without converting them as string.
+* If set, it will return length of data (as string) instead of data itself.
+*/
+function getSFTPFile(sftp, path, saveAs, returnLength = false) {
+	return new Promise((resolve, reject) => {
+		sftp.readFile(path, (err, data) => {
+			if (err) reject(err);
+			else if (saveAs) createFile(saveAs, data).then(() => {
+				resolve(returnLength ? `${data.length}` : `${data}`);
+			}).catch(reject);
+			else resolve(returnLength ? `${data.length}` : `${data}`);
+		});
+	});
+}
+export { getSFTPFile };

package/lib/ssh/readdir.d.ts

@@ -1,4 +1,4 @@
-import { Client, Stats } from "ssh2";
+import { SFTPWrapper, Stats } from "ssh2";
 interface FilesListItem {
   filename: string;
   longname: string;
@@ -7,5 +7,5 @@ interface FilesListItem {
 /**
  * Read remote directory
  */
-declare function readSFTPDir(client: Client, path: string): Promise<FilesListItem[]>;
+declare function readSFTPDir(sftp: SFTPWrapper, path: string): Promise<FilesListItem[]>;
 export { readSFTPDir };

package/lib/ssh/readdir.js

@@ -1,20 +1,14 @@
 /**
 * Read remote directory
 */
-function readSFTPDir(client, path) {
+function readSFTPDir(sftp, path) {
 	return new Promise((resolve, reject) => {
-		client.sftp((err, sftp) => {
+		sftp.readdir(path, (err, list) => {
 			if (err) {
 				reject(err);
 				return;
 			}
-			sftp.readdir(path, (err, list) => {
-				if (err) {
-					reject(err);
-					return;
-				}
-				resolve(list);
-			});
+			resolve(list);
 		});
 	});
 }

package/lib/ssh/sftp.d.ts

@@ -0,0 +1,6 @@
+import { Client, SFTPWrapper } from "ssh2";
+/**
+ * Start SFTP session
+ */
+declare function startSFTPSession(client: Client): Promise<SFTPWrapper>;
+export { startSFTPSession };

package/lib/ssh/sftp.js

@@ -0,0 +1,15 @@
+/**
+* Start SFTP session
+*/
+function startSFTPSession(client) {
+	return new Promise((resolve, reject) => {
+		client.sftp((err, sftp) => {
+			if (err) {
+				reject(err);
+				return;
+			}
+			resolve(sftp);
+		});
+	});
+}
+export { startSFTPSession };

package/lib/ssh/upload-files.d.ts

@@ -0,0 +1,13 @@
+import { Client } from "ssh2";
+import { GitRepoFilesList } from "@cyberalien/git-utils/lib/git/index.js";
+/**
+ * Upload multiple files
+ *
+ * For binary files use putSFTPFiles() instead
+ */
+declare function uploadSFTPFiles(client: Client, remoteRootDir: string, files: GitRepoFilesList): Promise<void>;
+/**
+ * Upload multiple local files
+ */
+declare function putSFTPFiles(client: Client, localRootDir: string, remoteRootDir: string, filenames: string[]): Promise<void>;
+export { putSFTPFiles, uploadSFTPFiles };

package/lib/ssh/upload-files.js

@@ -0,0 +1,75 @@
+import { execSFTPCommand } from "./exec.js";
+import { startSFTPSession } from "./sftp.js";
+import { putSFTPFile, uploadSFTPFile } from "./upload.js";
+import { dirname, join } from "node:path/posix";
+/**
+* Create directories for files
+*/
+async function createDirectories(client, rootDir, filenames) {
+	const directories = /* @__PURE__ */ new Set();
+	for (const file of filenames) {
+		let dir = dirname(file);
+		if (dir.startsWith("/")) {
+			if (rootDir) throw new Error(`File path ${file} is absolute`);
+			dir = dir.slice(1);
+		}
+		if (dir) directories.add(dir);
+	}
+	const sortedDirs = Array.from(directories).sort((a, b) => b.length - a.length);
+	const dirsToCreate = [];
+	for (const dir of sortedDirs) {
+		const match = `${dir}/`;
+		if (!dirsToCreate.some((d) => d.startsWith(match))) dirsToCreate.push(dir);
+	}
+	const commands = [`mkdir -p ${dirsToCreate.map((dir) => `"${join(rootDir, dir)}"`).join(" ")}`];
+	if (rootDir) {
+		commands.unshift(`cd "${rootDir}"`);
+		commands.unshift(`mkdir -p "${rootDir}"`);
+	}
+	const execResult = await execSFTPCommand(client, commands.join(" && "));
+	if (execResult.code !== 0) throw new Error(`Failed to create directories: ${execResult.stderr || execResult.stdout}`);
+}
+/**
+* Upload multiple files
+*
+* For binary files use putSFTPFiles() instead
+*/
+async function uploadSFTPFiles(client, remoteRootDir, files) {
+	const filenames = [];
+	let filesCount = 0;
+	for (const file in files) {
+		filesCount++;
+		if (files[file] === null) continue;
+		filenames.push(file);
+	}
+	await createDirectories(client, remoteRootDir, filenames);
+	const sftp = await startSFTPSession(client);
+	let index = 0;
+	for (const file in files) {
+		index++;
+		const content = files[file];
+		const target = join(remoteRootDir, file);
+		if (content === null) {
+			console.log(`[${index} / ${filesCount}] Deleting ${file}`);
+			await execSFTPCommand(client, `rm -f "${target}"`);
+			continue;
+		}
+		console.log(`[${index} / ${filesCount}] Uploading ${file}`);
+		await uploadSFTPFile(sftp, target, typeof content === "string" ? content : JSON.stringify(content, null, 2) + "\n");
+	}
+}
+/**
+* Upload multiple local files
+*/
+async function putSFTPFiles(client, localRootDir, remoteRootDir, filenames) {
+	await createDirectories(client, remoteRootDir, filenames);
+	const sftp = await startSFTPSession(client);
+	const filesCount = filenames.length;
+	let index = 0;
+	for (const file of filenames) {
+		index++;
+		console.log(`[${index} / ${filesCount}] Uploading ${file}`);
+		await putSFTPFile(sftp, join(localRootDir, file), join(remoteRootDir, file));
+	}
+}
+export { putSFTPFiles, uploadSFTPFiles };

package/lib/ssh/upload.d.ts

@@ -1,6 +1,12 @@
-import { Client } from "ssh2";
+import { SFTPWrapper } from "ssh2";
 /**
  * Upload file
+ *
+ * For binary files use putSFTPFile() instead
  */
-declare function uploadSFTPFile(client: Client, path: string, content: string): Promise<void>;
-export { uploadSFTPFile };
+declare function uploadSFTPFile(sftp: SFTPWrapper, remoteFile: string, content: string): Promise<void>;
+/**
+ * Upload local file
+ */
+declare function putSFTPFile(sftp: SFTPWrapper, localFile: string, remoteFile: string): Promise<void>;
+export { putSFTPFile, uploadSFTPFile };

package/lib/ssh/upload.js

@@ -1,21 +1,31 @@
 /**
 * Upload file
+*
+* For binary files use putSFTPFile() instead
 */
-function uploadSFTPFile(client, path, content) {
+function uploadSFTPFile(sftp, remoteFile, content) {
 	return new Promise((resolve, reject) => {
-		client.sftp((err, sftp) => {
+		sftp.writeFile(remoteFile, content, (err) => {
 			if (err) {
 				reject(err);
 				return;
 			}
-			sftp.writeFile(path, content, (err) => {
-				if (err) {
-					reject(err);
-					return;
-				}
-				resolve();
-			});
+			resolve();
 		});
 	});
 }
-export { uploadSFTPFile };
+/**
+* Upload local file
+*/
+function putSFTPFile(sftp, localFile, remoteFile) {
+	return new Promise((resolve, reject) => {
+		sftp.fastPut(localFile, remoteFile, (err) => {
+			if (err) {
+				reject(err);
+				return;
+			}
+			resolve();
+		});
+	});
+}
+export { putSFTPFile, uploadSFTPFile };

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "description": "Functions for deploying stuff.",
   "author": "Vjacheslav Trushkin",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "license": "UNLICENSED",
   "homepage": "https://cyberalien.dev/",
   "sideEffects": false,
@@ -15,15 +15,15 @@
     "*.d.ts"
   ],
   "devDependencies": {
-    "@types/node": "^25.6.0",
+    "@types/node": "^25.9.4",
     "@types/ssh2": "^1.15.5",
-    "oxlint": "^1.60.0",
-    "tsdown": "^0.21.9",
+    "oxlint": "^1.70.0",
+    "tsdown": "^0.21.10",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.4"
+    "vitest": "^4.1.9"
   },
   "dependencies": {
-    "@cyberalien/git-utils": "^0.0.8",
+    "@cyberalien/git-utils": "^0.0.11",
     "ssh2": "^1.17.0"
   },
   "scripts": {