@envelop/generic-auth 1.1.0-alpha-6952fd9.0 → 1.2.2-alpha-1e6c37b.0

package/README.md

@@ -72,7 +72,7 @@ Now, configure your plugin based on the mode you wish to use:
 
 #### Option #1 - `protect-all`
 
-This mode offers complete protection for the entire API. It protects your entire GraphQL schema by validating the user before executing the request.
+This mode offers complete protection for the entire API. It protects your entire GraphQL schema by validating the user before executing the request. You can optionally skip auth validation for specific GraphQL fields by using the `@skipAuth` directive.
 
 To setup this mode, use the following config:
 
@@ -102,6 +102,22 @@ const getEnveloped = envelop({
 });
 ```
 
+> By default, we assume that you have the GraphQL directive definition as part of your GraphQL schema (`directive @skipAuth on FIELD_DEFINITION`).
+
+Then, in your GraphQL schema SDL, you can add `@skipAuth` directive to your fields, and the `validateUser` will not get called while resolving that specific field:
+
+```graphql
+type Query {
+  me: User!
+  protectedField: String
+  publicField: String @skipAuth
+}
+```
+
+> You can apply that directive to any GraphQL `field` definition, not only to root fields.
+
+> If you are using a different directive for authentication, you can pass `authDirectiveName` configuration to customize it.
+
 #### Option #2 - `resolve-only`
 
 This mode uses the plugin to inject the authenticated user into the `context`, and later you can verify it in your resolvers.

package/index.d.ts

@@ -1,4 +1,4 @@
-import { DefaultContext, Plugin } from '@envelop/types';
+import { DefaultContext, Plugin } from '@envelop/core';
 import { DirectiveNode, GraphQLError, GraphQLResolveInfo } from 'graphql';
 export * from './utils';
 export declare class UnauthenticatedError extends GraphQLError {
@@ -11,6 +11,7 @@ export declare type ValidateUserFn<UserType, ContextType = DefaultContext> = (us
     info: GraphQLResolveInfo;
 }, directiveNode?: DirectiveNode) => void | Promise<void>;
 export declare const DIRECTIVE_SDL = "\n  directive @auth on FIELD_DEFINITION\n";
+export declare const SKIP_AUTH_DIRECTIVE_SDL = "\n  directive @skipAuth on FIELD_DEFINITION\n";
 export declare type GenericAuthPluginOptions<UserType extends {} = {}, ContextType extends DefaultContext = DefaultContext> = {
     /**
      * Here you can implement any custom sync/async code, and use the context built so far in Envelop and the HTTP request
@@ -33,8 +34,14 @@ export declare type GenericAuthPluginOptions<UserType extends {} = {}, ContextTy
     /**
      * This mode offers complete protection for the entire API.
      * It protects your entire GraphQL schema, by validating the user before executing the request.
+     * You can skip the validation using `@skipAuth` directive on a specific field.
      */
     mode: 'protect-all';
+    /**
+     * Overrides the default directive name
+     * @default skipAuth
+     */
+    authDirectiveName?: 'skipAuth' | string;
 } | {
     /**
      * Just resolves the user and inject to authenticated user into the `context`.

package/index.js

@@ -19,6 +19,9 @@ class UnauthenticatedError extends graphql.GraphQLError {
 const DIRECTIVE_SDL = /* GraphQL */ `
   directive @auth on FIELD_DEFINITION
 `;
+const SKIP_AUTH_DIRECTIVE_SDL = /* GraphQL */ `
+  directive @skipAuth on FIELD_DEFINITION
+`;
 function defaultValidateFn(user, contextType) {
     if (!user) {
         throw new UnauthenticatedError('Unauthenticated!');
@@ -31,11 +34,21 @@ const useGenericAuth = (options) => {
         return {
             async onContextBuilding({ context, extendContext }) {
                 const user = await options.resolveUserFn(context);
-                await validateUser(user, context);
                 extendContext({
                     [fieldName]: user,
+                    validateUser,
                 });
             },
+            onExecute() {
+                return {
+                    async onResolverCalled({ args, root, context, info }) {
+                        const authDirectiveNode = getDirective(info, options.authDirectiveName || 'skipAuth');
+                        if (authDirectiveNode)
+                            return;
+                        await context.validateUser(context[fieldName], context);
+                    },
+                };
+            },
         };
     }
     else if (options.mode === 'resolve-only') {
@@ -79,6 +92,7 @@ const useGenericAuth = (options) => {
 };
 
 exports.DIRECTIVE_SDL = DIRECTIVE_SDL;
+exports.SKIP_AUTH_DIRECTIVE_SDL = SKIP_AUTH_DIRECTIVE_SDL;
 exports.UnauthenticatedError = UnauthenticatedError;
 exports.defaultValidateFn = defaultValidateFn;
 exports.getDirective = getDirective;

package/index.mjs

@@ -15,6 +15,9 @@ class UnauthenticatedError extends GraphQLError {
 const DIRECTIVE_SDL = /* GraphQL */ `
   directive @auth on FIELD_DEFINITION
 `;
+const SKIP_AUTH_DIRECTIVE_SDL = /* GraphQL */ `
+  directive @skipAuth on FIELD_DEFINITION
+`;
 function defaultValidateFn(user, contextType) {
     if (!user) {
         throw new UnauthenticatedError('Unauthenticated!');
@@ -27,11 +30,21 @@ const useGenericAuth = (options) => {
         return {
             async onContextBuilding({ context, extendContext }) {
                 const user = await options.resolveUserFn(context);
-                await validateUser(user, context);
                 extendContext({
                     [fieldName]: user,
+                    validateUser,
                 });
             },
+            onExecute() {
+                return {
+                    async onResolverCalled({ args, root, context, info }) {
+                        const authDirectiveNode = getDirective(info, options.authDirectiveName || 'skipAuth');
+                        if (authDirectiveNode)
+                            return;
+                        await context.validateUser(context[fieldName], context);
+                    },
+                };
+            },
         };
     }
     else if (options.mode === 'resolve-only') {
@@ -74,4 +87,4 @@ const useGenericAuth = (options) => {
     return {};
 };
 
-export { DIRECTIVE_SDL, UnauthenticatedError, defaultValidateFn, getDirective, useGenericAuth };
+export { DIRECTIVE_SDL, SKIP_AUTH_DIRECTIVE_SDL, UnauthenticatedError, defaultValidateFn, getDirective, useGenericAuth };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@envelop/generic-auth",
-  "version": "1.1.0-alpha-6952fd9.0",
+  "version": "1.2.2-alpha-1e6c37b.0",
   "sideEffects": false,
   "peerDependencies": {
+    "@envelop/core": "1.6.6-alpha-1e6c37b.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "repository": {
@@ -26,6 +27,7 @@
     "./*": {
       "require": "./*.js",
       "import": "./*.mjs"
-    }
+    },
+    "./package.json": "./package.json"
   }
 }