Add CanCreateRepositoryAttribute (#362)

* chore: bump runtime

* chore: bump backbone version

* feat: add CanCreateRepositoryAttribute

* fix: add CanCreateRepositoryAttributeResponse to openapi

* chore: add changes from backbone bump

.dev/appsettings.override.json

@@ -64,7 +64,8 @@
                 }
             },
             "Application": {
-                "didDomainName": "localhost"
+                "didDomainName": "localhost",
+                "maxNumberOfMessageRecipients": 5
             }
         },
         "Files": {

.dev/compose.backbone.env

@@ -1 +1 @@
-BACKBONE_VERSION=6.28.0
+BACKBONE_VERSION=6.30.0

.dev/compose.backbone.yml

@@ -89,7 +89,7 @@ services:
   rabbitmq:
     container_name: bkb-rabbitmq
     hostname: rabbitmq
-    image: rabbitmq:3.12.10-management-alpine
+    image: rabbitmq:4.0.5-alpine
 
   ### seeds ###
 

package.json

@@ -83,7 +83,7 @@
         "@js-soft/docdb-access-mongo": "1.2.0",
         "@js-soft/node-logger": "1.2.0",
         "@js-soft/ts-utils": "^2.3.3",
-        "@nmshd/runtime": "6.23.1",
+        "@nmshd/runtime": "6.24.2",
         "@nmshd/typescript-ioc": "^3.2.4",
         "@nmshd/typescript-rest": "^3.1.0",
         "agentkeepalive": "4.6.0",
@@ -113,8 +113,8 @@
         "@js-soft/eslint-config-ts": "1.6.13",
         "@js-soft/license-check": "1.0.9",
         "@nmshd/connector-sdk": "*",
-        "@nmshd/content": "6.23.1",
-        "@nmshd/core-types": "6.23.1",
+        "@nmshd/content": "6.24.2",
+        "@nmshd/core-types": "6.24.2",
         "@nmshd/typescript-rest-swagger": "^1.4.1",
         "@types/amqplib": "^0.10.6",
         "@types/compression": "^1.7.5",

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.23.1",
+        "@nmshd/content": "6.24.2",
         "axios": "^1.7.9",
         "form-data": "^4.0.1",
         "qs": "^6.14.0"

packages/sdk/src/endpoints/AttributesEndpoint.ts

@@ -1,4 +1,6 @@
 import {
+    CanCreateRepositoryAttributeRequest,
+    CanCreateRepositoryAttributeResponse,
     ConnectorAttribute,
     ConnectorAttributeTagCollection,
     ConnectorAttributes,
@@ -25,6 +27,10 @@ import {
 import { Endpoint } from "./Endpoint";
 
 export class AttributesEndpoint extends Endpoint {
+    public async canCreateRepositoryAttribute(request: CanCreateRepositoryAttributeRequest): Promise<ConnectorHttpResponse<CanCreateRepositoryAttributeResponse>> {
+        return await this.put("/api/v2/Attributes/CanCreate", request);
+    }
+
     public async createRepositoryAttribute(request: CreateRepositoryAttributeRequest): Promise<ConnectorHttpResponse<ConnectorAttribute>> {
         return await this.post("/api/v2/Attributes", request);
     }

packages/sdk/src/types/attributes/index.ts

@@ -4,6 +4,8 @@ export * from "./ConnectorAttributeTagCollection";
 export * from "./IdentityAttributeQuery";
 export * from "./IQLQuery";
 export * from "./RelationshipAttributeQuery";
+export * from "./requests/CanCreateRepositoryAttributeRequest";
+export * from "./requests/CanCreateRepositoryAttributeResponse";
 export * from "./requests/CreateRepositoryAttributeRequest";
 export * from "./requests/DeleteOwnSharedAttributeAndNotifyPeerResponse";
 export * from "./requests/DeletePeerSharedAttributeAndNotifyOwnerResponse";

packages/sdk/src/types/attributes/requests/CanCreateRepositoryAttributeRequest.ts

@@ -0,0 +1,10 @@
+import { AttributeValues } from "@nmshd/content";
+
+export interface CanCreateRepositoryAttributeRequest {
+    content: {
+        value: AttributeValues.Identity.Json;
+        tags?: string[];
+        validFrom?: string;
+        validTo?: string;
+    };
+}

packages/sdk/src/types/attributes/requests/CanCreateRepositoryAttributeResponse.ts

@@ -0,0 +1,7 @@
+export type CanCreateRepositoryAttributeResponse =
+    | { isSuccess: true }
+    | {
+          isSuccess: false;
+          code: string;
+          message: string;
+      };

src/modules/coreHttpApi/controllers/AttributesController.ts

@@ -1,6 +1,6 @@
 import { ConsumptionServices, RuntimeErrors, TransportServices } from "@nmshd/runtime";
 import { Inject } from "@nmshd/typescript-ioc";
-import { Accept, Context, DELETE, GET, POST, Path, PathParam, QueryParam, Return, ServiceContext } from "@nmshd/typescript-rest";
+import { Accept, Context, DELETE, GET, POST, PUT, Path, PathParam, QueryParam, Return, ServiceContext } from "@nmshd/typescript-rest";
 import { Envelope } from "../../../infrastructure";
 import { BaseController } from "../common/BaseController";
 
@@ -13,6 +13,14 @@ export class AttributesController extends BaseController {
         super();
     }
 
+    @PUT
+    @Path("CanCreate")
+    @Accept("application/json")
+    public async canCreateRepositoryAttribute(request: any): Promise<Envelope> {
+        const result = await this.consumptionServices.attributes.canCreateRepositoryAttribute(request);
+        return this.ok(result);
+    }
+
     @POST
     @Accept("application/json")
     public async createRepositoryAttribute(request: any): Promise<Return.NewResource<Envelope>> {

src/modules/coreHttpApi/openapi.yml

@@ -257,6 +257,57 @@ paths:
 
   # ------------------- Attributes -------------------
 
+  /api/v2/Attributes/CanCreate:
+    put:
+      operationId: canCreateRepositoryAttribute
+      description: "Checks if a Repository Attribute can be created with the given parameters."
+      tags:
+        - Attributes
+      requestBody:
+        content:
+          application/json:
+            schema:
+              additionalProperties: false
+              properties:
+                content:
+                  type: object
+                  additionalProperties: false
+                  required:
+                    - value
+                  properties:
+                    value:
+                      $ref: "#/components/schemas/AttributeValue"
+                    tags:
+                      $ref: "#/components/schemas/IdentityAttributeContent_tags"
+                    validFrom:
+                      $ref: "#/components/schemas/AttributeContent_validFrom"
+                    validTo:
+                      $ref: "#/components/schemas/AttributeContent_validTo"
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    nullable: false
+                    $ref: "#/components/schemas/CanCreateRepositoryAttributeResponse"
+                required:
+                  - result
+          headers:
+            X-Response-Duration-ms:
+              schema:
+                $ref: "#/components/schemas/HeaderContent_X-Response-Duration-ms"
+            X-Response-Time:
+              schema:
+                $ref: "#/components/schemas/HeaderContent_X-Response-Time"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+
   /api/v2/Attributes:
     post:
       operationId: createRepositoryAttribute
@@ -5049,6 +5100,32 @@ components:
       required:
         - displayNames
 
+    CanCreateRepositoryAttributeResponse:
+      type: object
+      properties:
+        isSuccess:
+          type: boolean
+      oneOf:
+        - properties:
+            isSuccess:
+              const: true
+          required:
+            - isSuccess
+          additionalProperties: false
+
+        - properties:
+            isSuccess:
+              const: false
+            code:
+              type: string
+            message:
+              type: string
+          required:
+            - isSuccess
+            - code
+            - message
+          additionalProperties: false
+
     ConnectorHealth:
       type: object
       properties:

test/attributes.test.ts

@@ -40,6 +40,20 @@ beforeEach(async () => {
 });
 
 describe("Attributes", () => {
+    test("should check if a repository attribute can be created", async () => {
+        const canCreateAttributeResponse = await client1.attributes.canCreateRepositoryAttribute({
+            content: {
+                value: {
+                    "@type": "GivenName",
+                    value: "AGivenName"
+                },
+                tags: ["content:edu.de"]
+            }
+        });
+
+        expect(canCreateAttributeResponse.result.isSuccess).toBe(true);
+    });
+
     test("should create a repository attribute", async () => {
         const createAttributeResponse = await client1.attributes.createRepositoryAttribute({
             content: {