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

package/dist/index.d.ts

@@ -427,6 +427,21 @@ interface IArticleLinkWithMetadata extends IInternalLink {
     author?: IInternalLink;
     articleType?: IInternalLink;
 }
+type SitemapChangeFrequency = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+interface ISitemapEntry {
+    url: string;
+    lastModified?: Date;
+    changeFrequency?: SitemapChangeFrequency;
+    priority?: number;
+}
+interface SitemapContentTypeConfig {
+    priority?: number;
+    changeFrequency?: SitemapChangeFrequency;
+}
+type SitemapEntryProvider = (context: BaseConverterContext, config: ContentfulConfig, options?: FetchOptions) => Promise<CmsResponse<ISitemapEntry[]>>;
+interface SitemapConfig {
+    providers: SitemapEntryProvider[];
+}
 interface RelatedArticlesOptions {
     articleTypeId?: string;
     tagIds?: string[];
@@ -443,6 +458,13 @@ declare function contentfulAllTagLinks(context: BaseConverterContext, config: Co
 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 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[]>>;
+declare function contentfulTagSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
+declare function contentfulPersonSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
+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: {
@@ -565,4 +587,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, LocationTag, NavigationTag, PageTag, PersonTag, RateLimitError, RateLimiter, type RelatedArticlesOptions, type RetryConfig, type RevalidationConfig, TagTag, TemplateTag, ValidationError, arrayOrUndefined, articleTag, articleTypeIndexTag, articleTypeTag, assetTag, basePageConverter, calculateBackoffDelay, contentfulAllArticleLinks, contentfulAllArticleTypeLinks, contentfulAllPageLinks, contentfulAllPersonLinks, contentfulAllTagLinks, contentfulArticleRest, contentfulArticleTypeRest, contentfulPageRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createResponsiveVisual, createRevalidationHandler, customTypeTag, filterRelatedArticles, getAllArticlesForRelated, 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 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 };

package/dist/index.js

@@ -1604,6 +1604,12 @@ function baseTagLinkConverter(context, entry) {
 
 // src/api.ts
 init_utils();
+var PAGE_LINK_FIELDS = "sys,fields.cmsLabel,fields.title,fields.slug,fields.featuredImage,fields.backgroundColour,fields.textColour,fields.indexed,fields.hidden,fields.tags";
+var ARTICLE_LINK_FIELDS = "sys,fields.cmsLabel,fields.title,fields.slug,fields.featuredImage,fields.backgroundColour,fields.textColour,fields.indexed,fields.hidden,fields.tags,fields.articleType";
+var ARTICLE_RELATED_FIELDS = "sys,fields.cmsLabel,fields.title,fields.slug,fields.featuredImage,fields.backgroundColour,fields.textColour,fields.indexed,fields.hidden,fields.tags,fields.articleType,fields.date,fields.author";
+var ARTICLE_TYPE_LINK_FIELDS = "sys,fields.name,fields.slug,fields.featuredImage,fields.backgroundColour,fields.textColour,fields.indexed,fields.hidden";
+var TAG_LINK_FIELDS = "sys,fields.cmsLabel,fields.name,fields.slug,fields.featuredImage,fields.backgroundColour,fields.textColour,fields.indexed,fields.hidden";
+var PERSON_LINK_FIELDS = "sys,fields.name,fields.slug,fields.media,fields.backgroundColour,fields.textColour,fields.indexed,fields.hidden";
 function convertAllAssets(response, context) {
   const visuals = /* @__PURE__ */ new Map();
   const assets = response.includes?.Asset;
@@ -1883,7 +1889,8 @@ async function getAllArticlesForRelated(context, config, options) {
           // Shallow include - just enough for tags, articleType, author
           locale: options?.locale,
           limit: pageSize,
-          skip
+          skip,
+          select: ARTICLE_RELATED_FIELDS
         },
         requestOptions
       );
@@ -1928,7 +1935,7 @@ async function getAllArticlesForRelated(context, config, options) {
   }
   return await fetchFn();
 }
-async function fetchAllLinks(contentType, client, requestOptions, converter, context, pageSize = 100) {
+async function fetchAllLinks(contentType, client, requestOptions, converter, context, pageSize = 100, select) {
   const allLinks = [];
   const errors = [];
   let skip = 0;
@@ -1943,7 +1950,8 @@ async function fetchAllLinks(contentType, client, requestOptions, converter, con
             // Minimal include for link-only fetching
             locale: requestOptions?.locale,
             limit: pageSize,
-            skip
+            skip,
+            ...select && { select }
           },
           requestOptions
         );
@@ -1966,6 +1974,7 @@ async function fetchAllLinks(contentType, client, requestOptions, converter, con
               fullContext,
               entry
             );
+            converted.lastModified = entry.sys.updatedAt ? new Date(entry.sys.updatedAt) : void 0;
             allLinks.push(converted);
           } catch (error) {
             const entryId = entry.sys.id;
@@ -2002,7 +2011,15 @@ async function contentfulAllPageLinks(context, config, options) {
       tags: cacheTags
     }
   };
-  const fetchFn = () => fetchAllLinks("page", client, requestOptions, basePageLinkConverter, context);
+  const fetchFn = () => fetchAllLinks(
+    "page",
+    client,
+    requestOptions,
+    basePageLinkConverter,
+    context,
+    100,
+    PAGE_LINK_FIELDS
+  );
   if (options?.retry) {
     return await withRetry(fetchFn, options.retry);
   }
@@ -2018,7 +2035,15 @@ async function contentfulAllArticleLinks(context, config, options) {
       tags: cacheTags
     }
   };
-  const fetchFn = () => fetchAllLinks("article", client, requestOptions, baseArticleLinkConverter, context);
+  const fetchFn = () => fetchAllLinks(
+    "article",
+    client,
+    requestOptions,
+    baseArticleLinkConverter,
+    context,
+    100,
+    ARTICLE_LINK_FIELDS
+  );
   if (options?.retry) {
     return await withRetry(fetchFn, options.retry);
   }
@@ -2034,7 +2059,15 @@ async function contentfulAllTagLinks(context, config, options) {
       tags: cacheTags
     }
   };
-  const fetchFn = () => fetchAllLinks("tag", client, requestOptions, baseTagLinkConverter, context);
+  const fetchFn = () => fetchAllLinks(
+    "tag",
+    client,
+    requestOptions,
+    baseTagLinkConverter,
+    context,
+    100,
+    TAG_LINK_FIELDS
+  );
   if (options?.retry) {
     return await withRetry(fetchFn, options.retry);
   }
@@ -2050,7 +2083,15 @@ async function contentfulAllPersonLinks(context, config, options) {
       tags: cacheTags
     }
   };
-  const fetchFn = () => fetchAllLinks("person", client, requestOptions, basePersonLinkConverter, context);
+  const fetchFn = () => fetchAllLinks(
+    "person",
+    client,
+    requestOptions,
+    basePersonLinkConverter,
+    context,
+    100,
+    PERSON_LINK_FIELDS
+  );
   if (options?.retry) {
     return await withRetry(fetchFn, options.retry);
   }
@@ -2066,7 +2107,15 @@ async function contentfulAllArticleTypeLinks(context, config, options) {
       tags: cacheTags
     }
   };
-  const fetchFn = () => fetchAllLinks("articleType", client, requestOptions, baseArticleTypeLinkConverter, context);
+  const fetchFn = () => fetchAllLinks(
+    "articleType",
+    client,
+    requestOptions,
+    baseArticleTypeLinkConverter,
+    context,
+    100,
+    ARTICLE_TYPE_LINK_FIELDS
+  );
   if (options?.retry) {
     return await withRetry(fetchFn, options.retry);
   }
@@ -2118,6 +2167,64 @@ function filterRelatedArticles(articles, options) {
     return cleanLink;
   });
 }
+function linksToSitemapEntries(links, sitemapConfig) {
+  return links.filter((link) => link.indexed !== false && link.hidden !== true && link.href).map((link) => ({
+    url: link.href,
+    lastModified: link.lastModified,
+    changeFrequency: sitemapConfig?.changeFrequency,
+    priority: sitemapConfig?.priority
+  }));
+}
+async function contentfulPageSitemapEntries(context, config, sitemapConfig, options) {
+  const response = await contentfulAllPageLinks(context, config, options);
+  return {
+    data: linksToSitemapEntries(response.data, sitemapConfig),
+    errors: response.errors
+  };
+}
+async function contentfulArticleSitemapEntries(context, config, sitemapConfig, options) {
+  const response = await contentfulAllArticleLinks(context, config, options);
+  return {
+    data: linksToSitemapEntries(response.data, sitemapConfig),
+    errors: response.errors
+  };
+}
+async function contentfulArticleTypeSitemapEntries(context, config, sitemapConfig, options) {
+  const response = await contentfulAllArticleTypeLinks(context, config, options);
+  return {
+    data: linksToSitemapEntries(response.data, sitemapConfig),
+    errors: response.errors
+  };
+}
+async function contentfulTagSitemapEntries(context, config, sitemapConfig, options) {
+  const response = await contentfulAllTagLinks(context, config, options);
+  return {
+    data: linksToSitemapEntries(response.data, sitemapConfig),
+    errors: response.errors
+  };
+}
+async function contentfulPersonSitemapEntries(context, config, sitemapConfig, options) {
+  const response = await contentfulAllPersonLinks(context, config, options);
+  return {
+    data: linksToSitemapEntries(response.data, sitemapConfig),
+    errors: response.errors
+  };
+}
+async function getAllSitemapEntries(context, config, sitemapConfig, options) {
+  const allEntries = [];
+  const allErrors = [];
+  const results = await Promise.all(
+    sitemapConfig.providers.map((provider) => provider(context, config, options))
+  );
+  for (const result of results) {
+    allEntries.push(...result.data);
+    allErrors.push(...result.errors);
+  }
+  return { data: allEntries, errors: allErrors };
+}
+function createSitemapProvider(fetcher, sitemapConfig) {
+  return (context, config, options) => fetcher(context, config, sitemapConfig, options);
+}
 
 // src/revalidation/handlers.ts
 init_tags();
@@ -2339,6 +2446,6 @@ function createRevalidationHandler(config = {}) {
 init_tags();
 init_utils();
 
-export { AllTags, ArticleTag, ArticleTypeTag, AssetTag, AuthenticationError, BannerTag, ContentfulError, CustomTypeTag, EntryNotFoundError, GlobalTag, LocationTag, NavigationTag, PageTag, PersonTag, RateLimitError, RateLimiter, TagTag, TemplateTag, ValidationError, arrayOrUndefined, articleTag, articleTypeIndexTag, articleTypeTag, assetTag, basePageConverter, calculateBackoffDelay, contentfulAllArticleLinks, contentfulAllArticleTypeLinks, contentfulAllPageLinks, contentfulAllPersonLinks, contentfulAllTagLinks, contentfulArticleRest, contentfulArticleTypeRest, contentfulPageRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createResponsiveVisual, createRevalidationHandler, customTypeTag, filterRelatedArticles, getAllArticlesForRelated, 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, ContentfulError, CustomTypeTag, EntryNotFoundError, GlobalTag, LocationTag, NavigationTag, PageTag, PersonTag, RateLimitError, RateLimiter, 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 };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map