chore: import upstream snapshot with attribution

apps/sim/tools/neverbounce/get_credits.ts

@@ -0,0 +1,57 @@
+import type {
+  NeverBounceGetCreditsParams,
+  NeverBounceGetCreditsResponse,
+} from '@/tools/neverbounce/types'
+import type { ToolConfig } from '@/tools/types'
+
+export const getCreditsTool: ToolConfig<
+  NeverBounceGetCreditsParams,
+  NeverBounceGetCreditsResponse
+> = {
+  id: 'neverbounce_get_credits',
+  name: 'NeverBounce Get Credits',
+  description: 'Retrieve the remaining paid and free verification credits for the account.',
+  version: '1.0.0',
+
+  params: {
+    apiKey: {
+      type: 'string',
+      required: true,
+      visibility: 'user-only',
+      description: 'NeverBounce API Key',
+    },
+  },
+
+  request: {
+    url: (params) =>
+      `https://api.neverbounce.com/v4/account/info?key=${encodeURIComponent(params.apiKey.trim())}`,
+    method: 'GET',
+    headers: () => ({ Accept: 'application/json' }),
+  },
+
+  transformResponse: async (response: Response) => {
+    const data = await response.json().catch(() => ({}))
+    if (!response.ok || data.status !== 'success') {
+      return {
+        success: false,
+        error:
+          (data as Record<string, string>).message ||
+          `NeverBounce API error: ${response.status} ${response.statusText}`,
+        output: { credits: 0, freeCredits: 0 },
+      }
+    }
+    const creditsInfo = (data.credits_info ?? {}) as Record<string, number>
+    return {
+      success: true,
+      output: {
+        credits: creditsInfo.paid_credits_remaining ?? 0,
+        freeCredits: creditsInfo.free_credits_remaining ?? 0,
+      },
+    }
+  },
+
+  outputs: {
+    credits: { type: 'number', description: 'Remaining paid verification credits' },
+    freeCredits: { type: 'number', description: 'Remaining free verification credits' },
+  },
+}

apps/sim/tools/neverbounce/hosting.ts

@@ -0,0 +1,39 @@
+import type { ToolHostingConfig } from '@/tools/types'
+
+/**
+ * Env var prefix for NeverBounce hosted keys. Provide keys as
+ * `NEVERBOUNCE_API_KEY_COUNT` plus `NEVERBOUNCE_API_KEY_1..N`.
+ */
+export const NEVERBOUNCE_API_KEY_PREFIX = 'NEVERBOUNCE_API_KEY'
+
+/**
+ * Dollar cost of a single NeverBounce verification credit. NeverBounce charges
+ * one credit per email checked; estimated from the pay-as-you-go tiers and
+ * rounded up for smaller plans — https://neverbounce.com/pricing.
+ */
+export const NEVERBOUNCE_CREDIT_USD = 0.008
+
+/**
+ * Build a NeverBounce `hosting` config. `getCredits` returns the number of
+ * verification credits the call consumed (one per checked email).
+ */
+export function neverbounceHosting<P>(
+  getCredits: (params: P, output: Record<string, unknown>) => number
+): ToolHostingConfig<P> {
+  return {
+    envKeyPrefix: NEVERBOUNCE_API_KEY_PREFIX,
+    apiKeyParam: 'apiKey',
+    byokProviderId: 'neverbounce',
+    pricing: {
+      type: 'custom',
+      getCost: (params, output) => {
+        const credits = getCredits(params, output)
+        return { cost: credits * NEVERBOUNCE_CREDIT_USD, metadata: { credits } }
+      },
+    },
+    rateLimit: {
+      mode: 'per_request',
+      requestsPerMinute: 60,
+    },
+  }
+}

apps/sim/tools/neverbounce/index.ts

@@ -0,0 +1,7 @@
+export * from './types'
+
+import { getCreditsTool } from '@/tools/neverbounce/get_credits'
+import { verifyEmailTool } from '@/tools/neverbounce/verify_email'
+
+export const neverbounceVerifyEmailTool = verifyEmailTool
+export const neverbounceGetCreditsTool = getCreditsTool

apps/sim/tools/neverbounce/types.ts

@@ -0,0 +1,31 @@
+import type { ToolResponse } from '@/tools/types'
+
+export interface NeverBounceVerifyEmailParams {
+  email: string
+  apiKey: string
+}
+
+export interface NeverBounceVerifyEmailResponse extends ToolResponse {
+  output: {
+    email: string
+    status: string
+    deliverable: boolean
+    roleAccount?: boolean
+    freeEmail?: boolean
+    didYouMean?: string
+    flags?: string[]
+  }
+}
+
+export interface NeverBounceGetCreditsParams {
+  apiKey: string
+}
+
+export interface NeverBounceGetCreditsResponse extends ToolResponse {
+  output: {
+    credits: number
+    freeCredits: number
+  }
+}
+
+export type NeverBounceResponse = NeverBounceVerifyEmailResponse | NeverBounceGetCreditsResponse

apps/sim/tools/neverbounce/verify_email.ts

@@ -0,0 +1,115 @@
+import { neverbounceHosting } from '@/tools/neverbounce/hosting'
+import type {
+  NeverBounceVerifyEmailParams,
+  NeverBounceVerifyEmailResponse,
+} from '@/tools/neverbounce/types'
+import type { ToolConfig } from '@/tools/types'
+
+/** Maps a NeverBounce `result` to the shared verification vocabulary. */
+const STATUS_MAP: Record<string, string> = {
+  valid: 'valid',
+  invalid: 'invalid',
+  catchall: 'catch_all',
+  disposable: 'disposable',
+  unknown: 'unknown',
+}
+
+export const verifyEmailTool: ToolConfig<
+  NeverBounceVerifyEmailParams,
+  NeverBounceVerifyEmailResponse
+> = {
+  id: 'neverbounce_verify_email',
+  name: 'NeverBounce Verify Email',
+  description: 'Verify the deliverability of an email address. Uses one verification credit.',
+  version: '1.0.0',
+
+  hosting: neverbounceHosting<NeverBounceVerifyEmailParams>(() => {
+    // Each verification consumes one NeverBounce credit.
+    return 1
+  }),
+
+  params: {
+    email: {
+      type: 'string',
+      required: true,
+      visibility: 'user-or-llm',
+      description: 'Email address to verify (e.g., john@example.com)',
+    },
+    apiKey: {
+      type: 'string',
+      required: true,
+      visibility: 'user-only',
+      description: 'NeverBounce API Key',
+    },
+  },
+
+  request: {
+    url: (params) =>
+      `https://api.neverbounce.com/v4/single/check?key=${encodeURIComponent(
+        params.apiKey.trim()
+      )}&email=${encodeURIComponent(params.email.trim())}&address_info=1`,
+    method: 'GET',
+    headers: () => ({ Accept: 'application/json' }),
+  },
+
+  transformResponse: async (response: Response, params?: NeverBounceVerifyEmailParams) => {
+    const data = await response.json().catch(() => ({}))
+    // NeverBounce returns HTTP 200 for API-level errors; the envelope status
+    // distinguishes a successful check from an auth/quota failure.
+    if (!response.ok || data.status !== 'success') {
+      return {
+        success: false,
+        error:
+          (data as Record<string, string>).message ||
+          `NeverBounce API error: ${response.status} ${response.statusText}`,
+        output: { email: params?.email ?? '', status: '', deliverable: false },
+      }
+    }
+    const result = String(data.result ?? '')
+    const flags: string[] = Array.isArray(data.flags) ? data.flags : []
+    return {
+      success: true,
+      output: {
+        email: params?.email ?? '',
+        status: STATUS_MAP[result] ?? result,
+        deliverable: result === 'valid',
+        roleAccount: flags.includes('role_account'),
+        freeEmail: flags.includes('free_email_host'),
+        didYouMean: data.suggested_correction ?? '',
+        flags,
+      },
+    }
+  },
+
+  outputs: {
+    email: { type: 'string', description: 'The verified email address' },
+    status: {
+      type: 'string',
+      description: 'Verification status (valid, invalid, catch_all, disposable, unknown)',
+    },
+    deliverable: {
+      type: 'boolean',
+      description: 'Whether the email is valid and safe to send',
+    },
+    roleAccount: {
+      type: 'boolean',
+      description: 'Whether the address is a role account (e.g., info@, sales@)',
+      optional: true,
+    },
+    freeEmail: {
+      type: 'boolean',
+      description: 'Whether the address is on a free email provider',
+      optional: true,
+    },
+    didYouMean: {
+      type: 'string',
+      description: 'Suggested correction for a likely typo',
+      optional: true,
+    },
+    flags: {
+      type: 'array',
+      description: 'Raw NeverBounce flags for the address',
+      optional: true,
+    },
+  },
+}