chore(magic-link): rename api to login-link

Author: mt-kenny

dist/api/request-login-link.d.ts

@@ -0,0 +1,2 @@
+import { StoredOptions, RequestLoginLinkOptions } from '../typings';
+export default function requestLoginLink(storedOptions: StoredOptions, options?: RequestLoginLinkOptions): Promise<void>;

dist/api/request-magic-link.d.ts

@@ -291,21 +291,21 @@ mtLinkSdk.openService('myaccount-settings', { view: 'update-email' });
 | serviceId | `myaccount-settings` | true | | Open MyAccount |
 | options.view | `authorized-applications`, `change-language`, `email-preferences`, `delete-account`, `update-email`, `update-password` | false | | Directly go to the chosen page. If no view is provided, it goes to the top page of MyAccount. |
 
-### requestMagicLink
+### requestLoginLink
 
-Request for a magic link (password-less login link) to be sent to the guest's email address. Clicking on the link in the email will log a guest in directly to the screen specified by the `magicLinkTo` parameter.
+Request for a password-less login link to be sent to the guest's email address. Clicking on the link in the email will log a guest in directly to the screen specified by the `loginLinkTo` parameter.
 
 <h6>Usage:</h6>
 
 ```javascript
-mtLinkSdk.requestMagicLink(options);
+mtLinkSdk.requestLoginLink(options);
 ```
 
 | Parameter | Type | Required | Default Value | Description |
 | - | - | - | - | - |
 | options | object | false | Value set during `init`. | Optional parameters. Includes all options in [common options](#common-api-options). |
-| options.magicLinkTo | string | true | `settings` (for mobile view)<p><strong>OR</strong></p>`settings/update-email` (for desktop view) | Redirection to location after login, currently supported locations include:<li>`settings` - Main Moneytree account settings screen.</li><li>`settings/authorized-applications` - List of apps currently connected to Moneytree.</li><li>`settings/change-language` - Change Moneytree account language screen.<li>`settings/email-preferences` - Change Moneytree email preferences screen</li><li>`settings/delete-account` - Delete Moneytree account screen.</li><li>`settings/update-email` - Change Moneytree account email screen.</li><li>`settings/update-password` - Change Moneytree account password screen.</li> |
-| options.email | string | true | Value set during `init`. | Magic link will be sent to this email.<br /><br /><strong>NOTE:</strong> This function will throw an error if both values here and from the [init options](?id=api-init_options) are undefined. |
+| options.loginLinkTo | string | true | `settings` (for mobile view)<p><strong>OR</strong></p>`settings/update-email` (for desktop view) | Redirection to location after login, currently supported locations include:<li>`settings` - Main Moneytree account settings screen.</li><li>`settings/authorized-applications` - List of apps currently connected to Moneytree.</li><li>`settings/change-language` - Change Moneytree account language screen.<li>`settings/email-preferences` - Change Moneytree email preferences screen</li><li>`settings/delete-account` - Delete Moneytree account screen.</li><li>`settings/update-email` - Change Moneytree account email screen.</li><li>`settings/update-password` - Change Moneytree account password screen.</li> |
+| options.email | string | true | Value set during `init`. | Login Link will be sent to this email.<br /><br /><strong>NOTE:</strong> This function will throw an error if both values here and from the [init options](?id=api-init_options) are undefined. |
 
 ## Common API options
 

docs/README.md

@@ -28,16 +28,16 @@ export default {
   logoutBtn: document.getElementById('logout-btn') as HTMLButtonElement,
   openServiceBtn: document.getElementById('open-service-btn') as HTMLButtonElement,
   tokenInfoBtn: document.getElementById('token-info-btn') as HTMLButtonElement,
-  sendMagicLinkBtn: document.getElementById('send-magic-link') as HTMLButtonElement,
+  sendLoginLinkBtn: document.getElementById('send-login-link') as HTMLButtonElement,
   doOnboardBtn: document.getElementById('do-onboard') as HTMLButtonElement,
   tokenElm: document.getElementById('token') as HTMLInputElement,
-  magicLinkToElm: document.getElementById('magicLinkTo') as HTMLSelectElement,
-  magicLinkEmailElm: document.getElementById('magicLink-email') as HTMLSelectElement,
+  loginLinkToElm: document.getElementById('loginLinkTo') as HTMLSelectElement,
+  loginLinkEmailElm: document.getElementById('loginLink-email') as HTMLSelectElement,
   tokenInfoLabel: document.getElementById('token-info-text') as HTMLInputElement,
   accessTokenLabel: document.getElementById('access-token-text') as HTMLParagraphElement,
   authorizationSection: document.getElementById('authorization-section') as HTMLDivElement,
   onBoardSection: document.getElementById('onboard-section') as HTMLDivElement,
-  magicLinkSection: document.getElementById('magic-link-section') as HTMLDivElement,
+  loginLinkSection: document.getElementById('login-link-section') as HTMLDivElement,
   openServiceSection: document.getElementById('open-service-section') as HTMLDivElement,
   logoutSection: document.getElementById('logout-section') as HTMLDivElement,
   tokenInfoSection: document.getElementById('token-info-section') as HTMLDivElement,

sample/src/elements.ts

@@ -151,12 +151,12 @@ <h3>Onboard</h3>
         <button id="do-onboard">Do Onboard</button>
       </section>
 
-      <section id="magic-link-section">
-        <h3>Magic Link</h3>
+      <section id="login-link-section">
+        <h3>Login Link</h3>
         <p>
-          <span style="color: red;">*</span>MagicLinkTo, <small>Redirection to location after login </small>
+          <span style="color: red;">*</span>LoginLinkTo, <small>Redirection to location after login </small>
           <div>
-            <select id="magicLinkTo">
+            <select id="loginLinkTo">
               <option value="settings" default>settings</option>
               <option value="settings/authorized-applications">settings/authorized-applications</option>
               <option value="settings/change-language">settings/change-language</option>
@@ -168,14 +168,14 @@ <h3>Magic Link</h3>
           </div>
         </p>
         <p>
-          <span style="color: red;">*</span>Email, <small>Magic link will be sent to this email.</small>
+          <span style="color: red;">*</span>Email, <small>Login Link will be sent to this email.</small>
           <div>
-            <input id="magicLink-email" type="email"/>
+            <input id="loginLink-email" type="email"/>
           </div>
         </p>
 
         <a href="#common-options"><h4>Common API options(optionals)</h4></a>
-        <button id="send-magic-link">Send Magic Link</button>
+        <button id="send-login-link">Send Login Link</button>
       </section>
 
 

sample/src/index.html

@@ -5,7 +5,7 @@ import mtLinkSdk, {
   OnboardOptions,
   OpenServicesConfigsOptions,
   ServiceId,
-  MagicLinkTo,
+  LoginLinkTo,
   ServicesListType,
 } from '@moneytree/mt-link-javascript-sdk';
 
@@ -178,23 +178,23 @@ elements.openServiceBtn.onclick = () => {
   mtLinkSdk.openService(serviceId, OpenServicesConfigsOptions);
 };
 
-// Launch open magic link
-elements.sendMagicLinkBtn.onclick = async () => {
-  const { sendMagicLinkBtn, magicLinkToElm, magicLinkEmailElm } = elements;
+// Launch open login link
+elements.sendLoginLinkBtn.onclick = async () => {
+  const { sendLoginLinkBtn, loginLinkToElm, loginLinkEmailElm } = elements;
 
   try {
-    sendMagicLinkBtn.disabled = true;
+    sendLoginLinkBtn.disabled = true;
 
-    await mtLinkSdk.requestMagicLink({
-      magicLinkTo: magicLinkToElm.options[magicLinkToElm.selectedIndex].value as MagicLinkTo,
-      email: magicLinkEmailElm.value,
+    await mtLinkSdk.requestLoginLink({
+      loginLinkTo: loginLinkToElm.options[loginLinkToElm.selectedIndex].value as LoginLinkTo,
+      email: loginLinkEmailElm.value,
     });
-    window.alert('Success, magicLink sent out.');
+    window.alert('Success, loginLink sent out.');
   } catch (error) {
     console.log(error);
   }
 
-  sendMagicLinkBtn.disabled = false;
+  sendLoginLinkBtn.disabled = false;
 };
 
 // Helper, to switch the vault options, depends on openService's serviceId value
@@ -241,7 +241,7 @@ const initializeLinkSDK = (options: InitOptions = {}) => {
 const switchAuthorizeFunctions = (value: string) => {
   elements.authorizationSection.style.display = value;
   elements.onBoardSection.style.display = value;
-  elements.magicLinkSection.style.display = value;
+  elements.loginLinkSection.style.display = value;
 };
 
 const disabledFunctions = () => {

sample/src/index.ts

@@ -4,7 +4,7 @@ import authorize from '../api/authorize';
 import onboard from '../api/onboard';
 import logout from '../api/logout';
 import openService from '../api/open-service';
-import requestMagicLink from '../api/request-magic-link';
+import requestLoginLink from '../api/request-login-link';
 import exchangeToken from '../api/exchange-token';
 import tokenInfo from '../api/token-info';
 import mtLinkSdk, { MtLinkSdk } from '..';
@@ -13,7 +13,7 @@ jest.mock('../api/authorize');
 jest.mock('../api/onboard');
 jest.mock('../api/logout');
 jest.mock('../api/open-service');
-jest.mock('../api/request-magic-link');
+jest.mock('../api/request-login-link');
 jest.mock('../api/exchange-token');
 jest.mock('../api/token-info');
 
@@ -49,9 +49,9 @@ describe('index', () => {
     expect(result4).toBeUndefined();
     expect(openService).toBeCalledWith(storedOptions, 'test', undefined);
 
-    const result5 = await instance.requestMagicLink({ magicLinkTo: 'magicLinkTo' });
+    const result5 = await instance.requestLoginLink({ loginLinkTo: 'loginLinkTo' });
     expect(result5).toBeUndefined();
-    expect(requestMagicLink).toBeCalledWith(storedOptions, { magicLinkTo: 'magicLinkTo' });
+    expect(requestLoginLink).toBeCalledWith(storedOptions, { loginLinkTo: 'loginLinkTo' });
 
     mocked(exchangeToken).mockResolvedValueOnce('test');
     const result6 = await instance.exchangeToken({ code: 'code' });

src/__tests__/index.test.ts

@@ -5,17 +5,17 @@ import qs from 'qs';
 
 import { MY_ACCOUNT_DOMAINS } from '../../server-paths';
 import { MtLinkSdk } from '../..';
-import requestMagicLink from '../request-magic-link';
+import requestLoginLink from '../request-login-link';
 import { generateConfigs } from '../../helper';
 
 describe('api', () => {
-  describe('request-magic-link', () => {
+  describe('request-login-link', () => {
     const clientId = 'clientId';
     const email = 'email';
 
     test('email is required', async () => {
-      await expect(requestMagicLink(new MtLinkSdk().storedOptions)).rejects.toThrow(
-        '[mt-link-sdk] Missing option `email` in `requestMagicLink`, make sure to pass one via `requestMagicLink` options or `init` options.'
+      await expect(requestLoginLink(new MtLinkSdk().storedOptions)).rejects.toThrow(
+        '[mt-link-sdk] Missing option `email` in `requestLoginLink`, make sure to pass one via `requestLoginLink` options or `init` options.'
       );
     });
 
@@ -25,15 +25,15 @@ describe('api', () => {
       fetch.mockClear();
       fetch.mockRejectedValueOnce(error);
 
-      await expect(requestMagicLink(new MtLinkSdk().storedOptions, { email })).rejects.toThrow(
-        `[mt-link-sdk] \`requestMagicLink\` execution failed. ${error}`
+      await expect(requestLoginLink(new MtLinkSdk().storedOptions, { email })).rejects.toThrow(
+        `[mt-link-sdk] \`requestLoginLink\` execution failed. ${error}`
       );
     });
 
-    test('default magicLinkTo to /settings', async () => {
+    test('default loginLinkTo to /settings', async () => {
       fetch.mockClear();
 
-      await requestMagicLink(new MtLinkSdk().storedOptions, { email });
+      await requestLoginLink(new MtLinkSdk().storedOptions, { email });
 
       const query = qs.stringify({
         configs: generateConfigs(),
@@ -56,12 +56,12 @@ describe('api', () => {
       });
     });
 
-    test('prefix magicLinkTo with "/" if provided value do not have one', async () => {
+    test('prefix loginLinkTo with "/" if provided value do not have one', async () => {
       fetch.mockClear();
 
-      await requestMagicLink(new MtLinkSdk().storedOptions, {
+      await requestLoginLink(new MtLinkSdk().storedOptions, {
         email,
-        magicLinkTo: 'settings/delete-account',
+        loginLinkTo: 'settings/delete-account',
       });
 
       const query = qs.stringify({
@@ -91,7 +91,7 @@ describe('api', () => {
       fetch.mockClear();
       fetch.mockResolvedValueOnce({ status: 400, statusText } as Response);
 
-      await expect(requestMagicLink(new MtLinkSdk().storedOptions, { email })).rejects.toThrow(
+      await expect(requestLoginLink(new MtLinkSdk().storedOptions, { email })).rejects.toThrow(
         statusText
       );
     });
@@ -109,7 +109,7 @@ describe('api', () => {
         cobrandClientId,
       });
 
-      await requestMagicLink(mtLinkSdk.storedOptions);
+      await requestLoginLink(mtLinkSdk.storedOptions);
 
       const query = qs.stringify({
         client_id: clientId,

src/api/__tests__/request-magic-link.test.ts renamed to src/api/__tests__/request-login-link.test.ts

@@ -2,19 +2,19 @@ import { stringify } from 'qs';
 
 import { generateConfigs, mergeConfigs, generateSdkHeaderInfo } from '../helper';
 import { MY_ACCOUNT_DOMAINS } from '../server-paths';
-import { StoredOptions, RequestMagicLinkOptions } from '../typings';
+import { StoredOptions, RequestLoginLinkOptions } from '../typings';
 
-export default async function requestMagicLink(
+export default async function requestLoginLink(
   storedOptions: StoredOptions,
-  options: RequestMagicLinkOptions = {}
+  options: RequestLoginLinkOptions = {}
 ): Promise<void> {
   const { clientId, mode, email: defaultEmail, cobrandClientId, locale } = storedOptions;
-  const { email = defaultEmail, magicLinkTo, ...rest } = options;
+  const { email = defaultEmail, loginLinkTo, ...rest } = options;
   const configs = mergeConfigs(storedOptions, rest, ['email']);
 
   if (!email) {
     throw new Error(
-      '[mt-link-sdk] Missing option `email` in `requestMagicLink`, make sure to pass one via `requestMagicLink` options or `init` options.'
+      '[mt-link-sdk] Missing option `email` in `requestLoginLink`, make sure to pass one via `requestLoginLink` options or `init` options.'
     );
   }
 
@@ -27,10 +27,10 @@ export default async function requestMagicLink(
 
   const url = `${MY_ACCOUNT_DOMAINS[mode]}/magic-link.json?${queryString}`;
 
-  let magicLinkToValue = magicLinkTo || '/settings';
+  let loginLinkToValue = loginLinkTo || '/settings';
 
-  if (magicLinkToValue[0] !== '/') {
-    magicLinkToValue = `/${magicLinkToValue}`;
+  if (loginLinkToValue[0] !== '/') {
+    loginLinkToValue = `/${loginLinkToValue}`;
   }
 
   try {
@@ -42,14 +42,14 @@ export default async function requestMagicLink(
       },
       body: JSON.stringify({
         email,
-        magic_link_to: magicLinkToValue,
+        magic_link_to: loginLinkToValue,
       }),
     });
 
     if (response.status < 200 || response.status >= 300) {
       throw new Error(response.statusText);
     }
   } catch (error) {
-    throw new Error(`[mt-link-sdk] \`requestMagicLink\` execution failed. ${error}`);
+    throw new Error(`[mt-link-sdk] \`requestLoginLink\` execution failed. ${error}`);
   }
 }

src/api/request-magic-link.ts renamed to src/api/request-login-link.ts

@@ -2,7 +2,7 @@ import authorize from './api/authorize';
 import onboard from './api/onboard';
 import logout from './api/logout';
 import openService from './api/open-service';
-import requestMagicLink from './api/request-magic-link';
+import requestLoginLink from './api/request-login-link';
 import exchangeToken from './api/exchange-token';
 import tokenInfo from './api/token-info';
 import {
@@ -14,7 +14,7 @@ import {
   AuthorizeOptions,
   OnboardOptions,
   ExchangeTokenOptions,
-  RequestMagicLinkOptions,
+  RequestLoginLinkOptions,
   TokenInfo,
   Mode,
 } from './typings';
@@ -60,8 +60,8 @@ export class MtLinkSdk {
     openService(this.storedOptions, serviceId, options);
   }
 
-  public requestMagicLink(options?: RequestMagicLinkOptions): Promise<void> {
-    return requestMagicLink(this.storedOptions, options);
+  public requestLoginLink(options?: RequestLoginLinkOptions): Promise<void> {
+    return requestLoginLink(this.storedOptions, options);
   }
 
   public exchangeToken(options?: ExchangeTokenOptions): Promise<string> {

src/index.ts

@@ -115,7 +115,7 @@ export type OnboardOptions = Omit<
 
 export type ServiceId = string | 'vault' | 'myaccount-settings' | 'linkkit';
 
-export type MagicLinkTo =
+export type LoginLinkTo =
   | string
   | 'settings'
   | 'settings/authorized-applications'
@@ -125,8 +125,8 @@ export type MagicLinkTo =
   | 'settings/update-email'
   | 'settings/update-password';
 
-export interface RequestMagicLinkOptions extends ConfigsOptions {
-  magicLinkTo?: MagicLinkTo;
+export interface RequestLoginLinkOptions extends ConfigsOptions {
+  loginLinkTo?: LoginLinkTo;
 }
 
 export interface TokenInfo {