@janbox/contentful-marketplace-sdk 4.0.0-alpha.0 → 4.0.0-alpha.2

package/README.md

@@ -191,6 +191,50 @@ const articleById = await getDocArticleDetail({
 });
 ```
 
+### Help Center
+
+- `getHelpCategories(options?)`
+- `getHelpCategoryDetail({ id } | { slug })`
+- `getHelpArticles(options?)`
+- `getHelpArticleDetail({ id } | { slug })`
+
+```ts
+// Categories are flat: build the tree from parentId (null = top level).
+const categories = await getHelpCategories({ locale: "vi", size: 1000 });
+
+// One category, same shape as a list item.
+const category = await getHelpCategoryDetail({
+  slug: "thanh-toan",
+  locale: "vi",
+});
+
+// Article summaries (no body). Filter by category or featured flag.
+const articles = await getHelpArticles({ locale: "vi", size: 1000 });
+const featured = await getHelpArticles({ locale: "vi", featured: true });
+const subcategory = categories.items.find((c) => c.parentId !== null);
+const inCategory = await getHelpArticles({
+  locale: "vi",
+  categoryId: subcategory?.sys.id,
+});
+
+const article = await getHelpArticleDetail({
+  slug: "bao-lau-hang-ve-viet-nam",
+  locale: "vi",
+});
+// article.body: { json, links: { assets: { block } } } | null
+```
+
+Notes:
+
+- Results are ordered by `position`.
+- To load a whole locale, pass `size: 1000` (the maximum the CMS accepts) and check `totalPages`. A larger `size` is rejected with `CmsError` `InvalidQuery`.
+- `path` is the path stored on the CMS for the entry.
+- An article slug is unique within a locale only, so pass `locale` when looking an article up by slug.
+- A category slug is not always unique, even within a locale: a subcategory can share its parent's slug. `getHelpCategoryDetail({ slug })` then returns the category that comes first by `position`; use `id` to get a specific one.
+- Every item has `locale` (`null` when the entry has none), so an article fetched by `id`, or a list fetched without `locale`, still tells which language it belongs to.
+- `categoryId` is `null` for an article with no category.
+- The `categoryId` filter matches an article's own category only, not its subcategories. To list a whole branch, load all articles once and group them by `categoryId` along the tree.
+
 ### Brand / Hyperlink / Keyword Collections
 
 - `getBrandCollections(options?)`
@@ -239,7 +283,7 @@ Filters `marketCode` / `locale` with global fallback (entries where `markets` /
 
 Every error from the CMS is a `CmsError` of `@janbox/headless-cms-sdk` (`id`, `status`, `requestId`, `details`, `url`). The SDK README lists the `id` values.
 
-- The detail functions (`getBlogPostDetail`, `getBlogCategoryDetail`, `getDocCategoryDetail`, `getDocArticleDetail`), `getPolicyAndTerms` and `getBlogPosts({ collectionId })` throw a `CmsError` with `id: "NotFound"`, `status: 404` and `message: "Entry not found"` when no entry matches.
+- The detail functions (`getBlogPostDetail`, `getBlogCategoryDetail`, `getDocCategoryDetail`, `getDocArticleDetail`, `getHelpCategoryDetail`, `getHelpArticleDetail`), `getPolicyAndTerms` and `getBlogPosts({ collectionId })` throw a `CmsError` with `id: "NotFound"`, `status: 404` and `message: "Entry not found"` when no entry matches.
 - The detail functions throw `Error("Either id or slug is required.")` if neither `id` nor `slug` is provided.
 - Calling a function before `configure` throws `Error("Client is not configured")`.
 
@@ -275,6 +319,7 @@ The package exports:
 - client and entry functions from `src/client` and `src/entries`
 - content model field types (`TypeXxxFields`) from `src/types`
 - response item types such as `BlogPostGraphQLItem` and `DocArticleGraphQLItem` (names kept from 2.x)
+- help center item types `HelpCategoryItem`, `HelpArticleItem`, `HelpArticleDetailItem`, and `RichText` (the shape of rich text fields such as `body`)
 
 CMS data, query, config and error types (`Entry`, `Asset`, `Link`, `RawEntryCollection`, `EntriesQuery`, `ClientConfig`, `CmsClient`, `CmsError`) come from `@janbox/headless-cms-sdk`; this package does not re-export them.
 

package/dist/entries/help-center.d.ts

@@ -0,0 +1,56 @@
+import { PaginatedResponse } from '../utils';
+import { RichText } from '../utils/resolve';
+type HelpEntrySys = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+};
+export type HelpCategoryItem = {
+    sys: HelpEntrySys;
+    title: string | null;
+    slug: string | null;
+    path: string | null;
+    locale: string | null;
+    position: number | null;
+    parentId: string | null;
+};
+export type HelpArticleItem = {
+    sys: HelpEntrySys;
+    title: string | null;
+    slug: string | null;
+    path: string | null;
+    locale: string | null;
+    position: number | null;
+    featured: boolean;
+    categoryId: string | null;
+};
+export type GetHelpCategoriesResponse = PaginatedResponse<HelpCategoryItem>;
+export type GetHelpCategoryDetailResponse = HelpCategoryItem;
+export type GetHelpArticlesResponse = PaginatedResponse<HelpArticleItem>;
+export interface HelpArticleDetailItem extends HelpArticleItem {
+    body: RichText | null;
+}
+export type GetHelpArticleDetailResponse = HelpArticleDetailItem;
+export declare const getHelpCategories: ({ locale, page, size, }?: {
+    locale?: string;
+    page?: number;
+    size?: number;
+}) => Promise<GetHelpCategoriesResponse>;
+export declare const getHelpCategoryDetail: ({ id, slug, locale, }: {
+    id?: string;
+    slug?: string;
+    locale?: string;
+}) => Promise<GetHelpCategoryDetailResponse>;
+export declare const getHelpArticles: ({ locale, categoryId, featured, page, size, }?: {
+    locale?: string;
+    categoryId?: string;
+    featured?: boolean;
+    page?: number;
+    size?: number;
+}) => Promise<GetHelpArticlesResponse>;
+export declare const getHelpArticleDetail: ({ id, slug, locale, }: {
+    id?: string;
+    slug?: string;
+    locale?: string;
+}) => Promise<GetHelpArticleDetailResponse>;
+export {};

package/dist/entries/index.d.ts

@@ -4,6 +4,7 @@ export * from './blog-category';
 export * from './blog-collection';
 export * from './brand-collection';
 export * from './documentation';
+export * from './help-center';
 export * from './hyperlink-collection';
 export * from './hyperlink';
 export * from './keyword-collection';

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const A=require("@janbox/headless-cms-sdk"),U=["baseUrl","accessToken","headers","fetch","timeout","retry"];class d{static _config;static _client;static get config(){if(!this._config)throw new Error("Client is not configured");return this._config}static get client(){const t=this.config,i=this._client;if(i&&U.every(s=>i.builtFrom[s]===t[s]))return i.client;const l=A.createClient(t);return this._client={client:l,builtFrom:{...t}},l}static configure(t){this._config=t}}class h{page;total;size;items;totalPages;constructor({page:t,total:i,size:l,items:s}){this.page=t,this.total=i,this.size=l,this.items=s,this.totalPages=Math.ceil(this.total/this.size)}}const m="-sys.updatedAt",g=e=>e?A.or("market",[{"fields.markets[exists]":"false"},{"fields.markets.sys.contentType.sys.id":"market","fields.markets.fields.code":e}]):{},p=e=>e?A.or("locale",[{"fields.locale[exists]":"false"},{"fields.locale":e}]):{},v=({id:e,slug:t})=>{if(e)return{"sys.id":e,limit:1};if(t)return{"fields.slug":t,limit:1};throw new Error("Either id or slug is required.")},w=(e,t,i=0)=>{const l=Math.max(1,Math.floor(e)),s=Math.max(1,Math.floor(t)),n=Math.max(0,Math.floor(i));return{page:l,size:s,params:{limit:s,skip:(l-1)*s+n}}},f=e=>{const t=new Map,i=new Map;for(const s of[...e.items,...e.includes?.Entry??[]])t.set(s.sys.id,s);for(const s of e.includes?.Asset??[])i.set(s.sys.id,s);const l=s=>(s&&t.get(s.sys.id))??null;return{entry:l,asset:s=>(s&&i.get(s.sys.id))??null,entries:s=>(s??[]).map(n=>l(n)).filter(n=>n!==null)}},o=e=>e??null,k=e=>{const t=e?.fields.file;return t?{url:t.url,width:t.details.image?.width??null,height:t.details.image?.height??null,contentType:t.contentType}:null},q=e=>({sys:{id:e.sys.id},url:e.fields.file?.url,width:e.fields.file?.details.image?.width??null,height:e.fields.file?.details.image?.height??null,contentType:e.fields.file?.contentType,title:o(e.fields.title),description:o(e.fields.description)}),S=(e,t)=>{if(!e||typeof e!="object")return t;const i=e;if(i.nodeType==="embedded-asset-block"){const l=i.data?.target?.sys?.id;l&&!t.includes(l)&&t.push(l)}for(const l of i.content??[])S(l,t);return t},T=(e,t)=>{if(!e)return null;const i=S(e,[]).map(l=>t.asset({sys:{type:"Link",linkType:"Asset",id:l}})).filter(l=>l!==null&&!!l.fields.file).map(q);return{json:e,links:{assets:{block:i}}}},z=e=>e?{metaTitle:o(e.fields.metaTitle),metaDescription:o(e.fields.metaDescription),metaKeywords:o(e.fields.metaKeywords),metaRobots:o(e.fields.metaRobots)}:null,b=e=>e?{sys:{id:e.sys.id},label:o(e.fields.label),url:o(e.fields.url),target:o(e.fields.target),marketHandling:o(e.fields.marketHandling)}:null,R=(e,t)=>e?{name:o(e.fields.name),avatar:k(t.asset(e.fields.avatar))}:null,G=async({slot:e,page:t=1,size:i=20,platform:l,marketCode:s,locale:n})=>{const c=w(t,i),a=await d.client.getEntries({content_type:"bannerCollection","fields.slot":e,"fields.platform":l||void 0,select:"sys.id,fields.name,fields.slot,fields.platform,fields.banners",include:2,order:m,...c.params,...g(s),...p(n)},{resolveLinks:!1}),r=f(a);return new h({page:c.page,total:a.total,size:c.size,items:a.items.map(u=>({sys:{id:u.sys.id},name:o(u.fields.name),slot:o(u.fields.slot),platform:o(u.fields.platform),bannersCollection:{items:r.entries(u.fields.banners).map(C=>({sys:{id:C.sys.id},name:o(C.fields.name),hyperlink:b(r.entry(C.fields.hyperlink)),media:k(r.asset(C.fields.media))}))}}))})},E=()=>new A.CmsError({id:"NotFound",message:"Entry not found",url:`${d.config.baseUrl.trim().replace(/\/+$/,"")}/entries`,status:404}),I="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.shortDescription,fields.slug,fields.categories,fields.featuredImage",L=(e,t)=>({sys:{id:e.sys.id,createdAt:e.sys.createdAt,updatedAt:e.sys.updatedAt},title:o(e.fields.title),shortDescription:o(e.fields.shortDescription),slug:o(e.fields.slug),categoriesCollection:{items:t.entries(e.fields.categories).map(i=>({sys:{id:i.sys.id},title:o(i.fields.title),slug:o(i.fields.slug),featuredImage:k(t.asset(i.fields.featuredImage))}))},featuredImage:k(t.asset(e.fields.featuredImage))}),Y=async({marketCode:e,locale:t,collectionId:i,categoryId:l,page:s=1,size:n=20,skip:c=0}={})=>{const a=w(s,n,c);if(i){const B=(await d.client.getEntries({content_type:"blogCollection","sys.id":i,select:"sys.id,fields.posts",include:0,limit:1},{resolveLinks:!1})).items.at(0);if(!B)throw E();const _=(B.fields.posts??[]).filter(y=>y.sys.linkType==="Entry").map(y=>y.sys.id),D=_.slice(a.params.skip,a.params.skip+a.size);if(!D.length)return new h({page:a.page,total:_.length,size:a.size,items:[]});const P=await d.client.getEntries({content_type:"blogPost","sys.id[in]":D.join(","),select:I,include:2,limit:a.size},{resolveLinks:!1}),j=f(P),N=new Map(P.items.map(y=>[y.sys.id,y]));return new h({page:a.page,total:_.length,size:a.size,items:D.map(y=>N.get(y)).filter(y=>y!==void 0).map(y=>L(y,j))})}const r=await d.client.getEntries({content_type:"blogPost","fields.categories.sys.id":l||void 0,select:I,include:2,order:m,...a.params,...g(e),...p(t)},{resolveLinks:!1}),u=f(r);return new h({page:a.page,total:r.total,size:a.size,items:r.items.map(C=>L(C,u))})},J=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=v({id:e,slug:t}),n=await d.client.getEntries({content_type:"blogPost",...s,select:`${I},fields.author,fields.content,fields.seo`,include:2,order:m,...g(i),...p(l)},{resolveLinks:!1}),c=n.items.at(0);if(!c)throw E();const a=f(n);return{...L(c,a),author:R(a.entry(c.fields.author),a),content:T(c.fields.content,a),seo:z(a.entry(c.fields.seo))}},M="sys.id,fields.title,fields.slug,fields.featuredImage",F=(e,t)=>({sys:{id:e.sys.id},title:o(e.fields.title),slug:o(e.fields.slug),featuredImage:k(t.asset(e.fields.featuredImage))}),Q=async({marketCode:e,locale:t,page:i=1,size:l=20}={})=>{const s=w(i,l),n=await d.client.getEntries({content_type:"blogCategory",select:M,include:1,order:m,...s.params,...g(e),...p(t)},{resolveLinks:!1}),c=f(n);return new h({page:s.page,total:n.total,size:s.size,items:n.items.map(a=>F(a,c))})},V=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=v({id:e,slug:t}),n=await d.client.getEntries({content_type:"blogCategory",...s,select:`${M},fields.description,fields.seo`,include:1,order:m,...g(i),...p(l)},{resolveLinks:!1}),c=n.items.at(0);if(!c)throw E();const a=f(n);return{...F(c,a),description:o(c.fields.description),seo:z(a.entry(c.fields.seo))}},W=async({marketCode:e,locale:t,page:i=1,size:l=20}={})=>{const s=w(i,l),n=await d.client.getEntries({content_type:"blogCollection",select:"sys.id,fields.name,fields.type,fields.order,fields.category,fields.featuredImage",include:1,order:m,...s.params,...g(e),...p(t)},{resolveLinks:!1}),c=f(n),a=n.items.map(r=>{const u=c.entry(r.fields.category);return{name:o(r.fields.name),type:o(r.fields.type),order:o(r.fields.order),sys:{id:r.sys.id},category:u?{sys:{id:u.sys.id},title:o(u.fields.title),slug:o(u.fields.slug)}:null,featuredImage:k(c.asset(r.fields.featuredImage))}});return new h({page:s.page,total:n.total,size:s.size,items:a.map(r=>({...r,category:r.type==="category"?r.category:null,categoryId:r.type==="category"?r.category?.sys.id??null:null,collectionId:r.type==="manual"?r.sys.id:null}))})},X=async({page:e=1,size:t=20,marketCode:i,locale:l}={})=>{const s=w(e,t),n=await d.client.getEntries({content_type:"brandCollection",select:"sys.id,fields.name,fields.slot,fields.brands",include:2,order:m,...s.params,...g(i),...p(l)},{resolveLinks:!1}),c=f(n);return new h({page:s.page,total:n.total,size:s.size,items:n.items.map(a=>({sys:{id:a.sys.id},name:o(a.fields.name),slot:o(a.fields.slot),brandsCollection:{items:c.entries(a.fields.brands).map(r=>({sys:{id:r.sys.id},name:o(r.fields.name),logo:k(c.asset(r.fields.logo)),hyperlink:b(c.entry(r.fields.hyperlink))}))}}))})},x="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.description,fields.order,fields.seo",O="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.author,fields.category",K=e=>({id:e.sys.id,createdAt:e.sys.createdAt,updatedAt:e.sys.updatedAt}),H=(e,t)=>({sys:K(e),title:o(e.fields.title),slug:o(e.fields.slug),description:o(e.fields.description),order:o(e.fields.order),seo:z(t.entry(e.fields.seo))}),$=(e,t)=>{const i=t.entry(e.fields.category);return{sys:K(e),title:o(e.fields.title),slug:o(e.fields.slug),author:R(t.entry(e.fields.author),t),category:i?{title:o(i.fields.title),slug:o(i.fields.slug),description:o(i.fields.description),order:o(i.fields.order)}:null}},Z=async({marketCode:e,locale:t,page:i=1,size:l=20}={})=>{const s=w(i,l),n=await d.client.getEntries({content_type:"documentationCategory",select:x,include:1,order:m,...s.params,...g(e),...p(t)},{resolveLinks:!1}),c=f(n);return new h({page:s.page,total:n.total,size:s.size,items:n.items.map(a=>H(a,c))})},ee=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=v({id:e,slug:t}),n=await d.client.getEntries({content_type:"documentationCategory",...s,select:x,include:1,order:m,...g(i),...p(l)},{resolveLinks:!1}),c=n.items.at(0);if(!c)throw E();return H(c,f(n))},te=async({marketCode:e,locale:t,categorySlug:i,page:l=1,size:s=20}={})=>{const n=w(l,s),c=await d.client.getEntries({content_type:"documentationArticle",...i?{"fields.category.sys.contentType.sys.id":"documentationCategory","fields.category.fields.slug":i}:{},select:O,include:2,order:m,...n.params,...g(e),...p(t)},{resolveLinks:!1}),a=f(c);return new h({page:n.page,total:c.total,size:n.size,items:c.items.map(r=>$(r,a))})},se=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=v({id:e,slug:t}),n=await d.client.getEntries({content_type:"documentationArticle",...s,select:`${O},fields.content,fields.seo`,include:2,order:m,...g(i),...p(l)},{resolveLinks:!1}),c=n.items.at(0);if(!c)throw E();const a=f(n);return{...$(c,a),content:T(c.fields.content,a),seo:z(a.entry(c.fields.seo))}},ie=async({page:e=1,size:t=20,marketCode:i,locale:l}={})=>{const s=w(e,t),n=await d.client.getEntries({content_type:"hyperlinkCollection",select:"sys.id,fields.name,fields.slot,fields.order,fields.links",include:1,order:"fields.order",...s.params,...g(i),...p(l)},{resolveLinks:!1}),c=f(n);return new h({page:s.page,total:n.total,size:s.size,items:n.items.map(a=>({sys:{id:a.sys.id},name:o(a.fields.name),slot:o(a.fields.slot),order:o(a.fields.order),linksCollection:{items:c.entries(a.fields.links).map(r=>b(r))}}))})},le=async({page:e=1,size:t=20,marketCode:i,locale:l}={})=>{const s=w(e,t),n=await d.client.getEntries({content_type:"keywordCollection",select:"sys.id,fields.name,fields.slot,fields.keywords",include:0,order:m,...s.params,...g(i),...p(l)},{resolveLinks:!1});return new h({page:s.page,total:n.total,size:s.size,items:n.items.map(c=>({sys:{id:c.sys.id},name:o(c.fields.name),slot:o(c.fields.slot),keywords:o(c.fields.keywords)}))})},oe=async({marketCode:e,locale:t}={})=>{const i=await d.client.getEntries({content_type:"policyAndTerms",select:"sys.id,fields.title,fields.locale,fields.content",include:1,order:m,limit:1,...g(e),...p(t)},{resolveLinks:!1}),l=i.items.at(0);if(!l)throw E();return{sys:{id:l.sys.id},title:o(l.fields.title),locale:o(l.fields.locale),content:T(l.fields.content,f(i))}};exports.ContentfulSDK=d;exports.PaginatedResponse=h;exports.getBannerCollections=G;exports.getBlogCategories=Q;exports.getBlogCategoryDetail=V;exports.getBlogCollections=W;exports.getBlogPostDetail=J;exports.getBlogPosts=Y;exports.getBrandCollections=X;exports.getDocArticleDetail=se;exports.getDocArticles=te;exports.getDocCategories=Z;exports.getDocCategoryDetail=ee;exports.getHyperlinkCollections=ie;exports.getKeywordCollections=le;exports.getPolicyAndTerms=oe;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const _=require("@janbox/headless-cms-sdk"),X=["baseUrl","accessToken","headers","fetch","timeout","retry"];class r{static _config;static _client;static get config(){if(!this._config)throw new Error("Client is not configured");return this._config}static get client(){const t=this.config,i=this._client;if(i&&X.every(s=>i.builtFrom[s]===t[s]))return i.client;const l=_.createClient(t);return this._client={client:l,builtFrom:{...t}},l}static configure(t){this._config=t}}class p{page;total;size;items;totalPages;constructor({page:t,total:i,size:l,items:s}){this.page=t,this.total=i,this.size=l,this.items=s,this.totalPages=Math.ceil(this.total/this.size)}}const m="-sys.updatedAt",u=e=>e?_.or("market",[{"fields.markets[exists]":"false"},{"fields.markets.sys.contentType.sys.id":"market","fields.markets.fields.code":e}]):{},f=e=>e?_.or("locale",[{"fields.locale[exists]":"false"},{"fields.locale":e}]):{},A=({id:e,slug:t})=>{if(e)return{"sys.id":e,limit:1};if(t)return{"fields.slug":t,limit:1};throw new Error("Either id or slug is required.")},C=(e,t,i=0)=>{const l=Math.max(1,Math.floor(e)),s=Math.max(1,Math.floor(t)),o=Math.max(0,Math.floor(i));return{page:l,size:s,params:{limit:s,skip:(l-1)*s+o}}},g=e=>{const t=new Map,i=new Map;for(const s of[...e.items,...e.includes?.Entry??[]])t.set(s.sys.id,s);for(const s of e.includes?.Asset??[])i.set(s.sys.id,s);const l=s=>(s&&t.get(s.sys.id))??null;return{entry:l,asset:s=>(s&&i.get(s.sys.id))??null,entries:s=>(s??[]).map(o=>l(o)).filter(o=>o!==null)}},n=e=>e??null,k=e=>{const t=e?.fields.file;return t?{url:t.url,width:t.details.image?.width??null,height:t.details.image?.height??null,contentType:t.contentType}:null},Z=e=>({sys:{id:e.sys.id},url:e.fields.file?.url,width:e.fields.file?.details.image?.width??null,height:e.fields.file?.details.image?.height??null,contentType:e.fields.file?.contentType,title:n(e.fields.title),description:n(e.fields.description)}),R=(e,t)=>{if(!e||typeof e!="object")return t;const i=e;if(i.nodeType==="embedded-asset-block"){const l=i.data?.target?.sys?.id;l&&!t.includes(l)&&t.push(l)}for(const l of i.content??[])R(l,t);return t},L=(e,t)=>{if(!e)return null;const i=R(e,[]).map(l=>t.asset({sys:{type:"Link",linkType:"Asset",id:l}})).filter(l=>l!==null&&!!l.fields.file).map(Z);return{json:e,links:{assets:{block:i}}}},T=e=>e?{metaTitle:n(e.fields.metaTitle),metaDescription:n(e.fields.metaDescription),metaKeywords:n(e.fields.metaKeywords),metaRobots:n(e.fields.metaRobots)}:null,P=e=>e?{sys:{id:e.sys.id},label:n(e.fields.label),url:n(e.fields.url),target:n(e.fields.target),marketHandling:n(e.fields.marketHandling)}:null,S=(e,t)=>e?{name:n(e.fields.name),avatar:k(t.asset(e.fields.avatar))}:null,ee=async({slot:e,page:t=1,size:i=20,platform:l,marketCode:s,locale:o})=>{const a=C(t,i),c=await r.client.getEntries({content_type:"bannerCollection","fields.slot":e,"fields.platform":l||void 0,select:"sys.id,fields.name,fields.slot,fields.platform,fields.banners",include:2,order:m,...a.params,...u(s),...f(o)},{resolveLinks:!1}),d=g(c);return new p({page:a.page,total:c.total,size:a.size,items:c.items.map(y=>({sys:{id:y.sys.id},name:n(y.fields.name),slot:n(y.fields.slot),platform:n(y.fields.platform),bannersCollection:{items:d.entries(y.fields.banners).map(w=>({sys:{id:w.sys.id},name:n(w.fields.name),hyperlink:P(d.entry(w.fields.hyperlink)),media:k(d.asset(w.fields.media))}))}}))})},E=()=>new _.CmsError({id:"NotFound",message:"Entry not found",url:`${r.config.baseUrl.trim().replace(/\/+$/,"")}/entries`,status:404}),I="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.shortDescription,fields.slug,fields.categories,fields.featuredImage",b=(e,t)=>({sys:{id:e.sys.id,createdAt:e.sys.createdAt,updatedAt:e.sys.updatedAt},title:n(e.fields.title),shortDescription:n(e.fields.shortDescription),slug:n(e.fields.slug),categoriesCollection:{items:t.entries(e.fields.categories).map(i=>({sys:{id:i.sys.id},title:n(i.fields.title),slug:n(i.fields.slug),featuredImage:k(t.asset(i.fields.featuredImage))}))},featuredImage:k(t.asset(e.fields.featuredImage))}),te=async({marketCode:e,locale:t,collectionId:i,categoryId:l,page:s=1,size:o=20,skip:a=0}={})=>{const c=C(s,o,a);if(i){const H=(await r.client.getEntries({content_type:"blogCollection","sys.id":i,select:"sys.id,fields.posts",include:0,limit:1},{resolveLinks:!1})).items.at(0);if(!H)throw E();const z=(H.fields.posts??[]).filter(h=>h.sys.linkType==="Entry").map(h=>h.sys.id),D=z.slice(c.params.skip,c.params.skip+c.size);if(!D.length)return new p({page:c.page,total:z.length,size:c.size,items:[]});const B=await r.client.getEntries({content_type:"blogPost","sys.id[in]":D.join(","),select:I,include:2,limit:c.size},{resolveLinks:!1}),V=g(B),W=new Map(B.items.map(h=>[h.sys.id,h]));return new p({page:c.page,total:z.length,size:c.size,items:D.map(h=>W.get(h)).filter(h=>h!==void 0).map(h=>b(h,V))})}const d=await r.client.getEntries({content_type:"blogPost","fields.categories.sys.id":l||void 0,select:I,include:2,order:m,...c.params,...u(e),...f(t)},{resolveLinks:!1}),y=g(d);return new p({page:c.page,total:d.total,size:c.size,items:d.items.map(w=>b(w,y))})},se=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=A({id:e,slug:t}),o=await r.client.getEntries({content_type:"blogPost",...s,select:`${I},fields.author,fields.content,fields.seo`,include:2,order:m,...u(i),...f(l)},{resolveLinks:!1}),a=o.items.at(0);if(!a)throw E();const c=g(o);return{...b(a,c),author:S(c.entry(a.fields.author),c),content:L(a.fields.content,c),seo:T(c.entry(a.fields.seo))}},O="sys.id,fields.title,fields.slug,fields.featuredImage",M=(e,t)=>({sys:{id:e.sys.id},title:n(e.fields.title),slug:n(e.fields.slug),featuredImage:k(t.asset(e.fields.featuredImage))}),ie=async({marketCode:e,locale:t,page:i=1,size:l=20}={})=>{const s=C(i,l),o=await r.client.getEntries({content_type:"blogCategory",select:O,include:1,order:m,...s.params,...u(e),...f(t)},{resolveLinks:!1}),a=g(o);return new p({page:s.page,total:o.total,size:s.size,items:o.items.map(c=>M(c,a))})},le=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=A({id:e,slug:t}),o=await r.client.getEntries({content_type:"blogCategory",...s,select:`${O},fields.description,fields.seo`,include:1,order:m,...u(i),...f(l)},{resolveLinks:!1}),a=o.items.at(0);if(!a)throw E();const c=g(o);return{...M(a,c),description:n(a.fields.description),seo:T(c.entry(a.fields.seo))}},oe=async({marketCode:e,locale:t,page:i=1,size:l=20}={})=>{const s=C(i,l),o=await r.client.getEntries({content_type:"blogCollection",select:"sys.id,fields.name,fields.type,fields.order,fields.category,fields.featuredImage",include:1,order:m,...s.params,...u(e),...f(t)},{resolveLinks:!1}),a=g(o),c=o.items.map(d=>{const y=a.entry(d.fields.category);return{name:n(d.fields.name),type:n(d.fields.type),order:n(d.fields.order),sys:{id:d.sys.id},category:y?{sys:{id:y.sys.id},title:n(y.fields.title),slug:n(y.fields.slug)}:null,featuredImage:k(a.asset(d.fields.featuredImage))}});return new p({page:s.page,total:o.total,size:s.size,items:c.map(d=>({...d,category:d.type==="category"?d.category:null,categoryId:d.type==="category"?d.category?.sys.id??null:null,collectionId:d.type==="manual"?d.sys.id:null}))})},ne=async({page:e=1,size:t=20,marketCode:i,locale:l}={})=>{const s=C(e,t),o=await r.client.getEntries({content_type:"brandCollection",select:"sys.id,fields.name,fields.slot,fields.brands",include:2,order:m,...s.params,...u(i),...f(l)},{resolveLinks:!1}),a=g(o);return new p({page:s.page,total:o.total,size:s.size,items:o.items.map(c=>({sys:{id:c.sys.id},name:n(c.fields.name),slot:n(c.fields.slot),brandsCollection:{items:a.entries(c.fields.brands).map(d=>({sys:{id:d.sys.id},name:n(d.fields.name),logo:k(a.asset(d.fields.logo)),hyperlink:P(a.entry(d.fields.hyperlink))}))}}))})},F="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.description,fields.order,fields.seo",x="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.author,fields.category",N=e=>({id:e.sys.id,createdAt:e.sys.createdAt,updatedAt:e.sys.updatedAt}),$=(e,t)=>({sys:N(e),title:n(e.fields.title),slug:n(e.fields.slug),description:n(e.fields.description),order:n(e.fields.order),seo:T(t.entry(e.fields.seo))}),K=(e,t)=>{const i=t.entry(e.fields.category);return{sys:N(e),title:n(e.fields.title),slug:n(e.fields.slug),author:S(t.entry(e.fields.author),t),category:i?{title:n(i.fields.title),slug:n(i.fields.slug),description:n(i.fields.description),order:n(i.fields.order)}:null}},ae=async({marketCode:e,locale:t,page:i=1,size:l=20}={})=>{const s=C(i,l),o=await r.client.getEntries({content_type:"documentationCategory",select:F,include:1,order:m,...s.params,...u(e),...f(t)},{resolveLinks:!1}),a=g(o);return new p({page:s.page,total:o.total,size:s.size,items:o.items.map(c=>$(c,a))})},ce=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=A({id:e,slug:t}),o=await r.client.getEntries({content_type:"documentationCategory",...s,select:F,include:1,order:m,...u(i),...f(l)},{resolveLinks:!1}),a=o.items.at(0);if(!a)throw E();return $(a,g(o))},de=async({marketCode:e,locale:t,categorySlug:i,page:l=1,size:s=20}={})=>{const o=C(l,s),a=await r.client.getEntries({content_type:"documentationArticle",...i?{"fields.category.sys.contentType.sys.id":"documentationCategory","fields.category.fields.slug":i}:{},select:x,include:2,order:m,...o.params,...u(e),...f(t)},{resolveLinks:!1}),c=g(a);return new p({page:o.page,total:a.total,size:o.size,items:a.items.map(d=>K(d,c))})},re=async({id:e,slug:t,marketCode:i,locale:l})=>{const s=A({id:e,slug:t}),o=await r.client.getEntries({content_type:"documentationArticle",...s,select:`${x},fields.content,fields.seo`,include:2,order:m,...u(i),...f(l)},{resolveLinks:!1}),a=o.items.at(0);if(!a)throw E();const c=g(o);return{...K(a,c),content:L(a.fields.content,c),seo:T(c.entry(a.fields.seo))}},Y="crispHelpCategory",j="crispHelpArticle",v="fields.position,sys.id",G="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.path,fields.locale,fields.position,fields.parent",U="sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.path,fields.locale,fields.position,fields.featured,fields.category",q=e=>({id:e.sys.id,createdAt:e.sys.createdAt,updatedAt:e.sys.updatedAt}),J=e=>({sys:q(e),title:n(e.fields.title),slug:n(e.fields.slug),path:n(e.fields.path),locale:n(e.fields.locale),position:n(e.fields.position),parentId:e.fields.parent?.sys.id??null}),Q=e=>({sys:q(e),title:n(e.fields.title),slug:n(e.fields.slug),path:n(e.fields.path),locale:n(e.fields.locale),position:n(e.fields.position),featured:e.fields.featured===!0,categoryId:e.fields.category?.sys.id??null}),fe=async({locale:e,page:t=1,size:i=20}={})=>{const l=C(t,i),s=await r.client.getEntries({content_type:Y,select:G,include:0,order:v,...l.params,...f(e)},{resolveLinks:!1});return new p({page:l.page,total:s.total,size:l.size,items:s.items.map(J)})},ge=async({id:e,slug:t,locale:i})=>{const l=A({id:e,slug:t}),o=(await r.client.getEntries({content_type:Y,...l,select:G,include:0,order:v,...f(i)},{resolveLinks:!1})).items.at(0);if(!o)throw E();return J(o)},pe=async({locale:e,categoryId:t,featured:i,page:l=1,size:s=20}={})=>{const o=C(l,s),a=await r.client.getEntries({content_type:j,...t?{"fields.category.sys.id":t}:{},...i!==void 0?{"fields.featured":i}:{},select:U,include:0,order:v,...o.params,...f(e)},{resolveLinks:!1});return new p({page:o.page,total:a.total,size:o.size,items:a.items.map(Q)})},ue=async({id:e,slug:t,locale:i})=>{const l=A({id:e,slug:t}),s=await r.client.getEntries({content_type:j,...l,select:`${U},fields.body`,include:1,order:v,...f(i)},{resolveLinks:!1}),o=s.items.at(0);if(!o)throw E();return{...Q(o),body:L(o.fields.body,g(s))}},me=async({page:e=1,size:t=20,marketCode:i,locale:l}={})=>{const s=C(e,t),o=await r.client.getEntries({content_type:"hyperlinkCollection",select:"sys.id,fields.name,fields.slot,fields.order,fields.links",include:1,order:"fields.order",...s.params,...u(i),...f(l)},{resolveLinks:!1}),a=g(o);return new p({page:s.page,total:o.total,size:s.size,items:o.items.map(c=>({sys:{id:c.sys.id},name:n(c.fields.name),slot:n(c.fields.slot),order:n(c.fields.order),linksCollection:{items:a.entries(c.fields.links).map(d=>P(d))}}))})},ye=async({page:e=1,size:t=20,marketCode:i,locale:l}={})=>{const s=C(e,t),o=await r.client.getEntries({content_type:"keywordCollection",select:"sys.id,fields.name,fields.slot,fields.keywords",include:0,order:m,...s.params,...u(i),...f(l)},{resolveLinks:!1});return new p({page:s.page,total:o.total,size:s.size,items:o.items.map(a=>({sys:{id:a.sys.id},name:n(a.fields.name),slot:n(a.fields.slot),keywords:n(a.fields.keywords)}))})},he=async({marketCode:e,locale:t}={})=>{const i=await r.client.getEntries({content_type:"policyAndTerms",select:"sys.id,fields.title,fields.locale,fields.content",include:1,order:m,limit:1,...u(e),...f(t)},{resolveLinks:!1}),l=i.items.at(0);if(!l)throw E();return{sys:{id:l.sys.id},title:n(l.fields.title),locale:n(l.fields.locale),content:L(l.fields.content,g(i))}};exports.ContentfulSDK=r;exports.PaginatedResponse=p;exports.getBannerCollections=ee;exports.getBlogCategories=ie;exports.getBlogCategoryDetail=le;exports.getBlogCollections=oe;exports.getBlogPostDetail=se;exports.getBlogPosts=te;exports.getBrandCollections=ne;exports.getDocArticleDetail=re;exports.getDocArticles=de;exports.getDocCategories=ae;exports.getDocCategoryDetail=ce;exports.getHelpArticleDetail=ue;exports.getHelpArticles=pe;exports.getHelpCategories=fe;exports.getHelpCategoryDetail=ge;exports.getHyperlinkCollections=me;exports.getKeywordCollections=ye;exports.getPolicyAndTerms=he;

package/dist/index.js

@@ -1,5 +1,5 @@
-import { createClient as U, or as P, CmsError as G } from "@janbox/headless-cms-sdk";
-const q = [
+import { createClient as X, or as H, CmsError as Z } from "@janbox/headless-cms-sdk";
+const ee = [
   "baseUrl",
   "accessToken",
   "headers",
@@ -17,16 +17,16 @@ class r {
   }
   static get client() {
     const s = this.config, i = this._client;
-    if (i && q.every((t) => i.builtFrom[t] === s[t]))
+    if (i && ee.every((t) => i.builtFrom[t] === s[t]))
       return i.client;
-    const l = U(s);
+    const l = X(s);
     return this._client = { client: l, builtFrom: { ...s } }, l;
   }
   static configure(s) {
     this._config = s;
   }
 }
-class h {
+class u {
   page;
   total;
   size;
@@ -41,16 +41,16 @@ class h {
     this.page = s, this.total = i, this.size = l, this.items = t, this.totalPages = Math.ceil(this.total / this.size);
   }
 }
-const m = "-sys.updatedAt", g = (e) => e ? P("market", [
+const m = "-sys.updatedAt", p = (e) => e ? H("market", [
   { "fields.markets[exists]": "false" },
   {
     "fields.markets.sys.contentType.sys.id": "market",
     "fields.markets.fields.code": e
   }
-]) : {}, p = (e) => e ? P("locale", [
+]) : {}, f = (e) => e ? H("locale", [
   { "fields.locale[exists]": "false" },
   { "fields.locale": e }
-]) : {}, z = ({
+]) : {}, A = ({
   id: e,
   slug: s
 }) => {
@@ -59,17 +59,17 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
   if (s)
     return { "fields.slug": s, limit: 1 };
   throw new Error("Either id or slug is required.");
-}, w = (e, s, i = 0) => {
-  const l = Math.max(1, Math.floor(e)), t = Math.max(1, Math.floor(s)), n = Math.max(0, Math.floor(i));
+}, E = (e, s, i = 0) => {
+  const l = Math.max(1, Math.floor(e)), t = Math.max(1, Math.floor(s)), o = Math.max(0, Math.floor(i));
   return {
     page: l,
     size: t,
     params: {
       limit: t,
-      skip: (l - 1) * t + n
+      skip: (l - 1) * t + o
     }
   };
-}, f = (e) => {
+}, g = (e) => {
   const s = /* @__PURE__ */ new Map(), i = /* @__PURE__ */ new Map();
   for (const t of [...e.items, ...e.includes?.Entry ?? []])
     s.set(t.sys.id, t);
@@ -79,9 +79,9 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
   return {
     entry: l,
     asset: (t) => (t && i.get(t.sys.id)) ?? null,
-    entries: (t) => (t ?? []).map((n) => l(n)).filter((n) => n !== null)
+    entries: (t) => (t ?? []).map((o) => l(o)).filter((o) => o !== null)
   };
-}, o = (e) => e ?? null, E = (e) => {
+}, n = (e) => e ?? null, C = (e) => {
   const s = e?.fields.file;
   return s ? {
     url: s.url,
@@ -89,15 +89,15 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
     height: s.details.image?.height ?? null,
     contentType: s.contentType
   } : null;
-}, Y = (e) => ({
+}, se = (e) => ({
   sys: { id: e.sys.id },
   url: e.fields.file?.url,
   width: e.fields.file?.details.image?.width ?? null,
   height: e.fields.file?.details.image?.height ?? null,
   contentType: e.fields.file?.contentType,
-  title: o(e.fields.title),
-  description: o(e.fields.description)
-}), R = (e, s) => {
+  title: n(e.fields.title),
+  description: n(e.fields.description)
+}), B = (e, s) => {
   if (!e || typeof e != "object")
     return s;
   const i = e;
@@ -106,36 +106,36 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
     l && !s.includes(l) && s.push(l);
   }
   for (const l of i.content ?? [])
-    R(l, s);
+    B(l, s);
   return s;
-}, T = (e, s) => {
+}, _ = (e, s) => {
   if (!e)
     return null;
-  const i = R(e, []).map((l) => s.asset({ sys: { type: "Link", linkType: "Asset", id: l } })).filter((l) => l !== null && !!l.fields.file).map(Y);
+  const i = B(e, []).map((l) => s.asset({ sys: { type: "Link", linkType: "Asset", id: l } })).filter((l) => l !== null && !!l.fields.file).map(se);
   return { json: e, links: { assets: { block: i } } };
-}, _ = (e) => e ? {
-  metaTitle: o(e.fields.metaTitle),
-  metaDescription: o(e.fields.metaDescription),
-  metaKeywords: o(e.fields.metaKeywords),
-  metaRobots: o(e.fields.metaRobots)
-} : null, b = (e) => e ? {
+}, L = (e) => e ? {
+  metaTitle: n(e.fields.metaTitle),
+  metaDescription: n(e.fields.metaDescription),
+  metaKeywords: n(e.fields.metaKeywords),
+  metaRobots: n(e.fields.metaRobots)
+} : null, D = (e) => e ? {
   sys: { id: e.sys.id },
-  label: o(e.fields.label),
-  url: o(e.fields.url),
-  target: o(e.fields.target),
-  marketHandling: o(e.fields.marketHandling)
+  label: n(e.fields.label),
+  url: n(e.fields.url),
+  target: n(e.fields.target),
+  marketHandling: n(e.fields.marketHandling)
 } : null, S = (e, s) => e ? {
-  name: o(e.fields.name),
-  avatar: E(s.asset(e.fields.avatar))
-} : null, Q = async ({
+  name: n(e.fields.name),
+  avatar: C(s.asset(e.fields.avatar))
+} : null, ie = async ({
   slot: e,
   page: s = 1,
   size: i = 20,
   platform: l,
   marketCode: t,
-  locale: n
+  locale: o
 }) => {
-  const c = w(s, i), a = await r.client.getEntries(
+  const a = E(s, i), c = await r.client.getEntries(
     {
       content_type: "bannerCollection",
       "fields.slot": e,
@@ -143,70 +143,70 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
       select: "sys.id,fields.name,fields.slot,fields.platform,fields.banners",
       include: 2,
       order: m,
-      ...c.params,
-      ...g(t),
-      ...p(n)
+      ...a.params,
+      ...p(t),
+      ...f(o)
     },
     { resolveLinks: !1 }
-  ), d = f(a);
-  return new h({
-    page: c.page,
-    total: a.total,
-    size: c.size,
-    items: a.items.map(
-      (u) => ({
-        sys: { id: u.sys.id },
-        name: o(u.fields.name),
-        slot: o(u.fields.slot),
-        platform: o(u.fields.platform),
+  ), d = g(c);
+  return new u({
+    page: a.page,
+    total: c.total,
+    size: a.size,
+    items: c.items.map(
+      (y) => ({
+        sys: { id: y.sys.id },
+        name: n(y.fields.name),
+        slot: n(y.fields.slot),
+        platform: n(y.fields.platform),
         bannersCollection: {
-          items: d.entries(u.fields.banners).map((k) => ({
+          items: d.entries(y.fields.banners).map((k) => ({
             sys: { id: k.sys.id },
-            name: o(k.fields.name),
-            hyperlink: b(
+            name: n(k.fields.name),
+            hyperlink: D(
               d.entry(k.fields.hyperlink)
             ),
-            media: E(d.asset(k.fields.media))
+            media: C(d.asset(k.fields.media))
           }))
         }
       })
     )
   });
-}, C = () => new G({
+}, w = () => new Z({
   id: "NotFound",
   message: "Entry not found",
   url: `${r.config.baseUrl.trim().replace(/\/+$/, "")}/entries`,
   status: 404
-}), I = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.shortDescription,fields.slug,fields.categories,fields.featuredImage", L = (e, s) => ({
+}), I = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.shortDescription,fields.slug,fields.categories,fields.featuredImage", b = (e, s) => ({
   sys: {
     id: e.sys.id,
     createdAt: e.sys.createdAt,
     updatedAt: e.sys.updatedAt
   },
-  title: o(e.fields.title),
-  shortDescription: o(e.fields.shortDescription),
-  slug: o(e.fields.slug),
+  title: n(e.fields.title),
+  shortDescription: n(e.fields.shortDescription),
+  slug: n(e.fields.slug),
   categoriesCollection: {
     items: s.entries(e.fields.categories).map((i) => ({
       sys: { id: i.sys.id },
-      title: o(i.fields.title),
-      slug: o(i.fields.slug),
-      featuredImage: E(s.asset(i.fields.featuredImage))
+      title: n(i.fields.title),
+      slug: n(i.fields.slug),
+      featuredImage: C(s.asset(i.fields.featuredImage))
     }))
   },
-  featuredImage: E(s.asset(e.fields.featuredImage))
-}), V = async ({
+  featuredImage: C(s.asset(e.fields.featuredImage))
+}), le = async ({
   marketCode: e,
   locale: s,
   collectionId: i,
   categoryId: l,
   page: t = 1,
-  size: n = 20,
-  skip: c = 0
+  size: o = 20,
+  skip: a = 0
 } = {}) => {
-  const a = w(t, n, c);
+  const c = E(t, o, a);
   if (i) {
-    const D = (await r.client.getEntries(
+    const P = (await r.client.getEntries(
       {
         content_type: "blogCollection",
         "sys.id": i,
@@ -216,31 +216,31 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
       },
       { resolveLinks: !1 }
     )).items.at(0);
-    if (!D)
-      throw C();
-    const v = (D.fields.posts ?? []).filter((y) => y.sys.linkType === "Entry").map((y) => y.sys.id), A = v.slice(a.params.skip, a.params.skip + a.size);
-    if (!A.length)
-      return new h({
-        page: a.page,
+    if (!P)
+      throw w();
+    const v = (P.fields.posts ?? []).filter((h) => h.sys.linkType === "Entry").map((h) => h.sys.id), z = v.slice(c.params.skip, c.params.skip + c.size);
+    if (!z.length)
+      return new u({
+        page: c.page,
         total: v.length,
-        size: a.size,
+        size: c.size,
         items: []
       });
-    const B = await r.client.getEntries(
+    const R = await r.client.getEntries(
       {
         content_type: "blogPost",
-        "sys.id[in]": A.join(","),
+        "sys.id[in]": z.join(","),
         select: I,
         include: 2,
-        limit: a.size
+        limit: c.size
       },
       { resolveLinks: !1 }
-    ), N = f(B), j = new Map(B.items.map((y) => [y.sys.id, y]));
-    return new h({
-      page: a.page,
+    ), V = g(R), W = new Map(R.items.map((h) => [h.sys.id, h]));
+    return new u({
+      page: c.page,
       total: v.length,
-      size: a.size,
-      items: A.map((y) => j.get(y)).filter((y) => y !== void 0).map((y) => L(y, N))
+      size: c.size,
+      items: z.map((h) => W.get(h)).filter((h) => h !== void 0).map((h) => b(h, V))
     });
   }
   const d = await r.client.getEntries(
@@ -250,374 +250,484 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
       select: I,
       include: 2,
       order: m,
-      ...a.params,
-      ...g(e),
-      ...p(s)
+      ...c.params,
+      ...p(e),
+      ...f(s)
     },
     { resolveLinks: !1 }
-  ), u = f(d);
-  return new h({
-    page: a.page,
+  ), y = g(d);
+  return new u({
+    page: c.page,
     total: d.total,
-    size: a.size,
-    items: d.items.map((k) => L(k, u))
+    size: c.size,
+    items: d.items.map((k) => b(k, y))
   });
-}, W = async ({
+}, oe = async ({
   id: e,
   slug: s,
   marketCode: i,
   locale: l
 }) => {
-  const t = z({ id: e, slug: s }), n = await r.client.getEntries(
+  const t = A({ id: e, slug: s }), o = await r.client.getEntries(
     {
       content_type: "blogPost",
       ...t,
       select: `${I},fields.author,fields.content,fields.seo`,
       include: 2,
       order: m,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
     },
     { resolveLinks: !1 }
-  ), c = n.items.at(0);
-  if (!c)
-    throw C();
-  const a = f(n);
+  ), a = o.items.at(0);
+  if (!a)
+    throw w();
+  const c = g(o);
   return {
-    ...L(c, a),
-    author: S(a.entry(c.fields.author), a),
-    content: T(c.fields.content, a),
-    seo: _(a.entry(c.fields.seo))
+    ...b(a, c),
+    author: S(c.entry(a.fields.author), c),
+    content: _(a.fields.content, c),
+    seo: L(c.entry(a.fields.seo))
   };
-}, M = "sys.id,fields.title,fields.slug,fields.featuredImage", x = (e, s) => ({
+}, O = "sys.id,fields.title,fields.slug,fields.featuredImage", M = (e, s) => ({
   sys: { id: e.sys.id },
-  title: o(e.fields.title),
-  slug: o(e.fields.slug),
-  featuredImage: E(s.asset(e.fields.featuredImage))
-}), X = async ({
+  title: n(e.fields.title),
+  slug: n(e.fields.slug),
+  featuredImage: C(s.asset(e.fields.featuredImage))
+}), ne = async ({
   marketCode: e,
   locale: s,
   page: i = 1,
   size: l = 20
 } = {}) => {
-  const t = w(i, l), n = await r.client.getEntries(
+  const t = E(i, l), o = await r.client.getEntries(
     {
       content_type: "blogCategory",
-      select: M,
+      select: O,
       include: 1,
       order: m,
       ...t.params,
-      ...g(e),
-      ...p(s)
+      ...p(e),
+      ...f(s)
     },
     { resolveLinks: !1 }
-  ), c = f(n);
-  return new h({
+  ), a = g(o);
+  return new u({
     page: t.page,
-    total: n.total,
+    total: o.total,
     size: t.size,
-    items: n.items.map((a) => x(a, c))
+    items: o.items.map((c) => M(c, a))
   });
-}, Z = async ({
+}, ae = async ({
   id: e,
   slug: s,
   marketCode: i,
   locale: l
 }) => {
-  const t = z({ id: e, slug: s }), n = await r.client.getEntries(
+  const t = A({ id: e, slug: s }), o = await r.client.getEntries(
     {
       content_type: "blogCategory",
       ...t,
-      select: `${M},fields.description,fields.seo`,
+      select: `${O},fields.description,fields.seo`,
       include: 1,
       order: m,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
     },
     { resolveLinks: !1 }
-  ), c = n.items.at(0);
-  if (!c)
-    throw C();
-  const a = f(n);
+  ), a = o.items.at(0);
+  if (!a)
+    throw w();
+  const c = g(o);
   return {
-    ...x(c, a),
-    description: o(c.fields.description),
-    seo: _(a.entry(c.fields.seo))
+    ...M(a, c),
+    description: n(a.fields.description),
+    seo: L(c.entry(a.fields.seo))
   };
-}, ee = async ({
+}, ce = async ({
   marketCode: e,
   locale: s,
   page: i = 1,
   size: l = 20
 } = {}) => {
-  const t = w(i, l), n = await r.client.getEntries(
+  const t = E(i, l), o = await r.client.getEntries(
     {
       content_type: "blogCollection",
       select: "sys.id,fields.name,fields.type,fields.order,fields.category,fields.featuredImage",
       include: 1,
       order: m,
       ...t.params,
-      ...g(e),
-      ...p(s)
+      ...p(e),
+      ...f(s)
     },
     { resolveLinks: !1 }
-  ), c = f(n), a = n.items.map((d) => {
-    const u = c.entry(d.fields.category);
+  ), a = g(o), c = o.items.map((d) => {
+    const y = a.entry(d.fields.category);
     return {
-      name: o(d.fields.name),
-      type: o(d.fields.type),
-      order: o(d.fields.order),
+      name: n(d.fields.name),
+      type: n(d.fields.type),
+      order: n(d.fields.order),
       sys: { id: d.sys.id },
-      category: u ? {
-        sys: { id: u.sys.id },
-        title: o(u.fields.title),
-        slug: o(u.fields.slug)
+      category: y ? {
+        sys: { id: y.sys.id },
+        title: n(y.fields.title),
+        slug: n(y.fields.slug)
       } : null,
-      featuredImage: E(c.asset(d.fields.featuredImage))
+      featuredImage: C(a.asset(d.fields.featuredImage))
     };
   });
-  return new h({
+  return new u({
     page: t.page,
-    total: n.total,
+    total: o.total,
     size: t.size,
-    items: a.map((d) => ({
+    items: c.map((d) => ({
       ...d,
       category: d.type === "category" ? d.category : null,
       categoryId: d.type === "category" ? d.category?.sys.id ?? null : null,
       collectionId: d.type === "manual" ? d.sys.id : null
     }))
   });
-}, se = async ({
+}, de = async ({
   page: e = 1,
   size: s = 20,
   marketCode: i,
   locale: l
 } = {}) => {
-  const t = w(e, s), n = await r.client.getEntries(
+  const t = E(e, s), o = await r.client.getEntries(
     {
       content_type: "brandCollection",
       select: "sys.id,fields.name,fields.slot,fields.brands",
       include: 2,
       order: m,
       ...t.params,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
     },
     { resolveLinks: !1 }
-  ), c = f(n);
-  return new h({
+  ), a = g(o);
+  return new u({
     page: t.page,
-    total: n.total,
+    total: o.total,
     size: t.size,
-    items: n.items.map(
-      (a) => ({
-        sys: { id: a.sys.id },
-        name: o(a.fields.name),
-        slot: o(a.fields.slot),
+    items: o.items.map(
+      (c) => ({
+        sys: { id: c.sys.id },
+        name: n(c.fields.name),
+        slot: n(c.fields.slot),
         brandsCollection: {
-          items: c.entries(a.fields.brands).map((d) => ({
+          items: a.entries(c.fields.brands).map((d) => ({
             sys: { id: d.sys.id },
-            name: o(d.fields.name),
-            logo: E(c.asset(d.fields.logo)),
-            hyperlink: b(
-              c.entry(d.fields.hyperlink)
+            name: n(d.fields.name),
+            logo: C(a.asset(d.fields.logo)),
+            hyperlink: D(
+              a.entry(d.fields.hyperlink)
             )
           }))
         }
       })
     )
   });
-}, F = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.description,fields.order,fields.seo", O = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.author,fields.category", $ = (e) => ({
+}, x = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.description,fields.order,fields.seo", F = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.author,fields.category", N = (e) => ({
   id: e.sys.id,
   createdAt: e.sys.createdAt,
   updatedAt: e.sys.updatedAt
-}), H = (e, s) => ({
-  sys: $(e),
-  title: o(e.fields.title),
-  slug: o(e.fields.slug),
-  description: o(e.fields.description),
-  order: o(e.fields.order),
-  seo: _(s.entry(e.fields.seo))
-}), K = (e, s) => {
+}), $ = (e, s) => ({
+  sys: N(e),
+  title: n(e.fields.title),
+  slug: n(e.fields.slug),
+  description: n(e.fields.description),
+  order: n(e.fields.order),
+  seo: L(s.entry(e.fields.seo))
+}), Y = (e, s) => {
   const i = s.entry(e.fields.category);
   return {
-    sys: $(e),
-    title: o(e.fields.title),
-    slug: o(e.fields.slug),
+    sys: N(e),
+    title: n(e.fields.title),
+    slug: n(e.fields.slug),
     author: S(s.entry(e.fields.author), s),
     category: i ? {
-      title: o(i.fields.title),
-      slug: o(i.fields.slug),
-      description: o(i.fields.description),
-      order: o(i.fields.order)
+      title: n(i.fields.title),
+      slug: n(i.fields.slug),
+      description: n(i.fields.description),
+      order: n(i.fields.order)
     } : null
   };
-}, te = async ({
+}, re = async ({
   marketCode: e,
   locale: s,
   page: i = 1,
   size: l = 20
 } = {}) => {
-  const t = w(i, l), n = await r.client.getEntries(
+  const t = E(i, l), o = await r.client.getEntries(
     {
       content_type: "documentationCategory",
-      select: F,
+      select: x,
       include: 1,
       order: m,
       ...t.params,
-      ...g(e),
-      ...p(s)
+      ...p(e),
+      ...f(s)
     },
     { resolveLinks: !1 }
-  ), c = f(n);
-  return new h({
+  ), a = g(o);
+  return new u({
     page: t.page,
-    total: n.total,
+    total: o.total,
     size: t.size,
-    items: n.items.map((a) => H(a, c))
+    items: o.items.map((c) => $(c, a))
   });
-}, ie = async ({
+}, fe = async ({
   id: e,
   slug: s,
   marketCode: i,
   locale: l
 }) => {
-  const t = z({ id: e, slug: s }), n = await r.client.getEntries(
+  const t = A({ id: e, slug: s }), o = await r.client.getEntries(
     {
       content_type: "documentationCategory",
       ...t,
-      select: F,
+      select: x,
       include: 1,
       order: m,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
     },
     { resolveLinks: !1 }
-  ), c = n.items.at(0);
-  if (!c)
-    throw C();
-  return H(c, f(n));
-}, le = async ({
+  ), a = o.items.at(0);
+  if (!a)
+    throw w();
+  return $(a, g(o));
+}, ge = async ({
   marketCode: e,
   locale: s,
   categorySlug: i,
   page: l = 1,
   size: t = 20
 } = {}) => {
-  const n = w(l, t), c = await r.client.getEntries(
+  const o = E(l, t), a = await r.client.getEntries(
     {
       content_type: "documentationArticle",
       ...i ? {
         "fields.category.sys.contentType.sys.id": "documentationCategory",
         "fields.category.fields.slug": i
       } : {},
-      select: O,
+      select: F,
       include: 2,
       order: m,
-      ...n.params,
-      ...g(e),
-      ...p(s)
+      ...o.params,
+      ...p(e),
+      ...f(s)
     },
     { resolveLinks: !1 }
-  ), a = f(c);
-  return new h({
-    page: n.page,
-    total: c.total,
-    size: n.size,
-    items: c.items.map((d) => K(d, a))
+  ), c = g(a);
+  return new u({
+    page: o.page,
+    total: a.total,
+    size: o.size,
+    items: a.items.map((d) => Y(d, c))
   });
-}, oe = async ({
+}, pe = async ({
   id: e,
   slug: s,
   marketCode: i,
   locale: l
 }) => {
-  const t = z({ id: e, slug: s }), n = await r.client.getEntries(
+  const t = A({ id: e, slug: s }), o = await r.client.getEntries(
     {
       content_type: "documentationArticle",
       ...t,
-      select: `${O},fields.content,fields.seo`,
+      select: `${F},fields.content,fields.seo`,
       include: 2,
       order: m,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
+    },
+    { resolveLinks: !1 }
+  ), a = o.items.at(0);
+  if (!a)
+    throw w();
+  const c = g(o);
+  return {
+    ...Y(a, c),
+    content: _(a.fields.content, c),
+    seo: L(c.entry(a.fields.seo))
+  };
+}, G = "crispHelpCategory", K = "crispHelpArticle", T = "fields.position,sys.id", j = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.path,fields.locale,fields.position,fields.parent", U = "sys.id,sys.createdAt,sys.updatedAt,fields.title,fields.slug,fields.path,fields.locale,fields.position,fields.featured,fields.category", q = (e) => ({
+  id: e.sys.id,
+  createdAt: e.sys.createdAt,
+  updatedAt: e.sys.updatedAt
+}), J = (e) => ({
+  sys: q(e),
+  title: n(e.fields.title),
+  slug: n(e.fields.slug),
+  path: n(e.fields.path),
+  locale: n(e.fields.locale),
+  position: n(e.fields.position),
+  parentId: e.fields.parent?.sys.id ?? null
+}), Q = (e) => ({
+  sys: q(e),
+  title: n(e.fields.title),
+  slug: n(e.fields.slug),
+  path: n(e.fields.path),
+  locale: n(e.fields.locale),
+  position: n(e.fields.position),
+  featured: e.fields.featured === !0,
+  categoryId: e.fields.category?.sys.id ?? null
+}), ue = async ({
+  locale: e,
+  page: s = 1,
+  size: i = 20
+} = {}) => {
+  const l = E(s, i), t = await r.client.getEntries(
+    {
+      content_type: G,
+      select: j,
+      include: 0,
+      order: T,
+      ...l.params,
+      ...f(e)
+    },
+    { resolveLinks: !1 }
+  );
+  return new u({
+    page: l.page,
+    total: t.total,
+    size: l.size,
+    items: t.items.map(J)
+  });
+}, me = async ({
+  id: e,
+  slug: s,
+  locale: i
+}) => {
+  const l = A({ id: e, slug: s }), o = (await r.client.getEntries(
+    {
+      content_type: G,
+      ...l,
+      select: j,
+      include: 0,
+      order: T,
+      ...f(i)
+    },
+    { resolveLinks: !1 }
+  )).items.at(0);
+  if (!o)
+    throw w();
+  return J(o);
+}, ye = async ({
+  locale: e,
+  categoryId: s,
+  featured: i,
+  page: l = 1,
+  size: t = 20
+} = {}) => {
+  const o = E(l, t), a = await r.client.getEntries(
+    {
+      content_type: K,
+      ...s ? { "fields.category.sys.id": s } : {},
+      ...i !== void 0 ? { "fields.featured": i } : {},
+      select: U,
+      include: 0,
+      order: T,
+      ...o.params,
+      ...f(e)
+    },
+    { resolveLinks: !1 }
+  );
+  return new u({
+    page: o.page,
+    total: a.total,
+    size: o.size,
+    items: a.items.map(Q)
+  });
+}, he = async ({
+  id: e,
+  slug: s,
+  locale: i
+}) => {
+  const l = A({ id: e, slug: s }), t = await r.client.getEntries(
+    {
+      content_type: K,
+      ...l,
+      select: `${U},fields.body`,
+      include: 1,
+      order: T,
+      ...f(i)
     },
     { resolveLinks: !1 }
-  ), c = n.items.at(0);
-  if (!c)
-    throw C();
-  const a = f(n);
+  ), o = t.items.at(0);
+  if (!o)
+    throw w();
   return {
-    ...K(c, a),
-    content: T(c.fields.content, a),
-    seo: _(a.entry(c.fields.seo))
+    ...Q(o),
+    body: _(o.fields.body, g(t))
   };
-}, ne = async ({
+}, Ee = async ({
   page: e = 1,
   size: s = 20,
   marketCode: i,
   locale: l
 } = {}) => {
-  const t = w(e, s), n = await r.client.getEntries(
+  const t = E(e, s), o = await r.client.getEntries(
     {
       content_type: "hyperlinkCollection",
       select: "sys.id,fields.name,fields.slot,fields.order,fields.links",
       include: 1,
       order: "fields.order",
       ...t.params,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
     },
     { resolveLinks: !1 }
-  ), c = f(n);
-  return new h({
+  ), a = g(o);
+  return new u({
     page: t.page,
-    total: n.total,
+    total: o.total,
     size: t.size,
-    items: n.items.map(
-      (a) => ({
-        sys: { id: a.sys.id },
-        name: o(a.fields.name),
-        slot: o(a.fields.slot),
-        order: o(a.fields.order),
+    items: o.items.map(
+      (c) => ({
+        sys: { id: c.sys.id },
+        name: n(c.fields.name),
+        slot: n(c.fields.slot),
+        order: n(c.fields.order),
         linksCollection: {
-          items: c.entries(a.fields.links).map((d) => b(d))
+          items: a.entries(c.fields.links).map((d) => D(d))
         }
       })
     )
   });
-}, ae = async ({
+}, we = async ({
   page: e = 1,
   size: s = 20,
   marketCode: i,
   locale: l
 } = {}) => {
-  const t = w(e, s), n = await r.client.getEntries(
+  const t = E(e, s), o = await r.client.getEntries(
     {
       content_type: "keywordCollection",
       select: "sys.id,fields.name,fields.slot,fields.keywords",
       include: 0,
       order: m,
       ...t.params,
-      ...g(i),
-      ...p(l)
+      ...p(i),
+      ...f(l)
     },
     { resolveLinks: !1 }
   );
-  return new h({
+  return new u({
     page: t.page,
-    total: n.total,
+    total: o.total,
     size: t.size,
-    items: n.items.map(
-      (c) => ({
-        sys: { id: c.sys.id },
-        name: o(c.fields.name),
-        slot: o(c.fields.slot),
-        keywords: o(c.fields.keywords)
+    items: o.items.map(
+      (a) => ({
+        sys: { id: a.sys.id },
+        name: n(a.fields.name),
+        slot: n(a.fields.slot),
+        keywords: n(a.fields.keywords)
       })
     )
   });
-}, ce = async ({
+}, ke = async ({
   marketCode: e,
   locale: s
 } = {}) => {
@@ -628,35 +738,39 @@ const m = "-sys.updatedAt", g = (e) => e ? P("market", [
       include: 1,
       order: m,
       limit: 1,
-      ...g(e),
-      ...p(s)
+      ...p(e),
+      ...f(s)
     },
     { resolveLinks: !1 }
   ), l = i.items.at(0);
   if (!l)
-    throw C();
+    throw w();
   return {
     sys: { id: l.sys.id },
-    title: o(l.fields.title),
-    locale: o(l.fields.locale),
-    content: T(l.fields.content, f(i))
+    title: n(l.fields.title),
+    locale: n(l.fields.locale),
+    content: _(l.fields.content, g(i))
   };
 };
 export {
   r as ContentfulSDK,
-  h as PaginatedResponse,
-  Q as getBannerCollections,
-  X as getBlogCategories,
-  Z as getBlogCategoryDetail,
-  ee as getBlogCollections,
-  W as getBlogPostDetail,
-  V as getBlogPosts,
-  se as getBrandCollections,
-  oe as getDocArticleDetail,
-  le as getDocArticles,
-  te as getDocCategories,
-  ie as getDocCategoryDetail,
-  ne as getHyperlinkCollections,
-  ae as getKeywordCollections,
-  ce as getPolicyAndTerms
+  u as PaginatedResponse,
+  ie as getBannerCollections,
+  ne as getBlogCategories,
+  ae as getBlogCategoryDetail,
+  ce as getBlogCollections,
+  oe as getBlogPostDetail,
+  le as getBlogPosts,
+  de as getBrandCollections,
+  pe as getDocArticleDetail,
+  ge as getDocArticles,
+  re as getDocCategories,
+  fe as getDocCategoryDetail,
+  he as getHelpArticleDetail,
+  ye as getHelpArticles,
+  ue as getHelpCategories,
+  me as getHelpCategoryDetail,
+  Ee as getHyperlinkCollections,
+  we as getKeywordCollections,
+  ke as getPolicyAndTerms
 };

package/dist/types/content-model.d.ts

@@ -82,6 +82,24 @@ export interface TypeDocumentationCategoryFields {
     seo?: Link<"Entry">;
     markets?: Link<"Entry">[];
 }
+export interface TypeHelpArticleFields {
+    title: string;
+    slug: string;
+    path: string;
+    locale?: string;
+    position?: number;
+    featured?: boolean;
+    category?: Link<"Entry">;
+    body?: Document;
+}
+export interface TypeHelpCategoryFields {
+    title: string;
+    slug: string;
+    path: string;
+    locale?: string;
+    position?: number;
+    parent?: Link<"Entry">;
+}
 export interface TypeHyperlinkFields {
     label: string;
     url: string;

package/dist/utils/index.d.ts

@@ -11,3 +11,4 @@ export declare class PaginatedResponse<T> {
         items: T[];
     });
 }
+export type { RichText } from './resolve';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janbox/contentful-marketplace-sdk",
-  "version": "4.0.0-alpha.0",
+  "version": "4.0.0-alpha.2",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",