@envelop/graphql-middleware 3.4.0-alpha-26c4ae2.0 → 3.4.0-alpha-8a8cd36.0

package/README.md

@@ -0,0 +1,44 @@
+## `@envelop/graphql-middleware`
+
+This plugins wraps [`graphql-middleware`](https://github.com/maticzav/graphql-middleware) and allow you to apply schema middlewares that uses the standard defined by `graphql-middleware`.
+
+> You can find an awesome [list of middlewares here](https://github.com/maticzav/graphql-middleware#awesome-middlewares-)
+
+## Getting Started
+
+```
+yarn add graphql-middleware @envelop/graphql-middleware
+```
+
+## Usage Example
+
+You can use any type of middleware defined for `graphql-middleware`, here's an example for doing that with [`graphql-shield`](https://github.com/maticzav/graphql-shield):
+
+```ts
+import { envelop } from '@envelop/core';
+import { useGraphQLMiddleware } from '@envelop/graphql-middleware';
+import { rule, shield, and, or, not } from 'graphql-shield';
+
+// ...
+// You can find a complete example here: https://github.com/maticzav/graphql-shield#graphql-yoga
+// ...
+
+const permissions = shield({
+  Query: {
+    fruits: and(isAuthenticated, or(isAdmin, isEditor)),
+  },
+  Mutation: {
+    addFruitToBasket: isAuthenticated,
+  },
+  Fruit: isAuthenticated,
+  Customer: isAdmin,
+});
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useSchema(mySchema),
+    useGraphQLMiddleware([permissions]),
+  ],
+});
+```

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/graphql-middleware",
-  "version": "3.4.0-alpha-26c4ae2.0",
+  "version": "3.4.0-alpha-8a8cd36.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-26c4ae2.0",
+    "@envelop/core": "2.4.0-alpha-8a8cd36.0",
     "graphql-middleware": "^6.0.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },