@nangohq/types 0.56.4 → 0.57.1

package/dist/api.endpoints.d.ts

@@ -10,7 +10,7 @@ import type { GetUser, PatchUser } from './user/api';
 import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy, PatchIntegration, PostIntegration } from './integration/api';
 import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization, PostPublicJwtAuthorization, PostPublicBillAuthorization, PostPublicSignatureAuthorization, PostPublicTwoStepAuthorization, PostPublicApiKeyAuthorization, PostPublicBasicAuthorization, PostPublicAppStoreAuthorization } from './auth/http.api';
 import type { GetPublicProvider, GetPublicProviders } from './providers/api';
-import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect } from './connect/api';
+import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect, PostPublicConnectTelemetry } from './connect/api';
 import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PostConnectionRefresh } from './connection/api/get';
 import type { GetMeta } from './meta/api';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
@@ -20,7 +20,7 @@ import type { PatchWebhook } from './environment/api/webhook';
 import type { PostEnvironmentVariables } from './environment/variable/api';
 import type { GetPublicRecords } from './record/api';
 import type { GetPublicScriptsConfig } from './scripts/http.api';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | GetPublicScriptsConfig;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry;
 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 | PostEnvironment | PatchEnvironment | PatchWebhook | PostEnvironmentVariables;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**

package/dist/auth/api.d.ts

@@ -158,4 +158,6 @@ export type RefreshTokenResponse = AuthorizationTokenResponse;
 export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'type' | 'raw'> {
     expires_in?: number;
 }
+export type TestableCredentials = ApiKeyCredentials | BasicApiCredentials | TbaCredentials | JwtCredentials | SignatureCredentials;
+export type RefreshableCredentials = OAuth2Credentials | AppCredentials | AppStoreCredentials | OAuth2ClientCredentials | TableauCredentials | JwtCredentials | TwoStepCredentials | BillCredentials | SignatureCredentials;
 export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials | JwtCredentials | BillCredentials | TwoStepCredentials | SignatureCredentials;

package/dist/connect/api.d.ts

@@ -67,3 +67,16 @@ export type PostInternalConnectSessions = Endpoint<{
     Success: PostConnectSessions['Success'];
     Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization'>;
 }>;
+export type PostPublicConnectTelemetry = Endpoint<{
+    Method: 'POST';
+    Path: '/connect/telemetry';
+    Body: {
+        token: string;
+        event: 'open' | 'view:list' | 'view:integration' | 'view:unknown_error' | 'view:credentials_error' | 'view:success' | 'click:integration' | 'click:doc' | 'click:doc_section' | 'click:connect' | 'click:close' | 'click:finish' | 'click:outside' | 'popup:blocked_by_browser' | 'popup:closed_early';
+        timestamp: Date;
+        dimensions?: {
+            integration?: string | undefined;
+        } | undefined;
+    };
+    Success: never;
+}>;

package/dist/connect/session.d.ts

@@ -4,6 +4,7 @@ export interface ConnectSession {
     readonly accountId: number;
     readonly environmentId: number;
     readonly connectionId: number | null;
+    readonly operationId: string | null;
     readonly allowedIntegrations: string[] | null;
     readonly integrationsConfigDefaults: Record<string, {
         /** Only used by Slack */

package/dist/logs/api.d.ts

@@ -102,7 +102,7 @@ export type PostInsights = Endpoint<{
         env: string;
     };
     Body: {
-        type: PickFromUnion<ConcatOperationListWithGroup, 'action' | 'sync:run' | 'proxy' | 'webhook:incoming'>;
+        type: PickFromUnion<ConcatOperationListWithGroup, 'action' | 'sync:run' | 'proxy' | 'webhook:incoming' | 'auth:create_connection'>;
     };
     Success: {
         data: {
@@ -115,5 +115,8 @@ export interface InsightsHistogramEntry {
     total: number;
     success: number;
     failure: number;
+    cancelled: number;
+    expired: number;
+    running: number;
 }
 export {};

package/dist/logs/messages.d.ts

@@ -87,6 +87,7 @@ export interface MessageRow {
     level: LogLevel;
     type: MessageType;
     message: string;
+    context?: 'script' | 'proxy' | 'webhook' | undefined;
     parentId: string;
     error?: MessageError | undefined;
     request?: MessageHTTPRequest | undefined;
@@ -95,6 +96,7 @@ export interface MessageRow {
     retry?: MessageHTTPRetry | undefined;
     createdAt: string;
     endedAt?: string | undefined;
+    durationMs?: number | undefined;
 }
 export interface OperationRow {
     id: string;
@@ -122,6 +124,8 @@ export interface OperationRow {
     integrationName?: string | undefined;
     connectionId?: number | undefined;
     connectionName?: string | undefined;
+    endUserId?: string | undefined;
+    endUserName?: string | undefined;
     syncConfigId?: number | undefined;
     syncConfigName?: string | undefined;
     jobId?: string | undefined;
@@ -135,6 +139,7 @@ export interface OperationRow {
     startedAt: string | null;
     endedAt: string | null;
     expiresAt: string | null;
+    durationMs?: number | undefined;
 }
 /**
  * What is required to insert an Operation
@@ -143,7 +148,7 @@ export type OperationRowInsert = Merge<Partial<OperationRow>, Pick<OperationRow,
 /**
  * What is required to insert a Message
  */
-export type MessageRowInsert = Pick<MessageRow, 'type' | 'message' | 'createdAt'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
+export type MessageRowInsert = Pick<MessageRow, 'type' | 'message' | 'createdAt' | 'level'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
     id?: never;
 };
 export type MessageOrOperationRow = MessageRow | OperationRow;

package/dist/providers/provider.d.ts

@@ -50,7 +50,7 @@ export interface BaseProvider {
         paginate?: LinkPagination | CursorPagination | OffsetPagination;
         verification?: {
             method: EndpointMethod;
-            endpoint: string;
+            endpoints: string[];
             base_url_override?: string;
             headers?: Record<string, string>;
         };
@@ -74,6 +74,7 @@ export interface BaseProvider {
     webhook_routing_script?: string;
     webhook_user_defined_secret?: boolean;
     post_connection_script?: string;
+    credentials_verification_script?: string;
     categories?: string[];
     connection_configuration?: string[];
     connection_config?: Record<string, SimplifiedJSONSchema>;
@@ -140,3 +141,5 @@ export interface ProviderSignature extends BaseProvider {
     };
 }
 export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature;
+export type RefreshableProvider = ProviderOAuth2;
+export type TestableProvider = ProviderJwt | ProviderSignature;

package/dist/runner/sdk.d.ts

@@ -6,23 +6,26 @@ export interface NangoProps {
     scriptType: 'sync' | 'action' | 'webhook' | 'on-event';
     host?: string;
     secretKey: string;
-    team?: Pick<DBTeam, 'id' | 'name'>;
+    team: Pick<DBTeam, 'id' | 'name'>;
     connectionId: string;
     environmentId: number;
-    environmentName?: string;
+    environmentName: string;
     activityLogId?: string | undefined;
     providerConfigKey: string;
     provider: string;
     lastSyncDate?: Date;
     syncId?: string | undefined;
     syncVariant?: string | undefined;
-    nangoConnectionId?: number;
+    nangoConnectionId: number;
     syncJobId?: number | undefined;
     track_deletes?: boolean;
     attributes?: object | undefined;
     abortSignal?: AbortSignal;
     syncConfig: DBSyncConfig;
     runnerFlags: RunnerFlags;
+    /**
+     * @deprecated not used
+     */
     debug: boolean;
     startedAt: Date;
     endUser: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.56.4",
+    "version": "0.57.1",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -12,7 +12,7 @@
         "directory": "packages/utils"
     },
     "dependencies": {
-        "axios": "^1.7.9",
+        "axios": "^1.8.2",
         "json-schema": "0.4.0",
         "type-fest": "4.32.0"
     },