import { AclDescriptor } from './acl-descriptor.model';

export interface JournalFileSchema {
  /**
   * List of all Building Blocks discovered
   */
  blocks?: BuildingBlockJournalRecord[];
  /**
   * Date of the generation in ISO format (i.e. YYYY-MM-DD)
   */
  created?: string;
  /**
   * md5 hash over the content excluding 'version', 'created' & 'hash'
   */
  hash?: string;
  /**
   * Identify the version of the journal to enable the parsing of future version once settled.
   */
  version?: string;
}

export interface BuildingBlockJournalRecord {
  aclDescriptor?: AclDescriptor[];
  /**
   * Whether the design of this Building Block is approved
   */
  designApproved?: boolean;
  /**
   * List of available business events dispatched by this Building Block
   */
  businessEvents?: BusinessEvent[];
  /**
   * Plain list of channels like 'expert' where this Building Block applies
   */
  channel?: string[] | boolean | number | { [key: string]: unknown } | null | string;
  /**
   * Whether this Building Block is deprecated
   */
  deprecated?: boolean;
  /**
   * More information about why this Building Block is deprecated
   */
  deprecationMessage?: string;
  /**
   * Unique identifier for the Building Block within the package
   */
  id?: string;
  /**
   * List of LOB (Line of Business) where this Building Block applies.
   */
  lob?: LobValue[];
  /**
   * Angular Module Name to import to make this Building Block available
   */
  module?: string;
  /**
   * Package Name to import the Building Block from
   */
  package?: string;
  /**
   * Selector for this element
   */
  selector?: string;
  /**
   * Human readable title of the Building Block
   */
  title?: string;
  /**
   * Available Validations for a set of form controls (control paths)
   */
  validations?: { [key: string]: unknown };
}

export interface BusinessEvent {
  /**
   * Explanations of the intended effect of this business event
   */
  description?: string;
  /**
   * Unique identifier for the given Business event
   */
  id?: string;
}

export interface LobValue {
  /**
   * The LOB ID is encoded as the ABS value, e.g. KB or HH/
   */
  id?: string;
  /**
   * Human readable name of the given ABS value.
   */
  label?: string;
}