Skip to content

Releases: keystonejs/keystone

⚙️ 3rd November 2021

17 Nov 00:23
5b68e28
Compare
Choose a tag to compare

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 (#6871) for this release.

✨ 2nd November 2021

02 Nov 02:02
d30c2ee
Compare
Choose a tag to compare

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 (#6762) for this release.

✨ 5th October 2021

05 Oct 06:02
393c2bd
Compare
Choose a tag to compare

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 `...
Read more

✨ 6th September 2021

07 Sep 03:50
f1b3acf
Compare
Choose a tag to compare

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

  1. Follow the instructions in our Access Control upgrade guide.
  2. 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.

View verbose release notes

Releases

@keystone-next/admin-ui-utils@6.0.0

Major Changes

@keystone-next/auth@32.0.0

Major Changes

Patch Changes

Read more

✨ 17th August 2021

17 Aug 05:14
e45c631
Compare
Choose a tag to compare

What's New

A major milestone in the path to a General Availability status for Keystone 6, this release includes:

  • A new and improved GraphQL API 🎉 ✨
  • Enhancements to Custom Admin UI Pages
  • Better deletion notifications
  • And more…

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

"@keystone-ui/notice": "4.0.1",
"@keystone-ui/segmented-control": "4.0.2",
"@keystone-ui/toast": "4.0.2",
"@keystone-next/admin-ui-utils": "5.0.6",
"@keystone-next/auth": "31.0.0",
"@keystone-next/cloudinary": "6.0.6",
"@keystone-next/fields": "14.0.0",
"@keystone-next/fields-document": "8.0.0",
"@keystone-next/keystone": "24.0.0",
"@keystone-next/testing": "1.1.1",
"@keystone-next/types": "24.0.0",
"@keystone-next/utils": "1.0.4",

A new & improved GraphQL API ✨

We’ve made the experience of working with Keystone’s GraphQL API easier to program and reason about:

  • Queries: the names of top-level queries are now easier to understand. We also removed deprecated and unused legacy features.
  • Filters: the arguments used in queries have been updated to accept a filter object for each field, rather than having all the filter options available at the top level.
  • Mutations: all generated CRUD mutations have the same names and return types, but their inputs have changed.
  • Input Types: we’ve updated the input types used for relationship fields in update and create operations, removing obsolete options and making the syntax between the two operations easier to differentiate.

Upgrade guidance

We've written a complete guide to the improvements we've made, and it includes a checklist of the steps you need to take to upgrade your Keystone projects. Be sure to check it out!

💡 While there are a lot of changes to this API, if you approach the upgrade process systematically your experience should be pretty smooth. If you get stuck or have questions, reach out to us in the Keystone community slack to get the help you need.

Screen Shot 2021-08-17 at 11 28 56 am

Custom Admin UI Pages 📃

Our Custom Admin UI Pages guide has been expanded, with an example to make your custom pages look more like the Admin UI, as well as adding links to your custom pages from the Admin UI Navigation!

Screen Shot 2021-08-17 at 11 30 39 am

Improved Deletion Notifications 🗑

When items are deleted via the Admin UI, we now display all the items that were successfully deleted, and any that failed, instead of displaying multiple notifications without any context.

Screen Shot 2021-08-17 at 11 04 47 am

Deeper GraphQL Errors 🚧

A config.graphql.debug option has been added, which can be used to control whether debug information such as stack traces are included in the errors returned by the GraphQL API.

Prisma Update ⬆️

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

Credits 💫

Added option for Bearer token auth when using session, thanks to @gautamsi!

Enjoying Keystone?

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

View verbose release notes

Releases

@keystone-next/auth@31.0.0

Major Changes

  • #6211 d214e2f72 Thanks @mitchellhamilton! - The update mutations now accept where unique inputs instead of only an id and the where and data arguments are non-null.

    If you have a list called Item, the update mutations now look like this:

    type Mutation {
      updateItem(where: ItemWhereUniqueInput!, data: ItemUpdateInput!): Item
      updateItems(data: [ItemUpdateArgs!]!): [Item]
    }
    
    input ItemUpdateArgs {
      where: ItemWhereUniqueInput!
      data: ItemUpdateInput!
    }

Patch Changes

@keystone-next/fields@14.0.0

Major Changes

Read more

✨ 29th July 2021

30 Jul 04:46
Compare
Choose a tag to compare

What's New

Custom navigation, pages and logo in this big Admin UI themed release! 🎛️

"@keystone-ui/tooltip": "4.0.1",
"@keystone-next/admin-ui-utils": "5.0.5",
"@keystone-next/auth": "30.0.0",
"@keystone-next/cloudinary": "6.0.5",
"@keystone-next/fields": "13.0.0",
"@keystone-next/fields-document": "7.0.3",
"@keystone-next/keystone": "23.0.2",
"@keystone-next/testing": "1.1.0",
"@keystone-next/types": "23.0.0",
"@keystone-next/utils": "1.0.3",

Custom Admin UI Navigation 🚏

You can now create your own custom navigation component with custom routes to be rendered in the Admin UI.

Check out our detailed Custom Admin UI Navigation guide for all the details!

Custom navigation screenshot

Custom Admin UI Pages 📃

Take things a step further with custom pages. As the Admin UI is built on top of Next.js, it exposes the same /pages directory for adding custom pages.

ℹ️ In the near future you'll be able to directly embed pages within the Keystone Admin UI itself, stay tuned!

Read our new Custom Admin UI Pages guide for more details.

Custom page screenshot

Custom Admin UI Logo 🚩

Wait, theres more. You can also replace the default Admin UI logo with your own brand assets. ✨

Dive into our Custom Admin UI Logo guide to find out how.

Animated logo screenshot

Health Check 💙

We've added an optional /_healthcheck endpoint to Keystone's express server. You can use this endpoint to ensure your Keystone instance is up and running using website monitoring solutions.

Enable it by setting config.server.healthCheck: true, by default it will respond with { status: 'pass', timestamp: Date.now() }.

You can also specify a custom path and JSON data:

config({
  server: {
    healthCheck: {
      path: "/my-health-check",
      data: { status: "healthy" },
    },
  },
});

Or use a function for the data config to return real-time information:

config({
  server: {
    healthCheck: {
      path: "/my-health-check",
      data: () => ({
        status: "healthy",
        timestamp: Date.now(),
        uptime: process.uptime(),
      }),
    },
  },
});

Prisma Update ⬆️

Updated Prisma dependencies to 2.27.0, check out the Prisma releases page for more details.

Credits 💫

  • Fixed virtual field rendering of false & 0 values thanks to @ChuckJonas!

  • Added / to list.path on HomePage ListCard to better allow custom basePath thanks to @borisno2!

  • Changed symlink generation to use relative path instead of absolute which solves running project in docker when mapping volume, thanks to @gautamsi!

Enjoying Keystone?

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


View verbose release notes

Releases

@keystone-next/auth@30.0.0

Major Changes

Patch Changes

@keystone-next/fields@13.0.0

Major Changes

  • #6105 e5f61ad50 Thanks @mitchellhamilton! - Removed unnecessary descriptions on GraphQL types.

  • #6165 e4e6cf9b5 Thanks @mitchellhamilton! - Added ui.searchFields option to lists to allow searching by multiple fields in the Admin UI (the only current usage of this is in the select used in relationship fields) and to replace the usage of the search GraphQL argument which will be removed soon and should be replaced by using contains filters directly.

Patch Changes

@keystone-next/keystone@23.0.0

Major Changes

Read more

✨ 13th July 2021

13 Jul 23:31
8eb57b2
Compare
Choose a tag to compare

What's New

More examples, types, and UI rendering tweaks as we push forward towards a general availability release! 🚀

"@keystone-ui/core": "3.1.1",
"@keystone-next/admin-ui-utils": "5.0.4",
"@keystone-next/auth": "29.0.0",
"@keystone-next/cloudinary": "6.0.4",
"@keystone-next/document-renderer": "4.0.0",
"@keystone-next/fields": "12.0.0",
"@keystone-next/fields-document": "7.0.2",
"@keystone-next/keystone": "22.0.0",
"@keystone-next/session-store-redis": "3.0.2",
"@keystone-next/testing": "1.0.2",
"@keystone-next/types": "22.0.0",
"@keystone-next/utils": "1.0.2",

New Examples 📖

Custom Field Views

We have a new example for custom field views, demonstrating how to create a custom field view for a JSON field. This example allows users to add, edit and remove navigation items from a list:

image

Inline Relationship in Document Field

Rendering an inline relationship for the document field has been added to the existing example project as well as our docs page:

image

Be sure to check out all the examples, with more to come.

Document Rendering Improvements 📇

If an item referenced in a document field is deleted from Keystone, the document field now handles this gracefully. Before an error would be returned when querying the field, which prevents the user from being able to manage the issue.

This release fixes this to simply return null for the missing item. This also covers the behavior for when a user doesn't have read access for an item.

UI Fixes ⚙️

A variety of UI fixes are in this release when rendering fields in the Admin UI:

  • The value of data passed to the inline relationship renderer now matches the data returned by the GraphQL query.
  • Falsey values of data.label are no longer set to data.id and falsey values of data.data are no longer set to {}.
  • Fixed the relationship name not being passed to the inline relationship renderer.
  • Fixed confusing error when providing fields that don't exist to ui.cardFields, ui.inlineCreate.fields and ui.inlineEdit.fields.
  • Fixed relationship field with displayMode: 'cards' not using labels for related items in the cell view.

Types for KeystoneContext, KeystoneListsAPI and KeystoneDbAPI 🪢

We've added generated types for KeystoneContext, KeystoneListsAPI and KeystoneDbAPI.

You can now import these from .keystone/types (instead of @keystone-next/types) to get types that are pre-bound to your project's schema.

Housekeeping 🧹

Another update for Prisma, version 2.26.0, check out the Prisma releases page for more details.

Our packages-next folder has moved over to packages as part of our push to a general availability release in the near future!

Enjoying Keystone?

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


View verbose release notes

Releases

@keystone-next/document-renderer@4.0.0

Major Changes

  • #6040 890e3d0a5 Thanks @timleslie! - The value of data passed to the inline relationship renderer now matches the data returned by the GraphQL query.
    Falsey values of data.label are no longer set to data.id and falsey values of data.data are no longer set to {}.

Patch Changes

@keystone-next/fields@12.0.0

Major Changes

Patch Changes

@keystone-next/keystone@22.0.0

Major Changes

Patch Changes

  • #6087 139d7a8de Thanks @JedWatson! - Move source code from the packages-next to the packages directory.

  • #6094 279403cb0 Thanks @timleslie! - Refactored internal nested mutation input handler code.

  • #6045 253df44c2 Thanks @mitchellhamilton! - Adjusted when getAdminMeta is called on fields so that they can see the metadata (excluding the results of getAdminMeta on fields) of other fields to do validation or etc.

  • #6093 f482db633 Thanks @JedWatson! - Added generated types for KeystoneContext, KeystoneListsAPI and KeystoneDbAPI.

    You can now import these from .keystone/types (instead of @keystone-next/types) to get types that are pre-bound to your project's schema.

  • Updated dependencies [38b78f2ae, 5f3d407d7, 139d7a8de, 253df44c2, c536b478f]:

    • @keystone-next/fields@12.0.0
    • @keystone-next/types@22.0.0
    • @keystone-ui/core@3.1.1
    • @keystone-next/admin-ui-utils@5.0.4
    • @keystone-next/utils@1.0.2

@keystone-next/types@22.0.0

Major Changes

Patch Changes

Read more

✨ 30th June 2021

30 Jun 07:28
bb8e11d
Compare
Choose a tag to compare

What's New

We've fixed an issue with cloudinaryImage and relationship fields. 🔥

"@keystone-next/auth": "28.0.1",
"@keystone-next/cloudinary": "6.0.3",
"@keystone-next/fields": "11.0.3",
"@keystone-next/keystone": "21.0.2",
"@keystone-next/session-store-redis": "3.0.1",
"@keystone-next/types": "21.0.1",

Field Options Hotfix 🔥

We've discovered an issue where cloudinaryImage and relationship fields were not passing through access control, hooks, ui and graphql options to Keystone, this is now resolved!

Enjoying Keystone?

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


View verbose release notes

Releases

@keystone-next/auth@28.0.1

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2
    • @keystone-next/types@21.0.1

@keystone-next/cloudinary@6.0.3

Patch Changes

  • #6031 0988f08c2 Thanks @mitchellhamilton! - Fixed cloudinaryImage field not passing through access control, hooks, ui and graphql options to Keystone.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/types@21.0.1

@keystone-next/fields@11.0.3

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • #6031 0988f08c2 Thanks @mitchellhamilton! - Fixed relationship field not passing through access control, hooks, ui and graphql options to Keystone.

  • Updated dependencies [038cd09a2]:

    • @keystone-next/keystone@21.0.2
    • @keystone-next/types@21.0.1

@keystone-next/keystone@21.0.2

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/types@21.0.1

@keystone-next/session-store-redis@3.0.1

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

@keystone-next/types@21.0.1

Patch Changes

@keystone-next/website@3.1.2

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

@keystone-next/example-default-values@1.0.3

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2

@keystone-next/example-document-field@1.0.2

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2

@keystone-next/example-extend-graphql-schema@1.0.3

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2

@keystone-next/example-json-field@4.0.4

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2

@keystone-next/example-testing@0.0.3

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/auth@28.0.1
    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2
    • @keystone-next/types@21.0.1

@keystone-next/example-with-auth@2.0.4

Patch Changes

  • #6029 038cd09a2 Thanks @bladey! - Updated Keystone URL reference from next.keystonejs.com to keystonejs.com.

  • Updated dependencies [038cd09a2, 0988f08c2]:

    • @keystone-next/auth@28.0.1
    • @keystone-next/fields@11.0.3
    • @keystone-next/keystone@21.0.2

✨ 29th June 2021

29 Jun 07:25
020e210
Compare
Choose a tag to compare

What's New

The ID Field option has been revamped with cuid, uuid and autoincrement options! 🤹

"@keystone-next/admin-ui-utils": "5.0.3",
"@keystone-next/auth": "28.0.0",
"@keystone-next/cloudinary@": "6.0.2",
"@keystone-next/fields": "11.0.2",
"@keystone-next/fields-document": "7.0.1",
"@keystone-next/keystone": "21.0.1",
"@keystone-next/testing": "1.0.1",
"@keystone-next/types": "21.0.0",
"@keystone-next/utils": "1.0.1",

New ID Fields 🧮

We've replaced the idField list configuration option with a more constrained option, db.idField.

This option accepts an object with a kind property with a value of:

  • cuid
  • uuid
  • autoincrement

The default behaviour has changed from using autoincrement to using cuids.

To keep the current behaviour, you should set { kind: 'autoincrement' } at db.idField in your top level config.

db.idField can be set on either the top level config object:

config({
  db: {
    idField: { kind: 'uuid' }
  },
  lists,
});

Or on individual lists:

config({
  db,
  lists: createSchema({
    User: list({
      db: {
        idField: { kind: 'uuid' },
      },
      fields: {
        name: text({ isRequired: true }),
      },
    }),
});

Enjoying Keystone?

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


View verbose release notes

Releases

@keystone-next/keystone@21.0.1

Major Changes

  • #5947 03f535ba6 Thanks @mitchellhamilton! - Replaced the idField list configuration option with a more constrained option, db.idField, that accepts an object with a kind property with a value of cuid, uuid or autoincrement. db.idField can be set on either the top level config object, or on individual lists.

    The default behaviour has changed from using autoincrement to using cuids. To keep the current behaviour, you should set { kind: 'autoincrement' } at db.idField in your top level config.

  • #5947 03f535ba6 Thanks @mitchellhamilton! - Id field filters no longer allow null to be passed because ids can never be null. For the in and not_in, this is reflected in the GraphQL types

  • #6022 475307e0e Thanks @mitchellhamilton! - Fixed error when loading the Admin UI due to the id field changes.

Patch Changes

  • Updated dependencies [03f535ba6]:
    • @keystone-next/types@21.0.0
    • @keystone-next/fields@11.0.2
    • @keystone-next/admin-ui-utils@5.0.3
    • @keystone-next/utils@1.0.1

@keystone-next/types@21.0.0

Major Changes

  • #5947 03f535ba6 Thanks @mitchellhamilton! - Replaced the idField list configuration option with a more constrained option, db.idField, that accepts an object with a kind property with a value of cuid, uuid or autoincrement. db.idField can be set on either the top level config object, or on individual lists.

    The default behaviour has changed from using autoincrement to using cuids. To keep the current behaviour, you should set { kind: 'autoincrement' } at db.idField in your top level config.

Patch Changes

  • Updated dependencies []:
    • @keystone-next/fields@11.0.2

@keystone-next/admin-ui-utils@5.0.3

Patch Changes

  • Updated dependencies [03f535ba6]:
    • @keystone-next/types@21.0.0

@keystone-next/auth@28.0.0

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/types@21.0.0
    • @keystone-next/fields@11.0.2
    • @keystone-next/admin-ui-utils@5.0.3

@keystone-next/cloudinary@6.0.2

Patch Changes

  • Updated dependencies [03f535ba6]:
    • @keystone-next/types@21.0.0
    • @keystone-next/fields@11.0.2

@keystone-next/fields@11.0.2

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/types@21.0.0
    • @keystone-next/admin-ui-utils@5.0.3
    • @keystone-next/utils@1.0.1

@keystone-next/fields-document@7.0.1

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/types@21.0.0
    • @keystone-next/fields@11.0.2
    • @keystone-next/admin-ui-utils@5.0.3

@keystone-next/testing@1.0.1

Patch Changes

@keystone-next/utils@1.0.1

Patch Changes

  • Updated dependencies [03f535ba6]:
    • @keystone-next/types@21.0.0

@keystone-next/example-assets-cloud@1.0.1

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/fields@11.0.2

@keystone-next/example-assets-local@1.0.1

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/fields@11.0.2

@keystone-next/example-auth@4.0.3

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/auth@28.0.0
    • @keystone-next/fields@11.0.2

@keystone-next/examples-app-basic@4.0.3

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/types@21.0.0
    • @keystone-next/auth@28.0.0
    • @keystone-next/fields@11.0.2
    • @keystone-next/fields-document@7.0.1

@keystone-next/example-ecommerce@4.0.4

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/types@21.0.0
    • @keystone-next/auth@28.0.0
    • @keystone-next/fields@11.0.2
    • @keystone-next/cloudinary@6.0.2

@keystone-next/example-embedded-nextjs@3.0.3

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/fields@11.0.2

keystone-next-app@1.0.3

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/auth@28.0.0
    • @keystone-next/fields@11.0.2
    • @keystone-next/fields-document@7.0.1

@keystone-next/example-playground@1.0.2

Patch Changes

  • Updated dependencies [03f535ba6, 03f535ba6]:
    • @keystone-next/keystone@21.0.0
    • @keystone-next/fields@...
Read more

✨ 28th June 2021

28 Jun 06:12
235459e
Compare
Choose a tag to compare

What's New

An assortment of good things in this release! A new package to help test the behaviour of your GraphQL API, a document field example, better error messages, accessibility updates and another Prisma update! 🍱

"@keystone-ui/fields": "4.1.2",
"@keystone-ui/options": "4.0.1",
"@keystone-ui/pill": "5.0.0",
"@keystone-ui/popover": "4.0.2",
"@keystone-ui/toast": "4.0.1",
"@keystone-next/cloudinary": "6.0.1",
"@keystone-next/fields": "11.0.1",
"@keystone-next/keystone": "20.0.1",
"@keystone-next/testing": "1.0.0",
"@keystone-next/types": "20.0.1",
"@keystone-next/utils": "1.0.0",

Testing Package 🧪

We’ve shipped a new package called @keystone-next/testing to help you write tests for your GraphQL API!

Check out the guide on the Keystone website for more details.

Document Field Example ✍️

We have a new example project for the document field which covers the basic use case of configuring the toolbar, rendering the document field in a front end, and providing custom renderers for the built in data.

Another example showing advanced use cases is in-progress and will be available soon!

Error Messages ❗

GraphQL error messages are far more helpful when running queries. You will now get relevant error messages instead of getting Cannot assign to read only property 'path' of object '#<Object>'" back.

Thanks @tjbp for contributing this fix!

Improved Types for KeystoneContext 📜

⚠️ We've tweaked lists and db.lists APIs on KeystoneContext to have improved types. If you're using the generated KeystoneListsTypeInfo type like this:

const lists: KeystoneListsAPI<KeystoneListsTypeInfo> = context.lists;

You will have to change it to use as like this:

const lists = context.lists as KeystoneListsAPI<KeystoneListsTypeInfo>;

UI Accessibility 🏷️

Another set of accessibility improvements in the Admin UI in this release including assorted quality of life and screen reader improvements to Filter pills and dialogs, as well as labels and descriptions.

Prisma update ⬆️

We've updated our Prisma dependencies to 2.25.0, check out the Prisma releases page for more information.

Enjoying Keystone?

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


View verbose release notes

Releases

@keystone-ui/pill@5.0.0

Major Changes

  • #5987 972e04514 Thanks @gwyneplaine! - Added containerProps prop, these are spread onto the containing element. All other props are now spread onto the internal PillButton component (this change is inclusive of refs).

@keystone-next/testing@1.0.0

Major Changes

Patch Changes

@keystone-next/utils@1.0.0

Major Changes

Patch Changes

@keystone-ui/fields@4.1.2

Patch Changes

@keystone-ui/options@4.0.1

Patch Changes

@keystone-ui/popover@4.0.2

Patch Changes

@keystone-ui/toast@4.0.1

Patch Changes

@keystone-next/cloudinary@6.0.1

Patch Changes

@keystone-next/fields@11.0.1

Patch Changes

Read more