default.js.hbs

/*
 * Copyright (c) 2023, 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
 */
/* eslint-disable @typescript-eslint/no-var-requires */
const sites = require('./sites.js')
const {parseSettings, validateOtpTokenLength} = require('./utils.js')

module.exports = {
    app: {
        // Enable the store locator and shop the store feature.
        storeLocatorEnabled: true,
        // Enable the multi-ship feature.
        multishipEnabled: true,
        // Enable partial hydration capabilities via Island component
        {{#if answers.project.partialHydrationEnabled}}
        partialHydrationEnabled: {{answers.project.partialHydrationEnabled}},
        {{else}}
        partialHydrationEnabled: false,
        {{/if}}
        // Commerce shopping agent configuration for embedded messaging service
        // This enables an agentic shopping experience in the application
        // This property accepts either a JSON string or a plain JavaScript object.
        commerceAgent: parseSettings(process.env.COMMERCE_AGENT_SETTINGS) || {
            enabled: 'false',
            askAgentOnSearch: 'false',
            embeddedServiceName: '',
            embeddedServiceEndpoint: '',
            scriptSourceUrl: '',
            scrt2Url: '',
            salesforceOrgId: '',
            commerceOrgId: '',
            siteId: '',
            enableConversationContext: 'false',
            conversationContext: [],
            enableAgentFromHeader: 'false',
            enableAgentFromFloatingButton: 'false',
            enableAgentFromSearchSuggestions: 'false'
        },
        // Customize how your 'site' and 'locale' are displayed in the url.
        url: {
            {{#if answers.project.demo.enableDemoSettings}}
            // Determine where the siteRef is located. Valid values include 'path|query_param|none'. Defaults to: 'none'
            site: 'path',
            // Determine where the localeRef is located. Valid values include 'path|query_param|none'. Defaults to: 'none'
            locale: 'path',
            // This boolean value dictates whether or not default site or locale values are shown in the url. Defaults to: false
            showDefaults: true,
            // This boolean value dictates whether or not the base path, defined in ssrParameters.envBasePath,
            // is shown in shopper facing urls. Defaults to: false
            showBasePath: false,
            {{else}}
            // Determine where the siteRef is located. Valid values include 'path|query_param|none'. Defaults to: 'none'
            site: 'none',
            // Determine where the localeRef is located. Valid values include 'path|query_param|none'. Defaults to: 'none'
            locale: 'none',
            // This boolean value dictates whether or not default site or locale values are shown in the url. Defaults to: false
            showDefaults: false,
            // This boolean value dictates whether or not the base path, defined in ssrParameters.envBasePath,
            // is shown in shopper facing urls. Defaults to: false
            showBasePath: false,
            {{/if}}
            // This boolean value dictates whether the plus sign (+) is interpreted as space for query param string. Defaults to: false
            interpretPlusSignAsSpace: false
        },
        login: {
            // The length of the token for OTP authentication. Used by passwordless login and reset password.
            // If the env var `OTP_TOKEN_LENGTH` is set, it will override the config value. Valid values are 6 or 8. Defaults to: 8
            tokenLength: validateOtpTokenLength(process.env.OTP_TOKEN_LENGTH),
            passwordless: {
                // Enables or disables passwordless login for the site. Defaults to: false
                {{#if answers.project.demo.enableDemoSettings}}
                enabled: true,
                {{else}}
                enabled: false,
                {{/if}}
                // The mode for passwordless login. Valid values include 'email|callback'. Defaults to: 'callback'
                mode: 'email',
                // The callback URI, which can be an absolute URL (including third-party URIs) or a relative path set up by the developer.
                // Required when mode is set to 'callback'. If the env var `PASSWORDLESS_LOGIN_CALLBACK_URI` is set, it will override the config value.
                // callbackURI:
                //     process.env.PASSWORDLESS_LOGIN_CALLBACK_URI || '/passwordless-login-callback',
                // The landing path for passwordless login
                landingPath: '/passwordless-login-landing'
            },
            social: {
                // Enables or disables social login for the site. Defaults to: false
                {{#if answers.project.demo.enableDemoSettings}}
                enabled: true,
                {{else}}
                enabled: false,
                {{/if}}
                // The third-party identity providers supported by your app. The PWA Kit supports Google and Apple by default.
                // Additional IDPs will also need to be added to the IDP_CONFIG in the SocialLogin component.
                idps: ['google', 'apple'],
                // The redirect URI used after a successful social login authentication.
                // This should be a relative path set up by the developer.
                // If the env var `SOCIAL_LOGIN_REDIRECT_URI` is set, it will override the config value.
                redirectURI: process.env.SOCIAL_LOGIN_REDIRECT_URI || '/social-callback'
            },
            resetPassword: {
                // The mode for reset password. Valid values include 'email|callback'. Defaults to: 'callback'
                mode: 'email',
                // The callback URI, which can be an absolute URL (including third-party URIs) or a relative path set up by the developer.
                // Required when mode is set to 'callback'. If the env var `RESET_PASSWORD_CALLBACK_URI` is set, it will override the config value.
                // callbackURI: process.env.RESET_PASSWORD_CALLBACK_URI || '/reset-password-callback',
                // The landing path for reset password
                landingPath: '/reset-password-landing'
            }
        },
        // The default site for your app. This value will be used when a siteRef could not be determined from the url
        defaultSite: '{{answers.project.commerce.siteId}}',
        // Provide aliases for your sites. These will be used in place of your site id when generating paths throughout the application.
        {{#if answers.project.demo.enableDemoSettings}}
        siteAliases: {
            RefArch: 'us',
            RefArchGlobal: 'global'
        },
        {{else}}
        // siteAliases: {
        //    RefArch: 'us',
        //    RefArchGlobal: 'global'
        // },
        {{/if}}
        // The sites for your app, which is imported from sites.js
        sites,
        // Commerce api config
        commerceAPI: {
            proxyPath: '/mobify/proxy/api',
            parameters: {
                clientId: '{{answers.project.commerce.clientId}}',
                organizationId: '{{answers.project.commerce.organizationId}}',
                shortCode: '{{answers.project.commerce.shortCode}}',
                siteId: '{{answers.project.commerce.siteId}}'
            }
        },
        // Einstein api config
        einsteinAPI: {
            host: 'https://api.cquotient.com',
            einsteinId: '{{answers.project.einstein.clientId}}',
            siteId: '{{answers.project.einstein.siteId}}',
            // Flag Einstein activities as coming from a production environment.
            // By setting this to true, the Einstein activities generated by the environment will appear
            // in production environment reports
            isProduction: false
        },
        // Datacloud api config
        dataCloudAPI: {
            appSourceId: '{{answers.project.dataCloud.appSourceId}}',
            tenantId: '{{answers.project.dataCloud.tenantId}}'
        },
        // When shoppers use passwordless OTP login with one-click checkout, the system saves their shipping and payment information for faster checkout in the future.
        //   To maintain security, implement these safeguards:
        //   1. Captcha - Protects the passwordless login from bots.
        //   2. OTP for Email Changes - Verifies your identity before an email update, prevents accidental account lockouts from typos, and prevents unauthorized users from gaining access to saved payment methods.
        // To use One Click Checkout, enable the oneClickCheckout flag and configure private SLAS client. For more details, please
        // check https://github.com/SalesforceCommerceCloud/pwa-kit/releases/tag/v3.16.0
        oneClickCheckout: {
            enabled: false
        },
        // Bonus product config
        pages: {
            cart: {
                groupBonusProductsWithQualifyingProduct: true
            }
        },
        // Salesforce Payments configuration
        // Set enabled to true to enable Salesforce Payments (requires the Salesforce Payments feature toggle to be enabled on the Commerce Cloud instance).
        // Set enabled to false to disable Salesforce Payments on the storefront (the Commerce Cloud feature toggle is unaffected).
        // Set the sdkUrl and metadataUrl values to point to your Commerce Cloud instance host by replacing the [bm_or_vanity_host] placeholder with your Business Manager or vanity URL host name.
        //   sdkUrl:       'https://[bm_or_vanity_host]/on/demandware.static/Sites-Site/-/-/internal/jscript/sfp/v1/sfp.js'
        //   metadataUrl:  'https://[bm_or_vanity_host]/on/demandware.static/Sites-Site/-/-/internal/metadata/v1.json'
        sfPayments: {
            enabled: false,
            sdkUrl: '',
            metadataUrl: ''
        },
        // Google Cloud api config
        googleCloudAPI: {
            apiKey: process.env.GOOGLE_CLOUD_API_KEY
        }
    },
    // This list contains server-side only libraries that you don't want to be compiled by webpack
    externals: [],
    // Page not found url for your app
    pageNotFoundURL: '/page-not-found',
    // Enables or disables building the files necessary for server-side rendering.
    ssrEnabled: true,
    // This list determines which files are available exclusively to the server-side rendering system
    // and are not available through the /mobify/bundle/ path.
    ssrOnly: ['ssr.js', 'ssr.js.map', 'node_modules/**/*.*'],
    // This list determines which files are available to the server-side rendering system
    // and available through the /mobify/bundle/ path.
    ssrShared: [
        'static/ico/favicon.ico',
        'static/robots.txt',
        '**/*.js',
        '**/*.js.map',
        '**/*.json'
    ],
    // Additional parameters that configure Express app behavior.
    ssrParameters: {
        ssrFunctionNodeVersion: '24.x',
        proxyConfigs: [
            {
                host: '{{answers.project.commerce.shortCode}}.api.commercecloud.salesforce.com',
                path: 'api'
            }{{~#if answers.project.commerce.instanceUrl}},
            {
                host: '{{answers.project.commerce.instanceUrl}}',
                path: 'ocapi'
            }{{/if}}
        ]
    }
}