@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth 0.33.1-next.3 → 0.33.1-next.73

package/dist/index.d.ts

@@ -1,8 +1,218 @@
+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 { DIDDocument } from '@sphereon/did-uni-client';
+import { EventEmitter } from 'events';
+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 { 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';
+
+declare enum VerifiedDataMode {
+    NONE = "none",
+    VERIFIED_PRESENTATION = "vp",
+    CREDENTIAL_SUBJECT_FLATTENED = "cs-flat"
+}
+interface ISIOPv2RP extends IPluginMethodMap {
+    siopCreateAuthRequestURI(createArgs: ICreateAuthRequestArgs, context: IRequiredContext): Promise<string>;
+    siopCreateAuthRequestPayloads(createArgs: ICreateAuthRequestArgs, context: IRequiredContext): Promise<IAuthorizationRequestPayloads>;
+    siopGetAuthRequestState(args: IGetAuthRequestStateArgs, context: IRequiredContext): Promise<AuthorizationRequestState | undefined>;
+    siopGetAuthResponseState(args: IGetAuthResponseStateArgs, context: IRequiredContext): Promise<AuthorizationResponseStateWithVerifiedData | undefined>;
+    siopUpdateAuthRequestState(args: IUpdateRequestStateArgs, context: IRequiredContext): Promise<AuthorizationRequestState>;
+    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>;
+}
+interface ISiopv2RPOpts {
+    defaultOpts?: IRPDefaultOpts;
+    instanceOpts?: IPEXInstanceOptions[];
+}
+interface IRPDefaultOpts extends IRPOptions {
+}
+interface ICreateAuthRequestArgs {
+    definitionId: string;
+    correlationId: string;
+    responseURIType: ResponseURIType;
+    responseURI: string;
+    responseRedirectURI?: string;
+    jwtIssuer?: JwtIssuer;
+    requestByReferenceURI?: string;
+    nonce?: string;
+    state?: string;
+    claims?: ClaimPayloadCommonOpts;
+}
+interface IGetAuthRequestStateArgs {
+    correlationId: string;
+    definitionId: string;
+    errorOnNotFound?: boolean;
+}
+interface IGetAuthResponseStateArgs {
+    correlationId: string;
+    definitionId: string;
+    errorOnNotFound?: boolean;
+    progressRequestStateTo?: AuthorizationRequestStateStatus;
+    includeVerifiedData?: VerifiedDataMode;
+}
+interface IUpdateRequestStateArgs {
+    definitionId: string;
+    correlationId: string;
+    state: AuthorizationRequestStateStatus;
+    error?: string;
+}
+interface IDeleteAuthStateArgs {
+    correlationId: string;
+    definitionId: string;
+}
+interface IVerifyAuthResponseStateArgs {
+    authorizationResponse: string | AuthorizationResponsePayload;
+    definitionId?: string;
+    correlationId: string;
+    audience?: string;
+    presentationDefinitions?: PresentationDefinitionWithLocation | PresentationDefinitionWithLocation[];
+    dcqlQuery?: DcqlQueryREST;
+}
+interface IDefinitionPair {
+    definitionPayload: IPresentationDefinition;
+    dcqlPayload?: DcqlQueryREST;
+}
+interface ImportDefinitionsArgs {
+    definitions: Array<IDefinitionPair>;
+    tenantId?: string;
+    version?: string;
+    versionControlMode?: VersionControlMode;
+}
+interface IGetRedirectUriArgs {
+    correlationId: string;
+    definitionId?: string;
+    state?: string;
+}
+interface IAuthorizationRequestPayloads {
+    authorizationRequest: AuthorizationRequestPayload;
+    requestObject?: string;
+    requestObjectDecoded?: RequestObjectPayload;
+}
+interface IPEXDefinitionPersistArgs extends IPEXInstanceOptions {
+    definition: IPresentationDefinition;
+    ttl?: number;
+}
+interface ISiopRPInstanceArgs {
+    definitionId?: string;
+    responseRedirectURI?: string;
+}
+interface IPEXInstanceOptions extends IPEXOptions {
+    rpOpts?: IRPOptions;
+}
+interface IRPOptions {
+    responseMode?: ResponseMode;
+    supportedVersions?: SupportedVersion[];
+    sessionManager?: IRPSessionManager;
+    clientMetadataOpts?: ClientMetadataOpts;
+    expiresIn?: number;
+    eventEmitter?: EventEmitter;
+    credentialOpts?: CredentialOpts;
+    verificationPolicies?: VerificationPolicies;
+    identifierOpts: ISIOPIdentifierOptions;
+    verifyJwtCallback?: VerifyJwtCallback;
+    responseRedirectUri?: string;
+}
+interface IPEXOptions {
+    presentationVerifyCallback?: PresentationVerificationCallback;
+    definitionId: string;
+    version?: string;
+    tenantId?: string;
+}
+type VerificationPolicies = {
+    schemaValidation: SchemaValidation;
+};
+interface PerDidResolver {
+    didMethod: string;
+    resolver: Resolvable;
+}
+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;
+    checkLinkedDomains?: CheckLinkedDomain;
+    wellknownDIDVerifyCallback?: VerifyCallback;
+}
+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 {
+    private _rp;
+    private readonly _pexOptions;
+    private readonly _rpOptions;
+    constructor({ rpOpts, pexOpts }: {
+        rpOpts: IRPOptions;
+        pexOpts?: IPEXOptions;
+    });
+    get(context: IRequiredContext): Promise<RP>;
+    get rpOptions(): IRPOptions;
+    get pexOptions(): IPEXOptions | undefined;
+    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>;
+}
+
+declare class SIOPv2RP implements IAgentPlugin {
+    private readonly opts;
+    private static readonly _DEFAULT_OPTS_KEY;
+    private readonly instances;
+    readonly schema: any;
+    readonly methods: ISIOPv2RP;
+    constructor(opts: ISiopv2RPOpts);
+    setDefaultOpts(rpDefaultOpts: IRPDefaultOpts, context: IRequiredContext): void;
+    private createAuthorizationRequestURI;
+    private createAuthorizationRequestPayloads;
+    private siopGetRequestState;
+    private siopGetResponseState;
+    private presentationOrClaimsFrom;
+    private siopUpdateRequestState;
+    private siopDeleteState;
+    private siopVerifyAuthResponse;
+    private siopImportDefinitions;
+    private siopGetRedirectURI;
+    getRPInstance({ definitionId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
+    getRPOptions(context: IRequiredContext, opts: {
+        definitionId?: string;
+        responseRedirectURI?: string;
+    }): Promise<IRPOptions>;
+    getInstanceOpts(definitionId?: string): IPEXInstanceOptions | undefined;
+    private getDefaultOptions;
+}
+
 /**
  * @public
  */
 declare const schema: any;
-export { schema };
-export { SIOPv2RP } from './agent/SIOPv2RP';
-export * from './types/ISIOPv2RP';
-//# sourceMappingURL=index.d.ts.map
+
+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 };