feat(modify): BREAKING CHANGE - Change the return result to include warnings

[sandrina-p]

Follow-up of #71.

Linear issue (internal)

Now the result is an object with both schema and warn. The warn will be an array of all warnings highlighting unexpected changes. This can help you spot and avoid possible bugs with your modifications.

Before

const schema = modify(yourSchema, config)

Now

const { schema, warnings } = modify(yourSchema, config)

The warnings is an array of objects (list of warnings), each one with a type and message. Eg:

[{
  type: "CHANGE_FIELD_NOT_FOUND",
  message: "'Changing field "unknown_field" was ignored because it does not exist.'"
}]

Remembering the warnings

When using modify(), it will also log a console.warn by default calling you out to handle the warnings on your behalf. For example, report it to your error tracking systems.

You can disable the log by passing muteWarningTip

const { schema, warnings } = modify(yourSchema, {
  muteLogging: true,
})

---

References:

• Initial discussion about this API in another PR feat(modify): Allow creating fields #80 (comment)