@keystone-next/keystone-legacy v23.0.0

Keystone class

Usage

const { Keystone } = require('@keystone-next/keystone-legacy');

const keystone = new Keystone({
  adapter,
  defaultAccess,
  onConnect,
  queryLimits,
  schemaNames,
});

secure

A secure cookie is only sent to the server with an encrypted request over the HTTPS protocol. If secure 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 secure 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.

Usage

const keystone = new Keystone({
  /* ...config */
  cookie: {
    secure: process.env.NODE_ENV === 'production', // Default to true in production
    maxAge: 1000 * 60 * 60 * 24 * 30, // 30 days
    sameSite: false,
  },
});

defaultAccess

Default:

{
  list: true,
  field: true,
  custom: true
}

Default list and field access. See the Access Control page for more details.

onConnect

Default: undefined

Callback function that executes once keystone.connect() is complete. Takes no arguments.

queryLimits

Configures global query limits.

These should be used together with list query limits.

const keystone = new Keystone({
  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.

schemaNames

Default: ['public']

Methods

connect()

Manually connect Keystone to the adapter. See Custom Server.

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.

createList(listKey, config)

Registers a new list with Keystone and returns a Keystone list object. See:

• Adding lists tutorial
• Data modelling guide

keystone.createList('Posts', {...});

Config

disconnect()

Disconnect the adapter.

Config

• 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 following signature:

{
  resolver: (parent, args, context, info, extra) => {},
}

For more information about the first four arguments, please see the Apollo docs. The last argument extra is an object that contains the following property:

• The access argument for types, queries, and mutations are all either boolean values which are used at schema generation time to include or exclude the item from the schema, or a function which must return boolean.
• See the Access control API docs for more details.

Config

createContext({ schemaName, authentication, skipAccessControl })

Create a context object that can be used with context.graphql.raw().

Usage

const { gql } = require('apollo-server-express');

// Create a context which can execute GraphQL operations with no access control
const context = keystone.createContext().sudo()

// Execute a GraphQL operation with no access control
const { data, errors } = await context.graphql.raw({ context, query: gql` ... `, variables: { ... }})

Config

Usage

const { gql } = require('apollo-server-express');

// Create a context which can execute GraphQL operations with no access control
const context = keystone.createContext().sudo()

// Execute a GraphQL operation with no access control
const { data, errors } = await context.graphql.raw({ query: gql` ... `, variables: { ... }})

Config