@nangohq/types 0.45.0 → 0.46.0

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<'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'>;
+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'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/auth/api.d.ts

@@ -55,7 +55,6 @@ export interface ApiKeyCredentials {
     type: AuthModes['ApiKey'];
     apiKey: string;
 }
-export type AuthCredentials = OAuth2Credentials | OAuth1Credentials | OAuth2ClientCredentials;
 export interface AppCredentials {
     type: AuthModes['App'];
     access_token: string;

package/dist/auth/http.api.d.ts

@@ -9,6 +9,7 @@ export type ConnectionQueryString = {
 } | {
     connect_session_token: string;
 });
+type AuthErrors = ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'> | ApiError<'integration_not_allowed'>;
 export type PostPublicTbaAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
@@ -22,7 +23,7 @@ export type PostPublicTbaAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/tba/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
@@ -40,7 +41,7 @@ export type PostPublicTableauAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/tableau/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
@@ -61,7 +62,7 @@ export type PostPublicJwtAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/jwt/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
@@ -74,7 +75,7 @@ export type PostPublicUnauthenticatedAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/unauthenticated/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
@@ -93,7 +94,7 @@ export type PostPublicBillAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/bill/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
@@ -107,7 +108,7 @@ export type PostPublicTwoStepAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/two-step/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
@@ -124,9 +125,10 @@ export type PostPublicSignatureAuthorization = Endpoint<{
         providerConfigKey: string;
     };
     Path: '/auth/signature-based/:providerConfigKey';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Error: AuthErrors;
     Success: {
         providerConfigKey: string;
         connectionId: string;
     };
 }>;
+export {};

package/dist/deploy/api.d.ts

@@ -2,6 +2,7 @@ import type { JSONSchema7 } from 'json-schema';
 import type { Endpoint, ApiError } from '../api.js';
 import type { IncomingFlowConfig, OnEventScriptsByProvider } from './incomingFlow.js';
 import type { SyncDeploymentResult } from './index.js';
+import type { OnEventType } from '../scripts/on-events/api.js';
 export type PostDeployConfirmation = Endpoint<{
     Method: 'POST';
     Path: '/sync/deploy/confirmation';
@@ -13,7 +14,7 @@ export type PostDeployConfirmation = Endpoint<{
         singleDeployMode?: boolean;
         jsonSchema?: JSONSchema7 | undefined;
     };
-    Success: SyncAndActionDifferences;
+    Success: ScriptDifferences;
 }>;
 export type PostDeploy = Endpoint<{
     Method: 'POST';
@@ -61,6 +62,11 @@ export interface SlimAction {
     providerConfigKey: string;
     name: string;
 }
+export interface SlimOnEventScript {
+    providerConfigKey: string;
+    name: string;
+    event: OnEventType;
+}
 export interface SyncAndActionDifferences {
     newSyncs: SlimSync[];
     deletedSyncs: SlimSync[];
@@ -68,3 +74,7 @@ export interface SyncAndActionDifferences {
     deletedActions: SlimAction[];
     deletedModels: string[];
 }
+export interface ScriptDifferences extends SyncAndActionDifferences {
+    newOnEventScripts: SlimOnEventScript[];
+    deletedOnEventScripts: SlimOnEventScript[];
+}

package/dist/deploy/incomingFlow.d.ts

@@ -1,5 +1,6 @@
 import type { Merge } from 'type-fest';
-import type { NangoModel, NangoSyncEndpointOld, NangoSyncEndpointV2, OnEventType, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+import type { NangoModel, NangoSyncEndpointOld, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+import type { OnEventType } from '../scripts/on-events/api';
 export interface IncomingScriptFiles {
     js: string;
     ts: string;

package/dist/index.d.ts

@@ -22,7 +22,8 @@ export type * from './team/db.js';
 export type * from './providers/api.js';
 export type * from './proxy/api.js';
 export type * from './environment/db.js';
-export type * from './scripts/post-connection/db.js';
+export type * from './scripts/on-events/db.js';
+export type * from './scripts/on-events/api.js';
 export type * from './scripts/syncs/api.js';
 export type * from './slackNotifications/db.js';
 export type * from './notification/active-logs/db.js';

package/dist/integration/api.d.ts

@@ -2,7 +2,7 @@ import type { Merge } from 'type-fest';
 import type { ApiTimestamps, Endpoint } from '../api';
 import type { IntegrationConfig } from './db';
 import type { Provider } from '../providers/provider';
-import type { AuthModeType } from '../auth/api';
+import type { AuthModeType, AuthModes } from '../auth/api';
 import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral } from '../nangoYaml';
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
 import type { JSONSchema7 } from 'json-schema';
@@ -13,6 +13,17 @@ export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' |
 } & ApiPublicIntegrationInclude;
 export interface ApiPublicIntegrationInclude {
     webhook_url?: string | null;
+    credentials?: {
+        type: AuthModes['OAuth2'] | AuthModes['OAuth1'] | AuthModes['TBA'];
+        client_id: string | null;
+        client_secret: string | null;
+        scopes: string | null;
+    } | {
+        type: AuthModes['App'];
+        app_id: string | null;
+        private_key: string | null;
+        app_link: string | null;
+    } | null;
 }
 export type GetPublicListIntegrationsLegacy = Endpoint<{
     Method: 'GET';
@@ -24,6 +35,9 @@ export type GetPublicListIntegrationsLegacy = Endpoint<{
 export type GetPublicListIntegrations = Endpoint<{
     Method: 'GET';
     Path: '/integrations';
+    Querystring?: {
+        connect_session_token: string;
+    };
     Success: {
         data: ApiPublicIntegration[];
     };
@@ -35,7 +49,7 @@ export type GetPublicIntegration = Endpoint<{
         uniqueKey: string;
     };
     Querystring: {
-        include?: 'webhook'[] | undefined;
+        include?: ('webhook' | 'credentials')[] | undefined;
     };
     Success: {
         data: ApiPublicIntegration;
@@ -64,7 +78,7 @@ export type PostIntegration = Endpoint<{
         data: ApiIntegration;
     };
 }>;
-export type ApiIntegration = Merge<IntegrationConfig, ApiTimestamps>;
+export type ApiIntegration = Omit<Merge<IntegrationConfig, ApiTimestamps>, 'oauth_client_secret_iv' | 'oauth_client_secret_tag'>;
 export type GetIntegration = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey';

package/dist/integration/db.d.ts

@@ -1,14 +1,18 @@
+import type { SetOptional } from 'type-fest';
 import type { TimestampsAndDeleted } from '../db.js';
+import type { NullablePartial } from '../utils.js';
 export interface IntegrationConfig extends TimestampsAndDeleted {
-    id?: number;
+    id?: number | undefined;
     unique_key: string;
     provider: string;
-    oauth_client_id: string;
-    oauth_client_secret: string;
-    oauth_scopes?: string;
+    oauth_client_id: string | null;
+    oauth_client_secret: string | null;
+    oauth_scopes?: string | undefined | null;
     environment_id: number;
     oauth_client_secret_iv?: string | null;
     oauth_client_secret_tag?: string | null;
-    app_link?: string | null;
-    custom?: Record<string, string>;
+    app_link?: string | null | undefined;
+    custom?: Record<string, string> | undefined | null;
+    missing_fields: string[];
 }
+export type DBCreateIntegration = SetOptional<NullablePartial<Omit<IntegrationConfig, 'created_at' | 'updated_at'>>, 'missing_fields'>;

package/dist/logs/messages.d.ts

@@ -37,6 +37,10 @@ export interface OperationAction {
     type: 'action';
     action: 'run';
 }
+export interface OperationOnEvents {
+    type: 'events';
+    action: 'post_connection_creation' | 'pre_connection_deletion';
+}
 export interface OperationAuth {
     type: 'auth';
     action: 'create_connection' | 'refresh_token' | 'post_connection' | 'connection_test';
@@ -53,7 +57,7 @@ export interface OperationDeploy {
     type: 'deploy';
     action: 'prebuilt' | 'custom';
 }
-export type OperationList = OperationSync | OperationProxy | OperationAction | OperationWebhook | OperationDeploy | OperationAuth | OperationAdmin;
+export type OperationList = OperationSync | OperationProxy | OperationAction | OperationWebhook | OperationOnEvents | OperationDeploy | OperationAuth | OperationAdmin;
 /**
  * Full schema
  */

package/dist/nangoYaml/index.d.ts

@@ -1,7 +1,8 @@
+import type { OnEventType } from '../scripts/on-events/api';
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export type SyncTypeLiteral = 'incremental' | 'full';
 export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'post-connection-scripts';
-export type ScriptTypeLiteral = 'action' | 'sync';
+export type ScriptTypeLiteral = 'action' | 'sync' | 'on-event';
 export interface NangoYamlV1 {
     integrations: Record<string, Record<string, NangoYamlV1Integration>>;
     models: NangoYamlModel;
@@ -63,7 +64,6 @@ export interface NangoYamlModelFields {
 }
 export type NangoYamlModelField = boolean | number | string | null | string[] | NangoYamlModelFields;
 export type NangoYaml = NangoYamlV1 | NangoYamlV2;
-export type OnEventType = 'post-connection-creation' | 'pre-connection-deletion';
 export interface NangoYamlParsed {
     yamlVersion: 'v1' | 'v2';
     integrations: NangoYamlParsedIntegration[];

package/dist/providers/api.d.ts

@@ -5,6 +5,7 @@ export type GetPublicProviders = Endpoint<{
     Path: `/providers`;
     Querystring: {
         search?: string | undefined;
+        connect_session_token?: string;
     };
     Success: {
         data: ApiProvider[];
@@ -19,6 +20,9 @@ export type GetPublicProvider = Endpoint<{
     Params: {
         provider: string;
     };
+    Querystring?: {
+        connect_session_token: string;
+    };
     Success: {
         data: ApiProvider;
     };

package/dist/providers/provider.d.ts

@@ -33,6 +33,7 @@ export interface SimplifiedJSONSchema {
     suffix?: string;
     doc_section?: string;
     secret?: string;
+    automated: boolean;
 }
 export interface BaseProvider {
     display_name: string;
@@ -55,13 +56,13 @@ export interface BaseProvider {
         };
     };
     authorization_url?: string;
-    authorization_url_encode?: boolean;
+    authorization_url_skip_encode?: string[];
     access_token_url?: string;
     authorization_params?: Record<string, string>;
     scope_separator?: string;
     default_scopes?: string[];
     token_url?: string | TokenUrlObject;
-    token_url_encode?: boolean;
+    token_url_skip_encode?: string[];
     token_params?: Record<string, string>;
     authorization_url_replacements?: Record<string, string>;
     redirect_uri_metadata?: string[];

package/dist/runner/index.d.ts

@@ -8,3 +8,9 @@ export interface RunnerOutput {
     error: RunnerOutputError | null;
     response?: any;
 }
+export interface RunnerFlags {
+    validateActionInput: boolean;
+    validateActionOutput: boolean;
+    validateSyncRecords: boolean;
+    validateSyncMetadata: boolean;
+}

package/dist/scripts/on-events/api.d.ts

@@ -0,0 +1,14 @@
+import type { DBOnEventScript } from './db.js';
+export type OnEventType = 'post-connection-creation' | 'pre-connection-deletion';
+export interface OnEventScript {
+    id: DBOnEventScript['id'];
+    configId: DBOnEventScript['config_id'];
+    providerConfigKey: string;
+    name: DBOnEventScript['name'];
+    fileLocation: DBOnEventScript['file_location'];
+    version: DBOnEventScript['version'];
+    active: DBOnEventScript['active'];
+    event: OnEventType;
+    createdAt: DBOnEventScript['created_at'];
+    updatedAt: DBOnEventScript['updated_at'];
+}

package/dist/scripts/{post-connection → on-events}/db.d.ts

@@ -1,5 +1,5 @@
 import type { Timestamps } from '../../db.js';
-export interface OnEventScript extends Timestamps {
+export interface DBOnEventScript extends Timestamps {
     id: number;
     config_id: number;
     name: string;

package/dist/user/api.d.ts

@@ -21,4 +21,5 @@ export interface ApiUser {
     accountId: number;
     email: string;
     name: string;
+    uuid: string;
 }

package/dist/utils.d.ts

@@ -10,4 +10,7 @@ export interface Logger {
 }
 type ValidateSelection<T, U> = U extends T ? U : never;
 export type PickFromUnion<T, U extends T> = ValidateSelection<T, U>;
+export type NullablePartial<TBase, TNullableKey extends keyof TBase = {
+    [K in keyof TBase]: null extends TBase[K] ? K : never;
+}[keyof TBase]> = Partial<Pick<TBase, TNullableKey>> & Pick<TBase, Exclude<keyof TBase, TNullableKey>>;
 export {};

package/dist/web/env.d.ts

@@ -4,8 +4,9 @@ export interface WindowEnv {
     connectUrl: string;
     publicSentryKey: string;
     publicPosthogKey: string;
-    publicPosthogPost: string;
+    publicPosthogHost: string;
     publicLogoDevKey: string;
+    publicKoalaKey: string;
     isCloud: boolean;
     features: {
         logs: boolean;

package/dist/webhooks/api.d.ts

@@ -39,6 +39,13 @@ export interface NangoAuthWebhookBodyBase extends NangoWebhookBase {
     provider: string;
     environment: string;
     operation: AuthOperationType;
+    /**
+     * Only presents if the connection happened with a session token
+     */
+    endUser?: {
+        endUserId: string;
+        organizationId?: string | undefined;
+    } | undefined;
 }
 export interface NangoAuthWebhookBodySuccess extends NangoAuthWebhookBodyBase {
     success: true;

package/package.json

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