feat: merge all machini methods to qsu package. machini package will be deprecated.

Author: jooy2

docs/src/en/reference/os/getMachineId.md

@@ -0,0 +1,23 @@
+# getMachineId <Badge type="tip" text="JavaScript" />
+
+<span class="node-required">Requires a Node.js runtime ('qsu/node')</span>
+
+Gets the unique UUID of the current device. Throws an error if the value is not retrieved. Returns a `Promise` object, so use `await` or `.then()` to wait for the operation to complete and get the correct value.
+
+The UUID may change when the system is reinstalled or as the virtual machine's environment changes. On some systems, this value can also be modified by the system administrator (but this is rarely utilized as the system may become unstable after modification).
+
+This method returns the same value for every user on the system.
+
+## Parameters
+
+No required parameters
+
+## Returns
+
+> string
+
+## Examples
+
+```javascript
+console.log(await getMachineId()); // Returns 'a642d9e1-6063-4da7-8ea8-2298f989d01d'
+```

docs/src/en/reference/os/getSid.md

@@ -0,0 +1,25 @@
+# getSid <Badge type="tip" text="JavaScript" />
+
+<span class="node-required">Requires a Node.js runtime ('qsu/node')</span>
+
+Gets the Security Identifier (SID) value for the current user on the device. Throws an error if the value is not obtained.
+
+The SID value is only supported on Windows and macOS. Other OSes throw an error.
+
+Also, the SID value used on macOS is a value created for the directory service. If you don't trust this value, use the `machineId` method instead.
+
+This value can be changed by the user.
+
+## Parameters
+
+No required parameters
+
+## Returns
+
+> string
+
+## Examples
+
+```javascript
+console.log(await sid()); // Returns 'S-1-5-21-406418252-5582013529-1321253100-2001'
+```

docs/src/en/reference/os/runCommand.md

@@ -0,0 +1,19 @@
+# runCommand <Badge type="tip" text="JavaScript" />
+
+<span class="node-required">Requires a Node.js runtime ('qsu/node')</span>
+
+It returns the result that is output after entering and executing the command prompt command.
+
+## Parameters
+
+- `command::string`
+
+## Returns
+
+> string
+
+## Examples
+
+```javascript
+console.log(await runCommand('echo a')); // Returns 'a\n'
+```

docs/src/ko/reference/os/getMachineId.md

@@ -0,0 +1,23 @@
+# getMachineId <Badge type="tip" text="JavaScript" />
+
+<span class="node-required">Node.js 런타임 필요 ('qsu/node')</span>
+
+현재 장치의 고유 UUID를 가져옵니다. 값을 가져오지 못하면 에러를 발생시킵니다. `Promise` 객체를 반환하므로, `await` 또는 `.then()`을 사용하여 작업이 완료될 때까지 기다렸다가 올바른 값을 얻으십시오.
+
+UUID는 시스템을 재설치하거나 가상 머신의 환경이 변경될 때 변경될 수 있습니다. 일부 시스템에서는 시스템 관리자가 이 값을 수정할 수도 있습니다(그러나 시스템이 불안정해질 수 있으므로 거의 사용되지 않습니다).
+
+이 방법은 시스템의 모든 사용자에게 동일한 값을 반환합니다.
+
+## Parameters
+
+필수 매개 변수 없음
+
+## Returns
+
+> string
+
+## Examples
+
+```javascript
+console.log(await getMachineId()); // Returns 'a642d9e1-6063-4da7-8ea8-2298f989d01d'
+```

docs/src/ko/reference/os/getSid.md

@@ -0,0 +1,25 @@
+# getSid <Badge type="tip" text="JavaScript" />
+
+<span class="node-required">Node.js 런타임 필요 ('qsu/node')</span>
+
+장치의 현재 사용자에 대한 보안 식별자(SID) 값을 가져옵니다. 값을 가져오지 못하면 에러를 발생시킵니다.
+
+SID 값은 윈도우와 맥OS에서만 지원됩니다. 다른 운영 체제에서는 오류가 발생합니다.
+
+또한, 맥OS에서 사용되는 SID 값은 디렉토리 서비스를 위해 생성된 값입니다. 이 값을 신뢰하지 않는다면, 대신 `machineId` 방법을 사용하십시오.
+
+이 값은 사용자가 변경할 수 있습니다.
+
+## Parameters
+
+필수 매개 변수 없음
+
+## Returns
+
+> string
+
+## Examples
+
+```javascript
+console.log(await sid()); // Returns 'S-1-5-21-406418252-5582013529-1321253100-2001'
+```

docs/src/ko/reference/os/runCommand.md

@@ -0,0 +1,19 @@
+# runCommand <Badge type="tip" text="JavaScript" />
+
+<span class="node-required">Node.js 런타임 필요 ('qsu/node')</span>
+
+명령 프롬프트 커맨드를 입력하고 실행 후 출력되는 결과를 리턴합니다.
+
+## Parameters
+
+- `command::string`
+
+## Returns
+
+> string
+
+## Examples
+
+```javascript
+console.log(await runCommand('echo a')); // Returns 'a\n'
+```

packages/javascript/lib/node/index.ts

@@ -1,2 +1,3 @@
-export * from './file/index.js';
 export * from './crypto/index.js';
+export * from './file/index.js';
+export * from './os/index.js';

packages/javascript/lib/node/os/getMachineId.ts

@@ -0,0 +1,29 @@
+import { platform } from 'os';
+import { runCommand } from './runCommand.js';
+
+export async function getMachineId(): Promise<string> {
+	const platformName = platform();
+	let command;
+
+	if (platformName === 'win32') {
+		command =
+			'for /f "tokens=3 delims= " %i in (\'REG QUERY HKLM\\SOFTWARE\\Microsoft\\Cryptography /v MachineGuid ^| findstr MachineGuid\') do @echo %i';
+	} else if (platformName === 'darwin') {
+		command = "ioreg -rd1 -c IOPlatformExpertDevice | awk '/IOPlatformUUID/' | cut -d '\"' -f4";
+	} else if (platformName === 'freebsd') {
+		command = 'kenv -q smbios.system.uuid || sysctl -n kern.hostuuid';
+	} else {
+		command =
+			'(cat /var/lib/dbus/machine-id /etc/machine-id 2> /dev/null || hostname) | head -n 1 || :';
+	}
+
+	try {
+		return await runCommand(command);
+	} catch (error) {
+		if (error instanceof Error) {
+			throw new Error(error?.message);
+		}
+	}
+
+	throw new Error('Failed to get machine id');
+}

packages/javascript/lib/node/os/getSid.ts

@@ -0,0 +1,67 @@
+import { homedir, platform, userInfo } from 'os';
+import { AnyValueObject } from '../../_types/global';
+import { runCommand } from './runCommand.js';
+
+export async function getSid(): Promise<string> {
+	const platformName = platform();
+
+	if (platformName === 'win32') {
+		try {
+			const profileLists = await runCommand(
+				`REG QUERY "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ProfileList" /s`
+			);
+
+			const profiles: AnyValueObject = {};
+			const sections = profileLists.split('HKEY_LOCAL_MACHINE\\');
+
+			sections.forEach((section) => {
+				const lines = section
+					.split('\n')
+					.map((line) => line.trim())
+					.filter((line) => line);
+
+				if (lines.length > 0) {
+					const keyName: string = lines[0].split('\\').pop() || 'Unknown';
+					const profileImagePath = lines.find((line) => line.startsWith('ProfileImagePath'));
+
+					if (profileImagePath) {
+						profiles[keyName] = profileImagePath.split('    ').pop() || 'Unknown';
+					}
+				}
+			});
+
+			for (let i = 0; i < Object.keys(profiles).length; i += 1) {
+				const key = Object.keys(profiles)[i];
+				const value = profiles[key];
+
+				if (value === homedir()) {
+					return key;
+				}
+			}
+		} catch (error) {
+			if (error instanceof Error) {
+				throw new Error(error?.message);
+			}
+		}
+
+		throw new Error('Failed to get machine id');
+	}
+
+	if (platformName === 'darwin') {
+		try {
+			const execResult = await runCommand(`dsmemberutil getsid -U ${userInfo().username}`);
+
+			if (execResult) {
+				return execResult.replace(/\r?\n/g, '');
+			}
+		} catch (error) {
+			if (error instanceof Error) {
+				throw new Error(error?.message);
+			}
+		}
+
+		throw new Error('Failed to get machine id');
+	}
+
+	throw new Error('Not supported on this operating system.');
+}

packages/javascript/lib/node/os/index.ts

@@ -0,0 +1,3 @@
+export { getMachineId } from './getMachineId.js';
+export { getSid } from './getSid.js';
+export { runCommand } from './runCommand.js';

packages/javascript/lib/node/os/runCommand.ts

@@ -0,0 +1,28 @@
+import { exec as processExec } from 'child_process';
+import { platform } from 'os';
+
+export function runCommand(command: string): Promise<string> {
+	return new Promise((resolve, reject) => {
+		const execCommandProcess = processExec(
+			command,
+			{ encoding: 'utf8', windowsHide: true },
+			(error, stdout) => {
+				if (error) {
+					reject(error);
+					return;
+				}
+
+				const output = platform() === 'win32' ? stdout : stdout.split('\r\n')?.[0] || '';
+
+				execCommandProcess?.stdin?.end();
+
+				if (output) {
+					resolve(output);
+					return;
+				}
+
+				reject(new Error(`Command failed`));
+			}
+		);
+	});
+}

packages/javascript/test/os.test.ts

@@ -0,0 +1,48 @@
+import assert from 'assert';
+import { describe, it } from 'node:test';
+import { runCommand, getMachineId, getSid } from '../dist/node';
+
+describe('OS', () => {
+	it('runCommand', async () => {
+		assert.strictEqual(await runCommand('echo a'), 'a\n');
+		assert.strictEqual(await runCommand('echo b'), 'b\n');
+	});
+
+	/*
+	 * Sample Response:
+	 * Windows: a642d9e1-6063-4da7-8ea8-2298f989d01d
+	 * Linux: 5c6ee51d3e514eb4883e4373e320192c
+	 * macOS: BAC04154-124A-56E1-BFEB-D6D94FE5DBC0
+	 */
+	it('getMachineId', async () => {
+		const mId = await getMachineId();
+
+		let regex;
+
+		switch (process.platform) {
+			case 'win32':
+			case 'darwin':
+			case 'freebsd':
+				regex = /^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}/;
+				break;
+			default:
+				regex = /^[0-9a-zA-Z]{8}-?[0-9a-zA-Z]{4}-?[0-9a-zA-Z]{4}-?[0-9a-zA-Z]{4}-?[0-9a-zA-Z]{12}/;
+				break;
+		}
+
+		assert.match(mId, regex);
+	});
+
+	// Example: S-1-5-21-406418252-5582013529-1321253100-2001
+	it('getSid', async () => {
+		const { platform } = process;
+
+		if (platform !== 'win32' && platform !== 'darwin') {
+			return;
+		}
+
+		const sidResult = await getSid();
+
+		assert.match(sidResult, /^S-1-[0-59]-\d{2}-\d{8,10}-\d{8,10}-\d{8,10}-[1-9]\d{1,9}/);
+	});
+});