fix: add w3c credential status check

[RishabhS7]

Summary

add w3c credential status check

Jira Ticket

Summary by CodeRabbit

• New Features
  • Improved handling and display of credential status, including clearer identification of revoked or suspended credentials.
  • Enhanced error messages for documents with revoked or suspended status.
• Bug Fixes
  • More accurate detection and reporting of credential errors and statuses.
• Chores
  • Updated a dependency to the latest version for improved reliability.

[coderabbitai]

Walkthrough

The changes introduce enhanced handling and classification of W3C credential status verification results. A new enum standardizes status codes, and error handling logic is updated to distinguish revoked and suspended states more precisely. Several utility functions are added to process verification fragments, and the error message handling is tailored for W3C credentials.

Changes

File(s)	Change Summary
package.json	Updated "@tradetrust-tt/tradetrust-utils" dependency from ^2.3.1 to ^2.3.2.
src/utils/fragment/index.ts	Replaced direct export of errorMessageHandling; added new helper functions for W3C status detection; redefined error handling logic for W3C fragments.
src/verify/fragments/document-status/w3cCredentialStatus.ts	Introduced W3CCredentialStatusCode enum; enriched verification fragments with standardized reason codes and messages.
src/tests/core/verify.test.ts	Replaced numeric error codes with W3CCredentialStatusCode enum constants in tests; updated error code expectations for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant W3CVerifier

    User->>App: Submit credential for verification
    App->>W3CVerifier: Call verify() on credential
    W3CVerifier->>App: Return verification fragments (with reason codes)
    App->>App: errorMessageHandling(fragments)
    alt Fragments are W3C-related
        App->>App: Check for revoked/suspended via helper functions
        App->>User: Return specific error messages (REVOKED/SUSPENDED)
    else Not W3C
        App->>App: Use OAErrorMessageHandling fallback
        App->>User: Return general error messages
    end

Loading

Suggested labels

released

Poem

A hop, a skip, a status check—
Now W3C codes are clear as heck!
Revoked or suspended, we know what’s true,
With enums and helpers to guide us through.
🐇✨
Bugs, beware—this rabbit’s on guard,
For every credential, we’re raising the bar!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-17T04_16_43_250Z-debug-0.log

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a1c414 and 016431d.

📒 Files selected for processing (1)

• src/__tests__/core/verify.test.ts (8 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/tests/core/verify.test.ts

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🔭 Outside diff range comments (1)

src/verify/fragments/document-status/w3cCredentialStatus.ts (1)

8-37: SKIPPED code mismatch – enum says 4 but fragment uses 0.

skip() returns { code: 0, codeString: 'SKIPPED' }, yet W3CCredentialStatusCode.SKIPPED is 4.
This breaks downstream helpers that rely on the enum value (e.g. utils/fragment/index.ts) and may cause false negatives.

-      reason: {
-        code: 0,
-        codeString: 'SKIPPED',
+      reason: {
+        code: W3CCredentialStatusCode.SKIPPED,
+        codeString: 'SKIPPED',

Alternatively make the enum assign SKIPPED = 0 and move UNEXPECTED_ERROR to a different value – but keep the mapping consistent in both places.

🧹 Nitpick comments (4)

src/verify/fragments/document-status/w3cCredentialStatus.ts (3)

66-70: Guard against undefined purposes to avoid noisy array entries.

verificationResult.map((item) => item.purpose) will yield undefined for successful checks; these become extra items in purposes and are harmless today but brittle.

-const purposes = verificationResult.map((item) => item.purpose);
+const purposes = verificationResult
+  .map((item) => item.purpose)
+  .filter((p): p is string => typeof p === 'string');

Keeps the intent clear and prevents accidental includes(undefined) confusion.

---

76-79: Use a descriptive codeString instead of the generic "ERROR".

The enum already exposes ETHERS_UNHANDLED_ERROR; propagate it for easier log aggregation:

-          codeString: 'ERROR',
+          codeString: 'ETHERS_UNHANDLED_ERROR',

---

96-108: Granular error message improves UX & downstream handling.

Right now the message is always 'Document has been revoked or suspended.', even when only one condition applies.

Consider templating:

-          message: 'Document has been revoked or suspended.',
+          message: hasRevocationAndSuspension
+            ? 'Document has been revoked and suspended.'
+            : hasRevocation
+              ? 'Document has been revoked.'
+              : 'Document has been suspended.',

Makes UI and analytics clearer.

src/utils/fragment/index.ts (1)

15-30: Helper naming – issuedFragment → statusFragment to avoid confusion.

Inside w3cCredentialStatusRevoked / w3cCredentialStatusSuspended the variable issuedFragment actually represents the status fragment, not an issuance fragment. Minor but avoids mental overhead.

-  const issuedFragment = getW3CCredentialStatusFragment(fragments);
+  const statusFragment = getW3CCredentialStatusFragment(fragments);

Repeat for the suspension helper.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ac3c63 and a06091a.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• package.json (1 hunks)
• src/utils/fragment/index.ts (1 hunks)
• src/verify/fragments/document-status/w3cCredentialStatus.ts (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/utils/fragment/index.ts (1)

src/verify/verify.ts (3)

• utils (82-82)
• InvalidVerificationFragment (89-89)
• VerificationFragment (95-95)

🔇 Additional comments (1)

package.json (1)

118-118: Lock-file & CI sanity check after bumping tradetrust-utils.

The only change is the minor version bump from ^2.3.1 → ^2.3.2.
Please make sure to:

1. run npm install so that package-lock.json/pnpm-lock.yaml is updated, and
2. trigger the full test / type-check pipeline to catch any breaking changes in the new utils release.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/__tests__/core/verify.test.ts (2)

240-240: Remove stray console.log to keep test output clean

The console.log left in the test will add noise to CI logs and local runs. If you need this information for debugging, wrap it in a conditional or use Vitest’s debug() utilities, but avoid committing raw logs.

-      console.log(await verifyDocument(tampered));

---

246-248: Replace magic-number status code with enum / constant

Hard-coding code: 3 risks drift if the enum changes. Import the enum (e.g., ReasonCode.ERROR) or a helper constant so the test self-documents the meaning and stays in sync with implementation.

-              code: 3,
-              codeString: 'ERROR',
+              code: ReasonCode.ERROR,
+              codeString: 'ERROR',

(Adjust the import path according to where the enum is defined.)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a06091a and 73be2b4.

📒 Files selected for processing (1)

• src/__tests__/core/verify.test.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/__tests__/core/verify.test.ts (1)

src/core/verify.ts (1)

• verifyDocument (51-81)

[nghaninn]

🎉 This PR is included in version 1.5.4 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀