curator-bb v0.1.1-beta

Description :-

curator-bb - used to validate users at any web form. It is made up of React, TypeScript & Vite.

i). Overview

• The Curator Web SDK serves the primary purpose of validating preregistered users to enhance client app privacy and protect against potential security threats.
• The package exposes two key APIs: 'initialize' and 'curate'.
• The 'initialize' API facilitates the registration of users on the client app by making a request to the Axiom Protect server. This request includes parameters such as serverURL, operatorId, appId, and password.
• Users are required to define their form key name fields for inclusion in the Axiom policy under the pre-registration tab.
• Upon submitting the form, the 'curate' API is invoked, sending a request to the server, which responds with either 'true' or 'false' based on user validation. This information determines whether the user can proceed with the registration process in the client app.

Installation :-

i). Install at HTML pages

• Step 1: Be ready with HTML form and import the package

<script type="module">
   // import curator package
   import curatorBB from 'https://cdn.jsdelivr.net/npm/curator-bb@0.1.1/+esm'
</script>

• Step 2: Initially, call initialize function to get the curator service

   // initialize curator operator
   curatorBB.initialize({
      serverURL: string,
      operatorId: string,
      appId:string,
      password: string,
      onMessage: (arg) => { }
   });

Note: It is recommended to call initialize function before calling user validator.

• Step 3: Call curate function to get the curator service

   // form submission with curator for validating user
   curatorBB.curate({
      userDetails: object, 
      onMessage: (arg) => { }
   });

Note: It is recommended to call curate function after initializing the operator/developer. And make sure you prevent default.

Example :-

document.addEventListener("DOMContentLoaded", function () {
   document.getElementById("myForm").addEventListener("submit", function (event) {
      // Prevent the default form submission behavior
      event.preventDefault();
      ...
      // call curate
      curatorBB.curate({
         ...
      });
   }
}

You can get the return response or can use onMessage to know more about the return response. Use with one argument and check for arg.code

• 0 - failed message
• 1 - success message
• 2 - info message
• -1 - error message

Authors

• @Shankaresh
• @Suresh