Class ScPersonalizeMiddleware

Middleware / handler to support Sitecore Personalize

Hierarchy

  • MiddlewareBase
    • ScPersonalizeMiddleware

Constructors

constructor

Properties

SITE_SYMBOL _personalizeService config defaultHostname

Methods

excludeRoute extractDebugHeaders getExperienceParams getHandler getHostHeader getLanguage getSite handler isPreview

Constructors

constructor

Properties

Protected SITE_SYMBOL

SITE_SYMBOL: string = 'sc_site'

Private _personalizeService

_personalizeService: GraphQLSCPersonalizeService

Protected config

config: ScPersonalizeMiddlewareConfig

Personalize middleware config

Protected defaultHostname

defaultHostname: string

Methods

Protected excludeRoute

Protected extractDebugHeaders

  • extractDebugHeaders(incomingHeaders): {
        [key: string]: string;
    }

  • Safely extract all headers for debug logging Necessary to avoid middleware issue https://github.com/vercel/next.js/issues/39765

    Parameters

    • incomingHeaders: Headers

      Incoming headers

    Returns {
        [key: string]: string;
    }

    Object with headers as key/value pairs

    • [key: string]: string

Protected getExperienceParams

getHandler

  • getHandler(): ((req, res?) => Promise<NextResponse<unknown>>)

  • Gets the Next.js middleware handler with error handling

    Returns ((req, res?) => Promise<NextResponse<unknown>>)

    middleware handler

      • (req, res?): Promise<NextResponse<unknown>>

      • Gets the Next.js middleware handler with error handling

        Parameters

        • req: NextRequest
        • Optional res: NextResponse<unknown>

        Returns Promise<NextResponse<unknown>>

        middleware handler

Protected getHostHeader

  • getHostHeader(req): undefined | string

  • Extract 'host' header

    Parameters

    • req: NextRequest

      request

    Returns undefined | string

Protected getLanguage

  • getLanguage(req): string

  • Provides used language

    Parameters

    • req: NextRequest

      request

    Returns string

    language

Protected getSite

  • getSite(req, res?): SiteInfo

  • Get site information. Can not be used in Preview mode, since site will not be resolved

    Parameters

    • req: NextRequest

      request

    • Optional res: NextResponse<unknown>

      response

    Returns SiteInfo

    site information

Private handler

Protected isPreview

  • isPreview(req): boolean

  • Determines if mode is preview

    Parameters

    • req: NextRequest

      request

    Returns boolean

    is preview

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc