lens/src/common/catalog-entity.ts

export interface CatalogCategoryVersion {
  name: string;
  entityClass: { new(data: CatalogEntityData): CatalogEntity };
}

export interface CatalogCategory {
  apiVersion: string;
  kind: string;
  metadata: {
    name: string;
    icon: string;
  }
  spec: {
    group: string;
    versions: CatalogCategoryVersion[];
    names: {
      kind: string;
    }
  }
  getId: () => string;
}

export type CatalogEntityMetadata = {
  uid: string;
  name: string;
  description?: string;
  source?: string;
  labels: {
    [key: string]: string;
  }
  [key: string]: string | object;
};

export type CatalogEntityStatus = {
  phase: string;
  reason?: string;
  message?: string;
  active?: boolean;
};

export interface CatalogEntityActionContext {
  navigate: (url: string) => void;
  setCommandPaletteContext: (context?: CatalogEntity) => void;
}

export type CatalogEntityContextMenu = {
  icon: string;
  title: string;
  onlyVisibleForSource?: string; // show only if empty or if matches with entity source
  onClick: () => Promise<void>;
  confirm?: {
    message: string;
  }
};

export type CatalogEntitySettingsMenu = {
  group?: string;
  title: string;
  components: {
    View: React.ComponentType<any>
  };
};

export interface CatalogEntityContextMenuContext {
  navigate: (url: string) => void;
  menuItems: CatalogEntityContextMenu[];
}

export interface CatalogEntitySettingsContext {
  menuItems: CatalogEntityContextMenu[];
}

export interface CatalogEntityAddMenuContext {
  navigate: (url: string) => void;
  menuItems: CatalogEntityContextMenu[];
}

export type CatalogEntityData = {
  apiVersion: string;
  kind: string;
  metadata: CatalogEntityMetadata;
  status: CatalogEntityStatus;
  spec: {
    [key: string]: any;
  }
};

export interface CatalogEntity extends CatalogEntityData {
  getId: () => string;
  getName: () => string;
  onRun: (context: CatalogEntityActionContext) => Promise<void>;
  onDetailsOpen: (context: CatalogEntityActionContext) => Promise<void>;
  onContextMenuOpen: (context: CatalogEntityContextMenuContext) => Promise<void>;
  onSettingsOpen?: (context: CatalogEntitySettingsContext) => Promise<void>;
}