@nangohq/types 0.42.13 → 0.42.14

package/dist/api.d.ts

@@ -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<'missing_auth_header'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'>;
+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 EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/api.endpoints.d.ts

@@ -10,8 +10,9 @@ import type { GetUser, PatchUser } from './user/api';
 import type { DeletePublicIntegration, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy } from './integration/api';
 import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api';
 import type { GetPublicProvider, GetPublicProviders } from './providers/api';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration;
-export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus;
+import type { PostConnectSessions, PostInternalConnectSessions } from './connect/api';
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | 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;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/connect/api.d.ts

@@ -0,0 +1,57 @@
+import type { Endpoint } from '../api.js';
+export type PostConnectSessions = Endpoint<{
+    Method: 'POST';
+    Path: '/connect/sessions';
+    Body: {
+        end_user: {
+            id: string;
+            email: string;
+            display_name?: string | undefined;
+        };
+        organization?: {
+            id: string;
+            display_name?: string | undefined;
+        } | undefined;
+        allowed_integrations?: string[] | undefined;
+        integrations_config_defaults?: Record<string, {
+            connection_config: Record<string, unknown>;
+        }> | undefined;
+    };
+    Success: {
+        data: {
+            token: string;
+            expires_at: Date;
+        };
+    };
+}>;
+export type GetConnectSession = Endpoint<{
+    Method: 'GET';
+    Path: '/connect/session';
+    Success: {
+        data: {
+            allowed_integrations?: string[] | undefined;
+            integrations_config_defaults?: Record<string, {
+                connection_config: Record<string, unknown>;
+            }> | undefined;
+            end_user: {
+                id: string;
+                email: string;
+                display_name?: string | undefined;
+            };
+            organization?: {
+                id: string;
+                display_name?: string | undefined;
+            } | undefined;
+        };
+    };
+}>;
+export type DeleteConnectSession = Endpoint<{
+    Method: 'DELETE';
+    Path: '/connect/session';
+    Success: never;
+}>;
+export type PostInternalConnectSessions = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/connect/sessions';
+    Success: PostConnectSessions['Success'];
+}>;

package/dist/connect/session.d.ts

@@ -0,0 +1,12 @@
+export interface ConnectSession {
+    readonly id: number;
+    readonly endUserId: number;
+    readonly accountId: number;
+    readonly environmentId: number;
+    readonly allowedIntegrations?: string[] | null;
+    readonly integrationsConfigDefaults?: Record<string, {
+        connectionConfig: Record<string, unknown>;
+    }> | null;
+    readonly createdAt: Date;
+    readonly updatedAt: Date | null;
+}

package/dist/endUser/index.d.ts

@@ -0,0 +1,14 @@
+export interface EndUser {
+    readonly id: number;
+    readonly endUserId: string;
+    readonly accountId: number;
+    readonly environmentId: number;
+    readonly email: string;
+    readonly displayName?: string | null;
+    readonly organization?: {
+        readonly organizationId: string;
+        readonly displayName?: string | null;
+    } | null;
+    readonly createdAt: Date;
+    readonly updatedAt: Date | null;
+}

package/dist/index.d.ts

@@ -35,6 +35,9 @@ export type * from './auth/db.js';
 export type * from './auth/http.api.js';
 export type * from './deploy/api.js';
 export type * from './deploy/incomingFlow.js';
+export type * from './connect/api.js';
+export type * from './connect/session.js';
+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';

package/dist/integration/api.d.ts

@@ -9,6 +9,7 @@ import type { JSONSchema7 } from 'json-schema';
 import type { SyncType } from '../scripts/syncs/api';
 export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider'>, ApiTimestamps> & {
     logo: string;
+    display_name: string;
 } & ApiPublicIntegrationInclude;
 export interface ApiPublicIntegrationInclude {
     webhook_url?: string | null;

package/dist/keystore/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-export type EntityType = 'session' | 'connection' | 'environment';
+export type EntityType = 'connect_session' | 'connection' | 'environment';
 export interface PrivateKey {
     readonly id: number;
     readonly displayName: string;

package/dist/providers/provider.d.ts

@@ -18,6 +18,19 @@ export interface ProviderAlias {
         base_url?: string;
     };
 }
+export interface SimplifiedJSONSchema {
+    type: 'string';
+    title: string;
+    description: string;
+    example?: string;
+    pattern?: string;
+    format?: string;
+    order: number;
+    default_value?: string;
+    hidden?: string;
+    suffix?: string;
+    doc_section?: string;
+}
 export interface BaseProvider {
     display_name: string;
     auth_mode: AuthModeType;
@@ -49,12 +62,15 @@ export interface BaseProvider {
     redirect_uri_metadata?: string[];
     token_response_metadata?: string[];
     docs: string;
+    docs_connect?: string;
     token_expiration_buffer?: number;
     webhook_routing_script?: string;
     webhook_user_defined_secret?: boolean;
     post_connection_script?: string;
     categories?: string[];
     connection_configuration?: string[];
+    connection_config?: Record<string, SimplifiedJSONSchema>;
+    credentials?: Record<string, SimplifiedJSONSchema>;
 }
 export interface ProviderOAuth2 extends BaseProvider {
     auth_mode: 'OAUTH2' | 'CUSTOM';

package/package.json

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