Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Add static typed FieldTypeKind to importers (#2163)

Leendert de Borst6783bce4dd25
diff --git a/apps/server/Databases/AliasClientDb/Models/FieldTypeKind.cs b/apps/server/Databases/AliasClientDb/Models/FieldTypeKind.cs
new file mode 100644
index 000000000..cfcef5eb1
--- /dev/null
+++ b/apps/server/Databases/AliasClientDb/Models/FieldTypeKind.cs
@@ -0,0 +1,105 @@
+// <auto-generated />
+// This file is auto-generated from core/models/src/vault/Item.ts
+// Do not edit this file directly. Run 'npm run generate:models' to regenerate.
+
+#nullable enable
+
+namespace AliasClientDb.Models;
+
+/// <summary>
+/// Strongly-typed field types. Mirrors the string constants in <see cref="FieldType"/> so that
+/// callers (e.g. importers) are forced to pick a known field type at compile time. Convert to and
+/// from the canonical <see cref="FieldType"/> strings with <see cref="FieldTypeKindExtensions"/>.
+/// </summary>
+public enum FieldTypeKind
+{
+ /// <summary>
+ /// Text field type.
+ /// </summary>
+ Text,
+
+ /// <summary>
+ /// Password field type.
+ /// </summary>
+ Password,
+
+ /// <summary>
+ /// Hidden field type.
+ /// </summary>
+ Hidden,
+
+ /// <summary>
+ /// Email field type.
+ /// </summary>
+ Email,
+
+ /// <summary>
+ /// URL field type.
+ /// </summary>
+ URL,
+
+ /// <summary>
+ /// Date field type.
+ /// </summary>
+ Date,
+
+ /// <summary>
+ /// Number field type.
+ /// </summary>
+ Number,
+
+ /// <summary>
+ /// Phone field type.
+ /// </summary>
+ Phone,
+
+ /// <summary>
+ /// TextArea field type.
+ /// </summary>
+ TextArea,
+}
+
+/// <summary>
+/// Conversion helpers between <see cref="FieldTypeKind"/> and the canonical <see cref="FieldType"/> strings.
+/// </summary>
+public static class FieldTypeKindExtensions
+{
+ /// <summary>
+ /// Converts a <see cref="FieldTypeKind"/> to its canonical <see cref="FieldType"/> string.
+ /// </summary>
+ /// <param name="kind">The field type kind.</param>
+ /// <returns>The canonical field type string.</returns>
+ public static string ToFieldTypeString(this FieldTypeKind kind) => kind switch
+ {
+ FieldTypeKind.Text => FieldType.Text,
+ FieldTypeKind.Password => FieldType.Password,
+ FieldTypeKind.Hidden => FieldType.Hidden,
+ FieldTypeKind.Email => FieldType.Email,
+ FieldTypeKind.URL => FieldType.URL,
+ FieldTypeKind.Date => FieldType.Date,
+ FieldTypeKind.Number => FieldType.Number,
+ FieldTypeKind.Phone => FieldType.Phone,
+ FieldTypeKind.TextArea => FieldType.TextArea,
+ _ => FieldType.Text,
+ };
+
+ /// <summary>
+ /// Converts a canonical <see cref="FieldType"/> string to a <see cref="FieldTypeKind"/>.
+ /// Unknown or null values fall back to <see cref="FieldTypeKind.Text"/>.
+ /// </summary>
+ /// <param name="value">The canonical field type string.</param>
+ /// <returns>The matching field type kind.</returns>
+ public static FieldTypeKind ToFieldTypeKind(string? value) => value switch
+ {
+ FieldType.Text => FieldTypeKind.Text,
+ FieldType.Password => FieldTypeKind.Password,
+ FieldType.Hidden => FieldTypeKind.Hidden,
+ FieldType.Email => FieldTypeKind.Email,
+ FieldType.URL => FieldTypeKind.URL,
+ FieldType.Date => FieldTypeKind.Date,
+ FieldType.Number => FieldTypeKind.Number,
+ FieldType.Phone => FieldTypeKind.Phone,
+ FieldType.TextArea => FieldTypeKind.TextArea,
+ _ => FieldTypeKind.Text,
+ };
+}
diff --git a/apps/server/Tests/AliasVault.UnitTests/Utilities/ImportExportTests.cs b/apps/server/Tests/AliasVault.UnitTests/Utilities/ImportExportTests.cs
index 88e4eb459..d0166b441 100644
--- a/apps/server/Tests/AliasVault.UnitTests/Utilities/ImportExportTests.cs
+++ b/apps/server/Tests/AliasVault.UnitTests/Utilities/ImportExportTests.cs
@@ -1938,7 +1938,7 @@ public class ImportExportTests
Assert.Multiple(() =>
{
Assert.That(textField.Value, Is.EqualTo("My first pet"));
- Assert.That(textField.FieldType, Is.EqualTo("Text"));
+ Assert.That(textField.FieldType, Is.EqualTo(FieldTypeKind.Text));
Assert.That(textField.IsHidden, Is.False);
Assert.That(textField.Weight, Is.EqualTo(3));
});
@@ -1947,7 +1947,7 @@ public class ImportExportTests
Assert.Multiple(() =>
{
Assert.That(hiddenField.Value, Is.EqualTo("super-secret-recovery"));
- Assert.That(hiddenField.FieldType, Is.EqualTo("Password"));
+ Assert.That(hiddenField.FieldType, Is.EqualTo(FieldTypeKind.Password));
Assert.That(hiddenField.IsHidden, Is.True);
Assert.That(hiddenField.Weight, Is.EqualTo(5));
});
@@ -2225,15 +2225,15 @@ public class ImportExportTests
var securityQuestion = loginItem.CustomFieldValues!.First(f => f.Label == "Security Question");
Assert.That(securityQuestion.Value, Is.EqualTo("My first pet")); // Type 0: Text
- Assert.That(securityQuestion.FieldType, Is.EqualTo("Text"));
+ Assert.That(securityQuestion.FieldType, Is.EqualTo(FieldTypeKind.Text));
var apiKey = loginItem.CustomFieldValues!.First(f => f.Label == "API Key");
Assert.That(apiKey.Value, Is.EqualTo("sk_test_123456789")); // Type 1: Hidden
- Assert.That(apiKey.FieldType, Is.EqualTo("Hidden"));
+ Assert.That(apiKey.FieldType, Is.EqualTo(FieldTypeKind.Hidden));
var twoFactorEnabled = loginItem.CustomFieldValues!.First(f => f.Label == "Two Factor Enabled");
Assert.That(twoFactorEnabled.Value, Is.EqualTo("true")); // Type 2: Boolean
- Assert.That(twoFactorEnabled.FieldType, Is.EqualTo("Text"));
+ Assert.That(twoFactorEnabled.FieldType, Is.EqualTo(FieldTypeKind.Text));
// Notes should remain unchanged (linked fields are skipped, not added to notes)
Assert.That(loginItem.Notes, Is.EqualTo("This is a test login item"));
diff --git a/apps/server/Utilities/AliasVault.ImportExport/Importers/BaseImporter.cs b/apps/server/Utilities/AliasVault.ImportExport/Importers/BaseImporter.cs
index 14bb7d117..40bc6c419 100644
--- a/apps/server/Utilities/AliasVault.ImportExport/Importers/BaseImporter.cs
+++ b/apps/server/Utilities/AliasVault.ImportExport/Importers/BaseImporter.cs
@@ -167,24 +167,22 @@ public static class BaseImporter
/// <param name="credential">The credential to add the custom field to.</param>
/// <param name="label">The field label (display name).</param>
/// <param name="value">The field value.</param>
- /// <param name="fieldType">The field type.</param>
- public static void AddCustomField(ImportedCredential credential, string? label, string? value, string fieldType = FieldType.Text)
+ /// <param name="fieldType">The field type. Defaults to <see cref="FieldTypeKind.Text"/>.</param>
+ public static void AddCustomField(ImportedCredential credential, string? label, string? value, FieldTypeKind fieldType = FieldTypeKind.Text)
{
if (string.IsNullOrWhiteSpace(label) || string.IsNullOrWhiteSpace(value))
{
return;
}
- var resolvedType = string.IsNullOrWhiteSpace(fieldType) ? FieldType.Text : fieldType;
-
credential.CustomFieldValues ??= new List<ImportedCustomField>();
credential.CustomFieldValues.Add(new ImportedCustomField
{
DefinitionId = Guid.NewGuid(),
Label = label,
Value = value,
- FieldType = resolvedType,
- IsHidden = resolvedType is FieldType.Hidden or FieldType.Password,
+ FieldType = fieldType,
+ IsHidden = fieldType is FieldTypeKind.Hidden or FieldTypeKind.Password,
});
}
@@ -337,7 +335,7 @@ public static class BaseImporter
{
Id = Guid.NewGuid(),
Label = customField.Label,
- FieldType = string.IsNullOrWhiteSpace(customField.FieldType) ? FieldType.Text : customField.FieldType,
+ FieldType = customField.FieldType.ToFieldTypeString(),
IsMultiValue = customField.IsMultiValue,
IsHidden = customField.IsHidden,
EnableHistory = customField.EnableHistory,
diff --git a/apps/server/Utilities/AliasVault.ImportExport/Importers/BitwardenZipImporter.cs b/apps/server/Utilities/AliasVault.ImportExport/Importers/BitwardenZipImporter.cs
index 274b6255b..2c96759f2 100644
--- a/apps/server/Utilities/AliasVault.ImportExport/Importers/BitwardenZipImporter.cs
+++ b/apps/server/Utilities/AliasVault.ImportExport/Importers/BitwardenZipImporter.cs
@@ -257,7 +257,7 @@ public class BitwardenZipImporter : BaseArchiveImporter
credential,
field.Name,
field.Value,
- field.Type == 1 ? FieldType.Hidden : FieldType.Text);
+ field.Type == 1 ? FieldTypeKind.Hidden : FieldTypeKind.Text);
}
}
}
diff --git a/apps/server/Utilities/AliasVault.ImportExport/Importers/OnePassword1puxImporter.cs b/apps/server/Utilities/AliasVault.ImportExport/Importers/OnePassword1puxImporter.cs
index e2483a5c6..4b794f21a 100644
--- a/apps/server/Utilities/AliasVault.ImportExport/Importers/OnePassword1puxImporter.cs
+++ b/apps/server/Utilities/AliasVault.ImportExport/Importers/OnePassword1puxImporter.cs
@@ -326,18 +326,15 @@ public class OnePassword1puxImporter : BaseArchiveImporter
ExtractCreditCardField(credential, field);
}
- // Add other fields as custom fields. A concealed value (no plain string content)
- // indicates a hidden field; everything else defaults to a plain text field.
- var fieldValue = GetFieldValueAsString(field.Value);
- if (!string.IsNullOrWhiteSpace(fieldValue))
+ // Add other fields as custom fields.
+ var resolved = ResolveFieldValue(field.Value);
+ if (!string.IsNullOrWhiteSpace(resolved.Value))
{
- var isConcealed = string.IsNullOrWhiteSpace(field.Value.String)
- && !string.IsNullOrWhiteSpace(field.Value.Concealed);
BaseImporter.AddCustomField(
credential,
field.Title,
- fieldValue,
- isConcealed ? FieldType.Hidden : FieldType.Text);
+ resolved.Value,
+ resolved.FieldType);
}
}
}
@@ -462,63 +459,75 @@ public class OnePassword1puxImporter : BaseArchiveImporter
}
/// <summary>
- /// Gets a field value as a string.
+ /// Resolves a 1Password field value to both its string value representation and the matching field type.
/// </summary>
/// <param name="fieldValue">The field value object.</param>
- /// <returns>The value as a string, or null if empty.</returns>
- private static string? GetFieldValueAsString(OnePasswordFieldValue fieldValue)
+ /// <returns>The resolved value and its AliasVault field type. The value is null when empty.</returns>
+ private static ResolvedFieldValue ResolveFieldValue(OnePasswordFieldValue fieldValue)
{
if (!string.IsNullOrWhiteSpace(fieldValue.String))
{
- return fieldValue.String;
+ return new ResolvedFieldValue(fieldValue.String, FieldTypeKind.Text);
}
if (!string.IsNullOrWhiteSpace(fieldValue.Concealed))
{
- return fieldValue.Concealed;
+ return new ResolvedFieldValue(fieldValue.Concealed, FieldTypeKind.Hidden);
}
if (!string.IsNullOrWhiteSpace(fieldValue.Url))
{
- return fieldValue.Url;
+ return new ResolvedFieldValue(fieldValue.Url, FieldTypeKind.URL);
}
if (!string.IsNullOrWhiteSpace(fieldValue.CreditCardNumber))
{
- return fieldValue.CreditCardNumber;
+ return new ResolvedFieldValue(fieldValue.CreditCardNumber, FieldTypeKind.Text);
}
if (!string.IsNullOrWhiteSpace(fieldValue.Menu))
{
- return fieldValue.Menu;
+ return new ResolvedFieldValue(fieldValue.Menu, FieldTypeKind.Text);
}
if (!string.IsNullOrWhiteSpace(fieldValue.Phone))
{
- return fieldValue.Phone;
+ return new ResolvedFieldValue(fieldValue.Phone, FieldTypeKind.Phone);
}
if (fieldValue.Email?.EmailAddress != null)
{
- return fieldValue.Email.EmailAddress;
+ return new ResolvedFieldValue(fieldValue.Email.EmailAddress, FieldTypeKind.Email);
}
if (fieldValue.Address != null)
{
- return FormatAddress(fieldValue.Address);
+ return new ResolvedFieldValue(FormatAddress(fieldValue.Address), FieldTypeKind.Text);
}
if (fieldValue.Date.HasValue)
{
- return BaseImporter.FormatUnixTimestampAsDate(fieldValue.Date.Value);
+ // FormatUnixTimestampAsDate emits an ISO yyyy-MM-dd string, which the Date field renders as-is.
+ return new ResolvedFieldValue(BaseImporter.FormatUnixTimestampAsDate(fieldValue.Date.Value), FieldTypeKind.Date);
}
if (fieldValue.MonthYear.HasValue)
{
- return BaseImporter.FormatMonthYear(fieldValue.MonthYear.Value);
+ // MonthYear is only a yyyy-MM partial date, so keep it as plain text rather than a Date field.
+ return new ResolvedFieldValue(BaseImporter.FormatMonthYear(fieldValue.MonthYear.Value), FieldTypeKind.Text);
}
- return null;
+ return new ResolvedFieldValue(null, FieldTypeKind.Text);
+ }
+
+ /// <summary>
+ /// Gets a field value as a string.
+ /// </summary>
+ /// <param name="fieldValue">The field value object.</param>
+ /// <returns>The value as a string, or null if empty.</returns>
+ private static string? GetFieldValueAsString(OnePasswordFieldValue fieldValue)
+ {
+ return ResolveFieldValue(fieldValue).Value;
}
/// <summary>
@@ -636,4 +645,11 @@ public class OnePassword1puxImporter : BaseArchiveImporter
Blob = fileData,
});
}
+
+ /// <summary>
+ /// A 1Password field value resolved to its string value representation and matching field type.
+ /// </summary>
+ /// <param name="Value">The value as a string, or null when the field is empty.</param>
+ /// <param name="FieldType">The field type the value maps to.</param>
+ private readonly record struct ResolvedFieldValue(string? Value, FieldTypeKind FieldType);
}
diff --git a/apps/server/Utilities/AliasVault.ImportExport/Importers/ProtonPassZipImporter.cs b/apps/server/Utilities/AliasVault.ImportExport/Importers/ProtonPassZipImporter.cs
index 7ee643a26..dbf413b13 100644
--- a/apps/server/Utilities/AliasVault.ImportExport/Importers/ProtonPassZipImporter.cs
+++ b/apps/server/Utilities/AliasVault.ImportExport/Importers/ProtonPassZipImporter.cs
@@ -418,7 +418,7 @@ public class ProtonPassZipImporter : BaseArchiveImporter
credential,
field.FieldName,
value,
- type == "hidden" ? FieldType.Hidden : FieldType.Text);
+ type == "hidden" ? FieldTypeKind.Hidden : FieldTypeKind.Text);
}
}
diff --git a/apps/server/Utilities/AliasVault.ImportExport/Models/ImportedCustomField.cs b/apps/server/Utilities/AliasVault.ImportExport/Models/ImportedCustomField.cs
index a1a5056f1..857c1ce3a 100644
--- a/apps/server/Utilities/AliasVault.ImportExport/Models/ImportedCustomField.cs
+++ b/apps/server/Utilities/AliasVault.ImportExport/Models/ImportedCustomField.cs
@@ -31,12 +31,9 @@ public class ImportedCustomField
public string? Value { get; set; }
/// <summary>
- /// Gets or sets the field type. Use the canonical constants from
- /// <see cref="AliasClientDb.Models.FieldType"/> (Text, Password, Hidden, Email, URL, Date, etc.)
- /// rather than raw strings, so a renamed/removed field type breaks compilation at the call site.
- /// Stored as a string to match the vault data model and the .avux export format.
+ /// Gets or sets the field type.
/// </summary>
- public string FieldType { get; set; } = AliasClientDb.Models.FieldType.Text;
+ public AliasClientDb.Models.FieldTypeKind FieldType { get; set; } = AliasClientDb.Models.FieldTypeKind.Text;
/// <summary>
/// Gets or sets a value indicating whether this field supports multiple values.
diff --git a/apps/server/Utilities/AliasVault.ImportExport/VaultImportService.cs b/apps/server/Utilities/AliasVault.ImportExport/VaultImportService.cs
index 9af8905b9..5fd1f25b9 100644
--- a/apps/server/Utilities/AliasVault.ImportExport/VaultImportService.cs
+++ b/apps/server/Utilities/AliasVault.ImportExport/VaultImportService.cs
@@ -254,7 +254,7 @@ public static class VaultImportService
DefinitionId = definition.Id,
Label = definition.Label,
Value = fieldValue.Value,
- FieldType = definition.FieldType,
+ FieldType = AliasClientDb.Models.FieldTypeKindExtensions.ToFieldTypeKind(definition.FieldType),
IsMultiValue = definition.IsMultiValue,
IsHidden = definition.IsHidden,
EnableHistory = definition.EnableHistory,
diff --git a/core/models/scripts/generate-field-keys.cjs b/core/models/scripts/generate-field-keys.cjs
index 816194ab9..3cec0bfe4 100755
--- a/core/models/scripts/generate-field-keys.cjs
+++ b/core/models/scripts/generate-field-keys.cjs
@@ -15,6 +15,7 @@ const TS_REGISTRY_SOURCE = path.join(REPO_ROOT, 'core/models/src/vault/SystemFie
const TS_ICONS_SOURCE = path.join(REPO_ROOT, 'core/models/src/icons/ItemTypeIcons.ts');
const CS_OUTPUT = path.join(REPO_ROOT, 'apps/server/Databases/AliasClientDb/Models/FieldKey.cs');
const CS_FIELD_TYPE_OUTPUT = path.join(REPO_ROOT, 'apps/server/Databases/AliasClientDb/Models/FieldType.cs');
+const CS_FIELD_TYPE_ENUM_OUTPUT = path.join(REPO_ROOT, 'apps/server/Databases/AliasClientDb/Models/FieldTypeKind.cs');
const CS_ITEM_TYPE_OUTPUT = path.join(REPO_ROOT, 'apps/server/Databases/AliasClientDb/Models/ItemType.cs');
const CS_REGISTRY_OUTPUT = path.join(REPO_ROOT, 'apps/server/Databases/AliasClientDb/Models/SystemFieldRegistry.cs');
const CS_ICONS_OUTPUT = path.join(REPO_ROOT, 'apps/server/Databases/AliasClientDb/Models/ItemTypeIcons.cs');
@@ -399,6 +400,74 @@ public static class FieldType
return header + '\n' + fields + allTypes + footer;
}
+/**
+ * Generate C# enum (FieldTypeKind) + string converters for FieldType.
+ * The enum gives callers a closed, compile-time-checked set of field types (the string
+ * constants in FieldType cannot serve as a parameter type). The converters map each enum
+ * member to its FieldType constant, so a removed/renamed field type breaks compilation here.
+ */
+function generateCSharpFieldTypeEnum(fieldTypes) {
+ const header = `// <auto-generated />
+// This file is auto-generated from core/models/src/vault/Item.ts
+// Do not edit this file directly. Run 'npm run generate:models' to regenerate.
+
+#nullable enable
+
+namespace AliasClientDb.Models;
+
+/// <summary>
+/// Strongly-typed field types. Mirrors the string constants in <see cref="FieldType"/> so that
+/// callers (e.g. importers) are forced to pick a known field type at compile time. Convert to and
+/// from the canonical <see cref="FieldType"/> strings with <see cref="FieldTypeKindExtensions"/>.
+/// </summary>
+public enum FieldTypeKind
+{`;
+
+ const members = fieldTypes
+ .map(type => {
+ return ` /// <summary>
+ /// ${type} field type.
+ /// </summary>
+ ${type},`;
+ })
+ .join('\n\n');
+
+ const enumFooter = `
+}
+
+/// <summary>
+/// Conversion helpers between <see cref="FieldTypeKind"/> and the canonical <see cref="FieldType"/> strings.
+/// </summary>
+public static class FieldTypeKindExtensions
+{
+ /// <summary>
+ /// Converts a <see cref="FieldTypeKind"/> to its canonical <see cref="FieldType"/> string.
+ /// </summary>
+ /// <param name="kind">The field type kind.</param>
+ /// <returns>The canonical field type string.</returns>
+ public static string ToFieldTypeString(this FieldTypeKind kind) => kind switch
+ {
+${fieldTypes.map(t => ` FieldTypeKind.${t} => FieldType.${t},`).join('\n')}
+ _ => FieldType.${fieldTypes[0]},
+ };
+
+ /// <summary>
+ /// Converts a canonical <see cref="FieldType"/> string to a <see cref="FieldTypeKind"/>.
+ /// Unknown or null values fall back to <see cref="FieldTypeKind.${fieldTypes[0]}"/>.
+ /// </summary>
+ /// <param name="value">The canonical field type string.</param>
+ /// <returns>The matching field type kind.</returns>
+ public static FieldTypeKind ToFieldTypeKind(string? value) => value switch
+ {
+${fieldTypes.map(t => ` FieldType.${t} => FieldTypeKind.${t},`).join('\n')}
+ _ => FieldTypeKind.${fieldTypes[0]},
+ };
+}
+`;
+
+ return header + '\n' + members + enumFooter;
+}
+
/**
* Generate C# static class for ItemType
*/
@@ -1342,6 +1411,12 @@ function main() {
fs.writeFileSync(CS_FIELD_TYPE_OUTPUT, csFieldTypeContent, 'utf8');
console.log(`Generated: ${CS_FIELD_TYPE_OUTPUT}`);
+ // Generate C# FieldTypeKind enum (+ string converters)
+ ensureDir(CS_FIELD_TYPE_ENUM_OUTPUT);
+ const csFieldTypeEnumContent = generateCSharpFieldTypeEnum(fieldTypes);
+ fs.writeFileSync(CS_FIELD_TYPE_ENUM_OUTPUT, csFieldTypeEnumContent, 'utf8');
+ console.log(`Generated: ${CS_FIELD_TYPE_ENUM_OUTPUT}`);
+
// Generate C# ItemType
ensureDir(CS_ITEM_TYPE_OUTPUT);
const csItemTypeContent = generateCSharpItemType(itemTypes);