@nangohq/types 0.54.0 → 0.56.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_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 ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | ApiError<'forbidden'> | 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

package/dist/api.endpoints.d.ts

@@ -19,7 +19,8 @@ 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;
+import type { GetPublicScriptsConfig } from './scripts/http.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 | GetPublicScriptsConfig;
 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;
 /**

package/dist/deploy/api.d.ts

@@ -1,13 +1,13 @@
 import type { JSONSchema7 } from 'json-schema';
 import type { Endpoint, ApiError } from '../api.js';
-import type { IncomingFlowConfig, OnEventScriptsByProvider } from './incomingFlow.js';
+import type { CLIDeployFlowConfig, OnEventScriptsByProvider } from './incomingFlow.js';
 import type { SyncDeploymentResult } from './index.js';
 import type { OnEventType } from '../scripts/on-events/api.js';
 export type PostDeployConfirmation = Endpoint<{
     Method: 'POST';
     Path: '/sync/deploy/confirmation';
     Body: {
-        flowConfigs: IncomingFlowConfig[];
+        flowConfigs: CLIDeployFlowConfig[];
         onEventScriptsByProvider?: OnEventScriptsByProvider[] | undefined;
         reconcile: boolean;
         debug: boolean;
@@ -20,7 +20,7 @@ export type PostDeploy = Endpoint<{
     Method: 'POST';
     Path: '/sync/deploy';
     Body: {
-        flowConfigs: IncomingFlowConfig[];
+        flowConfigs: CLIDeployFlowConfig[];
         onEventScriptsByProvider?: OnEventScriptsByProvider[] | undefined;
         nangoYamlBody: string;
         reconcile: boolean;
@@ -37,7 +37,7 @@ export type PostDeployInternal = Endpoint<{
         customEnvironment: string;
     };
     Body: {
-        flowConfigs: IncomingFlowConfig[];
+        flowConfigs: CLIDeployFlowConfig[];
         onEventScriptsByProvider?: OnEventScriptsByProvider[] | undefined;
         nangoYamlBody: string;
         reconcile: boolean;

package/dist/deploy/incomingFlow.d.ts

@@ -25,20 +25,16 @@ export interface LegacySyncModelSchema {
         type: string;
     }[];
 }
-interface InternalIncomingPreBuiltFlowConfig {
+export interface PreBuiltFlowConfig {
     type: ScriptTypeLiteral;
     models: string[];
     runs: string | null;
-    auto_start?: boolean;
+    auto_start?: boolean | undefined;
     attributes?: object | undefined;
     metadata?: NangoConfigMetadata | undefined;
     model_schema: string | NangoModel[];
-    input?: string | LegacySyncModelSchema | undefined;
-    endpoints?: (NangoSyncEndpointV2 | NangoSyncEndpointOld)[] | undefined;
     track_deletes: boolean;
     providerConfigKey: string;
-}
-export interface IncomingPreBuiltFlowConfig extends InternalIncomingPreBuiltFlowConfig {
     provider: string;
     is_public: boolean;
     public_route: string;
@@ -47,15 +43,29 @@ export interface IncomingPreBuiltFlowConfig extends InternalIncomingPreBuiltFlow
     nango_config_id?: number;
     fileBody?: IncomingScriptFiles;
     endpoints: NangoSyncEndpointV2[];
+    input?: NangoModel | LegacySyncModelSchema | undefined;
 }
-export interface IncomingFlowConfig extends InternalIncomingPreBuiltFlowConfig {
+export interface CLIDeployFlowConfig {
+    type: ScriptTypeLiteral;
+    models: string[];
+    runs: string | null;
+    auto_start?: boolean;
+    attributes?: object | undefined;
+    metadata?: NangoConfigMetadata | undefined;
+    model_schema: string | NangoModel[];
+    endpoints?: (NangoSyncEndpointV2 | NangoSyncEndpointOld)[] | undefined;
+    track_deletes: boolean;
+    providerConfigKey: string;
+    input?: string | undefined;
     syncName: string;
     fileBody: IncomingScriptFiles;
     version?: string | undefined;
     sync_type?: SyncTypeLiteral | undefined;
     webhookSubscriptions?: string[] | undefined;
 }
-export type CleanedIncomingFlowConfig = Merge<IncomingFlowConfig, {
+/**
+ * Flow shape after being sent by the CLI and cleaned in the backend
+ */
+export type CleanedIncomingFlowConfig = Merge<CLIDeployFlowConfig, {
     endpoints: NangoSyncEndpointV2[];
 }>;
-export {};

package/dist/deploy/index.d.ts

@@ -9,6 +9,7 @@ export interface SyncDeploymentResult {
     input?: string | LegacySyncModelSchema | undefined | null;
     models: string | string[];
     id?: number | undefined;
+    runs?: string | null;
     /** @deprecated legacy **/
     sync_name?: string;
     /** @deprecated legacy **/

package/dist/flow/index.d.ts

@@ -0,0 +1,35 @@
+import type { JSONSchema7 } from 'json-schema';
+import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
+import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+export interface NangoSyncConfig {
+    name: string;
+    type?: ScriptTypeLiteral;
+    runs?: string | null;
+    auto_start?: boolean;
+    attributes?: object;
+    description?: string;
+    scopes?: string[];
+    metadata?: NangoConfigMetadata;
+    track_deletes?: boolean;
+    returns: string[];
+    models: NangoModel[] | LegacySyncModelSchema[];
+    endpoints: NangoSyncEndpointV2[];
+    is_public?: boolean | null;
+    pre_built?: boolean | null;
+    version?: string | null;
+    last_deployed?: string | null;
+    id?: number;
+    input?: NangoModel | LegacySyncModelSchema | undefined;
+    sync_type?: SyncTypeLiteral;
+    webhookSubscriptions?: string[];
+    enabled?: boolean;
+    json_schema: JSONSchema7 | null;
+    upgrade_version?: string;
+}
+export interface StandardNangoConfig {
+    providerConfigKey: string;
+    provider?: string;
+    syncs: NangoSyncConfig[];
+    actions: NangoSyncConfig[];
+    [`on-events`]: NangoSyncConfig[];
+}

package/dist/index.d.ts

@@ -24,9 +24,11 @@ export type * from './proxy/api.js';
 export type * from './scripts/on-events/db.js';
 export type * from './scripts/on-events/api.js';
 export type * from './scripts/syncs/api.js';
+export type * from './scripts/http.api.js';
 export type * from './slackNotifications/db.js';
 export type * from './notification/active-logs/db.js';
 export type * from './connection/api/get.js';
+export type * from './sync/api.js';
 export type * from './integration/api.js';
 export type * from './integration/db.js';
 export type * from './providers/provider.js';
@@ -52,6 +54,7 @@ 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';
+export type * from './flow/index.js';
 export type * from './utils.js';
 export type * from './web/env.js';
 export type * from './fleet/api.js';

package/dist/integration/api.d.ts

@@ -3,9 +3,7 @@ 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, SyncTypeLiteral } from '../nangoYaml';
-import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
-import type { JSONSchema7 } from 'json-schema';
+import type { NangoSyncConfig } from '../flow';
 export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider'>, ApiTimestamps> & {
     logo: string;
     display_name: string;
@@ -157,31 +155,6 @@ export type DeleteIntegration = Endpoint<{
         };
     };
 }>;
-export interface NangoSyncConfig {
-    name: string;
-    type?: ScriptTypeLiteral;
-    runs: string;
-    auto_start?: boolean;
-    attributes?: object;
-    description?: string;
-    scopes?: string[];
-    metadata?: NangoConfigMetadata;
-    track_deletes?: boolean;
-    returns: string[] | string;
-    models: any[];
-    endpoints: NangoSyncEndpointV2[];
-    is_public?: boolean | null;
-    pre_built?: boolean | null;
-    version?: string | null;
-    last_deployed?: string | null;
-    id?: number;
-    input?: NangoModel | LegacySyncModelSchema;
-    sync_type?: SyncTypeLiteral;
-    webhookSubscriptions?: string[];
-    enabled?: boolean;
-    json_schema: JSONSchema7 | null;
-    upgrade_version?: string;
-}
 export type GetIntegrationFlows = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/integrations/:providerConfigKey/flows';

package/dist/providers/provider.d.ts

@@ -59,6 +59,7 @@ export interface BaseProvider {
     authorization_url_skip_encode?: string[];
     access_token_url?: string;
     authorization_params?: Record<string, string>;
+    authorization_code_param_in_callback?: string;
     scope_separator?: string;
     default_scopes?: string[];
     token_url?: string | TokenUrlObject;

package/dist/proxy/api.d.ts

@@ -1,4 +1,3 @@
-import type { BasicApiCredentials, ApiKeyCredentials, AppCredentials, TbaCredentials, TableauCredentials, JwtCredentials, TwoStepCredentials, SignatureCredentials } from '../auth/api.js';
 import type { DBConnectionDecrypted } from '../connection/db.js';
 import type { HTTP_METHOD } from '../nangoYaml/index.js';
 import type { Provider } from '../providers/provider.js';
@@ -15,13 +14,12 @@ export interface ProxyFile {
 }
 export interface BaseProxyConfiguration {
     providerConfigKey: string;
-    connectionId: string;
     endpoint: string;
     retries?: number;
     data?: unknown;
     files?: ProxyFile[];
     headers?: Record<string, string>;
-    params?: string | Record<string, string | number>;
+    params?: string | Record<string, string | number | string[] | number[]>;
     baseUrlOverride?: string;
     responseType?: ResponseType | undefined;
     retryHeader?: RetryHeaderConfig;
@@ -32,19 +30,16 @@ export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
     method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' | 'get' | 'post' | 'patch' | 'put' | 'delete';
     paginate?: Partial<CursorPagination> | Partial<LinkPagination> | Partial<OffsetPagination>;
 }
+export type ConnectionForProxy = Pick<DBConnectionDecrypted, 'connection_id' | 'connection_config' | 'credentials' | 'metadata'>;
 export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfiguration {
-    decompress?: boolean;
+    decompress: boolean;
     method: HTTP_METHOD;
     providerName: string;
-    token: string | BasicApiCredentials | ApiKeyCredentials | AppCredentials | TbaCredentials | TableauCredentials | JwtCredentials | TwoStepCredentials | SignatureCredentials;
     provider: Provider;
-    connection: Pick<DBConnectionDecrypted, 'connection_id' | 'connection_config' | 'credentials' | 'metadata'>;
 }
 export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 export interface InternalProxyConfiguration {
     providerName: string;
-    connection: Pick<DBConnectionDecrypted, 'connection_id' | 'connection_config' | 'credentials' | 'metadata'>;
-    existingActivityLogId?: string | null | undefined;
 }
 export interface RetryHeaderConfig {
     at?: string;

package/dist/record/api.d.ts

@@ -30,6 +30,7 @@ export type GetPublicRecords = Endpoint<{
     Error: ApiError<'unknown_connection'>;
     Querystring: {
         model: string;
+        variant?: string | undefined;
         delta?: string | undefined;
         modified_after?: string | undefined;
         limit?: number | undefined;

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

@@ -0,0 +1,7 @@
+import type { Endpoint } from '../api';
+import type { StandardNangoConfig } from '../flow';
+export type GetPublicScriptsConfig = Endpoint<{
+    Method: 'GET';
+    Path: `/scripts/config`;
+    Success: StandardNangoConfig[];
+}>;

package/dist/sync/api.d.ts

@@ -0,0 +1,35 @@
+import type { ApiError, Endpoint } from '../api.js';
+export type PostSyncVariant = Endpoint<{
+    Method: 'POST';
+    Path: '/sync/:name/variant/:variant';
+    Body: {
+        provider_config_key: string;
+        connection_id: string;
+    };
+    Params: {
+        name: string;
+        variant: string;
+    };
+    Error: ApiError<'invalid_variant' | 'unknown_connection' | 'unknown_provider_config' | 'unknown_sync' | 'sync_variant_already_exists' | 'failed_sync_variant_creation'>;
+    Success: {
+        id: string;
+        name: string;
+        variant: string;
+    };
+}>;
+export type DeleteSyncVariant = Endpoint<{
+    Method: 'DELETE';
+    Path: '/sync/:name/variant/:variant';
+    Body: {
+        provider_config_key: string;
+        connection_id: string;
+    };
+    Params: {
+        name: string;
+        variant: string;
+    };
+    Error: ApiError<'invalid_variant' | 'unknown_connection' | 'failed_sync_variant_deletion'>;
+    Success: {
+        success: boolean;
+    };
+}>;

package/dist/webhooks/api.d.ts

@@ -12,6 +12,7 @@ export interface NangoSyncWebhookBodyBase extends NangoWebhookBase {
     connectionId: string;
     providerConfigKey: string;
     syncName: string;
+    syncVariant: string;
     model: string;
     syncType: 'INCREMENTAL' | 'INITIAL' | 'WEBHOOK';
 }

package/package.json

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