@nangohq/types 0.69.22 → 0.69.24

package/dist/api.endpoints.d.ts

@@ -8,7 +8,7 @@ import type { GetConnectUISettings, PutConnectUISettings } from './connectUISett
 import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata.js';
 import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api.js';
-import type { DeleteEnvironment, PatchEnvironment, PostEnvironment } from './environment/api/index.js';
+import type { DeleteEnvironment, GetEnvironments, PatchEnvironment, PostEnvironment } from './environment/api/index.js';
 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';
@@ -28,7 +28,7 @@ import type { DeleteTeamUser, GetTeam, 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 | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/auth/api.d.ts

@@ -16,6 +16,7 @@ export interface AuthModes {
     Signature: 'SIGNATURE';
     MCP_OAUTH2: 'MCP_OAUTH2';
     MCP_OAUTH2_GENERIC: 'MCP_OAUTH2_GENERIC';
+    InstallPlugin: 'INSTALL_PLUGIN';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
 export type AuthOperationType = 'creation' | 'override' | 'refresh' | 'unknown';
@@ -140,6 +141,10 @@ export interface SignatureCredentials {
     token?: string;
     expires_at?: Date | undefined;
 }
+export interface InstallPluginCredentials {
+    type: AuthModes['Basic'];
+    [key: string]: any;
+}
 export interface CombinedOauth2AppCredentials extends CredentialsCommon {
     type: AuthModes['Custom'];
     app: AppCredentials;
@@ -152,4 +157,4 @@ export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'typ
 }
 export type TestableCredentials = ApiKeyCredentials | BasicApiCredentials | TbaCredentials | JwtCredentials | SignatureCredentials;
 export type RefreshableCredentials = OAuth2Credentials | AppCredentials | AppStoreCredentials | OAuth2ClientCredentials | JwtCredentials | TwoStepCredentials | BillCredentials | SignatureCredentials;
-export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | JwtCredentials | BillCredentials | TwoStepCredentials | CombinedOauth2AppCredentials | SignatureCredentials;
+export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | JwtCredentials | BillCredentials | TwoStepCredentials | CombinedOauth2AppCredentials | SignatureCredentials | InstallPluginCredentials;

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

@@ -84,6 +84,7 @@ export type PostPublicTbaAuthorization = Endpoint<{
         token_secret: string;
         oauth_client_id_override?: string | undefined;
         oauth_client_secret_override?: string | undefined;
+        oauth_refresh_token_override?: string | undefined;
     };
     Querystring: ConnectionQueryString;
     Params: {

package/dist/connect/api.d.ts

@@ -78,7 +78,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'>;
+    Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization' | 'integrations_config_defaults' | 'overrides'>;
 }>;
 export type PostPublicConnectTelemetry = Endpoint<{
     Method: 'POST';

package/dist/environment/api/index.d.ts

@@ -7,6 +7,13 @@ export type ApiEnvironment = Omit<Merge<DBEnvironment, {
     callback_url: string;
 } & ApiTimestamps>, 'secret_key_iv' | 'secret_key_tag' | 'secret_key_hashed' | 'pending_secret_key_iv' | 'pending_secret_key_tag' | 'pending_public_key'>;
 export type ApiWebhooks = Omit<DBExternalWebhook, 'id' | 'environment_id' | 'created_at' | 'updated_at'>;
+export type GetEnvironments = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/environments';
+    Success: {
+        data: Pick<DBEnvironment, 'name'>[];
+    };
+}>;
 export type PostEnvironment = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/environments';

package/dist/environment/db.d.ts

@@ -56,3 +56,13 @@ export interface DBExternalWebhook extends Timestamps {
     on_sync_error: boolean;
     on_async_action_completion: boolean;
 }
+export interface DBAPISecret extends Timestamps {
+    id: number;
+    environment_id: number;
+    display_name: string;
+    secret: string;
+    iv: string;
+    tag: string;
+    hashed: string;
+    is_default: boolean;
+}

package/dist/environment/variable/api.d.ts

@@ -4,6 +4,9 @@ export type ApiEnvironmentVariable = Pick<DBEnvironmentVariable, 'name' | 'value
 export type PostEnvironmentVariables = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/environments/variables';
+    Querystring: {
+        env: string;
+    };
     Body: {
         variables: {
             name: string;

package/dist/fleet/api.d.ts

@@ -1,9 +1,10 @@
 import type { ApiError, Endpoint } from '../api.js';
-import type { Deployment } from './index.js';
+import type { Deployment, ImageType } from './index.js';
 export type PostRollout = Endpoint<{
     Method: 'POST';
     Path: '/fleet/:fleetId/rollout';
     Body: {
+        imageType?: ImageType;
         image: string;
     };
     Params: {

package/dist/fleet/index.d.ts

@@ -5,6 +5,7 @@ export interface Deployment {
     readonly supersededAt: Date | null;
 }
 export type RoutingId = string;
+export type ImageType = 'docker' | 'ecr';
 export interface NodeConfig {
     readonly image: string;
     readonly cpuMilli: number;
@@ -13,4 +14,6 @@ export interface NodeConfig {
     readonly isTracingEnabled: boolean;
     readonly isProfilingEnabled: boolean;
     readonly idleMaxDurationMs: number;
+    readonly executionTimeoutSecs: number;
+    readonly provisionedConcurrency: number;
 }

package/dist/integration/api.d.ts

@@ -95,6 +95,8 @@ export type ApiIntegrationList = ApiIntegration & {
         missingFieldsCount: number;
         connectionConfigParams?: string[];
         credentialParams?: string[];
+        assertionOptionParams?: string[];
+        authorizationParams?: Record<string, string>;
         displayName: string;
         requireClientCertificate?: boolean;
         installation?: 'outbound';
@@ -107,6 +109,43 @@ export type GetIntegrations = Endpoint<{
         data: ApiIntegrationList[];
     };
 }>;
+export interface OAuthAuthBody {
+    authType: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+    scopes?: string | undefined;
+}
+export interface AppAuthBody {
+    authType: Extract<AuthModeType, 'APP'>;
+    appId?: string | undefined;
+    appLink?: string | undefined;
+    privateKey?: string | undefined;
+}
+export interface CustomAuthBody {
+    authType: Extract<AuthModeType, 'CUSTOM'>;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+    appId?: string | undefined;
+    appLink?: string | undefined;
+    privateKey?: string | undefined;
+}
+export interface MCPOAuth2AuthBody {
+    authType: Extract<AuthModeType, 'MCP_OAUTH2'>;
+    scopes?: string | undefined;
+}
+export interface MCPOAuth2GenericAuthBody {
+    authType: Extract<AuthModeType, 'MCP_OAUTH2_GENERIC'>;
+    clientName?: string | undefined;
+    clientUri?: string | undefined;
+    clientLogoUri?: string | undefined;
+}
+export interface InstallPluginAuthBody {
+    authType: Extract<AuthModeType, 'INSTALL_PLUGIN'>;
+    appLink?: string | undefined;
+    username?: string | undefined;
+    password?: string | undefined;
+}
+export type IntegrationAuthBody = OAuthAuthBody | AppAuthBody | CustomAuthBody | MCPOAuth2AuthBody | MCPOAuth2GenericAuthBody | InstallPluginAuthBody;
 export type PostIntegration = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/integrations';
@@ -116,6 +155,11 @@ export type PostIntegration = Endpoint<{
     Body: {
         provider: string;
         useSharedCredentials: boolean;
+        integrationId?: string | undefined;
+        webhookSecret?: string | undefined;
+        displayName?: string | undefined;
+        forward_webhooks?: boolean | undefined;
+        auth?: IntegrationAuthBody | undefined;
     };
     Success: {
         data: ApiIntegration;
@@ -156,32 +200,7 @@ export type PatchIntegration = Endpoint<{
         webhookSecret?: string | undefined;
         displayName?: string | undefined;
         forward_webhooks?: boolean | undefined;
-    } | {
-        authType: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
-        clientId?: string | undefined;
-        clientSecret?: string | undefined;
-        scopes?: string | undefined;
-    } | {
-        authType: Extract<AuthModeType, 'APP'>;
-        appId?: string | undefined;
-        appLink?: string | undefined;
-        privateKey?: string | undefined;
-    } | {
-        authType: Extract<AuthModeType, 'CUSTOM'>;
-        clientId?: string | undefined;
-        clientSecret?: string | undefined;
-        appId?: string | undefined;
-        appLink?: string | undefined;
-        privateKey?: string | undefined;
-    } | {
-        authType: Extract<AuthModeType, 'MCP_OAUTH2'>;
-        scopes?: string | undefined;
-    } | {
-        authType: Extract<AuthModeType, 'MCP_OAUTH2_GENERIC'>;
-        clientName?: string | undefined;
-        clientUri?: string | undefined;
-        clientLogoUri?: string | undefined;
-    };
+    } | IntegrationAuthBody;
     Success: {
         data: {
             success: boolean;

package/dist/plans/db.d.ts

@@ -1,4 +1,5 @@
 import type { Timestamps } from '../db.js';
+type FunctionRuntime = 'runner' | 'lambda';
 export interface DBPlan extends Timestamps {
     id: number;
     account_id: number;
@@ -119,4 +120,25 @@ export interface DBPlan extends Timestamps {
      * @default false
      */
     can_disable_connect_ui_watermark: boolean;
+    /**
+     * Sync Function Runtime
+     * @default "runner"
+     */
+    sync_function_runtime: FunctionRuntime;
+    /**
+     * Action Function Runtime
+     * @default "runner"
+     */
+    action_function_runtime: FunctionRuntime;
+    /**
+     * Webhook Function Runtime
+     * @default "runner"
+     */
+    webhook_function_runtime: FunctionRuntime;
+    /**
+     * On Event Function Runtime
+     * @default "runner"
+     */
+    on_event_function_runtime: FunctionRuntime;
 }
+export {};

package/dist/providers/api.d.ts

@@ -36,6 +36,7 @@ export interface ApiProviderListItem {
     authMode: AuthModeType;
     categories?: string[] | undefined;
     docs: string;
+    docs_connect?: string | undefined;
     preConfigured: boolean;
     preConfiguredScopes: string[];
 }

package/dist/providers/provider.d.ts

@@ -83,6 +83,7 @@ export interface BaseProvider {
     connection_configuration?: string[];
     connection_config?: Record<string, SimplifiedJSONSchema>;
     credentials?: Record<string, SimplifiedJSONSchema>;
+    assertion_option?: Record<string, SimplifiedJSONSchema>;
     authorization_url_fragment?: string;
     body_format?: OAuthBodyFormatType;
     require_client_certificate?: boolean;
@@ -190,6 +191,16 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
         token_url: string;
         token_request_method?: 'GET';
     }[];
+    assertion?: {
+        key?: string;
+        issuer?: string;
+        lifetimeInSeconds?: number;
+        audiences?: string | string[];
+        attributes?: Record<string, string | number | boolean | (string | number | boolean)[]>;
+        sessionIndex?: string;
+        recipient?: string;
+    };
+    assertion_option?: Record<string, SimplifiedJSONSchema>;
     token_expires_in_ms?: number;
     proxy_header_authorization?: string;
     body_format?: 'xml' | 'json' | 'form';
@@ -206,6 +217,10 @@ export interface ProviderSignature extends BaseProvider {
 export interface ProviderApiKey extends BaseProvider {
     auth_mode: 'API_KEY';
 }
-export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature | ProviderApiKey | ProviderBill | ProviderGithubApp | ProviderAppleAppStore | ProviderCustom | ProviderMcpOAUTH2 | ProviderMcpOAuth2Generic;
+export interface ProviderInstallPlugin extends BaseProvider {
+    auth_mode: 'INSTALL_PLUGIN';
+    auth_type: 'BASIC';
+}
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature | ProviderApiKey | ProviderBill | ProviderGithubApp | ProviderAppleAppStore | ProviderCustom | ProviderMcpOAUTH2 | ProviderMcpOAuth2Generic | ProviderInstallPlugin;
 export type RefreshableProvider = ProviderTwoStep | ProviderJwt | ProviderSignature | ProviderOAuth2 | ProviderMcpOAuth2Generic;
 export type TestableProvider = ProviderApiKey;

package/dist/runner/index.d.ts

@@ -1,4 +1,5 @@
 import type { TelemetryBag } from './sdk.js';
+import type { DBPlan } from '../plans/db.js';
 export interface RunnerOutputError {
     type: string;
     payload: Record<string, unknown> | unknown[];
@@ -18,3 +19,6 @@ export interface RunnerFlags {
     validateSyncRecords: boolean;
     validateSyncMetadata: boolean;
 }
+export interface RuntimeContext {
+    plan: DBPlan | null;
+}

package/dist/runner/sdk.d.ts

@@ -7,8 +7,9 @@ import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResp
 export interface SdkLogger {
     level: LogLevel | 'off';
 }
+export type ScriptType = 'sync' | 'action' | 'webhook' | 'on-event';
 export interface NangoProps {
-    scriptType: 'sync' | 'action' | 'webhook' | 'on-event';
+    scriptType: ScriptType;
     host?: string;
     secretKey: string;
     team: Pick<DBTeam, 'id' | 'name'>;

package/package.json

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