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(editing): add open-scd-core Edit API #1299

Closed
wants to merge 1 commit into from

Conversation

ca-d
Copy link
Contributor

@ca-d ca-d commented Aug 18, 2023

This adds the Edit API from https://github.com/ca-d/open-scd-core to the Editing and Logging mixins, enabling editing through both APIs.

This change is needed in order to be able to handle namespaced updates at all.

Warning

Do not factor out plugins using this version of the Edit API!
For compatibility reasons with existing open-scd-core plugins, this pull request just adds the Edit API in its current version, which - while working as intended - still handles namespaced attribute updates quite poorly, as I described in openscd/open-scd-core#132 . I therefore strongly suggest adapting the Edit API before considering it stable. That change could either be made in open-scd-core, with the dependency being updated afterwards, or open-scd-core could be deprecated outright and the change made here, in which case all tests for the Edit API would have to move here, as well.

@trusz
Copy link
Member

trusz commented Aug 22, 2023

As we discussed, I would like to wait with this PR until we finish Milestone 2 in #1300.
With that we would import core from the monorepo directly.
I understand this is needed for other plugins, so we try to hurry.
Thank you for your understanding! ☀️

@trusz
Copy link
Member

trusz commented Aug 23, 2023

I'll convert this PR to draft for the time being, until the dependencies are done

@trusz trusz marked this pull request as draft August 23, 2023 08:12
@ca-d
Copy link
Contributor Author

ca-d commented Aug 30, 2023

Thank you for attending to this issue. If I can be of help in preparing the dependencies, I'm always happy to join a pair programming or sparring session!

@pascalwilbrink
Copy link
Member

Hi @ca-d, We want to split up the current Logging Mixin first into Logging and Historing.
Logging will contain info, warning and error logs. Historing will contain the edit kinds.
After this split, we can more easily migrate to the new Editing API

@trusz
Copy link
Member

trusz commented Jul 23, 2024

We would like to include the new edit event so both version of edit API works

@Sander3003
Copy link
Member

Inspiration: OMICRONEnergyOSS/open-scd-core@4e36a57

@trusz
Copy link
Member

trusz commented Jul 24, 2024

After talking about it, this PR is outdated and there is a newer version of this idea: OMICRONEnergyOSS/open-scd-core@4e36a57

I'll close this PR and we will take the new version.

@trusz trusz closed this Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants