import { DataType } from "../data-utilities/types.js";
import { NavigationConfig, NavigationConfigDictionary } from "./navigation.props.js";
import { Data, DataDictionary, LinkedData } from "./data.props.js";
import { SchemaDictionary } from "./schema.props.js";
import { MessageSystemType } from "./types.js";
import { Validation, ValidationError } from "./validation.props.js";
import { History } from "./history.props.js";
/**
 * Note on nomenclature: incoming messages are being sent to, and recieved, by the message system
 * while outgoing messages are being sent from the message system to any registered service. These
 * terms are from the POV of the message system.
 */
export declare enum MessageSystemDataTypeAction {
    update = "update",
    remove = "remove",
    add = "add",
    duplicate = "duplicate",
    removeLinkedData = "remove-linked-data",
    addLinkedData = "add-linked-data",
    reorderLinkedData = "reorder-linked-data"
}
export declare enum MessageSystemNavigationTypeAction {
    update = "update",
    get = "get"
}
export declare enum MessageSystemValidationTypeAction {
    update = "update",
    get = "get"
}
export declare enum MessageSystemHistoryTypeAction {
    get = "get",
    previous = "previous",
    next = "next"
}
export declare enum MessageSystemSchemaDictionaryTypeAction {
    add = "add"
}
interface ArbitraryMessageIncoming<TConfig = {}> {
    /**
     * Additional arbitrary options to be passed with the message
     */
    options?: TConfig;
}
interface ArbitraryMessageOutgoing<TConfig = {}> {
    /**
     * Additional arbitrary options to be passed with the message
     */
    options?: TConfig;
    activeHistoryIndex: number;
    dataDictionary: DataDictionary<unknown>;
    navigationDictionary: NavigationConfigDictionary;
    activeNavigationConfigId: string;
    activeDictionaryId: string;
    /**
     * @deprecated
     */
    dictionaryId: string;
    schemaDictionary: SchemaDictionary;
    validation: Validation;
    historyId: string;
}
export interface InternalIncomingMessage<Message> {
    /**
     * The message to be sent
     */
    0: Message;
    /**
     * The internal ID of the message
     */
    1: string;
}
export interface InternalOutgoingMessage<Message> {
    /**
     * The message to be sent
     */
    0: Message;
    /**
     * The internal ID of the message
     */
    1: string;
}
/**
 * The message to initialize the message system
 *
 * A message system can be initialized without a data dictionary or schema dictionary
 * if asynchronous services are being added to the message system and the initialization
 * must happen at a later stage once the asynchronous services have initialized.
 */
export interface InitializeMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.initialize;
    /**
     * This is deprecated in favor of the dataDictionary
     * property
     * @deprecated
     */
    data?: DataDictionary<unknown>;
    /**
     * This is required when data is not provided
     */
    dataDictionary?: DataDictionary<unknown>;
    /**
     * Set the dictionary id, otherwise default to the root
     */
    dictionaryId?: string;
    schemaDictionary: SchemaDictionary;
    historyLimit?: number;
}
/**
 * The message that the message system has been initialized
 */
export interface InitializeMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.initialize;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
    /**
     * @deprecated
     */
    schema: any;
    /**
     * @deprecated
     */
    historyLimit: number;
}
/**
 * The message that the validation should be updated
 */
export interface UpdateValidationMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.validation;
    action: MessageSystemValidationTypeAction.update;
    dictionaryId: string;
    validationErrors: ValidationError[];
}
/**
 * The message that the validation has been updated
 */
export interface UpdateValidationMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.validation;
    action: MessageSystemValidationTypeAction.update;
    /**
     * @deprecated
     */
    validationErrors: ValidationError[];
}
/**
 * The message to get the validation
 */
export interface GetValidationMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.validation;
    action: MessageSystemValidationTypeAction.get;
    dictionaryId: string;
}
/**
 * The message that the validation has been given
 */
export interface GetValidationMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.validation;
    action: MessageSystemValidationTypeAction.get;
    /**
     * @deprecated
     */
    validationErrors: ValidationError[];
}
/**
 * The message to update data
 */
export interface UpdateDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.update;
    /**
     * Dictionary ID to use if it is different from the current
     * active dictionary ID
     */
    dictionaryId?: string;
    dataLocation: string;
    data: unknown;
}
/**
 * The message that the data has been updated
 */
export interface UpdateDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.update;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * The message to add a linked data
 */
export interface AddLinkedDataDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.addLinkedData;
    /**
     * Dictionary ID to use if it is different from the current
     * active dictionary ID
     */
    dictionaryId?: string;
    /**
     * The index to insert the linked data to, if this is not provided
     * the linked data will be added to the end of the list
     */
    index?: number;
    dataLocation: string;
    linkedData: Array<Data<unknown>>;
    /**
     * If there is a list of previous IDs used for this linked data,
     * utilize these instead of generated them.
     *
     * Warning: this should only be used internally or if the user has a self
     * curated ID system they would prefer to use over the auto-generated one.
     */
    originalLinkedDataIds?: Array<LinkedData>;
}
/**
 * The message that linked data has been added
 */
export interface AddLinkedDataDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.addLinkedData;
    /**
     * @deprecated
     */
    linkedDataIds: LinkedData[];
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * The message to remove linked data
 */
export interface RemoveLinkedDataDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.removeLinkedData;
    /**
     * Dictionary ID to use if it is different from the current
     * active dictionary ID
     */
    dictionaryId?: string;
    dataLocation?: string;
    linkedData?: LinkedData[];
}
/**
 * The message that linked data has been removed
 */
export interface RemoveLinkedDataDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.removeLinkedData;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
    /**
     * An array of linked data ids that were removed from
     * the data dictionary
     * @deprecated
     */
    linkedDataIds: string[];
}
/**
 * The message to reorder linked data
 */
export interface ReorderLinkedDataDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.reorderLinkedData;
    dataLocation: string;
    linkedData: LinkedData[];
}
/**
 * The message that linked data has been reordered
 */
export interface ReorderLinkedDataDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.reorderLinkedData;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * The message to duplicate data
 */
export interface DuplicateDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.duplicate;
    sourceDataLocation: string;
}
/**
 * The message that the data has been duplicated
 * with updated data
 */
export interface DuplicateDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.duplicate;
    /**
     * @deprecated
     */
    sourceDataLocation: string;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * The message to remove data
 */
export interface RemoveDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.remove;
    dictionaryId?: string;
    dataLocation: string;
}
/**
 * The message that the data has been removed
 * with updated data
 */
export interface RemoveDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.remove;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * The message to add data
 */
export interface AddDataMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.add;
    dataLocation: string;
    data: unknown;
    dataType: DataType;
}
/**
 * The message that the data has been added
 * with updated data
 */
export interface AddDataMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.data;
    action: MessageSystemDataTypeAction.add;
    /**
     * @deprecated
     */
    data: unknown;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * Incoming data messages to the message system
 */
export declare type DataMessageIncoming = UpdateDataMessageIncoming | DuplicateDataMessageIncoming | RemoveDataMessageIncoming | AddDataMessageIncoming | AddLinkedDataDataMessageIncoming | RemoveLinkedDataDataMessageIncoming | ReorderLinkedDataDataMessageIncoming;
/**
 * Outgoing data messages to the message system
 */
export declare type DataMessageOutgoing = DuplicateDataMessageOutgoing | RemoveDataMessageOutgoing | AddDataMessageOutgoing | UpdateDataMessageOutgoing | AddLinkedDataDataMessageOutgoing | RemoveLinkedDataDataMessageOutgoing | ReorderLinkedDataDataMessageOutgoing;
/**
 * The message to update navigation
 */
export interface UpdateNavigationMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.navigation;
    action: MessageSystemNavigationTypeAction.update;
    activeDictionaryId: string;
    activeNavigationConfigId: string;
}
/**
 * The message that the navigation has been updated
 */
export interface UpdateNavigationMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.navigation;
    action: MessageSystemNavigationTypeAction.update;
}
/**
 * The message to get navigation
 */
export interface GetNavigationMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.navigation;
    action: MessageSystemNavigationTypeAction.get;
}
/**
 * The message that the navigation has been given
 */
export interface GetNavigationMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.navigation;
    action: MessageSystemNavigationTypeAction.get;
    /**
     * @deprecated
     */
    navigation: NavigationConfig;
}
/**
 * The message to get history
 */
export interface GetHistoryMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.history;
    action: MessageSystemHistoryTypeAction.get;
}
/**
 * The message that the history has been given
 */
export interface GetHistoryMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.history;
    action: MessageSystemHistoryTypeAction.get;
    history: History;
    activeHistoryIndex: number;
}
/**
 * The message to move to the next item in history
 * Note: This message does not have an outgoing message as the outgoing message
 * is the next message stored in the history item
 */
export interface NextHistoryMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.history;
    action: MessageSystemHistoryTypeAction.next;
}
/**
 * The message to move to the previous item in history
 */
export interface PreviousHistoryMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.history;
    action: MessageSystemHistoryTypeAction.previous;
}
/**
 * The message to add schemas to the schema dictionary
 */
export interface AddSchemaDictionaryMessageIncoming<TConfig = {}> extends ArbitraryMessageIncoming<TConfig> {
    type: MessageSystemType.schemaDictionary;
    action: MessageSystemSchemaDictionaryTypeAction.add;
    schemas: any[];
}
/**
 * The message that schemas have been added to the schema dictionary
 */
export interface AddSchemaDictionaryMessageOutgoing<TConfig = {}> extends ArbitraryMessageOutgoing<TConfig> {
    type: MessageSystemType.schemaDictionary;
    action: MessageSystemSchemaDictionaryTypeAction.add;
}
export interface CustomMessageIncomingOutgoing<OConfig> extends ArbitraryMessageIncoming<OConfig> {
    type: MessageSystemType.custom;
}
/**
 * The message that an error occured when attempting to perform an action
 */
export interface ErrorMessageOutgoing {
    type: MessageSystemType.error;
    message: string;
}
/**
 * The custom message interface
 */
export declare type CustomMessage<T, OConfig> = CustomMessageIncomingOutgoing<OConfig> & T;
/**
 * Incoming navigation messages to the message system
 */
export declare type NavigationMessageIncoming = UpdateNavigationMessageIncoming | GetNavigationMessageIncoming;
/**
 * Outgoing navigation messages to the message system
 */
export declare type NavigationMessageOutgoing = UpdateNavigationMessageOutgoing | GetNavigationMessageOutgoing;
/**
 * Incoming validation messages to the message system
 */
export declare type ValidationMessageIncoming = UpdateValidationMessageIncoming | GetValidationMessageIncoming;
/**
 * Outgoing validation messages to the message system
 */
export declare type ValidationMessageOutgoing = UpdateValidationMessageOutgoing | GetValidationMessageOutgoing;
/**
 * Incoming history messages to the message system
 */
export declare type HistoryMessageIncoming = GetHistoryMessageIncoming | NextHistoryMessageIncoming | PreviousHistoryMessageIncoming;
/**
 * Outgoing history messages from the message system
 */
export declare type HistoryMessageOutgoing = GetHistoryMessageOutgoing;
/**
 * Incoming schema dictionary messages to the message system
 */
export declare type SchemaDictionaryMessageIncoming = AddSchemaDictionaryMessageIncoming;
/**
 * Outgoing schema dictionary messages from the message system
 */
export declare type SchemaDictionaryMessageOutgoing = AddSchemaDictionaryMessageOutgoing;
/**
 * Incoming messages to the message system
 */
export declare type MessageSystemIncoming<C = {}, OConfig = {}> = InitializeMessageIncoming | DataMessageIncoming | HistoryMessageIncoming | SchemaDictionaryMessageIncoming | NavigationMessageIncoming | ValidationMessageIncoming | CustomMessage<C, OConfig>;
/**
 * Outgoing message to the message system after passing
 * through the internal MessageSystem instance
 */
export declare type InternalMessageSystemIncoming<C = {}, OConfig = {}> = InternalIncomingMessage<InitializeMessageIncoming> | InternalIncomingMessage<DataMessageIncoming> | InternalIncomingMessage<HistoryMessageIncoming> | InternalIncomingMessage<SchemaDictionaryMessageIncoming> | InternalIncomingMessage<NavigationMessageIncoming> | InternalIncomingMessage<ValidationMessageIncoming> | InternalOutgoingMessage<CustomMessage<C, OConfig>>;
/**
 * Outgoing messages from the message system
 */
export declare type MessageSystemOutgoing<C = {}, OConfig = {}> = InitializeMessageOutgoing | DataMessageOutgoing | ErrorMessageOutgoing | HistoryMessageOutgoing | SchemaDictionaryMessageOutgoing | NavigationMessageOutgoing | ValidationMessageOutgoing | CustomMessage<C, OConfig>;
/**
 * Outgoing message to the message system after passing
 * through the internal MessageSystem instance
 */
export declare type InternalMessageSystemOutgoing<C = {}, OConfig = {}> = InternalOutgoingMessage<InitializeMessageOutgoing> | InternalOutgoingMessage<DataMessageOutgoing> | InternalOutgoingMessage<ErrorMessageOutgoing> | InternalOutgoingMessage<HistoryMessageOutgoing> | InternalOutgoingMessage<SchemaDictionaryMessageOutgoing> | InternalOutgoingMessage<NavigationMessageOutgoing> | InternalOutgoingMessage<ValidationMessageOutgoing> | InternalOutgoingMessage<CustomMessage<C, OConfig>>;
export {};