@nangohq/types 0.66.1 → 0.67.0

package/dist/api.endpoints.d.ts

@@ -4,13 +4,14 @@ import type { PostImpersonate } from './admin/http.api.js';
 import type { EndpointMethod } from './api.js';
 import type { PostPublicApiKeyAuthorization, PostPublicAppStoreAuthorization, PostPublicBasicAuthorization, PostPublicBillAuthorization, PostPublicJwtAuthorization, PostPublicOauthOutboundAuthorization, PostPublicSignatureAuthorization, PostPublicTbaAuthorization, PostPublicTwoStepAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api.js';
 import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect, PostPublicConnectTelemetry } from './connect/api.js';
-import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PostConnectionRefresh } from './connection/api/get.js';
+import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata.js';
 import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api.js';
 import type { DeleteEnvironment, PatchEnvironment, PostEnvironment } from './environment/api/index.js';
 import type { PatchWebhook } from './environment/api/webhook.js';
 import type { PostEnvironmentVariables } from './environment/variable/api.js';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api.js';
+import type { GetGettingStarted, PatchGettingStarted } from './gettingStarted/api.js';
 import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicIntegration, GetPublicListIntegrations, PatchIntegration, PatchPublicIntegration, PostIntegration, PostPublicIntegration } from './integration/api.js';
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api.js';
 import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api.js';
@@ -20,12 +21,13 @@ import type { PostPlanExtendTrial } from './plans/http.api.js';
 import type { GetPublicProvider, GetPublicProviders } from './providers/api.js';
 import type { GetPublicRecords } from './record/api.js';
 import type { GetPublicScriptsConfig } from './scripts/http.api.js';
+import type { GetSharedCredentialsProvider, GetSharedCredentialsProviders, PatchSharedCredentialsProvider, PostSharedCredentialsProvider } from './sharedCredentials/api.js';
 import type { PostPublicTrigger, PutPublicSyncConnectionFrequency } from './sync/api.js';
 import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api.js';
 import type { GetUser, PatchUser } from './user/api.js';
 import type { PostPublicWebhook } from './webhooks/http.api.js';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | 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 | DeleteEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | 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 | DeleteEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/auth/api.d.ts

@@ -1,3 +1,4 @@
+import type { DBConnection } from '../connection/db.js';
 export interface AuthModes {
     OAuth1: 'OAUTH1';
     OAuth2: 'OAUTH2';
@@ -15,13 +16,7 @@ export interface AuthModes {
     Signature: 'SIGNATURE';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
-export interface AuthOperation {
-    CREATION: 'creation';
-    OVERRIDE: 'override';
-    REFRESH: 'refresh';
-    UNKNOWN: 'unknown';
-}
-export type AuthOperationType = AuthOperation[keyof AuthOperation];
+export type AuthOperationType = 'creation' | 'override' | 'refresh' | 'unknown';
 export interface OAuthAuthorizationMethod {
     BODY: 'body';
     HEADER: 'header';
@@ -33,8 +28,8 @@ export interface OAuthBodyFormat {
     JSON: 'json';
 }
 export interface ConnectionUpsertResponse {
-    id: number;
-    operation: AuthOperation;
+    connection: DBConnection;
+    operation: AuthOperationType;
 }
 export interface OAuth1RequestTokenResult {
     request_token: string;
@@ -63,6 +58,7 @@ export interface AppCredentials {
     access_token: string;
     expires_at?: Date | undefined;
     raw: Record<string, any>;
+    jwtToken?: string;
 }
 export interface AppStoreCredentials {
     type?: AuthModes['AppStore'];

package/dist/billing/types.d.ts

@@ -52,7 +52,7 @@ export interface BillingPlan {
     external_plan_id: string;
 }
 export interface BillingIngestEvent {
-    type: 'monthly_active_records' | 'billable_connections' | 'total_connections' | 'billable_actions' | 'billable_active_connections';
+    type: 'monthly_active_records' | 'billable_connections' | 'billable_actions' | 'billable_active_connections';
     idempotencyKey: string;
     accountId: number;
     timestamp: Date;

package/dist/connect/api.d.ts

@@ -13,6 +13,7 @@ export interface ConnectSessionInput {
         id: string;
         email?: string | undefined;
         display_name?: string | undefined;
+        tags?: Record<string, string> | undefined;
     };
     organization?: {
         id: string;

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

@@ -1,9 +1,9 @@
 import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
-import type { AllAuthCredentials } from '../../auth/api.js';
+import type { AllAuthCredentials, ApiKeyCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
 import type { ApiEndUser } from '../../endUser/index.js';
 import type { ActiveLog } from '../../notification/active-logs/db.js';
 import type { ReplaceInObject } from '../../utils.js';
-import type { DBConnection, DBConnectionDecrypted } from '../db.js';
+import type { ConnectionConfig, DBConnection, DBConnectionDecrypted } from '../db.js';
 import type { Merge } from 'type-fest';
 export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id' | 'connection_id' | 'provider_config_key' | 'created_at' | 'updated_at'> & {
     provider: string;
@@ -66,6 +66,24 @@ export type GetPublicConnections = Endpoint<{
         connections: ApiPublicConnection[];
     };
 }>;
+export type PostPublicConnection = Endpoint<{
+    Method: 'POST';
+    Path: '/connections';
+    Body: {
+        connection_id?: string | undefined;
+        provider_config_key: string;
+        metadata?: Record<string, unknown> | undefined;
+        connection_config?: ConnectionConfig | undefined;
+        credentials: OAuth2Credentials | OAuth2ClientCredentials | OAuth1Credentials | ApiKeyCredentials | BasicApiCredentials | TbaCredentials | {
+            type: 'APP';
+            app_id: string;
+            installation_id: string;
+        } | {
+            type: 'NONE';
+        };
+    };
+    Success: ApiPublicConnectionFull;
+}>;
 export type ApiConnectionFull = Omit<ReplaceInObject<DBConnectionDecrypted, Date, string>, 'credentials_iv' | 'end_user_id' | 'credentials_tag' | 'deleted' | 'deleted_at'>;
 export type GetConnection = Endpoint<{
     Method: 'GET';

package/dist/connection/db.d.ts

@@ -8,6 +8,7 @@ import type { Merge, Simplify } from 'type-fest';
 export type Metadata = Record<string, unknown>;
 export interface ConnectionConfig {
     [key: string]: any;
+    oauth_scopes_override?: string[];
     oauth_scopes?: string;
     authorization_params?: Record<string, string>;
 }

package/dist/endUser/index.d.ts

@@ -5,6 +5,7 @@ export interface EndUser {
     readonly environmentId: number;
     readonly email: string | null;
     readonly displayName?: string | null;
+    readonly tags: Record<string, string> | null;
     readonly organization?: {
         readonly organizationId: string;
         readonly displayName?: string | null;
@@ -21,6 +22,7 @@ export interface DBEndUser {
     readonly display_name: string | null;
     readonly organization_id: string | null;
     readonly organization_display_name: string | null;
+    readonly tags: Record<string, string> | null;
     readonly created_at: Date;
     readonly updated_at: Date | null;
 }

package/dist/gettingStarted/api.d.ts

@@ -0,0 +1,23 @@
+import type { GettingStartedOutput as GettingStartedProgressOutput, PatchGettingStartedInput as PatchGettingStartedProgressInput } from './dto.js';
+import type { ApiError, Endpoint } from '../api.js';
+export type GetGettingStarted = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/getting-started';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: GettingStartedProgressOutput;
+    };
+    Error: ApiError<'failed_to_get_or_create_getting_started_progress'>;
+}>;
+export type PatchGettingStarted = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/getting-started';
+    Querystring: {
+        env: string;
+    };
+    Success: never;
+    Body: PatchGettingStartedProgressInput;
+    Error: ApiError<'connection_not_found' | 'getting_started_progress_not_found' | 'failed_to_update_getting_started_progress'>;
+}>;

package/dist/gettingStarted/db.d.ts

@@ -0,0 +1,20 @@
+import type { Timestamps } from '../db.js';
+/**
+ * One per account. Holds environment and integration used for getting started flow for that account.
+ */
+export interface DBGettingStartedMeta extends Timestamps {
+    id: number;
+    account_id: number;
+    environment_id: number;
+    integration_id: number;
+}
+/**
+ * One per user. Holds progress for each user in the getting started flow.
+ */
+export interface DBGettingStartedProgress extends Timestamps {
+    id: number;
+    getting_started_meta_id: number;
+    user_id: number;
+    connection_id: number | null;
+    step: number;
+}

package/dist/gettingStarted/dto.d.ts

@@ -0,0 +1,18 @@
+import type { DBGettingStartedMeta, DBGettingStartedProgress } from './db.js';
+import type { DBConnection } from '../connection/db.js';
+import type { DBEnvironment } from '../environment/db.js';
+import type { IntegrationConfig } from '../integration/db.js';
+export interface GettingStartedOutput {
+    meta: {
+        environment: Pick<DBEnvironment, 'id' | 'name'>;
+        integration: Pick<IntegrationConfig, 'id' | 'unique_key' | 'provider' | 'display_name'>;
+    };
+    connection: Pick<DBConnection, 'id' | 'connection_id'> | null;
+    step: number;
+}
+export interface PatchGettingStartedInput {
+    connection_id?: string | null | undefined;
+    step?: number | undefined;
+}
+export type CreateGettingStartedMeta = Omit<DBGettingStartedMeta, 'id' | 'created_at' | 'updated_at'>;
+export type CreateGettingStartedProgress = Omit<DBGettingStartedProgress, 'id' | 'created_at' | 'updated_at'>;

package/dist/index.d.ts

@@ -3,6 +3,9 @@ export type * from './api.js';
 export type * from './api.endpoints.js';
 export type * from './onboarding/db.js';
 export type * from './onboarding/api.js';
+export type * from './gettingStarted/db.js';
+export type * from './gettingStarted/dto.js';
+export type * from './gettingStarted/api.js';
 export type * from './record/api.js';
 export type * from './logs/api.js';
 export type * from './logs/messages.js';
@@ -21,7 +24,9 @@ export type * from './syncConfigs/db.js';
 export type * from './syncConfigs/api.js';
 export type * from './team/api.js';
 export type * from './team/db.js';
+export type * from './sharedCredentials/api.js';
 export type * from './sharedCredentials/db.js';
+export type * from './sharedCredentials/dto.js';
 export type * from './billing/types.js';
 export type * from './billing/http.api.js';
 export type * from './usage/dto.js';

package/dist/integration/db.d.ts

@@ -18,5 +18,6 @@ export interface IntegrationConfig extends TimestampsAndDeleted {
     forward_webhooks: boolean;
     shared_credentials_id: number | null;
 }
+export type DBIntegrationDecrypted = IntegrationConfig;
 export type DBIntegrationCrypted = Tagged<IntegrationConfig, 'IntegrationCrypted'>;
 export type DBCreateIntegration = SetOptional<NullablePartial<Omit<IntegrationConfig, 'created_at' | 'updated_at'>>, 'missing_fields'>;

package/dist/proxy/api.d.ts

@@ -43,8 +43,8 @@ export interface InternalProxyConfiguration {
     providerName: string;
 }
 export interface RetryHeaderConfig {
-    at?: string;
-    after?: string;
+    at?: string[] | string;
+    after?: string[] | string;
     remaining?: string;
     error_code?: string[];
     in_body?: {

package/dist/runner/sdk.d.ts

@@ -34,6 +34,7 @@ export interface NangoProps {
         orgId: string | null;
     } | null;
     heartbeatTimeoutSecs?: number | undefined;
+    isCLI?: boolean | undefined;
     axios?: {
         request?: AxiosInterceptorManager<AxiosRequestConfig>;
         response?: {

package/dist/sharedCredentials/api.d.ts

@@ -0,0 +1,58 @@
+import type { ApiError, Endpoint } from '../api.js';
+export type GetSharedCredentialsProviders = Endpoint<{
+    Method: 'GET';
+    Path: '/internal/shared-credentials';
+    Success: {
+        success: boolean;
+        data: SharedCredentialsOutput[];
+    };
+}>;
+export type GetSharedCredentialsProvider = Endpoint<{
+    Method: 'GET';
+    Path: '/internal/shared-credentials/:id';
+    Params: {
+        id: number;
+    };
+    Success: {
+        success: boolean;
+        data: SharedCredentialsOutput;
+    };
+}>;
+export type PostSharedCredentialsProvider = Endpoint<{
+    Method: 'POST';
+    Path: '/internal/shared-credentials';
+    Body: SharedCredentialsBodyInput;
+    Success: {
+        success: boolean;
+    };
+    Error: ApiError<'invalid_body' | 'shared_credentials_already_exists' | 'invalid_provider'>;
+}>;
+export type PatchSharedCredentialsProvider = Endpoint<{
+    Method: 'PATCH';
+    Path: '/internal/shared-credentials/:id';
+    Params: {
+        id: number;
+    };
+    Body: SharedCredentialsBodyInput;
+    Success: {
+        success: boolean;
+    };
+    Error: ApiError<'invalid_body' | 'shared_credentials_provider_not_found' | 'shared_credentials_already_exists' | 'invalid_provider'>;
+}>;
+export interface SharedCredentialsBodyInput {
+    name: string;
+    client_id: string;
+    client_secret: string;
+    scopes?: string | undefined;
+}
+export interface SharedCredentialsOutput {
+    id: number;
+    name: string;
+    credentials: {
+        client_id: string;
+        client_secret: string;
+        scopes?: string | undefined;
+    };
+    created_at: string;
+    updated_at: string;
+}

package/dist/sharedCredentials/dto.d.ts

@@ -0,0 +1,2 @@
+import type { SharedCredentials } from './db.js';
+export type SharedCredentialsInputDto = Pick<SharedCredentials, 'oauth_client_id' | 'oauth_client_secret' | 'oauth_scopes'>;

package/package.json

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