# @lokalise/projects-engine-contracts

> API contracts and shared schemas for the Projects Engine service

Latest version **11.0.0** (published 2026-09-22) · Apache-2.0 license · 978 weekly downloads

## Install

```sh
npm install @lokalise/projects-engine-contracts
pnpm add @lokalise/projects-engine-contracts
yarn add @lokalise/projects-engine-contracts
bun add @lokalise/projects-engine-contracts
```

## Health

**Score 50/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

Negative: declining downloads.

## Facts

| | |
|---|---|
| Version | 11.0.0 |
| Published | 2026-09-22 |
| First published | 2026-04-24 |
| Weekly downloads | 978 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 134.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | bodrovis, botlokalise, kibertoad, carlos_gamero, aplokalise, filippos.mikropoulos, andrew_lokalise, dariacm, roger.gros-lokalise, catchme2, kostiantyn.khoroshailo, casamitjana, bartoszdrozd-lokalise, jhfedz |
| Keywords | projects, contracts, api, schemas |

## Links

- npm: https://www.npmjs.com/package/@lokalise/projects-engine-contracts
- Repository: https://github.com/lokalise/projects-engine
- npm.io page: https://npm.io/package/@lokalise/projects-engine-contracts

## Dependencies (2)

- [@lokalise/api-common](https://npm.io/package/@lokalise/api-common.md) ^7.1.1
- [@lokalise/content-type-app-engine-contracts](https://npm.io/package/@lokalise/content-type-app-engine-contracts.md) ^5.27.1

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads
- [sanity-zodify](https://npm.io/package/sanity-zodify.md) — 4 weekly downloads

## Recent versions

- 11.0.0 (latest) — 2026-09-22
- 10.2.3 — 2026-09-22
- 10.2.2 — 2026-09-17
- 10.2.1 — 2026-09-16
- 10.2.0 — 2026-09-15
- 10.1.0 — 2026-09-11
- 10.0.0 — 2026-09-11
- 9.3.2 — 2026-09-09
- 9.3.1 — 2026-09-04
- 9.3.0 — 2026-09-01
- 9.2.0 — 2026-09-01
- 9.1.5 — 2026-08-31
- 9.1.4 — 2026-08-26
- 9.1.3 — 2026-08-26
- 9.1.2 — 2026-08-25
- … 53 more at https://npm.io/package/@lokalise/projects-engine-contracts/versions

## README

# @lokalise/projects-engine-contracts

Shared API contracts and domain schemas for the Projects Engine service.

## Contents

### `src/apiContracts/`

Typed route contracts built with `defineApiContract` from `@lokalise/api-contracts`, one file per resource:
`projectsContracts.ts` (`getProjectsContract`, `getProjectContract`, `patchProjectContract`,
`deleteProjectContract`), plus `languageContracts.ts`, `projectSettingsContracts.ts`,
`translationSettingsContracts.ts`, `defaultReviewersContracts.ts` and `contributorsContracts.ts`.

### `src/schemas/`

The Zod schemas those contracts are assembled from — `projectSchemas.ts` (`PROJECT_SCHEMA`,
`GET_PROJECTS_QUERY_SCHEMA` with `limit`/`after`, `PROJECTS_DEFAULT_LIMIT`, `PROJECTS_MAX_LIMIT`),
`domainSchemas.ts`, `pathParamsSchemas.ts`, and one file per resource alongside them.

The project collection is cursor-paginated: `getProjectsContract` responds with the shared
`@lokalise/api-common` envelope (`data` array plus `meta: { count, cursor, hasMore }`).

## Publishing

This package is published to NPM automatically when a PR that modifies `packages/**` is merged to `main`. The version bump is driven by the PR label:

| Label          | Effect                            |
|----------------|-----------------------------------|
| `major`        | Bumps major version and publishes |
| `minor`        | Bumps minor version and publishes |
| `patch`        | Bumps patch version and publishes |
| `skip-release` | Skips publishing entirely         |

Every PR touching this package **must** carry exactly one of these labels (enforced by CI).

## Peer dependencies

This package requires `zod@^4.0.0` as a peer dependency.

## Installation

```bash
npm install @lokalise/projects-engine-contracts
```

---
_Source: https://npm.io/package/@lokalise/projects-engine-contracts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._