@nangohq/types 0.53.0 → 0.53.2

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

@@ -1,5 +1,5 @@
 import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
-import type { DBConnection } from '../db.js';
+import type { DBConnection, DBConnectionDecrypted } 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';
@@ -64,7 +64,7 @@ export type GetPublicConnections = Endpoint<{
         connections: ApiPublicConnection[];
     };
 }>;
-export type ApiConnectionFull = Merge<DBConnection, ApiTimestamps>;
+export type ApiConnectionFull = Merge<DBConnectionDecrypted, ApiTimestamps>;
 export type GetConnection = Endpoint<{
     Method: 'GET';
     Params: {
@@ -88,7 +88,7 @@ export type GetConnection = Endpoint<{
 export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key' | 'connection_config'> & {
     created_at: string;
     updated_at: string;
-    last_fetched_at: string;
+    last_fetched_at: string | null;
     metadata: Record<string, unknown> | null;
     provider: string;
     errors: {

package/dist/connection/db.d.ts

@@ -1,58 +1,53 @@
-import type { TimestampsAndDeleted } from '../db.js';
+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 { EndUser } from '../endUser/index.js';
 export type Metadata = Record<string, unknown>;
 export type ConnectionConfig = Record<string, any>;
-export interface BaseConnection extends TimestampsAndDeleted {
-    id?: number;
-    config_id?: number;
+export interface DBConnection extends TimestampsAndDeletedCorrect {
+    id: number;
+    config_id: number;
     end_user_id: number | null;
+    /**
+     * @deprecated
+     */
     provider_config_key: string;
     connection_id: string;
     connection_config: ConnectionConfig;
     environment_id: number;
-    metadata?: Metadata | null;
-    credentials_iv?: string | null;
-    credentials_tag?: string | null;
-    last_fetched_at?: Date | null;
-}
-export interface StoredConnection extends BaseConnection {
-    credentials: Record<string, any>;
+    metadata: Metadata | null;
+    credentials: {
+        encrypted_credentials?: string;
+    };
+    credentials_iv: string | null;
+    credentials_tag: string | null;
+    last_fetched_at: Date | null;
 }
-export type DBConnection = Merge<BaseConnection, {
-    id: number;
-    config_id: number;
-    credentials: Record<string, any>;
-}>;
-export interface Connection extends BaseConnection {
+export type DBConnectionDecrypted = Merge<DBConnection, {
     credentials: AllAuthCredentials;
-}
-export type RecentlyCreatedConnection = Pick<StoredConnection, 'id' | 'connection_id' | 'provider_config_key'> & {
+}>;
+export interface RecentlyCreatedConnection {
+    connection: DBConnection;
     auth_mode: AuthModeType;
     error?: string;
     operation: AuthOperationType;
     environment: DBEnvironment;
     account: DBTeam;
-};
-export interface NangoConnection {
-    id?: number;
-    connection_id: string;
-    provider_config_key: string;
-    environment_id: number;
-    connection_config?: ConnectionConfig;
-    /**
-     * @deprecated
-     */
-    account_id?: number;
+    endUser: EndUser | undefined;
 }
-export interface ConnectionList {
-    id: number;
-    connection_id: string;
-    provider_config_key: string;
-    provider: string;
-    created: string;
-    metadata?: Metadata | null;
-    error_log_id?: number | string | null;
+export interface FailedConnectionError {
+    type: string;
+    description: string;
+}
+export interface RecentlyFailedConnection {
+    connection: DBConnection | Pick<DBConnection, 'connection_id' | 'provider_config_key'>;
+    auth_mode: AuthModeType;
+    error?: FailedConnectionError;
+    operation: AuthOperationType;
+    environment: DBEnvironment;
+    account: DBTeam;
 }
+export type ConnectionInternal = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key' | 'environment_id' | 'connection_config'>;
+export type ConnectionJobs = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key' | 'environment_id'>;

package/dist/db.d.ts

@@ -6,5 +6,11 @@ export interface Deleted {
     deleted_at?: Date | null;
     deleted?: boolean;
 }
+export interface DeletedCorrect {
+    deleted_at: Date | null;
+    deleted: boolean;
+}
 export interface TimestampsAndDeleted extends Timestamps, Deleted {
 }
+export interface TimestampsAndDeletedCorrect extends Timestamps, DeletedCorrect {
+}

package/dist/logs/messages.d.ts

@@ -51,7 +51,7 @@ export interface OperationAdmin {
 }
 export interface OperationWebhook {
     type: 'webhook';
-    action: 'incoming' | 'forward' | 'sync';
+    action: 'incoming' | 'forward' | 'sync' | 'connection_create' | 'connection_refresh';
 }
 export interface OperationDeploy {
     type: 'deploy';
@@ -131,7 +131,7 @@ export type OperationRow = Merge<Required<OperationRowInsert>, {
 /**
  * What is required to insert a Message
  */
-export type MessageRowInsert = Pick<MessageRow, 'type' | 'message'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
+export type MessageRowInsert = Pick<MessageRow, 'type' | 'message' | 'createdAt'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
     id?: never;
 };
 export type MessageOrOperationRow = MessageRow | OperationRow;

package/dist/persist/api.d.ts

@@ -1,4 +1,4 @@
-import type { MergingStrategy } from '../record/api.js';
+import type { MergingStrategy, NangoRecord } from '../record/api.js';
 export interface PostRecordsSuccess {
     nextMerging: MergingStrategy;
 }
@@ -11,3 +11,7 @@ export interface DeleteRecordsSuccess {
 export interface GetCursorSuccess {
     cursor?: string;
 }
+export interface GetRecordsSuccess {
+    records: NangoRecord[];
+    nextCursor?: string;
+}

package/dist/providers/provider.d.ts

@@ -120,6 +120,12 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
         token_expiration: string;
         token_expiration_strategy: 'expireAt' | 'expireIn';
     };
+    additional_steps?: {
+        body_format?: 'json' | 'form';
+        token_params?: Record<string, string>;
+        token_headers?: Record<string, string>;
+        token_url: string;
+    }[];
     token_expires_in_ms?: number;
     proxy_header_authorization?: string;
     body_format?: 'xml' | 'json' | 'form';

package/dist/proxy/api.d.ts

@@ -1,6 +1,6 @@
 import type { EndpointMethod } from '../api.js';
 import type { BasicApiCredentials, ApiKeyCredentials, AppCredentials } from '../auth/api.js';
-import type { Connection } from '../connection/db.js';
+import type { DBConnectionDecrypted } from '../connection/db.js';
 import type { Provider } from '../providers/provider.js';
 export interface BaseProxyConfiguration {
     providerConfigKey: string;
@@ -26,12 +26,12 @@ export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfi
     providerName: string;
     token: string | BasicApiCredentials | ApiKeyCredentials | AppCredentials;
     provider: Provider;
-    connection: Connection;
+    connection: DBConnectionDecrypted;
 }
 export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 export interface InternalProxyConfiguration {
     providerName: string;
-    connection: Connection;
+    connection: DBConnectionDecrypted;
     existingActivityLogId?: string | null | undefined;
 }
 export interface RetryHeaderConfig {

package/dist/record/api.d.ts

@@ -17,7 +17,7 @@ export type MergingStrategy = {
     strategy: 'override';
 } | {
     strategy: 'ignore_if_modified_after_cursor';
-    cursor?: string;
+    cursor?: string | undefined;
 };
 export type CursorOffset = 'first' | 'last';
 export type GetPublicRecords = Endpoint<{

package/dist/runner/sdk.d.ts

@@ -28,6 +28,7 @@ export interface NangoProps {
     provider: string;
     lastSyncDate?: Date;
     syncId?: string | undefined;
+    syncVariant?: string | undefined;
     nangoConnectionId?: number;
     syncJobId?: number | undefined;
     track_deletes?: boolean;

package/package.json

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