@nangohq/types 0.39.32 → 0.40.0

package/dist/account/db.d.ts

@@ -0,0 +1,10 @@
+export interface Account {
+    id: number;
+    name: string;
+    secret_key: string;
+    host?: string | null;
+    websockets_path?: string;
+    uuid: string;
+    is_admin?: boolean;
+    is_capped?: boolean;
+}

package/dist/api.d.ts

@@ -1,8 +1,9 @@
-export interface ApiError<TCode extends string, TErrors = undefined> {
+export interface ApiError<TCode extends string, TErrors = undefined, P = unknown> {
     error: {
         code: TCode;
         message?: string | undefined;
         errors?: TErrors;
+        payload?: P;
     };
 }
 export interface ValidationError {
@@ -56,3 +57,7 @@ export interface Endpoint<T extends EndpointDefinition> {
      */
     Reply: ResDefaultErrors | (T['Error'] extends ApiError<any> ? T['Error'] | T['Success'] : T['Success']);
 }
+export interface ErrorPayload {
+    type: string;
+    description: string;
+}

package/dist/auth/api.d.ts

@@ -0,0 +1,102 @@
+import type { BaseConnection } from '../connection/db.js';
+export interface AuthModes {
+    OAuth1: 'OAUTH1';
+    OAuth2: 'OAUTH2';
+    OAuth2CC: 'OAUTH2_CC';
+    Basic: 'BASIC';
+    ApiKey: 'API_KEY';
+    AppStore: 'APP_STORE';
+    Custom: 'CUSTOM';
+    App: 'APP';
+    None: 'NONE';
+}
+export type AuthModeType = AuthModes[keyof AuthModes];
+export interface AuthOperation {
+    CREATION: 'creation';
+    OVERRIDE: 'override';
+    REFRESH: 'refresh';
+    UNKNOWN: 'unknown';
+}
+export type AuthOperationType = AuthOperation[keyof AuthOperation];
+export interface OAuthAuthorizationMethod {
+    BODY: 'body';
+    HEADER: 'header';
+}
+export type OAuthAuthorizationMethodType = OAuthAuthorizationMethod[keyof OAuthAuthorizationMethod];
+export type OAuthBodyFormatType = OAuthBodyFormat[keyof OAuthBodyFormat];
+export interface OAuthBodyFormat {
+    FORM: 'form';
+    JSON: 'json';
+}
+export interface ConnectionUpsertResponse {
+    id: number;
+    operation: AuthOperation;
+}
+export interface OAuth1RequestTokenResult {
+    request_token: string;
+    request_token_secret: string;
+    parsed_query_string: any;
+}
+export interface CredentialsCommon<T = Record<string, any>> {
+    type: AuthModeType;
+    raw: T;
+}
+export interface BasicApiCredentials {
+    type?: AuthModes['Basic'];
+    username: string;
+    password: string;
+}
+export interface ApiKeyCredentials {
+    type?: AuthModes['ApiKey'];
+    apiKey: string;
+}
+export type AuthCredentials = OAuth2Credentials | OAuth1Credentials | OAuth2ClientCredentials;
+export interface AppCredentials {
+    type?: AuthModes['App'];
+    access_token: string;
+    expires_at?: Date | undefined;
+    raw: Record<string, any>;
+}
+export interface AppStoreCredentials {
+    type?: AuthModes['AppStore'];
+    access_token: string;
+    expires_at?: Date | undefined;
+    raw: Record<string, any>;
+    private_key: string;
+}
+export interface OAuth2Credentials extends CredentialsCommon {
+    type: AuthModes['OAuth2'];
+    access_token: string;
+    refresh_token?: string;
+    expires_at?: Date | undefined;
+    config_override?: {
+        client_id?: string;
+        client_secret?: string;
+    };
+}
+export interface CustomCredentials extends CredentialsCommon {
+    type: AuthModes['Custom'];
+}
+export interface OAuth2ClientCredentials extends CredentialsCommon {
+    type: AuthModes['OAuth2CC'];
+    token: string;
+    expires_at?: Date | undefined;
+    client_id: string;
+    client_secret: string;
+}
+export interface OAuth1Credentials extends CredentialsCommon {
+    type: AuthModes['OAuth1'];
+    oauth_token: string;
+    oauth_token_secret: string;
+}
+export interface CredentialsRefresh<T = unknown> {
+    providerConfigKey: string;
+    connectionId: string;
+    promise: Promise<T>;
+}
+export type UnauthCredentials = Record<string, never>;
+export type RefreshTokenResponse = AuthorizationTokenResponse;
+export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'type' | 'raw'> {
+    expires_in?: number;
+}
+export type ImportedCredentials = (OAuth2Credentials & Partial<Pick<AuthorizationTokenResponse, 'expires_in'>> & Partial<Pick<BaseConnection, 'metadata' | 'connection_config'>>) | OAuth1Credentials;

package/dist/auth/db.d.ts

@@ -0,0 +1,15 @@
+import type { AuthModes } from './api.js';
+export interface OAuthSession {
+    providerConfigKey: string;
+    provider: string;
+    connectionId: string;
+    callbackUrl: string;
+    authMode: AuthModes;
+    id: string;
+    connectionConfig: Record<string, string>;
+    environmentId: number;
+    webSocketClientId: string | undefined;
+    codeVerifier: string;
+    requestTokenSecret?: string;
+    activityLogId: string;
+}

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

@@ -0,0 +1,21 @@
+import type { ApiError, Endpoint } from '../../api.js';
+import type { Connection } from '../db.js';
+import type { ActiveLog } from '../../notification/active-logs/db.js';
+export type GetConnection = Endpoint<{
+    Method: 'GET';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        env: string;
+        provider_config_key: string;
+        force_refresh?: 'true' | 'false';
+    };
+    Path: '/api/v1/connection/:connectionId';
+    Error: ApiError<'unknown_connection'> | ApiError<'missing_provider_config'> | ApiError<'unknown_provider'> | ApiError<'missing_connection'> | ApiError<'unknown_provider_config'>;
+    Success: {
+        provider: string | null;
+        connection: Connection;
+        errorLog: ActiveLog | null;
+    };
+}>;

package/dist/connection/db.d.ts

@@ -1 +1,62 @@
+import type { TimestampsAndDeleted } from '../db.js';
+import type { AuthCredentials, ApiKeyCredentials, BasicApiCredentials, AppCredentials, AppStoreCredentials, UnauthCredentials, CustomCredentials, AuthModeType, AuthOperationType } from '../auth/api.js';
+import type { Environment } from '../environment/db.js';
+import type { Account } from '../account/db.js';
 export type Metadata = Record<string, unknown>;
+export type ConnectionConfig = Record<string, any>;
+export interface BaseConnection extends TimestampsAndDeleted {
+    id?: number;
+    config_id?: number;
+    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>;
+}
+export interface Connection extends BaseConnection {
+    credentials: AuthCredentials | ApiKeyCredentials | BasicApiCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials;
+}
+export type RecentlyCreatedConnection = Pick<StoredConnection, 'id' | 'connection_id' | 'provider_config_key'> & {
+    auth_mode: AuthModeType;
+    error?: string;
+    operation: AuthOperationType;
+    environment: Environment;
+    account: Account;
+};
+export interface ApiConnection {
+    id?: number;
+    connection_id: string;
+    provider_config_key: string;
+    config_id?: number;
+    environment_id: number;
+    connection_config: ConnectionConfig;
+    credentials_iv?: string | null;
+    credentials_tag?: string | null;
+    credentials: BasicApiCredentials | ApiKeyCredentials;
+}
+export interface NangoConnection {
+    id?: number;
+    connection_id: string;
+    provider_config_key: string;
+    environment_id: number;
+    connection_config?: ConnectionConfig;
+    /**
+     * @deprecated
+     */
+    account_id?: number;
+}
+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;
+}

package/dist/environment/db.d.ts

@@ -7,3 +7,31 @@ export interface EnvironmentVariable extends Timestamps {
     value_iv?: string | null;
     value_tag?: string | null;
 }
+export interface Environment extends Timestamps {
+    id: number;
+    uuid: string;
+    name: string;
+    account_id: number;
+    secret_key: string;
+    public_key: string;
+    secret_key_iv?: string | null;
+    secret_key_tag?: string | null;
+    secret_key_hashed?: string | null;
+    callback_url: string | null;
+    webhook_url: string | null;
+    webhook_url_secondary: string | null;
+    websockets_path: string | null;
+    hmac_enabled: boolean;
+    always_send_webhook: boolean;
+    send_auth_webhook: boolean;
+    hmac_key: string | null;
+    hmac_digest?: string | null;
+    secret_key_rotatable?: boolean;
+    public_key_rotatable?: boolean;
+    pending_secret_key?: string | null;
+    pending_secret_key_iv?: string | null;
+    pending_secret_key_tag?: string | null;
+    pending_public_key?: string | null;
+    slack_notifications: boolean;
+    webhook_receive_url?: string;
+}

package/dist/index.d.ts

@@ -7,7 +7,17 @@ export type * from './record/api.js';
 export type * from './logs/api.js';
 export type * from './logs/messages.js';
 export type * from './account/api.js';
+export type * from './account/db.js';
 export type * from './user/api.js';
 export type * from './connection/api/metadata.js';
 export type * from './connection/db.js';
 export type * from './environment/db.js';
+export type * from './scripts/post-connection/api.js';
+export type * from './scripts/post-connection/db.js';
+export type * from './scripts/syncs/api.js';
+export type * from './notification/active-logs/db.js';
+export type * from './connection/api/get.js';
+export type * from './integration/db.js';
+export type * from './integration/template.js';
+export type * from './auth/api.js';
+export type * from './auth/db.js';

package/dist/integration/db.d.ts

@@ -0,0 +1,14 @@
+import type { TimestampsAndDeleted } from '../db.js';
+export interface IntegrationConfig extends TimestampsAndDeleted {
+    id?: number;
+    unique_key: string;
+    provider: string;
+    oauth_client_id: string;
+    oauth_client_secret: string;
+    oauth_scopes?: string;
+    environment_id: number;
+    oauth_client_secret_iv?: string | null;
+    oauth_client_secret_tag?: string | null;
+    app_link?: string | null;
+    custom?: Record<string, string>;
+}

package/dist/integration/template.d.ts

@@ -0,0 +1,71 @@
+import type { RetryHeaderConfig, CursorPagination, LinkPagination, OffsetPagination } from '../proxy/api.js';
+import type { AuthModeType, OAuthAuthorizationMethodType, OAuthBodyFormatType } from '../auth/api.js';
+import type { EndpointMethod } from '../api.js';
+export interface TokenUrlObject {
+    OAUTH1?: string;
+    OAUTH2?: string;
+    OAUTH2CC?: string;
+    BASIC?: string;
+    API_KEY?: string;
+    APP_STORE?: string;
+    CUSTOM?: string;
+    APP?: string;
+    NONE?: string;
+}
+export interface Template {
+    auth_mode: AuthModeType;
+    proxy?: {
+        base_url: string;
+        headers?: Record<string, string>;
+        query?: {
+            api_key: string;
+        };
+        retry?: RetryHeaderConfig;
+        decompress?: boolean;
+        paginate?: LinkPagination | CursorPagination | OffsetPagination;
+        verification?: {
+            method: EndpointMethod;
+            endpoint: string;
+            base_url_override?: string;
+            headers?: Record<string, string>;
+        };
+    };
+    authorization_url?: string;
+    authorization_params?: Record<string, string>;
+    scope_separator?: string;
+    default_scopes?: string[];
+    token_url?: string | TokenUrlObject;
+    token_params?: Record<string, string>;
+    authorization_url_replacements?: Record<string, string>;
+    redirect_uri_metadata?: string[];
+    token_response_metadata?: string[];
+    docs?: string;
+    token_expiration_buffer?: number;
+    webhook_routing_script?: string;
+    webhook_user_defined_secret?: boolean;
+    post_connection_script?: string;
+    categories?: string[];
+    connection_configuration?: string[];
+}
+export interface TemplateOAuth2 extends Template {
+    auth_mode: 'OAUTH2' | 'CUSTOM';
+    disable_pkce?: boolean;
+    token_params?: {
+        grant_type?: 'authorization_code' | 'client_credentials';
+    };
+    refresh_params?: {
+        grant_type: 'refresh_token';
+    };
+    authorization_method?: OAuthAuthorizationMethodType;
+    body_format?: OAuthBodyFormatType;
+    refresh_url?: string;
+    token_request_auth_method?: 'basic';
+}
+export interface TemplateOAuth1 extends Template {
+    auth_mode: 'OAUTH1';
+    request_url: string;
+    request_params?: Record<string, string>;
+    request_http_method?: 'GET' | 'PUT' | 'POST';
+    token_http_method?: 'GET' | 'PUT' | 'POST';
+    signature_method: 'HMAC-SHA1' | 'RSA-SHA1' | 'PLAINTEXT';
+}

package/dist/logs/api.d.ts

@@ -17,11 +17,13 @@ export type SearchOperations = Endpoint<{
         connections?: SearchOperationsConnection[] | undefined;
         syncs?: SearchOperationsSync[] | undefined;
         period?: SearchOperationsPeriod | undefined;
+        cursor?: string | null | undefined;
     };
     Success: {
         data: OperationRow[];
         pagination: {
             total: number;
+            cursor: string | null;
         };
     };
 }>;
@@ -59,11 +61,15 @@ export type SearchMessages = Endpoint<{
         limit?: number;
         states?: SearchOperationsState[];
         search?: string | undefined;
+        cursorBefore?: string | null | undefined;
+        cursorAfter?: string | null | undefined;
     };
     Success: {
         data: MessageRow[];
         pagination: {
             total: number;
+            cursorBefore: string | null;
+            cursorAfter: string | null;
         };
     };
 }>;

package/dist/logs/messages.d.ts

@@ -104,6 +104,7 @@ export type MessageRow = {
     updatedAt: string;
     startedAt: string | null;
     endedAt: string | null;
+    expiresAt: string | null;
 } & {
     operation: MessageOperation | null;
 };

package/dist/notification/active-logs/db.d.ts

@@ -0,0 +1,12 @@
+import type { Timestamps } from '../../db.js';
+export interface ActiveLog extends Timestamps {
+    id: number;
+    type: string;
+    action: string;
+    connection_id: number;
+    activity_log_id: number;
+    log_id: string;
+    active: boolean;
+    sync_id: string | null;
+}
+export type ActiveLogIds = Pick<ActiveLog, 'activity_log_id' | 'log_id'>;

package/dist/proxy/api.d.ts

@@ -0,0 +1,65 @@
+import type { ParamsSerializerOptions } from 'axios';
+import type { EndpointMethod } from '../api.js';
+import type { BasicApiCredentials, ApiKeyCredentials, AppCredentials } from '../auth/api.js';
+import type { Connection } from '../connection/db.js';
+import type { Template as ProviderTemplate } from '../integration/template.js';
+interface BaseProxyConfiguration {
+    providerConfigKey: string;
+    connectionId: string;
+    endpoint: string;
+    retries?: number;
+    data?: unknown;
+    headers?: Record<string, string>;
+    params?: string | Record<string, string | number>;
+    paramsSerializer?: ParamsSerializerOptions;
+    baseUrlOverride?: string;
+    responseType?: ResponseType;
+    retryHeader?: RetryHeaderConfig;
+    retryOn?: number[] | null;
+}
+export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
+    decompress?: boolean | string;
+    method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' | 'get' | 'post' | 'patch' | 'put' | 'delete';
+    paginate?: Partial<CursorPagination> | Partial<LinkPagination> | Partial<OffsetPagination>;
+}
+export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfiguration {
+    decompress?: boolean;
+    method: EndpointMethod;
+    provider: string;
+    token: string | BasicApiCredentials | ApiKeyCredentials | AppCredentials;
+    template: ProviderTemplate;
+    connection: Connection;
+}
+export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
+export interface InternalProxyConfiguration {
+    provider: string;
+    connection: Connection;
+    existingActivityLogId?: number | null;
+}
+export interface RetryHeaderConfig {
+    at?: string;
+    after?: string;
+}
+export declare enum PaginationType {
+    CURSOR = "cursor",
+    LINK = "link",
+    OFFSET = "offset"
+}
+export interface Pagination {
+    type: string;
+    limit?: number;
+    response_path?: string;
+    limit_name_in_request: string;
+}
+export interface CursorPagination extends Pagination {
+    cursor_path_in_response: string;
+    cursor_name_in_request: string;
+}
+export interface LinkPagination extends Pagination {
+    link_rel_in_response_header?: string;
+    link_path_in_response_body?: string;
+}
+export interface OffsetPagination extends Pagination {
+    offset_name_in_request: string;
+}
+export {};

package/dist/scripts/post-connection/api.d.ts

@@ -0,0 +1,11 @@
+export interface IncomingPostConnectionScript {
+    name: string;
+    fileBody: {
+        js: string;
+        ts: string;
+    };
+}
+export interface PostConnectionScriptByProvider {
+    providerConfigKey: string;
+    scripts: IncomingPostConnectionScript[];
+}

package/dist/scripts/post-connection/db.d.ts

@@ -0,0 +1,9 @@
+import type { Timestamps } from '../../db.js';
+export interface PostConnectionScript extends Timestamps {
+    id: number;
+    config_id: number;
+    name: string;
+    file_location: string;
+    version: string;
+    active: boolean;
+}

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

@@ -0,0 +1,6 @@
+export interface SyncResult {
+    added: number;
+    updated: number;
+    deleted: number;
+}
+export type SyncType = 'INCREMENTAL' | 'INITIAL';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.39.32",
+    "version": "0.40.0",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -11,6 +11,9 @@
         "url": "git+https://github.com/NangoHQ/nango.git",
         "directory": "packages/utils"
     },
+    "devDependencies": {
+        "axios": "^1.3.4"
+    },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "files": [
         "dist/**/*"