Skip to content

Add detailed JSDoc documentation to UpdateEncryptedKeyResult interface #1009

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.

Sign up for GitHub

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

Merged
Ansonhkg merged 2 commits into from
Dec 10, 2025
+7 −1
Merged

Add detailed JSDoc documentation to UpdateEncryptedKeyResult interface #1009

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ec70bd
Initial plan
Copilot Dec 10, 2025
8a56af2
docs(wrapped-keys): add detailed JSDoc for UpdateEncryptedKeyResult
Copilot Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion packages/wrapped-keys/src/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,13 @@ export type UpdateEncryptedKeyParams = BaseApiParams & {
memo?: string;
};

/** Result of updating a private key in the wrapped keys backend service */
/** Result of updating a private key in the wrapped keys backend service
*
* @typedef UpdateEncryptedKeyResult
* @property { string } id The unique identifier (UUID V4) of the encrypted private key that was updated
* @property { string } pkpAddress The LIT PKP Address that the key was linked to; this is derived from the provided pkpSessionSigs
* @property { string } updatedAt ISO 8601 timestamp of when the key was updated
Comment on lines +163 to +165
Copy link

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The property documentation order doesn't match the actual interface property order. For consistency with other interfaces in this file (e.g., StoreEncryptedKeyResult at lines 119-120), the properties should be documented in the same order they appear in the interface.

Suggested order:

@property { string } id The unique identifier (UUID V4) of the encrypted private key that was updated
@property { string } pkpAddress The LIT PKP Address that the key was linked to; this is derived from the provided pkpSessionSigs
@property { string } updatedAt ISO 8601 timestamp of when the key was updated

This matches the interface property order: id, pkpAddress, updatedAt (lines 168-170).

Copilot uses AI. Check for mistakes.
*/
export interface UpdateEncryptedKeyResult {
id: string;
pkpAddress: string;
Expand Down