@medusajs/types/dist/shared-context.d.ts

Medusa Types definition

import { EventBusTypes } from "./bundles";
import { Message } from "./event-bus";
export interface MessageAggregatorFormat {
    groupBy?: string[];
    sortBy?: {
        [key: string]: string[] | string | number;
    };
    /**
     * @internal
     * will prevent the info log to be displayed about those events
     */
    internal?: boolean;
}
export interface IMessageAggregator {
    save(msg: Message | Message[]): void;
    getMessages(format?: MessageAggregatorFormat): Record<string, Message[]>;
    clearMessages(): void;
    saveRawMessageData<T>(messageData: EventBusTypes.RawMessageFormat<T> | EventBusTypes.RawMessageFormat<T>[], options?: Record<string, unknown>): void;
}
/**
 * @interface
 * A context used to share resources, such as transaction manager, between the application and the module.
 */
export type Context<TManager = unknown> = {
    __type?: "MedusaContext";
    /**
     * An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.
     */
    transactionManager?: TManager;
    /**
     * An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.
     */
    manager?: TManager;
    /**
     * A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.
     */
    isolationLevel?: string;
    /**
     * A boolean value indicating whether nested transactions are enabled.
     */
    enableNestedTransactions?: boolean;
    /**
     * A string indicating the ID of the group to aggregate the events to be emitted at a later point.
     */
    eventGroupId?: string;
    /**
     * A string indicating the ID of the current transaction.
     */
    transactionId?: string;
    /**
     * An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.
     */
    messageAggregator?: IMessageAggregator;
    /**
     * A string indicating the ID of the current request.
     */
    requestId?: string;
    /**
     * A string indicating the idempotencyKey of the current workflow execution.
     */
    idempotencyKey?: string;
    /**
     * A string indicating the idempotencyKey of the parent workflow execution.
     */
    parentStepIdempotencyKey?: string;
    /**
     * preventReleaseEvents
     */
    preventReleaseEvents?: boolean;
    /**
     * A boolean value indicating whether the current workflow execution is being cancelled.
     */
    isCancelling?: boolean;
};
//# sourceMappingURL=shared-context.d.ts.map