import type { ExactReturn, OptionalArgIfUndefined } from "./types.js";
import { AsyncMapperSchemaValue, AsyncObjectMapperFunction, AsyncObjectMapperSchema } from "./async-types.js";
/**
 * Convert from one type of object to another.
 *
 * Instantiate an instance with a {@linkcode AsyncObjectMapperSchema}. You must pass two type parameters:
 *
 * - `TInput`: the type of the input object
 * - `TOutput`: the type of the desired output object
 *
 * You can pass an optional third type parameter:
 *
 * - `TContext`: an object with any additional data or functions. Useful when mapping multiple
 *   objects with some shared state, like a "now" timestamp.
 *
 * Invoke the mapper with {@linkcode AsyncObjectMapper#map}.
 *
 * If you want a plain (unbound) function, you can call {@linkcode AsyncObjectMapper#toFunction}.
 *
 * There is a convenience method {@linkcode AsyncObjectMapper#array}, for mapping some iterable to an array.
 *
 * @group async
 */
export declare class AsyncObjectMapper<TInput extends object, TOutput extends object, TContext extends object | undefined = undefined> {
    /**
     * Defines how to populate property on the output type.
     */
    readonly schema: AsyncObjectMapperSchema<TInput, TOutput, TContext>;
    /**
     * Create an AsyncObjectMapper factory function. Invoke it immediately,
     *  with an object mapper schema, to create an AsyncObjectMapper instance.
     *
     * We use this approach to trick TypeScript into requiring an exact type
     *  to be passed in. That is, the object mapper schema must only have
     *  properties that exist in the output type, and no additional properties.
     */
    static create<TInput extends object, TOutput extends object, TContext extends object | undefined = undefined>(): <TActualSchema extends AsyncObjectMapperSchema<TInput, TOutput, TContext> & { [P in Exclude<keyof TActualSchema, keyof TOutput>]: never; }>(schema: TActualSchema) => AsyncObjectMapper<TInput, TOutput, TContext>;
    /**
     * For faster runtime performance, the object mapper schema is converted to
     *  a Map instance.
     * @private
     */
    protected readonly schemaMap: Map<keyof TOutput, AsyncMapperSchemaValue<TInput, TOutput, TContext>>;
    protected constructor(
    /**
     * Defines how to populate property on the output type.
     */
    schema: AsyncObjectMapperSchema<TInput, TOutput, TContext>);
    /**
     * Map multiple input objects from some iterable, and return an
     *  array of output objects.
     */
    array(input: Iterable<TInput>, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput[]>>;
    /**
     * Map multiple input objects from some iterable, and return an
     *  array of output objects.
     *
     * If the input is `null`, it will be returned as-is.
     */
    array(input: Iterable<TInput> | null, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput[]> | null>;
    /**
     * Map multiple input objects from some iterable, and return an
     *  array of output objects.
     *
     * If the input is `undefined`, it will be returned as-is.
     */
    array(input: Iterable<TInput> | undefined, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput[]> | undefined>;
    /**
     * Map multiple input objects from some iterable, and return an
     *  array of output objects.
     *
     * If the input is `null` or `undefined`, it will be returned as-is.
     */
    array(input: Iterable<TInput> | null | undefined, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput[]> | null | undefined>;
    /**
     * Maps an input object to an output object.
     *
     * It does so by iterating each property in the object schema,
     *  and invoking the property's mapping function, passing the input and context.
     */
    map(input: TInput, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput>>;
    /**
     * Maps an input object to an output object.
     *
     * It does so by iterating each property in the object schema,
     *  and invoking the property's mapping function, passing the input and context.
     *
     * If {@linkcode input} is `null`, it will be returned as-is.
     */
    map(input: TInput | null, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput> | null>;
    /**
     * Maps an input object to an output object.
     *
     * It does so by iterating each property in the object schema,
     *  and invoking the property's mapping function, passing the input and context.
     *
     * If {@linkcode input} is `undefined`, it will be returned as-is.
     */
    map(input: TInput | undefined, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput> | undefined>;
    /**
     * Maps an input object to an output object.
     *
     * It does so by iterating each property in the object schema,
     *  and invoking the property's mapping function, passing the input and context.
     *
     * If {@linkcode input} is `null` or `undefined`, it will be returned as-is.
     */
    map(input: TInput | null | undefined, context: OptionalArgIfUndefined<TContext>): Promise<ExactReturn<TOutput> | null | undefined>;
    /**
     * Wrap this instance in a function, with a `schema` property.
     */
    toFunction(): AsyncObjectMapperFunction<TInput, TOutput, TContext>;
}
//# sourceMappingURL=async-object-mapper.d.ts.map