linkedin-secret-sauce 0.12.3 → 0.12.4

package/dist/enrichment/providers/bouncer.js

@@ -1,231 +0,0 @@
-"use strict";
-/**
- * Bouncer.io Email Verification Provider
- *
- * Provides SMTP-level email verification with 99%+ accuracy.
- * Best for verifying pattern-guessed emails on non-catch-all domains.
- *
- * Features:
- * - SMTP verification (checks if mailbox exists)
- * - Catch-all domain detection
- * - Disposable email detection
- * - Role account detection
- * - Toxicity scoring (0-5)
- *
- * @see https://docs.usebouncer.com
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBouncerProvider = createBouncerProvider;
-exports.verifyEmailWithBouncer = verifyEmailWithBouncer;
-exports.checkCatchAllDomain = checkCatchAllDomain;
-exports.verifyEmailsBatch = verifyEmailsBatch;
-const noop_provider_1 = require("../utils/noop-provider");
-const DEFAULT_API_URL = "https://api.usebouncer.com/v1.1";
-const DEFAULT_TIMEOUT_MS = 30000;
-/**
- * Map Bouncer status to confidence score
- */
-function statusToConfidence(status, response) {
-    switch (status) {
-        case "deliverable":
-            // High confidence - email verified as deliverable
-            // Reduce slightly if catch-all or high toxicity
-            let score = 95;
-            if (response.acceptAll)
-                score -= 20; // Catch-all reduces confidence
-            if (response.toxicity && response.toxicity >= 3)
-                score -= 10;
-            if (response.role)
-                score -= 5; // Role accounts slightly lower
-            return Math.max(50, score);
-        case "risky":
-            // Medium confidence - risky but might work
-            return response.acceptAll ? 40 : 50;
-        case "undeliverable":
-            // Email does not exist
-            return 0;
-        case "unknown":
-            // Could not verify
-            return 30;
-        default:
-            return 0;
-    }
-}
-/**
- * Extract email candidates from the enrichment candidate
- * Bouncer is a VERIFICATION provider, so it needs emails to verify
- */
-function extractEmailsToVerify(candidate) {
-    const emails = [];
-    // Check if candidate has pre-generated email patterns in metadata
-    const metadata = candidate._emailCandidates;
-    if (Array.isArray(metadata)) {
-        emails.push(...metadata.filter((e) => typeof e === "string"));
-    }
-    return emails;
-}
-/**
- * Verify a single email via Bouncer API
- */
-async function verifyEmail(email, apiKey, apiUrl, timeoutMs) {
-    const controller = new AbortController();
-    const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
-    try {
-        const url = `${apiUrl}/email/verify?email=${encodeURIComponent(email)}`;
-        const response = await fetch(url, {
-            method: "GET",
-            headers: {
-                "x-api-key": apiKey,
-                Accept: "application/json",
-            },
-            signal: controller.signal,
-        });
-        if (!response.ok) {
-            // All HTTP errors return null - let caller decide how to handle
-            return null;
-        }
-        const data = (await response.json());
-        return data;
-    }
-    catch {
-        // All errors (network, timeout, etc.) return null
-        return null;
-    }
-    finally {
-        clearTimeout(timeoutId);
-    }
-}
-/**
- * Create the Bouncer verification provider
- *
- * NOTE: This provider is a VERIFIER, not a FINDER. It verifies emails
- * that were generated by the construct provider or passed in the candidate.
- *
- * Usage in the enrichment flow:
- * 1. construct provider generates email patterns
- * 2. bouncer provider verifies which patterns are deliverable
- * 3. Only verified emails are returned
- */
-function createBouncerProvider(config) {
-    const { apiKey, apiUrl = DEFAULT_API_URL, timeoutMs = DEFAULT_TIMEOUT_MS, } = config;
-    if (!apiKey) {
-        return (0, noop_provider_1.createNoOpProvider)("bouncer");
-    }
-    async function verifyEmails(candidate) {
-        const emailsToVerify = extractEmailsToVerify(candidate);
-        // If no emails to verify, return null
-        // The orchestrator will need to pass emails from construct
-        if (emailsToVerify.length === 0) {
-            return null;
-        }
-        const verifiedEmails = [];
-        // Verify each email candidate
-        for (const email of emailsToVerify) {
-            try {
-                const result = await verifyEmail(email, apiKey, apiUrl, timeoutMs);
-                if (result) {
-                    const confidence = statusToConfidence(result.status, result);
-                    // Only include emails that are potentially deliverable
-                    if (result.status === "deliverable" || result.status === "risky") {
-                        verifiedEmails.push({
-                            email: result.email,
-                            verified: result.status === "deliverable",
-                            confidence,
-                            isCatchAll: result.acceptAll,
-                            metadata: {
-                                bouncerStatus: result.status,
-                                bouncerReason: result.reason,
-                                toxicity: result.toxicity,
-                                isDisposable: result.disposable,
-                                isRole: result.role,
-                                isFreeProvider: result.free,
-                            },
-                        });
-                    }
-                }
-            }
-            catch {
-                // Continue with other emails on error
-                continue;
-            }
-        }
-        if (verifiedEmails.length === 0) {
-            return null;
-        }
-        // Sort by confidence
-        verifiedEmails.sort((a, b) => (b.confidence ?? 0) - (a.confidence ?? 0));
-        return { emails: verifiedEmails };
-    }
-    // Mark provider name for orchestrator
-    verifyEmails.__name = "bouncer";
-    return verifyEmails;
-}
-/**
- * Standalone function to verify a single email via Bouncer
- *
- * Useful for ad-hoc verification outside the enrichment flow.
- *
- * @example
- * ```typescript
- * const result = await verifyEmailWithBouncer('test@example.com', {
- *   apiKey: process.env.BOUNCER_API_KEY,
- * });
- * console.log(result.status); // 'deliverable' | 'undeliverable' | 'risky' | 'unknown'
- * ```
- */
-async function verifyEmailWithBouncer(email, config) {
-    const { apiKey, apiUrl = DEFAULT_API_URL, timeoutMs = DEFAULT_TIMEOUT_MS, } = config;
-    return verifyEmail(email, apiKey, apiUrl, timeoutMs);
-}
-/**
- * Check if a domain is catch-all via Bouncer
- *
- * Sends a verification request for a random email and checks acceptAll flag.
- *
- * @example
- * ```typescript
- * const isCatchAll = await checkCatchAllDomain('example.com', {
- *   apiKey: process.env.BOUNCER_API_KEY,
- * });
- * ```
- */
-async function checkCatchAllDomain(domain, config) {
-    const { apiKey, apiUrl = DEFAULT_API_URL, timeoutMs = DEFAULT_TIMEOUT_MS, } = config;
-    // Generate a random email that almost certainly doesn't exist
-    const randomLocal = `bounce-test-${Date.now()}-${Math.random().toString(36).slice(2, 10)}`;
-    const testEmail = `${randomLocal}@${domain}`;
-    const result = await verifyEmail(testEmail, apiKey, apiUrl, timeoutMs);
-    if (!result) {
-        return null; // Could not determine
-    }
-    // If acceptAll is true, the domain accepts all emails (catch-all)
-    return result.acceptAll;
-}
-/**
- * Verify multiple emails in batch via Bouncer
- *
- * @example
- * ```typescript
- * const results = await verifyEmailsBatch(
- *   ['john@example.com', 'jane@example.com'],
- *   { apiKey: process.env.BOUNCER_API_KEY }
- * );
- * ```
- */
-async function verifyEmailsBatch(emails, config) {
-    const { apiKey, apiUrl = DEFAULT_API_URL, timeoutMs = DEFAULT_TIMEOUT_MS, } = config;
-    const results = new Map();
-    // Verify in parallel with concurrency limit
-    const CONCURRENCY = 5;
-    for (let i = 0; i < emails.length; i += CONCURRENCY) {
-        const batch = emails.slice(i, i + CONCURRENCY);
-        const batchResults = await Promise.all(batch.map(async (email) => {
-            const result = await verifyEmail(email, apiKey, apiUrl, timeoutMs);
-            return { email, result };
-        }));
-        for (const { email, result } of batchResults) {
-            results.set(email, result);
-        }
-    }
-    return results;
-}

package/dist/enrichment/providers/dropcontact.d.ts

@@ -1,22 +0,0 @@
-/**
- * Dropcontact Provider
- *
- * Dropcontact API for email finding and enrichment.
- * Uses the batch enrichment API with polling for results.
- *
- * API Flow:
- * 1. POST /batch to submit contacts for enrichment
- * 2. GET /batch/{request_id} to poll for results
- *
- * Features:
- * - Email finding from name + company/website
- * - Email verification (deliverable/undeliverable)
- * - GDPR compliant (EU-based)
- *
- * @see https://developer.dropcontact.com/
- */
-import type { EnrichmentCandidate, ProviderResult, DropcontactConfig } from "../types";
-/**
- * Create the Dropcontact provider function
- */
-export declare function createDropcontactProvider(config: DropcontactConfig): (candidate: EnrichmentCandidate) => Promise<ProviderResult | null>;

package/dist/enrichment/providers/dropcontact.js

@@ -1,206 +0,0 @@
-"use strict";
-/**
- * Dropcontact Provider
- *
- * Dropcontact API for email finding and enrichment.
- * Uses the batch enrichment API with polling for results.
- *
- * API Flow:
- * 1. POST /batch to submit contacts for enrichment
- * 2. GET /batch/{request_id} to poll for results
- *
- * Features:
- * - Email finding from name + company/website
- * - Email verification (deliverable/undeliverable)
- * - GDPR compliant (EU-based)
- *
- * @see https://developer.dropcontact.com/
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDropcontactProvider = createDropcontactProvider;
-const http_retry_1 = require("../utils/http-retry");
-const noop_provider_1 = require("../utils/noop-provider");
-const API_BASE = "https://api.dropcontact.io";
-/**
- * Extract inputs from candidate for Dropcontact API
- */
-function extractInputs(candidate) {
-    const name = candidate.name || candidate.fullName || candidate.full_name;
-    const first = candidate.first ||
-        candidate.first_name ||
-        candidate.firstName ||
-        name?.split?.(" ")?.[0];
-    const last = candidate.last ||
-        candidate.last_name ||
-        candidate.lastName ||
-        name?.split?.(" ")?.slice(1).join(" ") ||
-        undefined;
-    const domain = candidate.domain ||
-        candidate.companyDomain ||
-        candidate.company_domain ||
-        undefined;
-    const company = candidate.company ||
-        candidate.currentCompany ||
-        candidate.organization ||
-        candidate.org ||
-        undefined;
-    const linkedin = candidate.linkedinUrl ||
-        candidate.linkedin_url ||
-        (candidate.linkedinHandle
-            ? `https://www.linkedin.com/in/${candidate.linkedinHandle}`
-            : undefined) ||
-        (candidate.linkedin_handle
-            ? `https://www.linkedin.com/in/${candidate.linkedin_handle}`
-            : undefined) ||
-        undefined;
-    return {
-        first_name: first,
-        last_name: last,
-        full_name: name,
-        company: company,
-        website: domain,
-        linkedin: linkedin,
-    };
-}
-/**
- * Create the Dropcontact provider function
- */
-function createDropcontactProvider(config) {
-    const { apiKey } = config;
-    if (!apiKey) {
-        return (0, noop_provider_1.createNoOpProvider)("dropcontact");
-    }
-    /**
-     * Submit a batch request to Dropcontact
-     */
-    async function submitBatch(contacts) {
-        const body = {
-            data: contacts,
-            siren: false, // We don't need French company registration numbers
-            language: "en",
-        };
-        try {
-            const response = await (0, http_retry_1.postWithRetry)(`${API_BASE}/batch`, body, { "X-Access-Token": apiKey }, { retries: 2, backoffMs: 500, timeoutMs: 30000 });
-            if (response.error) {
-                return null;
-            }
-            return response.request_id || null;
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Poll for batch results with exponential backoff
-     */
-    async function pollResults(requestId, maxAttempts = 10, initialDelayMs = 2000) {
-        let delayMs = initialDelayMs;
-        for (let attempt = 0; attempt < maxAttempts; attempt++) {
-            await (0, http_retry_1.delay)(delayMs);
-            try {
-                const response = await (0, http_retry_1.getWithRetry)(`${API_BASE}/batch/${requestId}`, { "X-Access-Token": apiKey }, { retries: 1, backoffMs: 500, timeoutMs: 30000 });
-                // Check if processing is complete
-                if (response.error) {
-                    return null;
-                }
-                // If we have data and status is finished (or we got data back), return it
-                if (response.data && response.data.length > 0) {
-                    // Check if still processing
-                    if (response.status === "pending") {
-                        // Increase delay for next poll (max 10 seconds)
-                        delayMs = Math.min(delayMs * 1.5, 10000);
-                        continue;
-                    }
-                    return response.data;
-                }
-                // If explicitly finished but no data
-                if (response.status === "finished") {
-                    return response.data || null;
-                }
-                // Still processing, increase delay
-                delayMs = Math.min(delayMs * 1.5, 10000);
-            }
-            catch {
-                // Network error, retry with backoff
-                delayMs = Math.min(delayMs * 2, 10000);
-            }
-        }
-        return null; // Timeout after max attempts
-    }
-    /**
-     * Fetch email for a candidate
-     */
-    async function fetchEmail(candidate) {
-        const contact = extractInputs(candidate);
-        // Need at least a name and company/website to search
-        const hasName = (0, http_retry_1.truthy)(contact.first_name) || (0, http_retry_1.truthy)(contact.full_name);
-        const hasCompanyInfo = (0, http_retry_1.truthy)(contact.company) || (0, http_retry_1.truthy)(contact.website);
-        const hasLinkedIn = (0, http_retry_1.truthy)(contact.linkedin);
-        if (!hasName && !hasLinkedIn) {
-            return null; // Need at least name or LinkedIn URL
-        }
-        if (!hasCompanyInfo && !hasLinkedIn) {
-            return null; // Need company info or LinkedIn URL
-        }
-        // Submit single contact as batch
-        const requestId = await submitBatch([contact]);
-        if (!requestId) {
-            return null;
-        }
-        // Poll for results
-        const results = await pollResults(requestId);
-        if (!results || results.length === 0) {
-            return null;
-        }
-        // Extract email from first result
-        const enriched = results[0];
-        if (!enriched.email || enriched.email.length === 0) {
-            return null;
-        }
-        // Find the best email (prefer valid ones)
-        let bestEmail = null;
-        for (const emailObj of enriched.email) {
-            if (!emailObj.email)
-                continue;
-            // Prefer valid emails
-            if (emailObj.qualification === "valid") {
-                bestEmail = emailObj;
-                break;
-            }
-            // Take catch-all if no valid found yet
-            if (!bestEmail ||
-                (bestEmail.qualification !== "valid" &&
-                    emailObj.qualification === "catch_all")) {
-                bestEmail = emailObj;
-            }
-            // Take any email if nothing else
-            if (!bestEmail) {
-                bestEmail = emailObj;
-            }
-        }
-        if (!bestEmail || !bestEmail.email) {
-            return null;
-        }
-        // Map qualification to verified status
-        const verified = (0, http_retry_1.mapVerifiedStatus)(bestEmail.qualification);
-        // Confidence based on qualification
-        let score = 50;
-        if (bestEmail.qualification === "valid") {
-            score = 95;
-        }
-        else if (bestEmail.qualification === "catch_all") {
-            score = 60;
-        }
-        else if (bestEmail.qualification === "invalid") {
-            score = 10;
-        }
-        return {
-            email: bestEmail.email,
-            verified,
-            score,
-        };
-    }
-    // Mark provider name for orchestrator
-    fetchEmail.__name = "dropcontact";
-    return fetchEmail;
-}

package/docs/api/interfaces/DropcontactConfig.html

@@ -1,3 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DropcontactConfig | LinkedIn Secret Sauce - v0.12.3</title><meta name="description" content="Documentation for LinkedIn Secret Sauce"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">LinkedIn Secret Sauce - v0.12.3</a><div id="tsd-toolbar-links"><a href="https://github.com/enerage/LinkedInSecretSauce">GitHub</a><a href="https://www.npmjs.com/package/linkedin-secret-sauce">npm</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DropcontactConfig</a></li></ul><h1>Interface DropcontactConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Dropcontact provider configuration</p>
-</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DropcontactConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#apikey">apiKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/enerage/LinkedInSecretSauce/blob/142a9d0b85e83a724e9d23b89f1efc205b5a6dbd/src/enrichment/types.ts#L216">src/enrichment/types.ts:216</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#apikey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a>
-</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="apikey"><span>api<wbr/>Key</span><a href="#apikey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">apiKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/enerage/LinkedInSecretSauce/blob/142a9d0b85e83a724e9d23b89f1efc205b5a6dbd/src/enrichment/types.ts#L217">src/enrichment/types.ts:217</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#apikey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Key</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/enerage/LinkedInSecretSauce" class="tsd-nav-link">GitHub</a><a href="https://www.npmjs.com/package/linkedin-secret-sauce" class="tsd-nav-link">npm</a></nav><nav class="tsd-navigation"><a href="../index.html">LinkedIn Secret Sauce - v0.12.3</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>