/**
 * !!!! IMPORTANT !!!!
 * Changes made to interfaces here can affect custom changelog rendering done by end-user.
 */
import type { ChangeType } from './ChangeInfo';
/**
 * Entry ("comment") in CHANGELOG.json from a change file or dependent bump.
 * These objects are saved under the `ChangelogJson`'s `entries[].comments[type]`.
 *
 * (This is based on an individual `ChangeFileInfo` from ./ChangeInfo.ts, but with some different
 * naming and details.)
 */
export interface ChangelogEntry {
    /** Change comment */
    comment: string;
    /** Author email */
    author: string;
    /**
     * Commit hash.
     *
     * For changelogs generated by beachball versions \>=2.36.0, should be `"not available"` for
     * bump entries, because the correct commit doesn't exist yet (see [issue](https://github.com/microsoft/beachball/issues/901)).
     *
     * Could also be `"not available"` for other commits if there was an issue determing the hash
     * at changelog generation time.
     *
     * Will be undefined if `options.change.includeCommitHashes` is false.
     */
    commit?: string;
    /** Package name the change was in */
    package: string;
    /** Extra info added to the change file via custom prompts */
    [extraInfo: string]: any;
}
/**
 * Intermediate info used to generate a CHANGELOG.json entry for an individual version.
 * Usually this is for a single package. If using grouped changelogs, it could be for multiple packages.
 */
export interface PackageChangelog {
    /** Package name (if a grouped changelog, for the primary package) */
    name: string;
    /** Version creation date */
    date: Date;
    /** Version number (if a grouped changelog, for the primary package) */
    version: string;
    /** Corresponding git tag name (if a grouped changelog, for the primary package) */
    tag: string;
    /** Changes in this version */
    comments: {
        [k in ChangeType]?: ChangelogEntry[];
    };
}
/**
 * CHANGELOG.json entry for an individual version (under `ChangelogJson`'s `entries`).
 * Usually this is for a single package. If using grouped changelogs, it could be for multiple packages.
 */
export type ChangelogJsonEntry = Omit<PackageChangelog, 'name' | 'date'> & {
    /** Version creation date as a string */
    date: string;
};
/**
 * CHANGELOG.json file contents.
 */
export interface ChangelogJson {
    /** Package name */
    name: string;
    /** Entries for each package version */
    entries: ChangelogJsonEntry[];
}
//# sourceMappingURL=ChangeLog.d.ts.map