import type { ComponentModel, Model } from "../models";
import type { ConfigurableService } from "../services";
import type { ApplyDesignerSettingsArgs } from "./ApplyDesignerSettingsArgs";
import type { ComponentModelDesignerSettings } from "./ComponentModelDesignerSettings";
import type { GetDesignerSettingsArgs } from "./GetDesignerSettingsArgs";
import type { GetDesignerSettingsSchemaArgs } from "./GetDesignerSettingsSchemaArgs";
import type { ModelDesignerSettings } from "./ModelDesignerSettings";
import type { Group, SettingsSchema } from "./SettingsSchema";
import type { ValidateConfigurableItemArgs } from "./ValidateConfigurableItemArgs";
type Unionize<T> = T[keyof T];
/**
 * Corresponds to the top-level settings for a component/service. Each item that
 * is configurable in VertiGIS Studio App Designer must have at least theses
 * main settings, but can optionally have any number of subsettings forms as
 * well.
 */
export type TopLevelSettingsType = "";
/**
 * A mapping of subsetting types to settings DTOs. Use the `DesignerSettings`
 * helper to create a settings map.
 *
 * @template TSubsettingType A string literal enumeration type that represents
 *   the possible values for `subsettingsType` in callback arguments. Must
 *   include `MainSettings`.
 */
export type DesignerSettingsMap<TSubsettingType extends string = TopLevelSettingsType> = {
    [P in TSubsettingType]: object;
};
/**
 * Helper for creating a `DesignerSettingsMap`.
 *
 * @example
 *     // For simple components.
 *     interface Component1Settings = { ... };
 *     export type Component1SettingsMap = DesignerSettings<Component1Settings>;
 *
 *     // For more complex components that have subsettings.
 *     interface Component2Settings = { ... };
 *     interface Component2Subsettings1 = { ... };
 *     interface Component2Subsettings2 = { ... };
 *     export type Component2SettingsMap = DesignerSettings<Component2Settings>
 *     & DesignerSettings<Component2Subsettings1, "subsettings1">
 *     & DesignerSettings<Component2Subsettings2, "subsettings2">
 */
export type DesignerSettings<TSettings, TSubsettingType extends string = TopLevelSettingsType> = {
    [P in TSubsettingType]: TSettings;
};
/**
 * Applies settings that were modified in VertiGIS Studio App Designer back to
 * the model. Note that this function may be invoked to apply any arbitrary
 * subset of settings at a time.
 *
 * @param args Contains the updated settings, the model to update, as well as
 *   other contextual information such as the subsetting type and ID if
 *   applicable.
 */
export type ApplyDesignerSettingsCallback<TModel extends Model, TSettingsMap extends DesignerSettingsMap> = (args: MakeApplyDesignerSettingsArgs<TModel, TSettingsMap>) => void | Promise<void>;
/**
 * Gets the settings for a component's model, so that it can be configured by
 * VertiGIS Studio App Designer.
 *
 * @param args Information about the settings being requested such as the model,
 *   as well as the subsetting type and ID if applicable.
 */
export type GetDesignerSettingsCallback<TModel extends Model, TSettingsMap extends DesignerSettingsMap> = (args: MakeGetDesignerSettingsArgs<TModel, TSettingsMap>) => Unionize<TSettingsMap> | Promise<Unionize<TSettingsMap>>;
/**
 * Callback to confirm there are no warnings or errors on the configurable item.
 *
 * @param args The model being validated and utils which could be required for
 *   validation.
 */
export type ValidateConfigurableItemCallback<TModel extends Model> = (args: ValidateConfigurableItemArgs<TModel>) => ValidateConfigurableItemResponse[] | Promise<ValidateConfigurableItemResponse[]>;
/**
 * The response from validating a configurable item (component or service) on
 * save.
 */
export interface ValidateConfigurableItemResponse {
    /**
     * The type of validation response. An error would indicate invalid
     * configuration and prevent a save. A warning could be used to communicate
     * a default value is being used, but still allowing a save to occur.
     */
    errorType: "error" | "warning";
    /**
     * The message to display to the user why the error or warning occurred.
     */
    message: string;
    /**
     * The search term to open pinpoint with. This would direct the user to the
     * source of the error or warning.
     */
    pinpointSearchTerm?: string;
}
/**
 * Returns the VertiGIS Studio App Designer settings schema for a given model.
 *
 * @param args Information about the settings schema being requested.
 */
export type GetDesignerSettingsSchemaCallback<TModel extends Model, TSettingsMap extends DesignerSettingsMap> = (args: MakeGetDesignerSettingsSchemaArgs<TModel, TSettingsMap>) => MakeGetDesignerSettingsSchemaResult<TSettingsMap> | Promise<MakeGetDesignerSettingsSchemaResult<TSettingsMap>>;
type MakeApplyDesignerSettingsArgs<TModel extends Model, TSettingsMap> = Unionize<{
    [K in keyof TSettingsMap]: ApplyDesignerSettingsArgs<TModel, TSettingsMap[K], Extract<K, string>>;
}>;
type MakeGetDesignerSettingsArgs<TModel extends Model, TSettingsMap> = Unionize<{
    [K in keyof TSettingsMap]: GetDesignerSettingsArgs<TModel, Extract<K, string>>;
}>;
type MakeGetDesignerSettingsSchemaArgs<TModel extends Model, TSettingsMap> = Unionize<{
    [K in keyof TSettingsMap]: GetDesignerSettingsSchemaArgs<TModel, Extract<K, string>>;
}>;
type MakeGetDesignerSettingsSchemaResult<TSettingsMap> = Unionize<{
    [K in keyof TSettingsMap]: SettingsSchema<TSettingsMap[K]>;
}>;
/**
 * Gets the base settings for a component's model.
 *
 * @param args Arguments specifying the model and other options.
 */
export declare function getComponentModelDesignerSettings<TModel extends ComponentModel>(args: GetDesignerSettingsArgs<TModel>): Promise<ComponentModelDesignerSettings>;
/**
 * Gets the base settings schema for a component's model.
 *
 * @param args Arguments specifying the model and other options.
 */
export declare function getComponentModelDesignerSettingsSchema<TModel extends ComponentModel>(args: GetDesignerSettingsSchemaArgs<TModel>): Promise<GroupOnlySettingsSchema<ComponentModelDesignerSettings>>;
/**
 * Applies base settings to a component's model.
 *
 * @param args Arguments specifying the model and other options.
 */
export declare function applyComponentModelDesignerSettings<TModel extends ComponentModel>(args: ApplyDesignerSettingsArgs<TModel, ComponentModelDesignerSettings>): Promise<void>;
/**
 * Gets the base settings for a configurable service.
 *
 * @param args Arguments specifying the model and other options.
 */
export declare function getServiceDesignerSettings<TService extends ConfigurableService>(args: GetDesignerSettingsArgs<TService>): Promise<ModelDesignerSettings>;
/**
 * Applies the base settings for a configurable service.
 *
 * @param args Arguments specifying the model and other options.
 */
export declare function applyServiceDesignerSettings<TService extends ConfigurableService>(args: ApplyDesignerSettingsArgs<TService, ModelDesignerSettings>): Promise<void>;
/**
 * Gets the base settings schema for a configurable service.
 *
 * @param args Arguments specifying the model and other options.
 */
export declare function getServiceDesignerSettingsSchema<TService extends ConfigurableService>(args: GetDesignerSettingsSchemaArgs<TService>): Promise<SettingsSchema<ModelDesignerSettings>>;
/**
 * Default implementation of the validateConfigurableItem hook for App Designer.
 * Custom implementations should invoke this one.
 *
 * @param model The model to validate.
 */
export declare function validateConfigurableItem<TModel extends Model>(model: ValidateConfigurableItemArgs<TModel>): Promise<ValidateConfigurableItemResponse[]>;
interface GroupOnlySettingsSchema<T = object> extends Omit<SettingsSchema<T>, "settings"> {
    settings: Group<ComponentModelDesignerSettings>[];
}
export {};