@nangohq/types 0.44.0 → 0.45.0

package/dist/api.endpoints.d.ts

@@ -1,18 +1,21 @@
 import type { EndpointMethod } from './api';
 import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api';
-import type { GetOnboardingStatus } from './onboarding/api';
+import type { PatchOnboarding } from './onboarding/api';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata';
-import type { PostDeploy, PostDeployConfirmation } from './deploy/api';
+import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api';
 import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api';
-import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup } from './account/api';
-import type { DeleteInvite, PostInvite } from './invitations/api';
+import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup, GetEmailByExpiredToken, GetEmailByUuid, GetManagedCallback, PostManagedSignup } from './account/api';
+import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api';
 import type { GetUser, PatchUser } from './user/api';
-import type { DeletePublicIntegration, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy } from './integration/api';
-import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization, PostPublicJwtAuthorization } from './auth/http.api';
+import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy, PatchIntegration, PostIntegration } from './integration/api';
+import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization, PostPublicJwtAuthorization, PostPublicBillAuthorization, PostPublicSignatureAuthorization, PostPublicTwoStepAuthorization } from './auth/http.api';
 import type { GetPublicProvider, GetPublicProviders } from './providers/api';
-import type { PostConnectSessions, PostInternalConnectSessions } from './connect/api';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions;
-export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | PostInternalConnectSessions;
+import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions } from './connect/api';
+import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnections, PostConnectionRefresh } from './connection/api/get';
+import type { GetMeta } from './meta/api';
+import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | GetPublicConnections | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization;
+export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PatchOnboarding | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

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

@@ -1,4 +1,14 @@
 import type { ApiError, Endpoint } from '../api';
+export type ConnectionQueryString = {
+    connection_id?: string | undefined;
+    params?: Record<string, any> | undefined;
+    user_scope?: string | undefined;
+} & ({
+    public_key: string;
+    hmac?: string | undefined;
+} | {
+    connect_session_token: string;
+});
 export type PostPublicTbaAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
@@ -7,15 +17,11 @@ export type PostPublicTbaAuthorization = Endpoint<{
         oauth_client_id_override?: string | undefined;
         oauth_client_secret_override?: string | undefined;
     };
-    Querystring: {
-        connection_id?: string | undefined;
-        params?: Record<string, any> | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/tba';
+    Path: '/auth/tba/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
@@ -29,15 +35,11 @@ export type PostPublicTableauAuthorization = Endpoint<{
         pat_secret: string;
         content_url?: string | undefined;
     };
-    Querystring: {
-        connection_id?: string | undefined;
-        params?: Record<string, any> | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/tableau';
+    Path: '/auth/tableau/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
@@ -54,15 +56,11 @@ export type PostPublicJwtAuthorization = Endpoint<{
             secret: string;
         } | string;
     };
-    Querystring: {
-        connection_id?: string | undefined;
-        params?: Record<string, any> | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/jwt';
+    Path: '/auth/jwt/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
@@ -71,14 +69,11 @@ export type PostPublicJwtAuthorization = Endpoint<{
 }>;
 export type PostPublicUnauthenticatedAuthorization = Endpoint<{
     Method: 'POST';
-    Querystring: {
-        connection_id?: string | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/unauthenticated';
+    Path: '/auth/unauthenticated/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
@@ -93,15 +88,11 @@ export type PostPublicBillAuthorization = Endpoint<{
         organization_id: string;
         dev_key: string;
     };
-    Querystring: {
-        connection_id?: string | undefined;
-        params?: Record<string, any> | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/bill';
+    Path: '/auth/bill/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
@@ -111,15 +102,11 @@ export type PostPublicBillAuthorization = Endpoint<{
 export type PostPublicTwoStepAuthorization = Endpoint<{
     Method: 'POST';
     Body: Record<string, any>;
-    Querystring: {
-        connection_id?: string | undefined;
-        params?: Record<string, any> | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/two-step';
+    Path: '/auth/two-step/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;
@@ -132,15 +119,11 @@ export type PostPublicSignatureAuthorization = Endpoint<{
         username: string;
         password: string;
     };
-    Querystring: {
-        connection_id?: string | undefined;
-        params?: Record<string, any> | undefined;
-        hmac?: string | undefined;
-    };
+    Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;
     };
-    Path: '/auth/signature-based';
+    Path: '/auth/signature-based/:providerConfigKey';
     Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
     Success: {
         providerConfigKey: string;

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

@@ -35,6 +35,8 @@ export type GetConnectionsCount = Endpoint<{
         data: {
             total: number;
             withAuthError: number;
+            withSyncError: number;
+            withError: number;
         };
     };
 }>;

package/dist/deploy/api.d.ts

@@ -1,13 +1,13 @@
 import type { JSONSchema7 } from 'json-schema';
 import type { Endpoint, ApiError } from '../api.js';
-import type { IncomingFlowConfig, PostConnectionScriptByProvider } from './incomingFlow.js';
+import type { IncomingFlowConfig, OnEventScriptsByProvider } from './incomingFlow.js';
 import type { SyncDeploymentResult } from './index.js';
 export type PostDeployConfirmation = Endpoint<{
     Method: 'POST';
     Path: '/sync/deploy/confirmation';
     Body: {
         flowConfigs: IncomingFlowConfig[];
-        postConnectionScriptsByProvider: PostConnectionScriptByProvider[];
+        onEventScriptsByProvider?: OnEventScriptsByProvider[] | undefined;
         reconcile: boolean;
         debug: boolean;
         singleDeployMode?: boolean;
@@ -20,7 +20,7 @@ export type PostDeploy = Endpoint<{
     Path: '/sync/deploy';
     Body: {
         flowConfigs: IncomingFlowConfig[];
-        postConnectionScriptsByProvider: PostConnectionScriptByProvider[];
+        onEventScriptsByProvider?: OnEventScriptsByProvider[] | undefined;
         nangoYamlBody: string;
         reconcile: boolean;
         debug: boolean;
@@ -37,7 +37,7 @@ export type PostDeployInternal = Endpoint<{
     };
     Body: {
         flowConfigs: IncomingFlowConfig[];
-        postConnectionScriptsByProvider: PostConnectionScriptByProvider[];
+        onEventScriptsByProvider?: OnEventScriptsByProvider[] | undefined;
         nangoYamlBody: string;
         reconcile: boolean;
         debug: boolean;

package/dist/deploy/incomingFlow.d.ts

@@ -1,16 +1,17 @@
 import type { Merge } from 'type-fest';
-import type { NangoModel, NangoSyncEndpointOld, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+import type { NangoModel, NangoSyncEndpointOld, NangoSyncEndpointV2, OnEventType, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
 export interface IncomingScriptFiles {
     js: string;
     ts: string;
 }
-export interface IncomingPostConnectionScript {
+export interface IncomingOnEventScript {
     name: string;
     fileBody: IncomingScriptFiles;
+    event: OnEventType;
 }
-export interface PostConnectionScriptByProvider {
+export interface OnEventScriptsByProvider {
     providerConfigKey: string;
-    scripts: IncomingPostConnectionScript[];
+    scripts: IncomingOnEventScript[];
 }
 export interface NangoConfigMetadata {
     scopes?: string[] | undefined;

package/dist/index.d.ts

@@ -40,6 +40,7 @@ export type * from './endpoints/db.js';
 export type * from './connect/api.js';
 export type * from './connect/session.js';
 export type * from './endUser/index.js';
+export type * from './runner/index.js';
 export type * from './nangoYaml/index.js';
 export type * from './environment/db.js';
 export type * from './environment/api/webhook.js';

package/dist/integration/api.d.ts

@@ -54,6 +54,9 @@ export type DeletePublicIntegration = Endpoint<{
 export type PostIntegration = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/integrations';
+    Querystring: {
+        env: string;
+    };
     Body: {
         provider: string;
     };
@@ -65,6 +68,9 @@ export type ApiIntegration = Merge<IntegrationConfig, ApiTimestamps>;
 export type GetIntegration = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey';
+    Querystring: {
+        env: string;
+    };
     Params: {
         providerConfigKey: string;
     };
@@ -83,6 +89,9 @@ export type GetIntegration = Endpoint<{
 export type PatchIntegration = Endpoint<{
     Method: 'PATCH';
     Path: '/api/v1/integrations/:providerConfigKey';
+    Querystring: {
+        env: string;
+    };
     Params: {
         providerConfigKey: string;
     };
@@ -116,6 +125,9 @@ export type PatchIntegration = Endpoint<{
 export type DeleteIntegration = Endpoint<{
     Method: 'DELETE';
     Path: '/api/v1/integrations/:providerConfigKey';
+    Querystring: {
+        env: string;
+    };
     Params: {
         providerConfigKey: string;
     };
@@ -145,7 +157,6 @@ export interface NangoSyncConfig {
     id?: number;
     input?: NangoModel | LegacySyncModelSchema;
     sync_type?: SyncType;
-    nango_yaml_version?: string;
     webhookSubscriptions?: string[];
     enabled?: boolean;
     json_schema: JSONSchema7 | null;
@@ -154,6 +165,9 @@ export interface NangoSyncConfig {
 export type GetIntegrationFlows = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey/flows';
+    Querystring: {
+        env: string;
+    };
     Params: {
         providerConfigKey: string;
     };

package/dist/nangoYaml/index.d.ts

@@ -1,6 +1,6 @@
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export type SyncTypeLiteral = 'incremental' | 'full';
-export type ScriptFileType = 'actions' | 'syncs' | 'post-connection-scripts';
+export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'post-connection-scripts';
 export type ScriptTypeLiteral = 'action' | 'sync';
 export interface NangoYamlV1 {
     integrations: Record<string, Record<string, NangoYamlV1Integration>>;
@@ -28,6 +28,10 @@ export interface NangoYamlV2Integration {
     provider?: string;
     syncs?: Record<string, NangoYamlV2IntegrationSync>;
     actions?: Record<string, NangoYamlV2IntegrationAction>;
+    'on-events'?: Record<string, string[]>;
+    /**
+     * @deprecated
+     */
     'post-connection-scripts'?: string[];
 }
 export interface NangoYamlV2IntegrationSync {
@@ -59,6 +63,7 @@ export interface NangoYamlModelFields {
 }
 export type NangoYamlModelField = boolean | number | string | null | string[] | NangoYamlModelFields;
 export type NangoYaml = NangoYamlV1 | NangoYamlV2;
+export type OnEventType = 'post-connection-creation' | 'pre-connection-deletion';
 export interface NangoYamlParsed {
     yamlVersion: 'v1' | 'v2';
     integrations: NangoYamlParsedIntegration[];
@@ -68,7 +73,11 @@ export interface NangoYamlParsedIntegration {
     providerConfigKey: string;
     syncs: ParsedNangoSync[];
     actions: ParsedNangoAction[];
-    postConnectionScripts: string[];
+    onEventScripts: Record<OnEventType, string[]>;
+    /**
+     * @deprecated
+     */
+    postConnectionScripts?: string[];
 }
 export interface ParsedNangoSync {
     name: string;
@@ -121,3 +130,8 @@ export interface NangoSyncEndpointV2 {
     path: string;
     group?: string | undefined;
 }
+export interface FlowsYaml {
+    integrations: Record<string, NangoYamlV2Integration & {
+        models: NangoYamlModel;
+    }>;
+}

package/dist/onboarding/api.d.ts

@@ -1,18 +1,13 @@
-import type { ApiError, Endpoint } from '../api';
-import type { NangoRecord } from '../record/api';
-export type GetOnboardingStatus = Endpoint<{
-    Method: 'GET';
+import type { Endpoint } from '../api';
+export type PatchOnboarding = Endpoint<{
+    Method: 'PATCH';
     Path: '/api/v1/onboarding';
     Querystring: {
         env: string;
     };
-    Error: ApiError<'onboarding_dev_only'> | ApiError<'no_onboarding'> | ApiError<'failed_to_get_records'> | ApiError<'invalid_query_params'>;
     Success: {
-        id: number;
-        progress: number;
-        records: NangoRecord[] | null;
-        provider: boolean;
-        connection: boolean;
-        sync: boolean;
+        data: {
+            success: boolean;
+        };
     };
 }>;

package/dist/providers/provider.d.ts

@@ -40,7 +40,7 @@ export interface BaseProvider {
     proxy?: {
         base_url: string;
         headers?: Record<string, string>;
-        connection_base_url?: string;
+        connection_config?: Record<string, string>;
         query?: {
             api_key: string;
         };
@@ -112,7 +112,7 @@ export interface ProviderJwt extends BaseProvider {
         };
     };
 }
-export interface ProviderTwoStep extends BaseProvider {
+export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
     token_headers?: Record<string, string>;
     token_response: {
         token: string;
@@ -121,6 +121,7 @@ export interface ProviderTwoStep extends BaseProvider {
     };
     token_expires_in_ms?: number;
     proxy_header_authorization?: string;
+    body_format?: 'xml' | 'json';
 }
 export interface ProviderSignature extends BaseProvider {
     signature: {

package/dist/runner/index.d.ts

@@ -0,0 +1,10 @@
+export interface RunnerOutputError {
+    type: string;
+    payload: Record<string, unknown>;
+    status: number;
+}
+export interface RunnerOutput {
+    success: boolean;
+    error: RunnerOutputError | null;
+    response?: any;
+}

package/dist/scripts/post-connection/db.d.ts

@@ -1,9 +1,10 @@
 import type { Timestamps } from '../../db.js';
-export interface PostConnectionScript extends Timestamps {
+export interface OnEventScript extends Timestamps {
     id: number;
     config_id: number;
     name: string;
     file_location: string;
     version: string;
     active: boolean;
+    event: 'POST_CONNECTION_CREATION' | 'PRE_CONNECTION_DELETION';
 }

package/dist/user/db.d.ts

@@ -6,7 +6,7 @@ export interface DBUser extends Timestamps {
     hashed_password: string;
     salt: string;
     account_id: number;
-    reset_password_token: string | undefined;
+    reset_password_token: string | null;
     suspended: boolean;
     suspended_at: Date;
     email_verified: boolean;

package/dist/web/env.d.ts

@@ -12,6 +12,6 @@ export interface WindowEnv {
         scripts: boolean;
         auth: boolean;
         managedAuth: boolean;
-        interactiveDemo: boolean;
+        gettingStarted: boolean;
     };
 }

package/package.json

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