Add CanCreateRelationship API route (#292)

* chore: bump runtime Co-authored-by: Britta Stallknecht <[email protected]> * refactor: adjust ThirdPartyRelationshipAttribute nomenclature * feat: add CanCreateRelationship route * chore: adjust ConnectorRuntimeConfig to DeciderModuleConfiguration * feat: add canCreateRelationship to openapi.yml * feat: add thirdPartyAddress to shareInfo * chore: update dependencies * feat: use put for canCreateRelationship Co-authored-by: Britta Stallknecht <[email protected]> * refactor: more compact imports * feat: add Runtime call of CanCreateRelationshipUseCase * feat: add CanCreateRelationshipResponse schema * fix: inconsistency within openapi spec * feat: improve description --------- Co-authored-by: Britta Stallknecht <[email protected]> Co-authored-by: Britta Stallknecht <[email protected]>
nmshd · Oct 28, 2024 · ecfc975 · ecfc975
1 parent 50e67ad
commit ecfc975
Show file tree

Hide file tree

Showing 20 changed files with 191 additions and 80 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -84,7 +84,7 @@
         "@js-soft/docdb-access-mongo": "1.1.9",
         "@js-soft/node-logger": "1.2.0",
         "@js-soft/ts-utils": "^2.3.3",
-        "@nmshd/runtime": "6.3.1",
+        "@nmshd/runtime": "6.5.0",
         "@nmshd/typescript-ioc": "^3.2.4",
         "@nmshd/typescript-rest": "^3.0.5",
         "agentkeepalive": "4.5.0",
@@ -112,21 +112,21 @@
         "@js-soft/eslint-config-ts": "1.6.13",
         "@js-soft/license-check": "1.0.9",
         "@nmshd/connector-sdk": "*",
-        "@nmshd/content": "6.3.1",
-        "@nmshd/core-types": "6.3.1",
+        "@nmshd/content": "6.5.0",
+        "@nmshd/core-types": "6.5.0",
         "@nmshd/typescript-rest-swagger": "^1.4.1",
         "@types/amqplib": "^0.10.5",
         "@types/compression": "^1.7.5",
         "@types/cors": "^2.8.17",
         "@types/eventsource": "^1.1.15",
         "@types/express": "5.0.0",
-        "@types/jest": "^29.5.13",
+        "@types/jest": "^29.5.14",
         "@types/jest-json-schema": "^6.1.4",
         "@types/json-stringify-safe": "^5.0.3",
         "@types/lodash": "^4.17.12",
         "@types/luxon": "^3.4.2",
         "@types/nconf": "^0.10.7",
-        "@types/node": "^22.7.7",
+        "@types/node": "^22.8.0",
         "@types/on-headers": "^1.0.3",
         "@types/swagger-ui-express": "^4.1.6",
         "@types/yamljs": "^0.2.34",

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -30,7 +30,7 @@
         "build:schemas:watch": "npx nodemon -e ts -w 'src/types' --exec 'npm run build:schemas'"
     },
     "dependencies": {
-        "@nmshd/content": "6.3.1",
+        "@nmshd/content": "6.5.0",
         "axios": "^1.7.7",
         "form-data": "^4.0.1",
         "qs": "^6.13.0"

diff --git a/packages/sdk/src/endpoints/AttributesEndpoint.ts b/packages/sdk/src/endpoints/AttributesEndpoint.ts
@@ -5,7 +5,7 @@ import {
     CreateRepositoryAttributeRequest,
     DeleteOwnSharedAttributeAndNotifyPeerResponse,
     DeletePeerSharedAttributeAndNotifyOwnerResponse,
-    DeleteThirdPartyOwnedRelationshipAttributeAndNotifyPeerResponse,
+    DeleteThirdPartyRelationshipAttributeAndNotifyPeerResponse,
     ExecuteIQLQueryRequest,
     ExecuteIdentityAttributeQueryRequest,
     ExecuteRelationshipAttributeQueryRequest,
@@ -83,9 +83,9 @@ export class AttributesEndpoint extends Endpoint {
         return await this.delete(`/api/v2/Attributes/${attributeId}`, undefined, 204);
     }
 
-    public async deleteThirdPartyOwnedRelationshipAttributeAndNotifyPeer(
+    public async deleteThirdPartyRelationshipAttributeAndNotifyPeer(
         attributeId: string
-    ): Promise<ConnectorHttpResponse<DeleteThirdPartyOwnedRelationshipAttributeAndNotifyPeerResponse>> {
+    ): Promise<ConnectorHttpResponse<DeleteThirdPartyRelationshipAttributeAndNotifyPeerResponse>> {
         return await this.delete(`/api/v2/Attributes/ThirdParty/${attributeId}`);
     }
 

diff --git a/packages/sdk/src/endpoints/RelationshipsEndpoint.ts b/packages/sdk/src/endpoints/RelationshipsEndpoint.ts
@@ -1,7 +1,19 @@
-import { ConnectorAttributes, ConnectorHttpResponse, ConnectorRelationship, ConnectorRelationships, CreateRelationshipRequest, GetRelationshipsRequest } from "../types";
+import {
+    CanCreateRelationshipResponse,
+    ConnectorAttributes,
+    ConnectorHttpResponse,
+    ConnectorRelationship,
+    ConnectorRelationships,
+    CreateRelationshipRequest,
+    GetRelationshipsRequest
+} from "../types";
 import { Endpoint } from "./Endpoint";
 
 export class RelationshipsEndpoint extends Endpoint {
+    public async canCreateRelationship(request: CreateRelationshipRequest): Promise<ConnectorHttpResponse<CanCreateRelationshipResponse>> {
+        return await this.put("/api/v2/Relationships/CanCreate", request);
+    }
+
     public async createRelationship(request: CreateRelationshipRequest): Promise<ConnectorHttpResponse<ConnectorRelationship>> {
         return await this.post("/api/v2/Relationships", request);
     }

diff --git a/packages/sdk/src/types/attributes/ConnectorAttribute.ts b/packages/sdk/src/types/attributes/ConnectorAttribute.ts
@@ -30,12 +30,14 @@ export interface ConnectorAttributeShareInfoForRequest {
     requestReference: string;
     peer: string;
     sourceAttribute?: string;
+    thirdPartyAddress?: string;
 }
 
 export interface ConnectorAttributeShareInfoForNotification {
     notificationReference: string;
     peer: string;
     sourceAttribute?: string;
+    thirdPartyAddress?: string;
 }
 
 export type ConnectorAttributeShareInfo = ConnectorAttributeShareInfoForNotification | ConnectorAttributeShareInfoForRequest;
diff --git a/packages/sdk/src/types/attributes/index.ts b/packages/sdk/src/types/attributes/index.ts
@@ -6,7 +6,7 @@ export * from "./RelationshipAttributeQuery";
 export * from "./requests/CreateRepositoryAttributeRequest";
 export * from "./requests/DeleteOwnSharedAttributeAndNotifyPeerResponse";
 export * from "./requests/DeletePeerSharedAttributeAndNotifyOwnerResponse";
-export * from "./requests/DeleteThirdPartyOwnedRelationshipAttributeAndNotifyPeerResponse";
+export * from "./requests/DeleteThirdPartyRelationshipAttributeAndNotifyPeerResponse";
 export * from "./requests/ExecuteIdentityAttributeQueryRequest";
 export * from "./requests/ExecuteIQLQueryRequest";
 export * from "./requests/ExecuteRelationshipAttributeQueryRequest";

diff --git a/...es/attributes/requests/DeleteThirdPartyOwnedRelationshipAttributeAndNotifyPeerResponse.ts b/...es/attributes/requests/DeleteThirdPartyOwnedRelationshipAttributeAndNotifyPeerResponse.ts
diff --git a/...c/types/attributes/requests/DeleteThirdPartyRelationshipAttributeAndNotifyPeerResponse.ts b/...c/types/attributes/requests/DeleteThirdPartyRelationshipAttributeAndNotifyPeerResponse.ts
@@ -0,0 +1,3 @@
+export interface DeleteThirdPartyRelationshipAttributeAndNotifyPeerResponse {
+    notificationId: string;
+}
diff --git a/packages/sdk/src/types/attributes/requests/GetAttributesRequest.ts b/packages/sdk/src/types/attributes/requests/GetAttributesRequest.ts
@@ -19,5 +19,6 @@ export interface GetAttributesRequest {
         requestReference?: string;
         peer?: string;
         sourceAttribute?: string;
+        thirdPartyAddress?: string;
     };
 }
diff --git a/packages/sdk/src/types/attributes/requests/GetOwnSharedIdentityAttributesRequest.ts b/packages/sdk/src/types/attributes/requests/GetOwnSharedIdentityAttributesRequest.ts
@@ -14,6 +14,7 @@ export interface GetOwnSharedIdentityAttributesRequest {
     "query.shareInfo.requestReference"?: string | string[];
     "query.shareInfo.notificationReference"?: string | string[];
     "query.shareInfo.sourceAttribute"?: string | string[];
+    "query.shareInfo.thirdPartyAddress"?: string | string[];
     "query.deletionInfo"?: string | string[];
     "query.deletionInfo.deletionStatus"?: string | string[];
     "query.deletionInfo.deletionDate"?: string | string[];

diff --git a/packages/sdk/src/types/attributes/requests/GetPeerSharedIdentityAttributesRequest.ts b/packages/sdk/src/types/attributes/requests/GetPeerSharedIdentityAttributesRequest.ts
@@ -13,6 +13,7 @@ export interface GetPeerSharedIdentityAttributesRequest {
     "query.shareInfo"?: string | string[];
     "query.shareInfo.requestReference"?: string | string[];
     "query.shareInfo.notificationReference"?: string | string[];
+    "query.shareInfo.thirdPartyAddress"?: string | string[];
     "query.deletionInfo"?: string | string[];
     "query.deletionInfo.deletionStatus"?: string | string[];
     "query.deletionInfo.deletionDate"?: string | string[];

diff --git a/packages/sdk/src/types/relationships/index.ts b/packages/sdk/src/types/relationships/index.ts
@@ -6,3 +6,4 @@ export * from "./ConnectorRelationships";
 export * from "./ConnectorRelationshipStatus";
 export * from "./requests/CreateRelationshipRequest";
 export * from "./requests/GetRelationshipsRequest";
+export * from "./responses/CanCreateRelationshipResponse";