import { SpawnOptions, ExecFileOptions } from "child_process";
import { RequestInit, Response } from "node-fetch";

export interface NPMCommandOptions {
  buffer?: boolean;
  npmBinPath?: string;
}

export interface NPMSpawnOptions extends NPMCommandOptions, SpawnOptions {}

export interface NPMExecOptions extends NPMCommandOptions, ExecFileOptions {
  buffer: true;
}

export function npmCommand(args: string | string[], options: NPMExecOptions): Promise<[string, string]>;
export function npmCommand(options: NPMExecOptions): Promise<[string, string]>;
export function npmCommand(args: string | string[], options?: NPMSpawnOptions): Promise<void>;
export function npmCommand(options?: NPMSpawnOptions): Promise<void>;

export function npmInstall(packages: string | string[], options: NPMExecOptions): Promise<[string, string]>;
export function npmInstall(options: NPMExecOptions): Promise<[string, string]>;
export function npmInstall(packages: string | string[], options?: NPMSpawnOptions): Promise<void>;
export function npmInstall(options?: NPMSpawnOptions): Promise<void>;

export function npxInstall(args: string | string[], options: NPMExecOptions): Promise<[string, string]>;
export function npxInstall(options: NPMExecOptions): Promise<[string, string]>;
export function npxInstall(args: string | string[], options?: NPMSpawnOptions): Promise<void>;
export function npxInstall(options?: NPMSpawnOptions): Promise<void>;

export interface PackageRegistry {
  name?: string;
  publishConfig?: {
    registry?: string;
  };
}

export const defaultRegistryUrl: string;

/**
 * Gets a registry URL for a given package. Passing in a string of the package name will look up the registry in NPM
 * config files. Passing the package.json object in will get the publish registry, which includes the publishConfig.
 */
export function getRegistry(pkg: string | PackageRegistry, cwd?: string): string | undefined;

export interface RegistryRequestOptions extends RequestInit {
  /** Base registry url that is used when the url argument is missing a host. */
  registry?: string;
}

export function registryRequest(url: string, options?: RegistryRequestOptions): Promise<Response>;

type StringOrRecordOfStrings<T extends string> = string | Partial<Record<T, string>>;

export interface Package {
  [key: string]: any;
  name: string;
  version: string;
  description?: string;
  keywords?: string[];
  bugs?: Partial<Record<"url" | "email", string>>;
  license?: StringOrRecordOfStrings<"type" | "url">;
  homepage?: string;
  author?: StringOrRecordOfStrings<"name" | "email" | "url">;
  private?: boolean;
  main?: string;
  browser?: string;
  gitHead?: string;
  repository?: StringOrRecordOfStrings<"type" | "url" | "directory">;
  publishConfig?: {
    [key: string]: any;
    registry?: string;
  };
  dependencies?: Partial<Record<string, string>>;
  devDependencies?: Partial<Record<string, string>>;
  peerDependencies?: Partial<Record<string, string>>;
  optionalDependencies?: Partial<Record<string, string>>;
  files?: string[];
  bin?: StringOrRecordOfStrings<string>;
  man?: string | string[];
  directories?: Partial<Record<"lib" | "bin" | "man" | "doc" | "example" | "test", string>>;
  scripts?: Partial<Record<string, string>>;
  config?: Partial<Record<string, string>>;
  engines?: Partial<Record<string, string>>;
  os?: string[];
  cpu?: string[];
}

export interface PackageInfo {
  name: string;
  description?: string;
  "dist-tags": {
    [tag: string]: string;
  };
  versions: {
    [version: string]: Package;
  };
  time: {
    [version: string]: string;
  };
  readme?: string;
  readmeFilename?: string;
  keywords?: string[];
  license?: string;
}

export function fetchPackageInfo(registry: string | undefined, name: string): Promise<PackageInfo | undefined>;

export function getVersion(info: PackageInfo, tags?: string | string[]): string | undefined;

export function getRelease(info: PackageInfo, tags?: string | string[]): Package | undefined;

export function fetchRelease(
  registry: string | undefined,
  name: string,
  tags?: string | string[]
): Promise<Package | undefined>;