@nmshd/runtime 2.0.0-beta.18 → 2.0.0-beta.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/dist/buildInformation.js +5 -5
  2. package/dist/dataViews/DataViewExpander.js +7 -12
  3. package/dist/dataViews/DataViewExpander.js.map +1 -1
  4. package/dist/dataViews/consumption/DecidableRequestItemDVOs.d.ts +5 -7
  5. package/dist/dataViews/content/RequestItemDVOs.d.ts +4 -7
  6. package/dist/events/consumption/MessageProcessedEvent.d.ts +5 -4
  7. package/dist/events/consumption/MessageProcessedEvent.js +4 -3
  8. package/dist/events/consumption/MessageProcessedEvent.js.map +1 -1
  9. package/dist/events/consumption/index.d.ts +1 -0
  10. package/dist/events/consumption/index.js +1 -0
  11. package/dist/events/consumption/index.js.map +1 -1
  12. package/dist/modules/DeciderModule.d.ts +2 -0
  13. package/dist/modules/DeciderModule.js +23 -8
  14. package/dist/modules/DeciderModule.js.map +1 -1
  15. package/dist/modules/RequestModule.js +1 -2
  16. package/dist/modules/RequestModule.js.map +1 -1
  17. package/dist/useCases/common/Schemas.js +373 -173
  18. package/dist/useCases/common/Schemas.js.map +1 -1
  19. package/lib-web/nmshd.runtime.js +414 -203
  20. package/lib-web/nmshd.runtime.js.map +1 -1
  21. package/lib-web/nmshd.runtime.min.js +3 -3
  22. package/lib-web/nmshd.runtime.min.js.map +1 -1
  23. package/package.json +4 -4
package/dist/useCases/common/Schemas.js CHANGED
@@ -1928,7 +1928,7 @@ exports.CreateOutgoingRequestRequest = {
1928
1928
  "mustBeAccepted"
1929
1929
  ],
1930
1930
  "additionalProperties": false,
1931
- "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
1931
+ "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateRelationshipAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
1932
1932
  },
1933
1933
  "RequestItemJSONDerivations": {
1934
1934
  "anyOf": [
@@ -1936,7 +1936,10 @@ exports.CreateOutgoingRequestRequest = {
1936
1936
  "$ref": "#/definitions/RequestItemJSON"
1937
1937
  },
1938
1938
  {
1939
- "$ref": "#/definitions/CreateAttributeRequestItemJSON"
1939
+ "$ref": "#/definitions/CreateRelationshipAttributeRequestItemJSON"
1940
+ },
1941
+ {
1942
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
1940
1943
  },
1941
1944
  {
1942
1945
  "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
@@ -1945,10 +1948,10 @@ exports.CreateOutgoingRequestRequest = {
1945
1948
  "$ref": "#/definitions/ReadAttributeRequestItemJSON"
1946
1949
  },
1947
1950
  {
1948
- "$ref": "#/definitions/ShareAttributeRequestItemJSON"
1951
+ "$ref": "#/definitions/ConsentRequestItemJSON"
1949
1952
  },
1950
1953
  {
1951
- "$ref": "#/definitions/ConsentRequestItemJSON"
1954
+ "$ref": "#/definitions/AuthenticationRequestItemJSON"
1952
1955
  }
1953
1956
  ]
1954
1957
  },
@@ -1979,6 +1982,10 @@ exports.CreateOutgoingRequestRequest = {
1979
1982
  "mustBeAccepted": {
1980
1983
  "type": "boolean",
1981
1984
  "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."
1985
+ },
1986
+ "requireManualDecision": {
1987
+ "type": "boolean",
1988
+ "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."
1982
1989
  }
1983
1990
  },
1984
1991
  "required": [
@@ -1987,7 +1994,7 @@ exports.CreateOutgoingRequestRequest = {
1987
1994
  ],
1988
1995
  "additionalProperties": false
1989
1996
  },
1990
- "CreateAttributeRequestItemJSON": {
1997
+ "CreateRelationshipAttributeRequestItemJSON": {
1991
1998
  "type": "object",
1992
1999
  "properties": {
1993
2000
  "@type": {
@@ -2015,18 +2022,12 @@ exports.CreateOutgoingRequestRequest = {
2015
2022
  "type": "boolean",
2016
2023
  "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."
2017
2024
  },
2018
- "attribute": {
2019
- "anyOf": [
2020
- {
2021
- "$ref": "#/definitions/IdentityAttributeJSON"
2022
- },
2023
- {
2024
- "$ref": "#/definitions/RelationshipAttributeJSON"
2025
- }
2026
- ]
2025
+ "requireManualDecision": {
2026
+ "type": "boolean",
2027
+ "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."
2027
2028
  },
2028
- "sourceAttributeId": {
2029
- "type": "string"
2029
+ "attribute": {
2030
+ "$ref": "#/definitions/RelationshipAttributeJSON"
2030
2031
  }
2031
2032
  },
2032
2033
  "required": [
@@ -2036,7 +2037,7 @@ exports.CreateOutgoingRequestRequest = {
2036
2037
  ],
2037
2038
  "additionalProperties": false
2038
2039
  },
2039
- "IdentityAttributeJSON": {
2040
+ "RelationshipAttributeJSON": {
2040
2041
  "type": "object",
2041
2042
  "properties": {
2042
2043
  "@type": {
@@ -2060,15 +2061,20 @@ exports.CreateOutgoingRequestRequest = {
2060
2061
  "value": {
2061
2062
  "$ref": "#/definitions/AbstractAttributeValueJSON"
2062
2063
  },
2063
- "tags": {
2064
- "type": "array",
2065
- "items": {
2066
- "type": "string"
2067
- }
2064
+ "key": {
2065
+ "type": "string"
2066
+ },
2067
+ "isTechnical": {
2068
+ "type": "boolean"
2069
+ },
2070
+ "confidentiality": {
2071
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2068
2072
  }
2069
2073
  },
2070
2074
  "required": [
2071
2075
  "@type",
2076
+ "confidentiality",
2077
+ "key",
2072
2078
  "owner",
2073
2079
  "value"
2074
2080
  ],
@@ -2091,7 +2097,69 @@ exports.CreateOutgoingRequestRequest = {
2091
2097
  "@type"
2092
2098
  ]
2093
2099
  },
2094
- "RelationshipAttributeJSON": {
2100
+ "RelationshipAttributeConfidentiality": {
2101
+ "type": "string",
2102
+ "enum": [
2103
+ "public",
2104
+ "private",
2105
+ "protected"
2106
+ ]
2107
+ },
2108
+ "ShareAttributeRequestItemJSON": {
2109
+ "type": "object",
2110
+ "properties": {
2111
+ "@type": {
2112
+ "type": "string"
2113
+ },
2114
+ "@context": {
2115
+ "type": "string"
2116
+ },
2117
+ "@version": {
2118
+ "type": "string"
2119
+ },
2120
+ "title": {
2121
+ "type": "string",
2122
+ "description": "The human-readable title of this item."
2123
+ },
2124
+ "description": {
2125
+ "type": "string",
2126
+ "description": "The human-readable description of this item."
2127
+ },
2128
+ "metadata": {
2129
+ "type": "object",
2130
+ "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."
2131
+ },
2132
+ "mustBeAccepted": {
2133
+ "type": "boolean",
2134
+ "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."
2135
+ },
2136
+ "requireManualDecision": {
2137
+ "type": "boolean",
2138
+ "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."
2139
+ },
2140
+ "attribute": {
2141
+ "anyOf": [
2142
+ {
2143
+ "$ref": "#/definitions/IdentityAttributeJSON"
2144
+ },
2145
+ {
2146
+ "$ref": "#/definitions/RelationshipAttributeJSON"
2147
+ }
2148
+ ]
2149
+ },
2150
+ "sourceAttributeId": {
2151
+ "type": "string"
2152
+ }
2153
+ },
2154
+ "required": [
2155
+ "@type",
2156
+ "attribute",
2157
+ "mustBeAccepted",
2158
+ "sourceAttributeId"
2159
+ ],
2160
+ "additionalProperties": false
2161
+ },
2162
+ "IdentityAttributeJSON": {
2095
2163
  "type": "object",
2096
2164
  "properties": {
2097
2165
  "@type": {
@@ -2115,33 +2183,20 @@ exports.CreateOutgoingRequestRequest = {
2115
2183
  "value": {
2116
2184
  "$ref": "#/definitions/AbstractAttributeValueJSON"
2117
2185
  },
2118
- "key": {
2119
- "type": "string"
2120
- },
2121
- "isTechnical": {
2122
- "type": "boolean"
2123
- },
2124
- "confidentiality": {
2125
- "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2186
+ "tags": {
2187
+ "type": "array",
2188
+ "items": {
2189
+ "type": "string"
2190
+ }
2126
2191
  }
2127
2192
  },
2128
2193
  "required": [
2129
2194
  "@type",
2130
- "confidentiality",
2131
- "key",
2132
2195
  "owner",
2133
2196
  "value"
2134
2197
  ],
2135
2198
  "additionalProperties": false
2136
2199
  },
2137
- "RelationshipAttributeConfidentiality": {
2138
- "type": "string",
2139
- "enum": [
2140
- "public",
2141
- "private",
2142
- "protected"
2143
- ]
2144
- },
2145
2200
  "ProposeAttributeRequestItemJSON": {
2146
2201
  "type": "object",
2147
2202
  "properties": {
@@ -2170,6 +2225,10 @@ exports.CreateOutgoingRequestRequest = {
2170
2225
  "type": "boolean",
2171
2226
  "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."
2172
2227
  },
2228
+ "requireManualDecision": {
2229
+ "type": "boolean",
2230
+ "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."
2231
+ },
2173
2232
  "query": {
2174
2233
  "anyOf": [
2175
2234
  {
@@ -2398,6 +2457,10 @@ exports.CreateOutgoingRequestRequest = {
2398
2457
  "type": "boolean",
2399
2458
  "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."
2400
2459
  },
2460
+ "requireManualDecision": {
2461
+ "type": "boolean",
2462
+ "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."
2463
+ },
2401
2464
  "query": {
2402
2465
  "$ref": "#/definitions/AbstractAttributeQueryJSON"
2403
2466
  }
@@ -2437,7 +2500,7 @@ exports.CreateOutgoingRequestRequest = {
2437
2500
  ],
2438
2501
  "additionalProperties": false
2439
2502
  },
2440
- "ShareAttributeRequestItemJSON": {
2503
+ "ConsentRequestItemJSON": {
2441
2504
  "type": "object",
2442
2505
  "properties": {
2443
2506
  "@type": {
@@ -2465,23 +2528,27 @@ exports.CreateOutgoingRequestRequest = {
2465
2528
  "type": "boolean",
2466
2529
  "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."
2467
2530
  },
2468
- "attributeId": {
2531
+ "requireManualDecision": {
2532
+ "type": "boolean",
2533
+ "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."
2534
+ },
2535
+ "consent": {
2469
2536
  "type": "string"
2470
2537
  },
2471
- "shareWith": {
2538
+ "link": {
2472
2539
  "type": "string"
2473
2540
  }
2474
2541
  },
2475
2542
  "required": [
2476
2543
  "@type",
2477
- "attributeId",
2478
- "mustBeAccepted",
2479
- "shareWith"
2544
+ "consent",
2545
+ "mustBeAccepted"
2480
2546
  ],
2481
2547
  "additionalProperties": false
2482
2548
  },
2483
- "ConsentRequestItemJSON": {
2549
+ "AuthenticationRequestItemJSON": {
2484
2550
  "type": "object",
2551
+ "additionalProperties": false,
2485
2552
  "properties": {
2486
2553
  "@type": {
2487
2554
  "type": "string"
@@ -2508,22 +2575,15 @@ exports.CreateOutgoingRequestRequest = {
2508
2575
  "type": "boolean",
2509
2576
  "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."
2510
2577
  },
2511
- "consent": {
2512
- "type": "string"
2513
- },
2514
- "link": {
2515
- "type": "string"
2516
- },
2517
- "requireActiveConsent": {
2518
- "type": "boolean"
2578
+ "requireManualDecision": {
2579
+ "type": "boolean",
2580
+ "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."
2519
2581
  }
2520
2582
  },
2521
2583
  "required": [
2522
2584
  "@type",
2523
- "consent",
2524
2585
  "mustBeAccepted"
2525
- ],
2526
- "additionalProperties": false
2586
+ ]
2527
2587
  },
2528
2588
  "IRequestItemGroup": {
2529
2589
  "type": "object",
@@ -2557,7 +2617,7 @@ exports.CreateOutgoingRequestRequest = {
2557
2617
  "items"
2558
2618
  ],
2559
2619
  "additionalProperties": false,
2560
- "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
2620
+ "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateRelationshipAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
2561
2621
  },
2562
2622
  "IRequestItemDerivations": {
2563
2623
  "anyOf": [
@@ -2565,7 +2625,10 @@ exports.CreateOutgoingRequestRequest = {
2565
2625
  "$ref": "#/definitions/IRequestItem"
2566
2626
  },
2567
2627
  {
2568
- "$ref": "#/definitions/ICreateAttributeRequestItem"
2628
+ "$ref": "#/definitions/ICreateRelationshipAttributeRequestItem"
2629
+ },
2630
+ {
2631
+ "$ref": "#/definitions/IShareAttributeRequestItem"
2569
2632
  },
2570
2633
  {
2571
2634
  "$ref": "#/definitions/IProposeAttributeRequestItem"
@@ -2574,10 +2637,10 @@ exports.CreateOutgoingRequestRequest = {
2574
2637
  "$ref": "#/definitions/IReadAttributeRequestItem"
2575
2638
  },
2576
2639
  {
2577
- "$ref": "#/definitions/IShareAttributeRequestItem"
2640
+ "$ref": "#/definitions/IConsentRequestItem"
2578
2641
  },
2579
2642
  {
2580
- "$ref": "#/definitions/IConsentRequestItem"
2643
+ "$ref": "#/definitions/IAuthenticationRequestItem"
2581
2644
  }
2582
2645
  ]
2583
2646
  },
@@ -2599,6 +2662,10 @@ exports.CreateOutgoingRequestRequest = {
2599
2662
  "mustBeAccepted": {
2600
2663
  "type": "boolean",
2601
2664
  "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."
2665
+ },
2666
+ "requireManualDecision": {
2667
+ "type": "boolean",
2668
+ "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."
2602
2669
  }
2603
2670
  },
2604
2671
  "required": [
@@ -2606,7 +2673,7 @@ exports.CreateOutgoingRequestRequest = {
2606
2673
  ],
2607
2674
  "additionalProperties": false
2608
2675
  },
2609
- "ICreateAttributeRequestItem": {
2676
+ "ICreateRelationshipAttributeRequestItem": {
2610
2677
  "type": "object",
2611
2678
  "properties": {
2612
2679
  "title": {
@@ -2625,18 +2692,12 @@ exports.CreateOutgoingRequestRequest = {
2625
2692
  "type": "boolean",
2626
2693
  "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."
2627
2694
  },
2628
- "attribute": {
2629
- "anyOf": [
2630
- {
2631
- "$ref": "#/definitions/IIdentityAttribute"
2632
- },
2633
- {
2634
- "$ref": "#/definitions/IRelationshipAttribute"
2635
- }
2636
- ]
2695
+ "requireManualDecision": {
2696
+ "type": "boolean",
2697
+ "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."
2637
2698
  },
2638
- "sourceAttributeId": {
2639
- "$ref": "#/definitions/ICoreId"
2699
+ "attribute": {
2700
+ "$ref": "#/definitions/IRelationshipAttribute"
2640
2701
  }
2641
2702
  },
2642
2703
  "required": [
@@ -2645,7 +2706,7 @@ exports.CreateOutgoingRequestRequest = {
2645
2706
  ],
2646
2707
  "additionalProperties": false
2647
2708
  },
2648
- "IIdentityAttribute": {
2709
+ "IRelationshipAttribute": {
2649
2710
  "type": "object",
2650
2711
  "properties": {
2651
2712
  "owner": {
@@ -2660,14 +2721,19 @@ exports.CreateOutgoingRequestRequest = {
2660
2721
  "value": {
2661
2722
  "$ref": "#/definitions/IAbstractAttributeValue"
2662
2723
  },
2663
- "tags": {
2664
- "type": "array",
2665
- "items": {
2666
- "type": "string"
2667
- }
2724
+ "key": {
2725
+ "type": "string"
2726
+ },
2727
+ "isTechnical": {
2728
+ "type": "boolean"
2729
+ },
2730
+ "confidentiality": {
2731
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2668
2732
  }
2669
2733
  },
2670
2734
  "required": [
2735
+ "confidentiality",
2736
+ "key",
2671
2737
  "owner",
2672
2738
  "value"
2673
2739
  ],
@@ -2690,7 +2756,51 @@ exports.CreateOutgoingRequestRequest = {
2690
2756
  "additionalProperties": false,
2691
2757
  "properties": {}
2692
2758
  },
2693
- "IRelationshipAttribute": {
2759
+ "IShareAttributeRequestItem": {
2760
+ "type": "object",
2761
+ "properties": {
2762
+ "title": {
2763
+ "type": "string",
2764
+ "description": "The human-readable title of this item."
2765
+ },
2766
+ "description": {
2767
+ "type": "string",
2768
+ "description": "The human-readable description of this item."
2769
+ },
2770
+ "metadata": {
2771
+ "type": "object",
2772
+ "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."
2773
+ },
2774
+ "mustBeAccepted": {
2775
+ "type": "boolean",
2776
+ "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."
2777
+ },
2778
+ "requireManualDecision": {
2779
+ "type": "boolean",
2780
+ "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."
2781
+ },
2782
+ "attribute": {
2783
+ "anyOf": [
2784
+ {
2785
+ "$ref": "#/definitions/IIdentityAttribute"
2786
+ },
2787
+ {
2788
+ "$ref": "#/definitions/IRelationshipAttribute"
2789
+ }
2790
+ ]
2791
+ },
2792
+ "sourceAttributeId": {
2793
+ "$ref": "#/definitions/ICoreId"
2794
+ }
2795
+ },
2796
+ "required": [
2797
+ "attribute",
2798
+ "mustBeAccepted",
2799
+ "sourceAttributeId"
2800
+ ],
2801
+ "additionalProperties": false
2802
+ },
2803
+ "IIdentityAttribute": {
2694
2804
  "type": "object",
2695
2805
  "properties": {
2696
2806
  "owner": {
@@ -2705,19 +2815,14 @@ exports.CreateOutgoingRequestRequest = {
2705
2815
  "value": {
2706
2816
  "$ref": "#/definitions/IAbstractAttributeValue"
2707
2817
  },
2708
- "key": {
2709
- "type": "string"
2710
- },
2711
- "isTechnical": {
2712
- "type": "boolean"
2713
- },
2714
- "confidentiality": {
2715
- "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2818
+ "tags": {
2819
+ "type": "array",
2820
+ "items": {
2821
+ "type": "string"
2822
+ }
2716
2823
  }
2717
2824
  },
2718
2825
  "required": [
2719
- "confidentiality",
2720
- "key",
2721
2826
  "owner",
2722
2827
  "value"
2723
2828
  ],
@@ -2754,6 +2859,10 @@ exports.CreateOutgoingRequestRequest = {
2754
2859
  "type": "boolean",
2755
2860
  "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."
2756
2861
  },
2862
+ "requireManualDecision": {
2863
+ "type": "boolean",
2864
+ "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."
2865
+ },
2757
2866
  "query": {
2758
2867
  "anyOf": [
2759
2868
  {
@@ -2940,6 +3049,10 @@ exports.CreateOutgoingRequestRequest = {
2940
3049
  "type": "boolean",
2941
3050
  "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."
2942
3051
  },
3052
+ "requireManualDecision": {
3053
+ "type": "boolean",
3054
+ "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."
3055
+ },
2943
3056
  "query": {
2944
3057
  "$ref": "#/definitions/IAbstractAttributeQuery"
2945
3058
  }
@@ -2968,7 +3081,7 @@ exports.CreateOutgoingRequestRequest = {
2968
3081
  ],
2969
3082
  "additionalProperties": false
2970
3083
  },
2971
- "IShareAttributeRequestItem": {
3084
+ "IConsentRequestItem": {
2972
3085
  "type": "object",
2973
3086
  "properties": {
2974
3087
  "title": {
@@ -2987,22 +3100,26 @@ exports.CreateOutgoingRequestRequest = {
2987
3100
  "type": "boolean",
2988
3101
  "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."
2989
3102
  },
2990
- "attributeId": {
2991
- "$ref": "#/definitions/ICoreId"
3103
+ "requireManualDecision": {
3104
+ "type": "boolean",
3105
+ "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."
2992
3106
  },
2993
- "shareWith": {
2994
- "$ref": "#/definitions/ICoreAddress"
3107
+ "consent": {
3108
+ "type": "string"
3109
+ },
3110
+ "link": {
3111
+ "type": "string"
2995
3112
  }
2996
3113
  },
2997
3114
  "required": [
2998
- "attributeId",
2999
- "mustBeAccepted",
3000
- "shareWith"
3115
+ "consent",
3116
+ "mustBeAccepted"
3001
3117
  ],
3002
3118
  "additionalProperties": false
3003
3119
  },
3004
- "IConsentRequestItem": {
3120
+ "IAuthenticationRequestItem": {
3005
3121
  "type": "object",
3122
+ "additionalProperties": false,
3006
3123
  "properties": {
3007
3124
  "title": {
3008
3125
  "type": "string",
@@ -3020,21 +3137,14 @@ exports.CreateOutgoingRequestRequest = {
3020
3137
  "type": "boolean",
3021
3138
  "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."
3022
3139
  },
3023
- "consent": {
3024
- "type": "string"
3025
- },
3026
- "link": {
3027
- "type": "string"
3028
- },
3029
- "requireActiveConsent": {
3030
- "type": "boolean"
3140
+ "requireManualDecision": {
3141
+ "type": "boolean",
3142
+ "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."
3031
3143
  }
3032
3144
  },
3033
3145
  "required": [
3034
- "consent",
3035
3146
  "mustBeAccepted"
3036
- ],
3037
- "additionalProperties": false
3147
+ ]
3038
3148
  },
3039
3149
  "AddressString": {
3040
3150
  "type": "string",
@@ -3304,7 +3414,10 @@ exports.CompleteOutgoingRequestRequest = {
3304
3414
  "$ref": "#/definitions/AcceptResponseItemJSON"
3305
3415
  },
3306
3416
  {
3307
- "$ref": "#/definitions/CreateAttributeAcceptResponseItemJSON"
3417
+ "$ref": "#/definitions/CreateRelationshipAttributeAcceptResponseItemJSON"
3418
+ },
3419
+ {
3420
+ "$ref": "#/definitions/ShareAttributeAcceptResponseItemJSON"
3308
3421
  },
3309
3422
  {
3310
3423
  "$ref": "#/definitions/ProposeAttributeAcceptResponseItemJSON"
@@ -3337,7 +3450,34 @@ exports.CompleteOutgoingRequestRequest = {
3337
3450
  ],
3338
3451
  "additionalProperties": false
3339
3452
  },
3340
- "CreateAttributeAcceptResponseItemJSON": {
3453
+ "CreateRelationshipAttributeAcceptResponseItemJSON": {
3454
+ "type": "object",
3455
+ "properties": {
3456
+ "@type": {
3457
+ "type": "string"
3458
+ },
3459
+ "@context": {
3460
+ "type": "string"
3461
+ },
3462
+ "@version": {
3463
+ "type": "string"
3464
+ },
3465
+ "result": {
3466
+ "type": "string",
3467
+ "const": "Accepted"
3468
+ },
3469
+ "attributeId": {
3470
+ "type": "string"
3471
+ }
3472
+ },
3473
+ "required": [
3474
+ "@type",
3475
+ "attributeId",
3476
+ "result"
3477
+ ],
3478
+ "additionalProperties": false
3479
+ },
3480
+ "ShareAttributeAcceptResponseItemJSON": {
3341
3481
  "type": "object",
3342
3482
  "properties": {
3343
3483
  "@type": {
@@ -4220,7 +4360,7 @@ exports.ReceivedIncomingRequestRequest = {
4220
4360
  "mustBeAccepted"
4221
4361
  ],
4222
4362
  "additionalProperties": false,
4223
- "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
4363
+ "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateRelationshipAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
4224
4364
  },
4225
4365
  "RequestItemJSONDerivations": {
4226
4366
  "anyOf": [
@@ -4228,7 +4368,10 @@ exports.ReceivedIncomingRequestRequest = {
4228
4368
  "$ref": "#/definitions/RequestItemJSON"
4229
4369
  },
4230
4370
  {
4231
- "$ref": "#/definitions/CreateAttributeRequestItemJSON"
4371
+ "$ref": "#/definitions/CreateRelationshipAttributeRequestItemJSON"
4372
+ },
4373
+ {
4374
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
4232
4375
  },
4233
4376
  {
4234
4377
  "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
@@ -4237,10 +4380,10 @@ exports.ReceivedIncomingRequestRequest = {
4237
4380
  "$ref": "#/definitions/ReadAttributeRequestItemJSON"
4238
4381
  },
4239
4382
  {
4240
- "$ref": "#/definitions/ShareAttributeRequestItemJSON"
4383
+ "$ref": "#/definitions/ConsentRequestItemJSON"
4241
4384
  },
4242
4385
  {
4243
- "$ref": "#/definitions/ConsentRequestItemJSON"
4386
+ "$ref": "#/definitions/AuthenticationRequestItemJSON"
4244
4387
  }
4245
4388
  ]
4246
4389
  },
@@ -4271,6 +4414,10 @@ exports.ReceivedIncomingRequestRequest = {
4271
4414
  "mustBeAccepted": {
4272
4415
  "type": "boolean",
4273
4416
  "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."
4417
+ },
4418
+ "requireManualDecision": {
4419
+ "type": "boolean",
4420
+ "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."
4274
4421
  }
4275
4422
  },
4276
4423
  "required": [
@@ -4279,7 +4426,7 @@ exports.ReceivedIncomingRequestRequest = {
4279
4426
  ],
4280
4427
  "additionalProperties": false
4281
4428
  },
4282
- "CreateAttributeRequestItemJSON": {
4429
+ "CreateRelationshipAttributeRequestItemJSON": {
4283
4430
  "type": "object",
4284
4431
  "properties": {
4285
4432
  "@type": {
@@ -4307,18 +4454,12 @@ exports.ReceivedIncomingRequestRequest = {
4307
4454
  "type": "boolean",
4308
4455
  "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."
4309
4456
  },
4310
- "attribute": {
4311
- "anyOf": [
4312
- {
4313
- "$ref": "#/definitions/IdentityAttributeJSON"
4314
- },
4315
- {
4316
- "$ref": "#/definitions/RelationshipAttributeJSON"
4317
- }
4318
- ]
4457
+ "requireManualDecision": {
4458
+ "type": "boolean",
4459
+ "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."
4319
4460
  },
4320
- "sourceAttributeId": {
4321
- "type": "string"
4461
+ "attribute": {
4462
+ "$ref": "#/definitions/RelationshipAttributeJSON"
4322
4463
  }
4323
4464
  },
4324
4465
  "required": [
@@ -4328,7 +4469,7 @@ exports.ReceivedIncomingRequestRequest = {
4328
4469
  ],
4329
4470
  "additionalProperties": false
4330
4471
  },
4331
- "IdentityAttributeJSON": {
4472
+ "RelationshipAttributeJSON": {
4332
4473
  "type": "object",
4333
4474
  "properties": {
4334
4475
  "@type": {
@@ -4352,15 +4493,20 @@ exports.ReceivedIncomingRequestRequest = {
4352
4493
  "value": {
4353
4494
  "$ref": "#/definitions/AbstractAttributeValueJSON"
4354
4495
  },
4355
- "tags": {
4356
- "type": "array",
4357
- "items": {
4358
- "type": "string"
4359
- }
4496
+ "key": {
4497
+ "type": "string"
4498
+ },
4499
+ "isTechnical": {
4500
+ "type": "boolean"
4501
+ },
4502
+ "confidentiality": {
4503
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4360
4504
  }
4361
4505
  },
4362
4506
  "required": [
4363
4507
  "@type",
4508
+ "confidentiality",
4509
+ "key",
4364
4510
  "owner",
4365
4511
  "value"
4366
4512
  ],
@@ -4383,7 +4529,69 @@ exports.ReceivedIncomingRequestRequest = {
4383
4529
  "@type"
4384
4530
  ]
4385
4531
  },
4386
- "RelationshipAttributeJSON": {
4532
+ "RelationshipAttributeConfidentiality": {
4533
+ "type": "string",
4534
+ "enum": [
4535
+ "public",
4536
+ "private",
4537
+ "protected"
4538
+ ]
4539
+ },
4540
+ "ShareAttributeRequestItemJSON": {
4541
+ "type": "object",
4542
+ "properties": {
4543
+ "@type": {
4544
+ "type": "string"
4545
+ },
4546
+ "@context": {
4547
+ "type": "string"
4548
+ },
4549
+ "@version": {
4550
+ "type": "string"
4551
+ },
4552
+ "title": {
4553
+ "type": "string",
4554
+ "description": "The human-readable title of this item."
4555
+ },
4556
+ "description": {
4557
+ "type": "string",
4558
+ "description": "The human-readable description of this item."
4559
+ },
4560
+ "metadata": {
4561
+ "type": "object",
4562
+ "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."
4563
+ },
4564
+ "mustBeAccepted": {
4565
+ "type": "boolean",
4566
+ "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."
4567
+ },
4568
+ "requireManualDecision": {
4569
+ "type": "boolean",
4570
+ "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."
4571
+ },
4572
+ "attribute": {
4573
+ "anyOf": [
4574
+ {
4575
+ "$ref": "#/definitions/IdentityAttributeJSON"
4576
+ },
4577
+ {
4578
+ "$ref": "#/definitions/RelationshipAttributeJSON"
4579
+ }
4580
+ ]
4581
+ },
4582
+ "sourceAttributeId": {
4583
+ "type": "string"
4584
+ }
4585
+ },
4586
+ "required": [
4587
+ "@type",
4588
+ "attribute",
4589
+ "mustBeAccepted",
4590
+ "sourceAttributeId"
4591
+ ],
4592
+ "additionalProperties": false
4593
+ },
4594
+ "IdentityAttributeJSON": {
4387
4595
  "type": "object",
4388
4596
  "properties": {
4389
4597
  "@type": {
@@ -4407,33 +4615,20 @@ exports.ReceivedIncomingRequestRequest = {
4407
4615
  "value": {
4408
4616
  "$ref": "#/definitions/AbstractAttributeValueJSON"
4409
4617
  },
4410
- "key": {
4411
- "type": "string"
4412
- },
4413
- "isTechnical": {
4414
- "type": "boolean"
4415
- },
4416
- "confidentiality": {
4417
- "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4618
+ "tags": {
4619
+ "type": "array",
4620
+ "items": {
4621
+ "type": "string"
4622
+ }
4418
4623
  }
4419
4624
  },
4420
4625
  "required": [
4421
4626
  "@type",
4422
- "confidentiality",
4423
- "key",
4424
4627
  "owner",
4425
4628
  "value"
4426
4629
  ],
4427
4630
  "additionalProperties": false
4428
4631
  },
4429
- "RelationshipAttributeConfidentiality": {
4430
- "type": "string",
4431
- "enum": [
4432
- "public",
4433
- "private",
4434
- "protected"
4435
- ]
4436
- },
4437
4632
  "ProposeAttributeRequestItemJSON": {
4438
4633
  "type": "object",
4439
4634
  "properties": {
@@ -4462,6 +4657,10 @@ exports.ReceivedIncomingRequestRequest = {
4462
4657
  "type": "boolean",
4463
4658
  "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."
4464
4659
  },
4660
+ "requireManualDecision": {
4661
+ "type": "boolean",
4662
+ "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."
4663
+ },
4465
4664
  "query": {
4466
4665
  "anyOf": [
4467
4666
  {
@@ -4690,6 +4889,10 @@ exports.ReceivedIncomingRequestRequest = {
4690
4889
  "type": "boolean",
4691
4890
  "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."
4692
4891
  },
4892
+ "requireManualDecision": {
4893
+ "type": "boolean",
4894
+ "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."
4895
+ },
4693
4896
  "query": {
4694
4897
  "$ref": "#/definitions/AbstractAttributeQueryJSON"
4695
4898
  }
@@ -4729,7 +4932,7 @@ exports.ReceivedIncomingRequestRequest = {
4729
4932
  ],
4730
4933
  "additionalProperties": false
4731
4934
  },
4732
- "ShareAttributeRequestItemJSON": {
4935
+ "ConsentRequestItemJSON": {
4733
4936
  "type": "object",
4734
4937
  "properties": {
4735
4938
  "@type": {
@@ -4757,23 +4960,27 @@ exports.ReceivedIncomingRequestRequest = {
4757
4960
  "type": "boolean",
4758
4961
  "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."
4759
4962
  },
4760
- "attributeId": {
4963
+ "requireManualDecision": {
4964
+ "type": "boolean",
4965
+ "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."
4966
+ },
4967
+ "consent": {
4761
4968
  "type": "string"
4762
4969
  },
4763
- "shareWith": {
4970
+ "link": {
4764
4971
  "type": "string"
4765
4972
  }
4766
4973
  },
4767
4974
  "required": [
4768
4975
  "@type",
4769
- "attributeId",
4770
- "mustBeAccepted",
4771
- "shareWith"
4976
+ "consent",
4977
+ "mustBeAccepted"
4772
4978
  ],
4773
4979
  "additionalProperties": false
4774
4980
  },
4775
- "ConsentRequestItemJSON": {
4981
+ "AuthenticationRequestItemJSON": {
4776
4982
  "type": "object",
4983
+ "additionalProperties": false,
4777
4984
  "properties": {
4778
4985
  "@type": {
4779
4986
  "type": "string"
@@ -4800,22 +5007,15 @@ exports.ReceivedIncomingRequestRequest = {
4800
5007
  "type": "boolean",
4801
5008
  "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."
4802
5009
  },
4803
- "consent": {
4804
- "type": "string"
4805
- },
4806
- "link": {
4807
- "type": "string"
4808
- },
4809
- "requireActiveConsent": {
4810
- "type": "boolean"
5010
+ "requireManualDecision": {
5011
+ "type": "boolean",
5012
+ "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."
4811
5013
  }
4812
5014
  },
4813
5015
  "required": [
4814
5016
  "@type",
4815
- "consent",
4816
5017
  "mustBeAccepted"
4817
- ],
4818
- "additionalProperties": false
5018
+ ]
4819
5019
  },
4820
5020
  "MessageIdString": {
4821
5021
  "type": "string",