Singletons (#7863)

Co-authored-by: Daniel Cousens <dcousens@users.noreply.github.com>
keystonejs · Sep 7, 2022 · 524431b · 524431b
1 parent f251e51
commit 524431b
Show file tree

Hide file tree

Showing 87 changed files with 1,258 additions and 151 deletions.
diff --git a/.changeset/lazy-experts-shop.md b/.changeset/lazy-experts-shop.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Adds a new `singleton` list function for configuring Singleton lists
diff --git a/;e b/;e
@@ -0,0 +1,49 @@
+import type { KeystoneConfig } from '../../types';
+import { idFieldType } from '../id-field';
+
+/* Validate lists config and default the id field */
+export function applyIdFieldDefaults(config: KeystoneConfig): KeystoneConfig['lists'] {
+  const lists: KeystoneConfig['lists'] = {};
+  const defaultIdField = config.db.idField ?? { kind: 'cuid' };
+  if (
+    defaultIdField.kind === 'autoincrement' &&
+    defaultIdField.type === 'BigInt' &&
+    config.db.provider === 'sqlite'
+  ) {
+    throw new Error(
+      'BigInt autoincrements are not supported on SQLite but they are configured as the global id field type at db.idField'
+    );
+  }
+  Object.keys(config.lists).forEach(key => {
+    const listConfig = config.lists[key];
+    if (listConfig.fields.id) {
+      throw new Error(
+        `A field with the \`id\` path is defined in the fields object on the ${JSON.stringify(
+          key
+        )} list. This is not allowed, use the idField option instead.`
+      );
+    }
+    if (
+      listConfig.db?.idField?.kind === 'autoincrement' &&
+      listConfig.db.idField.type === 'BigInt' &&
+      config.db.provider === 'sqlite'
+    ) {
+      throw new Error(
+        `BigInt autoincrements are not supported on SQLite but they are configured at db.idField on the ${key} list`
+      );
+    }
+
+    if (listConfig.isSingleton && listConfig.db?.idField) {
+      throw new Error(
+        `A singleton list cannot specify an idField, but it is configured at db.idField on the ${key} list`
+      );
+    }
+    const idFieldConfig = listConfig.db?.idField ?? defaultIdField;
+
+    const idField = idFieldType(idFieldConfig, !!listConfig.isSingleton);
+
+    const fields = { id: idField, ...listConfig.fields };
+    lists[key] = { ...listConfig, fields };
+  });
+  return lists;
+}
diff --git a/examples/assets-local/schema.graphql b/examples/assets-local/schema.graphql
@@ -294,6 +294,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/assets-s3/schema.graphql b/examples/assets-s3/schema.graphql
@@ -294,6 +294,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/auth/schema.graphql b/examples/auth/schema.graphql
@@ -178,6 +178,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/basic/schema.graphql b/examples/basic/schema.graphql
@@ -443,6 +443,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/blog/schema.graphql b/examples/blog/schema.graphql
@@ -255,6 +255,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/custom-admin-ui-logo/schema.graphql b/examples/custom-admin-ui-logo/schema.graphql
@@ -255,6 +255,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/custom-admin-ui-navigation/schema.graphql b/examples/custom-admin-ui-navigation/schema.graphql
@@ -255,6 +255,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/custom-admin-ui-pages/schema.graphql b/examples/custom-admin-ui-pages/schema.graphql
@@ -255,6 +255,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/custom-field-view/schema.graphql b/examples/custom-field-view/schema.graphql
@@ -258,6 +258,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/custom-field/schema.graphql b/examples/custom-field/schema.graphql
@@ -146,6 +146,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/custom-session-validation/schema.graphql b/examples/custom-session-validation/schema.graphql
@@ -296,6 +296,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/default-values/schema.graphql b/examples/default-values/schema.graphql
@@ -255,6 +255,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/document-field-customisation/keystone-server/package.json b/examples/document-field-customisation/keystone-server/package.json
@@ -4,7 +4,7 @@
   "version": "0.0.1",
   "private": true,
   "repository": "https://github.com/keystonejs/keystone/tree/main/examples/document-field-customisation/keystone-server",
-  "scripts": {  
+  "scripts": {
     "dev": "keystone dev --seed-database",
     "start": "keystone start --seed-database",
     "build": "keystone build"

diff --git a/examples/document-field-customisation/keystone-server/schema.graphql b/examples/document-field-customisation/keystone-server/schema.graphql
@@ -246,6 +246,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/document-field/schema.graphql b/examples/document-field/schema.graphql
@@ -270,6 +270,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/e2e-boilerplate/keystone-server/package.json b/examples/e2e-boilerplate/keystone-server/package.json
@@ -4,8 +4,7 @@
   "version": "0.0.1",
   "private": true,
   "repository": "https://github.com/keystonejs/keystone/tree/main/examples/e2e-boilerplate/keystone-server",
-  "scripts": {  
-
+  "scripts": {
     "dev": "keystone dev --seed-database",
     "start": "keystone start --seed-database",
     "build": "keystone build"

diff --git a/examples/e2e-boilerplate/keystone-server/schema.graphql b/examples/e2e-boilerplate/keystone-server/schema.graphql
@@ -246,6 +246,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/ecommerce/schema.graphql b/examples/ecommerce/schema.graphql
@@ -861,6 +861,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/embedded-nextjs/schema.graphql b/examples/embedded-nextjs/schema.graphql
@@ -137,6 +137,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/extend-graphql-schema-graphql-ts/schema.graphql b/examples/extend-graphql-schema-graphql-ts/schema.graphql
@@ -264,6 +264,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/extend-graphql-schema-nexus/schema.graphql b/examples/extend-graphql-schema-nexus/schema.graphql
@@ -257,6 +257,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/extend-graphql-schema/schema.graphql b/examples/extend-graphql-schema/schema.graphql
@@ -267,6 +267,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/extend-graphql-subscriptions/schema.graphql b/examples/extend-graphql-subscriptions/schema.graphql
@@ -258,6 +258,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/feature-boilerplate/schema.graphql b/examples/feature-boilerplate/schema.graphql
@@ -246,6 +246,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/graphql-api-endpoint/schema.graphql b/examples/graphql-api-endpoint/schema.graphql
@@ -387,6 +387,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/graphql-ts-gql/schema.graphql b/examples/graphql-ts-gql/schema.graphql
@@ -266,6 +266,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/json/schema.graphql b/examples/json/schema.graphql
@@ -222,6 +222,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/rest-api/schema.graphql b/examples/rest-api/schema.graphql
@@ -256,6 +256,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/roles/schema.graphql b/examples/roles/schema.graphql
@@ -372,6 +372,7 @@ type KeystoneAdminUIListMeta {
   fields: [KeystoneAdminUIFieldMeta!]!
   initialSort: KeystoneAdminUISort
   isHidden: Boolean!
+  isSingleton: Boolean
 }
 
 type KeystoneAdminUIFieldMeta {

diff --git a/examples/singleton/README.md b/examples/singleton/README.md
@@ -0,0 +1 @@
+## Base Project - Singleton
diff --git a/examples/singleton/keystone.ts b/examples/singleton/keystone.ts
@@ -0,0 +1,17 @@
+import { config } from '@keystone-6/core';
+import { lists } from './schema';
+import { insertSeedData } from './seed-data';
+import { Context } from '.keystone/types';
+
+export default config({
+  db: {
+    provider: 'sqlite',
+    url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+    async onConnect(context: Context) {
+      if (process.argv.includes('--seed-data')) {
+        await insertSeedData(context);
+      }
+    },
+  },
+  lists,
+});
diff --git a/examples/singleton/package.json b/examples/singleton/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "@keystone-6/singleton",
+  "version": "0.0.4",
+  "private": true,
+  "license": "MIT",
+  "scripts": {
+    "dev": "keystone dev",
+    "start": "keystone start",
+    "build": "keystone build",
+    "seed-data": "keystone --seed-data"
+  },
+  "dependencies": {
+    "@keystone-6/core": "^2.2.0"
+  },
+  "devDependencies": {
+    "typescript": "^4.7.4"
+  },
+  "repository": "https://github.com/keystonejs/keystone/tree/main/examples/singleton"
+}
diff --git a/examples/singleton/sandbox.config.json b/examples/singleton/sandbox.config.json
@@ -0,0 +1,7 @@
+{
+  "template": "node",
+  "container": {
+    "startScript": "keystone dev",
+    "node": "14"
+  }
+}