@nangohq/types 0.71.2 → 0.71.4

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

@@ -1,5 +1,7 @@
-import type { Endpoint } from '../../api.js';
-export type PatchWebhook = Endpoint<{
+import type { ApiEndpoint } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
+export type PatchWebhook = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'webhook_urls_changed', 'environment'>;
     Method: 'PATCH';
     Querystring: {
         env: string;

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

@@ -1,7 +1,9 @@
-import type { Endpoint } from '../../api.js';
+import type { ApiEndpoint } from '../../api.js';
+import type { AuditPolicy } from '../../audit-trail/event.js';
 import type { DBEnvironmentVariable } from '../db.js';
 export type ApiEnvironmentVariable = Pick<DBEnvironmentVariable, 'name' | 'value'>;
-export type PostEnvironmentVariables = Endpoint<{
+export type PostEnvironmentVariables = ApiEndpoint<{
+    Audit: AuditPolicy<'environment', 'variables_changed', 'environment'>;
     Method: 'POST';
     Path: '/api/v1/environments/variables';
     Querystring: {

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

@@ -1,6 +1,8 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
 import type { ScriptTypeLiteral } from '../nangoYaml/index.js';
-export type PutUpgradePreBuiltFlow = Endpoint<{
+export type PutUpgradePreBuiltFlow = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'upgraded', 'environment'>;
     Method: 'PUT';
     Path: '/api/v1/flows/pre-built/upgrade';
     Querystring: {
@@ -20,7 +22,8 @@ export type PutUpgradePreBuiltFlow = Endpoint<{
         success: true;
     };
 }>;
-export type PostPreBuiltDeploy = Endpoint<{
+export type PostPreBuiltDeploy = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deployed', 'environment'>;
     Method: 'POST';
     Path: '/api/v1/flows/pre-built/deploy';
     Querystring: {
@@ -38,7 +41,8 @@ export type PostPreBuiltDeploy = Endpoint<{
         };
     };
 }>;
-export type PatchFlowEnable = Endpoint<{
+export type PatchFlowEnable = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'enabled', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/enable';
     Querystring: {
@@ -60,7 +64,8 @@ export type PatchFlowEnable = Endpoint<{
         };
     };
 }>;
-export type PatchFlowDisable = Endpoint<{
+export type PatchFlowDisable = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'disabled', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/disable';
     Querystring: {
@@ -82,7 +87,8 @@ export type PatchFlowDisable = Endpoint<{
         };
     };
 }>;
-export type PatchFlowFrequency = Endpoint<{
+export type PatchFlowFrequency = ApiEndpoint<{
+    Audit: AuditPolicy<'sync', 'frequency_changed', 'environment'>;
     Method: 'PATCH';
     Path: '/api/v1/flows/:id/frequency';
     Querystring: {
@@ -105,7 +111,11 @@ export type PatchFlowFrequency = Endpoint<{
         };
     };
 }>;
-export type GetFlowDownload = Endpoint<{
+export type GetFlowDownload = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/flows/:id/download';
     Querystring: {

package/dist/function/config.d.ts

@@ -0,0 +1,65 @@
+import type { OnEventType } from '../scripts/on-events/api.js';
+export interface FunctionCapabilities {
+    usesRecords: boolean;
+    usesOutbound: boolean;
+    usesCheckpoints: boolean;
+    usesMetadata: boolean;
+    usesInvoke: boolean;
+}
+/**
+ * Declares where the debounce/coalescing key is extracted from:
+ * - `{ body: '$.portalId' }`: dot notation path into the body
+ * - `{ header: 'x-goog-resource-id' }`: flat, case-insensitive header lookup
+ */
+export type DebounceKeySource = {
+    body: string;
+} | {
+    header: string;
+};
+/** Coalesces a burst of inbound HTTP requests into a single function run within a sliding window. */
+export interface DebounceOptions {
+    /** Events sharing the same resolved key coalesce together. */
+    keyBy?: DebounceKeySource | DebounceKeySource[] | undefined;
+    /** Sliding window in milliseconds. */
+    windowMs: number;
+    /** When exceeded, the window stops sliding. */
+    maxEntities?: number | undefined;
+    /** Which payloads from the coalesced window the handler receives. */
+    take?: 'latest' | 'first' | 'all' | undefined;
+}
+/**
+ * Declares how a function is initiated from outside; `kind` discriminates the source.
+ * - `none`: no external trigger; the function is invoke-only
+ * - `schedule`: a periodic schedule
+ * - `http`: an incoming HTTP call or webhook request
+ * - `event`: an internal Nango lifecycle event
+ */
+export type FunctionTriggerDefinition = {
+    kind: 'none';
+} | {
+    kind: 'schedule';
+    frequency: string;
+    autoStart?: boolean | undefined;
+} | {
+    kind: 'http';
+    subscriptions?: string[] | undefined;
+    debounce?: DebounceOptions | undefined;
+} | {
+    kind: 'event';
+    events: OnEventType[];
+};
+export type FunctionConcurrencyLimit = 1 | 'max';
+export interface FunctionLimits {
+    concurrency?: {
+        perConnection: FunctionConcurrencyLimit;
+    } | undefined;
+}
+export type FunctionRequires = {
+    connection?: true | undefined;
+    outbound?: boolean | undefined;
+    invoke?: boolean | undefined;
+} | {
+    connection: false;
+    outbound?: false | undefined;
+    invoke?: boolean | undefined;
+};

package/dist/function/db.d.ts

@@ -0,0 +1,39 @@
+import type { TimestampsAndDeletedAt } from '../db.js';
+import type { FunctionSource } from '../syncConfigs/db.js';
+import type { FunctionCapabilities, FunctionLimits, FunctionRequires, FunctionTriggerDefinition } from './config.js';
+import type { JSONSchema7 } from 'json-schema';
+export interface DBFunctionConfig extends TimestampsAndDeletedAt {
+    id: number;
+    nango_config_id: number;
+    environment_id: number;
+    name: string;
+    current_version_id: number | null;
+    enabled: boolean;
+}
+export interface DBFunctionConfigVersion extends TimestampsAndDeletedAt {
+    id: number;
+    function_config_id: number;
+    description: string;
+    file_location: string;
+    version: string;
+    source: FunctionSource;
+    trigger: FunctionTriggerDefinition;
+    requires: FunctionRequires;
+    capabilities: FunctionCapabilities;
+    limits: FunctionLimits;
+    input_schema_ref: string | null;
+    output_schema_ref: string | null;
+    model_schema_refs: string[];
+    metadata_schema_ref: string | null;
+    checkpoint_schema_ref: string | null;
+    json_schema: JSONSchema7;
+}
+export interface DBFunctionInstance extends TimestampsAndDeletedAt {
+    id: number;
+    nango_connection_id: number;
+    function_config_id: number;
+    name: string;
+    variant: string;
+    last_run_at: Date | null;
+    frequency: string | null;
+}

package/dist/functions/api.d.ts

@@ -1,5 +1,8 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
+import type { AuditPolicy } from '../audit-trail/event.js';
+import type { FunctionCapabilities, FunctionLimits, FunctionRequires, FunctionTriggerDefinition } from '../function/config.js';
 import type { DeployedNangoFunction, FunctionType, NangoActionFunction, NangoFunctionTemplate, NangoSyncFunction } from './domain.js';
+import type { JSONSchema7 } from 'json-schema';
 export type RunnableFunctionType = Extract<FunctionType, 'action' | 'sync'>;
 export type FunctionErrorCode = 'invalid_request' | 'server_error' | 'integration_not_found' | 'compilation_error' | 'dryrun_error' | 'deployment_error' | 'connection_not_found' | 'dryrun_not_found' | 'deployment_not_found' | 'function_disabled' | 'execution_environment_unavailable' | 'timeout' | 'validation_error';
 export interface ProxyCall {
@@ -130,21 +133,33 @@ export type FunctionDeploymentResultBody = {
         payload?: unknown;
     };
 };
-export type PostFunctionCompile = Endpoint<{
+export type PostFunctionCompile = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/functions/compile';
     Body: FunctionCompileBody;
     Error: ApiError<FunctionErrorCode>;
     Success: FunctionCompileSuccess;
 }>;
-export type PostFunctionDryrun = Endpoint<{
+export type PostFunctionDryrun = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/functions/dryruns';
     Body: FunctionDryrunBody;
     Error: ApiError<FunctionErrorCode>;
     Success: FunctionDryrunCreateSuccess;
 }>;
-export type GetFunctionDryrun = Endpoint<{
+export type GetFunctionDryrun = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/functions/dryruns/:id';
     Params: {
@@ -153,7 +168,11 @@ export type GetFunctionDryrun = Endpoint<{
     Error: ApiError<FunctionErrorCode>;
     Success: FunctionDryrunResultSuccess;
 }>;
-export type PostFunctionDryrunResult = Endpoint<{
+export type PostFunctionDryrunResult = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/functions/dryruns/:id/result';
     Params: {
@@ -165,14 +184,19 @@ export type PostFunctionDryrunResult = Endpoint<{
         ok: true;
     };
 }>;
-export type PostFunctionDeployment = Endpoint<{
+export type PostFunctionDeployment = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deployed', 'environment'>;
     Method: 'POST';
     Path: '/functions/deployments';
     Body: FunctionDeploymentBody;
     Error: ApiError<FunctionErrorCode> | ApiError<'template_not_found' | 'ambiguous_function' | 'plan_limit' | 'template_already_deployed'>;
     Success: FunctionDeploymentCreateSuccess;
 }>;
-export type GetFunctionDeployment = Endpoint<{
+export type GetFunctionDeployment = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/functions/deployments/:id';
     Params: {
@@ -181,7 +205,11 @@ export type GetFunctionDeployment = Endpoint<{
     Error: ApiError<FunctionErrorCode>;
     Success: FunctionDeploymentResultSuccess;
 }>;
-export type PostFunctionDeploymentResult = Endpoint<{
+export type PostFunctionDeploymentResult = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'TODO: audit coverage pending';
+    };
     Method: 'POST';
     Path: '/functions/deployments/:id/result';
     Params: {
@@ -218,7 +246,11 @@ export interface FunctionDeletionSuccess {
 export interface ProviderTemplatesSuccess {
     data: (NangoSyncFunction | NangoActionFunction)[];
 }
-export type GetIntegrationFunctions = Endpoint<{
+export type GetIntegrationFunctions = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey/functions';
     Querystring: {
@@ -229,7 +261,11 @@ export type GetIntegrationFunctions = Endpoint<{
     };
     Success: FunctionListSuccess;
 }>;
-export type GetIntegrationFunction = Endpoint<{
+export type GetIntegrationFunction = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey/functions/:functionName';
     Querystring: {
@@ -242,7 +278,8 @@ export type GetIntegrationFunction = Endpoint<{
     };
     Success: DeployedFunctionSuccess;
 }>;
-export type DeleteIntegrationFunction = Endpoint<{
+export type DeleteIntegrationFunction = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deleted', 'environment'>;
     Method: 'DELETE';
     Path: '/api/v1/integrations/:providerConfigKey/functions/:functionName';
     /** TODO: support deleting on-event functions */
@@ -257,7 +294,11 @@ export type DeleteIntegrationFunction = Endpoint<{
     Error: ApiError<'function_managed_by_deploy'>;
     Success: FunctionDeletionSuccess;
 }>;
-export type GetProviderTemplates = Endpoint<{
+export type GetProviderTemplates = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/providers/:providerConfigKey/templates';
     Querystring: {
@@ -268,7 +309,11 @@ export type GetProviderTemplates = Endpoint<{
     };
     Success: ProviderTemplatesSuccess;
 }>;
-export type GetPublicIntegrationFunctions = Endpoint<{
+export type GetPublicIntegrationFunctions = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/integrations/:uniqueKey/functions';
     Querystring: FunctionListFilters;
@@ -277,7 +322,11 @@ export type GetPublicIntegrationFunctions = Endpoint<{
     };
     Success: FunctionListSuccess;
 }>;
-export type GetPublicIntegrationFunction = Endpoint<{
+export type GetPublicIntegrationFunction = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/integrations/:uniqueKey/functions/:name';
     Querystring: {
@@ -289,7 +338,8 @@ export type GetPublicIntegrationFunction = Endpoint<{
     };
     Success: DeployedFunctionSuccess;
 }>;
-export type DeletePublicIntegrationFunction = Endpoint<{
+export type DeletePublicIntegrationFunction = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deleted', 'environment'>;
     Method: 'DELETE';
     Path: '/integrations/:uniqueKey/functions/:name';
     /** TODO: support deleting on-event functions */
@@ -303,7 +353,11 @@ export type DeletePublicIntegrationFunction = Endpoint<{
     Error: ApiError<'function_managed_by_deploy'>;
     Success: FunctionDeletionSuccess;
 }>;
-export type GetPublicProviderTemplates = Endpoint<{
+export type GetPublicProviderTemplates = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/providers/:provider/templates';
     Params: {
@@ -311,7 +365,11 @@ export type GetPublicProviderTemplates = Endpoint<{
     };
     Success: ProviderTemplatesSuccess;
 }>;
-export type GetIntegrationTemplates = Endpoint<{
+export type GetIntegrationTemplates = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey/templates';
     Querystring: {
@@ -324,3 +382,69 @@ export type GetIntegrationTemplates = Endpoint<{
         data: NangoFunctionTemplate[];
     };
 }>;
+export interface FunctionDeploymentArtifact {
+    name: string;
+    integrationId: string;
+    description: string;
+    trigger: FunctionTriggerDefinition;
+    requires: FunctionRequires;
+    capabilities: FunctionCapabilities;
+    limits: FunctionLimits;
+    input_schema_ref: string | null;
+    output_schema_ref: string | null;
+    model_schema_refs: string[];
+    metadata_schema_ref: string | null;
+    checkpoint_schema_ref: string | null;
+    json_schema: JSONSchema7;
+    fileBody: {
+        js: string;
+        ts: string;
+    };
+}
+export type FunctionReconciliationScope = {
+    kind: 'environment';
+} | {
+    kind: 'integration';
+    integrationId: string;
+};
+export interface FunctionDeploymentBundleBody {
+    reconciliationScope: FunctionReconciliationScope;
+    functions: FunctionDeploymentArtifact[];
+}
+export interface FunctionDeploymentBundleSuccess {
+    created: {
+        integrationId: string;
+        name: string;
+    }[];
+    updated: {
+        integrationId: string;
+        name: string;
+    }[];
+    unchanged: {
+        integrationId: string;
+        name: string;
+    }[];
+    deleted: {
+        integrationId: string;
+        name: string;
+    }[];
+}
+export type PostFunctionDeploymentBundlePreview = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
+    Method: 'POST';
+    Path: '/functions/deployments/bundle/preview';
+    Body: FunctionDeploymentBundleBody;
+    Error: ApiError<'functions_deployment_error' | 'integration_not_found'>;
+    Success: FunctionDeploymentBundleSuccess;
+}>;
+export type PostFunctionDeploymentBundle = ApiEndpoint<{
+    Audit: AuditPolicy<'function', 'deployed', 'environment'>;
+    Method: 'POST';
+    Path: '/functions/deployments/bundle';
+    Body: FunctionDeploymentBundleBody;
+    Error: ApiError<'functions_deployment_error' | 'concurrent_deployment' | 'integration_not_found'>;
+    Success: FunctionDeploymentBundleSuccess;
+}>;

package/dist/gettingStarted/api.d.ts

@@ -1,6 +1,10 @@
-import type { ApiError, Endpoint } from '../api.js';
+import type { ApiEndpoint, ApiError } from '../api.js';
 import type { GettingStartedOutput as GettingStartedProgressOutput, PatchGettingStartedInput as PatchGettingStartedProgressInput } from './dto.js';
-export type GetGettingStarted = Endpoint<{
+export type GetGettingStarted = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'GET';
     Path: '/api/v1/getting-started';
     Querystring: {
@@ -11,7 +15,11 @@ export type GetGettingStarted = Endpoint<{
     };
     Error: ApiError<'failed_to_get_or_create_getting_started_progress'>;
 }>;
-export type PatchGettingStarted = Endpoint<{
+export type PatchGettingStarted = ApiEndpoint<{
+    Audit: {
+        kind: 'no-audit';
+        reason: 'non-auditable';
+    };
     Method: 'PATCH';
     Path: '/api/v1/getting-started';
     Querystring: {

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export type * from './db.js';
 export type * from './api.js';
 export type * from './api.endpoints.js';
+export type * from './audit-trail/api.js';
+export type * from './audit-trail/event.js';
 export type * from './gettingStarted/db.js';
 export type * from './gettingStarted/dto.js';
 export type * from './gettingStarted/api.js';
@@ -69,8 +71,9 @@ export type * from './proxy/http.api.js';
 export type * from './dbConfig/db.js';
 export type * from './nangoYaml/index.js';
 export type * from './environment/db.js';
-export { ALL_SCOPES, API_KEY_SCOPES } from './api-keys/scopes.js';
-export type { ApiKeyScope } from './api-keys/scopes.js';
+export { ACCOUNT_API_KEY_SCOPES, API_KEY_SCOPES } from './api-keys/scopes.js';
+export type { AccountApiKeyScope, ApiKeyScope, CustomerKeyScope } from './api-keys/scopes.js';
+export type * from './api-keys/auth.js';
 export type * from './environment/api/index.js';
 export type * from './environment/api/webhook.js';
 export type * from './environment/api/otlp.js';
@@ -93,8 +96,9 @@ export type * from './checkpoint/db.js';
 export type * from './mcp/api.js';
 export type * from './mfa/api.js';
 export type * from './mfa/db.js';
+export type * from './function/config.js';
+export type * from './function/db.js';
 export type * from './functions/api.js';
-export type * from './functions/capabilities.js';
 export type * from './functions/domain.js';
 export type * from './lambda/index.js';
 export type * from './authz/types.js';