# @eengineer1/sd-jwt-ts-node

> [![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/.github?color=green&label=stable%20release&style=flat-square)](https://github.com/cheqd/.github/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release

Latest version **1.0.1** (published 2023-12-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install @eengineer1/sd-jwt-ts-node
pnpm add @eengineer1/sd-jwt-ts-node
yarn add @eengineer1/sd-jwt-ts-node
bun add @eengineer1/sd-jwt-ts-node
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-12-30 |
| First published | 2023-11-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.17.0 |
| Dependencies | 0 |
| Unpacked size | 149.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Eengineer1 |
| Maintainers | eengineer1 |
| Keywords | sd-jwt, verifiable-credentials |

## Links

- npm: https://www.npmjs.com/package/@eengineer1/sd-jwt-ts-node
- Repository: https://github.com/Eengineer1/sd-jwt-ts
- Homepage: https://github.com/Eengineer1/sd-jwt-ts#readme
- Issues: https://github.com/Eengineer1/sd-jwt-ts/issues
- npm.io page: https://npm.io/package/@eengineer1/sd-jwt-ts-node

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-12-30
- 1.0.2-develop.1 (beta) — 2024-01-16
- 1.0.1-develop.4 — 2023-12-30
- 1.0.1-develop.3 — 2023-12-27
- 1.0.1-develop.2 — 2023-12-05
- 1.0.1-develop.1 — 2023-12-05
- 1.0.0 — 2023-11-30
- 1.0.0-develop.2 — 2023-11-30
- 1.0.0-develop.1 — 2023-11-30

## README

# Spec compliant SD-JWT type-rich implementation for TypeScript

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/.github?color=green&label=stable%20release&style=flat-square)](https://github.com/cheqd/.github/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/.github?color=green&style=flat-square) [![GitHub license](https://img.shields.io/github/license/cheqd/.github?color=blue&style=flat-square)](https://github.com/cheqd/.github/blob/main/LICENSE)

[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/.github?include_prereleases&label=dev%20release&style=flat-square)](https://github.com/cheqd/.github/releases/) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/.github/latest?style=flat-square) [![GitHub contributors](https://img.shields.io/github/contributors/cheqd/.github?label=contributors%20%E2%9D%A4%EF%B8%8F&style=flat-square)](https://github.com/cheqd/.github/graphs/contributors)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/.github/dispatch.yml?label=workflows&style=flat-square)](https://github.com/cheqd/.github/actions/workflows/dispatch.yml) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/.github/codeql.yml?label=CodeQL&style=flat-square)](https://github.com/cheqd/.github/actions/workflows/codeql.yml) ![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/.github?style=flat-square)

## ℹ️ Overview

### Further information

Checkout the [documentation regarding SD-JWTs](https://docs.walt.id/v/ssikit/concepts/selective-disclosure), to find out more.

## What is SD-JWT?

This library implements the **Selective Disclosure JWT (SD-JWT)**
specification:  [draft-ietf-oauth-selective-disclosure-jwt-06](https://datatracker.ietf.org/doc/draft-ietf-oauth-selective-disclosure-jwt/06/).

### Features

* **Create and sign** SD-JWT tokens
  * Choose selectively disclosable payload fields (SD fields)
  * Create digests for SD fields and insert into JWT body payload
  * Create and append encoded disclosure strings for SD fields to JWT token
  * Add random or fixed number of **decoy digests** on each nested object property
* **Present** SD-JWT tokens
  * Selection of fields to be disclosed
  * Support for appending optional holder binding
* Full support for **nested SD fields** and **recursive disclosures**
* **Parse** SD-JWT tokens and restore original payload with disclosed fields
* **Verify** SD-JWT token
  * Signature verification
  * Hash comparison and tamper check of the appended disclosures
* Support for **integration** with various crypto libraries and frameworks, to perform the cryptographic operations and key management

---
_Source: https://npm.io/package/@eengineer1/sd-jwt-ts-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._