feat: deferred credential issuance (#86)

Signed-off-by: Henrique Dias <mail@hacdias.com>

Author: hacdias

.changeset/four-olives-tease.md

@@ -0,0 +1,6 @@
+---
+"@openid4vc/openid4vci": minor
+"@openid4vc/oauth2": patch
+---
+
+Add support for deferred credential issuance and Draft 16 of the OpenID for Verifiable Credential Issuance.

.changeset/fruity-spiders-stare.md

@@ -0,0 +1,6 @@
+---
+"@openid4vc/openid4vci": patch
+"@openid4vc/oauth2": patch
+---
+
+Fix a myriad of typos across errors, comments, and variable names.

packages/oauth2/src/Oauth2AuthorizationServer.ts

@@ -40,7 +40,7 @@ import {
   verifyPushedAuthorizationRequest,
 } from './authorization-request/verify-pushed-authorization-request'
 import type { CallbackContext } from './callbacks'
-import { type VerifyClientAttestationOptions, verifyClientAttestation } from './client-attestation/clent-attestation'
+import { type VerifyClientAttestationOptions, verifyClientAttestation } from './client-attestation/client-attestation'
 import { Oauth2ErrorCodes } from './common/z-oauth2-error'
 import { type VerifyDpopJwtOptions, verifyDpopJwt } from './dpop/dpop'
 import {

packages/oauth2/src/access-token/__tests__/parse-access-token-request.test.mts

@@ -14,7 +14,7 @@ describe('Parse Access Token Request', () => {
           url: 'https://request.com/token',
         },
       })
-    ).toThrow('Error occured during validation of authorization request.')
+    ).toThrow('Error occurred during validation of authorization request.')
   })
 
   test('handles unknown grant_type', () => {

packages/oauth2/src/access-token/introspect-token.ts

@@ -18,7 +18,7 @@ export interface IntrospectTokenOptions {
   authorizationServerMetadata: AuthorizationServerMetadata
 
   /**
-   * The provided acccess token
+   * The provided access token
    */
   token: string
 
@@ -29,7 +29,7 @@ export interface IntrospectTokenOptions {
   tokenTypeHint?: string
 
   /**
-   * Additional payload to include in the introspection equest. Items will be encoded and sent
+   * Additional payload to include in the introspection request. Items will be encoded and sent
    * using x-www-form-urlencoded format. Nested items (JSON) will be stringified and url encoded.
    */
   additionalPayload?: Record<string, unknown>

packages/oauth2/src/access-token/parse-access-token-request.ts

@@ -1,5 +1,5 @@
 import { formatZodError } from '@openid4vc/utils'
-import { extractClientAttestationJwtsFromHeaders } from '../client-attestation/clent-attestation'
+import { extractClientAttestationJwtsFromHeaders } from '../client-attestation/client-attestation'
 import type { RequestLike } from '../common/z-common'
 import { Oauth2ErrorCodes } from '../common/z-oauth2-error'
 import { extractDpopJwtFromHeaders } from '../dpop/dpop'
@@ -57,7 +57,7 @@ export interface ParseAccessTokenRequestOptions {
 
   /**
    * The access token request as a JSON object. Your server should decode the
-   * `x-www-url-form-urlencoded` body into an object (e.g. using `bodyParser.urlEncoed()` in express)
+   * `x-www-url-form-urlencoded` body into an object (e.g. using `bodyParser.urlEncoded()` in express)
    */
   accessTokenRequest: Record<string, unknown>
 }
@@ -74,7 +74,7 @@ export function parseAccessTokenRequest(options: ParseAccessTokenRequestOptions)
   if (!parsedAccessTokenRequest.success) {
     throw new Oauth2ServerErrorResponseError({
       error: Oauth2ErrorCodes.InvalidRequest,
-      error_description: `Error occured during validation of authorization request.\n${formatZodError(parsedAccessTokenRequest.error)}`,
+      error_description: `Error occurred during validation of authorization request.\n${formatZodError(parsedAccessTokenRequest.error)}`,
     })
   }
 

packages/oauth2/src/access-token/verify-access-token-request.ts

@@ -1,5 +1,5 @@
 import { type CallbackContext, HashAlgorithm } from '../callbacks'
-import { type VerifiedClientAttestationJwt, verifyClientAttestation } from '../client-attestation/clent-attestation'
+import { type VerifiedClientAttestationJwt, verifyClientAttestation } from '../client-attestation/client-attestation'
 import type { VerifiedClientAttestationPopJwt } from '../client-attestation/client-attestation-pop'
 import {
   oauthClientAttestationHeader,
@@ -306,7 +306,7 @@ async function verifyAccessTokenRequestClientAttestation(
         {
           error: Oauth2ErrorCodes.InvalidRequest,
           error_description:
-            'Expected the DPoP JWK thumbprint value to match the JWK thumbprint of the client attestation confirmation JWK. Ensrue both DPoP and client attestation use the same key.',
+            'Expected the DPoP JWK thumbprint value to match the JWK thumbprint of the client attestation confirmation JWK. Ensure both DPoP and client attestation use the same key.',
         },
         {
           status: 401,

packages/oauth2/src/authorization-challenge/parse-authorization-challenge-request.ts

@@ -32,7 +32,7 @@ export function parseAuthorizationChallengeRequest(
   if (!parsedAuthorizationChallengeRequest.success) {
     throw new Oauth2ServerErrorResponseError({
       error: Oauth2ErrorCodes.InvalidRequest,
-      error_description: `Error occured during validation of authorization challenge request.\n${formatZodError(parsedAuthorizationChallengeRequest.error)}`,
+      error_description: `Error occurred during validation of authorization challenge request.\n${formatZodError(parsedAuthorizationChallengeRequest.error)}`,
     })
   }
 

packages/oauth2/src/authorization-request/parse-authorization-request.ts

@@ -1,4 +1,4 @@
-import { extractClientAttestationJwtsFromHeaders } from '../client-attestation/clent-attestation'
+import { extractClientAttestationJwtsFromHeaders } from '../client-attestation/client-attestation'
 import type { RequestLike } from '../common/z-common'
 import { Oauth2ErrorCodes } from '../common/z-oauth2-error'
 import { extractDpopJwtFromHeaders } from '../dpop/dpop'
@@ -31,7 +31,7 @@ export interface ParseAuthorizationRequestResult {
         jwt: string
       }
 
-  // TOOD: we should revampt this to generic client authentication so we can suppor other
+  // TODO: we should revampt this to generic client authentication so we can suppor other
   // method as well. We should also create a generic verify client authentication method.
   /**
    * The client attestation jwts from the authorization request headers.

packages/oauth2/src/authorization-request/verify-authorization-request.ts

@@ -1,5 +1,5 @@
 import { type CallbackContext, HashAlgorithm } from '../callbacks'
-import { type VerifiedClientAttestationJwt, verifyClientAttestation } from '../client-attestation/clent-attestation'
+import { type VerifiedClientAttestationJwt, verifyClientAttestation } from '../client-attestation/client-attestation'
 import type { VerifiedClientAttestationPopJwt } from '../client-attestation/client-attestation-pop'
 import {
   oauthClientAttestationHeader,
@@ -23,15 +23,15 @@ export interface VerifyAuthorizationRequestDpop {
    * The dpop jwt from the pushed authorization request.
    *
    * If dpop is required, at least one of `jwt` or `jwkThumbprint` MUST
-   * be provided. If both are provided, the jwk thubmprints are matched
+   * be provided. If both are provided, the jwk thumbprints are matched
    */
   jwt?: string
 
   /**
    * The jwk thumbprint as provided in the `dpop_jkt` parameter.
    *
    * If dpop is required, at least one of `jwt` or `jwkThumbprint` MUST
-   * be provided. If both are provided, the jwk thubmprints are matched
+   * be provided. If both are provided, the jwk thumbprints are matched
    */
   jwkThumbprint?: string
 
@@ -73,7 +73,7 @@ export interface VerifyAuthorizationRequestReturn {
     jwkThumbprint: string
 
     /**
-     * The JWK will be returend if a DPoP proof was provided in the header.
+     * The JWK will be returned if a DPoP proof was provided in the header.
      */
     jwk?: Jwk
   }
@@ -188,7 +188,7 @@ async function verifyAuthorizationRequestClientAttestation(
         {
           error: Oauth2ErrorCodes.InvalidRequest,
           error_description:
-            'Expected the DPoP JWK thumbprint value to match the JWK thumbprint of the client attestation confirmation JWK. Ensrue both DPoP and client attestation use the same key.',
+            'Expected the DPoP JWK thumbprint value to match the JWK thumbprint of the client attestation confirmation JWK. Ensure both DPoP and client attestation use the same key.',
         },
         {
           status: 401,