@30nama/sdk 2.0.0-rc.37 → 2.0.0-rc.39

package/README.md

@@ -1,312 +1,312 @@
-# 30nama SDK
-
-Official TypeScript SDK for interacting with the 30nama platform's microservices.
-
-## Features
-
-- 🎯 **Unified API** - Single SDK for all 30nama user microservices
-- 📱 **Frontend-First** - Designed specifically for frontend applications
-- 🛡️ **Type-Safe** - Full TypeScript support with auto-generated types (synced with the API)
-- 🔄 **Auto-Retry** - Built-in retry logic for network failures (configurable)
-- 🐛 **Debug Mode** - Comprehensive logging for development
-- 🌍 **Multi-Environment** - Support for development, staging, and production
-- 🔐 **Simple Auth** - Ultra-simple callback-based authentication
-
-## Services Included
-
-- **VideoContent** - Handles video content management operations
-- **VideoData** - Handles video metadata and content access
-- **Stream** - Handles video streaming operations including link generation and streaming
-- **Operator** - Handles user authentication, profile management, and user operations
-- **Comment** - Handles user comments and questions on video content, biography, and news
-- **Biography** - Handles user and celebrity profiles
-- **News** - Handles news and articles management with SEO and search capabilities
-- **Supporter** - Handles user support, accessibility management, and system content viewing
-- **Notification** - Handles user notifications and settings
-
-## Installation
-
-```bash
-npm install @30nama/sdk
-# or
-yarn add @30nama/sdk
-# or
-pnpm add @30nama/sdk
-```
-
-## Quick Start
-
-```typescript
-import { ThirtyNamaSDK } from '@30nama/sdk'
-
-// Initialize the SDK
-const sdk = new ThirtyNamaSDK({
-  environment: 'production',
-  debug: true
-})
-
-// Set up authentication with callback
-sdk.setTokenStorageCallback(() => {
-  return localStorage.getItem('access_token')
-})
-
-// Use the services
-const videos = await sdk.videoContent.getUserContents({
-  limit: 10,
-  order_by: 'newest'
-})
-
-const streamLink = await sdk.stream.generateStreamLink({
-  video_content_id: 123
-})
-
-const comments = await sdk.comment.getComments({
-  content_id: 123,
-  content_type: 'VIDEO'
-})
-```
-
-## Configuration
-
-### SDK Configuration Options
-
-```typescript
-interface SDKConfig {
-  environment: 'staging' | 'production'
-  debug?: boolean
-  timeout?: number
-  retries?: number
-}
-```
-
-## Authentication
-
-The SDK uses a simple callback-based authentication system. You provide a function that returns the authentication token when needed.
-
-### Token Callback Authentication
-
-```typescript
-// Set up dynamic token retrieval
-sdk.setTokenStorageCallback(() => {
-  // Return token from your preferred storage
-  return localStorage.getItem('userToken')
-})
-
-// For async token retrieval
-sdk.setTokenStorageCallback(async () => {
-  // Return token from async source
-  return await getTokenFromSecureStorage()
-})
-
-// Clear authentication
-sdk.clearTokens()
-```
-
-## Service Usage Examples
-
-### Video Content Service
-
-```typescript
-// Get user content list with filtering
-const content = await sdk.videoContent.getUserContents({
-  category_slug: 'action',
-  order_by: 'popularity',
-  limit: 20
-})
-
-// Search content
-const searchResults = await sdk.videoContent.searchContents('batman', {
-  type: 'movies',
-  limit: 10
-})
-
-// Get content details
-const details = await sdk.videoContent.getContentDetails(123)
-```
-
-### Stream Service
-
-```typescript
-// Generate streaming link
-const streamData = await sdk.stream.generateStreamLink({
-  video_content_id: 123,
-  season_number: 1,
-  episode_number: 5
-})
-
-// Save viewing progress
-await sdk.stream.saveStreamLog({
-  video_content_id: 123,
-  elapsed_time: 1800, // 30 minutes
-  total_duration: 3600 // 1 hour
-})
-
-// Get watch history
-const history = await sdk.stream.getWatchHistory({
-  limit: 20
-})
-```
-
-### Comment Service
-
-```typescript
-// Add a comment
-await sdk.comment.addComment({
-  content_id: 123,
-  content_type: 'VIDEO',
-  text: 'Great movie!',
-  is_spoil: false
-})
-
-// Get comments for content
-const comments = await sdk.comment.getComments({
-  content_id: 123,
-  content_type: 'VIDEO',
-  page: 1,
-  limit: 20
-})
-
-// Like a comment
-await sdk.comment.likeDislikeComment('comment-id', 'like')
-```
-
-### News Service
-
-```typescript
-// Get latest news
-const news = await sdk.news.getLatestNews(10)
-
-// Get news by category
-const categoryNews = await sdk.news.getNewsByCategory(5, {
-  page: 1,
-  limit: 15
-})
-
-// Search news
-const searchResults = await sdk.news.searchNews('movie review', {
-  category_id: 1,
-  limit: 10
-})
-```
-
-## Error Handling
-
-The SDK provides comprehensive error handling with specific error types:
-
-```typescript
-import { SDKError } from '@30nama/sdk'
-
-try {
-  const data = await sdk.videoContent.getUserContents()
-} catch (error) {
-  if (error instanceof SDKError) {
-    switch (error.type) {
-      case 'AuthenticationError':
-        // Handle authentication errors
-        console.log('Please sign in again')
-        break
-      case 'NetworkError':
-        // Handle network errors
-        console.log('Check your internet connection')
-        break
-      case 'ValidationError':
-        // Handle validation errors
-        console.log('Invalid request data')
-        break
-      default:
-        console.log('An error occurred:', error.message)
-    }
-  }
-}
-```
-
-## Advanced Usage
-
-### Custom Service Configuration
-
-```typescript
-// Update SDK configuration
-sdk.updateConfig({
-  timeout: 60000,
-  retries: 5,
-  debug: true
-})
-
-// Change environment
-sdk.setEnvironment('staging')
-```
-
-### Health Monitoring
-
-```typescript
-// Check services health
-const health = await sdk.checkHealth()
-console.log('Services Health:', health)
-```
-
-### Debug Mode
-
-Enable debug mode for detailed logging:
-
-```typescript
-const sdk = new ThirtyNamaSDK({
-  environment: 'staging',
-  debug: true // Enable debug logging
-})
-```
-
-### Authentication Status
-
-Check authentication status for debugging:
-
-```typescript
-// Get auth status for a specific service
-const authStatus = await sdk.videoContent.getAuthStatus()
-console.log('Auth Status:', authStatus)
-// Output: { hasAuth: true, service: "VideoContent" }
-
-// Get detailed auth information
-const detailedStatus = sdk.authManager.getAuthStatus()
-console.log('Detailed Status:', detailedStatus)
-// Output: { hasCallback: true }
-```
-
-### Testing
-
-The SDK is designed to work seamlessly with your testing framework. You can mock the SDK services for unit testing:
-
-```typescript
-// Mock example for Jest
-jest.mock('@30nama/sdk', () => ({
-  ThirtyNamaSDK: jest.fn().mockImplementation(() => ({
-    videoContent: {
-      getUserContents: jest.fn().mockResolvedValue({ items: [], count: 0 })
-    }
-  }))
-}))
-```
-
-## License
-
-This project is licensed under the ISC License.
-
-## Support
-
-For support and questions:
-
-- Create an issue on GitHub
-- Check the documentation
-- Contact us through the official website
-
-## Changelog
-
-### What's new?
-
-- Ultra-simplified authentication system
-- Callback-based token management only
-- Complete rewrite with TypeScript
-- Unified SDK for all microservices
-- Enhanced error handling and retry logic
-- Full type safety with auto-generated types
-- Debug mode and health monitoring
-- Comprehensive documentation
+# 30nama SDK
+
+Official TypeScript SDK for interacting with the 30nama platform's microservices.
+
+## Features
+
+- 🎯 **Unified API** - Single SDK for all 30nama user microservices
+- 📱 **Frontend-First** - Designed specifically for frontend applications
+- 🛡️ **Type-Safe** - Full TypeScript support with auto-generated types (synced with the API)
+- 🔄 **Auto-Retry** - Built-in retry logic for network failures (configurable)
+- 🐛 **Debug Mode** - Comprehensive logging for development
+- 🌍 **Multi-Environment** - Support for development, staging, and production
+- 🔐 **Simple Auth** - Ultra-simple callback-based authentication
+
+## Services Included
+
+- **VideoContent** - Handles video content management operations
+- **VideoData** - Handles video metadata and content access
+- **Stream** - Handles video streaming operations including link generation and streaming
+- **Operator** - Handles user authentication, profile management, and user operations
+- **Comment** - Handles user comments and questions on video content, biography, and news
+- **Biography** - Handles user and celebrity profiles
+- **News** - Handles news and articles management with SEO and search capabilities
+- **Supporter** - Handles user support, accessibility management, and system content viewing
+- **Notification** - Handles user notifications and settings
+
+## Installation
+
+```bash
+npm install @30nama/sdk
+# or
+yarn add @30nama/sdk
+# or
+pnpm add @30nama/sdk
+```
+
+## Quick Start
+
+```typescript
+import { ThirtyNamaSDK } from '@30nama/sdk'
+
+// Initialize the SDK
+const sdk = new ThirtyNamaSDK({
+  environment: 'production',
+  debug: true
+})
+
+// Set up authentication with callback
+sdk.setTokenStorageCallback(() => {
+  return localStorage.getItem('access_token')
+})
+
+// Use the services
+const videos = await sdk.videoContent.getUserContents({
+  limit: 10,
+  order_by: 'newest'
+})
+
+const streamLink = await sdk.stream.generateStreamLink({
+  video_content_id: 123
+})
+
+const comments = await sdk.comment.getComments({
+  content_id: 123,
+  content_type: 'VIDEO'
+})
+```
+
+## Configuration
+
+### SDK Configuration Options
+
+```typescript
+interface SDKConfig {
+  environment: 'staging' | 'production'
+  debug?: boolean
+  timeout?: number
+  retries?: number
+}
+```
+
+## Authentication
+
+The SDK uses a simple callback-based authentication system. You provide a function that returns the authentication token when needed.
+
+### Token Callback Authentication
+
+```typescript
+// Set up dynamic token retrieval
+sdk.setTokenStorageCallback(() => {
+  // Return token from your preferred storage
+  return localStorage.getItem('userToken')
+})
+
+// For async token retrieval
+sdk.setTokenStorageCallback(async () => {
+  // Return token from async source
+  return await getTokenFromSecureStorage()
+})
+
+// Clear authentication
+sdk.clearTokens()
+```
+
+## Service Usage Examples
+
+### Video Content Service
+
+```typescript
+// Get user content list with filtering
+const content = await sdk.videoContent.getUserContents({
+  category_slug: 'action',
+  order_by: 'popularity',
+  limit: 20
+})
+
+// Search content
+const searchResults = await sdk.videoContent.searchContents('batman', {
+  type: 'movies',
+  limit: 10
+})
+
+// Get content details
+const details = await sdk.videoContent.getContentDetails(123)
+```
+
+### Stream Service
+
+```typescript
+// Generate streaming link
+const streamData = await sdk.stream.generateStreamLink({
+  video_content_id: 123,
+  season_number: 1,
+  episode_number: 5
+})
+
+// Save viewing progress
+await sdk.stream.saveStreamLog({
+  video_content_id: 123,
+  elapsed_time: 1800, // 30 minutes
+  total_duration: 3600 // 1 hour
+})
+
+// Get watch history
+const history = await sdk.stream.getWatchHistory({
+  limit: 20
+})
+```
+
+### Comment Service
+
+```typescript
+// Add a comment
+await sdk.comment.addComment({
+  content_id: 123,
+  content_type: 'VIDEO',
+  text: 'Great movie!',
+  is_spoil: false
+})
+
+// Get comments for content
+const comments = await sdk.comment.getComments({
+  content_id: 123,
+  content_type: 'VIDEO',
+  page: 1,
+  limit: 20
+})
+
+// Like a comment
+await sdk.comment.likeDislikeComment('comment-id', 'like')
+```
+
+### News Service
+
+```typescript
+// Get latest news
+const news = await sdk.news.getLatestNews(10)
+
+// Get news by category
+const categoryNews = await sdk.news.getNewsByCategory(5, {
+  page: 1,
+  limit: 15
+})
+
+// Search news
+const searchResults = await sdk.news.searchNews('movie review', {
+  category_id: 1,
+  limit: 10
+})
+```
+
+## Error Handling
+
+The SDK provides comprehensive error handling with specific error types:
+
+```typescript
+import { SDKError } from '@30nama/sdk'
+
+try {
+  const data = await sdk.videoContent.getUserContents()
+} catch (error) {
+  if (error instanceof SDKError) {
+    switch (error.type) {
+      case 'AuthenticationError':
+        // Handle authentication errors
+        console.log('Please sign in again')
+        break
+      case 'NetworkError':
+        // Handle network errors
+        console.log('Check your internet connection')
+        break
+      case 'ValidationError':
+        // Handle validation errors
+        console.log('Invalid request data')
+        break
+      default:
+        console.log('An error occurred:', error.message)
+    }
+  }
+}
+```
+
+## Advanced Usage
+
+### Custom Service Configuration
+
+```typescript
+// Update SDK configuration
+sdk.updateConfig({
+  timeout: 60000,
+  retries: 5,
+  debug: true
+})
+
+// Change environment
+sdk.setEnvironment('staging')
+```
+
+### Health Monitoring
+
+```typescript
+// Check services health
+const health = await sdk.checkHealth()
+console.log('Services Health:', health)
+```
+
+### Debug Mode
+
+Enable debug mode for detailed logging:
+
+```typescript
+const sdk = new ThirtyNamaSDK({
+  environment: 'staging',
+  debug: true // Enable debug logging
+})
+```
+
+### Authentication Status
+
+Check authentication status for debugging:
+
+```typescript
+// Get auth status for a specific service
+const authStatus = await sdk.videoContent.getAuthStatus()
+console.log('Auth Status:', authStatus)
+// Output: { hasAuth: true, service: "VideoContent" }
+
+// Get detailed auth information
+const detailedStatus = sdk.authManager.getAuthStatus()
+console.log('Detailed Status:', detailedStatus)
+// Output: { hasCallback: true }
+```
+
+### Testing
+
+The SDK is designed to work seamlessly with your testing framework. You can mock the SDK services for unit testing:
+
+```typescript
+// Mock example for Jest
+jest.mock('@30nama/sdk', () => ({
+  ThirtyNamaSDK: jest.fn().mockImplementation(() => ({
+    videoContent: {
+      getUserContents: jest.fn().mockResolvedValue({ items: [], count: 0 })
+    }
+  }))
+}))
+```
+
+## License
+
+This project is licensed under the ISC License.
+
+## Support
+
+For support and questions:
+
+- Create an issue on GitHub
+- Check the documentation
+- Contact us through the official website
+
+## Changelog
+
+### What's new?
+
+- Ultra-simplified authentication system
+- Callback-based token management only
+- Complete rewrite with TypeScript
+- Unified SDK for all microservices
+- Enhanced error handling and retry logic
+- Full type safety with auto-generated types
+- Debug mode and health monitoring
+- Comprehensive documentation