@nangohq/types 0.52.5 → 0.53.1

package/dist/api.d.ts

@@ -11,7 +11,7 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | 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'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'>;
+export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_headers', 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'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type
@@ -21,6 +21,7 @@ export interface EndpointDefinition {
     Path: string;
     Params?: Record<string, any>;
     Body?: Record<string, any>;
+    Headers?: Record<string, any>;
     Querystring?: Record<string, any>;
     Error?: ApiError<any> | never;
     Success: Record<string, any> | never;
@@ -44,6 +45,10 @@ export interface Endpoint<T extends EndpointDefinition> {
      * Received body
      */
     Body: T['Body'] extends Record<string, any> ? T['Body'] : never;
+    /**
+     * Received headers
+     */
+    Headers: T['Headers'] extends Record<string, any> ? T['Headers'] : never;
     /**
      * Response body for success
      */

package/dist/api.endpoints.d.ts

@@ -18,7 +18,8 @@ import type { PostPublicWebhook } from './webhooks/http.api';
 import type { PatchEnvironment, PostEnvironment } from './environment/api';
 import type { PatchWebhook } from './environment/api/webhook';
 import type { PostEnvironmentVariables } from './environment/variable/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;
+import type { GetPublicRecords } from './record/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;
 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/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/deploy/incomingFlow.d.ts

@@ -28,7 +28,7 @@ export interface LegacySyncModelSchema {
 interface InternalIncomingPreBuiltFlowConfig {
     type: ScriptTypeLiteral;
     models: string[];
-    runs: string;
+    runs: string | null;
     auto_start?: boolean;
     attributes?: object | undefined;
     metadata?: NangoConfigMetadata | undefined;

package/dist/deploy/index.d.ts

@@ -6,7 +6,7 @@ export interface SyncDeploymentResult {
     providerConfigKey: string;
     type: ScriptTypeLiteral;
     last_deployed?: Date;
-    input?: string | LegacySyncModelSchema | undefined;
+    input?: string | LegacySyncModelSchema | undefined | null;
     models: string | string[];
     id?: number | undefined;
     /** @deprecated legacy **/

package/dist/fleet/index.d.ts

@@ -1,9 +1,5 @@
-export type CommitHash = string & {
-    readonly length: 40;
-};
 export interface Deployment {
     readonly id: number;
-    readonly commitId: CommitHash;
     readonly image: string;
     readonly createdAt: Date;
     readonly supersededAt: Date | null;

package/dist/integration/api.d.ts

@@ -3,10 +3,9 @@ import type { ApiTimestamps, Endpoint } from '../api';
 import type { IntegrationConfig } from './db';
 import type { Provider } from '../providers/provider';
 import type { AuthModeType, AuthModes } from '../auth/api';
-import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral } from '../nangoYaml';
+import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
 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;
@@ -177,7 +176,7 @@ export interface NangoSyncConfig {
     last_deployed?: string | null;
     id?: number;
     input?: NangoModel | LegacySyncModelSchema;
-    sync_type?: SyncType;
+    sync_type?: SyncTypeLiteral;
     webhookSubscriptions?: string[];
     enabled?: boolean;
     json_schema: JSONSchema7 | null;

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';
@@ -109,7 +109,6 @@ export interface MessageRow {
     response: {
         code: number;
         headers: Record<string, string>;
-        body?: unknown;
     } | null;
     meta: MessageMeta | null;
     createdAt: string;

package/dist/nangoYaml/index.d.ts

@@ -1,6 +1,6 @@
 import type { OnEventType } from '../scripts/on-events/api';
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
-export type SyncTypeLiteral = 'incremental' | 'full' | 'FULL' | 'INCREMENTAL';
+export type SyncTypeLiteral = 'incremental' | 'full';
 export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'post-connection-scripts';
 export type ScriptTypeLiteral = 'action' | 'sync' | 'on-event';
 export interface NangoYamlV1 {

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

@@ -1,4 +1,6 @@
+import type { ApiError, Endpoint } from '../api';
 export type RecordLastAction = 'ADDED' | 'UPDATED' | 'DELETED' | 'added' | 'updated' | 'deleted';
+export type CombinedFilterAction = `${RecordLastAction},${RecordLastAction}`;
 export interface RecordMetadata {
     first_seen_at: string;
     last_modified_at: string;
@@ -6,15 +8,37 @@ export interface RecordMetadata {
     deleted_at: string | null;
     cursor: string;
 }
-export interface NangoRecord {
+export type NangoRecord<T extends Record<string, any> = Record<string, any>> = {
     [key: string]: any;
     id: string | number;
     _nango_metadata: RecordMetadata;
-}
+} & T;
 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<{
+    Method: 'GET';
+    Path: `/records`;
+    Headers: {
+        'connection-id': string;
+        'provider-config-key': string;
+    };
+    Error: ApiError<'unknown_connection'>;
+    Querystring: {
+        model: string;
+        delta?: string | undefined;
+        modified_after?: string | undefined;
+        limit?: number | undefined;
+        filter?: RecordLastAction | CombinedFilterAction | undefined;
+        cursor?: string | undefined;
+        ids?: string[] | undefined;
+    };
+    Success: {
+        next_cursor: string | null;
+        records: NangoRecord[];
+    };
+}>;

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

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

package/dist/syncConfigs/db.d.ts

@@ -8,7 +8,7 @@ export interface DBSyncConfig extends TimestampsAndDeleted {
     nango_config_id: number;
     file_location: string;
     version: string;
-    models: string[] | null;
+    models: string[];
     active: boolean;
     runs: string | null;
     model_schema: LegacySyncModelSchema[] | NangoModel[] | null;
@@ -26,3 +26,4 @@ export interface DBSyncConfig extends TimestampsAndDeleted {
     enabled: boolean;
     models_json_schema: JSONSchema7 | null;
 }
+export type DBSyncConfigInsert = Omit<DBSyncConfig, 'id'>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.52.5",
+    "version": "0.53.1",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -11,12 +11,14 @@
         "url": "git+https://github.com/NangoHQ/nango.git",
         "directory": "packages/utils"
     },
-    "devDependencies": {
-        "@types/json-schema": "7.0.15",
+    "dependencies": {
         "axios": "^1.7.9",
         "json-schema": "0.4.0",
         "type-fest": "4.32.0"
     },
+    "devDependencies": {
+        "@types/json-schema": "7.0.15"
+    },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "files": [
         "dist/**/*"