@nangohq/types 0.70.7 → 0.70.8

package/dist/account/api.d.ts

@@ -95,12 +95,11 @@ export type PostLogout = Endpoint<{
     Success: never;
 }>;
 export type PostForgotPassword = Endpoint<{
-    Method: 'PUT';
+    Method: 'POST';
     Path: '/api/v1/account/forgot-password';
     Body: {
         email: string;
     };
-    Error: ApiError<'user_not_found'>;
     Success: {
         success: true;
     };

package/dist/api.endpoints.d.ts

@@ -18,10 +18,11 @@ import type { DeleteIntegration, DeletePublicIntegration, GetIntegration, GetInt
 import type { DeleteInvite, GetInvite, PostInvite } from './invitations/api.js';
 import type { GetOperation, PostInsights, SearchFilters, SearchMessages, SearchOperations } from './logs/api.js';
 import type { GetMeta } from './meta/api.js';
+import type { GetPlainHmac } from './plain/api.js';
 import type { GetBillingUsage, GetBillingUsageTopDimensionValues, PostPlanChange, PostPlanExtendTrial, PutBillingInvoicingDetails } from './plans/http.api.js';
 import type { GetProvider, GetProviders, GetPublicProvider, GetPublicProviders } from './providers/api.js';
 import type { AllPublicProxy } from './proxy/http.api.js';
-import type { GetPublicRecords, PatchPublicPruneRecords } from './record/api.js';
+import type { GetConnectionRecordModels, GetConnectionRecords, 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';
@@ -29,7 +30,7 @@ import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api
 import type { GetUser, PatchUser, PutUserPassword } 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 | PostPublicQuickstartIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicAwsSigV4Authorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | PostFunctionCompile | PostFunctionDryrun | GetFunctionDryrun | PostFunctionDryrunResult | PostFunctionDeployment | GetFunctionDeployment | PostFunctionDeploymentResult | GetPublicFunctionCode | GetPublicIntegrationFunctions | GetPublicIntegrationFunction | DeletePublicIntegrationFunction | GetPublicProviderTemplates | AllPublicProxy;
-export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction;
+export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | PutBillingInvoicingDetails | GetBillingUsage | GetBillingUsageTopDimensionValues | GetUser | PatchUser | PutUserPassword | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | GetIntegrationFunction | GetIntegrationFunctions | DeleteIntegrationFunction | GetIntegrationTemplates | GetProviderTemplates | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetConnectionRecordModels | GetConnectionRecords | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | ListApiKeys | CreateApiKey | DeleteApiKey | PatchApiKey | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider | PostInternalTriggerFunction | GetPlainHmac;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export type * from './admin/http.api.js';
 export type * from './account/api.js';
 export type * from './user/api.js';
 export type * from './user/db.js';
+export type * from './plain/api.js';
 export type * from './connection/api/metadata.js';
 export type * from './connection/db.js';
 export type * from './connectUISettings/dto.js';

package/dist/nangoYaml/index.d.ts

@@ -4,8 +4,13 @@ import type { JSONSchema7 } from 'json-schema';
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /** @deprecated **/
 export type SyncTypeLiteral = 'incremental' | 'full';
-export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'post-connection-scripts';
+export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'functions' | 'webhooks' | 'post-connection-scripts';
 export type ScriptTypeLiteral = 'action' | 'sync' | 'on-event';
+/**
+ * The `function` primitive is authored via `createFunction()` / `createWebhook()`. It is tracked
+ * separately from {@link ScriptTypeLiteral} (sync/action/on-event) while it is introduced additively.
+ */
+export type FunctionScriptTypeLiteral = 'function';
 export interface NangoYamlV1 {
     integrations: Record<string, Record<string, NangoYamlV1Integration>>;
     models: NangoYamlModel;
@@ -76,6 +81,7 @@ export interface NangoYamlParsedIntegration {
     providerConfigKey: string;
     syncs: ParsedNangoSync[];
     actions: ParsedNangoAction[];
+    functions: ParsedNangoFunction[];
     onEventScripts: Record<OnEventType, string[]>;
     /**
      * @deprecated
@@ -101,6 +107,47 @@ export interface ParsedNangoSync {
     json_schema?: JSONSchema7 | undefined;
     features?: Feature[] | undefined;
 }
+/** Serializable view of a function trigger (the executable hooks live in the deployed file body). */
+export interface ParsedFunctionTrigger {
+    type: 'http' | 'schedule' | 'event';
+    /** http trigger: maps to the URL path segment. */
+    name?: string;
+    /** http trigger: 'integration' (default) or 'connection' for tokenized per-connection URLs. */
+    scope?: 'integration' | 'connection';
+    /** schedule trigger. */
+    schedule?: string;
+    /** event trigger. */
+    event?: string;
+    /** Whether ingress coalescing is configured (the window/key config). */
+    debounce?: {
+        key?: {
+            body: string;
+        } | {
+            header: string;
+        };
+        windowMs: number;
+        maxWindowMs?: number;
+        maxEntities?: number;
+        payloadMode?: 'latest' | 'all';
+    };
+    /** Whether the trigger ships an `ingressChallenge` hook (executed at ingress). */
+    hasIngressChallenge?: boolean;
+    /** Whether the trigger ships an `ingressValidation` hook (executed at ingress). */
+    hasIngressValidation?: boolean;
+}
+export interface ParsedNangoFunction {
+    name: string;
+    type: 'function';
+    description: string;
+    triggers: ParsedFunctionTrigger[];
+    input: string | null;
+    output: string[] | null;
+    scopes: string[];
+    usedModels: string[];
+    version: string;
+    json_schema?: JSONSchema7 | undefined;
+    features?: Feature[] | undefined;
+}
 export interface ParsedNangoAction {
     name: string;
     type: 'action';
@@ -143,7 +190,7 @@ export interface FlowsYaml {
         models: NangoYamlModel;
     }>;
 }
-export type FlowZeroJson = NangoYamlParsedIntegration & {
+export type FlowZeroJson = Omit<NangoYamlParsedIntegration, 'functions'> & {
     jsonSchema?: JSONSchema7;
     sdkVersion: string;
 };

package/dist/persist/api.d.ts

@@ -26,6 +26,7 @@ export type RunnerDataTransferTelemetry = WithTags<{
     callsite: 'proxy' | 'uncontrolled_fetch' | 'persist_records' | 'persist_logs';
     bytesSent: number;
     bytesReceived: number;
+    count: number;
 }>;
 export type RunnerTelemetry = RunnerDataTransferTelemetry;
 export type PostRunnerTelemetry = Endpoint<{

package/dist/plain/api.d.ts

@@ -0,0 +1,11 @@
+import type { ApiError, Endpoint } from '../api.js';
+export type GetPlainHmac = Endpoint<{
+    Method: 'GET';
+    Path: `/api/v1/plain`;
+    Success: {
+        data: {
+            hash: string;
+        };
+    };
+    Error: ApiError<'unauthorized'>;
+}>;

package/dist/pubsub/events.d.ts

@@ -95,6 +95,17 @@ export type UsageWebhookForwardEvent = UsageEventBase<'usage.webhook_forward', {
         success: boolean;
     };
 }>;
+export type DataTransferCallsite = 'credential_test_hook' | 'credential_verification_hook' | 'connection_hook' | 'webhook_forward' | 'proxy' | 'uncontrolled_fetch' | 'persist_logs' | 'persist_records';
+export type UsageDataTransferEvent = UsageEventBase<'usage.data_transfer', {
+    value: number;
+    properties: {
+        package: 'server' | 'runner' | 'shared';
+        callsite: DataTransferCallsite;
+        ingressedBytes: number;
+        egressedBytes: number;
+        syncId?: string;
+    };
+}>;
 type EnforceUsageEventBase<T extends UsageEventBase<any, any>> = T;
-export type UsageEvent = EnforceUsageEventBase<UsageMarEvent | UsageRecordsEvent | UsageActionsEvent | UsageConnectionsEvent | UsageFunctionExecutionsEvent | UsageProxyEvent | UsageWebhookForwardEvent>;
+export type UsageEvent = EnforceUsageEventBase<UsageMarEvent | UsageRecordsEvent | UsageActionsEvent | UsageConnectionsEvent | UsageFunctionExecutionsEvent | UsageProxyEvent | UsageWebhookForwardEvent | UsageDataTransferEvent>;
 export {};

package/dist/record/api.d.ts

@@ -63,3 +63,48 @@ export type PatchPublicPruneRecords = Endpoint<{
         has_more: boolean;
     };
 }>;
+export interface ConnectionRecordModel {
+    model: string;
+    variant: string | null;
+    count: number;
+    size_bytes: number;
+    updated_at: string;
+}
+export type GetConnectionRecordModels = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/connections/:connectionId/records/models';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        env: string;
+        provider_config_key: string;
+    };
+    Success: {
+        data: ConnectionRecordModel[];
+    };
+}>;
+export type GetConnectionRecords = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/connections/:connectionId/records';
+    Params: {
+        connectionId: string;
+    };
+    Querystring: {
+        env: string;
+        provider_config_key: string;
+        model: string;
+        variant?: string | undefined;
+        limit?: number | undefined;
+        cursor?: string | undefined;
+        metadata_only?: boolean | undefined;
+        /** When set, return at most one full record for this external id (for lazy payload fetch). metadata_only is ignored */
+        record_id?: string | undefined;
+    };
+    Success: {
+        data: {
+            next_cursor: string | null;
+            records: NangoRecord[];
+        };
+    };
+}>;

package/dist/web/env.d.ts

@@ -8,6 +8,7 @@ export interface WindowEnv {
     publicPosthogHost: string;
     publicLogoDevKey: string;
     publicStripeKey: string;
+    publicPlainAppId: string;
     isCloud: boolean;
     isHosted: boolean;
     isEnterprise: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.70.7",
+    "version": "0.70.8",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -12,7 +12,7 @@
         "directory": "packages/utils"
     },
     "dependencies": {
-        "axios": "1.16.1",
+        "axios": "1.18.0",
         "json-schema": "0.4.0",
         "type-fest": "4.41.0"
     },