Class BasePersonalizeGraphQLSitemapService`Abstract`

Service that fetches the list of site pages using Sitecore's GraphQL API. Used to handle a single site This list is used for SSG and Export functionality.

Mixes

SearchQueryService

Hierarchy

BasePersonalizeGraphQLSitemapService
- MultisitePersonalizeGraphQLSitemapService

Index

Constructors

constructor

new BasePersonalizeGraphQLSitemapService(options): BasePersonalizeGraphQLSitemapService
Creates an instance of graphQL sitemap service with the provided options
Parameters
- options: BaseGraphQLSitemapServiceConfig
  instance
Returns BasePersonalizeGraphQLSitemapService
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:194

Properties

`Private` _graphQLClient

_graphQLClient: GraphQLClient

options

options: BaseGraphQLSitemapServiceConfig

instance

Accessors

`Protected` graphQLClient

get graphQLClient(): GraphQLClient
GraphQL client accessible by descendant classes when needed

Returns GraphQLClient
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:179

`Protected` query

get query(): string
Gets the default query used for fetching the list of site pages

Returns string
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:186

Methods

fetchExportSitemap

fetchExportSitemap(locale): Promise<StaticPath[]>
Fetch sitemap which could be used for generation of static pages during next export. The locale parameter will be used in the item query, but since i18n is not supported, the output paths will not include a language property.
Parameters
- locale: string
  which application supports
Returns Promise<StaticPath[]>
an array of

See
StaticPath objects
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:205

`Protected` fetchLanguageSitePaths

fetchLanguageSitePaths(language, siteName): Promise<RouteListQueryResult[]>
Parameters
- language: string
- siteName: string
Returns Promise<RouteListQueryResult[]>
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:302

fetchSSGSitemap

fetchSSGSitemap(locales): Promise<StaticPath[]>
Fetch sitemap which could be used for generation of static pages using SSG mode
Parameters
- locales: string[]
  locales which application supports
Returns Promise<StaticPath[]>
an array of

See
StaticPath objects
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:221

`Protected` `Abstract` fetchSitemap

fetchSitemap(languages, formatStaticPath): Promise<StaticPath[]>
Fetch a flat list of all pages that belong to the specificed site and have a version in the specified language(s).
Parameters
- languages: string[]
  Fetch pages that have versions in this language(s).
- formatStaticPath: ((path, language, isStaticRender) => StaticPath)
  Function for transforming the raw search results into (@see StaticPath) types.
  - - (path, language, isStaticRender): StaticPath
    - Parameters
      path: string[]
      language: string
      isStaticRender: boolean
      Returns StaticPath
Returns Promise<StaticPath[]>
list of pages

Throws
if the list of languages is empty.

Throws
if the any of the languages is an empty string.
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:359

`Protected` getGraphQLClient

getGraphQLClient(): GraphQLClient
Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default library for fetching graphql data (@see GraphQLRequestClient). Override this method if you want to use something else.

Returns GraphQLClient
implementation
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:343

`Protected` getTranformedPaths

getTranformedPaths(siteName, languages, formatStaticPath): Promise<StaticPath[]>
Parameters
- siteName: string
- languages: string[]
- formatStaticPath: ((path, language, isStaticRender) => StaticPath)
  - - (path, language, isStaticRender): StaticPath
    - Parameters
      path: string[]
      language: string
      isStaticRender: boolean
      Returns StaticPath
Returns Promise<StaticPath[]>
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:233

`Protected` transformLanguageSitePaths

transformLanguageSitePaths(sitePaths, formatStaticPath, language): Promise<StaticPath[]>
Parameters
- sitePaths: RouteListQueryResult[]
- formatStaticPath: ((path, language, isStaticRender) => StaticPath)
  - - (path, language, isStaticRender): StaticPath
    - Parameters
      path: string[]
      language: string
      isStaticRender: boolean
      Returns StaticPath
- language: string
Returns Promise<StaticPath[]>
- Defined in src/plugins/sitemapFetcher/base-personalize-graphql-sitemap-service.ts:260

Class BasePersonalizeGraphQLSitemapServiceAbstract

Mixes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: BaseGraphQLSitemapServiceConfig

Returns BasePersonalizeGraphQLSitemapService

Properties

Private _graphQLClient

options

Accessors

Protected graphQLClient

Returns GraphQLClient

Protected query

Returns string

Methods

fetchExportSitemap

Parameters

locale: string

Returns Promise<StaticPath[]>

See

Protected fetchLanguageSitePaths

Parameters

language: string

siteName: string

Returns Promise<RouteListQueryResult[]>

fetchSSGSitemap

Parameters

locales: string[]

Returns Promise<StaticPath[]>

See

Protected Abstract fetchSitemap

Parameters

languages: string[]

formatStaticPath: ((path, language, isStaticRender) => StaticPath)

Parameters

path: string[]

language: string

isStaticRender: boolean

Returns StaticPath

Returns Promise<StaticPath[]>

Throws

Throws

Protected getGraphQLClient

Returns GraphQLClient

Protected getTranformedPaths

Parameters

siteName: string

languages: string[]

formatStaticPath: ((path, language, isStaticRender) => StaticPath)

Parameters

path: string[]

language: string

isStaticRender: boolean

Returns StaticPath

Returns Promise<StaticPath[]>

Protected transformLanguageSitePaths

Parameters

sitePaths: RouteListQueryResult[]

formatStaticPath: ((path, language, isStaticRender) => StaticPath)

Parameters

path: string[]

language: string

isStaticRender: boolean

Returns StaticPath

language: string

Returns Promise<StaticPath[]>

Settings

Member Visibility

Theme

On This Page

Class BasePersonalizeGraphQLSitemapService`Abstract`

`Private` _graphQLClient

`Protected` graphQLClient

`Protected` query

`Protected` fetchLanguageSitePaths

`Protected` `Abstract` fetchSitemap

`Protected` getGraphQLClient

`Protected` getTranformedPaths

`Protected` transformLanguageSitePaths