/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

export interface NameGeneratorOptions {
  // common
  reservedNames?: Set<string>;

  // hex name generator
  hexLength?: number;
  hexWithPrefixSuffix?: boolean;

  // dictionary name generator
  dictionaryList?: string[];

  // underline name generator
  underlineMaxLength?: number;
}

/**
 * @desc interface for name generator, use factory model
 */
export interface INameGenerator {
  /**
   * @desc get name from generator.
   * @return unique name generated
   */
  getName(): string;

  /**
   * @desc reset name generator
   */
  reset(): void;
}