@polygonlabs/servercore 1.0.0-dev.9 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +106 -6
- package/dist/api/health-check.d.ts +8 -0
- package/dist/api/health-check.js +85 -0
- package/dist/api/health-check.js.map +1 -0
- package/dist/api/index.d.ts +1 -0
- package/dist/api/index.js +1 -0
- package/dist/api/index.js.map +1 -1
- package/dist/api/response_handler.d.ts +6 -1
- package/dist/api/response_handler.js +5 -4
- package/dist/api/response_handler.js.map +1 -1
- package/dist/constants/http_success_codes.d.ts +2 -2
- package/dist/constants/http_success_codes.js +2 -2
- package/dist/constants/http_success_codes.js.map +1 -1
- package/dist/constants/index.d.ts +1 -1
- package/dist/consumers/abstract_cron_event_consumer.d.ts +23 -0
- package/dist/consumers/abstract_cron_event_consumer.js +30 -0
- package/dist/consumers/abstract_cron_event_consumer.js.map +1 -0
- package/dist/consumers/event_consumer.d.ts +5 -4
- package/dist/consumers/event_consumer.js +19 -16
- package/dist/consumers/event_consumer.js.map +1 -1
- package/dist/consumers/index.d.ts +3 -0
- package/dist/consumers/index.js +2 -0
- package/dist/consumers/index.js.map +1 -1
- package/dist/consumers/rest_api_consumer.d.ts +30 -0
- package/dist/consumers/rest_api_consumer.js +131 -0
- package/dist/consumers/rest_api_consumer.js.map +1 -0
- package/dist/errors/api_errors.d.ts +1 -1
- package/dist/errors/api_errors.js +11 -9
- package/dist/errors/api_errors.js.map +1 -1
- package/dist/index.d.ts +11 -3
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/logger/logger.js +16 -30
- package/dist/logger/logger.js.map +1 -1
- package/dist/storage/db_interface.d.ts +17 -0
- package/dist/storage/index.d.ts +4 -0
- package/dist/storage/index.js +3 -0
- package/dist/storage/index.js.map +1 -0
- package/dist/storage/queue_interface.d.ts +11 -0
- package/dist/storage/queue_interface.js +1 -0
- package/dist/storage/queue_interface.js.map +1 -0
- package/dist/types/database.d.ts +44 -9
- package/dist/types/index.d.ts +3 -1
- package/dist/types/index.js +2 -0
- package/dist/types/index.js.map +1 -1
- package/dist/types/queue_job_opts.d.ts +5 -0
- package/dist/types/queue_job_opts.js +1 -0
- package/dist/types/queue_job_opts.js.map +1 -0
- package/dist/types/rest_api_consumer_config.d.ts +17 -0
- package/dist/types/rest_api_consumer_config.js +1 -0
- package/dist/types/rest_api_consumer_config.js.map +1 -0
- package/dist/utils/decoder.d.ts +1 -1
- package/dist/utils/decoder.js +3 -3
- package/dist/utils/decoder.js.map +1 -1
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +1 -0
- package/dist/utils/index.js.map +1 -1
- package/dist/utils/ulid.d.ts +3 -0
- package/dist/utils/ulid.js +24 -0
- package/dist/utils/ulid.js.map +1 -0
- package/package.json +15 -15
- package/dist/database/db_interface.d.ts +0 -13
- package/dist/database/index.d.ts +0 -2
- package/dist/database/index.js +0 -2
- package/dist/database/index.js.map +0 -1
- /package/dist/{database → storage}/db_interface.js +0 -0
- /package/dist/{database → storage}/db_interface.js.map +0 -0
package/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2025 PT Services DMCC
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
@@ -1,15 +1,115 @@
|
|
1
|
-
# servercore
|
1
|
+
# @polygonlabs/servercore
|
2
2
|
|
3
|
-
|
3
|
+
Core server framework for building scalable TypeScript applications with built-in logging, error handling, API utilities, and event processing.
|
4
|
+
|
5
|
+
## Features
|
6
|
+
|
7
|
+
- **API Framework**: Health checks, response handlers, and Zod validation utilities
|
8
|
+
- **Event Consumers**: Abstract base classes for REST API and cron job consumers
|
9
|
+
- **Error Handling**: Comprehensive error system with custom error types
|
10
|
+
- **Logging**: Winston-based logging with Sentry integration
|
11
|
+
- **Storage Interfaces**: Abstract interfaces for databases and queues
|
12
|
+
- **Utilities**: ULID generation, data decoders, and type utilities
|
13
|
+
|
14
|
+
## Installation
|
4
15
|
|
5
16
|
```bash
|
6
|
-
|
17
|
+
npm install @polygonlabs/servercore
|
18
|
+
# or
|
19
|
+
bun add @polygonlabs/servercore
|
20
|
+
```
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
### API Framework
|
25
|
+
|
26
|
+
```typescript
|
27
|
+
import { healthCheck, handleResponse } from '@polygonlabs/servercore/api';
|
28
|
+
import { validateInput } from '@polygonlabs/servercore/api';
|
29
|
+
import { z } from 'zod';
|
30
|
+
|
31
|
+
// Health check endpoint
|
32
|
+
const health = healthCheck();
|
33
|
+
|
34
|
+
// Response handling
|
35
|
+
const response = handleResponse(data, 200);
|
36
|
+
|
37
|
+
// Input validation
|
38
|
+
const schema = z.object({ name: z.string() });
|
39
|
+
const validatedData = validateInput(schema, input);
|
40
|
+
```
|
41
|
+
|
42
|
+
### Event Consumers
|
43
|
+
|
44
|
+
```typescript
|
45
|
+
import { RestApiConsumer, CronEventConsumer } from '@polygonlabs/servercore/consumers';
|
46
|
+
|
47
|
+
class MyApiConsumer extends RestApiConsumer {
|
48
|
+
async processEvent(event: any) {
|
49
|
+
// Process API event
|
50
|
+
}
|
51
|
+
}
|
52
|
+
|
53
|
+
class MyCronConsumer extends CronEventConsumer {
|
54
|
+
async processEvent() {
|
55
|
+
// Process scheduled event
|
56
|
+
}
|
57
|
+
}
|
7
58
|
```
|
8
59
|
|
9
|
-
|
60
|
+
### Logging
|
61
|
+
|
62
|
+
```typescript
|
63
|
+
import { createLogger } from '@polygonlabs/servercore/logger';
|
64
|
+
|
65
|
+
const logger = createLogger({
|
66
|
+
level: 'info',
|
67
|
+
service: 'my-service'
|
68
|
+
});
|
69
|
+
|
70
|
+
logger.info('Application started');
|
71
|
+
logger.error('Something went wrong', { error });
|
72
|
+
```
|
73
|
+
|
74
|
+
### Error Handling
|
75
|
+
|
76
|
+
```typescript
|
77
|
+
import {
|
78
|
+
ApiError,
|
79
|
+
DatabaseError,
|
80
|
+
ExternalDependencyError
|
81
|
+
} from '@polygonlabs/servercore/errors';
|
82
|
+
|
83
|
+
// Throw specific errors
|
84
|
+
throw new ApiError('Invalid request', 'INVALID_REQUEST');
|
85
|
+
throw new DatabaseError('Connection failed');
|
86
|
+
throw new ExternalDependencyError('Service unavailable');
|
87
|
+
```
|
88
|
+
|
89
|
+
## Development
|
10
90
|
|
11
91
|
```bash
|
12
|
-
|
92
|
+
# Install dependencies
|
93
|
+
bun install
|
94
|
+
|
95
|
+
# Build the package
|
96
|
+
bun run build
|
97
|
+
|
98
|
+
# Run type checking
|
99
|
+
bun run typecheck
|
100
|
+
|
101
|
+
# Run tests
|
102
|
+
bun run tests
|
13
103
|
```
|
14
104
|
|
15
|
-
|
105
|
+
## Dependencies
|
106
|
+
|
107
|
+
- **croner**: Cron job scheduling
|
108
|
+
- **ulid**: Unique identifier generation
|
109
|
+
- **viem**: Ethereum utilities
|
110
|
+
- **winston**: Logging framework
|
111
|
+
- **zod**: Schema validation
|
112
|
+
|
113
|
+
## License
|
114
|
+
|
115
|
+
MIT
|
@@ -0,0 +1,85 @@
|
|
1
|
+
import { handleResponse, handleError } from "./response_handler";
|
2
|
+
import { ApiError } from "../errors";
|
3
|
+
class HealthCheck {
|
4
|
+
constructor(urls) {
|
5
|
+
this.urls = urls;
|
6
|
+
}
|
7
|
+
async checkHealth() {
|
8
|
+
try {
|
9
|
+
const results = await Promise.all(
|
10
|
+
this.urls.map(async (url) => {
|
11
|
+
const response = await fetch(`${url}`);
|
12
|
+
if (!response.ok) {
|
13
|
+
throw new Error(`Health check failed for ${url}`);
|
14
|
+
}
|
15
|
+
return response;
|
16
|
+
})
|
17
|
+
);
|
18
|
+
if (results.every((res) => res.ok)) {
|
19
|
+
return "ok";
|
20
|
+
}
|
21
|
+
throw new Error("One or more URLs failed the health check.");
|
22
|
+
} catch (error) {
|
23
|
+
const failedUrlChecks = await Promise.all(
|
24
|
+
this.urls.map(async (url) => {
|
25
|
+
try {
|
26
|
+
const response = await fetch(`${url}`);
|
27
|
+
return { url, failed: !response.ok };
|
28
|
+
} catch {
|
29
|
+
return { url, failed: true };
|
30
|
+
}
|
31
|
+
})
|
32
|
+
);
|
33
|
+
const failedUrls = failedUrlChecks.filter((check) => check.failed).map((check) => check.url);
|
34
|
+
throw new ApiError(
|
35
|
+
`Health check failed for the following URLs: ${failedUrls.join(
|
36
|
+
", "
|
37
|
+
)}. Original error: ${error.message}`
|
38
|
+
);
|
39
|
+
}
|
40
|
+
}
|
41
|
+
}
|
42
|
+
function createResponseContext(c) {
|
43
|
+
c.status = c.status || 200;
|
44
|
+
return {
|
45
|
+
status: (statusCode) => {
|
46
|
+
c.status = statusCode;
|
47
|
+
return createResponseContext(c);
|
48
|
+
},
|
49
|
+
json: (body) => {
|
50
|
+
return new Response(JSON.stringify(body), {
|
51
|
+
status: c.status,
|
52
|
+
headers: { "Content-Type": "application/json" }
|
53
|
+
});
|
54
|
+
}
|
55
|
+
};
|
56
|
+
}
|
57
|
+
function setupHealthCheckServer(urls, serverPort) {
|
58
|
+
const healthCheck = new HealthCheck(urls);
|
59
|
+
Bun.serve({
|
60
|
+
port: serverPort,
|
61
|
+
routes: {
|
62
|
+
"/health-check": {
|
63
|
+
GET: async (c) => {
|
64
|
+
try {
|
65
|
+
await healthCheck.checkHealth();
|
66
|
+
return handleResponse(createResponseContext(c), "ok");
|
67
|
+
} catch (error) {
|
68
|
+
return handleError(
|
69
|
+
createResponseContext(c),
|
70
|
+
error
|
71
|
+
);
|
72
|
+
}
|
73
|
+
}
|
74
|
+
}
|
75
|
+
}
|
76
|
+
});
|
77
|
+
console.log(
|
78
|
+
`Health check server running on http://localhost:${serverPort}/health-check`
|
79
|
+
);
|
80
|
+
}
|
81
|
+
export {
|
82
|
+
HealthCheck,
|
83
|
+
setupHealthCheckServer
|
84
|
+
};
|
85
|
+
//# sourceMappingURL=health-check.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["../../src/api/health-check.ts"],"sourcesContent":["import { handleResponse, handleError } from \"./response_handler\";\nimport type { ResponseContext } from \"../types\";\nimport { ApiError } from \"../errors\";\n\nexport class HealthCheck {\n constructor(private readonly urls: string[]) {}\n\n async checkHealth(): Promise<string> {\n try {\n const results = await Promise.all(\n this.urls.map(async (url) => {\n const response = await fetch(`${url}`);\n if (!response.ok) {\n throw new Error(`Health check failed for ${url}`);\n }\n return response;\n })\n );\n\n if (results.every((res) => res.ok)) {\n return \"ok\";\n }\n throw new Error(\"One or more URLs failed the health check.\");\n } catch (error) {\n const failedUrlChecks = await Promise.all(\n this.urls.map(async (url) => {\n try {\n const response = await fetch(`${url}`);\n return { url, failed: !response.ok };\n } catch {\n return { url, failed: true };\n }\n })\n );\n const failedUrls = failedUrlChecks\n .filter(check => check.failed)\n .map(check => check.url);\n \n throw new ApiError(\n `Health check failed for the following URLs: ${failedUrls.join(\n \", \"\n )}. Original error: ${(error as Error).message}`\n );\n }\n }\n}\n\n// Utility to convert Bun context to ResponseContext\nfunction createResponseContext(c: any): ResponseContext {\n c.status = c.status || 200; // Default status to 200 if undefined\n return {\n status: (statusCode: number) => {\n c.status = statusCode;\n return createResponseContext(c); // Return the updated context\n },\n json: (body: any) => {\n return new Response(JSON.stringify(body), {\n status: c.status,\n headers: { \"Content-Type\": \"application/json\" },\n });\n },\n };\n}\n\n// Setup Bun server with health check route\nexport function setupHealthCheckServer(\n urls: string[],\n serverPort: number\n): void {\n const healthCheck = new HealthCheck(urls);\n\n Bun.serve({\n port: serverPort,\n routes: {\n \"/health-check\": {\n GET: async (c: any) => {\n try {\n await healthCheck.checkHealth();\n return handleResponse(createResponseContext(c), \"ok\");\n } catch (error) {\n return handleError(\n createResponseContext(c),\n error as ApiError\n );\n }\n },\n },\n },\n });\n\n console.log(\n `Health check server running on http://localhost:${serverPort}/health-check`\n );\n}\n"],"mappings":"AAAA,SAAS,gBAAgB,mBAAmB;AAE5C,SAAS,gBAAgB;AAElB,MAAM,YAAY;AAAA,EACrB,YAA6B,MAAgB;AAAhB;AAAA,EAAiB;AAAA,EAE9C,MAAM,cAA+B;AACjC,QAAI;AACA,YAAM,UAAU,MAAM,QAAQ;AAAA,QAC1B,KAAK,KAAK,IAAI,OAAO,QAAQ;AACzB,gBAAM,WAAW,MAAM,MAAM,GAAG,GAAG,EAAE;AACrC,cAAI,CAAC,SAAS,IAAI;AACd,kBAAM,IAAI,MAAM,2BAA2B,GAAG,EAAE;AAAA,UACpD;AACA,iBAAO;AAAA,QACX,CAAC;AAAA,MACL;AAEA,UAAI,QAAQ,MAAM,CAAC,QAAQ,IAAI,EAAE,GAAG;AAChC,eAAO;AAAA,MACX;AACA,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC/D,SAAS,OAAO;AACZ,YAAM,kBAAkB,MAAM,QAAQ;AAAA,QAClC,KAAK,KAAK,IAAI,OAAO,QAAQ;AACzB,cAAI;AACA,kBAAM,WAAW,MAAM,MAAM,GAAG,GAAG,EAAE;AACrC,mBAAO,EAAE,KAAK,QAAQ,CAAC,SAAS,GAAG;AAAA,UACvC,QAAQ;AACJ,mBAAO,EAAE,KAAK,QAAQ,KAAK;AAAA,UAC/B;AAAA,QACJ,CAAC;AAAA,MACL;AACA,YAAM,aAAa,gBACd,OAAO,WAAS,MAAM,MAAM,EAC5B,IAAI,WAAS,MAAM,GAAG;AAE3B,YAAM,IAAI;AAAA,QACN,+CAA+C,WAAW;AAAA,UACtD;AAAA,QACJ,CAAC,qBAAsB,MAAgB,OAAO;AAAA,MAClD;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,sBAAsB,GAAyB;AACpD,IAAE,SAAS,EAAE,UAAU;AACvB,SAAO;AAAA,IACH,QAAQ,CAAC,eAAuB;AAC5B,QAAE,SAAS;AACX,aAAO,sBAAsB,CAAC;AAAA,IAClC;AAAA,IACA,MAAM,CAAC,SAAc;AACjB,aAAO,IAAI,SAAS,KAAK,UAAU,IAAI,GAAG;AAAA,QACtC,QAAQ,EAAE;AAAA,QACV,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,MAClD,CAAC;AAAA,IACL;AAAA,EACJ;AACJ;AAGO,SAAS,uBACZ,MACA,YACI;AACJ,QAAM,cAAc,IAAI,YAAY,IAAI;AAExC,MAAI,MAAM;AAAA,IACN,MAAM;AAAA,IACN,QAAQ;AAAA,MACJ,iBAAiB;AAAA,QACb,KAAK,OAAO,MAAW;AACnB,cAAI;AACA,kBAAM,YAAY,YAAY;AAC9B,mBAAO,eAAe,sBAAsB,CAAC,GAAG,IAAI;AAAA,UACxD,SAAS,OAAO;AACZ,mBAAO;AAAA,cACH,sBAAsB,CAAC;AAAA,cACvB;AAAA,YACJ;AAAA,UACJ;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ,CAAC;AAED,UAAQ;AAAA,IACJ,mDAAmD,UAAU;AAAA,EACjE;AACJ;","names":[]}
|
package/dist/api/index.d.ts
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
export { handleError, handleResponse } from './response_handler.js';
|
2
2
|
export { validateBody, validateParams, validateQuery } from './zod_utils.js';
|
3
|
+
export { HealthCheck, setupHealthCheckServer } from './health-check.js';
|
3
4
|
import '../errors/api_errors.js';
|
4
5
|
import '../errors/base_error.js';
|
5
6
|
import '../errors/database_errors.js';
|
package/dist/api/index.js
CHANGED
package/dist/api/index.js.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../src/api/index.ts"],"sourcesContent":["export * from \"./response_handler\";\nexport * from \"./zod_utils\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}
|
1
|
+
{"version":3,"sources":["../../src/api/index.ts"],"sourcesContent":["export * from \"./response_handler\";\nexport * from \"./zod_utils\";\nexport * from \"./health-check\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
|
@@ -4,7 +4,12 @@ import { ExternalDependencyError } from '../errors/external_dependency_error.js'
|
|
4
4
|
import { ResponseContext } from '../types/response_context.js';
|
5
5
|
import '../errors/base_error.js';
|
6
6
|
|
7
|
-
declare const handleResponse: (c: ResponseContext, data: any
|
7
|
+
declare const handleResponse: (c: ResponseContext, data: any, pagination?: {
|
8
|
+
total: number;
|
9
|
+
limit: number;
|
10
|
+
offset?: number;
|
11
|
+
nextStartAfterCursor?: string | number;
|
12
|
+
}) => any;
|
8
13
|
declare const handleError: (c: ResponseContext, error: ApiError | ExternalDependencyError | DatabaseError) => any;
|
9
14
|
|
10
15
|
export { handleError, handleResponse };
|
@@ -1,9 +1,10 @@
|
|
1
1
|
import { ApiError, DatabaseError, ExternalDependencyError } from "../errors";
|
2
|
-
import {
|
3
|
-
const handleResponse = (c, data) => {
|
4
|
-
return c.status(
|
2
|
+
import { httpResponseCodes, errorCodes } from "../constants";
|
3
|
+
const handleResponse = (c, data, pagination) => {
|
4
|
+
return c.status(httpResponseCodes.OK_RESPONSE).json({
|
5
5
|
status: "success",
|
6
|
-
data
|
6
|
+
data,
|
7
|
+
pagination
|
7
8
|
});
|
8
9
|
};
|
9
10
|
const handleError = (c, error) => {
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../src/api/response_handler.ts"],"sourcesContent":["import { ApiError, DatabaseError, ExternalDependencyError } from \"../errors\"; // Define your error types\nimport {
|
1
|
+
{"version":3,"sources":["../../src/api/response_handler.ts"],"sourcesContent":["import { ApiError, DatabaseError, ExternalDependencyError } from \"../errors\"; // Define your error types\nimport { httpResponseCodes, errorCodes } from \"../constants\"; // Define your success codes\nimport type { ResponseContext } from \"../types\";\n\nexport const handleResponse = (\n c: ResponseContext,\n data: any,\n pagination?: {\n total: number;\n limit: number;\n offset?: number;\n nextStartAfterCursor?: string | number;\n }\n) => {\n // This method returns a success response with the status and data.\n return c\n .status(httpResponseCodes.OK_RESPONSE) // Use success code from httpResponseCodes\n .json({\n status: \"success\",\n data: data,\n pagination,\n });\n};\n\nexport const handleError = (\n c: ResponseContext,\n error: ApiError | ExternalDependencyError | DatabaseError\n) => {\n // This method returns an error response with the error details.\n return c\n .status(error.code ?? errorCodes.api.INTERNAL_SERVER_ERROR) // Use error code or default to internal server error\n .json({\n status: \"error\",\n message: error.message,\n name: error.name,\n code: error.code,\n details: error.context,\n });\n};\n"],"mappings":"AAAA,SAAS,UAAU,eAAe,+BAA+B;AACjE,SAAS,mBAAmB,kBAAkB;AAGvC,MAAM,iBAAiB,CAC1B,GACA,MACA,eAMC;AAED,SAAO,EACF,OAAO,kBAAkB,WAAW,EACpC,KAAK;AAAA,IACF,QAAQ;AAAA,IACR;AAAA,IACA;AAAA,EACJ,CAAC;AACT;AAEO,MAAM,cAAc,CACvB,GACA,UACC;AAED,SAAO,EACF,OAAO,MAAM,QAAQ,WAAW,IAAI,qBAAqB,EACzD,KAAK;AAAA,IACF,QAAQ;AAAA,IACR,SAAS,MAAM;AAAA,IACf,MAAM,MAAM;AAAA,IACZ,MAAM,MAAM;AAAA,IACZ,SAAS,MAAM;AAAA,EACnB,CAAC;AACT;","names":[]}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../src/constants/http_success_codes.ts"],"sourcesContent":["export const
|
1
|
+
{"version":3,"sources":["../../src/constants/http_success_codes.ts"],"sourcesContent":["export const httpResponseCodes = {\n OK_RESPONSE: 200,\n};\n"],"mappings":"AAAO,MAAM,oBAAoB;AAAA,EAC7B,aAAa;AACjB;","names":[]}
|
@@ -1,2 +1,2 @@
|
|
1
1
|
export { errorCodes } from './error_codes.js';
|
2
|
-
export {
|
2
|
+
export { httpResponseCodes } from './http_success_codes.js';
|
@@ -0,0 +1,23 @@
|
|
1
|
+
import { AbstractEventConsumer } from './abstract_event_consumer.js';
|
2
|
+
import '../errors/consumer_errors.js';
|
3
|
+
import '../errors/base_error.js';
|
4
|
+
import 'events';
|
5
|
+
|
6
|
+
declare abstract class AbstractCronEventConsumer extends AbstractEventConsumer {
|
7
|
+
private cronJob;
|
8
|
+
/**
|
9
|
+
* Start the cron job with the given cron expression.
|
10
|
+
* @param cronExpr Cron expression string
|
11
|
+
*/
|
12
|
+
startCron(cronExpr: string): void;
|
13
|
+
/**
|
14
|
+
* Stop the cron job.
|
15
|
+
*/
|
16
|
+
stopCron(): void;
|
17
|
+
/**
|
18
|
+
* Implement this in subclasses to define what happens on each cron tick.
|
19
|
+
*/
|
20
|
+
protected abstract onTick(): Promise<void>;
|
21
|
+
}
|
22
|
+
|
23
|
+
export { AbstractCronEventConsumer };
|
@@ -0,0 +1,30 @@
|
|
1
|
+
import { Cron } from "croner";
|
2
|
+
import { AbstractEventConsumer } from "./abstract_event_consumer";
|
3
|
+
class AbstractCronEventConsumer extends AbstractEventConsumer {
|
4
|
+
cronJob = null;
|
5
|
+
/**
|
6
|
+
* Start the cron job with the given cron expression.
|
7
|
+
* @param cronExpr Cron expression string
|
8
|
+
*/
|
9
|
+
startCron(cronExpr) {
|
10
|
+
if (this.cronJob) {
|
11
|
+
this.cronJob.stop();
|
12
|
+
}
|
13
|
+
this.cronJob = new Cron(cronExpr, { protect: true }, async () => {
|
14
|
+
await this.onTick();
|
15
|
+
});
|
16
|
+
}
|
17
|
+
/**
|
18
|
+
* Stop the cron job.
|
19
|
+
*/
|
20
|
+
stopCron() {
|
21
|
+
if (this.cronJob) {
|
22
|
+
this.cronJob.stop();
|
23
|
+
this.cronJob = null;
|
24
|
+
}
|
25
|
+
}
|
26
|
+
}
|
27
|
+
export {
|
28
|
+
AbstractCronEventConsumer
|
29
|
+
};
|
30
|
+
//# sourceMappingURL=abstract_cron_event_consumer.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["../../src/consumers/abstract_cron_event_consumer.ts"],"sourcesContent":["import { Cron } from \"croner\";\nimport { AbstractEventConsumer } from \"./abstract_event_consumer\";\n\nexport abstract class AbstractCronEventConsumer extends AbstractEventConsumer {\n private cronJob: Cron | null = null;\n\n /**\n * Start the cron job with the given cron expression.\n * @param cronExpr Cron expression string\n */\n public startCron(cronExpr: string): void {\n if (this.cronJob) {\n this.cronJob.stop();\n }\n this.cronJob = new Cron(cronExpr, { protect: true }, async () => {\n await this.onTick();\n });\n }\n\n /**\n * Stop the cron job.\n */\n public stopCron(): void {\n if (this.cronJob) {\n this.cronJob.stop();\n this.cronJob = null;\n }\n }\n\n /**\n * Implement this in subclasses to define what happens on each cron tick.\n */\n protected abstract onTick(): Promise<void>;\n}\n"],"mappings":"AAAA,SAAS,YAAY;AACrB,SAAS,6BAA6B;AAE/B,MAAe,kCAAkC,sBAAsB;AAAA,EAClE,UAAuB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,UAAU,UAAwB;AACrC,QAAI,KAAK,SAAS;AACd,WAAK,QAAQ,KAAK;AAAA,IACtB;AACA,SAAK,UAAU,IAAI,KAAK,UAAU,EAAE,SAAS,KAAK,GAAG,YAAY;AAC7D,YAAM,KAAK,OAAO;AAAA,IACtB,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKO,WAAiB;AACpB,QAAI,KAAK,SAAS;AACd,WAAK,QAAQ,KAAK;AAClB,WAAK,UAAU;AAAA,IACnB;AAAA,EACJ;AAMJ;","names":[]}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { PublicClient } from 'viem';
|
1
|
+
import { PublicClient, WatchEventReturnType } from 'viem';
|
2
2
|
import { ConsumerError } from '../errors/consumer_errors.js';
|
3
3
|
import { IObserver } from '../types/observer.js';
|
4
4
|
import { IEventConsumerConfig } from '../types/event_consumer_config.js';
|
@@ -7,10 +7,11 @@ import '../errors/base_error.js';
|
|
7
7
|
import 'events';
|
8
8
|
|
9
9
|
declare class EventConsumer<T, U> extends AbstractEventConsumer {
|
10
|
-
private config;
|
11
|
-
private consumerRunning;
|
10
|
+
private readonly config;
|
12
11
|
protected client: PublicClient | null;
|
13
12
|
protected observer: IObserver<T, ConsumerError, U> | null;
|
13
|
+
isBackfillingInProcess: boolean;
|
14
|
+
protected unWatchFunction: WatchEventReturnType | undefined;
|
14
15
|
constructor(config: IEventConsumerConfig);
|
15
16
|
private _backfillEvents;
|
16
17
|
start(observer: IObserver<T, ConsumerError, U>): Promise<void>;
|
@@ -19,7 +20,7 @@ declare class EventConsumer<T, U> extends AbstractEventConsumer {
|
|
19
20
|
*
|
20
21
|
* @returns {void}
|
21
22
|
*/
|
22
|
-
|
23
|
+
onDisconnect(): void;
|
23
24
|
}
|
24
25
|
|
25
26
|
export { EventConsumer };
|
@@ -17,21 +17,22 @@ class EventConsumer extends AbstractEventConsumer {
|
|
17
17
|
transport: http(config.rpcUrl)
|
18
18
|
});
|
19
19
|
}
|
20
|
-
consumerRunning = false;
|
21
20
|
client = null;
|
22
21
|
observer = null;
|
22
|
+
isBackfillingInProcess = false;
|
23
|
+
unWatchFunction;
|
23
24
|
async _backfillEvents(fromBlock, toBlock, step) {
|
24
25
|
Logger.info({
|
25
26
|
location: "event_consumer",
|
26
27
|
functon: "_backfillEvents",
|
27
|
-
status: `[Backfill] Starting backfill from block ${fromBlock} to ${toBlock}`
|
28
|
+
status: `[Backfill] Starting backfill from block ${fromBlock.toString()} to ${toBlock.toString()}`
|
28
29
|
});
|
29
30
|
for (let start = fromBlock; start <= toBlock; start += step) {
|
30
31
|
const end = start + step - 1n > toBlock ? toBlock : start + step - 1n;
|
31
32
|
Logger.debug({
|
32
33
|
location: "event_consumer",
|
33
34
|
functon: "_backfillEvents",
|
34
|
-
status: `[Backfill] Fetching logs from block ${start} to ${end}`
|
35
|
+
status: `[Backfill] Fetching logs from block ${start.toString()} to ${end.toString()}`
|
35
36
|
});
|
36
37
|
const getLogsConfig = {
|
37
38
|
address: this.config.contractAddress,
|
@@ -39,48 +40,50 @@ class EventConsumer extends AbstractEventConsumer {
|
|
39
40
|
toBlock: end
|
40
41
|
};
|
41
42
|
if (this.config.events.length > 1) {
|
42
|
-
getLogsConfig.event = this.config.events[0];
|
43
|
-
} else {
|
44
43
|
getLogsConfig.events = this.config.events;
|
44
|
+
} else {
|
45
|
+
getLogsConfig.event = this.config.events[0];
|
45
46
|
}
|
46
47
|
const logs = await this.client?.getLogs(getLogsConfig);
|
47
48
|
Logger.debug({
|
48
49
|
location: "event_consumer",
|
49
50
|
functon: "_backfillEvents",
|
50
|
-
status: `[Backfill] ${logs?.length} logs from block ${start} to ${end}`
|
51
|
+
status: `[Backfill] ${logs?.length} logs from block ${start.toString()} to ${end.toString()}`
|
51
52
|
});
|
52
53
|
await this.observer?.next(logs);
|
53
54
|
}
|
54
55
|
}
|
55
56
|
async start(observer) {
|
56
57
|
try {
|
58
|
+
this.isBackfillingInProcess = true;
|
57
59
|
this.observer = observer;
|
58
60
|
const latestBlock = await this.client?.getBlockNumber() ?? BigInt(0);
|
59
61
|
Logger.debug({
|
60
62
|
location: "event_consumer",
|
61
63
|
functon: "start",
|
62
64
|
data: {
|
63
|
-
latestBlock,
|
64
|
-
startBlock: this.config.startBlock,
|
65
|
-
pollBatchSize: this.config.pollBatchSize
|
65
|
+
latestBlock: latestBlock.toString(),
|
66
|
+
startBlock: this.config.startBlock.toString(),
|
67
|
+
pollBatchSize: this.config.pollBatchSize.toString()
|
66
68
|
}
|
67
69
|
});
|
68
|
-
if (latestBlock - this.config.startBlock >
|
70
|
+
if (latestBlock - this.config.startBlock > BigInt(0)) {
|
69
71
|
await this._backfillEvents(
|
70
72
|
this.config.startBlock,
|
71
73
|
latestBlock,
|
72
74
|
this.config.pollBatchSize
|
73
75
|
);
|
74
76
|
}
|
77
|
+
this.isBackfillingInProcess = false;
|
75
78
|
Logger.debug({
|
76
79
|
location: "event_consumer",
|
77
80
|
functon: "start",
|
78
81
|
status: `Starting event subscription`
|
79
82
|
});
|
80
|
-
this.client?.watchEvent({
|
83
|
+
this.unWatchFunction = this.client?.watchEvent({
|
81
84
|
address: this.config.contractAddress,
|
82
85
|
events: this.config.events,
|
83
|
-
fromBlock:
|
86
|
+
fromBlock: latestBlock,
|
84
87
|
onLogs: (logs) => {
|
85
88
|
const transformedLogs = logs;
|
86
89
|
this.observer?.next(transformedLogs);
|
@@ -125,11 +128,11 @@ class EventConsumer extends AbstractEventConsumer {
|
|
125
128
|
* @returns {void}
|
126
129
|
*/
|
127
130
|
onDisconnect() {
|
128
|
-
|
129
|
-
|
130
|
-
this.
|
131
|
-
this.removeAllListeners();
|
131
|
+
this.removeAllListeners();
|
132
|
+
if (this.unWatchFunction) {
|
133
|
+
this.unWatchFunction();
|
132
134
|
}
|
135
|
+
this.observer?.closed();
|
133
136
|
}
|
134
137
|
}
|
135
138
|
export {
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../src/consumers/event_consumer.ts"],"sourcesContent":["import { Logger } from \"../logger\";\nimport { createPublicClient, http, type PublicClient } from \"viem\";\nimport { ConsumerError, ExternalDependencyError } from \"../errors\";\nimport type { IEventConsumerConfig, IObserver } from \"../types\";\nimport { AbstractEventConsumer } from \"./abstract_event_consumer\";\nimport { errorCodes } from \"../constants\";\n\nexport class EventConsumer<T, U> extends AbstractEventConsumer {\n
|
1
|
+
{"version":3,"sources":["../../src/consumers/event_consumer.ts"],"sourcesContent":["import { Logger } from \"../logger\";\nimport { createPublicClient, http, type PublicClient, type WatchEventReturnType } from \"viem\";\nimport { ConsumerError, ExternalDependencyError } from \"../errors\";\nimport type { IEventConsumerConfig, IObserver } from \"../types\";\nimport { AbstractEventConsumer } from \"./abstract_event_consumer\";\nimport { errorCodes } from \"../constants\";\n\nexport class EventConsumer<T, U> extends AbstractEventConsumer {\n protected client: PublicClient | null = null;\n protected observer: IObserver<T, ConsumerError, U> | null = null;\n public isBackfillingInProcess: boolean = false;\n protected unWatchFunction: WatchEventReturnType | undefined;\n\n constructor(private readonly config: IEventConsumerConfig) {\n super();\n this.client = createPublicClient({\n chain: {\n id: config.chainId,\n name: \"custom\",\n rpcUrls: { default: { http: [config.rpcUrl] } },\n nativeCurrency: config.nativeCurrency,\n },\n transport: http(config.rpcUrl),\n });\n }\n\n private async _backfillEvents(\n fromBlock: bigint,\n toBlock: bigint,\n step: bigint\n ): Promise<void> {\n Logger.info({\n location: \"event_consumer\",\n functon: \"_backfillEvents\",\n status: `[Backfill] Starting backfill from block ${fromBlock.toString()} to ${toBlock.toString()}`,\n });\n\n for (let start = fromBlock; start <= toBlock; start += step) {\n const end =\n start + step - 1n > toBlock ? toBlock : start + step - 1n;\n Logger.debug({\n location: \"event_consumer\",\n functon: \"_backfillEvents\",\n status: `[Backfill] Fetching logs from block ${start.toString()} to ${end.toString()}`,\n });\n const getLogsConfig: any = {\n address: this.config.contractAddress,\n fromBlock: start,\n toBlock: end,\n };\n if (this.config.events.length > 1) {\n getLogsConfig.events = this.config.events;\n } else {\n getLogsConfig.event = this.config.events[0];\n }\n const logs = await this.client?.getLogs(getLogsConfig);\n Logger.debug({\n location: \"event_consumer\",\n functon: \"_backfillEvents\",\n status: `[Backfill] ${logs?.length} logs from block ${start.toString()} to ${end.toString()}`,\n });\n await this.observer?.next(logs as T);\n }\n }\n\n public async start(\n observer: IObserver<T, ConsumerError, U>\n ): Promise<void> {\n try {\n this.isBackfillingInProcess = true\n this.observer = observer;\n const latestBlock: bigint =\n (await this.client?.getBlockNumber()) ?? BigInt(0);\n Logger.debug({\n location: \"event_consumer\",\n functon: \"start\",\n data: {\n latestBlock: latestBlock.toString(),\n startBlock: this.config.startBlock.toString(),\n pollBatchSize: this.config.pollBatchSize.toString(),\n },\n });\n if (latestBlock - this.config.startBlock > BigInt(0)) {\n await this._backfillEvents(\n this.config.startBlock,\n latestBlock,\n this.config.pollBatchSize\n );\n }\n this.isBackfillingInProcess = false\n\n Logger.debug({\n location: \"event_consumer\",\n functon: \"start\",\n status: `Starting event subscription`,\n });\n\n this.unWatchFunction = this.client?.watchEvent({\n address: this.config.contractAddress,\n events: this.config.events,\n fromBlock: latestBlock,\n onLogs: (logs) => {\n const transformedLogs = logs as T;\n this.observer?.next(transformedLogs);\n },\n onError: (error) => {\n this.onDisconnect();\n this.onFatalError(\n new ConsumerError(error.name, {\n name: \"CONSUMER_ERROR\",\n code: 1001,\n isFatal: true,\n origin: \"EventConsumer\",\n context: { eventName: this.config.events },\n })\n );\n },\n });\n\n Logger.debug({\n location: \"event_consumer\",\n functon: \"start\",\n status: `Subscribed to event`,\n });\n } catch (error) {\n this.onDisconnect();\n this.onFatalError(\n new ExternalDependencyError(\n this.config.rpcUrl,\n \"Failed to start the event consumer\",\n {\n externalCode:\n errorCodes.external\n .UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,\n rawError: error as Error,\n origin: \"EventConsumer\",\n context: { eventName: this.config.events },\n }\n )\n );\n }\n }\n\n /**\n * Private method which updates the connection status of consumer to disconnected, and removes all listeners.\n *\n * @returns {void}\n */\n public onDisconnect(): void {\n this.removeAllListeners();\n if (this.unWatchFunction) {\n this.unWatchFunction();\n }\n this.observer?.closed();\n }\n}\n"],"mappings":"AAAA,SAAS,cAAc;AACvB,SAAS,oBAAoB,YAA0D;AACvF,SAAS,eAAe,+BAA+B;AAEvD,SAAS,6BAA6B;AACtC,SAAS,kBAAkB;AAEpB,MAAM,sBAA4B,sBAAsB;AAAA,EAM3D,YAA6B,QAA8B;AACvD,UAAM;AADmB;AAEzB,SAAK,SAAS,mBAAmB;AAAA,MAC7B,OAAO;AAAA,QACH,IAAI,OAAO;AAAA,QACX,MAAM;AAAA,QACN,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,MAAM,EAAE,EAAE;AAAA,QAC9C,gBAAgB,OAAO;AAAA,MAC3B;AAAA,MACA,WAAW,KAAK,OAAO,MAAM;AAAA,IACjC,CAAC;AAAA,EACL;AAAA,EAhBU,SAA8B;AAAA,EAC9B,WAAkD;AAAA,EACrD,yBAAkC;AAAA,EAC/B;AAAA,EAeV,MAAc,gBACV,WACA,SACA,MACa;AACb,WAAO,KAAK;AAAA,MACR,UAAU;AAAA,MACV,SAAS;AAAA,MACT,QAAQ,2CAA2C,UAAU,SAAS,CAAC,OAAO,QAAQ,SAAS,CAAC;AAAA,IACpG,CAAC;AAED,aAAS,QAAQ,WAAW,SAAS,SAAS,SAAS,MAAM;AACzD,YAAM,MACF,QAAQ,OAAO,KAAK,UAAU,UAAU,QAAQ,OAAO;AAC3D,aAAO,MAAM;AAAA,QACT,UAAU;AAAA,QACV,SAAS;AAAA,QACT,QAAQ,uCAAuC,MAAM,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC;AAAA,MACxF,CAAC;AACD,YAAM,gBAAqB;AAAA,QACvB,SAAS,KAAK,OAAO;AAAA,QACrB,WAAW;AAAA,QACX,SAAS;AAAA,MACb;AACA,UAAI,KAAK,OAAO,OAAO,SAAS,GAAG;AAC/B,sBAAc,SAAS,KAAK,OAAO;AAAA,MACvC,OAAO;AACH,sBAAc,QAAQ,KAAK,OAAO,OAAO,CAAC;AAAA,MAC9C;AACA,YAAM,OAAO,MAAM,KAAK,QAAQ,QAAQ,aAAa;AACrD,aAAO,MAAM;AAAA,QACT,UAAU;AAAA,QACV,SAAS;AAAA,QACT,QAAQ,cAAc,MAAM,MAAM,oBAAoB,MAAM,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC;AAAA,MAC/F,CAAC;AACD,YAAM,KAAK,UAAU,KAAK,IAAS;AAAA,IACvC;AAAA,EACJ;AAAA,EAEA,MAAa,MACT,UACa;AACb,QAAI;AACA,WAAK,yBAAyB;AAC9B,WAAK,WAAW;AAChB,YAAM,cACD,MAAM,KAAK,QAAQ,eAAe,KAAM,OAAO,CAAC;AACrD,aAAO,MAAM;AAAA,QACT,UAAU;AAAA,QACV,SAAS;AAAA,QACT,MAAM;AAAA,UACF,aAAa,YAAY,SAAS;AAAA,UAClC,YAAY,KAAK,OAAO,WAAW,SAAS;AAAA,UAC5C,eAAe,KAAK,OAAO,cAAc,SAAS;AAAA,QACtD;AAAA,MACJ,CAAC;AACD,UAAI,cAAc,KAAK,OAAO,aAAa,OAAO,CAAC,GAAG;AAClD,cAAM,KAAK;AAAA,UACP,KAAK,OAAO;AAAA,UACZ;AAAA,UACA,KAAK,OAAO;AAAA,QAChB;AAAA,MACJ;AACA,WAAK,yBAAyB;AAE9B,aAAO,MAAM;AAAA,QACT,UAAU;AAAA,QACV,SAAS;AAAA,QACT,QAAQ;AAAA,MACZ,CAAC;AAED,WAAK,kBAAkB,KAAK,QAAQ,WAAW;AAAA,QAC3C,SAAS,KAAK,OAAO;AAAA,QACrB,QAAQ,KAAK,OAAO;AAAA,QACpB,WAAW;AAAA,QACX,QAAQ,CAAC,SAAS;AACd,gBAAM,kBAAkB;AACxB,eAAK,UAAU,KAAK,eAAe;AAAA,QACvC;AAAA,QACA,SAAS,CAAC,UAAU;AAChB,eAAK,aAAa;AAClB,eAAK;AAAA,YACD,IAAI,cAAc,MAAM,MAAM;AAAA,cAC1B,MAAM;AAAA,cACN,MAAM;AAAA,cACN,SAAS;AAAA,cACT,QAAQ;AAAA,cACR,SAAS,EAAE,WAAW,KAAK,OAAO,OAAO;AAAA,YAC7C,CAAC;AAAA,UACL;AAAA,QACJ;AAAA,MACJ,CAAC;AAED,aAAO,MAAM;AAAA,QACT,UAAU;AAAA,QACV,SAAS;AAAA,QACT,QAAQ;AAAA,MACZ,CAAC;AAAA,IACL,SAAS,OAAO;AACZ,WAAK,aAAa;AAClB,WAAK;AAAA,QACD,IAAI;AAAA,UACA,KAAK,OAAO;AAAA,UACZ;AAAA,UACA;AAAA,YACI,cACI,WAAW,SACN;AAAA,YACT,UAAU;AAAA,YACV,QAAQ;AAAA,YACR,SAAS,EAAE,WAAW,KAAK,OAAO,OAAO;AAAA,UAC7C;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,eAAqB;AACxB,SAAK,mBAAmB;AACxB,QAAI,KAAK,iBAAiB;AACtB,WAAK,gBAAgB;AAAA,IACzB;AACA,SAAK,UAAU,OAAO;AAAA,EAC1B;AACJ;","names":[]}
|
@@ -1,4 +1,6 @@
|
|
1
1
|
export { EventConsumer } from './event_consumer.js';
|
2
|
+
export { RestAPIConsumer } from './rest_api_consumer.js';
|
3
|
+
export { AbstractCronEventConsumer } from './abstract_cron_event_consumer.js';
|
2
4
|
import 'viem';
|
3
5
|
import '../errors/consumer_errors.js';
|
4
6
|
import '../errors/base_error.js';
|
@@ -6,3 +8,4 @@ import '../types/observer.js';
|
|
6
8
|
import '../types/event_consumer_config.js';
|
7
9
|
import './abstract_event_consumer.js';
|
8
10
|
import 'events';
|
11
|
+
import '../types/rest_api_consumer_config.js';
|
package/dist/consumers/index.js
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../src/consumers/index.ts"],"sourcesContent":["export * from \"./event_consumer\";\n"],"mappings":"AAAA,cAAc;","names":[]}
|
1
|
+
{"version":3,"sources":["../../src/consumers/index.ts"],"sourcesContent":["export * from \"./event_consumer\";\nexport * from \"./rest_api_consumer\";\nexport * from \"./abstract_cron_event_consumer\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
|
@@ -0,0 +1,30 @@
|
|
1
|
+
import { ConsumerError } from '../errors/consumer_errors.js';
|
2
|
+
import { IObserver } from '../types/observer.js';
|
3
|
+
import { IRestAPIConsumerConfig } from '../types/rest_api_consumer_config.js';
|
4
|
+
import { AbstractCronEventConsumer } from './abstract_cron_event_consumer.js';
|
5
|
+
import '../errors/base_error.js';
|
6
|
+
import './abstract_event_consumer.js';
|
7
|
+
import 'events';
|
8
|
+
|
9
|
+
declare class RestAPIConsumer<T, U> extends AbstractCronEventConsumer {
|
10
|
+
private readonly config;
|
11
|
+
protected observer: IObserver<T, ConsumerError, U> | null;
|
12
|
+
private currentPage;
|
13
|
+
private highestValueSeen;
|
14
|
+
constructor(config: IRestAPIConsumerConfig);
|
15
|
+
start(observer: IObserver<T, ConsumerError, U>): Promise<void>;
|
16
|
+
stop(): void;
|
17
|
+
protected onTick(): Promise<void>;
|
18
|
+
private fetchPage;
|
19
|
+
private getValueByPath;
|
20
|
+
private processDataForCurrentCountValue;
|
21
|
+
/**
|
22
|
+
* Updates the start count value to a specific value.
|
23
|
+
* This allows reprocessing data from a specified point.
|
24
|
+
*
|
25
|
+
* @param value The value to set as the new start count
|
26
|
+
*/
|
27
|
+
setStartValue(value: number): void;
|
28
|
+
}
|
29
|
+
|
30
|
+
export { RestAPIConsumer };
|