query-registry/dist/get-package-manifest.d.ts

Query the npm registry for packuments, manifests, packages and download counts

import * as z from "zod";
export declare const PackageManifest: z.ZodObject<{
    _id: z.ZodString;
    dist: z.ZodObject<{
        tarball: z.ZodString;
        shasum: z.ZodString;
        integrity: z.ZodOptional<z.ZodString>;
        fileCount: z.ZodOptional<z.ZodNumber>;
        unpackedSize: z.ZodOptional<z.ZodNumber>;
        "npm-signature": z.ZodOptional<z.ZodString>;
        signatures: z.ZodOptional<z.ZodArray<z.ZodObject<{
            keyid: z.ZodString;
            sig: z.ZodString;
        }, z.core.$strip>>>;
    }, z.core.$strip>;
    readme: z.ZodOptional<z.ZodString>;
    readmeFilename: z.ZodOptional<z.ZodString>;
    gitHead: z.ZodOptional<z.ZodString>;
    _hasShrinkwrap: z.ZodOptional<z.ZodBoolean>;
    _nodeVersion: z.ZodOptional<z.ZodString>;
    _npmVersion: z.ZodOptional<z.ZodString>;
    _npmUser: z.ZodOptional<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        name: z.ZodString;
        email: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>>;
    _npmOperationalInternal: z.ZodOptional<z.ZodObject<{
        host: z.ZodOptional<z.ZodString>;
        tmp: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>;
    engines: z.ZodCatch<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
    license: z.ZodCatch<z.ZodOptional<z.ZodString>>;
    homepage: z.ZodCatch<z.ZodOptional<z.ZodString>>;
    deprecated: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
    type: z.ZodCatch<z.ZodOptional<z.ZodLiteral<"module" | "commonjs">>>;
    name: z.ZodString;
    version: z.ZodString;
    description: z.ZodOptional<z.ZodString>;
    keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
    bugs: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        url: z.ZodOptional<z.ZodString>;
        email: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>;
    author: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        name: z.ZodString;
        email: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>;
    contributors: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        name: z.ZodString;
        email: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>>;
    maintainers: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        name: z.ZodString;
        email: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>>;
    funding: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        url: z.ZodString;
        type: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        url: z.ZodString;
        type: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>]>>;
    files: z.ZodOptional<z.ZodArray<z.ZodString>>;
    exports: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodString, z.ZodArray<z.ZodString>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
    main: z.ZodOptional<z.ZodString>;
    browser: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>]>>;
    bin: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
    man: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
    directories: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    repository: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        type: z.ZodString;
        url: z.ZodString;
        directory: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>;
    scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    peerDependenciesMeta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
        optional: z.ZodBoolean;
    }, z.core.$strip>>>;
    bundleDependencies: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
    bundledDependencies: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
    optionalDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    overrides: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    os: z.ZodOptional<z.ZodArray<z.ZodString>>;
    cpu: z.ZodOptional<z.ZodArray<z.ZodString>>;
    libc: z.ZodOptional<z.ZodString>;
    devEngines: z.ZodOptional<z.ZodObject<{
        cpu: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>>]>>;
        os: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>>]>>;
        libc: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>>]>>;
        runtime: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>>]>>;
        packageManager: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
            name: z.ZodString;
            version: z.ZodOptional<z.ZodString>;
            onFail: z.ZodOptional<z.ZodLiteral<"ignore" | "warn" | "error">>;
        }, z.core.$strip>>]>>;
    }, z.core.$strip>>;
    private: z.ZodOptional<z.ZodBoolean>;
    publishConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    workspaces: z.ZodOptional<z.ZodArray<z.ZodString>>;
    module: z.ZodOptional<z.ZodString>;
    types: z.ZodOptional<z.ZodString>;
    typings: z.ZodOptional<z.ZodString>;
    typesVersions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>>;
    packageManager: z.ZodOptional<z.ZodString>;
    sideEffects: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
    imports: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
}, z.core.$strip>;
/**
`PackageManifest` describes the manifest for a specific version of a package (e.g., `foo@1.0.0`).

@remarks
The manifest contains data extracted from `package.json` as well as data generated by the registry.

@see {@link https://docs.npmjs.com/cli/v10/configuring-npm/package-json}
@see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#getpackageversion}
@see {@link https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md#abbreviated-version-object}
@see {@link https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md#full-metadata-format}
@see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#version}
*/
export type PackageManifest = z.infer<typeof PackageManifest>;
/**
`getPackageManifest` returns the manifest describing a specific version of a package (e.g., `foo@1.0.0`).

@param name - package name
@param versionOrTag - semver version number (e.g., `1.0.0`) or distribution tag (e.g., `latest`) (default: `latest`)
@param registry - URL of the registry (default: npm registry)

@see {@link PackageManifest}
*/
export declare function getPackageManifest(name: string, versionOrTag?: string, registry?: string): Promise<PackageManifest>;