@nangohq/types 0.48.0 → 0.48.2

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

package/dist/api.endpoints.d.ts

@@ -15,8 +15,9 @@ import type { DeletePublicConnection, GetConnection, GetConnections, GetConnecti
 import type { GetMeta } from './meta/api';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
 import type { PostPublicWebhook } from './webhooks/http.api';
+import type { PostEnvironment } from './environment/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;
-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;
+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;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/auth/api.d.ts

@@ -46,6 +46,10 @@ export interface CredentialsCommon<T = Record<string, any>> {
     type: AuthModeType;
     raw: T;
 }
+export interface OAuth1Token {
+    oAuthToken: string;
+    oAuthTokenSecret: string;
+}
 export interface BasicApiCredentials {
     type: AuthModes['Basic'];
     username: string;

package/dist/endUser/index.d.ts

@@ -27,10 +27,10 @@ export interface DBEndUser {
 export type DBInsertEndUser = Omit<DBEndUser, 'id' | 'created_at' | 'updated_at'>;
 export interface ApiEndUser {
     id: string;
-    displayName: string | null;
+    display_name: string | null;
     email: string | null;
     organization: {
         id: string;
-        displayName: string | null;
+        display_name: string | null;
     } | null;
 }

package/dist/environment/api/index.d.ts

@@ -0,0 +1,12 @@
+import type { Endpoint } from '../../api';
+import type { DBEnvironment } from '../db';
+export type PostEnvironment = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/environments';
+    Body: {
+        name: string;
+    };
+    Success: {
+        data: Pick<DBEnvironment, 'id' | 'name'>;
+    };
+}>;

package/dist/environment/variable/index.d.ts

@@ -0,0 +1,4 @@
+export interface EnvironmentVariable {
+    name: string;
+    value: string;
+}

package/dist/index.d.ts

@@ -21,7 +21,6 @@ export type * from './team/api.js';
 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/on-events/db.js';
 export type * from './scripts/on-events/api.js';
 export type * from './scripts/syncs/api.js';
@@ -42,10 +41,13 @@ export type * from './connect/api.js';
 export type * from './connect/session.js';
 export type * from './endUser/index.js';
 export type * from './runner/index.js';
+export type * from './runner/sdk.js';
 export type * from './nangoYaml/index.js';
 export type * from './environment/db.js';
+export type * from './environment/api/index.js';
 export type * from './environment/api/webhook.js';
 export type * from './environment/api/otlp.js';
+export type * from './environment/variable/index.js';
 export type * from './webhooks/api.js';
 export type * from './webhooks/http.api.js';
 export type * from './flow/http.api.js';

package/dist/keystore/index.d.ts

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

package/dist/logs/api.d.ts

@@ -102,7 +102,7 @@ export type PostInsights = Endpoint<{
         env: string;
     };
     Body: {
-        type: PickFromUnion<ConcatOperationListWithGroup, 'action' | 'sync' | 'proxy' | 'webhook:incoming'>;
+        type: PickFromUnion<ConcatOperationListWithGroup, 'action' | 'sync:run' | 'proxy' | 'webhook:incoming'>;
     };
     Success: {
         data: {

package/dist/nangoYaml/index.d.ts

@@ -122,9 +122,7 @@ export interface NangoModelField {
     union?: boolean | undefined;
     optional?: boolean | undefined;
 }
-export type NangoSyncEndpointOld = {
-    [key in HTTP_METHOD]?: string | undefined;
-};
+export type NangoSyncEndpointOld = Partial<Record<HTTP_METHOD, string | undefined>>;
 export interface NangoSyncEndpointV2 {
     method: HTTP_METHOD;
     path: string;

package/dist/providers/provider.d.ts

@@ -122,7 +122,7 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
     };
     token_expires_in_ms?: number;
     proxy_header_authorization?: string;
-    body_format?: 'xml' | 'json';
+    body_format?: 'xml' | 'json' | 'form';
 }
 export interface ProviderSignature extends BaseProvider {
     signature: {

package/dist/proxy/api.d.ts

@@ -47,22 +47,25 @@ export declare enum PaginationType {
     LINK = "link",
     OFFSET = "offset"
 }
-export interface Pagination {
-    type: string;
+export interface PaginationBase {
     limit?: number;
     response_path?: string;
     limit_name_in_request: string;
 }
-export interface CursorPagination extends Pagination {
+export type Pagination = CursorPagination | LinkPagination | OffsetPagination;
+export interface CursorPagination extends PaginationBase {
+    type: 'cursor';
     cursor_path_in_response: string;
     cursor_name_in_request: string;
 }
-export interface LinkPagination extends Pagination {
+export interface LinkPagination extends PaginationBase {
+    type: 'link';
     link_rel_in_response_header?: string;
     link_path_in_response_body?: string;
 }
 export type OffsetCalculationMethod = 'per-page' | 'by-response-size';
-export interface OffsetPagination extends Pagination {
+export interface OffsetPagination extends PaginationBase {
+    type: 'offset';
     offset_name_in_request: string;
     offset_start_value?: number;
     offset_calculation_method?: OffsetCalculationMethod;

package/dist/runner/sdk.d.ts

@@ -0,0 +1,58 @@
+import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse } from 'axios';
+import type { RunnerFlags } from '.';
+import type { Metadata } from '../connection/db';
+import type { DBTeam } from '../team/db';
+import type { DBSyncConfig } from '../syncConfigs/db';
+export interface RunArgs {
+    sync: string;
+    connectionId: string;
+    lastSyncDate?: string;
+    useServerLastSyncDate?: boolean;
+    input?: object;
+    metadata?: Metadata;
+    autoConfirm: boolean;
+    debug: boolean;
+    optionalEnvironment?: string;
+    optionalProviderConfigKey?: string;
+}
+export interface DryRunServiceInterface {
+    run: (options: RunArgs, debug?: boolean) => Promise<string | void>;
+}
+export interface NangoProps {
+    scriptType: 'sync' | 'action' | 'webhook' | 'on-event';
+    host?: string;
+    secretKey: string;
+    team?: Pick<DBTeam, 'id' | 'name'>;
+    connectionId: string;
+    environmentId: number;
+    environmentName?: string;
+    activityLogId?: string | undefined;
+    providerConfigKey: string;
+    provider: string;
+    lastSyncDate?: Date;
+    syncId?: string | undefined;
+    nangoConnectionId?: number;
+    syncJobId?: number | undefined;
+    track_deletes?: boolean;
+    attributes?: object | undefined;
+    abortSignal?: AbortSignal;
+    syncConfig: DBSyncConfig;
+    runnerFlags: RunnerFlags;
+    debug: boolean;
+    startedAt: Date;
+    endUser: {
+        id: number;
+        endUserId: string | null;
+        orgId: string | null;
+    } | null;
+    axios?: {
+        request?: AxiosInterceptorManager<AxiosRequestConfig>;
+        response?: {
+            onFulfilled: (value: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
+            onRejected: (value: unknown) => AxiosError | Promise<AxiosError>;
+        };
+    };
+}
+export interface UserLogParameters {
+    level?: 'info' | 'debug' | 'error' | 'warn' | 'http' | 'verbose' | 'silly';
+}

package/dist/web/env.d.ts

@@ -6,7 +6,8 @@ export interface WindowEnv {
     publicPosthogKey: string;
     publicPosthogHost: string;
     publicLogoDevKey: string;
-    publicKoalaKey: string;
+    publicKoalaApiUrl: string;
+    publicKoalaCdnUrl: string;
     isCloud: boolean;
     features: {
         logs: boolean;
@@ -14,5 +15,6 @@ export interface WindowEnv {
         auth: boolean;
         managedAuth: boolean;
         gettingStarted: boolean;
+        slack: boolean;
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.48.0",
+    "version": "0.48.2",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -13,9 +13,9 @@
     },
     "devDependencies": {
         "@types/json-schema": "7.0.15",
-        "axios": "^1.7.4",
+        "axios": "^1.7.9",
         "json-schema": "0.4.0",
-        "type-fest": "4.26.1"
+        "type-fest": "4.32.0"
     },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "files": [