@incognia/web-sdk 1.1.3 → 1.2.0

package/README.md

@@ -59,20 +59,26 @@ Initialize the Web SDK with your Web Application ID. This step is _required_, an
 IncogniaWebSdk.init('<your-web-app-id>')
 ```
 
-### Identify
+### Account ID
 
-This method receives user identifiers (i.e., the `accountId`) and stores locally. The user identifier is then added to the `sessionToken` data.
+The method `setAccountId` receives an account ID and stores locally. It is then added to the `requestToken` data.
 
 ```js
-IncogniaWebSdk.identify({ accountId: '@accountId' })
+IncogniaWebSdk.setAccountId('@accountId')
 ```
 
-### Get session token
+The method `clearAccountId` removes the account ID from the local storage.
 
-This method generates a session token and returns it.
+```js
+IncogniaWebSdk.clearAccountId()
+```
+
+### Generate request token
+
+This method generates a request token and returns it.
 
 ```js
-const sessionToken = await IncogniaWebSdk.getSessionToken()
+const requestToken = await IncogniaWebSdk.generateRequestToken()
 ```
 
 ### Send custom event
@@ -115,10 +121,10 @@ However, if the geolocation is available (It was authorized by the user before),
 
 ### 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.
+When getting the `requestToken`, the option parameter `askForGeolocation` can be used to allow Incognia to automatically request the user location permissions.
 
 ```js
-const sessionToken = await IncogniaWebSdk.getSessionToken({
+const requestToken = await IncogniaWebSdk.generateRequestToken({
   askForGeolocation: true
 })
 ```
@@ -136,11 +142,11 @@ IncogniaWebSdk.init(...)
 2. Ask the user for Geolocation and then proceed to get the token:
 
 ```js
-navigator.geolocation.getCurrentPosition(getSessionToken, getSessionToken)
+navigator.geolocation.getCurrentPosition(generateRequestToken, generateRequestToken)
 
-function getSessionToken() {
-  const sessionToken = await IncogniaWebSdk.getSessionToken()
-  //TODO: Send the sessionToken to your backend.
+function generateRequestToken() {
+  const requestToken = await IncogniaWebSdk.generateRequestToken()
+  //TODO: Send the requestToken to your backend.
 }
 ```
 

package/dist/index.d.ts

@@ -1,9 +1,15 @@
 export type Identity = {
     accountId: string;
 };
+/**
+ * @deprecated Since v1.2.0 - Use `GenerateRequestTokenParams` instead.
+ */
 export type GetSessionTokenParams = {
     askForGeolocation: boolean;
 };
+export type GenerateRequestTokenParams = {
+    askForGeolocation: boolean;
+};
 export type EventProperties = Record<string, string | number | boolean>;
 export type EventAddress = {
     locale?: string;
@@ -27,8 +33,18 @@ export type CustomEventParams = {
     properties?: EventProperties;
 };
 declare class IncogniaWebSdk {
+    #private;
     init(appId: string): Promise<void>;
+    setAccountId(accountId: string): Promise<void>;
+    clearAccountId(): Promise<void>;
+    /**
+     * @deprecated Since v1.2.0 - Use `setAccountId` to set a new account id and `clearAccountId` to clear the account id instead.
+     */
     identify(identity: Identity): Promise<void>;
+    generateRequestToken(options?: GenerateRequestTokenParams): Promise<string | undefined>;
+    /**
+     * @deprecated Since v1.2.0 - Use `generateRequestToken` instead.
+     */
     getSessionToken(options?: GetSessionTokenParams): Promise<string | undefined>;
     sendCustomEvent(params: CustomEventParams): Promise<void>;
 }