Update ThirdPartyRelationshipAttribute nomenclature (#304)

* feat: remove ThirdPartyOwnedRelationship and add ThirdPartyRelationshipAttribute to LocalAttribute

* feat: replace ThirdPartyOwnedRA deletion by ThirdPartyRA deletion

* feat: replace third party owned succession by ThirdPartyRA succession

* feat: adjust tests

* refactor: use wording emitted instead of own shared

* fix: rebasing

* feat: clean up PR

* feat: re-add deprecated ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItem for backwards-campatibility

* feat: re-add runtime ThirdPartyOwnedRelationshipAttributeDeletedByPeerEvent for backwards-compatibility

* feat: simplify deprecation of ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItem

* feat: re-add deprecated deleteThirdPartyOwnedRelationshipAttributeAndNotifyPeer for backwards-compatibility

* feat: integrate comments

* refactor: ThirdPartyRelationshipAttributeDeletedByPeerNotificationItem test

---------

Co-authored-by: Julian König <33655937+jkoenig134@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

packages/consumption/src/consumption/ConsumptionController.ts

@@ -11,7 +11,7 @@ import {
     ReadAttributeRequestItem,
     RegisterAttributeListenerRequestItem,
     ShareAttributeRequestItem,
-    ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItem
+    ThirdPartyRelationshipAttributeDeletedByPeerNotificationItem
 } from "@nmshd/content";
 import { CoreAddress, CoreId } from "@nmshd/core-types";
 import { AccountController, Transport } from "@nmshd/transport";
@@ -41,7 +41,7 @@ import {
     RequestItemProcessorRegistry,
     SettingsController,
     ShareAttributeRequestItemProcessor,
-    ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItemProcessor
+    ThirdPartyRelationshipAttributeDeletedByPeerNotificationItemProcessor
 } from "../modules";
 import { ConsumptionConfig } from "./ConsumptionConfig";
 
@@ -168,7 +168,7 @@ export class ConsumptionController {
             [PeerSharedAttributeSucceededNotificationItem, PeerSharedAttributeSucceededNotificationItemProcessor],
             [OwnSharedAttributeDeletedByOwnerNotificationItem, OwnSharedAttributeDeletedByOwnerNotificationItemProcessor],
             [PeerSharedAttributeDeletedByPeerNotificationItem, PeerSharedAttributeDeletedByPeerNotificationItemProcessor],
-            [ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItem, ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItemProcessor]
+            [ThirdPartyRelationshipAttributeDeletedByPeerNotificationItem, ThirdPartyRelationshipAttributeDeletedByPeerNotificationItemProcessor]
         ]);
     }
 

packages/consumption/src/consumption/ConsumptionCoreErrors.ts

@@ -92,8 +92,8 @@ class Attributes {
         return new CoreError("error.consumption.attributes.predecessorIsNotPeerSharedRelationshipAttribute", "Predecessor is not a peer shared RelationshipAttribute.");
     }
 
-    public predecessorIsNotThirdPartyOwnedRelationshipAttribute() {
-        return new CoreError("error.consumption.attributes.predecessorIsNotThirdPartyOwnedRelationshipAttribute", "Predecessor is not a third party owned RelationshipAttribute.");
+    public predecessorIsNotThirdPartyRelationshipAttribute() {
+        return new CoreError("error.consumption.attributes.predecessorIsNotThirdPartyRelationshipAttribute", "Predecessor is not a ThirdPartyRelationshipAttribute.");
     }
 
     public successorIsNotRepositoryAttribute() {
@@ -116,8 +116,8 @@ class Attributes {
         return new CoreError("error.consumption.attributes.successorIsNotPeerSharedRelationshipAttribute", "Successor is not a peer shared RelationshipAttribute.");
     }
 
-    public successorIsNotThirdPartyOwnedRelationshipAttribute() {
-        return new CoreError("error.consumption.attributes.successorIsNotThirdPartyOwnedRelationshipAttribute", "Successor is not a third party owned RelationshipAttribute.");
+    public successorIsNotThirdPartyRelationshipAttribute() {
+        return new CoreError("error.consumption.attributes.successorIsNotThirdPartyRelationshipAttribute", "Successor is not a ThirdPartyRelationshipAttribute.");
     }
 
     public setPredecessorIdDoesNotMatchActualPredecessorId() {
@@ -170,6 +170,12 @@ class Attributes {
         return new CoreError("error.consumption.attributes.successionMustNotChangePeer", errorMessage);
     }
 
+    public successionMustNotChangeThirdParty(comment?: string) {
+        let errorMessage = "The thirdPartyAddress of the shared Attribute must not change.";
+        if (comment) errorMessage += ` ${comment}`;
+        return new CoreError("error.consumption.attributes.successionMustNotChangeThirdParty", errorMessage);
+    }
+
     public cannotSucceedAttributesWithASuccessor(successorId: string | CoreId) {
         return new CoreError(
             "error.consumption.attributes.cannotSucceedAttributesWithASuccessor",
@@ -209,10 +215,10 @@ class Attributes {
         );
     }
 
-    public invalidDeletionInfoOfThirdPartyOwnedRelationshipAttribute() {
+    public invalidDeletionInfoOfThirdPartyRelationshipAttribute() {
         return new CoreError(
-            "error.consumption.attributes.invalidDeletionInfoOfThirdPartyOwnedRelationshipAttribute",
-            "The only valid deletionStatus for third party owned RelationshipAttributes is 'DeletedByPeer'."
+            "error.consumption.attributes.invalidDeletionInfoOfThirdPartyRelationshipAttribute",
+            "The only valid deletionStatus for ThirdPartyRelationshipAttributes is 'DeletedByPeer'."
         );
     }
 
@@ -239,11 +245,8 @@ class Attributes {
         return new CoreError("error.consumption.attributes.isNotPeerSharedAttribute", `The Attribute (id: '${attributeId}') is not a peer shared Attribute.`);
     }
 
-    public isNotThirdPartyOwnedRelationshipAttribute(attributeId: string | CoreId) {
-        return new CoreError(
-            "error.consumption.attributes.isNotThirdPartyOwnedRelationshipAttribute",
-            `The Attribute (id: '${attributeId}') is not a third party owned RelationshipAttribute.`
-        );
+    public isNotThirdPartyRelationshipAttribute(attributeId: string | CoreId) {
+        return new CoreError("error.consumption.attributes.isNotThirdPartyRelationshipAttribute", `The Attribute (id: '${attributeId}') is not a ThirdPartyRelationshipAttribute.`);
     }
 
     public senderIsNotPeerOfSharedAttribute(senderId: string | CoreAddress, attributeId: string | CoreId) {

packages/consumption/src/modules/attributes/AttributesController.ts

@@ -32,7 +32,7 @@ import {
     OwnSharedAttributeSucceededEvent,
     RepositoryAttributeSucceededEvent,
     SharedAttributeCopyCreatedEvent,
-    ThirdPartyOwnedRelationshipAttributeSucceededEvent
+    ThirdPartyRelationshipAttributeSucceededEvent
 } from "./events";
 import { AttributeSuccessorParams, AttributeSuccessorParamsJSON, IAttributeSuccessorParams } from "./local/AttributeSuccessorParams";
 import { CreateRepositoryAttributeParams, ICreateRepositoryAttributeParams } from "./local/CreateRepositoryAttributeParams";
@@ -535,15 +535,15 @@ export class AttributesController extends ConsumptionBaseController {
         return { predecessor, successor };
     }
 
-    public async succeedThirdPartyOwnedRelationshipAttribute(
+    public async succeedThirdPartyRelationshipAttribute(
         predecessorId: CoreId,
         successorParams: IAttributeSuccessorParams | AttributeSuccessorParamsJSON,
         validate = true
     ): Promise<{ predecessor: LocalAttribute; successor: LocalAttribute }> {
         const parsedSuccessorParams = AttributeSuccessorParams.from(successorParams);
 
         if (validate) {
-            const validationResult = await this.validateThirdPartyOwnedRelationshipAttributeSuccession(predecessorId, parsedSuccessorParams);
+            const validationResult = await this.validateThirdPartyRelationshipAttributeSuccession(predecessorId, parsedSuccessorParams);
             if (validationResult.isError()) {
                 throw validationResult.error;
             }
@@ -559,7 +559,7 @@ export class AttributesController extends ConsumptionBaseController {
             succeededBy: parsedSuccessorParams.succeededBy
         });
 
-        this.eventBus.publish(new ThirdPartyOwnedRelationshipAttributeSucceededEvent(this.identity.address.toString(), predecessor, successor));
+        this.eventBus.publish(new ThirdPartyRelationshipAttributeSucceededEvent(this.identity.address.toString(), predecessor, successor));
 
         return { predecessor, successor };
     }
@@ -887,7 +887,7 @@ export class AttributesController extends ConsumptionBaseController {
         return ValidationResult.success();
     }
 
-    public async validateThirdPartyOwnedRelationshipAttributeSuccession(
+    public async validateThirdPartyRelationshipAttributeSuccession(
         predecessorId: CoreId,
         successorParams: IAttributeSuccessorParams | AttributeSuccessorParamsJSON
     ): Promise<ValidationResult> {
@@ -912,12 +912,12 @@ export class AttributesController extends ConsumptionBaseController {
             parentId: parsedSuccessorParams.parentId
         });
 
-        if (!predecessor.isThirdPartyOwnedRelationshipAttribute(this.identity.address)) {
-            return ValidationResult.error(ConsumptionCoreErrors.attributes.predecessorIsNotThirdPartyOwnedRelationshipAttribute());
+        if (!predecessor.isThirdPartyRelationshipAttribute()) {
+            return ValidationResult.error(ConsumptionCoreErrors.attributes.predecessorIsNotThirdPartyRelationshipAttribute());
         }
 
-        if (!successor.isThirdPartyOwnedRelationshipAttribute(this.identity.address)) {
-            return ValidationResult.error(ConsumptionCoreErrors.attributes.successorIsNotThirdPartyOwnedRelationshipAttribute());
+        if (!successor.isThirdPartyRelationshipAttribute()) {
+            return ValidationResult.error(ConsumptionCoreErrors.attributes.successorIsNotThirdPartyRelationshipAttribute());
         }
 
         if (successor.content.key !== predecessor.content.key) {
@@ -928,6 +928,10 @@ export class AttributesController extends ConsumptionBaseController {
             return ValidationResult.error(ConsumptionCoreErrors.attributes.successionMustNotChangePeer());
         }
 
+        if (!predecessor.shareInfo.thirdPartyAddress.equals(successor.shareInfo.thirdPartyAddress)) {
+            return ValidationResult.error(ConsumptionCoreErrors.attributes.successionMustNotChangeThirdParty());
+        }
+
         return ValidationResult.success();
     }
 

packages/consumption/src/modules/attributes/events/ThirdPartyRelationshipAttributeDeletedByPeerEvent.ts

@@ -0,0 +1,10 @@
+import { TransportDataEvent } from "@nmshd/transport";
+import { LocalAttribute } from "../local/LocalAttribute";
+
+export class ThirdPartyRelationshipAttributeDeletedByPeerEvent extends TransportDataEvent<LocalAttribute> {
+    public static readonly namespace = "consumption.thirdPartyRelationshipAttributeDeletedByPeer";
+
+    public constructor(eventTargetAddress: string, data: LocalAttribute) {
+        super(ThirdPartyRelationshipAttributeDeletedByPeerEvent.namespace, eventTargetAddress, data);
+    }
+}

packages/consumption/src/modules/attributes/events/ThirdPartyRelationshipAttributeSucceededEvent.ts

@@ -0,0 +1,11 @@
+import { TransportDataEvent } from "@nmshd/transport";
+import { LocalAttribute } from "../local/LocalAttribute";
+import { AttributeSucceededEventData } from "./AttributeSucceededEventData";
+
+export class ThirdPartyRelationshipAttributeSucceededEvent extends TransportDataEvent<AttributeSucceededEventData> {
+    public static readonly namespace = "consumption.thirdPartyRelationshipAttributeSucceeded";
+
+    public constructor(eventTargetAddress: string, predecessor: LocalAttribute, successor: LocalAttribute) {
+        super(ThirdPartyRelationshipAttributeSucceededEvent.namespace, eventTargetAddress, { predecessor, successor });
+    }
+}

packages/consumption/src/modules/attributes/events/index.ts

@@ -7,5 +7,5 @@ export * from "./PeerSharedAttributeDeletedByPeerEvent";
 export * from "./PeerSharedAttributeSucceededEvent";
 export * from "./RepositoryAttributeSucceededEvent";
 export * from "./SharedAttributeCopyCreatedEvent";
-export * from "./ThirdPartyOwnedRelationshipAttributeDeletedByPeerEvent";
-export * from "./ThirdPartyOwnedRelationshipAttributeSucceededEvent";
+export * from "./ThirdPartyRelationshipAttributeDeletedByPeerEvent";
+export * from "./ThirdPartyRelationshipAttributeSucceededEvent";

packages/consumption/src/modules/attributes/local/LocalAttribute.ts

@@ -52,12 +52,6 @@ export type OwnSharedRelationshipAttribute = LocalAttribute & {
     isDefault: undefined;
 };
 
-export type OwnSharedThirdPartyRelationshipAttribute = OwnSharedRelationshipAttribute & {
-    shareInfo: OwnSharedRelationshipAttribute["shareInfo"] & {
-        thirdPartyAddress: CoreAddress;
-    };
-};
-
 export type PeerSharedIdentityAttribute = LocalAttribute & {
     content: IdentityAttribute;
     shareInfo: LocalAttributeShareInfo & { sourceAttribute: undefined };
@@ -72,15 +66,9 @@ export type PeerSharedRelationshipAttribute = LocalAttribute & {
     isDefault: undefined;
 };
 
-export type PeerSharedThirdPartyRelationshipAttribute = PeerSharedRelationshipAttribute & {
-    shareInfo: PeerSharedRelationshipAttribute["shareInfo"] & {
-        thirdPartyAddress: CoreAddress;
-    };
-};
-
-export type ThirdPartyOwnedRelationshipAttribute = LocalAttribute & {
+export type ThirdPartyRelationshipAttribute = LocalAttribute & {
     content: RelationshipAttribute;
-    shareInfo: LocalAttribute["shareInfo"] & {
+    shareInfo: LocalAttributeShareInfo & {
         thirdPartyAddress: CoreAddress;
     };
     parentId: undefined;
@@ -157,8 +145,8 @@ export class LocalAttribute extends CoreSynchronizable implements ILocalAttribut
         return this.isRelationshipAttribute() && this.isPeerSharedAttribute(peerAddress);
     }
 
-    public isThirdPartyOwnedRelationshipAttribute(ownAddress: CoreAddress, thirdPartyAddress?: CoreAddress): this is ThirdPartyOwnedRelationshipAttribute {
-        return this.isRelationshipAttribute() && this.isThirdPartyOwnedAttribute(ownAddress, thirdPartyAddress);
+    public isThirdPartyRelationshipAttribute(): this is ThirdPartyRelationshipAttribute {
+        return this.isRelationshipAttribute() && !!this.shareInfo.thirdPartyAddress;
     }
 
     public isRepositoryAttribute(ownAddress: CoreAddress): this is RepositoryAttribute {
@@ -187,36 +175,17 @@ export class LocalAttribute extends CoreSynchronizable implements ILocalAttribut
         return isPeerSharedAttribute;
     }
 
-    public isOwnSharedThirdPartyRelationshipAttribute(ownAddress: CoreAddress): this is OwnSharedThirdPartyRelationshipAttribute {
-        const isThirdPartyAttribute = !!this.shareInfo?.thirdPartyAddress;
-        const isOwnShared = this.isOwnedBy(ownAddress);
-        return isThirdPartyAttribute && isOwnShared;
-    }
-
-    public isPeerSharedThirdPartyRelationshipAttribute(peerAddress: CoreAddress): this is PeerSharedThirdPartyRelationshipAttribute {
-        const isThirdPartyAttribute = !!this.shareInfo?.thirdPartyAddress;
-        const isPeerShared = this.isOwnedBy(peerAddress);
-        return isThirdPartyAttribute && isPeerShared;
-    }
-
-    public isThirdPartyOwnedAttribute(ownAddress: CoreAddress, thirdPartyAddress?: CoreAddress): this is ThirdPartyOwnedRelationshipAttribute {
-        let isThirdPartyOwnedAttribute = this.isShared() && !this.isOwnedBy(ownAddress) && !this.isOwnedBy(this.shareInfo.peer);
-
-        isThirdPartyOwnedAttribute &&= !this.parentId;
-        isThirdPartyOwnedAttribute &&= !this.isDefault;
-
-        if (thirdPartyAddress) isThirdPartyOwnedAttribute &&= this.isOwnedBy(thirdPartyAddress);
-        return isThirdPartyOwnedAttribute;
-    }
-
     public isIdentityAttribute(): this is LocalAttribute & { content: IdentityAttribute } {
         return this.content instanceof IdentityAttribute;
     }
 
-    public isRelationshipAttribute(): this is LocalAttribute & { content: RelationshipAttribute } & {
-        shareInfo: LocalAttributeShareInfo;
-    } {
-        return this.content instanceof RelationshipAttribute && this.isShared();
+    public isRelationshipAttribute(): this is LocalAttribute & { content: RelationshipAttribute; shareInfo: LocalAttributeShareInfo } {
+        let isRelationshipAttribute = this.content instanceof RelationshipAttribute && this.isShared();
+
+        isRelationshipAttribute &&= !this.parentId;
+        isRelationshipAttribute &&= !this.isDefault;
+
+        return isRelationshipAttribute;
     }
 
     public isComplexAttribute(): boolean {
@@ -244,8 +213,8 @@ export class LocalAttribute extends CoreSynchronizable implements ILocalAttribut
             throw ConsumptionCoreErrors.attributes.invalidDeletionInfoOfPeerSharedAttribute();
         }
 
-        if (this.isThirdPartyOwnedRelationshipAttribute(ownAddress) && !this.isThirdPartyOwnedRelationshipAttributeDeletionInfo(deletionInfo)) {
-            throw ConsumptionCoreErrors.attributes.invalidDeletionInfoOfThirdPartyOwnedRelationshipAttribute();
+        if (this.isThirdPartyRelationshipAttribute() && !this.isThirdPartyRelationshipAttributeDeletionInfo(deletionInfo)) {
+            throw ConsumptionCoreErrors.attributes.invalidDeletionInfoOfThirdPartyRelationshipAttribute();
         }
 
         this.deletionInfo = deletionInfo;
@@ -265,7 +234,7 @@ export class LocalAttribute extends CoreSynchronizable implements ILocalAttribut
         );
     }
 
-    private isThirdPartyOwnedRelationshipAttributeDeletionInfo(deletionInfo: LocalAttributeDeletionInfo): boolean {
+    private isThirdPartyRelationshipAttributeDeletionInfo(deletionInfo: LocalAttributeDeletionInfo): boolean {
         return deletionInfo.deletionStatus === LocalAttributeDeletionStatus.DeletedByPeer;
     }
 

packages/consumption/src/modules/notifications/index.ts

@@ -1,7 +1,7 @@
 export * from "./itemProcessors/AbstractNotificationItemProcessor";
 export * from "./itemProcessors/attributeDeleted/OwnSharedAttributeDeletedByOwnerNotificationItemProcessor";
 export * from "./itemProcessors/attributeDeleted/PeerSharedAttributeDeletedByPeerNotificationItemProcessor";
-export * from "./itemProcessors/attributeDeleted/ThirdPartyOwnedRelationshipAttributeDeletedByPeerNotificationItemProcessor";
+export * from "./itemProcessors/attributeDeleted/ThirdPartyRelationshipAttributeDeletedByPeerNotificationItemProcessor";
 export * from "./itemProcessors/attributeSucceeded/PeerSharedAttributeSucceededNotificationItemProcessor";
 export * from "./itemProcessors/NotificationItemConstructor";
 export * from "./itemProcessors/NotificationItemProcessorConstructor";