Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow to transform and report back #59

Merged
merged 1 commit into from
Jan 5, 2023
Merged

Conversation

kptdobe
Copy link
Contributor

@kptdobe kptdobe commented Jan 5, 2023

A frequently requested feature: allow to report some info back.

The helix-importer-ui offers a report mechanism which provides an Excel spreadsheet will all the URLs imported and some process info. The ask to is be able to add more data per imported entry to the sheet.

@kptdobe
Copy link
Contributor Author

kptdobe commented Jan 5, 2023

Since this is a more advanced use of the importer, I have decided to not change the simple case (i.e. use of transformDOM / generateDocumentPath methods) but only support the report property when using the transform method which can now return an object (or an array of objects) like:

{
  path: String,
  element: DOMElement,
  report: Object
}

where report is an object containing properties (columns) and values (string, array, object) can be "stringified" and added to the XLSX report (or anything else in the case of a pure usage of this API).

@kptdobe kptdobe requested review from mhaack and removed request for mhaack January 5, 2023 15:10
@kptdobe kptdobe merged commit bfeea5d into main Jan 5, 2023
@kptdobe kptdobe deleted the transform-and-report branch January 5, 2023 15:10
github-actions bot pushed a commit that referenced this pull request Jan 5, 2023
# [2.4.0](v2.3.6...v2.4.0) (2023-01-05)

### Features

* allow to transform and report back ([#59](#59)) ([bfeea5d](bfeea5d))
@github-actions
Copy link

github-actions bot commented Jan 5, 2023

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant