@nangohq/types 0.39.23 → 0.39.24

package/dist/api.d.ts

@@ -1,19 +1,31 @@
-export interface ApiError<TCode extends string> {
+export interface ApiError<TCode extends string, TErrors = undefined> {
     error: {
         code: TCode;
         message?: string | undefined;
+        errors?: TErrors;
     };
 }
+export interface ValidationError {
+    code: string;
+    message: string;
+    path: (string | number)[];
+}
+export type ResDefaultErrors = ApiError<'not_found'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_body', ValidationError[]>;
+export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type
  */
 export interface Endpoint<T extends {
+    Method: EndpointMethod;
+    Path: string;
     Params?: Record<string, any>;
     Body?: Record<string, any>;
     Querystring?: Record<string, any>;
     Error?: ApiError<any> | never;
     Success: Record<string, any> | never;
 }> {
+    Method: T['Method'];
+    Path: T['Path'];
     /**
      * URL params
      */
@@ -41,5 +53,5 @@ export interface Endpoint<T extends {
     /**
      * Response body (success + error)
      */
-    Reply: T['Error'] extends ApiError<any> ? T['Error'] | T['Success'] : T['Success'];
+    Reply: ResDefaultErrors | (T['Error'] extends ApiError<any> ? T['Error'] | T['Success'] : T['Success']);
 }

package/dist/api.endpoints.d.ts

@@ -0,0 +1,17 @@
+import type { EndpointMethod } from './api';
+import type { GetOnboardingStatus } from './onboarding/api';
+export type APIEndpoints = GetOnboardingStatus;
+/**
+ * Automatically narrow endpoints type with Method + Path
+ */
+export type APIEndpointsPicker<TMethod extends EndpointMethod, TPath extends APIEndpoints['Path']> = Extract<APIEndpoints, {
+    Method: TMethod;
+    Path: TPath;
+}>;
+/**
+ * Automatically narrow endpoints type with Path
+ * Useful to get allowed methods
+ */
+export type APIEndpointsPickerWithPath<TPath extends APIEndpoints['Path']> = Extract<APIEndpoints, {
+    Path: TPath;
+}>;

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export type * from './db.js';
+export type * from './api.js';
+export type * from './api.endpoints.js';
 export type * from './onboarding/db.js';
 export type * from './onboarding/api.js';
 export type * from './record/api.js';

package/dist/onboarding/api.d.ts

@@ -1,8 +1,10 @@
 import type { ApiError, Endpoint } from '../api';
 import type { NangoRecord } from '../record/api';
 export type GetOnboardingStatus = Endpoint<{
-    Params: {
-        foo: 'bar';
+    Method: 'GET';
+    Path: '/api/v1/onboarding';
+    Querystring: {
+        env: string;
     };
     Error: ApiError<'onboarding_dev_only'> | ApiError<'no_onboarding'> | ApiError<'failed_to_get_records'> | ApiError<'invalid_query_params'>;
     Success: {

package/package.json

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