@polygonlabs/servercore 1.0.0-dev.4 → 1.0.0-dev.41

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 (70) hide show
  1. package/LICENSE +21 -0
  2. package/dist/api/health-check.d.ts +8 -0
  3. package/dist/api/health-check.js +85 -0
  4. package/dist/api/health-check.js.map +1 -0
  5. package/dist/api/index.d.ts +2 -0
  6. package/dist/api/index.js +1 -0
  7. package/dist/api/index.js.map +1 -1
  8. package/dist/api/response_handler.d.ts +1 -4
  9. package/dist/api/response_handler.js.map +1 -1
  10. package/dist/consumers/abstract_cron_event_consumer.d.ts +23 -0
  11. package/dist/consumers/abstract_cron_event_consumer.js +30 -0
  12. package/dist/consumers/abstract_cron_event_consumer.js.map +1 -0
  13. package/dist/consumers/abstract_event_consumer.d.ts +1 -0
  14. package/dist/consumers/abstract_event_consumer.js +3 -0
  15. package/dist/consumers/abstract_event_consumer.js.map +1 -1
  16. package/dist/consumers/event_consumer.d.ts +7 -5
  17. package/dist/consumers/event_consumer.js +79 -16
  18. package/dist/consumers/event_consumer.js.map +1 -1
  19. package/dist/consumers/index.d.ts +3 -0
  20. package/dist/consumers/index.js +2 -0
  21. package/dist/consumers/index.js.map +1 -1
  22. package/dist/consumers/rest_api_consumer.d.ts +30 -0
  23. package/dist/consumers/rest_api_consumer.js +131 -0
  24. package/dist/consumers/rest_api_consumer.js.map +1 -0
  25. package/dist/errors/api_errors.d.ts +1 -1
  26. package/dist/errors/api_errors.js +11 -9
  27. package/dist/errors/api_errors.js.map +1 -1
  28. package/dist/errors/database_errors.js +1 -1
  29. package/dist/errors/database_errors.js.map +1 -1
  30. package/dist/index.d.ts +10 -1
  31. package/dist/index.js +2 -1
  32. package/dist/index.js.map +1 -1
  33. package/dist/logger/logger.d.ts +2 -0
  34. package/dist/logger/logger.js +45 -46
  35. package/dist/logger/logger.js.map +1 -1
  36. package/dist/{database → storage}/db_interface.d.ts +4 -3
  37. package/dist/storage/index.d.ts +4 -0
  38. package/dist/storage/index.js +3 -0
  39. package/dist/storage/index.js.map +1 -0
  40. package/dist/storage/queue_interface.d.ts +11 -0
  41. package/dist/storage/queue_interface.js +1 -0
  42. package/dist/storage/queue_interface.js.map +1 -0
  43. package/dist/types/event_consumer_config.d.ts +5 -4
  44. package/dist/types/index.d.ts +3 -0
  45. package/dist/types/index.js +3 -0
  46. package/dist/types/index.js.map +1 -1
  47. package/dist/types/queue_job_opts.d.ts +5 -0
  48. package/dist/types/queue_job_opts.js +1 -0
  49. package/dist/types/queue_job_opts.js.map +1 -0
  50. package/dist/types/response_context.d.ts +6 -0
  51. package/dist/types/response_context.js +1 -0
  52. package/dist/types/response_context.js.map +1 -0
  53. package/dist/types/rest_api_consumer_config.d.ts +17 -0
  54. package/dist/types/rest_api_consumer_config.js +1 -0
  55. package/dist/types/rest_api_consumer_config.js.map +1 -0
  56. package/dist/utils/decoder.d.ts +6 -0
  57. package/dist/utils/decoder.js +8 -0
  58. package/dist/utils/decoder.js.map +1 -0
  59. package/dist/utils/index.d.ts +2 -0
  60. package/dist/utils/index.js +3 -0
  61. package/dist/utils/index.js.map +1 -0
  62. package/dist/utils/ulid.d.ts +3 -0
  63. package/dist/utils/ulid.js +24 -0
  64. package/dist/utils/ulid.js.map +1 -0
  65. package/package.json +6 -12
  66. package/dist/database/index.d.ts +0 -2
  67. package/dist/database/index.js +0 -2
  68. package/dist/database/index.js.map +0 -1
  69. /package/dist/{database → storage}/db_interface.js +0 -0
  70. /package/dist/{database → storage}/db_interface.js.map +0 -0
@@ -0,0 +1,131 @@
1
+ import { errorCodes } from "../constants";
2
+ import { ConsumerError } from "../errors";
3
+ import { AbstractCronEventConsumer } from "./abstract_cron_event_consumer";
4
+ class RestAPIConsumer extends AbstractCronEventConsumer {
5
+ constructor(config) {
6
+ super();
7
+ this.config = config;
8
+ this.highestValueSeen = this.config.startCount.value;
9
+ }
10
+ observer = null;
11
+ currentPage = 0;
12
+ highestValueSeen = 0;
13
+ async start(observer) {
14
+ this.observer = observer;
15
+ this.currentPage = 1;
16
+ if (this.config.cronExpr) {
17
+ this.startCron(this.config.cronExpr);
18
+ } else {
19
+ await this.onTick();
20
+ }
21
+ }
22
+ stop() {
23
+ this.stopCron();
24
+ }
25
+ async onTick() {
26
+ this.currentPage = 1;
27
+ let shouldFetchNextPage = true;
28
+ while (shouldFetchNextPage) {
29
+ shouldFetchNextPage = await this.fetchPage();
30
+ }
31
+ this.config.startCount.value = this.highestValueSeen;
32
+ this.observer?.summary({
33
+ [`${this.config.startCount.key}`]: this.config.startCount.value
34
+ });
35
+ }
36
+ async fetchPage() {
37
+ try {
38
+ const paginationParam = this.config.paginationParam || "page";
39
+ const params = {
40
+ ...this.config.params || {},
41
+ [paginationParam]: this.currentPage.toString()
42
+ };
43
+ let url = this.config.apiUrl.toString();
44
+ if (Object.keys(params).length > 0) {
45
+ const queryString = new URLSearchParams(params).toString();
46
+ url += (url.includes("?") ? "&" : "?") + queryString;
47
+ }
48
+ const response = await fetch(url, {
49
+ method: this.config.method || "GET",
50
+ headers: this.config.headers,
51
+ body: this.config.body ? JSON.stringify(this.config.body) : void 0
52
+ });
53
+ if (!response.ok) {
54
+ throw new ConsumerError(
55
+ `Failed to fetch from API: ${response.statusText}`,
56
+ {
57
+ code: errorCodes.external.UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,
58
+ isFatal: true,
59
+ origin: "rest_api_consumer"
60
+ }
61
+ );
62
+ }
63
+ let data = await response.json();
64
+ if (this.config.resultPath) {
65
+ data = this.getValueByPath(data, this.config.resultPath);
66
+ }
67
+ const countKey = this.config.startCount.key;
68
+ let currentValue = void 0;
69
+ if (Array.isArray(data)) {
70
+ if (data.length === 0) {
71
+ return false;
72
+ }
73
+ for (const elem of data) {
74
+ currentValue = this.processDataForCurrentCountValue(
75
+ elem,
76
+ countKey
77
+ );
78
+ }
79
+ } else {
80
+ currentValue = this.processDataForCurrentCountValue(
81
+ data,
82
+ countKey
83
+ );
84
+ }
85
+ this.observer?.next(data);
86
+ this.currentPage++;
87
+ if (currentValue === void 0) {
88
+ return false;
89
+ }
90
+ return currentValue >= this.config.startCount.value;
91
+ } catch (error) {
92
+ this.onFatalError(error);
93
+ return false;
94
+ }
95
+ }
96
+ // Utility to get nested values using dot notation (e.g., "response.data.count")
97
+ getValueByPath(obj, path) {
98
+ return path.split(".").reduce((prev, curr) => {
99
+ return prev && prev[curr] !== void 0 ? prev[curr] : void 0;
100
+ }, obj);
101
+ }
102
+ processDataForCurrentCountValue(item, countKey) {
103
+ const value = this.getValueByPath(item, countKey);
104
+ if (value === void 0) {
105
+ throw new ConsumerError(
106
+ `Count key '${countKey}' not found in API response`,
107
+ {
108
+ code: errorCodes.external.UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,
109
+ isFatal: false,
110
+ origin: "rest_api_consumer"
111
+ }
112
+ );
113
+ }
114
+ this.highestValueSeen = Math.max(this.highestValueSeen, value);
115
+ return value;
116
+ }
117
+ /**
118
+ * Updates the start count value to a specific value.
119
+ * This allows reprocessing data from a specified point.
120
+ *
121
+ * @param value The value to set as the new start count
122
+ */
123
+ setStartValue(value) {
124
+ this.config.startCount.value = value;
125
+ this.highestValueSeen = value;
126
+ }
127
+ }
128
+ export {
129
+ RestAPIConsumer
130
+ };
131
+ //# sourceMappingURL=rest_api_consumer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/consumers/rest_api_consumer.ts"],"sourcesContent":["import { errorCodes } from \"../constants\";\nimport { ConsumerError } from \"../errors\";\nimport type { IObserver, IRestAPIConsumerConfig } from \"../types\";\nimport { AbstractCronEventConsumer } from \"./abstract_cron_event_consumer\";\n\nexport class RestAPIConsumer<T, U> extends AbstractCronEventConsumer {\n protected observer: IObserver<T, ConsumerError, U> | null = null;\n private currentPage = 0;\n private highestValueSeen = 0;\n\n constructor(private readonly config: IRestAPIConsumerConfig) {\n super();\n this.highestValueSeen = this.config.startCount.value;\n }\n\n public async start(\n observer: IObserver<T, ConsumerError, U>\n ): Promise<void> {\n this.observer = observer;\n this.currentPage = 1;\n if (this.config.cronExpr) {\n this.startCron(this.config.cronExpr);\n } else {\n // fallback: run once if no cron\n await this.onTick();\n }\n }\n\n public stop(): void {\n this.stopCron();\n }\n\n protected async onTick(): Promise<void> {\n // Reset page counter at the start of each cron run\n this.currentPage = 1;\n\n // Keep fetching pages until we've caught up\n let shouldFetchNextPage = true;\n\n while (shouldFetchNextPage) {\n shouldFetchNextPage = await this.fetchPage();\n }\n\n // Update config with the highest value we've seen\n // This prevents fetching the same data in the next cron run\n this.config.startCount.value = this.highestValueSeen;\n this.observer?.summary({\n [`${this.config.startCount.key}`]: this.config.startCount.value,\n } as U);\n }\n\n private async fetchPage(): Promise<boolean> {\n try {\n // Use paginationParam from config or default to \"page\"\n const paginationParam = this.config.paginationParam || \"page\";\n const params = {\n ...(this.config.params || {}),\n [paginationParam]: this.currentPage.toString(),\n };\n\n let url = this.config.apiUrl.toString();\n if (Object.keys(params).length > 0) {\n const queryString = new URLSearchParams(params).toString();\n url += (url.includes(\"?\") ? \"&\" : \"?\") + queryString;\n }\n\n const response = await fetch(url, {\n method: this.config.method || \"GET\",\n headers: this.config.headers,\n body: this.config.body\n ? JSON.stringify(this.config.body)\n : undefined,\n });\n\n if (!response.ok) {\n throw new ConsumerError(\n `Failed to fetch from API: ${response.statusText}`,\n {\n code: errorCodes.external\n .UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,\n isFatal: true,\n origin: \"rest_api_consumer\",\n }\n );\n }\n\n let data = await response.json();\n if (this.config.resultPath) {\n data = this.getValueByPath(data, this.config.resultPath);\n }\n\n // Extract the value we're tracking\n const countKey = this.config.startCount.key;\n let currentValue: number | undefined = undefined;\n\n if (Array.isArray(data)) {\n if (data.length === 0) {\n return false;\n }\n for (const elem of data) {\n currentValue = this.processDataForCurrentCountValue(\n elem,\n countKey\n );\n }\n } else {\n currentValue = this.processDataForCurrentCountValue(\n data,\n countKey\n );\n }\n\n // Send data to observer\n this.observer?.next(data);\n\n // Increment page for next potential fetch\n this.currentPage++;\n\n // Continue fetching if the current value is <= our threshold\n if (currentValue === undefined) {\n // If currentValue was never set, stop fetching\n return false;\n }\n return currentValue >= this.config.startCount.value;\n } catch (error) {\n this.onFatalError(error as ConsumerError);\n return false; // Stop fetching on error\n }\n }\n\n // Utility to get nested values using dot notation (e.g., \"response.data.count\")\n private getValueByPath(obj: any, path: string): any {\n return path.split(\".\").reduce((prev, curr) => {\n return prev && prev[curr] !== undefined ? prev[curr] : undefined;\n }, obj);\n }\n\n private processDataForCurrentCountValue(\n item: any,\n countKey: string\n ): number {\n const value = this.getValueByPath(item, countKey);\n if (value === undefined) {\n throw new ConsumerError(\n `Count key '${countKey}' not found in API response`,\n {\n code: errorCodes.external.UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,\n isFatal: false,\n origin: \"rest_api_consumer\",\n }\n );\n }\n this.highestValueSeen = Math.max(this.highestValueSeen, value);\n return value;\n }\n\n /**\n * Updates the start count value to a specific value.\n * This allows reprocessing data from a specified point.\n *\n * @param value The value to set as the new start count\n */\n public setStartValue(value: number): void {\n this.config.startCount.value = value;\n this.highestValueSeen = value;\n }\n}\n"],"mappings":"AAAA,SAAS,kBAAkB;AAC3B,SAAS,qBAAqB;AAE9B,SAAS,iCAAiC;AAEnC,MAAM,wBAA8B,0BAA0B;AAAA,EAKjE,YAA6B,QAAgC;AACzD,UAAM;AADmB;AAEzB,SAAK,mBAAmB,KAAK,OAAO,WAAW;AAAA,EACnD;AAAA,EAPU,WAAkD;AAAA,EACpD,cAAc;AAAA,EACd,mBAAmB;AAAA,EAO3B,MAAa,MACT,UACa;AACb,SAAK,WAAW;AAChB,SAAK,cAAc;AACnB,QAAI,KAAK,OAAO,UAAU;AACtB,WAAK,UAAU,KAAK,OAAO,QAAQ;AAAA,IACvC,OAAO;AAEH,YAAM,KAAK,OAAO;AAAA,IACtB;AAAA,EACJ;AAAA,EAEO,OAAa;AAChB,SAAK,SAAS;AAAA,EAClB;AAAA,EAEA,MAAgB,SAAwB;AAEpC,SAAK,cAAc;AAGnB,QAAI,sBAAsB;AAE1B,WAAO,qBAAqB;AACxB,4BAAsB,MAAM,KAAK,UAAU;AAAA,IAC/C;AAIA,SAAK,OAAO,WAAW,QAAQ,KAAK;AACpC,SAAK,UAAU,QAAQ;AAAA,MACnB,CAAC,GAAG,KAAK,OAAO,WAAW,GAAG,EAAE,GAAG,KAAK,OAAO,WAAW;AAAA,IAC9D,CAAM;AAAA,EACV;AAAA,EAEA,MAAc,YAA8B;AACxC,QAAI;AAEA,YAAM,kBAAkB,KAAK,OAAO,mBAAmB;AACvD,YAAM,SAAS;AAAA,QACX,GAAI,KAAK,OAAO,UAAU,CAAC;AAAA,QAC3B,CAAC,eAAe,GAAG,KAAK,YAAY,SAAS;AAAA,MACjD;AAEA,UAAI,MAAM,KAAK,OAAO,OAAO,SAAS;AACtC,UAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAChC,cAAM,cAAc,IAAI,gBAAgB,MAAM,EAAE,SAAS;AACzD,gBAAQ,IAAI,SAAS,GAAG,IAAI,MAAM,OAAO;AAAA,MAC7C;AAEA,YAAM,WAAW,MAAM,MAAM,KAAK;AAAA,QAC9B,QAAQ,KAAK,OAAO,UAAU;AAAA,QAC9B,SAAS,KAAK,OAAO;AAAA,QACrB,MAAM,KAAK,OAAO,OACZ,KAAK,UAAU,KAAK,OAAO,IAAI,IAC/B;AAAA,MACV,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AACd,cAAM,IAAI;AAAA,UACN,6BAA6B,SAAS,UAAU;AAAA,UAChD;AAAA,YACI,MAAM,WAAW,SACZ;AAAA,YACL,SAAS;AAAA,YACT,QAAQ;AAAA,UACZ;AAAA,QACJ;AAAA,MACJ;AAEA,UAAI,OAAO,MAAM,SAAS,KAAK;AAC/B,UAAI,KAAK,OAAO,YAAY;AACxB,eAAO,KAAK,eAAe,MAAM,KAAK,OAAO,UAAU;AAAA,MAC3D;AAGA,YAAM,WAAW,KAAK,OAAO,WAAW;AACxC,UAAI,eAAmC;AAEvC,UAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,YAAI,KAAK,WAAW,GAAG;AACnB,iBAAO;AAAA,QACX;AACA,mBAAW,QAAQ,MAAM;AACrB,yBAAe,KAAK;AAAA,YAChB;AAAA,YACA;AAAA,UACJ;AAAA,QACJ;AAAA,MACJ,OAAO;AACH,uBAAe,KAAK;AAAA,UAChB;AAAA,UACA;AAAA,QACJ;AAAA,MACJ;AAGA,WAAK,UAAU,KAAK,IAAI;AAGxB,WAAK;AAGL,UAAI,iBAAiB,QAAW;AAE5B,eAAO;AAAA,MACX;AACA,aAAO,gBAAgB,KAAK,OAAO,WAAW;AAAA,IAClD,SAAS,OAAO;AACZ,WAAK,aAAa,KAAsB;AACxC,aAAO;AAAA,IACX;AAAA,EACJ;AAAA;AAAA,EAGQ,eAAe,KAAU,MAAmB;AAChD,WAAO,KAAK,MAAM,GAAG,EAAE,OAAO,CAAC,MAAM,SAAS;AAC1C,aAAO,QAAQ,KAAK,IAAI,MAAM,SAAY,KAAK,IAAI,IAAI;AAAA,IAC3D,GAAG,GAAG;AAAA,EACV;AAAA,EAEQ,gCACJ,MACA,UACM;AACN,UAAM,QAAQ,KAAK,eAAe,MAAM,QAAQ;AAChD,QAAI,UAAU,QAAW;AACrB,YAAM,IAAI;AAAA,QACN,cAAc,QAAQ;AAAA,QACtB;AAAA,UACI,MAAM,WAAW,SAAS;AAAA,UAC1B,SAAS;AAAA,UACT,QAAQ;AAAA,QACZ;AAAA,MACJ;AAAA,IACJ;AACA,SAAK,mBAAmB,KAAK,IAAI,KAAK,kBAAkB,KAAK;AAC7D,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,cAAc,OAAqB;AACtC,SAAK,OAAO,WAAW,QAAQ;AAC/B,SAAK,mBAAmB;AAAA,EAC5B;AACJ;","names":[]}
@@ -20,7 +20,7 @@ declare class BadRequestError extends ApiError {
20
20
  constructor(message?: string, validationErrors?: Record<string, any>, context?: Record<string, any>, origin?: string);
21
21
  }
22
22
  declare class NotFoundError extends ApiError {
23
- constructor(entity?: string, identifier?: string | number, context?: Record<string, any>, origin?: string);
23
+ constructor(message: string, entity?: string, identifier?: string | number, context?: Record<string, any>, origin?: string);
24
24
  }
25
25
  declare class RateLimitError extends ApiError {
26
26
  constructor(message?: string, context?: Record<string, any>, origin?: string);
@@ -4,7 +4,7 @@ class ApiError extends BaseError {
4
4
  constructor(message, {
5
5
  name = "INTERNAL_SERVER_ERROR",
6
6
  code = errorCodes.api.INTERNAL_SERVER_ERROR,
7
- isFatal = true,
7
+ isFatal = false,
8
8
  origin = "api_errors",
9
9
  context = {}
10
10
  } = {}) {
@@ -17,7 +17,7 @@ class UnauthorizedError extends ApiError {
17
17
  super(message, {
18
18
  name: "UNAUTHORIZED",
19
19
  code: errorCodes.api.UNAUTHORIZED,
20
- isFatal: true,
20
+ isFatal: false,
21
21
  origin,
22
22
  context
23
23
  });
@@ -28,7 +28,7 @@ class ForbiddenError extends ApiError {
28
28
  super(message, {
29
29
  name: "FORBIDDEN",
30
30
  code: errorCodes.api.FORBIDDEN,
31
- isFatal: true,
31
+ isFatal: false,
32
32
  origin,
33
33
  context
34
34
  });
@@ -40,7 +40,7 @@ class BadRequestError extends ApiError {
40
40
  super(message, {
41
41
  name: "BAD_REQUEST",
42
42
  code: errorCodes.api.BAD_REQUEST,
43
- isFatal: true,
43
+ isFatal: false,
44
44
  origin,
45
45
  context
46
46
  });
@@ -48,12 +48,14 @@ class BadRequestError extends ApiError {
48
48
  }
49
49
  }
50
50
  class NotFoundError extends ApiError {
51
- constructor(entity = "Path", identifier, context = {}, origin = "api_errors") {
52
- const message = identifier ? `${entity} with identifier ${identifier} not found` : `${entity} not found`;
51
+ constructor(message, entity = "Path", identifier, context = {}, origin = "api_errors") {
52
+ if (!message) {
53
+ message = identifier ? `${entity} with identifier ${identifier} not found` : `${entity} not found`;
54
+ }
53
55
  super(message, {
54
56
  name: "NOT_FOUND",
55
57
  code: errorCodes.api.NOT_FOUND,
56
- isFatal: true,
58
+ isFatal: false,
57
59
  origin,
58
60
  context: { entity, identifier, ...context }
59
61
  });
@@ -64,7 +66,7 @@ class RateLimitError extends ApiError {
64
66
  super(message, {
65
67
  name: "RATE_LIMIT",
66
68
  code: errorCodes.api.TOO_MANY_REQUESTS,
67
- isFatal: true,
69
+ isFatal: false,
68
70
  origin,
69
71
  context
70
72
  });
@@ -76,7 +78,7 @@ class TimeoutError extends ApiError {
76
78
  name: "TIMEOUT",
77
79
  code: errorCodes.api.TIMEOUT_ERROR,
78
80
  // Gateway Timeout
79
- isFatal: true,
81
+ isFatal: false,
80
82
  origin,
81
83
  context: { operation, timeoutMs, ...context }
82
84
  });
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/errors/api_errors.ts"],"sourcesContent":["import { BaseError } from \"./base_error\";\nimport { errorCodes } from \"../constants\";\n\nexport class ApiError extends BaseError {\n constructor(\n message: string,\n {\n name = \"INTERNAL_SERVER_ERROR\",\n code = errorCodes.api.INTERNAL_SERVER_ERROR,\n isFatal = true,\n origin = \"api_errors\",\n context = {},\n }: {\n name?: string;\n code?: number;\n isFatal?: boolean;\n origin?: string;\n context?: Record<string, any>;\n } = {}\n ) {\n super(name, code, message, isFatal, origin, context);\n Error.captureStackTrace(this, this.constructor);\n }\n}\n\nexport class UnauthorizedError extends ApiError {\n constructor(\n message: string = \"Invalid auth credentials\",\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"UNAUTHORIZED\",\n code: errorCodes.api.UNAUTHORIZED,\n isFatal: true,\n origin,\n context,\n });\n }\n}\n\nexport class ForbiddenError extends ApiError {\n constructor(\n message: string = \"You do not have permission to perform this action\",\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"FORBIDDEN\",\n code: errorCodes.api.FORBIDDEN,\n isFatal: true,\n origin,\n context,\n });\n }\n}\n\nexport class BadRequestError extends ApiError {\n public readonly validationErrors: Record<string, string[]>;\n\n constructor(\n message: string = \"Malformed or invalid request\",\n validationErrors: Record<string, any> = {},\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"BAD_REQUEST\",\n code: errorCodes.api.BAD_REQUEST,\n isFatal: true,\n origin,\n context,\n });\n this.validationErrors = validationErrors;\n }\n}\n\nexport class NotFoundError extends ApiError {\n constructor(\n entity: string = \"Path\",\n identifier?: string | number,\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n const message = identifier\n ? `${entity} with identifier ${identifier} not found`\n : `${entity} not found`;\n\n super(message, {\n name: \"NOT_FOUND\",\n code: errorCodes.api.NOT_FOUND,\n isFatal: true,\n origin,\n context: { entity, identifier, ...context },\n });\n }\n}\n\nexport class RateLimitError extends ApiError {\n constructor(\n message: string = \"Rate limit exceeded\",\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"RATE_LIMIT\",\n code: errorCodes.api.TOO_MANY_REQUESTS,\n isFatal: true,\n origin,\n context,\n });\n }\n}\n\nexport class TimeoutError extends ApiError {\n constructor(\n operation: string,\n timeoutMs: number,\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(`Operation '${operation}' timed out after ${timeoutMs}ms`, {\n name: \"TIMEOUT\",\n code: errorCodes.api.TIMEOUT_ERROR, // Gateway Timeout\n isFatal: true,\n origin,\n context: { operation, timeoutMs, ...context },\n });\n }\n}\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAEpB,MAAM,iBAAiB,UAAU;AAAA,EACpC,YACI,SACA;AAAA,IACI,OAAO;AAAA,IACP,OAAO,WAAW,IAAI;AAAA,IACtB,UAAU;AAAA,IACV,SAAS;AAAA,IACT,UAAU,CAAC;AAAA,EACf,IAMI,CAAC,GACP;AACE,UAAM,MAAM,MAAM,SAAS,SAAS,QAAQ,OAAO;AACnD,UAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,EAClD;AACJ;AAEO,MAAM,0BAA0B,SAAS;AAAA,EAC5C,YACI,UAAkB,4BAClB,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,uBAAuB,SAAS;AAAA,EACzC,YACI,UAAkB,qDAClB,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,wBAAwB,SAAS;AAAA,EAC1B;AAAA,EAEhB,YACI,UAAkB,gCAClB,mBAAwC,CAAC,GACzC,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AACD,SAAK,mBAAmB;AAAA,EAC5B;AACJ;AAEO,MAAM,sBAAsB,SAAS;AAAA,EACxC,YACI,SAAiB,QACjB,YACA,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,UAAU,aACV,GAAG,MAAM,oBAAoB,UAAU,eACvC,GAAG,MAAM;AAEf,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA,SAAS,EAAE,QAAQ,YAAY,GAAG,QAAQ;AAAA,IAC9C,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,uBAAuB,SAAS;AAAA,EACzC,YACI,UAAkB,uBAClB,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,qBAAqB,SAAS;AAAA,EACvC,YACI,WACA,WACA,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,cAAc,SAAS,qBAAqB,SAAS,MAAM;AAAA,MAC7D,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA,SAAS,EAAE,WAAW,WAAW,GAAG,QAAQ;AAAA,IAChD,CAAC;AAAA,EACL;AACJ;","names":[]}
1
+ {"version":3,"sources":["../../src/errors/api_errors.ts"],"sourcesContent":["import { BaseError } from \"./base_error\";\nimport { errorCodes } from \"../constants\";\n\nexport class ApiError extends BaseError {\n constructor(\n message: string,\n {\n name = \"INTERNAL_SERVER_ERROR\",\n code = errorCodes.api.INTERNAL_SERVER_ERROR,\n isFatal = false,\n origin = \"api_errors\",\n context = {},\n }: {\n name?: string;\n code?: number;\n isFatal?: boolean;\n origin?: string;\n context?: Record<string, any>;\n } = {}\n ) {\n super(name, code, message, isFatal, origin, context);\n Error.captureStackTrace(this, this.constructor);\n }\n}\n\nexport class UnauthorizedError extends ApiError {\n constructor(\n message: string = \"Invalid auth credentials\",\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"UNAUTHORIZED\",\n code: errorCodes.api.UNAUTHORIZED,\n isFatal: false,\n origin,\n context,\n });\n }\n}\n\nexport class ForbiddenError extends ApiError {\n constructor(\n message: string = \"You do not have permission to perform this action\",\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"FORBIDDEN\",\n code: errorCodes.api.FORBIDDEN,\n isFatal: false,\n origin,\n context,\n });\n }\n}\n\nexport class BadRequestError extends ApiError {\n public readonly validationErrors: Record<string, string[]>;\n\n constructor(\n message: string = \"Malformed or invalid request\",\n validationErrors: Record<string, any> = {},\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"BAD_REQUEST\",\n code: errorCodes.api.BAD_REQUEST,\n isFatal: false,\n origin,\n context,\n });\n this.validationErrors = validationErrors;\n }\n}\n\nexport class NotFoundError extends ApiError {\n constructor(\n message: string,\n entity: string = \"Path\",\n identifier?: string | number,\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n if (!message) {\n message = identifier\n ? `${entity} with identifier ${identifier} not found`\n : `${entity} not found`;\n }\n\n super(message, {\n name: \"NOT_FOUND\",\n code: errorCodes.api.NOT_FOUND,\n isFatal: false,\n origin,\n context: { entity, identifier, ...context },\n });\n }\n}\n\nexport class RateLimitError extends ApiError {\n constructor(\n message: string = \"Rate limit exceeded\",\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(message, {\n name: \"RATE_LIMIT\",\n code: errorCodes.api.TOO_MANY_REQUESTS,\n isFatal: false,\n origin,\n context,\n });\n }\n}\n\nexport class TimeoutError extends ApiError {\n constructor(\n operation: string,\n timeoutMs: number,\n context: Record<string, any> = {},\n origin: string = \"api_errors\"\n ) {\n super(`Operation '${operation}' timed out after ${timeoutMs}ms`, {\n name: \"TIMEOUT\",\n code: errorCodes.api.TIMEOUT_ERROR, // Gateway Timeout\n isFatal: false,\n origin,\n context: { operation, timeoutMs, ...context },\n });\n }\n}\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAEpB,MAAM,iBAAiB,UAAU;AAAA,EACpC,YACI,SACA;AAAA,IACI,OAAO;AAAA,IACP,OAAO,WAAW,IAAI;AAAA,IACtB,UAAU;AAAA,IACV,SAAS;AAAA,IACT,UAAU,CAAC;AAAA,EACf,IAMI,CAAC,GACP;AACE,UAAM,MAAM,MAAM,SAAS,SAAS,QAAQ,OAAO;AACnD,UAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,EAClD;AACJ;AAEO,MAAM,0BAA0B,SAAS;AAAA,EAC5C,YACI,UAAkB,4BAClB,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,uBAAuB,SAAS;AAAA,EACzC,YACI,UAAkB,qDAClB,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,wBAAwB,SAAS;AAAA,EAC1B;AAAA,EAEhB,YACI,UAAkB,gCAClB,mBAAwC,CAAC,GACzC,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AACD,SAAK,mBAAmB;AAAA,EAC5B;AACJ;AAEO,MAAM,sBAAsB,SAAS;AAAA,EACxC,YACI,SACA,SAAiB,QACjB,YACA,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,QAAI,CAAC,SAAS;AACV,gBAAU,aACJ,GAAG,MAAM,oBAAoB,UAAU,eACvC,GAAG,MAAM;AAAA,IACnB;AAEA,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA,SAAS,EAAE,QAAQ,YAAY,GAAG,QAAQ;AAAA,IAC9C,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,uBAAuB,SAAS;AAAA,EACzC,YACI,UAAkB,uBAClB,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,SAAS;AAAA,MACX,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAEO,MAAM,qBAAqB,SAAS;AAAA,EACvC,YACI,WACA,WACA,UAA+B,CAAC,GAChC,SAAiB,cACnB;AACE,UAAM,cAAc,SAAS,qBAAqB,SAAS,MAAM;AAAA,MAC7D,MAAM;AAAA,MACN,MAAM,WAAW,IAAI;AAAA;AAAA,MACrB,SAAS;AAAA,MACT;AAAA,MACA,SAAS,EAAE,WAAW,WAAW,GAAG,QAAQ;AAAA,IAChD,CAAC;AAAA,EACL;AACJ;","names":[]}
@@ -2,7 +2,7 @@ import { BaseError } from "./base_error";
2
2
  import { errorCodes } from "../constants";
3
3
  class DatabaseError extends BaseError {
4
4
  constructor(message, originalError, {
5
- name = "CONSUMER_ERROR",
5
+ name = "DATABASE_ERROR",
6
6
  code = errorCodes.consumer.UNKNOWN_CONSUMER_ERR,
7
7
  isFatal = true,
8
8
  origin = "databse_errors",
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/errors/database_errors.ts"],"sourcesContent":["import { BaseError } from \"./base_error\";\nimport { errorCodes } from \"../constants\";\n\nexport class DatabaseError extends BaseError {\n constructor(\n message: string,\n originalError?: Error,\n {\n name = \"CONSUMER_ERROR\",\n code = errorCodes.consumer.UNKNOWN_CONSUMER_ERR,\n isFatal = true,\n origin = \"databse_errors\",\n context = {},\n }: {\n name?: string;\n code?: number;\n isFatal?: boolean;\n origin?: string;\n context?: Record<string, any>;\n } = {}\n ) {\n super(name, code, message, isFatal, origin, context);\n Error.captureStackTrace(this, this.constructor);\n }\n}\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAEpB,MAAM,sBAAsB,UAAU;AAAA,EACzC,YACI,SACA,eACA;AAAA,IACI,OAAO;AAAA,IACP,OAAO,WAAW,SAAS;AAAA,IAC3B,UAAU;AAAA,IACV,SAAS;AAAA,IACT,UAAU,CAAC;AAAA,EACf,IAMI,CAAC,GACP;AACE,UAAM,MAAM,MAAM,SAAS,SAAS,QAAQ,OAAO;AACnD,UAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,EAClD;AACJ;","names":[]}
1
+ {"version":3,"sources":["../../src/errors/database_errors.ts"],"sourcesContent":["import { BaseError } from \"./base_error\";\nimport { errorCodes } from \"../constants\";\n\nexport class DatabaseError extends BaseError {\n constructor(\n message: string,\n originalError?: Error,\n {\n name = \"DATABASE_ERROR\",\n code = errorCodes.consumer.UNKNOWN_CONSUMER_ERR,\n isFatal = true,\n origin = \"databse_errors\",\n context = {},\n }: {\n name?: string;\n code?: number;\n isFatal?: boolean;\n origin?: string;\n context?: Record<string, any>;\n } = {}\n ) {\n super(name, code, message, isFatal, origin, context);\n Error.captureStackTrace(this, this.constructor);\n }\n}\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAEpB,MAAM,sBAAsB,UAAU;AAAA,EACzC,YACI,SACA,eACA;AAAA,IACI,OAAO;AAAA,IACP,OAAO,WAAW,SAAS;AAAA,IAC3B,UAAU;AAAA,IACV,SAAS;AAAA,IACT,UAAU,CAAC;AAAA,EACf,IAMI,CAAC,GACP;AACE,UAAM,MAAM,MAAM,SAAS,SAAS,QAAQ,OAAO;AACnD,UAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,EAClD;AACJ;","names":[]}
package/dist/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export { handleError, handleResponse } from './api/response_handler.js';
2
2
  export { validateBody, validateParams, validateQuery } from './api/zod_utils.js';
3
+ export { HealthCheck, setupHealthCheckServer } from './api/health-check.js';
3
4
  export { Logger } from './logger/logger.js';
4
5
  export { errorCodes } from './constants/error_codes.js';
5
6
  export { httpResposneCodes } from './constants/http_success_codes.js';
@@ -7,13 +8,21 @@ export { ILoggerConfig } from './types/logger_config.js';
7
8
  export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp } from './types/database.js';
8
9
  export { IObserver } from './types/observer.js';
9
10
  export { ChainNativeCurrency, IEventConsumerConfig } from './types/event_consumer_config.js';
11
+ export { ResponseContext } from './types/response_context.js';
12
+ export { JobOpts } from './types/queue_job_opts.js';
13
+ export { IRestAPIConsumerConfig } from './types/rest_api_consumer_config.js';
10
14
  export { ApiError, BadRequestError, ForbiddenError, NotFoundError, RateLimitError, TimeoutError, UnauthorizedError } from './errors/api_errors.js';
11
15
  export { DatabaseError } from './errors/database_errors.js';
12
16
  export { ExternalDependencyError } from './errors/external_dependency_error.js';
13
17
  export { BaseError } from './errors/base_error.js';
14
18
  export { ConsumerError } from './errors/consumer_errors.js';
15
- export { Database } from './database/db_interface.js';
19
+ export { Database } from './storage/db_interface.js';
20
+ export { IQueue } from './storage/queue_interface.js';
16
21
  export { EventConsumer } from './consumers/event_consumer.js';
22
+ export { RestAPIConsumer } from './consumers/rest_api_consumer.js';
23
+ export { AbstractCronEventConsumer } from './consumers/abstract_cron_event_consumer.js';
24
+ export { parseEventLog } from './utils/decoder.js';
25
+ export { generateDeterministicULID } from './utils/ulid.js';
17
26
  import 'zod';
18
27
  import 'winston';
19
28
  import 'viem';
package/dist/index.js CHANGED
@@ -3,6 +3,7 @@ export * from "./logger";
3
3
  export * from "./constants";
4
4
  export * from "./types";
5
5
  export * from "./errors";
6
- export * from "./database";
6
+ export * from "./storage";
7
7
  export * from "./consumers";
8
+ export * from "./utils";
8
9
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from \"./api\";\nexport * from \"./logger\";\nexport * from \"./constants\";\nexport * from \"./types\";\nexport * from \"./errors\";\nexport * from \"./database\";\nexport * from \"./consumers\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from \"./api\";\nexport * from \"./logger\";\nexport * from \"./constants\";\nexport * from \"./types\";\nexport * from \"./errors\";\nexport * from \"./storage\";\nexport * from \"./consumers\";\nexport * from \"./utils\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
@@ -2,12 +2,14 @@ import { ILoggerConfig } from '../types/logger_config.js';
2
2
  import 'winston';
3
3
 
4
4
  declare class Logger {
5
+ private static logger;
5
6
  /**
6
7
  * @static
7
8
  * Create method must first be called before using the logger. It creates a singleton, which will then
8
9
  * be referred to throughout the application.
9
10
  */
10
11
  static create(config: ILoggerConfig): void;
12
+ static ensureInitialized(): void;
11
13
  /**
12
14
  * @static
13
15
  * Method to log for level - "info", this should not be called if it has been custom levels are
@@ -1,49 +1,43 @@
1
1
  import winston from "winston";
2
2
  import * as SentryImport from "winston-transport-sentry-node";
3
+ import { BaseError } from "../errors";
4
+ import { errorCodes } from "../constants";
3
5
  const Sentry = SentryImport.default;
4
- let logger;
5
6
  class Logger {
7
+ static logger;
6
8
  /**
7
9
  * @static
8
10
  * Create method must first be called before using the logger. It creates a singleton, which will then
9
11
  * be referred to throughout the application.
10
12
  */
11
13
  static create(config) {
12
- if (!logger) {
13
- logger = winston.createLogger(
14
- Object.assign(
15
- {
16
- format: winston.format.combine(
17
- winston.format.timestamp({
18
- format: "YYYY-MM-DD HH:mm:ss:ms"
19
- }),
20
- winston.format.colorize({
21
- all: true,
22
- colors: {
23
- error: "red",
24
- warn: "yellow",
25
- info: "green",
26
- debug: "white"
27
- }
28
- }),
29
- winston.format.printf(
30
- (info) => `${info.timestamp} ${info.level}: ${info.message}`
31
- )
32
- ),
33
- transports: [
34
- new winston.transports.Console({
35
- level: config.console?.level || "info"
36
- }),
37
- new Sentry({
38
- sentry: {
39
- dsn: config.sentry?.dsn
40
- },
41
- level: config.sentry?.level || "error"
42
- })
43
- ]
44
- },
45
- config.winston
46
- )
14
+ if (!this.logger) {
15
+ this.logger = winston.createLogger({
16
+ format: winston.format.json(),
17
+ transports: [
18
+ new winston.transports.Console({
19
+ level: config.console?.level || "info"
20
+ }),
21
+ new Sentry({
22
+ sentry: {
23
+ dsn: config.sentry?.dsn
24
+ },
25
+ level: config.sentry?.level || "error"
26
+ })
27
+ ],
28
+ ...config.winston
29
+ });
30
+ }
31
+ }
32
+ static ensureInitialized() {
33
+ if (!this.logger) {
34
+ throw new BaseError(
35
+ "LOGGER_ERROR",
36
+ errorCodes.base.BASE_ERROR,
37
+ "Logger not initialized. Please call Logger.create() first.",
38
+ true,
39
+ "Logger",
40
+ void 0
47
41
  );
48
42
  }
49
43
  }
@@ -55,10 +49,11 @@ class Logger {
55
49
  * @param {string|object} message - String or object to log.
56
50
  */
57
51
  static info(message) {
52
+ this.ensureInitialized();
58
53
  if (typeof message === "string") {
59
- logger?.info(message);
54
+ this.logger.info(message);
60
55
  } else {
61
- logger?.info(JSON.stringify(message));
56
+ this.logger.info(JSON.stringify(message));
62
57
  }
63
58
  }
64
59
  /**
@@ -69,10 +64,11 @@ class Logger {
69
64
  * @param {string|object} message - String or object to log.
70
65
  */
71
66
  static debug(message) {
67
+ this.ensureInitialized();
72
68
  if (typeof message === "string") {
73
- logger?.debug(message);
69
+ this.logger?.debug(message);
74
70
  } else {
75
- logger?.debug(JSON.stringify(message));
71
+ this.logger?.debug(JSON.stringify(message));
76
72
  }
77
73
  }
78
74
  /**
@@ -83,10 +79,11 @@ class Logger {
83
79
  * @param {string|object} error - String or object to log.
84
80
  */
85
81
  static error(error) {
82
+ this.ensureInitialized();
86
83
  if (typeof error === "string") {
87
- logger?.error(error);
84
+ this.logger?.error(error);
88
85
  } else {
89
- logger?.error(
86
+ this.logger?.error(
90
87
  `${error.message ? `${error.message} : ` : ""}${JSON.stringify(error)}`
91
88
  );
92
89
  }
@@ -99,10 +96,11 @@ class Logger {
99
96
  * @param {string|object} message - String or object to log.
100
97
  */
101
98
  static warn(message) {
99
+ this.ensureInitialized();
102
100
  if (typeof message === "string") {
103
- logger?.warn(message);
101
+ this.logger?.warn(message);
104
102
  } else {
105
- logger?.warn(JSON.stringify(message));
103
+ this.logger?.warn(JSON.stringify(message));
106
104
  }
107
105
  }
108
106
  /**
@@ -112,10 +110,11 @@ class Logger {
112
110
  * @param {string|object} message - String or object to log.
113
111
  */
114
112
  static log(level, message) {
113
+ this.ensureInitialized();
115
114
  if (typeof message === "string") {
116
- logger?.log(level, message);
115
+ this.logger?.log(level, message);
117
116
  } else {
118
- logger?.log(level, JSON.stringify(message));
117
+ this.logger?.log(level, JSON.stringify(message));
119
118
  }
120
119
  }
121
120
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/logger/logger.ts"],"sourcesContent":["import winston from \"winston\";\nimport type { ILoggerConfig } from \"../types\";\nimport * as SentryImport from \"winston-transport-sentry-node\";\nconst Sentry = SentryImport.default;\n\nlet logger: winston.Logger;\n\nexport class Logger {\n /**\n * @static\n * Create method must first be called before using the logger. It creates a singleton, which will then\n * be referred to throughout the application.\n */\n static create(config: ILoggerConfig) {\n if (!logger) {\n logger = winston.createLogger(\n Object.assign(\n {\n format: winston.format.combine(\n winston.format.timestamp({\n format: \"YYYY-MM-DD HH:mm:ss:ms\",\n }),\n winston.format.colorize({\n all: true,\n colors: {\n error: \"red\",\n warn: \"yellow\",\n info: \"green\",\n debug: \"white\",\n },\n }),\n winston.format.printf(\n (info) =>\n `${info.timestamp} ${info.level}: ${info.message}`\n )\n ),\n transports: [\n new winston.transports.Console({\n level: config.console?.level || \"info\",\n }),\n new Sentry({\n sentry: {\n dsn: config.sentry?.dsn,\n },\n level: config.sentry?.level || \"error\",\n }),\n ],\n },\n config.winston\n )\n );\n }\n }\n\n /**\n * @static\n * Method to log for level - \"info\", this should not be called if it has been custom levels are\n * set which does not include \"info\"\n *\n * @param {string|object} message - String or object to log.\n */\n static info(message: string | object) {\n if (typeof message === \"string\") {\n logger?.info(message);\n } else {\n logger?.info(JSON.stringify(message));\n }\n }\n\n /**\n * @static\n * Method to log for level - \"debug\", this should not be called if it has been custom levels are\n * set which does not include \"debug\"\n *\n * @param {string|object} message - String or object to log.\n */\n static debug(message: string | object) {\n if (typeof message === \"string\") {\n logger?.debug(message);\n } else {\n logger?.debug(JSON.stringify(message));\n }\n }\n\n /**\n * @static\n * Method to log for level - \"error\", this should not be called if it has been custom levels are\n * set which does not include \"error\"\n *\n * @param {string|object} error - String or object to log.\n */\n static error(error: string | object) {\n if (typeof error === \"string\") {\n logger?.error(error);\n } else {\n logger?.error(\n `${\n (error as Error).message\n ? `${(error as Error).message} : `\n : \"\"\n }${JSON.stringify(error)}`\n );\n }\n }\n\n /**\n * @static\n * Method to log for level - \"warn\", this should not be called if it has been custom levels are\n * set which does not include \"warn\"\n *\n * @param {string|object} message - String or object to log.\n */\n static warn(message: string | object) {\n if (typeof message === \"string\") {\n logger?.warn(message);\n } else {\n logger?.warn(JSON.stringify(message));\n }\n }\n\n /**\n * @static\n * Method to log for any level, which should be used to log all custom levels that may be added.\n *\n * @param {string|object} message - String or object to log.\n */\n static log(level: string, message: string | object) {\n if (typeof message === \"string\") {\n logger?.log(level, message);\n } else {\n logger?.log(level, JSON.stringify(message));\n }\n }\n}\n"],"mappings":"AAAA,OAAO,aAAa;AAEpB,YAAY,kBAAkB;AAC9B,MAAM,SAAS,aAAa;AAE5B,IAAI;AAEG,MAAM,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMhB,OAAO,OAAO,QAAuB;AACjC,QAAI,CAAC,QAAQ;AACT,eAAS,QAAQ;AAAA,QACb,OAAO;AAAA,UACH;AAAA,YACI,QAAQ,QAAQ,OAAO;AAAA,cACnB,QAAQ,OAAO,UAAU;AAAA,gBACrB,QAAQ;AAAA,cACZ,CAAC;AAAA,cACD,QAAQ,OAAO,SAAS;AAAA,gBACpB,KAAK;AAAA,gBACL,QAAQ;AAAA,kBACJ,OAAO;AAAA,kBACP,MAAM;AAAA,kBACN,MAAM;AAAA,kBACN,OAAO;AAAA,gBACX;AAAA,cACJ,CAAC;AAAA,cACD,QAAQ,OAAO;AAAA,gBACX,CAAC,SACG,GAAG,KAAK,SAAS,IAAI,KAAK,KAAK,KAAK,KAAK,OAAO;AAAA,cACxD;AAAA,YACJ;AAAA,YACA,YAAY;AAAA,cACR,IAAI,QAAQ,WAAW,QAAQ;AAAA,gBAC3B,OAAO,OAAO,SAAS,SAAS;AAAA,cACpC,CAAC;AAAA,cACD,IAAI,OAAO;AAAA,gBACP,QAAQ;AAAA,kBACJ,KAAK,OAAO,QAAQ;AAAA,gBACxB;AAAA,gBACA,OAAO,OAAO,QAAQ,SAAS;AAAA,cACnC,CAAC;AAAA,YACL;AAAA,UACJ;AAAA,UACA,OAAO;AAAA,QACX;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,KAAK,SAA0B;AAClC,QAAI,OAAO,YAAY,UAAU;AAC7B,cAAQ,KAAK,OAAO;AAAA,IACxB,OAAO;AACH,cAAQ,KAAK,KAAK,UAAU,OAAO,CAAC;AAAA,IACxC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,MAAM,SAA0B;AACnC,QAAI,OAAO,YAAY,UAAU;AAC7B,cAAQ,MAAM,OAAO;AAAA,IACzB,OAAO;AACH,cAAQ,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,IACzC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,MAAM,OAAwB;AACjC,QAAI,OAAO,UAAU,UAAU;AAC3B,cAAQ,MAAM,KAAK;AAAA,IACvB,OAAO;AACH,cAAQ;AAAA,QACJ,GACK,MAAgB,UACX,GAAI,MAAgB,OAAO,QAC3B,EACV,GAAG,KAAK,UAAU,KAAK,CAAC;AAAA,MAC5B;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,KAAK,SAA0B;AAClC,QAAI,OAAO,YAAY,UAAU;AAC7B,cAAQ,KAAK,OAAO;AAAA,IACxB,OAAO;AACH,cAAQ,KAAK,KAAK,UAAU,OAAO,CAAC;AAAA,IACxC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,IAAI,OAAe,SAA0B;AAChD,QAAI,OAAO,YAAY,UAAU;AAC7B,cAAQ,IAAI,OAAO,OAAO;AAAA,IAC9B,OAAO;AACH,cAAQ,IAAI,OAAO,KAAK,UAAU,OAAO,CAAC;AAAA,IAC9C;AAAA,EACJ;AACJ;","names":[]}
1
+ {"version":3,"sources":["../../src/logger/logger.ts"],"sourcesContent":["import winston from \"winston\";\nimport type { ILoggerConfig } from \"../types\";\nimport * as SentryImport from \"winston-transport-sentry-node\";\nimport { BaseError } from \"../errors\";\nimport { errorCodes } from \"../constants\";\nconst Sentry = SentryImport.default;\n\nexport class Logger {\n private static logger: winston.Logger;\n\n /**\n * @static\n * Create method must first be called before using the logger. It creates a singleton, which will then\n * be referred to throughout the application.\n */\n static create(config: ILoggerConfig) {\n if (!this.logger) {\n this.logger = winston.createLogger({\n format: winston.format.json(),\n transports: [\n new winston.transports.Console({\n level: config.console?.level || \"info\",\n }),\n new Sentry({\n sentry: {\n dsn: config.sentry?.dsn,\n },\n level: config.sentry?.level || \"error\",\n }),\n ],\n ...config.winston\n });\n }\n }\n\n static ensureInitialized(): void {\n if (!this.logger) {\n throw new BaseError(\n \"LOGGER_ERROR\",\n errorCodes.base.BASE_ERROR,\n \"Logger not initialized. Please call Logger.create() first.\",\n true,\n \"Logger\",\n undefined\n );\n }\n }\n\n /**\n * @static\n * Method to log for level - \"info\", this should not be called if it has been custom levels are\n * set which does not include \"info\"\n *\n * @param {string|object} message - String or object to log.\n */\n static info(message: string | object) {\n this.ensureInitialized();\n if (typeof message === \"string\") {\n this.logger.info(message);\n } else {\n this.logger.info(JSON.stringify(message));\n }\n }\n\n /**\n * @static\n * Method to log for level - \"debug\", this should not be called if it has been custom levels are\n * set which does not include \"debug\"\n *\n * @param {string|object} message - String or object to log.\n */\n static debug(message: string | object) {\n this.ensureInitialized();\n if (typeof message === \"string\") {\n this.logger?.debug(message);\n } else {\n this.logger?.debug(JSON.stringify(message));\n }\n }\n\n /**\n * @static\n * Method to log for level - \"error\", this should not be called if it has been custom levels are\n * set which does not include \"error\"\n *\n * @param {string|object} error - String or object to log.\n */\n static error(error: string | object) {\n this.ensureInitialized();\n if (typeof error === \"string\") {\n this.logger?.error(error);\n } else {\n this.logger?.error(\n `${(error as Error).message\n ? `${(error as Error).message} : `\n : \"\"\n }${JSON.stringify(error)}`\n );\n }\n }\n\n /**\n * @static\n * Method to log for level - \"warn\", this should not be called if it has been custom levels are\n * set which does not include \"warn\"\n *\n * @param {string|object} message - String or object to log.\n */\n static warn(message: string | object) {\n this.ensureInitialized();\n if (typeof message === \"string\") {\n this.logger?.warn(message);\n } else {\n this.logger?.warn(JSON.stringify(message));\n }\n }\n\n /**\n * @static\n * Method to log for any level, which should be used to log all custom levels that may be added.\n *\n * @param {string|object} message - String or object to log.\n */\n static log(level: string, message: string | object) {\n this.ensureInitialized();\n if (typeof message === \"string\") {\n this.logger?.log(level, message);\n } else {\n this.logger?.log(level, JSON.stringify(message));\n }\n }\n}\n"],"mappings":"AAAA,OAAO,aAAa;AAEpB,YAAY,kBAAkB;AAC9B,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAC3B,MAAM,SAAS,aAAa;AAErB,MAAM,OAAO;AAAA,EAChB,OAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOf,OAAO,OAAO,QAAuB;AACjC,QAAI,CAAC,KAAK,QAAQ;AACd,WAAK,SAAS,QAAQ,aAAa;AAAA,QAC/B,QAAQ,QAAQ,OAAO,KAAK;AAAA,QAC5B,YAAY;AAAA,UACR,IAAI,QAAQ,WAAW,QAAQ;AAAA,YAC3B,OAAO,OAAO,SAAS,SAAS;AAAA,UACpC,CAAC;AAAA,UACD,IAAI,OAAO;AAAA,YACP,QAAQ;AAAA,cACJ,KAAK,OAAO,QAAQ;AAAA,YACxB;AAAA,YACA,OAAO,OAAO,QAAQ,SAAS;AAAA,UACnC,CAAC;AAAA,QACL;AAAA,QACA,GAAG,OAAO;AAAA,MACd,CAAC;AAAA,IACL;AAAA,EACJ;AAAA,EAEA,OAAO,oBAA0B;AAC7B,QAAI,CAAC,KAAK,QAAQ;AACd,YAAM,IAAI;AAAA,QACN;AAAA,QACA,WAAW,KAAK;AAAA,QAChB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,KAAK,SAA0B;AAClC,SAAK,kBAAkB;AACvB,QAAI,OAAO,YAAY,UAAU;AAC7B,WAAK,OAAO,KAAK,OAAO;AAAA,IAC5B,OAAO;AACH,WAAK,OAAO,KAAK,KAAK,UAAU,OAAO,CAAC;AAAA,IAC5C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,MAAM,SAA0B;AACnC,SAAK,kBAAkB;AACvB,QAAI,OAAO,YAAY,UAAU;AAC7B,WAAK,QAAQ,MAAM,OAAO;AAAA,IAC9B,OAAO;AACH,WAAK,QAAQ,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,MAAM,OAAwB;AACjC,SAAK,kBAAkB;AACvB,QAAI,OAAO,UAAU,UAAU;AAC3B,WAAK,QAAQ,MAAM,KAAK;AAAA,IAC5B,OAAO;AACH,WAAK,QAAQ;AAAA,QACT,GAAI,MAAgB,UACd,GAAI,MAAgB,OAAO,QAC3B,EACN,GAAG,KAAK,UAAU,KAAK,CAAC;AAAA,MAC5B;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,KAAK,SAA0B;AAClC,SAAK,kBAAkB;AACvB,QAAI,OAAO,YAAY,UAAU;AAC7B,WAAK,QAAQ,KAAK,OAAO;AAAA,IAC7B,OAAO;AACH,WAAK,QAAQ,KAAK,KAAK,UAAU,OAAO,CAAC;AAAA,IAC7C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,IAAI,OAAe,SAA0B;AAChD,SAAK,kBAAkB;AACvB,QAAI,OAAO,YAAY,UAAU;AAC7B,WAAK,QAAQ,IAAI,OAAO,OAAO;AAAA,IACnC,OAAO;AACH,WAAK,QAAQ,IAAI,OAAO,KAAK,UAAU,OAAO,CAAC;AAAA,IACnD;AAAA,EACJ;AACJ;","names":[]}
@@ -3,11 +3,12 @@ import { IQueryFilterOperationParams, IDocumentConditionalModifications, IQueryO
3
3
  interface Database {
4
4
  connect(): Promise<void>;
5
5
  disconnect(): Promise<void>;
6
- addDocuments(collectionPaths: string[], docDatas: any[], docIds?: string[]): Promise<void>;
7
- updateDocuments(collectionPaths: string[], docDatas: any[], docIds: string[]): Promise<void>;
8
- conditionalUpdateDocuments(collectionPaths: string[], docDatas: any[], docIds: string[], conditions: IQueryFilterOperationParams[], conditionModifications: IDocumentConditionalModifications[]): Promise<void>;
6
+ addDocuments(collectionPaths: string[] | string, docDatas: any[], docIds?: string[]): Promise<void>;
7
+ updateDocuments(collectionPaths: string[] | string, docDatas: any[], docIds: string[]): Promise<void>;
8
+ conditionalUpdateDocuments(collectionPaths: string[] | string, docDatas: any[], docIds: string[], conditions: IQueryFilterOperationParams[], conditionModifications: IDocumentConditionalModifications[]): Promise<void>;
9
9
  getDocuments(collectionPath: string, filter?: IQueryFilterOperationParams[] | undefined, limit?: number | undefined, order?: IQueryOrderOperationParams[] | undefined, startAfterCursor?: string | number | undefined): Promise<any[]>;
10
10
  getDocument(collectionId: string, docId: string): Promise<any | null>;
11
+ getCollectionGroup(groupId: string, filter?: IQueryFilterOperationParams[]): Promise<any | null>;
11
12
  }
12
13
 
13
14
  export type { Database };
@@ -0,0 +1,4 @@
1
+ export { Database } from './db_interface.js';
2
+ export { IQueue } from './queue_interface.js';
3
+ import '../types/database.js';
4
+ import '../types/queue_job_opts.js';
@@ -0,0 +1,3 @@
1
+ export * from "./db_interface";
2
+ export * from "./queue_interface";
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/storage/index.ts"],"sourcesContent":["export * from \"./db_interface\";\nexport * from \"./queue_interface\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}
@@ -0,0 +1,11 @@
1
+ import { JobOpts } from '../types/queue_job_opts.js';
2
+
3
+ interface IQueue<JobData = any, JobResult = any> {
4
+ addJob(name: string, data: JobData, jobOpts?: JobOpts): Promise<void>;
5
+ pause(): Promise<void>;
6
+ resume(): Promise<void>;
7
+ clean(type: "completed" | "failed" | "wait" | "delayed"): Promise<void>;
8
+ getJobCounts(): Promise<Record<string, number>>;
9
+ }
10
+
11
+ export type { IQueue };
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=queue_interface.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
@@ -1,4 +1,4 @@
1
- import { Abi } from 'viem';
1
+ import { Address, AbiEvent } from 'viem';
2
2
 
3
3
  type ChainNativeCurrency = {
4
4
  name: string;
@@ -6,13 +6,14 @@ type ChainNativeCurrency = {
6
6
  decimals: number;
7
7
  };
8
8
  interface IEventConsumerConfig {
9
- contractAddress: `0x${string}`;
10
- eventName: string;
11
- abi: Abi;
9
+ contractAddress: Address | Address[];
10
+ events: AbiEvent[];
12
11
  chainId: number;
13
12
  rpcUrl: string;
14
13
  nativeCurrency: ChainNativeCurrency;
15
14
  startBlock: bigint;
15
+ pollBatchSize: bigint;
16
+ pollInterval: number;
16
17
  }
17
18
 
18
19
  export type { ChainNativeCurrency, IEventConsumerConfig };
@@ -2,5 +2,8 @@ export { ILoggerConfig } from './logger_config.js';
2
2
  export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp } from './database.js';
3
3
  export { IObserver } from './observer.js';
4
4
  export { ChainNativeCurrency, IEventConsumerConfig } from './event_consumer_config.js';
5
+ export { ResponseContext } from './response_context.js';
6
+ export { JobOpts } from './queue_job_opts.js';
7
+ export { IRestAPIConsumerConfig } from './rest_api_consumer_config.js';
5
8
  import 'winston';
6
9
  import 'viem';
@@ -2,4 +2,7 @@ export * from "./logger_config";
2
2
  export * from "./database";
3
3
  export * from "./observer";
4
4
  export * from "./event_consumer_config";
5
+ export * from "./response_context";
6
+ export * from "./queue_job_opts";
7
+ export * from "./rest_api_consumer_config";
5
8
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["export * from \"./logger_config\";\nexport * from \"./database\";\nexport * from \"./observer\";\nexport * from \"./event_consumer_config\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
1
+ {"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["export * from \"./logger_config\";\nexport * from \"./database\";\nexport * from \"./observer\";\nexport * from \"./event_consumer_config\";\nexport * from \"./response_context\";\nexport * from \"./queue_job_opts\";\nexport * from \"./rest_api_consumer_config\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
@@ -0,0 +1,5 @@
1
+ type JobOpts = {
2
+ replace?: boolean;
3
+ };
4
+
5
+ export type { JobOpts };
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=queue_job_opts.js.map