@envelop/generic-auth - npm Package Compare versions

Comparing version 4.0.0-alpha-4519bb8.0 to 4.0.0-alpha-4ba70ab.0

package.json

 {
   "name": "@envelop/generic-auth",
-  "version": "4.0.0-alpha-4519bb8.0",
+  "version": "4.0.0-alpha-4ba70ab.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^2.0.0",
+    "@envelop/core": "2.1.0-alpha-4ba70ab.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/extended-validation": "^1.3.1"
+    "@envelop/extended-validation": "2.0.0-alpha-4ba70ab.0"
   },
@@ -12,0 +12,0 @@ "repository": {

README.md

@@ -9,5 +9,5 @@ ## `@envelop/generic-auth`
 
-- **Option #1 - Complete Protection**: protected the entire GraphQL schema from unauthenticated access.
-- **Option #2 - Manual Validation**: the plugin will just resolve the user and injects it into the `context` without validating the user.
-- **Option #3 - Automatic validation using GraphQL directives**: Look for `@auth` directive and automatically protect specific GraphQL fields.
+- **Option #1 - Complete Protection**: protected the entire GraphQL schema from unauthenticated access. Allow unauthenticated access for certain fields by annotating them with a `@skipAuth` directive or `skipAuth` field extension.
+- **Option #2 - Manual Validation**: the plugin will just resolve the user and injects it into the `context` without validating access to schema field.
+- **Option #3 - Granular field access by using schema field directives or field extensions**: Look for an `@auth` directive or `auth` extension field and automatically protect those specific GraphQL fields.
 
@@ -106,2 +106,4 @@ ## Getting Started
 
+##### Allow unauthenticated access for specific fields using a field `directive`
+
 > By default, we assume that you have the GraphQL directive definition as part of your GraphQL schema (`directive @skipAuth on FIELD_DEFINITION`).
@@ -121,4 +123,25 @@
 
-> If you are using a different directive for authentication, you can pass `authDirectiveName` configuration to customize it.
+> If you are using a different directive for authentication, you can pass `directiveOrExtensionFieldName` configuration to customize it.
 
+##### Allow unauthenticated access for specific fields using a field extension
+
+```typescript
+import { GraphQLObjectType, GraphQLInt } from 'graphql';
+
+const GraphQLQueryType = new GraphQLObjectType({
+  name: 'Query',
+  fields: {
+    foo: {
+      type: GraphQLInt,
+      resolve: () => 1,
+      extensions: {
+        skipAuth: true,
+      },
+    },
+  },
+});
+```
+
+> If you want to use a different directive for authentication, you can use the `directiveOrExtensionFieldName` configuration to customize it.
+
 #### Option #2 - `resolve-only`
@@ -169,5 +192,5 @@
 
-#### Option #3 - `protect-auth-directive`
+#### Option #3 - `protect-granular`
 
-This mode is similar to option #2, but it uses `@auth` SDL directive to automatically protect specific GraphQL fields.
+This mode is similar to option #2, but it uses the `@auth` SDL directive or `auth` field extension for protecting specific GraphQL fields.
 
@@ -194,3 +217,3 @@ ```ts
       validateUser,
-      mode: 'protect-auth-directive',
+      mode: 'protect-granular',
     }),
@@ -201,2 +224,4 @@ ],
 
+##### Protect a field using a field `directive`
+
 > By default, we assume that you have the GraphQL directive definition as part of your GraphQL schema (`directive @auth on FIELD_DEFINITION`).
@@ -216,12 +241,34 @@
 
-> If you are using a different directive for authentication, you can pass `authDirectiveName` configuration to customize it.
+> If you are using a different directive for authentication, you can pass `directiveOrExtensionFieldName` configuration to customize it.
 
+##### Protect a field using a field extension
+
+```typescript
+import { GraphQLObjectType, GraphQLInt } from 'graphql';
+
+const GraphQLQueryType = new GraphQLObjectType({
+  name: 'Query',
+  fields: {
+    foo: {
+      type: GraphQLInt,
+      resolve: () => 1,
+      extensions: {
+        auth: true,
+      },
+    },
+  },
+});
+```
+
+> If you are using a different field extension for authentication, you can pass `directiveOrExtensionFieldName` configuration to customize it.
+
 ##### Extend authentication with custom directive logic
 
-You can also specify a custom `validateUser` function and get access to the `GraphQLResolveInfo` object while using the `protect-auth-directive` mode:
+You can also specify a custom `validateUser` function and get access to a handy object while using the `protect-all` and `protect-granular` mode:
 
 ```ts
+import { GraphQLError } from 'graphql';
 import { ValidateUserFn } from '@envelop/generic-auth';
 
-const validateUser: ValidateUserFn<UserType> = async (user, context, { root, args, context, info }) => {
+const validateUser: ValidateUserFn<UserType> = async ({ user }) => {
   // Now you can use the 3rd parameter to implement custom logic for user validation, with access
@@ -231,3 +278,3 @@ // to the resolver data and information.
   if (!user) {
-    throw new Error(`Unauthenticated!`);
+    return new GraphQLError(`Unauthenticated.`);
   }
@@ -253,3 +300,3 @@ };
 
-const validateUser: ValidateUserFn<UserType> = async (user, context, { root, args, context, info }, directiveNode) => {
+const validateUser: ValidateUserFn<UserType> = async ({ user, fieldAuthDirectiveNode }) => {
   // Now you can use the 3rd parameter to implement custom logic for user validation, with access
@@ -262,3 +309,3 @@ // to the resolver data and information.
 
-  const valueNode = directiveNode.arguments.find(arg => arg.name.value === 'role').value as EnumValueNode;
+  const valueNode = fieldAuthDirectiveNode.arguments.find(arg => arg.name.value === 'role').value as EnumValueNode;
   const role = valueNode.value;
@@ -265,0 +312,0 @@

No alert changes

Improved metrics

Total package byte prevSize

26094

increased by5.51%

Number of lines in readme file

308

increased by18.01%

Dependency changes

• + Added@envelop/core@2.1.0-alpha-4ba70ab.0(transitive)

• + Added@envelop/extended-validation@2.0.0-alpha-4ba70ab.0(transitive)

• + Added@envelop/types@2.0.0(transitive)

• + Addedtslib@2.8.1(transitive)

• - Removed@envelop/core@2.6.0(transitive)

• - Removed@envelop/extended-validation@1.9.0(transitive)

• - Removed@envelop/types@2.4.0(transitive)

• - Removedtslib@2.4.0(transitive)

• Updated@envelop/extended-validation@2.0.0-alpha-4ba70ab.0