query-registry/dist/get-packument.d.ts

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

import * as z from "zod";
export declare const Packument: z.ZodObject<{
    _id: z.ZodString;
    name: z.ZodString;
    "dist-tags": z.ZodObject<{
        latest: z.ZodString;
        next: z.ZodOptional<z.ZodString>;
        alpha: z.ZodOptional<z.ZodString>;
        beta: z.ZodOptional<z.ZodString>;
        rc: z.ZodOptional<z.ZodString>;
        canary: z.ZodOptional<z.ZodString>;
        dev: z.ZodOptional<z.ZodString>;
    }, z.core.$catchall<z.ZodString>>;
    time: z.ZodObject<{
        created: z.ZodString;
        modified: z.ZodString;
    }, z.core.$catchall<z.ZodString>>;
    versions: z.ZodRecord<z.ZodString, 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>>;
    _rev: z.ZodOptional<z.ZodCoercedString<unknown>>;
    users: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
    readme: z.ZodOptional<z.ZodString>;
    readmeFilename: z.ZodOptional<z.ZodString>;
    license: z.ZodOptional<z.ZodString>;
    homepage: z.ZodOptional<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>]>>>;
    repository: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
        type: z.ZodString;
        url: z.ZodString;
        directory: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>]>>;
}, z.core.$strip>;
/**
`Packument` (package document) describes the full metadata available about a package.
@see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#getpackage}
@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#package}
*/
export type Packument = z.infer<typeof Packument>;
/**
`getPackument` returns the full packument (package document)
containing all the metadata available about a package.

@remarks
To get only the metadata needed to install a package (abbreviated packument)
see {@link getAbbreviatedPackument}.

@param name - package name
@param registry - URL of the registry (default: npm registry)

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