feat: use computed tags for records

[TimoGlastra]

This allows to use computed tags, i.e. tags that are automatically set when retrieving the tags/storing the record.

The benefit is that it becomes a lot easier to add tags that need to stay in sync with the record values. For example records can now be queried by state, which is automatically updated when the record is saved.

In addition it partly fixes #290 by supporting boolean values and transforming those from and to store when storing/retrieving records. I'm not sure if we want other types supported? If so I'll address that in a separate PR

Also fixes #258

[codecov-commenter]

Codecov Report

Merging #313 (32ba89d) into main (6a26337) will decrease coverage by 0.01%.
The diff coverage is 90.12%.

@@            Coverage Diff             @@
##             main     #313      +/-   ##
==========================================
- Coverage   88.39%   88.38%   -0.02%     
==========================================
  Files         223      225       +2     
  Lines        4043     4088      +45     
  Branches      447      455       +8     
==========================================
+ Hits         3574     3613      +39     
- Misses        469      475       +6     

Impacted Files	Coverage Δ
src/modules/basic-messages/BasicMessageEvents.ts	100.00% <ø> (ø)
src/storage/BaseRecord.ts	61.11% <45.45%> (-28.89%)	⬇️
.../modules/credentials/services/CredentialService.ts	88.17% <50.00%> (ø)
src/modules/proofs/services/ProofService.ts	85.53% <50.00%> (ø)
src/modules/basic-messages/BasicMessageRole.ts	100.00% <100.00%> (ø)
src/modules/basic-messages/index.ts	100.00% <100.00%> (ø)
...es/basic-messages/repository/BasicMessageRecord.ts	100.00% <100.00%> (ø)
...les/basic-messages/services/BasicMessageService.ts	90.90% <100.00%> (-0.76%)	⬇️
...modules/connections/repository/ConnectionRecord.ts	96.66% <100.00%> (+0.30%)	⬆️
.../modules/connections/services/ConnectionService.ts	99.30% <100.00%> (-0.01%)	⬇️
... and 9 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6a26337...32ba89d. Read the comment docs.

[jakubkoci]

I’m sorry, I don’t want to bother with nitpicking, but I try to understand the typings here. Bear with me, please :)

Does it mean that DefaultTags allowing the data structures that are prohibited by TagsBase?

Is the goal that CustomTags cannot have number as a key or value but DefaultTags can?

I would assume that DefaultTags should have the same type as TagsBase. Then, maybe, we could simplified it to this:

export type TagValue = string | boolean | undefined
export type Tags = {
  [key: string]: TagValue
  [key: number]: never
}

export type RecordTags<DefaultTags, Tags> = Tags & DefaultTags

export abstract class BaseRecord<DefaultTags = Tags, CustomTags = Tags> {

[jakubkoci]

Of course, we can merge this if you want, I know it's been here for a while. I'm just curious if there is a way to simplify it a bit because it took me some time to understand what exactly we want to achieve with those types. I understand theres is some inherent complexity

[TimoGlastra]

I don't mind the nitpicking :)

You're totally right. I was struggling a bit with the types and wanted to indicate that by default he DefaultTags is an empty object. But with Record<string, unknown> that isn't any more clear. I changed it so both extend the TagsBase type now.

[TimoGlastra]

I think all issues should be resolved now @jakubkoci

[jakubkoci]

Nice 👍