@pothos/plugin-scope-auth/esm/global-types.d.ts

A Pothos plugin for adding scope based authorization checks to your GraphQL Schema

import type { FieldKind, FieldNullability, FieldOptionsFromKind, InferredFieldOptionKeys, InputFieldMap, InputShapeFromFields, MaybePromise, Normalize, Resolver, RootName, SchemaTypes, ShapeFromTypeParam, TypeParam } from '@pothos/core';
import type { PothosScopeAuthPlugin } from './index.js';
import type { AuthScopeMap, ContextForAuth, FieldAuthScopes, FieldGrantScopes, ForbiddenResult, ReplaceContext, ScopeAuthInitializer, ScopeAuthPluginOptions, TypeAuthScopes, TypeGrantScopes, UnauthorizedOptions } from './types.js';
declare global {
    export namespace PothosSchemaTypes {
        interface Plugins<Types extends SchemaTypes> {
            scopeAuth: PothosScopeAuthPlugin<Types>;
        }
        interface SchemaBuilderOptions<Types extends SchemaTypes> {
            scopeAuth: ScopeAuthPluginOptions<Types>;
        }
        interface V3SchemaBuilderOptions<Types extends SchemaTypes> {
            scopeAuth: never;
            scopeAuthOptions?: Omit<ScopeAuthPluginOptions<Types>, "authScopes">;
            authScopes: ScopeAuthInitializer<Types>;
        }
        interface SchemaBuilder<Types extends SchemaTypes> {
            runAuthScopes: (context: Types["Context"], scopes: AuthScopeMap<Types>, unauthorizedError?: (result: ForbiddenResult) => Error | string) => MaybePromise<void>;
        }
        interface BuildSchemaOptions<Types extends SchemaTypes> {
            disableScopeAuth?: boolean;
        }
        interface UserSchemaTypes {
            AuthScopes: {};
            AuthContexts: {};
            DefaultAuthStrategy: "all" | "any";
        }
        interface ExtendDefaultTypes<PartialTypes extends Partial<UserSchemaTypes>> {
            AuthScopes: PartialTypes["AuthScopes"] & {};
            AuthContexts: PartialTypes["AuthContexts"] & {};
            DefaultAuthStrategy: undefined extends PartialTypes["DefaultAuthStrategy"] ? "any" : PartialTypes["DefaultAuthStrategy"] & string;
        }
        interface RootTypeOptions<Types extends SchemaTypes, Type extends RootName> {
            authScopes?: TypeAuthScopes<Types, Types["Root"]>;
            grantScopes?: TypeGrantScopes<Types, Types["Root"]>;
        }
        interface ObjectTypeOptions<Types extends SchemaTypes, Shape> {
            authScopes?: TypeAuthScopes<Types, Shape>;
            grantScopes?: TypeGrantScopes<Types, Shape>;
            runScopesOnType?: boolean;
            skipInterfaceScopes?: boolean;
        }
        interface InterfaceTypeOptions<Types extends SchemaTypes, Shape> {
            authScopes?: TypeAuthScopes<Types, Shape>;
            grantScopes?: TypeGrantScopes<Types, Shape>;
            runScopesOnType?: boolean;
        }
        interface FieldOptions<Types extends SchemaTypes, ParentShape, Type extends TypeParam<Types>, Nullable extends FieldNullability<Type>, Args extends InputFieldMap, ResolveShape, ResolveReturnShape> extends UnauthorizedOptions<Types, ParentShape, Type, Nullable, Args> {
            authScopes?: FieldAuthScopes<Types, ParentShape, InputShapeFromFields<Args>>;
            grantScopes?: FieldGrantScopes<Types, ParentShape, InputShapeFromFields<Args>>;
            skipTypeScopes?: boolean;
        }
        interface ObjectFieldOptions<Types extends SchemaTypes, ParentShape, Type extends TypeParam<Types>, Nullable extends FieldNullability<Type>, Args extends InputFieldMap, ResolveReturnShape> extends FieldOptions<Types, ParentShape, Type, Nullable, Args, ParentShape, ResolveReturnShape> {
            skipInterfaceScopes?: boolean;
        }
        interface InterfaceFieldOptions<Types extends SchemaTypes, ParentShape, Type extends TypeParam<Types>, Nullable extends FieldNullability<Type>, Args extends InputFieldMap, ResolveReturnShape> extends FieldOptions<Types, ParentShape, Type, Nullable, Args, ParentShape, ResolveReturnShape> {
            skipInterfaceScopes?: boolean;
        }
        interface RootFieldBuilder<Types extends SchemaTypes, ParentShape, Kind extends FieldKind = FieldKind> {
            authField: <Args extends InputFieldMap, Type extends TypeParam<Types>, Scopes extends FieldAuthScopes<Types, ParentShape, InputShapeFromFields<Args>>, ResolveShape, ResolveReturnShape, Nullable extends FieldNullability<Type> = Types["DefaultFieldNullability"]>(options: Normalize<Omit<FieldOptionsFromKind<Types, ParentShape, Type, Nullable, Args, Kind, ResolveShape, ResolveReturnShape>, InferredFieldOptionKeys> & {
                authScopes: Scopes;
                resolve: Resolver<ParentShape, InputShapeFromFields<Args>, ContextForAuth<Types, Scopes>, ShapeFromTypeParam<Types, Type, Nullable>, ResolveReturnShape>;
            }>) => FieldRef<Types, ShapeFromTypeParam<Types, Type, Nullable>, Kind>;
        }
        interface QueryFieldBuilder<Types extends SchemaTypes, ParentShape> {
            withAuth: <Scopes extends FieldAuthScopes<Types, ParentShape, Record<string, unknown>>>(scopes: Scopes) => QueryFieldBuilder<ReplaceContext<Types, ContextForAuth<Types, Scopes> & object>, ParentShape>;
        }
        interface MutationFieldBuilder<Types extends SchemaTypes, ParentShape> {
            withAuth: <Scopes extends FieldAuthScopes<Types, ParentShape, Record<string, unknown>>>(scopes: Scopes) => MutationFieldBuilder<ReplaceContext<Types, ContextForAuth<Types, Scopes> & object>, ParentShape>;
        }
        interface SubscriptionFieldBuilder<Types extends SchemaTypes, ParentShape> {
            withAuth: <Scopes extends FieldAuthScopes<Types, ParentShape, Record<string, unknown>>>(scopes: Scopes) => SubscriptionFieldBuilder<ReplaceContext<Types, ContextForAuth<Types, Scopes> & object>, ParentShape>;
        }
        interface ObjectFieldBuilder<Types extends SchemaTypes, ParentShape> {
            withAuth: <Scopes extends FieldAuthScopes<Types, ParentShape, Record<string, unknown>>>(scopes: Scopes) => ObjectFieldBuilder<ReplaceContext<Types, ContextForAuth<Types, Scopes> & object>, ParentShape>;
        }
        interface InterfaceFieldBuilder<Types extends SchemaTypes, ParentShape> {
            withAuth: <Scopes extends FieldAuthScopes<Types, ParentShape, Record<string, unknown>>>(scopes: Scopes) => InterfaceFieldBuilder<ReplaceContext<Types, ContextForAuth<Types, Scopes> & object>, ParentShape>;
        }
        interface ScopeAuthFieldAuthScopes<Types extends SchemaTypes, Parent, Args extends {} = {}> {
            Scopes: FieldAuthScopes<Types, Parent, Args>;
        }
        interface ScopeAuthContextForAuth<Types extends SchemaTypes, Scopes extends {}> {
            Context: ContextForAuth<Types, Scopes>;
        }
    }
}
//# sourceMappingURL=global-types.d.ts.map