@sphereon/ssi-types - npm Package Compare versions

Comparing version 0.32.0 to 0.32.1-feature.MWALL.717.jwt.decode.crash.15

dist/mapper/credential-mapper.js

@@ -13,11 +13,8 @@ "use strict";
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredentialMapper = void 0;
-const jwt_decode_1 = __importDefault(require("jwt-decode"));
 const types_1 = require("../types");
 const mso_mdoc_1 = require("../types/mso_mdoc");
 const utils_1 = require("../utils");
+const jwt_decode_1 = require("jwt-decode");
 class CredentialMapper {
@@ -43,4 +40,4 @@ /**
         if (CredentialMapper.isJwtEncoded(presentation)) {
-            const payload = (0, jwt_decode_1.default)(presentation);
-            const header = (0, jwt_decode_1.default)(presentation, { header: true });
+            const payload = (0, jwt_decode_1.jwtDecode)(presentation);
+            const header = (0, jwt_decode_1.jwtDecode)(presentation, { header: true });
             payload.vp.proof = {
@@ -92,4 +89,4 @@ type: types_1.IProofType.JwtProof2020,
         if (CredentialMapper.isJwtEncoded(credential)) {
-            const payload = (0, jwt_decode_1.default)(credential);
-            const header = (0, jwt_decode_1.default)(credential, { header: true });
+            const payload = (0, jwt_decode_1.jwtDecode)(credential);
+            const header = (0, jwt_decode_1.jwtDecode)(credential, { header: true });
             payload.vc.proof = {
@@ -451,3 +448,3 @@ type: types_1.IProofType.JwtProof2020,
     static jwtEncodedPresentationToUniformPresentation(jwt, makeCredentialsUniform = true, opts) {
-        return CredentialMapper.jwtDecodedPresentationToUniformPresentation((0, jwt_decode_1.default)(jwt), makeCredentialsUniform, opts);
+        return CredentialMapper.jwtDecodedPresentationToUniformPresentation((0, jwt_decode_1.jwtDecode)(jwt), makeCredentialsUniform, opts);
     }
@@ -549,3 +546,3 @@ static jwtDecodedPresentationToUniformPresentation(decoded, makeCredentialsUniform = true, opts) {
     static jwtEncodedCredentialToUniformCredential(jwt, opts) {
-        return CredentialMapper.jwtDecodedCredentialToUniformCredential((0, jwt_decode_1.default)(jwt), opts);
+        return CredentialMapper.jwtDecodedCredentialToUniformCredential((0, jwt_decode_1.jwtDecode)(jwt), opts);
     }
@@ -552,0 +549,0 @@ static jwtDecodedCredentialToUniformCredential(decoded, opts) {

dist/types/sd-jwt-type-metadata.d.ts

@@ -1,6 +0,5 @@
-import { AsyncHasher } from './sd-jwt-vc';
 /**
  * Represents the metadata associated with a specific SD-JWT VC type.
  */
-interface SdJwtTypeMetadata {
+export interface SdJwtTypeMetadata {
     /**
@@ -41,8 +40,46 @@ * REQUIRED. The VC type URI.
      */
-    claims?: Array<any>;
+    claims?: Array<SdJwtClaimMetadata>;
 }
 /**
+ * Represents the metadata associated with a specific SD-JWT claim.
+ */
+export interface SdJwtClaimMetadata {
+    /**
+     * REQUIRED. An array indicating the claim or claims that are being addressed.
+     */
+    path: Array<SdJwtClaimPath>;
+    /**
+     * OPTIONAL. Display information for the claim.
+     */
+    display?: Array<SdJwtClaimDisplayMetadata>;
+    /**
+     * OPTIONAL. A string indicating whether the claim is selectively disclosable.
+     */
+    sd?: SdJwtClaimSelectiveDisclosure;
+    /**
+     * OPTIONAL. A string defining the ID of the claim for reference in the SVG template.
+     */
+    svg_id?: string;
+}
+/**
+ * Represents claim display metadata for a specific language.
+ */
+export interface SdJwtClaimDisplayMetadata {
+    /**
+     * REQUIRED. Language tag for the display information.
+     */
+    lang: string;
+    /**
+     * REQUIRED. A human-readable label for the claim, intended for end users.
+     */
+    label: string;
+    /**
+     * REQUIRED. A human-readable description for the claim, intended for end users.
+     */
+    description?: string;
+}
+/**
  * Represents display metadata for a specific language.
  */
-interface SdJwtTypeDisplayMetadata {
+export interface SdJwtTypeDisplayMetadata {
     /**
@@ -68,3 +105,3 @@ * REQUIRED. Language tag for the display information.
  */
-interface SdJwtTypeRenderingMetadata {
+export interface SdJwtTypeRenderingMetadata {
     /**
@@ -82,3 +119,3 @@ * OPTIONAL. Simple rendering method metadata.
  */
-interface SdJwtSimpleRenderingMetadata {
+export interface SdJwtSimpleRenderingMetadata {
     /**
@@ -100,3 +137,3 @@ * OPTIONAL. Metadata for the logo image.
  */
-interface SdJwtLogoMetadata {
+export interface SdJwtLogoMetadata {
     /**
@@ -118,3 +155,3 @@ * REQUIRED. URI pointing to the logo image.
  */
-interface SdJwtSVGTemplateMetadata {
+export interface SdJwtSVGTemplateMetadata {
     /**
@@ -136,3 +173,3 @@ * REQUIRED. URI pointing to the SVG template.
  */
-interface SdJwtSVGTemplateProperties {
+export interface SdJwtSVGTemplateProperties {
     /**
@@ -147,8 +184,15 @@ * OPTIONAL. The orientation for which the SVG template is optimized.
 }
+/**
+ * A string indicates that the respective key is to be selected.
+ * A null value indicates that all elements of the currently selected array(s) are to be selected.
+ * A non-negative integer indicates that the respective index in an array is to be selected.
+ */
+export type SdJwtClaimPath = string | null | number;
+/**
+ * always: The Issuer MUST make the claim selectively disclosable.
+ * allowed: The Issuer MAY make the claim selectively disclosable.
+ * never: The Issuer MUST NOT make the claim selectively disclosable.
+ */
+export type SdJwtClaimSelectiveDisclosure = 'always' | 'allowed' | 'never';
 export type SdJwtTypeHasher = (input: any, alg?: string) => string;
-export declare function fetchSdJwtTypeMetadataFromVctUrl(vct: string, opts?: {
-    hasher?: AsyncHasher;
-    integrity?: string;
-}): Promise<SdJwtTypeMetadata>;
-export {};
 //# sourceMappingURL=sd-jwt-type-metadata.d.ts.map

dist/types/sd-jwt-type-metadata.js

 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchSdJwtTypeMetadataFromVctUrl = fetchSdJwtTypeMetadataFromVctUrl;
-const u8a = __importStar(require("uint8arrays"));
-// Helper function to fetch API with error handling
-function fetchUrlWithErrorHandling(url) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const response = yield fetch(url);
-        if (!response.ok) {
-            throw new Error(`${response.status}: ${response.statusText}`);
-        }
-        return response;
-    });
-}
-function validateIntegrity(input, integrityValue, hasher, alg) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const hash = yield hasher(input, alg !== null && alg !== void 0 ? alg : 'sha256');
-        return u8a.toString(hash, 'utf-8') === integrityValue;
-    });
-}
-// Fetch and validate Type Metadata
-function fetchSdJwtTypeMetadataFromVctUrl(vct, opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const url = new URL(vct);
-        const wellKnownUrl = `${url.origin}/.well-known/vct${url.pathname}`;
-        const response = yield fetchUrlWithErrorHandling(wellKnownUrl);
-        const metadata = yield response.json();
-        assertValidTypeMetadata(metadata, vct);
-        if ((opts === null || opts === void 0 ? void 0 : opts.integrity) && opts.hasher) {
-            if (!(yield validateIntegrity(metadata, opts.integrity, opts.hasher))) {
-                throw new Error('Integrity check failed');
-            }
-        }
-        return metadata;
-    });
-}
-function assertValidTypeMetadata(metadata, vct) {
-    if (metadata.vct !== vct) {
-        throw new Error('VCT mismatch in metadata and credential');
-    }
-}
-/*
-// Example usage
-  try {
-    const vct = 'https://betelgeuse.example.com/education_credential'
-    const typeMetadata = await fetchSdJwtTypeMetadataFromVctUrl(vct)
-    console.log('Type Metadata retrieved successfully:', typeMetadata)
-  } catch (error) {
-    console.error('Error fetching type metadata:', error.message)
-  }
-*/
 //# sourceMappingURL=sd-jwt-type-metadata.js.map

package.json

 {
   "name": "@sphereon/ssi-types",
   "description": "SSI Common Types",
-  "version": "0.32.0",
+  "version": "0.32.1-feature.MWALL.717.jwt.decode.crash.15+1619ae43",
   "main": "dist/index.js",
@@ -16,3 +16,3 @@ "types": "dist/index.d.ts",
     "events": "^3.3.0",
-    "jwt-decode": "^3.1.2",
+    "jwt-decode": "^4.0.0",
     "uint8arrays": "3.1.1"
@@ -51,3 +51,3 @@ },
   "nx": {},
-  "gitHead": "6585912cbda057506cc459b23285526e53a9bce9"
+  "gitHead": "1619ae43e4fdee49a2bf6bfb6196cce25d33e5a3"
 }

src/mapper/credential-mapper.ts

 import { IssuerType } from '@veramo/core'
-import jwt_decode from 'jwt-decode'
 import {
@@ -48,2 +47,3 @@ AsyncHasher,
 import DeviceResponseCbor = com.sphereon.mdoc.data.device.DeviceResponseCbor
+import { jwtDecode } from 'jwt-decode'
 
@@ -73,4 +73,4 @@ export class CredentialMapper {
     if (CredentialMapper.isJwtEncoded(presentation)) {
-      const payload = jwt_decode(presentation as string) as JwtDecodedVerifiablePresentation
-      const header = jwt_decode(presentation as string, { header: true }) as Record<string, any>
+      const payload = jwtDecode(presentation as string) as JwtDecodedVerifiablePresentation
+      const header = jwtDecode(presentation as string, { header: true }) as Record<string, any>
 
@@ -119,4 +119,4 @@ payload.vp.proof = {
     if (CredentialMapper.isJwtEncoded(credential)) {
-      const payload = jwt_decode(credential as string) as JwtDecodedVerifiableCredential
-      const header = jwt_decode(credential as string, { header: true }) as Record<string, any>
+      const payload = jwtDecode(credential as string) as JwtDecodedVerifiableCredential
+      const header = jwtDecode(credential as string, { header: true }) as Record<string, any>
       payload.vc.proof = {
@@ -536,3 +536,3 @@ type: IProofType.JwtProof2020,
   ): IPresentation {
-    return CredentialMapper.jwtDecodedPresentationToUniformPresentation(jwt_decode(jwt), makeCredentialsUniform, opts)
+    return CredentialMapper.jwtDecodedPresentationToUniformPresentation(jwtDecode(jwt), makeCredentialsUniform, opts)
   }
@@ -667,3 +667,3 @@
   ): IVerifiableCredential {
-    return CredentialMapper.jwtDecodedCredentialToUniformCredential(jwt_decode(jwt), opts)
+    return CredentialMapper.jwtDecodedCredentialToUniformCredential(jwtDecode(jwt), opts)
   }
@@ -670,0 +670,0 @@

src/types/sd-jwt-type-metadata.ts

@@ -1,8 +0,5 @@
-import * as u8a from 'uint8arrays'
-import { AsyncHasher } from './sd-jwt-vc'
-
 /**
  * Represents the metadata associated with a specific SD-JWT VC type.
  */
-interface SdJwtTypeMetadata {
+export interface SdJwtTypeMetadata {
   /**
@@ -51,10 +48,54 @@ * REQUIRED. The VC type URI.
    */
-  // TODO:
-  claims?: Array<any>
+  claims?: Array<SdJwtClaimMetadata>
 }
 
 /**
+ * Represents the metadata associated with a specific SD-JWT claim.
+ */
+export interface SdJwtClaimMetadata {
+  /**
+   * REQUIRED. An array indicating the claim or claims that are being addressed.
+   */
+  path: Array<SdJwtClaimPath>
+
+  /**
+   * OPTIONAL. Display information for the claim.
+   */
+  display?: Array<SdJwtClaimDisplayMetadata>
+
+  /**
+   * OPTIONAL. A string indicating whether the claim is selectively disclosable.
+   */
+  sd?: SdJwtClaimSelectiveDisclosure
+
+  /**
+   * OPTIONAL. A string defining the ID of the claim for reference in the SVG template.
+   */
+  svg_id?: string
+}
+
+/**
+ * Represents claim display metadata for a specific language.
+ */
+export interface SdJwtClaimDisplayMetadata {
+  /**
+   * REQUIRED. Language tag for the display information.
+   */
+  lang: string
+
+  /**
+   * REQUIRED. A human-readable label for the claim, intended for end users.
+   */
+  label: string
+
+  /**
+   * REQUIRED. A human-readable description for the claim, intended for end users.
+   */
+  description?: string
+}
+
+/**
  * Represents display metadata for a specific language.
  */
-interface SdJwtTypeDisplayMetadata {
+export interface SdJwtTypeDisplayMetadata {
   /**
@@ -84,3 +125,3 @@ * REQUIRED. Language tag for the display information.
  */
-interface SdJwtTypeRenderingMetadata {
+export interface SdJwtTypeRenderingMetadata {
   /**
@@ -100,3 +141,3 @@ * OPTIONAL. Simple rendering method metadata.
  */
-interface SdJwtSimpleRenderingMetadata {
+export interface SdJwtSimpleRenderingMetadata {
   /**
@@ -121,3 +162,3 @@ * OPTIONAL. Metadata for the logo image.
  */
-interface SdJwtLogoMetadata {
+export interface SdJwtLogoMetadata {
   /**
@@ -142,3 +183,3 @@ * REQUIRED. URI pointing to the logo image.
  */
-interface SdJwtSVGTemplateMetadata {
+export interface SdJwtSVGTemplateMetadata {
   /**
@@ -163,3 +204,3 @@ * REQUIRED. URI pointing to the SVG template.
  */
-interface SdJwtSVGTemplateProperties {
+export interface SdJwtSVGTemplateProperties {
   /**
@@ -176,49 +217,16 @@ * OPTIONAL. The orientation for which the SVG template is optimized.
 
-// Helper function to fetch API with error handling
-async function fetchUrlWithErrorHandling(url: string): Promise<Response> {
-  const response = await fetch(url)
-  if (!response.ok) {
-    throw new Error(`${response.status}: ${response.statusText}`)
-  }
-  return response
-}
+/**
+ * A string indicates that the respective key is to be selected.
+ * A null value indicates that all elements of the currently selected array(s) are to be selected.
+ * A non-negative integer indicates that the respective index in an array is to be selected.
+ */
+export type SdJwtClaimPath = string | null | number
 
+/**
+ * always: The Issuer MUST make the claim selectively disclosable.
+ * allowed: The Issuer MAY make the claim selectively disclosable.
+ * never: The Issuer MUST NOT make the claim selectively disclosable.
+ */
+export type SdJwtClaimSelectiveDisclosure = 'always' | 'allowed' | 'never'
+
 export type SdJwtTypeHasher = (input: any, alg?: string) => string
-
-async function validateIntegrity(input: any, integrityValue: string, hasher: AsyncHasher, alg?: string): Promise<boolean> {
-  const hash = await hasher(input, alg ?? 'sha256')
-  return u8a.toString(hash, 'utf-8') === integrityValue
-}
-
-// Fetch and validate Type Metadata
-export async function fetchSdJwtTypeMetadataFromVctUrl(vct: string, opts?: { hasher?: AsyncHasher; integrity?: string }): Promise<SdJwtTypeMetadata> {
-  const url = new URL(vct)
-  const wellKnownUrl = `${url.origin}/.well-known/vct${url.pathname}`
-
-  const response = await fetchUrlWithErrorHandling(wellKnownUrl)
-  const metadata: SdJwtTypeMetadata = await response.json()
-  assertValidTypeMetadata(metadata, vct)
-  if (opts?.integrity && opts.hasher) {
-    if (!(await validateIntegrity(metadata, opts.integrity, opts.hasher))) {
-      throw new Error('Integrity check failed')
-    }
-  }
-  return metadata
-}
-
-function assertValidTypeMetadata(metadata: SdJwtTypeMetadata, vct: string): void {
-  if (metadata.vct !== vct) {
-    throw new Error('VCT mismatch in metadata and credential')
-  }
-}
-
-/*
-// Example usage
-  try {
-    const vct = 'https://betelgeuse.example.com/education_credential'
-    const typeMetadata = await fetchSdJwtTypeMetadataFromVctUrl(vct)
-    console.log('Type Metadata retrieved successfully:', typeMetadata)
-  } catch (error) {
-    console.error('Error fetching type metadata:', error.message)
-  }
-*/

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

363789

decreased by-0.89%

Lines of code

6298

decreased by-0.54%

Dependency changes

• + Addedjwt-decode@4.0.0(transitive)

• - Removedjwt-decode@3.1.2(transitive)

• Updatedjwt-decode@^4.0.0