# graphql-shield

> GraphQL Server permissions as another layer of abstraction!

Latest version **7.6.5** (published 2022-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install graphql-shield
pnpm add graphql-shield
yarn add graphql-shield
bun add graphql-shield
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.6.5 |
| Published | 2022-11-22 |
| First published | 2018-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 78.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matic Zavadlal |
| Maintainers | dotansimha, maticzav, saihaj, graphql-authz |

## Links

- npm: https://www.npmjs.com/package/graphql-shield
- Repository: https://github.com/maticzav/graphql-shield
- Issues: https://github.com/maticzav/graphql-shield/issues
- npm.io page: https://npm.io/package/graphql-shield

## Dependencies (4)

- [yup](https://npm.io/package/yup.md) ^0.32.0
- [tslib](https://npm.io/package/tslib.md) ^2.4.0
- [@types/yup](https://npm.io/package/@types/yup.md) 0.29.13
- [object-hash](https://npm.io/package/object-hash.md) ^3.0.0

## Recent versions

- 7.6.5 (latest) — 2022-11-22
- 8.0.0-alpha-20221215200711-24c1953 (alpha) — 2022-12-15
- 3.0.0-beta (next) — 2018-08-28
- 8.0.0-alpha-20221214190806-3953778 — 2022-12-14
- 8.0.0-alpha-20221214185453-335ce4c — 2022-12-14
- 8.0.0-alpha-20221127163606-0a537b9 — 2022-11-27
- 7.6.5-alpha-20221122185642-d59dda0 — 2022-11-22
- 7.6.4 — 2022-10-28
- 7.6.3 — 2022-10-17
- 7.6.3-alpha-20221013161836-7522a9f — 2022-10-13
- 7.6.3-alpha-20221013154153-ccafe90 — 2022-10-13
- 7.6.3-alpha-20221013120629-ebfd83d — 2022-10-13
- 7.6.3-alpha-20221010152516-b34c741 — 2022-10-10
- 7.6.3-alpha-20221010152214-fe69b7a — 2022-10-10
- 7.6.3-alpha-20221010012441-56c6c85 — 2022-10-10
- … 148 more at https://npm.io/package/graphql-shield/versions

## README

<p align="center"><img src="media/shield.jpg" width="300"/></p>

# graphql-shield

[![CircleCI](https://circleci.com/gh/maticzav/graphql-shield/tree/master.svg?style=shield)](https://circleci.com/gh/maticzav/graphql-shield/tree/master)
[![codecov](https://codecov.io/gh/maticzav/graphql-shield/branch/master/graph/badge.svg)](https://codecov.io/gh/maticzav/graphql-shield)
[![npm version](https://badge.fury.io/js/graphql-shield.svg)](https://badge.fury.io/js/graphql-shield)
[![Backers on Open Collective](https://opencollective.com/graphql-shield/backers/badge.svg)](#backers)[![Sponsors on Open Collective](https://opencollective.com/graphql-shield/sponsors/badge.svg)](#sponsors)

> GraphQL Server permissions as another layer of abstraction!

## Overview

GraphQL Shield helps you create a permission layer for your application. Using an intuitive rule-API, you'll gain the power of the shield engine on every request and reduce the load time of every request with smart caching. This way you can make sure your application will remain quick, and no internal data will be exposed.

## Features

- ✂️ **Flexible:** Based on [GraphQL Middleware](https://github.com/prismagraphql/graphql-middleware).
- 🤝 **Compatible:** Works with all GraphQL Servers.
- 🚀 **Smart:** Intelligent V8 Shield engine caches all your requests to prevent any unnecessary load.
- 🎯 **Per-Type or Per-Field:** Write permissions for your schema, types or specific fields (check the example below).

## Documentation

You can find extensive documentation at [https://the-guild.dev/graphql/shield](https://the-guild.dev/graphql/shield).

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](https://github.com/maticzav/graphql-shield/graphs/contributors)].
<a href="https://github.com/maticzav/graphql-shield/graphs/contributors"><img src="https://opencollective.com/graphql-shield/contributors.svg?width=890&button=false" /></a>

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/graphql-shield#backer)]

<a href="https://opencollective.com/graphql-shield#backers" target="_blank"><img src="https://opencollective.com/graphql-shield/backers.svg?width=890"></a>

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/graphql-shield#sponsor)]

<a href="https://opencollective.com/graphql-shield/sponsor/0/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/1/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/2/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/3/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/4/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/5/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/6/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/7/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/8/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/graphql-shield/sponsor/9/website" target="_blank"><img src="https://opencollective.com/graphql-shield/sponsor/9/avatar.svg"></a>

## Contributing

We are always looking for people to help us grow `graphql-shield`! If you have an issue, feature request, or pull request, let us know! For information about development setup and more, see [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT @ Matic Zavadlal

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