Function

Central logger for authorization checks

Throw:

Returns an authorized document

Throw:

enhances the schema by additional fields, required for authorization

checks, if a field contains a user's id returns true, if a field of type array/object/string contains the userId

changes a given string on the first character to lower case

helper methods to work with graphql ASTs

get generated code from template partials

gets context for later template compilation reads schema and determines data context for code replacements

reads all available partials of a template directory

Example:

 partials = [
   {
     "name": "hello",
     "path": "templates/default/hello.template",
     "source": "console.log('Hello World')"
   }
 ]

checks, if there is authorization logic defined true, if there is an @authorize directive in the header in the type's inputSchema if there is an @authorize directive => true if thers is no @authorize directive => false

changes a given string on the first character to lower case

Checks, if an user is logged in

similiar to authLog, registers dataloader on successfull authorization and doesn't throw exception in error case

Protects a field based on authorizations

Prepare a query object for mongodb operations with authorization queries creates an authQuery object with additional query arguments, to implement authorization restrictions for mongodb access

Example:

  const authQuery = 
    queryForRoles(me, userRoles, docRoles, { User }, authlog(resolver, mode, me ) );

changes a given string on the first character to upper case

Is a user's role authorized for a document You can use also the role 'world', to authorize everyone

extract the roles from the @authorize directive by reading the input schema's abstract syntax tree to get the roles and their authorized modes

Example:

         @authorize(
           admin: ["create", "read", "update", "delete"]
           this: ["read", "update", "delete"]
         )

it creates the following array (example):

allRoles = [
      {
          name: 'admin',
          type: 'userRole' || 'docRole'
          modes: {
           create: 'admin',
           readOne: 'admin',
           readMany: 'admin',
           update: 'admin',,
           delete: 'admin',
       }
]

get the field's type

Example:

'role: String'

'role: String!'

'coauthors: [User]'

'coauthors: [User]!'

'coauthors: [User!]'

'coauthors: [User!]!'

get the name of the partial template according to default naming convention defines the name of the partial template in its directory structure prepare name prefix: take just partial name on root template directory on deeper directory structures, prefix directory name to partial name

Example:

name = hello               {base}/hello.template
name = auth_hello          {base}/auth/hello.template
name = auth_special_hello  {base}/auth/special/hello.template

decide, if the given role is whether a 'userRole' or a 'docRole'

Procedure:

1. Determine, if this field is used as a roleField
2. Check, if this roleField... a) is of type: String or [String] ==> userRole b) is of type: User or [User] ==> docRole c) roleName = 'this' ==> docRole
3. If there is no roleField in this type it must be a userRole

For 1. is a roleField: read the type's abstract syntax tree loop over all provided fields, check, if the field has a directive '@authRole' and if this authRole is 'for' the provided 'roleName' or the roleName is the special case 'this' ==> then it is a roleField

For 2. get it's fieldType: read the type's abstract syntax tree for the roleField and read it's type

a) if it is a String or List of Strings, then the roleType = 'userRole'

b) if it is a User or List of Users (userIds), then the roleType = 'docType'

c) special case: roleName = 'this' (it doesn't look for an authRole for 'this') it means the document's id field is used for this meaning the role defines the authorizations, a User has upon his own User document

For 3. none of the above applies so the role must be a userRole

get userRoles and docRoles

converts first character of string to lower case

parses a Code into an abstract syntax tree (AST)

prepare roles for code generator convert array to String value replace " by '

converts first character of string to upper case