import Dream from '../Dream.js';
import DreamSerializerBuilder from './builders/DreamSerializerBuilder.js';
/**
 * Builds a serializer for a Dream model. A serializer is a function that takes the
 * data to render and declares the keys to render it with:
 *
 * ```typescript
 * export const UserSerializer = (user: User) =>
 *   DreamSerializer(User, user).attribute('email').rendersMany('posts')
 * ```
 *
 * A serializer must not read its data while being built: what it declares may not
 * depend on its data. Dream and Psychic build it without data to read its shape (the
 * OpenAPI schema, and the null and other-variant keys of a flattened association or
 * `customAttribute` that uses it), so a serializer that reads its data while being
 * built throws when a flattened association or `customAttribute` that uses it is
 * rendered. Read the data inside a `customAttribute` callback, which runs only when
 * the serializer renders, not while it is built.
 *
 * @param dreamClass - The Dream model class the serializer renders
 * @param data - The Dream instance to render
 * @param passthroughData - Data available to this serializer and passed down to the serializers
 *   it renders
 * @returns The serializer builder for method chaining
 */
export default function DreamSerializer<DreamClass extends typeof Dream, DataType extends Dream | null, PassthroughDataType extends object | undefined = undefined>(dreamClass: DreamClass, data: DataType, passthroughData?: PassthroughDataType): DreamSerializerBuilder<DreamClass, DataType, PassthroughDataType, Exclude<DataType, null>>;