@followgate/js 0.15.3 → 0.15.5

package/README.md

@@ -12,7 +12,7 @@ npm install @followgate/js
 
 ## Quick Start (Built-in Modal)
 
-Just 10 lines of code - no custom UI needed:
+Just a few lines of code - no custom UI needed:
 
 ```typescript
 import { FollowGate } from '@followgate/js';
@@ -21,10 +21,8 @@ import { FollowGate } from '@followgate/js';
 FollowGate.init({
   appId: 'your-app-id',
   apiKey: 'fg_live_xxx',
-  twitter: {
-    handle: 'your_twitter_handle',
-    tweetId: '1234567890', // Optional: require repost
-  },
+  userId: user.id, // Recommended for server-side verification
+  // Target handle is configured in the Dashboard - no code needed!
   onComplete: () => {
     // User completed all actions - redirect to your app
     router.push('/dashboard');
@@ -39,8 +37,10 @@ The SDK renders a beautiful, fully-functional modal with:
 
 - Username input step
 - Follow action with intent URL
-- Repost action (optional)
-- Confirmation step
+- Repost action (optional, configured in Dashboard)
+- Confirmation step with custom text support
+- X button to close/cancel (redirects to `cancelUrl` if configured)
+- Dark/light themes
 - All styling included (no CSS needed)
 
 ## When to Show the Modal
@@ -69,10 +69,10 @@ if (!FollowGate.isUnlocked()) {
 FollowGate.init({
   appId: 'your-app-id',
   apiKey: 'fg_live_xxx',
-  twitter: { handle: 'your_handle' },
+  // Handle configured in Dashboard!
 
   onComplete: async () => {
-    // ✅ User completed all steps - NOW create the account!
+    // User completed all steps - NOW create the account!
     const user = FollowGate.getUser();
 
     await fetch('/api/create-account', {
@@ -119,10 +119,10 @@ If no username is passed, the modal shows a Welcome step where the user types th
 FollowGate.init({
   appId: 'your-app-id',
   apiKey: 'fg_live_xxx',
-  twitter: { handle: 'your_handle' },
+  // Handle configured in Dashboard!
 });
 
-FollowGate.show(); // → Modal starts with username input step
+FollowGate.show(); // Modal starts with username input step
 ```
 
 **Method 2: App passes username via code (skips Welcome step)**
@@ -133,12 +133,11 @@ FollowGate.init({
   appId: 'your-app-id',
   apiKey: 'fg_live_xxx',
   twitter: {
-    handle: 'your_handle',
-    username: 'their_x_username', // ← skips Welcome step
+    username: 'their_x_username', // skips Welcome step
   },
 });
 
-FollowGate.show(); // → Modal starts directly with Follow step
+FollowGate.show(); // Modal starts directly with Follow step
 ```
 
 > **Note:** No Twitter API calls are made in either case. The SDK uses intent URLs only.
@@ -151,16 +150,15 @@ FollowGate.init({
   appId: 'your-app-id', // Your App ID from the dashboard
   apiKey: 'fg_live_xxx', // Your API key (starts with fg_live_ or fg_test_)
 
-  // Twitter/X Configuration
+  // Twitter/X Configuration (all optional - configure in Dashboard!)
   twitter: {
-    handle: 'your_handle', // Your Twitter username (without @)
-    tweetId: '1234567890', // Tweet ID to repost (optional)
+    overrideHandle: 'other_handle', // Override Dashboard handle (highest priority)
+    overridePostUrl: 'https://x.com/user/status/123', // Override Dashboard post URL for repost
+    username: 'their_username', // Pre-fill user's X username (skips Welcome step)
   },
 
   // Callback when user completes all actions
   onComplete: () => {
-    // Called after the user finishes all steps and clicks "Got it"
-    // Typically used to redirect to your app
     router.push('/dashboard');
   },
 
@@ -170,9 +168,17 @@ FollowGate.init({
   accentColor: '#6366f1', // Customize primary button color (hex)
   theme: 'dark', // 'dark' | 'light' - modal appearance
   apiUrl: 'https://...', // Custom API URL (for self-hosted)
+  forceShow: false, // Always show modal, even if user already unlocked
 });
 ```
 
+**Dashboard Configuration:** Target handle, required actions, custom texts, redirect URLs, and skip options are all configured in the [Dashboard](https://followgate.app) and fetched automatically by the SDK.
+
+**Handle Priority:**
+
+1. `twitter.overrideHandle` (explicit code override - highest priority)
+2. Dashboard `targetHandle` (default)
+
 ### Handle & Target Formats
 
 The SDK automatically normalizes usernames - you can use `@username` or `username`, both work:
@@ -180,31 +186,34 @@ The SDK automatically normalizes usernames - you can use `@username` or `usernam
 | Platform     | Action | Target Format                       | Example                              |
 | ------------ | ------ | ----------------------------------- | ------------------------------------ |
 | **Twitter**  | follow | Username (without @)                | `lukasvanuden`                       |
-| **Twitter**  | repost | Tweet ID (numbers only)             | `1234567890123456789`                |
-| **Twitter**  | like   | Tweet ID (numbers only)             | `1234567890123456789`                |
+| **Twitter**  | repost | Post URL or Tweet ID                | `https://x.com/user/status/123`      |
+| **Twitter**  | like   | Post URL or Tweet ID                | `https://x.com/user/status/123`      |
 | **Bluesky**  | follow | Handle (with or without @)          | `user.bsky.social`                   |
 | **Bluesky**  | repost | AT URI or post path                 | `user.bsky.social/post/xyz`          |
 | **LinkedIn** | follow | Company name or prefixed identifier | `company:anthropic` or `in:username` |
 
-**Tip:** For Twitter, you can find the Tweet ID in the URL: `https://x.com/user/status/1234567890123456789`
-
 ## API Reference
 
 ### Modal Methods
 
 ```typescript
-// Show the FollowGate modal
+// Show the FollowGate modal (async - fetches config first)
 // If user is already unlocked, calls onComplete immediately
-FollowGate.show();
+await FollowGate.show();
 
 // Hide the modal programmatically
+// Pass true to redirect to cancelUrl (if configured)
 FollowGate.hide();
+FollowGate.hide(true); // redirect to cancelUrl
 
 // Check if user has completed all actions
 FollowGate.isUnlocked(); // true | false
 
 // Reset user's session (for testing)
 FollowGate.reset();
+
+// Clear only unlock status, keep user data (v0.13.0+)
+FollowGate.clearUnlockStatus();
 ```
 
 ### Advanced Usage
@@ -287,16 +296,16 @@ FollowGate.init({
   appId: 'your-app-id',
   apiKey: 'fg_live_xxx',
   userId: clerkUserId,
-  twitter: { handle: 'lukasvanuden' },
+  // Handle configured in Dashboard!
 });
 
 const isVerified = await FollowGate.isVerified();
 
 if (isVerified) {
-  // User completed FollowGate → Full access
+  // User completed FollowGate - Full access
   enableAllFeatures();
 } else {
-  // User hasn't completed → Limited access
+  // User hasn't completed - Limited access
   enableTrialMode();
 }
 ```
@@ -347,7 +356,7 @@ export default function WelcomePage() {
     FollowGate.init({
       appId: process.env.NEXT_PUBLIC_FOLLOWGATE_APP_ID!,
       apiKey: process.env.NEXT_PUBLIC_FOLLOWGATE_API_KEY!,
-      twitter: { handle: 'your_handle' },
+      // Handle configured in Dashboard!
       onComplete: () => router.push('/dashboard'),
     });
 
@@ -385,7 +394,7 @@ export default function WelcomePage() {
       appId: process.env.NEXT_PUBLIC_FOLLOWGATE_APP_ID!,
       apiKey: process.env.NEXT_PUBLIC_FOLLOWGATE_API_KEY!,
       userId: user.id, // Per-user unlock status (recommended!)
-      twitter: { handle: 'lukasvanuden' },
+      // Handle configured in Dashboard!
       onComplete: () => router.push('/dashboard'),
     });
 
@@ -421,17 +430,12 @@ import type {
 
 ## Pricing
 
-| 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 |
+**FollowGate is 100% free.** No tiers, no limits, no billing. Use it for as many apps and users as you want.
 
 ## Links
 
 - [Dashboard](https://followgate.app)
-- [Documentation](https://docs.followgate.app)
+- [Documentation](https://followgate.app/docs)
 - [GitHub](https://github.com/JustFF5/FollowGate)
 - [Live Demo](https://follow-gate-web-demo.vercel.app)
 

package/dist/index.d.mts

@@ -5,7 +5,7 @@ type Platform = 'twitter' | 'bluesky' | 'linkedin';
 /**
  * Supported social actions
  */
-type SocialAction = 'follow' | 'repost' | 'like';
+type SocialAction = 'follow' | 'repost';
 /**
  * Twitter/X configuration
  */
@@ -178,7 +178,6 @@ declare class FollowGateClient {
     clearUnlockStatus(): void;
     getFollowUrl(platform: Platform, target: string): string;
     getRepostUrl(platform: Platform, target: string): string;
-    getLikeUrl(platform: Platform, target: string): string;
     openIntent(options: CompleteOptions): Promise<void>;
     complete(options: CompleteOptions): Promise<void>;
     unlock(): Promise<void>;

package/dist/index.d.ts

@@ -5,7 +5,7 @@ type Platform = 'twitter' | 'bluesky' | 'linkedin';
 /**
  * Supported social actions
  */
-type SocialAction = 'follow' | 'repost' | 'like';
+type SocialAction = 'follow' | 'repost';
 /**
  * Twitter/X configuration
  */
@@ -178,7 +178,6 @@ declare class FollowGateClient {
     clearUnlockStatus(): void;
     getFollowUrl(platform: Platform, target: string): string;
     getRepostUrl(platform: Platform, target: string): string;
-    getLikeUrl(platform: Platform, target: string): string;
     openIntent(options: CompleteOptions): Promise<void>;
     complete(options: CompleteOptions): Promise<void>;
     unlock(): Promise<void>;

package/dist/index.js

@@ -614,11 +614,13 @@ var FollowGateClient = class {
           );
         }
       } else {
-        console.warn(
-          "[FollowGate] Modal skipped - user already unlocked.",
-          "Use forceShow: true in init() to always show modal, or call FollowGate.reset() to clear.",
-          this.config.userId ? `(userId: ${this.config.userId})` : "(no userId set)"
-        );
+        if (this.config.debug) {
+          console.warn(
+            "[FollowGate] Modal skipped - user already unlocked.",
+            "Use forceShow: true in init() to always show modal, or call FollowGate.reset() to clear.",
+            this.config.userId ? `(userId: ${this.config.userId})` : "(no userId set)"
+          );
+        }
         this.config.onComplete?.();
         return;
       }
@@ -768,11 +770,13 @@ var FollowGateClient = class {
     const postUrl = this.getTargetPostUrl();
     const actionsIncludeRepost = this.serverConfig?.actions?.includes("repost");
     if (actionsIncludeRepost && !postUrl) {
-      console.warn(
-        "[FollowGate] REPOST action configured but no targetPostUrl available.",
-        "Set targetPostUrl in Dashboard or use overridePostUrl in config.",
-        "Skipping repost step."
-      );
+      if (this.config?.debug) {
+        console.warn(
+          "[FollowGate] REPOST action configured but no targetPostUrl available.",
+          "Set targetPostUrl in Dashboard or use overridePostUrl in config.",
+          "Skipping repost step."
+        );
+      }
       return false;
     }
     if (this.config?.twitter?.tweetId) {
@@ -846,16 +850,16 @@ var FollowGateClient = class {
     this.trackEvent("step_viewed", { step: "follow" });
     const handle = this.getTargetHandle();
     if (!handle) {
-      console.error(
-        "[FollowGate] No target handle configured. Set it in Dashboard or use overrideHandle."
-      );
+      if (this.config?.debug) {
+        console.error(
+          "[FollowGate] No target handle configured. Set it in Dashboard or use overrideHandle."
+        );
+      }
       return;
     }
     const hasRepost = this.shouldShowRepostStep();
-    const defaultTitle = hasRepost ? "Step 1: Follow" : "Follow to Continue";
-    const defaultMessage = `Follow @${handle} on X`;
-    const title = this.serverConfig?.welcomeTitle || defaultTitle;
-    const message = this.serverConfig?.welcomeMessage || defaultMessage;
+    const title = hasRepost ? "Step 1: Follow" : "Follow to Continue";
+    const message = `Follow @${handle} on X`;
     content.innerHTML = `
       ${hasRepost ? this.renderStepIndicator(1) : ""}
       <div class="fg-icon-box">
@@ -1100,14 +1104,14 @@ var FollowGateClient = class {
           </div>
         ` : ""}
       </div>
-      <p class="fg-verify-hint">Verification may take some time</p>
-      <p style="color: rgba(250, 204, 21, 0.85); font-size: 11px; margin: 8px 0 10px; text-align: center;">Access may be revoked if actions are not completed.</p>
+      <p class="fg-verify-hint" style="margin-bottom: 32px;">Verification may take some time</p>
+      <p style="color: rgba(250, 204, 21, 0.85); font-size: 11px; margin: 0 0 10px; text-align: center;">Access may be revoked if actions are not completed.</p>
       <button class="fg-btn fg-btn-green" id="fg-finish-btn">
         ${ICONS.check}
-        Got it - Get access
+        Got it - Get access now!
       </button>
       ${hasFollow || hasRepost ? `
-        <p style="color: rgba(255,255,255,0.4); font-size: 11px; margin: 24px 0 6px; text-align: center;">Missed something? Open again:</p>
+        <p style="color: rgba(255,255,255,0.4); font-size: 11px; margin: 24px 0 0; text-align: center;">Missed something? Open again:</p>
         <div class="fg-btn-row">
           ${hasFollow ? `
             <button class="fg-btn fg-btn-secondary" id="fg-redo-follow">
@@ -1242,9 +1246,6 @@ var FollowGateClient = class {
   getRepostUrl(platform, target) {
     return this.buildIntentUrl({ platform, action: "repost", target });
   }
-  getLikeUrl(platform, target) {
-    return this.buildIntentUrl({ platform, action: "like", target });
-  }
   async openIntent(options) {
     if (!this.config) {
       throw new Error("[FollowGate] SDK not initialized. Call init() first.");
@@ -1523,8 +1524,6 @@ var FollowGateClient = class {
         return `https://twitter.com/intent/follow?screen_name=${encodeURIComponent(target)}`;
       case "repost":
         return `https://twitter.com/intent/retweet?tweet_id=${encodeURIComponent(target)}`;
-      case "like":
-        return `https://twitter.com/intent/like?tweet_id=${encodeURIComponent(target)}`;
       default:
         throw new Error(`[FollowGate] Unsupported Twitter action: ${action}`);
     }
@@ -1535,7 +1534,6 @@ var FollowGateClient = class {
       case "follow":
         return `https://bsky.app/profile/${encodeURIComponent(normalizedTarget)}`;
       case "repost":
-      case "like":
         if (target.startsWith("at://") || target.includes("/post/")) {
           const postPath = target.replace("at://", "").replace("app.bsky.feed.post/", "post/");
           return `https://bsky.app/profile/${postPath}`;

package/dist/index.mjs

@@ -588,11 +588,13 @@ var FollowGateClient = class {
           );
         }
       } else {
-        console.warn(
-          "[FollowGate] Modal skipped - user already unlocked.",
-          "Use forceShow: true in init() to always show modal, or call FollowGate.reset() to clear.",
-          this.config.userId ? `(userId: ${this.config.userId})` : "(no userId set)"
-        );
+        if (this.config.debug) {
+          console.warn(
+            "[FollowGate] Modal skipped - user already unlocked.",
+            "Use forceShow: true in init() to always show modal, or call FollowGate.reset() to clear.",
+            this.config.userId ? `(userId: ${this.config.userId})` : "(no userId set)"
+          );
+        }
         this.config.onComplete?.();
         return;
       }
@@ -742,11 +744,13 @@ var FollowGateClient = class {
     const postUrl = this.getTargetPostUrl();
     const actionsIncludeRepost = this.serverConfig?.actions?.includes("repost");
     if (actionsIncludeRepost && !postUrl) {
-      console.warn(
-        "[FollowGate] REPOST action configured but no targetPostUrl available.",
-        "Set targetPostUrl in Dashboard or use overridePostUrl in config.",
-        "Skipping repost step."
-      );
+      if (this.config?.debug) {
+        console.warn(
+          "[FollowGate] REPOST action configured but no targetPostUrl available.",
+          "Set targetPostUrl in Dashboard or use overridePostUrl in config.",
+          "Skipping repost step."
+        );
+      }
       return false;
     }
     if (this.config?.twitter?.tweetId) {
@@ -820,16 +824,16 @@ var FollowGateClient = class {
     this.trackEvent("step_viewed", { step: "follow" });
     const handle = this.getTargetHandle();
     if (!handle) {
-      console.error(
-        "[FollowGate] No target handle configured. Set it in Dashboard or use overrideHandle."
-      );
+      if (this.config?.debug) {
+        console.error(
+          "[FollowGate] No target handle configured. Set it in Dashboard or use overrideHandle."
+        );
+      }
       return;
     }
     const hasRepost = this.shouldShowRepostStep();
-    const defaultTitle = hasRepost ? "Step 1: Follow" : "Follow to Continue";
-    const defaultMessage = `Follow @${handle} on X`;
-    const title = this.serverConfig?.welcomeTitle || defaultTitle;
-    const message = this.serverConfig?.welcomeMessage || defaultMessage;
+    const title = hasRepost ? "Step 1: Follow" : "Follow to Continue";
+    const message = `Follow @${handle} on X`;
     content.innerHTML = `
       ${hasRepost ? this.renderStepIndicator(1) : ""}
       <div class="fg-icon-box">
@@ -1074,14 +1078,14 @@ var FollowGateClient = class {
           </div>
         ` : ""}
       </div>
-      <p class="fg-verify-hint">Verification may take some time</p>
-      <p style="color: rgba(250, 204, 21, 0.85); font-size: 11px; margin: 8px 0 10px; text-align: center;">Access may be revoked if actions are not completed.</p>
+      <p class="fg-verify-hint" style="margin-bottom: 32px;">Verification may take some time</p>
+      <p style="color: rgba(250, 204, 21, 0.85); font-size: 11px; margin: 0 0 10px; text-align: center;">Access may be revoked if actions are not completed.</p>
       <button class="fg-btn fg-btn-green" id="fg-finish-btn">
         ${ICONS.check}
-        Got it - Get access
+        Got it - Get access now!
       </button>
       ${hasFollow || hasRepost ? `
-        <p style="color: rgba(255,255,255,0.4); font-size: 11px; margin: 24px 0 6px; text-align: center;">Missed something? Open again:</p>
+        <p style="color: rgba(255,255,255,0.4); font-size: 11px; margin: 24px 0 0; text-align: center;">Missed something? Open again:</p>
         <div class="fg-btn-row">
           ${hasFollow ? `
             <button class="fg-btn fg-btn-secondary" id="fg-redo-follow">
@@ -1216,9 +1220,6 @@ var FollowGateClient = class {
   getRepostUrl(platform, target) {
     return this.buildIntentUrl({ platform, action: "repost", target });
   }
-  getLikeUrl(platform, target) {
-    return this.buildIntentUrl({ platform, action: "like", target });
-  }
   async openIntent(options) {
     if (!this.config) {
       throw new Error("[FollowGate] SDK not initialized. Call init() first.");
@@ -1497,8 +1498,6 @@ var FollowGateClient = class {
         return `https://twitter.com/intent/follow?screen_name=${encodeURIComponent(target)}`;
       case "repost":
         return `https://twitter.com/intent/retweet?tweet_id=${encodeURIComponent(target)}`;
-      case "like":
-        return `https://twitter.com/intent/like?tweet_id=${encodeURIComponent(target)}`;
       default:
         throw new Error(`[FollowGate] Unsupported Twitter action: ${action}`);
     }
@@ -1509,7 +1508,6 @@ var FollowGateClient = class {
       case "follow":
         return `https://bsky.app/profile/${encodeURIComponent(normalizedTarget)}`;
       case "repost":
-      case "like":
         if (target.startsWith("at://") || target.includes("/post/")) {
           const postPath = target.replace("at://", "").replace("app.bsky.feed.post/", "post/");
           return `https://bsky.app/profile/${postPath}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@followgate/js",
-  "version": "0.15.3",
+  "version": "0.15.5",
   "description": "FollowGate SDK - Grow your audience with every download. Require social actions (follow, repost) before users can access your app.",
   "author": "FollowGate <hello@followgate.app>",
   "homepage": "https://followgate.app",