orangeslice 1.6.0 → 1.6.1

package/README.md

@@ -56,6 +56,35 @@ All calls are rate-limited automatically.
 npm install orangeslice
 ```
 
+### TypeScript Setup
+
+If running `.ts` files directly with `ts-node` or `tsx`, you may need:
+
+```bash
+npm install -D typescript @types/node tsx
+```
+
+Recommended `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "strict": false,
+    "skipLibCheck": true
+  }
+}
+```
+
+Then run with:
+
+```bash
+npx tsx your-script.ts
+```
+
 ## Usage
 
 ```typescript
@@ -135,6 +164,42 @@ const result = await orangeslice.b2b.query("SELECT * FROM linkedin_company LIMIT
 // result.rows, result.rowCount, result.duration_ms
 ```
 
+### `orangeslice.serp.search(query: string, options?): Promise<SerpResponse>`
+
+Search Google and return results.
+
+```typescript
+const response = await orangeslice.serp.search("Stripe funding 2024");
+// response.results = [{ title, link, snippet }, ...]
+
+// With options
+const filtered = await orangeslice.serp.search("site:linkedin.com CEO", {
+  tbs: "qdr:m",  // Past month
+  page: 1
+});
+```
+
+### `orangeslice.firecrawl.scrape(url: string, limit?): Promise<FirecrawlResponse>`
+
+Scrape a website and get markdown + social URLs.
+
+```typescript
+const page = await orangeslice.firecrawl.scrape("https://stripe.com/about");
+// page.markdown, page.socialUrls
+```
+
+### `orangeslice.browser.execute(code: string, options?): Promise<BrowserResponse>`
+
+Execute Playwright code with `page` in scope.
+
+```typescript
+const response = await orangeslice.browser.execute(`
+  await page.goto("https://example.com", { waitUntil: 'domcontentloaded' });
+  return await page.evaluate(() => document.title);
+`);
+// response.success, response.result
+```
+
 ## Note on Concurrency
 
 The rate limit is **per-process**. If you run multiple scripts simultaneously, each has its own queue. For most AI agent use cases (single script), this is fine.

package/dist/serp.d.ts

@@ -5,6 +5,9 @@ export interface SerpResult {
     position?: number;
 }
 export interface SerpResponse {
+    /** Search results (primary field from API) */
+    results?: SerpResult[];
+    /** @deprecated Use `results` instead */
     organic_results?: SerpResult[];
     related_questions?: Array<{
         question: string;
@@ -32,7 +35,7 @@ export interface SerpOptions {
  */
 export declare function search(query: string, options?: SerpOptions): Promise<SerpResponse>;
 /**
- * Search and return just the organic results
+ * Search and return just the results array
  */
 export declare function organic(query: string, options?: SerpOptions): Promise<SerpResult[]>;
 export declare const serp: {

package/dist/serp.js

@@ -57,11 +57,11 @@ async function search(query, options = {}) {
     });
 }
 /**
- * Search and return just the organic results
+ * Search and return just the results array
  */
 async function organic(query, options = {}) {
     const data = await search(query, options);
-    return data.organic_results || [];
+    return data.results || data.organic_results || [];
 }
 // Export as namespace
 exports.serp = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orangeslice",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "Turn any AI agent into a B2B sales research assistant with 1B+ LinkedIn profiles",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",