Add graphql.excludeKeystoneMeta configuration

docs/pages/docs/config/config.md

@@ -331,7 +331,6 @@ Options:
   - `'apollo'` - Do not add any plugins to the Apollo config, this will use [Apollo Sandbox](https://www.apollographql.com/docs/apollo-server/testing/build-run-queries/#apollo-sandbox)
 - `apolloConfig` (default: `undefined`): Allows you to pass [extra options](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#constructor) into the `ApolloServer` constructor.
 - `schemaPath` (default: `schema.graphql`): The path of the generated GraphQL API schema.
-- `excludeKeystoneMeta` (default: `undefined`): Allows you to exclude `keystone` query used by the Admin UI from the GraphQL API. If set to `true`, Admin UI will not be operational, so use it only in instances where you do not need it (when setting ui.isDisabled and/or using keystone in custom setup like `examples/framework-nextjs-*-directory`).
 
 ```typescript
 export default config({

packages/core/src/lib/createGraphQLSchema.ts

@@ -116,14 +116,15 @@ export function createGraphQLSchema(
             }),
           }
         : {},
-      query: adminMeta
-        ? {
-            keystone: graphql.field({
-              type: graphql.nonNull(KeystoneMeta),
-              resolve: () => ({ adminMeta }),
-            }),
-          }
-        : {},
+      query:
+        adminMeta && !config.ui?.isDisabled
+          ? {
+              keystone: graphql.field({
+                type: graphql.nonNull(KeystoneMeta),
+                resolve: () => ({ adminMeta }),
+              }),
+            }
+          : {},
     },
     sudo
   );

packages/core/src/types/config/index.ts

@@ -283,7 +283,10 @@ export type GraphQLConfig<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystoneTy
    */
   debug?: boolean;
 
-  // The path to GraphQL schema. Default: 'schema.graphql'.
+  /**
+   * The path to GraphQL schema
+   * @default 'schema.graphql'
+   */
   schemaPath?: string;
 };
 

tests/cli-tests/artifacts.test.ts

@@ -9,6 +9,7 @@ import {
   symlinkKeystoneDeps,
   testdir,
   customGraphqlPathKeystoneConfig,
+  customUiDiabledKeystoneConfig,
 } from './utils';
 
 describe.each(['postinstall', ['build', '--frozen']])('%s', command => {
@@ -104,9 +105,20 @@ describe('postinstall', () => {
     });
     const recording = recordConsole();
     await runCommand(tmp, ['postinstall', '--fix']);
-    const schemas = ['schema.prisma', 'different_schema.graphql'];
+    const schemas = ['different_schema.graphql'];
     const files = await getFiles(tmp, schemas);
     expect(files).toEqual(await getFiles(`${__dirname}/fixtures/custom-graphql-path`, schemas));
     expect(recording()).toMatchInlineSnapshot(`"? Generated GraphQL and Prisma schemas"`);
   });
+  test('disabling ui makes keystone query and KeystoneAdmin types disappear from schema', async () => {
+    const tmp = await testdir({
+      ...symlinkKeystoneDeps,
+      'keystone.js': customUiDiabledKeystoneConfig,
+    });
+    const recording = recordConsole();
+    await runCommand(tmp, ['postinstall', '--fix']);
+    const files = await getFiles(tmp, schemasMatch);
+    expect(files).toEqual(await getFiles(`${__dirname}/fixtures/custom-ui-disabled`, schemasMatch));
+    expect(recording()).toMatchInlineSnapshot(`"? Generated GraphQL and Prisma schemas"`);
+  });
 });

tests/cli-tests/fixtures/basic-project/keystone.ts

@@ -7,7 +7,6 @@ export default config({
     provider: 'sqlite',
     url: 'file:./app.db',
   },
-  ui: { isDisabled: true },
   lists: {
     Todo: list({
       access: allowAll,

tests/cli-tests/fixtures/custom-graphql-path/different_schema.graphql

@@ -98,112 +98,4 @@ type Query {
   todos(where: TodoWhereInput! = {}, orderBy: [TodoOrderByInput!]! = [], take: Int, skip: Int! = 0, cursor: TodoWhereUniqueInput): [Todo!]
   todo(where: TodoWhereUniqueInput!): Todo
   todosCount(where: TodoWhereInput! = {}): Int
-  keystone: KeystoneMeta!
-}
-
-type KeystoneMeta {
-  adminMeta: KeystoneAdminMeta!
-}
-
-type KeystoneAdminMeta {
-  lists: [KeystoneAdminUIListMeta!]!
-  list(key: String!): KeystoneAdminUIListMeta
-}
-
-type KeystoneAdminUIListMeta {
-  key: String!
-  itemQueryName: String!
-  listQueryName: String!
-  hideCreate: Boolean!
-  hideDelete: Boolean!
-  path: String!
-  label: String!
-  singular: String!
-  plural: String!
-  description: String
-  initialColumns: [String!]!
-  pageSize: Int!
-  labelField: String!
-  fields: [KeystoneAdminUIFieldMeta!]!
-  groups: [KeystoneAdminUIFieldGroupMeta!]!
-  initialSort: KeystoneAdminUISort
-  isHidden: Boolean!
-  isSingleton: Boolean!
-}
-
-type KeystoneAdminUIFieldMeta {
-  path: String!
-  label: String!
-  description: String
-  isOrderable: Boolean!
-  isFilterable: Boolean!
-  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
-  fieldMeta: JSON
-  viewsIndex: Int!
-  customViewsIndex: Int
-  createView: KeystoneAdminUIFieldMetaCreateView!
-  listView: KeystoneAdminUIFieldMetaListView!
-  itemView(id: ID): KeystoneAdminUIFieldMetaItemView
-  search: QueryMode
-}
-
-enum KeystoneAdminUIFieldMetaIsNonNull {
-  read
-  create
-  update
-}
-
-type KeystoneAdminUIFieldMetaCreateView {
-  fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
-}
-
-enum KeystoneAdminUIFieldMetaCreateViewFieldMode {
-  edit
-  hidden
-}
-
-type KeystoneAdminUIFieldMetaListView {
-  fieldMode: KeystoneAdminUIFieldMetaListViewFieldMode!
-}
-
-enum KeystoneAdminUIFieldMetaListViewFieldMode {
-  read
-  hidden
-}
-
-type KeystoneAdminUIFieldMetaItemView {
-  fieldMode: KeystoneAdminUIFieldMetaItemViewFieldMode
-  fieldPosition: KeystoneAdminUIFieldMetaItemViewFieldPosition
-}
-
-enum KeystoneAdminUIFieldMetaItemViewFieldMode {
-  edit
-  read
-  hidden
-}
-
-enum KeystoneAdminUIFieldMetaItemViewFieldPosition {
-  form
-  sidebar
-}
-
-enum QueryMode {
-  default
-  insensitive
-}
-
-type KeystoneAdminUIFieldGroupMeta {
-  label: String!
-  description: String
-  fields: [KeystoneAdminUIFieldMeta!]!
-}
-
-type KeystoneAdminUISort {
-  field: String!
-  direction: KeystoneAdminUISortDirection!
-}
-
-enum KeystoneAdminUISortDirection {
-  ASC
-  DESC
 }

tests/cli-tests/fixtures/custom-prisma-project/keystone.ts

@@ -11,7 +11,6 @@ export default config({
         .replace(/(\ngenerator[^\n]+\{[^\}]+)\}/, '$1  previewFeatures = ["multiSchema"]\n}')
         .replace(/(datasource[^\n]+\{[^\}]+)\}/, '$1  schemas = ["first", "second"]\n}'),
   },
-  ui: { isDisabled: true },
   lists: {
     Todo: list({
       access: allowAll,

tests/cli-tests/fixtures/custom-prisma-project/schema.graphql

@@ -95,7 +95,7 @@ type Mutation {
 }
 
 type Query {
-  todos(where: TodoWhereInput! = {}, orderBy: [TodoOrderByInput!]! = [], take: Int, skip: Int! = 0): [Todo!]
+  todos(where: TodoWhereInput! = {}, orderBy: [TodoOrderByInput!]! = [], take: Int, skip: Int! = 0, cursor: TodoWhereUniqueInput): [Todo!]
   todo(where: TodoWhereUniqueInput!): Todo
   todosCount(where: TodoWhereInput! = {}): Int
   keystone: KeystoneMeta!

tests/cli-tests/fixtures/custom-exclude-meta/keystone.ts → tests/cli-tests/fixtures/custom-ui-disabled/keystone.ts

@@ -16,7 +16,4 @@ export default config({
       },
     }),
   },
-  graphql: {
-    excludeKeystoneMeta: true,
-  },
 });

tests/cli-tests/utils.tsx

@@ -45,6 +45,11 @@ export const customGraphqlPathKeystoneConfig = fs.readFileSync(
   'utf8'
 );
 
+export const customUiDiabledKeystoneConfig = fs.readFileSync(
+  `${__dirname}/fixtures/custom-ui-disabled/keystone.ts`,
+  'utf8'
+);
+
 export function recordConsole() {
   let oldConsole = { ...console };
   const contents: string[] = [];