@sd-jwt/sd-jwt-vc 0.20.1 → 0.21.0-alpha-20260916100413

package/LICENSE

@@ -1,4 +1,4 @@
-                                 Apache License
+                                Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

package/README.md

@@ -1,36 +1,24 @@
-![License](https://img.shields.io/github/license/openwallet-foundation/sd-jwt-js.svg)
-![NPM](https://img.shields.io/npm/v/%40sd-jwt%2Fsd-jwt-vc)
-![Release](https://img.shields.io/github/v/release/openwallet-foundation/sd-jwt-js)
-![Stars](https://img.shields.io/github/stars/openwallet-foundation/sd-jwt-js)
+# @sd-jwt/sd-jwt-vc
 
-# SD-JWT Implementation in JavaScript (TypeScript)
+[![npm version](https://img.shields.io/npm/v/@sd-jwt/sd-jwt-vc)](https://npmjs.com/package/@sd-jwt/sd-jwt-vc)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/openwallet-foundation-labs/identity-common-ts/blob/main/LICENSE)
 
-## SD-JWT-VC
+Implementation of [SD-JWT-based Verifiable Credentials (SD-JWT VC) — draft-ietf-oauth-sd-jwt-vc-15](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-15.html), built on top of [`@sd-jwt/core`](../sd-jwt-core) ([RFC 9901](https://www.rfc-editor.org/rfc/rfc9901.html)).
 
-### About
-
-Implementation of [SD-JWT-based Verifiable Credentials (SD-JWT VC) — draft-ietf-oauth-sd-jwt-vc-15](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-15.html), built on top of `@sd-jwt/core` ([RFC 9901](https://www.rfc-editor.org/rfc/rfc9901.html)).
-
-Check the detail description in our github [repo](https://github.com/openwallet-foundation/sd-jwt-js).
-
-### Installation
-
-To install this project, run the following command:
+## Installation
 
 ```bash
-# using npm
+# Using npm
 npm install @sd-jwt/sd-jwt-vc
 
-# using yarn
-yarn add @sd-jwt/sd-jwt-vc
+# Using pnpm
+pnpm add @sd-jwt/sd-jwt-vc
 
-# using pnpm
-pnpm install @sd-jwt/sd-jwt-vc
+# Using yarn
+yarn add @sd-jwt/sd-jwt-vc
 ```
 
-Ensure you have Node.js installed as a prerequisite.
-
-### Usage
+## Usage
 
 Here's a basic example of how to use this library:
 
@@ -81,93 +69,38 @@ const presentation = await sdjwt.present(credential, presentationFrame);
 const verified = await sdjwt.verify(presentation);
 ```
 
-Check out more details in our [documentation](https://github.com/openwallet-foundation/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation/sd-jwt-js/tree/main/examples)
+## Examples
 
-### Revocation
+Runnable examples are available in [`examples/sd-jwt/sd-jwt-vc`](../../examples/sd-jwt/sd-jwt-vc). Run them from the repository root:
 
-To add revocation capabilities, you can use the `@owf/token-status-list` library to create a JWT Status List and include it in the SD-JWT-VC.
-
-You can pass a dedicated `statusVerifier` function in the configuration to verify the signature of the payload of the JWT of the statuslist. If no function is provided, it will fallback to the verifier that is also used for the sd-jwt-vc.
-
-### Type Metadata
-
-By setting the `loadTypeMetadataFormat` to `true` like this:
-
-```typescript
-const sdjwt = new SDJwtVcInstance({
-  signer,
-  signAlg: 'EdDSA',
-  verifier,
-  hasher: digest,
-  hashAlg: 'sha-256',
-  saltGenerator: generateSalt,
-  loadTypeMetadataFormat: true,
-});
+```bash
+pnpm tsx examples/sd-jwt/sd-jwt-vc/basic.ts
 ```
 
-The library will load the type metadata format based on the `vct` value according to the [SD-JWT-VC specification](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-15.html#name-sd-jwt-vc-type-metadata) and validate this schema.
+See the [SD-JWT examples overview](../../examples/sd-jwt/README.md) for the full list.
 
-Since at this point the display is not yet implemented, the library will only validate the schema and return the type metadata format. In the future the values of the type metadata can be fetched via a function call.
+## Dependencies
 
-### Verification
+- [@sd-jwt/core](https://www.npmjs.com/package/@sd-jwt/core)
+- [@owf/token-status-list](https://www.npmjs.com/package/@owf/token-status-list)
+- [zod](https://www.npmjs.com/package/zod)
 
-The library provides two verification approaches:
+## Platform Support
 
-#### Standard Verification (Fail-Fast)
+This library is **platform agnostic** and works in:
 
-The `verify()` method throws an error immediately when the first validation failure is encountered:
+- ✅ Node.js (>=20)
+- ✅ Browsers (modern browsers with ES2020 support)
+- ✅ React Native
 
-```typescript
-try {
-  const result = await sdjwt.verify(presentation);
-  console.log('Verified payload:', result.payload);
-} catch (error) {
-  console.error('Verification failed:', error.message);
-}
-```
+A global `TextEncoder` and `TextDecoder` must be available. See the [React Native notes](../identity-common/README.md#react-native) if you need a polyfill.
 
-#### Safe Verification (Collect All Errors)
+Cryptographic operations (signing, verification, hashing, salt generation) are provided as callbacks. [`@owf/crypto`](https://github.com/openwallet-foundation-labs/identity-common-ts/tree/main/packages/crypto) provides Web Crypto based implementations.
 
-The `safeVerify()` method collects all validation errors instead of failing on the first one. This is useful when you want to show users all issues with a credential at once, including signature, status (revocation), and VCT metadata validation:
+## Contributing
 
-```typescript
-import type { SafeVerifyResult, VerificationError } from '@sd-jwt/core';
-
-const result = await sdjwt.safeVerify(presentation);
-
-if (result.success) {
-  // Verification succeeded
-  console.log('Verified payload:', result.payload);
-  console.log('Header:', result.header);
-  if (result.kb) {
-    console.log('Key binding:', result.kb);
-  }
-  if (result.typeMetadata) {
-    console.log('Type metadata:', result.typeMetadata);
-  }
-} else {
-  // Verification failed - inspect all errors
-  for (const error of result.errors) {
-    console.error(`[${error.code}] ${error.message}`);
-    if (error.details) {
-      console.error('Details:', error.details);
-    }
-  }
-}
-```
+See the [Contributing Guide](https://github.com/openwallet-foundation-labs/identity-common-ts/blob/main/CONTRIBUTING.md) for details on how to contribute to this project.
 
-##### SD-JWT-VC Specific Error Codes
+## License
 
-In addition to the [core error codes](../core/README.md#error-codes), `safeVerify()` in SD-JWT-VC can return:
-
-| Code | Description |
-|------|-------------|
-| `STATUS_VERIFICATION_FAILED` | Status list fetch or verification failed |
-| `STATUS_INVALID` | Credential status indicates revocation |
-| `VCT_VERIFICATION_FAILED` | VCT type metadata fetch or validation failed |
-
-### Dependencies
-
-- [@sd-jwt/core](https://www.npmjs.com/package/@sd-jwt/core)
-- [@owf/token-status-list](https://www.npmjs.com/package/@owf/token-status-list)
-- [zod](https://www.npmjs.com/package/zod)
+This project is licensed under the [Apache License Version 2.0](https://github.com/openwallet-foundation-labs/identity-common-ts/blob/main/LICENSE) (Apache-2.0).