ts-pkgx
Version:
A library & CLI for managing packages
84 lines • 2.4 kB
TypeScript
import { } from './version-utils';
import type { PackageInfo, PackageName, SupportedArchitecture, SupportedPlatform } from './package-types';
/**
* Show detailed information about a package
*/
export declare function showPackageInfo(packageName: string): Promise<CLIResult<PackageInfo>>;
/**
* Search for packages by name or description
*/
export declare function searchPackagesCommand(searchTerm: string): Promise<CLIResult<PackageInfo[]>>;
/**
* List popular packages
*/
export declare function listPopularPackages(limit?: number): Promise<CLIResult<PackageInfo[]>>;
/**
* List recently active packages
*/
export declare function listActivePackages(limit?: number): Promise<CLIResult<PackageInfo[]>>;
/**
* List all available package aliases
*/
export declare function listAliases(): CLIResult<string[]>;
/**
* Validate a package specification
*/
export declare function validatePackage(packageSpec: string): Promise<CLIResult<{
packageName: PackageName
version?: string
isValid: boolean
}>>;
/**
* Create an installation plan for a package
*/
export declare function createInstallPlan(packageSpec: string): Promise<CLIResult<InstallationPlan>>;
/**
* Get version information for a package
*/
export declare function getVersionInfo(packageName: string): Promise<CLIResult<{
latest: string
total: number
versions: string[]
}>>;
/**
* Format package info for CLI display
*/
export declare function formatPackageInfo(info: PackageInfo): string;
/**
* Format search results for CLI display
*/
export declare function formatSearchResults(results: PackageInfo[]): string;
/**
* Format installation plan for CLI display
*/
export declare function formatInstallPlan(plan: InstallationPlan): string;
/**
* Get system information relevant to package installation
*/
export declare function getSystemInfo(): CLIResult<{
platform: SupportedPlatform
architecture: SupportedArchitecture
isSupported: boolean
nodeVersion: string
}>;
/**
* CLI command result interface
*/
export declare interface CLIResult<T = any> {
success: boolean
data?: T
error?: string
warnings?: string[]
}
/**
* Package installation plan
*/
export declare interface InstallationPlan {
packageName: PackageName
resolvedVersion: string
platform: SupportedPlatform
architecture: SupportedArchitecture
dependencies: string[]
companions: string[]
installCommand: string
}