/*
 * Copyright 2020 Spotify AB
 *
 * 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 type { Entity } from '@backstage/catalog-model';
import { Logger } from 'winston';

export type PreparerBase = {
  /**
   * Given an Entity definition from the Service Catalog, go and prepare a directory
   * with contents from the location in temporary storage and return the path
   * @param entity The entity from the Service Catalog
   */
  prepare(entity: Entity, opts?: { logger: Logger }): Promise<string>;
};

export type PreparerBuilder = {
  register(protocol: RemoteProtocol, preparer: PreparerBase): void;
  get(entity: Entity): PreparerBase;
};

export type RemoteProtocol =
  | 'dir'
  | 'github'
  | 'gitlab'
  | 'file'
  | 'azure/api'
  | 'url';
