@nangohq/types 0.71.0 → 0.71.1

package/dist/account/context.d.ts

@@ -0,0 +1,15 @@
+import type { DBEnvironment } from '../environment/db.js';
+import type { DBPlan } from '../plans/db.js';
+import type { DBTeam } from '../team/db.js';
+/**
+ * The context persist resolves when authenticating a request with an internal
+ * secret key. Deliberately minimal: it holds only the fields persist actually
+ * reads, fetched by a purpose-built query on the auth hot path — the Pick types
+ * make unfetched fields impossible to reference. Adding a field here requires
+ * extending the query in accountService.getPersistAuthContext.
+ */
+export interface PersistAuthContext {
+    account: Pick<DBTeam, 'id'>;
+    environment: Pick<DBEnvironment, 'id' | 'name'>;
+    plan: Pick<DBPlan, 'id' | 'name' | 'records_store'> | null;
+}

package/dist/api.endpoints.d.ts

@@ -6,8 +6,8 @@ import type { PostPublicApiKeyAuthorization, PostPublicAppStoreAuthorization, Po
 import type { PostCliTelemetry } from './cli/api.js';
 import type { GetPublicClientMetadata } from './clientMetadata/http.api.js';
 import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect, PostPublicConnectTelemetry } from './connect/api.js';
-import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PatchConnection, PatchPublicConnection, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
-import type { SetMetadata, UpdateMetadata } from './connection/api/metadata.js';
+import type { DeleteConnection, DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PatchConnection, PatchPublicConnection, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
+import type { PostConnectionMetadata, SetMetadata, UpdateMetadata } from './connection/api/metadata.js';
 import type { GetConnectUISettings, PutConnectUISettings } from './connectUISettings/api.js';
 import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api.js';
 import type { CreateApiKey, DeleteApiKey, DeleteEnvironment, GetEnvironment, GetEnvironments, ListApiKeys, PatchApiKey, PatchEnvironment, PostEnvironment } from './environment/api/index.js';
@@ -20,6 +20,7 @@ import type { DeleteIntegration, DeletePublicIntegration, GetFunctionCode, GetIn
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api.js';
 import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api.js';
 import type { GetMeta } from './meta/api.js';
+import type { DeleteMFA, GetMFAStatus, PostMFAActivation, PostMFAEnrollment, PostMFARecoveryCodes } from './mfa/api.js';
 import type { GetPlainHmac } from './plain/api.js';
 import type { GetBillingUsage, GetBillingUsageTopDimensionValues, PostPlanChange, PostPlanExtendTrial, PutBillingInvoicingDetails } from './plans/http.api.js';
 import type { GetProvider, GetProviders, GetPublicProvider, GetPublicProviders } from './providers/api.js';
@@ -31,8 +32,8 @@ import type { GetPublicSyncStatus, PostPublicSyncPause, PostPublicSyncStart, Pos
 import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api.js';
 import type { GetUser, PatchUser, PutUserPassword } from './user/api.js';
 import type { PostPublicWebhook } from './webhooks/http.api.js';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicClientMetadata | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PostCliTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | DeletePublicIntegrationFunction | GetPublicProviderTemplates | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | GetFunctionCode | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetConnectionRecordModels | GetConnectionRecords | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PatchConnection | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction | GetPlainHmac;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | DeleteConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicClientMetadata | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PostCliTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | DeletePublicIntegrationFunction | GetPublicProviderTemplates | AllPublicProxy;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | GetFunctionCode | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | PatchConnection | PostConnectionMetadata | GetConnectionRecordModels | GetConnectionRecords | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction | GetMFAStatus | PostMFAEnrollment | PostMFAActivation | PostMFARecoveryCodes | DeleteMFA | GetPlainHmac;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/billing/types.d.ts

@@ -132,6 +132,12 @@ export interface GetBillingUsageOpts {
             value: string;
         } | undefined;
     };
+    /**
+     * AVG metrics (connections, records) are returned as the point-in-time daily count instead of
+     * the billing running-average. Used by the Free caps view, where the cap is a concurrent
+     * maximum. CH path only. Default false (billing running-average).
+     */
+    avgPerDay?: boolean;
 }
 export interface BillingUsageMetric {
     externalId: string;

package/dist/connect/api.d.ts

@@ -9,7 +9,6 @@ export interface ConnectSessionInput {
         connection_config?: {
             [key: string]: unknown;
             oauth_scopes_override?: string | undefined;
-            webhook_url?: string | undefined;
         } | undefined;
     }> | undefined;
     end_user: EndUserInput;
@@ -21,6 +20,8 @@ export interface ConnectSessionInput {
     overrides?: Record<string, {
         docs_connect?: string | undefined;
     }> | undefined;
+    /** Session-level override of the environment's webhook URLs, applied to the connection created by this session. */
+    webhook_url_override?: string | undefined;
 }
 export interface EndUserInput {
     id: string;
@@ -62,6 +63,7 @@ export type PostPublicConnectSessionsReconnect = Endpoint<{
         end_user?: ConnectSessionInput['end_user'] | undefined;
         organization?: ConnectSessionInput['organization'];
         overrides?: ConnectSessionInput['overrides'];
+        webhook_url_override?: ConnectSessionInput['webhook_url_override'];
         tags?: ConnectSessionInput['tags'];
     };
     Success: {
@@ -88,7 +90,7 @@ export type PostInternalConnectSessions = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/connect/sessions';
     Success: PostConnectSessions['Success'];
-    Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization' | 'integrations_config_defaults' | 'overrides'>;
+    Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization' | 'integrations_config_defaults' | 'overrides' | 'webhook_url_override'>;
 }>;
 export type PostPublicConnectTelemetry = Endpoint<{
     Method: 'POST';

package/dist/connect/session.d.ts

@@ -10,6 +10,8 @@ export interface ConnectSession {
     readonly allowedIntegrations: string[] | null;
     readonly integrationsConfigDefaults: Record<string, ConnectSessionIntegrationConfigDefaults> | null;
     readonly overrides: Record<string, ConnectSessionOverrides> | null;
+    /** Session-level override of the environment's webhook URLs, applied to the connection created by this session. */
+    readonly webhookUrlOverride: string | null;
     readonly endUser: InternalEndUser | null;
     readonly tags: Tags;
     readonly createdAt: Date;

package/dist/connection/api/get.d.ts

@@ -83,6 +83,7 @@ export type PostPublicConnection = Endpoint<{
         provider_config_key: string;
         metadata?: Record<string, unknown> | undefined;
         connection_config?: ConnectionConfig | undefined;
+        webhook_url_override?: string | undefined;
         credentials: Omit<OAuth2Credentials, 'raw'> | Omit<OAuth2ClientCredentials, 'raw'> | Omit<OAuth1Credentials, 'raw'> | Omit<ApiKeyCredentials, 'raw'> | Omit<BasicApiCredentials, 'raw'> | Omit<TbaCredentials, 'raw'> | {
             type: 'APP';
             app_id: string;
@@ -121,7 +122,7 @@ export type GetConnection = Endpoint<{
         };
     };
 }>;
-export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id' | 'connection_config'> & {
+export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id' | 'connection_config' | 'webhook_url_override'> & {
     provider_config_key: string;
     created_at: string;
     updated_at: string;

package/dist/connection/api/metadata.d.ts

@@ -20,4 +20,22 @@ export type UpdateMetadata = Endpoint<{
     Error: MetadataError;
     Success: MetadataBody;
 }>;
+export type PostConnectionMetadata = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/connections/:connectionId/metadata';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        env: string;
+        provider_config_key: string;
+    };
+    Body: {
+        metadata: Metadata;
+    };
+    Success: {
+        success: boolean;
+    };
+    Error: ApiError<'unknown_provider_config' | 'not_found' | 'invalid_body'>;
+}>;
 export {};

package/dist/connection/db.d.ts

@@ -11,7 +11,6 @@ export interface ConnectionConfig {
     oauth_scopes_override?: string[] | undefined;
     oauth_scopes?: string | undefined;
     authorization_params?: Record<string, string> | undefined;
-    webhook_url?: string | undefined;
 }
 export interface DBConnection extends TimestampsAndDeletedCorrect {
     id: number;
@@ -24,6 +23,11 @@ export interface DBConnection extends TimestampsAndDeletedCorrect {
     provider_config_key: string;
     connection_id: string;
     connection_config: ConnectionConfig;
+    /**
+     * Backend-set override of the environment's webhook URLs for this connection. Distinct from `connection_config`,
+     * which holds end-user-supplied, provider-declared inputs (see providers.yaml). Only sourced from the connect session.
+     */
+    webhook_url_override: string | null;
     environment_id: number;
     metadata: Metadata | null;
     credentials: {
@@ -56,7 +60,7 @@ export interface FailedConnectionError {
     description: string;
 }
 export interface RecentlyFailedConnection {
-    connection: DBConnection | Pick<DBConnection, 'connection_id' | 'provider_config_key' | 'connection_config'>;
+    connection: DBConnection | (Pick<DBConnection, 'connection_id' | 'provider_config_key'> & Partial<Pick<DBConnection, 'webhook_url_override'>>);
     auth_mode: AuthModeType;
     error?: FailedConnectionError;
     operation: AuthOperationType;

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export type * from './keystore/index.js';
 export type * from './action/api.js';
 export type * from './admin/http.api.js';
 export type * from './account/api.js';
+export type * from './account/context.js';
 export type * from './user/api.js';
 export type * from './user/db.js';
 export type * from './plain/api.js';
@@ -90,6 +91,8 @@ export type * from './jobs/api.js';
 export type * from './checkpoint/types.js';
 export type * from './checkpoint/db.js';
 export type * from './mcp/api.js';
+export type * from './mfa/api.js';
+export type * from './mfa/db.js';
 export type * from './functions/api.js';
 export type * from './functions/capabilities.js';
 export type * from './functions/domain.js';

package/dist/integration/api.d.ts

@@ -11,6 +11,7 @@ export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' |
 export interface ApiPublicIntegrationInclude {
     webhook_url?: string | null;
     credentials_label?: Record<string, string> | undefined;
+    preconfigured_credentials?: string[] | undefined;
     credentials?: {
         type: AuthModes['OAuth2'] | AuthModes['OAuth1'] | AuthModes['TBA'];
         client_id: string | null;

package/dist/mfa/api.d.ts

@@ -0,0 +1,60 @@
+import type { ApiError, Endpoint } from '../api.js';
+type MFAError = ApiError<'invalid_mfa_code'> | ApiError<'mfa_already_enabled'> | ApiError<'mfa_enrollment_not_found'> | ApiError<'mfa_not_enabled'>;
+export type GetMFAStatus = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/account/mfa';
+    Success: {
+        data: {
+            enabled: boolean;
+        };
+    };
+}>;
+export type PostMFAEnrollment = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/account/mfa/enroll';
+    Error: ApiError<'mfa_already_enabled'>;
+    Success: {
+        data: {
+            otpauthUri: string;
+        };
+    };
+}>;
+export type PostMFAActivation = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/account/mfa/activate';
+    Body: {
+        code: string;
+    };
+    Error: ApiError<'invalid_mfa_code'> | ApiError<'mfa_enrollment_not_found'>;
+    Success: {
+        data: {
+            recoveryCodes: string[];
+        };
+    };
+}>;
+export type PostMFARecoveryCodes = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/account/mfa/recovery-codes';
+    Body: {
+        code: string;
+    };
+    Error: ApiError<'invalid_mfa_code'> | ApiError<'mfa_not_enabled'>;
+    Success: {
+        data: {
+            recoveryCodes: string[];
+        };
+    };
+}>;
+export type DeleteMFA = Endpoint<{
+    Method: 'DELETE';
+    Path: '/api/v1/account/mfa';
+    Body: {
+        code: string;
+    };
+    Error: ApiError<'invalid_mfa_code'> | ApiError<'mfa_not_enabled'>;
+    Success: {
+        success: true;
+    };
+}>;
+export type MFAEndpointError = MFAError;
+export {};

package/dist/mfa/db.d.ts

@@ -0,0 +1,19 @@
+import type { Timestamps } from '../db.js';
+export type MFAFactorType = 'totp';
+export interface DBMFAFactor extends Timestamps {
+    id: string;
+    user_id: number;
+    type: MFAFactorType;
+    encrypted_secret: string;
+    iv: string;
+    auth_tag: string;
+    enabled_at: Date | null;
+    last_accepted_counter: string | null;
+}
+export interface DBMFARecoveryCode {
+    id: string;
+    user_id: number;
+    code_hash: string;
+    created_at: Date;
+    consumed_at: Date | null;
+}

package/dist/oauthSessions/db.d.ts

@@ -9,6 +9,7 @@ export interface DBOAuthSession extends Timestamps {
     authMode: AuthModeType;
     connect_session_id: number | null;
     connection_config: Record<string, string>;
+    webhook_url_override: string | null;
     environment_id: number;
     web_socket_client_id: string | undefined;
     activity_log_id: string;
@@ -24,6 +25,7 @@ export interface OAuthSession {
     authMode: AuthModeType;
     connectSessionId: number | null;
     connectionConfig: Record<string, string>;
+    webhookUrlOverride: string | null;
     environmentId: number;
     webSocketClientId: string | undefined;
     activityLogId: string;

package/dist/plans/db.d.ts

@@ -89,7 +89,7 @@ export interface DBPlan extends Timestamps {
      * Change the applied rate limit for the public API
      * @default "m"
      */
-    api_rate_limit_size: 's' | 'm' | 'l' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl';
+    api_rate_limit_size: 's' | 'm' | 'l' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | '7xl' | '8xl' | '9xl' | '10xl' | '11xl' | '12xl';
     /**
      * Enable or disable machine auto idling
      * @default true

package/dist/plans/http.api.d.ts

@@ -103,6 +103,7 @@ export type GetBillingUsage = Endpoint<{
         } | undefined;
         top?: string | undefined;
         filter?: Partial<Record<UsageMetric, string | undefined>> | undefined;
+        avgPerDay?: boolean | undefined;
     };
     Success: {
         data: {

package/dist/providers/provider.d.ts

@@ -41,6 +41,9 @@ export interface SimplifiedJSONSchema {
         equals: string;
     };
 }
+export type ProxyBodyValue = string | {
+    [key: string]: ProxyBodyValue;
+};
 export interface BaseProvider {
     display_name: string;
     auth_mode: AuthModeType;
@@ -50,7 +53,7 @@ export interface BaseProvider {
         headers?: Record<string, string>;
         connection_config?: Record<string, string>;
         query?: Record<string, string>;
-        body?: Record<string, string>;
+        body?: Record<string, ProxyBodyValue>;
         retry?: RetryHeaderConfig;
         decompress?: boolean;
         forward_headers_on_redirect?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.71.0",
+    "version": "0.71.1",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",