rename API

Author: vigneshshanmugam

__tests__/core/totp.test.ts renamed to __tests__/core/mfa.test.ts

@@ -23,13 +23,12 @@
  *
  */
 
-import { createTOTP } from '../../src/core/totp';
+import { totp } from '../../src/core/mfa';
 
-describe('TOTP', () => {
-  it('generate one time token', () => {
-    const totp = createTOTP({ secret: "FLIIOLP3IR3W" });
-    expect(totp.generate().length).toBe(6);
-    expect(totp.toString()).toEqual('otpauth://totp/SyntheticsTOTP?secret=FLIIOLP3IR3Q&algorithm=SHA1&digits=6&period=30')
+describe('MFA', () => {
+  it('generate TOTP', () => {
+    const token = totp("FLIIOLP3IR3W");
+    expect(token.length).toBe(6);
   });
 });
 

src/core/totp.ts renamed to src/core/mfa.ts

@@ -36,8 +36,8 @@ type TOTPOptions = {
    */
   label?: string
   /**
-  * Include issuer prefix in label.
-  */
+   * Include issuer prefix in label.
+   */
   issuerInLabel?: boolean
   /**
    * The encoded secret key used to generate the TOTP.
@@ -60,6 +60,6 @@ type TOTPOptions = {
   period?: number
 };
 
-export function createTOTP(options: TOTPOptions) {
-  return new TOTP({ label: "SyntheticsTOTP", ...options });
+export function totp(secret?: string, options: TOTPOptions = {}) {
+  return new TOTP({ label: "SyntheticsTOTP", secret, ...options }).generate();
 }

src/index.ts

@@ -43,7 +43,7 @@ export {
   after,
 } from './core';
 export { expect } from './core/expect';
-export { createTOTP } from './core/totp';
+export * as mfa from './core/mfa';
 
 /**
  * Export all the driver related types to be consumed