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

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { IPluginMethodMap, IAgentContext, IResolver, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, IAgentPlugin } from '@veramo/core';
-import { ResponseURIType, ClaimPayloadCommonOpts, AuthorizationRequestPayload, RequestObjectPayload, AuthorizationRequestState, AuthorizationResponseState, AuthorizationResponsePayload, VerifiedAuthorizationResponse, ResponseMode, SupportedVersion, IRPSessionManager, ClientMetadataOpts, VerifyJwtCallback, PresentationVerificationCallback, RP, URI, AuthorizationRequest } from '@sphereon/did-auth-siop';
+import { ResponseURIType, ClaimPayloadCommonOpts, CallbackOpts, AuthorizationRequestPayload, RequestObjectPayload, AuthorizationRequestState, AuthorizationResponseStateWithVerifiedData, 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 { JwtIssuer } from '@sphereon/oid4vc-common';
@@ -13,11 +13,382 @@ 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 { DcqlQueryPayload, HasherSync } from '@sphereon/ssi-types';
 import { VerifyCallback } from '@sphereon/wellknown-dids-client';
 import { Resolvable } from 'did-resolver';
 import { EventEmitter } from 'events';
 
+var IDidAuthSiopOpAuthenticator = {
+	components: {
+		schemas: {
+			IGetSiopSessionArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSessionForSiop } "
+			},
+			IRegisterSiopSessionArgs: {
+				type: "object",
+				properties: {
+					identifier: {
+						type: "object",
+						properties: {
+							did: {
+								type: "string"
+							},
+							alias: {
+								type: "string"
+							},
+							provider: {
+								type: "string"
+							},
+							controllerKeyId: {
+								type: "string"
+							},
+							keys: {
+								type: "array",
+								items: {
+									type: "object",
+									properties: {
+										additionalProperties: true
+									}
+								}
+							},
+							services: {
+								type: "array",
+								items: {
+									type: "object",
+									properties: {
+										additionalProperties: true
+									}
+								}
+							}
+						},
+						additionalProperties: false,
+						required: [
+							"did",
+							"provider",
+							"keys",
+							"services"
+						]
+					},
+					sessionId: {
+						type: "string"
+					},
+					expiresIn: {
+						type: "number"
+					},
+					additionalProperties: false
+				},
+				required: [
+					"identifier"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.registerSessionForSiop } "
+			},
+			IRemoveSiopSessionArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.removeSessionForSiop } "
+			},
+			IAuthenticateWithSiopArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					stateId: {
+						type: "string"
+					},
+					redirectUrl: {
+						type: "string"
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId",
+					"stateId",
+					"redirectUrl"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.authenticateWithSiop } "
+			},
+			IResponse: {
+				type: "object",
+				properties: {
+					status: {
+						type: "number"
+					},
+					additionalProperties: true
+				},
+				required: [
+					"status"
+				],
+				description: "Result of {@link DidAuthSiopOpAuthenticator.authenticateWithSiop & DidAuthSiopOpAuthenticator.sendSiopAuthenticationResponse } "
+			},
+			IGetSiopAuthenticationRequestFromRpArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					stateId: {
+						type: "string"
+					},
+					redirectUrl: {
+						type: "string"
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId",
+					"stateId",
+					"redirectUrl"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestFromRP } "
+			},
+			ParsedAuthenticationRequestURI: {
+				type: "object",
+				properties: {
+					jwt: {
+						type: "string"
+					},
+					requestPayload: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					registration: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					additionalProperties: false
+				},
+				required: [
+					"jwt",
+					"requestPayload",
+					"registration"
+				],
+				description: "Result of {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestFromRP } "
+			},
+			IGetSiopAuthenticationRequestDetailsArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					verifiedAuthenticationRequest: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					credentialFilter: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId",
+					"verifiedAuthenticationRequest"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestDetails } "
+			},
+			IAuthRequestDetails: {
+				type: "object",
+				properties: {
+					id: {
+						type: "string"
+					},
+					alsoKnownAs: {
+						type: "array",
+						items: {
+							type: "string"
+						}
+					},
+					vpResponseOpts: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					additionalProperties: false
+				},
+				required: [
+					"id",
+					"vpResponseOpts"
+				],
+				description: "Result of {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestDetails } "
+			},
+			IVerifySiopAuthenticationRequestUriArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					ParsedAuthenticationRequestURI: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId",
+					"ParsedAuthenticationRequestURI"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.verifySiopAuthenticationRequestURI } "
+			},
+			VerifiedAuthorizationRequest: {
+				type: "object",
+				properties: {
+					payload: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					presentationDefinitions: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					verifyOpts: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					additionalProperties: false
+				},
+				required: [
+					"payload",
+					"verifyOpts"
+				],
+				description: "Result of {@link DidAuthSiopOpAuthenticator.verifySiopAuthenticationRequestURI } "
+			},
+			ISendSiopAuthenticationResponseArgs: {
+				type: "object",
+				properties: {
+					sessionId: {
+						type: "string"
+					},
+					verifiedAuthenticationRequest: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					verifiablePresentationResponse: {
+						type: "object",
+						properties: {
+							additionalProperties: true
+						}
+					},
+					additionalProperties: false
+				},
+				required: [
+					"sessionId",
+					"verifiedAuthenticationRequest"
+				],
+				description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.sendSiopAuthenticationResponse } "
+			}
+		},
+		methods: {
+			getSessionForSiop: {
+				description: "Get SIOP session",
+				"arguments": {
+					$ref: "#/components/schemas/IGetSiopSessionArgs"
+				},
+				returnType: "object"
+			},
+			registerSessionForSiop: {
+				description: "Register SIOP session",
+				"arguments": {
+					$ref: "#/components/schemas/IRegisterSiopSessionArgs"
+				},
+				returnType: "object"
+			},
+			removeSessionForSiop: {
+				description: "Remove SIOP session",
+				"arguments": {
+					$ref: "#/components/schemas/IRemoveSiopSessionArgs"
+				},
+				returnType: "boolean"
+			},
+			authenticateWithSiop: {
+				description: "Authenticate using DID Auth SIOP",
+				"arguments": {
+					$ref: "#/components/schemas/IAuthenticateWithSiopArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/Response"
+				}
+			},
+			getSiopAuthenticationRequestFromRP: {
+				description: "Get authentication request from RP",
+				"arguments": {
+					$ref: "#/components/schemas/IGetSiopAuthenticationRequestFromRpArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/ParsedAuthenticationRequestURI"
+				}
+			},
+			getSiopAuthenticationRequestDetails: {
+				description: "Get authentication request details",
+				"arguments": {
+					$ref: "#/components/schemas/IGetSiopAuthenticationRequestDetailsArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/IAuthRequestDetails"
+				}
+			},
+			verifySiopAuthenticationRequestURI: {
+				description: "Verify authentication request URI",
+				"arguments": {
+					$ref: "#/components/schemas/IVerifySiopAuthenticationRequestUriArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/VerifiedAuthorizationRequest"
+				}
+			},
+			sendSiopAuthenticationResponse: {
+				description: "Send authentication response",
+				"arguments": {
+					$ref: "#/components/schemas/ISendSiopAuthenticationResponseArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/IRequiredContext"
+				}
+			}
+		}
+	}
+};
+var plugin_schema = {
+	IDidAuthSiopOpAuthenticator: IDidAuthSiopOpAuthenticator
+};
+
 declare enum VerifiedDataMode {
     NONE = "none",
     VERIFIED_PRESENTATION = "vp",
@@ -52,6 +423,7 @@ interface ICreateAuthRequestArgs {
     nonce?: string;
     state?: string;
     claims?: ClaimPayloadCommonOpts;
+    callback?: CallbackOpts;
 }
 interface IGetAuthRequestStateArgs {
     correlationId: string;
@@ -153,9 +525,6 @@ interface ISIOPIdentifierOptions extends Omit<IDIDOptions, 'idOpts'> {
 type CredentialOpts = {
     hasher?: HasherSync;
 };
-interface AuthorizationResponseStateWithVerifiedData extends AuthorizationResponseState {
-    verifiedData?: AdditionalClaims;
-}
 type IRequiredContext = IAgentContext<IResolver & IDIDManager & IKeyManager & IIdentifierResolution & ICredentialIssuer & ICredentialValidation & ICredentialVerifier & IPresentationExchange & IPDManager & ISDJwtPlugin & IJwtService & ImDLMdoc>;
 
 declare class RPInstance {
@@ -180,7 +549,333 @@ declare class SIOPv2RP implements IAgentPlugin {
     private readonly opts;
     private static readonly _DEFAULT_OPTS_KEY;
     private readonly instances;
-    readonly schema: any;
+    readonly schema: {
+        components: {
+            schemas: {
+                IGetSiopSessionArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IRegisterSiopSessionArgs: {
+                    type: string;
+                    properties: {
+                        identifier: {
+                            type: string;
+                            properties: {
+                                did: {
+                                    type: string;
+                                };
+                                alias: {
+                                    type: string;
+                                };
+                                provider: {
+                                    type: string;
+                                };
+                                controllerKeyId: {
+                                    type: string;
+                                };
+                                keys: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                        properties: {
+                                            additionalProperties: boolean;
+                                        };
+                                    };
+                                };
+                                services: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                        properties: {
+                                            additionalProperties: boolean;
+                                        };
+                                    };
+                                };
+                            };
+                            additionalProperties: boolean;
+                            required: string[];
+                        };
+                        sessionId: {
+                            type: string;
+                        };
+                        expiresIn: {
+                            type: string;
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IRemoveSiopSessionArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IAuthenticateWithSiopArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        stateId: {
+                            type: string;
+                        };
+                        redirectUrl: {
+                            type: string;
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IResponse: {
+                    type: string;
+                    properties: {
+                        status: {
+                            type: string;
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IGetSiopAuthenticationRequestFromRpArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        stateId: {
+                            type: string;
+                        };
+                        redirectUrl: {
+                            type: string;
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                ParsedAuthenticationRequestURI: {
+                    type: string;
+                    properties: {
+                        jwt: {
+                            type: string;
+                        };
+                        requestPayload: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        registration: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IGetSiopAuthenticationRequestDetailsArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        verifiedAuthenticationRequest: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        credentialFilter: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IAuthRequestDetails: {
+                    type: string;
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        alsoKnownAs: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                        vpResponseOpts: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                IVerifySiopAuthenticationRequestUriArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        ParsedAuthenticationRequestURI: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                VerifiedAuthorizationRequest: {
+                    type: string;
+                    properties: {
+                        payload: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        presentationDefinitions: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        verifyOpts: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+                ISendSiopAuthenticationResponseArgs: {
+                    type: string;
+                    properties: {
+                        sessionId: {
+                            type: string;
+                        };
+                        verifiedAuthenticationRequest: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        verifiablePresentationResponse: {
+                            type: string;
+                            properties: {
+                                additionalProperties: boolean;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    required: string[];
+                    description: string;
+                };
+            };
+            methods: {
+                getSessionForSiop: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: string;
+                };
+                registerSessionForSiop: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: string;
+                };
+                removeSessionForSiop: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: string;
+                };
+                authenticateWithSiop: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+                getSiopAuthenticationRequestFromRP: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+                getSiopAuthenticationRequestDetails: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+                verifySiopAuthenticationRequestURI: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+                sendSiopAuthenticationResponse: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+            };
+        };
+    };
     readonly methods: ISIOPv2RP;
     constructor(opts: ISiopv2RPOpts);
     setDefaultOpts(rpDefaultOpts: IRPDefaultOpts, context: IRequiredContext): void;
@@ -203,9 +898,4 @@ declare class SIOPv2RP implements IAgentPlugin {
     private getDefaultOptions;
 }
 
-/**
- * @public
- */
-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 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 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, plugin_schema as schema };