@olastudio/social-media-sdk 0.1.0

package/dist/providers/facebook/index.d.mts

@@ -0,0 +1,464 @@
+import { U as UserProfile, R as RequestOptions, c as AuthProvider, A as AuthResult } from '../../auth.types-DTXCyA56.mjs';
+import { A as APIClient, d as PageOverview, c as InsightsResponse, g as VideoInsights, i as ReelsInsights, f as PostInsights, k as PhotoInsights } from '../../insights.types-5z7HJnbt.mjs';
+
+/**
+ * Facebook Types - Facebook-specific types
+ */
+
+/**
+ * Facebook provider configuration
+ * Note: apiVersion is fixed to v24.0 to ensure API compatibility
+ */
+interface FacebookConfig {
+    appId: string;
+    appSecret?: string;
+    redirectUri?: string;
+}
+/**
+ * Facebook Scopes (Business Permissions)
+ */
+declare enum FacebookScopesBusiness {
+    PUBLIC_PROFILE = "public_profile",
+    EMAIL = "email",
+    PAGES_SHOW_LIST = "pages_show_list",
+    PAGES_READ_ENGAGEMENT = "pages_read_engagement",
+    PAGES_MANAGE_POSTS = "pages_manage_posts",
+    ADS_MANAGEMENT = "ads_management",
+    ADS_READ = "ads_read",
+    BUSINESS_MANAGEMENT = "business_management",
+    CATALOG_MANAGEMENT = "catalog_management",
+    COMMERCE_ACCOUNT_MANAGE_ORDERS = "commerce_account_manage_orders",
+    COMMERCE_ACCOUNT_READ_ORDERS = "commerce_account_read_orders",
+    COMMERCE_ACCOUNT_READ_REPORTS = "commerce_account_read_reports",
+    COMMERCE_ACCOUNT_READ_SETTINGS = "commerce_account_read_settings",
+    COMMERCE_MANAGE_ACCOUNTS = "commerce_manage_accounts",
+    INSTAGRAM_BASIC = "instagram_basic",
+    INSTAGRAM_CONTENT_PUBLISH = "instagram_content_publish",
+    INSTAGRAM_MANAGE_COMMENTS = "instagram_manage_comments",
+    INSTAGRAM_MANAGE_INSIGHTS = "instagram_manage_insights",
+    INSTAGRAM_MANAGE_MESSAGES = "instagram_manage_messages",
+    INSTAGRAM_SHOPPING_TAG_PRODUCTS = "instagram_shopping_tag_products",
+    LEADS_RETRIEVAL = "leads_retrieval",
+    MANAGE_APP_SOLUTIONS = "manage_app_solutions",
+    MANAGE_FUNDRAISERS = "manage_fundraisers",
+    PAGES_MANAGE_CTA = "pages_manage_cta",
+    PAGE_EVENTS = "page_events",
+    PAGES_MANAGE_ADS = "pages_manage_ads",
+    PAGES_MANAGE_ENGAGEMENT = "pages_manage_engagement",
+    PAGES_MANAGE_INSTANT_ARTICLES = "pages_manage_instant_articles",
+    PAGES_MANAGE_METADATA = "pages_manage_metadata",
+    PAGES_MESSAGING = "pages_messaging",
+    PAGES_READ_USER_CONTENT = "pages_read_user_content",
+    PRIVATE_COMPUTATION_ACCESS = "private_computation_access",
+    PUBLISH_VIDEO = "publish_video",
+    READ_INSIGHTS = "read_insights",
+    READ_AUDIENCE_NETWORK_INSIGHTS = "read_audience_network_insights",
+    WHATSAPP_BUSINESS_MANAGEMENT = "whatsapp_business_management",
+    WHATSAPP_BUSINESS_MESSAGING = "whatsapp_business_messaging"
+}
+/**
+ * Facebook Scopes (User Permissions)
+ */
+declare enum FacebookScopesUser {
+    PUBLIC_PROFILE = "public_profile",
+    EMAIL = "email",
+    USER_FRIENDS = "user_friends"
+}
+/**
+ * Facebook Page
+ */
+interface FacebookPage {
+    id: string;
+    name: string;
+    access_token: string;
+    picture?: {
+        data: {
+            url: string;
+        };
+    };
+}
+/**
+ * Facebook user profile
+ */
+interface FacebookUserProfile extends UserProfile {
+    id: string;
+    name: string;
+    email?: string;
+    picture?: {
+        data: {
+            url: string;
+        };
+    };
+}
+/**
+ * Facebook pages response
+ */
+interface FacebookPagesResponse {
+    data: FacebookPage[];
+    paging?: {
+        cursors: {
+            before: string;
+            after: string;
+        };
+        next?: string;
+        previous?: string;
+    };
+}
+/**
+ * Facebook post response
+ */
+interface FacebookPostResponse {
+    id: string;
+    post_id?: string;
+}
+/**
+ * Parameters for publishing to Facebook
+ */
+interface FacebookPublishPostParams {
+    pageId: string;
+    pageAccessToken: string;
+    message?: string;
+    imageUrl?: string;
+    scheduledPublishTime?: number;
+}
+/**
+ * Parameters for token exchange
+ */
+interface FacebookExchangeTokenParams {
+    shortLivedToken: string;
+    appId: string;
+    appSecret: string;
+}
+/**
+ * Token exchange response
+ */
+interface FacebookTokenResponse {
+    access_token: string;
+    token_type?: string;
+    expires_in?: number;
+}
+/**
+ * Facebook error
+ */
+interface FacebookErrorResponse {
+    error: {
+        message: string;
+        type: string;
+        code: number;
+        fbtrace_id: string;
+    };
+}
+
+/**
+ * Facebook API - Facebook API Client
+ */
+
+declare class FacebookAPI implements APIClient {
+    private httpClient;
+    private config;
+    private accessToken?;
+    constructor(config: FacebookConfig, accessToken?: string);
+    /**
+     * Generic request
+     */
+    request<T>(endpoint: string, options?: RequestOptions): Promise<T>;
+    /**
+     * GET request
+     */
+    get<T>(endpoint: string, params?: Record<string, any>): Promise<T>;
+    /**
+     * POST request
+     */
+    post<T>(endpoint: string, body?: any): Promise<T>;
+    /**
+     * PUT request
+     */
+    put<T>(endpoint: string, body?: any): Promise<T>;
+    /**
+     * DELETE request
+     */
+    delete<T>(endpoint: string): Promise<T>;
+    /**
+     * Update access token
+     */
+    setAccessToken(token: string): void;
+    /**
+     * Get current access token
+     */
+    getAccessToken(): string | undefined;
+    /**
+     * Get user's pages
+     */
+    getPages(userAccessToken?: string): Promise<FacebookPage[]>;
+    /**
+     * Publish post to Facebook page
+     */
+    publishPost(params: FacebookPublishPostParams): Promise<FacebookPostResponse>;
+    /**
+     * Delete Facebook post
+     */
+    deletePost(postId: string, pageAccessToken: string): Promise<boolean>;
+    /**
+     * Get page information
+     */
+    getPage(pageId: string, fields?: string[]): Promise<FacebookPage>;
+    /**
+     * Debug/validate a Facebook access token
+     * Uses Facebook's debug_token endpoint
+     *
+     * @param inputToken - The token to validate
+     * @param appAccessToken - App token (app_id|app_secret)
+     * @returns Token debug information
+     */
+    debugToken(inputToken: string, appAccessToken: string): Promise<{
+        data: {
+            is_valid: boolean;
+            expires_at?: number;
+            scopes?: string[];
+            error?: {
+                message: string;
+                code: number;
+            };
+        };
+    }>;
+    /**
+     * Get page insights/analytics
+     * @param pageId - Facebook Page ID
+     * @param options - Insights options
+     * @returns Page insights data
+     */
+    getPageInsights(pageId: string, options: {
+        metric: string[];
+        period?: 'day' | 'week' | 'days_28' | 'month' | 'lifetime';
+        since?: number;
+        until?: number;
+    }): Promise<{
+        data: Array<{
+            name: string;
+            period: string;
+            values: Array<{
+                value: number;
+                end_time?: string;
+            }>;
+            title?: string;
+            description?: string;
+        }>;
+    }>;
+    /**
+     * Get page fans count (total followers)
+     * @param pageId - Facebook Page ID
+     * @returns Page with fan count
+     */
+    getPageFansCount(pageId: string): Promise<{
+        id: string;
+        fan_count: number;
+    }>;
+    /**
+     * Get page overview with key metrics
+     * @param pageId - Facebook Page ID
+     * @returns Page overview data
+     */
+    getPageOverview(pageId: string): Promise<PageOverview>;
+    /**
+     * Get video insights
+     * @param videoId - Facebook Video ID
+     * @param metrics - Specific metrics to fetch (defaults to common metrics)
+     * @returns Video insights data
+     */
+    getVideoInsights(videoId: string, metrics?: string[]): Promise<InsightsResponse>;
+    /**
+     * Get video insights with parsed values
+     * @param videoId - Facebook Video ID
+     * @returns Parsed video insights
+     */
+    getVideoInsightsParsed(videoId: string): Promise<VideoInsights>;
+    /**
+     * Get page videos with basic info
+     * @param pageId - Facebook Page ID
+     * @param limit - Number of videos to fetch
+     * @returns List of videos
+     */
+    getPageVideos(pageId: string, limit?: number): Promise<{
+        data: Array<{
+            id: string;
+            title?: string;
+            description?: string;
+            created_time: string;
+            length?: number;
+        }>;
+    }>;
+    /**
+     * Get reels insights
+     * @param reelId - Facebook Reel ID
+     * @param metrics - Specific metrics to fetch
+     * @returns Reels insights data
+     */
+    getReelsInsights(reelId: string, metrics?: string[]): Promise<InsightsResponse>;
+    /**
+     * Get reels insights with parsed values
+     * @param reelId - Facebook Reel ID
+     * @returns Parsed reels insights
+     */
+    getReelsInsightsParsed(reelId: string): Promise<ReelsInsights>;
+    /**
+     * Get page reels
+     * @param pageId - Facebook Page ID
+     * @param limit - Number of reels to fetch
+     * @returns List of reels
+     */
+    getPageReels(pageId: string, limit?: number): Promise<{
+        data: Array<{
+            id: string;
+            description?: string;
+            created_time: string;
+        }>;
+    }>;
+    /**
+     * Get post insights
+     * @param postId - Facebook Post ID
+     * @param metrics - Specific metrics to fetch
+     * @returns Post insights data
+     */
+    getPostInsights(postId: string, metrics?: string[]): Promise<InsightsResponse>;
+    /**
+     * Get post insights with parsed values
+     * @param postId - Facebook Post ID
+     * @returns Parsed post insights
+     */
+    getPostInsightsParsed(postId: string): Promise<PostInsights>;
+    /**
+     * Get page posts/feed
+     * @param pageId - Facebook Page ID
+     * @param limit - Number of posts to fetch
+     * @returns List of posts
+     */
+    getPagePosts(pageId: string, limit?: number): Promise<{
+        data: Array<{
+            id: string;
+            message?: string;
+            created_time: string;
+            type?: string;
+        }>;
+    }>;
+    /**
+     * Get photo insights
+     * @param photoId - Facebook Photo ID
+     * @param metrics - Specific metrics to fetch
+     * @returns Photo insights data
+     */
+    getPhotoInsights(photoId: string, metrics?: string[]): Promise<InsightsResponse>;
+    /**
+     * Get photo insights with parsed values
+     * @param photoId - Facebook Photo ID
+     * @returns Parsed photo insights
+     */
+    getPhotoInsightsParsed(photoId: string): Promise<PhotoInsights>;
+    /**
+     * Get page photos
+     * @param pageId - Facebook Page ID
+     * @param limit - Number of photos to fetch
+     * @returns List of photos
+     */
+    getPagePhotos(pageId: string, limit?: number): Promise<{
+        data: Array<{
+            id: string;
+            name?: string;
+            created_time: string;
+        }>;
+    }>;
+    /**
+     * Get quick insights summary for a page
+     * Combines key metrics in a single call
+     * @param pageId - Facebook Page ID
+     * @param period - Period for time-based metrics
+     * @returns Summary of page insights
+     */
+    getPageInsightsSummary(pageId: string, period?: 'day' | 'week' | 'days_28'): Promise<{
+        overview: PageOverview;
+        engagement: {
+            views?: number;
+            post_engagements?: number;
+            video_views?: number;
+        };
+    }>;
+    /**
+     * Get current API version (read-only)
+     */
+    getApiVersion(): string;
+}
+
+/**
+ * Facebook Auth - Facebook Authentication
+ */
+
+declare class FacebookAuth implements AuthProvider {
+    private httpClient;
+    private config;
+    constructor(config: FacebookConfig);
+    /**
+     * Exchange Facebook token for session
+     * In Expo + Supabase, this is handled in the app
+     * This function only validates and gets profile info
+     */
+    exchangeToken(facebookToken: string): Promise<AuthResult>;
+    /**
+     * Get Facebook user profile
+     */
+    getProfile(accessToken: string): Promise<UserProfile>;
+    /**
+     * Exchange short-lived token for long-lived token
+     */
+    exchangeForLongLivedToken(params: FacebookExchangeTokenParams): Promise<string>;
+    /**
+     * Get OAuth configuration for Facebook
+     */
+    getOAuthConfig(scopes: string[], redirectUri: string): {
+        authorizationEndpoint: "https://www.facebook.com/v24.0/dialog/oauth";
+        tokenEndpoint: string;
+        clientId: string;
+        clientSecret: string | undefined;
+        redirectUri: string;
+        scopes: string[];
+        responseType: "token";
+        extraParams: {
+            display: string;
+        };
+    };
+    /**
+     * Get authorization URL
+     */
+    getAuthorizationUrl(scopes: string[], redirectUri: string, state?: string): string;
+    /**
+     * Get current API version (read-only)
+     */
+    getApiVersion(): string;
+}
+
+/**
+ * Facebook Provider - Main Facebook provider
+ */
+
+/**
+ * Facebook provider that encapsulates Auth and API
+ */
+declare class FacebookProvider {
+    readonly name: "facebook";
+    auth: FacebookAuth;
+    api: FacebookAPI;
+    config: FacebookConfig;
+    constructor(config: FacebookConfig);
+    /**
+     * Create new API instance with access token
+     */
+    createAPIClient(accessToken: string): FacebookAPI;
+    /**
+     * Update access token of existing API client
+     */
+    setAccessToken(accessToken: string): void;
+    /**
+     * Get current access token
+     */
+    getAccessToken(): string | undefined;
+}
+
+export { FacebookAPI, FacebookAuth, type FacebookConfig, type FacebookErrorResponse, type FacebookExchangeTokenParams, type FacebookPage, type FacebookPagesResponse, type FacebookPostResponse, FacebookProvider, type FacebookPublishPostParams, FacebookScopesBusiness, FacebookScopesUser, type FacebookTokenResponse, type FacebookUserProfile };