Skip to content
KeystoneJS LogoKeystoneJSv5

keystone

Constructor

Usage

const { Keystone } = require('@keystonejs/keystone');

const keystone = new Keystone({
  /*...config */
});

Config

OptionTypeDefaultDescription
nameStringnullThe name of the project. Appears in the Admin UI.
adapterObjectRequiredThe database storage adapter. See the Adapter Framework page for more details.
adaptersObject{}A list of named database adapters. Use the format { name: adapterObject }.
defaultAdapterStringnullThe name of the database adapter to use by default if multiple are provided.
defaultAccessObject{}Default list and field access. See the Access Control page for more details.
onConnectFunctionnullCallback that executes once keystone.connect() complete. Takes no arguments.
cookieSecretStringqwertyThe secret used to sign session ID cookies. Should be long and unguessable. Don't use this default in production!
cookieMaxAgeInt30 daysThe maximum time, in milliseconds, session ID cookies remain valid.
secureCookiesBooleanVariableDefaults to true in production mode, false otherwise. See below for important details.
sessionStoreObjectnullA compatible Express session middleware.
schemaNamesArray['public']
queryLimitsObject{}Configures global query limits
appVersionObject{ version: '1.0.0', addVersionToHttpHeaders: true, access: true }Configure the application version and where it is made available

secureCookies

A secure cookie is only sent to the server with an encrypted request over the HTTPS protocol. If secureCookies is set to true (as is the default with a production build) for a KeystoneJS project running on a non-HTTPS server (such as localhost), you will not be able to log in. In that case, be sure you set secureCookies to false. This does not affect development builds since this value is already false.

You can read more about secure cookies on the MDN web docs.

sessionStore

Sets the Express server's session middleware. This should be configured before deploying your app.

This example uses the connect-mongo middleware, but you can use any of the stores that work with express session.

Usage

const expressSession = require('express-session');
const MongoStore = require('connect-mongo')(expressSession);

const keystone = new Keystone({
  /* ...config */
  sessionStore: new MongoStore({ url: 'mongodb://localhost/my-app' }),
});

queryLimits

Configures global query limits.

These should be used together with list query limits.

Usage

const keystone = new Keystone({
  /* ...config */
  queryLimits: {
    maxTotalResults: 1000,
  },
});
  • maxTotalResults: limit of the total results of all relationship subqueries

Note that maxTotalResults applies to the total results of all relationship queries separately, even if some are nested inside others.

appVersion

Configure the application version, which can be surfaced via HTTP headers or GraphQL

The version can be any string value you choose to use for your system. If addVersionToHttpHeaders is true then all requests will have the header X-Keystone-App-Version set. The version can also be queried from the GraphQL API as { appVersion }. You can control whether this is exposed in your schema using access, which can be either a boolean, or an object with schemaName keys and boolean values.

Usage

const keystone = new Keystone({
  /* ...config */
  appVersion: {
    version: '1.0.0',
    addVersionToHttpHeaders: true,
    access: true,
  },
});

Why don't we just use access to control the HTTP header?

We want to attach the HTTP header at the very top of the middleware stack, so if something gets rejected we can at least be sure of the system version that did the rejecting. This happens well before we have worked out which schema the person is trying to access, and therefore our access control isn’t ready to be used. Also, the access control that we set up is all about controlling access to the GraphQL API, and HTTP headers are a Different Thing, so even if it was technically possible to use the same mechanism, it really makes sense to decouple those two things.

Methods

MethodDescription
createListAdd a list to the Keystone schema.
extendGraphQLSchemaExtend keystones generated schema with custom types, queries, and mutations.
connectManually connect to Adapters.
prepareManually prepare Keystone middlewares.
createItemsAdd items to a Keystone list.
disconnectDisconnect from all adapters.
executeQueryRun GraphQL queries and mutations directly against a Keystone instance.

createList(listKey, config)

Usage

keystone.createList('Posts', {
  /*...config */
});

Config

Registers a new list with KeystoneJS and returns a Keystone list object.

OptionTypeDefaultDescription
listKeyStringnullThe name of the list. This should be singular, E.g. 'User' not 'Users'.
configObject{}The list config. See the createList API page for more details.

extendGraphQLSchema(config)

Extends keystones generated schema with custom types, queries, and mutations.

Usage

keystone.extendGraphQLSchema({
  types: [{ type: 'type FooBar { foo: Int, bar: Float }' }],
  queries: [
    {
      schema: 'double(x: Int): Int',
      resolver: (_, { x }) => 2 * x,
    },
  ],
  mutations: [
    {
      schema: 'double(x: Int): Int',
      resolver: (_, { x }) => 2 * x,
    },
  ],
});

Config

OptionTypeDescription
typesarrayA list of objects of the form { type, access } where the type string defines a graphQL type.
queriesarrayA list of objects of the form { schema, resolver, access }.
mutationsarrayA list of objects of the form { schema, resolver, access }.

The schema for both queries and mutations should be a string defining the graphQL schema element for the query/mutation, e.g.

{
  schema: 'getBestPosts(author: ID!): [Post]';
}

The resolver for both queries and mutations should be a resolver function with the signature (obj, args, context, info). See the Apollo docs for more details.

The access argument for types, queries, and mutations are all boolean values which are used at schema generation time to include or exclude the item from the schema.

createItems(items)

Allows bulk creation of items. This method's primary use is intended for migration scripts, or initial seeding of databases.

Usage

keystone.createItems({
  User: [{ name: 'Ticiana' }, { name: 'Lauren' }],
  Post: [
    {
      title: 'Hello World',
      author: { where: { name: 'Ticiana' } },
    },
  ],
});

The author field of the Post list would have the following configuration:

keystone.createList('Post', {
  fields: {
    author: { type: Relationship, ref: 'User' },
  },
});

Config

OptionTypeDescription
[listKey]ObjectAn object where keys are list keys, and values are an array of items to insert.

Note: The format of the data must match the lists and fields setup with keystone.createList()

It is possible to create relationships at insertion using the KeystoneJS query syntax.

E.g. author: { where: { name: 'Ticiana' } }

Upon insertion, KeystoneJS will resolve the { where: { name: 'Ticiana' } } query against the User list, ultimately setting the author field to the ID of the first User that is found.

Note an error is thrown if no items match the query.

prepare(config)

Manually prepare middlewares. Returns a promise representing the processed middlewares. They are available as an array through the middlewares property of the returned object.

Usage

const { middlewares } = await keystone.prepare({
  apps,
  dev: process.env.NODE_ENV !== 'production',
});

Config

OptionTypedefaultDescription
devBooleanfalseSets the dev flag in KeystoneJS' express middleware.
appsArray[]An array of 'Apps' which are express middleware.
distDirStringdistThe build directory for keystone.

connect()

Manually connect KeystoneJS to the adapters.

Usage

keystone.connect();

Note: keystone.connect() is only required for custom servers. Most example projects use the keystone start command to start a server and automatically connect.

See: Custom Server.

disconnect()

Disconnect all adapters.

executeQuery(queryString, config)

Use this method to execute queries or mutations directly against a Keystone instance.

Note: When querying or mutating via keystone.executeQuery, there are differences to keep in mind:

  • No access control checks are run (everything is set to () => true)
  • The context.req object is set to {} (you can override this if necessary, see options below)
  • Attempting to authenticate will throw errors (due to req being mocked)

Returns a Promise representing the result of the given query or mutation.

Usage

keystone.executeQuery(queryString, config);

queryString

A graphQL query string. For example:

query {
  allTodos {
    id
    name
  }
}

Can also be a mutation:

mutation newTodo($name: String) {
  createTodo(name: $name) {
    id
  }
}

Config

OptionTypeDefaultDescription
variablesObject{}The variables passed to the graphql query for the given queryString.
contextObject{}Override the default context object passed to the GraphQL engine. Useful for adding a req or setting the schemaName

createAuthStrategy(config)

Creates a new authentication middleware instance.

Usage

const authStrategy = keystone.createAuthStrategy({
  /*...config */
});

Config

See the Authentication docs for full details.

Have you found a mistake, something that is missing, or could be improved on this page? Please edit the Markdown file on GitHub and submit a PR with your changes.

Edit Page