@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth 0.34.1-feature.SSISDK.46.40 → 0.34.1-feature.SSISDK.50.98

package/dist/index.d.ts

@@ -1,22 +1,22 @@
 import { IPluginMethodMap, IAgentContext, IResolver, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, IAgentPlugin } from '@veramo/core';
-import { ResponseURIType, ClaimPayloadCommonOpts, AuthorizationRequestPayload, RequestObjectPayload, AuthorizationRequestState, AuthorizationResponseState, AuthorizationResponsePayload, PresentationDefinitionWithLocation, VerifiedAuthorizationResponse, ResponseMode, SupportedVersion, IRPSessionManager, ClientMetadataOpts, VerifyJwtCallback, PresentationVerificationCallback, VPTokenLocation, VerifiablePresentationTypeFormat, RP, URI, AuthorizationRequest } from '@sphereon/did-auth-siop';
-import { IIdentifierResolution, ManagedIdentifierOptsOrResult, ExternalIdentifierOIDFEntityIdOpts } from '@sphereon/ssi-sdk-ext.identifier-resolution';
-import { AdditionalClaims, DcqlQueryREST, HasherSync, W3CVerifiablePresentation } from '@sphereon/ssi-types';
-import { Resolvable } from 'did-resolver';
+import { ResponseURIType, ClaimPayloadCommonOpts, AuthorizationRequestPayload, RequestObjectPayload, AuthorizationRequestState, AuthorizationResponseState, AuthorizationResponsePayload, VerifiedAuthorizationResponse, ResponseMode, SupportedVersion, IRPSessionManager, ClientMetadataOpts, VerifyJwtCallback, PresentationVerificationCallback, RP, URI, AuthorizationRequest } from '@sphereon/did-auth-siop';
+import { CheckLinkedDomain } from '@sphereon/did-auth-siop-adapter';
 import { DIDDocument } from '@sphereon/did-uni-client';
-import { EventEmitter } from 'events';
+import { JwtIssuer } from '@sphereon/oid4vc-common';
 import { IPresentationDefinition } from '@sphereon/pex';
 import { IDIDOptions } from '@sphereon/ssi-sdk-ext.did-utils';
-import { IPresentationExchange } from '@sphereon/ssi-sdk.presentation-exchange';
-import { VerifyCallback } from '@sphereon/wellknown-dids-client';
-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 { IIdentifierResolution, ManagedIdentifierOptsOrResult, ExternalIdentifierOIDFEntityIdOpts } from '@sphereon/ssi-sdk-ext.identifier-resolution';
 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';
+import { ImDLMdoc } from '@sphereon/ssi-sdk.mdl-mdoc';
+import { 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 { AdditionalClaims, DcqlQueryPayload, HasherSync } from '@sphereon/ssi-types';
+import { VerifyCallback } from '@sphereon/wellknown-dids-client';
+import { Resolvable } from 'did-resolver';
+import { EventEmitter } from 'events';
 
 declare enum VerifiedDataMode {
     NONE = "none",
@@ -41,9 +41,8 @@ interface ISiopv2RPOpts {
 interface IRPDefaultOpts extends IRPOptions {
 }
 interface ICreateAuthRequestArgs {
-    queryId: string;
+    definitionId: string;
     correlationId: string;
-    useQueryIdInstance?: boolean;
     responseURIType: ResponseURIType;
     responseURI: string;
     responseRedirectURI?: string;
@@ -55,47 +54,46 @@ interface ICreateAuthRequestArgs {
 }
 interface IGetAuthRequestStateArgs {
     correlationId: string;
-    queryId?: string;
+    definitionId: string;
     errorOnNotFound?: boolean;
 }
 interface IGetAuthResponseStateArgs {
     correlationId: string;
-    queryId?: string;
+    definitionId: string;
     errorOnNotFound?: boolean;
     progressRequestStateTo?: AuthorizationRequestStateStatus;
     includeVerifiedData?: VerifiedDataMode;
 }
 interface IUpdateRequestStateArgs {
-    queryId: string;
+    definitionId: string;
     correlationId: string;
     state: AuthorizationRequestStateStatus;
     error?: string;
 }
 interface IDeleteAuthStateArgs {
     correlationId: string;
-    queryId?: string;
+    definitionId: string;
 }
 interface IVerifyAuthResponseStateArgs {
     authorizationResponse: string | AuthorizationResponsePayload;
-    queryId?: string;
+    definitionId?: string;
     correlationId: string;
     audience?: string;
-    presentationDefinitions?: PresentationDefinitionWithLocation | PresentationDefinitionWithLocation[];
-    dcqlQuery?: DcqlQueryREST;
+    dcqlQueryPayload?: DcqlQueryPayload;
 }
 interface IDefinitionPair {
-    definitionPayload: IPresentationDefinition;
-    dcqlPayload?: DcqlQueryREST;
+    definitionPayload?: IPresentationDefinition;
+    dcqlPayload?: DcqlQueryPayload;
 }
 interface ImportDefinitionsArgs {
-    queries: Array<IDefinitionPair>;
+    definitions: Array<IDefinitionPair>;
     tenantId?: string;
     version?: string;
     versionControlMode?: VersionControlMode;
 }
 interface IGetRedirectUriArgs {
     correlationId: string;
-    queryId?: string;
+    definitionId?: string;
     state?: string;
 }
 interface IAuthorizationRequestPayloads {
@@ -108,7 +106,7 @@ interface IPEXDefinitionPersistArgs extends IPEXInstanceOptions {
     ttl?: number;
 }
 interface ISiopRPInstanceArgs {
-    queryId?: string;
+    definitionId?: string;
     responseRedirectURI?: string;
 }
 interface IPEXInstanceOptions extends IPEXOptions {
@@ -129,7 +127,7 @@ interface IRPOptions {
 }
 interface IPEXOptions {
     presentationVerifyCallback?: PresentationVerificationCallback;
-    queryId: string;
+    definitionId: string;
     version?: string;
     tenantId?: string;
 }
@@ -143,15 +141,8 @@ interface PerDidResolver {
 interface IAuthRequestDetails {
     rpDIDDocument?: DIDDocument;
     id: string;
-    verifiablePresentationMatches: IPresentationWithDefinition[];
     alsoKnownAs?: string[];
 }
-interface IPresentationWithDefinition {
-    location: VPTokenLocation;
-    definition: PresentationDefinitionWithLocation;
-    format: VerifiablePresentationTypeFormat;
-    presentation: W3CVerifiablePresentation;
-}
 interface ISIOPIdentifierOptions extends Omit<IDIDOptions, 'idOpts'> {
     idOpts: ManagedIdentifierOptsOrResult;
     oidfOpts?: ExternalIdentifierOIDFEntityIdOpts;
@@ -180,8 +171,8 @@ declare class RPInstance {
     hasDefinition(): boolean;
     get definitionId(): string | undefined;
     getPresentationDefinition(context: IRequiredContext): Promise<IPresentationDefinition | undefined>;
-    createAuthorizationRequestURI(createArgs: Omit<ICreateAuthRequestArgs, 'queryId'>, context: IRequiredContext): Promise<URI>;
-    createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'queryId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
+    createAuthorizationRequestURI(createArgs: Omit<ICreateAuthRequestArgs, 'definitionId'>, context: IRequiredContext): Promise<URI>;
+    createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'definitionId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
 }
 
 declare class SIOPv2RP implements IAgentPlugin {
@@ -202,9 +193,9 @@ declare class SIOPv2RP implements IAgentPlugin {
     private siopVerifyAuthResponse;
     private siopImportDefinitions;
     private siopGetRedirectURI;
-    getRPInstance({ queryId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
+    getRPInstance({ definitionId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
     getRPOptions(context: IRequiredContext, opts: {
-        queryId?: string;
+        definitionId?: string;
         responseRedirectURI?: string;
     }): Promise<IRPOptions>;
     getInstanceOpts(definitionId?: string): IPEXInstanceOptions | undefined;
@@ -216,4 +207,4 @@ declare class SIOPv2RP implements IAgentPlugin {
  */
 declare const schema: any;
 
-export { type AuthorizationResponseStateWithVerifiedData, type CredentialOpts, type IAuthRequestDetails, type IAuthorizationRequestPayloads, type ICreateAuthRequestArgs, type IDefinitionPair, type IDeleteAuthStateArgs, type IGetAuthRequestStateArgs, type IGetAuthResponseStateArgs, type IGetRedirectUriArgs, type IPEXDefinitionPersistArgs, type IPEXInstanceOptions, type IPEXOptions, type IPresentationWithDefinition, type IRPDefaultOpts, type IRPOptions, type IRequiredContext, type ISIOPIdentifierOptions, type ISIOPv2RP, type ISiopRPInstanceArgs, type ISiopv2RPOpts, type IUpdateRequestStateArgs, type IVerifyAuthResponseStateArgs, type ImportDefinitionsArgs, type PerDidResolver, SIOPv2RP, type VerificationPolicies, VerifiedDataMode, schema };
+export { type AuthorizationResponseStateWithVerifiedData, type CredentialOpts, type IAuthRequestDetails, type IAuthorizationRequestPayloads, type ICreateAuthRequestArgs, type IDefinitionPair, type IDeleteAuthStateArgs, type IGetAuthRequestStateArgs, type IGetAuthResponseStateArgs, type IGetRedirectUriArgs, type IPEXDefinitionPersistArgs, type IPEXInstanceOptions, type IPEXOptions, type IRPDefaultOpts, type IRPOptions, type IRequiredContext, type ISIOPIdentifierOptions, type ISIOPv2RP, type ISiopRPInstanceArgs, type ISiopv2RPOpts, type IUpdateRequestStateArgs, type IVerifyAuthResponseStateArgs, type ImportDefinitionsArgs, type PerDidResolver, SIOPv2RP, type VerificationPolicies, VerifiedDataMode, schema };

package/dist/index.js

@@ -344,6 +344,7 @@ var require_plugin_schema = __commonJS({
 import { AuthorizationResponseStateStatus, decodeUriAsJson } from "@sphereon/did-auth-siop";
 import { getAgentResolver as getAgentResolver2 } from "@sphereon/ssi-sdk-ext.did-utils";
 import { CredentialMapper as CredentialMapper2 } from "@sphereon/ssi-types";
+import { DcqlQuery } from "dcql";
 
 // src/functions.ts
 import { InMemoryRPSessionManager, PassBy, PropertyTarget, ResponseMode, ResponseType, RevocationVerification, RP, Scope, SubjectType, SupportedVersion } from "@sphereon/did-auth-siop";
@@ -416,11 +417,11 @@ async function createRPBuilder(args) {
   const { identifierOpts } = rpOpts;
   let definition = args.definition;
   let dcqlQuery = args.dcql;
-  if (!definition && pexOpts && pexOpts.queryId) {
+  if (!definition && pexOpts && pexOpts.definitionId) {
     const presentationDefinitionItems = await context.agent.pdmGetDefinitions({
       filter: [
         {
-          definitionId: pexOpts.queryId,
+          definitionId: pexOpts.definitionId,
           version: pexOpts.version,
           tenantId: pexOpts.tenantId
         }
@@ -608,7 +609,7 @@ var RPInstance = class {
     return this.definitionId !== void 0;
   }
   get definitionId() {
-    return this.pexOptions?.queryId;
+    return this.pexOptions?.definitionId;
   }
   async getPresentationDefinition(context) {
     return this.definitionId ? await context.agent.pexStoreGetDefinition({
@@ -730,32 +731,30 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   async createAuthorizationRequestURI(createArgs, context) {
     return await this.getRPInstance({
-      responseRedirectURI: createArgs.responseRedirectURI,
-      ...createArgs.useQueryIdInstance === true && {
-        queryId: createArgs.queryId
-      }
+      definitionId: createArgs.definitionId,
+      responseRedirectURI: createArgs.responseRedirectURI
     }, context).then((rp) => rp.createAuthorizationRequestURI(createArgs, context)).then((URI) => URI.encodedUri);
   }
   async createAuthorizationRequestPayloads(createArgs, context) {
     return await this.getRPInstance({
-      queryId: createArgs.queryId
+      definitionId: createArgs.definitionId
     }, context).then((rp) => rp.createAuthorizationRequest(createArgs, context)).then(async (request) => {
       const authRequest = {
         authorizationRequest: request.payload,
         requestObject: await request.requestObjectJwt(),
-        requestObjectDecoded: request.requestObject?.getPayload()
+        requestObjectDecoded: await request.requestObject?.getPayload()
       };
       return authRequest;
     });
   }
   async siopGetRequestState(args, context) {
     return await this.getRPInstance({
-      queryId: args.queryId
+      definitionId: args.definitionId
     }, context).then((rp) => rp.get(context).then((rp2) => rp2.sessionManager.getRequestStateByCorrelationId(args.correlationId, args.errorOnNotFound)));
   }
   async siopGetResponseState(args, context) {
     const rpInstance = await this.getRPInstance({
-      queryId: args.queryId
+      definitionId: args.definitionId
     }, context);
     const authorizationResponseState = await rpInstance.get(context).then((rp) => rp.sessionManager.getResponseStateByCorrelationId(args.correlationId, args.errorOnNotFound));
     if (authorizationResponseState === void 0) {
@@ -808,11 +807,11 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   presentationOrClaimsFrom = /* @__PURE__ */ __name((presentationDecoded) => CredentialMapper2.isSdJwtDecodedCredential(presentationDecoded) ? presentationDecoded.decodedPayload : CredentialMapper2.toUniformPresentation(presentationDecoded), "presentationOrClaimsFrom");
   async siopUpdateRequestState(args, context) {
-    if (args.state !== "authorization_request_created") {
-      throw Error(`Only 'authorization_request_created' status is supported for this method at this point`);
+    if (args.state !== "sent") {
+      throw Error(`Only 'sent' status is supported for this method at this point`);
     }
     return await this.getRPInstance({
-      queryId: args.queryId
+      definitionId: args.definitionId
     }, context).then((rp) => rp.get(context).then(async (rp2) => {
       await rp2.signalAuthRequestRetrieved({
         correlationId: args.correlationId,
@@ -823,7 +822,7 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   async siopDeleteState(args, context) {
     return await this.getRPInstance({
-      queryId: args.queryId
+      definitionId: args.definitionId
     }, context).then((rp) => rp.get(context).then((rp2) => rp2.sessionManager.deleteStateForCorrelationId(args.correlationId))).then(() => true);
   }
   async siopVerifyAuthResponse(args, context) {
@@ -832,28 +831,38 @@ var SIOPv2RP = class _SIOPv2RP {
     }
     const authResponse = typeof args.authorizationResponse === "string" ? decodeUriAsJson(args.authorizationResponse) : args.authorizationResponse;
     return await this.getRPInstance({
-      queryId: args.queryId
+      definitionId: args.definitionId
     }, context).then((rp) => rp.get(context).then((rp2) => rp2.verifyAuthorizationResponse(authResponse, {
       correlationId: args.correlationId,
-      ...args.presentationDefinitions && !args.dcqlQuery ? {
-        presentationDefinitions: args.presentationDefinitions
-      } : {},
-      ...args.dcqlQuery ? {
-        dcqlQuery: args.dcqlQuery
+      ...args.dcqlQueryPayload ? {
+        dcqlQuery: args.dcqlQueryPayload.dcqlQuery
       } : {},
       audience: args.audience
     })));
   }
   async siopImportDefinitions(args, context) {
-    const { queries, tenantId, version, versionControlMode } = args;
-    await Promise.all(queries.map(async (definitionPair) => {
+    const { definitions, tenantId, version, versionControlMode } = args;
+    await Promise.all(definitions.map(async (definitionPair) => {
       const definitionPayload = definitionPair.definitionPayload;
-      await context.agent.pexValidateDefinition({
-        definition: definitionPayload
-      });
-      console.log(`persisting definition ${definitionPayload.id} / ${definitionPayload.name} with versionControlMode ${versionControlMode}`);
+      if (!definitionPayload && !definitionPair.dcqlPayload) {
+        return Promise.reject(Error("Either dcqlPayload or definitionPayload must be suppplied"));
+      }
+      let definitionId;
+      if (definitionPair.dcqlPayload) {
+        DcqlQuery.validate(definitionPair.dcqlPayload.dcqlQuery);
+        console.log(`persisting DCQL definition ${definitionPair.dcqlPayload.queryId} with versionControlMode ${versionControlMode}`);
+        definitionId = definitionPair.dcqlPayload.queryId;
+      }
+      if (definitionPayload) {
+        await context.agent.pexValidateDefinition({
+          definition: definitionPayload
+        });
+        console.log(`persisting PEX definition ${definitionPayload.id} / ${definitionPayload.name} with versionControlMode ${versionControlMode}`);
+        definitionId = definitionPayload.id;
+      }
       return context.agent.pdmPersistDefinition({
         definitionItem: {
+          definitionId,
           tenantId,
           version,
           definitionPayload,
@@ -866,7 +875,7 @@ var SIOPv2RP = class _SIOPv2RP {
     }));
   }
   async siopGetRedirectURI(args, context) {
-    const instanceId = args.queryId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
+    const instanceId = args.definitionId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
     if (this.instances.has(instanceId)) {
       const rpInstance = this.instances.get(instanceId);
       if (rpInstance !== void 0) {
@@ -882,12 +891,12 @@ var SIOPv2RP = class _SIOPv2RP {
     }
     return void 0;
   }
-  async getRPInstance({ queryId, responseRedirectURI }, context) {
-    const instanceId = queryId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
+  async getRPInstance({ definitionId, responseRedirectURI }, context) {
+    const instanceId = definitionId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
     if (!this.instances.has(instanceId)) {
-      const instanceOpts = this.getInstanceOpts(queryId);
+      const instanceOpts = this.getInstanceOpts(definitionId);
       const rpOpts = await this.getRPOptions(context, {
-        queryId,
+        definitionId,
         responseRedirectURI
       });
       if (!rpOpts.identifierOpts.resolveOpts?.resolver || typeof rpOpts.identifierOpts.resolveOpts.resolver.resolve !== "function") {
@@ -899,7 +908,7 @@ var SIOPv2RP = class _SIOPv2RP {
             ...rpOpts.identifierOpts.resolveOpts
           };
         }
-        console.log("Using agent DID resolver for RP instance with definition id " + queryId);
+        console.log("Using agent DID resolver for RP instance with definition id " + definitionId);
         rpOpts.identifierOpts.resolveOpts.resolver = getAgentResolver2(context, {
           uniresolverResolution: true,
           localResolution: true,
@@ -918,10 +927,10 @@ var SIOPv2RP = class _SIOPv2RP {
     return rpInstance;
   }
   async getRPOptions(context, opts) {
-    const { queryId, responseRedirectURI } = opts;
-    const options = this.getInstanceOpts(queryId)?.rpOpts ?? this.opts.defaultOpts;
+    const { definitionId, responseRedirectURI } = opts;
+    const options = this.getInstanceOpts(definitionId)?.rpOpts ?? this.opts.defaultOpts;
     if (!options) {
-      throw Error(`Could not get specific nor default options for definition ${queryId}`);
+      throw Error(`Could not get specific nor default options for definition ${definitionId}`);
     }
     if (this.opts.defaultOpts) {
       if (!options.identifierOpts) {
@@ -955,18 +964,18 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   getInstanceOpts(definitionId) {
     if (!this.opts.instanceOpts) return void 0;
-    const instanceOpt = definitionId ? this.opts.instanceOpts.find((i) => i.queryId === definitionId) : void 0;
+    const instanceOpt = definitionId ? this.opts.instanceOpts.find((i) => i.definitionId === definitionId) : void 0;
     return instanceOpt ?? this.getDefaultOptions(definitionId);
   }
   getDefaultOptions(definitionId) {
     if (!this.opts.instanceOpts) return void 0;
-    const defaultOptions = this.opts.instanceOpts.find((i) => i.queryId === "default");
+    const defaultOptions = this.opts.instanceOpts.find((i) => i.definitionId === "default");
     if (defaultOptions) {
       const clonedOptions = {
         ...defaultOptions
       };
       if (definitionId !== void 0) {
-        clonedOptions.queryId = definitionId;
+        clonedOptions.definitionId = definitionId;
       }
       return clonedOptions;
     }
@@ -975,12 +984,12 @@ var SIOPv2RP = class _SIOPv2RP {
 };
 
 // src/types/ISIOPv2RP.ts
-var VerifiedDataMode = /* @__PURE__ */ (function(VerifiedDataMode2) {
+var VerifiedDataMode = /* @__PURE__ */ function(VerifiedDataMode2) {
   VerifiedDataMode2["NONE"] = "none";
   VerifiedDataMode2["VERIFIED_PRESENTATION"] = "vp";
   VerifiedDataMode2["CREDENTIAL_SUBJECT_FLATTENED"] = "cs-flat";
   return VerifiedDataMode2;
-})({});
+}({});
 
 // src/index.ts
 var schema = require_plugin_schema();