@nangohq/types 0.42.22 → 0.44.0

package/dist/auth/api.d.ts

@@ -13,6 +13,7 @@ export interface AuthModes {
     Jwt: 'JWT';
     Bill: 'BILL';
     TwoStep: 'TWO_STEP';
+    Signature: 'SIGNATURE';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
 export interface AuthOperation {
@@ -142,9 +143,16 @@ export interface TwoStepCredentials extends CredentialsCommon {
     token?: string;
     expires_at?: Date | undefined;
 }
+export interface SignatureCredentials {
+    type: AuthModes['Signature'];
+    username: string;
+    password: string;
+    token?: string;
+    expires_at?: Date | undefined;
+}
 export type UnauthCredentials = Record<string, never>;
 export type RefreshTokenResponse = AuthorizationTokenResponse;
 export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'type' | 'raw'> {
     expires_in?: number;
 }
-export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials | JwtCredentials | BillCredentials | TwoStepCredentials;
+export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | TableauCredentials | JwtCredentials | BillCredentials | TwoStepCredentials | SignatureCredentials;

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

@@ -126,3 +126,24 @@ export type PostPublicTwoStepAuthorization = Endpoint<{
         connectionId: string;
     };
 }>;
+export type PostPublicSignatureAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: {
+        username: string;
+        password: string;
+    };
+    Querystring: {
+        connection_id?: string | undefined;
+        params?: Record<string, any> | undefined;
+        hmac?: string | undefined;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/auth/signature-based';
+    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'unknown_provider_template'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    Success: {
+        providerConfigKey: string;
+        connectionId: string;
+    };
+}>;

package/dist/deploy/api.d.ts

@@ -1,6 +1,7 @@
 import type { JSONSchema7 } from 'json-schema';
 import type { Endpoint, ApiError } from '../api.js';
 import type { IncomingFlowConfig, PostConnectionScriptByProvider } from './incomingFlow.js';
+import type { SyncDeploymentResult } from './index.js';
 export type PostDeployConfirmation = Endpoint<{
     Method: 'POST';
     Path: '/sync/deploy/confirmation';
@@ -26,7 +27,7 @@ export type PostDeploy = Endpoint<{
         singleDeployMode?: boolean;
         jsonSchema?: JSONSchema7 | undefined;
     };
-    Success: any[];
+    Success: SyncDeploymentResult[];
 }>;
 export type PostDeployInternal = Endpoint<{
     Method: 'POST';
@@ -44,7 +45,7 @@ export type PostDeployInternal = Endpoint<{
         jsonSchema?: JSONSchema7 | undefined;
     };
     Error: ApiError<'forbidden'> | ApiError<'environment_creation_error'>;
-    Success: any[];
+    Success: SyncDeploymentResult[];
 }>;
 export interface SlimSync {
     id?: number;

package/dist/deploy/index.d.ts

@@ -0,0 +1,16 @@
+import type { ScriptTypeLiteral } from '../nangoYaml';
+import type { LegacySyncModelSchema } from './incomingFlow';
+export interface SyncDeploymentResult {
+    name: string;
+    version?: string;
+    providerConfigKey: string;
+    type: ScriptTypeLiteral;
+    last_deployed?: Date;
+    input?: string | LegacySyncModelSchema | undefined;
+    models: string | string[];
+    id?: number | undefined;
+    /** @deprecated legacy **/
+    sync_name?: string;
+    /** @deprecated legacy **/
+    syncName?: string;
+}

package/dist/endpoints/db.d.ts

@@ -0,0 +1,12 @@
+import type { SetOptional } from 'type-fest';
+import type { Timestamps } from '../db';
+import type { HTTP_METHOD } from '../nangoYaml';
+export interface DBSyncEndpoint extends Timestamps {
+    id: number;
+    sync_config_id: number;
+    method: HTTP_METHOD;
+    path: string;
+    model: string | null;
+    group_name: string | null;
+}
+export type DBSyncEndpointCreate = SetOptional<Omit<DBSyncEndpoint, 'id'>, 'model' | 'group_name'>;

package/dist/index.d.ts

@@ -34,7 +34,9 @@ export type * from './auth/api.js';
 export type * from './auth/db.js';
 export type * from './auth/http.api.js';
 export type * from './deploy/api.js';
+export type * from './deploy/index.js';
 export type * from './deploy/incomingFlow.js';
+export type * from './endpoints/db.js';
 export type * from './connect/api.js';
 export type * from './connect/session.js';
 export type * from './endUser/index.js';

package/dist/logs/api.d.ts

@@ -1,4 +1,5 @@
 import type { Endpoint } from '../api';
+import type { PickFromUnion } from '../utils';
 import type { MessageRow, MessageState, OperationList, OperationRow } from './messages';
 type Concat<T extends OperationList> = T extends {
     action: string;
@@ -101,7 +102,7 @@ export type PostInsights = Endpoint<{
         env: string;
     };
     Body: {
-        type: 'action' | 'sync' | 'proxy' | 'webhook_external';
+        type: PickFromUnion<ConcatOperationListWithGroup, 'action' | 'sync' | 'proxy' | 'webhook:incoming'>;
     };
     Success: {
         data: {

package/dist/logs/messages.d.ts

@@ -47,7 +47,7 @@ export interface OperationAdmin {
 }
 export interface OperationWebhook {
     type: 'webhook';
-    action: 'incoming' | 'outgoing';
+    action: 'incoming' | 'forward';
 }
 export interface OperationDeploy {
     type: 'deploy';

package/dist/nangoYaml/index.d.ts

@@ -19,6 +19,11 @@ export interface NangoYamlV2 {
     integrations: Record<string, NangoYamlV2Integration>;
     models: NangoYamlModel;
 }
+export interface NangoYamlV2Endpoint {
+    method?: HTTP_METHOD;
+    path: string;
+    group?: string | undefined;
+}
 export interface NangoYamlV2Integration {
     provider?: string;
     syncs?: Record<string, NangoYamlV2IntegrationSync>;
@@ -26,7 +31,7 @@ export interface NangoYamlV2Integration {
     'post-connection-scripts'?: string[];
 }
 export interface NangoYamlV2IntegrationSync {
-    endpoint: string | string[] | NangoSyncEndpointV2 | NangoSyncEndpointV2[];
+    endpoint: string | string[] | NangoYamlV2Endpoint | NangoYamlV2Endpoint[];
     output: string | string[];
     description?: string;
     sync_type?: SyncTypeLiteral;
@@ -39,7 +44,7 @@ export interface NangoYamlV2IntegrationSync {
     version?: string;
 }
 export interface NangoYamlV2IntegrationAction {
-    endpoint: string;
+    endpoint: string | NangoYamlV2Endpoint;
     output?: string | string[];
     description?: string;
     scopes?: string | string[];
@@ -114,4 +119,5 @@ export type NangoSyncEndpointOld = {
 export interface NangoSyncEndpointV2 {
     method: HTTP_METHOD;
     path: string;
+    group?: string | undefined;
 }

package/dist/providers/provider.d.ts

@@ -25,12 +25,14 @@ export interface SimplifiedJSONSchema {
     example?: string;
     pattern?: string;
     optional?: boolean;
-    format?: string;
+    format?: 'hostname' | 'uri' | 'uuid' | 'email';
     order: number;
     default_value?: string;
     hidden?: string;
+    prefix?: string;
     suffix?: string;
     doc_section?: string;
+    secret?: string;
 }
 export interface BaseProvider {
     display_name: string;
@@ -120,4 +122,12 @@ export interface ProviderTwoStep extends BaseProvider {
     token_expires_in_ms?: number;
     proxy_header_authorization?: string;
 }
-export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep;
+export interface ProviderSignature extends BaseProvider {
+    signature: {
+        protocol: 'WSSE';
+    };
+    token: {
+        expires_in_ms: number;
+    };
+}
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2 | ProviderJwt | ProviderTwoStep | ProviderSignature;

package/dist/utils.d.ts

@@ -8,3 +8,6 @@ export interface Logger {
     debug: LogMethod;
     child: (...message: any[]) => Logger;
 }
+type ValidateSelection<T, U> = U extends T ? U : never;
+export type PickFromUnion<T, U extends T> = ValidateSelection<T, U>;
+export {};

package/package.json

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