zod-package-json

!Language

Zod 4 schema for the package.json file format.

This package exports a Zod and a Zod mini schema (and the inferred TypeScript type) named PackageJson
that can parse most well-formed package.json files.

The schema includes all currently supported properties listed in the
npm docs
as well as additional well-known properties specific to TypeScript and Node.js.

The schema also preserves unknown properties, which can be accessed
by indexing the parsed data with the desired string keys.

The schema only validates the known properties against their expected type
but does not do any additional normalization such as merging similar properties.
If necessary, that can be done by extending the schema with Zod methods such as
.transform() or .refine().

Useful resources

- Explore the API on jsDocs.io
- View package contents on unpkg
- View repository on GitHub
- Read the changelog on GitHub

Install

> [!NOTE]
> Make sure you have Zod v4 installed in your application to use this package.

Using npm:

``
npm add zod zod-package-json
`

Using yarn:

`
yarn add zod zod-package-json
`

Using pnpm:

`
pnpm add zod zod-package-json
`

Using bun:

`
bun add zod zod-package-json
`

Usage examples

To use the classic Zod schema:

`typescript
import { PackageJson } from "zod-package-json";

// Parse data from a package.json file.
const packageJson = PackageJson.parse({
name: "foo",
version: "1.0.0",
unknownProp: "who knows",
});

// Access a known property.
packageJson.name; // "foo"

// Access an unknown property.
packageJson["unknownProp"]; // "who knows"
`

To use the Zod mini schema:

`typescript
import { PackageJson } from "zod-package-json/mini";

// Parse data from a package.json file.
const packageJson = PackageJson.parse({
name: "foo",
version: "1.0.0",
unknownProp: "who knows",
});

// Access a known property.
packageJson.name; // "foo"

// Access an unknown property.
packageJson["unknownProp"]; // "who knows"
`

License

`
MIT
``

Copyright (c) 2025 Edoardo Scibona

See LICENSE file.