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

Basic types used by pnpm

export interface Dependencies {
    [name: string]: string;
}
export declare type PackageBin = string | {
    [commandName: string]: string;
};
export declare 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;
        node?: string;
    };
}
export interface PublishConfig extends Record<string, unknown> {
    directory?: string;
    executableFiles?: string[];
}
declare type Version = string;
declare type Pattern = string;
export interface TypesVersions {
    [version: Version]: {
        [pattern: Pattern]: string[];
    };
}
export interface BaseManifest {
    name?: string;
    version?: string;
    bin?: PackageBin;
    description?: string;
    directories?: {
        bin?: string;
    };
    dependencies?: Dependencies;
    devDependencies?: Dependencies;
    optionalDependencies?: Dependencies;
    peerDependencies?: Dependencies;
    peerDependenciesMeta?: PeerDependenciesMeta;
    dependenciesMeta?: DependenciesMeta;
    bundleDependencies?: string[];
    bundledDependencies?: string[];
    homepage?: string;
    repository?: string | {
        url: string;
    };
    scripts?: PackageScripts;
    config?: object;
    engines?: {
        node?: string;
        npm?: string;
        pnpm?: string;
    };
    cpu?: string[];
    os?: string[];
    main?: string;
    module?: string;
    typings?: string;
    types?: string;
    publishConfig?: PublishConfig;
    typesVersions?: TypesVersions;
    readme?: string;
    keywords?: string[];
    author?: string;
    license?: string;
}
export declare type DependencyManifest = BaseManifest & Required<Pick<BaseManifest, 'name' | 'version'>>;
export declare type PackageExtension = Pick<BaseManifest, 'dependencies' | 'optionalDependencies' | 'peerDependencies' | 'peerDependenciesMeta'>;
export interface PeerDependencyRules {
    ignoreMissing?: string[];
    allowedVersions?: Record<string, string>;
}
export declare type ProjectManifest = BaseManifest & {
    pnpm?: {
        neverBuiltDependencies?: string[];
        onlyBuiltDependencies?: string[];
        overrides?: Record<string, string>;
        packageExtensions?: Record<string, PackageExtension>;
        peerDependencyRules?: PeerDependencyRules;
    };
    private?: boolean;
    resolutions?: Record<string, string>;
};
export declare type PackageManifest = DependencyManifest & {
    deprecated?: string;
};
export {};