@nmshd/runtime 2.0.0-alpha.13 → 2.0.0-alpha.16

package/dist/useCases/common/Schemas.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateTokenForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.DownloadFileRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.UpdateSettingRequest = exports.GetSettingsRequest = exports.GetSettingRequest = exports.DeleteSettingRequest = exports.CreateSettingRequest = exports.SentOutgoingRequestRequest = exports.RequireManualDecisionOfIncomingRequestRequest = exports.ReceivedIncomingRequestRequest = exports.GetOutgoingRequestsRequest = exports.GetOutgoingRequestRequest = exports.GetIncomingRequestsRequest = exports.GetIncomingRequestRequest = exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = exports.CompleteOutgoingRequestRequest = exports.CompleteIncomingRequestRequest = exports.CheckPrerequisitesOfIncomingRequestRequest = exports.RejectIncomingRequestRequest = exports.CreateOutgoingRequestRequest = exports.AcceptIncomingRequestRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetAttributesRequest = exports.GetAttributeRequest = exports.DeleteAttributeRequest = exports.CreateShareAttributeCopyRequest = exports.CreateAttributeRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
-exports.LoadPeerTokenRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateOwnRelationshipTemplateRequest = exports.RevokeRelationshipChangeRequest = exports.RejectRelationshipChangeRequest = exports.GetRelationshipsRequest = exports.GetRelationshipByAddressRequest = exports.GetRelationshipRequest = exports.CreateRelationshipChangeRequest = exports.CreateRelationshipRequest = exports.AcceptRelationshipChangeRequest = exports.SendMessageRequest = exports.GetMessagesRequest = exports.GetMessageRequest = exports.GetAttachmentMetadataRequest = exports.CheckIdentityRequest = exports.UploadOwnFileRequest = exports.LoadPeerFileRequest = exports.LoadPeerFileViaReferenceRequest = exports.LoadPeerFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = void 0;
+exports.GetDeviceRequest = exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.DownloadFileRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.UpdateSettingRequest = exports.GetSettingsRequest = exports.GetSettingRequest = exports.DeleteSettingRequest = exports.CreateSettingRequest = exports.SentOutgoingRequestRequest = exports.RequireManualDecisionOfIncomingRequestRequest = exports.ReceivedIncomingRequestRequest = exports.GetOutgoingRequestsRequest = exports.GetOutgoingRequestRequest = exports.GetIncomingRequestsRequest = exports.GetIncomingRequestRequest = exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = exports.CompleteOutgoingRequestRequest = exports.CompleteIncomingRequestRequest = exports.CheckPrerequisitesOfIncomingRequestRequest = exports.RejectIncomingRequestRequest = exports.CreateOutgoingRequestRequest = exports.AcceptIncomingRequestRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetValidAttributesRequest = exports.GetAttributesRequest = exports.GetAttributeRequest = exports.ExecuteRelationshipAttributeQueryRequest = exports.ExecuteIdentityAttributeQueryRequest = exports.DeleteAttributeRequest = exports.CreateShareAttributeCopyRequest = exports.CreateAttributeRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
+exports.LoadPeerTokenRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateOwnRelationshipTemplateRequest = exports.RevokeRelationshipChangeRequest = exports.RejectRelationshipChangeRequest = exports.GetRelationshipsRequest = exports.GetRelationshipByAddressRequest = exports.GetRelationshipRequest = exports.GetAttributesForRelationshipRequest = exports.CreateRelationshipChangeRequest = exports.CreateRelationshipRequest = exports.AcceptRelationshipChangeRequest = exports.SendMessageRequest = exports.GetMessagesRequest = exports.GetMessageRequest = exports.GetAttachmentMetadataRequest = exports.CheckIdentityRequest = exports.UploadOwnFileRequest = exports.LoadPeerFileRequest = exports.LoadPeerFileViaReferenceRequest = exports.LoadPeerFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = void 0;
 exports.LoadPeerTokenAnonymousByIdAndKeyRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/LoadPeerTokenAnonymousByIdAndKeyRequest",
@@ -232,6 +232,392 @@ exports.DeleteAttributeRequest = {
         }
     }
 };
+exports.ExecuteIdentityAttributeQueryRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/ExecuteIdentityAttributeQueryRequest",
+    "definitions": {
+        "ExecuteIdentityAttributeQueryRequest": {
+            "type": "object",
+            "properties": {
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IIdentityAttributeQuery"
+                        },
+                        {
+                            "$ref": "#/definitions/IdentityAttributeQueryJSON"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "query"
+            ],
+            "additionalProperties": false
+        },
+        "IIdentityAttributeQuery": {
+            "type": "object",
+            "properties": {
+                "valueType": {
+                    "type": "string"
+                },
+                "validFrom": {
+                    "$ref": "#/definitions/ICoreDate"
+                },
+                "validTo": {
+                    "$ref": "#/definitions/ICoreDate"
+                },
+                "tags": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "additionalProperties": false
+        },
+        "ICoreDate": {
+            "type": "object",
+            "properties": {
+                "date": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "date"
+            ],
+            "additionalProperties": false
+        },
+        "IdentityAttributeQueryJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "valueType": {
+                    "type": "string"
+                },
+                "validFrom": {
+                    "type": "string"
+                },
+                "validTo": {
+                    "type": "string"
+                },
+                "tags": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "@type"
+            ]
+        }
+    }
+};
+exports.ExecuteRelationshipAttributeQueryRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/ExecuteRelationshipAttributeQueryRequest",
+    "definitions": {
+        "ExecuteRelationshipAttributeQueryRequest": {
+            "type": "object",
+            "properties": {
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IRelationshipAttributeQuery"
+                        },
+                        {
+                            "$ref": "#/definitions/RelationshipAttributeQueryJSON"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "query"
+            ],
+            "additionalProperties": false
+        },
+        "IRelationshipAttributeQuery": {
+            "type": "object",
+            "properties": {
+                "valueType": {
+                    "type": "string"
+                },
+                "validFrom": {
+                    "$ref": "#/definitions/ICoreDate"
+                },
+                "validTo": {
+                    "$ref": "#/definitions/ICoreDate"
+                },
+                "key": {
+                    "type": "string"
+                },
+                "owner": {
+                    "$ref": "#/definitions/ICoreAddress"
+                },
+                "attributeHints": {
+                    "$ref": "#/definitions/IRelationshipAttributeHints"
+                },
+                "thirdParty": {
+                    "$ref": "#/definitions/ICoreAddress"
+                }
+            },
+            "required": [
+                "key",
+                "owner",
+                "attributeHints"
+            ],
+            "additionalProperties": false
+        },
+        "ICoreDate": {
+            "type": "object",
+            "properties": {
+                "date": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "date"
+            ],
+            "additionalProperties": false
+        },
+        "ICoreAddress": {
+            "type": "object",
+            "properties": {
+                "address": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "address"
+            ],
+            "additionalProperties": false
+        },
+        "IRelationshipAttributeHints": {
+            "type": "object",
+            "properties": {
+                "title": {
+                    "type": "string"
+                },
+                "description": {
+                    "type": "string"
+                },
+                "valueHints": {
+                    "$ref": "#/definitions/IValueHints"
+                },
+                "isTechnical": {
+                    "type": "boolean"
+                },
+                "confidentiality": {
+                    "$ref": "#/definitions/RelationshipAttributeConfidentiality"
+                }
+            },
+            "required": [
+                "title",
+                "confidentiality"
+            ],
+            "additionalProperties": false
+        },
+        "IValueHints": {
+            "type": "object",
+            "properties": {
+                "editHelp": {
+                    "type": "string"
+                },
+                "min": {
+                    "type": "number"
+                },
+                "max": {
+                    "type": "number"
+                },
+                "pattern": {
+                    "type": "string"
+                },
+                "values": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/IValueHintsValue"
+                    }
+                },
+                "defaultValue": {
+                    "type": [
+                        "string",
+                        "number",
+                        "boolean"
+                    ]
+                }
+            },
+            "additionalProperties": false
+        },
+        "IValueHintsValue": {
+            "type": "object",
+            "properties": {
+                "key": {
+                    "type": [
+                        "string",
+                        "number",
+                        "boolean"
+                    ]
+                },
+                "displayName": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "key",
+                "displayName"
+            ],
+            "additionalProperties": false
+        },
+        "RelationshipAttributeConfidentiality": {
+            "type": "string",
+            "enum": [
+                "public",
+                "private",
+                "protected"
+            ]
+        },
+        "RelationshipAttributeQueryJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "valueType": {
+                    "type": "string"
+                },
+                "validFrom": {
+                    "type": "string"
+                },
+                "validTo": {
+                    "type": "string"
+                },
+                "key": {
+                    "type": "string"
+                },
+                "owner": {
+                    "type": "string"
+                },
+                "attributeHints": {
+                    "$ref": "#/definitions/RelationshipAttributeHintsJSON"
+                },
+                "thirdParty": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "@type",
+                "attributeHints",
+                "key",
+                "owner"
+            ],
+            "additionalProperties": false
+        },
+        "RelationshipAttributeHintsJSON": {
+            "type": "object",
+            "properties": {
+                "title": {
+                    "type": "string"
+                },
+                "description": {
+                    "type": "string"
+                },
+                "valueHints": {
+                    "$ref": "#/definitions/ValueHintsJSON"
+                },
+                "isTechnical": {
+                    "type": "boolean"
+                },
+                "confidentiality": {
+                    "$ref": "#/definitions/RelationshipAttributeConfidentiality"
+                }
+            },
+            "required": [
+                "title",
+                "confidentiality"
+            ],
+            "additionalProperties": false
+        },
+        "ValueHintsJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "editHelp": {
+                    "type": "string"
+                },
+                "min": {
+                    "type": "number"
+                },
+                "max": {
+                    "type": "number"
+                },
+                "pattern": {
+                    "type": "string"
+                },
+                "values": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ValueHintsValueJSON"
+                    }
+                },
+                "defaultValue": {
+                    "type": [
+                        "string",
+                        "number",
+                        "boolean"
+                    ]
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "@type"
+            ]
+        },
+        "ValueHintsValueJSON": {
+            "type": "object",
+            "properties": {
+                "key": {
+                    "type": [
+                        "string",
+                        "number",
+                        "boolean"
+                    ]
+                },
+                "displayName": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "key",
+                "displayName"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
 exports.GetAttributeRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/GetAttributeRequest",
@@ -259,12 +645,12 @@ exports.GetAttributesRequest = {
             "type": "object",
             "properties": {
                 "query": {
-                    "$ref": "#/definitions/ConsumptionAttributeQuery"
+                    "$ref": "#/definitions/GetAttributesRequestQuery"
                 }
             },
             "additionalProperties": false
         },
-        "ConsumptionAttributeQuery": {
+        "GetAttributesRequestQuery": {
             "type": "object",
             "properties": {
                 "createdAt": {
@@ -346,6 +732,92 @@ exports.GetAttributesRequest = {
         }
     }
 };
+exports.GetValidAttributesRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/GetValidAttributesRequest",
+    "definitions": {
+        "GetValidAttributesRequest": {
+            "type": "object",
+            "properties": {
+                "query": {
+                    "$ref": "#/definitions/GetValidAttributesRequestQuery"
+                }
+            },
+            "additionalProperties": false
+        },
+        "GetValidAttributesRequestQuery": {
+            "type": "object",
+            "properties": {
+                "content": {
+                    "type": "object",
+                    "properties": {
+                        "@type": {
+                            "type": "string"
+                        },
+                        "tags": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "owner": {
+                            "type": "string"
+                        },
+                        "key": {
+                            "type": "string"
+                        },
+                        "isTechnical": {
+                            "type": "boolean"
+                        },
+                        "confidentiality": {
+                            "$ref": "#/definitions/RelationshipAttributeConfidentiality"
+                        },
+                        "value": {
+                            "type": "object",
+                            "properties": {
+                                "@type": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": false
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "succeeds": {
+                    "type": "string"
+                },
+                "succeededBy": {
+                    "type": "string"
+                },
+                "shareInfo": {
+                    "type": "object",
+                    "properties": {
+                        "requestReference": {
+                            "type": "string"
+                        },
+                        "peer": {
+                            "type": "string"
+                        },
+                        "sourceAttribute": {
+                            "type": "string"
+                        }
+                    },
+                    "additionalProperties": false
+                }
+            },
+            "additionalProperties": {}
+        },
+        "RelationshipAttributeConfidentiality": {
+            "type": "string",
+            "enum": [
+                "public",
+                "private",
+                "protected"
+            ]
+        }
+    }
+};
 exports.SucceedAttributeRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/SucceedAttributeRequest",
@@ -1159,7 +1631,7 @@ exports.CheckPrerequisitesOfIncomingRequestRequest = {
             "properties": {
                 "requestId": {
                     "type": "string",
-                    "pattern": "REQ[A-Za-z0-9]{14}"
+                    "pattern": "REQ[A-Za-z0-9]{17}"
                 }
             },
             "required": [
@@ -1200,10 +1672,6 @@ exports.CompleteOutgoingRequestRequest = {
         "CompleteOutgoingRequestRequest": {
             "type": "object",
             "properties": {
-                "requestId": {
-                    "type": "string",
-                    "pattern": "REQ[A-Za-z0-9]{14}"
-                },
                 "receivedResponse": {
                     "$ref": "#/definitions/ResponseJSON"
                 },
@@ -1213,7 +1681,6 @@ exports.CompleteOutgoingRequestRequest = {
                 }
             },
             "required": [
-                "requestId",
                 "receivedResponse",
                 "messageId"
             ],
@@ -1365,7 +1832,7 @@ exports.GetIncomingRequestRequest = {
             "properties": {
                 "id": {
                     "type": "string",
-                    "pattern": "REQ[A-Za-z0-9]{14}"
+                    "pattern": "REQ[A-Za-z0-9]{17}"
                 }
             },
             "required": [
@@ -1383,12 +1850,12 @@ exports.GetIncomingRequestsRequest = {
             "type": "object",
             "properties": {
                 "query": {
-                    "$ref": "#/definitions/GetIncomingRequestsRequestsQuery"
+                    "$ref": "#/definitions/GetIncomingRequestsRequestQuery"
                 }
             },
             "additionalProperties": false
         },
-        "GetIncomingRequestsRequestsQuery": {
+        "GetIncomingRequestsRequestQuery": {
             "type": "object",
             "properties": {
                 "id": {
@@ -1495,7 +1962,7 @@ exports.GetOutgoingRequestRequest = {
             "properties": {
                 "id": {
                     "type": "string",
-                    "pattern": "REQ[A-Za-z0-9]{14}"
+                    "pattern": "REQ[A-Za-z0-9]{17}"
                 }
             },
             "required": [
@@ -1629,7 +2096,7 @@ exports.ReceivedIncomingRequestRequest = {
                 "requestSourceId": {
                     "type": "string",
                     "description": "The id of the Message or RelationshipTemplate in which the Response was received.",
-                    "pattern": "(MSG|RLT)[A-Za-z0-9]{14}"
+                    "pattern": "(MSG|RLT)[A-Za-z0-9]{17}"
                 }
             },
             "required": [
@@ -1773,7 +2240,7 @@ exports.RequireManualDecisionOfIncomingRequestRequest = {
             "properties": {
                 "requestId": {
                     "type": "string",
-                    "pattern": "REQ[A-Za-z0-9]{14}"
+                    "pattern": "REQ[A-Za-z0-9]{17}"
                 }
             },
             "required": [
@@ -1792,7 +2259,7 @@ exports.SentOutgoingRequestRequest = {
             "properties": {
                 "requestId": {
                     "type": "string",
-                    "pattern": "REQ[A-Za-z0-9]{14}"
+                    "pattern": "REQ[A-Za-z0-9]{17}"
                 },
                 "messageId": {
                     "type": "string",
@@ -2681,6 +3148,24 @@ exports.CreateRelationshipChangeRequest = {
         }
     }
 };
+exports.GetAttributesForRelationshipRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/GetAttributesForRelationshipRequest",
+    "definitions": {
+        "GetAttributesForRelationshipRequest": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "id"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
 exports.GetRelationshipRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/GetRelationshipRequest",