@nangohq/types 0.70.4 → 0.70.6

package/dist/api-keys/scopes.d.ts

@@ -1,3 +1,3 @@
-export declare const API_KEY_SCOPES: readonly ["environment:*", "environment:integrations:list", "environment:integrations:list_credentials", "environment:integrations:read", "environment:integrations:read_credentials", "environment:integrations:write", "environment:integrations:*", "environment:connections:list", "environment:connections:list_credentials", "environment:connections:read", "environment:connections:read_credentials", "environment:connections:write", "environment:connections:*", "environment:connect_sessions:write", "environment:syncs:read", "environment:syncs:execute", "environment:syncs:manage", "environment:syncs:*", "environment:deploy", "environment:records:read", "environment:records:write", "environment:records:*", "environment:actions:execute", "environment:actions:*", "environment:proxy", "environment:config:read", "environment:config:*", "environment:mcp"];
+export declare const API_KEY_SCOPES: readonly ["environment:*", "environment:integrations:list", "environment:integrations:list_credentials", "environment:integrations:list_functions", "environment:integrations:read", "environment:integrations:read_credentials", "environment:integrations:create", "environment:integrations:update", "environment:integrations:delete", "environment:integrations:*", "environment:connections:list", "environment:connections:list_credentials", "environment:connections:read", "environment:connections:read_credentials", "environment:connections:create", "environment:connections:update", "environment:connections:delete", "environment:connections:*", "environment:connect_sessions:write", "environment:syncs:read", "environment:syncs:execute", "environment:syncs:update", "environment:syncs:variant:create", "environment:syncs:variant:delete", "environment:syncs:*", "environment:functions:compile", "environment:functions:dryrun", "environment:functions:*", "environment:deploy", "environment:records:read", "environment:records:write", "environment:records:*", "environment:actions:execute", "environment:actions:*", "environment:proxy", "environment:variables:read", "environment:mcp"];
 export type ApiKeyScope = (typeof API_KEY_SCOPES)[number];
 export declare const ALL_SCOPES: string[];

package/dist/api.endpoints.d.ts

@@ -12,7 +12,7 @@ import type { CreateApiKey, DeleteApiKey, DeleteEnvironment, GetEnvironment, Get
 import type { PatchWebhook } from './environment/api/webhook.js';
 import type { PostEnvironmentVariables } from './environment/variable/api.js';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api.js';
-import type { GetIntegrationFunctions, GetProviderTemplates, PostRemoteFunctionCompile, PostRemoteFunctionDeploy, PostRemoteFunctionDryrun } from './functions/api.js';
+import type { GetFunctionDryrun, GetIntegrationFunction, GetIntegrationFunctions, GetIntegrationTemplates, GetProviderTemplates, PostFunctionCompile, PostFunctionDeployment, PostFunctionDryrun, PostFunctionDryrunResult, PostRemoteFunctionCompile, PostRemoteFunctionDeploy, PostRemoteFunctionDryrun } from './functions/api.js';
 import type { GetGettingStarted, PatchGettingStarted } from './gettingStarted/api.js';
 import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicFunctionCode, GetPublicIntegration, GetPublicListIntegrations, PatchIntegration, PatchPublicIntegration, PostIntegration, PostPublicIntegration, PostPublicQuickstartIntegration } from './integration/api.js';
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api.js';
@@ -28,8 +28,8 @@ import type { GetPublicSyncStatus, PostPublicSyncPause, PostPublicSyncStart, Pos
 import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api.js';
 import type { GetUser, PatchUser } 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 | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostRemoteFunctionCompile | PostRemoteFunctionDryrun | PostRemoteFunctionDeploy | GetPublicFunctionCode | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunctions | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | 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;
+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 | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | PostRemoteFunctionCompile | PostRemoteFunctionDryrun | PostRemoteFunctionDeploy | GetPublicFunctionCode | AllPublicProxy;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | 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;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/environment/db.d.ts

@@ -85,6 +85,9 @@ export interface DBCustomerKey extends Timestamps {
     iv: string;
     tag: string;
     hashed: string;
+    sandbox_signing_secret: string | null;
+    sandbox_signing_secret_iv: string | null;
+    sandbox_signing_secret_tag: string | null;
     last_used_at: Date | null;
     deleted_at: Date | null;
 }

package/dist/functions/api.d.ts

@@ -1,9 +1,7 @@
 import type { ApiError, Endpoint } from '../api.js';
-import type { OnEventType } from '../scripts/on-events/api.js';
-import type { FunctionSource } from '../syncConfigs/db.js';
-import type { JSONSchema7 } from 'json-schema';
-export type FunctionType = 'action' | 'sync' | 'on-event';
-export type FunctionErrorCode = 'invalid_request' | 'integration_not_found' | 'compilation_error' | 'dryrun_error' | 'deployment_error' | 'connection_not_found' | 'function_disabled' | 'timeout' | 'validation_error';
+import type { DeployedNangoFunction, FunctionType, NangoActionFunction, NangoFunctionTemplate, NangoSyncFunction } from './domain.js';
+export type RunnableFunctionType = Extract<FunctionType, 'action' | 'sync'>;
+export type FunctionErrorCode = 'invalid_request' | 'integration_not_found' | 'compilation_error' | 'dryrun_error' | 'deployment_error' | 'connection_not_found' | 'dryrun_not_found' | 'function_disabled' | 'execution_environment_unavailable' | 'timeout' | 'validation_error';
 export interface ProxyCall {
     method: string;
     endpoint: string;
@@ -16,114 +14,176 @@ export interface ProxyCall {
     response: unknown;
     headers: Record<string, unknown>;
 }
-export type PostRemoteFunctionCompile = Endpoint<{
-    Method: 'POST';
-    Path: '/remote-function/compile';
-    Body: {
-        integration_id: string;
-        function_name: string;
-        function_type: FunctionType;
-        code: string;
+export interface FunctionCompileBody {
+    code: string;
+}
+export interface FunctionCompileSuccess {
+    bundle_size_bytes: number;
+    bundled_js: string;
+    compiled_at: string;
+}
+export interface FunctionDryrunBody {
+    integration_id: string;
+    function_type: RunnableFunctionType;
+    code: string;
+    connection_id: string;
+    input?: unknown;
+    metadata?: Record<string, unknown> | undefined;
+    checkpoint?: Record<string, unknown> | undefined;
+    last_sync_date?: string | undefined;
+}
+export type FunctionDryrunStatus = 'waiting' | 'running' | 'success' | 'failed';
+export interface FunctionDryrunCreateSuccess {
+    id: string;
+    status: Extract<FunctionDryrunStatus, 'waiting' | 'running'>;
+    created_at: string;
+}
+export interface FunctionDryrunResultSuccess {
+    id: string;
+    status: FunctionDryrunStatus;
+    integration_id: string;
+    function_type: RunnableFunctionType;
+    created_at: string;
+    updated_at: string;
+    started_at?: string | undefined;
+    completed_at?: string | undefined;
+    duration_ms?: number | undefined;
+    output?: string | undefined;
+    result?: unknown;
+    error?: ApiError<FunctionErrorCode>['error'] | undefined;
+}
+export type FunctionDryrunResultBody = {
+    status: 'success';
+    output: string;
+    duration_ms?: number | undefined;
+} | {
+    status: 'failed';
+    output?: string | undefined;
+    duration_ms?: number | undefined;
+    error: {
+        code?: string | undefined;
+        message: string;
+        payload?: unknown;
     };
+};
+export interface FunctionDeploymentBody {
+    type: 'function';
+    integration_id: string;
+    function_name: string;
+    function_type: RunnableFunctionType;
+    code: string;
+    version?: string | undefined;
+    allow_destructive?: boolean | undefined;
+}
+export interface FunctionDeploySuccess {
+    integration_id: string;
+    function_name: string;
+    function_type: RunnableFunctionType;
+    deployed: boolean;
+    deployed_functions: {
+        name: string;
+        version: string;
+    }[];
+    output: string;
+}
+export type PostFunctionCompile = Endpoint<{
+    Method: 'POST';
+    Path: '/functions/compile';
+    Body: FunctionCompileBody;
     Error: ApiError<FunctionErrorCode>;
-    Success: {
-        integration_id: string;
-        function_name: string;
-        function_type: FunctionType;
-        bundle_size_bytes: number;
-        bundled_js: string;
-        compiled_at: string;
-    };
+    Success: FunctionCompileSuccess;
 }>;
-export type PostRemoteFunctionDryrun = Endpoint<{
+export type PostFunctionDryrun = Endpoint<{
     Method: 'POST';
-    Path: '/remote-function/dryrun';
-    Body: {
-        integration_id: string;
-        function_name: string;
-        function_type: FunctionType;
-        code: string;
-        connection_id: string;
-        input?: unknown;
-        metadata?: Record<string, unknown> | undefined;
-        checkpoint?: Record<string, unknown> | undefined;
-        last_sync_date?: string | undefined;
-    };
+    Path: '/functions/dryruns';
+    Body: FunctionDryrunBody;
     Error: ApiError<FunctionErrorCode>;
-    Success: {
-        integration_id: string;
-        function_name: string;
-        function_type: FunctionType;
-        execution_timeout_at: string;
-        duration_ms: number;
-        result?: unknown;
+    Success: FunctionDryrunCreateSuccess;
+}>;
+export type GetFunctionDryrun = Endpoint<{
+    Method: 'GET';
+    Path: '/functions/dryruns/:id';
+    Params: {
+        id: string;
     };
+    Error: ApiError<FunctionErrorCode>;
+    Success: FunctionDryrunResultSuccess;
 }>;
-export type PostRemoteFunctionDeploy = Endpoint<{
+export type PostFunctionDryrunResult = Endpoint<{
     Method: 'POST';
-    Path: '/remote-function/deploy';
-    Body: {
-        integration_id: string;
-        function_name: string;
-        function_type: FunctionType;
-        code: string;
+    Path: '/functions/dryruns/:id/result';
+    Params: {
+        id: string;
     };
+    Body: FunctionDryrunResultBody;
     Error: ApiError<FunctionErrorCode>;
     Success: {
-        integration_id: string;
-        function_name: string;
-        function_type: FunctionType;
-        deployed: boolean;
-        deployed_functions: {
-            name: string;
-            version: string;
-        }[];
-        output: string;
+        ok: true;
     };
 }>;
-interface NangoFunctionBase {
-    name: string;
-    description?: string;
-    scopes?: string[];
+export type PostFunctionDeployment = Endpoint<{
+    Method: 'POST';
+    Path: '/functions/deployments';
+    Body: FunctionDeploymentBody;
+    Error: ApiError<FunctionErrorCode>;
+    Success: FunctionDeploySuccess;
+}>;
+export interface RemoteFunctionCompileBody {
+    integration_id: string;
+    function_name: string;
+    function_type: RunnableFunctionType;
+    code: string;
 }
-export interface NangoSyncFunction extends NangoFunctionBase {
-    type: 'sync';
-    input?: string;
-    returns: string[];
-    json_schema: JSONSchema7 | null;
-    /** Cron expression. */
-    runs: string | null;
-    auto_start: boolean;
-    track_deletes: boolean;
+export interface RemoteFunctionCompileSuccess extends FunctionCompileSuccess {
+    integration_id: string;
+    function_name: string;
+    function_type: RunnableFunctionType;
 }
-export interface NangoActionFunction extends NangoFunctionBase {
-    type: 'action';
-    input?: string;
-    returns: string[];
-    json_schema: JSONSchema7 | null;
+export interface RemoteFunctionDryrunBody extends RemoteFunctionCompileBody {
+    connection_id: string;
+    input?: unknown;
+    metadata?: Record<string, unknown> | undefined;
+    checkpoint?: Record<string, unknown> | undefined;
+    last_sync_date?: string | undefined;
 }
-export interface NangoOnEventFunction extends NangoFunctionBase {
-    type: 'on-event';
-    event: OnEventType;
+export interface RemoteFunctionDryrunSuccess {
+    integration_id: string;
+    function_name: string;
+    function_type: RunnableFunctionType;
+    duration_ms: number;
+    result?: unknown;
 }
-export type NangoFunction = NangoSyncFunction | NangoActionFunction | NangoOnEventFunction;
-interface DeployedMeta {
-    id: number;
-    enabled: boolean;
-    /** ISO-8601 timestamp. */
-    last_deployed: string;
-    source: FunctionSource;
+export interface RemoteFunctionDeployBody extends RemoteFunctionCompileBody {
+    allow_destructive?: boolean | undefined;
 }
-export type NangoSyncFunctionDeployed = NangoSyncFunction & DeployedMeta;
-export type NangoActionFunctionDeployed = NangoActionFunction & DeployedMeta;
-export type NangoOnEventFunctionDeployed = NangoOnEventFunction & DeployedMeta;
-export type NangoFunctionDeployed = NangoSyncFunctionDeployed | NangoActionFunctionDeployed | NangoOnEventFunctionDeployed;
+export type PostRemoteFunctionCompile = Endpoint<{
+    Method: 'POST';
+    Path: '/remote-function/compile';
+    Body: RemoteFunctionCompileBody;
+    Error: ApiError<FunctionErrorCode>;
+    Success: RemoteFunctionCompileSuccess;
+}>;
+export type PostRemoteFunctionDryrun = Endpoint<{
+    Method: 'POST';
+    Path: '/remote-function/dryrun';
+    Body: RemoteFunctionDryrunBody;
+    Error: ApiError<FunctionErrorCode>;
+    Success: RemoteFunctionDryrunSuccess;
+}>;
+export type PostRemoteFunctionDeploy = Endpoint<{
+    Method: 'POST';
+    Path: '/remote-function/deploy';
+    Body: RemoteFunctionDeployBody;
+    Error: ApiError<FunctionErrorCode>;
+    Success: FunctionDeploySuccess;
+}>;
 export type GetIntegrationFunctions = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey/functions';
     Querystring: {
         env: string;
         type?: FunctionType;
+        search?: string;
         page?: number;
         limit?: number;
     };
@@ -131,7 +191,7 @@ export type GetIntegrationFunctions = Endpoint<{
         providerConfigKey: string;
     };
     Success: {
-        data: NangoFunctionDeployed[];
+        data: DeployedNangoFunction[];
         pagination: {
             total: number;
             page: number;
@@ -139,6 +199,21 @@ export type GetIntegrationFunctions = Endpoint<{
         };
     };
 }>;
+export type GetIntegrationFunction = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/integrations/:providerConfigKey/functions/:functionName';
+    Querystring: {
+        env: string;
+        type?: FunctionType;
+    };
+    Params: {
+        providerConfigKey: string;
+        functionName: string;
+    };
+    Success: {
+        data: DeployedNangoFunction;
+    };
+}>;
 export type GetProviderTemplates = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/providers/:providerConfigKey/templates';
@@ -152,4 +227,16 @@ export type GetProviderTemplates = Endpoint<{
         data: (NangoSyncFunction | NangoActionFunction)[];
     };
 }>;
-export {};
+export type GetIntegrationTemplates = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/integrations/:providerConfigKey/templates';
+    Querystring: {
+        env: string;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Success: {
+        data: NangoFunctionTemplate[];
+    };
+}>;

package/dist/functions/domain.d.ts

@@ -0,0 +1,45 @@
+import type { OnEventType } from '../scripts/on-events/api.js';
+import type { FunctionSource } from '../syncConfigs/db.js';
+import type { JSONSchema7 } from 'json-schema';
+export type FunctionType = 'action' | 'sync' | 'on-event';
+interface NangoFunctionBase {
+    name: string;
+    description?: string;
+    scopes?: string[];
+}
+export interface NangoSyncFunction extends NangoFunctionBase {
+    type: 'sync';
+    input?: string;
+    returns: string[];
+    json_schema: JSONSchema7 | null;
+    /** Schedule expression such as `every day`. */
+    runs: string | null;
+    auto_start: boolean;
+    track_deletes: boolean;
+}
+export interface NangoActionFunction extends NangoFunctionBase {
+    type: 'action';
+    input?: string;
+    returns: string[];
+    json_schema: JSONSchema7 | null;
+}
+export interface NangoOnEventFunction extends NangoFunctionBase {
+    type: 'on-event';
+    event: OnEventType;
+}
+export type NangoFunction = NangoSyncFunction | NangoActionFunction | NangoOnEventFunction;
+export interface DeployedMeta {
+    id: number;
+    enabled: boolean;
+    /** ISO-8601 timestamp. */
+    last_deployed: string;
+    source: FunctionSource;
+}
+export type DeployedNangoSyncFunction = NangoSyncFunction & DeployedMeta;
+export type DeployedNangoActionFunction = NangoActionFunction & DeployedMeta;
+export type DeployedNangoOnEventFunction = NangoOnEventFunction & DeployedMeta;
+export type DeployedNangoFunction = DeployedNangoSyncFunction | DeployedNangoActionFunction | DeployedNangoOnEventFunction;
+export type NangoFunctionTemplate = (NangoSyncFunction | NangoActionFunction) & {
+    deployed?: DeployedMeta;
+};
+export {};

package/dist/index.d.ts

@@ -88,6 +88,7 @@ export type * from './checkpoint/types.js';
 export type * from './checkpoint/db.js';
 export type * from './mcp/api.js';
 export type * from './functions/api.js';
+export type * from './functions/domain.js';
 export type * from './lambda/index.js';
 export type * from './authz/types.js';
 export type * from './pubsub/events.js';

package/dist/integration/api.d.ts

@@ -21,6 +21,13 @@ export interface ApiPublicIntegrationInclude {
         app_id: string | null;
         private_key: string | null;
         app_link: string | null;
+    } | {
+        type: AuthModes['Custom'];
+        client_id: string | null;
+        client_secret: string | null;
+        app_id: string | null;
+        app_link: string | null;
+        private_key: string | null;
     } | null;
 }
 export type GetPublicListIntegrations = Endpoint<{

package/dist/persist/api.d.ts

@@ -16,6 +16,29 @@ export type PostLog = Endpoint<{
     Error: ApiError<'post_log_failed'>;
     Success: never;
 }>;
+type WithTags<T> = T & {
+    integrationId: string;
+    connectionId: string;
+    syncId?: string | undefined;
+};
+export type RunnerDataTransferTelemetry = WithTags<{
+    type: 'data_transfer';
+    bytesSent: number;
+    bytesReceived: number;
+}>;
+export type RunnerTelemetry = RunnerDataTransferTelemetry;
+export type PostRunnerTelemetry = Endpoint<{
+    Method: 'POST';
+    Path: '/environment/:environmentId/runner/telemetry';
+    Params: {
+        environmentId: number;
+    };
+    Body: {
+        events: RunnerTelemetry[];
+    };
+    Error: ApiError<'post_runner_telemetry_failed'>;
+    Success: never;
+}>;
 export interface PostRecordsSuccess {
     nextMerging: MergingStrategy;
 }

package/dist/plans/db.d.ts

@@ -80,6 +80,11 @@ export interface DBPlan extends Timestamps {
      * @default false
      */
     has_otel: boolean;
+    /**
+     * Enable runner telemetry export to persist
+     * @default false
+     */
+    export_runner_telemetry: boolean;
     /**
      * Change the applied rate limit for the public API
      * @default "m"

package/dist/runner/index.d.ts

@@ -21,6 +21,7 @@ export interface RunnerFlags {
     validateActionOutput: boolean;
     validateSyncRecords: boolean;
     validateSyncMetadata: boolean;
+    exportRunnerTelemetry: boolean;
 }
 export interface RoutingContext {
     plan: DBPlan | null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.70.4",
+    "version": "0.70.6",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -12,7 +12,7 @@
         "directory": "packages/utils"
     },
     "dependencies": {
-        "axios": "1.15.2",
+        "axios": "1.16.1",
         "json-schema": "0.4.0",
         "type-fest": "4.41.0"
     },