feat: ability to add generic records

[MosCD3]

Summary of Changes

Added a non-secret module with minimal API just to expose the on-secret APIs for Indy library here
This will enable business logic that requires saving custom records like wallet history to be saved to the wallet and retrieved back when possible

Current Status

• Change all module names and APIs to "Generic Module" name (Done)
• Implement Typing constraints (Done)
• Implement generic get (Pending help from community .. )
• Implement modify and delete record
• Add unit tests

Related Issue #685

[berendsliedrecht]

I like the addition and can be useful in many cases. I have some minor points that I feel like would make it a bit more generic.

Also if you want to storage some data alongside a connectionRecord, which is why I think you added the connectionId, you can also use connectionRecord.metadata to add some quick JSON to a record.

[TimoGlastra]

Thanks for the PR @MosCD3.

I'm not sure if we should call this non secrets. Indy called it like this, but I would rather think of a better name. People not familiar with the indy ecyosystem have no idea what non secrets means and as we're moving to Aries Askar it'll make less sense. A connection record is as much a non secrets record than the records created with this new API. (I'm still thinking of a suitable name, will get back if I can think of something. Please let me know if you have any suggestions)

also in addition to the e2e tests, could you add some unit tests? This has bitten us in the past, so would like make sure new additions are well-covered.

as a last note, can you look to remove the changes to the yarn.lock file? I think they're unrelated to the additions of this PR.

[TimoGlastra]

.

[genaris]

This will be a great addition to the framework, as it will give the opportunity to store in the wallet those things that do not fit in other record types!

It's true that the naming could be too 'Indy-centric'. At first sigh I would call it 'Generic Records Module', but probably it's too long.

By the way, following conventions from other modules I think the naming of repository and service should be NonSecretRepository and NonSecretService respectively (unless we use 'Record' suffix as part of module name).

[TimoGlastra]

It's true that the naming could be too 'Indy-centric'. At first sigh I would call it 'Generic Records Module', but probably it's too long.

I like the direction of this. So the module will used like genericRecords. Don't think that's too long.

So it would be something like

agent.genericRecords.saveRecord()

// another thought?
agent.genericStorage.saveRecord()

[MosCD3]

@TimoGlastra that's a good idea 'genericRecords'. I will change to that

[genaris]

@TimoGlastra that's a good idea 'genericRecords'. I will change to that

Nice! So in that case saveRecord method would become just save to avoid verbosity?

[codecov-commenter]

Codecov Report

Merging #702 (1acafb0) into main (020e6ef) will decrease coverage by 0.01%.
The diff coverage is 85.54%.

@@            Coverage Diff             @@
##             main     #702      +/-   ##
==========================================
- Coverage   87.51%   87.49%   -0.02%     
==========================================
  Files         430      434       +4     
  Lines       10561    10644      +83     
  Branches     1827     1834       +7     
==========================================
+ Hits         9242     9313      +71     
- Misses       1256     1268      +12     
  Partials       63       63              

Impacted Files	Coverage Δ
...rc/modules/generic-records/GenericRecordsModule.ts	71.87% <71.87%> (ø)
...es/generic-records/service/GenericRecordService.ts	88.88% <88.88%> (ø)
packages/core/src/agent/Agent.ts	95.83% <100.00%> (+0.05%)	⬆️
...odules/generic-records/repository/GenericRecord.ts	100.00% <100.00%> (ø)
...ric-records/repository/GenericRecordsRepository.ts	100.00% <100.00%> (ø)

---

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 020e6ef...1acafb0. Read the comment docs.

[MosCD3]

@TimoGlastra @blu3beri Any idea about the dummy module that've been mixed with our changes? should we create a new clean PR?

[TimoGlastra]

Not sure what happened here. Can you try to merge with main?

[TimoGlastra]

Can you add back in the yarn.lock file?

[berendsliedrecht]

Looks good! I think there are some very minor code cleanup things, but I would be happy to pick that up myself Later on.

[berendsliedrecht]

closes #685