@nangohq/types 0.58.5 → 0.58.7

package/dist/api.endpoints.d.ts

@@ -5,11 +5,11 @@ import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, Post
 import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PostConnectionRefresh } from './connection/api/get';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata';
 import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api';
-import type { PatchEnvironment, PostEnvironment } from './environment/api';
+import type { DeleteEnvironment, PatchEnvironment, PostEnvironment } from './environment/api';
 import type { PatchWebhook } from './environment/api/webhook';
 import type { PostEnvironmentVariables } from './environment/variable/api';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
-import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy, PatchIntegration, PostIntegration } from './integration/api';
+import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetIntegrationFlows, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy, PatchIntegration, PatchPublicIntegration, PostIntegration, PostPublicIntegration } from './integration/api';
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api';
 import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api';
 import type { GetMeta } from './meta/api';
@@ -18,12 +18,12 @@ import type { PostPlanExtendTrial } from './plans/http.api';
 import type { GetPublicProvider, GetPublicProviders } from './providers/api';
 import type { GetPublicRecords } from './record/api';
 import type { GetPublicScriptsConfig } from './scripts/http.api';
-import type { PostPublicTrigger } from './sync/api';
+import type { PostPublicTrigger, PutPublicSyncConnectionFrequency } from './sync/api';
 import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api';
 import type { GetUser, PatchUser } from './user/api';
 import type { PostPublicWebhook } from './webhooks/http.api';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | 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 | GetPublicRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry;
-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 | PatchWebhook | PostEnvironmentVariables;
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | 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 | GetPublicRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PatchPublicIntegration;
+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;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/billing/types.d.ts

@@ -0,0 +1,35 @@
+import type { Result } from '../result';
+export interface BillingClient {
+    ingest: (events: BillingIngestEvent[]) => Promise<void>;
+    getCustomer: (accountId: number) => Promise<Result<BillingCustomer>>;
+    getSubscription: (accountId: number) => Promise<Result<BillingSubscription | null>>;
+    getUsage: (subscriptionId: string, period?: 'previous') => Promise<Result<BillingUsageMetric[]>>;
+}
+export interface BillingCustomer {
+    id: string;
+    portalUrl: string | null;
+}
+export interface BillingSubscription {
+    id: string;
+}
+export interface BillingUsageMetric {
+    id: string;
+    name: string;
+    quantity: number;
+}
+export interface BillingIngestEvent {
+    type: 'monthly_active_records' | 'billable_connections' | 'billable_actions';
+    idempotencyKey: string;
+    accountId: number;
+    timestamp: Date;
+    properties: Record<string, string | number>;
+}
+export interface BillingMetric {
+    type: BillingIngestEvent['type'];
+    value: number;
+    properties: {
+        accountId: number;
+        timestamp?: Date | undefined;
+        idempotencyKey?: string | undefined;
+    };
+}

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

@@ -53,3 +53,9 @@ export type PatchEnvironment = Endpoint<{
     };
     Error: ApiError<'conflict'>;
 }>;
+export type DeleteEnvironment = Endpoint<{
+    Method: 'DELETE';
+    Path: '/api/v1/environments';
+    Success: never;
+    Error: ApiError<'cannot_delete_prod_environment'>;
+}>;

package/dist/index.d.ts

@@ -19,8 +19,10 @@ 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 './billing/types.js';
 export type * from './providers/api.js';
 export type * from './proxy/api.js';
+export type * from './result.js';
 export type * from './scripts/on-events/db.js';
 export type * from './scripts/on-events/api.js';
 export type * from './scripts/syncs/api.js';

package/dist/integration/api.d.ts

@@ -4,9 +4,8 @@ import type { AuthModeType, AuthModes } from '../auth/api';
 import type { NangoSyncConfig } from '../flow';
 import type { Provider } from '../providers/provider';
 import type { Merge } from 'type-fest';
-export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider'>, ApiTimestamps> & {
+export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider' | 'display_name'>, ApiTimestamps> & {
     logo: string;
-    display_name: string;
 } & ApiPublicIntegrationInclude;
 export interface ApiPublicIntegrationInclude {
     webhook_url?: string | null;
@@ -39,6 +38,19 @@ export type GetPublicListIntegrations = Endpoint<{
         data: ApiPublicIntegration[];
     };
 }>;
+export type PostPublicIntegration = Endpoint<{
+    Method: 'POST';
+    Path: '/integrations';
+    Body: {
+        provider: string;
+        unique_key: string;
+        display_name?: string | undefined;
+        credentials?: ApiPublicIntegrationCredentials | undefined;
+    };
+    Success: {
+        data: ApiPublicIntegration;
+    };
+}>;
 export type GetPublicIntegration = Endpoint<{
     Method: 'GET';
     Path: '/integrations/:uniqueKey';
@@ -52,7 +64,32 @@ export type GetPublicIntegration = Endpoint<{
         data: ApiPublicIntegration;
     };
 }>;
+export type PatchPublicIntegration = Endpoint<{
+    Method: 'PATCH';
+    Path: '/integrations/:uniqueKey';
+    Params: {
+        uniqueKey: string;
+    };
+    Body: {
+        unique_key?: string | undefined;
+        display_name?: string | undefined;
+        credentials?: ApiPublicIntegrationCredentials | undefined;
+    };
+    Success: {
+        data: ApiPublicIntegration;
+    };
+}>;
 export type DeletePublicIntegration = Endpoint<{
+    Method: 'DELETE';
+    Path: '/integrations/:uniqueKey';
+    Params: {
+        uniqueKey: string;
+    };
+    Success: {
+        success: true;
+    };
+}>;
+export type DeletePublicIntegrationDeprecated = Endpoint<{
     Method: 'DELETE';
     Path: '/config/:providerConfigKey';
     Params: {
@@ -72,6 +109,7 @@ export type ApiIntegrationList = ApiIntegration & {
         missingFieldsCount: number;
         connectionConfigParams?: string[];
         credentialParams?: string[];
+        displayName: string;
     };
 };
 export type GetIntegrations = Endpoint<{
@@ -127,6 +165,7 @@ export type PatchIntegration = Endpoint<{
     Body: {
         integrationId?: string | undefined;
         webhookSecret?: string | undefined;
+        displayName?: string | undefined;
     } | {
         authType: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
         clientId: string;
@@ -181,3 +220,21 @@ export type GetIntegrationFlows = Endpoint<{
         };
     };
 }>;
+export type ApiPublicIntegrationCredentials = {
+    type: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
+    client_id: string;
+    client_secret: string;
+    scopes?: string | undefined;
+} | {
+    type: Extract<AuthModeType, 'APP'>;
+    app_id: string;
+    app_link: string;
+    private_key: string;
+} | {
+    type: Extract<AuthModeType, 'CUSTOM'>;
+    client_id: string;
+    client_secret: string;
+    app_id: string;
+    app_link: string;
+    private_key: string;
+};

package/dist/integration/db.d.ts

@@ -1,6 +1,6 @@
-import type { SetOptional } from 'type-fest';
 import type { TimestampsAndDeleted } from '../db.js';
 import type { NullablePartial } from '../utils.js';
+import type { SetOptional, Tagged } from 'type-fest';
 export interface IntegrationConfig extends TimestampsAndDeleted {
     id?: number | undefined;
     unique_key: string;
@@ -14,5 +14,7 @@ export interface IntegrationConfig extends TimestampsAndDeleted {
     app_link?: string | null | undefined;
     custom?: Record<string, string> | undefined | null;
     missing_fields: string[];
+    display_name: string | null;
 }
+export type DBIntegrationCrypted = Tagged<IntegrationConfig, 'IntegrationCrypted'>;
 export type DBCreateIntegration = SetOptional<NullablePartial<Omit<IntegrationConfig, 'created_at' | 'updated_at'>>, 'missing_fields'>;

package/dist/logs/api.d.ts

@@ -5,7 +5,7 @@ type Concat<T extends OperationList> = T extends {
     action: string;
 } ? `${T['type']}:${T['action']}` : never;
 export type ConcatOperationList = Concat<OperationList>;
-export type ConcatOperationListWithGroup = OperationList[keyof OperationList] | ConcatOperationList;
+export type ConcatOperationListWithGroup = OperationList['type'] | ConcatOperationList;
 export type SearchOperations = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/logs/operations';
@@ -13,6 +13,7 @@ export type SearchOperations = Endpoint<{
         env: string;
     };
     Body: {
+        search?: string | undefined;
         limit?: number;
         states?: SearchOperationsState[];
         types?: SearchOperationsType[];

package/dist/logs/messages.d.ts

@@ -89,6 +89,7 @@ export interface MessageRow {
     message: string;
     context?: 'script' | 'proxy' | 'webhook' | 'auth' | undefined;
     parentId: string;
+    accountId: number;
     error?: MessageError | undefined;
     request?: MessageHTTPRequest | undefined;
     response?: MessageHTTPResponse | undefined;
@@ -99,6 +100,8 @@ export interface MessageRow {
         addedKeys: string[];
         updated: number;
         updatedKeys: string[];
+        unchanged: number;
+        unchangedKeys: string[];
         deleted: number;
         deleteKeys: string[];
     } | undefined;

package/dist/persist/api.d.ts

@@ -3,7 +3,7 @@ import type { MessageRowInsert } from '../logs/messages.js';
 import type { MergingStrategy, NangoRecord } from '../record/api.js';
 interface LogBody {
     activityLogId: string;
-    log: MessageRowInsert;
+    log: Omit<MessageRowInsert, 'accountId'>;
 }
 export type PostLog = Endpoint<{
     Method: 'POST';

package/dist/plans/db.d.ts

@@ -14,6 +14,12 @@ export interface DBPlan extends Timestamps {
      * @default 3
      */
     connection_with_scripts_max: number | null;
+    /**
+     * Limit the number of total non-deleted connections
+     * Set to null to remove limit
+     * @default null
+     */
+    connections_max: number | null;
     /**
      * Limit the number of environments that can be created
      * @default 2

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

@@ -1,10 +1,11 @@
+import type { BillingCustomer, BillingUsageMetric } from '../billing/types';
 import type { ReplaceInObject } from '../utils';
 import type { DBPlan } from './db.js';
 import type { Endpoint } from '../api';
 export type ApiPlan = ReplaceInObject<DBPlan, Date, string>;
 export type PostPlanExtendTrial = Endpoint<{
     Method: 'POST';
-    Path: '/api/v1/plan/trial/extension';
+    Path: '/api/v1/plans/trial/extension';
     Querystring: {
         env: string;
     };
@@ -14,3 +15,37 @@ export type PostPlanExtendTrial = Endpoint<{
         };
     };
 }>;
+export interface PlanDefinition {
+    code: string;
+    title: string;
+    description: string;
+    canUpgrade: boolean;
+    canDowngrade: false;
+    cta?: string;
+    hidden?: boolean;
+    flags: Omit<Partial<DBPlan>, 'id' | 'account_id'>;
+}
+export type GetPlans = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/plans';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: PlanDefinition[];
+    };
+}>;
+export type GetUsage = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/plans/usage';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: {
+            customer: BillingCustomer;
+            current: BillingUsageMetric[];
+            previous: BillingUsageMetric[];
+        };
+    };
+}>;

package/dist/providers/provider.d.ts

@@ -1,6 +1,6 @@
-import type { RetryHeaderConfig, CursorPagination, LinkPagination, OffsetPagination } from '../proxy/api.js';
-import type { AuthModeType, OAuthAuthorizationMethodType, OAuthBodyFormatType } from '../auth/api.js';
 import type { EndpointMethod } from '../api.js';
+import type { AuthModeType, OAuthAuthorizationMethodType, OAuthBodyFormatType } from '../auth/api.js';
+import type { CursorPagination, LinkPagination, OffsetPagination, RetryHeaderConfig } from '../proxy/api.js';
 export interface TokenUrlObject {
     OAUTH1?: string;
     OAUTH2?: string;
@@ -84,7 +84,7 @@ export interface BaseProvider {
     body_format?: OAuthBodyFormatType;
 }
 export interface ProviderOAuth2 extends BaseProvider {
-    auth_mode: 'OAUTH2' | 'CUSTOM';
+    auth_mode: 'OAUTH2';
     disable_pkce?: boolean;
     token_params?: {
         grant_type?: 'authorization_code' | 'client_credentials';
@@ -93,6 +93,7 @@ export interface ProviderOAuth2 extends BaseProvider {
         grant_type: 'refresh_token';
     };
     authorization_method?: OAuthAuthorizationMethodType;
+    alternate_access_token_response_path?: string;
     refresh_url?: string;
     expires_in_unit?: 'milliseconds';
     token_request_auth_method?: 'basic' | 'custom';
@@ -105,6 +106,13 @@ export interface ProviderOAuth1 extends BaseProvider {
     token_http_method?: 'GET' | 'PUT' | 'POST';
     signature_method: 'HMAC-SHA1' | 'RSA-SHA1' | 'PLAINTEXT';
 }
+export interface ProviderCustom extends Omit<ProviderOAuth2, 'auth_mode'> {
+    auth_mode: 'CUSTOM';
+    token_url: {
+        OAUTH2: string;
+        APP: string;
+    };
+}
 export interface ProviderJwt extends BaseProvider {
     auth_mode: 'JWT';
     signature: {
@@ -124,8 +132,23 @@ export interface ProviderJwt extends BaseProvider {
         };
     };
 }
+export interface ProviderAppleAppStore extends BaseProvider {
+    auth_mode: 'APP_STORE';
+    token_url: string;
+}
+export interface ProviderTableau extends BaseProvider {
+    auth_mode: 'TABLEAU';
+}
+export interface ProviderBill extends BaseProvider {
+    auth_mode: 'BILL';
+}
+export interface ProviderGithubApp extends BaseProvider {
+    auth_mode: 'APP';
+    token_url: string;
+}
 export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
     auth_mode: 'TWO_STEP';
+    token_request_method?: 'GET';
     token_headers?: Record<string, string>;
     token_response: {
         token: string;
@@ -137,6 +160,7 @@ export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
         token_params?: Record<string, string>;
         token_headers?: Record<string, string>;
         token_url: string;
+        token_request_method?: 'GET';
     }[];
     token_expires_in_ms?: number;
     proxy_header_authorization?: string;
@@ -154,6 +178,6 @@ export interface ProviderSignature extends BaseProvider {
 export interface ProviderApiKey extends BaseProvider {
     auth_mode: 'API_KEY';
 }
-export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature | ProviderApiKey;
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature | ProviderApiKey | ProviderTableau | ProviderBill | ProviderGithubApp | ProviderAppleAppStore | ProviderCustom;
 export type RefreshableProvider = ProviderTwoStep | ProviderJwt | ProviderSignature | ProviderOAuth2;
 export type TestableProvider = ProviderApiKey;

package/dist/result.d.ts

@@ -0,0 +1,17 @@
+export interface Left<T, E extends Error> {
+    error: E;
+    isErr(this: Result<T, E>): this is Left<T, E>;
+    isOk(this: Result<T, E>): this is Right<T, E>;
+    unwrap(): T;
+    map<U>(fn: (value: T) => U): Result<T, E>;
+    mapError<U extends Error>(fn: (error: E) => U): Result<T, U>;
+}
+export interface Right<T, E extends Error> {
+    value: T;
+    isErr(this: Result<T, E>): this is Left<T, E>;
+    isOk(this: Result<T, E>): this is Right<T, E>;
+    unwrap(): T;
+    map<U>(fn: (value: T) => U): Result<U, E>;
+    mapError<U extends Error>(fn: (error: E) => U): Result<T, U>;
+}
+export type Result<T, E extends Error = Error> = Left<T, E> | Right<T, E>;

package/dist/sync/api.d.ts

@@ -55,3 +55,18 @@ export type DeleteSyncVariant = Endpoint<{
         success: boolean;
     };
 }>;
+export type PutPublicSyncConnectionFrequency = Endpoint<{
+    Method: 'PUT';
+    Path: '/sync/update-connection-frequency';
+    Body: {
+        sync_name: string;
+        sync_variant?: string | undefined;
+        provider_config_key: string;
+        connection_id: string;
+        frequency: string | null;
+    };
+    Success: {
+        frequency: string;
+    };
+    Error: ApiError<'unknown_connection' | 'unknown_sync'>;
+}>;

package/dist/web/env.d.ts

@@ -17,5 +17,6 @@ export interface WindowEnv {
         managedAuth: boolean;
         gettingStarted: boolean;
         slack: boolean;
+        plan: boolean;
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.58.5",
+    "version": "0.58.7",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -12,9 +12,9 @@
         "directory": "packages/utils"
     },
     "dependencies": {
-        "axios": "^1.8.4",
+        "axios": "1.9.0",
         "json-schema": "0.4.0",
-        "type-fest": "4.32.0"
+        "type-fest": "4.40.0"
     },
     "devDependencies": {
         "@types/json-schema": "7.0.15"