@nangohq/types 0.40.9 → 0.41.0

package/dist/auth/api.d.ts

@@ -43,17 +43,17 @@ export interface CredentialsCommon<T = Record<string, any>> {
     raw: T;
 }
 export interface BasicApiCredentials {
-    type?: AuthModes['Basic'];
+    type: AuthModes['Basic'];
     username: string;
     password: string;
 }
 export interface ApiKeyCredentials {
-    type?: AuthModes['ApiKey'];
+    type: AuthModes['ApiKey'];
     apiKey: string;
 }
 export type AuthCredentials = OAuth2Credentials | OAuth1Credentials | OAuth2ClientCredentials;
 export interface AppCredentials {
-    type?: AuthModes['App'];
+    type: AuthModes['App'];
     access_token: string;
     expires_at?: Date | undefined;
     raw: Record<string, any>;
@@ -110,3 +110,4 @@ export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'typ
     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;

package/dist/connection/db.d.ts

@@ -1,5 +1,5 @@
 import type { TimestampsAndDeleted } from '../db.js';
-import type { AuthCredentials, ApiKeyCredentials, BasicApiCredentials, AppCredentials, AppStoreCredentials, UnauthCredentials, CustomCredentials, TbaCredentials, AuthModeType, AuthOperationType } from '../auth/api.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';
 export type Metadata = Record<string, unknown>;
@@ -20,7 +20,7 @@ export interface StoredConnection extends BaseConnection {
     credentials: Record<string, any>;
 }
 export interface Connection extends BaseConnection {
-    credentials: AuthCredentials | ApiKeyCredentials | BasicApiCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials;
+    credentials: AllAuthCredentials;
 }
 export type RecentlyCreatedConnection = Pick<StoredConnection, 'id' | 'connection_id' | 'provider_config_key'> & {
     auth_mode: AuthModeType;

package/dist/webhooks/api.d.ts

@@ -2,8 +2,12 @@ import type { AuthOperationType, AuthModeType } from '../auth/api.js';
 import type { SyncResult, SyncType } from '../scripts/syncs/api.js';
 import type { ErrorPayload } from '../api.js';
 export type WebhookTypes = 'sync' | 'auth' | 'forward';
-export interface NangoSyncWebhookBody {
+export interface NangoWebhookBase {
     from: string;
+    type: WebhookTypes;
+}
+export type NangoWebhookBody = NangoSyncWebhookBody | NangoAuthWebhookBody;
+export interface NangoSyncWebhookBodyBase extends NangoWebhookBase {
     type: 'sync';
     connectionId: string;
     providerConfigKey: string;
@@ -11,20 +15,23 @@ export interface NangoSyncWebhookBody {
     model: string;
     syncType: SyncType;
 }
-export interface NangoSyncWebhookBodySuccess extends NangoSyncWebhookBody {
+export interface NangoSyncWebhookBodySuccess extends NangoSyncWebhookBodyBase {
+    success: true;
     modifiedAfter: string;
     responseResults: SyncResult;
-    success: true;
+    /**
+     * @deprecated legacy, use modifiedAfter instead
+     */
     queryTimeStamp: string | null;
 }
-export interface NangoSyncWebhookBodyError {
+export interface NangoSyncWebhookBodyError extends NangoSyncWebhookBodyBase {
     success: false;
     error: ErrorPayload;
     startedAt: string;
     failedAt: string;
 }
-export interface NangoAuthWebhookBody {
-    from: string;
+export type NangoSyncWebhookBody = NangoSyncWebhookBodySuccess | NangoSyncWebhookBodyError;
+export interface NangoAuthWebhookBodyBase extends NangoWebhookBase {
     type: 'auth';
     connectionId: string;
     authMode: AuthModeType;
@@ -33,16 +40,18 @@ export interface NangoAuthWebhookBody {
     environment: string;
     operation: AuthOperationType;
 }
-export interface NangoAuthWebhookBodySuccess extends NangoAuthWebhookBody {
+export interface NangoAuthWebhookBodySuccess extends NangoAuthWebhookBodyBase {
     success: true;
+    type: 'auth';
 }
-export interface NangoAuthWebhookBodyError extends NangoAuthWebhookBody {
+export interface NangoAuthWebhookBodyError extends NangoAuthWebhookBodyBase {
     success: false;
     error: ErrorPayload;
+    type: 'auth';
 }
-export interface NangoForwardWebhookBody {
-    from: string;
-    type: WebhookTypes;
+export type NangoAuthWebhookBody = NangoAuthWebhookBodySuccess | NangoAuthWebhookBodyError;
+export interface NangoForwardWebhookBody extends NangoWebhookBase {
+    type: 'forward';
     connectionId?: string;
     providerConfigKey: string;
     payload: unknown;

package/package.json

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