@se-studio/contentful-rest-api 1.0.35 → 1.0.37

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { IBaseArticle, IBaseArticleType, BaseCollectionContent, IBaseCollection, IBaseComponent, IBaseCustomType, INavigationItem, IBasePage, IBaseTag, IInternalLink, IVisual, IBasePerson, INavigation, IArticleLink, IArticleTypeLink, ITyped, ISvgImage, IResponsiveVisual } from '@se-studio/core-data-types';
+import { IBasePerson, IBaseArticle, IBaseArticleType, BaseCollectionContent, IBaseCollection, IBaseComponent, IBaseCustomType, INavigationItem, IBasePage, IBaseTag, IInternalLink, IVisual, INavigation, IArticleLink, IArticleTypeLink, ITyped, ISvgImage, IResponsiveVisual } from '@se-studio/core-data-types';
 import * as contentful from 'contentful';
 import { EntrySkeletonType, EntryFieldTypes, Entry, Asset, UnresolvedLink } from 'contentful';
 import { Document } from '@contentful/rich-text-types';
@@ -39,37 +39,9 @@ interface BaseMediaFields {
 }
 type BaseMediaSkeleton = EntrySkeletonType<BaseMediaFields, 'media'>;
 
-interface BaseNavigationItemFields {
-    title: EntryFieldTypes.Symbol;
-    useTitle: EntryFieldTypes.Boolean;
-    navigationItems?: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<BaseNavigationItemSkeleton>>;
-    text?: EntryFieldTypes.Symbol;
-    internal?: EntryFieldTypes.EntryLink<BaseLink>;
-    link?: EntryFieldTypes.Symbol;
-    isButton?: EntryFieldTypes.Boolean;
-    isOutlined?: EntryFieldTypes.Boolean;
-    backgroundColour?: EntryFieldTypes.Symbol<string>;
-    textColour?: EntryFieldTypes.Symbol<string>;
-    icon?: EntryFieldTypes.AssetLink;
-    mobileIcon?: EntryFieldTypes.AssetLink;
-    variant?: EntryFieldTypes.Symbol<string>;
-    size?: EntryFieldTypes.Symbol<string>;
-    longText?: EntryFieldTypes.RichText;
-}
-type BaseNavigationItemSkeleton = EntrySkeletonType<BaseNavigationItemFields, 'navigationItem'>;
-
-interface BaseNavigationFields {
-    adminLabel: EntryFieldTypes.Symbol;
-    name: EntryFieldTypes.Symbol;
-    backgroundColour?: EntryFieldTypes.Symbol<string>;
-    textColour?: EntryFieldTypes.Symbol<string>;
-    entries?: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<BaseNavigationItemSkeleton>>;
-}
-type BaseNavigationSkeleton = EntrySkeletonType<BaseNavigationFields, 'navigation'>;
-
 interface BaseSchemaFields {
     cmsLabel: EntryFieldTypes.Symbol;
-    markup: EntryFieldTypes.Object;
+    markup?: EntryFieldTypes.Text;
 }
 type BaseSchemaSkeleton = EntrySkeletonType<BaseSchemaFields, 'schema'>;
 
@@ -317,6 +289,37 @@ interface BasePageVariantFields {
 }
 type BasePageVariantSkeleton = EntrySkeletonType<BasePageVariantFields, 'pageVariant'>;
 
+type BaseContent = BaseCollectionSkeleton | BaseComponentSkeleton | BaseExternalComponentSkeleton | BaseExternalVideoSkeleton | BaseMediaSkeleton | BasePersonSkeleton;
+type BaseLink = BaseArticleSkeleton | BaseArticleTypeSkeleton | BaseLinkSkeleton | BasePageSkeleton | BasePageVariantSkeleton | BasePersonSkeleton | BaseTagSkeleton | BaseCustomTypeSkeleton;
+
+interface BaseNavigationItemFields {
+    title: EntryFieldTypes.Symbol;
+    useTitle: EntryFieldTypes.Boolean;
+    navigationItems?: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<BaseNavigationItemSkeleton>>;
+    text?: EntryFieldTypes.Symbol;
+    internal?: EntryFieldTypes.EntryLink<BaseLink>;
+    link?: EntryFieldTypes.Symbol;
+    isButton?: EntryFieldTypes.Boolean;
+    isOutlined?: EntryFieldTypes.Boolean;
+    backgroundColour?: EntryFieldTypes.Symbol<string>;
+    textColour?: EntryFieldTypes.Symbol<string>;
+    icon?: EntryFieldTypes.AssetLink;
+    mobileIcon?: EntryFieldTypes.AssetLink;
+    variant?: EntryFieldTypes.Symbol<string>;
+    size?: EntryFieldTypes.Symbol<string>;
+    longText?: EntryFieldTypes.RichText;
+}
+type BaseNavigationItemSkeleton = EntrySkeletonType<BaseNavigationItemFields, 'navigationItem'>;
+
+interface BaseNavigationFields {
+    adminLabel: EntryFieldTypes.Symbol;
+    name: EntryFieldTypes.Symbol;
+    backgroundColour?: EntryFieldTypes.Symbol<string>;
+    textColour?: EntryFieldTypes.Symbol<string>;
+    entries?: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<BaseNavigationItemSkeleton>>;
+}
+type BaseNavigationSkeleton = EntrySkeletonType<BaseNavigationFields, 'navigation'>;
+
 interface BaseCustomTypeFields {
     name: EntryFieldTypes.Symbol;
     slug: EntryFieldTypes.Symbol;
@@ -340,8 +343,10 @@ interface BaseCustomTypeFields {
 }
 type BaseCustomTypeSkeleton = EntrySkeletonType<BaseCustomTypeFields, 'customType'>;
 
-type BaseContent = BaseCollectionSkeleton | BaseComponentSkeleton | BaseExternalComponentSkeleton | BaseExternalVideoSkeleton | BaseMediaSkeleton | BasePersonSkeleton;
-type BaseLink = BaseArticleSkeleton | BaseArticleTypeSkeleton | BaseLinkSkeleton | BasePageSkeleton | BasePageVariantSkeleton | BasePersonSkeleton | BaseTagSkeleton | BaseCustomTypeSkeleton;
+type IContentfulPerson = IBasePerson & {
+    bio?: IContentfulRichText | null;
+};
+declare function basePersonConverter(context: ConverterContext, entry: Entry<BasePersonSkeleton, DefaultChainModifier, string>, customTypeEntry?: Entry<BaseCustomTypeSkeleton, DefaultChainModifier, string>): IContentfulPerson;
 
 interface ContentfulConfig {
     spaceId: string;
@@ -378,7 +383,7 @@ 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 baseArticleTypeConverter(context: ConverterContext, entry: Entry<BaseArticleTypeSkeleton, DefaultChainModifier, string>, customTypeEntry?: Entry<BaseCustomTypeSkeleton, DefaultChainModifier, string>): IBaseArticleType;
 
 type IContentfulCollection<TContents = BaseCollectionContent> = IBaseCollection<TContents> & {
     body?: IContentfulRichText | null;
@@ -397,8 +402,10 @@ declare function baseCustomTypeConverter(context: ConverterContext, entry: Entry
 declare function baseNavigationItemConverter(context: ConverterContext, entry: Entry<BaseNavigationItemSkeleton, DefaultChainModifier, string>): INavigationItem;
 
 declare function basePageConverter(context: ConverterContext, entry: Entry<BasePageSkeleton, DefaultChainModifier, string>): IBasePage;
+declare function calculatePageHref(slug: string): string;
+declare function calculatePageVariantHref(slug: string): string;
 
-declare function baseTagConverter(context: ConverterContext, entry: Entry<BaseTagSkeleton, DefaultChainModifier, string>): IBaseTag;
+declare function baseTagConverter(context: ConverterContext, entry: Entry<BaseTagSkeleton, DefaultChainModifier, string>, customTypeEntry?: Entry<BaseCustomTypeSkeleton, DefaultChainModifier, string>): IBaseTag;
 
 declare function lookupAsset(context: ConverterContext, asset: UnresolvedLink<'Asset'> | undefined): IVisual | undefined;
 type ContentResolverFunction = (context: ConverterContext, entry: Entry<BaseContent, DefaultChainModifier, string>) => unknown;
@@ -424,6 +431,7 @@ type BaseConverterContext = {
     articleResolver: typeof baseArticleConverter;
     articleTypeResolver: typeof baseArticleTypeConverter;
     tagResolver: typeof baseTagConverter;
+    personResolver: typeof basePersonConverter;
     customTypeResolver: typeof baseCustomTypeConverter;
     componentResolver: typeof baseComponentConverter;
     collectionResolver: typeof baseCollectionConverter;
@@ -437,7 +445,10 @@ type ConverterContext = 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, indexPageSlug: string, options?: FetchOptions): Promise<CmsResponse<IBaseArticleType | null>>;
+interface ArticleTypeFetchOptions extends FetchOptions {
+    customType?: string;
+}
+declare function contentfulArticleTypeRest(context: BaseConverterContext, config: ContentfulConfig, indexPageSlug: string, options?: ArticleTypeFetchOptions): Promise<CmsResponse<IBaseArticleType | null>>;
 
 interface ContentfulResponse<T = any> {
     sys: {
@@ -513,14 +524,10 @@ interface DownloadRouteParams {
 }
 declare function createDownloadHandler(config: DownloadHandlerConfig): (_request: NextRequest, { params }: DownloadRouteParams) => Promise<Response>;
 
-declare function createBaseConverterContext(): BaseConverterContext;
+declare function createBaseConverterContext(urlCalculators: UrlCalculators): BaseConverterContext;
 
 declare function contentfulCustomTypeRest(context: BaseConverterContext, config: ContentfulConfig, indexPageSlug: string, options?: FetchOptions): Promise<CmsResponse<IBaseCustomType | null>>;
 
-type IContentfulPerson = IBasePerson & {
-    bio?: IContentfulRichText | null;
-};
-
 type DefaultChainModifier = 'WITHOUT_LINK_RESOLUTION';
 interface IContentfulRichText {
     json: Document;
@@ -566,6 +573,11 @@ declare function contentfulAllArticleTypeLinks(context: BaseConverterContext, co
 
 declare function contentfulPageRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBasePage | null>>;
 
+interface PersonFetchOptions extends FetchOptions {
+    customType?: string;
+}
+declare function contentfulPersonRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: PersonFetchOptions): Promise<CmsResponse<IContentfulPerson | null>>;
+
 type PreviewContentType = 'page' | 'pageVariant' | 'article' | 'articleType' | 'tag' | 'person' | 'customType';
 interface PreviewEntryInfo {
     contentType: PreviewContentType;
@@ -586,7 +598,10 @@ 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;
 
-declare function contentfulTagRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBaseTag | null>>;
+interface TagFetchOptions extends FetchOptions {
+    customType?: string;
+}
+declare function contentfulTagRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: TagFetchOptions): Promise<CmsResponse<IBaseTag | null>>;
 
 interface IFetchedTemplate {
     id: string;
@@ -696,4 +711,4 @@ declare class RateLimiter {
     getIntervalMs(): 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, type DownloadHandlerConfig, type DownloadRouteParams, EntryNotFoundError, type FetchOptions, GlobalTag, type IContentfulCollection, type IContentfulComponent, type IContentfulPerson, type IContentfulRichText, type IFetchedTemplate, type ISitemapEntry, LocationTag, NavigationTag, PageTag, PersonTag, type PreviewContentType, type PreviewEntryInfo, RateLimitError, RateLimiter, type RelatedArticlesOptions, type RetryConfig, type RevalidationConfig, type SitemapChangeFrequency, type SitemapConfig, type SitemapContentTypeConfig, type SitemapEntryProvider, TagTag, TemplateTag, type UrlCalculators, ValidationError, arrayOrUndefined, articleTag, articleTypeIndexTag, articleTypeTag, assetTag, basePageConverter, calculateBackoffDelay, contentfulAllArticleLinks, contentfulAllArticleTypeLinks, contentfulAllPageLinks, contentfulAllPersonLinks, contentfulAllTagLinks, contentfulArticleRest, contentfulArticleSitemapEntries, contentfulArticleTypeRest, contentfulArticleTypeSitemapEntries, contentfulAssetRest, contentfulCustomTypeRest, contentfulPageRest, contentfulPageSitemapEntries, contentfulPersonSitemapEntries, contentfulTagRest, contentfulTagSitemapEntries, contentfulTemplateRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createDownloadHandler, createResponsiveVisual, createRevalidationHandler, createSitemapProvider, customTypeTag, filterRelatedArticles, getAllSitemapEntries, getCacheTags, getCacheTagsForPreview, getCacheTagsForProduction, getContentfulClient, getPreviewEntryInfo, getRetryAfter, isBrowserViewable, isContentfulError, isRateLimitError, isRetryableError, isValidDate, locationTag, lookupAsset, notEmpty, pageTag, personTag, resolveLink, resolveLinks, resolveRichTextDocument, revalidateSingleTag, revalidateTags, safeDate, tagTag, templateTag, withRetry };
+export { AllTags, ArticleTag, type ArticleTypeFetchOptions, ArticleTypeTag, AssetTag, AuthenticationError, BannerTag, type BaseConverterContext, type CmsError, type CmsResponse, type ContentResolverFunction, ContentfulFetchClient as ContentfulClient, type ContentfulConfig, ContentfulError, ContentfulFetchClient, type ConverterContext, CustomTypeTag, type DefaultChainModifier, type DownloadHandlerConfig, type DownloadRouteParams, EntryNotFoundError, type FetchOptions, GlobalTag, type IContentfulCollection, type IContentfulComponent, type IContentfulPerson, type IContentfulRichText, type IFetchedTemplate, type ISitemapEntry, LocationTag, NavigationTag, PageTag, type PersonFetchOptions, PersonTag, type PreviewContentType, type PreviewEntryInfo, RateLimitError, RateLimiter, type RelatedArticlesOptions, type RetryConfig, type RevalidationConfig, type SitemapChangeFrequency, type SitemapConfig, type SitemapContentTypeConfig, type SitemapEntryProvider, type TagFetchOptions, TagTag, TemplateTag, type UrlCalculators, ValidationError, arrayOrUndefined, articleTag, articleTypeIndexTag, articleTypeTag, assetTag, basePageConverter, calculateBackoffDelay, calculatePageHref, calculatePageVariantHref, contentfulAllArticleLinks, contentfulAllArticleTypeLinks, contentfulAllPageLinks, contentfulAllPersonLinks, contentfulAllTagLinks, contentfulArticleRest, contentfulArticleSitemapEntries, contentfulArticleTypeRest, contentfulArticleTypeSitemapEntries, contentfulAssetRest, contentfulCustomTypeRest, contentfulPageRest, contentfulPageSitemapEntries, contentfulPersonRest, contentfulPersonSitemapEntries, contentfulTagRest, contentfulTagSitemapEntries, contentfulTemplateRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createDownloadHandler, createResponsiveVisual, createRevalidationHandler, createSitemapProvider, customTypeTag, filterRelatedArticles, getAllSitemapEntries, getCacheTags, getCacheTagsForPreview, getCacheTagsForProduction, getContentfulClient, getPreviewEntryInfo, getRetryAfter, isBrowserViewable, isContentfulError, isRateLimitError, isRetryableError, isValidDate, locationTag, lookupAsset, notEmpty, pageTag, personTag, resolveLink, resolveLinks, resolveRichTextDocument, revalidateSingleTag, revalidateTags, safeDate, tagTag, templateTag, withRetry };