@polygonlabs/servercore 1.0.0-dev.42 → 1.0.0-dev.44

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/index.d.ts

@@ -5,7 +5,7 @@ export { Logger } from './logger/logger.js';
 export { errorCodes } from './constants/error_codes.js';
 export { httpResposneCodes } from './constants/http_success_codes.js';
 export { ILoggerConfig } from './types/logger_config.js';
-export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, 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';

package/dist/storage/db_interface.d.ts

@@ -1,14 +1,14 @@
-import { IQueryFilterOperationParams, IDocumentConditionalModifications, IQueryOrderOperationParams, IQueryOrFilterParams } 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[] | string, docDatas: any[], docIds?: string[]): Promise<void>;
-    updateDocuments(collectionPaths: string[] | string, docDatas: any[], docIds: string[]): Promise<void>;
-    conditionalUpdateDocuments(collectionPaths: string[] | 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, selectFields?: string[], orFilters?: IQueryOrFilterParams[]): Promise<any[]>;
-    getDocument(collectionId: string, docId: string): Promise<any | null>;
-    getCollectionGroup(groupId: string, filter?: IQueryFilterOperationParams[], orFilters?: IQueryOrFilterParams[]): Promise<any | null>;
+    addDocuments(params: AddDocumentsParams): Promise<void>;
+    updateDocuments(params: UpdateDocumentsParams): Promise<void>;
+    conditionalUpdateDocuments(params: ConditionalUpdateDocumentsParams): Promise<void>;
+    getDocuments(params: GetDocumentsParams): Promise<any[]>;
+    getDocument(params: GetDocumentParams): Promise<any | null>;
+    getCollectionGroup(params: GetCollectionGroupParams): Promise<any | null>;
 }
 
 export type { Database };

package/dist/types/database.d.ts

@@ -17,5 +17,41 @@ interface IDocumentConditionalModifications {
 interface IQueryOrFilterParams {
     or: IQueryFilterOperationParams[];
 }
+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;
+}
+interface GetDocumentParams {
+    collectionId: string;
+    docId: string;
+}
+interface GetCollectionGroupParams {
+    groupId: string;
+    filter?: IQueryFilterOperationParams[];
+    orFilters?: IQueryOrFilterParams[];
+}
 
-export type { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp };
+export type { AddDocumentsParams, ConditionalUpdateDocumentsParams, GetCollectionGroupParams, GetDocumentParams, GetDocumentsParams, IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, IQueryOrderOperationParams, OrderByDirection, UpdateDocumentsParams, WhereFilterOp };

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export { ILoggerConfig } from './logger_config.js';
-export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrFilterParams, 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';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@polygonlabs/servercore",
-    "version": "1.0.0-dev.42",
+    "version": "1.0.0-dev.44",
     "publishConfig": {
         "access": "public"
     },
@@ -16,7 +16,8 @@
     "scripts": {
         "tests": "echo 'Hello unit tests'",
         "tests:integration": "echo 'Hello integration tests'",
-        "build": "tsup"
+        "build": "tsup",
+        "typecheck": "tsc --noEmit"
     },
     "files": [
         "./dist/**",
@@ -35,5 +36,5 @@
         "winston-transport-sentry-node": "^3.0.0",
         "zod": "^3.24.2"
     },
-    "gitHead": "f1973a2b487ef400f2bd22a269a0b7efc45e8170"
+    "gitHead": "c446ec91faa1603fb2a326dea481dc60e1ac07d4"
 }