feat: add Agent and firmware metadata to user configuration

package.json

@@ -6,7 +6,7 @@
   "version": "8.0.1",
   "firmwareVersion": "15.3.0",
   "deviceProtocolVersion": "4.15.0",
-  "userConfigVersion": "12.1.0",
+  "userConfigVersion": "13.0.0",
   "hardwareConfigVersion": "1.0.0",
   "description": "Agent is the configuration application of the Ultimate Hacking Keyboard.",
   "repository": {

packages/uhk-common/scripts/generate-versions.mjs

@@ -1,6 +1,9 @@
+import { exec } from 'node:child_process';
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import process from 'node:process';
 
+import getGithubTag from '../../../scripts/get-github-tag.mjs';
 const rootPackageJsonPath = path.join(import.meta.dirname, '../../../package.json');
 const packageJsonContent = await fs.readFile(rootPackageJsonPath, { encoding: 'utf8' });
 const packageJson = JSON.parse(packageJsonContent)
@@ -9,6 +12,8 @@ const versionsFileContent = `\
 import { VersionInformation } from '../models/version-information.js';
 
 export const VERSIONS: VersionInformation = {
+    agentRepo: ${writeValue(getGitRepo())},
+    agentTag: ${writeValue(await getGitTag())},
     version: ${writeValue(packageJson.version)},
     firmwareVersion: ${writeValue(packageJson.firmwareVersion)},
     deviceProtocolVersion: ${writeValue(packageJson.deviceProtocolVersion)},
@@ -17,6 +22,11 @@ export const VERSIONS: VersionInformation = {
 }
 `
 
+if (process.env.CI) {
+    console.log('versions.ts file content:')
+    console.log(versionsFileContent);
+}
+
 const versionsFilePath = path.join(import.meta.dirname, '../src/util/versions.ts')
 await fs.writeFile(versionsFilePath, versionsFileContent, { encoding: 'utf8' });
 
@@ -31,3 +41,50 @@ function writeValue(value) {
 
     return `'${value}'`;
 }
+
+function getGitRepo() {
+    if (process.env.CI) {
+        return process.env.GITHUB_REPOSITORY;
+    }
+
+    return 'UltimateHackingKeyboard/agent'
+}
+
+async function getGitTag() {
+    if (process.env.CI) {
+        const tag = getGithubTag();
+        if (tag) {
+            return tag;
+        }
+    }
+
+    try {
+        const tagResponse = await execAsync('git describe --exact-match --tags')
+
+        if (tagResponse.stdout) {
+            return tagResponse.stdout.trim()
+        }
+    } catch (error) {
+        console.log('No Agent git tag fallback to sha')
+    }
+
+    // fallback to git sha
+    const shaResponse = await execAsync('git rev-parse --verify --short HEAD')
+
+    return shaResponse.stdout.trim()
+}
+
+async function execAsync(command) {
+    return new Promise((resolve, reject) => {
+        exec(command, (error, stdout, stderr) => {
+            if (error) {
+                return reject(error);
+            }
+
+            resolve({
+                stdout,
+                stderr,
+            });
+        })
+    })
+}

packages/uhk-common/src/config-serializer/config-items/host-connection.ts

@@ -74,6 +74,7 @@ export class HostConnection {
             case 9:
             case 11:
             case 12:
+            case 13:
                 return this.fromJsonObjectV9(jsonObject, serialisationInfo);
 
             default:
@@ -89,6 +90,7 @@ export class HostConnection {
             case 9:
             case 11:
             case 12:
+            case 13:
                 return this.fromJsonBinaryV9(buffer, serialisationInfo);
 
             default:

packages/uhk-common/src/config-serializer/config-items/key-action/helper.ts

@@ -40,6 +40,7 @@ export class Helper {
             case 9:
             case 11:
             case 12:
+            case 13:
                 return this.fromUhkBufferV1(buffer, macros, serialisationInfo);
 
             default:
@@ -128,6 +129,7 @@ export class Helper {
             case 9:
             case 11:
             case 12:
+            case 13:
                 return this.fromJSONObjectV1(keyAction, macros, serialisationInfo);
 
             default:

packages/uhk-common/src/config-serializer/config-items/key-action/keystroke-action.ts

@@ -85,6 +85,7 @@ export class KeystrokeAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV6(jsonObject, serialisationInfo);
                 break;
 
@@ -111,6 +112,7 @@ export class KeystrokeAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV6(buffer, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/key-action/mouse-action.ts

@@ -64,6 +64,7 @@ export class MouseAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV6(jsonObject, serialisationInfo);
                 break;
 
@@ -90,6 +91,7 @@ export class MouseAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV6(buffer, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/key-action/play-macro-action.ts

@@ -95,6 +95,7 @@ export class PlayMacroAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV6(jsonObject, macros, serialisationInfo);
                 break;
 
@@ -121,6 +122,7 @@ export class PlayMacroAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV6(buffer, macros, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/key-action/switch-keymap-action.ts

@@ -43,6 +43,7 @@ export class SwitchKeymapAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV6(jsonObject, serialisationInfo);
                 break;
 
@@ -119,6 +120,7 @@ export class UnresolvedSwitchKeymapAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV6(buffer, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/key-action/switch-layer-action.ts

@@ -73,6 +73,7 @@ export class SwitchLayerAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV6(jsonObject, serialisationInfo);
                 break;
 
@@ -99,6 +100,7 @@ export class SwitchLayerAction extends KeyAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV6(buffer, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/keymap.ts

@@ -42,6 +42,7 @@ export class Keymap {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject, macros, serialisationInfo);
                 break;
 
@@ -67,6 +68,7 @@ export class Keymap {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer, macros, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/layer.ts

@@ -41,6 +41,7 @@ export class Layer {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV5(jsonObject, macros, serialisationInfo);
                 break;
 
@@ -67,6 +68,7 @@ export class Layer {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV5(buffer, macros, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/command-macro-action.ts

@@ -27,6 +27,7 @@ export class CommandMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -50,6 +51,7 @@ export class CommandMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/delay-macro-action.ts

@@ -28,6 +28,7 @@ export class DelayMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -51,6 +52,7 @@ export class DelayMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/key-macro-action.ts

@@ -60,6 +60,7 @@ export class KeyMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -83,6 +84,7 @@ export class KeyMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/mouse-button-macro-action.ts

@@ -42,6 +42,7 @@ export class MouseButtonMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -65,6 +66,7 @@ export class MouseButtonMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/move-mouse-macro-action.ts

@@ -31,6 +31,7 @@ export class MoveMouseMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -54,6 +55,7 @@ export class MoveMouseMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/scroll-mouse-macro-action.ts

@@ -31,6 +31,7 @@ export class ScrollMouseMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -54,6 +55,7 @@ export class ScrollMouseMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro-action/text-macro-action.ts

@@ -27,6 +27,7 @@ export class TextMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject);
                 break;
 
@@ -50,6 +51,7 @@ export class TextMacroAction extends MacroAction {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/macro.ts

@@ -40,6 +40,7 @@ export class Macro {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject, serialisationInfo);
                 break;
 
@@ -63,6 +64,7 @@ export class Macro {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer, serialisationInfo);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/module-configuration.ts

@@ -95,6 +95,7 @@ export class ModuleConfiguration {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV7(jsonObject);
                 break;
 
@@ -120,6 +121,7 @@ export class ModuleConfiguration {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV7(buffer);
                 break;
 

packages/uhk-common/src/config-serializer/config-items/module.ts

@@ -44,6 +44,7 @@ export class Module {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromJsonObjectV1(jsonObject, macros, serialisationInfo);
                 break;
 
@@ -67,6 +68,7 @@ export class Module {
             case 9:
             case 11:
             case 12:
+            case 13:
                 this.fromBinaryV1(buffer, macros, serialisationInfo);
                 break;