@mybe/sdk 1.0.0

package/README.md

@@ -0,0 +1,364 @@
+# Mybe CMS SDK
+
+A TypeScript SDK for fetching content from Mybe CMS.
+
+## Installation
+
+```bash
+npm install @mybe/sdk
+```
+
+## Features
+
+- ✅ **Zero Dependencies** - Uses native fetch API
+- ✅ **TypeScript Support** - Full type safety with TypeScript
+- ✅ **Auto Environment Detection** - Automatically detects development vs production
+- ✅ **Error Handling** - Custom error classes for better error handling
+- ✅ **Pagination Support** - Built-in pagination for large datasets
+- ✅ **Status Filtering** - Filter content by status (draft, published, archived)
+- ✅ **Locale Filtering** - Filter content by locale for multi-language support
+
+## Quick Start
+
+```typescript
+import { MybeSDK } from '@mybe/sdk';
+
+// Initialize the SDK
+const sdk = new MybeSDK({
+  apiKey: 'your-api-key'
+});
+
+// Fetch a single content entry
+const content = await sdk.getContent('content-id');
+
+// Fetch content by type with filters
+const contentList = await sdk.getContentByType('content-type-id', {
+  status: 'published',
+  limit: 10
+});
+```
+
+## Configuration
+
+### Basic Configuration
+
+```typescript
+const sdk = new MybeSDK({
+  apiKey: 'your-api-key'
+});
+```
+
+The SDK automatically detects the environment:
+- **Development** (`NODE_ENV=development`): Uses `http://localhost:3001/api/v1`
+- **Production**: Uses `https://api.mybe.app/api/v1`
+
+### Custom Base URL (Optional)
+
+```typescript
+const sdk = new MybeSDK({
+  apiKey: 'your-api-key',
+  baseUrl: 'https://custom-api.example.com/api/v1'
+});
+```
+
+## API Reference
+
+### Content Models (Content Types)
+
+#### `getContentModels(projectId: string)`
+
+Get all content models for a project.
+
+```typescript
+const contentModels = await sdk.getContentModels('project-id');
+```
+
+**Returns:** `Promise<ContentType[]>`
+
+#### `getContentModel(contentTypeId: string)`
+
+Get a specific content model by ID.
+
+```typescript
+const contentModel = await sdk.getContentModel('content-type-id');
+```
+
+**Returns:** `Promise<ContentType>`
+
+### Content Entries
+
+#### `getContent(contentId: string)`
+
+Get a single content entry by ID.
+
+```typescript
+const content = await sdk.getContent('content-id');
+```
+
+**Returns:** `Promise<ContentEntry>`
+
+#### `getContentByType(contentTypeId: string, options?: ContentFilterOptions)`
+
+Get all content entries for a specific content type.
+
+```typescript
+const result = await sdk.getContentByType('content-type-id', {
+  status: 'published',
+  limit: 20,
+  lastKey: 'pagination-key' // For pagination
+});
+
+console.log(result.data); // Array of content entries
+console.log(result.pagination.hasMore); // Boolean
+console.log(result.pagination.lastEvaluatedKey); // For next page
+```
+
+**Options:**
+- `status?: 'draft' | 'published' | 'archived'` - Filter by status
+- `locale?: string` - Filter by locale (e.g., 'en-US', 'bn-BD', 'fr-FR', 'es-ES')
+- `limit?: number` - Number of items per page
+- `lastKey?: string` - Pagination key from previous response
+
+**Returns:** `Promise<ContentListResponse>`
+
+#### `getContentByProject(projectId: string, options?: ContentFilterOptions)`
+
+Get all content entries for a project.
+
+```typescript
+const result = await sdk.getContentByProject('project-id', {
+  status: 'published',
+  limit: 20
+});
+```
+
+**Options:**
+- `status?: 'draft' | 'published' | 'archived'` - Filter by status
+- `locale?: string` - Filter by locale (e.g., 'en-US', 'bn-BD', 'fr-FR', 'es-ES')
+- `limit?: number` - Number of items per page
+- `lastKey?: string` - Pagination key from previous response
+
+**Returns:** `Promise<ContentListResponse>`
+
+## Pagination Example
+
+```typescript
+let lastKey: string | undefined;
+let allContent: ContentEntry[] = [];
+
+do {
+  const result = await sdk.getContentByType('content-type-id', {
+    status: 'published',
+    limit: 50,
+    lastKey: lastKey ? JSON.stringify(result.pagination.lastEvaluatedKey) : undefined
+  });
+
+  allContent = [...allContent, ...result.data];
+  lastKey = result.pagination.hasMore 
+    ? JSON.stringify(result.pagination.lastEvaluatedKey) 
+    : undefined;
+
+} while (lastKey);
+
+console.log(`Fetched ${allContent.length} total items`);
+```
+
+## Error Handling
+
+The SDK provides custom error classes for better error handling:
+
+```typescript
+import { 
+  MybeSDK, 
+  NotFoundError, 
+  UnauthorizedError,
+  ValidationError,
+  ServerError 
+} from '@mybe/sdk';
+
+try {
+  const content = await sdk.getContent('content-id');
+} catch (error) {
+  if (error instanceof NotFoundError) {
+    console.error('Content not found');
+  } else if (error instanceof UnauthorizedError) {
+    console.error('Invalid API key');
+  } else if (error instanceof ValidationError) {
+    console.error('Validation error:', error.message);
+  } else if (error instanceof ServerError) {
+    console.error('Server error:', error.message);
+  } else {
+    console.error('Unknown error:', error);
+  }
+}
+```
+
+### Error Types
+
+- `MybeSDKError` - Base error class
+- `NotFoundError` - Resource not found (404)
+- `UnauthorizedError` - Invalid API key (401)
+- `ForbiddenError` - Insufficient permissions (403)
+- `ValidationError` - Validation failed (400)
+- `ServerError` - Internal server error (500)
+
+## TypeScript Types
+
+The SDK exports all TypeScript types for your convenience:
+
+```typescript
+import type {
+  ContentType,
+  ContentEntry,
+  ContentFilterOptions,
+  PaginationResponse,
+  APIResponse,
+  ContentListResponse
+} from '@mybe/sdk';
+```
+
+### ContentType
+
+```typescript
+interface ContentType {
+  id: string;
+  project_id: string;
+  name: string;
+  slug: string;
+  description?: string;
+  created_at: string;
+  updated_at: string;
+}
+```
+
+### ContentEntry
+
+```typescript
+interface ContentEntry {
+  id: string;
+  content_type_id: string;
+  project_id: string;
+  slug?: string;
+  status: 'draft' | 'published' | 'archived';
+  data: Record<string, any>;
+  locale?: string;
+  created_by: string;
+  updated_by?: string;
+  published_at?: string;
+  created_at: string;
+  updated_at: string;
+}
+```
+
+## Examples
+
+### Fetch Published Blog Posts
+
+```typescript
+const sdk = new MybeSDK({ apiKey: 'your-api-key' });
+
+const posts = await sdk.getContentByType('blog-post-type-id', {
+  status: 'published',
+  limit: 10
+});
+
+posts.data.forEach(post => {
+  console.log(post.data.title);
+  console.log(post.data.content);
+});
+```
+
+### Fetch All Content Models
+
+```typescript
+const contentModels = await sdk.getContentModels('project-id');
+
+contentModels.forEach(model => {
+  console.log(`${model.name} (${model.slug})`);
+});
+```
+
+### Fetch Single Content Entry
+
+```typescript
+const content = await sdk.getContent('content-entry-id');
+
+console.log(content.data); // Your content data
+console.log(content.status); // draft | published | archived
+```
+
+### Multi-locale Content
+
+Fetch content in different languages using the locale filter:
+
+```typescript
+const sdk = new MybeSDK({ apiKey: 'your-api-key' });
+
+// Fetch English content
+const englishPosts = await sdk.getContentByType('blog-post-type-id', {
+  status: 'published',
+  locale: 'en-US',
+  limit: 10
+});
+
+// Fetch Bangla content
+const banglaPosts = await sdk.getContentByType('blog-post-type-id', {
+  status: 'published',
+  locale: 'bn-BD',
+  limit: 10
+});
+
+// Fetch French content
+const frenchPosts = await sdk.getContentByType('blog-post-type-id', {
+  status: 'published',
+  locale: 'fr-FR',
+  limit: 10
+});
+
+// Fetch Spanish content
+const spanishPosts = await sdk.getContentByType('blog-post-type-id', {
+  status: 'published',
+  locale: 'es-ES',
+  limit: 10
+});
+```
+
+**Building a Multi-language Website:**
+
+```typescript
+// Get user's preferred language
+const userLocale = getUserPreferredLocale(); // e.g., 'bn-BD'
+
+// Fetch content in user's language
+const localizedContent = await sdk.getContentByType('content-type-id', {
+  status: 'published',
+  locale: userLocale,
+  limit: 20
+});
+
+// Display localized content
+localizedContent.data.forEach(item => {
+  console.log(item.data.title); // Title in user's language
+  console.log(item.metadata.locale); // e.g., 'bn-BD'
+});
+```
+
+**Supported Locales:**
+- `en-US` - English (United States)
+- `bn-BD` - Bangla (Bangladesh)
+- `fr-FR` - French (France)
+- `es-ES` - Spanish (Spain)
+- Custom locales as configured in your CMS
+
+## Requirements
+
+- Node.js 18+ (for native fetch support)
+- TypeScript 5.0+ (for development)
+
+## License
+
+MIT
+
+## Support
+
+For issues and questions, please visit the [GitHub repository](https://github.com/MyBeeInovationLabs/mybe-cms).

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@mybe/sdk",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "npm run build && npx tsx test.ts",
+    "prepublishOnly": "npm run build",
+    "prepack": "npm run build"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.9.2"
+  }
+}