@soyio/soyio-rn-sdk 2.0.0 → 2.1.0

package/README.md

@@ -50,7 +50,11 @@ This verification can happen in one of the following two ways:
 
 2. **Authentication**: Through an access key (passkey) or facial video. This can occur when a user has already been validated previously with Soyio.
 
-To instantiate this process in the code, it should be done in the following manner:
+To instantiate this process in the code, you have two options:
+
+#### 1.a Disclosure request on-the-fly:
+
+This doesn't require any previous setup. Given your company and disclosure template IDs, you can create disclosure requests freely when the user starts the widget:
 
 ```jsx
 import { useSoyioAuth } from "@soyio/soyio-rn-sdk";
@@ -89,6 +93,51 @@ export default function App() {
 }
 ```
 
+#### 1.b Created disclosure request:
+
+You can alternatively create a disclosure request beforehand with some **matchers** to make sure the person completing the request matches the one that your application thinks it is.
+
+For more details about the use case, please refer to [the documentation](https://docs.soyio.id/).
+
+To use this option, simply specify the disclosure request ID along with any optional parameters:
+
+```jsx
+import { useSoyioAuth } from "@soyio/soyio-rn-sdk";
+
+export default function App() {
+  const options = {
+    uriScheme: "<company custom uri scheme>"
+    customColor: "<custom color>",                 // Optional
+    isSandbox: true,                               // Optional
+  };
+
+  // For initialize a disclosure request
+  const disclosureParams = {
+    disclosureRequestId: "<disclosure request id>",  // Starts with 'dreq_'
+    userEmail: "<user email>",                       // Optional
+    forceError: '<error type>',                      // Optional
+  };
+
+  const onEventChange = (event) => {
+    console.log("Event:", event);
+  };
+
+  const { disclosure } = useSoyioAuth({ options, onEventChange });
+
+  const initDisclosureRequest = () => {
+    disclosure(disclosureParams);
+  };
+
+  return (
+    <View>
+      <Button title="Disclosure request" onPress={initDisclosureRequest} />
+    </View>
+  );
+}
+```
+
+Note that user and template properties are not specified here because they must be specified when creating the disclosure request beforehand.
+
 ### 2. Signature attempt (coming soon...)
 
 The **`signature_attempt`** is a process where, using a previously created `signature_attempt_id`, a request is initiated in which a user can digitally sign a document. To sign the document, the user must be authenticated. 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.

package/package/src/core.jsx

@@ -82,7 +82,7 @@ var useSoyioAuth = function (_a) {
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    disclosureBaseUri = (0, utils_1.getRequestUrl)(options, 'disclosure');
+                    disclosureBaseUri = (0, utils_1.getRequestUrl)(options, __assign({ request: 'disclosure' }, registerParams));
                     disclosureUri = "".concat(disclosureBaseUri, "?").concat((0, utils_1.buildUrlParams)(options, registerParams));
                     redirectUrl = (0, utils_1.getRedirectUrl)(options.uriScheme);
                     return [4 /*yield*/, (0, utils_1.getBrowserOptions)()];

package/package/src/types.d.ts

@@ -1,17 +1,25 @@
 export type SoyioErrors = 'user_exists' | 'facial_validation_error' | 'document_validation_error' | 'unknown_error';
+type NewDisclosureParams = {
+    templateId: string;
+    disclosureRequestId?: never;
+    userEmail?: string;
+    forceError?: SoyioErrors;
+};
+type ExistingDisclosureParams = {
+    templateId?: never;
+    disclosureRequestId: string;
+    userEmail?: never;
+    forceError?: SoyioErrors;
+};
 export type SoyioWidgetParams = {
-    companyId: string;
+    companyId?: string;
     userReference?: string;
     uriScheme: string;
     isSandbox?: boolean;
     customColor?: string;
     developmentUrl?: string;
 };
-export type DisclosureParams = {
-    templateId: string;
-    userEmail?: string;
-    forceError?: SoyioErrors;
-};
+export type DisclosureParams = NewDisclosureParams | ExistingDisclosureParams;
 export type SignatureParams = {
     signatureTemplateId: string;
     identityId: string;
@@ -24,3 +32,4 @@ export type SoyioWidgetViewPropsType = {
         message?: string;
     }) => void;
 };
+export {};

package/package/src/utils.d.ts

@@ -1,6 +1,11 @@
 import * as WebBrowser from 'expo-web-browser';
-import { DisclosureParams, SoyioWidgetParams } from './types';
-export declare function getRequestUrl(options: SoyioWidgetParams, request: 'disclosure' | 'signature'): string;
+import { DisclosureParams, SignatureParams, SoyioWidgetParams } from './types';
+type RequestUrlParams = {
+    request: 'disclosure';
+} & DisclosureParams | {
+    request: 'signature';
+} & SignatureParams;
+export declare function getRequestUrl(options: SoyioWidgetParams, params: RequestUrlParams): string;
 export declare function buildUrlParams(widgetParams: SoyioWidgetParams, requestParams: DisclosureParams): string;
 export declare function getBrowserOptions(): Promise<WebBrowser.AuthSessionOpenOptions>;
 export declare function getRedirectUrl(scheme: string): string;

package/package/src/utils.js

@@ -74,9 +74,16 @@ exports.parseUrlResponseParams = exports.getRedirectUrl = exports.getBrowserOpti
 var WebBrowser = __importStar(require("expo-web-browser"));
 var react_native_1 = require("react-native");
 var constants_1 = require("./constants");
-function getRequestUrl(options, request) {
+function getPath(params) {
+    if (params.request === 'disclosure' && params.disclosureRequestId) {
+        return "disclosures/".concat(params.disclosureRequestId);
+    }
+    return params.request;
+}
+function getRequestUrl(options, params) {
     var baseUrl = options.developmentUrl || (options.isSandbox ? constants_1.SANDBOX_URL : constants_1.PRODUCTION_URL);
-    return "".concat(baseUrl, "/").concat(request);
+    var path = getPath(params);
+    return "".concat(baseUrl, "/").concat(path);
 }
 exports.getRequestUrl = getRequestUrl;
 function buildUrlParams(widgetParams, requestParams) {
@@ -131,15 +138,18 @@ function getRedirectUrl(scheme) {
 }
 exports.getRedirectUrl = getRedirectUrl;
 function parseUrlResponseParams(url) {
-    var regex = /^(\w+):\/\/(\w+)\?(.+)$/;
+    var regex = /^([\w-]+):\/\/(\w+)\?(.+)$/;
     var match = url.match(regex);
     var requestType = match[2], queryString = match[3];
-    var params = new URLSearchParams(queryString);
     var result = {
         request: requestType,
     };
-    params.forEach(function (value, key) {
-        result[key] = value;
+    queryString.split('&').forEach(function (pair) {
+        var _a = pair.split('=').map(decodeURIComponent), key = _a[0], rawValue = _a[1];
+        if (key) {
+            var value = rawValue === 'null' ? null : rawValue;
+            result[key] = value;
+        }
     });
     return result;
 }

package/package.json

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