import type { OutgoingContext } from './OutgoingContext';
import type { ClientActionConfig } from './ClientActionConfig';

/**
 * Результат создания инстанса.
 *
 * Это не обязательно значит что такой объект будет сохранен на сервере.
 * Основная цель сформировать актуальный контекст и отдать его клиенту.
 */
export interface CreateAnswerMessage {

  /**
   * Идентификатор конкретной транзакции.
   * По этому значению клиентская сторона получит результат создания конкретного инстанса.
   */
  transactionId: string;

  type: 'create:answer';

  /**
   * Актуальные значения полей нового объекта.
   */
  context?: OutgoingContext;

  meta?: ClientActionConfig;

  /**
   * Статус результата.
   * Если false, на основе значения поля result будет сформировано исключение.
   */
  success: boolean;

  /**
   * Полезная нагрузка.
   * В данном случае видимо используется только для ошибки. (нужно в этом убедиться)
   */
  result: any;
}