SDK-2814 Support Digital ID in IDV

index.js

@@ -58,7 +58,7 @@ const {
   AdvancedIdentityProfileBuilder,
   AdvancedIdentityProfileSchemeBuilder,
   AdvancedIdentityProfileRequirementsBuilder,
-
+  AllowedProviderBuilder,
 } = require('./src/idv_service');
 
 const YotiCommon = require('./src/yoti_common');
@@ -124,4 +124,5 @@ module.exports = {
   AdvancedIdentityProfileBuilder,
   AdvancedIdentityProfileSchemeBuilder,
   AdvancedIdentityProfileRequirementsBuilder,
+  AllowedProviderBuilder,
 };

src/idv_service/index.js

@@ -33,6 +33,7 @@ const AdvancedIdentityProfileBuilder = require('./session/create/identity_profil
 const AdvancedIdentityProfileRequirementsBuilder = require('./session/create/identity_profile/advanced/advanced.identity.profile.requirements.builder');
 const AdvancedIdentityProfileSchemeBuilder = require('./session/create/identity_profile/advanced/advanced.identity.profile.scheme.builder');
 const AdvancedIdentityProfileSchemeConfigBuilder = require('./session/create/identity_profile/advanced/advanced.identity.profile.scheme.config');
+const AllowedProviderBuilder = require('./session/create/filters/allowed.provider.builder');
 
 module.exports = {
   IDVService,
@@ -68,4 +69,5 @@ module.exports = {
   AdvancedIdentityProfileSchemeBuilder,
   AdvancedIdentityProfileRequirementsBuilder,
   AdvancedIdentityProfileSchemeConfigBuilder,
+  AllowedProviderBuilder,
 };

src/idv_service/session/create/filters/allowed.provider.builder.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Validation = require('../../../../yoti_common/validation');
+const AllowedProvider = require('./allowed.provider');
+
+class AllowedProviderBuilder {
+  withName(provider) {
+    Validation.isString(provider, 'provider');
+    this.name = provider;
+    return this;
+  }
+
+  /**
+   * @returns {AllowedProvider}
+   */
+  build() {
+    return new AllowedProvider(
+      this.name
+    );
+  }
+}
+
+module.exports = AllowedProviderBuilder;

src/idv_service/session/create/filters/allowed.provider.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const Validation = require('../../../../yoti_common/validation');
+
+class AllowedProvider {
+  /**
+   * @param {string} name
+   */
+  constructor(name) {
+    Validation.isString(name, 'name');
+    /** @private */
+    this.name = name;
+  }
+
+  toJSON() {
+    return {
+      name: this.name,
+    };
+  }
+}
+
+module.exports = AllowedProvider;

src/idv_service/session/create/filters/document.filter.js

@@ -1,19 +1,78 @@
 'use strict';
 
 const Validation = require('../../../../yoti_common/validation');
+const AllowedProvider = require('./allowed.provider');
 
 class DocumentFilter {
   /**
    * @param {string} type
+   * @param {boolean} allowExpiredDocuments
+   * @param {boolean} allowNonLatinDocuments
+   * @param {boolean} allowDigitalIds
+   * @param {AllowedProvider[]} allowedProviders
    */
-  constructor(type) {
+  constructor(type, allowExpiredDocuments, allowNonLatinDocuments, allowDigitalIds, allowedProviders) {
     if (new.target === DocumentFilter) {
       throw TypeError('DocumentFilter cannot be instantiated');
     }
 
     Validation.isString(type, 'type');
     /** @private */
     this.type = type;
+
+    Validation.isBoolean(allowExpiredDocuments, 'allowExpiredDocuments', true);
+    /** @private */
+    this.allowExpiredDocuments = allowExpiredDocuments;
+
+    Validation.isBoolean(allowNonLatinDocuments, 'allowNonLatinDocuments', true);
+    /** @private */
+    this.allowNonLatinDocuments = allowNonLatinDocuments;
+
+    Validation.isBoolean(allowDigitalIds, 'allowDigitalIds', true);
+    /** @private */
+    this.allowDigitalIds = allowDigitalIds;
+
+    if (allowedProviders) {
+      Validation.isArrayOfType(allowedProviders, AllowedProvider, 'allowedProviders');
+      /** @private */
+      this.allowedProviders = allowedProviders;
+    }
+  }
+
+  /**
+   * Whether to allow non latin documents
+   *
+   * @return {boolean} flag
+   */
+  getAllowNonLatinDocuments() {
+    return this.allowNonLatinDocuments;
+  }
+
+  /**
+   * Whether to allow non expired documents
+   *
+   * @return {boolean} flag
+   */
+  getAllowExpiredDocuments() {
+    return this.allowExpiredDocuments;
+  }
+
+  /**
+   * Whether to allow digital IDs to satisfy the filter
+   *
+   * @return boolean flag
+   */
+  getAllowDigitalIds() {
+    return this.allowDigitalIds;
+  }
+
+  /**
+   * The list of digital ID providers that are allowed to satisfy the filter
+   *
+   * @return AllowedProvider[] the allowed providers
+   */
+  getAllowedProviders() {
+    return this.allowedProviders;
   }
 
   toJSON() {

src/idv_service/session/create/filters/document/document.restrictions.filter.builder.js

@@ -5,6 +5,10 @@ const DocumentRestriction = require('./document.restriction');
 const Validation = require('../../../../../yoti_common/validation');
 const IDVConstants = require('../../../../idv.constants');
 
+/**
+ * @typedef {import('./../allowed.provider')} AllowedProvider
+ */
+
 class DocumentRestrictionsFilterBuilder {
   constructor() {
     /** @private */
@@ -59,6 +63,26 @@ class DocumentRestrictionsFilterBuilder {
     return this;
   }
 
+  /**
+   * @param {Boolean} allowDigitalIds
+   *
+   * @returns {this}
+   */
+  withAllowDigitalIds(allowDigitalIds) {
+    this.allowDigitalIds = allowDigitalIds;
+    return this;
+  }
+
+  /**
+   * @param {AllowedProvider[]} allowedProviders
+   *
+   * @returns {this}
+   */
+  withAllowedProviders(allowedProviders) {
+    this.allowedProviders = allowedProviders;
+    return this;
+  }
+
   /**
    * @returns {DocumentRestrictionsFilter}
    */
@@ -67,7 +91,9 @@ class DocumentRestrictionsFilterBuilder {
       this.inclusion,
       this.documents,
       this.allowExpiredDocuments,
-      this.allowNonLatinDocuments
+      this.allowNonLatinDocuments,
+      this.allowDigitalIds,
+      this.allowedProviders
     );
   }
 }

src/idv_service/session/create/filters/document/document.restrictions.filter.js

@@ -5,15 +5,21 @@ const DocumentFilter = require('../document.filter');
 const DocumentRestriction = require('./document.restriction');
 const IDVConstants = require('../../../../idv.constants');
 
+/**
+ * @typedef {import('./../allowed.provider')} AllowedProvider
+ */
+
 class DocumentRestrictionsFilter extends DocumentFilter {
   /**
    * @param {string} inclusion
    * @param {DocumentRestriction[]} documents
    * @param {Boolean} allowExpiredDocuments
    * @param {Boolean} allowNonLatinDocuments
+   * @param {boolean} allowDigitalIds
+   * @param {AllowedProvider[]} allowedProviders
    */
-  constructor(inclusion, documents, allowExpiredDocuments, allowNonLatinDocuments) {
-    super(IDVConstants.DOCUMENT_RESTRICTIONS);
+  constructor(inclusion, documents, allowExpiredDocuments, allowNonLatinDocuments, allowDigitalIds, allowedProviders) {
+    super(IDVConstants.DOCUMENT_RESTRICTIONS, allowExpiredDocuments, allowNonLatinDocuments, allowDigitalIds, allowedProviders);
 
     Validation.isString(inclusion, 'inclusion');
     /** @private */
@@ -22,23 +28,17 @@ class DocumentRestrictionsFilter extends DocumentFilter {
     Validation.isArrayOfType(documents, DocumentRestriction, 'documents');
     /** @private */
     this.documents = documents;
-
-    Validation.isBoolean(allowExpiredDocuments, 'allowExpiredDocuments', true);
-    /** @private */
-    this.allowExpiredDocuments = allowExpiredDocuments;
-
-    Validation.isBoolean(allowNonLatinDocuments, 'allowNonLatinDocuments', true);
-    /** @private */
-    this.allowNonLatinDocuments = allowNonLatinDocuments;
   }
 
   toJSON() {
     const json = super.toJSON();
 
     json.inclusion = this.inclusion;
     json.documents = this.documents;
-    json.allow_expired_documents = this.allowExpiredDocuments;
-    json.allow_non_latin_documents = this.allowNonLatinDocuments;
+    json.allow_expired_documents = this.getAllowExpiredDocuments();
+    json.allow_non_latin_documents = this.getAllowNonLatinDocuments();
+    json.allow_digital_ids = this.getAllowDigitalIds();
+    json.allowed_providers = this.getAllowedProviders();
 
     return json;
   }

src/idv_service/session/create/filters/orthogonal/orthogonal.restrictions.filter.builder.js

@@ -5,6 +5,10 @@ const TypeRestriction = require('./type.restriction');
 const CountryRestriction = require('./country.restriction');
 const IDVConstants = require('../../../../idv.constants');
 
+/**
+ * @typedef {import('./../allowed.provider')} AllowedProvider
+ */
+
 class OrthogonalRestrictionsFilterBuilder {
   /**
    * @param {string[]} countryCodes
@@ -78,6 +82,26 @@ class OrthogonalRestrictionsFilterBuilder {
     return this;
   }
 
+  /**
+   * @param {Boolean} allowDigitalIds
+   *
+   * @returns {this}
+   */
+  withAllowDigitalIds(allowDigitalIds) {
+    this.allowDigitalIds = allowDigitalIds;
+    return this;
+  }
+
+  /**
+   * @param {AllowedProvider[]} allowedProviders
+   *
+   * @returns {this}
+   */
+  withAllowedProviders(allowedProviders) {
+    this.allowedProviders = allowedProviders;
+    return this;
+  }
+
   /**
    * @returns {OrthogonalRestrictionsFilter}
    */
@@ -86,7 +110,9 @@ class OrthogonalRestrictionsFilterBuilder {
       this.countryRestriction,
       this.typeRestriction,
       this.allowExpiredDocuments,
-      this.allowNonLatinDocuments
+      this.allowNonLatinDocuments,
+      this.allowDigitalIds,
+      this.allowedProviders
     );
   }
 }

src/idv_service/session/create/filters/orthogonal/orthogonal.restrictions.filter.js

@@ -6,15 +6,21 @@ const IDVConstants = require('../../../../idv.constants');
 const TypeRestriction = require('./type.restriction');
 const CountryRestriction = require('./country.restriction');
 
+/**
+ * @typedef {import('./../allowed.provider')} AllowedProvider
+ */
+
 class OrthogonalRestrictionsFilter extends DocumentFilter {
   /**
    * @param {CountryRestriction} countryRestriction
    * @param {TypeRestriction} typeRestriction
    * @param {Boolean} allowExpiredDocuments
    * @param {Boolean} allowNonLatinDocuments
+   * @param {boolean} allowDigitalIds
+   * @param {AllowedProvider[]} allowedProviders
    */
-  constructor(countryRestriction, typeRestriction, allowExpiredDocuments, allowNonLatinDocuments) {
-    super(IDVConstants.ORTHOGONAL_RESTRICTIONS);
+  constructor(countryRestriction, typeRestriction, allowExpiredDocuments, allowNonLatinDocuments, allowDigitalIds, allowedProviders) {
+    super(IDVConstants.ORTHOGONAL_RESTRICTIONS, allowExpiredDocuments, allowNonLatinDocuments, allowDigitalIds, allowedProviders);
 
     if (countryRestriction) {
       Validation.instanceOf(countryRestriction, CountryRestriction, 'countryRestriction');
@@ -27,23 +33,17 @@ class OrthogonalRestrictionsFilter extends DocumentFilter {
       /** @private */
       this.typeRestriction = typeRestriction;
     }
-
-    Validation.isBoolean(allowExpiredDocuments, 'allowExpiredDocuments', true);
-    /** @private */
-    this.allowExpiredDocuments = allowExpiredDocuments;
-
-    Validation.isBoolean(allowNonLatinDocuments, 'allowNonLatinDocuments', true);
-    /** @private */
-    this.allowNonLatinDocuments = allowNonLatinDocuments;
   }
 
   toJSON() {
     const json = super.toJSON();
 
     json.country_restriction = this.countryRestriction;
     json.type_restriction = this.typeRestriction;
-    json.allow_expired_documents = this.allowExpiredDocuments;
-    json.allow_non_latin_documents = this.allowNonLatinDocuments;
+    json.allow_expired_documents = this.getAllowExpiredDocuments();
+    json.allow_non_latin_documents = this.getAllowNonLatinDocuments();
+    json.allow_digital_ids = this.getAllowDigitalIds();
+    json.allowed_providers = this.getAllowedProviders();
 
     return json;
   }

src/idv_service/session/retrieve/configuration/capture/document/supported.document.response.js

@@ -10,6 +10,12 @@ class SupportedDocumentResponse {
     Validation.isString(supportedDocument.type, 'type');
     /** @private */
     this.type = supportedDocument.type;
+
+    if (supportedDocument.providers) {
+      Validation.isArrayOfStrings(supportedDocument.providers, 'providers');
+      /** @private */
+      this.providers = supportedDocument.providers;
+    }
   }
 
   /**
@@ -20,6 +26,15 @@ class SupportedDocumentResponse {
   getType() {
     return this.type;
   }
+
+  /**
+   * Returns the digital ID providers supported for this document type.
+   *
+   * @return {string[] | null}
+   */
+  getProviders() {
+    return this.providers;
+  }
 }
 
 module.exports = SupportedDocumentResponse;