@janbox/contentful-marketplace-sdk 0.0.1 → 0.0.3

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/index.d.ts

@@ -1 +1,3 @@
 export * from './banner';
+export * from './blog';
+export * from './documentation';

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 i{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})=>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 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,select:["fields.title","fields.category","fields.slug","fields.featuredImage","fields.shortDescription"],content_type:"blogPost",...t}),c=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"}),f=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},g=({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"}),u=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};exports.ContentfulSDK=i;exports.findBlogPostEntry=c;exports.findDocArticleEntry=u;exports.findDocCategoryEntry=f;exports.listBannerEntries=r;exports.listBlogPostEntries=d;exports.listDocArticleEntries=g;exports.listDocCategoryEntries=y;

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,148 @@ 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
+  }
+), y = 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;
+}, f = 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;
+};
 export {
-  s as ContentfulSDK,
-  r as listBannerEntries
+  i as ContentfulSDK,
+  y as findBlogPostEntry,
+  m as findDocArticleEntry,
+  g as findDocCategoryEntry,
+  d as listBannerEntries,
+  c as listBlogPostEntries,
+  u as listDocArticleEntries,
+  f as listDocCategoryEntries
 };

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@janbox/contentful-marketplace-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "README.md"
+  ],
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -12,12 +16,12 @@
   },
   "type": "module",
   "sideEffects": false,
+  "peerDependencies": {
+    "contentful": ">=11"
+  },
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
     "preview": "vite preview"
-  },
-  "peerDependencies": {
-    "contentful": ">=11"
   }
-}
+}

package/src/client/index.ts

@@ -1,22 +0,0 @@
-import {
-  type ContentfulClientApi,
-  createClient,
-  type CreateClientParams,
-} from "contentful";
-
-export class ContentfulSDK {
-  private static _client: ContentfulClientApi<undefined> | undefined;
-
-  // static getter
-
-  static get client() {
-    if (!this._client) {
-      throw new Error("Client is not initialized");
-    }
-    return this._client;
-  }
-
-  static configure(params: CreateClientParams) {
-    this._client = createClient(params);
-  }
-}

package/src/entries/banner.ts

@@ -1,23 +0,0 @@
-import { ContentfulSDK } from "@/client";
-import type { TypeBannerSkeleton } from "@/types";
-import type { EntriesQueries } from "contentful";
-
-export const listBannerEntries = async ({
-  query,
-  marketId,
-  language,
-}: {
-  marketId: string;
-  language: string;
-  query?: Partial<EntriesQueries<TypeBannerSkeleton, 'WITHOUT_UNRESOLVABLE_LINKS'>>;
-}) => {
-  return ContentfulSDK.client.withoutUnresolvableLinks.getEntries<TypeBannerSkeleton>({
-    'fields.market.sys.contentType.sys.id': 'market',
-    'fields.market.fields.marketId': marketId,
-    'fields.language.sys.contentType.sys.id': 'language',
-    'fields.language.fields.code': language,
-    ...query,
-    content_type: 'banner',
-  });
-};
-

package/src/entries/index.ts

@@ -1 +0,0 @@
-export * from "./banner";

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from "./client";
-export * from "./entries";
-export * from "./types";

package/src/types/index.ts

@@ -1,177 +0,0 @@
-import type {
-  ChainModifiers,
-  Entry,
-  EntryFieldTypes,
-  EntrySkeletonType,
-  LocaleCode,
-} from "contentful";
-
-export interface TypeAuthorFields {
-  name: EntryFieldTypes.Symbol;
-  avatar?: EntryFieldTypes.AssetLink;
-}
-
-export type TypeAuthorSkeleton = EntrySkeletonType<TypeAuthorFields, "author">;
-export type TypeAuthor<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeAuthorSkeleton, Modifiers, Locales>;
-
-export interface TypeBannerFields {
-  name: EntryFieldTypes.Symbol;
-  image: EntryFieldTypes.AssetLink;
-  redirectUrl?: EntryFieldTypes.Symbol;
-  market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
-  language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
-  platform: EntryFieldTypes.Array<EntryFieldTypes.Symbol<"MOBILE" | "WEB">>;
-}
-
-export type TypeBannerSkeleton = EntrySkeletonType<TypeBannerFields, "banner">;
-export type TypeBanner<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeBannerSkeleton, Modifiers, Locales>;
-
-export interface TypeBlogCategoryFields {
-  title: EntryFieldTypes.Symbol;
-  slug: EntryFieldTypes.Symbol;
-  description?: EntryFieldTypes.RichText;
-  publishedDate?: EntryFieldTypes.Date;
-  market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
-  language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
-  seo?: EntryFieldTypes.EntryLink<TypeSeoSkeleton>;
-}
-
-export type TypeBlogCategorySkeleton = EntrySkeletonType<
-  TypeBlogCategoryFields,
-  "blogCategory"
->;
-export type TypeBlogCategory<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeBlogCategorySkeleton, Modifiers, Locales>;
-
-export interface TypeBlogPostFields {
-  title: EntryFieldTypes.Symbol;
-  shortDescription?: EntryFieldTypes.Text;
-  slug: EntryFieldTypes.Symbol;
-  author?: EntryFieldTypes.EntryLink<TypeAuthorSkeleton>;
-  featuredImage: EntryFieldTypes.AssetLink;
-  content: EntryFieldTypes.RichText;
-  relatedBlogPosts?: EntryFieldTypes.Array<
-    EntryFieldTypes.EntryLink<TypeBlogPostSkeleton>
-  >;
-  category?: EntryFieldTypes.EntryLink<TypeBlogCategorySkeleton>;
-  market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
-  language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
-  seo?: EntryFieldTypes.EntryLink<TypeSeoSkeleton>;
-}
-
-export type TypeBlogPostSkeleton = EntrySkeletonType<
-  TypeBlogPostFields,
-  "blogPost"
->;
-export type TypeBlogPost<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeBlogPostSkeleton, Modifiers, Locales>;
-
-export interface TypeComponentSvgFields {
-  name: EntryFieldTypes.Symbol;
-  source: EntryFieldTypes.Text;
-}
-
-export type TypeComponentSvgSkeleton = EntrySkeletonType<
-  TypeComponentSvgFields,
-  "componentSvg"
->;
-export type TypeComponentSvg<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeComponentSvgSkeleton, Modifiers, Locales>;
-
-export interface TypeDocumentationArticleFields {
-  title: EntryFieldTypes.Symbol;
-  slug: EntryFieldTypes.Symbol;
-  content: EntryFieldTypes.RichText;
-  author?: EntryFieldTypes.EntryLink<TypeAuthorSkeleton>;
-  category?: EntryFieldTypes.EntryLink<TypeDocumentationCategorySkeleton>;
-  market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
-  language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
-  seo?: EntryFieldTypes.EntryLink<TypeSeoSkeleton>;
-}
-
-export type TypeDocumentationArticleSkeleton = EntrySkeletonType<
-  TypeDocumentationArticleFields,
-  "documentationArticle"
->;
-export type TypeDocumentationArticle<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeDocumentationArticleSkeleton, Modifiers, Locales>;
-
-export interface TypeDocumentationCategoryFields {
-  title: EntryFieldTypes.Symbol;
-  slug: EntryFieldTypes.Symbol;
-  description?: EntryFieldTypes.Symbol;
-  order?: EntryFieldTypes.Integer;
-  icon?: EntryFieldTypes.EntryLink<TypeComponentSvgSkeleton>;
-  market: EntryFieldTypes.EntryLink<TypeMarketSkeleton>;
-  language: EntryFieldTypes.EntryLink<TypeLanguageSkeleton>;
-  seo?: EntryFieldTypes.EntryLink<TypeSeoSkeleton>;
-}
-
-export type TypeDocumentationCategorySkeleton = EntrySkeletonType<
-  TypeDocumentationCategoryFields,
-  "documentationCategory"
->;
-export type TypeDocumentationCategory<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeDocumentationCategorySkeleton, Modifiers, Locales>;
-
-export interface TypeLanguageFields {
-  name: EntryFieldTypes.Symbol;
-  code: EntryFieldTypes.Symbol;
-}
-
-export type TypeLanguageSkeleton = EntrySkeletonType<
-  TypeLanguageFields,
-  "language"
->;
-export type TypeLanguage<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeLanguageSkeleton, Modifiers, Locales>;
-
-export interface TypeMarketFields {
-  marketId: EntryFieldTypes.Symbol;
-  marketName: EntryFieldTypes.Symbol;
-  description?: EntryFieldTypes.Text;
-  isPrimary?: EntryFieldTypes.Boolean;
-  currency?: EntryFieldTypes.Symbol;
-  status?: EntryFieldTypes.Number;
-  isDeleted?: EntryFieldTypes.Boolean;
-  createdAt?: EntryFieldTypes.Date;
-}
-
-export type TypeMarketSkeleton = EntrySkeletonType<TypeMarketFields, "market">;
-export type TypeMarket<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeMarketSkeleton, Modifiers, Locales>;
-
-export interface TypeSeoFields {
-  metaTitle: EntryFieldTypes.Symbol;
-  metaDescription?: EntryFieldTypes.Text;
-  metaKeywords?: EntryFieldTypes.Array<EntryFieldTypes.Symbol>;
-  metaRobots?: EntryFieldTypes.Array<
-    EntryFieldTypes.Symbol<"follow" | "index" | "nofollow" | "noindex">
-  >;
-}
-
-export type TypeSeoSkeleton = EntrySkeletonType<TypeSeoFields, "seo">;
-export type TypeSeo<
-  Modifiers extends ChainModifiers,
-  Locales extends LocaleCode = LocaleCode
-> = Entry<TypeSeoSkeleton, Modifiers, Locales>;

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": ["ES2022", "DOM", "DOM.Iterable"],
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "moduleDetection": "force",
-    "noEmit": true,
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "erasableSyntaxOnly": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true,
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  },
-  "include": ["src"]
-}

package/vite.config.ts

@@ -1,23 +0,0 @@
-import { defineConfig } from "vite";
-import { dirname, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import dts from "vite-plugin-dts";
-import tsconfigPaths from "vite-tsconfig-paths";
-import { peerDependencies } from "./package.json";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  build: {
-    lib: {
-      formats: ["cjs", "es"],
-      entry: resolve(__dirname, "src/index.ts"),
-      fileName: "index",
-    },
-    rollupOptions: {
-      external: Object.keys(peerDependencies),
-    },
-  },
-  plugins: [dts(), tsconfigPaths()],
-});