Broadleaf Microservices
  • v1.0.0-latest-prod

Next.js Starter Configuration Properties

Server Properties

  • NEXT_PUBLIC_API_ORIGIN

    • This is the origin of the app’s local server, this is used to hit the API routes defined in the app.

    • Default value http://localhost:4000.

Auth Properties

  • NEXT_PUBLIC_AUTH_BASEURL

  • NEXT_PUBLIC_USE_PKCE

    • Whether Proof-Key-for-Code-Exchange is enabled.

  • NEXT_PUBLIC_AUTH_CLIENTMODE

    • Indicates whether the app needs to resolve the authorized client dynamically or if it can be known statically. Typically, this is static whenever NEXT_PUBLIC_TENANT_RESOLVER_APPLICATION_RESOLUTION is token, meaning that the app is tied directly to a single Tenant Application by its Application#token.

    • Default value static. Otherwise, the app should resolve the Tenant Application dynamically based on the current URL in the browser.

  • NEXT_PUBLIC_AUTH_CLIENTID

    • Indicates the ID of the Authorized Client associated with this client app. This is required for user authentication.

    • Example value heatclinic.

  • NEXT_PUBLIC_AUTH_USERSCOPE

    • The scopes to use when getting authorization tokens for logged-in users.

    • Default value "USER CUSTOMER_USER".

  • NEXT_PUBLIC_AUTH_ACCOUNT_USERS_SCOPE

    • The additional scopes to use for users in B2B Account contexts.

    • Default value ACCOUNT_USERS.

  • NEXT_PUBLIC_AUTH_ACCOUNT_INVITE_SCOPE

    • The base scope required for a user to send and view invitations to users to join a B2B Account.

    • Default value ACCOUNT_INVITE.

  • NEXT_PUBLIC_AUTH_ACCOUNT_ADDRESS_SCOPE

    • The base scope required for a user to view or manage B2B Account shared addresses.

    • Default value ACCOUNT_ADDRESS.

  • NEXT_PUBLIC_AUTH_ACCOUNT_PAYMENT_SCOPE

    • The base scope required for a user to view or manage B2B Account shared payments.

    • Default value ACCOUNT_SAVED_PAYMENT_MANAGEMENT.

  • NEXT_PUBLIC_AUTH_APPROVE_CART

    • The base scope required for a user to approve B2B Account carts.

    • Default value APPROVE_CART.

  • NEXT_PUBLIC_AUTH_ACCOUNT_ORDER_SCOPE

    • The base scope required for a user to view or manage B2B Account shared orders.

    • Default value ACCOUNT_ORDER.

Embedded Login

  • NEXT_PUBLIC_USE_EMBEDDED_LOGIN

    • Whether the app uses an embedded login form rather than the Auth Service hosted form.

    • Default value false.

Refresh Token Rotation

  • NEXT_PUBLIC_AUTH_USE_REFRESH_TOKENS

    • Whether refresh token rotation is in use.

    • Default value false.

  • NEXT_PUBLIC_AUTH_USE_REFRESH_TOKENS_WITH_SESSION_STORAGE

    • Whether refresh tokens can be stored in session storage.

    • Default value false.

  • NEXT_PUBLIC_AUTH_USE_REFRESH_TOKENS_WITH_LOCAL_STORAGE

    • Whether refresh tokens can be stored in local storage.

    • Default value false.

CSR

  • NEXT_PUBLIC_AUTH_CSR_SCOPE

    • The base scope when getting authorization tokens for CSRs.

    • Default value "CSR PUBLISH_QUOTE".

Tenant Properties

  • NEXT_PUBLIC_TENANT_RESOLVER_APPLICATION_RESOLUTION

    • The type of resolution to use for the Tenant Application. This indicates the Application in context should be resolved using a token or via the URL in the browser.

    • Default value token.

    • Other possible value is url.

  • NEXT_PUBLIC_TENANT_RESOLVER_APPLICATION_TOKEN

    • If resolution type is token, then this is the value of the token to resolve. This can be found on the Application detail page in the Admin UI.

    • Default value HEAT_CLINIC.

  • NEXT_PUBLIC_TENANT_RESOLVER_FORWARD_HEADER

    • Indicates the name of the request header containing information if it was forwarded from another host. This is used in application resolution when the client app is behind a proxy gateway.

    • Default value x-forwarded-host.

  • NEXT_PUBLIC_CLIENT_BASE_HOST

    • Indicates the base host to use for requests made from the client by SDK agents.

    • Example value if using a remote backend https://heatclinic.ms.blcqa.com.

    • If using a local or same-origin backend, leave blank.

  • NEXT_PUBLIC_GATEWAY_HOST

Catalog Properties

  • NEXT_PUBLIC_CATEGORY_URL_PREFIX

    • Indicates the prefix for all category browse pages, if any.

    • Example value /category.

    • Blank by default.

  • NEXT_PUBLIC_PRODUCT_URL_PREFIX

    • Indicates the prefix for all product pages, if any.

    • Example value /product.

    • Blank by default.

  • NEXT_PUBLIC_CONTENT_URL_PREFIX

    • Indicates the prefix for all content pages, if any.

    • Example value /content.

    • Blank by default.

Payment Properties

  • NEXT_PUBLIC_PAYMENT_GATEWAY_TYPE

    • Default value PASSTHROUGH

    • Other support values:

      • CHECKOUT_COM

      • MY_FATOORAH

      • PAYPAL_CHECKOUT_V2

      • STRIPE

      • VERIFONE

  • NEXT_PUBLIC_PAYMENT_PAYPALCHECKOUT_CLIENT_ID

  • NEXT_PUBLIC_STRIPE_PUBLIC_API_KEY

  • NEXT_PUBLIC_CHECKOUT_COM_PUBLIC_API_KEY

  • NEXT_PUBLIC_CHECKOUT_COM_APPLE_PAY_ENABLED

    • Default value false

  • NEXT_PUBLIC_VERIFONE_PUBLIC_KEY

  • NEXT_PUBLIC_VERIFONE_PUBLIC_KEY_ALIAS

Content Security Properties

See Content Security Policies guide.

Item List Properties

  • NEXT_PUBLIC_RECENTLY_VIEWED_LIST_PERSIST_THRESHOLD

    • The threshold at which to save the recently viewed products to the DB. The list of recently-viewed products is stored in the browser until this limit is reached at which point it is sent to the Cart Service for persistence in an Item List.

    • Default value 1000

  • NEXT_PUBLIC_RECENTLY_VIEWED_LIST_DISPLAY_THRESHOLD

    • The number of recently viewed products to display.

    • Default value 15

Quote Properties