GraphQL addReference on Object Array

Summary

A way to have addReference traverse down into non root Types. collection.addReference(fieldName, typeName) and the source-filesystem options only apply to a root Type.

Basic example

My Input File:

field1: 'data'
field2: ['data1', 'data2']
field3:
- sub_field1: 'data'
  sub_field2: ['data1', 'data2']

This already works:

refs: {
  field1: 'typeName',
  field2: 'typeName'
}

This would be nice:

refs: {
  field3: {
    sub_field1: 'typeName'
    sub_field2: 'typeName'
}

Motivation

References are already very powerful, but they are limited by only applying at the Root level.

[belvederef]

I was experiencing the same problem @davidleininger was, and I solved it by declaring my own schema. Example:

 api.loadSource(({ addSchemaTypes }) => {
    addSchemaTypes(`
      type Comment implements Node {
        article: Article @reference(by: "id")
      }
    `);
  });

It was not working before specifying @reference(by: "id").

Just to be explicit, your Comment type needs to have a field article with a value that matches, in this case, the id field on the type Article.

From Comment I am now able to find the matching Article just using the field article. Instead, to find comments from an article, I used:

allArticle {
    edges {
      node {
        belongsTo {
          edges {
            node {
            	...on Comment {
                id
                content
              }
            }
          }
        }
      }
    }
  }

A bit convoluted but I could not find another way.

[davidleininger]

@hjvedvik I’m having an issue where the references aren’t getting made. I’ve added the following code to link one collection to another. I haven’t had an issue doing this in the past, but at the moment, GraphQL is just returning null for every reference.

Looking at the schema and the docs, in the playground, everything seems to be wired up correctly, but for whatever reason, everything comes back null.

api.loadSource(({ getCollection }) => {
    const restaurants = getCollection('Restaurants')
    restaurants.addReference('foodType', 'Types')
 })

In this case, it will return:

{
"id": "recwcDQAZGficxf0W",
"name": "O'Fallon Brewery",
"foodType": null
}