Record.store(), Record.import(), and roles API support #385

csuwildcat · 2024-01-22T23:12:38Z

First pass at PR

codesandbox · 2024-01-22T23:12:41Z

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

github-actions · 2024-01-22T23:16:15Z

TBDocs Report

✅ No errors or warnings

@web5/api

Project entry file: packages/api/src/index.ts

TBDocs Report Updated at 2024-02-02T17:28:28Z f51f896

frankhinek · 2024-01-23T15:21:37Z

@csuwildcat Node and one of the browser tests are failing. Can you look into why?

codecov · 2024-01-29T22:20:12Z

Codecov Report

Merging #385 (f51f896) into main (422ba93) will increase coverage by 1.35%.
Report is 1 commits behind head on main.
The diff coverage is 99.53%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #385      +/-   ##
==========================================
+ Coverage   91.90%   93.25%   +1.35%     
==========================================
  Files          67       77      +10     
  Lines       18241    23450    +5209     
  Branches     1550     1869     +319     
==========================================
+ Hits        16764    21869    +5105     
- Misses       1454     1542      +88     
- Partials       23       39      +16

Components	Coverage Δ
agent	`88.72% <94.44%> (+0.01%)`	⬆️
api	`97.30% <100.00%> (+0.35%)`	⬆️
common	`98.67% <ø> (+0.10%)`	⬆️
credentials	`94.60% <ø> (∅)`
crypto	`93.76% <ø> (-0.85%)`	⬇️
dids	`97.35% <ø> (+5.10%)`	⬆️
identity-agent	`56.81% <ø> (ø)`
crypto-aws-kms	`100.00% <ø> (ø)`
proxy-agent	`58.43% <ø> (ø)`
user-agent	`55.22% <ø> (ø)`

packages/api/src/record.ts

packages/api/tests/record.spec.ts

packages/agent/src/dwn-manager.ts

packages/api/src/record.ts

* optional target for send * guard store options

* simplification of records class * rename record options to reflect signing/storing

LiranCohen · 2024-02-01T01:33:15Z

@frankhinek Would love another run through and blessing from you.

There is more clean up to do, specifically I'd love to get rid of toJSON() completely in favor of the rawMessage getter.
I'd like to simplify the messageOptions as well for record creation and re-think some of this flow now that we have more context.

But I think this is in a good place to un-block some bugs. And do further cleanup in subsequent PRs.

Would also love feedback from the community and users if the import() and store() methods make sense from a dev-ex perspective.

frankhinek · 2024-02-02T17:24:27Z

Would also love feedback from the community and users if the import() and store() methods make sense from a dev-ex perspective.

This is the biggest open question I still have. Something about import() still seems confusing but better to ship and get feedback than endless deliberate. We can always change it.

- Add `store()` method to the `api` `Record` class. - Add `import()` method to the `api` `Record` class. These now allow to import and store initial writes as well as the current state write in local and remote DWNs.

csuwildcat requested review from frankhinek and mistermoe as code owners January 22, 2024 23:12

csuwildcat changed the title ~~Store import roles~~ Record.store(), Record.import(), and roles API support Jan 22, 2024