Add otp expiration transformation (#172)

Fix #167

documentation/pages/personal/secrets/read.mdx

@@ -51,6 +51,7 @@ The transformer is a function that will be applied to the secret field before lo
 Available transformers:
 
 -   `?otp` to generate a one-time password from a secret key
+-   `?otp+expiry` to generate a one-time password from a secret key and display its expiry date (in seconds)
 -   `?json=<JSONPathQuery>` to extract a value from a JSON object
     (please refer to [JSONPath documentation](https://github.com/JSONPath-Plus/JSONPath#syntax-through-examples) for more information)
 

src/utils/secretPath.ts

@@ -1,5 +1,5 @@
 import { isUuid } from './strings';
-import { transformJsonPath, transformOtp } from './secretTransformation';
+import { transformJsonPath, transformOtp, transformOtpAndExpiry } from './secretTransformation';
 import { ParsedPath } from '../types';
 import { InvalidDashlanePathError } from '../errors';
 
@@ -52,6 +52,9 @@ export const parsePath = (path: string): ParsedPath => {
             case 'otp':
                 transformation = transformOtp;
                 break;
+            case 'otp+expiry':
+                transformation = transformOtpAndExpiry;
+                break;
             case 'json':
                 transformation = (json: string) => transformJsonPath(json, queryParamValue);
                 break;

src/utils/secretTransformation.ts

@@ -5,6 +5,12 @@ export const transformOtp = (secret: string) => {
     return authenticator.generate(secret);
 };
 
+export const transformOtpAndExpiry = (secret: string) => {
+    const otp = authenticator.generate(secret);
+    const expiry = authenticator.timeRemaining();
+    return `${otp} ${expiry}`;
+};
+
 export const transformJsonPath = (json: string, path: string) => {
     const result = JSONPath<unknown>({ path, json: JSON.parse(json) as object, wrap: false });
     if (result === undefined) {