import { EventDataRegistry, EventName } from '../../types/event.js'; /** * Event name a subscriber registers under to receive EVERY event. Created by * placing the handler in a `subscribers/_all/` folder; named subscribers are * unaffected. */ export declare const WILDCARD_EVENT = "*"; /** * Folder name under `subscribers/` that maps to `WILDCARD_EVENT`. */ export declare const WILDCARD_FOLDER = "_all"; /** * Second argument passed to every subscriber: which event triggered it. A * named subscriber already knows its event, so this matters mainly to * wildcard (`_all`) subscribers. */ export type EventMeta = { /** The event name, e.g. `order_placed`. */ name: string; /** The `event` row uuid. Stable for the life of the event. */ uuid: string; }; /** * Type-safe event subscriber function. * Use this type to ensure your subscriber receives the correct event data type. * * @example * ```typescript * import { EventSubscriber } from '@evershop/evershop/lib/event/subscriber'; * * const handler: EventSubscriber<'order.placed'> = async (data) => { * // data is typed as EventDataRegistry['order.placed'] * console.log(data.orderId); // TypeScript knows this exists * }; * * export default handler; * ``` */ export type EventSubscriber = (data: EventDataRegistry[T]) => Promise | void; /** * Helper function to create a type-safe event subscriber. * Provides better IDE autocomplete and type checking. * * @example * ```typescript * import { createSubscriber } from '@evershop/evershop/lib/event/subscriber'; * * export default createSubscriber('order_placed', async (data) => { * // data is automatically typed * await sendEmail(data.orderId); * }); * ``` */ export declare function createSubscriber(eventName: T, handler: EventSubscriber): (data: EventDataRegistry[T]) => Promise;