@nangohq/types 0.42.10 → 0.42.12

package/dist/api.endpoints.d.ts

@@ -7,8 +7,12 @@ import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api';
 import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup } from './account/api';
 import type { DeleteInvite, PostInvite } from './invitations/api';
 import type { GetUser, PatchUser } from './user/api';
-import type { GetListIntegrations } from './integration/api';
-export type APIEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | GetListIntegrations;
+import type { DeletePublicIntegration, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy } from './integration/api';
+import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api';
+import type { GetPublicProvider, GetPublicProviders } from './providers/api';
+export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration;
+export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus;
+export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path
  */

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

@@ -1,43 +1,62 @@
 import type { ApiError, Endpoint } from '../api';
-import type { ConnectionConfig } from '../connection/db';
-export type TbaAuthorization = Endpoint<{
+export type PostPublicTbaAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
         token_id: string;
         token_secret: string;
-        oauth_client_id_override?: string;
-        oauth_client_secret_override?: string;
+        oauth_client_id_override?: string | undefined;
+        oauth_client_secret_override?: string | undefined;
     };
-    QueryParams: {
-        connectionId: string;
-        connectionConfig: ConnectionConfig;
+    Querystring: {
+        connection_id?: string | undefined;
+        public_key: string;
+        params?: Record<string, any> | undefined;
+        hmac?: string | undefined;
     };
     Params: {
         providerConfigKey: string;
     };
     Path: '/auth/tba';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    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;
     };
 }>;
-export type TableauAuthorization = Endpoint<{
+export type PostPublicTableauAuthorization = Endpoint<{
     Method: 'POST';
     Body: {
         pat_name: string;
         pat_secret: string;
-        content_url?: string;
+        content_url?: string | undefined;
     };
-    QueryParams: {
-        connectionId: string;
-        connectionConfig: ConnectionConfig;
+    Querystring: {
+        connection_id?: string | undefined;
+        public_key: string;
+        params?: Record<string, any> | undefined;
+        hmac?: string | undefined;
     };
     Params: {
         providerConfigKey: string;
     };
     Path: '/auth/tableau';
-    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'invalid_auth_mode'> | ApiError<'invalid_credentials'>;
+    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;
+    };
+}>;
+export type PostPublicUnauthenticatedAuthorization = Endpoint<{
+    Method: 'POST';
+    Querystring: {
+        connection_id?: string | undefined;
+        hmac?: string | undefined;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/auth/unauthenticated';
+    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/index.d.ts

@@ -18,6 +18,7 @@ export type * from './syncConfigs/db.js';
 export type * from './syncConfigs/api.js';
 export type * from './team/api.js';
 export type * from './team/db.js';
+export type * from './providers/api.js';
 export type * from './proxy/api.js';
 export type * from './environment/db.js';
 export type * from './scripts/post-connection/db.js';
@@ -27,7 +28,7 @@ export type * from './notification/active-logs/db.js';
 export type * from './connection/api/get.js';
 export type * from './integration/api.js';
 export type * from './integration/db.js';
-export type * from './integration/template.js';
+export type * from './providers/provider.js';
 export type * from './auth/api.js';
 export type * from './auth/db.js';
 export type * from './auth/http.api.js';

package/dist/integration/api.d.ts

@@ -1,23 +1,46 @@
 import type { Merge } from 'type-fest';
 import type { ApiTimestamps, Endpoint } from '../api';
 import type { IntegrationConfig } from './db';
-import type { Template } from './template';
+import type { Provider } from '../providers/provider';
 import type { AuthModeType } from '../auth/api';
 import type { NangoModel, NangoSyncEndpoint, ScriptTypeLiteral } from '../nangoYaml';
 import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
 import type { JSONSchema7 } from 'json-schema';
 import type { SyncType } from '../scripts/syncs/api';
-export type GetListIntegrations = Endpoint<{
+export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider'>, ApiTimestamps> & {
+    logo: string;
+} & ApiPublicIntegrationInclude;
+export interface ApiPublicIntegrationInclude {
+    webhook_url?: string | null;
+}
+export type GetPublicListIntegrationsLegacy = Endpoint<{
     Method: 'GET';
     Path: '/config';
     Success: {
-        configs: {
-            provider: string;
-            unique_key: string;
-        }[];
+        configs: ApiPublicIntegration[];
+    };
+}>;
+export type GetPublicListIntegrations = Endpoint<{
+    Method: 'GET';
+    Path: '/integrations';
+    Success: {
+        data: ApiPublicIntegration[];
+    };
+}>;
+export type GetPublicIntegration = Endpoint<{
+    Method: 'GET';
+    Path: '/integrations/:uniqueKey';
+    Params: {
+        uniqueKey: string;
+    };
+    Querystring: {
+        include?: 'webhook'[] | undefined;
+    };
+    Success: {
+        data: ApiPublicIntegration;
     };
 }>;
-export type DeleteIntegrationPublic = Endpoint<{
+export type DeletePublicIntegration = Endpoint<{
     Method: 'DELETE';
     Path: '/config/:providerConfigKey';
     Params: {
@@ -47,7 +70,7 @@ export type GetIntegration = Endpoint<{
     Success: {
         data: {
             integration: ApiIntegration;
-            template: Template;
+            template: Provider;
             meta: {
                 connectionsCount: number;
                 webhookUrl: string | null;

package/dist/providers/api.d.ts

@@ -0,0 +1,25 @@
+import type { Endpoint } from '../api';
+import type { Provider } from './provider';
+export type GetPublicProviders = Endpoint<{
+    Method: 'GET';
+    Path: `/providers`;
+    Querystring: {
+        search?: string | undefined;
+    };
+    Success: {
+        data: ApiProvider[];
+    };
+}>;
+export type ApiProvider = Provider & {
+    name: string;
+};
+export type GetPublicProvider = Endpoint<{
+    Method: 'GET';
+    Path: `/providers/:provider`;
+    Params: {
+        provider: string;
+    };
+    Success: {
+        data: ApiProvider;
+    };
+}>;

package/dist/{integration/template.d.ts → providers/provider.d.ts}

@@ -12,7 +12,13 @@ export interface TokenUrlObject {
     APP?: string;
     NONE?: string;
 }
-export interface Template {
+export interface ProviderAlias {
+    alias?: string;
+    proxy: {
+        base_url?: string;
+    };
+}
+export interface BaseProvider {
     auth_mode: AuthModeType;
     proxy?: {
         base_url: string;
@@ -49,7 +55,7 @@ export interface Template {
     categories?: string[];
     connection_configuration?: string[];
 }
-export interface TemplateOAuth2 extends Template {
+export interface ProviderOAuth2 extends BaseProvider {
     auth_mode: 'OAUTH2' | 'CUSTOM';
     disable_pkce?: boolean;
     token_params?: {
@@ -64,7 +70,7 @@ export interface TemplateOAuth2 extends Template {
     expires_in_unit?: 'milliseconds';
     token_request_auth_method?: 'basic' | 'custom';
 }
-export interface TemplateOAuth1 extends Template {
+export interface ProviderOAuth1 extends BaseProvider {
     auth_mode: 'OAUTH1';
     request_url: string;
     request_params?: Record<string, string>;
@@ -72,3 +78,4 @@ export interface TemplateOAuth1 extends Template {
     token_http_method?: 'GET' | 'PUT' | 'POST';
     signature_method: 'HMAC-SHA1' | 'RSA-SHA1' | 'PLAINTEXT';
 }
+export type Provider = BaseProvider | ProviderOAuth1 | ProviderOAuth2;

package/dist/proxy/api.d.ts

@@ -2,7 +2,7 @@ import type { ParamsSerializerOptions } from 'axios';
 import type { EndpointMethod } from '../api.js';
 import type { BasicApiCredentials, ApiKeyCredentials, AppCredentials } from '../auth/api.js';
 import type { Connection } from '../connection/db.js';
-import type { Template as ProviderTemplate } from '../integration/template.js';
+import type { Provider } from '../providers/provider.js';
 export interface BaseProxyConfiguration {
     providerConfigKey: string;
     connectionId: string;
@@ -25,16 +25,16 @@ export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
 export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfiguration {
     decompress?: boolean;
     method: EndpointMethod;
-    provider: string;
+    providerName: string;
     token: string | BasicApiCredentials | ApiKeyCredentials | AppCredentials;
-    template: ProviderTemplate;
+    provider: Provider;
     connection: Connection;
 }
 export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
 export interface InternalProxyConfiguration {
-    provider: string;
+    providerName: string;
     connection: Connection;
-    existingActivityLogId?: number | null;
+    existingActivityLogId?: string | null | undefined;
 }
 export interface RetryHeaderConfig {
     at?: string;

package/package.json

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