import { Result } from '../base';
import { Converter, ConverterFunc } from '../conversion';
import { Validator } from '../validation';
/**
 * An item that can be collected by some {@link ConvertingCollector | Collector}.
 * @public
 */
export interface ICollectible<TKEY extends string = string, TINDEX extends number = number> {
    readonly key: TKEY;
    readonly index: TINDEX | undefined;
    setIndex(index: number): Result<TINDEX>;
}
/**
 * Infer the key type from an {@link Collections.ICollectible | ICollectible} type.
 * @public
 */
export type CollectibleKey<TITEM extends ICollectible> = TITEM extends ICollectible<infer TKEY> ? TKEY : never;
/**
 * Infer the index type from an {@link Collections.ICollectible | ICollectible} type.
 * @public
 */
export type CollectibleIndex<TITEM extends ICollectible> = TITEM extends ICollectible<any, infer TINDEX> ? TINDEX : never;
/**
 * Factory function for creating a new {@link Collections.ICollectible | ICollectible} instance given a key, an index and a source representation
 * of the item to be added.
 * @public
 */
export type CollectibleFactory<TITEM extends ICollectible<any, any>, TSRC> = (key: CollectibleKey<TITEM>, index: number, item: TSRC) => Result<TITEM>;
/**
 * Factory function for creating a new {@link Collections.ICollectible | ICollectible} instance given a key and an index.
 * @public
 */
export type CollectibleFactoryCallback<TITEM extends ICollectible<any, any>> = (key: CollectibleKey<TITEM>, index: number) => Result<TITEM>;
/**
 * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance with
 * a defined, strongly-typed index.
 * @public
 */
export interface ICollectibleConstructorParamsWithIndex<TKEY extends string = string, TINDEX extends number = number> {
    key: TKEY;
    index: TINDEX;
}
/**
 * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance with an
 * index converter.
 * @public
 */
export interface ICollectibleConstructorParamsWithConverter<TKEY extends string = string, TINDEX extends number = number> {
    key: TKEY;
    index?: number;
    indexConverter: Validator<TINDEX, unknown> | Converter<TINDEX, unknown> | ConverterFunc<TINDEX, undefined>;
}
/**
 * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance.
 * @public
 */
export type ICollectibleConstructorParams<TKEY extends string = string, TINDEX extends number = number> = ICollectibleConstructorParamsWithIndex<TKEY, TINDEX> | ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>;
/**
 * Simple implementation of {@link Collections.ICollectible | ICollectible} which does not allow the index to be
 * changed once set.
 * @public
 */
export declare class Collectible<TKEY extends string = string, TINDEX extends number = number> implements ICollectible<TKEY, TINDEX> {
    /**
     * {@link Collections.ICollectible.key}
     */
    readonly key: TKEY;
    /**
     * {@link Collections.ICollectible.index}
     */
    get index(): TINDEX | undefined;
    protected _index: TINDEX | undefined;
    protected readonly _indexConverter?: Validator<TINDEX, unknown> | Converter<TINDEX, unknown>;
    /**
     * Constructs a new {@link Collections.Collectible | Collectible} instance
     * with a defined, strongly-typed index.
     * @param params - {@link Collections.ICollectibleConstructorParamsWithIndex | Parameters} for constructing
     * the collectible.
     */
    constructor(params: ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>);
    /**
     * Constructs a new {@link Collections.Collectible | Collectible} instance with
     * an undefined index and an index converter to validate te index when it is set.
     * @param params - {@link Collections.ICollectibleConstructorParamsWithConverter | Parameters} for constructing
     * the collectible.
     */
    constructor(params: ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>);
    /**
     * Constructs a new {@link Collections.Collectible | Collectible} instance.
     * @param params - {@link Collections.ICollectibleConstructorParams | Parameters} for constructing
     * the collectible.
     */
    constructor(params: ICollectibleConstructorParams<TKEY, TINDEX>);
    /**
     * Creates a new {@link Collections.Collectible | Collectible} instance with a defined, strongly-typed index.
     * @param params - {@link Collections.ICollectibleConstructorParamsWithIndex | Parameters} for constructing
     * the collectible.
     * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise.
     */
    static createCollectible<TKEY extends string = string, TINDEX extends number = number>(params: ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>): Result<Collectible<TKEY, TINDEX>>;
    /**
     * Creates a new {@link Collections.Collectible | Collectible} instance with an undefined index and an index
     * converter to validate the index when it is set.
     * @param params - {@link Collections.ICollectibleConstructorParamsWithConverter | Parameters} for constructing
     * the collectible.
     * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise.
     */
    static createCollectible<TKEY extends string = string, TINDEX extends number = number>(params: ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>): Result<Collectible<TKEY, TINDEX>>;
    /**
     * Creates a new {@link Collections.Collectible | Collectible} instance.
     * @param params - {@link Collections.ICollectibleConstructorParams | Parameters} for constructing
     * the collectible.
     * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise
     * @public
     */
    static createCollectible<TKEY extends string = string, TINDEX extends number = number>(params: ICollectibleConstructorParams<TKEY, TINDEX>): Result<Collectible<TKEY, TINDEX>>;
    /**
     * {@link Collections.ICollectible.setIndex}
     */
    setIndex(index: number): Result<TINDEX>;
}
//# sourceMappingURL=collectible.d.ts.map