@orchestr-sh/orchestr 1.6.1 → 1.7.1

package/dist/Support/Testing/Fakes/EventFake.d.ts

@@ -0,0 +1,291 @@
+import type { DispatcherContract } from '../../../Events/Contracts/Dispatcher';
+import type { Container } from '../../../Container/Container';
+import type { Event } from '../../../Events/Event';
+import type { EventListener } from '../../../Events/types';
+/**
+ * Dispatched Event Record
+ *
+ * Represents a single event dispatch with metadata
+ */
+interface DispatchedEvent {
+    /** The event instance or event name */
+    event: Event | string;
+    /** Additional payload passed to the event */
+    payload: any[];
+    /** Timestamp when the event was dispatched */
+    timestamp: number;
+}
+/**
+ * Event Fake Dispatcher
+ *
+ * A test double for the event dispatcher that records all dispatched events
+ * instead of actually calling listeners. Provides assertion methods to verify
+ * event dispatching behavior in tests.
+ *
+ * @example
+ * ```typescript
+ * // Replace the real dispatcher with a fake
+ * const fake = new EventFake(app);
+ * app.instance('events', fake);
+ *
+ * // Test code that dispatches events
+ * dispatch(new UserRegistered(user));
+ *
+ * // Assert the event was dispatched
+ * fake.assertDispatched(UserRegistered);
+ * fake.assertDispatchedTimes(UserRegistered, 1);
+ * ```
+ */
+export declare class EventFake implements DispatcherContract {
+    protected container: Container;
+    /**
+     * All dispatched events organized by event name
+     */
+    protected dispatched: Map<string, DispatchedEvent[]>;
+    /**
+     * Events that should be faked (empty = fake all)
+     */
+    protected fakedEvents: string[];
+    /**
+     * Events that should NOT be faked (all others will be)
+     */
+    protected exceptedEvents: string[];
+    /**
+     * The original dispatcher (for pass-through)
+     */
+    protected originalDispatcher?: DispatcherContract;
+    /**
+     * Registered listeners (for assertListening)
+     */
+    protected listeners: Map<string, EventListener[]>;
+    constructor(container: Container);
+    /**
+     * Set which events should be faked
+     *
+     * @param events - Array of event names or classes to fake
+     */
+    setFakedEvents(events: string[]): void;
+    /**
+     * Set which events should NOT be faked (all others will be)
+     *
+     * @param events - Array of event names or classes to NOT fake
+     */
+    setExceptedEvents(events: string[]): void;
+    /**
+     * Set the original dispatcher for pass-through
+     *
+     * @param dispatcher - The real dispatcher instance
+     */
+    setOriginalDispatcher(dispatcher: DispatcherContract): void;
+    /**
+     * Check if an event should be faked
+     *
+     * @param eventName - The event name to check
+     * @returns true if the event should be faked
+     */
+    protected shouldFake(eventName: string): boolean;
+    /**
+     * Register an event listener
+     *
+     * @param events - Event name(s) to listen for
+     * @param listener - The listener to call
+     */
+    listen(events: string | string[], listener: EventListener): void;
+    /**
+     * Check if an event has listeners
+     *
+     * @param eventName - The event name to check
+     * @returns true if the event has registered listeners
+     */
+    hasListeners(eventName: string): boolean;
+    /**
+     * Register an event subscriber
+     *
+     * @param subscriber - The subscriber instance
+     */
+    subscribe(subscriber: any): void;
+    /**
+     * Dispatch an event
+     *
+     * @param event - The event instance or name
+     * @param payload - Additional arguments to pass
+     * @param halt - Stop on first non-null response
+     * @returns Array of listener results
+     */
+    dispatch(event: string | Event, payload?: any[], halt?: boolean): any[];
+    /**
+     * Dispatch an event until the first non-null response
+     *
+     * @param event - The event instance or name
+     * @param payload - Additional arguments to pass
+     * @returns The first non-null listener result
+     */
+    until(event: string | Event, payload?: any[]): any;
+    /**
+     * Push an event onto the queue for later flushing
+     *
+     * @param event - The event name
+     * @param payload - Additional arguments to pass
+     */
+    push(event: string, payload?: any[]): void;
+    /**
+     * Flush all queued events
+     *
+     * @param event - The event name to flush
+     */
+    flush(event: string): void;
+    /**
+     * Remove all listeners for an event
+     *
+     * @param event - The event name
+     */
+    forget(event: string): void;
+    /**
+     * Clear all queued events
+     */
+    forgetPushed(): void;
+    /**
+     * Get all registered listeners
+     *
+     * @returns Map of event names to listeners
+     */
+    getRawListeners(): Map<string, EventListener[]>;
+    /**
+     * Get the event name from an event instance or string
+     *
+     * @param event - The event instance or name
+     * @returns The event name
+     */
+    protected getEventName(event: string | Event): string;
+    /**
+     * Assert that an event was dispatched
+     *
+     * @param event - The event name or class
+     * @param callback - Optional callback to filter events
+     * @throws Error if the event was not dispatched
+     *
+     * @example
+     * ```typescript
+     * // Assert event was dispatched
+     * fake.assertDispatched(UserRegistered);
+     *
+     * // Assert event with specific properties
+     * fake.assertDispatched(UserRegistered, (event) => {
+     *   return event.user.email === 'test@example.com';
+     * });
+     * ```
+     */
+    assertDispatched(event: string | (new (...args: any[]) => Event), callback?: (event: Event) => boolean): void;
+    /**
+     * Assert that an event was NOT dispatched
+     *
+     * @param event - The event name or class
+     * @param callback - Optional callback to filter events
+     * @throws Error if the event was dispatched
+     *
+     * @example
+     * ```typescript
+     * // Assert event was not dispatched
+     * fake.assertNotDispatched(UserDeleted);
+     *
+     * // Assert event with specific properties was not dispatched
+     * fake.assertNotDispatched(UserRegistered, (event) => {
+     *   return event.user.email === 'admin@example.com';
+     * });
+     * ```
+     */
+    assertNotDispatched(event: string | (new (...args: any[]) => Event), callback?: (event: Event) => boolean): void;
+    /**
+     * Assert that an event was dispatched a specific number of times
+     *
+     * @param event - The event name or class
+     * @param times - Expected number of dispatches
+     * @throws Error if the dispatch count doesn't match
+     *
+     * @example
+     * ```typescript
+     * fake.assertDispatchedTimes(UserRegistered, 3);
+     * ```
+     */
+    assertDispatchedTimes(event: string | (new (...args: any[]) => Event), times: number): void;
+    /**
+     * Assert that no events were dispatched
+     *
+     * @throws Error if any events were dispatched
+     *
+     * @example
+     * ```typescript
+     * fake.assertNothingDispatched();
+     * ```
+     */
+    assertNothingDispatched(): void;
+    /**
+     * Assert that a listener is registered for an event
+     *
+     * @param event - The event name or class
+     * @param listener - Optional specific listener to check for
+     * @throws Error if the listener is not registered
+     *
+     * @example
+     * ```typescript
+     * // Assert any listener is registered
+     * fake.assertListening(UserRegistered);
+     *
+     * // Assert specific listener is registered
+     * fake.assertListening(UserRegistered, SendWelcomeEmail);
+     * ```
+     */
+    assertListening(event: string | (new (...args: any[]) => Event), listener?: string | EventListener): void;
+    /**
+     * Get the name of a listener
+     *
+     * @param listener - The listener instance or closure
+     * @returns The listener name
+     */
+    protected getListenerName(listener: EventListener): string;
+    /**
+     * Get all dispatched events for a given event name
+     *
+     * @param event - The event name or class
+     * @returns Array of dispatched event records
+     *
+     * @example
+     * ```typescript
+     * const dispatches = fake.getDispatched(UserRegistered);
+     * expect(dispatches).toHaveLength(3);
+     * ```
+     */
+    getDispatched(event: string | (new (...args: any[]) => Event)): DispatchedEvent[];
+    /**
+     * Get all dispatched event names
+     *
+     * @returns Array of event names
+     */
+    getDispatchedEventNames(): string[];
+    /**
+     * Get the total count of dispatched events
+     *
+     * @returns Total number of event dispatches
+     */
+    getDispatchedCount(): number;
+    /**
+     * Clear all recorded dispatches
+     *
+     * @example
+     * ```typescript
+     * // Clear between tests
+     * fake.clear();
+     * ```
+     */
+    clear(): void;
+    /**
+     * Clear all registered listeners
+     */
+    clearListeners(): void;
+    /**
+     * Reset the fake completely
+     */
+    reset(): void;
+}
+export {};
+//# sourceMappingURL=EventFake.d.ts.map

package/dist/Support/Testing/Fakes/EventFake.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventFake.d.ts","sourceRoot":"","sources":["../../../../src/Support/Testing/Fakes/EventFake.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;;GAIG;AACH,UAAU,eAAe;IACvB,uCAAuC;IACvC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtB,6CAA6C;IAC7C,OAAO,EAAE,GAAG,EAAE,CAAC;IAEf,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,SAAU,YAAW,kBAAkB;IA0BtC,SAAS,CAAC,SAAS,EAAE,SAAS;IAzB1C;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC,CAAa;IAEjE;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,CAAM;IAErC;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,CAAM;IAExC;;OAEG;IACH,SAAS,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAElD;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAa;gBAExC,SAAS,EAAE,SAAS;IAE1C;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IAItC;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IAIzC;;;;OAIG;IACH,qBAAqB,CAAC,UAAU,EAAE,kBAAkB,GAAG,IAAI;IAI3D;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAehD;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,EAAE,aAAa,GAAG,IAAI;IAahE;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;IAKhC;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,GAAE,GAAG,EAAO,EAAE,IAAI,GAAE,OAAe,GAAG,GAAG,EAAE;IAyBlF;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,GAAE,GAAG,EAAO,GAAG,GAAG;IAItD;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,GAAG,EAAO,GAAG,IAAI;IAI9C;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI1B;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,YAAY,IAAI,IAAI;IAIpB;;;;OAIG;IACH,eAAe,IAAI,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM;IASrD;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACd,KAAK,EAAE,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,EAC/C,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GACnC,IAAI;IA2BP;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CACjB,KAAK,EAAE,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,EAC/C,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GACnC,IAAI;IA0BP;;;;;;;;;;;OAWG;IACH,qBAAqB,CACnB,KAAK,EAAE,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,EAC/C,KAAK,EAAE,MAAM,GACZ,IAAI;IAWP;;;;;;;;;OASG;IACH,uBAAuB,IAAI,IAAI;IAe/B;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,KAAK,EAAE,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,EAC/C,QAAQ,CAAC,EAAE,MAAM,GAAG,aAAa,GAChC,IAAI;IAyBP;;;;;OAKG;IACH,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM;IAkB1D;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,GAAG,eAAe,EAAE;IAKjF;;;;OAIG;IACH,uBAAuB,IAAI,MAAM,EAAE;IAInC;;;;OAIG;IACH,kBAAkB,IAAI,MAAM;IAK5B;;;;;;;;OAQG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,cAAc,IAAI,IAAI;IAItB;;OAEG;IACH,KAAK,IAAI,IAAI;CAOd"}