import { ValidateExVer } from '../../../base/lib/exver';
import * as T from '../../../base/lib/types';
/**
 * Sentinel value indicating that a migration in a given direction is not possible.
 * Use this for `migrations.up` or `migrations.down` to prevent migration.
 */
export declare const IMPOSSIBLE: unique symbol;
/**
 * Configuration options for a single service version definition.
 *
 * @typeParam Version - The string literal exver version number
 */
export type VersionOptions<Version extends string> = {
    /** The exver-compliant version number */
    version: Version & ValidateExVer<Version>;
    /** The release notes for this version */
    releaseNotes: T.LocaleString;
    /** Data migrations for this version */
    migrations: {
        /**
         * A migration from the previous version. Leave empty to indicate no migration is necessary.
         * Set to `IMPOSSIBLE` to indicate migrating from the previous version is not possible.
         */
        up?: ((opts: {
            effects: T.Effects;
        }) => Promise<void>) | typeof IMPOSSIBLE;
        /**
         * A migration to the previous version. Leave blank to indicate no migration is necessary.
         * Set to `IMPOSSIBLE` to indicate downgrades are prohibited
         */
        down?: ((opts: {
            effects: T.Effects;
        }) => Promise<void>) | typeof IMPOSSIBLE;
        /**
         * Additional migrations, such as fast-forward migrations, or migrations from other flavors.
         */
        other?: Record<string, {
            up?: (opts: {
                effects: T.Effects;
            }) => Promise<void>;
            down?: (opts: {
                effects: T.Effects;
            }) => Promise<void>;
        }>;
    };
};
/**
 * Represents a single version of the service, including its release notes,
 * migration scripts, and backwards-compatibility declarations.
 *
 * By convention, each version gets its own file (e.g. `versions/v1_0_0.ts`).
 *
 * @typeParam Version - The string literal exver version number
 */
export declare class VersionInfo<Version extends string> {
    readonly options: VersionOptions<Version> & {
        satisfies: string[];
    };
    private _version;
    private constructor();
    /**
     * @description Use this function to define a new version of the service. By convention, each version should receive its own file.
     * @property {string} version
     * @property {string} releaseNotes
     * @property {object} migrations
     * @returns A VersionInfo class instance that is exported, then imported into versions/index.ts.
     */
    static of<Version extends string>(options: VersionOptions<Version>): VersionInfo<Version>;
    /** Specify a version that this version is 100% backwards compatible to */
    satisfies<V extends string>(version: V & ValidateExVer<V>): VersionInfo<Version>;
}