Chore/Apply consistent attribute nomenclature (#9)

* refactor: reformat order of imports

* chore: apply consistent nomenclature for RepositoryAttributes

* chore: version bump

* fix: errors from merging

* refactor: rename tests

* fix: error renaming

* fix: clarify error message

* refactor: rename variable

* chore: rename cannotSucceedChildOfComplexAttribute

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

packages/app-runtime/package.json

@@ -61,7 +61,7 @@
         "@types/luxon": "^3.4.2"
     },
     "peerDependencies": {
-        "@nmshd/runtime": "^3.6.0"
+        "@nmshd/runtime": "^4.0.0"
     },
     "publishConfig": {
         "access": "public",

packages/consumption/src/consumption/CoreErrors.ts

@@ -29,10 +29,10 @@ class Attributes {
         return new CoreError("error.consumption.attributes.invalidSuccessionOfOwnSharedIdentityAttribute", errorMessage);
     }
 
-    public cannotSucceedPartOfComplexAttribute(parentId: string | CoreId) {
+    public cannotSucceedChildOfComplexAttribute(parentId: string | CoreId) {
         return new CoreError(
-            "error.consumption.attributes.cannotSucceedPartOfComplexAttribute",
-            `The attribute you want to succeed is part of a complex attribute (id: ${parentId}), and cannot be succeeded on its own. Instead, succeed the parent which will implicitly succeed all its children.`
+            "error.consumption.attributes.cannotSucceedChildOfComplexAttribute",
+            `The attribute you want to succeed is child attribute of a complex attribute (id: ${parentId}), and cannot be succeeded on its own. Instead, succeed the parent which will implicitly succeed all its children.`
         );
     }
 

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

@@ -781,7 +781,7 @@ export class AttributesController extends ConsumptionBaseController {
         }
 
         if (typeof successor.parentId !== "undefined") {
-            return ValidationResult.error(CoreErrors.attributes.cannotSucceedPartOfComplexAttribute(predecessorId.toString()));
+            return ValidationResult.error(CoreErrors.attributes.cannotSucceedChildOfComplexAttribute(predecessorId.toString()));
         }
 
         const predecessor = await this.getLocalAttribute(predecessorId);
@@ -794,7 +794,7 @@ export class AttributesController extends ConsumptionBaseController {
         }
 
         if (typeof predecessor.parentId !== "undefined") {
-            return ValidationResult.error(CoreErrors.attributes.cannotSucceedPartOfComplexAttribute(predecessorId.toString()));
+            return ValidationResult.error(CoreErrors.attributes.cannotSucceedChildOfComplexAttribute(predecessorId.toString()));
         }
 
         if (!predecessor.content.owner.equals(CoreAddress.from(successor.content.owner))) {

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

@@ -657,7 +657,7 @@ describe("AttributesController", function () {
 
                 const validationResult = await consumptionController.attributes.validateAttributeSuccessionCommon(predecessor.id, successorData);
                 expect(validationResult).errorValidationResult({
-                    code: "error.consumption.attributes.cannotSucceedPartOfComplexAttribute"
+                    code: "error.consumption.attributes.cannotSucceedChildOfComplexAttribute"
                 });
             });
 
@@ -728,7 +728,7 @@ describe("AttributesController", function () {
 
                 const validationResult = await consumptionController.attributes.validateAttributeSuccessionCommon(predecessor.id, successorData);
                 expect(validationResult).errorValidationResult({
-                    code: "error.consumption.attributes.cannotSucceedPartOfComplexAttribute"
+                    code: "error.consumption.attributes.cannotSucceedChildOfComplexAttribute"
                 });
             });
 

packages/runtime/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nmshd/runtime",
-    "version": "3.7.0",
+    "version": "4.0.0",
     "description": "The enmeshed client runtime.",
     "homepage": "https://enmeshed.eu",
     "repository": {

packages/runtime/src/Runtime.ts

@@ -22,21 +22,21 @@ import {
     ICoreAddress,
     IdentityController,
     MessageController,
-    RelationshipTemplateController,
     RelationshipsController,
+    RelationshipTemplateController,
     TokenController,
     Transport
 } from "@nmshd/transport";
 import { Container, Scope } from "typescript-ioc";
-import { DatabaseSchemaUpgrader } from "./DatabaseSchemaUpgrader";
-import { RuntimeConfig } from "./RuntimeConfig";
-import { RuntimeLoggerFactory } from "./RuntimeLoggerFactory";
 import { buildInformation } from "./buildInformation";
+import { DatabaseSchemaUpgrader } from "./DatabaseSchemaUpgrader";
 import { DataViewExpander } from "./dataViews";
 import { ModulesInitializedEvent, ModulesLoadedEvent, ModulesStartedEvent, RuntimeInitializedEvent, RuntimeInitializingEvent } from "./events";
 import { EventProxy } from "./events/EventProxy";
 import { AnonymousServices, ConsumptionServices, ModuleConfiguration, RuntimeModule, RuntimeModuleRegistry, TransportServices } from "./extensibility";
 import { AttributeListenerModule, DeciderModule, MessageModule, NotificationModule, RequestModule } from "./modules";
+import { RuntimeConfig } from "./RuntimeConfig";
+import { RuntimeLoggerFactory } from "./RuntimeLoggerFactory";
 import { RuntimeHealth } from "./types";
 import { RuntimeErrors } from "./useCases";
 import { SchemaRepository } from "./useCases/common/SchemaRepository";

packages/runtime/src/dataViews/DataViewExpander.ts

@@ -9,10 +9,10 @@ import {
     ErrorResponseItemJSON,
     FreeTextRequestItemJSON,
     GivenNameJSON,
-    IQLQueryJSON,
     IdentityAttribute,
     IdentityAttributeJSON,
     IdentityAttributeQueryJSON,
+    IQLQueryJSON,
     MailJSON,
     MiddleNameJSON,
     ProposeAttributeAcceptResponseItemJSON,
@@ -81,8 +81,6 @@ import {
     RelationshipTemplateDTO
 } from "../types";
 import { RuntimeErrors } from "../useCases";
-import { DataViewObject } from "./DataViewObject";
-import { DataViewTranslateable } from "./DataViewTranslateable";
 import {
     LocalAttributeDVO,
     LocalAttributeListenerDVO,
@@ -92,8 +90,8 @@ import {
     PeerAttributeDVO,
     PeerRelationshipAttributeDVO,
     ProcessedAttributeQueryDVO,
-    ProcessedIQLQueryDVO,
     ProcessedIdentityAttributeQueryDVO,
+    ProcessedIQLQueryDVO,
     ProcessedRelationshipAttributeQueryDVO,
     ProcessedThirdPartyRelationshipAttributeQueryDVO,
     RelationshipSettingDVO,
@@ -115,8 +113,8 @@ import {
     AttributeQueryDVO,
     DraftIdentityAttributeDVO,
     DraftRelationshipAttributeDVO,
-    IQLQueryDVO,
     IdentityAttributeQueryDVO,
+    IQLQueryDVO,
     RelationshipAttributeQueryDVO,
     ThirdPartyRelationshipAttributeQueryDVO
 } from "./content/AttributeDVOs";
@@ -133,8 +131,10 @@ import {
     ResponseItemGroupDVO,
     ShareAttributeAcceptResponseItemDVO
 } from "./content/ResponseItemDVOs";
+import { DataViewObject } from "./DataViewObject";
+import { DataViewTranslateable } from "./DataViewTranslateable";
 import { MessageDVO, MessageStatus, RecipientDVO } from "./transport/MessageDVO";
-import { RelationshipChangeDVO, RelationshipChangeResponseDVO, RelationshipDVO, RelationshipDirection } from "./transport/RelationshipDVO";
+import { RelationshipChangeDVO, RelationshipChangeResponseDVO, RelationshipDirection, RelationshipDVO } from "./transport/RelationshipDVO";
 
 export class DataViewExpander {
     public constructor(

packages/runtime/src/dataViews/consumption/LocalAttributeDVO.ts

@@ -1,6 +1,6 @@
 import { IdentityAttributeJSON, RelationshipAttributeCreationHintsJSON, RelationshipAttributeJSON, RenderHintsJSON, ValueHintsJSON } from "@nmshd/content";
-import { DataViewObject } from "../DataViewObject";
 import { AttributeQueryDVO } from "../content/AttributeDVOs";
+import { DataViewObject } from "../DataViewObject";
 import { IdentityDVO } from "../transport";
 
 /**

packages/runtime/src/dataViews/consumption/LocalRequestDVO.ts

@@ -1,6 +1,6 @@
 import { LocalRequestStatus } from "@nmshd/consumption";
-import { DataViewObject } from "../DataViewObject";
 import { RequestDVO, RequestItemDVO, RequestItemGroupDVO, ResponseDVO } from "../content";
+import { DataViewObject } from "../DataViewObject";
 import { IdentityDVO } from "../transport";
 
 export interface LocalRequestDVO extends DataViewObject {

packages/runtime/src/dataViews/content/ResponseItemDVOs.ts

@@ -1,6 +1,6 @@
 import { ResponseItemResult } from "@nmshd/content";
-import { DataViewObject } from "../DataViewObject";
 import { LocalAttributeDVO, LocalAttributeListenerDVO } from "../consumption";
+import { DataViewObject } from "../DataViewObject";
 
 export interface ResponseItemGroupDVO {
     type: "ResponseItemGroupDVO";

packages/runtime/src/dataViews/transport/RelationshipDVO.ts

@@ -1,6 +1,6 @@
 import { RelationshipChangeStatus, RelationshipChangeType } from "@nmshd/transport";
-import { DataViewObject } from "../DataViewObject";
 import { LocalAttributeDVO } from "../consumption";
+import { DataViewObject } from "../DataViewObject";
 
 export enum RelationshipDirection {
     Outgoing = "Outgoing",

packages/runtime/src/extensibility/facades/consumption/AttributesFacade.ts

@@ -4,70 +4,70 @@ import { LocalAttributeDTO, LocalRequestDTO } from "../../../types";
 import {
     CreateAndShareRelationshipAttributeRequest,
     CreateAndShareRelationshipAttributeUseCase,
-    CreateIdentityAttributeRequest,
-    CreateIdentityAttributeUseCase,
-    ExecuteIQLQueryRequest,
-    ExecuteIQLQueryUseCase,
+    CreateRepositoryAttributeRequest,
+    CreateRepositoryAttributeUseCase,
     ExecuteIdentityAttributeQueryRequest,
     ExecuteIdentityAttributeQueryUseCase,
+    ExecuteIQLQueryRequest,
+    ExecuteIQLQueryUseCase,
     ExecuteRelationshipAttributeQueryRequest,
     ExecuteRelationshipAttributeQueryUseCase,
     ExecuteThirdPartyRelationshipAttributeQueryRequest,
     ExecuteThirdPartyRelationshipAttributeQueryUseCase,
     GetAttributeRequest,
-    GetAttributeUseCase,
     GetAttributesRequest,
     GetAttributesUseCase,
-    GetOwnIdentityAttributesRequest,
-    GetOwnIdentityAttributesUseCase,
+    GetAttributeUseCase,
     GetOwnSharedAttributesRequest,
     GetOwnSharedAttributesUseCase,
     GetPeerSharedAttributesRequest,
     GetPeerSharedAttributesUseCase,
-    GetSharedVersionsOfIdentityAttributeRequest,
-    GetSharedVersionsOfIdentityAttributeUseCase,
+    GetRepositoryAttributesRequest,
+    GetRepositoryAttributesUseCase,
+    GetSharedVersionsOfRepositoryAttributeRequest,
+    GetSharedVersionsOfRepositoryAttributeUseCase,
     GetVersionsOfAttributeRequest,
     GetVersionsOfAttributeUseCase,
-    NotifyPeerAboutIdentityAttributeSuccessionRequest,
-    NotifyPeerAboutIdentityAttributeSuccessionResponse,
-    NotifyPeerAboutIdentityAttributeSuccessionUseCase,
-    ShareIdentityAttributeRequest,
-    ShareIdentityAttributeUseCase,
-    SucceedIdentityAttributeRequest,
-    SucceedIdentityAttributeResponse,
-    SucceedIdentityAttributeUseCase,
+    NotifyPeerAboutRepositoryAttributeSuccessionRequest,
+    NotifyPeerAboutRepositoryAttributeSuccessionResponse,
+    NotifyPeerAboutRepositoryAttributeSuccessionUseCase,
+    ShareRepositoryAttributeRequest,
+    ShareRepositoryAttributeUseCase,
     SucceedRelationshipAttributeAndNotifyPeerRequest,
     SucceedRelationshipAttributeAndNotifyPeerResponse,
     SucceedRelationshipAttributeAndNotifyPeerUseCase,
+    SucceedRepositoryAttributeRequest,
+    SucceedRepositoryAttributeResponse,
+    SucceedRepositoryAttributeUseCase,
     ValidateIQLQueryRequest,
     ValidateIQLQueryResponse,
     ValidateIQLQueryUseCase
 } from "../../../useCases";
 
 export class AttributesFacade {
     public constructor(
-        @Inject private readonly createIdentityAttributeUseCase: CreateIdentityAttributeUseCase,
-        @Inject private readonly shareIdentityAttributeUseCase: ShareIdentityAttributeUseCase,
+        @Inject private readonly createRepositoryAttributeUseCase: CreateRepositoryAttributeUseCase,
+        @Inject private readonly shareRepositoryAttributeUseCase: ShareRepositoryAttributeUseCase,
         @Inject private readonly getPeerSharedAttributesUseCase: GetPeerSharedAttributesUseCase,
         @Inject private readonly getOwnSharedAttributesUseCase: GetOwnSharedAttributesUseCase,
-        @Inject private readonly getOwnIdentityAttributesUseCase: GetOwnIdentityAttributesUseCase,
+        @Inject private readonly getRepositoryAttributesUseCase: GetRepositoryAttributesUseCase,
         @Inject private readonly getAttributeUseCase: GetAttributeUseCase,
         @Inject private readonly getAttributesUseCase: GetAttributesUseCase,
         @Inject private readonly getVersionsOfAttributeUseCase: GetVersionsOfAttributeUseCase,
-        @Inject private readonly getSharedVersionsOfIdentityAttributeUseCase: GetSharedVersionsOfIdentityAttributeUseCase,
-        @Inject private readonly succeedIdentityAttributeUseCase: SucceedIdentityAttributeUseCase,
+        @Inject private readonly getSharedVersionsOfRepositoryAttributeUseCase: GetSharedVersionsOfRepositoryAttributeUseCase,
+        @Inject private readonly succeedRepositoryAttributeUseCase: SucceedRepositoryAttributeUseCase,
         @Inject private readonly executeIdentityAttributeQueryUseCase: ExecuteIdentityAttributeQueryUseCase,
         @Inject private readonly executeRelationshipAttributeQueryUseCase: ExecuteRelationshipAttributeQueryUseCase,
         @Inject private readonly succeedRelationshipAttributeAndNotifyPeerUseCase: SucceedRelationshipAttributeAndNotifyPeerUseCase,
         @Inject private readonly executeThirdPartyRelationshipAttributeQueryUseCase: ExecuteThirdPartyRelationshipAttributeQueryUseCase,
         @Inject private readonly executeIQLQueryUseCase: ExecuteIQLQueryUseCase,
         @Inject private readonly validateIQLQueryUseCase: ValidateIQLQueryUseCase,
         @Inject private readonly createAndShareRelationshipAttributeUseCase: CreateAndShareRelationshipAttributeUseCase,
-        @Inject private readonly notifyPeerAboutIdentityAttributeSuccessionUseCase: NotifyPeerAboutIdentityAttributeSuccessionUseCase
+        @Inject private readonly notifyPeerAboutRepositoryAttributeSuccessionUseCase: NotifyPeerAboutRepositoryAttributeSuccessionUseCase
     ) {}
 
-    public async createIdentityAttribute(request: CreateIdentityAttributeRequest): Promise<Result<LocalAttributeDTO>> {
-        return await this.createIdentityAttributeUseCase.execute(request);
+    public async createRepositoryAttribute(request: CreateRepositoryAttributeRequest): Promise<Result<LocalAttributeDTO>> {
+        return await this.createRepositoryAttributeUseCase.execute(request);
     }
 
     public async getPeerSharedAttributes(request: GetPeerSharedAttributesRequest): Promise<Result<LocalAttributeDTO[]>> {
@@ -78,8 +78,8 @@ export class AttributesFacade {
         return await this.getOwnSharedAttributesUseCase.execute(request);
     }
 
-    public async getOwnIdentityAttributes(request: GetOwnIdentityAttributesRequest): Promise<Result<LocalAttributeDTO[]>> {
-        return await this.getOwnIdentityAttributesUseCase.execute(request);
+    public async getRepositoryAttributes(request: GetRepositoryAttributesRequest): Promise<Result<LocalAttributeDTO[]>> {
+        return await this.getRepositoryAttributesUseCase.execute(request);
     }
 
     public async getAttribute(request: GetAttributeRequest): Promise<Result<LocalAttributeDTO>> {
@@ -94,8 +94,8 @@ export class AttributesFacade {
         return await this.getVersionsOfAttributeUseCase.execute(request);
     }
 
-    public async getSharedVersionsOfIdentityAttribute(request: GetSharedVersionsOfIdentityAttributeRequest): Promise<Result<LocalAttributeDTO[]>> {
-        return await this.getSharedVersionsOfIdentityAttributeUseCase.execute(request);
+    public async getSharedVersionsOfRepositoryAttribute(request: GetSharedVersionsOfRepositoryAttributeRequest): Promise<Result<LocalAttributeDTO[]>> {
+        return await this.getSharedVersionsOfRepositoryAttributeUseCase.execute(request);
     }
 
     public async executeIdentityAttributeQuery(request: ExecuteIdentityAttributeQueryRequest): Promise<Result<LocalAttributeDTO[]>> {
@@ -124,21 +124,21 @@ export class AttributesFacade {
         return await this.validateIQLQueryUseCase.execute(request);
     }
 
-    public async succeedIdentityAttribute(request: SucceedIdentityAttributeRequest): Promise<Result<SucceedIdentityAttributeResponse>> {
-        return await this.succeedIdentityAttributeUseCase.execute(request);
+    public async succeedRepositoryAttribute(request: SucceedRepositoryAttributeRequest): Promise<Result<SucceedRepositoryAttributeResponse>> {
+        return await this.succeedRepositoryAttributeUseCase.execute(request);
     }
 
-    public async shareIdentityAttribute(request: ShareIdentityAttributeRequest): Promise<Result<LocalRequestDTO>> {
-        return await this.shareIdentityAttributeUseCase.execute(request);
+    public async shareRepositoryAttribute(request: ShareRepositoryAttributeRequest): Promise<Result<LocalRequestDTO>> {
+        return await this.shareRepositoryAttributeUseCase.execute(request);
     }
 
     public async createAndShareRelationshipAttribute(request: CreateAndShareRelationshipAttributeRequest): Promise<Result<LocalRequestDTO>> {
         return await this.createAndShareRelationshipAttributeUseCase.execute(request);
     }
 
-    public async notifyPeerAboutIdentityAttributeSuccession(
-        request: NotifyPeerAboutIdentityAttributeSuccessionRequest
-    ): Promise<Result<NotifyPeerAboutIdentityAttributeSuccessionResponse>> {
-        return await this.notifyPeerAboutIdentityAttributeSuccessionUseCase.execute(request);
+    public async notifyPeerAboutRepositoryAttributeSuccession(
+        request: NotifyPeerAboutRepositoryAttributeSuccessionRequest
+    ): Promise<Result<NotifyPeerAboutRepositoryAttributeSuccessionResponse>> {
+        return await this.notifyPeerAboutRepositoryAttributeSuccessionUseCase.execute(request);
     }
 }

packages/runtime/src/modules/AttributeListenerModule.ts

@@ -1,7 +1,7 @@
 import { RelationshipAttributeConfidentiality, ShareAttributeRequestItemJSON } from "@nmshd/content";
-import { RuntimeServices } from "../Runtime";
 import { AttributeCreatedEvent, AttributeListenerTriggeredEvent } from "../events";
 import { RuntimeModule } from "../extensibility";
+import { RuntimeServices } from "../Runtime";
 import { LocalAttributeDTO, LocalAttributeListenerDTO } from "../types";
 
 export class AttributeListenerModule extends RuntimeModule {

packages/runtime/src/modules/DeciderModule.ts

@@ -1,6 +1,5 @@
 import { LocalRequestStatus } from "@nmshd/consumption";
 import { RequestItemJSON } from "@nmshd/content";
-import { RuntimeServices } from "../Runtime";
 import {
     IncomingRequestStatusChangedEvent,
     MessageProcessedEvent,
@@ -9,6 +8,7 @@ import {
     RelationshipTemplateProcessedResult
 } from "../events";
 import { RuntimeModule } from "../extensibility";
+import { RuntimeServices } from "../Runtime";
 
 export class DeciderModule extends RuntimeModule {
     public init(): void {

packages/runtime/src/modules/RequestModule.ts

@@ -9,7 +9,6 @@ import {
     ResponseWrapper,
     ResponseWrapperJSON
 } from "@nmshd/content";
-import { RuntimeServices } from "../Runtime";
 import {
     IncomingRequestStatusChangedEvent,
     MessageProcessedEvent,
@@ -21,6 +20,7 @@ import {
 } from "../events";
 import { RelationshipTemplateProcessedEvent, RelationshipTemplateProcessedResult } from "../events/consumption/RelationshipTemplateProcessedEvent";
 import { RuntimeModule } from "../extensibility/modules/RuntimeModule";
+import { RuntimeServices } from "../Runtime";
 import { LocalRequestDTO, RelationshipStatus } from "../types";
 
 export class RequestModule extends RuntimeModule {