@nangohq/types 0.57.0 → 0.57.2

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

@@ -3,10 +3,11 @@ export interface ConnectSessionInput {
     allowed_integrations?: string[] | undefined;
     integrations_config_defaults?: Record<string, {
         user_scopes?: string | undefined;
-        connection_config: {
+        authorization_params?: Record<string, string> | undefined;
+        connection_config?: {
             [key: string]: unknown;
             oauth_scopes_override?: string | undefined;
-        };
+        } | undefined;
     }> | undefined;
     end_user: {
         id: string;
@@ -65,5 +66,18 @@ export type PostInternalConnectSessions = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/connect/sessions';
     Success: PostConnectSessions['Success'];
-    Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization'>;
+    Body: Pick<ConnectSessionInput, 'allowed_integrations' | 'end_user' | 'organization' | 'integrations_config_defaults'>;
+}>;
+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

@@ -6,14 +6,16 @@ export interface ConnectSession {
     readonly connectionId: number | null;
     readonly operationId: string | null;
     readonly allowedIntegrations: string[] | null;
-    readonly integrationsConfigDefaults: Record<string, {
-        /** Only used by Slack */
-        user_scopes?: string | undefined;
-        connectionConfig: {
-            [key: string]: unknown;
-            oauth_scopes_override?: string | undefined;
-        };
-    }> | null;
+    readonly integrationsConfigDefaults: Record<string, ConnectSessionIntegrationConfigDefaults> | null;
     readonly createdAt: Date;
     readonly updatedAt: Date | null;
 }
+export interface ConnectSessionIntegrationConfigDefaults {
+    /** Only used by Slack */
+    user_scopes?: string | undefined;
+    authorization_params?: Record<string, string> | undefined;
+    connectionConfig?: {
+        [key: string]: unknown;
+        oauth_scopes_override?: string | undefined;
+    } | undefined;
+}

package/dist/connection/db.d.ts

@@ -2,8 +2,9 @@ import type { TimestampsAndDeletedCorrect } from '../db.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';
+import type { Merge, Simplify } from 'type-fest';
 import type { EndUser } from '../endUser/index.js';
+import type { ReplaceInObject } from '../utils.js';
 export type Metadata = Record<string, unknown>;
 export type ConnectionConfig = Record<string, any>;
 export interface DBConnection extends TimestampsAndDeletedCorrect {
@@ -24,7 +25,13 @@ export interface DBConnection extends TimestampsAndDeletedCorrect {
     credentials_iv: string | null;
     credentials_tag: string | null;
     last_fetched_at: Date | null;
+    credentials_expires_at: Date | null;
+    last_refresh_failure: Date | null;
+    last_refresh_success: Date | null;
+    refresh_attempts: number | null;
+    refresh_exhausted: boolean;
 }
+export type DBConnectionAsJSONRow = Simplify<ReplaceInObject<DBConnection, Date, string>>;
 export type DBConnectionDecrypted = Merge<DBConnection, {
     credentials: AllAuthCredentials;
 }>;

package/dist/logs/messages.d.ts

@@ -87,7 +87,7 @@ export interface MessageRow {
     level: LogLevel;
     type: MessageType;
     message: string;
-    context?: 'script' | 'proxy' | 'webhook';
+    context?: 'script' | 'proxy' | 'webhook' | undefined;
     parentId: string;
     error?: MessageError | undefined;
     request?: MessageHTTPRequest | undefined;
@@ -148,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>;
@@ -104,6 +105,7 @@ export interface ProviderOAuth1 extends BaseProvider {
     signature_method: 'HMAC-SHA1' | 'RSA-SHA1' | 'PLAINTEXT';
 }
 export interface ProviderJwt extends BaseProvider {
+    auth_mode: 'JWT';
     token: {
         expires_in_ms: number;
         headers: {
@@ -115,6 +117,7 @@ export interface ProviderJwt extends BaseProvider {
     };
 }
 export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
+    auth_mode: 'TWO_STEP';
     token_headers?: Record<string, string>;
     token_response: {
         token: string;
@@ -132,6 +135,7 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
     body_format?: 'xml' | 'json' | 'form';
 }
 export interface ProviderSignature extends BaseProvider {
+    auth_mode: 'SIGNATURE';
     signature: {
         protocol: 'WSSE';
     };
@@ -139,4 +143,9 @@ export interface ProviderSignature extends BaseProvider {
         expires_in_ms: number;
     };
 }
-export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature;
+export interface ProviderApiKey extends BaseProvider {
+    auth_mode: 'API_KEY';
+}
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature | ProviderApiKey;
+export type RefreshableProvider = ProviderTwoStep | ProviderJwt | ProviderSignature | ProviderOAuth2;
+export type TestableProvider = ProviderApiKey;

package/dist/utils.d.ts

@@ -18,4 +18,7 @@ export type Jsonable = string | number | boolean | null | undefined | readonly J
 } | {
     toJSON(): Jsonable;
 };
+export type ReplaceInObject<T, From, To> = {
+    [K in keyof T]: T[K] extends infer U ? (U extends From ? Exclude<U, From> | To : U) : never;
+};
 export {};

package/package.json

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