@nangohq/types 0.58.4 → 0.58.6

package/dist/api.endpoints.d.ts

@@ -5,7 +5,7 @@ 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';
@@ -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;
+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/auth/api.d.ts

@@ -131,12 +131,7 @@ export interface TableauCredentials extends CredentialsCommon {
 }
 export interface JwtCredentials {
     type: AuthModes['Jwt'];
-    privateKeyId?: string;
-    issuerId?: string;
-    privateKey: {
-        id: string;
-        secret: string;
-    } | string;
+    [key: string]: any;
     token?: string;
     expires_at?: Date | undefined;
 }

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

@@ -90,14 +90,7 @@ export type PostPublicTableauAuthorization = Endpoint<{
 }>;
 export type PostPublicJwtAuthorization = Endpoint<{
     Method: 'POST';
-    Body: {
-        privateKeyId?: string;
-        issuerId?: string;
-        privateKey: {
-            id: string;
-            secret: string;
-        } | string;
-    };
+    Body: Record<string, any>;
     Querystring: ConnectionQueryString;
     Params: {
         providerConfigKey: string;

package/dist/deploy/incomingFlow.d.ts

@@ -44,6 +44,7 @@ export interface PreBuiltFlowConfig {
     fileBody?: IncomingScriptFiles;
     endpoints: NangoSyncEndpointV2[];
     input?: NangoModel | LegacySyncModelSchema | undefined;
+    version?: string | null;
 }
 export interface CLIDeployFlowConfig {
     type: ScriptTypeLiteral;

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/environment/db.d.ts

@@ -1,4 +1,4 @@
-import type { Timestamps } from '../db';
+import type { Timestamps, TimestampsAndDeletedCorrect } from '../db';
 export interface DBEnvironmentVariable extends Timestamps {
     id: number;
     name: string;
@@ -7,7 +7,7 @@ export interface DBEnvironmentVariable extends Timestamps {
     value_iv: string | null;
     value_tag: string | null;
 }
-export interface DBEnvironment extends Timestamps {
+export interface DBEnvironment extends TimestampsAndDeletedCorrect {
     id: number;
     uuid: string;
     name: string;

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;
@@ -72,6 +71,7 @@ export type ApiIntegrationList = ApiIntegration & {
         missingFieldsCount: number;
         connectionConfigParams?: string[];
         credentialParams?: string[];
+        displayName: string;
     };
 };
 export type GetIntegrations = Endpoint<{
@@ -127,6 +127,7 @@ export type PatchIntegration = Endpoint<{
     Body: {
         integrationId?: string | undefined;
         webhookSecret?: string | undefined;
+        displayName?: string | undefined;
     } | {
         authType: Extract<AuthModeType, 'OAUTH1' | 'OAUTH2' | 'TBA'>;
         clientId: 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 } from 'type-fest';
 export interface IntegrationConfig extends TimestampsAndDeleted {
     id?: number | undefined;
     unique_key: string;
@@ -14,5 +14,6 @@ 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 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';

package/dist/logs/messages.d.ts

@@ -89,10 +89,22 @@ export interface MessageRow {
     message: string;
     context?: 'script' | 'proxy' | 'webhook' | 'auth' | undefined;
     parentId: string;
+    accountId: number;
     error?: MessageError | undefined;
     request?: MessageHTTPRequest | undefined;
     response?: MessageHTTPResponse | undefined;
     meta?: MessageMeta | null | undefined;
+    persistResults?: {
+        model: string;
+        added: number;
+        addedKeys: string[];
+        updated: number;
+        updatedKeys: string[];
+        unchanged: number;
+        unchangedKeys: string[];
+        deleted: number;
+        deleteKeys: string[];
+    } | undefined;
     retry?: MessageHTTPRetry | undefined;
     createdAt: string;
     endedAt?: 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
@@ -35,4 +41,9 @@ export interface DBPlan extends Timestamps {
      * @default false
      */
     has_otel: boolean;
+    /**
+     * Change the applied rate limit for the public API
+     * @default "m"
+     */
+    api_rate_limit_size: 's' | 'm' | 'l' | 'xl' | '2xl' | '3xl' | '4xl';
 }

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

@@ -4,7 +4,7 @@ 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 +14,23 @@ 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[];
+    };
+}>;

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;
@@ -53,6 +53,7 @@ export interface BaseProvider {
             endpoints: string[];
             base_url_override?: string;
             headers?: Record<string, string>;
+            data?: unknown;
         };
     };
     authorization_url?: string;
@@ -106,18 +107,40 @@ export interface ProviderOAuth1 extends BaseProvider {
 }
 export interface ProviderJwt extends BaseProvider {
     auth_mode: 'JWT';
+    signature: {
+        protocol: 'RSA' | 'HMAC';
+    };
     token: {
+        signing_key: string;
         expires_in_ms: number;
-        headers: {
+        header: {
             alg: string;
+            typ?: string;
         };
         payload: {
-            aud: string;
+            aud?: string;
+            iss?: string;
+            sub?: string;
         };
     };
 }
+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;
@@ -129,6 +152,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;
@@ -146,6 +170,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;
 export type RefreshableProvider = ProviderTwoStep | ProviderJwt | ProviderSignature | ProviderOAuth2;
 export type TestableProvider = ProviderApiKey;

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.4",
+    "version": "0.58.6",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",