Skip to content

Commit 1d92fa5

Browse files
committed
changed JSDocs to reflect recent changes
1 parent 97b5d61 commit 1d92fa5

2 files changed

Lines changed: 28 additions & 27 deletions

File tree

src/eudi-sdk.js

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,22 @@ function anonymousCompatibility(config) {
2323
return (disallowed.filter(req => req == true).length == 0);
2424
}
2525

26-
// TODO: Change to reflect the recent config changes
2726
/**
2827
* @typedef {Object} ConfigOptions
29-
* @property {boolean} [AgeOver18] - Whether the user is over 18.
30-
* @property {boolean} [HealthID] - Whether to include Health ID attestation.
31-
* @property {boolean} [IBAN] - Whether to include IBAN attestation.
32-
* @property {boolean} [Loyalty] - Whether to include Loyalty attestation.
33-
* @property {boolean} [mDL] - Whether to include mobile Driver’s License (mDL) attestation.
34-
* @property {boolean} [MSISDN] - Whether to include MSISDN (phone number) attestation.
35-
* @property {boolean} [PhotoId] - Whether to include Photo ID attestation.
36-
* @property {boolean} [PID] - Whether to include Personal ID (PID) attestation.
37-
* @property {boolean} [PowerOfRepresentation] - Whether to include Power of Representation attestation.
38-
* @property {boolean} [PseudonymDeferred] - Whether to include Pseudonym Deferred attestation.
39-
* @property {boolean} [Reservation] - Whether to include Reservation attestation.
40-
* @property {boolean} [TaxNumber] - Whether to include Tax Number attestation.
28+
* @property {Object} required - Required attestations.
29+
* @property {boolean} [required.AgeOver18] - Whether the user is over 18.
30+
* @property {boolean} [required.HealthID] - Whether to include Health ID attestation.
31+
* @property {boolean} [required.IBAN] - Whether to include IBAN attestation.
32+
* @property {boolean} [required.Loyalty] - Whether to include Loyalty attestation.
33+
* @property {boolean} [required.mDL] - Whether to include mobile Driver’s License (mDL) attestation.
34+
* @property {boolean} [required.MSISDN] - Whether to include MSISDN (phone number) attestation.
35+
* @property {boolean} [required.PhotoId] - Whether to include Photo ID attestation.
36+
* @property {boolean} [required.PID] - Whether to include Personal ID (PID) attestation.
37+
* @property {boolean} [required.PowerOfRepresentation] - Whether to include Power of Representation attestation.
38+
* @property {boolean} [required.PseudonymDeferred] - Whether to include Pseudonym Deferred attestation.
39+
* @property {boolean} [required.Reservation] - Whether to include Reservation attestation.
40+
* @property {boolean} [required.TaxNumber] - Whether to include Tax Number attestation.
41+
* @property {Visibility} visibility - The visibility setting for the configuration.
4142
*/
4243

4344
/**

src/modules/config.mjs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,22 @@ export const EMPTY_CONFIG = {
5050
*/
5151
export class Config {
5252

53-
// TODO: Change to reflect the recent config changes
5453
/**
5554
* @typedef {Object} ConfigOptions
56-
* @property {boolean} [AgeOver18=false] - Whether the user is over 18.
57-
* @property {boolean} [HealthID=false] - Whether to include Health ID attestation.
58-
* @property {boolean} [IBAN=false] - Whether to include IBAN attestation.
59-
* @property {boolean} [Loyalty=false] - Whether to include Loyalty attestation.
60-
* @property {boolean} [mDL=false] - Whether to include mobile Driver’s License (mDL) attestation.
61-
* @property {boolean} [MSISDN=false] - Whether to include MSISDN (phone number) attestation.
62-
* @property {boolean} [PhotoId=false] - Whether to include Photo ID attestation.
63-
* @property {boolean} [PID=false] - Whether to include Personal ID (PID) attestation.
64-
* @property {boolean} [PowerOfRepresentation=false] - Whether to include Power of Representation attestation.
65-
* @property {boolean} [PseudonymDeferred=false] - Whether to include Pseudonym Deferred attestation.
66-
* @property {boolean} [Reservation=false] - Whether to include Reservation attestation.
67-
* @property {boolean} [TaxNumber=false] - Whether to include Tax Number attestation.
68-
* @property {integer} [visibility=Visibility.PUBLIC] - The level of visibility for the attestation data
55+
* @property {Object} required - Required attestations.
56+
* @property {boolean} [required.AgeOver18] - Whether the user is over 18.
57+
* @property {boolean} [required.HealthID] - Whether to include Health ID attestation.
58+
* @property {boolean} [required.IBAN] - Whether to include IBAN attestation.
59+
* @property {boolean} [required.Loyalty] - Whether to include Loyalty attestation.
60+
* @property {boolean} [required.mDL] - Whether to include mobile Driver’s License (mDL) attestation.
61+
* @property {boolean} [required.MSISDN] - Whether to include MSISDN (phone number) attestation.
62+
* @property {boolean} [required.PhotoId] - Whether to include Photo ID attestation.
63+
* @property {boolean} [required.PID] - Whether to include Personal ID (PID) attestation.
64+
* @property {boolean} [required.PowerOfRepresentation] - Whether to include Power of Representation attestation.
65+
* @property {boolean} [required.PseudonymDeferred] - Whether to include Pseudonym Deferred attestation.
66+
* @property {boolean} [required.Reservation] - Whether to include Reservation attestation.
67+
* @property {boolean} [required.TaxNumber] - Whether to include Tax Number attestation.
68+
* @property {Visibility} visibility - The visibility setting for the configuration.
6969
*/
7070

7171
/**

0 commit comments

Comments
 (0)