@nangohq/types 0.42.20 → 0.42.22

package/dist/api.d.ts

@@ -1,9 +1,9 @@
-export interface ApiError<TCode extends string, TErrors = any, P = unknown> {
+export interface ApiError<TCode extends string, TErrors = any, TPayload = unknown> {
     error: {
         code: TCode;
         message?: string | undefined;
         errors?: TErrors;
-        payload?: P;
+        payload?: TPayload;
     };
 }
 export interface ValidationError {
@@ -11,7 +11,7 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'>;
+export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/auth/api.d.ts

@@ -12,6 +12,7 @@ export interface AuthModes {
     Tableau: 'TABLEAU';
     Jwt: 'JWT';
     Bill: 'BILL';
+    TwoStep: 'TWO_STEP';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
 export interface AuthOperation {
@@ -135,9 +136,15 @@ export interface JwtCredentials {
     token?: string;
     expires_at?: Date | undefined;
 }
+export interface TwoStepCredentials extends CredentialsCommon {
+    type: AuthModes['TwoStep'];
+    [key: string]: any;
+    token?: string;
+    expires_at?: Date | undefined;
+}
 export type UnauthCredentials = Record<string, never>;
 export type RefreshTokenResponse = AuthorizationTokenResponse;
 export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'type' | 'raw'> {
     expires_in?: number;
 }
-export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials | JwtCredentials | BillCredentials;
+export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials | JwtCredentials | BillCredentials | TwoStepCredentials;

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

@@ -108,3 +108,21 @@ export type PostPublicBillAuthorization = Endpoint<{
         connectionId: string;
     };
 }>;
+export type PostPublicTwoStepAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: Record<string, any>;
+    Querystring: {
+        connection_id?: string | undefined;
+        params?: Record<string, any> | undefined;
+        hmac?: string | undefined;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/auth/two-step';
+    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;
+        connectionId: string;
+    };
+}>;

package/dist/connect/api.d.ts

@@ -41,4 +41,5 @@ export type PostInternalConnectSessions = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/connect/sessions';
     Success: PostConnectSessions['Success'];
+    Body: Pick<ConnectSessionPayload, 'allowed_integrations'>;
 }>;

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

@@ -1,6 +1,64 @@
-import type { ApiError, Endpoint } from '../../api.js';
-import type { Connection } from '../db.js';
+import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
+import type { DBConnection } from '../db.js';
 import type { ActiveLog } from '../../notification/active-logs/db.js';
+import type { Merge } from 'type-fest';
+import type { ApiEndUser } from '../../endUser/index.js';
+export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id' | 'connection_id' | 'provider_config_key' | 'created_at' | 'updated_at'> & {
+    provider: string;
+    errors: [{
+        type: string;
+        log_id: string;
+    }];
+    endUser: ApiEndUser | null;
+};
+export type GetConnections = Endpoint<{
+    Method: 'GET';
+    Querystring: {
+        env: string;
+        integrationIds?: string[] | undefined;
+        search?: string | undefined;
+        withError?: boolean | undefined;
+        page?: number | undefined;
+    };
+    Path: '/api/v1/connections';
+    Success: {
+        data: ApiConnectionSimple[];
+    };
+}>;
+export type GetConnectionsCount = Endpoint<{
+    Method: 'GET';
+    Querystring: {
+        env: string;
+    };
+    Path: '/api/v1/connections/count';
+    Success: {
+        data: {
+            total: number;
+            withAuthError: number;
+        };
+    };
+}>;
+export type ApiPublicConnection = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key'> & {
+    created: string;
+    metadata: Record<string, unknown> | null;
+    provider: string;
+    errors: [{
+        type: string;
+        log_id: string;
+    }];
+};
+export type GetPublicConnections = Endpoint<{
+    Method: 'GET';
+    Querystring: {
+        connectionId?: string | undefined;
+        search?: string | undefined;
+    };
+    Path: '/connection';
+    Success: {
+        connections: ApiPublicConnection[];
+    };
+}>;
+export type ApiConnectionFull = Merge<DBConnection, ApiTimestamps>;
 export type GetConnection = Endpoint<{
     Method: 'GET';
     Params: {
@@ -9,14 +67,33 @@ export type GetConnection = Endpoint<{
     Querystring: {
         env: string;
         provider_config_key: string;
-        force_refresh?: 'true' | 'false';
     };
     Path: '/api/v1/connections/:connectionId';
-    Error: ApiError<'unknown_connection'> | ApiError<'missing_provider_config'> | ApiError<'unknown_provider'> | ApiError<'missing_connection'> | ApiError<'unknown_provider_config'>;
+    Error: ApiError<'unknown_provider_config'>;
+    Success: {
+        data: {
+            provider: string | null;
+            connection: ApiConnectionFull;
+            endUser: ApiEndUser | null;
+            errorLog: ActiveLog | null;
+        };
+    };
+}>;
+export type PostConnectionRefresh = Endpoint<{
+    Method: 'POST';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        env: string;
+        provider_config_key: string;
+    };
+    Path: '/api/v1/connections/:connectionId/refresh';
+    Error: ApiError<'unknown_provider_config'> | ApiError<'failed_to_refresh', any, ActiveLog | null>;
     Success: {
-        provider: string | null;
-        connection: Connection;
-        errorLog: ActiveLog | null;
+        data: {
+            success: boolean;
+        };
     };
 }>;
 export type DeletePublicConnection = Endpoint<{

package/dist/connection/db.d.ts

@@ -1,7 +1,8 @@
 import type { TimestampsAndDeleted } from '../db.js';
-import type { ApiKeyCredentials, BasicApiCredentials, AuthModeType, AuthOperationType, AllAuthCredentials } from '../auth/api.js';
+import type { AuthModeType, AuthOperationType, AllAuthCredentials } from '../auth/api.js';
 import type { DBEnvironment } from '../environment/db.js';
 import type { DBTeam } from '../team/db.js';
+import type { Merge } from 'type-fest';
 export type Metadata = Record<string, unknown>;
 export type ConnectionConfig = Record<string, any>;
 export interface BaseConnection extends TimestampsAndDeleted {
@@ -20,6 +21,11 @@ export interface BaseConnection extends TimestampsAndDeleted {
 export interface StoredConnection extends BaseConnection {
     credentials: Record<string, any>;
 }
+export type DBConnection = Merge<BaseConnection, {
+    id: number;
+    config_id: number;
+    credentials: Record<string, any>;
+}>;
 export interface Connection extends BaseConnection {
     credentials: AllAuthCredentials;
 }
@@ -30,17 +36,6 @@ export type RecentlyCreatedConnection = Pick<StoredConnection, 'id' | 'connectio
     environment: DBEnvironment;
     account: DBTeam;
 };
-export interface ApiConnection {
-    id?: number;
-    connection_id: string;
-    provider_config_key: string;
-    config_id?: number;
-    environment_id: number;
-    connection_config: ConnectionConfig;
-    credentials_iv?: string | null;
-    credentials_tag?: string | null;
-    credentials: BasicApiCredentials | ApiKeyCredentials;
-}
 export interface NangoConnection {
     id?: number;
     connection_id: string;

package/dist/deploy/incomingFlow.d.ts

@@ -1,4 +1,5 @@
-import type { NangoModel, NangoSyncEndpoint, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+import type { Merge } from 'type-fest';
+import type { NangoModel, NangoSyncEndpointOld, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
 export interface IncomingScriptFiles {
     js: string;
     ts: string;
@@ -31,7 +32,7 @@ interface InternalIncomingPreBuiltFlowConfig {
     metadata?: NangoConfigMetadata | undefined;
     model_schema: string | NangoModel[];
     input?: string | LegacySyncModelSchema | undefined;
-    endpoints?: NangoSyncEndpoint[] | undefined;
+    endpoints?: (NangoSyncEndpointV2 | NangoSyncEndpointOld)[] | undefined;
     track_deletes: boolean;
     providerConfigKey: string;
 }
@@ -43,6 +44,7 @@ export interface IncomingPreBuiltFlowConfig extends InternalIncomingPreBuiltFlow
     syncName?: string;
     nango_config_id?: number;
     fileBody?: IncomingScriptFiles;
+    endpoints: NangoSyncEndpointV2[];
 }
 export interface IncomingFlowConfig extends InternalIncomingPreBuiltFlowConfig {
     syncName: string;
@@ -51,4 +53,7 @@ export interface IncomingFlowConfig extends InternalIncomingPreBuiltFlowConfig {
     sync_type?: SyncTypeLiteral | undefined;
     webhookSubscriptions?: string[] | undefined;
 }
+export type CleanedIncomingFlowConfig = Merge<IncomingFlowConfig, {
+    endpoints: NangoSyncEndpointV2[];
+}>;
 export {};

package/dist/endUser/index.d.ts

@@ -12,3 +12,25 @@ export interface EndUser {
     readonly createdAt: Date;
     readonly updatedAt: Date | null;
 }
+export interface DBEndUser {
+    readonly id: number;
+    readonly end_user_id: string;
+    readonly account_id: number;
+    readonly environment_id: number;
+    readonly email: string;
+    readonly display_name: string | null;
+    readonly organization_id: string | null;
+    readonly organization_display_name: string | null;
+    readonly created_at: Date;
+    readonly updated_at: Date | null;
+}
+export type DBInsertEndUser = Omit<DBEndUser, 'id' | 'created_at' | 'updated_at'>;
+export interface ApiEndUser {
+    id: string;
+    displayName: string | null;
+    email: string;
+    organization: {
+        id: string;
+        displayName: string | null;
+    } | null;
+}

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

@@ -0,0 +1,15 @@
+import type { ApiError, Endpoint } from '../../api.js';
+export interface OtlpSettings {
+    endpoint: string;
+    headers: Record<string, string>;
+}
+export type UpdateOtlpSettings = Endpoint<{
+    Method: 'POST';
+    Querystring: {
+        env: string;
+    };
+    Path: '/api/v1/environment/otlp/settings';
+    Body: OtlpSettings;
+    Success: OtlpSettings;
+    Error: ApiError<'forbidden'>;
+}>;

package/dist/environment/db.d.ts

@@ -34,6 +34,10 @@ export interface DBEnvironment extends Timestamps {
     pending_public_key?: string | null;
     slack_notifications: boolean;
     webhook_receive_url?: string;
+    otlp_settings: {
+        endpoint: string;
+        headers: Record<string, string>;
+    } | null;
 }
 export interface ExternalWebhook extends Timestamps {
     id: number;

package/dist/index.d.ts

@@ -41,6 +41,7 @@ export type * from './endUser/index.js';
 export type * from './nangoYaml/index.js';
 export type * from './environment/db.js';
 export type * from './environment/api/webhook.js';
+export type * from './environment/api/otlp.js';
 export type * from './webhooks/api.js';
 export type * from './flow/http.api.js';
 export type * from './utils.js';

package/dist/integration/api.d.ts

@@ -3,7 +3,7 @@ import type { ApiTimestamps, Endpoint } from '../api';
 import type { IntegrationConfig } from './db';
 import type { Provider } from '../providers/provider';
 import type { AuthModeType } from '../auth/api';
-import type { NangoModel, NangoSyncEndpoint, ScriptTypeLiteral } from '../nangoYaml';
+import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral } from '../nangoYaml';
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
 import type { JSONSchema7 } from 'json-schema';
 import type { SyncType } from '../scripts/syncs/api';
@@ -137,7 +137,7 @@ export interface NangoSyncConfig {
     track_deletes?: boolean;
     returns: string[] | string;
     models: any[];
-    endpoints: NangoSyncEndpoint[];
+    endpoints: NangoSyncEndpointV2[];
     is_public?: boolean | null;
     pre_built?: boolean | null;
     version?: string | null;

package/dist/nangoYaml/index.d.ts

@@ -1,4 +1,4 @@
-export type HTTP_VERB = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export type SyncTypeLiteral = 'incremental' | 'full';
 export type ScriptFileType = 'actions' | 'syncs' | 'post-connection-scripts';
 export type ScriptTypeLiteral = 'action' | 'sync';
@@ -26,7 +26,7 @@ export interface NangoYamlV2Integration {
     'post-connection-scripts'?: string[];
 }
 export interface NangoYamlV2IntegrationSync {
-    endpoint: string | string[];
+    endpoint: string | string[] | NangoSyncEndpointV2 | NangoSyncEndpointV2[];
     output: string | string[];
     description?: string;
     sync_type?: SyncTypeLiteral;
@@ -68,7 +68,7 @@ export interface NangoYamlParsedIntegration {
 export interface ParsedNangoSync {
     name: string;
     type: 'sync';
-    endpoints: NangoSyncEndpoint[];
+    endpoints: NangoSyncEndpointV2[];
     description: string;
     sync_type: SyncTypeLiteral;
     track_deletes: boolean;
@@ -87,7 +87,7 @@ export interface ParsedNangoAction {
     description: string;
     input: string | null;
     output: string[] | null;
-    endpoint: NangoSyncEndpoint | null;
+    endpoint: NangoSyncEndpointV2 | null;
     scopes: string[];
     usedModels: string[];
     version: string;
@@ -108,6 +108,10 @@ export interface NangoModelField {
     union?: boolean | undefined;
     optional?: boolean | undefined;
 }
-export type NangoSyncEndpoint = {
-    [key in HTTP_VERB]?: string | undefined;
+export type NangoSyncEndpointOld = {
+    [key in HTTP_METHOD]?: string | undefined;
 };
+export interface NangoSyncEndpointV2 {
+    method: HTTP_METHOD;
+    path: string;
+}

package/dist/providers/provider.d.ts

@@ -24,6 +24,7 @@ export interface SimplifiedJSONSchema {
     description: string;
     example?: string;
     pattern?: string;
+    optional?: boolean;
     format?: string;
     order: number;
     default_value?: string;
@@ -37,6 +38,7 @@ export interface BaseProvider {
     proxy?: {
         base_url: string;
         headers?: Record<string, string>;
+        connection_base_url?: string;
         query?: {
             api_key: string;
         };
@@ -73,6 +75,7 @@ export interface BaseProvider {
     connection_config?: Record<string, SimplifiedJSONSchema>;
     credentials?: Record<string, SimplifiedJSONSchema>;
     authorization_url_fragment?: string;
+    body_format?: OAuthBodyFormatType;
 }
 export interface ProviderOAuth2 extends BaseProvider {
     auth_mode: 'OAUTH2' | 'CUSTOM';
@@ -84,7 +87,6 @@ export interface ProviderOAuth2 extends BaseProvider {
         grant_type: 'refresh_token';
     };
     authorization_method?: OAuthAuthorizationMethodType;
-    body_format?: OAuthBodyFormatType;
     refresh_url?: string;
     expires_in_unit?: 'milliseconds';
     token_request_auth_method?: 'basic' | 'custom';
@@ -108,4 +110,14 @@ export interface ProviderJwt extends BaseProvider {
         };
     };
 }
-export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt;
+export interface ProviderTwoStep extends BaseProvider {
+    token_headers?: Record<string, string>;
+    token_response: {
+        token: string;
+        token_expiration: string;
+        token_expiration_strategy: 'expireAt' | 'expireIn';
+    };
+    token_expires_in_ms?: number;
+    proxy_header_authorization?: string;
+}
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep;

package/dist/scripts/syncs/api.d.ts

@@ -3,4 +3,4 @@ export interface SyncResult {
     updated: number;
     deleted: number;
 }
-export type SyncType = 'INCREMENTAL' | 'FULL';
+export type SyncType = 'INCREMENTAL' | 'FULL' | 'WEBHOOK';

package/dist/web/env.d.ts

@@ -5,6 +5,7 @@ export interface WindowEnv {
     publicSentryKey: string;
     publicPosthogKey: string;
     publicPosthogPost: string;
+    publicLogoDevKey: string;
     isCloud: boolean;
     features: {
         logs: boolean;
@@ -12,6 +13,5 @@ export interface WindowEnv {
         auth: boolean;
         managedAuth: boolean;
         interactiveDemo: boolean;
-        connectUI: boolean;
     };
 }

package/dist/webhooks/api.d.ts

@@ -13,7 +13,7 @@ export interface NangoSyncWebhookBodyBase extends NangoWebhookBase {
     providerConfigKey: string;
     syncName: string;
     model: string;
-    syncType: 'INCREMENTAL' | 'INITIAL';
+    syncType: 'INCREMENTAL' | 'INITIAL' | 'WEBHOOK';
 }
 export interface NangoSyncWebhookBodySuccess extends NangoSyncWebhookBodyBase {
     success: true;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.42.20",
+    "version": "0.42.22",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -15,7 +15,7 @@
         "@types/json-schema": "7.0.15",
         "axios": "^1.7.4",
         "json-schema": "0.4.0",
-        "type-fest": "4.25.0"
+        "type-fest": "4.26.1"
     },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "files": [