/*
 * Copyright 2021 The Backstage Authors
 *
 * 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.
 */

import { DocumentCollator, DocumentDecorator } from '@backstage/search-common';

/**
 * Parameters required to register a collator.
 */
export interface RegisterCollatorParameters {
  /**
   * The default interval (in seconds) that the provided collator will be called (can be overridden in config).
   */
  defaultRefreshIntervalSeconds: number;

  /**
   * The collator class responsible for returning all documents of the given type.
   */
  collator: DocumentCollator;
}

/**
 * Parameters required to register a decorator
 */
export interface RegisterDecoratorParameters {
  /**
   * The decorator class responsible for appending or modifying documents of the given type(s).
   */
  decorator: DocumentDecorator;
}
