@uncover/sdk 0.1.1 → 0.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uncover/sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "JavaScript SDK for Uncover API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,9 +14,16 @@
     "build": "tsc",
     "dev": "tsc --watch"
   },
-  "keywords": ["uncover", "api", "sdk"],
-  "author": "",
+  "keywords": [
+    "uncover",
+    "api",
+    "sdk"
+  ],
+  "author": "Alexander Wondwossen <alex@thealxlabs.ca>",
   "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@types/node": "^20.10.6",
     "typescript": "^5.3.3"

package/src/client.ts

@@ -4,14 +4,11 @@ export class Uncover {
   private apiKey: string;
   private baseUrl: string;
 
-  constructor(apiKey: string, baseUrl: string = "https://api.uncover.dev") {
+  constructor(apiKey: string, baseUrl = "https://api.uncover.dev") {
     this.apiKey = apiKey;
     this.baseUrl = baseUrl;
   }
 
-  /**
-   * Search for problems mentioned on Reddit/Twitter about a topic
-   */
   async search(request: SearchRequest): Promise<SearchResponse> {
     const response = await fetch(`${this.baseUrl}/api/search`, {
       method: "POST",
@@ -24,47 +21,37 @@ export class Uncover {
 
     if (!response.ok) {
       const error = await response.json();
-      throw new Error(`Search failed: ${error.error || "Unknown error"}`);
+      throw new Error(`Search failed: ${(error as any).error || "Unknown error"}`);
     }
 
     return response.json();
   }
 
-  /**
-   * Get the status and results of a search request
-   */
   async getSearchStatus(requestId: string): Promise<SearchStatusResponse> {
     const response = await fetch(`${this.baseUrl}/api/search/${requestId}`, {
-      headers: {
-        Authorization: `Bearer ${this.apiKey}`,
-      },
+      headers: { Authorization: `Bearer ${this.apiKey}` },
     });
 
     if (!response.ok) {
       const error = await response.json();
-      throw new Error(`Failed to get status: ${error.error || "Unknown error"}`);
+      throw new Error(`Failed to get status: ${(error as any).error || "Unknown error"}`);
     }
 
     return response.json();
   }
 
-  /**
-   * Poll for search completion with timeout
-   */
   async waitForSearch(
     requestId: string,
-    timeoutMs: number = 30000,
-    pollIntervalMs: number = 1000
+    timeoutMs = 30000,
+    pollIntervalMs = 1000
   ): Promise<SearchStatusResponse> {
     const startTime = Date.now();
 
     while (Date.now() - startTime < timeoutMs) {
       const status = await this.getSearchStatus(requestId);
-
       if (status.status === "completed" || status.status === "failed") {
         return status;
       }
-
       await new Promise((resolve) => setTimeout(resolve, pollIntervalMs));
     }
 

package/src/index.ts

@@ -5,6 +5,7 @@ export type {
   SearchStatusResponse,
   Problem,
   Source,
+  SearchOptions,
   SignupResponse,
   SigninResponse,
 } from "./types.js";

package/src/types.ts

@@ -1,15 +1,23 @@
-export type Source = "reddit" | "twitter";
+export type Source = "reddit" | "twitter" | "hackernews";
+
+export interface SearchOptions {
+  excludeSubreddits?: string[];
+  excludeKeywords?: string[];
+  minUpvotes?: number;
+  maxAgeHours?: number;
+}
 
 export interface SearchRequest {
   query: string;
   sources: Source[];
   limit?: number;
+  options?: SearchOptions;
 }
 
 export interface Problem {
   text: string;
   frequency: number;
-  sentiment: string;
+  sentiment: "frustrated" | "confused" | "disappointed" | "neutral";
 }
 
 export interface SearchResponse {
@@ -17,10 +25,14 @@ export interface SearchResponse {
   status: "pending" | "processing" | "completed" | "failed";
   query: string;
   sources: Source[];
+  postsAnalyzed?: number;
   problems?: Problem[];
   summary?: string;
   trends?: string[];
   cost?: number;
+  credits?: {
+    remaining: number;
+  };
 }
 
 export interface SearchStatusResponse {
@@ -28,9 +40,11 @@ export interface SearchStatusResponse {
   status: "pending" | "processing" | "completed" | "failed";
   query: string;
   sources: Source[];
+  postsAnalyzed?: number;
   problems?: Problem[];
   summary?: string;
   trends?: string[];
+  cost?: number;
   createdAt: string;
 }
 
@@ -57,5 +71,7 @@ export interface SigninResponse {
     id: string;
     name: string;
     createdAt: string;
+    lastUsed: string | null;
   }>;
+  message: string;
 }

package/tsconfig.json

@@ -1,15 +1,17 @@
 {
-  "extends": "../../tsconfig.json",
   "compilerOptions": {
+    "target": "ES2020",
+    "module": "ES2020",
+    "moduleResolution": "node",
     "outDir": "./dist",
     "rootDir": "./src",
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
     "declaration": true,
     "declarationMap": true,
-    "sourceMap": true,
-    "moduleResolution": "node",
-    "target": "ES2020",
-    "module": "ES2020"
+    "sourceMap": true
   },
   "include": ["src"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "dist"]
 }

package/README.md

@@ -1,253 +0,0 @@
-# @uncover/sdk
-
-JavaScript/TypeScript SDK for the [Uncover API](https://uncover.dev). Surface real problems people talk about on Reddit, X, and HackerNews — analyzed by AI.
-
-## Installation
-
-```bash
-npm install @uncover/sdk
-```
-
-## Quick Start
-
-```typescript
-import { Uncover } from "@uncover/sdk";
-
-const uncover = new Uncover("sk_live_your_api_key");
-
-const result = await uncover.search({
-  query: "password manager frustrations",
-  sources: ["reddit", "hackernews"],
-  limit: 20,
-});
-
-console.log(result.summary);
-// "Most users struggle with pricing, mobile app crashes, and steep setup..."
-
-console.log(result.problems);
-// [
-//   { text: "Too expensive for personal use", frequency: 8, sentiment: "frustrated" },
-//   { text: "Mobile app crashes constantly",  frequency: 7, sentiment: "frustrated" },
-//   { text: "Import from browser is broken",  frequency: 5, sentiment: "disappointed" },
-// ]
-
-console.log(result.trends);
-// ["pricing", "mobile", "browser extension", "support"]
-```
-
-## Get an API Key
-
-```bash
-curl -X POST https://api.uncover.dev/api/auth/signup \
-  -H "Content-Type: application/json" \
-  -d '{"email":"you@example.com","password":"yourpassword"}'
-```
-
-Returns `{ apiKey: { key: "sk_live_..." } }`. Save it — it's only shown once.
-
-Or sign up at [uncover.dev](https://uncover.dev).
-
-## API Reference
-
-### `new Uncover(apiKey, baseUrl?)`
-
-```typescript
-const uncover = new Uncover("sk_live_...");
-
-// Custom base URL (e.g. self-hosted)
-const uncover = new Uncover("sk_live_...", "https://your-api.com");
-```
-
----
-
-### `uncover.search(request)`
-
-Run a search. Deducts 1 credit.
-
-```typescript
-const result = await uncover.search({
-  query: "CRM software problems",         // required
-  sources: ["reddit", "hackernews"],      // required — "reddit" | "twitter" | "hackernews"
-  limit: 20,                              // optional, 1–50, default 20
-  options: {
-    excludeSubreddits: ["memes", "AskReddit"],  // filter out subreddits
-    excludeKeywords:   ["sponsored", "ad"],     // filter out posts with these words
-    minUpvotes:        10,                       // only include posts with 10+ upvotes
-    maxAgeHours:       720,                      // only posts from last 30 days
-  },
-});
-```
-
-**Response:**
-
-```typescript
-{
-  requestId:     string;
-  status:        "completed" | "failed";
-  query:         string;
-  sources:       string[];
-  postsAnalyzed: number;
-  summary:       string;       // 2-3 sentence AI summary
-  problems: [
-    {
-      text:      string;       // description of the problem
-      frequency: number;       // 1–10, how often it appears
-      sentiment: string;       // "frustrated" | "confused" | "disappointed" | "neutral"
-    }
-  ];
-  trends:  string[];           // recurring themes
-  cost:    number;             // $ cost of this search
-  credits: { remaining: number };
-}
-```
-
----
-
-### `uncover.getSearchStatus(requestId)`
-
-Retrieve a previous search by ID.
-
-```typescript
-const result = await uncover.getSearchStatus("req_abc123");
-```
-
----
-
-### `uncover.waitForSearch(requestId, timeoutMs?, pollIntervalMs?)`
-
-Poll until a search completes. Useful if you process searches asynchronously.
-
-```typescript
-const result = await uncover.waitForSearch(
-  "req_abc123",
-  30000,  // timeout after 30s (default)
-  1000    // poll every 1s (default)
-);
-```
-
----
-
-## Examples
-
-### Find problems for product research
-
-```typescript
-import { Uncover } from "@uncover/sdk";
-
-const uncover = new Uncover(process.env.UNCOVER_API_KEY!);
-
-async function researchTopic(topic: string) {
-  const result = await uncover.search({
-    query: `${topic} problems complaints`,
-    sources: ["reddit", "hackernews"],
-    limit: 30,
-    options: {
-      minUpvotes: 5,
-      maxAgeHours: 2160, // last 90 days
-    },
-  });
-
-  return {
-    summary: result.summary,
-    topProblems: result.problems
-      ?.sort((a, b) => b.frequency - a.frequency)
-      .slice(0, 5),
-    themes: result.trends,
-  };
-}
-
-const research = await researchTopic("project management software");
-console.log(research);
-```
-
-### Filter noise aggressively
-
-```typescript
-const result = await uncover.search({
-  query: "Notion productivity complaints",
-  sources: ["reddit"],
-  options: {
-    excludeSubreddits: ["memes", "funny", "AskReddit", "teenagers"],
-    excludeKeywords:   ["sponsored", "affiliate", "promo", "discount"],
-    minUpvotes:        20,
-    maxAgeHours:       720,
-  },
-});
-```
-
-### Use with multiple sources
-
-```typescript
-const result = await uncover.search({
-  query: "Figma designer frustrations",
-  sources: ["reddit", "twitter", "hackernews"],
-  limit: 50,
-});
-```
-
----
-
-## Error Handling
-
-```typescript
-try {
-  const result = await uncover.search({ query: "...", sources: ["reddit"] });
-} catch (err) {
-  if (err.message.includes("Insufficient credits")) {
-    // User needs to top up — redirect to billing
-    console.log("Buy more credits at https://uncover.dev/dashboard");
-  } else {
-    console.error("Search failed:", err.message);
-  }
-}
-```
-
----
-
-## CLI
-
-Prefer the command line? Install the CLI instead:
-
-```bash
-npm install -g @uncover/cli
-
-uncover login
-uncover scrape "password manager frustrations" --sources reddit,hackernews
-uncover status
-```
-
----
-
-## Pricing
-
-| Pack | Searches | Price |
-|------|----------|-------|
-| Starter | 50 | $5 |
-| Growth | 200 | $15 |
-| Pro | 500 | $29 |
-| Scale | 2,000 | $79 |
-
-Or subscribe for a monthly credit allowance (Builder $19/mo, Team $49/mo, Enterprise $149/mo).
-
-Credits never expire. Subscribers can top up with PAYG packs.
-
----
-
-## TypeScript
-
-Fully typed. All request and response types are exported:
-
-```typescript
-import type {
-  SearchRequest,
-  SearchResponse,
-  Problem,
-  Source,
-} from "@uncover/sdk";
-```
-
----
-
-## License
-
-MIT