refactor!: standardize tokenInfo response

BREAKING CHANGE: change `tokenInfo` API response to standard format.

Author: mt-max

docs/README.md

@@ -154,16 +154,19 @@ You can validate a token or get guest or resource server information related to
 
 ```javascript
 const tokenInfo = await mtLinkSdk.tokenInfo(token, options);
-tokenInfo.guestUid // guest's uid
-tokenInfo.country // guest's country
-tokenInfo.currency // guest's currency
-tokenInfo.language // guest's language
-tokenInfo.resourceServer // resource server domain
-tokenInfo.clientId // app client id
-tokenInfo.clientName // app name
-tokenInfo.expTimestamp // token expiration timestamp
-tokenInfo.scopes // token access scopes
-tokenInfo.isMtClient // for internal use
+tokenInfo.iat // token creation timestamp,
+tokenInfo.exp // token expiration timestamp,
+tokenInfo.sub // guest uid or null,
+tokenInfo.scope // string with space separated scopes
+tokenInfo.client_id // application client id or null
+tokenInfo.app // application related information or null
+tokenInfo.app.name // application name
+tokenInfo.app.is_mt // is moneytree client (internal usage)
+tokenInfo.guest // guest related information or null
+tokenInfo.guest.email // guest email if available
+tokenInfo.guest.country // guest country
+tokenInfo.guest.currency // guest currency,
+tokenInfo.guest.lang // guest language
 ```
 
 | Parameter | Type | Required | Default Value | Description |

src/api/__tests__/token-info.test.ts

@@ -20,7 +20,7 @@ describe('api', () => {
         name: 'aud-name',
       },
       exp: 'exp',
-      scopes: 'scopes',
+      scopes: ['scopes'],
     };
 
     const mtLinkSdk = new MtLinkSdk();

src/api/token-info.ts

@@ -1,3 +1,5 @@
+import { stringify } from 'qs';
+import { generateConfigs } from '../helper';
 import { MY_ACCOUNT_DOMAINS } from '../server-paths';
 import { StoredOptions, TokenInfo } from '../typings';
 
@@ -11,12 +13,17 @@ export default async function tokenInfo(
     throw new Error('[mt-link-sdk] Missing parameter `token` in `tokenInfo`.');
   }
 
+  const queryString = stringify({
+    client_id: clientId,
+    configs: generateConfigs()
+  })
+
   try {
-    const response = await fetch(`${MY_ACCOUNT_DOMAINS[mode]}/oauth/token/info.json`, {
+    const response = await fetch(`${MY_ACCOUNT_DOMAINS[mode]}/oauth/token/info.json?${queryString}`, {
       method: 'GET',
       headers: {
         Authorization: `Bearer ${token}`,
-        'x-api-key': clientId as string,
+        'API-Version': '1604911588',
       },
     });
 
@@ -26,18 +33,7 @@ export default async function tokenInfo(
       throw new Error(result.error_description);
     }
 
-    return {
-      guestUid: result.uid,
-      resourceServer: result.resource_server,
-      country: result.country,
-      currency: result.currency,
-      language: result.locale,
-      clientId: result.aud.uid,
-      clientName: result.aud.name,
-      expTimestamp: result.exp,
-      scopes: result.scopes,
-      isMtClient: result.is_mt_client,
-    };
+    return result;
   } catch (error) {
     throw new Error(`[mt-link-sdk] \`tokenInfo\` execution failed. ${error}`);
   }

src/helper.ts

@@ -72,7 +72,7 @@ export function generateConfigs(configs: ConfigsOptions = {}): string {
   ];
 
   for (const key in configs) {
-    if (configKeys.includes(key)) {
+    if (configKeys.indexOf(key) !== -1) {
       snakeCaseConfigs[snakeCase(key)] = configs[key as keyof ConfigsOptions];
     }
   }

src/typings.ts

@@ -111,14 +111,21 @@ export interface RequestMagicLinkOptions extends ConfigsOptions {
 }
 
 export interface TokenInfo {
-  guestUid: string;
-  resourceServer: string;
-  country: string;
-  currency: string;
-  language: string;
-  clientName: string;
-  clientId: string;
-  expTimestamp: number;
-  scopes: Scopes;
-  isMtClient: boolean;
+  iss: string;
+  iat: number;
+  exp: number;
+  aud: string[];
+  sub: null | string;
+  scope: string;
+  client_id: null | string;
+  app: null | {
+    name: string;
+    is_mt: boolean;
+  };
+  guest: null | {
+    email: string;
+    country: string;
+    currency: string;
+    lang: string;
+  };
 }