@se-studio/contentful-rest-api 1.0.28 → 1.0.30

package/dist/index.d.ts

@@ -403,9 +403,19 @@ declare function lookupAsset(context: ConverterContext, asset: UnresolvedLink<'A
 type ContentResolverFunction = (context: ConverterContext, entry: Entry<BaseContent, DefaultChainModifier, string>) => unknown;
 type LinkResolverFunction<TResult extends IInternalLink = IInternalLink> = (context: ConverterContext, entry: Entry<BaseLink, DefaultChainModifier, string>) => TResult;
 type LinkResolverMap = Map<string, LinkResolverFunction>;
+type UrlCalculators = {
+    page: (slug: string) => string;
+    pageVariant: (slug: string) => string;
+    article: (articleTypeSlug: string, slug: string) => string;
+    articleType: (slug: string) => string;
+    tag: (slug: string) => string;
+    person: (slug: string) => string;
+    customType: (slug: string) => string;
+};
 type BaseConverterContext = {
     videoPrefix: string;
     maskResolver?: (maskName: string) => string | undefined;
+    urlCalculators: UrlCalculators;
     linkResolver: LinkResolverMap;
     contentResolver: Map<string, (context: ConverterContext, entry: Entry<BaseContent, DefaultChainModifier, string>) => unknown>;
     navigationItemResolver: typeof baseNavigationItemConverter;
@@ -513,6 +523,16 @@ declare function contentfulAllArticleTypeLinks(context: BaseConverterContext, co
 
 declare function contentfulPageRest(context: BaseConverterContext, config: ContentfulConfig, slug: string, options?: FetchOptions): Promise<CmsResponse<IBasePage | null>>;
 
+type PreviewContentType = 'page' | 'pageVariant' | 'article' | 'articleType' | 'tag' | 'person' | 'customType';
+interface PreviewEntryInfo {
+    contentType: PreviewContentType;
+    entryId: string;
+    slug: string;
+    articleTypeSlug?: string;
+    href: string;
+}
+declare function getPreviewEntryInfo(context: BaseConverterContext, config: ContentfulConfig, entryId: string, options?: Omit<FetchOptions, 'preview'>): Promise<PreviewEntryInfo | null>;
+
 declare function filterRelatedArticles(articles: IArticleLink[], options: RelatedArticlesOptions): IArticleLink[];
 
 declare function contentfulPageSitemapEntries(context: BaseConverterContext, config: ContentfulConfig, sitemapConfig?: SitemapContentTypeConfig, options?: FetchOptions): Promise<CmsResponse<ISitemapEntry[]>>;
@@ -633,4 +653,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, 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 };
+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, 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, contentfulCustomTypeRest, contentfulPageRest, contentfulPageSitemapEntries, contentfulPersonSitemapEntries, contentfulTagRest, contentfulTagSitemapEntries, contentfulTemplateRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createResponsiveVisual, createRevalidationHandler, createSitemapProvider, customTypeTag, filterRelatedArticles, getAllSitemapEntries, getCacheTags, getCacheTagsForPreview, getCacheTagsForProduction, getContentfulClient, getPreviewEntryInfo, getRetryAfter, isContentfulError, isRateLimitError, isRetryableError, isValidDate, locationTag, lookupAsset, notEmpty, pageTag, personTag, resolveLink, resolveLinks, resolveRichTextDocument, revalidateSingleTag, revalidateTags, safeDate, tagTag, templateTag, withRetry };

package/dist/index.js

@@ -1294,16 +1294,49 @@ function resolveNavigationItem(context, fromId, entry) {
   return result;
 }
 function resolveCollectionContent(context, fromId, entry) {
+  const id = entry.sys.id;
+  const possibleEntry = context.includes.get(id);
+  if (!possibleEntry) {
+    throw new Error(
+      `Cannot find included entry for collection content from ${fromId} with id ${id}`
+    );
+  }
+  if (possibleEntry.resolved) {
+    return possibleEntry.resolved;
+  }
+  const { type } = possibleEntry;
+  if (type === "media") {
+    const visual = convertMediaEntryToVisual(
+      context,
+      possibleEntry.entry
+    );
+    if (!visual) {
+      throw new Error(`Failed to convert media entry with id ${id}`);
+    }
+    possibleEntry.resolved = visual;
+    return visual;
+  }
+  if (type === "externalVideo") {
+    const visual = convertExternalVideoEntryToVisual(
+      context,
+      possibleEntry.entry
+    );
+    if (!visual) {
+      throw new Error(`Failed to convert externalVideo entry with id ${id}`);
+    }
+    possibleEntry.resolved = visual;
+    return visual;
+  }
   return resolveHelper(
     context,
     fromId,
     entry,
-    (type) => {
-      const resolver = context.contentResolver.get(type);
+    (resolverType) => {
+      const resolver = context.contentResolver.get(resolverType);
       if (resolver) {
         return resolver;
       }
-      const linkResolver = context.linkResolver.get(type);
+      const linkResolver = context.linkResolver.get(resolverType);
       if (linkResolver) {
         return linkResolver;
       }
@@ -1724,7 +1757,7 @@ function baseArticleLinkConverter(context, entry) {
     sys.id,
     simpleFields,
     context,
-    calculateArticleHref(articleType.slug, fields.slug),
+    context.urlCalculators.article(articleType.slug, fields.slug),
     "Article",
     {
       tags,
@@ -1755,7 +1788,7 @@ function baseArticleTypeLinkConverter(context, entry) {
       slug: fields.slug
     },
     context,
-    calculateArticleTypeHref(fields.slug),
+    context.urlCalculators.articleType(fields.slug),
     "ArticleType",
     { indexPageSlug: fields.indexPageSlug }
   );
@@ -1980,7 +2013,7 @@ function baseCustomTypeLinkConverter(context, entry) {
       slug: fields.indexPageSlug
     },
     context,
-    calculateCustomTypeHref(fields.indexPageSlug),
+    context.urlCalculators.customType(fields.indexPageSlug),
     "CustomType"
   );
 }
@@ -2174,7 +2207,7 @@ function basePageLinkConverter(context, entry) {
       slug: fields.slug
     },
     context,
-    calculatePageHref(fields.slug),
+    context.urlCalculators.page(fields.slug),
     "Page",
     { tags: fields.tags?.map((tag) => resolveLink(context, id, tag)) }
   );
@@ -2203,7 +2236,7 @@ function basePageVariantLinkConverter(context, entry) {
       slug: fields.slug
     },
     context,
-    calculatePageVariantHref(fields.slug),
+    context.urlCalculators.pageVariant(fields.slug),
     "Page",
     { tags: fields.tags?.map((tag) => resolveLink(context, id, tag)) }
   );
@@ -2239,7 +2272,7 @@ function basePersonLinkConverter(context, entry) {
       cmsLabel: title
     },
     context,
-    calculatePersonHref(fields.slug),
+    context.urlCalculators.person(fields.slug),
     "Person",
     {
       bio: resolveRichTextDocument(context, sys.id, fieldsBio),
@@ -2267,7 +2300,7 @@ function baseTagLinkConverter(context, entry) {
       ...fields
     },
     context,
-    calculateTagHref(fields.slug),
+    context.urlCalculators.tag(fields.slug),
     "Tag"
   );
 }
@@ -2338,6 +2371,15 @@ function createBaseConverterContext() {
     "externalComponent",
     baseExternalComponentConverter
   );
+  const urlCalculators = {
+    page: calculatePageHref,
+    pageVariant: calculatePageVariantHref,
+    article: calculateArticleHref,
+    articleType: calculateArticleTypeHref,
+    tag: calculateTagHref,
+    person: calculatePersonHref,
+    customType: calculateCustomTypeHref
+  };
   return {
     pageResolver: basePageConverter,
     navigationItemResolver: baseNavigationItemConverter,
@@ -2349,6 +2391,7 @@ function createBaseConverterContext() {
     collectionResolver: baseCollectionConverter,
     linkResolver,
     contentResolver,
+    urlCalculators,
     videoPrefix: ""
   };
 }
@@ -2510,6 +2553,119 @@ async function contentfulPageRest(context, config, slug, options) {
   );
 }
 
+// src/api/preview.ts
+async function getPreviewEntryInfo(context, config, entryId, options) {
+  const client = getContentfulClient(config, true);
+  const response = await client.getEntries(
+    {
+      "sys.id": entryId,
+      include: 1
+      // Need 1 level for Article → ArticleType slug
+    },
+    {
+      ...options,
+      preview: true
+    }
+  );
+  const entry = response.items[0];
+  if (!entry) {
+    return null;
+  }
+  const contentTypeId = entry.sys.contentType.sys.id;
+  const { fields } = entry;
+  switch (contentTypeId) {
+    case "page": {
+      const slug = fields.slug;
+      if (!slug) return null;
+      return {
+        contentType: "page",
+        entryId,
+        slug,
+        href: context.urlCalculators.page(slug)
+      };
+    }
+    case "pageVariant": {
+      const slug = fields.slug;
+      if (!slug) return null;
+      return {
+        contentType: "pageVariant",
+        entryId,
+        slug,
+        href: context.urlCalculators.pageVariant(slug)
+      };
+    }
+    case "article": {
+      const slug = fields.slug;
+      const articleTypeSlug = getArticleTypeSlug(entry, response.includes?.Entry);
+      if (!slug || !articleTypeSlug) return null;
+      return {
+        contentType: "article",
+        entryId,
+        slug,
+        articleTypeSlug,
+        href: context.urlCalculators.article(articleTypeSlug, slug)
+      };
+    }
+    case "articleType": {
+      const slug = fields.indexPageSlug ?? fields.slug;
+      if (!slug) return null;
+      return {
+        contentType: "articleType",
+        entryId,
+        slug,
+        href: context.urlCalculators.articleType(slug)
+      };
+    }
+    case "tag": {
+      const slug = fields.slug;
+      if (!slug) return null;
+      return {
+        contentType: "tag",
+        entryId,
+        slug,
+        href: context.urlCalculators.tag(slug)
+      };
+    }
+    case "person": {
+      const slug = fields.slug;
+      if (!slug) return null;
+      return {
+        contentType: "person",
+        entryId,
+        slug,
+        href: context.urlCalculators.person(slug)
+      };
+    }
+    case "customType": {
+      const slug = fields.indexPageSlug ?? fields.slug;
+      if (!slug) return null;
+      return {
+        contentType: "customType",
+        entryId,
+        slug,
+        href: context.urlCalculators.customType(slug)
+      };
+    }
+    default:
+      return null;
+  }
+}
+function getArticleTypeSlug(entry, includes) {
+  const articleTypeField = entry.fields.articleType;
+  if (!articleTypeField) {
+    return void 0;
+  }
+  if (articleTypeField.fields?.slug) {
+    return articleTypeField.fields.slug;
+  }
+  const articleTypeId = articleTypeField.sys?.id;
+  if (!articleTypeId || !includes) {
+    return void 0;
+  }
+  const articleTypeEntry = includes.find((inc) => inc.sys.id === articleTypeId);
+  return articleTypeEntry?.fields?.slug;
+}
+
 // src/api/related-articles.ts
 function filterRelatedArticles(articles, options) {
   const {
@@ -2920,6 +3076,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, 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 };
+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, contentfulCustomTypeRest, contentfulPageRest, contentfulPageSitemapEntries, contentfulPersonSitemapEntries, contentfulTagRest, contentfulTagSitemapEntries, contentfulTemplateRest, createBaseConverterContext, createContentfulClient, createContentfulPreviewClient, createResponsiveVisual, createRevalidationHandler, createSitemapProvider, customTypeTag, filterRelatedArticles, getAllSitemapEntries, getCacheTags, getCacheTagsForPreview, getCacheTagsForProduction, getContentfulClient, getPreviewEntryInfo, getRetryAfter, isContentfulError, isRateLimitError, isRetryableError, isValidDate, locationTag, lookupAsset, notEmpty, pageTag, personTag, resolveLink, resolveLinks, resolveRichTextDocument, revalidateSingleTag, revalidateTags, safeDate, tagTag, templateTag, withRetry };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map