@nangohq/node 0.17.5-beta → 0.17.5

package/dist/index.d.ts

@@ -1,2 +1,50 @@
-import { Nango, NangoSync, NangoHelper, HubspotModels } from '@nangohq/shared';
-export { Nango, NangoSync, NangoHelper, HubspotModels };
+import type { ProxyConfiguration } from './types';
+export declare class Nango {
+    serverUrl: string;
+    secretKey: string;
+    constructor(config?: {
+        host?: string;
+        secretKey?: string;
+    });
+    /**
+     * For OAuth 2: returns the access token directly as a string.
+     * For OAuth 2: If you want to obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true."
+     * For OAuth 1: returns an object with 'oAuthToken' and 'oAuthTokenSecret' fields.
+     * @param providerConfigKey - This is the unique Config Key for the integration
+     * @param connectionId - This is the unique connection identifier used to identify this connection
+     * @param [forceRefresh] - When set, this is used to  obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true.
+     * */
+    getToken(providerConfigKey: string, connectionId: string, forceRefresh?: boolean): Promise<any>;
+    /**
+     * Get the full (fresh) credentials payload returned by the external API,
+     * which also contains access credentials.
+     * @param providerConfigKey - This is the unique Config Key for the integration
+     * @param connectionId - This is the unique connection identifier used to identify this connection
+     * @param [forceRefresh] - When set, this is used to  obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true.
+     * */
+    getRawTokenResponse(providerConfigKey: string, connectionId: string, forceRefresh?: boolean): Promise<any>;
+    /**
+     * Get the Connection object, which also contains access credentials and full credentials payload
+     * returned by the external API.
+     * @param providerConfigKey - This is the unique Config Key for the integration
+     * @param connectionId - This is the unique connection identifier used to identify this connection
+     * @param [forceRefresh] - When set, this is used to  obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true.
+     */
+    getConnection(providerConfigKey: string, connectionId: string, forceRefresh?: boolean): Promise<any>;
+    proxy(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
+    get(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
+    post(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
+    patch(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
+    delete(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
+    private getConnectionDetails;
+    /**
+     * Get the list of Connections, which does not contain access credentials.
+     */
+    listConnections(connectionId?: string): Promise<any>;
+    private listConnectionDetails;
+    private enrichHeaders;
+}

package/dist/index.js

@@ -1,3 +1,168 @@
-import { Nango, NangoSync, NangoHelper, HubspotModels } from '@nangohq/shared';
-export { Nango, NangoSync, NangoHelper, HubspotModels };
+import axios from 'axios';
+import { validateProxyConfiguration } from './utils.js';
+const prodHost = 'https://api.nango.dev';
+const stagingHost = 'https://api-staging.nango.dev';
+export class Nango {
+    serverUrl;
+    secretKey;
+    constructor(config = {}) {
+        config.host = config.host || prodHost;
+        this.serverUrl = config.host;
+        if (this.serverUrl.slice(-1) === '/') {
+            this.serverUrl = this.serverUrl.slice(0, -1);
+        }
+        try {
+            new URL(this.serverUrl);
+        }
+        catch (err) {
+            throw new Error(`Invalid URL provided for the Nango host: ${this.serverUrl}`);
+        }
+        this.secretKey = config.secretKey || '';
+    }
+    /**
+     * For OAuth 2: returns the access token directly as a string.
+     * For OAuth 2: If you want to obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true."
+     * For OAuth 1: returns an object with 'oAuthToken' and 'oAuthTokenSecret' fields.
+     * @param providerConfigKey - This is the unique Config Key for the integration
+     * @param connectionId - This is the unique connection identifier used to identify this connection
+     * @param [forceRefresh] - When set, this is used to  obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true.
+     * */
+    async getToken(providerConfigKey, connectionId, forceRefresh) {
+        let response = await this.getConnectionDetails(providerConfigKey, connectionId, forceRefresh);
+        switch (response.data.credentials.type) {
+            case 'OAUTH2':
+                return response.data.credentials.access_token;
+            case 'OAUTH1':
+                return { oAuthToken: response.data.credentials.oauth_token, oAuthTokenSecret: response.data.credentials.oauth_token_secret };
+            default:
+                throw new Error(`Unrecognized OAuth type '${response.data.credentials.type}' in stored credentials.`);
+        }
+    }
+    /**
+     * Get the full (fresh) credentials payload returned by the external API,
+     * which also contains access credentials.
+     * @param providerConfigKey - This is the unique Config Key for the integration
+     * @param connectionId - This is the unique connection identifier used to identify this connection
+     * @param [forceRefresh] - When set, this is used to  obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true.
+     * */
+    async getRawTokenResponse(providerConfigKey, connectionId, forceRefresh) {
+        let response = await this.getConnectionDetails(providerConfigKey, connectionId, forceRefresh);
+        return response.data.credentials.raw;
+    }
+    /**
+     * Get the Connection object, which also contains access credentials and full credentials payload
+     * returned by the external API.
+     * @param providerConfigKey - This is the unique Config Key for the integration
+     * @param connectionId - This is the unique connection identifier used to identify this connection
+     * @param [forceRefresh] - When set, this is used to  obtain a new refresh token from the provider before the current token has expired,
+     * you can set the forceRefresh argument to true.
+     */
+    async getConnection(providerConfigKey, connectionId, forceRefresh) {
+        let response = await this.getConnectionDetails(providerConfigKey, connectionId, forceRefresh);
+        return response.data;
+    }
+    async proxy(config) {
+        validateProxyConfiguration(config);
+        const { providerConfigKey, connectionId, method, retries, headers: customHeaders } = config;
+        const url = `${this.serverUrl}/proxy/${config.endpoint}`;
+        const headers = {
+            'Connection-Id': connectionId,
+            'Provider-Config-Key': providerConfigKey,
+            ...customHeaders
+        };
+        if (retries) {
+            headers['Retries'] = retries;
+        }
+        const options = {
+            headers: this.enrichHeaders(headers)
+        };
+        if (config.params) {
+            options.params = config.params;
+        }
+        if (config.paramsSerializer) {
+            options.paramsSerializer = config.paramsSerializer;
+        }
+        if (method?.toUpperCase() === 'POST') {
+            return axios.post(url, config.data, options);
+        }
+        else if (method?.toUpperCase() === 'PATCH') {
+            return axios.patch(url, config.data, options);
+        }
+        else if (method?.toUpperCase() === 'PUT') {
+            return axios.put(url, config.data, options);
+        }
+        else if (method?.toUpperCase() === 'DELETE') {
+            return axios.delete(url, options);
+        }
+        else {
+            return axios.get(url, options);
+        }
+    }
+    async get(config) {
+        return this.proxy({
+            ...config,
+            method: 'GET'
+        });
+    }
+    async post(config) {
+        return this.proxy({
+            ...config,
+            method: 'POST'
+        });
+    }
+    async patch(config) {
+        return this.proxy({
+            ...config,
+            method: 'PATCH'
+        });
+    }
+    async delete(config) {
+        return this.proxy({
+            ...config,
+            method: 'DELETE'
+        });
+    }
+    async getConnectionDetails(providerConfigKey, connectionId, forceRefresh = false) {
+        let url = `${this.serverUrl}/connection/${connectionId}`;
+        let headers = {
+            'Content-Type': 'application/json',
+            'Accept-Encoding': 'application/json'
+        };
+        let params = {
+            provider_config_key: providerConfigKey,
+            force_refresh: forceRefresh
+        };
+        return axios.get(url, { params: params, headers: this.enrichHeaders(headers) });
+    }
+    /**
+     * Get the list of Connections, which does not contain access credentials.
+     */
+    async listConnections(connectionId) {
+        let response = await this.listConnectionDetails(connectionId);
+        return response.data;
+    }
+    async listConnectionDetails(connectionId) {
+        let url = `${this.serverUrl}/connection?`;
+        if (connectionId) {
+            url = url.concat(`connectionId=${connectionId}`);
+        }
+        let headers = {
+            'Content-Type': 'application/json',
+            'Accept-Encoding': 'application/json'
+        };
+        return axios.get(url, { headers: this.enrichHeaders(headers) });
+    }
+    enrichHeaders(headers = {}) {
+        if (this.serverUrl === prodHost || this.serverUrl === stagingHost) {
+            headers['Authorization'] = 'Bearer ' + this.secretKey;
+        }
+        else if (this.secretKey) {
+            headers['Authorization'] = 'Basic ' + Buffer.from(this.secretKey + ':').toString('base64');
+        }
+        return headers;
+    }
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE/E,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAIxD,MAAM,QAAQ,GAAG,uBAAuB,CAAC;AACzC,MAAM,WAAW,GAAG,+BAA+B,CAAC;AAEpD,MAAM,OAAO,KAAK;IACd,SAAS,CAAS;IAClB,SAAS,CAAS;IAElB,YAAY,SAAgD,EAAE;QAC1D,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,QAAQ,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;QAE7B,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;YAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SAChD;QAED,IAAI;YACA,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC3B;QAAC,OAAO,GAAG,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,4CAA4C,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;SACjF;QAED,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;;;;SASK;IACE,KAAK,CAAC,QAAQ,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAsB;QACzF,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAE9F,QAAQ,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;YACpC,KAAK,QAAQ;gBACT,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC;YAClD,KAAK,QAAQ;gBACT,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,gBAAgB,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC;YACjI;gBACI,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,0BAA0B,CAAC,CAAC;SAC7G;IACL,CAAC;IAED;;;;;;;SAOK;IACE,KAAK,CAAC,mBAAmB,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAsB;QACpG,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAC9F,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAsB;QAC9F,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAC9F,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,MAA0B;QACzC,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAEnC,MAAM,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QAE5F,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,UAAU,MAAM,CAAC,QAAQ,EAAE,CAAC;QAEzD,MAAM,OAAO,GAA8C;YACvD,eAAe,EAAE,YAAY;YAC7B,qBAAqB,EAAE,iBAAiB;YACxC,GAAG,aAAa;SACnB,CAAC;QAEF,IAAI,OAAO,EAAE;YACT,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC;SAChC;QAED,MAAM,OAAO,GAAuB;YAChC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;SACvC,CAAC;QAEF,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;SAClC;QAED,IAAI,MAAM,CAAC,gBAAgB,EAAE;YACzB,OAAO,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;SACtD;QAED,IAAI,MAAM,EAAE,WAAW,EAAE,KAAK,MAAM,EAAE;YAClC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAChD;aAAM,IAAI,MAAM,EAAE,WAAW,EAAE,KAAK,OAAO,EAAE;YAC1C,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SACjD;aAAM,IAAI,MAAM,EAAE,WAAW,EAAE,KAAK,KAAK,EAAE;YACxC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC/C;aAAM,IAAI,MAAM,EAAE,WAAW,EAAE,KAAK,QAAQ,EAAE;YAC3C,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACrC;aAAM;YACH,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SAClC;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAA0B;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAA0B;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,MAA0B;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,OAAO;SAClB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,MAA0B;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,MAAM;YACT,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAY,GAAG,KAAK;QACpG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,eAAe,YAAY,EAAE,CAAC;QAEzD,IAAI,OAAO,GAAG;YACV,cAAc,EAAE,kBAAkB;YAClC,iBAAiB,EAAE,kBAAkB;SACxC,CAAC;QAEF,IAAI,MAAM,GAAG;YACT,mBAAmB,EAAE,iBAAiB;YACtC,aAAa,EAAE,YAAY;SAC9B,CAAC;QAEF,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,eAAe,CAAC,YAAqB;QAC9C,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAC9D,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,YAAqB;QACrD,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,cAAc,CAAC;QAE1C,IAAI,YAAY,EAAE;YACd,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC;SACpD;QAED,IAAI,OAAO,GAAG;YACV,cAAc,EAAE,kBAAkB;YAClC,iBAAiB,EAAE,kBAAkB;SACxC,CAAC;QAEF,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IAEO,aAAa,CAAC,UAAqD,EAAE;QACzE,IAAI,IAAI,CAAC,SAAS,KAAK,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,WAAW,EAAE;YAC/D,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;SACzD;aAAM,IAAI,IAAI,CAAC,SAAS,EAAE;YACvB,OAAO,CAAC,eAAe,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9F;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ"}

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { ParamsSerializerOptions } from 'axios';
 export interface ProxyConfiguration {
     [key: string]: any;
     endpoint: string;
@@ -6,22 +7,7 @@ export interface ProxyConfiguration {
     method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' | 'get' | 'post' | 'patch' | 'put' | 'delete';
     headers?: Record<string, string>;
     params?: string | Record<string, string>;
-    paramsSerializer?: {
-        encode?: (param: string) => string;
-        serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions) => void;
-        indexes?: boolean;
-    };
+    paramsSerializer?: ParamsSerializerOptions;
     data?: unknown;
     retries?: number;
 }
-interface ParamsSerializerOptions {
-    encode?: ParamEncoder;
-    serialize?: CustomParamsSerializer;
-}
-interface ParamEncoder {
-    (value: any, defaultEncoder: (value: any) => any): any;
-}
-interface CustomParamsSerializer {
-    (params: Record<string, any>, options?: ParamsSerializerOptions): string;
-}
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/node",
-    "version": "0.17.5-beta",
+    "version": "0.17.5",
     "description": "Nango's Node client.",
     "type": "module",
     "main": "dist/index.js",
@@ -13,7 +13,6 @@
     },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "dependencies": {
-        "@nangohq/shared": "^0.17.17",
         "axios": "^1.2.0"
     },
     "engines": {

package/dist/sync.d.ts

@@ -1,9 +0,0 @@
-import type { Nango } from './index.js';
-export declare abstract class NangoSync {
-    abstract fetchData(nango: Nango): Promise<any>;
-    abstract postData(nango: Nango): Promise<any>;
-    abstract patchData(nango: Nango): Promise<any>;
-    abstract putData(nango: Nango): Promise<any>;
-    abstract deleteData(nango: Nango): Promise<any>;
-}
-export default NangoSync;

package/dist/sync.js

@@ -1,4 +0,0 @@
-export class NangoSync {
-}
-export default NangoSync;
-//# sourceMappingURL=sync.js.map

package/dist/sync.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sync.js","sourceRoot":"","sources":["../lib/sync.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,SAAS;CAM9B;AAED,eAAe,SAAS,CAAC"}