feat: provide entry id for transform and derive functions

[marcolink]

Summary

Provide the entry id for several transform callbacks.

Description

For all transformation functions (transformEntries, deriveLinkedEntries and transformEntriesToType) we provide the entry id of the entry in scope in the call signature of the transform callbacks. This allows for cross checking the id with any other source, or more custom validations within scope.

We opted-in for an wrapping object as a third parameter to eventually enrich the callback with further data in the future.

Example: (more in the updated readme)

module.exports = function (migration) {
  migration.transformEntries({
    contentType: 'newsArticle',
    from: ['author', 'authorCity'],
    to: ['byline'],
    transformEntryForLocale: function (fromFields, currentLocale, {id}) {
      
      if(id === '<specific-entry-id>') {
        return;
      }
      
      if (currentLocale === 'de-DE') {
        return;
      }
      const newByline = `${fromFields.author[currentLocale]} ${fromFields.authorCity[currentLocale]}`;
      return { byline: newByline };
    }
  });
};

Motivation and Context

This is solves issues #1170, #1029, and the super seeds PR.

Todos

• add tests
• Update readme

[ruderngespra]

Very cool to see this tackled 🎉

If I see this correctly, this is no breaking change as this id can be completely ignored in the callbacks and never has to be provided or passed through by customers directly?

[contentful-automation]

🎉 This PR is included in version 4.13.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀