@followgate/js 0.1.0 → 0.3.0

package/README.md

@@ -32,11 +32,11 @@ FollowGate.open({
 
 ## Supported Platforms
 
-| Platform | Actions |
-|----------|---------|
+| Platform  | Actions                    |
+| --------- | -------------------------- |
 | Twitter/X | `follow`, `repost`, `like` |
-| Bluesky | `follow`, `repost`, `like` |
-| LinkedIn | `follow` |
+| Bluesky   | `follow`, `repost`, `like` |
+| LinkedIn  | `follow`                   |
 
 ## API Reference
 
@@ -46,10 +46,10 @@ Initialize the SDK with your credentials.
 
 ```typescript
 FollowGate.init({
-  appId: 'your-app-id',      // Required: Your app ID from dashboard
-  apiKey: 'fg_live_xxx',     // Required: Your API key
-  apiUrl: 'https://...',     // Optional: Custom API URL
-  debug: false,              // Optional: Enable debug logging
+  appId: 'your-app-id', // Required: Your app ID from dashboard
+  apiKey: 'fg_live_xxx', // Required: Your API key
+  apiUrl: 'https://...', // Optional: Custom API URL
+  debug: false, // Optional: Enable debug logging
 });
 ```
 
@@ -59,10 +59,10 @@ Open a social action popup/intent.
 
 ```typescript
 await FollowGate.open({
-  platform: 'twitter',    // 'twitter' | 'bluesky' | 'linkedin'
-  action: 'follow',       // 'follow' | 'repost' | 'like'
-  target: 'username',     // Username or post ID
-  userId: 'user-123',     // Optional: Your app's user ID
+  platform: 'twitter', // 'twitter' | 'bluesky' | 'linkedin'
+  action: 'follow', // 'follow' | 'repost' | 'like'
+  target: 'username', // Username or post ID
+  userId: 'user-123', // Optional: Your app's user ID
 });
 ```
 
@@ -106,7 +106,11 @@ FollowGate.on('error', (error) => {
 FollowGate.open({ platform: 'twitter', action: 'follow', target: 'elonmusk' });
 
 // Repost a tweet
-FollowGate.open({ platform: 'twitter', action: 'repost', target: '1234567890' });
+FollowGate.open({
+  platform: 'twitter',
+  action: 'repost',
+  target: '1234567890',
+});
 ```
 
 ### Bluesky
@@ -116,7 +120,11 @@ FollowGate.open({ platform: 'twitter', action: 'repost', target: '1234567890' })
 
 ```typescript
 // Follow
-FollowGate.open({ platform: 'bluesky', action: 'follow', target: 'alice.bsky.social' });
+FollowGate.open({
+  platform: 'bluesky',
+  action: 'follow',
+  target: 'alice.bsky.social',
+});
 ```
 
 ### LinkedIn
@@ -125,19 +133,27 @@ FollowGate.open({ platform: 'bluesky', action: 'follow', target: 'alice.bsky.soc
 
 ```typescript
 // Follow a company
-FollowGate.open({ platform: 'linkedin', action: 'follow', target: 'microsoft' });
+FollowGate.open({
+  platform: 'linkedin',
+  action: 'follow',
+  target: 'microsoft',
+});
 
 // Follow a personal profile
-FollowGate.open({ platform: 'linkedin', action: 'follow', target: 'in:satyanadella' });
+FollowGate.open({
+  platform: 'linkedin',
+  action: 'follow',
+  target: 'in:satyanadella',
+});
 ```
 
 ## Pricing
 
-| Tier | Price | Users | Verification |
-|------|-------|-------|--------------|
-| Free | $0 | 100 | Intent-URL only |
-| Starter | $15/mo | 500 | Weekly sampling |
-| Pro | $49/mo | 2,000 | OAuth verification |
+| Tier     | Price  | Users  | Verification       |
+| -------- | ------ | ------ | ------------------ |
+| Free     | $0     | 100    | Intent-URL only    |
+| Starter  | $15/mo | 500    | Weekly sampling    |
+| Pro      | $49/mo | 2,000  | OAuth verification |
 | Business | $99/mo | 5,000+ | Daily verification |
 
 ## TypeScript

package/dist/index.d.mts

@@ -31,21 +31,81 @@ type LinkedInTargetType = 'company' | 'profile';
 /**
  * Event types
  */
-type EventType = 'complete' | 'error' | 'cancel';
+type EventType = 'complete' | 'error' | 'cancel' | 'authenticated';
 /**
  * Event callback
  */
 type EventCallback = (data: unknown) => void;
+/**
+ * Authenticated user info
+ */
+interface AuthenticatedUser {
+    userId: string;
+    username: string;
+    platform: Platform;
+}
+/**
+ * Auth state when username input is needed
+ */
+interface PendingUsernameState {
+    needsUsername: true;
+    token: string;
+}
+/**
+ * Authentication options
+ */
+interface AuthOptions {
+    /** Where to redirect after auth (defaults to current page) */
+    redirectUri?: string;
+    /** Open in popup instead of redirect */
+    popup?: boolean;
+}
 /**
  * FollowGate SDK Client
  */
 declare class FollowGateClient {
     private config;
     private listeners;
+    private currentUser;
+    private authToken;
+    private pendingUsername;
     /**
      * Initialize the SDK
      */
     init(config: FollowGateConfig): void;
+    /**
+     * Authenticate user via Twitter OAuth (handled by FollowGate)
+     * This identifies WHO is completing the social actions.
+     */
+    authenticate(options?: AuthOptions): void;
+    /**
+     * Get current authenticated user
+     */
+    getUser(): AuthenticatedUser | null;
+    /**
+     * Check if user is authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Logout - clear stored session
+     */
+    logout(): void;
+    /**
+     * Check if username input is needed (Twitter Free Tier limitation)
+     */
+    needsUsernameInput(): boolean;
+    /**
+     * Set username manually (when needsUsernameInput() returns true)
+     */
+    setUsername(username: string): void;
+    /**
+     * Handle auth callback from URL params
+     */
+    private handleAuthCallback;
+    /**
+     * Restore session from localStorage
+     */
+    private restoreSession;
     /**
      * Open social action popup
      */
@@ -77,4 +137,4 @@ declare class FollowGateClient {
 }
 declare const FollowGate: FollowGateClient;
 
-export { type EventCallback, type EventType, FollowGate, FollowGateClient, type FollowGateConfig, type LinkedInTargetType, type OpenOptions, type Platform, type SocialAction };
+export { type AuthOptions, type AuthenticatedUser, type EventCallback, type EventType, FollowGate, FollowGateClient, type FollowGateConfig, type LinkedInTargetType, type OpenOptions, type PendingUsernameState, type Platform, type SocialAction };

package/dist/index.d.ts

@@ -31,21 +31,81 @@ type LinkedInTargetType = 'company' | 'profile';
 /**
  * Event types
  */
-type EventType = 'complete' | 'error' | 'cancel';
+type EventType = 'complete' | 'error' | 'cancel' | 'authenticated';
 /**
  * Event callback
  */
 type EventCallback = (data: unknown) => void;
+/**
+ * Authenticated user info
+ */
+interface AuthenticatedUser {
+    userId: string;
+    username: string;
+    platform: Platform;
+}
+/**
+ * Auth state when username input is needed
+ */
+interface PendingUsernameState {
+    needsUsername: true;
+    token: string;
+}
+/**
+ * Authentication options
+ */
+interface AuthOptions {
+    /** Where to redirect after auth (defaults to current page) */
+    redirectUri?: string;
+    /** Open in popup instead of redirect */
+    popup?: boolean;
+}
 /**
  * FollowGate SDK Client
  */
 declare class FollowGateClient {
     private config;
     private listeners;
+    private currentUser;
+    private authToken;
+    private pendingUsername;
     /**
      * Initialize the SDK
      */
     init(config: FollowGateConfig): void;
+    /**
+     * Authenticate user via Twitter OAuth (handled by FollowGate)
+     * This identifies WHO is completing the social actions.
+     */
+    authenticate(options?: AuthOptions): void;
+    /**
+     * Get current authenticated user
+     */
+    getUser(): AuthenticatedUser | null;
+    /**
+     * Check if user is authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Logout - clear stored session
+     */
+    logout(): void;
+    /**
+     * Check if username input is needed (Twitter Free Tier limitation)
+     */
+    needsUsernameInput(): boolean;
+    /**
+     * Set username manually (when needsUsernameInput() returns true)
+     */
+    setUsername(username: string): void;
+    /**
+     * Handle auth callback from URL params
+     */
+    private handleAuthCallback;
+    /**
+     * Restore session from localStorage
+     */
+    private restoreSession;
     /**
      * Open social action popup
      */
@@ -77,4 +137,4 @@ declare class FollowGateClient {
 }
 declare const FollowGate: FollowGateClient;
 
-export { type EventCallback, type EventType, FollowGate, FollowGateClient, type FollowGateConfig, type LinkedInTargetType, type OpenOptions, type Platform, type SocialAction };
+export { type AuthOptions, type AuthenticatedUser, type EventCallback, type EventType, FollowGate, FollowGateClient, type FollowGateConfig, type LinkedInTargetType, type OpenOptions, type PendingUsernameState, type Platform, type SocialAction };

package/dist/index.js

@@ -24,10 +24,13 @@ __export(index_exports, {
   FollowGateClient: () => FollowGateClient
 });
 module.exports = __toCommonJS(index_exports);
-var DEFAULT_API_URL = "https://api.followgate.io";
+var DEFAULT_API_URL = "https://api.followgate.app";
 var FollowGateClient = class {
   config = null;
   listeners = /* @__PURE__ */ new Map();
+  currentUser = null;
+  authToken = null;
+  pendingUsername = null;
   /**
    * Initialize the SDK
    */
@@ -36,8 +39,181 @@ var FollowGateClient = class {
       ...config,
       apiUrl: config.apiUrl || DEFAULT_API_URL
     };
+    this.handleAuthCallback();
+    this.restoreSession();
     if (config.debug) {
       console.log("[FollowGate] Initialized with appId:", config.appId);
+      if (this.currentUser) {
+        console.log("[FollowGate] Restored user:", this.currentUser.username);
+      }
+    }
+  }
+  /**
+   * Authenticate user via Twitter OAuth (handled by FollowGate)
+   * This identifies WHO is completing the social actions.
+   */
+  authenticate(options = {}) {
+    if (!this.config) {
+      throw new Error("[FollowGate] SDK not initialized. Call init() first.");
+    }
+    const redirectUri = options.redirectUri || window.location.href.split("?")[0];
+    const authUrl = `${this.config.apiUrl}/api/v1/auth/twitter?app_id=${encodeURIComponent(this.config.appId)}&redirect_uri=${encodeURIComponent(redirectUri)}`;
+    if (this.config.debug) {
+      console.log("[FollowGate] Starting auth flow:", authUrl);
+    }
+    if (options.popup) {
+      const popup = window.open(
+        authUrl,
+        "followgate_auth",
+        "width=600,height=700"
+      );
+      if (!popup) {
+        this.emit("error", { message: "Popup blocked" });
+      }
+    } else {
+      window.location.href = authUrl;
+    }
+  }
+  /**
+   * Get current authenticated user
+   */
+  getUser() {
+    return this.currentUser;
+  }
+  /**
+   * Check if user is authenticated
+   */
+  isAuthenticated() {
+    return this.currentUser !== null && this.authToken !== null;
+  }
+  /**
+   * Logout - clear stored session
+   */
+  logout() {
+    this.currentUser = null;
+    this.authToken = null;
+    this.pendingUsername = null;
+    if (typeof localStorage !== "undefined") {
+      localStorage.removeItem("followgate_token");
+      localStorage.removeItem("followgate_user");
+      localStorage.removeItem("followgate_pending_username");
+    }
+    if (this.config?.debug) {
+      console.log("[FollowGate] User logged out");
+    }
+  }
+  /**
+   * Check if username input is needed (Twitter Free Tier limitation)
+   */
+  needsUsernameInput() {
+    return this.pendingUsername !== null;
+  }
+  /**
+   * Set username manually (when needsUsernameInput() returns true)
+   */
+  setUsername(username) {
+    if (!this.pendingUsername) {
+      throw new Error(
+        "[FollowGate] No pending username state. User is either not authenticated or username is already set."
+      );
+    }
+    const normalizedUsername = username.startsWith("@") ? username.slice(1) : username;
+    this.currentUser = {
+      userId: "user_input",
+      username: normalizedUsername,
+      platform: "twitter"
+    };
+    this.authToken = this.pendingUsername.token;
+    if (typeof localStorage !== "undefined") {
+      localStorage.setItem("followgate_token", this.authToken);
+      localStorage.setItem("followgate_user", JSON.stringify(this.currentUser));
+      localStorage.removeItem("followgate_pending_username");
+    }
+    this.pendingUsername = null;
+    this.emit("authenticated", this.currentUser);
+    if (this.config?.debug) {
+      console.log("[FollowGate] Username set manually:", normalizedUsername);
+    }
+  }
+  /**
+   * Handle auth callback from URL params
+   */
+  handleAuthCallback() {
+    if (typeof window === "undefined") return;
+    const params = new URLSearchParams(window.location.search);
+    const token = params.get("followgate_token");
+    const username = params.get("followgate_user");
+    const needsUsername = params.get("followgate_needs_username") === "true";
+    if (token && needsUsername) {
+      this.pendingUsername = {
+        needsUsername: true,
+        token
+      };
+      if (typeof localStorage !== "undefined") {
+        localStorage.setItem(
+          "followgate_pending_username",
+          JSON.stringify(this.pendingUsername)
+        );
+      }
+      const url = new URL(window.location.href);
+      url.searchParams.delete("followgate_token");
+      url.searchParams.delete("followgate_needs_username");
+      window.history.replaceState({}, "", url.toString());
+      if (this.config?.debug) {
+        console.log("[FollowGate] OAuth successful, username input needed");
+      }
+    } else if (token && username) {
+      this.authToken = token;
+      this.currentUser = {
+        userId: "",
+        // Will be set from token verification
+        username,
+        platform: "twitter"
+      };
+      if (typeof localStorage !== "undefined") {
+        localStorage.setItem("followgate_token", token);
+        localStorage.setItem(
+          "followgate_user",
+          JSON.stringify(this.currentUser)
+        );
+      }
+      const url = new URL(window.location.href);
+      url.searchParams.delete("followgate_token");
+      url.searchParams.delete("followgate_user");
+      window.history.replaceState({}, "", url.toString());
+      this.emit("authenticated", this.currentUser);
+      if (this.config?.debug) {
+        console.log("[FollowGate] User authenticated:", username);
+      }
+    }
+  }
+  /**
+   * Restore session from localStorage
+   */
+  restoreSession() {
+    if (typeof localStorage === "undefined") return;
+    const pendingJson = localStorage.getItem("followgate_pending_username");
+    if (pendingJson) {
+      try {
+        this.pendingUsername = JSON.parse(pendingJson);
+        if (this.config?.debug) {
+          console.log("[FollowGate] Restored pending username state");
+        }
+        return;
+      } catch {
+        localStorage.removeItem("followgate_pending_username");
+      }
+    }
+    const token = localStorage.getItem("followgate_token");
+    const userJson = localStorage.getItem("followgate_user");
+    if (token && userJson) {
+      try {
+        this.authToken = token;
+        this.currentUser = JSON.parse(userJson);
+      } catch {
+        localStorage.removeItem("followgate_token");
+        localStorage.removeItem("followgate_user");
+      }
     }
   }
   /**

package/dist/index.mjs

@@ -1,8 +1,11 @@
 // src/index.ts
-var DEFAULT_API_URL = "https://api.followgate.io";
+var DEFAULT_API_URL = "https://api.followgate.app";
 var FollowGateClient = class {
   config = null;
   listeners = /* @__PURE__ */ new Map();
+  currentUser = null;
+  authToken = null;
+  pendingUsername = null;
   /**
    * Initialize the SDK
    */
@@ -11,8 +14,181 @@ var FollowGateClient = class {
       ...config,
       apiUrl: config.apiUrl || DEFAULT_API_URL
     };
+    this.handleAuthCallback();
+    this.restoreSession();
     if (config.debug) {
       console.log("[FollowGate] Initialized with appId:", config.appId);
+      if (this.currentUser) {
+        console.log("[FollowGate] Restored user:", this.currentUser.username);
+      }
+    }
+  }
+  /**
+   * Authenticate user via Twitter OAuth (handled by FollowGate)
+   * This identifies WHO is completing the social actions.
+   */
+  authenticate(options = {}) {
+    if (!this.config) {
+      throw new Error("[FollowGate] SDK not initialized. Call init() first.");
+    }
+    const redirectUri = options.redirectUri || window.location.href.split("?")[0];
+    const authUrl = `${this.config.apiUrl}/api/v1/auth/twitter?app_id=${encodeURIComponent(this.config.appId)}&redirect_uri=${encodeURIComponent(redirectUri)}`;
+    if (this.config.debug) {
+      console.log("[FollowGate] Starting auth flow:", authUrl);
+    }
+    if (options.popup) {
+      const popup = window.open(
+        authUrl,
+        "followgate_auth",
+        "width=600,height=700"
+      );
+      if (!popup) {
+        this.emit("error", { message: "Popup blocked" });
+      }
+    } else {
+      window.location.href = authUrl;
+    }
+  }
+  /**
+   * Get current authenticated user
+   */
+  getUser() {
+    return this.currentUser;
+  }
+  /**
+   * Check if user is authenticated
+   */
+  isAuthenticated() {
+    return this.currentUser !== null && this.authToken !== null;
+  }
+  /**
+   * Logout - clear stored session
+   */
+  logout() {
+    this.currentUser = null;
+    this.authToken = null;
+    this.pendingUsername = null;
+    if (typeof localStorage !== "undefined") {
+      localStorage.removeItem("followgate_token");
+      localStorage.removeItem("followgate_user");
+      localStorage.removeItem("followgate_pending_username");
+    }
+    if (this.config?.debug) {
+      console.log("[FollowGate] User logged out");
+    }
+  }
+  /**
+   * Check if username input is needed (Twitter Free Tier limitation)
+   */
+  needsUsernameInput() {
+    return this.pendingUsername !== null;
+  }
+  /**
+   * Set username manually (when needsUsernameInput() returns true)
+   */
+  setUsername(username) {
+    if (!this.pendingUsername) {
+      throw new Error(
+        "[FollowGate] No pending username state. User is either not authenticated or username is already set."
+      );
+    }
+    const normalizedUsername = username.startsWith("@") ? username.slice(1) : username;
+    this.currentUser = {
+      userId: "user_input",
+      username: normalizedUsername,
+      platform: "twitter"
+    };
+    this.authToken = this.pendingUsername.token;
+    if (typeof localStorage !== "undefined") {
+      localStorage.setItem("followgate_token", this.authToken);
+      localStorage.setItem("followgate_user", JSON.stringify(this.currentUser));
+      localStorage.removeItem("followgate_pending_username");
+    }
+    this.pendingUsername = null;
+    this.emit("authenticated", this.currentUser);
+    if (this.config?.debug) {
+      console.log("[FollowGate] Username set manually:", normalizedUsername);
+    }
+  }
+  /**
+   * Handle auth callback from URL params
+   */
+  handleAuthCallback() {
+    if (typeof window === "undefined") return;
+    const params = new URLSearchParams(window.location.search);
+    const token = params.get("followgate_token");
+    const username = params.get("followgate_user");
+    const needsUsername = params.get("followgate_needs_username") === "true";
+    if (token && needsUsername) {
+      this.pendingUsername = {
+        needsUsername: true,
+        token
+      };
+      if (typeof localStorage !== "undefined") {
+        localStorage.setItem(
+          "followgate_pending_username",
+          JSON.stringify(this.pendingUsername)
+        );
+      }
+      const url = new URL(window.location.href);
+      url.searchParams.delete("followgate_token");
+      url.searchParams.delete("followgate_needs_username");
+      window.history.replaceState({}, "", url.toString());
+      if (this.config?.debug) {
+        console.log("[FollowGate] OAuth successful, username input needed");
+      }
+    } else if (token && username) {
+      this.authToken = token;
+      this.currentUser = {
+        userId: "",
+        // Will be set from token verification
+        username,
+        platform: "twitter"
+      };
+      if (typeof localStorage !== "undefined") {
+        localStorage.setItem("followgate_token", token);
+        localStorage.setItem(
+          "followgate_user",
+          JSON.stringify(this.currentUser)
+        );
+      }
+      const url = new URL(window.location.href);
+      url.searchParams.delete("followgate_token");
+      url.searchParams.delete("followgate_user");
+      window.history.replaceState({}, "", url.toString());
+      this.emit("authenticated", this.currentUser);
+      if (this.config?.debug) {
+        console.log("[FollowGate] User authenticated:", username);
+      }
+    }
+  }
+  /**
+   * Restore session from localStorage
+   */
+  restoreSession() {
+    if (typeof localStorage === "undefined") return;
+    const pendingJson = localStorage.getItem("followgate_pending_username");
+    if (pendingJson) {
+      try {
+        this.pendingUsername = JSON.parse(pendingJson);
+        if (this.config?.debug) {
+          console.log("[FollowGate] Restored pending username state");
+        }
+        return;
+      } catch {
+        localStorage.removeItem("followgate_pending_username");
+      }
+    }
+    const token = localStorage.getItem("followgate_token");
+    const userJson = localStorage.getItem("followgate_user");
+    if (token && userJson) {
+      try {
+        this.authToken = token;
+        this.currentUser = JSON.parse(userJson);
+      } catch {
+        localStorage.removeItem("followgate_token");
+        localStorage.removeItem("followgate_user");
+      }
     }
   }
   /**

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@followgate/js",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "FollowGate SDK - Grow your audience with every download. Require social actions (follow, repost) before users can access your app.",
-  "author": "FollowGate <hello@followgate.io>",
-  "homepage": "https://followgate.io",
+  "author": "FollowGate <hello@followgate.app>",
+  "homepage": "https://followgate.app",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -43,7 +43,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/JustFF5/FollowGate.git",
+    "url": "git+https://github.com/JustFF5/FollowGate.git",
     "directory": "packages/sdk"
   },
   "bugs": {