@nmshd/runtime 2.0.0-beta.23 → 2.0.0-beta.24

package/dist/useCases/common/Schemas.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.LoadItemFromTruncatedReferenceRequest = exports.DownloadFileRequest = 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.CreateOutgoingRequestRequest = exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = exports.CompleteOutgoingRequestRequest = exports.CompleteIncomingRequestRequest = exports.CheckPrerequisitesOfIncomingRequestRequest = exports.RejectIncomingRequestRequest = exports.CanCreateOutgoingRequestRequest = exports.AcceptIncomingRequestRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetSharedToPeerAttributesRequest = exports.GetPeerAttributesRequest = exports.GetAttributesRequest = exports.GetAttributeRequest = exports.ExecuteThirdPartyRelationshipAttributeQueryRequest = exports.ExecuteRelationshipAttributeQueryRequest = exports.ExecuteIdentityAttributeQueryRequest = exports.DeleteAttributeRequest = exports.CreateSharedAttributeCopyRequest = exports.CreateAttributeRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
-exports.LoadPeerTokenRequest = exports.LoadPeerTokenViaSecretRequest = exports.LoadPeerTokenViaReferenceRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.LoadPeerRelationshipTemplateViaReferenceRequest = exports.LoadPeerRelationshipTemplateViaSecretRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateQrCodeForOwnTemplateRequest = 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.UploadOwnFileValidatableRequest = exports.UploadOwnFileRequest = exports.GetOrLoadFileRequest = exports.GetOrLoadFileViaReferenceRequest = exports.GetOrLoadFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.CreateQrCodeForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = void 0;
+exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.LoadItemFromTruncatedReferenceRequest = exports.DownloadFileRequest = 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.DiscardOutgoingRequestRequest = exports.CreateOutgoingRequestRequest = exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = exports.CompleteOutgoingRequestRequest = exports.CompleteIncomingRequestRequest = exports.CheckPrerequisitesOfIncomingRequestRequest = exports.RejectIncomingRequestRequest = exports.CanCreateOutgoingRequestRequest = exports.AcceptIncomingRequestRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetSharedToPeerAttributesRequest = exports.GetPeerAttributesRequest = exports.GetAttributesRequest = exports.GetAttributeRequest = exports.ExecuteThirdPartyRelationshipAttributeQueryRequest = exports.ExecuteRelationshipAttributeQueryRequest = exports.ExecuteIdentityAttributeQueryRequest = exports.DeleteAttributeRequest = exports.CreateSharedAttributeCopyRequest = exports.CreateAttributeRequest = exports.GetAttributeListenerRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
+exports.LoadPeerTokenRequest = exports.LoadPeerTokenViaSecretRequest = exports.LoadPeerTokenViaReferenceRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.LoadPeerRelationshipTemplateViaReferenceRequest = exports.LoadPeerRelationshipTemplateViaSecretRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateQrCodeForOwnTemplateRequest = 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.UploadOwnFileValidatableRequest = exports.UploadOwnFileRequest = exports.GetOrLoadFileRequest = exports.GetOrLoadFileViaReferenceRequest = exports.GetOrLoadFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.CreateQrCodeForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = void 0;
 exports.LoadPeerTokenAnonymousByIdAndKeyRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/LoadPeerTokenAnonymousByIdAndKeyRequest",
@@ -50,6 +50,28 @@ exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = {
         }
     }
 };
+exports.GetAttributeListenerRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/GetAttributeListenerRequest",
+    "definitions": {
+        "GetAttributeListenerRequest": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "$ref": "#/definitions/AttributeListenerIdString"
+                }
+            },
+            "required": [
+                "id"
+            ],
+            "additionalProperties": false
+        },
+        "AttributeListenerIdString": {
+            "type": "string",
+            "pattern": "ATL[A-Za-z0-9]{17}"
+        }
+    }
+};
 exports.CreateAttributeRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/CreateAttributeRequest",
@@ -2067,6 +2089,9 @@ exports.CanCreateOutgoingRequestRequest = {
                 },
                 {
                     "$ref": "#/definitions/AuthenticationRequestItemJSON"
+                },
+                {
+                    "$ref": "#/definitions/RegisterAttributeListenerRequestItemJSON"
                 }
             ]
         },
@@ -2734,6 +2759,57 @@ exports.CanCreateOutgoingRequestRequest = {
             ],
             "additionalProperties": false
         },
+        "RegisterAttributeListenerRequestItemJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string",
+                    "const": "RegisterAttributeListenerRequestItem"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "metadata": {
+                    "type": "object",
+                    "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItemJSON RequestItem }  can only be accepted if the parent group is accepted as well."
+                },
+                "requireManualDecision": {
+                    "type": "boolean",
+                    "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
+                },
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IdentityAttributeQueryJSON"
+                        },
+                        {
+                            "$ref": "#/definitions/ThirdPartyRelationshipAttributeQueryJSON"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "@type",
+                "mustBeAccepted",
+                "query"
+            ],
+            "additionalProperties": false
+        },
         "IRequestItemGroup": {
             "type": "object",
             "properties": {
@@ -2790,6 +2866,9 @@ exports.CanCreateOutgoingRequestRequest = {
                 },
                 {
                     "$ref": "#/definitions/IAuthenticationRequestItem"
+                },
+                {
+                    "$ref": "#/definitions/IRegisterAttributeListenerRequestItem"
                 }
             ]
         },
@@ -3317,6 +3396,46 @@ exports.CanCreateOutgoingRequestRequest = {
                 "mustBeAccepted"
             ]
         },
+        "IRegisterAttributeListenerRequestItem": {
+            "type": "object",
+            "properties": {
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "metadata": {
+                    "type": "object",
+                    "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItem RequestItem }  can only be accepted if the parent group is accepted as well."
+                },
+                "requireManualDecision": {
+                    "type": "boolean",
+                    "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
+                },
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IIdentityAttributeQuery"
+                        },
+                        {
+                            "$ref": "#/definitions/IThirdPartyRelationshipAttributeQuery"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "mustBeAccepted",
+                "query"
+            ],
+            "additionalProperties": false
+        },
         "AddressString": {
             "type": "string",
             "pattern": "id1[A-Za-z0-9]{32,33}"
@@ -3597,6 +3716,9 @@ exports.CompleteOutgoingRequestRequest = {
                 },
                 {
                     "$ref": "#/definitions/ReadAttributeAcceptResponseItemJSON"
+                },
+                {
+                    "$ref": "#/definitions/RegisterAttributeListenerAcceptResponseItemJSON"
                 }
             ]
         },
@@ -3865,6 +3987,34 @@ exports.CompleteOutgoingRequestRequest = {
             ],
             "additionalProperties": false
         },
+        "RegisterAttributeListenerAcceptResponseItemJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string",
+                    "const": "RegisterAttributeListenerAcceptResponseItem"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "result": {
+                    "type": "string",
+                    "const": "Accepted"
+                },
+                "listenerId": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "@type",
+                "listenerId",
+                "result"
+            ],
+            "additionalProperties": false
+        },
         "RejectResponseItemJSONDerivations": {
             "$ref": "#/definitions/RejectResponseItemJSON"
         },
@@ -4147,6 +4297,9 @@ exports.CreateOutgoingRequestRequest = {
                 },
                 {
                     "$ref": "#/definitions/AuthenticationRequestItemJSON"
+                },
+                {
+                    "$ref": "#/definitions/RegisterAttributeListenerRequestItemJSON"
                 }
             ]
         },
@@ -4814,6 +4967,57 @@ exports.CreateOutgoingRequestRequest = {
             ],
             "additionalProperties": false
         },
+        "RegisterAttributeListenerRequestItemJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string",
+                    "const": "RegisterAttributeListenerRequestItem"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "metadata": {
+                    "type": "object",
+                    "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItemJSON RequestItem }  can only be accepted if the parent group is accepted as well."
+                },
+                "requireManualDecision": {
+                    "type": "boolean",
+                    "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
+                },
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IdentityAttributeQueryJSON"
+                        },
+                        {
+                            "$ref": "#/definitions/ThirdPartyRelationshipAttributeQueryJSON"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "@type",
+                "mustBeAccepted",
+                "query"
+            ],
+            "additionalProperties": false
+        },
         "IRequestItemGroup": {
             "type": "object",
             "properties": {
@@ -4870,6 +5074,9 @@ exports.CreateOutgoingRequestRequest = {
                 },
                 {
                     "$ref": "#/definitions/IAuthenticationRequestItem"
+                },
+                {
+                    "$ref": "#/definitions/IRegisterAttributeListenerRequestItem"
                 }
             ]
         },
@@ -5397,12 +5604,74 @@ exports.CreateOutgoingRequestRequest = {
                 "mustBeAccepted"
             ]
         },
+        "IRegisterAttributeListenerRequestItem": {
+            "type": "object",
+            "properties": {
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "metadata": {
+                    "type": "object",
+                    "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItem RequestItem }  can only be accepted if the parent group is accepted as well."
+                },
+                "requireManualDecision": {
+                    "type": "boolean",
+                    "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
+                },
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IIdentityAttributeQuery"
+                        },
+                        {
+                            "$ref": "#/definitions/IThirdPartyRelationshipAttributeQuery"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "mustBeAccepted",
+                "query"
+            ],
+            "additionalProperties": false
+        },
         "AddressString": {
             "type": "string",
             "pattern": "id1[A-Za-z0-9]{32,33}"
         }
     }
 };
+exports.DiscardOutgoingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/DiscardOutgoingRequestRequest",
+    "definitions": {
+        "DiscardOutgoingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "$ref": "#/definitions/RequestIdString"
+                }
+            },
+            "required": [
+                "id"
+            ],
+            "additionalProperties": false
+        },
+        "RequestIdString": {
+            "type": "string",
+            "pattern": "REQ[A-Za-z0-9]{17}"
+        }
+    }
+};
 exports.GetIncomingRequestRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/GetIncomingRequestRequest",
@@ -6001,6 +6270,9 @@ exports.ReceivedIncomingRequestRequest = {
                 },
                 {
                     "$ref": "#/definitions/AuthenticationRequestItemJSON"
+                },
+                {
+                    "$ref": "#/definitions/RegisterAttributeListenerRequestItemJSON"
                 }
             ]
         },
@@ -6668,6 +6940,57 @@ exports.ReceivedIncomingRequestRequest = {
             ],
             "additionalProperties": false
         },
+        "RegisterAttributeListenerRequestItemJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string",
+                    "const": "RegisterAttributeListenerRequestItem"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "metadata": {
+                    "type": "object",
+                    "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItemJSON RequestItem }  can only be accepted if the parent group is accepted as well."
+                },
+                "requireManualDecision": {
+                    "type": "boolean",
+                    "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
+                },
+                "query": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/IdentityAttributeQueryJSON"
+                        },
+                        {
+                            "$ref": "#/definitions/ThirdPartyRelationshipAttributeQueryJSON"
+                        }
+                    ]
+                }
+            },
+            "required": [
+                "@type",
+                "mustBeAccepted",
+                "query"
+            ],
+            "additionalProperties": false
+        },
         "MessageIdString": {
             "type": "string",
             "pattern": "MSG[A-Za-z0-9]{17}"