Ability to extend the template API

[richardguerre]

The idea is to allow for even more customization by being able to extend the template API.

The current template API is:

export type TemplateProps = {
  componentName: string;
  fragments: TemplateFragment[];
  query: TemplateQuery;
};

export type TemplateFragment = {
  name: string;
  propName: string;
  raw: string;
  selectionSet: string[];
};

export type TemplateQuery = {
  raw: string;
  fragments: {
    propName: string;
    dataPath: string;
  }[];
};

But it would be nice to have isPaginationFragment in the TemplateFragment type so that you can conditionally render a usePaginationFragment instead of useFragment.

To extend, there could be a extension.(js|ts) file inside .relay-butler that exports a function that takes in config (the config object defined in .relay-butler/config.js), api (the default output of relay-butler's template API), and ast (the parsed AST object from running graphql.parse(input) on the contents of input.graphql) and outputs a new API.
For example:

// extension.js
module.exports = (config, api, ast) => {
  if(ast.definitions.find((def) => def.type === 'MyType')) {
    api.isMyType = true;
  }

  return api;
}

Add 👍 to upvote.