@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth 0.34.1-feature.FIDES.1.274 → 0.34.1-feature.IDK.11.48

package/src/types/ISIOPv2RP.ts

@@ -2,38 +2,46 @@ import {
   AuthorizationRequestPayload,
   AuthorizationRequestState,
   AuthorizationResponsePayload,
-  AuthorizationResponseStateWithVerifiedData,
-  CallbackOpts,
+  AuthorizationResponseState,
   ClaimPayloadCommonOpts,
   ClientMetadataOpts,
   IRPSessionManager,
+  PresentationDefinitionWithLocation,
   PresentationVerificationCallback,
   RequestObjectPayload,
   ResponseMode,
   ResponseURIType,
   SupportedVersion,
+  VerifiablePresentationTypeFormat,
   VerifiedAuthorizationResponse,
   VerifyJwtCallback,
+  VPTokenLocation,
 } from '@sphereon/did-auth-siop'
-import { CheckLinkedDomain } from '@sphereon/did-auth-siop-adapter'
+import { ExternalIdentifierOIDFEntityIdOpts, IIdentifierResolution, ManagedIdentifierOptsOrResult } from '@sphereon/ssi-sdk-ext.identifier-resolution'
+import { IAgentContext, ICredentialIssuer, ICredentialVerifier, IDIDManager, IKeyManager, IPluginMethodMap, IResolver } from '@veramo/core'
+import { AdditionalClaims, DcqlQueryREST, HasherSync, W3CVerifiablePresentation } from '@sphereon/ssi-types'
+
+import { Resolvable } from 'did-resolver'
 import { DIDDocument } from '@sphereon/did-uni-client'
-import { JwtIssuer } from '@sphereon/oid4vc-common'
+import { EventEmitter } from 'events'
 import { IPresentationDefinition } from '@sphereon/pex'
 import { IDIDOptions } from '@sphereon/ssi-sdk-ext.did-utils'
-import { ExternalIdentifierOIDFEntityIdOpts, IIdentifierResolution, ManagedIdentifierOptsOrResult } from '@sphereon/ssi-sdk-ext.identifier-resolution'
-import { IJwtService } from '@sphereon/ssi-sdk-ext.jwt-service'
-import { ICredentialValidation, SchemaValidation } from '@sphereon/ssi-sdk.credential-validation'
-import { ImDLMdoc } from '@sphereon/ssi-sdk.mdl-mdoc'
-import { ImportDcqlQueryItem, IPDManager, VersionControlMode } from '@sphereon/ssi-sdk.pd-manager'
 import { IPresentationExchange } from '@sphereon/ssi-sdk.presentation-exchange'
-import { ISDJwtPlugin } from '@sphereon/ssi-sdk.sd-jwt'
-import { AuthorizationRequestStateStatus } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
-import { HasherSync } from '@sphereon/ssi-types'
 import { VerifyCallback } from '@sphereon/wellknown-dids-client'
-import { IAgentContext, ICredentialVerifier, IDIDManager, IKeyManager, IPluginMethodMap, IResolver } from '@veramo/core'
-import { DcqlQuery } from 'dcql'
-import { Resolvable } from 'did-resolver'
-import { EventEmitter } from 'events'
+import { AuthorizationRequestStateStatus } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
+import { IPDManager, VersionControlMode } from '@sphereon/ssi-sdk.pd-manager'
+import { CheckLinkedDomain } from '@sphereon/did-auth-siop-adapter'
+import { ISDJwtPlugin } from '@sphereon/ssi-sdk.sd-jwt'
+import { IJwtService } from '@sphereon/ssi-sdk-ext.jwt-service'
+import { JwtIssuer } from '@sphereon/oid4vc-common'
+import { ImDLMdoc } from '@sphereon/ssi-sdk.mdl-mdoc'
+import { ICredentialValidation, SchemaValidation } from '@sphereon/ssi-sdk.credential-validation'
+
+export enum VerifiedDataMode {
+  NONE = 'none',
+  VERIFIED_PRESENTATION = 'vp',
+  CREDENTIAL_SUBJECT_FLATTENED = 'cs-flat',
+}
 
 export interface ISIOPv2RP extends IPluginMethodMap {
   siopCreateAuthRequestURI(createArgs: ICreateAuthRequestArgs, context: IRequiredContext): Promise<string>
@@ -47,6 +55,7 @@ export interface ISIOPv2RP extends IPluginMethodMap {
   siopDeleteAuthState(args: IDeleteAuthStateArgs, context: IRequiredContext): Promise<boolean>
   siopVerifyAuthResponse(args: IVerifyAuthResponseStateArgs, context: IRequiredContext): Promise<VerifiedAuthorizationResponse>
   siopImportDefinitions(args: ImportDefinitionsArgs, context: IRequiredContext): Promise<void>
+
   siopGetRedirectURI(args: IGetRedirectUriArgs, context: IRequiredContext): Promise<string | undefined>
 }
 
@@ -58,9 +67,8 @@ export interface ISiopv2RPOpts {
 export interface IRPDefaultOpts extends IRPOptions {}
 
 export interface ICreateAuthRequestArgs {
-  queryId: string
+  definitionId: string
   correlationId: string
-  useQueryIdInstance?: boolean
   responseURIType: ResponseURIType
   responseURI: string
   responseRedirectURI?: string
@@ -69,24 +77,24 @@ export interface ICreateAuthRequestArgs {
   nonce?: string
   state?: string
   claims?: ClaimPayloadCommonOpts
-  callback?: CallbackOpts
 }
 
 export interface IGetAuthRequestStateArgs {
   correlationId: string
-  queryId?: string
+  definitionId: string
   errorOnNotFound?: boolean
 }
 
 export interface IGetAuthResponseStateArgs {
   correlationId: string
-  queryId?: string
+  definitionId: string
   errorOnNotFound?: boolean
   progressRequestStateTo?: AuthorizationRequestStateStatus
+  includeVerifiedData?: VerifiedDataMode
 }
 
 export interface IUpdateRequestStateArgs {
-  queryId?: string
+  definitionId: string
   correlationId: string
   state: AuthorizationRequestStateStatus
   error?: string
@@ -94,18 +102,25 @@ export interface IUpdateRequestStateArgs {
 
 export interface IDeleteAuthStateArgs {
   correlationId: string
-  queryId?: string
+  definitionId: string
 }
 
 export interface IVerifyAuthResponseStateArgs {
   authorizationResponse: string | AuthorizationResponsePayload
-  queryId?: string
+  definitionId?: string
   correlationId: string
   audience?: string
-  dcqlQuery?: DcqlQuery
+  presentationDefinitions?: PresentationDefinitionWithLocation | PresentationDefinitionWithLocation[]
+  dcqlQuery?: DcqlQueryREST
+}
+
+export interface IDefinitionPair {
+  definitionPayload: IPresentationDefinition
+  dcqlPayload?: DcqlQueryREST
 }
+
 export interface ImportDefinitionsArgs {
-  importItems: Array<ImportDcqlQueryItem>
+  definitions: Array<IDefinitionPair>
   tenantId?: string
   version?: string
   versionControlMode?: VersionControlMode
@@ -113,7 +128,7 @@ export interface ImportDefinitionsArgs {
 
 export interface IGetRedirectUriArgs {
   correlationId: string
-  queryId?: string
+  definitionId?: string
   state?: string
 }
 
@@ -129,12 +144,11 @@ export interface IPEXDefinitionPersistArgs extends IPEXInstanceOptions {
 }
 
 export interface ISiopRPInstanceArgs {
-  createWhenNotPresent: boolean
-  queryId?: string
+  definitionId?: string
   responseRedirectURI?: string
 }
 
-export interface IPEXInstanceOptions extends IPresentationOptions {
+export interface IPEXInstanceOptions extends IPEXOptions {
   rpOpts?: IRPOptions
 }
 
@@ -152,9 +166,12 @@ export interface IRPOptions {
   responseRedirectUri?: string
 }
 
-export interface IPresentationOptions {
-  queryId: string
+export interface IPEXOptions {
   presentationVerifyCallback?: PresentationVerificationCallback
+  // definition?: IPresentationDefinition
+  definitionId: string
+  version?: string
+  tenantId?: string
 }
 
 export type VerificationPolicies = {
@@ -169,9 +186,17 @@ export interface PerDidResolver {
 export interface IAuthRequestDetails {
   rpDIDDocument?: DIDDocument
   id: string
+  verifiablePresentationMatches: IPresentationWithDefinition[]
   alsoKnownAs?: string[]
 }
 
+export interface IPresentationWithDefinition {
+  location: VPTokenLocation
+  definition: PresentationDefinitionWithLocation
+  format: VerifiablePresentationTypeFormat
+  presentation: W3CVerifiablePresentation
+}
+
 export interface ISIOPIdentifierOptions extends Omit<IDIDOptions, 'idOpts'> {
   // we replace the legacy idOpts with the Managed Identifier opts from the identifier resolution module
   idOpts: ManagedIdentifierOptsOrResult
@@ -185,11 +210,16 @@ export type CredentialOpts = {
   hasher?: HasherSync
 }
 
+export interface AuthorizationResponseStateWithVerifiedData extends AuthorizationResponseState {
+  verifiedData?: AdditionalClaims
+}
+
 export type IRequiredContext = IAgentContext<
   IResolver &
     IDIDManager &
     IKeyManager &
     IIdentifierResolution &
+    ICredentialIssuer &
     ICredentialValidation &
     ICredentialVerifier &
     IPresentationExchange &