@nangohq/types 0.69.26 → 0.69.28

package/dist/api.endpoints.d.ts

@@ -5,7 +5,7 @@ import type { EndpointMethod } from './api.js';
 import type { PostPublicApiKeyAuthorization, PostPublicAppStoreAuthorization, PostPublicBasicAuthorization, PostPublicBillAuthorization, PostPublicJwtAuthorization, PostPublicOauthOutboundAuthorization, PostPublicSignatureAuthorization, PostPublicTbaAuthorization, PostPublicTwoStepAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api.js';
 import type { DeleteConnectSession, GetConnectSession, PostConnectSessions, PostInternalConnectSessions, PostPublicConnectSessionsReconnect, PostPublicConnectTelemetry } from './connect/api.js';
 import type { GetConnectUISettings, PutConnectUISettings } from './connectUISettings/api.js';
-import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
+import type { DeletePublicConnection, GetConnection, GetConnections, GetConnectionsCount, GetPublicConnection, GetPublicConnections, PatchPublicConnection, PostConnectionRefresh, PostPublicConnection } from './connection/api/get.js';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata.js';
 import type { PostDeploy, PostDeployConfirmation, PostDeployInternal } from './deploy/api.js';
 import type { DeleteEnvironment, GetEnvironments, PatchEnvironment, PostEnvironment } from './environment/api/index.js';
@@ -27,7 +27,7 @@ import type { GetPublicSyncStatus, PostPublicSyncPause, PostPublicSyncStart, Pos
 import type { DeleteTeamUser, GetTeam, 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 | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | AllPublicProxy;
+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 | 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 | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**

package/dist/checkpoint/db.d.ts

@@ -0,0 +1,18 @@
+import type { Timestamps } from '../db.js';
+import type { Checkpoint } from './types.js';
+/**
+ * Checkpoints are identified by a flexible key format that allows
+ * attaching checkpoints to various entities:
+ *
+ * @example Key formats:
+ * - `connection:123:config:456` - checkpoint for a specific sync/action per connection
+ */
+export interface DBCheckpoint extends Timestamps {
+    id: number;
+    environment_id: number;
+    connection_id: number;
+    key: string;
+    checkpoint: Checkpoint;
+    version: number;
+    deleted_at: Date | null;
+}

package/dist/checkpoint/types.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Allowed types for checkpoint values.
+ * Only flat key-value structures are supported (no nested objects or arrays).
+ * Date values are automatically converted to ISO strings when stored.
+ */
+export type CheckpointValue = string | number | boolean | Date;
+/**
+ * A checkpoint is a flat key-value object that can be used to store
+ * progress or state during function execution.
+ * Date values are automatically converted to ISO strings when stored.
+ *
+ * @example
+ * ```typescript
+ * const checkpoint: Checkpoint = {
+ *     lastProcessedPage: 5,
+ *     lastCursor: "abc123",
+ *     lastRunAt: new Date(), // stored as ISO string
+ * };
+ * ```
+ */
+export type Checkpoint = Record<string, CheckpointValue>;

package/dist/connect/api.d.ts

@@ -16,6 +16,7 @@ export interface ConnectSessionInput {
         id: string;
         display_name?: string | undefined;
     } | undefined;
+    tags?: Record<string, string> | undefined;
     overrides?: Record<string, {
         docs_connect?: string | undefined;
     }> | undefined;
@@ -53,6 +54,7 @@ export type PostPublicConnectSessionsReconnect = Endpoint<{
         end_user?: ConnectSessionInput['end_user'] | undefined;
         organization?: ConnectSessionInput['organization'];
         overrides?: ConnectSessionInput['overrides'];
+        tags?: ConnectSessionInput['tags'];
     };
     Success: {
         data: {

package/dist/connect/session.d.ts

@@ -1,3 +1,4 @@
+import type { Tags } from '../db.js';
 import type { InternalEndUser } from '../endUser/index.js';
 export interface ConnectSession {
     readonly id: number;
@@ -10,6 +11,7 @@ export interface ConnectSession {
     readonly integrationsConfigDefaults: Record<string, ConnectSessionIntegrationConfigDefaults> | null;
     readonly overrides: Record<string, ConnectSessionOverrides> | null;
     readonly endUser: InternalEndUser | null;
+    readonly tags: Tags;
     readonly createdAt: Date;
     readonly updatedAt: Date | null;
 }

package/dist/connection/api/get.d.ts

@@ -1,6 +1,7 @@
 import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
 import type { AllAuthCredentials, ApiKeyCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
 import type { EndUserInput } from '../../connect/api.js';
+import type { Tags } from '../../db.js';
 import type { ApiEndUser } from '../../endUser/index.js';
 import type { ActiveLog } from '../../notification/active-logs/db.js';
 import type { ReplaceInObject } from '../../utils.js';
@@ -13,6 +14,7 @@ export type ApiConnectionSimple = Pick<Merge<DBConnection, ApiTimestamps>, 'id'
         log_id: string;
     }[];
     endUser: ApiEndUser | null;
+    tags: Tags;
 };
 export type GetConnections = Endpoint<{
     Method: 'GET';
@@ -53,6 +55,7 @@ export type ApiPublicConnection = Pick<DBConnection, 'id' | 'connection_id'> & {
         log_id: string;
     }[];
     end_user: ApiEndUser | null;
+    tags: Tags;
 };
 export type GetPublicConnections = Endpoint<{
     Method: 'GET';
@@ -62,6 +65,7 @@ export type GetPublicConnections = Endpoint<{
         endUserId?: string | undefined;
         integrationId?: string | undefined;
         endUserOrganizationId?: string | undefined;
+        tags?: Tags | undefined;
         limit?: number | undefined;
         page?: number | undefined;
     };
@@ -90,6 +94,7 @@ export type PostPublicConnection = Endpoint<{
             type: 'NONE';
         };
         end_user?: EndUserInput | undefined;
+        tags?: Tags | undefined;
     };
     Success: ApiPublicConnectionFull;
 }>;
@@ -126,6 +131,7 @@ export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id'
         log_id: string;
     }[];
     end_user: ApiEndUser | null;
+    tags: Tags;
     credentials: AllAuthCredentials;
 };
 export type GetPublicConnection = Endpoint<{
@@ -154,6 +160,7 @@ export type PatchPublicConnection = Endpoint<{
     };
     Body: {
         end_user?: EndUserInput | undefined;
+        tags?: Tags | undefined;
     };
     Success: {
         success: boolean;

package/dist/connection/db.d.ts

@@ -1,5 +1,5 @@
 import type { AllAuthCredentials, AuthModeType, AuthOperationType } from '../auth/api.js';
-import type { TimestampsAndDeletedCorrect } from '../db.js';
+import type { Tags, TimestampsAndDeletedCorrect } from '../db.js';
 import type { InternalEndUser } from '../endUser/index.js';
 import type { DBEnvironment } from '../environment/db.js';
 import type { DBTeam } from '../team/db.js';
@@ -16,6 +16,7 @@ export interface DBConnection extends TimestampsAndDeletedCorrect {
     id: number;
     config_id: number;
     end_user_id: number | null;
+    tags: Tags;
     /**
      * @deprecated
      */

package/dist/db.d.ts

@@ -14,3 +14,4 @@ export interface TimestampsAndDeleted extends Timestamps, Deleted {
 }
 export interface TimestampsAndDeletedCorrect extends Timestamps, DeletedCorrect {
 }
+export type Tags = Record<string, string>;

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

@@ -3,9 +3,9 @@ import type { ApiPlan } from '../../plans/http.api.js';
 import type { DBEnvironment, DBExternalWebhook } from '../db.js';
 import type { ApiEnvironmentVariable } from '../variable/api.js';
 import type { Merge } from 'type-fest';
-export type ApiEnvironment = Omit<Merge<DBEnvironment, {
+export type ApiEnvironment = Merge<DBEnvironment, {
     callback_url: string;
-} & ApiTimestamps>, 'secret_key_iv' | 'secret_key_tag' | 'secret_key_hashed' | 'pending_secret_key_iv' | 'pending_secret_key_tag' | 'pending_public_key'>;
+} & ApiTimestamps>;
 export type ApiWebhooks = Omit<DBExternalWebhook, 'id' | 'environment_id' | 'created_at' | 'updated_at'>;
 export type GetEnvironments = Endpoint<{
     Method: 'GET';

package/dist/environment/db.d.ts

@@ -12,11 +12,14 @@ export interface DBEnvironment extends TimestampsAndDeletedCorrect {
     uuid: string;
     name: string;
     account_id: number;
+    /**
+     * @deprecated Field secret_key is deprecated.
+     * New code should use SecretService to retrieve secrets for environments.
+     * This field is populated for backward compatibility only.
+     * It may be removed in a future release.
+     */
     secret_key: string;
     public_key: string;
-    secret_key_iv?: string | null;
-    secret_key_tag?: string | null;
-    secret_key_hashed?: string | null;
     callback_url: string | null;
     /**
      * @deprecated
@@ -34,9 +37,13 @@ export interface DBEnvironment extends TimestampsAndDeletedCorrect {
     hmac_digest?: string | null;
     secret_key_rotatable?: boolean;
     public_key_rotatable?: boolean;
+    /**
+     * @deprecated Field pending_secret_key is deprecated.
+     * New code should use SecretService to rotate secrets for environments.
+     * This field is populated for backward compatibility only.
+     * It may be removed in a future release.
+     */
     pending_secret_key: string | null;
-    pending_secret_key_iv?: string | null;
-    pending_secret_key_tag?: string | null;
     pending_public_key?: string | null;
     slack_notifications: boolean;
     webhook_receive_url: string | null;

package/dist/index.d.ts

@@ -82,4 +82,6 @@ export type * from './fleet/api.js';
 export type * from './fleet/index.js';
 export type * from './persist/api.js';
 export type * from './jobs/api.js';
+export type * from './checkpoint/types.js';
+export type * from './checkpoint/db.js';
 export type * from './mcp/api.js';

package/dist/persist/api.d.ts

@@ -1,4 +1,5 @@
 import type { ApiError, Endpoint } from '../api.js';
+import type { Checkpoint } from '../checkpoint/types.js';
 import type { MessageRowInsert } from '../logs/messages.js';
 import type { MergingStrategy, NangoRecord } from '../record/api.js';
 interface LogBody {
@@ -34,4 +35,13 @@ export interface GetRecordsSuccess {
     records: NangoRecord[];
     nextCursor?: string;
 }
+export interface GetCheckpointSuccess {
+    checkpoint: Checkpoint;
+    version: number;
+    deletedAt: string | null;
+}
+export interface PutCheckpointSuccess {
+    checkpoint: Checkpoint;
+    version: number;
+}
 export {};

package/dist/result.d.ts

@@ -3,7 +3,7 @@ export interface Left<T, E extends Error> {
     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>;
+    map<U>(fn: (value: T) => U): Result<U, E>;
     mapError<U extends Error>(fn: (error: E) => U): Result<T, U>;
 }
 export interface Right<T, E extends Error> {

package/dist/webhooks/api.d.ts

@@ -41,6 +41,7 @@ export interface NangoAuthWebhookBodyBase extends NangoWebhookBase {
     provider: string;
     environment: string;
     operation: AuthOperationType;
+    tags?: Record<string, string> | undefined;
     /**
      * Only presents if the connection happened with a session token
      */

package/package.json

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