@olastudio/social-media-sdk 0.1.1 → 0.1.2

package/README.md

@@ -2,109 +2,244 @@
 
 Modular SDK for managing authentication and APIs of multiple social media platforms.
 
-**Works everywhere:**
-- Node.js
-- Deno (Supabase Edge Functions)
-- Browser
-- React Native / Expo
-
 ## Installation
 
 ```bash
 npm install @olastudio/social-media-sdk
 ```
 
+## Supported Platforms
+
+- **Facebook** - Pages management, posts publishing, insights
+- **Instagram** - Account insights, media management, content publishing
+- **TikTok** - User info, video list, account insights, content publishing
+
 ## Quick Start
 
-### Basic Usage (Node.js / Deno / Edge Functions)
+### Initialize Providers
 
 ```typescript
-import { FacebookProvider, InstagramProvider } from '@olastudio/social-media-sdk';
+import { FacebookProvider, InstagramProvider, TikTokProvider } from '@olastudio/social-media-sdk';
 
-// Initialize providers
+// Facebook
 const facebookProvider = new FacebookProvider({
-  appId: process.env.FACEBOOK_APP_ID!,
+  appId: 'YOUR_FACEBOOK_APP_ID',
 });
 
+// Instagram
 const instagramProvider = new InstagramProvider({
-  appId: process.env.FACEBOOK_APP_ID!,
+  appId: 'YOUR_FACEBOOK_APP_ID', // Instagram uses Facebook App ID
+});
+
+// TikTok
+const tiktokProvider = new TikTokProvider({
+  clientKey: 'YOUR_TIKTOK_CLIENT_KEY',
 });
+```
+
+### Set Access Token
 
-// Set access token
+```typescript
+// After obtaining user's access token via OAuth
 facebookProvider.setAccessToken(userAccessToken);
 instagramProvider.setAccessToken(userAccessToken);
+tiktokProvider.setAccessToken(userAccessToken);
+```
+
+## Facebook API
+
+### Get User Pages
 
-// Use APIs
+```typescript
 const pages = await facebookProvider.api.getPages();
+console.log('User pages:', pages);
+```
+
+### Get Page Insights
+
+```typescript
+const insights = await facebookProvider.api.getPageInsights(pageId, {
+  metric: ['page_impressions', 'page_engaged_users'],
+  period: 'day',
+  since: startTimestamp,
+  until: endTimestamp,
+});
+```
+
+### Publish Post
+
+```typescript
+// Text only
+const post = await facebookProvider.api.publishPost({
+  pageId: 'PAGE_ID',
+  pageAccessToken: 'PAGE_ACCESS_TOKEN',
+  message: 'Hello from the SDK!',
+});
+
+// With photo
+const photoPost = await facebookProvider.api.publishPost({
+  pageId: 'PAGE_ID',
+  pageAccessToken: 'PAGE_ACCESS_TOKEN',
+  message: 'Check out this photo!',
+  imageUrl: 'https://example.com/photo.jpg',
+});
+```
+
+### Get Fan Count
+
+```typescript
+const fansData = await facebookProvider.api.getPageFansCount(pageId);
+console.log('Fans:', fansData.fan_count);
+```
+
+## Instagram API
+
+### Get Account Info
+
+```typescript
+const account = await instagramProvider.api.getAccount(accountId);
+console.log('Account:', account);
+```
+
+### Get Account Insights
+
+```typescript
 const insights = await instagramProvider.api.getAccountInsights(accountId, {
-  metric: ['reach', 'impressions'],
+  metric: ['reach', 'impressions', 'profile_views'],
   period: 'day',
   since: startTimestamp,
   until: endTimestamp,
 });
 ```
 
-### With Expo/React Native (OAuth)
+### Get Media
+
+```typescript
+const media = await instagramProvider.api.getMedia(accountId, 25);
+console.log('Recent media:', media);
+```
+
+### Publish Photo
+
+```typescript
+const post = await instagramProvider.api.publishPhoto({
+  instagramAccountId: 'IG_ACCOUNT_ID',
+  imageUrl: 'https://example.com/photo.jpg',
+  caption: 'Hello Instagram!',
+});
+```
+
+### Publish Reel
+
+```typescript
+const reel = await instagramProvider.api.publishReel({
+  instagramAccountId: 'IG_ACCOUNT_ID',
+  videoUrl: 'https://example.com/video.mp4',
+  caption: 'My new reel!',
+  coverUrl: 'https://example.com/cover.jpg',
+});
+```
+
+## TikTok API
+
+### Get User Info
+
+```typescript
+const userInfo = await tiktokProvider.api.getUserInfo();
+console.log('User:', userInfo);
+```
+
+### Get Account Insights
+
+```typescript
+const insights = await tiktokProvider.api.getAccountInsights();
+console.log('Insights:', insights);
+// Returns: followerCount, followingCount, likesCount, videoCount, totalViews, averageEngagementRate
+```
+
+### Get Video List
+
+```typescript
+const videos = await tiktokProvider.api.getVideoList({ maxCount: 20 });
+console.log('Videos:', videos);
+```
+
+### Get Video Insights
+
+```typescript
+const videoInsights = await tiktokProvider.api.getVideoInsights('VIDEO_ID');
+console.log('Video metrics:', videoInsights);
+```
+
+## OAuth Authentication (React Native/Expo)
+
+For mobile apps using Expo, import the ExpoAdapter separately:
 
 ```typescript
-// ExpoAdapter must be imported separately
 import { ExpoAdapter } from '@olastudio/social-media-sdk/adapters/expo';
 import { FacebookProvider } from '@olastudio/social-media-sdk';
 
 const oauthAdapter = new ExpoAdapter();
-const facebookProvider = new FacebookProvider({ appId: FB_APP_ID });
+const facebookProvider = new FacebookProvider({ appId: 'YOUR_APP_ID' });
 
-// Start OAuth flow
+// Get OAuth config
 const oauthConfig = facebookProvider.auth.getOAuthConfig(
   ['public_profile', 'email', 'pages_manage_posts'],
-  redirectUri
+  'YOUR_REDIRECT_URI'
 );
 
+// Start OAuth flow
 const result = await oauthAdapter.startAuthFlow(oauthConfig);
-if (result.type === 'success') {
+
+if (result.type === 'success' && result.accessToken) {
   facebookProvider.setAccessToken(result.accessToken);
+  // Now you can use the API
 }
 ```
 
-## Supported Platforms
-
-### Facebook
-- Pages management
-- Posts publishing (text, photos, videos)
-- Page insights
-- Fan count
+## Advanced Usage
 
-### Instagram
-- Account insights
-- Media management
-- Content publishing
-- Stories
+### Custom HTTP Client Configuration
 
-### TikTok
-- User info
-- Video list
-- Account insights
-- Content publishing
-
-## Deno / Edge Functions
+```typescript
+const provider = new FacebookProvider({
+  appId: 'YOUR_APP_ID',
+  apiVersion: 'v18.0', // Optional, defaults to v24.0
+});
+```
 
-This SDK works seamlessly with Deno and Supabase Edge Functions:
+### Error Handling
 
 ```typescript
-// In Supabase Edge Function
-import { FacebookProvider, InstagramProvider } from 'npm:@olastudio/social-media-sdk';
+import { APIError, AuthError } from '@olastudio/social-media-sdk';
 
-Deno.serve(async (req) => {
-  const facebookProvider = new FacebookProvider({ appId: Deno.env.get('FB_APP_ID')! });
-  facebookProvider.setAccessToken(accessToken);
-  
-  const insights = await facebookProvider.api.getPageInsights(pageId, {
-    metric: ['page_impressions'],
+try {
+  const insights = await instagramProvider.api.getAccountInsights(accountId, {
+    metric: ['reach'],
     period: 'day',
   });
-  
-  return new Response(JSON.stringify(insights));
-});
+} catch (error) {
+  if (error instanceof APIError) {
+    console.error('API Error:', error.message, error.statusCode);
+  } else if (error instanceof AuthError) {
+    console.error('Auth Error:', error.message);
+  }
+}
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and includes full type definitions.
+
+```typescript
+import type {
+  FacebookPage,
+  InstagramAccount,
+  InstagramMedia,
+  TikTokUserInfo,
+  PageInsightsParams,
+  AccountInsightsParams,
+} from '@olastudio/social-media-sdk';
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olastudio/social-media-sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Modular SDK for managing authentication and APIs of multiple social media platforms",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -62,14 +62,13 @@
     "api",
     "expo",
     "react-native",
-    "deno",
-    "supabase"
+    "typescript"
   ],
   "author": "Oktopus Dev",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/oktopus-dev/social-media-sdk"
+    "url": "https://github.com/OktopusSolutions/social-media-sdk"
   },
   "peerDependencies": {
     "expo-auth-session": ">=5.0.0",