@nangohq/node 0.21.13 → 0.21.141-beta

package/dist/index.d.ts

@@ -1,2 +1,86 @@
-import { Nango, NangoSync, SyncWebhookBody as NangoSyncWebhookBody, HubspotModels } from '@nangohq/shared';
-export { Nango, NangoSync, NangoSyncWebhookBody, HubspotModels };
+import type { AuthModes, OAuth1Credentials, OAuth2Credentials, ProxyConfiguration, GetRecordsRequestConfig } from './types.js';
+export declare const stagingHost = "https://api-staging.nango.dev";
+export declare const prodHost = "https://api.nango.dev";
+interface NangoProps {
+    host?: string;
+    secretKey?: string;
+    connectionId?: string;
+    providerConfigKey?: string;
+    isSync?: boolean;
+    dryRun?: boolean;
+    activityLogId?: number;
+}
+interface CreateConnectionOAuth1 extends OAuth1Credentials {
+    connection_id: string;
+    provider_config_key: string;
+    type: AuthModes.OAuth1;
+}
+interface CreateConnectionOAuth2 extends OAuth2Credentials {
+    connection_id: string;
+    provider_config_key: string;
+    type: AuthModes.OAuth2;
+}
+export declare class Nango {
+    serverUrl: string;
+    secretKey: string;
+    connectionId?: string;
+    providerConfigKey?: string;
+    isSync: boolean;
+    dryRun: boolean;
+    activityLogId?: number;
+    constructor(config?: NangoProps);
+    /**
+     * 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.
+     * @param [refreshToken] - When set this returns the refresh token as part of the response
+     */
+    getConnection(providerConfigKey: string, connectionId: string, forceRefresh?: boolean, refreshToken?: 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>>;
+    getRecords(config: GetRecordsRequestConfig): Promise<any>;
+    private getConnectionDetails;
+    /**
+     * Get the list of Connections, which does not contain access credentials.
+     */
+    listConnections(connectionId?: string): Promise<any>;
+    setFieldMapping(fieldMapping: Record<string, string>, optionalProviderConfigKey?: string, optionalConnectionId?: string): Promise<import("axios").AxiosResponse<any, any>>;
+    getFieldMapping(optionalProviderConfigKey?: string, optionalConnectionId?: string): Promise<any>;
+    triggerSync({ connectionId, providerConfigKey }: {
+        connectionId: string;
+        providerConfigKey: string;
+    }): Promise<import("axios").AxiosResponse<any, any>>;
+    createConnection(connectionArgs: CreateConnectionOAuth1 | (CreateConnectionOAuth2 & {
+        metadata: string;
+        connection_config: string;
+    })): Promise<import("axios").AxiosResponse<any, any>>;
+    private listConnectionDetails;
+    private enrichHeaders;
+}
+export {};

package/dist/index.js

@@ -1,3 +1,250 @@
-import { Nango, NangoSync, HubspotModels } from '@nangohq/shared';
-export { Nango, NangoSync, HubspotModels };
+import axios from 'axios';
+import { validateProxyConfiguration, validateSyncRecordConfiguration } from './utils.js';
+export const stagingHost = 'https://api-staging.nango.dev';
+export const prodHost = 'https://api.nango.dev';
+export class Nango {
+    serverUrl;
+    secretKey;
+    connectionId;
+    providerConfigKey;
+    isSync = false;
+    dryRun = false;
+    activityLogId;
+    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 || '';
+        this.connectionId = config.connectionId || '';
+        this.providerConfigKey = config.providerConfigKey || '';
+        if (config.isSync) {
+            this.isSync = config.isSync;
+        }
+        if (config.dryRun) {
+            this.dryRun = config.dryRun;
+        }
+        if (config.activityLogId) {
+            this.activityLogId = config.activityLogId;
+        }
+    }
+    /**
+     * 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) {
+        const 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) {
+        const 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.
+     * @param [refreshToken] - When set this returns the refresh token as part of the response
+     */
+    async getConnection(providerConfigKey, connectionId, forceRefresh, refreshToken) {
+        const response = await this.getConnectionDetails(providerConfigKey, connectionId, forceRefresh, refreshToken);
+        return response.data;
+    }
+    async proxy(config) {
+        if (!config.connectionId && this.connectionId) {
+            config.connectionId = this.connectionId;
+        }
+        if (!config.providerConfigKey && this.providerConfigKey) {
+            config.providerConfigKey = this.providerConfigKey;
+        }
+        validateProxyConfiguration(config);
+        const { providerConfigKey, connectionId, method, retries, headers: customHeaders, baseUrlOverride } = config;
+        const url = `${this.serverUrl}/proxy/${config.endpoint}`;
+        const headers = {
+            'Connection-Id': connectionId,
+            'Provider-Config-Key': providerConfigKey,
+            'Base-Url-Override': baseUrlOverride || '',
+            'Nango-Is-Sync': this.isSync,
+            'Nango-Is-Dry-Run': this.dryRun,
+            'Nango-Activity-Log-Id': this.activityLogId || '',
+            ...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 getRecords(config) {
+        const { connectionId, providerConfigKey, model, delta, offset, limit } = config;
+        validateSyncRecordConfiguration(config);
+        const url = `${this.serverUrl}/sync/records/?model=${model}&delta=${delta || ''}&offset=${offset || ''}&limit=${limit || ''}`;
+        const headers = {
+            'Connection-Id': connectionId,
+            'Provider-Config-Key': providerConfigKey
+        };
+        const options = {
+            headers: this.enrichHeaders(headers)
+        };
+        const response = await axios.get(url, options);
+        return response.data;
+    }
+    async getConnectionDetails(providerConfigKey, connectionId, forceRefresh = false, refreshToken = false, additionalHeader = {}) {
+        const url = `${this.serverUrl}/connection/${connectionId}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            'Accept-Encoding': 'application/json'
+        };
+        if (additionalHeader) {
+            Object.assign(headers, additionalHeader);
+        }
+        const params = {
+            provider_config_key: providerConfigKey,
+            force_refresh: forceRefresh,
+            refresh_token: refreshToken
+        };
+        return axios.get(url, { params: params, headers: this.enrichHeaders(headers) });
+    }
+    /**
+     * Get the list of Connections, which does not contain access credentials.
+     */
+    async listConnections(connectionId) {
+        const response = await this.listConnectionDetails(connectionId);
+        return response.data;
+    }
+    async setFieldMapping(fieldMapping, optionalProviderConfigKey, optionalConnectionId) {
+        const providerConfigKey = optionalProviderConfigKey || this.providerConfigKey;
+        const connectionId = optionalConnectionId || this.connectionId;
+        const url = `${this.serverUrl}/connection/${connectionId}/field-mapping?provider_config_key=${providerConfigKey}`;
+        const headers = {
+            'Provider-Config-Key': providerConfigKey
+        };
+        return axios.post(url, fieldMapping, { headers: this.enrichHeaders(headers) });
+    }
+    async getFieldMapping(optionalProviderConfigKey, optionalConnectionId) {
+        const providerConfigKey = optionalProviderConfigKey || this.providerConfigKey;
+        const connectionId = optionalConnectionId || this.connectionId;
+        if (!providerConfigKey) {
+            throw new Error('Provider Config Key is required');
+        }
+        if (!connectionId) {
+            throw new Error('Connection Id is required');
+        }
+        const response = await this.getConnectionDetails(providerConfigKey, connectionId, false, false, {
+            'Nango-Is-Sync': true,
+            'Nango-Is-Dry-Run': this.dryRun
+        });
+        return response.data.field_mappings;
+    }
+    async triggerSync({ connectionId, providerConfigKey }) {
+        const url = `${this.serverUrl}/sync/trigger`;
+        const headers = {
+            'Connection-Id': connectionId,
+            'Provider-Config-Key': providerConfigKey
+        };
+        return axios.post(url, {}, { headers: this.enrichHeaders(headers) });
+    }
+    async createConnection(connectionArgs) {
+        const url = `${this.serverUrl}/connection`;
+        const body = connectionArgs;
+        return axios.post(url, body, { headers: this.enrichHeaders() });
+    }
+    async listConnectionDetails(connectionId) {
+        let url = `${this.serverUrl}/connection?`;
+        if (connectionId) {
+            url = url.concat(`connectionId=${connectionId}`);
+        }
+        const 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,EAA2C,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE3G,OAAO,EAAE,KAAK,EAAE,SAAS,EAAwB,aAAa,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAGlD,OAAO,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAC;AAEzF,MAAM,CAAC,MAAM,WAAW,GAAG,+BAA+B,CAAC;AAC3D,MAAM,CAAC,MAAM,QAAQ,GAAG,uBAAuB,CAAC;AAwBhD,MAAM,OAAO,KAAK;IACd,SAAS,CAAS;IAClB,SAAS,CAAS;IAClB,YAAY,CAAU;IACtB,iBAAiB,CAAU;IAC3B,MAAM,GAAG,KAAK,CAAC;IACf,MAAM,GAAG,KAAK,CAAC;IACf,aAAa,CAAU;IAEvB,YAAY,SAAqB,EAAE;QAC/B,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;QACxC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC;QAC9C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC;QAExD,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;SAC/B;QAED,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;SAC/B;QAED,IAAI,MAAM,CAAC,aAAa,EAAE;YACtB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;SAC7C;IACL,CAAC;IAED;;;;;;;;;SASK;IACE,KAAK,CAAC,QAAQ,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAsB;QACzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAEhG,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,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAChG,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAsB,EAAE,YAAsB;QACtH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAC9G,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,MAA0B;QACzC,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE;YAC3C,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;SAC3C;QAED,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACrD,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;SACrD;QAED,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAEnC,MAAM,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QAE7G,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,UAAU,MAAM,CAAC,QAAQ,EAAE,CAAC;QAEzD,MAAM,OAAO,GAA8C;YACvD,eAAe,EAAE,YAAsB;YACvC,qBAAqB,EAAE,iBAA2B;YAClD,mBAAmB,EAAE,eAAe,IAAI,EAAE;YAC1C,eAAe,EAAE,IAAI,CAAC,MAAM;YAC5B,kBAAkB,EAAE,IAAI,CAAC,MAAM;YAC/B,uBAAuB,EAAE,IAAI,CAAC,aAAa,IAAI,EAAE;YACjD,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;IAEM,KAAK,CAAC,UAAU,CAAC,MAA+B;QACnD,MAAM,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAChF,+BAA+B,CAAC,MAAM,CAAC,CAAC;QAExC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,wBAAwB,KAAK,UAAU,KAAK,IAAI,EAAE,WAAW,MAAM,IAAI,EAAE,UAAU,KAAK,IAAI,EAAE,EAAE,CAAC;QAC9H,MAAM,OAAO,GAA8C;YACvD,eAAe,EAAE,YAAY;YAC7B,qBAAqB,EAAE,iBAAiB;SAC3C,CAAC;QAEF,MAAM,OAAO,GAAG;YACZ,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;SACvC,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAE/C,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,iBAAyB,EAAE,YAAoB,EAAE,YAAY,GAAG,KAAK,EAAE,YAAY,GAAG,KAAK,EAAE,gBAAgB,GAAG,EAAE;QACjJ,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,eAAe,YAAY,EAAE,CAAC;QAE3D,MAAM,OAAO,GAAG;YACZ,cAAc,EAAE,kBAAkB;YAClC,iBAAiB,EAAE,kBAAkB;SACxC,CAAC;QAEF,IAAI,gBAAgB,EAAE;YAClB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;SAC5C;QAED,MAAM,MAAM,GAAG;YACX,mBAAmB,EAAE,iBAAiB;YACtC,aAAa,EAAE,YAAY;YAC3B,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,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAChE,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,YAAoC,EAAE,yBAAkC,EAAE,oBAA6B;QAChI,MAAM,iBAAiB,GAAG,yBAAyB,IAAI,IAAI,CAAC,iBAAiB,CAAC;QAC9E,MAAM,YAAY,GAAG,oBAAoB,IAAI,IAAI,CAAC,YAAY,CAAC;QAC/D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,eAAe,YAAY,sCAAsC,iBAAiB,EAAE,CAAC;QAElH,MAAM,OAAO,GAA8C;YACvD,qBAAqB,EAAE,iBAA2B;SACrD,CAAC;QAEF,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACnF,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,yBAAkC,EAAE,oBAA6B;QAC1F,MAAM,iBAAiB,GAAG,yBAAyB,IAAI,IAAI,CAAC,iBAAiB,CAAC;QAC9E,MAAM,YAAY,GAAG,oBAAoB,IAAI,IAAI,CAAC,YAAY,CAAC;QAE/D,IAAI,CAAC,iBAAiB,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACtD;QAED,IAAI,CAAC,YAAY,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAChD;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE;YAC5F,eAAe,EAAE,IAAI;YACrB,kBAAkB,EAAE,IAAI,CAAC,MAAM;SAClC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,iBAAiB,EAAuD;QAC7G,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,eAAe,CAAC;QAE7C,MAAM,OAAO,GAAG;YACZ,eAAe,EAAE,YAAY;YAC7B,qBAAqB,EAAE,iBAAiB;SAC3C,CAAC;QAEF,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,cAAmH;QAC7I,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,aAAa,CAAC;QAE3C,MAAM,IAAI,GAAG,cAAc,CAAC;QAE5B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,YAAqB;QACrD,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,cAAc,CAAC;QAC1C,IAAI,YAAY,EAAE;YACd,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC;SACpD;QAED,MAAM,OAAO,GAAG;YACZ,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,27 +1,40 @@
+import type { ParamsSerializerOptions } from 'axios';
+export declare enum AuthModes {
+    OAuth1 = "OAUTH1",
+    OAuth2 = "OAUTH2"
+}
+export interface CredentialsCommon {
+    type: AuthModes;
+    raw: Record<string, string>;
+}
+export interface OAuth1Credentials extends CredentialsCommon {
+    type: AuthModes.OAuth1;
+    oauth_token: string;
+    oauth_token_secret: string;
+}
+export interface OAuth2Credentials extends CredentialsCommon {
+    type: AuthModes.OAuth2;
+    access_token: string;
+    refresh_token?: string;
+    expires_at?: Date | undefined;
+}
 export interface ProxyConfiguration {
-    [key: string]: any;
     endpoint: string;
-    providerConfigKey: string;
-    connectionId: string;
+    providerConfigKey?: string;
+    connectionId?: string;
     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;
+    baseUrlOverride?: string;
 }
-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 interface GetRecordsRequestConfig {
+    providerConfigKey: string;
+    connectionId: string;
+    model: string;
+    delta?: string;
+    offset?: number;
+    limit?: number;
 }
-export {};

package/dist/types.js

@@ -1,2 +1,6 @@
-export {};
+export var AuthModes;
+(function (AuthModes) {
+    AuthModes["OAuth1"] = "OAUTH1";
+    AuthModes["OAuth2"] = "OAUTH2";
+})(AuthModes || (AuthModes = {}));
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;AACrB,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}

package/dist/utils.d.ts

@@ -1,2 +1,3 @@
-import type { ProxyConfiguration } from './types';
+import type { ProxyConfiguration, GetRecordsRequestConfig } from './types.js';
 export declare const validateProxyConfiguration: (config: ProxyConfiguration) => void;
+export declare const validateSyncRecordConfiguration: (config: GetRecordsRequestConfig) => void;

package/dist/utils.js

@@ -6,4 +6,12 @@ export const validateProxyConfiguration = (config) => {
         }
     });
 };
+export const validateSyncRecordConfiguration = (config) => {
+    const requiredParams = ['model', 'providerConfigKey', 'connectionId'];
+    requiredParams.forEach((param) => {
+        if (typeof config[param] === 'undefined') {
+            throw new Error(`${param} is missing and is required to make a proxy call!`);
+        }
+    });
+};
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../lib/utils.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAA0B,EAAE,EAAE;IACrE,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;IAEzE,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,mDAAmD,CAAC,CAAC;SAChF;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../lib/utils.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAA0B,EAAE,EAAE;IACrE,MAAM,cAAc,GAAoC,CAAC,UAAU,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;IAE1G,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,mDAAmD,CAAC,CAAC;SAChF;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,MAA+B,EAAE,EAAE;IAC/E,MAAM,cAAc,GAAyC,CAAC,OAAO,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;IAE5G,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,mDAAmD,CAAC,CAAC;SAChF;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/node",
-    "version": "0.21.13",
+    "version": "0.21.141-beta",
     "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.21.13",
         "axios": "^1.2.0"
     },
     "engines": {