/**
 * @license
 * Copyright DagonMetric. All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found under the LICENSE file in the root directory of this source tree.
 */
/**
 * Template variables definition.
 */
export interface TplVar {
    [key: string]: string;
}
/**
 * The `when` or `skip` options to apply only if it equals with user input option.
 */
export interface WhenOrSkipOptions {
    [option: string]: boolean | string;
}
/**
 * Transliterate sub-rule item.
 * @additionalProperties false
 */
export interface TranslitSubRuleItem {
    /**
     * Description for the rule item.
     */
    description?: string;
    /**
     * Regular expression pattern for input string searching.
     * @minLength 1
     */
    from: string;
    /**
     * The value to replace the matched string.
     */
    to: string;
    /**
     * Start index for searching. Set `-1` for skipping the rule. It works only when `postRulesStrategy` is `startMatch`.
     * @minimum -1
     */
    start?: number;
    /**
     * Apply the rule only if `when` options and user options are met.
     */
    when?: WhenOrSkipOptions;
    /**
     * Apply the rule only if `skip` options and user options are met.
     */
    skip?: WhenOrSkipOptions;
    /**
     * Group code for grouping `or` items.
     */
    orGroup?: string;
}
/**
 * Post rules looping and matching strategy.
 */
export declare type PostRulesStrategy = 'startMatch' | 'whileMatch';
/**
 * Transliterate rule item.
 * @additionalProperties false
 */
export interface TranslitRuleItem {
    /**
     * Description for the rule item.
     */
    description?: string;
    /**
     * Regular expression pattern for input string searching.
     * @minLength 1
     */
    from: string;
    /**
     * The value to replace the matched string.
     */
    to?: string;
    /**
     * Minimum input string length matching for quick checking purpose.
     * @minimum 1
     */
    minLength?: number;
    /**
     * Array of input string character and index position matching for quick checking purpose.
     */
    quickTests?: [string, number][];
    /**
     * Set `true` to replace only if there was any converted left part characters, set `false` for reverse purpose checking.
     */
    hasLeft?: boolean;
    /**
     * Regular expression pattern for checking converted left part string.
     */
    left?: string;
    /**
     * Regular expression pattern for checking right part string after input string matching.
     */
    right?: string;
    /**
     * Apply the rule only if `when` options and user options are met.
     */
    when?: WhenOrSkipOptions;
    /**
     * Apply the rule only if `skip` options and user options are met.
     */
    skip?: WhenOrSkipOptions;
    /**
     * Sub-rule items to be processed after replaced.
     * @minItems 1
     */
    postRules?: TranslitSubRuleItem[];
    /**
     * The key value pair of `orGroup` and `start` index for `postRules` items.
     */
    postRulesStart?: {
        [orGroup: string]: number;
    };
    /**
     * Set the name defined in `postRulesDef` for referencing post rules.
     */
    postRulesRef?: string;
    /**
     * Post rules looping and matching strategy. Default is `startMatch`.
     */
    postRulesStrategy?: PostRulesStrategy;
}
/**
 * Transliterate rule phase.
 * @additionalProperties false
 */
export interface TranslitRulePhase {
    /**
     * Array of Transliterate rule items.
     * @minItems 1
     */
    rules: TranslitRuleItem[];
    /**
     * Description for the rule phase.
     */
    description?: string;
    /**
     * Phase level template variables definition.
     */
    tplVar?: TplVar;
    /**
     * Template loop/sequence variables definition.
     */
    tplSeq?: {
        [key: string]: [string, string, number][];
    };
    /**
     * Post rules definitions to be used with `postRulesRef`.
     */
    postRulesDef?: {
        [key: string]: TranslitSubRuleItem[];
    };
    /**
     * Apply the phase only if `when` options and user options are met.
     */
    when?: WhenOrSkipOptions;
    /**
     * Apply the phase only if `skip` options and user options are met.
     */
    skip?: WhenOrSkipOptions;
}
/**
 * Transliterate rule.
 * @additionalProperties false
 */
export interface TranslitRule {
    /**
     * Link to schema file.
     */
    $schema?: string;
    /**
     * Description for the rule.
     */
    description?: string;
    /**
     * The version for the rule.
     */
    version?: string;
    /**
     * Global template variables definition.
     */
    tplVar?: TplVar;
    /**
     * Transliterate rule phases.
     * @minItems 1
     */
    phases: TranslitRulePhase[];
}
/**
 * Transliterate rule phases.
 * @minItems 1
 */
export declare type TranslitRulePhases = TranslitRulePhase[];
/**
 * Transliterate rule items.
 * @minItems 1
 */
export declare type TranslitRuleItems = TranslitRuleItem[];
export declare type TranslitRuleAny = TranslitRule | TranslitRulePhases | TranslitRuleItems;