@tryfinch/finch-api 6.10.2 → 6.11.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/CHANGELOG.md +8 -0
- package/README.md +18 -1
- package/index.d.mts +6 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -1
- package/index.js +4 -0
- package/index.js.map +1 -1
- package/index.mjs +4 -0
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +13 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 6.11.0 (2024-11-25)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v6.10.2...v6.11.0](https://github.com/Finch-API/finch-api-node/compare/v6.10.2...v6.11.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **client:** do not run in browser context unless explicitly asked ([#500](https://github.com/Finch-API/finch-api-node/issues/500)) ([d251bc6](https://github.com/Finch-API/finch-api-node/commit/d251bc6a0ffa8df8ecc39cd6d3fc8a846843720e))
|
|
10
|
+
|
|
3
11
|
## 6.10.2 (2024-11-20)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v6.10.1...v6.10.2](https://github.com/Finch-API/finch-api-node/compare/v6.10.1...v6.10.2)
|
package/README.md
CHANGED
|
@@ -359,7 +359,6 @@ TypeScript >= 4.5 is supported.
|
|
|
359
359
|
|
|
360
360
|
The following runtimes are supported:
|
|
361
361
|
|
|
362
|
-
- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
|
|
363
362
|
- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
|
|
364
363
|
- Deno v1.28.0 or higher.
|
|
365
364
|
- Bun 1.0 or later.
|
|
@@ -367,6 +366,24 @@ The following runtimes are supported:
|
|
|
367
366
|
- Vercel Edge Runtime.
|
|
368
367
|
- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
|
|
369
368
|
- Nitro v2.6 or greater.
|
|
369
|
+
- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.
|
|
370
|
+
<details>
|
|
371
|
+
<summary>More explanation</summary>
|
|
372
|
+
|
|
373
|
+
### Why is this dangerous?
|
|
374
|
+
|
|
375
|
+
Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,
|
|
376
|
+
any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.
|
|
377
|
+
|
|
378
|
+
### When might this not be dangerous?
|
|
379
|
+
|
|
380
|
+
In certain scenarios where enabling browser support might not pose significant risks:
|
|
381
|
+
|
|
382
|
+
- Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.
|
|
383
|
+
- Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.
|
|
384
|
+
- Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.
|
|
385
|
+
|
|
386
|
+
</details>
|
|
370
387
|
|
|
371
388
|
Note that React Native is not supported at this time.
|
|
372
389
|
|
package/index.d.mts
CHANGED
|
@@ -78,6 +78,11 @@ export interface ClientOptions {
|
|
|
78
78
|
* param to `undefined` in request options.
|
|
79
79
|
*/
|
|
80
80
|
defaultQuery?: Core.DefaultQuery;
|
|
81
|
+
/**
|
|
82
|
+
* By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
83
|
+
* Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
|
|
84
|
+
*/
|
|
85
|
+
dangerouslyAllowBrowser?: boolean;
|
|
81
86
|
}
|
|
82
87
|
/**
|
|
83
88
|
* API Client for interfacing with the Finch API.
|
|
@@ -102,6 +107,7 @@ export declare class Finch extends Core.APIClient {
|
|
|
102
107
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
103
108
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
104
109
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
110
|
+
* @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
105
111
|
*/
|
|
106
112
|
constructor({ baseURL, accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
|
|
107
113
|
accessTokens: API.AccessTokens;
|
package/index.d.ts
CHANGED
|
@@ -78,6 +78,11 @@ export interface ClientOptions {
|
|
|
78
78
|
* param to `undefined` in request options.
|
|
79
79
|
*/
|
|
80
80
|
defaultQuery?: Core.DefaultQuery;
|
|
81
|
+
/**
|
|
82
|
+
* By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
83
|
+
* Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
|
|
84
|
+
*/
|
|
85
|
+
dangerouslyAllowBrowser?: boolean;
|
|
81
86
|
}
|
|
82
87
|
/**
|
|
83
88
|
* API Client for interfacing with the Finch API.
|
|
@@ -102,6 +107,7 @@ export declare class Finch extends Core.APIClient {
|
|
|
102
107
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
103
108
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
104
109
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
110
|
+
* @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
105
111
|
*/
|
|
106
112
|
constructor({ baseURL, accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
|
|
107
113
|
accessTokens: API.AccessTokens;
|
package/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EACL,KAAK,qBAAqB,EAC1B,uBAAuB,EACvB,KAAK,UAAU,EACf,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC7G,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EACL,iBAAiB,EACjB,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,QAAQ,EACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EACL,KAAK,qBAAqB,EAC1B,uBAAuB,EACvB,KAAK,UAAU,EACf,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC7G,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EACL,iBAAiB,EACjB,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,QAAQ,EACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAEjC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;IACvC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;;OAeG;gBACS,EACV,OAAwC,EACxC,WAAkB,EAClB,QAAkD,EAClD,YAA0D,EAC1D,aAA4D,EAC5D,GAAG,IAAI,EACR,GAAE,aAAkB;IAgCrB,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAmC;IAC3E,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAE7C;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBhF;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GACR,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,MAAM;IAcV;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK;cAIxB,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAQ5D,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO;cAoBlE,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAc5E,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAOlE,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAc9C,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,KAAK,eAAQ;IACpB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,UAAU,2BAAqB;IACtC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAaD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEzD,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IACvD,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,MAAM,QAAQ,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;IAC3D,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,MAAM,QAAQ,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IACrC,OAAO,EAAE,KAAK,UAAU,IAAI,UAAU,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,CAAC;IAE5E,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAE/F,OAAO,EAAE,SAAS,IAAI,SAAS,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAEzG,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,iBAAiB,IAAI,iBAAiB,EACtC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IAExB,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC5D,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACpD,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC,sBAAsB,CAAC;IAChE,MAAM,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;CACjC;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,KAAK,CAAC"}
|
package/index.js
CHANGED
|
@@ -60,6 +60,7 @@ class Finch extends Core.APIClient {
|
|
|
60
60
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
61
61
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
62
62
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
63
|
+
* @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
63
64
|
*/
|
|
64
65
|
constructor({ baseURL = Core.readEnv('FINCH_BASE_URL'), accessToken = null, clientId = Core.readEnv('FINCH_CLIENT_ID') ?? null, clientSecret = Core.readEnv('FINCH_CLIENT_SECRET') ?? null, webhookSecret = Core.readEnv('FINCH_WEBHOOK_SECRET') ?? null, ...opts } = {}) {
|
|
65
66
|
const options = {
|
|
@@ -70,6 +71,9 @@ class Finch extends Core.APIClient {
|
|
|
70
71
|
...opts,
|
|
71
72
|
baseURL: baseURL || `https://api.tryfinch.com`,
|
|
72
73
|
};
|
|
74
|
+
if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) {
|
|
75
|
+
throw new Errors.FinchError('This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })');
|
|
76
|
+
}
|
|
73
77
|
super({
|
|
74
78
|
baseURL: options.baseURL,
|
|
75
79
|
timeout: options.timeout ?? 60000 /* 1 minute */,
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,2DAAoC;AACpC,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAS3C,sDAAqC;AACrC,0DAAyC;AACzC,gEAA6G;AAC7G,oDAAiF;AACjF,wDAAiF;AACjF,0EAIwC;AACxC,sDAY8B;AAC9B,4DAAsD;AACtD,mDAAsE;AACtE,mDAA6C;AAC7C,4DAAsD;AACtD,4DAAsD;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,2DAAoC;AACpC,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAS3C,sDAAqC;AACrC,0DAAyC;AACzC,gEAA6G;AAC7G,oDAAiF;AACjF,wDAAiF;AACjF,0EAIwC;AACxC,sDAY8B;AAC9B,4DAAsD;AACtD,mDAAsE;AACtE,mDAA6C;AAC7C,4DAAsD;AACtD,4DAAsD;AAmFtD;;GAEG;AACH,MAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;IAQvC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EACxC,WAAW,GAAG,IAAI,EAClB,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,IAAI,EAClD,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,IAAI,EAC1D,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,IAAI,IAAI,EAC5D,GAAG,IAAI,KACU,EAAE;QACnB,MAAM,OAAO,GAAkB;YAC7B,WAAW;YACX,QAAQ;YACR,YAAY;YACZ,aAAa;YACb,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,0BAA0B;SAC/C,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,uBAAuB,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE;YACjE,MAAM,IAAI,MAAM,CAAC,UAAU,CACzB,wRAAwR,CACzR,CAAC;SACH;QAED,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAUL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,SAAI,GAAa,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,cAAS,GAAkB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,sBAAiB,GAA0B,IAAI,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC3E,SAAI,GAAa,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAjB3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAaD;;OAEG;IACH,cAAc,CAAC,IAAY,EAAE,OAAiC;QAC5D,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;SACpF;QACD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QACD,OAAO,IAAI,CAAC,IAAI,CAAgD,aAAa,EAAE;YAC7E,IAAI,EAAE;gBACJ,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;gBAChC,IAAI,EAAE,IAAI;gBACV,YAAY,EAAE,OAAO,EAAE,WAAW;aACnC;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,IAAI;aACpB;SACF,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GAKR;QACC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAChF;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,wCAAwC,CAAC,CAAC;QAC5E,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;YAC/B,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,WAAW;YACzB,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,WAAmB;QACjC,OAAO,IAAI,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;IACtD,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,mBAAmB,EAAE,YAAY;YACjC,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,eAAe,CAAC,OAAqB,EAAE,aAA2B;QACnF,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE;YAChD,OAAO;SACR;QACD,IAAI,aAAa,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE;YAClE,OAAO;SACR;QACD,IAAI,aAAa,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,MAAM,IAAI,KAAK,CACb,iMAAiM,CAClM,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEvC,IAAI,UAAU,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YACtD,OAAO,UAAU,CAAC;SACnB;QAED,IAAI,SAAS,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YACpD,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAES,UAAU,CAAC,IAA8B;QACjD,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,EAAE;YAC5B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACzD,CAAC;IAES,SAAS,CAAC,IAA8B;QAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO,EAAE,CAAC;SACX;QAED,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,OAAO,EAAE,CAAC;SACX;QAED,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5D,MAAM,aAAa,GAAG,SAAS,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,aAAa,EAAE,CAAC;IAC3B,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;;AAzMH,sBA8NC;;AAnBQ,WAAK,GAAG,EAAI,CAAC;AACb,qBAAe,GAAG,KAAK,CAAC,CAAC,WAAW;AAEpC,gBAAU,GAAG,MAAM,CAAC,UAAU,CAAC;AAC/B,cAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,wBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,+BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,uBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,mBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,mBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,oBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,qBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,yBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,2BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,8BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,YAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,kBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,KAAK,CAAC,YAAY,GAAG,4BAAY,CAAC;AAClC,KAAK,CAAC,IAAI,GAAG,WAAI,CAAC;AAClB,KAAK,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC5B,KAAK,CAAC,mBAAmB,GAAG,+BAAmB,CAAC;AAChD,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC;AACxB,KAAK,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC1B,KAAK,CAAC,iBAAiB,GAAG,sCAAiB,CAAC;AAC5C,KAAK,CAAC,IAAI,GAAG,WAAI,CAAC;AAClB,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC;AACxB,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC;AACxB,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC;AAqExB,wCAAiD;AAAxC,iGAAA,MAAM,OAAA;AAAE,uGAAA,YAAY,OAAA;AAC7B,oCAciB;AAbf,mGAAA,UAAU,OAAA;AACV,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA;AAG1B,kBAAe,KAAK,CAAC"}
|
package/index.mjs
CHANGED
|
@@ -34,6 +34,7 @@ export class Finch extends Core.APIClient {
|
|
|
34
34
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
35
35
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
36
36
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
37
|
+
* @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
37
38
|
*/
|
|
38
39
|
constructor({ baseURL = Core.readEnv('FINCH_BASE_URL'), accessToken = null, clientId = Core.readEnv('FINCH_CLIENT_ID') ?? null, clientSecret = Core.readEnv('FINCH_CLIENT_SECRET') ?? null, webhookSecret = Core.readEnv('FINCH_WEBHOOK_SECRET') ?? null, ...opts } = {}) {
|
|
39
40
|
const options = {
|
|
@@ -44,6 +45,9 @@ export class Finch extends Core.APIClient {
|
|
|
44
45
|
...opts,
|
|
45
46
|
baseURL: baseURL || `https://api.tryfinch.com`,
|
|
46
47
|
};
|
|
48
|
+
if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) {
|
|
49
|
+
throw new Errors.FinchError('This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })');
|
|
50
|
+
}
|
|
47
51
|
super({
|
|
48
52
|
baseURL: options.baseURL,
|
|
49
53
|
timeout: options.timeout ?? 60000 /* 1 minute */,
|
package/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,EAAE;OACP,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OASf,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAA2B,YAAY,EAA6B;OACpE,EAAE,OAAO,EAAqC;OAC9C,EAAY,SAAS,EAAE,mBAAmB,EAAE;OAC5C,EACL,iBAAiB,GAGlB;OACM,EAWL,QAAQ,GACT;OACM,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAA2B;OACjC,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,OAAO,EAAE;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,EAAE;OACP,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OASf,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAA2B,YAAY,EAA6B;OACpE,EAAE,OAAO,EAAqC;OAC9C,EAAY,SAAS,EAAE,mBAAmB,EAAE;OAC5C,EACL,iBAAiB,GAGlB;OACM,EAWL,QAAQ,GACT;OACM,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAA2B;OACjC,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,OAAO,EAAE;AAmFlB;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,IAAI,CAAC,SAAS;IAQvC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EACxC,WAAW,GAAG,IAAI,EAClB,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,IAAI,EAClD,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,IAAI,EAC1D,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,IAAI,IAAI,EAC5D,GAAG,IAAI,KACU,EAAE;QACnB,MAAM,OAAO,GAAkB;YAC7B,WAAW;YACX,QAAQ;YACR,YAAY;YACZ,aAAa;YACb,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,0BAA0B;SAC/C,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,uBAAuB,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE;YACjE,MAAM,IAAI,MAAM,CAAC,UAAU,CACzB,wRAAwR,CACzR,CAAC;SACH;QAED,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAUL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,SAAI,GAAa,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,cAAS,GAAkB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,sBAAiB,GAA0B,IAAI,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC3E,SAAI,GAAa,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAjB3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAaD;;OAEG;IACH,cAAc,CAAC,IAAY,EAAE,OAAiC;QAC5D,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;SACpF;QACD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QACD,OAAO,IAAI,CAAC,IAAI,CAAgD,aAAa,EAAE;YAC7E,IAAI,EAAE;gBACJ,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;gBAChC,IAAI,EAAE,IAAI;gBACV,YAAY,EAAE,OAAO,EAAE,WAAW;aACnC;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,IAAI;aACpB;SACF,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GAKR;QACC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAChF;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,wCAAwC,CAAC,CAAC;QAC5E,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;YAC/B,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,WAAW;YACzB,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,WAAmB;QACjC,OAAO,IAAI,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;IACtD,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,mBAAmB,EAAE,YAAY;YACjC,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,eAAe,CAAC,OAAqB,EAAE,aAA2B;QACnF,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE;YAChD,OAAO;SACR;QACD,IAAI,aAAa,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE;YAClE,OAAO;SACR;QACD,IAAI,aAAa,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE;YAC3C,OAAO;SACR;QAED,MAAM,IAAI,KAAK,CACb,iMAAiM,CAClM,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEvC,IAAI,UAAU,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YACtD,OAAO,UAAU,CAAC;SACnB;QAED,IAAI,SAAS,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YACpD,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAES,UAAU,CAAC,IAA8B;QACjD,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,EAAE;YAC5B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IACzD,CAAC;IAES,SAAS,CAAC,IAA8B;QAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO,EAAE,CAAC;SACX;QAED,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,OAAO,EAAE,CAAC;SACX;QAED,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5D,MAAM,aAAa,GAAG,SAAS,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,aAAa,EAAE,CAAC;IAC3B,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;;;AAEM,WAAK,GAAG,EAAI,CAAC;AACb,qBAAe,GAAG,KAAK,CAAC,CAAC,WAAW;AAEpC,gBAAU,GAAG,MAAM,CAAC,UAAU,CAAC;AAC/B,cAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,wBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,+BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,uBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,mBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,mBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,oBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,qBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,yBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,2BAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,8BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,YAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,kBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;AAClC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;AAClB,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;AAC5B,KAAK,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;AAChD,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;AACxB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC1B,KAAK,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AAC5C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;AAClB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;AACxB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;AACxB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;OAqEjB,EAAE,MAAM,EAAE,YAAY,EAAE;OACxB,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;AAED,eAAe,KAAK,CAAC"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -115,6 +115,12 @@ export interface ClientOptions {
|
|
|
115
115
|
* param to `undefined` in request options.
|
|
116
116
|
*/
|
|
117
117
|
defaultQuery?: Core.DefaultQuery;
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
121
|
+
* Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
|
|
122
|
+
*/
|
|
123
|
+
dangerouslyAllowBrowser?: boolean;
|
|
118
124
|
}
|
|
119
125
|
|
|
120
126
|
/**
|
|
@@ -142,6 +148,7 @@ export class Finch extends Core.APIClient {
|
|
|
142
148
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
143
149
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
144
150
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
151
|
+
* @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
|
|
145
152
|
*/
|
|
146
153
|
constructor({
|
|
147
154
|
baseURL = Core.readEnv('FINCH_BASE_URL'),
|
|
@@ -160,6 +167,12 @@ export class Finch extends Core.APIClient {
|
|
|
160
167
|
baseURL: baseURL || `https://api.tryfinch.com`,
|
|
161
168
|
};
|
|
162
169
|
|
|
170
|
+
if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) {
|
|
171
|
+
throw new Errors.FinchError(
|
|
172
|
+
'This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })',
|
|
173
|
+
);
|
|
174
|
+
}
|
|
175
|
+
|
|
163
176
|
super({
|
|
164
177
|
baseURL: options.baseURL!,
|
|
165
178
|
timeout: options.timeout ?? 60000 /* 1 minute */,
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.11.0'; // x-release-please-version
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.11.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.11.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|