Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | /**
* Configuration options for the {@link FingerprintJsProProvider} and {@link FingerprintJsProAgent}
*
* @group Types and interfaces
*/
export interface FingerprintJsProAgentParams {
/**
* your public API key that authenticates the agent with the API
*/
apiKey: string
/**
* which region to use
*/
region?: Region
/**
* server API URL, should be only used with the Custom subdomain
*/
endpointUrl?: string
/**
* provide array of endpoints to specify fallbacks
*/
fallbackEndpointUrls?: string[]
/**
* set this flag to get response in extended format
*/
extendedResponseFormat?: boolean
}
export interface QueryResult<TData, TError = Error> {
/**
* Visitor identification data
*/
data?: TData
/**
* Request state after calling `getData()`
*/
isLoading?: boolean
/**
* Error message in case of failed `getData()` call
*/
error?: TError
}
/**
* The {@link https://dev.fingerprint.com/docs/regions | region} of your application.
* The parameter is fully optional because JS agent detects the regions automatically using the provided API key.
* Nevertheless, we recommend always specifying the parameter. Otherwise the default region us.
* @group Types and interfaces
*/
export type Region = 'eu' | 'us' | 'ap'
/**
* Visitor identification data
*
* @group Types and interfaces
*/
export type VisitorData = ShortVisitorData | ExtendedVisitorData
/**
* Main identification information about the visitor
* @group Types and interfaces
*/
export interface ShortVisitorData {
/**
* The visitor identifier
*/
visitorId: string
/**
* The current request identifier. It's different for every request.
*/
requestId: string
/**
* A confidence score that tells how much the agent is sure about the visitor identifier
*/
confidence: Confidence
}
/**
* Represents the probability of accurate identification.
*
* @group Types and interfaces
*/
export interface Confidence {
/**
* A number between 0 and 1 that tells how much the agent is sure about the visitor identifier.
* The higher the number, the higher the chance of the visitor identifier to be true.
*/
score: number
/**
* Additional details about the score as a human-readable text
*/
comment?: string
}
/**
* All known identification information about the visitor
*
* @group Types and interfaces
*/
export interface ExtendedVisitorData extends ShortVisitorData {
/**
* If true, this visitor was found and visited before.
* If false, this visitor wasn't found and probably didn't visit before.
*/
visitorFound: boolean
/**
* IP address. Only IPv4 are returned.
* @example
* '191.14.35.17'
*/
ip: string
/**
* IP address location. Can be empty for anonymous proxies
*/
ipLocation?: IpLocation
/**
* OS name.
* @example
* 'iOS'
* @example
* 'Android'
*/
os: string
/**
* OS version
* @example
* '10.13.6'
*/
osVersion: string
/**
* Device.
* @example
* 'Samsung SM-J330F'
*/
device: string
/**
* When the visitor was seen for the first time
*/
firstSeenAt: SeenAt
/**
* When the visitor was seen previous time
*/
lastSeenAt: SeenAt
}
/**
* {@link https://dev.fingerprint.com/docs/geolocation | IP address location}. Can be empty for anonymous proxies.
*
* @group Types and interfaces
*/
export interface IpLocation {
/**
* IP address location detection radius. Smaller values (<50mi) are business/residential,
* medium values (50 < x < 500) are cellular towers (usually),
* larger values (>= 500) are cloud IPs or proxies, VPNs.
* Can be missing, in case of Tor/proxies.
*/
accuracyRadius?: number
/**
* Latitude
* Can be missing, in case of Tor/proxies.
* @example
* -19.8975
*/
latitude?: number
/**
* Longitude
* Can be missing, in case of Tor/proxies.
* @example
* -43.9625
*/
longitude?: number
/**
* Timezone of the IP address location
* @example
* 'America/Chicago'
*/
timezone?: string
/**
* Postal code, when available
*/
postalCode?: string
/**
* City, when available
*/
city?: {
name: string
}
/**
* Administrative subdivisions array (for example states|provinces -> counties|parishes).
* Can be empty or missing.
* When not empty, can contain only top-level administrative units within a country, e.g. a state.
*/
subdivisions?: [
{
isoCode: string
name: string
}
]
/**
* Country, when available. Will be missing for Tor/anonymous proxies.
*/
country?: {
name: string
code: string
}
/**
* Continent, when available. Will be missing for Tor/anonymous proxies.
*/
continent?: {
name: string
code: string
}
}
/**
*
* @group Types and interfaces
*/
export interface SeenAt {
/**
* The date and time within your subscription. The string format is ISO-8601.
* @example
* '2022-03-16T05:18:24.610Z'
* new Date(result.firstSeenAt.subscription)
*/
subscription: string | null
/**
* The date and time across all subscription. The string format is ISO-8601.
* @example
* '2022-03-16T05:18:24.610Z'
* new Date(result.firstSeenAt.global)
*/
global: string | null
}
/**
* Tags are returned in the webhook response so make sure the map you are passing to the library represents a valid JSON.
*
* @group Types and interfaces
*/
export type Tags = { [K in string]: Tag | Tag[] }
/**
* Tags are returned in the webhook response so make sure the map you are passing to the library represents a valid JSON.
*
* @group Types and interfaces
*/
export type Tag = string | number | boolean | Tags
export interface VisitorQueryResult extends QueryResult<VisitorData> {
/**
* Visitor identification dataaaa
*/
data?: VisitorData
}
/**
* @group Hooks approach
*/
export interface VisitorQueryContext extends VisitorQueryResult {
/**
* Retrieve the visitor identifier using your public API key.
* @param tags is a customer-provided value or an object that will be saved together with the analysis event and will be returned back to you in a webhook message or when you search for the visit in the server API. {@link https://dev.fingerprint.com/docs/js-agent#tag | more info in the documentation page}
* @param linkedId is a way of linking current analysis event with a custom identifier. This will allow you to filter visit information when using the Server API {@link https://dev.fingerprint.com/docs/js-agent#linkedid | more info in the documentation page}
*/
getData: (tags?: Tags, linkedId?: string) => Promise<VisitorData | null>
}
|