feat: Issuer credential offer and more fixes/features

README.md

@@ -5,7 +5,7 @@
   <br>
 </h1>
 
-[![CI](https://github.com/Sphereon-Opensource/OpenID4VCI/actions/workflows/build-test-on-pr.yml/badge.svg)](https://github.com/Sphereon-Opensource/OpenID4VCI/actions/workflows/build-test-on-pr.yml) [![codecov](https://codecov.io/gh/Sphereon-Opensource/OpenID4VCI/branch/develop/graph/badge.svg)](https://codecov.io/gh/Sphereon-Opensource/OpenID4VCI) [![NPM Version](https://img.shields.io/npm/v/@sphereon/openid4vci.svg)](https://npm.im/@sphereon/openid4vci)
+[![CI](https://github.com/Sphereon-Opensource/OpenID4VCI/actions/workflows/build-test-on-pr.yml/badge.svg)](https://github.com/Sphereon-Opensource/OpenID4VCI/actions/workflows/build-test-on-pr.yml) [![codecov](https://codecov.io/gh/Sphereon-Opensource/OpenID4VCI/branch/develop/graph/badge.svg)](https://codecov.io/gh/Sphereon-Opensource/OpenID4VCI) [![NPM Version](https://img.shields.io/npm/v/@sphereon/oid4vci.svg)](https://npm.im/@sphereon/oid4vci)
 
 _IMPORTANT the packages are in an early development stage and currently only supports the pre-authorized code flow of
 OpenID4VCI! Work is underway for the Authorized Flows as well, but not fully supported yet_

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "openid4vci-workspace",
-  "version": "0.5.0-unstable.0",
+  "name": "@sphereon/oid4vci-workspace",
+  "version": "0.5.0",
   "description": "OpenID for Verifiable Credential Issuance workspace",
   "author": "Sphereon",
   "license": "Apache-2.0",

packages/callback-example/lib/IssuerCallback.ts

@@ -3,7 +3,7 @@ import { Ed25519Signature2020 } from '@digitalcredentials/ed25519-signature-2020
 import { Ed25519VerificationKey2020 } from '@digitalcredentials/ed25519-verification-key-2020'
 import { securityLoader } from '@digitalcredentials/security-document-loader'
 import vc from '@digitalcredentials/vc'
-import { CredentialRequest } from '@sphereon/openid4vci-common'
+import { CredentialRequest } from '@sphereon/oid4vci-common'
 import { ICredential, W3CVerifiableCredential } from '@sphereon/ssi-types'
 
 // Example on how to generate a did:key to issue a verifiable credential

packages/callback-example/lib/__tests__/issuerCallback.spec.ts

@@ -1,21 +1,22 @@
 import { KeyObject } from 'crypto'
 
-import { CredentialRequestClient, CredentialRequestClientBuilderV1_0_09, ProofOfPossessionBuilder } from '@sphereon/openid4vci-client'
+import { CredentialRequestClient, CredentialRequestClientBuilderV1_0_09, ProofOfPossessionBuilder } from '@sphereon/oid4vci-client'
 import {
   Alg,
   CredentialFormatEnum,
+  CredentialOfferJwtVcJsonLdAndLdpVcV1_0_11,
   CredentialSupported,
   Display,
   IssuerCredentialSubjectDisplay,
   Jwt,
   ProofOfPossession,
   Typ,
-} from '@sphereon/openid4vci-common'
-import { CredentialSupportedBuilderV1_11, VcIssuer, VcIssuerBuilder } from '@sphereon/openid4vci-issuer'
-import { MemoryCredentialOfferStateManager } from '@sphereon/openid4vci-issuer/dist/state-manager/MemoryCredentialOfferStateManager'
+} from '@sphereon/oid4vci-common'
+import { CredentialSupportedBuilderV1_11, VcIssuer, VcIssuerBuilder } from '@sphereon/oid4vci-issuer'
 import { ICredential, IProofPurpose, IProofType, W3CVerifiableCredential } from '@sphereon/ssi-types'
 import * as jose from 'jose'
 
+import { MemoryCredentialOfferStateManager } from '../../../issuer/lib/state-manager'
 import { generateDid, getIssuerCallback, verifyCredential } from '../IssuerCallback'
 
 const INITIATION_TEST_URI =
@@ -95,16 +96,21 @@ describe('issuerCallback', () => {
       createdOn: +new Date(),
       userPin: 123456,
       credentialOffer: {
-        credential_issuer: 'did:key:test',
-        credential_definition: {
-          types: ['VerifiableCredential'],
-          '@context': ['https://www.w3.org/2018/credentials/v1'],
-          credentialSubject: {},
-        },
-        grants: {
-          authorization_code: { issuer_state: 'test_code' },
-          'urn:ietf:params:oauth:grant-type:pre-authorized_code': { 'pre-authorized_code': 'test_code', user_pin_required: true },
-        },
+        credential_offer: {
+          credential_issuer: 'did:key:test',
+          credential_definition: {
+            types: ['VerifiableCredential'],
+            '@context': ['https://www.w3.org/2018/credentials/v1'],
+            credentialSubject: {},
+          },
+          grants: {
+            authorization_code: { issuer_state: 'test_code' },
+            'urn:ietf:params:oauth:grant-type:pre-authorized_code': {
+              'pre-authorized_code': 'test_code',
+              user_pin_required: true,
+            },
+          },
+        } as CredentialOfferJwtVcJsonLdAndLdpVcV1_0_11,
       },
     })
     vcIssuer = new VcIssuerBuilder()

packages/callback-example/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@sphereon/openid4vci-callback-example",
-  "version": "0.5.0-unstable.0",
+  "name": "@sphereon/oid4vci-callback-example",
+  "version": "0.5.0",
   "description": "OpenID 4 Verifiable Credential Issuance issuer callback example",
   "source": "lib/index.ts",
   "main": "dist/index.js",
@@ -14,9 +14,9 @@
     "@digitalcredentials/ed25519-verification-key-2020": "^4.0.0",
     "@digitalcredentials/security-document-loader": "^1.0.0",
     "@digitalcredentials/vc": "^5.0.0",
-    "@sphereon/openid4vci-common": "workspace:../common",
-    "@sphereon/openid4vci-issuer": "workspace:../issuer",
-    "@sphereon/openid4vci-client": "workspace:../client",
+    "@sphereon/oid4vci-common": "workspace:*",
+    "@sphereon/oid4vci-issuer": "workspace:*",
+    "@sphereon/oid4vci-client": "workspace:*",
     "@sphereon/ssi-types": "^0.9.0",
     "jose": "^4.10.0"
   },

packages/callback-example/tsconfig.json

@@ -8,6 +8,12 @@
   "references": [
     {
       "path": "../common"
+    },
+    {
+      "path": "../client"
+    },
+    {
+      "path": "../issuer"
     }
   ]
 }

packages/client/CHANGELOG.md

@@ -75,7 +75,7 @@ Release with support for the pre-authorized code flow only!
 
 Release with support for the pre-authorized code flow only!
 
-**WARNING: The package has been renamed to @sphereon/openid4vci-client!**
+**WARNING: The package has been renamed to @sphereon/oid4vci-client!**
 
 - Added:
 

packages/client/README.md

@@ -5,7 +5,7 @@
   <br>
 </h1>
 
-[![CI](https://github.com/Sphereon-Opensource/openid4vci-client/actions/workflows/main.yml/badge.svg)](https://github.com/Sphereon-Opensource/openid4vci-client/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/Sphereon-Opensource/openid4vci-client/branch/develop/graph/badge.svg)](https://codecov.io/gh/Sphereon-Opensource/openid4vci-client) [![NPM Version](https://img.shields.io/npm/v/@sphereon/openid4vci-client.svg)](https://npm.im/@sphereon/openid4vci-client)
+[![CI](https://github.com/Sphereon-Opensource/openid4vci-client/actions/workflows/main.yml/badge.svg)](https://github.com/Sphereon-Opensource/openid4vci-client/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/Sphereon-Opensource/openid4vci-client/branch/develop/graph/badge.svg)](https://codecov.io/gh/Sphereon-Opensource/openid4vci-client) [![NPM Version](https://img.shields.io/npm/v/@sphereon/oid4vci-client.svg)](https://npm.im/@sphereon/oid4vci-client)
 
 _IMPORTANT this package is in an early development stage and currently only supports the pre-authorized code flow of
 OpenID4VCI!_
@@ -52,7 +52,7 @@ This initiates the client using a URI obtained from the Issuer using a link (URL
 already fetching the Server Metadata
 
 ```typescript
-import { OpenID4VCIClient } from '@sphereon/openid4vci-client';
+import { OpenID4VCIClient } from '@sphereon/oid4vci-client';
 
 // The client is initiated from a URI. This URI is provided by the Issuer, typically as a URL or QR code.
 const client = await OpenID4VCIClient.fromURI({
@@ -77,7 +77,7 @@ The code above already retrieved the metadata, so it will not be fetched again.
 the `retrieveServerMetadata` option, you can use this method to fetch it from the Issuer:
 
 ```typescript
-import { OpenID4VCIClient } from '@sphereon/openid4vci-client';
+import { OpenID4VCIClient } from '@sphereon/oid4vci-client';
 
 const metadata = await client.retrieveServerMetadata();
 ```
@@ -157,7 +157,7 @@ as a link or a QR code. You can call the `CredentialOffer.fromURI(uri)` method t
 containing the baseUrl and a `uri` JSON object
 
 ```typescript
-import { CredentialOffer } from '@sphereon/openid4vci-client';
+import { CredentialOffer } from '@sphereon/oid4vci-client';
 
 const initiationURI =
   'https://issuer.example.com?issuer=https%3A%2F%2Fserver%2Eexample%2Ecom&credential_type=https%3A%2F%2Fdid%2Eexample%2Eorg%2FhealthCard&credential_type=https%3A%2F%2Fdid%2Eexample%2Eorg%2FdriverLicense&op_state=eyJhbGciOiJSU0Et...FYUaBy';
@@ -193,7 +193,7 @@ OpenID4VCI well-known location is not found, the OIDC/OAuth2 well-known location
 Example:
 
 ```typescript
-import { MetadataClient } from '@sphereon/openid4vci-client';
+import { MetadataClient } from '@sphereon/oid4vci-client';
 
 const metadata = await MetadataClient.retrieveAllMetadataFromCredentialOffer(initiationRequestWithUrl);
 
@@ -235,7 +235,7 @@ The library allows to pass in a different value for the AS token endpoint as wel
 if you know the AS upfront. If no AS is provided the issuer value from the Issuance Initiation Request will be used.
 
 ```typescript
-import { AccessTokenClient, AuthorizationServerOpts } from '@sphereon/openid4vci-client';
+import { AccessTokenClient, AuthorizationServerOpts } from '@sphereon/oid4vci-client';
 
 const clientId = 'abcd'; // This can be a random value or a clientId assigned by the Authorization Server (depends on the environment)
 const pin = 1234; // A pincode which is shown out of band typically. Only use when the pin-code is required from the Issuance Initiation object.
@@ -279,7 +279,7 @@ export type JWTVerifyCallback = (args: { jwt: string; kid: string }) => Promise<
 This is an example of the signature callback function created using the `jose` library.
 
 ```typescript
-import { Jwt } from '@sphereon/openid4vci-client';
+import { Jwt } from '@sphereon/oid4vci-client';
 
 const { privateKey, publicKey } = await jose.generateKeyPair('ES256');
 
@@ -338,10 +338,10 @@ export interface Jwt {
 }
 ```
 
-The arguments requested by `jose` and `@sphereon/openid4vci-client`
+The arguments requested by `jose` and `@sphereon/oid4vci-client`
 
 ```typescript
-import { Jwt, ProofOfPossessionCallbacks } from '@sphereon/openid4vci-client';
+import { Jwt, ProofOfPossessionCallbacks } from '@sphereon/oid4vci-client';
 
 const callbacks: ProofOfPossessionCallbacks = {
   signCallback,
@@ -357,7 +357,7 @@ Normally you would use the Proof of Possession builder using the server metadata
 the callbacks. There is however the possibility to use a JWT directly, which will be explained in the next section.
 
 ```typescript
-import { ProofOfPossessionBuilder } from '@sphereon/openid4vci-client';
+import { ProofOfPossessionBuilder } from '@sphereon/oid4vci-client';
 
 const proofInput: ProofOfPossession = await ProofOfPossessionBuilder.fromAccessTokenResponse({
   accessTokenResponse,
@@ -381,7 +381,7 @@ have to use the `c_nonce` value from the Access Token response as `nonce` value!
 the `jti` property.
 
 ```typescript
-import { Jwt, ProofOfPossessionBuilder, ProofOfPossessionCallbacks } from '@sphereon/openid4vci-client';
+import { Jwt, ProofOfPossessionBuilder, ProofOfPossessionCallbacks } from '@sphereon/oid4vci-client';
 
 const callbacks: ProofOfPossessionCallbacks = {
   signCallback,
@@ -413,7 +413,7 @@ Now it is time to request the actual Credential(s) from the Issuer. The example
 the keypair created earlier.
 
 ```typescript
-import { CredentialRequestClientBuilder, CredentialResponse, ProofOfPossessionArgs } from '@sphereon/openid4vci-client';
+import { CredentialRequestClientBuilder, CredentialResponse, ProofOfPossessionArgs } from '@sphereon/oid4vci-client';
 
 const credentialRequestClient = CredentialRequestClientBuilder.fromCredentialOfferRequest(initiationRequestWithUrl, metadata).build();
 
@@ -438,7 +438,7 @@ Several utility functions are available
 Converts a Json object or string into an URI:
 
 ```typescript
-import { convertJsonToURI } from '@sphereon/openid4vci-client';
+import { convertJsonToURI } from '@sphereon/oid4vci-client';
 
 const encodedURI = convertJsonToURI(
   {
@@ -461,7 +461,7 @@ Converts a URI into a Json object with URL decoded properties. Allows to provide
 be converted into an array.
 
 ```typescript
-import { convertURIToJsonObject } from '@sphereon/openid4vci-client';
+import { convertURIToJsonObject } from '@sphereon/oid4vci-client';
 
 const decodedJson = convertURIToJsonObject(
   'issuer=https%3A%2F%2Fserver%2Eexample%2Ecom&credential_type=https%3A%2F%2Fdid%2Eexample%2Eorg%2FhealthCard&credential_type=https%3A%2F%2Fdid%2Eexample%2Eorg%2FdriverLicense&op_state=eyJhbGciOiJSU0Et...FYUaBy',

packages/client/lib/AccessTokenClient.ts

@@ -15,7 +15,7 @@ import {
   OpenIDResponse,
   PRE_AUTH_CODE_LITERAL,
   TokenErrorResponse,
-} from '@sphereon/openid4vci-common';
+} from '@sphereon/oid4vci-common';
 import { ObjectUtils } from '@sphereon/ssi-types';
 import Debug from 'debug';
 

packages/client/lib/AuthorizationDetailsBuilder.ts

@@ -1,4 +1,4 @@
-import { AuthorizationDetailsJwtVcJson, CredentialFormatEnum } from '@sphereon/openid4vci-common';
+import { AuthorizationDetailsJwtVcJson, CredentialFormatEnum } from '@sphereon/oid4vci-common';
 
 //todo: refactor this builder to be able to create ldp details as well
 export class AuthorizationDetailsBuilder {

packages/client/lib/CredentialOffer.ts

@@ -4,8 +4,8 @@ import {
   CredentialOfferPayloadV1_0_11,
   CredentialOfferRequestWithBaseUrl,
   OpenId4VCIVersion,
-} from '@sphereon/openid4vci-common';
-import { determineSpecVersionFromURI } from '@sphereon/openid4vci-common';
+} from '@sphereon/oid4vci-common';
+import { determineSpecVersionFromURI } from '@sphereon/oid4vci-common';
 import Debug from 'debug';
 
 import { convertJsonToURI, convertURIToJsonObject } from './functions';

packages/client/lib/CredentialRequestClient.ts

@@ -1,4 +1,4 @@
-import { CredentialRequest, CredentialResponse, OpenIDResponse, ProofOfPossession, URL_NOT_VALID } from '@sphereon/openid4vci-common';
+import { CredentialRequest, CredentialResponse, OpenIDResponse, ProofOfPossession, URL_NOT_VALID } from '@sphereon/oid4vci-common';
 import { CredentialFormat } from '@sphereon/ssi-types';
 import Debug from 'debug';
 

packages/client/lib/CredentialRequestClientBuilderV1_0_09.ts

@@ -6,7 +6,7 @@ import {
   EndpointMetadata,
   getIssuerFromCredentialOfferPayload,
   IssuerMetadata,
-} from '@sphereon/openid4vci-common';
+} from '@sphereon/oid4vci-common';
 import { CredentialFormat } from '@sphereon/ssi-types';
 
 import { CredentialRequestClient } from './CredentialRequestClient';

packages/client/lib/MetadataClient.ts

@@ -8,7 +8,7 @@ import {
   Oauth2ASWithOID4VCIMetadata,
   OpenIDResponse,
   WellKnownEndpoints,
-} from '@sphereon/openid4vci-common';
+} from '@sphereon/oid4vci-common';
 import Debug from 'debug';
 
 import { getJson } from './functions';

packages/client/lib/OpenID4VCIClient.ts

@@ -14,8 +14,8 @@ import {
   ProofOfPossessionCallbacks,
   PushedAuthorizationResponse,
   ResponseType,
-} from '@sphereon/openid4vci-common';
-import { CredentialSupportedTypeV1_0_08, CredentialSupportedV1_0_08 } from '@sphereon/openid4vci-common/dist/types/v1_0_08.types';
+} from '@sphereon/oid4vci-common';
+import { CredentialSupportedTypeV1_0_08, CredentialSupportedV1_0_08 } from '@sphereon/oid4vci-common/dist/types/v1_0_08.types';
 import { CredentialFormat } from '@sphereon/ssi-types';
 import Debug from 'debug';
 

packages/client/lib/ProofOfPossessionBuilder.ts

@@ -7,7 +7,7 @@ import {
   PROOF_CANT_BE_CONSTRUCTED,
   ProofOfPossession,
   ProofOfPossessionCallbacks,
-} from '@sphereon/openid4vci-common';
+} from '@sphereon/oid4vci-common';
 
 import { createProofOfPossession } from './functions';
 

packages/client/lib/__tests__/AccessTokenClient.spec.ts

@@ -1,4 +1,4 @@
-import { AccessTokenRequest, AccessTokenRequestOpts, AccessTokenResponse, GrantTypes, OpenIDResponse } from '@sphereon/openid4vci-common';
+import { AccessTokenRequest, AccessTokenRequestOpts, AccessTokenResponse, GrantTypes, OpenIDResponse } from '@sphereon/oid4vci-common';
 import nock from 'nock';
 
 import { AccessTokenClient } from '../AccessTokenClient';

packages/client/lib/__tests__/AuthorizationDetailsBuilder.spec.ts

@@ -1,4 +1,4 @@
-import { CredentialFormatEnum } from '@sphereon/openid4vci-common';
+import { CredentialFormatEnum } from '@sphereon/oid4vci-common';
 
 import { AuthorizationDetailsBuilder } from '../AuthorizationDetailsBuilder';
 

packages/client/lib/__tests__/AuthzFlowType.spec.ts

@@ -1,4 +1,4 @@
-import { AuthzFlowType, CredentialOfferPayloadV1_0_09 } from '@sphereon/openid4vci-common';
+import { AuthzFlowType, CredentialOfferPayloadV1_0_09 } from '@sphereon/oid4vci-common';
 
 //todo: this file is just testing v9, we probably want to add v11 tests here as well
 describe('Authorization Flow Type determination', () => {

packages/client/lib/__tests__/CredentialRequestClient.spec.ts

@@ -11,7 +11,7 @@ import {
   Typ,
   URL_NOT_VALID,
   WellKnownEndpoints,
-} from '@sphereon/openid4vci-common';
+} from '@sphereon/oid4vci-common';
 import * as jose from 'jose';
 import nock from 'nock';
 

packages/client/lib/__tests__/CredentialRequestClientBuilder.spec.ts

@@ -1,6 +1,6 @@
 import { KeyObject } from 'crypto';
 
-import { Alg, CredentialRequest, IssuerMetadata, Jwt, JWTPayload, ProofOfPossession, Typ } from '@sphereon/openid4vci-common';
+import { Alg, CredentialRequest, IssuerMetadata, Jwt, JWTPayload, ProofOfPossession, Typ } from '@sphereon/oid4vci-common';
 import * as jose from 'jose';
 
 import { CredentialRequestClientBuilderV1_0_09, ProofOfPossessionBuilder } from '..';

packages/client/lib/__tests__/IT.spec.ts

@@ -1,4 +1,4 @@
-import { AccessTokenResponse, Alg, AuthzFlowType, CredentialOfferRequestWithBaseUrl, Jwt, ProofOfPossession, Typ } from '@sphereon/openid4vci-common';
+import { AccessTokenResponse, Alg, AuthzFlowType, CredentialOfferRequestWithBaseUrl, Jwt, ProofOfPossession, Typ } from '@sphereon/oid4vci-common';
 import nock from 'nock';
 
 import { AccessTokenClient, CredentialRequestClientBuilderV1_0_09, OpenID4VCIClient, ProofOfPossessionBuilder } from '..';

packages/client/lib/__tests__/IssuanceInitiation.spec.ts

@@ -1,4 +1,4 @@
-import { OpenId4VCIVersion } from '@sphereon/openid4vci-common';
+import { OpenId4VCIVersion } from '@sphereon/oid4vci-common';
 
 import { CredentialOffer } from '../CredentialOffer';
 

packages/client/lib/__tests__/MetadataClient.spec.ts

@@ -1,4 +1,4 @@
-import { getIssuerFromCredentialOfferPayload, WellKnownEndpoints } from '@sphereon/openid4vci-common';
+import { getIssuerFromCredentialOfferPayload, WellKnownEndpoints } from '@sphereon/oid4vci-common';
 import nock from 'nock';
 
 import { CredentialOffer } from '../CredentialOffer';

packages/client/lib/__tests__/MetadataMocks.ts

@@ -1,4 +1,4 @@
-import { CredentialOfferPayloadV1_0_09, CredentialOfferRequestWithBaseUrl, OpenId4VCIVersion } from '@sphereon/openid4vci-common';
+import { CredentialOfferPayloadV1_0_09, CredentialOfferRequestWithBaseUrl, OpenId4VCIVersion } from '@sphereon/oid4vci-common';
 
 export const IDENTIPROOF_ISSUER_URL = 'https://issuer.research.identiproof.io';
 export const IDENTIPROOF_AS_URL = 'https://auth.research.identiproof.io';

packages/client/lib/__tests__/OpenID4VCIClient.spec.ts

@@ -1,4 +1,6 @@
-import { AuthzFlowType, CodeChallengeMethod } from '@sphereon/openid4vci-common';
+import { AuthzFlowType, CodeChallengeMethod } from '@sphereon/oid4vci-common';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
 import nock from 'nock';
 
 import { OpenID4VCIClient } from '../OpenID4VCIClient';

packages/client/lib/__tests__/OpenID4VCIClientPAR.spec.ts

@@ -1,4 +1,4 @@
-import { AuthzFlowType, CodeChallengeMethod, Oauth2ASWithOID4VCIMetadata } from '@sphereon/openid4vci-common';
+import { AuthzFlowType, CodeChallengeMethod, Oauth2ASWithOID4VCIMetadata } from '@sphereon/oid4vci-common';
 import nock from 'nock';
 
 import { OpenID4VCIClient } from '../OpenID4VCIClient';