@soyio/soyio-widget 1.0.0 → 1.0.2

package/README.md

@@ -39,7 +39,7 @@ Integrate the widget into your frontend framework using the script below. Ensure
       userEmail: "<user email>",
       flowTemplateId: "<flow template id>",
       identityId: "<identity id>",
-      forceError: 'no_error'
+      forceError: "<error type>",
     },
     onEvent: (data) => console.log(data),
     isSandbox: true,
@@ -58,12 +58,11 @@ Integrate the widget into your frontend framework using the script below. Ensure
 - **`companyId`**: The unique identifier for the company, must start with `'com_'`.
 - **`userReference`**: (Optional) A reference identifier provided by the company for the user engaging with the widget. This identifier is used in events (`onEvent` and `webhooks`) to inform the company which user the events are associated with.
 - **`userEmail`**: The user's email address. This field is optional when the flow is `'register'`, where if not provided, Soyio will prompt the user to enter their email. However, for the `'authenticate'` flow, this field should not be provided.
+- **`forceError`**: (Optional) Triggers specific errors for testing or debugging. Used to simulate failure scenarios.
 - **`flowTemplateId`**: : Required only in the `'register'` flow, this identifier specifies the order and quantity of documents requested from the user. It must start with `'vft_'`.
 - **`identityId`**: Necessary only in the `'authenticate'` flow, this identifier must start with `'id_'` and signifies the user's identity.
 - **`onEvent`**: A callback function triggered upon event occurrences, used for capturing and logging event-related data.
 - **`isSandbox`**: (Optional) Indicates if the widget should operate in sandbox mode, defaulting to `false`.
-- **`forceError`**: (Optional) Enum with two values (`no_error` and `validation_error`). Only valid for sandbox environment. Indicates if the flow should simulate a failed validation response.
- 
 
 #### Events
 
@@ -87,3 +86,12 @@ The `onEvent` callback is designed to handle various events that occur during wi
 
 - **`WIDGET_OPENED`**: This event occurs when the user closes the `Soyio` pop up. The event object is as follows:
   - `{ eventName: 'WIDGET_CLOSED' }`.
+
+#### Error types
+
+The `forceError` parameter can simulate the following error conditions:
+
+- `'user_exists'`: Triggers an error indicating that a user with the given credentials already exists in the system.
+- `'facial_validation_error'`: Simulates a failure in the facial video liveness test, indicating the system could not verify the user's live presence.
+- `'document_validation_error'`: Indicates an issue with validating the photos of the documents provided by the user.
+- `'unknown_error'`: Generates a generic error, representing an unspecified problem.

package/dist/index.d.ts

@@ -1,3 +1,39 @@
-export * from './src/index'
-import SoyioWidget from './src/index'
-export default SoyioWidget
+declare type ConfigProps = {
+    companyId: string;
+    userReference?: string;
+    flowTemplateId?: string;
+    userEmail?: string;
+    identityId?: string;
+    forceError?: SoyioErrors;
+};
+
+declare type EventData = {
+    eventName: 'IDENTITY_REGISTERED' | 'IDENTITY_AUTHENTICATED';
+    identityId: string;
+    userReference?: string;
+};
+
+declare type Flow = 'authenticate' | 'register';
+
+declare type SoyioErrors = 'user_exists' | 'facial_validation_error' | 'document_validation_error' | 'unknown_error';
+
+declare class Widget {
+    #private;
+    private flow;
+    private configProps;
+    private onEvent;
+    private isSandbox;
+    constructor(options: WidgetConfig);
+    validateProps(): void;
+}
+export default Widget;
+
+declare type WidgetConfig = {
+    flow: Flow;
+    configProps: Partial<ConfigProps>;
+    onEvent: (data: EventData) => void;
+    isSandbox?: boolean;
+    developmentUrl?: string;
+};
+
+export { }

package/package.json

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

package/dist/src/constants.d.ts

@@ -1,6 +0,0 @@
-export declare const CONTAINER_ID = "soyio-widget-iframe-container";
-export declare const IFRAME_ID = "soyio-widget-iframe";
-export declare const PRODUCTION_URL = "https://app.soyio.id/widget";
-export declare const SANDBOX_URL = "https://sandbox.soyio.id/widget";
-export declare const FINISHING_EVENTS: string[];
-export declare const CLOSED_EVENT = "WIDGET_CLOSED";

package/dist/src/events.d.ts

@@ -1,3 +0,0 @@
-declare function setReady(iframe: HTMLIFrameElement): void;
-declare function setConfig(iframe: HTMLIFrameElement, config: Partial<ConfigProps>): void;
-export { setReady, setConfig };

package/dist/src/index.d.ts

@@ -1,10 +0,0 @@
-declare class Widget {
-    #private;
-    private flow;
-    private configProps;
-    private onEvent;
-    private isSandbox;
-    constructor(options: WidgetConfig);
-    validateProps(): void;
-}
-export default Widget;

package/dist/src/listeners.d.ts

@@ -1,5 +0,0 @@
-type Hooks = {
-    onEvent: (event: any) => void;
-};
-export declare function setListeners(hooks: Hooks): void;
-export {};

package/dist/src/utils.d.ts

@@ -1 +0,0 @@
-export declare function getFullUrl(flow: Flow, configProps: Partial<ConfigProps>, isSandbox: boolean, developmentUrl: string | undefined): string;

package/dist/src/widget.d.ts

@@ -1,3 +0,0 @@
-export declare function showPopUp(flow: Flow, configProps: Partial<ConfigProps>, isSandbox: boolean, developmentUrl: string | undefined): void;
-export declare function clearOverlayEffects(): void;
-export declare function removePopUp(): void;

package/dist/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;