Graphql-shield NPM | npm.io

7.6.5 • Published 2 years ago

Install

Weekly downloads

139,168

License

MIT

Repository

Last release

2 years ago

graphql-shield

API

import {
  GraphQLFieldResolver,
  GraphQLScalarType,
  GraphQLTypeResolver,
  GraphQLResolveInfo,
} from 'graphql'

export type IRuleFunction = (
  parent: any,
  args: any,
  context: any,
  info: GraphQLResolveInfo,
) => Promise<boolean>

export interface IRuleTypeMap {
  [key: string]: IRuleFunction | IRuleFieldMap
}

export interface IRuleFieldMap {
  [key: string]: IRuleFunction
}

export type IRules = IRuleFunction | IRuleTypeMap

export function rule(func: IRuleFunction): IRuleFunction

export function shield(rules: IRules): IMiddleware

Example

import { GraphQLServer } from 'graphql-yoga'
import { rule, gqlShield, allow } from 'graphql-shield'

const typeDefs = `
  type Query {
    viewer: Viewer
    fruits: [Fruit!]!
  }

  type Fruit {
    name: String!
    count: Int!
  }

  type Viewer {
    cart: [Fruit!]!
  }
`

// Rules

@rule
async function isAuthenticated(parent, args, ctx, info) {
  return ctx.user !== null
}

// Permissions

const permissions = shield({
  Query: allow,
  Fruit: {
    name: allow,
    count: isAuthenticated
  }
  Viewer: isAuthenticated,
})

const server = GraphQLServer({
  typeDefs,
  resolvers,
  middlewares: [permissions],
})

server.start(() => console.log('Server is running on localhost:4000'))

License

MIT @ Matic Zavadlal

@graphql-tools/delegate @graphql-tools/wrap @graphql-tools/resolvers-composition @graphql-tools/schema @graphql-tools/utils @types/yup object-hash tslib yup

@pubngo-stack/billing-api-server graphql-fleetgrid-com niouz-api graphql-middleware-rate-limit gate-backend @genesisx/gql-federation-plg1 @genesisx/gql-utils dsdfsdfjklsdfjklsdfklj graphql2use @everything-registry/sub-chunk-1786 create-express-gql-ts walter-backend shield-rules resource-management-service happy-graphql-framework graphql-sequelize-integration graphql-yoga-prisma graphql-yoga-waterline graphql-rate-limiter graphql-rbac graphql-rate-limit graphql-shield-rules gqml next-graphql nexus-plugin-shield persimon trixian-api @apollo-waterline/policies @amnet/server @atto-byte/yoga @arck/http @automatisch/backend @britishcouncil/grizzly @coko/server @codezo/shared webiny-api-files webiny-api-security @harvestr/api-graphql @eventiva/databaseclasses @eventiva/internals @foxnfork/auth-node @genesisx/graphql-utils @grafee/shield @infinitebrahmanuniverse/nolb-graphql-s @mrapi/service @ericf89/graphql-rate-limit @mnemotix/synaptix.js @mnemotix/weever-core @knotel/authorize @graphnosql/mongoose @rana-acc/backend @pubngo-stack/billing-api-server-coupon @ops-stack/repository-api-server @ops-stack/workspaces-server @subquery/node @smartscripts/pe-auth-lib @common-stack/server-stack @pothos-examples/graphql-shield @ttoss/graphql-api @xxskyy/microbundle apicult farmingwithnature-server

7.6.3-alpha-20221010152516-b34c741

2 years ago

7.6.3-alpha-20221007172208-7dbe09d

2 years ago

8.0.0-alpha-20221214190806-3953778

2 years ago

8.0.0-alpha-20221127163606-0a537b9

2 years ago

7.6.3-alpha-20221010152214-fe69b7a

2 years ago

7.6.3-alpha-20221013120629-ebfd83d

2 years ago

7.6.3-alpha-20221013154153-ccafe90

2 years ago

7.6.3-alpha-20221010012441-56c6c85

2 years ago

8.0.0-alpha-20221214185453-335ce4c

2 years ago

7.6.3-alpha-20221009092723-76b0373

2 years ago

7.6.5-alpha-20221122185642-d59dda0

2 years ago

7.6.3-alpha-20221009084405-76b0373

2 years ago

2 years ago

8.0.0-alpha-20221215200711-24c1953

2 years ago

2 years ago

2 years ago

7.6.3-alpha-20221013161836-7522a9f

2 years ago

0.0.0-alpha-20221003194237

2 years ago

2 years ago

2 years ago

2 years ago

7.6.3-alpha-20221003195722-1106a3d

2 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.0.0-semantic-release

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago