Access Control

This is the last active development release of this package as Keystone 5 is now in a 6 to 12 month active maintenance phase. For more information please read our Keystone 5 and beyond post.

This package is an internal helper package used by Keystone to parse and validate access control expressions.

You should probably not use this directly in your Keystone projects.

For more information on how to configure access control for you Keystone application, please consult the Access Control Guide.

@keystonejs/access-control

7.1.2

Patch Changes

• #95 c8ff78b95 Thanks @bladey! - Renamed branch master to main.

• Updated dependencies [c8ff78b95]:

  • @keystonejs/utils@6.1.2

7.1.1

Patch Changes

• #95 a890b0576 Thanks @bladey! - Renamed branch master to main.

• Updated dependencies [a890b0576]:

  • @keystonejs/utils@6.1.1

7.1.0

Minor Changes

• 345a5f0f6 #23 Thanks @bladey! - Keystone 5 is now in a 6 to 12 month active maintenance phase, packages will no longer have active development releases. For more information please read our Keystone 5 and beyond post located here - https://github.com/keystonejs/keystone-5/issues/21

Patch Changes

• Updated dependencies [345a5f0f6]:
  • @keystonejs/utils@6.1.0

7.0.1

Patch Changes

• 04bf1e4bb #2 Thanks @bladey! - Updated repository URL in package.json.

• 15b1132d2 Thanks @timleslie! - Updated types to be parameterised by imperative argument type.

• Updated dependencies [04bf1e4bb]:

  • @keystonejs/utils@6.0.2

7.0.0

Major Changes

• 28a61dc67 #4801 Thanks @timleslie! - Converted the @keystonejs/access-control package to TypeScript.

6.3.2

Patch Changes

• 619ef5051 #4730 Thanks @timleslie! - Refactored access parsing to separate parsing from validation.

• 86b597d41 #4724 Thanks @timleslie! - Rearranged code to have an explicit exports group.

• c1257ca83 #4727 Thanks @timleslie! - Refactored out parseAccess and added checkSchemaNames.

• 5e22cc765 #4725 Thanks @timleslie! - Refactored calls to validateGranularConfigTypes to be more explicit.

• b9ec7fff9 #4723 Thanks @timleslie! - Replaced usage of getType() with typeof.

• 5ad7c12e8 #4726 Thanks @timleslie! - Refactored parseAccess and inlined the code from validateGranularConfigTypes and parseAccessCore.

• Updated dependencies [94c8d349d]:

  • @keystonejs/utils@6.0.1

6.3.1

Patch Changes

• Updated dependencies [b76241695]:
  • @keystonejs/utils@6.0.0

6.3.0

Minor Changes

• 5a3849806 #3262 Thanks @MadeByMike! - Added a new private internal schema that will allow a better method of bypassing access control on the executeGraphQL function.

  The schema name internal is now a reserved name and if you have a schema with this name you will need to change it with this update.

  Note: You cannot change access control on the internal schema.

6.2.0

Minor Changes

• dec3d336a #3153 Thanks @timleslie! - Made context available to user designed access control functions.

6.1.0

Minor Changes

• 463f55233 #3095 Thanks @timleslie! - Added { item, args, context, info, gqlName } to the arguments available in access control functions for custom queries/mutations.

6.0.0

Major Changes

• 839666e25 #2872 Thanks @wcalebgray! - Added async capability for all Access Control resolvers. This changes the below methods to async functions, returning Promises:

  access-control
  - validateCustomAccessControl
  - validateListAccessControl
  - validateFieldAccessControl
  - validateAuthAccessControl
  
  keystone/List
  - checkFieldAccess
  - checkListAccess
  
  keystone/providers/custom
  - computeAccess
  
  keystone/providers/listAuth
  - checkAccess
  

  Changed keystone/Keystone's getGraphQlContext return object (context) to include async resolvers for the following methods:

  - context.getCustomAccessControlForUser
  - context.getListAccessControlForUser
  - context.getFieldAccessControlForUser
  - context.getAuthAccessControlForUser

5.2.0

Minor Changes

• 42497b8e #2456 Thanks @timleslie! - Added validateAuthAccessControl as a special case for validating access control on authentication queries and mutations.

Patch Changes

• 5ba330b8 #2487 Thanks @Noviny! - Small changes to package.json (mostly adding a repository field)

• Updated dependencies [5ba330b8]:

  • @keystonejs/utils@5.2.2

5.1.0

Minor Changes

• 517b23e4 #2391 Thanks @timleslie! - Removed support for Node 8.x, as it is no longer in maintenance mode.

Patch Changes

• Updated dependencies [517b23e4]:
  • @keystonejs/utils@5.2.0

5.0.0

Major Changes

• 7b4ed362 #1821 Thanks @jesstelford! - Release @keystonejs/* packages (つ＾ ◡ ＾)つ

  • This is the first release of @keystonejs/* packages (previously @keystone-alpha/*).
  • All packages in the @keystone-alpha namespace are now available in the @keystonejs namespace, starting at version 5.0.0.
  • To upgrade your project you must update any @keystone-alpha/* dependencies in package.json to point to "@keystonejs/*": "^5.0.0" and update any require/import statements in your code.

Patch Changes

• Updated dependencies [7b4ed362]:
  • @keystonejs/utils@5.0.0

@keystone-alpha/access-control

3.1.0

Minor Changes

• 1405eb07: Add listKey, fieldKey (fields only), operation, gqlName, itemId and itemIds as arguments to imperative access control functions.

3.0.0

Major Changes

• 9ade2b2d: Add support for access: { auth: ... } which controls whether authentication queries and mutations are accessible on a List

  If you have a List which is being used as the target of an Authentication Strategy, you should set access: { auth: true } on that list.

Minor Changes

• b61289b4: Add parseCustomAccess() for parsing the access control directives on custom types/queries/mutations.
• 0bba9f07: Add validateCustomAccessControl() for use by custom queries/mutations access control checking.

Patch Changes

• 9ece715c: Refactor access-control internals to better support future changes

2.0.0

Major Changes

• bc0b9813: parseListAccess and parseFieldAccess now take schemaNames as an argument, and return a nested access object, with the schemaNames as keys.

  For example,

  parseListAccess({ defaultAccess: false, access: { public: true }, schemaNames: ['public', 'private'] }

  will return

  {
    public: { create: true, read: true, update: true, delete: true },
    private: { create: false, read: false, update: false, delete: false },
  }

  These changes are backwards compatible with regard to the access argument, so

  const access = { create: true, read: true, update: true, delete: true };
  parseListAccess({ access, schemaNames: ['public', 'private'] }

  will return

  {
    public: { create: true, read: true, update: true, delete: true },
    private: { create: true, read: true, update: true, delete: true },
  }

1.1.0

Minor Changes

• e5d4ee76: Expose 'originalInput' to access control functions for lists & fields

1.0.5

Patch Changes

• 19fe6c1b:

  Move frontmatter in docs into comments

1.0.4

• Updated dependencies b7a2ea9c:
  • @keystone-alpha/utils@3.0.0

1.0.3

• [patch]10d96db2:

  • Restructure internal code

1.0.2

• Updated dependencies 98c02a46:
  • @keystone-alpha/utils@2.0.0

1.0.1

• [patch]1f0bc236:

  • Update the package.json author field to "The Keystone Development Team"

• [patch]9534f98f:

  • Add README.md to package

1.0.0

• [major] 8b6734ae:

  • This is the first release of keystone-alpha (previously voussoir). All packages in the @voussoir namespace are now available in the @keystone-alpha namespace, starting at version 1.0.0. To upgrade your project you must update any @voussoir/<foo> dependencies in package.json to point to @keystone-alpha/<foo>: "^1.0.0" and update any require/import statements in your code.

@voussoir/access-control

0.4.2

• [patch] 113e16d4:

  • Remove unused dependencies

0.4.1

• Updated dependencies [723371a0]:
• Updated dependencies [aca26f71]:
• Updated dependencies [a3d5454d]:
  • @voussoir/utils@1.0.0

0.4.0

• [minor] ffc98ac4:

  • Rename the access control function parameter item to existingItem

0.3.0

• [minor] 3ae588b7:

  • Rename testAccessControl functions to validateAccessControl

0.2.0

• [minor] 47c7dcf6" :

  • Bump all packages with a minor version to set a new baseline

0.1.3

• [patch] Bump all packages for Babel config fixes d51c833
• [patch] Updated dependencies 9c75136
  • @voussoir/utils@0.2.0

0.1.2

• [patch] Rename readme files a8b995e

0.1.1

• [patch] Remove tests and markdown from npm dc3ee7d