@pnpm/types/lib/package.d.ts

Basic types used by pnpm

import type { Registries } from './misc.js';
export type Dependencies = Record<string, string>;
export type PackageBin = string | {
    [commandName: string]: string;
};
export type PackageScripts = {
    [name: string]: string;
} & {
    prepublish?: string;
    prepare?: string;
    prepublishOnly?: string;
    prepack?: string;
    postpack?: string;
    publish?: string;
    postpublish?: string;
    preinstall?: string;
    install?: string;
    postinstall?: string;
    preuninstall?: string;
    uninstall?: string;
    postuninstall?: string;
    preversion?: string;
    version?: string;
    postversion?: string;
    pretest?: string;
    test?: string;
    posttest?: string;
    prestop?: string;
    stop?: string;
    poststop?: string;
    prestart?: string;
    start?: string;
    poststart?: string;
    prerestart?: string;
    restart?: string;
    postrestart?: string;
    preshrinkwrap?: string;
    shrinkwrap?: string;
    postshrinkwrap?: string;
};
export interface PeerDependenciesMeta {
    [dependencyName: string]: {
        optional?: boolean;
    };
}
export interface DependenciesMeta {
    [dependencyName: string]: {
        injected?: boolean;
        patch?: string;
    };
}
export interface EngineDependency {
    name: string;
    version?: string;
    onFail?: 'ignore' | 'warn' | 'error' | 'download';
}
type DevEngineKey = 'os' | 'cpu' | 'libc' | 'runtime' | 'packageManager';
export type DevEngines = Partial<Record<DevEngineKey, EngineDependency | EngineDependency[]>>;
export interface PublishConfig extends Record<string, unknown> {
    directory?: string;
    linkDirectory?: boolean;
    executableFiles?: string[];
    registry?: string;
}
type Version = string;
type Pattern = string;
export interface TypesVersions {
    [version: Version]: {
        [pattern: Pattern]: string[];
    };
}
export interface BaseManifest {
    name?: string;
    version?: string;
    type?: string;
    bin?: PackageBin;
    description?: string;
    directories?: {
        bin?: string;
    };
    files?: string[];
    funding?: string;
    dependencies?: Dependencies;
    devDependencies?: Dependencies;
    optionalDependencies?: Dependencies;
    peerDependencies?: Dependencies;
    peerDependenciesMeta?: PeerDependenciesMeta;
    dependenciesMeta?: DependenciesMeta;
    bundleDependencies?: string[] | boolean;
    bundledDependencies?: string[] | boolean;
    homepage?: string;
    repository?: string | {
        url: string;
    };
    bugs?: string | {
        url?: string;
        email?: string;
    };
    scripts?: PackageScripts;
    config?: Record<string, unknown>;
    engines?: {
        node?: string;
        npm?: string;
        pnpm?: string;
    } & Pick<DevEngines, 'runtime'>;
    devEngines?: DevEngines;
    cpu?: string[];
    os?: string[];
    libc?: string[];
    main?: string;
    module?: string;
    typings?: string;
    types?: string;
    publishConfig?: PublishConfig;
    typesVersions?: TypesVersions;
    readme?: string;
    keywords?: string[];
    author?: string;
    license?: string;
    exports?: Record<string, string>;
    imports?: Record<string, unknown>;
}
export interface DependencyManifest extends BaseManifest {
    name: string;
    version: string;
}
export type PackageExtension = Pick<BaseManifest, 'dependencies' | 'optionalDependencies' | 'peerDependencies' | 'peerDependenciesMeta'>;
export interface PeerDependencyRules {
    ignoreMissing?: string[];
    allowAny?: string[];
    allowedVersions?: Record<string, string>;
}
export type AllowedDeprecatedVersions = Record<string, string>;
type VersionWithIntegrity = string;
/**
 * Old format (inline integrity in pnpm-workspace.yaml):
 *   "@my-org/cfg": "1.2.0+sha512-XYZ"
 *   or { tarball: "...", integrity: "1.2.0+sha512-XYZ" }
 *
 * New format (plain specifiers in pnpm-workspace.yaml, integrity in pnpm-lock.yaml):
 *   "@my-org/cfg": "^1.2.0"
 */
export type ConfigDependencies = Record<string, VersionWithIntegrity | {
    tarball?: string;
    integrity: VersionWithIntegrity;
}>;
/**
 * Clean specifiers for configDependencies in pnpm-workspace.yaml (new format).
 * Integrity info is stored in pnpm-lock.yaml instead.
 */
export type ConfigDependencySpecifiers = Record<string, string>;
export interface AuditConfig {
    ignoreGhsas?: string[];
}
export interface PnpmSettings {
    npmrcAuthFile?: string;
    registries?: Registries;
    configDependencies?: ConfigDependencies;
    allowBuilds?: Record<string, boolean | string>;
    overrides?: Record<string, string>;
    packageExtensions?: Record<string, PackageExtension>;
    ignoredOptionalDependencies?: string[];
    peerDependencyRules?: PeerDependencyRules;
    allowedDeprecatedVersions?: AllowedDeprecatedVersions;
    allowUnusedPatches?: boolean;
    patchedDependencies?: Record<string, string>;
    updateConfig?: {
        ignoreDependencies?: string[];
    };
    auditConfig?: AuditConfig;
    requiredScripts?: string[];
    supportedArchitectures?: SupportedArchitectures;
    nodeDownloadMirrors?: Record<string, string>;
    httpProxy?: string;
    httpsProxy?: string;
    noProxy?: string | boolean;
}
export interface ProjectManifest extends BaseManifest {
    packageManager?: string;
    workspaces?: string[];
    private?: boolean;
    resolutions?: Record<string, string>;
}
export interface PackageManifest extends DependencyManifest {
    deprecated?: string;
}
/**
 * Subset of package.json fields cached in the store index.
 * Used for bin linking, build scripts, runtime selection, and dependency resolution.
 */
export type BundledManifest = Pick<BaseManifest, 'bin' | 'bundledDependencies' | 'bundleDependencies' | 'cpu' | 'dependencies' | 'devDependencies' | 'directories' | 'engines' | 'libc' | 'name' | 'optionalDependencies' | 'os' | 'peerDependencies' | 'peerDependenciesMeta' | 'scripts' | 'version'>;
export interface SupportedArchitectures {
    os?: string[];
    cpu?: string[];
    libc?: string[];
}
export {};