/**
 * @license
 * Copyright (C) Gnucoop soc. coop.
 *
 * This file is part of the Advanced JSON forms (ajf).
 *
 * Advanced JSON forms (ajf) is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * Advanced JSON forms (ajf) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
 * General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Advanced JSON forms (ajf).
 * If not, see http://www.gnu.org/licenses/.
 *
 */
import { AjfCondition } from '@ajf/core/models';
import { EventEmitter } from '@angular/core';
import { AjfNode } from '../nodes/node';
/**
 * The instance of an ajfNode.
 * A single ajfNode can have multiple instances with different values
 * differentiated by a suffix, when used in a repeating slide.
 * (eg.
 * country__0 = 'ITA', country__1 = 'ESP'
 * city__0__0 = 'Milano', city__0__1 = 'Roma', city__1__0 = 'Madrid'
 * )
 *
 * The AjfNodeInstance visibility is determined by the visibility of the current branch
 * and  the visibility condition of the node itself.
 * @see {@link updateVisibility}
 * @see {@link updateConditionalBranches}
 */
export interface AjfBaseNodeInstance {
    /**
     * The AjfNode blueprint from which this node instance is generated
     */
    node: AjfNode;
    /**
     * Array of prefixes that identifies the tree of all the ancestor nodes indexes
     */
    prefix: number[];
    /**
     * The current node visibility
     */
    visible: boolean;
    /**
     * List of conditions that determines the branch to be followed
     */
    conditionalBranches: AjfCondition[];
    /**
     * AjfCondition for handling visibility
     */
    visibility?: AjfCondition;
    /**
     * Identifies the index of the condition verified and is equal to the
     * parentNode of branch that determines..?
     */
    verifiedBranch?: number;
    /**
     * Emitted when any property of the node instance has changed value
     */
    updatedEvt: EventEmitter<void>;
}