Skip to content

Conversation

Copy link

Copilot AI commented Dec 10, 2025

Description

Addresses review feedback on PR #1007 to add comprehensive JSDoc documentation to the UpdateEncryptedKeyResult interface, following the established pattern from StoreEncryptedKeyResult.

The UpdateEncryptedKeyResult interface previously had minimal documentation. Updated to include:

  • @typedef annotation for the interface
  • Detailed property descriptions for id, pkpAddress, and updatedAt fields
  • Consistent formatting with other result interfaces in the codebase

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • CodeQL security scan passed with no alerts
  • Code review completed

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-authored-by: Ansonhkg <4049673+Ansonhkg@users.noreply.github.com>
Copilot AI changed the title [WIP] Update versioned key update support and client APIs Add detailed JSDoc documentation to UpdateEncryptedKeyResult interface Dec 10, 2025
Copilot AI requested a review from Ansonhkg December 10, 2025 16:41
@Ansonhkg Ansonhkg marked this pull request as ready for review December 10, 2025 16:42
Copilot AI review requested due to automatic review settings December 10, 2025 16:42
@Ansonhkg Ansonhkg merged commit 209229e into feature/jss-141-add-update-function-for-wrapped-keys-naga Dec 10, 2025
1 of 2 checks passed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive JSDoc documentation to the UpdateEncryptedKeyResult interface, addressing review feedback from PR #1007. The changes bring this interface's documentation in line with established patterns used throughout the wrapped-keys package, particularly matching the style of StoreEncryptedKeyResult.

Key Changes:

  • Enhanced JSDoc documentation for UpdateEncryptedKeyResult interface with @typedef annotation and detailed property descriptions
  • Added descriptions for id, pkpAddress, and updatedAt properties

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +163 to +165
* @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
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants