AdminBro.mergeFeature function

[wojtek-krysiak]

Describe the problem feature solves

There are things that we very often reuse among projects. So it would be good to have an easy programming interface to attaching this "features".

Example feature:

• file upload or even an entire Media Dashboard.
• google map
• password hashing
• CMS
• csv export

Describe the solution you'd like

When you pass resource with options you will have another option: features like this:

const options: AdminBroOptions = {
  resources: [{
    resource: MyResource,
    options: {...},
    features: [feature1, feature2, feature3({ /** you can also pass options here */ })]
  }]
}

Each feature will be a simple function taking ResourceOptions as an argument and returning its modified version.

By carrying we could implement passing options like this:

const options: AdminBroOptions = {
  resources: [{
    resource: MyResource,
    features: [s3Uploader({
       accessKeyId: process.env.AWS_ACCESS_KEY,
       ...
       store: {
          s3Key: 'uploadedFile.s3Key',
          s3Bucket: 'bucket',
       }
    })]
  }]
}

possible implementation of this function would be:

const s3Uploader = (options: s3UploaderOptions) => (originalResourceOptions: ResourceOptions) => {
  const uploadComponent = AdminBro.bundle('./....tsx')
  return AdminBro.mergeFeature(originalResourceOptions, {
      actions: {
        before: ....,
      }
  })
}

So everything comes down to implement a AdminBro.mergeFeature static function.

AdminBro.mergeFeature should be a helper which will work similarly to _.merge from lodash but it will have to handle merging all hooks which user already created.

• add mergeFeature.
• write unit tests covering that.
• write an example feature in the example-app with e2e tests
• write documentation.

[github-actions]

🎉 This issue has been resolved in version 3.0.0-beta.6 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[github-actions]

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀