@automate.ax/integration-contracts 0.115.5 → 0.116.0

package/src/millionverifier/events.ts

@@ -0,0 +1,110 @@
+import * as z from "zod"
+
+const FILE_ID_WIRE_SCHEMA = z.union([z.string(), z.number()]).transform(String)
+
+export const MILLIONVERIFIER_NO_CREDIT_EVENT_SCHEMA = z.object({
+  reason: z.literal("noCredit"),
+})
+export const MILLIONVERIFIER_LOW_CREDIT_EVENT_SCHEMA = z.object({
+  credits: z.number().int().nonnegative(),
+  reason: z.literal("lowCredit"),
+})
+export const MILLIONVERIFIER_FILE_READY_EVENT_SCHEMA = z.object({
+  file: z.object({
+    catchAll: z.number().int().nonnegative(),
+    disposable: z.number().int().nonnegative(),
+    fileId: z.string(),
+    fileName: z.string(),
+    invalid: z.number().int().nonnegative(),
+    ok: z.number().int().nonnegative(),
+    totalRows: z.number().int().nonnegative(),
+    uniqueEmails: z.number().int().nonnegative(),
+    unknown: z.number().int().nonnegative(),
+  }),
+  reason: z.literal("fileReady"),
+})
+export const MILLIONVERIFIER_FILE_DELETION_SCHEDULED_EVENT_SCHEMA = z.object({
+  file: z.object({
+    deletesIn: z.string().min(1),
+    fileId: z.string(),
+    fileName: z.string(),
+  }),
+  reason: z.literal("fileDeletionScheduled"),
+})
+
+export const MILLIONVERIFIER_EVENT_SCHEMA = z.discriminatedUnion("reason", [
+  MILLIONVERIFIER_NO_CREDIT_EVENT_SCHEMA,
+  MILLIONVERIFIER_LOW_CREDIT_EVENT_SCHEMA,
+  MILLIONVERIFIER_FILE_READY_EVENT_SCHEMA,
+  MILLIONVERIFIER_FILE_DELETION_SCHEDULED_EVENT_SCHEMA,
+])
+
+export const MILLIONVERIFIER_WEBHOOK_WIRE_SCHEMA = z.discriminatedUnion(
+  "reason",
+  [
+    z.looseObject({ reason: z.literal("no_credit") }),
+    z.looseObject({
+      credits: z.number().int().nonnegative(),
+      reason: z.literal("low_credit"),
+    }),
+    z.looseObject({
+      file: z.looseObject({
+        catch_all: z.number().int().nonnegative(),
+        disposable: z.number().int().nonnegative(),
+        file_id: FILE_ID_WIRE_SCHEMA,
+        file_name: z.string(),
+        invalid: z.number().int().nonnegative(),
+        ok: z.number().int().nonnegative(),
+        total_rows: z.number().int().nonnegative(),
+        unique_emails: z.number().int().nonnegative(),
+        unknown: z.number().int().nonnegative(),
+      }),
+      reason: z.literal("file_ready"),
+    }),
+    z.looseObject({
+      file: z.looseObject({
+        file_delete: z.string().min(1),
+        file_id: FILE_ID_WIRE_SCHEMA,
+        file_name: z.string(),
+      }),
+      reason: z.literal("file_delete"),
+    }),
+  ],
+)
+
+/**
+ * Normalizes one documented MillionVerifier notification payload.
+ *
+ * @param value - Untrusted provider callback payload.
+ */
+export function normalizeMillionVerifierEvent(value: unknown) {
+  const event = MILLIONVERIFIER_WEBHOOK_WIRE_SCHEMA.parse(value)
+  if (event.reason === "no_credit") return { reason: "noCredit" as const }
+  if (event.reason === "low_credit") {
+    return { credits: event.credits, reason: "lowCredit" as const }
+  }
+  if (event.reason === "file_delete") {
+    return {
+      file: {
+        deletesIn: event.file.file_delete,
+        fileId: event.file.file_id,
+        fileName: event.file.file_name,
+      },
+      reason: "fileDeletionScheduled" as const,
+    }
+  }
+  return {
+    file: {
+      catchAll: event.file.catch_all,
+      disposable: event.file.disposable,
+      fileId: event.file.file_id,
+      fileName: event.file.file_name,
+      invalid: event.file.invalid,
+      ok: event.file.ok,
+      totalRows: event.file.total_rows,
+      uniqueEmails: event.file.unique_emails,
+      unknown: event.file.unknown,
+    },
+    reason: "fileReady" as const,
+  }
+}

package/src/millionverifier/index.ts

@@ -0,0 +1,33 @@
+export * from "./api"
+export * from "./events"
+export * from "./schemas"
+
+import * as z from "zod"
+import {
+  MILLIONVERIFIER_EVENT_SCHEMA,
+  MILLIONVERIFIER_FILE_DELETION_SCHEDULED_EVENT_SCHEMA,
+  MILLIONVERIFIER_FILE_READY_EVENT_SCHEMA,
+  MILLIONVERIFIER_LOW_CREDIT_EVENT_SCHEMA,
+  MILLIONVERIFIER_NO_CREDIT_EVENT_SCHEMA,
+} from "./events"
+
+export const MILLIONVERIFIER_TRIGGER_CONFIG_SCHEMA = z.object({})
+
+const contract = <TSchema extends z.ZodType>(eventSchema: TSchema) => ({
+  configSchema: MILLIONVERIFIER_TRIGGER_CONFIG_SCHEMA,
+  eventSchema,
+})
+
+export const millionVerifierTriggerContracts = {
+  "millionverifier.event": contract(MILLIONVERIFIER_EVENT_SCHEMA),
+  "millionverifier.noCredit": contract(MILLIONVERIFIER_NO_CREDIT_EVENT_SCHEMA),
+  "millionverifier.lowCredit": contract(
+    MILLIONVERIFIER_LOW_CREDIT_EVENT_SCHEMA,
+  ),
+  "millionverifier.fileReady": contract(
+    MILLIONVERIFIER_FILE_READY_EVENT_SCHEMA,
+  ),
+  "millionverifier.fileDeletionScheduled": contract(
+    MILLIONVERIFIER_FILE_DELETION_SCHEDULED_EVENT_SCHEMA,
+  ),
+} as const

package/src/millionverifier/schemas.ts

@@ -0,0 +1,207 @@
+import * as z from "zod"
+
+export const MILLIONVERIFIER_FILE_ID_SCHEMA = z
+  .union([z.string().regex(/^\d+$/), z.number().int().positive()])
+  .transform(String)
+
+export const MILLIONVERIFIER_FILE_STATUS_SCHEMA = z.enum([
+  "inProgress",
+  "error",
+  "finished",
+  "canceled",
+  "paused",
+  "inQueueToStart",
+])
+
+export const MILLIONVERIFIER_FILE_SCHEMA = z.object({
+  catchAll: z.number().int().nonnegative(),
+  createdAt: z.string(),
+  creditsRequired: z.number().int().nonnegative(),
+  disposable: z.number().int().nonnegative(),
+  error: z.string(),
+  estimatedTimeSeconds: z.number().int().nonnegative(),
+  fileId: z.string(),
+  fileName: z.string(),
+  invalid: z.number().int().nonnegative(),
+  ok: z.number().int().nonnegative(),
+  percent: z.number().int().min(0).max(100),
+  reverify: z.number().int().nonnegative(),
+  status: MILLIONVERIFIER_FILE_STATUS_SCHEMA,
+  totalRows: z.number().int().nonnegative(),
+  uniqueEmails: z.number().int().nonnegative(),
+  unknown: z.number().int().nonnegative(),
+  unverified: z.number().int().nonnegative(),
+  updatedAt: z.string(),
+  verified: z.number().int().nonnegative(),
+})
+
+export const MILLIONVERIFIER_EMAIL_RESULT_SCHEMA = z.enum([
+  "unverified",
+  "ok",
+  "catchAll",
+  "unknown",
+  "error",
+  "disposable",
+  "invalid",
+])
+
+export const MILLIONVERIFIER_EMAIL_VERIFICATION_SCHEMA = z.object({
+  credits: z.number().int().nonnegative(),
+  didYouMean: z.string(),
+  email: z.string(),
+  error: z.string(),
+  executionTimeMilliseconds: z.number().int().nonnegative(),
+  free: z.boolean(),
+  liveMode: z.boolean(),
+  quality: z.enum(["good", "bad", "risky"]).optional(),
+  result: MILLIONVERIFIER_EMAIL_RESULT_SCHEMA,
+  resultCode: z.number().int().min(0).max(6),
+  role: z.boolean(),
+  subresult: z.string(),
+})
+
+export const MILLIONVERIFIER_CREDITS_SCHEMA = z.object({
+  bulkCredits: z.number().int().nonnegative(),
+  credits: z.number().int().nonnegative(),
+  plan: z.number().int(),
+  renewingCredits: z.number().int().nonnegative(),
+})
+
+const PROVIDER_FILE_STATUS_SCHEMA = z.enum([
+  "in_progress",
+  "error",
+  "finished",
+  "canceled",
+  "paused",
+  "in_queue_to_start",
+])
+
+export const MILLIONVERIFIER_FILE_WIRE_SCHEMA = z
+  .looseObject({
+    catch_all: z.number().int().nonnegative(),
+    createdate: z.string(),
+    credit: z.number().int().nonnegative(),
+    disposable: z.number().int().nonnegative(),
+    error: z.string(),
+    estimated_time_sec: z.number().int().nonnegative(),
+    file_id: z.union([z.string(), z.number()]).transform(String),
+    file_name: z.string(),
+    invalid: z.number().int().nonnegative(),
+    ok: z.number().int().nonnegative(),
+    percent: z.number().int().min(0).max(100),
+    reverify: z.number().int().nonnegative(),
+    status: PROVIDER_FILE_STATUS_SCHEMA,
+    total_rows: z.number().int().nonnegative(),
+    unique_emails: z.number().int().nonnegative(),
+    unknown: z.number().int().nonnegative(),
+    unverified: z.number().int().nonnegative(),
+    updated_at: z.string(),
+    verified: z.number().int().nonnegative(),
+  })
+  .transform((file) =>
+    MILLIONVERIFIER_FILE_SCHEMA.parse({
+      catchAll: file.catch_all,
+      createdAt: file.createdate,
+      creditsRequired: file.credit,
+      disposable: file.disposable,
+      error: file.error,
+      estimatedTimeSeconds: file.estimated_time_sec,
+      fileId: file.file_id,
+      fileName: file.file_name,
+      invalid: file.invalid,
+      ok: file.ok,
+      percent: file.percent,
+      reverify: file.reverify,
+      status: fromProviderFileStatus(file.status),
+      totalRows: file.total_rows,
+      uniqueEmails: file.unique_emails,
+      unknown: file.unknown,
+      unverified: file.unverified,
+      updatedAt: file.updated_at,
+      verified: file.verified,
+    }),
+  )
+
+export const MILLIONVERIFIER_EMAIL_VERIFICATION_WIRE_SCHEMA = z
+  .looseObject({
+    credits: z.number().int().nonnegative(),
+    didyoumean: z.string(),
+    email: z.string(),
+    error: z.string(),
+    executiontime: z.number().int().nonnegative(),
+    free: z.boolean(),
+    livemode: z.boolean(),
+    quality: z.enum(["", "good", "bad", "risky"]).optional(),
+    result: z.enum([
+      "",
+      "unverified",
+      "ok",
+      "catch_all",
+      "unknown",
+      "error",
+      "disposable",
+      "invalid",
+    ]),
+    resultcode: z.number().int().min(0).max(6),
+    role: z.boolean(),
+    subresult: z.string(),
+  })
+  .transform((result) =>
+    MILLIONVERIFIER_EMAIL_VERIFICATION_SCHEMA.parse({
+      credits: result.credits,
+      didYouMean: result.didyoumean,
+      email: result.email,
+      error: result.error,
+      executionTimeMilliseconds: result.executiontime,
+      free: result.free,
+      liveMode: result.livemode,
+      quality: result.quality || undefined,
+      result:
+        result.result === "catch_all" ? "catchAll" : result.result || "error",
+      resultCode: result.resultcode,
+      role: result.role,
+      subresult: result.subresult,
+    }),
+  )
+
+export const MILLIONVERIFIER_CREDITS_WIRE_SCHEMA = z
+  .looseObject({
+    bulk_credits: z.number().int().nonnegative(),
+    credits: z.number().int().nonnegative(),
+    plan: z.number().int(),
+    renewing_credits: z.number().int().nonnegative(),
+  })
+  .transform((credits) =>
+    MILLIONVERIFIER_CREDITS_SCHEMA.parse({
+      bulkCredits: credits.bulk_credits,
+      credits: credits.credits,
+      plan: credits.plan,
+      renewingCredits: credits.renewing_credits,
+    }),
+  )
+
+/**
+ * Maps a provider file status to the public camelCase discriminator.
+ *
+ * @param status - Provider file status.
+ */
+function fromProviderFileStatus(
+  status: z.output<typeof PROVIDER_FILE_STATUS_SCHEMA>,
+) {
+  if (status === "in_progress") return "inProgress"
+  if (status === "in_queue_to_start") return "inQueueToStart"
+  return status
+}
+
+/**
+ * Maps a public file status to MillionVerifier's query value.
+ *
+ * @param status - Public file status.
+ */
+export function toMillionVerifierFileStatus(
+  status: z.output<typeof MILLIONVERIFIER_FILE_STATUS_SCHEMA>,
+) {
+  if (status === "inProgress") return "in_progress"
+  if (status === "inQueueToStart") return "in_queue_to_start"
+  return status
+}

package/src/triggers.ts

@@ -12,6 +12,7 @@ import type { googleFormsTriggerContracts } from "./google-forms"
 import type { googleMeetTriggerContracts } from "./google-meet"
 import type { googleSheetsTriggerContracts } from "./google-sheets"
 import type { linearTriggerContracts } from "./linear"
+import type { millionVerifierTriggerContracts } from "./millionverifier"
 import type { notionTriggerContracts } from "./notion"
 import type { outlookTriggerContracts } from "./outlook"
 import type { resendTriggerContracts } from "./resend"
@@ -38,6 +39,7 @@ export type TriggerContractMap = typeof airtableTriggerContracts &
   typeof googleMeetTriggerContracts &
   typeof googleSheetsTriggerContracts &
   typeof linearTriggerContracts &
+  typeof millionVerifierTriggerContracts &
   typeof notionTriggerContracts &
   typeof outlookTriggerContracts &
   typeof resendTriggerContracts &