Adds template name to loginWithOTP and loginWithMagicLink

packages/@magic-sdk/provider/src/modules/auth.ts

@@ -49,11 +49,11 @@ export class AuthModule extends BaseModule {
       }).log();
     }
 
-    const { email, showUI = true, redirectURI } = configuration;
+    const { email, showUI = true, redirectURI, overrides } = configuration;
 
     const requestPayload = createJsonRpcRequestPayload(
       this.sdk.testMode ? MagicPayloadMethod.LoginWithMagicLinkTestMode : MagicPayloadMethod.LoginWithMagicLink,
-      [{ email, showUI, redirectURI }],
+      [{ email, showUI, redirectURI, overrides }],
     );
     return this.request<string | null, LoginWithMagicLinkEventHandlers>(requestPayload);
   }
@@ -78,10 +78,10 @@ export class AuthModule extends BaseModule {
    * of 15 minutes)
    */
   public loginWithEmailOTP(configuration: LoginWithEmailOTPConfiguration) {
-    const { email, showUI, deviceCheckUI } = configuration;
+    const { email, showUI, deviceCheckUI, overrides } = configuration;
     const requestPayload = createJsonRpcRequestPayload(
       this.sdk.testMode ? MagicPayloadMethod.LoginWithEmailOTPTestMode : MagicPayloadMethod.LoginWithEmailOTP,
-      [{ email, showUI, deviceCheckUI }],
+      [{ email, showUI, deviceCheckUI, overrides }],
     );
     const handle = this.request<string | null, LoginWithEmailOTPEventHandlers>(requestPayload);
     if (!deviceCheckUI && handle) {

packages/@magic-sdk/provider/test/spec/modules/auth/loginWithEmailOTP.spec.ts

@@ -37,6 +37,18 @@ test('Generates JSON RPC request payload with `showUI: false` parameter', async
   expect(requestPayload.params).toEqual([{ email: expectedEmail, showUI: false }]);
 });
 
+test('Generates JSON RPC request payload with `overrides` parameter', async () => {
+  const magic = createMagicSDK();
+  magic.auth.request = jest.fn();
+
+  await magic.auth.loginWithEmailOTP({ email: expectedEmail, overrides: { variation: 'my custom template' } });
+
+  const requestPayload = magic.auth.request.mock.calls[0][0];
+  expect(requestPayload.jsonrpc).toBe('2.0');
+  expect(requestPayload.method).toBe(MagicPayloadMethod.LoginWithEmailOTP);
+  expect(requestPayload.params).toEqual([{ email: expectedEmail, overrides: { variation: 'my custom template' } }]);
+});
+
 test('If `testMode` is enabled, testing-specific RPC method is used', async () => {
   const magic = createMagicSDKTestMode();
   magic.auth.request = jest.fn();

packages/@magic-sdk/provider/test/spec/modules/auth/loginWithMagicLink.spec.ts

@@ -48,6 +48,20 @@ test('Generates JSON RPC request payload with `redirectURI` parameter', async ()
   expect(requestPayload.params).toEqual([{ email: 'test', showUI: true, redirectURI: 'helloworld' }]);
 });
 
+test('Generates JSON RPC request payload with `overrides` parameter', async () => {
+  const magic = createMagicSDK();
+  magic.auth.request = jest.fn();
+
+  await magic.auth.loginWithMagicLink({ email: 'test', showUI: true, overrides: { variation: 'my custom template' } });
+
+  const requestPayload = magic.auth.request.mock.calls[0][0];
+  expect(requestPayload.jsonrpc).toBe('2.0');
+  expect(requestPayload.method).toBe(MagicPayloadMethod.LoginWithMagicLink);
+  expect(requestPayload.params).toEqual([
+    { email: 'test', showUI: true, overrides: { variation: 'my custom template' } },
+  ]);
+});
+
 test('If `testMode` is enabled, testing-specific RPC method is used', async () => {
   const magic = createMagicSDKTestMode();
   magic.auth.request = jest.fn();

packages/@magic-sdk/types/src/modules/auth-types.ts

@@ -18,6 +18,15 @@ export interface LoginWithMagicLinkConfiguration {
    * configure here.
    */
   redirectURI?: string;
+
+  /**
+   * Enterprise users with a custom SMTP can create custom email templates
+   * from their dashboard. The default Magic loginWithMagicLink email will be
+   * overriden when a variation is passed here.
+   */
+  overrides?: {
+    variation?: string;
+  };
 }
 
 export interface LoginWithSmsConfiguration {
@@ -54,6 +63,15 @@ export interface LoginWithEmailOTPConfiguration {
    * handle device check events, providing a more tailored user experience.
    */
   deviceCheckUI?: boolean;
+
+  /**
+   * Enterprise users with a custom SMTP can create custom email templates
+   * from their dashboard. The default Magic loginWithOTP email will be
+   * overriden when a variation is passed here.
+   */
+  overrides?: {
+    variation?: string;
+  };
 }
 
 /**