@polygonlabs/servercore 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 PT Services DMCC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,15 +1,115 @@
-# servercore
+# @polygonlabs/servercore
 
-To install dependencies:
+Core server framework for building scalable TypeScript applications with built-in logging, error handling, API utilities, and event processing.
+
+## Features
+
+- **API Framework**: Health checks, response handlers, and Zod validation utilities
+- **Event Consumers**: Abstract base classes for REST API and cron job consumers
+- **Error Handling**: Comprehensive error system with custom error types
+- **Logging**: Winston-based logging with Sentry integration
+- **Storage Interfaces**: Abstract interfaces for databases and queues
+- **Utilities**: ULID generation, data decoders, and type utilities
+
+## Installation
 
 ```bash
-bun install
+npm install @polygonlabs/servercore
+# or
+bun add @polygonlabs/servercore
+```
+
+## Usage
+
+### API Framework
+
+```typescript
+import { healthCheck, handleResponse } from '@polygonlabs/servercore/api';
+import { validateInput } from '@polygonlabs/servercore/api';
+import { z } from 'zod';
+
+// Health check endpoint
+const health = healthCheck();
+
+// Response handling
+const response = handleResponse(data, 200);
+
+// Input validation
+const schema = z.object({ name: z.string() });
+const validatedData = validateInput(schema, input);
+```
+
+### Event Consumers
+
+```typescript
+import { RestApiConsumer, CronEventConsumer } from '@polygonlabs/servercore/consumers';
+
+class MyApiConsumer extends RestApiConsumer {
+  async processEvent(event: any) {
+    // Process API event
+  }
+}
+
+class MyCronConsumer extends CronEventConsumer {
+  async processEvent() {
+    // Process scheduled event
+  }
+}
 ```
 
-To run:
+### Logging
+
+```typescript
+import { createLogger } from '@polygonlabs/servercore/logger';
+
+const logger = createLogger({
+  level: 'info',
+  service: 'my-service'
+});
+
+logger.info('Application started');
+logger.error('Something went wrong', { error });
+```
+
+### Error Handling
+
+```typescript
+import { 
+  ApiError, 
+  DatabaseError, 
+  ExternalDependencyError 
+} from '@polygonlabs/servercore/errors';
+
+// Throw specific errors
+throw new ApiError('Invalid request', 'INVALID_REQUEST');
+throw new DatabaseError('Connection failed');
+throw new ExternalDependencyError('Service unavailable');
+```
+
+## Development
 
 ```bash
-bun run index.ts
+# Install dependencies
+bun install
+
+# Build the package
+bun run build
+
+# Run type checking
+bun run typecheck
+
+# Run tests
+bun run tests
 ```
 
-This project was created using `bun init` in bun v1.2.4. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+## Dependencies
+
+- **croner**: Cron job scheduling
+- **ulid**: Unique identifier generation  
+- **viem**: Ethereum utilities
+- **winston**: Logging framework
+- **zod**: Schema validation
+
+## License
+
+MIT

package/dist/api/health-check.d.ts

@@ -0,0 +1,8 @@
+declare class HealthCheck {
+    private readonly urls;
+    constructor(urls: string[]);
+    checkHealth(): Promise<string>;
+}
+declare function setupHealthCheckServer(urls: string[], serverPort: number): void;
+
+export { HealthCheck, setupHealthCheckServer };

package/dist/api/health-check.js

@@ -0,0 +1,85 @@
+import { handleResponse, handleError } from "./response_handler";
+import { ApiError } from "../errors";
+class HealthCheck {
+  constructor(urls) {
+    this.urls = urls;
+  }
+  async checkHealth() {
+    try {
+      const results = await Promise.all(
+        this.urls.map(async (url) => {
+          const response = await fetch(`${url}`);
+          if (!response.ok) {
+            throw new Error(`Health check failed for ${url}`);
+          }
+          return response;
+        })
+      );
+      if (results.every((res) => res.ok)) {
+        return "ok";
+      }
+      throw new Error("One or more URLs failed the health check.");
+    } catch (error) {
+      const failedUrlChecks = await Promise.all(
+        this.urls.map(async (url) => {
+          try {
+            const response = await fetch(`${url}`);
+            return { url, failed: !response.ok };
+          } catch {
+            return { url, failed: true };
+          }
+        })
+      );
+      const failedUrls = failedUrlChecks.filter((check) => check.failed).map((check) => check.url);
+      throw new ApiError(
+        `Health check failed for the following URLs: ${failedUrls.join(
+          ", "
+        )}. Original error: ${error.message}`
+      );
+    }
+  }
+}
+function createResponseContext(c) {
+  c.status = c.status || 200;
+  return {
+    status: (statusCode) => {
+      c.status = statusCode;
+      return createResponseContext(c);
+    },
+    json: (body) => {
+      return new Response(JSON.stringify(body), {
+        status: c.status,
+        headers: { "Content-Type": "application/json" }
+      });
+    }
+  };
+}
+function setupHealthCheckServer(urls, serverPort) {
+  const healthCheck = new HealthCheck(urls);
+  Bun.serve({
+    port: serverPort,
+    routes: {
+      "/health-check": {
+        GET: async (c) => {
+          try {
+            await healthCheck.checkHealth();
+            return handleResponse(createResponseContext(c), "ok");
+          } catch (error) {
+            return handleError(
+              createResponseContext(c),
+              error
+            );
+          }
+        }
+      }
+    }
+  });
+  console.log(
+    `Health check server running on http://localhost:${serverPort}/health-check`
+  );
+}
+export {
+  HealthCheck,
+  setupHealthCheckServer
+};
+//# sourceMappingURL=health-check.js.map

package/dist/api/health-check.js.map

@@ -0,0 +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

@@ -1,5 +1,6 @@
 export { handleError, handleResponse } from './response_handler.js';
 export { validateBody, validateParams, validateQuery } from './zod_utils.js';
+export { HealthCheck, setupHealthCheckServer } from './health-check.js';
 import '../errors/api_errors.js';
 import '../errors/base_error.js';
 import '../errors/database_errors.js';

package/dist/api/index.js

@@ -1,3 +1,4 @@
 export * from "./response_handler";
 export * from "./zod_utils";
+export * from "./health-check";
 //# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -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":[]}
+{"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":[]}

package/dist/api/response_handler.d.ts

@@ -4,7 +4,12 @@ import { ExternalDependencyError } from '../errors/external_dependency_error.js'
 import { ResponseContext } from '../types/response_context.js';
 import '../errors/base_error.js';
 
-declare const handleResponse: (c: ResponseContext, data: any) => any;
+declare const handleResponse: (c: ResponseContext, data: any, pagination?: {
+    total: number;
+    limit: number;
+    offset?: number;
+    nextStartAfterCursor?: string | number;
+}) => any;
 declare const handleError: (c: ResponseContext, error: ApiError | ExternalDependencyError | DatabaseError) => any;
 
 export { handleError, handleResponse };

package/dist/api/response_handler.js

@@ -1,9 +1,10 @@
 import { ApiError, DatabaseError, ExternalDependencyError } from "../errors";
-import { httpResposneCodes, errorCodes } from "../constants";
-const handleResponse = (c, data) => {
-  return c.status(httpResposneCodes.OK_RESPONSE).json({
+import { httpResponseCodes, errorCodes } from "../constants";
+const handleResponse = (c, data, pagination) => {
+  return c.status(httpResponseCodes.OK_RESPONSE).json({
     status: "success",
-    data
+    data,
+    pagination
   });
 };
 const handleError = (c, error) => {

package/dist/api/response_handler.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/api/response_handler.ts"],"sourcesContent":["import { ApiError, DatabaseError, ExternalDependencyError } from \"../errors\"; // Define your error types\nimport { httpResposneCodes, errorCodes } from \"../constants\"; // Define your success codes\nimport type { ResponseContext } from \"../types\";\n\nexport const handleResponse = (c: ResponseContext, data: any) => {\n    // This method returns a success response with the status and data.\n    return c\n        .status(httpResposneCodes.OK_RESPONSE) // Use success code from httpResposneCodes\n        .json({\n            status: \"success\",\n            data: data,\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,CAAC,GAAoB,SAAc;AAE7D,SAAO,EACF,OAAO,kBAAkB,WAAW,EACpC,KAAK;AAAA,IACF,QAAQ;AAAA,IACR;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":[]}
+{"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":[]}

package/dist/constants/http_success_codes.d.ts

@@ -1,5 +1,5 @@
-declare const httpResposneCodes: {
+declare const httpResponseCodes: {
     OK_RESPONSE: number;
 };
 
-export { httpResposneCodes };
+export { httpResponseCodes };

package/dist/constants/http_success_codes.js

@@ -1,7 +1,7 @@
-const httpResposneCodes = {
+const httpResponseCodes = {
   OK_RESPONSE: 200
 };
 export {
-  httpResposneCodes
+  httpResponseCodes
 };
 //# sourceMappingURL=http_success_codes.js.map

package/dist/constants/http_success_codes.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/constants/http_success_codes.ts"],"sourcesContent":["export const httpResposneCodes = {\n    OK_RESPONSE: 200,\n};\n"],"mappings":"AAAO,MAAM,oBAAoB;AAAA,EAC7B,aAAa;AACjB;","names":[]}
+{"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":[]}

package/dist/constants/index.d.ts

@@ -1,2 +1,2 @@
 export { errorCodes } from './error_codes.js';
-export { httpResposneCodes } from './http_success_codes.js';
+export { httpResponseCodes } from './http_success_codes.js';

package/dist/consumers/abstract_cron_event_consumer.d.ts

@@ -0,0 +1,23 @@
+import { AbstractEventConsumer } from './abstract_event_consumer.js';
+import '../errors/consumer_errors.js';
+import '../errors/base_error.js';
+import 'events';
+
+declare abstract class AbstractCronEventConsumer extends AbstractEventConsumer {
+    private cronJob;
+    /**
+     * Start the cron job with the given cron expression.
+     * @param cronExpr Cron expression string
+     */
+    startCron(cronExpr: string): void;
+    /**
+     * Stop the cron job.
+     */
+    stopCron(): void;
+    /**
+     * Implement this in subclasses to define what happens on each cron tick.
+     */
+    protected abstract onTick(): Promise<void>;
+}
+
+export { AbstractCronEventConsumer };

package/dist/consumers/abstract_cron_event_consumer.js

@@ -0,0 +1,30 @@
+import { Cron } from "croner";
+import { AbstractEventConsumer } from "./abstract_event_consumer";
+class AbstractCronEventConsumer extends AbstractEventConsumer {
+  cronJob = null;
+  /**
+   * Start the cron job with the given cron expression.
+   * @param cronExpr Cron expression string
+   */
+  startCron(cronExpr) {
+    if (this.cronJob) {
+      this.cronJob.stop();
+    }
+    this.cronJob = new Cron(cronExpr, { protect: true }, async () => {
+      await this.onTick();
+    });
+  }
+  /**
+   * Stop the cron job.
+   */
+  stopCron() {
+    if (this.cronJob) {
+      this.cronJob.stop();
+      this.cronJob = null;
+    }
+  }
+}
+export {
+  AbstractCronEventConsumer
+};
+//# sourceMappingURL=abstract_cron_event_consumer.js.map

package/dist/consumers/abstract_cron_event_consumer.js.map

@@ -0,0 +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":[]}

package/dist/consumers/event_consumer.d.ts

@@ -7,7 +7,7 @@ import '../errors/base_error.js';
 import 'events';
 
 declare class EventConsumer<T, U> extends AbstractEventConsumer {
-    private config;
+    private readonly config;
     protected client: PublicClient | null;
     protected observer: IObserver<T, ConsumerError, U> | null;
     isBackfillingInProcess: boolean;

package/dist/consumers/event_consumer.js

@@ -40,9 +40,9 @@ class EventConsumer extends AbstractEventConsumer {
         toBlock: end
       };
       if (this.config.events.length > 1) {
-        getLogsConfig.event = this.config.events[0];
-      } else {
         getLogsConfig.events = this.config.events;
+      } else {
+        getLogsConfig.event = this.config.events[0];
       }
       const logs = await this.client?.getLogs(getLogsConfig);
       Logger.debug({

package/dist/consumers/event_consumer.js.map

@@ -1 +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 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.event = this.config.events[0];\n            } else {\n                getLogsConfig.events = this.config.events;\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,YAAoB,QAA8B;AAC9C,UAAM;AADU;AAEhB,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,QAAQ,KAAK,OAAO,OAAO,CAAC;AAAA,MAC9C,OAAO;AACH,sBAAc,SAAS,KAAK,OAAO;AAAA,MACvC;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":[]}
+{"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":[]}

package/dist/consumers/index.d.ts

@@ -1,4 +1,6 @@
 export { EventConsumer } from './event_consumer.js';
+export { RestAPIConsumer } from './rest_api_consumer.js';
+export { AbstractCronEventConsumer } from './abstract_cron_event_consumer.js';
 import 'viem';
 import '../errors/consumer_errors.js';
 import '../errors/base_error.js';
@@ -6,3 +8,4 @@ import '../types/observer.js';
 import '../types/event_consumer_config.js';
 import './abstract_event_consumer.js';
 import 'events';
+import '../types/rest_api_consumer_config.js';

package/dist/consumers/index.js

@@ -1,2 +1,4 @@
 export * from "./event_consumer";
+export * from "./rest_api_consumer";
+export * from "./abstract_cron_event_consumer";
 //# sourceMappingURL=index.js.map

package/dist/consumers/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/consumers/index.ts"],"sourcesContent":["export * from \"./event_consumer\";\n"],"mappings":"AAAA,cAAc;","names":[]}
+{"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":[]}

package/dist/consumers/rest_api_consumer.d.ts

@@ -0,0 +1,30 @@
+import { ConsumerError } from '../errors/consumer_errors.js';
+import { IObserver } from '../types/observer.js';
+import { IRestAPIConsumerConfig } from '../types/rest_api_consumer_config.js';
+import { AbstractCronEventConsumer } from './abstract_cron_event_consumer.js';
+import '../errors/base_error.js';
+import './abstract_event_consumer.js';
+import 'events';
+
+declare class RestAPIConsumer<T, U> extends AbstractCronEventConsumer {
+    private readonly config;
+    protected observer: IObserver<T, ConsumerError, U> | null;
+    private currentPage;
+    private highestValueSeen;
+    constructor(config: IRestAPIConsumerConfig);
+    start(observer: IObserver<T, ConsumerError, U>): Promise<void>;
+    stop(): void;
+    protected onTick(): Promise<void>;
+    private fetchPage;
+    private getValueByPath;
+    private processDataForCurrentCountValue;
+    /**
+     * Updates the start count value to a specific value.
+     * This allows reprocessing data from a specified point.
+     *
+     * @param value The value to set as the new start count
+     */
+    setStartValue(value: number): void;
+}
+
+export { RestAPIConsumer };

package/dist/consumers/rest_api_consumer.js

@@ -0,0 +1,131 @@
+import { errorCodes } from "../constants";
+import { ConsumerError } from "../errors";
+import { AbstractCronEventConsumer } from "./abstract_cron_event_consumer";
+class RestAPIConsumer extends AbstractCronEventConsumer {
+  constructor(config) {
+    super();
+    this.config = config;
+    this.highestValueSeen = this.config.startCount.value;
+  }
+  observer = null;
+  currentPage = 0;
+  highestValueSeen = 0;
+  async start(observer) {
+    this.observer = observer;
+    this.currentPage = 1;
+    if (this.config.cronExpr) {
+      this.startCron(this.config.cronExpr);
+    } else {
+      await this.onTick();
+    }
+  }
+  stop() {
+    this.stopCron();
+  }
+  async onTick() {
+    this.currentPage = 1;
+    let shouldFetchNextPage = true;
+    while (shouldFetchNextPage) {
+      shouldFetchNextPage = await this.fetchPage();
+    }
+    this.config.startCount.value = this.highestValueSeen;
+    this.observer?.summary({
+      [`${this.config.startCount.key}`]: this.config.startCount.value
+    });
+  }
+  async fetchPage() {
+    try {
+      const paginationParam = this.config.paginationParam || "page";
+      const params = {
+        ...this.config.params || {},
+        [paginationParam]: this.currentPage.toString()
+      };
+      let url = this.config.apiUrl.toString();
+      if (Object.keys(params).length > 0) {
+        const queryString = new URLSearchParams(params).toString();
+        url += (url.includes("?") ? "&" : "?") + queryString;
+      }
+      const response = await fetch(url, {
+        method: this.config.method || "GET",
+        headers: this.config.headers,
+        body: this.config.body ? JSON.stringify(this.config.body) : void 0
+      });
+      if (!response.ok) {
+        throw new ConsumerError(
+          `Failed to fetch from API: ${response.statusText}`,
+          {
+            code: errorCodes.external.UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,
+            isFatal: true,
+            origin: "rest_api_consumer"
+          }
+        );
+      }
+      let data = await response.json();
+      if (this.config.resultPath) {
+        data = this.getValueByPath(data, this.config.resultPath);
+      }
+      const countKey = this.config.startCount.key;
+      let currentValue = void 0;
+      if (Array.isArray(data)) {
+        if (data.length === 0) {
+          return false;
+        }
+        for (const elem of data) {
+          currentValue = this.processDataForCurrentCountValue(
+            elem,
+            countKey
+          );
+        }
+      } else {
+        currentValue = this.processDataForCurrentCountValue(
+          data,
+          countKey
+        );
+      }
+      this.observer?.next(data);
+      this.currentPage++;
+      if (currentValue === void 0) {
+        return false;
+      }
+      return currentValue >= this.config.startCount.value;
+    } catch (error) {
+      this.onFatalError(error);
+      return false;
+    }
+  }
+  // Utility to get nested values using dot notation (e.g., "response.data.count")
+  getValueByPath(obj, path) {
+    return path.split(".").reduce((prev, curr) => {
+      return prev && prev[curr] !== void 0 ? prev[curr] : void 0;
+    }, obj);
+  }
+  processDataForCurrentCountValue(item, countKey) {
+    const value = this.getValueByPath(item, countKey);
+    if (value === void 0) {
+      throw new ConsumerError(
+        `Count key '${countKey}' not found in API response`,
+        {
+          code: errorCodes.external.UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,
+          isFatal: false,
+          origin: "rest_api_consumer"
+        }
+      );
+    }
+    this.highestValueSeen = Math.max(this.highestValueSeen, value);
+    return value;
+  }
+  /**
+   * Updates the start count value to a specific value.
+   * This allows reprocessing data from a specified point.
+   *
+   * @param value The value to set as the new start count
+   */
+  setStartValue(value) {
+    this.config.startCount.value = value;
+    this.highestValueSeen = value;
+  }
+}
+export {
+  RestAPIConsumer
+};
+//# sourceMappingURL=rest_api_consumer.js.map

package/dist/consumers/rest_api_consumer.js.map

@@ -0,0 +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":[]}

package/dist/errors/api_errors.d.ts

@@ -20,7 +20,7 @@ declare class BadRequestError extends ApiError {
     constructor(message?: string, validationErrors?: Record<string, any>, context?: Record<string, any>, origin?: string);
 }
 declare class NotFoundError extends ApiError {
-    constructor(entity?: string, identifier?: string | number, context?: Record<string, any>, origin?: string);
+    constructor(message: string, entity?: string, identifier?: string | number, context?: Record<string, any>, origin?: string);
 }
 declare class RateLimitError extends ApiError {
     constructor(message?: string, context?: Record<string, any>, origin?: string);

package/dist/errors/api_errors.js

@@ -4,7 +4,7 @@ class ApiError extends BaseError {
   constructor(message, {
     name = "INTERNAL_SERVER_ERROR",
     code = errorCodes.api.INTERNAL_SERVER_ERROR,
-    isFatal = true,
+    isFatal = false,
     origin = "api_errors",
     context = {}
   } = {}) {
@@ -17,7 +17,7 @@ class UnauthorizedError extends ApiError {
     super(message, {
       name: "UNAUTHORIZED",
       code: errorCodes.api.UNAUTHORIZED,
-      isFatal: true,
+      isFatal: false,
       origin,
       context
     });
@@ -28,7 +28,7 @@ class ForbiddenError extends ApiError {
     super(message, {
       name: "FORBIDDEN",
       code: errorCodes.api.FORBIDDEN,
-      isFatal: true,
+      isFatal: false,
       origin,
       context
     });
@@ -40,7 +40,7 @@ class BadRequestError extends ApiError {
     super(message, {
       name: "BAD_REQUEST",
       code: errorCodes.api.BAD_REQUEST,
-      isFatal: true,
+      isFatal: false,
       origin,
       context
     });
@@ -48,12 +48,14 @@ class BadRequestError extends ApiError {
   }
 }
 class NotFoundError extends ApiError {
-  constructor(entity = "Path", identifier, context = {}, origin = "api_errors") {
-    const message = identifier ? `${entity} with identifier ${identifier} not found` : `${entity} not found`;
+  constructor(message, entity = "Path", identifier, context = {}, origin = "api_errors") {
+    if (!message) {
+      message = identifier ? `${entity} with identifier ${identifier} not found` : `${entity} not found`;
+    }
     super(message, {
       name: "NOT_FOUND",
       code: errorCodes.api.NOT_FOUND,
-      isFatal: true,
+      isFatal: false,
       origin,
       context: { entity, identifier, ...context }
     });
@@ -64,7 +66,7 @@ class RateLimitError extends ApiError {
     super(message, {
       name: "RATE_LIMIT",
       code: errorCodes.api.TOO_MANY_REQUESTS,
-      isFatal: true,
+      isFatal: false,
       origin,
       context
     });
@@ -76,7 +78,7 @@ class TimeoutError extends ApiError {
       name: "TIMEOUT",
       code: errorCodes.api.TIMEOUT_ERROR,
       // Gateway Timeout
-      isFatal: true,
+      isFatal: false,
       origin,
       context: { operation, timeoutMs, ...context }
     });

package/dist/errors/api_errors.js.map

@@ -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":[]}
+{"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":[]}

package/dist/index.d.ts

@@ -1,14 +1,16 @@
 export { handleError, handleResponse } from './api/response_handler.js';
 export { validateBody, validateParams, validateQuery } from './api/zod_utils.js';
+export { HealthCheck, setupHealthCheckServer } from './api/health-check.js';
 export { Logger } from './logger/logger.js';
 export { errorCodes } from './constants/error_codes.js';
-export { httpResposneCodes } from './constants/http_success_codes.js';
+export { httpResponseCodes } from './constants/http_success_codes.js';
 export { ILoggerConfig } from './types/logger_config.js';
-export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp } from './types/database.js';
+export { AddDocumentsParams, ConditionalUpdateDocumentsParams, GetCollectionGroupParams, GetDocumentParams, GetDocumentsParams, IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, IQueryOrderOperationParams, OrderByDirection, UpdateDocumentsParams, WhereFilterOp } from './types/database.js';
 export { IObserver } from './types/observer.js';
 export { ChainNativeCurrency, IEventConsumerConfig } from './types/event_consumer_config.js';
 export { ResponseContext } from './types/response_context.js';
 export { JobOpts } from './types/queue_job_opts.js';
+export { IRestAPIConsumerConfig } from './types/rest_api_consumer_config.js';
 export { ApiError, BadRequestError, ForbiddenError, NotFoundError, RateLimitError, TimeoutError, UnauthorizedError } from './errors/api_errors.js';
 export { DatabaseError } from './errors/database_errors.js';
 export { ExternalDependencyError } from './errors/external_dependency_error.js';
@@ -17,7 +19,10 @@ export { ConsumerError } from './errors/consumer_errors.js';
 export { Database } from './storage/db_interface.js';
 export { IQueue } from './storage/queue_interface.js';
 export { EventConsumer } from './consumers/event_consumer.js';
+export { RestAPIConsumer } from './consumers/rest_api_consumer.js';
+export { AbstractCronEventConsumer } from './consumers/abstract_cron_event_consumer.js';
 export { parseEventLog } from './utils/decoder.js';
+export { generateDeterministicULID } from './utils/ulid.js';
 import 'zod';
 import 'winston';
 import 'viem';

package/dist/logger/logger.js

@@ -12,25 +12,21 @@ class Logger {
    */
   static create(config) {
     if (!this.logger) {
-      this.logger = winston.createLogger(
-        Object.assign(
-          {
-            format: winston.format.json(),
-            transports: [
-              new winston.transports.Console({
-                level: config.console?.level || "info"
-              }),
-              new Sentry({
-                sentry: {
-                  dsn: config.sentry?.dsn
-                },
-                level: config.sentry?.level || "error"
-              })
-            ]
-          },
-          config.winston
-        )
-      );
+      this.logger = winston.createLogger({
+        format: winston.format.json(),
+        transports: [
+          new winston.transports.Console({
+            level: config.console?.level || "info"
+          }),
+          new Sentry({
+            sentry: {
+              dsn: config.sentry?.dsn
+            },
+            level: config.sentry?.level || "error"
+          })
+        ],
+        ...config.winston
+      });
     }
   }
   static ensureInitialized() {

package/dist/logger/logger.js.map

@@ -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\";\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                Object.assign(\n                    {\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                    },\n                    config.winston\n                )\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,QAClB,OAAO;AAAA,UACH;AAAA,YACI,QAAQ,QAAQ,OAAO,KAAK;AAAA,YAC5B,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,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":[]}
+{"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":[]}

package/dist/storage/db_interface.d.ts

@@ -1,14 +1,17 @@
-import { IQueryFilterOperationParams, IDocumentConditionalModifications, IQueryOrderOperationParams } from '../types/database.js';
+import { AddDocumentsParams, UpdateDocumentsParams, ConditionalUpdateDocumentsParams, GetDocumentsParams, GetDocumentParams, GetCollectionGroupParams } from '../types/database.js';
 
 interface Database {
     connect(): Promise<void>;
     disconnect(): Promise<void>;
-    addDocuments(collectionPaths: string[], docDatas: any[], docIds?: string[]): Promise<void>;
-    updateDocuments(collectionPaths: string[], docDatas: any[], docIds: string[]): Promise<void>;
-    conditionalUpdateDocuments(collectionPaths: string[], docDatas: any[], docIds: string[], conditions: IQueryFilterOperationParams[], conditionModifications: IDocumentConditionalModifications[]): Promise<void>;
-    getDocuments(collectionPath: string, filter?: IQueryFilterOperationParams[] | undefined, limit?: number | undefined, order?: IQueryOrderOperationParams[] | undefined, startAfterCursor?: string | number | undefined): Promise<any[]>;
-    getDocument(collectionId: string, docId: string): Promise<any | null>;
-    getCollectionGroup(groupId: string, filter?: IQueryFilterOperationParams[]): Promise<any | null>;
+    addDocuments(params: AddDocumentsParams): Promise<void>;
+    updateDocuments(params: UpdateDocumentsParams): Promise<void>;
+    conditionalUpdateDocuments(params: ConditionalUpdateDocumentsParams): Promise<void>;
+    getDocuments(params: GetDocumentsParams): Promise<{
+        documents: any[];
+        totalDocumentsCount?: number;
+    }>;
+    getDocument(params: GetDocumentParams): Promise<any | null>;
+    getCollectionGroup(params: GetCollectionGroupParams): Promise<any | null>;
 }
 
 export type { Database };

package/dist/types/database.d.ts

@@ -1,5 +1,10 @@
 type WhereFilterOp = "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
 type OrderByDirection = "desc" | "asc";
+interface IQueryFilterOperationParams {
+    field: string;
+    operator: WhereFilterOp;
+    value: string | number | boolean | string[] | number[];
+}
 interface IQueryOrderOperationParams {
     field: string;
     order: OrderByDirection;
@@ -9,15 +14,45 @@ interface IDocumentConditionalModifications {
     value: string | number | boolean;
     defaultValue: string | number | boolean;
 }
-interface IQueryFilterOperationParams {
-    field: string;
-    operator: WhereFilterOp;
-    value: string | number | boolean | string[] | number[];
+interface IQueryOrFilterParams {
+    or: IQueryFilterOperationParams[];
 }
-interface IQueryFilterOperationParams {
-    field: string;
-    operator: WhereFilterOp;
-    value: string | number | boolean | string[] | number[];
+interface AddDocumentsParams {
+    collectionPaths: string[] | string;
+    docDatas: any[];
+    docIds?: string[];
+}
+interface UpdateDocumentsParams {
+    collectionPaths: string[] | string;
+    docDatas: any[];
+    docIds: string[];
+}
+interface ConditionalUpdateDocumentsParams {
+    collectionPaths: string[] | string;
+    docDatas: any[];
+    docIds: string[];
+    conditions: IQueryFilterOperationParams[];
+    conditionModifications: IDocumentConditionalModifications[];
+}
+interface GetDocumentsParams {
+    collectionPath: string;
+    filter?: IQueryFilterOperationParams[];
+    limit?: number;
+    order?: IQueryOrderOperationParams[];
+    startAfterCursor?: string | number;
+    selectFields?: string[];
+    orFilters?: IQueryOrFilterParams[];
+    offset?: number;
+    returnTotalDocumentsCount?: boolean;
+}
+interface GetDocumentParams {
+    collectionId: string;
+    docId: string;
+}
+interface GetCollectionGroupParams {
+    groupId: string;
+    filter?: IQueryFilterOperationParams[];
+    orFilters?: IQueryOrFilterParams[];
 }
 
-export type { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp };
+export type { AddDocumentsParams, ConditionalUpdateDocumentsParams, GetCollectionGroupParams, GetDocumentParams, GetDocumentsParams, IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, IQueryOrderOperationParams, OrderByDirection, UpdateDocumentsParams, WhereFilterOp };

package/dist/types/index.d.ts

@@ -1,8 +1,9 @@
 export { ILoggerConfig } from './logger_config.js';
-export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp } from './database.js';
+export { AddDocumentsParams, ConditionalUpdateDocumentsParams, GetCollectionGroupParams, GetDocumentParams, GetDocumentsParams, IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, IQueryOrderOperationParams, OrderByDirection, UpdateDocumentsParams, WhereFilterOp } from './database.js';
 export { IObserver } from './observer.js';
 export { ChainNativeCurrency, IEventConsumerConfig } from './event_consumer_config.js';
 export { ResponseContext } from './response_context.js';
 export { JobOpts } from './queue_job_opts.js';
+export { IRestAPIConsumerConfig } from './rest_api_consumer_config.js';
 import 'winston';
 import 'viem';

package/dist/types/index.js

@@ -4,4 +4,5 @@ export * from "./observer";
 export * from "./event_consumer_config";
 export * from "./response_context";
 export * from "./queue_job_opts";
+export * from "./rest_api_consumer_config";
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -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\";\nexport * from \"./response_context\";\nexport * from \"./queue_job_opts\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
+{"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":[]}

package/dist/types/rest_api_consumer_config.d.ts

@@ -0,0 +1,17 @@
+interface IRestAPIConsumerConfig {
+    apiUrl: URL;
+    startCount: {
+        key: string;
+        value: number;
+    };
+    cronExpr?: string;
+    pollSize?: number;
+    body?: Record<string, any>;
+    headers?: Record<string, string>;
+    method?: "GET" | "POST";
+    params?: Record<string, string>;
+    paginationParam?: string;
+    resultPath?: string;
+}
+
+export type { IRestAPIConsumerConfig };

package/dist/types/rest_api_consumer_config.js

@@ -0,0 +1 @@
+//# sourceMappingURL=rest_api_consumer_config.js.map

package/dist/types/rest_api_consumer_config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/utils/index.d.ts

@@ -1 +1,2 @@
 export { parseEventLog } from './decoder.js';
+export { generateDeterministicULID } from './ulid.js';

package/dist/utils/index.js

@@ -1,2 +1,3 @@
 export * from "./decoder";
+export * from "./ulid";
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/index.ts"],"sourcesContent":["export * from \"./decoder\";\n"],"mappings":"AAAA,cAAc;","names":[]}
+{"version":3,"sources":["../../src/utils/index.ts"],"sourcesContent":["export * from \"./decoder\";\nexport * from \"./ulid\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}

package/dist/utils/ulid.d.ts

@@ -0,0 +1,3 @@
+declare function generateDeterministicULID(dataToEncode: string[], timeSeed?: number, separator?: string): string;
+
+export { generateDeterministicULID };

package/dist/utils/ulid.js

@@ -0,0 +1,24 @@
+import { monotonicFactory, ulid } from "ulid";
+function deterministicPRNG(seed) {
+  let t = seed;
+  return () => {
+    t += 1831565813;
+    t = Math.imul(t ^ t >>> 15, t | 1);
+    t ^= t + Math.imul(t ^ t >>> 7, t | 61);
+    return ((t ^ t >>> 14) >>> 0) / 4294967296;
+  };
+}
+function generateDeterministicULID(dataToEncode, timeSeed, separator) {
+  if (!Array.isArray(dataToEncode) || !dataToEncode.every((item) => typeof item === "string")) {
+    throw new Error("dataToEncode must be an array of strings");
+  }
+  const monotonicULID = monotonicFactory();
+  const timestampPart = timeSeed ? ulid(timeSeed, deterministicPRNG(timeSeed)) : monotonicULID();
+  return [timestampPart, ...dataToEncode.filter(Boolean)].join(
+    separator || "-"
+  );
+}
+export {
+  generateDeterministicULID
+};
+//# sourceMappingURL=ulid.js.map

package/dist/utils/ulid.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/ulid.ts"],"sourcesContent":["import { monotonicFactory, ulid } from \"ulid\";\n\nfunction deterministicPRNG(seed: number): () => number {\n    let t = seed;\n    return () => {\n        t += 0x6d2b79f5; // Increment the seed with a large prime\n        t = Math.imul(t ^ (t >>> 15), t | 1); // XOR and multiply\n        t ^= t + Math.imul(t ^ (t >>> 7), t | 61); // More XOR and shifts\n        return ((t ^ (t >>> 14)) >>> 0) / 4294967296; // Normalize to [0, 1]\n    };\n}\n\nexport function generateDeterministicULID(\n    dataToEncode: string[],\n    timeSeed?: number,\n    separator?: string\n): string {\n    if (\n        !Array.isArray(dataToEncode) ||\n        !dataToEncode.every((item) => typeof item === \"string\")\n    ) {\n        throw new Error(\"dataToEncode must be an array of strings\");\n    }\n    const monotonicULID = monotonicFactory();\n    const timestampPart = timeSeed\n        ? ulid(timeSeed, deterministicPRNG(timeSeed))\n        : monotonicULID();\n    return [timestampPart, ...dataToEncode.filter(Boolean)].join(\n        separator || \"-\"\n    );\n}\n"],"mappings":"AAAA,SAAS,kBAAkB,YAAY;AAEvC,SAAS,kBAAkB,MAA4B;AACnD,MAAI,IAAI;AACR,SAAO,MAAM;AACT,SAAK;AACL,QAAI,KAAK,KAAK,IAAK,MAAM,IAAK,IAAI,CAAC;AACnC,SAAK,IAAI,KAAK,KAAK,IAAK,MAAM,GAAI,IAAI,EAAE;AACxC,aAAS,IAAK,MAAM,QAAS,KAAK;AAAA,EACtC;AACJ;AAEO,SAAS,0BACZ,cACA,UACA,WACM;AACN,MACI,CAAC,MAAM,QAAQ,YAAY,KAC3B,CAAC,aAAa,MAAM,CAAC,SAAS,OAAO,SAAS,QAAQ,GACxD;AACE,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC9D;AACA,QAAM,gBAAgB,iBAAiB;AACvC,QAAM,gBAAgB,WAChB,KAAK,UAAU,kBAAkB,QAAQ,CAAC,IAC1C,cAAc;AACpB,SAAO,CAAC,eAAe,GAAG,aAAa,OAAO,OAAO,CAAC,EAAE;AAAA,IACpD,aAAa;AAAA,EACjB;AACJ;","names":[]}

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "@polygonlabs/servercore",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "publishConfig": {
         "access": "public"
     },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
+    "license": "MIT",
     "exports": {
         ".": {
             "import": "./dist/index.js",
@@ -13,9 +14,11 @@
         }
     },
     "scripts": {
-        "tests": "echo 'Hello unit tests'",
-        "tests:integration": "echo 'Hello integration tests'",
-        "build": "tsup"
+        "test": "bun test tests/",
+        "tests": "bun test tests/",
+        "tests:integration": "bun test tests/ --testNamePattern='integration'",
+        "build": "tsup",
+        "typecheck": "tsc --noEmit"
     },
     "files": [
         "./dist/**",
@@ -23,23 +26,20 @@
         "LICENSE"
     ],
     "type": "module",
-    "devDependencies": {
-        "@semantic-release/changelog": "^6.0.3",
-        "@semantic-release/commit-analyzer": "^13.0.1",
-        "@semantic-release/git": "^10.0.1",
-        "@semantic-release/npm": "^12.0.1",
-        "@semantic-release/release-notes-generator": "^14.0.3",
-        "@types/bun": "latest",
-        "semantic-release": "^24.2.3",
-        "tsup": "^8.4.0"
-    },
     "peerDependencies": {
         "typescript": "^5"
     },
     "dependencies": {
+        "croner": "^9.0.0",
+        "ulid": "^3.0.1",
         "viem": "^2.26.3",
         "winston": "^3.17.0",
         "winston-transport-sentry-node": "^3.0.0",
         "zod": "^3.24.2"
-    }
+    },
+    "devDependencies": {
+        "@types/bun": "latest",
+        "bun-types": "latest"
+    },
+    "gitHead": "608300167f4bb72b72e75fea2fb92c25b3ca52fc"
 }