MaritalStatus as new IdentityAttribute (#887)

* refactor: remove unnecessary comment

* feat: add MaritalStatus IdentityAttribute value type

* feat: make MaritalStatus useable

* chore: build Schema.ts

* test: add DVO tests for MaritalStatus

* feat: add civil partnership statuses

* feat: add source for marital status in Germany

Author: britsta

packages/content/src/attributes/AttributeValueTypes.ts

@@ -48,6 +48,7 @@ import {
     IHonorificSuffix,
     IIdentityFileReference,
     IJobTitle,
+    IMaritalStatus,
     IMiddleName,
     INationality,
     IPhoneNumber,
@@ -73,6 +74,8 @@ import {
     IWebsite,
     JobTitle,
     JobTitleJSON,
+    MaritalStatus,
+    MaritalStatusJSON,
     MiddleName,
     MiddleNameJSON,
     Nationality,
@@ -143,6 +146,7 @@ export namespace AttributeValues {
                 | HonorificSuffixJSON
                 | IdentityFileReferenceJSON
                 | JobTitleJSON
+                | MaritalStatusJSON
                 | MiddleNameJSON
                 | NationalityJSON
                 | PhoneNumberJSON
@@ -170,6 +174,7 @@ export namespace AttributeValues {
                 | IHonorificSuffix
                 | IIdentityFileReference
                 | IJobTitle
+                | IMaritalStatus
                 | IMiddleName
                 | INationality
                 | IPhoneNumber
@@ -197,6 +202,7 @@ export namespace AttributeValues {
                 | HonorificSuffix
                 | IdentityFileReference
                 | JobTitle
+                | MaritalStatus
                 | MiddleName
                 | Nationality
                 | PhoneNumber
@@ -224,6 +230,7 @@ export namespace AttributeValues {
                 HonorificSuffix,
                 IdentityFileReference,
                 JobTitle,
+                MaritalStatus,
                 MiddleName,
                 Nationality,
                 PhoneNumber,
@@ -253,6 +260,7 @@ export namespace AttributeValues {
                 "IdentityFileReference",
                 "JobTitle",
                 "Nationality",
+                "MaritalStatus",
                 "MiddleName",
                 "PhoneNumber",
                 "PostOfficeBoxAddress",

packages/content/src/attributes/types/person/MaritalStatus.ts

@@ -0,0 +1,52 @@
+import { serialize, type, validate } from "@js-soft/ts-serval";
+import { RenderHints, RenderHintsEditType, ValueHints, ValueHintsValue } from "../../../attributes/hints";
+import { AbstractString, AbstractStringJSON, IAbstractString } from "../AbstractString";
+
+/**
+ * Particularly reflects marital status in Germany according to https://www.destatis.de/DE/Themen/Gesellschaft-Umwelt/Bevoelkerung/Haushalte-Familien/Glossar/familienstand.html
+ */
+export enum MaritalStatusValue {
+    Single = "single",
+    Married = "married",
+    Separated = "separated",
+    Divorced = "divorced",
+    Widowed = "widowed",
+    CivilPartnership = "civilPartnership",
+    CivilPartnershipDissolved = "civilPartnershipDissolved",
+    CivilPartnerDeceased = "civilPartnerDeceased"
+}
+
+export interface MaritalStatusJSON extends AbstractStringJSON {
+    "@type": "MaritalStatus";
+}
+
+export interface IMaritalStatus extends IAbstractString {}
+
+@type("MaritalStatus")
+export class MaritalStatus extends AbstractString {
+    @serialize()
+    @validate({
+        customValidator: (v) => (!Object.values(MaritalStatusValue).includes(v) ? `must be one of: ${Object.values(MaritalStatusValue)}` : undefined)
+    })
+    public override value: MaritalStatusValue;
+
+    public static override get valueHints(): ValueHints {
+        return super.valueHints.copyWith({
+            values: Object.values(MaritalStatusValue).map((value) => ValueHintsValue.from({ key: value, displayName: `i18n://attributes.values.maritalStatus.${value}` }))
+        });
+    }
+
+    public static override get renderHints(): RenderHints {
+        return super.renderHints.copyWith({
+            editType: RenderHintsEditType.ButtonLike
+        });
+    }
+
+    public static from(value: IMaritalStatus | Omit<MaritalStatusJSON, "@type"> | string): MaritalStatus {
+        return this.fromAny(value);
+    }
+
+    public override toJSON(verbose?: boolean | undefined, serializeAsString?: boolean | undefined): MaritalStatusJSON {
+        return super.toJSON(verbose, serializeAsString) as MaritalStatusJSON;
+    }
+}

packages/content/src/attributes/types/person/Sex.ts

@@ -2,9 +2,6 @@ import { serialize, type, validate } from "@js-soft/ts-serval";
 import { RenderHints, RenderHintsEditType, ValueHints, ValueHintsValue } from "../../../attributes/hints";
 import { AbstractString, AbstractStringJSON, IAbstractString } from "../AbstractString";
 
-/**
- * Biologisches Geschlecht
- */
 export enum BiologicalSex {
     X = "intersex",
     F = "female",

packages/content/src/attributes/types/person/index.ts

@@ -1,4 +1,5 @@
 export * from "./Citizenship";
 export * from "./JobTitle";
+export * from "./MaritalStatus";
 export * from "./Nationality";
 export * from "./Sex";