@automapper/types/src/plugin.d.ts

AutoMapper TypeScript Type Definitions

import type { ErrorHandler, Mapping } from './core';
import type { CreateMapOptions } from './options';
import type { Dictionary } from './utils';
/**
 * How a plugin should provide
 */
export interface MapPlugin<TKey = unknown> {
    /**
     * Instruction on how a plugin should initialize a mapping for a pair of Source <> Destination
     * This method will make use of the plugin's internal storages to store information for this pair.
     *
     * @param source - a key to be used to identify the information about a particular Source
     * @param destination - a key to be used to identify the information about a particular Destination
     * @param options {CreateMapOptions} - options for when initialize a mapping (which is globally applied to this pair of Source <> Destination)
     */
    initializeMapping(source: TKey, destination: TKey, options?: CreateMapOptions): Mapping | undefined;
    /**
     * Get the Mapping for a pair of Source <> Destination
     *
     * @param source - a key to be used to identify the information about a particular Source
     * @param destination - a key to be used to identify the information about a particular Destination
     */
    getMapping(source: any, destination: any): Mapping | undefined;
    /**
     * Instantiation logic of a plugin
     */
    instantiate<TModel extends Dictionary<TModel> = any>(model: any, obj?: TModel): [instance: TModel, nestedMetadata?: any[]];
    /**
     * An optional pre-map function to prepare the source and destination before map
     *
     * @param source - a key to be used to identify the information about a particular Source
     * @param destination - a key to be used to identify the information about a particular Destination
     * @param sourceObj - a plain object that takes the shape of the source
     * @param destinationObj - a plain object that takes the shape of the destination
     */
    preMap?<TSource extends Dictionary<TSource> = any, TDestination extends Dictionary<TDestination> = any>(source: TKey, destination: TKey, sourceObj?: TSource, destinationObj?: TDestination): [TSource, TDestination];
    /**
     * An optional post-map function to post-process the destination after map
     *
     * @param destination - a key to be used to identify the information about a particular Destination
     * @param destinationObj - a plain object that takes the shape of the destination
     */
    postMap?<TDestination extends Dictionary<TDestination> = any>(destination: TKey, destinationObj?: TDestination): TDestination;
    /**
     * An optional pre-mapArray function to prepare the sourceArray before mapArray
     *
     * @param source - a key to be used to identify the information about a particular Source
     * @param sourceArr - an array of TSource
     */
    preMapArray?<TSource extends Dictionary<TSource> = any>(source: TKey, sourceArr: TSource[]): TSource[];
    /**
     * Optional method to clean up the plugin's storages
     */
    dispose?(): void;
}
/**
 * Plugin initializer
 */
export interface MapPluginInitializer<TKey = unknown> {
    (errorHandler: ErrorHandler): MapPlugin<TKey>;
}