@soyio/soyio-widget 2.1.0 → 2.2.0

package/README.md

@@ -170,6 +170,43 @@ Optional props:
 - `forceError`
 - `customColor`.
 
+### 3. Auth Request
+
+The **`auth_request`** is a process where, using a previously created `auth_request_id`, a request is initiated in which a user can authenticate. This authentication can occur either through an access key or facial video. It's important to note that for this request, the user must have been previously verified with Soyio.
+
+```html
+<button id="start-auth-request">Start auth request</button>
+
+<script>
+  import { SoyioWidget } from "@soyio/soyio-widget";
+
+  // Widget configuration
+  const widgetConfig = {
+    request: "authentication",
+    configProps: {
+      authRequestId: "<auth request id>",
+      customColor: "<custom color>",
+    },
+    onEvent: (data) => console.log(data),
+    isSandbox: true,
+  };
+
+  // Function to create the widget
+  function initWidget() {
+    new SoyioWidget(widgetConfig);
+  }
+
+  // Add event listener to the button to create the widget on click
+  document
+    .getElementById("start-auth-request")
+    .addEventListener("click", initWidget);
+</script>
+```
+
+Optional props:
+
+- `customColor`.
+
 ### Attribute Descriptions
 
 - **`companyId`**: The unique identifier for the company, must start with `'com_'`.
@@ -178,6 +215,7 @@ Optional props:
 - **`templateId`**: Identifier of template. Specifies the order and quantity of documents requested from the user, as well as the mandatory data that the user is asked to share with the company. It must start with `'dtpl_'`.
 - **`disclosureRequestId`**: If created beforehand, you can target a specific disclosure request that the user must complete. It is useful if you need to match some data between the disclosure process and your database records. It must start with `'dreq_'`
 - **`signatureAttemptId`**: Identifier of signature attempt obtained when creating the `SignatureAttempt`. It must start with `'sa_'`.
+- **`authRequestId`**: Identifier of auth request obtained when creating the `AuthRequest`. It must start with `'authreq_'`.
 - **`identityId`**: This identifier must start with `'id_'` and signifies the user's identity.
 - **`isSandbox`**: Indicates if the widget should operate in sandbox mode, defaulting to `false`.
 - **`forceError`**: Triggers specific errors for testing or debugging. Used to simulate failure scenarios. Only works in `sandbox` mode.

package/dist/index.d.ts

@@ -1,4 +1,17 @@
-declare type AttemptConfig = DisclosureRequestConfig | SignatureAttemptConfig;
+declare type AttemptConfig = DisclosureRequestConfig | SignatureAttemptConfig | AuthRequestConfig;
+
+declare type AuthRequestConfig = {
+    request: 'authentication';
+    configProps: AuthRequestProps;
+    onEvent: (data: EventData) => void;
+    isSandbox?: boolean;
+    developmentUrl?: string;
+};
+
+declare type AuthRequestProps = {
+    authRequestId: `authreq_${string}`;
+    customColor?: string;
+};
 
 declare type DisclosureRequestConfig = {
     request: 'disclosure';
@@ -11,15 +24,15 @@ declare type DisclosureRequestConfig = {
 declare type DisclosureRequestProps = NewDisclosureRequestProps | ExistingDisclosureRequestProps;
 
 declare type EventData = {
-    eventName: 'IDENTITY_VALIDATED' | 'IDENTITY_AUTHENTICATED' | 'IDENTITY_SIGNATURE' | 'DENIED_CAMERA_PERMISSION' | 'REJECTED_SIGNATURE' | 'DISCLOSURE_REQUEST_SUCCESSFUL' | 'UNEXPECTED_ERROR';
-    identityId: string;
+    eventName: 'IDENTITY_VALIDATED' | 'IDENTITY_AUTHENTICATED' | 'IDENTITY_SIGNATURE' | 'DENIED_CAMERA_PERMISSION' | 'REJECTED_SIGNATURE' | 'DISCLOSURE_REQUEST_SUCCESSFUL' | 'UNEXPECTED_ERROR' | 'AUTH_REQUEST_SUCCESSFUL';
+    identityId: `id_${string}`;
     userReference?: string;
 };
 
 declare type ExistingDisclosureRequestProps = {
     companyId?: never;
     templateId?: never;
-    disclosureRequestId: string;
+    disclosureRequestId: `dreq_${string}`;
     userReference?: never;
     userEmail?: never;
     forceError?: ForceErrors;
@@ -29,8 +42,8 @@ declare type ExistingDisclosureRequestProps = {
 declare type ForceErrors = 'facial_validation_error' | 'document_validation_error' | 'unknown_error' | 'expiration_error' | 'camera_permission_error';
 
 declare type NewDisclosureRequestProps = {
-    companyId: string;
-    templateId: string;
+    companyId: `com_${string}`;
+    templateId: `dtpl_${string}`;
     disclosureRequestId?: never;
     userReference: string;
     userEmail?: string;
@@ -49,7 +62,7 @@ declare type SignatureAttemptConfig = {
 };
 
 declare type SignatureAttemptProps = {
-    signatureAttemptId: string;
+    signatureAttemptId: `sa_${string}`;
     forceError?: ForceErrors;
     customColor?: string;
 };
@@ -62,9 +75,11 @@ declare namespace SoyioTypes {
         ExistingDisclosureRequestProps,
         DisclosureRequestProps,
         SignatureAttemptProps,
+        AuthRequestProps,
         EventData,
         DisclosureRequestConfig,
         SignatureAttemptConfig,
+        AuthRequestConfig,
         AttemptConfig
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soyio/soyio-widget",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",