// Copyright (c) Dolittle. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

import { Cancellation } from '@dolittle/sdk.resilience';
import { AggregateRoot } from './AggregateRoot';
import { AggregateRootAction } from './AggregateRootAction';

/**
 * Defines a system for working with operations that can be formed on an {@link AggregateRoot}.
 * @template TAggregate {@link AggregateRoot} Type.
 */
export abstract class IAggregateRootOperations<TAggregate extends AggregateRoot> {

    /**
     * Perform an operation on an {@link AggregateRoot}.
     * @param {AggregateRootAction<TAggregate>} action - Callback for working with the aggregate root.
     * @param {Cancellation} [cancellation] - The optional cancellation token.
     * @returns {Promise<void>}
     */
    abstract perform(action: AggregateRootAction<TAggregate>, cancellation?: Cancellation): Promise<void>;
}