Adds itemValue prop for custom field view components to allow value…

…-driven field conditions (#8619)

Co-authored-by: Daniel Cousens <[email protected]>

.changeset/add-condition-fields.md

@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Adds `itemValue` prop for custom field view components to allow value-driven field conditions

docs/scripts/replace-show-next-release/index.ts

@@ -1,26 +1,8 @@
 import fs from 'fs/promises';
 import { ValidateError } from '@markdoc/markdoc';
-import { globby } from 'globby';
 import { loadAllMarkdoc } from '../../markdoc/load-all';
 import { printValidationError } from '../../markdoc';
 import { removeNextReleaseConditions } from './markdoc';
-import { replaceShowNextRelease } from './typescript';
-
-async function updateTsFiles() {
-  const paths = await globby('pages/**/*.{ts,tsx}');
-
-  console.log(`updating ${paths.length} Typescript files`);
-  await Promise.all(
-    paths.map(async path => {
-      const source = await fs.readFile(path, 'utf8');
-
-      if (!source.includes('process.env.SHOW_NEXT_RELEASE')) return;
-
-      console.log(`  updating ${path}`);
-      await fs.writeFile(path, await replaceShowNextRelease(path, source));
-    })
-  );
-}
 
 async function updateMarkdocFiles() {
   const docs = await loadAllMarkdoc();
@@ -48,5 +30,5 @@ async function updateMarkdocFiles() {
 }
 
 (async () => {
-  await Promise.all([updateTsFiles(), updateMarkdocFiles()]);
+  await updateMarkdocFiles();
 })();

examples/custom-field/1-text-field/index.ts

@@ -7,10 +7,9 @@ import {
 } from '@keystone-6/core/types';
 import { graphql } from '@keystone-6/core';
 
-export type TextFieldConfig<ListTypeInfo extends BaseListTypeInfo> =
-  CommonFieldConfig<ListTypeInfo> & {
-    isIndexed?: boolean | 'unique';
-  };
+type TextFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<ListTypeInfo> & {
+  isIndexed?: boolean | 'unique';
+};
 
 export function text<ListTypeInfo extends BaseListTypeInfo>({
   isIndexed,

examples/custom-field/1-text-field/views.tsx

@@ -33,7 +33,7 @@ export function Field({ field, value, onChange, autoFocus }: FieldProps<typeof c
 }
 
 export const Cell: CellComponent = ({ item, field, linkTo }) => {
-  let value = item[field.path] + '';
+  const value = item[field.path] + '';
   return linkTo ? <CellLink {...linkTo}>{value}</CellLink> : <CellContainer>{value}</CellContainer>;
 };
 Cell.supportsLinkTo = true;

examples/custom-field/2-stars-field/index.ts

@@ -12,11 +12,10 @@ import { graphql } from '@keystone-6/core';
 // and a different input in the Admin UI
 // https://github.com/keystonejs/keystone/tree/main/packages/core/src/fields/types/integer
 
-export type StarsFieldConfig<ListTypeInfo extends BaseListTypeInfo> =
-  CommonFieldConfig<ListTypeInfo> & {
-    isIndexed?: boolean | 'unique';
-    maxStars?: number;
-  };
+type StarsFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<ListTypeInfo> & {
+  isIndexed?: boolean | 'unique';
+  maxStars?: number;
+};
 
 export const stars =
   <ListTypeInfo extends BaseListTypeInfo>({

examples/custom-field/3-pair-field-json/index.ts

@@ -6,8 +6,7 @@ import {
 } from '@keystone-6/core/types';
 import { graphql } from '@keystone-6/core';
 
-export type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> =
-  CommonFieldConfig<ListTypeInfo>;
+type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<ListTypeInfo>;
 
 type PairInput = {
   left: string | null | undefined;

examples/custom-field/3-pair-field-nested/index.ts

@@ -6,8 +6,7 @@ import {
 } from '@keystone-6/core/types';
 import { graphql } from '@keystone-6/core';
 
-export type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> =
-  CommonFieldConfig<ListTypeInfo>;
+type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<ListTypeInfo>;
 
 type PairInput = {
   left: string | null | undefined;

examples/custom-field/3-pair-field/index.ts

@@ -6,8 +6,7 @@ import {
 } from '@keystone-6/core/types';
 import { graphql } from '@keystone-6/core';
 
-export type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> =
-  CommonFieldConfig<ListTypeInfo>;
+type PairFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<ListTypeInfo>;
 
 type PairInput = string;
 type PairOutput = string;

examples/custom-field/4-conditional-field/index.tsx

@@ -0,0 +1,56 @@
+import {
+  BaseListTypeInfo,
+  fieldType,
+  FieldTypeFunc,
+  CommonFieldConfig,
+  orderDirectionEnum,
+} from '@keystone-6/core/types';
+import { graphql } from '@keystone-6/core';
+
+type TextFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<ListTypeInfo> & {
+  isIndexed?: boolean | 'unique';
+  dependency: {
+    field: string;
+    minimumValue: number;
+  };
+};
+
+export function feedback<ListTypeInfo extends BaseListTypeInfo>({
+  isIndexed,
+  dependency,
+  ...config
+}: TextFieldConfig<ListTypeInfo>): FieldTypeFunc<ListTypeInfo> {
+  return meta =>
+    fieldType({
+      kind: 'scalar',
+      mode: 'optional',
+      scalar: 'String',
+      index: isIndexed === true ? 'index' : isIndexed || undefined,
+    })({
+      ...config,
+      input: {
+        create: {
+          arg: graphql.arg({ type: graphql.String }),
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
+          resolve(value, context) {
+            return value;
+          },
+        },
+        update: { arg: graphql.arg({ type: graphql.String }) },
+        orderBy: { arg: graphql.arg({ type: orderDirectionEnum }) },
+      },
+      output: graphql.field({
+        type: graphql.String,
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        resolve({ value, item }, args, context, info) {
+          return value;
+        },
+      }),
+      views: './4-conditional-field/views',
+      getAdminMeta() {
+        return {
+          dependency,
+        };
+      },
+    });
+}