@nangohq/types 0.42.0 → 0.42.2

package/dist/account/api.d.ts

@@ -1,31 +1,20 @@
 import type { ApiError, Endpoint } from '../api';
-import type { WebUser } from '../user/api';
-export type Signup = Endpoint<{
+import type { ApiUser } from '../user/api';
+export type PostSignup = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/account/signup';
     Body: {
         email: string;
         name: string;
         password: string;
+        token?: string | undefined;
     };
-    Error: ApiError<'email_already_verified'> | ApiError<'error_creating_user'> | ApiError<'user_already_exists'> | ApiError<'error_creating_account'> | ApiError<'email_not_verified'>;
+    Error: ApiError<'email_already_verified'> | ApiError<'error_creating_user'> | ApiError<'user_already_exists'> | ApiError<'error_creating_account'> | ApiError<'invalid_invite_token'> | ApiError<'email_not_verified'>;
     Success: {
-        uuid: string;
-    };
-}>;
-export type SignupWithToken = Endpoint<{
-    Method: 'POST';
-    Path: '/api/v1/account/signup/token';
-    Body: {
-        email: string;
-        name: string;
-        password: string;
-        token: string;
-        accountId: number;
-    };
-    Error: ApiError<'error_creating_user'> | ApiError<'user_already_exists'> | ApiError<'invalid_invite_token'> | ApiError<'error_logging_in'> | ApiError<'invalid_account_id'>;
-    Success: {
-        user: WebUser;
+        data: {
+            uuid: string;
+            verified: boolean;
+        };
     };
 }>;
 export type ValidateEmailAndLogin = Endpoint<{
@@ -36,7 +25,7 @@ export type ValidateEmailAndLogin = Endpoint<{
     };
     Error: ApiError<'error_logging_in'> | ApiError<'error_validating_user'> | ApiError<'token_expired'> | ApiError<'error_refreshing_token'>;
     Success: {
-        user: WebUser;
+        user: ApiUser;
     };
 }>;
 export type ResendVerificationEmailByUuid = Endpoint<{
@@ -86,7 +75,7 @@ export type GetEmailByExpiredToken = Endpoint<{
         uuid: string;
     };
 }>;
-export type Signin = Endpoint<{
+export type PostSignin = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/account/signin';
     Body: {
@@ -95,7 +84,7 @@ export type Signin = Endpoint<{
     };
     Error: ApiError<'email_not_verified'> | ApiError<'unauthorized'>;
     Success: {
-        user: WebUser;
+        user: ApiUser;
     };
 }>;
 export type PostForgotPassword = Endpoint<{
@@ -121,3 +110,30 @@ export type PutResetPassword = Endpoint<{
         success: true;
     };
 }>;
+export type PostManagedSignup = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/account/managed/signup';
+    Body: {
+        provider: 'GoogleOAuth';
+        token?: string | undefined;
+    };
+    Success: {
+        data: {
+            url: string;
+        };
+    };
+}>;
+export type GetManagedCallback = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/login/callback';
+    Querystring: {
+        code: string;
+        state?: string | undefined;
+    };
+    Error: ApiError<'error_creating_user'> | ApiError<'user_already_exists'> | ApiError<'error_creating_account'>;
+    Success: {
+        data: {
+            url: string;
+        };
+    };
+}>;

package/dist/api.endpoints.d.ts

@@ -1,12 +1,13 @@
 import type { EndpointMethod } from './api';
-import type { GetOperation, SearchFilters, SearchMessages, SearchOperations } from './logs/api';
+import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api';
 import type { GetOnboardingStatus } from './onboarding/api';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata';
 import type { PostDeploy, PostDeployConfirmation } from './deploy/api';
 import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api';
-import type { PostForgotPassword, PutResetPassword, Signin, Signup } from './account/api';
+import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup } from './account/api';
 import type { DeleteInvite, PostInvite } from './invitations/api';
-export type APIEndpoints = Signup | Signin | GetTeam | PutTeam | PostInvite | DeleteInvite | DeleteTeamUser | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation;
+import type { GetUser, PatchUser } from './user/api';
+export type APIEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation;
 /**
  * Automatically narrow endpoints type with Method + Path
  */

package/dist/auth/api.d.ts

@@ -10,6 +10,7 @@ export interface AuthModes {
     App: 'APP';
     None: 'NONE';
     TBA: 'TBA';
+    Tableau: 'TABLEAU';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
 export interface AuthOperation {
@@ -104,10 +105,18 @@ export interface TbaCredentials {
         client_secret?: string;
     };
 }
+export interface TableauCredentials extends CredentialsCommon {
+    type: AuthModes['Tableau'];
+    pat_name: string;
+    pat_secret: string;
+    content_url?: string;
+    token?: string;
+    expires_at?: Date | undefined;
+}
 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;
-export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials;
+export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials;

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

@@ -22,3 +22,24 @@ export type TbaAuthorization = Endpoint<{
         connectionId: string;
     };
 }>;
+export type TableauAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: {
+        pat_name: string;
+        pat_secret: string;
+        content_url?: string;
+    };
+    QueryParams: {
+        connectionId: string;
+        connectionConfig: ConnectionConfig;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/auth/tableau';
+    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Success: {
+        providerConfigKey: string;
+        connectionId: string;
+    };
+}>;

package/dist/index.d.ts

@@ -8,8 +8,10 @@ export type * from './logs/api.js';
 export type * from './logs/messages.js';
 export type * from './account/api.js';
 export type * from './user/api.js';
+export type * from './user/db.js';
 export type * from './connection/api/metadata.js';
 export type * from './connection/db.js';
+export type * from './meta/api.js';
 export type * from './invitations/api.js';
 export type * from './invitations/db.js';
 export type * from './team/api.js';
@@ -33,3 +35,4 @@ export type * from './environment/api/webhook.js';
 export type * from './webhooks/api.js';
 export type * from './flow/http.api.js';
 export type * from './utils.js';
+export type * from './web/env.js';

package/dist/invitations/api.d.ts

@@ -1,4 +1,6 @@
 import type { Endpoint } from '../api';
+import type { ApiInvitation, ApiTeam } from '../team/api';
+import type { ApiUser } from '../user/api';
 export type PostInvite = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/invite';
@@ -29,3 +31,42 @@ export type DeleteInvite = Endpoint<{
         };
     };
 }>;
+export type GetInvite = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/invite/:id';
+    Params: {
+        id: string;
+    };
+    Success: {
+        data: {
+            invitedBy: ApiUser;
+            invitation: ApiInvitation;
+            newTeam: ApiTeam;
+            newTeamUsers: number;
+        };
+    };
+}>;
+export type AcceptInvite = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/invite/:id';
+    Params: {
+        id: string;
+    };
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;
+export type DeclineInvite = Endpoint<{
+    Method: 'DELETE';
+    Path: '/api/v1/invite/:id';
+    Params: {
+        id: string;
+    };
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;

package/dist/logs/api.d.ts

@@ -92,4 +92,25 @@ export type SearchFilters = Endpoint<{
     };
 }>;
 export type SearchFiltersData = SearchMessages['Success']['data'][0];
+export type PostInsights = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/logs/insights';
+    Querystring: {
+        env: string;
+    };
+    Body: {
+        type: 'action' | 'sync' | 'proxy' | 'webhook_external';
+    };
+    Success: {
+        data: {
+            histogram: InsightsHistogramEntry[];
+        };
+    };
+}>;
+export interface InsightsHistogramEntry {
+    key: string;
+    total: number;
+    success: number;
+    failure: number;
+}
 export {};

package/dist/meta/api.d.ts

@@ -0,0 +1,19 @@
+import type { ApiError, Endpoint } from '../api';
+import type { DBEnvironment } from '../environment/db';
+export type GetMeta = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/meta';
+    Querystring: {
+        env: string;
+    };
+    Error: ApiError<'user_not_found'>;
+    Success: {
+        data: {
+            environments: Pick<DBEnvironment, 'name'>[];
+            version: string;
+            baseUrl: string;
+            debugMode: boolean;
+            onboardingComplete: boolean;
+        };
+    };
+}>;

package/dist/team/api.d.ts

@@ -1,7 +1,7 @@
 import type { Merge } from 'type-fest';
 import type { ApiError, ApiTimestamps, Endpoint } from '../api';
 import type { DBInvitation } from '../invitations/db';
-import type { WebUser } from '../user/api';
+import type { ApiUser } from '../user/api';
 import type { DBTeam } from './db';
 export type GetTeam = Endpoint<{
     Method: 'GET';
@@ -12,7 +12,7 @@ export type GetTeam = Endpoint<{
     Success: {
         data: {
             account: ApiTeam;
-            users: WebUser[];
+            users: ApiUser[];
             invitedUsers: ApiInvitation[];
             isAdminTeam: boolean;
         };
@@ -30,7 +30,7 @@ export type PutTeam = Endpoint<{
         name: string;
     };
     Success: {
-        data: DBTeam;
+        data: ApiTeam;
     };
 }>;
 export type DeleteTeamUser = Endpoint<{
@@ -42,7 +42,7 @@ export type DeleteTeamUser = Endpoint<{
     Params: {
         id: number;
     };
-    Error: ApiError<'user_not_found'>;
+    Error: ApiError<'user_not_found'> | ApiError<'forbidden_self_delete'>;
     Success: {
         data: {
             success: true;

package/dist/user/api.d.ts

@@ -1,23 +1,24 @@
-import type { Timestamps } from '../db';
-export interface WebUser {
+import type { Endpoint } from '../api';
+export type GetUser = Endpoint<{
+    Method: 'GET';
+    Path: `/api/v1/user`;
+    Success: {
+        data: ApiUser;
+    };
+}>;
+export type PatchUser = Endpoint<{
+    Method: 'PATCH';
+    Path: `/api/v1/user`;
+    Body: {
+        name: string;
+    };
+    Success: {
+        data: ApiUser;
+    };
+}>;
+export interface ApiUser {
     id: number;
     accountId: number;
     email: string;
     name: string;
 }
-export interface DBUser extends Timestamps {
-    id: number;
-    email: string;
-    name: string;
-    hashed_password: string;
-    salt: string;
-    account_id: number;
-    reset_password_token: string | undefined;
-    suspended: boolean;
-    suspended_at: Date;
-    currentUser?: boolean;
-    email_verified: boolean;
-    email_verification_token: string | null;
-    email_verification_token_expires_at: Date | null;
-    uuid: string;
-}

package/dist/user/db.d.ts

@@ -0,0 +1,16 @@
+import type { Timestamps } from '../db';
+export interface DBUser extends Timestamps {
+    id: number;
+    email: string;
+    name: string;
+    hashed_password: string;
+    salt: string;
+    account_id: number;
+    reset_password_token: string | undefined;
+    suspended: boolean;
+    suspended_at: Date;
+    email_verified: boolean;
+    email_verification_token: string | null;
+    email_verification_token_expires_at: Date | null;
+    uuid: string;
+}

package/dist/web/env.d.ts

@@ -0,0 +1,15 @@
+export interface WindowEnv {
+    apiUrl: string;
+    publicUrl: string;
+    publicSentryKey: string;
+    publicPosthogKey: string;
+    publicPosthogPost: string;
+    isCloud: boolean;
+    features: {
+        logs: boolean;
+        scripts: boolean;
+        auth: boolean;
+        managedAuth: boolean;
+        interactiveDemo: boolean;
+    };
+}

package/package.json

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