@nangohq/types 0.71.3 → 0.71.5

package/dist/keystore/index.d.ts

@@ -1,4 +1,11 @@
-export type EntityType = 'connect_session' | 'connection' | 'environment';
+export type EntityType = 'connect_session' | 'connection' | 'environment' | 'agent_session';
+export type PrivateKeyEntityRef = {
+    entityType: Exclude<EntityType, 'agent_session'>;
+    entityId: number;
+} | {
+    entityType: 'agent_session';
+    entityUuid: string;
+};
 export interface PrivateKey {
     readonly id: number;
     readonly displayName: string;
@@ -10,5 +17,6 @@ export interface PrivateKey {
     readonly expiresAt: Date | null;
     readonly lastAccessAt: Date | null;
     readonly entityType: EntityType;
-    readonly entityId: number;
+    readonly entityId: number | null;
+    readonly entityUuid: string | null;
 }

package/dist/logs/messages.d.ts

@@ -20,6 +20,10 @@ export type OperationState = 'waiting' | 'running' | 'success' | 'failed' | 'tim
 /**
  * Operations
  */
+export interface OperationFunction {
+    type: 'function';
+    action: 'invoke';
+}
 export interface OperationSync {
     type: 'sync';
     action: 'pause' | 'unpause' | 'run' | 'request_run' | 'request_run_full' | 'cancel' | 'init' | 'create_variant' | 'delete_variant';
@@ -52,7 +56,21 @@ export interface OperationDeploy {
     type: 'deploy';
     action: 'prebuilt' | 'custom';
 }
-export type OperationList = OperationSync | OperationProxy | OperationAction | OperationWebhook | OperationOnEvents | OperationDeploy | OperationAuth | OperationAdmin;
+export interface OperationAgentSession {
+    type: 'agent_session';
+    action: 'create';
+}
+export type OperationList = OperationFunction | OperationSync | OperationProxy | OperationAction | OperationWebhook | OperationOnEvents | OperationDeploy | OperationAuth | OperationAdmin | OperationAgentSession;
+/**
+ * Who triggered an operation
+ */
+export type OperationActor = {
+    kind: 'user';
+    id: number;
+} | {
+    kind: 'session';
+    id: string;
+};
 export interface MessageError {
     name: string;
     message: string;
@@ -141,7 +159,10 @@ export interface OperationRow {
     syncConfigId?: number | undefined;
     syncConfigName?: string | undefined;
     jobId?: string | undefined;
-    userId?: number | undefined;
+    /**
+     * Who triggered this operation, i.e: a dashboard user or an agent session
+     */
+    actor?: OperationActor | undefined;
     error?: MessageError | undefined;
     request?: MessageHTTPRequest | undefined;
     response?: MessageHTTPResponse | undefined;

package/dist/mcp/api.d.ts

@@ -23,17 +23,17 @@ export type GetConnectionToolsMcp = ApiEndpoint<{
     Path: '/mcp';
     Success: Record<string, unknown>;
 }>;
-export type PostControlPlaneMcp = ApiEndpoint<{
+export type PostManagementMcp = ApiEndpoint<{
     Audit: {
         kind: 'no-audit';
-        reason: 'non-auditable';
+        reason: 'audited-per-tool';
     };
     Method: 'POST';
     Path: '/mcp';
     Body: Record<string, unknown>;
     Success: Record<string, unknown>;
 }>;
-export type GetControlPlaneMcp = ApiEndpoint<{
+export type GetManagementMcp = ApiEndpoint<{
     Audit: {
         kind: 'no-audit';
         reason: 'non-auditable';

package/dist/mfa/api.d.ts

@@ -1,6 +1,7 @@
 import type { ApiEndpoint, ApiError } from '../api.js';
 import type { AuditPolicy } from '../audit-trail/event.js';
 import type { ApiUser } from '../user/api.js';
+import type { MFACredential } from './credential.js';
 type MFAError = ApiError<'invalid_mfa_code'> | ApiError<'mfa_already_enabled'> | ApiError<'mfa_enrollment_not_found'> | ApiError<'mfa_not_enabled'>;
 export type GetMFAStatus = ApiEndpoint<{
     Audit: {
@@ -71,13 +72,7 @@ export type PostMFALoginVerification = ApiEndpoint<{
     Audit: AuditPolicy<'mfa', 'verified', 'account'>;
     Method: 'POST';
     Path: '/api/v1/account/mfa/login/verify';
-    Body: {
-        type: 'code';
-        code: string;
-    } | {
-        type: 'recoveryCode';
-        recoveryCode: string;
-    };
+    Body: MFACredential;
     Error: ApiError<'invalid_mfa_code'> | ApiError<'mfa_login_expired'>;
     Success: {
         data: {

package/dist/mfa/credential.d.ts

@@ -0,0 +1,7 @@
+export type MFACredential = {
+    type: 'code';
+    code: string;
+} | {
+    type: 'recoveryCode';
+    recoveryCode: string;
+};

package/dist/mfa/db.d.ts

@@ -9,6 +9,7 @@ export interface DBMFAFactor extends Timestamps {
     auth_tag: string;
     enabled_at: Date | null;
     last_accepted_counter: string | null;
+    clock_offset_steps: number;
 }
 export interface DBMFARecoveryCode {
     id: string;

package/dist/persist/api.d.ts

@@ -23,7 +23,7 @@ type WithTags<T> = T & {
 };
 export type RunnerDataTransferTelemetry = WithTags<{
     type: 'data_transfer';
-    callsite: 'proxy' | 'uncontrolled_fetch' | 'persist_records' | 'persist_logs';
+    callsite: 'proxy' | 'uncontrolled_fetch' | 'persist_records' | 'persist_customer_logs' | 'persist_system_logs' | 'persist_logs';
     bytesSent: number;
     bytesReceived: number;
     count: number;

package/dist/plans/db.d.ts

@@ -44,6 +44,11 @@ export interface DBPlan extends Timestamps {
      * @default null
      */
     function_compute_gbms_max: number | null;
+    /** Limit the amount of function runtime (in "started seconds") that can be used in a month
+     * Set to null to remove limit
+     * @default null
+     */
+    function_duration_seconds_max: number | null;
     /** Limit the number of webhook forwards that can happen in a month
      * Set to null to remove limit
      * @default null
@@ -111,6 +116,16 @@ export interface DBPlan extends Timestamps {
      * @default false
      */
     has_rbac: boolean;
+    /**
+     * Record control-plane audit trail events
+     * @default false
+     */
+    has_audit_trail_control_plane: boolean;
+    /**
+     * Let the customer reach their audit trail, through the dashboard, the API and export
+     * @default false
+     */
+    has_audit_trail_access: boolean;
     /**
      * Enable or disable the ability to override the docs connect url from the connect session
      * @default false
@@ -151,6 +166,11 @@ export interface DBPlan extends Timestamps {
      * @default "runner"
      */
     on_event_function_runtime: FunctionRuntime;
+    /**
+     * Function Runtime
+     * @default "lambda"
+     */
+    function_runtime: FunctionRuntime;
     /**
      * Enable or disable records autopruning
      * @default true

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

@@ -134,6 +134,115 @@ export type GetBillingUsage = ApiEndpoint<{
         };
     };
 }>;
+export type GetOverdueInvoices = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/api/v1/plans/billing/overdue';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: {
+            hasOverdue: boolean;
+            portalUrl: string | null;
+        };
+    };
+}>;
+export type GetUpcomingInvoice = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/api/v1/plans/billing/upcoming-invoice';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: {
+            amountInCents: number | null;
+            currency: string | null;
+        };
+    };
+}>;
+export type GetBillingPeriodCosts = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/api/v1/plans/billing/period-costs';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: {
+            metrics: Partial<Record<UsageMetric, number>>;
+            /** Metrics with a real price whose charge couldn't be read — show a dash, not $0. */
+            malformedMetrics: UsageMetric[];
+            /** False when some usage price mapped to no metric of ours — an absent metric can't safely
+             *  read as $0, since the money might be one of theirs. */
+            fullyAttributed: boolean;
+            currency: string | null;
+            /** True when there's no billing period to report costs for — a free plan, no linked
+             *  subscription, or an ended one. `metrics`/`currency` are otherwise never empty/null. */
+            noCosts: boolean;
+        };
+    };
+}>;
+export type GetSpendAlert = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'GET';
+    Path: '/api/v1/plans/billing/spend-alert';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: {
+            /** Null when the plan gets no spend alerts, or none has been set. */
+            thresholdInCents: number | null;
+            /**
+             * ISO 4217. Null when there's nothing to price a threshold against — a non-spend plan,
+             * or no Orb subscription yet; otherwise set even when the threshold is null.
+             */
+            currency: string | null;
+        };
+    };
+}>;
+export type PutSpendAlert = ApiEndpoint<{
+    Audit: AuditPolicy<'billing', 'spend_alert_changed', 'account'>;
+    Method: 'PUT';
+    Path: '/api/v1/plans/billing/spend-alert';
+    Querystring: {
+        env: string;
+    };
+    Body: {
+        thresholdInCents: number;
+    };
+    Success: {
+        data: {
+            thresholdInCents: number;
+            currency: string | null;
+        };
+    };
+}>;
+export type DeleteSpendAlert = ApiEndpoint<{
+    Audit: AuditPolicy<'billing', 'spend_alert_removed', 'account'>;
+    Method: 'DELETE';
+    Path: '/api/v1/plans/billing/spend-alert';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        success: true;
+    };
+}>;
 export type PutBillingInvoicingDetails = ApiEndpoint<{
     Audit: AuditPolicy<'billing', 'details_changed', 'account'>;
     Method: 'PUT';

package/dist/pubsub/events.d.ts

@@ -72,7 +72,7 @@ export type UsageConnectionsEvent = UsageEventBase<'usage.connections', {
 export type UsageFunctionExecutionsEvent = UsageEventBase<'usage.function_executions', {
     value: number;
     properties: {
-        type: 'sync' | 'action' | 'webhook' | 'on-event';
+        type: 'function' | 'sync' | 'action' | 'webhook' | 'on-event';
         success: boolean;
         functionName: string;
         runtime: FunctionRuntime | undefined;
@@ -97,7 +97,7 @@ export type UsageWebhookForwardEvent = UsageEventBase<'usage.webhook_forward', {
         success: boolean;
     };
 }>;
-export type DataTransferCallsite = 'credential_test_hook' | 'credential_verification_hook' | 'connection_hook' | 'webhook_forward' | 'proxy' | 'uncontrolled_fetch' | 'persist_logs' | 'persist_records' | 'get_/records' | 'get_/proxy' | 'patch_/proxy' | 'post_/proxy' | 'put_/proxy' | 'delete_/proxy' | 'unknown_/proxy';
+export type DataTransferCallsite = 'credential_test_hook' | 'credential_verification_hook' | 'connection_hook' | 'webhook_forward' | 'proxy' | 'uncontrolled_fetch' | 'persist_customer_logs' | 'persist_system_logs' | 'persist_logs' | 'persist_records' | 'get_/records' | 'get_/proxy' | 'patch_/proxy' | 'post_/proxy' | 'put_/proxy' | 'delete_/proxy' | 'unknown_/proxy';
 export type UsageDataTransferEvent = UsageEventBase<'usage.data_transfer', {
     value: number;
     properties: {

package/dist/runner/sdk.d.ts

@@ -8,7 +8,7 @@ export interface SdkLogger {
     level: LogLevel | 'off';
 }
 export type ConflictResolutionMode = 'IN_MEMORY' | 'DISTRIBUTED';
-export type ScriptType = 'sync' | 'action' | 'webhook' | 'on-event';
+export type ScriptType = 'function' | 'sync' | 'action' | 'webhook' | 'on-event';
 export interface NangoProps {
     scriptType: ScriptType;
     host?: string;

package/dist/sharedCredentials/api.d.ts

@@ -44,6 +44,7 @@ export interface SharedCredentialsBodyInput {
     client_id: string;
     client_secret: string;
     scopes?: string | undefined;
+    app_link?: string | undefined;
 }
 export interface SharedCredentialsOutput {
     id: number;
@@ -52,6 +53,7 @@ export interface SharedCredentialsOutput {
         client_id: string;
         client_secret: string;
         scopes?: string | undefined;
+        app_link?: string | undefined;
     };
     created_at: string;
     updated_at: string;

package/dist/sharedCredentials/db.d.ts

@@ -5,6 +5,7 @@ export interface SharedCredentials {
     oauth_scopes?: string;
     oauth_client_secret_iv: string;
     oauth_client_secret_tag: string;
+    app_link?: string;
 }
 export interface DBSharedCredentials extends Timestamps {
     id: number;

package/dist/sharedCredentials/dto.d.ts

@@ -1,2 +1,2 @@
 import type { SharedCredentials } from './db.js';
-export type SharedCredentialsInputDto = Pick<SharedCredentials, 'oauth_client_id' | 'oauth_client_secret' | 'oauth_scopes'>;
+export type SharedCredentialsInputDto = Pick<SharedCredentials, 'oauth_client_id' | 'oauth_client_secret' | 'oauth_scopes' | 'app_link'>;

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

@@ -12,7 +12,10 @@ export type PostStripeCollectPayment = ApiEndpoint<{
 }>;
 export interface StripePaymentMethod {
     id: string;
+    brand: string;
     last4: string;
+    expMonth: number;
+    expYear: number;
 }
 export type GetStripePaymentMethods = ApiEndpoint<{
     Audit: {

package/dist/sync/api.d.ts

@@ -4,7 +4,7 @@ import type { ReportedSyncJobStatus } from './index.js';
 export type PostPublicTrigger = ApiEndpoint<{
     Audit: {
         kind: 'no-audit';
-        reason: 'TODO: audit coverage pending';
+        reason: 'data-plane operation';
     };
     Method: 'POST';
     Path: '/sync/trigger';

package/dist/usage/index.d.ts

@@ -1,4 +1,4 @@
-export type UsageMetric = 'proxy' | 'connections' | 'function_executions' | 'function_compute_gbms' | 'records' | 'webhook_forwards' | 'function_logs' | 'data_transfer';
+export type UsageMetric = 'proxy' | 'connections' | 'function_executions' | 'function_compute_gbms' | 'function_duration_seconds' | 'records' | 'webhook_forwards' | 'function_logs' | 'data_transfer';
 export interface MetricUsageSummary {
     label: string;
     usage: number;

package/dist/user/api.d.ts

@@ -1,5 +1,6 @@
-import type { ApiEndpoint, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError, Endpoint } from '../api.js';
 import type { AuditPolicy } from '../audit-trail/event.js';
+import type { MFACredential } from '../mfa/credential.js';
 import type { Role } from './db.js';
 export type GetUser = ApiEndpoint<{
     Audit: {
@@ -47,6 +48,7 @@ export type AllowedPermissions = Partial<Record<string, Partial<Record<'producti
 export type ApiUserWithPermissions = ApiUser & {
     role: Role;
     permissions: AllowedPermissions;
+    hasPassword: boolean;
 };
 export type PutUserPassword = ApiEndpoint<{
     Audit: AuditPolicy<'app_auth', 'password_changed', 'account'>;
@@ -55,7 +57,9 @@ export type PutUserPassword = ApiEndpoint<{
     Body: {
         oldPassword: string;
         newPassword: string;
+        mfa?: MFACredential | undefined;
     };
+    Error: ApiError<'incorrect_password'> | ApiError<'invalid_mfa_code'> | ApiError<'mfa_code_required'>;
     Success: {
         success: true;
     };

package/dist/user/db.d.ts

@@ -15,5 +15,7 @@ export interface DBUser extends Timestamps {
     email_verification_token_expires_at: Date | null;
     uuid: string;
     getting_started_closed: boolean;
+    account_discovery_pending: boolean;
+    account_invitation_requested_at: Date | null;
     role: Role;
 }

package/dist/web/env.d.ts

@@ -1,5 +1,8 @@
 export interface WindowEnv {
+    /** Public API host: OAuth callbacks, webhooks, and the `apiURL` handed to the SDK / Connect UI. */
     apiUrl: string;
+    /** Where the dashboard sends its own API requests. Equals `apiUrl` unless NANGO_DASHBOARD_API_URL is set. `/` means same-origin. */
+    dashboardApiUrl: string;
     publicUrl: string;
     connectUrl: string;
     gitHash: string | undefined;

package/package.json

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

package/dist/functions/capabilities.d.ts

@@ -1,7 +0,0 @@
-export interface FunctionCapabilities {
-    usesRecords: boolean;
-    usesCheckpoints: boolean;
-    usesMetadata: boolean;
-    usesOutbound: boolean;
-    usesInvoke: boolean;
-}