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
Introduce record normalizers #835
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use `unknown` instead of `any`.
Allows for customization of record type arguments in builder methods such as `findRecords`. Also allows for validation of types.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces the
RecordNormalizer
interface andStandardRecordNormalizer
implementation. Normalizers are used to transform records and identities into the normalized form from a more developer-friendly form. They will be used by query and transform builders to check and transform inputs. Because normalizers are provided with akeyMap
andschema
, they can provide validation and also look up identities from keys.A query builder can now accept either a
RecordIdentity
orRecordKeyValue
in place of an identity. This makes the following queries possible:Normalizers can work with any kind of inputs, including model classes, such as in
ember-orbit
. This will soon unlock the ability to mix models with builders, such as:In order to support record normalizers, this PR also:
Introduces
[Async/Sync]Queryable
and[Async/Sync]Updatable
interfaces that standardize the public facing interfaces shared by sources and caches.Updates all record-based caches and sources to expose builders as generics. Individual implementations can then override a builder with a custom normalizer and have typings still work.
Fixes a number of test cases that were using improperly normalized data.
Deprecates the no longer needed
firstResult
fn in@orbit/utils
.Fixes #545
Fixes #547