feat(sdk): Add option to open vault directly in the update and delete…

… connection view
moneytree · Oct 23, 2024 · 0a5d61d · 0a5d61d
1 parent 8280682
commit 0a5d61d
Show file tree

Hide file tree

Showing 5 changed files with 140 additions and 4 deletions.
diff --git a/src/api/__tests__/open-service-url.test.ts b/src/api/__tests__/open-service-url.test.ts
@@ -98,6 +98,38 @@ describe('api', () => {
       expect(url).toBe(`${VAULT_DOMAINS.production}/connection/123?${query}`);
     });
 
+    test('vault/connection-update', () => {
+      const url = openServiceUrl(new MtLinkSdk().storedOptions, 'vault', {
+        view: 'connection-update',
+        credentialId: '123',
+        showRememberMe: false
+      });
+
+      const query = qs.stringify({
+        configs: generateConfigs({
+          showRememberMe: false
+        })
+      });
+
+      expect(url).toBe(`${VAULT_DOMAINS.production}/connection/123/update?${query}`);
+    });
+
+    test('vault/connection-delete', () => {
+      const url = openServiceUrl(new MtLinkSdk().storedOptions, 'vault', {
+        view: 'connection-delete',
+        credentialId: '123',
+        showRememberMe: false
+      });
+
+      const query = qs.stringify({
+        configs: generateConfigs({
+          showRememberMe: false
+        })
+      });
+
+      expect(url).toBe(`${VAULT_DOMAINS.production}/connection/123/delete?${query}`);
+    });
+
     test('vault/customer-support', () => {
       const url = openServiceUrl(new MtLinkSdk().storedOptions, 'vault', {
         view: 'customer-support',

diff --git a/src/api/__tests__/open-service.test.ts b/src/api/__tests__/open-service.test.ts
@@ -127,6 +127,48 @@ describe('api', () => {
       expect(open).toBeCalledWith(url, '_self', 'noreferrer');
     });
 
+    test('vault/connection-update', () => {
+      open.mockClear();
+
+      openService(new MtLinkSdk().storedOptions, 'vault', {
+        view: 'connection-update',
+        credentialId: '123',
+        showRememberMe: false
+      });
+
+      expect(open).toBeCalledTimes(1);
+
+      const query = qs.stringify({
+        configs: generateConfigs({
+          showRememberMe: false
+        })
+      });
+      const url = `${VAULT_DOMAINS.production}/connection/123/update?${query}`;
+
+      expect(open).toBeCalledWith(url, '_self', 'noreferrer');
+    });
+
+    test('vault/connection-delete', () => {
+      open.mockClear();
+
+      openService(new MtLinkSdk().storedOptions, 'vault', {
+        view: 'connection-delete',
+        credentialId: '123',
+        showRememberMe: false
+      });
+
+      expect(open).toBeCalledTimes(1);
+
+      const query = qs.stringify({
+        configs: generateConfigs({
+          showRememberMe: false
+        })
+      });
+      const url = `${VAULT_DOMAINS.production}/connection/123/delete?${query}`;
+
+      expect(open).toBeCalledWith(url, '_self', 'noreferrer');
+    });
+
     test('vault/customer-support', () => {
       open.mockClear();
 

diff --git a/src/api/open-service-url.ts b/src/api/open-service-url.ts
@@ -16,6 +16,8 @@ import {
   VaultOpenServiceUrlViewServiceList,
   VaultOpenServiceUrlViewServiceConnection,
   VaultOpenServiceUrlViewConnectionSetting,
+  VaultOpenServiceUrlViewConnectionUpdate,
+  VaultOpenServiceUrlViewConnectionDelete,
   VaultOpenServiceUrlViewCustomerSupport
 } from '../typings';
 
@@ -57,6 +59,16 @@ export default function openServiceUrl(
   serviceId: 'vault',
   options?: VaultOpenServiceUrlViewConnectionSetting
 ): string;
+export default function openServiceUrl(
+  storedOptions: StoredOptions,
+  serviceId: 'vault',
+  options?: VaultOpenServiceUrlViewConnectionUpdate
+): string;
+export default function openServiceUrl(
+  storedOptions: StoredOptions,
+  serviceId: 'vault',
+  options?: VaultOpenServiceUrlViewConnectionDelete
+): string;
 export default function openServiceUrl(
   storedOptions: StoredOptions,
   serviceId: 'vault',
@@ -105,17 +117,29 @@ export default function openServiceUrl(
             search
           })}`;
 
-        case 'service-connection':
-          // eslint-disable-next-line no-case-declarations
+        case 'service-connection': {
           const { entityKey } = options as VaultViewServiceConnection;
 
           return `${VAULT_DOMAINS[mode]}/service/${entityKey}?${getQueryValue()}`;
+        }
 
-        case 'connection-setting':
-          // eslint-disable-next-line no-case-declarations
+        case 'connection-setting': {
           const { credentialId } = options as VaultViewConnectionSetting;
 
           return `${VAULT_DOMAINS[mode]}/connection/${credentialId}?${getQueryValue()}`;
+        }
+
+        case 'connection-update': {
+          const { credentialId } = options as VaultViewConnectionSetting;
+
+          return `${VAULT_DOMAINS[mode]}/connection/${credentialId}/update?${getQueryValue()}`;
+        }
+
+        case 'connection-delete': {
+          const { credentialId } = options as VaultViewConnectionSetting;
+
+          return `${VAULT_DOMAINS[mode]}/connection/${credentialId}/delete?${getQueryValue()}`;
+        }
 
         case 'customer-support':
         default:

diff --git a/src/api/open-service.ts b/src/api/open-service.ts
@@ -8,6 +8,8 @@ import {
   VaultOpenServiceViewServiceList,
   VaultOpenServiceViewServiceConnection,
   VaultOpenServiceViewConnectionSetting,
+  VaultOpenServiceViewConnectionUpdate,
+  VaultOpenServiceViewConnectionDelete,
   VaultOpenServiceViewCustomerSupport,
   ConfigsOptions
 } from '../typings';
@@ -39,6 +41,16 @@ export default function openService(
   serviceId: 'vault',
   options?: VaultOpenServiceViewConnectionSetting
 ): void;
+export default function openService(
+  storedOptions: StoredOptions,
+  serviceId: 'vault',
+  options?: VaultOpenServiceViewConnectionUpdate
+): void;
+export default function openService(
+  storedOptions: StoredOptions,
+  serviceId: 'vault',
+  options?: VaultOpenServiceViewConnectionDelete
+): void;
 export default function openService(
   storedOptions: StoredOptions,
   serviceId: 'vault',

diff --git a/src/typings.ts b/src/typings.ts
@@ -135,11 +135,29 @@ export type VaultViewConnectionSetting = {
    */
   credentialId: string;
 };
+export type VaultViewConnectionUpdate = {
+  view: 'connection-update';
+  /**
+   * Credential ID.
+   * @remark ⚠️ If credentialId is invalid the Vault top page will be shown.
+   */
+  credentialId: string;
+};
+export type VaultViewConnectionDelete = {
+  view: 'connection-delete';
+  /**
+   * Credential ID.
+   * @remark ⚠️ If credentialId is invalid the Vault top page will be shown.
+   */
+  credentialId: string;
+};
 export type VaultViewCustomerSupport = { view: 'customer-support' };
 export type VaultServiceTypes =
   | VaultViewServiceList
   | VaultViewServiceConnection
   | VaultViewConnectionSetting
+  | VaultViewConnectionUpdate
+  | VaultViewConnectionDelete
   | VaultViewCustomerSupport;
 
 export type MyAccountServiceTypes = {
@@ -160,10 +178,14 @@ export type MyAccountOpenServiceUrlOptions =
 export type VaultOpenServiceViewServiceList = ConfigsOptions & VaultViewServiceList;
 export type VaultOpenServiceViewServiceConnection = ConfigsOptions & VaultViewServiceConnection;
 export type VaultOpenServiceViewConnectionSetting = ConfigsOptions & VaultViewConnectionSetting;
+export type VaultOpenServiceViewConnectionUpdate = ConfigsOptions & VaultViewConnectionUpdate;
+export type VaultOpenServiceViewConnectionDelete = ConfigsOptions & VaultViewConnectionDelete;
 export type VaultOpenServiceViewCustomerSupport = ConfigsOptions & VaultViewCustomerSupport;
 export type VaultOpenServiceUrlViewServiceList = ConfigsOptionsWithoutIsNewTab & VaultViewServiceList;
 export type VaultOpenServiceUrlViewServiceConnection = ConfigsOptionsWithoutIsNewTab & VaultViewServiceConnection;
 export type VaultOpenServiceUrlViewConnectionSetting = ConfigsOptionsWithoutIsNewTab & VaultViewConnectionSetting;
+export type VaultOpenServiceUrlViewConnectionUpdate = ConfigsOptionsWithoutIsNewTab & VaultViewConnectionUpdate;
+export type VaultOpenServiceUrlViewConnectionDelete = ConfigsOptionsWithoutIsNewTab & VaultViewConnectionDelete;
 export type VaultOpenServiceUrlViewCustomerSupport = ConfigsOptionsWithoutIsNewTab & VaultViewCustomerSupport;
 
 export type LinkKitOpenServiceOptions = ConfigsOptions;
@@ -174,13 +196,17 @@ export type OpenServiceOptions =
   | ConfigsOptions
   | VaultOpenServiceViewServiceList
   | VaultOpenServiceViewConnectionSetting
+  | VaultOpenServiceViewConnectionUpdate
+  | VaultOpenServiceViewConnectionDelete
   | VaultOpenServiceViewCustomerSupport
   | LinkKitOpenServiceOptions;
 export type OpenServiceUrlOptions =
   | MyAccountOpenServiceUrlOptions
   | ConfigsOptionsWithoutIsNewTab
   | VaultOpenServiceUrlViewServiceList
   | VaultOpenServiceUrlViewConnectionSetting
+  | VaultOpenServiceUrlViewConnectionUpdate
+  | VaultOpenServiceUrlViewConnectionDelete
   | VaultOpenServiceUrlViewCustomerSupport
   | LinkKitOpenServiceUrlOptions;