Made handling of field-specific config options more consistent (#2919)

* Made handling of field-specific config options more consistent

.changeset/long-wombats-reply.md

@@ -0,0 +1,8 @@
+---
+'@keystonejs/demo-custom-fields': patch
+'@keystonejs/fields': patch
+'@keystonejs/fields-auto-increment': patch
+'@keystonejs/cypress-project-basic': patch
+---
+
+Made handling of field-specific config options more consistent.

demo-projects/custom-fields/fields/Stars/Implementation.js

@@ -1,8 +1,13 @@
 const { Integer } = require('@keystonejs/fields');
 
 class Stars extends Integer.implementation {
+  constructor(path, { starCount = 5 }) {
+    super(...arguments);
+    this.starCount = starCount;
+  }
+
   extendAdminMeta(meta) {
-    return { ...meta, starCount: this.config.starCount || 5 };
+    return { ...meta, starCount: this.starCount };
   }
 }
 

packages/fields-auto-increment/src/Implementation.js

@@ -2,22 +2,25 @@ import { Implementation } from '@keystonejs/fields';
 import { KnexFieldAdapter } from '@keystonejs/adapter-knex';
 
 export class AutoIncrementImplementation extends Implementation {
-  constructor(path, config = {}, context = {}) {
+  constructor(path, { gqlType, isUnique = true, access = {}, ...config } = {}, context = {}) {
     // Apply some field type defaults before we hand off to super; see README.md
-    if (typeof config.isUnique === 'undefined') config.isUnique = true;
-    if (typeof config.access === 'undefined') config.access = {};
-    if (typeof config.access === 'object') {
-      config.access = { create: false, update: false, delete: false, ...config.access };
+    if (typeof access === 'object') {
+      access = { create: false, update: false, delete: false, ...access };
     }
 
     // The base implementation takes care of everything else
-    super(path, config, context);
+    super(
+      path,
+      {
+        ...config,
+        isUnique,
+        access,
+      },
+      context
+    );
 
     // If no valid gqlType is supplied, default based on whether or not we're the primary key
-    const gqlTypeDefault = this.isPrimaryKey ? 'ID' : 'Int';
-    this.gqlType = ['ID', 'Int'].includes(this.config.gqlType)
-      ? this.config.gqlType
-      : gqlTypeDefault;
+    this.gqlType = ['ID', 'Int'].includes(gqlType) ? gqlType : this.isPrimaryKey ? 'ID' : 'Int';
   }
 
   gqlOutputFields() {

packages/fields/src/types/Virtual/Implementation.js

@@ -4,27 +4,33 @@ import { KnexFieldAdapter } from '@keystonejs/adapter-knex';
 import { parseFieldAccess } from '@keystonejs/access-control';
 
 export class Virtual extends Implementation {
-  constructor() {
+  constructor(
+    path,
+    { resolver, graphQLReturnType = 'String', graphQLReturnFragment = '', extendGraphQLTypes = [] }
+  ) {
     super(...arguments);
+    this.resolver = resolver;
+    this.graphQLReturnType = graphQLReturnType;
+    this.graphQLReturnFragment = graphQLReturnFragment;
+    this.extendGraphQLTypes = extendGraphQLTypes;
   }
 
   gqlOutputFields() {
-    return [`${this.path}: ${this.config.graphQLReturnType || `String`}`];
+    return [`${this.path}: ${this.graphQLReturnType}`];
   }
   getGqlAuxTypes() {
-    return this.config.extendGraphQLTypes || [];
+    return this.extendGraphQLTypes;
   }
   gqlOutputFieldResolvers() {
-    return { [`${this.path}`]: this.config.resolver };
+    return { [`${this.path}`]: this.resolver };
   }
   gqlQueryInputFields() {
     return [];
   }
   extendAdminMeta(meta) {
     return {
       ...meta,
-      isOrderable: false,
-      graphQLSelection: this.config.graphQLReturnFragment || '',
+      graphQLSelection: this.graphQLReturnFragment,
       isReadOnly: true,
     };
   }

test-projects/basic/custom-fields/Stars/Implementation.js

@@ -1,8 +1,13 @@
 const { Integer } = require('@keystonejs/fields');
 
 class Stars extends Integer.implementation {
+  constructor(path, { starCount = 5 }) {
+    super(...arguments);
+    this.starCount = starCount;
+  }
+
   extendAdminMeta(meta) {
-    return { ...meta, starCount: this.config.starCount || 5 };
+    return { ...meta, starCount: this.starCount };
   }
 }