@soyio/soyio-rn-sdk 1.0.2 → 1.0.4

package/README.md

@@ -61,7 +61,7 @@ export default function App() {
 
   // For registering a new identity
   const registerParams = {
-    flowTemplateId: "<flow template id>", // Starts with 'vft_'
+    flowTemplateId: "<flow template id>", // Starts with 'vt_'
     userEmail: "<user email>",            // Optional
     forceError: '<error type>',           // Optional
   };
@@ -104,6 +104,7 @@ The `onEventChange` function returns an object with the following properties:
   - `"open authenticate"`: Triggered when the user initiates the `authenticate` method.
   - `"dismiss"`: Triggered when the user closes the `WebBrowser`.
   - `"success"`: Triggered when the authentication flow is successfully completed.
+  - `"error"`: Triggered when there was an error on the flow.
 
 - `url` (optional): URL associated only with the `success` event.
 
@@ -112,13 +113,17 @@ The `onEventChange` function returns an object with the following properties:
 
   where `<identity_id>` is the unique identifier of the newly registered or authenticated user, respectively.
 
+- `message` (optional): Additional information associated with the event type received.
+	- Possible messages when event type is `error`:
+		- `"DENIED_CAMERA_PERMISSION"`: User denies access to its camera.
+
 #### Attribute Descriptions
 
 - **`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_'`.
+- **`flowTemplateId`**: Required only in the `'register'` flow, this identifier specifies the order and quantity of documents requested from the user. It must start with `'vt_'`.
 - **`identityId`**: Necessary only in the `'authenticate'` flow, this identifier must start with `'id_'` and signifies the user's identity.
 - **`customColor`**: (Optional) A hex code string that specifies the base color of the interface during either the authentication or registration flow.
 - **`isSandbox`**: (Optional) Indicates if the widget should operate in sandbox mode, defaulting to `false`.

package/package/src/core.jsx

@@ -66,22 +66,28 @@ var utils_1 = require("./utils");
 var useSoyioAuth = function (_a) {
     var options = _a.options, onEventChange = _a.onEventChange;
     var register = (0, react_1.useCallback)(function (registerParams) { return __awaiter(void 0, void 0, void 0, function () {
-        var registerBaseUri, registerUri, redirectUrl, webBrowserOptions, registerResult;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
+        var registerBaseUri, registerUri, redirectUrl, webBrowserOptions, registerResult, errorMessage;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
                     registerBaseUri = (0, utils_1.getFlowUrl)(options, 'register');
                     registerUri = "".concat(registerBaseUri, "?").concat((0, utils_1.buildUrlParams)(options, registerParams));
                     redirectUrl = (0, utils_1.getRedirectUrl)(options.uriScheme);
                     return [4 /*yield*/, (0, utils_1.getBrowserOptions)()];
                 case 1:
-                    webBrowserOptions = _a.sent();
+                    webBrowserOptions = _b.sent();
                     if (onEventChange)
                         onEventChange({ type: 'open register' });
                     return [4 /*yield*/, WebBrowser.openAuthSessionAsync(registerUri, redirectUrl, webBrowserOptions)];
                 case 2:
-                    registerResult = _a.sent();
-                    if (onEventChange)
+                    registerResult = _b.sent();
+                    if ((registerResult.type === 'success') && ((_a = registerResult.url) === null || _a === void 0 ? void 0 : _a.includes('error'))) {
+                        errorMessage = registerResult.url.match(utils_1.ERROR_URL_REGEX)[1];
+                        if (onEventChange)
+                            onEventChange({ type: 'error', message: errorMessage });
+                    }
+                    else if (onEventChange)
                         onEventChange(registerResult);
                     return [2 /*return*/];
             }

package/package/src/types.d.ts

@@ -20,5 +20,6 @@ export type SoyioWidgetViewPropsType = {
     onEventChange?: (event: {
         type: string;
         url?: string;
+        message?: string;
     }) => void;
 };

package/package/src/utils.d.ts

@@ -4,3 +4,4 @@ export declare function getFlowUrl(options: SoyioWidgetParams, flow: 'authentica
 export declare function buildUrlParams(widgetParams: SoyioWidgetParams, flowParams: RegisterParams | AuthenticateParams): string;
 export declare function getBrowserOptions(): Promise<WebBrowser.AuthSessionOpenOptions>;
 export declare function getRedirectUrl(scheme: string): string;
+export declare const ERROR_URL_REGEX: RegExp;

package/package/src/utils.js

@@ -70,7 +70,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRedirectUrl = exports.getBrowserOptions = exports.buildUrlParams = exports.getFlowUrl = void 0;
+exports.ERROR_URL_REGEX = exports.getRedirectUrl = exports.getBrowserOptions = exports.buildUrlParams = exports.getFlowUrl = void 0;
 var WebBrowser = __importStar(require("expo-web-browser"));
 var react_native_1 = require("react-native");
 var constants_1 = require("./constants");
@@ -80,10 +80,9 @@ function getFlowUrl(options, flow) {
 }
 exports.getFlowUrl = getFlowUrl;
 function buildUrlParams(widgetParams, flowParams) {
-    // eslint-disable-next-line no-nested-ternary
-    var platformSuffix = react_native_1.Platform.OS === 'android' ? '-android' : react_native_1.Platform.OS === 'ios' ? '-ios' : '';
+    var sdkSuffix = (react_native_1.Platform.OS === 'android' || react_native_1.Platform.OS === 'ios') ? "-".concat(react_native_1.Platform.OS) : '';
     var baseParams = {
-        platform: "rn".concat(platformSuffix),
+        sdk: "rn".concat(sdkSuffix),
         uriScheme: widgetParams.uriScheme,
         companyId: widgetParams.companyId,
         userReference: widgetParams.userReference,
@@ -131,4 +130,5 @@ function getRedirectUrl(scheme) {
     return "".concat(scheme, "://");
 }
 exports.getRedirectUrl = getRedirectUrl;
+exports.ERROR_URL_REGEX = /[?&]error=([^&]+)/;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soyio/soyio-rn-sdk",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "license": "MIT",
   "author": "Ignacio Méndez",
   "main": "./package/index.js",