@incognia/web-sdk 1.23.0 → 1.24.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ declare global {
     }
 }
 export type Identity = {
+    /** The unique identifier of the user's account. This value is used to associate this event with the user's account. */
     accountId: string;
 };
 /**
@@ -13,58 +14,95 @@ export type GetSessionTokenParams = {
     askForGeolocation: boolean;
 };
 export type GenerateRequestTokenParams = {
+    /** Whether to attempt collecting geolocation data (may require user permission). */
     askForGeolocation?: boolean;
+    /** The maximum length of the generated request token. If not specified, the default value (8KB) will be used. */
     maxLength?: number;
+    /** Wait for the data collection to be sent to our servers before generating the request token. This ensures that the most up-to-date data is used, but may increase the time required to generate the token. The delay is most noticeable immediately after the initial init call. After the first token generation, the SDK will have already collected the necessary data, and subsequent delays should be minimal. */
     ensureDataCollection?: boolean;
+    /** The maximum time (ms) to wait for data collection to complete when ensureDataCollection is enabled. If the timeout is reached before data collection finishes, the SDK will generate the request token anyway. If not specified, the SDK will wait until data collection is complete. */
     dataCollectionTimeoutMs?: number;
 };
 export type EventProperties = Record<string, string | number | boolean>;
 export type EventAddress = {
+    /** Locale used for formatting or interpreting the address (e.g., "en-US", "pt-BR"). */
     locale?: string;
+    /** Country code (e.g., "US", "BR"). */
     countryCode?: string;
+    /** Full country name (e.g., "United States", "Brazil"). */
     countryName?: string;
+    /** State, province, or region name (e.g., "California"). */
     state?: string;
+    /** City or municipality name (e.g., "New York City"). */
     city?: string;
+    /** Neighborhood, district, or suburb within the city (e.g., "Manhattan"). */
     neighborhood?: string;
+    /** Street number. Can be a string for cases like "12A" or "S/N". */
     number?: string | number;
+    /** Street name (e.g., "Fifth Avenue"). */
     street?: string;
+    /** Postal or ZIP code (e.g., "10118"). Can be string or number depending on format. */
     postalCode?: string | number;
+    /** Full address line (free-form), typically combining street, number, and complement. */
     addressLine?: string;
+    /** Latitude coordinate */
     latitude?: number;
+    /** Longitude coordinate */
     longitude?: number;
 };
 export type CustomEventParams = {
+    /** A tag that can be used to categorize the type of event. */
     tag: string;
+    /** The unique identifier of the user's account. This value is used to associate this event with the user's account. If value is number it will be converted to string. */
     accountId?: string | number;
+    /** A unique identifier for the attempt, allowing you to identify and analyze Incognia's results. */
     externalId?: string | number;
+    /** The address related to the mapped event. */
     address?: EventAddress;
+    /** A map of additional properties that can be used to provide more context about the event and help Incognia's analysis. Keys must be strings, and values may be of type Boolean, String or Number. */
     properties?: EventProperties;
 };
 export type IncogniaOptions = {
+    /** The unique identifier of your application, which can be found in the Incognia dashboard. */
     appId?: string;
+    /** Enables debug logging. */
     logEnabled?: boolean;
+    /** Enables the SDK to gather user interaction data on the webpage, such as mouse movements and clicks. */
     trackUserInteraction?: boolean;
+    /** A custom domain to be used for the SDK's requests. */
     customDomain?: string;
+    /** Sets the maximum length, in bytes, that a request token generated by the SDK should have. It must be set to an integer no smaller than 1000. */
     requestTokenMaxLength?: number;
+    /** Domain from which the Incognia SDK script is loaded. This value is set through Incognia Options and determines the CDN domain used by the SDK loader to fetch the artifact. */
     scriptSrcDomain?: string;
+    /** Enables the SDK to detect whether Incognia's domains are blocked. This intentionally triggers a network error visible in the browser's DevTools console. */
     domainBlockerDetectionEnabled?: boolean;
+    /** Enables the SDK to use cookies for storing identifiers. */
     cookieEnabled?: boolean;
+    /** The domain to be used for the SDK's cookies. Should be used to allow cookies across a shared subdomain (e.g., a domain=incognia.com will use the same identifier for dashboard.incognia.com and developer.incognia.com). */
     cookieDomain?: string;
+    /** Enables the SDK to collect motion sensor data (accelerometer and gyroscope). */
+    sensorsEnabled?: boolean;
 };
 declare class IncogniaWebSdk {
     #private;
+    /** Initializes the Incognia SDK with the app id or options parameters. */
     init(appIdOrOptions: string | IncogniaOptions): Promise<void>;
+    /** Sets an account id. */
     setAccountId(accountId: string | number): Promise<void>;
+    /** Clears the account id. */
     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>;
+    /** Generates the request token. */
     generateRequestToken(options?: GenerateRequestTokenParams): Promise<string | undefined>;
     /**
      * @deprecated Since v1.2.0 - Use `generateRequestToken` instead.
      */
     getSessionToken(options?: GetSessionTokenParams): Promise<string | undefined>;
+    /** Sends a custom event with the specified parameters. */
     sendCustomEvent(params: CustomEventParams): Promise<void>;
     sendLocationEvent(): Promise<void>;
 }