# @forge/manifest

> Definitions and validations of the Forge manifest

Latest version **13.9.0** (published 2026-11-09) · SEE LICENSE IN LICENSE.txt license · 83.0K weekly downloads

## Install

```sh
npm install @forge/manifest
pnpm add @forge/manifest
yarn add @forge/manifest
bun add @forge/manifest
```

## Health

**Score 75/100 (B)** — status: active.

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

## Facts

| | |
|---|---|
| Version | 13.9.0 |
| Published | 2026-11-09 |
| First published | 2020-09-03 |
| Weekly downloads | 83.0K |
| License | SEE LICENSE IN LICENSE.txt |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Atlassian |
| Maintainers | atlassianartifactteam |

## Links

- npm: https://www.npmjs.com/package/@forge/manifest
- npm.io page: https://npm.io/package/@forge/manifest

## Dependencies (9)

- [ajv](https://npm.io/package/ajv.md) ^8.18.0
- [glob](https://npm.io/package/glob.md) ^13.0.0
- [yaml](https://npm.io/package/yaml.md) ^2.3.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [cheerio](https://npm.io/package/cheerio.md) ^1.2.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.35
- [@forge/i18n](https://npm.io/package/@forge/i18n.md) 1.0.1
- [ajv-formats](https://npm.io/package/ajv-formats.md) 2.1.1
- [@sentry/node](https://npm.io/package/@sentry/node.md) 7.106.0

## Recent versions

- 13.9.0 (latest) — 2026-11-09
- 13.9.1-next.2-experimental-ea0dc44 (experimental) — 2026-11-19
- 13.9.1-next.2 (next) — 2026-11-18
- 13.9.1-next.2-experimental-aab0b34 — 2026-11-19
- 13.9.1-next.1-experimental-f59888d — 2026-11-18
- 13.9.1-next.1-experimental-55abb77 — 2026-11-18
- 13.9.1-next.1-experimental-c04e853 — 2026-11-17
- 13.9.1-next.1-experimental-a5f8a43 — 2026-11-16
- 13.9.1-next.1 — 2026-11-15
- 13.9.1-next.0 — 2026-11-11
- 13.9.0-next.8 — 2026-11-09
- 13.9.0-next.7 — 2026-11-08
- 13.9.0-next.6 — 2026-11-06
- 13.9.0-next.5 — 2026-11-02
- 13.9.0-next.4 — 2026-11-02
- … 1294 more at https://npm.io/package/@forge/manifest/versions

## README

# Forge manifest validation

> Package used to parse and validate the `manifest.yml` file of Forge apps.

## How to use the library

Use it as follows:

```typescript
import { ProcessorBuilder, ValidationTypes } from '@forge/manifest';

const results = ProcessorBuilder.instance()
  .withValidation(ValidationTypes.FULL)
  .build()
  .process();

console.log(`Valid manifest ? ${results.success}`);
```

## Simple Trigger Scopes Validation

For validating trigger event scopes, use the simple validation API that only requires the event name and scopes:

```typescript
import { validateTriggerScopes } from '@forge/manifest';

// Simple: just pass event and scopes
const result = await validateTriggerScopes(
  'avi:jira:assigned:issue',
  ['read:jira-work']
);

if (!result.valid) {
  console.error(`Missing scopes: ${result.missingScopes.join(', ')}`);
}
```

This is useful for:
- External tools that need to verify scope requirements
- Any service that validates event-scope mappings

## How to check the errors

In case of an invalid `manifest.yml`, the following information will be populated:

```typescript
export interface ValidationError {
  message: string;
  reference: string;
  level: 'error' | 'warning';
  line?: number;
  column?: number;
}

export interface ManifestValidationResult {
  success: boolean;
  errors?: ValidationError[];
}
```

## Updating Manifest schemas
The schemas in this package are automatically updated from Shipyard daily. Any manual changes to these files will be reverted. Please raise a PR in [app-host-artifacts](https://bitbucket.org/atlassian/app-host-artifacts/src/master/) instead.

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