@unchainedshop/events 4.8.29 → 5.0.0-alpha.10

package/README.md

@@ -14,7 +14,15 @@ npm install @unchainedshop/events
 ## Usage
 
 ```typescript
-import { emit, subscribe, registerEvents } from '@unchainedshop/events';
+import { EventEmitter } from 'node:events';
+import { emit, subscribe, registerEvents, setEmitAdapter } from '@unchainedshop/events';
+
+// Configure a backend before subscribing (platform presets do this for you)
+const emitter = new EventEmitter();
+setEmitAdapter({
+  publish: (eventName, data) => { emitter.emit(eventName, data); },
+  subscribe: (eventName, callback) => { emitter.on(eventName, callback); },
+});
 
 // Register custom events
 registerEvents(['ORDER_CREATED', 'ORDER_PAID']);
@@ -53,7 +61,7 @@ await emit('ORDER_CREATED', { orderId: '123', total: 99.99 });
 | Export | Description |
 |--------|-------------|
 | `EmitAdapter` | Interface for custom emit adapters |
-| `RawPayloadType` | Type for event payload data |
+| `RawPayloadType<T>` | Event wrapper containing a `payload` of type `T` |
 
 ### Built-in Events
 

package/lib/EventDirector.d.ts

@@ -4,6 +4,7 @@ export interface RawPayloadType<T> {
 export interface EmitAdapter {
     publish(eventName: string, data: RawPayloadType<Record<string, any>>): void;
     subscribe(eventName: string, callback: (payload: RawPayloadType<Record<string, any>>) => void): void;
+    shutdown?(): Promise<void> | void;
 }
 export declare const EventDirector: {
     registerEvents: (events: string[]) => void;

package/lib/audit/audit-integration.d.ts

@@ -1,3 +1,3 @@
 import type { AuditLog } from './index.ts';
 export declare function configureAuditIntegration(auditLog: AuditLog): void;
-export declare const AUDITED_EVENTS: readonly ["API_LOGIN_TOKEN_CREATED", "API_LOGOUT", "USER_CREATE", "USER_REMOVE", "USER_UPDATE_PASSWORD", "USER_ADD_ROLES", "USER_UPDATE_ROLE", "USER_ACCOUNT_ACTION", "ORDER_CREATE", "ORDER_CHECKOUT", "ORDER_CONFIRMED", "ORDER_FULFILLED", "ORDER_REJECTED", "ORDER_ADD_PRODUCT", "ORDER_REMOVE_CART_ITEM", "ORDER_PAY", "ORDER_UPDATE_PAYMENT"];
+export declare const AUDITED_EVENTS: readonly ["API_LOGIN_TOKEN_CREATED", "API_LOGIN_FAILED", "API_LOGOUT", "USER_CREATE", "USER_REMOVE", "USER_UPDATE_PASSWORD", "USER_ADD_ROLES", "USER_UPDATE_ROLE", "USER_ACCOUNT_ACTION", "ORDER_CREATE", "ORDER_CHECKOUT", "ORDER_CONFIRMED", "ORDER_FULFILLED", "ORDER_REJECTED", "ORDER_ADD_PRODUCT", "ORDER_REMOVE_CART_ITEM", "ORDER_PAY", "ORDER_UPDATE_PAYMENT", "ORDER_DELIVER", "ORDER_REMOVE", "ORDER_EMPTY_CART", "ORDER_SET_PAYMENT_PROVIDER", "ORDER_SET_DELIVERY_PROVIDER", "ACL_DENIED", "ACL_GRANTED_SENSITIVE", "PRODUCT_CREATE", "PRODUCT_UPDATE", "PRODUCT_REMOVE", "PRODUCT_PUBLISH", "PRODUCT_UNPUBLISH", "PRODUCT_UPDATE_TEXT", "PRODUCT_UPDATE_MEDIA_TEXT", "PRODUCT_ADD_MEDIA", "PRODUCT_REMOVE_MEDIA", "PRODUCT_REORDER_MEDIA", "PRODUCT_ADD_ASSIGNMENT", "PRODUCT_REMOVE_ASSIGNMENT", "PRODUCT_CREATE_BUNDLE_ITEM", "PRODUCT_REMOVE_BUNDLE_ITEM", "PRODUCT_CREATE_VARIATION", "PRODUCT_REMOVE_VARIATION", "PRODUCT_VARIATION_OPTION_CREATE", "PRODUCT_REMOVE_VARIATION_OPTION", "PRODUCT_UPDATE_VARIATION_TEXT", "PRODUCT_REVIEW_CREATE", "PRODUCT_UPDATE_REVIEW", "PRODUCT_REMOVE_REVIEW", "PRODUCT_REVIEW_ADD_VOTE", "PRODUCT_REMOVE_REVIEW_VOTE", "ASSORTMENT_UPDATE_TEXT", "ASSORTMENT_UPDATE_MEDIA_TEXT", "ASSORTMENT_ADD_PRODUCT", "ASSORTMENT_REMOVE_PRODUCT", "ASSORTMENT_ADD_LINK", "ASSORTMENT_REMOVE_LINK", "ASSORTMENT_ADD_FILTER", "ASSORTMENT_REMOVE_FILTER", "ASSORTMENT_ADD_MEDIA", "ASSORTMENT_REMOVE_MEDIA", "ASSORTMENT_REORDER_PRODUCTS", "ASSORTMENT_REORDER_LINKS", "ASSORTMENT_REORDER_FILTERS", "ASSORTMENT_REORDER_MEDIA", "FILTER_UPDATE_TEXT", "PAYMENT_PROVIDER_CREATE", "PAYMENT_PROVIDER_UPDATE", "PAYMENT_PROVIDER_REMOVE", "DELIVERY_PROVIDER_CREATE", "DELIVERY_PROVIDER_UPDATE", "DELIVERY_PROVIDER_REMOVE", "WAREHOUSING_PROVIDER_CREATE", "WAREHOUSING_PROVIDER_UPDATE", "WAREHOUSING_PROVIDER_REMOVE", "TOKEN_OWNERSHIP_CHANGED", "TOKEN_INVALIDATED", "ENROLLMENT_CREATE", "ENROLLMENT_UPDATE", "ENROLLMENT_REMOVE", "QUOTATION_REQUEST_CREATE", "QUOTATION_UPDATE", "ASSORTMENT_CREATE", "ASSORTMENT_UPDATE", "ASSORTMENT_REMOVE", "FILTER_CREATE", "FILTER_UPDATE", "FILTER_REMOVE", "FILE_CREATE", "FILE_REMOVE", "COUNTRY_CREATE", "COUNTRY_UPDATE", "COUNTRY_REMOVE", "CURRENCY_CREATE", "CURRENCY_UPDATE", "CURRENCY_REMOVE", "LANGUAGE_CREATE", "LANGUAGE_UPDATE", "LANGUAGE_REMOVE"];