Add support for migrations

[rafaelramalho19]

Fixes #74

---

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

• #74: Add store migrations

---

IssueHunt has been backed by the following sponsors. Become a sponsor

[satazor]

Is it possible to use, for example, store.set('internal.version', '1.2.3') ?

Do you mean for users? Then yes, but it should not be allowed. We should document that the __internal__ key is reserved and throw if it's used from the outside. I doubt anyone would ever encounter it though.

I mean for internal usage. If the user has set accessPropertiesByDotNotation to false, the internal migration code would fail, right?

I guess you have to create a internal _set function that doesn't care about key names, while the exposed pubic set ensures that keys can't start with __internal__.

[rafaelramalho19]

Is it possible to use, for example, store.set('internal.version', '1.2.3') ?

Do you mean for users? Then yes, but it should not be allowed. We should document that the __internal__ key is reserved and throw if it's used from the outside. I doubt anyone would ever encounter it though.

I mean for internal usage. If the user has set accessPropertiesByDotNotation to false, the internal migration code would fail, right?

I guess you have to create a internal _set function that doesn't care about key names, while the exposed pubic set ensures that keys can't start with __internal__.

Done!

Since we currently only need it for the migrations, I only used dot notations for now. (This skips the validation for this._options.accessPropertiesByDotNotation and all the validations associated with it.

If you prefer I can modify the set function flow to accept an override mechanism for the accessPropertiesByDotNotation.

[rafaelramalho19]

Hi @sindresorhus, can you provide any update on this PR? 😄

[sindresorhus]

This is excellent. Thank you for working on this, @rafaelramalho19. And sorry for the delay. The summer got the best of me and I'm way behind on OSS work.

[sindresorhus]

I noticed that there are no tests or docs (and TS) for using a semver range in the migration keys. Would you be able to submit a follow-up PR for that?

[rafaelramalho19]

It's okay. I hope you had a nice summer @sindresorhus 😄

I'll create a follow-up PR this week and tag you.