@salesforce/retail-react-app 6.0.0-preview.3 → 6.0.0-preview.5

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+## v6.0.0-preview.5 (Feb 17, 2025)
+
 ## v6.0.0
 - DNT Consent Banner: [#2203](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2203)
 - Support Node 22 [#2218](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2218)

package/app/ssr.js

@@ -16,22 +16,15 @@
 
 'use strict'
 
+import crypto from 'crypto'
+import express from 'express'
+import helmet from 'helmet'
+import {createRemoteJWKSet as joseCreateRemoteJWKSet, jwtVerify, decodeJwt} from 'jose'
 import path from 'path'
 import {getRuntime} from '@salesforce/pwa-kit-runtime/ssr/server/express'
 import {defaultPwaKitSecurityHeaders} from '@salesforce/pwa-kit-runtime/utils/middleware'
 import {getConfig} from '@salesforce/pwa-kit-runtime/utils/ssr-config'
-import helmet from 'helmet'
-
-import express from 'express'
-import {emailLink} from '@salesforce/retail-react-app/app/utils/marketing-cloud/marketing-cloud-email-link'
-import {
-    PASSWORDLESS_LOGIN_LANDING_PATH,
-    RESET_PASSWORD_LANDING_PATH
-} from '@salesforce/retail-react-app/app/constants'
-import {
-    validateSlasCallbackToken,
-    jwksCaching
-} from '@salesforce/retail-react-app/app/utils/jwt-utils'
+import {getAppOrigin} from '@salesforce/pwa-kit-react-sdk/utils/url'
 
 const config = getConfig()
 
@@ -78,6 +71,117 @@ const options = {
 
 const runtime = getRuntime()
 
+/**
+ * Tokens are valid for 20 minutes. We store it at the top level scope to reuse
+ * it during the lambda invocation. We'll refresh it after 15 minutes.
+ */
+let marketingCloudToken = ''
+let marketingCloudTokenExpiration = new Date()
+
+/**
+ * Generates a unique ID for the email message.
+ *
+ * @return {string} A unique ID for the email message.
+ */
+function generateUniqueId() {
+    return crypto.randomBytes(16).toString('hex')
+}
+
+/**
+ * Sends an email to a specified contact using the Marketing Cloud API. The template email must have a
+ * `%%magic-link%%` personalization string inserted.
+ * https://help.salesforce.com/s/articleView?id=mktg.mc_es_personalization_strings.htm&type=5
+ *
+ * @param {string} email - The email address of the contact to whom the email will be sent.
+ * @param {string} templateId - The ID of the email template to be used for the email.
+ * @param {string} magicLink - The magic link to be included in the email.
+ *
+ * @return {Promise<object>} A promise that resolves to the response object received from the Marketing Cloud API.
+ */
+async function sendMarketingCloudEmail(emailId, marketingCloudConfig) {
+    // Refresh token if expired
+    if (new Date() > marketingCloudTokenExpiration) {
+        const {clientId, clientSecret, subdomain} = marketingCloudConfig
+        const tokenUrl = `https://${subdomain}.auth.marketingcloudapis.com/v2/token`
+        const tokenResponse = await fetch(tokenUrl, {
+            method: 'POST',
+            headers: {'Content-Type': 'application/json'},
+            body: JSON.stringify({
+                grant_type: 'client_credentials',
+                client_id: clientId,
+                client_secret: clientSecret
+            })
+        })
+
+        if (!tokenResponse.ok)
+            throw new Error(
+                'Failed to fetch Marketing Cloud access token. Check your Marketing Cloud credentials and try again.'
+            )
+
+        const {access_token} = await tokenResponse.json()
+        marketingCloudToken = access_token
+        // Set expiration to 15 mins
+        marketingCloudTokenExpiration = new Date(Date.now() + 15 * 60 * 1000)
+    }
+
+    // Send the email
+    const emailUrl = `https://${
+        marketingCloudConfig.subdomain
+    }.rest.marketingcloudapis.com/messaging/v1/email/messages/${generateUniqueId()}`
+    const emailResponse = await fetch(emailUrl, {
+        method: 'POST',
+        headers: {
+            Authorization: `Bearer ${marketingCloudToken}`,
+            'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+            definitionKey: marketingCloudConfig.templateId,
+            recipient: {
+                contactKey: emailId,
+                to: emailId,
+                attributes: {'magic-link': marketingCloudConfig.magicLink}
+            }
+        })
+    })
+
+    if (!emailResponse.ok) throw new Error('Failed to send email to Marketing Cloud')
+
+    return await emailResponse.json()
+}
+
+/**
+ * Generates a unique ID, constructs an email message URL, and sends the email to the specified contact
+ * using the Marketing Cloud API.
+ *
+ * @param {string} email - The email address of the contact to whom the email will be sent.
+ * @param {string} templateId - The ID of the email template to be used for the email.
+ * @param {string} magicLink - The magic link to be included in the email.
+ *
+ * @return {Promise<object>} A promise that resolves to the response object received from the Marketing Cloud API.
+ */
+export async function emailLink(emailId, templateId, magicLink) {
+    if (!process.env.MARKETING_CLOUD_CLIENT_ID) {
+        console.warn('MARKETING_CLOUD_CLIENT_ID is not set in the environment variables.')
+    }
+
+    if (!process.env.MARKETING_CLOUD_CLIENT_SECRET) {
+        console.warn(' MARKETING_CLOUD_CLIENT_SECRET is not set in the environment variables.')
+    }
+
+    if (!process.env.MARKETING_CLOUD_SUBDOMAIN) {
+        console.warn('MARKETING_CLOUD_SUBDOMAIN is not set in the environment variables.')
+    }
+
+    const marketingCloudConfig = {
+        clientId: process.env.MARKETING_CLOUD_CLIENT_ID,
+        clientSecret: process.env.MARKETING_CLOUD_CLIENT_SECRET,
+        magicLink: magicLink,
+        subdomain: process.env.MARKETING_CLOUD_SUBDOMAIN,
+        templateId: templateId
+    }
+    return await sendMarketingCloudEmail(emailId, marketingCloudConfig)
+}
+
 const resetPasswordCallback =
     config.app.login?.resetPassword?.callbackURI || '/reset-password-callback'
 const passwordlessLoginCallback =
@@ -94,11 +198,11 @@ async function sendMagicLinkEmail(req, res, landingPath, emailTemplate, redirect
 
     // Construct the magic link URL
     let magicLink = `${base}${landingPath}?token=${encodeURIComponent(token)}`
-    if (landingPath === RESET_PASSWORD_LANDING_PATH) {
+    if (landingPath === config.app.login?.resetPassword?.landingPath) {
         // Add email query parameter for reset password flow
         magicLink += `&email=${encodeURIComponent(email_id)}`
     }
-    if (landingPath === PASSWORDLESS_LOGIN_LANDING_PATH && redirectUrl) {
+    if (landingPath === config.app.login?.passwordless?.landingPath && redirectUrl) {
         magicLink += `&redirect_url=${encodeURIComponent(redirectUrl)}`
     }
 
@@ -109,6 +213,85 @@ async function sendMagicLinkEmail(req, res, landingPath, emailTemplate, redirect
     res.send(emailLinkResponse)
 }
 
+const CLAIM = {
+    ISSUER: 'iss'
+}
+
+const DELIMITER = {
+    ISSUER: '/'
+}
+
+const throwSlasTokenValidationError = (message, code) => {
+    throw new Error(`SLAS Token Validation Error: ${message}`, code)
+}
+
+export const createRemoteJWKSet = (tenantId) => {
+    const appOrigin = getAppOrigin()
+    const {app: appConfig} = getConfig()
+    const shortCode = appConfig.commerceAPI.parameters.shortCode
+    const configTenantId = appConfig.commerceAPI.parameters.organizationId.replace(/^f_ecom_/, '')
+    if (tenantId !== configTenantId) {
+        throw new Error(
+            `The tenant ID in your PWA Kit configuration ("${configTenantId}") does not match the tenant ID in the SLAS callback token ("${tenantId}").`
+        )
+    }
+    const JWKS_URI = `${appOrigin}/${shortCode}/${tenantId}/oauth2/jwks`
+    return joseCreateRemoteJWKSet(new URL(JWKS_URI))
+}
+
+export const validateSlasCallbackToken = async (token) => {
+    const payload = decodeJwt(token)
+    const subClaim = payload[CLAIM.ISSUER]
+    const tokens = subClaim.split(DELIMITER.ISSUER)
+    const tenantId = tokens[2]
+    try {
+        const jwks = createRemoteJWKSet(tenantId)
+        const {payload} = await jwtVerify(token, jwks, {})
+        return payload
+    } catch (error) {
+        throwSlasTokenValidationError(error.message, 401)
+    }
+}
+
+const tenantIdRegExp = /^[a-zA-Z]{4}_([0-9]{3}|s[0-9]{2}|stg|dev|prd)$/
+const shortCodeRegExp = /^[a-zA-Z0-9-]+$/
+
+/**
+ *  Handles JWKS (JSON Web Key Set) caching the JWKS response for 2 weeks.
+ *
+ * @param {object} req Express request object.
+ * @param {object} res Express response object.
+ * @param {object} options Options for fetching B2C Commerce API JWKS.
+ * @param {string} options.shortCode - The Short Code assigned to the realm.
+ * @param {string} options.tenantId - The Tenant ID for the ECOM instance.
+ * @returns {Promise<*>} Promise with the JWKS data.
+ */
+export async function jwksCaching(req, res, options) {
+    const {shortCode, tenantId} = options
+
+    const isValidRequest = tenantIdRegExp.test(tenantId) && shortCodeRegExp.test(shortCode)
+    if (!isValidRequest)
+        return res
+            .status(400)
+            .json({error: 'Bad request parameters: Tenant ID or short code is invalid.'})
+    try {
+        const JWKS_URI = `https://${shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/f_ecom_${tenantId}/oauth2/jwks`
+        const response = await fetch(JWKS_URI)
+
+        if (!response.ok) {
+            throw new Error('Request failed with status: ' + response.status)
+        }
+
+        // JWKS rotate every 30 days. For now, cache response for 14 days so that
+        // fetches only need to happen twice a month
+        res.set('Cache-Control', 'public, max-age=1209600, stale-while-revalidate=86400')
+
+        return res.json(await response.json())
+    } catch (error) {
+        res.status(400).json({error: `Error while fetching data: ${error.message}`})
+    }
+}
+
 const {handler} = runtime.createHandler(options, (app) => {
     app.use(express.json()) // To parse JSON payloads
     app.use(express.urlencoded({extended: true}))
@@ -160,7 +343,7 @@ const {handler} = runtime.createHandler(options, (app) => {
             sendMagicLinkEmail(
                 req,
                 res,
-                PASSWORDLESS_LOGIN_LANDING_PATH,
+                config.app.login?.passwordless?.landingPath,
                 process.env.MARKETING_CLOUD_PASSWORDLESS_LOGIN_TEMPLATE,
                 redirectUrl
             )
@@ -177,7 +360,7 @@ const {handler} = runtime.createHandler(options, (app) => {
             sendMagicLinkEmail(
                 req,
                 res,
-                RESET_PASSWORD_LANDING_PATH,
+                config.app.login?.resetPassword?.landingPath,
                 process.env.MARKETING_CLOUD_RESET_PASSWORD_TEMPLATE
             )
         })

package/babel.config.js

@@ -4,21 +4,4 @@
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const baseConfig = require('@salesforce/pwa-kit-dev/configs/babel/babel-config')
-
-module.exports = {
-    ...baseConfig.default,
-    plugins: [
-        ...baseConfig.default.plugins,
-        [
-            'module-resolver',
-            {
-                root: ['./'],
-                alias: {
-                    '@salesforce/retail-react-app': './'
-                }
-            }
-        ]
-    ]
-}
+module.exports = require('@salesforce/pwa-kit-dev/configs/babel/babel-config')

package/config/default.js

@@ -19,7 +19,8 @@ module.exports = {
             passwordless: {
                 enabled: false,
                 callbackURI:
-                    process.env.PASSWORDLESS_LOGIN_CALLBACK_URI || '/passwordless-login-callback'
+                    process.env.PASSWORDLESS_LOGIN_CALLBACK_URI || '/passwordless-login-callback',
+                landingPath: '/passwordless-login-landing'
             },
             social: {
                 enabled: false,
@@ -27,7 +28,8 @@ module.exports = {
                 redirectURI: process.env.SOCIAL_LOGIN_REDIRECT_URI || '/social-callback'
             },
             resetPassword: {
-                callbackURI: process.env.RESET_PASSWORD_CALLBACK_URI || '/reset-password-callback'
+                callbackURI: process.env.RESET_PASSWORD_CALLBACK_URI || '/reset-password-callback',
+                landingPath: '/reset-password-landing'
             }
         },
         defaultSite: 'RefArchGlobal',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/retail-react-app",
-  "version": "6.0.0-preview.3",
+  "version": "6.0.0-preview.5",
   "license": "See license in LICENSE",
   "author": "cc-pwa-kit@salesforce.com",
   "ccExtensibility": {
@@ -45,10 +45,10 @@
     "@lhci/cli": "^0.11.0",
     "@loadable/component": "^5.15.3",
     "@peculiar/webcrypto": "^1.4.2",
-    "@salesforce/commerce-sdk-react": "3.2.0-preview.3",
-    "@salesforce/pwa-kit-dev": "3.9.0-preview.3",
-    "@salesforce/pwa-kit-react-sdk": "3.9.0-preview.3",
-    "@salesforce/pwa-kit-runtime": "3.9.0-preview.3",
+    "@salesforce/commerce-sdk-react": "3.2.0-preview.5",
+    "@salesforce/pwa-kit-dev": "3.9.0-preview.5",
+    "@salesforce/pwa-kit-react-sdk": "3.9.0-preview.5",
+    "@salesforce/pwa-kit-runtime": "3.9.0-preview.5",
     "@tanstack/react-query": "^4.28.0",
     "@tanstack/react-query-devtools": "^4.29.1",
     "@testing-library/dom": "^9.0.1",
@@ -101,5 +101,5 @@
       "maxSize": "325 kB"
     }
   ],
-  "gitHead": "5fc2978c2b1ac9156613b01226dc9d0a42d24c32"
+  "gitHead": "e4b6ec6c2b694c561fc6902bec8a4e8c910f11fb"
 }

package/app/utils/jwt-utils.js

@@ -1,88 +0,0 @@
-/*
- * Copyright (c) 2025, salesforce.com, inc.
- * All rights reserved.
- * SPDX-License-Identifier: BSD-3-Clause
- * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-import {createRemoteJWKSet as joseCreateRemoteJWKSet, jwtVerify, decodeJwt} from 'jose'
-import {getAppOrigin} from '@salesforce/pwa-kit-react-sdk/utils/url'
-import {getConfig} from '@salesforce/pwa-kit-runtime/utils/ssr-config'
-
-const CLAIM = {
-    ISSUER: 'iss'
-}
-
-const DELIMITER = {
-    ISSUER: '/'
-}
-
-const throwSlasTokenValidationError = (message, code) => {
-    throw new Error(`SLAS Token Validation Error: ${message}`, code)
-}
-
-export const createRemoteJWKSet = (tenantId) => {
-    const appOrigin = getAppOrigin()
-    const {app: appConfig} = getConfig()
-    const shortCode = appConfig.commerceAPI.parameters.shortCode
-    const configTenantId = appConfig.commerceAPI.parameters.organizationId.replace(/^f_ecom_/, '')
-    if (tenantId !== configTenantId) {
-        throw new Error(
-            `The tenant ID in your PWA Kit configuration ("${configTenantId}") does not match the tenant ID in the SLAS callback token ("${tenantId}").`
-        )
-    }
-    const JWKS_URI = `${appOrigin}/${shortCode}/${tenantId}/oauth2/jwks`
-    return joseCreateRemoteJWKSet(new URL(JWKS_URI))
-}
-
-export const validateSlasCallbackToken = async (token) => {
-    const payload = decodeJwt(token)
-    const subClaim = payload[CLAIM.ISSUER]
-    const tokens = subClaim.split(DELIMITER.ISSUER)
-    const tenantId = tokens[2]
-    try {
-        const jwks = createRemoteJWKSet(tenantId)
-        const {payload} = await jwtVerify(token, jwks, {})
-        return payload
-    } catch (error) {
-        throwSlasTokenValidationError(error.message, 401)
-    }
-}
-
-const tenantIdRegExp = /^[a-zA-Z]{4}_([0-9]{3}|s[0-9]{2}|stg|dev|prd)$/
-const shortCodeRegExp = /^[a-zA-Z0-9-]+$/
-
-/**
- *  Handles JWKS (JSON Web Key Set) caching the JWKS response for 2 weeks.
- *
- * @param {object} req Express request object.
- * @param {object} res Express response object.
- * @param {object} options Options for fetching B2C Commerce API JWKS.
- * @param {string} options.shortCode - The Short Code assigned to the realm.
- * @param {string} options.tenantId - The Tenant ID for the ECOM instance.
- * @returns {Promise<*>} Promise with the JWKS data.
- */
-export async function jwksCaching(req, res, options) {
-    const {shortCode, tenantId} = options
-
-    const isValidRequest = tenantIdRegExp.test(tenantId) && shortCodeRegExp.test(shortCode)
-    if (!isValidRequest)
-        return res
-            .status(400)
-            .json({error: 'Bad request parameters: Tenant ID or short code is invalid.'})
-    try {
-        const JWKS_URI = `https://${shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/f_ecom_${tenantId}/oauth2/jwks`
-        const response = await fetch(JWKS_URI)
-
-        if (!response.ok) {
-            throw new Error('Request failed with status: ' + response.status)
-        }
-
-        // JWKS rotate every 30 days. For now, cache response for 14 days so that
-        // fetches only need to happen twice a month
-        res.set('Cache-Control', 'public, max-age=1209600, stale-while-revalidate=86400')
-
-        return res.json(await response.json())
-    } catch (error) {
-        res.status(400).json({error: `Error while fetching data: ${error.message}`})
-    }
-}

package/app/utils/jwt-utils.test.js

@@ -1,134 +0,0 @@
-/*
- * Copyright (c) 2025, Salesforce, Inc.
- * All rights reserved.
- * SPDX-License-Identifier: BSD-3-Clause
- * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-import {createRemoteJWKSet as joseCreateRemoteJWKSet, jwtVerify, decodeJwt} from 'jose'
-import {
-    createRemoteJWKSet,
-    validateSlasCallbackToken
-} from '@salesforce/retail-react-app/app/utils/jwt-utils'
-import {getAppOrigin} from '@salesforce/pwa-kit-react-sdk/utils/url'
-import {getConfig} from '@salesforce/pwa-kit-runtime/utils/ssr-config'
-
-const MOCK_JWKS = {
-    keys: [
-        {
-            kty: 'EC',
-            crv: 'P-256',
-            use: 'sig',
-            kid: '8edb82b1-f6d5-49c1-bab2-c0d152ee3d0b',
-            x: 'i8e53csluQiqwP6Af8KsKgnUceXUE8_goFcvLuSzG3I',
-            y: 'yIH500tLKJtPhIl7MlMBOGvxQ_3U-VcrrXusr8bVr_0'
-        },
-        {
-            kty: 'EC',
-            crv: 'P-256',
-            use: 'sig',
-            kid: 'da9effc5-58cb-4a9c-9c9c-2919fb7d5e5e',
-            x: '_tAU1QSvcEkslcrbNBwx5V20-sN87z0zR7gcSdBETDQ',
-            y: 'ZJ7bgy7WrwJUGUtzcqm3MNyIfawI8F7fVawu5UwsN8E'
-        },
-        {
-            kty: 'EC',
-            crv: 'P-256',
-            use: 'sig',
-            kid: '5ccbbc6e-b234-4508-90f3-3b9b17efec16',
-            x: '9ULO2Atj5XToeWWAT6e6OhSHQftta4A3-djgOzcg4-Q',
-            y: 'JNuQSLMhakhLWN-c6Qi99tA5w-D7IFKf_apxVbVsK-g'
-        }
-    ]
-}
-
-jest.mock('@salesforce/pwa-kit-react-sdk/utils/url', () => ({
-    getAppOrigin: jest.fn()
-}))
-
-jest.mock('@salesforce/pwa-kit-runtime/utils/ssr-config', () => ({
-    getConfig: jest.fn()
-}))
-
-jest.mock('jose', () => ({
-    createRemoteJWKSet: jest.fn(),
-    jwtVerify: jest.fn(),
-    decodeJwt: jest.fn()
-}))
-
-describe('createRemoteJWKSet', () => {
-    afterEach(() => {
-        jest.restoreAllMocks()
-    })
-
-    it('constructs the correct JWKS URI and call joseCreateRemoteJWKSet', () => {
-        const mockTenantId = 'aaaa_001'
-        const mockAppOrigin = 'https://test-storefront.com'
-        getAppOrigin.mockReturnValue(mockAppOrigin)
-        getConfig.mockReturnValue({
-            app: {
-                commerceAPI: {
-                    parameters: {
-                        shortCode: 'abc123',
-                        organizationId: 'f_ecom_aaaa_001'
-                    }
-                }
-            }
-        })
-        joseCreateRemoteJWKSet.mockReturnValue('mockJWKSet')
-
-        const expectedJWKS_URI = new URL(`${mockAppOrigin}/abc123/aaaa_001/oauth2/jwks`)
-
-        const res = createRemoteJWKSet(mockTenantId)
-
-        expect(getAppOrigin).toHaveBeenCalled()
-        expect(getConfig).toHaveBeenCalled()
-        expect(joseCreateRemoteJWKSet).toHaveBeenCalledWith(expectedJWKS_URI)
-        expect(res).toBe('mockJWKSet')
-    })
-})
-
-describe('validateSlasCallbackToken', () => {
-    beforeEach(() => {
-        jest.resetAllMocks()
-        const mockAppOrigin = 'https://test-storefront.com'
-        getAppOrigin.mockReturnValue(mockAppOrigin)
-        getConfig.mockReturnValue({
-            app: {
-                commerceAPI: {
-                    parameters: {
-                        shortCode: 'abc123',
-                        organizationId: 'f_ecom_aaaa_001'
-                    }
-                }
-            }
-        })
-        joseCreateRemoteJWKSet.mockReturnValue(MOCK_JWKS)
-    })
-
-    it('returns payload when callback token is valid', async () => {
-        decodeJwt.mockReturnValue({iss: 'slas/dev/aaaa_001'})
-        const mockPayload = {sub: '123', role: 'admin'}
-        jwtVerify.mockResolvedValue({payload: mockPayload})
-
-        const res = await validateSlasCallbackToken('mock.slas.token')
-
-        expect(jwtVerify).toHaveBeenCalledWith('mock.slas.token', MOCK_JWKS, {})
-        expect(res).toEqual(mockPayload)
-    })
-
-    it('throws validation error when the token is invalid', async () => {
-        decodeJwt.mockReturnValue({iss: 'slas/dev/aaaa_001'})
-        const mockError = new Error('Invalid token')
-        jwtVerify.mockRejectedValue(mockError)
-
-        await expect(validateSlasCallbackToken('mock.slas.token')).rejects.toThrow(
-            mockError.message
-        )
-        expect(jwtVerify).toHaveBeenCalledWith('mock.slas.token', MOCK_JWKS, {})
-    })
-
-    it('throws mismatch error when the config tenantId does not match the jwt tenantId', async () => {
-        decodeJwt.mockReturnValue({iss: 'slas/dev/zzrf_001'})
-        await expect(validateSlasCallbackToken('mock.slas.token')).rejects.toThrow()
-    })
-})

package/app/utils/marketing-cloud/marketing-cloud-email-link.js

@@ -1,136 +0,0 @@
-/*
- * Copyright (c) 2024, Salesforce, Inc.
- * All rights reserved.
- * SPDX-License-Identifier: BSD-3-Clause
- * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-
-/**
- * This file is responsible for integrating with the Marketing Cloud APIs to
- * send emails with a magic link to a specified contact using the Marketing Cloud API.
- * For this integration to work, a template email with a `%%magic-link%%` personalization string inserted
- * must exist in your Marketing Cloud org.
- *
- * More details here: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/transactional-messaging-get-started.html
- *
- * High Level Flow:
- * 1. It retrieves an access token from the Marketing Cloud API using the
- *    provided client ID and client secret.
- * 2. It constructs the email message URL using the generated unique ID and the
- *    provided template ID.
- * 3. It sends the email message containing the magic link to the specified contact
- *    using the Marketing Cloud API.
- */
-
-import crypto from 'crypto'
-
-/**
- * Tokens are valid for 20 minutes. We store it at the top level scope to reuse
- * it during the lambda invocation. We'll refresh it after 15 minutes.
- */
-let marketingCloudToken = ''
-let marketingCloudTokenExpiration = new Date()
-
-/**
- * Generates a unique ID for the email message.
- *
- * @return {string} A unique ID for the email message.
- */
-function generateUniqueId() {
-    return crypto.randomBytes(16).toString('hex')
-}
-
-/**
- * Sends an email to a specified contact using the Marketing Cloud API. The template email must have a
- * `%%magic-link%%` personalization string inserted.
- * https://help.salesforce.com/s/articleView?id=mktg.mc_es_personalization_strings.htm&type=5
- *
- * @param {string} email - The email address of the contact to whom the email will be sent.
- * @param {string} templateId - The ID of the email template to be used for the email.
- * @param {string} magicLink - The magic link to be included in the email.
- *
- * @return {Promise<object>} A promise that resolves to the response object received from the Marketing Cloud API.
- */
-async function sendMarketingCloudEmail(emailId, marketingCloudConfig) {
-    // Refresh token if expired
-    if (new Date() > marketingCloudTokenExpiration) {
-        const {clientId, clientSecret, subdomain} = marketingCloudConfig
-        const tokenUrl = `https://${subdomain}.auth.marketingcloudapis.com/v2/token`
-        const tokenResponse = await fetch(tokenUrl, {
-            method: 'POST',
-            headers: {'Content-Type': 'application/json'},
-            body: JSON.stringify({
-                grant_type: 'client_credentials',
-                client_id: clientId,
-                client_secret: clientSecret
-            })
-        })
-
-        if (!tokenResponse.ok)
-            throw new Error(
-                'Failed to fetch Marketing Cloud access token. Check your Marketing Cloud credentials and try again.'
-            )
-
-        const {access_token} = await tokenResponse.json()
-        marketingCloudToken = access_token
-        // Set expiration to 15 mins
-        marketingCloudTokenExpiration = new Date(Date.now() + 15 * 60 * 1000)
-    }
-
-    // Send the email
-    const emailUrl = `https://${
-        marketingCloudConfig.subdomain
-    }.rest.marketingcloudapis.com/messaging/v1/email/messages/${generateUniqueId()}`
-    const emailResponse = await fetch(emailUrl, {
-        method: 'POST',
-        headers: {
-            Authorization: `Bearer ${marketingCloudToken}`,
-            'Content-Type': 'application/json'
-        },
-        body: JSON.stringify({
-            definitionKey: marketingCloudConfig.templateId,
-            recipient: {
-                contactKey: emailId,
-                to: emailId,
-                attributes: {'magic-link': marketingCloudConfig.magicLink}
-            }
-        })
-    })
-
-    if (!emailResponse.ok) throw new Error('Failed to send email to Marketing Cloud')
-
-    return await emailResponse.json()
-}
-
-/**
- * Generates a unique ID, constructs an email message URL, and sends the email to the specified contact
- * using the Marketing Cloud API.
- *
- * @param {string} email - The email address of the contact to whom the email will be sent.
- * @param {string} templateId - The ID of the email template to be used for the email.
- * @param {string} magicLink - The magic link to be included in the email.
- *
- * @return {Promise<object>} A promise that resolves to the response object received from the Marketing Cloud API.
- */
-export async function emailLink(emailId, templateId, magicLink) {
-    if (!process.env.MARKETING_CLOUD_CLIENT_ID) {
-        console.warn('MARKETING_CLOUD_CLIENT_ID is not set in the environment variables.')
-    }
-
-    if (!process.env.MARKETING_CLOUD_CLIENT_SECRET) {
-        console.warn(' MARKETING_CLOUD_CLIENT_SECRET is not set in the environment variables.')
-    }
-
-    if (!process.env.MARKETING_CLOUD_SUBDOMAIN) {
-        console.warn('MARKETING_CLOUD_SUBDOMAIN is not set in the environment variables.')
-    }
-
-    const marketingCloudConfig = {
-        clientId: process.env.MARKETING_CLOUD_CLIENT_ID,
-        clientSecret: process.env.MARKETING_CLOUD_CLIENT_SECRET,
-        magicLink: magicLink,
-        subdomain: process.env.MARKETING_CLOUD_SUBDOMAIN,
-        templateId: templateId
-    }
-    return await sendMarketingCloudEmail(emailId, marketingCloudConfig)
-}

package/app/utils/marketing-cloud/marketing-cloud-email-link.test.js

@@ -1,65 +0,0 @@
-/*
- * Copyright (c) 2024, Salesforce, Inc.
- * All rights reserved.
- * SPDX-License-Identifier: BSD-3-Clause
- * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-import fetchMock from 'jest-fetch-mock'
-import {emailLink} from '@salesforce/retail-react-app/app/utils/marketing-cloud/marketing-cloud-email-link'
-
-const fetchOriginal = global.fetch
-const originalEnv = process.env
-
-beforeAll(() => {
-    global.fetch = fetchMock
-    global.fetch.mockResponse(JSON.stringify({}))
-    process.env = {
-        ...originalEnv,
-        MARKETING_CLOUD_CLIENT_ID: 'mc_client_id',
-        MARKETING_CLOUD_CLIENT_SECRET: 'mc_client_secret',
-        MARKETING_CLOUD_SUBDOMAIN: 'mc_subdomain.com'
-    }
-})
-
-afterAll(() => {
-    global.fetch = fetchOriginal
-    process.env = originalEnv
-})
-
-describe('emailLink()', () => {
-    it('should send an email with a magic link', async () => {
-        const email = 'test@example.com'
-        const templateId = '123'
-        const magicLink = 'https://magic-link.example.com'
-        await emailLink(email, templateId, magicLink)
-
-        expect(fetch).toHaveBeenCalledTimes(2)
-        expect(fetch).toHaveBeenNthCalledWith(
-            1,
-            `https://${process.env.MARKETING_CLOUD_SUBDOMAIN}.auth.marketingcloudapis.com/v2/token`,
-            {
-                body: JSON.stringify({
-                    grant_type: 'client_credentials',
-                    client_id: process.env.MARKETING_CLOUD_CLIENT_ID,
-                    client_secret: process.env.MARKETING_CLOUD_CLIENT_SECRET
-                }),
-                headers: {'Content-Type': 'application/json'},
-                method: 'POST'
-            }
-        )
-        expect(fetch).toHaveBeenNthCalledWith(
-            2,
-            expect.stringContaining(
-                `https://${process.env.MARKETING_CLOUD_SUBDOMAIN}.rest.marketingcloudapis.com/messaging/v1/email/messages/`
-            ),
-            {
-                body: JSON.stringify({
-                    definitionKey: templateId,
-                    recipient: {contactKey: email, to: email, attributes: {'magic-link': magicLink}}
-                }),
-                headers: expect.objectContaining({'Content-Type': 'application/json'}),
-                method: 'POST'
-            }
-        )
-    })
-})