/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */
import { type InterdependencyRange, type VersionBumpType } from "@fluid-tools/version-tools";
import { MonoRepo } from "@fluidframework/build-tools";
import type { Context } from "./library/index.js";
import type { ReleaseGroup } from "./releaseGroups.js";
/**
 * Flub configuration that is expected in the flub config file or package.json.
 */
export interface FlubConfig {
    /**
     * The version of the config.
     *
     * IMPORTANT: this will become required in a future release.
     *
     * @remarks
     *
     * For backwards-compatibility with the fluidBuild config file - that is, supporting both the flub config and the
     * fluidBuild config in the same config file - this value must match the version value of the
     * fluidBuildConfig. Once they diverge, the flub config must be separate from the fluidBuild config.
     *
     * In other words, version 1 is the only version of the configs where they can be stored in the same file.
     */
    version?: 1;
    /**
     * Ponfiguration for the `check:policy` command.
     */
    policy?: PolicyConfig;
    /**
     * Configuration for assert tagging.
     * @remarks
     * Some of this applies to the root where flub is being run,
     * and some of it applies to the specific package being processed.
     * @privateRemarks
     * It seems like having each package have its own configuration would be simpler.
     */
    assertTagging?: AssertTaggingConfig;
    /**
     * Configuration for `flub bump`.
     */
    bump?: BumpConfig;
    /**
     * A mapping of branch names to previous version baseline styles. The type test generator takes this information
     * into account when calculating the baseline version to use when it's run on a particular branch. If this is not
     * defined for a branch or package, then that package will be skipped during type test generation.
     *
     * @deprecated This setting is no longer used and will be removed in the future.
     */
    branchReleaseTypes?: {
        [name: string]: VersionBumpType | PreviousVersionStyle;
    };
    /**
     * Configuration for the `generate:releaseNotes` command.
     */
    releaseNotes?: ReleaseNotesConfig;
    /**
     * Configuration for `release report` command
     */
    releaseReport?: ReleaseReportConfig;
}
/**
 * Configuration for the `release report` command. If this configuration is not present in the config, the
 * `release report` command will report an error.
 */
export interface ReleaseReportConfig {
    /**
     * Each key in the `legacyCompatInterval` object represents a specific release group or package name as string,
     * and the associated value is a number that defines the legacy compatibility interval for that group.
     */
    legacyCompatInterval: Record<ReleaseGroup | string, number>;
}
/**
 * A type representing the different version constraint styles we use when determining the previous version for type
 * test generation.
 *
 * The "base" versions are calculated by zeroing out all version segments lower than the base. That is, for a version v,
 * the baseMajor version is `${v.major}.0.0` and the baseMinor version is `${v.major}.${v.minor}.0`.
 *
 * The "previous" versions work similarly, but the major/minor/patch segment is reduced by 1. That is, for a version v,
 * the previousMajor version is `${min(v.major - 1, 1)}.0.0`, the previousMinor version is
 * `${v.major}.${min(v.minor - 1, 0)}.0`, and the previousPatch is `${v.major}.${v.minor}.${min(v.patch - 1, 0)}.0`.
 *
 * The "previous" versions never roll back below 1 for the major version and 0 for minor and patch. That is, the
 * previousMajor, previousMinor, and previousPatch versions for `1.0.0` are all `1.0.0`.
 *
 * @example
 *
 * Given the version 2.3.5:
 *
 * baseMajor: 2.0.0
 * baseMinor: 2.3.0
 * ~baseMinor: ~2.3.0
 * previousPatch: 2.3.4
 * previousMinor: 2.2.0
 * previousMajor: 1.0.0
 * ^previousMajor: ^1.0.0
 * ^previousMinor: ^2.2.0
 * ~previousMajor: ~1.0.0
 * ~previousMinor: ~2.2.0
 *
 * @example
 *
 * Given the version 2.0.0-internal.2.3.5:
 *
 * baseMajor: 2.0.0-internal.2.0.0
 * baseMinor: 2.0.0-internal.2.3.0
 * ~baseMinor: \>=2.0.0-internal.2.3.0 \<2.0.0-internal.3.0.0
 * previousPatch: 2.0.0-internal.2.3.4
 * previousMinor: 2.0.0-internal.2.2.0
 * previousMajor: 2.0.0-internal.1.0.0
 * ^previousMajor: \>=2.0.0-internal.1.0.0 \<2.0.0-internal.2.0.0
 * ^previousMinor: \>=2.0.0-internal.2.2.0 \<2.0.0-internal.3.0.0
 * ~previousMajor: \>=2.0.0-internal.1.0.0 \<2.0.0-internal.1.1.0
 * ~previousMinor: \>=2.0.0-internal.2.2.0 \<2.0.0-internal.2.2.0
 *
 * @example
 *
 * Given the version 2.0.0-internal.2.0.0:
 *
 * baseMajor: 2.0.0-internal.2.0.0
 * baseMinor: 2.0.0-internal.2.0.0
 * ~baseMinor: \>=2.0.0-internal.2.0.0 \<2.0.0-internal.2.1.0
 * previousPatch: 2.0.0-internal.2.0.0
 * previousMinor: 2.0.0-internal.2.0.0
 * previousMajor: 2.0.0-internal.1.0.0
 * ^previousMajor: \>=2.0.0-internal.1.0.0 \<2.0.0-internal.2.0.0
 * ^previousMinor: \>=2.0.0-internal.2.0.0 \<2.0.0-internal.3.0.0
 * ~previousMajor: \>=2.0.0-internal.1.0.0 \<2.0.0-internal.1.1.0
 * ~previousMinor: \>=2.0.0-internal.2.0.0 \<2.0.0-internal.2.1.0
 */
export type PreviousVersionStyle = "baseMajor" | "baseMinor" | "previousPatch" | "previousMinor" | "previousMajor" | "~baseMinor" | "^previousMajor" | "^previousMinor" | "~previousMajor" | "~previousMinor";
/**
 * A short name for the section. Each section in a {@link ReleaseNotesConfig} must have a unique name.
 */
export type ReleaseNotesSectionName = string;
/**
 * Configuration for a release notes section.
 */
export interface ReleaseNotesSection {
    /**
     * A full string to serve as the heading for the section when displayed in release notes.
     */
    heading: string;
}
/**
 * Configuration for the `generate:releaseNotes` command. If this configuration is not present in the config, the
 * `generate:releaseNotes` command will report an error.
 */
export interface ReleaseNotesConfig {
    sections: Record<ReleaseNotesSectionName, ReleaseNotesSection>;
}
/**
 * Policy configuration for the `check:policy` command.
 */
export interface PolicyConfig {
    additionalLockfilePaths?: string[];
    pnpmSinglePackageWorkspace?: string[];
    fluidBuildTasks: {
        tsc: {
            ignoreTasks: string[];
            ignoreDependencies: string[];
            ignoreDevDependencies: string[];
        };
    };
    dependencies?: {
        commandPackages: [string, string][];
    };
    /**
     * An array of strings/regular expressions. Paths that match any of these expressions will be completely excluded from
     * policy-check.
     */
    exclusions?: string[];
    /**
     * An object with handler name as keys that maps to an array of strings/regular expressions to
     * exclude that rule from being checked.
     */
    handlerExclusions?: {
        [rule: string]: (string | RegExp)[];
    };
    packageNames?: PackageNamePolicyConfig;
    /**
     * (optional) requirements to enforce against each public package.
     */
    publicPackageRequirements?: PackageRequirements;
}
/**
 * Used by `TagAssertsCommand`.
 */
export interface AssertTaggingConfig {
    /**
     * An array of paths under which assert tagging applies to. If this setting is provided, only packages whose paths
     * match the regular expressions in this setting will be assert-tagged.
     *
     * This is used from the root where flub is run.
     * TODO: this should be replaced by package selection flags passed to the command.
     */
    enabledPaths?: RegExp[];
}
/**
 * Configuration settings that influence `flub bump`.
 */
export interface BumpConfig {
    /**
     * The interdependencyRange controls the type of semver range to use between packages in the same release group. This
     * setting controls the default range that will be used when updating the version of a release group. The default can
     * be overridden using the `--interdependencyRange` flag in the `flub bump` command.
     */
    defaultInterdependencyRange?: Record<ReleaseGroup, InterdependencyRange>;
}
/**
 * Configuration for package naming and publication policies.
 */
export interface PackageNamePolicyConfig {
    /**
     * A list of package scopes that are permitted in the repo.
     */
    allowedScopes?: string[];
    /**
     * A list of packages that have no scope.
     */
    unscopedPackages?: string[];
    /**
     * Packages that must be published.
     */
    mustPublish: {
        /**
         * A list of package names or scopes that must publish to npm, and thus should never be marked private.
         */
        npm?: string[];
        /**
         * A list of package names or scopes that must publish to an internal feed, and thus should always be marked
         * private.
         */
        internalFeed?: string[];
    };
    /**
     * Packages that may or may not be published.
     */
    mayPublish: {
        /**
         * A list of package names or scopes that may publish to npm, and thus might or might not be marked private.
         */
        npm?: string[];
        /**
         * A list of package names or scopes that must publish to an internal feed, and thus might or might not be marked
         * private.
         */
        internalFeed?: string[];
    };
}
/**
 * Expresses requirements for a given package, applied to its package.json.
 */
export interface PackageRequirements {
    /**
     * (optional) list of script requirements for the package.
     */
    requiredScripts?: ScriptRequirement[];
    /**
     * (optional) list of required dev dependencies for the package.
     * @remarks Note: there is no enforcement of version requirements, only that a dependency on the specified name must exist.
     */
    requiredDevDependencies?: string[];
}
/**
 * Requirements for a given script.
 */
export interface ScriptRequirement {
    /**
     * Name of the script to check.
     */
    name: string;
    /**
     * Body of the script being checked.
     * A contents match will be enforced iff {@link ScriptRequirement.bodyMustMatch}.
     * This value will be used as the default contents inserted by the policy resolver (regardless of {@link ScriptRequirement.bodyMustMatch}).
     */
    body: string;
    /**
     * Whether or not the script body is required to match {@link ScriptRequirement.body} when running the policy checker.
     * @defaultValue `false`
     */
    bodyMustMatch?: boolean;
}
/**
 * Get an IFlubConfig from the flub property in a package.json file, or from flub.config.[c]js.
 *
 * @param configPath - The path to start searching for the config file. If a path to a file is provided, the file will
 * be loaded directly. Otherwise it will search upwards looking for config files until it finds one.
 * @param noCache - If true, the config cache will be cleared and the config will be reloaded.
 * @returns The flub config
 */
export declare function getFlubConfig(configPath: string, noCache?: boolean): FlubConfig;
/**
 * Convenience function to extract the default interdependency range for a release group from the flub config. For
 * back-compat, it will also load the relevant setting from the fluid-build config.
 */
export declare function getDefaultInterdependencyRange(releaseGroup: ReleaseGroup | MonoRepo, context: Context): InterdependencyRange;
//# sourceMappingURL=config.d.ts.map