@mattrglobal/verifier-sdk-web 1.1.1-unstable.179 → 1.1.1-unstable.196

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

@@ -5,7 +5,7 @@ export declare enum InitializeErrorMessage {
 /**
  * Initializes the SDK with the provided options.
  *
- * @param options - The options to initialize the SDK with.
+ * @param options - The {@link InitializeOptions | options} to initialize the SDK with.
  */
 export declare const initialize: (options: InitializeOptions) => void;
 export declare const getInitializeOptions: () => InitializeOptions | undefined;

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

@@ -3,7 +3,7 @@ import { RequestCredentialsError, RequestCredentialsOptions, RequestCredentialsR
 /**
  * Requests credentials based on the provided options.
  *
- * @param options - The options to request credentials with.
- * @returns A promise that resolves to a result containing either the requested credentials or an error.
+ * @param options - The options to request credentials with {@link RequestCredentialsOptions}.
+ * @returns A promise that resolves to a result containing either the {@link RequestCredentialsResponse | requested credentials} or an {@link RequestCredentialsError | error}.
  */
 export declare const requestCredentials: (options: RequestCredentialsOptions) => Promise<Result<RequestCredentialsResponse, RequestCredentialsError>>;

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

@@ -1,15 +1,16 @@
 import { Result } from "neverthrow";
 import { BaseError } from "../common";
 import { RequestCredentialsErrorType, RequestCredentialsResponse, RequestCredentialsWithDcApiOptions } from "./types";
-export declare const requestCredentialsWithDigitalCredentialsApi: (options: RequestCredentialsWithDcApiOptions) => Promise<Result<RequestCredentialsResponse, BaseError<RequestCredentialsErrorType.RequestCredentialsFailed>>>;
 /**
- * TypeScript does not know that window.DigitalCredential is a valid property,
- * even though it might exist at runtime, because the feature is experimental
+ * Request credentials for the Digital Credentials API
  *
- * @returns boolean.
+ * @param options - {@link RequestCredentialsWithDcApiOptions}
+ * @ignore - Dark release
  */
+export declare const requestCredentialsWithDigitalCredentialsApi: (options: RequestCredentialsWithDcApiOptions) => Promise<Result<RequestCredentialsResponse, BaseError<RequestCredentialsErrorType.RequestCredentialsFailed>>>;
 /**
  * Checks if Digital Credentials API feature is supported for the current browser.
+ * @ignore - Dark release
  *
  * @returns boolean.
  */

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

@@ -28,26 +28,13 @@ export type CrossDeviceRequestCredentialsOptions = {
     sessionId: string;
 };
 /**
- * Options for requestCredentials function without openId4vp configuration.
- * Can be used for requesting credential with Digital Credentials API or with openId4vp cross-device flow
- */
-export type RequestCredentialsBaseOptions = {
-    /**
-     * An array of CredentialQuery objects that specify the credentials to be requested.
-     */
-    credentialQuery: CredentialQuery[];
-    /**
-     *  The URI to which the user will be redirected after the credential request is completed.
-     */
-    challenge?: string;
-};
-/**
- * Options for openid4vpConfiguration to request credentials with same device
+ * Options for openid4vpConfiguration to request credentials via a same-device flow.
  */
 export type OpenId4vpConfigurationSameDeviceOptions = {
     /**
-     * An optional identifier for wallet configuration. If not provided, the default wallet will be used.
-     * This parameter is defined as part of your MATTR VII tenant verifier configuration
+     * An optional identifier for MATTR VII wallet provider configuration.
+     *
+     * If not provided, defaults to the global wallet schema 'mdoc-openid4vp://'.
      */
     walletProviderId?: string;
     /**
@@ -66,7 +53,7 @@ export declare const OpenId4vpConfigSameDeviceOptionsValidator: v.ObjectSchema<{
     readonly redirectUri: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, "Must not be empty">, v.UrlAction<string, undefined>]>;
 }, undefined>;
 /**
- * Options for openid4vpConfiguration to request credentials with cross device
+ * Options for openid4vpConfiguration to request credentials via a cross-device flow.
  */
 export type OpenId4vpConfigurationCrossDeviceOptions = {
     /**
@@ -97,23 +84,43 @@ export type OpenId4vpConfigurationAutoDetectOptions = {
      */
     redirectUri: string;
     /**
-     * An optional mode in which the credentials are requested. If not provided, the mode is determined based on the device (isMobileDetect(navigator.userAgent)).
+     * An optional mode in which the credentials are requested.
+     *
+     * If not provided, the mode will be automatically detected based off the end users device.
+     *
+     * @example isMobileDetect(navigator.userAgent)
+  
      */
     mode?: Mode;
 };
+/**
+ * Configuration for OpenID4VP presentation flow both same-device and cross-device flows.
+ */
+export type OpenIdvpConfiguration = OpenId4vpConfigurationSameDeviceOptions | OpenId4vpConfigurationCrossDeviceOptions | OpenId4vpConfigurationAutoDetectOptions;
 export declare const OpenId4vpConfigAutoDetectOptionsValidator: v.ObjectSchema<{
     readonly walletProviderId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
     readonly redirectUri: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, "Must not be empty">, v.UrlAction<string, undefined>]>;
     readonly mode: v.OptionalSchema<v.PicklistSchema<[Mode.CrossDevice, Mode.SameDevice], undefined>, undefined>;
 }, undefined>;
 /**
- * Options for the requestCredentials function
+ * Options for the requestCredentials function.
  */
-export type RequestCredentialsOptions = RequestCredentialsBaseOptions & {
+export type RequestCredentialsOptions = {
+    /**
+     * An array of {@link CredentialQuery} objects that specify the credentials to be requested.
+     */
+    credentialQuery: CredentialQuery[];
+    /**
+     * An optional unique challenge allowing association and verification of a specific session.
+     *
+     * If not provided a generated challenge will be created.
+     * @example MATTRVerifierSDK.utils.generateChallenge()
+     */
+    challenge?: string;
     /**
      * Optional configuration for openid4vp presentation flow
      */
-    openid4vpConfiguration?: OpenId4vpConfigurationSameDeviceOptions | OpenId4vpConfigurationCrossDeviceOptions | OpenId4vpConfigurationAutoDetectOptions;
+    openid4vpConfiguration?: OpenIdvpConfiguration;
 };
 export declare const RequestCredentialsOptionsValidator: v.ObjectSchema<{
     readonly credentialQuery: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
@@ -160,11 +167,12 @@ export type MessageEvent = {
  */
 export type RequestCredentialsResponse = {
     /**
-     *  Contains the result of the presentation session if result is configured to be available in the front channel
+     * Contains the result of the presentation session if the associated MATTR VII verifier application is configured
+     * to return results to the front channel (`frontChannelResultAvailable` set to `true`).
      */
     result?: PresentationSessionResult;
     /**
-     *  when frontChannelResultAvailable is set to true
+     * Session identifier which can be used to fetch a presentation result via a back channel.
      */
     sessionId: string;
     /**
@@ -216,13 +224,18 @@ export type HandleRedirectCallbackResponse = {
      *  Contains the result of the presentation session if result is configured to be available in the front channel
      */
     result?: PresentationSessionResult;
+    /**
+     * Session identifier which can be used to fetch a presentation result via a back channel.
+     */
     sessionId: string;
 };
 /**
  * Options for the initialize function
  */
 export type InitializeOptions = {
+    /** MATTR VII Tenant or base URL */
     apiBaseUrl: string;
+    /** MATTR VII configured Verifier application identifier */
     applicationId: string;
 };
 export declare const InitializeOptionsValidator: v.ObjectSchema<{

package/dist/verifier-js.development.js

@@ -7,7 +7,7 @@
  * Do Not Translate or Localize
  *
  * Bundle of @mattrglobal/verifier-sdk-web
- * Generated: 2025-05-26
+ * Generated: 2025-05-27
  * Version: 1.1.0
  * Dependencies:
  *