Release/3.0.0 pre

src/id-api.ts

@@ -4,7 +4,13 @@ import { mapServerUri, sdkVersionInfo, validatePartnerParams } from './helpers';
 import { IdInfo, PartnerParams } from './shared';
 import { JOB_TYPE } from './constants';
 
-const validateIdInfo = (idInfo: IdInfo) => {
+/**
+ * Validates the provided id info
+ * @param {IdInfo} idInfo Contains info needed for the verification job
+ * @returns {void}
+ * @throws {Error} - If the id info is invalid.
+ */
+const validateIdInfo = (idInfo: IdInfo): void => {
   if (typeof idInfo !== 'object') {
     throw new Error('ID Info needs to be an object');
   }
@@ -60,6 +66,15 @@ export class IDApi {
     this.url = mapServerUri(sid_server);
   }
 
+  /**
+   * Submit a job to Smile.
+   * @param {PartnerParams} partner_params - the user_id, job_id, and job_type of the job to submit.
+   * Can additionally include optional parameters that Smile will return in the
+   * job status.
+   * @param {IdInfo} id_info - ID information required to create a job.
+   * @returns {Promise<object>} A promise that resolves to the job status.
+   * @throws {Error} If any of the required parameters are missing or if the request fails.
+   */
   async submit_job(
     partner_params: PartnerParams,
     id_info: IdInfo,

src/signature.ts

@@ -12,7 +12,7 @@ const generate_signature = (
   partnerID: string,
   apiKey: string,
   timestamp: string | number,
-) => {
+): string => {
   const isoTimestamp =
     typeof timestamp === 'number'
       ? new Date(timestamp).toISOString()
@@ -63,7 +63,7 @@ export default class Signature {
     };
   }
 
-  confirm_signature(timestamp: string | number, signature: string) {
+  confirm_signature(timestamp: string | number, signature: string): boolean {
     return (
       generate_signature(this.partnerID, this.apiKey, timestamp) === signature
     );

src/web-api.ts

@@ -167,7 +167,7 @@ const hasSelfieImage = ({
 }: {
   image_type_id: number;
   image: string;
-}) => [0, 2].includes(image_type_id);
+}): boolean => [0, 2].includes(image_type_id);
 
 /**
  * Checks to ensure required images for job type 1 are present.