@chainlink/external-adapter-framework 0.3.9 → 0.4.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.
Files changed (201) hide show
  1. package/README.md +102 -0
  2. package/package.json +42 -50
  3. package/adapter/basic.d.ts +0 -86
  4. package/adapter/basic.js +0 -325
  5. package/adapter/basic.js.map +0 -1
  6. package/adapter/endpoint.d.ts +0 -17
  7. package/adapter/endpoint.js +0 -19
  8. package/adapter/endpoint.js.map +0 -1
  9. package/adapter/index.d.ts +0 -4
  10. package/adapter/index.js +0 -21
  11. package/adapter/index.js.map +0 -1
  12. package/adapter/price.d.ts +0 -75
  13. package/adapter/price.js +0 -88
  14. package/adapter/price.js.map +0 -1
  15. package/adapter/types.d.ts +0 -118
  16. package/adapter/types.js +0 -3
  17. package/adapter/types.js.map +0 -1
  18. package/background-executor.d.ts +0 -9
  19. package/background-executor.js +0 -97
  20. package/background-executor.js.map +0 -1
  21. package/cache/factory.d.ts +0 -6
  22. package/cache/factory.js +0 -24
  23. package/cache/factory.js.map +0 -1
  24. package/cache/index.d.ts +0 -87
  25. package/cache/index.js +0 -133
  26. package/cache/index.js.map +0 -1
  27. package/cache/local.d.ts +0 -23
  28. package/cache/local.js +0 -84
  29. package/cache/local.js.map +0 -1
  30. package/cache/metrics.d.ts +0 -27
  31. package/cache/metrics.js +0 -121
  32. package/cache/metrics.js.map +0 -1
  33. package/cache/redis.d.ts +0 -16
  34. package/cache/redis.js +0 -101
  35. package/cache/redis.js.map +0 -1
  36. package/config/index.d.ts +0 -298
  37. package/config/index.js +0 -359
  38. package/config/index.js.map +0 -1
  39. package/config/provider-limits.d.ts +0 -27
  40. package/config/provider-limits.js +0 -75
  41. package/config/provider-limits.js.map +0 -1
  42. package/examples/bank-frick/accounts.d.ts +0 -52
  43. package/examples/bank-frick/accounts.js +0 -190
  44. package/examples/bank-frick/accounts.js.map +0 -1
  45. package/examples/bank-frick/config/index.d.ts +0 -17
  46. package/examples/bank-frick/config/index.js +0 -55
  47. package/examples/bank-frick/config/index.js.map +0 -1
  48. package/examples/bank-frick/index.d.ts +0 -16
  49. package/examples/bank-frick/index.js +0 -16
  50. package/examples/bank-frick/index.js.map +0 -1
  51. package/examples/bank-frick/util.d.ts +0 -4
  52. package/examples/bank-frick/util.js +0 -40
  53. package/examples/bank-frick/util.js.map +0 -1
  54. package/examples/coingecko/src/config/index.d.ts +0 -2
  55. package/examples/coingecko/src/config/index.js +0 -6
  56. package/examples/coingecko/src/config/index.js.map +0 -1
  57. package/examples/coingecko/src/config/overrides.json +0 -10825
  58. package/examples/coingecko/src/crypto-utils.d.ts +0 -48
  59. package/examples/coingecko/src/crypto-utils.js +0 -60
  60. package/examples/coingecko/src/crypto-utils.js.map +0 -1
  61. package/examples/coingecko/src/endpoint/coins.d.ts +0 -9
  62. package/examples/coingecko/src/endpoint/coins.js +0 -37
  63. package/examples/coingecko/src/endpoint/coins.js.map +0 -1
  64. package/examples/coingecko/src/endpoint/crypto-marketcap.d.ts +0 -3
  65. package/examples/coingecko/src/endpoint/crypto-marketcap.js +0 -30
  66. package/examples/coingecko/src/endpoint/crypto-marketcap.js.map +0 -1
  67. package/examples/coingecko/src/endpoint/crypto-volume.d.ts +0 -3
  68. package/examples/coingecko/src/endpoint/crypto-volume.js +0 -30
  69. package/examples/coingecko/src/endpoint/crypto-volume.js.map +0 -1
  70. package/examples/coingecko/src/endpoint/crypto.d.ts +0 -2
  71. package/examples/coingecko/src/endpoint/crypto.js +0 -28
  72. package/examples/coingecko/src/endpoint/crypto.js.map +0 -1
  73. package/examples/coingecko/src/endpoint/dominance.d.ts +0 -3
  74. package/examples/coingecko/src/endpoint/dominance.js +0 -28
  75. package/examples/coingecko/src/endpoint/dominance.js.map +0 -1
  76. package/examples/coingecko/src/endpoint/global-marketcap.d.ts +0 -3
  77. package/examples/coingecko/src/endpoint/global-marketcap.js +0 -28
  78. package/examples/coingecko/src/endpoint/global-marketcap.js.map +0 -1
  79. package/examples/coingecko/src/endpoint/index.d.ts +0 -6
  80. package/examples/coingecko/src/endpoint/index.js +0 -16
  81. package/examples/coingecko/src/endpoint/index.js.map +0 -1
  82. package/examples/coingecko/src/global-utils.d.ts +0 -27
  83. package/examples/coingecko/src/global-utils.js +0 -47
  84. package/examples/coingecko/src/global-utils.js.map +0 -1
  85. package/examples/coingecko/src/index.d.ts +0 -4
  86. package/examples/coingecko/src/index.js +0 -19
  87. package/examples/coingecko/src/index.js.map +0 -1
  88. package/examples/coingecko-old/batch-warming.d.ts +0 -7
  89. package/examples/coingecko-old/batch-warming.js +0 -54
  90. package/examples/coingecko-old/batch-warming.js.map +0 -1
  91. package/examples/coingecko-old/index.d.ts +0 -2
  92. package/examples/coingecko-old/index.js +0 -12
  93. package/examples/coingecko-old/index.js.map +0 -1
  94. package/examples/coingecko-old/rest.d.ts +0 -12
  95. package/examples/coingecko-old/rest.js +0 -55
  96. package/examples/coingecko-old/rest.js.map +0 -1
  97. package/examples/cryptocompare/src/config/index.d.ts +0 -2
  98. package/examples/cryptocompare/src/config/index.js +0 -6
  99. package/examples/cryptocompare/src/config/index.js.map +0 -1
  100. package/examples/cryptocompare/src/endpoints/crypto.d.ts +0 -28
  101. package/examples/cryptocompare/src/endpoints/crypto.js +0 -54
  102. package/examples/cryptocompare/src/endpoints/crypto.js.map +0 -1
  103. package/examples/cryptocompare/src/endpoints/index.d.ts +0 -1
  104. package/examples/cryptocompare/src/endpoints/index.js +0 -6
  105. package/examples/cryptocompare/src/endpoints/index.js.map +0 -1
  106. package/examples/cryptocompare/src/index.d.ts +0 -4
  107. package/examples/cryptocompare/src/index.js +0 -14
  108. package/examples/cryptocompare/src/index.js.map +0 -1
  109. package/examples/genesis/config/index.d.ts +0 -7
  110. package/examples/genesis/config/index.js +0 -11
  111. package/examples/genesis/config/index.js.map +0 -1
  112. package/examples/genesis/index.d.ts +0 -2
  113. package/examples/genesis/index.js +0 -13
  114. package/examples/genesis/index.js.map +0 -1
  115. package/examples/genesis/sseStream.d.ts +0 -16
  116. package/examples/genesis/sseStream.js +0 -149
  117. package/examples/genesis/sseStream.js.map +0 -1
  118. package/index.d.ts +0 -17
  119. package/index.js +0 -174
  120. package/index.js.map +0 -1
  121. package/metrics/constants.d.ts +0 -16
  122. package/metrics/constants.js +0 -26
  123. package/metrics/constants.js.map +0 -1
  124. package/metrics/index.d.ts +0 -19
  125. package/metrics/index.js +0 -139
  126. package/metrics/index.js.map +0 -1
  127. package/metrics/util.d.ts +0 -7
  128. package/metrics/util.js +0 -10
  129. package/metrics/util.js.map +0 -1
  130. package/rate-limiting/background/fixed-frequency.d.ts +0 -11
  131. package/rate-limiting/background/fixed-frequency.js +0 -36
  132. package/rate-limiting/background/fixed-frequency.js.map +0 -1
  133. package/rate-limiting/index.d.ts +0 -56
  134. package/rate-limiting/index.js +0 -86
  135. package/rate-limiting/index.js.map +0 -1
  136. package/rate-limiting/metrics.d.ts +0 -3
  137. package/rate-limiting/metrics.js +0 -45
  138. package/rate-limiting/metrics.js.map +0 -1
  139. package/rate-limiting/request/simple-counting.d.ts +0 -21
  140. package/rate-limiting/request/simple-counting.js +0 -63
  141. package/rate-limiting/request/simple-counting.js.map +0 -1
  142. package/transports/batch-warming.d.ts +0 -35
  143. package/transports/batch-warming.js +0 -138
  144. package/transports/batch-warming.js.map +0 -1
  145. package/transports/index.d.ts +0 -87
  146. package/transports/index.js +0 -56
  147. package/transports/index.js.map +0 -1
  148. package/transports/metrics.d.ts +0 -25
  149. package/transports/metrics.js +0 -122
  150. package/transports/metrics.js.map +0 -1
  151. package/transports/rest.d.ts +0 -51
  152. package/transports/rest.js +0 -133
  153. package/transports/rest.js.map +0 -1
  154. package/transports/routing.d.ts +0 -23
  155. package/transports/routing.js +0 -52
  156. package/transports/routing.js.map +0 -1
  157. package/transports/sse.d.ts +0 -40
  158. package/transports/sse.js +0 -92
  159. package/transports/sse.js.map +0 -1
  160. package/transports/util.d.ts +0 -9
  161. package/transports/util.js +0 -87
  162. package/transports/util.js.map +0 -1
  163. package/transports/websocket.d.ts +0 -81
  164. package/transports/websocket.js +0 -165
  165. package/transports/websocket.js.map +0 -1
  166. package/util/censor/censor-list.d.ts +0 -9
  167. package/util/censor/censor-list.js +0 -13
  168. package/util/censor/censor-list.js.map +0 -1
  169. package/util/index.d.ts +0 -13
  170. package/util/index.js +0 -38
  171. package/util/index.js.map +0 -1
  172. package/util/logger.d.ts +0 -49
  173. package/util/logger.js +0 -123
  174. package/util/logger.js.map +0 -1
  175. package/util/request.d.ts +0 -102
  176. package/util/request.js +0 -3
  177. package/util/request.js.map +0 -1
  178. package/util/subscription-set/expiring-sorted-set.d.ts +0 -21
  179. package/util/subscription-set/expiring-sorted-set.js +0 -36
  180. package/util/subscription-set/expiring-sorted-set.js.map +0 -1
  181. package/util/subscription-set/redis-sorted-set.d.ts +0 -9
  182. package/util/subscription-set/redis-sorted-set.js +0 -29
  183. package/util/subscription-set/redis-sorted-set.js.map +0 -1
  184. package/util/subscription-set/subscription-set.d.ts +0 -19
  185. package/util/subscription-set/subscription-set.js +0 -28
  186. package/util/subscription-set/subscription-set.js.map +0 -1
  187. package/util/test-payload-loader.d.ts +0 -26
  188. package/util/test-payload-loader.js +0 -85
  189. package/util/test-payload-loader.js.map +0 -1
  190. package/validation/error.d.ts +0 -48
  191. package/validation/error.js +0 -78
  192. package/validation/error.js.map +0 -1
  193. package/validation/index.d.ts +0 -5
  194. package/validation/index.js +0 -91
  195. package/validation/index.js.map +0 -1
  196. package/validation/input-params.d.ts +0 -14
  197. package/validation/input-params.js +0 -3
  198. package/validation/input-params.js.map +0 -1
  199. package/validation/input-validator.d.ts +0 -16
  200. package/validation/input-validator.js +0 -123
  201. package/validation/input-validator.js.map +0 -1
@@ -1,27 +0,0 @@
1
- export declare const DEFAULT_MINUTE_RATE_LIMIT = 60;
2
- export declare const BURST_UNDEFINED_QUOTA_MULTIPLE = 2;
3
- export declare const DEFAULT_WS_CONNECTIONS = 2;
4
- export declare const DEFAULT_WS_SUBSCRIPTIONS = 10;
5
- declare type RateLimitTimeFrame = 'rateLimit1s' | 'rateLimit1m' | 'rateLimit1h';
6
- declare type HTTPTier = {
7
- rateLimit1s?: number;
8
- rateLimit1m?: number;
9
- rateLimit1h?: number;
10
- note?: string;
11
- };
12
- declare type WSTier = {
13
- connections: number;
14
- subscriptions: number;
15
- };
16
- export interface Limits {
17
- http: Record<string, HTTPTier>;
18
- ws: Record<string, WSTier>;
19
- }
20
- interface ProviderRateLimit {
21
- second: number;
22
- minute: number;
23
- }
24
- export declare const getHTTPLimit: (provider: string, limits: Limits, tier: string, timeframe: RateLimitTimeFrame) => number;
25
- export declare const getRateLimit: (provider: string, limits: Limits, tier: string) => ProviderRateLimit;
26
- export declare const getWSLimits: (provider: string, limits: Limits, tier: string) => WSTier;
27
- export {};
@@ -1,75 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getWSLimits = exports.getRateLimit = exports.getHTTPLimit = exports.DEFAULT_WS_SUBSCRIPTIONS = exports.DEFAULT_WS_CONNECTIONS = exports.BURST_UNDEFINED_QUOTA_MULTIPLE = exports.DEFAULT_MINUTE_RATE_LIMIT = void 0;
4
- const util_1 = require("../util");
5
- exports.DEFAULT_MINUTE_RATE_LIMIT = 60;
6
- exports.BURST_UNDEFINED_QUOTA_MULTIPLE = 2;
7
- exports.DEFAULT_WS_CONNECTIONS = 2;
8
- exports.DEFAULT_WS_SUBSCRIPTIONS = 10;
9
- const logger = (0, util_1.makeLogger)('ProviderLimits');
10
- const getHTTPLimit = (provider, limits, tier, timeframe) => {
11
- const providerLimit = getProviderLimits(provider, limits, tier, 'http');
12
- return providerLimit?.[timeframe] || 0;
13
- };
14
- exports.getHTTPLimit = getHTTPLimit;
15
- const getRateLimit = (provider, limits, tier) => {
16
- const providerLimit = getProviderLimits(provider, limits, tier, 'http');
17
- return calculateRateLimit(providerLimit);
18
- };
19
- exports.getRateLimit = getRateLimit;
20
- const getWSLimits = (provider, limits, tier) => {
21
- const providerLimit = getProviderLimits(provider, limits, tier, 'ws');
22
- return calculateWSLimits(providerLimit);
23
- };
24
- exports.getWSLimits = getWSLimits;
25
- const getProviderLimits = (provider, limits, tier, protocol) => {
26
- const providerConfig = parseLimits(limits);
27
- if (!providerConfig) {
28
- throw new Error(`Rate Limit: Provider: "${provider}" doesn't match any provider spec in limits.json`);
29
- }
30
- const protocolConfig = providerConfig[protocol];
31
- if (!protocolConfig) {
32
- throw new Error(`Rate Limit: "${provider}" doesn't have any configuration for ${protocol} in limits.json`);
33
- }
34
- let limitsConfig = protocolConfig[tier.toLowerCase()];
35
- if (!limitsConfig) {
36
- logger.debug(`Rate Limit: "${provider} does not have tier ${tier} defined. Falling back to lowest tier"`);
37
- limitsConfig = Object.values(protocolConfig)?.[0];
38
- }
39
- if (!limitsConfig) {
40
- throw new Error(`Rate Limit: Provider: "${provider}" has no tiers defined for ${protocol} in limits.json`);
41
- }
42
- return limitsConfig;
43
- };
44
- const objectKeysToLowercase = (obj) => {
45
- const lower = {};
46
- for (const key in obj) {
47
- lower[key.toLowerCase()] = obj[key];
48
- }
49
- return lower;
50
- };
51
- const parseLimits = (limits) => {
52
- limits.http = objectKeysToLowercase(limits.http);
53
- limits.ws = objectKeysToLowercase(limits.ws);
54
- return limits;
55
- };
56
- const calculateWSLimits = (providerLimit) => {
57
- return {
58
- connections: providerLimit.connections,
59
- subscriptions: providerLimit.subscriptions,
60
- };
61
- };
62
- const calculateRateLimit = (providerLimit) => {
63
- let quota = providerLimit.rateLimit1m;
64
- if (!quota && providerLimit?.rateLimit1h) {
65
- quota = providerLimit?.rateLimit1h / 60;
66
- }
67
- else if (!quota && providerLimit?.rateLimit1s) {
68
- quota = providerLimit?.rateLimit1s * 60;
69
- }
70
- return {
71
- second: providerLimit?.rateLimit1s || (quota / 60) * exports.BURST_UNDEFINED_QUOTA_MULTIPLE,
72
- minute: quota,
73
- };
74
- };
75
- //# sourceMappingURL=provider-limits.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"provider-limits.js","sourceRoot":"","sources":["../../../src/config/provider-limits.ts"],"names":[],"mappings":";;;AAAA,kCAAoC;AAEvB,QAAA,yBAAyB,GAAG,EAAE,CAAA;AAC9B,QAAA,8BAA8B,GAAG,CAAC,CAAA;AAElC,QAAA,sBAAsB,GAAG,CAAC,CAAA;AAC1B,QAAA,wBAAwB,GAAG,EAAE,CAAA;AA0B1C,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,gBAAgB,CAAC,CAAA;AAEpC,MAAM,YAAY,GAAG,CAC1B,QAAgB,EAChB,MAAc,EACd,IAAY,EACZ,SAA6B,EACrB,EAAE;IACV,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACvE,OAAQ,aAA0B,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AACtD,CAAC,CAAA;AARY,QAAA,YAAY,gBAQxB;AAEM,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAY,EAAqB,EAAE;IAChG,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACvE,OAAO,kBAAkB,CAAC,aAAyB,CAAC,CAAA;AACtD,CAAC,CAAA;AAHY,QAAA,YAAY,gBAGxB;AAEM,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAY,EAAU,EAAE;IACpF,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IACrE,OAAO,iBAAiB,CAAC,aAAuB,CAAC,CAAA;AACnD,CAAC,CAAA;AAHY,QAAA,WAAW,eAGvB;AAED,MAAM,iBAAiB,GAAG,CACxB,QAAgB,EAChB,MAAc,EACd,IAAY,EACZ,QAAuB,EACQ,EAAE;IACjC,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,kDAAkD,CACrF,CAAA;KACF;IAED,MAAM,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IAC/C,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,gBAAgB,QAAQ,wCAAwC,QAAQ,iBAAiB,CAC1F,CAAA;KACF;IAED,IAAI,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IAErD,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,CAAC,KAAK,CACV,gBAAgB,QAAQ,uBAAuB,IAAI,wCAAwC,CAC5F,CAAA;QACD,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;KAClD;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,8BAA8B,QAAQ,iBAAiB,CAC1F,CAAA;KACF;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAI,GAAsB,EAAqB,EAAE;IAC7E,MAAM,KAAK,GAAsB,EAAE,CAAA;IAEnC,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;QACrB,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;KACpC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,MAAc,EAAU,EAAE;IAC7C,MAAM,CAAC,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAChD,MAAM,CAAC,EAAE,GAAG,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC5C,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,CAAC,aAAqB,EAAU,EAAE;IAC1D,OAAO;QACL,WAAW,EAAE,aAAa,CAAC,WAAW;QACtC,aAAa,EAAE,aAAa,CAAC,aAAa;KAC3C,CAAA;AACH,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,CAAC,aAAuB,EAAqB,EAAE;IACxE,IAAI,KAAK,GAAG,aAAa,CAAC,WAAW,CAAA;IACrC,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,WAAW,EAAE;QACxC,KAAK,GAAG,aAAa,EAAE,WAAW,GAAG,EAAE,CAAA;KACxC;SAAM,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,WAAW,EAAE;QAC/C,KAAK,GAAG,aAAa,EAAE,WAAW,GAAG,EAAE,CAAA;KACxC;IACD,OAAO;QACL,MAAM,EAAE,aAAa,EAAE,WAAW,IAAI,CAAE,KAAgB,GAAG,EAAE,CAAC,GAAG,sCAA8B;QAC/F,MAAM,EAAE,KAAe;KACxB,CAAA;AACH,CAAC,CAAA"}
@@ -1,52 +0,0 @@
1
- import { AxiosRequestConfig, AxiosResponse } from 'axios';
2
- import { AdapterInputParameters, BankFrickAccountsRequestSchema, BankFrickAccountsResponseSchema, SigningAlgorithm } from './types';
3
- import { customSettings } from './config';
4
- import { Transport } from '../../transports';
5
- import { AdapterRequest, AdapterResponse } from '../../util';
6
- import { AdapterConfig } from '../../config';
7
- import { Cache } from '../../cache';
8
- import { AdapterDependencies, AdapterEndpoint } from '../../adapter';
9
- /**
10
- * RestTransport implementation for Bank Frick, which has unusually complex requirements for an EA
11
- * The RestTransport is generally built to make a single request and return a single response.
12
- * This transport instead is used to fetch and process pages of data, and also requires a JWT to run
13
- *
14
- * This transport does all the heavy lifting in setup(), which is where the paging happens, and it
15
- * also has complex retry logic that will attempt to refresh the JWT when certain HTTP errors occur
16
- */
17
- export declare class BankFrickAccountsTransport implements Transport<AdapterInputParameters, number, typeof customSettings> {
18
- token: string;
19
- cache: Cache<AdapterResponse<number>>;
20
- initialize(dependencies: AdapterDependencies): Promise<void>;
21
- /**
22
- * Creates an AxiosRequestConfig object for fetching a page of accounts from the Bank Frick API
23
- */
24
- prepareRequest(firstPosition: number, inputParams: AdapterInputParameters, config: AdapterConfig<typeof customSettings>): AxiosRequestConfig<BankFrickAccountsRequestSchema>;
25
- /**
26
- * Request with retry logic for Bank Frick's API. In addition to standard retry logic, this function
27
- * compares errors against expected errors from the Bank Frick API, and will throw without retries
28
- * on a known fatal error, or try to refresh the JWT on a known auth error
29
- **/
30
- makeRequest(axiosRequest: AxiosRequestConfig<BankFrickAccountsRequestSchema>, config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm): Promise<AxiosResponse<BankFrickAccountsResponseSchema>>;
31
- validateInputParams(params: AdapterInputParameters): string[];
32
- /**
33
- * Fetches pages of data from the Bank Frick API, scans for accounts by IBAN, and returns the balance
34
- * of all found accounts. Returns a 404 if any IBAN isn't found.
35
- */
36
- foregroundExecute(req: AdapterRequest<AdapterInputParameters>, config: AdapterConfig<typeof customSettings>): Promise<AdapterResponse<number>>;
37
- }
38
- export declare const accountsRestEndpoint: AdapterEndpoint<AdapterInputParameters, number, {
39
- readonly PAGE_SIZE: {
40
- readonly description: "The number of accounts to fetch per call to /accounts. Must be >= 1 and <= 500.";
41
- readonly type: "number";
42
- readonly required: false;
43
- readonly default: 500;
44
- readonly validate: (value?: number | undefined) => string | undefined;
45
- };
46
- readonly PRIVATE_KEY: {
47
- readonly description: "";
48
- readonly type: "string";
49
- readonly required: true;
50
- readonly validate: (value: string) => string | undefined;
51
- };
52
- }>;
@@ -1,190 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.accountsRestEndpoint = exports.BankFrickAccountsTransport = void 0;
7
- const axios_1 = __importDefault(require("axios"));
8
- const util_1 = require("./util");
9
- const util_2 = require("../../util");
10
- const error_1 = require("../../validation/error");
11
- const adapter_1 = require("../../adapter");
12
- const logger = (0, util_2.makeLogger)('BankFrickTransport');
13
- // Note: this is a shallow pattern that only checks for a country code since IBANs in the sandbox are invalid
14
- const ibanPattern = /^[A-Z]{2}[A-Z\d]{14,30}$/;
15
- const inputParameters = {
16
- ibanIDs: {
17
- description: 'The list of account ids included in the sum of balances',
18
- required: true,
19
- type: 'array',
20
- },
21
- signingAlgorithm: {
22
- description: 'What signing algorithm is used to sign and verify authorization data, one of rsa-sha256, rsa-sha384, or rsa-sha512',
23
- required: false,
24
- type: 'string',
25
- default: 'rsa-sha512',
26
- options: ['rsa-sha256', 'rsa-sha384', 'rsa-sha512'],
27
- },
28
- };
29
- // See here for all expected error returned by the API: https://developers.bankfrick.li/docs#errors
30
- const AuthErrors = {
31
- 401: 'No JWT token provided or token is invalid',
32
- 403: 'API key is invalid or any other condition is hindering the login', // Unclear if this is fatal or not
33
- };
34
- const FatalErrors = {
35
- 400: "Invalid parameters passed to Bank Frick's API",
36
- 423: "Authorization is valid, but the user's account is locked",
37
- };
38
- /**
39
- * RestTransport implementation for Bank Frick, which has unusually complex requirements for an EA
40
- * The RestTransport is generally built to make a single request and return a single response.
41
- * This transport instead is used to fetch and process pages of data, and also requires a JWT to run
42
- *
43
- * This transport does all the heavy lifting in setup(), which is where the paging happens, and it
44
- * also has complex retry logic that will attempt to refresh the JWT when certain HTTP errors occur
45
- */
46
- class BankFrickAccountsTransport {
47
- async initialize(dependencies) {
48
- this.cache = dependencies.cache;
49
- }
50
- /**
51
- * Creates an AxiosRequestConfig object for fetching a page of accounts from the Bank Frick API
52
- */
53
- prepareRequest(firstPosition, inputParams, config) {
54
- const { API_ENDPOINT, BASE_URL, PAGE_SIZE } = config;
55
- return {
56
- baseURL: API_ENDPOINT + BASE_URL,
57
- url: 'accounts',
58
- method: 'GET',
59
- params: {
60
- firstPosition,
61
- maxResults: PAGE_SIZE,
62
- },
63
- headers: {
64
- Authorization: `Bearer ${this.token}`,
65
- },
66
- };
67
- }
68
- /**
69
- * Request with retry logic for Bank Frick's API. In addition to standard retry logic, this function
70
- * compares errors against expected errors from the Bank Frick API, and will throw without retries
71
- * on a known fatal error, or try to refresh the JWT on a known auth error
72
- **/
73
- async makeRequest(axiosRequest, config, signingAlgorithm) {
74
- let retryNumber = 0;
75
- let response = await axios_1.default.request(axiosRequest);
76
- while (response.status !== 200) {
77
- retryNumber++;
78
- logger.warn('Encountered error when fetching accounts from Bank Frick:', response.status, response.statusText);
79
- // Evaluate whether the error was fatal, auth, or transient and whether we've exceeded the max number of retries.
80
- // Throw on fatal, refresh token on auth error, pass on transient until we've exhausted our retries
81
- if (FatalErrors[response.status]) {
82
- throw new error_1.AdapterError({
83
- statusCode: response.status,
84
- message: response.statusText,
85
- });
86
- }
87
- else if (AuthErrors[response.status]) {
88
- // We've encountered a known auth error, so try to refresh the token before making another request
89
- logger.info('Auth error received from the Bank Frick API, attempting to refresh the token');
90
- this.token = await (0, util_1.generateJWT)(config, signingAlgorithm);
91
- }
92
- else if (retryNumber === config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES) {
93
- throw new error_1.AdapterError({
94
- statusCode: 504,
95
- message: `Bank Frick transport hit the max number of retries (${config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES} retries) and aborted`,
96
- });
97
- }
98
- logger.debug(`Sleeping for ${config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES}ms before retrying`);
99
- await (0, util_2.sleep)(config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES);
100
- response = await axios_1.default.request(axiosRequest);
101
- }
102
- return response;
103
- }
104
- validateInputParams(params) {
105
- const encounteredIds = {};
106
- const errors = [];
107
- const { ibanIDs } = params;
108
- ibanIDs.forEach((v) => {
109
- if (!v.match(ibanPattern)) {
110
- errors.push(`Invalid IBAN: ${v}`);
111
- }
112
- encounteredIds[v] += 1;
113
- if (encounteredIds[v] > 1) {
114
- errors.push(`The following IBAN appears more than once in the input parameters: ${v}`);
115
- }
116
- });
117
- return errors;
118
- }
119
- /**
120
- * Fetches pages of data from the Bank Frick API, scans for accounts by IBAN, and returns the balance
121
- * of all found accounts. Returns a 404 if any IBAN isn't found.
122
- */
123
- async foregroundExecute(req, config) {
124
- const { ibanIDs, signingAlgorithm } = req.requestContext.data;
125
- const { PAGE_SIZE = 500 } = config;
126
- logger.debug(`Validating input: ${JSON.stringify(req.requestContext.data)}`);
127
- // Scan ibanIDs for duplicates and invalid IBANs
128
- const validationErrors = this.validateInputParams(req.requestContext.data);
129
- if (validationErrors.length > 0) {
130
- throw new error_1.AdapterError({
131
- statusCode: 420,
132
- message: `Received the following errors when validating inputParameters:\n ${validationErrors.join('\n')}`,
133
- });
134
- }
135
- // Refresh the token if it isn't set
136
- if (!this.token) {
137
- this.token = await (0, util_1.generateJWT)(config, signingAlgorithm);
138
- }
139
- let sum = 0;
140
- let position = 0;
141
- const keys = ibanIDs;
142
- logger.info("Fetching accounts from Bank Frick's API...");
143
- while (keys.length > 0) {
144
- // TODO Fetching and processing pages can be run concurrently
145
- const axiosRequest = this.prepareRequest(position, req.requestContext.data, config);
146
- const response = await this.makeRequest(axiosRequest, config, signingAlgorithm);
147
- logger.debug(`Evaluating accounts from page ${position / PAGE_SIZE}`);
148
- response.data.accounts.forEach((v) => {
149
- logger.trace(`Evaluating ${v.account} (iban: ${v.iban}, type: ${v.type})`);
150
- const index = ibanIDs.indexOf(v.iban);
151
- if (index > -1) {
152
- keys.splice(index, 1);
153
- sum += v.balance;
154
- logger.trace(`Found account: ${v.account} (iban: ${v.iban}) with balance of ${v.balance}`);
155
- logger.trace(`Running sum: ${sum}, number of ibans left to find: ${keys.length}/${ibanIDs.length}`);
156
- }
157
- });
158
- if (!response.data.moreResults) {
159
- logger.debug('No more results, breaking out of account query loop');
160
- break;
161
- }
162
- position += PAGE_SIZE || 0;
163
- }
164
- // 404 if one or more accounts were not found
165
- if (keys.length > 0) {
166
- logger.error(`Could not find all accounts, returning 404: ${keys.join(', ')}`);
167
- const res = {
168
- data: 0,
169
- statusCode: 404,
170
- result: 0,
171
- };
172
- await this.cache.set(req.requestContext.cacheKey, res, config.CACHE_MAX_AGE);
173
- }
174
- logger.debug('Was able to find all accounts, returning balance across all accounts: ', sum);
175
- const res = {
176
- data: sum,
177
- statusCode: 200,
178
- result: sum,
179
- };
180
- await this.cache.set(req.requestContext.cacheKey, res, config.CACHE_MAX_AGE);
181
- return res;
182
- }
183
- }
184
- exports.BankFrickAccountsTransport = BankFrickAccountsTransport;
185
- exports.accountsRestEndpoint = new adapter_1.AdapterEndpoint({
186
- name: 'accounts',
187
- transport: new BankFrickAccountsTransport(),
188
- inputParameters,
189
- });
190
- //# sourceMappingURL=accounts.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../../../src/examples/bank-frick/accounts.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAgE;AAUhE,iCAAoC;AACpC,qCAA+E;AAE/E,kDAAqD;AAGrD,2CAAoE;AAEpE,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAE/C,6GAA6G;AAC7G,MAAM,WAAW,GAAG,0BAA0B,CAAA;AAC9C,MAAM,eAAe,GAAoB;IACvC,OAAO,EAAE;QACP,WAAW,EAAE,yDAAyD;QACtE,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,OAAO;KACd;IACD,gBAAgB,EAAE;QAChB,WAAW,EACT,oHAAoH;QACtH,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,YAAY;QACrB,OAAO,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC;KACpD;CACF,CAAA;AAED,mGAAmG;AACnG,MAAM,UAAU,GAA8B;IAC5C,GAAG,EAAE,2CAA2C;IAChD,GAAG,EAAE,kEAAkE,EAAE,kCAAkC;CAC5G,CAAA;AACD,MAAM,WAAW,GAA8B;IAC7C,GAAG,EAAE,+CAA+C;IACpD,GAAG,EAAE,0DAA0D;CAChE,CAAA;AAED;;;;;;;GAOG;AACH,MAAa,0BAA0B;IAQrC,KAAK,CAAC,UAAU,CAAC,YAAiC;QAChD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAuC,CAAA;IACnE,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,aAAqB,EACrB,WAAmC,EACnC,MAA4C;QAE5C,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,CAAA;QAEpD,OAAO;YACL,OAAO,EAAE,YAAY,GAAG,QAAQ;YAChC,GAAG,EAAE,UAAU;YACf,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,aAAa;gBACb,UAAU,EAAE,SAAS;aACtB;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE;aACtC;SACF,CAAA;IACH,CAAC;IAED;;;;QAII;IACJ,KAAK,CAAC,WAAW,CACf,YAAgE,EAChE,MAA4C,EAC5C,gBAAmC;QAEnC,IAAI,WAAW,GAAG,CAAC,CAAA;QACnB,IAAI,QAAQ,GAAG,MAAM,eAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAChD,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC9B,WAAW,EAAE,CAAA;YACb,MAAM,CAAC,IAAI,CACT,2DAA2D,EAC3D,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,UAAU,CACpB,CAAA;YAED,iHAAiH;YACjH,mGAAmG;YACnG,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAChC,MAAM,IAAI,oBAAY,CAAC;oBACrB,UAAU,EAAE,QAAQ,CAAC,MAAM;oBAC3B,OAAO,EAAE,QAAQ,CAAC,UAAU;iBAC7B,CAAC,CAAA;aACH;iBAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACtC,kGAAkG;gBAClG,MAAM,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAA;gBAC3F,IAAI,CAAC,KAAK,GAAG,MAAM,IAAA,kBAAW,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;aACzD;iBAAM,IAAI,WAAW,KAAK,MAAM,CAAC,qCAAqC,EAAE;gBACvE,MAAM,IAAI,oBAAY,CAAC;oBACrB,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,uDAAuD,MAAM,CAAC,qCAAqC,uBAAuB;iBACpI,CAAC,CAAA;aACH;YAED,MAAM,CAAC,KAAK,CACV,gBAAgB,MAAM,CAAC,4CAA4C,oBAAoB,CACxF,CAAA;YACD,MAAM,IAAA,YAAK,EAAC,MAAM,CAAC,4CAA4C,CAAC,CAAA;YAChE,QAAQ,GAAG,MAAM,eAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;SAC7C;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,mBAAmB,CAAC,MAA8B;QAChD,MAAM,cAAc,GAA8B,EAAE,CAAA;QACpD,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;QAE1B,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBACzB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAA;aAClC;YACD,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YACtB,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;gBACzB,MAAM,CAAC,IAAI,CAAC,sEAAsE,CAAC,EAAE,CAAC,CAAA;aACvF;QACH,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CACrB,GAA2C,EAC3C,MAA4C;QAE5C,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,CAAA;QAC7D,MAAM,EAAE,SAAS,GAAG,GAAG,EAAE,GAAG,MAAM,CAAA;QAElC,MAAM,CAAC,KAAK,CAAC,qBAAqB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAE5E,gDAAgD;QAChD,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC1E,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,IAAI,oBAAY,CAAC;gBACrB,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,oEAAoE,gBAAgB,CAAC,IAAI,CAChG,IAAI,CACL,EAAE;aACJ,CAAC,CAAA;SACH;QAED,oCAAoC;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,KAAK,GAAG,MAAM,IAAA,kBAAW,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;SACzD;QAED,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,MAAM,IAAI,GAAG,OAAO,CAAA;QACpB,MAAM,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAA;QACzD,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,6DAA6D;YAC7D,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACnF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAA;YAE/E,MAAM,CAAC,KAAK,CAAC,iCAAiC,QAAQ,GAAG,SAAS,EAAE,CAAC,CAAA;YACrE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAU,EAAE,EAAE;gBAC5C,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,IAAI,GAAG,CAAC,CAAA;gBAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;gBACrC,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;oBACd,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;oBACrB,GAAG,IAAI,CAAC,CAAC,OAAO,CAAA;oBAChB,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;oBAC1F,MAAM,CAAC,KAAK,CACV,gBAAgB,GAAG,mCAAmC,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,CACtF,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;YAEF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC9B,MAAM,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAA;gBACnE,MAAK;aACN;YACD,QAAQ,IAAI,SAAS,IAAI,CAAC,CAAA;SAC3B;QAED,6CAA6C;QAC7C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACnB,MAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC9E,MAAM,GAAG,GAAG;gBACV,IAAI,EAAE,CAAC;gBACP,UAAU,EAAE,GAAG;gBACf,MAAM,EAAE,CAAC;aACiB,CAAA;YAC5B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;SAC7E;QAED,MAAM,CAAC,KAAK,CAAC,wEAAwE,EAAE,GAAG,CAAC,CAAA;QAC3F,MAAM,GAAG,GAAG;YACV,IAAI,EAAE,GAAG;YACT,UAAU,EAAE,GAAG;YACf,MAAM,EAAE,GAAG;SACe,CAAA;QAC5B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;QAC5E,OAAO,GAAG,CAAA;IACZ,CAAC;CACF;AAnLD,gEAmLC;AAEY,QAAA,oBAAoB,GAAG,IAAI,yBAAe,CAAC;IACtD,IAAI,EAAE,UAAU;IAChB,SAAS,EAAE,IAAI,0BAA0B,EAAE;IAC3C,eAAe;CAChB,CAAC,CAAA"}
@@ -1,17 +0,0 @@
1
- import { SigningAlgorithm } from '../types';
2
- export declare const signingAlgorithms: SigningAlgorithm[];
3
- export declare const customSettings: {
4
- readonly PAGE_SIZE: {
5
- readonly description: "The number of accounts to fetch per call to /accounts. Must be >= 1 and <= 500.";
6
- readonly type: "number";
7
- readonly required: false;
8
- readonly default: 500;
9
- readonly validate: (value?: number) => string | undefined;
10
- };
11
- readonly PRIVATE_KEY: {
12
- readonly description: "";
13
- readonly type: "string";
14
- readonly required: true;
15
- readonly validate: (value: string) => string | undefined;
16
- };
17
- };
@@ -1,55 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.customSettings = exports.signingAlgorithms = void 0;
7
- const crypto_1 = __importDefault(require("crypto"));
8
- const util_1 = require("../../../util");
9
- const logger = (0, util_1.makeLogger)('BankFrickConfig');
10
- // Used for enum options and validation
11
- exports.signingAlgorithms = ['rsa-sha256', 'rsa-sha384', 'rsa-sha512'];
12
- const MAX_PAGE_SIZE = 500;
13
- exports.customSettings = {
14
- PAGE_SIZE: {
15
- description: 'The number of accounts to fetch per call to /accounts. Must be >= 1 and <= 500.',
16
- type: 'number',
17
- required: false,
18
- default: MAX_PAGE_SIZE,
19
- validate: (value) => {
20
- if (!value) {
21
- return '';
22
- }
23
- else if (value < 1) {
24
- return `PAGE_SIZE must be at least >= 1, was ${value}`;
25
- }
26
- else if (value > MAX_PAGE_SIZE) {
27
- return `PAGE_SIZE must be <= 500, was ${value}`;
28
- }
29
- },
30
- },
31
- PRIVATE_KEY: {
32
- description: '',
33
- type: 'string',
34
- required: true,
35
- validate: (value) => {
36
- const failedAlgos = [];
37
- for (const algorithm of exports.signingAlgorithms) {
38
- const body = { example: 123 };
39
- try {
40
- crypto_1.default.sign(algorithm, Buffer.from(JSON.stringify(body)), value);
41
- logger.trace("Successfully tested PRIVATE_KEY by signing with algorithm '%s'", algorithm);
42
- }
43
- catch {
44
- logger.trace("PRIVATE_KEY failed to sign message with algorithm '%s'", algorithm);
45
- failedAlgos.push(algorithm);
46
- }
47
- }
48
- if (failedAlgos.length > 0) {
49
- return `Failed to sign a dummy body using $PRIVATE_KEY with the following algorithms ${failedAlgos.join(',')}`;
50
- }
51
- logger.debug('$PRIVATE_KEY successfully signed a dummy body with all supported algorithms');
52
- },
53
- },
54
- };
55
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/examples/bank-frick/config/index.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,wCAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,iBAAiB,CAAC,CAAA;AAE5C,uCAAuC;AAC1B,QAAA,iBAAiB,GAAuB,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,CAAA;AAC/F,MAAM,aAAa,GAAG,GAAG,CAAA;AAEZ,QAAA,cAAc,GAAG;IAC5B,SAAS,EAAE;QACT,WAAW,EAAE,iFAAiF;QAC9F,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,aAAa;QACtB,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE;YAC3B,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO,EAAE,CAAA;aACV;iBAAM,IAAI,KAAK,GAAG,CAAC,EAAE;gBACpB,OAAO,wCAAwC,KAAK,EAAE,CAAA;aACvD;iBAAM,IAAI,KAAK,GAAG,aAAa,EAAE;gBAChC,OAAO,iCAAiC,KAAK,EAAE,CAAA;aAChD;QACH,CAAC;KACF;IACD,WAAW,EAAE;QACX,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE;YAC1B,MAAM,WAAW,GAAuB,EAAE,CAAA;YAC1C,KAAK,MAAM,SAAS,IAAI,yBAAiB,EAAE;gBACzC,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAA;gBAC7B,IAAI;oBACF,gBAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;oBAChE,MAAM,CAAC,KAAK,CAAC,gEAAgE,EAAE,SAAS,CAAC,CAAA;iBAC1F;gBAAC,MAAM;oBACN,MAAM,CAAC,KAAK,CAAC,wDAAwD,EAAE,SAAS,CAAC,CAAA;oBACjF,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;iBAC5B;aACF;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC1B,OAAO,gFAAgF,WAAW,CAAC,IAAI,CACrG,GAAG,CACJ,EAAE,CAAA;aACJ;YACD,MAAM,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAA;QAC7F,CAAC;KACF;CACO,CAAA"}
@@ -1,16 +0,0 @@
1
- import { Adapter } from '../../adapter';
2
- export declare const adapter: Adapter<{
3
- readonly PAGE_SIZE: {
4
- readonly description: "The number of accounts to fetch per call to /accounts. Must be >= 1 and <= 500.";
5
- readonly type: "number";
6
- readonly required: false;
7
- readonly default: 500;
8
- readonly validate: (value?: number | undefined) => string | undefined;
9
- };
10
- readonly PRIVATE_KEY: {
11
- readonly description: "";
12
- readonly type: "string";
13
- readonly required: true;
14
- readonly validate: (value: string) => string | undefined;
15
- };
16
- }>;
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.adapter = void 0;
4
- const adapter_1 = require("../../adapter");
5
- const accounts_1 = require("./accounts");
6
- const config_1 = require("./config");
7
- exports.adapter = new adapter_1.Adapter({
8
- name: 'bank-frick',
9
- defaultEndpoint: 'accounts',
10
- endpoints: [accounts_1.accountsRestEndpoint],
11
- customSettings: config_1.customSettings,
12
- envDefaultOverrides: {
13
- API_ENDPOINT: 'https://olbsandbox.bankfrick.li/webapi/v2',
14
- },
15
- });
16
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/examples/bank-frick/index.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AACvC,yCAAiD;AACjD,qCAAyC;AAE5B,QAAA,OAAO,GAAG,IAAI,iBAAO,CAAC;IACjC,IAAI,EAAE,YAAY;IAClB,eAAe,EAAE,UAAU;IAC3B,SAAS,EAAE,CAAC,+BAAoB,CAAC;IACjC,cAAc,EAAd,uBAAc;IACd,mBAAmB,EAAE;QACnB,YAAY,EAAE,2CAA2C;KAC1D;CACF,CAAC,CAAA"}
@@ -1,4 +0,0 @@
1
- import { SigningAlgorithm } from './types';
2
- import { customSettings } from './config';
3
- import { AdapterConfig } from '../../config';
4
- export declare const generateJWT: (config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm) => Promise<string>;
@@ -1,40 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.generateJWT = void 0;
7
- const crypto_1 = __importDefault(require("crypto"));
8
- const axios_1 = __importDefault(require("axios"));
9
- const util_1 = require("../../util");
10
- const logger = (0, util_1.makeLogger)('BankFrickUtil');
11
- // Used by all endpoints requiring authentication
12
- const generateJWT = async (config, signingAlgorithm = 'rsa-sha512') => {
13
- logger.info("Generating a new JWT because we don't have one in config.token");
14
- const { API_KEY, PRIVATE_KEY, API_ENDPOINT } = config;
15
- // All of these are required, so validation should have failed prior to this line
16
- if (!API_KEY || !PRIVATE_KEY) {
17
- throw new Error('API_KEY, PRIVATE_KEY, and PASSWORD all must be defined to get a new token\n' +
18
- 'Received: \n' +
19
- `API_KEY: ${API_KEY}\n` +
20
- `PRIVATE_KEY: ${PRIVATE_KEY}`);
21
- }
22
- const data = {
23
- key: API_KEY,
24
- };
25
- const signature = crypto_1.default.sign(signingAlgorithm, Buffer.from(JSON.stringify(data)), PRIVATE_KEY);
26
- const options = {
27
- method: 'POST',
28
- baseURL: API_ENDPOINT,
29
- url: `authorize`,
30
- headers: {
31
- Signature: signature.toString('base64'),
32
- algorithm: signingAlgorithm,
33
- },
34
- data,
35
- };
36
- const response = await axios_1.default.request(options);
37
- return response.data.token;
38
- };
39
- exports.generateJWT = generateJWT;
40
- //# sourceMappingURL=util.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"util.js","sourceRoot":"","sources":["../../../../src/examples/bank-frick/util.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAG3B,kDAAiD;AACjD,qCAAuC;AAWvC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,eAAe,CAAC,CAAA;AAE1C,iDAAiD;AAC1C,MAAM,WAAW,GAAG,KAAK,EAC9B,MAA4C,EAC5C,mBAAqC,YAAY,EAChC,EAAE;IACnB,MAAM,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAA;IAC7E,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,MAAM,CAAA;IAErD,iFAAiF;IACjF,IAAI,CAAC,OAAO,IAAI,CAAC,WAAW,EAAE;QAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E;YAC3E,eAAe;YACf,YAAY,OAAO,IAAI;YACvB,gBAAgB,WAAW,EAAE,CAChC,CAAA;KACF;IAED,MAAM,IAAI,GAAqB;QAC7B,GAAG,EAAE,OAAO;KACb,CAAA;IAED,MAAM,SAAS,GAAG,gBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAA;IAC/F,MAAM,OAAO,GAAyC;QACpD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,YAAY;QACrB,GAAG,EAAE,WAAW;QAChB,OAAO,EAAE;YACP,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACvC,SAAS,EAAE,gBAAgB;SAC5B;QACD,IAAI;KACL,CAAA;IAED,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,OAAO,CAAoB,OAAO,CAAC,CAAA;IAEhE,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAA;AAC5B,CAAC,CAAA;AApCY,QAAA,WAAW,eAoCvB"}
@@ -1,2 +0,0 @@
1
- export declare const DEFAULT_API_ENDPOINT = "https://api.coingecko.com/api/v3";
2
- export declare const PRO_API_ENDPOINT = "https://pro-api.coingecko.com/api/v3";
@@ -1,6 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PRO_API_ENDPOINT = exports.DEFAULT_API_ENDPOINT = void 0;
4
- exports.DEFAULT_API_ENDPOINT = 'https://api.coingecko.com/api/v3';
5
- exports.PRO_API_ENDPOINT = 'https://pro-api.coingecko.com/api/v3';
6
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/examples/coingecko/src/config/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG,kCAAkC,CAAA;AACzD,QAAA,gBAAgB,GAAG,sCAAsC,CAAA"}