@faststore/core 3.99.1 → 4.0.0-dev.1

package/src/server/cms/pdp.ts

@@ -11,6 +11,7 @@ type PDPSettings = {
       value?: string
     }
     seo?: {
+      titleTemplate?: string
       id?: string
       mainEntityOfPage?: string
     }

package/src/server/cms/plp.ts

@@ -13,6 +13,9 @@ type PLPSettings = {
     template?: {
       value?: string
     }
+    seo: {
+      titleTemplate?: string
+    }
     productGallery: {
       itemsPerPage: number
       sortBySelection: string

package/src/server/content/service.ts

@@ -1,32 +1,32 @@
+import type { ServerProductQueryQuery } from '@generated/graphql'
 import type { ContentData, Locator } from '@vtex/client-cms'
-import ClientCP from '@vtex/client-cp'
 import type { ContentEntry, EntryPathParams } from '@vtex/client-cp'
+import ClientCP from '@vtex/client-cp'
+import MissingContentError from 'src/sdk/error/MissingContentError'
+import MultipleContentError from 'src/sdk/error/MultipleContentError'
 import { getCMSPage, getPage, type PageContentType } from 'src/server/cms'
-import type { ContentOptions, ContentParams, PreviewData } from './types'
-import config from '../../../discovery.config'
-import { getPLP, type PLPContentType } from '../cms/plp'
 import {
   findBestPDPTemplate,
   findBestPLPTemplate,
   type Rewrite,
   type RewritesConfig,
 } from 'src/utils/multipleTemplates'
-import MissingContentError from 'src/sdk/error/MissingContentError'
+import config from '../../../discovery.config'
 import { getPDP, type PDPContentType } from '../cms/pdp'
-import MultipleContentError from 'src/sdk/error/MultipleContentError'
-import type { ServerProductQueryQuery } from '@generated/graphql'
+import { getPLP, type PLPContentType } from '../cms/plp'
+import type { ContentOptions, ContentParams } from './types'
 import { isBranchPreview, isContentPlatformSource } from './utils'
 
 type ContentResult = ContentData | (ContentEntry & PageContentType)
 
+const OPTIONAL_CONTENT_TYPES = [
+  'globalHeaderSections',
+  'globalFooterSections',
+] as const
 export class ContentService {
-  private clientCP: ClientCP
-
-  constructor() {
-    this.clientCP = new ClientCP({
-      tenant: config.api.storeId,
-    })
-  }
+  private readonly clientCP = new ClientCP({
+    tenant: config.api.storeId,
+  })
 
   async getSingleContent<T extends ContentData>(
     params: ContentParams
@@ -157,7 +157,13 @@ export class ContentService {
   ): Promise<PageContentType> {
     const { entries } = await this.clientCP.listEntries(params)
     if (!entries || entries.length === 0) {
-      console.warn('No entries found for params', params)
+      const isOptional = OPTIONAL_CONTENT_TYPES.includes(
+        params.contentType as (typeof OPTIONAL_CONTENT_TYPES)[number]
+      )
+
+      if (!isOptional) {
+        console.warn('No entries found for params', params)
+      }
       return {} as PageContentType
     }
     if (entries.length > 1) {
@@ -167,7 +173,13 @@ export class ContentService {
   }
 
   private createContentOptions(params: ContentParams): ContentOptions {
-    const { contentType, previewData, slug } = params
+    const { contentType, previewData, slug, locale } = params
+    const previewLocale = previewData?.locale
+    const effectiveLocale =
+      previewLocale !== undefined &&
+      (locale === undefined || locale === config.session.locale)
+        ? previewLocale
+        : locale
 
     const contentPreviewEnabled = previewData?.contentType === contentType
     const branchPreviewEnabled = isBranchPreview(previewData)
@@ -178,6 +190,7 @@ export class ContentService {
         contentPreviewEnabled,
         branchPreviewEnabled
       ),
+      ...(effectiveLocale !== undefined && { locale: effectiveLocale }),
       ...(slug !== undefined && { slug }),
       isPreview: contentPreviewEnabled || branchPreviewEnabled,
     }
@@ -191,6 +204,7 @@ export class ContentService {
         (config.contentSource as Record<string, string>)?.project ??
         'faststore',
       contentType: cmsOptions.contentType,
+      locale: options.locale,
       slug: options.slug,
     }
 
@@ -204,14 +218,12 @@ export class ContentService {
       params.branchId = cmsOptions.releaseId
     }
     if ('filters' in cmsOptions && cmsOptions.filters) {
-      const nested = (
-        cmsOptions.filters as { filters?: Record<string, unknown> }
-      ).filters as Record<string, unknown>
-      if (nested && nested['settings.seo.slug']) {
-        const seo = nested['settings.seo.slug'] as string
+      const filters = cmsOptions.filters as Record<string, unknown>
+      const seo = filters['settings.seo.slug']
+
+      if (typeof seo === 'string' && !params.slug) {
         params.slug = seo.replace(/^\//, '')
       }
-      Object.assign(params, cmsOptions.filters)
     }
 
     return params as EntryPathParams
@@ -230,7 +242,7 @@ export class ContentService {
       releaseId,
       filters,
     } = params
-    const { slug: _, ...previewLocator } = previewData || {}
+    const { slug: _, locale: __, ...previewLocator } = previewData ?? {}
 
     return {
       contentType,
@@ -254,7 +266,7 @@ export class ContentService {
       ...entry,
       ...data,
       id: entry.id,
-      name: entry.name || '',
+      name: entry.name ?? '',
     }
   }
 }

package/src/server/content/types.ts

@@ -7,20 +7,27 @@ export const ContentSourceType = {
 
 export type PreviewData = Locator & {
   slug?: string
+  locale?: string
 }
 
-export interface ContentParams {
-  contentType?: string
+export interface ContentRequestContext {
   previewData?: PreviewData | null
+  locale?: string
+}
+
+export interface ContentParams extends ContentRequestContext {
+  contentType?: string
   slug?: string
   documentId?: string
   versionId?: string
   releaseId?: string
-  filters?: Record<string, unknown>
+  filters?: Record<string, string>
+  locale?: string
 }
 
 export interface ContentOptions {
   cmsOptions: Options
+  locale?: string
   slug?: string
   isPreview: boolean
 }

package/src/server/index.ts

@@ -11,27 +11,24 @@ import { useParserCache } from '@envelop/parser-cache'
 import { useValidationCache } from '@envelop/validation-cache'
 import type { CacheControl, Maybe } from '@faststore/api'
 import {
-  authDirective,
-  cacheControlDirective,
   BadRequestError,
-  getContextFactory,
-  getResolvers,
+  GraphqlVtexContextFactory,
+  GraphqlVtexSchema,
   isFastStoreError,
 } from '@faststore/api'
 import { loadFilesSync } from '@graphql-tools/load-files'
+import { mergeTypeDefs } from '@graphql-tools/merge'
 import { makeExecutableSchema } from '@graphql-tools/schema'
 import type { TypeSource } from '@graphql-tools/utils'
 import * as GraphQLJS from 'graphql'
 import { GraphQLError } from 'graphql'
 import path from 'path'
 
-import persisted from '@generated/persisted-documents.json'
-
 import thirdPartyResolvers from '../customizations/src/graphql/thirdParty/resolvers'
 import vtexExtensionsResolvers from '../customizations/src/graphql/vtex/resolvers'
 
 import type { Operation } from '../sdk/graphql/request'
-import { apiOptions } from './options'
+import { apiOptions, withTraceClient } from './options'
 
 interface ExecuteOptions<V = Record<string, unknown>> {
   operation: Operation
@@ -39,9 +36,7 @@ interface ExecuteOptions<V = Record<string, unknown>> {
   query?: string | null
 }
 
-const persistedQueries = new Map(Object.entries(persisted))
-
-const apiContextFactory = getContextFactory(apiOptions)
+const persistedQueries = new Map()
 
 const customFormatError: MaskError = (err) => {
   if (err instanceof GraphQLError && isFastStoreError(err.originalError)) {
@@ -59,22 +54,25 @@ function loadGeneratedSchema(): TypeSource {
   })
 }
 
-function getFinalAPISchema() {
-  const generatedSchema = loadGeneratedSchema()
-  const nativeResolvers = getResolvers(apiOptions)
+export function getFinalAPISchema() {
+  const finalTypeDefs = mergeTypeDefs([
+    GraphqlVtexSchema(),
+    loadGeneratedSchema(),
+  ])
 
   const schema = makeExecutableSchema({
-    typeDefs: generatedSchema,
-    resolvers: [nativeResolvers, vtexExtensionsResolvers, thirdPartyResolvers],
+    typeDefs: finalTypeDefs,
+    resolvers: [vtexExtensionsResolvers, thirdPartyResolvers],
   })
 
-  // Apply directive transformations
-  const directives = [cacheControlDirective, authDirective]
-  return directives.reduce((s, d) => d.transformer(s), schema)
+  return GraphqlVtexSchema(schema)
 }
 
-export const getEnvelop = async () =>
-  envelop({
+export const getEnvelop = async () => {
+  const options = await withTraceClient(apiOptions)
+  const apiContextFactory = await GraphqlVtexContextFactory(options)
+
+  return envelop({
     plugins: [
       useEngine(GraphQLJS),
       useSchema(getFinalAPISchema()),
@@ -85,6 +83,7 @@ export const getEnvelop = async () =>
       useParserCache(),
     ],
   })
+}
 
 const envelopPromise = getEnvelop()
 
@@ -102,6 +101,14 @@ export const execute = async <V extends Maybe<{ [key: string]: unknown }>, D>(
   const { operation, variables, query: maybeQuery } = options
   const { operationHash, operationName } = operation['__meta__']
 
+  if (!persistedQueries.size) {
+    const persistedQueriesLoaded = await import(
+      '@generated/persisted-documents.json'
+    )
+    Object.entries(
+      persistedQueriesLoaded.default ?? persistedQueriesLoaded
+    ).forEach(([key, value]) => persistedQueries.set(key, value))
+  }
   const query = maybeQuery ?? persistedQueries.get(operationHash)
 
   if (query == null) {

package/src/server/options.ts

@@ -1,6 +1,9 @@
-import type { Options as APIOptions } from '@faststore/api'
-
+import type { APIOptions } from '@faststore/api'
+import { getTraceClient } from '@faststore/diagnostics'
 import storeConfig from '../../discovery.config'
+import pkgJSON from '../../package.json'
+
+const { name, version } = pkgJSON
 
 export const apiOptions: APIOptions = {
   platform: storeConfig.platform as APIOptions['platform'],
@@ -19,4 +22,26 @@ export const apiOptions: APIOptions = {
     enableUnavailableItemsOnCart:
       storeConfig.api?.enableUnavailableItemsOnCart ?? false,
   },
+  version,
+  OTEL: {
+    enabled: storeConfig.analytics.otelEnabled,
+  },
+  discoveryConfig: storeConfig,
+}
+
+export async function withTraceClient<T extends APIOptions = typeof apiOptions>(
+  apiOptions: T
+): Promise<T> {
+  const OTEL = {}
+  getTraceClient(
+    apiOptions?.discoveryConfig?.analytics?.serviceName ?? name
+  )?.inject(OTEL)
+
+  return {
+    ...apiOptions,
+    OTEL: {
+      ...OTEL,
+      enabled: storeConfig.analytics?.otelEnabled?.toString() === 'true',
+    },
+  } as T
 }

package/src/styles/global/index.scss

@@ -1,15 +1,18 @@
+@use "sass:meta";
+
 // Establish a layer order up-front, FS UI base styles have the lowest priority
 @layer base, components, theme;
 
 // FastStore UI's base styles
-@import "@faststore/ui/src/styles/global.scss";
+@include meta.load-css("~@faststore/ui/src/styles/global.scss");
 
 // Components & Sections styles
-@import "@faststore/ui/src/components/atoms/Skeleton/styles.scss";
-@import "@faststore/ui/src/components/atoms/Overlay/styles.scss";
-@import "@faststore/ui/src/components/atoms/SROnly/styles.scss";
-@import "src/components/sections/Section/section.scss";
+@include meta.load-css("~@faststore/ui/src/components/atoms/Skeleton/styles.scss");
+@include meta.load-css("~@faststore/ui/src/components/atoms/Overlay/styles.scss");
+@include meta.load-css("~@faststore/ui/src/components/atoms/SROnly/styles.scss");
+@include meta.load-css("src/components/sections/Section/section.scss");
 
 // Importing this component because is being used outside the context of the Section
-@import "@faststore/ui/src/components/organisms/QuickOrderDrawer/styles.scss";
-@import "@faststore/ui/src/components/organisms/SlideOver/styles.scss";
+@include meta.load-css("~@faststore/ui/src/components/molecules/Dropdown/styles.scss");
+@include meta.load-css("~@faststore/ui/src/components/organisms/QuickOrderDrawer/styles.scss");
+@include meta.load-css("~@faststore/ui/src/components/organisms/SlideOver/styles.scss");

package/src/styles/main.scss

@@ -1,5 +1,5 @@
 // The import order of these stylesheets does affect in the layers override
 // global/index.scss should be import before themes/index.scss
-@import "./global/index.scss";
-@import "../customizations/src/themes/index.scss";
-@import "../plugins/index.scss";
+@use "./global/index.scss" as global;
+@use "../customizations/src/themes/index.scss" as themes;
+@use "../plugins/index.scss" as plugins;

package/src/typings/locales.ts

@@ -0,0 +1,41 @@
+export type LocalesSettings = {
+  defaultLocale: string
+  regions?: Record<
+    string,
+    {
+      code: string
+      name: string
+      dateFormat: string
+      timeFormat: string
+      timeFormatMask: string
+      unitSystem: string
+      defaultTimezone: string
+    }
+  >
+  locales: Record<
+    string,
+    {
+      code: string
+      name: string
+      languageCode: string
+      languageName: string
+      script: string
+      textDirection: string
+      regionCode: string
+      bindings: Array<{
+        currencyCode: string
+        url: string
+        salesChannel: string
+        isDefault: boolean
+      }>
+    }
+  >
+  currencies?: Record<
+    string,
+    {
+      code: string
+      name: string
+      symbol: string
+    }
+  >
+}

package/src/utils/fetchProductGallerySSR.ts

@@ -50,6 +50,7 @@ export async function fetchServerManyProducts({
   selectedFacets = [],
   sponsoredCount = 3,
   filter = true,
+  locale,
 }: {
   itemsPerPage: number
   sort: SearchState['sort']
@@ -60,8 +61,9 @@ export async function fetchServerManyProducts({
   }[]
   sponsoredCount?: number
   filter?: boolean
+  locale: string
 }) {
-  let { channel, locale } = storeConfig.session
+  let { channel } = storeConfig.session
 
   if (filter) {
     const { hasOnlyDefaultSalesChannel, ...filteredChannel } =

package/src/utils/getBaseDomain.ts

@@ -1,9 +1,10 @@
+import { getStoreURL } from 'src/sdk/localization/useLocalizationConfig'
 import config from '../../discovery.config'
 
 export const getBaseDomain = (urls: string[]) => {
   // Check if all hostnames are the same (unified domain scenario)
   if (urls[0] === urls[1]) {
-    return `.${new URL(config.storeUrl).hostname}`
+    return `.${new URL(getStoreURL()).hostname}`
   }
 
   const extractHostname = (url: string) => {

package/src/utils/getRequestHostname.ts

@@ -0,0 +1,26 @@
+/**
+ * Extracts and normalizes a hostname from a raw `Host` header value (or any
+ * "host:port" string).
+ *
+ * Normalization rules:
+ * - Strips the port segment (e.g. `"store.com:443"` -> `"store.com"`)
+ * - Lowercases the result for case-insensitive comparisons
+ * - Trims surrounding whitespace
+ * - Returns `null` when the input is missing, empty, or whitespace-only
+ */
+export function getRequestHostname(
+  host: string | null | undefined
+): string | null {
+  const trimmed = host?.trim()
+
+  if (!trimmed) {
+    return null
+  }
+
+  try {
+    return new URL(`https://${trimmed}`).hostname.toLowerCase()
+  } catch {
+    const fallback = trimmed.split(':')[0].trim().toLowerCase()
+    return fallback || null
+  }
+}

package/src/utils/globalSettings.ts

@@ -4,6 +4,7 @@ import { usePage } from 'src/sdk/overrides/PageProvider'
 export type GlobalCmsData = {
   regionalization?: RegionalizationCmsData
   deliveryPromise?: DeliveryPromiseCmsData
+  filters?: FiltersCmsData
 }
 
 type RegionalizationCmsData = {
@@ -13,6 +14,7 @@ type RegionalizationCmsData = {
     noProductsAvailableErrorMessage?: string
     buttonActionText?: string
     errorMessageHelper?: string
+    loadingLabel?: string
   }
   idkPostalCodeLink?: {
     text?: string
@@ -77,6 +79,15 @@ type DeliveryPromiseCmsData = {
   }
 }
 
+type FiltersCmsData = {
+  filterFacetRange?: {
+    minLabel?: string
+    maxLabel?: string
+    minPriceErrorMessage?: string
+    maxPriceErrorMessage?: string
+  }
+}
+
 export function getGlobalSettings(
   sectionRegionalizationData?: GlobalCmsData['regionalization']
 ): GlobalCmsData {