`ServerConfig`

Overview

The ServerConfig interface extends the PublicConfig interface and represents the full set of configuration available in the High Velocity front-end app, including sensitive non-public values.

Configuration values are grouped by vendor or functionality. A configuration group can be retrieved server-side from Config() functions by its top level key name, for example, algolia.

Attributes

`algolia` (optional)

The Algolia configuration object.

Only required if the implementation uses Algolia search vendor package.

`algolia.indexName`

The name of the Algolia index.

`algolia.appID`

The application ID for Algolia.

`algolia.apiKey`

The API key for Algolia.

`isMerchantAssistantEnabled`

Flag indicating whether the Merchant Assistant feature is enabled.

`commerceTools` (optional)

The CommerceTools configuration object.

Only required if the implementation uses CommerceTools vendor package.

`commerceTools.currencyCode`

The currency code for CommerceTools.

`commerceTools.projectKey`

The project key for CommerceTools.

`commerceTools.clientID`

The client ID for CommerceTools.

`commerceTools.clientSecret`

The client secret for CommerceTools.

`commerceTools.scope`

The scope for CommerceTools.

`commerceTools.apiUrl`

The API URL for CommerceTools.

`commerceTools.authUrl`

The authentication URL for CommerceTools.

`shopify` (optional)

The Shopify configuration object.

Only required if the implementation uses Shopify commerce vendor package.

`shopify.storefrontAccessToken`

The storefront access token for Shopify.

`shopify.storeDomain`

The store domain for Shopify.

`shopify.mainMenuHandle`

The main menu handle for Shopify.

`bigcommerce` (optional)

The BigCommerce configuration object.

Only required if the implementation uses BigCommerce vendor package.

`bigcommerce.storeHash`

The store hash for BigCommerce.

`bigcommerce.accessToken`

The access token for BigCommerce.

`bigcommerce.unsafeApiToken` (optional)

The pre-created API token for BigCommerce.

`bigcommerce.currencyCode`

The currency code for BigCommerce.

`bigcommerce.channelDomain`

The channel domain for BigCommerce.

`stripeConfig` (optional)

The Stripe configuration object.

Only required if the implementation uses Stripe commerce vendor package.

`stripeConfig.webhookSecret`

The webhook secret for Stripe.

`stripeConfig.publishableKey`

The publishable key for Stripe.

`stripeConfig.secretKey`

The secret key for Stripe.

`stripeConfig.supportedCountries`

An array of supported countries for Stripe.

`amplience` (optional)

The Amplience configuration object.

Only required if the implementation uses Amplience CMS vendor package.

`amplience.hubName`

The hub name for Amplience.

`amplience.mediaCdn`

The media CDN for Amplience.

`amplience.schemaBaseUrl`

The schema base URL for Amplience.

`amplience.vse`

The VSE address for Amplience.

`amplience.useVse`

Flag indicating whether to use VSE for Amplience.

`googlePay` (optional)

The Google Pay configuration object.

Only required if the implementation uses Google Pay vendor package.

`googlePay.merchantId`

The merchant ID for Google Pay.

`googlePay.merchantName`

The merchant name for Google Pay.

`googlePay.gateway`

The gateway for Google Pay.

`googlePay.gatewayMerchantId`

The gateway merchant ID for Google Pay.

`googlePay.allowedCardNetworks` (optional)

An array of allowed card networks for Google Pay.

`googlePay.allowedAuthMethods` (optional)

An array of allowed authentication methods for Google Pay.

`googlePay.environment`

The environment for Google Pay.

`contentful` (optional)

The Contentful configuration object.

Only required if the implementation uses Contentful CMS vendor package.

`contentful.env`

The environment identifier for Contentful.

`contentful.spaceId`

The space ID for Contentful.

`contentful.host`

The host URL for accessing Contentful APIs.

`contentful.hostPreview`

The preview host URL for accessing Contentful APIs.

`contentful.accessToken`

The CDA access token for Contentful.

`contentful.accessTokenPreview`

The CPA access token for Contentful.

`sanity` (optional)

The Sanity configuration object.

Only required if the implementation uses Sanity CMS vendor package.

`sanity.projectId`

The project ID for Sanity.

`sanity.dataset`

The dataset name for Sanity.

`sanity.useCdn`

Flag indicating whether to use CDN for Sanity.

`sanity.apiVersion`

The API version for Sanity.

`sanity.token`

The authentication token for Sanity.

`sanity.mediaHost`

The media host URL for Sanity.

`sanity.perspective`

The perspective for Sanity.

`hygraph` (optional)

The Hygraph configuration object.

Only required if the implementation uses Hygraph CMS vendor package.

`hygraph.env`

The environment for Hygraph.

`hygraph.envForLivePreview`

The environment for live preview in Hygraph.

`hygraph.pat`

The permanent auth token for Hygraph.

`hygraph.patForLivePreview`

The permanent auth token for live preview in Hygraph.

`hygraph.stage`

The stage for Hygraph.

`hygraph.stageForLivePreview`

The stage for live preview in Hygraph.

`disableSitemap` (optional)

Flag indicating whether the sitemap is disabled.

`contentstack` (optional)

The Contentstack configuration object.

Only required if the implementation uses Contentstack CMS vendor package.

`contentstack.apiKey`

The API key for Contentstack.

`contentstack.branch`

The branch for Contentstack.

`contentstack.deliveryToken`

The delivery token for Contentstack.

`contentstack.environment`

The environment for Contentstack.

`contentstack.livePreviewToken`

The live preview token for Contentstack.

Overview​

Attributes​

algolia (optional)​

algolia.indexName​

algolia.appID​

algolia.apiKey​

isMerchantAssistantEnabled​

commerceTools (optional)​

commerceTools.currencyCode​

commerceTools.projectKey​

commerceTools.clientID​

commerceTools.clientSecret​

commerceTools.scope​

commerceTools.apiUrl​

commerceTools.authUrl​

shopify (optional)​

shopify.storefrontAccessToken​

shopify.storeDomain​

shopify.mainMenuHandle​

bigcommerce (optional)​

bigcommerce.storeHash​

bigcommerce.accessToken​

bigcommerce.unsafeApiToken (optional)​

bigcommerce.currencyCode​

bigcommerce.channelDomain​

stripeConfig (optional)​

stripeConfig.webhookSecret​

stripeConfig.publishableKey​

stripeConfig.secretKey​

stripeConfig.supportedCountries​

amplience (optional)​

amplience.hubName​

amplience.mediaCdn​

amplience.schemaBaseUrl​

amplience.vse​

amplience.useVse​

googlePay (optional)​

googlePay.merchantId​

googlePay.merchantName​

googlePay.gateway​

googlePay.gatewayMerchantId​

googlePay.allowedCardNetworks (optional)​

googlePay.allowedAuthMethods (optional)​

googlePay.environment​

contentful (optional)​

contentful.env​

contentful.spaceId​

contentful.host​

contentful.hostPreview​

contentful.accessToken​

contentful.accessTokenPreview​

sanity (optional)​

sanity.projectId​

sanity.dataset​

sanity.useCdn​

sanity.apiVersion​

sanity.token​

sanity.mediaHost​

sanity.perspective​

hygraph (optional)​

hygraph.env​

hygraph.envForLivePreview​

hygraph.pat​

hygraph.patForLivePreview​

hygraph.stage​

hygraph.stageForLivePreview​

disableSitemap (optional)​

contentstack (optional)​

contentstack.apiKey​

contentstack.branch​

contentstack.deliveryToken​

contentstack.environment​

contentstack.livePreviewToken​