/**
 * @copyright Sister Software
 * @license AGPL-3.0
 * @author Teffen Ellis, et al.
 *
 *   The frozen record of sources that contributed rows to one corpus build.
 *   It also records the applicable terms.
 *
 *   Its digest is over the manifest with `contentDigest` emptied, so two builds over identical inputs
 *   produce the same digest. A change to a source, its elected grant, row count or recipe changes the digest.
 */
import { LicenseReviewState, type LicenseDecision, type SourceOperation } from "#source-register/types";
/**
 * What one source contributed to a build.
 *
 * Also records what the build had established about its terms.
 */
export interface TrainingSourceRecord {
    /**
     * The adapter id stamped into every row's `source`, and the join key to the register's `sourceID`.
     */
    source: string;
    /**
     * Rows this source contributed after license exclusion and eligibility but before augmentation.
     * A synthetic row counts under the source it was fanned from.
     */
    rows: number;
    license: string;
    /**
     * The register's decision for that license when the build ran, or `null`
     * when the register contains no decision for it.
     */
    decision: {
        licenseID: string;
        state: LicenseReviewState;
        electedTerms: string | null;
        /**
         * The operations the elected grant permitted at build time.
         *
         * An operation absent here was `unreviewed` or `refused`, which the decision records separately.
         */
        permitted: SourceOperation[];
    } | null;
}
/**
 * One corpus build's frozen source record.
 */
export interface TrainingManifest {
    manifestID: "corpus-training-manifest";
    schemaVersion: 1;
    corpusVersion: string;
    builtAt: string;
    /**
     * The build profile, so a reader can tell a corpus whose sources were checked
     * from one whose sources were not.
     */
    profile: string;
    /**
     * Sources in descending row order.
     */
    sources: TrainingSourceRecord[];
    /**
     * Sources the build refused, with the reasons, so the record shows what was
     * left out as well as what went in.
     *
     * Each key is `<adapter id>:<ISO 3166-1 alpha-2>`, the pair that addresses one register source,
     * because one adapter can emit several jurisdictions and each carries its own license decision.
     */
    refused: Record<string, readonly string[]>;
    totalRows: number;
    /**
     * Sha256 over this manifest with `contentDigest` emptied.
     */
    contentDigest: string;
}
/**
 * The digest a manifest should include, computed over the manifest with its digest field emptied.
 */
export declare function trainingManifestDigest(manifest: TrainingManifest): string;
/**
 * Freeze one build's source observations into a manifest.
 *
 * A license absent from the decision table records `decision: null` rather than being omitted,
 * so a build that read an unregistered adapter stays distinguishable from one that read no source.
 */
export declare function freezeTrainingManifest(input: {
    corpusVersion: string;
    builtAt: string;
    profile: string;
    rowsBySource: ReadonlyMap<string, {
        rows: number;
        license: string;
    }>;
    decisionsByLicense: ReadonlyMap<string, LicenseDecision>;
    refused: ReadonlyMap<string, readonly string[]>;
}): TrainingManifest;
/**
 * Everything wrong with a training manifest, one message per problem.
 *
 * The digest check is what makes the record frozen rather than merely written.
 */
export declare function auditTrainingManifest(manifest: TrainingManifest): string[];
/**
 * The sources in a manifest whose terms did not permit an operation
 * when the build ran, with the reason for each.
 */
export declare function sourcesNotPermitting(manifest: TrainingManifest, operation: SourceOperation): Array<{
    source: string;
    because: string;
}>;
//# sourceMappingURL=training-manifest.d.ts.map