@incognia/web-sdk 0.11.0

package/README.md

@@ -0,0 +1,118 @@
+# Incognia Web SDK
+
+The Incognia SDK for the web.
+
+Documentation can be found at <https://developer.incognia.com/docs>
+
+## Installation
+
+### npm
+
+```sh
+npm install @incognia/web-sdk
+```
+
+### yarn
+
+```sh
+yarn add @incognia/web-sdk
+```
+
+### CDN
+
+Add the following script to your HTML:
+
+```sh
+<script src="https://repo.incognia.com/web/latest/incognia-web-sdk.js"></script>
+```
+
+###
+
+## Getting started
+
+Import the package:
+
+```js
+// ES6
+import IncogniaWebSdk from '@incognia/web-sdk'
+
+// CommonJS (Outdated)
+const IncogniaWebSdk = require('@incognia/web-sdk')
+
+// CDN Script
+const IncogniaWebSdk = window.IncogniaWebSdk
+```
+
+## Library API methods
+
+### Init
+
+Initialize the Web SDK with your Web Application ID. This step is _required_, and further methods will not work if the SDK is not initialized.
+
+```js
+IncogniaWebSdk.init('<your-web-app-id>')
+```
+
+### Identify
+
+This method receives user identifiers (i.e., the `accountId`) and stores locally. The user identifier is then added to the `sessionToken` data.
+
+```js
+IncogniaWebSdk.identify({ accountId: '@accountId' })
+```
+
+### Get session token
+
+This method generates a session token and returns it.
+
+```js
+const sessionToken = await IncogniaWebSdk.getSessionToken()
+```
+
+## Geolocation API
+
+By default, the Incognia Web SDK does not ask the user for geolocation, because:
+
+- Not all use cases requires geolocation
+- The website should have total control when to ask for geolocation
+- The lib should run silently.
+
+However, if the geolocation is available (It was authorized by the user before), the Web SDK will include the geolocation information into the token.
+
+### Allowing Incognia to request geolocation permissions
+
+When getting the `sessionToken`, the option parameter `askForGeolocation` can be used to allow Incognia to automatically request the user location permissions.
+
+```js
+const sessionToken = await IncogniaWebSdk.getSessionToken({
+  askForGeolocation: true
+})
+```
+
+### How and when to ask the user for geolocation?
+
+The ideal flow to manually ask the user for geolocation is:
+
+1. Initialize the SDK:
+
+```js
+IncogniaWebSdk.init(...)
+```
+
+2. Ask the user for Geolocation and then proceed to get the token:
+
+```js
+navigator.geolocation.getCurrentPosition(getSessionToken, getSessionToken)
+
+function getSessionToken() {
+  const sessionToken = await IncogniaWebSdk.getSessionToken()
+  //TODO: Send the sessionToken to your backend.
+}
+```
+
+## Browser Compatibility
+
+Except for IE, this lib is compatible with every modern browser.
+
+However, for Geolocation API, each browser handles it differently. For example, Firefox v104 does not provide the Geolocation API by default. So the user has to enable it.
+Besides, for some OSs like MacOS, you have to allow the browser to access the geolocation. If the geolocation is not available, the token will be generated without that information.

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+declare type Identity = {
+    accountId: string;
+};
+declare type GetSessionTokenParams = {
+    askForGeolocation: boolean;
+};
+declare class IncogniaWebSdk {
+    init(appId: string): Promise<void>;
+    identify(identity: Identity): Promise<void>;
+    getSessionToken(options?: GetSessionTokenParams): Promise<string | undefined>;
+}
+declare const incogniaWebSdk: IncogniaWebSdk;
+export default incogniaWebSdk;

package/dist/index.js

@@ -0,0 +1 @@
+'use strict';var a0y=a0Q;(function(D,Q){var a0T={D:0x1e0,Q:0x1df,m:0x1e4,h:0x1ea,O:0x1e5,y:0x1e2,T:0x1e9,a:0x1e6,k:0x1dd,s:0x1e1},n=a0Q,m=D();while(!![]){try{var h=-parseInt(n(a0T.D))/0x1+parseInt(n(a0T.Q))/0x2+parseInt(n(a0T.m))/0x3*(parseInt(n(a0T.h))/0x4)+parseInt(n(a0T.O))/0x5*(-parseInt(n(a0T.y))/0x6)+-parseInt(n(a0T.T))/0x7+parseInt(n(a0T.a))/0x8*(parseInt(n(a0T.k))/0x9)+-parseInt(n(a0T.s))/0xa;if(h===Q)break;else m['push'](m['shift']());}catch(O){m['push'](m['shift']());}}}(a0D,0x5d0bb));function a0Q(D,Q){var m=a0D();return a0Q=function(h,O){h=h-0x1dd;var n=m[h];if(a0Q['DOJknU']===undefined){var y=function(s){var q='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+/=';var S='',J='';for(var A=0x0,w,p,c=0x0;p=s['charAt'](c++);~p&&(w=A%0x4?w*0x40+p:p,A++%0x4)?S+=String['fromCharCode'](0xff&w>>(-0x2*A&0x6)):0x0){p=q['indexOf'](p);}for(var N=0x0,F=S['length'];N<F;N++){J+='%'+('00'+S['charCodeAt'](N)['toString'](0x10))['slice'](-0x2);}return decodeURIComponent(J);};a0Q['MHLOeA']=y,D=arguments,a0Q['DOJknU']=!![];}var T=m[0x0],a=h+T,k=D[a];return!k?(n=a0Q['MHLOeA'](n),D[a]=n):n=k,n;},a0Q(D,Q);}function a0D(){var a=['mJu2mJKYmen6zwvVuG','mtmYCeDxvKj2','tK9erv9ftLy','nM9QEhDOqW','mtK0mtvNCw55uxu','mtuYr2Dowfj2','zxHWB3j0CW','zw52','mtGZodq0nxj2v1HhwG','otK5odq4EwLjv2jS','ChjVzhvJDgLVBG','mZi2nJm3zxzPvLbq','lI93zwiTC2rRlMnQCY5WCM9KDwn0Aw9UlM1PBI5QCW','nZe2odi0seTHz0Dq','ntyYndm1AhrRrhHt'];a0D=function(){return a;};return a0D();}process[a0y(0x1e8)][a0y(0x1e3)]===a0y(0x1eb)?module[a0y(0x1e7)]=require(a0y(0x1de)):module[a0y(0x1e7)]=require(a0y(0x1de));