@nangohq/types 0.69.45 → 0.69.47

package/dist/action/api.d.ts

@@ -26,6 +26,7 @@ export type PostPublicTriggerAction = Endpoint<{
     };
     Success: any;
 }>;
+/** @deprecated Use POST /action/trigger to trigger actions and GET /records to fetch sync records instead. */
 export type GetPublicV1 = Endpoint<{
     Method: 'GET';
     Path: `/v1/:path`;

package/dist/api.endpoints.d.ts

@@ -24,11 +24,11 @@ import type { GetPublicRecords, PatchPublicPruneRecords } from './record/api.js'
 import type { GetPublicScriptsConfig } from './scripts/http.api.js';
 import type { GetSharedCredentialsProvider, GetSharedCredentialsProviders, PatchSharedCredentialsProvider, PostSharedCredentialsProvider } from './sharedCredentials/api.js';
 import type { GetPublicSyncStatus, PostPublicSyncPause, PostPublicSyncStart, PostPublicTrigger, PutPublicSyncConnectionFrequency } from './sync/api.js';
-import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api.js';
+import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api.js';
 import type { GetUser, PatchUser } from './user/api.js';
 import type { PostPublicWebhook } from './webhooks/http.api.js';
 export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/authz/types.d.ts

@@ -0,0 +1,12 @@
+import type { Role } from '../user/db.js';
+export type Action = 'create' | 'read' | 'update' | 'delete' | '*';
+export type Resource = 'team' | 'team_member' | 'invite' | 'connect_ui_settings' | 'billing' | 'plan' | 'environment' | 'environment_production_flag' | 'environment_key' | 'environment_variable' | 'webhook' | 'integration' | 'connection' | 'flow' | 'sync_command' | 'secret_key' | 'connection_credential' | 'log' | '*';
+export type Scope = 'production' | 'non-production' | 'global';
+export interface Permission {
+    action: Action;
+    resource: Resource;
+    scope: Scope;
+}
+export interface PermissionEvaluator {
+    evaluate(role: Role, permission: Permission): Promise<boolean>;
+}

package/dist/deploy/incomingFlow.d.ts

@@ -1,5 +1,6 @@
 import type { NangoSyncEndpointOld, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
 import type { OnEventType } from '../scripts/on-events/api.js';
+import type { Feature } from '../syncConfigs/db.js';
 import type { JSONSchema7 } from 'json-schema';
 import type { Merge } from 'type-fest';
 export interface IncomingScriptFiles {
@@ -82,6 +83,7 @@ export interface CLIDeployFlowConfig {
     sync_type?: SyncTypeLiteral | undefined;
     webhookSubscriptions?: string[] | undefined;
     models_json_schema?: JSONSchema7 | undefined;
+    features?: Feature[] | undefined;
 }
 /**
  * Flow shape after being sent by the CLI and cleaned in the backend

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

@@ -11,7 +11,7 @@ export type GetEnvironments = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/environments';
     Success: {
-        data: Pick<DBEnvironment, 'name'>[];
+        data: Pick<DBEnvironment, 'name' | 'is_production'>[];
     };
 }>;
 export type PostEnvironment = Endpoint<{
@@ -45,6 +45,7 @@ export type PatchEnvironment = Endpoint<{
     Path: '/api/v1/environments';
     Body: {
         name?: string | undefined;
+        is_production?: boolean | undefined;
         callback_url?: string | undefined;
         hmac_key?: string | undefined;
         hmac_enabled?: boolean | undefined;
@@ -58,7 +59,7 @@ export type PatchEnvironment = Endpoint<{
     Success: {
         data: ApiEnvironment;
     };
-    Error: ApiError<'conflict'>;
+    Error: ApiError<'conflict' | 'cannot_toggle_prod_environment'>;
 }>;
 export type DeleteEnvironment = Endpoint<{
     Method: 'DELETE';

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

@@ -106,3 +106,15 @@ export type PatchFlowFrequency = Endpoint<{
         };
     };
 }>;
+export type GetFlowDownload = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/flows/:id/download';
+    Querystring: {
+        env: string;
+    };
+    Params: {
+        id: number;
+    };
+    Success: never;
+    Error: ApiError<'failed_to_download_flow'>;
+}>;

package/dist/flow/index.d.ts

@@ -1,5 +1,6 @@
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow.js';
 import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
+import type { Feature } from '../syncConfigs/db.js';
 import type { JSONSchema7 } from 'json-schema';
 export interface NangoSyncConfig {
     name: string;
@@ -27,6 +28,7 @@ export interface NangoSyncConfig {
     upgrade_version?: string;
     sdk_version: string | null;
     models?: NangoModel[] | LegacySyncModelSchema[] | undefined;
+    features: Feature[];
 }
 export interface StandardNangoConfig {
     providerConfigKey: string;

package/dist/index.d.ts

@@ -85,3 +85,4 @@ export type * from './jobs/api.js';
 export type * from './checkpoint/types.js';
 export type * from './checkpoint/db.js';
 export type * from './mcp/api.js';
+export type * from './authz/types.js';

package/dist/invitations/api.d.ts

@@ -1,6 +1,7 @@
 import type { ApiError, Endpoint } from '../api.js';
 import type { ApiInvitation, ApiTeam } from '../team/api.js';
 import type { ApiUser } from '../user/api.js';
+import type { Role } from '../user/db.js';
 export type PostInvite = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/invite';
@@ -9,6 +10,7 @@ export type PostInvite = Endpoint<{
     };
     Body: {
         emails: string[];
+        role?: Role;
     };
     Success: {
         data: {

package/dist/invitations/db.d.ts

@@ -1,4 +1,5 @@
 import type { Timestamps } from '../db.js';
+import type { Role } from '../user/db.js';
 export interface DBInvitation extends Timestamps {
     id: number;
     name: string;
@@ -8,4 +9,5 @@ export interface DBInvitation extends Timestamps {
     token: string;
     expires_at: Date;
     accepted: boolean;
+    role: Role;
 }

package/dist/meta/api.d.ts

@@ -9,7 +9,7 @@ export type GetMeta = Endpoint<{
     Error: ApiError<'user_not_found'>;
     Success: {
         data: {
-            environments: Pick<DBEnvironment, 'name'>[];
+            environments: Pick<DBEnvironment, 'name' | 'is_production'>[];
             version: string;
             baseUrl: string;
             debugMode: boolean;

package/dist/nangoYaml/index.d.ts

@@ -1,4 +1,5 @@
 import type { OnEventType } from '../scripts/on-events/api.js';
+import type { Feature } from '../syncConfigs/db.js';
 import type { JSONSchema7 } from 'json-schema';
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /** @deprecated **/
@@ -98,6 +99,7 @@ export interface ParsedNangoSync {
     webhookSubscriptions: string[];
     version: string;
     json_schema?: JSONSchema7 | undefined;
+    features?: Feature[] | undefined;
 }
 export interface ParsedNangoAction {
     name: string;
@@ -110,6 +112,7 @@ export interface ParsedNangoAction {
     usedModels: string[];
     version: string;
     json_schema?: JSONSchema7 | undefined;
+    features?: Feature[] | undefined;
 }
 export type LayoutMode = 'root' | 'nested';
 export interface NangoModel {

package/dist/plans/db.d.ts

@@ -145,5 +145,10 @@ export interface DBPlan extends Timestamps {
      * @default 100
      */
     variants_per_sync_max: number;
+    /**
+     * Override the prefix for the function routing
+     * @default null
+     */
+    fleet_node_routing_override: string | null;
 }
 export {};

package/dist/providers/provider.d.ts

@@ -132,6 +132,7 @@ export interface ProviderJwt extends BaseProvider {
     auth_mode: 'JWT';
     signature: {
         protocol: 'RSA' | 'HMAC';
+        hmac_secret_encoding?: 'hex' | 'utf8';
     };
     token: {
         signing_key: string;

package/dist/runner/index.d.ts

@@ -1,6 +1,7 @@
 import type { TelemetryBag } from './sdk.js';
 import type { CheckpointRange } from '../checkpoint/types.js';
 import type { DBPlan } from '../plans/db.js';
+import type { Feature } from '../syncConfigs/db.js';
 export interface RunnerOutputError {
     type: string;
     payload: Record<string, unknown> | unknown[];
@@ -21,6 +22,7 @@ export interface RunnerFlags {
     validateSyncRecords: boolean;
     validateSyncMetadata: boolean;
 }
-export interface RuntimeContext {
+export interface RoutingContext {
     plan: DBPlan | null;
+    features: Feature[];
 }

package/dist/sync/api.d.ts

@@ -24,7 +24,7 @@ export type PostPublicTrigger = Endpoint<{
     Success: {
         success: boolean;
     };
-    Error: ApiError<'missing_provider_config_key'>;
+    Error: ApiError<'missing_provider_config_key' | 'unknown_provider_config' | 'unknown_connection' | 'no_syncs_found'>;
 }>;
 export type PostSyncVariant = Endpoint<{
     Method: 'POST';
@@ -89,6 +89,7 @@ export type PostPublicSyncPause = Endpoint<{
     Success: {
         success: boolean;
     };
+    Error: ApiError<'no_syncs_found' | 'unknown_connection' | 'unknown_provider_config'>;
 }>;
 export type PostPublicSyncStart = Endpoint<{
     Method: 'POST';
@@ -104,6 +105,7 @@ export type PostPublicSyncStart = Endpoint<{
     Success: {
         success: boolean;
     };
+    Error: ApiError<'no_syncs_found' | 'unknown_connection' | 'unknown_provider_config'>;
 }>;
 export type GetPublicSyncStatus = Endpoint<{
     Method: 'GET';

package/dist/syncConfigs/db.d.ts

@@ -2,6 +2,7 @@ import type { TimestampsAndDeleted } from '../db.js';
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow.js';
 import type { NangoModel, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
 import type { JSONSchema7 } from 'json-schema';
+export type Feature = 'checkpoints';
 export interface DBSyncConfig extends TimestampsAndDeleted {
     id: number;
     sync_name: string;
@@ -27,5 +28,6 @@ export interface DBSyncConfig extends TimestampsAndDeleted {
     enabled: boolean;
     models_json_schema: JSONSchema7 | null;
     sdk_version: string | null;
+    features: Feature[];
 }
 export type DBSyncConfigInsert = Omit<DBSyncConfig, 'id'>;

package/dist/team/api.d.ts

@@ -2,6 +2,7 @@ import type { ApiError, ApiTimestamps, Endpoint } from '../api.js';
 import type { DBTeam } from './db.js';
 import type { DBInvitation } from '../invitations/db.js';
 import type { ApiUser } from '../user/api.js';
+import type { Role } from '../user/db.js';
 import type { Merge } from 'type-fest';
 export type GetTeam = Endpoint<{
     Method: 'GET';
@@ -49,3 +50,22 @@ export type DeleteTeamUser = Endpoint<{
         };
     };
 }>;
+export type PatchTeamUser = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/team/users/:id';
+    Querystring: {
+        env: string;
+    };
+    Params: {
+        id: number;
+    };
+    Body: {
+        role: Role;
+    };
+    Error: ApiError<'user_not_found'> | ApiError<'forbidden_self_demotion'>;
+    Success: {
+        data: {
+            success: true;
+        };
+    };
+}>;

package/dist/user/api.d.ts

@@ -1,9 +1,10 @@
 import type { Endpoint } from '../api.js';
+import type { Role } from './db.js';
 export type GetUser = Endpoint<{
     Method: 'GET';
     Path: `/api/v1/user`;
     Success: {
-        data: ApiUser;
+        data: ApiUserWithPermissions;
     };
 }>;
 export type InternalGetUsers = Endpoint<{
@@ -33,8 +34,14 @@ export interface ApiUser {
     email: string;
     name: string;
     uuid: string;
+    role: Role;
     gettingStartedClosed: boolean;
 }
+export type AllowedPermissions = Partial<Record<string, Partial<Record<'production' | 'non-production' | 'global', ('create' | 'read' | 'update' | 'delete' | '*')[]>>>>;
+export type ApiUserWithPermissions = ApiUser & {
+    role: Role;
+    permissions: AllowedPermissions;
+};
 export type PutUserPassword = Endpoint<{
     Method: 'PUT';
     Path: `/api/v1/user/password`;

package/dist/user/db.d.ts

@@ -1,4 +1,5 @@
 import type { Timestamps } from '../db.js';
+export type Role = 'administrator' | 'production_support' | 'development_full_access';
 export interface DBUser extends Timestamps {
     id: number;
     email: string;
@@ -14,4 +15,5 @@ export interface DBUser extends Timestamps {
     email_verification_token_expires_at: Date | null;
     uuid: string;
     getting_started_closed: boolean;
+    role: Role;
 }

package/dist/web/env.d.ts

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

package/dist/webhooks/api.d.ts

@@ -1,6 +1,7 @@
 import type { AsyncActionResponse } from '../action/api.js';
 import type { ErrorPayload, SyncErrorPayload } from '../api.js';
 import type { AuthModeType, AuthOperationType } from '../auth/api.js';
+import type { CheckpointRange } from '../checkpoint/types.js';
 import type { SyncResult } from '../sync/index.js';
 export type WebhookTypes = 'sync' | 'auth' | 'forward' | 'async_action';
 export interface NangoWebhookBase {
@@ -15,6 +16,7 @@ export interface NangoSyncWebhookBodyBase extends NangoWebhookBase {
     syncName: string;
     syncVariant: string;
     model: string;
+    checkpoints?: CheckpointRange | undefined;
     /** @deprecated **/
     syncType: 'INCREMENTAL' | 'INITIAL' | 'WEBHOOK';
 }

package/package.json

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