@vertesia/common 1.3.0 → 1.4.0-dev.20260615.042033Z

package/src/integrations.ts

@@ -1,61 +1,102 @@
-
-
-export interface IntegrationConfigurationBase {
+export interface IntegrationConfigurationBase<TIntegration extends SupportedIntegrations = SupportedIntegrations> {
+    integration: TIntegration;
     enabled: boolean;
 }
 
-export interface GladiaConfiguration extends IntegrationConfigurationBase {
+export interface GladiaConfigurationInput extends IntegrationConfigurationBase<SupportedIntegrations.gladia> {
     api_key?: string;
+    url?: string;
+}
+
+export interface GladiaConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.gladia> {
     has_api_key?: boolean;
     api_key_hint?: string;
     url?: string;
 }
 
+export interface GladiaConfigurationWithSecrets extends GladiaConfiguration {
+    api_key?: string;
+}
 
-export interface GithubConfiguration extends IntegrationConfigurationBase {
+export interface GithubConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.github> {
     allowed_repositories: string[];
 }
 
-export interface AwsConfiguration extends IntegrationConfigurationBase {
+export interface AwsConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.aws> {
     s3_role_arn: string;
 }
 
-export interface MagicPdfConfiguration extends IntegrationConfigurationBase {
+export interface MagicPdfConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.magic_pdf> {
     // No additional configuration
     default_features?: string[];
     default_zones?: string[];
 }
 
-export interface SerperConfiguration extends IntegrationConfigurationBase {
+export interface SerperConfigurationInput extends IntegrationConfigurationBase<SupportedIntegrations.serper> {
     api_key?: string;
+    url?: string;
+}
+
+export interface SerperConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.serper> {
     has_api_key?: boolean;
     api_key_hint?: string;
     url?: string;
 }
 
-export interface ExaConfiguration extends IntegrationConfigurationBase {
+export interface SerperConfigurationWithSecrets extends SerperConfiguration {
     api_key?: string;
+}
+
+export interface ExaConfigurationInput extends IntegrationConfigurationBase<SupportedIntegrations.exa> {
+    api_key?: string;
+}
+
+export interface ExaConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.exa> {
     has_api_key?: boolean;
     api_key_hint?: string;
 }
 
-export interface LinkupConfiguration extends IntegrationConfigurationBase {
+export interface ExaConfigurationWithSecrets extends ExaConfiguration {
     api_key?: string;
+}
+
+export interface LinkupConfigurationInput extends IntegrationConfigurationBase<SupportedIntegrations.linkup> {
+    api_key?: string;
+}
+
+export interface LinkupConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.linkup> {
     has_api_key?: boolean;
     api_key_hint?: string;
 }
 
-export interface ResendConfiguration extends IntegrationConfigurationBase {
+export interface LinkupConfigurationWithSecrets extends LinkupConfiguration {
+    api_key?: string;
+}
+
+export interface ResendConfigurationInput extends IntegrationConfigurationBase<SupportedIntegrations.resend> {
     /** Resend API key for sending emails */
     api_key?: string;
-    has_api_key?: boolean;
-    api_key_hint?: string;
     /** Domain for email (both sending and receiving). Must be verified in Resend. */
     email_domain: string;
     /** Default display name for outgoing emails (e.g., "Vertesia - Project Name") */
     default_from_name?: string;
     /** Webhook secret for validating inbound email webhooks (required for receiving emails) */
     webhook_secret?: string;
+    /** Domains allowed to send emails TO start agents (for inbound validation) */
+    allowed_sender_domains?: string[];
+    /** Require sender to have project access to start agents via email (default: true) */
+    require_project_access?: boolean;
+    /** Require DKIM/SPF authentication to pass for inbound emails (default: true) */
+    require_email_auth?: boolean;
+}
+
+export interface ResendConfiguration extends IntegrationConfigurationBase<SupportedIntegrations.resend> {
+    has_api_key?: boolean;
+    api_key_hint?: string;
+    /** Domain for email (both sending and receiving). Must be verified in Resend. */
+    email_domain: string;
+    /** Default display name for outgoing emails (e.g., "Vertesia - Project Name") */
+    default_from_name?: string;
     has_webhook_secret?: boolean;
     webhook_secret_hint?: string;
     /** Domains allowed to send emails TO start agents (for inbound validation) */
@@ -66,15 +107,37 @@ export interface ResendConfiguration extends IntegrationConfigurationBase {
     require_email_auth?: boolean;
 }
 
+export interface ResendConfigurationWithSecrets extends ResendConfiguration {
+    /** Resend API key for sending emails */
+    api_key?: string;
+    /** Webhook secret for validating inbound email webhooks (required for receiving emails) */
+    webhook_secret?: string;
+}
+
 /**
  * Configuration for ask_user webhook notifications.
  * Sends webhooks when agents call ask_user and when users respond.
  */
-export interface AskUserWebhookConfiguration extends IntegrationConfigurationBase {
+export interface AskUserWebhookConfigurationInput
+    extends IntegrationConfigurationBase<SupportedIntegrations.ask_user_webhook> {
     /** Webhook URL to receive ask_user events */
     webhook_url: string;
     /** Secret for signing webhook payloads (HMAC-SHA256) */
     webhook_secret?: string;
+    /** Which events to send: ['requested', 'resolved'] or subset (default: both) */
+    events?: ('requested' | 'resolved')[];
+    /** Custom headers to include in webhook requests */
+    custom_headers?: Record<string, string>;
+}
+
+/**
+ * Configuration for ask_user webhook notifications.
+ * Sends webhooks when agents call ask_user and when users respond.
+ */
+export interface AskUserWebhookConfiguration
+    extends IntegrationConfigurationBase<SupportedIntegrations.ask_user_webhook> {
+    /** Webhook URL to receive ask_user events */
+    webhook_url: string;
     has_webhook_secret?: boolean;
     webhook_secret_hint?: string;
     /** Which events to send: ['requested', 'resolved'] or subset (default: both) */
@@ -83,19 +146,41 @@ export interface AskUserWebhookConfiguration extends IntegrationConfigurationBas
     custom_headers?: Record<string, string>;
 }
 
+export interface AskUserWebhookConfigurationWithSecrets extends AskUserWebhookConfiguration {
+    /** Secret for signing webhook payloads (HMAC-SHA256) */
+    webhook_secret?: string;
+}
+
 export enum SupportedIntegrations {
-    gladia = "gladia",
-    github = "github",
-    aws = "aws",
-    magic_pdf = "magic_pdf",
-    serper = "serper",
-    exa = "exa",
-    linkup = "linkup",
-    resend = "resend",
-    ask_user_webhook = "ask_user_webhook",
-}
-
-export type ProjectIntegrationConfig =
+    gladia = 'gladia',
+    github = 'github',
+    aws = 'aws',
+    magic_pdf = 'magic_pdf',
+    serper = 'serper',
+    exa = 'exa',
+    linkup = 'linkup',
+    resend = 'resend',
+    ask_user_webhook = 'ask_user_webhook',
+}
+
+/**
+ * @discriminator integration
+ */
+export type ProjectIntegrationConfigRequest =
+    | GladiaConfigurationInput
+    | GithubConfiguration
+    | AwsConfiguration
+    | MagicPdfConfiguration
+    | SerperConfigurationInput
+    | ExaConfigurationInput
+    | LinkupConfigurationInput
+    | ResendConfigurationInput
+    | AskUserWebhookConfigurationInput;
+
+/**
+ * @discriminator integration
+ */
+export type ProjectIntegrationConfigResponse =
     | GladiaConfiguration
     | GithubConfiguration
     | AwsConfiguration
@@ -105,3 +190,26 @@ export type ProjectIntegrationConfig =
     | LinkupConfiguration
     | ResendConfiguration
     | AskUserWebhookConfiguration;
+
+export type ProjectIntegrationConfigWithSecrets =
+    | GladiaConfigurationWithSecrets
+    | GithubConfiguration
+    | AwsConfiguration
+    | MagicPdfConfiguration
+    | SerperConfigurationWithSecrets
+    | ExaConfigurationWithSecrets
+    | LinkupConfigurationWithSecrets
+    | ResendConfigurationWithSecrets
+    | AskUserWebhookConfigurationWithSecrets;
+
+export type ProjectIntegrationConfig = ProjectIntegrationConfigResponse;
+
+export function withProjectIntegrationDiscriminator(
+    integration: SupportedIntegrations,
+    config: Record<string, unknown>,
+): ProjectIntegrationConfigResponse {
+    return {
+        ...config,
+        integration,
+    } as ProjectIntegrationConfigResponse;
+}