@se-studio/contentful-rest-api 1.0.18 → 1.0.20

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { Document } from '@contentful/rich-text-types';
-import { IBaseArticle, IBaseArticleType, IBaseCollection, IBaseComponent, INavigationItem, IBasePage, IVisual, IInternalLink, INavigation, IPerson, IResponsiveVisual } from '@se-studio/core-data-types';
+import { IBaseArticle, IBaseArticleType, BaseCollectionContent, IBaseCollection, IBaseComponent, IBaseCustomType, INavigationItem, IBasePage, IBaseTag, IInternalLink, IVisual, IBasePerson, INavigation, IArticleLink, IArticleTypeLink, ITyped, IResponsiveVisual } from '@se-studio/core-data-types';
 import * as contentful from 'contentful';
 import { EntrySkeletonType, EntryFieldTypes, Entry, UnresolvedLink } from 'contentful';
+import { Document } from '@contentful/rich-text-types';
 import { NextRequest, NextResponse } from 'next/server';
 
 interface BaseExternalVideoFields {
@@ -377,17 +377,29 @@ interface CmsResponse<T> {
 declare function baseArticleConverter(context: ConverterContext, entry: Entry<BaseArticleSkeleton, DefaultChainModifier, string>): IBaseArticle;
 declare function baseArticleTypeConverter(context: ConverterContext, entry: Entry<BaseArticleTypeSkeleton, DefaultChainModifier, string>): IBaseArticleType;
 
-declare function baseCollectionConverter(context: ConverterContext, entry: Entry<BaseCollectionSkeleton, DefaultChainModifier, string>): IBaseCollection;
+type IContentfulCollection<TContents = BaseCollectionContent> = IBaseCollection<TContents> & {
+    body?: IContentfulRichText | null;
+    additionalCopy?: IContentfulRichText | null;
+};
+declare function baseCollectionConverter(context: ConverterContext, entry: Entry<BaseCollectionSkeleton, DefaultChainModifier, string>): IContentfulCollection;
 
-declare function baseComponentConverter(context: ConverterContext, entry: Entry<BaseComponentSkeleton, DefaultChainModifier, string>): IBaseComponent;
+type IContentfulComponent = IBaseComponent & {
+    body?: IContentfulRichText | null;
+    additionalCopy?: IContentfulRichText | null;
+};
+declare function baseComponentConverter(context: ConverterContext, entry: Entry<BaseComponentSkeleton, DefaultChainModifier, string>): IContentfulComponent;
+
+declare function baseCustomTypeConverter(context: ConverterContext, entry: Entry<BaseCustomTypeSkeleton, DefaultChainModifier, string>): IBaseCustomType;
 
 declare function baseNavigationItemConverter(context: ConverterContext, entry: Entry<BaseNavigationItemSkeleton, DefaultChainModifier, string>): INavigationItem;
 
 declare function basePageConverter(context: ConverterContext, entry: Entry<BasePageSkeleton, DefaultChainModifier, string>): IBasePage;
 
+declare function baseTagConverter(context: ConverterContext, entry: Entry<BaseTagSkeleton, DefaultChainModifier, string>): IBaseTag;
+
 declare function lookupAsset(context: ConverterContext, asset: UnresolvedLink<'Asset'> | undefined): IVisual | undefined;
 type ContentResolverFunction = (context: ConverterContext, entry: Entry<BaseContent, DefaultChainModifier, string>) => unknown;
-type LinkResolverFunction = (context: ConverterContext, entry: Entry<BaseLink, DefaultChainModifier, string>) => IInternalLink;
+type LinkResolverFunction<TResult extends IInternalLink = IInternalLink> = (context: ConverterContext, entry: Entry<BaseLink, DefaultChainModifier, string>) => TResult;
 type LinkResolverMap = Map<string, LinkResolverFunction>;
 type BaseConverterContext = {
     videoPrefix: string;
@@ -397,6 +409,8 @@ type BaseConverterContext = {
     pageResolver: typeof basePageConverter;
     articleResolver: typeof baseArticleConverter;
     articleTypeResolver: typeof baseArticleTypeConverter;
+    tagResolver: typeof baseTagConverter;
+    customTypeResolver: typeof baseCustomTypeConverter;
     componentResolver: typeof baseComponentConverter;
     collectionResolver: typeof baseCollectionConverter;
 };
@@ -406,27 +420,54 @@ type ConverterContext = BaseConverterContext & {
     errors: CmsError[];
 };
 
-type DefaultChainModifier = 'WITHOUT_LINK_RESOLUTION';
-type ResolvedEntry = IBasePage | IBaseArticle | IBaseArticleType | INavigation | INavigationItem | IInternalLink | unknown | IPerson;
-type PossibleResolvedEntry = {
-    id: string;
-    type: string;
-    entry: Entry<EntrySkeletonType, DefaultChainModifier, string>;
-    resolved?: ResolvedEntry;
+declare function contentfulArticleRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, articleTypeSlug: string, options?: FetchOptions): Promise<CmsResponse<IBaseArticle | null>>;
+
+declare function contentfulArticleTypeRest(context: BaseConverterContext, config: ContentfulConfig, indexPageSlug: string, options?: FetchOptions): Promise<CmsResponse<IBaseArticleType | null>>;
+
+declare function createBaseConverterContext(): BaseConverterContext;
+
+declare function contentfulCustomTypeRest(context: BaseConverterContext, config: ContentfulConfig, indexPageSlug: string, options?: FetchOptions): Promise<CmsResponse<IBaseCustomType | null>>;
+
+interface ContentfulResponse<T = any> {
+    sys: {
+        type: 'Array';
+    };
+    total: number;
+    skip: number;
+    limit: number;
+    items: T extends contentful.EntrySkeletonType ? Array<contentful.Entry<T, 'WITHOUT_LINK_RESOLUTION', string>> : T[];
+    includes?: {
+        Entry?: any[];
+        Asset?: any[];
+    };
+}
+interface ContentfulQuery {
+    content_type?: string;
+    locale?: string;
+    include?: number;
+    limit?: number;
+    skip?: number;
+    [key: string]: any;
+}
+declare class ContentfulFetchClient {
+    private readonly baseUrl;
+    private readonly accessToken;
+    constructor(config: ContentfulConfig, preview?: boolean);
+    getEntries<T = any>(query: ContentfulQuery, options?: FetchOptions): Promise<ContentfulResponse<T>>;
+}
+declare function createContentfulClient(config: ContentfulConfig): ContentfulFetchClient;
+declare function createContentfulPreviewClient(config: ContentfulConfig): ContentfulFetchClient;
+declare function getContentfulClient(config: ContentfulConfig, preview?: boolean): ContentfulFetchClient;
+
+type IContentfulPerson = IBasePerson & {
+    bio?: IContentfulRichText | null;
 };
-declare function contentfulPageRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBasePage | null>>;
+
+type DefaultChainModifier = 'WITHOUT_LINK_RESOLUTION';
 interface IContentfulRichText {
     json: Document;
     customStyles?: ReadonlyArray<string> | null;
 }
-declare function createBaseConverterContext(): BaseConverterContext;
-declare function contentfulArticleRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, articleTypeSlug: string, options?: FetchOptions): Promise<CmsResponse<IBaseArticle | null>>;
-declare function contentfulArticleTypeRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBaseArticleType | null>>;
-interface IArticleLinkWithMetadata extends IInternalLink {
-    date?: Date;
-    author?: IInternalLink;
-    articleType?: IInternalLink;
-}
 type SitemapChangeFrequency = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
 interface ISitemapEntry {
     url: string;
@@ -443,21 +484,32 @@ interface SitemapConfig {
     providers: SitemapEntryProvider[];
 }
 interface RelatedArticlesOptions {
-    articleTypeId?: string;
+    excludeArticleIds?: string[];
+    articleTypeIds?: string[];
     tagIds?: string[];
-    authorId?: string;
-    excludeIds?: string[];
+    authorIds?: string[];
     before?: Date;
     after?: Date;
     count?: number;
 }
-declare function getAllArticlesForRelated(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IArticleLinkWithMetadata[]>>;
+type ResolvedEntry = IBasePage | IBaseArticle | IBaseArticleType | IBaseTag | INavigation | INavigationItem | IInternalLink | unknown | IContentfulPerson;
+type PossibleResolvedEntry = {
+    id: string;
+    type: string;
+    entry: Entry<EntrySkeletonType, DefaultChainModifier, string>;
+    resolved?: ResolvedEntry;
+};
+
 declare function contentfulAllPageLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IInternalLink[]>>;
-declare function contentfulAllArticleLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IInternalLink[]>>;
+declare function contentfulAllArticleLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IArticleLink[]>>;
 declare function contentfulAllTagLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IInternalLink[]>>;
 declare function contentfulAllPersonLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IInternalLink[]>>;
-declare function contentfulAllArticleTypeLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IInternalLink[]>>;
-declare function filterRelatedArticles(articles: IArticleLinkWithMetadata[], options: RelatedArticlesOptions): IInternalLink[];
+declare function contentfulAllArticleTypeLinks(context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions): Promise<CmsResponse<IArticleTypeLink[]>>;
+
+declare function contentfulPageRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBasePage | null>>;
+
+declare function filterRelatedArticles(articles: IArticleLink[], options: RelatedArticlesOptions): IArticleLink[];
+
 declare function contentfulPageSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
 declare function contentfulArticleSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
 declare function contentfulArticleTypeSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
@@ -466,36 +518,20 @@ declare function contentfulPersonSitemapEntries(context: BaseConverterContext, c
 declare function getAllSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig: SitemapConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
 declare function createSitemapProvider(fetcher: (context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions) => Promise<CmsResponse<ISitemapEntry[]>>, sitemapConfig?: SitemapContentTypeConfig): SitemapEntryProvider;
 
-interface ContentfulResponse<T = any> {
-    sys: {
-        type: 'Array';
-    };
-    total: number;
-    skip: number;
-    limit: number;
-    items: T extends contentful.EntrySkeletonType ? Array<contentful.Entry<T, 'WITHOUT_LINK_RESOLUTION', string>> : T[];
-    includes?: {
-        Entry?: any[];
-        Asset?: any[];
-    };
-}
-interface ContentfulQuery {
-    content_type?: string;
-    locale?: string;
-    include?: number;
-    limit?: number;
-    skip?: number;
-    [key: string]: any;
-}
-declare class ContentfulFetchClient {
-    private readonly baseUrl;
-    private readonly accessToken;
-    constructor(config: ContentfulConfig, preview?: boolean);
-    getEntries<T = any>(query: ContentfulQuery, options?: FetchOptions): Promise<ContentfulResponse<T>>;
+declare function contentfulTagRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBaseTag | null>>;
+
+interface IFetchedTemplate {
+    id: string;
+    cmsLabel: string;
+    preContent: ReadonlyArray<ITyped>;
+    postContent: ReadonlyArray<ITyped>;
+    menu?: INavigation;
+    footer?: INavigation;
+    backgroundColour?: string;
+    textColour?: string;
+    stickyNav: boolean;
 }
-declare function createContentfulClient(config: ContentfulConfig): ContentfulFetchClient;
-declare function createContentfulPreviewClient(config: ContentfulConfig): ContentfulFetchClient;
-declare function getContentfulClient(config: ContentfulConfig, preview?: boolean): ContentfulFetchClient;
+declare function contentfulTemplateRest(context: BaseConverterContext, config: ContentfulConfig, cmsLabel: string, options?: FetchOptions): Promise<CmsResponse<IFetchedTemplate | null>>;
 
 declare function createResponsiveVisual(visual: IVisual | undefined, mobileVisual: IVisual | undefined, customSize?: number | null): IResponsiveVisual | undefined;
 
@@ -532,6 +568,7 @@ declare function customTypeTag(slug: string): string;
 declare function tagTag(slug: string): string;
 declare function personTag(slug: string): string;
 declare function assetTag(assetId: string): string;
+declare function templateTag(label: string): string;
 declare function locationTag(slug: string): string;
 declare const AllTags: string[];
 
@@ -587,4 +624,4 @@ declare class RateLimiter {
     getAvailableTokens(): number;
 }
 
-export { AllTags, ArticleTag, ArticleTypeTag, AssetTag, AuthenticationError, BannerTag, type BaseConverterContext, type CmsError, type CmsResponse, type ContentResolverFunction, ContentfulFetchClient as ContentfulClient, type ContentfulConfig, ContentfulError, ContentfulFetchClient, type ConverterContext, CustomTypeTag, type DefaultChainModifier, EntryNotFoundError, type FetchOptions, GlobalTag, type IArticleLinkWithMetadata, type IContentfulRichText, type ISitemapEntry, LocationTag, NavigationTag, PageTag, PersonTag, RateLimitError, RateLimiter, type RelatedArticlesOptions, type RetryConfig, type RevalidationConfig, type SitemapChangeFrequency, type SitemapConfig, type SitemapContentTypeConfig, type SitemapEntryProvider, TagTag, TemplateTag, ValidationError, arrayOrUndefined, articleTag, articleTypeIndexTag, articleTypeTag, assetTag, basePageConverter, calculateBackoffDelay, contentfulAllArticleLinks, contentfulAllArticleTypeLinks, contentfulAllPageLinks, contentfulAllPersonLinks, contentfulAllTagLinks, contentfulArticleRest, contentfulArticleSitemapEntries, contentfulArticleTypeRest, contentfulArticleTypeSitemapEntries, contentfulPageRest, contentfulPageSitemapEntries, contentfulPersonSitemapEntries, contentfulTagSitemapEntries, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createResponsiveVisual, createRevalidationHandler, createSitemapProvider, customTypeTag, filterRelatedArticles, getAllArticlesForRelated, getAllSitemapEntries, getCacheTags, getCacheTagsForPreview, getCacheTagsForProduction, getContentfulClient, getRetryAfter, isContentfulError, isRateLimitError, isRetryableError, isValidDate, locationTag, lookupAsset, notEmpty, pageTag, personTag, resolveLink, resolveLinks, resolveRichTextDocument, revalidateSingleTag, revalidateTags, safeDate, tagTag, withRetry };
+export { AllTags, ArticleTag, ArticleTypeTag, AssetTag, AuthenticationError, BannerTag, type BaseConverterContext, type CmsError, type CmsResponse, type ContentResolverFunction, ContentfulFetchClient as ContentfulClient, type ContentfulConfig, ContentfulError, ContentfulFetchClient, type ConverterContext, CustomTypeTag, type DefaultChainModifier, EntryNotFoundError, type FetchOptions, GlobalTag, type IContentfulCollection, type IContentfulComponent, type IContentfulPerson, type IContentfulRichText, type IFetchedTemplate, type ISitemapEntry, LocationTag, NavigationTag, PageTag, PersonTag, RateLimitError, RateLimiter, type RelatedArticlesOptions, type RetryConfig, type RevalidationConfig, type SitemapChangeFrequency, type SitemapConfig, type SitemapContentTypeConfig, type SitemapEntryProvider, TagTag, TemplateTag, ValidationError, arrayOrUndefined, articleTag, articleTypeIndexTag, articleTypeTag, assetTag, basePageConverter, calculateBackoffDelay, contentfulAllArticleLinks, contentfulAllArticleTypeLinks, contentfulAllPageLinks, contentfulAllPersonLinks, contentfulAllTagLinks, contentfulArticleRest, contentfulArticleSitemapEntries, contentfulArticleTypeRest, contentfulArticleTypeSitemapEntries, contentfulCustomTypeRest, contentfulPageRest, contentfulPageSitemapEntries, contentfulPersonSitemapEntries, contentfulTagRest, contentfulTagSitemapEntries, contentfulTemplateRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createResponsiveVisual, createRevalidationHandler, createSitemapProvider, customTypeTag, filterRelatedArticles, getAllSitemapEntries, getCacheTags, getCacheTagsForPreview, getCacheTagsForProduction, getContentfulClient, getRetryAfter, isContentfulError, isRateLimitError, isRetryableError, isValidDate, locationTag, lookupAsset, notEmpty, pageTag, personTag, resolveLink, resolveLinks, resolveRichTextDocument, revalidateSingleTag, revalidateTags, safeDate, tagTag, templateTag, withRetry };