Feature/83 rxidb

[TapaiBalazs]

Feature

• [X] Implements an existing feature request or change request. Make sure the feature request has been accepted for implementation before opening a PR.
• [X] Related issues linked using fixes #number
• [x] The new feature, or the fix is tested with jest and if applicable with cypress
• [x] The code is properly formatted using the project's prettier and eslint settings
• [x] Make sure that everything is properly typed in the code.
• [x] Contribution guidelines are met
• [x] Documentation added

Documentation / Examples

• [x] Make sure the linting passes
• [x] Added TSDoc annotations to code
• [x] Added example application for testing (see #83 issue)

Additional affected packages:

• [ ] Make sure affected packages are updated and published after this PR gets merged

fixes #82 closes #83

TODO:

• [x] Add unit tests to internal operators
• [x] Create a proper readme file

[TapaiBalazs]

@lindakatcodes

• I see a lot of changes, removals, and renames for a bunch of the cypress-indexedDB helper stuff. Is this rxidb library replacing that one?

No, the cypress-indexeddb helper tests got moved to their own test suite. That test suite should test that cypress helper library. The new tests are testing the rxidb library through the UI. It is important that we don't play around with IndexedDb modifications in those tests, so we actually test the version-update implementation of the rxidb library

[TapaiBalazs]

• Didn't have time to fully review the test files but all looks good there. The main question I have on those is that they all route to /cypress-helpers - I wonder will that url update at some point, if rxidb is replacing it? Worth keeping note of, if so, for whenever that route change takes place.

I updated the demo app routes to use rxidb instead of cypress-helpers

[TapaiBalazs]

@lindakatcodes Stackblitz related stuff:

1. It looks like it creates two versions of the idb stores, both with the same version. This happens for both examples for me. Not sure this is expected?

It does that for me as well. I don't think it is expected but this has something to do with stackblitz and the embedded iframe where the demoapp runs. Possibly it is a side effect running node inside a browser. :)

2. On the key-value pair example, no matter how many times I enter data, I don't see it show up in idb. Not sure if that's just because it's a branch version and something is going weird with it, or if there's something else going on. The code seems like it should work. The autoIncrement example works fine.

It didn't refresh for me automatically, but when I manually pressed the db refresh button it showed the new values. Again, I think this has something to do with Stackblitz and not the library itself. 🤔

[TapaiBalazs]

@NachoVazquez

• [x] Error on deleteItem if the key doesn't

It does not throw an error, it mimics IndexedDb behaviour: nothing happens, wont emit a thing.