import type { Annotations, ExternalService, ServiceProvider } from '@sap-ux/axios-extension';
import type { Destination } from '@sap-ux/btp-utils';
import type { CapService } from '@sap-ux/cap-config-writer';
import type { TableSelectionMode, TableType } from '@sap-ux/fiori-elements-writer';
import type { CommonPromptOptions, YUIQuestion } from '@sap-ux/inquirer-common';
import type { OdataVersion } from '@sap-ux/odata-service-writer';
import type { BackendSystem, BackendSystemFilter } from '@sap-ux/store';
import type { ListChoiceOptions } from 'inquirer';
import type { serviceUrlInternalPromptNames } from './prompts/datasources/service-url/types.js';
import type { EntityAnswer, NavigationEntityAnswer } from './prompts/edmx/entity-helper.js';
import type { PageTemplateType } from '@sap-ux/fe-fpm-writer';
/**
 * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
 */
export declare enum DatasourceType {
    sapSystem = "sapSystem",
    capProject = "capProject",
    odataServiceUrl = "odataServiceUrl",
    none = "none",
    metadataFile = "metadataFile",
    projectSpecificDestination = "projectSpecificDestination",
    businessHub = "businessHub"
}
export declare const SapSystemTypes: {
    readonly abapOnPrem: "abapOnPrem";
    readonly abapOnBtp: "abapOnBtp";
};
export type SapSystemType = keyof typeof SapSystemTypes;
export declare const SAP_CLIENT_KEY = "sap-client";
/**
 * The limit for the metadata file size in KB above which a warning will be displayed to the user regarding processing time.
 */
export declare const MetadataSizeWarningLimitKb = 1000;
/**
 * Answers returned by the OdataServiceInquirer prompt API.
 * These values may be used to write an OData service and may be derived from the user's input rather than direct answers.
 */
export interface OdataServiceAnswers {
    /**
     * The data source type answer.
     */
    datasourceType: DatasourceType;
    /**
     * The odata service metadata (edmx) document.
     */
    metadata?: string;
    /**
     * The annotations document for the service.
     */
    annotations?: Annotations[];
    /**
     * The selected CAP service.
     */
    capService?: CapService;
    /**
     * The odata version of the selected service.
     */
    odataVersion?: OdataVersion;
    /**
     * The url origin (scheme, domain and port) of the service.
     */
    origin?: string;
    /**
     * The relative url path of the selected service. This coupled with the origin forms the full service url.
     */
    servicePath?: string;
    /**
     * The id of the selected service.
     */
    serviceId?: string;
    /**
     * The 'sap-client' value for the service.
     */
    sapClient?: string;
    /**
     * Metadata file path
     */
    metadataFilePath?: string;
    /**
     * The connected system will allow downstream consumers to access the connected system without creating new connections.
     *
     */
    connectedSystem?: ConnectedSystem;
    /**
     * If the user chose to ignore the certificate error when connecting to the service the value will be true.
     */
    [serviceUrlInternalPromptNames.ignoreCertError]?: boolean;
    /**
     * Value list metdata related to the main odata service
     */
    valueListMetadata?: ExternalService[];
}
export interface ConnectedSystem {
    /**
     * Convienence property to pass the connected system
     */
    serviceProvider: ServiceProvider;
    /**
     * The persistable backend system representation of the connected service provider
     * `newOrUpdated` is set to true if the system was newly created or updated during the connection validation process and should be considered for storage.
     */
    backendSystem?: BackendSystem & {
        newOrUpdated?: boolean;
    };
    /**
     * The destination information for the connected system
     */
    destination?: Destination;
}
/**
 * Enumeration of prompt names used by OdataServiceInquirerPromptOptions
 */
export declare enum promptNames {
    /**
     * Data source type
     */
    datasourceType = "datasourceType",
    /**
     * Metadata file path
     */
    metadataFilePath = "metadataFilePath",
    /**
     * Cap project
     */
    capProject = "capProject",
    /**
     * Cap service
     */
    capService = "capService",
    /**
     * Odata service URL
     */
    serviceUrl = "serviceUrl",
    /**
     * password
     */
    serviceUrlPassword = "serviceUrlPassword",
    /**
     * Service selection
     */
    serviceSelection = "serviceSelection",
    /**
     * Newly created systems can be named for storage
     */
    userSystemName = "userSystemName",
    /**
     * System selection
     */
    systemSelection = "systemSelection",
    /**
     * Value Help download confirm prompt
     */
    valueHelpDownload = "valueHelpDownload"
}
/**
 * Prompt names for entity related prompts. These indirectly define the properties of the answers object returned by the entity related prompts.
 */
export declare const EntityPromptNames: {
    readonly mainEntity: "mainEntity";
    readonly navigationEntity: "navigationEntity";
    readonly filterEntitySet: "filterEntitySet";
    readonly addPageBuildingBlock: "addPageBuildingBlock";
    readonly pageBuildingBlockLayout: "pageBuildingBlockLayout";
    readonly pageBuildingBlockTitle: "pageBuildingBlockTitle";
    readonly tableType: "tableType";
    readonly hierarchyQualifier: "hierarchyQualifier";
    readonly addFEOPAnnotations: "addFEOPAnnotations";
    readonly addLineItemAnnotations: "addLineItemAnnotations";
    readonly presentationQualifier: "presentationQualifier";
    readonly tableSelectionMode: "tableSelectionMode";
    readonly tableMultiSelect: "tableMultiSelect";
    readonly tableAutoHide: "tableAutoHide";
    readonly smartVariantManagement: "smartVariantManagement";
};
export type EntityPromptNames = (typeof EntityPromptNames)[keyof typeof EntityPromptNames];
export interface EntitySelectionAnswers {
    [EntityPromptNames.mainEntity]?: EntityAnswer;
    [EntityPromptNames.navigationEntity]?: NavigationEntityAnswer;
    [EntityPromptNames.filterEntitySet]?: EntityAnswer;
}
/**
 * Answers related to the Page Building Block prompt.
 */
export interface PageBuildingBlockAnswers {
    [EntityPromptNames.addPageBuildingBlock]?: boolean;
    /** The layout type for the page building block. This is only applicable if addPageBuildingBlock is true. */
    [EntityPromptNames.pageBuildingBlockLayout]?: PageTemplateType;
    [EntityPromptNames.pageBuildingBlockTitle]?: string;
}
export interface TableConfigAnswers {
    [EntityPromptNames.tableType]?: TableType;
    [EntityPromptNames.hierarchyQualifier]?: string;
}
export interface AnnotationGenerationAnswers {
    [EntityPromptNames.addFEOPAnnotations]?: boolean;
    [EntityPromptNames.addLineItemAnnotations]?: boolean;
}
export interface AlpTableConfigAnswers {
    [EntityPromptNames.tableAutoHide]?: boolean;
    [EntityPromptNames.tableMultiSelect]?: boolean;
    [EntityPromptNames.tableSelectionMode]?: TableSelectionMode;
    [EntityPromptNames.presentationQualifier]?: string;
    [EntityPromptNames.smartVariantManagement]?: boolean;
}
/**
 * Convienience alias type for the entity related answers
 */
export type EntityRelatedAnswers = EntitySelectionAnswers & PageBuildingBlockAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers;
export interface CapServiceChoice extends ListChoiceOptions {
    value: CapService;
}
export type CapProjectPromptOptions = {
    /**
     * The search paths for the CAP projects, this is a mandatory option as searching the entire file system is not recommended.
     */
    capSearchPaths: string[];
    /**
     * The default selected CAP project choice, this is used to pre-select a CAP project based on the CAP project path.
     */
    defaultChoice?: string;
    /**
     * Use autocomplete for project selection instead of list (CLI only).
     * Note: inquirer-autocomplete-prompt module is used for this feature and has to be registered with the inquirer instance.
     */
    useAutoComplete?: boolean;
};
export type CapServicePromptOptions = {
    /**
     * The default selected CAP service choice, this is used to pre-select a CAP service based on the specified CAP service name.
     */
    defaultChoice?: Pick<CapService, 'serviceName' | 'projectPath'>;
};
export type DatasourceTypePromptOptions = {
    /**
     * Default datasource type
     */
    default?: DatasourceType;
    /**
     * Include the no datasource option in the datasource type prompt
     */
    includeNone?: boolean;
    /**
     * Limit the offered datasource types to the specified types. Note that if `default` is also provided and not included in the choices, the default will be ignored.
     * If `includeNone` is set to true, the `none` option will always be included.
     *
     */
    choices?: DatasourceType[];
};
export type DestinationFilters = {
    /**
     * 'WebIDEUsage' property is defined and includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
     */
    odata_abap: boolean;
    /**
     * 'WebIDEUsage' property is defined and includes the value 'odata_gen' and does not includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
     */
    odata_generic: boolean;
    /**
     * 'WebIDEAdditionalData' property is defined and includes the value 'full_url' and
     * 'WebIDEUsage' property is defined and includes the value 'odata_gen' and does not includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
     */
    full_service_url: boolean;
    /**
     * 'WebIDEAdditionalData' property is defined and does not include the value 'full_url' and
     * 'WebIDEUsage' property is defined and includes the value 'odata_gen' and does not includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
     */
    partial_service_url: boolean;
};
export type SystemSelectionPromptOptions = {
    /**
     * Set the specific filter option(s) to true to include only the destinatons that have matching configuration attributes.
     * If no filter is set, all destinations will be included. If multiple filters are set, the destination will be included if it matches any of the filters.
     * i.e. if both `abap_cloud` and `abap_on_premise` are set to true, the destination will be included if it has either 'abap_cloud' or 'abap_on_premise' matching configuration.
     */
    destinationFilters?: Partial<DestinationFilters>;
    /**
     * Determines if the system selection prompt should use auto complete prompt for system names.
     * Note that the auto-complete module must be registered with the inquirer instance to use this feature.
     */
    useAutoComplete?: boolean;
    /**
     * Include the Cloud Foundry Abap environments service in the system selection prompt, only on Business Application Studio.
     * On non-BAS environments e.g. VSCode, the option to connect with Cloud Foundry Abap environments is included by default
     * via the 'New System' -> 'ABAP Environment on SAP Business Technology Platform' -> 'Discover a Cloud Foundry Service' option.
     */
    includeCloudFoundryAbapEnvChoice?: boolean;
    /**
     * Provide a default choice for the system selection prompt, this is used to pre-select a system based on the system name.
     * Set as string literal types `NewSystemChoice` or `CfAbapEnvServiceChoice` to specify the default choice to create a new system connection config in VSCode or to select the     Cloud Foundry Abap environments service discovery choice in BAS respectively.
     * Supported as object reference `{ value: }` to allow binding to runtime variables of other prompts or as string.
     */
    defaultChoice?: string | {
        value?: string;
    };
    /**
     * Provide an alternative connection path that will be used to authenticate the users access to the system.
     * This may be used to bypass the default catalog requests that usually are used.Supported as object reference `{ value: }` to allow binding to runtime variables of other prompts.
     */
    connectPath?: {
        value?: string;
    };
    /**
     * Only show the default choice in the system selection prompt, this is used to skip the system selection prompt if the default choice is already known.
     * If the `defaultChoice` value is not found in the systems choices, or the `defaultChoice` option is not specified,
     * this option will not be applied and the full list of choices will be presented to the user.
     */
    onlyShowDefaultChoice?: boolean;
    /**
     * If true, the 'New System' option is not added to the system selection list. Default is false - the 'New System' option will be available.
     */
    hideNewSystem?: boolean;
    /**
     * Include systems specified by the backendSystemFilter see {@link BackendSystemFilter}.
     * Defaults to { connectionType: ['abap_catalog', 'odata_service'] } if not provided.
     */
    backendSystemFilter?: BackendSystemFilter;
};
export type MetadataPromptOptions = {
    /**
     * Used to validate the metadata file contains the required odata version edmx
     */
    requiredOdataVersion?: OdataVersion;
};
export type ServiceSelectionPromptOptions = {
    /**
     * Determines if the service selection prompt should use auto complete prompt for service names.
     * Note that the auto-complete module must be registered with the inquirer instance to use this feature.
     */
    useAutoComplete?: boolean;
    /**
     * Used to validate the selected service is of the required odata version
     */
    requiredOdataVersion?: OdataVersion;
    /**
     * This allows the prompt to be excluded where consuming generators only require the system connection functionality.
     * If the service selection prompt is hidden then the odata service related answer properties will not be returned.
     */
    hide?: boolean;
    /**
     * If true, warn the user if the selected service has draft root annotated entity sets but does not have the share action property set.
     * This is used to indicate that the service does not support collaborative draft.
     */
    showCollaborativeDraftWarning?: boolean;
    /**
     * A list of service ids ({@link ODataServiceInfo.id}) or service paths ({@link ODataServiceInfo.path}), used to filter the service catalog results
     */
    serviceFilter?: string[];
} & Pick<CommonPromptOptions, 'additionalMessages'>;
export type SystemNamePromptOptions = {
    /**
     * This option allows the prompt to be excluded where later storage of the system with the provided name is not required.
     * If this propmt is not included then a BackendSystem will not be returned for the connected system.
     */
    hide?: boolean;
};
export type OdataServiceUrlPromptOptions = {
    /**
     * Used to validate the service specified by the url is of the required odata version edmx
     */
    requiredOdataVersion?: OdataVersion;
    /**
     * If true, warn the user if the selected service has draft root annotated entity sets but does not have the share action property set.
     * This is used to indicate that the service does not support collaborative draft.
     */
    showCollaborativeDraftWarning?: boolean;
} & Pick<CommonPromptOptions, 'additionalMessages'>;
/**
 * Provide the correct type checking for prompt options
 */
type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceSelection, ServiceSelectionPromptOptions> & Record<promptNames.userSystemName, SystemNamePromptOptions> & Record<promptNames.systemSelection, SystemSelectionPromptOptions> & Record<promptNames.valueHelpDownload, ValueHelpDownloadPromptOptions>;
export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
/**
 * The entity related prompt options. These options are used to configure the entity related prompts.
 */
export type EntityPromptOptions = {
    /**
     * Determines if entity related prompts should use auto complete on user input.
     * Note that the auto-complete module must be registered with the inquirer instance to use this feature.
     */
    useAutoComplete?: boolean;
    /**
     * Provide an entity name that will be preselected as the default option for the prompt.
     */
    defaultMainEntityName?: string;
    /**
     * Hides the table layout related prompts when true, default is false.
     */
    hideTableLayoutPrompts?: boolean;
    /**
     * Used to determine if the display page building block prompt should be displayed.
     */
    displayPageBuildingBlockPrompt?: boolean;
};
/**
 * Support hiding of the value help download prompt, default is true - hidden.
 * Note that this prompt is dependant on service metdata being provided, usually by the service selection prompt.
 */
export type ValueHelpDownloadPromptOptions = Pick<CommonPromptOptions, 'hide'>;
export {};
//# sourceMappingURL=types.d.ts.map