@nangohq/types 0.39.27 → 0.39.29

package/dist/api.d.ts

@@ -10,12 +10,12 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', 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'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type
  */
-export interface Endpoint<T extends {
+export interface EndpointDefinition {
     Method: EndpointMethod;
     Path: string;
     Params?: Record<string, any>;
@@ -23,7 +23,8 @@ export interface Endpoint<T extends {
     Querystring?: Record<string, any>;
     Error?: ApiError<any> | never;
     Success: Record<string, any> | never;
-}> {
+}
+export interface Endpoint<T extends EndpointDefinition> {
     Method: T['Method'];
     Path: T['Path'];
     /**
@@ -49,7 +50,7 @@ export interface Endpoint<T extends {
     /**
      * Response body for any error
      */
-    Errors: ResDefaultErrors | T['Error'];
+    Errors: T['Error'] extends ApiError<any> ? ResDefaultErrors | T['Error'] : ResDefaultErrors;
     /**
      * Response body (success + error)
      */

package/dist/api.endpoints.d.ts

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

package/dist/connection/api/metadata.d.ts

@@ -0,0 +1,23 @@
+import type { ApiError, Endpoint } from '../../api';
+import type { Metadata } from '../db';
+export interface MetadataBody {
+    connection_id: string | string[];
+    provider_config_key: string;
+    metadata: Metadata;
+}
+type MetadataError = ApiError<'invalid_body'> | ApiError<'unknown_connection'>;
+export type SetMetadata = Endpoint<{
+    Method: 'POST';
+    Body: MetadataBody;
+    Path: '/connection/metadata';
+    Error: MetadataError;
+    Success: MetadataBody;
+}>;
+export type UpdateMetadata = Endpoint<{
+    Method: 'PATCH';
+    Path: '/connection/metadata';
+    Body: MetadataBody;
+    Error: MetadataError;
+    Success: MetadataBody;
+}>;
+export {};

package/dist/connection/db.d.ts

@@ -0,0 +1 @@
+export type Metadata = Record<string, unknown>;

package/dist/index.d.ts

@@ -6,3 +6,5 @@ export type * from './onboarding/api.js';
 export type * from './record/api.js';
 export type * from './logs/api.js';
 export type * from './logs/messages.js';
+export type * from './connection/api/metadata.js';
+export type * from './connection/db.js';

package/dist/logs/api.d.ts

@@ -1,4 +1,4 @@
-import type { ApiError, Endpoint } from '../api';
+import type { Endpoint } from '../api';
 import type { MessageState, OperationRow } from './messages';
 export type SearchLogs = Endpoint<{
     Method: 'POST';
@@ -10,7 +10,6 @@ export type SearchLogs = Endpoint<{
         limit?: number;
         states?: SearchLogsState[];
     };
-    Error: ApiError<'invalid_query_params'>;
     Success: {
         data: OperationRow[];
         pagination: {
@@ -20,3 +19,16 @@ export type SearchLogs = Endpoint<{
 }>;
 export type SearchLogsState = 'all' | MessageState;
 export type SearchLogsData = SearchLogs['Success']['data'][0];
+export type GetOperation = Endpoint<{
+    Method: 'GET';
+    Path: `/api/v1/logs/operations/:operationId`;
+    Querystring: {
+        env: string;
+    };
+    Params: {
+        operationId: string;
+    };
+    Success: {
+        data: OperationRow;
+    };
+}>;

package/package.json

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