From 973a1b80d0ec9c37bbcf3df9b1df39d220b5042a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maxi=20Quo=C3=9F?= <maxi@quoss.org>
Date: Wed, 22 Jan 2025 13:21:07 +0100
Subject: [PATCH] feat: add device description field

---
 .../migrations/1737546920_updated_devices.go  | 45 +++++++++++++++++++
 frontend/src/lib/components/DeviceCard.svelte |  3 ++
 frontend/src/lib/components/DeviceForm.svelte | 15 +++++++
 frontend/src/lib/i18n/de/index.ts             |  2 +
 frontend/src/lib/i18n/en/index.ts             |  2 +
 frontend/src/lib/i18n/es/index.ts             |  2 +
 frontend/src/lib/i18n/fr/index.ts             |  2 +
 frontend/src/lib/i18n/i18n-svelte.ts          |  1 -
 frontend/src/lib/i18n/i18n-types.ts           | 17 +++++++
 frontend/src/lib/i18n/i18n-util.async.ts      |  2 +-
 frontend/src/lib/i18n/i18n-util.sync.ts       |  3 +-
 frontend/src/lib/i18n/i18n-util.ts            |  2 +-
 frontend/src/lib/i18n/it/index.ts             |  2 +
 frontend/src/lib/i18n/ja-JP/index.ts          |  8 ++++
 frontend/src/lib/i18n/ja/index.ts             |  2 +
 frontend/src/lib/i18n/nl/index.ts             |  2 +
 frontend/src/lib/i18n/pt/index.ts             |  2 +
 frontend/src/lib/i18n/zh-TW/index.ts          |  4 +-
 frontend/src/lib/i18n/zh/index.ts             |  2 +
 frontend/src/lib/types/device.ts              |  1 +
 frontend/src/routes/account/+page.svelte      |  1 +
 21 files changed, 115 insertions(+), 5 deletions(-)
 create mode 100644 backend/migrations/1737546920_updated_devices.go
 create mode 100644 frontend/src/lib/i18n/ja-JP/index.ts

diff --git a/backend/migrations/1737546920_updated_devices.go b/backend/migrations/1737546920_updated_devices.go
new file mode 100644
index 00000000..16ea8eb9
--- /dev/null
+++ b/backend/migrations/1737546920_updated_devices.go
@@ -0,0 +1,45 @@
+package migrations
+
+import (
+	"github.com/pocketbase/pocketbase/core"
+	m "github.com/pocketbase/pocketbase/migrations"
+)
+
+func init() {
+	m.Register(func(app core.App) error {
+		collection, err := app.FindCollectionByNameOrId("z5lghx2r3tm45n1")
+		if err != nil {
+			return err
+		}
+
+		// add field
+		if err := collection.Fields.AddMarshaledJSONAt(5, []byte(`{
+			"autogeneratePattern": "",
+			"hidden": false,
+			"id": "text1843675174",
+			"max": 0,
+			"min": 0,
+			"name": "description",
+			"pattern": "",
+			"presentable": false,
+			"primaryKey": false,
+			"required": false,
+			"system": false,
+			"type": "text"
+		}`)); err != nil {
+			return err
+		}
+
+		return app.Save(collection)
+	}, func(app core.App) error {
+		collection, err := app.FindCollectionByNameOrId("z5lghx2r3tm45n1")
+		if err != nil {
+			return err
+		}
+
+		// remove field
+		collection.Fields.RemoveById("text1843675174")
+
+		return app.Save(collection)
+	})
+}
diff --git a/frontend/src/lib/components/DeviceCard.svelte b/frontend/src/lib/components/DeviceCard.svelte
index 1ed5b6d4..fcbecb0c 100644
--- a/frontend/src/lib/components/DeviceCard.svelte
+++ b/frontend/src/lib/components/DeviceCard.svelte
@@ -157,6 +157,9 @@
 		{:else}
 			<h1 class="card-title">{device.name}</h1>
 		{/if}
+		{#if device.description}
+			<p>{device.description}</p>
+		{/if}
 		<ul class="menu rounded-box bg-base-200">
 			<!-- TODO: change to nic array once backend supports it -->
 			<DeviceCardNic {device} />
diff --git a/frontend/src/lib/components/DeviceForm.svelte b/frontend/src/lib/components/DeviceForm.svelte
index 5d533c49..9247b738 100644
--- a/frontend/src/lib/components/DeviceForm.svelte
+++ b/frontend/src/lib/components/DeviceForm.svelte
@@ -246,6 +246,21 @@
 						required
 					/>
 				</div>
+				<div class="form-control w-full max-w-xs">
+					<label class="label" for="device-description">
+						<div class="label-text">
+							<span>{$LL.device.general_description()}</span>
+						</div>
+					</label>
+					<input
+						id="device-description"
+						type="text"
+						placeholder={$LL.device.general_description_placeholder()}
+						class="input w-full max-w-xs"
+						bind:value={device.description}
+					/>
+				</div>
+
 				<span class="badge self-center text-error">* {$LL.device.general_required_field()}</span>
 			</div>
 		</div>
diff --git a/frontend/src/lib/i18n/de/index.ts b/frontend/src/lib/i18n/de/index.ts
index aec368e4..b080b94d 100644
--- a/frontend/src/lib/i18n/de/index.ts
+++ b/frontend/src/lib/i18n/de/index.ts
@@ -55,6 +55,8 @@ const de = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Netmask',
+		general_description: 'Beschreibung',
+		general_description_placeholder: 'Eine Beschreibung des Geräts',
 		general_required_field: 'Pflichtfeld',
 		ports: 'Ports',
 		ports_desc: 'UpSnap kann auch prüfen, ob bestimmte Ports offen sind.',
diff --git a/frontend/src/lib/i18n/en/index.ts b/frontend/src/lib/i18n/en/index.ts
index 9a31e72d..5e68b063 100644
--- a/frontend/src/lib/i18n/en/index.ts
+++ b/frontend/src/lib/i18n/en/index.ts
@@ -53,6 +53,8 @@ const en = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Netmask',
+		general_description: 'Description',
+		general_description_placeholder: 'Some description of the device',
 		general_required_field: 'required field',
 		ports: 'Ports',
 		ports_desc: 'UpSnap can also check if given ports are open.',
diff --git a/frontend/src/lib/i18n/es/index.ts b/frontend/src/lib/i18n/es/index.ts
index 4f710320..32a8fcac 100644
--- a/frontend/src/lib/i18n/es/index.ts
+++ b/frontend/src/lib/i18n/es/index.ts
@@ -55,6 +55,8 @@ const es = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Máscara de red',
+		general_description: 'Descripción',
+		general_description_placeholder: 'Descripción del dispositivo',
 		general_required_field: 'Campo obligatorio',
 		ports: 'Puertos',
 		ports_desc: 'UpSnap puede comprobar si ciertos puertos están abiertos.',
diff --git a/frontend/src/lib/i18n/fr/index.ts b/frontend/src/lib/i18n/fr/index.ts
index 23524cbd..e12d816c 100644
--- a/frontend/src/lib/i18n/fr/index.ts
+++ b/frontend/src/lib/i18n/fr/index.ts
@@ -56,6 +56,8 @@ const fr = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Masque réseau',
+		general_description: 'Description',
+		general_description_placeholder: "Description de l'appareil",
 		general_required_field: 'champ requis',
 		ports: 'Ports',
 		ports_desc: 'UpSnap peut aussi vérifier si certains ports sont ouverts.',
diff --git a/frontend/src/lib/i18n/i18n-svelte.ts b/frontend/src/lib/i18n/i18n-svelte.ts
index ca6733e4..f2c13c4a 100644
--- a/frontend/src/lib/i18n/i18n-svelte.ts
+++ b/frontend/src/lib/i18n/i18n-svelte.ts
@@ -1,5 +1,4 @@
 // This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
- 
 
 import { initI18nSvelte } from 'typesafe-i18n/svelte';
 import type { Formatters, Locales, TranslationFunctions, Translations } from './i18n-types';
diff --git a/frontend/src/lib/i18n/i18n-types.ts b/frontend/src/lib/i18n/i18n-types.ts
index 3a778943..2044ccbb 100644
--- a/frontend/src/lib/i18n/i18n-types.ts
+++ b/frontend/src/lib/i18n/i18n-types.ts
@@ -21,6 +21,7 @@ export type Locales =
 	| 'it'
 	| 'it-IT'
 	| 'ja'
+	| 'ja-JP'
 	| 'nl'
 	| 'nl-NL'
 	| 'pt'
@@ -233,6 +234,14 @@ type RootTranslation = {
 		 * N​e​t​m​a​s​k
 		 */
 		general_netmask: string;
+		/**
+		 * D​e​s​c​r​i​p​t​i​o​n
+		 */
+		general_description: string;
+		/**
+		 * S​o​m​e​ ​d​e​s​c​r​i​p​t​i​o​n​ ​o​f​ ​t​h​e​ ​d​e​v​i​c​e
+		 */
+		general_description_placeholder: string;
 		/**
 		 * r​e​q​u​i​r​e​d​ ​f​i​e​l​d
 		 */
@@ -1004,6 +1013,14 @@ export type TranslationFunctions = {
 		 * Netmask
 		 */
 		general_netmask: () => LocalizedString;
+		/**
+		 * Description
+		 */
+		general_description: () => LocalizedString;
+		/**
+		 * Some description of the device
+		 */
+		general_description_placeholder: () => LocalizedString;
 		/**
 		 * required field
 		 */
diff --git a/frontend/src/lib/i18n/i18n-util.async.ts b/frontend/src/lib/i18n/i18n-util.async.ts
index a1d67b0a..c60c1db0 100644
--- a/frontend/src/lib/i18n/i18n-util.async.ts
+++ b/frontend/src/lib/i18n/i18n-util.async.ts
@@ -1,5 +1,4 @@
 // This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
- 
 
 import { initFormatters } from './formatters';
 import type { Locales, Translations } from './i18n-types';
@@ -17,6 +16,7 @@ const localeTranslationLoaders = {
 	it: () => import('./it'),
 	'it-IT': () => import('./it-IT'),
 	ja: () => import('./ja'),
+	'ja-JP': () => import('./ja-JP'),
 	nl: () => import('./nl'),
 	'nl-NL': () => import('./nl-NL'),
 	pt: () => import('./pt'),
diff --git a/frontend/src/lib/i18n/i18n-util.sync.ts b/frontend/src/lib/i18n/i18n-util.sync.ts
index 6b2e6096..e28de4c6 100644
--- a/frontend/src/lib/i18n/i18n-util.sync.ts
+++ b/frontend/src/lib/i18n/i18n-util.sync.ts
@@ -1,5 +1,4 @@
 // This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
- 
 
 import { initFormatters } from './formatters';
 import type { Locales, Translations } from './i18n-types';
@@ -16,6 +15,7 @@ import fr_FR from './fr-FR';
 import it from './it';
 import it_IT from './it-IT';
 import ja from './ja';
+import ja_JP from './ja-JP';
 import nl from './nl';
 import nl_NL from './nl-NL';
 import pt from './pt';
@@ -36,6 +36,7 @@ const localeTranslations = {
 	it,
 	'it-IT': it_IT,
 	ja,
+	'ja-JP': ja_JP,
 	nl,
 	'nl-NL': nl_NL,
 	pt,
diff --git a/frontend/src/lib/i18n/i18n-util.ts b/frontend/src/lib/i18n/i18n-util.ts
index 4586b6f4..6f2397ed 100644
--- a/frontend/src/lib/i18n/i18n-util.ts
+++ b/frontend/src/lib/i18n/i18n-util.ts
@@ -1,5 +1,4 @@
 // This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
- 
 
 import {
 	i18n as initI18n,
@@ -26,6 +25,7 @@ export const locales: Locales[] = [
 	'it',
 	'it-IT',
 	'ja',
+	'ja-JP',
 	'nl',
 	'nl-NL',
 	'pt',
diff --git a/frontend/src/lib/i18n/it/index.ts b/frontend/src/lib/i18n/it/index.ts
index 6249e170..4983f841 100644
--- a/frontend/src/lib/i18n/it/index.ts
+++ b/frontend/src/lib/i18n/it/index.ts
@@ -55,6 +55,8 @@ const it = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Maschera di rete',
+		general_description: 'Descrizione',
+		general_description_placeholder: 'Descrizione del dispositivo',
 		general_required_field: 'Campo obbligatorio',
 		ports: 'Porte',
 		ports_desc: "UpSnap puo' anche controllare che le porte siano aperte.",
diff --git a/frontend/src/lib/i18n/ja-JP/index.ts b/frontend/src/lib/i18n/ja-JP/index.ts
new file mode 100644
index 00000000..85ad318b
--- /dev/null
+++ b/frontend/src/lib/i18n/ja-JP/index.ts
@@ -0,0 +1,8 @@
+import type { Translation } from '../i18n-types';
+import ja from '../ja';
+
+const ja_JP = {
+	...(ja as unknown as Translation)
+} satisfies Translation;
+
+export default ja_JP;
diff --git a/frontend/src/lib/i18n/ja/index.ts b/frontend/src/lib/i18n/ja/index.ts
index 990821fd..c31f9e9c 100644
--- a/frontend/src/lib/i18n/ja/index.ts
+++ b/frontend/src/lib/i18n/ja/index.ts
@@ -53,6 +53,8 @@ const ja = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'ネットマスク',
+		general_description: '説明',
+		general_description_placeholder: '装置の説明',
 		general_required_field: '必須項目',
 		ports: 'ポート',
 		ports_desc: 'UpSnap は指定されたポートが開いているか確認することもできます。',
diff --git a/frontend/src/lib/i18n/nl/index.ts b/frontend/src/lib/i18n/nl/index.ts
index b499c291..9fd26ad7 100644
--- a/frontend/src/lib/i18n/nl/index.ts
+++ b/frontend/src/lib/i18n/nl/index.ts
@@ -55,6 +55,8 @@ const nl = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Subnetmask',
+		general_description: 'Beschrijving',
+		general_description_placeholder: 'Enige beschrijving van het apparaat',
 		general_required_field: 'vereist veld',
 		ports: 'Poorten',
 		ports_desc: 'UpSnap kan ook controleren of gegeven poorten open zijn.',
diff --git a/frontend/src/lib/i18n/pt/index.ts b/frontend/src/lib/i18n/pt/index.ts
index 4eda8f59..3aca288b 100644
--- a/frontend/src/lib/i18n/pt/index.ts
+++ b/frontend/src/lib/i18n/pt/index.ts
@@ -55,6 +55,8 @@ const pt = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: 'Máscara de rede',
+		general_description: 'Descrição',
+		general_description_placeholder: 'Alguma descrição do dispositivo',
 		general_required_field: 'campo obrigatório',
 		ports: 'Portos',
 		ports_desc: 'UpSnap pode verificar se certos portos estão abertos.',
diff --git a/frontend/src/lib/i18n/zh-TW/index.ts b/frontend/src/lib/i18n/zh-TW/index.ts
index b83ebb9e..3c4f4bab 100644
--- a/frontend/src/lib/i18n/zh-TW/index.ts
+++ b/frontend/src/lib/i18n/zh-TW/index.ts
@@ -1,5 +1,5 @@
-import zh from '../zh';
 import type { Translation } from '../i18n-types';
+import zh from '../zh';
 
 const zh_TW = {
 	...(zh as unknown as Translation),
@@ -54,6 +54,8 @@ const zh_TW = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: '子網域遮罩',
+		general_description: '描述',
+		general_description_placeholder: '關於這个裝置的描述',
 		general_required_field: '必填',
 		ports: '埠',
 		ports_desc: 'UpSnap 可以檢查指定的埠是否開啟',
diff --git a/frontend/src/lib/i18n/zh/index.ts b/frontend/src/lib/i18n/zh/index.ts
index 2a6c14ed..cf78f6f3 100644
--- a/frontend/src/lib/i18n/zh/index.ts
+++ b/frontend/src/lib/i18n/zh/index.ts
@@ -52,6 +52,8 @@ const zh = {
 		general_ip: 'IP',
 		general_mac: 'Mac',
 		general_netmask: '子网掩码',
+		general_description: '说明',
+		general_description_placeholder: '设备的一些说明',
 		general_required_field: '必填字段',
 		ports: '端口',
 		ports_desc: 'UpSnap 可以检查设备端口是否正常.',
diff --git a/frontend/src/lib/types/device.ts b/frontend/src/lib/types/device.ts
index 6dc8fdd9..c60abfa2 100644
--- a/frontend/src/lib/types/device.ts
+++ b/frontend/src/lib/types/device.ts
@@ -5,6 +5,7 @@ export type Device = RecordModel & {
 	ip: string;
 	mac: string;
 	netmask: string;
+	description: string;
 	status: 'pending' | 'online' | 'offline' | '';
 	ports: string[];
 	link: URL;
diff --git a/frontend/src/routes/account/+page.svelte b/frontend/src/routes/account/+page.svelte
index 00d4f19c..2034047e 100644
--- a/frontend/src/routes/account/+page.svelte
+++ b/frontend/src/routes/account/+page.svelte
@@ -24,6 +24,7 @@
 		it: '🇮🇹',
 		'it-IT': '🇮🇹',
 		ja: '🇯🇵',
+		'ja-JP': '🇯🇵',
 		nl: '🇳🇱',
 		'nl-NL': '🇳🇱',
 		pt: '🇵🇹',