SDK-2421 TypeScript Support (#428)

* Added generated types from JSDoc
* Types are generated in pre-commit hook

.eslintignore

@@ -1 +1,2 @@
 **/node_modules
+types

.eslintrc.js

@@ -1,31 +1,41 @@
 module.exports = {
-  "plugins": ["node", "jest"],
-  "extends": ["plugin:node/recommended", "airbnb-base"],
+  plugins: ['node', 'jest'],
+  extends: ['plugin:node/recommended', 'airbnb-base'],
   rules: {
-    "node/exports-style": ["error", "module.exports"],
-    "prefer-destructuring": ["error", {"object": false, "array": false}],
-    "strict": 0,
-    "comma-dangle": ["error", {
-      "arrays": "always-multiline",
-      "exports": "always-multiline",
-      "functions": "never",
-      "imports": "always-multiline",
-      "objects": "always-multiline"
+    'node/exports-style': ['error', 'module.exports'],
+    'prefer-destructuring': ['error', { object: false, array: false }],
+    strict: 0,
+    'comma-dangle': ['error', {
+      arrays: 'always-multiline',
+      exports: 'always-multiline',
+      functions: 'never',
+      imports: 'always-multiline',
+      objects: 'always-multiline',
+    }],
+    'no-console': 0,
+    'prefer-object-spread': 0,
+    'default-param-last': 'off',
+    'prefer-regex-literals': 'off',
+    'max-len': ['error', {
+      code: 100,
+      tabWidth: 2,
+      ignoreUrls: true,
+      ignoreComments: false,
+      ignoreRegExpLiterals: true,
+      ignoreStrings: true,
+      ignoreTemplateLiterals: true,
+      ignorePattern: '\\* @typedef \\{import',
     }],
-    "no-console": 0,
-    "prefer-object-spread": 0,
-    "default-param-last": "off",
-    "prefer-regex-literals": "off"
   },
   env: {
-    "node": true,
-    "jest/globals": true
+    node: true,
+    'jest/globals': true,
   },
-  "overrides": [{
-    "files": "\"./tests/**/*.spec.js\"",
-    "rules": {
-        "node/no-unpublished-require": 0,
-        "node/no-missing-require": 0
-    }
-  }]
+  overrides: [{
+    files: '"./tests/**/*.spec.js"',
+    rules: {
+      'node/no-unpublished-require': 0,
+      'node/no-missing-require': 0,
+    },
+  }],
 };

index.js

@@ -53,9 +53,20 @@ const {
   RequestedTypeListSourcesBuilder,
   CreateFaceCaptureResourcePayloadBuilder,
   UploadFaceCaptureImagePayloadBuilder,
+  IDVService,
 } = require('./src/idv_service');
 
+const YotiCommon = require('./src/yoti_common');
+const { YotiRequest } = require('./src/request/request');
+const IDVError = require('./src/idv_service/idv.error');
+
 module.exports = {
+  internals: {
+    IDVService,
+    YotiCommon,
+    YotiRequest,
+    IDVError,
+  },
   Client: YotiClient,
   IDVClient,
   DigitalIdentityClient,

package.json

@@ -11,11 +11,14 @@
   "engines": {
     "node": ">=14"
   },
+  "types": "./types/index.d.ts",
   "scripts": {
     "lint": "npx eslint *.js './src/**/*.js' './tests/**/*.spec.js' config/*.js",
     "test": "jest",
     "audit": "audit-ci --config ./audit-ci.jsonc",
-    "pre-commit": "npm run test"
+    "types:generate": "tsc index.js --declaration --allowJs --checkJs --resolveJsonModule --emitDeclarationOnly --skipLibCheck --outDir types",
+    "types:refresh": "rm -rf types && npm run types:generate && git add types",
+    "pre-commit": "npm run test && npm run types:refresh"
   },
   "jest": {
     "verbose": true,
@@ -46,6 +49,7 @@
     "eslint-plugin-node": "11.1.0",
     "husky": "8.0.3",
     "jest": "29.5.0",
-    "nock": "13.2.9"
+    "nock": "13.2.9",
+    "typescript": "5.3.3"
   }
 }

src/aml_service/index.js

@@ -44,15 +44,17 @@ class AmlService {
   /**
    * @param {string} sdkId
    * @param {string|Buffer} pem
-   * @param {Object} options
-   * @param {string} options.apiUrl
+   * @param {{apiUrl?: string}} options
    */
   constructor(sdkId, pem, { apiUrl = DEFAULT_API_URL } = {}) {
     Validation.isString(sdkId, 'sdkId');
     Validation.notNullOrEmpty(pem, 'pem');
 
+    /** @private */
     this.sdkId = sdkId;
+    /** @private */
     this.pem = pem;
+    /** @private */
     this.apiUrl = apiUrl;
   }
 
@@ -65,7 +67,7 @@ class AmlService {
 
     const requestBuilder = new RequestBuilder()
       .withBaseUrl(this.apiUrl)
-      .withPemString(this.pem)
+      .withPemString(this.pem.toString())
       .withEndpoint('/aml-check')
       .withQueryParam('appId', this.sdkId)
       .withMethod('POST')

src/aml_type/aml.address.js

@@ -52,7 +52,6 @@ module.exports.AmlAddress = class AmlAddress {
   }
 
   /**
-   * @param countryCode
    *
    * @deprecated Replaced by Validation.notNullOrEmpty()
    */

src/client/digital.identity.client.js

@@ -7,56 +7,68 @@ class DigitalIdentityClient {
   /**
    * @param {string} sdkId
    * @param {string|Buffer} pem
-   * @param {Object} options
-   * @param {string} options.apiUrl
+   * @param {{apiUrl?: string}} options
    */
   constructor(sdkId, pem, { apiUrl } = {}) {
     const options = {
       apiUrl: apiUrl || config.yoti.digitalIdentityApi,
     };
 
+    /** @private */
     this.digitalIdentityService = new DigitalIdentityService(sdkId, pem, options);
   }
 
   /**
+   * @typedef {import('../digital_identity_service/share.session.configuration.js')} ShareSessionConfig
+   *
+   * @param {ShareSessionConfig} shareSessionConfig
+   *
+   * @typedef {import('../digital_identity_service/create.share.session.result.js')} CreateShareSessionResult
    *
-   * @param shareSessionConfig
    * @returns {Promise<CreateShareSessionResult>}
    */
   async createShareSession(shareSessionConfig) {
     return this.digitalIdentityService.createShareSession(shareSessionConfig);
   }
 
   /**
+   * @param {string} sessionId
+   *
+   * @typedef {import('../digital_identity_service/get.share.session.result.js')} GetShareSessionResult
    *
-   * @param sessionId
    * @returns {Promise<GetShareSessionResult>}
    */
   async getShareSession(sessionId) {
     return this.digitalIdentityService.getShareSession(sessionId);
   }
 
   /**
+   * @param {string} sessionId
+   *
+   * @typedef {import('../digital_identity_service/create.share.qr.code.result.js')} CreateShareQrCodeResult
    *
-   * @param sessionId
    * @returns {Promise<CreateShareQrCodeResult>}
    */
   async createShareQrCode(sessionId) {
     return this.digitalIdentityService.createShareQrCode(sessionId);
   }
 
   /**
+   * @param {string} qrCodeId
+   *
+   * @typedef {import('../digital_identity_service/get.share.qr.code.result.js')} GetShareQrCodeResult
    *
-   * @param qrCodeId
    * @returns {Promise<GetShareQrCodeResult>}
    */
   async getShareQrCode(qrCodeId) {
     return this.digitalIdentityService.getShareQrCode(qrCodeId);
   }
 
   /**
-   *
    * @param {string} receiptId
+   *
+   * @typedef {import('../digital_identity_service/get.share.receipt.result.js')} GetShareReceiptResult
+   *
    * @returns {Promise<GetShareReceiptResult>}
    */
   async getShareReceipt(receiptId) {

src/client/idv.client.js

@@ -14,21 +14,25 @@ class IDVClient {
   /**
    * @param {string} sdkId
    * @param {string|Buffer} pem
-   * @param {Object} options
-   * @param {string} options.apiUrl
+   * @param {{apiUrl?: string}} options
    */
   constructor(sdkId, pem, { apiUrl } = {}) {
     const options = {
       apiUrl: apiUrl || config.yoti.idvApi,
     };
+    /** @private */
     this.idvService = new IDVService(sdkId, pem, options);
   }
 
   /**
    * Creates a IDV session using the supplied session specification
    *
+   * @typedef {import('../idv_service/session/create/session.specification.js')} SessionSpecification
+   *
    * @param {SessionSpecification} sessionSpecification
    *
+   * @typedef {import('../idv_service/session/create/create.session.result')} CreateSessionResult
+   *
    * @returns {Promise<CreateSessionResult>}
    */
   createSession(sessionSpecification) {
@@ -40,6 +44,8 @@ class IDVClient {
    *
    * @param {string} sessionId
    *
+   * @typedef {import('../idv_service/session/retrieve/get.session.result.js')} GetSessionResult
+   *
    * @returns {Promise<GetSessionResult>}
    */
   getSession(sessionId) {
@@ -52,7 +58,7 @@ class IDVClient {
    *
    * @param {string} sessionId
    *
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
   deleteSession(sessionId) {
     return this.idvService.deleteSession(sessionId);
@@ -65,6 +71,8 @@ class IDVClient {
    * @param {string} sessionId
    * @param {string} mediaId
    *
+   * @typedef {import('../data_type/media.js')} Media
+   *
    * @returns {Promise<Media>}
    */
   getMediaContent(sessionId, mediaId) {
@@ -78,7 +86,7 @@ class IDVClient {
    * @param {string} sessionId
    * @param {string} mediaId
    *
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
   deleteMediaContent(sessionId, mediaId) {
     return this.idvService.deleteMediaContent(sessionId, mediaId);
@@ -89,6 +97,8 @@ class IDVClient {
    *
    * @param {boolean} includeNonLatin
    *
+   * @typedef {import('../idv_service/support/supported.documents.response.js')} SupportedDocumentsResponse
+   *
    * @returns {Promise<SupportedDocumentsResponse>}
    */
   getSupportedDocuments(includeNonLatin) {
@@ -98,8 +108,13 @@ class IDVClient {
   /**
    * Creates a face capture resource
    * @param {string} sessionId
+   *
+   * @typedef {import('../idv_service/session/create/face_capture/create.face.capture.resource.payload.js')} CreateFaceCaptureResourcePayload
+   *
    * @param {CreateFaceCaptureResourcePayload} createFaceCaptureResourcePayload
    *
+   * @typedef {import('../idv_service/session/retrieve/create.face.capture.resource.response.js')} CreateFaceCaptureResourceResponse
+   *
    * @returns {Promise<CreateFaceCaptureResourceResponse>}
    */
   createFaceCaptureResource(sessionId, createFaceCaptureResourcePayload) {
@@ -113,9 +128,12 @@ class IDVClient {
    * Uploads a face capture image
    * @param {string} sessionId
    * @param {string} resourceId
+   *
+   * @typedef {import('../idv_service/session/create/face_capture/upload.face.capture.image.payload.js')} UploadFaceCaptureImagePayload
+   *
    * @param {UploadFaceCaptureImagePayload} uploadFaceCaptureImagePayload
    *
-   * @returns {Promise<CreateFaceCaptureResourceResponse>}
+   * @returns {Promise<void>}
    */
   uploadFaceCaptureImage(sessionId, resourceId, uploadFaceCaptureImagePayload) {
     return this.idvService.uploadFaceCaptureImage(
@@ -130,6 +148,8 @@ class IDVClient {
    *
    * @param {string} sessionId
    *
+   * @typedef {import('../idv_service/session/retrieve/configuration/session.configuration.response.js')} SessionConfigurationResponse
+   *
    * @returns {Promise<SessionConfigurationResponse>}
    */
   getSessionConfiguration(sessionId) {