@nangohq/node 0.24.12 → 0.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +9 -5
- package/dist/index.js +6 -7
- package/dist/index.js.map +1 -1
- package/dist/types.d.ts +28 -1
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
- package/dist/sync.d.ts +0 -32
- package/dist/sync.js +0 -97
- package/dist/sync.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { AuthModes, OAuth1Credentials, OAuth2Credentials, ProxyConfiguration, GetRecordsRequestConfig, BasicApiCredentials, ApiKeyCredentials, Connection } from './types.js';
|
|
2
2
|
export declare const stagingHost = "https://api-staging.nango.dev";
|
|
3
3
|
export declare const prodHost = "https://api.nango.dev";
|
|
4
4
|
interface NangoProps {
|
|
@@ -15,6 +15,10 @@ interface CreateConnectionOAuth1 extends OAuth1Credentials {
|
|
|
15
15
|
provider_config_key: string;
|
|
16
16
|
type: AuthModes.OAuth1;
|
|
17
17
|
}
|
|
18
|
+
interface OAuth1Token {
|
|
19
|
+
oAuthToken: string;
|
|
20
|
+
oAuthTokenSecret: string;
|
|
21
|
+
}
|
|
18
22
|
interface CreateConnectionOAuth2 extends OAuth2Credentials {
|
|
19
23
|
connection_id: string;
|
|
20
24
|
provider_config_key: string;
|
|
@@ -57,7 +61,7 @@ export declare class Nango {
|
|
|
57
61
|
* @param [forceRefresh] - When set, this is used to obtain a new refresh token from the provider before the current token has expired,
|
|
58
62
|
* you can set the forceRefresh argument to true.
|
|
59
63
|
* */
|
|
60
|
-
getToken(providerConfigKey: string, connectionId: string, forceRefresh?: boolean): Promise<
|
|
64
|
+
getToken(providerConfigKey: string, connectionId: string, forceRefresh?: boolean): Promise<string | OAuth1Token | BasicApiCredentials | ApiKeyCredentials>;
|
|
61
65
|
/**
|
|
62
66
|
* Get the full (fresh) credentials payload returned by the external API,
|
|
63
67
|
* which also contains access credentials.
|
|
@@ -76,7 +80,7 @@ export declare class Nango {
|
|
|
76
80
|
* you can set the forceRefresh argument to true.
|
|
77
81
|
* @param [refreshToken] - When set this returns the refresh token as part of the response
|
|
78
82
|
*/
|
|
79
|
-
getConnection(providerConfigKey: string, connectionId: string, forceRefresh?: boolean, refreshToken?: boolean): Promise<
|
|
83
|
+
getConnection(providerConfigKey: string, connectionId: string, forceRefresh?: boolean, refreshToken?: boolean): Promise<Connection>;
|
|
80
84
|
proxy(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
81
85
|
get(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
82
86
|
post(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
@@ -95,10 +99,10 @@ export declare class Nango {
|
|
|
95
99
|
connectionId: string;
|
|
96
100
|
providerConfigKey: string;
|
|
97
101
|
}): Promise<import("axios").AxiosResponse<any, any>>;
|
|
98
|
-
createConnection(
|
|
102
|
+
createConnection(_connectionArgs: CreateConnectionOAuth1 | (CreateConnectionOAuth2 & {
|
|
99
103
|
metadata: string;
|
|
100
104
|
connection_config: string;
|
|
101
|
-
})): Promise<
|
|
105
|
+
})): Promise<void>;
|
|
102
106
|
private listConnectionDetails;
|
|
103
107
|
private enrichHeaders;
|
|
104
108
|
}
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import axios from 'axios';
|
|
2
|
+
import { AuthModes } from './types.js';
|
|
2
3
|
import { validateProxyConfiguration, validateSyncRecordConfiguration } from './utils.js';
|
|
3
4
|
export const stagingHost = 'https://api-staging.nango.dev';
|
|
4
5
|
export const prodHost = 'https://api.nango.dev';
|
|
@@ -56,12 +57,12 @@ export class Nango {
|
|
|
56
57
|
async getToken(providerConfigKey, connectionId, forceRefresh) {
|
|
57
58
|
const response = await this.getConnectionDetails(providerConfigKey, connectionId, forceRefresh);
|
|
58
59
|
switch (response.data.credentials.type) {
|
|
59
|
-
case
|
|
60
|
+
case AuthModes.OAuth2:
|
|
60
61
|
return response.data.credentials.access_token;
|
|
61
|
-
case
|
|
62
|
+
case AuthModes.OAuth1:
|
|
62
63
|
return { oAuthToken: response.data.credentials.oauth_token, oAuthTokenSecret: response.data.credentials.oauth_token_secret };
|
|
63
64
|
default:
|
|
64
|
-
|
|
65
|
+
return response.data.credentials;
|
|
65
66
|
}
|
|
66
67
|
}
|
|
67
68
|
/**
|
|
@@ -243,10 +244,8 @@ export class Nango {
|
|
|
243
244
|
};
|
|
244
245
|
return axios.post(url, {}, { headers: this.enrichHeaders(headers) });
|
|
245
246
|
}
|
|
246
|
-
async createConnection(
|
|
247
|
-
|
|
248
|
-
const body = connectionArgs;
|
|
249
|
-
return axios.post(url, body, { headers: this.enrichHeaders() });
|
|
247
|
+
async createConnection(_connectionArgs) {
|
|
248
|
+
throw new Error('This method has been deprecated, please use the REST API to create a connection. See https://docs.nango.dev/api-reference/connection/post');
|
|
250
249
|
}
|
|
251
250
|
async listConnectionDetails(connectionId) {
|
|
252
251
|
let url = `${this.serverUrl}/connection?`;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAElD,OAAO,EACH,SAAS,EAQZ,MAAM,YAAY,CAAC;AACpB,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;AAiChD,MAAM,CAAN,IAAY,QAGX;AAHD,WAAY,QAAQ;IAChB,+BAAmB,CAAA;IACnB,uCAA2B,CAAA;AAC/B,CAAC,EAHW,QAAQ,KAAR,QAAQ,QAGnB;AAkBD,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,MAAkB;QAC1B,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,CAAC,MAAM,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACzE;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,CAAC;QAClC,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,CACjB,iBAAyB,EACzB,YAAoB,EACpB,YAAsB;QAEtB,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,SAAS,CAAC,MAAM;gBACjB,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC;YAClD,KAAK,SAAS,CAAC,MAAM;gBACjB,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,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;SACxC;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,qBAAqB,GACvB,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,aAA8B,CAAC,CAAC,MAAM,GAAG,CAAC;YACnE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,aAA8B,CAAC,CAAC,MAAM,CAAC,CAAC,GAAkB,EAAE,GAAW,EAAE,EAAE;gBACnF,GAAG,CAAC,eAAe,GAAG,EAAE,CAAC,GAAG,aAAa,CAAC,GAAG,CAAW,CAAC;gBACzD,OAAO,GAAG,CAAC;YACf,CAAC,EAAE,EAAE,CAAC;YACR,CAAC,CAAE,EAAoB,CAAC;QAEhC,MAAM,OAAO,GAA8D;YACvE,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,qBAAqB;SAC3B,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,OAAoD,CAAC;SACpF,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,IAAI,CAAC,MAAM,EAAE;YACb,OAAO,CAAC,GAAG,CAAC,wBAAwB,MAAM,EAAE,WAAW,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;SACvE;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,cAAc,CAAC,iBAAyB,EAAE,4BAA4B,GAAG,KAAK;QACvF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,WAAW,iBAAiB,EAAE,CAAC;QAC5D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;QACpI,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,eAAoH;QAC9I,MAAM,IAAI,KAAK,CACX,2IAA2I,CAC9I,CAAC;IACN,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,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtD,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import type { ParamsSerializerOptions } from 'axios';
|
|
2
2
|
export declare enum AuthModes {
|
|
3
3
|
OAuth1 = "OAUTH1",
|
|
4
|
-
OAuth2 = "OAUTH2"
|
|
4
|
+
OAuth2 = "OAUTH2",
|
|
5
|
+
Basic = "BASIC",
|
|
6
|
+
ApiKey = "API_KEY"
|
|
5
7
|
}
|
|
6
8
|
export interface CredentialsCommon<T = Record<string, any>> {
|
|
7
9
|
type: AuthModes;
|
|
@@ -38,3 +40,28 @@ export interface GetRecordsRequestConfig {
|
|
|
38
40
|
offset?: number;
|
|
39
41
|
limit?: number;
|
|
40
42
|
}
|
|
43
|
+
export interface BasicApiCredentials {
|
|
44
|
+
type?: AuthModes.Basic;
|
|
45
|
+
username: string;
|
|
46
|
+
password: string;
|
|
47
|
+
}
|
|
48
|
+
export interface ApiKeyCredentials {
|
|
49
|
+
type?: AuthModes.ApiKey;
|
|
50
|
+
apiKey: string;
|
|
51
|
+
}
|
|
52
|
+
type AuthCredentials = OAuth2Credentials | OAuth1Credentials | BasicApiCredentials | ApiKeyCredentials;
|
|
53
|
+
export interface Connection {
|
|
54
|
+
id?: number;
|
|
55
|
+
created_at?: string;
|
|
56
|
+
updated_at?: string;
|
|
57
|
+
provider_config_key: string;
|
|
58
|
+
connection_id: string;
|
|
59
|
+
connection_config: Record<string, string>;
|
|
60
|
+
environment_id: number;
|
|
61
|
+
metadata: Record<string, string> | null;
|
|
62
|
+
credentials_iv?: string | null;
|
|
63
|
+
credentials_tag?: string | null;
|
|
64
|
+
field_mappings?: Record<string, string>;
|
|
65
|
+
credentials: AuthCredentials;
|
|
66
|
+
}
|
|
67
|
+
export {};
|
package/dist/types.js
CHANGED
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACjB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,+BAAkB,CAAA;AACtB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB"}
|
package/package.json
CHANGED
package/dist/sync.d.ts
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { DataResponse, HubspotModels, ProxyConfiguration, SyncWebhookBody, LogLevel, UpsertResponse } from '@nangohq/shared';
|
|
2
|
-
export { SyncWebhookBody as NangoSyncWebhookBody, HubspotModels };
|
|
3
|
-
import { Nango } from './index';
|
|
4
|
-
interface NangoProps {
|
|
5
|
-
activityLogId?: number;
|
|
6
|
-
lastSyncDate?: Date;
|
|
7
|
-
syncId?: string;
|
|
8
|
-
nangoConnectionId?: number;
|
|
9
|
-
syncJobId?: number;
|
|
10
|
-
}
|
|
11
|
-
interface UserLogParameters {
|
|
12
|
-
success?: boolean;
|
|
13
|
-
level?: LogLevel;
|
|
14
|
-
}
|
|
15
|
-
export declare class NangoSync {
|
|
16
|
-
nango: Nango;
|
|
17
|
-
activityLogId?: number;
|
|
18
|
-
lastSyncDate?: Date;
|
|
19
|
-
syncId?: string;
|
|
20
|
-
nangoConnectionId?: number;
|
|
21
|
-
syncJobId?: number;
|
|
22
|
-
private throttledCreateActivityLogMessage;
|
|
23
|
-
constructor(config?: NangoProps);
|
|
24
|
-
setLastSyncDate(date: Date): void;
|
|
25
|
-
proxy(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
26
|
-
get(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
27
|
-
post(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
28
|
-
patch(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
29
|
-
delete(config: ProxyConfiguration): Promise<import("axios").AxiosResponse<any, any>>;
|
|
30
|
-
batchSend(results: DataResponse[], model: string): Promise<UpsertResponse | null>;
|
|
31
|
-
log(content: string, userDefinedLevel?: UserLogParameters): Promise<void>;
|
|
32
|
-
}
|
package/dist/sync.js
DELETED
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
import _ from 'lodash';
|
|
2
|
-
import { updateSyncJobResult, createActivityLogMessage, dataService, syncDataService } from '@nangohq/shared';
|
|
3
|
-
import { Nango } from './index';
|
|
4
|
-
export class NangoSync {
|
|
5
|
-
nango;
|
|
6
|
-
activityLogId;
|
|
7
|
-
lastSyncDate;
|
|
8
|
-
syncId;
|
|
9
|
-
nangoConnectionId;
|
|
10
|
-
syncJobId;
|
|
11
|
-
throttledCreateActivityLogMessage;
|
|
12
|
-
constructor(config = {}) {
|
|
13
|
-
this.throttledCreateActivityLogMessage = _.throttle(createActivityLogMessage, 1000);
|
|
14
|
-
if (config.activityLogId) {
|
|
15
|
-
this.activityLogId = config.activityLogId;
|
|
16
|
-
}
|
|
17
|
-
this.nango = new Nango(config);
|
|
18
|
-
if (config.syncId) {
|
|
19
|
-
this.syncId = config.syncId;
|
|
20
|
-
}
|
|
21
|
-
if (config.nangoConnectionId) {
|
|
22
|
-
this.nangoConnectionId = config.nangoConnectionId;
|
|
23
|
-
}
|
|
24
|
-
if (config.syncJobId) {
|
|
25
|
-
this.syncJobId = config.syncJobId;
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
setLastSyncDate(date) {
|
|
29
|
-
this.lastSyncDate = date;
|
|
30
|
-
}
|
|
31
|
-
async proxy(config) {
|
|
32
|
-
return this.nango.proxy(config);
|
|
33
|
-
}
|
|
34
|
-
async get(config) {
|
|
35
|
-
return this.proxy({
|
|
36
|
-
...config,
|
|
37
|
-
method: 'GET'
|
|
38
|
-
});
|
|
39
|
-
}
|
|
40
|
-
async post(config) {
|
|
41
|
-
return this.proxy({
|
|
42
|
-
...config,
|
|
43
|
-
method: 'POST'
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
async patch(config) {
|
|
47
|
-
return this.proxy({
|
|
48
|
-
...config,
|
|
49
|
-
method: 'PATCH'
|
|
50
|
-
});
|
|
51
|
-
}
|
|
52
|
-
async delete(config) {
|
|
53
|
-
return this.proxy({
|
|
54
|
-
...config,
|
|
55
|
-
method: 'DELETE'
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
|
-
async batchSend(results, model) {
|
|
59
|
-
if (!this.nangoConnectionId || !this.syncId || !this.activityLogId || !this.syncJobId) {
|
|
60
|
-
throw new Error('Nango Connection Id, Sync Id, Activity Log Id and Sync Job Id are all required');
|
|
61
|
-
}
|
|
62
|
-
const formattedResults = syncDataService.formatDataRecords(results, this.nangoConnectionId, model, this.syncId);
|
|
63
|
-
const responseResults = await dataService.upsert(formattedResults, '_nango_sync_data_records', 'external_id', this.nangoConnectionId, model, this.activityLogId);
|
|
64
|
-
if (responseResults) {
|
|
65
|
-
const updatedResults = { added: responseResults.addedKeys.length, updated: responseResults.updatedKeys.length };
|
|
66
|
-
await createActivityLogMessage({
|
|
67
|
-
level: 'info',
|
|
68
|
-
activity_log_id: this.activityLogId,
|
|
69
|
-
content: `Batch send was a success and resulted in ${JSON.stringify(updatedResults, null, 2)}`,
|
|
70
|
-
timestamp: Date.now()
|
|
71
|
-
});
|
|
72
|
-
await updateSyncJobResult(this.syncJobId, updatedResults);
|
|
73
|
-
return responseResults;
|
|
74
|
-
}
|
|
75
|
-
else {
|
|
76
|
-
await createActivityLogMessage({
|
|
77
|
-
level: 'error',
|
|
78
|
-
activity_log_id: this.activityLogId,
|
|
79
|
-
content: `There was an issue with the batch send`,
|
|
80
|
-
timestamp: Date.now()
|
|
81
|
-
});
|
|
82
|
-
return null;
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
async log(content, userDefinedLevel) {
|
|
86
|
-
if (!this.activityLogId) {
|
|
87
|
-
throw new Error('There is no current activity log stream to log to');
|
|
88
|
-
}
|
|
89
|
-
await this.throttledCreateActivityLogMessage({
|
|
90
|
-
level: userDefinedLevel?.level ?? 'info',
|
|
91
|
-
activity_log_id: this.activityLogId,
|
|
92
|
-
content,
|
|
93
|
-
timestamp: Date.now()
|
|
94
|
-
});
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
//# sourceMappingURL=sync.js.map
|
package/dist/sync.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"sync.js","sourceRoot":"","sources":["../lib/sync.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAK9G,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAehC,MAAM,OAAO,SAAS;IAClB,KAAK,CAAQ;IACb,aAAa,CAAU;IACvB,YAAY,CAAQ;IACpB,MAAM,CAAU;IAChB,iBAAiB,CAAU;IAC3B,SAAS,CAAU;IAEX,iCAAiC,CAAC;IAE1C,YAAY,SAAqB,EAAE;QAC/B,IAAI,CAAC,iCAAiC,GAAG,CAAC,CAAC,QAAQ,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QAEpF,IAAI,MAAM,CAAC,aAAa,EAAE;YACtB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;SAC7C;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;SAC/B;QAED,IAAI,MAAM,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;SACrD;QAED,IAAI,MAAM,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;SACrC;IACL,CAAC;IAEM,eAAe,CAAC,IAAU;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,MAA0B;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpC,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,SAAS,CAAC,OAAuB,EAAE,KAAa;QACzD,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnF,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;SACrG;QAED,MAAM,gBAAgB,GAAG,eAAe,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,iBAA2B,EAAE,KAAK,EAAE,IAAI,CAAC,MAAgB,CAAC,CAAC;QAEpI,MAAM,eAAe,GAAG,MAAM,WAAW,CAAC,MAAM,CAC5C,gBAAgB,EAChB,0BAA0B,EAC1B,aAAa,EACb,IAAI,CAAC,iBAA2B,EAChC,KAAK,EACL,IAAI,CAAC,aAAuB,CAC/B,CAAC;QAEF,IAAI,eAAe,EAAE;YACjB,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YAEhH,MAAM,wBAAwB,CAAC;gBAC3B,KAAK,EAAE,MAAM;gBACb,eAAe,EAAE,IAAI,CAAC,aAAuB;gBAC7C,OAAO,EAAE,4CAA4C,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;gBAC9F,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACxB,CAAC,CAAC;YAEH,MAAM,mBAAmB,CAAC,IAAI,CAAC,SAAmB,EAAE,cAAc,CAAC,CAAC;YAEpE,OAAO,eAAe,CAAC;SAC1B;aAAM;YACH,MAAM,wBAAwB,CAAC;gBAC3B,KAAK,EAAE,OAAO;gBACd,eAAe,EAAE,IAAI,CAAC,aAAuB;gBAC7C,OAAO,EAAE,wCAAwC;gBACjD,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACxB,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;SACf;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,OAAe,EAAE,gBAAoC;QAClE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;SACxE;QAED,MAAM,IAAI,CAAC,iCAAiC,CAAC;YACzC,KAAK,EAAE,gBAAgB,EAAE,KAAK,IAAI,MAAM;YACxC,eAAe,EAAE,IAAI,CAAC,aAAuB;YAC7C,OAAO;YACP,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACxB,CAAC,CAAC;IACP,CAAC;CACJ"}
|