@nangohq/types 0.41.0 → 0.42.0

package/dist/account/api.d.ts

@@ -98,3 +98,26 @@ export type Signin = Endpoint<{
         user: WebUser;
     };
 }>;
+export type PostForgotPassword = Endpoint<{
+    Method: 'PUT';
+    Path: '/api/v1/account/forgot-password';
+    Body: {
+        email: string;
+    };
+    Error: ApiError<'user_not_found'>;
+    Success: {
+        success: true;
+    };
+}>;
+export type PutResetPassword = Endpoint<{
+    Method: 'PUT';
+    Path: '/api/v1/account/reset-password';
+    Body: {
+        token: string;
+        password: string;
+    };
+    Error: ApiError<'user_not_found'> | ApiError<'invalid_token'>;
+    Success: {
+        success: true;
+    };
+}>;

package/dist/api.d.ts

@@ -61,3 +61,7 @@ export interface ErrorPayload {
     type: string;
     description: string;
 }
+export interface ApiTimestamps {
+    created_at: string;
+    updated_at: string;
+}

package/dist/api.endpoints.d.ts

@@ -3,7 +3,10 @@ import type { GetOperation, SearchFilters, SearchMessages, SearchOperations } fr
 import type { GetOnboardingStatus } from './onboarding/api';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata';
 import type { PostDeploy, PostDeployConfirmation } from './deploy/api';
-export type APIEndpoints = SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation;
+import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api';
+import type { PostForgotPassword, PutResetPassword, Signin, Signup } 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;
 /**
  * Automatically narrow endpoints type with Method + Path
  */

package/dist/connection/db.d.ts

@@ -1,7 +1,7 @@
 import type { TimestampsAndDeleted } from '../db.js';
 import type { ApiKeyCredentials, BasicApiCredentials, AuthModeType, AuthOperationType, AllAuthCredentials } from '../auth/api.js';
-import type { Environment } from '../environment/db.js';
-import type { Account } from '../account/db.js';
+import type { DBEnvironment } from '../environment/db.js';
+import type { DBTeam } from '../team/db.js';
 export type Metadata = Record<string, unknown>;
 export type ConnectionConfig = Record<string, any>;
 export interface BaseConnection extends TimestampsAndDeleted {
@@ -26,8 +26,8 @@ export type RecentlyCreatedConnection = Pick<StoredConnection, 'id' | 'connectio
     auth_mode: AuthModeType;
     error?: string;
     operation: AuthOperationType;
-    environment: Environment;
-    account: Account;
+    environment: DBEnvironment;
+    account: DBTeam;
 };
 export interface ApiConnection {
     id?: number;

package/dist/db.d.ts

@@ -1,6 +1,6 @@
 export interface Timestamps {
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }
 export interface Deleted {
     deleted_at?: Date | null;

package/dist/deploy/api.d.ts

@@ -47,4 +47,5 @@ export interface SyncAndActionDifferences {
     deletedSyncs: SlimSync[];
     newActions: SlimAction[];
     deletedActions: SlimAction[];
+    deletedModels: string[];
 }

package/dist/deploy/incomingFlow.d.ts

@@ -52,4 +52,11 @@ export interface IncomingFlowConfig extends InternalIncomingPreBuiltFlowConfig {
     sync_type?: SyncTypeLiteral | undefined;
     webhookSubscriptions?: string[] | undefined;
 }
+export interface IncomingFlowConfigUpgrade extends IncomingFlowConfig {
+    id: string;
+    upgrade_version: string;
+    last_deployed: string;
+    is_public: true;
+    pre_built: true;
+}
 export {};

package/dist/environment/db.d.ts

@@ -1,5 +1,5 @@
 import type { Timestamps } from '../db';
-export interface EnvironmentVariable extends Timestamps {
+export interface DBEnvironmentVariable extends Timestamps {
     id?: number;
     name: string;
     value: string;
@@ -7,7 +7,7 @@ export interface EnvironmentVariable extends Timestamps {
     value_iv?: string | null;
     value_tag?: string | null;
 }
-export interface Environment extends Timestamps {
+export interface DBEnvironment extends Timestamps {
     id: number;
     uuid: string;
     name: string;
@@ -28,7 +28,7 @@ export interface Environment extends Timestamps {
     hmac_digest?: string | null;
     secret_key_rotatable?: boolean;
     public_key_rotatable?: boolean;
-    pending_secret_key?: string | null;
+    pending_secret_key: string | null;
     pending_secret_key_iv?: string | null;
     pending_secret_key_tag?: string | null;
     pending_public_key?: string | null;

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

@@ -0,0 +1,11 @@
+import type { ApiError, Endpoint } from '../api';
+import type { IncomingFlowConfigUpgrade } from '../deploy/incomingFlow';
+export type UpgradePreBuiltFlow = Endpoint<{
+    Method: 'PUT';
+    Path: '/api/v1/flow/upgrade/pre-built';
+    Body: IncomingFlowConfigUpgrade;
+    Error: ApiError<'upgrade_failed'>;
+    Success: {
+        success: true;
+    };
+}>;

package/dist/index.d.ts

@@ -7,10 +7,13 @@ 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 './invitations/api.js';
+export type * from './invitations/db.js';
+export type * from './team/api.js';
+export type * from './team/db.js';
 export type * from './proxy/api.js';
 export type * from './environment/db.js';
 export type * from './scripts/post-connection/db.js';
@@ -28,4 +31,5 @@ export type * from './nangoYaml/index.js';
 export type * from './environment/db.js';
 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';

package/dist/integration/template.d.ts

@@ -60,7 +60,7 @@ export interface TemplateOAuth2 extends Template {
     authorization_method?: OAuthAuthorizationMethodType;
     body_format?: OAuthBodyFormatType;
     refresh_url?: string;
-    token_request_auth_method?: 'basic';
+    token_request_auth_method?: 'basic' | 'custom';
 }
 export interface TemplateOAuth1 extends Template {
     auth_mode: 'OAUTH1';

package/dist/invitations/api.d.ts

@@ -0,0 +1,31 @@
+import type { Endpoint } from '../api';
+export type PostInvite = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/invite';
+    Querystring: {
+        env: string;
+    };
+    Body: {
+        emails: string[];
+    };
+    Success: {
+        data: {
+            invited: string[];
+        };
+    };
+}>;
+export type DeleteInvite = Endpoint<{
+    Method: 'DELETE';
+    Path: '/api/v1/invite';
+    Querystring: {
+        env: string;
+    };
+    Body: {
+        email: string;
+    };
+    Success: {
+        data: {
+            success: boolean;
+        };
+    };
+}>;

package/dist/invitations/db.d.ts

@@ -0,0 +1,11 @@
+import type { Timestamps } from '../db';
+export interface DBInvitation extends Timestamps {
+    id: number;
+    name: string;
+    email: string;
+    account_id: number;
+    invited_by: number;
+    token: string;
+    expires_at: Date;
+    accepted: boolean;
+}

package/dist/nangoYaml/index.d.ts

@@ -13,6 +13,7 @@ export interface NangoYamlV1Integration {
     runs?: string;
     track_deletes?: boolean;
     auto_start?: boolean;
+    version?: string;
 }
 export interface NangoYamlV2 {
     integrations: Record<string, NangoYamlV2Integration>;
@@ -35,6 +36,7 @@ export interface NangoYamlV2IntegrationSync {
     scopes?: string | string[];
     input?: string;
     'webhook-subscriptions'?: string | string[];
+    version?: string;
 }
 export interface NangoYamlV2IntegrationAction {
     endpoint: string;
@@ -42,6 +44,7 @@ export interface NangoYamlV2IntegrationAction {
     description?: string;
     scopes?: string | string[];
     input?: string;
+    version?: string;
 }
 export interface NangoYamlModel {
     [key: string]: NangoYamlModelFields;
@@ -76,6 +79,7 @@ export interface ParsedNangoSync {
     output: string[] | null;
     usedModels: string[];
     webhookSubscriptions: string[];
+    version: string;
 }
 export interface ParsedNangoAction {
     name: string;
@@ -86,6 +90,7 @@ export interface ParsedNangoAction {
     endpoint: NangoSyncEndpoint | null;
     scopes: string[];
     usedModels: string[];
+    version: string;
 }
 export type LayoutMode = 'root' | 'nested';
 export interface NangoModel {

package/dist/team/api.d.ts

@@ -0,0 +1,51 @@
+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 { DBTeam } from './db';
+export type GetTeam = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/team';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: {
+            account: ApiTeam;
+            users: WebUser[];
+            invitedUsers: ApiInvitation[];
+            isAdminTeam: boolean;
+        };
+    };
+}>;
+export type ApiInvitation = Merge<Omit<DBInvitation, 'token'>, ApiTimestamps>;
+export type ApiTeam = Merge<DBTeam, ApiTimestamps>;
+export type PutTeam = Endpoint<{
+    Method: 'PUT';
+    Path: '/api/v1/team';
+    Querystring: {
+        env: string;
+    };
+    Body: {
+        name: string;
+    };
+    Success: {
+        data: DBTeam;
+    };
+}>;
+export type DeleteTeamUser = Endpoint<{
+    Method: 'DELETE';
+    Path: '/api/v1/team/users/:id';
+    Querystring: {
+        env: string;
+    };
+    Params: {
+        id: number;
+    };
+    Error: ApiError<'user_not_found'>;
+    Success: {
+        data: {
+            success: true;
+        };
+    };
+}>;

package/dist/team/db.d.ts

@@ -0,0 +1,7 @@
+import type { Timestamps } from '../db';
+export interface DBTeam extends Timestamps {
+    id: number;
+    name: string;
+    uuid: string;
+    is_capped: boolean;
+}

package/dist/user/api.d.ts

@@ -1,6 +1,23 @@
+import type { Timestamps } from '../db';
 export interface WebUser {
     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/package.json

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

package/dist/account/db.d.ts

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