@bright.global/arboretum-sdk 0.0.8 → 0.1.0-rc.0

package/dist/types/arboretum-client.d.ts

@@ -4,6 +4,7 @@ import { ContentTypeT, EntryT, LocaleT, StatusT, TagT } from "./clients/contentf
 export type ArboretumClientOptions = {
     data?: CachedDataT;
     eagerly?: boolean;
+    sitemapRepresentation?: "parent-to-children" | "child-to-parent";
     includeEntryStatus?: boolean;
 };
 export type ArboretumClientContentfulConfigOptionsT = {
@@ -12,6 +13,7 @@ export type ArboretumClientContentfulConfigOptionsT = {
             slugFieldId: string;
             titleFieldId?: string;
             childPagesFieldId?: string;
+            parentPageFieldId?: string;
         };
     };
     redirectContentType?: {
@@ -59,7 +61,7 @@ export type ArboretumClientConfigFromCdaT = {
         client: ContentfulClientApi;
         options: ArboretumClientContentfulConfigOptionsT;
     };
-    options?: Pick<ArboretumClientOptions, "data" | "eagerly">;
+    options?: Pick<ArboretumClientOptions, "data" | "eagerly" | "sitemapRepresentation">;
 };
 export type CreateClientParams = {
     space: string;
@@ -76,7 +78,7 @@ export type ArboretumClientConfigFromCdaParamsT = {
     contentful: Omit<CreateClientParams, "host"> & {
         options: ArboretumClientContentfulConfigOptionsT;
     };
-    options?: Pick<ArboretumClientOptions, "data" | "eagerly">;
+    options?: Pick<ArboretumClientOptions, "data" | "eagerly" | "sitemapRepresentation">;
 };
 export type ArboretumClientConfigT = ArboretumClientConfigFromCmaT | ArboretumClientConfigFromCdaT | ArboretumClientConfigFromCdaParamsT;
 type ArboretumPageBaseT = {
@@ -96,6 +98,7 @@ export type ArboretumAliasT = ArboretumPageBaseT & {
 };
 export type ArboretumPageT = ArboretumPageBaseT & {
     type: "page";
+    contentTypeId: string;
     slug: string;
     totalDirectChildrenCount: number;
     children?: Array<ArboretumPageNodeT>;
@@ -106,7 +109,7 @@ export type OptionsT = {
     withChildren?: boolean;
     withAncestors?: boolean;
 };
-export type ArboretumClientOptionsT = Pick<ArboretumClientContentfulConfigOptionsT, "pageContentTypes" | "redirectContentType"> & Pick<ArboretumClientOptions, "includeEntryStatus">;
+export type ArboretumClientOptionsT = Pick<ArboretumClientContentfulConfigOptionsT, "pageContentTypes" | "redirectContentType"> & Pick<ArboretumClientOptions, "includeEntryStatus" | "sitemapRepresentation">;
 export type ArboretumClientT = {
     homePage: (localeCode: string, options?: OptionsT) => Either<string, ArboretumPageT>;
     pageByPath: (path: string, options?: OptionsT) => Either<string, ArboretumPageNodeT>;

package/dist/types/impl/arboretum-client.impl.d.ts

@@ -16,6 +16,7 @@ export type PageT = {
     sys: {
         id: string;
         cmaOnlyStatus?: StatusT;
+        contentTypeId: string;
     };
     metadata?: MetadataT;
     parent: {

package/dist/types/impl/sitemap/adapters/page-entry-adapter.d.ts

@@ -1,6 +1,6 @@
-import { PageT } from '../../arboretum-client.impl';
-import { ContentTypeT, EntryT, LocaleT } from '../../../clients/contentful-client/contentful-client';
-import { SitemapDataT } from '../../data/sitemap-data';
-export declare const pageEntryAdapter: (data: Pick<SitemapDataT, 'locales' | 'defaultLocaleCode'>, slugField: ContentTypeT['fields'][number], titleField: ContentTypeT['fields'][number] | undefined, childPagesField: ContentTypeT['fields'][number] | undefined, locale: LocaleT, parent: (NonNullable<PageT['parent']> & {
+import { PageT } from "../../arboretum-client.impl";
+import { ContentTypeT, EntryT, LocaleT } from "../../../clients/contentful-client/contentful-client";
+import { SitemapDataT } from "../../data/sitemap-data";
+export declare const pageEntryAdapter: (data: Pick<SitemapDataT, "locales" | "defaultLocaleCode" | "pages">, slugField: ContentTypeT["fields"][number], titleField: ContentTypeT["fields"][number] | undefined, childrenRefs: PageT["childPages"], locale: LocaleT, parent: (NonNullable<PageT["parent"]> & {
     path: string;
 }) | undefined, entry: EntryT) => PageT | undefined;

package/dist/types/impl/sitemap/adapters/to-arboretum-page-with-missing-data-adapter.d.ts

@@ -1,3 +1,3 @@
-import { ArboretumPageT } from '../../../arboretum-client';
-import { PageT } from '../../arboretum-client.impl';
-export declare const toArboretumPageWithMissingData: (localeCode: string) => (page: PageT, ancestors: ArboretumPageT['ancestors'], children: ArboretumPageT['children']) => ArboretumPageT;
+import { ArboretumPageT } from "../../../arboretum-client";
+import { PageT } from "../../arboretum-client.impl";
+export declare const toArboretumPageWithMissingData: (localeCode: string) => (page: PageT, ancestors: ArboretumPageT["ancestors"], children: ArboretumPageT["children"]) => ArboretumPageT;

package/dist/types/impl/sitemap/helpers/__mocks__/mocked-localized-sitemap.d.ts

@@ -1,4 +1,4 @@
-import { LocalizedSitemapT, PageT, RedirectT } from '../../../arboretum-client.impl';
+import { LocalizedSitemapT, PageT, RedirectT } from "../../../arboretum-client.impl";
 export declare const mockedRoot: PageT;
 export declare const mockedPage1: PageT;
 export declare const mockedPage1_1: PageT;

package/dist/types/impl/sitemap/helpers/build-localized-sitemap.d.ts

@@ -1,5 +1,5 @@
-import { Either } from '../../../utils/fp-utils';
-import { ArboretumClientCtx, LocalizedSitemapT } from '../../arboretum-client.impl';
-import { LocaleT } from '../../../clients/contentful-client/contentful-client';
-export declare const buildLocalizedSitemap: (data: Pick<ArboretumClientCtx['data'], 'homePagesByTagId' | 'pages' | 'contentTypes' | 'defaultLocaleCode' | 'locales' | 'redirects'>, options: ArboretumClientCtx['options'], pageHomeTagId: ArboretumClientCtx['pageHomeTagId'], locale: LocaleT) => Either<string, LocalizedSitemapT>;
-export declare const localizedSitemapFromCacheOrBuildEff: (ctx: Pick<ArboretumClientCtx, 'options' | 'data' | 'pageHomeTagId' | 'sitemap'>, locale: LocaleT) => Either<string, LocalizedSitemapT>;
+import { Either } from "../../../utils/fp-utils";
+import { ArboretumClientCtx, LocalizedSitemapT } from "../../arboretum-client.impl";
+import { LocaleT } from "../../../clients/contentful-client/contentful-client";
+export declare const buildLocalizedSitemap: (data: Pick<ArboretumClientCtx["data"], "homePagesByTagId" | "pages" | "contentTypes" | "defaultLocaleCode" | "locales" | "redirects">, options: ArboretumClientCtx["options"], pageHomeTagId: ArboretumClientCtx["pageHomeTagId"], locale: LocaleT) => Either<string, LocalizedSitemapT>;
+export declare const localizedSitemapFromCacheOrBuildEff: (ctx: Pick<ArboretumClientCtx, "options" | "data" | "pageHomeTagId" | "sitemap">, locale: LocaleT) => Either<string, LocalizedSitemapT>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bright.global/arboretum-sdk",
-  "version": "0.0.8",
+  "version": "0.1.0-rc.0",
   "license": "MIT",
   "description": "The sitemap for contentful",
   "dependencies": {},