@nangohq/types 0.40.5 → 0.40.7

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'> | ApiError<'missing_auth_header'> | ApiError<'generic_error_support', undefined, string>;
+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> | ApiError<'server_error'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/api.endpoints.d.ts

@@ -2,7 +2,8 @@ import type { EndpointMethod } from './api';
 import type { GetOperation, SearchFilters, SearchMessages, SearchOperations } from './logs/api';
 import type { GetOnboardingStatus } from './onboarding/api';
 import type { SetMetadata, UpdateMetadata } from './connection/api/metadata';
-export type APIEndpoints = SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata;
+import type { PostDeploy, PostDeployConfirmation } from './deploy/api';
+export type APIEndpoints = SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus | SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation;
 /**
  * Automatically narrow endpoints type with Method + Path
  */

package/dist/auth/api.d.ts

@@ -9,6 +9,7 @@ export interface AuthModes {
     Custom: 'CUSTOM';
     App: 'APP';
     None: 'NONE';
+    TBA: 'TBA';
 }
 export type AuthModeType = AuthModes[keyof AuthModes];
 export interface AuthOperation {
@@ -94,6 +95,13 @@ export interface CredentialsRefresh<T = unknown> {
     connectionId: string;
     promise: Promise<T>;
 }
+export interface TbaCredentials {
+    type: AuthModes['TBA'];
+    token: string;
+    secret: string;
+    oauth_client_id: string;
+    oauth_client_secret: string;
+}
 export type UnauthCredentials = Record<string, never>;
 export type RefreshTokenResponse = AuthorizationTokenResponse;
 export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'type' | 'raw'> {

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

@@ -0,0 +1,19 @@
+import type { ApiError, Endpoint } from '../api';
+import type { ConnectionConfig } from '../connection/db';
+export type TbaAuthorization = Endpoint<{
+    Method: 'POST';
+    Body: {
+        token_id: string;
+        token_secret: string;
+    };
+    QueryParams: {
+        connectionId: string;
+        connectionConfig: ConnectionConfig;
+    };
+    Params: {
+        providerConfigKey: string;
+    };
+    Path: '/auth/tba';
+    Error: ApiError<'invalid_body'> | ApiError<'invalid_query_params'> | ApiError<'unknown_provider_config'> | ApiError<'invalid_auth_mode'> | ApiError<'missing_token_url'> | ApiError<'no_data_returned_from_token_request'> | ApiError<'missing_connection_config_param'>;
+    Success: never;
+}>;

package/dist/connection/db.d.ts

@@ -1,5 +1,5 @@
 import type { TimestampsAndDeleted } from '../db.js';
-import type { AuthCredentials, ApiKeyCredentials, BasicApiCredentials, AppCredentials, AppStoreCredentials, UnauthCredentials, CustomCredentials, AuthModeType, AuthOperationType } from '../auth/api.js';
+import type { AuthCredentials, ApiKeyCredentials, BasicApiCredentials, AppCredentials, AppStoreCredentials, UnauthCredentials, CustomCredentials, TbaCredentials, AuthModeType, AuthOperationType } from '../auth/api.js';
 import type { Environment } from '../environment/db.js';
 import type { Account } from '../account/db.js';
 export type Metadata = Record<string, unknown>;
@@ -20,7 +20,7 @@ export interface StoredConnection extends BaseConnection {
     credentials: Record<string, any>;
 }
 export interface Connection extends BaseConnection {
-    credentials: AuthCredentials | ApiKeyCredentials | BasicApiCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials;
+    credentials: AuthCredentials | ApiKeyCredentials | BasicApiCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials;
 }
 export type RecentlyCreatedConnection = Pick<StoredConnection, 'id' | 'connection_id' | 'provider_config_key'> & {
     auth_mode: AuthModeType;

package/dist/deploy/api.d.ts

@@ -0,0 +1,50 @@
+import type { JSONSchema7 } from 'json-schema';
+import type { Endpoint } from '../api.js';
+import type { IncomingFlowConfig, PostConnectionScriptByProvider } from './incomingFlow.js';
+export type PostDeployConfirmation = Endpoint<{
+    Method: 'POST';
+    Path: '/sync/deploy/confirmation';
+    Body: {
+        flowConfigs: IncomingFlowConfig[];
+        postConnectionScriptsByProvider: PostConnectionScriptByProvider[];
+        reconcile: boolean;
+        debug: boolean;
+        singleDeployMode?: boolean;
+        jsonSchema?: JSONSchema7 | undefined;
+    };
+    Success: SyncAndActionDifferences;
+}>;
+export type PostDeploy = Endpoint<{
+    Method: 'POST';
+    Path: '/sync/deploy';
+    Body: {
+        flowConfigs: IncomingFlowConfig[];
+        postConnectionScriptsByProvider: PostConnectionScriptByProvider[];
+        nangoYamlBody: string;
+        reconcile: boolean;
+        debug: boolean;
+        singleDeployMode?: boolean;
+        jsonSchema?: JSONSchema7 | undefined;
+    };
+    Success: any[];
+}>;
+export interface SlimSync {
+    id?: number;
+    name: string;
+    auto_start: boolean;
+    sync_id?: string | null;
+    providerConfigKey: string;
+    connections?: number;
+    enabled?: boolean;
+}
+export interface SlimAction {
+    id?: number;
+    providerConfigKey: string;
+    name: string;
+}
+export interface SyncAndActionDifferences {
+    newSyncs: SlimSync[];
+    deletedSyncs: SlimSync[];
+    newActions: SlimAction[];
+    deletedActions: SlimAction[];
+}

package/dist/deploy/incomingFlow.d.ts

@@ -0,0 +1,55 @@
+import type { NangoModel, NangoSyncEndpoint, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml';
+export interface IncomingScriptFiles {
+    js: string;
+    ts: string;
+}
+export interface IncomingPostConnectionScript {
+    name: string;
+    fileBody: IncomingScriptFiles;
+}
+export interface PostConnectionScriptByProvider {
+    providerConfigKey: string;
+    scripts: IncomingPostConnectionScript[];
+}
+export interface NangoConfigMetadata {
+    scopes?: string[] | undefined;
+    description?: string | undefined;
+}
+export interface LegacySyncModelSchema {
+    name: string;
+    fields: {
+        name: string;
+        type: string;
+    }[];
+}
+interface InternalIncomingPreBuiltFlowConfig {
+    type: ScriptTypeLiteral;
+    models: string[];
+    runs: string;
+    auto_start?: boolean;
+    attributes?: object | undefined;
+    metadata?: NangoConfigMetadata | undefined;
+    model_schema: string | NangoModel[];
+    input?: string | LegacySyncModelSchema | undefined;
+    endpoints?: NangoSyncEndpoint[] | undefined;
+}
+export interface IncomingPreBuiltFlowConfig extends InternalIncomingPreBuiltFlowConfig {
+    provider: string;
+    is_public: boolean;
+    public_route?: string;
+    name: string;
+    syncName?: string;
+    nango_config_id?: number;
+    providerConfigKey?: string;
+    fileBody?: IncomingScriptFiles;
+}
+export interface IncomingFlowConfig extends InternalIncomingPreBuiltFlowConfig {
+    syncName: string;
+    providerConfigKey: string;
+    fileBody: IncomingScriptFiles;
+    version?: string | undefined;
+    track_deletes?: boolean;
+    sync_type?: SyncTypeLiteral | undefined;
+    webhookSubscriptions?: string[] | undefined;
+}
+export {};

package/dist/index.d.ts

@@ -13,7 +13,6 @@ 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';
 export type * from './scripts/syncs/api.js';
 export type * from './notification/active-logs/db.js';
@@ -22,8 +21,11 @@ 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 './auth/http.api.js';
+export type * from './deploy/api.js';
+export type * from './deploy/incomingFlow.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';
+export type * from './utils.js';

package/dist/integration/template.d.ts

@@ -31,6 +31,7 @@ export interface Template {
         };
     };
     authorization_url?: string;
+    access_token_url?: string;
     authorization_params?: Record<string, string>;
     scope_separator?: string;
     default_scopes?: string[];

package/dist/nangoYaml/index.d.ts

@@ -1,11 +1,13 @@
 export type HTTP_VERB = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export type SyncTypeLiteral = 'incremental' | 'full';
+export type ScriptFileType = 'actions' | 'syncs' | 'post-connection-scripts';
+export type ScriptTypeLiteral = 'action' | 'sync';
 export interface NangoYamlV1 {
     integrations: Record<string, Record<string, NangoYamlV1Integration>>;
     models: NangoYamlModel;
 }
 export interface NangoYamlV1Integration {
-    type?: 'action' | 'sync';
+    type?: ScriptTypeLiteral;
     returns?: string | string[];
     description?: string;
     runs?: string;
@@ -89,18 +91,18 @@ export type LayoutMode = 'root' | 'nested';
 export interface NangoModel {
     name: string;
     fields: NangoModelField[];
-    isAnon?: boolean;
+    isAnon?: boolean | undefined;
 }
 export interface NangoModelField {
     name: string;
-    value: string | number | boolean | null | undefined | NangoModelField[];
-    dynamic?: boolean;
-    tsType?: boolean;
-    model?: boolean;
-    array?: boolean;
-    union?: boolean;
-    optional?: boolean;
+    value: string | number | boolean | null | NangoModelField[];
+    dynamic?: boolean | undefined;
+    tsType?: boolean | undefined;
+    model?: boolean | undefined;
+    array?: boolean | undefined;
+    union?: boolean | undefined;
+    optional?: boolean | undefined;
 }
 export type NangoSyncEndpoint = {
-    [key in HTTP_VERB]?: string;
+    [key in HTTP_VERB]?: string | undefined;
 };

package/dist/notification/active-logs/db.d.ts

@@ -4,9 +4,8 @@ export interface ActiveLog extends Timestamps {
     type: string;
     action: string;
     connection_id: number;
-    activity_log_id: number;
     log_id: string;
     active: boolean;
     sync_id: string | null;
 }
-export type ActiveLogIds = Pick<ActiveLog, 'activity_log_id' | 'log_id'>;
+export type ActiveLogIds = Pick<ActiveLog, 'log_id'>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.40.5",
+    "version": "0.40.7",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -12,7 +12,9 @@
         "directory": "packages/utils"
     },
     "devDependencies": {
+        "@types/json-schema": "7.0.15",
         "axios": "^1.3.4",
+        "json-schema": "0.4.0",
         "type-fest": "4.14.0"
     },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",

package/dist/scripts/post-connection/api.d.ts

@@ -1,11 +0,0 @@
-export interface IncomingPostConnectionScript {
-    name: string;
-    fileBody: {
-        js: string;
-        ts: string;
-    };
-}
-export interface PostConnectionScriptByProvider {
-    providerConfigKey: string;
-    scripts: IncomingPostConnectionScript[];
-}