@mattrglobal/verifier-sdk-web 2.0.0-preview-digital-credential-api.3 → 2.0.0-preview-digital-credential-api.5

package/dist/typings/verifier/types/credential-presentation.d.ts

@@ -1,8 +1,15 @@
 import * as v from "valibot";
-/*** mobile-credential-framework https://github.com/mattrinternal/opencore/tree/master/packages/mobile-credential-framework/src/types ***/
 export declare enum MobileCredentialVerificationReasonType {
+    /** Credential has expired  */
     Expired = "expired",
-    Inactive = "inactive"
+    /** Credential is not yet active */
+    Inactive = "inactive",
+    /** Credential has been revoked permanently and a new credential must be issued */
+    StatusRevoked = "invalid",
+    /** Credential has been suspended and must be re-activated before use */
+    StatusSuspended = "suspended",
+    /** The Credentials status could not be resolved or verified */
+    StatusUnknown = "unknown"
 }
 export declare enum ClaimType {
     Boolean = "boolean",
@@ -28,43 +35,53 @@ export type MobileCredentialError = {
     readonly docType: string;
     readonly errorCode: MobileCredentialResponseErrorCode;
 };
-/*** mobile-credential-framework end ***/
-/*** credential-presentation https://github.com/mattrinternal/platform/tree/master/libraries/platform-api-types/src/api-types/credential-presentation ***/
 export declare enum OpenidPresentationCredentialProfileSupported {
     MOBILE = "mobile"
 }
 export type CredentialQueryClaim = {
+    /**
+     * `intentToRetain` (Optional): When set to `true`, the holder will be indicated that the verifier intends to retain this claim beyond the verification workflow. Defaults to `false` when not specified.
+     */
     intentToRetain?: boolean;
 };
 /**
  * Credential query
  * @example
- * {
- *   "format":"mso_mdoc",
- *   "docType":"org.iso.18013.5.1.mDL",
- *   "nameSpaces":{
- *     "org.iso.18013.5.1":{
- *       "birthdate":{
- *         "intentToRetain":true
- *       },
- *       "portrait":{
- *         "intentToRetain":true
+ *  // The following example credential query will request the `birthdate` and `portrait` claims from a `mobile` credential `profile` with `org.iso.18013.5.1.mDL` as a `docType`:
+ *  {
+ *   "profile": "mobile",
+ *   "docType": "org.iso.18013.5.1.mDL",
+ *   "nameSpaces": {
+ *     "org.iso.18013.5.1": {
+ *       "birthdate": {
+           "intentToRetain": false
+ *        },
+ *       "portrait": {
+ *         "intentToRetain": false
  *       },
- *       "resident_postal_code":{
- *         "intentToRetain":true
- *       }
- *     },
- *     "org.iso.18013.5.1.aamva":{
- *       "DHS_compliance":{
- *         "intentToRetain":true
- *       }
- *     }
- *   }
- * }
+ *       "resident_postal_code": {
+ *         "intentToRetain": false
+ *        }
+ *      },
+ *    }
+ *  }
  */
 export type CredentialQuery = {
+    /**
+     * Credential format of the credential that will be verified. Currently only mobile (mDocs) is supported.
+     */
     profile: OpenidPresentationCredentialProfileSupported;
+    /**
+     * the mDL’s type. Confirm with the certificate issuer for what docType they are issuing. Some common examples include:
+     *   * Mobile Driver Licence (`org.iso.18013.5.1.mDL`).
+     *   * PhotoID (`org.iso.23220.photoid.1`).
+     *   * Mobile Vehicle Registration Card (`org.iso.7367.1.mVRC`).
+     *   * Health certificate (`org.micov.vtr.1`).
+     */
     docType: string;
+    /**
+     * Each namespace corresponds to a group of claims included in the credential. These can be claims that are part of a specific standard, jurisdiction or any other reference. The namespace would usually correspond to the requested `docType`.
+     */
     nameSpaces: {
         [nameSpace: string]: {
             [claim: string]: CredentialQueryClaim;
@@ -78,6 +95,36 @@ export declare const CredentialQueryValidator: v.ObjectSchema<{
         readonly intentToRetain: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
     }, undefined>, undefined>, undefined>;
 }, undefined>;
+export type DcqlCredentialQuery = {
+    credentials: {
+        id: string;
+        format: string;
+        meta?: unknown;
+        claims: {
+            path: string[];
+        }[];
+    }[];
+    credential_sets?: {
+        options: string[][];
+        required?: boolean;
+        purpose?: unknown;
+    }[];
+};
+export declare const DcqlCredentialQueryValidator: v.ObjectSchema<{
+    readonly credentials: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly format: v.StringSchema<undefined>;
+        readonly meta: v.OptionalSchema<v.UnknownSchema, never>;
+        readonly claims: v.ArraySchema<v.ObjectSchema<{
+            readonly path: v.ArraySchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly credential_sets: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+        readonly options: v.ArraySchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+        readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
+        readonly purpose: v.OptionalSchema<v.UnknownSchema, never>;
+    }, undefined>, undefined>, never>;
+}, undefined>;
 /**
  * List of error types for presentation failure result
  */
@@ -104,8 +151,6 @@ export declare enum PresentationErrorType {
      */
     Unknown = "Unknown"
 }
-/*** credential-presentation end ***/
-/*** mobile-credential https://github.com/mattrinternal/platform/tree/master/libraries/platform-api-types/src/api-types/mobile-credential ***/
 export type ValidityInfoRequest = {
     signed: string;
     validFrom: string;
@@ -169,24 +214,22 @@ export type Claim = {
 export type MobileCredentialPresentationCredential = {
     docType: string;
     validityInfo: ValidityInfoRequest;
-    branding?: CredentialBranding;
-    claims?: Record<string, Record<string, Claim>>;
-    claimErrors?: Record<string, Record<string, MobileCredentialResponseErrorCode>>;
-    verificationResult: MobileCredentialVerificationResult;
     issuerInfo: {
         commonName: string;
         trustedIssuerId: string;
     };
+    verificationResult: MobileCredentialVerificationResult;
+    branding?: CredentialBranding;
+    claims?: Record<string, Record<string, Claim>>;
+    claimErrors?: Record<string, Record<string, MobileCredentialResponseErrorCode>>;
 };
-/*** mobile-credential end ***/
-/*** session result https://github.com/mattrinternal/platform/tree/master/libraries/platform-api-types/src/api-types/credential-presentation/sessionResult.ts ***/
 /**
  * The result of a credential presentation request, default response or set `resultAvailableInFrontChannel: true` as verifier's configuration
  */
 export type PresentationSuccessResult = {
     sessionId: string;
     challenge: string;
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     credentials?: MobileCredentialPresentationCredential[];
     credentialErrors?: MobileCredentialError[];
 };
@@ -210,7 +253,7 @@ export declare const PresentationResultRelaxValidator: v.ObjectSchema<{
 export type PresentationFailureResult = {
     sessionId: string;
     challenge: string;
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     error: {
         type: PresentationErrorType;
         message: string;
@@ -231,17 +274,29 @@ export type ExchangeSessionResultRequest = {
     readonly responseCode: string;
 };
 export type ExchangeSessionResultResponse = PresentationSessionResult | PresentationHiddenResult;
-/*** session result end ***/
-/*** session https://github.com/mattrinternal/platform/tree/master/libraries/platform-api-types/src/api-types/credential-presentation/session.ts ***/
 export type CreateSessionRequest = v.InferOutput<typeof CreateSessionRequestValidator>;
 export declare const CreateSessionRequestValidator: v.ObjectSchema<{
-    readonly credentialQuery: v.ArraySchema<v.ObjectSchema<{
+    readonly credentialQuery: v.UnionSchema<[v.ArraySchema<v.ObjectSchema<{
         readonly profile: v.PicklistSchema<[OpenidPresentationCredentialProfileSupported], undefined>;
         readonly docType: v.StringSchema<undefined>;
         readonly nameSpaces: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
             readonly intentToRetain: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
         }, undefined>, undefined>, undefined>;
-    }, undefined>, undefined>;
+    }, undefined>, undefined>, v.ObjectSchema<{
+        readonly credentials: v.ArraySchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly format: v.StringSchema<undefined>;
+            readonly meta: v.OptionalSchema<v.UnknownSchema, never>;
+            readonly claims: v.ArraySchema<v.ObjectSchema<{
+                readonly path: v.ArraySchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly credential_sets: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly options: v.ArraySchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
+            readonly purpose: v.OptionalSchema<v.UnknownSchema, never>;
+        }, undefined>, undefined>, never>;
+    }, undefined>], undefined>;
     readonly challenge: v.StringSchema<undefined>;
     readonly redirectUri: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly walletProviderId: v.OptionalSchema<v.StringSchema<undefined>, never>;

package/dist/typings/verifier/types/verifier-web-sdk.d.ts

@@ -1,7 +1,7 @@
 import * as v from "valibot";
 import { BaseError } from "../../common";
 import { CrossDeviceCallbackError } from "../requestCredentialsCrossDevice";
-import { CredentialQuery, PresentationSessionResult } from "./credential-presentation";
+import { CredentialQuery, DcqlCredentialQuery, PresentationSessionResult } from "./credential-presentation";
 export declare enum LocalStorageKey {
     challenge = "mattr_chg",
     sessionId = "mattr_sid"
@@ -25,7 +25,7 @@ export declare enum MessageEventDataType {
     PresentationAbort = "PresentationAbort"
 }
 export type SameDeviceRequestCredentialsOptions = {
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     redirectUri: string;
     challenge: string;
     mode: Mode.sameDevice;
@@ -54,7 +54,7 @@ export type CrossDeviceCallback = {
     onFailure: (error: CrossDeviceCallbackError) => void;
 };
 export type CrossDeviceRequestCredentialsOptions = {
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     crossDeviceCallback: CrossDeviceCallback;
     challenge: string;
     walletProviderId?: string;
@@ -62,7 +62,7 @@ export type CrossDeviceRequestCredentialsOptions = {
     initialiseOptions: InitialiseOptions;
 };
 export type DigitalCredentialsApiRequestOptions = {
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     challenge: string;
     initialiseOptions: InitialiseOptions;
 };
@@ -73,7 +73,7 @@ export type RequestCredentialsSameDeviceOptions = {
     /**
      * An array of CredentialQuery objects that specify the credentials to be requested.
      */
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     /**
      *  The URI to which the user will be redirected after the credential request is completed.
      */
@@ -93,7 +93,7 @@ export type RequestCredentialsSameDeviceOptions = {
     mode: Mode.sameDevice;
 };
 export declare const RequestCredentialsSameDeviceOptionsValidator: v.ObjectSchema<{
-    readonly credentialQuery: v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
+    readonly credentialQuery: v.UnionSchema<[v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
         readonly profile: v.PicklistSchema<[import("./credential-presentation").OpenidPresentationCredentialProfileSupported], undefined>;
         readonly docType: v.StringSchema<undefined>;
         readonly nameSpaces: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
@@ -109,7 +109,21 @@ export declare const RequestCredentialsSameDeviceOptionsValidator: v.ObjectSchem
             };
         };
         docType: string;
-    }[], undefined>]>;
+    }[], undefined>]>, v.ObjectSchema<{
+        readonly credentials: v.ArraySchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly format: v.StringSchema<undefined>;
+            readonly meta: v.OptionalSchema<v.UnknownSchema, never>;
+            readonly claims: v.ArraySchema<v.ObjectSchema<{
+                readonly path: v.ArraySchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly credential_sets: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly options: v.ArraySchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
+            readonly purpose: v.OptionalSchema<v.UnknownSchema, never>;
+        }, undefined>, undefined>, never>;
+    }, undefined>], undefined>;
     readonly redirectUri: v.StringSchema<undefined>;
     readonly challenge: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly walletProviderId: v.OptionalSchema<v.StringSchema<undefined>, never>;
@@ -122,7 +136,7 @@ export type RequestCredentialsCrossDeviceDeviceOptions = {
     /**
      * An array of CredentialQuery objects that specify the credentials to be requested.
      */
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     /**
      * The callback functions to be executed on success or failure of the credential request in cross device mode.
      */
@@ -142,7 +156,7 @@ export type RequestCredentialsCrossDeviceDeviceOptions = {
     mode: Mode.crossDevice;
 };
 export declare const RequestCredentialsCrossDeviceOptionsValidator: v.ObjectSchema<{
-    readonly credentialQuery: v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
+    readonly credentialQuery: v.UnionSchema<[v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
         readonly profile: v.PicklistSchema<[import("./credential-presentation").OpenidPresentationCredentialProfileSupported], undefined>;
         readonly docType: v.StringSchema<undefined>;
         readonly nameSpaces: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
@@ -158,7 +172,21 @@ export declare const RequestCredentialsCrossDeviceOptionsValidator: v.ObjectSche
             };
         };
         docType: string;
-    }[], undefined>]>;
+    }[], undefined>]>, v.ObjectSchema<{
+        readonly credentials: v.ArraySchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly format: v.StringSchema<undefined>;
+            readonly meta: v.OptionalSchema<v.UnknownSchema, never>;
+            readonly claims: v.ArraySchema<v.ObjectSchema<{
+                readonly path: v.ArraySchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly credential_sets: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly options: v.ArraySchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
+            readonly purpose: v.OptionalSchema<v.UnknownSchema, never>;
+        }, undefined>, undefined>, never>;
+    }, undefined>], undefined>;
     readonly crossDeviceCallback: v.ObjectSchema<{
         readonly onComplete: v.FunctionSchema<undefined>;
         readonly onFailure: v.FunctionSchema<undefined>;
@@ -174,7 +202,7 @@ export type RequestCredentialsAutoDetectOptions = {
     /**
      * An array of CredentialQuery objects that specify the credentials to be requested.
      */
-    credentialQuery: CredentialQuery[];
+    credentialQuery: CredentialQuery[] | DcqlCredentialQuery;
     /**
      * The callback functions to be executed on success or failure of the credential request in cross device mode.
      */
@@ -203,7 +231,7 @@ export declare const RequestCredentialsAutoDetectDeviceOptionsValidator: v.Gener
  */
 export type RequestCredentialsOptions = RequestCredentialsSameDeviceOptions | RequestCredentialsCrossDeviceDeviceOptions | RequestCredentialsAutoDetectOptions;
 export declare const RequestCredentialsOptionsValidator: v.UnionSchema<[v.ObjectSchema<{
-    readonly credentialQuery: v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
+    readonly credentialQuery: v.UnionSchema<[v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
         readonly profile: v.PicklistSchema<[import("./credential-presentation").OpenidPresentationCredentialProfileSupported], undefined>;
         readonly docType: v.StringSchema<undefined>;
         readonly nameSpaces: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
@@ -219,13 +247,27 @@ export declare const RequestCredentialsOptionsValidator: v.UnionSchema<[v.Object
             };
         };
         docType: string;
-    }[], undefined>]>;
+    }[], undefined>]>, v.ObjectSchema<{
+        readonly credentials: v.ArraySchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly format: v.StringSchema<undefined>;
+            readonly meta: v.OptionalSchema<v.UnknownSchema, never>;
+            readonly claims: v.ArraySchema<v.ObjectSchema<{
+                readonly path: v.ArraySchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly credential_sets: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly options: v.ArraySchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
+            readonly purpose: v.OptionalSchema<v.UnknownSchema, never>;
+        }, undefined>, undefined>, never>;
+    }, undefined>], undefined>;
     readonly redirectUri: v.StringSchema<undefined>;
     readonly challenge: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly walletProviderId: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly mode: v.PicklistSchema<[Mode.sameDevice], undefined>;
 }, undefined>, v.ObjectSchema<{
-    readonly credentialQuery: v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
+    readonly credentialQuery: v.UnionSchema<[v.SchemaWithPipe<[v.ArraySchema<v.ObjectSchema<{
         readonly profile: v.PicklistSchema<[import("./credential-presentation").OpenidPresentationCredentialProfileSupported], undefined>;
         readonly docType: v.StringSchema<undefined>;
         readonly nameSpaces: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
@@ -241,7 +283,21 @@ export declare const RequestCredentialsOptionsValidator: v.UnionSchema<[v.Object
             };
         };
         docType: string;
-    }[], undefined>]>;
+    }[], undefined>]>, v.ObjectSchema<{
+        readonly credentials: v.ArraySchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly format: v.StringSchema<undefined>;
+            readonly meta: v.OptionalSchema<v.UnknownSchema, never>;
+            readonly claims: v.ArraySchema<v.ObjectSchema<{
+                readonly path: v.ArraySchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly credential_sets: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly options: v.ArraySchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
+            readonly purpose: v.OptionalSchema<v.UnknownSchema, never>;
+        }, undefined>, undefined>, never>;
+    }, undefined>], undefined>;
     readonly crossDeviceCallback: v.ObjectSchema<{
         readonly onComplete: v.FunctionSchema<undefined>;
         readonly onFailure: v.FunctionSchema<undefined>;
@@ -308,12 +364,14 @@ export type HandleRedirectCallbackResponse = {
  */
 export type InitialiseOptions = {
     apiBaseUrl: string;
+    applicationId?: string;
     digitalCredentialsApiProtocol?: string;
     enableDigitalCredentialsApiSameDeviceFlow?: boolean;
     enableDigitalCredentialsApiCrossDeviceFlow?: boolean;
 };
 export declare const InitialiseOptionsValidator: v.ObjectSchema<{
     readonly apiBaseUrl: v.StringSchema<undefined>;
+    readonly applicationId: v.OptionalSchema<v.StringSchema<undefined>, never>;
     readonly enableDigitalCredentialsApiSameDeviceFlow: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
     readonly enableDigitalCredentialsApiCrossDeviceFlow: v.OptionalSchema<v.BooleanSchema<undefined>, never>;
 }, undefined>;

package/dist/typings/verifier/utils.d.ts

@@ -1,6 +1,6 @@
 import { Result } from "neverthrow";
 import { SafeFetchValidateRespondError } from "../common/safeFetch";
-import { CreateSessionRequest, CreateSessionResponse, ExchangeSessionResultResponse, CreateDigitalCredentialsApiSessionResponse } from "./types";
+import { CreateSessionRequest, CreateSessionResponse, ExchangeSessionResultResponse, InitialiseOptions, CreateDigitalCredentialsApiSessionResponse } from "./types";
 /**
  * Generates a challenge string using the window.crypto API.
  *
@@ -22,12 +22,11 @@ export declare const getHashParamValue: (hash: string, param: string) => string
  * @param challenge - The challenge for the session.
  * @param redirectUri - The redirect URI for the session.
  * @param apiBaseUrl - The base URL of the API.
- * @param walletProviderId - The ID of the wallet provider.
+ * @param applicationId - optional, The ID of the verifier application, if not provided the default application ID will be used.
+ * @param walletProviderId - optional, The ID of the wallet provider, if not provided the default wallet provider will be used.
  * @returns A promise that resolves to a result containing either the created session response or an error.
  */
-export declare const createSession: ({ credentialQuery, challenge, redirectUri, apiBaseUrl, walletProviderId, }: CreateSessionRequest & {
-    apiBaseUrl: string;
-}) => Promise<Result<CreateSessionResponse, SafeFetchValidateRespondError>>;
+export declare const createSession: ({ credentialQuery, challenge, redirectUri, apiBaseUrl, applicationId, walletProviderId, }: CreateSessionRequest & InitialiseOptions) => Promise<Result<CreateSessionResponse, SafeFetchValidateRespondError>>;
 /**
  * Exchange the result of a session using the provided parameters.
  *
@@ -77,9 +76,10 @@ export declare const createDigitalCredentialsApiSession: ({ credentialQuery, cha
  * @param apiBaseUrl - The base URL of the API.
  * @returns A promise that resolves to a result containing either the session result response or an error.
  */
-export declare const getDigitalCredentialsApiSessionResult: ({ challenge, sessionId, response, apiBaseUrl, }: {
+export declare const getDigitalCredentialsApiSessionResult: ({ challenge, sessionId, response, apiBaseUrl, protocol, }: {
     challenge: string;
     sessionId: string;
     response: any;
     apiBaseUrl: string;
+    protocol: string;
 }) => Promise<Result<any, SafeFetchValidateRespondError>>;