@nangohq/types 0.40.0 → 0.40.2

package/dist/api.d.ts

@@ -11,7 +11,7 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'>;
+export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'missing_auth_header'> | ApiError<'generic_error_support', undefined, string>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

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

@@ -0,0 +1,46 @@
+import type { Endpoint } from '../../api.js';
+export interface WebhookSettings {
+    alwaysSendWebhook: boolean;
+    sendAuthWebhook: boolean;
+    sendRefreshFailedWebhook: boolean;
+    sendSyncFailedWebhook: boolean;
+}
+export type UpdateWebhookSettings = 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';
+    Body: {
+        url: string;
+    };
+    Success: {
+        data: {
+            url: string;
+        };
+    };
+}>;

package/dist/environment/db.d.ts

@@ -35,3 +35,13 @@ export interface Environment extends Timestamps {
     slack_notifications: boolean;
     webhook_receive_url?: string;
 }
+export interface ExternalWebhook extends Timestamps {
+    id: number;
+    environment_id: number;
+    primary_url: string;
+    secondary_url: string;
+    on_sync_completion_always: boolean;
+    on_auth_creation: boolean;
+    on_auth_refresh_error: boolean;
+    on_sync_error: boolean;
+}

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export type * from './account/db.js';
 export type * from './user/api.js';
 export type * from './connection/api/metadata.js';
 export type * from './connection/db.js';
+export type * from './proxy/api.js';
 export type * from './environment/db.js';
 export type * from './scripts/post-connection/api.js';
 export type * from './scripts/post-connection/db.js';
@@ -21,3 +22,8 @@ export type * from './integration/db.js';
 export type * from './integration/template.js';
 export type * from './auth/api.js';
 export type * from './auth/db.js';
+export type * from './nangoYaml/index.js';
+export type * from './utils.js';
+export type * from './environment/db.js';
+export type * from './environment/api/webhook.js';
+export type * from './webhooks/api.js';

package/dist/logs/messages.d.ts

@@ -120,3 +120,4 @@ export type OperationRow = Pick<MessageRow, OperationRequired> & Omit<MessageRow
 export type MessageRowInsert = Pick<MessageRow, 'type' | 'message'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
     id?: string | undefined;
 };
+export type LogsBuffer = Pick<MessageRow, 'level' | 'message' | 'createdAt'> & Partial<Pick<MessageRow, 'error' | 'meta'>>;

package/dist/nangoYaml/index.d.ts

@@ -0,0 +1,106 @@
+export type HTTP_VERB = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+export type SyncTypeLiteral = 'incremental' | 'full';
+export interface NangoYamlV1 {
+    integrations: Record<string, Record<string, NangoYamlV1Integration>>;
+    models: NangoYamlModel;
+}
+export interface NangoYamlV1Integration {
+    type?: 'action' | 'sync';
+    returns?: string | string[];
+    description?: string;
+    runs?: string;
+    track_deletes?: boolean;
+    auto_start?: boolean;
+}
+export interface NangoYamlV2 {
+    integrations: Record<string, NangoYamlV2Integration>;
+    models: NangoYamlModel;
+}
+export interface NangoYamlV2Integration {
+    provider?: string;
+    syncs?: Record<string, NangoYamlV2IntegrationSync>;
+    actions?: Record<string, NangoYamlV2IntegrationAction>;
+    'post-connection-scripts'?: string[];
+}
+export interface NangoYamlV2IntegrationSync {
+    endpoint: string | string[];
+    output: string | string[];
+    description?: string;
+    sync_type?: SyncTypeLiteral;
+    track_deletes?: boolean;
+    auto_start?: boolean;
+    runs: string;
+    scopes?: string | string[];
+    input?: string;
+    'webhook-subscriptions'?: string | string[];
+}
+export interface NangoYamlV2IntegrationAction {
+    endpoint: string;
+    output?: string | string[];
+    description?: string;
+    scopes?: string | string[];
+    input?: string;
+}
+export interface NangoYamlModel {
+    [key: string]: NangoYamlModelFields;
+}
+export interface NangoYamlModelFields {
+    [key: string]: NangoYamlModelField;
+}
+export type NangoYamlModelField = boolean | number | string | null | string[] | NangoYamlModelFields;
+export type NangoYaml = NangoYamlV1 | NangoYamlV2;
+export interface NangoYamlParsed {
+    yamlVersion: 'v1' | 'v2';
+    integrations: NangoYamlParsedIntegration[];
+    models: Map<string, NangoModel>;
+}
+export interface NangoYamlParsedIntegration {
+    providerConfigKey: string;
+    syncs: ParsedNangoSync[];
+    actions: ParsedNangoAction[];
+    postConnectionScripts: string[];
+}
+export interface ParsedNangoSync {
+    name: string;
+    type: 'sync';
+    endpoints: NangoSyncEndpoint[];
+    description: string;
+    sync_type: SyncTypeLiteral;
+    track_deletes: boolean;
+    auto_start: boolean;
+    runs: string;
+    scopes: string[];
+    input: string | null;
+    output: string[] | null;
+    usedModels: string[];
+    webhookSubscriptions: string[];
+}
+export interface ParsedNangoAction {
+    name: string;
+    type: 'action';
+    description: string;
+    input: string | null;
+    output: string[] | null;
+    endpoint: NangoSyncEndpoint | null;
+    scopes: string[];
+    usedModels: string[];
+}
+export type LayoutMode = 'root' | 'nested';
+export interface NangoModel {
+    name: string;
+    fields: NangoModelField[];
+    isAnon?: boolean;
+}
+export interface NangoModelField {
+    name: string;
+    value: string | number | boolean | null | undefined | NangoModelField[];
+    dynamic?: boolean;
+    tsType?: boolean;
+    model?: boolean;
+    array?: boolean;
+    union?: boolean;
+    optional?: boolean;
+}
+export type NangoSyncEndpoint = {
+    [key in HTTP_VERB]?: string;
+};

package/dist/proxy/api.d.ts

@@ -3,7 +3,7 @@ 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';
-interface BaseProxyConfiguration {
+export interface BaseProxyConfiguration {
     providerConfigKey: string;
     connectionId: string;
     endpoint: string;
@@ -62,4 +62,3 @@ export interface LinkPagination extends Pagination {
 export interface OffsetPagination extends Pagination {
     offset_name_in_request: string;
 }
-export {};

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+export type MaybePromise<T> = Promise<T> | T;
+export type LogMethod = (...args: any[]) => any;
+export interface Logger {
+    error: LogMethod;
+    warn: LogMethod;
+    info: LogMethod;
+    debug: LogMethod;
+    child: (...message: any[]) => Logger;
+}

package/dist/webhooks/api.d.ts

@@ -0,0 +1,49 @@
+import type { AuthOperationType, AuthModeType } from '../auth/api.js';
+import type { SyncResult, SyncType } from '../scripts/syncs/api.js';
+import type { ErrorPayload } from '../api.js';
+export type WebhookTypes = 'sync' | 'auth' | 'forward';
+export interface NangoSyncWebhookBody {
+    from: string;
+    type: 'sync';
+    connectionId: string;
+    providerConfigKey: string;
+    syncName: string;
+    model: string;
+    syncType: SyncType;
+}
+export interface NangoSyncWebhookBodySuccess extends NangoSyncWebhookBody {
+    modifiedAfter: string;
+    responseResults: SyncResult;
+    success: true;
+    queryTimeStamp: string | null;
+}
+export interface NangoSyncWebhookBodyError {
+    success: false;
+    error: ErrorPayload;
+    startedAt: string;
+    failedAt: string;
+}
+export interface NangoAuthWebhookBody {
+    from: string;
+    type: 'auth';
+    connectionId: string;
+    authMode: AuthModeType;
+    providerConfigKey: string;
+    provider: string;
+    environment: string;
+    operation: AuthOperationType;
+}
+export interface NangoAuthWebhookBodySuccess extends NangoAuthWebhookBody {
+    success: true;
+}
+export interface NangoAuthWebhookBodyError extends NangoAuthWebhookBody {
+    success: false;
+    error: ErrorPayload;
+}
+export interface NangoForwardWebhookBody {
+    from: string;
+    type: WebhookTypes;
+    connectionId?: string;
+    providerConfigKey: string;
+    payload: unknown;
+}

package/package.json

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