/**********************************************************************
 * Copyright (C) 2025 Red Hat, Inc.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 ***********************************************************************/

// handle the context information of the docker contexts
// https://docs.docker.com/engine/manage-resources/contexts/
export interface DockerContextInfo {
  name: string;
  isCurrentContext: boolean;
  metadata: {
    description: string;
  };
  endpoints: {
    docker: {
      host: string;
    };
  };
}

// omit current context as it is coming from another source
// disabling the rule as we're not only extending the interface but omitting one field
// but the rule is not able to understand that
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
export interface DockerContextParsingInfo extends Omit<DockerContextInfo, 'isCurrentContext'> {}

export interface DockerExtensionApi {
  createContext: (context: DockerContextParsingInfo) => Promise<void>;
  removeContext: (context: string) => Promise<void>;
}
