@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth 0.34.1-feature.DIIPv4.144 → 0.34.1-feature.DIIPv4.152

package/dist/index.d.cts

@@ -41,8 +41,9 @@ interface ISiopv2RPOpts {
 interface IRPDefaultOpts extends IRPOptions {
 }
 interface ICreateAuthRequestArgs {
-    definitionId: string;
+    queryId: string;
     correlationId: string;
+    useQueryIdInstance?: boolean;
     responseURIType: ResponseURIType;
     responseURI: string;
     responseRedirectURI?: string;
@@ -54,29 +55,29 @@ interface ICreateAuthRequestArgs {
 }
 interface IGetAuthRequestStateArgs {
     correlationId: string;
-    definitionId: string;
+    queryId?: string;
     errorOnNotFound?: boolean;
 }
 interface IGetAuthResponseStateArgs {
     correlationId: string;
-    definitionId: string;
+    queryId?: string;
     errorOnNotFound?: boolean;
     progressRequestStateTo?: AuthorizationRequestStateStatus;
     includeVerifiedData?: VerifiedDataMode;
 }
 interface IUpdateRequestStateArgs {
-    definitionId: string;
+    queryId: string;
     correlationId: string;
     state: AuthorizationRequestStateStatus;
     error?: string;
 }
 interface IDeleteAuthStateArgs {
     correlationId: string;
-    definitionId: string;
+    queryId?: string;
 }
 interface IVerifyAuthResponseStateArgs {
     authorizationResponse: string | AuthorizationResponsePayload;
-    definitionId?: string;
+    queryId?: string;
     correlationId: string;
     audience?: string;
     dcqlQueryPayload?: DcqlQueryPayload;
@@ -86,14 +87,14 @@ interface IDefinitionPair {
     dcqlPayload?: DcqlQueryPayload;
 }
 interface ImportDefinitionsArgs {
-    definitions: Array<IDefinitionPair>;
+    queries: Array<IDefinitionPair>;
     tenantId?: string;
     version?: string;
     versionControlMode?: VersionControlMode;
 }
 interface IGetRedirectUriArgs {
     correlationId: string;
-    definitionId?: string;
+    queryId?: string;
     state?: string;
 }
 interface IAuthorizationRequestPayloads {
@@ -106,7 +107,7 @@ interface IPEXDefinitionPersistArgs extends IPEXInstanceOptions {
     ttl?: number;
 }
 interface ISiopRPInstanceArgs {
-    definitionId?: string;
+    queryId?: string;
     responseRedirectURI?: string;
 }
 interface IPEXInstanceOptions extends IPEXOptions {
@@ -127,7 +128,7 @@ interface IRPOptions {
 }
 interface IPEXOptions {
     presentationVerifyCallback?: PresentationVerificationCallback;
-    definitionId: string;
+    queryId: string;
     version?: string;
     tenantId?: string;
 }
@@ -171,8 +172,8 @@ declare class RPInstance {
     hasDefinition(): boolean;
     get definitionId(): string | undefined;
     getPresentationDefinition(context: IRequiredContext): Promise<IPresentationDefinition | undefined>;
-    createAuthorizationRequestURI(createArgs: Omit<ICreateAuthRequestArgs, 'definitionId'>, context: IRequiredContext): Promise<URI>;
-    createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'definitionId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
+    createAuthorizationRequestURI(createArgs: ICreateAuthRequestArgs, context: IRequiredContext): Promise<URI>;
+    createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'queryId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
 }
 
 declare class SIOPv2RP implements IAgentPlugin {
@@ -193,9 +194,9 @@ declare class SIOPv2RP implements IAgentPlugin {
     private siopVerifyAuthResponse;
     private siopImportDefinitions;
     private siopGetRedirectURI;
-    getRPInstance({ definitionId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
+    getRPInstance({ queryId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
     getRPOptions(context: IRequiredContext, opts: {
-        definitionId?: string;
+        queryId?: string;
         responseRedirectURI?: string;
     }): Promise<IRPOptions>;
     getInstanceOpts(definitionId?: string): IPEXInstanceOptions | undefined;

package/dist/index.d.ts

@@ -41,8 +41,9 @@ interface ISiopv2RPOpts {
 interface IRPDefaultOpts extends IRPOptions {
 }
 interface ICreateAuthRequestArgs {
-    definitionId: string;
+    queryId: string;
     correlationId: string;
+    useQueryIdInstance?: boolean;
     responseURIType: ResponseURIType;
     responseURI: string;
     responseRedirectURI?: string;
@@ -54,29 +55,29 @@ interface ICreateAuthRequestArgs {
 }
 interface IGetAuthRequestStateArgs {
     correlationId: string;
-    definitionId: string;
+    queryId?: string;
     errorOnNotFound?: boolean;
 }
 interface IGetAuthResponseStateArgs {
     correlationId: string;
-    definitionId: string;
+    queryId?: string;
     errorOnNotFound?: boolean;
     progressRequestStateTo?: AuthorizationRequestStateStatus;
     includeVerifiedData?: VerifiedDataMode;
 }
 interface IUpdateRequestStateArgs {
-    definitionId: string;
+    queryId: string;
     correlationId: string;
     state: AuthorizationRequestStateStatus;
     error?: string;
 }
 interface IDeleteAuthStateArgs {
     correlationId: string;
-    definitionId: string;
+    queryId?: string;
 }
 interface IVerifyAuthResponseStateArgs {
     authorizationResponse: string | AuthorizationResponsePayload;
-    definitionId?: string;
+    queryId?: string;
     correlationId: string;
     audience?: string;
     dcqlQueryPayload?: DcqlQueryPayload;
@@ -86,14 +87,14 @@ interface IDefinitionPair {
     dcqlPayload?: DcqlQueryPayload;
 }
 interface ImportDefinitionsArgs {
-    definitions: Array<IDefinitionPair>;
+    queries: Array<IDefinitionPair>;
     tenantId?: string;
     version?: string;
     versionControlMode?: VersionControlMode;
 }
 interface IGetRedirectUriArgs {
     correlationId: string;
-    definitionId?: string;
+    queryId?: string;
     state?: string;
 }
 interface IAuthorizationRequestPayloads {
@@ -106,7 +107,7 @@ interface IPEXDefinitionPersistArgs extends IPEXInstanceOptions {
     ttl?: number;
 }
 interface ISiopRPInstanceArgs {
-    definitionId?: string;
+    queryId?: string;
     responseRedirectURI?: string;
 }
 interface IPEXInstanceOptions extends IPEXOptions {
@@ -127,7 +128,7 @@ interface IRPOptions {
 }
 interface IPEXOptions {
     presentationVerifyCallback?: PresentationVerificationCallback;
-    definitionId: string;
+    queryId: string;
     version?: string;
     tenantId?: string;
 }
@@ -171,8 +172,8 @@ declare class RPInstance {
     hasDefinition(): boolean;
     get definitionId(): string | undefined;
     getPresentationDefinition(context: IRequiredContext): Promise<IPresentationDefinition | undefined>;
-    createAuthorizationRequestURI(createArgs: Omit<ICreateAuthRequestArgs, 'definitionId'>, context: IRequiredContext): Promise<URI>;
-    createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'definitionId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
+    createAuthorizationRequestURI(createArgs: ICreateAuthRequestArgs, context: IRequiredContext): Promise<URI>;
+    createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'queryId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
 }
 
 declare class SIOPv2RP implements IAgentPlugin {
@@ -193,9 +194,9 @@ declare class SIOPv2RP implements IAgentPlugin {
     private siopVerifyAuthResponse;
     private siopImportDefinitions;
     private siopGetRedirectURI;
-    getRPInstance({ definitionId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
+    getRPInstance({ queryId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
     getRPOptions(context: IRequiredContext, opts: {
-        definitionId?: string;
+        queryId?: string;
         responseRedirectURI?: string;
     }): Promise<IRPOptions>;
     getInstanceOpts(definitionId?: string): IPEXInstanceOptions | undefined;

package/dist/index.js

@@ -416,11 +416,11 @@ async function createRPBuilder(args) {
   const { identifierOpts } = rpOpts;
   let definition = args.definition;
   let dcqlQuery = args.dcql;
-  if (!definition && pexOpts && pexOpts.definitionId) {
+  if (!definition && pexOpts && pexOpts.queryId) {
     const presentationDefinitionItems = await context.agent.pdmGetDefinitions({
       filter: [
         {
-          definitionId: pexOpts.definitionId,
+          definitionId: pexOpts.queryId,
           version: pexOpts.version,
           tenantId: pexOpts.tenantId
         }
@@ -602,7 +602,7 @@ var RPInstance = class {
     return this.definitionId !== void 0;
   }
   get definitionId() {
-    return this.pexOptions?.definitionId;
+    return this.pexOptions?.queryId;
   }
   async getPresentationDefinition(context) {
     return this.definitionId ? await context.agent.pexStoreGetDefinition({
@@ -611,7 +611,7 @@ var RPInstance = class {
     }) : void 0;
   }
   async createAuthorizationRequestURI(createArgs, context) {
-    const { correlationId, claims, requestByReferenceURI, responseURI, responseURIType } = createArgs;
+    const { correlationId, queryId, claims, requestByReferenceURI, responseURI, responseURIType } = createArgs;
     const nonce = createArgs.nonce ?? uuidv4();
     const state = createArgs.state ?? correlationId;
     let jwtIssuer;
@@ -639,6 +639,7 @@ var RPInstance = class {
     return await this.get(context).then((rp) => rp.createAuthorizationRequestURI({
       version: getRequestVersion(this.rpOptions),
       correlationId,
+      queryId,
       nonce,
       state,
       claims,
@@ -724,30 +725,32 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   async createAuthorizationRequestURI(createArgs, context) {
     return await this.getRPInstance({
-      definitionId: createArgs.definitionId,
-      responseRedirectURI: createArgs.responseRedirectURI
+      responseRedirectURI: createArgs.responseRedirectURI,
+      ...createArgs.useQueryIdInstance === true && {
+        queryId: createArgs.queryId
+      }
     }, context).then((rp) => rp.createAuthorizationRequestURI(createArgs, context)).then((URI) => URI.encodedUri);
   }
   async createAuthorizationRequestPayloads(createArgs, context) {
     return await this.getRPInstance({
-      definitionId: createArgs.definitionId
+      queryId: createArgs.queryId
     }, context).then((rp) => rp.createAuthorizationRequest(createArgs, context)).then(async (request) => {
       const authRequest = {
         authorizationRequest: request.payload,
         requestObject: await request.requestObjectJwt(),
-        requestObjectDecoded: await request.requestObject?.getPayload()
+        requestObjectDecoded: request.requestObject?.getPayload()
       };
       return authRequest;
     });
   }
   async siopGetRequestState(args, context) {
     return await this.getRPInstance({
-      definitionId: args.definitionId
+      queryId: args.queryId
     }, context).then((rp) => rp.get(context).then((rp2) => rp2.sessionManager.getRequestStateByCorrelationId(args.correlationId, args.errorOnNotFound)));
   }
   async siopGetResponseState(args, context) {
     const rpInstance = await this.getRPInstance({
-      definitionId: args.definitionId
+      queryId: args.queryId
     }, context);
     const authorizationResponseState = await rpInstance.get(context).then((rp) => rp.sessionManager.getResponseStateByCorrelationId(args.correlationId, args.errorOnNotFound));
     if (authorizationResponseState === void 0) {
@@ -800,11 +803,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 !== "sent") {
-      throw Error(`Only 'sent' status is supported for this method at this point`);
+    if (args.state !== "authorization_request_created") {
+      throw Error(`Only 'authorization_request_created' status is supported for this method at this point`);
     }
     return await this.getRPInstance({
-      definitionId: args.definitionId
+      queryId: args.queryId
     }, context).then((rp) => rp.get(context).then(async (rp2) => {
       await rp2.signalAuthRequestRetrieved({
         correlationId: args.correlationId,
@@ -815,7 +818,7 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   async siopDeleteState(args, context) {
     return await this.getRPInstance({
-      definitionId: args.definitionId
+      queryId: args.queryId
     }, context).then((rp) => rp.get(context).then((rp2) => rp2.sessionManager.deleteStateForCorrelationId(args.correlationId))).then(() => true);
   }
   async siopVerifyAuthResponse(args, context) {
@@ -824,7 +827,7 @@ var SIOPv2RP = class _SIOPv2RP {
     }
     const authResponse = typeof args.authorizationResponse === "string" ? decodeUriAsJson(args.authorizationResponse) : args.authorizationResponse;
     return await this.getRPInstance({
-      definitionId: args.definitionId
+      queryId: args.queryId
     }, context).then((rp) => rp.get(context).then((rp2) => rp2.verifyAuthorizationResponse(authResponse, {
       correlationId: args.correlationId,
       ...args.dcqlQueryPayload ? {
@@ -834,8 +837,8 @@ var SIOPv2RP = class _SIOPv2RP {
     })));
   }
   async siopImportDefinitions(args, context) {
-    const { definitions, tenantId, version, versionControlMode } = args;
-    await Promise.all(definitions.map(async (definitionPair) => {
+    const { queries, tenantId, version, versionControlMode } = args;
+    await Promise.all(queries.map(async (definitionPair) => {
       const definitionPayload = definitionPair.definitionPayload;
       if (!definitionPayload && !definitionPair.dcqlPayload) {
         return Promise.reject(Error("Either dcqlPayload or definitionPayload must be suppplied"));
@@ -868,7 +871,7 @@ var SIOPv2RP = class _SIOPv2RP {
     }));
   }
   async siopGetRedirectURI(args, context) {
-    const instanceId = args.definitionId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
+    const instanceId = args.queryId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
     if (this.instances.has(instanceId)) {
       const rpInstance = this.instances.get(instanceId);
       if (rpInstance !== void 0) {
@@ -884,12 +887,12 @@ var SIOPv2RP = class _SIOPv2RP {
     }
     return void 0;
   }
-  async getRPInstance({ definitionId, responseRedirectURI }, context) {
-    const instanceId = definitionId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
+  async getRPInstance({ queryId, responseRedirectURI }, context) {
+    const instanceId = queryId ?? _SIOPv2RP._DEFAULT_OPTS_KEY;
     if (!this.instances.has(instanceId)) {
-      const instanceOpts = this.getInstanceOpts(definitionId);
+      const instanceOpts = this.getInstanceOpts(queryId);
       const rpOpts = await this.getRPOptions(context, {
-        definitionId,
+        queryId,
         responseRedirectURI
       });
       if (!rpOpts.identifierOpts.resolveOpts?.resolver || typeof rpOpts.identifierOpts.resolveOpts.resolver.resolve !== "function") {
@@ -901,7 +904,7 @@ var SIOPv2RP = class _SIOPv2RP {
             ...rpOpts.identifierOpts.resolveOpts
           };
         }
-        console.log("Using agent DID resolver for RP instance with definition id " + definitionId);
+        console.log("Using agent DID resolver for RP instance with definition id " + queryId);
         rpOpts.identifierOpts.resolveOpts.resolver = getAgentResolver2(context, {
           uniresolverResolution: true,
           localResolution: true,
@@ -920,10 +923,10 @@ var SIOPv2RP = class _SIOPv2RP {
     return rpInstance;
   }
   async getRPOptions(context, opts) {
-    const { definitionId, responseRedirectURI } = opts;
-    const options = this.getInstanceOpts(definitionId)?.rpOpts ?? this.opts.defaultOpts;
+    const { queryId, responseRedirectURI } = opts;
+    const options = this.getInstanceOpts(queryId)?.rpOpts ?? this.opts.defaultOpts;
     if (!options) {
-      throw Error(`Could not get specific nor default options for definition ${definitionId}`);
+      throw Error(`Could not get specific nor default options for definition ${queryId}`);
     }
     if (this.opts.defaultOpts) {
       if (!options.identifierOpts) {
@@ -957,18 +960,18 @@ var SIOPv2RP = class _SIOPv2RP {
   }
   getInstanceOpts(definitionId) {
     if (!this.opts.instanceOpts) return void 0;
-    const instanceOpt = definitionId ? this.opts.instanceOpts.find((i) => i.definitionId === definitionId) : void 0;
+    const instanceOpt = definitionId ? this.opts.instanceOpts.find((i) => i.queryId === 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.definitionId === "default");
+    const defaultOptions = this.opts.instanceOpts.find((i) => i.queryId === "default");
     if (defaultOptions) {
       const clonedOptions = {
         ...defaultOptions
       };
       if (definitionId !== void 0) {
-        clonedOptions.definitionId = definitionId;
+        clonedOptions.queryId = definitionId;
       }
       return clonedOptions;
     }