@unchainedshop/core-events 5.0.0-alpha.5 → 5.0.0-alpha.8

package/README.md

@@ -13,71 +13,21 @@ npm install @unchainedshop/core-events
 
 ## Usage
 
-```typescript
-import { configureEventsModule } from '@unchainedshop/core-events';
+The platform initializes this module as `platform.unchainedAPI.modules.events` and installs the database history adapter if none is already configured.
 
-const eventsModule = await configureEventsModule({ db });
+```typescript
+const { events } = platform.unchainedAPI.modules;
 
-// Find events by type
-const orderEvents = await eventsModule.findEvents({
-  types: ['ORDER_CREATE', 'ORDER_PAID'],
+const orderEvents = await events.findEvents({
+  types: ['ORDER_CREATE', 'ORDER_PAY'],
   limit: 100,
 });
-
-// Get event statistics
-const report = await eventsModule.getReport({
-  types: ['ORDER_CREATE'],
-  dateRange: { start: '2024-01-01', end: '2024-12-31' },
-});
+const report = await events.getReport({ types: ['ORDER_CREATE'] });
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureEventsModule` | Configure and return the events module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findEvent` | Find a single event by ID or filter |
-| `findEvents` | Find events with filtering, sorting, and pagination |
-| `count` | Count events matching query |
-| `getReport` | Get aggregated event statistics by type and date |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new event record |
-
-### Helper Methods
-
-| Method | Description |
-|--------|-------------|
-| `type` | Get event type, returns 'UNKNOWN' for unregistered types |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Event` | Event document type |
-| `EventQuery` | Query parameters type |
-| `EventReport` | Report output type |
-| `EventsModule` | Module interface type |
-
-## Event History
-
-This module automatically integrates with `@unchainedshop/events` to persist all emitted events to the database. Events are stored with:
-
-- Event type
-- Payload data
-- Timestamp
+Records contain the event type, payload, and creation timestamp. The TTL index removes records after `EVENTS_TTL_SECONDS` (default: 172800 seconds, or two days). Configure long-term audit retention through your logging pipeline.
 
-This enables event sourcing patterns, audit trails, and analytics.
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/events), [public exports](src/events-index.ts), and [module implementation](src/module/configureEventsModule.ts).
 
 ## License
 

package/lib/module/configureEventsModule.js

@@ -67,7 +67,7 @@ export const configureEventsModule = async ({ db }) => {
                     conditions.push({ created: { $lte: toDate } });
                 }
                 if (conditions.length) {
-                    match.$or = conditions;
+                    match.$and = conditions;
                 }
             }
             if (types?.length) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unchainedshop/core-events",
   "description": "Event history and tracking module for the Unchained Engine",
-  "version": "5.0.0-alpha.5",
+  "version": "5.0.0-alpha.8",
   "main": "lib/events-index.js",
   "types": "lib/events-index.d.ts",
   "type": "module",
@@ -35,10 +35,10 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^5.0.0-alpha.5",
-    "@unchainedshop/logger": "^5.0.0-alpha.5",
-    "@unchainedshop/mongodb": "^5.0.0-alpha.5",
-    "@unchainedshop/utils": "^5.0.0-alpha.5"
+    "@unchainedshop/events": "^5.0.0-alpha.8",
+    "@unchainedshop/logger": "^5.0.0-alpha.8",
+    "@unchainedshop/mongodb": "^5.0.0-alpha.8",
+    "@unchainedshop/utils": "^5.0.0-alpha.8"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",