Skip to content

feat: Implement Type Metadata utility functions #33

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
vijayshiyani merged 8 commits into from
May 30, 2025
Merged

feat: Implement Type Metadata utility functions #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3f19088
feat: Implement Type Metadata utility functions
vijayshiyani May 28, 2025
ebaaa25
refactoring utility functions
vijayshiyani May 30, 2025
57baf60
updated a changelog
vijayshiyani May 30, 2025
60ffd98
added a comment and default algo prefix sha384
vijayshiyani May 30, 2025
da986cd
refactor: remove algorithmPrefixes param and replace console.warn wit…
vijayshiyani May 30, 2025
9e852b0
refactor: simplify algorithm prefix validation logic
vijayshiyani May 30, 2025
83cbc60
updated changelog
vijayshiyani May 30, 2025
0197b6f
update readme
vijayshiyani May 30, 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
7 changes: 6 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project (loosely) adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 2.0.0 - 2025-XX-XX
## 2.0.0 - 2025-05-28

### Added

- `extractEmbeddedTypeMetadata()` utility function to extract and decode Type Metadata documents embedded in the `vctm` unprotected header of SD-JWT VCs
- `fetchTypeMetadataFromUrl()` utility function to fetch and optionally verify Type Metadata from URLs specified in the `vct` claim, with integrity validation support

### Changed

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

This is an implementation of [SD-JWT VC (I-D version 01)](https://drafts.oauth.net/oauth-sd-jwt-vc/draft-ietf-oauth-sd-jwt-vc.html) in Typescript. It provides a higher-level interface on top of the [@meeco/sd-jwt](https://github.com/Meeco/sd-jwt) library to create the compliant SD-JWT VCs.

**Note on `typ` header (as of v2.0.0 / Unreleased):**
**Note on `typ` header (as of v2.0.0):**

- The `typ` header for issued SD-JWT VCs is `dc+sd-jwt`.
- The `Verifier` will accept both `vc+sd-jwt` and `dc+sd-jwt`.
Expand Down
32 changes: 32 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,35 @@ export const ReservedJWTClaimKeys: CreateSDJWTPayloadKeys[] = [
'nbf',
'exp',
];

/**
* Represents the structure of a Type Metadata document as defined in the SD-JWT VC specification (Section 6.2).
*/
export interface TypeMetadata {
vct?: string;
name?: string;
description?: string;
extends?: string; // URI
display?: Array<Record<string, any>>;
claims?: Array<Record<string, any>>;
/**
* OPTIONAL. An embedded JSON Schema document describing the structure of the Verifiable Credential.
* MUST NOT be used if schema_uri is present.
*/
schema?: Record<string, any>;
/**
* OPTIONAL. A URL pointing to a JSON Schema document.
* MUST NOT be used if schema is present.
*/
schema_uri?: string;

/**
* OPTIONAL. integrity metadata for vct, extends, schema_uri, and similar URIs.
* Value MUST be an "integrity metadata" string per W3C.SRI.
*/
'schema_uri#integrity'?: string;
'vct#integrity'?: string;
'extends#integrity'?: string;

[key: string]: any;
}
Loading