@soyio/soyio-rn-sdk 2.0.1 → 2.2.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,41 +93,82 @@ export default function App() {
 }
 ```
 
-### 2. Signature attempt (coming soon...)
+#### 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.
 
-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.
+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 = {
-    companyId: "<company id>",                     // Starts with 'com_'
     uriScheme: "<company custom uri scheme>"
-    userReference: "<company identifier of user>", // Optional
     customColor: "<custom color>",                 // Optional
-    isSandbox: true,                               // Optional
+    isSandbox: false,                              // 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. 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 with Soyio. This authentication can occur either through an access key or facial video.
+
+```jsx
+import { useSoyioAuth } from "@soyio/soyio-rn-sdk";
+
+export default function App() {
+  const options = {
+    uriScheme: "<company custom uri scheme>"
+    customColor: "<custom color>",                 // Optional
+    isSandbox: false,                              // Optional
   };
 
-  // For signing documents
-  const signatureParams = {
-    signatureTemplateId: "<signature template id>" // Starts with 'st_'
-    identityId: "<identity id>",                   // Starts with 'id_'
+  const authRequestParams = {
+    authRequestId: "<auth request id>" // Starts with 'authreq_'
   }
 
   const onEventChange = (event) => {
     console.log("Event:", event);
   };
 
-  const { signature } = useSoyioAuth({ options, onEventChange });
+  const { authentication } = useSoyioAuth({ options, onEventChange });
 
-  const initSignatureAttempt = () => {
-    signature(signatureParams);
+  const initAuthRequest = () => {
+    authentication(authRequestParams);
   };
 
   return (
     <View>
-      <Button title="Signature Request" onPress={initSignatureAttempt} />
+      <Button title="Auth Request" onPress={initAuthRequest} />
     </View>
   );
 }
@@ -131,12 +176,12 @@ export default function App() {
 
 The `onEventChange` function can return the following objects:
 
-1. When disclosure request is successful:
+1. When a request is successful:
 
 ```js
 {
   type: "success",
-  request: "disclosure",
+  request: "disclosure" | "authRequest",
   verificationKind: "validation" | "authentication",
   userReference: "<company-user-reference>",
   identityId: "<soyio-identity-id-of-user>",
@@ -147,7 +192,7 @@ The `onEventChange` function can return the following objects:
 
 ```js
 {
-  type: "open_disclosure";
+  type: "open";
 }
 ```
 
@@ -164,8 +209,8 @@ The `onEventChange` function can return the following objects:
 ```js
 {
   type: "error",
-  request: "disclosure",
-  error: "DENIED_CAMERA_PERMISSIONS" | "UNEXPECTED_ERROR"
+  request: "disclosure" | "authRequest",
+  error: "UNEXPECTED_ERROR"
 }
 ```
 
@@ -179,7 +224,7 @@ The `onEventChange` function can return the following objects:
 - **`customColor`**: (Optional) A hex code string that specifies the base color of the interface
 - **`isSandbox`**: (Optional) Indicates if the widget should operate in sandbox mode, defaulting to `false`.
 - **`uriScheme`**: The unique redirect scheme you've set with `npx uri-scheme add ...`, critical for redirect handling in your app.
-- **`signatureTemplateId`**: Identifier of template. Specifies the order and quantity of documents to sign. It must start with `'st_'`.
+- **`authRequestId`**: Identifier of auth request obtained when creating the `AuthRequest`. It must start with `'authreq_'`.
 
 #### Error types
 

package/package/src/core.d.ts

@@ -1,4 +1,5 @@
-import type { DisclosureParams, SoyioWidgetViewPropsType } from './types';
+import type { AuthRequestParams, DisclosureParams, SoyioWidgetViewPropsType } from './types';
 export declare const useSoyioAuth: ({ options, onEventChange }: SoyioWidgetViewPropsType) => {
     disclosure: (registerParams: DisclosureParams) => Promise<void>;
+    authentication: (authRequestParams: AuthRequestParams) => Promise<void>;
 };

package/package/src/core.jsx

@@ -76,29 +76,28 @@ var react_1 = require("react");
 var utils_1 = require("./utils");
 var useSoyioAuth = function (_a) {
     var options = _a.options, onEventChange = _a.onEventChange;
-    var disclosure = (0, react_1.useCallback)(function (registerParams) { return __awaiter(void 0, void 0, void 0, function () {
-        var disclosureBaseUri, disclosureUri, redirectUrl, webBrowserOptions, disclosureResult, urlParams;
+    var handleProcess = (0, react_1.useCallback)(function (baseUri, params) { return __awaiter(void 0, void 0, void 0, function () {
+        var uri, redirectUrl, webBrowserOptions, result, urlParams;
         var _a;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    disclosureBaseUri = (0, utils_1.getRequestUrl)(options, 'disclosure');
-                    disclosureUri = "".concat(disclosureBaseUri, "?").concat((0, utils_1.buildUrlParams)(options, registerParams));
+                    uri = "".concat(baseUri, "?").concat((0, utils_1.buildUrlParams)(options, params));
                     redirectUrl = (0, utils_1.getRedirectUrl)(options.uriScheme);
                     return [4 /*yield*/, (0, utils_1.getBrowserOptions)()];
                 case 1:
                     webBrowserOptions = _b.sent();
                     if (onEventChange)
-                        onEventChange({ type: 'open_disclosure' });
-                    return [4 /*yield*/, WebBrowser.openAuthSessionAsync(disclosureUri, redirectUrl, webBrowserOptions)];
+                        onEventChange({ type: 'open' });
+                    return [4 /*yield*/, WebBrowser.openAuthSessionAsync(uri, redirectUrl, webBrowserOptions)];
                 case 2:
-                    disclosureResult = _b.sent();
+                    result = _b.sent();
                     if (onEventChange) {
                         // 'success' type means that a redirection was triggered by Soyio,
                         // but doesn't mean that the process was successful
-                        if (disclosureResult.type === 'success') {
-                            urlParams = (0, utils_1.parseUrlResponseParams)(disclosureResult.url);
-                            if ((_a = disclosureResult.url) === null || _a === void 0 ? void 0 : _a.includes('error')) {
+                        if (result.type === 'success') {
+                            urlParams = (0, utils_1.parseUrlResponseParams)(result.url);
+                            if ((_a = result.url) === null || _a === void 0 ? void 0 : _a.includes('error')) {
                                 onEventChange(__assign({ type: 'error' }, urlParams));
                             }
                             else {
@@ -106,14 +105,30 @@ var useSoyioAuth = function (_a) {
                             }
                         }
                         else {
-                            onEventChange(disclosureResult);
+                            onEventChange(result);
                         }
                     }
                     return [2 /*return*/];
             }
         });
     }); }, [options, onEventChange]);
-    return { disclosure: disclosure };
+    var disclosure = (0, react_1.useCallback)(function (registerParams) { return __awaiter(void 0, void 0, void 0, function () {
+        var disclosureBaseUri;
+        return __generator(this, function (_a) {
+            disclosureBaseUri = (0, utils_1.getRequestUrl)(options, __assign({ request: 'disclosure' }, registerParams));
+            handleProcess(disclosureBaseUri, registerParams);
+            return [2 /*return*/];
+        });
+    }); }, [options, handleProcess]);
+    var authentication = (0, react_1.useCallback)(function (authRequestParams) { return __awaiter(void 0, void 0, void 0, function () {
+        var authBaseUri;
+        return __generator(this, function (_a) {
+            authBaseUri = (0, utils_1.getRequestUrl)(options, __assign({ request: 'authentication' }, authRequestParams));
+            handleProcess(authBaseUri, authRequestParams);
+            return [2 /*return*/];
+        });
+    }); }, [options, handleProcess]);
+    return { disclosure: disclosure, authentication: authentication };
 };
 exports.useSoyioAuth = useSoyioAuth;
 //# sourceMappingURL=core.jsx.map

package/package/src/types.d.ts

@@ -1,21 +1,28 @@
 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 AuthRequestParams = {
+    authRequestId: `authreq_${string}`;
+};
 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 SignatureParams = {
-    signatureTemplateId: string;
-    identityId: string;
-};
+export type DisclosureParams = NewDisclosureParams | ExistingDisclosureParams;
 export type SoyioWidgetViewPropsType = {
     options: SoyioWidgetParams;
     onEventChange?: (event: {
@@ -24,3 +31,4 @@ export type SoyioWidgetViewPropsType = {
         message?: string;
     }) => void;
 };
+export {};

package/package/src/utils.d.ts

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

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) {
@@ -84,9 +91,9 @@ function buildUrlParams(widgetParams, requestParams) {
     var baseParams = {
         sdk: "rn".concat(sdkSuffix),
         uriScheme: widgetParams.uriScheme,
+        customColor: widgetParams.customColor,
         companyId: widgetParams.companyId,
         userReference: widgetParams.userReference,
-        customColor: widgetParams.customColor,
     };
     var allParams = __assign(__assign({}, baseParams), requestParams);
     var queryParams = Object.entries(allParams)

package/package.json

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