@followgate/js 0.1.0

package/README.md

@@ -0,0 +1,159 @@
+# @followgate/js
+
+**Grow your audience with every download.** Require social actions (follow, repost) before users can access your app.
+
+FollowGate is inspired by [Hypeddit](https://hypeddit.com) (for musicians), but built for software developers and app creators.
+
+## Installation
+
+```bash
+npm install @followgate/js
+```
+
+## Quick Start
+
+```typescript
+import { FollowGate } from '@followgate/js';
+
+// Initialize with your API credentials (get them at https://app.followgate.io)
+FollowGate.init({
+  appId: 'your-app-id',
+  apiKey: 'fg_live_xxx',
+});
+
+// Require a Twitter follow before granting access
+FollowGate.open({
+  platform: 'twitter',
+  action: 'follow',
+  target: 'yourusername',
+  userId: 'user-123', // Optional: your app's user ID for tracking
+});
+```
+
+## Supported Platforms
+
+| Platform | Actions |
+|----------|---------|
+| Twitter/X | `follow`, `repost`, `like` |
+| Bluesky | `follow`, `repost`, `like` |
+| LinkedIn | `follow` |
+
+## API Reference
+
+### `FollowGate.init(config)`
+
+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
+});
+```
+
+### `FollowGate.open(options)`
+
+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
+});
+```
+
+### `FollowGate.verify(options)`
+
+Verify if a user completed the action (Pro/Business tiers with OAuth).
+
+```typescript
+const isVerified = await FollowGate.verify({
+  platform: 'twitter',
+  action: 'follow',
+  target: 'yourusername',
+  userId: 'user-123',
+});
+```
+
+### `FollowGate.on(event, callback)`
+
+Listen for events.
+
+```typescript
+FollowGate.on('complete', (data) => {
+  console.log('User completed action:', data);
+  // Grant access to your app
+});
+
+FollowGate.on('error', (error) => {
+  console.error('Error:', error);
+});
+```
+
+## Platform-Specific Notes
+
+### Twitter/X
+
+- `target` for `follow`: Twitter username (without @)
+- `target` for `repost`/`like`: Tweet ID
+
+```typescript
+// Follow
+FollowGate.open({ platform: 'twitter', action: 'follow', target: 'elonmusk' });
+
+// Repost a tweet
+FollowGate.open({ platform: 'twitter', action: 'repost', target: '1234567890' });
+```
+
+### Bluesky
+
+- `target` for `follow`: Bluesky handle (e.g., `alice.bsky.social`)
+- `target` for `repost`/`like`: Post path (e.g., `alice.bsky.social/post/xxx`)
+
+```typescript
+// Follow
+FollowGate.open({ platform: 'bluesky', action: 'follow', target: 'alice.bsky.social' });
+```
+
+### LinkedIn
+
+- `target` for `follow`: Company name or `in:username` for personal profiles
+
+```typescript
+// Follow a company
+FollowGate.open({ platform: 'linkedin', action: 'follow', target: 'microsoft' });
+
+// Follow a personal profile
+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 |
+| Business | $99/mo | 5,000+ | Daily verification |
+
+## TypeScript
+
+Full TypeScript support included. Types are exported:
+
+```typescript
+import type { Platform, SocialAction, FollowGateConfig } from '@followgate/js';
+```
+
+## Links
+
+- [Dashboard](https://app.followgate.io)
+- [Documentation](https://followgate.io/docs)
+- [GitHub](https://github.com/JustFF5/FollowGate)
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,80 @@
+/**
+ * Supported social platforms
+ */
+type Platform = 'twitter' | 'bluesky' | 'linkedin';
+/**
+ * Supported social actions
+ */
+type SocialAction = 'follow' | 'repost' | 'like';
+/**
+ * SDK Configuration
+ */
+interface FollowGateConfig {
+    appId: string;
+    apiKey: string;
+    apiUrl?: string;
+    debug?: boolean;
+}
+/**
+ * Open action options
+ */
+interface OpenOptions {
+    platform: Platform;
+    action: SocialAction;
+    target: string;
+    userId?: string;
+}
+/**
+ * LinkedIn target type
+ */
+type LinkedInTargetType = 'company' | 'profile';
+/**
+ * Event types
+ */
+type EventType = 'complete' | 'error' | 'cancel';
+/**
+ * Event callback
+ */
+type EventCallback = (data: unknown) => void;
+/**
+ * FollowGate SDK Client
+ */
+declare class FollowGateClient {
+    private config;
+    private listeners;
+    /**
+     * Initialize the SDK
+     */
+    init(config: FollowGateConfig): void;
+    /**
+     * Open social action popup
+     */
+    open(options: OpenOptions): Promise<void>;
+    /**
+     * Verify follow status (for Pro/Business tiers with OAuth)
+     */
+    verify(options: OpenOptions): Promise<boolean>;
+    /**
+     * Track analytics event
+     */
+    private trackEvent;
+    /**
+     * Register event listener
+     */
+    on(event: EventType, callback: EventCallback): void;
+    /**
+     * Remove event listener
+     */
+    off(event: EventType, callback: EventCallback): void;
+    /**
+     * Build intent URL for platform
+     */
+    private buildIntentUrl;
+    private buildTwitterUrl;
+    private buildBlueskyUrl;
+    private buildLinkedInUrl;
+    private emit;
+}
+declare const FollowGate: FollowGateClient;
+
+export { type EventCallback, type EventType, FollowGate, FollowGateClient, type FollowGateConfig, type LinkedInTargetType, type OpenOptions, type Platform, type SocialAction };

package/dist/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Supported social platforms
+ */
+type Platform = 'twitter' | 'bluesky' | 'linkedin';
+/**
+ * Supported social actions
+ */
+type SocialAction = 'follow' | 'repost' | 'like';
+/**
+ * SDK Configuration
+ */
+interface FollowGateConfig {
+    appId: string;
+    apiKey: string;
+    apiUrl?: string;
+    debug?: boolean;
+}
+/**
+ * Open action options
+ */
+interface OpenOptions {
+    platform: Platform;
+    action: SocialAction;
+    target: string;
+    userId?: string;
+}
+/**
+ * LinkedIn target type
+ */
+type LinkedInTargetType = 'company' | 'profile';
+/**
+ * Event types
+ */
+type EventType = 'complete' | 'error' | 'cancel';
+/**
+ * Event callback
+ */
+type EventCallback = (data: unknown) => void;
+/**
+ * FollowGate SDK Client
+ */
+declare class FollowGateClient {
+    private config;
+    private listeners;
+    /**
+     * Initialize the SDK
+     */
+    init(config: FollowGateConfig): void;
+    /**
+     * Open social action popup
+     */
+    open(options: OpenOptions): Promise<void>;
+    /**
+     * Verify follow status (for Pro/Business tiers with OAuth)
+     */
+    verify(options: OpenOptions): Promise<boolean>;
+    /**
+     * Track analytics event
+     */
+    private trackEvent;
+    /**
+     * Register event listener
+     */
+    on(event: EventType, callback: EventCallback): void;
+    /**
+     * Remove event listener
+     */
+    off(event: EventType, callback: EventCallback): void;
+    /**
+     * Build intent URL for platform
+     */
+    private buildIntentUrl;
+    private buildTwitterUrl;
+    private buildBlueskyUrl;
+    private buildLinkedInUrl;
+    private emit;
+}
+declare const FollowGate: FollowGateClient;
+
+export { type EventCallback, type EventType, FollowGate, FollowGateClient, type FollowGateConfig, type LinkedInTargetType, type OpenOptions, type Platform, type SocialAction };

package/dist/index.js

@@ -0,0 +1,208 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  FollowGate: () => FollowGate,
+  FollowGateClient: () => FollowGateClient
+});
+module.exports = __toCommonJS(index_exports);
+var DEFAULT_API_URL = "https://api.followgate.io";
+var FollowGateClient = class {
+  config = null;
+  listeners = /* @__PURE__ */ new Map();
+  /**
+   * Initialize the SDK
+   */
+  init(config) {
+    this.config = {
+      ...config,
+      apiUrl: config.apiUrl || DEFAULT_API_URL
+    };
+    if (config.debug) {
+      console.log("[FollowGate] Initialized with appId:", config.appId);
+    }
+  }
+  /**
+   * Open social action popup
+   */
+  async open(options) {
+    if (!this.config) {
+      throw new Error("[FollowGate] SDK not initialized. Call init() first.");
+    }
+    const url = this.buildIntentUrl(options);
+    if (this.config.debug) {
+      console.log("[FollowGate] Opening:", url);
+    }
+    await this.trackEvent("gate_opened", options);
+    const popup = window.open(url, "_blank", "width=600,height=700");
+    if (!popup) {
+      this.emit("error", { message: "Popup blocked" });
+      return;
+    }
+    await this.trackEvent("action_clicked", options);
+    this.emit("complete", {
+      platform: options.platform,
+      action: options.action,
+      target: options.target
+    });
+  }
+  /**
+   * Verify follow status (for Pro/Business tiers with OAuth)
+   */
+  async verify(options) {
+    if (!this.config) {
+      throw new Error("[FollowGate] SDK not initialized. Call init() first.");
+    }
+    try {
+      const response = await fetch(`${this.config.apiUrl}/api/v1/verify`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "X-API-Key": this.config.apiKey
+        },
+        body: JSON.stringify({
+          platform: options.platform,
+          action: options.action,
+          target: options.target,
+          externalUserId: options.userId
+        })
+      });
+      const data = await response.json();
+      return data.success && data.data?.verified === true;
+    } catch (error) {
+      if (this.config.debug) {
+        console.error("[FollowGate] Verification error:", error);
+      }
+      return false;
+    }
+  }
+  /**
+   * Track analytics event
+   */
+  async trackEvent(event, options) {
+    if (!this.config) return;
+    try {
+      await fetch(`${this.config.apiUrl}/api/v1/events`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "X-API-Key": this.config.apiKey
+        },
+        body: JSON.stringify({
+          event,
+          platform: options.platform,
+          action: options.action,
+          target: options.target,
+          externalUserId: options.userId
+        })
+      });
+    } catch (error) {
+      if (this.config.debug) {
+        console.warn("[FollowGate] Failed to track event:", error);
+      }
+    }
+  }
+  /**
+   * Register event listener
+   */
+  on(event, callback) {
+    if (!this.listeners.has(event)) {
+      this.listeners.set(event, /* @__PURE__ */ new Set());
+    }
+    this.listeners.get(event).add(callback);
+  }
+  /**
+   * Remove event listener
+   */
+  off(event, callback) {
+    this.listeners.get(event)?.delete(callback);
+  }
+  /**
+   * Build intent URL for platform
+   */
+  buildIntentUrl(options) {
+    const { platform, action, target } = options;
+    switch (platform) {
+      case "twitter":
+        return this.buildTwitterUrl(action, target);
+      case "bluesky":
+        return this.buildBlueskyUrl(action, target);
+      case "linkedin":
+        return this.buildLinkedInUrl(action, target);
+      default:
+        throw new Error(`[FollowGate] Unsupported platform: ${platform}`);
+    }
+  }
+  buildTwitterUrl(action, target) {
+    switch (action) {
+      case "follow":
+        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}`);
+    }
+  }
+  buildBlueskyUrl(action, target) {
+    const normalizedTarget = target.startsWith("@") ? target.slice(1) : target;
+    switch (action) {
+      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}`;
+        }
+        return `https://bsky.app/profile/${encodeURIComponent(normalizedTarget)}`;
+      default:
+        throw new Error(`[FollowGate] Unsupported Bluesky action: ${action}`);
+    }
+  }
+  buildLinkedInUrl(action, target) {
+    switch (action) {
+      case "follow": {
+        if (target.startsWith("in:")) {
+          const username = target.slice(3);
+          return `https://www.linkedin.com/in/${encodeURIComponent(username)}`;
+        } else if (target.startsWith("company:")) {
+          const company = target.slice(8);
+          return `https://www.linkedin.com/company/${encodeURIComponent(company)}`;
+        } else {
+          return `https://www.linkedin.com/company/${encodeURIComponent(target)}`;
+        }
+      }
+      default:
+        throw new Error(`[FollowGate] Unsupported LinkedIn action: ${action}`);
+    }
+  }
+  emit(event, data) {
+    this.listeners.get(event)?.forEach((callback) => callback(data));
+  }
+};
+var FollowGate = new FollowGateClient();
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FollowGate,
+  FollowGateClient
+});

package/dist/index.mjs

@@ -0,0 +1,182 @@
+// src/index.ts
+var DEFAULT_API_URL = "https://api.followgate.io";
+var FollowGateClient = class {
+  config = null;
+  listeners = /* @__PURE__ */ new Map();
+  /**
+   * Initialize the SDK
+   */
+  init(config) {
+    this.config = {
+      ...config,
+      apiUrl: config.apiUrl || DEFAULT_API_URL
+    };
+    if (config.debug) {
+      console.log("[FollowGate] Initialized with appId:", config.appId);
+    }
+  }
+  /**
+   * Open social action popup
+   */
+  async open(options) {
+    if (!this.config) {
+      throw new Error("[FollowGate] SDK not initialized. Call init() first.");
+    }
+    const url = this.buildIntentUrl(options);
+    if (this.config.debug) {
+      console.log("[FollowGate] Opening:", url);
+    }
+    await this.trackEvent("gate_opened", options);
+    const popup = window.open(url, "_blank", "width=600,height=700");
+    if (!popup) {
+      this.emit("error", { message: "Popup blocked" });
+      return;
+    }
+    await this.trackEvent("action_clicked", options);
+    this.emit("complete", {
+      platform: options.platform,
+      action: options.action,
+      target: options.target
+    });
+  }
+  /**
+   * Verify follow status (for Pro/Business tiers with OAuth)
+   */
+  async verify(options) {
+    if (!this.config) {
+      throw new Error("[FollowGate] SDK not initialized. Call init() first.");
+    }
+    try {
+      const response = await fetch(`${this.config.apiUrl}/api/v1/verify`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "X-API-Key": this.config.apiKey
+        },
+        body: JSON.stringify({
+          platform: options.platform,
+          action: options.action,
+          target: options.target,
+          externalUserId: options.userId
+        })
+      });
+      const data = await response.json();
+      return data.success && data.data?.verified === true;
+    } catch (error) {
+      if (this.config.debug) {
+        console.error("[FollowGate] Verification error:", error);
+      }
+      return false;
+    }
+  }
+  /**
+   * Track analytics event
+   */
+  async trackEvent(event, options) {
+    if (!this.config) return;
+    try {
+      await fetch(`${this.config.apiUrl}/api/v1/events`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "X-API-Key": this.config.apiKey
+        },
+        body: JSON.stringify({
+          event,
+          platform: options.platform,
+          action: options.action,
+          target: options.target,
+          externalUserId: options.userId
+        })
+      });
+    } catch (error) {
+      if (this.config.debug) {
+        console.warn("[FollowGate] Failed to track event:", error);
+      }
+    }
+  }
+  /**
+   * Register event listener
+   */
+  on(event, callback) {
+    if (!this.listeners.has(event)) {
+      this.listeners.set(event, /* @__PURE__ */ new Set());
+    }
+    this.listeners.get(event).add(callback);
+  }
+  /**
+   * Remove event listener
+   */
+  off(event, callback) {
+    this.listeners.get(event)?.delete(callback);
+  }
+  /**
+   * Build intent URL for platform
+   */
+  buildIntentUrl(options) {
+    const { platform, action, target } = options;
+    switch (platform) {
+      case "twitter":
+        return this.buildTwitterUrl(action, target);
+      case "bluesky":
+        return this.buildBlueskyUrl(action, target);
+      case "linkedin":
+        return this.buildLinkedInUrl(action, target);
+      default:
+        throw new Error(`[FollowGate] Unsupported platform: ${platform}`);
+    }
+  }
+  buildTwitterUrl(action, target) {
+    switch (action) {
+      case "follow":
+        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}`);
+    }
+  }
+  buildBlueskyUrl(action, target) {
+    const normalizedTarget = target.startsWith("@") ? target.slice(1) : target;
+    switch (action) {
+      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}`;
+        }
+        return `https://bsky.app/profile/${encodeURIComponent(normalizedTarget)}`;
+      default:
+        throw new Error(`[FollowGate] Unsupported Bluesky action: ${action}`);
+    }
+  }
+  buildLinkedInUrl(action, target) {
+    switch (action) {
+      case "follow": {
+        if (target.startsWith("in:")) {
+          const username = target.slice(3);
+          return `https://www.linkedin.com/in/${encodeURIComponent(username)}`;
+        } else if (target.startsWith("company:")) {
+          const company = target.slice(8);
+          return `https://www.linkedin.com/company/${encodeURIComponent(company)}`;
+        } else {
+          return `https://www.linkedin.com/company/${encodeURIComponent(target)}`;
+        }
+      }
+      default:
+        throw new Error(`[FollowGate] Unsupported LinkedIn action: ${action}`);
+    }
+  }
+  emit(event, data) {
+    this.listeners.get(event)?.forEach((callback) => callback(data));
+  }
+};
+var FollowGate = new FollowGateClient();
+export {
+  FollowGate,
+  FollowGateClient
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@followgate/js",
+  "version": "0.1.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",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "dev": "tsup src/index.ts --watch",
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "tsup": "^8.0.0"
+  },
+  "keywords": [
+    "followgate",
+    "social",
+    "follow",
+    "twitter",
+    "x",
+    "bluesky",
+    "linkedin",
+    "growth",
+    "audience",
+    "sdk",
+    "social-gate"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JustFF5/FollowGate.git",
+    "directory": "packages/sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/JustFF5/FollowGate/issues"
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}