Merge pull request #1283 from contentful/field-resolver

feat: support graphQL annotations [MONET-1302]

Author: kdamball

examples/43-assign-field-annotations.js

@@ -1,4 +1,10 @@
 module.exports = function (migration) {
   const annotatedContentType = migration.editContentType('annotated')
   annotatedContentType.editField('sources').setAnnotations(['Contentful:AggregateComponent'])
+  annotatedContentType.editField('title').setAnnotations(['Contentful:GraphQLFieldResolver'], {
+    parameters: {
+      appFunctionId: '123',
+      appDefinitionId: '456'
+    }
+  })
 }

examples/44-clear-field-annotations.js

@@ -1,4 +1,5 @@
 module.exports = function (migration) {
   const annotatedContentType = migration.editContentType('annotated')
   annotatedContentType.editField('sources').clearAnnotations()
+  annotatedContentType.editField('title').clearAnnotations()
 }

src/lib/action/field-annotate.ts

@@ -5,12 +5,19 @@ class FieldAnnotateAction extends EntityAction {
   private contentTypeId: string
   private fieldId: string
   private annotations: AnnotationLink[]
+  private fieldAnnotationPayload: Record<string, any>
 
-  constructor(contentTypeId: string, fieldId: string, annotations?: AnnotationLink[]) {
+  constructor(
+    contentTypeId: string,
+    fieldId: string,
+    annotations?: AnnotationLink[],
+    fieldAnnotationPayload?: Record<string, any>
+  ) {
     super()
     this.contentTypeId = contentTypeId
     this.fieldId = fieldId
     this.annotations = annotations
+    this.fieldAnnotationPayload = fieldAnnotationPayload
   }
 
   getEntityId(): string {
@@ -25,7 +32,7 @@ class FieldAnnotateAction extends EntityAction {
     if (!this.annotations || !this.annotations.length) {
       ct.clearFieldAnnotations(this.fieldId)
     } else {
-      ct.setFieldAnnotations(this.fieldId, this.annotations)
+      ct.setFieldAnnotations(this.fieldId, this.annotations, this.fieldAnnotationPayload)
     }
   }
 }

src/lib/entities/content-type.ts

@@ -711,8 +711,16 @@ class ContentType {
     delete this._metadata?.annotations?.ContentType
   }
 
-  setFieldAnnotations(fieldId: string, annotations: AnnotationLink[]) {
-    set(this, `_metadata.annotations.ContentTypeField.${fieldId}`, annotations)
+  setFieldAnnotations(
+    fieldId: string,
+    annotations: AnnotationLink[],
+    fieldAnnotationPayload?: Record<string, any>
+  ) {
+    set(
+      this,
+      `_metadata.annotations.ContentTypeField.${fieldId}`,
+      Object.assign(annotations, fieldAnnotationPayload)
+    )
   }
 
   getFieldAnnotations(fieldId: string) {

src/lib/intent/field-annotate.ts

@@ -31,7 +31,8 @@ export default class FieldAnnotateIntent extends Intent {
         id,
         type: 'Link',
         linkType: 'Annotation'
-      }
+      },
+      ...this.payload.fieldAnnotationPayload
     }))
     return [new FieldAnnotateAction(this.getContentTypeId(), this.getFieldId(), annotationLinks)]
   }

src/lib/interfaces/annotation.ts

@@ -94,6 +94,28 @@ export const availableAnnotations = {
         ]
       }
     ]
+  }),
+  'Contentful:GraphQLFieldResolver': new Annotation({
+    id: 'Contentful:GraphQLFieldResolver',
+    targets: [
+      {
+        type: 'ContentTypeField',
+        accept: [
+          {
+            type: 'Symbol'
+          },
+          {
+            type: 'Array',
+            items: {
+              type: 'Symbol'
+            }
+          },
+          {
+            type: 'Object'
+          }
+        ]
+      }
+    ]
   })
 }
 

src/lib/interfaces/raw-step.ts

@@ -52,6 +52,7 @@ interface RawStepPayload {
   tagVisibility?: TagVisibility
   entryTransformationForTags?: EntrySetTags
   annotations?: AnnotationId[]
+  fieldAnnotationPayload?: Record<string, any>
 }
 
 interface EditorInterfaceInfo {

src/lib/migration-steps/action-creators.ts

@@ -674,7 +674,8 @@ const actionCreators = {
       fieldId,
       fieldInstanceId,
       callsite,
-      annotationIds
+      annotationIds,
+      fieldAnnotationPayload?
     ): Intents.FieldAnnotate =>
       new Intents.FieldAnnotate({
         type: 'field/annotate',
@@ -689,7 +690,8 @@ const actionCreators = {
         payload: {
           contentTypeId,
           fieldId,
-          annotations: annotationIds
+          annotations: annotationIds,
+          fieldAnnotationPayload
         }
       })
   },

src/lib/migration-steps/index.ts

@@ -52,7 +52,7 @@ class Field extends DispatchProxy {
     })
   }
 
-  setAnnotations(annotationIds: string[]) {
+  setAnnotations(annotationIds: string[], fieldAnnotationPayload?: Record<string, any>) {
     const callsite = getFirstExternalCaller()
     const fieldInstanceId = this.contentType.fieldInstanceIds.getNew(this.id)
     this.contentType.dispatch(
@@ -62,7 +62,8 @@ class Field extends DispatchProxy {
         this.id,
         fieldInstanceId,
         callsite,
-        annotationIds
+        annotationIds,
+        fieldAnnotationPayload
       )
     )
 

test/integration/migration.spec.js

@@ -1217,6 +1217,19 @@ describe('the migration', function () {
                 linkType: 'Annotation'
               }
             }
+          ],
+          title: [
+            {
+              sys: {
+                type: 'Link',
+                linkType: 'Annotation',
+                id: 'Contentful:GraphQLFieldResolver'
+              },
+              parameters: {
+                appFunctionId: '123',
+                appDefinitionId: '456'
+              }
+            }
           ]
         }
       }