@did-btcr2/cli 0.19.3 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/README.md +35 -26
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/cjs/index.js +136 -171
  4. package/dist/esm/src/commands/deactivate.js +11 -88
  5. package/dist/esm/src/commands/deactivate.js.map +1 -1
  6. package/dist/esm/src/commands/resolve.js +3 -20
  7. package/dist/esm/src/commands/resolve.js.map +1 -1
  8. package/dist/esm/src/commands/update.js +15 -85
  9. package/dist/esm/src/commands/update.js.map +1 -1
  10. package/dist/esm/src/commands/write.js +119 -0
  11. package/dist/esm/src/commands/write.js.map +1 -0
  12. package/dist/esm/src/resolution-options.js +47 -0
  13. package/dist/esm/src/resolution-options.js.map +1 -0
  14. package/dist/esm/src/types.js.map +1 -1
  15. package/dist/types/src/commands/deactivate.d.ts +1 -1
  16. package/dist/types/src/commands/deactivate.d.ts.map +1 -1
  17. package/dist/types/src/commands/resolve.d.ts.map +1 -1
  18. package/dist/types/src/commands/update.d.ts +1 -1
  19. package/dist/types/src/commands/update.d.ts.map +1 -1
  20. package/dist/types/src/commands/write.d.ts +47 -0
  21. package/dist/types/src/commands/write.d.ts.map +1 -0
  22. package/dist/types/src/resolution-options.d.ts +21 -0
  23. package/dist/types/src/resolution-options.d.ts.map +1 -0
  24. package/dist/types/src/types.d.ts +17 -7
  25. package/dist/types/src/types.d.ts.map +1 -1
  26. package/package.json +5 -5
  27. package/src/commands/deactivate.ts +14 -142
  28. package/src/commands/resolve.ts +7 -36
  29. package/src/commands/update.ts +19 -139
  30. package/src/commands/write.ts +198 -0
  31. package/src/resolution-options.ts +67 -0
  32. package/src/types.ts +17 -7
package/src/types.ts CHANGED
@@ -1,5 +1,4 @@
1
- import type { DidUpdateResult } from '@did-btcr2/api';
2
- import type { PatchOperation } from '@did-btcr2/common';
1
+ import type { BroadcastOptions, DidUpdateResult, PublishToCasMode, Signer } from '@did-btcr2/api';
3
2
  import type { Btcr2DidDocument, ResolutionOptions } from '@did-btcr2/method';
4
3
  import type { DidResolutionResult } from '@web5/dids';
5
4
  import type { DoctorReport, EffectiveConfig } from './config.js';
@@ -36,12 +35,23 @@ export interface ResolveCommandOptions {
36
35
  options? : ResolutionOptions;
37
36
  }
38
37
 
38
+ /**
39
+ * The parameters that `update` and `deactivate` hand to the api's `updateDid`
40
+ * and `deactivateDid`. `update` adds `patches`. An absent source pair lets the
41
+ * api resolve the current document with `resolutionOptions` (ADR 098, ADR
42
+ * 101). An absent `verificationMethodId` or `beaconId` lets the api derive it
43
+ * (ADR 104).
44
+ */
39
45
  export interface UpdateCommandOptions {
40
- sourceDocument : Btcr2DidDocument;
41
- patches : PatchOperation[];
42
- sourceVersionId : number;
43
- verificationMethodId : string;
44
- beaconId : string;
46
+ did : string;
47
+ signer : Signer;
48
+ sourceDocument? : Btcr2DidDocument;
49
+ sourceVersionId? : number;
50
+ verificationMethodId? : string;
51
+ beaconId? : string;
52
+ resolutionOptions? : ResolutionOptions;
53
+ publishToCas : PublishToCasMode;
54
+ broadcastOptions? : BroadcastOptions;
45
55
  }
46
56
 
47
57
  export type CommandResult =