@nangohq/types 0.52.4 → 0.53.0

package/dist/api.d.ts

@@ -11,7 +11,7 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'>;
+export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_headers', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type
@@ -21,6 +21,7 @@ export interface EndpointDefinition {
     Path: string;
     Params?: Record<string, any>;
     Body?: Record<string, any>;
+    Headers?: Record<string, any>;
     Querystring?: Record<string, any>;
     Error?: ApiError<any> | never;
     Success: Record<string, any> | never;
@@ -44,6 +45,10 @@ export interface Endpoint<T extends EndpointDefinition> {
      * Received body
      */
     Body: T['Body'] extends Record<string, any> ? T['Body'] : never;
+    /**
+     * Received headers
+     */
+    Headers: T['Headers'] extends Record<string, any> ? T['Headers'] : never;
     /**
      * Response body for success
      */

package/dist/api.endpoints.d.ts

@@ -15,9 +15,12 @@ import type { DeletePublicConnection, GetConnection, GetConnections, GetConnecti
 import type { GetMeta } from './meta/api';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
 import type { PostPublicWebhook } from './webhooks/http.api';
-import type { PostEnvironment } from './environment/api';
-export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | 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;
-export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | 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;
+import type { PatchEnvironment, PostEnvironment } from './environment/api';
+import type { PatchWebhook } from './environment/api/webhook';
+import type { PostEnvironmentVariables } from './environment/variable/api';
+import type { GetPublicRecords } from './record/api';
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | 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;
+export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | 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 APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/deploy/incomingFlow.d.ts

@@ -28,7 +28,7 @@ export interface LegacySyncModelSchema {
 interface InternalIncomingPreBuiltFlowConfig {
     type: ScriptTypeLiteral;
     models: string[];
-    runs: string;
+    runs: string | null;
     auto_start?: boolean;
     attributes?: object | undefined;
     metadata?: NangoConfigMetadata | undefined;

package/dist/deploy/index.d.ts

@@ -6,7 +6,7 @@ export interface SyncDeploymentResult {
     providerConfigKey: string;
     type: ScriptTypeLiteral;
     last_deployed?: Date;
-    input?: string | LegacySyncModelSchema | undefined;
+    input?: string | LegacySyncModelSchema | undefined | null;
     models: string | string[];
     id?: number | undefined;
     /** @deprecated legacy **/

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

@@ -1,5 +1,10 @@
-import type { Endpoint } from '../../api';
-import type { DBEnvironment } from '../db';
+import type { Merge } from 'type-fest';
+import type { ApiTimestamps, Endpoint } from '../../api';
+import type { DBEnvironment, DBExternalWebhook } from '../db';
+export type ApiEnvironment = Omit<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'>;
+export type ApiWebhooks = Omit<DBExternalWebhook, 'id' | 'environment_id' | 'created_at' | 'updated_at'>;
 export type PostEnvironment = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/environments';
@@ -10,3 +15,21 @@ export type PostEnvironment = Endpoint<{
         data: Pick<DBEnvironment, 'id' | 'name'>;
     };
 }>;
+export type PatchEnvironment = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/environments';
+    Body: {
+        callback_url?: string | undefined;
+        hmac_key?: string | undefined;
+        hmac_enabled?: boolean | undefined;
+        slack_notifications?: boolean | undefined;
+        otlp_endpoint?: string | undefined;
+        otlp_headers?: {
+            name: string;
+            value: string;
+        }[] | undefined;
+    };
+    Success: {
+        data: ApiEnvironment;
+    };
+}>;

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

@@ -1,46 +1,19 @@
 import type { Endpoint } from '../../api.js';
-export interface WebhookSettings {
-    alwaysSendWebhook: boolean;
-    sendAuthWebhook: boolean;
-    sendRefreshFailedWebhook: boolean;
-    sendSyncFailedWebhook: boolean;
-}
-export type UpdateWebhookSettings = Endpoint<{
+export type PatchWebhook = Endpoint<{
     Method: 'PATCH';
     Querystring: {
         env: string;
     };
-    Path: '/api/v1/environment/webhook/settings';
-    Body: WebhookSettings;
-    Success: WebhookSettings;
-}>;
-export type UpdatePrimaryUrl = Endpoint<{
-    Method: 'PATCH';
-    Querystring: {
-        env: string;
-    };
-    Path: '/api/v1/environment/webhook/url/primary-url';
-    Body: {
-        url: string;
-    };
-    Success: {
-        data: {
-            url: string;
-        };
-    };
-}>;
-export type UpdateSecondaryUrl = Endpoint<{
-    Method: 'PATCH';
-    Querystring: {
-        env: string;
-    };
-    Path: '/api/v1/environment/webhook/secondary-url';
+    Path: '/api/v1/environments/webhook';
     Body: {
-        url: string;
+        primary_url?: string | undefined;
+        secondary_url?: string | undefined;
+        on_sync_completion_always?: boolean | undefined;
+        on_auth_creation?: boolean | undefined;
+        on_auth_refresh_error?: boolean | undefined;
+        on_sync_error?: boolean | undefined;
     };
     Success: {
-        data: {
-            url: string;
-        };
+        success: boolean;
     };
 }>;

package/dist/environment/db.d.ts

@@ -1,11 +1,11 @@
 import type { Timestamps } from '../db';
 export interface DBEnvironmentVariable extends Timestamps {
-    id?: number;
+    id: number;
     name: string;
     value: string;
     environment_id: number;
-    value_iv?: string | null;
-    value_tag?: string | null;
+    value_iv: string | null;
+    value_tag: string | null;
 }
 export interface DBEnvironment extends Timestamps {
     id: number;
@@ -18,7 +18,13 @@ export interface DBEnvironment extends Timestamps {
     secret_key_tag?: string | null;
     secret_key_hashed?: string | null;
     callback_url: string | null;
+    /**
+     * @deprecated
+     */
     webhook_url: string | null;
+    /**
+     * @deprecated
+     */
     webhook_url_secondary: string | null;
     websockets_path: string | null;
     hmac_enabled: boolean;
@@ -33,17 +39,17 @@ export interface DBEnvironment extends Timestamps {
     pending_secret_key_tag?: string | null;
     pending_public_key?: string | null;
     slack_notifications: boolean;
-    webhook_receive_url?: string;
+    webhook_receive_url: string | null;
     otlp_settings: {
         endpoint: string;
         headers: Record<string, string>;
     } | null;
 }
-export interface ExternalWebhook extends Timestamps {
+export interface DBExternalWebhook extends Timestamps {
     id: number;
     environment_id: number;
-    primary_url: string;
-    secondary_url: string;
+    primary_url: string | null;
+    secondary_url: string | null;
     on_sync_completion_always: boolean;
     on_auth_creation: boolean;
     on_auth_refresh_error: boolean;

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

@@ -0,0 +1,16 @@
+import type { Endpoint } from '../../api';
+import type { DBEnvironmentVariable } from '../db';
+export type ApiEnvironmentVariable = Pick<DBEnvironmentVariable, 'name' | 'value'>;
+export type PostEnvironmentVariables = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/environments/variables';
+    Body: {
+        variables: {
+            name: string;
+            value: string;
+        }[];
+    };
+    Success: {
+        success: boolean;
+    };
+}>;

package/dist/fleet/api.d.ts

@@ -1,10 +1,10 @@
 import type { Endpoint, ApiError } from '../api.js';
-import type { CommitHash, Deployment } from './index.js';
+import type { Deployment } from './index.js';
 export type PostRollout = Endpoint<{
     Method: 'POST';
     Path: '/fleet/:fleetId/rollout';
     Body: {
-        commitHash: CommitHash;
+        image: string;
     };
     Params: {
         fleetId: string;

package/dist/fleet/index.d.ts

@@ -1,9 +1,6 @@
-export type CommitHash = string & {
-    readonly length: 40;
-};
 export interface Deployment {
     readonly id: number;
-    readonly commitId: CommitHash;
+    readonly image: string;
     readonly createdAt: Date;
     readonly supersededAt: Date | null;
 }

package/dist/index.d.ts

@@ -48,6 +48,7 @@ export type * from './environment/api/index.js';
 export type * from './environment/api/webhook.js';
 export type * from './environment/api/otlp.js';
 export type * from './environment/variable/index.js';
+export type * from './environment/variable/api.js';
 export type * from './webhooks/api.js';
 export type * from './webhooks/http.api.js';
 export type * from './flow/http.api.js';

package/dist/integration/api.d.ts

@@ -3,10 +3,9 @@ import type { ApiTimestamps, Endpoint } from '../api';
 import type { IntegrationConfig } from './db';
 import type { Provider } from '../providers/provider';
 import type { AuthModeType, AuthModes } from '../auth/api';
-import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral } from '../nangoYaml';
+import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
 import type { JSONSchema7 } from 'json-schema';
-import type { SyncType } from '../scripts/syncs/api';
 export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider'>, ApiTimestamps> & {
     logo: string;
     display_name: string;
@@ -177,7 +176,7 @@ export interface NangoSyncConfig {
     last_deployed?: string | null;
     id?: number;
     input?: NangoModel | LegacySyncModelSchema;
-    sync_type?: SyncType;
+    sync_type?: SyncTypeLiteral;
     webhookSubscriptions?: string[];
     enabled?: boolean;
     json_schema: JSONSchema7 | null;

package/dist/logs/messages.d.ts

@@ -109,7 +109,6 @@ export interface MessageRow {
     response: {
         code: number;
         headers: Record<string, string>;
-        body?: unknown;
     } | null;
     meta: MessageMeta | null;
     createdAt: string;

package/dist/nangoYaml/index.d.ts

@@ -1,6 +1,6 @@
 import type { OnEventType } from '../scripts/on-events/api';
 export type HTTP_METHOD = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
-export type SyncTypeLiteral = 'incremental' | 'full' | 'FULL' | 'INCREMENTAL';
+export type SyncTypeLiteral = 'incremental' | 'full';
 export type ScriptFileType = 'actions' | 'syncs' | 'on-events' | 'post-connection-scripts';
 export type ScriptTypeLiteral = 'action' | 'sync' | 'on-event';
 export interface NangoYamlV1 {

package/dist/record/api.d.ts

@@ -1,4 +1,6 @@
+import type { ApiError, Endpoint } from '../api';
 export type RecordLastAction = 'ADDED' | 'UPDATED' | 'DELETED' | 'added' | 'updated' | 'deleted';
+export type CombinedFilterAction = `${RecordLastAction},${RecordLastAction}`;
 export interface RecordMetadata {
     first_seen_at: string;
     last_modified_at: string;
@@ -6,11 +8,11 @@ export interface RecordMetadata {
     deleted_at: string | null;
     cursor: string;
 }
-export interface NangoRecord {
+export type NangoRecord<T extends Record<string, any> = Record<string, any>> = {
     [key: string]: any;
     id: string | number;
     _nango_metadata: RecordMetadata;
-}
+} & T;
 export type MergingStrategy = {
     strategy: 'override';
 } | {
@@ -18,3 +20,25 @@ export type MergingStrategy = {
     cursor?: string;
 };
 export type CursorOffset = 'first' | 'last';
+export type GetPublicRecords = Endpoint<{
+    Method: 'GET';
+    Path: `/records`;
+    Headers: {
+        'connection-id': string;
+        'provider-config-key': string;
+    };
+    Error: ApiError<'unknown_connection'>;
+    Querystring: {
+        model: string;
+        delta?: string | undefined;
+        modified_after?: string | undefined;
+        limit?: number | undefined;
+        filter?: RecordLastAction | CombinedFilterAction | undefined;
+        cursor?: string | undefined;
+        ids?: string[] | undefined;
+    };
+    Success: {
+        next_cursor: string | null;
+        records: NangoRecord[];
+    };
+}>;

package/dist/scripts/syncs/api.d.ts

@@ -3,4 +3,4 @@ export interface SyncResult {
     updated: number;
     deleted: number;
 }
-export type SyncType = 'INCREMENTAL' | 'FULL' | 'WEBHOOK';
+export type SyncOperationType = 'INCREMENTAL' | 'FULL' | 'WEBHOOK';

package/dist/syncConfigs/db.d.ts

@@ -8,7 +8,7 @@ export interface DBSyncConfig extends TimestampsAndDeleted {
     nango_config_id: number;
     file_location: string;
     version: string;
-    models: string[] | null;
+    models: string[];
     active: boolean;
     runs: string | null;
     model_schema: LegacySyncModelSchema[] | NangoModel[] | null;
@@ -26,3 +26,4 @@ export interface DBSyncConfig extends TimestampsAndDeleted {
     enabled: boolean;
     models_json_schema: JSONSchema7 | null;
 }
+export type DBSyncConfigInsert = Omit<DBSyncConfig, 'id'>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.52.4",
+    "version": "0.53.0",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -11,12 +11,14 @@
         "url": "git+https://github.com/NangoHQ/nango.git",
         "directory": "packages/utils"
     },
-    "devDependencies": {
-        "@types/json-schema": "7.0.15",
+    "dependencies": {
         "axios": "^1.7.9",
         "json-schema": "0.4.0",
         "type-fest": "4.32.0"
     },
+    "devDependencies": {
+        "@types/json-schema": "7.0.15"
+    },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "files": [
         "dist/**/*"