@janbox/contentful-marketplace-sdk 0.0.2 → 0.0.4

package/README.md

@@ -0,0 +1,363 @@
+# iChiba Contentful SDK
+
+A TypeScript SDK for accessing iChiba marketplace content from Contentful CMS. This SDK provides type-safe methods to retrieve banners, blog posts, documentation articles, and other content types with market and language filtering support.
+
+## Features
+
+- 🔒 **Type-safe**: Full TypeScript support with auto-generated types from Contentful schemas
+- 🌐 **Multi-market**: Built-in filtering by market and language
+- 📝 **Content Types**: Support for banners, blog posts, documentation, and more
+- 🚀 **Easy to use**: Simple API with intuitive method names
+- 🎯 **Selective queries**: Optimized queries with field selection
+- ⚡ **Performance**: Built on top of the official Contentful SDK
+
+## Installation
+
+```bash
+# Using npm
+npm install @janbox/contentful-marketplace-sdk
+
+# Using yarn
+yarn add @janbox/contentful-marketplace-sdk
+
+# Using pnpm
+pnpm add @janbox/contentful-marketplace-sdk
+```
+
+## Quick Start
+
+### 1. Configure the SDK
+
+```typescript
+import { ContentfulSDK } from '@janbox/contentful-marketplace-sdk';
+
+// Initialize the SDK with your Contentful credentials
+ContentfulSDK.configure({
+  space: 'your-space-id',
+  accessToken: 'your-access-token',
+  environment: 'master', // optional, defaults to 'master'
+});
+```
+
+### 2. Fetch Content
+
+```typescript
+import { 
+  listBannerEntries, 
+  listBlogPostEntries, 
+  findBlogPostEntry,
+  listDocCategoryEntries,
+  listDocArticleEntries 
+} from '@janbox/contentful-marketplace-sdk';
+
+// Get banners for a specific market and language
+const banners = await listBannerEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.platform[in]': 'WEB',
+    limit: 10
+  }
+});
+
+// Get blog posts
+const blogPosts = await listBlogPostEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    order: '-sys.createdAt',
+    limit: 5
+  }
+});
+
+// Find a specific blog post by slug
+const blogPost = await findBlogPostEntry({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.slug': 'how-to-shop-online'
+  }
+});
+
+// Get documentation categories
+const docCategories = await listDocCategoryEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    order: 'fields.order'
+  }
+});
+```
+
+## Supported Content Types
+
+### 🎯 Banners
+- **Type**: `banner`
+- **Methods**: `listBannerEntries()`
+- **Fields**: name, image, redirectUrl, market, language, platform
+- **Platforms**: `MOBILE`, `WEB`
+
+### 📝 Blog Posts
+- **Type**: `blogPost`
+- **Methods**: `listBlogPostEntries()`, `findBlogPostEntry()`
+- **Fields**: title, slug, author, featuredImage, content, category, shortDescription, seo
+- **Features**: Related posts, categories, SEO metadata
+
+### 📚 Documentation
+- **Types**: `documentationCategory`, `documentationArticle`
+- **Methods**: `listDocCategoryEntries()`, `findDocCategoryEntry()`, `listDocArticleEntries()`, `findDocArticleEntry()`
+- **Features**: Hierarchical categories, searchable articles, SVG icons
+
+### 👤 Authors
+- **Type**: `author`
+- **Fields**: name, avatar
+
+### 🏷️ Categories
+- **Types**: `blogCategory`, `documentationCategory`
+- **Features**: SEO support, hierarchical organization
+
+### 🔍 SEO Metadata
+- **Type**: `seo`
+- **Fields**: metaTitle, metaDescription, metaKeywords, metaRobots
+
+## API Reference
+
+### Configuration
+
+#### `ContentfulSDK.configure(params)`
+
+Configure the SDK with Contentful credentials.
+
+```typescript
+ContentfulSDK.configure({
+  space: string,           // Your Contentful space ID
+  accessToken: string,     // Your Contentful access token
+  environment?: string,    // Environment (default: 'master')
+  host?: string,          // Custom host (optional)
+  // ... other Contentful client options
+});
+```
+
+### Banner Methods
+
+#### `listBannerEntries(options)`
+
+Retrieve multiple banner entries.
+
+```typescript
+const banners = await listBannerEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.platform[in]': 'WEB,MOBILE',
+    limit: 10,
+    order: '-sys.createdAt'
+  }
+});
+```
+
+### Blog Methods
+
+#### `listBlogPostEntries(options)`
+
+Retrieve multiple blog post entries with basic fields.
+
+```typescript
+const posts = await listBlogPostEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.category.sys.id': 'category-id',
+    limit: 10,
+    skip: 0
+  }
+});
+```
+
+#### `findBlogPostEntry(options)`
+
+Retrieve a single blog post with full content.
+
+```typescript
+const post = await findBlogPostEntry({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.slug': 'my-blog-post'
+  }
+});
+```
+
+### Documentation Methods
+
+#### `listDocCategoryEntries(options)`
+
+Retrieve documentation categories.
+
+```typescript
+const categories = await listDocCategoryEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    order: 'fields.order'
+  }
+});
+```
+
+#### `findDocCategoryEntry(options)`
+
+Find a specific documentation category.
+
+```typescript
+const category = await findDocCategoryEntry({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.slug': 'getting-started'
+  }
+});
+```
+
+#### `listDocArticleEntries(options)`
+
+Retrieve documentation articles.
+
+```typescript
+const articles = await listDocArticleEntries({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.category.sys.id': 'category-id',
+    order: '-sys.updatedAt'
+  }
+});
+```
+
+#### `findDocArticleEntry(options)`
+
+Find a specific documentation article.
+
+```typescript
+const article = await findDocArticleEntry({
+  marketId: 'vn',
+  language: 'vi',
+  query: {
+    'fields.slug': 'payment-methods'
+  }
+});
+```
+
+## Error Handling
+
+The SDK includes built-in error handling for common scenarios:
+
+```typescript
+import { NotFoundResponse } from '@janbox/contentful-marketplace-sdk';
+
+try {
+  const post = await findBlogPostEntry({
+    marketId: 'vn',
+    language: 'vi',
+    query: { 'fields.slug': 'non-existent-post' }
+  });
+} catch (error) {
+  if (error instanceof NotFoundResponse) {
+    console.log('Blog post not found');
+  }
+}
+```
+
+## Type Definitions
+
+The SDK exports comprehensive TypeScript types for all content:
+
+```typescript
+import type {
+  // Entry Types
+  BannerEntry,
+  BlogPostEntry,
+  DocCategoryEntry,
+  DocArticleEntry,
+  
+  // Skeleton Types
+  TypeBannerSkeleton,
+  TypeBlogPostSkeleton,
+  TypeDocumentationCategorySkeleton,
+  TypeDocumentationArticleSkeleton,
+  
+  // Field Types
+  TypeBannerFields,
+  TypeBlogPostFields,
+  // ... and many more
+} from '@janbox/contentful-marketplace-sdk';
+```
+
+## Query Options
+
+All list methods accept Contentful's standard query parameters:
+
+- `limit`: Number of entries to return (max 1000)
+- `skip`: Number of entries to skip
+- `order`: Sort order (e.g., '-sys.createdAt', 'fields.title')
+- `fields.*`: Filter by field values
+- `sys.*`: Filter by system properties
+- `include`: Include linked entries (0-10)
+- `select`: Choose specific fields to return
+
+## Development
+
+### Prerequisites
+
+- Node.js 18+
+- pnpm 8+
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/your-org/ichiba-contentful-sdk.git
+
+# Install dependencies
+pnpm install
+
+# Build the SDK
+pnpm build:packages
+```
+
+### Project Structure
+
+```
+ichiba-contentful-sdk/
+├── packages/
+│   └── marketplace-sdk/
+│       ├── src/
+│       │   ├── client/         # SDK client configuration
+│       │   ├── entries/        # Content type methods
+│       │   ├── http-responses/ # Custom error responses
+│       │   ├── types/          # TypeScript type definitions
+│       │   └── index.ts        # Main export file
+│       ├── dist/               # Built files
+│       └── package.json
+├── examples/                   # Usage examples
+└── package.json
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/amazing-feature`
+3. Commit your changes: `git commit -m 'Add amazing feature'`
+4. Push to the branch: `git push origin feature/amazing-feature`
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For questions and support, please contact the iChiba development team or create an issue in the repository.
+
+---
+
+**Built with ❤️ by the iChiba team**

package/dist/entries/banner.d.ts

@@ -1,5 +1,6 @@
 import { TypeBannerSkeleton } from '../types';
-import { EntriesQueries } from 'contentful';
+import { EntriesQueries, Entry } from 'contentful';
+export type BannerEntry = Entry<TypeBannerSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>;
 export declare const listBannerEntries: ({ query, marketId, language, }: {
     marketId: string;
     language: string;

package/dist/entries/blog.d.ts

@@ -0,0 +1,13 @@
+import { EntriesQueries, Entry } from 'contentful';
+import { TypeBlogPostSkeleton } from '../types';
+export type BlogPostEntry = Entry<TypeBlogPostSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>;
+export declare const listBlogPostEntries: ({ query, marketId, language, }: {
+    marketId: string;
+    language: string;
+    query?: Partial<EntriesQueries<TypeBlogPostSkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+}) => Promise<import('contentful').EntryCollection<TypeBlogPostSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;
+export declare const findBlogPostEntry: ({ query, marketId, language, }: {
+    marketId: string;
+    language: string;
+    query: Partial<EntriesQueries<TypeBlogPostSkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+}) => Promise<Entry<TypeBlogPostSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;

package/dist/entries/documentation.d.ts

@@ -0,0 +1,30 @@
+import { EntriesQueries, Entry } from 'contentful';
+import { TypeDocumentationArticleSkeleton, TypeDocumentationCategorySkeleton } from '../types';
+/**
+ * Documentation category entry
+ */
+export type DocCategoryEntry = Entry<TypeDocumentationCategorySkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>;
+export declare const listDocCategoryEntries: ({ query, marketId, language, }: {
+    query: Partial<EntriesQueries<TypeDocumentationCategorySkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+    marketId: string;
+    language: string;
+}) => Promise<import('contentful').EntryCollection<TypeDocumentationCategorySkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;
+export declare const findDocCategoryEntry: ({ query, marketId, language, }: {
+    query: Partial<EntriesQueries<TypeDocumentationCategorySkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+    marketId: string;
+    language: string;
+}) => Promise<Entry<TypeDocumentationCategorySkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;
+/**
+ * Documentation article entry
+ */
+export type DocArticleEntry = Entry<TypeDocumentationArticleSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>;
+export declare const listDocArticleEntries: ({ query, marketId, language, }: {
+    query: Partial<EntriesQueries<TypeDocumentationArticleSkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+    marketId: string;
+    language: string;
+}) => Promise<import('contentful').EntryCollection<TypeDocumentationArticleSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;
+export declare const findDocArticleEntry: ({ query, marketId, language, }: {
+    query: Partial<EntriesQueries<TypeDocumentationArticleSkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+    marketId: string;
+    language: string;
+}) => Promise<Entry<TypeDocumentationArticleSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;

package/dist/entries/footer-menu.d.ts

@@ -0,0 +1,7 @@
+import { EntriesQueries } from 'contentful';
+import { TypeFooterMenuSkeleton } from '../types';
+export declare const listFooterMenuEntries: ({ query, marketId, language, }: {
+    marketId: string;
+    language: string;
+    query?: Partial<EntriesQueries<TypeFooterMenuSkeleton, "WITHOUT_UNRESOLVABLE_LINKS">>;
+}) => Promise<import('contentful').EntryCollection<TypeFooterMenuSkeleton, "WITHOUT_UNRESOLVABLE_LINKS", string>>;

package/dist/entries/index.d.ts

@@ -1 +1,4 @@
 export * from './banner';
+export * from './blog';
+export * from './documentation';
+export * from './footer-menu';

package/dist/http-responses/index.d.ts

@@ -0,0 +1,3 @@
+export declare class NotFoundResponse extends Response {
+    constructor(...args: ConstructorParameters<typeof Response>);
+}

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("contentful");class n{static _client;static get client(){if(!this._client)throw new Error("Client is not initialized");return this._client}static configure(e){this._client=s.createClient(e)}}const l=async({query:t,marketId:e,language:i})=>n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":i,...t,content_type:"banner"});exports.ContentfulSDK=n;exports.listBannerEntries=l;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("contentful");class n{static _client;static get client(){if(!this._client)throw new Error("Client is not initialized");return this._client}static configure(e){this._client=o.createClient(e)}}const r=async({query:t,marketId:e,language:s})=>n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,...t,content_type:"banner"});class a extends Response{constructor(...e){super(e[0]??"Not Found",{status:404,...e[1]})}}const d=async({query:t,marketId:e,language:s})=>n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,select:["fields.title","fields.category","fields.slug","fields.featuredImage","fields.shortDescription"],content_type:"blogPost",...t}),c=async({query:t,marketId:e,language:s})=>{const i=await n.client.withoutUnresolvableLinks.getEntries({select:["fields.title","fields.category","fields.slug","fields.featuredImage","fields.shortDescription","fields.author","fields.content","fields.seo","sys.updatedAt"],"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,content_type:"blogPost",limit:1,...t}).then(l=>l.items.at(0));if(!i)throw new a;return i},y=async({query:t,marketId:e,language:s})=>n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,...t,content_type:"documentationCategory"}),f=async({query:t,marketId:e,language:s})=>{const i=await n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,...t,content_type:"documentationCategory",limit:1}).then(l=>l.items.at(0));if(!i)throw new a;return i},g=({query:t,marketId:e,language:s})=>n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,...t,content_type:"documentationArticle"}),u=async({query:t,marketId:e,language:s})=>{const i=await n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,...t,content_type:"documentationArticle",limit:1}).then(l=>l.items.at(0));if(!i)throw new a;return i},m=async({query:t,marketId:e,language:s})=>n.client.withoutUnresolvableLinks.getEntries({"fields.market.sys.contentType.sys.id":"market","fields.market.fields.marketId":e,"fields.language.sys.contentType.sys.id":"language","fields.language.fields.code":s,select:["fields.name","fields.children"],content_type:"footerMenu",...t});exports.ContentfulSDK=n;exports.findBlogPostEntry=c;exports.findDocArticleEntry=u;exports.findDocCategoryEntry=f;exports.listBannerEntries=r;exports.listBlogPostEntries=d;exports.listDocArticleEntries=g;exports.listDocCategoryEntries=y;exports.listFooterMenuEntries=m;

package/dist/index.js

@@ -1,5 +1,5 @@
-import { createClient as n } from "contentful";
-class s {
+import { createClient as o } from "contentful";
+class i {
   static _client;
   // static getter
   static get client() {
@@ -7,23 +7,163 @@ class s {
       throw new Error("Client is not initialized");
     return this._client;
   }
-  static configure(t) {
-    this._client = n(t);
+  static configure(e) {
+    this._client = o(e);
   }
 }
-const r = async ({
-  query: e,
-  marketId: t,
-  language: i
-}) => s.client.withoutUnresolvableLinks.getEntries({
-  "fields.market.sys.contentType.sys.id": "market",
-  "fields.market.fields.marketId": t,
-  "fields.language.sys.contentType.sys.id": "language",
-  "fields.language.fields.code": i,
-  ...e,
-  content_type: "banner"
-});
+const d = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => i.client.withoutUnresolvableLinks.getEntries(
+  {
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    ...t,
+    content_type: "banner"
+  }
+);
+class a extends Response {
+  constructor(...e) {
+    super(e[0] ?? "Not Found", {
+      status: 404,
+      ...e[1]
+    });
+  }
+}
+const c = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => i.client.withoutUnresolvableLinks.getEntries(
+  {
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    select: [
+      "fields.title",
+      "fields.category",
+      "fields.slug",
+      "fields.featuredImage",
+      "fields.shortDescription"
+    ],
+    content_type: "blogPost",
+    ...t
+  }
+), f = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => {
+  const n = await i.client.withoutUnresolvableLinks.getEntries({
+    select: [
+      "fields.title",
+      "fields.category",
+      "fields.slug",
+      "fields.featuredImage",
+      "fields.shortDescription",
+      "fields.author",
+      "fields.content",
+      "fields.seo",
+      "sys.updatedAt"
+    ],
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    content_type: "blogPost",
+    limit: 1,
+    ...t
+  }).then((l) => l.items.at(0));
+  if (!n)
+    throw new a();
+  return n;
+}, y = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => i.client.withoutUnresolvableLinks.getEntries(
+  {
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    ...t,
+    content_type: "documentationCategory"
+  }
+), g = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => {
+  const n = await i.client.withoutUnresolvableLinks.getEntries({
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    ...t,
+    content_type: "documentationCategory",
+    limit: 1
+  }).then((l) => l.items.at(0));
+  if (!n)
+    throw new a();
+  return n;
+}, u = ({
+  query: t,
+  marketId: e,
+  language: s
+}) => i.client.withoutUnresolvableLinks.getEntries(
+  {
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    ...t,
+    content_type: "documentationArticle"
+  }
+), m = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => {
+  const n = await i.client.withoutUnresolvableLinks.getEntries({
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    ...t,
+    content_type: "documentationArticle",
+    limit: 1
+  }).then((l) => l.items.at(0));
+  if (!n)
+    throw new a();
+  return n;
+}, k = async ({
+  query: t,
+  marketId: e,
+  language: s
+}) => i.client.withoutUnresolvableLinks.getEntries(
+  {
+    "fields.market.sys.contentType.sys.id": "market",
+    "fields.market.fields.marketId": e,
+    "fields.language.sys.contentType.sys.id": "language",
+    "fields.language.fields.code": s,
+    select: ["fields.name", "fields.children"],
+    content_type: "footerMenu",
+    ...t
+  }
+);
 export {
-  s as ContentfulSDK,
-  r as listBannerEntries
+  i as ContentfulSDK,
+  f as findBlogPostEntry,
+  m as findDocArticleEntry,
+  g as findDocCategoryEntry,
+  d as listBannerEntries,
+  c as listBlogPostEntries,
+  u as listDocArticleEntries,
+  y as listDocCategoryEntries,
+  k as listFooterMenuEntries
 };

package/dist/types/index.d.ts

@@ -71,6 +71,21 @@ export interface TypeDocumentationCategoryFields {
 }
 export type TypeDocumentationCategorySkeleton = EntrySkeletonType<TypeDocumentationCategoryFields, "documentationCategory">;
 export type TypeDocumentationCategory<Modifiers extends ChainModifiers, Locales extends LocaleCode = LocaleCode> = Entry<TypeDocumentationCategorySkeleton, Modifiers, Locales>;
+export interface TypeFooterMenuFields {
+    name: EntryFieldTypes.Symbol;
+    children: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<TypeHyperlinkSkeleton>>;
+    language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
+    market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
+}
+export type TypeFooterMenuSkeleton = EntrySkeletonType<TypeFooterMenuFields, "footerMenu">;
+export type TypeFooterMenu<Modifiers extends ChainModifiers, Locales extends LocaleCode = LocaleCode> = Entry<TypeFooterMenuSkeleton, Modifiers, Locales>;
+export interface TypeHyperlinkFields {
+    label: EntryFieldTypes.Symbol;
+    url: EntryFieldTypes.Symbol;
+    target: EntryFieldTypes.Symbol<"_blank" | "_self">;
+}
+export type TypeHyperlinkSkeleton = EntrySkeletonType<TypeHyperlinkFields, "hyperlink">;
+export type TypeHyperlink<Modifiers extends ChainModifiers, Locales extends LocaleCode = LocaleCode> = Entry<TypeHyperlinkSkeleton, Modifiers, Locales>;
 export interface TypeLanguageFields {
     name: EntryFieldTypes.Symbol;
     code: EntryFieldTypes.Symbol;
@@ -89,6 +104,15 @@ export interface TypeMarketFields {
 }
 export type TypeMarketSkeleton = EntrySkeletonType<TypeMarketFields, "market">;
 export type TypeMarket<Modifiers extends ChainModifiers, Locales extends LocaleCode = LocaleCode> = Entry<TypeMarketSkeleton, Modifiers, Locales>;
+export interface TypeNoticeFields {
+    title: EntryFieldTypes.Symbol;
+    content: EntryFieldTypes.RichText;
+    market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
+    language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
+    variant?: EntryFieldTypes.Array<EntryFieldTypes.Symbol<"Featured" | "Promotion" | "Urgent">>;
+}
+export type TypeNoticeSkeleton = EntrySkeletonType<TypeNoticeFields, "notice">;
+export type TypeNotice<Modifiers extends ChainModifiers, Locales extends LocaleCode = LocaleCode> = Entry<TypeNoticeSkeleton, Modifiers, Locales>;
 export interface TypeSeoFields {
     metaTitle: EntryFieldTypes.Symbol;
     metaDescription?: EntryFieldTypes.Text;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@janbox/contentful-marketplace-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist/**/*"
+    "dist/**/*",
+    "README.md"
   ],
   "exports": {
     ".": {
@@ -15,12 +16,15 @@
   },
   "type": "module",
   "sideEffects": false,
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "preview": "vite preview"
-  },
   "peerDependencies": {
     "contentful": ">=11"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -p tsconfig.build.json && vite build",
+    "preview": "vite preview",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest --coverage"
   }
-}
+}