@envelop/generic-auth 4.3.1 → 4.3.2-alpha-1eb54ef.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@envelop/generic-auth",
-  "version": "4.3.1",
+  "version": "4.3.2-alpha-1eb54ef.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^2.4.1",
+    "@envelop/core": "2.4.2-alpha-1eb54ef.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/extended-validation": "^1.7.1"
+    "@envelop/extended-validation": "1.7.2-alpha-1eb54ef.0"
   },
   "repository": {
     "type": "git",
@@ -26,7 +26,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {
@@ -40,7 +40,7 @@
     },
     "./*": {
       "require": {
-        "types": "./typings/*.d.ts",
+        "types": "./typings/*.d.cts",
         "default": "./cjs/*.js"
       },
       "import": {

package/typings/index.d.cts

@@ -0,0 +1,80 @@
+import { DefaultContext, Maybe, Plugin, PromiseOrValue } from '@envelop/core';
+import { DirectiveNode, FieldNode, GraphQLError, GraphQLObjectType } from 'graphql';
+export declare class UnauthenticatedError extends GraphQLError {
+}
+export declare type ResolveUserFn<UserType, ContextType = DefaultContext> = (context: ContextType) => PromiseOrValue<Maybe<UserType>>;
+export declare type ValidateUserFnParams<UserType> = {
+    /** The user object. */
+    user: UserType;
+    /** The field node from the operation that is being validated. */
+    fieldNode: FieldNode;
+    /** The object type which has the field that is being validated. */
+    objectType: GraphQLObjectType;
+    /** The directive node used for the authentication (If using an SDL flow). */
+    fieldAuthDirectiveNode: DirectiveNode | undefined;
+    /** The extensions used for authentication (If using an extension based flow). */
+    fieldAuthExtension: unknown | undefined;
+};
+export declare type ValidateUserFn<UserType> = (params: ValidateUserFnParams<UserType>) => void | UnauthenticatedError;
+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 = DefaultContext, CurrentUserKey extends string = 'currentUser'> = {
+    /**
+     * Here you can implement any custom sync/async code, and use the context built so far in Envelop and the HTTP request
+     * to find the current user.
+     * Common practice is to use a JWT token here, validate it, and use the payload as-is, or fetch the user from an external services.
+     * Make sure to either return `null` or the user object.
+     */
+    resolveUserFn: ResolveUserFn<UserType, ContextType>;
+    /**
+     * Overrides the default field name for injecting the user into the execution `context`.
+     * @default currentUser
+     */
+    contextFieldName?: CurrentUserKey;
+} & ({
+    /**
+     * 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 or extension field for marking a field available for unauthorized users.
+     * @default skipAuth
+     */
+    directiveOrExtensionFieldName?: 'skipAuth' | string;
+    /**
+     * Customize how the user is validated. E.g. apply authorization role based validation.
+     * The validation is applied during the extended validation phase.
+     * @default `defaultProtectAllValidateFn`
+     */
+    validateUser?: ValidateUserFn<UserType>;
+} | {
+    /**
+     * Just resolves the user and inject to authenticated user into the `context`.
+     * User validation needs to be implemented by you, in your resolvers.
+     */
+    mode: 'resolve-only';
+} | {
+    /**
+     * resolves the user and inject to authenticated user into the `context`.
+     * And checks for `@auth` directives usages to run validation automatically.
+     */
+    mode: 'protect-granular';
+    /**
+     * Overrides the default directive name or extension field for marking a field available only for authorized users.
+     * @default auth
+     */
+    directiveOrExtensionFieldName?: 'auth' | string;
+    /**
+     * Customize how the user is validated. E.g. apply authorization role based validation.
+     * The validation is applied during the extended validation phase.
+     * @default `defaultProtectSingleValidateFn`
+     */
+    validateUser?: ValidateUserFn<UserType>;
+});
+export declare function defaultProtectAllValidateFn<UserType>(params: ValidateUserFnParams<UserType>): void | UnauthenticatedError;
+export declare function defaultProtectSingleValidateFn<UserType>(params: ValidateUserFnParams<UserType>): void | UnauthenticatedError;
+export declare const useGenericAuth: <UserType extends {} = {}, ContextType = DefaultContext, CurrentUserKey extends string = "currentUser">(options: GenericAuthPluginOptions<UserType, ContextType, CurrentUserKey>) => Plugin<{
+    validateUser: ValidateUserFn<UserType>;
+} & Record<CurrentUserKey, UserType>>;