Bot releases are visible (Hide)

keystone - ✨ 15th November 2021

Published by bladey almost 3 years ago

Expanded unique filters, customisable table and column names support and a new example featuring Nexus as we continue to finalise our GA release. 🪢

"@keystone-next/auth": "36.0.0",
"@keystone-next/cloudinary": "11.0.0",
"@keystone-next/fields-document": "13.0.0",
"@keystone-next/keystone": "28.0.0",
"@keystone-next/session-store-redis": "8.0.0",

Like this release? Give us a star on GitHub!

Expanded Unique Filters 🔎

select, timestamp, float and decimal fields with isIndexed: 'unique' now have unique filters via ListWhereUniqueInput which text, integer and the id field already support.

For example, if you added isIndexed: 'unique' to a select field in a theoretical Settings list, you can now run the following query:

query {
  setting ( where: { provider: "github" } ) {
    id
    token
  }
}

This is instead of running a settings query where you would have received a list back, and have had to check for results and get the first element:

query {
  settings ( where: { provider: { equals: "github" } } ) {
    id
    token
  }
}

Customisable Table and Column Names 📇

You may now use different table and column names to those automatically chosen by Keystone for your list and field keys. This is powered by Prisma's @map and @@map attributes. You can read more about this concept in Prisma's documentation.

This is useful if you do not want to modify your existing database (such as a read-only database) and use it with Keystone.

For example if you wanted to refer to a table named stories but you refer to it in Keystone as Posts provide config.db.map to a list or field key such as:

Post: list({
  db: {
    map: 'stories',
  },
  fields: {
    ...
  }
})

Nexus Example 🪢

We've got a new example using Nexus, a declarative, code-first and strongly typed GraphQL schema construction for TypeScript & JavaScript.

Using Nexus you can extend the GraphQL API provided by Keystone with custom queries and mutations.

In the example below we expose a mutation called nexusPosts which pulls out items from our Posts list that have been published within the past 7 days (by default), with an optional author filter.

export const PostQuery = extendType({
  type: "Query",
  definition(t) {
    t.field("nexusPosts", {
      type: nonNull(list("NexusPost")),
      args: {
        authorId: stringArg(),
        days: nonNull(intArg({ default: 7 })),
      },
      async resolve(root, { authorId, days }, context) {
        const cutoff = new Date(
          new Date().setUTCDate(new Date().getUTCDate() - days)
        ).toISOString();

        return await context.prisma.post.findMany({
          where: {
            ...(authorId ? { author: { id: authorId } } : null),
            publishDate: { gt: cutoff },
          },
        });
      },
    });
  },
});

Check out the example in Keystone's examples directory.

Miscellaneous Fixes ⚙️

The format of the date shown in the DatePicker now uses the user's locale.
When the sessionData option is invalid, the error will now be thrown on startup instead of silently ignored.

Changelog

You can also the verbose changelog in the related PR (https://github.com/keystonejs/keystone/pull/6914) for this release.

keystone - ⚙️ 10th November 2021

Published by bladey almost 3 years ago

Patch release.

"@keystone-next/keystone": "27.0.2",

Miscellaneous Fixes ⚙️

Fixed importing packages that provide Node ESM
Local images and files are no longer restricted behind ui.isAccessAllowed
Updated Prisma monorepo to v3.4.0

Enjoying Keystone?

Star this repo 🌟 ☝️ or connect to Keystone on Twitter and in Slack.

Changelog

You can also view the verbose changelog in the related PR (https://github.com/keystonejs/keystone/pull/6892) for this release.

keystone - ⚙️ 3rd November 2021

Published by bladey almost 3 years ago

Patch release.

"@keystone-next/keystone": "27.0.1",

Miscellaneous Fixes ⚙️

Fixed files with names including things like [...rest] created using ui.getAdditionalFiles being deleted after being written in dev.
Runtime type errors from Prisma are now actually returned instead of being returned as Prisma error:
Fixed Schema must contain uniquely named types but contains multiple types named "OrderDirection". error when running keystone-next build.

Enjoying Keystone?

Star this repo 🌟 ☝️ or connect to Keystone on Twitter and in Slack.

Changelog

You can also view the verbose changelog in the related PR (https://github.com/keystonejs/keystone/pull/6871) for this release.

keystone - ✨ 2nd November 2021

Published by bladey almost 3 years ago

Server-side Live Reloading is here! 🚀 Plus more updates as we finalise the Keystone 6 GA release.

"keystone-next/auth": "35.0.0",
"keystone-next/cloudinary": "10.0.0",
"keystone-next/fields-document": "12.0.0",
"keystone-next/keystone": "27.0.0",
"keystone-next/session-store-redis": "7.0.0",

Like this release? Give us a star on GitHub!

Warning: ⚠️ This release contains breaking changes, please see below!

Server-side Live Reloading 🚀

Keystone now supports live reloading with keystone-next dev.

You can now update your GraphQL schema, change your hooks and access control, log errors and see how your data returns, then immediately use the playground to test it and iterate.

This is in addition to the current support for live reloading changes to custom views in the Admin UI.

How it works

When you run keystone-next dev now, it will start watching for changes to your config and schema. When changes are detected, Keystone will reload your config and schema and hot-swap the GraphQL endpoint.

To balance performance and predictability, Keystone does not do a complete restart when changes are made. The things to know are:

Prisma Schema Changes

The Prisma Client is not reloaded as you make changes to the Keystone Schema. If you make changes that affect your Prisma schema, Keystone will exit the process and wait for you to run keystone-next dev again.

This is because making database schema changes involves generating database migrations, and can result in data loss if those migrations are automatically run against your current database.

When adding or removing lists and fields (except virtual fields), we recommend you finish making your changes then start the dev process again. This will generate a single migration for all the changes you’ve made, and interactively prompt you to resolve any migrations that can't be run safely.

onConnect is not hot reloaded

The db.onConnect function (if specified) will only be run once when Keystone is started, and not when your config is hot reloaded.

This is because onConnect is typically used to run data seeding and other once-off processes that should be executed once before the Keystone server comes online. Re-running it whenever a file is changed could result in a heavy database load, harming overall dev performance and introducing unpredictable behaviour.

If you make changes to the onConnect function, you need to manually stop the dev process and start it again for your changes to take effect.

GraphQL Playground and Apollo Sandbox 🏝

In the last release we upgraded to Apollo Server 3 which brought Apollo Sandbox as the default development UI for testing your GraphQL queries.

This surfaced a number of issues as Apollo Sandbox is hosted remotely rather than locally, including CORS issues and security concerns, making it a bad default.

With this in mind, Keystone will now go back to using the GraphQL Playground by default instead of Apollo Sandbox as it did prior to updating to Apollo Server 3.

We have now introduced the graphql.playground config option, with three possible settings:

true will configure Apollo Server plugins to enable the GraphQL Playground
false will configure Apollo Server plugins to disable any GET requests to the GraphQL endpoint
'apollo' will add no plugins to Apollo Server, enabling the new Apollo Sandbox behaviour

graphql.playground defaults to process.env.NODE_ENV !== 'production' which matches the previous Keystone 6 behaviour before the October update and Apollo Server 3.

Next.js Update ✨

We've updated our Next.js dependency from 11.x to 12.x! This latest release of Next.js includes a new Rust powered compiler with faster refresh and build rates, making your Keystone dev experience even faster.

Check out the Next.js blog for more details.

Relationship Filtering ❤️

If you have hundreds of items in your relationship fields, the Admin UI was sometimes displaying duplicate entries and/or missing entries.

We've made a series of improvements to fetching data resulting in a performance boost, as well as filtering fixes. We also changed the way we detect when an ID is pasted into the field allowing you to select a related item quickly.

CORS Configuration 🌐

We've removed the graphql.cors option, we had one too many ways to configure CORS and it was proving to be confusing.

You should now exclusively configure cors with the server.cors option.

Renamed `src` in Image and File Fields 🗄️

⚠️ Breaking Change

The src field on the output of image and file fields has been renamed to url.

Subsequently the getSrc function on ImagesContext and FilesContext has been renamed to getUrl.

Removed `resolveFields` 🚧

The deprecated resolveFields from context.query has been removed.

If you were still using it, you should switch to providing the query option to context.query or use context.db if you were providing false.

The context.query functions will now also throw an error if an empty string is passed to query rather than silently returning what the context.db functions return, you must select at least one field or omit the query option to default to selecting the id.

Internal Types Renamed ✏️

We have updated @graphql-ts/schema to 0.5.0.

The __rootVal properties on ObjectType, InterfaceType and UnionType have been renamed to __source, this is intended to be internal but you may have depended on it, if you were using it, rename __rootVal to __source.

In addition the fields property on InterfaceType has been renamed to __fields and it will no longer exist at runtime like the other types.

GraphQL Schema Reorder 🛗

We've made internal changes to the endSession field on the Mutation type and the keystone field on the Query type. This may result in re-ordering in your generated schema.graphql file.

Miscellaneous Fixes ⚙️

The sessionSchema export of @keystone-next/keystone/session has been removed.
context.session no longer has a value if the session is invalid.
text, integer, float and decimal on the item view now render correctly when using ui.itemView.fieldMode: 'read'.
Admin UI home page now respects ui.hideCreate and won't show a plus button when create is disabled.
Read-only arrays are now accepted where previously mutable arrays were required. Using as const when writing an array and then passing it to various APIs in Keystone will now work.
Fixed bug in LinkToRelatedItems button for double sided relationships.
Updated minor typos in GraphQL errors.

Prisma Update 🗃

We've updated our Prisma dependency from 3.1.1 to 3.3.0!

Check out the Prisma releases page for more details.

Credits 💫

Added a short plain-text display to document fields in the List view as well as a rendered document view in CardValue. Thanks @oplik0!
We now support extensions with numerical characters when generating safe filenames. Thanks @Zlitus!

Changelog

You can view the verbose change log in the related PR (https://github.com/keystonejs/keystone/pull/6762) for this release.

keystone - ✨ 5th October 2021

Published by bladey about 3 years ago

We're nearly at Gold Master status for the Keystone 6 GA release! Here's what's new:

Fields Overhaul with lots of tweaks and additions 🚀
Hook Updates bringing consolidation and clearer naming 🪝
Removal of unused return types and unused values 🚫
Renaming of options for consistency 📛
Apollo Server Upgrade to version 3 👩‍🚀
Improved Error Messaging 📟
Performance updates for a faster Admin UI 🏃‍♀️
REST API Example using the new createContext inside extendExpressApp 👩‍🏫
Other Notable Changes to be aware of 🛎️
Prisma Update from 2.x to 3.x 🗃

We've got further improvements to error messaging and performance to come in the next release!

Warning: This release contains breaking changes, please see below!

"@keystone-next/auth": "33.0.0",
"@keystone-next/cloudinary": "8.0.0",
"@keystone-next/fields-document": "10.0.0",
"@keystone-next/keystone": "26.0.1",
"@keystone-next/session-store-redis": "5.0.0",

Upgrade Guide 👇

Be sure to read the entire release notes below for everything you need to know about this new release.

The main things to keep in mind are:

defaultValue config is now static, if you have dynamic defaults, use the resolveInput hook
isRequired for fields is now validation: { isRequired } and we have new validation options such as min and max for some fields
We've made it clearer which fields are nullable in the database and tweaked the defaults, you now have more control but may need to migrate your database (more details below)
The hooks API has new arguments, and we've consolidated update and delete events into beforeOperation and afterOperation
context.lists has been renamed to context.query

Fields Overhaul 🚀

Keystone's field types have been given a big overhaul - including several breaking changes, read on to understand what has changed.

Warning: Some of these API changes are breaking and you will be required to update your project.

text

defaultValue is now a static value
isRequired has moved to validation.isRequired
Now requires that the value has a length of at least one
New validation.length.min, validation.length.max and validation.match options

float

defaultValue is now a static number
isRequired has moved to validation.isRequired
New validation.min and validation.max options

integer

defaultValue is now a static number or { kind: 'autoincrement' }
isRequired has moved to validation.isRequired
New validation.min and validation.max options

The autoIncrement field has also been removed, use the integer field with a defaultValue of { kind: 'autoincrement' }.

decimal

defaultValue is now a static number written as a string
isRequired has moved to validation.isRequired
Now requires the input isn't NaN
New validation.min and validation.max options

timestamp

defaultValue is now a static date time value in an ISO8601 string or { kind: 'now' }
isRequired has moved to validation.isRequired

The field can also be automatically set to the current time on a create/update by setting db.updatedAt: true, this will add Prisma's @updatedAt attribute to the field.

The timestamp field also now uses a custom GraphQL scalar type named DateTime which requires inputs as full ISO8601 date-time strings such as "2021-01-30T00:00:00.000Z". Using new Date().toISOString() will give you a string in the correct format.

select

dataType has been renamed to type
defaultValue is now a static value
isRequired has moved to validation.isRequired

The select can now also be cleared in the Admin UI when ui.displayMode is segmented-control.

password

defaultValue has been removed
isRequired has moved to validation.isRequired
rejectCommon has moved to validation.rejectCommon
minLength has moved to validation.length.min
New validation.length.max and validation.match options

validation.length.min also must be 1 or above, though it still defaults to 8.

If workFactor is outside of the range of 6 to 31, an error will now be thrown instead of the previous behaviour of clamping the value to 4 to 31 and warning if it's below 6.

image

Removed isRequired
Removed defaultValue

If you were using these options, the same behaviour can be re-created with the validateInput and resolveInput hooks respectively.

file

Removed isRequired
Removed defaultValue

If you were using these options, the same behaviour can be re-created with the validateInput and resolveInput hooks respectively.

cloudinaryImage

Removed isRequired
Removed defaultValue

If you were using these options, the same behaviour can be re-created with the validateInput and resolveInput hooks respectively.

json

Removed isRequired
defaultValue can no longer be dynamic in the json field

If you were using isRequired, the same behaviour can be re-created with the validateInput hook.

relationship

Removed defaultValue
Removed undocumented withMeta option

To re-create defaultValue, you can use resolveInput though note that if you're using autoincrement ids, you need to return the id as number, not a string like you would provide to GraphQL, e.g. { connect: { id: 1 } } rather than { connect: { id: "1" } }.

If you were using withMeta: false, please open an issue with your use case.

checkbox

The checkbox field is now non-nullable in the database, if you need three states, you should use the select field.

The field no longer accepts dynamic default values and it will default to false unless a different defaultValue is specified.

If you're using SQLite, Prisma will generate a migration that makes the column non-nullable and sets any rows that have null values to the defaultValue.

If you're using PostgreSQL, Prisma will generate a migration but you'll need to modify it if you have nulls in a checkbox field. Keystone will say that the migration cannot be executed:

✨ Starting Keystone
⭐️ Dev Server Ready on http://localhost:3000
✨ Generating GraphQL and Prisma schemas
✨ There has been a change to your Keystone schema that requires a migration

⚠️ We found changes that cannot be executed:

  • Made the column `isAdmin` on table `User` required, but there are 1 existing NULL values.

✔ Name of migration … make-is-admin-non-null
✨ A migration has been created at migrations/20210906053141_make_is_admin_non_null
Please edit the migration and run keystone-next dev again to apply the migration

The generated migration will look like this:

/*
  Warnings:

  - Made the column `isAdmin` on table `User` required. This step will fail if there are existing NULL values in that column.

*/
-- AlterTable
ALTER TABLE "User" ALTER COLUMN "isAdmin" SET NOT NULL,
ALTER COLUMN "isAdmin" SET DEFAULT false;

To make it set any null values to false in your database, you need to modify it so that it looks like this but with the table and column names replaced.

ALTER TABLE "User" ALTER COLUMN "isAdmin" SET DEFAULT false;
UPDATE "User" SET "isAdmin" = DEFAULT WHERE "isAdmin" IS NULL;
ALTER TABLE "User" ALTER COLUMN "isAdmin" SET NOT NULL;

document

The document field is now non-nullable in the database. The field no longer has defaultValue or isRequired options.

The same behaviour can be re-created with the validateInput and resolveInput hooks respectively.

The field will default to [{ "type": "paragraph", "children": [{ "text": "" }] }]. The output type has also been renamed to ListKey_fieldKey_Document

If you're using SQLite, Prisma will generate a migration that makes the column non-nullable and sets any rows that have null values to an empty paragraph.

If you're using PostgreSQL, Prisma will generate a migration but you'll need to modify it if you have nulls in a document field.

Keystone will say that the migration cannot be executed:

✨ Starting Keystone
⭐️ Dev Server Ready on http://localhost:3000
✨ Generating GraphQL and Prisma schemas
✨ There has been a change to your Keystone schema that requires a migration

⚠️ We found changes that cannot be executed:

  • Made the column `content` on table `Post` required, but there are 1 existing NULL values.

✔ Name of migration … make_document_field_non_null
✨ A migration has been created at migrations/20210915050920_make_document_field_non_null
Please edit the migration and run keystone-next dev again to apply the migration

The generated migration will look like this:

/*
  Warnings:

  - Made the column `content` on table `Post` required. This step will fail if there are existing NULL values in that column.

*/
-- AlterTable
ALTER TABLE "Post" ALTER COLUMN "content" SET NOT NULL,
ALTER COLUMN "content" SET DEFAULT E'[{"type":"paragraph","children":[{"text":""}]}]';

To make it set any null values to an empty paragraph in your database, you need to modify it so that it looks like this but with the table and column names replaced.

ALTER TABLE "Post" ALTER COLUMN "content" SET DEFAULT E'[{"type":"paragraph","children":[{"text":""}]}]';
UPDATE "Post" SET "content" = DEFAULT WHERE "content" IS NULL;
ALTER TABLE "Post" ALTER COLUMN "content" SET NOT NULL;

general

text, float, integer, decimal, timestamp, select, password can be made non-nullable at the database-level with the isNullable option which defaults to true, except for text which defaults to false.

All fields above except password can also have:

graphql.read.isNonNull set if the field has isNullable: false and you have no read access control and you don't intend to add any in the future, it will make the GraphQL output field non-nullable.
graphql.create.isNonNull set if you have no create access control and you don't intend to add any in the future, it will make the GraphQL create input field non-nullable.

Keep in mind, checkbox is now always non-nullable.

Hook Updates 🪝

We've consolidated the beforeChange/beforeDelete and afterChange/afterDelete hooks into beforeOperation and afterOperation.

Additionaly, we've renamed:

originalInput for access control functions to inputData
originalInput for hook functions to inputData
existingItem for all hooks (except afterOperation) to item
existingItem for afterOperation to originalItem
updatedItem for afterOperation to item

See the Hooks API docs for a complete reference for the updated API!

Removals 🚫

Some unused return types and unused values from enum definitions have been removed:

sendUserPasswordResetLink and sendUserMagicAuthLink only ever return null, so now have return types of Boolean.
UserAuthenticationWithPasswordFailure no longer has a code value.
MagicLinkRedemptionErrorCode and PasswordResetRedemptionErrorCode no longer have the values IDENTITY_NOT_FOUND, MULTIPLE_IDENTITY_MATCHES, TOKEN_NOT_SET, or TOKEN_MISMATCH.

If you were using the createSchema function, you can also remove the call to createSchema and pass the lists directly to the lists property.

Before:

import { config, createSchema, list } from '@keystone-next/keystone';

config({
  lists: createSchema({
   User: list({ ... }),
  }),
})

After:

import { config, list } from '@keystone-next/keystone';

config({
  lists: {
   User: list({ ... }),
  },
 })

We've removed the deprecated config.db.adapter option. Please use config.db.provider to indicate the database provider for your system.

Finally, the internal protectIdentities variable which was previously hardcoded to true to protect user data, there are no immediate plans to implement this as a configurable option.

Renames 📇

The API context.lists has been renamed to context.query, and context.db.lists has been renamed to context.db.

The skipAccessControl argument to createContext to sudo for consistency with context.sudo().

When using the experimental option config.experimental.generateNodeAPI, the api module now exports query rather than lists.

Renamed graphQLReturnFragment to ui.query in the virtual field options. The virtual field now checks if ui.query is required for the GraphQL output type, and throws an error if it is missing. If you don't want want the Admin UI to fetch the field, you can set ui.itemView.fieldMode and ui.listView.fieldMode to 'hidden' instead of providing ui.query.

Also, we've moved the graphql export of @keystone-next/keystone/types to @keystone-next/keystone.

Improved Error Messaging 📟

Error messages have been improved across the board, in summary:

On startup, we now output where the GraphQL API is located
If access is denied errors are thrown, we now state which operation isn't permitted
Bad relationship field inputs are detected and outputed
Clearer distinction if a user input is invalid
If access control functions return invalid values we state what we got and what we expected
Improved the error messages provided from the GraphQL API when extension code (e.g access control functions, hooks, etc) throws exceptions
Better formatting of GraphQL error messages resulting from Prisma errors
Clearer sign-in errors when logging into the Admin UI
Improved error messages when returning bad filters from filter access control

Performance 🚅

Field Mode

We've optimised the itemView field mode fetching - we now only fetch the item once to determine the field modes rather than once per field.

The Admin UI will also skip fetching fields that have a statically set itemView.fieldMode: 'hidden' on the itemView.

The id argument to the KeystoneAdminUIFieldMeta.itemView GraphQL field can now be omitted which will make KeystoneAdminUIFieldMetaItemView.fieldMode return null when there isn't a static field mode.

The itemView also no longer uses a sudo context when fetching the item in the KeystoneAdminUIFieldMetaItemView.fieldMode. Previously, if someone had access to the Admin UI(ui.isAccessAllowed) and a field had a itemView.fieldMode function that used the item argument, someone could bypass access control to determine whether or not an item with a given id exists.

Query Generation Performance

Query generation performance has been improved when querying single relationships without filter-based access control.

When resolving related items, we often have a foreign key available to us that we can use to help optimise the subsequent related item query. If, on top of this, there are no filter-based access control rules in place, then we can use the Prisma findUnique operation, which will group all the operations into a single database query. This solves the GraphQL N+1 query problem in this specific instance.

REST API Example 👩‍🏫

This release also adds createContext to the extendExpressApp function giving you access to the full context API from Keystone.

In a new example we demonstate how to create REST endpoints by extending Keystone's express app and using the Query API to execute queries against the schema.

Note: You can find all of our examples in our examples folder on GitHub.

Other Notable Changes 🛎️

The KeystoneAdminUIFieldMeta.isOrderable and KeystoneAdminUIFieldMeta.isFilterable fields are no longer statically resolvable and will now take into account the context/session. This also means isOrderable and isFilterable are no longer accessible on useList().fields[fieldKey].isOrderable/isFilterable, they can be fetched through GraphQL if you need them in the Admin UI.
The sendItemMagicAuthLink and sendItemPasswordResetLink mutations now always return true instead of always returning null
Added support for dynamic isFilterable and isOrderable field config values. If a function is provided for these config option, it will be dynamically evaluated each time the field is used for filtering and ordering, and an error will be returned if the function returns false.

Apollo Server Upgrade 👩‍🚀

Apollo Server has had a major upgrade to Version 3.

The Apollo documentation contains a full list of breaking changes introduced by this update.

You can configure the Apollo Server provided by Keystone using the graphql.apolloConfig configuration option.

The most prominent change for most users will be that the GraphQL Playground has been replaced by the Apollo Sandbox.

If you prefer to keep the GraphQL Playground, you can configure your server by following these instructions.

Prisma Update 🗃

We've updated our Prisma dependency from 2.30.2 to 3.1.1!

Note that Keystone continues to use the "binary" query engine, rather than the new "node-API" query engine, which is now the Prisma default. We are still performing tests to ensure that the node-API query engine will work well with Keystone.

Check out the Prisma releases page for more details on this major update.

Credits 💫

Exported Field types to help in updating contrib packages. Thanks @gautamsi!
Fixed remaining windows issue where it creates invalid import path. This removes some duplicate code which caused this. Thanks @gautamsi!
Added support for Prisma preview features via the config.db.prismaPreviewFeatures configuration option. Thanks @Nikitoring!

Changelog

You can view the verbose change log in the related PR (https://github.com/keystonejs/keystone/pull/6483) for this release.

keystone - ✨ 6th September 2021

Published by bladey about 3 years ago

What's New

Big strides towards our General Availability release for Keystone 6 in the very near future⌛ this release includes:

New & Improved Access Control API ✨
Customisable Express App 🗺️
Customisable GraphQL Paths 🚏
Faster GraphQL API startups in local dev 🚀
Next.js 11 upgrade for Admin UI ⚙️
Apollo Server Introspection 🔎
Omit GraphQL Operations 🚦
And more...

⚠️ This release contains breaking changes, please see below!

"@keystone-next/admin-ui-utils": "6.0.0",
"@keystone-next/auth": "32.0.0",
"@keystone-next/cloudinary": "7.0.0",
"@keystone-next/fields": "15.0.0",
"@keystone-next/fields-document": "9.0.0",
"@keystone-next/keystone": "25.0.1",
"@keystone-next/session-store-redis": "4.0.0",
"@keystone-next/testing": "2.0.0",
"@keystone-next/types": "25.0.0",
"@keystone-next/utils": "2.0.0",

New & Improved Access Control API ✨

⚠️ This includes breaking changes which impact the security of all Keystone systems.

Access Control is now easier to program, and makes it harder to introduce security gaps in your system:

The static approach to access control has been replaced. Now access control never effects the operations in your GraphQL API.
Keystone used to return an access denied error from a query if an item couldn't be found, or explicitly had access denied. The improved API never returns that error type on a query.
Access rules are now more explicit, and support fewer variations so you're less likely to introduce security gaps. They're also easier to read, write, and maintain.

How to upgrade

Follow the instructions in our Access Control upgrade guide.
Review our updated Access Control API docs.

💡 If you get stuck or have questions, reach out to us in the Keystone community slack to get the help you need.

CleanShot 2021-09-07 at 11 40 20

Faster Startup 🚀

The GraphQL API endpoint now starts up significantly faster in development!

Often when you're working with the GraphQL API you'll be waiting around for it to start up, now you don't need to wait for the Admin UI to be ready before hitting the server. The process of creating of the Express Server + GraphQL API has been split from the Admin UI, which significantly speeds up boot time for the GraphQL API in development! 🎉

💡 To facilitate this, createExpressServer no longer includes the step of creating the Admin UI Middleware, which changes its signature. createAdminUIMiddleware is now also exported from @keystone-next/keystone/system.

Next.js 11 ⚙️

We've updated the underlying Next.js server that Keystone uses under the hood from version 10 to 11, which includes optimisations to improve cold startup time.

💡 If you've been using a custom Babel config, you'll need to remove this as it’s no longer supported in Next.js 11.

Omit GraphQL Operations 🚦

You can now add graphql.omit to list and field level configuration to control which types and operations are excluded from the GraphQL API. This option accepts either true, or an array of the values read, create, or update. If you specify true then the field will be excluded from all input and output types in the GraphQL API. If you provide an array of read, create, or update the field will be omitted from the corresponding input and output types in the GraphQL API.

User: list({
  fields: {
    name: text({
      graphql: {
        omit: ['read', 'create', 'update'],
      }
    }),
  },
})

Customisable Express App 🗺️

A long awaited feature, the Express App that Keystone creates is now customisable with the new extendExpressApp option!

Add your own custom server routes
Host two apps on separate ports
And more...

Check out the Server Config docs for more information.

Package Shuffle 💃

We've moved some packages around to make it easier for you to keep your project in sync with Keystone releases, in order to prevent mismatching versions of Keystone packages. The exports from the following packages now reside inside the @keystone-next/keystone/* package:

@keystone-next/admin-ui-utils
@keystone-next/fields
@keystone-next/testing
@keystone-next/types
@keystone-next/utils

For example if you had:

import {
  relationship,
} from '@keystone-next/fields';

This is now:

import {
  relationship,
} from '@keystone-next/keystone/fields';

💡 For any affected package, you'll need to change your import references and remove deprecated packages from your package.json as they will no longer be updated.

Key Changes 🔑

`isUnique` now `isIndex` for unique fields 🗂

Unique fields marked as isUnique: true are now represented as isIndexed: 'unique'. This ensures that regular indexes and unique indexes aren't enabled at the same time.

isIndexed accepts the following options as per the Fields API docs -

If true then the field will be indexed by the database.
If 'unique' then all values of the field must be unique.

`fieldPath` now `fieldKey` for field hooks 🪝

The fieldPath argument to field hooks has been renamed to fieldKey. This makes the naming consistent with the Access Control APIs.

`schema` now `graphql` for virtual and custom fields 🥽

If you've using Virtual fields or custom field types, or if constructing GraphQL types, we used to export schema, this has been changed to graphql.

Disabled filtering and ordering (by default) 🙅‍♀️

Filtering and ordering is no longer enabled by default, as they have the potential to expose data which would otherwise be protected by access control. To enable filtering and ordering you can set isFilterable: true and isOrderable: true on specific fields, or set defaultIsFilterable: true and defaultIsOrderable: true at the list level.

Check out our Fields API docs for all field level options.

Introspection 🔎

You can now enable introspection in the Apollo Server config. Introspection enables you to query a GraphQL server for information about the underlying schema. Check out the GraphQL Config docs for more information.

GraphQL Path Customisation 🚏

The GraphQL endpoint accessible by default at /api/graphql can now be customised with the new option config.graphql.path. You can find this and all other options in our GraphQL API docs.

Admin UI Improvements 🛠️

The Navigation component has been updated to show docs and playground links irrespective of authentication. The triple-dot menu is now available in the Admin UI even if authentication isn't being used.

CleanShot 2021-09-07 at 13 22 30

Additionally, performance has been improved of the create item modal when many fields are configured. Thanks to Sam Lam for the heads up!

Prisma Update ⬆️

Updated Prisma dependencies from 2.29.0 to 2.30.2, check out the Prisma releases page for more details.

Credits 💫

Fixed an issue in the Relationship field when using display mode count, thanks to @gautamsi!
Sam Lam for alerting us to performance issues with Admin UI create item modal.

Enjoying Keystone?

Star this repo 🌟 ☝️ or connect to Keystone on Twitter and in Slack.

keystone

Expanded Unique Filters 🔎

Customisable Table and Column Names 📇

Nexus Example 🪢

Miscellaneous Fixes ⚙️

Changelog

Miscellaneous Fixes ⚙️

Enjoying Keystone?

Changelog

Miscellaneous Fixes ⚙️

Enjoying Keystone?

Changelog

Server-side Live Reloading 🚀

How it works

Prisma Schema Changes

onConnect is not hot reloaded

GraphQL Playground and Apollo Sandbox 🏝

Next.js Update ✨

Relationship Filtering ❤️

CORS Configuration 🌐

Renamed src in Image and File Fields 🗄️

Removed resolveFields 🚧

Internal Types Renamed ✏️

GraphQL Schema Reorder 🛗

Miscellaneous Fixes ⚙️

Prisma Update 🗃

Credits 💫

Changelog

Upgrade Guide 👇

Fields Overhaul 🚀

text

float

integer

decimal

timestamp

select

password

image

file

cloudinaryImage

json

relationship

checkbox

document

general

Hook Updates 🪝

Removals 🚫

Renames 📇

Improved Error Messaging 📟

Performance 🚅

Field Mode

Query Generation Performance

REST API Example 👩‍🏫

Other Notable Changes 🛎️

Apollo Server Upgrade 👩‍🚀

Prisma Update 🗃

Credits 💫

Changelog

What's New

New & Improved Access Control API ✨

How to upgrade

Faster Startup 🚀

Next.js 11 ⚙️

Omit GraphQL Operations 🚦

Customisable Express App 🗺️

Package Shuffle 💃

Key Changes 🔑

isUnique now isIndex for unique fields 🗂

fieldPath now fieldKey for field hooks 🪝

schema now graphql for virtual and custom fields 🥽

Disabled filtering and ordering (by default) 🙅‍♀️

Introspection 🔎

GraphQL Path Customisation 🚏

Admin UI Improvements 🛠️

Prisma Update ⬆️

Credits 💫

Enjoying Keystone?

Releases

@keystone-next/[email protected]

Major Changes

Renamed `src` in Image and File Fields 🗄️

Removed `resolveFields` 🚧

`isUnique` now `isIndex` for unique fields 🗂

`fieldPath` now `fieldKey` for field hooks 🪝

`schema` now `graphql` for virtual and custom fields 🥽