import {
  Frame,
  PageConfigurationWithTransformedDynamicForms,
  LibraryConfiguration,
  PageConfiguration,
  PluginConfiguration,
  WebcomponentConfiguration
} from '@allianz/taly-core/schemas';

/**
 * Schema Definition for a file, which can serve as the base for generating pages and will
 * also be consumed by the runtime to describe the content of a single page.
 */
export interface PagesJsonSchema
  extends Omit<PagesConfigurationWithTransformedDynamicForms, 'pages'> {
  /**
   * List of all available pages
   */
  pages: PageConfiguration[];
}

export interface PagesConfigurationWithTransformedDynamicForms {
  /**
   * Configuration for Frame Parts (Navigation, Footer etc)
   */
  frame?: Frame;
  /**
   * Provide a list of all used Building Block Libraries with the package name & version.
   * Unused packages (i.e. not referred to in any 'Building Block Configuration') will be
   * ignored.
   * @default []
   */
  libraries: LibraryConfiguration[];
  /**
   * List of all available pages
   */
  pages: PageConfigurationWithTransformedDynamicForms[];
  /**
   * Configuration for plugins
   * @default []
   */
  plugins?: PluginConfiguration[];
  /**
   * Application Title. Will be used as the website title. If omitted the app name is used.
   */
  title?: string;
  /**
   * Application Description. Will be used for the meta description tag.
   */
  description?: string;
  /**
   * Configuration for generating a webcomponent out of this application
   */
  webcomponent?: WebcomponentConfiguration;
  /**
   * set to true to show `WORK IN PROGRESS` text on top of the application.
   * @default false
   */
  workInProgressIndicator?: boolean;
}