Rename 'sitemapRepresentation' arboretum option to 'pageRelations'

BrightIT · Oct 18, 2024 · e171c2a · e171c2a
1 parent 4eb1de8
commit e171c2a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/src/arboretum-client.ts b/src/arboretum-client.ts
@@ -11,7 +11,7 @@ import {
 export type ArboretumClientOptions = {
   data?: CachedDataT;
   eagerly?: boolean;
-  sitemapRepresentation?: "parent-to-children" | "child-to-parent";
+  pageRelations?: "parent-to-children" | "child-to-parent";
   includeEntryStatus?: boolean;
 };
 
@@ -77,7 +77,7 @@ export type ArboretumClientConfigFromCdaT = {
   };
   options?: Pick<
     ArboretumClientOptions,
-    "data" | "eagerly" | "sitemapRepresentation"
+    "data" | "eagerly" | "pageRelations"
   >;
 };
 
@@ -99,7 +99,7 @@ export type ArboretumClientConfigFromCdaParamsT = {
   };
   options?: Pick<
     ArboretumClientOptions,
-    "data" | "eagerly" | "sitemapRepresentation"
+    "data" | "eagerly" | "pageRelations"
   >;
 };
 
@@ -161,7 +161,7 @@ export type ArboretumClientOptionsT = Pick<
   ArboretumClientContentfulConfigOptionsT,
   "pageContentTypes" | "redirectContentType"
 > &
-  Pick<ArboretumClientOptions, "includeEntryStatus" | "sitemapRepresentation">;
+  Pick<ArboretumClientOptions, "includeEntryStatus" | "pageRelations">;
 
 export type ArboretumClientT = {
   homePage: (

diff --git a/src/impl/arboretum-client.impl.ts b/src/impl/arboretum-client.impl.ts
@@ -154,7 +154,7 @@ export const createArboretumClient = async (
     options: {
       ...options,
       includeEntryStatus,
-      sitemapRepresentation: config.options?.sitemapRepresentation,
+      pageRelations: config.options?.pageRelations,
     },
     localeTagIdPrefix,
     pageHomeTagId: options.homePageTagId || pageHomeTagId,

diff --git a/src/impl/sitemap/helpers/build-localized-sitemap.ts b/src/impl/sitemap/helpers/build-localized-sitemap.ts
@@ -271,7 +271,7 @@ export const buildLocalizedSitemap = (
 
   if (homePageEntry) {
     const childrenRefsByPageId =
-      options.sitemapRepresentation === "child-to-parent"
+      options.pageRelations === "child-to-parent"
         ? getChildrenRefsByParentId(data, locale, options)
         : undefined;