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

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

import * as z from "zod";
export declare const AbbreviatedPackument: z.ZodObject<{
    name: z.ZodString;
    modified: 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>>;
    versions: z.ZodRecord<z.ZodString, z.ZodObject<{
        hasInstallScript: z.ZodOptional<z.ZodBoolean>;
        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>;
        _hasShrinkwrap: z.ZodOptional<z.ZodBoolean>;
        engines: z.ZodCatch<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
        deprecated: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
        name: z.ZodString;
        version: z.ZodString;
        bin: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
        directories: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
        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>]>>;
        optionalDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
        os: z.ZodOptional<z.ZodArray<z.ZodString>>;
        cpu: z.ZodOptional<z.ZodArray<z.ZodString>>;
    }, z.core.$strip>>;
}, z.core.$strip>;
/**
`AbbreviatedPackument` (package document) describes the minimal metadata needed for installing a package.
@see {@link https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md#abbreviated-metadata-format}
*/
export type AbbreviatedPackument = z.infer<typeof AbbreviatedPackument>;
/**
`getAbbreviatedPackument` returns the abbreviated packument (package document)
containing only the metadata necessary to install a package.

@remarks
To get all the metadata (full packument) about a package see {@link getPackument}.

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

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