Chore(deps): bump the update-runtime group across 2 directories with …

…3 updates (#326)
nmshd · Dec 10, 2024 · 6c7eb6b · 6c7eb6b
1 parent bb1852e
commit 6c7eb6b
Show file tree

Hide file tree

Showing 10 changed files with 141 additions and 50 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -83,7 +83,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.10.0",
+        "@nmshd/runtime": "6.13.0",
         "@nmshd/typescript-ioc": "^3.2.4",
         "@nmshd/typescript-rest": "^3.0.5",
         "agentkeepalive": "4.5.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.10.0",
-        "@nmshd/core-types": "6.10.0",
+        "@nmshd/content": "6.13.0",
+        "@nmshd/core-types": "6.13.0",
         "@nmshd/typescript-rest-swagger": "^1.4.1",
         "@types/amqplib": "^0.10.6",
         "@types/compression": "^1.7.5",

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

diff --git a/packages/sdk/src/endpoints/AttributesEndpoint.ts b/packages/sdk/src/endpoints/AttributesEndpoint.ts
@@ -1,5 +1,6 @@
 import {
     ConnectorAttribute,
+    ConnectorAttributeTagCollection,
     ConnectorAttributes,
     ConnectorHttpResponse,
     CreateRepositoryAttributeRequest,
@@ -51,6 +52,10 @@ export class AttributesEndpoint extends Endpoint {
         return await this.get("/api/v2/Attributes/Valid", request);
     }
 
+    public async getAttributeTagCollection(): Promise<ConnectorHttpResponse<ConnectorAttributeTagCollection>> {
+        return await this.get("/api/v2/Attributes/TagCollection");
+    }
+
     public async getOwnRepositoryAttributes(request?: GetOwnRepositoryAttributesRequest): Promise<ConnectorHttpResponse<ConnectorAttributes>> {
         return await this.get("/api/v2/Attributes/Own/Repository", request);
     }

diff --git a/packages/sdk/src/types/attributes/ConnectorAttributeTagCollection.ts b/packages/sdk/src/types/attributes/ConnectorAttributeTagCollection.ts
@@ -0,0 +1,9 @@
+export interface ConnectorAttributeTagCollection {
+    supportedLanguages: string[];
+    tagsForAttributeValueTypes: Record<string, Record<string, ConnectorAttributeTag>>;
+}
+
+export interface ConnectorAttributeTag {
+    displayNames: Record<string, string>;
+    children?: Record<string, ConnectorAttributeTag>;
+}
diff --git a/packages/sdk/src/types/attributes/index.ts b/packages/sdk/src/types/attributes/index.ts
@@ -1,5 +1,6 @@
 export * from "./ConnectorAttribute";
 export * from "./ConnectorAttributes";
+export * from "./ConnectorAttributeTagCollection";
 export * from "./IdentityAttributeQuery";
 export * from "./IQLQuery";
 export * from "./RelationshipAttributeQuery";

diff --git a/src/modules/coreHttpApi/controllers/AttributesController.ts b/src/modules/coreHttpApi/controllers/AttributesController.ts
@@ -155,6 +155,14 @@ export class AttributesController extends BaseController {
         return this.ok(result);
     }
 
+    @GET
+    @Path("/TagCollection")
+    @Accept("application/json")
+    public async getAttributeTagCollection(): Promise<Envelope> {
+        const result = await this.consumptionServices.attributes.getAttributeTagCollection();
+        return this.ok(result);
+    }
+
     @POST
     @Path("/ExecuteIdentityAttributeQuery")
     @Accept("application/json")

diff --git a/src/modules/coreHttpApi/openapi.yml b/src/modules/coreHttpApi/openapi.yml
@@ -1268,6 +1268,38 @@ paths:
         403:
           $ref: "#/components/responses/Forbidden"
 
+  /api/v2/Attributes/TagCollection:
+    get:
+      operationId: getAttributeTagCollection
+      description: List valid Tags for Attributes
+      tags:
+        - Attributes
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/AttributeTagCollection"
+                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/ExecuteIdentityAttributeQuery:
     post:
       operationId: executeIdentityQuery
@@ -4875,6 +4907,48 @@ components:
       required:
         - "@type"
 
+    AttributeTagCollection:
+      type: object
+      additionalProperties: false
+      properties:
+        supportedLanguages:
+          type: array
+          items:
+            type: string
+          example: ["en", "de"]
+        tagsForAttributeValueTypes:
+          type: object
+          additionalProperties:
+            type: object
+            additionalProperties:
+              "$ref": "#/components/schemas/AttributeTag"
+          example:
+            PhoneNumber:
+              emergency:
+                displayNames: { de: "Notfallkontakt", en: "Emergency Contact" }
+                children:
+                  first: { displayNames: { de: "Erster Notfallkontakt", en: "First Emergency Contact" } }
+                  second: { displayNames: { de: "Zweiter Notfallkontakt", en: "Second Emergency Contact" } }
+              private: { displayNames: { de: "Privat", en: "Private" } }
+      required:
+        - supportedLanguages
+        - tagsForAttributeValueTypes
+
+    AttributeTag:
+      type: object
+      additionalProperties: false
+      properties:
+        children:
+          additionalProperties:
+            "$ref": "#/components/schemas/AttributeTag"
+          type: object
+        displayNames:
+          additionalProperties:
+            type: string
+          type: object
+      required:
+        - displayNames
+
     ConnectorHealth:
       type: object
       properties:

diff --git a/test/attributes.test.ts b/test/attributes.test.ts
@@ -623,3 +623,10 @@ describe("Delete attributes", () => {
         expect(client3DeletedAttribute.isError).toBe(true);
     });
 });
+
+describe("Attributes Tag Collection", () => {
+    test("should get all valid tags", async () => {
+        const response = await client1.attributes.getAttributeTagCollection();
+        expect(response).toBeSuccessful(ValidationSchema.ConnectorAttributeTagCollection);
+    });
+});
diff --git a/test/lib/validation.ts b/test/lib/validation.ts
@@ -36,6 +36,7 @@ export enum ValidationSchema {
     ConnectorRequests = "ConnectorRequests",
     ConnectorAttribute = "ConnectorAttribute",
     ConnectorAttributes = "ConnectorAttributes",
+    ConnectorAttributeTagCollection = "ConnectorAttributeTagCollection",
     SucceedAttributeResponse = "SucceedAttributeResponse"
 }